@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface ChimeSdkIdentityAsyncClient extends AwsClient
builder() method.
The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications. These APIs provide the overarching framework for creating and sending messages. For more information about the identity APIs, refer to Amazon Chime SDK identity.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CreateAppInstanceResponse> createAppInstance(CreateAppInstanceRequest createAppInstanceRequest)
Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers
use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.
identity
createAppInstanceRequest - default CompletableFuture<CreateAppInstanceResponse> createAppInstance(Consumer<CreateAppInstanceRequest.Builder> createAppInstanceRequest)
Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers
use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.
identity
This is a convenience which creates an instance of the CreateAppInstanceRequest.Builder avoiding the need
to create one manually via CreateAppInstanceRequest.builder()
createAppInstanceRequest - A Consumer that will call methods on
CreateAppInstanceRequest.Builder to create
a request.default CompletableFuture<CreateAppInstanceAdminResponse> createAppInstanceAdmin(CreateAppInstanceAdminRequest createAppInstanceAdminRequest)
Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The
promoted entity can perform the following actions.
ChannelModerator actions across all channels in the AppInstance.
DeleteChannelMessage actions.
Only an AppInstanceUser and AppInstanceBot can be promoted to an
AppInstanceAdmin role.
createAppInstanceAdminRequest - default CompletableFuture<CreateAppInstanceAdminResponse> createAppInstanceAdmin(Consumer<CreateAppInstanceAdminRequest.Builder> createAppInstanceAdminRequest)
Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The
promoted entity can perform the following actions.
ChannelModerator actions across all channels in the AppInstance.
DeleteChannelMessage actions.
Only an AppInstanceUser and AppInstanceBot can be promoted to an
AppInstanceAdmin role.
This is a convenience which creates an instance of the CreateAppInstanceAdminRequest.Builder avoiding the
need to create one manually via CreateAppInstanceAdminRequest.builder()
createAppInstanceAdminRequest - A Consumer that will call methods on
CreateAppInstanceAdminRequest.Builder to
create a request.default CompletableFuture<CreateAppInstanceBotResponse> createAppInstanceBot(CreateAppInstanceBotRequest createAppInstanceBotRequest)
Creates a bot under an Amazon Chime AppInstance. The request consists of a unique
Configuration and Name for that bot.
createAppInstanceBotRequest - default CompletableFuture<CreateAppInstanceBotResponse> createAppInstanceBot(Consumer<CreateAppInstanceBotRequest.Builder> createAppInstanceBotRequest)
Creates a bot under an Amazon Chime AppInstance. The request consists of a unique
Configuration and Name for that bot.
This is a convenience which creates an instance of the CreateAppInstanceBotRequest.Builder avoiding the
need to create one manually via CreateAppInstanceBotRequest.builder()
createAppInstanceBotRequest - A Consumer that will call methods on
CreateAppInstanceBotRequest.Builder to
create a request.default CompletableFuture<CreateAppInstanceUserResponse> createAppInstanceUser(CreateAppInstanceUserRequest createAppInstanceUserRequest)
Creates a user under an Amazon Chime AppInstance. The request consists of a unique
appInstanceUserId and Name for that user.
createAppInstanceUserRequest - default CompletableFuture<CreateAppInstanceUserResponse> createAppInstanceUser(Consumer<CreateAppInstanceUserRequest.Builder> createAppInstanceUserRequest)
Creates a user under an Amazon Chime AppInstance. The request consists of a unique
appInstanceUserId and Name for that user.
This is a convenience which creates an instance of the CreateAppInstanceUserRequest.Builder avoiding the
need to create one manually via CreateAppInstanceUserRequest.builder()
createAppInstanceUserRequest - A Consumer that will call methods on
CreateAppInstanceUserRequest.Builder to
create a request.default CompletableFuture<DeleteAppInstanceResponse> deleteAppInstance(DeleteAppInstanceRequest deleteAppInstanceRequest)
Deletes an AppInstance and all associated data asynchronously.
deleteAppInstanceRequest - default CompletableFuture<DeleteAppInstanceResponse> deleteAppInstance(Consumer<DeleteAppInstanceRequest.Builder> deleteAppInstanceRequest)
Deletes an AppInstance and all associated data asynchronously.
This is a convenience which creates an instance of the DeleteAppInstanceRequest.Builder avoiding the need
to create one manually via DeleteAppInstanceRequest.builder()
deleteAppInstanceRequest - A Consumer that will call methods on
DeleteAppInstanceRequest.Builder to create
a request.default CompletableFuture<DeleteAppInstanceAdminResponse> deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest deleteAppInstanceAdminRequest)
Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot. This
action does not delete the user.
deleteAppInstanceAdminRequest - default CompletableFuture<DeleteAppInstanceAdminResponse> deleteAppInstanceAdmin(Consumer<DeleteAppInstanceAdminRequest.Builder> deleteAppInstanceAdminRequest)
Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot. This
action does not delete the user.
This is a convenience which creates an instance of the DeleteAppInstanceAdminRequest.Builder avoiding the
need to create one manually via DeleteAppInstanceAdminRequest.builder()
deleteAppInstanceAdminRequest - A Consumer that will call methods on
DeleteAppInstanceAdminRequest.Builder to
create a request.default CompletableFuture<DeleteAppInstanceBotResponse> deleteAppInstanceBot(DeleteAppInstanceBotRequest deleteAppInstanceBotRequest)
Deletes an AppInstanceBot.
deleteAppInstanceBotRequest - default CompletableFuture<DeleteAppInstanceBotResponse> deleteAppInstanceBot(Consumer<DeleteAppInstanceBotRequest.Builder> deleteAppInstanceBotRequest)
Deletes an AppInstanceBot.
This is a convenience which creates an instance of the DeleteAppInstanceBotRequest.Builder avoiding the
need to create one manually via DeleteAppInstanceBotRequest.builder()
deleteAppInstanceBotRequest - A Consumer that will call methods on
DeleteAppInstanceBotRequest.Builder to
create a request.default CompletableFuture<DeleteAppInstanceUserResponse> deleteAppInstanceUser(DeleteAppInstanceUserRequest deleteAppInstanceUserRequest)
Deletes an AppInstanceUser.
deleteAppInstanceUserRequest - default CompletableFuture<DeleteAppInstanceUserResponse> deleteAppInstanceUser(Consumer<DeleteAppInstanceUserRequest.Builder> deleteAppInstanceUserRequest)
Deletes an AppInstanceUser.
This is a convenience which creates an instance of the DeleteAppInstanceUserRequest.Builder avoiding the
need to create one manually via DeleteAppInstanceUserRequest.builder()
deleteAppInstanceUserRequest - A Consumer that will call methods on
DeleteAppInstanceUserRequest.Builder to
create a request.default CompletableFuture<DeregisterAppInstanceUserEndpointResponse> deregisterAppInstanceUserEndpoint(DeregisterAppInstanceUserEndpointRequest deregisterAppInstanceUserEndpointRequest)
Deregisters an AppInstanceUserEndpoint.
deregisterAppInstanceUserEndpointRequest - default CompletableFuture<DeregisterAppInstanceUserEndpointResponse> deregisterAppInstanceUserEndpoint(Consumer<DeregisterAppInstanceUserEndpointRequest.Builder> deregisterAppInstanceUserEndpointRequest)
Deregisters an AppInstanceUserEndpoint.
This is a convenience which creates an instance of the DeregisterAppInstanceUserEndpointRequest.Builder
avoiding the need to create one manually via DeregisterAppInstanceUserEndpointRequest.builder()
deregisterAppInstanceUserEndpointRequest - A Consumer that will call methods on
DeregisterAppInstanceUserEndpointRequest.Builder
to create a request.default CompletableFuture<DescribeAppInstanceResponse> describeAppInstance(DescribeAppInstanceRequest describeAppInstanceRequest)
Returns the full details of an AppInstance.
describeAppInstanceRequest - default CompletableFuture<DescribeAppInstanceResponse> describeAppInstance(Consumer<DescribeAppInstanceRequest.Builder> describeAppInstanceRequest)
Returns the full details of an AppInstance.
This is a convenience which creates an instance of the DescribeAppInstanceRequest.Builder avoiding the
need to create one manually via DescribeAppInstanceRequest.builder()
describeAppInstanceRequest - A Consumer that will call methods on
DescribeAppInstanceRequest.Builder to
create a request.default CompletableFuture<DescribeAppInstanceAdminResponse> describeAppInstanceAdmin(DescribeAppInstanceAdminRequest describeAppInstanceAdminRequest)
Returns the full details of an AppInstanceAdmin.
describeAppInstanceAdminRequest - default CompletableFuture<DescribeAppInstanceAdminResponse> describeAppInstanceAdmin(Consumer<DescribeAppInstanceAdminRequest.Builder> describeAppInstanceAdminRequest)
Returns the full details of an AppInstanceAdmin.
This is a convenience which creates an instance of the DescribeAppInstanceAdminRequest.Builder avoiding
the need to create one manually via DescribeAppInstanceAdminRequest.builder()
describeAppInstanceAdminRequest - A Consumer that will call methods on
DescribeAppInstanceAdminRequest.Builder to
create a request.default CompletableFuture<DescribeAppInstanceBotResponse> describeAppInstanceBot(DescribeAppInstanceBotRequest describeAppInstanceBotRequest)
The AppInstanceBot's information.
describeAppInstanceBotRequest - default CompletableFuture<DescribeAppInstanceBotResponse> describeAppInstanceBot(Consumer<DescribeAppInstanceBotRequest.Builder> describeAppInstanceBotRequest)
The AppInstanceBot's information.
This is a convenience which creates an instance of the DescribeAppInstanceBotRequest.Builder avoiding the
need to create one manually via DescribeAppInstanceBotRequest.builder()
describeAppInstanceBotRequest - A Consumer that will call methods on
DescribeAppInstanceBotRequest.Builder to
create a request.default CompletableFuture<DescribeAppInstanceUserResponse> describeAppInstanceUser(DescribeAppInstanceUserRequest describeAppInstanceUserRequest)
Returns the full details of an AppInstanceUser.
describeAppInstanceUserRequest - default CompletableFuture<DescribeAppInstanceUserResponse> describeAppInstanceUser(Consumer<DescribeAppInstanceUserRequest.Builder> describeAppInstanceUserRequest)
Returns the full details of an AppInstanceUser.
This is a convenience which creates an instance of the DescribeAppInstanceUserRequest.Builder avoiding
the need to create one manually via DescribeAppInstanceUserRequest.builder()
describeAppInstanceUserRequest - A Consumer that will call methods on
DescribeAppInstanceUserRequest.Builder to
create a request.default CompletableFuture<DescribeAppInstanceUserEndpointResponse> describeAppInstanceUserEndpoint(DescribeAppInstanceUserEndpointRequest describeAppInstanceUserEndpointRequest)
Returns the full details of an AppInstanceUserEndpoint.
describeAppInstanceUserEndpointRequest - default CompletableFuture<DescribeAppInstanceUserEndpointResponse> describeAppInstanceUserEndpoint(Consumer<DescribeAppInstanceUserEndpointRequest.Builder> describeAppInstanceUserEndpointRequest)
Returns the full details of an AppInstanceUserEndpoint.
This is a convenience which creates an instance of the DescribeAppInstanceUserEndpointRequest.Builder
avoiding the need to create one manually via DescribeAppInstanceUserEndpointRequest.builder()
describeAppInstanceUserEndpointRequest - A Consumer that will call methods on
DescribeAppInstanceUserEndpointRequest.Builder
to create a request.default CompletableFuture<GetAppInstanceRetentionSettingsResponse> getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest getAppInstanceRetentionSettingsRequest)
Gets the retention settings for an AppInstance.
getAppInstanceRetentionSettingsRequest - default CompletableFuture<GetAppInstanceRetentionSettingsResponse> getAppInstanceRetentionSettings(Consumer<GetAppInstanceRetentionSettingsRequest.Builder> getAppInstanceRetentionSettingsRequest)
Gets the retention settings for an AppInstance.
This is a convenience which creates an instance of the GetAppInstanceRetentionSettingsRequest.Builder
avoiding the need to create one manually via GetAppInstanceRetentionSettingsRequest.builder()
getAppInstanceRetentionSettingsRequest - A Consumer that will call methods on
GetAppInstanceRetentionSettingsRequest.Builder
to create a request.default CompletableFuture<ListAppInstanceAdminsResponse> listAppInstanceAdmins(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest)
Returns a list of the administrators in the AppInstance.
listAppInstanceAdminsRequest - default CompletableFuture<ListAppInstanceAdminsResponse> listAppInstanceAdmins(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest)
Returns a list of the administrators in the AppInstance.
This is a convenience which creates an instance of the ListAppInstanceAdminsRequest.Builder avoiding the
need to create one manually via ListAppInstanceAdminsRequest.builder()
listAppInstanceAdminsRequest - A Consumer that will call methods on
ListAppInstanceAdminsRequest.Builder to
create a request.default ListAppInstanceAdminsPublisher listAppInstanceAdminsPaginator(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest)
Returns a list of the administrators in the AppInstance.
This is a variant of
listAppInstanceAdmins(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsRequest)
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.chimesdkidentity.paginators.ListAppInstanceAdminsPublisher publisher = client.listAppInstanceAdminsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceAdminsPublisher publisher = client.listAppInstanceAdminsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceAdmins(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsRequest)
operation.
listAppInstanceAdminsRequest - default ListAppInstanceAdminsPublisher listAppInstanceAdminsPaginator(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest)
Returns a list of the administrators in the AppInstance.
This is a variant of
listAppInstanceAdmins(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsRequest)
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.chimesdkidentity.paginators.ListAppInstanceAdminsPublisher publisher = client.listAppInstanceAdminsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceAdminsPublisher publisher = client.listAppInstanceAdminsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceAdmins(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsRequest)
operation.
This is a convenience which creates an instance of the ListAppInstanceAdminsRequest.Builder avoiding the
need to create one manually via ListAppInstanceAdminsRequest.builder()
listAppInstanceAdminsRequest - A Consumer that will call methods on
ListAppInstanceAdminsRequest.Builder to
create a request.default CompletableFuture<ListAppInstanceBotsResponse> listAppInstanceBots(ListAppInstanceBotsRequest listAppInstanceBotsRequest)
Lists all AppInstanceBots created under a single AppInstance.
listAppInstanceBotsRequest - default CompletableFuture<ListAppInstanceBotsResponse> listAppInstanceBots(Consumer<ListAppInstanceBotsRequest.Builder> listAppInstanceBotsRequest)
Lists all AppInstanceBots created under a single AppInstance.
This is a convenience which creates an instance of the ListAppInstanceBotsRequest.Builder avoiding the
need to create one manually via ListAppInstanceBotsRequest.builder()
listAppInstanceBotsRequest - A Consumer that will call methods on
ListAppInstanceBotsRequest.Builder to
create a request.default ListAppInstanceBotsPublisher listAppInstanceBotsPaginator(ListAppInstanceBotsRequest listAppInstanceBotsRequest)
Lists all AppInstanceBots created under a single AppInstance.
This is a variant of
listAppInstanceBots(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsRequest)
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.chimesdkidentity.paginators.ListAppInstanceBotsPublisher publisher = client.listAppInstanceBotsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceBotsPublisher publisher = client.listAppInstanceBotsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceBots(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsRequest)
operation.
listAppInstanceBotsRequest - default ListAppInstanceBotsPublisher listAppInstanceBotsPaginator(Consumer<ListAppInstanceBotsRequest.Builder> listAppInstanceBotsRequest)
Lists all AppInstanceBots created under a single AppInstance.
This is a variant of
listAppInstanceBots(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsRequest)
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.chimesdkidentity.paginators.ListAppInstanceBotsPublisher publisher = client.listAppInstanceBotsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceBotsPublisher publisher = client.listAppInstanceBotsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceBots(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsRequest)
operation.
This is a convenience which creates an instance of the ListAppInstanceBotsRequest.Builder avoiding the
need to create one manually via ListAppInstanceBotsRequest.builder()
listAppInstanceBotsRequest - A Consumer that will call methods on
ListAppInstanceBotsRequest.Builder to
create a request.default CompletableFuture<ListAppInstanceUserEndpointsResponse> listAppInstanceUserEndpoints(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest)
Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
listAppInstanceUserEndpointsRequest - default CompletableFuture<ListAppInstanceUserEndpointsResponse> listAppInstanceUserEndpoints(Consumer<ListAppInstanceUserEndpointsRequest.Builder> listAppInstanceUserEndpointsRequest)
Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
This is a convenience which creates an instance of the ListAppInstanceUserEndpointsRequest.Builder
avoiding the need to create one manually via ListAppInstanceUserEndpointsRequest.builder()
listAppInstanceUserEndpointsRequest - A Consumer that will call methods on
ListAppInstanceUserEndpointsRequest.Builder
to create a request.default ListAppInstanceUserEndpointsPublisher listAppInstanceUserEndpointsPaginator(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest)
Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
This is a variant of
listAppInstanceUserEndpoints(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsRequest)
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.chimesdkidentity.paginators.ListAppInstanceUserEndpointsPublisher publisher = client.listAppInstanceUserEndpointsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUserEndpointsPublisher publisher = client.listAppInstanceUserEndpointsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceUserEndpoints(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsRequest)
operation.
listAppInstanceUserEndpointsRequest - default ListAppInstanceUserEndpointsPublisher listAppInstanceUserEndpointsPaginator(Consumer<ListAppInstanceUserEndpointsRequest.Builder> listAppInstanceUserEndpointsRequest)
Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
This is a variant of
listAppInstanceUserEndpoints(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsRequest)
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.chimesdkidentity.paginators.ListAppInstanceUserEndpointsPublisher publisher = client.listAppInstanceUserEndpointsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUserEndpointsPublisher publisher = client.listAppInstanceUserEndpointsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceUserEndpoints(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsRequest)
operation.
This is a convenience which creates an instance of the ListAppInstanceUserEndpointsRequest.Builder
avoiding the need to create one manually via ListAppInstanceUserEndpointsRequest.builder()
listAppInstanceUserEndpointsRequest - A Consumer that will call methods on
ListAppInstanceUserEndpointsRequest.Builder
to create a request.default CompletableFuture<ListAppInstanceUsersResponse> listAppInstanceUsers(ListAppInstanceUsersRequest listAppInstanceUsersRequest)
List all AppInstanceUsers created under a single AppInstance.
listAppInstanceUsersRequest - default CompletableFuture<ListAppInstanceUsersResponse> listAppInstanceUsers(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest)
List all AppInstanceUsers created under a single AppInstance.
This is a convenience which creates an instance of the ListAppInstanceUsersRequest.Builder avoiding the
need to create one manually via ListAppInstanceUsersRequest.builder()
listAppInstanceUsersRequest - A Consumer that will call methods on
ListAppInstanceUsersRequest.Builder to
create a request.default ListAppInstanceUsersPublisher listAppInstanceUsersPaginator(ListAppInstanceUsersRequest listAppInstanceUsersRequest)
List all AppInstanceUsers created under a single AppInstance.
This is a variant of
listAppInstanceUsers(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersRequest)
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.chimesdkidentity.paginators.ListAppInstanceUsersPublisher publisher = client.listAppInstanceUsersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUsersPublisher publisher = client.listAppInstanceUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceUsers(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersRequest)
operation.
listAppInstanceUsersRequest - default ListAppInstanceUsersPublisher listAppInstanceUsersPaginator(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest)
List all AppInstanceUsers created under a single AppInstance.
This is a variant of
listAppInstanceUsers(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersRequest)
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.chimesdkidentity.paginators.ListAppInstanceUsersPublisher publisher = client.listAppInstanceUsersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUsersPublisher publisher = client.listAppInstanceUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceUsers(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersRequest)
operation.
This is a convenience which creates an instance of the ListAppInstanceUsersRequest.Builder avoiding the
need to create one manually via ListAppInstanceUsersRequest.builder()
listAppInstanceUsersRequest - A Consumer that will call methods on
ListAppInstanceUsersRequest.Builder to
create a request.default CompletableFuture<ListAppInstancesResponse> listAppInstances(ListAppInstancesRequest listAppInstancesRequest)
Lists all Amazon Chime AppInstances created under a single AWS account.
listAppInstancesRequest - default CompletableFuture<ListAppInstancesResponse> listAppInstances(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest)
Lists all Amazon Chime AppInstances created under a single AWS account.
This is a convenience which creates an instance of the ListAppInstancesRequest.Builder avoiding the need
to create one manually via ListAppInstancesRequest.builder()
listAppInstancesRequest - A Consumer that will call methods on
ListAppInstancesRequest.Builder to create a
request.default ListAppInstancesPublisher listAppInstancesPaginator(ListAppInstancesRequest listAppInstancesRequest)
Lists all Amazon Chime AppInstances created under a single AWS account.
This is a variant of
listAppInstances(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesRequest)
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.chimesdkidentity.paginators.ListAppInstancesPublisher publisher = client.listAppInstancesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstancesPublisher publisher = client.listAppInstancesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstances(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesRequest)
operation.
listAppInstancesRequest - default ListAppInstancesPublisher listAppInstancesPaginator(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest)
Lists all Amazon Chime AppInstances created under a single AWS account.
This is a variant of
listAppInstances(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesRequest)
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.chimesdkidentity.paginators.ListAppInstancesPublisher publisher = client.listAppInstancesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstancesPublisher publisher = client.listAppInstancesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstances(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesRequest)
operation.
This is a convenience which creates an instance of the ListAppInstancesRequest.Builder avoiding the need
to create one manually via ListAppInstancesRequest.builder()
listAppInstancesRequest - A Consumer that will call methods on
ListAppInstancesRequest.Builder to create a
request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags applied to an Amazon Chime SDK identity resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags applied to an Amazon Chime SDK identity resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to
create a request.default CompletableFuture<PutAppInstanceRetentionSettingsResponse> putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest putAppInstanceRetentionSettingsRequest)
Sets the amount of time in days that a given AppInstance retains data.
putAppInstanceRetentionSettingsRequest - default CompletableFuture<PutAppInstanceRetentionSettingsResponse> putAppInstanceRetentionSettings(Consumer<PutAppInstanceRetentionSettingsRequest.Builder> putAppInstanceRetentionSettingsRequest)
Sets the amount of time in days that a given AppInstance retains data.
This is a convenience which creates an instance of the PutAppInstanceRetentionSettingsRequest.Builder
avoiding the need to create one manually via PutAppInstanceRetentionSettingsRequest.builder()
putAppInstanceRetentionSettingsRequest - A Consumer that will call methods on
PutAppInstanceRetentionSettingsRequest.Builder
to create a request.default CompletableFuture<PutAppInstanceUserExpirationSettingsResponse> putAppInstanceUserExpirationSettings(PutAppInstanceUserExpirationSettingsRequest putAppInstanceUserExpirationSettingsRequest)
Sets the number of days before the AppInstanceUser is automatically deleted.
A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion
times may vary.
Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their
expiration settings. The system honors the new settings.
putAppInstanceUserExpirationSettingsRequest - default CompletableFuture<PutAppInstanceUserExpirationSettingsResponse> putAppInstanceUserExpirationSettings(Consumer<PutAppInstanceUserExpirationSettingsRequest.Builder> putAppInstanceUserExpirationSettingsRequest)
Sets the number of days before the AppInstanceUser is automatically deleted.
A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion
times may vary.
Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their
expiration settings. The system honors the new settings.
This is a convenience which creates an instance of the
PutAppInstanceUserExpirationSettingsRequest.Builder avoiding the need to create one manually via
PutAppInstanceUserExpirationSettingsRequest.builder()
putAppInstanceUserExpirationSettingsRequest - A Consumer that will call methods on
PutAppInstanceUserExpirationSettingsRequest.Builder
to create a request.default CompletableFuture<RegisterAppInstanceUserEndpointResponse> registerAppInstanceUserEndpoint(RegisterAppInstanceUserEndpointRequest registerAppInstanceUserEndpointRequest)
Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for a
user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a
user.
registerAppInstanceUserEndpointRequest - default CompletableFuture<RegisterAppInstanceUserEndpointResponse> registerAppInstanceUserEndpoint(Consumer<RegisterAppInstanceUserEndpointRequest.Builder> registerAppInstanceUserEndpointRequest)
Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for a
user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a
user.
This is a convenience which creates an instance of the RegisterAppInstanceUserEndpointRequest.Builder
avoiding the need to create one manually via RegisterAppInstanceUserEndpointRequest.builder()
registerAppInstanceUserEndpointRequest - A Consumer that will call methods on
RegisterAppInstanceUserEndpointRequest.Builder
to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Applies the specified tags to the specified Amazon Chime SDK identity resource.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Applies the specified tags to the specified Amazon Chime SDK identity resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a
request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified Amazon Chime SDK identity resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the specified tags from the specified Amazon Chime SDK identity resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a
request.default CompletableFuture<UpdateAppInstanceResponse> updateAppInstance(UpdateAppInstanceRequest updateAppInstanceRequest)
Updates AppInstance metadata.
updateAppInstanceRequest - default CompletableFuture<UpdateAppInstanceResponse> updateAppInstance(Consumer<UpdateAppInstanceRequest.Builder> updateAppInstanceRequest)
Updates AppInstance metadata.
This is a convenience which creates an instance of the UpdateAppInstanceRequest.Builder avoiding the need
to create one manually via UpdateAppInstanceRequest.builder()
updateAppInstanceRequest - A Consumer that will call methods on
UpdateAppInstanceRequest.Builder to create
a request.default CompletableFuture<UpdateAppInstanceBotResponse> updateAppInstanceBot(UpdateAppInstanceBotRequest updateAppInstanceBotRequest)
Updates the name and metadata of an AppInstanceBot.
updateAppInstanceBotRequest - default CompletableFuture<UpdateAppInstanceBotResponse> updateAppInstanceBot(Consumer<UpdateAppInstanceBotRequest.Builder> updateAppInstanceBotRequest)
Updates the name and metadata of an AppInstanceBot.
This is a convenience which creates an instance of the UpdateAppInstanceBotRequest.Builder avoiding the
need to create one manually via UpdateAppInstanceBotRequest.builder()
updateAppInstanceBotRequest - A Consumer that will call methods on
UpdateAppInstanceBotRequest.Builder to
create a request.default CompletableFuture<UpdateAppInstanceUserResponse> updateAppInstanceUser(UpdateAppInstanceUserRequest updateAppInstanceUserRequest)
Updates the details of an AppInstanceUser. You can update names and metadata.
updateAppInstanceUserRequest - default CompletableFuture<UpdateAppInstanceUserResponse> updateAppInstanceUser(Consumer<UpdateAppInstanceUserRequest.Builder> updateAppInstanceUserRequest)
Updates the details of an AppInstanceUser. You can update names and metadata.
This is a convenience which creates an instance of the UpdateAppInstanceUserRequest.Builder avoiding the
need to create one manually via UpdateAppInstanceUserRequest.builder()
updateAppInstanceUserRequest - A Consumer that will call methods on
UpdateAppInstanceUserRequest.Builder to
create a request.default CompletableFuture<UpdateAppInstanceUserEndpointResponse> updateAppInstanceUserEndpoint(UpdateAppInstanceUserEndpointRequest updateAppInstanceUserEndpointRequest)
Updates the details of an AppInstanceUserEndpoint. You can update the name and
AllowMessage values.
updateAppInstanceUserEndpointRequest - default CompletableFuture<UpdateAppInstanceUserEndpointResponse> updateAppInstanceUserEndpoint(Consumer<UpdateAppInstanceUserEndpointRequest.Builder> updateAppInstanceUserEndpointRequest)
Updates the details of an AppInstanceUserEndpoint. You can update the name and
AllowMessage values.
This is a convenience which creates an instance of the UpdateAppInstanceUserEndpointRequest.Builder
avoiding the need to create one manually via UpdateAppInstanceUserEndpointRequest.builder()
updateAppInstanceUserEndpointRequest - A Consumer that will call methods on
UpdateAppInstanceUserEndpointRequest.Builder
to create a request.default ChimeSdkIdentityServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic ChimeSdkIdentityAsyncClient create()
ChimeSdkIdentityAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ChimeSdkIdentityAsyncClientBuilder builder()
ChimeSdkIdentityAsyncClient.Copyright © 2023. All rights reserved.