public interface AmazonConnect
Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides rich metrics and real-time reporting that allow you to optimize contact routing. You can also resolve customer issues more efficiently by putting customers in touch with the right agents.
There are limits to the number of Amazon Connect resources that you can create and limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
To connect programmatically to an AWS service, you use an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
Working with contact flows? Check out the Amazon Connect Flow language.
| Modifier and Type | Method and Description |
|---|---|
void |
associateApprovedOrigin(AssociateApprovedOriginRequest associateApprovedOriginRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
AssociateInstanceStorageConfigResult |
associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest associateInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
associateLambdaFunction(AssociateLambdaFunctionRequest associateLambdaFunctionRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
associateLexBot(AssociateLexBotRequest associateLexBotRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest)
Associates a set of queues with a routing profile.
|
AssociateSecurityKeyResult |
associateSecurityKey(AssociateSecurityKeyRequest associateSecurityKeyRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
CreateContactFlowResult |
createContactFlow(CreateContactFlowRequest createContactFlowRequest)
Creates a contact flow for the specified Amazon Connect instance.
|
CreateInstanceResult |
createInstance(CreateInstanceRequest createInstanceRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
CreateIntegrationAssociationResult |
createIntegrationAssociation(CreateIntegrationAssociationRequest createIntegrationAssociationRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
CreateQuickConnectResult |
createQuickConnect(CreateQuickConnectRequest createQuickConnectRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
CreateRoutingProfileResult |
createRoutingProfile(CreateRoutingProfileRequest createRoutingProfileRequest)
Creates a new routing profile.
|
CreateUseCaseResult |
createUseCase(CreateUseCaseRequest createUseCaseRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
CreateUserResult |
createUser(CreateUserRequest createUserRequest)
Creates a user account for the specified Amazon Connect instance.
|
CreateUserHierarchyGroupResult |
createUserHierarchyGroup(CreateUserHierarchyGroupRequest createUserHierarchyGroupRequest)
Creates a new user hierarchy group.
|
void |
deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
deleteIntegrationAssociation(DeleteIntegrationAssociationRequest deleteIntegrationAssociationRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
deleteQuickConnect(DeleteQuickConnectRequest deleteQuickConnectRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
deleteUseCase(DeleteUseCaseRequest deleteUseCaseRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user account from the specified Amazon Connect instance.
|
void |
deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest deleteUserHierarchyGroupRequest)
Deletes an existing user hierarchy group.
|
DescribeContactFlowResult |
describeContactFlow(DescribeContactFlowRequest describeContactFlowRequest)
Describes the specified contact flow.
|
DescribeInstanceResult |
describeInstance(DescribeInstanceRequest describeInstanceRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
DescribeInstanceAttributeResult |
describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
DescribeInstanceStorageConfigResult |
describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest describeInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
DescribeQuickConnectResult |
describeQuickConnect(DescribeQuickConnectRequest describeQuickConnectRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
DescribeRoutingProfileResult |
describeRoutingProfile(DescribeRoutingProfileRequest describeRoutingProfileRequest)
Describes the specified routing profile.
|
DescribeUserResult |
describeUser(DescribeUserRequest describeUserRequest)
Describes the specified user account.
|
DescribeUserHierarchyGroupResult |
describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest)
Describes the specified hierarchy group.
|
DescribeUserHierarchyStructureResult |
describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest)
Describes the hierarchy structure of the specified Amazon Connect
instance.
|
void |
disassociateApprovedOrigin(DisassociateApprovedOriginRequest disassociateApprovedOriginRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest disassociateInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
disassociateLambdaFunction(DisassociateLambdaFunctionRequest disassociateLambdaFunctionRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
disassociateLexBot(DisassociateLexBotRequest disassociateLexBotRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest disassociateRoutingProfileQueuesRequest)
Disassociates a set of queues from a routing profile.
|
void |
disassociateSecurityKey(DisassociateSecurityKeyRequest disassociateSecurityKeyRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
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 getContactAttributesRequest)
Retrieves the contact attributes for the specified contact.
|
GetCurrentMetricDataResult |
getCurrentMetricData(GetCurrentMetricDataRequest getCurrentMetricDataRequest)
Gets the real-time metric data from the specified Amazon Connect
instance.
|
GetFederationTokenResult |
getFederationToken(GetFederationTokenRequest getFederationTokenRequest)
Retrieves a token for federation.
|
GetMetricDataResult |
getMetricData(GetMetricDataRequest getMetricDataRequest)
Gets historical metric data from the specified Amazon Connect instance.
|
ListApprovedOriginsResult |
listApprovedOrigins(ListApprovedOriginsRequest listApprovedOriginsRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListContactFlowsResult |
listContactFlows(ListContactFlowsRequest listContactFlowsRequest)
Provides information about the contact flows for the specified Amazon
Connect instance.
|
ListHoursOfOperationsResult |
listHoursOfOperations(ListHoursOfOperationsRequest listHoursOfOperationsRequest)
Provides information about the hours of operation for the specified
Amazon Connect instance.
|
ListInstanceAttributesResult |
listInstanceAttributes(ListInstanceAttributesRequest listInstanceAttributesRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListInstancesResult |
listInstances(ListInstancesRequest listInstancesRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListInstanceStorageConfigsResult |
listInstanceStorageConfigs(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListIntegrationAssociationsResult |
listIntegrationAssociations(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListLambdaFunctionsResult |
listLambdaFunctions(ListLambdaFunctionsRequest listLambdaFunctionsRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListLexBotsResult |
listLexBots(ListLexBotsRequest listLexBotsRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListPhoneNumbersResult |
listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest)
Provides information about the phone numbers for the specified Amazon
Connect instance.
|
ListPromptsResult |
listPrompts(ListPromptsRequest listPromptsRequest)
Provides information about the prompts for the specified Amazon Connect
instance.
|
ListQueuesResult |
listQueues(ListQueuesRequest listQueuesRequest)
Provides information about the queues for the specified Amazon Connect
instance.
|
ListQuickConnectsResult |
listQuickConnects(ListQuickConnectsRequest listQuickConnectsRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListRoutingProfileQueuesResult |
listRoutingProfileQueues(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest)
List the queues associated with a routing profile.
|
ListRoutingProfilesResult |
listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest)
Provides summary information about the routing profiles for the specified
Amazon Connect instance.
|
ListSecurityKeysResult |
listSecurityKeys(ListSecurityKeysRequest listSecurityKeysRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListSecurityProfilesResult |
listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest)
Provides summary information about the security profiles for the
specified Amazon Connect instance.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for the specified resource.
|
ListUseCasesResult |
listUseCases(ListUseCasesRequest listUseCasesRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
ListUserHierarchyGroupsResult |
listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)
Provides summary information about the hierarchy groups for the specified
Amazon Connect instance.
|
ListUsersResult |
listUsers(ListUsersRequest listUsersRequest)
Provides summary information about the users for the specified Amazon
Connect instance.
|
ResumeContactRecordingResult |
resumeContactRecording(ResumeContactRecordingRequest resumeContactRecordingRequest)
When a contact is being recorded, and the recording has been suspended
using SuspendContactRecording, this API resumes recording the call.
|
void |
setEndpoint(java.lang.String endpoint)
Overrides the default endpoint for this client
("https://connect.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String), sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartChatContactResult |
startChatContact(StartChatContactRequest startChatContactRequest)
Initiates a contact flow to start a new chat for the customer.
|
StartContactRecordingResult |
startContactRecording(StartContactRecordingRequest startContactRecordingRequest)
This API starts recording the contact when the agent joins the call.
|
StartOutboundVoiceContactResult |
startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest)
This API places an outbound call to a contact, and then initiates the
contact flow.
|
StartTaskContactResult |
startTaskContact(StartTaskContactRequest startTaskContactRequest)
Initiates a contact flow to start a new task.
|
StopContactResult |
stopContact(StopContactRequest stopContactRequest)
Ends the specified contact.
|
StopContactRecordingResult |
stopContactRecording(StopContactRecordingRequest stopContactRecordingRequest)
When a contact is being recorded, this API stops recording the call.
|
SuspendContactRecordingResult |
suspendContactRecording(SuspendContactRecordingRequest suspendContactRecordingRequest)
When a contact is being recorded, this API suspends recording the call.
|
void |
tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource.
|
void |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified resource.
|
UpdateContactAttributesResult |
updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest)
Creates or updates the contact attributes associated with the specified
contact.
|
void |
updateContactFlowContent(UpdateContactFlowContentRequest updateContactFlowContentRequest)
Updates the specified contact flow.
|
void |
updateContactFlowName(UpdateContactFlowNameRequest updateContactFlowNameRequest)
The name of the contact flow.
|
void |
updateInstanceAttribute(UpdateInstanceAttributeRequest updateInstanceAttributeRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest updateInstanceStorageConfigRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
updateQuickConnectConfig(UpdateQuickConnectConfigRequest updateQuickConnectConfigRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
updateQuickConnectName(UpdateQuickConnectNameRequest updateQuickConnectNameRequest)
This API is in preview release for Amazon Connect and is subject to
change.
|
void |
updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest)
Updates the channels that agents can handle in the Contact Control Panel
(CCP) for a routing profile.
|
void |
updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest updateRoutingProfileDefaultOutboundQueueRequest)
Updates the default outbound queue of a routing profile.
|
void |
updateRoutingProfileName(UpdateRoutingProfileNameRequest updateRoutingProfileNameRequest)
Updates the name and description of a routing profile.
|
void |
updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest updateRoutingProfileQueuesRequest)
Updates the properties associated with a set of queues for a routing
profile.
|
void |
updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest)
Assigns the specified hierarchy group to the specified user.
|
void |
updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest updateUserHierarchyGroupNameRequest)
Updates the name of the user hierarchy group.
|
void |
updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest updateUserHierarchyStructureRequest)
Updates the user hierarchy structure: add, remove, and rename user
hierarchy levels.
|
void |
updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest)
Updates the identity information for the specified user.
|
void |
updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest)
Updates the phone configuration settings for the specified user.
|
void |
updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest)
Assigns the specified routing profile to the specified user.
|
void |
updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest)
Assigns the specified security profiles to the specified user.
|
void setEndpoint(java.lang.String endpoint)
throws java.lang.IllegalArgumentException
Callers can pass in just the endpoint (ex:
"connect.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://connect.us-east-1.amazonaws.com"). If the protocol is not
specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "connect.us-east-1.amazonaws.com") or a
full URL, including the protocol (ex:
"https://connect.us-east-1.amazonaws.com") of the region
specific AWS endpoint this client will communicate with.java.lang.IllegalArgumentException - If any problems are detected with the
specified endpoint.void setRegion(Region region) throws java.lang.IllegalArgumentException
setEndpoint(String), sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region.java.lang.IllegalArgumentException - If the given region is null,
or if this service isn't available in the given region. See
Region.isServiceSupported(String)Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)void associateApprovedOrigin(AssociateApprovedOriginRequest associateApprovedOriginRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
associateApprovedOriginRequest - ResourceNotFoundExceptionResourceConflictExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionServiceQuotaExceededExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.AssociateInstanceStorageConfigResult associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest associateInstanceStorageConfigRequest) throws AmazonClientException, AmazonServiceException
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 Amazon S3 bucket, exists when being used for association.
associateInstanceStorageConfigRequest - ResourceNotFoundExceptionResourceConflictExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void associateLambdaFunction(AssociateLambdaFunctionRequest associateLambdaFunctionRequest) throws AmazonClientException, AmazonServiceException
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.
associateLambdaFunctionRequest - ResourceNotFoundExceptionResourceConflictExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionServiceQuotaExceededExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void associateLexBot(AssociateLexBotRequest associateLexBotRequest) throws AmazonClientException, AmazonServiceException
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.
associateLexBotRequest - ResourceNotFoundExceptionResourceConflictExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionServiceQuotaExceededExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest) throws AmazonClientException, AmazonServiceException
Associates a set of queues with a routing profile.
associateRoutingProfileQueuesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.AssociateSecurityKeyResult associateSecurityKey(AssociateSecurityKeyRequest associateSecurityKeyRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
associateSecurityKeyRequest - ResourceNotFoundExceptionResourceConflictExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionServiceQuotaExceededExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateContactFlowResult createContactFlow(CreateContactFlowRequest createContactFlowRequest) throws AmazonClientException, AmazonServiceException
Creates a contact flow for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
createContactFlowRequest - InvalidRequestExceptionInvalidContactFlowExceptionInvalidParameterExceptionDuplicateResourceExceptionLimitExceededExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateInstanceResult createInstance(CreateInstanceRequest createInstanceRequest) throws AmazonClientException, AmazonServiceException
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 S3, or Kinesis) or allow for any configurations on features such as Contact Lens for Amazon Connect.
createInstanceRequest - InvalidRequestExceptionServiceQuotaExceededExceptionThrottlingExceptionResourceNotFoundExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateIntegrationAssociationResult createIntegrationAssociation(CreateIntegrationAssociationRequest createIntegrationAssociationRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Create an AppIntegration association with an Amazon Connect instance.
createIntegrationAssociationRequest - DuplicateResourceExceptionResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateQuickConnectResult createQuickConnect(CreateQuickConnectRequest createQuickConnectRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Creates a quick connect for the specified Amazon Connect instance.
createQuickConnectRequest - InvalidRequestExceptionInvalidParameterExceptionDuplicateResourceExceptionResourceNotFoundExceptionLimitExceededExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateRoutingProfileResult createRoutingProfile(CreateRoutingProfileRequest createRoutingProfileRequest) throws AmazonClientException, AmazonServiceException
Creates a new routing profile.
createRoutingProfileRequest - InvalidRequestExceptionInvalidParameterExceptionDuplicateResourceExceptionResourceNotFoundExceptionLimitExceededExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateUseCaseResult createUseCase(CreateUseCaseRequest createUseCaseRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Creates a use case for an AppIntegration association.
createUseCaseRequest - DuplicateResourceExceptionResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateUserResult createUser(CreateUserRequest createUserRequest) throws AmazonClientException, AmazonServiceException
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.
createUserRequest - InvalidRequestExceptionInvalidParameterExceptionLimitExceededExceptionDuplicateResourceExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.CreateUserHierarchyGroupResult createUserHierarchyGroup(CreateUserHierarchyGroupRequest createUserHierarchyGroupRequest) throws AmazonClientException, AmazonServiceException
Creates a new user hierarchy group.
createUserHierarchyGroupRequest - InvalidRequestExceptionInvalidParameterExceptionDuplicateResourceExceptionLimitExceededExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteInstance(DeleteInstanceRequest deleteInstanceRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
deleteInstanceRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteIntegrationAssociation(DeleteIntegrationAssociationRequest deleteIntegrationAssociationRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Deletes an AppIntegration association from an Amazon Connect instance. The association must not have any use cases associated with it.
deleteIntegrationAssociationRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteQuickConnect(DeleteQuickConnectRequest deleteQuickConnectRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Deletes a quick connect.
deleteQuickConnectRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteUseCase(DeleteUseCaseRequest deleteUseCaseRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Deletes a use case from an AppIntegration association.
deleteUseCaseRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteUser(DeleteUserRequest deleteUserRequest) throws AmazonClientException, AmazonServiceException
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.
deleteUserRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest deleteUserHierarchyGroupRequest) throws AmazonClientException, AmazonServiceException
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
deleteUserHierarchyGroupRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionResourceInUseExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeContactFlowResult describeContactFlow(DescribeContactFlowRequest describeContactFlowRequest) throws AmazonClientException, AmazonServiceException
Describes the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
describeContactFlowRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionContactFlowNotPublishedExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeInstanceResult describeInstance(DescribeInstanceRequest describeInstanceRequest) throws AmazonClientException, AmazonServiceException
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.
describeInstanceRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
describeInstanceAttributeRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeInstanceStorageConfigResult describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest describeInstanceStorageConfigRequest) throws AmazonClientException, AmazonServiceException
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.
describeInstanceStorageConfigRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeQuickConnectResult describeQuickConnect(DescribeQuickConnectRequest describeQuickConnectRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Describes the quick connect.
describeQuickConnectRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeRoutingProfileResult describeRoutingProfile(DescribeRoutingProfileRequest describeRoutingProfileRequest) throws AmazonClientException, AmazonServiceException
Describes the specified routing profile.
describeRoutingProfileRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeUserResult describeUser(DescribeUserRequest describeUserRequest) throws AmazonClientException, AmazonServiceException
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.
describeUserRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeUserHierarchyGroupResult describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest) throws AmazonClientException, AmazonServiceException
Describes the specified hierarchy group.
describeUserHierarchyGroupRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.DescribeUserHierarchyStructureResult describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest) throws AmazonClientException, AmazonServiceException
Describes the hierarchy structure of the specified Amazon Connect instance.
describeUserHierarchyStructureRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void disassociateApprovedOrigin(DisassociateApprovedOriginRequest disassociateApprovedOriginRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
disassociateApprovedOriginRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest disassociateInstanceStorageConfigRequest) throws AmazonClientException, AmazonServiceException
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.
disassociateInstanceStorageConfigRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void disassociateLambdaFunction(DisassociateLambdaFunctionRequest disassociateLambdaFunctionRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Remove the Lambda function from the drop-down options available in the relevant contact flow blocks.
disassociateLambdaFunctionRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void disassociateLexBot(DisassociateLexBotRequest disassociateLexBotRequest) throws AmazonClientException, AmazonServiceException
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.
disassociateLexBotRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest disassociateRoutingProfileQueuesRequest) throws AmazonClientException, AmazonServiceException
Disassociates a set of queues from a routing profile.
disassociateRoutingProfileQueuesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void disassociateSecurityKey(DisassociateSecurityKeyRequest disassociateSecurityKeyRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
disassociateSecurityKeyRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.GetContactAttributesResult getContactAttributes(GetContactAttributesRequest getContactAttributesRequest) throws AmazonClientException, AmazonServiceException
Retrieves the contact attributes for the specified contact.
getContactAttributesRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.GetCurrentMetricDataResult getCurrentMetricData(GetCurrentMetricDataRequest getCurrentMetricDataRequest) throws AmazonClientException, AmazonServiceException
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.
getCurrentMetricDataRequest - InvalidRequestExceptionInvalidParameterExceptionInternalServiceExceptionThrottlingExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.GetFederationTokenResult getFederationToken(GetFederationTokenRequest getFederationTokenRequest) throws AmazonClientException, AmazonServiceException
Retrieves a token for federation.
getFederationTokenRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionUserNotFoundExceptionInternalServiceExceptionDuplicateResourceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.GetMetricDataResult getMetricData(GetMetricDataRequest getMetricDataRequest) throws AmazonClientException, AmazonServiceException
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.
getMetricDataRequest - InvalidRequestExceptionInvalidParameterExceptionInternalServiceExceptionThrottlingExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListApprovedOriginsResult listApprovedOrigins(ListApprovedOriginsRequest listApprovedOriginsRequest) throws AmazonClientException, AmazonServiceException
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.
listApprovedOriginsRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListContactFlowsResult listContactFlows(ListContactFlowsRequest listContactFlowsRequest) throws AmazonClientException, AmazonServiceException
Provides information about the contact flows for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide.
listContactFlowsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListHoursOfOperationsResult listHoursOfOperations(ListHoursOfOperationsRequest listHoursOfOperationsRequest) throws AmazonClientException, AmazonServiceException
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.
listHoursOfOperationsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListInstanceAttributesResult listInstanceAttributes(ListInstanceAttributesRequest listInstanceAttributesRequest) throws AmazonClientException, AmazonServiceException
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.
listInstanceAttributesRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListInstanceStorageConfigsResult listInstanceStorageConfigs(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest) throws AmazonClientException, AmazonServiceException
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.
listInstanceStorageConfigsRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListInstancesResult listInstances(ListInstancesRequest listInstancesRequest) throws AmazonClientException, AmazonServiceException
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.
listInstancesRequest - InvalidRequestExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListIntegrationAssociationsResult listIntegrationAssociations(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Provides summary information about the AppIntegration associations for the specified Amazon Connect instance.
listIntegrationAssociationsRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListLambdaFunctionsResult listLambdaFunctions(ListLambdaFunctionsRequest listLambdaFunctionsRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Lambda functions that show up in the drop-down options in the relevant contact flow blocks.
listLambdaFunctionsRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListLexBotsResult listLexBots(ListLexBotsRequest listLexBotsRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex bots currently associated with the instance.
listLexBotsRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest) throws AmazonClientException, AmazonServiceException
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.
listPhoneNumbersRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListPromptsResult listPrompts(ListPromptsRequest listPromptsRequest) throws AmazonClientException, AmazonServiceException
Provides information about the prompts for the specified Amazon Connect instance.
listPromptsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest) throws AmazonClientException, AmazonServiceException
Provides information about the queues for the specified Amazon Connect instance.
For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.
listQueuesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListQuickConnectsResult listQuickConnects(ListQuickConnectsRequest listQuickConnectsRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Provides information about the quick connects for the specified Amazon Connect instance.
listQuickConnectsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListRoutingProfileQueuesResult listRoutingProfileQueues(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest) throws AmazonClientException, AmazonServiceException
List the queues associated with a routing profile.
listRoutingProfileQueuesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest) throws AmazonClientException, AmazonServiceException
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.
listRoutingProfilesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListSecurityKeysResult listSecurityKeys(ListSecurityKeysRequest listSecurityKeysRequest) throws AmazonClientException, AmazonServiceException
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.
listSecurityKeysRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest) throws AmazonClientException, AmazonServiceException
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.
listSecurityProfilesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AmazonClientException, AmazonServiceException
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.
listTagsForResourceRequest - InvalidRequestExceptionInvalidParameterExceptionInternalServiceExceptionResourceNotFoundExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListUseCasesResult listUseCases(ListUseCasesRequest listUseCasesRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
List the use cases.
listUseCasesRequest - Provides summary information about the use cases for the specified Amazon Connect AppIntegration association.
ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest) throws AmazonClientException, AmazonServiceException
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.
listUserHierarchyGroupsRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ListUsersResult listUsers(ListUsersRequest listUsersRequest) throws AmazonClientException, AmazonServiceException
Provides summary information about the users for the specified Amazon Connect instance.
listUsersRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.ResumeContactRecordingResult resumeContactRecording(ResumeContactRecordingRequest resumeContactRecordingRequest) throws AmazonClientException, AmazonServiceException
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.
resumeContactRecordingRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.StartChatContactResult startChatContact(StartChatContactRequest startChatContactRequest) throws AmazonClientException, AmazonServiceException
Initiates a contact 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 need to 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 two situations:
API rate limit is exceeded. API TPS throttling returns a
TooManyRequests exception from the API Gateway.
The quota for concurrent active chats is exceeded. Active chat
throttling returns a LimitExceededException.
For more information about how chat works, see Chat in the Amazon Connect Administrator Guide.
startChatContactRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalServiceExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.StartContactRecordingResult startContactRecording(StartContactRecordingRequest startContactRecordingRequest) throws AmazonClientException, AmazonServiceException
This API starts recording the contact when the agent joins the 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.
startContactRecordingRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest) throws AmazonClientException, AmazonServiceException
This API places an outbound call to a contact, and then initiates the
contact flow. It performs the actions in the contact flow that's
specified (in ContactFlowId).
Agents are not involved in initiating the outbound API (that is, dialing the contact). If the contact flow places an outbound call to a contact, and then puts the contact in queue, that's when the call is 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.
startOutboundVoiceContactRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalServiceExceptionLimitExceededExceptionDestinationNotAllowedExceptionOutboundContactNotPermittedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.StartTaskContactResult startTaskContact(StartTaskContactRequest startTaskContactRequest) throws AmazonClientException, AmazonServiceException
Initiates a contact flow to start a new task.
startTaskContactRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionServiceQuotaExceededExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.StopContactResult stopContact(StopContactRequest stopContactRequest) throws AmazonClientException, AmazonServiceException
Ends the specified contact.
stopContactRequest - InvalidRequestExceptionContactNotFoundExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.StopContactRecordingResult stopContactRecording(StopContactRecordingRequest stopContactRecordingRequest) throws AmazonClientException, AmazonServiceException
When a contact is being recorded, this API stops recording the call. 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.
stopContactRecordingRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.SuspendContactRecordingResult suspendContactRecording(SuspendContactRecordingRequest suspendContactRecordingRequest) throws AmazonClientException, AmazonServiceException
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.
suspendContactRecordingRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void tagResource(TagResourceRequest tagResourceRequest) throws AmazonClientException, AmazonServiceException
Adds the specified tags to the specified resource.
The supported resource types are users, routing profiles, quick connects, and contact flows.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
tagResourceRequest - InvalidRequestExceptionInvalidParameterExceptionInternalServiceExceptionResourceNotFoundExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void untagResource(UntagResourceRequest untagResourceRequest) throws AmazonClientException, AmazonServiceException
Removes the specified tags from the specified resource.
untagResourceRequest - InvalidRequestExceptionInvalidParameterExceptionInternalServiceExceptionResourceNotFoundExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.UpdateContactAttributesResult updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest) throws AmazonClientException, AmazonServiceException
Creates or updates the contact attributes associated with the specified contact.
You can add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed 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 identifying abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted.
Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.
updateContactAttributesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateContactFlowContent(UpdateContactFlowContentRequest updateContactFlowContentRequest) throws AmazonClientException, AmazonServiceException
Updates the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
updateContactFlowContentRequest - InvalidRequestExceptionInvalidContactFlowExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateContactFlowName(UpdateContactFlowNameRequest updateContactFlowNameRequest) throws AmazonClientException, AmazonServiceException
The name of the contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
updateContactFlowNameRequest - InvalidRequestExceptionInvalidParameterExceptionDuplicateResourceExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateInstanceAttribute(UpdateInstanceAttributeRequest updateInstanceAttributeRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
updateInstanceAttributeRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest updateInstanceStorageConfigRequest) throws AmazonClientException, AmazonServiceException
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.
updateInstanceStorageConfigRequest - ResourceNotFoundExceptionInternalServiceExceptionInvalidRequestExceptionInvalidParameterExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateQuickConnectConfig(UpdateQuickConnectConfigRequest updateQuickConnectConfigRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
Updates the configuration settings for the specified quick connect.
updateQuickConnectConfigRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateQuickConnectName(UpdateQuickConnectNameRequest updateQuickConnectNameRequest) throws AmazonClientException, AmazonServiceException
This API is in preview release for Amazon Connect and is subject to change.
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.
updateQuickConnectNameRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest) throws AmazonClientException, AmazonServiceException
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
updateRoutingProfileConcurrencyRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest updateRoutingProfileDefaultOutboundQueueRequest) throws AmazonClientException, AmazonServiceException
Updates the default outbound queue of a routing profile.
updateRoutingProfileDefaultOutboundQueueRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateRoutingProfileName(UpdateRoutingProfileNameRequest updateRoutingProfileNameRequest) throws AmazonClientException, AmazonServiceException
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.
updateRoutingProfileNameRequest - DuplicateResourceExceptionInvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest updateRoutingProfileQueuesRequest) throws AmazonClientException, AmazonServiceException
Updates the properties associated with a set of queues for a routing profile.
updateRoutingProfileQueuesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest) throws AmazonClientException, AmazonServiceException
Assigns the specified hierarchy group to the specified user.
updateUserHierarchyRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest updateUserHierarchyGroupNameRequest) throws AmazonClientException, AmazonServiceException
Updates the name of the user hierarchy group.
updateUserHierarchyGroupNameRequest - InvalidRequestExceptionInvalidParameterExceptionDuplicateResourceExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest updateUserHierarchyStructureRequest) throws AmazonClientException, AmazonServiceException
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
updateUserHierarchyStructureRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionResourceInUseExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest) throws AmazonClientException, AmazonServiceException
Updates the identity information for the specified user.
Someone with the ability to invoke UpdateUserIndentityInfo
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. We strongly recommend limiting who has
the ability to invoke UpdateUserIndentityInfo. For more
information, see Best Practices for Security Profiles in the Amazon Connect
Administrator Guide.
updateUserIdentityInfoRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest) throws AmazonClientException, AmazonServiceException
Updates the phone configuration settings for the specified user.
updateUserPhoneConfigRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest) throws AmazonClientException, AmazonServiceException
Assigns the specified routing profile to the specified user.
updateUserRoutingProfileRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest) throws AmazonClientException, AmazonServiceException
Assigns the specified security profiles to the specified user.
updateUserSecurityProfilesRequest - InvalidRequestExceptionInvalidParameterExceptionResourceNotFoundExceptionThrottlingExceptionInternalServiceExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Connect indicating either a problem with the data in the
request, or a server side issue.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.