[ aws . outposts ]

get-outpost

Description

Gets information about the specified Outpost.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-outpost
--outpost-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--outpost-id (string)

The ID of the Outpost.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To get Outpost details

The following get-outpost example displays the details for the specified Outpost.

aws outposts get-outpost \
    --outpost-id op-0ab23c4567EXAMPLE

Output:

{
    "Outpost": {
        "OutpostId": "op-0ab23c4567EXAMPLE",
        "OwnerId": "123456789012",
        "OutpostArn": "arn:aws:outposts:us-west-2:123456789012:outpost/op-0ab23c4567EXAMPLE",
        "SiteId": "os-0ab12c3456EXAMPLE",
        "Name": "EXAMPLE",
        "LifeCycleStatus": "ACTIVE",
        "AvailabilityZone": "us-west-2a",
        "AvailabilityZoneId": "usw2-az1",
        "Tags": {}
    }
}

For more information, see Working with Outposts in the AWS Outposts User Guide.

Output

Outpost -> (structure)

Information about an Outpost.

OutpostId -> (string)

The ID of the Outpost.

OwnerId -> (string)

The AWS account ID of the Outpost owner.

OutpostArn -> (string)

The Amazon Resource Name (ARN) of the Outpost.

SiteId -> (string)

The ID of the site.

Name -> (string)

The name of the Outpost.

Description -> (string)

The description of the Outpost.

LifeCycleStatus -> (string)

The life cycle status.

AvailabilityZone -> (string)

The Availability Zone.

You must specify AvailabilityZone or AvailabilityZoneId .

AvailabilityZoneId -> (string)

The ID of the Availability Zone.

You must specify AvailabilityZone or AvailabilityZoneId .

Tags -> (map)

The Outpost tags.

key -> (string)

value -> (string)