Private5G / Paginator / ListNetworkResources

ListNetworkResources

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
            },
            'returnInformation': {
                'replacementOrderArn': 'string',
                'returnReason': 'string',
                'shippingAddress': {
                    'city': 'string',
                    'company': 'string',
                    'country': 'string',
                    'name': 'string',
                    'phoneNumber': 'string',
                    'postalCode': 'string',
                    'stateOrProvince': 'string',
                    'street1': 'string',
                    'street2': 'string',
                    'street3': 'string'
                },
                'shippingLabel': 'string'
            },
            'serialNumber': 'string',
            'status': 'PENDING'|'SHIPPED'|'PROVISIONING'|'PROVISIONED'|'AVAILABLE'|'DELETING'|'PENDING_RETURN'|'DELETED'|'CREATING_SHIPPING_LABEL',
            '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.

      • returnInformation (dict) –

        Information about a request to return the network resource.

        • replacementOrderArn (string) –

          The Amazon Resource Name (ARN) of the replacement order.

        • returnReason (string) –

          The reason for the return. If the return request did not include a reason for the return, this value is null.

        • shippingAddress (dict) –

          The shipping address.

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

        • shippingLabel (string) –

          The URL of the shipping label. The shipping label is available for download only if the status of the network resource is PENDING_RETURN. For more information, see Return a radio unit.

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