GetControlOperation - AWS Control Tower

GetControlOperation

Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the AWS Control Tower User Guide.

Request Syntax

POST /get-control-operation HTTP/1.1 Content-type: application/json { "operationIdentifier": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

operationIdentifier

The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "controlOperation": { "controlIdentifier": "string", "enabledControlIdentifier": "string", "endTime": "string", "operationIdentifier": "string", "operationType": "string", "startTime": "string", "status": "string", "statusMessage": "string", "targetIdentifier": "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.

controlOperation

An operation performed by the control.

Type: ControlOperation object

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred during processing of a request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

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