AWS Outposts

2023/02/06 - AWS Outposts - 2 updated api methods

Changes  Adds OrderType to Order structure. Adds PreviousOrderId and PreviousLineItemId to LineItem structure. Adds new line item status REPLACED. Increases maximum length of pagination token.

CreateOrder (updated) Link ¶
Changes (response) 
{'Order': {'LineItems': {'PreviousLineItemId': 'string',
                         'PreviousOrderId': 'string',
                         'Status': {'REPLACED'}},
           'OrderType': 'OUTPOST | REPLACEMENT'}}

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'|'REPLACED',
                'ShipmentInformation': {
                    'ShipmentTrackingNumber': 'string',
                    'ShipmentCarrier': 'DHL'|'DBS'|'FEDEX'|'UPS'
                },
                'AssetInformationList': [
                    {
                        'AssetId': 'string',
                        'MacAddressList': [
                            'string',
                        ]
                    },
                ],
                'PreviousLineItemId': 'string',
                'PreviousOrderId': 'string'
            },
        ],
        'PaymentOption': 'ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
        'OrderSubmissionDate': datetime(2015, 1, 1),
        'OrderFulfilledDate': datetime(2015, 1, 1),
        'PaymentTerm': 'THREE_YEARS'|'ONE_YEAR',
        'OrderType': 'OUTPOST'|'REPLACEMENT'
    }
}

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.

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

          • PreviousLineItemId (string) --

            The ID of the previous line item.

          • PreviousOrderId (string) --

            The ID of the previous order.

      • PaymentOption (string) --

        The payment option for the order.

      • OrderSubmissionDate (datetime) --

        The submission date for the order.

      • OrderFulfilledDate (datetime) --

        The fulfillment date of the order.

      • PaymentTerm (string) --

        The payment term.

      • OrderType (string) --

        The type of order.

GetOrder (updated) Link ¶
Changes (response) 
{'Order': {'LineItems': {'PreviousLineItemId': 'string',
                         'PreviousOrderId': 'string',
                         'Status': {'REPLACED'}},
           'OrderType': 'OUTPOST | REPLACEMENT'}}

Gets information about the specified order.

See also: AWS API Documentation

Request Syntax

client.get_order(
    OrderId='string'
)
type OrderId:

string

param OrderId:

[REQUIRED]

The ID of the order.

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'|'REPLACED',
                'ShipmentInformation': {
                    'ShipmentTrackingNumber': 'string',
                    'ShipmentCarrier': 'DHL'|'DBS'|'FEDEX'|'UPS'
                },
                'AssetInformationList': [
                    {
                        'AssetId': 'string',
                        'MacAddressList': [
                            'string',
                        ]
                    },
                ],
                'PreviousLineItemId': 'string',
                'PreviousOrderId': 'string'
            },
        ],
        'PaymentOption': 'ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
        'OrderSubmissionDate': datetime(2015, 1, 1),
        'OrderFulfilledDate': datetime(2015, 1, 1),
        'PaymentTerm': 'THREE_YEARS'|'ONE_YEAR',
        'OrderType': 'OUTPOST'|'REPLACEMENT'
    }
}

Response Structure

  • (dict) --

    • Order (dict) --

      Information about an 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.

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

          • PreviousLineItemId (string) --

            The ID of the previous line item.

          • PreviousOrderId (string) --

            The ID of the previous order.

      • PaymentOption (string) --

        The payment option for the order.

      • OrderSubmissionDate (datetime) --

        The submission date for the order.

      • OrderFulfilledDate (datetime) --

        The fulfillment date of the order.

      • PaymentTerm (string) --

        The payment term.

      • OrderType (string) --

        The type of order.