AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
AppInstanceUserMembershipSummary |
Summary of the membership details of an |
|
AssociateChannelFlowRequest |
Container for the parameters to the AssociateChannelFlow operation.
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 |
|
AssociateChannelFlowResponse |
This is the response object from the AssociateChannelFlow operation. |
|
BadRequestException |
The input parameters don't match the service's restrictions. |
|
BatchChannelMemberships |
The membership information, including member ARNs, the channel ARN, and membership types. |
|
BatchCreateChannelMembershipError |
A list of failed member ARNs, error codes, and error messages. |
|
BatchCreateChannelMembershipRequest |
Container for the parameters to the BatchCreateChannelMembership operation. Adds a specified number of users and bots to a channel. |
|
BatchCreateChannelMembershipResponse |
This is the response object from the BatchCreateChannelMembership operation. |
|
Channel |
The details of a channel. |
|
ChannelAssociatedWithFlowSummary |
Summary of details of a channel associated with channel flow. |
|
ChannelBan |
The details of a channel ban. |
|
ChannelBanSummary |
Summary of the details of a |
|
ChannelFlow |
The details of a channel flow. |
|
ChannelFlowCallbackRequest |
Container for the parameters to the ChannelFlowCallback operation. 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:
|
|
ChannelFlowCallbackResponse |
This is the response object from the ChannelFlowCallback operation. |
|
ChannelFlowSummary |
Summary of details of a channel flow. |
|
ChannelMembership |
The details of a channel member. |
|
ChannelMembershipForAppInstanceUserSummary |
Summary of the channel membership details of an |
|
ChannelMembershipPreferences |
The channel membership preferences for an |
|
ChannelMembershipSummary |
Summary of the details of a |
|
ChannelMessage |
The details of a message in a channel. |
|
ChannelMessageCallback |
Stores information about a callback. |
|
ChannelMessageStatusStructure |
Stores information about a message status. |
|
ChannelMessageSummary |
Summary of the messages in a |
|
ChannelModeratedByAppInstanceUserSummary |
Summary of the details of a moderated channel. |
|
ChannelModerator |
The details of a channel moderator. |
|
ChannelModeratorSummary |
Summary of the details of a |
|
ChannelSummary |
Summary of the details of a |
|
ChimeSDKMessagingPaginatorFactory |
Paginators for the ChimeSDKMessaging service |
|
ConflictException |
The request could not be processed because of conflict in the current state of the resource. |
|
CreateChannelBanRequest |
Container for the parameters to the CreateChannelBan operation.
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 |
|
CreateChannelBanResponse |
This is the response object from the CreateChannelBan operation. |
|
CreateChannelFlowRequest |
Container for the parameters to the CreateChannelFlow operation. 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. |
|
CreateChannelFlowResponse |
This is the response object from the CreateChannelFlow operation. |
|
CreateChannelMembershipRequest |
Container for the parameters to the CreateChannelMembership operation.
Adds a member to a channel. The
Privacy settings impact this action as follows:
The |
|
CreateChannelMembershipResponse |
This is the response object from the CreateChannelMembership operation. |
|
CreateChannelModeratorRequest |
Container for the parameters to the CreateChannelModerator operation.
Creates a new
The |
|
CreateChannelModeratorResponse |
This is the response object from the CreateChannelModerator operation. |
|
CreateChannelRequest |
Container for the parameters to the CreateChannel operation. Creates a channel to which you can add users and send messages. Restriction: You can't change a channel's privacy.
The |
|
CreateChannelResponse |
This is the response object from the CreateChannel operation. |
|
DeleteChannelBanRequest |
Container for the parameters to the DeleteChannelBan operation.
Removes a member from a channel's ban list.
The |
|
DeleteChannelBanResponse |
This is the response object from the DeleteChannelBan operation. |
|
DeleteChannelFlowRequest |
Container for the parameters to the DeleteChannelFlow operation.
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 |
|
DeleteChannelFlowResponse |
This is the response object from the DeleteChannelFlow operation. |
|
DeleteChannelMembershipRequest |
Container for the parameters to the DeleteChannelMembership operation.
Removes a member from a channel.
The |
|
DeleteChannelMembershipResponse |
This is the response object from the DeleteChannelMembership operation. |
|
DeleteChannelMessageRequest |
Container for the parameters to the DeleteChannelMessage operation.
Deletes a channel message. Only admins can perform this action. Deletion makes messages
inaccessible immediately. A background process deletes any revisions created by
The |
|
DeleteChannelMessageResponse |
This is the response object from the DeleteChannelMessage operation. |
|
DeleteChannelModeratorRequest |
Container for the parameters to the DeleteChannelModerator operation.
Deletes a channel moderator.
The |
|
DeleteChannelModeratorResponse |
This is the response object from the DeleteChannelModerator operation. |
|
DeleteChannelRequest |
Container for the parameters to the DeleteChannel operation.
Immediately makes a channel and its memberships inaccessible and marks them for deletion.
This is an irreversible process.
The |
|
DeleteChannelResponse |
This is the response object from the DeleteChannel operation. |
|
DeleteMessagingStreamingConfigurationsRequest |
Container for the parameters to the DeleteMessagingStreamingConfigurations operation.
Deletes the streaming configurations for an |
|
DeleteMessagingStreamingConfigurationsResponse |
This is the response object from the DeleteMessagingStreamingConfigurations operation. |
|
DescribeChannelBanRequest |
Container for the parameters to the DescribeChannelBan operation.
Returns the full details of a channel ban.
The |
|
DescribeChannelBanResponse |
This is the response object from the DescribeChannelBan operation. |
|
DescribeChannelFlowRequest |
Container for the parameters to the DescribeChannelFlow operation.
Returns the full details of a channel flow in an Amazon Chime |
|
DescribeChannelFlowResponse |
This is the response object from the DescribeChannelFlow operation. |
|
DescribeChannelMembershipForAppInstanceUserRequest |
Container for the parameters to the DescribeChannelMembershipForAppInstanceUser operation.
Returns the details of a channel based on the membership of the specified
The |
|
DescribeChannelMembershipForAppInstanceUserResponse |
This is the response object from the DescribeChannelMembershipForAppInstanceUser operation. |
|
DescribeChannelMembershipRequest |
Container for the parameters to the DescribeChannelMembership operation.
Returns the full details of a user's channel membership.
The |
|
DescribeChannelMembershipResponse |
This is the response object from the DescribeChannelMembership operation. |
|
DescribeChannelModeratedByAppInstanceUserRequest |
Container for the parameters to the DescribeChannelModeratedByAppInstanceUser operation.
Returns the full details of a channel moderated by the specified
The |
|
DescribeChannelModeratedByAppInstanceUserResponse |
This is the response object from the DescribeChannelModeratedByAppInstanceUser operation. |
|
DescribeChannelModeratorRequest |
Container for the parameters to the DescribeChannelModerator operation.
Returns the full details of a single ChannelModerator.
The |
|
DescribeChannelModeratorResponse |
This is the response object from the DescribeChannelModerator operation. |
|
DescribeChannelRequest |
Container for the parameters to the DescribeChannel operation.
Returns the full details of a channel in an Amazon Chime
The |
|
DescribeChannelResponse |
This is the response object from the DescribeChannel operation. |
|
DisassociateChannelFlowRequest |
Container for the parameters to the DisassociateChannelFlow operation.
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 |
|
DisassociateChannelFlowResponse |
This is the response object from the DisassociateChannelFlow operation. |
|
ElasticChannelConfiguration |
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members. |
|
ExpirationSettings |
Settings that control the interval after which a channel is deleted. |
|
ForbiddenException |
The client is permanently forbidden from making the request. |
|
GetChannelMembershipPreferencesRequest |
Container for the parameters to the GetChannelMembershipPreferences operation.
Gets the membership preferences of an
The |
|
GetChannelMembershipPreferencesResponse |
This is the response object from the GetChannelMembershipPreferences operation. |
|
GetChannelMessageRequest |
Container for the parameters to the GetChannelMessage operation.
Gets the full details of a channel message.
The |
|
GetChannelMessageResponse |
This is the response object from the GetChannelMessage operation. |
|
GetChannelMessageStatusRequest |
Container for the parameters to the GetChannelMessageStatus operation.
Gets message status for a specified Messages can have any one of these statuses.
|
|
GetChannelMessageStatusResponse |
This is the response object from the GetChannelMessageStatus operation. |
|
GetMessagingSessionEndpointRequest |
Container for the parameters to the GetMessagingSessionEndpoint operation. The details of the endpoint for the messaging session. |
|
GetMessagingSessionEndpointResponse |
This is the response object from the GetMessagingSessionEndpoint operation. |
|
GetMessagingStreamingConfigurationsRequest |
Container for the parameters to the GetMessagingStreamingConfigurations operation.
Retrieves the data streaming configuration for an |
|
GetMessagingStreamingConfigurationsResponse |
This is the response object from the GetMessagingStreamingConfigurations operation. |
|
Identity |
The details of a user or bot. |
|
LambdaConfiguration |
Stores metadata about a Lambda processor. |
|
ListChannelBansRequest |
Container for the parameters to the ListChannelBans operation.
Lists all the users and bots banned from a particular channel.
The |
|
ListChannelBansResponse |
This is the response object from the ListChannelBans operation. |
|
ListChannelFlowsRequest |
Container for the parameters to the ListChannelFlows operation. Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API. |
|
ListChannelFlowsResponse |
This is the response object from the ListChannelFlows operation. |
|
ListChannelMembershipsForAppInstanceUserRequest |
Container for the parameters to the ListChannelMembershipsForAppInstanceUser operation.
Lists all channels that an
The |
|
ListChannelMembershipsForAppInstanceUserResponse |
This is the response object from the ListChannelMembershipsForAppInstanceUser operation. |
|
ListChannelMembershipsRequest |
Container for the parameters to the ListChannelMemberships operation.
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. |
|
ListChannelMembershipsResponse |
This is the response object from the ListChannelMemberships operation. |
|
ListChannelMessagesRequest |
Container for the parameters to the ListChannelMessages operation.
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 |
|
ListChannelMessagesResponse |
This is the response object from the ListChannelMessages operation. |
|
ListChannelModeratorsRequest |
Container for the parameters to the ListChannelModerators operation.
Lists all the moderators for a channel.
The |
|
ListChannelModeratorsResponse |
This is the response object from the ListChannelModerators operation. |
|
ListChannelsAssociatedWithChannelFlowRequest |
Container for the parameters to the ListChannelsAssociatedWithChannelFlow operation. 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. |
|
ListChannelsAssociatedWithChannelFlowResponse |
This is the response object from the ListChannelsAssociatedWithChannelFlow operation. |
|
ListChannelsModeratedByAppInstanceUserRequest |
Container for the parameters to the ListChannelsModeratedByAppInstanceUser operation.
A list of the channels moderated by an
The |
|
ListChannelsModeratedByAppInstanceUserResponse |
This is the response object from the ListChannelsModeratedByAppInstanceUser operation. |
|
ListChannelsRequest |
Container for the parameters to the ListChannels operation. Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results. Functionality & restrictions
The |
|
ListChannelsResponse |
This is the response object from the ListChannels operation. |
|
ListSubChannelsRequest |
Container for the parameters to the ListSubChannels operation. 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. |
|
ListSubChannelsResponse |
This is the response object from the ListSubChannels operation. |
|
ListTagsForResourceRequest |
Container for the parameters to the ListTagsForResource operation. Lists the tags applied to an Amazon Chime SDK messaging resource. |
|
ListTagsForResourceResponse |
This is the response object from the ListTagsForResource operation. |
|
MessageAttributeValue |
A list of message attribute values. |
|
MessagingSessionEndpoint |
The websocket endpoint used to connect to Amazon Chime SDK messaging. |
|
NotFoundException |
One or more of the resources in the request does not exist in the system. |
|
Processor |
The information about a processor in a channel flow. |
|
ProcessorConfiguration |
A processor's metadata. |
|
PushNotificationConfiguration |
The push notification configuration of the message. |
|
PushNotificationPreferences |
The channel membership preferences for push notification. |
|
PutChannelExpirationSettingsRequest |
Container for the parameters to the PutChannelExpirationSettings operation.
Sets the number of days before the channel is automatically deleted.
A background process deletes expired channels within 6 hours of expiration. Actual
deletion times may vary.
Expired channels that have not yet been deleted appear as active, and you can update
their expiration settings. The system honors the new settings.
The |
|
PutChannelExpirationSettingsResponse |
This is the response object from the PutChannelExpirationSettings operation. |
|
PutChannelMembershipPreferencesRequest |
Container for the parameters to the PutChannelMembershipPreferences operation.
Sets the membership preferences of an
The x-amz-chime-bearer request header is mandatory. Use the ARN of an |
|
PutChannelMembershipPreferencesResponse |
This is the response object from the PutChannelMembershipPreferences operation. |
|
PutMessagingStreamingConfigurationsRequest |
Container for the parameters to the PutMessagingStreamingConfigurations operation.
Sets the data streaming configuration for an |
|
PutMessagingStreamingConfigurationsResponse |
This is the response object from the PutMessagingStreamingConfigurations operation. |
|
RedactChannelMessageRequest |
Container for the parameters to the RedactChannelMessage operation.
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 |
|
RedactChannelMessageResponse |
This is the response object from the RedactChannelMessage operation. |
|
ResourceLimitExceededException |
The request exceeds the resource limit. |
|
SearchChannelsRequest |
Container for the parameters to the SearchChannels operation.
Allows the
The |
|
SearchChannelsResponse |
This is the response object from the SearchChannels operation. |
|
SearchField |
A |
|
SendChannelMessageRequest |
Container for the parameters to the SendChannelMessage operation.
Sends a message to a particular channel that the member is a part of.
The
Also,
|
|
SendChannelMessageResponse |
This is the response object from the SendChannelMessage operation. |
|
ServiceFailureException |
The service encountered an unexpected error. |
|
ServiceUnavailableException |
The service is currently unavailable. |
|
StreamingConfiguration |
The configuration for connecting a messaging stream to Amazon Kinesis. |
|
SubChannelSummary |
Summary of the sub-channels associated with the elastic channel. |
|
Tag |
A tag object containing a key-value pair. |
|
TagResourceRequest |
Container for the parameters to the TagResource operation. Applies the specified tags to the specified Amazon Chime SDK messaging resource. |
|
TagResourceResponse |
This is the response object from the TagResource operation. |
|
Target |
The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see. |
|
ThrottledClientException |
The client exceeded its request rate limit. |
|
UnauthorizedClientException |
The client is not currently authorized to make the request. |
|
UntagResourceRequest |
Container for the parameters to the UntagResource operation. Removes the specified tags from the specified Amazon Chime SDK messaging resource. |
|
UntagResourceResponse |
This is the response object from the UntagResource operation. |
|
UpdateChannelFlowRequest |
Container for the parameters to the UpdateChannelFlow operation. Updates channel flow attributes. This is a developer API. |
|
UpdateChannelFlowResponse |
This is the response object from the UpdateChannelFlow operation. |
|
UpdateChannelMessageRequest |
Container for the parameters to the UpdateChannelMessage operation.
Updates the content of a message.
The |
|
UpdateChannelMessageResponse |
This is the response object from the UpdateChannelMessage operation. |
|
UpdateChannelReadMarkerRequest |
Container for the parameters to the UpdateChannelReadMarker operation.
The details of the time when a user last read messages in a channel.
The |
|
UpdateChannelReadMarkerResponse |
This is the response object from the UpdateChannelReadMarker operation. |
|
UpdateChannelRequest |
Container for the parameters to the UpdateChannel operation. Update a channel's attributes. Restriction: You can't change a channel's privacy.
The |
|
UpdateChannelResponse |
This is the response object from the UpdateChannel operation. |
Name | Description | |
---|---|---|
IChimeSDKMessagingPaginatorFactory |
Paginators for the ChimeSDKMessaging service |
|
IListChannelBansPaginator |
Paginator for the ListChannelBans operation |
|
IListChannelFlowsPaginator |
Paginator for the ListChannelFlows operation |
|
IListChannelMembershipsForAppInstanceUserPaginator |
Paginator for the ListChannelMembershipsForAppInstanceUser operation |
|
IListChannelMembershipsPaginator |
Paginator for the ListChannelMemberships operation |
|
IListChannelMessagesPaginator |
Paginator for the ListChannelMessages operation |
|
IListChannelModeratorsPaginator |
Paginator for the ListChannelModerators operation |
|
IListChannelsAssociatedWithChannelFlowPaginator |
Paginator for the ListChannelsAssociatedWithChannelFlow operation |
|
IListChannelsModeratedByAppInstanceUserPaginator |
Paginator for the ListChannelsModeratedByAppInstanceUser operation |
|
IListChannelsPaginator |
Paginator for the ListChannels operation |
|
IListSubChannelsPaginator |
Paginator for the ListSubChannels operation |
|
ISearchChannelsPaginator |
Paginator for the SearchChannels operation |