AmazonChimeSDKMessaging (AWS Java SDK for Amazon Chime SDK Messaging 1.12.55 API)

All Known Subinterfaces:

AmazonChimeSDKMessagingAsync

All Known Implementing Classes:

AbstractAmazonChimeSDKMessaging, AbstractAmazonChimeSDKMessagingAsync, AmazonChimeSDKMessagingAsyncClient, AmazonChimeSDKMessagingClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonChimeSDKMessaging
```
Interface for accessing Amazon Chime SDK Messaging.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonChimeSDKMessaging instead.

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 .

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BatchCreateChannelMembershipResult`	`batchCreateChannelMembership(BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest)` Adds a specified number of users to a channel.
`CreateChannelResult`	`createChannel(CreateChannelRequest createChannelRequest)` Creates a channel to which you can add users and send messages.
`CreateChannelBanResult`	`createChannelBan(CreateChannelBanRequest createChannelBanRequest)` Permanently bans a member from a channel.
`CreateChannelMembershipResult`	`createChannelMembership(CreateChannelMembershipRequest createChannelMembershipRequest)` Adds a user to a channel.
`CreateChannelModeratorResult`	`createChannelModerator(CreateChannelModeratorRequest createChannelModeratorRequest)` Creates a new `ChannelModerator`.
`DeleteChannelResult`	`deleteChannel(DeleteChannelRequest deleteChannelRequest)` Immediately makes a channel and its memberships inaccessible and marks them for deletion.
`DeleteChannelBanResult`	`deleteChannelBan(DeleteChannelBanRequest deleteChannelBanRequest)` Removes a user from a channel's ban list.
`DeleteChannelMembershipResult`	`deleteChannelMembership(DeleteChannelMembershipRequest deleteChannelMembershipRequest)` Removes a member from a channel.
`DeleteChannelMessageResult`	`deleteChannelMessage(DeleteChannelMessageRequest deleteChannelMessageRequest)` Deletes a channel message.
`DeleteChannelModeratorResult`	`deleteChannelModerator(DeleteChannelModeratorRequest deleteChannelModeratorRequest)` Deletes a channel moderator.
`DescribeChannelResult`	`describeChannel(DescribeChannelRequest describeChannelRequest)` Returns the full details of a channel in an Amazon Chime `AppInstance`.
`DescribeChannelBanResult`	`describeChannelBan(DescribeChannelBanRequest describeChannelBanRequest)` Returns the full details of a channel ban.
`DescribeChannelMembershipResult`	`describeChannelMembership(DescribeChannelMembershipRequest describeChannelMembershipRequest)` Returns the full details of a user's channel membership.
`DescribeChannelMembershipForAppInstanceUserResult`	`describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest describeChannelMembershipForAppInstanceUserRequest)` Returns the details of a channel based on the membership of the specified `AppInstanceUser`.
`DescribeChannelModeratedByAppInstanceUserResult`	`describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest describeChannelModeratedByAppInstanceUserRequest)` Returns the full details of a channel moderated by the specified `AppInstanceUser`.
`DescribeChannelModeratorResult`	`describeChannelModerator(DescribeChannelModeratorRequest describeChannelModeratorRequest)` Returns the full details of a single ChannelModerator.
`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.
`GetChannelMessageResult`	`getChannelMessage(GetChannelMessageRequest getChannelMessageRequest)` Gets the full details of a channel message.
`GetMessagingSessionEndpointResult`	`getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest)` The details of the endpoint for the messaging session.
`ListChannelBansResult`	`listChannelBans(ListChannelBansRequest listChannelBansRequest)` Lists all the users banned from a particular channel.
`ListChannelMembershipsResult`	`listChannelMemberships(ListChannelMembershipsRequest listChannelMembershipsRequest)` Lists all channel memberships in a channel.
`ListChannelMembershipsForAppInstanceUserResult`	`listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest)` Lists all channels that a particular `AppInstanceUser` is a part of.
`ListChannelMessagesResult`	`listChannelMessages(ListChannelMessagesRequest listChannelMessagesRequest)` List all the messages in a channel.
`ListChannelModeratorsResult`	`listChannelModerators(ListChannelModeratorsRequest listChannelModeratorsRequest)` Lists all the moderators for a channel.
`ListChannelsResult`	`listChannels(ListChannelsRequest listChannelsRequest)` Lists all Channels created under a single Chime App as a paginated list.
`ListChannelsModeratedByAppInstanceUserResult`	`listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest)` A list of the channels moderated by an `AppInstanceUser`.
`RedactChannelMessageResult`	`redactChannelMessage(RedactChannelMessageRequest redactChannelMessageRequest)` Redacts message content, but not metadata.
`SendChannelMessageResult`	`sendChannelMessage(SendChannelMessageRequest sendChannelMessageRequest)` 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.
`UpdateChannelResult`	`updateChannel(UpdateChannelRequest updateChannelRequest)` Update a channel's attributes.
`UpdateChannelMessageResult`	`updateChannelMessage(UpdateChannelMessageRequest updateChannelMessageRequest)` Updates the content of a message.
`UpdateChannelReadMarkerResult`	`updateChannelReadMarker(UpdateChannelReadMarkerRequest updateChannelReadMarkerRequest)` The details of the time when a user last read messages in a channel.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - batchCreateChannelMembership
```
BatchCreateChannelMembershipResult batchCreateChannelMembership(BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest)
```
    Adds a specified number of users to a channel.
    
    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.
    
    ForbiddenException - The client is permanently forbidden from making the request.
    
    ThrottledClientException - The client exceeded its request rate limit.
    
    See Also:
    
    AWS API Documentation
  - createChannel
```
CreateChannelResult createChannel(CreateChannelRequest createChannelRequest)
```
    Creates a channel to which you can add users and send messages.
    
    Restriction: You can't change a channel's privacy.
    
    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
    
    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
```
CreateChannelBanResult createChannelBan(CreateChannelBanRequest createChannelBanRequest)
```
    Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and 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.
    
    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
  - createChannelMembership
```
CreateChannelMembershipResult createChannelMembership(CreateChannelMembershipRequest createChannelMembershipRequest)
```
    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.
    Parameters:
    
    createChannelMembershipRequest -
    
    Returns:
    
    Result of the CreateChannelMembership 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
  - createChannelModerator
```
CreateChannelModeratorResult createChannelModerator(CreateChannelModeratorRequest createChannelModeratorRequest)
```
    Creates a new ChannelModerator. A channel moderator can:
    - Add and remove other members of the channel.
    - Add and remove other moderators of the channel.
    - Add and remove user bans for the channel.
    - Redact messages in the channel.
    - List messages in the channel.
    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
    Parameters:
    
    createChannelModeratorRequest -
    
    Returns:
    
    Result of the CreateChannelModerator operation returned by the service.
    
    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
```
DeleteChannelResult deleteChannel(DeleteChannelRequest deleteChannelRequest)
```
    Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
    
    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
    
    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
```
DeleteChannelBanResult deleteChannelBan(DeleteChannelBanRequest deleteChannelBanRequest)
```
    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.
    
    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
  - deleteChannelMembership
```
DeleteChannelMembershipResult deleteChannelMembership(DeleteChannelMembershipRequest deleteChannelMembershipRequest)
```
    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.
    
    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
```
DeleteChannelMessageResult deleteChannelMessage(DeleteChannelMessageRequest deleteChannelMessageRequest)
```
    Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.
    
    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
    
    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
```
DeleteChannelModeratorResult deleteChannelModerator(DeleteChannelModeratorRequest deleteChannelModeratorRequest)
```
    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.
    
    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
  - describeChannel
```
DescribeChannelResult describeChannel(DescribeChannelRequest describeChannelRequest)
```
    Returns the full details of a channel in an Amazon Chime AppInstance.
    
    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
    
    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
```
DescribeChannelBanResult describeChannelBan(DescribeChannelBanRequest describeChannelBanRequest)
```
    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.
    
    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
  - describeChannelMembership
```
DescribeChannelMembershipResult describeChannelMembership(DescribeChannelMembershipRequest describeChannelMembershipRequest)
```
    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.
    
    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
```
DescribeChannelMembershipForAppInstanceUserResult describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest describeChannelMembershipForAppInstanceUserRequest)
```
    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.
    
    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
```
DescribeChannelModeratedByAppInstanceUserResult describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest describeChannelModeratedByAppInstanceUserRequest)
```
    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.
    
    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
```
DescribeChannelModeratorResult describeChannelModerator(DescribeChannelModeratorRequest describeChannelModeratorRequest)
```
    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.
    
    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
  - getChannelMessage
```
GetChannelMessageResult getChannelMessage(GetChannelMessageRequest getChannelMessageRequest)
```
    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.
    
    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
  - getMessagingSessionEndpoint
```
GetMessagingSessionEndpointResult getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest)
```
    The details of the endpoint for the messaging session.
    
    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
  - listChannelBans
```
ListChannelBansResult listChannelBans(ListChannelBansRequest listChannelBansRequest)
```
    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.
    
    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
  - listChannelMemberships
```
ListChannelMembershipsResult listChannelMemberships(ListChannelMembershipsRequest listChannelMembershipsRequest)
```
    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.
    
    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
```
ListChannelMembershipsForAppInstanceUserResult listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest)
```
    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.
    
    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
```
ListChannelMessagesResult listChannelMessages(ListChannelMessagesRequest listChannelMessagesRequest)
```
    List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.
    
    Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
    
    Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
    
    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
```
ListChannelModeratorsResult listChannelModerators(ListChannelModeratorsRequest listChannelModeratorsRequest)
```
    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.
    
    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
```
ListChannelsResult listChannels(ListChannelsRequest listChannelsRequest)
```
    Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
    
    Functionality & restrictions
    - Use privacy = PUBLIC to retrieve all public channels in the account.
    - Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.
    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
    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
  - listChannelsModeratedByAppInstanceUser
```
ListChannelsModeratedByAppInstanceUserResult listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest)
```
    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.
    
    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
  - redactChannelMessage
```
RedactChannelMessageResult redactChannelMessage(RedactChannelMessageRequest redactChannelMessageRequest)
```
    Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
    
    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
    
    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.
    
    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
```
SendChannelMessageResult sendChannelMessage(SendChannelMessageRequest sendChannelMessageRequest)
```
    Sends a message to a particular channel that the member is a part of.
    
    The x-amz-chime-bearer request header is mandatory. Use the 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.
    
    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
  - updateChannel
```
UpdateChannelResult updateChannel(UpdateChannelRequest updateChannelRequest)
```
    Update a channel's attributes.
    
    Restriction: You can't change a channel's privacy.
    
    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
    
    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
  - updateChannelMessage
```
UpdateChannelMessageResult updateChannelMessage(UpdateChannelMessageRequest updateChannelMessageRequest)
```
    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.
    
    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
```
UpdateChannelReadMarkerResult updateChannelReadMarker(UpdateChannelReadMarkerRequest updateChannelReadMarkerRequest)
```
    The details of the time when a user last read messages in a channel.
    
    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
    
    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
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Interface AmazonChimeSDKMessaging

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

batchCreateChannelMembership

createChannel

createChannelBan

createChannelMembership

createChannelModerator

deleteChannel

deleteChannelBan

deleteChannelMembership

deleteChannelMessage

deleteChannelModerator

describeChannel

describeChannelBan

describeChannelMembership

describeChannelMembershipForAppInstanceUser

describeChannelModeratedByAppInstanceUser

describeChannelModerator

getChannelMessage

getMessagingSessionEndpoint

listChannelBans

listChannelMemberships

listChannelMembershipsForAppInstanceUser

listChannelMessages

listChannelModerators

listChannels

listChannelsModeratedByAppInstanceUser

redactChannelMessage

sendChannelMessage

updateChannel

updateChannelMessage

updateChannelReadMarker

shutdown

getCachedResponseMetadata