ControlTower / Client / get_control_operation

get_control_operation#

ControlTower.Client.get_control_operation(**kwargs)#

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.

Request Syntax

response = client.get_control_operation(
    operationIdentifier='string'
)

Parameters:

operationIdentifier (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'controlOperation': {
        'controlIdentifier': 'string',
        'enabledControlIdentifier': 'string',
        'endTime': datetime(2015, 1, 1),
        'operationIdentifier': 'string',
        'operationType': 'ENABLE_CONTROL'|'DISABLE_CONTROL'|'UPDATE_ENABLED_CONTROL',
        'startTime': datetime(2015, 1, 1),
        'status': 'SUCCEEDED'|'FAILED'|'IN_PROGRESS',
        'statusMessage': 'string',
        'targetIdentifier': 'string'
    }
}

Response Structure

(dict) –
- controlOperation (dict) –
  
  An operation performed by the control.
  - controlIdentifier (string) –
    
    The controlIdentifier of the control for the operation.
  - enabledControlIdentifier (string) –
    
    The controlIdentifier of the enabled control.
  - endTime (datetime) –
    
    The time that the operation finished.
  - operationIdentifier (string) –
    
    The identifier of the specified operation.
  - operationType (string) –
    
    One of ENABLE_CONTROL or DISABLE_CONTROL.
  - startTime (datetime) –
    
    The time that the operation began.
  - status (string) –
    
    One of IN_PROGRESS, SUCEEDED, or FAILED.
  - statusMessage (string) –
    
    If the operation result is FAILED, this string contains a message explaining why the operation failed.
  - targetIdentifier (string) –
    
    The target upon which the control operation is working.

Exceptions

ControlTower.Client.exceptions.ValidationException
ControlTower.Client.exceptions.InternalServerException
ControlTower.Client.exceptions.AccessDeniedException
ControlTower.Client.exceptions.ThrottlingException
ControlTower.Client.exceptions.ResourceNotFoundException