@cdklabs/cdk-construct-connect-datalake 0.0.26 → 0.0.28

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

@@ -1,7 +1,213 @@
-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, NotificationStatus, 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, 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, UserIdentityInfo, 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, TaskTemplateStatus, TestCaseExecutionStatus, TestCaseStatus, 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, TaskTemplateConstraints, TaskTemplateDefaults, Validation } from "./models_0";
+import type { AutoAcceptConfig, ContactFlow, ContactFlowModule, DataTable, EvaluationAnswerData, EvaluationNote, ExtensionConfiguration, HierarchyGroup, HoursOfOperation, HoursOfOperationOverride, MetricDefinition, PersistentConnectionConfig, PhoneNumberConfig, PredefinedAttribute, Prompt, Queue, QuickConnect, RoutingProfile, TaskTemplateField, TestCase, TestCaseEntryPoint, UserPhoneConfig, View, VoiceEnhancementConfig } from "./models_1";
+/**
+ * @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
+ */
+export interface ReplicateInstanceResponse {
+    /**
+     * <p>The identifier of the replicated instance. You can find the <code>instanceId</code> in the ARN of the instance.
+     *    The replicated instance has the same identifier as the instance it was replicated from.</p>
+     * @public
+     */
+    Id?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the replicated instance.</p>
+     * @public
+     */
+    Arn?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ResumeContactRequest {
+    /**
+     * <p>The identifier of the contact.</p>
+     * @public
+     */
+    ContactId: string | undefined;
+    /**
+     * <p>The identifier of the Connect Customer instance. You can find the <code>instanceId</code> in the ARN of the
+     *    instance.</p>
+     * @public
+     */
+    InstanceId: string | undefined;
+    /**
+     * <p>The identifier of the flow.</p>
+     * @public
+     */
+    ContactFlowId?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ResumeContactResponse {
+}
+/**
+ * @public
+ */
+export interface ResumeContactRecordingRequest {
+    /**
+     * <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 contact.</p>
+     * @public
+     */
+    ContactId: string | undefined;
+    /**
+     * <p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with
+     *    the contact center.</p>
+     * @public
+     */
+    InitialContactId: string | undefined;
+    /**
+     * <p>The type of recording being operated on.</p>
+     * @public
+     */
+    ContactRecordingType?: ContactRecordingType | undefined;
+}
+/**
+ * @public
+ */
+export interface ResumeContactRecordingResponse {
+}
+/**
+ * @public
+ */
+export interface SearchAgentStatusesResponse {
+    /**
+     * <p>The search criteria to be used to return agent statuses.</p>
+     * @public
+     */
+    AgentStatuses?: AgentStatus[] | undefined;
+    /**
+     * <p>If there are additional results, this is the token for the next set of results.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+    /**
+     * <p>The total number of agent statuses which matched your search query.</p>
+     * @public
+     */
+    ApproximateTotalCount?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface SearchAvailablePhoneNumbersRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN) for Connect Customer instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
+     * @public
+     */
+    TargetArn?: string | undefined;
+    /**
+     * <p>The identifier of the Connect Customer instance that phone numbers are claimed to. 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 must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
+     * @public
+     */
+    InstanceId?: string | undefined;
+    /**
+     * <p>The ISO country code.</p>
+     * @public
+     */
+    PhoneNumberCountryCode: PhoneNumberCountryCode | undefined;
+    /**
+     * <p>The type of phone number.</p>
+     * @public
+     */
+    PhoneNumberType: PhoneNumberType | undefined;
+    /**
+     * <p>The prefix of the phone number. If provided, it must contain <code>+</code> as part of the country code.</p>
+     * @public
+     */
+    PhoneNumberPrefix?: string | undefined;
+    /**
+     * <p>The maximum number of results to return per page.</p>
+     * @public
+     */
+    MaxResults?: number | 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 | undefined;
+}
 /**
  * <p>Information about available phone numbers.</p>
  * @public
@@ -1260,6 +1466,11 @@ export interface EvaluationFormSearchSummary {
      * @public
      */
     Tags?: Record<string, string> | undefined;
+    /**
+     * <p>The AI version to use for the evaluation form. This specifies which AI model version is used for automated evaluations.</p>
+     * @public
+     */
+    AIVersion?: string | undefined;
 }
 /**
  * @public
@@ -5700,6 +5911,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;
@@ -6548,6 +6764,11 @@ export interface UpdateSecurityProfileRequest {
      * @public
      */
     AllowedFlowModules?: FlowModule[] | undefined;
