feat(client-connect): Release ReplicaConfiguration as part of Describ…

…eInstance
aws · Sep 3, 2024 · 3ac8b18 · 3ac8b18
1 parent b54802e
commit 3ac8b18
Show file tree

Hide file tree

Showing 7 changed files with 377 additions and 135 deletions.
diff --git a/clients/client-connect/src/commands/DescribeInstanceCommand.ts b/clients/client-connect/src/commands/DescribeInstanceCommand.ts
@@ -68,6 +68,17 @@ export interface DescribeInstanceCommandOutput extends DescribeInstanceResponse,
  * //       "<keys>": "STRING_VALUE",
  * //     },
  * //   },
+ * //   ReplicationConfiguration: { // ReplicationConfiguration
+ * //     ReplicationStatusSummaryList: [ // ReplicationStatusSummaryList
+ * //       { // ReplicationStatusSummary
+ * //         Region: "STRING_VALUE",
+ * //         ReplicationStatus: "INSTANCE_REPLICATION_COMPLETE" || "INSTANCE_REPLICATION_IN_PROGRESS" || "INSTANCE_REPLICATION_FAILED" || "INSTANCE_REPLICA_DELETING" || "INSTANCE_REPLICATION_DELETION_FAILED" || "RESOURCE_REPLICATION_NOT_STARTED",
+ * //         ReplicationStatusReason: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     SourceRegion: "STRING_VALUE",
+ * //     GlobalSignInEndpoint: "STRING_VALUE",
+ * //   },
  * // };
  *
  * ```

diff --git a/clients/client-connect/src/commands/ListTaskTemplatesCommand.ts b/clients/client-connect/src/commands/ListTaskTemplatesCommand.ts
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
 import { commonParams } from "../endpoint/EndpointParameters";
-import { ListTaskTemplatesRequest, ListTaskTemplatesResponse } from "../models/models_1";
+import { ListTaskTemplatesRequest, ListTaskTemplatesResponse } from "../models/models_2";
 import { de_ListTaskTemplatesCommand, se_ListTaskTemplatesCommand } from "../protocols/Aws_restJson1";
 
 /**

diff --git a/clients/client-connect/src/models/models_0.ts b/clients/client-connect/src/models/models_0.ts
@@ -1739,7 +1739,7 @@ export interface AssociateSecurityKeyRequest {
   InstanceId: string | undefined;
 
   /**
-   * <p>A valid security key in PEM format.</p>
+   * <p>A valid security key in PEM format as a String.</p>
    * @public
    */
   Key: string | undefined;

diff --git a/clients/client-connect/src/models/models_1.ts b/clients/client-connect/src/models/models_1.ts
@@ -842,6 +842,90 @@ export interface Instance {
   Tags?: Record<string, string>;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const InstanceReplicationStatus = {
+  INSTANCE_REPLICATION_COMPLETE: "INSTANCE_REPLICATION_COMPLETE",
+  INSTANCE_REPLICATION_DELETION_FAILED: "INSTANCE_REPLICATION_DELETION_FAILED",
+  INSTANCE_REPLICATION_FAILED: "INSTANCE_REPLICATION_FAILED",
+  INSTANCE_REPLICATION_IN_PROGRESS: "INSTANCE_REPLICATION_IN_PROGRESS",
+  INSTANCE_REPLICA_DELETING: "INSTANCE_REPLICA_DELETING",
+  RESOURCE_REPLICATION_NOT_STARTED: "RESOURCE_REPLICATION_NOT_STARTED",
+} as const;
+
+/**
+ * @public
+ */
+export type InstanceReplicationStatus = (typeof InstanceReplicationStatus)[keyof typeof InstanceReplicationStatus];
+
+/**
+ * <p>Status information about the replication process, where you use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ReplicateInstance.html">ReplicateInstance</a> API to create a replica of your Amazon Connect instance in
+ *    another Amazon Web Services Region. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html">Set up Amazon Connect
+ *     Global Resiliency</a> in the <i>Amazon Connect Administrator Guide</i>.
+ *   </p>
+ * @public
+ */
+export interface ReplicationStatusSummary {
+  /**
+   * <p>The Amazon Web Services Region. This can be either the source or the replica Region,
+   *    depending where it appears in the summary list.</p>
+   * @public
+   */
+  Region?: string;
+
+  /**
+   * <p>The state of the replication.</p>
+   * @public
+   */
+  ReplicationStatus?: InstanceReplicationStatus;
+
+  /**
+   * <p>A description of the replication status. Use this information to resolve any issues that are
+   *    preventing the successful replication of your Amazon Connect instance to another
+   *    Region.</p>
+   * @public
+   */
+  ReplicationStatusReason?: string;
+}
+
+/**
+ * <p>Details about the status of the replication of a source Amazon Connect instance across
+ *     Amazon Web Services Regions. Use these details to understand the general status of a given
+ *    replication. For information about why a replication process may fail, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html#why-replicateinstance-fails">Why a ReplicateInstance call fails</a> in the <i>Create a replica of your existing
+ *      Amazon Connect instance</i> topic in the <i>Amazon Connect Administrator
+ *     Guide</i>. </p>
+ * @public
+ */
+export interface ReplicationConfiguration {
+  /**
+   * <p>A list of replication status summaries. The summaries contain details about the replication
+   *    of configuration information for Amazon Connect resources, for each Amazon Web Services
+   *    Region.</p>
+   * @public
+   */
+  ReplicationStatusSummaryList?: ReplicationStatusSummary[];
+
+  /**
+   * <p>The Amazon Web Services Region where the source Amazon Connect instance was created. This
+   *    is the Region where the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ReplicateInstance.html">ReplicateInstance</a> API was
+   *    called to start the replication process.</p>
+   * @public
+   */
+  SourceRegion?: string;
+
+  /**
+   * <p>The URL that is used to sign-in to your Amazon Connect instance according to your
+   *    traffic distribution group configuration. For more information about sign-in and traffic
+   *    distribution groups, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-traffic-distribution-groups.html">Important things to
+   *     know</a> in the <i>Create traffic distribution groups</i> topic in the
+   *      <i>Amazon Connect Administrator Guide</i>. </p>
+   * @public
+   */
+  GlobalSignInEndpoint?: string;
+}
+
 /**
  * @public
  */
@@ -851,6 +935,17 @@ export interface DescribeInstanceResponse {
    * @public
    */
   Instance?: Instance;
+
+  /**
+   * <p>Status information about the replication process. This field is included only when you are
+   *    using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ReplicateInstance.html">ReplicateInstance</a> API to
+   *    replicate an Amazon Connect instance across Amazon Web Services Regions. For information about
+   *    replicating Amazon Connect instances, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html">Create a replica of your
+   *     existing Amazon Connect instance</a> in the <i>Amazon Connect Administrator
+   *     Guide</i>.</p>
+   * @public
+   */
+  ReplicationConfiguration?: ReplicationConfiguration;
 }
 
 /**
@@ -5544,7 +5639,7 @@ export interface GetMetricDataV2Request {
    *        metric.</p>
    *                </note>
    *             </dd>
-   *             <dt>SUM_CONTACTS_ABANDONED</dt>
+   *             <dt>CONTACTS_ABANDONED</dt>
    *             <dd>
    *                <p>Unit: Count</p>
    *                <p>Metric filter: </p>
@@ -9771,121 +9866,6 @@ export interface ListTagsForResourceResponse {
   tags?: Record<string, string>;
 }
 
-/**
- * @public
- */
-export interface ListTaskTemplatesRequest {
-  /**
-   * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
-   * @public
-   */
-  InstanceId: string | undefined;
-
-  /**
-   * <p>The token for the next set of results. Use the value returned in the previous
-   * response in the next request to retrieve the next set of results.</p>
-   *          <important>
-   *             <p>It is not expected that you set this because the value returned in the previous response is
-   *     always null.</p>
-   *          </important>
-   * @public
-   */
-  NextToken?: string;
-
-  /**
-   * <p>The maximum number of results to return per page.</p>
-   *          <important>
-   *             <p>It is not expected that you set this.</p>
-   *          </important>
-   * @public
-   */
-  MaxResults?: number;
-
-  /**
-   * <p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it.
-   * Tasks can only be created from <code>ACTIVE</code> templates.
-   * If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>
-   * @public
-   */
-  Status?: TaskTemplateStatus;
-
-  /**
-   * <p>The name of the task template.</p>
-   * @public
-   */
-  Name?: string;
-}
-
-/**
- * <p>Contains summary information about the task template.</p>
- * @public
- */
-export interface TaskTemplateMetadata {
-  /**
-   * <p>A unique identifier for the task template.</p>
-   * @public
-   */
-  Id?: string;
-
-  /**
-   * <p>The Amazon Resource Name (ARN) of the task template.</p>
-   * @public
-   */
-  Arn?: string;
-
-  /**
-   * <p>The name of the task template.</p>
-   * @public
-   */
-  Name?: string;
-
-  /**
-   * <p>The description of the task template.</p>
-   * @public
-   */
-  Description?: string;
-
-  /**
-   * <p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it.
-   * Tasks can only be created from <code>ACTIVE</code> templates.
-   * If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>
-   * @public
-   */
-  Status?: TaskTemplateStatus;
-
-  /**
-   * <p>The timestamp when the task template was last modified.</p>
-   * @public
-   */
-  LastModifiedTime?: Date;
-
-  /**
-   * <p>The timestamp when the task template was created.</p>
-   * @public
-   */
-  CreatedTime?: Date;
-}
-
-/**
- * @public
- */
-export interface ListTaskTemplatesResponse {
-  /**
-   * <p>Provides details about a list of task templates belonging to an instance.</p>
-   * @public
-   */
-  TaskTemplates?: TaskTemplateMetadata[];
-
-  /**
-   * <p>If there are additional results, this is the token for the next set of results.</p>
-   *          <important>
-   *             <p>This is always returned as a null in the response.</p>
-   *          </important>
-   * @public
-   */
-  NextToken?: string;
-}
-
 /**
  * @internal
  */