com.amazonaws.services.connect

Interface AmazonConnect

All Known Subinterfaces:

AmazonConnectAsync

All Known Implementing Classes:

AbstractAmazonConnect, AbstractAmazonConnectAsync, AmazonConnectAsyncClient, AmazonConnectClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonConnect

Interface for accessing Amazon Connect.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

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.
GetFederationTokenResult	getFederationToken(GetFederationTokenRequest getFederationTokenRequest) Retrieves a token for federation.
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.
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) Update the security profiles assigned to the user.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createUser

CreateUserResult createUser(CreateUserRequest createUserRequest)

Creates a new user account in your Amazon Connect instance.

Parameters:

createUserRequest -

Returns:

Result of the CreateUser operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

InvalidParameterException - One or more of the parameters provided to the operation are not valid.

LimitExceededException - The limit exceeded the maximum allowed active calls in a queue.

DuplicateResourceException - A resource with that name already exisits.

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.

See Also:

AWS API Documentation

deleteUser

DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)

Deletes a user account from Amazon Connect.

Parameters:

deleteUserRequest -

Returns:

Result of the DeleteUser operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeUser

DescribeUserResult describeUser(DescribeUserRequest describeUserRequest)

Returns a User object that contains information about the user account specified by the UserId.

Parameters:

describeUserRequest -

Returns:

Result of the DescribeUser operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeUserHierarchyGroup

DescribeUserHierarchyGroupResult describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest)

Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.

Parameters:

describeUserHierarchyGroupRequest -

Returns:

Result of the DescribeUserHierarchyGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeUserHierarchyStructure

DescribeUserHierarchyStructureResult describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest)

Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy.

Parameters:

describeUserHierarchyStructureRequest -

Returns:

Result of the DescribeUserHierarchyStructure operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getFederationToken

GetFederationTokenResult getFederationToken(GetFederationTokenRequest getFederationTokenRequest)

Retrieves a token for federation.

Parameters:

getFederationTokenRequest -

Returns:

Result of the GetFederationToken operation returned by the service.

Throws:

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 exisits.

See Also:

AWS API Documentation

listRoutingProfiles

ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest)

Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your instance.

Parameters:

listRoutingProfilesRequest -

Returns:

Result of the ListRoutingProfiles operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listSecurityProfiles

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.

Parameters:

listSecurityProfilesRequest -

Returns:

Result of the ListSecurityProfiles operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listUserHierarchyGroups

ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)

Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your instance.

Parameters:

listUserHierarchyGroupsRequest -

Returns:

Result of the ListUserHierarchyGroups operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listUsers

ListUsersResult listUsers(ListUsersRequest listUsersRequest)

Returns a UserSummaryList, which is an array of UserSummary objects.

Parameters:

listUsersRequest -

Returns:

Result of the ListUsers operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startOutboundVoiceContact

StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest)

The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.

There is a throttling limit placed on usage of the API that includes a RateLimit of 2 per second, and a BurstLimit of 5 per second.

If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact action.

Parameters:

startOutboundVoiceContactRequest -

Returns:

Result of the StartOutboundVoiceContact operation returned by the service.

Throws:

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 limit exceeded the maximum allowed active calls in a queue.

DestinationNotAllowedException - Outbound calls to the destination number are not allowed.

OutboundContactNotPermittedException - The contact is not permitted.

See Also:

AWS API Documentation

stopContact

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.

Parameters:

stopContactRequest -

Returns:

Result of the StopContact operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateUserHierarchy

UpdateUserHierarchyResult updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest)

Assigns the specified hierarchy group to the user.

Parameters:

updateUserHierarchyRequest -

Returns:

Result of the UpdateUserHierarchy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateUserIdentityInfo

UpdateUserIdentityInfoResult updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest)

Updates the identity information for the specified user in a UserIdentityInfo object, including email, first name, and last name.

Parameters:

updateUserIdentityInfoRequest -

Returns:

Result of the UpdateUserIdentityInfo operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateUserPhoneConfig

UpdateUserPhoneConfigResult updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest)

Updates the phone configuration settings in the UserPhoneConfig object for the specified user.

Parameters:

updateUserPhoneConfigRequest -

Returns:

Result of the UpdateUserPhoneConfig operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateUserRoutingProfile

UpdateUserRoutingProfileResult updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest)

Assigns the specified routing profile to a user.

Parameters:

updateUserRoutingProfileRequest -

Returns:

Result of the UpdateUserRoutingProfile operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateUserSecurityProfiles

UpdateUserSecurityProfilesResult updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest)

Update the security profiles assigned to the user.

Parameters:

updateUserSecurityProfilesRequest -

Returns:

Result of the UpdateUserSecurityProfiles operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.