+    /**
+     * <p>A list of AI agents that the security profile will give access to.</p>
+     * @public
+     */
+    AllowedAIAgents?: AIAgent[] | undefined;
     /**
      * <p>The granular access control configuration for the security profile, including data table permissions.</p>
      * @public
@@ -6745,235 +6966,3 @@ export interface UpdateTestCaseRequest {
      */
     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>
-     * @public
-     */
-    InstanceId: string | undefined;
-}
-/**
- * @public
- */
-export interface UpdateUserHierarchyRequest {
-    /**
-     * <p>The identifier of the hierarchy group.</p>
-     * @public
-     */
-    HierarchyGroupId?: string | 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>
-     * @public
-     */
-    InstanceId: string | undefined;
-}
-/**
- * @public
- */
-export interface UpdateUserHierarchyGroupNameRequest {
-    /**
-     * <p>The name of the hierarchy group. Must not be more than 100 characters.</p>
-     * @public
-     */
-    Name: string | undefined;
-    /**
-     * <p>The identifier of the hierarchy group.</p>
-     * @public
-     */
-    HierarchyGroupId: 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>Contains information about the hierarchy level to update.</p>
- * @public
- */
-export interface HierarchyLevelUpdate {
-    /**
-     * <p>The name of the user hierarchy level. Must not be more than 50 characters.</p>
-     * @public
-     */
-    Name: string | undefined;
-}
-/**
- * <p>Contains information about the level hierarchy to update.</p>
- * @public
- */
-export interface HierarchyStructureUpdate {
-    /**
-     * <p>The
-     *    update
-     *    for level one.</p>
-     * @public
-     */
-    LevelOne?: HierarchyLevelUpdate | undefined;
-    /**
-     * <p>The update for level two.</p>
-     * @public
-     */
-    LevelTwo?: HierarchyLevelUpdate | undefined;
-    /**
-     * <p>The update for level three.</p>
-     * @public
-     */
-    LevelThree?: HierarchyLevelUpdate | undefined;
-    /**
-     * <p>The update for level four.</p>
-     * @public
-     */
-    LevelFour?: HierarchyLevelUpdate | undefined;
-    /**
-     * <p>The update for level five.</p>
-     * @public
-     */
-    LevelFive?: HierarchyLevelUpdate | undefined;
-}
-/**
- * @public
- */
-export interface UpdateUserHierarchyStructureRequest {
-    /**
-     * <p>The hierarchy levels to update.</p>
-     * @public
-     */
-    HierarchyStructure: HierarchyStructureUpdate | 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;
-}
-/**
- * @public
- */
-export interface UpdateUserIdentityInfoRequest {
-    /**
-     * <p>The identity information for the user.</p>
-     * @public
-     */
-    IdentityInfo: UserIdentityInfo | 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>
-     * @public
-     */
-    InstanceId: string | undefined;
-}
-/**
- * @public
- */
-export interface UpdateUserNotificationStatusRequest {
-    /**
-     * <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 unique identifier for the notification.</p>
-     * @public
-     */
-    NotificationId: string | undefined;
-    /**
-     * <p>The identifier of the user whose notification status is being updated.</p>
-     * @public
-     */
-    UserId: string | undefined;
-    /**
-     * <p>The new status for the notification. Valid values are READ, UNREAD, and HIDDEN.</p>
-     * @public
-     */
-    Status: NotificationStatus | undefined;
-    /**
-     * <p>The timestamp when the notification status was last modified. Used for cross-region replication and optimistic locking.</p>
-     * @public
-     */
-    LastModifiedTime?: Date | undefined;
-    /**
-     * <p>The AWS Region where the notification status was last modified. Used for cross-region replication.</p>
-     * @public
-     */
-    LastModifiedRegion?: string | undefined;
-}