Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
" }, "DeleteLandingZone":{ "name":"DeleteLandingZone", "http":{ "method":"POST", "requestUri":"/delete-landingzone", "responseCode":200 }, "input":{"shape":"DeleteLandingZoneInput"}, "output":{"shape":"DeleteLandingZoneOutput"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.
Decommissioning a landing zone is a process with significant consequences, and it cannot be undone. We strongly recommend that you perform this decommissioning process only if you intend to stop using your landing zone.
", "idempotent":true }, "DisableBaseline":{ "name":"DisableBaseline", "http":{ "method":"POST", "requestUri":"/disable-baseline", "responseCode":200 }, "input":{"shape":"DisableBaselineInput"}, "output":{"shape":"DisableBaselineOutput"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Disable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Controls Reference Guide .
" }, "EnableBaseline":{ "name":"EnableBaseline", "http":{ "method":"POST", "requestUri":"/enable-baseline", "responseCode":200 }, "input":{"shape":"EnableBaselineInput"}, "output":{"shape":"EnableBaselineOutput"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"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 Amazon Web Services Control Tower User Guide .
This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Controls Reference Guide .
" }, "GetBaseline":{ "name":"GetBaseline", "http":{ "method":"POST", "requestUri":"/get-baseline", "responseCode":200 }, "input":{"shape":"GetBaselineInput"}, "output":{"shape":"GetBaselineOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieve details about an existing Baseline resource by specifying its identifier. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Controls Reference Guide .
Retrieve details of an EnabledBaseline resource by specifying its identifier.
Retrieves details about an enabled control. For usage examples, see the Controls Reference Guide .
", "readonly":true }, "GetLandingZone":{ "name":"GetLandingZone", "http":{ "method":"POST", "requestUri":"/get-landingzone", "responseCode":200 }, "input":{"shape":"GetLandingZoneInput"}, "output":{"shape":"GetLandingZoneOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns details about the landing zone. Displays a message in case of error.
", "readonly":true }, "GetLandingZoneOperation":{ "name":"GetLandingZoneOperation", "http":{ "method":"POST", "requestUri":"/get-landingzone-operation", "responseCode":200 }, "input":{"shape":"GetLandingZoneOperationInput"}, "output":{"shape":"GetLandingZoneOperationOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.
", "readonly":true }, "ListBaselines":{ "name":"ListBaselines", "http":{ "method":"POST", "requestUri":"/list-baselines", "responseCode":200 }, "input":{"shape":"ListBaselinesInput"}, "output":{"shape":"ListBaselinesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .
", "readonly":true }, "ListControlOperations":{ "name":"ListControlOperations", "http":{ "method":"POST", "requestUri":"/list-control-operations", "responseCode":200 }, "input":{"shape":"ListControlOperationsInput"}, "output":{"shape":"ListControlOperationsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.
", "readonly":true }, "ListEnabledBaselines":{ "name":"ListEnabledBaselines", "http":{ "method":"POST", "requestUri":"/list-enabled-baselines", "responseCode":200 }, "input":{"shape":"ListEnabledBaselinesInput"}, "output":{"shape":"ListEnabledBaselinesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"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 .
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the Controls Reference Guide .
", "readonly":true }, "ListLandingZoneOperations":{ "name":"ListLandingZoneOperations", "http":{ "method":"POST", "requestUri":"/list-landingzone-operations", "responseCode":200 }, "input":{"shape":"ListLandingZoneOperationsInput"}, "output":{"shape":"ListLandingZoneOperationsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Lists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.
", "readonly":true }, "ListLandingZones":{ "name":"ListLandingZones", "http":{ "method":"POST", "requestUri":"/list-landingzones", "responseCode":200 }, "input":{"shape":"ListLandingZonesInput"}, "output":{"shape":"ListLandingZonesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns the landing zone ARN for the landing zone deployed in your managed account. This API also creates an ARN for existing accounts that do not yet have a landing zone ARN.
Returns one landing zone ARN.
", "readonly":true }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceInput"}, "output":{"shape":"ListTagsForResourceOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Returns a list of tags associated with the resource. For usage examples, see the Controls Reference Guide .
", "readonly":true }, "ResetEnabledBaseline":{ "name":"ResetEnabledBaseline", "http":{ "method":"POST", "requestUri":"/reset-enabled-baseline", "responseCode":200 }, "input":{"shape":"ResetEnabledBaselineInput"}, "output":{"shape":"ResetEnabledBaselineOutput"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU. For usage examples, see the Amazon Web Services Control Tower User Guide .
Resets an enabled control. Does not work for controls implemented with SCPs.
" }, "ResetLandingZone":{ "name":"ResetLandingZone", "http":{ "method":"POST", "requestUri":"/reset-landingzone", "responseCode":200 }, "input":{"shape":"ResetLandingZoneInput"}, "output":{"shape":"ResetLandingZoneOutput"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in the original configuration, which you specified in the manifest file. Nothing in the manifest file's original landing zone configuration is changed during the reset process, by default. This API is not the same as a rollback of a landing zone version, which is not a supported operation.
" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}", "responseCode":204 }, "input":{"shape":"TagResourceInput"}, "output":{"shape":"TagResourceOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Applies tags to a resource. For usage examples, see the Controls Reference Guide .
" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}", "responseCode":204 }, "input":{"shape":"UntagResourceInput"}, "output":{"shape":"UntagResourceOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Removes tags from a resource. For usage examples, see the Controls Reference Guide .
" }, "UpdateEnabledBaseline":{ "name":"UpdateEnabledBaseline", "http":{ "method":"POST", "requestUri":"/update-enabled-baseline", "responseCode":200 }, "input":{"shape":"UpdateEnabledBaselineInput"}, "output":{"shape":"UpdateEnabledBaselineOutput"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .
Updates the configuration of an already enabled control.
If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.
If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower updates the control to match any valid parameters that you supply.
If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling the ResetEnabledControl API. Alternatively, you can call DisableControl and then call EnableControl again. Also, you can run an extending governance operation to repair drift. For usage examples, see the Controls Reference Guide .
This API call updates the landing zone. It starts an asynchronous operation that updates the landing zone based on the new landing zone version, or on the changed parameters specified in the updated manifest file.
" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"You do not have sufficient access to perform this action.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "Arn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws[0-9a-zA-Z_\\-:\\/]+" }, "BaselineArn":{ "type":"string", "pattern":"arn:[a-z-]+:controltower:[a-z0-9-]*:[0-9]{0,12}:baseline/[A-Z0-9]{16}" }, "BaselineOperation":{ "type":"structure", "members":{ "operationIdentifier":{ "shape":"OperationIdentifier", "documentation":"The identifier of the specified operation.
" }, "operationType":{ "shape":"BaselineOperationType", "documentation":"An enumerated type (enum) with possible values of ENABLE_BASELINE, DISABLE_BASELINE, UPDATE_ENABLED_BASELINE, or RESET_ENABLED_BASELINE.
An enumerated type (enum) with possible values of SUCCEEDED, FAILED, or IN_PROGRESS.
The start time of the operation, in ISO 8601 format.
" }, "endTime":{ "shape":"Timestamp", "documentation":"The end time of the operation (if applicable), in ISO 8601 format.
" }, "statusMessage":{ "shape":"String", "documentation":"A status message that gives more information about the operation's status, if applicable.
" } }, "documentation":"An object of shape BaselineOperation, returning details about the specified Baseline operation ID.
The full ARN of a Baseline.
" }, "name":{ "shape":"String", "documentation":"The human-readable name of a Baseline.
" }, "description":{ "shape":"String", "documentation":"A summary description of a Baseline.
" } }, "documentation":"Returns a summary of information about a Baseline object.
Updating or deleting the resource can cause an inconsistent state.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "ControlIdentifier":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws[0-9a-zA-Z_\\-:\\/]+" }, "ControlIdentifiers":{ "type":"list", "member":{"shape":"ControlIdentifier"}, "max":1, "min":1 }, "ControlOperation":{ "type":"structure", "members":{ "operationType":{ "shape":"ControlOperationType", "documentation":"One of ENABLE_CONTROL or DISABLE_CONTROL.
The time that the operation began.
" }, "endTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The time that the operation finished.
" }, "status":{ "shape":"ControlOperationStatus", "documentation":"One of IN_PROGRESS, SUCEEDED, or FAILED.
If the operation result is FAILED, this string contains a message explaining why the operation failed.
The identifier of the specified operation.
" }, "controlIdentifier":{ "shape":"ControlIdentifier", "documentation":"The controlIdentifier of the control for the operation.
The target upon which the control operation is working.
" }, "enabledControlIdentifier":{ "shape":"Arn", "documentation":"The controlIdentifier of the enabled control.
An operation performed by the control.
" }, "ControlOperationFilter":{ "type":"structure", "members":{ "controlIdentifiers":{ "shape":"ControlIdentifiers", "documentation":"The set of controlIdentifier returned by the filter.
The set of targetIdentifier objects returned by the filter.
The set controlIdentifier of enabled controls selected by the filter.
Lists the status of control operations.
" }, "controlOperationTypes":{ "shape":"ControlOperationTypes", "documentation":"The set of ControlOperation objects returned by the filter.
A filter object that lets you call ListControlOperations with a specific filter.
The type of operation.
" }, "startTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The time at which a control operation began.
" }, "endTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The time at which the control operation was completed.
" }, "status":{ "shape":"ControlOperationStatus", "documentation":"The status of the specified control operation.
" }, "statusMessage":{ "shape":"String", "documentation":"A speficic message displayed as part of the control status.
" }, "operationIdentifier":{ "shape":"OperationIdentifier", "documentation":"The unique identifier of a control operation.
" }, "controlIdentifier":{ "shape":"ControlIdentifier", "documentation":"The controlIdentifier of a control.
The unique identifier of the target of a control operation.
" }, "enabledControlIdentifier":{ "shape":"Arn", "documentation":"The controlIdentifier of an enabled control.
A summary of information about the specified control operation.
" }, "ControlOperationType":{ "type":"string", "enum":[ "ENABLE_CONTROL", "DISABLE_CONTROL", "UPDATE_ENABLED_CONTROL", "RESET_ENABLED_CONTROL" ] }, "ControlOperationTypes":{ "type":"list", "member":{"shape":"ControlOperationType"}, "max":1, "min":1 }, "ControlOperations":{ "type":"list", "member":{"shape":"ControlOperationSummary"} }, "CreateLandingZoneInput":{ "type":"structure", "required":["version"], "members":{ "version":{ "shape":"LandingZoneVersion", "documentation":"The landing zone version, for example, 3.0.
" }, "remediationTypes":{ "shape":"RemediationTypes", "documentation":"Specifies the types of remediation actions to apply when creating the landing zone, such as automatic drift correction or compliance enforcement.
" }, "tags":{ "shape":"TagMap", "documentation":"Tags to be applied to the landing zone.
" }, "manifest":{ "shape":"Manifest", "documentation":"The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone.
" } } }, "CreateLandingZoneOutput":{ "type":"structure", "required":[ "arn", "operationIdentifier" ], "members":{ "arn":{ "shape":"Arn", "documentation":"The ARN of the landing zone resource.
" }, "operationIdentifier":{ "shape":"OperationIdentifier", "documentation":"A unique identifier assigned to a CreateLandingZone operation. You can use this identifier as an input of GetLandingZoneOperation to check the operation's status.
The unique identifier of the landing zone.
" } } }, "DeleteLandingZoneOutput":{ "type":"structure", "required":["operationIdentifier"], "members":{ "operationIdentifier":{ "shape":"OperationIdentifier", "documentation":">A unique identifier assigned to a DeleteLandingZone operation. You can use this identifier as an input parameter of GetLandingZoneOperation to check the operation's status.
Identifier of the EnabledBaseline resource to be deactivated, in ARN format.
The ID (in UUID format) of the asynchronous DisableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.
The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The ARN of the enabled control to be disabled, which uniquely identifies the control instance on the target organizational unit.
" } } }, "DisableControlOutput":{ "type":"structure", "required":["operationIdentifier"], "members":{ "operationIdentifier":{ "shape":"OperationIdentifier", "documentation":"The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
" } } }, "Document":{ "type":"structure", "members":{}, "document":true }, "DriftStatus":{ "type":"string", "enum":[ "DRIFTED", "IN_SYNC", "NOT_CHECKING", "UNKNOWN" ] }, "DriftStatusSummary":{ "type":"structure", "members":{ "driftStatus":{ "shape":"DriftStatus", "documentation":"The drift status of the enabled control.
Valid values:
DRIFTED: The enabledControl deployed in this configuration doesn’t match the configuration that Amazon Web Services Control Tower expected.
IN_SYNC: The enabledControl deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.
NOT_CHECKING: Amazon Web Services Control Tower does not check drift for this enabled control. Drift is not supported for the control type.
UNKNOWN: Amazon Web Services Control Tower is not able to check the drift status for the enabled control.
An object that categorizes the different types of drift detected for the enabled control.
" } }, "documentation":"The drift summary of the enabled control.
Amazon Web Services Control Tower expects the enabled control configuration to include all supported and governed Regions. If the enabled control differs from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control.
" }, "DriftStatuses":{ "type":"list", "member":{"shape":"DriftStatus"}, "max":1, "min":1 }, "EnableBaselineInput":{ "type":"structure", "required":[ "baselineVersion", "baselineIdentifier", "targetIdentifier" ], "members":{ "baselineVersion":{ "shape":"BaselineVersion", "documentation":"The specific version to be enabled of the specified baseline.
" }, "parameters":{ "shape":"EnabledBaselineParameters", "documentation":"A list of key-value objects that specify enablement parameters, where key is a string and value is a document of any type.
The ARN of the baseline to be enabled.
" }, "targetIdentifier":{ "shape":"Arn", "documentation":"The ARN of the target on which the baseline will be enabled. Only OUs are supported as targets.
" }, "tags":{ "shape":"TagMap", "documentation":"Tags associated with input to EnableBaseline.
The ID (in UUID format) of the asynchronous EnableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The ARN of the EnabledBaseline resource.
The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.
The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
Tags to be applied to the EnabledControl resource.
A list of input parameter values, which are specified to configure the control when you enable it.
" } } }, "EnableControlOutput":{ "type":"structure", "required":["operationIdentifier"], "members":{ "operationIdentifier":{ "shape":"OperationIdentifier", "documentation":"The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
" }, "arn":{ "shape":"Arn", "documentation":"The ARN of the EnabledControl resource.
The ARN of the EnabledBaseline resource.
The specific Baseline enabled as part of the EnabledBaseline resource.
The enabled version of the Baseline.
The drift status of the enabled baseline.
" }, "targetIdentifier":{ "shape":"String", "documentation":"The target on which to enable the Baseline.
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.
Shows the parameters that are applied when enabling this Baseline.
Details of the EnabledBaseline resource.
The types of drift that can be detected for an enabled baseline. Amazon Web Services Control Tower detects inheritance drift on enabled baselines that apply at the OU level.
" } }, "documentation":"The drift summary of the enabled baseline. Amazon Web Services Control Tower reports inheritance drift when an enabled baseline configuration of a member account is different than the configuration that applies to the OU. Amazon Web Services Control Tower reports this type of drift for a parent or child enabled baseline. One way to repair this drift by resetting the parent enabled baseline, on the OU.
For example, you may see this type of drift if you move accounts between OUs, but the accounts are not yet (re-)enrolled.
" }, "EnabledBaselineDriftStatuses":{ "type":"list", "member":{"shape":"EnabledBaselineDriftStatus"}, "max":1, "min":1 }, "EnabledBaselineDriftTypes":{ "type":"structure", "members":{ "inheritance":{ "shape":"EnabledBaselineInheritanceDrift", "documentation":"At least one account within the target OU does not match the baseline configuration defined on that OU. An account is in inheritance drift when it does not match the configuration of a parent OU, possibly a new parent OU, if the account is moved.
" } }, "documentation":"The types of drift that can be detected for an enabled baseline.
Amazon Web Services Control Tower detects inheritance drift on the enabled baselines that target OUs: AWSControlTowerBaseline and BackupBaseline.
Amazon Web Services Control Tower does not detect drift on the baselines that apply to your landing zone: IdentityCenterBaseline, AuditBaseline, LogArchiveBaseline, BackupCentralVaultBaseline, or BackupAdminBaseline. For more information, see Types of baselines.
Baselines enabled on an OU are inherited by its member accounts as child EnabledBaseline resources. The baseline on the OU serves as the parent EnabledBaseline, which governs the configuration of each child EnabledBaseline.
If the baseline configuration of a member account in an OU does not match the configuration of the parent OU, the parent and child baseline is in a state of inheritance drift. This drift could occur in the AWSControlTowerBaseline or the BackupBaseline related to that account.
Identifiers for the targets of the Baseline filter operation.
Identifiers for the Baseline objects returned as part of the filter operation.
An optional filter that sets up a list of parentIdentifiers to filter the results of the ListEnabledBaseline output.
A list of EnablementStatus items.
A list of EnabledBaselineDriftStatus items for enabled baselines.
A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.
The inheritance drift status for enabled baselines.
" } }, "documentation":"The inheritance drift summary for the enabled baseline. Inheritance drift occurs when any accounts in the target OU do not match the baseline configuration defined on that OU.
" }, "EnabledBaselineParameter":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"String", "documentation":"A string denoting the parameter key.
" }, "value":{ "shape":"EnabledBaselineParameterDocument", "documentation":"A low-level Document object of any type (for example, a Java Object).
A key-value parameter to an EnabledBaseline resource.
A string denoting the parameter key.
" }, "value":{ "shape":"EnabledBaselineParameterDocument", "documentation":"A low-level document object of any type (for example, a Java Object).
" } }, "documentation":"Summary of an applied parameter to an EnabledBaseline resource.
The ARN of the EnabledBaseline resource
The specific baseline that is enabled as part of the EnabledBaseline resource.
The enabled version of the baseline.
" }, "driftStatusSummary":{ "shape":"EnabledBaselineDriftStatusSummary", "documentation":"The drift status of the enabled baseline.
" }, "targetIdentifier":{ "shape":"String", "documentation":"The target upon which the baseline is enabled.
" }, "parentIdentifier":{ "shape":"Arn", "documentation":"An ARN that represents an object returned by ListEnabledBaseline, to describe an enabled baseline.
Returns a summary of information about an EnabledBaseline object.
The ARN of the enabled control.
" }, "controlIdentifier":{ "shape":"ControlIdentifier", "documentation":"The control identifier of the enabled control. For information on how to find the controlIdentifier, see the overview page.
The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The deployment summary of the enabled control.
" }, "driftStatusSummary":{ "shape":"DriftStatusSummary", "documentation":"The drift status of the enabled control.
" }, "parentIdentifier":{ "shape":"ParentIdentifier", "documentation":"The ARN of the parent enabled control from which this control inherits its configuration, if applicable.
" }, "targetRegions":{ "shape":"TargetRegions", "documentation":"Target Amazon Web Services Regions for the enabled control.
" }, "parameters":{ "shape":"EnabledControlParameterSummaries", "documentation":"Array of EnabledControlParameter objects.
Information about the enabled control.
" }, "EnabledControlDriftTypes":{ "type":"structure", "members":{ "inheritance":{ "shape":"EnabledControlInheritanceDrift", "documentation":"Indicates drift related to inheritance configuration between parent and child controls.
" }, "resource":{ "shape":"EnabledControlResourceDrift", "documentation":"Indicates drift related to the underlying Amazon Web Services resources managed by the control.
" } }, "documentation":"Defines the various categories of drift that can occur for an enabled control resource.
" }, "EnabledControlFilter":{ "type":"structure", "members":{ "controlIdentifiers":{ "shape":"ControlIdentifiers", "documentation":"The set of controlIdentifier returned by the filter.
A list of EnablementStatus items.
A list of DriftStatus items.
Filters enabled controls by their parent control identifiers, allowing you to find child controls of specific parent controls.
" }, "inheritanceDriftStatuses":{ "shape":"DriftStatuses", "documentation":"Filters enabled controls by their inheritance drift status, allowing you to find controls with specific inheritance-related drift conditions.
" }, "resourceDriftStatuses":{ "shape":"DriftStatuses", "documentation":"Filters enabled controls by their resource drift status, allowing you to find controls with specific resource-related drift conditions.
" } }, "documentation":"A structure that returns a set of control identifiers, the control status for each control in the set, and the drift status for each control in the set.
" }, "EnabledControlIdentifiers":{ "type":"list", "member":{"shape":"Arn"}, "max":1, "min":1 }, "EnabledControlInheritanceDrift":{ "type":"structure", "members":{ "status":{ "shape":"DriftStatus", "documentation":"The status of inheritance drift for the enabled control, indicating whether inheritance configuration matches expectations.
" } }, "documentation":"Represents drift information related to control inheritance between organizational units.
" }, "EnabledControlParameter":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"String", "documentation":"The key of a key/value pair.
" }, "value":{ "shape":"Document", "documentation":"The value of a key/value pair.
" } }, "documentation":"A key/value pair, where Key is of type String and Value is of type Document.
The key of a key/value pair.
" }, "value":{ "shape":"Document", "documentation":"The value of a key/value pair.
" } }, "documentation":"Returns a summary of information about the parameters of an enabled control.
" }, "EnabledControlParameters":{ "type":"list", "member":{"shape":"EnabledControlParameter"} }, "EnabledControlResourceDrift":{ "type":"structure", "members":{ "status":{ "shape":"DriftStatus", "documentation":"The status of resource drift for the enabled control, indicating whether the underlying resources match the expected configuration.
" } }, "documentation":"Represents drift information related to the underlying Amazon Web Services resources managed by the control.
" }, "EnabledControlSummary":{ "type":"structure", "members":{ "arn":{ "shape":"Arn", "documentation":"The ARN of the enabled control.
" }, "controlIdentifier":{ "shape":"ControlIdentifier", "documentation":"The controlIdentifier of the enabled control.
The ARN of the organizational unit.
" }, "statusSummary":{ "shape":"EnablementStatusSummary", "documentation":"A short description of the status of the enabled control.
" }, "driftStatusSummary":{ "shape":"DriftStatusSummary", "documentation":"The drift status of the enabled control.
" }, "parentIdentifier":{ "shape":"ParentIdentifier", "documentation":"The ARN of the parent enabled control from which this control inherits its configuration, if applicable.
" } }, "documentation":"Returns a summary of information about an enabled control.
" }, "EnabledControls":{ "type":"list", "member":{"shape":"EnabledControlSummary"} }, "EnablementStatus":{ "type":"string", "enum":[ "SUCCEEDED", "FAILED", "UNDER_CHANGE" ] }, "EnablementStatusSummary":{ "type":"structure", "members":{ "status":{ "shape":"EnablementStatus", "documentation":"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.
The last operation identifier for the enabled resource.
" } }, "documentation":"The deployment summary of an EnabledControl or EnabledBaseline resource.
The ARN of the Baseline resource to be retrieved.
The operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset).
" } } }, "GetBaselineOperationOutput":{ "type":"structure", "required":["baselineOperation"], "members":{ "baselineOperation":{ "shape":"BaselineOperation", "documentation":"A baselineOperation object that shows information about the specified operation ID.
The baseline ARN.
" }, "name":{ "shape":"String", "documentation":"A user-friendly name for the baseline.
" }, "description":{ "shape":"String", "documentation":"A description of the baseline.
" } } }, "GetControlOperationInput":{ "type":"structure", "required":["operationIdentifier"], "members":{ "operationIdentifier":{ "shape":"OperationIdentifier", "documentation":"The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
" } } }, "GetControlOperationOutput":{ "type":"structure", "required":["controlOperation"], "members":{ "controlOperation":{ "shape":"ControlOperation", "documentation":"An operation performed by the control.
" } } }, "GetEnabledBaselineInput":{ "type":"structure", "required":["enabledBaselineIdentifier"], "members":{ "enabledBaselineIdentifier":{ "shape":"Arn", "documentation":"Identifier of the EnabledBaseline resource to be retrieved, in ARN format.
Details of the EnabledBaseline resource.
The controlIdentifier of the enabled control.
Information about the enabled control.
" } } }, "GetLandingZoneInput":{ "type":"structure", "required":["landingZoneIdentifier"], "members":{ "landingZoneIdentifier":{ "shape":"String", "documentation":"The unique identifier of the landing zone.
" } } }, "GetLandingZoneOperationInput":{ "type":"structure", "required":["operationIdentifier"], "members":{ "operationIdentifier":{ "shape":"OperationIdentifier", "documentation":"A unique identifier assigned to a landing zone operation.
" } } }, "GetLandingZoneOperationOutput":{ "type":"structure", "required":["operationDetails"], "members":{ "operationDetails":{ "shape":"LandingZoneOperationDetail", "documentation":"Details about a landing zone operation.
" } } }, "GetLandingZoneOutput":{ "type":"structure", "required":["landingZone"], "members":{ "landingZone":{ "shape":"LandingZoneDetail", "documentation":"Information about the landing zone.
" } } }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"An unexpected error occurred during processing of a request.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "LandingZoneDetail":{ "type":"structure", "required":[ "version", "manifest" ], "members":{ "version":{ "shape":"LandingZoneVersion", "documentation":"The landing zone's current deployed version.
" }, "remediationTypes":{ "shape":"RemediationTypes", "documentation":"The types of remediation actions configured for the landing zone, such as automatic drift correction or compliance enforcement.
" }, "arn":{ "shape":"Arn", "documentation":"The ARN of the landing zone.
" }, "status":{ "shape":"LandingZoneStatus", "documentation":"The landing zone deployment status. One of ACTIVE, PROCESSING, FAILED.
The latest available version of the landing zone.
" }, "driftStatus":{ "shape":"LandingZoneDriftStatusSummary", "documentation":"The drift status of the landing zone.
" }, "manifest":{ "shape":"Manifest", "documentation":"The landing zone manifest JSON text file that specifies the landing zone configurations.
" } }, "documentation":"Information about the landing zone.
" }, "LandingZoneDriftStatus":{ "type":"string", "enum":[ "DRIFTED", "IN_SYNC" ] }, "LandingZoneDriftStatusSummary":{ "type":"structure", "members":{ "status":{ "shape":"LandingZoneDriftStatus", "documentation":"The drift status of the landing zone.
Valid values:
DRIFTED: The landing zone deployed in this configuration does not match the configuration that Amazon Web Services Control Tower expected.
IN_SYNC: The landing zone deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.
The drift status summary of the landing zone.
If the landing zone differs from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the landing zone.
" }, "LandingZoneOperationDetail":{ "type":"structure", "members":{ "operationType":{ "shape":"LandingZoneOperationType", "documentation":"The landing zone operation type.
Valid values:
DELETE: The DeleteLandingZone operation.
CREATE: The CreateLandingZone operation.
UPDATE: The UpdateLandingZone operation.
RESET: The ResetLandingZone operation.
The operationIdentifier of the landing zone operation.
Valid values:
SUCCEEDED: The landing zone operation succeeded.
IN_PROGRESS: The landing zone operation is in progress.
FAILED: The landing zone operation failed.
The landing zone operation start time.
" }, "endTime":{ "shape":"Timestamp", "documentation":"The landing zone operation end time.
" }, "statusMessage":{ "shape":"String", "documentation":"If the operation result is FAILED, this string contains a message explaining why the operation failed.
" } }, "documentation":"Information about a landing zone operation.
" }, "LandingZoneOperationFilter":{ "type":"structure", "members":{ "types":{ "shape":"LandingZoneOperationTypes", "documentation":"The set of landing zone operation types selected by the filter.
" }, "statuses":{ "shape":"LandingZoneOperationStatuses", "documentation":"The statuses of the set of landing zone operations selected by the filter.
" } }, "documentation":"A filter object that lets you call ListLandingZoneOperations with a specific filter.
The type of the landing zone operation.
" }, "operationIdentifier":{ "shape":"OperationIdentifier", "documentation":"The operationIdentifier of the landing zone operation.
The status of the landing zone operation.
" } }, "documentation":"Returns a summary of information about a landing zone operation.
" }, "LandingZoneOperationType":{ "type":"string", "enum":[ "DELETE", "CREATE", "UPDATE", "RESET" ] }, "LandingZoneOperationTypes":{ "type":"list", "member":{"shape":"LandingZoneOperationType"}, "max":1, "min":1 }, "LandingZoneOperations":{ "type":"list", "member":{"shape":"LandingZoneOperationSummary"} }, "LandingZoneStatus":{ "type":"string", "enum":[ "ACTIVE", "PROCESSING", "FAILED" ] }, "LandingZoneSummary":{ "type":"structure", "members":{ "arn":{ "shape":"Arn", "documentation":"The ARN of the landing zone.
" } }, "documentation":"Returns a summary of information about a landing zone.
" }, "LandingZoneVersion":{ "type":"string", "max":10, "min":3, "pattern":"\\d+.\\d+" }, "ListBaselinesInput":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "documentation":"A pagination token.
" }, "maxResults":{ "shape":"ListBaselinesMaxResults", "documentation":"The maximum number of results to be shown.
" } } }, "ListBaselinesMaxResults":{ "type":"integer", "box":true, "max":100, "min":4 }, "ListBaselinesOutput":{ "type":"structure", "required":["baselines"], "members":{ "baselines":{ "shape":"Baselines", "documentation":"A list of Baseline object details.
A pagination token.
" } } }, "ListControlOperationsInput":{ "type":"structure", "members":{ "filter":{ "shape":"ControlOperationFilter", "documentation":"An input filter for the ListControlOperations API that lets you select the types of control operations to view.
A pagination token.
" }, "maxResults":{ "shape":"ListControlOperationsMaxResults", "documentation":"The maximum number of results to be shown.
" } } }, "ListControlOperationsMaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListControlOperationsNextToken":{ "type":"string", "pattern":".*\\S+.*" }, "ListControlOperationsOutput":{ "type":"structure", "required":["controlOperations"], "members":{ "controlOperations":{ "shape":"ControlOperations", "documentation":"Returns a list of output from control operations.
" }, "nextToken":{ "shape":"ListControlOperationsNextToken", "documentation":"A pagination token.
" } } }, "ListEnabledBaselinesInput":{ "type":"structure", "members":{ "filter":{ "shape":"EnabledBaselineFilter", "documentation":"A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.
A pagination token.
" }, "maxResults":{ "shape":"ListEnabledBaselinesMaxResults", "documentation":"The maximum number of results to be shown.
" }, "includeChildren":{ "shape":"Boolean", "documentation":"A value that can be set to include the child enabled baselines in responses. The default value is false.
" } } }, "ListEnabledBaselinesMaxResults":{ "type":"integer", "box":true, "max":100, "min":5 }, "ListEnabledBaselinesNextToken":{ "type":"string", "pattern":".*\\S+.*" }, "ListEnabledBaselinesOutput":{ "type":"structure", "required":["enabledBaselines"], "members":{ "enabledBaselines":{ "shape":"EnabledBaselines", "documentation":"Retuens a list of summaries of EnabledBaseline resources.
A pagination token.
" } } }, "ListEnabledControlsInput":{ "type":"structure", "members":{ "targetIdentifier":{ "shape":"TargetIdentifier", "documentation":"The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.
The token to continue the list from a previous API call with the same parameters.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"How many results to return per API call.
" }, "filter":{ "shape":"EnabledControlFilter", "documentation":"An input filter for the ListEnabledControls API that lets you select the types of control operations to view.
A boolean value that determines whether to include enabled controls from child organizational units in the response.
" } } }, "ListEnabledControlsOutput":{ "type":"structure", "required":["enabledControls"], "members":{ "enabledControls":{ "shape":"EnabledControls", "documentation":"Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.
" }, "nextToken":{ "shape":"String", "documentation":"Retrieves the next page of results. If the string is empty, the response is the end of the results.
" } } }, "ListLandingZoneOperationsInput":{ "type":"structure", "members":{ "filter":{ "shape":"LandingZoneOperationFilter", "documentation":"An input filter for the ListLandingZoneOperations API that lets you select the types of landing zone operations to view.
The token to continue the list from a previous API call with the same parameters.
" }, "maxResults":{ "shape":"ListLandingZoneOperationsMaxResults", "documentation":"How many results to return per API call.
" } } }, "ListLandingZoneOperationsMaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListLandingZoneOperationsOutput":{ "type":"structure", "required":["landingZoneOperations"], "members":{ "landingZoneOperations":{ "shape":"LandingZoneOperations", "documentation":"Lists landing zone operations.
" }, "nextToken":{ "shape":"String", "documentation":"Retrieves the next page of results. If the string is empty, the response is the end of the results.
" } } }, "ListLandingZonesInput":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "documentation":"The token to continue the list from a previous API call with the same parameters.
" }, "maxResults":{ "shape":"ListLandingZonesMaxResults", "documentation":"The maximum number of returned landing zone ARNs, which is one.
" } } }, "ListLandingZonesMaxResults":{ "type":"integer", "box":true, "max":1, "min":1 }, "ListLandingZonesOutput":{ "type":"structure", "required":["landingZones"], "members":{ "landingZones":{ "shape":"ListLandingZonesOutputLandingZonesList", "documentation":"The ARN of the landing zone.
" }, "nextToken":{ "shape":"String", "documentation":"Retrieves the next page of results. If the string is empty, the response is the end of the results.
" } } }, "ListLandingZonesOutputLandingZonesList":{ "type":"list", "member":{"shape":"LandingZoneSummary"}, "max":1, "min":0 }, "ListTagsForResourceInput":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The ARN of the resource.
", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceOutput":{ "type":"structure", "required":["tags"], "members":{ "tags":{ "shape":"TagMap", "documentation":"A list of tags, as key:value strings.
The Amazon Web Services Region name.
" } }, "documentation":"An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed.
The expected Regions are based on the Regions that are governed by the landing zone. In certain cases, a control is not actually enabled in the Region as expected, such as during drift, or mixed governance.
" }, "RegionName":{ "type":"string", "max":50, "min":1 }, "RemediationType":{ "type":"string", "enum":["INHERITANCE_DRIFT"] }, "RemediationTypes":{ "type":"list", "member":{"shape":"RemediationType"}, "max":1, "min":1 }, "ResetEnabledBaselineInput":{ "type":"structure", "required":["enabledBaselineIdentifier"], "members":{ "enabledBaselineIdentifier":{ "shape":"Arn", "documentation":"Specifies the ID of the EnabledBaseline resource to be re-enabled, in ARN format.
The ID (in UUID format) of the asynchronous ResetEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The ARN of the enabled control to be reset.
" } } }, "ResetEnabledControlOutput":{ "type":"structure", "required":["operationIdentifier"], "members":{ "operationIdentifier":{ "shape":"OperationIdentifier", "documentation":" The operation identifier for this ResetEnabledControl operation.
The unique identifier of the landing zone.
" } } }, "ResetLandingZoneOutput":{ "type":"structure", "required":["operationIdentifier"], "members":{ "operationIdentifier":{ "shape":"OperationIdentifier", "documentation":"A unique identifier assigned to a ResetLandingZone operation. You can use this identifier as an input parameter of GetLandingZoneOperation to check the operation's status.
The request references a resource that does not exist.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ServiceQuotaExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"The request would cause a service quota to be exceeded. See Service quotas.
", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "String":{"type":"string"}, "SyntheticTimestamp_date_time":{ "type":"timestamp", "timestampFormat":"iso8601" }, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, "min":0 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":200, "min":0 }, "TagResourceInput":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The ARN of the resource to be tagged.
", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", "documentation":"Tags to be applied to the resource.
" } } }, "TagResourceOutput":{ "type":"structure", "members":{} }, "TagValue":{ "type":"string", "max":256, "min":0 }, "TargetIdentifier":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws[0-9a-zA-Z_\\-:\\/]+" }, "TargetIdentifiers":{ "type":"list", "member":{"shape":"TargetIdentifier"}, "max":1, "min":1 }, "TargetRegions":{ "type":"list", "member":{"shape":"Region"} }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "serviceCode":{ "shape":"String", "documentation":"The ID of the service that is associated with the error.
" }, "quotaCode":{ "shape":"String", "documentation":"The ID of the service quota that was exceeded.
" }, "retryAfterSeconds":{ "shape":"Integer", "documentation":"The number of seconds the caller should wait before retrying.
", "location":"header", "locationName":"Retry-After" } }, "documentation":"The request was denied due to request throttling.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true, "retryable":{"throttling":true} }, "Timestamp":{ "type":"timestamp", "timestampFormat":"iso8601" }, "UntagResourceInput":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The ARN of the resource.
", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeys", "documentation":"Tag keys to be removed from the resource.
", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceOutput":{ "type":"structure", "members":{} }, "UpdateEnabledBaselineInput":{ "type":"structure", "required":[ "baselineVersion", "enabledBaselineIdentifier" ], "members":{ "baselineVersion":{ "shape":"BaselineVersion", "documentation":"Specifies the new Baseline version, to which the EnabledBaseline should be updated.
Parameters to apply when making an update.
" }, "enabledBaselineIdentifier":{ "shape":"Arn", "documentation":"Specifies the EnabledBaseline resource to be updated.
The ID (in UUID format) of the asynchronous UpdateEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
A key/value pair, where Key is of type String and Value is of type Document.
The ARN of the enabled control that will be updated.
" } } }, "UpdateEnabledControlOutput":{ "type":"structure", "required":["operationIdentifier"], "members":{ "operationIdentifier":{ "shape":"OperationIdentifier", "documentation":" The operation identifier for this UpdateEnabledControl operation.
The landing zone version, for example, 3.2.
" }, "remediationTypes":{ "shape":"RemediationTypes", "documentation":"Specifies the types of remediation actions to apply when updating the landing zone configuration.
" }, "landingZoneIdentifier":{ "shape":"String", "documentation":"The unique identifier of the landing zone.
" }, "manifest":{ "shape":"Manifest", "documentation":"The manifest file (JSON) is a text file that describes your Amazon Web Services resources. For an example, review Launch your landing zone. The example manifest file contains each of the available parameters. The schema for the landing zone's JSON manifest file is not published, by design.
" } } }, "UpdateLandingZoneOutput":{ "type":"structure", "required":["operationIdentifier"], "members":{ "operationIdentifier":{ "shape":"OperationIdentifier", "documentation":"A unique identifier assigned to a UpdateLandingZone operation. You can use this identifier as an input of GetLandingZoneOperation to check the operation's status.
The input does not satisfy the constraints specified by an Amazon Web Services service.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true } }, "documentation":"Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:
For more information about these types of resources, see the Amazon Web Services Control Tower User Guide .
About control APIs
These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.
To call these APIs, you'll need to know:
the controlIdentifier for the control--or guardrail--you are targeting.
the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.
the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier for your Amazon Web Services Control Tower control:
The controlIdentifier is an ARN that is specified for each control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.
About identifiers for Amazon Web Services Control Tower
The Amazon Web Services Control Tower controlIdentifier is unique in each Amazon Web Services Region for each control. You can find the controlIdentifier for each Region and control in the Tables of control metadata or the Control availability by Region tables in the Amazon Web Services Control Tower Controls Reference Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Amazon Web Services Control Tower Controls Reference Guide . Remember that Mandatory controls cannot be added or removed.
Some controls have two identifiers
ARN format for Amazon Web Services Control Tower: arn:aws:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}
Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
ARN format for Amazon Web Services Control Catalog: arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}
You can find the {CONTROL_CATALOG_OPAQUE_ID} in the Amazon Web Services Control Tower Controls Reference Guide , or in the Amazon Web Services Control Tower console, on the Control details page.
The Amazon Web Services Control Tower APIs for enabled controls, such as GetEnabledControl and ListEnabledControls always return an ARN of the same type given when the control was enabled.
To get the targetIdentifier:
The targetIdentifier is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
OU ARN format:
arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
About landing zone APIs
You can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see Getting started with Amazon Web Services Control Tower using APIs.
For an overview of landing zone API operations, see Amazon Web Services Control Tower supports landing zone APIs. The individual API operations for landing zones are detailed in this document, the API reference manual, in the \"Actions\" section.
About baseline APIs
You can apply the AWSControlTowerBaseline baseline to an organizational unit (OU) as a way to register the OU with Amazon Web Services Control Tower, programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines.
You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.
The individual API operations for baselines are detailed in this document, the API reference manual, in the \"Actions\" section. For usage examples, see Baseline API input and output examples with CLI.
About Amazon Web Services Control Catalog identifiers
The EnableControl and DisableControl API operations can be called by specifying either the Amazon Web Services Control Tower identifer or the Amazon Web Services Control Catalog identifier. The API response returns the same type of identifier that you specified when calling the API.
If you use an Amazon Web Services Control Tower identifier to call the EnableControl API, and then call EnableControl again with an Amazon Web Services Control Catalog identifier, Amazon Web Services Control Tower returns an error message stating that the control is already enabled. Similar behavior applies to the DisableControl API operation.
Mandatory controls and the landing-zone-level Region deny control have Amazon Web Services Control Tower identifiers only.
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
" }