@aws-sdk/client-connect 3.606.0 → 3.608.0

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

@@ -1,6 +1,139 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
-import { ActionSummary, AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, Application, Channel, ContactFlowStatus, ContactFlowType, ContactState, CreatedByInfo, DirectoryType, Distribution, EvaluationScore, EvaluationStatus, EventSourceName, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowAssociationSummary, HoursOfOperationConfig, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, OutboundCallerConfig, ParticipantRole, PredefinedAttributeValues, QueueReference, QuickConnectConfig, QuickConnectType, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UseCaseType, UserIdentityInfo, UserPhoneConfig, UserProficiency, View, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
+import { ActionSummary, AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, Application, Channel, ContactFlowStatus, ContactFlowType, ContactState, CreatedByInfo, DirectoryType, Distribution, EvaluationAnswerOutput, EventSourceName, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowAssociationSummary, HoursOfOperationConfig, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, OutboundCallerConfig, ParticipantRole, PredefinedAttributeValues, QueueReference, QuickConnectConfig, QuickConnectType, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UseCaseType, UserIdentityInfo, UserPhoneConfig, View, VocabularyLanguageCode, VocabularyState } from "./models_0";
+/**
+ * <p>Information about scores of a contact evaluation item (section or question).</p>
+ * @public
+ */
+export interface EvaluationScore {
+    /**
+     * <p>The score percentage for an item in a contact evaluation.</p>
+     * @public
+     */
+    Percentage?: number;
+    /**
+     * <p>The flag to mark the item as not applicable for scoring.</p>
+     * @public
+     */
+    NotApplicable?: boolean;
+    /**
+     * <p>The flag that marks the item as automatic fail. If the item or a child item gets an
+     *    automatic fail answer, this flag will be true.</p>
+     * @public
+     */
+    AutomaticFail?: boolean;
+}
+/**
+ * <p>Metadata information about a contact evaluation.</p>
+ * @public
+ */
+export interface EvaluationMetadata {
+    /**
+     * <p>The identifier of the contact in this instance of Amazon Connect. </p>
+     * @public
+     */
+    ContactId: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation.</p>
+     * @public
+     */
+    EvaluatorArn: string | undefined;
+    /**
+     * <p>The identifier of the agent who performed the contact.</p>
+     * @public
+     */
+    ContactAgentId?: string;
+    /**
+     * <p>The overall score of the contact evaluation.</p>
+     * @public
+     */
+    Score?: EvaluationScore;
+}
+/**
+ * <p>Information about notes for a contact evaluation.</p>
+ * @public
+ */
+export interface EvaluationNote {
+    /**
+     * <p>The note for an item (section or question) in a contact evaluation.</p>
+     *          <note>
+     *             <p>Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the
+     *     total number of chars for all the notes in the evaluation combined. Assuming there are N
+     *     questions in the evaluation being submitted, then the max char limit for all notes combined is N
+     *     x 1024.</p>
+     *          </note>
+     * @public
+     */
+    Value?: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const EvaluationStatus: {
+    readonly DRAFT: "DRAFT";
+    readonly SUBMITTED: "SUBMITTED";
+};
+/**
+ * @public
+ */
+export type EvaluationStatus = (typeof EvaluationStatus)[keyof typeof EvaluationStatus];
+/**
+ * <p>Information about a contact evaluation.</p>
+ * @public
+ */
+export interface Evaluation {
+    /**
+     * <p>A unique identifier for the contact evaluation.</p>
+     * @public
+     */
+    EvaluationId: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
+     * @public
+     */
+    EvaluationArn: string | undefined;
+    /**
+     * <p>Metadata about the contact evaluation.</p>
+     * @public
+     */
+    Metadata: EvaluationMetadata | undefined;
+    /**
+     * <p>A map of question identifiers to answer value.</p>
+     * @public
+     */
+    Answers: Record<string, EvaluationAnswerOutput> | undefined;
+    /**
+     * <p>A map of question identifiers to note value.</p>
+     * @public
+     */
+    Notes: Record<string, EvaluationNote> | undefined;
+    /**
+     * <p>The status of the contact evaluation.</p>
+     * @public
+     */
+    Status: EvaluationStatus | undefined;
+    /**
+     * <p>A map of item (section or question) identifiers to score value.</p>
+     * @public
+     */
+    Scores?: Record<string, EvaluationScore>;
+    /**
+     * <p>The timestamp for when the evaluation was created.</p>
+     * @public
+     */
+    CreatedTime: Date | undefined;
+    /**
+     * <p>The timestamp for when the evaluation was last updated.</p>
+     * @public
+     */
+    LastModifiedTime: Date | undefined;
+    /**
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * @public
+     */
+    Tags?: Record<string, string>;
+}
 /**
  * <p>The flow has not been published.</p>
  * @public
@@ -4295,45 +4428,6 @@ export interface GetMetricDataV2Request {
      *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html##cases-created-historical">Cases created</a>
      *                </p>
      *             </dd>
-     *             <dt>CONTACTS_ABANDONED</dt>
-     *             <dd>
-     *                <p>Unit: Count</p>
-     *                <p>Metric filter: </p>
-     *                <ul>
-     *                   <li>
-     *                      <p>Valid values: <code>API</code>| <code>Incoming</code> | <code>Outbound</code> |
-     *          <code>Transfer</code> | <code>Callback</code> | <code>Queue_Transfer</code>|
-     *          <code>Disconnect</code>
-     *                      </p>
-     *                   </li>
-     *                </ul>
-     *                <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
-     *       contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect</p>
-     *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical">Contact abandoned</a>
-     *                </p>
-     *             </dd>
-     *             <dt>CONTACTS_ABANDONED_IN_X</dt>
-     *             <dd>
-     *                <p>Unit: Count</p>
-     *                <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
-     *       Q in Connect</p>
-     *                <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
-     *       (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
-     *       "Less than"). </p>
-     *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical">Contacts abandoned in X seconds</a>
-     *                </p>
-     *             </dd>
-     *             <dt>CONTACTS_ANSWERED_IN_X</dt>
-     *             <dd>
-     *                <p>Unit: Count</p>
-     *                <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
-     *       Q in Connect</p>
-     *                <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
-     *       (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
-     *       "Less than"). </p>
-     *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical">Contacts answered in X seconds</a>
-     *                </p>
-     *             </dd>
      *             <dt>CONTACTS_CREATED</dt>
      *             <dd>
      *                <p>Unit: Count</p>
@@ -4430,6 +4524,15 @@ export interface GetMetricDataV2Request {
      *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-by-enqueue-historical">Contacts queued (enqueue timestamp)</a>
      *                </p>
      *             </dd>
+     *             <dt>CONTACTS_REMOVED_FROM_QUEUE_IN_X</dt>
+     *             <dd>
+     *                <p>Unit: Count</p>
+     *                <p>Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect</p>
+     *                <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
+     *       (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
+     *       "Less than").</p>
+     *                <p>UI name: This metric is not available in Amazon Connect admin website. </p>
+     *             </dd>
      *             <dt>CONTACTS_RESOLVED_IN_X</dt>
      *             <dd>
      *                <p>Unit: Count</p>
@@ -4531,13 +4634,15 @@ export interface GetMetricDataV2Request {
      *             <dd>
      *                <p>Unit: Percent</p>
      *                <p>Valid groupings and filters: Queue, RoutingStepExpression</p>
-     *                <p>UI name: Not available </p>
+     *                <p>UI name: This metric is available in Real-time Metrics UI but not on the Historical
+     *       Metrics UI.</p>
      *             </dd>
      *             <dt>PERCENT_CONTACTS_STEP_JOINED</dt>
      *             <dd>
      *                <p>Unit: Percent</p>
      *                <p>Valid groupings and filters: Queue, RoutingStepExpression</p>
-     *                <p>UI name: Not available </p>
+     *                <p>UI name: This metric is available in Real-time Metrics UI but not on the Historical
+     *       Metrics UI.</p>
      *             </dd>
      *             <dt>PERCENT_FLOWS_OUTCOME</dt>
      *             <dd>
@@ -4608,7 +4713,7 @@ export interface GetMetricDataV2Request {
      *                <p>Unit: Count</p>
      *                <p>Required filter key: CASE_TEMPLATE_ARN</p>
      *                <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p>
-     *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-historicall">Cases resolved</a>
+     *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-historical">Cases resolved</a>
      *                </p>
      *             </dd>
      *             <dt>SERVICE_LEVEL</dt>
@@ -4626,7 +4731,8 @@ export interface GetMetricDataV2Request {
      *             <dd>
      *                <p>Unit: Count</p>
      *                <p>Valid groupings and filters: Queue, RoutingStepExpression</p>
-     *                <p>UI name: Not available</p>
+     *                <p>UI name: This metric is available in Real-time Metrics UI but not on the Historical
+     *       Metrics UI.</p>
      *             </dd>
      *             <dt>SUM_AFTER_CONTACT_WORK_TIME</dt>
      *             <dd>
@@ -4651,6 +4757,45 @@ export interface GetMetricDataV2Request {
      *        metric.</p>
      *                </note>
      *             </dd>
+     *             <dt>SUM_CONTACTS_ABANDONED</dt>
+     *             <dd>
+     *                <p>Unit: Count</p>
+     *                <p>Metric filter: </p>
+     *                <ul>
+     *                   <li>
+     *                      <p>Valid values: <code>API</code>| <code>Incoming</code> | <code>Outbound</code> |
+     *          <code>Transfer</code> | <code>Callback</code> | <code>Queue_Transfer</code>|
+     *          <code>Disconnect</code>
+     *                      </p>
+     *                   </li>
+     *                </ul>
+     *                <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
+     *       contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect</p>
+     *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical">Contact abandoned</a>
+     *                </p>
+     *             </dd>
+     *             <dt>SUM_CONTACTS_ABANDONED_IN_X</dt>
+     *             <dd>
+     *                <p>Unit: Count</p>
+     *                <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
+     *       Q in Connect</p>
+     *                <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
+     *       (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
+     *       "Less than"). </p>
+     *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical">Contacts abandoned in X seconds</a>
+     *                </p>
+     *             </dd>
+     *             <dt>SUM_CONTACTS_ANSWERED_IN_X</dt>
+     *             <dd>
+     *                <p>Unit: Count</p>
+     *                <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
+     *       Q in Connect</p>
+     *                <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
+     *       (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
+     *       "Less than"). </p>
+     *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical">Contacts answered in X seconds</a>
+     *                </p>
+     *             </dd>
      *             <dt>SUM_CONTACT_FLOW_TIME</dt>
      *             <dd>
      *                <p>Unit: Seconds</p>
@@ -4661,7 +4806,7 @@ export interface GetMetricDataV2Request {
      *             <dt>SUM_CONTACT_TIME_AGENT</dt>
      *             <dd>
      *                <p>Unit: Seconds</p>
-     *                <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
+     *                <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p>
      *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-on-contact-time-historical">Agent on contact time</a>
      *                </p>
      *             </dd>
@@ -4678,7 +4823,7 @@ export interface GetMetricDataV2Request {
      *             <dt>SUM_ERROR_STATUS_TIME_AGENT</dt>
      *             <dd>
      *                <p>Unit: Seconds</p>
-     *                <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
+     *                <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p>
      *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#error-status-time-historical">Error status time</a>
      *                </p>
      *             </dd>
@@ -5216,6 +5361,83 @@ export interface ListApprovedOriginsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
+export interface ListAuthenticationProfilesRequest {
+    /**
+     * <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 maximum number of results to return per page.</p>
+     * @public
+     */
+    MaxResults?: number;
+    /**
+     * <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>
+     * @public
+     */
+    NextToken?: string;
+}
+/**
+ * <p>This API is in preview release for Amazon Connect and is subject to change. To
+ * request access to this API, contact Amazon Web Services Support.</p>
+ *          <p>A summary of a given authentication profile.</p>
+ * @public
+ */
+export interface AuthenticationProfileSummary {
+    /**
+     * <p>The unique identifier of the authentication profile.</p>
+     * @public
+     */
+    Id?: string;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the authentication profile summary.</p>
+     * @public
+     */
+    Arn?: string;
+    /**
+     * <p>The name of the authentication profile summary.</p>
+     * @public
+     */
+    Name?: string;
+    /**
+     * <p>Shows whether the authentication profile is the default authentication profile for the
+     *     Amazon Connect instance. The default authentication profile applies to all agents in an
+     *     Amazon Connect instance, unless overridden by another authentication profile.</p>
+     * @public
+     */
+    IsDefault?: boolean;
+    /**
+     * <p>The timestamp when the authentication profile summary was last modified.</p>
+     * @public
+     */
+    LastModifiedTime?: Date;
+    /**
+     * <p>The Amazon Web Services Region when the authentication profile summary was last
+     *    modified.</p>
+     * @public
+     */
+    LastModifiedRegion?: string;
+}
+/**
+ * @public
+ */
+export interface ListAuthenticationProfilesResponse {
+    /**
+     * <p>A summary of a given authentication profile.</p>
+     * @public
+     */
+    AuthenticationProfileSummaryList?: AuthenticationProfileSummary[];
+    /**
+     * <p>If there are additional results, this is the token for the next set of results.</p>
+     * @public
+     */
+    NextToken?: string;
+}
 /**
  * @public
  * @enum
@@ -8436,188 +8658,6 @@ export interface ListUseCasesResponse {
      */
     NextToken?: string;
 }
