TelcoNetworkBuilder

Client

class TelcoNetworkBuilder.Client

A low-level client representing AWS Telco Network Builder

Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of your telecommunication network functions throughout planning, deployment, and post-deployment activities.

import boto3

client = boto3.client('tnb')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
cancel_sol_network_operation(**kwargs)

Cancels a network operation.

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

See also: AWS API Documentation

Request Syntax

response = client.cancel_sol_network_operation(
    nsLcmOpOccId='string'
)
Parameters
nsLcmOpOccId (string) --

[REQUIRED]

The ID of a network operation occurrence.

Returns
None

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
close()

Closes underlying endpoint connections.

create_sol_function_package(**kwargs)

Creates 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. For more information, see Function packages in the Amazon Web Services Telco Network Builder User Guide .

Creating a function package is the first step for creating a network in AWS TNB. This request creates an empty container with an ID. The next step is to upload the actual CSAR zip file into that empty container. To upload function package content, see PutSolFunctionPackageContent.

See also: AWS API Documentation

Request Syntax

response = client.create_sol_function_package(
    tags={
        'string': 'string'
    }
)
Parameters
tags (dict) --

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

  • (string) --
    • (string) --
Return type
dict
Returns
Response Syntax
{
    'arn': 'string',
    'id': 'string',
    'onboardingState': 'CREATED'|'ONBOARDED'|'ERROR',
    'operationalState': 'ENABLED'|'DISABLED',
    'tags': {
        'string': 'string'
    },
    'usageState': 'IN_USE'|'NOT_IN_USE'
}

Response Structure

  • (dict) --
    • arn (string) --

      Function package ARN.

    • id (string) --

      ID of the function package.

    • onboardingState (string) --

      Onboarding state of the function package.

    • operationalState (string) --

      Operational state of the function package.

    • tags (dict) --

      A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

      • (string) --
        • (string) --
    • usageState (string) --

      Usage state of the function package.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ServiceQuotaExceededException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
create_sol_network_instance(**kwargs)

Creates a 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. Creating a network instance is the third step after creating a network package. For more information about network instances, Network instances in the Amazon Web Services Telco Network Builder User Guide .

Once you create a network instance, you can instantiate it. To instantiate a network, see InstantiateSolNetworkInstance.

See also: AWS API Documentation

Request Syntax

