@aws-sdk/client-controltower 3.454.0 → 3.459.0

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";
@@ -14,7 +15,7 @@ export declare class AccessDeniedException extends __BaseException {
 }
 /**
  * @public
- * <p>Updating or deleting a resource can cause an inconsistent state.</p>
+ * <p>Updating or deleting the resource can cause an inconsistent state.</p>
  */
 export declare class ConflictException extends __BaseException {
     readonly name: "ConflictException";
@@ -32,7 +33,7 @@ export interface DisableControlInput {
      * @public
      * <p>The ARN of the control. Only <b>Strongly recommended</b> and
      *          <b>Elective</b> controls are permitted, with the exception of the
-     *          <b>Region deny</b> control. For information on how to find the <code>controlIdentifier</code>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.</p>
+     *          <b>landing zone Region deny</b> control. For information on how to find the <code>controlIdentifier</code>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.</p>
      */
     controlIdentifier: string | undefined;
     /**
@@ -54,7 +55,7 @@ export interface DisableControlOutput {
 }
 /**
  * @public
- * <p>Unexpected error during processing of request.</p>
+ * <p>An unexpected error occurred during processing of a request.</p>
  */
 export declare class InternalServerException extends __BaseException {
     readonly name: "InternalServerException";
@@ -67,7 +68,7 @@ export declare class InternalServerException extends __BaseException {
 }
 /**
  * @public
- * <p>Request references a resource which does not exist.</p>
+ * <p>The request references a resource that does not exist.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
     readonly name: "ResourceNotFoundException";
@@ -79,7 +80,7 @@ export declare class ResourceNotFoundException extends __BaseException {
 }
 /**
  * @public
- * <p>Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.</p>
+ * <p>The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.</p>
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
     readonly name: "ServiceQuotaExceededException";
@@ -91,7 +92,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
 }
 /**
  * @public
- * <p> Request was denied due to request throttling.</p>
+ * <p>The request was denied due to request throttling.</p>
  */
 export declare class ThrottlingException extends __BaseException {
     readonly name: "ThrottlingException";
@@ -101,7 +102,8 @@ export declare class ThrottlingException extends __BaseException {
     };
     /**
      * @public
-     * <p>The ID of the service that is associated with the error.</p>
+     * <p>The ID of the service that is associated with the error.
+     *       </p>
      */
     serviceCode?: string;
     /**
@@ -111,7 +113,7 @@ export declare class ThrottlingException extends __BaseException {
     quotaCode?: string;
     /**
      * @public
-     * <p>The number of seconds the caller should wait before retrying.</p>
+     * <p>The number of seconds to wait before retrying.</p>
      */
     retryAfterSeconds?: number;
     /**
@@ -121,7 +123,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 does not satisfy the constraints specified by an  Amazon Web Services service.</p>
  */
 export declare class ValidationException extends __BaseException {
     readonly name: "ValidationException";
@@ -131,6 +133,23 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * @public
+ * <p> A set of parameters that configure the behavior of the enabled control. A key/value pair, where <code>Key</code> is of type <code>String</code> and <code>Value</code> is of type <code>Document</code>.</p>
+ */
+export interface EnabledControlParameter {
+    /**
+     * @public
+     * <p>The key of a key/value pair. It is of type <code>string</code>.</p>
+     */
+    key: string | undefined;
+    /**
+     * @public
+     * <p>The value of a key/value pair. It can be of type <code>array</code>
+     *             <code>string</code>, <code>number</code>, <code>object</code>, or <code>boolean</code>. </p>
+     */
+    value: __DocumentType | undefined;
+}
 /**
  * @public
  */
@@ -139,7 +158,7 @@ export interface EnableControlInput {
      * @public
      * <p>The ARN of the control. Only <b>Strongly recommended</b> and
      *          <b>Elective</b> controls are permitted, with the exception of the
-     *          <b>Region deny</b> control. For information on how to find the <code>controlIdentifier</code>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.</p>
+     *          <b>landing zone Region deny</b> control. For information on how to find the <code>controlIdentifier</code>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.</p>
      */
     controlIdentifier: string | undefined;
     /**
@@ -152,6 +171,11 @@ export interface EnableControlInput {
      * <p>Tags to be applied to the <code>EnabledControl</code> resource.</p>
      */
     tags?: Record<string, string>;
+    /**
+     * @public
+     * <p>An array of <code>EnabledControlParameter</code> objects</p>
+     */
+    parameters?: EnabledControlParameter[];
 }
 /**
  * @public
@@ -187,6 +211,7 @@ export interface GetControlOperationInput {
 export declare const ControlOperationType: {
     readonly DISABLE_CONTROL: "DISABLE_CONTROL";
     readonly ENABLE_CONTROL: "ENABLE_CONTROL";
+    readonly UPDATE_ENABLED_CONTROL: "UPDATE_ENABLED_CONTROL";
 };
 /**
  * @public
@@ -273,8 +298,8 @@ export declare const DriftStatus: {
 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>The drift summary of the enabled control.</p>
+ *          <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,27 +312,43 @@ 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
-     *                control. Drift is not supported for the control type.</p>
+     *                   <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
-     *                enabled control. </p>
+     *                   <code>UNKNOWN</code>: Amazon Web Services Control Tower is not able to check the drift status for the
+     *                   enabled control. </p>
      *             </li>
      *          </ul>
      */
     driftStatus?: DriftStatus;
 }
+/**
+ * @public
+ * <p>Returns a summary of information about the parameters of an enabled control.</p>
+ */
+export interface EnabledControlParameterSummary {
+    /**
+     * @public
+     * <p>The key of a key/value pair.</p>
+     */
+    key: string | undefined;
+    /**
+     * @public
+     * <p>The value of a key/value pair.</p>
+     */
+    value: __DocumentType | undefined;
+}
 /**
  * @public
  * @enum
@@ -354,15 +395,15 @@ 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>
+ *             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>
  */
 export interface Region {
     /**
      * @public
-     * <p>The AWS Region name.</p>
+     * <p>The Amazon Web Services Region name.</p>
      */
     name?: string;
 }
@@ -388,7 +429,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[];
     /**
@@ -401,6 +442,11 @@ export interface EnabledControlDetails {
      * <p>The drift status of the enabled control.</p>
      */
     driftStatusSummary?: DriftStatusSummary;
+    /**
+     * @public
+     * <p>Array of <code>EnabledControlParameter</code> objects.</p>
+     */
+    parameters?: EnabledControlParameterSummary[];
 }
 /**
  * @public
@@ -412,6 +458,376 @@ export interface GetEnabledControlOutput {
      */
     enabledControlDetails: EnabledControlDetails | undefined;
 }
+/**
+ * @public
+ */
+export interface CreateLandingZoneInput {
+    /**
+     * @public
+     * <p>The landing zone version, for example, 3.0.</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 resource.</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>&gt;A unique identifier assigned to a <code>DeleteLandingZone</code> operation. You can use this
+     *          identifier as an input parameter 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 <code>manifest.yaml</code> 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>
+     */
+    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>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>Details about a landing zone operation.</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, which is one.</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 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 parameter of <code>GetLandingZoneOperation</code> to check the operation's status.</p>
+     */
+    operationIdentifier: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateLandingZoneInput {
+    /**
+     * @public
+     * <p>The landing zone version, for example, 3.2.</p>
+     */
+    version: string | undefined;
+    /**
+     * @public
+     * <p>The <code>manifest.yaml</code> 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
  */
@@ -449,9 +865,7 @@ export interface EnabledControlSummary {
     arn?: string;
     /**
      * @public
-     * <p>
-     *          The ARN of the organizational unit.
-     *       </p>
+     * <p>The ARN of the organizational unit.</p>
      */
     targetIdentifier?: string;
     /**
@@ -471,13 +885,13 @@ 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;
     /**
      * @public
-     * <p>Retrieves the next page of results. If the string is empty, the current response is the
+     * <p>Retrieves the next page of results. If the string is empty, the response is the
      *          end of the results.</p>
      */
     nextToken?: string;
@@ -542,3 +956,32 @@ export interface UntagResourceInput {
  */
 export interface UntagResourceOutput {
 }
+/**
+ * @public
+ */
+export interface UpdateEnabledControlInput {
+    /**
+     * @public
+     * <p>A key/value pair, where <code>Key</code> is of type <code>String</code> and <code>Value</code> is of type <code>Document</code>.</p>
+     */
+    parameters: EnabledControlParameter[] | undefined;
+    /**
+     * @public
+     * <p>
+     *          The ARN of the enabled control that will be updated.
+     *       </p>
+     */
+    enabledControlIdentifier: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateEnabledControlOutput {
+    /**
+     * @public
+     * <p>
+     *          The operation identifier for this <code>UpdateEnabledControl</code> operation.
+     *       </p>
+     */
+    operationIdentifier: string | 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";