TelcoNetworkBuilder / Paginator / ListSolFunctionPackages

ListSolFunctionPackages#

class TelcoNetworkBuilder.Paginator.ListSolFunctionPackages#
paginator = client.get_paginator('list_sol_function_packages')
paginate(**kwargs)#

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

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

{
    'functionPackages': [
        {
            'arn': 'string',
            'id': 'string',
            'metadata': {
                'createdAt': datetime(2015, 1, 1),
                'lastModified': datetime(2015, 1, 1)
            },
            'onboardingState': 'CREATED'|'ONBOARDED'|'ERROR',
            'operationalState': 'ENABLED'|'DISABLED',
            'usageState': 'IN_USE'|'NOT_IN_USE',
            'vnfProductName': 'string',
            'vnfProvider': 'string',
            'vnfdId': 'string',
            'vnfdVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • functionPackages (list) –

      Function packages. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

      • (dict) –

        Information about a function package.

        A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

        • arn (string) –

          Function package ARN.

        • id (string) –

          ID of the function package.

        • metadata (dict) –

          The metadata of the function package.

          • createdAt (datetime) –

            The date that the resource was created.

          • lastModified (datetime) –

            The date that the resource was last modified.

        • onboardingState (string) –

          Onboarding state of the function package.

        • operationalState (string) –

          Operational state of the function package.

        • usageState (string) –

          Usage state of the function package.

        • vnfProductName (string) –

          The product name for the network function.

        • vnfProvider (string) –

          Provider of the function package and the function package descriptor.

        • vnfdId (string) –

          Identifies the function package and the function package descriptor.

        • vnfdVersion (string) –

          Identifies the version of the function package descriptor.

    • NextToken (string) –

      A token to resume pagination.