@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonConnectAsync extends AmazonConnect
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonConnectAsync
instead.
The Amazon Connect API Reference provides descriptions, syntax, and usage examples for each of the Amazon Connect actions, data types, parameters, and errors. 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.
Throttling limits for the Amazon Connect API operations:
For the GetMetricData
and GetCurrentMetricData
operations, a RateLimit of 5 per second, and
a BurstLimit of 8 per second.
For all other operations, a RateLimit of 2 per second, and a BurstLimit of 5 per second.
You can request an increase to the throttling limits by submitting a Amazon Connect service limits increase form. You must be signed in to your AWS account to access the form.
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<CreateUserResult> |
createUserAsync(CreateUserRequest createUserRequest)
Creates a new user account in your Amazon Connect instance.
|
Future<CreateUserResult> |
createUserAsync(CreateUserRequest createUserRequest,
AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
Creates a new user account in your Amazon Connect instance.
|
Future<DeleteUserResult> |
deleteUserAsync(DeleteUserRequest deleteUserRequest)
Deletes a user account from Amazon Connect.
|
Future<DeleteUserResult> |
deleteUserAsync(DeleteUserRequest deleteUserRequest,
AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
Deletes a user account from Amazon Connect.
|
Future<DescribeUserResult> |
describeUserAsync(DescribeUserRequest describeUserRequest)
Returns a
User object that contains information about the user account specified by the
UserId . |
Future<DescribeUserResult> |
describeUserAsync(DescribeUserRequest describeUserRequest,
AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
Returns a
User object that contains information about the user account specified by the
UserId . |
Future<DescribeUserHierarchyGroupResult> |
describeUserHierarchyGroupAsync(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest)
Returns a
HierarchyGroup object that includes information about a hierarchy group in your instance. |
Future<DescribeUserHierarchyGroupResult> |
describeUserHierarchyGroupAsync(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest,
AsyncHandler<DescribeUserHierarchyGroupRequest,DescribeUserHierarchyGroupResult> asyncHandler)
Returns a
HierarchyGroup object that includes information about a hierarchy group in your instance. |
Future<DescribeUserHierarchyStructureResult> |
describeUserHierarchyStructureAsync(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest)
Returns a
HiearchyGroupStructure object, which contains data about the levels in the agent
hierarchy. |
Future<DescribeUserHierarchyStructureResult> |
describeUserHierarchyStructureAsync(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest,
AsyncHandler<DescribeUserHierarchyStructureRequest,DescribeUserHierarchyStructureResult> asyncHandler)
Returns a
HiearchyGroupStructure object, which contains data about the levels in the agent
hierarchy. |
Future<GetContactAttributesResult> |
getContactAttributesAsync(GetContactAttributesRequest getContactAttributesRequest)
Retrieves the contact attributes associated with a contact.
|
Future<GetContactAttributesResult> |
getContactAttributesAsync(GetContactAttributesRequest getContactAttributesRequest,
AsyncHandler<GetContactAttributesRequest,GetContactAttributesResult> asyncHandler)
Retrieves the contact attributes associated with a contact.
|
Future<GetCurrentMetricDataResult> |
getCurrentMetricDataAsync(GetCurrentMetricDataRequest getCurrentMetricDataRequest)
The
GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance. |
Future<GetCurrentMetricDataResult> |
getCurrentMetricDataAsync(GetCurrentMetricDataRequest getCurrentMetricDataRequest,
AsyncHandler<GetCurrentMetricDataRequest,GetCurrentMetricDataResult> asyncHandler)
The
GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance. |
Future<GetFederationTokenResult> |
getFederationTokenAsync(GetFederationTokenRequest getFederationTokenRequest)
Retrieves a token for federation.
|
Future<GetFederationTokenResult> |
getFederationTokenAsync(GetFederationTokenRequest getFederationTokenRequest,
AsyncHandler<GetFederationTokenRequest,GetFederationTokenResult> asyncHandler)
Retrieves a token for federation.
|
Future<GetMetricDataResult> |
getMetricDataAsync(GetMetricDataRequest getMetricDataRequest)
The
GetMetricData operation retrieves historical metrics data from your Amazon Connect instance. |
Future<GetMetricDataResult> |
getMetricDataAsync(GetMetricDataRequest getMetricDataRequest,
AsyncHandler<GetMetricDataRequest,GetMetricDataResult> asyncHandler)
The
GetMetricData operation retrieves historical metrics data from your Amazon Connect instance. |
Future<ListRoutingProfilesResult> |
listRoutingProfilesAsync(ListRoutingProfilesRequest listRoutingProfilesRequest)
Returns an array of
RoutingProfileSummary objects that includes information about the routing
profiles in your instance. |
Future<ListRoutingProfilesResult> |
listRoutingProfilesAsync(ListRoutingProfilesRequest listRoutingProfilesRequest,
AsyncHandler<ListRoutingProfilesRequest,ListRoutingProfilesResult> asyncHandler)
Returns an array of
RoutingProfileSummary objects that includes information about the routing
profiles in your instance. |
Future<ListSecurityProfilesResult> |
listSecurityProfilesAsync(ListSecurityProfilesRequest listSecurityProfilesRequest)
Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your
instance, including the ARN, Id, and Name of the security profile.
|
Future<ListSecurityProfilesResult> |
listSecurityProfilesAsync(ListSecurityProfilesRequest listSecurityProfilesRequest,
AsyncHandler<ListSecurityProfilesRequest,ListSecurityProfilesResult> asyncHandler)
Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your
instance, including the ARN, Id, and Name of the security profile.
|
Future<ListUserHierarchyGroupsResult> |
listUserHierarchyGroupsAsync(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)
Returns a
UserHierarchyGroupSummaryList , which is an array of HierarchyGroupSummary
objects that contain information about the hierarchy groups in your instance. |
Future<ListUserHierarchyGroupsResult> |
listUserHierarchyGroupsAsync(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest,
AsyncHandler<ListUserHierarchyGroupsRequest,ListUserHierarchyGroupsResult> asyncHandler)
Returns a
UserHierarchyGroupSummaryList , which is an array of HierarchyGroupSummary
objects that contain information about the hierarchy groups in your instance. |
Future<ListUsersResult> |
listUsersAsync(ListUsersRequest listUsersRequest)
Returns a
UserSummaryList , which is an array of UserSummary objects. |
Future<ListUsersResult> |
listUsersAsync(ListUsersRequest listUsersRequest,
AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
Returns a
UserSummaryList , which is an array of UserSummary objects. |
Future<StartOutboundVoiceContactResult> |
startOutboundVoiceContactAsync(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest)
The
StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a
customer. |
Future<StartOutboundVoiceContactResult> |
startOutboundVoiceContactAsync(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest,
AsyncHandler<StartOutboundVoiceContactRequest,StartOutboundVoiceContactResult> asyncHandler)
The
StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a
customer. |
Future<StopContactResult> |
stopContactAsync(StopContactRequest stopContactRequest)
Ends the contact initiated by the
StartOutboundVoiceContact operation. |
Future<StopContactResult> |
stopContactAsync(StopContactRequest stopContactRequest,
AsyncHandler<StopContactRequest,StopContactResult> asyncHandler)
Ends the contact initiated by the
StartOutboundVoiceContact operation. |
Future<UpdateContactAttributesResult> |
updateContactAttributesAsync(UpdateContactAttributesRequest updateContactAttributesRequest)
The
UpdateContactAttributes operation lets you programmatically create new, or update existing,
contact attributes associated with a contact. |
Future<UpdateContactAttributesResult> |
updateContactAttributesAsync(UpdateContactAttributesRequest updateContactAttributesRequest,
AsyncHandler<UpdateContactAttributesRequest,UpdateContactAttributesResult> asyncHandler)
The
UpdateContactAttributes operation lets you programmatically create new, or update existing,
contact attributes associated with a contact. |
Future<UpdateUserHierarchyResult> |
updateUserHierarchyAsync(UpdateUserHierarchyRequest updateUserHierarchyRequest)
Assigns the specified hierarchy group to the user.
|
Future<UpdateUserHierarchyResult> |
updateUserHierarchyAsync(UpdateUserHierarchyRequest updateUserHierarchyRequest,
AsyncHandler<UpdateUserHierarchyRequest,UpdateUserHierarchyResult> asyncHandler)
Assigns the specified hierarchy group to the user.
|
Future<UpdateUserIdentityInfoResult> |
updateUserIdentityInfoAsync(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest)
Updates the identity information for the specified user in a
UserIdentityInfo object, including
email, first name, and last name. |
Future<UpdateUserIdentityInfoResult> |
updateUserIdentityInfoAsync(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest,
AsyncHandler<UpdateUserIdentityInfoRequest,UpdateUserIdentityInfoResult> asyncHandler)
Updates the identity information for the specified user in a
UserIdentityInfo object, including
email, first name, and last name. |
Future<UpdateUserPhoneConfigResult> |
updateUserPhoneConfigAsync(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest)
Updates the phone configuration settings in the
UserPhoneConfig object for the specified user. |
Future<UpdateUserPhoneConfigResult> |
updateUserPhoneConfigAsync(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest,
AsyncHandler<UpdateUserPhoneConfigRequest,UpdateUserPhoneConfigResult> asyncHandler)
Updates the phone configuration settings in the
UserPhoneConfig object for the specified user. |
Future<UpdateUserRoutingProfileResult> |
updateUserRoutingProfileAsync(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest)
Assigns the specified routing profile to a user.
|
Future<UpdateUserRoutingProfileResult> |
updateUserRoutingProfileAsync(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest,
AsyncHandler<UpdateUserRoutingProfileRequest,UpdateUserRoutingProfileResult> asyncHandler)
Assigns the specified routing profile to a user.
|
Future<UpdateUserSecurityProfilesResult> |
updateUserSecurityProfilesAsync(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest)
Updates the security profiles assigned to the user.
|
Future<UpdateUserSecurityProfilesResult> |
updateUserSecurityProfilesAsync(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest,
AsyncHandler<UpdateUserSecurityProfilesRequest,UpdateUserSecurityProfilesResult> asyncHandler)
Updates the security profiles assigned to the user.
|
createUser, deleteUser, describeUser, describeUserHierarchyGroup, describeUserHierarchyStructure, getCachedResponseMetadata, getContactAttributes, getCurrentMetricData, getFederationToken, getMetricData, listRoutingProfiles, listSecurityProfiles, listUserHierarchyGroups, listUsers, shutdown, startOutboundVoiceContact, stopContact, updateContactAttributes, updateUserHierarchy, updateUserIdentityInfo, updateUserPhoneConfig, updateUserRoutingProfile, updateUserSecurityProfiles
Future<CreateUserResult> createUserAsync(CreateUserRequest createUserRequest)
Creates a new user account in your Amazon Connect instance.
createUserRequest
- Future<CreateUserResult> createUserAsync(CreateUserRequest createUserRequest, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
Creates a new user account in your Amazon Connect instance.
createUserRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest)
Deletes a user account from Amazon Connect.
deleteUserRequest
- Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
Deletes a user account from Amazon Connect.
deleteUserRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeUserResult> describeUserAsync(DescribeUserRequest describeUserRequest)
Returns a User
object that contains information about the user account specified by the
UserId
.
describeUserRequest
- Future<DescribeUserResult> describeUserAsync(DescribeUserRequest describeUserRequest, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
Returns a User
object that contains information about the user account specified by the
UserId
.
describeUserRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeUserHierarchyGroupResult> describeUserHierarchyGroupAsync(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest)
Returns a HierarchyGroup
object that includes information about a hierarchy group in your instance.
describeUserHierarchyGroupRequest
- Future<DescribeUserHierarchyGroupResult> describeUserHierarchyGroupAsync(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest, AsyncHandler<DescribeUserHierarchyGroupRequest,DescribeUserHierarchyGroupResult> asyncHandler)
Returns a HierarchyGroup
object that includes information about a hierarchy group in your instance.
describeUserHierarchyGroupRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeUserHierarchyStructureResult> describeUserHierarchyStructureAsync(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest)
Returns a HiearchyGroupStructure
object, which contains data about the levels in the agent
hierarchy.
describeUserHierarchyStructureRequest
- Future<DescribeUserHierarchyStructureResult> describeUserHierarchyStructureAsync(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest, AsyncHandler<DescribeUserHierarchyStructureRequest,DescribeUserHierarchyStructureResult> asyncHandler)
Returns a HiearchyGroupStructure
object, which contains data about the levels in the agent
hierarchy.
describeUserHierarchyStructureRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetContactAttributesResult> getContactAttributesAsync(GetContactAttributesRequest getContactAttributesRequest)
Retrieves the contact attributes associated with a contact.
getContactAttributesRequest
- Future<GetContactAttributesResult> getContactAttributesAsync(GetContactAttributesRequest getContactAttributesRequest, AsyncHandler<GetContactAttributesRequest,GetContactAttributesResult> asyncHandler)
Retrieves the contact attributes associated with a contact.
getContactAttributesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetCurrentMetricDataResult> getCurrentMetricDataAsync(GetCurrentMetricDataRequest getCurrentMetricDataRequest)
The GetCurrentMetricData
operation retrieves current metric data from your Amazon Connect instance.
If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData
action.
getCurrentMetricDataRequest
- Future<GetCurrentMetricDataResult> getCurrentMetricDataAsync(GetCurrentMetricDataRequest getCurrentMetricDataRequest, AsyncHandler<GetCurrentMetricDataRequest,GetCurrentMetricDataResult> asyncHandler)
The GetCurrentMetricData
operation retrieves current metric data from your Amazon Connect instance.
If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData
action.
getCurrentMetricDataRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetFederationTokenResult> getFederationTokenAsync(GetFederationTokenRequest getFederationTokenRequest)
Retrieves a token for federation.
getFederationTokenRequest
- Future<GetFederationTokenResult> getFederationTokenAsync(GetFederationTokenRequest getFederationTokenRequest, AsyncHandler<GetFederationTokenRequest,GetFederationTokenResult> asyncHandler)
Retrieves a token for federation.
getFederationTokenRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMetricDataResult> getMetricDataAsync(GetMetricDataRequest getMetricDataRequest)
The GetMetricData
operation retrieves historical metrics data from your Amazon Connect instance.
If you are using an IAM account, it must have permission to the connect:GetMetricData
action.
getMetricDataRequest
- Future<GetMetricDataResult> getMetricDataAsync(GetMetricDataRequest getMetricDataRequest, AsyncHandler<GetMetricDataRequest,GetMetricDataResult> asyncHandler)
The GetMetricData
operation retrieves historical metrics data from your Amazon Connect instance.
If you are using an IAM account, it must have permission to the connect:GetMetricData
action.
getMetricDataRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListRoutingProfilesResult> listRoutingProfilesAsync(ListRoutingProfilesRequest listRoutingProfilesRequest)
Returns an array of RoutingProfileSummary
objects that includes information about the routing
profiles in your instance.
listRoutingProfilesRequest
- Future<ListRoutingProfilesResult> listRoutingProfilesAsync(ListRoutingProfilesRequest listRoutingProfilesRequest, AsyncHandler<ListRoutingProfilesRequest,ListRoutingProfilesResult> asyncHandler)
Returns an array of RoutingProfileSummary
objects that includes information about the routing
profiles in your instance.
listRoutingProfilesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListSecurityProfilesResult> listSecurityProfilesAsync(ListSecurityProfilesRequest listSecurityProfilesRequest)
Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.
listSecurityProfilesRequest
- Future<ListSecurityProfilesResult> listSecurityProfilesAsync(ListSecurityProfilesRequest listSecurityProfilesRequest, AsyncHandler<ListSecurityProfilesRequest,ListSecurityProfilesResult> asyncHandler)
Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.
listSecurityProfilesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListUserHierarchyGroupsResult> listUserHierarchyGroupsAsync(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)
Returns a UserHierarchyGroupSummaryList
, which is an array of HierarchyGroupSummary
objects that contain information about the hierarchy groups in your instance.
listUserHierarchyGroupsRequest
- Future<ListUserHierarchyGroupsResult> listUserHierarchyGroupsAsync(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest, AsyncHandler<ListUserHierarchyGroupsRequest,ListUserHierarchyGroupsResult> asyncHandler)
Returns a UserHierarchyGroupSummaryList
, which is an array of HierarchyGroupSummary
objects that contain information about the hierarchy groups in your instance.
listUserHierarchyGroupsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest)
Returns a UserSummaryList
, which is an array of UserSummary
objects.
listUsersRequest
- Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
Returns a UserSummaryList
, which is an array of UserSummary
objects.
listUsersRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartOutboundVoiceContactResult> startOutboundVoiceContactAsync(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest)
The StartOutboundVoiceContact
operation initiates a contact flow to place an outbound call to a
customer.
If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact
action.
There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, the call fails.
startOutboundVoiceContactRequest
- Future<StartOutboundVoiceContactResult> startOutboundVoiceContactAsync(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest, AsyncHandler<StartOutboundVoiceContactRequest,StartOutboundVoiceContactResult> asyncHandler)
The StartOutboundVoiceContact
operation initiates a contact flow to place an outbound call to a
customer.
If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact
action.
There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, the call fails.
startOutboundVoiceContactRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopContactResult> stopContactAsync(StopContactRequest stopContactRequest)
Ends the contact initiated by the StartOutboundVoiceContact
operation.
If you are using an IAM account, it must have permission to the connect:StopContact
action.
stopContactRequest
- Future<StopContactResult> stopContactAsync(StopContactRequest stopContactRequest, AsyncHandler<StopContactRequest,StopContactResult> asyncHandler)
Ends the contact initiated by the StartOutboundVoiceContact
operation.
If you are using an IAM account, it must have permission to the connect:StopContact
action.
stopContactRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateContactAttributesResult> updateContactAttributesAsync(UpdateContactAttributesRequest updateContactAttributesRequest)
The UpdateContactAttributes
operation lets you programmatically create new, or update existing,
contact attributes associated with a contact. You can use the operation to 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 use the UpdateContactAttributes
operation to update
attributes for a contact using data from your CRM application and save the data with the contact in Amazon
Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted.
Important:
You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.
updateContactAttributesRequest
- Future<UpdateContactAttributesResult> updateContactAttributesAsync(UpdateContactAttributesRequest updateContactAttributesRequest, AsyncHandler<UpdateContactAttributesRequest,UpdateContactAttributesResult> asyncHandler)
The UpdateContactAttributes
operation lets you programmatically create new, or update existing,
contact attributes associated with a contact. You can use the operation to 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 use the UpdateContactAttributes
operation to update
attributes for a contact using data from your CRM application and save the data with the contact in Amazon
Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted.
Important:
You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.
updateContactAttributesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateUserHierarchyResult> updateUserHierarchyAsync(UpdateUserHierarchyRequest updateUserHierarchyRequest)
Assigns the specified hierarchy group to the user.
updateUserHierarchyRequest
- Future<UpdateUserHierarchyResult> updateUserHierarchyAsync(UpdateUserHierarchyRequest updateUserHierarchyRequest, AsyncHandler<UpdateUserHierarchyRequest,UpdateUserHierarchyResult> asyncHandler)
Assigns the specified hierarchy group to the user.
updateUserHierarchyRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateUserIdentityInfoResult> updateUserIdentityInfoAsync(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest)
Updates the identity information for the specified user in a UserIdentityInfo
object, including
email, first name, and last name.
updateUserIdentityInfoRequest
- Future<UpdateUserIdentityInfoResult> updateUserIdentityInfoAsync(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest, AsyncHandler<UpdateUserIdentityInfoRequest,UpdateUserIdentityInfoResult> asyncHandler)
Updates the identity information for the specified user in a UserIdentityInfo
object, including
email, first name, and last name.
updateUserIdentityInfoRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateUserPhoneConfigResult> updateUserPhoneConfigAsync(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest)
Updates the phone configuration settings in the UserPhoneConfig
object for the specified user.
updateUserPhoneConfigRequest
- Future<UpdateUserPhoneConfigResult> updateUserPhoneConfigAsync(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest, AsyncHandler<UpdateUserPhoneConfigRequest,UpdateUserPhoneConfigResult> asyncHandler)
Updates the phone configuration settings in the UserPhoneConfig
object for the specified user.
updateUserPhoneConfigRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateUserRoutingProfileResult> updateUserRoutingProfileAsync(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest)
Assigns the specified routing profile to a user.
updateUserRoutingProfileRequest
- Future<UpdateUserRoutingProfileResult> updateUserRoutingProfileAsync(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest, AsyncHandler<UpdateUserRoutingProfileRequest,UpdateUserRoutingProfileResult> asyncHandler)
Assigns the specified routing profile to a user.
updateUserRoutingProfileRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateUserSecurityProfilesResult> updateUserSecurityProfilesAsync(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest)
Updates the security profiles assigned to the user.
updateUserSecurityProfilesRequest
- Future<UpdateUserSecurityProfilesResult> updateUserSecurityProfilesAsync(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest, AsyncHandler<UpdateUserSecurityProfilesRequest,UpdateUserSecurityProfilesResult> asyncHandler)
Updates the security profiles assigned to the user.
updateUserSecurityProfilesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.