control_operations

Creates, updates, deletes, gets or lists a control_operations resource.

Overview

Name	control_operations
Type	Resource
Id	aws.controltower.control_operations

Fields

The following fields are returned by SELECT queries:

get_control_operation

Name	Datatype	Description
control_identifier	string	The controlIdentifier of the control for the operation. (pattern: <code>arn:aws[0-9a-zA-Z_-:/]+</code>)
enabled_control_identifier	string	The controlIdentifier of the enabled control. (pattern: <code>arn:aws[0-9a-zA-Z_-:/]+</code>)
end_time	string (date-time)	The time that the operation finished.
operation_identifier	string	The identifier of the specified operation. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
operation_type	string	One of ENABLE_CONTROL or DISABLE_CONTROL. (ENABLE_CONTROL, DISABLE_CONTROL, UPDATE_ENABLED_CONTROL, RESET_ENABLED_CONTROL)
start_time	string (date-time)	The time that the operation began.
status	string	One of IN_PROGRESS, SUCEEDED, or FAILED. (SUCCEEDED, FAILED, IN_PROGRESS)
status_message	string	If the operation result is FAILED, this string contains a message explaining why the operation failed.
target_identifier	string	The target upon which the control operation is working. (pattern: <code>arn:aws[0-9a-zA-Z_-:/]+</code>)

list_control_operations

Name	Datatype	Description
control_identifier	string	The controlIdentifier of a control. (pattern: <code>arn:aws[0-9a-zA-Z_-:/]+</code>)
enabled_control_identifier	string	The controlIdentifier of an enabled control. (pattern: <code>arn:aws[0-9a-zA-Z_-:/]+</code>)
end_time	string (date-time)	The time at which the control operation was completed.
operation_identifier	string	The unique identifier of a control operation. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
operation_type	string	The type of operation. (ENABLE_CONTROL, DISABLE_CONTROL, UPDATE_ENABLED_CONTROL, RESET_ENABLED_CONTROL)
start_time	string (date-time)	The time at which a control operation began.
status	string	The status of the specified control operation. (SUCCEEDED, FAILED, IN_PROGRESS)
status_message	string	A speficic message displayed as part of the control status.
target_identifier	string	The unique identifier of the target of a control operation. (pattern: <code>arn:aws[0-9a-zA-Z_-:/]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_control_operation	select	region		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 .
list_control_operations	select	region		Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_control_operation

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 .

SELECT
control_identifier,
enabled_control_identifier,
end_time,
operation_identifier,
operation_type,
start_time,
status,
status_message,
target_identifier
FROM aws.controltower.control_operations
WHERE region = '{{ region }}' -- required
;

list_control_operations

Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.

SELECT
control_identifier,
enabled_control_identifier,
end_time,
operation_identifier,
operation_type,
start_time,
status,
status_message,
target_identifier
FROM aws.controltower.control_operations
WHERE region = '{{ region }}' -- required
;