ControlTower / Paginator / ListControlOperations

ListControlOperations

class ControlTower.Paginator.ListControlOperations

paginator = client.get_paginator('list_control_operations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ControlTower.Client.list_control_operations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filter={
        'controlIdentifiers': [
            'string',
        ],
        'controlOperationTypes': [
            'ENABLE_CONTROL'|'DISABLE_CONTROL'|'UPDATE_ENABLED_CONTROL',
        ],
        'enabledControlIdentifiers': [
            'string',
        ],
        'statuses': [
            'SUCCEEDED'|'FAILED'|'IN_PROGRESS',
        ],
        'targetIdentifiers': [
            'string',
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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',
            '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. PLACEHOLDER

    • (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 token to resume pagination.