[ aws . outposts ]

list-sites

Description

Lists the Outpost sites for your Amazon Web Services account. Add operating address filters to your request to return a more specific list of results. Use filters to match site city, country code, or state/region of the operating address.

If you specify multiple filters, the filters are joined with an AND , and the request returns only results that match all of the specified filters.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-sites
[--next-token <value>]
[--max-results <value>]
[--operating-address-country-code-filter <value>]
[--operating-address-state-or-region-filter <value>]
[--operating-address-city-filter <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--next-token (string)

The pagination token.

--max-results (integer)

The maximum page size.

--operating-address-country-code-filter (list)

A filter for the country code of the Outpost site.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.

(string)

Syntax:

"string" "string" ...

--operating-address-state-or-region-filter (list)

A filter for the state/region of the Outpost site.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.

(string)

Syntax:

"string" "string" ...

--operating-address-city-filter (list)

A filter for the city of the Outpost site.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.

(string)

Syntax:

"string" "string" ...

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To list sites

The following list-sites example lists the available Outpost sites in your AWS account.

aws outposts list-sites

Output:

{
    "Sites": [
        {
            "SiteId": "os-0ab12c3456EXAMPLE",
            "AccountId": "123456789012",
            "Name": "EXAMPLE",
            "Description": "example",
            "Tags": {}
        }
    ]
}

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

Output

Sites -> (list)

Information about the sites.

(structure)

Information about a site.

SiteId -> (string)

The ID of the site.

AccountId -> (string)

The ID of the Amazon Web Services account.

Name -> (string)

The name of the site.

Description -> (string)

The description of the site.

Tags -> (map)

The site tags.

key -> (string)

value -> (string)

SiteArn -> (string)

The Amazon Resource Name (ARN) of the site.

Notes -> (string)

Notes about a site.

OperatingAddressCountryCode -> (string)

The ISO-3166 two-letter country code where the hardware is installed and powered on.

OperatingAddressStateOrRegion -> (string)

State or region where the hardware is installed and powered on.

OperatingAddressCity -> (string)

City where the hardware is installed and powered on.

RackPhysicalProperties -> (structure)

Information about the physical and logistical details for a rack at the site.

PowerDrawKva -> (string)

The power draw available at the hardware placement position for the rack.

PowerPhase -> (string)

The power option that you can provide for hardware.

PowerConnector -> (string)

The power connector for the hardware.

PowerFeedDrop -> (string)

The position of the power feed.

UplinkGbps -> (string)

The uplink speed the rack supports for the connection to the Region.

UplinkCount -> (string)

The number of uplinks each Outpost network device.

FiberOpticCableType -> (string)

The type of fiber used to attach the Outpost to the network.

OpticalStandard -> (string)

The type of optical standard used to attach the Outpost to the network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.

MaximumSupportedWeightLbs -> (string)

The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs (907 kg).

NextToken -> (string)

The pagination token.