Update 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.
Choose the updateType parameter to target the necessary update of the network instance.
Request Syntax
POST /sol/nslcm/v1/ns_instances/nsInstanceId/update HTTP/1.1
Content-type: application/json
{
"modifyVnfInfoData": {
"vnfConfigurableProperties": JSON value,
"vnfInstanceId": "string"
},
"tags": {
"string" : "string"
},
"updateNs": {
"additionalParamsForNs": JSON value,
"nsdInfoId": "string"
},
"updateType": "string"
}URI Request Parameters
The request uses the following URI parameters.
- nsInstanceId
-
ID of the network instance.
Pattern:
^ni-[a-f0-9]{17}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- modifyVnfInfoData
-
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.Type: UpdateSolNetworkModify object
Required: No
-
A tag is a label that you assign to an AWS 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 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
- updateNs
-
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.Type: UpdateSolNetworkServiceData object
Required: No
- updateType
-
The type of update.
-
Use the
MODIFY_VNF_INFORMATIONupdate type, to update a specific network function configuration, in the network instance. -
Use the
UPDATE_NSupdate type, to update the network instance to a new network service descriptor.
Type: String
Valid Values:
MODIFY_VNF_INFORMATION | UPDATE_NSRequired: Yes
-
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"nsLcmOpOccId": "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.
- nsLcmOpOccId
-
The identifier of the network operation.
Type: String
Pattern:
^no-[a-f0-9]{17}$ -
A tag is a label that you assign to an AWS 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 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
