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

GetSolNetworkOperation

Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks.

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

Request Syntax


GET /sol/nslcm/v1/ns_lcm_op_occs/nsLcmOpOccId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

nsLcmOpOccId

The identifier of the network operation.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "error": { 
      "detail": "string",
      "title": "string"
   },
   "id": "string",
   "lcmOperationType": "string",
   "metadata": { 
      "createdAt": "string",
      "lastModified": "string"
   },
   "nsInstanceId": "string",
   "operationState": "string",
   "tags": { 
      "string" : "string" 
   },
   "tasks": [ 
      { 
         "taskContext": { 
            "string" : "string" 
         },
         "taskEndTime": "string",
         "taskErrorDetails": { 
            "cause": "string",
            "details": "string"
         },
         "taskName": "string",
         "taskStartTime": "string",
         "taskStatus": "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.

arn

Network operation 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-operation/no-[a-f0-9]{17})$

error

Error related to this specific network operation occurrence.

Type: ProblemDetails object

id

ID of this network operation occurrence.

Type: String

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

lcmOperationType

Type of the operation represented by this occurrence.

Type: String

Valid Values: INSTANTIATE | UPDATE | TERMINATE

metadata

Metadata of this network operation occurrence.

Type: GetSolNetworkOperationMetadata object

nsInstanceId

ID of the network operation instance.

Type: String

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

operationState

The state of the network operation.

Type: String

Valid Values: PROCESSING | COMPLETED | FAILED | CANCELLING | CANCELLED

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.

tasks

All tasks associated with this operation occurrence.

Type: Array of GetSolNetworkOperationTaskDetails objects

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

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