ControlTower / Client / list_enabled_baselines

list_enabled_baselines#

ControlTower.Client.list_enabled_baselines(**kwargs)#

Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources.

See also: AWS API Documentation

Request Syntax

response = client.list_enabled_baselines(
    filter={
        'baselineIdentifiers': [
            'string',
        ],
        'targetIdentifiers': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='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) –

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

  • nextToken (string) – A pagination token.

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 pagination token.

Exceptions

  • ControlTower.Client.exceptions.ValidationException

  • ControlTower.Client.exceptions.InternalServerException

  • ControlTower.Client.exceptions.AccessDeniedException

  • ControlTower.Client.exceptions.ThrottlingException