ControlTower / Client / list_control_operations

list_control_operations#

ControlTower.Client.list_control_operations(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_control_operations(
    filter={
        'controlIdentifiers': [
            'string',
        ],
        'controlOperationTypes': [
            'ENABLE_CONTROL'|'DISABLE_CONTROL'|'UPDATE_ENABLED_CONTROL'|'RESET_ENABLED_CONTROL',
        ],
        'enabledControlIdentifiers': [
            'string',
        ],
        'statuses': [
            'SUCCEEDED'|'FAILED'|'IN_PROGRESS',
        ],
        'targetIdentifiers': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='string'
)
Parameters:

  • filter (dict) –

    An input filter for the ListControlOperations API that lets you select the types of control operations to view.

    • controlIdentifiers (list) –

      The set of controlIdentifier returned by the filter.

      • (string) –

    • controlOperationTypes (list) –

      The set of ControlOperation objects returned by the filter.

      • (string) –

    • enabledControlIdentifiers (list) –

      The set controlIdentifier of enabled controls selected by the filter.

      • (string) –

    • statuses (list) –

      Lists the status of control operations.

      • (string) –

    • targetIdentifiers (list) –

      The set of targetIdentifier objects returned by the filter.

      • (string) –

  • maxResults (integer) – The maximum number of results to be shown.

  • nextToken (string) – A pagination token.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • controlOperations (list) –

      Returns a list of output from control operations.

      • (dict) –

        A summary of information about the specified control operation.

        • controlIdentifier (string) –

          The controlIdentifier of a control.

        • enabledControlIdentifier (string) –

          The controlIdentifier of an enabled control.

        • endTime (datetime) –

          The time at which the control operation was completed.

        • operationIdentifier (string) –

          The unique identifier of a control operation.

        • operationType (string) –

          The type of operation.

        • startTime (datetime) –

          The time at which a control operation began.

        • status (string) –

          The status of the specified control operation.

        • statusMessage (string) –

          A speficic message displayed as part of the control status.

        • targetIdentifier (string) –

          The unique identifier of the target of a control operation.

    • nextToken (string) –

      A pagination token.

Exceptions