Private5G

Client

class Private5G.Client

A low-level client representing AWS Private 5G

Amazon Web Services Private 5G is a managed service that makes it easy to deploy, operate, and scale your own private mobile network at your on-premises location. Private 5G provides the pre-configured hardware and software for mobile networks, helps automate setup, and scales capacity on demand to support additional devices as needed.

client = session.create_client('privatenetworks')

These are the available methods:

acknowledge_order_receipt(**kwargs)

Acknowledges that the specified network order was received.

See also: AWS API Documentation

Request Syntax

response = client.acknowledge_order_receipt(
    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'
            },
        ]
    }
}

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.

Exceptions

activate_device_identifier(**kwargs)

Activates the specified device identifier.

See also: AWS API Documentation

Request Syntax

response = client.activate_device_identifier(
    clientToken='string',
    deviceIdentifierArn='string'
)
Parameters
  • clientToken (string) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency .
  • deviceIdentifierArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the device identifier.

Return type

dict

Returns

Response Syntax

{
    'deviceIdentifier': {
        'createdAt': datetime(2015, 1, 1),
        'deviceIdentifierArn': 'string',
        'iccid': 'string',
        'imsi': 'string',
        'networkArn': 'string',
        'orderArn': 'string',
        'status': 'ACTIVE'|'INACTIVE',
        'trafficGroupArn': 'string',
        'vendor': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • deviceIdentifier (dict) --

      Information about the device identifier.

      • createdAt (datetime) --

        The creation time of this device identifier.

      • deviceIdentifierArn (string) --

        The Amazon Resource Name (ARN) of the device identifier.

      • iccid (string) --

        The Integrated Circuit Card Identifier of the device identifier.

      • imsi (string) --

        The International Mobile Subscriber Identity of the device identifier.

      • networkArn (string) --

        The Amazon Resource Name (ARN) of the network on which the device identifier appears.

      • orderArn (string) --

        The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

      • status (string) --

        The status of the device identifier.

      • trafficGroupArn (string) --

        The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

      • vendor (string) --

        The vendor of the device identifier.

    • tags (dict) --

      The tags on the device identifier.

      • (string) --
        • (string) --

Exceptions

activate_network_site(**kwargs)

Activates the specified network site.

See also: AWS API Documentation

Request Syntax

response = client.activate_network_site(
    clientToken='string',
    networkSiteArn='string',
    shippingAddress={
        'city': 'string',
        'company': 'string',
        'country': 'string',
        'name': 'string',
        'phoneNumber': 'string',
        'postalCode': 'string',
        'stateOrProvince': 'string',
        'street1': 'string',
        'street2': 'string',
        'street3': 'string'
    }
)
Parameters
  • clientToken (string) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency .
  • networkSiteArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the network site.

  • shippingAddress (dict) --

    [REQUIRED]

    The shipping address of the network site.

    • city (string) -- [REQUIRED]

      The city for this address.

    • company (string) --

      The company name for this address.

    • country (string) -- [REQUIRED]

      The country for this address.

    • name (string) -- [REQUIRED]

      The recipient's name for this address.

    • phoneNumber (string) --

      The phone number for this address.

    • postalCode (string) -- [REQUIRED]

      The postal code for this address.

    • stateOrProvince (string) -- [REQUIRED]

      The state or province for this address.

    • street1 (string) -- [REQUIRED]

      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.

Return type

dict

Returns

Response Syntax

{
    'networkSite': {
        'availabilityZone': 'string',
        'availabilityZoneId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'currentPlan': {
            'options': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'resourceDefinitions': [
                {
                    'count': 123,
                    'options': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ]
        },
        'description': 'string',
        'networkArn': 'string',
        'networkSiteArn': 'string',
        'networkSiteName': 'string',
        'pendingPlan': {
            'options': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'resourceDefinitions': [
                {
                    'count': 123,
                    'options': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ]
        },
        'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
        'statusReason': 'string'
    }
}

Response Structure

  • (dict) --

    • networkSite (dict) --

      Information about the network site.

      • availabilityZone (string) --

        The parent Availability Zone for the network site.

      • availabilityZoneId (string) --

        The parent Availability Zone ID for the network site.

      • createdAt (datetime) --

        The creation time of the network site.

      • currentPlan (dict) --

        The current plan of the network site.

        • options (list) --

          The options of the plan.

          • (dict) --

            Information about a name/value pair.

            • name (string) --

              The name of the pair.

            • value (string) --

              The value of the pair.

        • resourceDefinitions (list) --

          The resource definitions of the plan.

          • (dict) --

            Information about a network resource definition.

            • count (integer) --

              The count in the network resource definition.

            • options (list) --

              The options in the network resource definition.

              • (dict) --

                Information about a name/value pair.

                • name (string) --

                  The name of the pair.

                • value (string) --

                  The value of the pair.

            • type (string) --

              The type in the network resource definition.

      • description (string) --

        The description of the network site.

      • networkArn (string) --

        The Amazon Resource Name (ARN) of the network to which the network site belongs.

      • networkSiteArn (string) --

        The Amazon Resource Name (ARN) of the network site.

      • networkSiteName (string) --

        The name of the network site.

      • pendingPlan (dict) --

        The pending plan of the network site.

        • options (list) --

          The options of the plan.

          • (dict) --

            Information about a name/value pair.

            • name (string) --

              The name of the pair.

            • value (string) --

              The value of the pair.

        • resourceDefinitions (list) --

          The resource definitions of the plan.

          • (dict) --

            Information about a network resource definition.

            • count (integer) --

              The count in the network resource definition.

            • options (list) --

              The options in the network resource definition.

              • (dict) --

                Information about a name/value pair.

                • name (string) --

                  The name of the pair.

                • value (string) --

                  The value of the pair.

            • type (string) --

              The type in the network resource definition.

      • status (string) --

        The status of the network site.

      • statusReason (string) --

        The status reason of the network site.

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

configure_access_point(**kwargs)

Configures the specified network resource.

Use this action to specify the geographic position of the hardware. You must provide Certified Professional Installer (CPI) credentials in the request so that we can obtain spectrum grants. For more information, see Radio units in the Amazon Web Services Private 5G User Guide .

See also: AWS API Documentation

Request Syntax

response = client.configure_access_point(
    accessPointArn='string',
    cpiSecretKey='string',
    cpiUserId='string',
    cpiUserPassword='string',
    cpiUsername='string',
    position={
        'elevation': 123.0,
        'elevationReference': 'AGL'|'AMSL',
        'elevationUnit': 'FEET',
        'latitude': 123.0,
        'longitude': 123.0
    }
)
Parameters
  • accessPointArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the network resource.

  • cpiSecretKey (string) -- A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource.
  • cpiUserId (string) -- The CPI user ID of the CPI user who is certifying the coordinates of the network resource.
  • cpiUserPassword (string) -- The CPI password associated with the CPI certificate in cpiSecretKey .
  • cpiUsername (string) -- The CPI user name of the CPI user who is certifying the coordinates of the radio unit.
  • position (dict) --

    The position of the network resource.

    • elevation (float) --

      The elevation of the equipment at this position.

    • elevationReference (string) --

      The reference point from which elevation is reported.

    • elevationUnit (string) --

      The units used to measure the elevation of the position.

    • latitude (float) --

      The latitude of the position.

    • longitude (float) --

      The longitude of the position.

Return type

dict

Returns

Response Syntax

{
    'accessPoint': {
        'attributes': [
            {
                'name': 'string',
                'value': 'string'
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'health': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
        'model': 'string',
        'networkArn': 'string',
        'networkResourceArn': 'string',
        'networkSiteArn': 'string',
        'orderArn': 'string',
        'position': {
            'elevation': 123.0,
            'elevationReference': 'AGL'|'AMSL',
            'elevationUnit': 'FEET',
            'latitude': 123.0,
            'longitude': 123.0
        },
        'serialNumber': 'string',
        'status': 'PENDING'|'SHIPPED'|'PROVISIONING'|'PROVISIONED'|'AVAILABLE'|'DELETING'|'PENDING_RETURN'|'DELETED',
        'statusReason': 'string',
        'type': 'RADIO_UNIT',
        'vendor': 'string'
    }
}

Response Structure

  • (dict) --

    • accessPoint (dict) --

      Information about the network resource.

      • attributes (list) --

        The attributes of the network resource.

        • (dict) --

          Information about a name/value pair.

          • name (string) --

            The name of the pair.

          • value (string) --

            The value of the pair.

      • createdAt (datetime) --

        The creation time of the network resource.

      • description (string) --

        The description of the network resource.

      • health (string) --

        The health of the network resource.

      • model (string) --

        The model of the network resource.

      • networkArn (string) --

        The Amazon Resource Name (ARN) of the network on which this network resource appears.

      • networkResourceArn (string) --

        The Amazon Resource Name (ARN) of the network resource.

      • networkSiteArn (string) --

        The Amazon Resource Name (ARN) of the network site on which this network resource appears.

      • orderArn (string) --

        The Amazon Resource Name (ARN) of the order used to purchase this network resource.

      • position (dict) --

        The position of the network resource.

        • elevation (float) --

          The elevation of the equipment at this position.

        • elevationReference (string) --

          The reference point from which elevation is reported.

        • elevationUnit (string) --

          The units used to measure the elevation of the position.

        • latitude (float) --

          The latitude of the position.

        • longitude (float) --

          The longitude of the position.

      • serialNumber (string) --

        The serial number of the network resource.

      • status (string) --

        The status of the network resource.

      • statusReason (string) --

        The status reason of the network resource.

      • type (string) --

        The type of the network resource.

      • vendor (string) --

        The vendor of the network resource.

Exceptions

create_network(**kwargs)

Creates a network.

See also: AWS API Documentation

Request Syntax

response = client.create_network(
    clientToken='string',
    description='string',
    networkName='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • clientToken (string) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency .
  • description (string) -- The description of the network.
  • networkName (string) --

    [REQUIRED]

    The name of the network. You can't change the name after you create the network.

  • tags (dict) --

    The tags to apply to the network.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'network': {
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'networkArn': 'string',
        'networkName': 'string',
        'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
        'statusReason': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • network (dict) --

      Information about the network.

      • createdAt (datetime) --

        The creation time of the network.

      • description (string) --

        The description of the network.

      • networkArn (string) --

        The Amazon Resource Name (ARN) of the network.

      • networkName (string) --

        The name of the network.

      • status (string) --

        The status of the network.

      • statusReason (string) --

        The status reason of the network.

    • tags (dict) --

      The network tags.

      • (string) --
        • (string) --

Exceptions

create_network_site(**kwargs)

Creates a network site.

See also: AWS API Documentation

Request Syntax

response = client.create_network_site(
    availabilityZone='string',
    availabilityZoneId='string',
    clientToken='string',
    description='string',
    networkArn='string',
    networkSiteName='string',
    pendingPlan={
        'options': [
            {
                'name': 'string',
                'value': 'string'
            },
        ],
        'resourceDefinitions': [
            {
                'count': 123,
                'options': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
            },
        ]
    },
    tags={
        'string': 'string'
    }
)
Parameters
  • availabilityZone (string) -- The Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.
  • availabilityZoneId (string) -- The ID of the Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.
  • clientToken (string) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency .
  • description (string) -- The description of the site.
  • networkArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the network.

  • networkSiteName (string) --

    [REQUIRED]

    The name of the site. You can't change the name after you create the site.

  • pendingPlan (dict) --

    Information about the pending plan for this site.

    • options (list) --

      The options of the plan.

      • (dict) --

        Information about a name/value pair.

        • name (string) -- [REQUIRED]

          The name of the pair.

        • value (string) --

          The value of the pair.

    • resourceDefinitions (list) --

      The resource definitions of the plan.

      • (dict) --

        Information about a network resource definition.

        • count (integer) -- [REQUIRED]

          The count in the network resource definition.

        • options (list) --

          The options in the network resource definition.

          • (dict) --

            Information about a name/value pair.

            • name (string) -- [REQUIRED]

              The name of the pair.

            • value (string) --

              The value of the pair.

        • type (string) -- [REQUIRED]

          The type in the network resource definition.

  • tags (dict) --

    The tags to apply to the network site.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'networkSite': {
        'availabilityZone': 'string',
        'availabilityZoneId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'currentPlan': {
            'options': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'resourceDefinitions': [
                {
                    'count': 123,
                    'options': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ]
        },
        'description': 'string',
        'networkArn': 'string',
        'networkSiteArn': 'string',
        'networkSiteName': 'string',
        'pendingPlan': {
            'options': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'resourceDefinitions': [
                {
                    'count': 123,
                    'options': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ]
        },
        'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
        'statusReason': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • networkSite (dict) --

      Information about the network site.

      • availabilityZone (string) --

        The parent Availability Zone for the network site.

      • availabilityZoneId (string) --

        The parent Availability Zone ID for the network site.

      • createdAt (datetime) --

        The creation time of the network site.

      • currentPlan (dict) --

        The current plan of the network site.

        • options (list) --

          The options of the plan.

          • (dict) --

            Information about a name/value pair.

            • name (string) --

              The name of the pair.

            • value (string) --

              The value of the pair.

        • resourceDefinitions (list) --

          The resource definitions of the plan.

          • (dict) --

            Information about a network resource definition.

            • count (integer) --

              The count in the network resource definition.

            • options (list) --

              The options in the network resource definition.

              • (dict) --

                Information about a name/value pair.

                • name (string) --

                  The name of the pair.

                • value (string) --

                  The value of the pair.

            • type (string) --

              The type in the network resource definition.

      • description (string) --

        The description of the network site.

      • networkArn (string) --

        The Amazon Resource Name (ARN) of the network to which the network site belongs.

      • networkSiteArn (string) --

        The Amazon Resource Name (ARN) of the network site.

      • networkSiteName (string) --

        The name of the network site.

      • pendingPlan (dict) --

        The pending plan of the network site.

        • options (list) --

          The options of the plan.

          • (dict) --

            Information about a name/value pair.

            • name (string) --

              The name of the pair.

            • value (string) --

              The value of the pair.

        • resourceDefinitions (list) --

          The resource definitions of the plan.

          • (dict) --

            Information about a network resource definition.

            • count (integer) --

              The count in the network resource definition.

            • options (list) --

              The options in the network resource definition.

              • (dict) --

                Information about a name/value pair.

                • name (string) --

                  The name of the pair.

                • value (string) --

                  The value of the pair.

            • type (string) --

              The type in the network resource definition.

      • status (string) --

        The status of the network site.

      • statusReason (string) --

        The status reason of the network site.

    • tags (dict) --

      The network site tags.

      • (string) --
        • (string) --

Exceptions

deactivate_device_identifier(**kwargs)

Deactivates the specified device identifier.

See also: AWS API Documentation

Request Syntax

response = client.deactivate_device_identifier(
    clientToken='string',
    deviceIdentifierArn='string'
)
Parameters
  • clientToken (string) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency .
  • deviceIdentifierArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the device identifier.

Return type

dict

Returns

Response Syntax

{
    'deviceIdentifier': {
        'createdAt': datetime(2015, 1, 1),
        'deviceIdentifierArn': 'string',
        'iccid': 'string',
        'imsi': 'string',
        'networkArn': 'string',
        'orderArn': 'string',
        'status': 'ACTIVE'|'INACTIVE',
        'trafficGroupArn': 'string',
        'vendor': 'string'
    }
}

Response Structure

  • (dict) --

    • deviceIdentifier (dict) --

      Information about the device identifier.

      • createdAt (datetime) --

        The creation time of this device identifier.

      • deviceIdentifierArn (string) --

        The Amazon Resource Name (ARN) of the device identifier.

      • iccid (string) --

        The Integrated Circuit Card Identifier of the device identifier.

      • imsi (string) --

        The International Mobile Subscriber Identity of the device identifier.

      • networkArn (string) --

        The Amazon Resource Name (ARN) of the network on which the device identifier appears.

      • orderArn (string) --

        The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

      • status (string) --

        The status of the device identifier.

      • trafficGroupArn (string) --

        The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

      • vendor (string) --

        The vendor of the device identifier.

Exceptions

delete_network(**kwargs)

Deletes the specified network. You must delete network sites before you delete the network. For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services Private 5G .

See also: AWS API Documentation

Request Syntax

response = client.delete_network(
    clientToken='string',
    networkArn='string'
)
Parameters
  • clientToken (string) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency .
  • networkArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the network.

Return type

dict

Returns

Response Syntax

{
    'network': {
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'networkArn': 'string',
        'networkName': 'string',
        'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
        'statusReason': 'string'
    }
}

Response Structure

  • (dict) --

    • network (dict) --

      Information about the network.

      • createdAt (datetime) --

        The creation time of the network.

      • description (string) --

        The description of the network.

      • networkArn (string) --

        The Amazon Resource Name (ARN) of the network.

      • networkName (string) --

        The name of the network.

      • status (string) --

        The status of the network.

      • statusReason (string) --

        The status reason of the network.

Exceptions

delete_network_site(**kwargs)

Deletes the specified network site. Return the hardware after you delete the network site. You are responsible for minimum charges. For more information, see Hardware returns in the Amazon Web Services Private 5G User Guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_network_site(
    clientToken='string',
    networkSiteArn='string'
)
Parameters
  • clientToken (string) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency .
  • networkSiteArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the network site.

Return type

dict

Returns

Response Syntax

{
    'networkSite': {
        'availabilityZone': 'string',
        'availabilityZoneId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'currentPlan': {
            'options': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'resourceDefinitions': [
                {
                    'count': 123,
                    'options': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ]
        },
        'description': 'string',
        'networkArn': 'string',
        'networkSiteArn': 'string',
        'networkSiteName': 'string',
        'pendingPlan': {
            'options': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'resourceDefinitions': [
                {
                    'count': 123,
                    'options': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ]
        },
        'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
        'statusReason': 'string'
    }
}

Response Structure

  • (dict) --

    • networkSite (dict) --

      Information about the network site.

      • availabilityZone (string) --

        The parent Availability Zone for the network site.

      • availabilityZoneId (string) --

        The parent Availability Zone ID for the network site.

      • createdAt (datetime) --

        The creation time of the network site.

      • currentPlan (dict) --

        The current plan of the network site.

        • options (list) --

          The options of the plan.

          • (dict) --

            Information about a name/value pair.

            • name (string) --

              The name of the pair.

            • value (string) --

              The value of the pair.

        • resourceDefinitions (list) --

          The resource definitions of the plan.

          • (dict) --

            Information about a network resource definition.

            • count (integer) --

              The count in the network resource definition.

            • options (list) --

              The options in the network resource definition.

              • (dict) --

                Information about a name/value pair.

                • name (string) --

                  The name of the pair.

                • value (string) --

                  The value of the pair.

            • type (string) --

              The type in the network resource definition.

      • description (string) --

        The description of the network site.

      • networkArn (string) --

        The Amazon Resource Name (ARN) of the network to which the network site belongs.

      • networkSiteArn (string) --

        The Amazon Resource Name (ARN) of the network site.

      • networkSiteName (string) --

        The name of the network site.

      • pendingPlan (dict) --

        The pending plan of the network site.

        • options (list) --

          The options of the plan.

          • (dict) --

            Information about a name/value pair.

            • name (string) --

              The name of the pair.

            • value (string) --

              The value of the pair.

        • resourceDefinitions (list) --

          The resource definitions of the plan.

          • (dict) --

            Information about a network resource definition.

            • count (integer) --

              The count in the network resource definition.

            • options (list) --

              The options in the network resource definition.

              • (dict) --

                Information about a name/value pair.

                • name (string) --

                  The name of the pair.

                • value (string) --

                  The value of the pair.

            • type (string) --

              The type in the network resource definition.

      • status (string) --

        The status of the network site.

      • statusReason (string) --

        The status reason of the network site.

Exceptions

get_device_identifier(**kwargs)

Gets the specified device identifier.

See also: AWS API Documentation

Request Syntax

response = client.get_device_identifier(
    deviceIdentifierArn='string'
)
Parameters
deviceIdentifierArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the device identifier.

Return type
dict
Returns
Response Syntax
{
    'deviceIdentifier': {
        'createdAt': datetime(2015, 1, 1),
        'deviceIdentifierArn': 'string',
        'iccid': 'string',
        'imsi': 'string',
        'networkArn': 'string',
        'orderArn': 'string',
        'status': 'ACTIVE'|'INACTIVE',
        'trafficGroupArn': 'string',
        'vendor': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • deviceIdentifier (dict) --

      Information about the device identifier.

      • createdAt (datetime) --

        The creation time of this device identifier.

      • deviceIdentifierArn (string) --

        The Amazon Resource Name (ARN) of the device identifier.

      • iccid (string) --

        The Integrated Circuit Card Identifier of the device identifier.

      • imsi (string) --

        The International Mobile Subscriber Identity of the device identifier.

      • networkArn (string) --

        The Amazon Resource Name (ARN) of the network on which the device identifier appears.

      • orderArn (string) --

        The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

      • status (string) --

        The status of the device identifier.

      • trafficGroupArn (string) --

        The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

      • vendor (string) --

        The vendor of the device identifier.

    • tags (dict) --

      The device identifier tags.

      • (string) --
        • (string) --

Exceptions

get_network(**kwargs)

Gets the specified network.

See also: AWS API Documentation

Request Syntax

response = client.get_network(
    networkArn='string'
)
Parameters
networkArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the network.

Return type
dict
Returns
Response Syntax
{
    'network': {
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'networkArn': 'string',
        'networkName': 'string',
        'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
        'statusReason': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • network (dict) --

      Information about the network.

      • createdAt (datetime) --

        The creation time of the network.

      • description (string) --

        The description of the network.

      • networkArn (string) --

        The Amazon Resource Name (ARN) of the network.

      • networkName (string) --

        The name of the network.

      • status (string) --

        The status of the network.

      • statusReason (string) --

        The status reason of the network.

    • tags (dict) --

      The network tags.

      • (string) --
        • (string) --

Exceptions

get_network_resource(**kwargs)

Gets the specified network resource.

See also: AWS API Documentation

Request Syntax

response = client.get_network_resource(
    networkResourceArn='string'
)
Parameters
networkResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the network resource.

Return type
dict
Returns
Response Syntax
{
    'networkResource': {
        'attributes': [
            {
                'name': 'string',
                'value': 'string'
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'health': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
        'model': 'string',
        'networkArn': 'string',
        'networkResourceArn': 'string',
        'networkSiteArn': 'string',
        'orderArn': 'string',
        'position': {
            'elevation': 123.0,
            'elevationReference': 'AGL'|'AMSL',
            'elevationUnit': 'FEET',
            'latitude': 123.0,
            'longitude': 123.0
        },
        'serialNumber': 'string',
        'status': 'PENDING'|'SHIPPED'|'PROVISIONING'|'PROVISIONED'|'AVAILABLE'|'DELETING'|'PENDING_RETURN'|'DELETED',
        'statusReason': 'string',
        'type': 'RADIO_UNIT',
        'vendor': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • networkResource (dict) --

      Information about the network resource.

      • attributes (list) --

        The attributes of the network resource.

        • (dict) --

          Information about a name/value pair.

          • name (string) --

            The name of the pair.

          • value (string) --

            The value of the pair.

      • createdAt (datetime) --

        The creation time of the network resource.

      • description (string) --

        The description of the network resource.

      • health (string) --

        The health of the network resource.

      • model (string) --

        The model of the network resource.

      • networkArn (string) --

        The Amazon Resource Name (ARN) of the network on which this network resource appears.

      • networkResourceArn (string) --

        The Amazon Resource Name (ARN) of the network resource.

      • networkSiteArn (string) --

        The Amazon Resource Name (ARN) of the network site on which this network resource appears.

      • orderArn (string) --

        The Amazon Resource Name (ARN) of the order used to purchase this network resource.

      • position (dict) --

        The position of the network resource.

        • elevation (float) --

          The elevation of the equipment at this position.

        • elevationReference (string) --

          The reference point from which elevation is reported.

        • elevationUnit (string) --

          The units used to measure the elevation of the position.

        • latitude (float) --

          The latitude of the position.

        • longitude (float) --

          The longitude of the position.

      • serialNumber (string) --

        The serial number of the network resource.

      • status (string) --

        The status of the network resource.

      • statusReason (string) --

        The status reason of the network resource.

      • type (string) --

        The type of the network resource.

      • vendor (string) --

        The vendor of the network resource.

    • tags (dict) --

      The network resource tags.

      • (string) --
        • (string) --

Exceptions

get_network_site(**kwargs)

Gets the specified network site.

See also: AWS API Documentation

Request Syntax

response = client.get_network_site(
    networkSiteArn='string'
)
Parameters
networkSiteArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the network site.

Return type
dict
Returns
Response Syntax
{
    'networkSite': {
        'availabilityZone': 'string',
        'availabilityZoneId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'currentPlan': {
            'options': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'resourceDefinitions': [
                {
                    'count': 123,
                    'options': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ]
        },
        'description': 'string',
        'networkArn': 'string',
        'networkSiteArn': 'string',
        'networkSiteName': 'string',
        'pendingPlan': {
            'options': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'resourceDefinitions': [
                {
                    'count': 123,
                    'options': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ]
        },
        'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
        'statusReason': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • networkSite (dict) --

      Information about the network site.

      • availabilityZone (string) --

        The parent Availability Zone for the network site.

      • availabilityZoneId (string) --

        The parent Availability Zone ID for the network site.

      • createdAt (datetime) --

        The creation time of the network site.

      • currentPlan (dict) --

        The current plan of the network site.

        • options (list) --

          The options of the plan.

          • (dict) --

            Information about a name/value pair.

            • name (string) --

              The name of the pair.

            • value (string) --

              The value of the pair.

        • resourceDefinitions (list) --

          The resource definitions of the plan.

          • (dict) --

            Information about a network resource definition.

            • count (integer) --

              The count in the network resource definition.

            • options (list) --

              The options in the network resource definition.

              • (dict) --

                Information about a name/value pair.

                • name (string) --

                  The name of the pair.

                • value (string) --

                  The value of the pair.

            • type (string) --

              The type in the network resource definition.

      • description (string) --

        The description of the network site.

      • networkArn (string) --

        The Amazon Resource Name (ARN) of the network to which the network site belongs.

      • networkSiteArn (string) --

        The Amazon Resource Name (ARN) of the network site.

      • networkSiteName (string) --

        The name of the network site.

      • pendingPlan (dict) --

        The pending plan of the network site.

        • options (list) --

          The options of the plan.

          • (dict) --

            Information about a name/value pair.

            • name (string) --

              The name of the pair.

            • value (string) --

              The value of the pair.

        • resourceDefinitions (list) --

          The resource definitions of the plan.

          • (dict) --

            Information about a network resource definition.

            • count (integer) --

              The count in the network resource definition.

            • options (list) --

              The options in the network resource definition.

              • (dict) --

                Information about a name/value pair.

                • name (string) --

                  The name of the pair.

                • value (string) --

                  The value of the pair.

            • type (string) --

              The type in the network resource definition.

      • status (string) --

        The status of the network site.

      • statusReason (string) --

        The status reason of the network site.

    • tags (dict) --

      The network site tags.

      • (string) --
        • (string) --

Exceptions

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

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_device_identifiers(**kwargs)

Lists device identifiers. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status of device identifiers, or the ARN of the traffic group.

<p>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_device_identifiers(
    filters={
        'string': [
            'string',
        ]
    },
    maxResults=123,
    networkArn='string',
    startToken='string'
)
Parameters
  • filters (dict) --

    The filters.

    • ORDER - The Amazon Resource Name (ARN) of the order.
    • STATUS - The status (ACTIVE | INACTIVE ).
    • TRAFFIC_GROUP - The Amazon Resource Name (ARN) of the traffic group.

    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

{
    'deviceIdentifiers': [
        {
            'createdAt': datetime(2015, 1, 1),
            'deviceIdentifierArn': 'string',
            'iccid': 'string',
            'imsi': 'string',
            'networkArn': 'string',
            'orderArn': 'string',
            'status': 'ACTIVE'|'INACTIVE',
            'trafficGroupArn': 'string',
            'vendor': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • deviceIdentifiers (list) --

      Information about the device identifiers.

      • (dict) --

        Information about a subscriber of a device that can use a network.

        • createdAt (datetime) --

          The creation time of this device identifier.

        • deviceIdentifierArn (string) --

          The Amazon Resource Name (ARN) of the device identifier.

        • iccid (string) --

          The Integrated Circuit Card Identifier of the device identifier.

        • imsi (string) --

          The International Mobile Subscriber Identity of the device identifier.

        • networkArn (string) --

          The Amazon Resource Name (ARN) of the network on which the device identifier appears.

        • orderArn (string) --

          The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

        • status (string) --

          The status of the device identifier.

        • trafficGroupArn (string) --

          The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

        • vendor (string) --

          The vendor of the device identifier.

    • nextToken (string) --

      The token for the next page of results.

Exceptions

list_network_resources(**kwargs)

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

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_network_resources(
    filters={
        'string': [
            'string',
        ]
    },
    maxResults=123,
    networkArn='string',
    startToken='string'
)
Parameters
  • filters (dict) --

    The filters.

    • ORDER - The Amazon Resource Name (ARN) of the order.
    • STATUS - The status (AVAILABLE | DELETED | DELETING | PENDING | PENDING_RETURN | PROVISIONING | SHIPPED ).

    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

{
    'networkResources': [
        {
            'attributes': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'health': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
            'model': 'string',
            'networkArn': 'string',
            'networkResourceArn': 'string',
            'networkSiteArn': 'string',
            'orderArn': 'string',
            'position': {
                'elevation': 123.0,
                'elevationReference': 'AGL'|'AMSL',
                'elevationUnit': 'FEET',
                'latitude': 123.0,
                'longitude': 123.0
            },
            'serialNumber': 'string',
            'status': 'PENDING'|'SHIPPED'|'PROVISIONING'|'PROVISIONED'|'AVAILABLE'|'DELETING'|'PENDING_RETURN'|'DELETED',
            'statusReason': 'string',
            'type': 'RADIO_UNIT',
            'vendor': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • networkResources (list) --

      Information about network resources.

      • (dict) --

        Information about a network resource.

        • attributes (list) --

          The attributes of the network resource.

          • (dict) --

            Information about a name/value pair.

            • name (string) --

              The name of the pair.

            • value (string) --

              The value of the pair.

        • createdAt (datetime) --

          The creation time of the network resource.

        • description (string) --

          The description of the network resource.

        • health (string) --

          The health of the network resource.

        • model (string) --

          The model of the network resource.

        • networkArn (string) --

          The Amazon Resource Name (ARN) of the network on which this network resource appears.

        • networkResourceArn (string) --

          The Amazon Resource Name (ARN) of the network resource.

        • networkSiteArn (string) --

          The Amazon Resource Name (ARN) of the network site on which this network resource appears.

        • orderArn (string) --

          The Amazon Resource Name (ARN) of the order used to purchase this network resource.

        • position (dict) --

          The position of the network resource.

          • elevation (float) --

            The elevation of the equipment at this position.

          • elevationReference (string) --

            The reference point from which elevation is reported.

          • elevationUnit (string) --

            The units used to measure the elevation of the position.

          • latitude (float) --

            The latitude of the position.

          • longitude (float) --

            The longitude of the position.

        • serialNumber (string) --

          The serial number of the network resource.

        • status (string) --

          The status of the network resource.

        • statusReason (string) --

          The status reason of the network resource.

        • type (string) --

          The type of the network resource.

        • vendor (string) --

          The vendor of the network resource.

    • nextToken (string) --

      The token for the next page of results.

Exceptions

list_network_sites(**kwargs)

Lists network sites. Add filters to your request to return a more specific list of results. Use filters to match the status of the network site.

See also: AWS API Documentation

Request Syntax

response = client.list_network_sites(
    filters={
        'string': [
            'string',
        ]
    },
    maxResults=123,
    networkArn='string',
    startToken='string'
)
Parameters
  • filters (dict) --

    The filters. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.

    • STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING ).

    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

{
    'networkSites': [
        {
            'availabilityZone': 'string',
            'availabilityZoneId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'currentPlan': {
                'options': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'resourceDefinitions': [
                    {
                        'count': 123,
                        'options': [
                            {
                                'name': 'string',
                                'value': 'string'
                            },
                        ],
                        'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                    },
                ]
            },
            'description': 'string',
            'networkArn': 'string',
            'networkSiteArn': 'string',
            'networkSiteName': 'string',
            'pendingPlan': {
                'options': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'resourceDefinitions': [
                    {
                        'count': 123,
                        'options': [
                            {
                                'name': 'string',
                                'value': 'string'
                            },
                        ],
                        'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                    },
                ]
            },
            'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
            'statusReason': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • networkSites (list) --

      Information about the network sites.

      • (dict) --

        Information about a network site.

        • availabilityZone (string) --

          The parent Availability Zone for the network site.

        • availabilityZoneId (string) --

          The parent Availability Zone ID for the network site.

        • createdAt (datetime) --

          The creation time of the network site.

        • currentPlan (dict) --

          The current plan of the network site.

          • options (list) --

            The options of the plan.

            • (dict) --

              Information about a name/value pair.

              • name (string) --

                The name of the pair.

              • value (string) --

                The value of the pair.

          • resourceDefinitions (list) --

            The resource definitions of the plan.

            • (dict) --

              Information about a network resource definition.

              • count (integer) --

                The count in the network resource definition.

              • options (list) --

                The options in the network resource definition.

                • (dict) --

                  Information about a name/value pair.

                  • name (string) --

                    The name of the pair.

                  • value (string) --

                    The value of the pair.

              • type (string) --

                The type in the network resource definition.

        • description (string) --

          The description of the network site.

        • networkArn (string) --

          The Amazon Resource Name (ARN) of the network to which the network site belongs.

        • networkSiteArn (string) --

          The Amazon Resource Name (ARN) of the network site.

        • networkSiteName (string) --

          The name of the network site.

        • pendingPlan (dict) --

          The pending plan of the network site.

          • options (list) --

            The options of the plan.

            • (dict) --

              Information about a name/value pair.

              • name (string) --

                The name of the pair.

              • value (string) --

                The value of the pair.

          • resourceDefinitions (list) --

            The resource definitions of the plan.

            • (dict) --

              Information about a network resource definition.

              • count (integer) --

                The count in the network resource definition.

              • options (list) --

                The options in the network resource definition.

                • (dict) --

                  Information about a name/value pair.

                  • name (string) --

                    The name of the pair.

                  • value (string) --

                    The value of the pair.

              • type (string) --

                The type in the network resource definition.

        • status (string) --

          The status of the network site.

        • statusReason (string) --

          The status reason of the network site.

    • nextToken (string) --

      The token for the next page of results.

Exceptions

list_networks(**kwargs)

Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network.

See also: AWS API Documentation

Request Syntax

response = client.list_networks(
    filters={
        'string': [
            'string',
        ]
    },
    maxResults=123,
    startToken='string'
)
Parameters
  • filters (dict) --

    The filters.

    • STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING ).

    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.
  • startToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'networks': [
        {
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'networkArn': 'string',
            'networkName': 'string',
            'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
            'statusReason': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • networks (list) --

      The networks.

      • (dict) --

        Information about a network.

        • createdAt (datetime) --

          The creation time of the network.

        • description (string) --

          The description of the network.

        • networkArn (string) --

          The Amazon Resource Name (ARN) of the network.

        • networkName (string) --

          The name of the network.

        • status (string) --

          The status of the network.

        • statusReason (string) --

          The status reason of the network.

    • nextToken (string) --

      The token for the next page of results.

Exceptions

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',
            'shippingAddress': {
                'city': 'string',
                'company': 'string',
                'country': '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.

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

Exceptions

list_tags_for_resource(**kwargs)

Lists the tags for the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)
Parameters
resourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

Return type
dict
Returns
Response Syntax
{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • tags (dict) --

      The resource tags.

      • (string) --
        • (string) --

Exceptions

ping()

Checks the health of the service.

See also: AWS API Documentation

Request Syntax

response = client.ping()
Return type
dict
Returns
Response Syntax
{
    'status': 'string'
}

Response Structure

  • (dict) --
    • status (string) --

      Information about the health of the service.

Exceptions

tag_resource(**kwargs)

Adds tags to the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • tags (dict) --

    [REQUIRED]

    The tags to add to the resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes tags from the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • tagKeys (list) --

    [REQUIRED]

    The tag keys.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_network_site(**kwargs)

Updates the specified network site.

See also: AWS API Documentation

Request Syntax

response = client.update_network_site(
    clientToken='string',
    description='string',
    networkSiteArn='string'
)
Parameters
  • clientToken (string) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency .
  • description (string) -- The description.
  • networkSiteArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the network site.

Return type

dict

Returns

Response Syntax

{
    'networkSite': {
        'availabilityZone': 'string',
        'availabilityZoneId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'currentPlan': {
            'options': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'resourceDefinitions': [
                {
                    'count': 123,
                    'options': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ]
        },
        'description': 'string',
        'networkArn': 'string',
        'networkSiteArn': 'string',
        'networkSiteName': 'string',
        'pendingPlan': {
            'options': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'resourceDefinitions': [
                {
                    'count': 123,
                    'options': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ]
        },
        'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
        'statusReason': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • networkSite (dict) --

      Information about the network site.

      • availabilityZone (string) --

        The parent Availability Zone for the network site.

      • availabilityZoneId (string) --

        The parent Availability Zone ID for the network site.

      • createdAt (datetime) --

        The creation time of the network site.

      • currentPlan (dict) --

        The current plan of the network site.

        • options (list) --

          The options of the plan.

          • (dict) --

            Information about a name/value pair.

            • name (string) --

              The name of the pair.

            • value (string) --

              The value of the pair.

        • resourceDefinitions (list) --

          The resource definitions of the plan.

          • (dict) --

            Information about a network resource definition.

            • count (integer) --

              The count in the network resource definition.

            • options (list) --

              The options in the network resource definition.

              • (dict) --

                Information about a name/value pair.

                • name (string) --

                  The name of the pair.

                • value (string) --

                  The value of the pair.

            • type (string) --

              The type in the network resource definition.

      • description (string) --

        The description of the network site.

      • networkArn (string) --

        The Amazon Resource Name (ARN) of the network to which the network site belongs.

      • networkSiteArn (string) --

        The Amazon Resource Name (ARN) of the network site.

      • networkSiteName (string) --

        The name of the network site.

      • pendingPlan (dict) --

        The pending plan of the network site.

        • options (list) --

          The options of the plan.

          • (dict) --

            Information about a name/value pair.

            • name (string) --

              The name of the pair.

            • value (string) --

              The value of the pair.

        • resourceDefinitions (list) --

          The resource definitions of the plan.

          • (dict) --

            Information about a network resource definition.

            • count (integer) --

              The count in the network resource definition.

            • options (list) --

              The options in the network resource definition.

              • (dict) --

                Information about a name/value pair.

                • name (string) --

                  The name of the pair.

                • value (string) --

                  The value of the pair.

            • type (string) --

              The type in the network resource definition.

      • status (string) --

        The status of the network site.

      • statusReason (string) --

        The status reason of the network site.

    • tags (dict) --

      The network site tags.

      • (string) --
        • (string) --

Exceptions

update_network_site_plan(**kwargs)

Updates the specified network site plan.

See also: AWS API Documentation

Request Syntax

response = client.update_network_site_plan(
    clientToken='string',
    networkSiteArn='string',
    pendingPlan={
        'options': [
            {
                'name': 'string',
                'value': 'string'
            },
        ],
        'resourceDefinitions': [
            {
                'count': 123,
                'options': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
            },
        ]
    }
)
Parameters
  • clientToken (string) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency .
  • networkSiteArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the network site.

  • pendingPlan (dict) --

    [REQUIRED]

    The pending plan.

    • options (list) --

      The options of the plan.

      • (dict) --

        Information about a name/value pair.

        • name (string) -- [REQUIRED]

          The name of the pair.

        • value (string) --

          The value of the pair.

    • resourceDefinitions (list) --

      The resource definitions of the plan.

      • (dict) --

        Information about a network resource definition.

        • count (integer) -- [REQUIRED]

          The count in the network resource definition.

        • options (list) --

          The options in the network resource definition.

          • (dict) --

            Information about a name/value pair.

            • name (string) -- [REQUIRED]

              The name of the pair.

            • value (string) --

              The value of the pair.

        • type (string) -- [REQUIRED]

          The type in the network resource definition.

Return type

dict

Returns

Response Syntax

{
    'networkSite': {
        'availabilityZone': 'string',
        'availabilityZoneId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'currentPlan': {
            'options': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'resourceDefinitions': [
                {
                    'count': 123,
                    'options': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ]
        },
        'description': 'string',
        'networkArn': 'string',
        'networkSiteArn': 'string',
        'networkSiteName': 'string',
        'pendingPlan': {
            'options': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'resourceDefinitions': [
                {
                    'count': 123,
                    'options': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ]
        },
        'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
        'statusReason': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • networkSite (dict) --

      Information about the network site.

      • availabilityZone (string) --

        The parent Availability Zone for the network site.

      • availabilityZoneId (string) --

        The parent Availability Zone ID for the network site.

      • createdAt (datetime) --

        The creation time of the network site.

      • currentPlan (dict) --

        The current plan of the network site.

        • options (list) --

          The options of the plan.

          • (dict) --

            Information about a name/value pair.

            • name (string) --

              The name of the pair.

            • value (string) --

              The value of the pair.

        • resourceDefinitions (list) --

          The resource definitions of the plan.

          • (dict) --

            Information about a network resource definition.

            • count (integer) --

              The count in the network resource definition.

            • options (list) --

              The options in the network resource definition.

              • (dict) --

                Information about a name/value pair.

                • name (string) --

                  The name of the pair.

                • value (string) --

                  The value of the pair.

            • type (string) --

              The type in the network resource definition.

      • description (string) --

        The description of the network site.

      • networkArn (string) --

        The Amazon Resource Name (ARN) of the network to which the network site belongs.

      • networkSiteArn (string) --

        The Amazon Resource Name (ARN) of the network site.

      • networkSiteName (string) --

        The name of the network site.

      • pendingPlan (dict) --

        The pending plan of the network site.

        • options (list) --

          The options of the plan.

          • (dict) --

            Information about a name/value pair.

            • name (string) --

              The name of the pair.

            • value (string) --

              The value of the pair.

        • resourceDefinitions (list) --

          The resource definitions of the plan.

          • (dict) --

            Information about a network resource definition.

            • count (integer) --

              The count in the network resource definition.

            • options (list) --

              The options in the network resource definition.

              • (dict) --

                Information about a name/value pair.

                • name (string) --

                  The name of the pair.

                • value (string) --

                  The value of the pair.

            • type (string) --

              The type in the network resource definition.

      • status (string) --

        The status of the network site.

      • statusReason (string) --

        The status reason of the network site.

    • tags (dict) --

      The network site tags.

      • (string) --
        • (string) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class Private5G.Client.exceptions.AccessDeniedException

You do not have permission to perform this operation.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have permission to perform this operation.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Private5G.Client.exceptions.InternalServerException

Information about an internal error.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'retryAfterSeconds': 123,
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Information about an internal error.

    • message (string) --

      Description of the error.

    • retryAfterSeconds (integer) --

      Advice to clients on when the call can be safely retried.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Private5G.Client.exceptions.LimitExceededException

The limit was exceeded.

Example

try:
  ...
except client.exceptions.LimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The limit was exceeded.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Private5G.Client.exceptions.ResourceNotFoundException

The resource was not found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceId': 'string',
    'resourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource was not found.

    • message (string) --

      Description of the error.

    • resourceId (string) --

      Identifier of the affected resource.

    • resourceType (string) --

      Type of the affected resource.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Private5G.Client.exceptions.ThrottlingException

The request was denied due to request throttling.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied due to request throttling.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Private5G.Client.exceptions.ValidationException

The request failed validation.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'fieldList': [
        {
            'message': 'string',
            'name': 'string'
        },
    ],
    'message': 'string',
    'reason': 'UNKNOWN_OPERATION'|'CANNOT_PARSE'|'CANNOT_ASSUME_ROLE'|'FIELD_VALIDATION_FAILED'|'OTHER',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request failed validation.

    • fieldList (list) --

      The list of fields that caused the error, if applicable.

      • (dict) --

        Information about a field that failed validation.

        • message (string) --

          The message about the validation failure.

        • name (string) --

          The field name that failed validation.

    • message (string) --

      Description of the error.

    • reason (string) --

      Reason the request failed validation.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class Private5G.Paginator.ListDeviceIdentifiers
paginator = client.get_paginator('list_device_identifiers')
paginate(**kwargs)

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

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.

    • ORDER - The Amazon Resource Name (ARN) of the order.
    • STATUS - The status (ACTIVE | INACTIVE ).
    • TRAFFIC_GROUP - The Amazon Resource Name (ARN) of the traffic group.

    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

{
    'deviceIdentifiers': [
        {
            'createdAt': datetime(2015, 1, 1),
            'deviceIdentifierArn': 'string',
            'iccid': 'string',
            'imsi': 'string',
            'networkArn': 'string',
            'orderArn': 'string',
            'status': 'ACTIVE'|'INACTIVE',
            'trafficGroupArn': 'string',
            'vendor': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • deviceIdentifiers (list) --

      Information about the device identifiers.

      • (dict) --

        Information about a subscriber of a device that can use a network.

        • createdAt (datetime) --

          The creation time of this device identifier.

        • deviceIdentifierArn (string) --

          The Amazon Resource Name (ARN) of the device identifier.

        • iccid (string) --

          The Integrated Circuit Card Identifier of the device identifier.

        • imsi (string) --

          The International Mobile Subscriber Identity of the device identifier.

        • networkArn (string) --

          The Amazon Resource Name (ARN) of the network on which the device identifier appears.

        • orderArn (string) --

          The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

        • status (string) --

          The status of the device identifier.

        • trafficGroupArn (string) --

          The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

        • vendor (string) --

          The vendor of the device identifier.

    • NextToken (string) --

      A token to resume pagination.

class Private5G.Paginator.ListNetworkResources
paginator = client.get_paginator('list_network_resources')
paginate(**kwargs)

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

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.

    • ORDER - The Amazon Resource Name (ARN) of the order.
    • STATUS - The status (AVAILABLE | DELETED | DELETING | PENDING | PENDING_RETURN | PROVISIONING | SHIPPED ).

    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

{
    'networkResources': [
        {
            'attributes': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'health': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
            'model': 'string',
            'networkArn': 'string',
            'networkResourceArn': 'string',
            'networkSiteArn': 'string',
            'orderArn': 'string',
            'position': {
                'elevation': 123.0,
                'elevationReference': 'AGL'|'AMSL',
                'elevationUnit': 'FEET',
                'latitude': 123.0,
                'longitude': 123.0
            },
            'serialNumber': 'string',
            'status': 'PENDING'|'SHIPPED'|'PROVISIONING'|'PROVISIONED'|'AVAILABLE'|'DELETING'|'PENDING_RETURN'|'DELETED',
            'statusReason': 'string',
            'type': 'RADIO_UNIT',
            'vendor': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • networkResources (list) --

      Information about network resources.

      • (dict) --

        Information about a network resource.

        • attributes (list) --

          The attributes of the network resource.

          • (dict) --

            Information about a name/value pair.

            • name (string) --

              The name of the pair.

            • value (string) --

              The value of the pair.

        • createdAt (datetime) --

          The creation time of the network resource.

        • description (string) --

          The description of the network resource.

        • health (string) --

          The health of the network resource.

        • model (string) --

          The model of the network resource.

        • networkArn (string) --

          The Amazon Resource Name (ARN) of the network on which this network resource appears.

        • networkResourceArn (string) --

          The Amazon Resource Name (ARN) of the network resource.

        • networkSiteArn (string) --

          The Amazon Resource Name (ARN) of the network site on which this network resource appears.

        • orderArn (string) --

          The Amazon Resource Name (ARN) of the order used to purchase this network resource.

        • position (dict) --

          The position of the network resource.

          • elevation (float) --

            The elevation of the equipment at this position.

          • elevationReference (string) --

            The reference point from which elevation is reported.

          • elevationUnit (string) --

            The units used to measure the elevation of the position.

          • latitude (float) --

            The latitude of the position.

          • longitude (float) --

            The longitude of the position.

        • serialNumber (string) --

          The serial number of the network resource.

        • status (string) --

          The status of the network resource.

        • statusReason (string) --

          The status reason of the network resource.

        • type (string) --

          The type of the network resource.

        • vendor (string) --

          The vendor of the network resource.

    • NextToken (string) --

      A token to resume pagination.

class Private5G.Paginator.ListNetworkSites
paginator = client.get_paginator('list_network_sites')
paginate(**kwargs)

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

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. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.

    • STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING ).

    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

{
    'networkSites': [
        {
            'availabilityZone': 'string',
            'availabilityZoneId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'currentPlan': {
                'options': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'resourceDefinitions': [
                    {
                        'count': 123,
                        'options': [
                            {
                                'name': 'string',
                                'value': 'string'
                            },
                        ],
                        'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                    },
                ]
            },
            'description': 'string',
            'networkArn': 'string',
            'networkSiteArn': 'string',
            'networkSiteName': 'string',
            'pendingPlan': {
                'options': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'resourceDefinitions': [
                    {
                        'count': 123,
                        'options': [
                            {
                                'name': 'string',
                                'value': 'string'
                            },
                        ],
                        'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                    },
                ]
            },
            'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
            'statusReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • networkSites (list) --

      Information about the network sites.

      • (dict) --

        Information about a network site.

        • availabilityZone (string) --

          The parent Availability Zone for the network site.

        • availabilityZoneId (string) --

          The parent Availability Zone ID for the network site.

        • createdAt (datetime) --

          The creation time of the network site.

        • currentPlan (dict) --

          The current plan of the network site.

          • options (list) --

            The options of the plan.

            • (dict) --

              Information about a name/value pair.

              • name (string) --

                The name of the pair.

              • value (string) --

                The value of the pair.

          • resourceDefinitions (list) --

            The resource definitions of the plan.

            • (dict) --

              Information about a network resource definition.

              • count (integer) --

                The count in the network resource definition.

              • options (list) --

                The options in the network resource definition.

                • (dict) --

                  Information about a name/value pair.

                  • name (string) --

                    The name of the pair.

                  • value (string) --

                    The value of the pair.

              • type (string) --

                The type in the network resource definition.

        • description (string) --

          The description of the network site.

        • networkArn (string) --

          The Amazon Resource Name (ARN) of the network to which the network site belongs.

        • networkSiteArn (string) --

          The Amazon Resource Name (ARN) of the network site.

        • networkSiteName (string) --

          The name of the network site.

        • pendingPlan (dict) --

          The pending plan of the network site.

          • options (list) --

            The options of the plan.

            • (dict) --

              Information about a name/value pair.

              • name (string) --

                The name of the pair.

              • value (string) --

                The value of the pair.

          • resourceDefinitions (list) --

            The resource definitions of the plan.

            • (dict) --

              Information about a network resource definition.

              • count (integer) --

                The count in the network resource definition.

              • options (list) --

                The options in the network resource definition.

                • (dict) --

                  Information about a name/value pair.

                  • name (string) --

                    The name of the pair.

                  • value (string) --

                    The value of the pair.

              • type (string) --

                The type in the network resource definition.

        • status (string) --

          The status of the network site.

        • statusReason (string) --

          The status reason of the network site.

    • NextToken (string) --

      A token to resume pagination.

class Private5G.Paginator.ListNetworks
paginator = client.get_paginator('list_networks')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

    The filters.

    • STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING ).

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

{
    'networks': [
        {
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'networkArn': 'string',
            'networkName': 'string',
            'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
            'statusReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • networks (list) --

      The networks.

      • (dict) --

        Information about a network.

        • createdAt (datetime) --

          The creation time of the network.

        • description (string) --

          The description of the network.

        • networkArn (string) --

          The Amazon Resource Name (ARN) of the network.

        • networkName (string) --

          The name of the network.

        • status (string) --

          The status of the network.

        • statusReason (string) --

          The status reason of the network.

    • NextToken (string) --

      A token to resume pagination.

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.