AmazonChimeSDKMessagingClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.chimesdkmessaging.AmazonChimeSDKMessagingClient

All Implemented Interfaces:

AmazonChimeSDKMessaging

Direct Known Subclasses:

AmazonChimeSDKMessagingAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonChimeSDKMessagingClient
extends AmazonWebServiceClient
implements AmazonChimeSDKMessaging
```
Client for accessing Amazon Chime SDK Messaging. All service calls made using this client are blocking, and will not return until the service call completes.

The Amazon Chime SDK Messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK Identity APIs. For more information about the messaging APIs, see Amazon Chime SDK messaging.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.chimesdkmessaging.AmazonChimeSDKMessaging
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateChannelFlowResult`	`associateChannelFlow(AssociateChannelFlowRequest request)` Associates a channel flow with a channel.
`BatchCreateChannelMembershipResult`	`batchCreateChannelMembership(BatchCreateChannelMembershipRequest request)` Adds a specified number of users and bots to a channel.
`static AmazonChimeSDKMessagingClientBuilder`	`builder()`
`ChannelFlowCallbackResult`	`channelFlowCallback(ChannelFlowCallbackRequest request)` Calls back Chime SDK Messaging with a processing response message.
`CreateChannelResult`	`createChannel(CreateChannelRequest request)` Creates a channel to which you can add users and send messages.
`CreateChannelBanResult`	`createChannelBan(CreateChannelBanRequest request)` Permanently bans a member from a channel.
`CreateChannelFlowResult`	`createChannelFlow(CreateChannelFlowRequest request)` Creates a channel flow, a container for processors.
`CreateChannelMembershipResult`	`createChannelMembership(CreateChannelMembershipRequest request)` Adds a member to a channel.
`CreateChannelModeratorResult`	`createChannelModerator(CreateChannelModeratorRequest request)` Creates a new `ChannelModerator`.
`DeleteChannelResult`	`deleteChannel(DeleteChannelRequest request)` Immediately makes a channel and its memberships inaccessible and marks them for deletion.
`DeleteChannelBanResult`	`deleteChannelBan(DeleteChannelBanRequest request)` Removes a member from a channel's ban list.
`DeleteChannelFlowResult`	`deleteChannelFlow(DeleteChannelFlowRequest request)` Deletes a channel flow, an irreversible process.
`DeleteChannelMembershipResult`	`deleteChannelMembership(DeleteChannelMembershipRequest request)` Removes a member from a channel.
`DeleteChannelMessageResult`	`deleteChannelMessage(DeleteChannelMessageRequest request)` Deletes a channel message.
`DeleteChannelModeratorResult`	`deleteChannelModerator(DeleteChannelModeratorRequest request)` Deletes a channel moderator.
`DeleteMessagingStreamingConfigurationsResult`	`deleteMessagingStreamingConfigurations(DeleteMessagingStreamingConfigurationsRequest request)` Deletes the streaming configurations for an `AppInstance`.
`DescribeChannelResult`	`describeChannel(DescribeChannelRequest request)` Returns the full details of a channel in an Amazon Chime `AppInstance`.
`DescribeChannelBanResult`	`describeChannelBan(DescribeChannelBanRequest request)` Returns the full details of a channel ban.
`DescribeChannelFlowResult`	`describeChannelFlow(DescribeChannelFlowRequest request)` Returns the full details of a channel flow in an Amazon Chime `AppInstance`.
`DescribeChannelMembershipResult`	`describeChannelMembership(DescribeChannelMembershipRequest request)` Returns the full details of a user's channel membership.
`DescribeChannelMembershipForAppInstanceUserResult`	`describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest request)` Returns the details of a channel based on the membership of the specified `AppInstanceUser` or `AppInstanceBot`.
`DescribeChannelModeratedByAppInstanceUserResult`	`describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest request)` Returns the full details of a channel moderated by the specified `AppInstanceUser` or `AppInstanceBot`.
`DescribeChannelModeratorResult`	`describeChannelModerator(DescribeChannelModeratorRequest request)` Returns the full details of a single ChannelModerator.
`DisassociateChannelFlowResult`	`disassociateChannelFlow(DisassociateChannelFlowRequest request)` Disassociates a channel flow from all its channels.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetChannelMembershipPreferencesResult`	`getChannelMembershipPreferences(GetChannelMembershipPreferencesRequest request)` Gets the membership preferences of an `AppInstanceUser` or `AppInstanceBot` for the specified channel.
`GetChannelMessageResult`	`getChannelMessage(GetChannelMessageRequest request)` Gets the full details of a channel message.
`GetChannelMessageStatusResult`	`getChannelMessageStatus(GetChannelMessageStatusRequest request)` Gets message status for a specified `messageId`.
`GetMessagingSessionEndpointResult`	`getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest request)` The details of the endpoint for the messaging session.
`GetMessagingStreamingConfigurationsResult`	`getMessagingStreamingConfigurations(GetMessagingStreamingConfigurationsRequest request)` Retrieves the data streaming configuration for an `AppInstance`.
`ListChannelBansResult`	`listChannelBans(ListChannelBansRequest request)` Lists all the users and bots banned from a particular channel.
`ListChannelFlowsResult`	`listChannelFlows(ListChannelFlowsRequest request)` Returns a paginated lists of all the channel flows created under a single Chime.
`ListChannelMembershipsResult`	`listChannelMemberships(ListChannelMembershipsRequest request)` Lists all channel memberships in a channel.
`ListChannelMembershipsForAppInstanceUserResult`	`listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest request)` Lists all channels that anr `AppInstanceUser` or `AppInstanceBot` is a part of.
`ListChannelMessagesResult`	`listChannelMessages(ListChannelMessagesRequest request)` List all the messages in a channel.
`ListChannelModeratorsResult`	`listChannelModerators(ListChannelModeratorsRequest request)` Lists all the moderators for a channel.
`ListChannelsResult`	`listChannels(ListChannelsRequest request)` Lists all Channels created under a single Chime App as a paginated list.
`ListChannelsAssociatedWithChannelFlowResult`	`listChannelsAssociatedWithChannelFlow(ListChannelsAssociatedWithChannelFlowRequest request)` Lists all channels associated with a specified channel flow.
`ListChannelsModeratedByAppInstanceUserResult`	`listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest request)` A list of the channels moderated by an `AppInstanceUser`.
`ListSubChannelsResult`	`listSubChannels(ListSubChannelsRequest request)` Lists all the SubChannels in an elastic channel when given a channel ID.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists the tags applied to an Amazon Chime SDK messaging resource.
`PutChannelExpirationSettingsResult`	`putChannelExpirationSettings(PutChannelExpirationSettingsRequest request)` Sets the number of days before the channel is automatically deleted.
`PutChannelMembershipPreferencesResult`	`putChannelMembershipPreferences(PutChannelMembershipPreferencesRequest request)` Sets the membership preferences of an `AppInstanceUser` or `AppIntanceBot` for the specified channel.
`PutMessagingStreamingConfigurationsResult`	`putMessagingStreamingConfigurations(PutMessagingStreamingConfigurationsRequest request)` Sets the data streaming configuration for an `AppInstance`.
`RedactChannelMessageResult`	`redactChannelMessage(RedactChannelMessageRequest request)` Redacts message content, but not metadata.
`SearchChannelsResult`	`searchChannels(SearchChannelsRequest request)` Allows the `ChimeBearer` to search channels by channel members.
`SendChannelMessageResult`	`sendChannelMessage(SendChannelMessageRequest request)` Sends a message to a particular channel that the member is a part of.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Applies the specified tags to the specified Amazon Chime SDK messaging resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes the specified tags from the specified Amazon Chime SDK messaging resource.
`UpdateChannelResult`	`updateChannel(UpdateChannelRequest request)` Update a channel's attributes.
`UpdateChannelFlowResult`	`updateChannelFlow(UpdateChannelFlowRequest request)` Updates channel flow attributes.
`UpdateChannelMessageResult`	`updateChannelMessage(UpdateChannelMessageRequest request)` Updates the content of a message.
`UpdateChannelReadMarkerResult`	`updateChannelReadMarker(UpdateChannelReadMarkerRequest request)` The details of the time when a user last read messages in a channel.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AmazonChimeSDKMessagingClientBuilder builder()
```
  - associateChannelFlow
