AWS Telco Network Builder

{'tags': {'string': 'string'}}

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

client.instantiate_sol_network_instance(
    additionalParamsForNs={...}|[...]|123|123.4|'string'|True|None,
    dryRun=True|False,
    nsInstanceId='string',
    tags={
        'string': 'string'
    }
)

type additionalParamsForNs:

:ref:`document<document>`

param additionalParamsForNs:

Provides values for the configurable properties.

type dryRun:

boolean

param dryRun:

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.

type nsInstanceId:

string

param nsInstanceId:

[REQUIRED]

ID of the network instance.

type tags:

dict

param tags:

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

• (string) --

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'nsLcmOpOccId': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  • nsLcmOpOccId (string) --

    The identifier 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. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

    • (string) --

      • (string) --

{'tags': {'string': 'string'}}

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

client.terminate_sol_network_instance(
    nsInstanceId='string',
    tags={
        'string': 'string'
    }
)

type nsInstanceId:

string

param nsInstanceId:

[REQUIRED]

ID of the network instance.

type tags:

dict

param tags:

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

• (string) --

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'nsLcmOpOccId': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  • nsLcmOpOccId (string) --

    The identifier 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. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

    • (string) --

      • (string) --

{'tags': {'string': 'string'}}

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

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

type modifyVnfInfoData:

dict

param modifyVnfInfoData:

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

• vnfConfigurableProperties (:ref:`document<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 .

type nsInstanceId:

string

param nsInstanceId:

[REQUIRED]

ID of the network instance.

type tags:

dict

param tags:

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

• (string) --

  • (string) --

type updateType:

string

param updateType:

[REQUIRED]

The type of update.

rtype:

dict

returns:

Response Syntax

{
    'nsLcmOpOccId': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  • nsLcmOpOccId (string) --

    The identifier 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. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

    • (string) --

      • (string) --