Interface ChimeSdkMessagingClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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 TypeMethodDescriptiondefault AssociateChannelFlowResponse
associateChannelFlow
(Consumer<AssociateChannelFlowRequest.Builder> associateChannelFlowRequest) Associates a channel flow with a channel.default AssociateChannelFlowResponse
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 aChimeSdkMessagingClient
.default ChannelFlowCallbackResponse
channelFlowCallback
(Consumer<ChannelFlowCallbackRequest.Builder> channelFlowCallbackRequest) Calls back Amazon Chime SDK messaging with a processing response message.default ChannelFlowCallbackResponse
channelFlowCallback
(ChannelFlowCallbackRequest channelFlowCallbackRequest) Calls back Amazon Chime SDK messaging with a processing response message.static ChimeSdkMessagingClient
create()
Create aChimeSdkMessagingClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateChannelResponse
createChannel
(Consumer<CreateChannelRequest.Builder> createChannelRequest) Creates a channel to which you can add users and send messages.default CreateChannelResponse
createChannel
(CreateChannelRequest createChannelRequest) Creates a channel to which you can add users and send messages.default CreateChannelBanResponse
createChannelBan
(Consumer<CreateChannelBanRequest.Builder> createChannelBanRequest) Permanently bans a member from a channel.default CreateChannelBanResponse
createChannelBan
(CreateChannelBanRequest createChannelBanRequest) Permanently bans a member from a channel.default CreateChannelFlowResponse
createChannelFlow
(Consumer<CreateChannelFlowRequest.Builder> createChannelFlowRequest) Creates a channel flow, a container for processors.default CreateChannelFlowResponse
createChannelFlow
(CreateChannelFlowRequest createChannelFlowRequest) Creates a channel flow, a container for processors.default CreateChannelMembershipResponse
createChannelMembership
(Consumer<CreateChannelMembershipRequest.Builder> createChannelMembershipRequest) Adds a member to a channel.default CreateChannelMembershipResponse
createChannelMembership
(CreateChannelMembershipRequest createChannelMembershipRequest) Adds a member to a channel.default CreateChannelModeratorResponse
createChannelModerator
(Consumer<CreateChannelModeratorRequest.Builder> createChannelModeratorRequest) Creates a newChannelModerator
.default CreateChannelModeratorResponse
createChannelModerator
(CreateChannelModeratorRequest createChannelModeratorRequest) Creates a newChannelModerator
.default DeleteChannelResponse
deleteChannel
(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest) Immediately makes a channel and its memberships inaccessible and marks them for deletion.default DeleteChannelResponse
deleteChannel
(DeleteChannelRequest deleteChannelRequest) Immediately makes a channel and its memberships inaccessible and marks them for deletion.default DeleteChannelBanResponse
deleteChannelBan
(Consumer<DeleteChannelBanRequest.Builder> deleteChannelBanRequest) Removes a member from a channel's ban list.default DeleteChannelBanResponse
deleteChannelBan
(DeleteChannelBanRequest deleteChannelBanRequest) Removes a member from a channel's ban list.default DeleteChannelFlowResponse
deleteChannelFlow
(Consumer<DeleteChannelFlowRequest.Builder> deleteChannelFlowRequest) Deletes a channel flow, an irreversible process.default DeleteChannelFlowResponse
deleteChannelFlow
(DeleteChannelFlowRequest deleteChannelFlowRequest) Deletes a channel flow, an irreversible process.default DeleteChannelMembershipResponse
deleteChannelMembership
(Consumer<DeleteChannelMembershipRequest.Builder> deleteChannelMembershipRequest) Removes a member from a channel.default DeleteChannelMembershipResponse
deleteChannelMembership
(DeleteChannelMembershipRequest deleteChannelMembershipRequest) Removes a member from a channel.default DeleteChannelMessageResponse
deleteChannelMessage
(Consumer<DeleteChannelMessageRequest.Builder> deleteChannelMessageRequest) Deletes a channel message.default DeleteChannelMessageResponse
deleteChannelMessage
(DeleteChannelMessageRequest deleteChannelMessageRequest) Deletes a channel message.default DeleteChannelModeratorResponse
deleteChannelModerator
(Consumer<DeleteChannelModeratorRequest.Builder> deleteChannelModeratorRequest) Deletes a channel moderator.default DeleteChannelModeratorResponse
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 DescribeChannelResponse
describeChannel
(Consumer<DescribeChannelRequest.Builder> describeChannelRequest) Returns the full details of a channel in an Amazon ChimeAppInstance
.default DescribeChannelResponse
describeChannel
(DescribeChannelRequest describeChannelRequest) Returns the full details of a channel in an Amazon ChimeAppInstance
.default DescribeChannelBanResponse
describeChannelBan
(Consumer<DescribeChannelBanRequest.Builder> describeChannelBanRequest) Returns the full details of a channel ban.default DescribeChannelBanResponse
describeChannelBan
(DescribeChannelBanRequest describeChannelBanRequest) Returns the full details of a channel ban.default DescribeChannelFlowResponse
describeChannelFlow
(Consumer<DescribeChannelFlowRequest.Builder> describeChannelFlowRequest) Returns the full details of a channel flow in an Amazon ChimeAppInstance
.default DescribeChannelFlowResponse
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
.default DescribeChannelModeratorResponse
describeChannelModerator
(Consumer<DescribeChannelModeratorRequest.Builder> describeChannelModeratorRequest) Returns the full details of a single ChannelModerator.default DescribeChannelModeratorResponse
describeChannelModerator
(DescribeChannelModeratorRequest describeChannelModeratorRequest) Returns the full details of a single ChannelModerator.default DisassociateChannelFlowResponse
disassociateChannelFlow
(Consumer<DisassociateChannelFlowRequest.Builder> disassociateChannelFlowRequest) Disassociates a channel flow from all its channels.default DisassociateChannelFlowResponse
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.default GetChannelMessageResponse
getChannelMessage
(Consumer<GetChannelMessageRequest.Builder> getChannelMessageRequest) Gets the full details of a channel message.default GetChannelMessageResponse
getChannelMessage
(GetChannelMessageRequest getChannelMessageRequest) Gets the full details of a channel message.default GetChannelMessageStatusResponse
getChannelMessageStatus
(Consumer<GetChannelMessageStatusRequest.Builder> getChannelMessageStatusRequest) Gets message status for a specifiedmessageId
.default GetChannelMessageStatusResponse
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 ListChannelBansResponse
listChannelBans
(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest) Lists all the users and bots banned from a particular channel.default ListChannelBansResponse
listChannelBans
(ListChannelBansRequest listChannelBansRequest) Lists all the users and bots banned from a particular channel.default ListChannelBansIterable
listChannelBansPaginator
(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest) This is a variant oflistChannelBans(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansRequest)
operation.default ListChannelBansIterable
listChannelBansPaginator
(ListChannelBansRequest listChannelBansRequest) This is a variant oflistChannelBans(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansRequest)
operation.default ListChannelFlowsResponse
listChannelFlows
(Consumer<ListChannelFlowsRequest.Builder> listChannelFlowsRequest) Returns a paginated lists of all the channel flows created under a single Chime.default ListChannelFlowsResponse
listChannelFlows
(ListChannelFlowsRequest listChannelFlowsRequest) Returns a paginated lists of all the channel flows created under a single Chime.default ListChannelFlowsIterable
listChannelFlowsPaginator
(Consumer<ListChannelFlowsRequest.Builder> listChannelFlowsRequest) This is a variant oflistChannelFlows(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsRequest)
operation.default ListChannelFlowsIterable
listChannelFlowsPaginator
(ListChannelFlowsRequest listChannelFlowsRequest) This is a variant oflistChannelFlows(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsRequest)
operation.default ListChannelMembershipsResponse
listChannelMemberships
(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest) Lists all channel memberships in a channel.default ListChannelMembershipsResponse
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 ListChannelMembershipsIterable
listChannelMembershipsPaginator
(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest) This is a variant oflistChannelMemberships(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsRequest)
operation.default ListChannelMembershipsIterable
listChannelMembershipsPaginator
(ListChannelMembershipsRequest listChannelMembershipsRequest) This is a variant oflistChannelMemberships(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsRequest)
operation.default ListChannelMessagesResponse
listChannelMessages
(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest) List all the messages in a channel.default ListChannelMessagesResponse
listChannelMessages
(ListChannelMessagesRequest listChannelMessagesRequest) List all the messages in a channel.default ListChannelMessagesIterable
listChannelMessagesPaginator
(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest) This is a variant oflistChannelMessages(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesRequest)
operation.default ListChannelMessagesIterable
listChannelMessagesPaginator
(ListChannelMessagesRequest listChannelMessagesRequest) This is a variant oflistChannelMessages(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesRequest)
operation.default ListChannelModeratorsResponse
listChannelModerators
(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest) Lists all the moderators for a channel.default ListChannelModeratorsResponse
listChannelModerators
(ListChannelModeratorsRequest listChannelModeratorsRequest) Lists all the moderators for a channel.default ListChannelModeratorsIterable
listChannelModeratorsPaginator
(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest) This is a variant oflistChannelModerators(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsRequest)
operation.default ListChannelModeratorsIterable
listChannelModeratorsPaginator
(ListChannelModeratorsRequest listChannelModeratorsRequest) This is a variant oflistChannelModerators(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsRequest)
operation.default ListChannelsResponse
listChannels
(Consumer<ListChannelsRequest.Builder> listChannelsRequest) Lists all Channels created under a single Chime App as a paginated list.default 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 ListChannelsIterable
listChannelsPaginator
(Consumer<ListChannelsRequest.Builder> listChannelsRequest) This is a variant oflistChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsRequest)
operation.default ListChannelsIterable
listChannelsPaginator
(ListChannelsRequest listChannelsRequest) This is a variant oflistChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsRequest)
operation.default ListSubChannelsResponse
listSubChannels
(Consumer<ListSubChannelsRequest.Builder> listSubChannelsRequest) Lists all the SubChannels in an elastic channel when given a channel ID.default ListSubChannelsResponse
listSubChannels
(ListSubChannelsRequest listSubChannelsRequest) Lists all the SubChannels in an elastic channel when given a channel ID.default ListSubChannelsIterable
listSubChannelsPaginator
(Consumer<ListSubChannelsRequest.Builder> listSubChannelsRequest) This is a variant oflistSubChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsRequest)
operation.default ListSubChannelsIterable
listSubChannelsPaginator
(ListSubChannelsRequest listSubChannelsRequest) This is a variant oflistSubChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags applied to an Amazon Chime SDK messaging resource.default ListTagsForResourceResponse
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
.default RedactChannelMessageResponse
redactChannelMessage
(Consumer<RedactChannelMessageRequest.Builder> redactChannelMessageRequest) Redacts message content, but not metadata.default RedactChannelMessageResponse
redactChannelMessage
(RedactChannelMessageRequest redactChannelMessageRequest) Redacts message content, but not metadata.default SearchChannelsResponse
searchChannels
(Consumer<SearchChannelsRequest.Builder> searchChannelsRequest) Allows theChimeBearer
to search channels by channel members.default SearchChannelsResponse
searchChannels
(SearchChannelsRequest searchChannelsRequest) Allows theChimeBearer
to search channels by channel members.default SearchChannelsIterable
searchChannelsPaginator
(Consumer<SearchChannelsRequest.Builder> searchChannelsRequest) This is a variant ofsearchChannels(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsRequest)
operation.default SearchChannelsIterable
searchChannelsPaginator
(SearchChannelsRequest searchChannelsRequest) This is a variant ofsearchChannels(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsRequest)
operation.default SendChannelMessageResponse
sendChannelMessage
(Consumer<SendChannelMessageRequest.Builder> sendChannelMessageRequest) Sends a message to a particular channel that the member is a part of.default SendChannelMessageResponse
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., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Applies the specified tags to the specified Amazon Chime SDK messaging resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Applies the specified tags to the specified Amazon Chime SDK messaging resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified Amazon Chime SDK messaging resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified Amazon Chime SDK messaging resource.default UpdateChannelResponse
updateChannel
(Consumer<UpdateChannelRequest.Builder> updateChannelRequest) Update a channel's attributes.default UpdateChannelResponse
updateChannel
(UpdateChannelRequest updateChannelRequest) Update a channel's attributes.default UpdateChannelFlowResponse
updateChannelFlow
(Consumer<UpdateChannelFlowRequest.Builder> updateChannelFlowRequest) Updates channel flow attributes.default UpdateChannelFlowResponse
updateChannelFlow
(UpdateChannelFlowRequest updateChannelFlowRequest) Updates channel flow attributes.default UpdateChannelMessageResponse
updateChannelMessage
(Consumer<UpdateChannelMessageRequest.Builder> updateChannelMessageRequest) Updates the content of a message.default UpdateChannelMessageResponse
updateChannelMessage
(UpdateChannelMessageRequest updateChannelMessageRequest) Updates the content of a message.default UpdateChannelReadMarkerResponse
updateChannelReadMarker
(Consumer<UpdateChannelReadMarkerRequest.Builder> updateChannelReadMarkerRequest) The details of the time when a user last read messages in a channel.default UpdateChannelReadMarkerResponse
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 AssociateChannelFlowResponse associateChannelFlow(AssociateChannelFlowRequest associateChannelFlowRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the AssociateChannelFlow operation returned by the service.
- See Also:
-
associateChannelFlow
default AssociateChannelFlowResponse associateChannelFlow(Consumer<AssociateChannelFlowRequest.Builder> associateChannelFlowRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the AssociateChannelFlow operation returned by the service.
- See Also:
-
batchCreateChannelMembership
default BatchCreateChannelMembershipResponse batchCreateChannelMembership(BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest) throws ServiceFailureException, ServiceUnavailableException, UnauthorizedClientException, BadRequestException, NotFoundException, ForbiddenException, ThrottledClientException, ResourceLimitExceededException, AwsServiceException, SdkClientException, ChimeSdkMessagingException Adds a specified number of users and bots to a channel.
- Parameters:
batchCreateChannelMembershipRequest
-- Returns:
- Result of the BatchCreateChannelMembership operation returned by the service.
- See Also:
-
batchCreateChannelMembership
default BatchCreateChannelMembershipResponse batchCreateChannelMembership(Consumer<BatchCreateChannelMembershipRequest.Builder> batchCreateChannelMembershipRequest) throws ServiceFailureException, ServiceUnavailableException, UnauthorizedClientException, BadRequestException, NotFoundException, ForbiddenException, ThrottledClientException, ResourceLimitExceededException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the BatchCreateChannelMembership operation returned by the service.
- See Also:
-
channelFlowCallback
default ChannelFlowCallbackResponse channelFlowCallback(ChannelFlowCallbackRequest channelFlowCallbackRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ChannelFlowCallback operation returned by the service.
- See Also:
-
-
channelFlowCallback
default ChannelFlowCallbackResponse channelFlowCallback(Consumer<ChannelFlowCallbackRequest.Builder> channelFlowCallbackRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ChannelFlowCallback operation returned by the service.
- See Also:
-
-
createChannel
default CreateChannelResponse createChannel(CreateChannelRequest createChannelRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the CreateChannel operation returned by the service.
- See Also:
-
createChannel
default CreateChannelResponse createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the CreateChannel operation returned by the service.
- See Also:
-
createChannelBan
default CreateChannelBanResponse createChannelBan(CreateChannelBanRequest createChannelBanRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the CreateChannelBan operation returned by the service.
- See Also:
-
createChannelBan
default CreateChannelBanResponse createChannelBan(Consumer<CreateChannelBanRequest.Builder> createChannelBanRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the CreateChannelBan operation returned by the service.
- See Also:
-
createChannelFlow
default CreateChannelFlowResponse createChannelFlow(CreateChannelFlowRequest createChannelFlowRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the CreateChannelFlow operation returned by the service.
- See Also:
-
-
createChannelFlow
default CreateChannelFlowResponse createChannelFlow(Consumer<CreateChannelFlowRequest.Builder> createChannelFlowRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the CreateChannelFlow operation returned by the service.
- See Also:
-
-
createChannelMembership
default CreateChannelMembershipResponse createChannelMembership(CreateChannelMembershipRequest createChannelMembershipRequest) throws BadRequestException, NotFoundException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the CreateChannelMembership operation returned by the service.
- See Also:
-
-
createChannelMembership
default CreateChannelMembershipResponse createChannelMembership(Consumer<CreateChannelMembershipRequest.Builder> createChannelMembershipRequest) throws BadRequestException, NotFoundException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the CreateChannelMembership operation returned by the service.
- See Also:
-
-
createChannelModerator
default CreateChannelModeratorResponse createChannelModerator(CreateChannelModeratorRequest createChannelModeratorRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the CreateChannelModerator operation returned by the service.
- See Also:
-
-
createChannelModerator
default CreateChannelModeratorResponse createChannelModerator(Consumer<CreateChannelModeratorRequest.Builder> createChannelModeratorRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the CreateChannelModerator operation returned by the service.
- See Also:
-
-
deleteChannel
default DeleteChannelResponse deleteChannel(DeleteChannelRequest deleteChannelRequest) throws BadRequestException, ForbiddenException, ConflictException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DeleteChannel operation returned by the service.
- See Also:
-
deleteChannel
default DeleteChannelResponse deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest) throws BadRequestException, ForbiddenException, ConflictException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DeleteChannel operation returned by the service.
- See Also:
-
deleteChannelBan
default DeleteChannelBanResponse deleteChannelBan(DeleteChannelBanRequest deleteChannelBanRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DeleteChannelBan operation returned by the service.
- See Also:
-
deleteChannelBan
default DeleteChannelBanResponse deleteChannelBan(Consumer<DeleteChannelBanRequest.Builder> deleteChannelBanRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DeleteChannelBan operation returned by the service.
- See Also:
-
deleteChannelFlow
default DeleteChannelFlowResponse deleteChannelFlow(DeleteChannelFlowRequest deleteChannelFlowRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ConflictException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DeleteChannelFlow operation returned by the service.
- See Also:
-
deleteChannelFlow
default DeleteChannelFlowResponse deleteChannelFlow(Consumer<DeleteChannelFlowRequest.Builder> deleteChannelFlowRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ConflictException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DeleteChannelFlow operation returned by the service.
- See Also:
-
deleteChannelMembership
default DeleteChannelMembershipResponse deleteChannelMembership(DeleteChannelMembershipRequest deleteChannelMembershipRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DeleteChannelMembership operation returned by the service.
- See Also:
-
deleteChannelMembership
default DeleteChannelMembershipResponse deleteChannelMembership(Consumer<DeleteChannelMembershipRequest.Builder> deleteChannelMembershipRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DeleteChannelMembership operation returned by the service.
- See Also:
-
deleteChannelMessage
default DeleteChannelMessageResponse deleteChannelMessage(DeleteChannelMessageRequest deleteChannelMessageRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DeleteChannelMessage operation returned by the service.
- See Also:
-
deleteChannelMessage
default DeleteChannelMessageResponse deleteChannelMessage(Consumer<DeleteChannelMessageRequest.Builder> deleteChannelMessageRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DeleteChannelMessage operation returned by the service.
- See Also:
-
deleteChannelModerator
default DeleteChannelModeratorResponse deleteChannelModerator(DeleteChannelModeratorRequest deleteChannelModeratorRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DeleteChannelModerator operation returned by the service.
- See Also:
-
deleteChannelModerator
default DeleteChannelModeratorResponse deleteChannelModerator(Consumer<DeleteChannelModeratorRequest.Builder> deleteChannelModeratorRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DeleteChannelModerator operation returned by the service.
- See Also:
-
deleteMessagingStreamingConfigurations
default DeleteMessagingStreamingConfigurationsResponse deleteMessagingStreamingConfigurations(DeleteMessagingStreamingConfigurationsRequest deleteMessagingStreamingConfigurationsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException Deletes the streaming configurations for an
AppInstance
. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.- Parameters:
deleteMessagingStreamingConfigurationsRequest
-- Returns:
- Result of the DeleteMessagingStreamingConfigurations operation returned by the service.
- See Also:
-
deleteMessagingStreamingConfigurations
default DeleteMessagingStreamingConfigurationsResponse deleteMessagingStreamingConfigurations(Consumer<DeleteMessagingStreamingConfigurationsRequest.Builder> deleteMessagingStreamingConfigurationsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DeleteMessagingStreamingConfigurations operation returned by the service.
- See Also:
-
describeChannel
default DescribeChannelResponse describeChannel(DescribeChannelRequest describeChannelRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DescribeChannel operation returned by the service.
- See Also:
-
describeChannel
default DescribeChannelResponse describeChannel(Consumer<DescribeChannelRequest.Builder> describeChannelRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DescribeChannel operation returned by the service.
- See Also:
-
describeChannelBan
default DescribeChannelBanResponse describeChannelBan(DescribeChannelBanRequest describeChannelBanRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DescribeChannelBan operation returned by the service.
- See Also:
-
describeChannelBan
default DescribeChannelBanResponse describeChannelBan(Consumer<DescribeChannelBanRequest.Builder> describeChannelBanRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DescribeChannelBan operation returned by the service.
- See Also:
-
describeChannelFlow
default DescribeChannelFlowResponse describeChannelFlow(DescribeChannelFlowRequest describeChannelFlowRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException Returns the full details of a channel flow in an Amazon Chime
AppInstance
. This is a developer API.- Parameters:
describeChannelFlowRequest
-- Returns:
- Result of the DescribeChannelFlow operation returned by the service.
- See Also:
-
describeChannelFlow
default DescribeChannelFlowResponse describeChannelFlow(Consumer<DescribeChannelFlowRequest.Builder> describeChannelFlowRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DescribeChannelFlow operation returned by the service.
- See Also:
-
describeChannelMembership
default DescribeChannelMembershipResponse describeChannelMembership(DescribeChannelMembershipRequest describeChannelMembershipRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DescribeChannelMembership operation returned by the service.
- See Also:
-
describeChannelMembership
default DescribeChannelMembershipResponse describeChannelMembership(Consumer<DescribeChannelMembershipRequest.Builder> describeChannelMembershipRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DescribeChannelMembership operation returned by the service.
- See Also:
-
describeChannelMembershipForAppInstanceUser
default DescribeChannelMembershipForAppInstanceUserResponse describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest describeChannelMembershipForAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DescribeChannelMembershipForAppInstanceUser operation returned by the service.
- See Also:
-
describeChannelMembershipForAppInstanceUser
default DescribeChannelMembershipForAppInstanceUserResponse describeChannelMembershipForAppInstanceUser(Consumer<DescribeChannelMembershipForAppInstanceUserRequest.Builder> describeChannelMembershipForAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DescribeChannelMembershipForAppInstanceUser operation returned by the service.
- See Also:
-
describeChannelModeratedByAppInstanceUser
default DescribeChannelModeratedByAppInstanceUserResponse describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest describeChannelModeratedByAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DescribeChannelModeratedByAppInstanceUser operation returned by the service.
- See Also:
-
describeChannelModeratedByAppInstanceUser
default DescribeChannelModeratedByAppInstanceUserResponse describeChannelModeratedByAppInstanceUser(Consumer<DescribeChannelModeratedByAppInstanceUserRequest.Builder> describeChannelModeratedByAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DescribeChannelModeratedByAppInstanceUser operation returned by the service.
- See Also:
-
describeChannelModerator
default DescribeChannelModeratorResponse describeChannelModerator(DescribeChannelModeratorRequest describeChannelModeratorRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DescribeChannelModerator operation returned by the service.
- See Also:
-
describeChannelModerator
default DescribeChannelModeratorResponse describeChannelModerator(Consumer<DescribeChannelModeratorRequest.Builder> describeChannelModeratorRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DescribeChannelModerator operation returned by the service.
- See Also:
-
disassociateChannelFlow
default DisassociateChannelFlowResponse disassociateChannelFlow(DisassociateChannelFlowRequest disassociateChannelFlowRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DisassociateChannelFlow operation returned by the service.
- See Also:
-
disassociateChannelFlow
default DisassociateChannelFlowResponse disassociateChannelFlow(Consumer<DisassociateChannelFlowRequest.Builder> disassociateChannelFlowRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the DisassociateChannelFlow operation returned by the service.
- See Also:
-
getChannelMembershipPreferences
default GetChannelMembershipPreferencesResponse getChannelMembershipPreferences(GetChannelMembershipPreferencesRequest getChannelMembershipPreferencesRequest) throws BadRequestException, UnauthorizedClientException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the GetChannelMembershipPreferences operation returned by the service.
- See Also:
-
getChannelMembershipPreferences
default GetChannelMembershipPreferencesResponse getChannelMembershipPreferences(Consumer<GetChannelMembershipPreferencesRequest.Builder> getChannelMembershipPreferencesRequest) throws BadRequestException, UnauthorizedClientException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the GetChannelMembershipPreferences operation returned by the service.
- See Also:
-
getChannelMessage
default GetChannelMessageResponse getChannelMessage(GetChannelMessageRequest getChannelMessageRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the GetChannelMessage operation returned by the service.
- See Also:
-
getChannelMessage
default GetChannelMessageResponse getChannelMessage(Consumer<GetChannelMessageRequest.Builder> getChannelMessageRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the GetChannelMessage operation returned by the service.
- See Also:
-
getChannelMessageStatus
default GetChannelMessageStatusResponse getChannelMessageStatus(GetChannelMessageStatusRequest getChannelMessageStatusRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the GetChannelMessageStatus operation returned by the service.
- See Also:
-
getChannelMessageStatus
default GetChannelMessageStatusResponse getChannelMessageStatus(Consumer<GetChannelMessageStatusRequest.Builder> getChannelMessageStatusRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the GetChannelMessageStatus operation returned by the service.
- See Also:
-
getMessagingSessionEndpoint
default GetMessagingSessionEndpointResponse getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest) throws UnauthorizedClientException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException The details of the endpoint for the messaging session.
- Parameters:
getMessagingSessionEndpointRequest
-- Returns:
- Result of the GetMessagingSessionEndpoint operation returned by the service.
- See Also:
-
getMessagingSessionEndpoint
default GetMessagingSessionEndpointResponse getMessagingSessionEndpoint(Consumer<GetMessagingSessionEndpointRequest.Builder> getMessagingSessionEndpointRequest) throws UnauthorizedClientException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the GetMessagingSessionEndpoint operation returned by the service.
- See Also:
-
getMessagingStreamingConfigurations
default GetMessagingStreamingConfigurationsResponse getMessagingStreamingConfigurations(GetMessagingStreamingConfigurationsRequest getMessagingStreamingConfigurationsRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the GetMessagingStreamingConfigurations operation returned by the service.
- See Also:
-
getMessagingStreamingConfigurations
default GetMessagingStreamingConfigurationsResponse getMessagingStreamingConfigurations(Consumer<GetMessagingStreamingConfigurationsRequest.Builder> getMessagingStreamingConfigurationsRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the GetMessagingStreamingConfigurations operation returned by the service.
- See Also:
-
listChannelBans
default ListChannelBansResponse listChannelBans(ListChannelBansRequest listChannelBansRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannelBans operation returned by the service.
- See Also:
-
listChannelBans
default ListChannelBansResponse listChannelBans(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannelBans operation returned by the service.
- See Also:
-
listChannelBansPaginator
default ListChannelBansIterable listChannelBansPaginator(ListChannelBansRequest listChannelBansRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannelBans(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansIterable responses = client.listChannelBansPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansIterable responses = client .listChannelBansPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansIterable responses = client.listChannelBansPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannelBansPaginator
default ListChannelBansIterable listChannelBansPaginator(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannelBans(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansIterable responses = client.listChannelBansPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansIterable responses = client .listChannelBansPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansIterable responses = client.listChannelBansPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannelFlows
default ListChannelFlowsResponse listChannelFlows(ListChannelFlowsRequest listChannelFlowsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
- Parameters:
listChannelFlowsRequest
-- Returns:
- Result of the ListChannelFlows operation returned by the service.
- See Also:
-
listChannelFlows
default ListChannelFlowsResponse listChannelFlows(Consumer<ListChannelFlowsRequest.Builder> listChannelFlowsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannelFlows operation returned by the service.
- See Also:
-
listChannelFlowsPaginator
default ListChannelFlowsIterable listChannelFlowsPaginator(ListChannelFlowsRequest listChannelFlowsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannelFlows(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelFlowsIterable responses = client.listChannelFlowsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelFlowsIterable responses = client .listChannelFlowsPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelFlowsIterable responses = client.listChannelFlowsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannelFlowsPaginator
default ListChannelFlowsIterable listChannelFlowsPaginator(Consumer<ListChannelFlowsRequest.Builder> listChannelFlowsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannelFlows(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelFlowsIterable responses = client.listChannelFlowsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelFlowsIterable responses = client .listChannelFlowsPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelFlowsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelFlowsIterable responses = client.listChannelFlowsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannelMemberships
default ListChannelMembershipsResponse listChannelMemberships(ListChannelMembershipsRequest listChannelMembershipsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannelMemberships operation returned by the service.
- See Also:
-
listChannelMemberships
default ListChannelMembershipsResponse listChannelMemberships(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannelMemberships operation returned by the service.
- See Also:
-
listChannelMembershipsPaginator
default ListChannelMembershipsIterable listChannelMembershipsPaginator(ListChannelMembershipsRequest listChannelMembershipsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannelMemberships(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsIterable responses = client.listChannelMembershipsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsIterable responses = client .listChannelMembershipsPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsIterable responses = client.listChannelMembershipsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannelMembershipsPaginator
default ListChannelMembershipsIterable listChannelMembershipsPaginator(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannelMemberships(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsIterable responses = client.listChannelMembershipsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsIterable responses = client .listChannelMembershipsPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsIterable responses = client.listChannelMembershipsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannelMembershipsForAppInstanceUser
default ListChannelMembershipsForAppInstanceUserResponse listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannelMembershipsForAppInstanceUser operation returned by the service.
- See Also:
-
listChannelMembershipsForAppInstanceUser
default ListChannelMembershipsForAppInstanceUserResponse listChannelMembershipsForAppInstanceUser(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannelMembershipsForAppInstanceUser operation returned by the service.
- See Also:
-
listChannelMembershipsForAppInstanceUserPaginator
default ListChannelMembershipsForAppInstanceUserIterable listChannelMembershipsForAppInstanceUserPaginator(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannelMembershipsForAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsForAppInstanceUserIterable responses = client.listChannelMembershipsForAppInstanceUserPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsForAppInstanceUserIterable responses = client .listChannelMembershipsForAppInstanceUserPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsForAppInstanceUserIterable responses = client.listChannelMembershipsForAppInstanceUserPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannelMembershipsForAppInstanceUserPaginator
default ListChannelMembershipsForAppInstanceUserIterable listChannelMembershipsForAppInstanceUserPaginator(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannelMembershipsForAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsForAppInstanceUserIterable responses = client.listChannelMembershipsForAppInstanceUserPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsForAppInstanceUserIterable responses = client .listChannelMembershipsForAppInstanceUserPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMembershipsForAppInstanceUserResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsForAppInstanceUserIterable responses = client.listChannelMembershipsForAppInstanceUserPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannelMessages
default ListChannelMessagesResponse listChannelMessages(ListChannelMessagesRequest listChannelMessagesRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannelMessages operation returned by the service.
- See Also:
-
listChannelMessages
default ListChannelMessagesResponse listChannelMessages(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannelMessages operation returned by the service.
- See Also:
-
listChannelMessagesPaginator
default ListChannelMessagesIterable listChannelMessagesPaginator(ListChannelMessagesRequest listChannelMessagesRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannelMessages(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMessagesIterable responses = client.listChannelMessagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMessagesIterable responses = client .listChannelMessagesPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMessagesIterable responses = client.listChannelMessagesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannelMessagesPaginator
default ListChannelMessagesIterable listChannelMessagesPaginator(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannelMessages(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMessagesIterable responses = client.listChannelMessagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMessagesIterable responses = client .listChannelMessagesPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMessagesIterable responses = client.listChannelMessagesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannelModerators
default ListChannelModeratorsResponse listChannelModerators(ListChannelModeratorsRequest listChannelModeratorsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannelModerators operation returned by the service.
- See Also:
-
listChannelModerators
default ListChannelModeratorsResponse listChannelModerators(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannelModerators operation returned by the service.
- See Also:
-
listChannelModeratorsPaginator
default ListChannelModeratorsIterable listChannelModeratorsPaginator(ListChannelModeratorsRequest listChannelModeratorsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannelModerators(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelModeratorsIterable responses = client.listChannelModeratorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelModeratorsIterable responses = client .listChannelModeratorsPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelModeratorsIterable responses = client.listChannelModeratorsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannelModeratorsPaginator
default ListChannelModeratorsIterable listChannelModeratorsPaginator(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannelModerators(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelModeratorsIterable responses = client.listChannelModeratorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelModeratorsIterable responses = client .listChannelModeratorsPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelModeratorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelModeratorsIterable responses = client.listChannelModeratorsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannels
default ListChannelsResponse listChannels(ListChannelsRequest listChannelsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannels operation returned by the service.
- See Also:
-
-
listChannels
default ListChannelsResponse listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannels operation returned by the service.
- See Also:
-
-
listChannelsPaginator
default ListChannelsIterable listChannelsPaginator(ListChannelsRequest listChannelsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsIterable responses = client .listChannelsPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannelsPaginator
default ListChannelsIterable listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsIterable responses = client .listChannelsPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannelsAssociatedWithChannelFlow
default ListChannelsAssociatedWithChannelFlowResponse listChannelsAssociatedWithChannelFlow(ListChannelsAssociatedWithChannelFlowRequest listChannelsAssociatedWithChannelFlowRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannelsAssociatedWithChannelFlow operation returned by the service.
- See Also:
-
listChannelsAssociatedWithChannelFlow
default ListChannelsAssociatedWithChannelFlowResponse listChannelsAssociatedWithChannelFlow(Consumer<ListChannelsAssociatedWithChannelFlowRequest.Builder> listChannelsAssociatedWithChannelFlowRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannelsAssociatedWithChannelFlow operation returned by the service.
- See Also:
-
listChannelsAssociatedWithChannelFlowPaginator
default ListChannelsAssociatedWithChannelFlowIterable listChannelsAssociatedWithChannelFlowPaginator(ListChannelsAssociatedWithChannelFlowRequest listChannelsAssociatedWithChannelFlowRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannelsAssociatedWithChannelFlow(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsAssociatedWithChannelFlowIterable responses = client.listChannelsAssociatedWithChannelFlowPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsAssociatedWithChannelFlowIterable responses = client .listChannelsAssociatedWithChannelFlowPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsAssociatedWithChannelFlowIterable responses = client.listChannelsAssociatedWithChannelFlowPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannelsAssociatedWithChannelFlowPaginator
default ListChannelsAssociatedWithChannelFlowIterable listChannelsAssociatedWithChannelFlowPaginator(Consumer<ListChannelsAssociatedWithChannelFlowRequest.Builder> listChannelsAssociatedWithChannelFlowRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannelsAssociatedWithChannelFlow(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsAssociatedWithChannelFlowIterable responses = client.listChannelsAssociatedWithChannelFlowPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsAssociatedWithChannelFlowIterable responses = client .listChannelsAssociatedWithChannelFlowPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsAssociatedWithChannelFlowResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsAssociatedWithChannelFlowIterable responses = client.listChannelsAssociatedWithChannelFlowPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannelsModeratedByAppInstanceUser
default ListChannelsModeratedByAppInstanceUserResponse listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannelsModeratedByAppInstanceUser operation returned by the service.
- See Also:
-
listChannelsModeratedByAppInstanceUser
default ListChannelsModeratedByAppInstanceUserResponse listChannelsModeratedByAppInstanceUser(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListChannelsModeratedByAppInstanceUser operation returned by the service.
- See Also:
-
listChannelsModeratedByAppInstanceUserPaginator
default ListChannelsModeratedByAppInstanceUserIterable listChannelsModeratedByAppInstanceUserPaginator(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannelsModeratedByAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsModeratedByAppInstanceUserIterable responses = client.listChannelsModeratedByAppInstanceUserPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsModeratedByAppInstanceUserIterable responses = client .listChannelsModeratedByAppInstanceUserPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsModeratedByAppInstanceUserIterable responses = client.listChannelsModeratedByAppInstanceUserPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listChannelsModeratedByAppInstanceUserPaginator
default ListChannelsModeratedByAppInstanceUserIterable listChannelsModeratedByAppInstanceUserPaginator(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listChannelsModeratedByAppInstanceUser(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsModeratedByAppInstanceUserIterable responses = client.listChannelsModeratedByAppInstanceUserPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsModeratedByAppInstanceUserIterable responses = client .listChannelsModeratedByAppInstanceUserPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelsModeratedByAppInstanceUserResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsModeratedByAppInstanceUserIterable responses = client.listChannelsModeratedByAppInstanceUserPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listSubChannels
default ListSubChannelsResponse listSubChannels(ListSubChannelsRequest listSubChannelsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListSubChannels operation returned by the service.
- See Also:
-
listSubChannels
default ListSubChannelsResponse listSubChannels(Consumer<ListSubChannelsRequest.Builder> listSubChannelsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListSubChannels operation returned by the service.
- See Also:
-
listSubChannelsPaginator
default ListSubChannelsIterable listSubChannelsPaginator(ListSubChannelsRequest listSubChannelsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listSubChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListSubChannelsIterable responses = client.listSubChannelsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListSubChannelsIterable responses = client .listSubChannelsPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListSubChannelsIterable responses = client.listSubChannelsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listSubChannelsPaginator
default ListSubChannelsIterable listSubChannelsPaginator(Consumer<ListSubChannelsRequest.Builder> listSubChannelsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
listSubChannels(software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListSubChannelsIterable responses = client.listSubChannelsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.ListSubChannelsIterable responses = client .listSubChannelsPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.ListSubChannelsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.ListSubChannelsIterable responses = client.listSubChannelsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException Lists the tags applied to an Amazon Chime SDK messaging resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
putChannelExpirationSettings
default PutChannelExpirationSettingsResponse putChannelExpirationSettings(PutChannelExpirationSettingsRequest putChannelExpirationSettingsRequest) throws BadRequestException, ForbiddenException, ConflictException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the PutChannelExpirationSettings operation returned by the service.
- See Also:
-
-
putChannelExpirationSettings
default PutChannelExpirationSettingsResponse putChannelExpirationSettings(Consumer<PutChannelExpirationSettingsRequest.Builder> putChannelExpirationSettingsRequest) throws BadRequestException, ForbiddenException, ConflictException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the PutChannelExpirationSettings operation returned by the service.
- See Also:
-
-
putChannelMembershipPreferences
default PutChannelMembershipPreferencesResponse putChannelMembershipPreferences(PutChannelMembershipPreferencesRequest putChannelMembershipPreferencesRequest) throws BadRequestException, ConflictException, UnauthorizedClientException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the PutChannelMembershipPreferences operation returned by the service.
- See Also:
-
putChannelMembershipPreferences
default PutChannelMembershipPreferencesResponse putChannelMembershipPreferences(Consumer<PutChannelMembershipPreferencesRequest.Builder> putChannelMembershipPreferencesRequest) throws BadRequestException, ConflictException, UnauthorizedClientException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the PutChannelMembershipPreferences operation returned by the service.
- See Also:
-
putMessagingStreamingConfigurations
default PutMessagingStreamingConfigurationsResponse putMessagingStreamingConfigurations(PutMessagingStreamingConfigurationsRequest putMessagingStreamingConfigurationsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ConflictException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the PutMessagingStreamingConfigurations operation returned by the service.
- See Also:
-
putMessagingStreamingConfigurations
default PutMessagingStreamingConfigurationsResponse putMessagingStreamingConfigurations(Consumer<PutMessagingStreamingConfigurationsRequest.Builder> putMessagingStreamingConfigurationsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ConflictException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the PutMessagingStreamingConfigurations operation returned by the service.
- See Also:
-
redactChannelMessage
default RedactChannelMessageResponse redactChannelMessage(RedactChannelMessageRequest redactChannelMessageRequest) throws BadRequestException, ForbiddenException, ConflictException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the RedactChannelMessage operation returned by the service.
- See Also:
-
redactChannelMessage
default RedactChannelMessageResponse redactChannelMessage(Consumer<RedactChannelMessageRequest.Builder> redactChannelMessageRequest) throws BadRequestException, ForbiddenException, ConflictException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the RedactChannelMessage operation returned by the service.
- See Also:
-
searchChannels
default SearchChannelsResponse searchChannels(SearchChannelsRequest searchChannelsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the SearchChannels operation returned by the service.
- See Also:
-
searchChannels
default SearchChannelsResponse searchChannels(Consumer<SearchChannelsRequest.Builder> searchChannelsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the SearchChannels operation returned by the service.
- See Also:
-
searchChannelsPaginator
default SearchChannelsIterable searchChannelsPaginator(SearchChannelsRequest searchChannelsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
searchChannels(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.SearchChannelsIterable responses = client.searchChannelsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.SearchChannelsIterable responses = client .searchChannelsPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.SearchChannelsIterable responses = client.searchChannelsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
searchChannelsPaginator
default SearchChannelsIterable searchChannelsPaginator(Consumer<SearchChannelsRequest.Builder> searchChannelsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException This is a variant of
searchChannels(software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkmessaging.paginators.SearchChannelsIterable responses = client.searchChannelsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkmessaging.paginators.SearchChannelsIterable responses = client .searchChannelsPaginator(request); for (software.amazon.awssdk.services.chimesdkmessaging.model.SearchChannelsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmessaging.paginators.SearchChannelsIterable responses = client.searchChannelsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
sendChannelMessage
default SendChannelMessageResponse sendChannelMessage(SendChannelMessageRequest sendChannelMessageRequest) throws BadRequestException, ConflictException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the SendChannelMessage operation returned by the service.
- See Also:
-
sendChannelMessage
default SendChannelMessageResponse sendChannelMessage(Consumer<SendChannelMessageRequest.Builder> sendChannelMessageRequest) throws BadRequestException, ConflictException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the SendChannelMessage operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException Applies the specified tags to the specified Amazon Chime SDK messaging resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException Removes the specified tags from the specified Amazon Chime SDK messaging resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateChannel
default UpdateChannelResponse updateChannel(UpdateChannelRequest updateChannelRequest) throws BadRequestException, ForbiddenException, ConflictException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the UpdateChannel operation returned by the service.
- See Also:
-
updateChannel
default UpdateChannelResponse updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest) throws BadRequestException, ForbiddenException, ConflictException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the UpdateChannel operation returned by the service.
- See Also:
-
updateChannelFlow
default UpdateChannelFlowResponse updateChannelFlow(UpdateChannelFlowRequest updateChannelFlowRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException Updates channel flow attributes. This is a developer API.
- Parameters:
updateChannelFlowRequest
-- Returns:
- Result of the UpdateChannelFlow operation returned by the service.
- See Also:
-
updateChannelFlow
default UpdateChannelFlowResponse updateChannelFlow(Consumer<UpdateChannelFlowRequest.Builder> updateChannelFlowRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the UpdateChannelFlow operation returned by the service.
- See Also:
-
updateChannelMessage
default UpdateChannelMessageResponse updateChannelMessage(UpdateChannelMessageRequest updateChannelMessageRequest) throws BadRequestException, ConflictException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the UpdateChannelMessage operation returned by the service.
- See Also:
-
updateChannelMessage
default UpdateChannelMessageResponse updateChannelMessage(Consumer<UpdateChannelMessageRequest.Builder> updateChannelMessageRequest) throws BadRequestException, ConflictException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the UpdateChannelMessage operation returned by the service.
- See Also:
-
updateChannelReadMarker
default UpdateChannelReadMarkerResponse updateChannelReadMarker(UpdateChannelReadMarkerRequest updateChannelReadMarkerRequest) throws BadRequestException, ForbiddenException, ConflictException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the UpdateChannelReadMarker operation returned by the service.
- See Also:
-
updateChannelReadMarker
default UpdateChannelReadMarkerResponse updateChannelReadMarker(Consumer<UpdateChannelReadMarkerRequest.Builder> updateChannelReadMarkerRequest) throws BadRequestException, ForbiddenException, ConflictException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException 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:
- Result of the UpdateChannelReadMarker operation returned by the service.
- See Also:
-
create
Create aChimeSdkMessagingClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aChimeSdkMessagingClient
. -
serviceMetadata
-
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
-