@aws-sdk/client-connect 3.533.0 → 3.538.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/dist-cjs/index.js +8 -0
- package/dist-es/models/models_0.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +6 -0
- package/dist-types/Connect.d.ts +4 -1
- package/dist-types/ConnectClient.d.ts +1 -1
- package/dist-types/commands/ActivateEvaluationFormCommand.d.ts +2 -1
- package/dist-types/commands/AssociateAnalyticsDataSetCommand.d.ts +2 -1
- package/dist-types/commands/AssociateApprovedOriginCommand.d.ts +2 -1
- package/dist-types/commands/AssociateBotCommand.d.ts +2 -1
- package/dist-types/commands/AssociateDefaultVocabularyCommand.d.ts +2 -1
- package/dist-types/commands/AssociateFlowCommand.d.ts +2 -1
- package/dist-types/commands/AssociateInstanceStorageConfigCommand.d.ts +3 -2
- package/dist-types/commands/AssociateLambdaFunctionCommand.d.ts +2 -1
- package/dist-types/commands/AssociateLexBotCommand.d.ts +2 -1
- package/dist-types/commands/AssociatePhoneNumberContactFlowCommand.d.ts +2 -1
- package/dist-types/commands/AssociateQueueQuickConnectsCommand.d.ts +2 -1
- package/dist-types/commands/AssociateRoutingProfileQueuesCommand.d.ts +2 -1
- package/dist-types/commands/AssociateSecurityKeyCommand.d.ts +2 -1
- package/dist-types/commands/AssociateTrafficDistributionGroupUserCommand.d.ts +2 -1
- package/dist-types/commands/AssociateUserProficienciesCommand.d.ts +2 -1
- package/dist-types/commands/BatchAssociateAnalyticsDataSetCommand.d.ts +2 -1
- package/dist-types/commands/BatchDisassociateAnalyticsDataSetCommand.d.ts +2 -1
- package/dist-types/commands/BatchGetFlowAssociationCommand.d.ts +2 -1
- package/dist-types/commands/BatchPutContactCommand.d.ts +2 -1
- package/dist-types/commands/ClaimPhoneNumberCommand.d.ts +2 -1
- package/dist-types/commands/CreateAgentStatusCommand.d.ts +2 -1
- package/dist-types/commands/CreateContactFlowCommand.d.ts +2 -1
- package/dist-types/commands/CreateContactFlowModuleCommand.d.ts +2 -1
- package/dist-types/commands/CreateEvaluationFormCommand.d.ts +2 -1
- package/dist-types/commands/CreateHoursOfOperationCommand.d.ts +2 -1
- package/dist-types/commands/CreateInstanceCommand.d.ts +2 -1
- package/dist-types/commands/CreateIntegrationAssociationCommand.d.ts +2 -1
- package/dist-types/commands/CreateParticipantCommand.d.ts +2 -1
- package/dist-types/commands/CreatePersistentContactAssociationCommand.d.ts +2 -1
- package/dist-types/commands/CreatePredefinedAttributeCommand.d.ts +2 -1
- package/dist-types/commands/CreatePromptCommand.d.ts +2 -1
- package/dist-types/commands/CreateQueueCommand.d.ts +2 -1
- package/dist-types/commands/CreateQuickConnectCommand.d.ts +2 -1
- package/dist-types/commands/CreateRoutingProfileCommand.d.ts +2 -1
- package/dist-types/commands/CreateRuleCommand.d.ts +2 -1
- package/dist-types/commands/CreateSecurityProfileCommand.d.ts +6 -1
- package/dist-types/commands/CreateTaskTemplateCommand.d.ts +2 -1
- package/dist-types/commands/CreateTrafficDistributionGroupCommand.d.ts +2 -1
- package/dist-types/commands/CreateUseCaseCommand.d.ts +2 -1
- package/dist-types/commands/CreateUserCommand.d.ts +2 -1
- package/dist-types/commands/CreateUserHierarchyGroupCommand.d.ts +2 -1
- package/dist-types/commands/CreateViewCommand.d.ts +2 -1
- package/dist-types/commands/CreateViewVersionCommand.d.ts +2 -1
- package/dist-types/commands/CreateVocabularyCommand.d.ts +2 -1
- package/dist-types/commands/DeactivateEvaluationFormCommand.d.ts +2 -1
- package/dist-types/commands/DeleteContactEvaluationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteContactFlowCommand.d.ts +2 -1
- package/dist-types/commands/DeleteContactFlowModuleCommand.d.ts +2 -1
- package/dist-types/commands/DeleteEvaluationFormCommand.d.ts +2 -1
- package/dist-types/commands/DeleteHoursOfOperationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteInstanceCommand.d.ts +2 -1
- package/dist-types/commands/DeleteIntegrationAssociationCommand.d.ts +2 -1
- package/dist-types/commands/DeletePredefinedAttributeCommand.d.ts +2 -1
- package/dist-types/commands/DeletePromptCommand.d.ts +2 -1
- package/dist-types/commands/DeleteQueueCommand.d.ts +2 -1
- package/dist-types/commands/DeleteQuickConnectCommand.d.ts +2 -1
- package/dist-types/commands/DeleteRoutingProfileCommand.d.ts +2 -1
- package/dist-types/commands/DeleteRuleCommand.d.ts +2 -1
- package/dist-types/commands/DeleteSecurityProfileCommand.d.ts +2 -1
- package/dist-types/commands/DeleteTaskTemplateCommand.d.ts +2 -1
- package/dist-types/commands/DeleteTrafficDistributionGroupCommand.d.ts +2 -1
- package/dist-types/commands/DeleteUseCaseCommand.d.ts +2 -1
- package/dist-types/commands/DeleteUserCommand.d.ts +2 -1
- package/dist-types/commands/DeleteUserHierarchyGroupCommand.d.ts +2 -1
- package/dist-types/commands/DeleteViewCommand.d.ts +2 -1
- package/dist-types/commands/DeleteViewVersionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteVocabularyCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAgentStatusCommand.d.ts +2 -1
- package/dist-types/commands/DescribeContactCommand.d.ts +2 -1
- package/dist-types/commands/DescribeContactEvaluationCommand.d.ts +2 -1
- package/dist-types/commands/DescribeContactFlowCommand.d.ts +2 -1
- package/dist-types/commands/DescribeContactFlowModuleCommand.d.ts +2 -1
- package/dist-types/commands/DescribeEvaluationFormCommand.d.ts +2 -1
- package/dist-types/commands/DescribeHoursOfOperationCommand.d.ts +2 -1
- package/dist-types/commands/DescribeInstanceAttributeCommand.d.ts +2 -1
- package/dist-types/commands/DescribeInstanceCommand.d.ts +2 -1
- package/dist-types/commands/DescribeInstanceStorageConfigCommand.d.ts +3 -2
- package/dist-types/commands/DescribePhoneNumberCommand.d.ts +2 -1
- package/dist-types/commands/DescribePredefinedAttributeCommand.d.ts +2 -1
- package/dist-types/commands/DescribePromptCommand.d.ts +2 -1
- package/dist-types/commands/DescribeQueueCommand.d.ts +2 -1
- package/dist-types/commands/DescribeQuickConnectCommand.d.ts +2 -1
- package/dist-types/commands/DescribeRoutingProfileCommand.d.ts +2 -1
- package/dist-types/commands/DescribeRuleCommand.d.ts +2 -1
- package/dist-types/commands/DescribeSecurityProfileCommand.d.ts +6 -1
- package/dist-types/commands/DescribeTrafficDistributionGroupCommand.d.ts +2 -1
- package/dist-types/commands/DescribeUserCommand.d.ts +2 -1
- package/dist-types/commands/DescribeUserHierarchyGroupCommand.d.ts +2 -1
- package/dist-types/commands/DescribeUserHierarchyStructureCommand.d.ts +2 -1
- package/dist-types/commands/DescribeViewCommand.d.ts +2 -1
- package/dist-types/commands/DescribeVocabularyCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateAnalyticsDataSetCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateApprovedOriginCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateBotCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateFlowCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateInstanceStorageConfigCommand.d.ts +3 -2
- package/dist-types/commands/DisassociateLambdaFunctionCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateLexBotCommand.d.ts +2 -1
- package/dist-types/commands/DisassociatePhoneNumberContactFlowCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateQueueQuickConnectsCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateRoutingProfileQueuesCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateSecurityKeyCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateTrafficDistributionGroupUserCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateUserProficienciesCommand.d.ts +2 -1
- package/dist-types/commands/DismissUserContactCommand.d.ts +2 -1
- package/dist-types/commands/GetContactAttributesCommand.d.ts +2 -1
- package/dist-types/commands/GetCurrentMetricDataCommand.d.ts +2 -1
- package/dist-types/commands/GetCurrentUserDataCommand.d.ts +2 -1
- package/dist-types/commands/GetFederationTokenCommand.d.ts +2 -1
- package/dist-types/commands/GetFlowAssociationCommand.d.ts +2 -1
- package/dist-types/commands/GetMetricDataCommand.d.ts +2 -1
- package/dist-types/commands/GetMetricDataV2Command.d.ts +2 -1
- package/dist-types/commands/GetPromptFileCommand.d.ts +2 -1
- package/dist-types/commands/GetTaskTemplateCommand.d.ts +2 -1
- package/dist-types/commands/GetTrafficDistributionCommand.d.ts +2 -1
- package/dist-types/commands/ImportPhoneNumberCommand.d.ts +2 -1
- package/dist-types/commands/ListAgentStatusesCommand.d.ts +2 -1
- package/dist-types/commands/ListAnalyticsDataAssociationsCommand.d.ts +2 -1
- package/dist-types/commands/ListApprovedOriginsCommand.d.ts +2 -1
- package/dist-types/commands/ListBotsCommand.d.ts +2 -1
- package/dist-types/commands/ListContactEvaluationsCommand.d.ts +2 -1
- package/dist-types/commands/ListContactFlowModulesCommand.d.ts +2 -1
- package/dist-types/commands/ListContactFlowsCommand.d.ts +2 -1
- package/dist-types/commands/ListContactReferencesCommand.d.ts +2 -1
- package/dist-types/commands/ListDefaultVocabulariesCommand.d.ts +2 -1
- package/dist-types/commands/ListEvaluationFormVersionsCommand.d.ts +2 -1
- package/dist-types/commands/ListEvaluationFormsCommand.d.ts +2 -1
- package/dist-types/commands/ListFlowAssociationsCommand.d.ts +2 -1
- package/dist-types/commands/ListHoursOfOperationsCommand.d.ts +2 -1
- package/dist-types/commands/ListInstanceAttributesCommand.d.ts +2 -1
- package/dist-types/commands/ListInstanceStorageConfigsCommand.d.ts +3 -2
- package/dist-types/commands/ListInstancesCommand.d.ts +2 -1
- package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +2 -1
- package/dist-types/commands/ListLambdaFunctionsCommand.d.ts +2 -1
- package/dist-types/commands/ListLexBotsCommand.d.ts +2 -1
- package/dist-types/commands/ListPhoneNumbersCommand.d.ts +2 -1
- package/dist-types/commands/ListPhoneNumbersV2Command.d.ts +2 -1
- package/dist-types/commands/ListPredefinedAttributesCommand.d.ts +2 -1
- package/dist-types/commands/ListPromptsCommand.d.ts +2 -1
- package/dist-types/commands/ListQueueQuickConnectsCommand.d.ts +2 -1
- package/dist-types/commands/ListQueuesCommand.d.ts +2 -1
- package/dist-types/commands/ListQuickConnectsCommand.d.ts +2 -1
- package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +2 -1
- package/dist-types/commands/ListRoutingProfileQueuesCommand.d.ts +2 -1
- package/dist-types/commands/ListRoutingProfilesCommand.d.ts +2 -1
- package/dist-types/commands/ListRulesCommand.d.ts +2 -1
- package/dist-types/commands/ListSecurityKeysCommand.d.ts +2 -1
- package/dist-types/commands/ListSecurityProfileApplicationsCommand.d.ts +2 -1
- package/dist-types/commands/ListSecurityProfilePermissionsCommand.d.ts +2 -1
- package/dist-types/commands/ListSecurityProfilesCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListTaskTemplatesCommand.d.ts +2 -1
- package/dist-types/commands/ListTrafficDistributionGroupUsersCommand.d.ts +2 -1
- package/dist-types/commands/ListTrafficDistributionGroupsCommand.d.ts +2 -1
- package/dist-types/commands/ListUseCasesCommand.d.ts +2 -1
- package/dist-types/commands/ListUserHierarchyGroupsCommand.d.ts +2 -1
- package/dist-types/commands/ListUserProficienciesCommand.d.ts +2 -1
- package/dist-types/commands/ListUsersCommand.d.ts +2 -1
- package/dist-types/commands/ListViewVersionsCommand.d.ts +2 -1
- package/dist-types/commands/ListViewsCommand.d.ts +2 -1
- package/dist-types/commands/MonitorContactCommand.d.ts +2 -1
- package/dist-types/commands/PauseContactCommand.d.ts +2 -1
- package/dist-types/commands/PutUserStatusCommand.d.ts +2 -1
- package/dist-types/commands/ReleasePhoneNumberCommand.d.ts +2 -1
- package/dist-types/commands/ReplicateInstanceCommand.d.ts +2 -1
- package/dist-types/commands/ResumeContactCommand.d.ts +2 -1
- package/dist-types/commands/ResumeContactRecordingCommand.d.ts +2 -1
- package/dist-types/commands/SearchAvailablePhoneNumbersCommand.d.ts +2 -1
- package/dist-types/commands/SearchContactsCommand.d.ts +2 -1
- package/dist-types/commands/SearchHoursOfOperationsCommand.d.ts +2 -1
- package/dist-types/commands/SearchPredefinedAttributesCommand.d.ts +2 -1
- package/dist-types/commands/SearchPromptsCommand.d.ts +2 -1
- package/dist-types/commands/SearchQueuesCommand.d.ts +2 -1
- package/dist-types/commands/SearchQuickConnectsCommand.d.ts +2 -1
- package/dist-types/commands/SearchResourceTagsCommand.d.ts +2 -1
- package/dist-types/commands/SearchRoutingProfilesCommand.d.ts +2 -1
- package/dist-types/commands/SearchSecurityProfilesCommand.d.ts +2 -1
- package/dist-types/commands/SearchUsersCommand.d.ts +24 -9
- package/dist-types/commands/SearchVocabulariesCommand.d.ts +2 -1
- package/dist-types/commands/SendChatIntegrationEventCommand.d.ts +2 -1
- package/dist-types/commands/StartChatContactCommand.d.ts +2 -1
- package/dist-types/commands/StartContactEvaluationCommand.d.ts +2 -1
- package/dist-types/commands/StartContactRecordingCommand.d.ts +2 -1
- package/dist-types/commands/StartContactStreamingCommand.d.ts +2 -1
- package/dist-types/commands/StartOutboundVoiceContactCommand.d.ts +2 -1
- package/dist-types/commands/StartTaskContactCommand.d.ts +2 -1
- package/dist-types/commands/StartWebRTCContactCommand.d.ts +2 -1
- package/dist-types/commands/StopContactCommand.d.ts +2 -1
- package/dist-types/commands/StopContactRecordingCommand.d.ts +2 -1
- package/dist-types/commands/StopContactStreamingCommand.d.ts +2 -1
- package/dist-types/commands/SubmitContactEvaluationCommand.d.ts +2 -1
- package/dist-types/commands/SuspendContactRecordingCommand.d.ts +2 -1
- package/dist-types/commands/TagContactCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/TransferContactCommand.d.ts +2 -1
- package/dist-types/commands/UntagContactCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAgentStatusCommand.d.ts +2 -1
- package/dist-types/commands/UpdateContactAttributesCommand.d.ts +2 -1
- package/dist-types/commands/UpdateContactCommand.d.ts +2 -1
- package/dist-types/commands/UpdateContactEvaluationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateContactFlowContentCommand.d.ts +2 -1
- package/dist-types/commands/UpdateContactFlowMetadataCommand.d.ts +2 -1
- package/dist-types/commands/UpdateContactFlowModuleContentCommand.d.ts +2 -1
- package/dist-types/commands/UpdateContactFlowModuleMetadataCommand.d.ts +2 -1
- package/dist-types/commands/UpdateContactFlowNameCommand.d.ts +2 -1
- package/dist-types/commands/UpdateContactRoutingDataCommand.d.ts +2 -1
- package/dist-types/commands/UpdateContactScheduleCommand.d.ts +2 -1
- package/dist-types/commands/UpdateEvaluationFormCommand.d.ts +2 -1
- package/dist-types/commands/UpdateHoursOfOperationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateInstanceAttributeCommand.d.ts +2 -1
- package/dist-types/commands/UpdateInstanceStorageConfigCommand.d.ts +3 -2
- package/dist-types/commands/UpdateParticipantRoleConfigCommand.d.ts +2 -1
- package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +2 -1
- package/dist-types/commands/UpdatePhoneNumberMetadataCommand.d.ts +2 -1
- package/dist-types/commands/UpdatePredefinedAttributeCommand.d.ts +2 -1
- package/dist-types/commands/UpdatePromptCommand.d.ts +2 -1
- package/dist-types/commands/UpdateQueueHoursOfOperationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateQueueMaxContactsCommand.d.ts +2 -1
- package/dist-types/commands/UpdateQueueNameCommand.d.ts +2 -1
- package/dist-types/commands/UpdateQueueOutboundCallerConfigCommand.d.ts +2 -1
- package/dist-types/commands/UpdateQueueStatusCommand.d.ts +2 -1
- package/dist-types/commands/UpdateQuickConnectConfigCommand.d.ts +2 -1
- package/dist-types/commands/UpdateQuickConnectNameCommand.d.ts +2 -1
- package/dist-types/commands/UpdateRoutingProfileAgentAvailabilityTimerCommand.d.ts +2 -1
- package/dist-types/commands/UpdateRoutingProfileConcurrencyCommand.d.ts +2 -1
- package/dist-types/commands/UpdateRoutingProfileDefaultOutboundQueueCommand.d.ts +2 -1
- package/dist-types/commands/UpdateRoutingProfileNameCommand.d.ts +2 -1
- package/dist-types/commands/UpdateRoutingProfileQueuesCommand.d.ts +2 -1
- package/dist-types/commands/UpdateRuleCommand.d.ts +2 -1
- package/dist-types/commands/UpdateSecurityProfileCommand.d.ts +6 -1
- package/dist-types/commands/UpdateTaskTemplateCommand.d.ts +2 -1
- package/dist-types/commands/UpdateTrafficDistributionCommand.d.ts +2 -1
- package/dist-types/commands/UpdateUserHierarchyCommand.d.ts +2 -1
- package/dist-types/commands/UpdateUserHierarchyGroupNameCommand.d.ts +2 -1
- package/dist-types/commands/UpdateUserHierarchyStructureCommand.d.ts +2 -1
- package/dist-types/commands/UpdateUserIdentityInfoCommand.d.ts +2 -1
- package/dist-types/commands/UpdateUserPhoneConfigCommand.d.ts +2 -1
- package/dist-types/commands/UpdateUserProficienciesCommand.d.ts +2 -1
- package/dist-types/commands/UpdateUserRoutingProfileCommand.d.ts +2 -1
- package/dist-types/commands/UpdateUserSecurityProfilesCommand.d.ts +2 -1
- package/dist-types/commands/UpdateViewContentCommand.d.ts +2 -1
- package/dist-types/commands/UpdateViewMetadataCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +824 -794
- package/dist-types/models/models_1.d.ts +1136 -1119
- package/dist-types/models/models_2.d.ts +740 -645
- package/dist-types/ts3.4/Connect.d.ts +3 -0
- package/dist-types/ts3.4/commands/ActivateEvaluationFormCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociateAnalyticsDataSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociateApprovedOriginCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociateBotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociateDefaultVocabularyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociateFlowCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociateInstanceStorageConfigCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociateLambdaFunctionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociateLexBotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociatePhoneNumberContactFlowCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociateQueueQuickConnectsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociateRoutingProfileQueuesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociateSecurityKeyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociateTrafficDistributionGroupUserCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociateUserProficienciesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchAssociateAnalyticsDataSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchDisassociateAnalyticsDataSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchGetFlowAssociationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchPutContactCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ClaimPhoneNumberCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateAgentStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateContactFlowCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateContactFlowModuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateEvaluationFormCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateHoursOfOperationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateInstanceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateIntegrationAssociationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateParticipantCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreatePersistentContactAssociationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreatePredefinedAttributeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreatePromptCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateQueueCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateQuickConnectCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateRoutingProfileCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateRuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateSecurityProfileCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateTaskTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateTrafficDistributionGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateUseCaseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateUserCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateUserHierarchyGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateViewCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateViewVersionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateVocabularyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeactivateEvaluationFormCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteContactEvaluationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteContactFlowCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteContactFlowModuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteEvaluationFormCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteHoursOfOperationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteInstanceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteIntegrationAssociationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeletePredefinedAttributeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeletePromptCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteQueueCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteQuickConnectCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteRoutingProfileCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteRuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteSecurityProfileCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteTaskTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteTrafficDistributionGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteUseCaseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteUserCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteUserHierarchyGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteViewCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteViewVersionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeAgentStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeContactCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeContactEvaluationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeContactFlowCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeContactFlowModuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeEvaluationFormCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeHoursOfOperationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeInstanceAttributeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeInstanceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeInstanceStorageConfigCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribePhoneNumberCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribePredefinedAttributeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribePromptCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeQueueCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeQuickConnectCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeRoutingProfileCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeRuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeSecurityProfileCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeTrafficDistributionGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeUserCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeUserHierarchyGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeUserHierarchyStructureCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeViewCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeVocabularyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateAnalyticsDataSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateApprovedOriginCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateBotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateFlowCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateInstanceStorageConfigCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateLambdaFunctionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateLexBotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociatePhoneNumberContactFlowCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateQueueQuickConnectsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateRoutingProfileQueuesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateSecurityKeyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateTrafficDistributionGroupUserCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateUserProficienciesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DismissUserContactCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetContactAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCurrentMetricDataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCurrentUserDataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetFederationTokenCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetFlowAssociationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetMetricDataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetMetricDataV2Command.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetPromptFileCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetTaskTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetTrafficDistributionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ImportPhoneNumberCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListAgentStatusesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListAnalyticsDataAssociationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListApprovedOriginsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListBotsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListContactEvaluationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListContactFlowModulesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListContactFlowsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListContactReferencesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDefaultVocabulariesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListEvaluationFormVersionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListEvaluationFormsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListFlowAssociationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListHoursOfOperationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListInstanceAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListInstanceStorageConfigsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListInstancesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListIntegrationAssociationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListLambdaFunctionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListLexBotsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListPhoneNumbersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListPhoneNumbersV2Command.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListPredefinedAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListPromptsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListQueueQuickConnectsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListQueuesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListQuickConnectsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListRoutingProfileQueuesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListRoutingProfilesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListRulesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSecurityKeysCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSecurityProfileApplicationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSecurityProfilePermissionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSecurityProfilesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTaskTemplatesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTrafficDistributionGroupUsersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTrafficDistributionGroupsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListUseCasesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListUserHierarchyGroupsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListUserProficienciesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListViewVersionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListViewsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/MonitorContactCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PauseContactCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutUserStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ReleasePhoneNumberCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ReplicateInstanceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ResumeContactCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ResumeContactRecordingCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchAvailablePhoneNumbersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchContactsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchHoursOfOperationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchPredefinedAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchPromptsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchQueuesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchQuickConnectsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchResourceTagsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchRoutingProfilesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchSecurityProfilesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchUsersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchVocabulariesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SendChatIntegrationEventCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartChatContactCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartContactEvaluationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartContactRecordingCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartContactStreamingCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartOutboundVoiceContactCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartTaskContactCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartWebRTCContactCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopContactCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopContactRecordingCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopContactStreamingCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SubmitContactEvaluationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SuspendContactRecordingCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagContactCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TransferContactCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagContactCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateAgentStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateContactAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateContactCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateContactEvaluationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateContactFlowContentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateContactFlowMetadataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateContactFlowModuleContentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateContactFlowModuleMetadataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateContactFlowNameCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateContactRoutingDataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateContactScheduleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateEvaluationFormCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateHoursOfOperationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateInstanceAttributeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateInstanceStorageConfigCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateParticipantRoleConfigCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdatePhoneNumberCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdatePhoneNumberMetadataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdatePredefinedAttributeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdatePromptCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateQueueHoursOfOperationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateQueueMaxContactsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateQueueNameCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateQueueOutboundCallerConfigCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateQueueStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateQuickConnectConfigCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateQuickConnectNameCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateRoutingProfileAgentAvailabilityTimerCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateRoutingProfileConcurrencyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateRoutingProfileDefaultOutboundQueueCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateRoutingProfileNameCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateRoutingProfileQueuesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateRuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateSecurityProfileCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateTaskTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateTrafficDistributionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateUserHierarchyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateUserHierarchyGroupNameCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateUserHierarchyStructureCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateUserIdentityInfoCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateUserPhoneConfigCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateUserProficienciesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateUserRoutingProfileCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateUserSecurityProfilesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateViewContentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateViewMetadataCommand.d.ts +9 -0
- package/dist-types/ts3.4/models/models_0.d.ts +4 -0
- package/dist-types/ts3.4/models/models_1.d.ts +2 -0
- package/dist-types/ts3.4/models/models_2.d.ts +13 -0
- package/package.json +40 -40
|
@@ -17,23 +17,23 @@ export declare const SearchContactsTimeRangeType: {
|
|
|
17
17
|
*/
|
|
18
18
|
export type SearchContactsTimeRangeType = (typeof SearchContactsTimeRangeType)[keyof typeof SearchContactsTimeRangeType];
|
|
19
19
|
/**
|
|
20
|
-
* @public
|
|
21
20
|
* <p>A structure of time range that you want to search results.</p>
|
|
21
|
+
* @public
|
|
22
22
|
*/
|
|
23
23
|
export interface SearchContactsTimeRange {
|
|
24
24
|
/**
|
|
25
|
-
* @public
|
|
26
25
|
* <p>The type of timestamp to search.</p>
|
|
26
|
+
* @public
|
|
27
27
|
*/
|
|
28
28
|
Type: SearchContactsTimeRangeType | undefined;
|
|
29
29
|
/**
|
|
30
|
-
* @public
|
|
31
30
|
* <p>The start time of the time range.</p>
|
|
31
|
+
* @public
|
|
32
32
|
*/
|
|
33
33
|
StartTime: Date | undefined;
|
|
34
34
|
/**
|
|
35
|
-
* @public
|
|
36
35
|
* <p>The end time of the time range.</p>
|
|
36
|
+
* @public
|
|
37
37
|
*/
|
|
38
38
|
EndTime: Date | undefined;
|
|
39
39
|
}
|
|
@@ -42,117 +42,116 @@ export interface SearchContactsTimeRange {
|
|
|
42
42
|
*/
|
|
43
43
|
export interface SearchContactsRequest {
|
|
44
44
|
/**
|
|
45
|
-
* @public
|
|
46
45
|
* <p>The identifier of Amazon Connect instance. You can find the instance ID in the Amazon
|
|
47
46
|
* Resource Name (ARN) of the instance.</p>
|
|
47
|
+
* @public
|
|
48
48
|
*/
|
|
49
49
|
InstanceId: string | undefined;
|
|
50
50
|
/**
|
|
51
|
-
* @public
|
|
52
51
|
* <p>Time range that you want to search results.</p>
|
|
52
|
+
* @public
|
|
53
53
|
*/
|
|
54
54
|
TimeRange: SearchContactsTimeRange | undefined;
|
|
55
55
|
/**
|
|
56
|
-
* @public
|
|
57
56
|
* <p>The search criteria to be used to return contacts.</p>
|
|
57
|
+
* @public
|
|
58
58
|
*/
|
|
59
59
|
SearchCriteria?: SearchCriteria;
|
|
60
60
|
/**
|
|
61
|
-
* @public
|
|
62
61
|
* <p>The maximum number of results to return per page.</p>
|
|
62
|
+
* @public
|
|
63
63
|
*/
|
|
64
64
|
MaxResults?: number;
|
|
65
65
|
/**
|
|
66
|
-
* @public
|
|
67
66
|
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
68
67
|
* the next request to retrieve the next set of results.</p>
|
|
68
|
+
* @public
|
|
69
69
|
*/
|
|
70
70
|
NextToken?: string;
|
|
71
71
|
/**
|
|
72
|
-
* @public
|
|
73
72
|
* <p>Specifies a field to sort by and a sort order.</p>
|
|
73
|
+
* @public
|
|
74
74
|
*/
|
|
75
75
|
Sort?: Sort;
|
|
76
76
|
}
|
|
77
77
|
/**
|
|
78
|
-
* @public
|
|
79
78
|
* <p>Information about the agent who accepted the contact.</p>
|
|
79
|
+
* @public
|
|
80
80
|
*/
|
|
81
81
|
export interface ContactSearchSummaryAgentInfo {
|
|
82
82
|
/**
|
|
83
|
-
* @public
|
|
84
83
|
* <p>The identifier of the agent who accepted the contact.</p>
|
|
84
|
+
* @public
|
|
85
85
|
*/
|
|
86
86
|
Id?: string;
|
|
87
87
|
/**
|
|
88
|
-
* @public
|
|
89
88
|
* <p>The timestamp when the contact was connected to the agent.</p>
|
|
89
|
+
* @public
|
|
90
90
|
*/
|
|
91
91
|
ConnectedToAgentTimestamp?: Date;
|
|
92
92
|
}
|
|
93
93
|
/**
|
|
94
|
-
* @public
|
|
95
94
|
* <p>If this contact was queued, this contains information about the queue.</p>
|
|
95
|
+
* @public
|
|
96
96
|
*/
|
|
97
97
|
export interface ContactSearchSummaryQueueInfo {
|
|
98
98
|
/**
|
|
99
|
-
* @public
|
|
100
99
|
* <p>The unique identifier for the queue.</p>
|
|
100
|
+
* @public
|
|
101
101
|
*/
|
|
102
102
|
Id?: string;
|
|
103
103
|
/**
|
|
104
|
-
* @public
|
|
105
104
|
* <p>The timestamp when the contact was added to the queue.</p>
|
|
105
|
+
* @public
|
|
106
106
|
*/
|
|
107
107
|
EnqueueTimestamp?: Date;
|
|
108
108
|
}
|
|
109
109
|
/**
|
|
110
|
-
* @public
|
|
111
110
|
* <p>Information of returned contact.</p>
|
|
111
|
+
* @public
|
|
112
112
|
*/
|
|
113
113
|
export interface ContactSearchSummary {
|
|
114
114
|
/**
|
|
115
|
-
* @public
|
|
116
115
|
* <p>The Amazon Resource Name (ARN) of the contact.</p>
|
|
116
|
+
* @public
|
|
117
117
|
*/
|
|
118
118
|
Arn?: string;
|
|
119
119
|
/**
|
|
120
|
-
* @public
|
|
121
120
|
* <p>The identifier of the contact summary.</p>
|
|
121
|
+
* @public
|
|
122
122
|
*/
|
|
123
123
|
Id?: string;
|
|
124
124
|
/**
|
|
125
|
-
* @public
|
|
126
125
|
* <p>If this contact is related to other contacts, this is the ID of the initial contact.</p>
|
|
126
|
+
* @public
|
|
127
127
|
*/
|
|
128
128
|
InitialContactId?: string;
|
|
129
129
|
/**
|
|
130
|
-
* @public
|
|
131
130
|
* <p>If this contact is not the first contact, this is the ID of the previous contact.</p>
|
|
131
|
+
* @public
|
|
132
132
|
*/
|
|
133
133
|
PreviousContactId?: string;
|
|
134
134
|
/**
|
|
135
|
-
* @public
|
|
136
135
|
* <p>Indicates how the contact was initiated.</p>
|
|
136
|
+
* @public
|
|
137
137
|
*/
|
|
138
138
|
InitiationMethod?: ContactInitiationMethod;
|
|
139
139
|
/**
|
|
140
|
-
* @public
|
|
141
140
|
* <p>How the contact reached your contact center.</p>
|
|
141
|
+
* @public
|
|
142
142
|
*/
|
|
143
143
|
Channel?: Channel;
|
|
144
144
|
/**
|
|
145
|
-
* @public
|
|
146
145
|
* <p>If this contact was queued, this contains information about the queue.</p>
|
|
146
|
+
* @public
|
|
147
147
|
*/
|
|
148
148
|
QueueInfo?: ContactSearchSummaryQueueInfo;
|
|
149
149
|
/**
|
|
150
|
-
* @public
|
|
151
150
|
* <p>Information about the agent who accepted the contact.</p>
|
|
151
|
+
* @public
|
|
152
152
|
*/
|
|
153
153
|
AgentInfo?: ContactSearchSummaryAgentInfo;
|
|
154
154
|
/**
|
|
155
|
-
* @public
|
|
156
155
|
* <p>The date and time this contact was initiated, in UTC time. For <code>INBOUND</code>, this is
|
|
157
156
|
* when the contact arrived. For <code>OUTBOUND</code>, this is when the agent began dialing. For
|
|
158
157
|
* <code>CALLBACK</code>, this is when the callback contact was created. For <code>TRANSFER</code>
|
|
@@ -160,16 +159,17 @@ export interface ContactSearchSummary {
|
|
|
160
159
|
* the request arrived. For <code>EXTERNAL_OUTBOUND</code>, this is when the agent started dialing
|
|
161
160
|
* the external participant. For <code>MONITOR</code>, this is when the supervisor started listening
|
|
162
161
|
* to a contact.</p>
|
|
162
|
+
* @public
|
|
163
163
|
*/
|
|
164
164
|
InitiationTimestamp?: Date;
|
|
165
165
|
/**
|
|
166
|
-
* @public
|
|
167
166
|
* <p>The timestamp when the customer endpoint disconnected from Amazon Connect.</p>
|
|
167
|
+
* @public
|
|
168
168
|
*/
|
|
169
169
|
DisconnectTimestamp?: Date;
|
|
170
170
|
/**
|
|
171
|
-
* @public
|
|
172
171
|
* <p>The timestamp, in Unix epoch time format, at which to start running the inbound flow.</p>
|
|
172
|
+
* @public
|
|
173
173
|
*/
|
|
174
174
|
ScheduledTimestamp?: Date;
|
|
175
175
|
}
|
|
@@ -178,18 +178,18 @@ export interface ContactSearchSummary {
|
|
|
178
178
|
*/
|
|
179
179
|
export interface SearchContactsResponse {
|
|
180
180
|
/**
|
|
181
|
-
* @public
|
|
182
181
|
* <p>Information about the contacts.</p>
|
|
182
|
+
* @public
|
|
183
183
|
*/
|
|
184
184
|
Contacts: ContactSearchSummary[] | undefined;
|
|
185
185
|
/**
|
|
186
|
-
* @public
|
|
187
186
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
187
|
+
* @public
|
|
188
188
|
*/
|
|
189
189
|
NextToken?: string;
|
|
190
190
|
/**
|
|
191
|
-
* @public
|
|
192
191
|
* <p>The total number of contacts which matched your search query.</p>
|
|
192
|
+
* @public
|
|
193
193
|
*/
|
|
194
194
|
TotalCount?: number;
|
|
195
195
|
}
|
|
@@ -207,49 +207,48 @@ export declare const StringComparisonType: {
|
|
|
207
207
|
*/
|
|
208
208
|
export type StringComparisonType = (typeof StringComparisonType)[keyof typeof StringComparisonType];
|
|
209
209
|
/**
|
|
210
|
-
* @public
|
|
211
210
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
212
211
|
* <note>
|
|
213
212
|
* <p>The currently supported values for <code>FieldName</code> are <code>name</code> and
|
|
214
213
|
* <code>description</code>.</p>
|
|
215
214
|
* </note>
|
|
215
|
+
* @public
|
|
216
216
|
*/
|
|
217
217
|
export interface StringCondition {
|
|
218
218
|
/**
|
|
219
|
-
* @public
|
|
220
219
|
* <p>The name of the field in the string condition.</p>
|
|
220
|
+
* @public
|
|
221
221
|
*/
|
|
222
222
|
FieldName?: string;
|
|
223
223
|
/**
|
|
224
|
-
* @public
|
|
225
224
|
* <p>The value of the string.</p>
|
|
225
|
+
* @public
|
|
226
226
|
*/
|
|
227
227
|
Value?: string;
|
|
228
228
|
/**
|
|
229
|
-
* @public
|
|
230
229
|
* <p>The type of comparison to be made when evaluating the string condition.</p>
|
|
230
|
+
* @public
|
|
231
231
|
*/
|
|
232
232
|
ComparisonType?: StringComparisonType;
|
|
233
233
|
}
|
|
234
234
|
/**
|
|
235
|
-
* @public
|
|
236
235
|
* <p>A leaf node condition which can be used to specify a tag condition, for example, <code>HAVE
|
|
237
236
|
* BPO = 123</code>. </p>
|
|
237
|
+
* @public
|
|
238
238
|
*/
|
|
239
239
|
export interface TagCondition {
|
|
240
240
|
/**
|
|
241
|
-
* @public
|
|
242
241
|
* <p>The tag key in the tag condition.</p>
|
|
242
|
+
* @public
|
|
243
243
|
*/
|
|
244
244
|
TagKey?: string;
|
|
245
245
|
/**
|
|
246
|
-
* @public
|
|
247
246
|
* <p>The tag value in the tag condition.</p>
|
|
247
|
+
* @public
|
|
248
248
|
*/
|
|
249
249
|
TagValue?: string;
|
|
250
250
|
}
|
|
251
251
|
/**
|
|
252
|
-
* @public
|
|
253
252
|
* <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
|
|
254
253
|
* This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p>
|
|
255
254
|
* <ul>
|
|
@@ -262,33 +261,33 @@ export interface TagCondition {
|
|
|
262
261
|
* operator.</p>
|
|
263
262
|
* </li>
|
|
264
263
|
* </ul>
|
|
264
|
+
* @public
|
|
265
265
|
*/
|
|
266
266
|
export interface ControlPlaneTagFilter {
|
|
267
267
|
/**
|
|
268
|
-
* @public
|
|
269
268
|
* <p>A list of conditions which would be applied together with an <code>OR</code> condition.
|
|
270
269
|
* </p>
|
|
270
|
+
* @public
|
|
271
271
|
*/
|
|
272
272
|
OrConditions?: TagCondition[][];
|
|
273
273
|
/**
|
|
274
|
-
* @public
|
|
275
274
|
* <p>A list of conditions which would be applied together with an <code>AND</code>
|
|
276
275
|
* condition.</p>
|
|
276
|
+
* @public
|
|
277
277
|
*/
|
|
278
278
|
AndConditions?: TagCondition[];
|
|
279
279
|
/**
|
|
280
|
-
* @public
|
|
281
280
|
* <p>A leaf node condition which can be used to specify a tag condition. </p>
|
|
281
|
+
* @public
|
|
282
282
|
*/
|
|
283
283
|
TagCondition?: TagCondition;
|
|
284
284
|
}
|
|
285
285
|
/**
|
|
286
|
-
* @public
|
|
287
286
|
* <p>Filters to be applied to search results.</p>
|
|
287
|
+
* @public
|
|
288
288
|
*/
|
|
289
289
|
export interface HoursOfOperationSearchFilter {
|
|
290
290
|
/**
|
|
291
|
-
* @public
|
|
292
291
|
* <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
|
|
293
292
|
* This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p>
|
|
294
293
|
* <ul>
|
|
@@ -301,6 +300,7 @@ export interface HoursOfOperationSearchFilter {
|
|
|
301
300
|
* operator.</p>
|
|
302
301
|
* </li>
|
|
303
302
|
* </ul>
|
|
303
|
+
* @public
|
|
304
304
|
*/
|
|
305
305
|
TagFilter?: ControlPlaneTagFilter;
|
|
306
306
|
}
|
|
@@ -309,18 +309,18 @@ export interface HoursOfOperationSearchFilter {
|
|
|
309
309
|
*/
|
|
310
310
|
export interface SearchHoursOfOperationsResponse {
|
|
311
311
|
/**
|
|
312
|
-
* @public
|
|
313
312
|
* <p>Information about the hours of operations.</p>
|
|
313
|
+
* @public
|
|
314
314
|
*/
|
|
315
315
|
HoursOfOperations?: HoursOfOperation[];
|
|
316
316
|
/**
|
|
317
|
-
* @public
|
|
318
317
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
318
|
+
* @public
|
|
319
319
|
*/
|
|
320
320
|
NextToken?: string;
|
|
321
321
|
/**
|
|
322
|
-
* @public
|
|
323
322
|
* <p>The total number of hours of operations which matched your search query.</p>
|
|
323
|
+
* @public
|
|
324
324
|
*/
|
|
325
325
|
ApproximateTotalCount?: number;
|
|
326
326
|
}
|
|
@@ -329,29 +329,28 @@ export interface SearchHoursOfOperationsResponse {
|
|
|
329
329
|
*/
|
|
330
330
|
export interface SearchPredefinedAttributesResponse {
|
|
331
331
|
/**
|
|
332
|
-
* @public
|
|
333
332
|
* <p>Predefined attributes matched by the search criteria.</p>
|
|
333
|
+
* @public
|
|
334
334
|
*/
|
|
335
335
|
PredefinedAttributes?: PredefinedAttribute[];
|
|
336
336
|
/**
|
|
337
|
-
* @public
|
|
338
337
|
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
339
338
|
* the next request to retrieve the next set of results.</p>
|
|
339
|
+
* @public
|
|
340
340
|
*/
|
|
341
341
|
NextToken?: string;
|
|
342
342
|
/**
|
|
343
|
-
* @public
|
|
344
343
|
* <p>The approximate number of predefined attributes which matched your search query.</p>
|
|
344
|
+
* @public
|
|
345
345
|
*/
|
|
346
346
|
ApproximateTotalCount?: number;
|
|
347
347
|
}
|
|
348
348
|
/**
|
|
349
|
-
* @public
|
|
350
349
|
* <p>Filters to be applied to search results.</p>
|
|
350
|
+
* @public
|
|
351
351
|
*/
|
|
352
352
|
export interface PromptSearchFilter {
|
|
353
353
|
/**
|
|
354
|
-
* @public
|
|
355
354
|
* <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
|
|
356
355
|
* This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p>
|
|
357
356
|
* <ul>
|
|
@@ -364,6 +363,7 @@ export interface PromptSearchFilter {
|
|
|
364
363
|
* operator.</p>
|
|
365
364
|
* </li>
|
|
366
365
|
* </ul>
|
|
366
|
+
* @public
|
|
367
367
|
*/
|
|
368
368
|
TagFilter?: ControlPlaneTagFilter;
|
|
369
369
|
}
|
|
@@ -372,18 +372,18 @@ export interface PromptSearchFilter {
|
|
|
372
372
|
*/
|
|
373
373
|
export interface SearchPromptsResponse {
|
|
374
374
|
/**
|
|
375
|
-
* @public
|
|
376
375
|
* <p>Information about the prompts.</p>
|
|
376
|
+
* @public
|
|
377
377
|
*/
|
|
378
378
|
Prompts?: Prompt[];
|
|
379
379
|
/**
|
|
380
|
-
* @public
|
|
381
380
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
381
|
+
* @public
|
|
382
382
|
*/
|
|
383
383
|
NextToken?: string;
|
|
384
384
|
/**
|
|
385
|
-
* @public
|
|
386
385
|
* <p>The total number of quick connects which matched your search query.</p>
|
|
386
|
+
* @public
|
|
387
387
|
*/
|
|
388
388
|
ApproximateTotalCount?: number;
|
|
389
389
|
}
|
|
@@ -399,12 +399,11 @@ export declare const SearchableQueueType: {
|
|
|
399
399
|
*/
|
|
400
400
|
export type SearchableQueueType = (typeof SearchableQueueType)[keyof typeof SearchableQueueType];
|
|
401
401
|
/**
|
|
402
|
-
* @public
|
|
403
402
|
* <p>Filters to be applied to search results.</p>
|
|
403
|
+
* @public
|
|
404
404
|
*/
|
|
405
405
|
export interface QueueSearchFilter {
|
|
406
406
|
/**
|
|
407
|
-
* @public
|
|
408
407
|
* <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
|
|
409
408
|
* This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p>
|
|
410
409
|
* <ul>
|
|
@@ -417,6 +416,7 @@ export interface QueueSearchFilter {
|
|
|
417
416
|
* operator.</p>
|
|
418
417
|
* </li>
|
|
419
418
|
* </ul>
|
|
419
|
+
* @public
|
|
420
420
|
*/
|
|
421
421
|
TagFilter?: ControlPlaneTagFilter;
|
|
422
422
|
}
|
|
@@ -425,28 +425,27 @@ export interface QueueSearchFilter {
|
|
|
425
425
|
*/
|
|
426
426
|
export interface SearchQueuesResponse {
|
|
427
427
|
/**
|
|
428
|
-
* @public
|
|
429
428
|
* <p>Information about the queues.</p>
|
|
429
|
+
* @public
|
|
430
430
|
*/
|
|
431
431
|
Queues?: Queue[];
|
|
432
432
|
/**
|
|
433
|
-
* @public
|
|
434
433
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
434
|
+
* @public
|
|
435
435
|
*/
|
|
436
436
|
NextToken?: string;
|
|
437
437
|
/**
|
|
438
|
-
* @public
|
|
439
438
|
* <p>The total number of queues which matched your search query.</p>
|
|
439
|
+
* @public
|
|
440
440
|
*/
|
|
441
441
|
ApproximateTotalCount?: number;
|
|
442
442
|
}
|
|
443
443
|
/**
|
|
444
|
-
* @public
|
|
445
444
|
* <p>Filters to be applied to search results.</p>
|
|
445
|
+
* @public
|
|
446
446
|
*/
|
|
447
447
|
export interface QuickConnectSearchFilter {
|
|
448
448
|
/**
|
|
449
|
-
* @public
|
|
450
449
|
* <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
|
|
451
450
|
* This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p>
|
|
452
451
|
* <ul>
|
|
@@ -459,6 +458,7 @@ export interface QuickConnectSearchFilter {
|
|
|
459
458
|
* operator.</p>
|
|
460
459
|
* </li>
|
|
461
460
|
* </ul>
|
|
461
|
+
* @public
|
|
462
462
|
*/
|
|
463
463
|
TagFilter?: ControlPlaneTagFilter;
|
|
464
464
|
}
|
|
@@ -467,25 +467,25 @@ export interface QuickConnectSearchFilter {
|
|
|
467
467
|
*/
|
|
468
468
|
export interface SearchQuickConnectsResponse {
|
|
469
469
|
/**
|
|
470
|
-
* @public
|
|
471
470
|
* <p>Information about the quick connects.</p>
|
|
471
|
+
* @public
|
|
472
472
|
*/
|
|
473
473
|
QuickConnects?: QuickConnect[];
|
|
474
474
|
/**
|
|
475
|
-
* @public
|
|
476
475
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
476
|
+
* @public
|
|
477
477
|
*/
|
|
478
478
|
NextToken?: string;
|
|
479
479
|
/**
|
|
480
|
-
* @public
|
|
481
480
|
* <p>The total number of quick connects which matched your search query.</p>
|
|
481
|
+
* @public
|
|
482
482
|
*/
|
|
483
483
|
ApproximateTotalCount?: number;
|
|
484
484
|
}
|
|
485
485
|
/**
|
|
486
|
-
* @public
|
|
487
486
|
* <p>Maximum number (1000) of tags have been returned with current request. Consider changing
|
|
488
487
|
* request parameters to get more tags.</p>
|
|
488
|
+
* @public
|
|
489
489
|
*/
|
|
490
490
|
export declare class MaximumResultReturnedException extends __BaseException {
|
|
491
491
|
readonly name: "MaximumResultReturnedException";
|
|
@@ -497,41 +497,41 @@ export declare class MaximumResultReturnedException extends __BaseException {
|
|
|
497
497
|
constructor(opts: __ExceptionOptionType<MaximumResultReturnedException, __BaseException>);
|
|
498
498
|
}
|
|
499
499
|
/**
|
|
500
|
-
* @public
|
|
501
500
|
* <p>The search criteria to be used to return tags.</p>
|
|
501
|
+
* @public
|
|
502
502
|
*/
|
|
503
503
|
export interface TagSearchCondition {
|
|
504
504
|
/**
|
|
505
|
-
* @public
|
|
506
505
|
* <p>The tag key used in the tag search condition.</p>
|
|
506
|
+
* @public
|
|
507
507
|
*/
|
|
508
508
|
tagKey?: string;
|
|
509
509
|
/**
|
|
510
|
-
* @public
|
|
511
510
|
* <p>The tag value used in the tag search condition.</p>
|
|
511
|
+
* @public
|
|
512
512
|
*/
|
|
513
513
|
tagValue?: string;
|
|
514
514
|
/**
|
|
515
|
-
* @public
|
|
516
515
|
* <p>The type of comparison to be made when evaluating the tag key in tag search
|
|
517
516
|
* condition.</p>
|
|
517
|
+
* @public
|
|
518
518
|
*/
|
|
519
519
|
tagKeyComparisonType?: StringComparisonType;
|
|
520
520
|
/**
|
|
521
|
-
* @public
|
|
522
521
|
* <p>The type of comparison to be made when evaluating the tag value in tag search
|
|
523
522
|
* condition.</p>
|
|
523
|
+
* @public
|
|
524
524
|
*/
|
|
525
525
|
tagValueComparisonType?: StringComparisonType;
|
|
526
526
|
}
|
|
527
527
|
/**
|
|
528
|
-
* @public
|
|
529
528
|
* <p>The search criteria to be used to search tags.</p>
|
|
529
|
+
* @public
|
|
530
530
|
*/
|
|
531
531
|
export interface ResourceTagsSearchCriteria {
|
|
532
532
|
/**
|
|
533
|
-
* @public
|
|
534
533
|
* <p>The search criteria to be used to return tags.</p>
|
|
534
|
+
* @public
|
|
535
535
|
*/
|
|
536
536
|
TagSearchCondition?: TagSearchCondition;
|
|
537
537
|
}
|
|
@@ -540,47 +540,47 @@ export interface ResourceTagsSearchCriteria {
|
|
|
540
540
|
*/
|
|
541
541
|
export interface SearchResourceTagsRequest {
|
|
542
542
|
/**
|
|
543
|
-
* @public
|
|
544
543
|
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon
|
|
545
544
|
* Resource Name (ARN) of the instance.</p>
|
|
545
|
+
* @public
|
|
546
546
|
*/
|
|
547
547
|
InstanceId: string | undefined;
|
|
548
548
|
/**
|
|
549
|
-
* @public
|
|
550
549
|
* <p>The list of resource types to be used to search tags from. If not provided or if any empty
|
|
551
550
|
* list is provided, this API will search from all supported resource types.</p>
|
|
551
|
+
* @public
|
|
552
552
|
*/
|
|
553
553
|
ResourceTypes?: string[];
|
|
554
554
|
/**
|
|
555
|
-
* @public
|
|
556
555
|
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
557
556
|
* the next request to retrieve the next set of results.</p>
|
|
557
|
+
* @public
|
|
558
558
|
*/
|
|
559
559
|
NextToken?: string;
|
|
560
560
|
/**
|
|
561
|
-
* @public
|
|
562
561
|
* <p>The maximum number of results to return per page.</p>
|
|
562
|
+
* @public
|
|
563
563
|
*/
|
|
564
564
|
MaxResults?: number;
|
|
565
565
|
/**
|
|
566
|
-
* @public
|
|
567
566
|
* <p>The search criteria to be used to return tags.</p>
|
|
567
|
+
* @public
|
|
568
568
|
*/
|
|
569
569
|
SearchCriteria?: ResourceTagsSearchCriteria;
|
|
570
570
|
}
|
|
571
571
|
/**
|
|
572
|
-
* @public
|
|
573
572
|
* <p>A tag set contains tag key and tag value.</p>
|
|
573
|
+
* @public
|
|
574
574
|
*/
|
|
575
575
|
export interface TagSet {
|
|
576
576
|
/**
|
|
577
|
-
* @public
|
|
578
577
|
* <p>The tag key in the tagSet.</p>
|
|
578
|
+
* @public
|
|
579
579
|
*/
|
|
580
580
|
key?: string;
|
|
581
581
|
/**
|
|
582
|
-
* @public
|
|
583
582
|
* <p>The tag value in the tagSet.</p>
|
|
583
|
+
* @public
|
|
584
584
|
*/
|
|
585
585
|
value?: string;
|
|
586
586
|
}
|
|
@@ -589,23 +589,22 @@ export interface TagSet {
|
|
|
589
589
|
*/
|
|
590
590
|
export interface SearchResourceTagsResponse {
|
|
591
591
|
/**
|
|
592
|
-
* @public
|
|
593
592
|
* <p>A list of tags used in the Amazon Connect instance.</p>
|
|
593
|
+
* @public
|
|
594
594
|
*/
|
|
595
595
|
Tags?: TagSet[];
|
|
596
596
|
/**
|
|
597
|
-
* @public
|
|
598
597
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
598
|
+
* @public
|
|
599
599
|
*/
|
|
600
600
|
NextToken?: string;
|
|
601
601
|
}
|
|
602
602
|
/**
|
|
603
|
-
* @public
|
|
604
603
|
* <p>Filters to be applied to search results.</p>
|
|
604
|
+
* @public
|
|
605
605
|
*/
|
|
606
606
|
export interface RoutingProfileSearchFilter {
|
|
607
607
|
/**
|
|
608
|
-
* @public
|
|
609
608
|
* <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
|
|
610
609
|
* This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p>
|
|
611
610
|
* <ul>
|
|
@@ -618,6 +617,7 @@ export interface RoutingProfileSearchFilter {
|
|
|
618
617
|
* operator.</p>
|
|
619
618
|
* </li>
|
|
620
619
|
* </ul>
|
|
620
|
+
* @public
|
|
621
621
|
*/
|
|
622
622
|
TagFilter?: ControlPlaneTagFilter;
|
|
623
623
|
}
|
|
@@ -626,28 +626,27 @@ export interface RoutingProfileSearchFilter {
|
|
|
626
626
|
*/
|
|
627
627
|
export interface SearchRoutingProfilesResponse {
|
|
628
628
|
/**
|
|
629
|
-
* @public
|
|
630
629
|
* <p>Information about the routing profiles.</p>
|
|
630
|
+
* @public
|
|
631
631
|
*/
|
|
632
632
|
RoutingProfiles?: RoutingProfile[];
|
|
633
633
|
/**
|
|
634
|
-
* @public
|
|
635
634
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
635
|
+
* @public
|
|
636
636
|
*/
|
|
637
637
|
NextToken?: string;
|
|
638
638
|
/**
|
|
639
|
-
* @public
|
|
640
639
|
* <p>The total number of routing profiles which matched your search query.</p>
|
|
640
|
+
* @public
|
|
641
641
|
*/
|
|
642
642
|
ApproximateTotalCount?: number;
|
|
643
643
|
}
|
|
644
644
|
/**
|
|
645
|
-
* @public
|
|
646
645
|
* <p>Filters to be applied to search results.</p>
|
|
646
|
+
* @public
|
|
647
647
|
*/
|
|
648
648
|
export interface SecurityProfilesSearchFilter {
|
|
649
649
|
/**
|
|
650
|
-
* @public
|
|
651
650
|
* <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
|
|
652
651
|
* This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p>
|
|
653
652
|
* <ul>
|
|
@@ -660,42 +659,43 @@ export interface SecurityProfilesSearchFilter {
|
|
|
660
659
|
* operator.</p>
|
|
661
660
|
* </li>
|
|
662
661
|
* </ul>
|
|
662
|
+
* @public
|
|
663
663
|
*/
|
|
664
664
|
TagFilter?: ControlPlaneTagFilter;
|
|
665
665
|
}
|
|
666
666
|
/**
|
|
667
|
-
* @public
|
|
668
667
|
* <p>Information about the returned security profiles.</p>
|
|
668
|
+
* @public
|
|
669
669
|
*/
|
|
670
670
|
export interface SecurityProfileSearchSummary {
|
|
671
671
|
/**
|
|
672
|
-
* @public
|
|
673
672
|
* <p>The identifier of the security profile.</p>
|
|
673
|
+
* @public
|
|
674
674
|
*/
|
|
675
675
|
Id?: string;
|
|
676
676
|
/**
|
|
677
|
-
* @public
|
|
678
677
|
* <p>The organization resource identifier.</p>
|
|
678
|
+
* @public
|
|
679
679
|
*/
|
|
680
680
|
OrganizationResourceId?: string;
|
|
681
681
|
/**
|
|
682
|
-
* @public
|
|
683
682
|
* <p>The Amazon Resource Name (ARN) of the security profile.</p>
|
|
683
|
+
* @public
|
|
684
684
|
*/
|
|
685
685
|
Arn?: string;
|
|
686
686
|
/**
|
|
687
|
-
* @public
|
|
688
687
|
* <p>The name of the security profile.</p>
|
|
688
|
+
* @public
|
|
689
689
|
*/
|
|
690
690
|
SecurityProfileName?: string;
|
|
691
691
|
/**
|
|
692
|
-
* @public
|
|
693
692
|
* <p>The description of the security profile.</p>
|
|
693
|
+
* @public
|
|
694
694
|
*/
|
|
695
695
|
Description?: string;
|
|
696
696
|
/**
|
|
697
|
-
* @public
|
|
698
697
|
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
698
|
+
* @public
|
|
699
699
|
*/
|
|
700
700
|
Tags?: Record<string, string>;
|
|
701
701
|
}
|
|
@@ -704,18 +704,18 @@ export interface SecurityProfileSearchSummary {
|
|
|
704
704
|
*/
|
|
705
705
|
export interface SearchSecurityProfilesResponse {
|
|
706
706
|
/**
|
|
707
|
-
* @public
|
|
708
707
|
* <p>Information about the security profiles.</p>
|
|
708
|
+
* @public
|
|
709
709
|
*/
|
|
710
710
|
SecurityProfiles?: SecurityProfileSearchSummary[];
|
|
711
711
|
/**
|
|
712
|
-
* @public
|
|
713
712
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
713
|
+
* @public
|
|
714
714
|
*/
|
|
715
715
|
NextToken?: string;
|
|
716
716
|
/**
|
|
717
|
-
* @public
|
|
718
717
|
* <p>The total number of security profiles which matched your search query.</p>
|
|
718
|
+
* @public
|
|
719
719
|
*/
|
|
720
720
|
ApproximateTotalCount?: number;
|
|
721
721
|
}
|
|
@@ -732,28 +732,89 @@ export declare const HierarchyGroupMatchType: {
|
|
|
732
732
|
*/
|
|
733
733
|
export type HierarchyGroupMatchType = (typeof HierarchyGroupMatchType)[keyof typeof HierarchyGroupMatchType];
|
|
734
734
|
/**
|
|
735
|
-
* @public
|
|
736
735
|
* <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
|
|
736
|
+
* @public
|
|
737
737
|
*/
|
|
738
738
|
export interface HierarchyGroupCondition {
|
|
739
739
|
/**
|
|
740
|
-
* @public
|
|
741
740
|
* <p>The value in the hierarchy group condition.</p>
|
|
741
|
+
* @public
|
|
742
742
|
*/
|
|
743
743
|
Value?: string;
|
|
744
744
|
/**
|
|
745
|
-
* @public
|
|
746
745
|
* <p>The type of hierarchy group match.</p>
|
|
746
|
+
* @public
|
|
747
747
|
*/
|
|
748
748
|
HierarchyGroupMatchType?: HierarchyGroupMatchType;
|
|
749
749
|
}
|
|
750
750
|
/**
|
|
751
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code>
|
|
752
|
+
* condition.</p>
|
|
751
753
|
* @public
|
|
754
|
+
*/
|
|
755
|
+
export interface AttributeAndCondition {
|
|
756
|
+
/**
|
|
757
|
+
* <p>A leaf node condition which can be used to specify a tag condition.</p>
|
|
758
|
+
* @public
|
|
759
|
+
*/
|
|
760
|
+
TagConditions?: TagCondition[];
|
|
761
|
+
/**
|
|
762
|
+
* <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
|
|
763
|
+
* @public
|
|
764
|
+
*/
|
|
765
|
+
HierarchyGroupCondition?: HierarchyGroupCondition;
|
|
766
|
+
}
|
|
767
|
+
/**
|
|
768
|
+
* <p>An object that can be used to specify Tag conditions or Hierarchy Group conditions inside
|
|
769
|
+
* the <code>SearchFilter</code>.</p>
|
|
770
|
+
* <p>This accepts an <code>OR</code> of <code>AND</code> (List of List) input where:</p>
|
|
771
|
+
* <ul>
|
|
772
|
+
* <li>
|
|
773
|
+
* <p>The top level list specifies conditions that need to be applied with <code>OR</code>
|
|
774
|
+
* operator</p>
|
|
775
|
+
* </li>
|
|
776
|
+
* <li>
|
|
777
|
+
* <p>The inner list specifies conditions that need to be applied with <code>AND</code>
|
|
778
|
+
* operator.</p>
|
|
779
|
+
* </li>
|
|
780
|
+
* </ul>
|
|
781
|
+
* <note>
|
|
782
|
+
* <p>Only one field can be populated. Maximum number of allowed Tag conditions is 25. Maximum
|
|
783
|
+
* number of allowed Hierarchy Group conditions is 20. </p>
|
|
784
|
+
* </note>
|
|
785
|
+
* @public
|
|
786
|
+
*/
|
|
787
|
+
export interface ControlPlaneUserAttributeFilter {
|
|
788
|
+
/**
|
|
789
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code>
|
|
790
|
+
* condition.</p>
|
|
791
|
+
* @public
|
|
792
|
+
*/
|
|
793
|
+
OrConditions?: AttributeAndCondition[];
|
|
794
|
+
/**
|
|
795
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code>
|
|
796
|
+
* condition.</p>
|
|
797
|
+
* @public
|
|
798
|
+
*/
|
|
799
|
+
AndCondition?: AttributeAndCondition;
|
|
800
|
+
/**
|
|
801
|
+
* <p>A leaf node condition which can be used to specify a tag condition, for example, <code>HAVE
|
|
802
|
+
* BPO = 123</code>. </p>
|
|
803
|
+
* @public
|
|
804
|
+
*/
|
|
805
|
+
TagCondition?: TagCondition;
|
|
806
|
+
/**
|
|
807
|
+
* <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
|
|
808
|
+
* @public
|
|
809
|
+
*/
|
|
810
|
+
HierarchyGroupCondition?: HierarchyGroupCondition;
|
|
811
|
+
}
|
|
812
|
+
/**
|
|
752
813
|
* <p>Filters to be applied to search results.</p>
|
|
814
|
+
* @public
|
|
753
815
|
*/
|
|
754
816
|
export interface UserSearchFilter {
|
|
755
817
|
/**
|
|
756
|
-
* @public
|
|
757
818
|
* <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
|
|
758
819
|
* This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p>
|
|
759
820
|
* <ul>
|
|
@@ -766,78 +827,101 @@ export interface UserSearchFilter {
|
|
|
766
827
|
* operator.</p>
|
|
767
828
|
* </li>
|
|
768
829
|
* </ul>
|
|
830
|
+
* @public
|
|
769
831
|
*/
|
|
770
832
|
TagFilter?: ControlPlaneTagFilter;
|
|
833
|
+
/**
|
|
834
|
+
* <p>An object that can be used to specify Tag conditions or Hierarchy Group conditions inside
|
|
835
|
+
* the SearchFilter.</p>
|
|
836
|
+
* <p>This accepts an <code>OR</code> of <code>AND</code> (List of List) input where:</p>
|
|
837
|
+
* <ul>
|
|
838
|
+
* <li>
|
|
839
|
+
* <p>The top level list specifies conditions that need to be applied with <code>OR</code>
|
|
840
|
+
* operator.</p>
|
|
841
|
+
* </li>
|
|
842
|
+
* <li>
|
|
843
|
+
* <p>The inner list specifies conditions that need to be applied with <code>AND</code>
|
|
844
|
+
* operator.</p>
|
|
845
|
+
* </li>
|
|
846
|
+
* </ul>
|
|
847
|
+
* <note>
|
|
848
|
+
* <p>Only one field can be populated. This object can’t be used along with TagFilter. Request
|
|
849
|
+
* can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of
|
|
850
|
+
* both is not supported and such request will throw AccessDeniedException.</p>
|
|
851
|
+
* </note>
|
|
852
|
+
* @public
|
|
853
|
+
*/
|
|
854
|
+
UserAttributeFilter?: ControlPlaneUserAttributeFilter;
|
|
771
855
|
}
|
|
772
856
|
/**
|
|
773
|
-
* @public
|
|
774
857
|
* <p>The user's first name and last name.</p>
|
|
858
|
+
* @public
|
|
775
859
|
*/
|
|
776
860
|
export interface UserIdentityInfoLite {
|
|
777
861
|
/**
|
|
778
|
-
* @public
|
|
779
862
|
* <p>The user's first name.</p>
|
|
863
|
+
* @public
|
|
780
864
|
*/
|
|
781
865
|
FirstName?: string;
|
|
782
866
|
/**
|
|
783
|
-
* @public
|
|
784
867
|
* <p>The user's last name.</p>
|
|
868
|
+
* @public
|
|
785
869
|
*/
|
|
786
870
|
LastName?: string;
|
|
787
871
|
}
|
|
788
872
|
/**
|
|
789
|
-
* @public
|
|
790
873
|
* <p>Information about the returned users.</p>
|
|
874
|
+
* @public
|
|
791
875
|
*/
|
|
792
876
|
export interface UserSearchSummary {
|
|
793
877
|
/**
|
|
794
|
-
* @public
|
|
795
878
|
* <p>The Amazon Resource Name (ARN) of the user.</p>
|
|
879
|
+
* @public
|
|
796
880
|
*/
|
|
797
881
|
Arn?: string;
|
|
798
882
|
/**
|
|
799
|
-
* @public
|
|
800
883
|
* <p>The directory identifier of the user.</p>
|
|
884
|
+
* @public
|
|
801
885
|
*/
|
|
802
886
|
DirectoryUserId?: string;
|
|
803
887
|
/**
|
|
804
|
-
* @public
|
|
805
888
|
* <p>The identifier of the user's hierarchy group.</p>
|
|
889
|
+
* @public
|
|
806
890
|
*/
|
|
807
891
|
HierarchyGroupId?: string;
|
|
808
892
|
/**
|
|
809
|
-
* @public
|
|
810
893
|
* <p>The identifier of the user's summary.</p>
|
|
894
|
+
* @public
|
|
811
895
|
*/
|
|
812
896
|
Id?: string;
|
|
813
897
|
/**
|
|
814
|
-
* @public
|
|
815
898
|
* <p>The user's first name and last name.</p>
|
|
899
|
+
* @public
|
|
816
900
|
*/
|
|
817
901
|
IdentityInfo?: UserIdentityInfoLite;
|
|
818
902
|
/**
|
|
819
|
-
* @public
|
|
820
903
|
* <p>Contains information about the phone configuration settings for a user.</p>
|
|
904
|
+
* @public
|
|
821
905
|
*/
|
|
822
906
|
PhoneConfig?: UserPhoneConfig;
|
|
823
907
|
/**
|
|
824
|
-
* @public
|
|
825
908
|
* <p>The identifier of the user's routing profile.</p>
|
|
909
|
+
* @public
|
|
826
910
|
*/
|
|
827
911
|
RoutingProfileId?: string;
|
|
828
912
|
/**
|
|
829
|
-
* @public
|
|
830
913
|
* <p>The identifiers of the user's security profiles.</p>
|
|
914
|
+
* @public
|
|
831
915
|
*/
|
|
832
916
|
SecurityProfileIds?: string[];
|
|
833
917
|
/**
|
|
834
|
-
* @public
|
|
835
918
|
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
919
|
+
* @public
|
|
836
920
|
*/
|
|
837
921
|
Tags?: Record<string, string>;
|
|
838
922
|
/**
|
|
839
|
-
* @public
|
|
840
923
|
* <p>The name of the user.</p>
|
|
924
|
+
* @public
|
|
841
925
|
*/
|
|
842
926
|
Username?: string;
|
|
843
927
|
}
|
|
@@ -846,18 +930,18 @@ export interface UserSearchSummary {
|
|
|
846
930
|
*/
|
|
847
931
|
export interface SearchUsersResponse {
|
|
848
932
|
/**
|
|
849
|
-
* @public
|
|
850
933
|
* <p>Information about the users.</p>
|
|
934
|
+
* @public
|
|
851
935
|
*/
|
|
852
936
|
Users?: UserSearchSummary[];
|
|
853
937
|
/**
|
|
854
|
-
* @public
|
|
855
938
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
939
|
+
* @public
|
|
856
940
|
*/
|
|
857
941
|
NextToken?: string;
|
|
858
942
|
/**
|
|
859
|
-
* @public
|
|
860
943
|
* <p>The total number of users who matched your search query.</p>
|
|
944
|
+
* @public
|
|
861
945
|
*/
|
|
862
946
|
ApproximateTotalCount?: number;
|
|
863
947
|
}
|
|
@@ -866,79 +950,79 @@ export interface SearchUsersResponse {
|
|
|
866
950
|
*/
|
|
867
951
|
export interface SearchVocabulariesRequest {
|
|
868
952
|
/**
|
|
869
|
-
* @public
|
|
870
953
|
* <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>
|
|
954
|
+
* @public
|
|
871
955
|
*/
|
|
872
956
|
InstanceId: string | undefined;
|
|
873
957
|
/**
|
|
874
|
-
* @public
|
|
875
958
|
* <p>The maximum number of results to return per page.</p>
|
|
959
|
+
* @public
|
|
876
960
|
*/
|
|
877
961
|
MaxResults?: number;
|
|
878
962
|
/**
|
|
879
|
-
* @public
|
|
880
963
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
881
964
|
* response in the next request to retrieve the next set of results.</p>
|
|
965
|
+
* @public
|
|
882
966
|
*/
|
|
883
967
|
NextToken?: string;
|
|
884
968
|
/**
|
|
885
|
-
* @public
|
|
886
969
|
* <p>The current state of the custom vocabulary.</p>
|
|
970
|
+
* @public
|
|
887
971
|
*/
|
|
888
972
|
State?: VocabularyState;
|
|
889
973
|
/**
|
|
890
|
-
* @public
|
|
891
974
|
* <p>The starting pattern of the name of the vocabulary.</p>
|
|
975
|
+
* @public
|
|
892
976
|
*/
|
|
893
977
|
NameStartsWith?: string;
|
|
894
978
|
/**
|
|
895
|
-
* @public
|
|
896
979
|
* <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
|
|
897
980
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
|
|
898
981
|
* </p>
|
|
982
|
+
* @public
|
|
899
983
|
*/
|
|
900
984
|
LanguageCode?: VocabularyLanguageCode;
|
|
901
985
|
}
|
|
902
986
|
/**
|
|
903
|
-
* @public
|
|
904
987
|
* <p>Contains summary information about the custom vocabulary.</p>
|
|
988
|
+
* @public
|
|
905
989
|
*/
|
|
906
990
|
export interface VocabularySummary {
|
|
907
991
|
/**
|
|
908
|
-
* @public
|
|
909
992
|
* <p>A unique name of the custom vocabulary.</p>
|
|
993
|
+
* @public
|
|
910
994
|
*/
|
|
911
995
|
Name: string | undefined;
|
|
912
996
|
/**
|
|
913
|
-
* @public
|
|
914
997
|
* <p>The identifier of the custom vocabulary.</p>
|
|
998
|
+
* @public
|
|
915
999
|
*/
|
|
916
1000
|
Id: string | undefined;
|
|
917
1001
|
/**
|
|
918
|
-
* @public
|
|
919
1002
|
* <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p>
|
|
1003
|
+
* @public
|
|
920
1004
|
*/
|
|
921
1005
|
Arn: string | undefined;
|
|
922
1006
|
/**
|
|
923
|
-
* @public
|
|
924
1007
|
* <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
|
|
925
1008
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
|
|
926
1009
|
* </p>
|
|
1010
|
+
* @public
|
|
927
1011
|
*/
|
|
928
1012
|
LanguageCode: VocabularyLanguageCode | undefined;
|
|
929
1013
|
/**
|
|
930
|
-
* @public
|
|
931
1014
|
* <p>The current state of the custom vocabulary.</p>
|
|
1015
|
+
* @public
|
|
932
1016
|
*/
|
|
933
1017
|
State: VocabularyState | undefined;
|
|
934
1018
|
/**
|
|
935
|
-
* @public
|
|
936
1019
|
* <p>The timestamp when the custom vocabulary was last modified.</p>
|
|
1020
|
+
* @public
|
|
937
1021
|
*/
|
|
938
1022
|
LastModifiedTime: Date | undefined;
|
|
939
1023
|
/**
|
|
940
|
-
* @public
|
|
941
1024
|
* <p>The reason why the custom vocabulary was not created.</p>
|
|
1025
|
+
* @public
|
|
942
1026
|
*/
|
|
943
1027
|
FailureReason?: string;
|
|
944
1028
|
}
|
|
@@ -947,13 +1031,13 @@ export interface VocabularySummary {
|
|
|
947
1031
|
*/
|
|
948
1032
|
export interface SearchVocabulariesResponse {
|
|
949
1033
|
/**
|
|
950
|
-
* @public
|
|
951
1034
|
* <p>The list of the available custom vocabularies.</p>
|
|
1035
|
+
* @public
|
|
952
1036
|
*/
|
|
953
1037
|
VocabularySummaryList?: VocabularySummary[];
|
|
954
1038
|
/**
|
|
955
|
-
* @public
|
|
956
1039
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1040
|
+
* @public
|
|
957
1041
|
*/
|
|
958
1042
|
NextToken?: string;
|
|
959
1043
|
}
|
|
@@ -971,7 +1055,6 @@ export declare const ChatEventType: {
|
|
|
971
1055
|
*/
|
|
972
1056
|
export type ChatEventType = (typeof ChatEventType)[keyof typeof ChatEventType];
|
|
973
1057
|
/**
|
|
974
|
-
* @public
|
|
975
1058
|
* <p>Chat integration event containing payload to perform different chat actions such as:</p>
|
|
976
1059
|
* <ul>
|
|
977
1060
|
* <li>
|
|
@@ -984,15 +1067,15 @@ export type ChatEventType = (typeof ChatEventType)[keyof typeof ChatEventType];
|
|
|
984
1067
|
* <p>Disconnecting from a chat</p>
|
|
985
1068
|
* </li>
|
|
986
1069
|
* </ul>
|
|
1070
|
+
* @public
|
|
987
1071
|
*/
|
|
988
1072
|
export interface ChatEvent {
|
|
989
1073
|
/**
|
|
990
|
-
* @public
|
|
991
1074
|
* <p>Type of chat integration event. </p>
|
|
1075
|
+
* @public
|
|
992
1076
|
*/
|
|
993
1077
|
Type: ChatEventType | undefined;
|
|
994
1078
|
/**
|
|
995
|
-
* @public
|
|
996
1079
|
* <p>Type of content. This is required when <code>Type</code> is <code>MESSAGE</code> or
|
|
997
1080
|
* <code>EVENT</code>. </p>
|
|
998
1081
|
* <ul>
|
|
@@ -1006,10 +1089,10 @@ export interface ChatEvent {
|
|
|
1006
1089
|
* Reference</i>. </p>
|
|
1007
1090
|
* </li>
|
|
1008
1091
|
* </ul>
|
|
1092
|
+
* @public
|
|
1009
1093
|
*/
|
|
1010
1094
|
ContentType?: string;
|
|
1011
1095
|
/**
|
|
1012
|
-
* @public
|
|
1013
1096
|
* <p>Content of the message or event. This is required when <code>Type</code> is
|
|
1014
1097
|
* <code>MESSAGE</code> and for certain <code>ContentTypes</code> when <code>Type</code> is
|
|
1015
1098
|
* <code>EVENT</code>.</p>
|
|
@@ -1023,39 +1106,39 @@ export interface ChatEvent {
|
|
|
1023
1106
|
* Reference</i>. </p>
|
|
1024
1107
|
* </li>
|
|
1025
1108
|
* </ul>
|
|
1109
|
+
* @public
|
|
1026
1110
|
*/
|
|
1027
1111
|
Content?: string;
|
|
1028
1112
|
}
|
|
1029
1113
|
/**
|
|
1030
|
-
* @public
|
|
1031
1114
|
* <p>The customer's details.</p>
|
|
1115
|
+
* @public
|
|
1032
1116
|
*/
|
|
1033
1117
|
export interface ParticipantDetails {
|
|
1034
1118
|
/**
|
|
1035
|
-
* @public
|
|
1036
1119
|
* <p>Display name of the participant.</p>
|
|
1120
|
+
* @public
|
|
1037
1121
|
*/
|
|
1038
1122
|
DisplayName: string | undefined;
|
|
1039
1123
|
}
|
|
1040
1124
|
/**
|
|
1041
|
-
* @public
|
|
1042
1125
|
* <p>The streaming configuration, such as the Amazon SNS streaming endpoint.</p>
|
|
1126
|
+
* @public
|
|
1043
1127
|
*/
|
|
1044
1128
|
export interface ChatStreamingConfiguration {
|
|
1045
1129
|
/**
|
|
1046
|
-
* @public
|
|
1047
1130
|
* <p>The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used
|
|
1048
1131
|
* to publish real-time message streaming for chat conversations.</p>
|
|
1132
|
+
* @public
|
|
1049
1133
|
*/
|
|
1050
1134
|
StreamingEndpointArn: string | undefined;
|
|
1051
1135
|
}
|
|
1052
1136
|
/**
|
|
1053
|
-
* @public
|
|
1054
1137
|
* <p>Payload of chat properties to apply when starting a new contact.</p>
|
|
1138
|
+
* @public
|
|
1055
1139
|
*/
|
|
1056
1140
|
export interface NewSessionDetails {
|
|
1057
1141
|
/**
|
|
1058
|
-
* @public
|
|
1059
1142
|
* <p> The supported chat message content types. Supported types are <code>text/plain</code>,
|
|
1060
1143
|
* <code>text/markdown</code>, <code>application/json</code>,
|
|
1061
1144
|
* <code>application/vnd.amazonaws.connect.message.interactive</code>, and
|
|
@@ -1065,23 +1148,24 @@ export interface NewSessionDetails {
|
|
|
1065
1148
|
* <code>text/plain</code>: <code>[text/plain, text/markdown, application/json]</code>, <code>
|
|
1066
1149
|
* [text/markdown, text/plain]</code>, <code>[text/plain, application/json,
|
|
1067
1150
|
* application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>
|
|
1151
|
+
* @public
|
|
1068
1152
|
*/
|
|
1069
1153
|
SupportedMessagingContentTypes?: string[];
|
|
1070
1154
|
/**
|
|
1071
|
-
* @public
|
|
1072
1155
|
* <p>The customer's details.</p>
|
|
1156
|
+
* @public
|
|
1073
1157
|
*/
|
|
1074
1158
|
ParticipantDetails?: ParticipantDetails;
|
|
1075
1159
|
/**
|
|
1076
|
-
* @public
|
|
1077
1160
|
* <p> A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes. </p>
|
|
1078
1161
|
* <p> There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute
|
|
1079
1162
|
* keys can include only alphanumeric, dash, and underscore characters. </p>
|
|
1163
|
+
* @public
|
|
1080
1164
|
*/
|
|
1081
1165
|
Attributes?: Record<string, string>;
|
|
1082
1166
|
/**
|
|
1083
|
-
* @public
|
|
1084
1167
|
* <p>The streaming configuration, such as the Amazon SNS streaming endpoint.</p>
|
|
1168
|
+
* @public
|
|
1085
1169
|
*/
|
|
1086
1170
|
StreamingConfiguration?: ChatStreamingConfiguration;
|
|
1087
1171
|
}
|
|
@@ -1090,35 +1174,35 @@ export interface NewSessionDetails {
|
|
|
1090
1174
|
*/
|
|
1091
1175
|
export interface SendChatIntegrationEventRequest {
|
|
1092
1176
|
/**
|
|
1093
|
-
* @public
|
|
1094
1177
|
* <p>External identifier of chat customer participant, used in part to uniquely identify a chat.
|
|
1095
1178
|
* For SMS, this is the E164 phone number of the chat customer participant.</p>
|
|
1179
|
+
* @public
|
|
1096
1180
|
*/
|
|
1097
1181
|
SourceId: string | undefined;
|
|
1098
1182
|
/**
|
|
1099
|
-
* @public
|
|
1100
1183
|
* <p>Chat system identifier, used in part to uniquely identify chat. This is associated with the
|
|
1101
1184
|
* Amazon Connect instance and flow to be used to start chats. For SMS, this is the phone
|
|
1102
1185
|
* number destination of inbound SMS messages represented by an Amazon Pinpoint phone number
|
|
1103
1186
|
* ARN.</p>
|
|
1187
|
+
* @public
|
|
1104
1188
|
*/
|
|
1105
1189
|
DestinationId: string | undefined;
|
|
1106
1190
|
/**
|
|
1107
|
-
* @public
|
|
1108
1191
|
* <p>Classification of a channel. This is used in part to uniquely identify chat. </p>
|
|
1109
1192
|
* <p>Valid value: <code>["connect:sms"]</code>
|
|
1110
1193
|
* </p>
|
|
1194
|
+
* @public
|
|
1111
1195
|
*/
|
|
1112
1196
|
Subtype?: string;
|
|
1113
1197
|
/**
|
|
1114
|
-
* @public
|
|
1115
1198
|
* <p>Chat integration event payload</p>
|
|
1199
|
+
* @public
|
|
1116
1200
|
*/
|
|
1117
1201
|
Event: ChatEvent | undefined;
|
|
1118
1202
|
/**
|
|
1119
|
-
* @public
|
|
1120
1203
|
* <p>Contact properties to apply when starting a new chat. If the integration event is handled
|
|
1121
1204
|
* with an existing chat, this is ignored.</p>
|
|
1205
|
+
* @public
|
|
1122
1206
|
*/
|
|
1123
1207
|
NewSessionDetails?: NewSessionDetails;
|
|
1124
1208
|
}
|
|
@@ -1127,32 +1211,31 @@ export interface SendChatIntegrationEventRequest {
|
|
|
1127
1211
|
*/
|
|
1128
1212
|
export interface SendChatIntegrationEventResponse {
|
|
1129
1213
|
/**
|
|
1130
|
-
* @public
|
|
1131
1214
|
* <p>Identifier of chat contact used to handle integration event. This may be null if the
|
|
1132
1215
|
* integration event is not valid without an already existing chat contact.</p>
|
|
1216
|
+
* @public
|
|
1133
1217
|
*/
|
|
1134
1218
|
InitialContactId?: string;
|
|
1135
1219
|
/**
|
|
1136
|
-
* @public
|
|
1137
1220
|
* <p>Whether handling the integration event resulted in creating a new chat or acting on existing
|
|
1138
1221
|
* chat.</p>
|
|
1222
|
+
* @public
|
|
1139
1223
|
*/
|
|
1140
1224
|
NewChatCreated?: boolean;
|
|
1141
1225
|
}
|
|
1142
1226
|
/**
|
|
1143
|
-
* @public
|
|
1144
1227
|
* <p>A chat message.</p>
|
|
1228
|
+
* @public
|
|
1145
1229
|
*/
|
|
1146
1230
|
export interface ChatMessage {
|
|
1147
1231
|
/**
|
|
1148
|
-
* @public
|
|
1149
1232
|
* <p>The type of the content. Supported types are <code>text/plain</code>,
|
|
1150
1233
|
* <code>text/markdown</code>, <code>application/json</code>, and
|
|
1151
1234
|
* <code>application/vnd.amazonaws.connect.message.interactive.response</code>.</p>
|
|
1235
|
+
* @public
|
|
1152
1236
|
*/
|
|
1153
1237
|
ContentType: string | undefined;
|
|
1154
1238
|
/**
|
|
1155
|
-
* @public
|
|
1156
1239
|
* <p>The content of the chat message. </p>
|
|
1157
1240
|
* <ul>
|
|
1158
1241
|
* <li>
|
|
@@ -1168,17 +1251,17 @@ export interface ChatMessage {
|
|
|
1168
1251
|
* Length Constraints are Minimum of 1, Maximum of 12288.</p>
|
|
1169
1252
|
* </li>
|
|
1170
1253
|
* </ul>
|
|
1254
|
+
* @public
|
|
1171
1255
|
*/
|
|
1172
1256
|
Content: string | undefined;
|
|
1173
1257
|
}
|
|
1174
1258
|
/**
|
|
1175
|
-
* @public
|
|
1176
1259
|
* <p>Enable persistent chats. For more information about enabling persistent chat, and for
|
|
1177
1260
|
* example use cases and how to configure for them, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>.</p>
|
|
1261
|
+
* @public
|
|
1178
1262
|
*/
|
|
1179
1263
|
export interface PersistentChat {
|
|
1180
1264
|
/**
|
|
1181
|
-
* @public
|
|
1182
1265
|
* <p>The contactId that is used for rehydration depends on the rehydration type. RehydrationType
|
|
1183
1266
|
* is required for persistent chat. </p>
|
|
1184
1267
|
* <ul>
|
|
@@ -1198,23 +1281,24 @@ export interface PersistentChat {
|
|
|
1198
1281
|
* </li>
|
|
1199
1282
|
* </ul>
|
|
1200
1283
|
* <p>The actual contactId used for rehydration is provided in the response of this API. </p>
|
|
1284
|
+
* @public
|
|
1201
1285
|
*/
|
|
1202
1286
|
RehydrationType?: RehydrationType;
|
|
1203
1287
|
/**
|
|
1204
|
-
* @public
|
|
1205
1288
|
* <p>The contactId from which a persistent chat session must be started.</p>
|
|
1289
|
+
* @public
|
|
1206
1290
|
*/
|
|
1207
1291
|
SourceContactId?: string;
|
|
1208
1292
|
}
|
|
1209
1293
|
/**
|
|
1210
|
-
* @public
|
|
1211
1294
|
* <p>A value for a segment attribute. This is structured as a map where the key is
|
|
1212
1295
|
* <code>valueString</code> and the value is a string.</p>
|
|
1296
|
+
* @public
|
|
1213
1297
|
*/
|
|
1214
1298
|
export interface SegmentAttributeValue {
|
|
1215
1299
|
/**
|
|
1216
|
-
* @public
|
|
1217
1300
|
* <p>The value of a segment attribute.</p>
|
|
1301
|
+
* @public
|
|
1218
1302
|
*/
|
|
1219
1303
|
ValueString?: string;
|
|
1220
1304
|
}
|
|
@@ -1223,12 +1307,11 @@ export interface SegmentAttributeValue {
|
|
|
1223
1307
|
*/
|
|
1224
1308
|
export interface StartChatContactRequest {
|
|
1225
1309
|
/**
|
|
1226
|
-
* @public
|
|
1227
1310
|
* <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>
|
|
1311
|
+
* @public
|
|
1228
1312
|
*/
|
|
1229
1313
|
InstanceId: string | undefined;
|
|
1230
1314
|
/**
|
|
1231
|
-
* @public
|
|
1232
1315
|
* <p>The identifier of the flow for initiating the chat.
|
|
1233
1316
|
* To
|
|
1234
1317
|
* see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the flow. On the
|
|
@@ -1236,43 +1319,43 @@ export interface StartChatContactRequest {
|
|
|
1236
1319
|
* information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p>
|
|
1237
1320
|
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
1238
1321
|
* </p>
|
|
1322
|
+
* @public
|
|
1239
1323
|
*/
|
|
1240
1324
|
ContactFlowId: string | undefined;
|
|
1241
1325
|
/**
|
|
1242
|
-
* @public
|
|
1243
1326
|
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes. </p>
|
|
1244
1327
|
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
1245
1328
|
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
1329
|
+
* @public
|
|
1246
1330
|
*/
|
|
1247
1331
|
Attributes?: Record<string, string>;
|
|
1248
1332
|
/**
|
|
1249
|
-
* @public
|
|
1250
1333
|
* <p>Information identifying the participant.</p>
|
|
1334
|
+
* @public
|
|
1251
1335
|
*/
|
|
1252
1336
|
ParticipantDetails: ParticipantDetails | undefined;
|
|
1253
1337
|
/**
|
|
1254
|
-
* @public
|
|
1255
1338
|
* <p>The initial message to be sent to the newly created chat. If you have a Lex bot in your
|
|
1256
1339
|
* flow, the initial message is not delivered to the Lex bot.</p>
|
|
1340
|
+
* @public
|
|
1257
1341
|
*/
|
|
1258
1342
|
InitialMessage?: ChatMessage;
|
|
1259
1343
|
/**
|
|
1260
|
-
* @public
|
|
1261
1344
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1262
1345
|
* request. If not provided, the Amazon Web Services
|
|
1263
1346
|
* SDK populates this field. For more information about idempotency, see
|
|
1264
1347
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1348
|
+
* @public
|
|
1265
1349
|
*/
|
|
1266
1350
|
ClientToken?: string;
|
|
1267
1351
|
/**
|
|
1268
|
-
* @public
|
|
1269
1352
|
* <p>The total duration of the newly started chat session. If not specified, the chat session
|
|
1270
1353
|
* duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum
|
|
1271
1354
|
* configurable time is 10,080 minutes (7 days).</p>
|
|
1355
|
+
* @public
|
|
1272
1356
|
*/
|
|
1273
1357
|
ChatDurationInMinutes?: number;
|
|
1274
1358
|
/**
|
|
1275
|
-
* @public
|
|
1276
1359
|
* <p>The supported chat message content types. Supported types are <code>text/plain</code>,
|
|
1277
1360
|
* <code>text/markdown</code>, <code>application/json</code>,
|
|
1278
1361
|
* <code>application/vnd.amazonaws.connect.message.interactive</code>, and
|
|
@@ -1287,25 +1370,25 @@ export interface StartChatContactRequest {
|
|
|
1287
1370
|
* use the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html">Show
|
|
1288
1371
|
* view</a> flow block.</p>
|
|
1289
1372
|
* </note>
|
|
1373
|
+
* @public
|
|
1290
1374
|
*/
|
|
1291
1375
|
SupportedMessagingContentTypes?: string[];
|
|
1292
1376
|
/**
|
|
1293
|
-
* @public
|
|
1294
1377
|
* <p>Enable persistent chats. For more information about enabling persistent chat, and for
|
|
1295
1378
|
* example use cases and how to configure for them, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>.</p>
|
|
1379
|
+
* @public
|
|
1296
1380
|
*/
|
|
1297
1381
|
PersistentChat?: PersistentChat;
|
|
1298
1382
|
/**
|
|
1299
|
-
* @public
|
|
1300
1383
|
* <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
|
|
1301
1384
|
* chat starting.</p>
|
|
1302
1385
|
* <note>
|
|
1303
1386
|
* <p>You cannot provide data for both RelatedContactId and PersistentChat. </p>
|
|
1304
1387
|
* </note>
|
|
1388
|
+
* @public
|
|
1305
1389
|
*/
|
|
1306
1390
|
RelatedContactId?: string;
|
|
1307
1391
|
/**
|
|
1308
|
-
* @public
|
|
1309
1392
|
* <p>A set of system defined key-value pairs stored on individual contact segments using an
|
|
1310
1393
|
* attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in
|
|
1311
1394
|
* flows.</p>
|
|
@@ -1318,6 +1401,7 @@ export interface StartChatContactRequest {
|
|
|
1318
1401
|
* <code>SegmentAttributes</code> as \{<code> "connect:Subtype": \{"valueString" : "connect:Guide"
|
|
1319
1402
|
* \}\}</code>.</p>
|
|
1320
1403
|
* </note>
|
|
1404
|
+
* @public
|
|
1321
1405
|
*/
|
|
1322
1406
|
SegmentAttributes?: Record<string, SegmentAttributeValue>;
|
|
1323
1407
|
}
|
|
@@ -1326,26 +1410,26 @@ export interface StartChatContactRequest {
|
|
|
1326
1410
|
*/
|
|
1327
1411
|
export interface StartChatContactResponse {
|
|
1328
1412
|
/**
|
|
1329
|
-
* @public
|
|
1330
1413
|
* <p>The identifier of this contact within the Amazon Connect instance. </p>
|
|
1414
|
+
* @public
|
|
1331
1415
|
*/
|
|
1332
1416
|
ContactId?: string;
|
|
1333
1417
|
/**
|
|
1334
|
-
* @public
|
|
1335
1418
|
* <p>The identifier for a chat participant. The participantId for a chat participant is the same
|
|
1336
1419
|
* throughout the chat lifecycle.</p>
|
|
1420
|
+
* @public
|
|
1337
1421
|
*/
|
|
1338
1422
|
ParticipantId?: string;
|
|
1339
1423
|
/**
|
|
1340
|
-
* @public
|
|
1341
1424
|
* <p>The token used by the chat participant to call <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a>. The participant token is valid for the lifetime of a chat
|
|
1342
1425
|
* participant.</p>
|
|
1426
|
+
* @public
|
|
1343
1427
|
*/
|
|
1344
1428
|
ParticipantToken?: string;
|
|
1345
1429
|
/**
|
|
1346
|
-
* @public
|
|
1347
1430
|
* <p>The contactId from which a persistent chat session is started. This field is populated only
|
|
1348
1431
|
* for persistent chats.</p>
|
|
1432
|
+
* @public
|
|
1349
1433
|
*/
|
|
1350
1434
|
ContinuedFromContactId?: string;
|
|
1351
1435
|
}
|
|
@@ -1354,26 +1438,26 @@ export interface StartChatContactResponse {
|
|
|
1354
1438
|
*/
|
|
1355
1439
|
export interface StartContactEvaluationRequest {
|
|
1356
1440
|
/**
|
|
1357
|
-
* @public
|
|
1358
1441
|
* <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>
|
|
1442
|
+
* @public
|
|
1359
1443
|
*/
|
|
1360
1444
|
InstanceId: string | undefined;
|
|
1361
1445
|
/**
|
|
1362
|
-
* @public
|
|
1363
1446
|
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
1447
|
+
* @public
|
|
1364
1448
|
*/
|
|
1365
1449
|
ContactId: string | undefined;
|
|
1366
1450
|
/**
|
|
1367
|
-
* @public
|
|
1368
1451
|
* <p>The unique identifier for the evaluation form.</p>
|
|
1452
|
+
* @public
|
|
1369
1453
|
*/
|
|
1370
1454
|
EvaluationFormId: string | undefined;
|
|
1371
1455
|
/**
|
|
1372
|
-
* @public
|
|
1373
1456
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1374
1457
|
* request. If not provided, the Amazon Web Services
|
|
1375
1458
|
* SDK populates this field. For more information about idempotency, see
|
|
1376
1459
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1460
|
+
* @public
|
|
1377
1461
|
*/
|
|
1378
1462
|
ClientToken?: string;
|
|
1379
1463
|
}
|
|
@@ -1382,13 +1466,13 @@ export interface StartContactEvaluationRequest {
|
|
|
1382
1466
|
*/
|
|
1383
1467
|
export interface StartContactEvaluationResponse {
|
|
1384
1468
|
/**
|
|
1385
|
-
* @public
|
|
1386
1469
|
* <p>A unique identifier for the contact evaluation.</p>
|
|
1470
|
+
* @public
|
|
1387
1471
|
*/
|
|
1388
1472
|
EvaluationId: string | undefined;
|
|
1389
1473
|
/**
|
|
1390
|
-
* @public
|
|
1391
1474
|
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
1475
|
+
* @public
|
|
1392
1476
|
*/
|
|
1393
1477
|
EvaluationArn: string | undefined;
|
|
1394
1478
|
}
|
|
@@ -1406,13 +1490,13 @@ export declare const VoiceRecordingTrack: {
|
|
|
1406
1490
|
*/
|
|
1407
1491
|
export type VoiceRecordingTrack = (typeof VoiceRecordingTrack)[keyof typeof VoiceRecordingTrack];
|
|
1408
1492
|
/**
|
|
1409
|
-
* @public
|
|
1410
1493
|
* <p>Contains information about the recording configuration settings.</p>
|
|
1494
|
+
* @public
|
|
1411
1495
|
*/
|
|
1412
1496
|
export interface VoiceRecordingConfiguration {
|
|
1413
1497
|
/**
|
|
1414
|
-
* @public
|
|
1415
1498
|
* <p>Identifies which track is being recorded.</p>
|
|
1499
|
+
* @public
|
|
1416
1500
|
*/
|
|
1417
1501
|
VoiceRecordingTrack?: VoiceRecordingTrack;
|
|
1418
1502
|
}
|
|
@@ -1421,24 +1505,24 @@ export interface VoiceRecordingConfiguration {
|
|
|
1421
1505
|
*/
|
|
1422
1506
|
export interface StartContactRecordingRequest {
|
|
1423
1507
|
/**
|
|
1424
|
-
* @public
|
|
1425
1508
|
* <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>
|
|
1509
|
+
* @public
|
|
1426
1510
|
*/
|
|
1427
1511
|
InstanceId: string | undefined;
|
|
1428
1512
|
/**
|
|
1429
|
-
* @public
|
|
1430
1513
|
* <p>The identifier of the contact.</p>
|
|
1514
|
+
* @public
|
|
1431
1515
|
*/
|
|
1432
1516
|
ContactId: string | undefined;
|
|
1433
1517
|
/**
|
|
1434
|
-
* @public
|
|
1435
1518
|
* <p>The identifier of the contact. This is the identifier of the contact associated with the
|
|
1436
1519
|
* first interaction with the contact center.</p>
|
|
1520
|
+
* @public
|
|
1437
1521
|
*/
|
|
1438
1522
|
InitialContactId: string | undefined;
|
|
1439
1523
|
/**
|
|
1440
|
-
* @public
|
|
1441
1524
|
* <p>The person being recorded.</p>
|
|
1525
|
+
* @public
|
|
1442
1526
|
*/
|
|
1443
1527
|
VoiceRecordingConfiguration: VoiceRecordingConfiguration | undefined;
|
|
1444
1528
|
}
|
|
@@ -1452,27 +1536,27 @@ export interface StartContactRecordingResponse {
|
|
|
1452
1536
|
*/
|
|
1453
1537
|
export interface StartContactStreamingRequest {
|
|
1454
1538
|
/**
|
|
1455
|
-
* @public
|
|
1456
1539
|
* <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>
|
|
1540
|
+
* @public
|
|
1457
1541
|
*/
|
|
1458
1542
|
InstanceId: string | undefined;
|
|
1459
1543
|
/**
|
|
1460
|
-
* @public
|
|
1461
1544
|
* <p>The identifier of the contact. This is the identifier of the contact associated with the
|
|
1462
1545
|
* first interaction with the contact center.</p>
|
|
1546
|
+
* @public
|
|
1463
1547
|
*/
|
|
1464
1548
|
ContactId: string | undefined;
|
|
1465
1549
|
/**
|
|
1466
|
-
* @public
|
|
1467
1550
|
* <p>The streaming configuration, such as the Amazon SNS streaming endpoint.</p>
|
|
1551
|
+
* @public
|
|
1468
1552
|
*/
|
|
1469
1553
|
ChatStreamingConfiguration: ChatStreamingConfiguration | undefined;
|
|
1470
1554
|
/**
|
|
1471
|
-
* @public
|
|
1472
1555
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1473
1556
|
* request. If not provided, the Amazon Web Services
|
|
1474
1557
|
* SDK populates this field. For more information about idempotency, see
|
|
1475
1558
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1559
|
+
* @public
|
|
1476
1560
|
*/
|
|
1477
1561
|
ClientToken?: string;
|
|
1478
1562
|
}
|
|
@@ -1481,21 +1565,21 @@ export interface StartContactStreamingRequest {
|
|
|
1481
1565
|
*/
|
|
1482
1566
|
export interface StartContactStreamingResponse {
|
|
1483
1567
|
/**
|
|
1484
|
-
* @public
|
|
1485
1568
|
* <p>The identifier of the streaming configuration enabled. </p>
|
|
1569
|
+
* @public
|
|
1486
1570
|
*/
|
|
1487
1571
|
StreamingId: string | undefined;
|
|
1488
1572
|
}
|
|
1489
1573
|
/**
|
|
1490
|
-
* @public
|
|
1491
1574
|
* <p>Outbound calls to the destination number are not allowed.</p>
|
|
1575
|
+
* @public
|
|
1492
1576
|
*/
|
|
1493
1577
|
export declare class DestinationNotAllowedException extends __BaseException {
|
|
1494
1578
|
readonly name: "DestinationNotAllowedException";
|
|
1495
1579
|
readonly $fault: "client";
|
|
1496
1580
|
/**
|
|
1497
|
-
* @public
|
|
1498
1581
|
* <p>The message about the outbound calls.</p>
|
|
1582
|
+
* @public
|
|
1499
1583
|
*/
|
|
1500
1584
|
Message?: string;
|
|
1501
1585
|
/**
|
|
@@ -1504,15 +1588,15 @@ export declare class DestinationNotAllowedException extends __BaseException {
|
|
|
1504
1588
|
constructor(opts: __ExceptionOptionType<DestinationNotAllowedException, __BaseException>);
|
|
1505
1589
|
}
|
|
1506
1590
|
/**
|
|
1507
|
-
* @public
|
|
1508
1591
|
* <p>The contact is not permitted.</p>
|
|
1592
|
+
* @public
|
|
1509
1593
|
*/
|
|
1510
1594
|
export declare class OutboundContactNotPermittedException extends __BaseException {
|
|
1511
1595
|
readonly name: "OutboundContactNotPermittedException";
|
|
1512
1596
|
readonly $fault: "client";
|
|
1513
1597
|
/**
|
|
1514
|
-
* @public
|
|
1515
1598
|
* <p>The message about the contact.</p>
|
|
1599
|
+
* @public
|
|
1516
1600
|
*/
|
|
1517
1601
|
Message?: string;
|
|
1518
1602
|
/**
|
|
@@ -1521,20 +1605,20 @@ export declare class OutboundContactNotPermittedException extends __BaseExceptio
|
|
|
1521
1605
|
constructor(opts: __ExceptionOptionType<OutboundContactNotPermittedException, __BaseException>);
|
|
1522
1606
|
}
|
|
1523
1607
|
/**
|
|
1524
|
-
* @public
|
|
1525
1608
|
* <p>Configuration of the answering machine detection.</p>
|
|
1609
|
+
* @public
|
|
1526
1610
|
*/
|
|
1527
1611
|
export interface AnswerMachineDetectionConfig {
|
|
1528
1612
|
/**
|
|
1529
|
-
* @public
|
|
1530
1613
|
* <p>The flag to indicate if answer machine detection analysis needs to be performed for a voice
|
|
1531
1614
|
* call. If set to <code>true</code>, <code>TrafficType</code> must be set as <code>CAMPAIGN</code>.
|
|
1532
1615
|
* </p>
|
|
1616
|
+
* @public
|
|
1533
1617
|
*/
|
|
1534
1618
|
EnableAnswerMachineDetection?: boolean;
|
|
1535
1619
|
/**
|
|
1536
|
-
* @public
|
|
1537
1620
|
* <p>Wait for the answering machine prompt.</p>
|
|
1621
|
+
* @public
|
|
1538
1622
|
*/
|
|
1539
1623
|
AwaitAnswerMachinePrompt?: boolean;
|
|
1540
1624
|
}
|
|
@@ -1555,41 +1639,40 @@ export type TrafficType = (typeof TrafficType)[keyof typeof TrafficType];
|
|
|
1555
1639
|
*/
|
|
1556
1640
|
export interface StartOutboundVoiceContactRequest {
|
|
1557
1641
|
/**
|
|
1558
|
-
* @public
|
|
1559
1642
|
* <p>The name of a voice contact that is shown to an agent in the Contact Control Panel
|
|
1560
1643
|
* (CCP).</p>
|
|
1644
|
+
* @public
|
|
1561
1645
|
*/
|
|
1562
1646
|
Name?: string;
|
|
1563
1647
|
/**
|
|
1564
|
-
* @public
|
|
1565
1648
|
* <p>A description of the voice contact that is shown to an agent in the Contact Control Panel
|
|
1566
1649
|
* (CCP).</p>
|
|
1650
|
+
* @public
|
|
1567
1651
|
*/
|
|
1568
1652
|
Description?: string;
|
|
1569
1653
|
/**
|
|
1570
|
-
* @public
|
|
1571
1654
|
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can
|
|
1572
1655
|
* have the following reference types at the time of creation: <code>URL</code> |
|
|
1573
1656
|
* <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>.
|
|
1574
1657
|
* <code>ATTACHMENT</code> is not a supported reference type during voice contact creation.</p>
|
|
1658
|
+
* @public
|
|
1575
1659
|
*/
|
|
1576
1660
|
References?: Record<string, Reference>;
|
|
1577
1661
|
/**
|
|
1578
|
-
* @public
|
|
1579
1662
|
* <p>The <code>contactId</code> that is related to this contact. Linking voice, task, or chat by
|
|
1580
1663
|
* using <code>RelatedContactID</code> copies over contact attributes from the related contact to
|
|
1581
1664
|
* the new contact. All updates to user-defined attributes in the new contact are limited to the
|
|
1582
1665
|
* individual contact ID. There are no limits to the number of contacts that can be linked by using
|
|
1583
1666
|
* <code>RelatedContactId</code>. </p>
|
|
1667
|
+
* @public
|
|
1584
1668
|
*/
|
|
1585
1669
|
RelatedContactId?: string;
|
|
1586
1670
|
/**
|
|
1587
|
-
* @public
|
|
1588
1671
|
* <p>The phone number of the customer, in E.164 format.</p>
|
|
1672
|
+
* @public
|
|
1589
1673
|
*/
|
|
1590
1674
|
DestinationPhoneNumber: string | undefined;
|
|
1591
1675
|
/**
|
|
1592
|
-
* @public
|
|
1593
1676
|
* <p>The
|
|
1594
1677
|
* identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the
|
|
1595
1678
|
* navigation menu go to <b>Routing</b>, <b>Contact
|
|
@@ -1598,59 +1681,60 @@ export interface StartOutboundVoiceContactRequest {
|
|
|
1598
1681
|
* part of the ARN, shown here in bold: </p>
|
|
1599
1682
|
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
1600
1683
|
* </p>
|
|
1684
|
+
* @public
|
|
1601
1685
|
*/
|
|
1602
1686
|
ContactFlowId: string | undefined;
|
|
1603
1687
|
/**
|
|
1604
|
-
* @public
|
|
1605
1688
|
* <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>
|
|
1689
|
+
* @public
|
|
1606
1690
|
*/
|
|
1607
1691
|
InstanceId: string | undefined;
|
|
1608
1692
|
/**
|
|
1609
|
-
* @public
|
|
1610
1693
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1611
1694
|
* request. If not provided, the Amazon Web Services
|
|
1612
1695
|
* SDK populates this field. For more information about idempotency, see
|
|
1613
1696
|
* <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,
|
|
1614
1697
|
* the contact ID is returned.
|
|
1615
1698
|
* </p>
|
|
1699
|
+
* @public
|
|
1616
1700
|
*/
|
|
1617
1701
|
ClientToken?: string;
|
|
1618
1702
|
/**
|
|
1619
|
-
* @public
|
|
1620
1703
|
* <p>The phone number associated with the Amazon Connect instance, in E.164 format. If you do
|
|
1621
1704
|
* not specify a source phone number, you must specify a queue.</p>
|
|
1705
|
+
* @public
|
|
1622
1706
|
*/
|
|
1623
1707
|
SourcePhoneNumber?: string;
|
|
1624
1708
|
/**
|
|
1625
|
-
* @public
|
|
1626
1709
|
* <p>The queue for the call. If you specify a queue, the phone displayed for caller ID is the
|
|
1627
1710
|
* phone number specified in the queue. If you do not specify a queue, the queue defined in the flow
|
|
1628
1711
|
* is used. If you do not specify a queue, you must specify a source phone number.</p>
|
|
1712
|
+
* @public
|
|
1629
1713
|
*/
|
|
1630
1714
|
QueueId?: string;
|
|
1631
1715
|
/**
|
|
1632
|
-
* @public
|
|
1633
1716
|
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p>
|
|
1634
1717
|
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
1635
1718
|
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
1719
|
+
* @public
|
|
1636
1720
|
*/
|
|
1637
1721
|
Attributes?: Record<string, string>;
|
|
1638
1722
|
/**
|
|
1639
|
-
* @public
|
|
1640
1723
|
* <p>Configuration of the answering machine detection for this outbound call. </p>
|
|
1724
|
+
* @public
|
|
1641
1725
|
*/
|
|
1642
1726
|
AnswerMachineDetectionConfig?: AnswerMachineDetectionConfig;
|
|
1643
1727
|
/**
|
|
1644
|
-
* @public
|
|
1645
1728
|
* <p>The campaign identifier of the outbound communication.</p>
|
|
1729
|
+
* @public
|
|
1646
1730
|
*/
|
|
1647
1731
|
CampaignId?: string;
|
|
1648
1732
|
/**
|
|
1649
|
-
* @public
|
|
1650
1733
|
* <p>Denotes the class of traffic. Calls with different traffic types are handled differently by
|
|
1651
1734
|
* Amazon Connect. The default value is <code>GENERAL</code>. Use <code>CAMPAIGN</code> if
|
|
1652
1735
|
* <code>EnableAnswerMachineDetection</code> is set to <code>true</code>. For all other cases, use
|
|
1653
1736
|
* <code>GENERAL</code>. </p>
|
|
1737
|
+
* @public
|
|
1654
1738
|
*/
|
|
1655
1739
|
TrafficType?: TrafficType;
|
|
1656
1740
|
}
|
|
@@ -1659,8 +1743,8 @@ export interface StartOutboundVoiceContactRequest {
|
|
|
1659
1743
|
*/
|
|
1660
1744
|
export interface StartOutboundVoiceContactResponse {
|
|
1661
1745
|
/**
|
|
1662
|
-
* @public
|
|
1663
1746
|
* <p>The identifier of this contact within the Amazon Connect instance.</p>
|
|
1747
|
+
* @public
|
|
1664
1748
|
*/
|
|
1665
1749
|
ContactId?: string;
|
|
1666
1750
|
}
|
|
@@ -1669,88 +1753,88 @@ export interface StartOutboundVoiceContactResponse {
|
|
|
1669
1753
|
*/
|
|
1670
1754
|
export interface StartTaskContactRequest {
|
|
1671
1755
|
/**
|
|
1672
|
-
* @public
|
|
1673
1756
|
* <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>
|
|
1757
|
+
* @public
|
|
1674
1758
|
*/
|
|
1675
1759
|
InstanceId: string | undefined;
|
|
1676
1760
|
/**
|
|
1677
|
-
* @public
|
|
1678
1761
|
* <p>The identifier of the previous chat, voice, or task contact. Any updates to user-defined
|
|
1679
1762
|
* attributes to task contacts linked using the same <code>PreviousContactID</code> will affect
|
|
1680
1763
|
* every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.</p>
|
|
1764
|
+
* @public
|
|
1681
1765
|
*/
|
|
1682
1766
|
PreviousContactId?: string;
|
|
1683
1767
|
/**
|
|
1684
|
-
* @public
|
|
1685
1768
|
* <p>The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website,
|
|
1686
1769
|
* on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
|
|
1687
1770
|
* <b>Show additional flow information</b>. The ContactFlowId is the last
|
|
1688
1771
|
* part of the ARN, shown here in bold: </p>
|
|
1689
1772
|
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
1690
1773
|
* </p>
|
|
1774
|
+
* @public
|
|
1691
1775
|
*/
|
|
1692
1776
|
ContactFlowId?: string;
|
|
1693
1777
|
/**
|
|
1694
|
-
* @public
|
|
1695
1778
|
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p>
|
|
1696
1779
|
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
1697
1780
|
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
1781
|
+
* @public
|
|
1698
1782
|
*/
|
|
1699
1783
|
Attributes?: Record<string, string>;
|
|
1700
1784
|
/**
|
|
1701
|
-
* @public
|
|
1702
1785
|
* <p>The name of a task that is shown to an agent in the Contact Control Panel (CCP).</p>
|
|
1786
|
+
* @public
|
|
1703
1787
|
*/
|
|
1704
1788
|
Name: string | undefined;
|
|
1705
1789
|
/**
|
|
1706
|
-
* @public
|
|
1707
1790
|
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
|
|
1708
1791
|
* the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> |
|
|
1709
1792
|
* <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a
|
|
1710
1793
|
* supported reference type during task creation.</p>
|
|
1794
|
+
* @public
|
|
1711
1795
|
*/
|
|
1712
1796
|
References?: Record<string, Reference>;
|
|
1713
1797
|
/**
|
|
1714
|
-
* @public
|
|
1715
1798
|
* <p>A description of the task that is shown to an agent in the Contact Control Panel
|
|
1716
1799
|
* (CCP).</p>
|
|
1800
|
+
* @public
|
|
1717
1801
|
*/
|
|
1718
1802
|
Description?: string;
|
|
1719
1803
|
/**
|
|
1720
|
-
* @public
|
|
1721
1804
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1722
1805
|
* request. If not provided, the Amazon Web Services
|
|
1723
1806
|
* SDK populates this field. For more information about idempotency, see
|
|
1724
1807
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1808
|
+
* @public
|
|
1725
1809
|
*/
|
|
1726
1810
|
ClientToken?: string;
|
|
1727
1811
|
/**
|
|
1728
|
-
* @public
|
|
1729
1812
|
* <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>
|
|
1813
|
+
* @public
|
|
1730
1814
|
*/
|
|
1731
1815
|
ScheduledTime?: Date;
|
|
1732
1816
|
/**
|
|
1733
|
-
* @public
|
|
1734
1817
|
* <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
|
|
1735
1818
|
* <i>Amazon Connect Administrator Guide</i>. </p>
|
|
1819
|
+
* @public
|
|
1736
1820
|
*/
|
|
1737
1821
|
TaskTemplateId?: string;
|
|
1738
1822
|
/**
|
|
1739
|
-
* @public
|
|
1740
1823
|
* <p>The identifier for the quick connect. Tasks that are created by using <code>QuickConnectId</code> will use the
|
|
1741
1824
|
* flow that is defined on agent or queue quick connect. For more information about quick connects,
|
|
1742
1825
|
* see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html">Create quick
|
|
1743
1826
|
* connects</a>.</p>
|
|
1827
|
+
* @public
|
|
1744
1828
|
*/
|
|
1745
1829
|
QuickConnectId?: string;
|
|
1746
1830
|
/**
|
|
1747
|
-
* @public
|
|
1748
1831
|
* <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
|
|
1749
1832
|
* tasks together by using <code>RelatedContactID</code> copies over contact attributes from the
|
|
1750
1833
|
* related task contact to the new task contact. All updates to user-defined attributes in the new
|
|
1751
1834
|
* task contact are limited to the individual contact ID, unlike what happens when tasks are linked
|
|
1752
1835
|
* by using <code>PreviousContactID</code>. There are no limits to the number of contacts that can
|
|
1753
1836
|
* be linked by using <code>RelatedContactId</code>. </p>
|
|
1837
|
+
* @public
|
|
1754
1838
|
*/
|
|
1755
1839
|
RelatedContactId?: string;
|
|
1756
1840
|
}
|
|
@@ -1759,8 +1843,8 @@ export interface StartTaskContactRequest {
|
|
|
1759
1843
|
*/
|
|
1760
1844
|
export interface StartTaskContactResponse {
|
|
1761
1845
|
/**
|
|
1762
|
-
* @public
|
|
1763
1846
|
* <p>The identifier of this contact within the Amazon Connect instance.</p>
|
|
1847
|
+
* @public
|
|
1764
1848
|
*/
|
|
1765
1849
|
ContactId?: string;
|
|
1766
1850
|
}
|
|
@@ -1769,24 +1853,23 @@ export interface StartTaskContactResponse {
|
|
|
1769
1853
|
*/
|
|
1770
1854
|
export interface StartWebRTCContactRequest {
|
|
1771
1855
|
/**
|
|
1772
|
-
* @public
|
|
1773
1856
|
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p>
|
|
1774
1857
|
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
1775
1858
|
* can include only alphanumeric, -, and _ characters.</p>
|
|
1859
|
+
* @public
|
|
1776
1860
|
*/
|
|
1777
1861
|
Attributes?: Record<string, string>;
|
|
1778
1862
|
/**
|
|
1779
|
-
* @public
|
|
1780
1863
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1781
1864
|
* request. If not provided, the Amazon Web Services
|
|
1782
1865
|
* SDK populates this field. For more information about idempotency, see
|
|
1783
1866
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1784
1867
|
* <p>The token is valid for 7 days after creation. If a contact is already started, the contact
|
|
1785
1868
|
* ID is returned.</p>
|
|
1869
|
+
* @public
|
|
1786
1870
|
*/
|
|
1787
1871
|
ClientToken?: string;
|
|
1788
1872
|
/**
|
|
1789
|
-
* @public
|
|
1790
1873
|
* <p>The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the
|
|
1791
1874
|
* navigation menu go to <b>Routing</b>, <b>Contact
|
|
1792
1875
|
* Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
|
|
@@ -1794,89 +1877,90 @@ export interface StartWebRTCContactRequest {
|
|
|
1794
1877
|
* part of the ARN, shown here in bold: </p>
|
|
1795
1878
|
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
1796
1879
|
* </p>
|
|
1880
|
+
* @public
|
|
1797
1881
|
*/
|
|
1798
1882
|
ContactFlowId: string | undefined;
|
|
1799
1883
|
/**
|
|
1800
|
-
* @public
|
|
1801
1884
|
* <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>
|
|
1885
|
+
* @public
|
|
1802
1886
|
*/
|
|
1803
1887
|
InstanceId: string | undefined;
|
|
1804
1888
|
/**
|
|
1805
|
-
* @public
|
|
1806
1889
|
* <p>Information about the video sharing capabilities of the participants (customer,
|
|
1807
1890
|
* agent).</p>
|
|
1891
|
+
* @public
|
|
1808
1892
|
*/
|
|
1809
1893
|
AllowedCapabilities?: AllowedCapabilities;
|
|
1810
1894
|
/**
|
|
1811
|
-
* @public
|
|
1812
1895
|
* <p>The customer's details.</p>
|
|
1896
|
+
* @public
|
|
1813
1897
|
*/
|
|
1814
1898
|
ParticipantDetails: ParticipantDetails | undefined;
|
|
1815
1899
|
/**
|
|
1816
|
-
* @public
|
|
1817
1900
|
* <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
|
|
1818
1901
|
* contact starting.</p>
|
|
1902
|
+
* @public
|
|
1819
1903
|
*/
|
|
1820
1904
|
RelatedContactId?: string;
|
|
1821
1905
|
/**
|
|
1822
|
-
* @public
|
|
1823
1906
|
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
|
|
1824
1907
|
* the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> |
|
|
1825
1908
|
* <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a
|
|
1826
1909
|
* supported reference type during task creation.</p>
|
|
1910
|
+
* @public
|
|
1827
1911
|
*/
|
|
1828
1912
|
References?: Record<string, Reference>;
|
|
1829
1913
|
/**
|
|
1830
|
-
* @public
|
|
1831
1914
|
* <p>A description of the task that is shown to an agent in the Contact Control Panel
|
|
1832
1915
|
* (CCP).</p>
|
|
1916
|
+
* @public
|
|
1833
1917
|
*/
|
|
1834
1918
|
Description?: string;
|
|
1835
1919
|
}
|
|
1836
1920
|
/**
|
|
1837
|
-
* @public
|
|
1838
1921
|
* <p>The attendee information, including attendee ID and join token.</p>
|
|
1922
|
+
* @public
|
|
1839
1923
|
*/
|
|
1840
1924
|
export interface Attendee {
|
|
1841
1925
|
/**
|
|
1842
|
-
* @public
|
|
1843
1926
|
* <p>The Amazon Chime SDK attendee ID.</p>
|
|
1927
|
+
* @public
|
|
1844
1928
|
*/
|
|
1845
1929
|
AttendeeId?: string;
|
|
1846
1930
|
/**
|
|
1847
|
-
* @public
|
|
1848
1931
|
* <p>The join token used by the Amazon Chime SDK attendee.</p>
|
|
1932
|
+
* @public
|
|
1849
1933
|
*/
|
|
1850
1934
|
JoinToken?: string;
|
|
1851
1935
|
}
|
|
1852
1936
|
/**
|
|
1853
|
-
* @public
|
|
1854
1937
|
* <p>A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.</p>
|
|
1938
|
+
* @public
|
|
1855
1939
|
*/
|
|
1856
1940
|
export interface MediaPlacement {
|
|
1857
1941
|
/**
|
|
1858
|
-
* @public
|
|
1859
1942
|
* <p>The audio host URL.</p>
|
|
1943
|
+
* @public
|
|
1860
1944
|
*/
|
|
1861
1945
|
AudioHostUrl?: string;
|
|
1862
1946
|
/**
|
|
1863
|
-
* @public
|
|
1864
1947
|
* <p>The audio fallback URL.</p>
|
|
1948
|
+
* @public
|
|
1865
1949
|
*/
|
|
1866
1950
|
AudioFallbackUrl?: string;
|
|
1867
1951
|
/**
|
|
1868
|
-
* @public
|
|
1869
1952
|
* <p>The signaling URL.</p>
|
|
1953
|
+
* @public
|
|
1870
1954
|
*/
|
|
1871
1955
|
SignalingUrl?: string;
|
|
1872
1956
|
/**
|
|
1873
|
-
* @public
|
|
1874
1957
|
* <p>The turn control URL.</p>
|
|
1958
|
+
* @public
|
|
1875
1959
|
*/
|
|
1876
1960
|
TurnControlUrl?: string;
|
|
1877
1961
|
/**
|
|
1878
|
-
* @public
|
|
1879
1962
|
* <p>The event ingestion URL to which you send client meeting events.</p>
|
|
1963
|
+
* @public
|
|
1880
1964
|
*/
|
|
1881
1965
|
EventIngestionUrl?: string;
|
|
1882
1966
|
}
|
|
@@ -1893,66 +1977,66 @@ export declare const MeetingFeatureStatus: {
|
|
|
1893
1977
|
*/
|
|
1894
1978
|
export type MeetingFeatureStatus = (typeof MeetingFeatureStatus)[keyof typeof MeetingFeatureStatus];
|
|
1895
1979
|
/**
|
|
1896
|
-
* @public
|
|
1897
1980
|
* <p>Has audio-specific configurations as the operating parameter for Echo Reduction.</p>
|
|
1981
|
+
* @public
|
|
1898
1982
|
*/
|
|
1899
1983
|
export interface AudioFeatures {
|
|
1900
1984
|
/**
|
|
1901
|
-
* @public
|
|
1902
1985
|
* <p>Makes echo reduction available to clients who connect to the meeting.</p>
|
|
1986
|
+
* @public
|
|
1903
1987
|
*/
|
|
1904
1988
|
EchoReduction?: MeetingFeatureStatus;
|
|
1905
1989
|
}
|
|
1906
1990
|
/**
|
|
1907
|
-
* @public
|
|
1908
1991
|
* <p>The configuration settings of the features available to a meeting.</p>
|
|
1992
|
+
* @public
|
|
1909
1993
|
*/
|
|
1910
1994
|
export interface MeetingFeaturesConfiguration {
|
|
1911
1995
|
/**
|
|
1912
|
-
* @public
|
|
1913
1996
|
* <p>The configuration settings for the audio features available to a meeting.</p>
|
|
1997
|
+
* @public
|
|
1914
1998
|
*/
|
|
1915
1999
|
Audio?: AudioFeatures;
|
|
1916
2000
|
}
|
|
1917
2001
|
/**
|
|
1918
|
-
* @public
|
|
1919
2002
|
* <p>A meeting created using the Amazon Chime SDK.</p>
|
|
2003
|
+
* @public
|
|
1920
2004
|
*/
|
|
1921
2005
|
export interface Meeting {
|
|
1922
2006
|
/**
|
|
1923
|
-
* @public
|
|
1924
2007
|
* <p>The Amazon Web Services Region in which you create the meeting.</p>
|
|
2008
|
+
* @public
|
|
1925
2009
|
*/
|
|
1926
2010
|
MediaRegion?: string;
|
|
1927
2011
|
/**
|
|
1928
|
-
* @public
|
|
1929
2012
|
* <p>The media placement for the meeting.</p>
|
|
2013
|
+
* @public
|
|
1930
2014
|
*/
|
|
1931
2015
|
MediaPlacement?: MediaPlacement;
|
|
1932
2016
|
/**
|
|
1933
|
-
* @public
|
|
1934
2017
|
* <p>The configuration settings of the features available to a meeting.</p>
|
|
2018
|
+
* @public
|
|
1935
2019
|
*/
|
|
1936
2020
|
MeetingFeatures?: MeetingFeaturesConfiguration;
|
|
1937
2021
|
/**
|
|
1938
|
-
* @public
|
|
1939
2022
|
* <p>The Amazon Chime SDK meeting ID.</p>
|
|
2023
|
+
* @public
|
|
1940
2024
|
*/
|
|
1941
2025
|
MeetingId?: string;
|
|
1942
2026
|
}
|
|
1943
2027
|
/**
|
|
1944
|
-
* @public
|
|
1945
2028
|
* <p>Information required to join the call.</p>
|
|
2029
|
+
* @public
|
|
1946
2030
|
*/
|
|
1947
2031
|
export interface ConnectionData {
|
|
1948
2032
|
/**
|
|
1949
|
-
* @public
|
|
1950
2033
|
* <p>The attendee information, including attendee ID and join token.</p>
|
|
2034
|
+
* @public
|
|
1951
2035
|
*/
|
|
1952
2036
|
Attendee?: Attendee;
|
|
1953
2037
|
/**
|
|
1954
|
-
* @public
|
|
1955
2038
|
* <p>A meeting created using the Amazon Chime SDK.</p>
|
|
2039
|
+
* @public
|
|
1956
2040
|
*/
|
|
1957
2041
|
Meeting?: Meeting;
|
|
1958
2042
|
}
|
|
@@ -1961,40 +2045,40 @@ export interface ConnectionData {
|
|
|
1961
2045
|
*/
|
|
1962
2046
|
export interface StartWebRTCContactResponse {
|
|
1963
2047
|
/**
|
|
1964
|
-
* @public
|
|
1965
2048
|
* <p>Information required for the client application (mobile application or website) to connect
|
|
1966
2049
|
* to the call.</p>
|
|
2050
|
+
* @public
|
|
1967
2051
|
*/
|
|
1968
2052
|
ConnectionData?: ConnectionData;
|
|
1969
2053
|
/**
|
|
1970
|
-
* @public
|
|
1971
2054
|
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
2055
|
+
* @public
|
|
1972
2056
|
*/
|
|
1973
2057
|
ContactId?: string;
|
|
1974
2058
|
/**
|
|
1975
|
-
* @public
|
|
1976
2059
|
* <p>The identifier for a contact participant. The <code>ParticipantId</code> for a contact
|
|
1977
2060
|
* participant is the same throughout the contact lifecycle.</p>
|
|
2061
|
+
* @public
|
|
1978
2062
|
*/
|
|
1979
2063
|
ParticipantId?: string;
|
|
1980
2064
|
/**
|
|
1981
|
-
* @public
|
|
1982
2065
|
* <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
|
|
1983
2066
|
* contact participant.</p>
|
|
2067
|
+
* @public
|
|
1984
2068
|
*/
|
|
1985
2069
|
ParticipantToken?: string;
|
|
1986
2070
|
}
|
|
1987
2071
|
/**
|
|
1988
|
-
* @public
|
|
1989
2072
|
* <p>The contact with the specified ID is not active or does not exist. Applies to Voice calls
|
|
1990
2073
|
* only, not to Chat or Task contacts.</p>
|
|
2074
|
+
* @public
|
|
1991
2075
|
*/
|
|
1992
2076
|
export declare class ContactNotFoundException extends __BaseException {
|
|
1993
2077
|
readonly name: "ContactNotFoundException";
|
|
1994
2078
|
readonly $fault: "client";
|
|
1995
2079
|
/**
|
|
1996
|
-
* @public
|
|
1997
2080
|
* <p>The message.</p>
|
|
2081
|
+
* @public
|
|
1998
2082
|
*/
|
|
1999
2083
|
Message?: string;
|
|
2000
2084
|
/**
|
|
@@ -2003,14 +2087,14 @@ export declare class ContactNotFoundException extends __BaseException {
|
|
|
2003
2087
|
constructor(opts: __ExceptionOptionType<ContactNotFoundException, __BaseException>);
|
|
2004
2088
|
}
|
|
2005
2089
|
/**
|
|
2006
|
-
* @public
|
|
2007
2090
|
* <p>Contains details about why a contact was disconnected. Only Amazon Connect outbound
|
|
2008
2091
|
* campaigns can provide this field.</p>
|
|
2092
|
+
* @public
|
|
2009
2093
|
*/
|
|
2010
2094
|
export interface DisconnectReason {
|
|
2011
2095
|
/**
|
|
2012
|
-
* @public
|
|
2013
2096
|
* <p>A code that indicates how the contact was terminated.</p>
|
|
2097
|
+
* @public
|
|
2014
2098
|
*/
|
|
2015
2099
|
Code?: string;
|
|
2016
2100
|
}
|
|
@@ -2019,19 +2103,19 @@ export interface DisconnectReason {
|
|
|
2019
2103
|
*/
|
|
2020
2104
|
export interface StopContactRequest {
|
|
2021
2105
|
/**
|
|
2022
|
-
* @public
|
|
2023
2106
|
* <p>The ID of the contact.</p>
|
|
2107
|
+
* @public
|
|
2024
2108
|
*/
|
|
2025
2109
|
ContactId: string | undefined;
|
|
2026
2110
|
/**
|
|
2027
|
-
* @public
|
|
2028
2111
|
* <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>
|
|
2112
|
+
* @public
|
|
2029
2113
|
*/
|
|
2030
2114
|
InstanceId: string | undefined;
|
|
2031
2115
|
/**
|
|
2032
|
-
* @public
|
|
2033
2116
|
* <p>The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can
|
|
2034
2117
|
* provide this field.</p>
|
|
2118
|
+
* @public
|
|
2035
2119
|
*/
|
|
2036
2120
|
DisconnectReason?: DisconnectReason;
|
|
2037
2121
|
}
|
|
@@ -2045,19 +2129,19 @@ export interface StopContactResponse {
|
|
|
2045
2129
|
*/
|
|
2046
2130
|
export interface StopContactRecordingRequest {
|
|
2047
2131
|
/**
|
|
2048
|
-
* @public
|
|
2049
2132
|
* <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>
|
|
2133
|
+
* @public
|
|
2050
2134
|
*/
|
|
2051
2135
|
InstanceId: string | undefined;
|
|
2052
2136
|
/**
|
|
2053
|
-
* @public
|
|
2054
2137
|
* <p>The identifier of the contact.</p>
|
|
2138
|
+
* @public
|
|
2055
2139
|
*/
|
|
2056
2140
|
ContactId: string | undefined;
|
|
2057
2141
|
/**
|
|
2058
|
-
* @public
|
|
2059
2142
|
* <p>The identifier of the contact. This is the identifier of the contact associated with the
|
|
2060
2143
|
* first interaction with the contact center.</p>
|
|
2144
|
+
* @public
|
|
2061
2145
|
*/
|
|
2062
2146
|
InitialContactId: string | undefined;
|
|
2063
2147
|
}
|
|
@@ -2071,19 +2155,19 @@ export interface StopContactRecordingResponse {
|
|
|
2071
2155
|
*/
|
|
2072
2156
|
export interface StopContactStreamingRequest {
|
|
2073
2157
|
/**
|
|
2074
|
-
* @public
|
|
2075
2158
|
* <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>
|
|
2159
|
+
* @public
|
|
2076
2160
|
*/
|
|
2077
2161
|
InstanceId: string | undefined;
|
|
2078
2162
|
/**
|
|
2079
|
-
* @public
|
|
2080
2163
|
* <p>The identifier of the contact. This is the identifier of the contact that is associated with
|
|
2081
2164
|
* the first interaction with the contact center.</p>
|
|
2165
|
+
* @public
|
|
2082
2166
|
*/
|
|
2083
2167
|
ContactId: string | undefined;
|
|
2084
2168
|
/**
|
|
2085
|
-
* @public
|
|
2086
2169
|
* <p>The identifier of the streaming configuration enabled. </p>
|
|
2170
|
+
* @public
|
|
2087
2171
|
*/
|
|
2088
2172
|
StreamingId: string | undefined;
|
|
2089
2173
|
}
|
|
@@ -2093,13 +2177,13 @@ export interface StopContactStreamingRequest {
|
|
|
2093
2177
|
export interface StopContactStreamingResponse {
|
|
2094
2178
|
}
|
|
2095
2179
|
/**
|
|
2096
|
-
* @public
|
|
2097
2180
|
* <p>Information about input answers for a contact evaluation.</p>
|
|
2181
|
+
* @public
|
|
2098
2182
|
*/
|
|
2099
2183
|
export interface EvaluationAnswerInput {
|
|
2100
2184
|
/**
|
|
2101
|
-
* @public
|
|
2102
2185
|
* <p>The value for an answer in a contact evaluation.</p>
|
|
2186
|
+
* @public
|
|
2103
2187
|
*/
|
|
2104
2188
|
Value?: EvaluationAnswerData;
|
|
2105
2189
|
}
|
|
@@ -2108,23 +2192,23 @@ export interface EvaluationAnswerInput {
|
|
|
2108
2192
|
*/
|
|
2109
2193
|
export interface SubmitContactEvaluationRequest {
|
|
2110
2194
|
/**
|
|
2111
|
-
* @public
|
|
2112
2195
|
* <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>
|
|
2196
|
+
* @public
|
|
2113
2197
|
*/
|
|
2114
2198
|
InstanceId: string | undefined;
|
|
2115
2199
|
/**
|
|
2116
|
-
* @public
|
|
2117
2200
|
* <p>A unique identifier for the contact evaluation.</p>
|
|
2201
|
+
* @public
|
|
2118
2202
|
*/
|
|
2119
2203
|
EvaluationId: string | undefined;
|
|
2120
2204
|
/**
|
|
2121
|
-
* @public
|
|
2122
2205
|
* <p>A map of question identifiers to answer value.</p>
|
|
2206
|
+
* @public
|
|
2123
2207
|
*/
|
|
2124
2208
|
Answers?: Record<string, EvaluationAnswerInput>;
|
|
2125
2209
|
/**
|
|
2126
|
-
* @public
|
|
2127
2210
|
* <p>A map of question identifiers to note value.</p>
|
|
2211
|
+
* @public
|
|
2128
2212
|
*/
|
|
2129
2213
|
Notes?: Record<string, EvaluationNote>;
|
|
2130
2214
|
}
|
|
@@ -2133,13 +2217,13 @@ export interface SubmitContactEvaluationRequest {
|
|
|
2133
2217
|
*/
|
|
2134
2218
|
export interface SubmitContactEvaluationResponse {
|
|
2135
2219
|
/**
|
|
2136
|
-
* @public
|
|
2137
2220
|
* <p>A unique identifier for the contact evaluation.</p>
|
|
2221
|
+
* @public
|
|
2138
2222
|
*/
|
|
2139
2223
|
EvaluationId: string | undefined;
|
|
2140
2224
|
/**
|
|
2141
|
-
* @public
|
|
2142
2225
|
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
2226
|
+
* @public
|
|
2143
2227
|
*/
|
|
2144
2228
|
EvaluationArn: string | undefined;
|
|
2145
2229
|
}
|
|
@@ -2148,19 +2232,19 @@ export interface SubmitContactEvaluationResponse {
|
|
|
2148
2232
|
*/
|
|
2149
2233
|
export interface SuspendContactRecordingRequest {
|
|
2150
2234
|
/**
|
|
2151
|
-
* @public
|
|
2152
2235
|
* <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>
|
|
2236
|
+
* @public
|
|
2153
2237
|
*/
|
|
2154
2238
|
InstanceId: string | undefined;
|
|
2155
2239
|
/**
|
|
2156
|
-
* @public
|
|
2157
2240
|
* <p>The identifier of the contact.</p>
|
|
2241
|
+
* @public
|
|
2158
2242
|
*/
|
|
2159
2243
|
ContactId: string | undefined;
|
|
2160
2244
|
/**
|
|
2161
|
-
* @public
|
|
2162
2245
|
* <p>The identifier of the contact. This is the identifier of the contact associated with the
|
|
2163
2246
|
* first interaction with the contact center.</p>
|
|
2247
|
+
* @public
|
|
2164
2248
|
*/
|
|
2165
2249
|
InitialContactId: string | undefined;
|
|
2166
2250
|
}
|
|
@@ -2174,22 +2258,22 @@ export interface SuspendContactRecordingResponse {
|
|
|
2174
2258
|
*/
|
|
2175
2259
|
export interface TagContactRequest {
|
|
2176
2260
|
/**
|
|
2177
|
-
* @public
|
|
2178
2261
|
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
2262
|
+
* @public
|
|
2179
2263
|
*/
|
|
2180
2264
|
ContactId: string | undefined;
|
|
2181
2265
|
/**
|
|
2182
|
-
* @public
|
|
2183
2266
|
* <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>
|
|
2267
|
+
* @public
|
|
2184
2268
|
*/
|
|
2185
2269
|
InstanceId: string | undefined;
|
|
2186
2270
|
/**
|
|
2187
|
-
* @public
|
|
2188
2271
|
* <p>The tags to be assigned to the contact resource. For example, \{ "Tags": \{"key1":"value1",
|
|
2189
2272
|
* "key2":"value2"\} \}.</p>
|
|
2190
2273
|
* <note>
|
|
2191
2274
|
* <p>Authorization is not supported by this tag.</p>
|
|
2192
2275
|
* </note>
|
|
2276
|
+
* @public
|
|
2193
2277
|
*/
|
|
2194
2278
|
Tags: Record<string, string> | undefined;
|
|
2195
2279
|
}
|
|
@@ -2203,13 +2287,13 @@ export interface TagContactResponse {
|
|
|
2203
2287
|
*/
|
|
2204
2288
|
export interface TagResourceRequest {
|
|
2205
2289
|
/**
|
|
2206
|
-
* @public
|
|
2207
2290
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
2291
|
+
* @public
|
|
2208
2292
|
*/
|
|
2209
2293
|
resourceArn: string | undefined;
|
|
2210
2294
|
/**
|
|
2211
|
-
* @public
|
|
2212
2295
|
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
2296
|
+
* @public
|
|
2213
2297
|
*/
|
|
2214
2298
|
tags: Record<string, string> | undefined;
|
|
2215
2299
|
}
|
|
@@ -2218,36 +2302,36 @@ export interface TagResourceRequest {
|
|
|
2218
2302
|
*/
|
|
2219
2303
|
export interface TransferContactRequest {
|
|
2220
2304
|
/**
|
|
2221
|
-
* @public
|
|
2222
2305
|
* <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>
|
|
2306
|
+
* @public
|
|
2223
2307
|
*/
|
|
2224
2308
|
InstanceId: string | undefined;
|
|
2225
2309
|
/**
|
|
2226
|
-
* @public
|
|
2227
2310
|
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
2311
|
+
* @public
|
|
2228
2312
|
*/
|
|
2229
2313
|
ContactId: string | undefined;
|
|
2230
2314
|
/**
|
|
2231
|
-
* @public
|
|
2232
2315
|
* <p>The identifier for the queue.</p>
|
|
2316
|
+
* @public
|
|
2233
2317
|
*/
|
|
2234
2318
|
QueueId?: string;
|
|
2235
2319
|
/**
|
|
2236
|
-
* @public
|
|
2237
2320
|
* <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
|
|
2321
|
+
* @public
|
|
2238
2322
|
*/
|
|
2239
2323
|
UserId?: string;
|
|
2240
2324
|
/**
|
|
2241
|
-
* @public
|
|
2242
2325
|
* <p>The identifier of the flow.</p>
|
|
2326
|
+
* @public
|
|
2243
2327
|
*/
|
|
2244
2328
|
ContactFlowId: string | undefined;
|
|
2245
2329
|
/**
|
|
2246
|
-
* @public
|
|
2247
2330
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2248
2331
|
* request. If not provided, the Amazon Web Services
|
|
2249
2332
|
* SDK populates this field. For more information about idempotency, see
|
|
2250
2333
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
2334
|
+
* @public
|
|
2251
2335
|
*/
|
|
2252
2336
|
ClientToken?: string;
|
|
2253
2337
|
}
|
|
@@ -2256,13 +2340,13 @@ export interface TransferContactRequest {
|
|
|
2256
2340
|
*/
|
|
2257
2341
|
export interface TransferContactResponse {
|
|
2258
2342
|
/**
|
|
2259
|
-
* @public
|
|
2260
2343
|
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
2344
|
+
* @public
|
|
2261
2345
|
*/
|
|
2262
2346
|
ContactId?: string;
|
|
2263
2347
|
/**
|
|
2264
|
-
* @public
|
|
2265
2348
|
* <p>The Amazon Resource Name (ARN) of the contact.</p>
|
|
2349
|
+
* @public
|
|
2266
2350
|
*/
|
|
2267
2351
|
ContactArn?: string;
|
|
2268
2352
|
}
|
|
@@ -2271,19 +2355,19 @@ export interface TransferContactResponse {
|
|
|
2271
2355
|
*/
|
|
2272
2356
|
export interface UntagContactRequest {
|
|
2273
2357
|
/**
|
|
2274
|
-
* @public
|
|
2275
2358
|
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
2359
|
+
* @public
|
|
2276
2360
|
*/
|
|
2277
2361
|
ContactId: string | undefined;
|
|
2278
2362
|
/**
|
|
2279
|
-
* @public
|
|
2280
2363
|
* <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>
|
|
2364
|
+
* @public
|
|
2281
2365
|
*/
|
|
2282
2366
|
InstanceId: string | undefined;
|
|
2283
2367
|
/**
|
|
2284
|
-
* @public
|
|
2285
2368
|
* <p>A list of tag keys. Existing tags on the contact whose keys are members of this list will be
|
|
2286
2369
|
* removed.</p>
|
|
2370
|
+
* @public
|
|
2287
2371
|
*/
|
|
2288
2372
|
TagKeys: string[] | undefined;
|
|
2289
2373
|
}
|
|
@@ -2297,13 +2381,13 @@ export interface UntagContactResponse {
|
|
|
2297
2381
|
*/
|
|
2298
2382
|
export interface UntagResourceRequest {
|
|
2299
2383
|
/**
|
|
2300
|
-
* @public
|
|
2301
2384
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
2385
|
+
* @public
|
|
2302
2386
|
*/
|
|
2303
2387
|
resourceArn: string | undefined;
|
|
2304
2388
|
/**
|
|
2305
|
-
* @public
|
|
2306
2389
|
* <p>The tag keys.</p>
|
|
2390
|
+
* @public
|
|
2307
2391
|
*/
|
|
2308
2392
|
tagKeys: string[] | undefined;
|
|
2309
2393
|
}
|
|
@@ -2312,38 +2396,38 @@ export interface UntagResourceRequest {
|
|
|
2312
2396
|
*/
|
|
2313
2397
|
export interface UpdateAgentStatusRequest {
|
|
2314
2398
|
/**
|
|
2315
|
-
* @public
|
|
2316
2399
|
* <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>
|
|
2400
|
+
* @public
|
|
2317
2401
|
*/
|
|
2318
2402
|
InstanceId: string | undefined;
|
|
2319
2403
|
/**
|
|
2320
|
-
* @public
|
|
2321
2404
|
* <p>The identifier of the agent status.</p>
|
|
2405
|
+
* @public
|
|
2322
2406
|
*/
|
|
2323
2407
|
AgentStatusId: string | undefined;
|
|
2324
2408
|
/**
|
|
2325
|
-
* @public
|
|
2326
2409
|
* <p>The name of the agent status.</p>
|
|
2410
|
+
* @public
|
|
2327
2411
|
*/
|
|
2328
2412
|
Name?: string;
|
|
2329
2413
|
/**
|
|
2330
|
-
* @public
|
|
2331
2414
|
* <p>The description of the agent status.</p>
|
|
2415
|
+
* @public
|
|
2332
2416
|
*/
|
|
2333
2417
|
Description?: string;
|
|
2334
2418
|
/**
|
|
2335
|
-
* @public
|
|
2336
2419
|
* <p>The state of the agent status.</p>
|
|
2420
|
+
* @public
|
|
2337
2421
|
*/
|
|
2338
2422
|
State?: AgentStatusState;
|
|
2339
2423
|
/**
|
|
2340
|
-
* @public
|
|
2341
2424
|
* <p>The display order of the agent status.</p>
|
|
2425
|
+
* @public
|
|
2342
2426
|
*/
|
|
2343
2427
|
DisplayOrder?: number;
|
|
2344
2428
|
/**
|
|
2345
|
-
* @public
|
|
2346
2429
|
* <p>A number indicating the reset order of the agent status.</p>
|
|
2430
|
+
* @public
|
|
2347
2431
|
*/
|
|
2348
2432
|
ResetOrderNumber?: boolean;
|
|
2349
2433
|
}
|
|
@@ -2352,29 +2436,29 @@ export interface UpdateAgentStatusRequest {
|
|
|
2352
2436
|
*/
|
|
2353
2437
|
export interface UpdateContactRequest {
|
|
2354
2438
|
/**
|
|
2355
|
-
* @public
|
|
2356
2439
|
* <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>
|
|
2440
|
+
* @public
|
|
2357
2441
|
*/
|
|
2358
2442
|
InstanceId: string | undefined;
|
|
2359
2443
|
/**
|
|
2360
|
-
* @public
|
|
2361
2444
|
* <p>The identifier of the contact. This is the identifier of the contact associated with the
|
|
2362
2445
|
* first interaction with your contact center.</p>
|
|
2446
|
+
* @public
|
|
2363
2447
|
*/
|
|
2364
2448
|
ContactId: string | undefined;
|
|
2365
2449
|
/**
|
|
2366
|
-
* @public
|
|
2367
2450
|
* <p>The name of the contact.</p>
|
|
2451
|
+
* @public
|
|
2368
2452
|
*/
|
|
2369
2453
|
Name?: string;
|
|
2370
2454
|
/**
|
|
2371
|
-
* @public
|
|
2372
2455
|
* <p>The description of the contact.</p>
|
|
2456
|
+
* @public
|
|
2373
2457
|
*/
|
|
2374
2458
|
Description?: string;
|
|
2375
2459
|
/**
|
|
2376
|
-
* @public
|
|
2377
2460
|
* <p>Well-formed data on contact, shown to agents on Contact Control Panel (CCP).</p>
|
|
2461
|
+
* @public
|
|
2378
2462
|
*/
|
|
2379
2463
|
References?: Record<string, Reference>;
|
|
2380
2464
|
}
|
|
@@ -2388,22 +2472,22 @@ export interface UpdateContactResponse {
|
|
|
2388
2472
|
*/
|
|
2389
2473
|
export interface UpdateContactAttributesRequest {
|
|
2390
2474
|
/**
|
|
2391
|
-
* @public
|
|
2392
2475
|
* <p>The identifier of the contact. This is the identifier of the contact associated with the
|
|
2393
2476
|
* first interaction with the contact center.</p>
|
|
2477
|
+
* @public
|
|
2394
2478
|
*/
|
|
2395
2479
|
InitialContactId: string | undefined;
|
|
2396
2480
|
/**
|
|
2397
|
-
* @public
|
|
2398
2481
|
* <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>
|
|
2482
|
+
* @public
|
|
2399
2483
|
*/
|
|
2400
2484
|
InstanceId: string | undefined;
|
|
2401
2485
|
/**
|
|
2402
|
-
* @public
|
|
2403
2486
|
* <p>The Amazon Connect attributes. These attributes can be accessed in flows just like any
|
|
2404
2487
|
* other contact attributes.</p>
|
|
2405
2488
|
* <p>You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys
|
|
2406
2489
|
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
2490
|
+
* @public
|
|
2407
2491
|
*/
|
|
2408
2492
|
Attributes: Record<string, string> | undefined;
|
|
2409
2493
|
}
|
|
@@ -2417,23 +2501,23 @@ export interface UpdateContactAttributesResponse {
|
|
|
2417
2501
|
*/
|
|
2418
2502
|
export interface UpdateContactEvaluationRequest {
|
|
2419
2503
|
/**
|
|
2420
|
-
* @public
|
|
2421
2504
|
* <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>
|
|
2505
|
+
* @public
|
|
2422
2506
|
*/
|
|
2423
2507
|
InstanceId: string | undefined;
|
|
2424
2508
|
/**
|
|
2425
|
-
* @public
|
|
2426
2509
|
* <p>A unique identifier for the contact evaluation.</p>
|
|
2510
|
+
* @public
|
|
2427
2511
|
*/
|
|
2428
2512
|
EvaluationId: string | undefined;
|
|
2429
2513
|
/**
|
|
2430
|
-
* @public
|
|
2431
2514
|
* <p>A map of question identifiers to answer value.</p>
|
|
2515
|
+
* @public
|
|
2432
2516
|
*/
|
|
2433
2517
|
Answers?: Record<string, EvaluationAnswerInput>;
|
|
2434
2518
|
/**
|
|
2435
|
-
* @public
|
|
2436
2519
|
* <p>A map of question identifiers to note value.</p>
|
|
2520
|
+
* @public
|
|
2437
2521
|
*/
|
|
2438
2522
|
Notes?: Record<string, EvaluationNote>;
|
|
2439
2523
|
}
|
|
@@ -2442,13 +2526,13 @@ export interface UpdateContactEvaluationRequest {
|
|
|
2442
2526
|
*/
|
|
2443
2527
|
export interface UpdateContactEvaluationResponse {
|
|
2444
2528
|
/**
|
|
2445
|
-
* @public
|
|
2446
2529
|
* <p>A unique identifier for the contact evaluation.</p>
|
|
2530
|
+
* @public
|
|
2447
2531
|
*/
|
|
2448
2532
|
EvaluationId: string | undefined;
|
|
2449
2533
|
/**
|
|
2450
|
-
* @public
|
|
2451
2534
|
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
2535
|
+
* @public
|
|
2452
2536
|
*/
|
|
2453
2537
|
EvaluationArn: string | undefined;
|
|
2454
2538
|
}
|
|
@@ -2457,20 +2541,20 @@ export interface UpdateContactEvaluationResponse {
|
|
|
2457
2541
|
*/
|
|
2458
2542
|
export interface UpdateContactFlowContentRequest {
|
|
2459
2543
|
/**
|
|
2460
|
-
* @public
|
|
2461
2544
|
* <p>The identifier of the Amazon Connect instance.</p>
|
|
2545
|
+
* @public
|
|
2462
2546
|
*/
|
|
2463
2547
|
InstanceId: string | undefined;
|
|
2464
2548
|
/**
|
|
2465
|
-
* @public
|
|
2466
2549
|
* <p>The identifier of the flow.</p>
|
|
2550
|
+
* @public
|
|
2467
2551
|
*/
|
|
2468
2552
|
ContactFlowId: string | undefined;
|
|
2469
2553
|
/**
|
|
2470
|
-
* @public
|
|
2471
2554
|
* <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
|
|
2472
2555
|
* flow in Amazon Connect Flow language</a>. </p>
|
|
2473
2556
|
* <p>Length Constraints: Minimum length of 1. Maximum length of 256000.</p>
|
|
2557
|
+
* @public
|
|
2474
2558
|
*/
|
|
2475
2559
|
Content: string | undefined;
|
|
2476
2560
|
}
|
|
@@ -2484,28 +2568,28 @@ export interface UpdateContactFlowContentResponse {
|
|
|
2484
2568
|
*/
|
|
2485
2569
|
export interface UpdateContactFlowMetadataRequest {
|
|
2486
2570
|
/**
|
|
2487
|
-
* @public
|
|
2488
2571
|
* <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>
|
|
2572
|
+
* @public
|
|
2489
2573
|
*/
|
|
2490
2574
|
InstanceId: string | undefined;
|
|
2491
2575
|
/**
|
|
2492
|
-
* @public
|
|
2493
2576
|
* <p>The identifier of the flow.</p>
|
|
2577
|
+
* @public
|
|
2494
2578
|
*/
|
|
2495
2579
|
ContactFlowId: string | undefined;
|
|
2496
2580
|
/**
|
|
2497
|
-
* @public
|
|
2498
2581
|
* <p>The name of the flow.</p>
|
|
2582
|
+
* @public
|
|
2499
2583
|
*/
|
|
2500
2584
|
Name?: string;
|
|
2501
2585
|
/**
|
|
2502
|
-
* @public
|
|
2503
2586
|
* <p>The description of the flow.</p>
|
|
2587
|
+
* @public
|
|
2504
2588
|
*/
|
|
2505
2589
|
Description?: string;
|
|
2506
2590
|
/**
|
|
2507
|
-
* @public
|
|
2508
2591
|
* <p>The state of flow.</p>
|
|
2592
|
+
* @public
|
|
2509
2593
|
*/
|
|
2510
2594
|
ContactFlowState?: ContactFlowState;
|
|
2511
2595
|
}
|
|
@@ -2519,19 +2603,19 @@ export interface UpdateContactFlowMetadataResponse {
|
|
|
2519
2603
|
*/
|
|
2520
2604
|
export interface UpdateContactFlowModuleContentRequest {
|
|
2521
2605
|
/**
|
|
2522
|
-
* @public
|
|
2523
2606
|
* <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>
|
|
2607
|
+
* @public
|
|
2524
2608
|
*/
|
|
2525
2609
|
InstanceId: string | undefined;
|
|
2526
2610
|
/**
|
|
2527
|
-
* @public
|
|
2528
2611
|
* <p>The identifier of the flow module.</p>
|
|
2612
|
+
* @public
|
|
2529
2613
|
*/
|
|
2530
2614
|
ContactFlowModuleId: string | undefined;
|
|
2531
2615
|
/**
|
|
2532
|
-
* @public
|
|
2533
2616
|
* <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
|
|
2534
2617
|
* flow in Amazon Connect Flow language</a>. </p>
|
|
2618
|
+
* @public
|
|
2535
2619
|
*/
|
|
2536
2620
|
Content: string | undefined;
|
|
2537
2621
|
}
|
|
@@ -2545,28 +2629,28 @@ export interface UpdateContactFlowModuleContentResponse {
|
|
|
2545
2629
|
*/
|
|
2546
2630
|
export interface UpdateContactFlowModuleMetadataRequest {
|
|
2547
2631
|
/**
|
|
2548
|
-
* @public
|
|
2549
2632
|
* <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>
|
|
2633
|
+
* @public
|
|
2550
2634
|
*/
|
|
2551
2635
|
InstanceId: string | undefined;
|
|
2552
2636
|
/**
|
|
2553
|
-
* @public
|
|
2554
2637
|
* <p>The identifier of the flow module.</p>
|
|
2638
|
+
* @public
|
|
2555
2639
|
*/
|
|
2556
2640
|
ContactFlowModuleId: string | undefined;
|
|
2557
2641
|
/**
|
|
2558
|
-
* @public
|
|
2559
2642
|
* <p>The name of the flow module.</p>
|
|
2643
|
+
* @public
|
|
2560
2644
|
*/
|
|
2561
2645
|
Name?: string;
|
|
2562
2646
|
/**
|
|
2563
|
-
* @public
|
|
2564
2647
|
* <p>The description of the flow module.</p>
|
|
2648
|
+
* @public
|
|
2565
2649
|
*/
|
|
2566
2650
|
Description?: string;
|
|
2567
2651
|
/**
|
|
2568
|
-
* @public
|
|
2569
2652
|
* <p>The state of flow module.</p>
|
|
2653
|
+
* @public
|
|
2570
2654
|
*/
|
|
2571
2655
|
State?: ContactFlowModuleState;
|
|
2572
2656
|
}
|
|
@@ -2580,23 +2664,23 @@ export interface UpdateContactFlowModuleMetadataResponse {
|
|
|
2580
2664
|
*/
|
|
2581
2665
|
export interface UpdateContactFlowNameRequest {
|
|
2582
2666
|
/**
|
|
2583
|
-
* @public
|
|
2584
2667
|
* <p>The identifier of the Amazon Connect instance.</p>
|
|
2668
|
+
* @public
|
|
2585
2669
|
*/
|
|
2586
2670
|
InstanceId: string | undefined;
|
|
2587
2671
|
/**
|
|
2588
|
-
* @public
|
|
2589
2672
|
* <p>The identifier of the flow.</p>
|
|
2673
|
+
* @public
|
|
2590
2674
|
*/
|
|
2591
2675
|
ContactFlowId: string | undefined;
|
|
2592
2676
|
/**
|
|
2593
|
-
* @public
|
|
2594
2677
|
* <p>The name of the flow.</p>
|
|
2678
|
+
* @public
|
|
2595
2679
|
*/
|
|
2596
2680
|
Name?: string;
|
|
2597
2681
|
/**
|
|
2598
|
-
* @public
|
|
2599
2682
|
* <p>The description of the flow.</p>
|
|
2683
|
+
* @public
|
|
2600
2684
|
*/
|
|
2601
2685
|
Description?: string;
|
|
2602
2686
|
}
|
|
@@ -2610,27 +2694,27 @@ export interface UpdateContactFlowNameResponse {
|
|
|
2610
2694
|
*/
|
|
2611
2695
|
export interface UpdateContactRoutingDataRequest {
|
|
2612
2696
|
/**
|
|
2613
|
-
* @public
|
|
2614
2697
|
* <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>
|
|
2698
|
+
* @public
|
|
2615
2699
|
*/
|
|
2616
2700
|
InstanceId: string | undefined;
|
|
2617
2701
|
/**
|
|
2618
|
-
* @public
|
|
2619
2702
|
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
2703
|
+
* @public
|
|
2620
2704
|
*/
|
|
2621
2705
|
ContactId: string | undefined;
|
|
2622
2706
|
/**
|
|
2623
|
-
* @public
|
|
2624
2707
|
* <p>The number of seconds to add or subtract from the contact's routing age. Contacts are routed
|
|
2625
2708
|
* to agents on a first-come, first-serve basis. This means that changing their amount of time in
|
|
2626
2709
|
* queue compared to others also changes their position in queue.</p>
|
|
2710
|
+
* @public
|
|
2627
2711
|
*/
|
|
2628
2712
|
QueueTimeAdjustmentSeconds?: number;
|
|
2629
2713
|
/**
|
|
2630
|
-
* @public
|
|
2631
2714
|
* <p>Priority of the contact in the queue. The default priority for new contacts is 5. You can
|
|
2632
2715
|
* raise the priority of a contact compared to other contacts in the queue by assigning them a
|
|
2633
2716
|
* higher priority, such as 1 or 2.</p>
|
|
2717
|
+
* @public
|
|
2634
2718
|
*/
|
|
2635
2719
|
QueuePriority?: number;
|
|
2636
2720
|
}
|
|
@@ -2644,18 +2728,18 @@ export interface UpdateContactRoutingDataResponse {
|
|
|
2644
2728
|
*/
|
|
2645
2729
|
export interface UpdateContactScheduleRequest {
|
|
2646
2730
|
/**
|
|
2647
|
-
* @public
|
|
2648
2731
|
* <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>
|
|
2732
|
+
* @public
|
|
2649
2733
|
*/
|
|
2650
2734
|
InstanceId: string | undefined;
|
|
2651
2735
|
/**
|
|
2652
|
-
* @public
|
|
2653
2736
|
* <p>The identifier of the contact.</p>
|
|
2737
|
+
* @public
|
|
2654
2738
|
*/
|
|
2655
2739
|
ContactId: string | undefined;
|
|
2656
2740
|
/**
|
|
2657
|
-
* @public
|
|
2658
2741
|
* <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>
|
|
2742
|
+
* @public
|
|
2659
2743
|
*/
|
|
2660
2744
|
ScheduledTime: Date | undefined;
|
|
2661
2745
|
}
|
|
@@ -2669,18 +2753,18 @@ export interface UpdateContactScheduleResponse {
|
|
|
2669
2753
|
*/
|
|
2670
2754
|
export interface UpdateEvaluationFormResponse {
|
|
2671
2755
|
/**
|
|
2672
|
-
* @public
|
|
2673
2756
|
* <p>The unique identifier for the evaluation form.</p>
|
|
2757
|
+
* @public
|
|
2674
2758
|
*/
|
|
2675
2759
|
EvaluationFormId: string | undefined;
|
|
2676
2760
|
/**
|
|
2677
|
-
* @public
|
|
2678
2761
|
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
2762
|
+
* @public
|
|
2679
2763
|
*/
|
|
2680
2764
|
EvaluationFormArn: string | undefined;
|
|
2681
2765
|
/**
|
|
2682
|
-
* @public
|
|
2683
2766
|
* <p>The version of the updated evaluation form resource.</p>
|
|
2767
|
+
* @public
|
|
2684
2768
|
*/
|
|
2685
2769
|
EvaluationFormVersion: number | undefined;
|
|
2686
2770
|
}
|
|
@@ -2689,33 +2773,33 @@ export interface UpdateEvaluationFormResponse {
|
|
|
2689
2773
|
*/
|
|
2690
2774
|
export interface UpdateHoursOfOperationRequest {
|
|
2691
2775
|
/**
|
|
2692
|
-
* @public
|
|
2693
2776
|
* <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>
|
|
2777
|
+
* @public
|
|
2694
2778
|
*/
|
|
2695
2779
|
InstanceId: string | undefined;
|
|
2696
2780
|
/**
|
|
2697
|
-
* @public
|
|
2698
2781
|
* <p>The identifier of the hours of operation.</p>
|
|
2782
|
+
* @public
|
|
2699
2783
|
*/
|
|
2700
2784
|
HoursOfOperationId: string | undefined;
|
|
2701
2785
|
/**
|
|
2702
|
-
* @public
|
|
2703
2786
|
* <p>The name of the hours of operation.</p>
|
|
2787
|
+
* @public
|
|
2704
2788
|
*/
|
|
2705
2789
|
Name?: string;
|
|
2706
2790
|
/**
|
|
2707
|
-
* @public
|
|
2708
2791
|
* <p>The description of the hours of operation.</p>
|
|
2792
|
+
* @public
|
|
2709
2793
|
*/
|
|
2710
2794
|
Description?: string;
|
|
2711
2795
|
/**
|
|
2712
|
-
* @public
|
|
2713
2796
|
* <p>The time zone of the hours of operation.</p>
|
|
2797
|
+
* @public
|
|
2714
2798
|
*/
|
|
2715
2799
|
TimeZone?: string;
|
|
2716
2800
|
/**
|
|
2717
|
-
* @public
|
|
2718
2801
|
* <p>Configuration information of the hours of operation.</p>
|
|
2802
|
+
* @public
|
|
2719
2803
|
*/
|
|
2720
2804
|
Config?: HoursOfOperationConfig[];
|
|
2721
2805
|
}
|
|
@@ -2724,22 +2808,22 @@ export interface UpdateHoursOfOperationRequest {
|
|
|
2724
2808
|
*/
|
|
2725
2809
|
export interface UpdateInstanceAttributeRequest {
|
|
2726
2810
|
/**
|
|
2727
|
-
* @public
|
|
2728
2811
|
* <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>
|
|
2812
|
+
* @public
|
|
2729
2813
|
*/
|
|
2730
2814
|
InstanceId: string | undefined;
|
|
2731
2815
|
/**
|
|
2732
|
-
* @public
|
|
2733
2816
|
* <p>The type of attribute.</p>
|
|
2734
2817
|
* <note>
|
|
2735
2818
|
* <p>Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature,
|
|
2736
2819
|
* contact Amazon Web Services Support for allowlisting.</p>
|
|
2737
2820
|
* </note>
|
|
2821
|
+
* @public
|
|
2738
2822
|
*/
|
|
2739
2823
|
AttributeType: InstanceAttributeType | undefined;
|
|
2740
2824
|
/**
|
|
2741
|
-
* @public
|
|
2742
2825
|
* <p>The value for the attribute. Maximum character limit is 100. </p>
|
|
2826
|
+
* @public
|
|
2743
2827
|
*/
|
|
2744
2828
|
Value: string | undefined;
|
|
2745
2829
|
}
|
|
@@ -2748,23 +2832,23 @@ export interface UpdateInstanceAttributeRequest {
|
|
|
2748
2832
|
*/
|
|
2749
2833
|
export interface UpdateInstanceStorageConfigRequest {
|
|
2750
2834
|
/**
|
|
2751
|
-
* @public
|
|
2752
2835
|
* <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>
|
|
2836
|
+
* @public
|
|
2753
2837
|
*/
|
|
2754
2838
|
InstanceId: string | undefined;
|
|
2755
2839
|
/**
|
|
2756
|
-
* @public
|
|
2757
2840
|
* <p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>
|
|
2841
|
+
* @public
|
|
2758
2842
|
*/
|
|
2759
2843
|
AssociationId: string | undefined;
|
|
2760
2844
|
/**
|
|
2761
|
-
* @public
|
|
2762
2845
|
* <p>A valid resource type.</p>
|
|
2846
|
+
* @public
|
|
2763
2847
|
*/
|
|
2764
2848
|
ResourceType: InstanceStorageResourceType | undefined;
|
|
2765
2849
|
/**
|
|
2766
|
-
* @public
|
|
2767
2850
|
* <p>The storage configuration for the instance.</p>
|
|
2851
|
+
* @public
|
|
2768
2852
|
*/
|
|
2769
2853
|
StorageConfig: InstanceStorageConfig | undefined;
|
|
2770
2854
|
}
|
|
@@ -2804,11 +2888,11 @@ export declare const ParticipantTimerAction: {
|
|
|
2804
2888
|
*/
|
|
2805
2889
|
export type ParticipantTimerAction = (typeof ParticipantTimerAction)[keyof typeof ParticipantTimerAction];
|
|
2806
2890
|
/**
|
|
2807
|
-
* @public
|
|
2808
2891
|
* <p>The value of the timer. Either the timer action (<code>Unset</code> to delete the timer), or
|
|
2809
2892
|
* the duration of the timer in minutes. Only one value can be set.</p>
|
|
2810
2893
|
* <p>For more information about how chat timeouts work, see
|
|
2811
2894
|
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html">Set up chat timeouts for human participants</a>. </p>
|
|
2895
|
+
* @public
|
|
2812
2896
|
*/
|
|
2813
2897
|
export type ParticipantTimerValue = ParticipantTimerValue.ParticipantTimerActionMember | ParticipantTimerValue.ParticipantTimerDurationInMinutesMember | ParticipantTimerValue.$UnknownMember;
|
|
2814
2898
|
/**
|
|
@@ -2816,9 +2900,9 @@ export type ParticipantTimerValue = ParticipantTimerValue.ParticipantTimerAction
|
|
|
2816
2900
|
*/
|
|
2817
2901
|
export declare namespace ParticipantTimerValue {
|
|
2818
2902
|
/**
|
|
2819
|
-
* @public
|
|
2820
2903
|
* <p>The timer action. Currently only one value is allowed: <code>Unset</code>. It deletes a
|
|
2821
2904
|
* timer.</p>
|
|
2905
|
+
* @public
|
|
2822
2906
|
*/
|
|
2823
2907
|
interface ParticipantTimerActionMember {
|
|
2824
2908
|
ParticipantTimerAction: ParticipantTimerAction;
|
|
@@ -2826,8 +2910,8 @@ export declare namespace ParticipantTimerValue {
|
|
|
2826
2910
|
$unknown?: never;
|
|
2827
2911
|
}
|
|
2828
2912
|
/**
|
|
2829
|
-
* @public
|
|
2830
2913
|
* <p>The duration of a timer, in minutes. </p>
|
|
2914
|
+
* @public
|
|
2831
2915
|
*/
|
|
2832
2916
|
interface ParticipantTimerDurationInMinutesMember {
|
|
2833
2917
|
ParticipantTimerAction?: never;
|
|
@@ -2850,48 +2934,48 @@ export declare namespace ParticipantTimerValue {
|
|
|
2850
2934
|
const visit: <T>(value: ParticipantTimerValue, visitor: Visitor<T>) => T;
|
|
2851
2935
|
}
|
|
2852
2936
|
/**
|
|
2853
|
-
* @public
|
|
2854
2937
|
* <p>Configuration information for the timer. After the timer configuration is set, it persists
|
|
2855
2938
|
* for the duration of the chat. It persists across new contacts in the chain, for example, transfer
|
|
2856
2939
|
* contacts.</p>
|
|
2857
2940
|
* <p>For more information about how chat timeouts work, see
|
|
2858
2941
|
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html">Set up chat timeouts for human participants</a>. </p>
|
|
2942
|
+
* @public
|
|
2859
2943
|
*/
|
|
2860
2944
|
export interface ParticipantTimerConfiguration {
|
|
2861
2945
|
/**
|
|
2862
|
-
* @public
|
|
2863
2946
|
* <p>The role of the participant in the chat conversation.</p>
|
|
2947
|
+
* @public
|
|
2864
2948
|
*/
|
|
2865
2949
|
ParticipantRole: TimerEligibleParticipantRoles | undefined;
|
|
2866
2950
|
/**
|
|
2867
|
-
* @public
|
|
2868
2951
|
* <p>The type of timer. <code>IDLE</code> indicates the timer applies for considering a human
|
|
2869
2952
|
* chat participant as idle. <code>DISCONNECT_NONCUSTOMER</code> indicates the timer applies to
|
|
2870
2953
|
* automatically disconnecting a chat participant due to idleness.</p>
|
|
2954
|
+
* @public
|
|
2871
2955
|
*/
|
|
2872
2956
|
TimerType: ParticipantTimerType | undefined;
|
|
2873
2957
|
/**
|
|
2874
|
-
* @public
|
|
2875
2958
|
* <p>The value of the timer. Either the timer action (Unset to delete the timer), or the duration
|
|
2876
2959
|
* of the timer in minutes. Only one value can be set.</p>
|
|
2960
|
+
* @public
|
|
2877
2961
|
*/
|
|
2878
2962
|
TimerValue: ParticipantTimerValue | undefined;
|
|
2879
2963
|
}
|
|
2880
2964
|
/**
|
|
2881
|
-
* @public
|
|
2882
2965
|
* <p>Configuration information for the chat participant role.</p>
|
|
2966
|
+
* @public
|
|
2883
2967
|
*/
|
|
2884
2968
|
export interface ChatParticipantRoleConfig {
|
|
2885
2969
|
/**
|
|
2886
|
-
* @public
|
|
2887
2970
|
* <p>A list of participant timers. You can specify any unique combination of role and timer type.
|
|
2888
2971
|
* Duplicate entries error out the request with a 400.</p>
|
|
2972
|
+
* @public
|
|
2889
2973
|
*/
|
|
2890
2974
|
ParticipantTimerConfigList: ParticipantTimerConfiguration[] | undefined;
|
|
2891
2975
|
}
|
|
2892
2976
|
/**
|
|
2893
|
-
* @public
|
|
2894
2977
|
* <p>Configuration information for the chat participant role.</p>
|
|
2978
|
+
* @public
|
|
2895
2979
|
*/
|
|
2896
2980
|
export type UpdateParticipantRoleConfigChannelInfo = UpdateParticipantRoleConfigChannelInfo.ChatMember | UpdateParticipantRoleConfigChannelInfo.$UnknownMember;
|
|
2897
2981
|
/**
|
|
@@ -2899,8 +2983,8 @@ export type UpdateParticipantRoleConfigChannelInfo = UpdateParticipantRoleConfig
|
|
|
2899
2983
|
*/
|
|
2900
2984
|
export declare namespace UpdateParticipantRoleConfigChannelInfo {
|
|
2901
2985
|
/**
|
|
2902
|
-
* @public
|
|
2903
2986
|
* <p>Configuration information for the chat participant role.</p>
|
|
2987
|
+
* @public
|
|
2904
2988
|
*/
|
|
2905
2989
|
interface ChatMember {
|
|
2906
2990
|
Chat: ChatParticipantRoleConfig;
|
|
@@ -2924,18 +3008,18 @@ export declare namespace UpdateParticipantRoleConfigChannelInfo {
|
|
|
2924
3008
|
*/
|
|
2925
3009
|
export interface UpdateParticipantRoleConfigRequest {
|
|
2926
3010
|
/**
|
|
2927
|
-
* @public
|
|
2928
3011
|
* <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>
|
|
3012
|
+
* @public
|
|
2929
3013
|
*/
|
|
2930
3014
|
InstanceId: string | undefined;
|
|
2931
3015
|
/**
|
|
2932
|
-
* @public
|
|
2933
3016
|
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
3017
|
+
* @public
|
|
2934
3018
|
*/
|
|
2935
3019
|
ContactId: string | undefined;
|
|
2936
3020
|
/**
|
|
2937
|
-
* @public
|
|
2938
3021
|
* <p>The Amazon Connect channel you want to configure.</p>
|
|
3022
|
+
* @public
|
|
2939
3023
|
*/
|
|
2940
3024
|
ChannelConfiguration: UpdateParticipantRoleConfigChannelInfo | undefined;
|
|
2941
3025
|
}
|
|
@@ -2949,28 +3033,28 @@ export interface UpdateParticipantRoleConfigResponse {
|
|
|
2949
3033
|
*/
|
|
2950
3034
|
export interface UpdatePhoneNumberRequest {
|
|
2951
3035
|
/**
|
|
2952
|
-
* @public
|
|
2953
3036
|
* <p>A unique identifier for the phone number.</p>
|
|
3037
|
+
* @public
|
|
2954
3038
|
*/
|
|
2955
3039
|
PhoneNumberId: string | undefined;
|
|
2956
3040
|
/**
|
|
2957
|
-
* @public
|
|
2958
3041
|
* <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>
|
|
3042
|
+
* @public
|
|
2959
3043
|
*/
|
|
2960
3044
|
TargetArn?: string;
|
|
2961
3045
|
/**
|
|
2962
|
-
* @public
|
|
2963
3046
|
* <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You
|
|
2964
3047
|
* can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
|
|
2965
3048
|
* instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
|
|
3049
|
+
* @public
|
|
2966
3050
|
*/
|
|
2967
3051
|
InstanceId?: string;
|
|
2968
3052
|
/**
|
|
2969
|
-
* @public
|
|
2970
3053
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2971
3054
|
* request. If not provided, the Amazon Web Services
|
|
2972
3055
|
* SDK populates this field. For more information about idempotency, see
|
|
2973
3056
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
3057
|
+
* @public
|
|
2974
3058
|
*/
|
|
2975
3059
|
ClientToken?: string;
|
|
2976
3060
|
}
|
|
@@ -2979,13 +3063,13 @@ export interface UpdatePhoneNumberRequest {
|
|
|
2979
3063
|
*/
|
|
2980
3064
|
export interface UpdatePhoneNumberResponse {
|
|
2981
3065
|
/**
|
|
2982
|
-
* @public
|
|
2983
3066
|
* <p>A unique identifier for the phone number.</p>
|
|
3067
|
+
* @public
|
|
2984
3068
|
*/
|
|
2985
3069
|
PhoneNumberId?: string;
|
|
2986
3070
|
/**
|
|
2987
|
-
* @public
|
|
2988
3071
|
* <p>The Amazon Resource Name (ARN) of the phone number.</p>
|
|
3072
|
+
* @public
|
|
2989
3073
|
*/
|
|
2990
3074
|
PhoneNumberArn?: string;
|
|
2991
3075
|
}
|
|
@@ -2994,21 +3078,21 @@ export interface UpdatePhoneNumberResponse {
|
|
|
2994
3078
|
*/
|
|
2995
3079
|
export interface UpdatePhoneNumberMetadataRequest {
|
|
2996
3080
|
/**
|
|
2997
|
-
* @public
|
|
2998
3081
|
* <p>The Amazon Resource Name (ARN) or resource ID of the phone number.</p>
|
|
3082
|
+
* @public
|
|
2999
3083
|
*/
|
|
3000
3084
|
PhoneNumberId: string | undefined;
|
|
3001
3085
|
/**
|
|
3002
|
-
* @public
|
|
3003
3086
|
* <p>The description of the phone number.</p>
|
|
3087
|
+
* @public
|
|
3004
3088
|
*/
|
|
3005
3089
|
PhoneNumberDescription?: string;
|
|
3006
3090
|
/**
|
|
3007
|
-
* @public
|
|
3008
3091
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3009
3092
|
* request. If not provided, the Amazon Web Services
|
|
3010
3093
|
* SDK populates this field. For more information about idempotency, see
|
|
3011
3094
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
3095
|
+
* @public
|
|
3012
3096
|
*/
|
|
3013
3097
|
ClientToken?: string;
|
|
3014
3098
|
}
|
|
@@ -3017,19 +3101,19 @@ export interface UpdatePhoneNumberMetadataRequest {
|
|
|
3017
3101
|
*/
|
|
3018
3102
|
export interface UpdatePredefinedAttributeRequest {
|
|
3019
3103
|
/**
|
|
3020
|
-
* @public
|
|
3021
3104
|
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
|
|
3022
3105
|
* Name (ARN) of the instance.</p>
|
|
3106
|
+
* @public
|
|
3023
3107
|
*/
|
|
3024
3108
|
InstanceId: string | undefined;
|
|
3025
3109
|
/**
|
|
3026
|
-
* @public
|
|
3027
3110
|
* <p>The name of the predefined attribute.</p>
|
|
3111
|
+
* @public
|
|
3028
3112
|
*/
|
|
3029
3113
|
Name: string | undefined;
|
|
3030
3114
|
/**
|
|
3031
|
-
* @public
|
|
3032
3115
|
* <p>The values of the predefined attribute.</p>
|
|
3116
|
+
* @public
|
|
3033
3117
|
*/
|
|
3034
3118
|
Values?: PredefinedAttributeValues;
|
|
3035
3119
|
}
|
|
@@ -3038,30 +3122,30 @@ export interface UpdatePredefinedAttributeRequest {
|
|
|
3038
3122
|
*/
|
|
3039
3123
|
export interface UpdatePromptRequest {
|
|
3040
3124
|
/**
|
|
3041
|
-
* @public
|
|
3042
3125
|
* <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>
|
|
3126
|
+
* @public
|
|
3043
3127
|
*/
|
|
3044
3128
|
InstanceId: string | undefined;
|
|
3045
3129
|
/**
|
|
3046
|
-
* @public
|
|
3047
3130
|
* <p>A unique identifier for the prompt.</p>
|
|
3131
|
+
* @public
|
|
3048
3132
|
*/
|
|
3049
3133
|
PromptId: string | undefined;
|
|
3050
3134
|
/**
|
|
3051
|
-
* @public
|
|
3052
3135
|
* <p>The name of the prompt.</p>
|
|
3136
|
+
* @public
|
|
3053
3137
|
*/
|
|
3054
3138
|
Name?: string;
|
|
3055
3139
|
/**
|
|
3056
|
-
* @public
|
|
3057
3140
|
* <p>A description of the prompt.</p>
|
|
3141
|
+
* @public
|
|
3058
3142
|
*/
|
|
3059
3143
|
Description?: string;
|
|
3060
3144
|
/**
|
|
3061
|
-
* @public
|
|
3062
3145
|
* <p>The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the
|
|
3063
3146
|
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html">GetPromptFile</a>
|
|
3064
3147
|
* API instead of providing S3 URIs.</p>
|
|
3148
|
+
* @public
|
|
3065
3149
|
*/
|
|
3066
3150
|
S3Uri?: string;
|
|
3067
3151
|
}
|
|
@@ -3070,13 +3154,13 @@ export interface UpdatePromptRequest {
|
|
|
3070
3154
|
*/
|
|
3071
3155
|
export interface UpdatePromptResponse {
|
|
3072
3156
|
/**
|
|
3073
|
-
* @public
|
|
3074
3157
|
* <p>The Amazon Resource Name (ARN) of the prompt.</p>
|
|
3158
|
+
* @public
|
|
3075
3159
|
*/
|
|
3076
3160
|
PromptARN?: string;
|
|
3077
3161
|
/**
|
|
3078
|
-
* @public
|
|
3079
3162
|
* <p>A unique identifier for the prompt.</p>
|
|
3163
|
+
* @public
|
|
3080
3164
|
*/
|
|
3081
3165
|
PromptId?: string;
|
|
3082
3166
|
}
|
|
@@ -3085,18 +3169,18 @@ export interface UpdatePromptResponse {
|
|
|
3085
3169
|
*/
|
|
3086
3170
|
export interface UpdateQueueHoursOfOperationRequest {
|
|
3087
3171
|
/**
|
|
3088
|
-
* @public
|
|
3089
3172
|
* <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>
|
|
3173
|
+
* @public
|
|
3090
3174
|
*/
|
|
3091
3175
|
InstanceId: string | undefined;
|
|
3092
3176
|
/**
|
|
3093
|
-
* @public
|
|
3094
3177
|
* <p>The identifier for the queue.</p>
|
|
3178
|
+
* @public
|
|
3095
3179
|
*/
|
|
3096
3180
|
QueueId: string | undefined;
|
|
3097
3181
|
/**
|
|
3098
|
-
* @public
|
|
3099
3182
|
* <p>The identifier for the hours of operation.</p>
|
|
3183
|
+
* @public
|
|
3100
3184
|
*/
|
|
3101
3185
|
HoursOfOperationId: string | undefined;
|
|
3102
3186
|
}
|
|
@@ -3105,18 +3189,18 @@ export interface UpdateQueueHoursOfOperationRequest {
|
|
|
3105
3189
|
*/
|
|
3106
3190
|
export interface UpdateQueueMaxContactsRequest {
|
|
3107
3191
|
/**
|
|
3108
|
-
* @public
|
|
3109
3192
|
* <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>
|
|
3193
|
+
* @public
|
|
3110
3194
|
*/
|
|
3111
3195
|
InstanceId: string | undefined;
|
|
3112
3196
|
/**
|
|
3113
|
-
* @public
|
|
3114
3197
|
* <p>The identifier for the queue.</p>
|
|
3198
|
+
* @public
|
|
3115
3199
|
*/
|
|
3116
3200
|
QueueId: string | undefined;
|
|
3117
3201
|
/**
|
|
3118
|
-
* @public
|
|
3119
3202
|
* <p>The maximum number of contacts that can be in the queue before it is considered full.</p>
|
|
3203
|
+
* @public
|
|
3120
3204
|
*/
|
|
3121
3205
|
MaxContacts?: number;
|
|
3122
3206
|
}
|
|
@@ -3125,23 +3209,23 @@ export interface UpdateQueueMaxContactsRequest {
|
|
|
3125
3209
|
*/
|
|
3126
3210
|
export interface UpdateQueueNameRequest {
|
|
3127
3211
|
/**
|
|
3128
|
-
* @public
|
|
3129
3212
|
* <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>
|
|
3213
|
+
* @public
|
|
3130
3214
|
*/
|
|
3131
3215
|
InstanceId: string | undefined;
|
|
3132
3216
|
/**
|
|
3133
|
-
* @public
|
|
3134
3217
|
* <p>The identifier for the queue.</p>
|
|
3218
|
+
* @public
|
|
3135
3219
|
*/
|
|
3136
3220
|
QueueId: string | undefined;
|
|
3137
3221
|
/**
|
|
3138
|
-
* @public
|
|
3139
3222
|
* <p>The name of the queue.</p>
|
|
3223
|
+
* @public
|
|
3140
3224
|
*/
|
|
3141
3225
|
Name?: string;
|
|
3142
3226
|
/**
|
|
3143
|
-
* @public
|
|
3144
3227
|
* <p>The description of the queue.</p>
|
|
3228
|
+
* @public
|
|
3145
3229
|
*/
|
|
3146
3230
|
Description?: string;
|
|
3147
3231
|
}
|
|
@@ -3150,18 +3234,18 @@ export interface UpdateQueueNameRequest {
|
|
|
3150
3234
|
*/
|
|
3151
3235
|
export interface UpdateQueueOutboundCallerConfigRequest {
|
|
3152
3236
|
/**
|
|
3153
|
-
* @public
|
|
3154
3237
|
* <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>
|
|
3238
|
+
* @public
|
|
3155
3239
|
*/
|
|
3156
3240
|
InstanceId: string | undefined;
|
|
3157
3241
|
/**
|
|
3158
|
-
* @public
|
|
3159
3242
|
* <p>The identifier for the queue.</p>
|
|
3243
|
+
* @public
|
|
3160
3244
|
*/
|
|
3161
3245
|
QueueId: string | undefined;
|
|
3162
3246
|
/**
|
|
3163
|
-
* @public
|
|
3164
3247
|
* <p>The outbound caller ID name, number, and outbound whisper flow.</p>
|
|
3248
|
+
* @public
|
|
3165
3249
|
*/
|
|
3166
3250
|
OutboundCallerConfig: OutboundCallerConfig | undefined;
|
|
3167
3251
|
}
|
|
@@ -3170,18 +3254,18 @@ export interface UpdateQueueOutboundCallerConfigRequest {
|
|
|
3170
3254
|
*/
|
|
3171
3255
|
export interface UpdateQueueStatusRequest {
|
|
3172
3256
|
/**
|
|
3173
|
-
* @public
|
|
3174
3257
|
* <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>
|
|
3258
|
+
* @public
|
|
3175
3259
|
*/
|
|
3176
3260
|
InstanceId: string | undefined;
|
|
3177
3261
|
/**
|
|
3178
|
-
* @public
|
|
3179
3262
|
* <p>The identifier for the queue.</p>
|
|
3263
|
+
* @public
|
|
3180
3264
|
*/
|
|
3181
3265
|
QueueId: string | undefined;
|
|
3182
3266
|
/**
|
|
3183
|
-
* @public
|
|
3184
3267
|
* <p>The status of the queue.</p>
|
|
3268
|
+
* @public
|
|
3185
3269
|
*/
|
|
3186
3270
|
Status: QueueStatus | undefined;
|
|
3187
3271
|
}
|
|
@@ -3190,18 +3274,18 @@ export interface UpdateQueueStatusRequest {
|
|
|
3190
3274
|
*/
|
|
3191
3275
|
export interface UpdateQuickConnectConfigRequest {
|
|
3192
3276
|
/**
|
|
3193
|
-
* @public
|
|
3194
3277
|
* <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>
|
|
3278
|
+
* @public
|
|
3195
3279
|
*/
|
|
3196
3280
|
InstanceId: string | undefined;
|
|
3197
3281
|
/**
|
|
3198
|
-
* @public
|
|
3199
3282
|
* <p>The identifier for the quick connect.</p>
|
|
3283
|
+
* @public
|
|
3200
3284
|
*/
|
|
3201
3285
|
QuickConnectId: string | undefined;
|
|
3202
3286
|
/**
|
|
3203
|
-
* @public
|
|
3204
3287
|
* <p>Information about the configuration settings for the quick connect.</p>
|
|
3288
|
+
* @public
|
|
3205
3289
|
*/
|
|
3206
3290
|
QuickConnectConfig: QuickConnectConfig | undefined;
|
|
3207
3291
|
}
|
|
@@ -3210,23 +3294,23 @@ export interface UpdateQuickConnectConfigRequest {
|
|
|
3210
3294
|
*/
|
|
3211
3295
|
export interface UpdateQuickConnectNameRequest {
|
|
3212
3296
|
/**
|
|
3213
|
-
* @public
|
|
3214
3297
|
* <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>
|
|
3298
|
+
* @public
|
|
3215
3299
|
*/
|
|
3216
3300
|
InstanceId: string | undefined;
|
|
3217
3301
|
/**
|
|
3218
|
-
* @public
|
|
3219
3302
|
* <p>The identifier for the quick connect.</p>
|
|
3303
|
+
* @public
|
|
3220
3304
|
*/
|
|
3221
3305
|
QuickConnectId: string | undefined;
|
|
3222
3306
|
/**
|
|
3223
|
-
* @public
|
|
3224
3307
|
* <p>The name of the quick connect.</p>
|
|
3308
|
+
* @public
|
|
3225
3309
|
*/
|
|
3226
3310
|
Name?: string;
|
|
3227
3311
|
/**
|
|
3228
|
-
* @public
|
|
3229
3312
|
* <p>The description of the quick connect.</p>
|
|
3313
|
+
* @public
|
|
3230
3314
|
*/
|
|
3231
3315
|
Description?: string;
|
|
3232
3316
|
}
|
|
@@ -3235,20 +3319,20 @@ export interface UpdateQuickConnectNameRequest {
|
|
|
3235
3319
|
*/
|
|
3236
3320
|
export interface UpdateRoutingProfileAgentAvailabilityTimerRequest {
|
|
3237
3321
|
/**
|
|
3238
|
-
* @public
|
|
3239
3322
|
* <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>
|
|
3323
|
+
* @public
|
|
3240
3324
|
*/
|
|
3241
3325
|
InstanceId: string | undefined;
|
|
3242
3326
|
/**
|
|
3243
|
-
* @public
|
|
3244
3327
|
* <p>The identifier of the routing profile.</p>
|
|
3328
|
+
* @public
|
|
3245
3329
|
*/
|
|
3246
3330
|
RoutingProfileId: string | undefined;
|
|
3247
3331
|
/**
|
|
3248
|
-
* @public
|
|
3249
3332
|
* <p>Whether agents with this routing profile will have their routing order calculated based on
|
|
3250
3333
|
* <i>time since their last inbound contact</i> or <i>longest idle
|
|
3251
3334
|
* time</i>. </p>
|
|
3335
|
+
* @public
|
|
3252
3336
|
*/
|
|
3253
3337
|
AgentAvailabilityTimer: AgentAvailabilityTimer | undefined;
|
|
3254
3338
|
}
|
|
@@ -3257,18 +3341,18 @@ export interface UpdateRoutingProfileAgentAvailabilityTimerRequest {
|
|
|
3257
3341
|
*/
|
|
3258
3342
|
export interface UpdateRoutingProfileConcurrencyRequest {
|
|
3259
3343
|
/**
|
|
3260
|
-
* @public
|
|
3261
3344
|
* <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>
|
|
3345
|
+
* @public
|
|
3262
3346
|
*/
|
|
3263
3347
|
InstanceId: string | undefined;
|
|
3264
3348
|
/**
|
|
3265
|
-
* @public
|
|
3266
3349
|
* <p>The identifier of the routing profile.</p>
|
|
3350
|
+
* @public
|
|
3267
3351
|
*/
|
|
3268
3352
|
RoutingProfileId: string | undefined;
|
|
3269
3353
|
/**
|
|
3270
|
-
* @public
|
|
3271
3354
|
* <p>The channels that agents can handle in the Contact Control Panel (CCP).</p>
|
|
3355
|
+
* @public
|
|
3272
3356
|
*/
|
|
3273
3357
|
MediaConcurrencies: MediaConcurrency[] | undefined;
|
|
3274
3358
|
}
|
|
@@ -3277,18 +3361,18 @@ export interface UpdateRoutingProfileConcurrencyRequest {
|
|
|
3277
3361
|
*/
|
|
3278
3362
|
export interface UpdateRoutingProfileDefaultOutboundQueueRequest {
|
|
3279
3363
|
/**
|
|
3280
|
-
* @public
|
|
3281
3364
|
* <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>
|
|
3365
|
+
* @public
|
|
3282
3366
|
*/
|
|
3283
3367
|
InstanceId: string | undefined;
|
|
3284
3368
|
/**
|
|
3285
|
-
* @public
|
|
3286
3369
|
* <p>The identifier of the routing profile.</p>
|
|
3370
|
+
* @public
|
|
3287
3371
|
*/
|
|
3288
3372
|
RoutingProfileId: string | undefined;
|
|
3289
3373
|
/**
|
|
3290
|
-
* @public
|
|
3291
3374
|
* <p>The identifier for the default outbound queue.</p>
|
|
3375
|
+
* @public
|
|
3292
3376
|
*/
|
|
3293
3377
|
DefaultOutboundQueueId: string | undefined;
|
|
3294
3378
|
}
|
|
@@ -3297,23 +3381,23 @@ export interface UpdateRoutingProfileDefaultOutboundQueueRequest {
|
|
|
3297
3381
|
*/
|
|
3298
3382
|
export interface UpdateRoutingProfileNameRequest {
|
|
3299
3383
|
/**
|
|
3300
|
-
* @public
|
|
3301
3384
|
* <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>
|
|
3385
|
+
* @public
|
|
3302
3386
|
*/
|
|
3303
3387
|
InstanceId: string | undefined;
|
|
3304
3388
|
/**
|
|
3305
|
-
* @public
|
|
3306
3389
|
* <p>The identifier of the routing profile.</p>
|
|
3390
|
+
* @public
|
|
3307
3391
|
*/
|
|
3308
3392
|
RoutingProfileId: string | undefined;
|
|
3309
3393
|
/**
|
|
3310
|
-
* @public
|
|
3311
3394
|
* <p>The name of the routing profile. Must not be more than 127 characters.</p>
|
|
3395
|
+
* @public
|
|
3312
3396
|
*/
|
|
3313
3397
|
Name?: string;
|
|
3314
3398
|
/**
|
|
3315
|
-
* @public
|
|
3316
3399
|
* <p>The description of the routing profile. Must not be more than 250 characters.</p>
|
|
3400
|
+
* @public
|
|
3317
3401
|
*/
|
|
3318
3402
|
Description?: string;
|
|
3319
3403
|
}
|
|
@@ -3322,20 +3406,20 @@ export interface UpdateRoutingProfileNameRequest {
|
|
|
3322
3406
|
*/
|
|
3323
3407
|
export interface UpdateRoutingProfileQueuesRequest {
|
|
3324
3408
|
/**
|
|
3325
|
-
* @public
|
|
3326
3409
|
* <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>
|
|
3410
|
+
* @public
|
|
3327
3411
|
*/
|
|
3328
3412
|
InstanceId: string | undefined;
|
|
3329
3413
|
/**
|
|
3330
|
-
* @public
|
|
3331
3414
|
* <p>The identifier of the routing profile.</p>
|
|
3415
|
+
* @public
|
|
3332
3416
|
*/
|
|
3333
3417
|
RoutingProfileId: string | undefined;
|
|
3334
3418
|
/**
|
|
3335
|
-
* @public
|
|
3336
3419
|
* <p>The queues to be updated for this routing profile.
|
|
3337
3420
|
* Queues must first be associated to the routing
|
|
3338
3421
|
* profile. You can do this using AssociateRoutingProfileQueues.</p>
|
|
3422
|
+
* @public
|
|
3339
3423
|
*/
|
|
3340
3424
|
QueueConfigs: RoutingProfileQueueConfig[] | undefined;
|
|
3341
3425
|
}
|
|
@@ -3344,36 +3428,36 @@ export interface UpdateRoutingProfileQueuesRequest {
|
|
|
3344
3428
|
*/
|
|
3345
3429
|
export interface UpdateRuleRequest {
|
|
3346
3430
|
/**
|
|
3347
|
-
* @public
|
|
3348
3431
|
* <p>A unique identifier for the rule.</p>
|
|
3432
|
+
* @public
|
|
3349
3433
|
*/
|
|
3350
3434
|
RuleId: string | undefined;
|
|
3351
3435
|
/**
|
|
3352
|
-
* @public
|
|
3353
3436
|
* <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>
|
|
3437
|
+
* @public
|
|
3354
3438
|
*/
|
|
3355
3439
|
InstanceId: string | undefined;
|
|
3356
3440
|
/**
|
|
3357
|
-
* @public
|
|
3358
3441
|
* <p>The name of the rule. You can change the name only if <code>TriggerEventSource</code> is one
|
|
3359
3442
|
* of the following values: <code>OnZendeskTicketCreate</code> |
|
|
3360
3443
|
* <code>OnZendeskTicketStatusUpdate</code> | <code>OnSalesforceCaseCreate</code>
|
|
3361
3444
|
* </p>
|
|
3445
|
+
* @public
|
|
3362
3446
|
*/
|
|
3363
3447
|
Name: string | undefined;
|
|
3364
3448
|
/**
|
|
3365
|
-
* @public
|
|
3366
3449
|
* <p>The conditions of the rule.</p>
|
|
3450
|
+
* @public
|
|
3367
3451
|
*/
|
|
3368
3452
|
Function: string | undefined;
|
|
3369
3453
|
/**
|
|
3370
|
-
* @public
|
|
3371
3454
|
* <p>A list of actions to be run when the rule is triggered.</p>
|
|
3455
|
+
* @public
|
|
3372
3456
|
*/
|
|
3373
3457
|
Actions: RuleAction[] | undefined;
|
|
3374
3458
|
/**
|
|
3375
|
-
* @public
|
|
3376
3459
|
* <p>The publish status of the rule.</p>
|
|
3460
|
+
* @public
|
|
3377
3461
|
*/
|
|
3378
3462
|
PublishStatus: RulePublishStatus | undefined;
|
|
3379
3463
|
}
|
|
@@ -3382,92 +3466,103 @@ export interface UpdateRuleRequest {
|
|
|
3382
3466
|
*/
|
|
3383
3467
|
export interface UpdateSecurityProfileRequest {
|
|
3384
3468
|
/**
|
|
3385
|
-
* @public
|
|
3386
3469
|
* <p>The description of the security profile.</p>
|
|
3470
|
+
* @public
|
|
3387
3471
|
*/
|
|
3388
3472
|
Description?: string;
|
|
3389
3473
|
/**
|
|
3390
|
-
* @public
|
|
3391
3474
|
* <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
|
|
3392
3475
|
* profile permissions</a>.</p>
|
|
3476
|
+
* @public
|
|
3393
3477
|
*/
|
|
3394
3478
|
Permissions?: string[];
|
|
3395
3479
|
/**
|
|
3396
|
-
* @public
|
|
3397
3480
|
* <p>The identifier for the security profle.</p>
|
|
3481
|
+
* @public
|
|
3398
3482
|
*/
|
|
3399
3483
|
SecurityProfileId: string | undefined;
|
|
3400
3484
|
/**
|
|
3401
|
-
* @public
|
|
3402
3485
|
* <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>
|
|
3486
|
+
* @public
|
|
3403
3487
|
*/
|
|
3404
3488
|
InstanceId: string | undefined;
|
|
3405
3489
|
/**
|
|
3406
|
-
* @public
|
|
3407
3490
|
* <p>The list of tags that a security profile uses to restrict access to resources in Amazon Connect.</p>
|
|
3491
|
+
* @public
|
|
3408
3492
|
*/
|
|
3409
3493
|
AllowedAccessControlTags?: Record<string, string>;
|
|
3410
3494
|
/**
|
|
3411
|
-
* @public
|
|
3412
3495
|
* <p>The list of resources that a security profile applies tag restrictions to in Amazon Connect.</p>
|
|
3496
|
+
* @public
|
|
3413
3497
|
*/
|
|
3414
3498
|
TagRestrictedResources?: string[];
|
|
3415
3499
|
/**
|
|
3416
|
-
* @public
|
|
3417
3500
|
* <p>This API is in preview release for Amazon Connect and is subject to change.</p>
|
|
3418
3501
|
* <p>A list of the third-party application's metadata.</p>
|
|
3502
|
+
* @public
|
|
3419
3503
|
*/
|
|
3420
3504
|
Applications?: Application[];
|
|
3505
|
+
/**
|
|
3506
|
+
* <p>The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: <code>User</code>.</p>
|
|
3507
|
+
* @public
|
|
3508
|
+
*/
|
|
3509
|
+
HierarchyRestrictedResources?: string[];
|
|
3510
|
+
/**
|
|
3511
|
+
* <p>The identifier of the hierarchy group that a security profile uses to restrict access to
|
|
3512
|
+
* resources in Amazon Connect.</p>
|
|
3513
|
+
* @public
|
|
3514
|
+
*/
|
|
3515
|
+
AllowedAccessControlHierarchyGroupId?: string;
|
|
3421
3516
|
}
|
|
3422
3517
|
/**
|
|
3423
3518
|
* @public
|
|
3424
3519
|
*/
|
|
3425
3520
|
export interface UpdateTaskTemplateRequest {
|
|
3426
3521
|
/**
|
|
3427
|
-
* @public
|
|
3428
3522
|
* <p>A unique identifier for the task template.</p>
|
|
3523
|
+
* @public
|
|
3429
3524
|
*/
|
|
3430
3525
|
TaskTemplateId: string | undefined;
|
|
3431
3526
|
/**
|
|
3432
|
-
* @public
|
|
3433
3527
|
* <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>
|
|
3528
|
+
* @public
|
|
3434
3529
|
*/
|
|
3435
3530
|
InstanceId: string | undefined;
|
|
3436
3531
|
/**
|
|
3437
|
-
* @public
|
|
3438
3532
|
* <p>The name of the task template.</p>
|
|
3533
|
+
* @public
|
|
3439
3534
|
*/
|
|
3440
3535
|
Name?: string;
|
|
3441
3536
|
/**
|
|
3442
|
-
* @public
|
|
3443
3537
|
* <p>The description of the task template.</p>
|
|
3538
|
+
* @public
|
|
3444
3539
|
*/
|
|
3445
3540
|
Description?: string;
|
|
3446
3541
|
/**
|
|
3447
|
-
* @public
|
|
3448
3542
|
* <p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>
|
|
3543
|
+
* @public
|
|
3449
3544
|
*/
|
|
3450
3545
|
ContactFlowId?: string;
|
|
3451
3546
|
/**
|
|
3452
|
-
* @public
|
|
3453
3547
|
* <p>Constraints that are applicable to the fields listed.</p>
|
|
3548
|
+
* @public
|
|
3454
3549
|
*/
|
|
3455
3550
|
Constraints?: TaskTemplateConstraints;
|
|
3456
3551
|
/**
|
|
3457
|
-
* @public
|
|
3458
3552
|
* <p>The default values for fields when a task is created by referencing this template.</p>
|
|
3553
|
+
* @public
|
|
3459
3554
|
*/
|
|
3460
3555
|
Defaults?: TaskTemplateDefaults;
|
|
3461
3556
|
/**
|
|
3462
|
-
* @public
|
|
3463
3557
|
* <p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it.
|
|
3464
3558
|
* Tasks can only be created from <code>ACTIVE</code> templates.
|
|
3465
3559
|
* If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>
|
|
3560
|
+
* @public
|
|
3466
3561
|
*/
|
|
3467
3562
|
Status?: TaskTemplateStatus;
|
|
3468
3563
|
/**
|
|
3469
|
-
* @public
|
|
3470
3564
|
* <p>Fields that are part of the template.</p>
|
|
3565
|
+
* @public
|
|
3471
3566
|
*/
|
|
3472
3567
|
Fields?: TaskTemplateField[];
|
|
3473
3568
|
}
|
|
@@ -3476,65 +3571,65 @@ export interface UpdateTaskTemplateRequest {
|
|
|
3476
3571
|
*/
|
|
3477
3572
|
export interface UpdateTaskTemplateResponse {
|
|
3478
3573
|
/**
|
|
3479
|
-
* @public
|
|
3480
3574
|
* <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>
|
|
3575
|
+
* @public
|
|
3481
3576
|
*/
|
|
3482
3577
|
InstanceId?: string;
|
|
3483
3578
|
/**
|
|
3484
|
-
* @public
|
|
3485
3579
|
* <p>The identifier of the task template resource.</p>
|
|
3580
|
+
* @public
|
|
3486
3581
|
*/
|
|
3487
3582
|
Id?: string;
|
|
3488
3583
|
/**
|
|
3489
|
-
* @public
|
|
3490
3584
|
* <p>The Amazon Resource Name (ARN) for the task template resource.</p>
|
|
3585
|
+
* @public
|
|
3491
3586
|
*/
|
|
3492
3587
|
Arn?: string;
|
|
3493
3588
|
/**
|
|
3494
|
-
* @public
|
|
3495
3589
|
* <p>The name of the task template.</p>
|
|
3590
|
+
* @public
|
|
3496
3591
|
*/
|
|
3497
3592
|
Name?: string;
|
|
3498
3593
|
/**
|
|
3499
|
-
* @public
|
|
3500
3594
|
* <p>The description of the task template.</p>
|
|
3595
|
+
* @public
|
|
3501
3596
|
*/
|
|
3502
3597
|
Description?: string;
|
|
3503
3598
|
/**
|
|
3504
|
-
* @public
|
|
3505
3599
|
* <p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>
|
|
3600
|
+
* @public
|
|
3506
3601
|
*/
|
|
3507
3602
|
ContactFlowId?: string;
|
|
3508
3603
|
/**
|
|
3509
|
-
* @public
|
|
3510
3604
|
* <p>Constraints that are applicable to the fields listed.</p>
|
|
3605
|
+
* @public
|
|
3511
3606
|
*/
|
|
3512
3607
|
Constraints?: TaskTemplateConstraints;
|
|
3513
3608
|
/**
|
|
3514
|
-
* @public
|
|
3515
3609
|
* <p>The default values for fields when a task is created by referencing this template.</p>
|
|
3610
|
+
* @public
|
|
3516
3611
|
*/
|
|
3517
3612
|
Defaults?: TaskTemplateDefaults;
|
|
3518
3613
|
/**
|
|
3519
|
-
* @public
|
|
3520
3614
|
* <p>Fields that are part of the template.</p>
|
|
3615
|
+
* @public
|
|
3521
3616
|
*/
|
|
3522
3617
|
Fields?: TaskTemplateField[];
|
|
3523
3618
|
/**
|
|
3524
|
-
* @public
|
|
3525
3619
|
* <p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it.
|
|
3526
3620
|
* Tasks can only be created from <code>ACTIVE</code> templates.
|
|
3527
3621
|
* If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>
|
|
3622
|
+
* @public
|
|
3528
3623
|
*/
|
|
3529
3624
|
Status?: TaskTemplateStatus;
|
|
3530
3625
|
/**
|
|
3531
|
-
* @public
|
|
3532
3626
|
* <p>The timestamp when the task template was last modified.</p>
|
|
3627
|
+
* @public
|
|
3533
3628
|
*/
|
|
3534
3629
|
LastModifiedTime?: Date;
|
|
3535
3630
|
/**
|
|
3536
|
-
* @public
|
|
3537
3631
|
* <p>The timestamp when the task template was created.</p>
|
|
3632
|
+
* @public
|
|
3538
3633
|
*/
|
|
3539
3634
|
CreatedTime?: Date;
|
|
3540
3635
|
}
|
|
@@ -3543,26 +3638,26 @@ export interface UpdateTaskTemplateResponse {
|
|
|
3543
3638
|
*/
|
|
3544
3639
|
export interface UpdateTrafficDistributionRequest {
|
|
3545
3640
|
/**
|
|
3546
|
-
* @public
|
|
3547
3641
|
* <p>The identifier of the traffic distribution group.
|
|
3548
3642
|
* This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
|
|
3549
3643
|
* The ARN must be provided if the call is from the replicated Region. </p>
|
|
3644
|
+
* @public
|
|
3550
3645
|
*/
|
|
3551
3646
|
Id: string | undefined;
|
|
3552
3647
|
/**
|
|
3553
|
-
* @public
|
|
3554
3648
|
* <p>The distribution of traffic between the instance and its replica(s).</p>
|
|
3649
|
+
* @public
|
|
3555
3650
|
*/
|
|
3556
3651
|
TelephonyConfig?: TelephonyConfig;
|
|
3557
3652
|
/**
|
|
3558
|
-
* @public
|
|
3559
3653
|
* <p>The distribution that determines which Amazon Web Services Regions should be used to sign in
|
|
3560
3654
|
* agents in to both the instance and its replica(s).</p>
|
|
3655
|
+
* @public
|
|
3561
3656
|
*/
|
|
3562
3657
|
SignInConfig?: SignInConfig;
|
|
3563
3658
|
/**
|
|
3564
|
-
* @public
|
|
3565
3659
|
* <p>The distribution of agents between the instance and its replica(s).</p>
|
|
3660
|
+
* @public
|
|
3566
3661
|
*/
|
|
3567
3662
|
AgentConfig?: AgentConfig;
|
|
3568
3663
|
}
|
|
@@ -3576,18 +3671,18 @@ export interface UpdateTrafficDistributionResponse {
|
|
|
3576
3671
|
*/
|
|
3577
3672
|
export interface UpdateUserHierarchyRequest {
|
|
3578
3673
|
/**
|
|
3579
|
-
* @public
|
|
3580
3674
|
* <p>The identifier of the hierarchy group.</p>
|
|
3675
|
+
* @public
|
|
3581
3676
|
*/
|
|
3582
3677
|
HierarchyGroupId?: string;
|
|
3583
3678
|
/**
|
|
3584
|
-
* @public
|
|
3585
3679
|
* <p>The identifier of the user account.</p>
|
|
3680
|
+
* @public
|
|
3586
3681
|
*/
|
|
3587
3682
|
UserId: string | undefined;
|
|
3588
3683
|
/**
|
|
3589
|
-
* @public
|
|
3590
3684
|
* <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>
|
|
3685
|
+
* @public
|
|
3591
3686
|
*/
|
|
3592
3687
|
InstanceId: string | undefined;
|
|
3593
3688
|
}
|
|
@@ -3596,62 +3691,62 @@ export interface UpdateUserHierarchyRequest {
|
|
|
3596
3691
|
*/
|
|
3597
3692
|
export interface UpdateUserHierarchyGroupNameRequest {
|
|
3598
3693
|
/**
|
|
3599
|
-
* @public
|
|
3600
3694
|
* <p>The name of the hierarchy group. Must not be more than 100 characters.</p>
|
|
3695
|
+
* @public
|
|
3601
3696
|
*/
|
|
3602
3697
|
Name: string | undefined;
|
|
3603
3698
|
/**
|
|
3604
|
-
* @public
|
|
3605
3699
|
* <p>The identifier of the hierarchy group.</p>
|
|
3700
|
+
* @public
|
|
3606
3701
|
*/
|
|
3607
3702
|
HierarchyGroupId: string | undefined;
|
|
3608
3703
|
/**
|
|
3609
|
-
* @public
|
|
3610
3704
|
* <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>
|
|
3705
|
+
* @public
|
|
3611
3706
|
*/
|
|
3612
3707
|
InstanceId: string | undefined;
|
|
3613
3708
|
}
|
|
3614
3709
|
/**
|
|
3615
|
-
* @public
|
|
3616
3710
|
* <p>Contains information about the hierarchy level to update.</p>
|
|
3711
|
+
* @public
|
|
3617
3712
|
*/
|
|
3618
3713
|
export interface HierarchyLevelUpdate {
|
|
3619
3714
|
/**
|
|
3620
|
-
* @public
|
|
3621
3715
|
* <p>The name of the user hierarchy level. Must not be more than 50 characters.</p>
|
|
3716
|
+
* @public
|
|
3622
3717
|
*/
|
|
3623
3718
|
Name: string | undefined;
|
|
3624
3719
|
}
|
|
3625
3720
|
/**
|
|
3626
|
-
* @public
|
|
3627
3721
|
* <p>Contains information about the level hierarchy to update.</p>
|
|
3722
|
+
* @public
|
|
3628
3723
|
*/
|
|
3629
3724
|
export interface HierarchyStructureUpdate {
|
|
3630
3725
|
/**
|
|
3631
|
-
* @public
|
|
3632
3726
|
* <p>The
|
|
3633
3727
|
* update
|
|
3634
3728
|
* for level one.</p>
|
|
3729
|
+
* @public
|
|
3635
3730
|
*/
|
|
3636
3731
|
LevelOne?: HierarchyLevelUpdate;
|
|
3637
3732
|
/**
|
|
3638
|
-
* @public
|
|
3639
3733
|
* <p>The update for level two.</p>
|
|
3734
|
+
* @public
|
|
3640
3735
|
*/
|
|
3641
3736
|
LevelTwo?: HierarchyLevelUpdate;
|
|
3642
3737
|
/**
|
|
3643
|
-
* @public
|
|
3644
3738
|
* <p>The update for level three.</p>
|
|
3739
|
+
* @public
|
|
3645
3740
|
*/
|
|
3646
3741
|
LevelThree?: HierarchyLevelUpdate;
|
|
3647
3742
|
/**
|
|
3648
|
-
* @public
|
|
3649
3743
|
* <p>The update for level four.</p>
|
|
3744
|
+
* @public
|
|
3650
3745
|
*/
|
|
3651
3746
|
LevelFour?: HierarchyLevelUpdate;
|
|
3652
3747
|
/**
|
|
3653
|
-
* @public
|
|
3654
3748
|
* <p>The update for level five.</p>
|
|
3749
|
+
* @public
|
|
3655
3750
|
*/
|
|
3656
3751
|
LevelFive?: HierarchyLevelUpdate;
|
|
3657
3752
|
}
|
|
@@ -3660,13 +3755,13 @@ export interface HierarchyStructureUpdate {
|
|
|
3660
3755
|
*/
|
|
3661
3756
|
export interface UpdateUserHierarchyStructureRequest {
|
|
3662
3757
|
/**
|
|
3663
|
-
* @public
|
|
3664
3758
|
* <p>The hierarchy levels to update.</p>
|
|
3759
|
+
* @public
|
|
3665
3760
|
*/
|
|
3666
3761
|
HierarchyStructure: HierarchyStructureUpdate | undefined;
|
|
3667
3762
|
/**
|
|
3668
|
-
* @public
|
|
3669
3763
|
* <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>
|
|
3764
|
+
* @public
|
|
3670
3765
|
*/
|
|
3671
3766
|
InstanceId: string | undefined;
|
|
3672
3767
|
}
|
|
@@ -3675,18 +3770,18 @@ export interface UpdateUserHierarchyStructureRequest {
|
|
|
3675
3770
|
*/
|
|
3676
3771
|
export interface UpdateUserIdentityInfoRequest {
|
|
3677
3772
|
/**
|
|
3678
|
-
* @public
|
|
3679
3773
|
* <p>The identity information for the user.</p>
|
|
3774
|
+
* @public
|
|
3680
3775
|
*/
|
|
3681
3776
|
IdentityInfo: UserIdentityInfo | undefined;
|
|
3682
3777
|
/**
|
|
3683
|
-
* @public
|
|
3684
3778
|
* <p>The identifier of the user account.</p>
|
|
3779
|
+
* @public
|
|
3685
3780
|
*/
|
|
3686
3781
|
UserId: string | undefined;
|
|
3687
3782
|
/**
|
|
3688
|
-
* @public
|
|
3689
3783
|
* <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>
|
|
3784
|
+
* @public
|
|
3690
3785
|
*/
|
|
3691
3786
|
InstanceId: string | undefined;
|
|
3692
3787
|
}
|
|
@@ -3695,18 +3790,18 @@ export interface UpdateUserIdentityInfoRequest {
|
|
|
3695
3790
|
*/
|
|
3696
3791
|
export interface UpdateUserPhoneConfigRequest {
|
|
3697
3792
|
/**
|
|
3698
|
-
* @public
|
|
3699
3793
|
* <p>Information about phone configuration settings for the user.</p>
|
|
3794
|
+
* @public
|
|
3700
3795
|
*/
|
|
3701
3796
|
PhoneConfig: UserPhoneConfig | undefined;
|
|
3702
3797
|
/**
|
|
3703
|
-
* @public
|
|
3704
3798
|
* <p>The identifier of the user account.</p>
|
|
3799
|
+
* @public
|
|
3705
3800
|
*/
|
|
3706
3801
|
UserId: string | undefined;
|
|
3707
3802
|
/**
|
|
3708
|
-
* @public
|
|
3709
3803
|
* <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>
|
|
3804
|
+
* @public
|
|
3710
3805
|
*/
|
|
3711
3806
|
InstanceId: string | undefined;
|
|
3712
3807
|
}
|
|
@@ -3715,20 +3810,20 @@ export interface UpdateUserPhoneConfigRequest {
|
|
|
3715
3810
|
*/
|
|
3716
3811
|
export interface UpdateUserProficienciesRequest {
|
|
3717
3812
|
/**
|
|
3718
|
-
* @public
|
|
3719
3813
|
* <p> The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
|
|
3720
3814
|
* Name (ARN) of the instance.</p>
|
|
3815
|
+
* @public
|
|
3721
3816
|
*/
|
|
3722
3817
|
InstanceId: string | undefined;
|
|
3723
3818
|
/**
|
|
3724
|
-
* @public
|
|
3725
3819
|
* <p>The identifier of the user account.</p>
|
|
3820
|
+
* @public
|
|
3726
3821
|
*/
|
|
3727
3822
|
UserId: string | undefined;
|
|
3728
3823
|
/**
|
|
3729
|
-
* @public
|
|
3730
3824
|
* <p>The proficiencies to be updated for the user. Proficiencies must first be associated to the
|
|
3731
3825
|
* user. You can do this using AssociateUserProficiencies API.</p>
|
|
3826
|
+
* @public
|
|
3732
3827
|
*/
|
|
3733
3828
|
UserProficiencies: UserProficiency[] | undefined;
|
|
3734
3829
|
}
|
|
@@ -3737,18 +3832,18 @@ export interface UpdateUserProficienciesRequest {
|
|
|
3737
3832
|
*/
|
|
3738
3833
|
export interface UpdateUserRoutingProfileRequest {
|
|
3739
3834
|
/**
|
|
3740
|
-
* @public
|
|
3741
3835
|
* <p>The identifier of the routing profile for the user.</p>
|
|
3836
|
+
* @public
|
|
3742
3837
|
*/
|
|
3743
3838
|
RoutingProfileId: string | undefined;
|
|
3744
3839
|
/**
|
|
3745
|
-
* @public
|
|
3746
3840
|
* <p>The identifier of the user account.</p>
|
|
3841
|
+
* @public
|
|
3747
3842
|
*/
|
|
3748
3843
|
UserId: string | undefined;
|
|
3749
3844
|
/**
|
|
3750
|
-
* @public
|
|
3751
3845
|
* <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>
|
|
3846
|
+
* @public
|
|
3752
3847
|
*/
|
|
3753
3848
|
InstanceId: string | undefined;
|
|
3754
3849
|
}
|
|
@@ -3757,18 +3852,18 @@ export interface UpdateUserRoutingProfileRequest {
|
|
|
3757
3852
|
*/
|
|
3758
3853
|
export interface UpdateUserSecurityProfilesRequest {
|
|
3759
3854
|
/**
|
|
3760
|
-
* @public
|
|
3761
3855
|
* <p>The identifiers of the security profiles for the user.</p>
|
|
3856
|
+
* @public
|
|
3762
3857
|
*/
|
|
3763
3858
|
SecurityProfileIds: string[] | undefined;
|
|
3764
3859
|
/**
|
|
3765
|
-
* @public
|
|
3766
3860
|
* <p>The identifier of the user account.</p>
|
|
3861
|
+
* @public
|
|
3767
3862
|
*/
|
|
3768
3863
|
UserId: string | undefined;
|
|
3769
3864
|
/**
|
|
3770
|
-
* @public
|
|
3771
3865
|
* <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>
|
|
3866
|
+
* @public
|
|
3772
3867
|
*/
|
|
3773
3868
|
InstanceId: string | undefined;
|
|
3774
3869
|
}
|
|
@@ -3777,28 +3872,28 @@ export interface UpdateUserSecurityProfilesRequest {
|
|
|
3777
3872
|
*/
|
|
3778
3873
|
export interface UpdateViewContentRequest {
|
|
3779
3874
|
/**
|
|
3780
|
-
* @public
|
|
3781
3875
|
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
3782
3876
|
* the instance.</p>
|
|
3877
|
+
* @public
|
|
3783
3878
|
*/
|
|
3784
3879
|
InstanceId: string | undefined;
|
|
3785
3880
|
/**
|
|
3786
|
-
* @public
|
|
3787
3881
|
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
3788
3882
|
* used.</p>
|
|
3883
|
+
* @public
|
|
3789
3884
|
*/
|
|
3790
3885
|
ViewId: string | undefined;
|
|
3791
3886
|
/**
|
|
3792
|
-
* @public
|
|
3793
3887
|
* <p>Indicates the view status as either <code>SAVED</code> or <code>PUBLISHED</code>. The
|
|
3794
3888
|
* <code>PUBLISHED</code> status will initiate validation on the content.</p>
|
|
3889
|
+
* @public
|
|
3795
3890
|
*/
|
|
3796
3891
|
Status: ViewStatus | undefined;
|
|
3797
3892
|
/**
|
|
3798
|
-
* @public
|
|
3799
3893
|
* <p>View content containing all content necessary to render a view except for runtime input data
|
|
3800
3894
|
* and the runtime input schema, which is auto-generated by this operation.</p>
|
|
3801
3895
|
* <p>The total uncompressed content has a maximum file size of 400kB.</p>
|
|
3896
|
+
* @public
|
|
3802
3897
|
*/
|
|
3803
3898
|
Content: ViewInputContent | undefined;
|
|
3804
3899
|
}
|
|
@@ -3807,8 +3902,8 @@ export interface UpdateViewContentRequest {
|
|
|
3807
3902
|
*/
|
|
3808
3903
|
export interface UpdateViewContentResponse {
|
|
3809
3904
|
/**
|
|
3810
|
-
* @public
|
|
3811
3905
|
* <p>A view resource object. Contains metadata and content necessary to render the view.</p>
|
|
3906
|
+
* @public
|
|
3812
3907
|
*/
|
|
3813
3908
|
View?: View;
|
|
3814
3909
|
}
|
|
@@ -3817,25 +3912,25 @@ export interface UpdateViewContentResponse {
|
|
|
3817
3912
|
*/
|
|
3818
3913
|
export interface UpdateViewMetadataRequest {
|
|
3819
3914
|
/**
|
|
3820
|
-
* @public
|
|
3821
3915
|
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
3822
3916
|
* the instance.</p>
|
|
3917
|
+
* @public
|
|
3823
3918
|
*/
|
|
3824
3919
|
InstanceId: string | undefined;
|
|
3825
3920
|
/**
|
|
3826
|
-
* @public
|
|
3827
3921
|
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
3828
3922
|
* used.</p>
|
|
3923
|
+
* @public
|
|
3829
3924
|
*/
|
|
3830
3925
|
ViewId: string | undefined;
|
|
3831
3926
|
/**
|
|
3832
|
-
* @public
|
|
3833
3927
|
* <p>The name of the view.</p>
|
|
3928
|
+
* @public
|
|
3834
3929
|
*/
|
|
3835
3930
|
Name?: string;
|
|
3836
3931
|
/**
|
|
3837
|
-
* @public
|
|
3838
3932
|
* <p>The description of the view.</p>
|
|
3933
|
+
* @public
|
|
3839
3934
|
*/
|
|
3840
3935
|
Description?: string;
|
|
3841
3936
|
}
|
|
@@ -3845,9 +3940,9 @@ export interface UpdateViewMetadataRequest {
|
|
|
3845
3940
|
export interface UpdateViewMetadataResponse {
|
|
3846
3941
|
}
|
|
3847
3942
|
/**
|
|
3848
|
-
* @public
|
|
3849
3943
|
* <p>Information about an item from an evaluation form. The item must be either a section or a
|
|
3850
3944
|
* question.</p>
|
|
3945
|
+
* @public
|
|
3851
3946
|
*/
|
|
3852
3947
|
export type EvaluationFormItem = EvaluationFormItem.QuestionMember | EvaluationFormItem.SectionMember | EvaluationFormItem.$UnknownMember;
|
|
3853
3948
|
/**
|
|
@@ -3855,8 +3950,8 @@ export type EvaluationFormItem = EvaluationFormItem.QuestionMember | EvaluationF
|
|
|
3855
3950
|
*/
|
|
3856
3951
|
export declare namespace EvaluationFormItem {
|
|
3857
3952
|
/**
|
|
3858
|
-
* @public
|
|
3859
3953
|
* <p>The information of the section.</p>
|
|
3954
|
+
* @public
|
|
3860
3955
|
*/
|
|
3861
3956
|
interface SectionMember {
|
|
3862
3957
|
Section: EvaluationFormSection;
|
|
@@ -3864,8 +3959,8 @@ export declare namespace EvaluationFormItem {
|
|
|
3864
3959
|
$unknown?: never;
|
|
3865
3960
|
}
|
|
3866
3961
|
/**
|
|
3867
|
-
* @public
|
|
3868
3962
|
* <p>The information of the question.</p>
|
|
3963
|
+
* @public
|
|
3869
3964
|
*/
|
|
3870
3965
|
interface QuestionMember {
|
|
3871
3966
|
Section?: never;
|
|
@@ -3888,35 +3983,35 @@ export declare namespace EvaluationFormItem {
|
|
|
3888
3983
|
const visit: <T>(value: EvaluationFormItem, visitor: Visitor<T>) => T;
|
|
3889
3984
|
}
|
|
3890
3985
|
/**
|
|
3891
|
-
* @public
|
|
3892
3986
|
* <p>Information about a section from an evaluation form. A section can contain sections and/or
|
|
3893
3987
|
* questions. Evaluation forms can only contain sections and subsections (two level nesting).</p>
|
|
3988
|
+
* @public
|
|
3894
3989
|
*/
|
|
3895
3990
|
export interface EvaluationFormSection {
|
|
3896
3991
|
/**
|
|
3897
|
-
* @public
|
|
3898
3992
|
* <p>The title of the section.</p>
|
|
3993
|
+
* @public
|
|
3899
3994
|
*/
|
|
3900
3995
|
Title: string | undefined;
|
|
3901
3996
|
/**
|
|
3902
|
-
* @public
|
|
3903
3997
|
* <p>The identifier of the section. An identifier must be unique within the evaluation
|
|
3904
3998
|
* form.</p>
|
|
3999
|
+
* @public
|
|
3905
4000
|
*/
|
|
3906
4001
|
RefId: string | undefined;
|
|
3907
4002
|
/**
|
|
3908
|
-
* @public
|
|
3909
4003
|
* <p>The instructions of the section.</p>
|
|
4004
|
+
* @public
|
|
3910
4005
|
*/
|
|
3911
4006
|
Instructions?: string;
|
|
3912
4007
|
/**
|
|
3913
|
-
* @public
|
|
3914
4008
|
* <p>The items of the section.</p>
|
|
4009
|
+
* @public
|
|
3915
4010
|
*/
|
|
3916
4011
|
Items: EvaluationFormItem[] | undefined;
|
|
3917
4012
|
/**
|
|
3918
|
-
* @public
|
|
3919
4013
|
* <p>The scoring weight of the section.</p>
|
|
4014
|
+
* @public
|
|
3920
4015
|
*/
|
|
3921
4016
|
Weight?: number;
|
|
3922
4017
|
}
|
|
@@ -3925,350 +4020,350 @@ export interface EvaluationFormSection {
|
|
|
3925
4020
|
*/
|
|
3926
4021
|
export interface CreateEvaluationFormRequest {
|
|
3927
4022
|
/**
|
|
3928
|
-
* @public
|
|
3929
4023
|
* <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>
|
|
4024
|
+
* @public
|
|
3930
4025
|
*/
|
|
3931
4026
|
InstanceId: string | undefined;
|
|
3932
4027
|
/**
|
|
3933
|
-
* @public
|
|
3934
4028
|
* <p>A title of the evaluation form.</p>
|
|
4029
|
+
* @public
|
|
3935
4030
|
*/
|
|
3936
4031
|
Title: string | undefined;
|
|
3937
4032
|
/**
|
|
3938
|
-
* @public
|
|
3939
4033
|
* <p>The description of the evaluation form.</p>
|
|
4034
|
+
* @public
|
|
3940
4035
|
*/
|
|
3941
4036
|
Description?: string;
|
|
3942
4037
|
/**
|
|
3943
|
-
* @public
|
|
3944
4038
|
* <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
|
|
4039
|
+
* @public
|
|
3945
4040
|
*/
|
|
3946
4041
|
Items: EvaluationFormItem[] | undefined;
|
|
3947
4042
|
/**
|
|
3948
|
-
* @public
|
|
3949
4043
|
* <p>A scoring strategy of the evaluation form.</p>
|
|
4044
|
+
* @public
|
|
3950
4045
|
*/
|
|
3951
4046
|
ScoringStrategy?: EvaluationFormScoringStrategy;
|
|
3952
4047
|
/**
|
|
3953
|
-
* @public
|
|
3954
4048
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3955
4049
|
* request. If not provided, the Amazon Web Services
|
|
3956
4050
|
* SDK populates this field. For more information about idempotency, see
|
|
3957
4051
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
4052
|
+
* @public
|
|
3958
4053
|
*/
|
|
3959
4054
|
ClientToken?: string;
|
|
3960
4055
|
}
|
|
3961
4056
|
/**
|
|
3962
|
-
* @public
|
|
3963
4057
|
* <p>Information about the evaluation form.</p>
|
|
4058
|
+
* @public
|
|
3964
4059
|
*/
|
|
3965
4060
|
export interface EvaluationForm {
|
|
3966
4061
|
/**
|
|
3967
|
-
* @public
|
|
3968
4062
|
* <p>The unique identifier for the evaluation form.</p>
|
|
4063
|
+
* @public
|
|
3969
4064
|
*/
|
|
3970
4065
|
EvaluationFormId: string | undefined;
|
|
3971
4066
|
/**
|
|
3972
|
-
* @public
|
|
3973
4067
|
* <p>A version of the evaluation form.</p>
|
|
4068
|
+
* @public
|
|
3974
4069
|
*/
|
|
3975
4070
|
EvaluationFormVersion: number | undefined;
|
|
3976
4071
|
/**
|
|
3977
|
-
* @public
|
|
3978
4072
|
* <p>The flag indicating whether the evaluation form is locked for changes.</p>
|
|
4073
|
+
* @public
|
|
3979
4074
|
*/
|
|
3980
4075
|
Locked: boolean | undefined;
|
|
3981
4076
|
/**
|
|
3982
|
-
* @public
|
|
3983
4077
|
* <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
|
|
4078
|
+
* @public
|
|
3984
4079
|
*/
|
|
3985
4080
|
EvaluationFormArn: string | undefined;
|
|
3986
4081
|
/**
|
|
3987
|
-
* @public
|
|
3988
4082
|
* <p>A title of the evaluation form.</p>
|
|
4083
|
+
* @public
|
|
3989
4084
|
*/
|
|
3990
4085
|
Title: string | undefined;
|
|
3991
4086
|
/**
|
|
3992
|
-
* @public
|
|
3993
4087
|
* <p>The description of the evaluation form.</p>
|
|
4088
|
+
* @public
|
|
3994
4089
|
*/
|
|
3995
4090
|
Description?: string;
|
|
3996
4091
|
/**
|
|
3997
|
-
* @public
|
|
3998
4092
|
* <p>The status of the evaluation form.</p>
|
|
4093
|
+
* @public
|
|
3999
4094
|
*/
|
|
4000
4095
|
Status: EvaluationFormVersionStatus | undefined;
|
|
4001
4096
|
/**
|
|
4002
|
-
* @public
|
|
4003
4097
|
* <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
|
|
4098
|
+
* @public
|
|
4004
4099
|
*/
|
|
4005
4100
|
Items: EvaluationFormItem[] | undefined;
|
|
4006
4101
|
/**
|
|
4007
|
-
* @public
|
|
4008
4102
|
* <p>A scoring strategy of the evaluation form.</p>
|
|
4103
|
+
* @public
|
|
4009
4104
|
*/
|
|
4010
4105
|
ScoringStrategy?: EvaluationFormScoringStrategy;
|
|
4011
4106
|
/**
|
|
4012
|
-
* @public
|
|
4013
4107
|
* <p>The timestamp for when the evaluation form was created.</p>
|
|
4108
|
+
* @public
|
|
4014
4109
|
*/
|
|
4015
4110
|
CreatedTime: Date | undefined;
|
|
4016
4111
|
/**
|
|
4017
|
-
* @public
|
|
4018
4112
|
* <p>The Amazon Resource Name (ARN) of the user who created the evaluation form.</p>
|
|
4113
|
+
* @public
|
|
4019
4114
|
*/
|
|
4020
4115
|
CreatedBy: string | undefined;
|
|
4021
4116
|
/**
|
|
4022
|
-
* @public
|
|
4023
4117
|
* <p>The timestamp for when the evaluation form was last updated.</p>
|
|
4118
|
+
* @public
|
|
4024
4119
|
*/
|
|
4025
4120
|
LastModifiedTime: Date | undefined;
|
|
4026
4121
|
/**
|
|
4027
|
-
* @public
|
|
4028
4122
|
* <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation form.</p>
|
|
4123
|
+
* @public
|
|
4029
4124
|
*/
|
|
4030
4125
|
LastModifiedBy: string | undefined;
|
|
4031
4126
|
/**
|
|
4032
|
-
* @public
|
|
4033
4127
|
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
4128
|
+
* @public
|
|
4034
4129
|
*/
|
|
4035
4130
|
Tags?: Record<string, string>;
|
|
4036
4131
|
}
|
|
4037
4132
|
/**
|
|
4038
|
-
* @public
|
|
4039
4133
|
* <p>Information about an evaluation form used in a contact evaluation.</p>
|
|
4134
|
+
* @public
|
|
4040
4135
|
*/
|
|
4041
4136
|
export interface EvaluationFormContent {
|
|
4042
4137
|
/**
|
|
4043
|
-
* @public
|
|
4044
4138
|
* <p>A version of the evaluation form.</p>
|
|
4139
|
+
* @public
|
|
4045
4140
|
*/
|
|
4046
4141
|
EvaluationFormVersion: number | undefined;
|
|
4047
4142
|
/**
|
|
4048
|
-
* @public
|
|
4049
4143
|
* <p>The unique identifier for the evaluation form.</p>
|
|
4144
|
+
* @public
|
|
4050
4145
|
*/
|
|
4051
4146
|
EvaluationFormId: string | undefined;
|
|
4052
4147
|
/**
|
|
4053
|
-
* @public
|
|
4054
4148
|
* <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
|
|
4149
|
+
* @public
|
|
4055
4150
|
*/
|
|
4056
4151
|
EvaluationFormArn: string | undefined;
|
|
4057
4152
|
/**
|
|
4058
|
-
* @public
|
|
4059
4153
|
* <p>A title of the evaluation form.</p>
|
|
4154
|
+
* @public
|
|
4060
4155
|
*/
|
|
4061
4156
|
Title: string | undefined;
|
|
4062
4157
|
/**
|
|
4063
|
-
* @public
|
|
4064
4158
|
* <p>The description of the evaluation form.</p>
|
|
4159
|
+
* @public
|
|
4065
4160
|
*/
|
|
4066
4161
|
Description?: string;
|
|
4067
4162
|
/**
|
|
4068
|
-
* @public
|
|
4069
4163
|
* <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
|
|
4164
|
+
* @public
|
|
4070
4165
|
*/
|
|
4071
4166
|
Items: EvaluationFormItem[] | undefined;
|
|
4072
4167
|
/**
|
|
4073
|
-
* @public
|
|
4074
4168
|
* <p>A scoring strategy of the evaluation form.</p>
|
|
4169
|
+
* @public
|
|
4075
4170
|
*/
|
|
4076
4171
|
ScoringStrategy?: EvaluationFormScoringStrategy;
|
|
4077
4172
|
}
|
|
4078
4173
|
/**
|
|
4079
|
-
* @public
|
|
4080
4174
|
* <p>The search criteria to be used to return hours of operations.</p>
|
|
4175
|
+
* @public
|
|
4081
4176
|
*/
|
|
4082
4177
|
export interface HoursOfOperationSearchCriteria {
|
|
4083
4178
|
/**
|
|
4084
|
-
* @public
|
|
4085
4179
|
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
4180
|
+
* @public
|
|
4086
4181
|
*/
|
|
4087
4182
|
OrConditions?: HoursOfOperationSearchCriteria[];
|
|
4088
4183
|
/**
|
|
4089
|
-
* @public
|
|
4090
4184
|
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
4185
|
+
* @public
|
|
4091
4186
|
*/
|
|
4092
4187
|
AndConditions?: HoursOfOperationSearchCriteria[];
|
|
4093
4188
|
/**
|
|
4094
|
-
* @public
|
|
4095
4189
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
4096
4190
|
* <note>
|
|
4097
4191
|
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
4098
4192
|
* <code>description</code>, <code>timezone</code>, and <code>resourceID</code>.</p>
|
|
4099
4193
|
* </note>
|
|
4194
|
+
* @public
|
|
4100
4195
|
*/
|
|
4101
4196
|
StringCondition?: StringCondition;
|
|
4102
4197
|
}
|
|
4103
4198
|
/**
|
|
4104
|
-
* @public
|
|
4105
4199
|
* <p>The search criteria to be used to return predefined attributes.</p>
|
|
4200
|
+
* @public
|
|
4106
4201
|
*/
|
|
4107
4202
|
export interface PredefinedAttributeSearchCriteria {
|
|
4108
4203
|
/**
|
|
4109
|
-
* @public
|
|
4110
4204
|
* <p>A list of conditions which would be applied together with an <code>OR</code>
|
|
4111
4205
|
* condition.</p>
|
|
4206
|
+
* @public
|
|
4112
4207
|
*/
|
|
4113
4208
|
OrConditions?: PredefinedAttributeSearchCriteria[];
|
|
4114
4209
|
/**
|
|
4115
|
-
* @public
|
|
4116
4210
|
* <p>A list of conditions which would be applied together with an <code>AND</code>
|
|
4117
4211
|
* condition.</p>
|
|
4212
|
+
* @public
|
|
4118
4213
|
*/
|
|
4119
4214
|
AndConditions?: PredefinedAttributeSearchCriteria[];
|
|
4120
4215
|
/**
|
|
4121
|
-
* @public
|
|
4122
4216
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
4123
4217
|
* <note>
|
|
4124
4218
|
* <p>The currently supported values for <code>FieldName</code> are <code>name</code> and
|
|
4125
4219
|
* <code>description</code>.</p>
|
|
4126
4220
|
* </note>
|
|
4221
|
+
* @public
|
|
4127
4222
|
*/
|
|
4128
4223
|
StringCondition?: StringCondition;
|
|
4129
4224
|
}
|
|
4130
4225
|
/**
|
|
4131
|
-
* @public
|
|
4132
4226
|
* <p>The search criteria to be used to return prompts.</p>
|
|
4227
|
+
* @public
|
|
4133
4228
|
*/
|
|
4134
4229
|
export interface PromptSearchCriteria {
|
|
4135
4230
|
/**
|
|
4136
|
-
* @public
|
|
4137
4231
|
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
4232
|
+
* @public
|
|
4138
4233
|
*/
|
|
4139
4234
|
OrConditions?: PromptSearchCriteria[];
|
|
4140
4235
|
/**
|
|
4141
|
-
* @public
|
|
4142
4236
|
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
4237
|
+
* @public
|
|
4143
4238
|
*/
|
|
4144
4239
|
AndConditions?: PromptSearchCriteria[];
|
|
4145
4240
|
/**
|
|
4146
|
-
* @public
|
|
4147
4241
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
4148
4242
|
* <note>
|
|
4149
4243
|
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
4150
4244
|
* <code>description</code>, and <code>resourceID</code>.</p>
|
|
4151
4245
|
* </note>
|
|
4246
|
+
* @public
|
|
4152
4247
|
*/
|
|
4153
4248
|
StringCondition?: StringCondition;
|
|
4154
4249
|
}
|
|
4155
4250
|
/**
|
|
4156
|
-
* @public
|
|
4157
4251
|
* <p>The search criteria to be used to return queues.</p>
|
|
4158
4252
|
* <note>
|
|
4159
4253
|
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
4160
4254
|
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
4161
4255
|
* outside of this range will throw invalid results. </p>
|
|
4162
4256
|
* </note>
|
|
4257
|
+
* @public
|
|
4163
4258
|
*/
|
|
4164
4259
|
export interface QueueSearchCriteria {
|
|
4165
4260
|
/**
|
|
4166
|
-
* @public
|
|
4167
4261
|
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
4262
|
+
* @public
|
|
4168
4263
|
*/
|
|
4169
4264
|
OrConditions?: QueueSearchCriteria[];
|
|
4170
4265
|
/**
|
|
4171
|
-
* @public
|
|
4172
4266
|
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
4267
|
+
* @public
|
|
4173
4268
|
*/
|
|
4174
4269
|
AndConditions?: QueueSearchCriteria[];
|
|
4175
4270
|
/**
|
|
4176
|
-
* @public
|
|
4177
4271
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
4178
4272
|
* <note>
|
|
4179
4273
|
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
4180
4274
|
* <code>description</code>, and <code>resourceID</code>.</p>
|
|
4181
4275
|
* </note>
|
|
4276
|
+
* @public
|
|
4182
4277
|
*/
|
|
4183
4278
|
StringCondition?: StringCondition;
|
|
4184
4279
|
/**
|
|
4185
|
-
* @public
|
|
4186
4280
|
* <p>The type of queue.</p>
|
|
4281
|
+
* @public
|
|
4187
4282
|
*/
|
|
4188
4283
|
QueueTypeCondition?: SearchableQueueType;
|
|
4189
4284
|
}
|
|
4190
4285
|
/**
|
|
4191
|
-
* @public
|
|
4192
4286
|
* <p>The search criteria to be used to return quick connects.</p>
|
|
4287
|
+
* @public
|
|
4193
4288
|
*/
|
|
4194
4289
|
export interface QuickConnectSearchCriteria {
|
|
4195
4290
|
/**
|
|
4196
|
-
* @public
|
|
4197
4291
|
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
4292
|
+
* @public
|
|
4198
4293
|
*/
|
|
4199
4294
|
OrConditions?: QuickConnectSearchCriteria[];
|
|
4200
4295
|
/**
|
|
4201
|
-
* @public
|
|
4202
4296
|
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
4297
|
+
* @public
|
|
4203
4298
|
*/
|
|
4204
4299
|
AndConditions?: QuickConnectSearchCriteria[];
|
|
4205
4300
|
/**
|
|
4206
|
-
* @public
|
|
4207
4301
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
4208
4302
|
* <note>
|
|
4209
4303
|
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
4210
4304
|
* <code>description</code>, and <code>resourceID</code>.</p>
|
|
4211
4305
|
* </note>
|
|
4306
|
+
* @public
|
|
4212
4307
|
*/
|
|
4213
4308
|
StringCondition?: StringCondition;
|
|
4214
4309
|
}
|
|
4215
4310
|
/**
|
|
4216
|
-
* @public
|
|
4217
4311
|
* <p>The search criteria to be used to return routing profiles.</p>
|
|
4218
4312
|
* <note>
|
|
4219
4313
|
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
4220
4314
|
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
4221
4315
|
* outside of this range will throw invalid results. </p>
|
|
4222
4316
|
* </note>
|
|
4317
|
+
* @public
|
|
4223
4318
|
*/
|
|
4224
4319
|
export interface RoutingProfileSearchCriteria {
|
|
4225
4320
|
/**
|
|
4226
|
-
* @public
|
|
4227
4321
|
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
4322
|
+
* @public
|
|
4228
4323
|
*/
|
|
4229
4324
|
OrConditions?: RoutingProfileSearchCriteria[];
|
|
4230
4325
|
/**
|
|
4231
|
-
* @public
|
|
4232
4326
|
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
4327
|
+
* @public
|
|
4233
4328
|
*/
|
|
4234
4329
|
AndConditions?: RoutingProfileSearchCriteria[];
|
|
4235
4330
|
/**
|
|
4236
|
-
* @public
|
|
4237
4331
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
4238
4332
|
* <note>
|
|
4239
4333
|
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
4240
4334
|
* <code>description</code>, and <code>resourceID</code>.</p>
|
|
4241
4335
|
* </note>
|
|
4336
|
+
* @public
|
|
4242
4337
|
*/
|
|
4243
4338
|
StringCondition?: StringCondition;
|
|
4244
4339
|
}
|
|
4245
4340
|
/**
|
|
4246
|
-
* @public
|
|
4247
4341
|
* <p>The search criteria to be used to return security profiles.</p>
|
|
4248
4342
|
* <note>
|
|
4249
4343
|
* <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and
|
|
4250
4344
|
* maximum of 25 characters. Any queries with character lengths outside of this range will throw
|
|
4251
4345
|
* invalid results.</p>
|
|
4252
4346
|
* </note>
|
|
4347
|
+
* @public
|
|
4253
4348
|
*/
|
|
4254
4349
|
export interface SecurityProfileSearchCriteria {
|
|
4255
4350
|
/**
|
|
4256
|
-
* @public
|
|
4257
4351
|
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
4352
|
+
* @public
|
|
4258
4353
|
*/
|
|
4259
4354
|
OrConditions?: SecurityProfileSearchCriteria[];
|
|
4260
4355
|
/**
|
|
4261
|
-
* @public
|
|
4262
4356
|
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
4357
|
+
* @public
|
|
4263
4358
|
*/
|
|
4264
4359
|
AndConditions?: SecurityProfileSearchCriteria[];
|
|
4265
4360
|
/**
|
|
4266
|
-
* @public
|
|
4267
4361
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
4268
4362
|
* <note>
|
|
4269
4363
|
* <p>The currently supported values for <code>FieldName</code> are <code>name</code> and
|
|
4270
4364
|
* <code>description</code>.</p>
|
|
4271
4365
|
* </note>
|
|
4366
|
+
* @public
|
|
4272
4367
|
*/
|
|
4273
4368
|
StringCondition?: StringCondition;
|
|
4274
4369
|
}
|
|
@@ -4277,87 +4372,87 @@ export interface SecurityProfileSearchCriteria {
|
|
|
4277
4372
|
*/
|
|
4278
4373
|
export interface UpdateEvaluationFormRequest {
|
|
4279
4374
|
/**
|
|
4280
|
-
* @public
|
|
4281
4375
|
* <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>
|
|
4376
|
+
* @public
|
|
4282
4377
|
*/
|
|
4283
4378
|
InstanceId: string | undefined;
|
|
4284
4379
|
/**
|
|
4285
|
-
* @public
|
|
4286
4380
|
* <p>The unique identifier for the evaluation form.</p>
|
|
4381
|
+
* @public
|
|
4287
4382
|
*/
|
|
4288
4383
|
EvaluationFormId: string | undefined;
|
|
4289
4384
|
/**
|
|
4290
|
-
* @public
|
|
4291
4385
|
* <p>A version of the evaluation form to update.</p>
|
|
4386
|
+
* @public
|
|
4292
4387
|
*/
|
|
4293
4388
|
EvaluationFormVersion: number | undefined;
|
|
4294
4389
|
/**
|
|
4295
|
-
* @public
|
|
4296
4390
|
* <p>A flag indicating whether the operation must create a new version.</p>
|
|
4391
|
+
* @public
|
|
4297
4392
|
*/
|
|
4298
4393
|
CreateNewVersion?: boolean;
|
|
4299
4394
|
/**
|
|
4300
|
-
* @public
|
|
4301
4395
|
* <p>A title of the evaluation form.</p>
|
|
4396
|
+
* @public
|
|
4302
4397
|
*/
|
|
4303
4398
|
Title: string | undefined;
|
|
4304
4399
|
/**
|
|
4305
|
-
* @public
|
|
4306
4400
|
* <p>The description of the evaluation form.</p>
|
|
4401
|
+
* @public
|
|
4307
4402
|
*/
|
|
4308
4403
|
Description?: string;
|
|
4309
4404
|
/**
|
|
4310
|
-
* @public
|
|
4311
4405
|
* <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
|
|
4406
|
+
* @public
|
|
4312
4407
|
*/
|
|
4313
4408
|
Items: EvaluationFormItem[] | undefined;
|
|
4314
4409
|
/**
|
|
4315
|
-
* @public
|
|
4316
4410
|
* <p>A scoring strategy of the evaluation form.</p>
|
|
4411
|
+
* @public
|
|
4317
4412
|
*/
|
|
4318
4413
|
ScoringStrategy?: EvaluationFormScoringStrategy;
|
|
4319
4414
|
/**
|
|
4320
|
-
* @public
|
|
4321
4415
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
4322
4416
|
* request. If not provided, the Amazon Web Services
|
|
4323
4417
|
* SDK populates this field. For more information about idempotency, see
|
|
4324
4418
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
4419
|
+
* @public
|
|
4325
4420
|
*/
|
|
4326
4421
|
ClientToken?: string;
|
|
4327
4422
|
}
|
|
4328
4423
|
/**
|
|
4329
|
-
* @public
|
|
4330
4424
|
* <p>The search criteria to be used to return users.</p>
|
|
4331
4425
|
* <note>
|
|
4332
4426
|
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
4333
4427
|
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
4334
4428
|
* outside of this range will throw invalid results. </p>
|
|
4335
4429
|
* </note>
|
|
4430
|
+
* @public
|
|
4336
4431
|
*/
|
|
4337
4432
|
export interface UserSearchCriteria {
|
|
4338
4433
|
/**
|
|
4339
|
-
* @public
|
|
4340
4434
|
* <p>A list of conditions which would be applied together with an <code>OR</code>
|
|
4341
4435
|
* condition.</p>
|
|
4436
|
+
* @public
|
|
4342
4437
|
*/
|
|
4343
4438
|
OrConditions?: UserSearchCriteria[];
|
|
4344
4439
|
/**
|
|
4345
|
-
* @public
|
|
4346
4440
|
* <p>A list of conditions which would be applied together with an <code>AND</code> condition.
|
|
4347
4441
|
* </p>
|
|
4442
|
+
* @public
|
|
4348
4443
|
*/
|
|
4349
4444
|
AndConditions?: UserSearchCriteria[];
|
|
4350
4445
|
/**
|
|
4351
|
-
* @public
|
|
4352
4446
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
4353
4447
|
* <p>The currently supported values for <code>FieldName</code> are <code>Username</code>,
|
|
4354
4448
|
* <code>FirstName</code>, <code>LastName</code>, <code>RoutingProfileId</code>,
|
|
4355
4449
|
* <code>SecurityProfileId</code>, <code>ResourceId</code>.</p>
|
|
4450
|
+
* @public
|
|
4356
4451
|
*/
|
|
4357
4452
|
StringCondition?: StringCondition;
|
|
4358
4453
|
/**
|
|
4359
|
-
* @public
|
|
4360
4454
|
* <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
|
|
4455
|
+
* @public
|
|
4361
4456
|
*/
|
|
4362
4457
|
HierarchyGroupCondition?: HierarchyGroupCondition;
|
|
4363
4458
|
}
|
|
@@ -4366,13 +4461,13 @@ export interface UserSearchCriteria {
|
|
|
4366
4461
|
*/
|
|
4367
4462
|
export interface DescribeContactEvaluationResponse {
|
|
4368
4463
|
/**
|
|
4369
|
-
* @public
|
|
4370
4464
|
* <p>Information about the evaluation form completed for a specific contact.</p>
|
|
4465
|
+
* @public
|
|
4371
4466
|
*/
|
|
4372
4467
|
Evaluation: Evaluation | undefined;
|
|
4373
4468
|
/**
|
|
4374
|
-
* @public
|
|
4375
4469
|
* <p>Information about the evaluation form.</p>
|
|
4470
|
+
* @public
|
|
4376
4471
|
*/
|
|
4377
4472
|
EvaluationForm: EvaluationFormContent | undefined;
|
|
4378
4473
|
}
|
|
@@ -4381,8 +4476,8 @@ export interface DescribeContactEvaluationResponse {
|
|
|
4381
4476
|
*/
|
|
4382
4477
|
export interface DescribeEvaluationFormResponse {
|
|
4383
4478
|
/**
|
|
4384
|
-
* @public
|
|
4385
4479
|
* <p>Information about the evaluation form.</p>
|
|
4480
|
+
* @public
|
|
4386
4481
|
*/
|
|
4387
4482
|
EvaluationForm: EvaluationForm | undefined;
|
|
4388
4483
|
}
|
|
@@ -4391,29 +4486,29 @@ export interface DescribeEvaluationFormResponse {
|
|
|
4391
4486
|
*/
|
|
4392
4487
|
export interface SearchHoursOfOperationsRequest {
|
|
4393
4488
|
/**
|
|
4394
|
-
* @public
|
|
4395
4489
|
* <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>
|
|
4490
|
+
* @public
|
|
4396
4491
|
*/
|
|
4397
4492
|
InstanceId: string | undefined;
|
|
4398
4493
|
/**
|
|
4399
|
-
* @public
|
|
4400
4494
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
4401
4495
|
* response in the next request to retrieve the next set of results.</p>
|
|
4496
|
+
* @public
|
|
4402
4497
|
*/
|
|
4403
4498
|
NextToken?: string;
|
|
4404
4499
|
/**
|
|
4405
|
-
* @public
|
|
4406
4500
|
* <p>The maximum number of results to return per page.</p>
|
|
4501
|
+
* @public
|
|
4407
4502
|
*/
|
|
4408
4503
|
MaxResults?: number;
|
|
4409
4504
|
/**
|
|
4410
|
-
* @public
|
|
4411
4505
|
* <p>Filters to be applied to search results.</p>
|
|
4506
|
+
* @public
|
|
4412
4507
|
*/
|
|
4413
4508
|
SearchFilter?: HoursOfOperationSearchFilter;
|
|
4414
4509
|
/**
|
|
4415
|
-
* @public
|
|
4416
4510
|
* <p>The search criteria to be used to return hours of operations.</p>
|
|
4511
|
+
* @public
|
|
4417
4512
|
*/
|
|
4418
4513
|
SearchCriteria?: HoursOfOperationSearchCriteria;
|
|
4419
4514
|
}
|
|
@@ -4422,25 +4517,25 @@ export interface SearchHoursOfOperationsRequest {
|
|
|
4422
4517
|
*/
|
|
4423
4518
|
export interface SearchPredefinedAttributesRequest {
|
|
4424
4519
|
/**
|
|
4425
|
-
* @public
|
|
4426
4520
|
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
|
|
4427
4521
|
* Name (ARN) of the instance.</p>
|
|
4522
|
+
* @public
|
|
4428
4523
|
*/
|
|
4429
4524
|
InstanceId: string | undefined;
|
|
4430
4525
|
/**
|
|
4431
|
-
* @public
|
|
4432
4526
|
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
4433
4527
|
* the next request to retrieve the next set of results.</p>
|
|
4528
|
+
* @public
|
|
4434
4529
|
*/
|
|
4435
4530
|
NextToken?: string;
|
|
4436
4531
|
/**
|
|
4437
|
-
* @public
|
|
4438
4532
|
* <p>The maximum number of results to return per page.</p>
|
|
4533
|
+
* @public
|
|
4439
4534
|
*/
|
|
4440
4535
|
MaxResults?: number;
|
|
4441
4536
|
/**
|
|
4442
|
-
* @public
|
|
4443
4537
|
* <p>The search criteria to be used to return predefined attributes.</p>
|
|
4538
|
+
* @public
|
|
4444
4539
|
*/
|
|
4445
4540
|
SearchCriteria?: PredefinedAttributeSearchCriteria;
|
|
4446
4541
|
}
|
|
@@ -4449,29 +4544,29 @@ export interface SearchPredefinedAttributesRequest {
|
|
|
4449
4544
|
*/
|
|
4450
4545
|
export interface SearchPromptsRequest {
|
|
4451
4546
|
/**
|
|
4452
|
-
* @public
|
|
4453
4547
|
* <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>
|
|
4548
|
+
* @public
|
|
4454
4549
|
*/
|
|
4455
4550
|
InstanceId: string | undefined;
|
|
4456
4551
|
/**
|
|
4457
|
-
* @public
|
|
4458
4552
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
4459
4553
|
* response in the next request to retrieve the next set of results.</p>
|
|
4554
|
+
* @public
|
|
4460
4555
|
*/
|
|
4461
4556
|
NextToken?: string;
|
|
4462
4557
|
/**
|
|
4463
|
-
* @public
|
|
4464
4558
|
* <p>The maximum number of results to return per page.</p>
|
|
4559
|
+
* @public
|
|
4465
4560
|
*/
|
|
4466
4561
|
MaxResults?: number;
|
|
4467
4562
|
/**
|
|
4468
|
-
* @public
|
|
4469
4563
|
* <p>Filters to be applied to search results.</p>
|
|
4564
|
+
* @public
|
|
4470
4565
|
*/
|
|
4471
4566
|
SearchFilter?: PromptSearchFilter;
|
|
4472
4567
|
/**
|
|
4473
|
-
* @public
|
|
4474
4568
|
* <p>The search criteria to be used to return prompts.</p>
|
|
4569
|
+
* @public
|
|
4475
4570
|
*/
|
|
4476
4571
|
SearchCriteria?: PromptSearchCriteria;
|
|
4477
4572
|
}
|
|
@@ -4480,34 +4575,34 @@ export interface SearchPromptsRequest {
|
|
|
4480
4575
|
*/
|
|
4481
4576
|
export interface SearchQueuesRequest {
|
|
4482
4577
|
/**
|
|
4483
|
-
* @public
|
|
4484
4578
|
* <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>
|
|
4579
|
+
* @public
|
|
4485
4580
|
*/
|
|
4486
4581
|
InstanceId: string | undefined;
|
|
4487
4582
|
/**
|
|
4488
|
-
* @public
|
|
4489
4583
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
4490
4584
|
* response in the next request to retrieve the next set of results.</p>
|
|
4585
|
+
* @public
|
|
4491
4586
|
*/
|
|
4492
4587
|
NextToken?: string;
|
|
4493
4588
|
/**
|
|
4494
|
-
* @public
|
|
4495
4589
|
* <p>The maximum number of results to return per page.</p>
|
|
4590
|
+
* @public
|
|
4496
4591
|
*/
|
|
4497
4592
|
MaxResults?: number;
|
|
4498
4593
|
/**
|
|
4499
|
-
* @public
|
|
4500
4594
|
* <p>Filters to be applied to search results.</p>
|
|
4595
|
+
* @public
|
|
4501
4596
|
*/
|
|
4502
4597
|
SearchFilter?: QueueSearchFilter;
|
|
4503
4598
|
/**
|
|
4504
|
-
* @public
|
|
4505
4599
|
* <p>The search criteria to be used to return queues.</p>
|
|
4506
4600
|
* <note>
|
|
4507
4601
|
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
4508
4602
|
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
4509
4603
|
* outside of this range will throw invalid results. </p>
|
|
4510
4604
|
* </note>
|
|
4605
|
+
* @public
|
|
4511
4606
|
*/
|
|
4512
4607
|
SearchCriteria?: QueueSearchCriteria;
|
|
4513
4608
|
}
|
|
@@ -4516,29 +4611,29 @@ export interface SearchQueuesRequest {
|
|
|
4516
4611
|
*/
|
|
4517
4612
|
export interface SearchQuickConnectsRequest {
|
|
4518
4613
|
/**
|
|
4519
|
-
* @public
|
|
4520
4614
|
* <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>
|
|
4615
|
+
* @public
|
|
4521
4616
|
*/
|
|
4522
4617
|
InstanceId: string | undefined;
|
|
4523
4618
|
/**
|
|
4524
|
-
* @public
|
|
4525
4619
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
4526
4620
|
* response in the next request to retrieve the next set of results.</p>
|
|
4621
|
+
* @public
|
|
4527
4622
|
*/
|
|
4528
4623
|
NextToken?: string;
|
|
4529
4624
|
/**
|
|
4530
|
-
* @public
|
|
4531
4625
|
* <p>The maximum number of results to return per page.</p>
|
|
4626
|
+
* @public
|
|
4532
4627
|
*/
|
|
4533
4628
|
MaxResults?: number;
|
|
4534
4629
|
/**
|
|
4535
|
-
* @public
|
|
4536
4630
|
* <p>Filters to be applied to search results.</p>
|
|
4631
|
+
* @public
|
|
4537
4632
|
*/
|
|
4538
4633
|
SearchFilter?: QuickConnectSearchFilter;
|
|
4539
4634
|
/**
|
|
4540
|
-
* @public
|
|
4541
4635
|
* <p>The search criteria to be used to return quick connects.</p>
|
|
4636
|
+
* @public
|
|
4542
4637
|
*/
|
|
4543
4638
|
SearchCriteria?: QuickConnectSearchCriteria;
|
|
4544
4639
|
}
|
|
@@ -4547,34 +4642,34 @@ export interface SearchQuickConnectsRequest {
|
|
|
4547
4642
|
*/
|
|
4548
4643
|
export interface SearchRoutingProfilesRequest {
|
|
4549
4644
|
/**
|
|
4550
|
-
* @public
|
|
4551
4645
|
* <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>
|
|
4646
|
+
* @public
|
|
4552
4647
|
*/
|
|
4553
4648
|
InstanceId: string | undefined;
|
|
4554
4649
|
/**
|
|
4555
|
-
* @public
|
|
4556
4650
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
4557
4651
|
* response in the next request to retrieve the next set of results.</p>
|
|
4652
|
+
* @public
|
|
4558
4653
|
*/
|
|
4559
4654
|
NextToken?: string;
|
|
4560
4655
|
/**
|
|
4561
|
-
* @public
|
|
4562
4656
|
* <p>The maximum number of results to return per page.</p>
|
|
4657
|
+
* @public
|
|
4563
4658
|
*/
|
|
4564
4659
|
MaxResults?: number;
|
|
4565
4660
|
/**
|
|
4566
|
-
* @public
|
|
4567
4661
|
* <p>Filters to be applied to search results.</p>
|
|
4662
|
+
* @public
|
|
4568
4663
|
*/
|
|
4569
4664
|
SearchFilter?: RoutingProfileSearchFilter;
|
|
4570
4665
|
/**
|
|
4571
|
-
* @public
|
|
4572
4666
|
* <p>The search criteria to be used to return routing profiles.</p>
|
|
4573
4667
|
* <note>
|
|
4574
4668
|
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
4575
4669
|
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
4576
4670
|
* outside of this range will throw invalid results. </p>
|
|
4577
4671
|
* </note>
|
|
4672
|
+
* @public
|
|
4578
4673
|
*/
|
|
4579
4674
|
SearchCriteria?: RoutingProfileSearchCriteria;
|
|
4580
4675
|
}
|
|
@@ -4583,23 +4678,22 @@ export interface SearchRoutingProfilesRequest {
|
|
|
4583
4678
|
*/
|
|
4584
4679
|
export interface SearchSecurityProfilesRequest {
|
|
4585
4680
|
/**
|
|
4586
|
-
* @public
|
|
4587
4681
|
* <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>
|
|
4682
|
+
* @public
|
|
4588
4683
|
*/
|
|
4589
4684
|
InstanceId: string | undefined;
|
|
4590
4685
|
/**
|
|
4591
|
-
* @public
|
|
4592
4686
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
4593
4687
|
* response in the next request to retrieve the next set of results.</p>
|
|
4688
|
+
* @public
|
|
4594
4689
|
*/
|
|
4595
4690
|
NextToken?: string;
|
|
4596
4691
|
/**
|
|
4597
|
-
* @public
|
|
4598
4692
|
* <p>The maximum number of results to return per page.</p>
|
|
4693
|
+
* @public
|
|
4599
4694
|
*/
|
|
4600
4695
|
MaxResults?: number;
|
|
4601
4696
|
/**
|
|
4602
|
-
* @public
|
|
4603
4697
|
* <p>The search criteria to be used to return security profiles. </p>
|
|
4604
4698
|
* <note>
|
|
4605
4699
|
* <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and
|
|
@@ -4610,11 +4704,12 @@ export interface SearchSecurityProfilesRequest {
|
|
|
4610
4704
|
* <p>The currently supported value for <code>FieldName</code>: <code>name</code>
|
|
4611
4705
|
* </p>
|
|
4612
4706
|
* </note>
|
|
4707
|
+
* @public
|
|
4613
4708
|
*/
|
|
4614
4709
|
SearchCriteria?: SecurityProfileSearchCriteria;
|
|
4615
4710
|
/**
|
|
4616
|
-
* @public
|
|
4617
4711
|
* <p>Filters to be applied to search results.</p>
|
|
4712
|
+
* @public
|
|
4618
4713
|
*/
|
|
4619
4714
|
SearchFilter?: SecurityProfilesSearchFilter;
|
|
4620
4715
|
}
|
|
@@ -4623,37 +4718,37 @@ export interface SearchSecurityProfilesRequest {
|
|
|
4623
4718
|
*/
|
|
4624
4719
|
export interface SearchUsersRequest {
|
|
4625
4720
|
/**
|
|
4626
|
-
* @public
|
|
4627
4721
|
* <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>
|
|
4628
4722
|
* <note>
|
|
4629
4723
|
* <p>InstanceID is a required field. The "Required: No" below is incorrect.</p>
|
|
4630
4724
|
* </note>
|
|
4725
|
+
* @public
|
|
4631
4726
|
*/
|
|
4632
4727
|
InstanceId: string | undefined;
|
|
4633
4728
|
/**
|
|
4634
|
-
* @public
|
|
4635
4729
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
4636
4730
|
* response in the next request to retrieve the next set of results.</p>
|
|
4731
|
+
* @public
|
|
4637
4732
|
*/
|
|
4638
4733
|
NextToken?: string;
|
|
4639
4734
|
/**
|
|
4640
|
-
* @public
|
|
4641
4735
|
* <p>The maximum number of results to return per page.</p>
|
|
4736
|
+
* @public
|
|
4642
4737
|
*/
|
|
4643
4738
|
MaxResults?: number;
|
|
4644
4739
|
/**
|
|
4645
|
-
* @public
|
|
4646
4740
|
* <p>Filters to be applied to search results.</p>
|
|
4741
|
+
* @public
|
|
4647
4742
|
*/
|
|
4648
4743
|
SearchFilter?: UserSearchFilter;
|
|
4649
4744
|
/**
|
|
4650
|
-
* @public
|
|
4651
4745
|
* <p>The search criteria to be used to return users.</p>
|
|
4652
4746
|
* <note>
|
|
4653
4747
|
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
4654
4748
|
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
4655
4749
|
* outside of this range will throw invalid results. </p>
|
|
4656
4750
|
* </note>
|
|
4751
|
+
* @public
|
|
4657
4752
|
*/
|
|
4658
4753
|
SearchCriteria?: UserSearchCriteria;
|
|
4659
4754
|
}
|