@aws-sdk/client-connect 3.940.0 → 3.943.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +362 -13
- package/dist-cjs/index.js +3179 -266
- package/dist-es/Connect.js +88 -0
- package/dist-es/commands/AssociateSecurityProfilesCommand.js +16 -0
- package/dist-es/commands/AssociateWorkspaceCommand.js +16 -0
- package/dist-es/commands/BatchCreateDataTableValueCommand.js +16 -0
- package/dist-es/commands/BatchDeleteDataTableValueCommand.js +16 -0
- package/dist-es/commands/BatchDescribeDataTableValueCommand.js +16 -0
- package/dist-es/commands/BatchUpdateDataTableValueCommand.js +16 -0
- package/dist-es/commands/CreateDataTableAttributeCommand.js +16 -0
- package/dist-es/commands/CreateDataTableCommand.js +16 -0
- package/dist-es/commands/CreateWorkspaceCommand.js +16 -0
- package/dist-es/commands/CreateWorkspacePageCommand.js +16 -0
- package/dist-es/commands/DeleteDataTableAttributeCommand.js +16 -0
- package/dist-es/commands/DeleteDataTableCommand.js +16 -0
- package/dist-es/commands/DeleteWorkspaceCommand.js +16 -0
- package/dist-es/commands/DeleteWorkspaceMediaCommand.js +16 -0
- package/dist-es/commands/DeleteWorkspacePageCommand.js +16 -0
- package/dist-es/commands/DescribeDataTableAttributeCommand.js +16 -0
- package/dist-es/commands/DescribeDataTableCommand.js +16 -0
- package/dist-es/commands/DescribeWorkspaceCommand.js +16 -0
- package/dist-es/commands/DisassociateSecurityProfilesCommand.js +16 -0
- package/dist-es/commands/DisassociateWorkspaceCommand.js +16 -0
- package/dist-es/commands/EvaluateDataTableValuesCommand.js +16 -0
- package/dist-es/commands/ImportWorkspaceMediaCommand.js +16 -0
- package/dist-es/commands/ListDataTableAttributesCommand.js +16 -0
- package/dist-es/commands/ListDataTablePrimaryValuesCommand.js +16 -0
- package/dist-es/commands/ListDataTableValuesCommand.js +16 -0
- package/dist-es/commands/ListDataTablesCommand.js +16 -0
- package/dist-es/commands/ListEntitySecurityProfilesCommand.js +16 -0
- package/dist-es/commands/ListSecurityProfileFlowModulesCommand.js +16 -0
- package/dist-es/commands/ListWorkspaceMediaCommand.js +16 -0
- package/dist-es/commands/ListWorkspacePagesCommand.js +16 -0
- package/dist-es/commands/ListWorkspacesCommand.js +16 -0
- package/dist-es/commands/SearchDataTablesCommand.js +16 -0
- package/dist-es/commands/SearchViewsCommand.js +16 -0
- package/dist-es/commands/SearchWorkspaceAssociationsCommand.js +16 -0
- package/dist-es/commands/SearchWorkspacesCommand.js +16 -0
- package/dist-es/commands/StartContactMediaProcessingCommand.js +16 -0
- package/dist-es/commands/StopContactMediaProcessingCommand.js +16 -0
- package/dist-es/commands/UpdateDataTableAttributeCommand.js +16 -0
- package/dist-es/commands/UpdateDataTableMetadataCommand.js +16 -0
- package/dist-es/commands/UpdateDataTablePrimaryValuesCommand.js +16 -0
- package/dist-es/commands/UpdateWorkspaceMetadataCommand.js +16 -0
- package/dist-es/commands/UpdateWorkspacePageCommand.js +16 -0
- package/dist-es/commands/UpdateWorkspaceThemeCommand.js +16 -0
- package/dist-es/commands/UpdateWorkspaceVisibilityCommand.js +16 -0
- package/dist-es/commands/index.js +44 -0
- package/dist-es/models/enums.js +103 -0
- package/dist-es/models/errors.js +14 -14
- package/dist-es/pagination/EvaluateDataTableValuesPaginator.js +4 -0
- package/dist-es/pagination/ListDataTableAttributesPaginator.js +4 -0
- package/dist-es/pagination/ListDataTablePrimaryValuesPaginator.js +4 -0
- package/dist-es/pagination/ListDataTableValuesPaginator.js +4 -0
- package/dist-es/pagination/ListDataTablesPaginator.js +4 -0
- package/dist-es/pagination/ListWorkspacePagesPaginator.js +4 -0
- package/dist-es/pagination/ListWorkspacesPaginator.js +4 -0
- package/dist-es/pagination/SearchDataTablesPaginator.js +4 -0
- package/dist-es/pagination/SearchViewsPaginator.js +4 -0
- package/dist-es/pagination/SearchWorkspaceAssociationsPaginator.js +4 -0
- package/dist-es/pagination/SearchWorkspacesPaginator.js +4 -0
- package/dist-es/pagination/index.js +11 -0
- package/dist-es/schemas/schemas_0.js +2407 -257
- package/dist-types/Connect.d.ts +320 -13
- package/dist-types/ConnectClient.d.ts +56 -15
- package/dist-types/commands/ActivateEvaluationFormCommand.d.ts +2 -2
- package/dist-types/commands/AssociateAnalyticsDataSetCommand.d.ts +2 -2
- package/dist-types/commands/AssociateBotCommand.d.ts +2 -2
- package/dist-types/commands/AssociateContactWithUserCommand.d.ts +14 -17
- package/dist-types/commands/AssociateDefaultVocabularyCommand.d.ts +2 -2
- package/dist-types/commands/AssociateEmailAddressAliasCommand.d.ts +21 -28
- package/dist-types/commands/AssociateInstanceStorageConfigCommand.d.ts +6 -6
- package/dist-types/commands/AssociateLambdaFunctionCommand.d.ts +1 -2
- package/dist-types/commands/AssociateLexBotCommand.d.ts +2 -2
- package/dist-types/commands/AssociatePhoneNumberContactFlowCommand.d.ts +5 -8
- package/dist-types/commands/AssociateSecurityProfilesCommand.d.ts +100 -0
- package/dist-types/commands/AssociateTrafficDistributionGroupUserCommand.d.ts +2 -2
- package/dist-types/commands/AssociateWorkspaceCommand.d.ts +110 -0
- package/dist-types/commands/BatchAssociateAnalyticsDataSetCommand.d.ts +2 -2
- package/dist-types/commands/BatchCreateDataTableValueCommand.d.ts +152 -0
- package/dist-types/commands/BatchDeleteDataTableValueCommand.d.ts +142 -0
- package/dist-types/commands/BatchDescribeDataTableValueCommand.d.ts +138 -0
- package/dist-types/commands/BatchDisassociateAnalyticsDataSetCommand.d.ts +2 -2
- package/dist-types/commands/BatchGetAttachedFileMetadataCommand.d.ts +2 -3
- package/dist-types/commands/BatchPutContactCommand.d.ts +6 -7
- package/dist-types/commands/BatchUpdateDataTableValueCommand.d.ts +145 -0
- package/dist-types/commands/ClaimPhoneNumberCommand.d.ts +8 -8
- package/dist-types/commands/CompleteAttachedFileUploadCommand.d.ts +2 -2
- package/dist-types/commands/CreateContactCommand.d.ts +12 -14
- package/dist-types/commands/CreateContactFlowModuleVersionCommand.d.ts +2 -1
- package/dist-types/commands/CreateContactFlowVersionCommand.d.ts +4 -5
- package/dist-types/commands/CreateDataTableAttributeCommand.d.ts +132 -0
- package/dist-types/commands/CreateDataTableCommand.d.ts +117 -0
- package/dist-types/commands/CreateEmailAddressCommand.d.ts +3 -3
- package/dist-types/commands/CreateEvaluationFormCommand.d.ts +69 -13
- package/dist-types/commands/CreateHoursOfOperationOverrideCommand.d.ts +1 -2
- package/dist-types/commands/CreateInstanceCommand.d.ts +5 -5
- package/dist-types/commands/CreateIntegrationAssociationCommand.d.ts +2 -3
- package/dist-types/commands/CreateParticipantCommand.d.ts +5 -5
- package/dist-types/commands/CreatePersistentContactAssociationCommand.d.ts +3 -3
- package/dist-types/commands/CreatePredefinedAttributeCommand.d.ts +11 -13
- package/dist-types/commands/CreatePromptCommand.d.ts +3 -3
- package/dist-types/commands/CreatePushNotificationRegistrationCommand.d.ts +2 -4
- package/dist-types/commands/CreateQueueCommand.d.ts +5 -6
- package/dist-types/commands/CreateQuickConnectCommand.d.ts +4 -1
- package/dist-types/commands/CreateRuleCommand.d.ts +3 -3
- package/dist-types/commands/CreateSecurityProfileCommand.d.ts +25 -4
- package/dist-types/commands/CreateTrafficDistributionGroupCommand.d.ts +2 -2
- package/dist-types/commands/CreateUserCommand.d.ts +5 -5
- package/dist-types/commands/CreateViewCommand.d.ts +8 -11
- package/dist-types/commands/CreateViewVersionCommand.d.ts +5 -7
- package/dist-types/commands/CreateVocabularyCommand.d.ts +3 -3
- package/dist-types/commands/CreateWorkspaceCommand.d.ts +190 -0
- package/dist-types/commands/CreateWorkspacePageCommand.d.ts +107 -0
- package/dist-types/commands/DeactivateEvaluationFormCommand.d.ts +2 -2
- package/dist-types/commands/DeleteAttachedFileCommand.d.ts +2 -2
- package/dist-types/commands/DeleteContactFlowModuleAliasCommand.d.ts +3 -2
- package/dist-types/commands/DeleteContactFlowModuleVersionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteContactFlowVersionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDataTableAttributeCommand.d.ts +103 -0
- package/dist-types/commands/DeleteDataTableCommand.d.ts +95 -0
- package/dist-types/commands/DeleteEmailAddressCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEvaluationFormCommand.d.ts +2 -3
- package/dist-types/commands/DeleteHoursOfOperationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteHoursOfOperationOverrideCommand.d.ts +2 -3
- package/dist-types/commands/DeleteInstanceCommand.d.ts +3 -4
- package/dist-types/commands/DeleteIntegrationAssociationCommand.d.ts +3 -3
- package/dist-types/commands/DeletePredefinedAttributeCommand.d.ts +4 -5
- package/dist-types/commands/DeletePromptCommand.d.ts +1 -1
- package/dist-types/commands/DeletePushNotificationRegistrationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteQueueCommand.d.ts +4 -5
- package/dist-types/commands/DeleteQuickConnectCommand.d.ts +5 -7
- package/dist-types/commands/DeleteRoutingProfileCommand.d.ts +4 -5
- package/dist-types/commands/DeleteRuleCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSecurityProfileCommand.d.ts +4 -5
- package/dist-types/commands/DeleteTaskTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteTrafficDistributionGroupCommand.d.ts +7 -9
- package/dist-types/commands/DeleteUseCaseCommand.d.ts +1 -1
- package/dist-types/commands/DeleteUserCommand.d.ts +7 -10
- package/dist-types/commands/DeleteUserHierarchyGroupCommand.d.ts +6 -7
- package/dist-types/commands/DeleteViewCommand.d.ts +5 -7
- package/dist-types/commands/DeleteViewVersionCommand.d.ts +4 -5
- package/dist-types/commands/DeleteVocabularyCommand.d.ts +4 -5
- package/dist-types/commands/DeleteWorkspaceCommand.d.ts +91 -0
- package/dist-types/commands/DeleteWorkspaceMediaCommand.d.ts +89 -0
- package/dist-types/commands/DeleteWorkspacePageCommand.d.ts +95 -0
- package/dist-types/commands/DescribeAgentStatusCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAuthenticationProfileCommand.d.ts +1 -1
- package/dist-types/commands/DescribeContactCommand.d.ts +35 -14
- package/dist-types/commands/DescribeContactEvaluationCommand.d.ts +85 -10
- package/dist-types/commands/DescribeContactFlowCommand.d.ts +8 -10
- package/dist-types/commands/DescribeContactFlowModuleAliasCommand.d.ts +2 -1
- package/dist-types/commands/DescribeContactFlowModuleCommand.d.ts +3 -4
- package/dist-types/commands/DescribeDataTableAttributeCommand.d.ts +129 -0
- package/dist-types/commands/DescribeDataTableCommand.d.ts +115 -0
- package/dist-types/commands/DescribeEvaluationFormCommand.d.ts +67 -11
- package/dist-types/commands/DescribeInstanceAttributeCommand.d.ts +2 -2
- package/dist-types/commands/DescribeInstanceCommand.d.ts +4 -5
- package/dist-types/commands/DescribeInstanceStorageConfigCommand.d.ts +2 -2
- package/dist-types/commands/DescribePhoneNumberCommand.d.ts +4 -7
- package/dist-types/commands/DescribePredefinedAttributeCommand.d.ts +10 -12
- package/dist-types/commands/DescribeQuickConnectCommand.d.ts +4 -1
- package/dist-types/commands/DescribeRoutingProfileCommand.d.ts +3 -2
- package/dist-types/commands/DescribeRuleCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSecurityProfileCommand.d.ts +18 -4
- package/dist-types/commands/DescribeUserCommand.d.ts +3 -2
- package/dist-types/commands/DescribeViewCommand.d.ts +4 -4
- package/dist-types/commands/DescribeWorkspaceCommand.d.ts +187 -0
- package/dist-types/commands/DisassociateBotCommand.d.ts +1 -2
- package/dist-types/commands/DisassociateEmailAddressAliasCommand.d.ts +24 -32
- package/dist-types/commands/DisassociateInstanceStorageConfigCommand.d.ts +1 -2
- package/dist-types/commands/DisassociateLambdaFunctionCommand.d.ts +1 -2
- package/dist-types/commands/DisassociateLexBotCommand.d.ts +1 -2
- package/dist-types/commands/DisassociatePhoneNumberContactFlowCommand.d.ts +5 -8
- package/dist-types/commands/DisassociateRoutingProfileQueuesCommand.d.ts +2 -2
- package/dist-types/commands/DisassociateSecurityProfilesCommand.d.ts +101 -0
- package/dist-types/commands/DisassociateTrafficDistributionGroupUserCommand.d.ts +2 -2
- package/dist-types/commands/DisassociateWorkspaceCommand.d.ts +107 -0
- package/dist-types/commands/DismissUserContactCommand.d.ts +3 -5
- package/dist-types/commands/EvaluateDataTableValuesCommand.d.ts +125 -0
- package/dist-types/commands/GetAttachedFileCommand.d.ts +2 -3
- package/dist-types/commands/GetContactMetricsCommand.d.ts +5 -8
- package/dist-types/commands/GetCurrentMetricDataCommand.d.ts +8 -10
- package/dist-types/commands/GetFederationTokenCommand.d.ts +6 -10
- package/dist-types/commands/GetMetricDataCommand.d.ts +6 -9
- package/dist-types/commands/GetMetricDataV2Command.d.ts +18 -16
- package/dist-types/commands/GetTaskTemplateCommand.d.ts +1 -2
- package/dist-types/commands/ImportPhoneNumberCommand.d.ts +14 -16
- package/dist-types/commands/ImportWorkspaceMediaCommand.d.ts +90 -0
- package/dist-types/commands/ListAnalyticsDataAssociationsCommand.d.ts +1 -2
- package/dist-types/commands/ListAnalyticsDataLakeDataSetsCommand.d.ts +1 -2
- package/dist-types/commands/ListAssociatedContactsCommand.d.ts +1 -2
- package/dist-types/commands/ListAuthenticationProfilesCommand.d.ts +2 -1
- package/dist-types/commands/ListBotsCommand.d.ts +3 -1
- package/dist-types/commands/ListContactEvaluationsCommand.d.ts +5 -0
- package/dist-types/commands/ListContactFlowModuleAliasesCommand.d.ts +2 -1
- package/dist-types/commands/ListContactFlowModulesCommand.d.ts +1 -2
- package/dist-types/commands/ListContactFlowVersionsCommand.d.ts +2 -3
- package/dist-types/commands/ListContactFlowsCommand.d.ts +4 -3
- package/dist-types/commands/ListContactReferencesCommand.d.ts +9 -5
- package/dist-types/commands/ListDataTableAttributesCommand.d.ts +136 -0
- package/dist-types/commands/ListDataTablePrimaryValuesCommand.d.ts +120 -0
- package/dist-types/commands/ListDataTableValuesCommand.d.ts +130 -0
- package/dist-types/commands/ListDataTablesCommand.d.ts +103 -0
- package/dist-types/commands/ListDefaultVocabulariesCommand.d.ts +1 -1
- package/dist-types/commands/ListEntitySecurityProfilesCommand.d.ts +98 -0
- package/dist-types/commands/ListEvaluationFormVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListEvaluationFormsCommand.d.ts +1 -1
- package/dist-types/commands/ListFlowAssociationsCommand.d.ts +1 -1
- package/dist-types/commands/ListHoursOfOperationOverridesCommand.d.ts +1 -1
- package/dist-types/commands/ListHoursOfOperationsCommand.d.ts +4 -5
- package/dist-types/commands/ListInstanceAttributesCommand.d.ts +2 -2
- package/dist-types/commands/ListInstanceStorageConfigsCommand.d.ts +2 -3
- package/dist-types/commands/ListInstancesCommand.d.ts +4 -4
- package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +4 -5
- package/dist-types/commands/ListLambdaFunctionsCommand.d.ts +3 -3
- package/dist-types/commands/ListLexBotsCommand.d.ts +3 -4
- package/dist-types/commands/ListPhoneNumbersCommand.d.ts +9 -13
- package/dist-types/commands/ListPhoneNumbersV2Command.d.ts +9 -11
- package/dist-types/commands/ListPredefinedAttributesCommand.d.ts +11 -13
- package/dist-types/commands/ListPromptsCommand.d.ts +1 -1
- package/dist-types/commands/ListQueueQuickConnectsCommand.d.ts +2 -2
- package/dist-types/commands/ListQueuesCommand.d.ts +6 -7
- package/dist-types/commands/ListQuickConnectsCommand.d.ts +4 -5
- package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +7 -8
- package/dist-types/commands/ListRoutingProfileManualAssignmentQueuesCommand.d.ts +8 -12
- package/dist-types/commands/ListRoutingProfileQueuesCommand.d.ts +1 -1
- package/dist-types/commands/ListRoutingProfilesCommand.d.ts +3 -5
- package/dist-types/commands/ListRulesCommand.d.ts +1 -1
- package/dist-types/commands/ListSecurityKeysCommand.d.ts +1 -2
- package/dist-types/commands/ListSecurityProfileApplicationsCommand.d.ts +2 -1
- package/dist-types/commands/ListSecurityProfileFlowModulesCommand.d.ts +100 -0
- package/dist-types/commands/ListSecurityProfilePermissionsCommand.d.ts +3 -4
- package/dist-types/commands/ListSecurityProfilesCommand.d.ts +3 -4
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -3
- package/dist-types/commands/ListUserHierarchyGroupsCommand.d.ts +2 -4
- package/dist-types/commands/ListUsersCommand.d.ts +1 -2
- package/dist-types/commands/ListViewVersionsCommand.d.ts +1 -2
- package/dist-types/commands/ListWorkspaceMediaCommand.d.ts +98 -0
- package/dist-types/commands/ListWorkspacePagesCommand.d.ts +103 -0
- package/dist-types/commands/ListWorkspacesCommand.d.ts +103 -0
- package/dist-types/commands/MonitorContactCommand.d.ts +2 -3
- package/dist-types/commands/PauseContactCommand.d.ts +2 -2
- package/dist-types/commands/PutUserStatusCommand.d.ts +4 -4
- package/dist-types/commands/ReleasePhoneNumberCommand.d.ts +9 -11
- package/dist-types/commands/ReplicateInstanceCommand.d.ts +4 -5
- package/dist-types/commands/ResumeContactCommand.d.ts +2 -2
- package/dist-types/commands/ResumeContactRecordingCommand.d.ts +3 -4
- package/dist-types/commands/SearchAvailablePhoneNumbersCommand.d.ts +3 -3
- package/dist-types/commands/SearchContactEvaluationsCommand.d.ts +10 -7
- package/dist-types/commands/SearchContactFlowsCommand.d.ts +18 -0
- package/dist-types/commands/SearchDataTablesCommand.d.ts +166 -0
- package/dist-types/commands/SearchEvaluationFormsCommand.d.ts +6 -5
- package/dist-types/commands/SearchHoursOfOperationsCommand.d.ts +1 -2
- package/dist-types/commands/SearchPredefinedAttributesCommand.d.ts +10 -12
- package/dist-types/commands/SearchQuickConnectsCommand.d.ts +4 -1
- package/dist-types/commands/SearchResourceTagsCommand.d.ts +2 -2
- package/dist-types/commands/SearchSecurityProfilesCommand.d.ts +4 -6
- package/dist-types/commands/SearchUserHierarchyGroupsCommand.d.ts +3 -4
- package/dist-types/commands/SearchViewsCommand.d.ts +173 -0
- package/dist-types/commands/SearchVocabulariesCommand.d.ts +2 -2
- package/dist-types/commands/SearchWorkspaceAssociationsCommand.d.ts +154 -0
- package/dist-types/commands/SearchWorkspacesCommand.d.ts +158 -0
- package/dist-types/commands/SendChatIntegrationEventCommand.d.ts +9 -10
- package/dist-types/commands/SendOutboundEmailCommand.d.ts +4 -4
- package/dist-types/commands/StartAttachedFileUploadCommand.d.ts +1 -3
- package/dist-types/commands/StartChatContactCommand.d.ts +13 -12
- package/dist-types/commands/StartContactEvaluationCommand.d.ts +4 -6
- package/dist-types/commands/StartContactMediaProcessingCommand.d.ts +97 -0
- package/dist-types/commands/StartContactRecordingCommand.d.ts +9 -11
- package/dist-types/commands/StartContactStreamingCommand.d.ts +2 -2
- package/dist-types/commands/StartEmailContactCommand.d.ts +3 -3
- package/dist-types/commands/StartOutboundChatContactCommand.d.ts +15 -15
- package/dist-types/commands/StartOutboundEmailContactCommand.d.ts +4 -3
- package/dist-types/commands/StartOutboundVoiceContactCommand.d.ts +17 -17
- package/dist-types/commands/StartScreenSharingCommand.d.ts +3 -4
- package/dist-types/commands/StartTaskContactCommand.d.ts +20 -25
- package/dist-types/commands/StartWebRTCContactCommand.d.ts +5 -4
- package/dist-types/commands/StopContactCommand.d.ts +4 -5
- package/dist-types/commands/StopContactMediaProcessingCommand.d.ts +91 -0
- package/dist-types/commands/StopContactRecordingCommand.d.ts +5 -6
- package/dist-types/commands/StopContactStreamingCommand.d.ts +2 -3
- package/dist-types/commands/SubmitContactEvaluationCommand.d.ts +10 -7
- package/dist-types/commands/SuspendContactRecordingCommand.d.ts +7 -7
- package/dist-types/commands/TagContactCommand.d.ts +3 -4
- package/dist-types/commands/TagResourceCommand.d.ts +5 -7
- package/dist-types/commands/TransferContactCommand.d.ts +7 -8
- package/dist-types/commands/UntagContactCommand.d.ts +3 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAgentStatusCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAuthenticationProfileCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactAttributesCommand.d.ts +9 -14
- package/dist-types/commands/UpdateContactCommand.d.ts +7 -9
- package/dist-types/commands/UpdateContactEvaluationCommand.d.ts +8 -5
- package/dist-types/commands/UpdateContactFlowContentCommand.d.ts +4 -5
- package/dist-types/commands/UpdateContactFlowMetadataCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactFlowModuleAliasCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactFlowModuleContentCommand.d.ts +4 -5
- package/dist-types/commands/UpdateContactFlowModuleMetadataCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactFlowNameCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactRoutingDataCommand.d.ts +9 -13
- package/dist-types/commands/UpdateContactScheduleCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataTableAttributeCommand.d.ts +132 -0
- package/dist-types/commands/UpdateDataTableMetadataCommand.d.ts +109 -0
- package/dist-types/commands/UpdateDataTablePrimaryValuesCommand.d.ts +120 -0
- package/dist-types/commands/UpdateEmailAddressMetadataCommand.d.ts +3 -3
- package/dist-types/commands/UpdateEvaluationFormCommand.d.ts +71 -16
- package/dist-types/commands/UpdateHoursOfOperationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateHoursOfOperationOverrideCommand.d.ts +1 -1
- package/dist-types/commands/UpdateInstanceAttributeCommand.d.ts +2 -2
- package/dist-types/commands/UpdateInstanceStorageConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateParticipantAuthenticationCommand.d.ts +11 -11
- package/dist-types/commands/UpdateParticipantRoleConfigCommand.d.ts +3 -3
- package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +9 -14
- package/dist-types/commands/UpdatePhoneNumberMetadataCommand.d.ts +4 -5
- package/dist-types/commands/UpdatePredefinedAttributeCommand.d.ts +12 -13
- package/dist-types/commands/UpdatePromptCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueHoursOfOperationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueMaxContactsCommand.d.ts +2 -3
- package/dist-types/commands/UpdateQueueNameCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueOutboundCallerConfigCommand.d.ts +7 -9
- package/dist-types/commands/UpdateQueueOutboundEmailConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueStatusCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQuickConnectConfigCommand.d.ts +5 -2
- package/dist-types/commands/UpdateQuickConnectNameCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRoutingProfileAgentAvailabilityTimerCommand.d.ts +3 -4
- package/dist-types/commands/UpdateRoutingProfileConcurrencyCommand.d.ts +2 -3
- package/dist-types/commands/UpdateRoutingProfileDefaultOutboundQueueCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRoutingProfileNameCommand.d.ts +2 -3
- package/dist-types/commands/UpdateRoutingProfileQueuesCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRuleCommand.d.ts +4 -4
- package/dist-types/commands/UpdateSecurityProfileCommand.d.ts +26 -5
- package/dist-types/commands/UpdateTaskTemplateCommand.d.ts +3 -4
- package/dist-types/commands/UpdateTrafficDistributionCommand.d.ts +6 -6
- package/dist-types/commands/UpdateUserHierarchyCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserHierarchyGroupNameCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserHierarchyStructureCommand.d.ts +4 -5
- package/dist-types/commands/UpdateUserIdentityInfoCommand.d.ts +6 -8
- package/dist-types/commands/UpdateUserPhoneConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserProficienciesCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserRoutingProfileCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserSecurityProfilesCommand.d.ts +1 -1
- package/dist-types/commands/UpdateViewContentCommand.d.ts +9 -11
- package/dist-types/commands/UpdateViewMetadataCommand.d.ts +6 -7
- package/dist-types/commands/UpdateWorkspaceMetadataCommand.d.ts +97 -0
- package/dist-types/commands/UpdateWorkspacePageCommand.d.ts +102 -0
- package/dist-types/commands/UpdateWorkspaceThemeCommand.d.ts +173 -0
- package/dist-types/commands/UpdateWorkspaceVisibilityCommand.d.ts +92 -0
- package/dist-types/commands/index.d.ts +44 -0
- package/dist-types/index.d.ts +10 -13
- package/dist-types/models/enums.d.ts +263 -0
- package/dist-types/models/errors.d.ts +22 -24
- package/dist-types/models/models_0.d.ts +2763 -2635
- package/dist-types/models/models_1.d.ts +5591 -6229
- package/dist-types/models/models_2.d.ts +3898 -3652
- package/dist-types/models/models_3.d.ts +4041 -284
- package/dist-types/pagination/EvaluateDataTableValuesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDataTableAttributesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDataTablePrimaryValuesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDataTableValuesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDataTablesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListWorkspacePagesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListWorkspacesPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchDataTablesPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchViewsPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchWorkspaceAssociationsPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchWorkspacesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +11 -0
- package/dist-types/schemas/schemas_0.d.ts +256 -0
- package/dist-types/ts3.4/Connect.d.ts +750 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +266 -2
- package/dist-types/ts3.4/commands/AssociateSecurityProfilesCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/AssociateWorkspaceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/BatchCreateDataTableValueCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/BatchDeleteDataTableValueCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/BatchDescribeDataTableValueCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/BatchUpdateDataTableValueCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateDataTableAttributeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateDataTableCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateWorkspaceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateWorkspacePageCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteContactFlowModuleAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteContactFlowModuleVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteContactFlowVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteDataTableAttributeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteDataTableCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteEmailAddressCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteEvaluationFormCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteHoursOfOperationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteHoursOfOperationOverrideCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteInstanceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteIntegrationAssociationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeletePredefinedAttributeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeletePromptCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeletePushNotificationRegistrationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteQueueCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteQuickConnectCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteRoutingProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteRuleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteSecurityProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteTaskTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteTrafficDistributionGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteUseCaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteUserHierarchyGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteViewCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteViewVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteWorkspaceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteWorkspaceMediaCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteWorkspacePageCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeAgentStatusCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeAuthenticationProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeContactEvaluationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDataTableAttributeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeDataTableCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeWorkspaceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DisassociateSecurityProfilesCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DisassociateWorkspaceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/EvaluateDataTableValuesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ImportWorkspaceMediaCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListContactFlowVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListContactFlowsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListContactReferencesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDataTableAttributesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListDataTablePrimaryValuesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListDataTableValuesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListDataTablesCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListDefaultVocabulariesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListEntitySecurityProfilesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListEvaluationFormVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListEvaluationFormsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListFlowAssociationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListHoursOfOperationOverridesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListHoursOfOperationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListInstanceAttributesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListInstanceStorageConfigsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListInstancesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIntegrationAssociationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListLambdaFunctionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListLexBotsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPhoneNumbersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPhoneNumbersV2Command.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPredefinedAttributesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPromptsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListQueueQuickConnectsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListQueuesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListQuickConnectsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRoutingProfileManualAssignmentQueuesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRoutingProfileQueuesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRoutingProfilesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRulesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSecurityKeysCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/ListSecurityProfileFlowModulesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListWorkspaceMediaCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListWorkspacePagesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListWorkspacesCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/SearchDataTablesCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/SearchViewsCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/SearchWorkspaceAssociationsCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/SearchWorkspacesCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/StartContactMediaProcessingCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartOutboundEmailContactCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartOutboundVoiceContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartScreenSharingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartTaskContactCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/StartWebRTCContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopContactMediaProcessingCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StopContactRecordingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopContactStreamingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SubmitContactEvaluationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SuspendContactRecordingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TransferContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAgentStatusCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAuthenticationProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactAttributesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/UpdateContactEvaluationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactFlowContentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactFlowMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactFlowModuleAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactFlowModuleContentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactFlowModuleMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactFlowNameCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContactRoutingDataCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/UpdateContactScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataTableAttributeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateDataTableMetadataCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateDataTablePrimaryValuesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateEmailAddressMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateEvaluationFormCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/UpdateHoursOfOperationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateHoursOfOperationOverrideCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateInstanceAttributeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateInstanceStorageConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateParticipantAuthenticationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateParticipantRoleConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePhoneNumberCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePhoneNumberMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePredefinedAttributeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePromptCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueHoursOfOperationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueMaxContactsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueNameCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueOutboundCallerConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueOutboundEmailConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueStatusCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQuickConnectConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQuickConnectNameCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRoutingProfileAgentAvailabilityTimerCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRoutingProfileConcurrencyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRoutingProfileDefaultOutboundQueueCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRoutingProfileNameCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRoutingProfileQueuesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRuleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateSecurityProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTaskTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTrafficDistributionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserHierarchyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserHierarchyGroupNameCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserHierarchyStructureCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserIdentityInfoCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserPhoneConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserProficienciesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserRoutingProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserSecurityProfilesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateViewContentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateViewMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateWorkspaceMetadataCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateWorkspacePageCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateWorkspaceThemeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateWorkspaceVisibilityCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +44 -0
- package/dist-types/ts3.4/models/enums.d.ts +137 -0
- package/dist-types/ts3.4/models/errors.d.ts +11 -11
- package/dist-types/ts3.4/models/models_0.d.ts +363 -276
- package/dist-types/ts3.4/models/models_1.d.ts +517 -761
- package/dist-types/ts3.4/models/models_2.d.ts +1467 -1247
- package/dist-types/ts3.4/models/models_3.d.ts +982 -29
- package/dist-types/ts3.4/pagination/EvaluateDataTableValuesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDataTableAttributesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDataTablePrimaryValuesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDataTableValuesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDataTablesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListWorkspacePagesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListWorkspacesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchDataTablesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchViewsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchWorkspaceAssociationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchWorkspacesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +11 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +256 -0
- package/package.json +5 -5
|
@@ -1,20 +1,3640 @@
|
|
|
1
|
-
import { AnsweringMachineDetectionStatus, Channel, ContactInitiationMethod, EvaluationFormVersionStatus, InitiateAs, RoutingCriteriaStepStatus } from "./enums";
|
|
2
|
-
import { AdditionalEmailRecipients, AgentInfo, AgentStatusSearchFilter, Campaign,
|
|
3
|
-
import { Evaluation } from "./models_1";
|
|
4
|
-
import {
|
|
1
|
+
import { AgentAvailabilityTimer, AgentStatusState, AnsweringMachineDetectionStatus, Channel, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactRecordingType, DataTableAttributeValueType, DataTableLockLevel, EvaluationFormItemEnablementAction, EvaluationFormItemEnablementOperator, EvaluationFormQuestionType, EvaluationFormVersionStatus, InitiateAs, InstanceAttributeType, InstanceStorageResourceType, MeetingFeatureStatus, ParticipantTimerAction, ParticipantTimerType, QueueStatus, RoutingCriteriaStepStatus, RulePublishStatus, SearchableQueueType, TaskTemplateStatus, TimerEligibleParticipantRoles, TrafficType, ViewStatus, ViewType, Visibility } from "./enums";
|
|
2
|
+
import { AdditionalEmailRecipients, AgentConfig, AgentInfo, AgentStatusSearchFilter, AllowedCapabilities, Application, Campaign, DataTableLockVersion, Endpoint, EvaluationFormAutoEvaluationConfiguration, EvaluationFormItemEnablementExpression, EvaluationFormLanguageConfiguration, EvaluationFormQuestionTypeProperties, EvaluationFormScoringStrategy, EvaluationFormTargetConfiguration, FlowModule, GranularAccessControlConfiguration, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InputPredefinedAttributeConfiguration, InstanceStorageConfig, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, OutboundStrategy, PredefinedAttributeValues, PrimaryValue, QuickConnectConfig, Reference, RoutingProfileQueueConfig, RuleAction, StringCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, UserIdentityInfo, UserInfo, UserPhoneConfig, UserProficiency, Validation, View, ViewInputContent, WorkspaceTheme } from "./models_0";
|
|
3
|
+
import { AttributeCondition, ChatMetrics, ContactDetails, ContactEvaluation, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, EvaluationAnswerData, EvaluationNote, Expiry, NextContactEntry, QualityMetrics, QueueInfo, RecordingInfo, SignInConfig, TaskTemplateInfoV2, TelephonyConfig, WisdomInfo } from "./models_1";
|
|
4
|
+
import { BooleanCondition, ChatMessage, ContactFlowModuleSearchFilter, ContactFlowSearchFilter, ContactSearchSummaryAgentInfo, ContactSearchSummaryQueueInfo, DataTableSearchFilter, DateCondition, DateTimeCondition, DecimalCondition, EmailAddressInfo, EmailAddressSearchFilter, EmailAttachment, EvaluationFormSearchFilter, EvaluationSearchFilter, HierarchyGroupCondition, HoursOfOperationSearchFilter, InboundAdditionalRecipients, InboundEmailContent, ListCondition, NumberCondition, ParticipantConfiguration, ParticipantDetails, PersistentChat, PromptSearchFilter, QueueSearchFilter, QuickConnectSearchFilter, RoutingProfileSearchFilter, SecurityProfilesSearchFilter, UserHierarchyGroupSearchFilter, UserSearchFilter, ViewSearchFilter, WorkspaceAssociationSearchFilter, WorkspaceSearchFilter } from "./models_2";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface StartOutboundEmailContactResponse {
|
|
9
|
+
/**
|
|
10
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
ContactId?: string | undefined;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* <p>Configuration of the answering machine detection.</p>
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
export interface AnswerMachineDetectionConfig {
|
|
20
|
+
/**
|
|
21
|
+
* <p>The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to
|
|
22
|
+
* <code>true</code>, <code>TrafficType</code> must be set as <code>CAMPAIGN</code>. </p>
|
|
23
|
+
* @public
|
|
24
|
+
*/
|
|
25
|
+
EnableAnswerMachineDetection?: boolean | undefined;
|
|
26
|
+
/**
|
|
27
|
+
* <p>Wait for the answering machine prompt.</p>
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
AwaitAnswerMachinePrompt?: boolean | undefined;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
export interface StartOutboundVoiceContactRequest {
|
|
36
|
+
/**
|
|
37
|
+
* <p>The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).</p>
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
Name?: string | undefined;
|
|
41
|
+
/**
|
|
42
|
+
* <p>A description of the voice contact that appears in the agent's snapshot in the CCP logs. For more information
|
|
43
|
+
* about CCP logs, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/download-ccp-logs.html">Download and
|
|
44
|
+
* review CCP logs</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
Description?: string | undefined;
|
|
48
|
+
/**
|
|
49
|
+
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following
|
|
50
|
+
* reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> |
|
|
51
|
+
* <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a supported reference type during voice
|
|
52
|
+
* contact creation.</p>
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
References?: Record<string, Reference> | undefined;
|
|
56
|
+
/**
|
|
57
|
+
* <p>The <code>contactId</code> that is related to this contact. Linking voice, task, or chat by using
|
|
58
|
+
* <code>RelatedContactID</code> copies over contact attributes from the related contact to the new contact. All
|
|
59
|
+
* updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits
|
|
60
|
+
* to the number of contacts that can be linked by using <code>RelatedContactId</code>. </p>
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
RelatedContactId?: string | undefined;
|
|
64
|
+
/**
|
|
65
|
+
* <p>The phone number of the customer, in E.164 format.</p>
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
DestinationPhoneNumber: string | undefined;
|
|
69
|
+
/**
|
|
70
|
+
* <p>The
|
|
71
|
+
* identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to
|
|
72
|
+
* <b>Routing</b>, <b>Contact Flows</b>. Choose the flow. On the
|
|
73
|
+
* flow page, under the name of the flow, choose <b>Show additional flow information</b>. The
|
|
74
|
+
* ContactFlowId is the last part of the ARN, shown here in bold: </p>
|
|
75
|
+
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
76
|
+
* </p>
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
ContactFlowId: string | undefined;
|
|
80
|
+
/**
|
|
81
|
+
* <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>
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
InstanceId: string | undefined;
|
|
85
|
+
/**
|
|
86
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
87
|
+
* request. If not provided, the Amazon Web Services
|
|
88
|
+
* SDK populates this field. For more information about idempotency, see
|
|
89
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>. The token is valid for 7 days after creation. If a contact is already started, the contact ID is
|
|
90
|
+
* returned.
|
|
91
|
+
* </p>
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
ClientToken?: string | undefined;
|
|
95
|
+
/**
|
|
96
|
+
* <p>The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a
|
|
97
|
+
* source phone number, you must specify a queue.</p>
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
SourcePhoneNumber?: string | undefined;
|
|
101
|
+
/**
|
|
102
|
+
* <p>The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified
|
|
103
|
+
* in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue,
|
|
104
|
+
* you must specify a source phone number.</p>
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
QueueId?: string | undefined;
|
|
108
|
+
/**
|
|
109
|
+
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and
|
|
110
|
+
* can be accessed in flows just like any other contact attributes.</p>
|
|
111
|
+
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only
|
|
112
|
+
* alphanumeric, dash, and underscore characters.</p>
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
Attributes?: Record<string, string> | undefined;
|
|
116
|
+
/**
|
|
117
|
+
* <p>Configuration of the answering machine detection for this outbound call. </p>
|
|
118
|
+
* @public
|
|
119
|
+
*/
|
|
120
|
+
AnswerMachineDetectionConfig?: AnswerMachineDetectionConfig | undefined;
|
|
121
|
+
/**
|
|
122
|
+
* <p>The campaign identifier of the outbound communication.</p>
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
CampaignId?: string | undefined;
|
|
126
|
+
/**
|
|
127
|
+
* <p>Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect.
|
|
128
|
+
* The default value is <code>GENERAL</code>. Use <code>CAMPAIGN</code> if <code>EnableAnswerMachineDetection</code> is
|
|
129
|
+
* set to <code>true</code>. For all other cases, use <code>GENERAL</code>. </p>
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
TrafficType?: TrafficType | undefined;
|
|
133
|
+
/**
|
|
134
|
+
* <p>Information about the outbound strategy.</p>
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
OutboundStrategy?: OutboundStrategy | undefined;
|
|
138
|
+
/**
|
|
139
|
+
* <p>The maximum time the outbound call will wait for the destination to answer the call, in seconds </p>
|
|
140
|
+
* @public
|
|
141
|
+
*/
|
|
142
|
+
RingTimeoutInSeconds?: number | undefined;
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* @public
|
|
146
|
+
*/
|
|
147
|
+
export interface StartOutboundVoiceContactResponse {
|
|
148
|
+
/**
|
|
149
|
+
* <p>The identifier of this contact within the Amazon Connect instance.</p>
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
ContactId?: string | undefined;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* @public
|
|
156
|
+
*/
|
|
157
|
+
export interface StartScreenSharingRequest {
|
|
158
|
+
/**
|
|
159
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
160
|
+
* request. If not provided, the Amazon Web Services
|
|
161
|
+
* SDK populates this field. For more information about idempotency, see
|
|
162
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
ClientToken?: string | undefined;
|
|
166
|
+
/**
|
|
167
|
+
* <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>
|
|
168
|
+
* @public
|
|
169
|
+
*/
|
|
170
|
+
InstanceId: string | undefined;
|
|
171
|
+
/**
|
|
172
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
175
|
+
ContactId: string | undefined;
|
|
176
|
+
}
|
|
177
|
+
/**
|
|
178
|
+
* @public
|
|
179
|
+
*/
|
|
180
|
+
export interface StartScreenSharingResponse {
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* @public
|
|
184
|
+
*/
|
|
185
|
+
export interface StartTaskContactResponse {
|
|
186
|
+
/**
|
|
187
|
+
* <p>The identifier of this contact within the Amazon Connect instance.</p>
|
|
188
|
+
* @public
|
|
189
|
+
*/
|
|
190
|
+
ContactId?: string | undefined;
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* @public
|
|
194
|
+
*/
|
|
195
|
+
export interface StartWebRTCContactRequest {
|
|
196
|
+
/**
|
|
197
|
+
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and
|
|
198
|
+
* can be accessed in flows just like any other contact attributes.</p>
|
|
199
|
+
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only
|
|
200
|
+
* alphanumeric, -, and _ characters.</p>
|
|
201
|
+
* @public
|
|
202
|
+
*/
|
|
203
|
+
Attributes?: Record<string, string> | undefined;
|
|
204
|
+
/**
|
|
205
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
206
|
+
* request. If not provided, the Amazon Web Services
|
|
207
|
+
* SDK populates this field. For more information about idempotency, see
|
|
208
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
209
|
+
* <p>The token is valid for 7 days after creation. If a contact is already started, the contact ID is
|
|
210
|
+
* returned.</p>
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
213
|
+
ClientToken?: string | undefined;
|
|
214
|
+
/**
|
|
215
|
+
* <p>The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to
|
|
216
|
+
* <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page,
|
|
217
|
+
* under the name of the flow, choose <b>Show additional flow information</b>. The
|
|
218
|
+
* ContactFlowId is the last part of the ARN, shown here in bold: </p>
|
|
219
|
+
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
220
|
+
* </p>
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
ContactFlowId: string | undefined;
|
|
224
|
+
/**
|
|
225
|
+
* <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>
|
|
226
|
+
* @public
|
|
227
|
+
*/
|
|
228
|
+
InstanceId: string | undefined;
|
|
229
|
+
/**
|
|
230
|
+
* <p>Information about the video sharing capabilities of the participants (customer, agent).</p>
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
AllowedCapabilities?: AllowedCapabilities | undefined;
|
|
234
|
+
/**
|
|
235
|
+
* <p>The customer's details.</p>
|
|
236
|
+
* @public
|
|
237
|
+
*/
|
|
238
|
+
ParticipantDetails: ParticipantDetails | undefined;
|
|
239
|
+
/**
|
|
240
|
+
* <p>The unique identifier for an Amazon Connect contact. This identifier is related to the contact
|
|
241
|
+
* starting.</p>
|
|
242
|
+
* @public
|
|
243
|
+
*/
|
|
244
|
+
RelatedContactId?: string | undefined;
|
|
245
|
+
/**
|
|
246
|
+
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following
|
|
247
|
+
* reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> |
|
|
248
|
+
* <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a supported reference type during task
|
|
249
|
+
* creation.</p>
|
|
250
|
+
* @public
|
|
251
|
+
*/
|
|
252
|
+
References?: Record<string, Reference> | undefined;
|
|
253
|
+
/**
|
|
254
|
+
* <p>A description of the task that is shown to an agent in the Contact Control Panel (CCP).</p>
|
|
255
|
+
* @public
|
|
256
|
+
*/
|
|
257
|
+
Description?: string | undefined;
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* <p>The attendee information, including attendee ID and join token.</p>
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
export interface Attendee {
|
|
264
|
+
/**
|
|
265
|
+
* <p>The Amazon Chime SDK attendee ID.</p>
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
AttendeeId?: string | undefined;
|
|
269
|
+
/**
|
|
270
|
+
* <p>The join token used by the Amazon Chime SDK attendee.</p>
|
|
271
|
+
* @public
|
|
272
|
+
*/
|
|
273
|
+
JoinToken?: string | undefined;
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
* <p>A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK
|
|
277
|
+
* meeting.</p>
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
280
|
+
export interface MediaPlacement {
|
|
281
|
+
/**
|
|
282
|
+
* <p>The audio host URL.</p>
|
|
283
|
+
* @public
|
|
284
|
+
*/
|
|
285
|
+
AudioHostUrl?: string | undefined;
|
|
286
|
+
/**
|
|
287
|
+
* <p>The audio fallback URL.</p>
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
AudioFallbackUrl?: string | undefined;
|
|
291
|
+
/**
|
|
292
|
+
* <p>The signaling URL.</p>
|
|
293
|
+
* @public
|
|
294
|
+
*/
|
|
295
|
+
SignalingUrl?: string | undefined;
|
|
296
|
+
/**
|
|
297
|
+
* <p>The turn control URL.</p>
|
|
298
|
+
* @public
|
|
299
|
+
*/
|
|
300
|
+
TurnControlUrl?: string | undefined;
|
|
301
|
+
/**
|
|
302
|
+
* <p>The event ingestion URL to which you send client meeting events.</p>
|
|
303
|
+
* @public
|
|
304
|
+
*/
|
|
305
|
+
EventIngestionUrl?: string | undefined;
|
|
306
|
+
}
|
|
307
|
+
/**
|
|
308
|
+
* <p>Has audio-specific configurations as the operating parameter for Echo Reduction.</p>
|
|
309
|
+
* @public
|
|
310
|
+
*/
|
|
311
|
+
export interface AudioFeatures {
|
|
312
|
+
/**
|
|
313
|
+
* <p>Makes echo reduction available to clients who connect to the meeting.</p>
|
|
314
|
+
* @public
|
|
315
|
+
*/
|
|
316
|
+
EchoReduction?: MeetingFeatureStatus | undefined;
|
|
317
|
+
}
|
|
318
|
+
/**
|
|
319
|
+
* <p>The configuration settings of the features available to a meeting.</p>
|
|
320
|
+
* @public
|
|
321
|
+
*/
|
|
322
|
+
export interface MeetingFeaturesConfiguration {
|
|
323
|
+
/**
|
|
324
|
+
* <p>The configuration settings for the audio features available to a meeting.</p>
|
|
325
|
+
* @public
|
|
326
|
+
*/
|
|
327
|
+
Audio?: AudioFeatures | undefined;
|
|
328
|
+
}
|
|
329
|
+
/**
|
|
330
|
+
* <p>A meeting created using the Amazon Chime SDK.</p>
|
|
331
|
+
* @public
|
|
332
|
+
*/
|
|
333
|
+
export interface Meeting {
|
|
334
|
+
/**
|
|
335
|
+
* <p>The Amazon Web Services Region in which you create the meeting.</p>
|
|
336
|
+
* @public
|
|
337
|
+
*/
|
|
338
|
+
MediaRegion?: string | undefined;
|
|
339
|
+
/**
|
|
340
|
+
* <p>The media placement for the meeting.</p>
|
|
341
|
+
* @public
|
|
342
|
+
*/
|
|
343
|
+
MediaPlacement?: MediaPlacement | undefined;
|
|
344
|
+
/**
|
|
345
|
+
* <p>The configuration settings of the features available to a meeting.</p>
|
|
346
|
+
* @public
|
|
347
|
+
*/
|
|
348
|
+
MeetingFeatures?: MeetingFeaturesConfiguration | undefined;
|
|
349
|
+
/**
|
|
350
|
+
* <p>The Amazon Chime SDK meeting ID.</p>
|
|
351
|
+
* @public
|
|
352
|
+
*/
|
|
353
|
+
MeetingId?: string | undefined;
|
|
354
|
+
}
|
|
355
|
+
/**
|
|
356
|
+
* <p>Information required to join the call.</p>
|
|
357
|
+
* @public
|
|
358
|
+
*/
|
|
359
|
+
export interface ConnectionData {
|
|
360
|
+
/**
|
|
361
|
+
* <p>The attendee information, including attendee ID and join token.</p>
|
|
362
|
+
* @public
|
|
363
|
+
*/
|
|
364
|
+
Attendee?: Attendee | undefined;
|
|
365
|
+
/**
|
|
366
|
+
* <p>A meeting created using the Amazon Chime SDK.</p>
|
|
367
|
+
* @public
|
|
368
|
+
*/
|
|
369
|
+
Meeting?: Meeting | undefined;
|
|
370
|
+
}
|
|
371
|
+
/**
|
|
372
|
+
* @public
|
|
373
|
+
*/
|
|
374
|
+
export interface StartWebRTCContactResponse {
|
|
375
|
+
/**
|
|
376
|
+
* <p>Information required for the client application (mobile application or website) to connect to the call.</p>
|
|
377
|
+
* @public
|
|
378
|
+
*/
|
|
379
|
+
ConnectionData?: ConnectionData | undefined;
|
|
380
|
+
/**
|
|
381
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
382
|
+
* @public
|
|
383
|
+
*/
|
|
384
|
+
ContactId?: string | undefined;
|
|
385
|
+
/**
|
|
386
|
+
* <p>The identifier for a contact participant. The <code>ParticipantId</code> for a contact participant is the same
|
|
387
|
+
* throughout the contact lifecycle.</p>
|
|
388
|
+
* @public
|
|
389
|
+
*/
|
|
390
|
+
ParticipantId?: string | undefined;
|
|
391
|
+
/**
|
|
392
|
+
* <p>The token used by the contact participant to call the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> API. The participant token is valid for the lifetime of a contact
|
|
393
|
+
* participant.</p>
|
|
394
|
+
* @public
|
|
395
|
+
*/
|
|
396
|
+
ParticipantToken?: string | undefined;
|
|
397
|
+
}
|
|
398
|
+
/**
|
|
399
|
+
* <p>Contains details about why a contact was disconnected. Only Amazon Connect outbound campaigns can provide
|
|
400
|
+
* this field.</p>
|
|
401
|
+
* @public
|
|
402
|
+
*/
|
|
403
|
+
export interface DisconnectReason {
|
|
404
|
+
/**
|
|
405
|
+
* <p>A code that indicates how the contact was terminated.</p>
|
|
406
|
+
* @public
|
|
407
|
+
*/
|
|
408
|
+
Code?: string | undefined;
|
|
409
|
+
}
|
|
410
|
+
/**
|
|
411
|
+
* @public
|
|
412
|
+
*/
|
|
413
|
+
export interface StopContactRequest {
|
|
414
|
+
/**
|
|
415
|
+
* <p>The ID of the contact.</p>
|
|
416
|
+
* @public
|
|
417
|
+
*/
|
|
418
|
+
ContactId: string | undefined;
|
|
419
|
+
/**
|
|
420
|
+
* <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>
|
|
421
|
+
* @public
|
|
422
|
+
*/
|
|
423
|
+
InstanceId: string | undefined;
|
|
424
|
+
/**
|
|
425
|
+
* <p>The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can provide this field. For
|
|
426
|
+
* a list and description of all the possible disconnect reasons by channel (including outbound campaign voice contacts)
|
|
427
|
+
* see DisconnectReason under <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the
|
|
428
|
+
* <i>Amazon Connect Administrator Guide</i>. </p>
|
|
429
|
+
* @public
|
|
430
|
+
*/
|
|
431
|
+
DisconnectReason?: DisconnectReason | undefined;
|
|
432
|
+
}
|
|
433
|
+
/**
|
|
434
|
+
* @public
|
|
435
|
+
*/
|
|
436
|
+
export interface StopContactResponse {
|
|
437
|
+
}
|
|
438
|
+
/**
|
|
439
|
+
* @public
|
|
440
|
+
*/
|
|
441
|
+
export interface StopContactMediaProcessingRequest {
|
|
442
|
+
/**
|
|
443
|
+
* <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>
|
|
444
|
+
* @public
|
|
445
|
+
*/
|
|
446
|
+
InstanceId?: string | undefined;
|
|
447
|
+
/**
|
|
448
|
+
* <p> The identifier of the contact. </p>
|
|
449
|
+
* @public
|
|
450
|
+
*/
|
|
451
|
+
ContactId?: string | undefined;
|
|
452
|
+
}
|
|
453
|
+
/**
|
|
454
|
+
* @public
|
|
455
|
+
*/
|
|
456
|
+
export interface StopContactMediaProcessingResponse {
|
|
457
|
+
}
|
|
458
|
+
/**
|
|
459
|
+
* @public
|
|
460
|
+
*/
|
|
461
|
+
export interface StopContactRecordingRequest {
|
|
462
|
+
/**
|
|
463
|
+
* <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>
|
|
464
|
+
* @public
|
|
465
|
+
*/
|
|
466
|
+
InstanceId: string | undefined;
|
|
467
|
+
/**
|
|
468
|
+
* <p>The identifier of the contact.</p>
|
|
469
|
+
* @public
|
|
470
|
+
*/
|
|
471
|
+
ContactId: string | undefined;
|
|
472
|
+
/**
|
|
473
|
+
* <p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with
|
|
474
|
+
* the contact center.</p>
|
|
475
|
+
* @public
|
|
476
|
+
*/
|
|
477
|
+
InitialContactId: string | undefined;
|
|
478
|
+
/**
|
|
479
|
+
* <p>The type of recording being operated on.</p>
|
|
480
|
+
* @public
|
|
481
|
+
*/
|
|
482
|
+
ContactRecordingType?: ContactRecordingType | undefined;
|
|
483
|
+
}
|
|
484
|
+
/**
|
|
485
|
+
* @public
|
|
486
|
+
*/
|
|
487
|
+
export interface StopContactRecordingResponse {
|
|
488
|
+
}
|
|
489
|
+
/**
|
|
490
|
+
* @public
|
|
491
|
+
*/
|
|
492
|
+
export interface StopContactStreamingRequest {
|
|
493
|
+
/**
|
|
494
|
+
* <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>
|
|
495
|
+
* @public
|
|
496
|
+
*/
|
|
497
|
+
InstanceId: string | undefined;
|
|
498
|
+
/**
|
|
499
|
+
* <p>The identifier of the contact. This is the identifier of the contact that is associated with the first
|
|
500
|
+
* interaction with the contact center.</p>
|
|
501
|
+
* @public
|
|
502
|
+
*/
|
|
503
|
+
ContactId: string | undefined;
|
|
504
|
+
/**
|
|
505
|
+
* <p>The identifier of the streaming configuration enabled. </p>
|
|
506
|
+
* @public
|
|
507
|
+
*/
|
|
508
|
+
StreamingId: string | undefined;
|
|
509
|
+
}
|
|
510
|
+
/**
|
|
511
|
+
* @public
|
|
512
|
+
*/
|
|
513
|
+
export interface StopContactStreamingResponse {
|
|
514
|
+
}
|
|
515
|
+
/**
|
|
516
|
+
* <p>Information about input answers for a contact evaluation.</p>
|
|
517
|
+
* @public
|
|
518
|
+
*/
|
|
519
|
+
export interface EvaluationAnswerInput {
|
|
520
|
+
/**
|
|
521
|
+
* <p>The value for an answer in a contact evaluation.</p>
|
|
522
|
+
* @public
|
|
523
|
+
*/
|
|
524
|
+
Value?: EvaluationAnswerData | undefined;
|
|
525
|
+
}
|
|
526
|
+
/**
|
|
527
|
+
* <p>Represents the entity that performed the action on the evaluation.</p>
|
|
528
|
+
* @public
|
|
529
|
+
*/
|
|
530
|
+
export type EvaluatorUserUnion = EvaluatorUserUnion.ConnectUserArnMember | EvaluatorUserUnion.$UnknownMember;
|
|
531
|
+
/**
|
|
532
|
+
* @public
|
|
533
|
+
*/
|
|
534
|
+
export declare namespace EvaluatorUserUnion {
|
|
535
|
+
/**
|
|
536
|
+
* <p>Represents the Amazon Connect ARN of the user.</p>
|
|
537
|
+
* @public
|
|
538
|
+
*/
|
|
539
|
+
interface ConnectUserArnMember {
|
|
540
|
+
ConnectUserArn: string;
|
|
541
|
+
$unknown?: never;
|
|
542
|
+
}
|
|
543
|
+
/**
|
|
544
|
+
* @public
|
|
545
|
+
*/
|
|
546
|
+
interface $UnknownMember {
|
|
547
|
+
ConnectUserArn?: never;
|
|
548
|
+
$unknown: [string, any];
|
|
549
|
+
}
|
|
550
|
+
/**
|
|
551
|
+
* @deprecated unused in schema-serde mode.
|
|
552
|
+
*
|
|
553
|
+
*/
|
|
554
|
+
interface Visitor<T> {
|
|
555
|
+
ConnectUserArn: (value: string) => T;
|
|
556
|
+
_: (name: string, value: any) => T;
|
|
557
|
+
}
|
|
558
|
+
}
|
|
559
|
+
/**
|
|
560
|
+
* @public
|
|
561
|
+
*/
|
|
562
|
+
export interface SubmitContactEvaluationRequest {
|
|
563
|
+
/**
|
|
564
|
+
* <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>
|
|
565
|
+
* @public
|
|
566
|
+
*/
|
|
567
|
+
InstanceId: string | undefined;
|
|
568
|
+
/**
|
|
569
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
570
|
+
* @public
|
|
571
|
+
*/
|
|
572
|
+
EvaluationId: string | undefined;
|
|
573
|
+
/**
|
|
574
|
+
* <p>A map of question identifiers to answer value.</p>
|
|
575
|
+
* @public
|
|
576
|
+
*/
|
|
577
|
+
Answers?: Record<string, EvaluationAnswerInput> | undefined;
|
|
578
|
+
/**
|
|
579
|
+
* <p>A map of question identifiers to note value.</p>
|
|
580
|
+
* @public
|
|
581
|
+
*/
|
|
582
|
+
Notes?: Record<string, EvaluationNote> | undefined;
|
|
583
|
+
/**
|
|
584
|
+
* <p>The ID of the user who submitted the contact evaluation.</p>
|
|
585
|
+
* @public
|
|
586
|
+
*/
|
|
587
|
+
SubmittedBy?: EvaluatorUserUnion | undefined;
|
|
588
|
+
}
|
|
589
|
+
/**
|
|
590
|
+
* @public
|
|
591
|
+
*/
|
|
592
|
+
export interface SubmitContactEvaluationResponse {
|
|
593
|
+
/**
|
|
594
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
595
|
+
* @public
|
|
596
|
+
*/
|
|
597
|
+
EvaluationId: string | undefined;
|
|
598
|
+
/**
|
|
599
|
+
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
600
|
+
* @public
|
|
601
|
+
*/
|
|
602
|
+
EvaluationArn: string | undefined;
|
|
603
|
+
}
|
|
604
|
+
/**
|
|
605
|
+
* @public
|
|
606
|
+
*/
|
|
607
|
+
export interface SuspendContactRecordingRequest {
|
|
608
|
+
/**
|
|
609
|
+
* <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>
|
|
610
|
+
* @public
|
|
611
|
+
*/
|
|
612
|
+
InstanceId: string | undefined;
|
|
613
|
+
/**
|
|
614
|
+
* <p>The identifier of the contact.</p>
|
|
615
|
+
* @public
|
|
616
|
+
*/
|
|
617
|
+
ContactId: string | undefined;
|
|
618
|
+
/**
|
|
619
|
+
* <p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with
|
|
620
|
+
* the contact center.</p>
|
|
621
|
+
* @public
|
|
622
|
+
*/
|
|
623
|
+
InitialContactId: string | undefined;
|
|
624
|
+
/**
|
|
625
|
+
* <p>The type of recording being operated on.</p>
|
|
626
|
+
* @public
|
|
627
|
+
*/
|
|
628
|
+
ContactRecordingType?: ContactRecordingType | undefined;
|
|
629
|
+
}
|
|
630
|
+
/**
|
|
631
|
+
* @public
|
|
632
|
+
*/
|
|
633
|
+
export interface SuspendContactRecordingResponse {
|
|
634
|
+
}
|
|
635
|
+
/**
|
|
636
|
+
* @public
|
|
637
|
+
*/
|
|
638
|
+
export interface TagContactRequest {
|
|
639
|
+
/**
|
|
640
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
641
|
+
* @public
|
|
642
|
+
*/
|
|
643
|
+
ContactId: string | undefined;
|
|
644
|
+
/**
|
|
645
|
+
* <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>
|
|
646
|
+
* @public
|
|
647
|
+
*/
|
|
648
|
+
InstanceId: string | undefined;
|
|
649
|
+
/**
|
|
650
|
+
* <p>The tags to be assigned to the contact resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\}
|
|
651
|
+
* \}.</p>
|
|
652
|
+
* <note>
|
|
653
|
+
* <p>Authorization is not supported by this tag.</p>
|
|
654
|
+
* </note>
|
|
655
|
+
* @public
|
|
656
|
+
*/
|
|
657
|
+
Tags: Record<string, string> | undefined;
|
|
658
|
+
}
|
|
659
|
+
/**
|
|
660
|
+
* @public
|
|
661
|
+
*/
|
|
662
|
+
export interface TagContactResponse {
|
|
663
|
+
}
|
|
664
|
+
/**
|
|
665
|
+
* @public
|
|
666
|
+
*/
|
|
667
|
+
export interface TagResourceRequest {
|
|
668
|
+
/**
|
|
669
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
670
|
+
* @public
|
|
671
|
+
*/
|
|
672
|
+
resourceArn: string | undefined;
|
|
673
|
+
/**
|
|
674
|
+
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
675
|
+
* @public
|
|
676
|
+
*/
|
|
677
|
+
tags: Record<string, string> | undefined;
|
|
678
|
+
}
|
|
679
|
+
/**
|
|
680
|
+
* @public
|
|
681
|
+
*/
|
|
682
|
+
export interface TransferContactRequest {
|
|
683
|
+
/**
|
|
684
|
+
* <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>
|
|
685
|
+
* @public
|
|
686
|
+
*/
|
|
687
|
+
InstanceId: string | undefined;
|
|
688
|
+
/**
|
|
689
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
690
|
+
* @public
|
|
691
|
+
*/
|
|
692
|
+
ContactId: string | undefined;
|
|
693
|
+
/**
|
|
694
|
+
* <p>The identifier for the queue.</p>
|
|
695
|
+
* @public
|
|
696
|
+
*/
|
|
697
|
+
QueueId?: string | undefined;
|
|
698
|
+
/**
|
|
699
|
+
* <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
|
|
700
|
+
* @public
|
|
701
|
+
*/
|
|
702
|
+
UserId?: string | undefined;
|
|
703
|
+
/**
|
|
704
|
+
* <p>The identifier of the flow.</p>
|
|
705
|
+
* @public
|
|
706
|
+
*/
|
|
707
|
+
ContactFlowId: string | undefined;
|
|
708
|
+
/**
|
|
709
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
710
|
+
* request. If not provided, the Amazon Web Services
|
|
711
|
+
* SDK populates this field. For more information about idempotency, see
|
|
712
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
713
|
+
* @public
|
|
714
|
+
*/
|
|
715
|
+
ClientToken?: string | undefined;
|
|
716
|
+
}
|
|
717
|
+
/**
|
|
718
|
+
* @public
|
|
719
|
+
*/
|
|
720
|
+
export interface TransferContactResponse {
|
|
721
|
+
/**
|
|
722
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
723
|
+
* @public
|
|
724
|
+
*/
|
|
725
|
+
ContactId?: string | undefined;
|
|
726
|
+
/**
|
|
727
|
+
* <p>The Amazon Resource Name (ARN) of the contact.</p>
|
|
728
|
+
* @public
|
|
729
|
+
*/
|
|
730
|
+
ContactArn?: string | undefined;
|
|
731
|
+
}
|
|
732
|
+
/**
|
|
733
|
+
* @public
|
|
734
|
+
*/
|
|
735
|
+
export interface UntagContactRequest {
|
|
736
|
+
/**
|
|
737
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
738
|
+
* @public
|
|
739
|
+
*/
|
|
740
|
+
ContactId: string | undefined;
|
|
741
|
+
/**
|
|
742
|
+
* <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>
|
|
743
|
+
* @public
|
|
744
|
+
*/
|
|
745
|
+
InstanceId: string | undefined;
|
|
746
|
+
/**
|
|
747
|
+
* <p>A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed.</p>
|
|
748
|
+
* @public
|
|
749
|
+
*/
|
|
750
|
+
TagKeys: string[] | undefined;
|
|
751
|
+
}
|
|
752
|
+
/**
|
|
753
|
+
* @public
|
|
754
|
+
*/
|
|
755
|
+
export interface UntagContactResponse {
|
|
756
|
+
}
|
|
757
|
+
/**
|
|
758
|
+
* @public
|
|
759
|
+
*/
|
|
760
|
+
export interface UntagResourceRequest {
|
|
761
|
+
/**
|
|
762
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
763
|
+
* @public
|
|
764
|
+
*/
|
|
765
|
+
resourceArn: string | undefined;
|
|
766
|
+
/**
|
|
767
|
+
* <p>The tag keys.</p>
|
|
768
|
+
* @public
|
|
769
|
+
*/
|
|
770
|
+
tagKeys: string[] | undefined;
|
|
771
|
+
}
|
|
772
|
+
/**
|
|
773
|
+
* @public
|
|
774
|
+
*/
|
|
775
|
+
export interface UpdateAgentStatusRequest {
|
|
776
|
+
/**
|
|
777
|
+
* <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>
|
|
778
|
+
* @public
|
|
779
|
+
*/
|
|
780
|
+
InstanceId: string | undefined;
|
|
781
|
+
/**
|
|
782
|
+
* <p>The identifier of the agent status.</p>
|
|
783
|
+
* @public
|
|
784
|
+
*/
|
|
785
|
+
AgentStatusId: string | undefined;
|
|
786
|
+
/**
|
|
787
|
+
* <p>The name of the agent status.</p>
|
|
788
|
+
* @public
|
|
789
|
+
*/
|
|
790
|
+
Name?: string | undefined;
|
|
791
|
+
/**
|
|
792
|
+
* <p>The description of the agent status.</p>
|
|
793
|
+
* @public
|
|
794
|
+
*/
|
|
795
|
+
Description?: string | undefined;
|
|
796
|
+
/**
|
|
797
|
+
* <p>The state of the agent status.</p>
|
|
798
|
+
* @public
|
|
799
|
+
*/
|
|
800
|
+
State?: AgentStatusState | undefined;
|
|
801
|
+
/**
|
|
802
|
+
* <p>The display order of the agent status.</p>
|
|
803
|
+
* @public
|
|
804
|
+
*/
|
|
805
|
+
DisplayOrder?: number | undefined;
|
|
806
|
+
/**
|
|
807
|
+
* <p>A number indicating the reset order of the agent status.</p>
|
|
808
|
+
* @public
|
|
809
|
+
*/
|
|
810
|
+
ResetOrderNumber?: boolean | undefined;
|
|
811
|
+
}
|
|
812
|
+
/**
|
|
813
|
+
* @public
|
|
814
|
+
*/
|
|
815
|
+
export interface UpdateAuthenticationProfileRequest {
|
|
816
|
+
/**
|
|
817
|
+
* <p>A unique identifier for the authentication profile. </p>
|
|
818
|
+
* @public
|
|
819
|
+
*/
|
|
820
|
+
AuthenticationProfileId: string | undefined;
|
|
821
|
+
/**
|
|
822
|
+
* <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>
|
|
823
|
+
* @public
|
|
824
|
+
*/
|
|
825
|
+
InstanceId: string | undefined;
|
|
826
|
+
/**
|
|
827
|
+
* <p>The name for the authentication profile.</p>
|
|
828
|
+
* @public
|
|
829
|
+
*/
|
|
830
|
+
Name?: string | undefined;
|
|
831
|
+
/**
|
|
832
|
+
* <p>The description for the authentication profile.</p>
|
|
833
|
+
* @public
|
|
834
|
+
*/
|
|
835
|
+
Description?: string | undefined;
|
|
836
|
+
/**
|
|
837
|
+
* <p>A list of IP address range strings that are allowed to access the instance. For more information on how to
|
|
838
|
+
* configure IP addresses, see<a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts">Configure session
|
|
839
|
+
* timeouts</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
840
|
+
* @public
|
|
841
|
+
*/
|
|
842
|
+
AllowedIps?: string[] | undefined;
|
|
843
|
+
/**
|
|
844
|
+
* <p>A list of IP address range strings that are blocked from accessing the instance. For more information on how to
|
|
845
|
+
* configure IP addresses, For more information on how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac">Configure IP-based access
|
|
846
|
+
* control</a> in the <i>Amazon Connect Administrator Guide</i>. </p>
|
|
847
|
+
* @public
|
|
848
|
+
*/
|
|
849
|
+
BlockedIps?: string[] | undefined;
|
|
850
|
+
/**
|
|
851
|
+
* <p>The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value
|
|
852
|
+
* determines the maximum possible time before an agent is authenticated. For more information, For more information on
|
|
853
|
+
* how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts">Configure session
|
|
854
|
+
* timeouts</a> in the <i>Amazon Connect Administrator Guide</i>. </p>
|
|
855
|
+
*
|
|
856
|
+
* @deprecated PeriodicSessionDuration is deprecated. Use SessionInactivityDuration instead.
|
|
857
|
+
* @public
|
|
858
|
+
*/
|
|
859
|
+
PeriodicSessionDuration?: number | undefined;
|
|
860
|
+
/**
|
|
861
|
+
* <p>The period, in minutes, before an agent is automatically signed out of the contact center when they go
|
|
862
|
+
* inactive.</p>
|
|
863
|
+
* @public
|
|
864
|
+
*/
|
|
865
|
+
SessionInactivityDuration?: number | undefined;
|
|
866
|
+
/**
|
|
867
|
+
* <p>Determines if automatic logout on user inactivity is enabled.</p>
|
|
868
|
+
* @public
|
|
869
|
+
*/
|
|
870
|
+
SessionInactivityHandlingEnabled?: boolean | undefined;
|
|
871
|
+
}
|
|
872
|
+
/**
|
|
873
|
+
* <p>Information about a queue.</p>
|
|
874
|
+
* @public
|
|
875
|
+
*/
|
|
876
|
+
export interface QueueInfoInput {
|
|
877
|
+
/**
|
|
878
|
+
* <p>The identifier of the queue.</p>
|
|
879
|
+
* @public
|
|
880
|
+
*/
|
|
881
|
+
Id?: string | undefined;
|
|
882
|
+
}
|
|
883
|
+
/**
|
|
884
|
+
* @public
|
|
885
|
+
*/
|
|
886
|
+
export interface UpdateContactResponse {
|
|
887
|
+
}
|
|
888
|
+
/**
|
|
889
|
+
* @public
|
|
890
|
+
*/
|
|
891
|
+
export interface UpdateContactAttributesRequest {
|
|
892
|
+
/**
|
|
893
|
+
* <p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with
|
|
894
|
+
* the contact center.</p>
|
|
895
|
+
* @public
|
|
896
|
+
*/
|
|
897
|
+
InitialContactId: string | undefined;
|
|
898
|
+
/**
|
|
899
|
+
* <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>
|
|
900
|
+
* @public
|
|
901
|
+
*/
|
|
902
|
+
InstanceId: string | undefined;
|
|
903
|
+
/**
|
|
904
|
+
* <p>The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact
|
|
905
|
+
* attributes.</p>
|
|
906
|
+
* <p>You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only
|
|
907
|
+
* alphanumeric, dash, and underscore characters.</p>
|
|
908
|
+
* <p>In the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html">Set contact
|
|
909
|
+
* attributes</a> block, when the attributes for a contact exceed 32 KB, the contact is routed down the Error
|
|
910
|
+
* branch of the flow. As a mitigation, consider the following options:</p>
|
|
911
|
+
* <ul>
|
|
912
|
+
* <li>
|
|
913
|
+
* <p>Remove unnecessary attributes by setting their values to empty.</p>
|
|
914
|
+
* </li>
|
|
915
|
+
* <li>
|
|
916
|
+
* <p>If the attributes are only used in one flow and don't need to be referred to outside of that flow (for
|
|
917
|
+
* example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB
|
|
918
|
+
* of information from one flow to another. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html">Flow block: Set contact attributes</a> in the
|
|
919
|
+
* <i>Amazon Connect Administrator Guide</i>. </p>
|
|
920
|
+
* </li>
|
|
921
|
+
* </ul>
|
|
922
|
+
* @public
|
|
923
|
+
*/
|
|
924
|
+
Attributes: Record<string, string> | undefined;
|
|
925
|
+
}
|
|
926
|
+
/**
|
|
927
|
+
* @public
|
|
928
|
+
*/
|
|
929
|
+
export interface UpdateContactAttributesResponse {
|
|
930
|
+
}
|
|
931
|
+
/**
|
|
932
|
+
* @public
|
|
933
|
+
*/
|
|
934
|
+
export interface UpdateContactEvaluationRequest {
|
|
935
|
+
/**
|
|
936
|
+
* <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>
|
|
937
|
+
* @public
|
|
938
|
+
*/
|
|
939
|
+
InstanceId: string | undefined;
|
|
940
|
+
/**
|
|
941
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
942
|
+
* @public
|
|
943
|
+
*/
|
|
944
|
+
EvaluationId: string | undefined;
|
|
945
|
+
/**
|
|
946
|
+
* <p>A map of question identifiers to answer value.</p>
|
|
947
|
+
* @public
|
|
948
|
+
*/
|
|
949
|
+
Answers?: Record<string, EvaluationAnswerInput> | undefined;
|
|
950
|
+
/**
|
|
951
|
+
* <p>A map of question identifiers to note value.</p>
|
|
952
|
+
* @public
|
|
953
|
+
*/
|
|
954
|
+
Notes?: Record<string, EvaluationNote> | undefined;
|
|
955
|
+
/**
|
|
956
|
+
* <p>The ID of the user who updated the contact evaluation.</p>
|
|
957
|
+
* @public
|
|
958
|
+
*/
|
|
959
|
+
UpdatedBy?: EvaluatorUserUnion | undefined;
|
|
960
|
+
}
|
|
961
|
+
/**
|
|
962
|
+
* @public
|
|
963
|
+
*/
|
|
964
|
+
export interface UpdateContactEvaluationResponse {
|
|
965
|
+
/**
|
|
966
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
967
|
+
* @public
|
|
968
|
+
*/
|
|
969
|
+
EvaluationId: string | undefined;
|
|
970
|
+
/**
|
|
971
|
+
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
972
|
+
* @public
|
|
973
|
+
*/
|
|
974
|
+
EvaluationArn: string | undefined;
|
|
975
|
+
}
|
|
976
|
+
/**
|
|
977
|
+
* @public
|
|
978
|
+
*/
|
|
979
|
+
export interface UpdateContactFlowContentRequest {
|
|
980
|
+
/**
|
|
981
|
+
* <p>The identifier of the Amazon Connect instance.</p>
|
|
982
|
+
* @public
|
|
983
|
+
*/
|
|
984
|
+
InstanceId: string | undefined;
|
|
985
|
+
/**
|
|
986
|
+
* <p>The identifier of the flow.</p>
|
|
987
|
+
* @public
|
|
988
|
+
*/
|
|
989
|
+
ContactFlowId: string | undefined;
|
|
990
|
+
/**
|
|
991
|
+
* <p>The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example
|
|
992
|
+
* flow in Amazon Connect Flow language</a>. </p>
|
|
993
|
+
* <p>Length Constraints: Minimum length of 1. Maximum length of 256000.</p>
|
|
994
|
+
* @public
|
|
995
|
+
*/
|
|
996
|
+
Content: string | undefined;
|
|
997
|
+
}
|
|
998
|
+
/**
|
|
999
|
+
* @public
|
|
1000
|
+
*/
|
|
1001
|
+
export interface UpdateContactFlowContentResponse {
|
|
1002
|
+
}
|
|
1003
|
+
/**
|
|
1004
|
+
* @public
|
|
1005
|
+
*/
|
|
1006
|
+
export interface UpdateContactFlowMetadataRequest {
|
|
1007
|
+
/**
|
|
1008
|
+
* <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>
|
|
1009
|
+
* @public
|
|
1010
|
+
*/
|
|
1011
|
+
InstanceId: string | undefined;
|
|
1012
|
+
/**
|
|
1013
|
+
* <p>The identifier of the flow.</p>
|
|
1014
|
+
* @public
|
|
1015
|
+
*/
|
|
1016
|
+
ContactFlowId: string | undefined;
|
|
1017
|
+
/**
|
|
1018
|
+
* <p>The name of the flow.</p>
|
|
1019
|
+
* @public
|
|
1020
|
+
*/
|
|
1021
|
+
Name?: string | undefined;
|
|
1022
|
+
/**
|
|
1023
|
+
* <p>The description of the flow.</p>
|
|
1024
|
+
* @public
|
|
1025
|
+
*/
|
|
1026
|
+
Description?: string | undefined;
|
|
1027
|
+
/**
|
|
1028
|
+
* <p>The state of flow.</p>
|
|
1029
|
+
* @public
|
|
1030
|
+
*/
|
|
1031
|
+
ContactFlowState?: ContactFlowState | undefined;
|
|
1032
|
+
}
|
|
1033
|
+
/**
|
|
1034
|
+
* @public
|
|
1035
|
+
*/
|
|
1036
|
+
export interface UpdateContactFlowMetadataResponse {
|
|
1037
|
+
}
|
|
1038
|
+
/**
|
|
1039
|
+
* @public
|
|
1040
|
+
*/
|
|
1041
|
+
export interface UpdateContactFlowModuleAliasRequest {
|
|
1042
|
+
/**
|
|
1043
|
+
* <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>
|
|
1044
|
+
* @public
|
|
1045
|
+
*/
|
|
1046
|
+
InstanceId: string | undefined;
|
|
1047
|
+
/**
|
|
1048
|
+
* <p>The identifier of the flow module.</p>
|
|
1049
|
+
* @public
|
|
1050
|
+
*/
|
|
1051
|
+
ContactFlowModuleId: string | undefined;
|
|
1052
|
+
/**
|
|
1053
|
+
* <p>The identifier of the alias.</p>
|
|
1054
|
+
* @public
|
|
1055
|
+
*/
|
|
1056
|
+
AliasId: string | undefined;
|
|
1057
|
+
/**
|
|
1058
|
+
* <p>The name of the alias.</p>
|
|
1059
|
+
* @public
|
|
1060
|
+
*/
|
|
1061
|
+
Name?: string | undefined;
|
|
1062
|
+
/**
|
|
1063
|
+
* <p>The description of the alias.</p>
|
|
1064
|
+
* @public
|
|
1065
|
+
*/
|
|
1066
|
+
Description?: string | undefined;
|
|
1067
|
+
/**
|
|
1068
|
+
* <p>The version of the flow module.</p>
|
|
1069
|
+
* @public
|
|
1070
|
+
*/
|
|
1071
|
+
ContactFlowModuleVersion?: number | undefined;
|
|
1072
|
+
}
|
|
1073
|
+
/**
|
|
1074
|
+
* @public
|
|
1075
|
+
*/
|
|
1076
|
+
export interface UpdateContactFlowModuleAliasResponse {
|
|
1077
|
+
}
|
|
1078
|
+
/**
|
|
1079
|
+
* @public
|
|
1080
|
+
*/
|
|
1081
|
+
export interface UpdateContactFlowModuleContentRequest {
|
|
1082
|
+
/**
|
|
1083
|
+
* <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>
|
|
1084
|
+
* @public
|
|
1085
|
+
*/
|
|
1086
|
+
InstanceId: string | undefined;
|
|
1087
|
+
/**
|
|
1088
|
+
* <p>The identifier of the flow module.</p>
|
|
1089
|
+
* @public
|
|
1090
|
+
*/
|
|
1091
|
+
ContactFlowModuleId: string | undefined;
|
|
1092
|
+
/**
|
|
1093
|
+
* <p>The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example
|
|
1094
|
+
* flow in Amazon Connect Flow language</a>. </p>
|
|
1095
|
+
* @public
|
|
1096
|
+
*/
|
|
1097
|
+
Content?: string | undefined;
|
|
1098
|
+
/**
|
|
1099
|
+
* <p>Serialized JSON string of the flow module Settings schema.</p>
|
|
1100
|
+
* @public
|
|
1101
|
+
*/
|
|
1102
|
+
Settings?: string | undefined;
|
|
1103
|
+
}
|
|
1104
|
+
/**
|
|
1105
|
+
* @public
|
|
1106
|
+
*/
|
|
1107
|
+
export interface UpdateContactFlowModuleContentResponse {
|
|
1108
|
+
}
|
|
1109
|
+
/**
|
|
1110
|
+
* @public
|
|
1111
|
+
*/
|
|
1112
|
+
export interface UpdateContactFlowModuleMetadataRequest {
|
|
1113
|
+
/**
|
|
1114
|
+
* <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>
|
|
1115
|
+
* @public
|
|
1116
|
+
*/
|
|
1117
|
+
InstanceId: string | undefined;
|
|
1118
|
+
/**
|
|
1119
|
+
* <p>The identifier of the flow module.</p>
|
|
1120
|
+
* @public
|
|
1121
|
+
*/
|
|
1122
|
+
ContactFlowModuleId: string | undefined;
|
|
1123
|
+
/**
|
|
1124
|
+
* <p>The name of the flow module.</p>
|
|
1125
|
+
* @public
|
|
1126
|
+
*/
|
|
1127
|
+
Name?: string | undefined;
|
|
1128
|
+
/**
|
|
1129
|
+
* <p>The description of the flow module.</p>
|
|
1130
|
+
* @public
|
|
1131
|
+
*/
|
|
1132
|
+
Description?: string | undefined;
|
|
1133
|
+
/**
|
|
1134
|
+
* <p>The state of flow module.</p>
|
|
1135
|
+
* @public
|
|
1136
|
+
*/
|
|
1137
|
+
State?: ContactFlowModuleState | undefined;
|
|
1138
|
+
}
|
|
1139
|
+
/**
|
|
1140
|
+
* @public
|
|
1141
|
+
*/
|
|
1142
|
+
export interface UpdateContactFlowModuleMetadataResponse {
|
|
1143
|
+
}
|
|
1144
|
+
/**
|
|
1145
|
+
* @public
|
|
1146
|
+
*/
|
|
1147
|
+
export interface UpdateContactFlowNameRequest {
|
|
1148
|
+
/**
|
|
1149
|
+
* <p>The identifier of the Amazon Connect instance.</p>
|
|
1150
|
+
* @public
|
|
1151
|
+
*/
|
|
1152
|
+
InstanceId: string | undefined;
|
|
1153
|
+
/**
|
|
1154
|
+
* <p>The identifier of the flow.</p>
|
|
1155
|
+
* @public
|
|
1156
|
+
*/
|
|
1157
|
+
ContactFlowId: string | undefined;
|
|
1158
|
+
/**
|
|
1159
|
+
* <p>The name of the flow.</p>
|
|
1160
|
+
* @public
|
|
1161
|
+
*/
|
|
1162
|
+
Name?: string | undefined;
|
|
1163
|
+
/**
|
|
1164
|
+
* <p>The description of the flow.</p>
|
|
1165
|
+
* @public
|
|
1166
|
+
*/
|
|
1167
|
+
Description?: string | undefined;
|
|
1168
|
+
}
|
|
1169
|
+
/**
|
|
1170
|
+
* @public
|
|
1171
|
+
*/
|
|
1172
|
+
export interface UpdateContactFlowNameResponse {
|
|
1173
|
+
}
|
|
1174
|
+
/**
|
|
1175
|
+
* <p>Specify whether this routing criteria step should apply for only a limited amount of time, or if it should never
|
|
1176
|
+
* expire.</p>
|
|
1177
|
+
* @public
|
|
1178
|
+
*/
|
|
1179
|
+
export interface RoutingCriteriaInputStepExpiry {
|
|
1180
|
+
/**
|
|
1181
|
+
* <p>The number of seconds that the contact will be routed only to agents matching this routing step, if expiry was
|
|
1182
|
+
* configured for this routing step.</p>
|
|
1183
|
+
* @public
|
|
1184
|
+
*/
|
|
1185
|
+
DurationInSeconds?: number | undefined;
|
|
1186
|
+
}
|
|
1187
|
+
/**
|
|
1188
|
+
* @public
|
|
1189
|
+
*/
|
|
1190
|
+
export interface UpdateContactRoutingDataResponse {
|
|
1191
|
+
}
|
|
1192
|
+
/**
|
|
1193
|
+
* @public
|
|
1194
|
+
*/
|
|
1195
|
+
export interface UpdateContactScheduleRequest {
|
|
1196
|
+
/**
|
|
1197
|
+
* <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>
|
|
1198
|
+
* @public
|
|
1199
|
+
*/
|
|
1200
|
+
InstanceId: string | undefined;
|
|
1201
|
+
/**
|
|
1202
|
+
* <p>The identifier of the contact.</p>
|
|
1203
|
+
* @public
|
|
1204
|
+
*/
|
|
1205
|
+
ContactId: string | undefined;
|
|
1206
|
+
/**
|
|
1207
|
+
* <p>The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future. </p>
|
|
1208
|
+
* @public
|
|
1209
|
+
*/
|
|
1210
|
+
ScheduledTime: Date | undefined;
|
|
1211
|
+
}
|
|
1212
|
+
/**
|
|
1213
|
+
* @public
|
|
1214
|
+
*/
|
|
1215
|
+
export interface UpdateContactScheduleResponse {
|
|
1216
|
+
}
|
|
1217
|
+
/**
|
|
1218
|
+
* @public
|
|
1219
|
+
*/
|
|
1220
|
+
export interface UpdateDataTableAttributeRequest {
|
|
1221
|
+
/**
|
|
1222
|
+
* <p>The unique identifier for the Amazon Connect instance.</p>
|
|
1223
|
+
* @public
|
|
1224
|
+
*/
|
|
1225
|
+
InstanceId: string | undefined;
|
|
1226
|
+
/**
|
|
1227
|
+
* <p>The unique identifier for the data table. Must also accept the table ARN with or without a version alias.</p>
|
|
1228
|
+
* @public
|
|
1229
|
+
*/
|
|
1230
|
+
DataTableId: string | undefined;
|
|
1231
|
+
/**
|
|
1232
|
+
* <p>The current name of the attribute to update. Used as an identifier since attribute names can be changed.</p>
|
|
1233
|
+
* @public
|
|
1234
|
+
*/
|
|
1235
|
+
AttributeName: string | undefined;
|
|
1236
|
+
/**
|
|
1237
|
+
* <p>The new name for the attribute. Must conform to Connect human readable string specification and be unique within the data table.</p>
|
|
1238
|
+
* @public
|
|
1239
|
+
*/
|
|
1240
|
+
Name: string | undefined;
|
|
1241
|
+
/**
|
|
1242
|
+
* <p>The updated value type for the attribute. When changing value types, existing values are not deleted but may return default values if incompatible.</p>
|
|
1243
|
+
* @public
|
|
1244
|
+
*/
|
|
1245
|
+
ValueType: DataTableAttributeValueType | undefined;
|
|
1246
|
+
/**
|
|
1247
|
+
* <p>The updated description for the attribute.</p>
|
|
1248
|
+
* @public
|
|
1249
|
+
*/
|
|
1250
|
+
Description?: string | undefined;
|
|
1251
|
+
/**
|
|
1252
|
+
* <p>Whether the attribute should be treated as a primary key. Converting to primary attribute requires existing values to maintain uniqueness.</p>
|
|
1253
|
+
* @public
|
|
1254
|
+
*/
|
|
1255
|
+
Primary?: boolean | undefined;
|
|
1256
|
+
/**
|
|
1257
|
+
* <p>The updated validation rules for the attribute. Changes do not affect existing values until they are modified.</p>
|
|
1258
|
+
* @public
|
|
1259
|
+
*/
|
|
1260
|
+
Validation?: Validation | undefined;
|
|
1261
|
+
}
|
|
1262
|
+
/**
|
|
1263
|
+
* @public
|
|
1264
|
+
*/
|
|
1265
|
+
export interface UpdateDataTableAttributeResponse {
|
|
1266
|
+
/**
|
|
1267
|
+
* <p>The trimmed name and identifier for the updated attribute.</p>
|
|
1268
|
+
* @public
|
|
1269
|
+
*/
|
|
1270
|
+
Name: string | undefined;
|
|
1271
|
+
/**
|
|
1272
|
+
* <p>The new lock version for the attribute after the update.</p>
|
|
1273
|
+
* @public
|
|
1274
|
+
*/
|
|
1275
|
+
LockVersion: DataTableLockVersion | undefined;
|
|
1276
|
+
}
|
|
1277
|
+
/**
|
|
1278
|
+
* @public
|
|
1279
|
+
*/
|
|
1280
|
+
export interface UpdateDataTableMetadataRequest {
|
|
1281
|
+
/**
|
|
1282
|
+
* <p>The unique identifier for the Amazon Connect instance.</p>
|
|
1283
|
+
* @public
|
|
1284
|
+
*/
|
|
1285
|
+
InstanceId: string | undefined;
|
|
1286
|
+
/**
|
|
1287
|
+
* <p>The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the version is provided as part of the identifier or ARN, the version must be $LATEST. Providing any other alias fails with an error.</p>
|
|
1288
|
+
* @public
|
|
1289
|
+
*/
|
|
1290
|
+
DataTableId: string | undefined;
|
|
1291
|
+
/**
|
|
1292
|
+
* <p>The updated name for the data table. Must conform to Connect human readable string specification and have 1-127 characters. Must be unique for the instance using case-insensitive comparison.</p>
|
|
1293
|
+
* @public
|
|
1294
|
+
*/
|
|
1295
|
+
Name: string | undefined;
|
|
1296
|
+
/**
|
|
1297
|
+
* <p>The updated description for the data table. Must conform to Connect human readable string specification and have 0-250 characters.</p>
|
|
1298
|
+
* @public
|
|
1299
|
+
*/
|
|
1300
|
+
Description?: string | undefined;
|
|
1301
|
+
/**
|
|
1302
|
+
* <p>The updated value lock level for the data table. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE.</p>
|
|
1303
|
+
* @public
|
|
1304
|
+
*/
|
|
1305
|
+
ValueLockLevel: DataTableLockLevel | undefined;
|
|
1306
|
+
/**
|
|
1307
|
+
* <p>The updated IANA timezone identifier to use when resolving time based dynamic values.</p>
|
|
1308
|
+
* @public
|
|
1309
|
+
*/
|
|
1310
|
+
TimeZone: string | undefined;
|
|
1311
|
+
}
|
|
1312
|
+
/**
|
|
1313
|
+
* @public
|
|
1314
|
+
*/
|
|
1315
|
+
export interface UpdateDataTableMetadataResponse {
|
|
1316
|
+
/**
|
|
1317
|
+
* <p>The new lock version for the data table after the update.</p>
|
|
1318
|
+
* @public
|
|
1319
|
+
*/
|
|
1320
|
+
LockVersion: DataTableLockVersion | undefined;
|
|
1321
|
+
}
|
|
1322
|
+
/**
|
|
1323
|
+
* @public
|
|
1324
|
+
*/
|
|
1325
|
+
export interface UpdateDataTablePrimaryValuesRequest {
|
|
1326
|
+
/**
|
|
1327
|
+
* <p>The unique identifier for the Amazon Connect instance.</p>
|
|
1328
|
+
* @public
|
|
1329
|
+
*/
|
|
1330
|
+
InstanceId: string | undefined;
|
|
1331
|
+
/**
|
|
1332
|
+
* <p>The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the version is provided as part of the identifier or ARN, the version must be one of the two available system managed aliases, $SAVED or $LATEST.</p>
|
|
1333
|
+
* @public
|
|
1334
|
+
*/
|
|
1335
|
+
DataTableId: string | undefined;
|
|
1336
|
+
/**
|
|
1337
|
+
* <p>The current primary values for the record. Required and must include values for all primary attributes. Fails if the table has primary attributes and some primary values are omitted.</p>
|
|
1338
|
+
* @public
|
|
1339
|
+
*/
|
|
1340
|
+
PrimaryValues: PrimaryValue[] | undefined;
|
|
1341
|
+
/**
|
|
1342
|
+
* <p>The new primary values for the record. Required and must include values for all primary attributes. The combination must be unique within the table.</p>
|
|
1343
|
+
* @public
|
|
1344
|
+
*/
|
|
1345
|
+
NewPrimaryValues: PrimaryValue[] | undefined;
|
|
1346
|
+
/**
|
|
1347
|
+
* <p>The lock version information required for optimistic locking to prevent concurrent modifications.</p>
|
|
1348
|
+
* @public
|
|
1349
|
+
*/
|
|
1350
|
+
LockVersion: DataTableLockVersion | undefined;
|
|
1351
|
+
}
|
|
1352
|
+
/**
|
|
1353
|
+
* @public
|
|
1354
|
+
*/
|
|
1355
|
+
export interface UpdateDataTablePrimaryValuesResponse {
|
|
1356
|
+
/**
|
|
1357
|
+
* <p>The updated lock version information for the data table and affected components after the primary values change.</p>
|
|
1358
|
+
* @public
|
|
1359
|
+
*/
|
|
1360
|
+
LockVersion: DataTableLockVersion | undefined;
|
|
1361
|
+
}
|
|
1362
|
+
/**
|
|
1363
|
+
* @public
|
|
1364
|
+
*/
|
|
1365
|
+
export interface UpdateEmailAddressMetadataRequest {
|
|
1366
|
+
/**
|
|
1367
|
+
* <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>
|
|
1368
|
+
* @public
|
|
1369
|
+
*/
|
|
1370
|
+
InstanceId: string | undefined;
|
|
1371
|
+
/**
|
|
1372
|
+
* <p>The identifier of the email address.</p>
|
|
1373
|
+
* @public
|
|
1374
|
+
*/
|
|
1375
|
+
EmailAddressId: string | undefined;
|
|
1376
|
+
/**
|
|
1377
|
+
* <p>The description of the email address.</p>
|
|
1378
|
+
* @public
|
|
1379
|
+
*/
|
|
1380
|
+
Description?: string | undefined;
|
|
1381
|
+
/**
|
|
1382
|
+
* <p>The display name of email address.</p>
|
|
1383
|
+
* @public
|
|
1384
|
+
*/
|
|
1385
|
+
DisplayName?: string | undefined;
|
|
1386
|
+
/**
|
|
1387
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1388
|
+
* request. If not provided, the Amazon Web Services
|
|
1389
|
+
* SDK populates this field. For more information about idempotency, see
|
|
1390
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1391
|
+
* @public
|
|
1392
|
+
*/
|
|
1393
|
+
ClientToken?: string | undefined;
|
|
1394
|
+
}
|
|
1395
|
+
/**
|
|
1396
|
+
* @public
|
|
1397
|
+
*/
|
|
1398
|
+
export interface UpdateEmailAddressMetadataResponse {
|
|
1399
|
+
/**
|
|
1400
|
+
* <p>The identifier of the email address.</p>
|
|
1401
|
+
* @public
|
|
1402
|
+
*/
|
|
1403
|
+
EmailAddressId?: string | undefined;
|
|
1404
|
+
/**
|
|
1405
|
+
* <p>The Amazon Resource Name (ARN) of the email address.</p>
|
|
1406
|
+
* @public
|
|
1407
|
+
*/
|
|
1408
|
+
EmailAddressArn?: string | undefined;
|
|
1409
|
+
}
|
|
1410
|
+
/**
|
|
1411
|
+
* @public
|
|
1412
|
+
*/
|
|
1413
|
+
export interface UpdateEvaluationFormResponse {
|
|
1414
|
+
/**
|
|
1415
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
1416
|
+
* @public
|
|
1417
|
+
*/
|
|
1418
|
+
EvaluationFormId: string | undefined;
|
|
1419
|
+
/**
|
|
1420
|
+
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
1421
|
+
* @public
|
|
1422
|
+
*/
|
|
1423
|
+
EvaluationFormArn: string | undefined;
|
|
1424
|
+
/**
|
|
1425
|
+
* <p>The version of the updated evaluation form resource.</p>
|
|
1426
|
+
* @public
|
|
1427
|
+
*/
|
|
1428
|
+
EvaluationFormVersion: number | undefined;
|
|
1429
|
+
}
|
|
1430
|
+
/**
|
|
1431
|
+
* @public
|
|
1432
|
+
*/
|
|
1433
|
+
export interface UpdateHoursOfOperationRequest {
|
|
1434
|
+
/**
|
|
1435
|
+
* <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>
|
|
1436
|
+
* @public
|
|
1437
|
+
*/
|
|
1438
|
+
InstanceId: string | undefined;
|
|
1439
|
+
/**
|
|
1440
|
+
* <p>The identifier of the hours of operation.</p>
|
|
1441
|
+
* @public
|
|
1442
|
+
*/
|
|
1443
|
+
HoursOfOperationId: string | undefined;
|
|
1444
|
+
/**
|
|
1445
|
+
* <p>The name of the hours of operation.</p>
|
|
1446
|
+
* @public
|
|
1447
|
+
*/
|
|
1448
|
+
Name?: string | undefined;
|
|
1449
|
+
/**
|
|
1450
|
+
* <p>The description of the hours of operation.</p>
|
|
1451
|
+
* @public
|
|
1452
|
+
*/
|
|
1453
|
+
Description?: string | undefined;
|
|
1454
|
+
/**
|
|
1455
|
+
* <p>The time zone of the hours of operation.</p>
|
|
1456
|
+
* @public
|
|
1457
|
+
*/
|
|
1458
|
+
TimeZone?: string | undefined;
|
|
1459
|
+
/**
|
|
1460
|
+
* <p>Configuration information of the hours of operation.</p>
|
|
1461
|
+
* @public
|
|
1462
|
+
*/
|
|
1463
|
+
Config?: HoursOfOperationConfig[] | undefined;
|
|
1464
|
+
}
|
|
1465
|
+
/**
|
|
1466
|
+
* @public
|
|
1467
|
+
*/
|
|
1468
|
+
export interface UpdateHoursOfOperationOverrideRequest {
|
|
1469
|
+
/**
|
|
1470
|
+
* <p>The identifier of the Amazon Connect instance.</p>
|
|
1471
|
+
* @public
|
|
1472
|
+
*/
|
|
1473
|
+
InstanceId: string | undefined;
|
|
1474
|
+
/**
|
|
1475
|
+
* <p>The identifier for the hours of operation.</p>
|
|
1476
|
+
* @public
|
|
1477
|
+
*/
|
|
1478
|
+
HoursOfOperationId: string | undefined;
|
|
1479
|
+
/**
|
|
1480
|
+
* <p>The identifier for the hours of operation override.</p>
|
|
1481
|
+
* @public
|
|
1482
|
+
*/
|
|
1483
|
+
HoursOfOperationOverrideId: string | undefined;
|
|
1484
|
+
/**
|
|
1485
|
+
* <p>The name of the hours of operation override.</p>
|
|
1486
|
+
* @public
|
|
1487
|
+
*/
|
|
1488
|
+
Name?: string | undefined;
|
|
1489
|
+
/**
|
|
1490
|
+
* <p>The description of the hours of operation override.</p>
|
|
1491
|
+
* @public
|
|
1492
|
+
*/
|
|
1493
|
+
Description?: string | undefined;
|
|
1494
|
+
/**
|
|
1495
|
+
* <p>Configuration information for the hours of operation override: day, start time, and end time.</p>
|
|
1496
|
+
* @public
|
|
1497
|
+
*/
|
|
1498
|
+
Config?: HoursOfOperationOverrideConfig[] | undefined;
|
|
1499
|
+
/**
|
|
1500
|
+
* <p>The date from when the hours of operation override would be effective.</p>
|
|
1501
|
+
* @public
|
|
1502
|
+
*/
|
|
1503
|
+
EffectiveFrom?: string | undefined;
|
|
1504
|
+
/**
|
|
1505
|
+
* <p>The date until the hours of operation override is effective.</p>
|
|
1506
|
+
* @public
|
|
1507
|
+
*/
|
|
1508
|
+
EffectiveTill?: string | undefined;
|
|
1509
|
+
}
|
|
1510
|
+
/**
|
|
1511
|
+
* @public
|
|
1512
|
+
*/
|
|
1513
|
+
export interface UpdateInstanceAttributeRequest {
|
|
1514
|
+
/**
|
|
1515
|
+
* <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>
|
|
1516
|
+
* @public
|
|
1517
|
+
*/
|
|
1518
|
+
InstanceId: string | undefined;
|
|
1519
|
+
/**
|
|
1520
|
+
* <p>The type of attribute.</p>
|
|
1521
|
+
* <note>
|
|
1522
|
+
* <p>Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.</p>
|
|
1523
|
+
* </note>
|
|
1524
|
+
* <note>
|
|
1525
|
+
* <p>If you set the attribute type as <code>MESSAGE_STREAMING</code>, you need to update the Lex bot alias resource
|
|
1526
|
+
* based policy to include the <code>lex:RecognizeMessageAsync</code> action for the connect instance ARN
|
|
1527
|
+
* resource.</p>
|
|
1528
|
+
* </note>
|
|
1529
|
+
* @public
|
|
1530
|
+
*/
|
|
1531
|
+
AttributeType: InstanceAttributeType | undefined;
|
|
1532
|
+
/**
|
|
1533
|
+
* <p>The value for the attribute. Maximum character limit is 100. </p>
|
|
1534
|
+
* @public
|
|
1535
|
+
*/
|
|
1536
|
+
Value: string | undefined;
|
|
1537
|
+
/**
|
|
1538
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1539
|
+
* request. If not provided, the Amazon Web Services
|
|
1540
|
+
* SDK populates this field. For more information about idempotency, see
|
|
1541
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1542
|
+
* @public
|
|
1543
|
+
*/
|
|
1544
|
+
ClientToken?: string | undefined;
|
|
1545
|
+
}
|
|
1546
|
+
/**
|
|
1547
|
+
* @public
|
|
1548
|
+
*/
|
|
1549
|
+
export interface UpdateInstanceStorageConfigRequest {
|
|
1550
|
+
/**
|
|
1551
|
+
* <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>
|
|
1552
|
+
* @public
|
|
1553
|
+
*/
|
|
1554
|
+
InstanceId: string | undefined;
|
|
1555
|
+
/**
|
|
1556
|
+
* <p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>
|
|
1557
|
+
* @public
|
|
1558
|
+
*/
|
|
1559
|
+
AssociationId: string | undefined;
|
|
1560
|
+
/**
|
|
1561
|
+
* <p>A valid resource type.</p>
|
|
1562
|
+
* @public
|
|
1563
|
+
*/
|
|
1564
|
+
ResourceType: InstanceStorageResourceType | undefined;
|
|
1565
|
+
/**
|
|
1566
|
+
* <p>The storage configuration for the instance.</p>
|
|
1567
|
+
* @public
|
|
1568
|
+
*/
|
|
1569
|
+
StorageConfig: InstanceStorageConfig | undefined;
|
|
1570
|
+
/**
|
|
1571
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1572
|
+
* request. If not provided, the Amazon Web Services
|
|
1573
|
+
* SDK populates this field. For more information about idempotency, see
|
|
1574
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1575
|
+
* @public
|
|
1576
|
+
*/
|
|
1577
|
+
ClientToken?: string | undefined;
|
|
1578
|
+
}
|
|
1579
|
+
/**
|
|
1580
|
+
* @public
|
|
1581
|
+
*/
|
|
1582
|
+
export interface UpdateParticipantAuthenticationRequest {
|
|
1583
|
+
/**
|
|
1584
|
+
* <p>The <code>state</code> query parameter that was provided by Cognito in the <code>redirectUri</code>. This will
|
|
1585
|
+
* also match the <code>state</code> parameter provided in the <code>AuthenticationUrl</code> from the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetAuthenticationUrl.html">GetAuthenticationUrl</a>
|
|
1586
|
+
* response.</p>
|
|
1587
|
+
* @public
|
|
1588
|
+
*/
|
|
1589
|
+
State: string | undefined;
|
|
1590
|
+
/**
|
|
1591
|
+
* <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>
|
|
1592
|
+
* @public
|
|
1593
|
+
*/
|
|
1594
|
+
InstanceId: string | undefined;
|
|
1595
|
+
/**
|
|
1596
|
+
* <p>The <code>code</code> query parameter provided by Cognito in the <code>redirectUri</code>.</p>
|
|
1597
|
+
* @public
|
|
1598
|
+
*/
|
|
1599
|
+
Code?: string | undefined;
|
|
1600
|
+
/**
|
|
1601
|
+
* <p>The <code>error</code> query parameter provided by Cognito in the <code>redirectUri</code>.</p>
|
|
1602
|
+
* @public
|
|
1603
|
+
*/
|
|
1604
|
+
Error?: string | undefined;
|
|
1605
|
+
/**
|
|
1606
|
+
* <p>The <code>error_description</code> parameter provided by Cognito in the <code>redirectUri</code>.</p>
|
|
1607
|
+
* @public
|
|
1608
|
+
*/
|
|
1609
|
+
ErrorDescription?: string | undefined;
|
|
1610
|
+
}
|
|
1611
|
+
/**
|
|
1612
|
+
* @public
|
|
1613
|
+
*/
|
|
1614
|
+
export interface UpdateParticipantAuthenticationResponse {
|
|
1615
|
+
}
|
|
1616
|
+
/**
|
|
1617
|
+
* <p>The value of the timer. Either the timer action (<code>Unset</code> to delete the timer), or the duration of the
|
|
1618
|
+
* timer in minutes. Only one value can be set.</p>
|
|
1619
|
+
* <p>For more information about how chat timeouts work, see
|
|
1620
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html">Set up chat timeouts for human participants</a>. </p>
|
|
1621
|
+
* @public
|
|
1622
|
+
*/
|
|
1623
|
+
export type ParticipantTimerValue = ParticipantTimerValue.ParticipantTimerActionMember | ParticipantTimerValue.ParticipantTimerDurationInMinutesMember | ParticipantTimerValue.$UnknownMember;
|
|
1624
|
+
/**
|
|
1625
|
+
* @public
|
|
1626
|
+
*/
|
|
1627
|
+
export declare namespace ParticipantTimerValue {
|
|
1628
|
+
/**
|
|
1629
|
+
* <p>The timer action. Currently only one value is allowed: <code>Unset</code>. It deletes a timer.</p>
|
|
1630
|
+
* @public
|
|
1631
|
+
*/
|
|
1632
|
+
interface ParticipantTimerActionMember {
|
|
1633
|
+
ParticipantTimerAction: ParticipantTimerAction;
|
|
1634
|
+
ParticipantTimerDurationInMinutes?: never;
|
|
1635
|
+
$unknown?: never;
|
|
1636
|
+
}
|
|
1637
|
+
/**
|
|
1638
|
+
* <p>The duration of a timer, in minutes. </p>
|
|
1639
|
+
* @public
|
|
1640
|
+
*/
|
|
1641
|
+
interface ParticipantTimerDurationInMinutesMember {
|
|
1642
|
+
ParticipantTimerAction?: never;
|
|
1643
|
+
ParticipantTimerDurationInMinutes: number;
|
|
1644
|
+
$unknown?: never;
|
|
1645
|
+
}
|
|
1646
|
+
/**
|
|
1647
|
+
* @public
|
|
1648
|
+
*/
|
|
1649
|
+
interface $UnknownMember {
|
|
1650
|
+
ParticipantTimerAction?: never;
|
|
1651
|
+
ParticipantTimerDurationInMinutes?: never;
|
|
1652
|
+
$unknown: [string, any];
|
|
1653
|
+
}
|
|
1654
|
+
/**
|
|
1655
|
+
* @deprecated unused in schema-serde mode.
|
|
1656
|
+
*
|
|
1657
|
+
*/
|
|
1658
|
+
interface Visitor<T> {
|
|
1659
|
+
ParticipantTimerAction: (value: ParticipantTimerAction) => T;
|
|
1660
|
+
ParticipantTimerDurationInMinutes: (value: number) => T;
|
|
1661
|
+
_: (name: string, value: any) => T;
|
|
1662
|
+
}
|
|
1663
|
+
}
|
|
1664
|
+
/**
|
|
1665
|
+
* <p>Configuration information for the timer. After the timer configuration is set, it persists for the duration of
|
|
1666
|
+
* the chat. It persists across new contacts in the chain, for example, transfer contacts.</p>
|
|
1667
|
+
* <p>For more information about how chat timeouts work, see
|
|
1668
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html">Set up chat timeouts for human participants</a>. </p>
|
|
1669
|
+
* @public
|
|
1670
|
+
*/
|
|
1671
|
+
export interface ParticipantTimerConfiguration {
|
|
1672
|
+
/**
|
|
1673
|
+
* <p>The role of the participant in the chat conversation.</p>
|
|
1674
|
+
* @public
|
|
1675
|
+
*/
|
|
1676
|
+
ParticipantRole: TimerEligibleParticipantRoles | undefined;
|
|
1677
|
+
/**
|
|
1678
|
+
* <p>The type of timer. <code>IDLE</code> indicates the timer applies for considering a human chat participant as
|
|
1679
|
+
* idle. <code>DISCONNECT_NONCUSTOMER</code> indicates the timer applies to automatically disconnecting a chat
|
|
1680
|
+
* participant due to idleness.</p>
|
|
1681
|
+
* @public
|
|
1682
|
+
*/
|
|
1683
|
+
TimerType: ParticipantTimerType | undefined;
|
|
1684
|
+
/**
|
|
1685
|
+
* <p>The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in
|
|
1686
|
+
* minutes. Only one value can be set.</p>
|
|
1687
|
+
* @public
|
|
1688
|
+
*/
|
|
1689
|
+
TimerValue: ParticipantTimerValue | undefined;
|
|
1690
|
+
}
|
|
1691
|
+
/**
|
|
1692
|
+
* <p>Configuration information for the chat participant role.</p>
|
|
1693
|
+
* @public
|
|
1694
|
+
*/
|
|
1695
|
+
export interface ChatParticipantRoleConfig {
|
|
1696
|
+
/**
|
|
1697
|
+
* <p>A list of participant timers. You can specify any unique combination of role and timer type. Duplicate entries
|
|
1698
|
+
* error out the request with a 400.</p>
|
|
1699
|
+
* @public
|
|
1700
|
+
*/
|
|
1701
|
+
ParticipantTimerConfigList: ParticipantTimerConfiguration[] | undefined;
|
|
1702
|
+
}
|
|
1703
|
+
/**
|
|
1704
|
+
* <p>Configuration information for the chat participant role.</p>
|
|
1705
|
+
* @public
|
|
1706
|
+
*/
|
|
1707
|
+
export type UpdateParticipantRoleConfigChannelInfo = UpdateParticipantRoleConfigChannelInfo.ChatMember | UpdateParticipantRoleConfigChannelInfo.$UnknownMember;
|
|
1708
|
+
/**
|
|
1709
|
+
* @public
|
|
1710
|
+
*/
|
|
1711
|
+
export declare namespace UpdateParticipantRoleConfigChannelInfo {
|
|
1712
|
+
/**
|
|
1713
|
+
* <p>Configuration information for the chat participant role.</p>
|
|
1714
|
+
* @public
|
|
1715
|
+
*/
|
|
1716
|
+
interface ChatMember {
|
|
1717
|
+
Chat: ChatParticipantRoleConfig;
|
|
1718
|
+
$unknown?: never;
|
|
1719
|
+
}
|
|
1720
|
+
/**
|
|
1721
|
+
* @public
|
|
1722
|
+
*/
|
|
1723
|
+
interface $UnknownMember {
|
|
1724
|
+
Chat?: never;
|
|
1725
|
+
$unknown: [string, any];
|
|
1726
|
+
}
|
|
1727
|
+
/**
|
|
1728
|
+
* @deprecated unused in schema-serde mode.
|
|
1729
|
+
*
|
|
1730
|
+
*/
|
|
1731
|
+
interface Visitor<T> {
|
|
1732
|
+
Chat: (value: ChatParticipantRoleConfig) => T;
|
|
1733
|
+
_: (name: string, value: any) => T;
|
|
1734
|
+
}
|
|
1735
|
+
}
|
|
1736
|
+
/**
|
|
1737
|
+
* @public
|
|
1738
|
+
*/
|
|
1739
|
+
export interface UpdateParticipantRoleConfigRequest {
|
|
1740
|
+
/**
|
|
1741
|
+
* <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>
|
|
1742
|
+
* @public
|
|
1743
|
+
*/
|
|
1744
|
+
InstanceId: string | undefined;
|
|
1745
|
+
/**
|
|
1746
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
1747
|
+
* @public
|
|
1748
|
+
*/
|
|
1749
|
+
ContactId: string | undefined;
|
|
1750
|
+
/**
|
|
1751
|
+
* <p>The Amazon Connect channel you want to configure.</p>
|
|
1752
|
+
* @public
|
|
1753
|
+
*/
|
|
1754
|
+
ChannelConfiguration: UpdateParticipantRoleConfigChannelInfo | undefined;
|
|
1755
|
+
}
|
|
1756
|
+
/**
|
|
1757
|
+
* @public
|
|
1758
|
+
*/
|
|
1759
|
+
export interface UpdateParticipantRoleConfigResponse {
|
|
1760
|
+
}
|
|
1761
|
+
/**
|
|
1762
|
+
* @public
|
|
1763
|
+
*/
|
|
1764
|
+
export interface UpdatePhoneNumberRequest {
|
|
1765
|
+
/**
|
|
1766
|
+
* <p>A unique identifier for the phone number.</p>
|
|
1767
|
+
* @public
|
|
1768
|
+
*/
|
|
1769
|
+
PhoneNumberId: string | undefined;
|
|
1770
|
+
/**
|
|
1771
|
+
* <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
|
|
1772
|
+
* @public
|
|
1773
|
+
*/
|
|
1774
|
+
TargetArn?: string | undefined;
|
|
1775
|
+
/**
|
|
1776
|
+
* <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You
|
|
1777
|
+
* can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
|
|
1778
|
+
* instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
|
|
1779
|
+
* @public
|
|
1780
|
+
*/
|
|
1781
|
+
InstanceId?: string | undefined;
|
|
1782
|
+
/**
|
|
1783
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1784
|
+
* request. If not provided, the Amazon Web Services
|
|
1785
|
+
* SDK populates this field. For more information about idempotency, see
|
|
1786
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1787
|
+
* @public
|
|
1788
|
+
*/
|
|
1789
|
+
ClientToken?: string | undefined;
|
|
1790
|
+
}
|
|
1791
|
+
/**
|
|
1792
|
+
* @public
|
|
1793
|
+
*/
|
|
1794
|
+
export interface UpdatePhoneNumberResponse {
|
|
1795
|
+
/**
|
|
1796
|
+
* <p>A unique identifier for the phone number.</p>
|
|
1797
|
+
* @public
|
|
1798
|
+
*/
|
|
1799
|
+
PhoneNumberId?: string | undefined;
|
|
1800
|
+
/**
|
|
1801
|
+
* <p>The Amazon Resource Name (ARN) of the phone number.</p>
|
|
1802
|
+
* @public
|
|
1803
|
+
*/
|
|
1804
|
+
PhoneNumberArn?: string | undefined;
|
|
1805
|
+
}
|
|
1806
|
+
/**
|
|
1807
|
+
* @public
|
|
1808
|
+
*/
|
|
1809
|
+
export interface UpdatePhoneNumberMetadataRequest {
|
|
1810
|
+
/**
|
|
1811
|
+
* <p>The Amazon Resource Name (ARN) or resource ID of the phone number.</p>
|
|
1812
|
+
* @public
|
|
1813
|
+
*/
|
|
1814
|
+
PhoneNumberId: string | undefined;
|
|
1815
|
+
/**
|
|
1816
|
+
* <p>The description of the phone number.</p>
|
|
1817
|
+
* @public
|
|
1818
|
+
*/
|
|
1819
|
+
PhoneNumberDescription?: string | undefined;
|
|
1820
|
+
/**
|
|
1821
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1822
|
+
* request. If not provided, the Amazon Web Services
|
|
1823
|
+
* SDK populates this field. For more information about idempotency, see
|
|
1824
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1825
|
+
* @public
|
|
1826
|
+
*/
|
|
1827
|
+
ClientToken?: string | undefined;
|
|
1828
|
+
}
|
|
1829
|
+
/**
|
|
1830
|
+
* @public
|
|
1831
|
+
*/
|
|
1832
|
+
export interface UpdatePredefinedAttributeRequest {
|
|
1833
|
+
/**
|
|
1834
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the
|
|
1835
|
+
* instance.</p>
|
|
1836
|
+
* @public
|
|
1837
|
+
*/
|
|
1838
|
+
InstanceId: string | undefined;
|
|
1839
|
+
/**
|
|
1840
|
+
* <p>The name of the predefined attribute.</p>
|
|
1841
|
+
* @public
|
|
1842
|
+
*/
|
|
1843
|
+
Name: string | undefined;
|
|
1844
|
+
/**
|
|
1845
|
+
* <p>The values of the predefined attribute.</p>
|
|
1846
|
+
* @public
|
|
1847
|
+
*/
|
|
1848
|
+
Values?: PredefinedAttributeValues | undefined;
|
|
1849
|
+
/**
|
|
1850
|
+
* <p>Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.</p>
|
|
1851
|
+
* @public
|
|
1852
|
+
*/
|
|
1853
|
+
Purposes?: string[] | undefined;
|
|
1854
|
+
/**
|
|
1855
|
+
* <p>Custom metadata that is associated to predefined attributes to control behavior
|
|
1856
|
+
* in upstream services, such as controlling
|
|
1857
|
+
* how a predefined attribute should be displayed in the Amazon Connect admin website.</p>
|
|
1858
|
+
* @public
|
|
1859
|
+
*/
|
|
1860
|
+
AttributeConfiguration?: InputPredefinedAttributeConfiguration | undefined;
|
|
1861
|
+
}
|
|
1862
|
+
/**
|
|
1863
|
+
* @public
|
|
1864
|
+
*/
|
|
1865
|
+
export interface UpdatePromptRequest {
|
|
1866
|
+
/**
|
|
1867
|
+
* <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>
|
|
1868
|
+
* @public
|
|
1869
|
+
*/
|
|
1870
|
+
InstanceId: string | undefined;
|
|
1871
|
+
/**
|
|
1872
|
+
* <p>A unique identifier for the prompt.</p>
|
|
1873
|
+
* @public
|
|
1874
|
+
*/
|
|
1875
|
+
PromptId: string | undefined;
|
|
1876
|
+
/**
|
|
1877
|
+
* <p>The name of the prompt.</p>
|
|
1878
|
+
* @public
|
|
1879
|
+
*/
|
|
1880
|
+
Name?: string | undefined;
|
|
1881
|
+
/**
|
|
1882
|
+
* <p>A description of the prompt.</p>
|
|
1883
|
+
* @public
|
|
1884
|
+
*/
|
|
1885
|
+
Description?: string | undefined;
|
|
1886
|
+
/**
|
|
1887
|
+
* <p>The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the
|
|
1888
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html">GetPromptFile</a>
|
|
1889
|
+
* API instead of providing S3 URIs.</p>
|
|
1890
|
+
* @public
|
|
1891
|
+
*/
|
|
1892
|
+
S3Uri?: string | undefined;
|
|
1893
|
+
}
|
|
1894
|
+
/**
|
|
1895
|
+
* @public
|
|
1896
|
+
*/
|
|
1897
|
+
export interface UpdatePromptResponse {
|
|
1898
|
+
/**
|
|
1899
|
+
* <p>The Amazon Resource Name (ARN) of the prompt.</p>
|
|
1900
|
+
* @public
|
|
1901
|
+
*/
|
|
1902
|
+
PromptARN?: string | undefined;
|
|
1903
|
+
/**
|
|
1904
|
+
* <p>A unique identifier for the prompt.</p>
|
|
1905
|
+
* @public
|
|
1906
|
+
*/
|
|
1907
|
+
PromptId?: string | undefined;
|
|
1908
|
+
}
|
|
1909
|
+
/**
|
|
1910
|
+
* @public
|
|
1911
|
+
*/
|
|
1912
|
+
export interface UpdateQueueHoursOfOperationRequest {
|
|
1913
|
+
/**
|
|
1914
|
+
* <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>
|
|
1915
|
+
* @public
|
|
1916
|
+
*/
|
|
1917
|
+
InstanceId: string | undefined;
|
|
1918
|
+
/**
|
|
1919
|
+
* <p>The identifier for the queue.</p>
|
|
1920
|
+
* @public
|
|
1921
|
+
*/
|
|
1922
|
+
QueueId: string | undefined;
|
|
1923
|
+
/**
|
|
1924
|
+
* <p>The identifier for the hours of operation.</p>
|
|
1925
|
+
* @public
|
|
1926
|
+
*/
|
|
1927
|
+
HoursOfOperationId: string | undefined;
|
|
1928
|
+
}
|
|
1929
|
+
/**
|
|
1930
|
+
* @public
|
|
1931
|
+
*/
|
|
1932
|
+
export interface UpdateQueueMaxContactsRequest {
|
|
1933
|
+
/**
|
|
1934
|
+
* <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>
|
|
1935
|
+
* @public
|
|
1936
|
+
*/
|
|
1937
|
+
InstanceId: string | undefined;
|
|
1938
|
+
/**
|
|
1939
|
+
* <p>The identifier for the queue.</p>
|
|
1940
|
+
* @public
|
|
1941
|
+
*/
|
|
1942
|
+
QueueId: string | undefined;
|
|
1943
|
+
/**
|
|
1944
|
+
* <p>The maximum number of contacts that can be in the queue before it is considered full.</p>
|
|
1945
|
+
* @public
|
|
1946
|
+
*/
|
|
1947
|
+
MaxContacts?: number | undefined;
|
|
1948
|
+
}
|
|
1949
|
+
/**
|
|
1950
|
+
* @public
|
|
1951
|
+
*/
|
|
1952
|
+
export interface UpdateQueueNameRequest {
|
|
1953
|
+
/**
|
|
1954
|
+
* <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>
|
|
1955
|
+
* @public
|
|
1956
|
+
*/
|
|
1957
|
+
InstanceId: string | undefined;
|
|
1958
|
+
/**
|
|
1959
|
+
* <p>The identifier for the queue.</p>
|
|
1960
|
+
* @public
|
|
1961
|
+
*/
|
|
1962
|
+
QueueId: string | undefined;
|
|
1963
|
+
/**
|
|
1964
|
+
* <p>The name of the queue.</p>
|
|
1965
|
+
* @public
|
|
1966
|
+
*/
|
|
1967
|
+
Name?: string | undefined;
|
|
1968
|
+
/**
|
|
1969
|
+
* <p>The description of the queue.</p>
|
|
1970
|
+
* @public
|
|
1971
|
+
*/
|
|
1972
|
+
Description?: string | undefined;
|
|
1973
|
+
}
|
|
1974
|
+
/**
|
|
1975
|
+
* @public
|
|
1976
|
+
*/
|
|
1977
|
+
export interface UpdateQueueOutboundCallerConfigRequest {
|
|
1978
|
+
/**
|
|
1979
|
+
* <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>
|
|
1980
|
+
* @public
|
|
1981
|
+
*/
|
|
1982
|
+
InstanceId: string | undefined;
|
|
1983
|
+
/**
|
|
1984
|
+
* <p>The identifier for the queue.</p>
|
|
1985
|
+
* @public
|
|
1986
|
+
*/
|
|
1987
|
+
QueueId: string | undefined;
|
|
1988
|
+
/**
|
|
1989
|
+
* <p>The outbound caller ID name, number, and outbound whisper flow.</p>
|
|
1990
|
+
* @public
|
|
1991
|
+
*/
|
|
1992
|
+
OutboundCallerConfig: OutboundCallerConfig | undefined;
|
|
1993
|
+
}
|
|
1994
|
+
/**
|
|
1995
|
+
* @public
|
|
1996
|
+
*/
|
|
1997
|
+
export interface UpdateQueueOutboundEmailConfigRequest {
|
|
1998
|
+
/**
|
|
1999
|
+
* <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>
|
|
2000
|
+
* @public
|
|
2001
|
+
*/
|
|
2002
|
+
InstanceId: string | undefined;
|
|
2003
|
+
/**
|
|
2004
|
+
* <p>The identifier for the queue.</p>
|
|
2005
|
+
* @public
|
|
2006
|
+
*/
|
|
2007
|
+
QueueId: string | undefined;
|
|
2008
|
+
/**
|
|
2009
|
+
* <p>The outbound email address ID for a specified queue.</p>
|
|
2010
|
+
* @public
|
|
2011
|
+
*/
|
|
2012
|
+
OutboundEmailConfig: OutboundEmailConfig | undefined;
|
|
2013
|
+
}
|
|
2014
|
+
/**
|
|
2015
|
+
* @public
|
|
2016
|
+
*/
|
|
2017
|
+
export interface UpdateQueueStatusRequest {
|
|
2018
|
+
/**
|
|
2019
|
+
* <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>
|
|
2020
|
+
* @public
|
|
2021
|
+
*/
|
|
2022
|
+
InstanceId: string | undefined;
|
|
2023
|
+
/**
|
|
2024
|
+
* <p>The identifier for the queue.</p>
|
|
2025
|
+
* @public
|
|
2026
|
+
*/
|
|
2027
|
+
QueueId: string | undefined;
|
|
2028
|
+
/**
|
|
2029
|
+
* <p>The status of the queue.</p>
|
|
2030
|
+
* @public
|
|
2031
|
+
*/
|
|
2032
|
+
Status: QueueStatus | undefined;
|
|
2033
|
+
}
|
|
2034
|
+
/**
|
|
2035
|
+
* @public
|
|
2036
|
+
*/
|
|
2037
|
+
export interface UpdateQuickConnectConfigRequest {
|
|
2038
|
+
/**
|
|
2039
|
+
* <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>
|
|
2040
|
+
* @public
|
|
2041
|
+
*/
|
|
2042
|
+
InstanceId: string | undefined;
|
|
2043
|
+
/**
|
|
2044
|
+
* <p>The identifier for the quick connect.</p>
|
|
2045
|
+
* @public
|
|
2046
|
+
*/
|
|
2047
|
+
QuickConnectId: string | undefined;
|
|
2048
|
+
/**
|
|
2049
|
+
* <p>Information about the configuration settings for the quick connect.</p>
|
|
2050
|
+
* @public
|
|
2051
|
+
*/
|
|
2052
|
+
QuickConnectConfig: QuickConnectConfig | undefined;
|
|
2053
|
+
}
|
|
2054
|
+
/**
|
|
2055
|
+
* @public
|
|
2056
|
+
*/
|
|
2057
|
+
export interface UpdateQuickConnectNameRequest {
|
|
2058
|
+
/**
|
|
2059
|
+
* <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>
|
|
2060
|
+
* @public
|
|
2061
|
+
*/
|
|
2062
|
+
InstanceId: string | undefined;
|
|
2063
|
+
/**
|
|
2064
|
+
* <p>The identifier for the quick connect.</p>
|
|
2065
|
+
* @public
|
|
2066
|
+
*/
|
|
2067
|
+
QuickConnectId: string | undefined;
|
|
2068
|
+
/**
|
|
2069
|
+
* <p>The name of the quick connect.</p>
|
|
2070
|
+
* @public
|
|
2071
|
+
*/
|
|
2072
|
+
Name?: string | undefined;
|
|
2073
|
+
/**
|
|
2074
|
+
* <p>The description of the quick connect.</p>
|
|
2075
|
+
* @public
|
|
2076
|
+
*/
|
|
2077
|
+
Description?: string | undefined;
|
|
2078
|
+
}
|
|
2079
|
+
/**
|
|
2080
|
+
* @public
|
|
2081
|
+
*/
|
|
2082
|
+
export interface UpdateRoutingProfileAgentAvailabilityTimerRequest {
|
|
2083
|
+
/**
|
|
2084
|
+
* <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>
|
|
2085
|
+
* @public
|
|
2086
|
+
*/
|
|
2087
|
+
InstanceId: string | undefined;
|
|
2088
|
+
/**
|
|
2089
|
+
* <p>The identifier of the routing profile.</p>
|
|
2090
|
+
* @public
|
|
2091
|
+
*/
|
|
2092
|
+
RoutingProfileId: string | undefined;
|
|
2093
|
+
/**
|
|
2094
|
+
* <p>Whether agents with this routing profile will have their routing order calculated based on <i>time since
|
|
2095
|
+
* their last inbound contact</i> or <i>longest idle time</i>. </p>
|
|
2096
|
+
* @public
|
|
2097
|
+
*/
|
|
2098
|
+
AgentAvailabilityTimer: AgentAvailabilityTimer | undefined;
|
|
2099
|
+
}
|
|
2100
|
+
/**
|
|
2101
|
+
* @public
|
|
2102
|
+
*/
|
|
2103
|
+
export interface UpdateRoutingProfileConcurrencyRequest {
|
|
2104
|
+
/**
|
|
2105
|
+
* <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>
|
|
2106
|
+
* @public
|
|
2107
|
+
*/
|
|
2108
|
+
InstanceId: string | undefined;
|
|
2109
|
+
/**
|
|
2110
|
+
* <p>The identifier of the routing profile.</p>
|
|
2111
|
+
* @public
|
|
2112
|
+
*/
|
|
2113
|
+
RoutingProfileId: string | undefined;
|
|
2114
|
+
/**
|
|
2115
|
+
* <p>The channels that agents can handle in the Contact Control Panel (CCP).</p>
|
|
2116
|
+
* @public
|
|
2117
|
+
*/
|
|
2118
|
+
MediaConcurrencies: MediaConcurrency[] | undefined;
|
|
2119
|
+
}
|
|
2120
|
+
/**
|
|
2121
|
+
* @public
|
|
2122
|
+
*/
|
|
2123
|
+
export interface UpdateRoutingProfileDefaultOutboundQueueRequest {
|
|
2124
|
+
/**
|
|
2125
|
+
* <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>
|
|
2126
|
+
* @public
|
|
2127
|
+
*/
|
|
2128
|
+
InstanceId: string | undefined;
|
|
2129
|
+
/**
|
|
2130
|
+
* <p>The identifier of the routing profile.</p>
|
|
2131
|
+
* @public
|
|
2132
|
+
*/
|
|
2133
|
+
RoutingProfileId: string | undefined;
|
|
2134
|
+
/**
|
|
2135
|
+
* <p>The identifier for the default outbound queue.</p>
|
|
2136
|
+
* @public
|
|
2137
|
+
*/
|
|
2138
|
+
DefaultOutboundQueueId: string | undefined;
|
|
2139
|
+
}
|
|
2140
|
+
/**
|
|
2141
|
+
* @public
|
|
2142
|
+
*/
|
|
2143
|
+
export interface UpdateRoutingProfileNameRequest {
|
|
2144
|
+
/**
|
|
2145
|
+
* <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>
|
|
2146
|
+
* @public
|
|
2147
|
+
*/
|
|
2148
|
+
InstanceId: string | undefined;
|
|
2149
|
+
/**
|
|
2150
|
+
* <p>The identifier of the routing profile.</p>
|
|
2151
|
+
* @public
|
|
2152
|
+
*/
|
|
2153
|
+
RoutingProfileId: string | undefined;
|
|
2154
|
+
/**
|
|
2155
|
+
* <p>The name of the routing profile. Must not be more than 127 characters.</p>
|
|
2156
|
+
* @public
|
|
2157
|
+
*/
|
|
2158
|
+
Name?: string | undefined;
|
|
2159
|
+
/**
|
|
2160
|
+
* <p>The description of the routing profile. Must not be more than 250 characters.</p>
|
|
2161
|
+
* @public
|
|
2162
|
+
*/
|
|
2163
|
+
Description?: string | undefined;
|
|
2164
|
+
}
|
|
2165
|
+
/**
|
|
2166
|
+
* @public
|
|
2167
|
+
*/
|
|
2168
|
+
export interface UpdateRoutingProfileQueuesRequest {
|
|
2169
|
+
/**
|
|
2170
|
+
* <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>
|
|
2171
|
+
* @public
|
|
2172
|
+
*/
|
|
2173
|
+
InstanceId: string | undefined;
|
|
2174
|
+
/**
|
|
2175
|
+
* <p>The identifier of the routing profile.</p>
|
|
2176
|
+
* @public
|
|
2177
|
+
*/
|
|
2178
|
+
RoutingProfileId: string | undefined;
|
|
2179
|
+
/**
|
|
2180
|
+
* <p>The queues to be updated for this routing profile. Queues must
|
|
2181
|
+
* first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.</p>
|
|
2182
|
+
* @public
|
|
2183
|
+
*/
|
|
2184
|
+
QueueConfigs: RoutingProfileQueueConfig[] | undefined;
|
|
2185
|
+
}
|
|
2186
|
+
/**
|
|
2187
|
+
* @public
|
|
2188
|
+
*/
|
|
2189
|
+
export interface UpdateRuleRequest {
|
|
2190
|
+
/**
|
|
2191
|
+
* <p>A unique identifier for the rule.</p>
|
|
2192
|
+
* @public
|
|
2193
|
+
*/
|
|
2194
|
+
RuleId: string | undefined;
|
|
2195
|
+
/**
|
|
2196
|
+
* <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>
|
|
2197
|
+
* @public
|
|
2198
|
+
*/
|
|
2199
|
+
InstanceId: string | undefined;
|
|
2200
|
+
/**
|
|
2201
|
+
* <p>The name of the rule. You can change the name only if <code>TriggerEventSource</code> is one of the following
|
|
2202
|
+
* values: <code>OnZendeskTicketCreate</code> | <code>OnZendeskTicketStatusUpdate</code> |
|
|
2203
|
+
* <code>OnSalesforceCaseCreate</code>
|
|
2204
|
+
* </p>
|
|
2205
|
+
* @public
|
|
2206
|
+
*/
|
|
2207
|
+
Name: string | undefined;
|
|
2208
|
+
/**
|
|
2209
|
+
* <p>The conditions of the rule.</p>
|
|
2210
|
+
* @public
|
|
2211
|
+
*/
|
|
2212
|
+
Function: string | undefined;
|
|
2213
|
+
/**
|
|
2214
|
+
* <p>A list of actions to be run when the rule is triggered.</p>
|
|
2215
|
+
* @public
|
|
2216
|
+
*/
|
|
2217
|
+
Actions: RuleAction[] | undefined;
|
|
2218
|
+
/**
|
|
2219
|
+
* <p>The publish status of the rule.</p>
|
|
2220
|
+
* @public
|
|
2221
|
+
*/
|
|
2222
|
+
PublishStatus: RulePublishStatus | undefined;
|
|
2223
|
+
}
|
|
2224
|
+
/**
|
|
2225
|
+
* @public
|
|
2226
|
+
*/
|
|
2227
|
+
export interface UpdateSecurityProfileRequest {
|
|
2228
|
+
/**
|
|
2229
|
+
* <p>The description of the security profile.</p>
|
|
2230
|
+
* @public
|
|
2231
|
+
*/
|
|
2232
|
+
Description?: string | undefined;
|
|
2233
|
+
/**
|
|
2234
|
+
* <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>
|
|
2235
|
+
* @public
|
|
2236
|
+
*/
|
|
2237
|
+
Permissions?: string[] | undefined;
|
|
2238
|
+
/**
|
|
2239
|
+
* <p>The identifier for the security profle.</p>
|
|
2240
|
+
* @public
|
|
2241
|
+
*/
|
|
2242
|
+
SecurityProfileId: string | undefined;
|
|
2243
|
+
/**
|
|
2244
|
+
* <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>
|
|
2245
|
+
* @public
|
|
2246
|
+
*/
|
|
2247
|
+
InstanceId: string | undefined;
|
|
2248
|
+
/**
|
|
2249
|
+
* <p>The list of tags that a security profile uses to restrict access to resources in Amazon Connect.</p>
|
|
2250
|
+
* @public
|
|
2251
|
+
*/
|
|
2252
|
+
AllowedAccessControlTags?: Record<string, string> | undefined;
|
|
2253
|
+
/**
|
|
2254
|
+
* <p>The list of resources that a security profile applies tag restrictions to in Amazon Connect.</p>
|
|
2255
|
+
* @public
|
|
2256
|
+
*/
|
|
2257
|
+
TagRestrictedResources?: string[] | undefined;
|
|
2258
|
+
/**
|
|
2259
|
+
* <p>A list of the third-party application's metadata.</p>
|
|
2260
|
+
* @public
|
|
2261
|
+
*/
|
|
2262
|
+
Applications?: Application[] | undefined;
|
|
2263
|
+
/**
|
|
2264
|
+
* <p>The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following
|
|
2265
|
+
* are acceptable ResourceNames: <code>User</code>.</p>
|
|
2266
|
+
* @public
|
|
2267
|
+
*/
|
|
2268
|
+
HierarchyRestrictedResources?: string[] | undefined;
|
|
2269
|
+
/**
|
|
2270
|
+
* <p>The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.</p>
|
|
2271
|
+
* @public
|
|
2272
|
+
*/
|
|
2273
|
+
AllowedAccessControlHierarchyGroupId?: string | undefined;
|
|
2274
|
+
/**
|
|
2275
|
+
* <p> A list of Flow Modules an AI Agent can invoke as a tool </p>
|
|
2276
|
+
* @public
|
|
2277
|
+
*/
|
|
2278
|
+
AllowedFlowModules?: FlowModule[] | undefined;
|
|
2279
|
+
/**
|
|
2280
|
+
* <p>The granular access control configuration for the security profile, including data table permissions.</p>
|
|
2281
|
+
* @public
|
|
2282
|
+
*/
|
|
2283
|
+
GranularAccessControlConfiguration?: GranularAccessControlConfiguration | undefined;
|
|
2284
|
+
}
|
|
2285
|
+
/**
|
|
2286
|
+
* @public
|
|
2287
|
+
*/
|
|
2288
|
+
export interface UpdateTaskTemplateRequest {
|
|
2289
|
+
/**
|
|
2290
|
+
* <p>A unique identifier for the task template.</p>
|
|
2291
|
+
* @public
|
|
2292
|
+
*/
|
|
2293
|
+
TaskTemplateId: string | undefined;
|
|
2294
|
+
/**
|
|
2295
|
+
* <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>
|
|
2296
|
+
* @public
|
|
2297
|
+
*/
|
|
2298
|
+
InstanceId: string | undefined;
|
|
2299
|
+
/**
|
|
2300
|
+
* <p>The name of the task template.</p>
|
|
2301
|
+
* @public
|
|
2302
|
+
*/
|
|
2303
|
+
Name?: string | undefined;
|
|
2304
|
+
/**
|
|
2305
|
+
* <p>The description of the task template.</p>
|
|
2306
|
+
* @public
|
|
2307
|
+
*/
|
|
2308
|
+
Description?: string | undefined;
|
|
2309
|
+
/**
|
|
2310
|
+
* <p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>
|
|
2311
|
+
* @public
|
|
2312
|
+
*/
|
|
2313
|
+
ContactFlowId?: string | undefined;
|
|
2314
|
+
/**
|
|
2315
|
+
* <p>The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.</p>
|
|
2316
|
+
* @public
|
|
2317
|
+
*/
|
|
2318
|
+
SelfAssignFlowId?: string | undefined;
|
|
2319
|
+
/**
|
|
2320
|
+
* <p>Constraints that are applicable to the fields listed.</p>
|
|
2321
|
+
* @public
|
|
2322
|
+
*/
|
|
2323
|
+
Constraints?: TaskTemplateConstraints | undefined;
|
|
2324
|
+
/**
|
|
2325
|
+
* <p>The default values for fields when a task is created by referencing this template.</p>
|
|
2326
|
+
* @public
|
|
2327
|
+
*/
|
|
2328
|
+
Defaults?: TaskTemplateDefaults | undefined;
|
|
2329
|
+
/**
|
|
2330
|
+
* <p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it.
|
|
2331
|
+
* Tasks can only be created from <code>ACTIVE</code> templates.
|
|
2332
|
+
* If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>
|
|
2333
|
+
* @public
|
|
2334
|
+
*/
|
|
2335
|
+
Status?: TaskTemplateStatus | undefined;
|
|
2336
|
+
/**
|
|
2337
|
+
* <p>Fields that are part of the template.</p>
|
|
2338
|
+
* @public
|
|
2339
|
+
*/
|
|
2340
|
+
Fields?: TaskTemplateField[] | undefined;
|
|
2341
|
+
}
|
|
2342
|
+
/**
|
|
2343
|
+
* @public
|
|
2344
|
+
*/
|
|
2345
|
+
export interface UpdateTaskTemplateResponse {
|
|
2346
|
+
/**
|
|
2347
|
+
* <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>
|
|
2348
|
+
* @public
|
|
2349
|
+
*/
|
|
2350
|
+
InstanceId?: string | undefined;
|
|
2351
|
+
/**
|
|
2352
|
+
* <p>The identifier of the task template resource.</p>
|
|
2353
|
+
* @public
|
|
2354
|
+
*/
|
|
2355
|
+
Id?: string | undefined;
|
|
2356
|
+
/**
|
|
2357
|
+
* <p>The Amazon Resource Name (ARN) for the task template resource.</p>
|
|
2358
|
+
* @public
|
|
2359
|
+
*/
|
|
2360
|
+
Arn?: string | undefined;
|
|
2361
|
+
/**
|
|
2362
|
+
* <p>The name of the task template.</p>
|
|
2363
|
+
* @public
|
|
2364
|
+
*/
|
|
2365
|
+
Name?: string | undefined;
|
|
2366
|
+
/**
|
|
2367
|
+
* <p>The description of the task template.</p>
|
|
2368
|
+
* @public
|
|
2369
|
+
*/
|
|
2370
|
+
Description?: string | undefined;
|
|
2371
|
+
/**
|
|
2372
|
+
* <p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>
|
|
2373
|
+
* @public
|
|
2374
|
+
*/
|
|
2375
|
+
ContactFlowId?: string | undefined;
|
|
2376
|
+
/**
|
|
2377
|
+
* <p>The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.</p>
|
|
2378
|
+
* @public
|
|
2379
|
+
*/
|
|
2380
|
+
SelfAssignFlowId?: string | undefined;
|
|
2381
|
+
/**
|
|
2382
|
+
* <p>Constraints that are applicable to the fields listed.</p>
|
|
2383
|
+
* @public
|
|
2384
|
+
*/
|
|
2385
|
+
Constraints?: TaskTemplateConstraints | undefined;
|
|
2386
|
+
/**
|
|
2387
|
+
* <p>The default values for fields when a task is created by referencing this template.</p>
|
|
2388
|
+
* @public
|
|
2389
|
+
*/
|
|
2390
|
+
Defaults?: TaskTemplateDefaults | undefined;
|
|
2391
|
+
/**
|
|
2392
|
+
* <p>Fields that are part of the template.</p>
|
|
2393
|
+
* @public
|
|
2394
|
+
*/
|
|
2395
|
+
Fields?: TaskTemplateField[] | undefined;
|
|
2396
|
+
/**
|
|
2397
|
+
* <p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it.
|
|
2398
|
+
* Tasks can only be created from <code>ACTIVE</code> templates.
|
|
2399
|
+
* If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>
|
|
2400
|
+
* @public
|
|
2401
|
+
*/
|
|
2402
|
+
Status?: TaskTemplateStatus | undefined;
|
|
2403
|
+
/**
|
|
2404
|
+
* <p>The timestamp when the task template was last modified.</p>
|
|
2405
|
+
* @public
|
|
2406
|
+
*/
|
|
2407
|
+
LastModifiedTime?: Date | undefined;
|
|
2408
|
+
/**
|
|
2409
|
+
* <p>The timestamp when the task template was created.</p>
|
|
2410
|
+
* @public
|
|
2411
|
+
*/
|
|
2412
|
+
CreatedTime?: Date | undefined;
|
|
2413
|
+
}
|
|
2414
|
+
/**
|
|
2415
|
+
* @public
|
|
2416
|
+
*/
|
|
2417
|
+
export interface UpdateTrafficDistributionRequest {
|
|
2418
|
+
/**
|
|
2419
|
+
* <p>The identifier of the traffic distribution group.
|
|
2420
|
+
* This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
|
|
2421
|
+
* The ARN must be provided if the call is from the replicated Region. </p>
|
|
2422
|
+
* @public
|
|
2423
|
+
*/
|
|
2424
|
+
Id: string | undefined;
|
|
2425
|
+
/**
|
|
2426
|
+
* <p>The distribution of traffic between the instance and its replica(s).</p>
|
|
2427
|
+
* @public
|
|
2428
|
+
*/
|
|
2429
|
+
TelephonyConfig?: TelephonyConfig | undefined;
|
|
2430
|
+
/**
|
|
2431
|
+
* <p>The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both
|
|
2432
|
+
* the instance and its replica(s).</p>
|
|
2433
|
+
* @public
|
|
2434
|
+
*/
|
|
2435
|
+
SignInConfig?: SignInConfig | undefined;
|
|
2436
|
+
/**
|
|
2437
|
+
* <p>The distribution of agents between the instance and its replica(s).</p>
|
|
2438
|
+
* @public
|
|
2439
|
+
*/
|
|
2440
|
+
AgentConfig?: AgentConfig | undefined;
|
|
2441
|
+
}
|
|
2442
|
+
/**
|
|
2443
|
+
* @public
|
|
2444
|
+
*/
|
|
2445
|
+
export interface UpdateTrafficDistributionResponse {
|
|
2446
|
+
}
|
|
2447
|
+
/**
|
|
2448
|
+
* @public
|
|
2449
|
+
*/
|
|
2450
|
+
export interface UpdateUserHierarchyRequest {
|
|
2451
|
+
/**
|
|
2452
|
+
* <p>The identifier of the hierarchy group.</p>
|
|
2453
|
+
* @public
|
|
2454
|
+
*/
|
|
2455
|
+
HierarchyGroupId?: string | undefined;
|
|
2456
|
+
/**
|
|
2457
|
+
* <p>The identifier of the user account.</p>
|
|
2458
|
+
* @public
|
|
2459
|
+
*/
|
|
2460
|
+
UserId: string | undefined;
|
|
2461
|
+
/**
|
|
2462
|
+
* <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>
|
|
2463
|
+
* @public
|
|
2464
|
+
*/
|
|
2465
|
+
InstanceId: string | undefined;
|
|
2466
|
+
}
|
|
2467
|
+
/**
|
|
2468
|
+
* @public
|
|
2469
|
+
*/
|
|
2470
|
+
export interface UpdateUserHierarchyGroupNameRequest {
|
|
2471
|
+
/**
|
|
2472
|
+
* <p>The name of the hierarchy group. Must not be more than 100 characters.</p>
|
|
2473
|
+
* @public
|
|
2474
|
+
*/
|
|
2475
|
+
Name: string | undefined;
|
|
2476
|
+
/**
|
|
2477
|
+
* <p>The identifier of the hierarchy group.</p>
|
|
2478
|
+
* @public
|
|
2479
|
+
*/
|
|
2480
|
+
HierarchyGroupId: string | undefined;
|
|
2481
|
+
/**
|
|
2482
|
+
* <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>
|
|
2483
|
+
* @public
|
|
2484
|
+
*/
|
|
2485
|
+
InstanceId: string | undefined;
|
|
2486
|
+
}
|
|
2487
|
+
/**
|
|
2488
|
+
* <p>Contains information about the hierarchy level to update.</p>
|
|
2489
|
+
* @public
|
|
2490
|
+
*/
|
|
2491
|
+
export interface HierarchyLevelUpdate {
|
|
2492
|
+
/**
|
|
2493
|
+
* <p>The name of the user hierarchy level. Must not be more than 50 characters.</p>
|
|
2494
|
+
* @public
|
|
2495
|
+
*/
|
|
2496
|
+
Name: string | undefined;
|
|
2497
|
+
}
|
|
2498
|
+
/**
|
|
2499
|
+
* <p>Contains information about the level hierarchy to update.</p>
|
|
2500
|
+
* @public
|
|
2501
|
+
*/
|
|
2502
|
+
export interface HierarchyStructureUpdate {
|
|
2503
|
+
/**
|
|
2504
|
+
* <p>The
|
|
2505
|
+
* update
|
|
2506
|
+
* for level one.</p>
|
|
2507
|
+
* @public
|
|
2508
|
+
*/
|
|
2509
|
+
LevelOne?: HierarchyLevelUpdate | undefined;
|
|
2510
|
+
/**
|
|
2511
|
+
* <p>The update for level two.</p>
|
|
2512
|
+
* @public
|
|
2513
|
+
*/
|
|
2514
|
+
LevelTwo?: HierarchyLevelUpdate | undefined;
|
|
2515
|
+
/**
|
|
2516
|
+
* <p>The update for level three.</p>
|
|
2517
|
+
* @public
|
|
2518
|
+
*/
|
|
2519
|
+
LevelThree?: HierarchyLevelUpdate | undefined;
|
|
2520
|
+
/**
|
|
2521
|
+
* <p>The update for level four.</p>
|
|
2522
|
+
* @public
|
|
2523
|
+
*/
|
|
2524
|
+
LevelFour?: HierarchyLevelUpdate | undefined;
|
|
2525
|
+
/**
|
|
2526
|
+
* <p>The update for level five.</p>
|
|
2527
|
+
* @public
|
|
2528
|
+
*/
|
|
2529
|
+
LevelFive?: HierarchyLevelUpdate | undefined;
|
|
2530
|
+
}
|
|
2531
|
+
/**
|
|
2532
|
+
* @public
|
|
2533
|
+
*/
|
|
2534
|
+
export interface UpdateUserHierarchyStructureRequest {
|
|
2535
|
+
/**
|
|
2536
|
+
* <p>The hierarchy levels to update.</p>
|
|
2537
|
+
* @public
|
|
2538
|
+
*/
|
|
2539
|
+
HierarchyStructure: HierarchyStructureUpdate | undefined;
|
|
2540
|
+
/**
|
|
2541
|
+
* <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>
|
|
2542
|
+
* @public
|
|
2543
|
+
*/
|
|
2544
|
+
InstanceId: string | undefined;
|
|
2545
|
+
}
|
|
2546
|
+
/**
|
|
2547
|
+
* @public
|
|
2548
|
+
*/
|
|
2549
|
+
export interface UpdateUserIdentityInfoRequest {
|
|
2550
|
+
/**
|
|
2551
|
+
* <p>The identity information for the user.</p>
|
|
2552
|
+
* @public
|
|
2553
|
+
*/
|
|
2554
|
+
IdentityInfo: UserIdentityInfo | undefined;
|
|
2555
|
+
/**
|
|
2556
|
+
* <p>The identifier of the user account.</p>
|
|
2557
|
+
* @public
|
|
2558
|
+
*/
|
|
2559
|
+
UserId: string | undefined;
|
|
2560
|
+
/**
|
|
2561
|
+
* <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>
|
|
2562
|
+
* @public
|
|
2563
|
+
*/
|
|
2564
|
+
InstanceId: string | undefined;
|
|
2565
|
+
}
|
|
2566
|
+
/**
|
|
2567
|
+
* @public
|
|
2568
|
+
*/
|
|
2569
|
+
export interface UpdateUserPhoneConfigRequest {
|
|
2570
|
+
/**
|
|
2571
|
+
* <p>Information about phone configuration settings for the user.</p>
|
|
2572
|
+
* @public
|
|
2573
|
+
*/
|
|
2574
|
+
PhoneConfig: UserPhoneConfig | undefined;
|
|
2575
|
+
/**
|
|
2576
|
+
* <p>The identifier of the user account.</p>
|
|
2577
|
+
* @public
|
|
2578
|
+
*/
|
|
2579
|
+
UserId: string | undefined;
|
|
2580
|
+
/**
|
|
2581
|
+
* <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>
|
|
2582
|
+
* @public
|
|
2583
|
+
*/
|
|
2584
|
+
InstanceId: string | undefined;
|
|
2585
|
+
}
|
|
2586
|
+
/**
|
|
2587
|
+
* @public
|
|
2588
|
+
*/
|
|
2589
|
+
export interface UpdateUserProficienciesRequest {
|
|
2590
|
+
/**
|
|
2591
|
+
* <p> The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the
|
|
2592
|
+
* instance.</p>
|
|
2593
|
+
* @public
|
|
2594
|
+
*/
|
|
2595
|
+
InstanceId: string | undefined;
|
|
2596
|
+
/**
|
|
2597
|
+
* <p>The identifier of the user account.</p>
|
|
2598
|
+
* @public
|
|
2599
|
+
*/
|
|
2600
|
+
UserId: string | undefined;
|
|
2601
|
+
/**
|
|
2602
|
+
* <p>The proficiencies to be updated for the user. Proficiencies must first be associated to the user. You can do
|
|
2603
|
+
* this using AssociateUserProficiencies API.</p>
|
|
2604
|
+
* @public
|
|
2605
|
+
*/
|
|
2606
|
+
UserProficiencies: UserProficiency[] | undefined;
|
|
2607
|
+
}
|
|
2608
|
+
/**
|
|
2609
|
+
* @public
|
|
2610
|
+
*/
|
|
2611
|
+
export interface UpdateUserRoutingProfileRequest {
|
|
2612
|
+
/**
|
|
2613
|
+
* <p>The identifier of the routing profile for the user.</p>
|
|
2614
|
+
* @public
|
|
2615
|
+
*/
|
|
2616
|
+
RoutingProfileId: string | undefined;
|
|
2617
|
+
/**
|
|
2618
|
+
* <p>The identifier of the user account.</p>
|
|
2619
|
+
* @public
|
|
2620
|
+
*/
|
|
2621
|
+
UserId: string | undefined;
|
|
2622
|
+
/**
|
|
2623
|
+
* <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>
|
|
2624
|
+
* @public
|
|
2625
|
+
*/
|
|
2626
|
+
InstanceId: string | undefined;
|
|
2627
|
+
}
|
|
2628
|
+
/**
|
|
2629
|
+
* @public
|
|
2630
|
+
*/
|
|
2631
|
+
export interface UpdateUserSecurityProfilesRequest {
|
|
2632
|
+
/**
|
|
2633
|
+
* <p>The identifiers of the security profiles for the user.</p>
|
|
2634
|
+
* @public
|
|
2635
|
+
*/
|
|
2636
|
+
SecurityProfileIds: string[] | undefined;
|
|
2637
|
+
/**
|
|
2638
|
+
* <p>The identifier of the user account.</p>
|
|
2639
|
+
* @public
|
|
2640
|
+
*/
|
|
2641
|
+
UserId: string | undefined;
|
|
2642
|
+
/**
|
|
2643
|
+
* <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>
|
|
2644
|
+
* @public
|
|
2645
|
+
*/
|
|
2646
|
+
InstanceId: string | undefined;
|
|
2647
|
+
}
|
|
2648
|
+
/**
|
|
2649
|
+
* @public
|
|
2650
|
+
*/
|
|
2651
|
+
export interface UpdateViewContentRequest {
|
|
2652
|
+
/**
|
|
2653
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the
|
|
2654
|
+
* instance.</p>
|
|
2655
|
+
* @public
|
|
2656
|
+
*/
|
|
2657
|
+
InstanceId: string | undefined;
|
|
2658
|
+
/**
|
|
2659
|
+
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be used.</p>
|
|
2660
|
+
* @public
|
|
2661
|
+
*/
|
|
2662
|
+
ViewId: string | undefined;
|
|
2663
|
+
/**
|
|
2664
|
+
* <p>Indicates the view status as either <code>SAVED</code> or <code>PUBLISHED</code>. The <code>PUBLISHED</code>
|
|
2665
|
+
* status will initiate validation on the content.</p>
|
|
2666
|
+
* @public
|
|
2667
|
+
*/
|
|
2668
|
+
Status: ViewStatus | undefined;
|
|
2669
|
+
/**
|
|
2670
|
+
* <p>View content containing all content necessary to render a view except for runtime input data and the runtime
|
|
2671
|
+
* input schema, which is auto-generated by this operation.</p>
|
|
2672
|
+
* <p>The total uncompressed content has a maximum file size of 400kB.</p>
|
|
2673
|
+
* @public
|
|
2674
|
+
*/
|
|
2675
|
+
Content: ViewInputContent | undefined;
|
|
2676
|
+
}
|
|
2677
|
+
/**
|
|
2678
|
+
* @public
|
|
2679
|
+
*/
|
|
2680
|
+
export interface UpdateViewContentResponse {
|
|
2681
|
+
/**
|
|
2682
|
+
* <p>A view resource object. Contains metadata and content necessary to render the view.</p>
|
|
2683
|
+
* @public
|
|
2684
|
+
*/
|
|
2685
|
+
View?: View | undefined;
|
|
2686
|
+
}
|
|
2687
|
+
/**
|
|
2688
|
+
* @public
|
|
2689
|
+
*/
|
|
2690
|
+
export interface UpdateViewMetadataRequest {
|
|
2691
|
+
/**
|
|
2692
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the
|
|
2693
|
+
* instance.</p>
|
|
2694
|
+
* @public
|
|
2695
|
+
*/
|
|
2696
|
+
InstanceId: string | undefined;
|
|
2697
|
+
/**
|
|
2698
|
+
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be used.</p>
|
|
2699
|
+
* @public
|
|
2700
|
+
*/
|
|
2701
|
+
ViewId: string | undefined;
|
|
2702
|
+
/**
|
|
2703
|
+
* <p>The name of the view.</p>
|
|
2704
|
+
* @public
|
|
2705
|
+
*/
|
|
2706
|
+
Name?: string | undefined;
|
|
2707
|
+
/**
|
|
2708
|
+
* <p>The description of the view.</p>
|
|
2709
|
+
* @public
|
|
2710
|
+
*/
|
|
2711
|
+
Description?: string | undefined;
|
|
2712
|
+
}
|
|
2713
|
+
/**
|
|
2714
|
+
* @public
|
|
2715
|
+
*/
|
|
2716
|
+
export interface UpdateViewMetadataResponse {
|
|
2717
|
+
}
|
|
2718
|
+
/**
|
|
2719
|
+
* @public
|
|
2720
|
+
*/
|
|
2721
|
+
export interface UpdateWorkspaceMetadataRequest {
|
|
2722
|
+
/**
|
|
2723
|
+
* <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>
|
|
2724
|
+
* @public
|
|
2725
|
+
*/
|
|
2726
|
+
InstanceId: string | undefined;
|
|
2727
|
+
/**
|
|
2728
|
+
* <p>The identifier of the workspace.</p>
|
|
2729
|
+
* @public
|
|
2730
|
+
*/
|
|
2731
|
+
WorkspaceId: string | undefined;
|
|
2732
|
+
/**
|
|
2733
|
+
* <p>The name of the workspace.</p>
|
|
2734
|
+
* @public
|
|
2735
|
+
*/
|
|
2736
|
+
Name?: string | undefined;
|
|
2737
|
+
/**
|
|
2738
|
+
* <p>The description of the workspace.</p>
|
|
2739
|
+
* @public
|
|
2740
|
+
*/
|
|
2741
|
+
Description?: string | undefined;
|
|
2742
|
+
/**
|
|
2743
|
+
* <p>The title displayed for the workspace.</p>
|
|
2744
|
+
* @public
|
|
2745
|
+
*/
|
|
2746
|
+
Title?: string | undefined;
|
|
2747
|
+
}
|
|
2748
|
+
/**
|
|
2749
|
+
* @public
|
|
2750
|
+
*/
|
|
2751
|
+
export interface UpdateWorkspaceMetadataResponse {
|
|
2752
|
+
}
|
|
2753
|
+
/**
|
|
2754
|
+
* @public
|
|
2755
|
+
*/
|
|
2756
|
+
export interface UpdateWorkspacePageRequest {
|
|
2757
|
+
/**
|
|
2758
|
+
* <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>
|
|
2759
|
+
* @public
|
|
2760
|
+
*/
|
|
2761
|
+
InstanceId: string | undefined;
|
|
2762
|
+
/**
|
|
2763
|
+
* <p>The identifier of the workspace.</p>
|
|
2764
|
+
* @public
|
|
2765
|
+
*/
|
|
2766
|
+
WorkspaceId: string | undefined;
|
|
2767
|
+
/**
|
|
2768
|
+
* <p>The current page identifier.</p>
|
|
2769
|
+
* @public
|
|
2770
|
+
*/
|
|
2771
|
+
Page: string | undefined;
|
|
2772
|
+
/**
|
|
2773
|
+
* <p>The new page identifier, if changing the page name.</p>
|
|
2774
|
+
* @public
|
|
2775
|
+
*/
|
|
2776
|
+
NewPage?: string | undefined;
|
|
2777
|
+
/**
|
|
2778
|
+
* <p>The Amazon Resource Name (ARN) of the view to associate with the page.</p>
|
|
2779
|
+
* @public
|
|
2780
|
+
*/
|
|
2781
|
+
ResourceArn?: string | undefined;
|
|
2782
|
+
/**
|
|
2783
|
+
* <p>The URL-friendly identifier for the page.</p>
|
|
2784
|
+
* @public
|
|
2785
|
+
*/
|
|
2786
|
+
Slug?: string | undefined;
|
|
2787
|
+
/**
|
|
2788
|
+
* <p>A JSON string containing input parameters for the view.</p>
|
|
2789
|
+
* @public
|
|
2790
|
+
*/
|
|
2791
|
+
InputData?: string | undefined;
|
|
2792
|
+
}
|
|
2793
|
+
/**
|
|
2794
|
+
* @public
|
|
2795
|
+
*/
|
|
2796
|
+
export interface UpdateWorkspacePageResponse {
|
|
2797
|
+
}
|
|
2798
|
+
/**
|
|
2799
|
+
* @public
|
|
2800
|
+
*/
|
|
2801
|
+
export interface UpdateWorkspaceThemeRequest {
|
|
2802
|
+
/**
|
|
2803
|
+
* <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>
|
|
2804
|
+
* @public
|
|
2805
|
+
*/
|
|
2806
|
+
InstanceId: string | undefined;
|
|
2807
|
+
/**
|
|
2808
|
+
* <p>The identifier of the workspace.</p>
|
|
2809
|
+
* @public
|
|
2810
|
+
*/
|
|
2811
|
+
WorkspaceId: string | undefined;
|
|
2812
|
+
/**
|
|
2813
|
+
* <p>The theme configuration, including color schemes and visual styles.</p>
|
|
2814
|
+
* @public
|
|
2815
|
+
*/
|
|
2816
|
+
Theme?: WorkspaceTheme | undefined;
|
|
2817
|
+
}
|
|
2818
|
+
/**
|
|
2819
|
+
* @public
|
|
2820
|
+
*/
|
|
2821
|
+
export interface UpdateWorkspaceThemeResponse {
|
|
2822
|
+
}
|
|
2823
|
+
/**
|
|
2824
|
+
* @public
|
|
2825
|
+
*/
|
|
2826
|
+
export interface UpdateWorkspaceVisibilityRequest {
|
|
2827
|
+
/**
|
|
2828
|
+
* <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>
|
|
2829
|
+
* @public
|
|
2830
|
+
*/
|
|
2831
|
+
InstanceId: string | undefined;
|
|
2832
|
+
/**
|
|
2833
|
+
* <p>The identifier of the workspace.</p>
|
|
2834
|
+
* @public
|
|
2835
|
+
*/
|
|
2836
|
+
WorkspaceId: string | undefined;
|
|
2837
|
+
/**
|
|
2838
|
+
* <p>The visibility setting for the workspace. Valid values are: <code>ALL</code> (available to all users), <code>ASSIGNED</code> (available only to assigned users and routing profiles), and <code>NONE</code> (not visible to any users).</p>
|
|
2839
|
+
* @public
|
|
2840
|
+
*/
|
|
2841
|
+
Visibility: Visibility | undefined;
|
|
2842
|
+
}
|
|
2843
|
+
/**
|
|
2844
|
+
* @public
|
|
2845
|
+
*/
|
|
2846
|
+
export interface UpdateWorkspaceVisibilityResponse {
|
|
2847
|
+
}
|
|
2848
|
+
/**
|
|
2849
|
+
* <p>A condition for item enablement.</p>
|
|
2850
|
+
* @public
|
|
2851
|
+
*/
|
|
2852
|
+
export interface EvaluationFormItemEnablementCondition {
|
|
2853
|
+
/**
|
|
2854
|
+
* <p>Operands of the enablement condition.</p>
|
|
2855
|
+
* @public
|
|
2856
|
+
*/
|
|
2857
|
+
Operands: EvaluationFormItemEnablementConditionOperand[] | undefined;
|
|
2858
|
+
/**
|
|
2859
|
+
* <p>The operator to be used to be applied to operands if more than one provided. </p>
|
|
2860
|
+
* @public
|
|
2861
|
+
*/
|
|
2862
|
+
Operator?: EvaluationFormItemEnablementOperator | undefined;
|
|
2863
|
+
}
|
|
2864
|
+
/**
|
|
2865
|
+
* <p>An operand of the enablement condition.</p>
|
|
2866
|
+
* @public
|
|
2867
|
+
*/
|
|
2868
|
+
export type EvaluationFormItemEnablementConditionOperand = EvaluationFormItemEnablementConditionOperand.ConditionMember | EvaluationFormItemEnablementConditionOperand.ExpressionMember | EvaluationFormItemEnablementConditionOperand.$UnknownMember;
|
|
2869
|
+
/**
|
|
2870
|
+
* @public
|
|
2871
|
+
*/
|
|
2872
|
+
export declare namespace EvaluationFormItemEnablementConditionOperand {
|
|
2873
|
+
/**
|
|
2874
|
+
* <p>An expression of the enablement condition.</p>
|
|
2875
|
+
* @public
|
|
2876
|
+
*/
|
|
2877
|
+
interface ExpressionMember {
|
|
2878
|
+
Expression: EvaluationFormItemEnablementExpression;
|
|
2879
|
+
Condition?: never;
|
|
2880
|
+
$unknown?: never;
|
|
2881
|
+
}
|
|
2882
|
+
/**
|
|
2883
|
+
* <p>A condition for item enablement.</p>
|
|
2884
|
+
* @public
|
|
2885
|
+
*/
|
|
2886
|
+
interface ConditionMember {
|
|
2887
|
+
Expression?: never;
|
|
2888
|
+
Condition: EvaluationFormItemEnablementCondition;
|
|
2889
|
+
$unknown?: never;
|
|
2890
|
+
}
|
|
2891
|
+
/**
|
|
2892
|
+
* @public
|
|
2893
|
+
*/
|
|
2894
|
+
interface $UnknownMember {
|
|
2895
|
+
Expression?: never;
|
|
2896
|
+
Condition?: never;
|
|
2897
|
+
$unknown: [string, any];
|
|
2898
|
+
}
|
|
2899
|
+
/**
|
|
2900
|
+
* @deprecated unused in schema-serde mode.
|
|
2901
|
+
*
|
|
2902
|
+
*/
|
|
2903
|
+
interface Visitor<T> {
|
|
2904
|
+
Expression: (value: EvaluationFormItemEnablementExpression) => T;
|
|
2905
|
+
Condition: (value: EvaluationFormItemEnablementCondition) => T;
|
|
2906
|
+
_: (name: string, value: any) => T;
|
|
2907
|
+
}
|
|
2908
|
+
}
|
|
2909
|
+
/**
|
|
2910
|
+
* <p>The search criteria to be used to return agent statuses.</p>
|
|
2911
|
+
* @public
|
|
2912
|
+
*/
|
|
2913
|
+
export interface AgentStatusSearchCriteria {
|
|
2914
|
+
/**
|
|
2915
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
|
|
2916
|
+
* @public
|
|
2917
|
+
*/
|
|
2918
|
+
OrConditions?: AgentStatusSearchCriteria[] | undefined;
|
|
2919
|
+
/**
|
|
2920
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
2921
|
+
* <note>
|
|
2922
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>,
|
|
2923
|
+
* <code>state</code>, <code>type</code>, <code>displayOrder</code>, and <code>resourceID</code>.</p>
|
|
2924
|
+
* </note>
|
|
2925
|
+
* @public
|
|
2926
|
+
*/
|
|
2927
|
+
AndConditions?: AgentStatusSearchCriteria[] | undefined;
|
|
2928
|
+
/**
|
|
2929
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
2930
|
+
* <note>
|
|
2931
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>,
|
|
2932
|
+
* <code>state</code>, <code>type</code>, <code>displayOrder</code>, and <code>resourceID</code>.</p>
|
|
2933
|
+
* </note>
|
|
2934
|
+
* @public
|
|
2935
|
+
*/
|
|
2936
|
+
StringCondition?: StringCondition | undefined;
|
|
2937
|
+
}
|
|
2938
|
+
/**
|
|
2939
|
+
* <p>The search criteria to be used to return flow modules.</p>
|
|
2940
|
+
* @public
|
|
2941
|
+
*/
|
|
2942
|
+
export interface ContactFlowModuleSearchCriteria {
|
|
2943
|
+
/**
|
|
2944
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
|
|
2945
|
+
* @public
|
|
2946
|
+
*/
|
|
2947
|
+
OrConditions?: ContactFlowModuleSearchCriteria[] | undefined;
|
|
2948
|
+
/**
|
|
2949
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>
|
|
2950
|
+
* @public
|
|
2951
|
+
*/
|
|
2952
|
+
AndConditions?: ContactFlowModuleSearchCriteria[] | undefined;
|
|
2953
|
+
/**
|
|
2954
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
2955
|
+
* @public
|
|
2956
|
+
*/
|
|
2957
|
+
StringCondition?: StringCondition | undefined;
|
|
2958
|
+
/**
|
|
2959
|
+
* <p>The state of the flow.</p>
|
|
2960
|
+
* @public
|
|
2961
|
+
*/
|
|
2962
|
+
StateCondition?: ContactFlowModuleState | undefined;
|
|
2963
|
+
/**
|
|
2964
|
+
* <p>The status of the flow.</p>
|
|
2965
|
+
* @public
|
|
2966
|
+
*/
|
|
2967
|
+
StatusCondition?: ContactFlowModuleStatus | undefined;
|
|
2968
|
+
}
|
|
2969
|
+
/**
|
|
2970
|
+
* <p>The search criteria to be used to return flows.</p>
|
|
2971
|
+
* @public
|
|
2972
|
+
*/
|
|
2973
|
+
export interface ContactFlowSearchCriteria {
|
|
2974
|
+
/**
|
|
2975
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
|
|
2976
|
+
* @public
|
|
2977
|
+
*/
|
|
2978
|
+
OrConditions?: ContactFlowSearchCriteria[] | undefined;
|
|
2979
|
+
/**
|
|
2980
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>
|
|
2981
|
+
* @public
|
|
2982
|
+
*/
|
|
2983
|
+
AndConditions?: ContactFlowSearchCriteria[] | undefined;
|
|
2984
|
+
/**
|
|
2985
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
2986
|
+
* @public
|
|
2987
|
+
*/
|
|
2988
|
+
StringCondition?: StringCondition | undefined;
|
|
2989
|
+
/**
|
|
2990
|
+
* <p>The type of flow.</p>
|
|
2991
|
+
* @public
|
|
2992
|
+
*/
|
|
2993
|
+
TypeCondition?: ContactFlowType | undefined;
|
|
2994
|
+
/**
|
|
2995
|
+
* <p>The state of the flow.</p>
|
|
2996
|
+
* @public
|
|
2997
|
+
*/
|
|
2998
|
+
StateCondition?: ContactFlowState | undefined;
|
|
2999
|
+
/**
|
|
3000
|
+
* <p>The status of the flow.</p>
|
|
3001
|
+
* @public
|
|
3002
|
+
*/
|
|
3003
|
+
StatusCondition?: ContactFlowStatus | undefined;
|
|
3004
|
+
}
|
|
3005
|
+
/**
|
|
3006
|
+
* <p>A data table search criteria.</p>
|
|
3007
|
+
* @public
|
|
3008
|
+
*/
|
|
3009
|
+
export interface DataTableSearchCriteria {
|
|
3010
|
+
/**
|
|
3011
|
+
* <p>The criteria's or conditions.</p>
|
|
3012
|
+
* @public
|
|
3013
|
+
*/
|
|
3014
|
+
OrConditions?: DataTableSearchCriteria[] | undefined;
|
|
3015
|
+
/**
|
|
3016
|
+
* <p>The criteria's and conditions.</p>
|
|
3017
|
+
* @public
|
|
3018
|
+
*/
|
|
3019
|
+
AndConditions?: DataTableSearchCriteria[] | undefined;
|
|
3020
|
+
/**
|
|
3021
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3022
|
+
* @public
|
|
3023
|
+
*/
|
|
3024
|
+
StringCondition?: StringCondition | undefined;
|
|
3025
|
+
}
|
|
3026
|
+
/**
|
|
3027
|
+
* <p>The search criteria to be used to return email addresses.</p>
|
|
3028
|
+
* @public
|
|
3029
|
+
*/
|
|
3030
|
+
export interface EmailAddressSearchCriteria {
|
|
3031
|
+
/**
|
|
3032
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
3033
|
+
* @public
|
|
3034
|
+
*/
|
|
3035
|
+
OrConditions?: EmailAddressSearchCriteria[] | undefined;
|
|
3036
|
+
/**
|
|
3037
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
3038
|
+
* @public
|
|
3039
|
+
*/
|
|
3040
|
+
AndConditions?: EmailAddressSearchCriteria[] | undefined;
|
|
3041
|
+
/**
|
|
3042
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3043
|
+
* @public
|
|
3044
|
+
*/
|
|
3045
|
+
StringCondition?: StringCondition | undefined;
|
|
3046
|
+
}
|
|
3047
|
+
/**
|
|
3048
|
+
* <p>An item enablement configuration.</p>
|
|
3049
|
+
* @public
|
|
3050
|
+
*/
|
|
3051
|
+
export interface EvaluationFormItemEnablementConfiguration {
|
|
3052
|
+
/**
|
|
3053
|
+
* <p>A condition for item enablement configuration.</p>
|
|
3054
|
+
* @public
|
|
3055
|
+
*/
|
|
3056
|
+
Condition: EvaluationFormItemEnablementCondition | undefined;
|
|
3057
|
+
/**
|
|
3058
|
+
* <p>An enablement action that if condition is satisfied. </p>
|
|
3059
|
+
* @public
|
|
3060
|
+
*/
|
|
3061
|
+
Action: EvaluationFormItemEnablementAction | undefined;
|
|
3062
|
+
/**
|
|
3063
|
+
* <p>An enablement action that if condition is not satisfied. </p>
|
|
3064
|
+
* @public
|
|
3065
|
+
*/
|
|
3066
|
+
DefaultAction?: EvaluationFormItemEnablementAction | undefined;
|
|
3067
|
+
}
|
|
3068
|
+
/**
|
|
3069
|
+
* <p>The search criteria to be used to return evaluation forms.</p>
|
|
3070
|
+
* @public
|
|
3071
|
+
*/
|
|
3072
|
+
export interface EvaluationFormSearchCriteria {
|
|
3073
|
+
/**
|
|
3074
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
3075
|
+
* @public
|
|
3076
|
+
*/
|
|
3077
|
+
OrConditions?: EvaluationFormSearchCriteria[] | undefined;
|
|
3078
|
+
/**
|
|
3079
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
3080
|
+
* @public
|
|
3081
|
+
*/
|
|
3082
|
+
AndConditions?: EvaluationFormSearchCriteria[] | undefined;
|
|
3083
|
+
/**
|
|
3084
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3085
|
+
* @public
|
|
3086
|
+
*/
|
|
3087
|
+
StringCondition?: StringCondition | undefined;
|
|
3088
|
+
/**
|
|
3089
|
+
* <p>A leaf node condition which can be used to specify a numeric condition.</p>
|
|
3090
|
+
* <note>
|
|
3091
|
+
* <p>The currently supported value for <code>FieldName</code> is <code>limit</code>.</p>
|
|
3092
|
+
* </note>
|
|
3093
|
+
* @public
|
|
3094
|
+
*/
|
|
3095
|
+
NumberCondition?: NumberCondition | undefined;
|
|
3096
|
+
/**
|
|
3097
|
+
* <p>Boolean search condition.</p>
|
|
3098
|
+
* @public
|
|
3099
|
+
*/
|
|
3100
|
+
BooleanCondition?: BooleanCondition | undefined;
|
|
3101
|
+
/**
|
|
3102
|
+
* <p>Datetime search condition.</p>
|
|
3103
|
+
* @public
|
|
3104
|
+
*/
|
|
3105
|
+
DateTimeCondition?: DateTimeCondition | undefined;
|
|
3106
|
+
}
|
|
3107
|
+
/**
|
|
3108
|
+
* <p>The search criteria to be used to return evaluations.</p>
|
|
3109
|
+
* @public
|
|
3110
|
+
*/
|
|
3111
|
+
export interface EvaluationSearchCriteria {
|
|
3112
|
+
/**
|
|
3113
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
3114
|
+
* @public
|
|
3115
|
+
*/
|
|
3116
|
+
OrConditions?: EvaluationSearchCriteria[] | undefined;
|
|
3117
|
+
/**
|
|
3118
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
3119
|
+
* @public
|
|
3120
|
+
*/
|
|
3121
|
+
AndConditions?: EvaluationSearchCriteria[] | undefined;
|
|
3122
|
+
/**
|
|
3123
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3124
|
+
* @public
|
|
3125
|
+
*/
|
|
3126
|
+
StringCondition?: StringCondition | undefined;
|
|
3127
|
+
/**
|
|
3128
|
+
* <p>A leaf node condition which can be used to specify a numeric condition.</p>
|
|
3129
|
+
* <note>
|
|
3130
|
+
* <p>The currently supported value for <code>FieldName</code> is <code>limit</code>.</p>
|
|
3131
|
+
* </note>
|
|
3132
|
+
* @public
|
|
3133
|
+
*/
|
|
3134
|
+
NumberCondition?: NumberCondition | undefined;
|
|
3135
|
+
/**
|
|
3136
|
+
* <p>The boolean condition search criteria for searching evaluations.</p>
|
|
3137
|
+
* @public
|
|
3138
|
+
*/
|
|
3139
|
+
BooleanCondition?: BooleanCondition | undefined;
|
|
3140
|
+
/**
|
|
3141
|
+
* <p>The datetime condition search criteria for searching evaluations.</p>
|
|
3142
|
+
* @public
|
|
3143
|
+
*/
|
|
3144
|
+
DateTimeCondition?: DateTimeCondition | undefined;
|
|
3145
|
+
/**
|
|
3146
|
+
* <p>The decimal condition search criteria for searching evaluations.</p>
|
|
3147
|
+
* @public
|
|
3148
|
+
*/
|
|
3149
|
+
DecimalCondition?: DecimalCondition | undefined;
|
|
3150
|
+
}
|
|
3151
|
+
/**
|
|
3152
|
+
* <p>A tagged union to specify expression for a routing step.</p>
|
|
3153
|
+
* @public
|
|
3154
|
+
*/
|
|
3155
|
+
export interface Expression {
|
|
3156
|
+
/**
|
|
3157
|
+
* <p>An object to specify the predefined attribute condition.</p>
|
|
3158
|
+
* @public
|
|
3159
|
+
*/
|
|
3160
|
+
AttributeCondition?: AttributeCondition | undefined;
|
|
3161
|
+
/**
|
|
3162
|
+
* <p>List of routing expressions which will be AND-ed together.</p>
|
|
3163
|
+
* @public
|
|
3164
|
+
*/
|
|
3165
|
+
AndExpression?: Expression[] | undefined;
|
|
3166
|
+
/**
|
|
3167
|
+
* <p>List of routing expressions which will be OR-ed together.</p>
|
|
3168
|
+
* @public
|
|
3169
|
+
*/
|
|
3170
|
+
OrExpression?: Expression[] | undefined;
|
|
3171
|
+
/**
|
|
3172
|
+
* <p>An object to specify the predefined attribute condition.</p>
|
|
3173
|
+
* @public
|
|
3174
|
+
*/
|
|
3175
|
+
NotAttributeCondition?: AttributeCondition | undefined;
|
|
3176
|
+
}
|
|
3177
|
+
/**
|
|
3178
|
+
* <p>The search criteria to be used to return hours of operations overrides.</p>
|
|
3179
|
+
* @public
|
|
3180
|
+
*/
|
|
3181
|
+
export interface HoursOfOperationOverrideSearchCriteria {
|
|
3182
|
+
/**
|
|
3183
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
3184
|
+
* @public
|
|
3185
|
+
*/
|
|
3186
|
+
OrConditions?: HoursOfOperationOverrideSearchCriteria[] | undefined;
|
|
3187
|
+
/**
|
|
3188
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
3189
|
+
* @public
|
|
3190
|
+
*/
|
|
3191
|
+
AndConditions?: HoursOfOperationOverrideSearchCriteria[] | undefined;
|
|
3192
|
+
/**
|
|
3193
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3194
|
+
* @public
|
|
3195
|
+
*/
|
|
3196
|
+
StringCondition?: StringCondition | undefined;
|
|
3197
|
+
/**
|
|
3198
|
+
* <p>A leaf node condition which can be used to specify a date condition.</p>
|
|
3199
|
+
* @public
|
|
3200
|
+
*/
|
|
3201
|
+
DateCondition?: DateCondition | undefined;
|
|
3202
|
+
}
|
|
3203
|
+
/**
|
|
3204
|
+
* <p>The search criteria to be used to return hours of operations.</p>
|
|
3205
|
+
* @public
|
|
3206
|
+
*/
|
|
3207
|
+
export interface HoursOfOperationSearchCriteria {
|
|
3208
|
+
/**
|
|
3209
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
3210
|
+
* @public
|
|
3211
|
+
*/
|
|
3212
|
+
OrConditions?: HoursOfOperationSearchCriteria[] | undefined;
|
|
3213
|
+
/**
|
|
3214
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
3215
|
+
* @public
|
|
3216
|
+
*/
|
|
3217
|
+
AndConditions?: HoursOfOperationSearchCriteria[] | undefined;
|
|
3218
|
+
/**
|
|
3219
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3220
|
+
* <note>
|
|
3221
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>,
|
|
3222
|
+
* <code>timezone</code>, and <code>resourceID</code>.</p>
|
|
3223
|
+
* </note>
|
|
3224
|
+
* @public
|
|
3225
|
+
*/
|
|
3226
|
+
StringCondition?: StringCondition | undefined;
|
|
3227
|
+
}
|
|
3228
|
+
/**
|
|
3229
|
+
* <p>The search criteria to be used to return predefined attributes.</p>
|
|
3230
|
+
* @public
|
|
3231
|
+
*/
|
|
3232
|
+
export interface PredefinedAttributeSearchCriteria {
|
|
3233
|
+
/**
|
|
3234
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
|
|
3235
|
+
* @public
|
|
3236
|
+
*/
|
|
3237
|
+
OrConditions?: PredefinedAttributeSearchCriteria[] | undefined;
|
|
3238
|
+
/**
|
|
3239
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>
|
|
3240
|
+
* @public
|
|
3241
|
+
*/
|
|
3242
|
+
AndConditions?: PredefinedAttributeSearchCriteria[] | undefined;
|
|
3243
|
+
/**
|
|
3244
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3245
|
+
* @public
|
|
3246
|
+
*/
|
|
3247
|
+
StringCondition?: StringCondition | undefined;
|
|
3248
|
+
}
|
|
3249
|
+
/**
|
|
3250
|
+
* <p>The search criteria to be used to return prompts.</p>
|
|
3251
|
+
* @public
|
|
3252
|
+
*/
|
|
3253
|
+
export interface PromptSearchCriteria {
|
|
3254
|
+
/**
|
|
3255
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
3256
|
+
* @public
|
|
3257
|
+
*/
|
|
3258
|
+
OrConditions?: PromptSearchCriteria[] | undefined;
|
|
3259
|
+
/**
|
|
3260
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
3261
|
+
* @public
|
|
3262
|
+
*/
|
|
3263
|
+
AndConditions?: PromptSearchCriteria[] | undefined;
|
|
3264
|
+
/**
|
|
3265
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3266
|
+
* <note>
|
|
3267
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>, and
|
|
3268
|
+
* <code>resourceID</code>.</p>
|
|
3269
|
+
* </note>
|
|
3270
|
+
* @public
|
|
3271
|
+
*/
|
|
3272
|
+
StringCondition?: StringCondition | undefined;
|
|
3273
|
+
}
|
|
3274
|
+
/**
|
|
3275
|
+
* <p>The search criteria to be used to return queues.</p>
|
|
3276
|
+
* <note>
|
|
3277
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
3278
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
3279
|
+
* outside of this range will throw invalid results. </p>
|
|
3280
|
+
* </note>
|
|
3281
|
+
* @public
|
|
3282
|
+
*/
|
|
3283
|
+
export interface QueueSearchCriteria {
|
|
3284
|
+
/**
|
|
3285
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
3286
|
+
* @public
|
|
3287
|
+
*/
|
|
3288
|
+
OrConditions?: QueueSearchCriteria[] | undefined;
|
|
3289
|
+
/**
|
|
3290
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
3291
|
+
* @public
|
|
3292
|
+
*/
|
|
3293
|
+
AndConditions?: QueueSearchCriteria[] | undefined;
|
|
3294
|
+
/**
|
|
3295
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3296
|
+
* <note>
|
|
3297
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>, and
|
|
3298
|
+
* <code>resourceID</code>.</p>
|
|
3299
|
+
* </note>
|
|
3300
|
+
* @public
|
|
3301
|
+
*/
|
|
3302
|
+
StringCondition?: StringCondition | undefined;
|
|
3303
|
+
/**
|
|
3304
|
+
* <p>The type of queue.</p>
|
|
3305
|
+
* @public
|
|
3306
|
+
*/
|
|
3307
|
+
QueueTypeCondition?: SearchableQueueType | undefined;
|
|
3308
|
+
}
|
|
3309
|
+
/**
|
|
3310
|
+
* <p>The search criteria to be used to return quick connects.</p>
|
|
3311
|
+
* @public
|
|
3312
|
+
*/
|
|
3313
|
+
export interface QuickConnectSearchCriteria {
|
|
3314
|
+
/**
|
|
3315
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
3316
|
+
* @public
|
|
3317
|
+
*/
|
|
3318
|
+
OrConditions?: QuickConnectSearchCriteria[] | undefined;
|
|
3319
|
+
/**
|
|
3320
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
3321
|
+
* @public
|
|
3322
|
+
*/
|
|
3323
|
+
AndConditions?: QuickConnectSearchCriteria[] | undefined;
|
|
3324
|
+
/**
|
|
3325
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3326
|
+
* <note>
|
|
3327
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>, and
|
|
3328
|
+
* <code>resourceID</code>.</p>
|
|
3329
|
+
* </note>
|
|
3330
|
+
* @public
|
|
3331
|
+
*/
|
|
3332
|
+
StringCondition?: StringCondition | undefined;
|
|
3333
|
+
}
|
|
3334
|
+
/**
|
|
3335
|
+
* <p>The search criteria to be used to return routing profiles.</p>
|
|
3336
|
+
* <note>
|
|
3337
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
3338
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
3339
|
+
* outside of this range will throw invalid results. </p>
|
|
3340
|
+
* </note>
|
|
3341
|
+
* @public
|
|
3342
|
+
*/
|
|
3343
|
+
export interface RoutingProfileSearchCriteria {
|
|
3344
|
+
/**
|
|
3345
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
3346
|
+
* @public
|
|
3347
|
+
*/
|
|
3348
|
+
OrConditions?: RoutingProfileSearchCriteria[] | undefined;
|
|
3349
|
+
/**
|
|
3350
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
3351
|
+
* @public
|
|
3352
|
+
*/
|
|
3353
|
+
AndConditions?: RoutingProfileSearchCriteria[] | undefined;
|
|
3354
|
+
/**
|
|
3355
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3356
|
+
* <note>
|
|
3357
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>associatedQueueIds</code>,
|
|
3358
|
+
* <code>name</code>, <code>description</code>, and <code>resourceID</code>.</p>
|
|
3359
|
+
* </note>
|
|
3360
|
+
* @public
|
|
3361
|
+
*/
|
|
3362
|
+
StringCondition?: StringCondition | undefined;
|
|
3363
|
+
}
|
|
3364
|
+
/**
|
|
3365
|
+
* <p>The search criteria to be used to return security profiles.</p>
|
|
3366
|
+
* <note>
|
|
3367
|
+
* <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and maximum of 25
|
|
3368
|
+
* characters. Any queries with character lengths outside of this range will throw invalid
|
|
3369
|
+
* results.</p>
|
|
3370
|
+
* </note>
|
|
3371
|
+
* @public
|
|
3372
|
+
*/
|
|
3373
|
+
export interface SecurityProfileSearchCriteria {
|
|
3374
|
+
/**
|
|
3375
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
3376
|
+
* @public
|
|
3377
|
+
*/
|
|
3378
|
+
OrConditions?: SecurityProfileSearchCriteria[] | undefined;
|
|
3379
|
+
/**
|
|
3380
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
3381
|
+
* @public
|
|
3382
|
+
*/
|
|
3383
|
+
AndConditions?: SecurityProfileSearchCriteria[] | undefined;
|
|
3384
|
+
/**
|
|
3385
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3386
|
+
* @public
|
|
3387
|
+
*/
|
|
3388
|
+
StringCondition?: StringCondition | undefined;
|
|
3389
|
+
}
|
|
3390
|
+
/**
|
|
3391
|
+
* <p>A value for a segment attribute. This is structured as a map where the key is <code>valueString</code> and the
|
|
3392
|
+
* value is a string.</p>
|
|
3393
|
+
* @public
|
|
3394
|
+
*/
|
|
3395
|
+
export interface SegmentAttributeValue {
|
|
3396
|
+
/**
|
|
3397
|
+
* <p>The value of a segment attribute.</p>
|
|
3398
|
+
* @public
|
|
3399
|
+
*/
|
|
3400
|
+
ValueString?: string | undefined;
|
|
3401
|
+
/**
|
|
3402
|
+
* <p>The value of a segment attribute.</p>
|
|
3403
|
+
* @public
|
|
3404
|
+
*/
|
|
3405
|
+
ValueMap?: Record<string, SegmentAttributeValue> | undefined;
|
|
3406
|
+
/**
|
|
3407
|
+
* <p>The value of a segment attribute.</p>
|
|
3408
|
+
* @public
|
|
3409
|
+
*/
|
|
3410
|
+
ValueInteger?: number | undefined;
|
|
3411
|
+
/**
|
|
3412
|
+
* <p>The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined
|
|
3413
|
+
* attributes.</p>
|
|
3414
|
+
* @public
|
|
3415
|
+
*/
|
|
3416
|
+
ValueList?: SegmentAttributeValue[] | undefined;
|
|
3417
|
+
/**
|
|
3418
|
+
* <p>The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined
|
|
3419
|
+
* attributes, not for user-defined attributes.</p>
|
|
3420
|
+
* @public
|
|
3421
|
+
*/
|
|
3422
|
+
ValueArn?: string | undefined;
|
|
3423
|
+
}
|
|
3424
|
+
/**
|
|
3425
|
+
* <p>The search criteria to be used to return userHierarchyGroup.</p>
|
|
3426
|
+
* @public
|
|
3427
|
+
*/
|
|
3428
|
+
export interface UserHierarchyGroupSearchCriteria {
|
|
3429
|
+
/**
|
|
3430
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
3431
|
+
* @public
|
|
3432
|
+
*/
|
|
3433
|
+
OrConditions?: UserHierarchyGroupSearchCriteria[] | undefined;
|
|
3434
|
+
/**
|
|
3435
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
3436
|
+
* @public
|
|
3437
|
+
*/
|
|
3438
|
+
AndConditions?: UserHierarchyGroupSearchCriteria[] | undefined;
|
|
3439
|
+
/**
|
|
3440
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3441
|
+
* <note>
|
|
3442
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>parentId</code>,
|
|
3443
|
+
* <code>levelId</code>, and <code>resourceID</code>.</p>
|
|
3444
|
+
* </note>
|
|
3445
|
+
* @public
|
|
3446
|
+
*/
|
|
3447
|
+
StringCondition?: StringCondition | undefined;
|
|
3448
|
+
}
|
|
3449
|
+
/**
|
|
3450
|
+
* <p>The search criteria to be used to return users.</p>
|
|
3451
|
+
* <note>
|
|
3452
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
3453
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
3454
|
+
* outside of this range will throw invalid results. </p>
|
|
3455
|
+
* </note>
|
|
3456
|
+
* @public
|
|
3457
|
+
*/
|
|
3458
|
+
export interface UserSearchCriteria {
|
|
3459
|
+
/**
|
|
3460
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
|
|
3461
|
+
* @public
|
|
3462
|
+
*/
|
|
3463
|
+
OrConditions?: UserSearchCriteria[] | undefined;
|
|
3464
|
+
/**
|
|
3465
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code> condition. </p>
|
|
3466
|
+
* @public
|
|
3467
|
+
*/
|
|
3468
|
+
AndConditions?: UserSearchCriteria[] | undefined;
|
|
3469
|
+
/**
|
|
3470
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3471
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>Username</code>, <code>FirstName</code>,
|
|
3472
|
+
* <code>LastName</code>, <code>RoutingProfileId</code>, <code>SecurityProfileId</code>,
|
|
3473
|
+
* <code>resourceId</code>.</p>
|
|
3474
|
+
* @public
|
|
3475
|
+
*/
|
|
3476
|
+
StringCondition?: StringCondition | undefined;
|
|
3477
|
+
/**
|
|
3478
|
+
* <p>A leaf node condition which can be used to specify a List condition to search users with attributes included in
|
|
3479
|
+
* Lists like Proficiencies.</p>
|
|
3480
|
+
* @public
|
|
3481
|
+
*/
|
|
3482
|
+
ListCondition?: ListCondition | undefined;
|
|
3483
|
+
/**
|
|
3484
|
+
* <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
|
|
3485
|
+
* @public
|
|
3486
|
+
*/
|
|
3487
|
+
HierarchyGroupCondition?: HierarchyGroupCondition | undefined;
|
|
3488
|
+
}
|
|
3489
|
+
/**
|
|
3490
|
+
* <p>Defines the search criteria for filtering views.</p>
|
|
3491
|
+
* @public
|
|
3492
|
+
*/
|
|
3493
|
+
export interface ViewSearchCriteria {
|
|
3494
|
+
/**
|
|
3495
|
+
* <p>A list of conditions to be met, where at least one condition must be satisfied.</p>
|
|
3496
|
+
* @public
|
|
3497
|
+
*/
|
|
3498
|
+
OrConditions?: ViewSearchCriteria[] | undefined;
|
|
3499
|
+
/**
|
|
3500
|
+
* <p>A list of conditions that must all be satisfied.</p>
|
|
3501
|
+
* @public
|
|
3502
|
+
*/
|
|
3503
|
+
AndConditions?: ViewSearchCriteria[] | undefined;
|
|
3504
|
+
/**
|
|
3505
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3506
|
+
* @public
|
|
3507
|
+
*/
|
|
3508
|
+
StringCondition?: StringCondition | undefined;
|
|
3509
|
+
/**
|
|
3510
|
+
* <p>A condition that filters views by their type.</p>
|
|
3511
|
+
* @public
|
|
3512
|
+
*/
|
|
3513
|
+
ViewTypeCondition?: ViewType | undefined;
|
|
3514
|
+
/**
|
|
3515
|
+
* <p>A condition that filters views by their status.</p>
|
|
3516
|
+
* @public
|
|
3517
|
+
*/
|
|
3518
|
+
ViewStatusCondition?: ViewStatus | undefined;
|
|
3519
|
+
}
|
|
3520
|
+
/**
|
|
3521
|
+
* <p>Defines the search criteria for filtering workspace associations.</p>
|
|
3522
|
+
* @public
|
|
3523
|
+
*/
|
|
3524
|
+
export interface WorkspaceAssociationSearchCriteria {
|
|
3525
|
+
/**
|
|
3526
|
+
* <p>A list of conditions to be met, where at least one condition must be satisfied.</p>
|
|
3527
|
+
* @public
|
|
3528
|
+
*/
|
|
3529
|
+
OrConditions?: WorkspaceAssociationSearchCriteria[] | undefined;
|
|
3530
|
+
/**
|
|
3531
|
+
* <p>A list of conditions that must all be satisfied.</p>
|
|
3532
|
+
* @public
|
|
3533
|
+
*/
|
|
3534
|
+
AndConditions?: WorkspaceAssociationSearchCriteria[] | undefined;
|
|
3535
|
+
/**
|
|
3536
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3537
|
+
* @public
|
|
3538
|
+
*/
|
|
3539
|
+
StringCondition?: StringCondition | undefined;
|
|
3540
|
+
}
|
|
3541
|
+
/**
|
|
3542
|
+
* <p>Defines the search criteria for filtering workspaces.</p>
|
|
3543
|
+
* @public
|
|
3544
|
+
*/
|
|
3545
|
+
export interface WorkspaceSearchCriteria {
|
|
3546
|
+
/**
|
|
3547
|
+
* <p>A list of conditions to be met, where at least one condition must be satisfied.</p>
|
|
3548
|
+
* @public
|
|
3549
|
+
*/
|
|
3550
|
+
OrConditions?: WorkspaceSearchCriteria[] | undefined;
|
|
3551
|
+
/**
|
|
3552
|
+
* <p>A list of conditions that must all be satisfied.</p>
|
|
3553
|
+
* @public
|
|
3554
|
+
*/
|
|
3555
|
+
AndConditions?: WorkspaceSearchCriteria[] | undefined;
|
|
3556
|
+
/**
|
|
3557
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
3558
|
+
* @public
|
|
3559
|
+
*/
|
|
3560
|
+
StringCondition?: StringCondition | undefined;
|
|
3561
|
+
}
|
|
3562
|
+
/**
|
|
3563
|
+
* <p>Information about a question from an evaluation form.</p>
|
|
3564
|
+
* @public
|
|
3565
|
+
*/
|
|
3566
|
+
export interface EvaluationFormQuestion {
|
|
3567
|
+
/**
|
|
3568
|
+
* <p>The title of the question.</p>
|
|
3569
|
+
* @public
|
|
3570
|
+
*/
|
|
3571
|
+
Title: string | undefined;
|
|
3572
|
+
/**
|
|
3573
|
+
* <p>The instructions of the section.</p>
|
|
3574
|
+
* @public
|
|
3575
|
+
*/
|
|
3576
|
+
Instructions?: string | undefined;
|
|
3577
|
+
/**
|
|
3578
|
+
* <p>The identifier of the question. An identifier must be unique within the evaluation form.</p>
|
|
3579
|
+
* @public
|
|
3580
|
+
*/
|
|
3581
|
+
RefId: string | undefined;
|
|
3582
|
+
/**
|
|
3583
|
+
* <p>The flag to enable not applicable answers to the question.</p>
|
|
3584
|
+
* @public
|
|
3585
|
+
*/
|
|
3586
|
+
NotApplicableEnabled?: boolean | undefined;
|
|
3587
|
+
/**
|
|
3588
|
+
* <p>The type of the question.</p>
|
|
3589
|
+
* @public
|
|
3590
|
+
*/
|
|
3591
|
+
QuestionType: EvaluationFormQuestionType | undefined;
|
|
3592
|
+
/**
|
|
3593
|
+
* <p>The properties of the type of question. Text questions do not have to define question type properties.</p>
|
|
3594
|
+
* @public
|
|
3595
|
+
*/
|
|
3596
|
+
QuestionTypeProperties?: EvaluationFormQuestionTypeProperties | undefined;
|
|
3597
|
+
/**
|
|
3598
|
+
* <p>A question conditional enablement.</p>
|
|
3599
|
+
* @public
|
|
3600
|
+
*/
|
|
3601
|
+
Enablement?: EvaluationFormItemEnablementConfiguration | undefined;
|
|
3602
|
+
/**
|
|
3603
|
+
* <p>The scoring weight of the section.</p>
|
|
3604
|
+
* @public
|
|
3605
|
+
*/
|
|
3606
|
+
Weight?: number | undefined;
|
|
3607
|
+
}
|
|
3608
|
+
/**
|
|
3609
|
+
* <p>Step defines the list of agents to be routed or route based on the agent requirements such as ProficiencyLevel,
|
|
3610
|
+
* Name, or Value.</p>
|
|
3611
|
+
* @public
|
|
3612
|
+
*/
|
|
3613
|
+
export interface RoutingCriteriaInputStep {
|
|
3614
|
+
/**
|
|
3615
|
+
* <p>An object to specify the expiration of a routing step.</p>
|
|
3616
|
+
* @public
|
|
3617
|
+
*/
|
|
3618
|
+
Expiry?: RoutingCriteriaInputStepExpiry | undefined;
|
|
3619
|
+
/**
|
|
3620
|
+
* <p>A tagged union to specify expression for a routing step.</p>
|
|
3621
|
+
* @public
|
|
3622
|
+
*/
|
|
3623
|
+
Expression?: Expression | undefined;
|
|
3624
|
+
}
|
|
5
3625
|
/**
|
|
6
3626
|
* @public
|
|
7
3627
|
*/
|
|
8
3628
|
export interface SearchAgentStatusesRequest {
|
|
9
3629
|
/**
|
|
10
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
11
|
-
*
|
|
3630
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the
|
|
3631
|
+
* instance.</p>
|
|
12
3632
|
* @public
|
|
13
3633
|
*/
|
|
14
3634
|
InstanceId: string | undefined;
|
|
15
3635
|
/**
|
|
16
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
17
|
-
*
|
|
3636
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
3637
|
+
* retrieve the next set of results.</p>
|
|
18
3638
|
* @public
|
|
19
3639
|
*/
|
|
20
3640
|
NextToken?: string | undefined;
|
|
@@ -70,14 +3690,14 @@ export interface SearchContactEvaluationsRequest {
|
|
|
70
3690
|
*/
|
|
71
3691
|
export interface SearchContactFlowModulesRequest {
|
|
72
3692
|
/**
|
|
73
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the
|
|
74
|
-
*
|
|
3693
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name
|
|
3694
|
+
* (ARN) of the instance.</p>
|
|
75
3695
|
* @public
|
|
76
3696
|
*/
|
|
77
3697
|
InstanceId: string | undefined;
|
|
78
3698
|
/**
|
|
79
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
80
|
-
*
|
|
3699
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
3700
|
+
* retrieve the next set of results.</p>
|
|
81
3701
|
* @public
|
|
82
3702
|
*/
|
|
83
3703
|
NextToken?: string | undefined;
|
|
@@ -94,9 +3714,9 @@ export interface SearchContactFlowModulesRequest {
|
|
|
94
3714
|
/**
|
|
95
3715
|
* <p>The search criteria to be used to return flow modules.</p>
|
|
96
3716
|
* <note>
|
|
97
|
-
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a
|
|
98
|
-
*
|
|
99
|
-
*
|
|
3717
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a minimum of 2
|
|
3718
|
+
* characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in
|
|
3719
|
+
* invalid results.</p>
|
|
100
3720
|
* </note>
|
|
101
3721
|
* @public
|
|
102
3722
|
*/
|
|
@@ -107,14 +3727,14 @@ export interface SearchContactFlowModulesRequest {
|
|
|
107
3727
|
*/
|
|
108
3728
|
export interface SearchContactFlowsRequest {
|
|
109
3729
|
/**
|
|
110
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the
|
|
111
|
-
*
|
|
3730
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name
|
|
3731
|
+
* (ARN) of the instance.</p>
|
|
112
3732
|
* @public
|
|
113
3733
|
*/
|
|
114
3734
|
InstanceId: string | undefined;
|
|
115
3735
|
/**
|
|
116
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
117
|
-
*
|
|
3736
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
3737
|
+
* retrieve the next set of results.</p>
|
|
118
3738
|
* @public
|
|
119
3739
|
*/
|
|
120
3740
|
NextToken?: string | undefined;
|
|
@@ -131,14 +3751,44 @@ export interface SearchContactFlowsRequest {
|
|
|
131
3751
|
/**
|
|
132
3752
|
* <p>The search criteria to be used to return flows.</p>
|
|
133
3753
|
* <note>
|
|
134
|
-
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a
|
|
135
|
-
*
|
|
136
|
-
*
|
|
3754
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a minimum of 2
|
|
3755
|
+
* characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in
|
|
3756
|
+
* invalid results.</p>
|
|
137
3757
|
* </note>
|
|
138
3758
|
* @public
|
|
139
3759
|
*/
|
|
140
3760
|
SearchCriteria?: ContactFlowSearchCriteria | undefined;
|
|
141
3761
|
}
|
|
3762
|
+
/**
|
|
3763
|
+
* @public
|
|
3764
|
+
*/
|
|
3765
|
+
export interface SearchDataTablesRequest {
|
|
3766
|
+
/**
|
|
3767
|
+
* <p>The unique identifier for the Amazon Connect instance to search within.</p>
|
|
3768
|
+
* @public
|
|
3769
|
+
*/
|
|
3770
|
+
InstanceId: string | undefined;
|
|
3771
|
+
/**
|
|
3772
|
+
* <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
|
|
3773
|
+
* @public
|
|
3774
|
+
*/
|
|
3775
|
+
NextToken?: string | undefined;
|
|
3776
|
+
/**
|
|
3777
|
+
* <p>The maximum number of data tables to return in one page of results.</p>
|
|
3778
|
+
* @public
|
|
3779
|
+
*/
|
|
3780
|
+
MaxResults?: number | undefined;
|
|
3781
|
+
/**
|
|
3782
|
+
* <p>Optional filters to apply to the search results, such as tag-based filtering for attribute-based access control.</p>
|
|
3783
|
+
* @public
|
|
3784
|
+
*/
|
|
3785
|
+
SearchFilter?: DataTableSearchFilter | undefined;
|
|
3786
|
+
/**
|
|
3787
|
+
* <p>Search criteria including string conditions for matching table names, descriptions, or resource IDs. Supports STARTS_WITH, CONTAINS, and EXACT comparison types.</p>
|
|
3788
|
+
* @public
|
|
3789
|
+
*/
|
|
3790
|
+
SearchCriteria?: DataTableSearchCriteria | undefined;
|
|
3791
|
+
}
|
|
142
3792
|
/**
|
|
143
3793
|
* @public
|
|
144
3794
|
*/
|
|
@@ -211,8 +3861,8 @@ export interface SearchHoursOfOperationOverridesRequest {
|
|
|
211
3861
|
*/
|
|
212
3862
|
InstanceId: string | undefined;
|
|
213
3863
|
/**
|
|
214
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
215
|
-
*
|
|
3864
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
3865
|
+
* retrieve the next set of results. </p>
|
|
216
3866
|
* @public
|
|
217
3867
|
*/
|
|
218
3868
|
NextToken?: string | undefined;
|
|
@@ -268,14 +3918,14 @@ export interface SearchHoursOfOperationsRequest {
|
|
|
268
3918
|
*/
|
|
269
3919
|
export interface SearchPredefinedAttributesRequest {
|
|
270
3920
|
/**
|
|
271
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
|
|
272
|
-
*
|
|
3921
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the
|
|
3922
|
+
* instance.</p>
|
|
273
3923
|
* @public
|
|
274
3924
|
*/
|
|
275
3925
|
InstanceId: string | undefined;
|
|
276
3926
|
/**
|
|
277
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
278
|
-
*
|
|
3927
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
3928
|
+
* retrieve the next set of results.</p>
|
|
279
3929
|
* @public
|
|
280
3930
|
*/
|
|
281
3931
|
NextToken?: string | undefined;
|
|
@@ -447,9 +4097,8 @@ export interface SearchSecurityProfilesRequest {
|
|
|
447
4097
|
/**
|
|
448
4098
|
* <p>The search criteria to be used to return security profiles. </p>
|
|
449
4099
|
* <note>
|
|
450
|
-
* <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and
|
|
451
|
-
*
|
|
452
|
-
* invalid results.</p>
|
|
4100
|
+
* <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and maximum of 25
|
|
4101
|
+
* characters. Any queries with character lengths outside of this range will throw invalid results.</p>
|
|
453
4102
|
* </note>
|
|
454
4103
|
* <note>
|
|
455
4104
|
* <p>The currently supported value for <code>FieldName</code>: <code>name</code>
|
|
@@ -469,14 +4118,14 @@ export interface SearchSecurityProfilesRequest {
|
|
|
469
4118
|
*/
|
|
470
4119
|
export interface SearchUserHierarchyGroupsRequest {
|
|
471
4120
|
/**
|
|
472
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
473
|
-
*
|
|
4121
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the
|
|
4122
|
+
* instance.</p>
|
|
474
4123
|
* @public
|
|
475
4124
|
*/
|
|
476
4125
|
InstanceId: string | undefined;
|
|
477
4126
|
/**
|
|
478
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
479
|
-
*
|
|
4127
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
4128
|
+
* retrieve the next set of results.</p>
|
|
480
4129
|
* @public
|
|
481
4130
|
*/
|
|
482
4131
|
NextToken?: string | undefined;
|
|
@@ -532,6 +4181,96 @@ export interface SearchUsersRequest {
|
|
|
532
4181
|
*/
|
|
533
4182
|
SearchCriteria?: UserSearchCriteria | undefined;
|
|
534
4183
|
}
|
|
4184
|
+
/**
|
|
4185
|
+
* @public
|
|
4186
|
+
*/
|
|
4187
|
+
export interface SearchViewsRequest {
|
|
4188
|
+
/**
|
|
4189
|
+
* <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>
|
|
4190
|
+
* @public
|
|
4191
|
+
*/
|
|
4192
|
+
InstanceId: string | undefined;
|
|
4193
|
+
/**
|
|
4194
|
+
* <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>
|
|
4195
|
+
* @public
|
|
4196
|
+
*/
|
|
4197
|
+
NextToken?: string | undefined;
|
|
4198
|
+
/**
|
|
4199
|
+
* <p>The maximum number of results to return per page.</p>
|
|
4200
|
+
* @public
|
|
4201
|
+
*/
|
|
4202
|
+
MaxResults?: number | undefined;
|
|
4203
|
+
/**
|
|
4204
|
+
* <p>Filters to apply to the search, such as tag-based filters.</p>
|
|
4205
|
+
* @public
|
|
4206
|
+
*/
|
|
4207
|
+
SearchFilter?: ViewSearchFilter | undefined;
|
|
4208
|
+
/**
|
|
4209
|
+
* <p>The search criteria, including field names and comparison types.</p>
|
|
4210
|
+
* @public
|
|
4211
|
+
*/
|
|
4212
|
+
SearchCriteria?: ViewSearchCriteria | undefined;
|
|
4213
|
+
}
|
|
4214
|
+
/**
|
|
4215
|
+
* @public
|
|
4216
|
+
*/
|
|
4217
|
+
export interface SearchWorkspaceAssociationsRequest {
|
|
4218
|
+
/**
|
|
4219
|
+
* <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>
|
|
4220
|
+
* @public
|
|
4221
|
+
*/
|
|
4222
|
+
InstanceId: string | undefined;
|
|
4223
|
+
/**
|
|
4224
|
+
* <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>
|
|
4225
|
+
* @public
|
|
4226
|
+
*/
|
|
4227
|
+
NextToken?: string | undefined;
|
|
4228
|
+
/**
|
|
4229
|
+
* <p>The maximum number of results to return per page.</p>
|
|
4230
|
+
* @public
|
|
4231
|
+
*/
|
|
4232
|
+
MaxResults?: number | undefined;
|
|
4233
|
+
/**
|
|
4234
|
+
* <p>Filters to apply to the search, such as tag-based filters.</p>
|
|
4235
|
+
* @public
|
|
4236
|
+
*/
|
|
4237
|
+
SearchFilter?: WorkspaceAssociationSearchFilter | undefined;
|
|
4238
|
+
/**
|
|
4239
|
+
* <p>The search criteria, including workspace ID, resource ID, or resource type.</p>
|
|
4240
|
+
* @public
|
|
4241
|
+
*/
|
|
4242
|
+
SearchCriteria?: WorkspaceAssociationSearchCriteria | undefined;
|
|
4243
|
+
}
|
|
4244
|
+
/**
|
|
4245
|
+
* @public
|
|
4246
|
+
*/
|
|
4247
|
+
export interface SearchWorkspacesRequest {
|
|
4248
|
+
/**
|
|
4249
|
+
* <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>
|
|
4250
|
+
* @public
|
|
4251
|
+
*/
|
|
4252
|
+
InstanceId: string | undefined;
|
|
4253
|
+
/**
|
|
4254
|
+
* <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>
|
|
4255
|
+
* @public
|
|
4256
|
+
*/
|
|
4257
|
+
NextToken?: string | undefined;
|
|
4258
|
+
/**
|
|
4259
|
+
* <p>The maximum number of results to return per page.</p>
|
|
4260
|
+
* @public
|
|
4261
|
+
*/
|
|
4262
|
+
MaxResults?: number | undefined;
|
|
4263
|
+
/**
|
|
4264
|
+
* <p>Filters to apply to the search, such as tag-based filters.</p>
|
|
4265
|
+
* @public
|
|
4266
|
+
*/
|
|
4267
|
+
SearchFilter?: WorkspaceSearchFilter | undefined;
|
|
4268
|
+
/**
|
|
4269
|
+
* <p>The search criteria, including field names and comparison types.</p>
|
|
4270
|
+
* @public
|
|
4271
|
+
*/
|
|
4272
|
+
SearchCriteria?: WorkspaceSearchCriteria | undefined;
|
|
4273
|
+
}
|
|
535
4274
|
/**
|
|
536
4275
|
* <p>Step signifies the criteria to be used for routing to an agent</p>
|
|
537
4276
|
* @public
|
|
@@ -554,9 +4293,9 @@ export interface Step {
|
|
|
554
4293
|
Status?: RoutingCriteriaStepStatus | undefined;
|
|
555
4294
|
}
|
|
556
4295
|
/**
|
|
557
|
-
* <p>The value of a segment attribute. This is structured as a map with a single key-value pair.
|
|
558
|
-
*
|
|
559
|
-
*
|
|
4296
|
+
* <p>The value of a segment attribute. This is structured as a map with a single key-value pair. The key
|
|
4297
|
+
* 'valueString' indicates that the attribute type is a string, and its corresponding value is the actual string value
|
|
4298
|
+
* of the segment attribute.</p>
|
|
560
4299
|
* @public
|
|
561
4300
|
*/
|
|
562
4301
|
export interface ContactSearchSummarySegmentAttributeValue {
|
|
@@ -594,24 +4333,24 @@ export interface CreateContactRequest {
|
|
|
594
4333
|
*/
|
|
595
4334
|
RelatedContactId?: string | undefined;
|
|
596
4335
|
/**
|
|
597
|
-
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and
|
|
598
|
-
*
|
|
599
|
-
*
|
|
4336
|
+
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and
|
|
4337
|
+
* can be accessed in flows just like any other contact attributes.</p>
|
|
4338
|
+
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only
|
|
4339
|
+
* alphanumeric, dash, and underscore characters.</p>
|
|
600
4340
|
* @public
|
|
601
4341
|
*/
|
|
602
4342
|
Attributes?: Record<string, string> | undefined;
|
|
603
4343
|
/**
|
|
604
|
-
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
|
|
605
|
-
*
|
|
606
|
-
* <code>
|
|
4344
|
+
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following
|
|
4345
|
+
* reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> |
|
|
4346
|
+
* <code>DATE</code> | <code>EMAIL</code> | <code>ATTACHMENT</code>.</p>
|
|
607
4347
|
* @public
|
|
608
4348
|
*/
|
|
609
4349
|
References?: Record<string, Reference> | undefined;
|
|
610
4350
|
/**
|
|
611
4351
|
* <p>The channel for the contact.</p>
|
|
612
4352
|
* <important>
|
|
613
|
-
* <p>The CHAT channel is not supported. The following information is incorrect. We're working to
|
|
614
|
-
* correct it.</p>
|
|
4353
|
+
* <p>The CHAT channel is not supported. The following information is incorrect. We're working to correct it.</p>
|
|
615
4354
|
* </important>
|
|
616
4355
|
* @public
|
|
617
4356
|
*/
|
|
@@ -634,8 +4373,7 @@ export interface CreateContactRequest {
|
|
|
634
4373
|
* </p>
|
|
635
4374
|
* </li>
|
|
636
4375
|
* </ul>
|
|
637
|
-
* <p>The other channels listed below are incorrect. We're working to correct this
|
|
638
|
-
* information.</p>
|
|
4376
|
+
* <p>The other channels listed below are incorrect. We're working to correct this information.</p>
|
|
639
4377
|
* </important>
|
|
640
4378
|
* @public
|
|
641
4379
|
*/
|
|
@@ -648,15 +4386,15 @@ export interface CreateContactRequest {
|
|
|
648
4386
|
/**
|
|
649
4387
|
* <p>User details for the contact</p>
|
|
650
4388
|
* <important>
|
|
651
|
-
* <p>UserInfo is required when creating an EMAIL contact with <code>OUTBOUND</code> and
|
|
652
|
-
*
|
|
4389
|
+
* <p>UserInfo is required when creating an EMAIL contact with <code>OUTBOUND</code> and <code>AGENT_REPLY</code>
|
|
4390
|
+
* contact initiation methods.</p>
|
|
653
4391
|
* </important>
|
|
654
4392
|
* @public
|
|
655
4393
|
*/
|
|
656
4394
|
UserInfo?: UserInfo | undefined;
|
|
657
4395
|
/**
|
|
658
|
-
* <p>Initial state of the contact when it's created. Only TASK channel contacts can be initiated
|
|
659
|
-
*
|
|
4396
|
+
* <p>Initial state of the contact when it's created. Only TASK channel contacts can be initiated with
|
|
4397
|
+
* <code>COMPLETED</code> state.</p>
|
|
660
4398
|
* @public
|
|
661
4399
|
*/
|
|
662
4400
|
InitiateAs?: InitiateAs | undefined;
|
|
@@ -671,25 +4409,22 @@ export interface CreateContactRequest {
|
|
|
671
4409
|
*/
|
|
672
4410
|
Description?: string | undefined;
|
|
673
4411
|
/**
|
|
674
|
-
* <p>A set of system defined key-value pairs stored on individual contact segments (unique
|
|
675
|
-
*
|
|
676
|
-
* They can be accessed in flows.</p>
|
|
4412
|
+
* <p>A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an
|
|
4413
|
+
* attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</p>
|
|
677
4414
|
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
678
4415
|
* <p>This field can be used to set Segment Contact Expiry as a duration in minutes.</p>
|
|
679
4416
|
* <note>
|
|
680
|
-
* <p>To set contact expiry, a ValueMap must be specified containing the integer number of
|
|
681
|
-
*
|
|
682
|
-
*
|
|
683
|
-
* 135\}\}\}\}</code>. </p>
|
|
4417
|
+
* <p>To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will
|
|
4418
|
+
* be active for before expiring, with <code>SegmentAttributes</code> like \{ <code> "connect:ContactExpiry":
|
|
4419
|
+
* \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger": 135\}\}\}\}</code>. </p>
|
|
684
4420
|
* </note>
|
|
685
4421
|
* @public
|
|
686
4422
|
*/
|
|
687
4423
|
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
688
4424
|
/**
|
|
689
|
-
* <p>The ID of the previous contact when creating a transfer contact. This value can be provided
|
|
690
|
-
*
|
|
691
|
-
*
|
|
692
|
-
* Guide</i>.</p>
|
|
4425
|
+
* <p>The ID of the previous contact when creating a transfer contact. This value can be provided only for external
|
|
4426
|
+
* audio contacts. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Integrate Amazon Connect Contact Lens with external voice
|
|
4427
|
+
* systems</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
693
4428
|
* @public
|
|
694
4429
|
*/
|
|
695
4430
|
PreviousContactId?: string | undefined;
|
|
@@ -706,18 +4441,18 @@ export interface StartChatContactRequest {
|
|
|
706
4441
|
/**
|
|
707
4442
|
* <p>The identifier of the flow for initiating the chat.
|
|
708
4443
|
* To
|
|
709
|
-
* see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page,
|
|
710
|
-
*
|
|
711
|
-
* information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p>
|
|
4444
|
+
* see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here
|
|
4445
|
+
* in bold: </p>
|
|
712
4446
|
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
713
4447
|
* </p>
|
|
714
4448
|
* @public
|
|
715
4449
|
*/
|
|
716
4450
|
ContactFlowId: string | undefined;
|
|
717
4451
|
/**
|
|
718
|
-
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They
|
|
719
|
-
*
|
|
720
|
-
*
|
|
4452
|
+
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They
|
|
4453
|
+
* can be accessed in flows just like any other contact attributes. </p>
|
|
4454
|
+
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only
|
|
4455
|
+
* alphanumeric, dash, and underscore characters.</p>
|
|
721
4456
|
* @public
|
|
722
4457
|
*/
|
|
723
4458
|
Attributes?: Record<string, string> | undefined;
|
|
@@ -726,6 +4461,11 @@ export interface StartChatContactRequest {
|
|
|
726
4461
|
* @public
|
|
727
4462
|
*/
|
|
728
4463
|
ParticipantDetails: ParticipantDetails | undefined;
|
|
4464
|
+
/**
|
|
4465
|
+
* <p> The configuration of the participant. </p>
|
|
4466
|
+
* @public
|
|
4467
|
+
*/
|
|
4468
|
+
ParticipantConfiguration?: ParticipantConfiguration | undefined;
|
|
729
4469
|
/**
|
|
730
4470
|
* <p>The initial message to be sent to the newly created chat.</p>
|
|
731
4471
|
* @public
|
|
@@ -740,9 +4480,8 @@ export interface StartChatContactRequest {
|
|
|
740
4480
|
*/
|
|
741
4481
|
ClientToken?: string | undefined;
|
|
742
4482
|
/**
|
|
743
|
-
* <p>The total duration of the newly started chat session. If not specified, the chat session
|
|
744
|
-
*
|
|
745
|
-
* configurable time is 10,080 minutes (7 days).</p>
|
|
4483
|
+
* <p>The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25
|
|
4484
|
+
* hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).</p>
|
|
746
4485
|
* @public
|
|
747
4486
|
*/
|
|
748
4487
|
ChatDurationInMinutes?: number | undefined;
|
|
@@ -751,28 +4490,25 @@ export interface StartChatContactRequest {
|
|
|
751
4490
|
* <code>text/markdown</code>, <code>application/json</code>,
|
|
752
4491
|
* <code>application/vnd.amazonaws.connect.message.interactive</code>, and
|
|
753
4492
|
* <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p>
|
|
754
|
-
* <p>Content types must always contain <code>text/plain</code>. You can then put any other
|
|
755
|
-
*
|
|
756
|
-
*
|
|
757
|
-
*
|
|
758
|
-
* application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>
|
|
4493
|
+
* <p>Content types must always contain <code>text/plain</code>. You can then put any other supported type in the
|
|
4494
|
+
* list. For example, all the following lists are valid because they contain <code>text/plain</code>: <code>[text/plain,
|
|
4495
|
+
* text/markdown, application/json]</code>, <code>[text/markdown, text/plain]</code>, <code>[text/plain,
|
|
4496
|
+
* application/json, application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>
|
|
759
4497
|
* <note>
|
|
760
|
-
* <p>The type <code>application/vnd.amazonaws.connect.message.interactive</code> is required to
|
|
761
|
-
* use the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html">Show
|
|
762
|
-
* view</a> flow block.</p>
|
|
4498
|
+
* <p>The type <code>application/vnd.amazonaws.connect.message.interactive</code> is required to use the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html">Show view</a> flow block.</p>
|
|
763
4499
|
* </note>
|
|
764
4500
|
* @public
|
|
765
4501
|
*/
|
|
766
4502
|
SupportedMessagingContentTypes?: string[] | undefined;
|
|
767
4503
|
/**
|
|
768
|
-
* <p>Enable persistent chats. For more information about enabling persistent chat, and for
|
|
769
|
-
*
|
|
4504
|
+
* <p>Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how
|
|
4505
|
+
* to configure for them, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable
|
|
4506
|
+
* persistent chat</a>.</p>
|
|
770
4507
|
* @public
|
|
771
4508
|
*/
|
|
772
4509
|
PersistentChat?: PersistentChat | undefined;
|
|
773
4510
|
/**
|
|
774
|
-
* <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
|
|
775
|
-
* chat starting.</p>
|
|
4511
|
+
* <p>The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.</p>
|
|
776
4512
|
* <note>
|
|
777
4513
|
* <p>You cannot provide data for both RelatedContactId and PersistentChat. </p>
|
|
778
4514
|
* </note>
|
|
@@ -780,24 +4516,22 @@ export interface StartChatContactRequest {
|
|
|
780
4516
|
*/
|
|
781
4517
|
RelatedContactId?: string | undefined;
|
|
782
4518
|
/**
|
|
783
|
-
* <p>A set of system defined key-value pairs stored on individual contact segments using an
|
|
784
|
-
*
|
|
785
|
-
* flows.</p>
|
|
4519
|
+
* <p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The
|
|
4520
|
+
* attributes are standard Amazon Connect attributes. They can be accessed in flows.</p>
|
|
786
4521
|
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
787
4522
|
* <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
|
|
788
4523
|
* <note>
|
|
789
4524
|
* <p>The types <code>application/vnd.amazonaws.connect.message.interactive</code> and
|
|
790
|
-
* <code>application/vnd.amazonaws.connect.message.interactive.response</code> must be present in
|
|
791
|
-
*
|
|
792
|
-
*
|
|
793
|
-
* \}\}</code>.</p>
|
|
4525
|
+
* <code>application/vnd.amazonaws.connect.message.interactive.response</code> must be present in the
|
|
4526
|
+
* SupportedMessagingContentTypes field of this API in order to set <code>SegmentAttributes</code> as \{<code>
|
|
4527
|
+
* "connect:Subtype": \{"valueString" : "connect:Guide" \}\}</code>.</p>
|
|
794
4528
|
* </note>
|
|
795
4529
|
* @public
|
|
796
4530
|
*/
|
|
797
4531
|
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
798
4532
|
/**
|
|
799
|
-
* <p>The customer's identification number. For example, the <code>CustomerId</code> may be a
|
|
800
|
-
*
|
|
4533
|
+
* <p>The customer's identification number. For example, the <code>CustomerId</code> may be a customer number from
|
|
4534
|
+
* your CRM.</p>
|
|
801
4535
|
* @public
|
|
802
4536
|
*/
|
|
803
4537
|
CustomerId?: string | undefined;
|
|
@@ -827,11 +4561,10 @@ export interface StartEmailContactRequest {
|
|
|
827
4561
|
*/
|
|
828
4562
|
Description?: string | undefined;
|
|
829
4563
|
/**
|
|
830
|
-
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can
|
|
831
|
-
*
|
|
832
|
-
* <code>
|
|
833
|
-
*
|
|
834
|
-
* email creation.</p>
|
|
4564
|
+
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following
|
|
4565
|
+
* reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> |
|
|
4566
|
+
* <code>DATE</code>. <code>EMAIL</code> | <code>EMAIL_MESSAGE</code> |<code>ATTACHMENT</code> are not a supported
|
|
4567
|
+
* reference type during email creation.</p>
|
|
835
4568
|
* @public
|
|
836
4569
|
*/
|
|
837
4570
|
References?: Record<string, Reference> | undefined;
|
|
@@ -856,42 +4589,40 @@ export interface StartEmailContactRequest {
|
|
|
856
4589
|
*/
|
|
857
4590
|
Attachments?: EmailAttachment[] | undefined;
|
|
858
4591
|
/**
|
|
859
|
-
* <p>The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website,
|
|
860
|
-
*
|
|
861
|
-
*
|
|
862
|
-
* part of the ARN, shown here in bold: </p>
|
|
4592
|
+
* <p>The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website, on the navigation
|
|
4593
|
+
* menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the
|
|
4594
|
+
* flow page, under the name of the flow, choose <b>Show additional flow information</b>. The
|
|
4595
|
+
* ContactFlowId is the last part of the ARN, shown here in bold: </p>
|
|
863
4596
|
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
864
4597
|
* </p>
|
|
865
4598
|
* @public
|
|
866
4599
|
*/
|
|
867
4600
|
ContactFlowId?: string | undefined;
|
|
868
4601
|
/**
|
|
869
|
-
* <p>The contactId that is related to this contact. Linking emails together by using
|
|
870
|
-
*
|
|
871
|
-
* the new email contact
|
|
872
|
-
*
|
|
873
|
-
* linked by using <code>RelatedContactId</code>. </p>
|
|
4602
|
+
* <p>The contactId that is related to this contact. Linking emails together by using <code>RelatedContactID</code>
|
|
4603
|
+
* copies over contact attributes from the related email contact to the new email contact. All updates to user-defined
|
|
4604
|
+
* attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of
|
|
4605
|
+
* contacts that can be linked by using <code>RelatedContactId</code>. </p>
|
|
874
4606
|
* @public
|
|
875
4607
|
*/
|
|
876
4608
|
RelatedContactId?: string | undefined;
|
|
877
4609
|
/**
|
|
878
|
-
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and
|
|
879
|
-
*
|
|
880
|
-
*
|
|
4610
|
+
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and
|
|
4611
|
+
* can be accessed in flows just like any other contact attributes.</p>
|
|
4612
|
+
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only
|
|
4613
|
+
* alphanumeric, dash, and underscore characters.</p>
|
|
881
4614
|
* @public
|
|
882
4615
|
*/
|
|
883
4616
|
Attributes?: Record<string, string> | undefined;
|
|
884
4617
|
/**
|
|
885
|
-
* <p>A set of system defined key-value pairs stored on individual contact segments using an
|
|
886
|
-
*
|
|
887
|
-
* flows.</p>
|
|
4618
|
+
* <p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The
|
|
4619
|
+
* attributes are standard Amazon Connect attributes. They can be accessed in flows.</p>
|
|
888
4620
|
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
889
4621
|
* <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
|
|
890
4622
|
* <note>
|
|
891
|
-
* <p>To set contact expiry, a <code>ValueMap</code> must be specified containing the integer
|
|
892
|
-
*
|
|
893
|
-
*
|
|
894
|
-
* "ExpiryDuration": \{ "ValueInteger":135\}\}\}\}</code>.</p>
|
|
4623
|
+
* <p>To set contact expiry, a <code>ValueMap</code> must be specified containing the integer number of minutes the
|
|
4624
|
+
* contact will be active for before expiring, with <code>SegmentAttributes</code> like \{ <code>
|
|
4625
|
+
* "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger":135\}\}\}\}</code>.</p>
|
|
895
4626
|
* </note>
|
|
896
4627
|
* @public
|
|
897
4628
|
*/
|
|
@@ -920,15 +4651,14 @@ export interface StartOutboundChatContactRequest {
|
|
|
920
4651
|
*/
|
|
921
4652
|
DestinationEndpoint: Endpoint | undefined;
|
|
922
4653
|
/**
|
|
923
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the
|
|
924
|
-
*
|
|
4654
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name
|
|
4655
|
+
* (ARN) of the instance.</p>
|
|
925
4656
|
* @public
|
|
926
4657
|
*/
|
|
927
4658
|
InstanceId: string | undefined;
|
|
928
4659
|
/**
|
|
929
|
-
* <p>A set of system defined key-value pairs stored on individual contact segments using an
|
|
930
|
-
*
|
|
931
|
-
* flows.</p>
|
|
4660
|
+
* <p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The
|
|
4661
|
+
* attributes are standard Amazon Connect attributes. They can be accessed in flows.</p>
|
|
932
4662
|
* <ul>
|
|
933
4663
|
* <li>
|
|
934
4664
|
* <p>Attribute keys can include only alphanumeric, <code>-</code>, and <code>_</code>.</p>
|
|
@@ -942,16 +4672,16 @@ export interface StartOutboundChatContactRequest {
|
|
|
942
4672
|
*/
|
|
943
4673
|
SegmentAttributes: Record<string, SegmentAttributeValue> | undefined;
|
|
944
4674
|
/**
|
|
945
|
-
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and
|
|
4675
|
+
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and
|
|
4676
|
+
* can be accessed in flows just like any other contact attributes.</p>
|
|
946
4677
|
* @public
|
|
947
4678
|
*/
|
|
948
4679
|
Attributes?: Record<string, string> | undefined;
|
|
949
4680
|
/**
|
|
950
|
-
* <p>The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect
|
|
951
|
-
*
|
|
952
|
-
*
|
|
953
|
-
*
|
|
954
|
-
* part of the ARN, shown here in bold:</p>
|
|
4681
|
+
* <p>The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect console user
|
|
4682
|
+
* interface, on the navigation menu go to <b>Routing, Contact Flows</b>. Choose the flow. On
|
|
4683
|
+
* the flow page, under the name of the flow, choose <b>Show additional flow information</b>.
|
|
4684
|
+
* The ContactFlowId is the last part of the ARN, shown here in bold:</p>
|
|
955
4685
|
* <ul>
|
|
956
4686
|
* <li>
|
|
957
4687
|
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>123ec456-a007-89c0-1234-xxxxxxxxxxxx</b>
|
|
@@ -962,9 +4692,8 @@ export interface StartOutboundChatContactRequest {
|
|
|
962
4692
|
*/
|
|
963
4693
|
ContactFlowId: string | undefined;
|
|
964
4694
|
/**
|
|
965
|
-
* <p>The total duration of the newly started chat session. If not specified, the chat session
|
|
966
|
-
*
|
|
967
|
-
* configurable time is 10,080 minutes (7 days).</p>
|
|
4695
|
+
* <p>The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25
|
|
4696
|
+
* hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).</p>
|
|
968
4697
|
* @public
|
|
969
4698
|
*/
|
|
970
4699
|
ChatDurationInMinutes?: number | undefined;
|
|
@@ -979,8 +4708,8 @@ export interface StartOutboundChatContactRequest {
|
|
|
979
4708
|
*/
|
|
980
4709
|
InitialSystemMessage?: ChatMessage | undefined;
|
|
981
4710
|
/**
|
|
982
|
-
* <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
|
|
983
|
-
*
|
|
4711
|
+
* <p>The unique identifier for an Amazon Connect contact. This identifier is related to the contact
|
|
4712
|
+
* starting.</p>
|
|
984
4713
|
* @public
|
|
985
4714
|
*/
|
|
986
4715
|
RelatedContactId?: string | undefined;
|
|
@@ -999,8 +4728,7 @@ export interface StartOutboundChatContactRequest {
|
|
|
999
4728
|
* </li>
|
|
1000
4729
|
* <li>
|
|
1001
4730
|
* <p>
|
|
1002
|
-
* <code>application/json,
|
|
1003
|
-
* application/vnd.amazonaws.connect.message.interactive</code>
|
|
4731
|
+
* <code>application/json, application/vnd.amazonaws.connect.message.interactive</code>
|
|
1004
4732
|
* </p>
|
|
1005
4733
|
* </li>
|
|
1006
4734
|
* <li>
|
|
@@ -1009,9 +4737,8 @@ export interface StartOutboundChatContactRequest {
|
|
|
1009
4737
|
* </p>
|
|
1010
4738
|
* </li>
|
|
1011
4739
|
* </ul>
|
|
1012
|
-
* <p>Content types must always contain <code>text/plain</code>. You can then put any other
|
|
1013
|
-
*
|
|
1014
|
-
* <code>text/plain</code>:</p>
|
|
4740
|
+
* <p>Content types must always contain <code>text/plain</code>. You can then put any other supported type in the
|
|
4741
|
+
* list. For example, all the following lists are valid because they contain <code>text/plain</code>:</p>
|
|
1015
4742
|
* <ul>
|
|
1016
4743
|
* <li>
|
|
1017
4744
|
* <p>
|
|
@@ -1026,7 +4753,7 @@ export interface StartOutboundChatContactRequest {
|
|
|
1026
4753
|
* <li>
|
|
1027
4754
|
* <p>
|
|
1028
4755
|
* <code>[text/plain, application/json,
|
|
1029
|
-
*
|
|
4756
|
+
* application/vnd.amazonaws.connect.message.interactive.response]</code>
|
|
1030
4757
|
* </p>
|
|
1031
4758
|
* </li>
|
|
1032
4759
|
* </ul>
|
|
@@ -1034,11 +4761,10 @@ export interface StartOutboundChatContactRequest {
|
|
|
1034
4761
|
*/
|
|
1035
4762
|
SupportedMessagingContentTypes?: string[] | undefined;
|
|
1036
4763
|
/**
|
|
1037
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1038
|
-
*
|
|
1039
|
-
*
|
|
1040
|
-
*
|
|
1041
|
-
* contact is already started, the contact ID is returned.</p>
|
|
4764
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
|
|
4765
|
+
* the AWS 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
|
|
4766
|
+
* idempotent APIs</a>. The token is valid for 7 days after creation. If a contact is already started, the contact
|
|
4767
|
+
* ID is returned.</p>
|
|
1042
4768
|
* @public
|
|
1043
4769
|
*/
|
|
1044
4770
|
ClientToken?: string | undefined;
|
|
@@ -1053,26 +4779,27 @@ export interface StartTaskContactRequest {
|
|
|
1053
4779
|
*/
|
|
1054
4780
|
InstanceId: string | undefined;
|
|
1055
4781
|
/**
|
|
1056
|
-
* <p>The identifier of the previous chat, voice, or task contact. Any updates to user-defined
|
|
1057
|
-
*
|
|
1058
|
-
*
|
|
4782
|
+
* <p>The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task
|
|
4783
|
+
* contacts linked using the same <code>PreviousContactID</code> will affect every contact in the chain. There can be a
|
|
4784
|
+
* maximum of 12 linked task contacts in a chain.</p>
|
|
1059
4785
|
* @public
|
|
1060
4786
|
*/
|
|
1061
4787
|
PreviousContactId?: string | undefined;
|
|
1062
4788
|
/**
|
|
1063
|
-
* <p>The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website,
|
|
1064
|
-
*
|
|
1065
|
-
*
|
|
1066
|
-
* part of the ARN, shown here in bold: </p>
|
|
4789
|
+
* <p>The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, on the navigation
|
|
4790
|
+
* menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the
|
|
4791
|
+
* flow page, under the name of the flow, choose <b>Show additional flow information</b>. The
|
|
4792
|
+
* ContactFlowId is the last part of the ARN, shown here in bold: </p>
|
|
1067
4793
|
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
1068
4794
|
* </p>
|
|
1069
4795
|
* @public
|
|
1070
4796
|
*/
|
|
1071
4797
|
ContactFlowId?: string | undefined;
|
|
1072
4798
|
/**
|
|
1073
|
-
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and
|
|
1074
|
-
*
|
|
1075
|
-
*
|
|
4799
|
+
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and
|
|
4800
|
+
* can be accessed in flows just like any other contact attributes.</p>
|
|
4801
|
+
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only
|
|
4802
|
+
* alphanumeric, dash, and underscore characters.</p>
|
|
1076
4803
|
* @public
|
|
1077
4804
|
*/
|
|
1078
4805
|
Attributes?: Record<string, string> | undefined;
|
|
@@ -1082,16 +4809,15 @@ export interface StartTaskContactRequest {
|
|
|
1082
4809
|
*/
|
|
1083
4810
|
Name: string | undefined;
|
|
1084
4811
|
/**
|
|
1085
|
-
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
|
|
1086
|
-
*
|
|
1087
|
-
* <code>
|
|
1088
|
-
*
|
|
4812
|
+
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following
|
|
4813
|
+
* reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> |
|
|
4814
|
+
* <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a supported reference type during task
|
|
4815
|
+
* creation.</p>
|
|
1089
4816
|
* @public
|
|
1090
4817
|
*/
|
|
1091
4818
|
References?: Record<string, Reference> | undefined;
|
|
1092
4819
|
/**
|
|
1093
|
-
* <p>A description of the task that is shown to an agent in the Contact Control Panel
|
|
1094
|
-
* (CCP).</p>
|
|
4820
|
+
* <p>A description of the task that is shown to an agent in the Contact Control Panel (CCP).</p>
|
|
1095
4821
|
* @public
|
|
1096
4822
|
*/
|
|
1097
4823
|
Description?: string | undefined;
|
|
@@ -1109,43 +4835,37 @@ export interface StartTaskContactRequest {
|
|
|
1109
4835
|
*/
|
|
1110
4836
|
ScheduledTime?: Date | undefined;
|
|
1111
4837
|
/**
|
|
1112
|
-
* <p>A unique identifier for the task template. For more information about task templates, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html">Create task templates</a> in the
|
|
1113
|
-
* <i>Amazon Connect Administrator Guide</i>. </p>
|
|
4838
|
+
* <p>A unique identifier for the task template. For more information about task templates, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html">Create task templates</a> in the <i>Amazon Connect Administrator Guide</i>. </p>
|
|
1114
4839
|
* @public
|
|
1115
4840
|
*/
|
|
1116
4841
|
TaskTemplateId?: string | undefined;
|
|
1117
4842
|
/**
|
|
1118
|
-
* <p>The identifier for the quick connect. Tasks that are created by using <code>QuickConnectId</code> will use the
|
|
1119
|
-
*
|
|
1120
|
-
* see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html">Create quick
|
|
1121
|
-
* connects</a>.</p>
|
|
4843
|
+
* <p>The identifier for the quick connect. Tasks that are created by using <code>QuickConnectId</code> will use the flow that is defined
|
|
4844
|
+
* on agent or queue quick connect. For more information about quick connects, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html">Create quick connects</a>.</p>
|
|
1122
4845
|
* @public
|
|
1123
4846
|
*/
|
|
1124
4847
|
QuickConnectId?: string | undefined;
|
|
1125
4848
|
/**
|
|
1126
|
-
* <p>The contactId that is <a href="https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks">related</a> to this contact. Linking
|
|
1127
|
-
*
|
|
1128
|
-
*
|
|
1129
|
-
*
|
|
1130
|
-
*
|
|
1131
|
-
* be linked by using <code>RelatedContactId</code>. </p>
|
|
4849
|
+
* <p>The contactId that is <a href="https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks">related</a> to this contact. Linking tasks together by using <code>RelatedContactID</code> copies over contact
|
|
4850
|
+
* attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new
|
|
4851
|
+
* task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using
|
|
4852
|
+
* <code>PreviousContactID</code>. There are no limits to the number of contacts that can be linked by using
|
|
4853
|
+
* <code>RelatedContactId</code>. </p>
|
|
1132
4854
|
* @public
|
|
1133
4855
|
*/
|
|
1134
4856
|
RelatedContactId?: string | undefined;
|
|
1135
4857
|
/**
|
|
1136
|
-
* <p>A set of system defined key-value pairs stored on individual contact segments (unique
|
|
1137
|
-
*
|
|
1138
|
-
* They can be accessed in flows.</p>
|
|
4858
|
+
* <p>A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an
|
|
4859
|
+
* attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</p>
|
|
1139
4860
|
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
1140
|
-
* <p>This field can be used to set Contact Expiry as a duration in minutes and set a UserId for
|
|
1141
|
-
*
|
|
4861
|
+
* <p>This field can be used to set Contact Expiry as a duration in minutes and set a UserId for the User who created
|
|
4862
|
+
* a task.</p>
|
|
1142
4863
|
* <note>
|
|
1143
|
-
* <p>To set contact expiry, a ValueMap must be specified containing the integer number of
|
|
1144
|
-
*
|
|
1145
|
-
*
|
|
1146
|
-
*
|
|
1147
|
-
*
|
|
1148
|
-
* <code>SegmentAttributes</code> like \{ <code>"connect:CreatedByUser" \{ "ValueString":
|
|
4864
|
+
* <p>To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will
|
|
4865
|
+
* be active for before expiring, with <code>SegmentAttributes</code> like \{ <code> "connect:ContactExpiry":
|
|
4866
|
+
* \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger": 135\}\}\}\}</code>. </p>
|
|
4867
|
+
* <p>To set the created by user, a valid AgentResourceId must be supplied, with <code>SegmentAttributes</code> like
|
|
4868
|
+
* \{ <code>"connect:CreatedByUser" \{ "ValueString":
|
|
1149
4869
|
* "arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"\}\}\}</code>.
|
|
1150
4870
|
* </p>
|
|
1151
4871
|
* </note>
|
|
@@ -1163,8 +4883,8 @@ export interface UpdateContactRequest {
|
|
|
1163
4883
|
*/
|
|
1164
4884
|
InstanceId: string | undefined;
|
|
1165
4885
|
/**
|
|
1166
|
-
* <p>The identifier of the contact. This is the identifier of the contact associated with the
|
|
1167
|
-
*
|
|
4886
|
+
* <p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with
|
|
4887
|
+
* your contact center.</p>
|
|
1168
4888
|
* @public
|
|
1169
4889
|
*/
|
|
1170
4890
|
ContactId: string | undefined;
|
|
@@ -1184,54 +4904,50 @@ export interface UpdateContactRequest {
|
|
|
1184
4904
|
*/
|
|
1185
4905
|
References?: Record<string, Reference> | undefined;
|
|
1186
4906
|
/**
|
|
1187
|
-
* <p>A set of system defined key-value pairs stored on individual contact segments (unique
|
|
1188
|
-
*
|
|
1189
|
-
* They can be accessed in flows.</p>
|
|
4907
|
+
* <p>A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an
|
|
4908
|
+
* attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</p>
|
|
1190
4909
|
* <p>Attribute keys can include only alphanumeric, -, and _.</p>
|
|
1191
4910
|
* <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
|
|
1192
|
-
* <p>Contact Expiry, and user-defined attributes (String - String) that are defined in predefined
|
|
1193
|
-
*
|
|
4911
|
+
* <p>Contact Expiry, and user-defined attributes (String - String) that are defined in predefined attributes, can be
|
|
4912
|
+
* updated by using the UpdateContact API.</p>
|
|
1194
4913
|
* @public
|
|
1195
4914
|
*/
|
|
1196
4915
|
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
1197
4916
|
/**
|
|
1198
|
-
* <p> Information about the queue associated with a contact. This parameter can only be updated
|
|
1199
|
-
*
|
|
1200
|
-
* analytics. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect Contact Lens integration</a> in
|
|
4917
|
+
* <p> Information about the queue associated with a contact. This parameter can only be updated for external audio
|
|
4918
|
+
* contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect Contact Lens integration</a> in
|
|
1201
4919
|
* the <i>
|
|
1202
4920
|
* Amazon Connect Administrator Guide</i>.</p>
|
|
1203
4921
|
* @public
|
|
1204
4922
|
*/
|
|
1205
4923
|
QueueInfo?: QueueInfoInput | undefined;
|
|
1206
4924
|
/**
|
|
1207
|
-
* <p>Information about the agent associated with a contact. This parameter can only be updated
|
|
1208
|
-
*
|
|
1209
|
-
* analytics. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect Contact Lens integration</a> in
|
|
4925
|
+
* <p>Information about the agent associated with a contact. This parameter can only be updated for external audio
|
|
4926
|
+
* contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect Contact Lens integration</a> in
|
|
1210
4927
|
* the <i>
|
|
1211
4928
|
* Amazon Connect Administrator Guide</i>.</p>
|
|
1212
4929
|
* @public
|
|
1213
4930
|
*/
|
|
1214
4931
|
UserInfo?: UserInfo | undefined;
|
|
1215
4932
|
/**
|
|
1216
|
-
* <p>The endpoint of the customer for which the contact was initiated. For external audio
|
|
1217
|
-
*
|
|
1218
|
-
*
|
|
1219
|
-
* integration</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
4933
|
+
* <p>The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually
|
|
4934
|
+
* the end customer's phone number. This value can only be updated for external audio contacts. For more information,
|
|
4935
|
+
* see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect
|
|
4936
|
+
* Contact Lens integration</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
1220
4937
|
* @public
|
|
1221
4938
|
*/
|
|
1222
4939
|
CustomerEndpoint?: Endpoint | undefined;
|
|
1223
4940
|
/**
|
|
1224
|
-
* <p>External system endpoint for the contact was initiated. For external audio contacts, this is
|
|
1225
|
-
* the
|
|
1226
|
-
*
|
|
1227
|
-
*
|
|
4941
|
+
* <p>External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of
|
|
4942
|
+
* the external system such as the contact center. This value can only be updated for external audio contacts. For more
|
|
4943
|
+
* information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect Contact Lens integration</a> in the <i>Amazon Connect Administrator
|
|
4944
|
+
* Guide</i>.</p>
|
|
1228
4945
|
* @public
|
|
1229
4946
|
*/
|
|
1230
4947
|
SystemEndpoint?: Endpoint | undefined;
|
|
1231
4948
|
}
|
|
1232
4949
|
/**
|
|
1233
|
-
* <p>Information about an item from an evaluation form. The item must be either a section or a
|
|
1234
|
-
* question.</p>
|
|
4950
|
+
* <p>Information about an item from an evaluation form. The item must be either a section or a question.</p>
|
|
1235
4951
|
* @public
|
|
1236
4952
|
*/
|
|
1237
4953
|
export type EvaluationFormItem = EvaluationFormItem.QuestionMember | EvaluationFormItem.SectionMember | EvaluationFormItem.$UnknownMember;
|
|
@@ -1281,18 +4997,16 @@ export declare namespace EvaluationFormItem {
|
|
|
1281
4997
|
*/
|
|
1282
4998
|
export interface RoutingCriteria {
|
|
1283
4999
|
/**
|
|
1284
|
-
* <p>List of routing steps. When Amazon Connect does not find an available agent meeting the
|
|
1285
|
-
*
|
|
1286
|
-
*
|
|
1287
|
-
* contact will be offered to any agent in the queue.</p>
|
|
5000
|
+
* <p>List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a
|
|
5001
|
+
* step for a given step duration, the routing criteria will move on to the next step sequentially until a join is
|
|
5002
|
+
* completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.</p>
|
|
1288
5003
|
* @public
|
|
1289
5004
|
*/
|
|
1290
5005
|
Steps?: Step[] | undefined;
|
|
1291
5006
|
/**
|
|
1292
|
-
* <p>The timestamp indicating when the routing criteria is set to active. A routing criteria is
|
|
1293
|
-
*
|
|
1294
|
-
*
|
|
1295
|
-
* in agent queue.</p>
|
|
5007
|
+
* <p>The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when
|
|
5008
|
+
* contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue
|
|
5009
|
+
* even though Routing criteria is never activated for contacts in agent queue.</p>
|
|
1296
5010
|
* @public
|
|
1297
5011
|
*/
|
|
1298
5012
|
ActivationTimestamp?: Date | undefined;
|
|
@@ -1308,19 +5022,16 @@ export interface RoutingCriteria {
|
|
|
1308
5022
|
*/
|
|
1309
5023
|
export interface RoutingCriteriaInput {
|
|
1310
5024
|
/**
|
|
1311
|
-
* <p>When Amazon Connect does not find an available agent meeting the requirements in a step
|
|
1312
|
-
*
|
|
1313
|
-
|
|
1314
|
-
* a
|
|
1315
|
-
join is completed with an agent. When all steps are exhausted, the contact will be offered to
|
|
1316
|
-
* any agent in the queue.</p>
|
|
5025
|
+
* <p>When Amazon Connect does not find an available agent meeting the requirements in a step for a given step
|
|
5026
|
+
* duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent.
|
|
5027
|
+
* When all steps are exhausted, the contact will be offered to any agent in the queue.</p>
|
|
1317
5028
|
* @public
|
|
1318
5029
|
*/
|
|
1319
5030
|
Steps?: RoutingCriteriaInputStep[] | undefined;
|
|
1320
5031
|
}
|
|
1321
5032
|
/**
|
|
1322
|
-
* <p>Information about a section from an evaluation form. A section can contain sections and/or
|
|
1323
|
-
*
|
|
5033
|
+
* <p>Information about a section from an evaluation form. A section can contain sections and/or questions. Evaluation
|
|
5034
|
+
* forms can only contain sections and subsections (two level nesting).</p>
|
|
1324
5035
|
* @public
|
|
1325
5036
|
*/
|
|
1326
5037
|
export interface EvaluationFormSection {
|
|
@@ -1330,8 +5041,7 @@ export interface EvaluationFormSection {
|
|
|
1330
5041
|
*/
|
|
1331
5042
|
Title: string | undefined;
|
|
1332
5043
|
/**
|
|
1333
|
-
* <p>The identifier of the section. An identifier must be unique within the evaluation
|
|
1334
|
-
* form.</p>
|
|
5044
|
+
* <p>The identifier of the section. An identifier must be unique within the evaluation form.</p>
|
|
1335
5045
|
* @public
|
|
1336
5046
|
*/
|
|
1337
5047
|
RefId: string | undefined;
|
|
@@ -1393,11 +5103,26 @@ export interface CreateEvaluationFormRequest {
|
|
|
1393
5103
|
* @public
|
|
1394
5104
|
*/
|
|
1395
5105
|
ClientToken?: string | undefined;
|
|
5106
|
+
/**
|
|
5107
|
+
* <p>A boolean flag indicating whether to create evaluation form in draft state.</p>
|
|
5108
|
+
* @public
|
|
5109
|
+
*/
|
|
5110
|
+
AsDraft?: boolean | undefined;
|
|
1396
5111
|
/**
|
|
1397
5112
|
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
1398
5113
|
* @public
|
|
1399
5114
|
*/
|
|
1400
5115
|
Tags?: Record<string, string> | undefined;
|
|
5116
|
+
/**
|
|
5117
|
+
* <p>Configuration that specifies the target for the evaluation form.</p>
|
|
5118
|
+
* @public
|
|
5119
|
+
*/
|
|
5120
|
+
TargetConfiguration?: EvaluationFormTargetConfiguration | undefined;
|
|
5121
|
+
/**
|
|
5122
|
+
* <p>Configuration for language settings of the evaluation form.</p>
|
|
5123
|
+
* @public
|
|
5124
|
+
*/
|
|
5125
|
+
LanguageConfiguration?: EvaluationFormLanguageConfiguration | undefined;
|
|
1401
5126
|
}
|
|
1402
5127
|
/**
|
|
1403
5128
|
* <p>Information about the evaluation form.</p>
|
|
@@ -1479,6 +5204,16 @@ export interface EvaluationForm {
|
|
|
1479
5204
|
* @public
|
|
1480
5205
|
*/
|
|
1481
5206
|
Tags?: Record<string, string> | undefined;
|
|
5207
|
+
/**
|
|
5208
|
+
* <p>Configuration that specifies the target for this evaluation form.</p>
|
|
5209
|
+
* @public
|
|
5210
|
+
*/
|
|
5211
|
+
TargetConfiguration?: EvaluationFormTargetConfiguration | undefined;
|
|
5212
|
+
/**
|
|
5213
|
+
* <p>Configuration for language settings of this evaluation form.</p>
|
|
5214
|
+
* @public
|
|
5215
|
+
*/
|
|
5216
|
+
LanguageConfiguration?: EvaluationFormLanguageConfiguration | undefined;
|
|
1482
5217
|
}
|
|
1483
5218
|
/**
|
|
1484
5219
|
* <p>Information about an evaluation form used in a contact evaluation.</p>
|
|
@@ -1525,6 +5260,16 @@ export interface EvaluationFormContent {
|
|
|
1525
5260
|
* @public
|
|
1526
5261
|
*/
|
|
1527
5262
|
AutoEvaluationConfiguration?: EvaluationFormAutoEvaluationConfiguration | undefined;
|
|
5263
|
+
/**
|
|
5264
|
+
* <p>Configuration that specifies the target for this evaluation form content.</p>
|
|
5265
|
+
* @public
|
|
5266
|
+
*/
|
|
5267
|
+
TargetConfiguration?: EvaluationFormTargetConfiguration | undefined;
|
|
5268
|
+
/**
|
|
5269
|
+
* <p>Configuration for language settings of this evaluation form content.</p>
|
|
5270
|
+
* @public
|
|
5271
|
+
*/
|
|
5272
|
+
LanguageConfiguration?: EvaluationFormLanguageConfiguration | undefined;
|
|
1528
5273
|
}
|
|
1529
5274
|
/**
|
|
1530
5275
|
* @public
|
|
@@ -1541,22 +5286,21 @@ export interface UpdateContactRoutingDataRequest {
|
|
|
1541
5286
|
*/
|
|
1542
5287
|
ContactId: string | undefined;
|
|
1543
5288
|
/**
|
|
1544
|
-
* <p>The number of seconds to add or subtract from the contact's routing age. Contacts are routed
|
|
1545
|
-
*
|
|
1546
|
-
*
|
|
5289
|
+
* <p>The number of seconds to add or subtract from the contact's routing age. Contacts are routed to agents on a
|
|
5290
|
+
* first-come, first-serve basis. This means that changing their amount of time in queue compared to others also changes
|
|
5291
|
+
* their position in queue.</p>
|
|
1547
5292
|
* @public
|
|
1548
5293
|
*/
|
|
1549
5294
|
QueueTimeAdjustmentSeconds?: number | undefined;
|
|
1550
5295
|
/**
|
|
1551
|
-
* <p>Priority of the contact in the queue. The default priority for new contacts is 5. You can
|
|
1552
|
-
*
|
|
1553
|
-
* higher priority, such as 1 or 2.</p>
|
|
5296
|
+
* <p>Priority of the contact in the queue. The default priority for new contacts is 5. You can raise the priority of
|
|
5297
|
+
* a contact compared to other contacts in the queue by assigning them a higher priority, such as 1 or 2.</p>
|
|
1554
5298
|
* @public
|
|
1555
5299
|
*/
|
|
1556
5300
|
QueuePriority?: number | undefined;
|
|
1557
5301
|
/**
|
|
1558
|
-
* <p>Updates the routing criteria on the contact. These properties can be used to change how a
|
|
1559
|
-
*
|
|
5302
|
+
* <p>Updates the routing criteria on the contact. These properties can be used to change how a contact is routed
|
|
5303
|
+
* within the queue.</p>
|
|
1560
5304
|
* @public
|
|
1561
5305
|
*/
|
|
1562
5306
|
RoutingCriteria?: RoutingCriteriaInput | undefined;
|
|
@@ -1610,6 +5354,11 @@ export interface UpdateEvaluationFormRequest {
|
|
|
1610
5354
|
* @public
|
|
1611
5355
|
*/
|
|
1612
5356
|
AutoEvaluationConfiguration?: EvaluationFormAutoEvaluationConfiguration | undefined;
|
|
5357
|
+
/**
|
|
5358
|
+
* <p>A boolean flag indicating whether to update evaluation form to draft state.</p>
|
|
5359
|
+
* @public
|
|
5360
|
+
*/
|
|
5361
|
+
AsDraft?: boolean | undefined;
|
|
1613
5362
|
/**
|
|
1614
5363
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1615
5364
|
* request. If not provided, the Amazon Web Services
|
|
@@ -1618,6 +5367,16 @@ export interface UpdateEvaluationFormRequest {
|
|
|
1618
5367
|
* @public
|
|
1619
5368
|
*/
|
|
1620
5369
|
ClientToken?: string | undefined;
|
|
5370
|
+
/**
|
|
5371
|
+
* <p>Configuration that specifies the target for the evaluation form.</p>
|
|
5372
|
+
* @public
|
|
5373
|
+
*/
|
|
5374
|
+
TargetConfiguration?: EvaluationFormTargetConfiguration | undefined;
|
|
5375
|
+
/**
|
|
5376
|
+
* <p>Configuration for language settings of the evaluation form.</p>
|
|
5377
|
+
* @public
|
|
5378
|
+
*/
|
|
5379
|
+
LanguageConfiguration?: EvaluationFormLanguageConfiguration | undefined;
|
|
1621
5380
|
}
|
|
1622
5381
|
/**
|
|
1623
5382
|
* @public
|
|
@@ -1670,8 +5429,8 @@ export interface Contact {
|
|
|
1670
5429
|
*/
|
|
1671
5430
|
PreviousContactId?: string | undefined;
|
|
1672
5431
|
/**
|
|
1673
|
-
* <p>This is the root contactId which is used as a unique identifier for all subsequent contacts
|
|
1674
|
-
*
|
|
5432
|
+
* <p>This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact
|
|
5433
|
+
* tree.</p>
|
|
1675
5434
|
* @public
|
|
1676
5435
|
*/
|
|
1677
5436
|
ContactAssociationId?: string | undefined;
|
|
@@ -1706,20 +5465,19 @@ export interface Contact {
|
|
|
1706
5465
|
*/
|
|
1707
5466
|
AgentInfo?: AgentInfo | undefined;
|
|
1708
5467
|
/**
|
|
1709
|
-
* <p>The date and time this contact was initiated, in UTC time. For <code>INBOUND</code>, this is
|
|
1710
|
-
*
|
|
1711
|
-
*
|
|
1712
|
-
*
|
|
1713
|
-
*
|
|
1714
|
-
* started dialing the external participant. For <code>MONITOR</code>, this is when the supervisor
|
|
5468
|
+
* <p>The date and time this contact was initiated, in UTC time. For <code>INBOUND</code>, this is when the contact
|
|
5469
|
+
* arrived. For <code>OUTBOUND</code>, this is when the agent began dialing. For <code>CALLBACK</code>, this is when the
|
|
5470
|
+
* callback contact was created. For <code>TRANSFER</code> and <code>QUEUE_TRANSFER</code>, this is when the transfer
|
|
5471
|
+
* was initiated. For <code>API</code>, this is when the request arrived. For <code>EXTERNAL_OUTBOUND</code>, this is
|
|
5472
|
+
* when the agent started dialing the external participant. For <code>MONITOR</code>, this is when the supervisor
|
|
1715
5473
|
* started listening to a contact.</p>
|
|
1716
5474
|
* @public
|
|
1717
5475
|
*/
|
|
1718
5476
|
InitiationTimestamp?: Date | undefined;
|
|
1719
5477
|
/**
|
|
1720
|
-
* <p>The date and time that the customer endpoint disconnected from the current contact, in UTC
|
|
1721
|
-
*
|
|
1722
|
-
*
|
|
5478
|
+
* <p>The date and time that the customer endpoint disconnected from the current contact, in UTC time. In transfer
|
|
5479
|
+
* scenarios, the DisconnectTimestamp of the previous contact indicates the date and time when that contact
|
|
5480
|
+
* ended.</p>
|
|
1723
5481
|
* @public
|
|
1724
5482
|
*/
|
|
1725
5483
|
DisconnectTimestamp?: Date | undefined;
|
|
@@ -1754,14 +5512,12 @@ export interface Contact {
|
|
|
1754
5512
|
*/
|
|
1755
5513
|
TotalPauseDurationInSeconds?: number | undefined;
|
|
1756
5514
|
/**
|
|
1757
|
-
* <p>The timestamp, in Unix epoch time format, at which to start running the inbound flow.
|
|
1758
|
-
* </p>
|
|
5515
|
+
* <p>The timestamp, in Unix epoch time format, at which to start running the inbound flow. </p>
|
|
1759
5516
|
* @public
|
|
1760
5517
|
*/
|
|
1761
5518
|
ScheduledTimestamp?: Date | undefined;
|
|
1762
5519
|
/**
|
|
1763
|
-
* <p>The contactId that is <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html#relatedcontactid">related</a> to this
|
|
1764
|
-
* contact.</p>
|
|
5520
|
+
* <p>The contactId that is <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html#relatedcontactid">related</a> to this contact.</p>
|
|
1765
5521
|
* @public
|
|
1766
5522
|
*/
|
|
1767
5523
|
RelatedContactId?: string | undefined;
|
|
@@ -1771,10 +5527,10 @@ export interface Contact {
|
|
|
1771
5527
|
*/
|
|
1772
5528
|
WisdomInfo?: WisdomInfo | undefined;
|
|
1773
5529
|
/**
|
|
1774
|
-
* <p>The customer's identification number. For example, the <code>CustomerId</code> may be a
|
|
1775
|
-
*
|
|
1776
|
-
*
|
|
1777
|
-
*
|
|
5530
|
+
* <p>The customer's identification number. For example, the <code>CustomerId</code> may be a customer number from
|
|
5531
|
+
* your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you
|
|
5532
|
+
* enable Amazon Connect Voice ID capability, this attribute is populated with the <code>CustomerSpeakerId</code> of
|
|
5533
|
+
* the caller.</p>
|
|
1778
5534
|
* @public
|
|
1779
5535
|
*/
|
|
1780
5536
|
CustomerId?: string | undefined;
|
|
@@ -1784,31 +5540,29 @@ export interface Contact {
|
|
|
1784
5540
|
*/
|
|
1785
5541
|
CustomerEndpoint?: EndpointInfo | undefined;
|
|
1786
5542
|
/**
|
|
1787
|
-
* <p>The system endpoint. For <code>INBOUND</code>, this is the phone number or email address
|
|
1788
|
-
*
|
|
1789
|
-
*
|
|
1790
|
-
*
|
|
5543
|
+
* <p>The system endpoint. For <code>INBOUND</code>, this is the phone number or email address that the customer
|
|
5544
|
+
* dialed. For <code>OUTBOUND</code> and <code>EXTERNAL_OUTBOUND</code>, this is the outbound caller ID number assigned
|
|
5545
|
+
* to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled
|
|
5546
|
+
* by agents with softphone.</p>
|
|
1791
5547
|
* @public
|
|
1792
5548
|
*/
|
|
1793
5549
|
SystemEndpoint?: EndpointInfo | undefined;
|
|
1794
5550
|
/**
|
|
1795
|
-
* <p>An integer that represents the queue time adjust to be applied to the contact, in seconds
|
|
1796
|
-
*
|
|
1797
|
-
*
|
|
5551
|
+
* <p>An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue
|
|
5552
|
+
* time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined
|
|
5553
|
+
* and a valid integer value.</p>
|
|
1798
5554
|
* @public
|
|
1799
5555
|
*/
|
|
1800
5556
|
QueueTimeAdjustmentSeconds?: number | undefined;
|
|
1801
5557
|
/**
|
|
1802
|
-
* <p>An integer that represents the queue priority to be applied to the contact (lower priorities
|
|
1803
|
-
*
|
|
1804
|
-
*
|
|
1805
|
-
* 5.</p>
|
|
5558
|
+
* <p>An integer that represents the queue priority to be applied to the contact (lower priorities are routed
|
|
5559
|
+
* preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must
|
|
5560
|
+
* be larger than zero, and a valid integer value. Default Value is 5.</p>
|
|
1806
5561
|
* @public
|
|
1807
5562
|
*/
|
|
1808
5563
|
QueuePriority?: number | undefined;
|
|
1809
5564
|
/**
|
|
1810
|
-
* <p>Tags associated with the contact. This contains both Amazon Web Services generated and
|
|
1811
|
-
* user-defined tags.</p>
|
|
5565
|
+
* <p>Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.</p>
|
|
1812
5566
|
* @public
|
|
1813
5567
|
*/
|
|
1814
5568
|
Tags?: Record<string, string> | undefined;
|
|
@@ -1833,8 +5587,7 @@ export interface Contact {
|
|
|
1833
5587
|
*/
|
|
1834
5588
|
Campaign?: Campaign | undefined;
|
|
1835
5589
|
/**
|
|
1836
|
-
* <p>Indicates how an <a href="https://docs.aws.amazon.com/connect/latest/adminguide/how-to-create-campaigns.html">outbound campaign</a> call is
|
|
1837
|
-
* actually disposed if the contact is connected to Amazon Connect.</p>
|
|
5590
|
+
* <p>Indicates how an <a href="https://docs.aws.amazon.com/connect/latest/adminguide/how-to-create-campaigns.html">outbound campaign</a> call is actually disposed if the contact is connected to Amazon Connect.</p>
|
|
1838
5591
|
* @public
|
|
1839
5592
|
*/
|
|
1840
5593
|
AnsweringMachineDetectionStatus?: AnsweringMachineDetectionStatus | undefined;
|
|
@@ -1864,11 +5617,10 @@ export interface Contact {
|
|
|
1864
5617
|
*/
|
|
1865
5618
|
AdditionalEmailRecipients?: AdditionalEmailRecipients | undefined;
|
|
1866
5619
|
/**
|
|
1867
|
-
* <p>A set of system defined key-value pairs stored on individual contact segments using an
|
|
1868
|
-
*
|
|
1869
|
-
*
|
|
1870
|
-
*
|
|
1871
|
-
* <code>connect:SMS</code>.</p>
|
|
5620
|
+
* <p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The
|
|
5621
|
+
* attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only
|
|
5622
|
+
* alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example,
|
|
5623
|
+
* <code>connect:Guide</code> or <code>connect:SMS</code>.</p>
|
|
1872
5624
|
* @public
|
|
1873
5625
|
*/
|
|
1874
5626
|
SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
|
|
@@ -1878,14 +5630,15 @@ export interface Contact {
|
|
|
1878
5630
|
*/
|
|
1879
5631
|
Recordings?: RecordingInfo[] | undefined;
|
|
1880
5632
|
/**
|
|
1881
|
-
* <p>The disconnect reason for the contact. For a list and description of all the possible
|
|
1882
|
-
*
|
|
5633
|
+
* <p>The disconnect reason for the contact. For a list and description of all the possible disconnect reasons by
|
|
5634
|
+
* channel, see DisconnectReason under <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the
|
|
5635
|
+
* <i>Amazon Connect Administrator Guide</i>. </p>
|
|
1883
5636
|
* @public
|
|
1884
5637
|
*/
|
|
1885
5638
|
DisconnectReason?: string | undefined;
|
|
1886
5639
|
/**
|
|
1887
|
-
* <p>Information about the contact evaluations where the key is the FormId, which is a unique
|
|
1888
|
-
*
|
|
5640
|
+
* <p>Information about the contact evaluations where the key is the FormId, which is a unique identifier for the
|
|
5641
|
+
* form.</p>
|
|
1889
5642
|
* @public
|
|
1890
5643
|
*/
|
|
1891
5644
|
ContactEvaluations?: Record<string, ContactEvaluation> | undefined;
|
|
@@ -1895,8 +5648,8 @@ export interface Contact {
|
|
|
1895
5648
|
*/
|
|
1896
5649
|
TaskTemplateInfo?: TaskTemplateInfoV2 | undefined;
|
|
1897
5650
|
/**
|
|
1898
|
-
* <p>A map of string key/value pairs that contain user-defined attributes which are lightly typed
|
|
1899
|
-
*
|
|
5651
|
+
* <p>A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact.
|
|
5652
|
+
* This object is used only for task contacts.</p>
|
|
1900
5653
|
* @public
|
|
1901
5654
|
*/
|
|
1902
5655
|
ContactDetails?: ContactDetails | undefined;
|
|
@@ -1910,6 +5663,11 @@ export interface Contact {
|
|
|
1910
5663
|
* @public
|
|
1911
5664
|
*/
|
|
1912
5665
|
Attributes?: Record<string, string> | undefined;
|
|
5666
|
+
/**
|
|
5667
|
+
* <p> List of next contact entries for the contact. </p>
|
|
5668
|
+
* @public
|
|
5669
|
+
*/
|
|
5670
|
+
NextContacts?: NextContactEntry[] | undefined;
|
|
1913
5671
|
}
|
|
1914
5672
|
/**
|
|
1915
5673
|
* <p>Information of returned contact.</p>
|
|
@@ -1957,13 +5715,12 @@ export interface ContactSearchSummary {
|
|
|
1957
5715
|
*/
|
|
1958
5716
|
AgentInfo?: ContactSearchSummaryAgentInfo | undefined;
|
|
1959
5717
|
/**
|
|
1960
|
-
* <p>The date and time this contact was initiated, in UTC time. For <code>INBOUND</code>, this is
|
|
1961
|
-
*
|
|
1962
|
-
*
|
|
1963
|
-
*
|
|
1964
|
-
* the
|
|
1965
|
-
*
|
|
1966
|
-
* to a contact.</p>
|
|
5718
|
+
* <p>The date and time this contact was initiated, in UTC time. For <code>INBOUND</code>, this is when the contact
|
|
5719
|
+
* arrived. For <code>OUTBOUND</code>, this is when the agent began dialing. For <code>CALLBACK</code>, this is when the
|
|
5720
|
+
* callback contact was created. For <code>TRANSFER</code> and <code>QUEUE_TRANSFER</code>, this is when the transfer
|
|
5721
|
+
* was initiated. For API, this is when the request arrived. For <code>EXTERNAL_OUTBOUND</code>, this is when the agent
|
|
5722
|
+
* started dialing the external participant. For <code>MONITOR</code>, this is when the supervisor started listening to
|
|
5723
|
+
* a contact.</p>
|
|
1967
5724
|
* @public
|
|
1968
5725
|
*/
|
|
1969
5726
|
InitiationTimestamp?: Date | undefined;
|