```
public AssociateChannelFlowResult associateChannelFlow(AssociateChannelFlowRequest request)
```
    Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the DisassociateChannelFlow API.
    
    Only administrators or channel moderators can associate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    associateChannelFlow in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    associateChannelFlowRequest -
    
    Returns:
    
    Result of the AssociateChannelFlow operation returned by the service.
    
    Throws:
    
    BadRequestException - The input parameters don't match the service's restrictions.
    
    ForbiddenException - The client is permanently forbidden from making the request.
    
    NotFoundException - One or more of the resources in the request does not exist in the system.
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    ConflictException - The request could not be processed because of conflict in the current state of the resource.
    
    ThrottledClientException - The client exceeded its request rate limit.
    
    ServiceUnavailableException - The service is currently unavailable.
    
    ServiceFailureException - The service encountered an unexpected error.
    
    See Also:
    
    AWS API Documentation
  - batchCreateChannelMembership
```
public BatchCreateChannelMembershipResult batchCreateChannelMembership(BatchCreateChannelMembershipRequest request)
```
    Adds a specified number of users and bots to a channel.
    
    Specified by:
    
    batchCreateChannelMembership in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    batchCreateChannelMembershipRequest -
    
    Returns:
    
    Result of the BatchCreateChannelMembership operation returned by the service.
    
    Throws:
    
    ServiceFailureException - The service encountered an unexpected error.
    
    ServiceUnavailableException - The service is currently unavailable.
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    BadRequestException - The input parameters don't match the service's restrictions.
    
    NotFoundException - One or more of the resources in the request does not exist in the system.
    
    ForbiddenException - The client is permanently forbidden from making the request.
    
    ThrottledClientException - The client exceeded its request rate limit.
    
    ResourceLimitExceededException - The request exceeds the resource limit.
    
    See Also:
    
    AWS API Documentation
  - channelFlowCallback
