AbstractAmazonConnect (AWS SDK for Java

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateUserResult`	`createUser(CreateUserRequest request)` Creates a new user account in your Amazon Connect instance.
`DeleteUserResult`	`deleteUser(DeleteUserRequest request)` Deletes a user account from Amazon Connect.
`DescribeUserResult`	`describeUser(DescribeUserRequest request)` Returns a `User` object that contains information about the user account specified by the `UserId`.
`DescribeUserHierarchyGroupResult`	`describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest request)` Returns a `HierarchyGroup` object that includes information about a hierarchy group in your instance.
`DescribeUserHierarchyStructureResult`	`describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest request)` 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 request)` Retrieves the contact attributes associated with a contact.
`GetCurrentMetricDataResult`	`getCurrentMetricData(GetCurrentMetricDataRequest request)` The `GetCurrentMetricData` operation retrieves current metric data from your Amazon Connect instance.
`GetFederationTokenResult`	`getFederationToken(GetFederationTokenRequest request)` Retrieves a token for federation.
`GetMetricDataResult`	`getMetricData(GetMetricDataRequest request)` The `GetMetricData` operation retrieves historical metrics data from your Amazon Connect instance.
`ListRoutingProfilesResult`	`listRoutingProfiles(ListRoutingProfilesRequest request)` Returns an array of `RoutingProfileSummary` objects that includes information about the routing profiles in your instance.
`ListSecurityProfilesResult`	`listSecurityProfiles(ListSecurityProfilesRequest request)` 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 request)` Returns a `UserHierarchyGroupSummaryList`, which is an array of `HierarchyGroupSummary` objects that contain information about the hierarchy groups in your instance.
`ListUsersResult`	`listUsers(ListUsersRequest request)` 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 request)` The `StartOutboundVoiceContact` operation initiates a contact flow to place an outbound call to a customer.
`StopContactResult`	`stopContact(StopContactRequest request)` Ends the contact initiated by the `StartOutboundVoiceContact` operation.
`UpdateContactAttributesResult`	`updateContactAttributes(UpdateContactAttributesRequest request)` The `UpdateContactAttributes` operation lets you programmatically create new, or update existing, contact attributes associated with a contact.
`UpdateUserHierarchyResult`	`updateUserHierarchy(UpdateUserHierarchyRequest request)` Assigns the specified hierarchy group to the user.
`UpdateUserIdentityInfoResult`	`updateUserIdentityInfo(UpdateUserIdentityInfoRequest request)` Updates the identity information for the specified user in a `UserIdentityInfo` object, including email, first name, and last name.
`UpdateUserPhoneConfigResult`	`updateUserPhoneConfig(UpdateUserPhoneConfigRequest request)` Updates the phone configuration settings in the `UserPhoneConfig` object for the specified user.
`UpdateUserRoutingProfileResult`	`updateUserRoutingProfile(UpdateUserRoutingProfileRequest request)` Assigns the specified routing profile to a user.
`UpdateUserSecurityProfilesResult`	`updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest request)` Updates the security profiles assigned to the user.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createUser
```
public CreateUserResult createUser(CreateUserRequest request)
```
    Description copied from interface: AmazonConnect
    
    Creates a new user account in your 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 Amazon Connect.
    
    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
    
    Returns a User object that contains information about the user account specified by the UserId.
    
    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
    
    Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.
    
    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
    
    Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy.
    
    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 associated with a 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
    
    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.
    
    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
    
    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.
    
    Specified by:
    
    getMetricData in interface AmazonConnect
    
    Returns:
    
    Result of the GetMetricData operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRoutingProfiles
```
public ListRoutingProfilesResult listRoutingProfiles(ListRoutingProfilesRequest request)
```
    Description copied from interface: AmazonConnect
    
    Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your 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
    
    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.
    
    Specified by:
    
    listSecurityProfiles in interface AmazonConnect
    
    Returns:
    
    Result of the ListSecurityProfiles operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUserHierarchyGroups
```
public ListUserHierarchyGroupsResult listUserHierarchyGroups(ListUserHierarchyGroupsRequest request)
```
    Description copied from interface: AmazonConnect
    
    Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your 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
    
    Returns a UserSummaryList, which is an array of UserSummary objects.
    
    Specified by:
    
    listUsers in interface AmazonConnect
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startOutboundVoiceContact
```
public StartOutboundVoiceContactResult startOutboundVoiceContact(StartOutboundVoiceContactRequest request)
```
    Description copied from interface: AmazonConnect
    
    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.
    
    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 contact initiated by the StartOutboundVoiceContact operation.
    
    If you are using an IAM account, it must have permission to the connect:StopContact action.
    
    Specified by:
    
    stopContact in interface AmazonConnect
    
    Returns:
    
    Result of the StopContact operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateContactAttributes
```
public UpdateContactAttributesResult updateContactAttributes(UpdateContactAttributesRequest request)
```
    Description copied from interface: AmazonConnect
    
    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.
    
    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 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 in a UserIdentityInfo object, including email, first name, and last name.
    
    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 in the UserPhoneConfig object 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 a 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
    
    Updates the security profiles assigned to the 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.

Did this page help you?

Class AbstractAmazonConnect

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createUser

deleteUser

describeUser

describeUserHierarchyGroup

describeUserHierarchyStructure

getContactAttributes

getCurrentMetricData

getFederationToken

getMetricData

listRoutingProfiles

listSecurityProfiles

listUserHierarchyGroups

listUsers

startOutboundVoiceContact

stopContact

updateContactAttributes

updateUserHierarchy

updateUserIdentityInfo

updateUserPhoneConfig

updateUserRoutingProfile

updateUserSecurityProfiles

shutdown

getCachedResponseMetadata