ListOrders

class Private5G.Paginator.ListOrders

paginator = client.get_paginator('list_orders')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters={
        'string': [
            'string',
        ]
    },
    networkArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• filters (dict) --

  The filters.

  • NETWORK_SITE - The Amazon Resource Name (ARN) of the network site.
  • STATUS - The status ( ACKNOWLEDGING | ACKNOWLEDGED | UNACKNOWLEDGED ).

  Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.

  • (string) --
    • (list) --
      • (string) --
• networkArn (string) --

  [REQUIRED]

  The Amazon Resource Name (ARN) of the network.

• 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': [
        {
            'acknowledgmentStatus': 'ACKNOWLEDGING'|'ACKNOWLEDGED'|'UNACKNOWLEDGED',
            'createdAt': datetime(2015, 1, 1),
            'networkArn': 'string',
            'networkSiteArn': 'string',
            'orderArn': 'string',
            'shippingAddress': {
                'city': 'string',
                'company': 'string',
                'country': 'string',
                'name': 'string',
                'phoneNumber': 'string',
                'postalCode': 'string',
                'stateOrProvince': 'string',
                'street1': 'string',
                'street2': 'string',
                'street3': 'string'
            },
            'trackingInformation': [
                {
                    'trackingNumber': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • orders (list) --

    Information about the orders.

    • (dict) --

      Information about an order.

      • acknowledgmentStatus (string) --

        The acknowledgement status of the order.

      • createdAt (datetime) --

        The creation time of the order.

      • networkArn (string) --

        The Amazon Resource Name (ARN) of the network associated with this order.

      • networkSiteArn (string) --

        The Amazon Resource Name (ARN) of the network site associated with this order.

      • orderArn (string) --

        The Amazon Resource Name (ARN) of the order.

      • shippingAddress (dict) --

        The shipping address of the order.

        • city (string) --

          The city for this address.

        • company (string) --

          The company name for this address.

        • country (string) --

          The country for this address.

        • name (string) --

          The recipient's name for this address.

        • phoneNumber (string) --

          The phone number for this address.

        • postalCode (string) --

          The postal code for this address.

        • stateOrProvince (string) --

          The state or province for this address.

        • street1 (string) --

          The first line of the street address.

        • street2 (string) --

          The second line of the street address.

        • street3 (string) --

          The third line of the street address.

      • trackingInformation (list) --

        The tracking information of the order.

        • (dict) --

          Information about tracking a shipment.

          • trackingNumber (string) --

            The tracking number of the shipment.

  • NextToken (string) --

    A token to resume pagination.