TelcoNetworkBuilder / Paginator / ListSolFunctionInstances

ListSolFunctionInstances

class TelcoNetworkBuilder.Paginator.ListSolFunctionInstances

paginator = client.get_paginator('list_sol_function_instances')

paginate(**kwargs)

Creates an iterator that will paginate through responses from TelcoNetworkBuilder.Client.list_sol_function_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

{
    'functionInstances': [
        {
            'arn': 'string',
            'id': 'string',
            'instantiatedVnfInfo': {
                'vnfState': 'STARTED'|'STOPPED'
            },
            'instantiationState': 'INSTANTIATED'|'NOT_INSTANTIATED',
            'metadata': {
                'createdAt': datetime(2015, 1, 1),
                'lastModified': datetime(2015, 1, 1)
            },
            'nsInstanceId': 'string',
            'vnfPkgId': 'string',
            'vnfPkgName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • functionInstances (list) –

    Network function instances.

    • (dict) –

      Lists information about a network function instance.

      A network function instance is a function in a function package .

      • arn (string) –

        Network function instance ARN.

      • id (string) –

        Network function instance ID.

      • instantiatedVnfInfo (dict) –

        Information about a network function.

        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.

        • vnfState (string) –

          State of the network function.

      • instantiationState (string) –

        Network function instance instantiation state.

      • metadata (dict) –

        Network function instance metadata.

        • createdAt (datetime) –

          When the network function instance was created.

        • lastModified (datetime) –

          When the network function instance was last modified.

      • nsInstanceId (string) –

        Network instance ID.

      • vnfPkgId (string) –

        Function package ID.

      • vnfPkgName (string) –

        Function package name.

  • NextToken (string) –

    A token to resume pagination.