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:
-To get the controlIdentifier for your AWS Control Tower
+To get the controlIdentifier for your Amazon Web Services Control Tower
control:
The 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:
- * To get the The 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:
- * To get the The Creates a new landing zone. This 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. You do not have sufficient access to perform this action. Updating or deleting a resource can cause an inconsistent state. Updating or deleting the resource can cause an inconsistent state. Unexpected error during processing of request. An unexpected error occurred during processing of a request. Request was denied due to request throttling. The request was denied due to request throttling. The input fails to 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. This decommissions a landing zone. This starts an asynchronous operation that deletes Amazon Web Services Control Tower
- * resources deployed in Amazon Web Services Control Tower managed accounts. 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. You do not have sufficient access to perform this action. Updating or deleting a resource can cause an inconsistent state. Updating or deleting the resource can cause an inconsistent state. Unexpected error during processing of request. An unexpected error occurred during processing of a request. Request references a resource which does not exist. The request references a resource that does not exist. Request was denied due to request throttling. The request was denied due to request throttling. The input fails to 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. You do not have sufficient access to perform this action. Updating or deleting a resource can cause an inconsistent state. Updating or deleting the resource can cause an inconsistent state. Unexpected error during processing of request. An unexpected error occurred during processing of a request. Request references a resource which does not exist. The request references a resource that does not exist. Request would cause a service quota to be exceeded. The limit is 10 concurrent operations. The request would cause a service quota to be exceeded. The limit is 10 concurrent operations. Request was denied due to request throttling. The request was denied due to request throttling. The input fails to 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. You do not have sufficient access to perform this action. Updating or deleting a resource can cause an inconsistent state. Updating or deleting the resource can cause an inconsistent state. Unexpected error during processing of request. An unexpected error occurred during processing of a request. Request references a resource which does not exist. The request references a resource that does not exist. Request would cause a service quota to be exceeded. The limit is 10 concurrent operations. The request would cause a service quota to be exceeded. The limit is 10 concurrent operations. Request was denied due to request throttling. The request was denied due to request throttling. The input fails to 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. You do not have sufficient access to perform this action. Unexpected error during processing of request. An unexpected error occurred during processing of a request. Request references a resource which does not exist. The request references a resource that does not exist. Request was denied due to request throttling. The request was denied due to request throttling. The input fails to 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. You do not have sufficient access to perform this action. Unexpected error during processing of request. An unexpected error occurred during processing of a request. Request references a resource which does not exist. The request references a resource that does not exist. Request was denied due to request throttling. The request was denied due to request throttling. The input fails to 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 details about the landing zone. Displays a message in case of error. Returns details about the landing zone. Displays a message in case of error. You do not have sufficient access to perform this action. Unexpected error during processing of request. An unexpected error occurred during processing of a request. Request references a resource which does not exist. The request references a resource that does not exist. Request was denied due to request throttling. The request was denied due to request throttling. The input fails to 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 the status of the specified landing zone operation. Details for an operation are available for
- * X days. controlIdentifier is an ARN that is specified for each
@@ -419,6 +419,14 @@ UntagResource
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/controltower/command/UntagResourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/UntagResourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/UntagResourceCommandOutput/)
+
+
+UpdateEnabledControl
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/controltower/command/UpdateEnabledControlCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/UpdateEnabledControlCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/UpdateEnabledControlCommandOutput/)
+
diff --git a/clients/client-controltower/src/ControlTower.ts b/clients/client-controltower/src/ControlTower.ts
index 898c644fadfd..b5d8a4ebc5d5 100644
--- a/clients/client-controltower/src/ControlTower.ts
+++ b/clients/client-controltower/src/ControlTower.ts
@@ -68,6 +68,11 @@ import {
UntagResourceCommandInput,
UntagResourceCommandOutput,
} from "./commands/UntagResourceCommand";
+import {
+ UpdateEnabledControlCommand,
+ UpdateEnabledControlCommandInput,
+ UpdateEnabledControlCommandOutput,
+} from "./commands/UpdateEnabledControlCommand";
import {
UpdateLandingZoneCommand,
UpdateLandingZoneCommandInput,
@@ -90,6 +95,7 @@ const commands = {
ResetLandingZoneCommand,
TagResourceCommand,
UntagResourceCommand,
+ UpdateEnabledControlCommand,
UpdateLandingZoneCommand,
};
@@ -308,6 +314,23 @@ export interface ControlTower {
cb: (err: any, data?: UntagResourceCommandOutput) => void
): void;
+ /**
+ * @see {@link UpdateEnabledControlCommand}
+ */
+ updateEnabledControl(
+ args: UpdateEnabledControlCommandInput,
+ options?: __HttpHandlerOptions
+ ): Promise
*
* controlIdentifier for your AWS Control Tower
+ * To get the controlIdentifier for your Amazon Web Services Control Tower
* control:
* controlIdentifier is an ARN that is specified for each
diff --git a/clients/client-controltower/src/ControlTowerClient.ts b/clients/client-controltower/src/ControlTowerClient.ts
index 449e7cc0d51c..951b72b64bb6 100644
--- a/clients/client-controltower/src/ControlTowerClient.ts
+++ b/clients/client-controltower/src/ControlTowerClient.ts
@@ -76,6 +76,10 @@ import {
import { ResetLandingZoneCommandInput, ResetLandingZoneCommandOutput } from "./commands/ResetLandingZoneCommand";
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
+import {
+ UpdateEnabledControlCommandInput,
+ UpdateEnabledControlCommandOutput,
+} from "./commands/UpdateEnabledControlCommand";
import { UpdateLandingZoneCommandInput, UpdateLandingZoneCommandOutput } from "./commands/UpdateLandingZoneCommand";
import {
ClientInputEndpointParameters,
@@ -106,6 +110,7 @@ export type ServiceInputTypes =
| ResetLandingZoneCommandInput
| TagResourceCommandInput
| UntagResourceCommandInput
+ | UpdateEnabledControlCommandInput
| UpdateLandingZoneCommandInput;
/**
@@ -126,6 +131,7 @@ export type ServiceOutputTypes =
| ResetLandingZoneCommandOutput
| TagResourceCommandOutput
| UntagResourceCommandOutput
+ | UpdateEnabledControlCommandOutput
| UpdateLandingZoneCommandOutput;
/**
@@ -300,8 +306,8 @@ export interface ControlTowerClientResolvedConfig extends ControlTowerClientReso
/**
* @public
- *
*
* controlIdentifier for your AWS Control Tower
+ * To get the controlIdentifier for your Amazon Web Services Control Tower
* control:
* controlIdentifier is an ARN that is specified for each
diff --git a/clients/client-controltower/src/commands/CreateLandingZoneCommand.ts b/clients/client-controltower/src/commands/CreateLandingZoneCommand.ts
index 4b42708796e5..babefc612450 100644
--- a/clients/client-controltower/src/commands/CreateLandingZoneCommand.ts
+++ b/clients/client-controltower/src/commands/CreateLandingZoneCommand.ts
@@ -37,8 +37,8 @@ export interface CreateLandingZoneCommandOutput extends CreateLandingZoneOutput,
/**
* @public
- *
You do not have sufficient access to perform this action.
* * @throws {@link InternalServerException} (server fault) - *Unexpected error during processing of request.
+ *An unexpected error occurred during processing of a request.
* * @throws {@link ResourceNotFoundException} (client fault) - *Request references a resource which does not exist.
+ *The request references a resource that does not exist.
* * @throws {@link ThrottlingException} (client fault) - *Request was denied due to request throttling.
+ *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to 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/ListEnabledControlsCommand.ts b/clients/client-controltower/src/commands/ListEnabledControlsCommand.ts index 91de66f82259..0a41a1cc8059 100644 --- a/clients/client-controltower/src/commands/ListEnabledControlsCommand.ts +++ b/clients/client-controltower/src/commands/ListEnabledControlsCommand.ts @@ -84,16 +84,16 @@ export interface ListEnabledControlsCommandOutput extends ListEnabledControlsOut *You do not have sufficient access to perform this action.
* * @throws {@link InternalServerException} (server fault) - *Unexpected error during processing of request.
+ *An unexpected error occurred during processing of a request.
* * @throws {@link ResourceNotFoundException} (client fault) - *Request references a resource which does not exist.
+ *The request references a resource that does not exist.
* * @throws {@link ThrottlingException} (client fault) - *Request was denied due to request throttling.
+ *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to 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/ListLandingZonesCommand.ts b/clients/client-controltower/src/commands/ListLandingZonesCommand.ts index c81607acb565..aa77eed9931d 100644 --- a/clients/client-controltower/src/commands/ListLandingZonesCommand.ts +++ b/clients/client-controltower/src/commands/ListLandingZonesCommand.ts @@ -39,7 +39,7 @@ export interface ListLandingZonesCommandOutput extends ListLandingZonesOutput, _ * @public *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.
- *The return limit is one landing zone ARN.
+ *Returns one landing zone ARN.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -73,13 +73,13 @@ export interface ListLandingZonesCommandOutput extends ListLandingZonesOutput, _ *You do not have sufficient access to perform this action.
* * @throws {@link InternalServerException} (server fault) - *Unexpected error during processing of request.
+ *An unexpected error occurred during processing of a request.
* * @throws {@link ThrottlingException} (client fault) - *Request was denied due to request throttling.
+ *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to 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/ListTagsForResourceCommand.ts b/clients/client-controltower/src/commands/ListTagsForResourceCommand.ts index 2fcff2e73364..642cff16334a 100644 --- a/clients/client-controltower/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-controltower/src/commands/ListTagsForResourceCommand.ts @@ -66,13 +66,13 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape. * * @throws {@link InternalServerException} (server fault) - *Unexpected error during processing of request.
+ *An unexpected error occurred during processing of a request.
* * @throws {@link ResourceNotFoundException} (client fault) - *Request references a resource which does not exist.
+ *The request references a resource that does not exist.
* * @throws {@link ValidationException} (client fault) - *The input fails to 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/ResetLandingZoneCommand.ts b/clients/client-controltower/src/commands/ResetLandingZoneCommand.ts index 86b2f4f04555..82a767e7ad15 100644 --- a/clients/client-controltower/src/commands/ResetLandingZoneCommand.ts +++ b/clients/client-controltower/src/commands/ResetLandingZoneCommand.ts @@ -38,7 +38,7 @@ export interface ResetLandingZoneCommandOutput extends ResetLandingZoneOutput, _ /** * @public *This API call resets a landing zone. It starts an asynchronous operation that resets the - * landing zone to the parameters specified in its original configuration.
+ * landing zone to the parameters specified in its original configuration. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -66,19 +66,19 @@ export interface ResetLandingZoneCommandOutput extends ResetLandingZoneOutput, _ *You do not have sufficient access to perform this action.
* * @throws {@link ConflictException} (client fault) - *Updating or deleting a resource can cause an inconsistent state.
+ *Updating or deleting the resource can cause an inconsistent state.
* * @throws {@link InternalServerException} (server fault) - *Unexpected error during processing of request.
+ *An unexpected error occurred during processing of a request.
* * @throws {@link ResourceNotFoundException} (client fault) - *Request references a resource which does not exist.
+ *The request references a resource that does not exist.
* * @throws {@link ThrottlingException} (client fault) - *Request was denied due to request throttling.
+ *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to 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/TagResourceCommand.ts b/clients/client-controltower/src/commands/TagResourceCommand.ts index 13a51c3daa98..37902c936728 100644 --- a/clients/client-controltower/src/commands/TagResourceCommand.ts +++ b/clients/client-controltower/src/commands/TagResourceCommand.ts @@ -65,13 +65,13 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape. * * @throws {@link InternalServerException} (server fault) - *Unexpected error during processing of request.
+ *An unexpected error occurred during processing of a request.
* * @throws {@link ResourceNotFoundException} (client fault) - *Request references a resource which does not exist.
+ *The request references a resource that does not exist.
* * @throws {@link ValidationException} (client fault) - *The input fails to 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/UntagResourceCommand.ts b/clients/client-controltower/src/commands/UntagResourceCommand.ts index 73e7e767f575..daaa5690c1b6 100644 --- a/clients/client-controltower/src/commands/UntagResourceCommand.ts +++ b/clients/client-controltower/src/commands/UntagResourceCommand.ts @@ -65,13 +65,13 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape. * * @throws {@link InternalServerException} (server fault) - *Unexpected error during processing of request.
+ *An unexpected error occurred during processing of a request.
* * @throws {@link ResourceNotFoundException} (client fault) - *Request references a resource which does not exist.
+ *The request references a resource that does not exist.
* * @throws {@link ValidationException} (client fault) - *The input fails to 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/UpdateEnabledControlCommand.ts b/clients/client-controltower/src/commands/UpdateEnabledControlCommand.ts new file mode 100644 index 000000000000..45686f2403bb --- /dev/null +++ b/clients/client-controltower/src/commands/UpdateEnabledControlCommand.ts @@ -0,0 +1,173 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient"; +import { UpdateEnabledControlInput, UpdateEnabledControlOutput } from "../models/models_0"; +import { de_UpdateEnabledControlCommand, se_UpdateEnabledControlCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link UpdateEnabledControlCommand}. + */ +export interface UpdateEnabledControlCommandInput extends UpdateEnabledControlInput {} +/** + * @public + * + * The output of {@link UpdateEnabledControlCommand}. + */ +export interface UpdateEnabledControlCommandOutput extends UpdateEnabledControlOutput, __MetadataBearer {} + +/** + * @public + *+ * 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 will update 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 DisableControl and again calling EnableControl, or you can run an extending governance operation. For usage examples, see
+ * the Amazon Web Services Control Tower User Guide
+ *
+ *
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 UpdateEnabledControlCommand extends $Command< + UpdateEnabledControlCommandInput, + UpdateEnabledControlCommandOutput, + ControlTowerClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateEnabledControlCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThis API call updates the landing zone. It starts an asynchronous operation that updates the - * landing zone based on the new landing zone version or the updated parameters specified in the - * updated manifest file.
+ * landing zone based on the new landing zone version, or on the changed parameters specified in the + * updated manifest file. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -69,19 +69,19 @@ export interface UpdateLandingZoneCommandOutput extends UpdateLandingZoneOutput, *You do not have sufficient access to perform this action.
* * @throws {@link ConflictException} (client fault) - *Updating or deleting a resource can cause an inconsistent state.
+ *Updating or deleting the resource can cause an inconsistent state.
* * @throws {@link InternalServerException} (server fault) - *Unexpected error during processing of request.
+ *An unexpected error occurred during processing of a request.
* * @throws {@link ResourceNotFoundException} (client fault) - *Request references a resource which does not exist.
+ *The request references a resource that does not exist.
* * @throws {@link ThrottlingException} (client fault) - *Request was denied due to request throttling.
+ *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to 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/index.ts b/clients/client-controltower/src/commands/index.ts index 9bb1b5fa80ab..3fc3a18e0247 100644 --- a/clients/client-controltower/src/commands/index.ts +++ b/clients/client-controltower/src/commands/index.ts @@ -13,4 +13,5 @@ export * from "./ListTagsForResourceCommand"; export * from "./ResetLandingZoneCommand"; export * from "./TagResourceCommand"; export * from "./UntagResourceCommand"; +export * from "./UpdateEnabledControlCommand"; export * from "./UpdateLandingZoneCommand"; diff --git a/clients/client-controltower/src/index.ts b/clients/client-controltower/src/index.ts index 9da906dce708..0b4f0e8e46dc 100644 --- a/clients/client-controltower/src/index.ts +++ b/clients/client-controltower/src/index.ts @@ -1,8 +1,8 @@ // smithy-typescript generated code /* eslint-disable */ /** - *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:
*
- * To get the controlIdentifier for your AWS Control Tower
+ * To get the controlIdentifier for your Amazon Web Services Control Tower
* control:
*
The controlIdentifier is an ARN that is specified for each
diff --git a/clients/client-controltower/src/models/models_0.ts b/clients/client-controltower/src/models/models_0.ts
index eadbcb9093fb..ab411650c986 100644
--- a/clients/client-controltower/src/models/models_0.ts
+++ b/clients/client-controltower/src/models/models_0.ts
@@ -26,7 +26,7 @@ export class AccessDeniedException extends __BaseException {
/**
* @public
- *
Updating or deleting a resource can cause an inconsistent state.
+ *Updating or deleting the resource can cause an inconsistent state.
*/ export class ConflictException extends __BaseException { readonly name: "ConflictException" = "ConflictException"; @@ -52,7 +52,7 @@ export interface DisableControlInput { * @public *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.
controlIdentifier, see the overview page.
*/
controlIdentifier: string | undefined;
@@ -77,7 +77,7 @@ export interface DisableControlOutput {
/**
* @public
- * Unexpected error during processing of request.
+ *An unexpected error occurred during processing of a request.
*/ export class InternalServerException extends __BaseException { readonly name: "InternalServerException" = "InternalServerException"; @@ -98,7 +98,7 @@ export class InternalServerException extends __BaseException { /** * @public - *Request references a resource which does not exist.
+ *The request references a resource that does not exist.
*/ export class ResourceNotFoundException extends __BaseException { readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; @@ -118,7 +118,7 @@ export class ResourceNotFoundException extends __BaseException { /** * @public - *Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
+ *The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
*/ export class ServiceQuotaExceededException extends __BaseException { readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException"; @@ -138,7 +138,7 @@ export class ServiceQuotaExceededException extends __BaseException { /** * @public - *Request was denied due to request throttling.
+ *The request was denied due to request throttling.
*/ export class ThrottlingException extends __BaseException { readonly name: "ThrottlingException" = "ThrottlingException"; @@ -148,7 +148,8 @@ export class ThrottlingException extends __BaseException { }; /** * @public - *The ID of the service that is associated with the error.
+ *The ID of the service that is associated with the error. + *
*/ serviceCode?: string; @@ -160,7 +161,7 @@ export class ThrottlingException extends __BaseException { /** * @public - *The number of seconds the caller should wait before retrying.
+ *The number of seconds to wait before retrying.
*/ retryAfterSeconds?: number; @@ -182,7 +183,7 @@ export class ThrottlingException extends __BaseException { /** * @public - *The input fails to satisfy the constraints specified by an Amazon Web Services service.
+ *The input does not satisfy the constraints specified by an Amazon Web Services service.
*/ export class ValidationException extends __BaseException { readonly name: "ValidationException" = "ValidationException"; @@ -200,6 +201,25 @@ export class ValidationException extends __BaseException { } } +/** + * @public + * A set of parameters that configure the behavior of the enabled control. A key/value pair, where Key is of type String and Value is of type Document.
The key of a key/value pair. It is of type string.
The value of a key/value pair. It can be of type array
+ * string, number, object, or boolean.
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.
controlIdentifier, see the overview page.
*/
controlIdentifier: string | undefined;
@@ -223,6 +243,12 @@ export interface EnableControlInput {
* Tags to be applied to the EnabledControl resource.
An array of EnabledControlParameter objects
The drift summary of the enabled control.
+ *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.
@@ -375,28 +402,46 @@ export interface DriftStatusSummary { *
* 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.
Returns a summary of information about the parameters of an enabled control.
+ */ +export interface EnabledControlParameterSummary { + /** + * @public + *The key of a key/value pair.
+ */ + key: string | undefined; + + /** + * @public + *The value of a key/value pair.
+ */ + value: __DocumentType | undefined; +} + /** * @public * @enum @@ -447,10 +492,10 @@ export interface EnablementStatusSummary { /** * @public - *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.
+ * certain cases, a control is not actually enabled in the Region as expected, such as during + * drift, or mixed governance. */ export interface Region { /** @@ -500,6 +545,12 @@ export interface EnabledControlDetails { *The drift status of the enabled control.
*/ driftStatusSummary?: DriftStatusSummary; + + /** + * @public + *Array of EnabledControlParameter objects.
The landing zone version.
+ *The landing zone version, for example, 3.0.
*/ version: string | undefined; @@ -543,14 +594,14 @@ export interface CreateLandingZoneInput { export interface CreateLandingZoneOutput { /** * @public - *The ARN of the landing zone.
+ *The ARN of the landing zone resource.
*/ arn: string | undefined; /** * @public *A unique identifier assigned to a CreateLandingZone operation. You can use this
- * identifier as an input of GetLandingZoneOperation to check the operation's status.
GetLandingZoneOperation to check the operation's status.
*/
operationIdentifier: string | undefined;
}
@@ -561,7 +612,7 @@ export interface CreateLandingZoneOutput {
export interface DeleteLandingZoneInput {
/**
* @public
- * The unique identifier of the landing zone.
+ *The unique identifier of the landing zone.
*/ landingZoneIdentifier: string | undefined; } @@ -572,8 +623,8 @@ export interface DeleteLandingZoneInput { export interface DeleteLandingZoneOutput { /** * @public - *A unique identifier assigned to a DeleteLandingZone operation. You can use this
- * identifier as an input of GetLandingZoneOperation to check the operation's status.
>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.
The unique identifier of the landing zone.
+ *The unique identifier of the landing zone.
*/ landingZoneIdentifier: string | undefined; } @@ -607,7 +658,7 @@ export type LandingZoneDriftStatus = (typeof LandingZoneDriftStatus)[keyof typeo * @public *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.
+ * drift. You can repair this drift by resetting the landing zone. */ export interface LandingZoneDriftStatusSummary { /** @@ -647,57 +698,42 @@ export type LandingZoneStatus = (typeof LandingZoneStatus)[keyof typeof LandingZ /** * @public - *Information about the landing zone.
+ *Information about the landing zone.
*/ export interface LandingZoneDetail { /** * @public - *The landing zone's current deployed version.
+ *The landing zone's current deployed version.
*/ version: string | undefined; /** * @public - *The landing zone manifest.yaml text file that specifies the landing zone configurations.
+ *The landing zone manifest.yaml text file that specifies the landing zone configurations.
The ARN of the landing zone.
+ *The ARN of the landing zone.
*/ arn?: string; /** * @public - *The landing zone deployment status.
- *Valid values:
- *
- * ACTIVE: The landing zone is actively deployed.
- * PROCESSING: The landing zone is processing deployment.
- * FAILED: The landing zone failed deployment.
The landing zone deployment status.
*/ status?: LandingZoneStatus; /** * @public - *The latest available version of the landing zone.
+ *The latest available version of the landing zone.
*/ latestAvailableVersion?: string; /** * @public - *The drift status of the landing zone.
+ *The drift status of the landing zone.
*/ driftStatus?: LandingZoneDriftStatusSummary; } @@ -708,7 +744,7 @@ export interface LandingZoneDetail { export interface GetLandingZoneOutput { /** * @public - *Information about the landing zone.
+ *Information about the landing zone.
*/ landingZone: LandingZoneDetail | undefined; } @@ -719,7 +755,7 @@ export interface GetLandingZoneOutput { export interface GetLandingZoneOperationInput { /** * @public - *A unique identifier assigned to a landing zone operation.
+ *A unique identifier assigned to a landing zone operation.
*/ operationIdentifier: string | undefined; } @@ -757,7 +793,7 @@ export type LandingZoneOperationStatus = (typeof LandingZoneOperationStatus)[key /** * @public - *Information about a landing zone operation.
+ *Information about a landing zone operation.
*/ export interface LandingZoneOperationDetail { /** @@ -787,20 +823,19 @@ export interface LandingZoneOperationDetail { /** * @public - *The landing zone operation start time.
+ *The landing zone operation start time.
*/ startTime?: Date; /** * @public - *The landing zone operation end time.
+ *The landing zone operation end time.
*/ endTime?: Date; /** * @public - *The landing zone operation status.
- *Valid values:
+ *Valid values:
*@@ -820,7 +855,7 @@ export interface LandingZoneOperationDetail { /** * @public - *
If the operation result is FAILED, this string contains a message explaining why the operation failed.
+ *If the operation result is FAILED, this string contains a message explaining why the operation failed.
*/ statusMessage?: string; } @@ -831,7 +866,7 @@ export interface LandingZoneOperationDetail { export interface GetLandingZoneOperationOutput { /** * @public - *The landing zone operation details.
+ *Details about a landing zone operation.
*/ operationDetails: LandingZoneOperationDetail | undefined; } @@ -842,25 +877,25 @@ export interface GetLandingZoneOperationOutput { export interface ListLandingZonesInput { /** * @public - *The token to continue the list from a previous API call with the same parameters.
+ *The token to continue the list from a previous API call with the same parameters.
*/ nextToken?: string; /** * @public - *The maximum number of returned landing zone ARNs.
+ *The maximum number of returned landing zone ARNs, which is one.
*/ maxResults?: number; } /** * @public - *Returns a summary of information about a landing zone.
+ *Returns a summary of information about a landing zone.
*/ export interface LandingZoneSummary { /** * @public - *The ARN of the landing zone.
+ *The ARN of the landing zone.
*/ arn?: string; } @@ -871,13 +906,13 @@ export interface LandingZoneSummary { export interface ListLandingZonesOutput { /** * @public - *The ARN of the landing zone.
+ *The ARN of the landing zone.
*/ landingZones: LandingZoneSummary[] | undefined; /** * @public - *Retrieves the next page of results. If the string is empty, the current response is the end of the results.
+ *Retrieves the next page of results. If the string is empty, the response is the end of the results.
*/ nextToken?: string; } @@ -888,7 +923,7 @@ export interface ListLandingZonesOutput { export interface ResetLandingZoneInput { /** * @public - *The unique identifier of the landing zone.
+ *The unique identifier of the landing zone.
*/ landingZoneIdentifier: string | undefined; } @@ -900,7 +935,7 @@ export interface ResetLandingZoneOutput { /** * @public *A unique identifier assigned to a ResetLandingZone operation. You can use this
- * identifier as an input of GetLandingZoneOperation to check the operation's status.
GetLandingZoneOperation to check the operation's status.
*/
operationIdentifier: string | undefined;
}
@@ -911,21 +946,20 @@ export interface ResetLandingZoneOutput {
export interface UpdateLandingZoneInput {
/**
* @public
- * The landing zone version.
+ *The landing zone version, for example, 3.2.
*/ version: string | undefined; /** * @public - *The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review - * The manifest file - *
+ *The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review
+ * The manifest file.
The unique identifier of the landing zone.
+ *The unique identifier of the landing zone.
*/ landingZoneIdentifier: string | undefined; } @@ -984,9 +1018,7 @@ export interface EnabledControlSummary { /** * @public - *- * The ARN of the organizational unit. - *
+ *The ARN of the organizational unit.
*/ targetIdentifier?: string; @@ -1016,7 +1048,7 @@ export interface ListEnabledControlsOutput { /** * @public - *Retrieves the next page of results. If the string is empty, the current response is the + *
Retrieves the next page of results. If the string is empty, the response is the * end of the results.
*/ nextToken?: string; @@ -1087,3 +1119,35 @@ export interface UntagResourceInput { * @public */ export interface UntagResourceOutput {} + +/** + * @public + */ +export interface UpdateEnabledControlInput { + /** + * @public + *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. + *
+ */ + enabledControlIdentifier: string | undefined; +} + +/** + * @public + */ +export interface UpdateEnabledControlOutput { + /** + * @public + *
+ * The operation identifier for this UpdateEnabledControl operation.
+ *
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.
\nTo call these APIs, you'll need to know:
\nthe 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.
\n\n To get the controlIdentifier for your AWS Control Tower\n control:\n
The 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.
The 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
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\n ARN format:\n arn:aws:controltower:{REGION}::control/{CONTROL_NAME}\n
\n Example:\n
\n\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n
\n To get the targetIdentifier:\n
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.
\n\n OU ARN format:\n
\n\n arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n
\n Details and examples\n
\n\n Creating Amazon Web Services Control Tower resources with Amazon Web Services CloudFormation\n
\nTo view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n
\n\n Recording API Requests\n
\nAmazon 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.
", + "smithy.api#documentation": "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.
\nTo call these APIs, you'll need to know:
\nthe 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.
\n\n To get the controlIdentifier for your Amazon Web Services Control Tower\n control:\n
The 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.
The 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
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\n ARN format:\n arn:aws:controltower:{REGION}::control/{CONTROL_NAME}\n
\n Example:\n
\n\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n
\n To get the targetIdentifier:\n
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.
\n\n OU ARN format:\n
\n\n arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n
\n Details and examples\n
\n\n Creating Amazon Web Services Control Tower resources with Amazon Web Services CloudFormation\n
\nTo view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n
\n\n Recording API Requests\n
\nAmazon 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.
", "smithy.api#title": "AWS Control Tower", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -953,7 +956,7 @@ } }, "traits": { - "smithy.api#documentation": "Updating or deleting a resource can cause an inconsistent state.
", + "smithy.api#documentation": "Updating or deleting the resource can cause an inconsistent state.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1038,6 +1041,10 @@ { "name": "DISABLE_CONTROL", "value": "DISABLE_CONTROL" + }, + { + "name": "UPDATE_ENABLED_CONTROL", + "value": "UPDATE_ENABLED_CONTROL" } ] } @@ -1068,7 +1075,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new landing zone. This starts an asynchronous operation that creates and configures a landing zone \n based on the parameters specified in the manifest JSON file.
", + "smithy.api#documentation": "Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, \n based on the parameters specified in the manifest JSON file.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -1082,7 +1089,7 @@ "version": { "target": "com.amazonaws.controltower#LandingZoneVersion", "traits": { - "smithy.api#documentation": "The landing zone version.
", + "smithy.api#documentation": "The landing zone version, for example, 3.0.
", "smithy.api#required": {} } }, @@ -1111,14 +1118,14 @@ "arn": { "target": "com.amazonaws.controltower#Arn", "traits": { - "smithy.api#documentation": "The ARN of the landing zone.
", + "smithy.api#documentation": "The ARN of the landing zone resource.
", "smithy.api#required": {} } }, "operationIdentifier": { "target": "com.amazonaws.controltower#OperationIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier assigned to a CreateLandingZone operation. You can use this \n identifier as an input of GetLandingZoneOperation to check the operation's status.
A unique identifier assigned to a CreateLandingZone operation. You can use this \n identifier as an input of GetLandingZoneOperation to check the operation's status.
This decommissions a landing zone. This starts an asynchronous operation that deletes Amazon Web Services Control Tower \n resources deployed in Amazon Web Services Control Tower managed accounts.
", + "smithy.api#documentation": "Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower \n resources deployed in accounts managed by Amazon Web Services Control Tower.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -1171,7 +1178,7 @@ "landingZoneIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The unique identifier of the landing zone.
", + "smithy.api#documentation": "The unique identifier of the landing zone.
", "smithy.api#required": {} } } @@ -1186,7 +1193,7 @@ "operationIdentifier": { "target": "com.amazonaws.controltower#OperationIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier assigned to a DeleteLandingZone operation. You can use this \n identifier as an input of GetLandingZoneOperation to check the operation's status.
>A unique identifier assigned to a DeleteLandingZone operation. You can use this \n identifier as an input parameter of GetLandingZoneOperation to check the operation's status.
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 controlIdentifier, see the overview page.
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 controlIdentifier, see the overview page.
The drift status of the enabled control.
\nValid values:
\n\n DRIFTED: The enabledControl deployed in this configuration\n doesn’t match the configuration that Amazon Web Services Control Tower expected.
\n IN_SYNC: The enabledControl deployed in this configuration matches\n the configuration that Amazon Web Services Control Tower expected.
\n NOT_CHECKING: Amazon Web Services Control Tower does not check drift for this enabled\n control. Drift is not supported for the control type.
\n UNKNOWN: Amazon Web Services Control Tower is not able to check the drift status for the\n enabled control.
The drift status of the enabled control.
\nValid values:
\n\n DRIFTED: The enabledControl deployed in this configuration\n doesn’t match the configuration that Amazon Web Services Control Tower expected.
\n IN_SYNC: The enabledControl deployed in this configuration matches\n the configuration that Amazon Web Services Control Tower expected.
\n NOT_CHECKING: Amazon Web Services Control Tower does not check drift for this enabled\n control. Drift is not supported for the control type.
\n UNKNOWN: Amazon Web Services Control Tower is not able to check the drift status for the\n enabled control.
The drift summary of the enabled control.
\nAmazon 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.
" + "smithy.api#documentation": "The drift summary of the enabled control.
\nAmazon 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.
" } }, "com.amazonaws.controltower#EnableControl": { @@ -1355,7 +1362,7 @@ "controlIdentifier": { "target": "com.amazonaws.controltower#ControlIdentifier", "traits": { - "smithy.api#documentation": "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 controlIdentifier, see the overview page.
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 controlIdentifier, see the overview page.
Tags to be applied to the EnabledControl resource.
An array of EnabledControlParameter objects
The drift status of the enabled control.
" } + }, + "parameters": { + "target": "com.amazonaws.controltower#EnabledControlParameterSummaries", + "traits": { + "smithy.api#documentation": "Array of EnabledControlParameter objects.
Information about the enabled control.
" } }, + "com.amazonaws.controltower#EnabledControlParameter": { + "type": "structure", + "members": { + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The key of a key/value pair. It is of type string.
The value of a key/value pair. It can be of type array\n string, number, object, or boolean.
A set of parameters that configure the behavior of the enabled control. A key/value pair, where Key is of type String and Value is of type Document.
The key of a key/value pair.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "The value of a key/value pair.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Returns a summary of information about the parameters of an enabled control.
" + } + }, + "com.amazonaws.controltower#EnabledControlParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#EnabledControlParameter" + } + }, "com.amazonaws.controltower#EnabledControlSummary": { "type": "structure", "members": { @@ -1454,7 +1529,7 @@ "targetIdentifier": { "target": "com.amazonaws.controltower#TargetIdentifier", "traits": { - "smithy.api#documentation": "\n The ARN of the organizational unit.\n
" + "smithy.api#documentation": "The ARN of the organizational unit.
" } }, "statusSummary": { @@ -1673,7 +1748,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns details about the landing zone. Displays a message in case of error.
", + "smithy.api#documentation": "Returns details about the landing zone. Displays a message in case of error.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -1688,7 +1763,7 @@ "landingZoneIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The unique identifier of the landing zone.
", + "smithy.api#documentation": "The unique identifier of the landing zone.
", "smithy.api#required": {} } } @@ -1723,7 +1798,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the status of the specified landing zone operation. Details for an operation are available for \n X days.
", + "smithy.api#documentation": "Returns the status of the specified landing zone operation. Details for an operation are available for \n 60 days.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -1738,7 +1813,7 @@ "operationIdentifier": { "target": "com.amazonaws.controltower#OperationIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier assigned to a landing zone operation.
", + "smithy.api#documentation": "A unique identifier assigned to a landing zone operation.
", "smithy.api#required": {} } } @@ -1753,7 +1828,7 @@ "operationDetails": { "target": "com.amazonaws.controltower#LandingZoneOperationDetail", "traits": { - "smithy.api#documentation": "The landing zone operation details.
", + "smithy.api#documentation": "Details about a landing zone operation.
", "smithy.api#required": {} } } @@ -1768,7 +1843,7 @@ "landingZone": { "target": "com.amazonaws.controltower#LandingZoneDetail", "traits": { - "smithy.api#documentation": "Information about the landing zone.
", + "smithy.api#documentation": "Information about the landing zone.
", "smithy.api#required": {} } } @@ -1788,7 +1863,7 @@ } }, "traits": { - "smithy.api#documentation": "Unexpected error during processing of request.
", + "smithy.api#documentation": "An unexpected error occurred during processing of a request.
", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} @@ -1800,44 +1875,44 @@ "version": { "target": "com.amazonaws.controltower#LandingZoneVersion", "traits": { - "smithy.api#documentation": "The landing zone's current deployed version.
", + "smithy.api#documentation": "The landing zone's current deployed version.
", "smithy.api#required": {} } }, "manifest": { "target": "com.amazonaws.controltower#Manifest", "traits": { - "smithy.api#documentation": "The landing zone manifest.yaml text file that specifies the landing zone configurations.
", + "smithy.api#documentation": "The landing zone manifest.yaml text file that specifies the landing zone configurations.
The ARN of the landing zone.
" + "smithy.api#documentation": "The ARN of the landing zone.
" } }, "status": { "target": "com.amazonaws.controltower#LandingZoneStatus", "traits": { - "smithy.api#documentation": "The landing zone deployment status.
\nValid values:
\n\n ACTIVE: The landing zone is actively deployed.
\n PROCESSING: The landing zone is processing deployment.
\n FAILED: The landing zone failed deployment.
The landing zone deployment status.
" } }, "latestAvailableVersion": { "target": "com.amazonaws.controltower#LandingZoneVersion", "traits": { - "smithy.api#documentation": "The latest available version of the landing zone.
" + "smithy.api#documentation": "The latest available version of the landing zone.
" } }, "driftStatus": { "target": "com.amazonaws.controltower#LandingZoneDriftStatusSummary", "traits": { - "smithy.api#documentation": "The drift status of the landing zone.
" + "smithy.api#documentation": "The drift status of the landing zone.
" } } }, "traits": { - "smithy.api#documentation": "Information about the landing zone.
" + "smithy.api#documentation": "Information about the landing zone.
" } }, "com.amazonaws.controltower#LandingZoneDriftStatus": { @@ -1868,7 +1943,7 @@ } }, "traits": { - "smithy.api#documentation": "The drift status summary of the landing zone.
\nIf the landing zone differs from the expected configuration, it is defined to be in a state of \n drift. You can repair this drift by resetting the landing zone.
" + "smithy.api#documentation": "The drift status summary of the landing zone.
\nIf the landing zone differs from the expected configuration, it is defined to be in a state of \n drift. You can repair this drift by resetting the landing zone.
" } }, "com.amazonaws.controltower#LandingZoneOperationDetail": { @@ -1883,30 +1958,30 @@ "startTime": { "target": "com.amazonaws.controltower#Timestamp", "traits": { - "smithy.api#documentation": "The landing zone operation start time.
" + "smithy.api#documentation": "The landing zone operation start time.
" } }, "endTime": { "target": "com.amazonaws.controltower#Timestamp", "traits": { - "smithy.api#documentation": "The landing zone operation end time.
" + "smithy.api#documentation": "The landing zone operation end time.
" } }, "status": { "target": "com.amazonaws.controltower#LandingZoneOperationStatus", "traits": { - "smithy.api#documentation": "The landing zone operation status.
\nValid values:
\n\n SUCCEEDED: The landing zone operation succeeded.
\n IN_PROGRESS: The landing zone operation is in progress.
\n FAILED: The landing zone operation failed.
Valid values:
\n\n SUCCEEDED: The landing zone operation succeeded.
\n IN_PROGRESS: The landing zone operation is in progress.
\n FAILED: The landing zone operation failed.
If the operation result is FAILED, this string contains a message explaining why the operation failed.
" + "smithy.api#documentation": "If the operation result is FAILED, this string contains a message explaining why the operation failed.
" } } }, "traits": { - "smithy.api#documentation": "Information about a landing zone operation.
" + "smithy.api#documentation": "Information about a landing zone operation.
" } }, "com.amazonaws.controltower#LandingZoneOperationStatus": { @@ -2034,12 +2109,12 @@ "arn": { "target": "com.amazonaws.controltower#Arn", "traits": { - "smithy.api#documentation": "The ARN of the landing zone.
" + "smithy.api#documentation": "The ARN of the landing zone.
" } } }, "traits": { - "smithy.api#documentation": "Returns a summary of information about a landing zone.
" + "smithy.api#documentation": "Returns a summary of information about a landing zone.
" } }, "com.amazonaws.controltower#LandingZoneVersion": { @@ -2130,7 +2205,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Retrieves the next page of results. If the string is empty, the current response is the\n end of the results.
" + "smithy.api#documentation": "Retrieves the next page of results. If the string is empty, the response is the\n end of the results.
" } } } @@ -2158,7 +2233,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the landing zone ARN for the landing zone deployed in your managed account. This API also \n creates an ARN for existing accounts that do not yet have a landing zone ARN.
\nThe return limit is one landing zone ARN.
", + "smithy.api#documentation": "Returns the landing zone ARN for the landing zone deployed in your managed account. This API also \n creates an ARN for existing accounts that do not yet have a landing zone ARN.
\nReturns one landing zone ARN.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -2179,13 +2254,13 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The token to continue the list from a previous API call with the same parameters.
" + "smithy.api#documentation": "The token to continue the list from a previous API call with the same parameters.
" } }, "maxResults": { "target": "com.amazonaws.controltower#ListLandingZonesMaxResults", "traits": { - "smithy.api#documentation": "The maximum number of returned landing zone ARNs.
" + "smithy.api#documentation": "The maximum number of returned landing zone ARNs, which is one.
" } } }, @@ -2208,7 +2283,7 @@ "landingZones": { "target": "com.amazonaws.controltower#LandingZoneSummaries", "traits": { - "smithy.api#documentation": "The ARN of the landing zone.
", + "smithy.api#documentation": "The ARN of the landing zone.
", "smithy.api#length": { "min": 0, "max": 1 @@ -2219,7 +2294,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Retrieves the next page of results. If the string is empty, the current response is the end of the results.
" + "smithy.api#documentation": "Retrieves the next page of results. If the string is empty, the response is the end of the results.
" } } }, @@ -2320,7 +2395,7 @@ } }, "traits": { - "smithy.api#documentation": "An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed.
\nThe 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.
" + "smithy.api#documentation": "An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed.
\nThe 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.
" } }, "com.amazonaws.controltower#RegionName": { @@ -2361,7 +2436,7 @@ } ], "traits": { - "smithy.api#documentation": "This API call resets a landing zone. It starts an asynchronous operation that resets the \n landing zone to the parameters specified in its original configuration.
", + "smithy.api#documentation": "This API call resets a landing zone. It starts an asynchronous operation that resets the \n landing zone to the parameters specified in its original configuration.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -2375,7 +2450,7 @@ "landingZoneIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The unique identifier of the landing zone.
", + "smithy.api#documentation": "The unique identifier of the landing zone.
", "smithy.api#required": {} } } @@ -2390,7 +2465,7 @@ "operationIdentifier": { "target": "com.amazonaws.controltower#OperationIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier assigned to a ResetLandingZone operation. You can use this \n identifier as an input of GetLandingZoneOperation to check the operation's status.
A unique identifier assigned to a ResetLandingZone operation. You can use this \n identifier as an input parameter of GetLandingZoneOperation to check the operation's status.
Request references a resource which does not exist.
", + "smithy.api#documentation": "The request references a resource that does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -2426,7 +2501,7 @@ } }, "traits": { - "smithy.api#documentation": "Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
", + "smithy.api#documentation": "The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -2562,7 +2637,7 @@ "serviceCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The ID of the service that is associated with the error.
" + "smithy.api#documentation": "The ID of the service that is associated with the error.\n
" } }, "quotaCode": { @@ -2574,13 +2649,13 @@ "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The number of seconds the caller should wait before retrying.
", + "smithy.api#documentation": "The number of seconds to wait before retrying.
", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { - "smithy.api#documentation": "Request was denied due to request throttling.
", + "smithy.api#documentation": "The request was denied due to request throttling.
", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { @@ -2653,6 +2728,83 @@ "smithy.api#output": {} } }, + "com.amazonaws.controltower#UpdateEnabledControl": { + "type": "operation", + "input": { + "target": "com.amazonaws.controltower#UpdateEnabledControlInput" + }, + "output": { + "target": "com.amazonaws.controltower#UpdateEnabledControlOutput" + }, + "errors": [ + { + "target": "com.amazonaws.controltower#AccessDeniedException" + }, + { + "target": "com.amazonaws.controltower#ConflictException" + }, + { + "target": "com.amazonaws.controltower#InternalServerException" + }, + { + "target": "com.amazonaws.controltower#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.controltower#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.controltower#ThrottlingException" + }, + { + "target": "com.amazonaws.controltower#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Updates the configuration of an already enabled control.
\nIf 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 will update 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 DisableControl and again calling EnableControl, or you can run an extending governance operation. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n \n
A key/value pair, where Key is of type String and Value is of type Document.
\n The ARN of the enabled control that will be updated.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.controltower#UpdateEnabledControlOutput": { + "type": "structure", + "members": { + "operationIdentifier": { + "target": "com.amazonaws.controltower#OperationIdentifier", + "traits": { + "smithy.api#documentation": "\n The operation identifier for this UpdateEnabledControl operation.\n
This API call updates the landing zone. It starts an asynchronous operation that updates the \n landing zone based on the new landing zone version or the updated parameters specified in the \n updated manifest file.
", + "smithy.api#documentation": "This API call updates the landing zone. It starts an asynchronous operation that updates the \n landing zone based on the new landing zone version, or on the changed parameters specified in the \n updated manifest file.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -2696,21 +2848,21 @@ "version": { "target": "com.amazonaws.controltower#LandingZoneVersion", "traits": { - "smithy.api#documentation": "The landing zone version.
", + "smithy.api#documentation": "The landing zone version, for example, 3.2.
", "smithy.api#required": {} } }, "manifest": { "target": "com.amazonaws.controltower#Manifest", "traits": { - "smithy.api#documentation": "The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review \n The manifest file\n
", + "smithy.api#documentation": "The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review \n The manifest file.
The unique identifier of the landing zone.
", + "smithy.api#documentation": "The unique identifier of the landing zone.
", "smithy.api#required": {} } } @@ -2745,7 +2897,7 @@ } }, "traits": { - "smithy.api#documentation": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
", + "smithy.api#documentation": "The input does not satisfy the constraints specified by an Amazon Web Services service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 }