AWS API Changes

2022/10/05 - AWS Outposts - 2 updated api methods

Changes This release adds the Asset state information to the ListAssets response. The ListAssets request supports filtering on Asset state.

CreateOrder (updated)

Link ¶
Changes (request)

{'PaymentTerm': {'ONE_YEAR'}}

Creates an order for an Outpost.

See also: AWS API Documentation

Request Syntax

client.create_order(
    OutpostIdentifier='string',
    LineItems=[
        {
            'CatalogItemId': 'string',
            'Quantity': 123
        },
    ],
    PaymentOption='ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
    PaymentTerm='THREE_YEARS'|'ONE_YEAR'
)

type OutpostIdentifier

string

param OutpostIdentifier

[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the Outpost.

type LineItems

list

param LineItems

[REQUIRED]

The line items that make up the order.

(dict) --

Information about a line item request.
- CatalogItemId (string) --
  
  The ID of the catalog item.
- Quantity (integer) --
  
  The quantity of a line item request.

type PaymentOption

string

param PaymentOption

[REQUIRED]

The payment option.

type PaymentTerm

string

param PaymentTerm

The payment terms.

rtype

dict

returns

Response Syntax

{
    'Order': {
        'OutpostId': 'string',
        'OrderId': 'string',
        'Status': 'RECEIVED'|'PENDING'|'PROCESSING'|'INSTALLING'|'FULFILLED'|'CANCELLED'|'PREPARING'|'IN_PROGRESS'|'COMPLETED'|'ERROR',
        'LineItems': [
            {
                'CatalogItemId': 'string',
                'LineItemId': 'string',
                'Quantity': 123,
                'Status': 'PREPARING'|'BUILDING'|'SHIPPED'|'DELIVERED'|'INSTALLING'|'INSTALLED'|'ERROR'|'CANCELLED',
                'ShipmentInformation': {
                    'ShipmentTrackingNumber': 'string',
                    'ShipmentCarrier': 'DHL'|'DBS'|'FEDEX'|'UPS'
                },
                'AssetInformationList': [
                    {
                        'AssetId': 'string',
                        'MacAddressList': [
                            'string',
                        ]
                    },
                ]
            },
        ],
        'PaymentOption': 'ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
        'OrderSubmissionDate': datetime(2015, 1, 1),
        'OrderFulfilledDate': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- Order (dict) --
  
  Information about this order.
  - OutpostId (string) --
    
    The ID of the Outpost in the order.
  - OrderId (string) --
    
    The ID of the order.
  - Status (string) --
    
    The status of the order.
    - PREPARING - Order is received and being prepared.
    - IN_PROGRESS - Order is either being built, shipped, or installed. To get more details, see the line item status.
    - COMPLETED - Order is complete.
    - CANCELLED - Order is cancelled.
    - ERROR - Customer should contact support.
    Note
    
    The following status are deprecated: RECEIVED , PENDING , PROCESSING , INSTALLING , and FULFILLED .
  - LineItems (list) --
    
    The line items for the order
    - (dict) --
      
      Information about a line item.
      - CatalogItemId (string) --
        
        The ID of the catalog item.
      - LineItemId (string) --
        
        The ID of the line item.
      - Quantity (integer) --
        
        The quantity of the line item.
      - Status (string) --
        
        The status of the line item.
      - ShipmentInformation (dict) --
        
        Information about a line item shipment.
        
        ShipmentTrackingNumber (string) --
        
        The tracking number of the shipment.
        
        ShipmentCarrier (string) --
        
        The carrier of the shipment.
      - AssetInformationList (list) --
        
        Information about assets.
        
        (dict) --
        
        Information about a line item asset.
        
        AssetId (string) --
        
        The ID of the asset.
        
        MacAddressList (list) --
        
        The MAC addresses of the asset.
        
        (string) --
  - PaymentOption (string) --
    
    The payment option for the order.
  - OrderSubmissionDate (datetime) --
    
    The submission date for the order.
  - OrderFulfilledDate (datetime) --
    
    The fulfillment date of the order.

ListAssets (updated)

Link ¶
Changes (request, response)
Request

{'StatusFilter': ['ACTIVE | RETIRING']}

Response

{'Assets': {'ComputeAttributes': {'State': 'ACTIVE | ISOLATED | RETIRING'}}}

Lists the hardware assets for the specified Outpost.

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

client.list_assets(
    OutpostIdentifier='string',
    HostIdFilter=[
        'string',
    ],
    MaxResults=123,
    NextToken='string',
    StatusFilter=[
        'ACTIVE'|'RETIRING',
    ]
)

type OutpostIdentifier

string

param OutpostIdentifier

[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the Outpost.

type HostIdFilter

list

param HostIdFilter

Filters the results by the host ID of a Dedicated Host.

(string) --

type MaxResults

integer

param MaxResults

The maximum page size.

type NextToken

string

param NextToken

The pagination token.

type StatusFilter

list

param StatusFilter

Filters the results by state.

(string) --

rtype

dict

returns

Response Syntax

{
    'Assets': [
        {
            'AssetId': 'string',
            'RackId': 'string',
            'AssetType': 'COMPUTE',
            'ComputeAttributes': {
                'HostId': 'string',
                'State': 'ACTIVE'|'ISOLATED'|'RETIRING'
            },
            'AssetLocation': {
                'RackElevation': ...
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Assets (list) --
  
  Information about the hardware assets.
  - (dict) --
    
    Information about hardware assets.
    - AssetId (string) --
      
      The ID of the asset.
    - RackId (string) --
      
      The rack ID of the asset.
    - AssetType (string) --
      
      The type of the asset.
    - ComputeAttributes (dict) --
      
      Information about compute hardware assets.
      - HostId (string) --
        
        The host ID of the Dedicated Host on the asset.
      - State (string) --
        
        The state.
        
        ACTIVE - The asset is available and can provide capacity for new compute resources.
        
        ISOLATED - The asset is undergoing maintenance and can't provide capacity for new compute resources. Existing compute resources on the asset are not affected.
        
        RETIRING - The underlying hardware for the asset is degraded. Capacity for new compute resources is reduced. Amazon Web Services sends notifications for resources that must be stopped before the asset can be replaced.
    - AssetLocation (dict) --
      
      The position of an asset in a rack.
      - RackElevation (float) --
        
        The position of an asset in a rack measured in rack units.
- NextToken (string) --
  
  The pagination token.