AWS Outposts

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

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 for the order.

type PaymentTerm:

string

param PaymentTerm:

The payment terms for the order.

rtype:

dict

returns:

Response Syntax

{
    'Order': {
        'OutpostId': 'string',
        'OrderId': 'string',
        'Status': 'RECEIVED'|'PENDING'|'PROCESSING'|'INSTALLING'|'FULFILLED'|'CANCELLED',
        'LineItems': [
            {
                'CatalogItemId': 'string',
                'LineItemId': 'string',
                'Quantity': 123,
                'Status': '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.

    • OrderId (string) --

      The ID of the order.

    • Status (string) --

      The status of the order

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

    • PaymentOption (string) --

      The payment option for the order.

    • OrderSubmissionDate (datetime) --

      The submission date for the order.

    • OrderFulfilledDate (datetime) --

      The fulfillment date of the order.