```
public ChannelFlowCallbackResult channelFlowCallback(ChannelFlowCallbackRequest request)
```
    Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.
    
    You can return one of the following processing responses:
    - Update message content or metadata
    - Deny a message
    - Make no changes to the message
    Specified by:
    
    channelFlowCallback in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    channelFlowCallbackRequest -
    
    Returns:
    
    Result of the ChannelFlowCallback operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createChannel
```
public CreateChannelResult createChannel(CreateChannelRequest request)
```
    Creates a channel to which you can add users and send messages.
    
    Restriction: You can't change a channel's privacy.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    createChannel in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    createChannelRequest -
    
    Returns:
    
    Result of the CreateChannel operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createChannelBan
```
public CreateChannelBanResult createChannelBan(CreateChannelBanRequest request)
```
    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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    createChannelBan in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    createChannelBanRequest -
    
    Returns:
    
    Result of the CreateChannelBan operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createChannelFlow
```
public CreateChannelFlowResult createChannelFlow(CreateChannelFlowRequest request)
```
    Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.
    
    Channel flows process the following items:
    1. New and updated messages
    2. Persistent and non-persistent messages
    3. The Standard message type
    Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to Message types in the Amazon Chime developer guide.
    Specified by:
    
    createChannelFlow in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    createChannelFlowRequest -
    
    Returns:
    
    Result of the CreateChannelFlow operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createChannelMembership
