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.
+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:
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.
+ *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:
*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.
+ *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 request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input does not satisfy the constraints specified by an Amazon Web Services service.
+ *The input does not satisfy the constraints specified by an Amazon Web Services service.
* * @throws {@link ControlTowerServiceException} *Base exception class for all service exceptions from ControlTower service.
diff --git a/clients/client-controltower/src/commands/DeleteLandingZoneCommand.ts b/clients/client-controltower/src/commands/DeleteLandingZoneCommand.ts index d6edbef7ced3..dbc009f3339c 100644 --- a/clients/client-controltower/src/commands/DeleteLandingZoneCommand.ts +++ b/clients/client-controltower/src/commands/DeleteLandingZoneCommand.ts @@ -69,7 +69,7 @@ export interface DeleteLandingZoneCommandOutput extends DeleteLandingZoneOutput, *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input does not satisfy the constraints specified by an Amazon Web Services service.
+ *The input does not satisfy the constraints specified by an Amazon Web Services service.
* * @throws {@link ControlTowerServiceException} *Base exception class for all service exceptions from ControlTower service.
diff --git a/clients/client-controltower/src/commands/DisableBaselineCommand.ts b/clients/client-controltower/src/commands/DisableBaselineCommand.ts new file mode 100644 index 000000000000..9dc08e931fac --- /dev/null +++ b/clients/client-controltower/src/commands/DisableBaselineCommand.ts @@ -0,0 +1,102 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DisableBaselineInput, DisableBaselineOutput } from "../models/models_0"; +import { de_DisableBaselineCommand, se_DisableBaselineCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link DisableBaselineCommand}. + */ +export interface DisableBaselineCommandInput extends DisableBaselineInput {} +/** + * @public + * + * The output of {@link DisableBaselineCommand}. + */ +export interface DisableBaselineCommandOutput extends DisableBaselineOutput, __MetadataBearer {} + +/** + * @public + *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.
You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *Updating or deleting the resource can cause an inconsistent state.
+ * + * @throws {@link InternalServerException} (server fault) + *An unexpected error occurred during processing of a request.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The request references a resource that does not exist.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input does not satisfy the constraints specified by an Amazon Web Services service.
+ * + * @throws {@link ControlTowerServiceException} + *Base exception class for all service exceptions from ControlTower service.
+ * + */ +export class DisableBaselineCommand extends $Command + .classBuilder< + DisableBaselineCommandInput, + DisableBaselineCommandOutput, + ControlTowerClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: ControlTowerClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSControlTowerApis", "DisableBaseline", {}) + .n("ControlTowerClient", "DisableBaselineCommand") + .f(void 0, void 0) + .ser(se_DisableBaselineCommand) + .de(de_DisableBaselineCommand) + .build() {} diff --git a/clients/client-controltower/src/commands/DisableControlCommand.ts b/clients/client-controltower/src/commands/DisableControlCommand.ts index e5577ed524b5..8d2dab233917 100644 --- a/clients/client-controltower/src/commands/DisableControlCommand.ts +++ b/clients/client-controltower/src/commands/DisableControlCommand.ts @@ -28,7 +28,7 @@ export interface DisableControlCommandOutput extends DisableControlOutput, __Met /** * @public - *This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services + *
This API call turns off a control. It starts an asynchronous operation that deletes AWS
* 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 Amazon Web Services Control Tower User Guide
@@ -76,7 +76,7 @@ export interface DisableControlCommandOutput extends DisableControlOutput, __Met
* The request was denied due to request throttling. The input does not satisfy the constraints specified by an Amazon Web Services service. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. Enable (apply) a You 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 would cause a service quota to be exceeded. The limit is 10 concurrent operations. The request was denied due to request throttling. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. The request was denied due to request throttling. The input does not satisfy the constraints specified by an Amazon Web Services service. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. Retrieve details about an existing You do not have sufficient access to perform this action. 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. Base exception class for all service exceptions from ControlTower service. Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: You do not have sufficient access to perform this action. 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. Base exception class for all service exceptions from ControlTower service. The request was denied due to request throttling. The input does not satisfy the constraints specified by an Amazon Web Services service. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. Retrieve details of an You do not have sufficient access to perform this action. 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. Base exception class for all service exceptions from ControlTower service. The request was denied due to request throttling. The input does not satisfy the constraints specified by an Amazon Web Services service. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. The request was denied due to request throttling. The input does not satisfy the constraints specified by an Amazon Web Services service. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. The request was denied due to request throttling. The input does not satisfy the constraints specified by an Amazon Web Services service. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. Returns a summary list of all available baselines. You do not have sufficient access to perform this action. An unexpected error occurred during processing of a request. The request was denied due to request throttling. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. Returns a list of summaries describing You do not have sufficient access to perform this action. An unexpected error occurred during processing of a request. The request was denied due to request throttling. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. The request was denied due to request throttling. The input does not satisfy the constraints specified by an Amazon Web Services service. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. The request was denied due to request throttling. The input does not satisfy the constraints specified by an Amazon Web Services service. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. The request references a resource that does not exist. The input does not satisfy the constraints specified by an Amazon Web Services service. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. Re-enables an You 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 would cause a service quota to be exceeded. The limit is 10 concurrent operations. The request was denied due to request throttling. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. The request was denied due to request throttling. The input does not satisfy the constraints specified by an Amazon Web Services service. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. The request references a resource that does not exist. The input does not satisfy the constraints specified by an Amazon Web Services service. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. The request references a resource that does not exist. The input does not satisfy the constraints specified by an Amazon Web Services service. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. Updates an You 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 would cause a service quota to be exceeded. The limit is 10 concurrent operations. The request was denied due to request throttling. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. The request was denied due to request throttling. The input does not satisfy the constraints specified by an Amazon Web Services service. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. The request was denied due to request throttling. The input does not satisfy the constraints specified by an Amazon Web Services service. The input does not satisfy the constraints specified by an Amazon Web Services service. Base exception class for all service exceptions from ControlTower service. 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. 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 ARN of the The baseline ARN. A user-friendly name for the baseline. A description of the baseline. 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 ID of the service that is associated with the error. The ID of the service quota that was exceeded. The number of seconds the caller should wait before retrying. The input does not satisfy the constraints specified by an Amazon Web Services service. A pagination token. The maximum number of results to be shown. Returns a summary of information about a The full ARN of a Baseline. The human-readable name of a Baseline. A summary description of a Baseline. A list of A pagination token. Updating or deleting the resource can cause an inconsistent state. 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 The ARN of the organizational unit. For information on how to find the The ID of the asynchronous operation, which is used to track status. The operation is
+ * available for 90 days. The request would cause a service quota to be exceeded. The limit is 10 concurrent operations. A key/value pair, where The key of a key/value pair. The value of a key/value pair. 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 The ARN of the organizational unit. For information on how to find the Tags to be applied to the A list of input parameter values, which are specified to configure the control when you enable it. The ID of the asynchronous operation, which is used to track status. The operation is
+ * available for 90 days. The ARN of the Identifier of the The ID (in UUID format) of the asynchronous A key-value parameter to an A string denoting the parameter key. A low-level The specific version to be enabled of the specified baseline. A list of The ARN of the baseline to be enabled. The ARN of the target on which the baseline will be enabled. Only OUs are supported as targets. Tags associated with input to The ID (in UUID format) of the asynchronous The ARN of the The operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset). An object of shape The identifier of the specified operation. An enumerated type ( An enumerated type ( The start time of the operation, in ISO 8601 format. The end time of the operation (if applicable), in ISO 8601 format. A status message that gives more information about the operation's status, if applicable. A Identifier of the Summary of an applied parameter to an A string denoting the parameter key. A low-level document object of any type (for example, a Java Object). The deployment summary of the enabled control. The ARN of the control. Only Strongly recommended and
- * Elective controls are permitted, with the exception of the
- * landing zone Region deny control. For information on how to find the The deployment status of the enabled control. Valid values:
+ *
+ *
+ * The ARN of the organizational unit. For information on how to find the The last operation identifier for the enabled control. Details of the The ID of the asynchronous operation, which is used to track status. The operation is
- * available for 90 days. The ARN of the The specific The enabled version of the The target on which to enable the The deployment summary of the enabled control. Shows the parameters that are applied when enabling this An unexpected error occurred during processing of a request. Details of the The request references a resource that does not exist. A filter applied on the Identifiers for the targets of the Identifiers for the The request would cause a service quota to be exceeded. The limit is 10 concurrent operations. A filter applied on the A pagination token. The maximum number of results to be shown. The request was denied due to request throttling. Returns a summary of information about an The ID of the service that is associated with the error.
- * The ARN of the The ID of the service quota that was exceeded. The specific baseline that is enabled as part of the The number of seconds to wait before retrying. The enabled version of the baseline. The target upon which the baseline is enabled. The input does not satisfy the constraints specified by an Amazon Web Services service. The deployment summary of the enabled control. A set of parameters that configure the behavior of the enabled control. A key/value pair, where The key of a key/value pair. It is of type Retuens a list of summaries of The value of a key/value pair. It can be of type A pagination token. The ARN of the control. Only Strongly recommended and
- * Elective controls are permitted, with the exception of the
- * landing zone Region deny control. For information on how to find the Specifies the ID of the The ARN of the organizational unit. For information on how to find the The ID (in UUID format) of the asynchronous Specifies the new Tags to be applied to the Parameters to apply when making an update. An array of Specifies the The ID of the asynchronous operation, which is used to track status. The operation is
- * available for 90 days. The ID (in UUID format) of the asynchronous The ARN of the The deployment summary of the enabled control. The deployment status of the enabled control. Valid values:
- *
- *
- * The last operation identifier for the enabled control. An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed. 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. The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review
- * Launch your landing zone. The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review
+ * The manifest file. The landing zone manifest JSON text file that specifies the landing zone configurations. The landing zone The landing zone deployment status. The landing zone deployment status. One of The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review
- * Launch your landing zone. The These interfaces allow you to apply the Amazon Web Services library of pre-defined\n 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 the ARN associated with the target organizational unit (OU), which we call the the ARN associated with a resource that you wish to tag or untag. \n To get the The The A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and\n Elective controls is given in Resource identifiers for\n APIs and controls in the Controls reference guide section\n of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls\n cannot be added or removed. \n ARN format:\n \n Example:\n \n \n To get the The 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. \n OU ARN format:\n \n \n Details and examples\n \n Creating Amazon Web Services Control Tower resources with Amazon Web Services CloudFormation\n To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n \n Recording API Requests\n Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by\n CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made\n the request and when, and so on. For more about Amazon Web Services Control Tower and its support for\n CloudTrail, see Logging Amazon Web Services Control Tower\n Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about\n CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User\n Guide. These interfaces allow you to apply the Amazon Web Services library of pre-defined\n 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 the ARN associated with the target organizational unit (OU), which we call the the ARN associated with a resource that you wish to tag or untag. \n To get the The The A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and\n Elective controls is given in Resource identifiers for\n APIs and controls in the Controls reference guide section\n of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls\n cannot be added or removed. \n ARN format:\n \n Example:\n \n \n To get the The 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. \n OU ARN format:\n \n \n Details and examples\n \n Creating Amazon Web Services Control Tower resources with Amazon Web Services CloudFormation\n To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n \n Recording API Requests\n Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by\n CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made\n the request and when, and so on. For more about Amazon Web Services Control Tower and its support for\n CloudTrail, see Logging Amazon Web Services Control Tower\n Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about\n CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User\n Guide. The identifier of the specified operation. An enumerated type ( An enumerated type ( The start time of the operation, in ISO 8601 format. The end time of the operation (if applicable), in ISO 8601 format. A status message that gives more information about the operation's status, if applicable. An object of shape The full ARN of a Baseline. The human-readable name of a Baseline. A summary description of a Baseline. Returns a summary of information about a The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review \n Launch your landing zone. The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review \n The manifest file. Disable an Identifier of the The ID (in UUID format) of the asynchronous This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services\n resources on the specified organizational unit and the accounts it contains. The resources\n will vary according to the control that you specify. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n . This API call turns off a control. It starts an asynchronous operation that deletes AWS\n resources on the specified organizational unit and the accounts it contains. The resources\n will vary according to the control that you specify. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n . The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n landing zone Region deny control. For information on how to find the The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n Region deny control. For information on how to find the The drift summary of the enabled control. Amazon Web Services Control Tower expects the enabled control\n configuration to include all supported and governed Regions. If the enabled control differs\n from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control. This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services\n resources on the specified organizational unit and the accounts it contains. The resources\n created will vary according to the control that you specify. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n . Enable (apply) a The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n landing zone Region deny control. For information on how to find the The specific version to be enabled of the specified baseline. The ARN of the organizational unit. For information on how to find the A list of The ARN of the baseline to be enabled. Tags to be applied to the The ARN of the target on which the baseline will be enabled. Only OUs are supported as targets. An array of Tags associated with input to The ID of the asynchronous operation, which is used to track status. The operation is\n available for 90 days. The ID (in UUID format) of the asynchronous The ARN of the The ARN of the The ARN of the enabled control. The control identifier of the enabled control. For information on how to find the The ARN of the organizational unit. For information on how to find the This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services\n resources on the specified organizational unit and the accounts it contains. The resources\n created will vary according to the control that you specify. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n . The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n Region deny control. For information on how to find the The ARN of the organizational unit. For information on how to find the Tags to be applied to the A list of input parameter values, which are specified to configure the control when you enable it. The ID of the asynchronous operation, which is used to track status. The operation is\n available for 90 days. The ARN of the The ARN of the The specific The enabled version of the The target on which to enable the Shows the parameters that are applied when enabling this Details of the Identifiers for the targets of the Identifiers for the A filter applied on the A string denoting the parameter key. A low-level A key-value parameter to an A string denoting the parameter key. A low-level document object of any type (for example, a Java Object). Summary of an applied parameter to an The ARN of the The specific baseline that is enabled as part of the The enabled version of the baseline. The target upon which the baseline is enabled. Returns a summary of information about an The ARN of the enabled control. The control identifier of the enabled control. For information on how to find the The ARN of the organizational unit. For information on how to find the The key of a key/value pair. It is of type The key of a key/value pair. The value of a key/value pair. It can be of type The value of a key/value pair. A set of parameters that configure the behavior of the enabled control. A key/value pair, where A key/value pair, where The drift status of the enabled control. The drift status of the enabled control. Returns a summary of information about an enabled control. The deployment status of the enabled control. Valid values: \n \n \n The last operation identifier for the enabled control. The deployment summary of the enabled control. Retrieve details about an existing The ARN of the Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: The operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset). Returns a summary of information about an enabled control. A The deployment status of the enabled control. Valid values: \n \n \n The baseline ARN. The last operation identifier for the enabled control. A user-friendly name for the baseline. A description of the baseline. The deployment summary of the enabled control. Retrieve details of an Identifier of the Details of the The landing zone manifest JSON text file that specifies the landing zone configurations. The landing zone The landing zone deployment status. The landing zone deployment status. One of The ARN of the landing zone. Returns a summary of information about a landing zone. Returns a summary list of all available baselines. A pagination token. The maximum number of results to be shown. A list of A pagination token. Returns a list of summaries describing A filter applied on the A pagination token. The maximum number of results to be shown. The ARN of the landing zone. Retuens a list of summaries of A pagination token. Returns a summary of information about a landing zone. 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\n certain cases, a control is not actually enabled in the Region as expected, such as during\n drift, or mixed governance. 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\n certain cases, a control is not actually enabled in the Region as expected, such as during\n drift, or mixed governance. Re-enables an Specifies the ID of the The ID (in UUID format) of the asynchronous The ID of the service that is associated with the error.\n The ID of the service that is associated with the error. The number of seconds to wait before retrying. The number of seconds the caller should wait before retrying. Updates an Specifies the new Parameters to apply when making an update. Specifies the The ID (in UUID format) of the asynchronous The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review \n Launch your landing zone. The The input does not satisfy the constraints specified by an Amazon Web Services service. The input does not satisfy the constraints specified by an Amazon Web Services service.Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target.Baseline resource by specifying its identifier.EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure.EnabledBaseline resource by specifying its identifier.EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources.EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU.EnabledBaseline resource's applied parameters or version.
*
Baseline resource to be retrieved.Baseline object.Baseline object details.controlIdentifier, see the overview page.targetIdentifier, see the overview page.Key is of type String and Value is of type Document.controlIdentifier, see the overview page.targetIdentifier, see the overview page.EnabledControl resource.EnabledControl resource.EnabledBaseline resource to be deactivated, in ARN format.DisableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.EnabledBaseline resource.Document object of any type (for example, a Java Object).key-value objects that specify enablement parameters, where key is a string and value is a document of any type.EnableBaseline.EnableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.EnabledBaseline resource.BaselineOperation, returning details about the specified Baseline operation ID.enum) with possible values of ENABLE_BASELINE, DISABLE_BASELINE, UPDATE_ENABLED_BASELINE, or RESET_ENABLED_BASELINE.enum) with possible values of SUCCEEDED, FAILED, or IN_PROGRESS.baselineOperation object that shows information about the specified operation ID.EnabledBaseline resource to be retrieved, in ARN format.EnabledBaseline resource. controlIdentifier, see the overview page.
+ *
*/
- controlIdentifier: string | undefined;
+ status?: EnablementStatus;
/**
* @public
- * SUCCEEDED: The enabledControl configuration was deployed successfully.UNDER_CHANGE: The enabledControl configuration is changing. FAILED: The enabledControl configuration failed to deploy.targetIdentifier, see the overview page.EnabledBaseline resource.EnabledBaseline resource.Baseline enabled as part of the EnabledBaseline resource.Baseline.Baseline.Baseline.EnabledBaseline resource.ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.Baseline filter operation.Baseline objects returned as part of the filter operation.ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.EnabledBaseline object.EnabledBaseline resourceEnabledBaseline resource.Key is of type String and Value is of type Document.string.EnabledBaseline resources.array
- * string, number, object, or boolean. controlIdentifier, see the overview page.EnabledBaseline resource to be re-enabled, in ARN format.targetIdentifier, see the overview page.ResetEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.Baseline version, to which the EnabledBaseline should be updated.EnabledControl resource.EnabledControlParameter objectsEnabledBaseline resource to be updated.UpdateEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.EnabledControl resource.
- *
- */
- status?: EnablementStatus;
-
- /**
- * @public
- * SUCCEEDED: The enabledControl configuration was deployed successfully.UNDER_CHANGE: The enabledControl configuration is changing. FAILED: The enabledControl configuration failed to deploy.manifest.yaml text file that specifies the landing zone configurations. ACTIVE, PROCESSING, FAILED.manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review
+ * The manifest file.\n
\n controlIdentifier for the control--or guardrail--you are targeting.targetIdentifier.controlIdentifier for your Amazon Web Services Control Tower\n control:\n controlIdentifier is an ARN that is specified for each\n control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.controlIdentifier is unique in each Amazon Web Services Region for each control. You can\n find the controlIdentifier for each Region and control in the Tables of control metadata in the Amazon Web Services Control Tower User Guide.\n arn:aws:controltower:{REGION}::control/{CONTROL_NAME}\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n targetIdentifier:\n targetIdentifier is the ARN for an OU.arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n \n
\n \n
\n controlIdentifier for the control--or guardrail--you are targeting.targetIdentifier.controlIdentifier for your Amazon Web Services Control Tower\n control:\n controlIdentifier is an ARN that is specified for each\n control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.controlIdentifier is unique in each Amazon Web Services Region for each control. You can\n find the controlIdentifier for each Region and control in the Tables of control metadata in the Amazon Web Services Control Tower User Guide.\n arn:aws:controltower:{REGION}::control/{CONTROL_NAME}\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n targetIdentifier:\n targetIdentifier is the ARN for an OU.arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n \n
\n enum) with possible values of ENABLE_BASELINE, DISABLE_BASELINE, UPDATE_ENABLED_BASELINE, or RESET_ENABLED_BASELINE.enum) with possible values of SUCCEEDED, FAILED, or IN_PROGRESS.BaselineOperation, returning details about the specified Baseline operation ID.Baseline object.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.EnabledBaseline resource to be deactivated, in ARN format.DisableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.controlIdentifier, see the overview page.controlIdentifier, see the overview page.Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target.controlIdentifier, see the overview page.targetIdentifier, see the overview page.key-value objects that specify enablement parameters, where key is a string and value is a document of any type.EnabledControl resource.EnabledControlParameter objectsEnableBaseline.EnableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.EnabledControl resource.EnabledBaseline resource.controlIdentifier, see the overview page.targetIdentifier, see the overview page.controlIdentifier, see the overview page.targetIdentifier, see the overview page.EnabledControl resource.EnabledControl resource.EnabledBaseline resource.Baseline enabled as part of the EnabledBaseline resource.Baseline.Baseline.Baseline.EnabledBaseline resource.Baseline filter operation.Baseline objects returned as part of the filter operation.ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.Document object of any type (for example, a Java Object).EnabledBaseline resource.EnabledBaseline resource. EnabledBaseline resourceEnabledBaseline resource.EnabledBaseline object.controlIdentifier, see the overview page.targetIdentifier, see the overview page.string.array\n string, number, object, or boolean. Key is of type String and Value is of type Document.Key is of type String and Value is of type Document.\n
"
+ }
+ },
+ "lastOperationIdentifier": {
+ "target": "com.amazonaws.controltower#OperationIdentifier",
+ "traits": {
+ "smithy.api#documentation": "SUCCEEDED: The enabledControl configuration was deployed successfully.UNDER_CHANGE: The enabledControl configuration is changing. FAILED: The enabledControl configuration failed to deploy.Baseline resource by specifying its identifier.Baseline resource to be retrieved.EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure.baselineOperation object that shows information about the specified operation ID.\n
"
+ "smithy.api#documentation": "SUCCEEDED: The enabledControl configuration was deployed successfully.UNDER_CHANGE: The enabledControl configuration is changing. FAILED: The enabledControl configuration failed to deploy.EnabledBaseline resource by specifying its identifier.EnabledBaseline resource to be retrieved, in ARN format.EnabledBaseline resource.manifest.yaml text file that specifies the landing zone configurations. ACTIVE, PROCESSING, FAILED.Baseline object details.EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources.ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.EnabledBaseline resources.EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU.EnabledBaseline resource to be re-enabled, in ARN format.ResetEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.EnabledBaseline resource's applied parameters or version.Baseline version, to which the EnabledBaseline should be updated.EnabledBaseline resource to be updated.UpdateEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review \n The manifest file.