@Generated(value="software.amazon.awssdk:codegen") public interface ConnectAsyncClient extends SdkClient
builder()
method.
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.
There is a throttling limit placed on usage of the Amazon Connect operations that includes a RateLimit of 2 per second, and a BurstLimit of 5 per second.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static ConnectAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
ConnectAsyncClient . |
static ConnectAsyncClient |
create()
Create a
ConnectAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateUserResponse> |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a new user account in your Amazon Connect instance.
|
default CompletableFuture<CreateUserResponse> |
createUser(CreateUserRequest createUserRequest)
Creates a new user account in your Amazon Connect instance.
|
default CompletableFuture<DeleteUserResponse> |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes a user account from Amazon Connect.
|
default CompletableFuture<DeleteUserResponse> |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user account from Amazon Connect.
|
default CompletableFuture<DescribeUserResponse> |
describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Returns a
User object that contains information about the user account specified by the
UserId . |
default CompletableFuture<DescribeUserResponse> |
describeUser(DescribeUserRequest describeUserRequest)
Returns a
User object that contains information about the user account specified by the
UserId . |
default CompletableFuture<DescribeUserHierarchyGroupResponse> |
describeUserHierarchyGroup(Consumer<DescribeUserHierarchyGroupRequest.Builder> describeUserHierarchyGroupRequest)
Returns a
HierarchyGroup object that includes information about a hierarchy group in your instance. |
default CompletableFuture<DescribeUserHierarchyGroupResponse> |
describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest)
Returns a
HierarchyGroup object that includes information about a hierarchy group in your instance. |
default CompletableFuture<DescribeUserHierarchyStructureResponse> |
describeUserHierarchyStructure(Consumer<DescribeUserHierarchyStructureRequest.Builder> describeUserHierarchyStructureRequest)
Returns a
HiearchyGroupStructure object, which contains data about the levels in the agent
hierarchy. |
default CompletableFuture<DescribeUserHierarchyStructureResponse> |
describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest)
Returns a
HiearchyGroupStructure object, which contains data about the levels in the agent
hierarchy. |
default CompletableFuture<GetCurrentMetricDataResponse> |
getCurrentMetricData(Consumer<GetCurrentMetricDataRequest.Builder> getCurrentMetricDataRequest)
The
GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance. |
default CompletableFuture<GetCurrentMetricDataResponse> |
getCurrentMetricData(GetCurrentMetricDataRequest getCurrentMetricDataRequest)
The
GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance. |
default GetCurrentMetricDataPublisher |
getCurrentMetricDataPaginator(Consumer<GetCurrentMetricDataRequest.Builder> getCurrentMetricDataRequest)
The
GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance. |
default GetCurrentMetricDataPublisher |
getCurrentMetricDataPaginator(GetCurrentMetricDataRequest getCurrentMetricDataRequest)
The
GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance. |
default CompletableFuture<GetFederationTokenResponse> |
getFederationToken(Consumer<GetFederationTokenRequest.Builder> getFederationTokenRequest)
Retrieves a token for federation.
|
default CompletableFuture<GetFederationTokenResponse> |
getFederationToken(GetFederationTokenRequest getFederationTokenRequest)
Retrieves a token for federation.
|
default CompletableFuture<GetMetricDataResponse> |
getMetricData(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest)
The
GetMetricData operation retrieves historical metrics data from your Amazon Connect instance. |
default CompletableFuture<GetMetricDataResponse> |
getMetricData(GetMetricDataRequest getMetricDataRequest)
The
GetMetricData operation retrieves historical metrics data from your Amazon Connect instance. |
default GetMetricDataPublisher |
getMetricDataPaginator(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest)
The
GetMetricData operation retrieves historical metrics data from your Amazon Connect instance. |
default GetMetricDataPublisher |
getMetricDataPaginator(GetMetricDataRequest getMetricDataRequest)
The
GetMetricData operation retrieves historical metrics data from your Amazon Connect instance. |
default CompletableFuture<ListRoutingProfilesResponse> |
listRoutingProfiles(Consumer<ListRoutingProfilesRequest.Builder> listRoutingProfilesRequest)
Returns an array of
RoutingProfileSummary objects that includes information about the routing
profiles in your instance. |
default CompletableFuture<ListRoutingProfilesResponse> |
listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest)
Returns an array of
RoutingProfileSummary objects that includes information about the routing
profiles in your instance. |
default CompletableFuture<ListSecurityProfilesResponse> |
listSecurityProfiles(Consumer<ListSecurityProfilesRequest.Builder> 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.
|
default CompletableFuture<ListSecurityProfilesResponse> |
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.
|
default CompletableFuture<ListUserHierarchyGroupsResponse> |
listUserHierarchyGroups(Consumer<ListUserHierarchyGroupsRequest.Builder> listUserHierarchyGroupsRequest)
Returns a
UserHierarchyGroupSummaryList , which is an array of HierarchyGroupSummary
objects that contain information about the hierarchy groups in your instance. |
default CompletableFuture<ListUserHierarchyGroupsResponse> |
listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)
Returns a
UserHierarchyGroupSummaryList , which is an array of HierarchyGroupSummary
objects that contain information about the hierarchy groups in your instance. |
default CompletableFuture<ListUsersResponse> |
listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Returns a
UserSummaryList , which is an array of UserSummary objects. |
default CompletableFuture<ListUsersResponse> |
listUsers(ListUsersRequest listUsersRequest)
Returns a
UserSummaryList , which is an array of UserSummary objects. |
default CompletableFuture<StartOutboundVoiceContactResponse> |
startOutboundVoiceContact(Consumer<StartOutboundVoiceContactRequest.Builder> startOutboundVoiceContactRequest)
The
StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a
customer. |
default CompletableFuture<StartOutboundVoiceContactResponse> |
startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest)
The
StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a
customer. |
default CompletableFuture<StopContactResponse> |
stopContact(Consumer<StopContactRequest.Builder> stopContactRequest)
Ends the contact initiated by the
StartOutboundVoiceContact operation. |
default CompletableFuture<StopContactResponse> |
stopContact(StopContactRequest stopContactRequest)
Ends the contact initiated by the
StartOutboundVoiceContact operation. |
default CompletableFuture<UpdateContactAttributesResponse> |
updateContactAttributes(Consumer<UpdateContactAttributesRequest.Builder> updateContactAttributesRequest)
The
UpdateContactAttributes operation lets you programmatically create new, or update existing,
contact attributes associated with a contact. |
default CompletableFuture<UpdateContactAttributesResponse> |
updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest)
The
UpdateContactAttributes operation lets you programmatically create new, or update existing,
contact attributes associated with a contact. |
default CompletableFuture<UpdateUserHierarchyResponse> |
updateUserHierarchy(Consumer<UpdateUserHierarchyRequest.Builder> updateUserHierarchyRequest)
Assigns the specified hierarchy group to the user.
|
default CompletableFuture<UpdateUserHierarchyResponse> |
updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest)
Assigns the specified hierarchy group to the user.
|
default CompletableFuture<UpdateUserIdentityInfoResponse> |
updateUserIdentityInfo(Consumer<UpdateUserIdentityInfoRequest.Builder> updateUserIdentityInfoRequest)
Updates the identity information for the specified user in a
UserIdentityInfo object, including
email, first name, and last name. |
default CompletableFuture<UpdateUserIdentityInfoResponse> |
updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest)
Updates the identity information for the specified user in a
UserIdentityInfo object, including
email, first name, and last name. |
default CompletableFuture<UpdateUserPhoneConfigResponse> |
updateUserPhoneConfig(Consumer<UpdateUserPhoneConfigRequest.Builder> updateUserPhoneConfigRequest)
Updates the phone configuration settings in the
UserPhoneConfig object for the specified user. |
default CompletableFuture<UpdateUserPhoneConfigResponse> |
updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest)
Updates the phone configuration settings in the
UserPhoneConfig object for the specified user. |
default CompletableFuture<UpdateUserRoutingProfileResponse> |
updateUserRoutingProfile(Consumer<UpdateUserRoutingProfileRequest.Builder> updateUserRoutingProfileRequest)
Assigns the specified routing profile to a user.
|
default CompletableFuture<UpdateUserRoutingProfileResponse> |
updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest)
Assigns the specified routing profile to a user.
|
default CompletableFuture<UpdateUserSecurityProfilesResponse> |
updateUserSecurityProfiles(Consumer<UpdateUserSecurityProfilesRequest.Builder> updateUserSecurityProfilesRequest)
Updates the security profiles assigned to the user.
|
default CompletableFuture<UpdateUserSecurityProfilesResponse> |
updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest)
Updates the security profiles assigned to the user.
|
serviceName
close
static final String SERVICE_NAME
static ConnectAsyncClient create()
ConnectAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ConnectAsyncClientBuilder builder()
ConnectAsyncClient
.default CompletableFuture<CreateUserResponse> createUser(CreateUserRequest createUserRequest)
Creates a new user account in your Amazon Connect instance.
createUserRequest
- default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a new user account in your Amazon Connect instance.
This is a convenience which creates an instance of the CreateUserRequest.Builder
avoiding the need to
create one manually via CreateUserRequest.builder()
createUserRequest
- A Consumer
that will call methods on CreateUserRequest.Builder
to create a request.default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user account from Amazon Connect.
deleteUserRequest
- default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes a user account from Amazon Connect.
This is a convenience which creates an instance of the DeleteUserRequest.Builder
avoiding the need to
create one manually via DeleteUserRequest.builder()
deleteUserRequest
- A Consumer
that will call methods on DeleteUserRequest.Builder
to create a request.default CompletableFuture<DescribeUserResponse> describeUser(DescribeUserRequest describeUserRequest)
Returns a User
object that contains information about the user account specified by the
UserId
.
describeUserRequest
- default CompletableFuture<DescribeUserResponse> describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Returns a User
object that contains information about the user account specified by the
UserId
.
This is a convenience which creates an instance of the DescribeUserRequest.Builder
avoiding the need to
create one manually via DescribeUserRequest.builder()
describeUserRequest
- A Consumer
that will call methods on DescribeUserRequest.Builder
to create a request.default CompletableFuture<DescribeUserHierarchyGroupResponse> describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest)
Returns a HierarchyGroup
object that includes information about a hierarchy group in your instance.
describeUserHierarchyGroupRequest
- default CompletableFuture<DescribeUserHierarchyGroupResponse> describeUserHierarchyGroup(Consumer<DescribeUserHierarchyGroupRequest.Builder> describeUserHierarchyGroupRequest)
Returns a HierarchyGroup
object that includes information about a hierarchy group in your instance.
This is a convenience which creates an instance of the DescribeUserHierarchyGroupRequest.Builder
avoiding
the need to create one manually via DescribeUserHierarchyGroupRequest.builder()
describeUserHierarchyGroupRequest
- A Consumer
that will call methods on DescribeUserHierarchyGroupRequest.Builder
to create a
request.default CompletableFuture<DescribeUserHierarchyStructureResponse> describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest)
Returns a HiearchyGroupStructure
object, which contains data about the levels in the agent
hierarchy.
describeUserHierarchyStructureRequest
- default CompletableFuture<DescribeUserHierarchyStructureResponse> describeUserHierarchyStructure(Consumer<DescribeUserHierarchyStructureRequest.Builder> describeUserHierarchyStructureRequest)
Returns a HiearchyGroupStructure
object, which contains data about the levels in the agent
hierarchy.
This is a convenience which creates an instance of the DescribeUserHierarchyStructureRequest.Builder
avoiding the need to create one manually via DescribeUserHierarchyStructureRequest.builder()
describeUserHierarchyStructureRequest
- A Consumer
that will call methods on DescribeUserHierarchyStructureRequest.Builder
to
create a request.default CompletableFuture<GetCurrentMetricDataResponse> 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
- default CompletableFuture<GetCurrentMetricDataResponse> getCurrentMetricData(Consumer<GetCurrentMetricDataRequest.Builder> 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.
This is a convenience which creates an instance of the GetCurrentMetricDataRequest.Builder
avoiding the
need to create one manually via GetCurrentMetricDataRequest.builder()
getCurrentMetricDataRequest
- A Consumer
that will call methods on GetCurrentMetricDataRequest.Builder
to create a
request.default GetCurrentMetricDataPublisher getCurrentMetricDataPaginator(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.
This is a variant of
getCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataPublisher publisher = client.getCurrentMetricDataPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataPublisher publisher = client.getCurrentMetricDataPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.GetCurrentMetricDataResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest)
operation.
getCurrentMetricDataRequest
- default GetCurrentMetricDataPublisher getCurrentMetricDataPaginator(Consumer<GetCurrentMetricDataRequest.Builder> 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.
This is a variant of
getCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataPublisher publisher = client.getCurrentMetricDataPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataPublisher publisher = client.getCurrentMetricDataPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.GetCurrentMetricDataResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest)
operation.
This is a convenience which creates an instance of the GetCurrentMetricDataRequest.Builder
avoiding the
need to create one manually via GetCurrentMetricDataRequest.builder()
getCurrentMetricDataRequest
- A Consumer
that will call methods on GetCurrentMetricDataRequest.Builder
to create a
request.default CompletableFuture<GetFederationTokenResponse> getFederationToken(GetFederationTokenRequest getFederationTokenRequest)
Retrieves a token for federation.
getFederationTokenRequest
- default CompletableFuture<GetFederationTokenResponse> getFederationToken(Consumer<GetFederationTokenRequest.Builder> getFederationTokenRequest)
Retrieves a token for federation.
This is a convenience which creates an instance of the GetFederationTokenRequest.Builder
avoiding the
need to create one manually via GetFederationTokenRequest.builder()
getFederationTokenRequest
- A Consumer
that will call methods on GetFederationTokenRequest.Builder
to create a
request.default CompletableFuture<GetMetricDataResponse> 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
- default CompletableFuture<GetMetricDataResponse> getMetricData(Consumer<GetMetricDataRequest.Builder> 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.
This is a convenience which creates an instance of the GetMetricDataRequest.Builder
avoiding the need to
create one manually via GetMetricDataRequest.builder()
getMetricDataRequest
- A Consumer
that will call methods on GetMetricDataRequest.Builder
to create a request.default GetMetricDataPublisher getMetricDataPaginator(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.
This is a variant of getMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.connect.paginators.GetMetricDataPublisher publisher = client.getMetricDataPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.connect.paginators.GetMetricDataPublisher publisher = client.getMetricDataPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.GetMetricDataResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.connect.model.GetMetricDataResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest)
operation.
getMetricDataRequest
- default GetMetricDataPublisher getMetricDataPaginator(Consumer<GetMetricDataRequest.Builder> 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.
This is a variant of getMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.connect.paginators.GetMetricDataPublisher publisher = client.getMetricDataPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.connect.paginators.GetMetricDataPublisher publisher = client.getMetricDataPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.GetMetricDataResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.connect.model.GetMetricDataResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest)
operation.
This is a convenience which creates an instance of the GetMetricDataRequest.Builder
avoiding the need to
create one manually via GetMetricDataRequest.builder()
getMetricDataRequest
- A Consumer
that will call methods on GetMetricDataRequest.Builder
to create a request.default CompletableFuture<ListRoutingProfilesResponse> listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest)
Returns an array of RoutingProfileSummary
objects that includes information about the routing
profiles in your instance.
listRoutingProfilesRequest
- default CompletableFuture<ListRoutingProfilesResponse> listRoutingProfiles(Consumer<ListRoutingProfilesRequest.Builder> listRoutingProfilesRequest)
Returns an array of RoutingProfileSummary
objects that includes information about the routing
profiles in your instance.
This is a convenience which creates an instance of the ListRoutingProfilesRequest.Builder
avoiding the
need to create one manually via ListRoutingProfilesRequest.builder()
listRoutingProfilesRequest
- A Consumer
that will call methods on ListRoutingProfilesRequest.Builder
to create a
request.default CompletableFuture<ListSecurityProfilesResponse> 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
- default CompletableFuture<ListSecurityProfilesResponse> listSecurityProfiles(Consumer<ListSecurityProfilesRequest.Builder> 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.
This is a convenience which creates an instance of the ListSecurityProfilesRequest.Builder
avoiding the
need to create one manually via ListSecurityProfilesRequest.builder()
listSecurityProfilesRequest
- A Consumer
that will call methods on ListSecurityProfilesRequest.Builder
to create a
request.default CompletableFuture<ListUserHierarchyGroupsResponse> listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)
Returns a UserHierarchyGroupSummaryList
, which is an array of HierarchyGroupSummary
objects that contain information about the hierarchy groups in your instance.
listUserHierarchyGroupsRequest
- default CompletableFuture<ListUserHierarchyGroupsResponse> listUserHierarchyGroups(Consumer<ListUserHierarchyGroupsRequest.Builder> listUserHierarchyGroupsRequest)
Returns a UserHierarchyGroupSummaryList
, which is an array of HierarchyGroupSummary
objects that contain information about the hierarchy groups in your instance.
This is a convenience which creates an instance of the ListUserHierarchyGroupsRequest.Builder
avoiding
the need to create one manually via ListUserHierarchyGroupsRequest.builder()
listUserHierarchyGroupsRequest
- A Consumer
that will call methods on ListUserHierarchyGroupsRequest.Builder
to create a
request.default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest)
Returns a UserSummaryList
, which is an array of UserSummary
objects.
listUsersRequest
- default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Returns a UserSummaryList
, which is an array of UserSummary
objects.
This is a convenience which creates an instance of the ListUsersRequest.Builder
avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest
- A Consumer
that will call methods on ListUsersRequest.Builder
to create a request.default CompletableFuture<StartOutboundVoiceContactResponse> 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.
startOutboundVoiceContactRequest
- default CompletableFuture<StartOutboundVoiceContactResponse> startOutboundVoiceContact(Consumer<StartOutboundVoiceContactRequest.Builder> 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.
This is a convenience which creates an instance of the StartOutboundVoiceContactRequest.Builder
avoiding
the need to create one manually via StartOutboundVoiceContactRequest.builder()
startOutboundVoiceContactRequest
- A Consumer
that will call methods on StartOutboundVoiceContactRequest.Builder
to create a
request.default CompletableFuture<StopContactResponse> 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
- default CompletableFuture<StopContactResponse> stopContact(Consumer<StopContactRequest.Builder> 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.
This is a convenience which creates an instance of the StopContactRequest.Builder
avoiding the need to
create one manually via StopContactRequest.builder()
stopContactRequest
- A Consumer
that will call methods on StopContactRequest.Builder
to create a request.default CompletableFuture<UpdateContactAttributesResponse> 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
- default CompletableFuture<UpdateContactAttributesResponse> updateContactAttributes(Consumer<UpdateContactAttributesRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateContactAttributesRequest.Builder
avoiding
the need to create one manually via UpdateContactAttributesRequest.builder()
updateContactAttributesRequest
- A Consumer
that will call methods on UpdateContactAttributesRequest.Builder
to create a
request.default CompletableFuture<UpdateUserHierarchyResponse> updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest)
Assigns the specified hierarchy group to the user.
updateUserHierarchyRequest
- default CompletableFuture<UpdateUserHierarchyResponse> updateUserHierarchy(Consumer<UpdateUserHierarchyRequest.Builder> updateUserHierarchyRequest)
Assigns the specified hierarchy group to the user.
This is a convenience which creates an instance of the UpdateUserHierarchyRequest.Builder
avoiding the
need to create one manually via UpdateUserHierarchyRequest.builder()
updateUserHierarchyRequest
- A Consumer
that will call methods on UpdateUserHierarchyRequest.Builder
to create a
request.default CompletableFuture<UpdateUserIdentityInfoResponse> updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest)
Updates the identity information for the specified user in a UserIdentityInfo
object, including
email, first name, and last name.
updateUserIdentityInfoRequest
- default CompletableFuture<UpdateUserIdentityInfoResponse> updateUserIdentityInfo(Consumer<UpdateUserIdentityInfoRequest.Builder> updateUserIdentityInfoRequest)
Updates the identity information for the specified user in a UserIdentityInfo
object, including
email, first name, and last name.
This is a convenience which creates an instance of the UpdateUserIdentityInfoRequest.Builder
avoiding the
need to create one manually via UpdateUserIdentityInfoRequest.builder()
updateUserIdentityInfoRequest
- A Consumer
that will call methods on UpdateUserIdentityInfoRequest.Builder
to create a
request.default CompletableFuture<UpdateUserPhoneConfigResponse> updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest)
Updates the phone configuration settings in the UserPhoneConfig
object for the specified user.
updateUserPhoneConfigRequest
- default CompletableFuture<UpdateUserPhoneConfigResponse> updateUserPhoneConfig(Consumer<UpdateUserPhoneConfigRequest.Builder> updateUserPhoneConfigRequest)
Updates the phone configuration settings in the UserPhoneConfig
object for the specified user.
This is a convenience which creates an instance of the UpdateUserPhoneConfigRequest.Builder
avoiding the
need to create one manually via UpdateUserPhoneConfigRequest.builder()
updateUserPhoneConfigRequest
- A Consumer
that will call methods on UpdateUserPhoneConfigRequest.Builder
to create a
request.default CompletableFuture<UpdateUserRoutingProfileResponse> updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest)
Assigns the specified routing profile to a user.
updateUserRoutingProfileRequest
- default CompletableFuture<UpdateUserRoutingProfileResponse> updateUserRoutingProfile(Consumer<UpdateUserRoutingProfileRequest.Builder> updateUserRoutingProfileRequest)
Assigns the specified routing profile to a user.
This is a convenience which creates an instance of the UpdateUserRoutingProfileRequest.Builder
avoiding
the need to create one manually via UpdateUserRoutingProfileRequest.builder()
updateUserRoutingProfileRequest
- A Consumer
that will call methods on UpdateUserRoutingProfileRequest.Builder
to create a
request.default CompletableFuture<UpdateUserSecurityProfilesResponse> updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest)
Updates the security profiles assigned to the user.
updateUserSecurityProfilesRequest
- default CompletableFuture<UpdateUserSecurityProfilesResponse> updateUserSecurityProfiles(Consumer<UpdateUserSecurityProfilesRequest.Builder> updateUserSecurityProfilesRequest)
Updates the security profiles assigned to the user.
This is a convenience which creates an instance of the UpdateUserSecurityProfilesRequest.Builder
avoiding
the need to create one manually via UpdateUserSecurityProfilesRequest.builder()
updateUserSecurityProfilesRequest
- A Consumer
that will call methods on UpdateUserSecurityProfilesRequest.Builder
to create a
request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.