- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
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 Amazon Chime SDK messaging .
Installation
npm install @aws-sdk/client-chime-sdk-messaging
yarn add @aws-sdk/client-chime-sdk-messaging
pnpm add @aws-sdk/client-chime-sdk-messaging
ChimeSDKMessagingClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
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 Only administrators or channel moderators can associate a channel flow. The |
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:
|
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 If you ban a user who is already part of a channel, that user is automatically kicked from the channel. The |
CreateChannelCommand | Creates a channel to which you can add users and send messages. Restriction: You can't change a channel's privacy. The |
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:
Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to Message types in the Amazon Chime developer guide. |
CreateChannelMembershipCommand | Adds a member to a channel. The
Privacy settings impact this action as follows:
The |
CreateChannelModeratorCommand | Creates a new
The |
DeleteChannelBanCommand | Removes a member from a channel's ban list. The |
DeleteChannelCommand | Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process. The |
DeleteChannelFlowCommand | Deletes a channel flow, an irreversible process. This is a developer API. This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the |
DeleteChannelMembershipCommand | Removes a member from a channel. The |
DeleteChannelMessageCommand | Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by The |
DeleteChannelModeratorCommand | Deletes a channel moderator. The |
DeleteMessagingStreamingConfigurationsCommand | Deletes the streaming configurations for an |
DescribeChannelBanCommand | Returns the full details of a channel ban. The |
DescribeChannelCommand | Returns the full details of a channel in an Amazon Chime The |
DescribeChannelFlowCommand | Returns the full details of a channel flow in an Amazon Chime |
DescribeChannelMembershipCommand | Returns the full details of a user's channel membership. The |
DescribeChannelMembershipForAppInstanceUserCommand | Returns the details of a channel based on the membership of the specified The |
DescribeChannelModeratedByAppInstanceUserCommand | Returns the full details of a channel moderated by the specified The |
DescribeChannelModeratorCommand | Returns the full details of a single ChannelModerator. The |
DisassociateChannelFlowCommand | Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor. Only administrators or channel moderators can disassociate a channel flow. The |
GetChannelMembershipPreferencesCommand | Gets the membership preferences of an The |
GetChannelMessageCommand | Gets the full details of a channel message. The |
GetChannelMessageStatusCommand | Gets message status for a specified Messages can have any one of these statuses.
|
GetMessagingSessionEndpointCommand | The details of the endpoint for the messaging session. |
GetMessagingStreamingConfigurationsCommand | Retrieves the data streaming configuration for an |
ListChannelBansCommand | Lists all the users and bots banned from a particular channel. The |
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. The If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API. |
ListChannelMembershipsForAppInstanceUserCommand | Lists all channels that an The |
ListChannelMessagesCommand | List all the messages in a channel. Returns a paginated list of 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 |
ListChannelModeratorsCommand | Lists all the moderators for a channel. The |
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
The |
ListChannelsModeratedByAppInstanceUserCommand | A list of the channels moderated by an The |
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.
|
PutChannelMembershipPreferencesCommand | Sets the membership preferences of an The x-amz-chime-bearer request header is mandatory. Use the ARN of an |
PutMessagingStreamingConfigurationsCommand | Sets the data streaming configuration for an |
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. The |
SearchChannelsCommand | Allows the The |
SendChannelMessageCommand | Sends a message to a particular channel that the member is a part of. The Also, |
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. The |
UpdateChannelFlowCommand | Updates channel flow attributes. This is a developer API. |
UpdateChannelMessageCommand | Updates the content of a message. The |
UpdateChannelReadMarkerCommand | The details of the time when a user last read messages in a channel. The |
ChimeSDKMessagingClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: ChimeSDKMessagingClientConfig