@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonConnect
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonConnect
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreateUserResult |
createUser(CreateUserRequest createUserRequest)
Creates a new user account in your Amazon Connect instance.
|
DeleteUserResult |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user account from Amazon Connect.
|
DescribeUserResult |
describeUser(DescribeUserRequest describeUserRequest)
Returns a
User object that contains information about the user account specified by the
UserId . |
DescribeUserHierarchyGroupResult |
describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest)
Returns a
HierarchyGroup object that includes information about a hierarchy group in your instance. |
DescribeUserHierarchyStructureResult |
describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest)
Returns a
HiearchyGroupStructure object, which contains data about the levels in the agent
hierarchy. |
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetContactAttributesResult |
getContactAttributes(GetContactAttributesRequest getContactAttributesRequest)
Retrieves the contact attributes associated with a contact.
|
GetCurrentMetricDataResult |
getCurrentMetricData(GetCurrentMetricDataRequest getCurrentMetricDataRequest)
The
GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance. |
GetFederationTokenResult |
getFederationToken(GetFederationTokenRequest getFederationTokenRequest)
Retrieves a token for federation.
|
GetMetricDataResult |
getMetricData(GetMetricDataRequest getMetricDataRequest)
The
GetMetricData operation retrieves historical metrics data from your Amazon Connect instance. |
ListRoutingProfilesResult |
listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest)
Returns an array of
RoutingProfileSummary objects that includes information about the routing
profiles in your instance. |
ListSecurityProfilesResult |
listSecurityProfiles(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.
|
ListUserHierarchyGroupsResult |
listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)
Returns a
UserHierarchyGroupSummaryList , which is an array of HierarchyGroupSummary
objects that contain information about the hierarchy groups in your instance. |
ListUsersResult |
listUsers(ListUsersRequest listUsersRequest)
Returns a
UserSummaryList , which is an array of UserSummary objects. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartOutboundVoiceContactResult |
startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest)
The
StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a
customer. |
StopContactResult |
stopContact(StopContactRequest stopContactRequest)
Ends the contact initiated by the
StartOutboundVoiceContact operation. |
UpdateContactAttributesResult |
updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest)
The
UpdateContactAttributes operation lets you programmatically create new, or update existing,
contact attributes associated with a contact. |
UpdateUserHierarchyResult |
updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest)
Assigns the specified hierarchy group to the user.
|
UpdateUserIdentityInfoResult |
updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest)
Updates the identity information for the specified user in a
UserIdentityInfo object, including
email, first name, and last name. |
UpdateUserPhoneConfigResult |
updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest)
Updates the phone configuration settings in the
UserPhoneConfig object for the specified user. |
UpdateUserRoutingProfileResult |
updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest)
Assigns the specified routing profile to a user.
|
UpdateUserSecurityProfilesResult |
updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest)
Updates the security profiles assigned to the user.
|
static final String ENDPOINT_PREFIX
CreateUserResult createUser(CreateUserRequest createUserRequest)
Creates a new user account in your Amazon Connect instance.
createUserRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation are not valid.LimitExceededException
- The allowed limit for the resource has been reached.DuplicateResourceException
- A resource with that 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.DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user account from Amazon Connect.
deleteUserRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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.DescribeUserResult describeUser(DescribeUserRequest describeUserRequest)
Returns a User
object that contains information about the user account specified by the
UserId
.
describeUserRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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.DescribeUserHierarchyGroupResult describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest)
Returns a HierarchyGroup
object that includes information about a hierarchy group in your instance.
describeUserHierarchyGroupRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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.DescribeUserHierarchyStructureResult describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest)
Returns a HiearchyGroupStructure
object, which contains data about the levels in the agent
hierarchy.
describeUserHierarchyStructureRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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.GetContactAttributesResult getContactAttributes(GetContactAttributesRequest getContactAttributesRequest)
Retrieves the contact attributes associated with a contact.
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.GetCurrentMetricDataResult getCurrentMetricData(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
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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.GetFederationTokenResult getFederationToken(GetFederationTokenRequest getFederationTokenRequest)
Retrieves a token for federation.
getFederationTokenRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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 that name already exists.GetMetricDataResult getMetricData(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
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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.ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest)
Returns an array of RoutingProfileSummary
objects that includes information about the routing
profiles in your instance.
listRoutingProfilesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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.ListSecurityProfilesResult listSecurityProfiles(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
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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.ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)
Returns a UserHierarchyGroupSummaryList
, which is an array of HierarchyGroupSummary
objects that contain information about the hierarchy groups in your instance.
listUserHierarchyGroupsRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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.ListUsersResult listUsers(ListUsersRequest listUsersRequest)
Returns a UserSummaryList
, which is an array of UserSummary
objects.
listUsersRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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.StartOutboundVoiceContactResult startOutboundVoiceContact(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
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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 reached.DestinationNotAllowedException
- Outbound calls to the destination number are not allowed.OutboundContactNotPermittedException
- The contact is not permitted.StopContactResult stopContact(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
- 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 parameters provided to the operation are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.UpdateContactAttributesResult updateContactAttributes(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
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation are not valid.ResourceNotFoundException
- The specified resource was not found.InternalServiceException
- Request processing failed due to an error or failure with the service.UpdateUserHierarchyResult updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest)
Assigns the specified hierarchy group to the user.
updateUserHierarchyRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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.UpdateUserIdentityInfoResult updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest)
Updates the identity information for the specified user in a UserIdentityInfo
object, including
email, first name, and last name.
updateUserIdentityInfoRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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.UpdateUserPhoneConfigResult updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest)
Updates the phone configuration settings in the UserPhoneConfig
object for the specified user.
updateUserPhoneConfigRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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.UpdateUserRoutingProfileResult updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest)
Assigns the specified routing profile to a user.
updateUserRoutingProfileRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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.UpdateUserSecurityProfilesResult updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest)
Updates the security profiles assigned to the user.
updateUserSecurityProfilesRequest
- InvalidRequestException
- The request is not valid.InvalidParameterException
- One or more of the parameters provided to the operation 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.