@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface ChimeSdkMessagingClient extends 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
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default BatchCreateChannelMembershipResponse |
batchCreateChannelMembership(BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest)
Adds a specified number of users to a channel.
|
default BatchCreateChannelMembershipResponse |
batchCreateChannelMembership(Consumer<BatchCreateChannelMembershipRequest.Builder> batchCreateChannelMembershipRequest)
Adds a specified number of users to a channel.
|
static ChimeSdkMessagingClientBuilder |
builder()
Create a builder that can be used to configure and create a
ChimeSdkMessagingClient. |
static ChimeSdkMessagingClient |
create()
Create a
ChimeSdkMessagingClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
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 CreateChannelMembershipResponse |
createChannelMembership(Consumer<CreateChannelMembershipRequest.Builder> createChannelMembershipRequest)
Adds a user to a channel.
|
default CreateChannelMembershipResponse |
createChannelMembership(CreateChannelMembershipRequest createChannelMembershipRequest)
Adds a user to a channel.
|
default CreateChannelModeratorResponse |
createChannelModerator(Consumer<CreateChannelModeratorRequest.Builder> createChannelModeratorRequest)
Creates a new
ChannelModerator. |
default CreateChannelModeratorResponse |
createChannelModerator(CreateChannelModeratorRequest createChannelModeratorRequest)
Creates a new
ChannelModerator. |
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 user from a channel's ban list.
|
default DeleteChannelBanResponse |
deleteChannelBan(DeleteChannelBanRequest deleteChannelBanRequest)
Removes a user from a channel's ban list.
|
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.
|
default DescribeChannelResponse |
describeChannel(Consumer<DescribeChannelRequest.Builder> describeChannelRequest)
Returns the full details of a channel in an Amazon Chime
AppInstance. |
default DescribeChannelResponse |
describeChannel(DescribeChannelRequest describeChannelRequest)
Returns the full details of a channel in an Amazon Chime
AppInstance. |
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 DescribeChannelMembershipResponse |
describeChannelMembership(Consumer<DescribeChannelMembershipRequest.Builder> describeChannelMembershipRequest)
Returns the full details of a user's channel membership.
|
default DescribeChannelMembershipResponse |
describeChannelMembership(DescribeChannelMembershipRequest describeChannelMembershipRequest)
Returns the full details of a user's channel membership.
|
default DescribeChannelMembershipForAppInstanceUserResponse |
describeChannelMembershipForAppInstanceUser(Consumer<DescribeChannelMembershipForAppInstanceUserRequest.Builder> describeChannelMembershipForAppInstanceUserRequest)
Returns the details of a channel based on the membership of the specified
AppInstanceUser. |
default DescribeChannelMembershipForAppInstanceUserResponse |
describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest describeChannelMembershipForAppInstanceUserRequest)
Returns the details of a channel based on the membership of the specified
AppInstanceUser. |
default DescribeChannelModeratedByAppInstanceUserResponse |
describeChannelModeratedByAppInstanceUser(Consumer<DescribeChannelModeratedByAppInstanceUserRequest.Builder> describeChannelModeratedByAppInstanceUserRequest)
Returns the full details of a channel moderated by the specified
AppInstanceUser. |
default DescribeChannelModeratedByAppInstanceUserResponse |
describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest describeChannelModeratedByAppInstanceUserRequest)
Returns the full details of a channel moderated by the specified
AppInstanceUser. |
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 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 GetMessagingSessionEndpointResponse |
getMessagingSessionEndpoint(Consumer<GetMessagingSessionEndpointRequest.Builder> getMessagingSessionEndpointRequest)
The details of the endpoint for the messaging session.
|
default GetMessagingSessionEndpointResponse |
getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest)
The details of the endpoint for the messaging session.
|
default ListChannelBansResponse |
listChannelBans(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest)
Lists all the users banned from a particular channel.
|
default ListChannelBansResponse |
listChannelBans(ListChannelBansRequest listChannelBansRequest)
Lists all the users banned from a particular channel.
|
default ListChannelBansIterable |
listChannelBansPaginator(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest)
Lists all the users banned from a particular channel.
|
default ListChannelBansIterable |
listChannelBansPaginator(ListChannelBansRequest listChannelBansRequest)
Lists all the users banned from a particular channel.
|
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.
|
default ListChannelMembershipsForAppInstanceUserResponse |
listChannelMembershipsForAppInstanceUser(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest)
Lists all channels that a particular
AppInstanceUser is a part of. |
default ListChannelMembershipsForAppInstanceUserResponse |
listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest)
Lists all channels that a particular
AppInstanceUser is a part of. |
default ListChannelMembershipsForAppInstanceUserIterable |
listChannelMembershipsForAppInstanceUserPaginator(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest)
Lists all channels that a particular
AppInstanceUser is a part of. |
default ListChannelMembershipsForAppInstanceUserIterable |
listChannelMembershipsForAppInstanceUserPaginator(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest)
Lists all channels that a particular
AppInstanceUser is a part of. |
default ListChannelMembershipsIterable |
listChannelMembershipsPaginator(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest)
Lists all channel memberships in a channel.
|
default ListChannelMembershipsIterable |
listChannelMembershipsPaginator(ListChannelMembershipsRequest listChannelMembershipsRequest)
Lists all channel memberships in a channel.
|
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)
List all the messages in a channel.
|
default ListChannelMessagesIterable |
listChannelMessagesPaginator(ListChannelMessagesRequest listChannelMessagesRequest)
List all the messages in a channel.
|
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)
Lists all the moderators for a channel.
|
default ListChannelModeratorsIterable |
listChannelModeratorsPaginator(ListChannelModeratorsRequest listChannelModeratorsRequest)
Lists all the moderators for a channel.
|
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.
|
default ListChannelsModeratedByAppInstanceUserResponse |
listChannelsModeratedByAppInstanceUser(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest)
A list of the channels moderated by an
AppInstanceUser. |
default ListChannelsModeratedByAppInstanceUserResponse |
listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest)
A list of the channels moderated by an
AppInstanceUser. |
default ListChannelsModeratedByAppInstanceUserIterable |
listChannelsModeratedByAppInstanceUserPaginator(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest)
A list of the channels moderated by an
AppInstanceUser. |
default ListChannelsModeratedByAppInstanceUserIterable |
listChannelsModeratedByAppInstanceUserPaginator(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest)
A list of the channels moderated by an
AppInstanceUser. |
default ListChannelsIterable |
listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
Lists all Channels created under a single Chime App as a paginated list.
|
default ListChannelsIterable |
listChannelsPaginator(ListChannelsRequest listChannelsRequest)
Lists all Channels created under a single Chime App as a paginated list.
|
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 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.
|
static ServiceMetadata |
serviceMetadata() |
default UpdateChannelResponse |
updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest)
Update a channel's attributes.
|
default UpdateChannelResponse |
updateChannel(UpdateChannelRequest updateChannelRequest)
Update a channel's 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.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static ChimeSdkMessagingClient create()
ChimeSdkMessagingClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ChimeSdkMessagingClientBuilder builder()
ChimeSdkMessagingClient.default BatchCreateChannelMembershipResponse batchCreateChannelMembership(BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest) throws ServiceFailureException, ServiceUnavailableException, UnauthorizedClientException, BadRequestException, ForbiddenException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeSdkMessagingException
Adds a specified number of users to a channel.
batchCreateChannelMembershipRequest - ServiceFailureException - The service encountered an unexpected error.ServiceUnavailableException - The service is currently unavailable.UnauthorizedClientException - The client is not currently authorized to make the request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchCreateChannelMembershipResponse batchCreateChannelMembership(Consumer<BatchCreateChannelMembershipRequest.Builder> batchCreateChannelMembershipRequest) throws ServiceFailureException, ServiceUnavailableException, UnauthorizedClientException, BadRequestException, ForbiddenException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeSdkMessagingException
Adds a specified number of users to a channel.
This is a convenience which creates an instance of the BatchCreateChannelMembershipRequest.Builder
avoiding the need to create one manually via BatchCreateChannelMembershipRequest.builder()
batchCreateChannelMembershipRequest - A Consumer that will call methods on BatchCreateChannelMembershipRequest.Builder to create
a request.ServiceFailureException - The service encountered an unexpected error.ServiceUnavailableException - The service is currently unavailable.UnauthorizedClientException - The client is not currently authorized to make the request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user 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 via CreateChannelRequest.builder()
createChannelRequest - A Consumer that will call methods on CreateChannelRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 then CreateChannelMembership. 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelBanRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 then CreateChannelMembership. 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 AppInstanceUserArn of the
user 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 via CreateChannelBanRequest.builder()
createChannelBanRequest - A Consumer that will call methods on CreateChannelBanRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateChannelMembershipResponse createChannelMembership(CreateChannelMembershipRequest createChannelMembershipRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException
Adds a user to a channel. The InvitedBy response field 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelMembershipRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateChannelMembershipResponse createChannelMembership(Consumer<CreateChannelMembershipRequest.Builder> createChannelMembershipRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException
Adds a user to a channel. The InvitedBy response field 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 AppInstanceUserArn of the
user 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 via CreateChannelMembershipRequest.builder()
createChannelMembershipRequest - A Consumer that will call methods on CreateChannelMembershipRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
createChannelModeratorRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn 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 via CreateChannelModeratorRequest.builder()
createChannelModeratorRequest - A Consumer that will call methods on CreateChannelModeratorRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteChannelResponse deleteChannel(DeleteChannelRequest deleteChannelRequest) throws BadRequestException, ForbiddenException, 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteChannelResponse deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest) throws BadRequestException, ForbiddenException, 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 AppInstanceUserArn of the
user 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 via DeleteChannelRequest.builder()
deleteChannelRequest - A Consumer that will call methods on DeleteChannelRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteChannelBanResponse deleteChannelBan(DeleteChannelBanRequest deleteChannelBanRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException
Removes a user from a channel's ban list.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelBanRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteChannelBanResponse deleteChannelBan(Consumer<DeleteChannelBanRequest.Builder> deleteChannelBanRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException
Removes a user from a channel's ban list.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user 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 via DeleteChannelBanRequest.builder()
deleteChannelBanRequest - A Consumer that will call methods on DeleteChannelBanRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 the AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelMembershipRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 the AppInstanceUserArn 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 via DeleteChannelMembershipRequest.builder()
deleteChannelMembershipRequest - A Consumer that will call methods on DeleteChannelMembershipRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelMessageRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user 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 via DeleteChannelMessageRequest.builder()
deleteChannelMessageRequest - A Consumer that will call methods on DeleteChannelMessageRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
deleteChannelModeratorRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user 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 via DeleteChannelModeratorRequest.builder()
deleteChannelModeratorRequest - A Consumer that will call methods on DeleteChannelModeratorRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user 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 via DescribeChannelRequest.builder()
describeChannelRequest - A Consumer that will call methods on DescribeChannelRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelBanRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user 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 via DescribeChannelBanRequest.builder()
describeChannelBanRequest - A Consumer that will call methods on DescribeChannelBanRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelMembershipRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user 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 via DescribeChannelMembershipRequest.builder()
describeChannelMembershipRequest - A Consumer that will call methods on DescribeChannelMembershipRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelMembershipForAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user 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 via
DescribeChannelMembershipForAppInstanceUserRequest.builder()
describeChannelMembershipForAppInstanceUserRequest - A Consumer that will call methods on
DescribeChannelMembershipForAppInstanceUserRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelModeratedByAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user 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 via
DescribeChannelModeratedByAppInstanceUserRequest.builder()
describeChannelModeratedByAppInstanceUserRequest - A Consumer that will call methods on
DescribeChannelModeratedByAppInstanceUserRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 the AppInstanceUserArn of the
user that makes the API call as the value in the header.
describeChannelModeratorRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 the AppInstanceUserArn 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 via DescribeChannelModeratorRequest.builder()
describeChannelModeratorRequest - A Consumer that will call methods on DescribeChannelModeratorRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the user that
makes the API call as the value in the header.
getChannelMessageRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the user 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 via GetChannelMessageRequest.builder()
getChannelMessageRequest - A Consumer that will call methods on GetChannelMessageRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetMessagingSessionEndpointResponse getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest) throws UnauthorizedClientException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException
The details of the endpoint for the messaging session.
getMessagingSessionEndpointRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetMessagingSessionEndpointRequest.builder()
getMessagingSessionEndpointRequest - A Consumer that will call methods on GetMessagingSessionEndpointRequest.Builder to create
a request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelBansResponse listChannelBans(ListChannelBansRequest listChannelBansRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException
Lists all the users banned from a particular channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelBansRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelBansResponse listChannelBans(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException
Lists all the users banned from a particular channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user 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 via ListChannelBansRequest.builder()
listChannelBansRequest - A Consumer that will call methods on ListChannelBansRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelBansIterable listChannelBansPaginator(ListChannelBansRequest listChannelBansRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException
Lists all the users banned from a particular channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
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 Stream
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansIterable responses = client.listChannelBansPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listChannelBansRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelBansIterable listChannelBansPaginator(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException
Lists all the users banned from a particular channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
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 Stream
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansIterable responses = client.listChannelBansPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListChannelBansRequest.builder()
listChannelBansRequest - A Consumer that will call methods on ListChannelBansRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelMembershipsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
This is a convenience which creates an instance of the ListChannelMembershipsRequest.Builder avoiding the
need to create one manually via ListChannelMembershipsRequest.builder()
listChannelMembershipsRequest - A Consumer that will call methods on ListChannelMembershipsRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelMembershipsIterable listChannelMembershipsPaginator(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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
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 Stream
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsIterable responses = client.listChannelMembershipsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listChannelMembershipsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelMembershipsIterable listChannelMembershipsPaginator(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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
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 Stream
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsIterable responses = client.listChannelMembershipsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListChannelMembershipsRequest.builder()
listChannelMembershipsRequest - A Consumer that will call methods on ListChannelMembershipsRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelMembershipsForAppInstanceUserResponse listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException
Lists all channels that a particular AppInstanceUser is a part of. Only an
AppInstanceAdmin can call the API with a user ARN that is not their own.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelMembershipsForAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelMembershipsForAppInstanceUserResponse listChannelMembershipsForAppInstanceUser(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException
Lists all channels that a particular AppInstanceUser is a part of. Only an
AppInstanceAdmin can call the API with a user ARN that is not their own.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user 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 via
ListChannelMembershipsForAppInstanceUserRequest.builder()
listChannelMembershipsForAppInstanceUserRequest - A Consumer that will call methods on
ListChannelMembershipsForAppInstanceUserRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelMembershipsForAppInstanceUserIterable listChannelMembershipsForAppInstanceUserPaginator(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException
Lists all channels that a particular AppInstanceUser is a part of. Only an
AppInstanceAdmin can call the API with a user ARN that is not their own.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
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 Stream
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsForAppInstanceUserIterable responses = client.listChannelMembershipsForAppInstanceUserPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listChannelMembershipsForAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelMembershipsForAppInstanceUserIterable listChannelMembershipsForAppInstanceUserPaginator(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMessagingException
Lists all channels that a particular AppInstanceUser is a part of. Only an
AppInstanceAdmin can call the API with a user ARN that is not their own.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
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 Stream
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMembershipsForAppInstanceUserIterable responses = client.listChannelMembershipsForAppInstanceUserPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via
ListChannelMembershipsForAppInstanceUserRequest.builder()
listChannelMembershipsForAppInstanceUserRequest - A Consumer that will call methods on
ListChannelMembershipsForAppInstanceUserRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the user
that makes the API call as the value in the header.
listChannelMessagesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the user
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 via ListChannelMessagesRequest.builder()
listChannelMessagesRequest - A Consumer that will call methods on ListChannelMessagesRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelMessagesIterable listChannelMessagesPaginator(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 AppInstanceUserArn of the user
that makes the API call as the value in the header.
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 Stream
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMessagesIterable responses = client.listChannelMessagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listChannelMessagesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelMessagesIterable listChannelMessagesPaginator(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 AppInstanceUserArn of the user
that makes the API call as the value in the header.
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 Stream
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelMessagesIterable responses = client.listChannelMessagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListChannelMessagesRequest.builder()
listChannelMessagesRequest - A Consumer that will call methods on ListChannelMessagesRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelModeratorsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user 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 via ListChannelModeratorsRequest.builder()
listChannelModeratorsRequest - A Consumer that will call methods on ListChannelModeratorsRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelModeratorsIterable listChannelModeratorsPaginator(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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
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 Stream
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelModeratorsIterable responses = client.listChannelModeratorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listChannelModeratorsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelModeratorsIterable listChannelModeratorsPaginator(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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
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 Stream
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelModeratorsIterable responses = client.listChannelModeratorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListChannelModeratorsRequest.builder()
listChannelModeratorsRequest - A Consumer that will call methods on ListChannelModeratorsRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user 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 via ListChannelsRequest.builder()
listChannelsRequest - A Consumer that will call methods on ListChannelsRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelsIterable listChannelsPaginator(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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
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 Stream
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listChannelsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelsIterable listChannelsPaginator(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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
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 Stream
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListChannelsRequest.builder()
listChannelsRequest - A Consumer that will call methods on ListChannelsRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
listChannelsModeratedByAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user 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 via
ListChannelsModeratedByAppInstanceUserRequest.builder()
listChannelsModeratedByAppInstanceUserRequest - A Consumer that will call methods on ListChannelsModeratedByAppInstanceUserRequest.Builder
to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelsModeratedByAppInstanceUserIterable listChannelsModeratedByAppInstanceUserPaginator(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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
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 Stream
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsModeratedByAppInstanceUserIterable responses = client.listChannelsModeratedByAppInstanceUserPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listChannelsModeratedByAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelsModeratedByAppInstanceUserIterable listChannelsModeratedByAppInstanceUserPaginator(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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
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 Stream
software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelsModeratedByAppInstanceUserIterable responses = client.listChannelsModeratedByAppInstanceUserPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via
ListChannelsModeratedByAppInstanceUserRequest.builder()
listChannelsModeratedByAppInstanceUserRequest - A Consumer that will call methods on ListChannelsModeratedByAppInstanceUserRequest.Builder
to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RedactChannelMessageResponse redactChannelMessage(RedactChannelMessageRequest redactChannelMessageRequest) throws BadRequestException, ForbiddenException, 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
redactChannelMessageRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RedactChannelMessageResponse redactChannelMessage(Consumer<RedactChannelMessageRequest.Builder> redactChannelMessageRequest) throws BadRequestException, ForbiddenException, 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 AppInstanceUserArn of the
user 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 via RedactChannelMessageRequest.builder()
redactChannelMessageRequest - A Consumer that will call methods on RedactChannelMessageRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL
messages can contain 30 bytes of data and no metadata.
sendChannelMessageRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL
messages can contain 30 bytes of data and no metadata.
This is a convenience which creates an instance of the SendChannelMessageRequest.Builder avoiding the
need to create one manually via SendChannelMessageRequest.builder()
sendChannelMessageRequest - A Consumer that will call methods on SendChannelMessageRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
updateChannelRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user 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 via UpdateChannelRequest.builder()
updateChannelRequest - A Consumer that will call methods on UpdateChannelRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
updateChannelMessageRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user 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 via UpdateChannelMessageRequest.builder()
updateChannelMessageRequest - A Consumer that will call methods on UpdateChannelMessageRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user that makes the API call as the value in the header.
updateChannelReadMarkerRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AppInstanceUserArn of the
user 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 via UpdateChannelReadMarkerRequest.builder()
updateChannelReadMarkerRequest - A Consumer that will call methods on UpdateChannelReadMarkerRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeSdkMessagingException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2021. All rights reserved.