GetControlOperationCommand

Suggest an Edit

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 Controls Reference Guide  .

Example Syntax

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

import { ControlTowerClient, GetControlOperationCommand } from "@aws-sdk/client-controltower"; // ES Modules import
// const { ControlTowerClient, GetControlOperationCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
const client = new ControlTowerClient(config);
const input = { // GetControlOperationInput
  operationIdentifier: "STRING_VALUE", // required
};
const command = new GetControlOperationCommand(input);
const response = await client.send(command);
// { // GetControlOperationOutput
//   controlOperation: { // ControlOperation
//     operationType: "ENABLE_CONTROL" || "DISABLE_CONTROL" || "UPDATE_ENABLED_CONTROL" || "RESET_ENABLED_CONTROL",
//     startTime: new Date("TIMESTAMP"),
//     endTime: new Date("TIMESTAMP"),
//     status: "SUCCEEDED" || "FAILED" || "IN_PROGRESS",
//     statusMessage: "STRING_VALUE",
//     operationIdentifier: "STRING_VALUE",
//     controlIdentifier: "STRING_VALUE",
//     targetIdentifier: "STRING_VALUE",
//     enabledControlIdentifier: "STRING_VALUE",
//   },
// };

GetControlOperationCommand Input

See GetControlOperationCommandInput for more details

Parameter
Type
Description
operationIdentifier
Required
string | undefined

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

GetControlOperationCommand Output

See GetControlOperationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
controlOperation
Required
ControlOperation | undefined

An operation performed by the control.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

An unexpected error occurred during processing of a request.

ResourceNotFoundException
client

The request references a resource that does not exist.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input does not satisfy the constraints specified by an Amazon Web Services service.

ControlTowerServiceException
Base exception class for all service exceptions from ControlTower service.