```
public CreateChannelMembershipResult createChannelMembership(CreateChannelMembershipRequest request)
```
    Adds a member to a channel. The InvitedBy field in ChannelMembership is derived from the request header. A channel member can:
    - List messages
    - Send messages
    - Receive messages
    - Edit their own messages
    - Leave the channel
    Privacy settings impact this action as follows:
    - Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
    - Private Channels: You must be a member to list or send messages.
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.
    Specified by:
    
    createChannelMembership in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    createChannelMembershipRequest -
    
    Returns:
    
    Result of the CreateChannelMembership operation returned by the service.
    
    Throws:
    
    BadRequestException - The input parameters don't match the service's restrictions.
    
    NotFoundException - One or more of the resources in the request does not exist in the system.
    
    ForbiddenException - The client is permanently forbidden from making the request.
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    ConflictException - The request could not be processed because of conflict in the current state of the resource.
    
    ResourceLimitExceededException - The request exceeds the resource limit.
    
    ThrottledClientException - The client exceeded its request rate limit.
    
    ServiceUnavailableException - The service is currently unavailable.
    
    ServiceFailureException - The service encountered an unexpected error.
    
    See Also:
    
    AWS API Documentation
  - createChannelModerator
```
public CreateChannelModeratorResult createChannelModerator(CreateChannelModeratorRequest request)
```
    Creates a new ChannelModerator. A channel moderator can:
    - Add and remove other members of the channel.
    - Add and remove other moderators of the channel.
    - Add and remove user bans for the channel.
    - Redact messages in the channel.
    - List messages in the channel.
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBotof the user that makes the API call as the value in the header.
    Specified by:
    
    createChannelModerator in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    createChannelModeratorRequest -
    
    Returns:
    
    Result of the CreateChannelModerator operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteChannel
```
public DeleteChannelResult deleteChannel(DeleteChannelRequest request)
```
    Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    deleteChannel in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    deleteChannelRequest -
    
    Returns:
    
    Result of the DeleteChannel operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteChannelBan
```
public DeleteChannelBanResult deleteChannelBan(DeleteChannelBanRequest request)
```
    Removes a member from a channel's ban list.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    deleteChannelBan in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    deleteChannelBanRequest -
    
    Returns:
    
    Result of the DeleteChannelBan operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteChannelFlow
```
public DeleteChannelFlowResult deleteChannelFlow(DeleteChannelFlowRequest request)
```
    Deletes a channel flow, an irreversible process. This is a developer API.
    
    This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API to disassociate a channel flow from all channels.
    
    Specified by:
    
    deleteChannelFlow in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    deleteChannelFlowRequest -
    
    Returns:
    
    Result of the DeleteChannelFlow operation returned by the service.
    
    Throws:
    
    BadRequestException - The input parameters don't match the service's restrictions.
    
    ForbiddenException - The client is permanently forbidden from making the request.
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    ThrottledClientException - The client exceeded its request rate limit.
    
    ConflictException - The request could not be processed because of conflict in the current state of the resource.
    
    ServiceUnavailableException - The service is currently unavailable.
    
    ServiceFailureException - The service encountered an unexpected error.
    
    See Also:
    
    AWS API Documentation
  - deleteChannelMembership
```
public DeleteChannelMembershipResult deleteChannelMembership(DeleteChannelMembershipRequest request)
```
    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.
    
    Specified by:
    
    deleteChannelMembership in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    deleteChannelMembershipRequest -
    
    Returns:
    
    Result of the DeleteChannelMembership operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteChannelMessage
```
public DeleteChannelMessageResult deleteChannelMessage(DeleteChannelMessageRequest request)
```
    Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    deleteChannelMessage in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    deleteChannelMessageRequest -
    
    Returns:
    
    Result of the DeleteChannelMessage operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteChannelModerator
```
public DeleteChannelModeratorResult deleteChannelModerator(DeleteChannelModeratorRequest request)
```
    Deletes a channel moderator.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    deleteChannelModerator in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    deleteChannelModeratorRequest -
    
    Returns:
    
    Result of the DeleteChannelModerator operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteMessagingStreamingConfigurations
```
public DeleteMessagingStreamingConfigurationsResult deleteMessagingStreamingConfigurations(DeleteMessagingStreamingConfigurationsRequest request)
```
    Deletes the streaming configurations for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.
    
    Specified by:
    
    deleteMessagingStreamingConfigurations in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    deleteMessagingStreamingConfigurationsRequest -
    
    Returns:
    
    Result of the DeleteMessagingStreamingConfigurations operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeChannel
