ListSolNetworkInstances - AWS Telco Network Builder

ListSolNetworkInstances

Lists your network instances.

A network instance is a single network created in AWS TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

Request Syntax

GET /sol/nslcm/v1/ns_instances?max_results=maxResults&nextpage_opaque_marker=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to include in the response.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The token for the next page of results.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "networkInstances": [ { "arn": "string", "id": "string", "metadata": { "createdAt": "string", "lastModified": "string" }, "nsdId": "string", "nsdInfoId": "string", "nsInstanceDescription": "string", "nsInstanceName": "string", "nsState": "string" } ], "nextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

networkInstances

Lists network instances.

Type: Array of ListSolNetworkInstanceInfo objects

nextToken

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Insufficient permissions to make request.

HTTP Status Code: 403

InternalServerException

Unexpected error occurred. Problem on the server.

HTTP Status Code: 500

ThrottlingException

Exception caused by throttling.

HTTP Status Code: 429

ValidationException

Unable to process the request because the client provided input failed to satisfy request constraints.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: