ControlTower / Client / get_baseline_operation

get_baseline_operation#

ControlTower.Client.get_baseline_operation(**kwargs)#

Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure. For usage examples, see the Amazon Web Services Control Tower User Guide.

Request Syntax

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

Parameters:

operationIdentifier (string) –

[REQUIRED]

The operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset).

Return type:

dict

Returns:

Response Syntax

{
    'baselineOperation': {
        'endTime': datetime(2015, 1, 1),
        'operationIdentifier': 'string',
        'operationType': 'ENABLE_BASELINE'|'DISABLE_BASELINE'|'UPDATE_ENABLED_BASELINE'|'RESET_ENABLED_BASELINE',
        'startTime': datetime(2015, 1, 1),
        'status': 'SUCCEEDED'|'FAILED'|'IN_PROGRESS',
        'statusMessage': 'string'
    }
}

Response Structure

(dict) –
- baselineOperation (dict) –
  
  A baselineOperation object that shows information about the specified operation ID.
  - endTime (datetime) –
    
    The end time of the operation (if applicable), in ISO 8601 format.
  - operationIdentifier (string) –
    
    The identifier of the specified operation.
  - operationType (string) –
    
    An enumerated type ( enum) with possible values of ENABLE_BASELINE, DISABLE_BASELINE, UPDATE_ENABLED_BASELINE, or RESET_ENABLED_BASELINE.
  - startTime (datetime) –
    
    The start time of the operation, in ISO 8601 format.
  - status (string) –
    
    An enumerated type ( enum) with possible values of SUCCEEDED, FAILED, or IN_PROGRESS.
  - statusMessage (string) –
    
    A status message that gives more information about the operation’s status, if applicable.

Exceptions

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