TelcoNetworkBuilder / Client / instantiate_sol_network_instance

instantiate_sol_network_instance#

TelcoNetworkBuilder.Client.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',
    tags={
        'string': '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.

  • 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 only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

    • (string) –

      • (string) –

Return type:

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 only applied to the network operation that is created. These tags are not applied to the network instance. 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