ControlTower / Paginator / ListEnabledControls

ListEnabledControls#

class ControlTower.Paginator.ListEnabledControls#
paginator = client.get_paginator('list_enabled_controls')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    targetIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • targetIdentifier (string) –

    [REQUIRED]

    The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

  • 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

{
    'enabledControls': [
        {
            'arn': 'string',
            'controlIdentifier': 'string',
            'driftStatusSummary': {
                'driftStatus': 'DRIFTED'|'IN_SYNC'|'NOT_CHECKING'|'UNKNOWN'
            },
            'statusSummary': {
                'lastOperationIdentifier': 'string',
                'status': 'SUCCEEDED'|'FAILED'|'UNDER_CHANGE'
            },
            'targetIdentifier': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • enabledControls (list) –

      Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.

      • (dict) –

        Returns a summary of information about an enabled control.

        • arn (string) –

          The ARN of the enabled control.

        • controlIdentifier (string) –

          The controlIdentifier of the enabled control.

        • driftStatusSummary (dict) –

          The drift status of the enabled control.

          • driftStatus (string) –

            The drift status of the enabled control.

            Valid values:

            • DRIFTED: The enabledControl deployed in this configuration doesn’t match the configuration that Amazon Web Services Control Tower expected.

            • IN_SYNC: The enabledControl deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.

            • NOT_CHECKING: Amazon Web Services Control Tower does not check drift for this enabled control. Drift is not supported for the control type.

            • UNKNOWN: Amazon Web Services Control Tower is not able to check the drift status for the enabled control.

        • statusSummary (dict) –

          A short description of the status of the enabled control.

          • lastOperationIdentifier (string) –

            The last operation identifier for the enabled control.

          • status (string) –

            The deployment status of the enabled control.

            Valid values:

            • SUCCEEDED: The enabledControl configuration was deployed successfully.

            • UNDER_CHANGE: The enabledControl configuration is changing.

            • FAILED: The enabledControl configuration failed to deploy.

        • targetIdentifier (string) –

          The ARN of the organizational unit.

    • NextToken (string) –

      A token to resume pagination.