response = client.create_sol_network_instance(
    nsDescription='string',
    nsName='string',
    nsdInfoId='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • nsDescription (string) -- Network instance description.
  • nsName (string) --

    [REQUIRED]

    Network instance name.

  • nsdInfoId (string) --

    [REQUIRED]

    ID for network service descriptor.

  • tags (dict) --

    A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'nsInstanceName': 'string',
    'nsdInfoId': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • arn (string) --

      Network instance ARN.

    • id (string) --

      Network instance ID.

    • nsInstanceName (string) --

      Network instance name.

    • nsdInfoId (string) --

      Network service descriptor ID.

    • tags (dict) --

      A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

      • (string) --
        • (string) --

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ServiceQuotaExceededException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
create_sol_network_package(**kwargs)

Creates a network package.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. For more information, see Network instances in the Amazon Web Services Telco Network Builder User Guide .

A network package consists of a network service descriptor (NSD) file (required) and any additional files (optional), such as scripts specific to your needs. For example, if you have multiple function packages in your network package, you can use the NSD to define which network functions should run in certain VPCs, subnets, or EKS clusters.

This request creates an empty network package container with an ID. Once you create a network package, you can upload the network package content using PutSolNetworkPackageContent.

See also: AWS API Documentation

Request Syntax

response = client.create_sol_network_package(
    tags={
        'string': 'string'
    }
)
Parameters
tags (dict) --

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

  • (string) --
    • (string) --
Return type
dict
Returns
Response Syntax
{
    'arn': 'string',
    'id': 'string',
    'nsdOnboardingState': 'CREATED'|'ONBOARDED'|'ERROR',
    'nsdOperationalState': 'ENABLED'|'DISABLED',
    'nsdUsageState': 'IN_USE'|'NOT_IN_USE',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • arn (string) --

      Network package ARN.

    • id (string) --

      ID of the network package.

    • nsdOnboardingState (string) --

      Onboarding state of the network service descriptor in the network package.

    • nsdOperationalState (string) --

      Operational state of the network service descriptor in the network package.

    • nsdUsageState (string) --

      Usage state of the network service descriptor in the network package.

    • tags (dict) --

      A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

      • (string) --
        • (string) --

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ServiceQuotaExceededException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
delete_sol_function_package(**kwargs)

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

To delete a function package, the package must be in a disabled state. To disable a function package, see UpdateSolFunctionPackage.

See also: AWS API Documentation

Request Syntax

response = client.delete_sol_function_package(
    vnfPkgId='string'
)
Parameters
vnfPkgId (string) --

[REQUIRED]

ID of the function package.

Returns
None

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
delete_sol_network_instance(**kwargs)

Deletes a 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.

To delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see TerminateSolNetworkInstance.

See also: AWS API Documentation

Request Syntax

response = client.delete_sol_network_instance(
    nsInstanceId='string'
)
Parameters
nsInstanceId (string) --

[REQUIRED]

Network instance ID.

Returns
None

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
delete_sol_network_package(**kwargs)

Deletes network package.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

To delete a network package, the package must be in a disable state. To disable a network package, see UpdateSolNetworkPackage.

See also: AWS API Documentation

Request Syntax

response = client.delete_sol_network_package(
    nsdInfoId='string'
)
Parameters
nsdInfoId (string) --

[REQUIRED]

ID of the network service descriptor in the network package.

Returns
None

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_sol_function_instance(**kwargs)

Gets the details of a network function instance, including the instantation state and metadata from the function package descriptor in the network function package.

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

See also: AWS API Documentation

Request Syntax

response = client.get_sol_function_instance(
    vnfInstanceId='string'
)
Parameters
vnfInstanceId (string) --

[REQUIRED]

ID of the network function.

Return type
dict
Returns
Response Syntax
{
    'arn': 'string',
    'id': 'string',
    'instantiatedVnfInfo': {
        'vnfState': 'STARTED'|'STOPPED',
        'vnfcResourceInfo': [
            {
                'metadata': {
                    'cluster': 'string',
                    'helmChart': 'string',
                    'nodeGroup': 'string'
                }
            },
        ]
    },
    'instantiationState': 'INSTANTIATED'|'NOT_INSTANTIATED',
    'metadata': {
        'createdAt': datetime(2015, 1, 1),
        'lastModified': datetime(2015, 1, 1)
    },
    'nsInstanceId': 'string',
    'tags': {
        'string': 'string'
    },
    'vnfPkgId': 'string',
    'vnfProductName': 'string',
    'vnfProvider': 'string',
    'vnfdId': 'string',
    'vnfdVersion': 'string'
}

Response Structure

  • (dict) --
    • arn (string) --

      Network function instance ARN.

    • id (string) --

      Network function instance ID.

    • instantiatedVnfInfo (dict) --

      Information about the network function.

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

      • vnfState (string) --

        State of the network function instance.

      • vnfcResourceInfo (list) --

        Compute info used by the network function instance.

        • (dict) --

          Details of resource associated with 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.

          • metadata (dict) --

            The metadata of the network function compute.

            • cluster (string) --

              Information about the cluster.

            • helmChart (string) --

              Information about the helm chart.

            • nodeGroup (string) --

              Information about the node group.

    • instantiationState (string) --

      Network function instantiation state.

    • metadata (dict) --

      The metadata of a network function instance.

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

      • createdAt (datetime) --

        The date that the resource was created.

      • lastModified (datetime) --

        The date that the resource was last modified.

    • nsInstanceId (string) --

      Network instance ID.

    • tags (dict) --

      A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

      • (string) --
        • (string) --
    • vnfPkgId (string) --

      Function package ID.

    • vnfProductName (string) --

      Network function product name.

    • vnfProvider (string) --

      Network function provider.

    • vnfdId (string) --

      Function package descriptor ID.

    • vnfdVersion (string) --

      Function package descriptor version.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
get_sol_function_package(**kwargs)

Gets the details of an individual function package, such as the operational state and whether the package is in use.

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

See also: AWS API Documentation

Request Syntax

response = client.get_sol_function_package(
    vnfPkgId='string'
)
Parameters
vnfPkgId (string) --

[REQUIRED]

ID of the function package.

Return type
dict
Returns
Response Syntax
{
    'arn': 'string',
    'id': 'string',
    'metadata': {
        'createdAt': datetime(2015, 1, 1),
        'lastModified': datetime(2015, 1, 1),
        'vnfd': {
            'overrides': [
                {
                    'defaultValue': 'string',
                    'name': 'string'
                },
            ]
        }
    },
    'onboardingState': 'CREATED'|'ONBOARDED'|'ERROR',
    'operationalState': 'ENABLED'|'DISABLED',
    'tags': {
        'string': 'string'
    },
    'usageState': 'IN_USE'|'NOT_IN_USE',
    'vnfProductName': 'string',
    'vnfProvider': 'string',
    'vnfdId': 'string',
    'vnfdVersion': 'string'
}

Response Structure

  • (dict) --
    • arn (string) --

      Function package ARN.

    • id (string) --

      Function package ID.

    • metadata (dict) --

      Metadata related to the 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.

      • createdAt (datetime) --

        The date that the resource was created.

      • lastModified (datetime) --

        The date that the resource was last modified.

      • vnfd (dict) --

        Metadata related to the function package descriptor of the function package.

        • overrides (list) --

          Lists of function package overrides.

          • (dict) --

            Overrides of the TOSCA node.

            • defaultValue (string) --

              Default value for the override.

            • name (string) --

              Name of the TOSCA override.

    • onboardingState (string) --

      Function package onboarding state.

    • operationalState (string) --

      Function package operational state.

    • tags (dict) --

      A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

      • (string) --
        • (string) --
    • usageState (string) --

      Function package usage state.

    • vnfProductName (string) --

      Network function product name.

    • vnfProvider (string) --

      Network function provider.

    • vnfdId (string) --

      Function package descriptor ID.

    • vnfdVersion (string) --

      Function package descriptor version.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
get_sol_function_package_content(**kwargs)

Gets the contents of 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.

See also: AWS API Documentation

Request Syntax

response = client.get_sol_function_package_content(
    accept='application/zip',
    vnfPkgId='string'
)
Parameters
  • accept (string) --

    [REQUIRED]

    The format of the package that you want to download from the function packages.

  • vnfPkgId (string) --

    [REQUIRED]

    ID of the function package.

Return type

dict

Returns

Response Syntax

{
    'contentType': 'application/zip',
    'packageContent': StreamingBody()
}

Response Structure

  • (dict) --

    • contentType (string) --

      Indicates the media type of the resource.

    • packageContent (StreamingBody) --

      Contents of the function package.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
get_sol_function_package_descriptor(**kwargs)

Gets a function package descriptor in a function package.

A function package descriptor is a .yaml file in a function package that uses the TOSCA standard to describe how the network function in the function package should run on your network.

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.

See also: AWS API Documentation

Request Syntax

response = client.get_sol_function_package_descriptor(
    accept='text/plain',
    vnfPkgId='string'
)
Parameters
  • accept (string) --

    [REQUIRED]

    Indicates which content types, expressed as MIME types, the client is able to understand.

  • vnfPkgId (string) --

    [REQUIRED]

    ID of the function package.

Return type

dict

Returns

Response Syntax

{
    'contentType': 'text/plain',
    'vnfd': StreamingBody()
}

Response Structure

  • (dict) --

    • contentType (string) --

      Indicates the media type of the resource.

    • vnfd (StreamingBody) --

      Contents of the function package descriptor.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
get_sol_network_instance(**kwargs)

Gets the details of the 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.

See also: AWS API Documentation

Request Syntax

response = client.get_sol_network_instance(
    nsInstanceId='string'
)
Parameters
nsInstanceId (string) --

[REQUIRED]

ID of the network instance.

Return type
dict
Returns
Response Syntax
{
    'arn': 'string',
    'id': 'string',
    'lcmOpInfo': {
        'nsLcmOpOccId': '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',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • arn (string) --

      Network instance ARN.

    • id (string) --

      Network instance ID.

    • lcmOpInfo (dict) --

      Lifecycle management operation details on the network instance.

      Lifecycle management operations are deploy, update, or delete operations.

      • nsLcmOpOccId (string) --

        The identifier of the latest network lifecycle management operation occurrence.

    • metadata (dict) --

      The metadata of a 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.

      • createdAt (datetime) --

        The date that the resource was created.

      • lastModified (datetime) --

        The date that the resource was last modified.

    • nsInstanceDescription (string) --

      Network instance description.

    • nsInstanceName (string) --

      Network instance name.

    • nsState (string) --

      Network instance state.

    • nsdId (string) --

      Network service descriptor ID.

    • nsdInfoId (string) --

      Network service descriptor info ID.

    • tags (dict) --

      A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

      • (string) --
        • (string) --

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
get_sol_network_operation(**kwargs)

Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks.

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

See also: AWS API Documentation

Request Syntax

response = client.get_sol_network_operation(
    nsLcmOpOccId='string'
)
Parameters
nsLcmOpOccId (string) --

[REQUIRED]

The identifier of the operation occurrence.

Return type
dict
Returns
Response Syntax
{
    'arn': 'string',
    'error': {
        'detail': 'string',
        'title': 'string'
    },
    'id': 'string',
    'lcmOperationType': 'INSTANTIATE'|'UPDATE'|'TERMINATE',
    'metadata': {
        'createdAt': datetime(2015, 1, 1),
        'lastModified': datetime(2015, 1, 1)
    },
    'nsInstanceId': 'string',
    'operationState': 'PROCESSING'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
    'tags': {
        'string': 'string'
    },
    'tasks': [
        {
            'taskContext': {
                'string': 'string'
            },
            'taskEndTime': datetime(2015, 1, 1),
            'taskErrorDetails': {
                'cause': 'string',
                'details': 'string'
            },
            'taskName': 'string',
            'taskStartTime': datetime(2015, 1, 1),
            'taskStatus': 'SCHEDULED'|'STARTED'|'IN_PROGRESS'|'COMPLETED'|'ERROR'|'SKIPPED'|'CANCELLED'
        },
    ]
}

Response Structure

  • (dict) --
    • arn (string) --

      Network operation ARN.

    • error (dict) --

      Error related to this specific network operation occurence.

      • detail (string) --

        A human-readable explanation specific to this occurrence of the problem.

      • title (string) --

        A human-readable title of the problem type.

    • id (string) --

      ID of this network operation occurrence.

    • lcmOperationType (string) --

      Type of the operation represented by this occurrence.

    • metadata (dict) --

      Metadata of this network operation occurrence.

      • createdAt (datetime) --

        The date that the resource was created.

      • lastModified (datetime) --

        The date that the resource was last modified.

    • nsInstanceId (string) --

      ID of the network operation instance.

    • operationState (string) --

      The state of the network operation.

    • tags (dict) --

      A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

      • (string) --
        • (string) --
    • tasks (list) --

      All tasks associated with this operation occurrence.

      • (dict) --

        Gets the details of a network operation.

        A network operation is any operation that is done to your network, such as network instance instantiation or termination.

        • taskContext (dict) --

          Context for the network operation task.

          • (string) --
            • (string) --
        • taskEndTime (datetime) --

          Task end time.

        • taskErrorDetails (dict) --

          Task error details.

          • cause (string) --

            Error cause.

          • details (string) --

            Error details.

        • taskName (string) --

          Task name.

        • taskStartTime (datetime) --

          Task start time.

        • taskStatus (string) --

          Task status.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
get_sol_network_package(**kwargs)

Gets the details of a network package.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

See also: AWS API Documentation

Request Syntax

response = client.get_sol_network_package(
    nsdInfoId='string'
)
Parameters
nsdInfoId (string) --

[REQUIRED]

ID of the network service descriptor in the network package.

Return type
dict
Returns
Response Syntax
{
    'arn': 'string',
    'id': 'string',
    'metadata': {
        'createdAt': datetime(2015, 1, 1),
        'lastModified': datetime(2015, 1, 1),
        'nsd': {
            'overrides': [
                {
                    'defaultValue': 'string',
                    'name': 'string'
                },
            ]
        }
    },
    'nsdId': 'string',
    'nsdName': 'string',
    'nsdOnboardingState': 'CREATED'|'ONBOARDED'|'ERROR',
    'nsdOperationalState': 'ENABLED'|'DISABLED',
    'nsdUsageState': 'IN_USE'|'NOT_IN_USE',
    'nsdVersion': 'string',
    'tags': {
        'string': 'string'
    },
    'vnfPkgIds': [
        'string',
    ]
}

Response Structure

  • (dict) --
    • arn (string) --

      Network package ARN.

    • id (string) --

      Network package ID.

    • metadata (dict) --

      Metadata associated with a network package.

      A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

      • createdAt (datetime) --

        The date that the resource was created.

      • lastModified (datetime) --

        The date that the resource was last modified.

      • nsd (dict) --

        Metadata related to the onboarded network service descriptor in the network package.

        • overrides (list) --

          Lists network package overrides.

          • (dict) --

            Overrides of the TOSCA node.

            • defaultValue (string) --

              Default value for the override.

            • name (string) --

              Name of the TOSCA override.

    • nsdId (string) --

      Network service descriptor ID.

    • nsdName (string) --

      Network service descriptor name.

    • nsdOnboardingState (string) --

      Network service descriptor onboarding state.

    • nsdOperationalState (string) --

      Network service descriptor operational state.

    • nsdUsageState (string) --

      Network service descriptor usage state.

    • nsdVersion (string) --

      Network service descriptor version.

    • tags (dict) --

      A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

      • (string) --
        • (string) --
    • vnfPkgIds (list) --

      Identifies the function package for the function package descriptor referenced by the onboarded network package.

      • (string) --

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
get_sol_network_package_content(**kwargs)

Gets the contents of a network package.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

See also: AWS API Documentation

Request Syntax

response = client.get_sol_network_package_content(
    accept='application/zip',
    nsdInfoId='string'
)
Parameters
  • accept (string) --

    [REQUIRED]

    The format of the package you want to download from the network package.

  • nsdInfoId (string) --

    [REQUIRED]

    ID of the network service descriptor in the network package.

Return type

dict

Returns

Response Syntax

{
    'contentType': 'application/zip',
    'nsdContent': StreamingBody()
}

Response Structure

  • (dict) --

    • contentType (string) --

      Indicates the media type of the resource.

    • nsdContent (StreamingBody) --

      Content of the network service descriptor in the network package.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
get_sol_network_package_descriptor(**kwargs)

Gets the content of the network service descriptor.

A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.

See also: AWS API Documentation

Request Syntax

response = client.get_sol_network_package_descriptor(
    nsdInfoId='string'
)
Parameters
nsdInfoId (string) --

[REQUIRED]

ID of the network service descriptor in the network package.

Return type
dict
Returns
Response Syntax
{
    'contentType': 'text/plain',
    'nsd': StreamingBody()
}

Response Structure

  • (dict) --
    • contentType (string) --

      Indicates the media type of the resource.

    • nsd (StreamingBody) --

      Contents of the network service descriptor in the network package.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
instantiate_sol_network_instance(**kwargs)

Instantiates a 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.

Before you can instantiate a network instance, you have to create a network instance. For more information, see CreateSolNetworkInstance.

See also: AWS API Documentation

Request Syntax

response = client.instantiate_sol_network_instance(
    additionalParamsForNs={...}|[...]|123|123.4|'string'|True|None,
    dryRun=True|False,
    nsInstanceId='string'
)
Parameters
  • additionalParamsForNs (document) -- Provides values for the configurable properties.
  • dryRun (boolean) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
  • nsInstanceId (string) --

    [REQUIRED]

    ID of the network instance.

Return type

dict

Returns

Response Syntax

{
    'nsLcmOpOccId': 'string'
}

Response Structure

  • (dict) --

    • nsLcmOpOccId (string) --

      The identifier of the network instance.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ServiceQuotaExceededException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
list_sol_function_instances(**kwargs)

Lists network function instances.

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

See also: AWS API Documentation

Request Syntax

response = client.list_sol_function_instances(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of results to include in the response.
  • nextToken (string) -- The token for the next page of results.
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) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
list_sol_function_packages(**kwargs)

Lists information about 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.

See also: AWS API Documentation

Request Syntax

response = client.list_sol_function_packages(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of results to include in the response.
  • nextToken (string) -- The token for the next page of results.
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) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
list_sol_network_instances(**kwargs)

Lists your network instances.

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.

See also: AWS API Documentation

Request Syntax

response = client.list_sol_network_instances(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of results to include in the response.
  • nextToken (string) -- The token for the next page of results.
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) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
list_sol_network_operations(**kwargs)

Lists details for a network operation, including when the operation started and the status of the operation.

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

See also: AWS API Documentation

Request Syntax

response = client.list_sol_network_operations(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of results to include in the response.
  • nextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'networkOperations': [
        {
            'arn': 'string',
            'error': {
                'detail': 'string',
                'title': 'string'
            },
            'id': 'string',
            'lcmOperationType': 'INSTANTIATE'|'UPDATE'|'TERMINATE',
            'metadata': {
                'createdAt': datetime(2015, 1, 1),
                'lastModified': datetime(2015, 1, 1)
            },
            'nsInstanceId': 'string',
            'operationState': 'PROCESSING'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • networkOperations (list) --

      Lists network operation occurrences. Lifecycle management operations are deploy, update, or delete operations.

      • (dict) --

        Information parameters for a network operation.

        • arn (string) --

          Network operation ARN.

        • error (dict) --

          Error related to this specific network operation.

          • detail (string) --

            A human-readable explanation specific to this occurrence of the problem.

          • title (string) --

            A human-readable title of the problem type.

        • id (string) --

          ID of this network operation.

        • lcmOperationType (string) --

          Type of lifecycle management network operation.

        • metadata (dict) --

          Metadata related to this network operation.

          • createdAt (datetime) --

            The date that the resource was created.

          • lastModified (datetime) --

            The date that the resource was last modified.

        • nsInstanceId (string) --

          ID of the network instance related to this operation.

        • operationState (string) --

          The state of the network operation.

    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
list_sol_network_packages(**kwargs)

Lists network packages.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

See also: AWS API Documentation

Request Syntax

response = client.list_sol_network_packages(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of results to include in the response.
  • nextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'networkPackages': [
        {
            'arn': 'string',
            'id': 'string',
            'metadata': {
                'createdAt': datetime(2015, 1, 1),
                'lastModified': datetime(2015, 1, 1)
            },
            'nsdDesigner': 'string',
            'nsdId': 'string',
            'nsdInvariantId': 'string',
            'nsdName': 'string',
            'nsdOnboardingState': 'CREATED'|'ONBOARDED'|'ERROR',
            'nsdOperationalState': 'ENABLED'|'DISABLED',
            'nsdUsageState': 'IN_USE'|'NOT_IN_USE',
            'nsdVersion': 'string',
            'vnfPkgIds': [
                'string',
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • networkPackages (list) --

      Network packages. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

      • (dict) --

        Details of a network package.

        A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

        • arn (string) --

          Network package ARN.

        • id (string) --

          ID of the individual network package.

        • metadata (dict) --

          The metadata of the network package.

          • createdAt (datetime) --

            The date that the resource was created.

          • lastModified (datetime) --

            The date that the resource was last modified.

        • nsdDesigner (string) --

          Designer of the onboarded network service descriptor in the network package.

        • nsdId (string) --

          ID of the network service descriptor on which the network package is based.

        • nsdInvariantId (string) --

          Identifies a network service descriptor in a version independent manner.

        • nsdName (string) --

          Name of the onboarded network service descriptor in the network package.

        • nsdOnboardingState (string) --

          Onboarding state of the network service descriptor in the network package.

        • nsdOperationalState (string) --

          Operational state of the network service descriptor in the network package.

        • nsdUsageState (string) --

          Usage state of the network service descriptor in the network package.

        • nsdVersion (string) --

          Version of the onboarded network service descriptor in the network package.

        • vnfPkgIds (list) --

          Identifies the function package for the function package descriptor referenced by the onboarded network package.

          • (string) --
    • nextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
list_tags_for_resource(**kwargs)

Lists tags for AWS TNB resources.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)
Parameters
resourceArn (string) --

[REQUIRED]

Resource ARN.

Return type
dict
Returns
Response Syntax
{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • tags (dict) --

      A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

      • (string) --
        • (string) --

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
put_sol_function_package_content(**kwargs)

Uploads the contents of 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.

See also: AWS API Documentation

Request Syntax

response = client.put_sol_function_package_content(
    contentType='application/zip',
    file=b'bytes'|file,
    vnfPkgId='string'
)
Parameters
  • contentType (string) -- Function package content type.
  • file (bytes or seekable file-like object) --

    [REQUIRED]

    Function package file.

  • vnfPkgId (string) --

    [REQUIRED]

    Function package ID.

Return type

dict

Returns

Response Syntax

{
    'id': 'string',
    'metadata': {
        'vnfd': {
            'overrides': [
                {
                    'defaultValue': 'string',
                    'name': 'string'
                },
            ]
        }
    },
    'vnfProductName': 'string',
    'vnfProvider': 'string',
    'vnfdId': 'string',
    'vnfdVersion': 'string'
}

Response Structure

  • (dict) --

    • id (string) --

      Function package ID.

    • metadata (dict) --

      Function package metadata.

      • vnfd (dict) --

        Metadata for function package artifacts.

        Artifacts are the contents of the package descriptor file and the state of the package.

        • overrides (list) --

          Lists of function package overrides.

          • (dict) --

            Overrides of the TOSCA node.

            • defaultValue (string) --

              Default value for the override.

            • name (string) --

              Name of the TOSCA override.

    • vnfProductName (string) --

      Function product name.

    • vnfProvider (string) --

      Function provider.

    • vnfdId (string) --

      Function package descriptor ID.

    • vnfdVersion (string) --

      Function package descriptor version.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
put_sol_network_package_content(**kwargs)

Uploads the contents of a network package.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

See also: AWS API Documentation

Request Syntax

response = client.put_sol_network_package_content(
    contentType='application/zip',
    file=b'bytes'|file,
    nsdInfoId='string'
)
Parameters
  • contentType (string) -- Network package content type.
  • file (bytes or seekable file-like object) --

    [REQUIRED]

    Network package file.

  • nsdInfoId (string) --

    [REQUIRED]

    Network service descriptor info ID.

Return type

dict

Returns

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'metadata': {
        'nsd': {
            'overrides': [
                {
                    'defaultValue': 'string',
                    'name': 'string'
                },
            ]
        }
    },
    'nsdId': 'string',
    'nsdName': 'string',
    'nsdVersion': 'string',
    'vnfPkgIds': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • arn (string) --

      Network package ARN.

    • id (string) --

      Network package ID.

    • metadata (dict) --

      Network package metadata.

      • nsd (dict) --

        Metadata for network package artifacts.

        Artifacts are the contents of the package descriptor file and the state of the package.

        • overrides (list) --

          Lists network package overrides.

          • (dict) --

            Overrides of the TOSCA node.

            • defaultValue (string) --

              Default value for the override.

            • name (string) --

              Name of the TOSCA override.

    • nsdId (string) --

      Network service descriptor ID.

    • nsdName (string) --

      Network service descriptor name.

    • nsdVersion (string) --

      Network service descriptor version.

    • vnfPkgIds (list) --

      Function package IDs.

      • (string) --

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
tag_resource(**kwargs)

Tags an AWS TNB resource.

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    Resource ARN.

  • tags (dict) --

    [REQUIRED]

    A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
terminate_sol_network_instance(**kwargs)

Terminates a 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.

You must terminate a network instance before you can delete it.

See also: AWS API Documentation

Request Syntax

response = client.terminate_sol_network_instance(
    nsInstanceId='string'
)
Parameters
nsInstanceId (string) --

[REQUIRED]

ID of the network instance.

Return type
dict
Returns
Response Syntax
{
    'nsLcmOpOccId': 'string'
}

Response Structure

  • (dict) --
    • nsLcmOpOccId (string) --

      The identifier of the operation occurrence.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ServiceQuotaExceededException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
untag_resource(**kwargs)

Untags an AWS TNB resource.

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    Resource ARN.

  • tagKeys (list) --

    [REQUIRED]

    Tag keys.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
update_sol_function_package(**kwargs)

Updates the operational state of 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.

See also: AWS API Documentation

Request Syntax

response = client.update_sol_function_package(
    operationalState='ENABLED'|'DISABLED',
    vnfPkgId='string'
)
Parameters
  • operationalState (string) --

    [REQUIRED]

    Operational state of the function package.

  • vnfPkgId (string) --

    [REQUIRED]

    ID of the function package.

Return type

dict

Returns

Response Syntax

{
    'operationalState': 'ENABLED'|'DISABLED'
}

Response Structure

  • (dict) --

    • operationalState (string) --

      Operational state of the function package.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
update_sol_network_instance(**kwargs)

Update a 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.

See also: AWS API Documentation

Request Syntax

response = client.update_sol_network_instance(
    modifyVnfInfoData={
        'vnfConfigurableProperties': {...}|[...]|123|123.4|'string'|True|None,
        'vnfInstanceId': 'string'
    },
    nsInstanceId='string',
    updateType='MODIFY_VNF_INFORMATION'
)
Parameters
  • modifyVnfInfoData (dict) --

    Identifies the network function information parameters and/or the configurable properties of the network function to be modified.

    • vnfConfigurableProperties (document) -- [REQUIRED]

      Provides values for the configurable properties declared in the function package descriptor.

    • vnfInstanceId (string) -- [REQUIRED]

      ID of the network function instance.

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

  • nsInstanceId (string) --

    [REQUIRED]

    ID of the network instance.

  • updateType (string) --

    [REQUIRED]

    The type of update.

Return type

dict

Returns

Response Syntax

{
    'nsLcmOpOccId': 'string'
}

Response Structure

  • (dict) --

    • nsLcmOpOccId (string) --

      The identifier of the network instance operation occurrence.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ServiceQuotaExceededException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
update_sol_network_package(**kwargs)

Updates the operational state of a network package.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.

See also: AWS API Documentation

Request Syntax

response = client.update_sol_network_package(
    nsdInfoId='string',
    nsdOperationalState='ENABLED'|'DISABLED'
)
Parameters
  • nsdInfoId (string) --

    [REQUIRED]

    ID of the network service descriptor in the network package.

  • nsdOperationalState (string) --

    [REQUIRED]

    Operational state of the network service descriptor in the network package.

Return type

dict

Returns

Response Syntax

{
    'nsdOperationalState': 'ENABLED'|'DISABLED'
}

Response Structure

  • (dict) --

    • nsdOperationalState (string) --

      Operational state of the network service descriptor in the network package.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
validate_sol_function_package_content(**kwargs)

Validates function package content. This can be used as a dry run before uploading function package content with PutSolFunctionPackageContent.

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.

See also: AWS API Documentation

Request Syntax

response = client.validate_sol_function_package_content(
    contentType='application/zip',
    file=b'bytes'|file,
    vnfPkgId='string'
)
Parameters
  • contentType (string) -- Function package content type.
  • file (bytes or seekable file-like object) --

    [REQUIRED]

    Function package file.

  • vnfPkgId (string) --

    [REQUIRED]

    Function package ID.

Return type

dict

Returns

Response Syntax

{
    'id': 'string',
    'metadata': {
        'vnfd': {
            'overrides': [
                {
                    'defaultValue': 'string',
                    'name': 'string'
                },
            ]
        }
    },
    'vnfProductName': 'string',
    'vnfProvider': 'string',
    'vnfdId': 'string',
    'vnfdVersion': 'string'
}

Response Structure

  • (dict) --

    • id (string) --

      Function package ID.

    • metadata (dict) --

      Function package metadata.

      • vnfd (dict) --

        Metadata for function package artifacts.

        Artifacts are the contents of the package descriptor file and the state of the package.

        • overrides (list) --

          Lists of function package overrides.

          • (dict) --

            Overrides of the TOSCA node.

            • defaultValue (string) --

              Default value for the override.

            • name (string) --

              Name of the TOSCA override.

    • vnfProductName (string) --

      Network function product name.

    • vnfProvider (string) --

      Network function provider.

    • vnfdId (string) --

      Function package descriptor ID.

    • vnfdVersion (string) --

      Function package descriptor version.

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException
validate_sol_network_package_content(**kwargs)

Validates network package content. This can be used as a dry run before uploading network package content with PutSolNetworkPackageContent.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

See also: AWS API Documentation

Request Syntax

response = client.validate_sol_network_package_content(
    contentType='application/zip',
    file=b'bytes'|file,
    nsdInfoId='string'
)
Parameters
  • contentType (string) -- Network package content type.
  • file (bytes or seekable file-like object) --

    [REQUIRED]

    Network package file.

  • nsdInfoId (string) --

    [REQUIRED]

    Network service descriptor file.

Return type

dict

Returns

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'metadata': {
        'nsd': {
            'overrides': [
                {
                    'defaultValue': 'string',
                    'name': 'string'
                },
            ]
        }
    },
    'nsdId': 'string',
    'nsdName': 'string',
    'nsdVersion': 'string',
    'vnfPkgIds': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • arn (string) --

      Network package ARN.

    • id (string) --

      Network package ID.

    • metadata (dict) --

      Network package metadata.

      • nsd (dict) --

        Metadata for network package artifacts.

        Artifacts are the contents of the package descriptor file and the state of the package.

        • overrides (list) --

          Lists network package overrides.

          • (dict) --

            Overrides of the TOSCA node.

            • defaultValue (string) --

              Default value for the override.

            • name (string) --

              Name of the TOSCA override.

    • nsdId (string) --

      Network service descriptor ID.

    • nsdName (string) --

      Network service descriptor name.

    • nsdVersion (string) --

      Network service descriptor version.

    • vnfPkgIds (list) --

      Function package IDs.

      • (string) --

Exceptions

  • TelcoNetworkBuilder.Client.exceptions.InternalServerException
  • TelcoNetworkBuilder.Client.exceptions.ThrottlingException
  • TelcoNetworkBuilder.Client.exceptions.ValidationException
  • TelcoNetworkBuilder.Client.exceptions.ResourceNotFoundException
  • TelcoNetworkBuilder.Client.exceptions.AccessDeniedException

Paginators

The available paginators are:

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.

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.

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.

class TelcoNetworkBuilder.Paginator.ListSolNetworkOperations
paginator = client.get_paginator('list_sol_network_operations')
paginate(**kwargs)

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

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
{
    'networkOperations': [
        {
            'arn': 'string',
            'error': {
                'detail': 'string',
                'title': 'string'
            },
            'id': 'string',
            'lcmOperationType': 'INSTANTIATE'|'UPDATE'|'TERMINATE',
            'metadata': {
                'createdAt': datetime(2015, 1, 1),
                'lastModified': datetime(2015, 1, 1)
            },
            'nsInstanceId': 'string',
            'operationState': 'PROCESSING'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • networkOperations (list) --

      Lists network operation occurrences. Lifecycle management operations are deploy, update, or delete operations.

      • (dict) --

        Information parameters for a network operation.

        • arn (string) --

          Network operation ARN.

        • error (dict) --

          Error related to this specific network operation.

          • detail (string) --

            A human-readable explanation specific to this occurrence of the problem.

          • title (string) --

            A human-readable title of the problem type.

        • id (string) --

          ID of this network operation.

        • lcmOperationType (string) --

          Type of lifecycle management network operation.

        • metadata (dict) --

          Metadata related to this network operation.

          • createdAt (datetime) --

            The date that the resource was created.

          • lastModified (datetime) --

            The date that the resource was last modified.

        • nsInstanceId (string) --

          ID of the network instance related to this operation.

        • operationState (string) --

          The state of the network operation.

    • NextToken (string) --

      A token to resume pagination.

class TelcoNetworkBuilder.Paginator.ListSolNetworkPackages
paginator = client.get_paginator('list_sol_network_packages')
paginate(**kwargs)

Creates an iterator that will paginate through responses from TelcoNetworkBuilder.Client.list_sol_network_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
{
    'networkPackages': [
        {
            'arn': 'string',
            'id': 'string',
            'metadata': {
                'createdAt': datetime(2015, 1, 1),
                'lastModified': datetime(2015, 1, 1)
            },
            'nsdDesigner': 'string',
            'nsdId': 'string',
            'nsdInvariantId': 'string',
            'nsdName': 'string',
            'nsdOnboardingState': 'CREATED'|'ONBOARDED'|'ERROR',
            'nsdOperationalState': 'ENABLED'|'DISABLED',
            'nsdUsageState': 'IN_USE'|'NOT_IN_USE',
            'nsdVersion': 'string',
            'vnfPkgIds': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • networkPackages (list) --

      Network packages. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

      • (dict) --

        Details of a network package.

        A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

        • arn (string) --

          Network package ARN.

        • id (string) --

          ID of the individual network package.

        • metadata (dict) --

          The metadata of the network package.

          • createdAt (datetime) --

            The date that the resource was created.

          • lastModified (datetime) --

            The date that the resource was last modified.

        • nsdDesigner (string) --

          Designer of the onboarded network service descriptor in the network package.

        • nsdId (string) --

          ID of the network service descriptor on which the network package is based.

        • nsdInvariantId (string) --

          Identifies a network service descriptor in a version independent manner.

        • nsdName (string) --

          Name of the onboarded network service descriptor in the network package.

        • nsdOnboardingState (string) --

          Onboarding state of the network service descriptor in the network package.

        • nsdOperationalState (string) --

          Operational state of the network service descriptor in the network package.

        • nsdUsageState (string) --

          Usage state of the network service descriptor in the network package.

        • nsdVersion (string) --

          Version of the onboarded network service descriptor in the network package.

        • vnfPkgIds (list) --

          Identifies the function package for the function package descriptor referenced by the onboarded network package.

          • (string) --
    • NextToken (string) --

      A token to resume pagination.