com.amazonaws.services.connect

Class AbstractAmazonConnect

java.lang.Object

com.amazonaws.services.connect.AbstractAmazonConnect

All Implemented Interfaces:

AmazonConnect

Direct Known Subclasses:

AbstractAmazonConnectAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonConnect
extends Object
implements AmazonConnect

Abstract implementation of AmazonConnect. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.connect.AmazonConnect

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAmazonConnect()

Method Summary

Modifier and Type	Method and Description
CreateUserResult	createUser(CreateUserRequest request) Creates a user account for the specified Amazon Connect instance.
DeleteUserResult	deleteUser(DeleteUserRequest request) Deletes a user account from the specified Amazon Connect instance.
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.
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.
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.
ListPhoneNumbersResult	listPhoneNumbers(ListPhoneNumbersRequest request) Provides information about the phone numbers for the specified Amazon Connect instance.
ListQueuesResult	listQueues(ListQueuesRequest request) Provides information about the queues for the specified Amazon Connect instance.
ListRoutingProfilesResult	listRoutingProfiles(ListRoutingProfilesRequest request) Provides summary information about the routing profiles for the specified Amazon Connect 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.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartChatContactResult	startChatContact(StartChatContactRequest request) Initiates a contact flow to start a new chat for the customer.
StartOutboundVoiceContactResult	startOutboundVoiceContact(StartOutboundVoiceContactRequest request) Initiates a contact flow to place an outbound call to a customer.
StopContactResult	stopContact(StopContactRequest request) Ends the specified contact.
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.
UpdateUserHierarchyResult	updateUserHierarchy(UpdateUserHierarchyRequest request) Assigns the specified hierarchy group to the specified user.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAmazonConnect

protected AbstractAmazonConnect()

Method Detail

createUser

public CreateUserResult createUser(CreateUserRequest request)

Description copied from interface: AmazonConnect

Creates a user account for the specified Amazon Connect instance.

Specified by:

createUser in interface AmazonConnect

Returns:

Result of the CreateUser operation returned by the service.

See Also:

AWS API Documentation

deleteUser

public DeleteUserResult deleteUser(DeleteUserRequest request)

Description copied from interface: AmazonConnect

Deletes a user account from the specified Amazon Connect instance.

Specified by:

deleteUser in interface AmazonConnect

Returns:

Result of the DeleteUser operation returned by the service.

See Also:

AWS API Documentation

describeUser

public DescribeUserResult describeUser(DescribeUserRequest request)

Description copied from interface: AmazonConnect

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.

Specified by:

describeUser in interface AmazonConnect

Returns:

Result of the DescribeUser operation returned by the service.

See Also:

AWS API Documentation

describeUserHierarchyGroup

public DescribeUserHierarchyGroupResult describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest request)

Description copied from interface: AmazonConnect

Describes the specified hierarchy group.

Specified by:

describeUserHierarchyGroup in interface AmazonConnect

Returns:

Result of the DescribeUserHierarchyGroup operation returned by the service.

See Also:

AWS API Documentation

describeUserHierarchyStructure

public DescribeUserHierarchyStructureResult describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest request)

Description copied from interface: AmazonConnect

Describes the hierarchy structure of the specified Amazon Connect instance.

Specified by:

describeUserHierarchyStructure in interface AmazonConnect

Returns:

Result of the DescribeUserHierarchyStructure operation returned by the service.

See Also:

AWS API Documentation

getContactAttributes

public GetContactAttributesResult getContactAttributes(GetContactAttributesRequest request)

Description copied from interface: AmazonConnect

Retrieves the contact attributes for the specified contact.

Specified by:

getContactAttributes in interface AmazonConnect

Returns:

Result of the GetContactAttributes operation returned by the service.

See Also:

AWS API Documentation

getCurrentMetricData

public GetCurrentMetricDataResult getCurrentMetricData(GetCurrentMetricDataRequest request)

Description copied from interface: AmazonConnect

Gets the real-time metric data from the specified Amazon Connect instance.

For more information, see Real-time Metrics Reports in the Amazon Connect Administrator Guide.

Specified by:

getCurrentMetricData in interface AmazonConnect

Returns:

Result of the GetCurrentMetricData operation returned by the service.

See Also:

AWS API Documentation

getFederationToken

public GetFederationTokenResult getFederationToken(GetFederationTokenRequest request)

Description copied from interface: AmazonConnect

Retrieves a token for federation.

Specified by:

getFederationToken in interface AmazonConnect

Returns:

Result of the GetFederationToken operation returned by the service.

See Also:

AWS API Documentation

getMetricData

public GetMetricDataResult getMetricData(GetMetricDataRequest request)

Description copied from interface: AmazonConnect

Gets historical metric data from the specified Amazon Connect instance.

For more information, see Historical Metrics Reports in the Amazon Connect Administrator Guide.

Specified by:

getMetricData in interface AmazonConnect

Returns:

Result of the GetMetricData operation returned by the service.

See Also:

AWS API Documentation

listContactFlows

public ListContactFlowsResult listContactFlows(ListContactFlowsRequest request)

Description copied from interface: AmazonConnect

Provides information about the contact flows for the specified Amazon Connect instance.

Specified by:

listContactFlows in interface AmazonConnect

Returns:

Result of the ListContactFlows operation returned by the service.

See Also:

AWS API Documentation

listHoursOfOperations

public ListHoursOfOperationsResult listHoursOfOperations(ListHoursOfOperationsRequest request)

Description copied from interface: AmazonConnect

Provides information about the hours of operation for the specified Amazon Connect instance.

Specified by:

listHoursOfOperations in interface AmazonConnect

Returns:

