@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonConnect extends Object implements AmazonConnect
AmazonConnect
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
ActivateEvaluationFormResult |
activateEvaluationForm(ActivateEvaluationFormRequest request)
Activates an evaluation form in the specified Amazon Connect instance.
|
AssociateAnalyticsDataSetResult |
associateAnalyticsDataSet(AssociateAnalyticsDataSetRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateApprovedOriginResult |
associateApprovedOrigin(AssociateApprovedOriginRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateBotResult |
associateBot(AssociateBotRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateDefaultVocabularyResult |
associateDefaultVocabulary(AssociateDefaultVocabularyRequest request)
Associates an existing vocabulary as the default.
|
AssociateFlowResult |
associateFlow(AssociateFlowRequest request)
Associates a connect resource to a flow.
|
AssociateInstanceStorageConfigResult |
associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateLambdaFunctionResult |
associateLambdaFunction(AssociateLambdaFunctionRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateLexBotResult |
associateLexBot(AssociateLexBotRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociatePhoneNumberContactFlowResult |
associatePhoneNumberContactFlow(AssociatePhoneNumberContactFlowRequest request)
Associates a flow with a phone number claimed to your Amazon Connect instance.
|
AssociateQueueQuickConnectsResult |
associateQueueQuickConnects(AssociateQueueQuickConnectsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateRoutingProfileQueuesResult |
associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest request)
Associates a set of queues with a routing profile.
|
AssociateSecurityKeyResult |
associateSecurityKey(AssociateSecurityKeyRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
AssociateTrafficDistributionGroupUserResult |
associateTrafficDistributionGroupUser(AssociateTrafficDistributionGroupUserRequest request)
Associates an agent with a traffic distribution group.
|
AssociateUserProficienciesResult |
associateUserProficiencies(AssociateUserProficienciesRequest request)
>Associates a set of proficiencies with a user.
|
BatchAssociateAnalyticsDataSetResult |
batchAssociateAnalyticsDataSet(BatchAssociateAnalyticsDataSetRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
BatchDisassociateAnalyticsDataSetResult |
batchDisassociateAnalyticsDataSet(BatchDisassociateAnalyticsDataSetRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
BatchGetAttachedFileMetadataResult |
batchGetAttachedFileMetadata(BatchGetAttachedFileMetadataRequest request)
Allows you to retrieve metadata about multiple attached files on an associated resource.
|
BatchGetFlowAssociationResult |
batchGetFlowAssociation(BatchGetFlowAssociationRequest request)
Retrieve the flow associations for the given resources.
|
BatchPutContactResult |
batchPutContact(BatchPutContactRequest request)
|
ClaimPhoneNumberResult |
claimPhoneNumber(ClaimPhoneNumberRequest request)
Claims an available phone number to your Amazon Connect instance or traffic distribution group.
|
CompleteAttachedFileUploadResult |
completeAttachedFileUpload(CompleteAttachedFileUploadRequest request)
Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the
StartAttachedFileUpload API.
|
CreateAgentStatusResult |
createAgentStatus(CreateAgentStatusRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateContactFlowResult |
createContactFlow(CreateContactFlowRequest request)
Creates a flow for the specified Amazon Connect instance.
|
CreateContactFlowModuleResult |
createContactFlowModule(CreateContactFlowModuleRequest request)
Creates a flow module for the specified Amazon Connect instance.
|
CreateEvaluationFormResult |
createEvaluationForm(CreateEvaluationFormRequest request)
Creates an evaluation form in the specified Amazon Connect instance.
|
CreateHoursOfOperationResult |
createHoursOfOperation(CreateHoursOfOperationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateInstanceResult |
createInstance(CreateInstanceRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateIntegrationAssociationResult |
createIntegrationAssociation(CreateIntegrationAssociationRequest request)
Creates an Amazon Web Services resource association with an Amazon Connect instance.
|
CreateParticipantResult |
createParticipant(CreateParticipantRequest request)
Adds a new participant into an on-going chat contact.
|
CreatePersistentContactAssociationResult |
createPersistentContactAssociation(CreatePersistentContactAssociationRequest request)
Enables rehydration of chats for the lifespan of a contact.
|
CreatePredefinedAttributeResult |
createPredefinedAttribute(CreatePredefinedAttributeRequest request)
Creates a new predefined attribute for the specified Amazon Connect instance.
|
CreatePromptResult |
createPrompt(CreatePromptRequest request)
Creates a prompt.
|
CreateQueueResult |
createQueue(CreateQueueRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
CreateQuickConnectResult |
createQuickConnect(CreateQuickConnectRequest request)
Creates a quick connect for the specified Amazon Connect instance.
|
CreateRoutingProfileResult |
createRoutingProfile(CreateRoutingProfileRequest request)
Creates a new routing profile.
|
CreateRuleResult |
createRule(CreateRuleRequest request)
Creates a rule for the specified Amazon Connect instance.
|
CreateSecurityProfileResult |
createSecurityProfile(CreateSecurityProfileRequest request)
Creates a security profile.
|
CreateTaskTemplateResult |
createTaskTemplate(CreateTaskTemplateRequest request)
Creates a new task template in the specified Amazon Connect instance.
|
CreateTrafficDistributionGroupResult |
createTrafficDistributionGroup(CreateTrafficDistributionGroupRequest request)
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
|
CreateUseCaseResult |
createUseCase(CreateUseCaseRequest request)
Creates a use case for an integration association.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a user account for the specified Amazon Connect instance.
|
CreateUserHierarchyGroupResult |
createUserHierarchyGroup(CreateUserHierarchyGroupRequest request)
Creates a new user hierarchy group.
|
CreateViewResult |
createView(CreateViewRequest request)
Creates a new view with the possible status of
SAVED or PUBLISHED . |
CreateViewVersionResult |
createViewVersion(CreateViewVersionRequest request)
Publishes a new version of the view identifier.
|
CreateVocabularyResult |
createVocabulary(CreateVocabularyRequest request)
Creates a custom vocabulary associated with your Amazon Connect instance.
|
DeactivateEvaluationFormResult |
deactivateEvaluationForm(DeactivateEvaluationFormRequest request)
Deactivates an evaluation form in the specified Amazon Connect instance.
|
DeleteAttachedFileResult |
deleteAttachedFile(DeleteAttachedFileRequest request)
Deletes an attached file along with the underlying S3 Object.
|
DeleteContactEvaluationResult |
deleteContactEvaluation(DeleteContactEvaluationRequest request)
Deletes a contact evaluation in the specified Amazon Connect instance.
|
DeleteContactFlowResult |
deleteContactFlow(DeleteContactFlowRequest request)
Deletes a flow for the specified Amazon Connect instance.
|
DeleteContactFlowModuleResult |
deleteContactFlowModule(DeleteContactFlowModuleRequest request)
Deletes the specified flow module.
|
DeleteEvaluationFormResult |
deleteEvaluationForm(DeleteEvaluationFormRequest request)
Deletes an evaluation form in the specified Amazon Connect instance.
|
DeleteHoursOfOperationResult |
deleteHoursOfOperation(DeleteHoursOfOperationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DeleteInstanceResult |
deleteInstance(DeleteInstanceRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DeleteIntegrationAssociationResult |
deleteIntegrationAssociation(DeleteIntegrationAssociationRequest request)
Deletes an Amazon Web Services resource association from an Amazon Connect instance.
|
DeletePredefinedAttributeResult |
deletePredefinedAttribute(DeletePredefinedAttributeRequest request)
Deletes a predefined attribute from the specified Amazon Connect instance.
|
DeletePromptResult |
deletePrompt(DeletePromptRequest request)
Deletes a prompt.
|
DeleteQueueResult |
deleteQueue(DeleteQueueRequest request)
Deletes a queue.
|
DeleteQuickConnectResult |
deleteQuickConnect(DeleteQuickConnectRequest request)
Deletes a quick connect.
|
DeleteRoutingProfileResult |
deleteRoutingProfile(DeleteRoutingProfileRequest request)
Deletes a routing profile.
|
DeleteRuleResult |
deleteRule(DeleteRuleRequest request)
Deletes a rule for the specified Amazon Connect instance.
|
DeleteSecurityProfileResult |
deleteSecurityProfile(DeleteSecurityProfileRequest request)
Deletes a security profile.
|
DeleteTaskTemplateResult |
deleteTaskTemplate(DeleteTaskTemplateRequest request)
Deletes the task template.
|
DeleteTrafficDistributionGroupResult |
deleteTrafficDistributionGroup(DeleteTrafficDistributionGroupRequest request)
Deletes a traffic distribution group.
|
DeleteUseCaseResult |
deleteUseCase(DeleteUseCaseRequest request)
Deletes a use case from an integration association.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes a user account from the specified Amazon Connect instance.
|
DeleteUserHierarchyGroupResult |
deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest request)
Deletes an existing user hierarchy group.
|
DeleteViewResult |
deleteView(DeleteViewRequest request)
Deletes the view entirely.
|
DeleteViewVersionResult |
deleteViewVersion(DeleteViewVersionRequest request)
Deletes the particular version specified in
ViewVersion identifier. |
DeleteVocabularyResult |
deleteVocabulary(DeleteVocabularyRequest request)
Deletes the vocabulary that has the given identifier.
|
DescribeAgentStatusResult |
describeAgentStatus(DescribeAgentStatusRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeAuthenticationProfileResult |
describeAuthenticationProfile(DescribeAuthenticationProfileRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeContactResult |
describeContact(DescribeContactRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeContactEvaluationResult |
describeContactEvaluation(DescribeContactEvaluationRequest request)
Describes a contact evaluation in the specified Amazon Connect instance.
|
DescribeContactFlowResult |
describeContactFlow(DescribeContactFlowRequest request)
Describes the specified flow.
|
DescribeContactFlowModuleResult |
describeContactFlowModule(DescribeContactFlowModuleRequest request)
Describes the specified flow module.
|
DescribeEvaluationFormResult |
describeEvaluationForm(DescribeEvaluationFormRequest request)
Describes an evaluation form in the specified Amazon Connect instance.
|
DescribeHoursOfOperationResult |
describeHoursOfOperation(DescribeHoursOfOperationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeInstanceResult |
describeInstance(DescribeInstanceRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeInstanceAttributeResult |
describeInstanceAttribute(DescribeInstanceAttributeRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeInstanceStorageConfigResult |
describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribePhoneNumberResult |
describePhoneNumber(DescribePhoneNumberRequest request)
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution
group.
|
DescribePredefinedAttributeResult |
describePredefinedAttribute(DescribePredefinedAttributeRequest request)
Describes a predefined attribute for the specified Amazon Connect instance.
|
DescribePromptResult |
describePrompt(DescribePromptRequest request)
Describes the prompt.
|
DescribeQueueResult |
describeQueue(DescribeQueueRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeQuickConnectResult |
describeQuickConnect(DescribeQuickConnectRequest request)
Describes the quick connect.
|
DescribeRoutingProfileResult |
describeRoutingProfile(DescribeRoutingProfileRequest request)
Describes the specified routing profile.
|
DescribeRuleResult |
describeRule(DescribeRuleRequest request)
Describes a rule for the specified Amazon Connect instance.
|
DescribeSecurityProfileResult |
describeSecurityProfile(DescribeSecurityProfileRequest request)
Gets basic information about the security profle.
|
DescribeTrafficDistributionGroupResult |
describeTrafficDistributionGroup(DescribeTrafficDistributionGroupRequest request)
Gets details and status of a traffic distribution group.
|
DescribeUserResult |
describeUser(DescribeUserRequest request)
Describes the specified user.
|
DescribeUserHierarchyGroupResult |
describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest request)
Describes the specified hierarchy group.
|
DescribeUserHierarchyStructureResult |
describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest request)
Describes the hierarchy structure of the specified Amazon Connect instance.
|
DescribeViewResult |
describeView(DescribeViewRequest request)
Retrieves the view for the specified Amazon Connect instance and view identifier.
|
DescribeVocabularyResult |
describeVocabulary(DescribeVocabularyRequest request)
Describes the specified vocabulary.
|
DisassociateAnalyticsDataSetResult |
disassociateAnalyticsDataSet(DisassociateAnalyticsDataSetRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateApprovedOriginResult |
disassociateApprovedOrigin(DisassociateApprovedOriginRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateBotResult |
disassociateBot(DisassociateBotRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateFlowResult |
disassociateFlow(DisassociateFlowRequest request)
Disassociates a connect resource from a flow.
|
DisassociateInstanceStorageConfigResult |
disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateLambdaFunctionResult |
disassociateLambdaFunction(DisassociateLambdaFunctionRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateLexBotResult |
disassociateLexBot(DisassociateLexBotRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociatePhoneNumberContactFlowResult |
disassociatePhoneNumberContactFlow(DisassociatePhoneNumberContactFlowRequest request)
Removes the flow association from a phone number claimed to your Amazon Connect instance.
|
DisassociateQueueQuickConnectsResult |
disassociateQueueQuickConnects(DisassociateQueueQuickConnectsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateRoutingProfileQueuesResult |
disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest request)
Disassociates a set of queues from a routing profile.
|
DisassociateSecurityKeyResult |
disassociateSecurityKey(DisassociateSecurityKeyRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DisassociateTrafficDistributionGroupUserResult |
disassociateTrafficDistributionGroupUser(DisassociateTrafficDistributionGroupUserRequest request)
Disassociates an agent from a traffic distribution group.
|
DisassociateUserProficienciesResult |
disassociateUserProficiencies(DisassociateUserProficienciesRequest request)
Disassociates a set of proficiencies from a user.
|
DismissUserContactResult |
dismissUserContact(DismissUserContactRequest request)
Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to
receive a new routed contact.
|
GetAttachedFileResult |
getAttachedFile(GetAttachedFileRequest request)
Provides a pre-signed URL for download of an approved attached file.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetContactAttributesResult |
getContactAttributes(GetContactAttributesRequest request)
Retrieves the contact attributes for the specified contact.
|
GetCurrentMetricDataResult |
getCurrentMetricData(GetCurrentMetricDataRequest request)
Gets the real-time metric data from the specified Amazon Connect instance.
|
GetCurrentUserDataResult |
getCurrentUserData(GetCurrentUserDataRequest request)
Gets the real-time active user data from the specified Amazon Connect instance.
|
GetFederationTokenResult |
getFederationToken(GetFederationTokenRequest request)
Supports SAML sign-in for Amazon Connect.
|
GetFlowAssociationResult |
getFlowAssociation(GetFlowAssociationRequest request)
Retrieves the flow associated for a given resource.
|
GetMetricDataResult |
getMetricData(GetMetricDataRequest request)
Gets historical metric data from the specified Amazon Connect instance.
|
GetMetricDataV2Result |
getMetricDataV2(GetMetricDataV2Request request)
Gets metric data from the specified Amazon Connect instance.
|
GetPromptFileResult |
getPromptFile(GetPromptFileRequest request)
Gets the prompt file.
|
GetTaskTemplateResult |
getTaskTemplate(GetTaskTemplateRequest request)
Gets details about a specific task template in the specified Amazon Connect instance.
|
GetTrafficDistributionResult |
getTrafficDistribution(GetTrafficDistributionRequest request)
Retrieves the current traffic distribution for a given traffic distribution group.
|
ImportPhoneNumberResult |
importPhoneNumber(ImportPhoneNumberRequest request)
Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect
instance.
|
ListAgentStatusesResult |
listAgentStatuses(ListAgentStatusesRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListAnalyticsDataAssociationsResult |
listAnalyticsDataAssociations(ListAnalyticsDataAssociationsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListApprovedOriginsResult |
listApprovedOrigins(ListApprovedOriginsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListAuthenticationProfilesResult |
listAuthenticationProfiles(ListAuthenticationProfilesRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListBotsResult |
listBots(ListBotsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListContactEvaluationsResult |
listContactEvaluations(ListContactEvaluationsRequest request)
Lists contact evaluations in the specified Amazon Connect instance.
|
ListContactFlowModulesResult |
listContactFlowModules(ListContactFlowModulesRequest request)
Provides information about the flow modules for the specified Amazon Connect instance.
|
ListContactFlowsResult |
listContactFlows(ListContactFlowsRequest request)
Provides information about the flows for the specified Amazon Connect instance.
|
ListContactReferencesResult |
listContactReferences(ListContactReferencesRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListDefaultVocabulariesResult |
listDefaultVocabularies(ListDefaultVocabulariesRequest request)
Lists the default vocabularies for the specified Amazon Connect instance.
|
ListEvaluationFormsResult |
listEvaluationForms(ListEvaluationFormsRequest request)
Lists evaluation forms in the specified Amazon Connect instance.
|
ListEvaluationFormVersionsResult |
listEvaluationFormVersions(ListEvaluationFormVersionsRequest request)
Lists versions of an evaluation form in the specified Amazon Connect instance.
|
ListFlowAssociationsResult |
listFlowAssociations(ListFlowAssociationsRequest request)
List the flow association based on the filters.
|
ListHoursOfOperationsResult |
listHoursOfOperations(ListHoursOfOperationsRequest request)
Provides information about the hours of operation for the specified Amazon Connect instance.
|
ListInstanceAttributesResult |
listInstanceAttributes(ListInstanceAttributesRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListInstancesResult |
listInstances(ListInstancesRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListInstanceStorageConfigsResult |
listInstanceStorageConfigs(ListInstanceStorageConfigsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListIntegrationAssociationsResult |
listIntegrationAssociations(ListIntegrationAssociationsRequest request)
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect
instance.
|
ListLambdaFunctionsResult |
listLambdaFunctions(ListLambdaFunctionsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListLexBotsResult |
listLexBots(ListLexBotsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListPhoneNumbersResult |
listPhoneNumbers(ListPhoneNumbersRequest request)
Provides information about the phone numbers for the specified Amazon Connect instance.
|
ListPhoneNumbersV2Result |
listPhoneNumbersV2(ListPhoneNumbersV2Request request)
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group.
|
ListPredefinedAttributesResult |
listPredefinedAttributes(ListPredefinedAttributesRequest request)
Lists predefined attributes for the specified Amazon Connect instance.
|
ListPromptsResult |
listPrompts(ListPromptsRequest request)
Provides information about the prompts for the specified Amazon Connect instance.
|
ListQueueQuickConnectsResult |
listQueueQuickConnects(ListQueueQuickConnectsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListQueuesResult |
listQueues(ListQueuesRequest request)
Provides information about the queues for the specified Amazon Connect instance.
|
ListQuickConnectsResult |
listQuickConnects(ListQuickConnectsRequest request)
Provides information about the quick connects for the specified Amazon Connect instance.
|
ListRealtimeContactAnalysisSegmentsV2Result |
listRealtimeContactAnalysisSegmentsV2(ListRealtimeContactAnalysisSegmentsV2Request request)
Provides a list of analysis segments for a real-time analysis session.
|
ListRoutingProfileQueuesResult |
listRoutingProfileQueues(ListRoutingProfileQueuesRequest request)
Lists the queues associated with a routing profile.
|
ListRoutingProfilesResult |
listRoutingProfiles(ListRoutingProfilesRequest request)
Provides summary information about the routing profiles for the specified Amazon Connect instance.
|
ListRulesResult |
listRules(ListRulesRequest request)
List all rules for the specified Amazon Connect instance.
|
ListSecurityKeysResult |
listSecurityKeys(ListSecurityKeysRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
ListSecurityProfileApplicationsResult |
listSecurityProfileApplications(ListSecurityProfileApplicationsRequest request)
Returns a list of third-party applications in a specific security profile.
|
ListSecurityProfilePermissionsResult |
listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest request)
Lists the permissions granted to a security profile.
|
ListSecurityProfilesResult |
listSecurityProfiles(ListSecurityProfilesRequest request)
Provides summary information about the security profiles for the specified Amazon Connect instance.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags for the specified resource.
|
ListTaskTemplatesResult |
listTaskTemplates(ListTaskTemplatesRequest request)
Lists task templates for the specified Amazon Connect instance.
|
ListTrafficDistributionGroupsResult |
listTrafficDistributionGroups(ListTrafficDistributionGroupsRequest request)
Lists traffic distribution groups.
|
ListTrafficDistributionGroupUsersResult |
listTrafficDistributionGroupUsers(ListTrafficDistributionGroupUsersRequest request)
Lists traffic distribution group users.
|
ListUseCasesResult |
listUseCases(ListUseCasesRequest request)
Lists the use cases for the integration association.
|
ListUserHierarchyGroupsResult |
listUserHierarchyGroups(ListUserHierarchyGroupsRequest request)
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
|
ListUserProficienciesResult |
listUserProficiencies(ListUserProficienciesRequest request)
Lists proficiencies associated with a user.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Provides summary information about the users for the specified Amazon Connect instance.
|
ListViewsResult |
listViews(ListViewsRequest request)
Returns views in the given instance.
|
ListViewVersionsResult |
listViewVersions(ListViewVersionsRequest request)
Returns all the available versions for the specified Amazon Connect instance and view identifier.
|
MonitorContactResult |
monitorContact(MonitorContactRequest request)
Initiates silent monitoring of a contact.
|
PauseContactResult |
pauseContact(PauseContactRequest request)
Allows pausing an ongoing task contact.
|
PutUserStatusResult |
putUserStatus(PutUserStatusRequest request)
Changes the current status of a user or agent in Amazon Connect.
|
ReleasePhoneNumberResult |
releasePhoneNumber(ReleasePhoneNumberRequest request)
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group.
|
ReplicateInstanceResult |
replicateInstance(ReplicateInstanceRequest request)
Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration
information for Amazon Connect resources across Amazon Web Services Regions.
|
ResumeContactResult |
resumeContact(ResumeContactRequest request)
Allows resuming a task contact in a paused state.
|
ResumeContactRecordingResult |
resumeContactRecording(ResumeContactRecordingRequest request)
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API
resumes recording whatever recording is selected in the flow configuration: call, screen, or both.
|
SearchAgentStatusesResult |
searchAgentStatuses(SearchAgentStatusesRequest request)
Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
|
SearchAvailablePhoneNumbersResult |
searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest request)
Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution
group.
|
SearchContactFlowModulesResult |
searchContactFlowModules(SearchContactFlowModulesRequest request)
Searches the flow modules in an Amazon Connect instance, with optional filtering.
|
SearchContactFlowsResult |
searchContactFlows(SearchContactFlowsRequest request)
Searches the contact flows in an Amazon Connect instance, with optional filtering.
|
SearchContactsResult |
searchContacts(SearchContactsRequest request)
Searches contacts in an Amazon Connect instance.
|
SearchHoursOfOperationsResult |
searchHoursOfOperations(SearchHoursOfOperationsRequest request)
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
|
SearchPredefinedAttributesResult |
searchPredefinedAttributes(SearchPredefinedAttributesRequest request)
Predefined attributes that meet certain criteria.
|
SearchPromptsResult |
searchPrompts(SearchPromptsRequest request)
Searches prompts in an Amazon Connect instance, with optional filtering.
|
SearchQueuesResult |
searchQueues(SearchQueuesRequest request)
Searches queues in an Amazon Connect instance, with optional filtering.
|
SearchQuickConnectsResult |
searchQuickConnects(SearchQuickConnectsRequest request)
Searches quick connects in an Amazon Connect instance, with optional filtering.
|
SearchResourceTagsResult |
searchResourceTags(SearchResourceTagsRequest request)
Searches tags used in an Amazon Connect instance using optional search criteria.
|
SearchRoutingProfilesResult |
searchRoutingProfiles(SearchRoutingProfilesRequest request)
Searches routing profiles in an Amazon Connect instance, with optional filtering.
|
SearchSecurityProfilesResult |
searchSecurityProfiles(SearchSecurityProfilesRequest request)
Searches security profiles in an Amazon Connect instance, with optional filtering.
|
SearchUserHierarchyGroupsResult |
searchUserHierarchyGroups(SearchUserHierarchyGroupsRequest request)
Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
|
SearchUsersResult |
searchUsers(SearchUsersRequest request)
Searches users in an Amazon Connect instance, with optional filtering.
|
SearchVocabulariesResult |
searchVocabularies(SearchVocabulariesRequest request)
Searches for vocabularies within a specific Amazon Connect instance using
State ,
NameStartsWith , and LanguageCode . |
SendChatIntegrationEventResult |
sendChatIntegrationEvent(SendChatIntegrationEventRequest request)
Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartAttachedFileUploadResult |
startAttachedFileUpload(StartAttachedFileUploadRequest request)
Provides a pre-signed Amazon S3 URL in response for uploading your content.
|
StartChatContactResult |
startChatContact(StartChatContactRequest request)
Initiates a flow to start a new chat for the customer.
|
StartContactEvaluationResult |
startContactEvaluation(StartContactEvaluationRequest request)
Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the
particular contact.
|
StartContactRecordingResult |
startContactRecording(StartContactRecordingRequest request)
Starts recording the contact:
|
StartContactStreamingResult |
startContactStreaming(StartContactStreamingRequest request)
Initiates real-time message streaming for a new chat contact.
|
StartOutboundVoiceContactResult |
startOutboundVoiceContact(StartOutboundVoiceContactRequest request)
Places an outbound call to a contact, and then initiates the flow.
|
StartTaskContactResult |
startTaskContact(StartTaskContactRequest request)
Initiates a flow to start a new task contact.
|
StartWebRTCContactResult |
startWebRTCContact(StartWebRTCContactRequest request)
Places an inbound in-app, web, or video call to a contact, and then initiates the flow.
|
StopContactResult |
stopContact(StopContactRequest request)
Ends the specified contact.
|
StopContactRecordingResult |
stopContactRecording(StopContactRecordingRequest request)
Stops recording a call when a contact is being recorded.
|
StopContactStreamingResult |
stopContactStreaming(StopContactStreamingRequest request)
Ends message streaming on a specified contact.
|
SubmitContactEvaluationResult |
submitContactEvaluation(SubmitContactEvaluationRequest request)
Submits a contact evaluation in the specified Amazon Connect instance.
|
SuspendContactRecordingResult |
suspendContactRecording(SuspendContactRecordingRequest request)
When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration:
call, screen, or both.
|
TagContactResult |
tagContact(TagContactRequest request)
Adds the specified tags to the contact resource.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds the specified tags to the specified resource.
|
TransferContactResult |
transferContact(TransferContactRequest request)
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created.
|
UntagContactResult |
untagContact(UntagContactRequest request)
Removes the specified tags from the contact resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes the specified tags from the specified resource.
|
UpdateAgentStatusResult |
updateAgentStatus(UpdateAgentStatusRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateAuthenticationProfileResult |
updateAuthenticationProfile(UpdateAuthenticationProfileRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateContactResult |
updateContact(UpdateContactRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateContactAttributesResult |
updateContactAttributes(UpdateContactAttributesRequest request)
Creates or updates user-defined contact attributes associated with the specified contact.
|
UpdateContactEvaluationResult |
updateContactEvaluation(UpdateContactEvaluationRequest request)
Updates details about a contact evaluation in the specified Amazon Connect instance.
|
UpdateContactFlowContentResult |
updateContactFlowContent(UpdateContactFlowContentRequest request)
Updates the specified flow.
|
UpdateContactFlowMetadataResult |
updateContactFlowMetadata(UpdateContactFlowMetadataRequest request)
Updates metadata about specified flow.
|
UpdateContactFlowModuleContentResult |
updateContactFlowModuleContent(UpdateContactFlowModuleContentRequest request)
Updates specified flow module for the specified Amazon Connect instance.
|
UpdateContactFlowModuleMetadataResult |
updateContactFlowModuleMetadata(UpdateContactFlowModuleMetadataRequest request)
Updates metadata about specified flow module.
|
UpdateContactFlowNameResult |
updateContactFlowName(UpdateContactFlowNameRequest request)
The name of the flow.
|
UpdateContactRoutingDataResult |
updateContactRoutingData(UpdateContactRoutingDataRequest request)
Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds).
|
UpdateContactScheduleResult |
updateContactSchedule(UpdateContactScheduleRequest request)
Updates the scheduled time of a task contact that is already scheduled.
|
UpdateEvaluationFormResult |
updateEvaluationForm(UpdateEvaluationFormRequest request)
Updates details about a specific evaluation form version in the specified Amazon Connect instance.
|
UpdateHoursOfOperationResult |
updateHoursOfOperation(UpdateHoursOfOperationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateInstanceAttributeResult |
updateInstanceAttribute(UpdateInstanceAttributeRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateInstanceStorageConfigResult |
updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateParticipantRoleConfigResult |
updateParticipantRoleConfig(UpdateParticipantRoleConfigRequest request)
Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically
disconnected from a chat due to idleness.
|
UpdatePhoneNumberResult |
updatePhoneNumber(UpdatePhoneNumberRequest request)
Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to
another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
|
UpdatePhoneNumberMetadataResult |
updatePhoneNumberMetadata(UpdatePhoneNumberMetadataRequest request)
Updates a phone number’s metadata.
|
UpdatePredefinedAttributeResult |
updatePredefinedAttribute(UpdatePredefinedAttributeRequest request)
Updates a predefined attribute for the specified Amazon Connect instance.
|
UpdatePromptResult |
updatePrompt(UpdatePromptRequest request)
Updates a prompt.
|
UpdateQueueHoursOfOperationResult |
updateQueueHoursOfOperation(UpdateQueueHoursOfOperationRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQueueMaxContactsResult |
updateQueueMaxContacts(UpdateQueueMaxContactsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQueueNameResult |
updateQueueName(UpdateQueueNameRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQueueOutboundCallerConfigResult |
updateQueueOutboundCallerConfig(UpdateQueueOutboundCallerConfigRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQueueStatusResult |
updateQueueStatus(UpdateQueueStatusRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
UpdateQuickConnectConfigResult |
updateQuickConnectConfig(UpdateQuickConnectConfigRequest request)
Updates the configuration settings for the specified quick connect.
|
UpdateQuickConnectNameResult |
updateQuickConnectName(UpdateQuickConnectNameRequest request)
Updates the name and description of a quick connect.
|
UpdateRoutingProfileAgentAvailabilityTimerResult |
updateRoutingProfileAgentAvailabilityTimer(UpdateRoutingProfileAgentAvailabilityTimerRequest request)
Whether agents with this routing profile will have their routing order calculated based on time since their
last inbound contact or longest idle time.
|
UpdateRoutingProfileConcurrencyResult |
updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest request)
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
|
UpdateRoutingProfileDefaultOutboundQueueResult |
updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest request)
Updates the default outbound queue of a routing profile.
|
UpdateRoutingProfileNameResult |
updateRoutingProfileName(UpdateRoutingProfileNameRequest request)
Updates the name and description of a routing profile.
|
UpdateRoutingProfileQueuesResult |
updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest request)
Updates the properties associated with a set of queues for a routing profile.
|
UpdateRuleResult |
updateRule(UpdateRuleRequest request)
Updates a rule for the specified Amazon Connect instance.
|
UpdateSecurityProfileResult |
updateSecurityProfile(UpdateSecurityProfileRequest request)
Updates a security profile.
|
UpdateTaskTemplateResult |
updateTaskTemplate(UpdateTaskTemplateRequest request)
Updates details about a specific task template in the specified Amazon Connect instance.
|
UpdateTrafficDistributionResult |
updateTrafficDistribution(UpdateTrafficDistributionRequest request)
Updates the traffic distribution for a given traffic distribution group.
|
UpdateUserHierarchyResult |
updateUserHierarchy(UpdateUserHierarchyRequest request)
Assigns the specified hierarchy group to the specified user.
|
UpdateUserHierarchyGroupNameResult |
updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest request)
Updates the name of the user hierarchy group.
|
UpdateUserHierarchyStructureResult |
updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest request)
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
|
UpdateUserIdentityInfoResult |
updateUserIdentityInfo(UpdateUserIdentityInfoRequest request)
Updates the identity information for the specified user.
|
UpdateUserPhoneConfigResult |
updateUserPhoneConfig(UpdateUserPhoneConfigRequest request)
Updates the phone configuration settings for the specified user.
|
UpdateUserProficienciesResult |
updateUserProficiencies(UpdateUserProficienciesRequest request)
Updates the properties associated with the proficiencies of a user.
|
UpdateUserRoutingProfileResult |
updateUserRoutingProfile(UpdateUserRoutingProfileRequest request)
Assigns the specified routing profile to the specified user.
|
UpdateUserSecurityProfilesResult |
updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest request)
Assigns the specified security profiles to the specified user.
|
UpdateViewContentResult |
updateViewContent(UpdateViewContentRequest request)
Updates the view content of the given view identifier in the specified Amazon Connect instance.
|
UpdateViewMetadataResult |
updateViewMetadata(UpdateViewMetadataRequest request)
Updates the view metadata.
|
public ActivateEvaluationFormResult activateEvaluationForm(ActivateEvaluationFormRequest request)
AmazonConnect
Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
activateEvaluationForm
in interface AmazonConnect
public AssociateAnalyticsDataSetResult associateAnalyticsDataSet(AssociateAnalyticsDataSetRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
associateAnalyticsDataSet
in interface AmazonConnect
public AssociateApprovedOriginResult associateApprovedOrigin(AssociateApprovedOriginRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
associateApprovedOrigin
in interface AmazonConnect
public AssociateBotResult associateBot(AssociateBotRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.
associateBot
in interface AmazonConnect
public AssociateDefaultVocabularyResult associateDefaultVocabulary(AssociateDefaultVocabularyRequest request)
AmazonConnect
Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.
associateDefaultVocabulary
in interface AmazonConnect
public AssociateFlowResult associateFlow(AssociateFlowRequest request)
AmazonConnect
Associates a connect resource to a flow.
associateFlow
in interface AmazonConnect
public AssociateInstanceStorageConfigResult associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.
This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.
associateInstanceStorageConfig
in interface AmazonConnect
public AssociateLambdaFunctionResult associateLambdaFunction(AssociateLambdaFunctionRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Lambda function.
associateLambdaFunction
in interface AmazonConnect
public AssociateLexBotResult associateLexBot(AssociateLexBotRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.
associateLexBot
in interface AmazonConnect
public AssociatePhoneNumberContactFlowResult associatePhoneNumberContactFlow(AssociatePhoneNumberContactFlowRequest request)
AmazonConnect
Associates a flow with a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the
Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone
number ARN or UUID value for the PhoneNumberId
URI request parameter. However, if the number is
claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon
Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If
a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
associatePhoneNumberContactFlow
in interface AmazonConnect
public AssociateQueueQuickConnectsResult associateQueueQuickConnects(AssociateQueueQuickConnectsRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
associateQueueQuickConnects
in interface AmazonConnect
public AssociateRoutingProfileQueuesResult associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest request)
AmazonConnect
Associates a set of queues with a routing profile.
associateRoutingProfileQueues
in interface AmazonConnect
public AssociateSecurityKeyResult associateSecurityKey(AssociateSecurityKeyRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
associateSecurityKey
in interface AmazonConnect
public AssociateTrafficDistributionGroupUserResult associateTrafficDistributionGroupUser(AssociateTrafficDistributionGroupUserRequest request)
AmazonConnect
Associates an agent with a traffic distribution group.
associateTrafficDistributionGroupUser
in interface AmazonConnect
public AssociateUserProficienciesResult associateUserProficiencies(AssociateUserProficienciesRequest request)
AmazonConnect
>Associates a set of proficiencies with a user.
associateUserProficiencies
in interface AmazonConnect
public BatchAssociateAnalyticsDataSetResult batchAssociateAnalyticsDataSet(BatchAssociateAnalyticsDataSetRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
batchAssociateAnalyticsDataSet
in interface AmazonConnect
public BatchDisassociateAnalyticsDataSetResult batchDisassociateAnalyticsDataSet(BatchDisassociateAnalyticsDataSetRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
batchDisassociateAnalyticsDataSet
in interface AmazonConnect
public BatchGetAttachedFileMetadataResult batchGetAttachedFileMetadata(BatchGetAttachedFileMetadataRequest request)
AmazonConnect
Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
batchGetAttachedFileMetadata
in interface AmazonConnect
public BatchGetFlowAssociationResult batchGetFlowAssociation(BatchGetFlowAssociationRequest request)
AmazonConnect
Retrieve the flow associations for the given resources.
batchGetFlowAssociation
in interface AmazonConnect
public BatchPutContactResult batchPutContact(BatchPutContactRequest request)
AmazonConnect
Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.
batchPutContact
in interface AmazonConnect
public ClaimPhoneNumberResult claimPhoneNumber(ClaimPhoneNumberRequest request)
AmazonConnect
Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
claimPhoneNumber
in interface AmazonConnect
public CompleteAttachedFileUploadResult completeAttachedFileUpload(CompleteAttachedFileUploadRequest request)
AmazonConnect
Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
completeAttachedFileUpload
in interface AmazonConnect
request
- Request to CompleteAttachedFileUpload APIpublic CreateAgentStatusResult createAgentStatus(CreateAgentStatusRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
createAgentStatus
in interface AmazonConnect
public CreateContactFlowResult createContactFlow(CreateContactFlowRequest request)
AmazonConnect
Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
createContactFlow
in interface AmazonConnect
public CreateContactFlowModuleResult createContactFlowModule(CreateContactFlowModuleRequest request)
AmazonConnect
Creates a flow module for the specified Amazon Connect instance.
createContactFlowModule
in interface AmazonConnect
public CreateEvaluationFormResult createEvaluationForm(CreateEvaluationFormRequest request)
AmazonConnect
Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.
createEvaluationForm
in interface AmazonConnect
public CreateHoursOfOperationResult createHoursOfOperation(CreateHoursOfOperationRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
createHoursOfOperation
in interface AmazonConnect
public CreateInstanceResult createInstance(CreateInstanceRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
createInstance
in interface AmazonConnect
public CreateIntegrationAssociationResult createIntegrationAssociation(CreateIntegrationAssociationRequest request)
AmazonConnect
Creates an Amazon Web Services resource association with an Amazon Connect instance.
createIntegrationAssociation
in interface AmazonConnect
public CreateParticipantResult createParticipant(CreateParticipantRequest request)
AmazonConnect
Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
createParticipant
in interface AmazonConnect
public CreatePersistentContactAssociationResult createPersistentContactAssociation(CreatePersistentContactAssociationRequest request)
AmazonConnect
Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
createPersistentContactAssociation
in interface AmazonConnect
public CreatePredefinedAttributeResult createPredefinedAttribute(CreatePredefinedAttributeRequest request)
AmazonConnect
Creates a new predefined attribute for the specified Amazon Connect instance.
createPredefinedAttribute
in interface AmazonConnect
public CreatePromptResult createPrompt(CreatePromptRequest request)
AmazonConnect
Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
createPrompt
in interface AmazonConnect
public CreateQueueResult createQueue(CreateQueueRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon
Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for
OutboundCallerIdNumberId
. However, if the phone number is claimed to a traffic distribution group
that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that
is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is
provided in this scenario, you will receive a ResourceNotFoundException
.
Only use the phone number ARN format that doesn't contain instance
in the path, for example,
arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned
when you call the ListPhoneNumbersV2
API.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
createQueue
in interface AmazonConnect
public CreateQuickConnectResult createQuickConnect(CreateQuickConnectRequest request)
AmazonConnect
Creates a quick connect for the specified Amazon Connect instance.
createQuickConnect
in interface AmazonConnect
public CreateRoutingProfileResult createRoutingProfile(CreateRoutingProfileRequest request)
AmazonConnect
Creates a new routing profile.
createRoutingProfile
in interface AmazonConnect
public CreateRuleResult createRule(CreateRuleRequest request)
AmazonConnect
Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
createRule
in interface AmazonConnect
public CreateSecurityProfileResult createSecurityProfile(CreateSecurityProfileRequest request)
AmazonConnect
Creates a security profile.
createSecurityProfile
in interface AmazonConnect
public CreateTaskTemplateResult createTaskTemplate(CreateTaskTemplateRequest request)
AmazonConnect
Creates a new task template in the specified Amazon Connect instance.
createTaskTemplate
in interface AmazonConnect
public CreateTrafficDistributionGroupResult createTrafficDistributionGroup(CreateTrafficDistributionGroupRequest request)
AmazonConnect
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
The SignInConfig
distribution is available only on a default TrafficDistributionGroup
(see the IsDefault
parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution
with a modified
SignInConfig
and a non-default TrafficDistributionGroup
, an
InvalidRequestException
is returned.
For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.
createTrafficDistributionGroup
in interface AmazonConnect
public CreateUseCaseResult createUseCase(CreateUseCaseRequest request)
AmazonConnect
Creates a use case for an integration association.
createUseCase
in interface AmazonConnect
public CreateUserResult createUser(CreateUserRequest request)
AmazonConnect
Creates a user account for the specified Amazon Connect instance.
Certain UserIdentityInfo
parameters are required in some situations. For example, Email
is required if you are using SAML for
identity management. FirstName
and LastName
are required if you are using Amazon
Connect or SAML for identity management.
For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
createUser
in interface AmazonConnect
public CreateUserHierarchyGroupResult createUserHierarchyGroup(CreateUserHierarchyGroupRequest request)
AmazonConnect
Creates a new user hierarchy group.
createUserHierarchyGroup
in interface AmazonConnect
public CreateViewResult createView(CreateViewRequest request)
AmazonConnect
Creates a new view with the possible status of SAVED
or PUBLISHED
.
The views will have a unique name for each connect instance.
It performs basic content validation if the status is SAVED
or full content validation if the status
is set to PUBLISHED
. An error is returned if validation fails. It associates either the
$SAVED
qualifier or both of the $SAVED
and $LATEST
qualifiers with the
provided view content based on the status. The view is idempotent if ClientToken is provided.
createView
in interface AmazonConnect
public CreateViewVersionResult createViewVersion(CreateViewVersionRequest request)
AmazonConnect
Publishes a new version of the view identifier.
Versions are immutable and monotonically increasing.
It returns the highest version if there is no change in content compared to that version. An error is displayed
if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST
alias.
createViewVersion
in interface AmazonConnect
public CreateVocabularyResult createVocabulary(CreateVocabularyRequest request)
AmazonConnect
Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.
createVocabulary
in interface AmazonConnect
public DeactivateEvaluationFormResult deactivateEvaluationForm(DeactivateEvaluationFormRequest request)
AmazonConnect
Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
deactivateEvaluationForm
in interface AmazonConnect
public DeleteAttachedFileResult deleteAttachedFile(DeleteAttachedFileRequest request)
AmazonConnect
Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
deleteAttachedFile
in interface AmazonConnect
request
- Request to DeleteAttachedFile APIpublic DeleteContactEvaluationResult deleteContactEvaluation(DeleteContactEvaluationRequest request)
AmazonConnect
Deletes a contact evaluation in the specified Amazon Connect instance.
deleteContactEvaluation
in interface AmazonConnect
public DeleteContactFlowResult deleteContactFlow(DeleteContactFlowRequest request)
AmazonConnect
Deletes a flow for the specified Amazon Connect instance.
deleteContactFlow
in interface AmazonConnect
public DeleteContactFlowModuleResult deleteContactFlowModule(DeleteContactFlowModuleRequest request)
AmazonConnect
Deletes the specified flow module.
deleteContactFlowModule
in interface AmazonConnect
public DeleteEvaluationFormResult deleteEvaluationForm(DeleteEvaluationFormRequest request)
AmazonConnect
Deletes an evaluation form in the specified Amazon Connect instance.
If the version property is provided, only the specified version of the evaluation form is deleted.
If no version is provided, then the full form (all versions) is deleted.
deleteEvaluationForm
in interface AmazonConnect
public DeleteHoursOfOperationResult deleteHoursOfOperation(DeleteHoursOfOperationRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
deleteHoursOfOperation
in interface AmazonConnect
public DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
deleteInstance
in interface AmazonConnect
public DeleteIntegrationAssociationResult deleteIntegrationAssociation(DeleteIntegrationAssociationRequest request)
AmazonConnect
Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
deleteIntegrationAssociation
in interface AmazonConnect
public DeletePredefinedAttributeResult deletePredefinedAttribute(DeletePredefinedAttributeRequest request)
AmazonConnect
Deletes a predefined attribute from the specified Amazon Connect instance.
deletePredefinedAttribute
in interface AmazonConnect
public DeletePromptResult deletePrompt(DeletePromptRequest request)
AmazonConnect
Deletes a prompt.
deletePrompt
in interface AmazonConnect
public DeleteQueueResult deleteQueue(DeleteQueueRequest request)
AmazonConnect
Deletes a queue.
deleteQueue
in interface AmazonConnect
public DeleteQuickConnectResult deleteQuickConnect(DeleteQuickConnectRequest request)
AmazonConnect
Deletes a quick connect.
After calling DeleteUser, it's important
to call DeleteQuickConnect
to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
deleteQuickConnect
in interface AmazonConnect
public DeleteRoutingProfileResult deleteRoutingProfile(DeleteRoutingProfileRequest request)
AmazonConnect
Deletes a routing profile.
deleteRoutingProfile
in interface AmazonConnect
public DeleteRuleResult deleteRule(DeleteRuleRequest request)
AmazonConnect
Deletes a rule for the specified Amazon Connect instance.
deleteRule
in interface AmazonConnect
public DeleteSecurityProfileResult deleteSecurityProfile(DeleteSecurityProfileRequest request)
AmazonConnect
Deletes a security profile.
deleteSecurityProfile
in interface AmazonConnect
public DeleteTaskTemplateResult deleteTaskTemplate(DeleteTaskTemplateRequest request)
AmazonConnect
Deletes the task template.
deleteTaskTemplate
in interface AmazonConnect
public DeleteTrafficDistributionGroupResult deleteTrafficDistributionGroup(DeleteTrafficDistributionGroupRequest request)
AmazonConnect
Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.
deleteTrafficDistributionGroup
in interface AmazonConnect
public DeleteUseCaseResult deleteUseCase(DeleteUseCaseRequest request)
AmazonConnect
Deletes a use case from an integration association.
deleteUseCase
in interface AmazonConnect
public DeleteUserResult deleteUser(DeleteUserRequest request)
AmazonConnect
Deletes a user account from the specified Amazon Connect instance.
For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.
After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
deleteUser
in interface AmazonConnect
public DeleteUserHierarchyGroupResult deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest request)
AmazonConnect
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
deleteUserHierarchyGroup
in interface AmazonConnect
public DeleteViewResult deleteView(DeleteViewRequest request)
AmazonConnect
Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
deleteView
in interface AmazonConnect
public DeleteViewVersionResult deleteViewVersion(DeleteViewVersionRequest request)
AmazonConnect
Deletes the particular version specified in ViewVersion
identifier.
deleteViewVersion
in interface AmazonConnect
public DeleteVocabularyResult deleteVocabulary(DeleteVocabularyRequest request)
AmazonConnect
Deletes the vocabulary that has the given identifier.
deleteVocabulary
in interface AmazonConnect
public DescribeAgentStatusResult describeAgentStatus(DescribeAgentStatusRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
describeAgentStatus
in interface AmazonConnect
public DescribeAuthenticationProfileResult describeAuthenticationProfile(DescribeAuthenticationProfileRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Describes the target authentication profile.
describeAuthenticationProfile
in interface AmazonConnect
public DescribeContactResult describeContact(DescribeContactRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Contact information remains available in Amazon Connect for 24 months, and then it is deleted.
Only data from November 12, 2021, and later is returned by this API.
describeContact
in interface AmazonConnect
public DescribeContactEvaluationResult describeContactEvaluation(DescribeContactEvaluationRequest request)
AmazonConnect
Describes a contact evaluation in the specified Amazon Connect instance.
describeContactEvaluation
in interface AmazonConnect
public DescribeContactFlowResult describeContactFlow(DescribeContactFlowRequest request)
AmazonConnect
Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For
example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
In the response, Status indicates the flow status as either SAVED
or PUBLISHED
.
The PUBLISHED
status will initiate validation on the content. SAVED
does not initiate
validation of the content. SAVED
| PUBLISHED
describeContactFlow
in interface AmazonConnect
public DescribeContactFlowModuleResult describeContactFlowModule(DescribeContactFlowModuleRequest request)
AmazonConnect
Describes the specified flow module.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For
example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
describeContactFlowModule
in interface AmazonConnect
public DescribeEvaluationFormResult describeEvaluationForm(DescribeEvaluationFormRequest request)
AmazonConnect
Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
describeEvaluationForm
in interface AmazonConnect
public DescribeHoursOfOperationResult describeHoursOfOperation(DescribeHoursOfOperationRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
describeHoursOfOperation
in interface AmazonConnect
public DescribeInstanceResult describeInstance(DescribeInstanceRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.
If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.
describeInstance
in interface AmazonConnect
public DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
describeInstanceAttribute
in interface AmazonConnect
public DescribeInstanceStorageConfigResult describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
describeInstanceStorageConfig
in interface AmazonConnect
public DescribePhoneNumberResult describePhoneNumber(DescribePhoneNumberRequest request)
AmazonConnect
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region
where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the
PhoneNumberId
URI request parameter. However, if the number is claimed to a traffic distribution
group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic
distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will
receive a ResourceNotFoundException
.
describePhoneNumber
in interface AmazonConnect
public DescribePredefinedAttributeResult describePredefinedAttribute(DescribePredefinedAttributeRequest request)
AmazonConnect
Describes a predefined attribute for the specified Amazon Connect instance.
describePredefinedAttribute
in interface AmazonConnect
public DescribePromptResult describePrompt(DescribePromptRequest request)
AmazonConnect
Describes the prompt.
describePrompt
in interface AmazonConnect
public DescribeQueueResult describeQueue(DescribeQueueRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
describeQueue
in interface AmazonConnect
public DescribeQuickConnectResult describeQuickConnect(DescribeQuickConnectRequest request)
AmazonConnect
Describes the quick connect.
describeQuickConnect
in interface AmazonConnect
public DescribeRoutingProfileResult describeRoutingProfile(DescribeRoutingProfileRequest request)
AmazonConnect
Describes the specified routing profile.
describeRoutingProfile
in interface AmazonConnect
public DescribeRuleResult describeRule(DescribeRuleRequest request)
AmazonConnect
Describes a rule for the specified Amazon Connect instance.
describeRule
in interface AmazonConnect
public DescribeSecurityProfileResult describeSecurityProfile(DescribeSecurityProfileRequest request)
AmazonConnect
Gets basic information about the security profle.
describeSecurityProfile
in interface AmazonConnect
public DescribeTrafficDistributionGroupResult describeTrafficDistributionGroup(DescribeTrafficDistributionGroupRequest request)
AmazonConnect
Gets details and status of a traffic distribution group.
describeTrafficDistributionGroup
in interface AmazonConnect
public DescribeUserResult describeUser(DescribeUserRequest request)
AmazonConnect
Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.
describeUser
in interface AmazonConnect
public DescribeUserHierarchyGroupResult describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest request)
AmazonConnect
Describes the specified hierarchy group.
describeUserHierarchyGroup
in interface AmazonConnect
public DescribeUserHierarchyStructureResult describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest request)
AmazonConnect
Describes the hierarchy structure of the specified Amazon Connect instance.
describeUserHierarchyStructure
in interface AmazonConnect
public DescribeViewResult describeView(DescribeViewRequest request)
AmazonConnect
Retrieves the view for the specified Amazon Connect instance and view identifier.
The view identifier can be supplied as a ViewId or ARN.
$SAVED
needs to be supplied if a view is unpublished.
The view identifier can contain an optional qualifier, for example, <view-id>:$SAVED
, which is
either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST
. If it is
not supplied, then $LATEST
is assumed for customer managed views and an error is returned if there
is no published content available. Version 1 is assumed for Amazon Web Services managed views.
describeView
in interface AmazonConnect
public DescribeVocabularyResult describeVocabulary(DescribeVocabularyRequest request)
AmazonConnect
Describes the specified vocabulary.
describeVocabulary
in interface AmazonConnect
public DisassociateAnalyticsDataSetResult disassociateAnalyticsDataSet(DisassociateAnalyticsDataSetRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Removes the dataset ID associated with a given Amazon Connect instance.
disassociateAnalyticsDataSet
in interface AmazonConnect
public DisassociateApprovedOriginResult disassociateApprovedOrigin(DisassociateApprovedOriginRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
disassociateApprovedOrigin
in interface AmazonConnect
public DisassociateBotResult disassociateBot(DisassociateBotRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.
disassociateBot
in interface AmazonConnect
public DisassociateFlowResult disassociateFlow(DisassociateFlowRequest request)
AmazonConnect
Disassociates a connect resource from a flow.
disassociateFlow
in interface AmazonConnect
public DisassociateInstanceStorageConfigResult disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Removes the storage type configurations for the specified resource type and association ID.
disassociateInstanceStorageConfig
in interface AmazonConnect
public DisassociateLambdaFunctionResult disassociateLambdaFunction(DisassociateLambdaFunctionRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Remove the Lambda function from the dropdown options available in the relevant flow blocks.
disassociateLambdaFunction
in interface AmazonConnect
public DisassociateLexBotResult disassociateLexBot(DisassociateLexBotRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex bot.
disassociateLexBot
in interface AmazonConnect
public DisassociatePhoneNumberContactFlowResult disassociatePhoneNumberContactFlow(DisassociatePhoneNumberContactFlowRequest request)
AmazonConnect
Removes the flow association from a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the
Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone
number ARN or UUID value for the PhoneNumberId
URI request parameter. However, if the number is
claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon
Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If
a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
disassociatePhoneNumberContactFlow
in interface AmazonConnect
public DisassociateQueueQuickConnectsResult disassociateQueueQuickConnects(DisassociateQueueQuickConnectsRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
disassociateQueueQuickConnects
in interface AmazonConnect
public DisassociateRoutingProfileQueuesResult disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest request)
AmazonConnect
Disassociates a set of queues from a routing profile.
disassociateRoutingProfileQueues
in interface AmazonConnect
public DisassociateSecurityKeyResult disassociateSecurityKey(DisassociateSecurityKeyRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
disassociateSecurityKey
in interface AmazonConnect
public DisassociateTrafficDistributionGroupUserResult disassociateTrafficDistributionGroupUser(DisassociateTrafficDistributionGroupUserRequest request)
AmazonConnect
Disassociates an agent from a traffic distribution group.
disassociateTrafficDistributionGroupUser
in interface AmazonConnect
public DisassociateUserProficienciesResult disassociateUserProficiencies(DisassociateUserProficienciesRequest request)
AmazonConnect
Disassociates a set of proficiencies from a user.
disassociateUserProficiencies
in interface AmazonConnect
public DismissUserContactResult dismissUserContact(DismissUserContactRequest request)
AmazonConnect
Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to
receive a new routed contact. Contacts can only be dismissed if they are in a MISSED
,
ERROR
, ENDED
, or REJECTED
state in the Agent Event Stream.
dismissUserContact
in interface AmazonConnect
public GetAttachedFileResult getAttachedFile(GetAttachedFileRequest request)
AmazonConnect
Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the
attached file. It will only return a downloadURL if the status of the attached file is APPROVED
.
getAttachedFile
in interface AmazonConnect
request
- Request to GetAttachedFile API.public GetContactAttributesResult getContactAttributes(GetContactAttributesRequest request)
AmazonConnect
Retrieves the contact attributes for the specified contact.
getContactAttributes
in interface AmazonConnect
public GetCurrentMetricDataResult getCurrentMetricData(GetCurrentMetricDataRequest request)
AmazonConnect
Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
getCurrentMetricData
in interface AmazonConnect
public GetCurrentUserDataResult getCurrentUserData(GetCurrentUserDataRequest request)
AmazonConnect
Gets the real-time active user data from the specified Amazon Connect instance.
getCurrentUserData
in interface AmazonConnect
public GetFederationTokenResult getFederationToken(GetFederationTokenRequest request)
AmazonConnect
Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.
For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.
This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:
Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect
getFederationToken
in interface AmazonConnect
public GetFlowAssociationResult getFlowAssociation(GetFlowAssociationRequest request)
AmazonConnect
Retrieves the flow associated for a given resource.
getFlowAssociation
in interface AmazonConnect
public GetMetricDataResult getMetricData(GetMetricDataRequest request)
AmazonConnect
Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
We recommend using the GetMetricDataV2 API.
It provides more flexibility, features, and the ability to query longer time ranges than
GetMetricData
. Use it to retrieve historical agent and contact metrics for the last 3 months, at
varying intervals. You can also use it to build custom dashboards to measure historical queue and agent
performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by
day, to see how contact volume changed per day of the week.
getMetricData
in interface AmazonConnect
public GetMetricDataV2Result getMetricDataV2(GetMetricDataV2Request request)
AmazonConnect
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2
offers more features than GetMetricData, the
previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to
filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve
historical data for the last 3 months, at varying intervals.
For a description of the historical metrics that are supported by GetMetricDataV2
and
GetMetricData
, see Historical
metrics definitions in the Amazon Connect Administrator Guide.
getMetricDataV2
in interface AmazonConnect
public GetPromptFileResult getPromptFile(GetPromptFileRequest request)
AmazonConnect
Gets the prompt file.
getPromptFile
in interface AmazonConnect
public GetTaskTemplateResult getTaskTemplate(GetTaskTemplateRequest request)
AmazonConnect
Gets details about a specific task template in the specified Amazon Connect instance.
getTaskTemplate
in interface AmazonConnect
public GetTrafficDistributionResult getTrafficDistribution(GetTrafficDistributionRequest request)
AmazonConnect
Retrieves the current traffic distribution for a given traffic distribution group.
getTrafficDistribution
in interface AmazonConnect
public ImportPhoneNumberResult importPhoneNumber(ImportPhoneNumberRequest request)
AmazonConnect
Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
Call the DescribePhoneNumber
API to verify the status of a previous ImportPhoneNumber
operation.
If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.
importPhoneNumber
in interface AmazonConnect
public ListAgentStatusesResult listAgentStatuses(ListAgentStatusesRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
listAgentStatuses
in interface AmazonConnect
public ListAnalyticsDataAssociationsResult listAnalyticsDataAssociations(ListAnalyticsDataAssociationsRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Lists the association status of requested dataset ID for a given Amazon Connect instance.
listAnalyticsDataAssociations
in interface AmazonConnect
public ListApprovedOriginsResult listApprovedOrigins(ListApprovedOriginsRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all approved origins associated with the instance.
listApprovedOrigins
in interface AmazonConnect
public ListAuthenticationProfilesResult listAuthenticationProfiles(ListAuthenticationProfilesRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Provides summary information about the authentication profiles in a specified Amazon Connect instance.
listAuthenticationProfiles
in interface AmazonConnect
public ListBotsResult listBots(ListBotsRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.
listBots
in interface AmazonConnect
public ListContactEvaluationsResult listContactEvaluations(ListContactEvaluationsRequest request)
AmazonConnect
Lists contact evaluations in the specified Amazon Connect instance.
listContactEvaluations
in interface AmazonConnect
public ListContactFlowModulesResult listContactFlowModules(ListContactFlowModulesRequest request)
AmazonConnect
Provides information about the flow modules for the specified Amazon Connect instance.
listContactFlowModules
in interface AmazonConnect
public ListContactFlowsResult listContactFlows(ListContactFlowsRequest request)
AmazonConnect
Provides information about the flows for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
For more information about flows, see Flows in the Amazon Connect Administrator Guide.
listContactFlows
in interface AmazonConnect
public ListContactReferencesResult listContactReferences(ListContactReferencesRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
For the specified referenceTypes
, returns a list of references associated with the contact.
References are links to documents that are related to a contact, such as emails, attachments, or URLs.
listContactReferences
in interface AmazonConnect
public ListDefaultVocabulariesResult listDefaultVocabularies(ListDefaultVocabulariesRequest request)
AmazonConnect
Lists the default vocabularies for the specified Amazon Connect instance.
listDefaultVocabularies
in interface AmazonConnect
public ListEvaluationFormVersionsResult listEvaluationFormVersions(ListEvaluationFormVersionsRequest request)
AmazonConnect
Lists versions of an evaluation form in the specified Amazon Connect instance.
listEvaluationFormVersions
in interface AmazonConnect
public ListEvaluationFormsResult listEvaluationForms(ListEvaluationFormsRequest request)
AmazonConnect
Lists evaluation forms in the specified Amazon Connect instance.
listEvaluationForms
in interface AmazonConnect
public ListFlowAssociationsResult listFlowAssociations(ListFlowAssociationsRequest request)
AmazonConnect
List the flow association based on the filters.
listFlowAssociations
in interface AmazonConnect
public ListHoursOfOperationsResult listHoursOfOperations(ListHoursOfOperationsRequest request)
AmazonConnect
Provides information about the hours of operation for the specified Amazon Connect instance.
For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.
listHoursOfOperations
in interface AmazonConnect
public ListInstanceAttributesResult listInstanceAttributes(ListInstanceAttributesRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all attribute types for the given instance.
listInstanceAttributes
in interface AmazonConnect
public ListInstanceStorageConfigsResult listInstanceStorageConfigs(ListInstanceStorageConfigsRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of storage configs for the identified instance and resource type.
listInstanceStorageConfigs
in interface AmazonConnect
public ListInstancesResult listInstances(ListInstancesRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.
listInstances
in interface AmazonConnect
public ListIntegrationAssociationsResult listIntegrationAssociations(ListIntegrationAssociationsRequest request)
AmazonConnect
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
listIntegrationAssociations
in interface AmazonConnect
public ListLambdaFunctionsResult listLambdaFunctions(ListLambdaFunctionsRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.
listLambdaFunctions
in interface AmazonConnect
public ListLexBotsResult listLexBots(ListLexBotsRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.
listLexBots
in interface AmazonConnect
public ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest request)
AmazonConnect
Provides information about the phone numbers for the specified Amazon Connect instance.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
We recommend using ListPhoneNumbersV2
to return phone number types. ListPhoneNumbers doesn't support number types UIFN
,
SHARED
, THIRD_PARTY_TF
, and THIRD_PARTY_DID
. While it returns numbers of
those types, it incorrectly lists them as TOLL_FREE
or DID
.
The phone number Arn
value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a
ResourceNotFoundException
. Instead, use the ListPhoneNumbersV2
API. It returns the new phone number ARN that can be used to tag phone number resources.
listPhoneNumbers
in interface AmazonConnect
public ListPhoneNumbersV2Result listPhoneNumbersV2(ListPhoneNumbersV2Request request)
AmazonConnect
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided
TargetArn
is a traffic distribution group, you can call this API in both Amazon Web Services Regions
associated with traffic distribution group.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
When given an instance ARN, ListPhoneNumbersV2
returns only the phone numbers claimed to the
instance.
When given a traffic distribution group ARN ListPhoneNumbersV2
returns only the phone numbers
claimed to the traffic distribution group.
listPhoneNumbersV2
in interface AmazonConnect
public ListPredefinedAttributesResult listPredefinedAttributes(ListPredefinedAttributesRequest request)
AmazonConnect
Lists predefined attributes for the specified Amazon Connect instance.
listPredefinedAttributes
in interface AmazonConnect
public ListPromptsResult listPrompts(ListPromptsRequest request)
AmazonConnect
Provides information about the prompts for the specified Amazon Connect instance.
listPrompts
in interface AmazonConnect
public ListQueueQuickConnectsResult listQueueQuickConnects(ListQueueQuickConnectsRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
listQueueQuickConnects
in interface AmazonConnect
public ListQueuesResult listQueues(ListQueuesRequest request)
AmazonConnect
Provides information about the queues for the specified Amazon Connect instance.
If you do not specify a QueueTypes
parameter, both standard and agent queues are returned. This
might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of
results of the API call in code.
For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.
listQueues
in interface AmazonConnect
public ListQuickConnectsResult listQuickConnects(ListQuickConnectsRequest request)
AmazonConnect
Provides information about the quick connects for the specified Amazon Connect instance.
listQuickConnects
in interface AmazonConnect
public ListRealtimeContactAnalysisSegmentsV2Result listRealtimeContactAnalysisSegmentsV2(ListRealtimeContactAnalysisSegmentsV2Request request)
AmazonConnect
Provides a list of analysis segments for a real-time analysis session.
listRealtimeContactAnalysisSegmentsV2
in interface AmazonConnect
public ListRoutingProfileQueuesResult listRoutingProfileQueues(ListRoutingProfileQueuesRequest request)
AmazonConnect
Lists the queues associated with a routing profile.
listRoutingProfileQueues
in interface AmazonConnect
public ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest request)
AmazonConnect
Provides summary information about the routing profiles for the specified Amazon Connect instance.
For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.
listRoutingProfiles
in interface AmazonConnect
public ListRulesResult listRules(ListRulesRequest request)
AmazonConnect
List all rules for the specified Amazon Connect instance.
listRules
in interface AmazonConnect
public ListSecurityKeysResult listSecurityKeys(ListSecurityKeysRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all security keys associated with the instance.
listSecurityKeys
in interface AmazonConnect
public ListSecurityProfileApplicationsResult listSecurityProfileApplications(ListSecurityProfileApplicationsRequest request)
AmazonConnect
Returns a list of third-party applications in a specific security profile.
listSecurityProfileApplications
in interface AmazonConnect
public ListSecurityProfilePermissionsResult listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest request)
AmazonConnect
Lists the permissions granted to a security profile.
listSecurityProfilePermissions
in interface AmazonConnect
public ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest request)
AmazonConnect
Provides summary information about the security profiles for the specified Amazon Connect instance.
For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.
listSecurityProfiles
in interface AmazonConnect
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonConnect
Lists the tags for the specified resource.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
listTagsForResource
in interface AmazonConnect
public ListTaskTemplatesResult listTaskTemplates(ListTaskTemplatesRequest request)
AmazonConnect
Lists task templates for the specified Amazon Connect instance.
listTaskTemplates
in interface AmazonConnect
public ListTrafficDistributionGroupUsersResult listTrafficDistributionGroupUsers(ListTrafficDistributionGroupUsersRequest request)
AmazonConnect
Lists traffic distribution group users.
listTrafficDistributionGroupUsers
in interface AmazonConnect
public ListTrafficDistributionGroupsResult listTrafficDistributionGroups(ListTrafficDistributionGroupsRequest request)
AmazonConnect
Lists traffic distribution groups.
listTrafficDistributionGroups
in interface AmazonConnect
public ListUseCasesResult listUseCases(ListUseCasesRequest request)
AmazonConnect
Lists the use cases for the integration association.
listUseCases
in interface AmazonConnect
request
- Provides summary information about the use cases for the specified integration association.public ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest request)
AmazonConnect
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
listUserHierarchyGroups
in interface AmazonConnect
public ListUserProficienciesResult listUserProficiencies(ListUserProficienciesRequest request)
AmazonConnect
Lists proficiencies associated with a user.
listUserProficiencies
in interface AmazonConnect
public ListUsersResult listUsers(ListUsersRequest request)
AmazonConnect
Provides summary information about the users for the specified Amazon Connect instance.
listUsers
in interface AmazonConnect
public ListViewVersionsResult listViewVersions(ListViewVersionsRequest request)
AmazonConnect
Returns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
listViewVersions
in interface AmazonConnect
public ListViewsResult listViews(ListViewsRequest request)
AmazonConnect
Returns views in the given instance.
Results are sorted primarily by type, and secondarily by name.
listViews
in interface AmazonConnect
public MonitorContactResult monitorContact(MonitorContactRequest request)
AmazonConnect
Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.
monitorContact
in interface AmazonConnect
public PauseContactResult pauseContact(PauseContactRequest request)
AmazonConnect
Allows pausing an ongoing task contact.
pauseContact
in interface AmazonConnect
public PutUserStatusResult putUserStatus(PutUserStatusRequest request)
AmazonConnect
Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.
For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.
putUserStatus
in interface AmazonConnect
public ReleasePhoneNumberResult releasePhoneNumber(ReleasePhoneNumberRequest request)
AmazonConnect
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber
API, not the
Amazon Connect admin website.
After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
releasePhoneNumber
in interface AmazonConnect
public ReplicateInstanceResult replicateInstance(ReplicateInstanceRequest request)
AmazonConnect
Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.
replicateInstance
in interface AmazonConnect
public ResumeContactResult resumeContact(ResumeContactRequest request)
AmazonConnect
Allows resuming a task contact in a paused state.
resumeContact
in interface AmazonConnect
public ResumeContactRecordingResult resumeContactRecording(ResumeContactRecordingRequest request)
AmazonConnect
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.
Voice and screen recordings are supported.
resumeContactRecording
in interface AmazonConnect
public SearchAgentStatusesResult searchAgentStatuses(SearchAgentStatusesRequest request)
AmazonConnect
Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
searchAgentStatuses
in interface AmazonConnect
public SearchAvailablePhoneNumbersResult searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest request)
AmazonConnect
Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution
group. If the provided TargetArn
is a traffic distribution group, you can call this API in both
Amazon Web Services Regions associated with the traffic distribution group.
searchAvailablePhoneNumbers
in interface AmazonConnect
public SearchContactFlowModulesResult searchContactFlowModules(SearchContactFlowModulesRequest request)
AmazonConnect
Searches the flow modules in an Amazon Connect instance, with optional filtering.
searchContactFlowModules
in interface AmazonConnect
public SearchContactFlowsResult searchContactFlows(SearchContactFlowsRequest request)
AmazonConnect
Searches the contact flows in an Amazon Connect instance, with optional filtering.
searchContactFlows
in interface AmazonConnect
public SearchContactsResult searchContacts(SearchContactsRequest request)
AmazonConnect
Searches contacts in an Amazon Connect instance.
searchContacts
in interface AmazonConnect
public SearchHoursOfOperationsResult searchHoursOfOperations(SearchHoursOfOperationsRequest request)
AmazonConnect
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
searchHoursOfOperations
in interface AmazonConnect
public SearchPredefinedAttributesResult searchPredefinedAttributes(SearchPredefinedAttributesRequest request)
AmazonConnect
Predefined attributes that meet certain criteria.
searchPredefinedAttributes
in interface AmazonConnect
public SearchPromptsResult searchPrompts(SearchPromptsRequest request)
AmazonConnect
Searches prompts in an Amazon Connect instance, with optional filtering.
searchPrompts
in interface AmazonConnect
public SearchQueuesResult searchQueues(SearchQueuesRequest request)
AmazonConnect
Searches queues in an Amazon Connect instance, with optional filtering.
searchQueues
in interface AmazonConnect
public SearchQuickConnectsResult searchQuickConnects(SearchQuickConnectsRequest request)
AmazonConnect
Searches quick connects in an Amazon Connect instance, with optional filtering.
searchQuickConnects
in interface AmazonConnect
public SearchResourceTagsResult searchResourceTags(SearchResourceTagsRequest request)
AmazonConnect
Searches tags used in an Amazon Connect instance using optional search criteria.
searchResourceTags
in interface AmazonConnect
public SearchRoutingProfilesResult searchRoutingProfiles(SearchRoutingProfilesRequest request)
AmazonConnect
Searches routing profiles in an Amazon Connect instance, with optional filtering.
searchRoutingProfiles
in interface AmazonConnect
public SearchSecurityProfilesResult searchSecurityProfiles(SearchSecurityProfilesRequest request)
AmazonConnect
Searches security profiles in an Amazon Connect instance, with optional filtering.
searchSecurityProfiles
in interface AmazonConnect
public SearchUserHierarchyGroupsResult searchUserHierarchyGroups(SearchUserHierarchyGroupsRequest request)
AmazonConnect
Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
The UserHierarchyGroup with "LevelId": "0"
is the foundation for building levels on top of an
instance. It is not user-definable, nor is it visible in the UI.
searchUserHierarchyGroups
in interface AmazonConnect
public SearchUsersResult searchUsers(SearchUsersRequest request)
AmazonConnect
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit
is returned in milliseconds.
searchUsers
in interface AmazonConnect
public SearchVocabulariesResult searchVocabularies(SearchVocabulariesRequest request)
AmazonConnect
Searches for vocabularies within a specific Amazon Connect instance using State
,
NameStartsWith
, and LanguageCode
.
searchVocabularies
in interface AmazonConnect
public SendChatIntegrationEventResult sendChatIntegrationEvent(SendChatIntegrationEventRequest request)
AmazonConnect
Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:
SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat
When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.
Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.
sendChatIntegrationEvent
in interface AmazonConnect
public StartAttachedFileUploadResult startAttachedFileUpload(StartAttachedFileUploadRequest request)
AmazonConnect
Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to an Amazon Connect Case.
startAttachedFileUpload
in interface AmazonConnect
public StartChatContactResult startChatContact(StartChatContactRequest request)
AmazonConnect
Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
API rate limit is exceeded. API TPS throttling returns a TooManyRequests
exception.
The quota for
concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException
.
If you use the ChatDurationInMinutes
parameter and receive a 400 error, your account may not support
the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
startChatContact
in interface AmazonConnect
public StartContactEvaluationResult startContactEvaluation(StartContactEvaluationRequest request)
AmazonConnect
Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.
Evaluations created through the public API do not contain answer values suggested from automation.
startContactEvaluation
in interface AmazonConnect
public StartContactRecordingResult startContactRecording(StartContactRecordingRequest request)
AmazonConnect
Starts recording the contact:
If the API is called before the agent joins the call, recording starts when the agent joins the call.
If the API is called after the agent joins the call, recording starts at the time of the API call.
StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.
You can use this API to override the recording behavior configured in the Set recording behavior block.
Only voice recordings are supported at this time.
startContactRecording
in interface AmazonConnect
public StartContactStreamingResult startContactStreaming(StartContactStreamingRequest request)
AmazonConnect
Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
startContactStreaming
in interface AmazonConnect
public StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest request)
AmazonConnect
Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's
specified (in ContactFlowId
).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.
There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
Campaign calls are not allowed by default. Before you can make a call with TrafficType
=
CAMPAIGN
, you must submit a service quota increase request to the quota Amazon Connect campaigns.
startOutboundVoiceContact
in interface AmazonConnect
public StartTaskContactResult startTaskContact(StartTaskContactRequest request)
AmazonConnect
Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.
When using PreviousContactId
and RelatedContactId
input parameters, note the following:
PreviousContactId
Any updates to user-defined task contact attributes on any contact linked through the same
PreviousContactId
will affect every contact in the chain.
There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share
the same PreviousContactId
.
RelatedContactId
Copies contact attributes from the related task contact to the new contact.
Any update on attributes in a new task contact does not update attributes on previous contact.
There’s no limit on the number of task contacts that can be created that use the same
RelatedContactId
.
In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID
,
QuickConnectID
, or TaskTemplateID
. Only one parameter is required as long as the task
template has a flow configured to run it. If more than one parameter is specified, or only the
TaskTemplateID
is specified but it does not have a flow configured, the request returns an error
because Amazon Connect cannot identify the unique flow to run when the task is created.
A ServiceQuotaExceededException
occurs when the number of open tasks exceeds the active tasks quota
or there are already 12 tasks referencing the same PreviousContactId
. For more information about
service quotas for task contacts, see Amazon Connect
service quotas in the Amazon Connect Administrator Guide.
startTaskContact
in interface AmazonConnect
public StartWebRTCContactResult startWebRTCContact(StartWebRTCContactRequest request)
AmazonConnect
Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).
startWebRTCContact
in interface AmazonConnect
public StopContactResult stopContact(StopContactRequest request)
AmazonConnect
Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
EXTERNAL_OUTBOUND
MONITOR
Chat and task contacts can be terminated in any state, regardless of initiation method.
stopContact
in interface AmazonConnect
public StopContactRecordingResult stopContactRecording(StopContactRecordingRequest request)
AmazonConnect
Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.
Only voice recordings are supported at this time.
stopContactRecording
in interface AmazonConnect
public StopContactStreamingResult stopContactStreaming(StopContactStreamingRequest request)
AmazonConnect
Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
stopContactStreaming
in interface AmazonConnect
public SubmitContactEvaluationResult submitContactEvaluation(SubmitContactEvaluationRequest request)
AmazonConnect
Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged
with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted
with the existing answers and notes. You can delete an answer or note by passing an empty object ({}
) to the question identifier.
If a contact evaluation is already in submitted state, this operation will trigger a resubmission.
submitContactEvaluation
in interface AmazonConnect
public SuspendContactRecordingResult suspendContactRecording(SuspendContactRecordingRequest request)
AmazonConnect
When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.
The period of time that the recording is suspended is filled with silence in the final recording.
Voice and screen recordings are supported.
suspendContactRecording
in interface AmazonConnect
public TagContactResult tagContact(TagContactRequest request)
AmazonConnect
Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
tagContact
in interface AmazonConnect
public TagResourceResult tagResource(TagResourceRequest request)
AmazonConnect
Adds the specified tags to the specified resource.
Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
tagResource
in interface AmazonConnect
public TransferContactResult transferContact(TransferContactRequest request)
AmazonConnect
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.
Note the following requirements:
Transfer is supported for only TASK
contacts.
Do not use both QueueId
and UserId
in the same call.
The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
The TransferContact
API can be called only on active contacts.
A contact cannot be transferred more than 11 times.
transferContact
in interface AmazonConnect
public UntagContactResult untagContact(UntagContactRequest request)
AmazonConnect
Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
untagContact
in interface AmazonConnect
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonConnect
Removes the specified tags from the specified resource.
untagResource
in interface AmazonConnect
public UpdateAgentStatusResult updateAgentStatus(UpdateAgentStatusRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
updateAgentStatus
in interface AmazonConnect
public UpdateAuthenticationProfileResult updateAuthenticationProfile(UpdateAuthenticationProfileRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Updates the selected authentication profile.
updateAuthenticationProfile
in interface AmazonConnect
public UpdateContactResult updateContact(UpdateContactRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.
You can add or update user-defined contact information for both ongoing and completed contacts.
updateContact
in interface AmazonConnect
public UpdateContactAttributesResult updateContactAttributes(UpdateContactAttributesRequest request)
AmazonConnect
Creates or updates user-defined contact attributes associated with the specified contact.
You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.
updateContactAttributes
in interface AmazonConnect
public UpdateContactEvaluationResult updateContactEvaluation(UpdateContactEvaluationRequest request)
AmazonConnect
Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be
in draft state. Answers included in the request are merged with existing answers for the given evaluation. An
answer or note can be deleted by passing an empty object ({}
) to the question identifier.
updateContactEvaluation
in interface AmazonConnect
public UpdateContactFlowContentResult updateContactFlowContent(UpdateContactFlowContentRequest request)
AmazonConnect
Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For
example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
updateContactFlowContent
in interface AmazonConnect
public UpdateContactFlowMetadataResult updateContactFlowMetadata(UpdateContactFlowMetadataRequest request)
AmazonConnect
Updates metadata about specified flow.
updateContactFlowMetadata
in interface AmazonConnect
public UpdateContactFlowModuleContentResult updateContactFlowModuleContent(UpdateContactFlowModuleContentRequest request)
AmazonConnect
Updates specified flow module for the specified Amazon Connect instance.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For
example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
updateContactFlowModuleContent
in interface AmazonConnect
public UpdateContactFlowModuleMetadataResult updateContactFlowModuleMetadata(UpdateContactFlowModuleMetadataRequest request)
AmazonConnect
Updates metadata about specified flow module.
updateContactFlowModuleMetadata
in interface AmazonConnect
public UpdateContactFlowNameResult updateContactFlowName(UpdateContactFlowNameRequest request)
AmazonConnect
The name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
updateContactFlowName
in interface AmazonConnect
public UpdateContactRoutingDataResult updateContactRoutingData(UpdateContactRoutingDataRequest request)
AmazonConnect
Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.
updateContactRoutingData
in interface AmazonConnect
public UpdateContactScheduleResult updateContactSchedule(UpdateContactScheduleRequest request)
AmazonConnect
Updates the scheduled time of a task contact that is already scheduled.
updateContactSchedule
in interface AmazonConnect
public UpdateEvaluationFormResult updateEvaluationForm(UpdateEvaluationFormRequest request)
AmazonConnect
Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.
This operation does not support partial updates. Instead it does a full update of evaluation form content.
updateEvaluationForm
in interface AmazonConnect
public UpdateHoursOfOperationResult updateHoursOfOperation(UpdateHoursOfOperationRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
updateHoursOfOperation
in interface AmazonConnect
public UpdateInstanceAttributeResult updateInstanceAttribute(UpdateInstanceAttributeRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
updateInstanceAttribute
in interface AmazonConnect
public UpdateInstanceStorageConfigResult updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Updates an existing configuration for a resource type. This API is idempotent.
updateInstanceStorageConfig
in interface AmazonConnect
public UpdateParticipantRoleConfigResult updateParticipantRoleConfig(UpdateParticipantRoleConfigRequest request)
AmazonConnect
Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:
Customer idle timeout
Customer auto-disconnect timeout
Agent idle timeout
Agent auto-disconnect timeout
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
updateParticipantRoleConfig
in interface AmazonConnect
public UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest request)
AmazonConnect
Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.
You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.
updatePhoneNumber
in interface AmazonConnect
public UpdatePhoneNumberMetadataResult updatePhoneNumberMetadata(UpdatePhoneNumberMetadataRequest request)
AmazonConnect
Updates a phone number’s metadata.
To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
updatePhoneNumberMetadata
in interface AmazonConnect
public UpdatePredefinedAttributeResult updatePredefinedAttribute(UpdatePredefinedAttributeRequest request)
AmazonConnect
Updates a predefined attribute for the specified Amazon Connect instance.
updatePredefinedAttribute
in interface AmazonConnect
public UpdatePromptResult updatePrompt(UpdatePromptRequest request)
AmazonConnect
Updates a prompt.
updatePrompt
in interface AmazonConnect
public UpdateQueueHoursOfOperationResult updateQueueHoursOfOperation(UpdateQueueHoursOfOperationRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
updateQueueHoursOfOperation
in interface AmazonConnect
public UpdateQueueMaxContactsResult updateQueueMaxContacts(UpdateQueueMaxContactsRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Updates the maximum number of contacts allowed in a queue before it is considered full.
updateQueueMaxContacts
in interface AmazonConnect
public UpdateQueueNameResult updateQueueName(UpdateQueueNameRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a queue. At least Name
or Description
must be
provided.
updateQueueName
in interface AmazonConnect
public UpdateQueueOutboundCallerConfigResult updateQueueOutboundCallerConfig(UpdateQueueOutboundCallerConfigRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon
Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for
OutboundCallerIdNumberId
. However, if the phone number is claimed to a traffic distribution group
that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that
is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is
provided in this scenario, you will receive a ResourceNotFoundException
.
Only use the phone number ARN format that doesn't contain instance
in the path, for example,
arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned
when you call the ListPhoneNumbersV2
API.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
updateQueueOutboundCallerConfig
in interface AmazonConnect
public UpdateQueueStatusResult updateQueueStatus(UpdateQueueStatusRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
updateQueueStatus
in interface AmazonConnect
public UpdateQuickConnectConfigResult updateQuickConnectConfig(UpdateQuickConnectConfigRequest request)
AmazonConnect
Updates the configuration settings for the specified quick connect.
updateQuickConnectConfig
in interface AmazonConnect
public UpdateQuickConnectNameResult updateQuickConnectName(UpdateQuickConnectNameRequest request)
AmazonConnect
Updates the name and description of a quick connect. The request accepts the following data in JSON format. At
least Name
or Description
must be provided.
updateQuickConnectName
in interface AmazonConnect
public UpdateRoutingProfileAgentAvailabilityTimerResult updateRoutingProfileAgentAvailabilityTimer(UpdateRoutingProfileAgentAvailabilityTimerRequest request)
AmazonConnect
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
updateRoutingProfileAgentAvailabilityTimer
in interface AmazonConnect
public UpdateRoutingProfileConcurrencyResult updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest request)
AmazonConnect
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
updateRoutingProfileConcurrency
in interface AmazonConnect
public UpdateRoutingProfileDefaultOutboundQueueResult updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest request)
AmazonConnect
Updates the default outbound queue of a routing profile.
updateRoutingProfileDefaultOutboundQueue
in interface AmazonConnect
public UpdateRoutingProfileNameResult updateRoutingProfileName(UpdateRoutingProfileNameRequest request)
AmazonConnect
Updates the name and description of a routing profile. The request accepts the following data in JSON format. At
least Name
or Description
must be provided.
updateRoutingProfileName
in interface AmazonConnect
public UpdateRoutingProfileQueuesResult updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest request)
AmazonConnect
Updates the properties associated with a set of queues for a routing profile.
updateRoutingProfileQueues
in interface AmazonConnect
public UpdateRuleResult updateRule(UpdateRuleRequest request)
AmazonConnect
Updates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
updateRule
in interface AmazonConnect
public UpdateSecurityProfileResult updateSecurityProfile(UpdateSecurityProfileRequest request)
AmazonConnect
Updates a security profile.
updateSecurityProfile
in interface AmazonConnect
public UpdateTaskTemplateResult updateTaskTemplate(UpdateTaskTemplateRequest request)
AmazonConnect
Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.
updateTaskTemplate
in interface AmazonConnect
public UpdateTrafficDistributionResult updateTrafficDistribution(UpdateTrafficDistributionRequest request)
AmazonConnect
Updates the traffic distribution for a given traffic distribution group.
The SignInConfig
distribution is available only on a default TrafficDistributionGroup
(see the IsDefault
parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution
with a modified
SignInConfig
and a non-default TrafficDistributionGroup
, an
InvalidRequestException
is returned.
For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.
updateTrafficDistribution
in interface AmazonConnect
public UpdateUserHierarchyResult updateUserHierarchy(UpdateUserHierarchyRequest request)
AmazonConnect
Assigns the specified hierarchy group to the specified user.
updateUserHierarchy
in interface AmazonConnect
public UpdateUserHierarchyGroupNameResult updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest request)
AmazonConnect
Updates the name of the user hierarchy group.
updateUserHierarchyGroupName
in interface AmazonConnect
public UpdateUserHierarchyStructureResult updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest request)
AmazonConnect
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
updateUserHierarchyStructure
in interface AmazonConnect
public UpdateUserIdentityInfoResult updateUserIdentityInfo(UpdateUserIdentityInfoRequest request)
AmazonConnect
Updates the identity information for the specified user.
We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo
. Someone with
that ability can change the login credentials of other users by changing their email address. This poses a
security risk to your organization. They can change the email address of a user to the attacker's email address,
and then reset the password through email. For more information, see Best Practices
for Security Profiles in the Amazon Connect Administrator Guide.
updateUserIdentityInfo
in interface AmazonConnect
public UpdateUserPhoneConfigResult updateUserPhoneConfig(UpdateUserPhoneConfigRequest request)
AmazonConnect
Updates the phone configuration settings for the specified user.
updateUserPhoneConfig
in interface AmazonConnect
public UpdateUserProficienciesResult updateUserProficiencies(UpdateUserProficienciesRequest request)
AmazonConnect
Updates the properties associated with the proficiencies of a user.
updateUserProficiencies
in interface AmazonConnect
public UpdateUserRoutingProfileResult updateUserRoutingProfile(UpdateUserRoutingProfileRequest request)
AmazonConnect
Assigns the specified routing profile to the specified user.
updateUserRoutingProfile
in interface AmazonConnect
public UpdateUserSecurityProfilesResult updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest request)
AmazonConnect
Assigns the specified security profiles to the specified user.
updateUserSecurityProfiles
in interface AmazonConnect
public UpdateViewContentResult updateViewContent(UpdateViewContentRequest request)
AmazonConnect
Updates the view content of the given view identifier in the specified Amazon Connect instance.
It performs content validation if Status
is set to SAVED
and performs full content
validation if Status
is PUBLISHED
. Note that the $SAVED
alias' content
will always be updated, but the $LATEST
alias' content will only be updated if Status
is PUBLISHED
.
updateViewContent
in interface AmazonConnect
public UpdateViewMetadataResult updateViewMetadata(UpdateViewMetadataRequest request)
AmazonConnect
Updates the view metadata. Note that either Name
or Description
must be provided.
updateViewMetadata
in interface AmazonConnect
public void shutdown()
AmazonConnect
shutdown
in interface AmazonConnect
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonConnect
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonConnect
request
- The originally executed request.