com.amazonaws.services.chimesdkmessaging

Class AmazonChimeSDKMessagingClient

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

Modifier and Type	Method and Description
BatchCreateChannelMembershipResult	batchCreateChannelMembership(BatchCreateChannelMembershipRequest request) Adds a specified number of users to a channel.
static AmazonChimeSDKMessagingClientBuilder	builder()
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.
CreateChannelMembershipResult	createChannelMembership(CreateChannelMembershipRequest request) Adds a user 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 user from a channel's ban list.
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.
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.
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.
DescribeChannelModeratedByAppInstanceUserResult	describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest request) Returns the full details of a channel moderated by the specified AppInstanceUser.
DescribeChannelModeratorResult	describeChannelModerator(DescribeChannelModeratorRequest request) 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 request) Gets the full details of a channel message.
GetMessagingSessionEndpointResult	getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest request) The details of the endpoint for the messaging session.
ListChannelBansResult	listChannelBans(ListChannelBansRequest request) Lists all the users banned from a particular channel.
ListChannelMembershipsResult	listChannelMemberships(ListChannelMembershipsRequest request) Lists all channel memberships in a channel.
ListChannelMembershipsForAppInstanceUserResult	listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest request) Lists all channels that a particular AppInstanceUser 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.
ListChannelsModeratedByAppInstanceUserResult	listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest request) A list of the channels moderated by an AppInstanceUser.
RedactChannelMessageResult	redactChannelMessage(RedactChannelMessageRequest request) Redacts message content, but not metadata.
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.
UpdateChannelResult	updateChannel(UpdateChannelRequest request) Update a channel's 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 com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonChimeSDKMessagingClientBuilder builder()

batchCreateChannelMembership

public BatchCreateChannelMembershipResult batchCreateChannelMembership(BatchCreateChannelMembershipRequest request)

Adds a specified number of users 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.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

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 AppInstanceUserArn of the user 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 AppInstanceUserArn of the user 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

createChannelMembership

public CreateChannelMembershipResult createChannelMembership(CreateChannelMembershipRequest request)

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.

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.

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 AppInstanceUserArn of 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 AppInstanceUserArn of the user 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 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.

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

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 AppInstanceUserArn of the user 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 AppInstanceUserArn of the user 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

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 AppInstanceUserArn of the user 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 AppInstanceUserArn of the user 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

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 AppInstanceUserArn of the user 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.

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:

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.

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:

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

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 AppInstanceUserArn of the user 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

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

listChannelBans

public ListChannelBansResult listChannelBans(ListChannelBansRequest request)

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.

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

listChannelMemberships

public ListChannelMembershipsResult listChannelMemberships(ListChannelMembershipsRequest request)

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.

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 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.

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 AppInstanceUserArn of the user 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 AppInstanceUserArn of the user 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 AppInstanceUserArn of the user 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

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 AppInstanceUserArn of the user 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

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 AppInstanceUserArn of the user 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.

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 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.

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

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 AppInstanceUserArn of the user 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

updateChannelMessage

public UpdateChannelMessageResult updateChannelMessage(UpdateChannelMessageRequest request)

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.

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 AppInstanceUserArn of the user 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