Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1433161130.9 KB

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.

get/sol/nslcm/v1/ns_instances/{nsInstanceId}

Path parameters

nsInstanceIdstring required

ID of the network instance.

Response

Success

arnstring required

Network instance ARN.

idstring required

Network instance ID.

nsInstanceDescriptionstring required

Network instance description.

nsInstanceNamestring required

Network instance name.

nsState'INSTANTIATED' | 'NOT_INSTANTIATED' | 'UPDATED' | 'IMPAIRED' | 'UPDATE_FAILED' | 'STOPPED' | 'DELETED' | 'INSTANTIATE_IN_PROGRESS' | 'INTENT_TO_UPDATE_IN_PROGRESS' | 'UPDATE_IN_PROGRESS' | 'TERMINATE_IN_PROGRESS'

Network instance state.

nsdIdstring required

Network service descriptor ID.

nsdInfoIdstring required

Network service descriptor info ID.

tagsobject

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.