UpdateSolNetworkInstanceCommand

Suggest an Edit

Update 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.

Choose the updateType parameter to target the necessary update of the network instance.

Example Syntax

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

import { TnbClient, UpdateSolNetworkInstanceCommand } from "@aws-sdk/client-tnb"; // ES Modules import
// const { TnbClient, UpdateSolNetworkInstanceCommand } = require("@aws-sdk/client-tnb"); // CommonJS import
const client = new TnbClient(config);
const input = { // UpdateSolNetworkInstanceInput
  nsInstanceId: "STRING_VALUE", // required
  updateType: "MODIFY_VNF_INFORMATION" || "UPDATE_NS", // required
  modifyVnfInfoData: { // UpdateSolNetworkModify
    vnfInstanceId: "STRING_VALUE", // required
    vnfConfigurableProperties: "DOCUMENT_VALUE", // required
  },
  updateNs: { // UpdateSolNetworkServiceData
    nsdInfoId: "STRING_VALUE", // required
    additionalParamsForNs: "DOCUMENT_VALUE",
  },
  tags: { // TagMap
    "<keys>": "STRING_VALUE",
  },
};
const command = new UpdateSolNetworkInstanceCommand(input);
const response = await client.send(command);
// { // UpdateSolNetworkInstanceOutput
//   nsLcmOpOccId: "STRING_VALUE",
//   tags: { // TagMap
//     "<keys>": "STRING_VALUE",
//   },
// };

UpdateSolNetworkInstanceCommand Input

See UpdateSolNetworkInstanceCommandInput for more details

Parameter
Type
Description
nsInstanceId
Required
string | undefined

ID of the network instance.

updateType
Required
UpdateSolNetworkType | undefined

The type of update.

  • Use the MODIFY_VNF_INFORMATION update type, to update a specific network function configuration, in the network instance.

  • Use the UPDATE_NS update type, to update the network instance to a new network service descriptor.

modifyVnfInfoData
UpdateSolNetworkModify | undefined

Identifies the network function information parameters and/or the configurable properties of the network function to be modified.

Include this property only if the update type is MODIFY_VNF_INFORMATION.

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. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

updateNs
UpdateSolNetworkServiceData | undefined

Identifies the network service descriptor and the configurable properties of the descriptor, to be used for the update.

Include this property only if the update type is UPDATE_NS.

UpdateSolNetworkInstanceCommand Output

See UpdateSolNetworkInstanceCommandOutput for details

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

The identifier of the network operation.

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. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. 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.