Result of the ListHoursOfOperations operation returned by the service.

See Also:

AWS API Documentation

listPhoneNumbers

public ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest request)

Description copied from interface: AmazonConnect

Provides information about the phone numbers for the specified Amazon Connect instance.

Specified by:

listPhoneNumbers in interface AmazonConnect

Returns:

Result of the ListPhoneNumbers operation returned by the service.

See Also:

AWS API Documentation

listQueues

public ListQueuesResult listQueues(ListQueuesRequest request)

Description copied from interface: AmazonConnect

Provides information about the queues for the specified Amazon Connect instance.

Specified by:

listQueues in interface AmazonConnect

Returns:

Result of the ListQueues operation returned by the service.

See Also:

AWS API Documentation

listRoutingProfiles

public ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest request)

Description copied from interface: AmazonConnect

Provides summary information about the routing profiles for the specified Amazon Connect instance.

Specified by:

listRoutingProfiles in interface AmazonConnect

Returns:

Result of the ListRoutingProfiles operation returned by the service.

See Also:

AWS API Documentation

listSecurityProfiles

public ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest request)

Description copied from interface: AmazonConnect

Provides summary information about the security profiles for the specified Amazon Connect instance.

Specified by:

listSecurityProfiles in interface AmazonConnect

Returns:

Result of the ListSecurityProfiles operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AmazonConnect

Lists the tags for the specified resource.

Specified by:

listTagsForResource in interface AmazonConnect

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

listUserHierarchyGroups

public ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest request)

Description copied from interface: AmazonConnect

Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

Specified by:

listUserHierarchyGroups in interface AmazonConnect

Returns:

Result of the ListUserHierarchyGroups operation returned by the service.

See Also:

AWS API Documentation

listUsers

public ListUsersResult listUsers(ListUsersRequest request)

Description copied from interface: AmazonConnect

Provides summary information about the users for the specified Amazon Connect instance.

Specified by:

listUsers in interface AmazonConnect

Returns:

Result of the ListUsers operation returned by the service.

See Also:

AWS API Documentation

startChatContact

public StartChatContactResult startChatContact(StartChatContactRequest request)

Description copied from interface: AmazonConnect

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.

Specified by:

startChatContact in interface AmazonConnect

Returns:

Result of the StartChatContact operation returned by the service.

See Also:

AWS API Documentation

startOutboundVoiceContact

public StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest request)

Description copied from interface: AmazonConnect

Initiates a contact flow to place an outbound call to a customer.

There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

Specified by:

startOutboundVoiceContact in interface AmazonConnect

Returns:

Result of the StartOutboundVoiceContact operation returned by the service.

See Also:

AWS API Documentation

stopContact

public StopContactResult stopContact(StopContactRequest request)

Description copied from interface: AmazonConnect

Ends the specified contact.

Specified by:

stopContact in interface AmazonConnect

Returns:

Result of the StopContact operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AmazonConnect

Adds the specified tags to the specified resource.

The supported resource type is users.

Specified by:

tagResource in interface AmazonConnect

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AmazonConnect

Removes the specified tags from the specified resource.

Specified by:

untagResource in interface AmazonConnect

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateContactAttributes

public UpdateContactAttributesResult updateContactAttributes(UpdateContactAttributesRequest request)

Description copied from interface: AmazonConnect

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.

Specified by:

updateContactAttributes in interface AmazonConnect

Returns:

Result of the UpdateContactAttributes operation returned by the service.

See Also:

AWS API Documentation

updateUserHierarchy

public UpdateUserHierarchyResult updateUserHierarchy(UpdateUserHierarchyRequest request)

Description copied from interface: AmazonConnect

Assigns the specified hierarchy group to the specified user.

Specified by:

updateUserHierarchy in interface AmazonConnect

Returns:

Result of the UpdateUserHierarchy operation returned by the service.

See Also:

AWS API Documentation

updateUserIdentityInfo

public UpdateUserIdentityInfoResult updateUserIdentityInfo(UpdateUserIdentityInfoRequest request)

Description copied from interface: AmazonConnect

Updates the identity information for the specified user.

Specified by:

updateUserIdentityInfo in interface AmazonConnect

Returns:

Result of the UpdateUserIdentityInfo operation returned by the service.

See Also:

AWS API Documentation

updateUserPhoneConfig

public UpdateUserPhoneConfigResult updateUserPhoneConfig(UpdateUserPhoneConfigRequest request)

Description copied from interface: AmazonConnect

Updates the phone configuration settings for the specified user.

Specified by:

updateUserPhoneConfig in interface AmazonConnect

Returns:

Result of the UpdateUserPhoneConfig operation returned by the service.

See Also:

AWS API Documentation

updateUserRoutingProfile

public UpdateUserRoutingProfileResult updateUserRoutingProfile(UpdateUserRoutingProfileRequest request)

Description copied from interface: AmazonConnect

Assigns the specified routing profile to the specified user.

Specified by:

updateUserRoutingProfile in interface AmazonConnect

Returns:

Result of the UpdateUserRoutingProfile operation returned by the service.

See Also:

AWS API Documentation

updateUserSecurityProfiles

public UpdateUserSecurityProfilesResult updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest request)

Description copied from interface: AmazonConnect

Assigns the specified security profiles to the specified user.

Specified by:

updateUserSecurityProfiles in interface AmazonConnect

Returns:

Result of the UpdateUserSecurityProfiles operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonConnect

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.

Specified by:

shutdown in interface AmazonConnect

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonConnect

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.

Specified by:

getCachedResponseMetadata in interface AmazonConnect

Parameters:

request - The originally executed request.

Returns:

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