(constructor)

[configuration]

Constructs a new instance of the <code>ChimeSDKMessagingClient</code> class

config

The resolved configuration of ChimeSDKMessagingClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-chime-sdk-messaging!ChimeSDKMessagingClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

ChimeSDKMessagingClient

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 <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

AssociateChannelFlowCommand

Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the <code>DisassociateChannelFlow</code> API. <note> Only administrators or channel moderators can associate a channel flow. The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

BatchCreateChannelMembershipCommand

Adds a specified number of users and bots to a channel.

ChannelFlowCallbackCommand

Calls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API. You can return one of the following processing responses: <ul> <li> Update message content or metadata </li> <li> Deny a message </li> <li> Make no changes to the message </li> </ul>

CreateChannelBanCommand

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to <code>DeleteChannelBan</code>, and then <code>CreateChannelMembership</code>. 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. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

CreateChannelCommand

Creates a channel to which you can add users and send messages. Restriction: You can't change a channel's privacy. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

CreateChannelFlowCommand

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: <ol> <li> New and updated messages </li> <li> Persistent and non-persistent messages </li> <li> The Standard message type </li> </ol> <note> Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to <a href="https://docs.aws.amazon.com/chime/latest/dg/using-the-messaging-sdk.html#msg-types">Message types</a> in the Amazon Chime developer guide. </note>

CreateChannelMembershipCommand

Adds a member to a channel. The <code>InvitedBy</code> field in <code>ChannelMembership</code> is derived from the request header. A channel member can: <ul> <li> List messages </li> <li> Send messages </li> <li> Receive messages </li> <li> Edit their own messages </li> <li> Leave the channel </li> </ul> Privacy settings impact this action as follows: <ul> <li> Public Channels: You do not need to be a member to list messages, but you must be a member to send messages. </li> <li> Private Channels: You must be a member to list or send messages. </li> </ul> <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUserArn</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

CreateChannelModeratorCommand

Creates a new <code>ChannelModerator</code>. A channel moderator can: <ul> <li> Add and remove other members of the channel. </li> <li> Add and remove other moderators of the channel. </li> <li> Add and remove user bans for the channel. </li> <li> Redact messages in the channel. </li> <li> List messages in the channel. </li> </ul> <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>of the user that makes the API call as the value in the header. </note>

DeleteChannelBanCommand

Removes a member from a channel's ban list. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

DeleteChannelCommand

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUserArn</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

DeleteChannelFlowCommand

Deletes a channel flow, an irreversible process. This is a developer API. <note> 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 <code>ListChannelsAssociatedWithChannelFlow</code> API. Use the <code>DisassociateChannelFlow</code> API to disassociate a channel flow from all channels. </note>

DeleteChannelMembershipCommand

Removes a member from a channel. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </note>

DeleteChannelMessageCommand

Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by <code>UpdateChannelMessage</code>. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

DeleteChannelModeratorCommand

Deletes a channel moderator. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

DeleteMessagingStreamingConfigurationsCommand

Deletes the streaming configurations for an <code>AppInstance</code>. For more information, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the Amazon Chime SDK Developer Guide.

DescribeChannelBanCommand

Returns the full details of a channel ban. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

DescribeChannelCommand

Returns the full details of a channel in an Amazon Chime <code>AppInstance</code>. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

DescribeChannelFlowCommand

Returns the full details of a channel flow in an Amazon Chime <code>AppInstance</code>. This is a developer API.

DescribeChannelMembershipCommand

Returns the full details of a user's channel membership. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

DescribeChannelMembershipForAppInstanceUserCommand

Returns the details of a channel based on the membership of the specified <code>AppInstanceUser</code> or <code>AppInstanceBot</code>. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

DescribeChannelModeratedByAppInstanceUserCommand

Returns the full details of a channel moderated by the specified <code>AppInstanceUser</code> or <code>AppInstanceBot</code>. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

DescribeChannelModeratorCommand

Returns the full details of a single ChannelModerator. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </note>

DisassociateChannelFlowCommand

Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor. <note> Only administrators or channel moderators can disassociate a channel flow. The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

GetChannelMembershipPreferencesCommand

Gets the membership preferences of an <code>AppInstanceUser</code> or <code>AppInstanceBot</code> for the specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve membership preferences. Users or bots in the <code>AppInstanceAdmin</code> 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. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

