@aws-sdk/client-controltower 3.451.0 → 3.458.0

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>
@@ -19,13 +19,13 @@
  *          </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

package/dist-types/models/models_0.d.ts

@@ -1,8 +1,9 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { DocumentType as __DocumentType } from "@smithy/types";
 import { ControlTowerServiceException as __BaseException } from "./ControlTowerServiceException";
 /**
  * @public
- * <p>User does not have sufficient access to perform this action.</p>
+ * <p>You do not have sufficient access to perform this action.</p>
  */
 export declare class AccessDeniedException extends __BaseException {
     readonly name: "AccessDeniedException";
@@ -91,7 +92,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
 }
 /**
  * @public
- * <p> Request was denied due to request throttling.</p>
+ * <p>Request was denied due to request throttling.</p>
  */
 export declare class ThrottlingException extends __BaseException {
     readonly name: "ThrottlingException";
@@ -121,7 +122,7 @@ export declare class ThrottlingException extends __BaseException {
 }
 /**
  * @public
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
  */
 export declare class ValidationException extends __BaseException {
     readonly name: "ValidationException";
@@ -274,7 +275,7 @@ export type DriftStatus = (typeof DriftStatus)[keyof typeof DriftStatus];
 /**
  * @public
  * <p> The drift summary of the enabled control.</p>
- *          <p>AWS Control Tower expects the enabled control
+ *          <p>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.</p>
  */
@@ -287,21 +288,21 @@ export interface DriftStatusSummary {
      *             <li>
      *                <p>
      *                   <code>DRIFTED</code>: The <code>enabledControl</code> deployed in this configuration
-     *                doesn’t match the configuration that AWS Control Tower expected. </p>
+     *                doesn’t match the configuration that Amazon Web Services Control Tower expected. </p>
      *             </li>
      *             <li>
      *                <p>
      *                   <code>IN_SYNC</code>: The <code>enabledControl</code> deployed in this configuration matches
-     *                the configuration that AWS Control Tower expected.</p>
+     *                the configuration that Amazon Web Services Control Tower expected.</p>
      *             </li>
      *             <li>
      *                <p>
-     *                   <code>NOT_CHECKING</code>: AWS Control Tower does not check drift for this enabled
+     *                   <code>NOT_CHECKING</code>: Amazon Web Services Control Tower does not check drift for this enabled
      *                control. Drift is not supported for the control type.</p>
      *             </li>
      *             <li>
      *                <p>
-     *                   <code>UNKNOWN</code>: AWS Control Tower is not able to check the drift status for the
+     *                   <code>UNKNOWN</code>: Amazon Web Services Control Tower is not able to check the drift status for the
      *                enabled control. </p>
      *             </li>
      *          </ul>
@@ -354,7 +355,7 @@ export interface EnablementStatusSummary {
 }
 /**
  * @public
- * <p>An AWS Region in which AWS Control Tower expects to find the control deployed. </p>
+ * <p>An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed. </p>
  *          <p>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 <a href="https://docs.aws.amazon.com/controltower/latest/userguide/region-how.html#mixed-governance">mixed governance</a>.</p>
@@ -362,7 +363,7 @@ export interface EnablementStatusSummary {
 export interface Region {
     /**
      * @public
-     * <p>The AWS Region name.</p>
+     * <p>The Amazon Web Services Region name.</p>
      */
     name?: string;
 }
@@ -388,7 +389,7 @@ export interface EnabledControlDetails {
     targetIdentifier?: string;
     /**
      * @public
-     * <p>Target AWS Regions for the enabled control.</p>
+     * <p>Target Amazon Web Services Regions for the enabled control.</p>
      */
     targetRegions?: Region[];
     /**
@@ -412,6 +413,393 @@ export interface GetEnabledControlOutput {
      */
     enabledControlDetails: EnabledControlDetails | undefined;
 }
+/**
+ * @public
+ */
+export interface CreateLandingZoneInput {
+    /**
+     * @public
+     * <p>The landing zone version. </p>
+     */
+    version: string | undefined;
+    /**
+     * @public
+     * <p>The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review
+     *          <a href="https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file">The manifest file</a>. </p>
+     */
+    manifest: __DocumentType | undefined;
+    /**
+     * @public
+     * <p>Tags to be applied to the landing zone. </p>
+     */
+    tags?: Record<string, string>;
+}
+/**
+ * @public
+ */
+export interface CreateLandingZoneOutput {
+    /**
+     * @public
+     * <p>The ARN of the landing zone. </p>
+     */
+    arn: string | undefined;
+    /**
+     * @public
+     * <p>A unique identifier assigned to a <code>CreateLandingZone</code> operation. You can use this
+     *       identifier as an input of <code>GetLandingZoneOperation</code> to check the operation's status. </p>
+     */
+    operationIdentifier: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteLandingZoneInput {
+    /**
+     * @public
+     * <p>The unique identifier of the landing zone. </p>
+     */
+    landingZoneIdentifier: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteLandingZoneOutput {
+    /**
+     * @public
+     * <p>A unique identifier assigned to a <code>DeleteLandingZone</code> operation. You can use this
+     *          identifier as an input of <code>GetLandingZoneOperation</code> to check the operation's status. </p>
+     */
+    operationIdentifier: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetLandingZoneInput {
+    /**
+     * @public
+     * <p>The unique identifier of the landing zone. </p>
+     */
+    landingZoneIdentifier: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const LandingZoneDriftStatus: {
+    readonly DRIFTED: "DRIFTED";
+    readonly IN_SYNC: "IN_SYNC";
+};
+/**
+ * @public
+ */
+export type LandingZoneDriftStatus = (typeof LandingZoneDriftStatus)[keyof typeof LandingZoneDriftStatus];
+/**
+ * @public
+ * <p>The drift status summary of the landing zone. </p>
+ *          <p>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. </p>
+ */
+export interface LandingZoneDriftStatusSummary {
+    /**
+     * @public
+     * <p>The drift status of the landing zone. </p>
+     *          <p>Valid values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>DRIFTED</code>: The landing zone deployed in this configuration does not match the
+     *                   configuration that Amazon Web Services Control Tower expected. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>IN_SYNC</code>: The landing zone deployed in this configuration matches the
+     *                   configuration that Amazon Web Services Control Tower expected. </p>
+     *             </li>
+     *          </ul>
+     */
+    status?: LandingZoneDriftStatus;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const LandingZoneStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly FAILED: "FAILED";
+    readonly PROCESSING: "PROCESSING";
+};
+/**
+ * @public
+ */
+export type LandingZoneStatus = (typeof LandingZoneStatus)[keyof typeof LandingZoneStatus];
+/**
+ * @public
+ * <p>Information about the landing zone. </p>
+ */
+export interface LandingZoneDetail {
+    /**
+     * @public
+     * <p>The landing zone's current deployed version. </p>
+     */
+    version: string | undefined;
+    /**
+     * @public
+     * <p>The landing zone manifest.yaml text file that specifies the landing zone configurations. </p>
+     */
+    manifest: __DocumentType | undefined;
+    /**
+     * @public
+     * <p>The ARN of the landing zone. </p>
+     */
+    arn?: string;
+    /**
+     * @public
+     * <p>The landing zone deployment status. </p>
+     *          <p>Valid values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>ACTIVE</code>: The landing zone is actively deployed.  </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>PROCESSING</code>: The landing zone is processing deployment. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>FAILED</code>: The landing zone failed deployment. </p>
+     *             </li>
+     *          </ul>
+     */
+    status?: LandingZoneStatus;
+    /**
+     * @public
+     * <p>The latest available version of the landing zone. </p>
+     */
+    latestAvailableVersion?: string;
+    /**
+     * @public
+     * <p>The drift status of the landing zone. </p>
+     */
+    driftStatus?: LandingZoneDriftStatusSummary;
+}
+/**
+ * @public
+ */
+export interface GetLandingZoneOutput {
+    /**
+     * @public
+     * <p>Information about the landing zone. </p>
+     */
+    landingZone: LandingZoneDetail | undefined;
+}
+/**
+ * @public
+ */
+export interface GetLandingZoneOperationInput {
+    /**
+     * @public
+     * <p>A unique identifier assigned to a landing zone operation. </p>
+     */
+    operationIdentifier: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const LandingZoneOperationType: {
+    readonly CREATE: "CREATE";
+    readonly DELETE: "DELETE";
+    readonly RESET: "RESET";
+    readonly UPDATE: "UPDATE";
+};
+/**
+ * @public
+ */
+export type LandingZoneOperationType = (typeof LandingZoneOperationType)[keyof typeof LandingZoneOperationType];
+/**
+ * @public
+ * @enum
+ */
+export declare const LandingZoneOperationStatus: {
+    readonly FAILED: "FAILED";
+    readonly IN_PROGRESS: "IN_PROGRESS";
+    readonly SUCCEEDED: "SUCCEEDED";
+};
+/**
+ * @public
+ */
+export type LandingZoneOperationStatus = (typeof LandingZoneOperationStatus)[keyof typeof LandingZoneOperationStatus];
+/**
+ * @public
+ * <p>Information about a landing zone operation. </p>
+ */
+export interface LandingZoneOperationDetail {
+    /**
+     * @public
+     * <p>The landing zone operation type. </p>
+     *          <p>Valid values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>DELETE</code>: The <code>DeleteLandingZone</code> operation.  </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>CREATE</code>: The <code>CreateLandingZone</code> operation. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>UPDATE</code>: The <code>UpdateLandingZone</code> operation. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>RESET</code>: The <code>ResetLandingZone</code> operation. </p>
+     *             </li>
+     *          </ul>
+     */
+    operationType?: LandingZoneOperationType;
+    /**
+     * @public
+     * <p>The landing zone operation start time. </p>
+     */
+    startTime?: Date;
+    /**
+     * @public
+     * <p>The landing zone operation end time. </p>
+     */
+    endTime?: Date;
+    /**
+     * @public
+     * <p>The landing zone operation status. </p>
+     *          <p>Valid values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>SUCCEEDED</code>: The landing zone operation succeeded.  </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>IN_PROGRESS</code>: The landing zone operation is in progress. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>FAILED</code>: The landing zone operation failed. </p>
+     *             </li>
+     *          </ul>
+     */
+    status?: LandingZoneOperationStatus;
+    /**
+     * @public
+     * <p>If the operation result is FAILED, this string contains a message explaining why the operation failed. </p>
+     */
+    statusMessage?: string;
+}
+/**
+ * @public
+ */
+export interface GetLandingZoneOperationOutput {
+    /**
+     * @public
+     * <p>The landing zone operation details. </p>
+     */
+    operationDetails: LandingZoneOperationDetail | undefined;
+}
+/**
+ * @public
+ */
+export interface ListLandingZonesInput {
+    /**
+     * @public
+     * <p>The token to continue the list from a previous API call with the same parameters. </p>
+     */
+    nextToken?: string;
+    /**
+     * @public
+     * <p>The maximum number of returned landing zone ARNs. </p>
+     */
+    maxResults?: number;
+}
+/**
+ * @public
+ * <p>Returns a summary of information about a landing zone. </p>
+ */
+export interface LandingZoneSummary {
+    /**
+     * @public
+     * <p>The ARN of the landing zone. </p>
+     */
+    arn?: string;
+}
+/**
+ * @public
+ */
+export interface ListLandingZonesOutput {
+    /**
+     * @public
+     * <p>The ARN of the landing zone. </p>
+     */
+    landingZones: LandingZoneSummary[] | undefined;
+    /**
+     * @public
+     * <p>Retrieves the next page of results. If the string is empty, the current response is the end of the results. </p>
+     */
+    nextToken?: string;
+}
+/**
+ * @public
+ */
+export interface ResetLandingZoneInput {
+    /**
+     * @public
+     * <p>The unique identifier of the landing zone. </p>
+     */
+    landingZoneIdentifier: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ResetLandingZoneOutput {
+    /**
+     * @public
+     * <p>A unique identifier assigned to a <code>ResetLandingZone</code> operation. You can use this
+     *          identifier as an input of <code>GetLandingZoneOperation</code> to check the operation's status.</p>
+     */
+    operationIdentifier: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateLandingZoneInput {
+    /**
+     * @public
+     * <p>The landing zone version. </p>
+     */
+    version: string | undefined;
+    /**
+     * @public
+     * <p>The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review
+     *          <a href="https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file">The manifest file</a>
+     *          </p>
+     */
+    manifest: __DocumentType | undefined;
+    /**
+     * @public
+     * <p>The unique identifier of the landing zone. </p>
+     */
+    landingZoneIdentifier: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateLandingZoneOutput {
+    /**
+     * @public
+     * <p>A unique identifier assigned to a <code>UpdateLandingZone</code> operation. You can use this
+     *          identifier as an input of <code>GetLandingZoneOperation</code> to check the operation's status.</p>
+     */
+    operationIdentifier: string | undefined;
+}
 /**
  * @public
  */
@@ -471,7 +859,7 @@ export interface EnabledControlSummary {
 export interface ListEnabledControlsOutput {
     /**
      * @public
-     * <p>Lists the controls enabled by AWS Control Tower on the specified organizational unit and
+     * <p>Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and
      *          the accounts it contains.</p>
      */
     enabledControls: EnabledControlSummary[] | undefined;

package/dist-types/pagination/ListLandingZonesPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListLandingZonesCommandInput, ListLandingZonesCommandOutput } from "../commands/ListLandingZonesCommand";
+import { ControlTowerPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare function paginateListLandingZones(config: ControlTowerPaginationConfiguration, input: ListLandingZonesCommandInput, ...additionalArguments: any): Paginator<ListLandingZonesCommandOutput>;

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

@@ -1,2 +1,3 @@
 export * from "./Interfaces";
 export * from "./ListEnabledControlsPaginator";
+export * from "./ListLandingZonesPaginator";