AWS Control Tower

{'enabledBaselineDetails': {'parentIdentifier': 'string'}}

Retrieve details of an EnabledBaseline resource by specifying its identifier.

See also: AWS API Documentation

Request Syntax

client.get_enabled_baseline(
    enabledBaselineIdentifier='string'
)

type enabledBaselineIdentifier:

string

param enabledBaselineIdentifier:

[REQUIRED]

Identifier of the EnabledBaseline resource to be retrieved, in ARN format.

rtype:

dict

returns:

Response Syntax

{
    'enabledBaselineDetails': {
        'arn': 'string',
        'baselineIdentifier': 'string',
        'baselineVersion': 'string',
        'parameters': [
            {
                'key': 'string',
                'value': {...}|[...]|123|123.4|'string'|True|None
            },
        ],
        'parentIdentifier': 'string',
        'statusSummary': {
            'lastOperationIdentifier': 'string',
            'status': 'SUCCEEDED'|'FAILED'|'UNDER_CHANGE'
        },
        'targetIdentifier': 'string'
    }
}

Response Structure

• (dict) --

  • enabledBaselineDetails (dict) --

    Details of the EnabledBaseline resource.

    • arn (string) --

      The ARN of the EnabledBaseline resource.

    • baselineIdentifier (string) --

      The specific Baseline enabled as part of the EnabledBaseline resource.

    • baselineVersion (string) --

      The enabled version of the Baseline.

    • parameters (list) --

      Shows the parameters that are applied when enabling this Baseline.

      • (dict) --

        Summary of an applied parameter to an EnabledBaseline resource.

        • key (string) --

          A string denoting the parameter key.

        • value (:ref:`document<document>`) --

          A low-level document object of any type (for example, a Java Object).

    • parentIdentifier (string) --

      An ARN that represents the parent EnabledBaseline at the Organizational Unit (OU) level, from which the child EnabledBaseline inherits its configuration. The value is returned by GetEnabledBaseline.

    • statusSummary (dict) --

      The deployment summary of an EnabledControl or EnabledBaseline resource.

      • lastOperationIdentifier (string) --

        The last operation identifier for the enabled resource.

      • status (string) --

        The deployment status of the enabled resource.

        Valid values:

        • SUCCEEDED: The EnabledControl or EnabledBaseline configuration was deployed successfully.

        • UNDER_CHANGE: The EnabledControl or EnabledBaseline configuration is changing.

        • FAILED: The EnabledControl or EnabledBaseline configuration failed to deploy.

    • targetIdentifier (string) --

      The target on which to enable the Baseline.

{'filter': {'parentIdentifiers': ['string']}, 'includeChildren': 'boolean'}

{'enabledBaselines': {'parentIdentifier': 'string'}}

Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources. For usage examples, see the Amazon Web Services Control Tower User Guide.

See also: AWS API Documentation

Request Syntax

client.list_enabled_baselines(
    filter={
        'baselineIdentifiers': [
            'string',
        ],
        'parentIdentifiers': [
            'string',
        ],
        'targetIdentifiers': [
            'string',
        ]
    },
    includeChildren=True|False,
    maxResults=123,
    nextToken='string'
)

type filter:

dict

param filter:

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) --

• parentIdentifiers (list) --

  An optional filter that sets up a list of parentIdentifiers to filter the results of the ListEnabledBaseline output.

  • (string) --

• targetIdentifiers (list) --

  Identifiers for the targets of the Baseline filter operation.

  • (string) --

type includeChildren:

boolean

param includeChildren:

A value that can be set to include the child enabled baselines in responses. The default value is false.

type maxResults:

integer

param maxResults:

The maximum number of results to be shown.

type nextToken:

string

param nextToken:

A pagination token.

rtype:

dict

returns:

Response Syntax

{
    'enabledBaselines': [
        {
            'arn': 'string',
            'baselineIdentifier': 'string',
            'baselineVersion': 'string',
            'parentIdentifier': '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.

      • parentIdentifier (string) --

        An ARN that represents an object returned by ListEnabledBaseline, to describe an enabled baseline.

      • statusSummary (dict) --

        The deployment summary of an EnabledControl or EnabledBaseline resource.

        • lastOperationIdentifier (string) --

          The last operation identifier for the enabled resource.

        • status (string) --

          The deployment status of the enabled resource.

          Valid values:

          • SUCCEEDED: The EnabledControl or EnabledBaseline configuration was deployed successfully.

          • UNDER_CHANGE: The EnabledControl or EnabledBaseline configuration is changing.

          • FAILED: The EnabledControl or EnabledBaseline configuration failed to deploy.

      • targetIdentifier (string) --

        The target upon which the baseline is enabled.

  • nextToken (string) --

    A pagination token.