AWS API Changes

2019/12/03 - AWS Outposts - 5 new api methods

Changes This is the initial release for AWS Outposts, a fully managed service that extends AWS infrastructure, services, APIs, and tools to customer sites. AWS Outposts enables you to launch and run EC2 instances and EBS volumes locally at your on-premises location. This release introduces new APIs for creating and viewing Outposts.

GetOutpostInstanceTypes (new)

Link ¶

Lists the instance types for the specified Outpost.

See also: AWS API Documentation

Request Syntax

client.get_outpost_instance_types(
    OutpostId='string',
    NextToken='string',
    MaxResults=123
)

type OutpostId

string

param OutpostId

[REQUIRED]

The ID of the Outpost.

type NextToken

string

param NextToken

The pagination token.

type MaxResults

integer

param MaxResults

The maximum page size.

rtype

dict

returns

Response Syntax

{
    'InstanceTypes': [
        {
            'InstanceType': 'string'
        },
    ],
    'NextToken': 'string',
    'OutpostId': 'string',
    'OutpostArn': 'string'
}

Response Structure

(dict) --
- InstanceTypes (list) --
  
  Information about the instance types.
  - (dict) --
    
    Information about an instance type.
    - InstanceType (string) --
      
      The instance type.
- NextToken (string) --
  
  The pagination token.
- OutpostId (string) --
  
  The ID of the Outpost.
- OutpostArn (string) --
  
  The Amazon Resource Name (ARN) of the Outpost.

GetOutpost (new)

Link ¶

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'
    }
}

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.
  - AvailabilityZoneId (string) --
    
    The ID of the Availability Zone.

ListSites (new)

Link ¶

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'
        },
    ],
    '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.
- NextToken (string) --
  
  The pagination token.

CreateOutpost (new)

Link ¶

Creates an Outpost.

See also: AWS API Documentation

Request Syntax

client.create_outpost(
    Name='string',
    Description='string',
    SiteId='string',
    AvailabilityZone='string',
    AvailabilityZoneId='string'
)

type Name

string

param Name

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.

type AvailabilityZoneId

string

param AvailabilityZoneId

The ID of the Availability Zone.

rtype

dict

returns

Response Syntax

{
    'Outpost': {
        'OutpostId': 'string',
        'OwnerId': 'string',
        'OutpostArn': 'string',
        'SiteId': 'string',
        'Name': 'string',
        'Description': 'string',
        'LifeCycleStatus': 'string',
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': '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.
  - AvailabilityZoneId (string) --
    
    The ID of the Availability Zone.

ListOutposts (new)

Link ¶

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'
        },
    ],
    '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.
    - AvailabilityZoneId (string) --
      
      The ID of the Availability Zone.
- NextToken (string) --
  
  The pagination token.