Awso_controltower_asyncSourceval create_landing_zone :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.CreateLandingZoneInput.t ->
(Awso_controltower.Values.CreateLandingZoneOutput.t,
Awso_controltower.Values.CreateLandingZoneOutput.error)
Result.t
Async.Deferred.tval delete_landing_zone :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.DeleteLandingZoneInput.t ->
(Awso_controltower.Values.DeleteLandingZoneOutput.t,
Awso_controltower.Values.DeleteLandingZoneOutput.error)
Result.t
Async.Deferred.tval disable_baseline :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.DisableBaselineInput.t ->
(Awso_controltower.Values.DisableBaselineOutput.t,
Awso_controltower.Values.DisableBaselineOutput.error)
Result.t
Async.Deferred.tval disable_control :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.DisableControlInput.t ->
(Awso_controltower.Values.DisableControlOutput.t,
Awso_controltower.Values.DisableControlOutput.error)
Result.t
Async.Deferred.tval enable_baseline :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.EnableBaselineInput.t ->
(Awso_controltower.Values.EnableBaselineOutput.t,
Awso_controltower.Values.EnableBaselineOutput.error)
Result.t
Async.Deferred.tval enable_control :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.EnableControlInput.t ->
(Awso_controltower.Values.EnableControlOutput.t,
Awso_controltower.Values.EnableControlOutput.error)
Result.t
Async.Deferred.tval get_baseline :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.GetBaselineInput.t ->
(Awso_controltower.Values.GetBaselineOutput.t,
Awso_controltower.Values.GetBaselineOutput.error)
Result.t
Async.Deferred.tval get_baseline_operation :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.GetBaselineOperationInput.t ->
(Awso_controltower.Values.GetBaselineOperationOutput.t,
Awso_controltower.Values.GetBaselineOperationOutput.error)
Result.t
Async.Deferred.tval get_control_operation :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.GetControlOperationInput.t ->
(Awso_controltower.Values.GetControlOperationOutput.t,
Awso_controltower.Values.GetControlOperationOutput.error)
Result.t
Async.Deferred.tval get_enabled_baseline :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.GetEnabledBaselineInput.t ->
(Awso_controltower.Values.GetEnabledBaselineOutput.t,
Awso_controltower.Values.GetEnabledBaselineOutput.error)
Result.t
Async.Deferred.tval get_enabled_control :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.GetEnabledControlInput.t ->
(Awso_controltower.Values.GetEnabledControlOutput.t,
Awso_controltower.Values.GetEnabledControlOutput.error)
Result.t
Async.Deferred.tval get_landing_zone :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.GetLandingZoneInput.t ->
(Awso_controltower.Values.GetLandingZoneOutput.t,
Awso_controltower.Values.GetLandingZoneOutput.error)
Result.t
Async.Deferred.tval get_landing_zone_operation :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.GetLandingZoneOperationInput.t ->
(Awso_controltower.Values.GetLandingZoneOperationOutput.t,
Awso_controltower.Values.GetLandingZoneOperationOutput.error)
Result.t
Async.Deferred.tval list_baselines :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.ListBaselinesInput.t ->
(Awso_controltower.Values.ListBaselinesOutput.t,
Awso_controltower.Values.ListBaselinesOutput.error)
Result.t
Async.Deferred.tval list_control_operations :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.ListControlOperationsInput.t ->
(Awso_controltower.Values.ListControlOperationsOutput.t,
Awso_controltower.Values.ListControlOperationsOutput.error)
Result.t
Async.Deferred.tval list_enabled_baselines :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.ListEnabledBaselinesInput.t ->
(Awso_controltower.Values.ListEnabledBaselinesOutput.t,
Awso_controltower.Values.ListEnabledBaselinesOutput.error)
Result.t
Async.Deferred.tval list_enabled_controls :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.ListEnabledControlsInput.t ->
(Awso_controltower.Values.ListEnabledControlsOutput.t,
Awso_controltower.Values.ListEnabledControlsOutput.error)
Result.t
Async.Deferred.tval list_landing_zone_operations :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.ListLandingZoneOperationsInput.t ->
(Awso_controltower.Values.ListLandingZoneOperationsOutput.t,
Awso_controltower.Values.ListLandingZoneOperationsOutput.error)
Result.t
Async.Deferred.tval list_landing_zones :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.ListLandingZonesInput.t ->
(Awso_controltower.Values.ListLandingZonesOutput.t,
Awso_controltower.Values.ListLandingZonesOutput.error)
Result.t
Async.Deferred.tval list_tags_for_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.ListTagsForResourceInput.t ->
(Awso_controltower.Values.ListTagsForResourceOutput.t,
Awso_controltower.Values.ListTagsForResourceOutput.error)
Result.t
Async.Deferred.tval reset_enabled_baseline :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.ResetEnabledBaselineInput.t ->
(Awso_controltower.Values.ResetEnabledBaselineOutput.t,
Awso_controltower.Values.ResetEnabledBaselineOutput.error)
Result.t
Async.Deferred.tval reset_enabled_control :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.ResetEnabledControlInput.t ->
(Awso_controltower.Values.ResetEnabledControlOutput.t,
Awso_controltower.Values.ResetEnabledControlOutput.error)
Result.t
Async.Deferred.tval reset_landing_zone :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.ResetLandingZoneInput.t ->
(Awso_controltower.Values.ResetLandingZoneOutput.t,
Awso_controltower.Values.ResetLandingZoneOutput.error)
Result.t
Async.Deferred.tval tag_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.TagResourceInput.t ->
(Awso_controltower.Values.TagResourceOutput.t,
Awso_controltower.Values.TagResourceOutput.error)
Result.t
Async.Deferred.tval untag_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.UntagResourceInput.t ->
(Awso_controltower.Values.UntagResourceOutput.t,
Awso_controltower.Values.UntagResourceOutput.error)
Result.t
Async.Deferred.tval update_enabled_baseline :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.UpdateEnabledBaselineInput.t ->
(Awso_controltower.Values.UpdateEnabledBaselineOutput.t,
Awso_controltower.Values.UpdateEnabledBaselineOutput.error)
Result.t
Async.Deferred.tval update_enabled_control :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.UpdateEnabledControlInput.t ->
(Awso_controltower.Values.UpdateEnabledControlOutput.t,
Awso_controltower.Values.UpdateEnabledControlOutput.error)
Result.t
Async.Deferred.tval update_landing_zone :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_controltower.Values.UpdateLandingZoneInput.t ->
(Awso_controltower.Values.UpdateLandingZoneOutput.t,
Awso_controltower.Values.UpdateLandingZoneOutput.error)
Result.t
Async.Deferred.tinclude module type of struct include Awso_controltower.Values endval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]module EnabledControlInheritanceDrift =
Awso_controltower.Values.EnabledControlInheritanceDriftRepresents drift information related to control inheritance between organizational units.
Represents drift information related to the underlying Amazon Web Services resources managed by the control.
module EnabledBaselineInheritanceDrift =
Awso_controltower.Values.EnabledBaselineInheritanceDriftThe 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.
Defines the various categories of drift that can occur for an enabled control resource.
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.
module EnabledBaselineParameterDocument =
Awso_controltower.Values.EnabledBaselineParameterDocumentThe 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.
The deployment summary of an EnabledControl or EnabledBaseline resource.
module EnabledBaselineDriftStatusSummary =
Awso_controltower.Values.EnabledBaselineDriftStatusSummaryThe 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.
module EnabledControlParameterSummary =
Awso_controltower.Values.EnabledControlParameterSummaryReturns a summary of information about the parameters of an enabled control.
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.
module EnabledBaselineParameterSummary =
Awso_controltower.Values.EnabledBaselineParameterSummarySummary of an applied parameter to an EnabledBaseline resource.
A key/value pair, where Key is of type String and Value is of type Document.
A key-value parameter to an EnabledBaseline resource.
Returns a summary of information about a landing zone.
Returns a summary of information about a landing zone operation.
Returns a summary of information about an enabled control.
Returns a summary of information about an EnabledBaseline object.
module EnabledBaselineBaselineIdentifiers =
Awso_controltower.Values.EnabledBaselineBaselineIdentifiersmodule EnabledBaselineEnablementStatuses =
Awso_controltower.Values.EnabledBaselineEnablementStatusesmodule EnabledBaselineParentIdentifiers =
Awso_controltower.Values.EnabledBaselineParentIdentifiersmodule EnabledBaselineTargetIdentifiers =
Awso_controltower.Values.EnabledBaselineTargetIdentifiersA summary of information about the specified control operation.
Returns a summary of information about a Baseline object.
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.
module EnabledControlParameterSummaries =
Awso_controltower.Values.EnabledControlParameterSummariesmodule EnabledBaselineParameterSummaries =
Awso_controltower.Values.EnabledBaselineParameterSummariesYou do not have sufficient access to perform this action.
Updating or deleting the resource can cause an inconsistent state.
An unexpected error occurred during processing of a request.
The request references a resource that does not exist.
The request was denied due to request throttling.
The input does not satisfy the constraints specified by an Amazon Web Services service.
The request would cause a service quota to be exceeded. See Service quotas.
module ListLandingZonesOutputLandingZonesList =
Awso_controltower.Values.ListLandingZonesOutputLandingZonesListA filter object that lets you call ListLandingZoneOperations with a specific filter.
module ListLandingZoneOperationsMaxResults =
Awso_controltower.Values.ListLandingZoneOperationsMaxResultsA 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.
A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.
module ListEnabledBaselinesMaxResults =
Awso_controltower.Values.ListEnabledBaselinesMaxResultsmodule ListControlOperationsNextToken =
Awso_controltower.Values.ListControlOperationsNextTokenA filter object that lets you call ListControlOperations with a specific filter.
module ListControlOperationsMaxResults =
Awso_controltower.Values.ListControlOperationsMaxResultsInformation about the landing zone.
Information about a landing zone operation.
Information about the enabled control.
Details of the EnabledBaseline resource.
An operation performed by the control.
An object of shape BaselineOperation, returning details about the specified Baseline operation ID.
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.
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.
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 .
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 .
Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .
Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .
Removes tags from a resource. For usage examples, see the Controls Reference Guide .
Removes tags from a resource. For usage examples, see the Controls Reference Guide .
Applies tags to a resource. For usage examples, see the Controls Reference Guide .
Applies tags to a resource. For usage examples, see the Controls Reference Guide .
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.
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.
Resets an enabled control. Does not work for controls implemented with SCPs.
Resets an enabled control. Does not work for controls implemented with SCPs.
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 .
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 .
Returns a list of tags associated with the resource. For usage examples, see the Controls Reference Guide .
Returns a list of tags associated with the resource. For usage examples, see the Controls Reference Guide .
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.
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.
module ListLandingZoneOperationsOutput =
Awso_controltower.Values.ListLandingZoneOperationsOutputLists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.
module ListLandingZoneOperationsInput =
Awso_controltower.Values.ListLandingZoneOperationsInputLists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.
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 .
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 .
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 .
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 .
Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.
Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.
Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns details about the landing zone. Displays a message in case of error.
Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.
Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.
Returns details about the landing zone. Displays a message in case of error.
Retrieves details about an enabled control. For usage examples, see the Controls Reference Guide .
Retrieves details about an enabled control. For usage examples, see the Controls Reference Guide .
Retrieve details of an EnabledBaseline resource by specifying its identifier.
Retrieve details of an EnabledBaseline resource by specifying its identifier.
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 .
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 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 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 .
Retrieve details about an existing Baseline resource by specifying its identifier. 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 .
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 .
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 .
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 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 .
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 .
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 .
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 .
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.
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.
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.
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.