@aws-sdk/client-controltower 3.454.0 → 3.459.0

package/dist-types/commands/UpdateEnabledControlCommand.d.ts

@@ -0,0 +1,107 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient";
+import { UpdateEnabledControlInput, UpdateEnabledControlOutput } from "../models/models_0";
+/**
+ * @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
+ * <p>
+ *          Updates the configuration of an already enabled control.</p>
+ *          <p>If the enabled control shows an <code>EnablementStatus</code> of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.</p>
+ *          <p>If the enabled control shows an <code>EnablementStatus</code> of FAILED, Amazon Web Services Control Tower will update the control to match any valid parameters that you supply.</p>
+ *          <p>If the <code>DriftSummary</code> status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling <code>DisableControl</code> and again calling <code>EnableControl</code>, or you can run an extending governance operation. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">
+ *                <i>the Amazon Web Services Control Tower User Guide</i>
+ *             </a>
+ *          </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ControlTowerClient, UpdateEnabledControlCommand } from "@aws-sdk/client-controltower"; // ES Modules import
+ * // const { ControlTowerClient, UpdateEnabledControlCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
+ * const client = new ControlTowerClient(config);
+ * const input = { // UpdateEnabledControlInput
+ *   parameters: [ // EnabledControlParameters // required
+ *     { // EnabledControlParameter
+ *       key: "STRING_VALUE", // required
+ *       value: "DOCUMENT_VALUE", // required
+ *     },
+ *   ],
+ *   enabledControlIdentifier: "STRING_VALUE", // required
+ * };
+ * const command = new UpdateEnabledControlCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateEnabledControlOutput
+ * //   operationIdentifier: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateEnabledControlCommandInput - {@link UpdateEnabledControlCommandInput}
+ * @returns {@link UpdateEnabledControlCommandOutput}
+ * @see {@link UpdateEnabledControlCommandInput} for command's `input` shape.
+ * @see {@link UpdateEnabledControlCommandOutput} for command's `response` shape.
+ * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Updating or deleting the resource can cause an inconsistent state.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An unexpected error occurred during processing of a request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request references a resource that does not exist.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input does not satisfy the constraints specified by an  Amazon Web Services service.</p>
+ *
+ * @throws {@link ControlTowerServiceException}
+ * <p>Base exception class for all service exceptions from ControlTower service.</p>
+ *
+ */
+export declare class UpdateEnabledControlCommand extends $Command<UpdateEnabledControlCommandInput, UpdateEnabledControlCommandOutput, ControlTowerClientResolvedConfig> {
+    readonly input: UpdateEnabledControlCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateEnabledControlCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateEnabledControlCommandInput, UpdateEnabledControlCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/UpdateLandingZoneCommand.d.ts

@@ -0,0 +1,95 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient";
+import { UpdateLandingZoneInput, UpdateLandingZoneOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateLandingZoneCommand}.
+ */
+export interface UpdateLandingZoneCommandInput extends UpdateLandingZoneInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateLandingZoneCommand}.
+ */
+export interface UpdateLandingZoneCommandOutput extends UpdateLandingZoneOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>This API call updates the landing zone. It starts an asynchronous operation that updates the
+ *          landing zone based on the new landing zone version, or on the changed parameters specified in the
+ *          updated manifest file. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ControlTowerClient, UpdateLandingZoneCommand } from "@aws-sdk/client-controltower"; // ES Modules import
+ * // const { ControlTowerClient, UpdateLandingZoneCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
+ * const client = new ControlTowerClient(config);
+ * const input = { // UpdateLandingZoneInput
+ *   version: "STRING_VALUE", // required
+ *   manifest: "DOCUMENT_VALUE", // required
+ *   landingZoneIdentifier: "STRING_VALUE", // required
+ * };
+ * const command = new UpdateLandingZoneCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateLandingZoneOutput
+ * //   operationIdentifier: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateLandingZoneCommandInput - {@link UpdateLandingZoneCommandInput}
+ * @returns {@link UpdateLandingZoneCommandOutput}
+ * @see {@link UpdateLandingZoneCommandInput} for command's `input` shape.
+ * @see {@link UpdateLandingZoneCommandOutput} for command's `response` shape.
+ * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Updating or deleting the resource can cause an inconsistent state.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An unexpected error occurred during processing of a request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request references a resource that does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input does not satisfy the constraints specified by an  Amazon Web Services service.</p>
+ *
+ * @throws {@link ControlTowerServiceException}
+ * <p>Base exception class for all service exceptions from ControlTower service.</p>
+ *
+ */
+export declare class UpdateLandingZoneCommand extends $Command<UpdateLandingZoneCommandInput, UpdateLandingZoneCommandOutput, ControlTowerClientResolvedConfig> {
+    readonly input: UpdateLandingZoneCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateLandingZoneCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateLandingZoneCommandInput, UpdateLandingZoneCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/index.d.ts

@@ -1,8 +1,16 @@
+export * from "./CreateLandingZoneCommand";
+export * from "./DeleteLandingZoneCommand";
 export * from "./DisableControlCommand";
 export * from "./EnableControlCommand";
 export * from "./GetControlOperationCommand";
 export * from "./GetEnabledControlCommand";
+export * from "./GetLandingZoneCommand";
+export * from "./GetLandingZoneOperationCommand";
 export * from "./ListEnabledControlsCommand";
+export * from "./ListLandingZonesCommand";
 export * from "./ListTagsForResourceCommand";
+export * from "./ResetLandingZoneCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
+export * from "./UpdateEnabledControlCommand";
+export * from "./UpdateLandingZoneCommand";

package/dist-types/index.d.ts

@@ -1,6 +1,6 @@
 /**
- * <p>These interfaces allow you to apply the AWS library of pre-defined
- *          <i>controls</i> to your organizational units, programmatically. In AWS Control Tower, the terms "control" and "guardrail" are synonyms.</p>
+ * <p>These interfaces allow you to apply the  Amazon Web Services library of pre-defined
+ *          <i>controls</i> to your organizational units, programmatically. In  Amazon Web Services Control Tower, the terms "control" and "guardrail" are synonyms.</p>
  *          <p>To call these APIs, you'll need to know:</p>
  *          <ul>
  *             <li>
@@ -14,18 +14,18 @@
  *             </li>
  *          </ul>
  *          <p>
- *             <b>To get the <code>controlIdentifier</code> for your AWS Control Tower
+ *             <b>To get the <code>controlIdentifier</code> for your Amazon Web Services Control Tower
  *          control:</b>
  *          </p>
  *          <p>The <code>controlIdentifier</code> is an ARN that is specified for each
  *          control. You can view the <code>controlIdentifier</code> in the console on the <b>Control details</b> page, as well as in the documentation.</p>
- *          <p>The <code>controlIdentifier</code> is unique in each AWS Region for each control. You can
- *          find the <code>controlIdentifier</code> for each Region and control in the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html">Tables of control metadata</a> in the <i>AWS Control Tower User Guide.</i>
+ *          <p>The <code>controlIdentifier</code> is unique in each Amazon Web Services Region for each control. You can
+ *          find the <code>controlIdentifier</code> for each Region and control in the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html">Tables of control metadata</a> in the <i>Amazon Web Services Control Tower User Guide.</i>
  *          </p>
- *          <p>A quick-reference list of control identifers for the AWS Control Tower legacy <i>Strongly recommended</i> and
+ *          <p>A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy <i>Strongly recommended</i> and
  *          <i>Elective</i> controls is given in <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html">Resource identifiers for
  *             APIs and controls</a> in the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html">Controls reference guide section</a>
- *          of the <i>AWS Control Tower User Guide</i>. Remember that <i>Mandatory</i> controls
+ *          of the <i>Amazon Web Services Control Tower User Guide</i>. Remember that <i>Mandatory</i> controls
  *          cannot be added or removed.</p>
  *          <note>
  *             <p>
@@ -43,7 +43,7 @@
  *             <b>To get the <code>targetIdentifier</code>:</b>
  *          </p>
  *          <p>The <code>targetIdentifier</code> is the ARN for an OU.</p>
- *          <p>In the AWS Organizations console, you can find the ARN for the OU on the <b>Organizational unit details</b> page associated with that OU.</p>
+ *          <p>In the Amazon Web Services Organizations console, you can find the ARN for the OU on the <b>Organizational unit details</b> page associated with that OU.</p>
  *          <note>
  *             <p>
  *                <b>OU ARN format:</b>
@@ -88,7 +88,7 @@
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/controltower/latest/userguide/creating-resources-with-cloudformation.html">Creating AWS Control Tower resources with AWS CloudFormation</a>
+ *                   <a href="https://docs.aws.amazon.com/controltower/latest/userguide/creating-resources-with-cloudformation.html">Creating Amazon Web Services Control Tower resources with Amazon Web Services CloudFormation</a>
  *                </p>
  *             </li>
  *          </ul>
@@ -97,13 +97,13 @@
  *          <p>
  *             <b>Recording API Requests</b>
  *          </p>
- *          <p>AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your
- *          AWS account and delivers log files to an Amazon S3 bucket. By using information collected by
- *          CloudTrail, you can determine which requests the AWS Control Tower service received, who made
- *          the request and when, and so on. For more about AWS Control Tower and its support for
- *          CloudTrail, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging AWS Control Tower
- *             Actions with AWS CloudTrail</a> in the AWS Control Tower User Guide. To learn more about
- *          CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User
+ *          <p>Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your
+ *          Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by
+ *          CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made
+ *          the request and when, and so on. For more about Amazon Web Services Control Tower and its support for
+ *          CloudTrail, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging Amazon Web Services Control Tower
+ *             Actions with Amazon Web Services CloudTrail</a> in the Amazon Web Services Control Tower User Guide. To learn more about
+ *          CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User
  *          Guide.</p>
  *
  * @packageDocumentation