Outposts / Client / list_outposts

list_outposts#

Outposts.Client.list_outposts(**kwargs)#

Lists the Outposts for your Amazon Web Services account.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

See also: AWS API Documentation

Request Syntax

response = client.list_outposts(
    NextToken='string',
    MaxResults=123,
    LifeCycleStatusFilter=[
        'string',
    ],
    AvailabilityZoneFilter=[
        'string',
    ],
    AvailabilityZoneIdFilter=[
        'string',
    ]
)
Parameters:

  • NextToken (string) – The pagination token.

  • MaxResults (integer) – The maximum page size.

  • LifeCycleStatusFilter (list) –

    Filters the results by the lifecycle status.

    • (string) –

      The life cycle status.

  • AvailabilityZoneFilter (list) –

    Filters the results by Availability Zone (for example, us-east-1a).

    • (string) –

      The Availability Zone.

  • AvailabilityZoneIdFilter (list) –

    Filters the results by AZ ID (for example, use1-az1).

    • (string) –

      The ID of the Availability Zone.

Return type:

dict

Returns:

Response Syntax

{
    'Outposts': [
        {
            'OutpostId': 'string',
            'OwnerId': 'string',
            'OutpostArn': 'string',
            'SiteId': 'string',
            'Name': 'string',
            'Description': 'string',
            'LifeCycleStatus': 'string',
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'Tags': {
                'string': 'string'
            },
            'SiteArn': 'string',
            'SupportedHardwareType': 'RACK'|'SERVER'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Outposts (list) –

      Information about the Outposts.

      • (dict) –

        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 (dict) –

          The Outpost tags.

          • (string) –

            • (string) –

        • SiteArn (string) –

          The Amazon Resource Name (ARN) of the site.

        • SupportedHardwareType (string) –

          The hardware type.

    • NextToken (string) –

      The pagination token.

Exceptions

  • Outposts.Client.exceptions.ValidationException

  • Outposts.Client.exceptions.AccessDeniedException

  • Outposts.Client.exceptions.InternalServerException