Interface ChimeSdkIdentityAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Create a builder that can be used to configure and create aChimeSdkIdentityAsyncClient.static ChimeSdkIdentityAsyncClientcreate()Create aChimeSdkIdentityAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createAppInstance(Consumer<CreateAppInstanceRequest.Builder> createAppInstanceRequest) Creates an Amazon Chime SDK messagingAppInstanceunder an AWS account.createAppInstance(CreateAppInstanceRequest createAppInstanceRequest) Creates an Amazon Chime SDK messagingAppInstanceunder an AWS account.createAppInstanceAdmin(Consumer<CreateAppInstanceAdminRequest.Builder> createAppInstanceAdminRequest) Promotes anAppInstanceUserorAppInstanceBotto anAppInstanceAdmin.createAppInstanceAdmin(CreateAppInstanceAdminRequest createAppInstanceAdminRequest) Promotes anAppInstanceUserorAppInstanceBotto anAppInstanceAdmin.createAppInstanceBot(Consumer<CreateAppInstanceBotRequest.Builder> createAppInstanceBotRequest) Creates a bot under an Amazon ChimeAppInstance.createAppInstanceBot(CreateAppInstanceBotRequest createAppInstanceBotRequest) Creates a bot under an Amazon ChimeAppInstance.createAppInstanceUser(Consumer<CreateAppInstanceUserRequest.Builder> createAppInstanceUserRequest) Creates a user under an Amazon ChimeAppInstance.createAppInstanceUser(CreateAppInstanceUserRequest createAppInstanceUserRequest) Creates a user under an Amazon ChimeAppInstance.deleteAppInstance(Consumer<DeleteAppInstanceRequest.Builder> deleteAppInstanceRequest) Deletes anAppInstanceand all associated data asynchronously.deleteAppInstance(DeleteAppInstanceRequest deleteAppInstanceRequest) Deletes anAppInstanceand all associated data asynchronously.deleteAppInstanceAdmin(Consumer<DeleteAppInstanceAdminRequest.Builder> deleteAppInstanceAdminRequest) Demotes anAppInstanceAdminto anAppInstanceUserorAppInstanceBot.deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest deleteAppInstanceAdminRequest) Demotes anAppInstanceAdminto anAppInstanceUserorAppInstanceBot.deleteAppInstanceBot(Consumer<DeleteAppInstanceBotRequest.Builder> deleteAppInstanceBotRequest) Deletes anAppInstanceBot.deleteAppInstanceBot(DeleteAppInstanceBotRequest deleteAppInstanceBotRequest) Deletes anAppInstanceBot.deleteAppInstanceUser(Consumer<DeleteAppInstanceUserRequest.Builder> deleteAppInstanceUserRequest) Deletes anAppInstanceUser.deleteAppInstanceUser(DeleteAppInstanceUserRequest deleteAppInstanceUserRequest) Deletes anAppInstanceUser.deregisterAppInstanceUserEndpoint(Consumer<DeregisterAppInstanceUserEndpointRequest.Builder> deregisterAppInstanceUserEndpointRequest) Deregisters anAppInstanceUserEndpoint.deregisterAppInstanceUserEndpoint(DeregisterAppInstanceUserEndpointRequest deregisterAppInstanceUserEndpointRequest) Deregisters anAppInstanceUserEndpoint.describeAppInstance(Consumer<DescribeAppInstanceRequest.Builder> describeAppInstanceRequest) Returns the full details of anAppInstance.describeAppInstance(DescribeAppInstanceRequest describeAppInstanceRequest) Returns the full details of anAppInstance.describeAppInstanceAdmin(Consumer<DescribeAppInstanceAdminRequest.Builder> describeAppInstanceAdminRequest) Returns the full details of anAppInstanceAdmin.describeAppInstanceAdmin(DescribeAppInstanceAdminRequest describeAppInstanceAdminRequest) Returns the full details of anAppInstanceAdmin.describeAppInstanceBot(Consumer<DescribeAppInstanceBotRequest.Builder> describeAppInstanceBotRequest) TheAppInstanceBot'sinformation.describeAppInstanceBot(DescribeAppInstanceBotRequest describeAppInstanceBotRequest) TheAppInstanceBot'sinformation.describeAppInstanceUser(Consumer<DescribeAppInstanceUserRequest.Builder> describeAppInstanceUserRequest) Returns the full details of anAppInstanceUser.describeAppInstanceUser(DescribeAppInstanceUserRequest describeAppInstanceUserRequest) Returns the full details of anAppInstanceUser.describeAppInstanceUserEndpoint(Consumer<DescribeAppInstanceUserEndpointRequest.Builder> describeAppInstanceUserEndpointRequest) Returns the full details of anAppInstanceUserEndpoint.describeAppInstanceUserEndpoint(DescribeAppInstanceUserEndpointRequest describeAppInstanceUserEndpointRequest) Returns the full details of anAppInstanceUserEndpoint.getAppInstanceRetentionSettings(Consumer<GetAppInstanceRetentionSettingsRequest.Builder> getAppInstanceRetentionSettingsRequest) Gets the retention settings for anAppInstance.getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest getAppInstanceRetentionSettingsRequest) Gets the retention settings for anAppInstance.listAppInstanceAdmins(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest) Returns a list of the administrators in theAppInstance.listAppInstanceAdmins(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest) Returns a list of the administrators in theAppInstance.default ListAppInstanceAdminsPublisherlistAppInstanceAdminsPaginator(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest) This is a variant oflistAppInstanceAdmins(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsRequest)operation.default ListAppInstanceAdminsPublisherlistAppInstanceAdminsPaginator(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest) This is a variant oflistAppInstanceAdmins(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsRequest)operation.listAppInstanceBots(Consumer<ListAppInstanceBotsRequest.Builder> listAppInstanceBotsRequest) Lists allAppInstanceBotscreated under a singleAppInstance.listAppInstanceBots(ListAppInstanceBotsRequest listAppInstanceBotsRequest) Lists allAppInstanceBotscreated under a singleAppInstance.default ListAppInstanceBotsPublisherlistAppInstanceBotsPaginator(Consumer<ListAppInstanceBotsRequest.Builder> listAppInstanceBotsRequest) This is a variant oflistAppInstanceBots(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsRequest)operation.default ListAppInstanceBotsPublisherlistAppInstanceBotsPaginator(ListAppInstanceBotsRequest listAppInstanceBotsRequest) This is a variant oflistAppInstanceBots(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsRequest)operation.listAppInstances(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest) Lists all Amazon ChimeAppInstances created under a single AWS account.listAppInstances(ListAppInstancesRequest listAppInstancesRequest) Lists all Amazon ChimeAppInstances created under a single AWS account.default ListAppInstancesPublisherlistAppInstancesPaginator(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest) This is a variant oflistAppInstances(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesRequest)operation.default ListAppInstancesPublisherlistAppInstancesPaginator(ListAppInstancesRequest listAppInstancesRequest) This is a variant oflistAppInstances(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesRequest)operation.listAppInstanceUserEndpoints(Consumer<ListAppInstanceUserEndpointsRequest.Builder> listAppInstanceUserEndpointsRequest) Lists all theAppInstanceUserEndpointscreated under a singleAppInstanceUser.listAppInstanceUserEndpoints(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest) Lists all theAppInstanceUserEndpointscreated under a singleAppInstanceUser.listAppInstanceUserEndpointsPaginator(Consumer<ListAppInstanceUserEndpointsRequest.Builder> listAppInstanceUserEndpointsRequest) This is a variant oflistAppInstanceUserEndpoints(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsRequest)operation.listAppInstanceUserEndpointsPaginator(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest) This is a variant oflistAppInstanceUserEndpoints(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsRequest)operation.listAppInstanceUsers(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest) List allAppInstanceUserscreated under a singleAppInstance.listAppInstanceUsers(ListAppInstanceUsersRequest listAppInstanceUsersRequest) List allAppInstanceUserscreated under a singleAppInstance.default ListAppInstanceUsersPublisherlistAppInstanceUsersPaginator(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest) This is a variant oflistAppInstanceUsers(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersRequest)operation.default ListAppInstanceUsersPublisherlistAppInstanceUsersPaginator(ListAppInstanceUsersRequest listAppInstanceUsersRequest) This is a variant oflistAppInstanceUsers(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags applied to an Amazon Chime SDK identity resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags applied to an Amazon Chime SDK identity resource.putAppInstanceRetentionSettings(Consumer<PutAppInstanceRetentionSettingsRequest.Builder> putAppInstanceRetentionSettingsRequest) Sets the amount of time in days that a givenAppInstanceretains data.putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest putAppInstanceRetentionSettingsRequest) Sets the amount of time in days that a givenAppInstanceretains data.putAppInstanceUserExpirationSettings(Consumer<PutAppInstanceUserExpirationSettingsRequest.Builder> putAppInstanceUserExpirationSettingsRequest) Sets the number of days before theAppInstanceUseris automatically deleted.putAppInstanceUserExpirationSettings(PutAppInstanceUserExpirationSettingsRequest putAppInstanceUserExpirationSettingsRequest) Sets the number of days before theAppInstanceUseris automatically deleted.registerAppInstanceUserEndpoint(Consumer<RegisterAppInstanceUserEndpointRequest.Builder> registerAppInstanceUserEndpointRequest) Registers an endpoint under an Amazon ChimeAppInstanceUser.registerAppInstanceUserEndpoint(RegisterAppInstanceUserEndpointRequest registerAppInstanceUserEndpointRequest) Registers an endpoint under an Amazon ChimeAppInstanceUser.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Applies the specified tags to the specified Amazon Chime SDK identity resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Applies the specified tags to the specified Amazon Chime SDK identity resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified Amazon Chime SDK identity resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified Amazon Chime SDK identity resource.updateAppInstance(Consumer<UpdateAppInstanceRequest.Builder> updateAppInstanceRequest) UpdatesAppInstancemetadata.updateAppInstance(UpdateAppInstanceRequest updateAppInstanceRequest) UpdatesAppInstancemetadata.updateAppInstanceBot(Consumer<UpdateAppInstanceBotRequest.Builder> updateAppInstanceBotRequest) Updates the name and metadata of anAppInstanceBot.updateAppInstanceBot(UpdateAppInstanceBotRequest updateAppInstanceBotRequest) Updates the name and metadata of anAppInstanceBot.updateAppInstanceUser(Consumer<UpdateAppInstanceUserRequest.Builder> updateAppInstanceUserRequest) Updates the details of anAppInstanceUser.updateAppInstanceUser(UpdateAppInstanceUserRequest updateAppInstanceUserRequest) Updates the details of anAppInstanceUser.updateAppInstanceUserEndpoint(Consumer<UpdateAppInstanceUserEndpointRequest.Builder> updateAppInstanceUserEndpointRequest) Updates the details of anAppInstanceUserEndpoint.updateAppInstanceUserEndpoint(UpdateAppInstanceUserEndpointRequest updateAppInstanceUserEndpointRequest) Updates the details of anAppInstanceUserEndpoint.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
createAppInstance
default CompletableFuture<CreateAppInstanceResponse> createAppInstance(CreateAppInstanceRequest createAppInstanceRequest) Creates an Amazon Chime SDK messaging
AppInstanceunder an AWS account. Only SDK messaging customers use this API.CreateAppInstancesupports idempotency behavior as described in the AWS API Standard.identity
- Parameters:
createAppInstanceRequest-- Returns:
- A Java Future containing the result of the CreateAppInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAppInstance
default CompletableFuture<CreateAppInstanceResponse> createAppInstance(Consumer<CreateAppInstanceRequest.Builder> createAppInstanceRequest) Creates an Amazon Chime SDK messaging
AppInstanceunder an AWS account. Only SDK messaging customers use this API.CreateAppInstancesupports idempotency behavior as described in the AWS API Standard.identity
This is a convenience which creates an instance of the
CreateAppInstanceRequest.Builderavoiding the need to create one manually viaCreateAppInstanceRequest.builder()- Parameters:
createAppInstanceRequest- AConsumerthat will call methods onCreateAppInstanceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateAppInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAppInstanceAdmin
default CompletableFuture<CreateAppInstanceAdminResponse> createAppInstanceAdmin(CreateAppInstanceAdminRequest createAppInstanceAdminRequest) Promotes an
AppInstanceUserorAppInstanceBotto anAppInstanceAdmin. The promoted entity can perform the following actions.-
ChannelModeratoractions across all channels in theAppInstance. -
DeleteChannelMessageactions.
Only an
AppInstanceUserandAppInstanceBotcan be promoted to anAppInstanceAdminrole.- Parameters:
createAppInstanceAdminRequest-- Returns:
- A Java Future containing the result of the CreateAppInstanceAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createAppInstanceAdmin
default CompletableFuture<CreateAppInstanceAdminResponse> createAppInstanceAdmin(Consumer<CreateAppInstanceAdminRequest.Builder> createAppInstanceAdminRequest) Promotes an
AppInstanceUserorAppInstanceBotto anAppInstanceAdmin. The promoted entity can perform the following actions.-
ChannelModeratoractions across all channels in theAppInstance. -
DeleteChannelMessageactions.
Only an
AppInstanceUserandAppInstanceBotcan be promoted to anAppInstanceAdminrole.
This is a convenience which creates an instance of the
CreateAppInstanceAdminRequest.Builderavoiding the need to create one manually viaCreateAppInstanceAdminRequest.builder()- Parameters:
createAppInstanceAdminRequest- AConsumerthat will call methods onCreateAppInstanceAdminRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateAppInstanceAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createAppInstanceBot
default CompletableFuture<CreateAppInstanceBotResponse> createAppInstanceBot(CreateAppInstanceBotRequest createAppInstanceBotRequest) Creates a bot under an Amazon Chime
AppInstance. The request consists of a uniqueConfigurationandNamefor that bot.- Parameters:
createAppInstanceBotRequest-- Returns:
- A Java Future containing the result of the CreateAppInstanceBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAppInstanceBot
default CompletableFuture<CreateAppInstanceBotResponse> createAppInstanceBot(Consumer<CreateAppInstanceBotRequest.Builder> createAppInstanceBotRequest) Creates a bot under an Amazon Chime
AppInstance. The request consists of a uniqueConfigurationandNamefor that bot.
This is a convenience which creates an instance of the
CreateAppInstanceBotRequest.Builderavoiding the need to create one manually viaCreateAppInstanceBotRequest.builder()- Parameters:
createAppInstanceBotRequest- AConsumerthat will call methods onCreateAppInstanceBotRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateAppInstanceBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAppInstanceUser
default CompletableFuture<CreateAppInstanceUserResponse> createAppInstanceUser(CreateAppInstanceUserRequest createAppInstanceUserRequest) Creates a user under an Amazon Chime
AppInstance. The request consists of a uniqueappInstanceUserIdandNamefor that user.- Parameters:
createAppInstanceUserRequest-- Returns:
- A Java Future containing the result of the CreateAppInstanceUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAppInstanceUser
default CompletableFuture<CreateAppInstanceUserResponse> createAppInstanceUser(Consumer<CreateAppInstanceUserRequest.Builder> createAppInstanceUserRequest) Creates a user under an Amazon Chime
AppInstance. The request consists of a uniqueappInstanceUserIdandNamefor that user.
This is a convenience which creates an instance of the
CreateAppInstanceUserRequest.Builderavoiding the need to create one manually viaCreateAppInstanceUserRequest.builder()- Parameters:
createAppInstanceUserRequest- AConsumerthat will call methods onCreateAppInstanceUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateAppInstanceUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppInstance
default CompletableFuture<DeleteAppInstanceResponse> deleteAppInstance(DeleteAppInstanceRequest deleteAppInstanceRequest) Deletes an
AppInstanceand all associated data asynchronously.- Parameters:
deleteAppInstanceRequest-- Returns:
- A Java Future containing the result of the DeleteAppInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppInstance
default CompletableFuture<DeleteAppInstanceResponse> deleteAppInstance(Consumer<DeleteAppInstanceRequest.Builder> deleteAppInstanceRequest) Deletes an
AppInstanceand all associated data asynchronously.
This is a convenience which creates an instance of the
DeleteAppInstanceRequest.Builderavoiding the need to create one manually viaDeleteAppInstanceRequest.builder()- Parameters:
deleteAppInstanceRequest- AConsumerthat will call methods onDeleteAppInstanceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteAppInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppInstanceAdmin
default CompletableFuture<DeleteAppInstanceAdminResponse> deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest deleteAppInstanceAdminRequest) Demotes an
AppInstanceAdminto anAppInstanceUserorAppInstanceBot. This action does not delete the user.- Parameters:
deleteAppInstanceAdminRequest-- Returns:
- A Java Future containing the result of the DeleteAppInstanceAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppInstanceAdmin
default CompletableFuture<DeleteAppInstanceAdminResponse> deleteAppInstanceAdmin(Consumer<DeleteAppInstanceAdminRequest.Builder> deleteAppInstanceAdminRequest) Demotes an
AppInstanceAdminto anAppInstanceUserorAppInstanceBot. This action does not delete the user.
This is a convenience which creates an instance of the
DeleteAppInstanceAdminRequest.Builderavoiding the need to create one manually viaDeleteAppInstanceAdminRequest.builder()- Parameters:
deleteAppInstanceAdminRequest- AConsumerthat will call methods onDeleteAppInstanceAdminRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteAppInstanceAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppInstanceBot
default CompletableFuture<DeleteAppInstanceBotResponse> deleteAppInstanceBot(DeleteAppInstanceBotRequest deleteAppInstanceBotRequest) Deletes an
AppInstanceBot.- Parameters:
deleteAppInstanceBotRequest-- Returns:
- A Java Future containing the result of the DeleteAppInstanceBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppInstanceBot
default CompletableFuture<DeleteAppInstanceBotResponse> deleteAppInstanceBot(Consumer<DeleteAppInstanceBotRequest.Builder> deleteAppInstanceBotRequest) Deletes an
AppInstanceBot.
This is a convenience which creates an instance of the
DeleteAppInstanceBotRequest.Builderavoiding the need to create one manually viaDeleteAppInstanceBotRequest.builder()- Parameters:
deleteAppInstanceBotRequest- AConsumerthat will call methods onDeleteAppInstanceBotRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteAppInstanceBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppInstanceUser
default CompletableFuture<DeleteAppInstanceUserResponse> deleteAppInstanceUser(DeleteAppInstanceUserRequest deleteAppInstanceUserRequest) Deletes an
AppInstanceUser.- Parameters:
deleteAppInstanceUserRequest-- Returns:
- A Java Future containing the result of the DeleteAppInstanceUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppInstanceUser
default CompletableFuture<DeleteAppInstanceUserResponse> deleteAppInstanceUser(Consumer<DeleteAppInstanceUserRequest.Builder> deleteAppInstanceUserRequest) Deletes an
AppInstanceUser.
This is a convenience which creates an instance of the
DeleteAppInstanceUserRequest.Builderavoiding the need to create one manually viaDeleteAppInstanceUserRequest.builder()- Parameters:
deleteAppInstanceUserRequest- AConsumerthat will call methods onDeleteAppInstanceUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteAppInstanceUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterAppInstanceUserEndpoint
default CompletableFuture<DeregisterAppInstanceUserEndpointResponse> deregisterAppInstanceUserEndpoint(DeregisterAppInstanceUserEndpointRequest deregisterAppInstanceUserEndpointRequest) Deregisters an
AppInstanceUserEndpoint.- Parameters:
deregisterAppInstanceUserEndpointRequest-- Returns:
- A Java Future containing the result of the DeregisterAppInstanceUserEndpoint operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterAppInstanceUserEndpoint
default CompletableFuture<DeregisterAppInstanceUserEndpointResponse> deregisterAppInstanceUserEndpoint(Consumer<DeregisterAppInstanceUserEndpointRequest.Builder> deregisterAppInstanceUserEndpointRequest) Deregisters an
AppInstanceUserEndpoint.
This is a convenience which creates an instance of the
DeregisterAppInstanceUserEndpointRequest.Builderavoiding the need to create one manually viaDeregisterAppInstanceUserEndpointRequest.builder()- Parameters:
deregisterAppInstanceUserEndpointRequest- AConsumerthat will call methods onDeregisterAppInstanceUserEndpointRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeregisterAppInstanceUserEndpoint operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppInstance
default CompletableFuture<DescribeAppInstanceResponse> describeAppInstance(DescribeAppInstanceRequest describeAppInstanceRequest) Returns the full details of an
AppInstance.- Parameters:
describeAppInstanceRequest-- Returns:
- A Java Future containing the result of the DescribeAppInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppInstance
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.Builderavoiding the need to create one manually viaDescribeAppInstanceRequest.builder()- Parameters:
describeAppInstanceRequest- AConsumerthat will call methods onDescribeAppInstanceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeAppInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppInstanceAdmin
default CompletableFuture<DescribeAppInstanceAdminResponse> describeAppInstanceAdmin(DescribeAppInstanceAdminRequest describeAppInstanceAdminRequest) Returns the full details of an
AppInstanceAdmin.- Parameters:
describeAppInstanceAdminRequest-- Returns:
- A Java Future containing the result of the DescribeAppInstanceAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppInstanceAdmin
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.Builderavoiding the need to create one manually viaDescribeAppInstanceAdminRequest.builder()- Parameters:
describeAppInstanceAdminRequest- AConsumerthat will call methods onDescribeAppInstanceAdminRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeAppInstanceAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppInstanceBot
default CompletableFuture<DescribeAppInstanceBotResponse> describeAppInstanceBot(DescribeAppInstanceBotRequest describeAppInstanceBotRequest) The
AppInstanceBot'sinformation.- Parameters:
describeAppInstanceBotRequest-- Returns:
- A Java Future containing the result of the DescribeAppInstanceBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppInstanceBot
default CompletableFuture<DescribeAppInstanceBotResponse> describeAppInstanceBot(Consumer<DescribeAppInstanceBotRequest.Builder> describeAppInstanceBotRequest) The
AppInstanceBot'sinformation.
This is a convenience which creates an instance of the
DescribeAppInstanceBotRequest.Builderavoiding the need to create one manually viaDescribeAppInstanceBotRequest.builder()- Parameters:
describeAppInstanceBotRequest- AConsumerthat will call methods onDescribeAppInstanceBotRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeAppInstanceBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppInstanceUser
default CompletableFuture<DescribeAppInstanceUserResponse> describeAppInstanceUser(DescribeAppInstanceUserRequest describeAppInstanceUserRequest) Returns the full details of an
AppInstanceUser.- Parameters:
describeAppInstanceUserRequest-- Returns:
- A Java Future containing the result of the DescribeAppInstanceUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppInstanceUser
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.Builderavoiding the need to create one manually viaDescribeAppInstanceUserRequest.builder()- Parameters:
describeAppInstanceUserRequest- AConsumerthat will call methods onDescribeAppInstanceUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeAppInstanceUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppInstanceUserEndpoint
default CompletableFuture<DescribeAppInstanceUserEndpointResponse> describeAppInstanceUserEndpoint(DescribeAppInstanceUserEndpointRequest describeAppInstanceUserEndpointRequest) Returns the full details of an
AppInstanceUserEndpoint.- Parameters:
describeAppInstanceUserEndpointRequest-- Returns:
- A Java Future containing the result of the DescribeAppInstanceUserEndpoint operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAppInstanceUserEndpoint
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.Builderavoiding the need to create one manually viaDescribeAppInstanceUserEndpointRequest.builder()- Parameters:
describeAppInstanceUserEndpointRequest- AConsumerthat will call methods onDescribeAppInstanceUserEndpointRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeAppInstanceUserEndpoint operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppInstanceRetentionSettings
default CompletableFuture<GetAppInstanceRetentionSettingsResponse> getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest getAppInstanceRetentionSettingsRequest) Gets the retention settings for an
AppInstance.- Parameters:
getAppInstanceRetentionSettingsRequest-- Returns:
- A Java Future containing the result of the GetAppInstanceRetentionSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppInstanceRetentionSettings
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.Builderavoiding the need to create one manually viaGetAppInstanceRetentionSettingsRequest.builder()- Parameters:
getAppInstanceRetentionSettingsRequest- AConsumerthat will call methods onGetAppInstanceRetentionSettingsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAppInstanceRetentionSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstanceAdmins
default CompletableFuture<ListAppInstanceAdminsResponse> listAppInstanceAdmins(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest) Returns a list of the administrators in the
AppInstance.- Parameters:
listAppInstanceAdminsRequest-- Returns:
- A Java Future containing the result of the ListAppInstanceAdmins operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstanceAdmins
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.Builderavoiding the need to create one manually viaListAppInstanceAdminsRequest.builder()- Parameters:
listAppInstanceAdminsRequest- AConsumerthat will call methods onListAppInstanceAdminsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAppInstanceAdmins operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstanceAdminsPaginator
default ListAppInstanceAdminsPublisher listAppInstanceAdminsPaginator(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest) 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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceAdminsPublisher publisher = client.listAppInstanceAdminsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.- Parameters:
listAppInstanceAdminsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstanceAdminsPaginator
default ListAppInstanceAdminsPublisher listAppInstanceAdminsPaginator(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest) 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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceAdminsPublisher publisher = client.listAppInstanceAdminsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListAppInstanceAdminsRequest.builder()- Parameters:
listAppInstanceAdminsRequest- AConsumerthat will call methods onListAppInstanceAdminsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstanceBots
default CompletableFuture<ListAppInstanceBotsResponse> listAppInstanceBots(ListAppInstanceBotsRequest listAppInstanceBotsRequest) Lists all
AppInstanceBotscreated under a singleAppInstance.- Parameters:
listAppInstanceBotsRequest-- Returns:
- A Java Future containing the result of the ListAppInstanceBots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstanceBots
default CompletableFuture<ListAppInstanceBotsResponse> listAppInstanceBots(Consumer<ListAppInstanceBotsRequest.Builder> listAppInstanceBotsRequest) Lists all
AppInstanceBotscreated under a singleAppInstance.
This is a convenience which creates an instance of the
ListAppInstanceBotsRequest.Builderavoiding the need to create one manually viaListAppInstanceBotsRequest.builder()- Parameters:
listAppInstanceBotsRequest- AConsumerthat will call methods onListAppInstanceBotsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAppInstanceBots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstanceBotsPaginator
default ListAppInstanceBotsPublisher listAppInstanceBotsPaginator(ListAppInstanceBotsRequest listAppInstanceBotsRequest) 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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceBotsPublisher publisher = client.listAppInstanceBotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.- Parameters:
listAppInstanceBotsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstanceBotsPaginator
default ListAppInstanceBotsPublisher listAppInstanceBotsPaginator(Consumer<ListAppInstanceBotsRequest.Builder> listAppInstanceBotsRequest) 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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceBotsPublisher publisher = client.listAppInstanceBotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListAppInstanceBotsRequest.builder()- Parameters:
listAppInstanceBotsRequest- AConsumerthat will call methods onListAppInstanceBotsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstanceUserEndpoints
default CompletableFuture<ListAppInstanceUserEndpointsResponse> listAppInstanceUserEndpoints(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest) Lists all the
AppInstanceUserEndpointscreated under a singleAppInstanceUser.- Parameters:
listAppInstanceUserEndpointsRequest-- Returns:
- A Java Future containing the result of the ListAppInstanceUserEndpoints operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstanceUserEndpoints
default CompletableFuture<ListAppInstanceUserEndpointsResponse> listAppInstanceUserEndpoints(Consumer<ListAppInstanceUserEndpointsRequest.Builder> listAppInstanceUserEndpointsRequest) Lists all the
AppInstanceUserEndpointscreated under a singleAppInstanceUser.
This is a convenience which creates an instance of the
ListAppInstanceUserEndpointsRequest.Builderavoiding the need to create one manually viaListAppInstanceUserEndpointsRequest.builder()- Parameters:
listAppInstanceUserEndpointsRequest- AConsumerthat will call methods onListAppInstanceUserEndpointsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAppInstanceUserEndpoints operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstanceUserEndpointsPaginator
default ListAppInstanceUserEndpointsPublisher listAppInstanceUserEndpointsPaginator(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest) 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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUserEndpointsPublisher publisher = client.listAppInstanceUserEndpointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.- Parameters:
listAppInstanceUserEndpointsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstanceUserEndpointsPaginator
default ListAppInstanceUserEndpointsPublisher listAppInstanceUserEndpointsPaginator(Consumer<ListAppInstanceUserEndpointsRequest.Builder> listAppInstanceUserEndpointsRequest) 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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUserEndpointsPublisher publisher = client.listAppInstanceUserEndpointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListAppInstanceUserEndpointsRequest.builder()- Parameters:
listAppInstanceUserEndpointsRequest- AConsumerthat will call methods onListAppInstanceUserEndpointsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstanceUsers
default CompletableFuture<ListAppInstanceUsersResponse> listAppInstanceUsers(ListAppInstanceUsersRequest listAppInstanceUsersRequest) List all
AppInstanceUserscreated under a singleAppInstance.- Parameters:
listAppInstanceUsersRequest-- Returns:
- A Java Future containing the result of the ListAppInstanceUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstanceUsers
default CompletableFuture<ListAppInstanceUsersResponse> listAppInstanceUsers(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest) List all
AppInstanceUserscreated under a singleAppInstance.
This is a convenience which creates an instance of the
ListAppInstanceUsersRequest.Builderavoiding the need to create one manually viaListAppInstanceUsersRequest.builder()- Parameters:
listAppInstanceUsersRequest- AConsumerthat will call methods onListAppInstanceUsersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAppInstanceUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstanceUsersPaginator
default ListAppInstanceUsersPublisher listAppInstanceUsersPaginator(ListAppInstanceUsersRequest listAppInstanceUsersRequest) 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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUsersPublisher publisher = client.listAppInstanceUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.- Parameters:
listAppInstanceUsersRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstanceUsersPaginator
default ListAppInstanceUsersPublisher listAppInstanceUsersPaginator(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest) 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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUsersPublisher publisher = client.listAppInstanceUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListAppInstanceUsersRequest.builder()- Parameters:
listAppInstanceUsersRequest- AConsumerthat will call methods onListAppInstanceUsersRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstances
default CompletableFuture<ListAppInstancesResponse> listAppInstances(ListAppInstancesRequest listAppInstancesRequest) Lists all Amazon Chime
AppInstances created under a single AWS account.- Parameters:
listAppInstancesRequest-- Returns:
- A Java Future containing the result of the ListAppInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstances
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.Builderavoiding the need to create one manually viaListAppInstancesRequest.builder()- Parameters:
listAppInstancesRequest- AConsumerthat will call methods onListAppInstancesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAppInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstancesPaginator
default ListAppInstancesPublisher listAppInstancesPaginator(ListAppInstancesRequest listAppInstancesRequest) 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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstancesPublisher publisher = client.listAppInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.- Parameters:
listAppInstancesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppInstancesPaginator
default ListAppInstancesPublisher listAppInstancesPaginator(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest) 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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstancesPublisher publisher = client.listAppInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListAppInstancesRequest.builder()- Parameters:
listAppInstancesRequest- AConsumerthat will call methods onListAppInstancesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags applied to an Amazon Chime SDK identity resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAppInstanceRetentionSettings
default CompletableFuture<PutAppInstanceRetentionSettingsResponse> putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest putAppInstanceRetentionSettingsRequest) Sets the amount of time in days that a given
AppInstanceretains data.- Parameters:
putAppInstanceRetentionSettingsRequest-- Returns:
- A Java Future containing the result of the PutAppInstanceRetentionSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAppInstanceRetentionSettings
default CompletableFuture<PutAppInstanceRetentionSettingsResponse> putAppInstanceRetentionSettings(Consumer<PutAppInstanceRetentionSettingsRequest.Builder> putAppInstanceRetentionSettingsRequest) Sets the amount of time in days that a given
AppInstanceretains data.
This is a convenience which creates an instance of the
PutAppInstanceRetentionSettingsRequest.Builderavoiding the need to create one manually viaPutAppInstanceRetentionSettingsRequest.builder()- Parameters:
putAppInstanceRetentionSettingsRequest- AConsumerthat will call methods onPutAppInstanceRetentionSettingsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutAppInstanceRetentionSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAppInstanceUserExpirationSettings
default CompletableFuture<PutAppInstanceUserExpirationSettingsResponse> putAppInstanceUserExpirationSettings(PutAppInstanceUserExpirationSettingsRequest putAppInstanceUserExpirationSettingsRequest) Sets the number of days before the
AppInstanceUseris automatically deleted.A background process deletes expired
AppInstanceUserswithin 6 hours of expiration. Actual deletion times may vary.Expired
AppInstanceUsersthat have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.- Parameters:
putAppInstanceUserExpirationSettingsRequest-- Returns:
- A Java Future containing the result of the PutAppInstanceUserExpirationSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAppInstanceUserExpirationSettings
default CompletableFuture<PutAppInstanceUserExpirationSettingsResponse> putAppInstanceUserExpirationSettings(Consumer<PutAppInstanceUserExpirationSettingsRequest.Builder> putAppInstanceUserExpirationSettingsRequest) Sets the number of days before the
AppInstanceUseris automatically deleted.A background process deletes expired
AppInstanceUserswithin 6 hours of expiration. Actual deletion times may vary.Expired
AppInstanceUsersthat 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.Builderavoiding the need to create one manually viaPutAppInstanceUserExpirationSettingsRequest.builder()- Parameters:
putAppInstanceUserExpirationSettingsRequest- AConsumerthat will call methods onPutAppInstanceUserExpirationSettingsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutAppInstanceUserExpirationSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerAppInstanceUserEndpoint
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.- Parameters:
registerAppInstanceUserEndpointRequest-- Returns:
- A Java Future containing the result of the RegisterAppInstanceUserEndpoint operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerAppInstanceUserEndpoint
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.Builderavoiding the need to create one manually viaRegisterAppInstanceUserEndpointRequest.builder()- Parameters:
registerAppInstanceUserEndpointRequest- AConsumerthat will call methods onRegisterAppInstanceUserEndpointRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the RegisterAppInstanceUserEndpoint operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Applies the specified tags to the specified Amazon Chime SDK identity resource.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified Amazon Chime SDK identity resource.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAppInstance
default CompletableFuture<UpdateAppInstanceResponse> updateAppInstance(UpdateAppInstanceRequest updateAppInstanceRequest) Updates
AppInstancemetadata.- Parameters:
updateAppInstanceRequest-- Returns:
- A Java Future containing the result of the UpdateAppInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAppInstance
default CompletableFuture<UpdateAppInstanceResponse> updateAppInstance(Consumer<UpdateAppInstanceRequest.Builder> updateAppInstanceRequest) Updates
AppInstancemetadata.
This is a convenience which creates an instance of the
UpdateAppInstanceRequest.Builderavoiding the need to create one manually viaUpdateAppInstanceRequest.builder()- Parameters:
updateAppInstanceRequest- AConsumerthat will call methods onUpdateAppInstanceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateAppInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAppInstanceBot
default CompletableFuture<UpdateAppInstanceBotResponse> updateAppInstanceBot(UpdateAppInstanceBotRequest updateAppInstanceBotRequest) Updates the name and metadata of an
AppInstanceBot.- Parameters:
updateAppInstanceBotRequest-- Returns:
- A Java Future containing the result of the UpdateAppInstanceBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAppInstanceBot
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.Builderavoiding the need to create one manually viaUpdateAppInstanceBotRequest.builder()- Parameters:
updateAppInstanceBotRequest- AConsumerthat will call methods onUpdateAppInstanceBotRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateAppInstanceBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAppInstanceUser
default CompletableFuture<UpdateAppInstanceUserResponse> updateAppInstanceUser(UpdateAppInstanceUserRequest updateAppInstanceUserRequest) Updates the details of an
AppInstanceUser. You can update names and metadata.- Parameters:
updateAppInstanceUserRequest-- Returns:
- A Java Future containing the result of the UpdateAppInstanceUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAppInstanceUser
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.Builderavoiding the need to create one manually viaUpdateAppInstanceUserRequest.builder()- Parameters:
updateAppInstanceUserRequest- AConsumerthat will call methods onUpdateAppInstanceUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateAppInstanceUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ResourceLimitExceededException The request exceeds the resource limit.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAppInstanceUserEndpoint
default CompletableFuture<UpdateAppInstanceUserEndpointResponse> updateAppInstanceUserEndpoint(UpdateAppInstanceUserEndpointRequest updateAppInstanceUserEndpointRequest) Updates the details of an
AppInstanceUserEndpoint. You can update the name andAllowMessagevalues.- Parameters:
updateAppInstanceUserEndpointRequest-- Returns:
- A Java Future containing the result of the UpdateAppInstanceUserEndpoint operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAppInstanceUserEndpoint
default CompletableFuture<UpdateAppInstanceUserEndpointResponse> updateAppInstanceUserEndpoint(Consumer<UpdateAppInstanceUserEndpointRequest.Builder> updateAppInstanceUserEndpointRequest) Updates the details of an
AppInstanceUserEndpoint. You can update the name andAllowMessagevalues.
This is a convenience which creates an instance of the
UpdateAppInstanceUserEndpointRequest.Builderavoiding the need to create one manually viaUpdateAppInstanceUserEndpointRequest.builder()- Parameters:
updateAppInstanceUserEndpointRequest- AConsumerthat will call methods onUpdateAppInstanceUserEndpointRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateAppInstanceUserEndpoint operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkIdentityException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aChimeSdkIdentityAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aChimeSdkIdentityAsyncClient.
-