AWS API Changes

2021/11/30 - AWS Outposts - 3 updated api methods

Changes This release adds the SupportedHardwareType parameter to CreateOutpost.

CreateOutpost (updated)

Link ¶
Changes (request, response)
Request

{'SupportedHardwareType': 'RACK | SERVER'}

Response

{'Outpost': {'SupportedHardwareType': 'RACK | SERVER'}}

Creates an Outpost.

You can specify AvailabilityZone or AvailabilityZoneId .

See also: AWS API Documentation

Request Syntax

client.create_outpost(
    Name='string',
    Description='string',
    SiteId='string',
    AvailabilityZone='string',
    AvailabilityZoneId='string',
    Tags={
        'string': 'string'
    },
    SupportedHardwareType='RACK'|'SERVER'
)

type Name

string

param Name

[REQUIRED]

The name of the Outpost.

type Description

string

param Description

The description of the Outpost.

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.

type Tags

dict

param Tags

The tags to apply to the Outpost.

(string) --
- (string) --

type SupportedHardwareType

string

param SupportedHardwareType

The type of hardware for this 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'
        },
        'SiteArn': 'string',
        'SupportedHardwareType': 'RACK'|'SERVER'
    }
}

Response Structure

(dict) --
- Outpost (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.

GetOutpost (updated)

Link ¶
Changes (response)

{'Outpost': {'SupportedHardwareType': 'RACK | SERVER'}}

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'
        },
        'SiteArn': 'string',
        'SupportedHardwareType': 'RACK'|'SERVER'
    }
}

Response Structure

(dict) --
- Outpost (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.

ListOutposts (updated)

Link ¶
Changes (response)

{'Outposts': {'SupportedHardwareType': 'RACK | SERVER'}}

Create a list of the Outposts for your Amazon Web Services account. Add filters to your request to return a more specific list of results. Use filters to match an Outpost lifecycle status, Availability Zone ( us-east-1a ), and AZ ID ( use1-az1 ).

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

Request Syntax

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

type NextToken

string

param NextToken

The pagination token.

type MaxResults

integer

param MaxResults

The maximum page size.

type LifeCycleStatusFilter

list

param LifeCycleStatusFilter

A filter for the lifecycle status of the Outpost.

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) --

The life cycle status.

type AvailabilityZoneFilter

list

param AvailabilityZoneFilter

A filter for the Availability Zone ( us-east-1a ) of the Outpost.

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) --

The Availability Zone.

type AvailabilityZoneIdFilter

list

param AvailabilityZoneIdFilter

A filter for the AZ IDs ( use1-az1 ) of the Outpost.

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) --

The ID of the Availability Zone.

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