@cdklabs/cdk-construct-connect-datalake 0.0.27 → 0.0.29

package/node_modules/@aws-sdk/client-connect/dist-types/models/models_3.d.ts

@@ -1,7 +1,82 @@
-import type { AgentAvailabilityTimer, AgentStatusState, AiUseCase, AnalyticsMode, AttachmentScope, AutoEvaluationStatus, Behavior, BooleanComparisonType, Channel, ChatEventType, ContactEvaluationAttributeComparisonType, ContactEvaluationAttributeKey, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactInitiationMethod, ContactInteractionType, ContactMediaProcessingFailureMode, ContactParticipantRole, ContactRecordingType, DataTableAttributeValueType, DataTableLockLevel, DateComparisonType, DateTimeComparisonType, DecimalComparisonType, EmailHeaderType, EvaluationFormLanguageCode, EvaluationFormVersionStatus, EvaluationStatus, EvaluationType, FileStatusType, FileUseCaseType, HierarchyGroupMatchType, InboundMessageSourceType, InstanceAttributeType, InstanceStorageResourceType, IvrRecordingTrack, LocaleCode, MaskMode, MeetingFeatureStatus, MetricUnit, NotificationPriority, NotificationType, NumberComparisonType, OutboundMessageSourceType, OverrideType, ParticipantRole, ParticipantTimerAction, ParticipantTimerType, PerformanceCategoryName, PhoneNumberCountryCode, PhoneNumberType, Policy, QueueStatus, RehydrationType, ResponseMode, RuleCapabilityTier, RulePublishStatus, SearchContactsMatchType, SearchContactsTimeRangeConditionType, SearchContactsTimeRangeType, SortableFieldName, SortOrder, StringComparisonType, SummaryMode, TargetListType, TaskTemplateStatus, TestCaseExecutionStatus, TestCaseStatus, TimerEligibleParticipantRoles, TrafficType, TrendIndicator, Visibility, VocabularyLanguageCode, VocabularyState, VoiceRecordingTrack } from "./enums";
-import type { ActionSummary, AfterContactWorkConfigPerChannel, AgentConfig, AgentHierarchyGroups, AgentStatus, AiAgentInput, AiAgentsCriteria, AliasConfiguration, Application, ControlPlaneAttributeFilter, CreatedByInfo, DataTableLockVersion, ExtractionConfiguration, ExtractionDefinitionDisplay, FlowModule, GranularAccessControlConfiguration, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InputPredefinedAttributeConfiguration, InstanceStorageConfig, MediaConcurrency, MetricCalculation, OutboundCallerConfig, OutboundEmailConfig, OutboundStrategy, PredefinedAttributeValues, PreEvaluationFilters, PrimaryValue, QuickConnectConfig, RecurrenceConfig, Reference, RoutingProfileQueueConfig, RuleAction, RuleTriggerEventSource, StringCondition, TagCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, Validation } from "./models_0";
-import type { AutoAcceptConfig, ContactFlow, ContactFlowModule, DataTable, EvaluationAnswerData, EvaluationNote, ExtensionConfiguration, HierarchyGroup, HoursOfOperation, HoursOfOperationOverride, MetricDefinition, PersistentConnectionConfig, PhoneNumberConfig, PredefinedAttribute, Prompt, Queue, QuickConnect, RoutingProfile, TestCase, TestCaseEntryPoint, UserPhoneConfig, View, VoiceEnhancementConfig } from "./models_1";
-import type { SignInConfig, TelephonyConfig } from "./models_2";
+import type { AgentAvailabilityTimer, AgentStatusState, AiUseCase, AnalyticsMode, AttachmentScope, AutoEvaluationStatus, Behavior, BooleanComparisonType, Channel, ChatEventType, ContactEvaluationAttributeComparisonType, ContactEvaluationAttributeKey, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactInitiationMethod, ContactInteractionType, ContactMediaProcessingFailureMode, ContactParticipantRole, ContactRecordingType, DataTableAttributeValueType, DataTableLockLevel, DateComparisonType, DateTimeComparisonType, DecimalComparisonType, EmailHeaderType, EvaluationFormLanguageCode, EvaluationFormVersionStatus, EvaluationStatus, EvaluationType, FileStatusType, FileUseCaseType, HierarchyGroupMatchType, InboundMessageSourceType, InstanceAttributeType, InstanceStorageResourceType, IvrRecordingTrack, LocaleCode, MaskMode, MeetingFeatureStatus, MetricUnit, NotificationPriority, NotificationType, NumberComparisonType, OutboundMessageSourceType, OverrideType, ParticipantRole, ParticipantTimerAction, ParticipantTimerType, PerformanceCategoryName, PhoneNumberCountryCode, PhoneNumberType, Policy, QueueStatus, RehydrationType, ResponseMode, RuleCapabilityTier, RulePublishStatus, SearchContactsMatchType, SearchContactsTimeRangeConditionType, SearchContactsTimeRangeType, SortableFieldName, SortOrder, StringComparisonType, SummaryMode, TargetListType, TestCaseExecutionStatus, TimerEligibleParticipantRoles, TrafficType, TrendIndicator, Visibility, VocabularyLanguageCode, VocabularyState, VoiceRecordingTrack } from "./enums";
+import type { ActionSummary, AfterContactWorkConfigPerChannel, AgentHierarchyGroups, AgentStatus, AIAgent, AiAgentInput, AiAgentsCriteria, AliasConfiguration, Application, ControlPlaneAttributeFilter, CreatedByInfo, DataTableLockVersion, ExtractionConfiguration, ExtractionDefinitionDisplay, FlowModule, GranularAccessControlConfiguration, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InputPredefinedAttributeConfiguration, InstanceStorageConfig, MediaConcurrency, MetricCalculation, OutboundCallerConfig, OutboundEmailConfig, OutboundStrategy, PredefinedAttributeValues, PreEvaluationFilters, PrimaryValue, QuickConnectConfig, RecurrenceConfig, Reference, RoutingProfileQueueConfig, RuleAction, RuleTriggerEventSource, StringCondition, TagCondition, Validation } from "./models_0";
+import type { AutoAcceptConfig, ContactFlow, ContactFlowModule, DataTable, EvaluationAnswerData, EvaluationNote, ExtensionConfiguration, HierarchyGroup, HoursOfOperation, HoursOfOperationOverride, MetricDefinition, PersistentConnectionConfig, PhoneNumberConfig, PredefinedAttribute, Prompt, Queue, QuickConnect, RoutingProfile, TestCase, UserPhoneConfig, View, VoiceEnhancementConfig } from "./models_1";
+/**
+ * @public
+ */
+export interface PauseContactResponse {
+}
+/**
+ * @public
+ */
+export interface PutUserStatusRequest {
+    /**
+     * <p>The identifier of the user.</p>
+     * @public
+     */
+    UserId: string | undefined;
+    /**
+     * <p>The identifier of the Connect Customer 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 identifier of the agent status.</p>
+     * @public
+     */
+    AgentStatusId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface PutUserStatusResponse {
+}
+/**
+ * @public
+ */
+export interface ReleasePhoneNumberRequest {
+    /**
+     * <p>A unique identifier for the phone number.</p>
+     * @public
+     */
+    PhoneNumberId: string | undefined;
+    /**
+     * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
+     *             request. If not provided, the Amazon Web Services
+     *             SDK populates this field. For more information about idempotency, see
+     *             <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
+     * @public
+     */
+    ClientToken?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ReplicateInstanceRequest {
+    /**
+     * <p>The identifier of the Connect Customer 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. You can provide the <code>InstanceId</code>, or the entire ARN.</p>
+     * @public
+     */
+    InstanceId: string | undefined;
+    /**
+     * <p>The Amazon Web Services Region where to replicate the Connect Customer instance.</p>
+     * @public
+     */
+    ReplicaRegion: string | undefined;
+    /**
+     * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
+     *             request. If not provided, the Amazon Web Services
+     *             SDK populates this field. For more information about idempotency, see
+     *             <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
+     * @public
+     */
+    ClientToken?: string | undefined;
+    /**
+     * <p>The alias for the replicated instance. The <code>ReplicaAlias</code> must be unique.</p>
+     * @public
+     */
+    ReplicaAlias?: string | undefined;
+}
 /**
  * @public
  */
@@ -3570,6 +3645,40 @@ export interface ParticipantConfiguration {
      */
     ResponseMode?: ResponseMode | undefined;
 }
+/**
+ * <p>The credentials that a chat participant uses to connect to the Connect Customer Participant Service.</p>
+ * @public
+ */
+export interface ConnectionCredentials {
+    /**
+     * <p>The connection token used by the chat participant to call the Connect Customer Participant Service.</p>
+     * @public
+     */
+    ConnectionToken?: string | undefined;
+    /**
+     * <p>The expiration of the token. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
+     *    2019-11-08T02:41:28.172Z.</p>
+     * @public
+     */
+    Expiry?: string | undefined;
+}
+/**
+ * <p>The websocket that a chat participant uses to receive messages and events for the chat.</p>
+ * @public
+ */
+export interface Websocket {
+    /**
+     * <p>The URL of the websocket.</p>
+     * @public
+     */
+    Url?: string | undefined;
+    /**
+     * <p>The expiration of the websocket URL. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
+     *    2019-11-08T02:41:28.172Z.</p>
+     * @public
+     */
+    ConnectionExpiry?: string | undefined;
+}
 /**
  * @public
  */
@@ -3596,6 +3705,24 @@ export interface StartChatContactResponse {
      * @public
      */
     ContinuedFromContactId?: string | undefined;
+    /**
+     * <p>The connection credentials for the chat participant. Returned only when the request includes
+     *     <code>CONNECTION_CREDENTIALS</code> in <code>ConnectionTypes</code>.</p>
+     * @public
+     */
+    ConnectionCredentials?: ConnectionCredentials | undefined;
+    /**
+     * <p>The websocket for the chat participant. Returned only when the request includes <code>WEBSOCKET</code> in
+     *     <code>ConnectionTypes</code>.</p>
+     * @public
+     */
+    Websocket?: Websocket | undefined;
+    /**
+     * <p>The identifier of the streaming configuration enabled with the chat. Returned only when the request sets
+     *     <code>ChatStreamingConfiguration</code>. Use this value to call <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StopContactStreaming.html">StopContactStreaming</a>.</p>
+     * @public
+     */
+    StreamingId?: string | undefined;
 }
 /**
  * <p>The language configuration for conversational analytics.</p>
@@ -5841,6 +5968,11 @@ export interface UpdateInstanceAttributeRequest {
      *     based policy to include the <code>lex:RecognizeMessageAsync</code> action for the connect instance ARN
      *     resource.</p>
      *          </note>
+     *          <note>
+     *             <p>If you set the attribute type <code>AUTO_MUTE_AGENT_ON_HOLD</code> to <code>true</code>, the system
+     *     automatically mutes agents while they're on hold and unmutes them when they resume the contact. Agents can't
+     *     change their mute state while on hold.</p>
+     *          </note>
      * @public
      */
     AttributeType: InstanceAttributeType | undefined;
@@ -5971,7 +6103,8 @@ export interface UpdateNotificationContentRequest {
      */
     NotificationId: string | undefined;
     /**
-     * <p>The updated localized content of the notification. A map of locale codes and values. Maximum 500 characters per locale.</p>
+     * <p>The updated localized content of the notification. A map of locale codes and values. Maximum 500 visible
+     *    characters per locale.</p>
      * @public
      */
     Content: Partial<Record<LocaleCode, string>> | undefined;
@@ -6690,277 +6823,13 @@ export interface UpdateSecurityProfileRequest {
      */
     AllowedFlowModules?: FlowModule[] | undefined;
     /**
-     * <p>The granular access control configuration for the security profile, including data table permissions.</p>
-     * @public
-     */
-    GranularAccessControlConfiguration?: GranularAccessControlConfiguration | undefined;
-}
-/**
- * @public
- */
-export interface UpdateTaskTemplateRequest {
-    /**
-     * <p>A unique identifier for the task template.</p>
-     * @public
-     */
-    TaskTemplateId: string | undefined;
-    /**
-     * <p>The identifier of the Connect Customer 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 name of the task template.</p>
-     * @public
-     */
-    Name?: string | undefined;
-    /**
-     * <p>The description of the task template.</p>
-     * @public
-     */
-    Description?: string | undefined;
-    /**
-     * <p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>
-     *          <p>Although this parameter is marked as optional, the request must contain either a <code>ContactFlowId</code> or a field of type <code>QUICK_CONNECT</code>.</p>
-     * @public
-     */
-    ContactFlowId?: string | undefined;
-    /**
-     * <p>The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.</p>
-     * @public
-     */
-    SelfAssignFlowId?: string | undefined;
-    /**
-     * <p>Constraints that are applicable to the fields listed.
-     * Although this parameter is marked as optional in the API model, the service requires it when calling <code>CreateTaskTemplate</code> or <code>UpdateTaskTemplate</code>.
-     * The <code>RequiredFields</code> array must contain at least one element, and the field of type <code>NAME</code> must be included in <code>RequiredFields</code>.</p>
-     * @public
-     */
-    Constraints?: TaskTemplateConstraints | undefined;
-    /**
-     * <p>The default values for fields when a task is created by referencing this template.</p>
-     * @public
-     */
-    Defaults?: TaskTemplateDefaults | undefined;
-    /**
-     * <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>
-     *          <p>Although this parameter is marked as optional, the service requires it when calling <code>UpdateTaskTemplate</code>.</p>
-     * @public
-     */
-    Status?: TaskTemplateStatus | undefined;
-    /**
-     * <p>Fields that are part of the template.</p>
-     *          <p>The request must contain exactly one field of type <code>NAME</code>. This field must also be listed in the <code>RequiredFields</code> array within the <code>Constraints</code> parameter.</p>
-     * @public
-     */
-    Fields?: TaskTemplateField[] | undefined;
-}
-/**
- * @public
- */
-export interface UpdateTaskTemplateResponse {
-    /**
-     * <p>The identifier of the Connect Customer 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 identifier of the task template resource.</p>
-     * @public
-     */
-    Id?: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) for the task template resource.</p>
-     * @public
-     */
-    Arn?: string | undefined;
-    /**
-     * <p>The name of the task template.</p>
-     * @public
-     */
-    Name?: string | undefined;
-    /**
-     * <p>The description of the task template.</p>
-     * @public
-     */
-    Description?: string | undefined;
-    /**
-     * <p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>
-     * @public
-     */
-    ContactFlowId?: string | undefined;
-    /**
-     * <p>The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.</p>
-     * @public
-     */
-    SelfAssignFlowId?: string | undefined;
-    /**
-     * <p>Constraints that are applicable to the fields listed.
-     * Although this parameter is marked as optional in the API model, the service requires it when calling <code>CreateTaskTemplate</code> or <code>UpdateTaskTemplate</code>.
-     * The <code>RequiredFields</code> array must contain at least one element, and the field of type <code>NAME</code> must be included in <code>RequiredFields</code>.</p>
-     * @public
-     */
-    Constraints?: TaskTemplateConstraints | undefined;
-    /**
-     * <p>The default values for fields when a task is created by referencing this template.</p>
-     * @public
-     */
-    Defaults?: TaskTemplateDefaults | undefined;
-    /**
-     * <p>Fields that are part of the template.</p>
-     * @public
-     */
-    Fields?: TaskTemplateField[] | undefined;
-    /**
-     * <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 | undefined;
-    /**
-     * <p>The timestamp when the task template was last modified.</p>
-     * @public
-     */
-    LastModifiedTime?: Date | undefined;
-    /**
-     * <p>The timestamp when the task template was created.</p>
-     * @public
-     */
-    CreatedTime?: Date | undefined;
-}
-/**
- * @public
- */
-export interface UpdateTestCaseRequest {
-    /**
-     * <p>The identifier of the Amazon Connect instance.</p>
-     * @public
-     */
-    InstanceId: string | undefined;
-    /**
-     * <p>The identifier of the test case to update.</p>
-     * @public
-     */
-    TestCaseId: string | undefined;
-    /**
-     * <p>The JSON string that represents the content of the test.</p>
-     * @public
-     */
-    Content?: string | undefined;
-    /**
-     * <p>Defines the starting point for your test.</p>
-     * @public
-     */
-    EntryPoint?: TestCaseEntryPoint | undefined;
-    /**
-     * <p>Defines the test attributes for precise data representation.</p>
-     * @public
-     */
-    InitializationData?: string | undefined;
-    /**
-     * <p>The name of the test case.</p>
-     * @public
-     */
-    Name?: string | undefined;
-    /**
-     * <p>The description of the test case.</p>
-     * @public
-     */
-    Description?: string | undefined;
-    /**
-     * <p>Indicates the test status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. The SAVED status does not initiate validation of the content.</p>
+     * <p>A list of AI agents that the security profile will give access to.</p>
      * @public
      */
-    Status?: TestCaseStatus | undefined;
+    AllowedAIAgents?: AIAgent[] | undefined;
     /**
-     * <p>The time at which the resource was last modified.</p>
-     * @public
-     */
-    LastModifiedTime?: Date | undefined;
-    /**
-     * <p>The region in which the resource was last modified</p>
-     * @public
-     */
-    LastModifiedRegion?: string | undefined;
-}
-/**
- * @public
- */
-export interface UpdateTestCaseResponse {
-}
-/**
- * @public
- */
-export interface UpdateTrafficDistributionRequest {
-    /**
-     * <p>The identifier of the traffic distribution group.
-     * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
-     * The ARN must be provided if the call is from the replicated Region. </p>
-     * @public
-     */
-    Id: string | undefined;
-    /**
-     * <p>The distribution of traffic between the instance and its replica(s).</p>
-     * @public
-     */
-    TelephonyConfig?: TelephonyConfig | undefined;
-    /**
-     * <p>The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both
-     *    the instance and its replica(s).</p>
-     * @public
-     */
-    SignInConfig?: SignInConfig | undefined;
-    /**
-     * <p>The distribution of agents between the instance and its replica(s).</p>
-     * @public
-     */
-    AgentConfig?: AgentConfig | undefined;
-}
-/**
- * @public
- */
-export interface UpdateTrafficDistributionResponse {
-}
-/**
- * @public
- */
-export interface UpdateUserConfigRequest {
-    /**
-     * <p>The list of auto-accept configuration settings for each channel. When auto-accept is enabled for a channel, available agents are automatically connected to contacts from that channel without needing to manually accept. Auto-accept connects agents to contacts in less than one second.</p>
-     * @public
-     */
-    AutoAcceptConfigs?: AutoAcceptConfig[] | undefined;
-    /**
-     * <p>The list of after contact work (ACW) timeout configuration settings for each channel. ACW timeout specifies how many seconds agents have for after contact work, such as entering notes about the contact. The minimum setting is 1 second, and the maximum is 2,000,000 seconds (24 days). Enter 0 for an indefinite amount of time, meaning agents must manually choose to end ACW.</p>
-     * @public
-     */
-    AfterContactWorkConfigs?: AfterContactWorkConfigPerChannel[] | undefined;
-    /**
-     * <p>The list of phone number configuration settings for each channel.</p>
-     * @public
-     */
-    PhoneNumberConfigs?: PhoneNumberConfig[] | undefined;
-    /**
-     * <p>The list of persistent connection configuration settings for each channel.</p>
-     * @public
-     */
-    PersistentConnectionConfigs?: PersistentConnectionConfig[] | undefined;
-    /**
-     * <p>The list of voice enhancement configuration settings for each channel.</p>
-     * @public
-     */
-    VoiceEnhancementConfigs?: VoiceEnhancementConfig[] | undefined;
-    /**
-     * <p>The identifier of the user account.</p>
-     * @public
-     */
-    UserId: string | undefined;
-    /**
-     * <p>The identifier of the Connect Customer 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>
+     * <p>The granular access control configuration for the security profile, including data table permissions.</p>
      * @public
      */
-    InstanceId: string | undefined;
+    GranularAccessControlConfiguration?: GranularAccessControlConfiguration | undefined;
 }