AWS Outposts

2020/11/23 - AWS Outposts - 4 updated api methods

Changes  Support specifying tags during the creation of the Outpost resource. Tags are now returned in the response body of Outpost APIs.

CreateOutpost (updated) Link ¶
Changes (request, response)
Request
{'Tags': {'string': 'string'}}
Response
{'Outpost': {'Tags': {'string': 'string'}}}

Creates an Outpost.

See also: AWS API Documentation

Request Syntax

client.create_outpost(
    Name='string',
    Description='string',
    SiteId='string',
    AvailabilityZone='string',
    AvailabilityZoneId='string',
    Tags={
        'string': 'string'
    }
)
type Name

string

param Name

[REQUIRED]

The name of the Outpost.

type Description

string

param Description

The Outpost description.

type SiteId

string

param SiteId

[REQUIRED]

The ID of the site.

type AvailabilityZone

string

param AvailabilityZone

The Availability Zone.

You must specify AvailabilityZone or AvailabilityZoneId .

type AvailabilityZoneId

string

param AvailabilityZoneId

The ID of the Availability Zone.

You must specify AvailabilityZone or AvailabilityZoneId .

type Tags

dict

param Tags

The tags to apply to the Outpost.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'Outpost': {
        'OutpostId': 'string',
        'OwnerId': 'string',
        'OutpostArn': 'string',
        'SiteId': 'string',
        'Name': 'string',
        'Description': 'string',
        'LifeCycleStatus': 'string',
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Outpost (dict) --

      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 Outpost description.

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

        The Outpost tags.

        • (string) --

          • (string) --

GetOutpost (updated) Link ¶
Changes (response)
{'Outpost': {'Tags': {'string': 'string'}}}

Gets information about the specified Outpost.

See also: AWS API Documentation

Request Syntax

client.get_outpost(
    OutpostId='string'
)
type OutpostId

string

param OutpostId

[REQUIRED]

The ID of the Outpost.

rtype

dict

returns

Response Syntax

{
    'Outpost': {
        'OutpostId': 'string',
        'OwnerId': 'string',
        'OutpostArn': 'string',
        'SiteId': 'string',
        'Name': 'string',
        'Description': 'string',
        'LifeCycleStatus': 'string',
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Outpost (dict) --

      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 Outpost description.

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

        The Outpost tags.

        • (string) --

          • (string) --

ListOutposts (updated) Link ¶
Changes (response)
{'Outposts': {'Tags': {'string': 'string'}}}

List the Outposts for your AWS account.

See also: AWS API Documentation

Request Syntax

client.list_outposts(
    NextToken='string',
    MaxResults=123
)
type NextToken

string

param NextToken

The pagination token.

type MaxResults

integer

param MaxResults

The maximum page size.

rtype

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'
            }
        },
    ],
    '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 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 Outpost description.

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

          The Outpost tags.

          • (string) --

            • (string) --

    • NextToken (string) --

      The pagination token.

ListSites (updated) Link ¶
Changes (response)
{'Sites': {'Tags': {'string': 'string'}}}

Lists the sites for the specified AWS account.

See also: AWS API Documentation

Request Syntax

client.list_sites(
    NextToken='string',
    MaxResults=123
)
type NextToken

string

param NextToken

The pagination token.

type MaxResults

integer

param MaxResults

The maximum page size.

rtype

dict

returns

Response Syntax

{
    'Sites': [
        {
            'SiteId': 'string',
            'AccountId': 'string',
            'Name': 'string',
            'Description': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Sites (list) --

      Information about the sites.

      • (dict) --

        Information about a site.

        • SiteId (string) --

          The ID of the site.

        • AccountId (string) --

          The ID of the AWS account.

        • Name (string) --

          The name of the site.

        • Description (string) --

          The description of the site.

        • Tags (dict) --

          The site tags.

          • (string) --

            • (string) --

    • NextToken (string) --

      The pagination token.