@aws-sdk/client-connect 3.473.0 → 3.475.0

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

@@ -19,9 +19,12 @@ export declare class AccessDeniedException extends __BaseException {
  */
 export declare const ActionType: {
     readonly ASSIGN_CONTACT_CATEGORY: "ASSIGN_CONTACT_CATEGORY";
+    readonly CREATE_CASE: "CREATE_CASE";
     readonly CREATE_TASK: "CREATE_TASK";
+    readonly END_ASSOCIATED_TASKS: "END_ASSOCIATED_TASKS";
     readonly GENERATE_EVENTBRIDGE_EVENT: "GENERATE_EVENTBRIDGE_EVENT";
     readonly SEND_NOTIFICATION: "SEND_NOTIFICATION";
+    readonly UPDATE_CASE: "UPDATE_CASE";
 };
 /**
  * @public
@@ -319,6 +322,11 @@ export interface AgentInfo {
      * <p>The timestamp when the contact was connected to the agent.</p>
      */
     ConnectedToAgentTimestamp?: Date;
+    /**
+     * @public
+     * <p>Agent pause duration for a contact in seconds.</p>
+     */
+    AgentPauseDurationInSeconds?: number;
 }
 /**
  * @public
@@ -387,7 +395,7 @@ export interface AgentStatus {
     State?: AgentStatusState;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
     /**
@@ -1233,8 +1241,8 @@ export interface BatchAssociateAnalyticsDataSetResponse {
     Created?: AnalyticsDataAssociationResult[];
     /**
      * @public
-     * <p>A list of errors for datasets that aren't successfully associated
-     *    with the target account.</p>
+     * <p>A list of errors for datasets that aren't successfully associated with the target
+     *    account.</p>
      */
     Errors?: ErrorResult[];
 }
