Outposts / Client / list_orders

list_orders#

Outposts.Client.list_orders(**kwargs)#

Lists the Outpost orders for your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_orders(
    OutpostIdentifierFilter='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • OutpostIdentifierFilter (string) – The ID or the Amazon Resource Name (ARN) of the Outpost.

  • NextToken (string) – The pagination token.

  • MaxResults (integer) – The maximum page size.

Return type:

dict

Returns:

Response Syntax

{
    'Orders': [
        {
            'OutpostId': 'string',
            'OrderId': 'string',
            'OrderType': 'OUTPOST'|'REPLACEMENT',
            'Status': 'RECEIVED'|'PENDING'|'PROCESSING'|'INSTALLING'|'FULFILLED'|'CANCELLED'|'PREPARING'|'IN_PROGRESS'|'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.

Exceptions

  • Outposts.Client.exceptions.ValidationException

  • Outposts.Client.exceptions.NotFoundException

  • Outposts.Client.exceptions.AccessDeniedException

  • Outposts.Client.exceptions.InternalServerException