-/**
- * @public
- */
-export interface ListUserHierarchyGroupsRequest {
-    /**
-     * <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>
-     * @public
-     */
-    NextToken?: string;
-    /**
-     * <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
-     * @public
-     */
-    MaxResults?: number;
-}
-/**
- * @public
- */
-export interface ListUserHierarchyGroupsResponse {
-    /**
-     * <p>Information about the hierarchy groups.</p>
-     * @public
-     */
-    UserHierarchyGroupSummaryList?: HierarchyGroupSummary[];
-    /**
-     * <p>If there are additional results, this is the token for the next set of results.</p>
-     * @public
-     */
-    NextToken?: string;
-}
-/**
- * @public
- */
-export interface ListUserProficienciesRequest {
-    /**
-     * <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
-     *    Name (ARN) of the instance.</p>
-     * @public
-     */
-    InstanceId: string | undefined;
-    /**
-     * <p>The identifier of the user account.</p>
-     * @public
-     */
-    UserId: 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>
-     * @public
-     */
-    NextToken?: string;
-    /**
-     * <p>The maximum number of results to return per page.</p>
-     * @public
-     */
-    MaxResults?: number;
-}
-/**
- * @public
- */
-export interface ListUserProficienciesResponse {
-    /**
-     * <p>If there are additional results, this is the token for the next set of results.</p>
-     * @public
-     */
-    NextToken?: string;
-    /**
-     * <p>Information about the user proficiencies.</p>
-     * @public
-     */
-    UserProficiencyList?: UserProficiency[];
-    /**
-     * <p>The last time that the user's proficiencies are were modified.</p>
-     * @public
-     */
-    LastModifiedTime?: Date;
-    /**
-     * <p>The region in which a user's proficiencies were last modified.</p>
-     * @public
-     */
-    LastModifiedRegion?: string;
-}
-/**
- * @public
- */
-export interface ListUsersRequest {
-    /**
-     * <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>
-     * @public
-     */
-    NextToken?: string;
-    /**
-     * <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
-     * @public
-     */
-    MaxResults?: number;
-}
-/**
- * <p>Contains summary information about a user.</p>
- * @public
- */
-export interface UserSummary {
-    /**
-     * <p>The identifier of the user account.</p>
-     * @public
-     */
-    Id?: string;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the user account.</p>
-     * @public
-     */
-    Arn?: string;
-    /**
-     * <p>The Amazon Connect user name of the user account.</p>
-     * @public
-     */
-    Username?: string;
-    /**
-     * <p>The timestamp when this resource was last modified.</p>
-     * @public
-     */
-    LastModifiedTime?: Date;
-    /**
-     * <p>The Amazon Web Services Region where this resource was last modified.</p>
-     * @public
-     */
-    LastModifiedRegion?: string;
-}
-/**
- * @public
- */
-export interface ListUsersResponse {
-    /**
-     * <p>Information about the users.</p>
-     * @public
-     */
-    UserSummaryList?: UserSummary[];
-    /**
-     * <p>If there are additional results, this is the token for the next set of results.</p>
-     * @public
-     */
-    NextToken?: string;
-}
-/**
- * @public
- */
-export interface ListViewsRequest {
-    /**
-     * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
-     *    the instance.</p>
-     * @public
-     */
-    InstanceId: string | undefined;
-    /**
-     * <p>The type of the view.</p>
-     * @public
-     */
-    Type?: ViewType;
-    /**
-     * <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>
-     * @public
-     */
-    NextToken?: string;
-    /**
-     * <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
-     * @public
-     */
-    MaxResults?: number;
-}
 /**
  * @internal
  */