Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

EnableBaseline

Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target. For usage examples, see the AWS Control Tower User Guide.

Request Syntax


POST /enable-baseline HTTP/1.1
Content-type: application/json

{
   "baselineIdentifier": "string",
   "baselineVersion": "string",
   "parameters": [ 
      { 
         "key": "string",
         "value": JSON value
      }
   ],
   "tags": { 
      "string" : "string" 
   },
   "targetIdentifier": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

baselineIdentifier

The ARN of the baseline to be enabled.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[0-9a-zA-Z_\-:\/]+$

Required: Yes

baselineVersion

The specific version to be enabled of the specified baseline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10.

Pattern: ^\d+(?:\.\d+){0,2}$

Required: Yes

parameters

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

Type: Array of EnabledBaselineParameter objects

Required: No

tags

Tags associated with input to EnableBaseline.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

targetIdentifier

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[0-9a-zA-Z_\-:\/]+$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "operationIdentifier": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

The ARN of the EnabledBaseline resource.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[0-9a-zA-Z_\-:\/]+$

operationIdentifier

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

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

Updating or deleting the resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred during processing of a request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400