Private5G / Client / list_orders

list_orders#

Private5G.Client.list_orders(**kwargs)#

Lists orders. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or the status of the order.

If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.

See also: AWS API Documentation

Request Syntax

response = client.list_orders(
    filters={
        'string': [
            'string',
        ]
    },
    maxResults=123,
    networkArn='string',
    startToken='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) –

  • maxResults (integer) – The maximum number of results to return.

  • networkArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the network.

  • startToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'orders': [
        {
            'acknowledgmentStatus': 'ACKNOWLEDGING'|'ACKNOWLEDGED'|'UNACKNOWLEDGED',
            'createdAt': datetime(2015, 1, 1),
            'networkArn': 'string',
            'networkSiteArn': 'string',
            'orderArn': 'string',
            'orderedResources': [
                {
                    'commitmentConfiguration': {
                        'automaticRenewal': True|False,
                        'commitmentLength': 'SIXTY_DAYS'|'ONE_YEAR'|'THREE_YEARS'
                    },
                    'count': 123,
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ],
            'shippingAddress': {
                'city': 'string',
                'company': 'string',
                'country': 'string',
                'emailAddress': 'string',
                'name': 'string',
                'phoneNumber': 'string',
                'postalCode': 'string',
                'stateOrProvince': 'string',
                'street1': 'string',
                'street2': 'string',
                'street3': 'string'
            },
            'trackingInformation': [
                {
                    'trackingNumber': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The token for the next page of results.

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

        • orderedResources (list) –

          A list of the network resources placed in the order.

          • (dict) –

            Details of the network resources in the order.

            • commitmentConfiguration (dict) –

              The duration and renewal status of the commitment period for each radio unit in the order. Does not show details if the resource type is DEVICE_IDENTIFIER.

              • automaticRenewal (boolean) –

                Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.

                Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.

                You can do the following:

                • Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.

                • Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.

                • Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.

                You cannot use the automatic-renewal option for a 60-day commitment.

              • commitmentLength (string) –

                The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.

            • count (integer) –

              The number of network resources in the order.

            • type (string) –

              The type of network resource in 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.

          • emailAddress (string) –

            The recipient’s email address.

          • name (string) –

            The recipient’s name for this address.

          • phoneNumber (string) –

            The recipient’s phone number.

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

Exceptions