@@ -1553,7 +1561,7 @@ export interface ClaimPhoneNumberRequest {
     PhoneNumberDescription?: string;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
     /**
@@ -1613,7 +1621,7 @@ export interface CreateAgentStatusRequest {
     DisplayOrder?: number;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -1698,7 +1706,7 @@ export interface CreateContactFlowRequest {
     Content: string | undefined;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -1772,7 +1780,7 @@ export interface CreateContactFlowModuleRequest {
     Content: string | undefined;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
     /**
@@ -2329,7 +2337,7 @@ export interface CreateHoursOfOperationRequest {
     Config: HoursOfOperationConfig[] | undefined;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -2397,7 +2405,8 @@ export interface CreateInstanceRequest {
     OutboundCallsEnabled: boolean | undefined;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, <code>\{ "tags": \{"key1":"value1", "key2":"value2"\} \}</code>.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, <code>\{
+     *     "tags": \{"key1":"value1", "key2":"value2"\} \}</code>.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -2440,6 +2449,7 @@ export type IntegrationType = (typeof IntegrationType)[keyof typeof IntegrationT
  * @enum
  */
 export declare const SourceType: {
+    readonly CASES: "CASES";
     readonly SALESFORCE: "SALESFORCE";
     readonly ZENDESK: "ZENDESK";
 };
@@ -2487,7 +2497,7 @@ export interface CreateIntegrationAssociationRequest {
     SourceType?: SourceType;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -2781,7 +2791,7 @@ export interface CreatePromptRequest {
     S3Uri: string | undefined;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -2862,7 +2872,7 @@ export interface CreateQueueRequest {
     QuickConnectIds?: string[];
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -2992,7 +3002,7 @@ export interface CreateQuickConnectRequest {
     QuickConnectConfig: QuickConnectConfig | undefined;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -3106,7 +3116,7 @@ export interface CreateRoutingProfileRequest {
     MediaConcurrencies: MediaConcurrency[] | undefined;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
     /**
@@ -3143,6 +3153,76 @@ export interface CreateRoutingProfileResponse {
  */
 export interface AssignContactCategoryActionDefinition {
 }
+/**
+ * @public
+ * <p>An empty value.</p>
+ */
+export interface EmptyFieldValue {
+}
+/**
+ * @public
+ * <p>Object to store union of Field values.</p>
+ */
+export interface FieldValueUnion {
+    /**
+     * @public
+     * <p>A Boolean number value type.</p>
+     */
+    BooleanValue?: boolean;
+    /**
+     * @public
+     * <p>a Double number value type.</p>
+     */
+    DoubleValue?: number;
+    /**
+     * @public
+     * <p>An empty value.</p>
+     */
+    EmptyValue?: EmptyFieldValue;
+    /**
+     * @public
+     * <p>String value type.</p>
+     */
+    StringValue?: string;
+}
+/**
+ * @public
+ * <p>Object for case field values.</p>
+ */
+export interface FieldValue {
+    /**
+     * @public
+     * <p>Unique identifier of a field.</p>
+     */
+    Id: string | undefined;
+    /**
+     * @public
+     * <p>Union of potential field value types.</p>
+     */
+    Value: FieldValueUnion | undefined;
+}
+/**
+ * @public
+ * <p>The <code>CreateCase</code> action definition.</p>
+ */
+export interface CreateCaseActionDefinition {
+    /**
+     * @public
+     * <p>An array of objects with <code>Field ID</code> and <code>Value</code> data.</p>
+     */
+    Fields: FieldValue[] | undefined;
+    /**
+     * @public
+     * <p>A unique identifier of a template.</p>
+     */
+    TemplateId: string | undefined;
+}
+/**
+ * @public
+ * <p>End associated tasks related to a case.</p>
+ */
+export interface EndAssociatedTasksActionDefinition {
+}
 /**
  * @public
  * <p>The EventBridge action definition.</p>
@@ -3183,7 +3263,7 @@ export type NotificationDeliveryType = (typeof NotificationDeliveryType)[keyof t
 export interface NotificationRecipientType {
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}. Amazon Connect users with the specified tags will be notified.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}. Amazon Connect users with the specified tags will be notified.</p>
      */
     UserTags?: Record<string, string>;
     /**
@@ -3294,6 +3374,17 @@ export interface TaskActionDefinition {
      */
     References?: Record<string, Reference>;
 }
+/**
+ * @public
+ * <p>The <code>UpdateCase</code> action definition.</p>
+ */
+export interface UpdateCaseActionDefinition {
+    /**
+     * @public
+     * <p>An array of objects with <code>Field ID</code> and Value data.</p>
+     */
+    Fields: FieldValue[] | undefined;
+}
 /**
  * @public
  * <p>Information about the action to be performed when a rule is triggered.</p>
@@ -3343,6 +3434,26 @@ export interface RuleAction {
      *          </p>
      */
     SendNotificationAction?: SendNotificationActionDefinition;
+    /**
+     * @public
+     * <p>Information about the create case action.</p>
+     *          <p>Supported only for <code>TriggerEventSource</code> values:
+     *     <code>OnPostCallAnalysisAvailable</code> | <code>OnPostChatAnalysisAvailable</code>.</p>
+     */
+    CreateCaseAction?: CreateCaseActionDefinition;
+    /**
+     * @public
+     * <p>Information about the update case action.</p>
+     *          <p>Supported only for <code>TriggerEventSource</code> values: <code>OnCaseCreate</code> |
+     *     <code>OnCaseUpdate</code>.</p>
+     */
+    UpdateCaseAction?: UpdateCaseActionDefinition;
+    /**
+     * @public
+     * <p>Information about the end associated tasks action.</p>
+     *          <p>Supported only for <code>TriggerEventSource</code> values: <code>OnCaseUpdate</code>.</p>
+     */
+    EndAssociatedTasksAction?: EndAssociatedTasksActionDefinition;
 }
 /**
  * @public
@@ -3361,6 +3472,8 @@ export type RulePublishStatus = (typeof RulePublishStatus)[keyof typeof RulePubl
  * @enum
  */
 export declare const EventSourceName: {
+    readonly OnCaseCreate: "OnCaseCreate";
+    readonly OnCaseUpdate: "OnCaseUpdate";
     readonly OnContactEvaluationSubmit: "OnContactEvaluationSubmit";
     readonly OnMetricDataUpdate: "OnMetricDataUpdate";
     readonly OnPostCallAnalysisAvailable: "OnPostCallAnalysisAvailable";
@@ -3497,7 +3610,7 @@ export interface CreateSecurityProfileRequest {
     InstanceId: string | undefined;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
     /**
@@ -3837,7 +3950,7 @@ export interface CreateTrafficDistributionGroupRequest {
     ClientToken?: string;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -3905,7 +4018,7 @@ export interface CreateUseCaseRequest {
     UseCaseType: UseCaseType | undefined;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -4063,7 +4176,7 @@ export interface CreateUserRequest {
     InstanceId: string | undefined;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -4104,7 +4217,7 @@ export interface CreateUserHierarchyGroupRequest {
     InstanceId: string | undefined;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -4449,7 +4562,7 @@ export interface CreateVocabularyRequest {
     Content: string | undefined;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -5047,6 +5160,26 @@ export interface Contact {
      * <p>The timestamp when contact was last updated.</p>
      */
     LastUpdateTimestamp?: Date;
+    /**
+     * @public
+     * <p>The timestamp when the contact was last paused.</p>
+     */
+    LastPausedTimestamp?: Date;
+    /**
+     * @public
+     * <p>The timestamp when the contact was last resumed.</p>
+     */
+    LastResumedTimestamp?: Date;
+    /**
+     * @public
+     * <p>Total pause count for a contact.</p>
+     */
+    TotalPauseCount?: number;
+    /**
+     * @public
+     * <p>Total pause duration for a contact in seconds.</p>
+     */
+    TotalPauseDurationInSeconds?: number;
     /**
      * @public
      * <p>The timestamp, in Unix epoch time format, at which to start running the inbound flow.
@@ -5064,6 +5197,11 @@ export interface Contact {
      * <p>Information about Amazon Connect Wisdom.</p>
      */
     WisdomInfo?: WisdomInfo;
+    /**
+     * @public
+     * <p>Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.</p>
+     */
+    Tags?: Record<string, string>;
 }
 /**
  * @public
@@ -5286,7 +5424,7 @@ export interface Evaluation {
     LastModifiedTime: Date | undefined;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -5375,7 +5513,7 @@ export interface ContactFlow {
     Content?: string;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -5471,7 +5609,7 @@ export interface ContactFlowModule {
     Status?: ContactFlowModuleStatus;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -5569,7 +5707,7 @@ export interface HoursOfOperation {
     Config?: HoursOfOperationConfig[];
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
     /**
@@ -6172,7 +6310,7 @@ export interface ClaimedPhoneNumberSummary {
     InstanceId?: string;
     /**
      * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
      */
     Tags?: Record<string, string>;
     /**
@@ -6239,155 +6377,6 @@ export interface DescribePromptRequest {
      */
     PromptId: string | undefined;
 }
-/**
- * @public
- * <p>Information about a prompt.</p>
- */
-export interface Prompt {
-    /**
-     * @public
-     * <p>The Amazon Resource Name (ARN) of the prompt.</p>
-     */
-    PromptARN?: string;
-    /**
-     * @public
-     * <p>A unique identifier for the prompt.</p>
-     */
-    PromptId?: string;
-    /**
-     * @public
-     * <p>The name of the prompt.</p>
-     */
-    Name?: string;
-    /**
-     * @public
-     * <p>The description of the prompt.</p>
-     */
-    Description?: string;
-    /**
-     * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
-     */
-    Tags?: Record<string, string>;
-    /**
-     * @public
-     * <p>The timestamp when this resource was last modified.</p>
-     */
-    LastModifiedTime?: Date;
-    /**
-     * @public
-     * <p>The Amazon Web Services Region where this resource was last modified.</p>
-     */
-    LastModifiedRegion?: string;
-}
-/**
- * @public
- */
-export interface DescribePromptResponse {
-    /**
-     * @public
-     * <p>Information about the prompt.</p>
-     */
-    Prompt?: Prompt;
-}
-/**
- * @public
- */
-export interface DescribeQueueRequest {
-    /**
-     * @public
-     * <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>
-     */
-    InstanceId: string | undefined;
-    /**
-     * @public
-     * <p>The identifier for the queue.</p>
-     */
-    QueueId: string | undefined;
-}
-/**
- * @public
- * @enum
- */
-export declare const QueueStatus: {
-    readonly DISABLED: "DISABLED";
-    readonly ENABLED: "ENABLED";
-};
-/**
- * @public
- */
-export type QueueStatus = (typeof QueueStatus)[keyof typeof QueueStatus];
-/**
- * @public
- * <p>Contains information about a queue.</p>
- */
-export interface Queue {
-    /**
-     * @public
-     * <p>The name of the queue.</p>
-     */
-    Name?: string;
-    /**
-     * @public
-     * <p>The Amazon Resource Name (ARN) for the queue.</p>
-     */
-    QueueArn?: string;
-    /**
-     * @public
-     * <p>The identifier for the queue.</p>
-     */
-    QueueId?: string;
-    /**
-     * @public
-     * <p>The description of the queue.</p>
-     */
-    Description?: string;
-    /**
-     * @public
-     * <p>The outbound caller ID name, number, and outbound whisper flow.</p>
-     */
-    OutboundCallerConfig?: OutboundCallerConfig;
-    /**
-     * @public
-     * <p>The identifier for the hours of operation.</p>
-     */
-    HoursOfOperationId?: string;
-    /**
-     * @public
-     * <p>The maximum number of contacts that can be in the queue before it is considered full.</p>
-     */
-    MaxContacts?: number;
-    /**
-     * @public
-     * <p>The status of the queue.</p>
-     */
-    Status?: QueueStatus;
-    /**
-     * @public
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
-     */
-    Tags?: Record<string, string>;
-    /**
-     * @public
-     * <p>The timestamp when this resource was last modified.</p>
-     */
-    LastModifiedTime?: Date;
-    /**
-     * @public
-     * <p>The Amazon Web Services Region where this resource was last modified.</p>
-     */
-    LastModifiedRegion?: string;
-}
-/**
- * @public
- */
-export interface DescribeQueueResponse {
-    /**
-     * @public
-     * <p>The name of the queue.</p>
-     */
-    Queue?: Queue;
-}
 /**
  * @internal
  */