Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateSolNetworkInstance

Creates a network instance.

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. Creating a network instance is the third step after creating a network package. For more information about network instances, Network instances in the AWS Telco Network Builder User Guide.

Once you create a network instance, you can instantiate it. To instantiate a network, see InstantiateSolNetworkInstance.

Request Syntax


POST /sol/nslcm/v1/ns_instances HTTP/1.1
Content-type: application/json

{
   "nsDescription": "string",
   "nsdInfoId": "string",
   "nsName": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

nsDescription

Network instance description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Required: No

nsdInfoId

ID for network service descriptor.

Type: String

Pattern: ^np-[a-f0-9]{17}$

Required: Yes

nsName

Network instance name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

tags

A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Pattern: ^(?!aws:).{1,128}$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "nsdInfoId": "string",
   "nsInstanceName": "string",
   "tags": { 
      "string" : "string" 
   }
}

Response Elements

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

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

arn

Network instance ARN.

Type: String

Pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\d{12}:(network-instance/ni-[a-f0-9]{17})$

id

Network instance ID.

Type: String

Pattern: ^ni-[a-f0-9]{17}$

nsdInfoId

Network service descriptor ID.

Type: String

Pattern: ^np-[a-f0-9]{17}$

nsInstanceName

Network instance name.

Type: String

tags

A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Pattern: ^(?!aws:).{1,128}$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

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

ResourceNotFoundException

Request references a resource that doesn't exist.

HTTP Status Code: 404

ServiceQuotaExceededException

Service quotas have been exceeded.

HTTP Status Code: 402

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