@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 |
---|---|
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.
|
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.
|
ClaimPhoneNumberResult |
claimPhoneNumber(ClaimPhoneNumberRequest request)
Claims an available phone number to your Amazon Connect instance or traffic distribution group.
|
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.
|
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.
|
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)
This API is in preview release for Amazon Connect and is subject to change.
|
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.
|
CreateVocabularyResult |
createVocabulary(CreateVocabularyRequest request)
Creates a custom vocabulary associated with your 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.
|
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.
|
DeleteQuickConnectResult |
deleteQuickConnect(DeleteQuickConnectRequest request)
Deletes a quick connect.
|
DeleteRuleResult |
deleteRule(DeleteRuleRequest request)
Deletes a rule for the specified Amazon Connect instance.
|
DeleteSecurityProfileResult |
deleteSecurityProfile(DeleteSecurityProfileRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
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.
|
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.
|
DescribeContactResult |
describeContact(DescribeContactRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeContactFlowResult |
describeContactFlow(DescribeContactFlowRequest request)
Describes the specified flow.
|
DescribeContactFlowModuleResult |
describeContactFlowModule(DescribeContactFlowModuleRequest request)
Describes the specified flow module.
|
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.
|
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)
This API is in preview release for Amazon Connect and is subject to change.
|
DescribeTrafficDistributionGroupResult |
describeTrafficDistributionGroup(DescribeTrafficDistributionGroupRequest request)
Gets details and status of a traffic distribution group.
|
DescribeUserResult |
describeUser(DescribeUserRequest request)
Describes the specified user account.
|
DescribeUserHierarchyGroupResult |
describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest request)
Describes the specified hierarchy group.
|
DescribeUserHierarchyStructureResult |
describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest request)
Describes the hierarchy structure of the specified Amazon Connect instance.
|
DescribeVocabularyResult |
describeVocabulary(DescribeVocabularyRequest request)
Describes the specified vocabulary.
|
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.
|
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.
|
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.
|
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)
Retrieves a token for federation.
|
GetMetricDataResult |
getMetricData(GetMetricDataRequest request)
Gets historical metric data from the specified Amazon Connect instance.
|
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.
|
ListAgentStatusesResult |
listAgentStatuses(ListAgentStatusesRequest 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.
|
ListBotsResult |
listBots(ListBotsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
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.
|
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.
|
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.
|
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.
|
ListSecurityProfilePermissionsResult |
listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
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.
|
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.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Provides summary information about the users for the specified Amazon Connect instance.
|
MonitorContactResult |
monitorContact(MonitorContactRequest request)
Initiates silent monitoring of a 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.
|
ResumeContactRecordingResult |
resumeContactRecording(ResumeContactRecordingRequest request)
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API
resumes recording the call.
|
SearchAvailablePhoneNumbersResult |
searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest request)
Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution
group.
|
SearchQueuesResult |
searchQueues(SearchQueuesRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
SearchRoutingProfilesResult |
searchRoutingProfiles(SearchRoutingProfilesRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
SearchSecurityProfilesResult |
searchSecurityProfiles(SearchSecurityProfilesRequest request)
This API is in preview release for Amazon Connect and is subject to change.
|
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 . |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartChatContactResult |
startChatContact(StartChatContactRequest request)
Initiates a flow to start a new chat for the customer.
|
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.
|
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.
|
SuspendContactRecordingResult |
suspendContactRecording(SuspendContactRecordingRequest request)
When a contact is being recorded, this API suspends recording the call.
|
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.
|
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.
|
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.
|
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.
|
UpdateContactScheduleResult |
updateContactSchedule(UpdateContactScheduleRequest request)
Updates the scheduled time of a task contact that is already scheduled.
|
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.
|
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.
|
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.
|
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)
This API is in preview release for Amazon Connect and is subject to change.
|
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.
|
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.
|
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 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 bot.
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 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.
claimPhoneNumber
in interface AmazonConnect
public 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 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 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 number being used in the input 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 OutboundCallerIdNumberId
value of the OutboundCallerConfig
request body 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
.
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.
createRule
in interface AmazonConnect
public CreateSecurityProfileResult createSecurityProfile(CreateSecurityProfileRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
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.
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.
For information about how to create user accounts using the Amazon Connect console, 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 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 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 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 DeleteQuickConnectResult deleteQuickConnect(DeleteQuickConnectRequest request)
AmazonConnect
Deletes a quick connect.
deleteQuickConnect
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
This API is in preview release for Amazon Connect and is subject to change.
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.
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 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 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 DescribeContactFlowResult describeContactFlow(DescribeContactFlowRequest request)
AmazonConnect
Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
describeContactFlow
in interface AmazonConnect
public DescribeContactFlowModuleResult describeContactFlowModule(DescribeContactFlowModuleRequest request)
AmazonConnect
Describes the specified flow module.
describeContactFlowModule
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 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
This API is in preview release for Amazon Connect and is subject to change.
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 account. You can find the instance ID in the 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 DescribeVocabularyResult describeVocabulary(DescribeVocabularyRequest request)
AmazonConnect
Describes the specified vocabulary.
describeVocabulary
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 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 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 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
Retrieves a token for federation.
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 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.
getMetricData
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 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 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 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 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.
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 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.
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.
listPhoneNumbersV2
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 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 ListSecurityProfilePermissionsResult listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
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 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 ListUsersResult listUsers(ListUsersRequest request)
AmazonConnect
Provides summary information about the users for the specified Amazon Connect instance.
listUsers
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 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 console.
After releasing a phone number, the phone number enters into a cooldown period of 30 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.
releasePhoneNumber
in interface AmazonConnect
public ReplicateInstanceResult replicateInstance(ReplicateInstanceRequest request)
AmazonConnect
Replicates an Amazon Connect instance in the specified Amazon Web Services Region.
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 ResumeContactRecordingResult resumeContactRecording(ResumeContactRecordingRequest request)
AmazonConnect
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.
Only voice recordings are supported at this time.
resumeContactRecording
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 SearchQueuesResult searchQueues(SearchQueuesRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Searches queues in an Amazon Connect instance, with optional filtering.
searchQueues
in interface AmazonConnect
public SearchRoutingProfilesResult searchRoutingProfiles(SearchRoutingProfilesRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Searches routing profiles in an Amazon Connect instance, with optional filtering.
searchRoutingProfiles
in interface AmazonConnect
public SearchSecurityProfilesResult searchSecurityProfiles(SearchSecurityProfilesRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
Searches security profiles in an Amazon Connect instance, with optional filtering.
searchSecurityProfiles
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 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 Chat in the Amazon Connect Administrator Guide.
startChatContact
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.
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.
startTaskContact
in interface AmazonConnect
public StopContactResult stopContact(StopContactRequest request)
AmazonConnect
Ends the specified contact. This call does not work for the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
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 SuspendContactRecordingResult suspendContactRecording(SuspendContactRecordingRequest request)
AmazonConnect
When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.
The period of time that the recording is suspended is filled with silence in the final recording.
Only voice recordings are supported at this time.
suspendContactRecording
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 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 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 UpdateContactFlowContentResult updateContactFlowContent(UpdateContactFlowContentRequest request)
AmazonConnect
Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
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.
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 UpdateContactScheduleResult updateContactSchedule(UpdateContactScheduleRequest request)
AmazonConnect
Updates the scheduled time of a task contact that is already scheduled.
updateContactSchedule
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 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.
You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.
updatePhoneNumber
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 number being used in the input 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 OutboundCallerIdNumberId
value of the OutboundCallerConfig
request body 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
.
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 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.
updateRule
in interface AmazonConnect
public UpdateSecurityProfileResult updateSecurityProfile(UpdateSecurityProfileRequest request)
AmazonConnect
This API is in preview release for Amazon Connect and is subject to change.
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.
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 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 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.