TelcoNetworkBuilder / Client / get_sol_network_instance

get_sol_network_instance

TelcoNetworkBuilder.Client.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 network operation.

  • 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