```
public DescribeChannelResult describeChannel(DescribeChannelRequest request)
```
    Returns the full details of a channel in an Amazon Chime AppInstance.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    describeChannel in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    describeChannelRequest -
    
    Returns:
    
    Result of the DescribeChannel operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeChannelBan
```
public DescribeChannelBanResult describeChannelBan(DescribeChannelBanRequest request)
```
    Returns the full details of a channel ban.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    describeChannelBan in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    describeChannelBanRequest -
    
    Returns:
    
    Result of the DescribeChannelBan operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeChannelFlow
```
public DescribeChannelFlowResult describeChannelFlow(DescribeChannelFlowRequest request)
```
    Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.
    
    Specified by:
    
    describeChannelFlow in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    describeChannelFlowRequest -
    
    Returns:
    
    Result of the DescribeChannelFlow operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeChannelMembership
```
public DescribeChannelMembershipResult describeChannelMembership(DescribeChannelMembershipRequest request)
```
    Returns the full details of a user's channel membership.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    describeChannelMembership in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    describeChannelMembershipRequest -
    
    Returns:
    
    Result of the DescribeChannelMembership operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeChannelMembershipForAppInstanceUser
```
public DescribeChannelMembershipForAppInstanceUserResult describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest request)
```
    Returns the details of a channel based on the membership of the specified AppInstanceUser or AppInstanceBot.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    describeChannelMembershipForAppInstanceUser in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    describeChannelMembershipForAppInstanceUserRequest -
    
    Returns:
    
    Result of the DescribeChannelMembershipForAppInstanceUser operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeChannelModeratedByAppInstanceUser
```
public DescribeChannelModeratedByAppInstanceUserResult describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest request)
```
    Returns the full details of a channel moderated by the specified AppInstanceUser or AppInstanceBot.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    describeChannelModeratedByAppInstanceUser in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    describeChannelModeratedByAppInstanceUserRequest -
    
    Returns:
    
    Result of the DescribeChannelModeratedByAppInstanceUser operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeChannelModerator
```
public DescribeChannelModeratorResult describeChannelModerator(DescribeChannelModeratorRequest request)
```
    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.
    
    Specified by:
    
    describeChannelModerator in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    describeChannelModeratorRequest -
    
    Returns:
    
    Result of the DescribeChannelModerator operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - disassociateChannelFlow
```
public DisassociateChannelFlowResult disassociateChannelFlow(DisassociateChannelFlowRequest request)
```
    Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor.
    
    Only administrators or channel moderators can disassociate a channel flow.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    disassociateChannelFlow in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    disassociateChannelFlowRequest -
    
    Returns:
    
    Result of the DisassociateChannelFlow operation returned by the service.
    
    Throws:
    
    BadRequestException - The input parameters don't match the service's restrictions.
    
    ForbiddenException - The client is permanently forbidden from making the request.
    
    NotFoundException - One or more of the resources in the request does not exist in the system.
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    ConflictException - The request could not be processed because of conflict in the current state of the resource.
    
    ThrottledClientException - The client exceeded its request rate limit.
    
    ServiceUnavailableException - The service is currently unavailable.
    
    ServiceFailureException - The service encountered an unexpected error.
    
    See Also:
    
    AWS API Documentation
  - getChannelMembershipPreferences
```
public GetChannelMembershipPreferencesResult getChannelMembershipPreferences(GetChannelMembershipPreferencesRequest request)
```
    Gets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. A user or a bot must be a member of the channel and own the membership to be able to retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the channel from which they are banned.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    getChannelMembershipPreferences in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    getChannelMembershipPreferencesRequest -
    
    Returns:
    
    Result of the GetChannelMembershipPreferences operation returned by the service.
    
    Throws:
    
    BadRequestException - The input parameters don't match the service's restrictions.
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    ForbiddenException - The client is permanently forbidden from making the request.
    
    ThrottledClientException - The client exceeded its request rate limit.
    
    ServiceUnavailableException - The service is currently unavailable.
    
    ServiceFailureException - The service encountered an unexpected error.
    
    See Also:
    
    AWS API Documentation
  - getChannelMessage
