TelcoNetworkBuilder / Paginator / ListSolNetworkInstances

ListSolNetworkInstances

class TelcoNetworkBuilder.Paginator.ListSolNetworkInstances

paginator = client.get_paginator('list_sol_network_instances')

paginate(**kwargs)

Creates an iterator that will paginate through responses from TelcoNetworkBuilder.Client.list_sol_network_instances().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'networkInstances': [
        {
            'arn': 'string',
            'id': 'string',
            'metadata': {
                'createdAt': datetime(2015, 1, 1),
                'lastModified': datetime(2015, 1, 1)
            },
            'nsInstanceDescription': 'string',
            'nsInstanceName': 'string',
            'nsState': 'INSTANTIATED'|'NOT_INSTANTIATED'|'IMPAIRED'|'STOPPED'|'DELETED'|'INSTANTIATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'TERMINATE_IN_PROGRESS',
            'nsdId': 'string',
            'nsdInfoId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • networkInstances (list) –

    Lists network instances.

    • (dict) –

      Info about the specific network instance.

      A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

      • arn (string) –

        Network instance ARN.

      • id (string) –

        ID of the network instance.

      • metadata (dict) –

        The metadata of the network instance.

        • createdAt (datetime) –

          The date that the resource was created.

        • lastModified (datetime) –

          The date that the resource was last modified.

      • nsInstanceDescription (string) –

        Human-readable description of the network instance.

      • nsInstanceName (string) –

        Human-readable name of the network instance.

      • nsState (string) –

        The state of the network instance.

      • nsdId (string) –

        ID of the network service descriptor in the network package.

      • nsdInfoId (string) –

        ID of the network service descriptor in the network package.

  • NextToken (string) –

    A token to resume pagination.