Interface ChimeSdkMessagingAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
The Amazon Chime SDK messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK identity APIs. For more information about the messaging APIs, see Amazon Chime SDK messaging.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateChannelFlow
(Consumer<AssociateChannelFlowRequest.Builder> associateChannelFlowRequest) Associates a channel flow with a channel.associateChannelFlow
(AssociateChannelFlowRequest associateChannelFlowRequest) Associates a channel flow with a channel.batchCreateChannelMembership
(Consumer<BatchCreateChannelMembershipRequest.Builder> batchCreateChannelMembershipRequest) Adds a specified number of users and bots to a channel.batchCreateChannelMembership
(BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest) Adds a specified number of users and bots to a channel.builder()
Create a builder that can be used to configure and create aChimeSdkMessagingAsyncClient
.channelFlowCallback
(Consumer<ChannelFlowCallbackRequest.Builder> channelFlowCallbackRequest) Calls back Amazon Chime SDK messaging with a processing response message.channelFlowCallback
(ChannelFlowCallbackRequest channelFlowCallbackRequest) Calls back Amazon Chime SDK messaging with a processing response message.static ChimeSdkMessagingAsyncClient
create()
Create aChimeSdkMessagingAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateChannelResponse> createChannel
(Consumer<CreateChannelRequest.Builder> createChannelRequest) Creates a channel to which you can add users and send messages.default CompletableFuture
<CreateChannelResponse> createChannel
(CreateChannelRequest createChannelRequest) Creates a channel to which you can add users and send messages.createChannelBan
(Consumer<CreateChannelBanRequest.Builder> createChannelBanRequest) Permanently bans a member from a channel.createChannelBan
(CreateChannelBanRequest createChannelBanRequest) Permanently bans a member from a channel.createChannelFlow
(Consumer<CreateChannelFlowRequest.Builder> createChannelFlowRequest) Creates a channel flow, a container for processors.createChannelFlow
(CreateChannelFlowRequest createChannelFlowRequest) Creates a channel flow, a container for processors.createChannelMembership
(Consumer<CreateChannelMembershipRequest.Builder> createChannelMembershipRequest) Adds a member to a channel.createChannelMembership
(CreateChannelMembershipRequest createChannelMembershipRequest) Adds a member to a channel.createChannelModerator
(Consumer<CreateChannelModeratorRequest.Builder> createChannelModeratorRequest) Creates a newChannelModerator
.createChannelModerator
(CreateChannelModeratorRequest createChannelModeratorRequest) Creates a newChannelModerator
.default CompletableFuture
<DeleteChannelResponse> deleteChannel
(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest) Immediately makes a channel and its memberships inaccessible and marks them for deletion.default CompletableFuture
<DeleteChannelResponse> deleteChannel
(DeleteChannelRequest deleteChannelRequest) Immediately makes a channel and its memberships inaccessible and marks them for deletion.deleteChannelBan
(Consumer<DeleteChannelBanRequest.Builder> deleteChannelBanRequest) Removes a member from a channel's ban list.deleteChannelBan
(DeleteChannelBanRequest deleteChannelBanRequest) Removes a member from a channel's ban list.deleteChannelFlow
(Consumer<DeleteChannelFlowRequest.Builder> deleteChannelFlowRequest) Deletes a channel flow, an irreversible process.deleteChannelFlow
(DeleteChannelFlowRequest deleteChannelFlowRequest) Deletes a channel flow, an irreversible process.deleteChannelMembership
(Consumer<DeleteChannelMembershipRequest.Builder> deleteChannelMembershipRequest) Removes a member from a channel.deleteChannelMembership
(DeleteChannelMembershipRequest deleteChannelMembershipRequest) Removes a member from a channel.deleteChannelMessage
(Consumer<DeleteChannelMessageRequest.Builder> deleteChannelMessageRequest) Deletes a channel message.deleteChannelMessage
(DeleteChannelMessageRequest deleteChannelMessageRequest) Deletes a channel message.deleteChannelModerator
(Consumer<DeleteChannelModeratorRequest.Builder> deleteChannelModeratorRequest) Deletes a channel moderator.deleteChannelModerator
(DeleteChannelModeratorRequest deleteChannelModeratorRequest) Deletes a channel moderator.deleteMessagingStreamingConfigurations
(Consumer<DeleteMessagingStreamingConfigurationsRequest.Builder> deleteMessagingStreamingConfigurationsRequest) Deletes the streaming configurations for anAppInstance
.deleteMessagingStreamingConfigurations
(DeleteMessagingStreamingConfigurationsRequest deleteMessagingStreamingConfigurationsRequest) Deletes the streaming configurations for anAppInstance
.default CompletableFuture
<DescribeChannelResponse> describeChannel
(Consumer<DescribeChannelRequest.Builder> describeChannelRequest) Returns the full details of a channel in an Amazon ChimeAppInstance
.default CompletableFuture
<DescribeChannelResponse> describeChannel
(DescribeChannelRequest describeChannelRequest) Returns the full details of a channel in an Amazon ChimeAppInstance
.describeChannelBan
(Consumer<DescribeChannelBanRequest.Builder> describeChannelBanRequest) Returns the full details of a channel ban.describeChannelBan
(DescribeChannelBanRequest describeChannelBanRequest) Returns the full details of a channel ban.describeChannelFlow
(Consumer<DescribeChannelFlowRequest.Builder> describeChannelFlowRequest) Returns the full details of a channel flow in an Amazon ChimeAppInstance
.describeChannelFlow
(DescribeChannelFlowRequest describeChannelFlowRequest) Returns the full details of a channel flow in an Amazon ChimeAppInstance
.describeChannelMembership
(Consumer<DescribeChannelMembershipRequest.Builder> describeChannelMembershipRequest) Returns the full details of a user's channel membership.describeChannelMembership
(DescribeChannelMembershipRequest describeChannelMembershipRequest) Returns the full details of a user's channel membership.describeChannelMembershipForAppInstanceUser
(Consumer<DescribeChannelMembershipForAppInstanceUserRequest.Builder> describeChannelMembershipForAppInstanceUserRequest) Returns the details of a channel based on the membership of the specifiedAppInstanceUser
orAppInstanceBot
.describeChannelMembershipForAppInstanceUser
(DescribeChannelMembershipForAppInstanceUserRequest describeChannelMembershipForAppInstanceUserRequest) Returns the details of a channel based on the membership of the specifiedAppInstanceUser
orAppInstanceBot
.describeChannelModeratedByAppInstanceUser
(Consumer<DescribeChannelModeratedByAppInstanceUserRequest.Builder> describeChannelModeratedByAppInstanceUserRequest) Returns the full details of a channel moderated by the specifiedAppInstanceUser
orAppInstanceBot
.describeChannelModeratedByAppInstanceUser
(DescribeChannelModeratedByAppInstanceUserRequest describeChannelModeratedByAppInstanceUserRequest) Returns the full details of a channel moderated by the specifiedAppInstanceUser
orAppInstanceBot
.describeChannelModerator
(Consumer<DescribeChannelModeratorRequest.Builder> describeChannelModeratorRequest) Returns the full details of a single ChannelModerator.describeChannelModerator
(DescribeChannelModeratorRequest describeChannelModeratorRequest) Returns the full details of a single ChannelModerator.disassociateChannelFlow
(Consumer<DisassociateChannelFlowRequest.Builder> disassociateChannelFlowRequest) Disassociates a channel flow from all its channels.disassociateChannelFlow
(DisassociateChannelFlowRequest disassociateChannelFlowRequest) Disassociates a channel flow from all its channels.getChannelMembershipPreferences
(Consumer<GetChannelMembershipPreferencesRequest.Builder> getChannelMembershipPreferencesRequest) Gets the membership preferences of anAppInstanceUser
orAppInstanceBot
for the specified channel.getChannelMembershipPreferences
(GetChannelMembershipPreferencesRequest getChannelMembershipPreferencesRequest) Gets the membership preferences of anAppInstanceUser
orAppInstanceBot
for the specified channel.getChannelMessage
(Consumer<GetChannelMessageRequest.Builder> getChannelMessageRequest) Gets the full details of a channel message.getChannelMessage
(GetChannelMessageRequest getChannelMessageRequest) Gets the full details of a channel message.getChannelMessageStatus
(Consumer<GetChannelMessageStatusRequest.Builder> getChannelMessageStatusRequest) Gets message status for a specifiedmessageId
.getChannelMessageStatus
(GetChannelMessageStatusRequest getChannelMessageStatusRequest) Gets message status for a specifiedmessageId
.getMessagingSessionEndpoint
(Consumer<GetMessagingSessionEndpointRequest.Builder> getMessagingSessionEndpointRequest) The details of the endpoint for the messaging session.getMessagingSessionEndpoint
(GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest) The details of the endpoint for the messaging session.getMessagingStreamingConfigurations
(Consumer<GetMessagingStreamingConfigurationsRequest.Builder> getMessagingStreamingConfigurationsRequest) Retrieves the data streaming configuration for anAppInstance
.getMessagingStreamingConfigurations
(GetMessagingStreamingConfigurationsRequest getMessagingStreamingConfigurationsRequest) Retrieves the data streaming configuration for anAppInstance
.default CompletableFuture
<ListChannelBansResponse> listChannelBans
(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest) Lists all the users and bots banned from a particular channel.default CompletableFuture
<ListChannelBansResponse> listChannelBans
(ListChannelBansRequest listChannelBansRequest) Lists all the users and bots banned from a particular channel.default ListChannelBansPublisher
listChannelBansPaginator
(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest) This is a variant oflistChannelBans(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansRequest)
operation.default ListChannelBansPublisher
listChannelBansPaginator
(ListChannelBansRequest listChannelBansRequest) This is a variant oflistChannelBans(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansRequest)
operation.listChannelFlows
(Consumer<ListChannelFlowsRequest.Builder> listChannelFlowsRequest) Returns a paginated lists of all the channel flows created under a single Chime.listChannelFlows
(ListChannelFlowsRequest listChannelFlowsRequest) Returns a paginated lists of all the channel flows created under a single Chime.default ListChannelFlowsPublisher
listChannelFlowsPaginator
(Consumer<ListChannelFlowsRequest.Builder> listChannelFlowsRequest) This is a variant oflistChannelFlows(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsRequest)
operation.default ListChannelFlowsPublisher
listChannelFlowsPaginator
(ListChannelFlowsRequest listChannelFlowsRequest) This is a variant oflistChannelFlows(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsRequest)
operation.listChannelMemberships
(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest) Lists all channel memberships in a channel.listChannelMemberships
(ListChannelMembershipsRequest listChannelMembershipsRequest) Lists all channel memberships in a channel.listChannelMembershipsForAppInstanceUser
(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest) Lists all channels that anAppInstanceUser
orAppInstanceBot
is a part of.listChannelMembershipsForAppInstanceUser
(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest) Lists all channels that anAppInstanceUser
orAppInstanceBot
is a part of.listChannelMembershipsForAppInstanceUserPaginator
(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest) listChannelMembershipsForAppInstanceUserPaginator
(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest) default ListChannelMembershipsPublisher
listChannelMembershipsPaginator
(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest) This is a variant oflistChannelMemberships(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsRequest)
operation.default ListChannelMembershipsPublisher
listChannelMembershipsPaginator
(ListChannelMembershipsRequest listChannelMembershipsRequest) This is a variant oflistChannelMemberships(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsRequest)
operation.listChannelMessages
(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest) List all the messages in a channel.listChannelMessages
(ListChannelMessagesRequest listChannelMessagesRequest) List all the messages in a channel.default ListChannelMessagesPublisher
listChannelMessagesPaginator
(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest) This is a variant oflistChannelMessages(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesRequest)
operation.default ListChannelMessagesPublisher
listChannelMessagesPaginator
(ListChannelMessagesRequest listChannelMessagesRequest) This is a variant oflistChannelMessages(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesRequest)
operation.listChannelModerators
(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest) Lists all the moderators for a channel.listChannelModerators
(ListChannelModeratorsRequest listChannelModeratorsRequest) Lists all the moderators for a channel.default ListChannelModeratorsPublisher
listChannelModeratorsPaginator
(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest) This is a variant oflistChannelModerators(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsRequest)
operation.default ListChannelModeratorsPublisher
listChannelModeratorsPaginator
(ListChannelModeratorsRequest listChannelModeratorsRequest) This is a variant oflistChannelModerators(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsRequest)
operation.default CompletableFuture
<ListChannelsResponse> listChannels
(Consumer<ListChannelsRequest.Builder> listChannelsRequest) Lists all Channels created under a single Chime App as a paginated list.default CompletableFuture
<ListChannelsResponse> listChannels
(ListChannelsRequest listChannelsRequest) Lists all Channels created under a single Chime App as a paginated list.listChannelsAssociatedWithChannelFlow
(Consumer<ListChannelsAssociatedWithChannelFlowRequest.Builder> listChannelsAssociatedWithChannelFlowRequest) Lists all channels associated with a specified channel flow.listChannelsAssociatedWithChannelFlow
(ListChannelsAssociatedWithChannelFlowRequest listChannelsAssociatedWithChannelFlowRequest) Lists all channels associated with a specified channel flow.listChannelsAssociatedWithChannelFlowPaginator
(Consumer<ListChannelsAssociatedWithChannelFlowRequest.Builder> listChannelsAssociatedWithChannelFlowRequest) listChannelsAssociatedWithChannelFlowPaginator
(ListChannelsAssociatedWithChannelFlowRequest listChannelsAssociatedWithChannelFlowRequest) listChannelsModeratedByAppInstanceUser
(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest) A list of the channels moderated by anAppInstanceUser
.listChannelsModeratedByAppInstanceUser
(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest) A list of the channels moderated by anAppInstanceUser
.listChannelsModeratedByAppInstanceUserPaginator
(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest) listChannelsModeratedByAppInstanceUserPaginator
(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest) default ListChannelsPublisher
listChannelsPaginator
(Consumer<ListChannelsRequest.Builder> listChannelsRequest) This is a variant oflistChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsRequest)
operation.default ListChannelsPublisher
listChannelsPaginator
(ListChannelsRequest listChannelsRequest) This is a variant oflistChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsRequest)
operation.default CompletableFuture
<ListSubChannelsResponse> listSubChannels
(Consumer<ListSubChannelsRequest.Builder> listSubChannelsRequest) Lists all the SubChannels in an elastic channel when given a channel ID.default CompletableFuture
<ListSubChannelsResponse> listSubChannels
(ListSubChannelsRequest listSubChannelsRequest) Lists all the SubChannels in an elastic channel when given a channel ID.default ListSubChannelsPublisher
listSubChannelsPaginator
(Consumer<ListSubChannelsRequest.Builder> listSubChannelsRequest) This is a variant oflistSubChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsRequest)
operation.default ListSubChannelsPublisher
listSubChannelsPaginator
(ListSubChannelsRequest listSubChannelsRequest) This is a variant oflistSubChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags applied to an Amazon Chime SDK messaging resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags applied to an Amazon Chime SDK messaging resource.putChannelExpirationSettings
(Consumer<PutChannelExpirationSettingsRequest.Builder> putChannelExpirationSettingsRequest) Sets the number of days before the channel is automatically deleted.putChannelExpirationSettings
(PutChannelExpirationSettingsRequest putChannelExpirationSettingsRequest) Sets the number of days before the channel is automatically deleted.putChannelMembershipPreferences
(Consumer<PutChannelMembershipPreferencesRequest.Builder> putChannelMembershipPreferencesRequest) Sets the membership preferences of anAppInstanceUser
orAppInstanceBot
for the specified channel.putChannelMembershipPreferences
(PutChannelMembershipPreferencesRequest putChannelMembershipPreferencesRequest) Sets the membership preferences of anAppInstanceUser
orAppInstanceBot
for the specified channel.putMessagingStreamingConfigurations
(Consumer<PutMessagingStreamingConfigurationsRequest.Builder> putMessagingStreamingConfigurationsRequest) Sets the data streaming configuration for anAppInstance
.putMessagingStreamingConfigurations
(PutMessagingStreamingConfigurationsRequest putMessagingStreamingConfigurationsRequest) Sets the data streaming configuration for anAppInstance
.redactChannelMessage
(Consumer<RedactChannelMessageRequest.Builder> redactChannelMessageRequest) Redacts message content, but not metadata.redactChannelMessage
(RedactChannelMessageRequest redactChannelMessageRequest) Redacts message content, but not metadata.default CompletableFuture
<SearchChannelsResponse> searchChannels
(Consumer<SearchChannelsRequest.Builder> searchChannelsRequest) Allows theChimeBearer
to search channels by channel members.default CompletableFuture
<SearchChannelsResponse> searchChannels
(SearchChannelsRequest searchChannelsRequest) Allows theChimeBearer
to search channels by channel members.default SearchChannelsPublisher
searchChannelsPaginator
(Consumer<SearchChannelsRequest.Builder> searchChannelsRequest) This is a variant ofsearchChannels(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsRequest)
operation.default SearchChannelsPublisher
searchChannelsPaginator
(SearchChannelsRequest searchChannelsRequest) This is a variant ofsearchChannels(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsRequest)
operation.sendChannelMessage
(Consumer<SendChannelMessageRequest.Builder> sendChannelMessageRequest) Sends a message to a particular channel that the member is a part of.sendChannelMessage
(SendChannelMessageRequest sendChannelMessageRequest) Sends a message to a particular channel that the member is a part of.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 messaging resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Applies the specified tags to the specified Amazon Chime SDK messaging resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified Amazon Chime SDK messaging resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified Amazon Chime SDK messaging resource.default CompletableFuture
<UpdateChannelResponse> updateChannel
(Consumer<UpdateChannelRequest.Builder> updateChannelRequest) Update a channel's attributes.default CompletableFuture
<UpdateChannelResponse> updateChannel
(UpdateChannelRequest updateChannelRequest) Update a channel's attributes.updateChannelFlow
(Consumer<UpdateChannelFlowRequest.Builder> updateChannelFlowRequest) Updates channel flow attributes.updateChannelFlow
(UpdateChannelFlowRequest updateChannelFlowRequest) Updates channel flow attributes.updateChannelMessage
(Consumer<UpdateChannelMessageRequest.Builder> updateChannelMessageRequest) Updates the content of a message.updateChannelMessage
(UpdateChannelMessageRequest updateChannelMessageRequest) Updates the content of a message.updateChannelReadMarker
(Consumer<UpdateChannelReadMarkerRequest.Builder> updateChannelReadMarkerRequest) The details of the time when a user last read messages in a channel.updateChannelReadMarker
(UpdateChannelReadMarkerRequest updateChannelReadMarkerRequest) The details of the time when a user last read messages in a channel.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods 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
-
associateChannelFlow
default CompletableFuture<AssociateChannelFlowResponse> associateChannelFlow(AssociateChannelFlowRequest associateChannelFlowRequest) Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the
DisassociateChannelFlow
API.Only administrators or channel moderators can associate a channel flow. The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
associateChannelFlowRequest
-- Returns:
- A Java Future containing the result of the AssociateChannelFlow 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.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateChannelFlow
default CompletableFuture<AssociateChannelFlowResponse> associateChannelFlow(Consumer<AssociateChannelFlowRequest.Builder> associateChannelFlowRequest) Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the
DisassociateChannelFlow
API.Only administrators or channel moderators can associate a channel flow. The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
AssociateChannelFlowRequest.Builder
avoiding the need to create one manually viaAssociateChannelFlowRequest.builder()
- Parameters:
associateChannelFlowRequest
- AConsumer
that will call methods onAssociateChannelFlowRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateChannelFlow 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.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchCreateChannelMembership
default CompletableFuture<BatchCreateChannelMembershipResponse> batchCreateChannelMembership(BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest) Adds a specified number of users and bots to a channel.
- Parameters:
batchCreateChannelMembershipRequest
-- Returns:
- A Java Future containing the result of the BatchCreateChannelMembership 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.- ServiceFailureException The service encountered an unexpected error.
- ServiceUnavailableException The service is currently unavailable.
- UnauthorizedClientException The client is not currently authorized to make the request.
- BadRequestException The input parameters don't match the service's restrictions.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchCreateChannelMembership
default CompletableFuture<BatchCreateChannelMembershipResponse> batchCreateChannelMembership(Consumer<BatchCreateChannelMembershipRequest.Builder> batchCreateChannelMembershipRequest) Adds a specified number of users and bots to a channel.
This is a convenience which creates an instance of the
BatchCreateChannelMembershipRequest.Builder
avoiding the need to create one manually viaBatchCreateChannelMembershipRequest.builder()
- Parameters:
batchCreateChannelMembershipRequest
- AConsumer
that will call methods onBatchCreateChannelMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchCreateChannelMembership 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.- ServiceFailureException The service encountered an unexpected error.
- ServiceUnavailableException The service is currently unavailable.
- UnauthorizedClientException The client is not currently authorized to make the request.
- BadRequestException The input parameters don't match the service's restrictions.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
channelFlowCallback
default CompletableFuture<ChannelFlowCallbackResponse> channelFlowCallback(ChannelFlowCallbackRequest channelFlowCallbackRequest) Calls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.
You can return one of the following processing responses:
-
Update message content or metadata
-
Deny a message
-
Make no changes to the message
- Parameters:
channelFlowCallbackRequest
-- Returns:
- A Java Future containing the result of the ChannelFlowCallback 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
channelFlowCallback
default CompletableFuture<ChannelFlowCallbackResponse> channelFlowCallback(Consumer<ChannelFlowCallbackRequest.Builder> channelFlowCallbackRequest) Calls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.
You can return one of the following processing responses:
-
Update message content or metadata
-
Deny a message
-
Make no changes to the message
This is a convenience which creates an instance of the
ChannelFlowCallbackRequest.Builder
avoiding the need to create one manually viaChannelFlowCallbackRequest.builder()
- Parameters:
channelFlowCallbackRequest
- AConsumer
that will call methods onChannelFlowCallbackRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ChannelFlowCallback 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createChannel
default CompletableFuture<CreateChannelResponse> createChannel(CreateChannelRequest createChannelRequest) Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
createChannelRequest
-- Returns:
- A Java Future containing the result of the CreateChannel 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChannel
default CompletableFuture<CreateChannelResponse> createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest) Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
CreateChannelRequest.Builder
avoiding the need to create one manually viaCreateChannelRequest.builder()
- Parameters:
createChannelRequest
- AConsumer
that will call methods onCreateChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateChannel 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChannelBan
default CompletableFuture<CreateChannelBanResponse> createChannelBan(CreateChannelBanRequest createChannelBanRequest) Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to
DeleteChannelBan
, and thenCreateChannelMembership
. Bans are cleaned up when you delete users or channels.If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
createChannelBanRequest
-- Returns:
- A Java Future containing the result of the CreateChannelBan 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChannelBan
default CompletableFuture<CreateChannelBanResponse> createChannelBan(Consumer<CreateChannelBanRequest.Builder> createChannelBanRequest) Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to
DeleteChannelBan
, and thenCreateChannelMembership
. Bans are cleaned up when you delete users or channels.If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
CreateChannelBanRequest.Builder
avoiding the need to create one manually viaCreateChannelBanRequest.builder()
- Parameters:
createChannelBanRequest
- AConsumer
that will call methods onCreateChannelBanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateChannelBan 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChannelFlow
default CompletableFuture<CreateChannelFlowResponse> createChannelFlow(CreateChannelFlowRequest createChannelFlowRequest) Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.
Channel flows process the following items:
-
New and updated messages
-
Persistent and non-persistent messages
-
The Standard message type
Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to Message types in the Amazon Chime developer guide.
- Parameters:
createChannelFlowRequest
-- Returns:
- A Java Future containing the result of the CreateChannelFlow 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createChannelFlow
default CompletableFuture<CreateChannelFlowResponse> createChannelFlow(Consumer<CreateChannelFlowRequest.Builder> createChannelFlowRequest) Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.
Channel flows process the following items:
-
New and updated messages
-
Persistent and non-persistent messages
-
The Standard message type
Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to Message types in the Amazon Chime developer guide.
This is a convenience which creates an instance of the
CreateChannelFlowRequest.Builder
avoiding the need to create one manually viaCreateChannelFlowRequest.builder()
- Parameters:
createChannelFlowRequest
- AConsumer
that will call methods onCreateChannelFlowRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateChannelFlow 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createChannelMembership
default CompletableFuture<CreateChannelMembershipResponse> createChannelMembership(CreateChannelMembershipRequest createChannelMembershipRequest) Adds a member to a channel. The
InvitedBy
field inChannelMembership
is derived from the request header. A channel member can:-
List messages
-
Send messages
-
Receive messages
-
Edit their own messages
-
Leave the channel
Privacy settings impact this action as follows:
-
Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
-
Private Channels: You must be a member to list or send messages.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUserArn
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
createChannelMembershipRequest
-- Returns:
- A Java Future containing the result of the CreateChannelMembership 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.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createChannelMembership
default CompletableFuture<CreateChannelMembershipResponse> createChannelMembership(Consumer<CreateChannelMembershipRequest.Builder> createChannelMembershipRequest) Adds a member to a channel. The
InvitedBy
field inChannelMembership
is derived from the request header. A channel member can:-
List messages
-
Send messages
-
Receive messages
-
Edit their own messages
-
Leave the channel
Privacy settings impact this action as follows:
-
Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
-
Private Channels: You must be a member to list or send messages.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUserArn
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
CreateChannelMembershipRequest.Builder
avoiding the need to create one manually viaCreateChannelMembershipRequest.builder()
- Parameters:
createChannelMembershipRequest
- AConsumer
that will call methods onCreateChannelMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateChannelMembership 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.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createChannelModerator
default CompletableFuture<CreateChannelModeratorResponse> createChannelModerator(CreateChannelModeratorRequest createChannelModeratorRequest) Creates a new
ChannelModerator
. A channel moderator can:-
Add and remove other members of the channel.
-
Add and remove other moderators of the channel.
-
Add and remove user bans for the channel.
-
Redact messages in the channel.
-
List messages in the channel.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
of the user that makes the API call as the value in the header.- Parameters:
createChannelModeratorRequest
-- Returns:
- A Java Future containing the result of the CreateChannelModerator 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createChannelModerator
default CompletableFuture<CreateChannelModeratorResponse> createChannelModerator(Consumer<CreateChannelModeratorRequest.Builder> createChannelModeratorRequest) Creates a new
ChannelModerator
. A channel moderator can:-
Add and remove other members of the channel.
-
Add and remove other moderators of the channel.
-
Add and remove user bans for the channel.
-
Redact messages in the channel.
-
List messages in the channel.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
of the user that makes the API call as the value in the header.
This is a convenience which creates an instance of the
CreateChannelModeratorRequest.Builder
avoiding the need to create one manually viaCreateChannelModeratorRequest.builder()
- Parameters:
createChannelModeratorRequest
- AConsumer
that will call methods onCreateChannelModeratorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateChannelModerator 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteChannel
default CompletableFuture<DeleteChannelResponse> deleteChannel(DeleteChannelRequest deleteChannelRequest) Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUserArn
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
deleteChannelRequest
-- Returns:
- A Java Future containing the result of the DeleteChannel 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannel
default CompletableFuture<DeleteChannelResponse> deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest) Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUserArn
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
DeleteChannelRequest.Builder
avoiding the need to create one manually viaDeleteChannelRequest.builder()
- Parameters:
deleteChannelRequest
- AConsumer
that will call methods onDeleteChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannel 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannelBan
default CompletableFuture<DeleteChannelBanResponse> deleteChannelBan(DeleteChannelBanRequest deleteChannelBanRequest) Removes a member from a channel's ban list.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
deleteChannelBanRequest
-- Returns:
- A Java Future containing the result of the DeleteChannelBan 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannelBan
default CompletableFuture<DeleteChannelBanResponse> deleteChannelBan(Consumer<DeleteChannelBanRequest.Builder> deleteChannelBanRequest) Removes a member from a channel's ban list.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
DeleteChannelBanRequest.Builder
avoiding the need to create one manually viaDeleteChannelBanRequest.builder()
- Parameters:
deleteChannelBanRequest
- AConsumer
that will call methods onDeleteChannelBanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannelBan 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannelFlow
default CompletableFuture<DeleteChannelFlowResponse> deleteChannelFlow(DeleteChannelFlowRequest deleteChannelFlowRequest) Deletes a channel flow, an irreversible process. This is a developer API.
This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the
ListChannelsAssociatedWithChannelFlow
API. Use theDisassociateChannelFlow
API to disassociate a channel flow from all channels.- Parameters:
deleteChannelFlowRequest
-- Returns:
- A Java Future containing the result of the DeleteChannelFlow 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannelFlow
default CompletableFuture<DeleteChannelFlowResponse> deleteChannelFlow(Consumer<DeleteChannelFlowRequest.Builder> deleteChannelFlowRequest) Deletes a channel flow, an irreversible process. This is a developer API.
This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the
ListChannelsAssociatedWithChannelFlow
API. Use theDisassociateChannelFlow
API to disassociate a channel flow from all channels.
This is a convenience which creates an instance of the
DeleteChannelFlowRequest.Builder
avoiding the need to create one manually viaDeleteChannelFlowRequest.builder()
- Parameters:
deleteChannelFlowRequest
- AConsumer
that will call methods onDeleteChannelFlowRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannelFlow 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannelMembership
default CompletableFuture<DeleteChannelMembershipResponse> deleteChannelMembership(DeleteChannelMembershipRequest deleteChannelMembershipRequest) Removes a member from a channel.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
of the user that makes the API call as the value in the header.- Parameters:
deleteChannelMembershipRequest
-- Returns:
- A Java Future containing the result of the DeleteChannelMembership 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannelMembership
default CompletableFuture<DeleteChannelMembershipResponse> deleteChannelMembership(Consumer<DeleteChannelMembershipRequest.Builder> deleteChannelMembershipRequest) Removes a member from a channel.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
of the user that makes the API call as the value in the header.
This is a convenience which creates an instance of the
DeleteChannelMembershipRequest.Builder
avoiding the need to create one manually viaDeleteChannelMembershipRequest.builder()
- Parameters:
deleteChannelMembershipRequest
- AConsumer
that will call methods onDeleteChannelMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannelMembership 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannelMessage
default CompletableFuture<DeleteChannelMessageResponse> deleteChannelMessage(DeleteChannelMessageRequest deleteChannelMessageRequest) Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by
UpdateChannelMessage
.The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
deleteChannelMessageRequest
-- Returns:
- A Java Future containing the result of the DeleteChannelMessage 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannelMessage
default CompletableFuture<DeleteChannelMessageResponse> deleteChannelMessage(Consumer<DeleteChannelMessageRequest.Builder> deleteChannelMessageRequest) Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by
UpdateChannelMessage
.The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
DeleteChannelMessageRequest.Builder
avoiding the need to create one manually viaDeleteChannelMessageRequest.builder()
- Parameters:
deleteChannelMessageRequest
- AConsumer
that will call methods onDeleteChannelMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannelMessage 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannelModerator
default CompletableFuture<DeleteChannelModeratorResponse> deleteChannelModerator(DeleteChannelModeratorRequest deleteChannelModeratorRequest) Deletes a channel moderator.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
deleteChannelModeratorRequest
-- Returns:
- A Java Future containing the result of the DeleteChannelModerator 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannelModerator
default CompletableFuture<DeleteChannelModeratorResponse> deleteChannelModerator(Consumer<DeleteChannelModeratorRequest.Builder> deleteChannelModeratorRequest) Deletes a channel moderator.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
DeleteChannelModeratorRequest.Builder
avoiding the need to create one manually viaDeleteChannelModeratorRequest.builder()
- Parameters:
deleteChannelModeratorRequest
- AConsumer
that will call methods onDeleteChannelModeratorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannelModerator 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMessagingStreamingConfigurations
default CompletableFuture<DeleteMessagingStreamingConfigurationsResponse> deleteMessagingStreamingConfigurations(DeleteMessagingStreamingConfigurationsRequest deleteMessagingStreamingConfigurationsRequest) Deletes the streaming configurations for an
AppInstance
. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.- Parameters:
deleteMessagingStreamingConfigurationsRequest
-- Returns:
- A Java Future containing the result of the DeleteMessagingStreamingConfigurations 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMessagingStreamingConfigurations
default CompletableFuture<DeleteMessagingStreamingConfigurationsResponse> deleteMessagingStreamingConfigurations(Consumer<DeleteMessagingStreamingConfigurationsRequest.Builder> deleteMessagingStreamingConfigurationsRequest) Deletes the streaming configurations for an
AppInstance
. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.
This is a convenience which creates an instance of the
DeleteMessagingStreamingConfigurationsRequest.Builder
avoiding the need to create one manually viaDeleteMessagingStreamingConfigurationsRequest.builder()
- Parameters:
deleteMessagingStreamingConfigurationsRequest
- AConsumer
that will call methods onDeleteMessagingStreamingConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMessagingStreamingConfigurations 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeChannel
default CompletableFuture<DescribeChannelResponse> describeChannel(DescribeChannelRequest describeChannelRequest) Returns the full details of a channel in an Amazon Chime
AppInstance
.The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
describeChannelRequest
-- Returns:
- A Java Future containing the result of the DescribeChannel 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeChannel
default CompletableFuture<DescribeChannelResponse> describeChannel(Consumer<DescribeChannelRequest.Builder> describeChannelRequest) Returns the full details of a channel in an Amazon Chime
AppInstance
.The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
DescribeChannelRequest.Builder
avoiding the need to create one manually viaDescribeChannelRequest.builder()
- Parameters:
describeChannelRequest
- AConsumer
that will call methods onDescribeChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeChannel 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeChannelBan
default CompletableFuture<DescribeChannelBanResponse> describeChannelBan(DescribeChannelBanRequest describeChannelBanRequest) Returns the full details of a channel ban.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
describeChannelBanRequest
-- Returns:
- A Java Future containing the result of the DescribeChannelBan 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.
- NotFoundException One or more of the resources in the request does not exist in the system.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeChannelBan
default CompletableFuture<DescribeChannelBanResponse> describeChannelBan(Consumer<DescribeChannelBanRequest.Builder> describeChannelBanRequest) Returns the full details of a channel ban.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
DescribeChannelBanRequest.Builder
avoiding the need to create one manually viaDescribeChannelBanRequest.builder()
- Parameters:
describeChannelBanRequest
- AConsumer
that will call methods onDescribeChannelBanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeChannelBan 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.
- NotFoundException One or more of the resources in the request does not exist in the system.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeChannelFlow
default CompletableFuture<DescribeChannelFlowResponse> describeChannelFlow(DescribeChannelFlowRequest describeChannelFlowRequest) Returns the full details of a channel flow in an Amazon Chime
AppInstance
. This is a developer API.- Parameters:
describeChannelFlowRequest
-- Returns:
- A Java Future containing the result of the DescribeChannelFlow 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeChannelFlow
default CompletableFuture<DescribeChannelFlowResponse> describeChannelFlow(Consumer<DescribeChannelFlowRequest.Builder> describeChannelFlowRequest) Returns the full details of a channel flow in an Amazon Chime
AppInstance
. This is a developer API.
This is a convenience which creates an instance of the
DescribeChannelFlowRequest.Builder
avoiding the need to create one manually viaDescribeChannelFlowRequest.builder()
- Parameters:
describeChannelFlowRequest
- AConsumer
that will call methods onDescribeChannelFlowRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeChannelFlow 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeChannelMembership
default CompletableFuture<DescribeChannelMembershipResponse> describeChannelMembership(DescribeChannelMembershipRequest describeChannelMembershipRequest) Returns the full details of a user's channel membership.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
describeChannelMembershipRequest
-- Returns:
- A Java Future containing the result of the DescribeChannelMembership 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.
- NotFoundException One or more of the resources in the request does not exist in the system.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeChannelMembership
default CompletableFuture<DescribeChannelMembershipResponse> describeChannelMembership(Consumer<DescribeChannelMembershipRequest.Builder> describeChannelMembershipRequest) Returns the full details of a user's channel membership.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
DescribeChannelMembershipRequest.Builder
avoiding the need to create one manually viaDescribeChannelMembershipRequest.builder()
- Parameters:
describeChannelMembershipRequest
- AConsumer
that will call methods onDescribeChannelMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeChannelMembership 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.
- NotFoundException One or more of the resources in the request does not exist in the system.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeChannelMembershipForAppInstanceUser
default CompletableFuture<DescribeChannelMembershipForAppInstanceUserResponse> describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest describeChannelMembershipForAppInstanceUserRequest) Returns the details of a channel based on the membership of the specified
AppInstanceUser
orAppInstanceBot
.The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
describeChannelMembershipForAppInstanceUserRequest
-- Returns:
- A Java Future containing the result of the DescribeChannelMembershipForAppInstanceUser 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeChannelMembershipForAppInstanceUser
default CompletableFuture<DescribeChannelMembershipForAppInstanceUserResponse> describeChannelMembershipForAppInstanceUser(Consumer<DescribeChannelMembershipForAppInstanceUserRequest.Builder> describeChannelMembershipForAppInstanceUserRequest) Returns the details of a channel based on the membership of the specified
AppInstanceUser
orAppInstanceBot
.The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
DescribeChannelMembershipForAppInstanceUserRequest.Builder
avoiding the need to create one manually viaDescribeChannelMembershipForAppInstanceUserRequest.builder()
- Parameters:
describeChannelMembershipForAppInstanceUserRequest
- AConsumer
that will call methods onDescribeChannelMembershipForAppInstanceUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeChannelMembershipForAppInstanceUser 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeChannelModeratedByAppInstanceUser
default CompletableFuture<DescribeChannelModeratedByAppInstanceUserResponse> describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest describeChannelModeratedByAppInstanceUserRequest) Returns the full details of a channel moderated by the specified
AppInstanceUser
orAppInstanceBot
.The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
describeChannelModeratedByAppInstanceUserRequest
-- Returns:
- A Java Future containing the result of the DescribeChannelModeratedByAppInstanceUser 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeChannelModeratedByAppInstanceUser
default CompletableFuture<DescribeChannelModeratedByAppInstanceUserResponse> describeChannelModeratedByAppInstanceUser(Consumer<DescribeChannelModeratedByAppInstanceUserRequest.Builder> describeChannelModeratedByAppInstanceUserRequest) Returns the full details of a channel moderated by the specified
AppInstanceUser
orAppInstanceBot
.The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
DescribeChannelModeratedByAppInstanceUserRequest.Builder
avoiding the need to create one manually viaDescribeChannelModeratedByAppInstanceUserRequest.builder()
- Parameters:
describeChannelModeratedByAppInstanceUserRequest
- AConsumer
that will call methods onDescribeChannelModeratedByAppInstanceUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeChannelModeratedByAppInstanceUser 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeChannelModerator
default CompletableFuture<DescribeChannelModeratorResponse> describeChannelModerator(DescribeChannelModeratorRequest describeChannelModeratorRequest) Returns the full details of a single ChannelModerator.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
of the user that makes the API call as the value in the header.- Parameters:
describeChannelModeratorRequest
-- Returns:
- A Java Future containing the result of the DescribeChannelModerator 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.
- NotFoundException One or more of the resources in the request does not exist in the system.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeChannelModerator
default CompletableFuture<DescribeChannelModeratorResponse> describeChannelModerator(Consumer<DescribeChannelModeratorRequest.Builder> describeChannelModeratorRequest) Returns the full details of a single ChannelModerator.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
of the user that makes the API call as the value in the header.
This is a convenience which creates an instance of the
DescribeChannelModeratorRequest.Builder
avoiding the need to create one manually viaDescribeChannelModeratorRequest.builder()
- Parameters:
describeChannelModeratorRequest
- AConsumer
that will call methods onDescribeChannelModeratorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeChannelModerator 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.
- NotFoundException One or more of the resources in the request does not exist in the system.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateChannelFlow
default CompletableFuture<DisassociateChannelFlowResponse> disassociateChannelFlow(DisassociateChannelFlowRequest disassociateChannelFlowRequest) Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor.
Only administrators or channel moderators can disassociate a channel flow.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
disassociateChannelFlowRequest
-- Returns:
- A Java Future containing the result of the DisassociateChannelFlow 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.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateChannelFlow
default CompletableFuture<DisassociateChannelFlowResponse> disassociateChannelFlow(Consumer<DisassociateChannelFlowRequest.Builder> disassociateChannelFlowRequest) Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor.
Only administrators or channel moderators can disassociate a channel flow.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
DisassociateChannelFlowRequest.Builder
avoiding the need to create one manually viaDisassociateChannelFlowRequest.builder()
- Parameters:
disassociateChannelFlowRequest
- AConsumer
that will call methods onDisassociateChannelFlowRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateChannelFlow 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.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChannelMembershipPreferences
default CompletableFuture<GetChannelMembershipPreferencesResponse> getChannelMembershipPreferences(GetChannelMembershipPreferencesRequest getChannelMembershipPreferencesRequest) Gets the membership preferences of an
AppInstanceUser
orAppInstanceBot
for the specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve membership preferences. Users or bots in theAppInstanceAdmin
and channel moderator roles can't retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the channel from which they are banned.The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
getChannelMembershipPreferencesRequest
-- Returns:
- A Java Future containing the result of the GetChannelMembershipPreferences 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.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ForbiddenException The client is permanently forbidden from making 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChannelMembershipPreferences
default CompletableFuture<GetChannelMembershipPreferencesResponse> getChannelMembershipPreferences(Consumer<GetChannelMembershipPreferencesRequest.Builder> getChannelMembershipPreferencesRequest) Gets the membership preferences of an
AppInstanceUser
orAppInstanceBot
for the specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve membership preferences. Users or bots in theAppInstanceAdmin
and channel moderator roles can't retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the channel from which they are banned.The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
GetChannelMembershipPreferencesRequest.Builder
avoiding the need to create one manually viaGetChannelMembershipPreferencesRequest.builder()
- Parameters:
getChannelMembershipPreferencesRequest
- AConsumer
that will call methods onGetChannelMembershipPreferencesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetChannelMembershipPreferences 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.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ForbiddenException The client is permanently forbidden from making 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChannelMessage
default CompletableFuture<GetChannelMessageResponse> getChannelMessage(GetChannelMessageRequest getChannelMessageRequest) Gets the full details of a channel message.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
getChannelMessageRequest
-- Returns:
- A Java Future containing the result of the GetChannelMessage 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.
- NotFoundException One or more of the resources in the request does not exist in the system.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChannelMessage
default CompletableFuture<GetChannelMessageResponse> getChannelMessage(Consumer<GetChannelMessageRequest.Builder> getChannelMessageRequest) Gets the full details of a channel message.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
GetChannelMessageRequest.Builder
avoiding the need to create one manually viaGetChannelMessageRequest.builder()
- Parameters:
getChannelMessageRequest
- AConsumer
that will call methods onGetChannelMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetChannelMessage 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.
- NotFoundException One or more of the resources in the request does not exist in the system.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChannelMessageStatus
default CompletableFuture<GetChannelMessageStatusResponse> getChannelMessageStatus(GetChannelMessageStatusRequest getChannelMessageStatusRequest) Gets message status for a specified
messageId
. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket.Messages can have any one of these statuses.
- SENT
-
Message processed successfully
- PENDING
-
Ongoing processing
- FAILED
-
Processing failed
- DENIED
-
Message denied by the processor
-
This API does not return statuses for denied messages, because we don't store them once the processor denies them.
-
Only the message sender can invoke this API.
-
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
- Parameters:
getChannelMessageStatusRequest
-- Returns:
- A Java Future containing the result of the GetChannelMessageStatus 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChannelMessageStatus
default CompletableFuture<GetChannelMessageStatusResponse> getChannelMessageStatus(Consumer<GetChannelMessageStatusRequest.Builder> getChannelMessageStatusRequest) Gets message status for a specified
messageId
. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket.Messages can have any one of these statuses.
- SENT
-
Message processed successfully
- PENDING
-
Ongoing processing
- FAILED
-
Processing failed
- DENIED
-
Message denied by the processor
-
This API does not return statuses for denied messages, because we don't store them once the processor denies them.
-
Only the message sender can invoke this API.
-
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
GetChannelMessageStatusRequest.Builder
avoiding the need to create one manually viaGetChannelMessageStatusRequest.builder()
- Parameters:
getChannelMessageStatusRequest
- AConsumer
that will call methods onGetChannelMessageStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetChannelMessageStatus 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMessagingSessionEndpoint
default CompletableFuture<GetMessagingSessionEndpointResponse> getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest) The details of the endpoint for the messaging session.
- Parameters:
getMessagingSessionEndpointRequest
-- Returns:
- A Java Future containing the result of the GetMessagingSessionEndpoint 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.- UnauthorizedClientException The client is not currently authorized to make the request.
- ForbiddenException The client is permanently forbidden from making 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMessagingSessionEndpoint
default CompletableFuture<GetMessagingSessionEndpointResponse> getMessagingSessionEndpoint(Consumer<GetMessagingSessionEndpointRequest.Builder> getMessagingSessionEndpointRequest) The details of the endpoint for the messaging session.
This is a convenience which creates an instance of the
GetMessagingSessionEndpointRequest.Builder
avoiding the need to create one manually viaGetMessagingSessionEndpointRequest.builder()
- Parameters:
getMessagingSessionEndpointRequest
- AConsumer
that will call methods onGetMessagingSessionEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMessagingSessionEndpoint 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.- UnauthorizedClientException The client is not currently authorized to make the request.
- ForbiddenException The client is permanently forbidden from making 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMessagingStreamingConfigurations
default CompletableFuture<GetMessagingStreamingConfigurationsResponse> getMessagingStreamingConfigurations(GetMessagingStreamingConfigurationsRequest getMessagingStreamingConfigurationsRequest) Retrieves the data streaming configuration for an
AppInstance
. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.- Parameters:
getMessagingStreamingConfigurationsRequest
-- Returns:
- A Java Future containing the result of the GetMessagingStreamingConfigurations 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.
- NotFoundException One or more of the resources in the request does not exist in the system.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMessagingStreamingConfigurations
default CompletableFuture<GetMessagingStreamingConfigurationsResponse> getMessagingStreamingConfigurations(Consumer<GetMessagingStreamingConfigurationsRequest.Builder> getMessagingStreamingConfigurationsRequest) Retrieves the data streaming configuration for an
AppInstance
. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.
This is a convenience which creates an instance of the
GetMessagingStreamingConfigurationsRequest.Builder
avoiding the need to create one manually viaGetMessagingStreamingConfigurationsRequest.builder()
- Parameters:
getMessagingStreamingConfigurationsRequest
- AConsumer
that will call methods onGetMessagingStreamingConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMessagingStreamingConfigurations 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.
- NotFoundException One or more of the resources in the request does not exist in the system.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelBans
default CompletableFuture<ListChannelBansResponse> listChannelBans(ListChannelBansRequest listChannelBansRequest) Lists all the users and bots banned from a particular channel.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
listChannelBansRequest
-- Returns:
- A Java Future containing the result of the ListChannelBans 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelBans
default CompletableFuture<ListChannelBansResponse> listChannelBans(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest) Lists all the users and bots banned from a particular channel.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
ListChannelBansRequest.Builder
avoiding the need to create one manually viaListChannelBansRequest.builder()
- Parameters:
listChannelBansRequest
- AConsumer
that will call methods onListChannelBansRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannelBans 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelBansPaginator
default ListChannelBansPublisher listChannelBansPaginator(ListChannelBansRequest listChannelBansRequest) This is a variant of
listChannelBans(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansPublisher publisher = client.listChannelBansPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansPublisher publisher = client.listChannelBansPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansResponse 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
listChannelBans(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansRequest)
operation.- Parameters:
listChannelBansRequest
-- 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelBansPaginator
default ListChannelBansPublisher listChannelBansPaginator(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest) This is a variant of
listChannelBans(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansPublisher publisher = client.listChannelBansPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansPublisher publisher = client.listChannelBansPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansResponse 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
listChannelBans(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansRequest)
operation.
This is a convenience which creates an instance of the
ListChannelBansRequest.Builder
avoiding the need to create one manually viaListChannelBansRequest.builder()
- Parameters:
listChannelBansRequest
- AConsumer
that will call methods onListChannelBansRequest.Builder
to 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelFlows
default CompletableFuture<ListChannelFlowsResponse> listChannelFlows(ListChannelFlowsRequest listChannelFlowsRequest) Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
- Parameters:
listChannelFlowsRequest
-- Returns:
- A Java Future containing the result of the ListChannelFlows 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelFlows
default CompletableFuture<ListChannelFlowsResponse> listChannelFlows(Consumer<ListChannelFlowsRequest.Builder> listChannelFlowsRequest) Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
This is a convenience which creates an instance of the
ListChannelFlowsRequest.Builder
avoiding the need to create one manually viaListChannelFlowsRequest.builder()
- Parameters:
listChannelFlowsRequest
- AConsumer
that will call methods onListChannelFlowsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannelFlows 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelFlowsPaginator
default ListChannelFlowsPublisher listChannelFlowsPaginator(ListChannelFlowsRequest listChannelFlowsRequest) This is a variant of
listChannelFlows(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelFlowsPublisher publisher = client.listChannelFlowsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelFlowsPublisher publisher = client.listChannelFlowsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsResponse 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
listChannelFlows(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsRequest)
operation.- Parameters:
listChannelFlowsRequest
-- 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelFlowsPaginator
default ListChannelFlowsPublisher listChannelFlowsPaginator(Consumer<ListChannelFlowsRequest.Builder> listChannelFlowsRequest) This is a variant of
listChannelFlows(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelFlowsPublisher publisher = client.listChannelFlowsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelFlowsPublisher publisher = client.listChannelFlowsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsResponse 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
listChannelFlows(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsRequest)
operation.
This is a convenience which creates an instance of the
ListChannelFlowsRequest.Builder
avoiding the need to create one manually viaListChannelFlowsRequest.builder()
- Parameters:
listChannelFlowsRequest
- AConsumer
that will call methods onListChannelFlowsRequest.Builder
to 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelMemberships
default CompletableFuture<ListChannelMembershipsResponse> listChannelMemberships(ListChannelMembershipsRequest listChannelMembershipsRequest) Lists all channel memberships in a channel.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
- Parameters:
listChannelMembershipsRequest
-- Returns:
- A Java Future containing the result of the ListChannelMemberships 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelMemberships
default CompletableFuture<ListChannelMembershipsResponse> listChannelMemberships(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest) Lists all channel memberships in a channel.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
This is a convenience which creates an instance of the
ListChannelMembershipsRequest.Builder
avoiding the need to create one manually viaListChannelMembershipsRequest.builder()
- Parameters:
listChannelMembershipsRequest
- AConsumer
that will call methods onListChannelMembershipsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannelMemberships 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelMembershipsForAppInstanceUser
default CompletableFuture<ListChannelMembershipsForAppInstanceUserResponse> listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest) Lists all channels that an
AppInstanceUser
orAppInstanceBot
is a part of. Only anAppInstanceAdmin
can call the API with a user ARN that is not their own.The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
listChannelMembershipsForAppInstanceUserRequest
-- Returns:
- A Java Future containing the result of the ListChannelMembershipsForAppInstanceUser 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelMembershipsForAppInstanceUser
default CompletableFuture<ListChannelMembershipsForAppInstanceUserResponse> listChannelMembershipsForAppInstanceUser(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest) Lists all channels that an
AppInstanceUser
orAppInstanceBot
is a part of. Only anAppInstanceAdmin
can call the API with a user ARN that is not their own.The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
ListChannelMembershipsForAppInstanceUserRequest.Builder
avoiding the need to create one manually viaListChannelMembershipsForAppInstanceUserRequest.builder()
- Parameters:
listChannelMembershipsForAppInstanceUserRequest
- AConsumer
that will call methods onListChannelMembershipsForAppInstanceUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannelMembershipsForAppInstanceUser 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelMembershipsForAppInstanceUserPaginator
default ListChannelMembershipsForAppInstanceUserPublisher listChannelMembershipsForAppInstanceUserPaginator(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest) This is a variant of
listChannelMembershipsForAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsForAppInstanceUserPublisher publisher = client.listChannelMembershipsForAppInstanceUserPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsForAppInstanceUserPublisher publisher = client.listChannelMembershipsForAppInstanceUserPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserResponse 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
listChannelMembershipsForAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserRequest)
operation.- Parameters:
listChannelMembershipsForAppInstanceUserRequest
-- 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelMembershipsForAppInstanceUserPaginator
default ListChannelMembershipsForAppInstanceUserPublisher listChannelMembershipsForAppInstanceUserPaginator(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest) This is a variant of
listChannelMembershipsForAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsForAppInstanceUserPublisher publisher = client.listChannelMembershipsForAppInstanceUserPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsForAppInstanceUserPublisher publisher = client.listChannelMembershipsForAppInstanceUserPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserResponse 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
listChannelMembershipsForAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserRequest)
operation.
This is a convenience which creates an instance of the
ListChannelMembershipsForAppInstanceUserRequest.Builder
avoiding the need to create one manually viaListChannelMembershipsForAppInstanceUserRequest.builder()
- Parameters:
listChannelMembershipsForAppInstanceUserRequest
- AConsumer
that will call methods onListChannelMembershipsForAppInstanceUserRequest.Builder
to 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelMembershipsPaginator
default ListChannelMembershipsPublisher listChannelMembershipsPaginator(ListChannelMembershipsRequest listChannelMembershipsRequest) This is a variant of
listChannelMemberships(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsPublisher publisher = client.listChannelMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsPublisher publisher = client.listChannelMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsResponse 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
listChannelMemberships(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsRequest)
operation.- Parameters:
listChannelMembershipsRequest
-- 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelMembershipsPaginator
default ListChannelMembershipsPublisher listChannelMembershipsPaginator(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest) This is a variant of
listChannelMemberships(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsPublisher publisher = client.listChannelMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsPublisher publisher = client.listChannelMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsResponse 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
listChannelMemberships(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsRequest)
operation.
This is a convenience which creates an instance of the
ListChannelMembershipsRequest.Builder
avoiding the need to create one manually viaListChannelMembershipsRequest.builder()
- Parameters:
listChannelMembershipsRequest
- AConsumer
that will call methods onListChannelMembershipsRequest.Builder
to 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelMessages
default CompletableFuture<ListChannelMessagesResponse> listChannelMessages(ListChannelMessagesRequest listChannelMessagesRequest) List all the messages in a channel. Returns a paginated list of
ChannelMessages
. By default, sorted by creation timestamp in descending order.Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Also, the
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
listChannelMessagesRequest
-- Returns:
- A Java Future containing the result of the ListChannelMessages 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelMessages
default CompletableFuture<ListChannelMessagesResponse> listChannelMessages(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest) List all the messages in a channel. Returns a paginated list of
ChannelMessages
. By default, sorted by creation timestamp in descending order.Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Also, the
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
ListChannelMessagesRequest.Builder
avoiding the need to create one manually viaListChannelMessagesRequest.builder()
- Parameters:
listChannelMessagesRequest
- AConsumer
that will call methods onListChannelMessagesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannelMessages 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelMessagesPaginator
default ListChannelMessagesPublisher listChannelMessagesPaginator(ListChannelMessagesRequest listChannelMessagesRequest) This is a variant of
listChannelMessages(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMessagesPublisher publisher = client.listChannelMessagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMessagesPublisher publisher = client.listChannelMessagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesResponse 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
listChannelMessages(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesRequest)
operation.- Parameters:
listChannelMessagesRequest
-- 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelMessagesPaginator
default ListChannelMessagesPublisher listChannelMessagesPaginator(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest) This is a variant of
listChannelMessages(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMessagesPublisher publisher = client.listChannelMessagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMessagesPublisher publisher = client.listChannelMessagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesResponse 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
listChannelMessages(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesRequest)
operation.
This is a convenience which creates an instance of the
ListChannelMessagesRequest.Builder
avoiding the need to create one manually viaListChannelMessagesRequest.builder()
- Parameters:
listChannelMessagesRequest
- AConsumer
that will call methods onListChannelMessagesRequest.Builder
to 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelModerators
default CompletableFuture<ListChannelModeratorsResponse> listChannelModerators(ListChannelModeratorsRequest listChannelModeratorsRequest) Lists all the moderators for a channel.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
listChannelModeratorsRequest
-- Returns:
- A Java Future containing the result of the ListChannelModerators 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelModerators
default CompletableFuture<ListChannelModeratorsResponse> listChannelModerators(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest) Lists all the moderators for a channel.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
ListChannelModeratorsRequest.Builder
avoiding the need to create one manually viaListChannelModeratorsRequest.builder()
- Parameters:
listChannelModeratorsRequest
- AConsumer
that will call methods onListChannelModeratorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannelModerators 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelModeratorsPaginator
default ListChannelModeratorsPublisher listChannelModeratorsPaginator(ListChannelModeratorsRequest listChannelModeratorsRequest) This is a variant of
listChannelModerators(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelModeratorsPublisher publisher = client.listChannelModeratorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelModeratorsPublisher publisher = client.listChannelModeratorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsResponse 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
listChannelModerators(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsRequest)
operation.- Parameters:
listChannelModeratorsRequest
-- 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelModeratorsPaginator
default ListChannelModeratorsPublisher listChannelModeratorsPaginator(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest) This is a variant of
listChannelModerators(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelModeratorsPublisher publisher = client.listChannelModeratorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelModeratorsPublisher publisher = client.listChannelModeratorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsResponse 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
listChannelModerators(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsRequest)
operation.
This is a convenience which creates an instance of the
ListChannelModeratorsRequest.Builder
avoiding the need to create one manually viaListChannelModeratorsRequest.builder()
- Parameters:
listChannelModeratorsRequest
- AConsumer
that will call methods onListChannelModeratorsRequest.Builder
to 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannels
default CompletableFuture<ListChannelsResponse> listChannels(ListChannelsRequest listChannelsRequest) Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
-
Use privacy =
PUBLIC
to retrieve all public channels in the account. -
Only an
AppInstanceAdmin
can set privacy =PRIVATE
to list the private channels in an account.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
listChannelsRequest
-- Returns:
- A Java Future containing the result of the ListChannels 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listChannels
default CompletableFuture<ListChannelsResponse> listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest) Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
-
Use privacy =
PUBLIC
to retrieve all public channels in the account. -
Only an
AppInstanceAdmin
can set privacy =PRIVATE
to list the private channels in an account.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
ListChannelsRequest.Builder
avoiding the need to create one manually viaListChannelsRequest.builder()
- Parameters:
listChannelsRequest
- AConsumer
that will call methods onListChannelsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannels 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listChannelsAssociatedWithChannelFlow
default CompletableFuture<ListChannelsAssociatedWithChannelFlowResponse> listChannelsAssociatedWithChannelFlow(ListChannelsAssociatedWithChannelFlowRequest listChannelsAssociatedWithChannelFlowRequest) Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.
- Parameters:
listChannelsAssociatedWithChannelFlowRequest
-- Returns:
- A Java Future containing the result of the ListChannelsAssociatedWithChannelFlow 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsAssociatedWithChannelFlow
default CompletableFuture<ListChannelsAssociatedWithChannelFlowResponse> listChannelsAssociatedWithChannelFlow(Consumer<ListChannelsAssociatedWithChannelFlowRequest.Builder> listChannelsAssociatedWithChannelFlowRequest) Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.
This is a convenience which creates an instance of the
ListChannelsAssociatedWithChannelFlowRequest.Builder
avoiding the need to create one manually viaListChannelsAssociatedWithChannelFlowRequest.builder()
- Parameters:
listChannelsAssociatedWithChannelFlowRequest
- AConsumer
that will call methods onListChannelsAssociatedWithChannelFlowRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannelsAssociatedWithChannelFlow 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsAssociatedWithChannelFlowPaginator
default ListChannelsAssociatedWithChannelFlowPublisher listChannelsAssociatedWithChannelFlowPaginator(ListChannelsAssociatedWithChannelFlowRequest listChannelsAssociatedWithChannelFlowRequest) This is a variant of
listChannelsAssociatedWithChannelFlow(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsAssociatedWithChannelFlowPublisher publisher = client.listChannelsAssociatedWithChannelFlowPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsAssociatedWithChannelFlowPublisher publisher = client.listChannelsAssociatedWithChannelFlowPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowResponse 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
listChannelsAssociatedWithChannelFlow(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowRequest)
operation.- Parameters:
listChannelsAssociatedWithChannelFlowRequest
-- 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsAssociatedWithChannelFlowPaginator
default ListChannelsAssociatedWithChannelFlowPublisher listChannelsAssociatedWithChannelFlowPaginator(Consumer<ListChannelsAssociatedWithChannelFlowRequest.Builder> listChannelsAssociatedWithChannelFlowRequest) This is a variant of
listChannelsAssociatedWithChannelFlow(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsAssociatedWithChannelFlowPublisher publisher = client.listChannelsAssociatedWithChannelFlowPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsAssociatedWithChannelFlowPublisher publisher = client.listChannelsAssociatedWithChannelFlowPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowResponse 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
listChannelsAssociatedWithChannelFlow(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowRequest)
operation.
This is a convenience which creates an instance of the
ListChannelsAssociatedWithChannelFlowRequest.Builder
avoiding the need to create one manually viaListChannelsAssociatedWithChannelFlowRequest.builder()
- Parameters:
listChannelsAssociatedWithChannelFlowRequest
- AConsumer
that will call methods onListChannelsAssociatedWithChannelFlowRequest.Builder
to 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsModeratedByAppInstanceUser
default CompletableFuture<ListChannelsModeratedByAppInstanceUserResponse> listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest) A list of the channels moderated by an
AppInstanceUser
.The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
listChannelsModeratedByAppInstanceUserRequest
-- Returns:
- A Java Future containing the result of the ListChannelsModeratedByAppInstanceUser 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsModeratedByAppInstanceUser
default CompletableFuture<ListChannelsModeratedByAppInstanceUserResponse> listChannelsModeratedByAppInstanceUser(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest) A list of the channels moderated by an
AppInstanceUser
.The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
ListChannelsModeratedByAppInstanceUserRequest.Builder
avoiding the need to create one manually viaListChannelsModeratedByAppInstanceUserRequest.builder()
- Parameters:
listChannelsModeratedByAppInstanceUserRequest
- AConsumer
that will call methods onListChannelsModeratedByAppInstanceUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannelsModeratedByAppInstanceUser 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsModeratedByAppInstanceUserPaginator
default ListChannelsModeratedByAppInstanceUserPublisher listChannelsModeratedByAppInstanceUserPaginator(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest) This is a variant of
listChannelsModeratedByAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsModeratedByAppInstanceUserPublisher publisher = client.listChannelsModeratedByAppInstanceUserPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsModeratedByAppInstanceUserPublisher publisher = client.listChannelsModeratedByAppInstanceUserPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserResponse 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
listChannelsModeratedByAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserRequest)
operation.- Parameters:
listChannelsModeratedByAppInstanceUserRequest
-- 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsModeratedByAppInstanceUserPaginator
default ListChannelsModeratedByAppInstanceUserPublisher listChannelsModeratedByAppInstanceUserPaginator(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest) This is a variant of
listChannelsModeratedByAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsModeratedByAppInstanceUserPublisher publisher = client.listChannelsModeratedByAppInstanceUserPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsModeratedByAppInstanceUserPublisher publisher = client.listChannelsModeratedByAppInstanceUserPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserResponse 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
listChannelsModeratedByAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserRequest)
operation.
This is a convenience which creates an instance of the
ListChannelsModeratedByAppInstanceUserRequest.Builder
avoiding the need to create one manually viaListChannelsModeratedByAppInstanceUserRequest.builder()
- Parameters:
listChannelsModeratedByAppInstanceUserRequest
- AConsumer
that will call methods onListChannelsModeratedByAppInstanceUserRequest.Builder
to 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsPaginator
This is a variant of
listChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsResponse 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
listChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsRequest)
operation.- Parameters:
listChannelsRequest
-- 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsPaginator
default ListChannelsPublisher listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest) This is a variant of
listChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsResponse 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
listChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsRequest)
operation.
This is a convenience which creates an instance of the
ListChannelsRequest.Builder
avoiding the need to create one manually viaListChannelsRequest.builder()
- Parameters:
listChannelsRequest
- AConsumer
that will call methods onListChannelsRequest.Builder
to 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubChannels
default CompletableFuture<ListSubChannelsResponse> listSubChannels(ListSubChannelsRequest listSubChannelsRequest) Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.
- Parameters:
listSubChannelsRequest
-- Returns:
- A Java Future containing the result of the ListSubChannels 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubChannels
default CompletableFuture<ListSubChannelsResponse> listSubChannels(Consumer<ListSubChannelsRequest.Builder> listSubChannelsRequest) Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.
This is a convenience which creates an instance of the
ListSubChannelsRequest.Builder
avoiding the need to create one manually viaListSubChannelsRequest.builder()
- Parameters:
listSubChannelsRequest
- AConsumer
that will call methods onListSubChannelsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSubChannels 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubChannelsPaginator
default ListSubChannelsPublisher listSubChannelsPaginator(ListSubChannelsRequest listSubChannelsRequest) This is a variant of
listSubChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListSubChannelsPublisher publisher = client.listSubChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListSubChannelsPublisher publisher = client.listSubChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsResponse 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
listSubChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsRequest)
operation.- Parameters:
listSubChannelsRequest
-- 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubChannelsPaginator
default ListSubChannelsPublisher listSubChannelsPaginator(Consumer<ListSubChannelsRequest.Builder> listSubChannelsRequest) This is a variant of
listSubChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListSubChannelsPublisher publisher = client.listSubChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListSubChannelsPublisher publisher = client.listSubChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsResponse 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
listSubChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsRequest)
operation.
This is a convenience which creates an instance of the
ListSubChannelsRequest.Builder
avoiding the need to create one manually viaListSubChannelsRequest.builder()
- Parameters:
listSubChannelsRequest
- AConsumer
that will call methods onListSubChannelsRequest.Builder
to 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.
- 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.
- ChimeSdkMessagingException 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 messaging 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.
- ChimeSdkMessagingException 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 messaging resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putChannelExpirationSettings
default CompletableFuture<PutChannelExpirationSettingsResponse> putChannelExpirationSettings(PutChannelExpirationSettingsRequest putChannelExpirationSettingsRequest) Sets the number of days before the channel is automatically deleted.
-
A background process deletes expired channels within 6 hours of expiration. Actual deletion times may vary.
-
Expired channels that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.
-
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
- Parameters:
putChannelExpirationSettingsRequest
-- Returns:
- A Java Future containing the result of the PutChannelExpirationSettings 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
putChannelExpirationSettings
default CompletableFuture<PutChannelExpirationSettingsResponse> putChannelExpirationSettings(Consumer<PutChannelExpirationSettingsRequest.Builder> putChannelExpirationSettingsRequest) Sets the number of days before the channel is automatically deleted.
-
A background process deletes expired channels within 6 hours of expiration. Actual deletion times may vary.
-
Expired channels that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.
-
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
PutChannelExpirationSettingsRequest.Builder
avoiding the need to create one manually viaPutChannelExpirationSettingsRequest.builder()
- Parameters:
putChannelExpirationSettingsRequest
- AConsumer
that will call methods onPutChannelExpirationSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutChannelExpirationSettings 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
putChannelMembershipPreferences
default CompletableFuture<PutChannelMembershipPreferencesResponse> putChannelMembershipPreferences(PutChannelMembershipPreferencesRequest putChannelMembershipPreferencesRequest) Sets the membership preferences of an
AppInstanceUser
orAppInstanceBot
for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in theAppInstanceAdmin
and channel moderator roles can't set preferences for other users. Banned users or bots can't set membership preferences for the channel from which they are banned.The x-amz-chime-bearer request header is mandatory. Use the ARN of an
AppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
putChannelMembershipPreferencesRequest
-- Returns:
- A Java Future containing the result of the PutChannelMembershipPreferences 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.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ForbiddenException The client is permanently forbidden from making 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putChannelMembershipPreferences
default CompletableFuture<PutChannelMembershipPreferencesResponse> putChannelMembershipPreferences(Consumer<PutChannelMembershipPreferencesRequest.Builder> putChannelMembershipPreferencesRequest) Sets the membership preferences of an
AppInstanceUser
orAppInstanceBot
for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in theAppInstanceAdmin
and channel moderator roles can't set preferences for other users. Banned users or bots can't set membership preferences for the channel from which they are banned.The x-amz-chime-bearer request header is mandatory. Use the ARN of an
AppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
PutChannelMembershipPreferencesRequest.Builder
avoiding the need to create one manually viaPutChannelMembershipPreferencesRequest.builder()
- Parameters:
putChannelMembershipPreferencesRequest
- AConsumer
that will call methods onPutChannelMembershipPreferencesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutChannelMembershipPreferences 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.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ForbiddenException The client is permanently forbidden from making 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putMessagingStreamingConfigurations
default CompletableFuture<PutMessagingStreamingConfigurationsResponse> putMessagingStreamingConfigurations(PutMessagingStreamingConfigurationsRequest putMessagingStreamingConfigurationsRequest) Sets the data streaming configuration for an
AppInstance
. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.- Parameters:
putMessagingStreamingConfigurationsRequest
-- Returns:
- A Java Future containing the result of the PutMessagingStreamingConfigurations 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.- NotFoundException One or more of the resources in the request does not exist in the system.
- 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putMessagingStreamingConfigurations
default CompletableFuture<PutMessagingStreamingConfigurationsResponse> putMessagingStreamingConfigurations(Consumer<PutMessagingStreamingConfigurationsRequest.Builder> putMessagingStreamingConfigurationsRequest) Sets the data streaming configuration for an
AppInstance
. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.
This is a convenience which creates an instance of the
PutMessagingStreamingConfigurationsRequest.Builder
avoiding the need to create one manually viaPutMessagingStreamingConfigurationsRequest.builder()
- Parameters:
putMessagingStreamingConfigurationsRequest
- AConsumer
that will call methods onPutMessagingStreamingConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutMessagingStreamingConfigurations 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.- NotFoundException One or more of the resources in the request does not exist in the system.
- 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
redactChannelMessage
default CompletableFuture<RedactChannelMessageResponse> redactChannelMessage(RedactChannelMessageRequest redactChannelMessageRequest) Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
redactChannelMessageRequest
-- Returns:
- A Java Future containing the result of the RedactChannelMessage 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
redactChannelMessage
default CompletableFuture<RedactChannelMessageResponse> redactChannelMessage(Consumer<RedactChannelMessageRequest.Builder> redactChannelMessageRequest) Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
RedactChannelMessageRequest.Builder
avoiding the need to create one manually viaRedactChannelMessageRequest.builder()
- Parameters:
redactChannelMessageRequest
- AConsumer
that will call methods onRedactChannelMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RedactChannelMessage 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchChannels
default CompletableFuture<SearchChannelsResponse> searchChannels(SearchChannelsRequest searchChannelsRequest) Allows the
ChimeBearer
to search channels by channel members. Users or bots can search across the channels that they belong to. Users in theAppInstanceAdmin
role can search across all channels.The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
searchChannelsRequest
-- Returns:
- A Java Future containing the result of the SearchChannels 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchChannels
default CompletableFuture<SearchChannelsResponse> searchChannels(Consumer<SearchChannelsRequest.Builder> searchChannelsRequest) Allows the
ChimeBearer
to search channels by channel members. Users or bots can search across the channels that they belong to. Users in theAppInstanceAdmin
role can search across all channels.The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
SearchChannelsRequest.Builder
avoiding the need to create one manually viaSearchChannelsRequest.builder()
- Parameters:
searchChannelsRequest
- AConsumer
that will call methods onSearchChannelsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SearchChannels 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchChannelsPaginator
default SearchChannelsPublisher searchChannelsPaginator(SearchChannelsRequest searchChannelsRequest) This is a variant of
searchChannels(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.SearchChannelsPublisher publisher = client.searchChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.SearchChannelsPublisher publisher = client.searchChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsResponse 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
searchChannels(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsRequest)
operation.- Parameters:
searchChannelsRequest
-- 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchChannelsPaginator
default SearchChannelsPublisher searchChannelsPaginator(Consumer<SearchChannelsRequest.Builder> searchChannelsRequest) This is a variant of
searchChannels(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsRequest)
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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.SearchChannelsPublisher publisher = client.searchChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmessaging.paginators.SearchChannelsPublisher publisher = client.searchChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsResponse 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
searchChannels(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsRequest)
operation.
This is a convenience which creates an instance of the
SearchChannelsRequest.Builder
avoiding the need to create one manually viaSearchChannelsRequest.builder()
- Parameters:
searchChannelsRequest
- AConsumer
that will call methods onSearchChannelsRequest.Builder
to 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendChannelMessage
default CompletableFuture<SendChannelMessageResponse> sendChannelMessage(SendChannelMessageRequest sendChannelMessageRequest) Sends a message to a particular channel that the member is a part of.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.Also,
STANDARD
messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.CONTROL
messages are limited to 30 bytes and do not contain metadata.- Parameters:
sendChannelMessageRequest
-- Returns:
- A Java Future containing the result of the SendChannelMessage 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendChannelMessage
default CompletableFuture<SendChannelMessageResponse> sendChannelMessage(Consumer<SendChannelMessageRequest.Builder> sendChannelMessageRequest) Sends a message to a particular channel that the member is a part of.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.Also,
STANDARD
messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.CONTROL
messages are limited to 30 bytes and do not contain metadata.
This is a convenience which creates an instance of the
SendChannelMessageRequest.Builder
avoiding the need to create one manually viaSendChannelMessageRequest.builder()
- Parameters:
sendChannelMessageRequest
- AConsumer
that will call methods onSendChannelMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SendChannelMessage 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.
- 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.
- ChimeSdkMessagingException 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 messaging 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.
- ChimeSdkMessagingException 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 messaging resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to 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.
- ChimeSdkMessagingException 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 messaging 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.
- ChimeSdkMessagingException 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 messaging resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannel
default CompletableFuture<UpdateChannelResponse> updateChannel(UpdateChannelRequest updateChannelRequest) Update a channel's attributes.
Restriction: You can't change a channel's privacy.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
updateChannelRequest
-- Returns:
- A Java Future containing the result of the UpdateChannel 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannel
default CompletableFuture<UpdateChannelResponse> updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest) Update a channel's attributes.
Restriction: You can't change a channel's privacy.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
UpdateChannelRequest.Builder
avoiding the need to create one manually viaUpdateChannelRequest.builder()
- Parameters:
updateChannelRequest
- AConsumer
that will call methods onUpdateChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateChannel 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannelFlow
default CompletableFuture<UpdateChannelFlowResponse> updateChannelFlow(UpdateChannelFlowRequest updateChannelFlowRequest) Updates channel flow attributes. This is a developer API.
- Parameters:
updateChannelFlowRequest
-- Returns:
- A Java Future containing the result of the UpdateChannelFlow 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannelFlow
default CompletableFuture<UpdateChannelFlowResponse> updateChannelFlow(Consumer<UpdateChannelFlowRequest.Builder> updateChannelFlowRequest) Updates channel flow attributes. This is a developer API.
This is a convenience which creates an instance of the
UpdateChannelFlowRequest.Builder
avoiding the need to create one manually viaUpdateChannelFlowRequest.builder()
- Parameters:
updateChannelFlowRequest
- AConsumer
that will call methods onUpdateChannelFlowRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateChannelFlow 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannelMessage
default CompletableFuture<UpdateChannelMessageResponse> updateChannelMessage(UpdateChannelMessageRequest updateChannelMessageRequest) Updates the content of a message.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
updateChannelMessageRequest
-- Returns:
- A Java Future containing the result of the UpdateChannelMessage 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannelMessage
default CompletableFuture<UpdateChannelMessageResponse> updateChannelMessage(Consumer<UpdateChannelMessageRequest.Builder> updateChannelMessageRequest) Updates the content of a message.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
UpdateChannelMessageRequest.Builder
avoiding the need to create one manually viaUpdateChannelMessageRequest.builder()
- Parameters:
updateChannelMessageRequest
- AConsumer
that will call methods onUpdateChannelMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateChannelMessage 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.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannelReadMarker
default CompletableFuture<UpdateChannelReadMarkerResponse> updateChannelReadMarker(UpdateChannelReadMarkerRequest updateChannelReadMarkerRequest) The details of the time when a user last read messages in a channel.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.- Parameters:
updateChannelReadMarkerRequest
-- Returns:
- A Java Future containing the result of the UpdateChannelReadMarker 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannelReadMarker
default CompletableFuture<UpdateChannelReadMarkerResponse> updateChannelReadMarker(Consumer<UpdateChannelReadMarkerRequest.Builder> updateChannelReadMarkerRequest) The details of the time when a user last read messages in a channel.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
This is a convenience which creates an instance of the
UpdateChannelReadMarkerRequest.Builder
avoiding the need to create one manually viaUpdateChannelReadMarkerRequest.builder()
- Parameters:
updateChannelReadMarkerRequest
- AConsumer
that will call methods onUpdateChannelReadMarkerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateChannelReadMarker 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.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- ChimeSdkMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aChimeSdkMessagingAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aChimeSdkMessagingAsyncClient
.
-