GetChannelMessageCommand

Gets the full details of a channel message. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

GetChannelMessageStatusCommand

Gets message status for a specified <code>messageId</code>. 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. <dl> <dt>SENT</dt> <dd> Message processed successfully </dd> <dt>PENDING</dt> <dd> Ongoing processing </dd> <dt>FAILED</dt> <dd> Processing failed </dd> <dt>DENIED</dt> <dd> Message denied by the processor </dd> </dl> <note> <ul> <li> This API does not return statuses for denied messages, because we don't store them once the processor denies them. </li> <li> Only the message sender can invoke this API. </li> <li> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </li> </ul> </note>

GetMessagingSessionEndpointCommand

The details of the endpoint for the messaging session.

GetMessagingStreamingConfigurationsCommand

Retrieves the data streaming configuration for an <code>AppInstance</code>. For more information, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the Amazon Chime SDK Developer Guide.

ListChannelBansCommand

Lists all the users and bots banned from a particular channel. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

ListChannelFlowsCommand

Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.

ListChannelMembershipsCommand

Lists all channel memberships in a channel. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note> If you want to list the channels to which a specific app instance user belongs, see the <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html">ListChannelMembershipsForAppInstanceUser</a> API.

ListChannelMembershipsForAppInstanceUserCommand

Lists all channels that an <code>AppInstanceUser</code> or <code>AppInstanceBot</code> is a part of. Only an <code>AppInstanceAdmin</code> can call the API with a user ARN that is not their own. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

ListChannelMessagesCommand

List all the messages in a channel. Returns a paginated list of <code>ChannelMessages</code>. By default, sorted by creation timestamp in descending order. <note> 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 <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

ListChannelModeratorsCommand

Lists all the moderators for a channel. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

ListChannelsAssociatedWithChannelFlowCommand

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.

ListChannelsCommand

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results. Functionality & restrictions <ul> <li> Use privacy = <code>PUBLIC</code> to retrieve all public channels in the account. </li> <li> Only an <code>AppInstanceAdmin</code> can set privacy = <code>PRIVATE</code> to list the private channels in an account. </li> </ul> <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

ListChannelsModeratedByAppInstanceUserCommand

A list of the channels moderated by an <code>AppInstanceUser</code>. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

ListSubChannelsCommand

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.

ListTagsForResourceCommand

Lists the tags applied to an Amazon Chime SDK messaging resource.

PutChannelExpirationSettingsCommand

Sets the number of days before the channel is automatically deleted. <note> <ul> <li> A background process deletes expired channels within 6 hours of expiration. Actual deletion times may vary. </li> <li> Expired channels that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings. </li> <li> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </li> </ul> </note>

PutChannelMembershipPreferencesCommand

Sets the membership preferences of an <code>AppInstanceUser</code> or <code>AppInstanceBot</code> 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 <code>AppInstanceAdmin</code> and channel moderator roles can't set preferences for other users. Banned users or bots can't set membership preferences for the channel from which they are banned. <note> The x-amz-chime-bearer request header is mandatory. Use the ARN of an <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

PutMessagingStreamingConfigurationsCommand

Sets the data streaming configuration for an <code>AppInstance</code>. For more information, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the Amazon Chime SDK Developer Guide.

RedactChannelMessageCommand

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. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

SearchChannelsCommand

Allows the <code>ChimeBearer</code> to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the <code>AppInstanceAdmin</code> role can search across all channels. The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header.

SendChannelMessageCommand

Sends a message to a particular channel that the member is a part of. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. Also, <code>STANDARD</code> messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment. <code>CONTROL</code> messages are limited to 30 bytes and do not contain metadata. </note>

TagResourceCommand

Applies the specified tags to the specified Amazon Chime SDK messaging resource.

UntagResourceCommand

Removes the specified tags from the specified Amazon Chime SDK messaging resource.

UpdateChannelCommand

Update a channel's attributes. Restriction: You can't change a channel's privacy. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

UpdateChannelFlowCommand

Updates channel flow attributes. This is a developer API.

UpdateChannelMessageCommand

Updates the content of a message. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>

UpdateChannelReadMarkerCommand

The details of the time when a user last read messages in a channel. <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header. </note>