public class AmazonConnectClient extends AmazonWebServiceClient implements 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.
LOGGING_AWS_REQUEST_METRIC
Constructor and Description |
---|
AmazonConnectClient()
Deprecated.
|
AmazonConnectClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AmazonConnect using
the specified AWS account credentials.
|
AmazonConnectClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonConnect using
the specified AWS account credentials and client configuration options.
|
AmazonConnectClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AmazonConnect using
the specified AWS account credentials provider.
|
AmazonConnectClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonConnect using
the specified AWS account credentials provider and client configuration
options.
|
AmazonConnectClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
HttpClient httpClient)
Constructs a new client to invoke service methods on AmazonConnect using
the specified AWS account credentials provider, client configuration
options and request metric collector.
|
AmazonConnectClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
Deprecated.
|
AmazonConnectClient(ClientConfiguration clientConfiguration)
Deprecated.
|
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)
Deprecated.
ResponseMetadata cache can hold up to 50 requests and
responses in memory and will cause memory issue. This method
now always returns null.
|
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.
|
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.
|
addRequestHandler, addRequestHandler, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
@Deprecated public AmazonConnectClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonConnectClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling
how this client connects to AmazonConnect (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonConnectClient(AWSCredentials awsCredentials)
The client requests are authenticated using the AWSCredentials
provided in this constructor. Static AWSCredentials can be passed for
quick testing. However, it is strongly recommended to use Amazon Cognito
vended temporary credentials for use in production. This can be achieved
by using AWSMobileClient
. Please see
https://aws-amplify.github.io/docs/android/authentication for
instructions on how to enable AWSMobileClient
.
AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() { @Override public void onResult(final UserStateDetails details) { AmazonConnectClient client = new AmazonConnectClient(AWSMobileClient.getInstance()); } @Override public void onError(final Exception e) { e.printStackTrace(); } });
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key)
to use when authenticating with AWS services.public AmazonConnectClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
The client requests are authenticated using the AWSCredentials
provided in this constructor. Static AWSCredentials can be passed for
quick testing. However, it is strongly recommended to use Amazon Cognito
vended temporary credentials for use in production. This can be achieved
by using AWSMobileClient
. Please see
https://aws-amplify.github.io/docs/android/authentication for
instructions on how to enable AWSMobileClient
.
AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() { @Override public void onResult(final UserStateDetails details) { AmazonConnectClient client = new AmazonConnectClient(AWSMobileClient.getInstance()); } @Override public void onError(final Exception e) { e.printStackTrace(); } });
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key)
to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling
how this client connects to AmazonConnect (ex: proxy settings,
retry counts, etc.).public AmazonConnectClient(AWSCredentialsProvider awsCredentialsProvider)
The client requests are authenticated using the AWSCredentials
provided by the AWSCredentialsProvider
. Static AWSCredentials can
be passed for quick testing. However, it is strongly recommended to use
Amazon Cognito vended temporary credentials for use in production. This
can be achieved by using AWSMobileClient
. Please see
https://aws-amplify.github.io/docs/android/authentication for
instructions on how to enable AWSMobileClient
.
AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() { @Override public void onResult(final UserStateDetails details) { AmazonConnectClient client = new AmazonConnectClient(AWSMobileClient.getInstance()); } @Override public void onError(final Exception e) { e.printStackTrace(); } });
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.public AmazonConnectClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
The client requests are authenticated using the AWSCredentials
provided by the AWSCredentialsProvider
. Static AWSCredentials can
be passed for quick testing. However, it is strongly recommended to use
Amazon Cognito vended temporary credentials for use in production. This
can be achieved by using AWSMobileClient
. Please see
https://aws-amplify.github.io/docs/android/authentication for
instructions on how to enable AWSMobileClient
.
AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() { @Override public void onResult(final UserStateDetails details) { AmazonConnectClient client = new AmazonConnectClient(AWSMobileClient.getInstance()); } @Override public void onError(final Exception e) { e.printStackTrace(); } });
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration
- The client configuration options controlling
how this client connects to AmazonConnect (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonConnectClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration
- The client configuration options controlling
how this client connects to AmazonConnect (ex: proxy settings,
retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic AmazonConnectClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient)
The client requests are authenticated using the AWSCredentials
provided by the AWSCredentialsProvider
. Static AWSCredentials can
be passed for quick testing. However, it is strongly recommended to use
Amazon Cognito vended temporary credentials for use in production. This
can be achieved by using AWSMobileClient
. Please see
https://aws-amplify.github.io/docs/android/authentication for
instructions on how to enable AWSMobileClient
.
AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() { @Override public void onResult(final UserStateDetails details) { AmazonConnectClient client = new AmazonConnectClient(AWSMobileClient.getInstance()); } @Override public void onError(final Exception e) { e.printStackTrace(); } });
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration
- The client configuration options controlling
how this client connects to AmazonConnect (ex: proxy settings,
retry counts, etc.).httpClient
- A http clientpublic void associateApprovedOrigin(AssociateApprovedOriginRequest associateApprovedOriginRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
associateApprovedOrigin
in interface AmazonConnect
associateApprovedOriginRequest
- ResourceNotFoundException
ResourceConflictException
InternalServiceException
InvalidRequestException
InvalidParameterException
ServiceQuotaExceededException
ThrottlingException
AmazonClientException
- 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.public AssociateInstanceStorageConfigResult associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest associateInstanceStorageConfigRequest) throws AmazonServiceException, AmazonClientException
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.
associateInstanceStorageConfig
in interface AmazonConnect
associateInstanceStorageConfigRequest
- ResourceNotFoundException
ResourceConflictException
InternalServiceException
InvalidRequestException
InvalidParameterException
ThrottlingException
AmazonClientException
- 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.public void associateLambdaFunction(AssociateLambdaFunctionRequest associateLambdaFunctionRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Lambda function.
associateLambdaFunction
in interface AmazonConnect
associateLambdaFunctionRequest
- ResourceNotFoundException
ResourceConflictException
InternalServiceException
InvalidRequestException
InvalidParameterException
ServiceQuotaExceededException
ThrottlingException
AmazonClientException
- 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.public void associateLexBot(AssociateLexBotRequest associateLexBotRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.
associateLexBot
in interface AmazonConnect
associateLexBotRequest
- ResourceNotFoundException
ResourceConflictException
InternalServiceException
InvalidRequestException
InvalidParameterException
ServiceQuotaExceededException
ThrottlingException
AmazonClientException
- 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.public void associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest) throws AmazonServiceException, AmazonClientException
Associates a set of queues with a routing profile.
associateRoutingProfileQueues
in interface AmazonConnect
associateRoutingProfileQueuesRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public AssociateSecurityKeyResult associateSecurityKey(AssociateSecurityKeyRequest associateSecurityKeyRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
associateSecurityKey
in interface AmazonConnect
associateSecurityKeyRequest
- ResourceNotFoundException
ResourceConflictException
InternalServiceException
InvalidRequestException
InvalidParameterException
ServiceQuotaExceededException
ThrottlingException
AmazonClientException
- 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.public CreateContactFlowResult createContactFlow(CreateContactFlowRequest createContactFlowRequest) throws AmazonServiceException, AmazonClientException
Creates a contact flow for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
createContactFlow
in interface AmazonConnect
createContactFlowRequest
- InvalidRequestException
InvalidContactFlowException
InvalidParameterException
DuplicateResourceException
LimitExceededException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public CreateInstanceResult createInstance(CreateInstanceRequest createInstanceRequest) throws AmazonServiceException, AmazonClientException
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.
createInstance
in interface AmazonConnect
createInstanceRequest
- InvalidRequestException
ServiceQuotaExceededException
ThrottlingException
ResourceNotFoundException
InternalServiceException
AmazonClientException
- 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.public CreateIntegrationAssociationResult createIntegrationAssociation(CreateIntegrationAssociationRequest createIntegrationAssociationRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Create an AppIntegration association with an Amazon Connect instance.
createIntegrationAssociation
in interface AmazonConnect
createIntegrationAssociationRequest
- DuplicateResourceException
ResourceNotFoundException
InternalServiceException
InvalidRequestException
ThrottlingException
AmazonClientException
- 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.public CreateQuickConnectResult createQuickConnect(CreateQuickConnectRequest createQuickConnectRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Creates a quick connect for the specified Amazon Connect instance.
createQuickConnect
in interface AmazonConnect
createQuickConnectRequest
- InvalidRequestException
InvalidParameterException
DuplicateResourceException
ResourceNotFoundException
LimitExceededException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public CreateRoutingProfileResult createRoutingProfile(CreateRoutingProfileRequest createRoutingProfileRequest) throws AmazonServiceException, AmazonClientException
Creates a new routing profile.
createRoutingProfile
in interface AmazonConnect
createRoutingProfileRequest
- InvalidRequestException
InvalidParameterException
DuplicateResourceException
ResourceNotFoundException
LimitExceededException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public CreateUseCaseResult createUseCase(CreateUseCaseRequest createUseCaseRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Creates a use case for an AppIntegration association.
createUseCase
in interface AmazonConnect
createUseCaseRequest
- DuplicateResourceException
ResourceNotFoundException
InternalServiceException
InvalidRequestException
ThrottlingException
AmazonClientException
- 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.public CreateUserResult createUser(CreateUserRequest createUserRequest) throws AmazonServiceException, AmazonClientException
Creates a user account for the specified Amazon Connect instance.
For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.
createUser
in interface AmazonConnect
createUserRequest
- InvalidRequestException
InvalidParameterException
LimitExceededException
DuplicateResourceException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public CreateUserHierarchyGroupResult createUserHierarchyGroup(CreateUserHierarchyGroupRequest createUserHierarchyGroupRequest) throws AmazonServiceException, AmazonClientException
Creates a new user hierarchy group.
createUserHierarchyGroup
in interface AmazonConnect
createUserHierarchyGroupRequest
- InvalidRequestException
InvalidParameterException
DuplicateResourceException
LimitExceededException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void deleteInstance(DeleteInstanceRequest deleteInstanceRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
deleteInstance
in interface AmazonConnect
deleteInstanceRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
AmazonClientException
- 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.public void deleteIntegrationAssociation(DeleteIntegrationAssociationRequest deleteIntegrationAssociationRequest) throws AmazonServiceException, AmazonClientException
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.
deleteIntegrationAssociation
in interface AmazonConnect
deleteIntegrationAssociationRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
ThrottlingException
AmazonClientException
- 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.public void deleteQuickConnect(DeleteQuickConnectRequest deleteQuickConnectRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Deletes a quick connect.
deleteQuickConnect
in interface AmazonConnect
deleteQuickConnectRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void deleteUseCase(DeleteUseCaseRequest deleteUseCaseRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Deletes a use case from an AppIntegration association.
deleteUseCase
in interface AmazonConnect
deleteUseCaseRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
ThrottlingException
AmazonClientException
- 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.public void deleteUser(DeleteUserRequest deleteUserRequest) throws AmazonServiceException, AmazonClientException
Deletes a user account from the specified Amazon Connect instance.
For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.
deleteUser
in interface AmazonConnect
deleteUserRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest deleteUserHierarchyGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
deleteUserHierarchyGroup
in interface AmazonConnect
deleteUserHierarchyGroupRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ResourceInUseException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public DescribeContactFlowResult describeContactFlow(DescribeContactFlowRequest describeContactFlowRequest) throws AmazonServiceException, AmazonClientException
Describes the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
describeContactFlow
in interface AmazonConnect
describeContactFlowRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ContactFlowNotPublishedException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public DescribeInstanceResult describeInstance(DescribeInstanceRequest describeInstanceRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status if applicable.
If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.
describeInstance
in interface AmazonConnect
describeInstanceRequest
- InvalidRequestException
ResourceNotFoundException
InternalServiceException
AmazonClientException
- 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.public DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
describeInstanceAttribute
in interface AmazonConnect
describeInstanceAttributeRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
InvalidParameterException
ThrottlingException
AmazonClientException
- 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.public DescribeInstanceStorageConfigResult describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest describeInstanceStorageConfigRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
describeInstanceStorageConfig
in interface AmazonConnect
describeInstanceStorageConfigRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
InvalidParameterException
ThrottlingException
AmazonClientException
- 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.public DescribeQuickConnectResult describeQuickConnect(DescribeQuickConnectRequest describeQuickConnectRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Describes the quick connect.
describeQuickConnect
in interface AmazonConnect
describeQuickConnectRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public DescribeRoutingProfileResult describeRoutingProfile(DescribeRoutingProfileRequest describeRoutingProfileRequest) throws AmazonServiceException, AmazonClientException
Describes the specified routing profile.
describeRoutingProfile
in interface AmazonConnect
describeRoutingProfileRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public DescribeUserResult describeUser(DescribeUserRequest describeUserRequest) throws AmazonServiceException, AmazonClientException
Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.
describeUser
in interface AmazonConnect
describeUserRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public DescribeUserHierarchyGroupResult describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest) throws AmazonServiceException, AmazonClientException
Describes the specified hierarchy group.
describeUserHierarchyGroup
in interface AmazonConnect
describeUserHierarchyGroupRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public DescribeUserHierarchyStructureResult describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest) throws AmazonServiceException, AmazonClientException
Describes the hierarchy structure of the specified Amazon Connect instance.
describeUserHierarchyStructure
in interface AmazonConnect
describeUserHierarchyStructureRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void disassociateApprovedOrigin(DisassociateApprovedOriginRequest disassociateApprovedOriginRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
disassociateApprovedOrigin
in interface AmazonConnect
disassociateApprovedOriginRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
InvalidParameterException
ThrottlingException
AmazonClientException
- 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.public void disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest disassociateInstanceStorageConfigRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Removes the storage type configurations for the specified resource type and association ID.
disassociateInstanceStorageConfig
in interface AmazonConnect
disassociateInstanceStorageConfigRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
InvalidParameterException
ThrottlingException
AmazonClientException
- 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.public void disassociateLambdaFunction(DisassociateLambdaFunctionRequest disassociateLambdaFunctionRequest) throws AmazonServiceException, AmazonClientException
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.
disassociateLambdaFunction
in interface AmazonConnect
disassociateLambdaFunctionRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
InvalidParameterException
ThrottlingException
AmazonClientException
- 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.public void disassociateLexBot(DisassociateLexBotRequest disassociateLexBotRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex bot.
disassociateLexBot
in interface AmazonConnect
disassociateLexBotRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
InvalidParameterException
ThrottlingException
AmazonClientException
- 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.public void disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest disassociateRoutingProfileQueuesRequest) throws AmazonServiceException, AmazonClientException
Disassociates a set of queues from a routing profile.
disassociateRoutingProfileQueues
in interface AmazonConnect
disassociateRoutingProfileQueuesRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void disassociateSecurityKey(DisassociateSecurityKeyRequest disassociateSecurityKeyRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
disassociateSecurityKey
in interface AmazonConnect
disassociateSecurityKeyRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
InvalidParameterException
ThrottlingException
AmazonClientException
- 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.public GetContactAttributesResult getContactAttributes(GetContactAttributesRequest getContactAttributesRequest) throws AmazonServiceException, AmazonClientException
Retrieves the contact attributes for the specified contact.
getContactAttributes
in interface AmazonConnect
getContactAttributesRequest
- InvalidRequestException
ResourceNotFoundException
InternalServiceException
AmazonClientException
- 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.public GetCurrentMetricDataResult getCurrentMetricData(GetCurrentMetricDataRequest getCurrentMetricDataRequest) throws AmazonServiceException, AmazonClientException
Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
getCurrentMetricData
in interface AmazonConnect
getCurrentMetricDataRequest
- InvalidRequestException
InvalidParameterException
InternalServiceException
ThrottlingException
ResourceNotFoundException
AmazonClientException
- 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.public GetFederationTokenResult getFederationToken(GetFederationTokenRequest getFederationTokenRequest) throws AmazonServiceException, AmazonClientException
Retrieves a token for federation.
getFederationToken
in interface AmazonConnect
getFederationTokenRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
UserNotFoundException
InternalServiceException
DuplicateResourceException
AmazonClientException
- 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.public GetMetricDataResult getMetricData(GetMetricDataRequest getMetricDataRequest) throws AmazonServiceException, AmazonClientException
Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
getMetricData
in interface AmazonConnect
getMetricDataRequest
- InvalidRequestException
InvalidParameterException
InternalServiceException
ThrottlingException
ResourceNotFoundException
AmazonClientException
- 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.public ListApprovedOriginsResult listApprovedOrigins(ListApprovedOriginsRequest listApprovedOriginsRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all approved origins associated with the instance.
listApprovedOrigins
in interface AmazonConnect
listApprovedOriginsRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
InvalidParameterException
ThrottlingException
AmazonClientException
- 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.public ListContactFlowsResult listContactFlows(ListContactFlowsRequest listContactFlowsRequest) throws AmazonServiceException, AmazonClientException
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.
listContactFlows
in interface AmazonConnect
listContactFlowsRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public ListHoursOfOperationsResult listHoursOfOperations(ListHoursOfOperationsRequest listHoursOfOperationsRequest) throws AmazonServiceException, AmazonClientException
Provides information about the hours of operation for the specified Amazon Connect instance.
For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.
listHoursOfOperations
in interface AmazonConnect
listHoursOfOperationsRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public ListInstanceAttributesResult listInstanceAttributes(ListInstanceAttributesRequest listInstanceAttributesRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all attribute types for the given instance.
listInstanceAttributes
in interface AmazonConnect
listInstanceAttributesRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
InvalidParameterException
ThrottlingException
AmazonClientException
- 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.public ListInstanceStorageConfigsResult listInstanceStorageConfigs(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of storage configs for the identified instance and resource type.
listInstanceStorageConfigs
in interface AmazonConnect
listInstanceStorageConfigsRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
InvalidParameterException
ThrottlingException
AmazonClientException
- 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.public ListInstancesResult listInstances(ListInstancesRequest listInstancesRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.
listInstances
in interface AmazonConnect
listInstancesRequest
- InvalidRequestException
InternalServiceException
AmazonClientException
- 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.public ListIntegrationAssociationsResult listIntegrationAssociations(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest) throws AmazonServiceException, AmazonClientException
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.
listIntegrationAssociations
in interface AmazonConnect
listIntegrationAssociationsRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
ThrottlingException
AmazonClientException
- 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.public ListLambdaFunctionsResult listLambdaFunctions(ListLambdaFunctionsRequest listLambdaFunctionsRequest) throws AmazonServiceException, AmazonClientException
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.
listLambdaFunctions
in interface AmazonConnect
listLambdaFunctionsRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
InvalidParameterException
ThrottlingException
AmazonClientException
- 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.public ListLexBotsResult listLexBots(ListLexBotsRequest listLexBotsRequest) throws AmazonServiceException, AmazonClientException
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.
listLexBots
in interface AmazonConnect
listLexBotsRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
InvalidParameterException
ThrottlingException
AmazonClientException
- 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.public ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest) throws AmazonServiceException, AmazonClientException
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.
listPhoneNumbers
in interface AmazonConnect
listPhoneNumbersRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public ListPromptsResult listPrompts(ListPromptsRequest listPromptsRequest) throws AmazonServiceException, AmazonClientException
Provides information about the prompts for the specified Amazon Connect instance.
listPrompts
in interface AmazonConnect
listPromptsRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest) throws AmazonServiceException, AmazonClientException
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.
listQueues
in interface AmazonConnect
listQueuesRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public ListQuickConnectsResult listQuickConnects(ListQuickConnectsRequest listQuickConnectsRequest) throws AmazonServiceException, AmazonClientException
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.
listQuickConnects
in interface AmazonConnect
listQuickConnectsRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public ListRoutingProfileQueuesResult listRoutingProfileQueues(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest) throws AmazonServiceException, AmazonClientException
List the queues associated with a routing profile.
listRoutingProfileQueues
in interface AmazonConnect
listRoutingProfileQueuesRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest) throws AmazonServiceException, AmazonClientException
Provides summary information about the routing profiles for the specified Amazon Connect instance.
For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.
listRoutingProfiles
in interface AmazonConnect
listRoutingProfilesRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public ListSecurityKeysResult listSecurityKeys(ListSecurityKeysRequest listSecurityKeysRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all security keys associated with the instance.
listSecurityKeys
in interface AmazonConnect
listSecurityKeysRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
InvalidParameterException
ThrottlingException
AmazonClientException
- 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.public ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest) throws AmazonServiceException, AmazonClientException
Provides summary information about the security profiles for the specified Amazon Connect instance.
For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.
listSecurityProfiles
in interface AmazonConnect
listSecurityProfilesRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AmazonServiceException, AmazonClientException
Lists the tags for the specified resource.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
listTagsForResource
in interface AmazonConnect
listTagsForResourceRequest
- InvalidRequestException
InvalidParameterException
InternalServiceException
ResourceNotFoundException
ThrottlingException
AmazonClientException
- 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.public ListUseCasesResult listUseCases(ListUseCasesRequest listUseCasesRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
List the use cases.
listUseCases
in interface AmazonConnect
listUseCasesRequest
- Provides summary information about the use cases for the specified Amazon Connect AppIntegration association.
ResourceNotFoundException
InternalServiceException
InvalidRequestException
ThrottlingException
AmazonClientException
- 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.public ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest) throws AmazonServiceException, AmazonClientException
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
listUserHierarchyGroups
in interface AmazonConnect
listUserHierarchyGroupsRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public ListUsersResult listUsers(ListUsersRequest listUsersRequest) throws AmazonServiceException, AmazonClientException
Provides summary information about the users for the specified Amazon Connect instance.
listUsers
in interface AmazonConnect
listUsersRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public ResumeContactRecordingResult resumeContactRecording(ResumeContactRecordingRequest resumeContactRecordingRequest) throws AmazonServiceException, AmazonClientException
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.
Only voice recordings are supported at this time.
resumeContactRecording
in interface AmazonConnect
resumeContactRecordingRequest
- InvalidRequestException
ResourceNotFoundException
InternalServiceException
AmazonClientException
- 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.public StartChatContactResult startChatContact(StartChatContactRequest startChatContactRequest) throws AmazonServiceException, AmazonClientException
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.
startChatContact
in interface AmazonConnect
startChatContactRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
InternalServiceException
LimitExceededException
AmazonClientException
- 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.public StartContactRecordingResult startContactRecording(StartContactRecordingRequest startContactRecordingRequest) throws AmazonServiceException, AmazonClientException
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.
startContactRecording
in interface AmazonConnect
startContactRecordingRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
InternalServiceException
AmazonClientException
- 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.public StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest) throws AmazonServiceException, AmazonClientException
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.
startOutboundVoiceContact
in interface AmazonConnect
startOutboundVoiceContactRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
InternalServiceException
LimitExceededException
DestinationNotAllowedException
OutboundContactNotPermittedException
AmazonClientException
- 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.public StartTaskContactResult startTaskContact(StartTaskContactRequest startTaskContactRequest) throws AmazonServiceException, AmazonClientException
Initiates a contact flow to start a new task.
startTaskContact
in interface AmazonConnect
startTaskContactRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
ServiceQuotaExceededException
InternalServiceException
AmazonClientException
- 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.public StopContactResult stopContact(StopContactRequest stopContactRequest) throws AmazonServiceException, AmazonClientException
Ends the specified contact.
stopContact
in interface AmazonConnect
stopContactRequest
- InvalidRequestException
ContactNotFoundException
InvalidParameterException
ResourceNotFoundException
InternalServiceException
AmazonClientException
- 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.public StopContactRecordingResult stopContactRecording(StopContactRecordingRequest stopContactRecordingRequest) throws AmazonServiceException, AmazonClientException
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.
stopContactRecording
in interface AmazonConnect
stopContactRecordingRequest
- InvalidRequestException
ResourceNotFoundException
InternalServiceException
AmazonClientException
- 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.public SuspendContactRecordingResult suspendContactRecording(SuspendContactRecordingRequest suspendContactRecordingRequest) throws AmazonServiceException, AmazonClientException
When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.
The period of time that the recording is suspended is filled with silence in the final recording.
Only voice recordings are supported at this time.
suspendContactRecording
in interface AmazonConnect
suspendContactRecordingRequest
- InvalidRequestException
ResourceNotFoundException
InternalServiceException
AmazonClientException
- 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.public void tagResource(TagResourceRequest tagResourceRequest) throws AmazonServiceException, AmazonClientException
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.
tagResource
in interface AmazonConnect
tagResourceRequest
- InvalidRequestException
InvalidParameterException
InternalServiceException
ResourceNotFoundException
ThrottlingException
AmazonClientException
- 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.public void untagResource(UntagResourceRequest untagResourceRequest) throws AmazonServiceException, AmazonClientException
Removes the specified tags from the specified resource.
untagResource
in interface AmazonConnect
untagResourceRequest
- InvalidRequestException
InvalidParameterException
InternalServiceException
ResourceNotFoundException
ThrottlingException
AmazonClientException
- 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.public UpdateContactAttributesResult updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest) throws AmazonServiceException, AmazonClientException
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.
updateContactAttributes
in interface AmazonConnect
updateContactAttributesRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
InternalServiceException
AmazonClientException
- 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.public void updateContactFlowContent(UpdateContactFlowContentRequest updateContactFlowContentRequest) throws AmazonServiceException, AmazonClientException
Updates the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
updateContactFlowContent
in interface AmazonConnect
updateContactFlowContentRequest
- InvalidRequestException
InvalidContactFlowException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void updateContactFlowName(UpdateContactFlowNameRequest updateContactFlowNameRequest) throws AmazonServiceException, AmazonClientException
The name of the contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
updateContactFlowName
in interface AmazonConnect
updateContactFlowNameRequest
- InvalidRequestException
InvalidParameterException
DuplicateResourceException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void updateInstanceAttribute(UpdateInstanceAttributeRequest updateInstanceAttributeRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
updateInstanceAttribute
in interface AmazonConnect
updateInstanceAttributeRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
InvalidParameterException
ThrottlingException
AmazonClientException
- 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.public void updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest updateInstanceStorageConfigRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Updates an existing configuration for a resource type. This API is idempotent.
updateInstanceStorageConfig
in interface AmazonConnect
updateInstanceStorageConfigRequest
- ResourceNotFoundException
InternalServiceException
InvalidRequestException
InvalidParameterException
ThrottlingException
AmazonClientException
- 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.public void updateQuickConnectConfig(UpdateQuickConnectConfigRequest updateQuickConnectConfigRequest) throws AmazonServiceException, AmazonClientException
This API is in preview release for Amazon Connect and is subject to change.
Updates the configuration settings for the specified quick connect.
updateQuickConnectConfig
in interface AmazonConnect
updateQuickConnectConfigRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void updateQuickConnectName(UpdateQuickConnectNameRequest updateQuickConnectNameRequest) throws AmazonServiceException, AmazonClientException
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.
updateQuickConnectName
in interface AmazonConnect
updateQuickConnectNameRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest) throws AmazonServiceException, AmazonClientException
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
updateRoutingProfileConcurrency
in interface AmazonConnect
updateRoutingProfileConcurrencyRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest updateRoutingProfileDefaultOutboundQueueRequest) throws AmazonServiceException, AmazonClientException
Updates the default outbound queue of a routing profile.
updateRoutingProfileDefaultOutboundQueue
in interface AmazonConnect
updateRoutingProfileDefaultOutboundQueueRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void updateRoutingProfileName(UpdateRoutingProfileNameRequest updateRoutingProfileNameRequest) throws AmazonServiceException, AmazonClientException
Updates the name and description of a routing profile. The request
accepts the following data in JSON format. At least Name
or
Description
must be provided.
updateRoutingProfileName
in interface AmazonConnect
updateRoutingProfileNameRequest
- DuplicateResourceException
InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest updateRoutingProfileQueuesRequest) throws AmazonServiceException, AmazonClientException
Updates the properties associated with a set of queues for a routing profile.
updateRoutingProfileQueues
in interface AmazonConnect
updateRoutingProfileQueuesRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest) throws AmazonServiceException, AmazonClientException
Assigns the specified hierarchy group to the specified user.
updateUserHierarchy
in interface AmazonConnect
updateUserHierarchyRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest updateUserHierarchyGroupNameRequest) throws AmazonServiceException, AmazonClientException
Updates the name of the user hierarchy group.
updateUserHierarchyGroupName
in interface AmazonConnect
updateUserHierarchyGroupNameRequest
- InvalidRequestException
InvalidParameterException
DuplicateResourceException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest updateUserHierarchyStructureRequest) throws AmazonServiceException, AmazonClientException
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
updateUserHierarchyStructure
in interface AmazonConnect
updateUserHierarchyStructureRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ResourceInUseException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest) throws AmazonServiceException, AmazonClientException
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.
updateUserIdentityInfo
in interface AmazonConnect
updateUserIdentityInfoRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest) throws AmazonServiceException, AmazonClientException
Updates the phone configuration settings for the specified user.
updateUserPhoneConfig
in interface AmazonConnect
updateUserPhoneConfigRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest) throws AmazonServiceException, AmazonClientException
Assigns the specified routing profile to the specified user.
updateUserRoutingProfile
in interface AmazonConnect
updateUserRoutingProfileRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.public void updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest) throws AmazonServiceException, AmazonClientException
Assigns the specified security profiles to the specified user.
updateUserSecurityProfiles
in interface AmazonConnect
updateUserSecurityProfilesRequest
- InvalidRequestException
InvalidParameterException
ResourceNotFoundException
ThrottlingException
InternalServiceException
AmazonClientException
- 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.@Deprecated public 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 the request.
getCachedResponseMetadata
in interface AmazonConnect
request
- The originally executed requestCopyright © 2018 Amazon Web Services, Inc. All Rights Reserved.