CreateSolNetworkInstanceCommand

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

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { TnbClient, CreateSolNetworkInstanceCommand } from "@aws-sdk/client-tnb"; // ES Modules import
// const { TnbClient, CreateSolNetworkInstanceCommand } = require("@aws-sdk/client-tnb"); // CommonJS import
const client = new TnbClient(config);
const input = { // CreateSolNetworkInstanceInput
  nsdInfoId: "STRING_VALUE", // required
  nsName: "STRING_VALUE", // required
  nsDescription: "STRING_VALUE",
  tags: { // TagMap
    "<keys>": "STRING_VALUE",
  },
};
const command = new CreateSolNetworkInstanceCommand(input);
const response = await client.send(command);
// { // CreateSolNetworkInstanceOutput
//   id: "STRING_VALUE", // required
//   arn: "STRING_VALUE", // required
//   nsdInfoId: "STRING_VALUE", // required
//   nsInstanceName: "STRING_VALUE", // required
//   tags: { // TagMap
//     "<keys>": "STRING_VALUE",
//   },
// };

CreateSolNetworkInstanceCommand Input

Parameter
Type
Description
nsName
Required
string | undefined

Network instance name.

nsdInfoId
Required
string | undefined

ID for network service descriptor.

nsDescription
string | undefined

Network instance description.

tags
Record<string, string> | undefined

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.

CreateSolNetworkInstanceCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
arn
Required
string | undefined

Network instance ARN.

id
Required
string | undefined

Network instance ID.

nsInstanceName
Required
string | undefined

Network instance name.

nsdInfoId
Required
string | undefined

Network service descriptor ID.

tags
Record<string, string> | undefined

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.

Throws

Name
Fault
Details
AccessDeniedException
client

Insufficient permissions to make request.

InternalServerException
server

Unexpected error occurred. Problem on the server.

ResourceNotFoundException
client

Request references a resource that doesn't exist.

ServiceQuotaExceededException
client

Service quotas have been exceeded.

ThrottlingException
client

Exception caused by throttling.

ValidationException
client

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

TnbServiceException
Base exception class for all service exceptions from Tnb service.