Navigation Guide
You are on the package index page for the Client of a service. Return to the Client landing page

@aws-sdk/client-chime-sdk-messaging

Description

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

npm install @aws-sdk/client-chime-sdk-messaging

Yarn

yarn add @aws-sdk/client-chime-sdk-messaging

pnpm

pnpm add @aws-sdk/client-chime-sdk-messaging

Types

Type Name	Type
AllowNotifications	TypeAlias
AllowNotificationsenum	Variable
AppInstanceUserMembershipSummary	Interface
AssociateChannelFlowCommand	Class
AssociateChannelFlowCommandInput	Interface
AssociateChannelFlowCommandOutput	Interface
AssociateChannelFlowRequest	Interface
BadRequestException	Class
BatchChannelMemberships	Interface
BatchCreateChannelMembershipCommand	Class
BatchCreateChannelMembershipCommandInput	Interface
BatchCreateChannelMembershipCommandOutput	Interface
BatchCreateChannelMembershipError	Interface
BatchCreateChannelMembershipRequest	Interface
BatchCreateChannelMembershipResponse	Interface
Channel	Interface
ChannelAssociatedWithFlowSummary	Interface
ChannelBan	Interface
ChannelBanSummary	Interface
ChannelFlow	Interface
ChannelFlowCallbackCommand	Class
ChannelFlowCallbackCommandInput	Interface
ChannelFlowCallbackCommandOutput	Interface
ChannelFlowCallbackRequest	Interface
ChannelFlowCallbackResponse	Interface
ChannelFlowSummary	Interface
ChannelMembership	Interface
ChannelMembershipForAppInstanceUserSummary	Interface
ChannelMembershipPreferences	Interface
ChannelMembershipSummary	Interface
ChannelMembershipType	TypeAlias
ChannelMembershipTypeenum	Variable
ChannelMessage	Interface
ChannelMessageCallback	Interface
ChannelMessagePersistenceType	TypeAlias
ChannelMessagePersistenceTypeenum	Variable
ChannelMessageStatus	TypeAlias
ChannelMessageStatusenum	Variable
ChannelMessageStatusStructure	Interface
ChannelMessageSummary	Interface
ChannelMessageType	TypeAlias
ChannelMessageTypeenum	Variable
ChannelMode	TypeAlias
ChannelModeenum	Variable
ChannelModeratedByAppInstanceUserSummary	Interface
ChannelModerator	Interface
ChannelModeratorSummary	Interface
ChannelPrivacy	TypeAlias
ChannelPrivacyenum	Variable
ChannelSummary	Interface
ChimeSDKMessaging	Class
ChimeSDKMessaging	Interface
ChimeSDKMessagingClient	Class
ChimeSDKMessagingClientConfig	Interface
ChimeSDKMessagingClientConfigType	TypeAlias
ChimeSDKMessagingClientResolvedConfig	Interface
ChimeSDKMessagingClientResolvedConfigType	TypeAlias
ChimeSDKMessagingPaginationConfiguration	Interface
ChimeSDKMessagingServiceException	Class
ClientDefaults	Interface
ClientInputEndpointParameters	Interface
ConflictException	Class
CreateChannelBanCommand	Class
CreateChannelBanCommandInput	Interface
CreateChannelBanCommandOutput	Interface
CreateChannelBanRequest	Interface
CreateChannelBanResponse	Interface
CreateChannelCommand	Class
CreateChannelCommandInput	Interface
CreateChannelCommandOutput	Interface
CreateChannelFlowCommand	Class
CreateChannelFlowCommandInput	Interface
CreateChannelFlowCommandOutput	Interface
CreateChannelFlowRequest	Interface
CreateChannelFlowResponse	Interface
CreateChannelMembershipCommand	Class
CreateChannelMembershipCommandInput	Interface
CreateChannelMembershipCommandOutput	Interface
CreateChannelMembershipRequest	Interface
CreateChannelMembershipResponse	Interface
CreateChannelModeratorCommand	Class
CreateChannelModeratorCommandInput	Interface
CreateChannelModeratorCommandOutput	Interface
CreateChannelModeratorRequest	Interface
CreateChannelModeratorResponse	Interface
CreateChannelRequest	Interface
CreateChannelResponse	Interface
DeleteChannelBanCommand	Class
DeleteChannelBanCommandInput	Interface
DeleteChannelBanCommandOutput	Interface
DeleteChannelBanRequest	Interface
DeleteChannelCommand	Class
DeleteChannelCommandInput	Interface
DeleteChannelCommandOutput	Interface
DeleteChannelFlowCommand	Class
DeleteChannelFlowCommandInput	Interface
DeleteChannelFlowCommandOutput	Interface
DeleteChannelFlowRequest	Interface
DeleteChannelMembershipCommand	Class
DeleteChannelMembershipCommandInput	Interface
DeleteChannelMembershipCommandOutput	Interface
DeleteChannelMembershipRequest	Interface
DeleteChannelMessageCommand	Class
DeleteChannelMessageCommandInput	Interface
DeleteChannelMessageCommandOutput	Interface
DeleteChannelMessageRequest	Interface
DeleteChannelModeratorCommand	Class
DeleteChannelModeratorCommandInput	Interface
DeleteChannelModeratorCommandOutput	Interface
DeleteChannelModeratorRequest	Interface
DeleteChannelRequest	Interface
DeleteMessagingStreamingConfigurationsCommand	Class
DeleteMessagingStreamingConfigurationsCommandInput	Interface
DeleteMessagingStreamingConfigurationsCommandOutput	Interface
DeleteMessagingStreamingConfigurationsRequest	Interface
DescribeChannelBanCommand	Class
DescribeChannelBanCommandInput	Interface
DescribeChannelBanCommandOutput	Interface
DescribeChannelBanRequest	Interface
DescribeChannelBanResponse	Interface
DescribeChannelCommand	Class
DescribeChannelCommandInput	Interface
DescribeChannelCommandOutput	Interface
DescribeChannelFlowCommand	Class
DescribeChannelFlowCommandInput	Interface
DescribeChannelFlowCommandOutput	Interface
DescribeChannelFlowRequest	Interface
DescribeChannelFlowResponse	Interface
DescribeChannelMembershipCommand	Class
DescribeChannelMembershipCommandInput	Interface
DescribeChannelMembershipCommandOutput	Interface
DescribeChannelMembershipForAppInstanceUserCommand	Class
DescribeChannelMembershipForAppInstanceUserCommandInput	Interface
DescribeChannelMembershipForAppInstanceUserCommandOutput	Interface
DescribeChannelMembershipForAppInstanceUserRequest	Interface
DescribeChannelMembershipForAppInstanceUserResponse	Interface
DescribeChannelMembershipRequest	Interface
DescribeChannelMembershipResponse	Interface
DescribeChannelModeratedByAppInstanceUserCommand	Class
DescribeChannelModeratedByAppInstanceUserCommandInput	Interface
DescribeChannelModeratedByAppInstanceUserCommandOutput	Interface
DescribeChannelModeratedByAppInstanceUserRequest	Interface
DescribeChannelModeratedByAppInstanceUserResponse	Interface
DescribeChannelModeratorCommand	Class
DescribeChannelModeratorCommandInput	Interface
DescribeChannelModeratorCommandOutput	Interface
DescribeChannelModeratorRequest	Interface
DescribeChannelModeratorResponse	Interface
DescribeChannelRequest	Interface
DescribeChannelResponse	Interface
DisassociateChannelFlowCommand	Class
DisassociateChannelFlowCommandInput	Interface
DisassociateChannelFlowCommandOutput	Interface
DisassociateChannelFlowRequest	Interface
ElasticChannelConfiguration	Interface
ErrorCode	TypeAlias
ErrorCodeenum	Variable
ExpirationCriterion	TypeAlias
ExpirationCriterionenum	Variable
ExpirationSettings	Interface
FallbackAction	TypeAlias
FallbackActionenum	Variable
ForbiddenException	Class
GetChannelMembershipPreferencesCommand	Class
GetChannelMembershipPreferencesCommandInput	Interface
GetChannelMembershipPreferencesCommandOutput	Interface
GetChannelMembershipPreferencesRequest	Interface
GetChannelMembershipPreferencesResponse	Interface
GetChannelMessageCommand	Class
GetChannelMessageCommandInput	Interface
GetChannelMessageCommandOutput	Interface
GetChannelMessageRequest	Interface
GetChannelMessageResponse	Interface
GetChannelMessageStatusCommand	Class
GetChannelMessageStatusCommandInput	Interface
GetChannelMessageStatusCommandOutput	Interface
GetChannelMessageStatusRequest	Interface
GetChannelMessageStatusResponse	Interface
GetMessagingSessionEndpointCommand	Class
GetMessagingSessionEndpointCommandInput	Interface
GetMessagingSessionEndpointCommandOutput	Interface
GetMessagingSessionEndpointRequest	Interface
GetMessagingSessionEndpointResponse	Interface
GetMessagingStreamingConfigurationsCommand	Class
GetMessagingStreamingConfigurationsCommandInput	Interface
GetMessagingStreamingConfigurationsCommandOutput	Interface
GetMessagingStreamingConfigurationsRequest	Interface
GetMessagingStreamingConfigurationsResponse	Interface
Identity	Interface
InvocationType	TypeAlias
InvocationTypeenum	Variable
LambdaConfiguration	Interface
ListChannelBansCommand	Class
ListChannelBansCommandInput	Interface
ListChannelBansCommandOutput	Interface
ListChannelBansRequest	Interface
ListChannelBansResponse	Interface
ListChannelFlowsCommand	Class
ListChannelFlowsCommandInput	Interface
ListChannelFlowsCommandOutput	Interface
ListChannelFlowsRequest	Interface
ListChannelFlowsResponse	Interface
ListChannelMembershipsCommand	Class
ListChannelMembershipsCommandInput	Interface
ListChannelMembershipsCommandOutput	Interface
ListChannelMembershipsForAppInstanceUserCommand	Class
ListChannelMembershipsForAppInstanceUserCommandInput	Interface
ListChannelMembershipsForAppInstanceUserCommandOutput	Interface
ListChannelMembershipsForAppInstanceUserRequest	Interface
ListChannelMembershipsForAppInstanceUserResponse	Interface
ListChannelMembershipsRequest	Interface
ListChannelMembershipsResponse	Interface
ListChannelMessagesCommand	Class
ListChannelMessagesCommandInput	Interface
ListChannelMessagesCommandOutput	Interface
ListChannelMessagesRequest	Interface
ListChannelMessagesResponse	Interface
ListChannelModeratorsCommand	Class
ListChannelModeratorsCommandInput	Interface
ListChannelModeratorsCommandOutput	Interface
ListChannelModeratorsRequest	Interface
ListChannelModeratorsResponse	Interface
ListChannelsAssociatedWithChannelFlowCommand	Class
ListChannelsAssociatedWithChannelFlowCommandInput	Interface
ListChannelsAssociatedWithChannelFlowCommandOutput	Interface
ListChannelsAssociatedWithChannelFlowRequest	Interface
ListChannelsAssociatedWithChannelFlowResponse	Interface
ListChannelsCommand	Class
ListChannelsCommandInput	Interface
ListChannelsCommandOutput	Interface
ListChannelsModeratedByAppInstanceUserCommand	Class
ListChannelsModeratedByAppInstanceUserCommandInput	Interface
ListChannelsModeratedByAppInstanceUserCommandOutput	Interface
ListChannelsModeratedByAppInstanceUserRequest	Interface
ListChannelsModeratedByAppInstanceUserResponse	Interface
ListChannelsRequest	Interface
ListChannelsResponse	Interface
ListSubChannelsCommand	Class
ListSubChannelsCommandInput	Interface
ListSubChannelsCommandOutput	Interface
ListSubChannelsRequest	Interface
ListSubChannelsResponse	Interface
ListTagsForResourceCommand	Class
ListTagsForResourceCommandInput	Interface
ListTagsForResourceCommandOutput	Interface
ListTagsForResourceRequest	Interface
ListTagsForResourceResponse	Interface
MessageAttributeValue	Interface
MessagingDataType	TypeAlias
MessagingDataTypeenum	Variable
MessagingSessionEndpoint	Interface
NotFoundException	Class
paginateListChannelBans	Variable
paginateListChannelFlows	Variable
paginateListChannelMemberships	Variable
paginateListChannelMembershipsForAppInstanceUser	Variable
paginateListChannelMessages	Variable
paginateListChannelModerators	Variable
paginateListChannels	Variable
paginateListChannelsAssociatedWithChannelFlow	Variable
paginateListChannelsModeratedByAppInstanceUser	Variable
paginateListSubChannels	Variable
paginateSearchChannels	Variable
Processor	Interface
ProcessorConfiguration	Interface
PushNotificationConfiguration	Interface
PushNotificationPreferences	Interface
PushNotificationType	TypeAlias
PushNotificationTypeenum	Variable
PutChannelExpirationSettingsCommand	Class
PutChannelExpirationSettingsCommandInput	Interface
PutChannelExpirationSettingsCommandOutput	Interface
PutChannelExpirationSettingsRequest	Interface
PutChannelExpirationSettingsResponse	Interface
PutChannelMembershipPreferencesCommand	Class
PutChannelMembershipPreferencesCommandInput	Interface
PutChannelMembershipPreferencesCommandOutput	Interface
PutChannelMembershipPreferencesRequest	Interface
PutChannelMembershipPreferencesResponse	Interface
PutMessagingStreamingConfigurationsCommand	Class
PutMessagingStreamingConfigurationsCommandInput	Interface
PutMessagingStreamingConfigurationsCommandOutput	Interface
PutMessagingStreamingConfigurationsRequest	Interface
PutMessagingStreamingConfigurationsResponse	Interface
RedactChannelMessageCommand	Class
RedactChannelMessageCommandInput	Interface
RedactChannelMessageCommandOutput	Interface
RedactChannelMessageRequest	Interface
RedactChannelMessageResponse	Interface
ResourceLimitExceededException	Class
RuntimeExtension	Interface
SearchChannelsCommand	Class
SearchChannelsCommandInput	Interface
SearchChannelsCommandOutput	Interface
SearchChannelsRequest	Interface
SearchChannelsResponse	Interface
SearchField	Interface
SearchFieldKey	TypeAlias
SearchFieldKeyenum	Variable
SearchFieldOperator	TypeAlias
SearchFieldOperatorenum	Variable
SendChannelMessageCommand	Class
SendChannelMessageCommandInput	Interface
SendChannelMessageCommandOutput	Interface
SendChannelMessageRequest	Interface
SendChannelMessageResponse	Interface
ServiceFailureException	Class
ServiceInputTypes	TypeAlias
ServiceOutputTypes	TypeAlias
ServiceUnavailableException	Class
SortOrder	TypeAlias
SortOrderenum	Variable
StreamingConfiguration	Interface
SubChannelSummary	Interface
Tag	Interface
TagResourceCommand	Class
TagResourceCommandInput	Interface
TagResourceCommandOutput	Interface
TagResourceRequest	Interface
Target	Interface
ThrottledClientException	Class
UnauthorizedClientException	Class
UntagResourceCommand	Class
UntagResourceCommandInput	Interface
UntagResourceCommandOutput	Interface
UntagResourceRequest	Interface
UpdateChannelCommand	Class
UpdateChannelCommandInput	Interface
UpdateChannelCommandOutput	Interface
UpdateChannelFlowCommand	Class
UpdateChannelFlowCommandInput	Interface
UpdateChannelFlowCommandOutput	Interface
UpdateChannelFlowRequest	Interface
UpdateChannelFlowResponse	Interface
UpdateChannelMessageCommand	Class
UpdateChannelMessageCommandInput	Interface
UpdateChannelMessageCommandOutput	Interface
UpdateChannelMessageRequest	Interface
UpdateChannelMessageResponse	Interface
UpdateChannelReadMarkerCommand	Class
UpdateChannelReadMarkerCommandInput	Interface
UpdateChannelReadMarkerCommandOutput	Interface
UpdateChannelReadMarkerRequest	Interface
UpdateChannelReadMarkerResponse	Interface
UpdateChannelRequest	Interface
UpdateChannelResponse	Interface

Getting Started

References

@aws-sdk/client-chime-sdk-messaging

Description

Installation

Types

Table of Contents

Search