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().

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'
                },
            ],
            'commitmentInformation': {
                'commitmentConfiguration': {
                    'automaticRenewal': True|False,
                    'commitmentLength': 'SIXTY_DAYS'|'ONE_YEAR'|'THREE_YEARS'
                },
                'expiresOn': datetime(2015, 1, 1),
                'startAt': datetime(2015, 1, 1)
            },
            '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',
                    'emailAddress': '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.
    - commitmentInformation (dict) –
      
      Information about the commitment period for the radio unit. Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period.
      - commitmentConfiguration (dict) –
        
        The duration and renewal status of the commitment period for the radio unit.
        
        automaticRenewal (boolean) –
        
        Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.
        
        Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.
        
        You can do the following:
        
        Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
        
        Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
        
        Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.
        
        You cannot use the automatic-renewal option for a 60-day commitment.
        
        commitmentLength (string) –
        
        The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
      - expiresOn (datetime) –
        
        The date and time that the commitment period ends. If you do not cancel or renew the commitment before the expiration date, you will be billed at the 60-day-commitment rate.
      - startAt (datetime) –
        
        The date and time that the commitment period started.
    - 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.
        
        emailAddress (string) –
        
        The recipient’s email address.
        
        name (string) –
        
        The recipient’s name for this address.
        
        phoneNumber (string) –
        
        The recipient’s phone number.
        
        postalCode (string) –
        
        The postal code for this address.
        
        stateOrProvince (string) –
        
        The state or province for this address.
        
        street1 (string) –
        
        The first line of the street address.
        
        street2 (string) –
        
        The second line of the street address.
        
        street3 (string) –
        
        The third line of the street address.
      - 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.