ControlTower / Paginator / ListEnabledBaselines

ListEnabledBaselines

class ControlTower.Paginator.ListEnabledBaselines

paginator = client.get_paginator('list_enabled_baselines')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filter={
        'baselineIdentifiers': [
            'string',
        ],
        'targetIdentifiers': [
            'string',
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filter (dict) –

  A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.

  • baselineIdentifiers (list) –

    Identifiers for the Baseline objects returned as part of the filter operation.

    • (string) –

  • targetIdentifiers (list) –

    Identifiers for the targets of the Baseline filter operation.

    • (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

{
    'enabledBaselines': [
        {
            'arn': 'string',
            'baselineIdentifier': 'string',
            'baselineVersion': 'string',
            'statusSummary': {
                'lastOperationIdentifier': 'string',
                'status': 'SUCCEEDED'|'FAILED'|'UNDER_CHANGE'
            },
            'targetIdentifier': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • enabledBaselines (list) –

    Retuens a list of summaries of EnabledBaseline resources.

    • (dict) –

      Returns a summary of information about an EnabledBaseline object.

      • arn (string) –

        The ARN of the EnabledBaseline resource

      • baselineIdentifier (string) –

        The specific baseline that is enabled as part of the EnabledBaseline resource.

      • baselineVersion (string) –

        The enabled version of the baseline.

      • statusSummary (dict) –

        The deployment summary 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 target upon which the baseline is enabled.

  • NextToken (string) –

    A token to resume pagination.