Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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 <value>]
[--generate-cli-skeleton <value>]

Options

--outpost-id (string)

The ID of the Outpost.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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 Amazon Web Services 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.

AvailabilityZoneId -> (string)

The ID of the Availability Zone.

Tags -> (map)

The Outpost tags.

key -> (string)

value -> (string)

SiteArn -> (string)

The Amazon Resource Name (ARN) of the site.

SupportedHardwareType -> (string)

The hardware type.