@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") 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
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociateApprovedOriginResult |
associateApprovedOrigin(AssociateApprovedOriginRequest request)
Associates an approved origin to an Amazon Connect instance.
|
AssociateInstanceStorageConfigResult |
associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest request)
Associates a storage resource type for the first time.
|
AssociateLambdaFunctionResult |
associateLambdaFunction(AssociateLambdaFunctionRequest request)
Allows the specified Amazon Connect instance to access the specified Lambda function.
|
AssociateLexBotResult |
associateLexBot(AssociateLexBotRequest request)
Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.
|
AssociateRoutingProfileQueuesResult |
associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest request)
Associates a set of queues with a routing profile.
|
AssociateSecurityKeyResult |
associateSecurityKey(AssociateSecurityKeyRequest request)
Associates a security key to the instance.
|
static AmazonConnectClientBuilder |
builder() |
CreateContactFlowResult |
createContactFlow(CreateContactFlowRequest request)
Creates a contact flow for the specified Amazon Connect instance.
|
CreateInstanceResult |
createInstance(CreateInstanceRequest request)
Initiates an Amazon Connect instance with all the supported channels enabled.
|
CreateRoutingProfileResult |
createRoutingProfile(CreateRoutingProfileRequest request)
Creates a new routing profile.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a user account for the specified Amazon Connect instance.
|
CreateUserHierarchyGroupResult |
createUserHierarchyGroup(CreateUserHierarchyGroupRequest request)
Creates a new user hierarchy group.
|
DeleteInstanceResult |
deleteInstance(DeleteInstanceRequest request)
Deletes the Amazon Connect instance.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes a user account from the specified Amazon Connect instance.
|
DeleteUserHierarchyGroupResult |
deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest request)
Deletes an existing user hierarchy group.
|
DescribeContactFlowResult |
describeContactFlow(DescribeContactFlowRequest request)
Describes the specified contact flow.
|
DescribeInstanceResult |
describeInstance(DescribeInstanceRequest request)
Returns the current state of the specified instance identifier.
|
DescribeInstanceAttributeResult |
describeInstanceAttribute(DescribeInstanceAttributeRequest request)
Describes the specified instance attribute.
|
DescribeInstanceStorageConfigResult |
describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest request)
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
|
DescribeRoutingProfileResult |
describeRoutingProfile(DescribeRoutingProfileRequest request)
Describes the specified routing profile.
|
DescribeUserResult |
describeUser(DescribeUserRequest request)
Describes the specified user account.
|
DescribeUserHierarchyGroupResult |
describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest request)
Describes the specified hierarchy group.
|
DescribeUserHierarchyStructureResult |
describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest request)
Describes the hierarchy structure of the specified Amazon Connect instance.
|
DisassociateApprovedOriginResult |
disassociateApprovedOrigin(DisassociateApprovedOriginRequest request)
Revokes access to integrated applications from Amazon Connect.
|
DisassociateInstanceStorageConfigResult |
disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest request)
Removes the storage type configurations for the specified resource type and association ID.
|
DisassociateLambdaFunctionResult |
disassociateLambdaFunction(DisassociateLambdaFunctionRequest request)
Remove the Lambda function from the drop-down options available in the relevant contact flow blocks.
|
DisassociateLexBotResult |
disassociateLexBot(DisassociateLexBotRequest request)
Revokes authorization from the specified instance to access the specified Amazon Lex bot.
|
DisassociateRoutingProfileQueuesResult |
disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest request)
Disassociates a set of queues from a routing profile.
|
DisassociateSecurityKeyResult |
disassociateSecurityKey(DisassociateSecurityKeyRequest request)
Deletes the specified security key.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetContactAttributesResult |
getContactAttributes(GetContactAttributesRequest request)
Retrieves the contact attributes for the specified contact.
|
GetCurrentMetricDataResult |
getCurrentMetricData(GetCurrentMetricDataRequest request)
Gets the real-time metric data from the specified Amazon Connect instance.
|
GetFederationTokenResult |
getFederationToken(GetFederationTokenRequest request)
Retrieves a token for federation.
|
GetMetricDataResult |
getMetricData(GetMetricDataRequest request)
Gets historical metric data from the specified Amazon Connect instance.
|
ListApprovedOriginsResult |
listApprovedOrigins(ListApprovedOriginsRequest request)
Returns a paginated list of all approved origins associated with the instance.
|
ListContactFlowsResult |
listContactFlows(ListContactFlowsRequest request)
Provides information about the contact flows for the specified Amazon Connect instance.
|
ListHoursOfOperationsResult |
listHoursOfOperations(ListHoursOfOperationsRequest request)
Provides information about the hours of operation for the specified Amazon Connect instance.
|
ListInstanceAttributesResult |
listInstanceAttributes(ListInstanceAttributesRequest request)
Returns a paginated list of all attribute types for the given instance.
|
ListInstancesResult |
listInstances(ListInstancesRequest request)
Return a list of instances which are in active state, creation-in-progress state, and failed state.
|
ListInstanceStorageConfigsResult |
listInstanceStorageConfigs(ListInstanceStorageConfigsRequest request)
Returns a paginated list of storage configs for the identified instance and resource type.
|
ListLambdaFunctionsResult |
listLambdaFunctions(ListLambdaFunctionsRequest request)
Returns a paginated list of all the Lambda functions that show up in the drop-down options in the relevant
contact flow blocks.
|
ListLexBotsResult |
listLexBots(ListLexBotsRequest request)
Returns a paginated list of all the Amazon Lex bots currently associated with the instance.
|
ListPhoneNumbersResult |
listPhoneNumbers(ListPhoneNumbersRequest request)
Provides information about the phone numbers for the specified Amazon Connect instance.
|
ListPromptsResult |
listPrompts(ListPromptsRequest request)
Provides information about the prompts for the specified Amazon Connect instance.
|
ListQueuesResult |
listQueues(ListQueuesRequest request)
Provides information about the queues for the specified Amazon Connect instance.
|
ListRoutingProfileQueuesResult |
listRoutingProfileQueues(ListRoutingProfileQueuesRequest request)
List the queues associated with a routing profile.
|
ListRoutingProfilesResult |
listRoutingProfiles(ListRoutingProfilesRequest request)
Provides summary information about the routing profiles for the specified Amazon Connect instance.
|
ListSecurityKeysResult |
listSecurityKeys(ListSecurityKeysRequest request)
Returns a paginated list of all security keys associated with the instance.
|
ListSecurityProfilesResult |
listSecurityProfiles(ListSecurityProfilesRequest request)
Provides summary information about the security profiles for the specified Amazon Connect instance.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags for the specified resource.
|
ListUserHierarchyGroupsResult |
listUserHierarchyGroups(ListUserHierarchyGroupsRequest request)
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Provides summary information about the users for the specified Amazon Connect instance.
|
ResumeContactRecordingResult |
resumeContactRecording(ResumeContactRecordingRequest request)
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API
resumes recording the call.
|
StartChatContactResult |
startChatContact(StartChatContactRequest request)
Initiates a contact flow to start a new chat for the customer.
|
StartContactRecordingResult |
startContactRecording(StartContactRecordingRequest request)
This API starts recording the contact when the agent joins the call.
|
StartOutboundVoiceContactResult |
startOutboundVoiceContact(StartOutboundVoiceContactRequest request)
This API places an outbound call to a contact, and then initiates the contact flow.
|
StopContactResult |
stopContact(StopContactRequest request)
Ends the specified contact.
|
StopContactRecordingResult |
stopContactRecording(StopContactRecordingRequest request)
When a contact is being recorded, this API stops recording the call.
|
SuspendContactRecordingResult |
suspendContactRecording(SuspendContactRecordingRequest request)
When a contact is being recorded, this API suspends recording the call.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds the specified tags to the specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes the specified tags from the specified resource.
|
UpdateContactAttributesResult |
updateContactAttributes(UpdateContactAttributesRequest request)
Creates or updates the contact attributes associated with the specified contact.
|
UpdateContactFlowContentResult |
updateContactFlowContent(UpdateContactFlowContentRequest request)
Updates the specified contact flow.
|
UpdateContactFlowNameResult |
updateContactFlowName(UpdateContactFlowNameRequest request)
The name of the contact flow.
|
UpdateInstanceAttributeResult |
updateInstanceAttribute(UpdateInstanceAttributeRequest request)
Updates the value for the specified attribute type.
|
UpdateInstanceStorageConfigResult |
updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest request)
Updates an existing configuration for a resource type.
|
UpdateRoutingProfileConcurrencyResult |
updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest request)
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
|
UpdateRoutingProfileDefaultOutboundQueueResult |
updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest request)
Updates the default outbound queue of a routing profile.
|
UpdateRoutingProfileNameResult |
updateRoutingProfileName(UpdateRoutingProfileNameRequest request)
Updates the name and description of a routing profile.
|
UpdateRoutingProfileQueuesResult |
updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest request)
Updates the properties associated with a set of queues for a routing profile.
|
UpdateUserHierarchyResult |
updateUserHierarchy(UpdateUserHierarchyRequest request)
Assigns the specified hierarchy group to the specified user.
|
UpdateUserHierarchyGroupNameResult |
updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest request)
Updates the name of the user hierarchy group.
|
UpdateUserHierarchyStructureResult |
updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest request)
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
|
UpdateUserIdentityInfoResult |
updateUserIdentityInfo(UpdateUserIdentityInfoRequest request)
Updates the identity information for the specified user.
|
UpdateUserPhoneConfigResult |
updateUserPhoneConfig(UpdateUserPhoneConfigRequest request)
Updates the phone configuration settings for the specified user.
|
UpdateUserRoutingProfileResult |
updateUserRoutingProfile(UpdateUserRoutingProfileRequest request)
Assigns the specified routing profile to the specified user.
|
UpdateUserSecurityProfilesResult |
updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest request)
Assigns the specified security profiles to the specified user.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
shutdown
public static AmazonConnectClientBuilder builder()
public AssociateApprovedOriginResult associateApprovedOrigin(AssociateApprovedOriginRequest request)
Associates an approved origin to an Amazon Connect instance.
associateApprovedOrigin
in interface AmazonConnect
associateApprovedOriginRequest
- ResourceNotFoundException
- The specified resource was not found.ResourceConflictException
- A resource already has that name.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ServiceQuotaExceededException
- The service quota has been exceeded.ThrottlingException
- The throttling limit has been exceeded.public AssociateInstanceStorageConfigResult associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest request)
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
- The specified resource was not found.ResourceConflictException
- A resource already has that name.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public AssociateLambdaFunctionResult associateLambdaFunction(AssociateLambdaFunctionRequest request)
Allows the specified Amazon Connect instance to access the specified Lambda function.
associateLambdaFunction
in interface AmazonConnect
associateLambdaFunctionRequest
- ResourceNotFoundException
- The specified resource was not found.ResourceConflictException
- A resource already has that name.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ServiceQuotaExceededException
- The service quota has been exceeded.ThrottlingException
- The throttling limit has been exceeded.public AssociateLexBotResult associateLexBot(AssociateLexBotRequest request)
Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.
associateLexBot
in interface AmazonConnect
associateLexBotRequest
- ResourceNotFoundException
- The specified resource was not found.ResourceConflictException
- A resource already has that name.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ServiceQuotaExceededException
- The service quota has been exceeded.ThrottlingException
- The throttling limit has been exceeded.public AssociateRoutingProfileQueuesResult associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest request)
Associates a set of queues with a routing profile.
associateRoutingProfileQueues
in interface AmazonConnect
associateRoutingProfileQueuesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public AssociateSecurityKeyResult associateSecurityKey(AssociateSecurityKeyRequest request)
Associates a security key to the instance.
associateSecurityKey
in interface AmazonConnect
associateSecurityKeyRequest
- ResourceNotFoundException
- The specified resource was not found.ResourceConflictException
- A resource already has that name.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ServiceQuotaExceededException
- The service quota has been exceeded.ThrottlingException
- The throttling limit has been exceeded.public CreateContactFlowResult createContactFlow(CreateContactFlowRequest request)
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
- The request is not valid.InvalidContactFlowException
- The contact flow is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.LimitExceededException
- The allowed limit for the resource has been exceeded.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public CreateInstanceResult createInstance(CreateInstanceRequest request)
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
- The request is not valid.ServiceQuotaExceededException
- The service quota has been exceeded.ThrottlingException
- The throttling limit has been exceeded.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.public CreateRoutingProfileResult createRoutingProfile(CreateRoutingProfileRequest request)
Creates a new routing profile.
createRoutingProfile
in interface AmazonConnect
createRoutingProfileRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.LimitExceededException
- The allowed limit for the resource has been exceeded.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public CreateUserResult createUser(CreateUserRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.LimitExceededException
- The allowed limit for the resource has been exceeded.DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public CreateUserHierarchyGroupResult createUserHierarchyGroup(CreateUserHierarchyGroupRequest request)
Creates a new user hierarchy group.
createUserHierarchyGroup
in interface AmazonConnect
createUserHierarchyGroupRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.LimitExceededException
- The allowed limit for the resource has been exceeded.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
Deletes the Amazon Connect instance.
deleteInstance
in interface AmazonConnect
deleteInstanceRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.public DeleteUserResult deleteUser(DeleteUserRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public DeleteUserHierarchyGroupResult deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ResourceInUseException
- That resource is already in use. Please try another.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public DescribeContactFlowResult describeContactFlow(DescribeContactFlowRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ContactFlowNotPublishedException
- The contact flow has not been published.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public DescribeInstanceResult describeInstance(DescribeInstanceRequest request)
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
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.public DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest request)
Describes the specified instance attribute.
describeInstanceAttribute
in interface AmazonConnect
describeInstanceAttributeRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public DescribeInstanceStorageConfigResult describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest request)
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
describeInstanceStorageConfig
in interface AmazonConnect
describeInstanceStorageConfigRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public DescribeRoutingProfileResult describeRoutingProfile(DescribeRoutingProfileRequest request)
Describes the specified routing profile.
describeRoutingProfile
in interface AmazonConnect
describeRoutingProfileRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public DescribeUserResult describeUser(DescribeUserRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public DescribeUserHierarchyGroupResult describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest request)
Describes the specified hierarchy group.
describeUserHierarchyGroup
in interface AmazonConnect
describeUserHierarchyGroupRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public DescribeUserHierarchyStructureResult describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest request)
Describes the hierarchy structure of the specified Amazon Connect instance.
describeUserHierarchyStructure
in interface AmazonConnect
describeUserHierarchyStructureRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public DisassociateApprovedOriginResult disassociateApprovedOrigin(DisassociateApprovedOriginRequest request)
Revokes access to integrated applications from Amazon Connect.
disassociateApprovedOrigin
in interface AmazonConnect
disassociateApprovedOriginRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public DisassociateInstanceStorageConfigResult disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest request)
Removes the storage type configurations for the specified resource type and association ID.
disassociateInstanceStorageConfig
in interface AmazonConnect
disassociateInstanceStorageConfigRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public DisassociateLambdaFunctionResult disassociateLambdaFunction(DisassociateLambdaFunctionRequest request)
Remove the Lambda function from the drop-down options available in the relevant contact flow blocks.
disassociateLambdaFunction
in interface AmazonConnect
disassociateLambdaFunctionRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public DisassociateLexBotResult disassociateLexBot(DisassociateLexBotRequest request)
Revokes authorization from the specified instance to access the specified Amazon Lex bot.
disassociateLexBot
in interface AmazonConnect
disassociateLexBotRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public DisassociateRoutingProfileQueuesResult disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest request)
Disassociates a set of queues from a routing profile.
disassociateRoutingProfileQueues
in interface AmazonConnect
disassociateRoutingProfileQueuesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public DisassociateSecurityKeyResult disassociateSecurityKey(DisassociateSecurityKeyRequest request)
Deletes the specified security key.
disassociateSecurityKey
in interface AmazonConnect
disassociateSecurityKeyRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public GetContactAttributesResult getContactAttributes(GetContactAttributesRequest request)
Retrieves the contact attributes for the specified contact.
getContactAttributes
in interface AmazonConnect
getContactAttributesRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.public GetCurrentMetricDataResult getCurrentMetricData(GetCurrentMetricDataRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.InternalServiceException
- Request processing failed due to an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.ResourceNotFoundException
- The specified resource was not found.public GetFederationTokenResult getFederationToken(GetFederationTokenRequest request)
Retrieves a token for federation.
getFederationToken
in interface AmazonConnect
getFederationTokenRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.UserNotFoundException
- No user with the specified credentials was found in the Amazon Connect instance.InternalServiceException
- Request processing failed due to an error or failure with the service.DuplicateResourceException
- A resource with the specified name already exists.public GetMetricDataResult getMetricData(GetMetricDataRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.InternalServiceException
- Request processing failed due to an error or failure with the service.ThrottlingException
- The throttling limit has been exceeded.ResourceNotFoundException
- The specified resource was not found.public ListApprovedOriginsResult listApprovedOrigins(ListApprovedOriginsRequest request)
Returns a paginated list of all approved origins associated with the instance.
listApprovedOrigins
in interface AmazonConnect
listApprovedOriginsRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public ListContactFlowsResult listContactFlows(ListContactFlowsRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public ListHoursOfOperationsResult listHoursOfOperations(ListHoursOfOperationsRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public ListInstanceAttributesResult listInstanceAttributes(ListInstanceAttributesRequest request)
Returns a paginated list of all attribute types for the given instance.
listInstanceAttributes
in interface AmazonConnect
listInstanceAttributesRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public ListInstanceStorageConfigsResult listInstanceStorageConfigs(ListInstanceStorageConfigsRequest request)
Returns a paginated list of storage configs for the identified instance and resource type.
listInstanceStorageConfigs
in interface AmazonConnect
listInstanceStorageConfigsRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public ListInstancesResult listInstances(ListInstancesRequest request)
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
- The request is not valid.InternalServiceException
- Request processing failed due to an error or failure with the service.public ListLambdaFunctionsResult listLambdaFunctions(ListLambdaFunctionsRequest request)
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
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public ListLexBotsResult listLexBots(ListLexBotsRequest request)
Returns a paginated list of all the Amazon Lex bots currently associated with the instance.
listLexBots
in interface AmazonConnect
listLexBotsRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public ListPromptsResult listPrompts(ListPromptsRequest request)
Provides information about the prompts for the specified Amazon Connect instance.
listPrompts
in interface AmazonConnect
listPromptsRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public ListQueuesResult listQueues(ListQueuesRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public ListRoutingProfileQueuesResult listRoutingProfileQueues(ListRoutingProfileQueuesRequest request)
List the queues associated with a routing profile.
listRoutingProfileQueues
in interface AmazonConnect
listRoutingProfileQueuesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public ListSecurityKeysResult listSecurityKeys(ListSecurityKeysRequest request)
Returns a paginated list of all security keys associated with the instance.
listSecurityKeys
in interface AmazonConnect
listSecurityKeysRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.InternalServiceException
- Request processing failed due to an error or failure with the service.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.public ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public ListUsersResult listUsers(ListUsersRequest request)
Provides summary information about the users for the specified Amazon Connect instance.
listUsers
in interface AmazonConnect
listUsersRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public ResumeContactRecordingResult resumeContactRecording(ResumeContactRecordingRequest request)
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
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.public StartChatContactResult startChatContact(StartChatContactRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.LimitExceededException
- The allowed limit for the resource has been exceeded.public StartContactRecordingResult startContactRecording(StartContactRecordingRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.public StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.LimitExceededException
- The allowed limit for the resource has been exceeded.DestinationNotAllowedException
- Outbound calls to the destination number are not allowed.OutboundContactNotPermittedException
- The contact is not permitted.public StopContactResult stopContact(StopContactRequest request)
Ends the specified contact.
stopContact
in interface AmazonConnect
stopContactRequest
- InvalidRequestException
- The request is not valid.ContactNotFoundException
- The contact with the specified ID is not active or does not exist.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.public StopContactRecordingResult stopContactRecording(StopContactRecordingRequest request)
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
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.public SuspendContactRecordingResult suspendContactRecording(SuspendContactRecordingRequest request)
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
- The request is not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.public TagResourceResult tagResource(TagResourceRequest request)
Adds the specified tags to the specified resource.
The supported resource types are users, routing profiles, 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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.InternalServiceException
- Request processing failed due to an error or failure with the service.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes the specified tags from the specified resource.
untagResource
in interface AmazonConnect
untagResourceRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.InternalServiceException
- Request processing failed due to an error or failure with the service.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.public UpdateContactAttributesResult updateContactAttributes(UpdateContactAttributesRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.public UpdateContactFlowContentResult updateContactFlowContent(UpdateContactFlowContentRequest request)
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
- The request is not valid.InvalidContactFlowException
- The contact flow is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public UpdateContactFlowNameResult updateContactFlowName(UpdateContactFlowNameRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public UpdateInstanceAttributeResult updateInstanceAttribute(UpdateInstanceAttributeRequest request)
Updates the value for the specified attribute type.
updateInstanceAttribute
in interface AmazonConnect
updateInstanceAttributeRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public UpdateInstanceStorageConfigResult updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest request)
Updates an existing configuration for a resource type. This API is idempotent.
updateInstanceStorageConfig
in interface AmazonConnect
updateInstanceStorageConfigRequest
- ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ThrottlingException
- The throttling limit has been exceeded.public UpdateRoutingProfileConcurrencyResult updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest request)
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
updateRoutingProfileConcurrency
in interface AmazonConnect
updateRoutingProfileConcurrencyRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public UpdateRoutingProfileDefaultOutboundQueueResult updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest request)
Updates the default outbound queue of a routing profile.
updateRoutingProfileDefaultOutboundQueue
in interface AmazonConnect
updateRoutingProfileDefaultOutboundQueueRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public UpdateRoutingProfileNameResult updateRoutingProfileName(UpdateRoutingProfileNameRequest request)
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
- A resource with the specified name already exists.InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public UpdateRoutingProfileQueuesResult updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest request)
Updates the properties associated with a set of queues for a routing profile.
updateRoutingProfileQueues
in interface AmazonConnect
updateRoutingProfileQueuesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public UpdateUserHierarchyResult updateUserHierarchy(UpdateUserHierarchyRequest request)
Assigns the specified hierarchy group to the specified user.
updateUserHierarchy
in interface AmazonConnect
updateUserHierarchyRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public UpdateUserHierarchyGroupNameResult updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest request)
Updates the name of the user hierarchy group.
updateUserHierarchyGroupName
in interface AmazonConnect
updateUserHierarchyGroupNameRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.DuplicateResourceException
- A resource with the specified name already exists.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public UpdateUserHierarchyStructureResult updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest request)
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
updateUserHierarchyStructure
in interface AmazonConnect
updateUserHierarchyStructureRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ResourceInUseException
- That resource is already in use. Please try another.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public UpdateUserIdentityInfoResult updateUserIdentityInfo(UpdateUserIdentityInfoRequest request)
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
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public UpdateUserPhoneConfigResult updateUserPhoneConfig(UpdateUserPhoneConfigRequest request)
Updates the phone configuration settings for the specified user.
updateUserPhoneConfig
in interface AmazonConnect
updateUserPhoneConfigRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public UpdateUserRoutingProfileResult updateUserRoutingProfile(UpdateUserRoutingProfileRequest request)
Assigns the specified routing profile to the specified user.
updateUserRoutingProfile
in interface AmazonConnect
updateUserRoutingProfileRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.public UpdateUserSecurityProfilesResult updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest request)
Assigns the specified security profiles to the specified user.
updateUserSecurityProfiles
in interface AmazonConnect
updateUserSecurityProfilesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the specified parameters are not valid.ResourceNotFoundException
- The specified resource was not found.ThrottlingException
- The throttling limit has been exceeded.InternalServiceException
- Request processing failed due to an error or failure with the service.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 request