AWS Outposts

2024/10/10 - AWS Outposts - 3 updated api methods

Changes  Adding new "DELIVERED" enum value for Outposts Order status

CreateOrder (updated) Link ¶
Changes (response) 
{'Order': {'Status': {'DELIVERED'}}}

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'|'DELIVERED'|'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'|'EXPEDITORS'
                },
                '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 or shipped. To get more details, see the line item status.

        • DELIVERED - Order was delivered to the Outpost site.

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

          • 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': {'Status': {'DELIVERED'}}}

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'|'DELIVERED'|'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'|'EXPEDITORS'
                },
                '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 or shipped. To get more details, see the line item status.

        • DELIVERED - Order was delivered to the Outpost site.

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

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

ListOrders (updated) Link ¶
Changes (response) 
{'Orders': {'Status': {'DELIVERED'}}}

Lists the Outpost orders for your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

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

string

param OutpostIdentifierFilter

The ID or the Amazon Resource Name (ARN) 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

{
    'Orders': [
        {
            'OutpostId': 'string',
            'OrderId': 'string',
            'OrderType': 'OUTPOST'|'REPLACEMENT',
            'Status': 'RECEIVED'|'PENDING'|'PROCESSING'|'INSTALLING'|'FULFILLED'|'CANCELLED'|'PREPARING'|'IN_PROGRESS'|'DELIVERED'|'COMPLETED'|'ERROR',
            'LineItemCountsByStatus': {
                'string': 123
            },
            'OrderSubmissionDate': datetime(2015, 1, 1),
            'OrderFulfilledDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Orders (list) --

      Information about the orders.

      • (dict) --

        A summary of line items in your order.

        • OutpostId (string) --

          The ID of the Outpost.

        • OrderId (string) --

          The ID of the order.

        • OrderType (string) --

          The type of order.

        • Status (string) --

          The status of the order.

          • PREPARING - Order is received and is being prepared.

          • IN_PROGRESS - Order is either being built, shipped, or installed. For more information, see the LineItem status.

          • COMPLETED - Order is complete.

          • CANCELLED - Order is cancelled.

          • ERROR - Customer should contact support.

          Note

          The following statuses are deprecated: RECEIVED , PENDING , PROCESSING , INSTALLING , and FULFILLED .

        • LineItemCountsByStatus (dict) --

          The status of all line items in the order.

          • (string) --

            • (integer) --

        • OrderSubmissionDate (datetime) --

          The submission date for the order.

        • OrderFulfilledDate (datetime) --

          The fulfilment date for the order.

    • NextToken (string) --

      The pagination token.