ControlTower / Client / enable_baseline

enable_baseline

ControlTower.Client.enable_baseline(**kwargs)

Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target.

See also: AWS API Documentation

Request Syntax

response = client.enable_baseline(
    baselineIdentifier='string',
    baselineVersion='string',
    parameters=[
        {
            'key': 'string',
            'value': {...}|[...]|123|123.4|'string'|True|None
        },
    ],
    tags={
        'string': 'string'
    },
    targetIdentifier='string'
)

Parameters:

• baselineIdentifier (string) –

  [REQUIRED]

  The ARN of the baseline to be enabled.

• baselineVersion (string) –

  [REQUIRED]

  The specific version to be enabled of the specified baseline.

• parameters (list) –

  A list of key-value objects that specify enablement parameters, where key is a string and value is a document of any type.

  • (dict) –

    A key-value parameter to an EnabledBaseline resource.

    • key (string) – [REQUIRED]

      A string denoting the parameter key.

    • value (document) – [REQUIRED]

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

• tags (dict) –

  Tags associated with input to EnableBaseline.

  • (string) –

    • (string) –

• targetIdentifier (string) –

  [REQUIRED]

  The ARN of the target on which the baseline will be enabled. Only OUs are supported as targets.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'operationIdentifier': 'string'
}

Response Structure

• (dict) –

  • arn (string) –

    The ARN of the EnabledBaseline resource.

  • operationIdentifier (string) –

    The ID (in UUID format) of the asynchronous EnableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.

Exceptions

• ControlTower.Client.exceptions.ValidationException

• ControlTower.Client.exceptions.ConflictException

• ControlTower.Client.exceptions.ServiceQuotaExceededException

• ControlTower.Client.exceptions.InternalServerException

• ControlTower.Client.exceptions.AccessDeniedException

• ControlTower.Client.exceptions.ThrottlingException

• ControlTower.Client.exceptions.ResourceNotFoundException