Outposts / Paginator / ListOrders

ListOrders

class Outposts.Paginator.ListOrders

paginator = client.get_paginator('list_orders')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Outposts.Client.list_orders().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OutpostIdentifierFilter='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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)
        },
    ],

}

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.