AWS Cloud Map
API Reference (API Version 2017-03-14)

GetOperation

Gets information about any operation that returns an operation ID in the response, such as a CreateService request.

Note

To get a list of operations that match specified criteria, see ListOperations.

Request Syntax

{ "OperationId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

OperationId

The ID of the operation that you want to get more information about.

Type: String

Length Constraints: Maximum length of 64.

Required: Yes

Response Syntax

{ "Operation": { "CreateDate": number, "ErrorCode": "string", "ErrorMessage": "string", "Id": "string", "Status": "string", "Targets": { "string" : "string" }, "Type": "string", "UpdateDate": number } }

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.

Operation

A complex type that contains information about the operation.

Type: Operation object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidInput

One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.

HTTP Status Code: 400

OperationNotFound

No operation exists with the specified ID.

HTTP Status Code: 400

Example

GetOperation Example

Sample Request

POST / HTTP/1.1 host:servicediscovery.us-west-2.amazonaws.com x-amz-date:20181118T211710Z authorization: AWS4-HMAC-SHA256 Credential=AKIAIIO2CIV3EXAMPLE/20181118/us-west-2/servicediscovery/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target, Signature=[calculated-signature] x-amz-target:Route53AutoNaming_v20170314.GetOperation content-type:application/x-amz-json-1.1 content-length:[number of characters in the JSON string] { "OperationId": "deleteelozuhfet5kzxoxg-a-response-example" }

Sample Response

HTTP/1.1 200 Content-Length: 215 Content-Type: application/x-amz-json-1.1 { "Operation": { "CreateDate": "20181118T211707Z", "Id": "deleteelozuhfet5kzxoxg-a-response-example", "Status": "SUCCESS", "Targets": { "NAMESPACE": "ns-e4anhexample0004" }, "Type": "DELETE_NAMESPACE", "UpdateDate": "20181118T211708Z" } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: