@aws-sdk/client-connect 3.1149.0 → 3.1151.0

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

@@ -1,6 +1,224 @@
-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 { 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, MonitorCapability, NotificationPriority, NotificationType, NumberComparisonType, OutboundMessageSourceType, OverrideType, ParticipantRole, ParticipantTimerAction, ParticipantTimerType, PerformanceCategoryName, PhoneNumberCountryCode, PhoneNumberType, Policy, 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, AiAgentInput, AiAgentsCriteria, AliasConfiguration, ControlPlaneAttributeFilter, CreatedByInfo, DataTableLockVersion, ExtractionConfiguration, ExtractionDefinitionDisplay, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InputPredefinedAttributeConfiguration, InstanceStorageConfig, MetricCalculation, OutboundStrategy, PredefinedAttributeValues, PreEvaluationFilters, PrimaryValue, RecurrenceConfig, Reference, 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";
+import type { MediaItem } from "./models_2";
+/**
+ * @public
+ */
+export interface ListWorkspaceMediaResponse {
+    /**
+     * <p>A list of media assets for the workspace.</p>
+     * @public
+     */
+    Media?: MediaItem[] | undefined;
+}
+/**
+ * @public
+ */
+export interface ListWorkspacePagesRequest {
+    /**
+     * <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 identifier of the workspace.</p>
+     * @public
+     */
+    WorkspaceId: 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 | undefined;
+    /**
+     * <p>The maximum number of results to return per page.</p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+}
+/**
+ * <p>Contains information about a page configuration in a workspace, including the view assigned to the page.</p>
+ * @public
+ */
+export interface WorkspacePage {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the view associated with this page.</p>
+     * @public
+     */
+    ResourceArn?: string | undefined;
+    /**
+     * <p>The page identifier. System pages include <code>HOME</code> and <code>AGENT_EXPERIENCE</code>.</p>
+     * @public
+     */
+    Page?: string | undefined;
+    /**
+     * <p>The URL-friendly identifier for the page.</p>
+     * @public
+     */
+    Slug?: string | undefined;
+    /**
+     * <p>A JSON string containing input parameters passed to the view when the page is rendered.</p>
+     * @public
+     */
+    InputData?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListWorkspacePagesResponse {
+    /**
+     * <p>If there are additional results, this is the token for the next set of results.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+    /**
+     * <p>A list of page configurations in the workspace.</p>
+     * @public
+     */
+    WorkspacePageList: WorkspacePage[] | undefined;
+}
+/**
+ * @public
+ */
+export interface ListWorkspacesRequest {
+    /**
+     * <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 | undefined;
+    /**
+     * <p>The maximum number of results to return per page.</p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+}
+/**
+ * <p>Contains summary information about a workspace.</p>
+ * @public
+ */
+export interface WorkspaceSummary {
+    /**
+     * <p>The unique identifier of the workspace.</p>
+     * @public
+     */
+    Id?: string | undefined;
+    /**
+     * <p>The name of the workspace.</p>
+     * @public
+     */
+    Name?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the workspace.</p>
+     * @public
+     */
+    Arn?: string | undefined;
+    /**
+     * <p>The timestamp when the workspace was last modified.</p>
+     * @public
+     */
+    LastModifiedTime?: Date | undefined;
+    /**
+     * <p>The Amazon Web Services Region where the workspace was last modified.</p>
+     * @public
+     */
+    LastModifiedRegion?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListWorkspacesResponse {
+    /**
+     * <p>If there are additional results, this is the token for the next set of results.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+    /**
+     * <p>A summary list of workspaces.</p>
+     * @public
+     */
+    WorkspaceSummaryList: WorkspaceSummary[] | undefined;
+}
+/**
+ * @public
+ */
+export interface MonitorContactRequest {
+    /**
+     * <p>The identifier of the Connect Customer instance. You can find the instanceId in the 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 user account.</p>
+     * @public
+     */
+    UserId: string | undefined;
+    /**
+     * <p>Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to
+     *    escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.</p>
+     * @public
+     */
+    AllowedMonitorCapabilities?: MonitorCapability[] | 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 MonitorContactResponse {
+    /**
+     * <p>The identifier of the contact.</p>
+     * @public
+     */
+    ContactId?: string | undefined;
+    /**
+     * <p>The ARN of the contact.</p>
+     * @public
+     */
+    ContactArn?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface PauseContactRequest {
+    /**
+     * <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
  */
@@ -5301,6 +5519,46 @@ export interface UpdateContactEvaluationResponse {
      */
     EvaluationArn: string | undefined;
 }
+/**
+ * @public
+ */
+export interface UpdateContactFlowAliasRequest {
+    /**
+     * <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 flow.</p>
+     * @public
+     */
+    ContactFlowId: string | undefined;
+    /**
+     * <p>The identifier of the alias.</p>
+     * @public
+     */
+    AliasId: string | undefined;
+    /**
+     * <p>The name of the alias.</p>
+     * @public
+     */
+    Name?: string | undefined;
+    /**
+     * <p>The description of the alias.</p>
+     * @public
+     */
+    Description?: string | undefined;
+    /**
+     * <p>The version of the flow.</p>
+     * @public
+     */
+    ContactFlowVersion?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateContactFlowAliasResponse {
+}
 /**
  * @public
  */
@@ -6510,326 +6768,3 @@ export interface UpdateQueueNameRequest {
      */
     Description?: string | undefined;
 }
-/**
- * @public
- */
-export interface UpdateQueueOutboundCallerConfigRequest {
-    /**
-     * <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 for the queue.</p>
-     * @public
-     */
-    QueueId: string | undefined;
-    /**
-     * <p>The outbound caller ID name, number, and outbound whisper flow.</p>
-     * @public
-     */
-    OutboundCallerConfig: OutboundCallerConfig | undefined;
-}
-/**
- * @public
- */
-export interface UpdateQueueOutboundEmailConfigRequest {
-    /**
-     * <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 for the queue.</p>
-     * @public
-     */
-    QueueId: string | undefined;
-    /**
-     * <p>The outbound email address ID for a specified queue.</p>
-     * @public
-     */
-    OutboundEmailConfig: OutboundEmailConfig | undefined;
-}
-/**
- * @public
- */
-export interface UpdateQueueStatusRequest {
-    /**
-     * <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 for the queue.</p>
-     * @public
-     */
-    QueueId: string | undefined;
-    /**
-     * <p>The status of the queue.</p>
-     * @public
-     */
-    Status: QueueStatus | undefined;
-}
-/**
- * @public
- */
-export interface UpdateQuickConnectConfigRequest {
-    /**
-     * <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 for the quick connect.</p>
-     * @public
-     */
-    QuickConnectId: string | undefined;
-    /**
-     * <p>Information about the configuration settings for the quick connect.</p>
-     * @public
-     */
-    QuickConnectConfig: QuickConnectConfig | undefined;
-}
-/**
- * @public
- */
-export interface UpdateQuickConnectNameRequest {
-    /**
-     * <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 for the quick connect.</p>
-     * @public
-     */
-    QuickConnectId: string | undefined;
-    /**
-     * <p>The name of the quick connect.</p>
-     * @public
-     */
-    Name?: string | undefined;
-    /**
-     * <p>The description of the quick connect.</p>
-     * @public
-     */
-    Description?: string | undefined;
-}
-/**
- * @public
- */
-export interface UpdateRoutingProfileAgentAvailabilityTimerRequest {
-    /**
-     * <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 routing profile.</p>
-     * @public
-     */
-    RoutingProfileId: string | undefined;
-    /**
-     * <p>Whether agents with this routing profile will have their routing order calculated based on <i>time since
-     *     their last inbound contact</i> or <i>longest idle time</i>. </p>
-     * @public
-     */
-    AgentAvailabilityTimer: AgentAvailabilityTimer | undefined;
-}
-/**
- * @public
- */
-export interface UpdateRoutingProfileConcurrencyRequest {
-    /**
-     * <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 routing profile.</p>
-     * @public
-     */
-    RoutingProfileId: string | undefined;
-    /**
-     * <p>The channels that agents can handle in the Contact Control Panel (CCP).</p>
-     * @public
-     */
-    MediaConcurrencies: MediaConcurrency[] | undefined;
-}
-/**
- * @public
- */
-export interface UpdateRoutingProfileDefaultOutboundQueueRequest {
-    /**
-     * <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 routing profile.</p>
-     * @public
-     */
-    RoutingProfileId: string | undefined;
-    /**
-     * <p>The identifier for the default outbound queue.</p>
-     * @public
-     */
-    DefaultOutboundQueueId: string | undefined;
-}
-/**
- * @public
- */
-export interface UpdateRoutingProfileNameRequest {
-    /**
-     * <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 routing profile.</p>
-     * @public
-     */
-    RoutingProfileId: string | undefined;
-    /**
-     * <p>The name of the routing profile. Must not be more than 127 characters.</p>
-     * @public
-     */
-    Name?: string | undefined;
-    /**
-     * <p>The description of the routing profile. Must not be more than 250 characters.</p>
-     * @public
-     */
-    Description?: string | undefined;
-}
-/**
- * @public
- */
-export interface UpdateRoutingProfileQueuesRequest {
-    /**
-     * <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 routing profile.</p>
-     * @public
-     */
-    RoutingProfileId: string | undefined;
-    /**
-     * <p>The queues to be updated for this routing profile. Queues must
-     *    first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.</p>
-     * @public
-     */
-    QueueConfigs: RoutingProfileQueueConfig[] | undefined;
-}
-/**
- * @public
- */
-export interface UpdateRuleRequest {
-    /**
-     * <p>A unique identifier for the rule.</p>
-     * @public
-     */
-    RuleId: 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 rule. You can change the name only if <code>TriggerEventSource</code> is one of the following
-     *    values: <code>OnZendeskTicketCreate</code> | <code>OnZendeskTicketStatusUpdate</code> |
-     *     <code>OnSalesforceCaseCreate</code>
-     *          </p>
-     * @public
-     */
-    Name: string | undefined;
-    /**
-     * <p>The conditions of the rule.</p>
-     * @public
-     */
-    Function: string | undefined;
-    /**
-     * <p>A list of actions to be run when the rule is triggered.</p>
-     * @public
-     */
-    Actions: RuleAction[] | undefined;
-    /**
-     * <p>The publish status of the rule.</p>
-     * @public
-     */
-    PublishStatus: RulePublishStatus | undefined;
-    /**
-     * <p>The pre-evaluation filters for the rule, that restrict the rule to be applied to only certain resources based
-     *    on the resource's attributes, such as tags assigned to a contact. The pre-evaluation filters are applied even before
-     *    rule conditions are evaluated and are used to enforce tag-based-access-control while applying rules.</p>
-     * @public
-     */
-    PreEvaluationFilters?: PreEvaluationFilters | undefined;
-}
-/**
- * @public
- */
-export interface UpdateSecurityProfileRequest {
-    /**
-     * <p>The description of the security profile.</p>
-     * @public
-     */
-    Description?: string | undefined;
-    /**
-     * <p>The permissions granted to a security profile. For a list of valid permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile permissions</a>.</p>
-     * @public
-     */
-    Permissions?: string[] | undefined;
-    /**
-     * <p>The identifier for the security profle.</p>
-     * @public
-     */
-    SecurityProfileId: 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 list of tags that a security profile uses to restrict access to resources in Connect Customer.</p>
-     * @public
-     */
-    AllowedAccessControlTags?: Record<string, string> | undefined;
-    /**
-     * <p>The list of resources that a security profile applies tag restrictions to in Connect Customer.</p>
-     * @public
-     */
-    TagRestrictedResources?: string[] | undefined;
-    /**
-     * <p>A list of the third-party application's metadata.</p>
-     * @public
-     */
-    Applications?: Application[] | undefined;
-    /**
-     * <p>The list of resources that a security profile applies hierarchy restrictions to in Connect Customer. Following
-     *    are acceptable ResourceNames: <code>User</code>.</p>
-     * @public
-     */
-    HierarchyRestrictedResources?: string[] | undefined;
-    /**
-     * <p>The identifier of the hierarchy group that a security profile uses to restrict access to resources in Connect Customer.</p>
-     * @public
-     */
-    AllowedAccessControlHierarchyGroupId?: string | undefined;
-    /**
-     * <p> A list of Flow Modules an AI Agent can invoke as a tool </p>
-     * @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
-     */
-    GranularAccessControlConfiguration?: GranularAccessControlConfiguration | undefined;
-}