```
public GetChannelMessageResult getChannelMessage(GetChannelMessageRequest request)
```
    Gets the full details of a channel message.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    getChannelMessage in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    getChannelMessageRequest -
    
    Returns:
    
    Result of the GetChannelMessage operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getChannelMessageStatus
```
public GetChannelMessageStatusResult getChannelMessageStatus(GetChannelMessageStatusRequest request)
```
    Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket.
    
    Messages can have any one of these statuses.
    
    SENT
    
    Message processed successfully
    
    PENDING
    
    Ongoing processing
    
    FAILED
    
    Processing failed
    
    DENIED
    
    Messasge denied by the processor
    This API does not return statuses for denied messages, because we don't store them once the processor denies them.
    
    Only the message sender can invoke this API.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    Specified by:
    
    getChannelMessageStatus in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    getChannelMessageStatusRequest -
    
    Returns:
    
    Result of the GetChannelMessageStatus operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getMessagingSessionEndpoint
```
public GetMessagingSessionEndpointResult getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest request)
```
    The details of the endpoint for the messaging session.
    
    Specified by:
    
    getMessagingSessionEndpoint in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    getMessagingSessionEndpointRequest -
    
    Returns:
    
    Result of the GetMessagingSessionEndpoint operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getMessagingStreamingConfigurations
```
public GetMessagingStreamingConfigurationsResult getMessagingStreamingConfigurations(GetMessagingStreamingConfigurationsRequest request)
```
    Retrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.
    
    Specified by:
    
    getMessagingStreamingConfigurations in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    getMessagingStreamingConfigurationsRequest -
    
    Returns:
    
    Result of the GetMessagingStreamingConfigurations operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listChannelBans
```
public ListChannelBansResult listChannelBans(ListChannelBansRequest request)
```
    Lists all the users and bots banned from a particular channel.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    listChannelBans in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    listChannelBansRequest -
    
    Returns:
    
    Result of the ListChannelBans operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listChannelFlows
```
public ListChannelFlowsResult listChannelFlows(ListChannelFlowsRequest request)
```
    Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
    
    Specified by:
    
    listChannelFlows in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    listChannelFlowsRequest -
    
    Returns:
    
    Result of the ListChannelFlows operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listChannelMemberships
```
public ListChannelMembershipsResult listChannelMemberships(ListChannelMembershipsRequest request)
```
    Lists all channel memberships in a channel.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
    
    Specified by:
    
    listChannelMemberships in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    listChannelMembershipsRequest -
    
    Returns:
    
    Result of the ListChannelMemberships operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listChannelMembershipsForAppInstanceUser
```
public ListChannelMembershipsForAppInstanceUserResult listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest request)
```
    Lists all channels that anr AppInstanceUser or AppInstanceBot 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    listChannelMembershipsForAppInstanceUser in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    listChannelMembershipsForAppInstanceUserRequest -
    
    Returns:
    
    Result of the ListChannelMembershipsForAppInstanceUser operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listChannelMessages
```
public ListChannelMessagesResult listChannelMessages(ListChannelMessagesRequest request)
```
    List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.
    
    Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
    
    Also, the x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    listChannelMessages in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    listChannelMessagesRequest -
    
    Returns:
    
    Result of the ListChannelMessages operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listChannelModerators
```
public ListChannelModeratorsResult listChannelModerators(ListChannelModeratorsRequest request)
```
    Lists all the moderators for a channel.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    listChannelModerators in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    listChannelModeratorsRequest -
    
    Returns:
    
    Result of the ListChannelModerators operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listChannels
```
public ListChannelsResult listChannels(ListChannelsRequest request)
```
    Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
    
    Functionality & restrictions
    - Use privacy = PUBLIC to retrieve all public channels in the account.
    - Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    Specified by:
    
    listChannels in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    listChannelsRequest -
    
    Returns:
    
    Result of the ListChannels operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listChannelsAssociatedWithChannelFlow
