Private5G / Client / get_order

get_order

Private5G.Client.get_order(**kwargs)

Gets the specified order.

See also: AWS API Documentation

Request Syntax

response = client.get_order(
    orderArn='string'
)

Parameters:

orderArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the order.

Return type:

dict

Returns:

Response Syntax

{
    'order': {
        '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'
            },
        ]
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) –

  • order (dict) –

    Information about the 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.

  • tags (dict) –

    The order tags.

    • (string) –

      • (string) –

Exceptions

• Private5G.Client.exceptions.ResourceNotFoundException

• Private5G.Client.exceptions.ValidationException

• Private5G.Client.exceptions.InternalServerException