@aws-sdk/client-controltower 3.600.0 → 3.606.0

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

@@ -0,0 +1,88 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient";
+import { ListLandingZoneOperationsInput, ListLandingZoneOperationsOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListLandingZoneOperationsCommand}.
+ */
+export interface ListLandingZoneOperationsCommandInput extends ListLandingZoneOperationsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListLandingZoneOperationsCommand}.
+ */
+export interface ListLandingZoneOperationsCommandOutput extends ListLandingZoneOperationsOutput, __MetadataBearer {
+}
+declare const ListLandingZoneOperationsCommand_base: {
+    new (input: ListLandingZoneOperationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListLandingZoneOperationsCommandInput, ListLandingZoneOperationsCommandOutput, ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListLandingZoneOperationsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListLandingZoneOperationsCommandInput, ListLandingZoneOperationsCommandOutput, ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ControlTowerClient, ListLandingZoneOperationsCommand } from "@aws-sdk/client-controltower"; // ES Modules import
+ * // const { ControlTowerClient, ListLandingZoneOperationsCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
+ * const client = new ControlTowerClient(config);
+ * const input = { // ListLandingZoneOperationsInput
+ *   filter: { // LandingZoneOperationFilter
+ *     types: [ // LandingZoneOperationTypes
+ *       "DELETE" || "CREATE" || "UPDATE" || "RESET",
+ *     ],
+ *     statuses: [ // LandingZoneOperationStatuses
+ *       "SUCCEEDED" || "FAILED" || "IN_PROGRESS",
+ *     ],
+ *   },
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
+ * const command = new ListLandingZoneOperationsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListLandingZoneOperationsOutput
+ * //   landingZoneOperations: [ // LandingZoneOperations // required
+ * //     { // LandingZoneOperationSummary
+ * //       operationType: "DELETE" || "CREATE" || "UPDATE" || "RESET",
+ * //       operationIdentifier: "STRING_VALUE",
+ * //       status: "SUCCEEDED" || "FAILED" || "IN_PROGRESS",
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListLandingZoneOperationsCommandInput - {@link ListLandingZoneOperationsCommandInput}
+ * @returns {@link ListLandingZoneOperationsCommandOutput}
+ * @see {@link ListLandingZoneOperationsCommandInput} for command's `input` shape.
+ * @see {@link ListLandingZoneOperationsCommandOutput} 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 InternalServerException} (server fault)
+ *  <p>An unexpected error occurred during processing of a request.</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>
+ *
+ * @public
+ */
+export declare class ListLandingZoneOperationsCommand extends ListLandingZoneOperationsCommand_base {
+}

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

@@ -27,8 +27,8 @@ declare const ListTagsForResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a list of tags associated with the resource. 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>
+ * <p>Returns a list of tags associated with the resource. For usage examples, see the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html">
+ *                <i>Controls Reference Guide</i>
  *             </a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -28,7 +28,10 @@ declare const ResetLandingZoneCommand_base: {
 };
 /**
  * <p>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.</p>
+ *          landing zone to the parameters specified in the original configuration, which you specified
+ *          in the manifest file. Nothing in the manifest file's original landing zone configuration is changed
+ *          during the reset process, by default. This API is not the same as a rollback of a landing
+ *          zone version, which is not a supported operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,8 +27,8 @@ declare const TagResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Applies tags to a resource. 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>
+ * <p>Applies tags to a resource. For usage examples, see the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html">
+ *                <i>Controls Reference Guide</i>
  *             </a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -27,8 +27,8 @@ declare const UntagResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Removes tags from a resource. 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>
+ * <p>Removes tags from a resource. For usage examples, see the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html">
+ *                <i>Controls Reference Guide</i>
  *             </a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -30,11 +30,11 @@ declare const UpdateEnabledControlCommand_base: {
  * <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>
+ *          <p>If the enabled control shows an <code>EnablementStatus</code> of FAILED, Amazon Web Services Control Tower updates 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 the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html">
+ *                <i>Controls Reference Guide</i>
+ *             </a>.
+ *       </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -15,6 +15,7 @@ export * from "./ListBaselinesCommand";
 export * from "./ListControlOperationsCommand";
 export * from "./ListEnabledBaselinesCommand";
 export * from "./ListEnabledControlsCommand";
+export * from "./ListLandingZoneOperationsCommand";
 export * from "./ListLandingZonesCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./ResetEnabledBaselineCommand";

package/dist-types/index.d.ts

@@ -4,23 +4,161 @@
  *             <li>
  *                <p>
  *                   <a href="https://docs.aws.amazon.com/controltower/latest/userguide/controls.html">
- *                      <i>controls</i>
+ *                      <i>Controls</i>
  *                   </a>
  *                </p>
+ *                <ul>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_DisableControl.html">DisableControl</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_EnableControl.html">EnableControl</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetEnabledControl.html">GetEnabledControl</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListControlOperations.html">ListControlOperations</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListEnabledControls.html">ListEnabledControls</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateEnabledControl.html">UpdateEnabledControl</a>
+ *                      </p>
+ *                   </li>
+ *                </ul>
  *             </li>
  *             <li>
  *                <p>
  *                   <a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch.html">
- *                      <i>landing zones</i>
+ *                      <i>Landing zones</i>
  *                   </a>
  *                </p>
+ *                <ul>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_CreateLandingZone.html">CreateLandingZone</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_DeleteLandingZone.html">DeleteLandingZone</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetLandingZone.html">GetLandingZone</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetLandingZoneOperation.html">GetLandingZoneOperation</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListLandingZones.html">ListLandingZones</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ResetLandingZone.html">ResetLandingZone</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateLandingZone.html">UpdateLandingZone</a>
+ *                      </p>
+ *                   </li>
+ *                </ul>
  *             </li>
  *             <li>
  *                <p>
  *                   <a href="https://docs.aws.amazon.com/controltower/latest/userguide/types-of-baselines.html">
- *                      <i>baselines</i>
+ *                      <i>Baselines</i>
  *                   </a>
  *                </p>
+ *                <ul>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_DisableBaseline.html">DisableBaseline</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_EnableBaseline.html">EnableBaseline</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetBaseline.html">GetBaseline</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetBaselineOperation.html">GetBaselineOperation</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetEnabledBaseline.html">GetEnabledBaseline</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListBaselines.html">ListBaselines</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListEnabledBaselines.html">ListEnabledBaselines</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ResetEnabledBaseline.html">ResetEnabledBaseline</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateEnabledBaseline.html">UpdateEnabledBaseline</a>
+ *                      </p>
+ *                   </li>
+ *                </ul>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/tagging.html">Tagging</a>
+ *                </p>
+ *                <ul>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_TagResource.html">TagResource</a>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_UntagResource.html">UntagResource</a>
+ *                      </p>
+ *                   </li>
+ *                </ul>
  *             </li>
  *          </ul>
  *          <p>For more information about these types of resources, see the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/what-is-control-tower.html">
@@ -50,13 +188,12 @@
  *          <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 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> or the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-region-tables.html">Control availability by Region tables</a> in the <i>Amazon Web Services Control Tower User Guide.</i>
- *          </p>
+ *          find the <code>controlIdentifier</code> for each Region and control in the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-metadata-tables.html">Tables of control metadata</a> or the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-region-tables.html">Control availability by Region tables</a> in the <i>Amazon Web Services Control Tower Controls Reference Guide</i>.</p>
  *          <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>Amazon Web Services Control Tower User Guide</i>. Remember that <i>Mandatory</i> controls
- *          cannot be added or removed.</p>
+ *          <i>Elective</i> controls is given in <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html.html">Resource identifiers for
+ *             APIs and controls</a> in the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html">
+ *                <i>Amazon Web Services Control Tower Controls Reference Guide</i>
+ *             </a>. Remember that <i>Mandatory</i> controls cannot be added or removed.</p>
  *          <note>
  *             <p>
  *                <b>ARN format:</b>
@@ -99,7 +236,7 @@
  *          <ul>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">Control API input and output examples with CLI</a>
+ *                   <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html">Control API input and output examples with CLI</a>
  *                </p>
  *             </li>
  *             <li>
@@ -109,7 +246,7 @@
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/controltower/latest/userguide/enable-controls.html">Enable controls with CloudFormation</a>
+ *                   <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/enable-controls.html">Enable controls with CloudFormation</a>
  *                </p>
  *             </li>
  *             <li>
@@ -119,27 +256,27 @@
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html">Control metadata tables (large page)</a>
+ *                   <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-metadata-tables.html">Control metadata tables (large page)</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-region-tables.html">Control availability by Region tables (large page)</a>
+ *                   <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-region-tables.html">Control availability by Region tables (large page)</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html">List of identifiers for legacy controls</a>
+ *                   <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html">List of identifiers for legacy controls</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/controltower/latest/userguide/controls.html">Controls reference guide</a>
+ *                   <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/controls.html">Controls reference guide</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/controltower/latest/userguide/controls-reference.html">Controls library groupings</a>
+ *                   <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/controls-reference.html">Controls library groupings</a>
  *                </p>
  *             </li>
  *             <li>