```
public ListChannelsAssociatedWithChannelFlowResult listChannelsAssociatedWithChannelFlow(ListChannelsAssociatedWithChannelFlowRequest request)
```
    Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.
    
    Specified by:
    
    listChannelsAssociatedWithChannelFlow in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    listChannelsAssociatedWithChannelFlowRequest -
    
    Returns:
    
    Result of the ListChannelsAssociatedWithChannelFlow operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listChannelsModeratedByAppInstanceUser
```
public ListChannelsModeratedByAppInstanceUserResult listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest request)
```
    A list of the channels moderated by an AppInstanceUser.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    listChannelsModeratedByAppInstanceUser in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    listChannelsModeratedByAppInstanceUserRequest -
    
    Returns:
    
    Result of the ListChannelsModeratedByAppInstanceUser operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listSubChannels
```
public ListSubChannelsResult listSubChannels(ListSubChannelsRequest request)
```
    Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.
    
    Specified by:
    
    listSubChannels in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    listSubChannelsRequest -
    
    Returns:
    
    Result of the ListSubChannels operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Lists the tags applied to an Amazon Chime SDK messaging resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - putChannelExpirationSettings
```
public PutChannelExpirationSettingsResult putChannelExpirationSettings(PutChannelExpirationSettingsRequest request)
```
    Sets the number of days before the channel is automatically deleted.
    A background process deletes expired channels within 6 hours of expiration. Actual deletion times may vary.
    
    Expired channels that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    Specified by:
    
    putChannelExpirationSettings in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    putChannelExpirationSettingsRequest -
    
    Returns:
    
    Result of the PutChannelExpirationSettings operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - putChannelMembershipPreferences
```
public PutChannelMembershipPreferencesResult putChannelMembershipPreferences(PutChannelMembershipPreferencesRequest request)
```
    Sets the membership preferences of an AppInstanceUser or AppIntanceBot for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't set preferences for other users or users. Banned users or bots can't set membership preferences for the channel from which they are banned.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of an AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    putChannelMembershipPreferences in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    putChannelMembershipPreferencesRequest -
    
    Returns:
    
    Result of the PutChannelMembershipPreferences operation returned by the service.
    
    Throws:
    
    BadRequestException - The input parameters don't match the service's restrictions.
    
    ConflictException - The request could not be processed because of conflict in the current state of the resource.
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    ForbiddenException - The client is permanently forbidden from making the request.
    
    ThrottledClientException - The client exceeded its request rate limit.
    
    ServiceUnavailableException - The service is currently unavailable.
    
    ServiceFailureException - The service encountered an unexpected error.
    
    See Also:
    
    AWS API Documentation
  - putMessagingStreamingConfigurations
```
public PutMessagingStreamingConfigurationsResult putMessagingStreamingConfigurations(PutMessagingStreamingConfigurationsRequest request)
```
    Sets the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.
    
    Specified by:
    
    putMessagingStreamingConfigurations in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    putMessagingStreamingConfigurationsRequest -
    
    Returns:
    
    Result of the PutMessagingStreamingConfigurations operation returned by the service.
    
    Throws:
    
    NotFoundException - One or more of the resources in the request does not exist in the system.
    
    BadRequestException - The input parameters don't match the service's restrictions.
    
    ForbiddenException - The client is permanently forbidden from making the request.
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    ThrottledClientException - The client exceeded its request rate limit.
    
    ConflictException - The request could not be processed because of conflict in the current state of the resource.
    
    ServiceUnavailableException - The service is currently unavailable.
    
    ServiceFailureException - The service encountered an unexpected error.
    
    See Also:
    
    AWS API Documentation
  - redactChannelMessage
```
public RedactChannelMessageResult redactChannelMessage(RedactChannelMessageRequest request)
```
    Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    redactChannelMessage in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    redactChannelMessageRequest -
    
    Returns:
    
    Result of the RedactChannelMessage operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - searchChannels
```
public SearchChannelsResult searchChannels(SearchChannelsRequest request)
```
    Allows the ChimeBearer to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin role can search across all channels.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    searchChannels in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    searchChannelsRequest -
    
    Returns:
    
    Result of the SearchChannels operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - sendChannelMessage
```
public SendChannelMessageResult sendChannelMessage(SendChannelMessageRequest request)
```
    Sends a message to a particular channel that the member is a part of.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot 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.
    
    Specified by:
    
    sendChannelMessage in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    sendChannelMessageRequest -
    
    Returns:
    
    Result of the SendChannelMessage operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Applies the specified tags to the specified Amazon Chime SDK messaging resource.
    
    Specified by:
    
    tagResource in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    BadRequestException - The input parameters don't match the service's restrictions.
    
    ForbiddenException - The client is permanently forbidden from making the request.
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    ResourceLimitExceededException - The request exceeds the resource limit.
    
    ThrottledClientException - The client exceeded its request rate limit.
    
    ServiceUnavailableException - The service is currently unavailable.
    
    ServiceFailureException - The service encountered an unexpected error.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes the specified tags from the specified Amazon Chime SDK messaging resource.
    
    Specified by:
    
    untagResource in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateChannel
```
public UpdateChannelResult updateChannel(UpdateChannelRequest request)
```
    Update a channel's attributes.
    
    Restriction: You can't change a channel's privacy.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    updateChannel in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    updateChannelRequest -
    
    Returns:
    
    Result of the UpdateChannel operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateChannelFlow
```
public UpdateChannelFlowResult updateChannelFlow(UpdateChannelFlowRequest request)
```
    Updates channel flow attributes. This is a developer API.
    
    Specified by:
    
    updateChannelFlow in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    updateChannelFlowRequest -
    
    Returns:
    
    Result of the UpdateChannelFlow operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateChannelMessage
```
public UpdateChannelMessageResult updateChannelMessage(UpdateChannelMessageRequest request)
```
    Updates the content of a message.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    updateChannelMessage in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    updateChannelMessageRequest -
    
    Returns:
    
    Result of the UpdateChannelMessage operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateChannelReadMarker
```
public UpdateChannelReadMarkerResult updateChannelReadMarker(UpdateChannelReadMarkerRequest request)
```
    The details of the time when a user last read messages in a channel.
    
    The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
    
    Specified by:
    
    updateChannelReadMarker in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    updateChannelReadMarkerRequest -
    
    Returns:
    
    Result of the UpdateChannelReadMarker operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonChimeSDKMessaging
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonChimeSDKMessaging
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AmazonChimeSDKMessagingClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.chimesdkmessaging.AmazonChimeSDKMessaging

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

associateChannelFlow

batchCreateChannelMembership

channelFlowCallback

createChannel

createChannelBan

createChannelFlow

createChannelMembership

createChannelModerator

deleteChannel

deleteChannelBan

deleteChannelFlow

deleteChannelMembership

deleteChannelMessage

deleteChannelModerator

deleteMessagingStreamingConfigurations

describeChannel

describeChannelBan

describeChannelFlow

describeChannelMembership

describeChannelMembershipForAppInstanceUser

describeChannelModeratedByAppInstanceUser

describeChannelModerator

disassociateChannelFlow

getChannelMembershipPreferences

getChannelMessage

getChannelMessageStatus

getMessagingSessionEndpoint

getMessagingStreamingConfigurations

listChannelBans

listChannelFlows

listChannelMemberships

listChannelMembershipsForAppInstanceUser

listChannelMessages

listChannelModerators

listChannels

listChannelsAssociatedWithChannelFlow

listChannelsModeratedByAppInstanceUser

listSubChannels

listTagsForResource

putChannelExpirationSettings

putChannelMembershipPreferences

putMessagingStreamingConfigurations

redactChannelMessage

searchChannels

sendChannelMessage

tagResource

untagResource

updateChannel

updateChannelFlow

updateChannelMessage

updateChannelReadMarker

getCachedResponseMetadata

shutdown