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
", "operations": { "BatchCreateChannelMembership": "Adds a specified number of users to a channel.
", "CreateChannel": "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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
The details of the endpoint for the messaging session.
", "ListChannelBans": "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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Summary of the membership details of an AppInstanceUser.
Returns the channel membership data for an AppInstance.
The input parameters don't match the service's restrictions.
", "refs": { } }, "BatchChannelMemberships": { "base": "The membership information, including member ARNs, the channel ARN, and membership types.
", "refs": { "BatchCreateChannelMembershipResponse$BatchChannelMemberships": "The list of channel memberships in the response.
" } }, "BatchCreateChannelMembershipError": { "base": "A list of failed member ARNs, error codes, and error messages.
", "refs": { "BatchCreateChannelMembershipErrors$member": null } }, "BatchCreateChannelMembershipErrors": { "base": null, "refs": { "BatchCreateChannelMembershipResponse$Errors": "If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.
" } }, "BatchCreateChannelMembershipRequest": { "base": null, "refs": { } }, "BatchCreateChannelMembershipResponse": { "base": null, "refs": { } }, "Channel": { "base": "The details of a channel.
", "refs": { "DescribeChannelResponse$Channel": "The channel details.
" } }, "ChannelBan": { "base": "The details of a channel ban.
", "refs": { "DescribeChannelBanResponse$ChannelBan": "The details of the ban.
" } }, "ChannelBanSummary": { "base": "Summary of the details of a ChannelBan.
The information for each requested ban.
" } }, "ChannelMembership": { "base": "The details of a channel member.
", "refs": { "DescribeChannelMembershipResponse$ChannelMembership": "The details of the membership.
" } }, "ChannelMembershipForAppInstanceUserSummary": { "base": "Summary of the channel membership details of an AppInstanceUser.
The channel to which a user belongs.
" } }, "ChannelMembershipForAppInstanceUserSummaryList": { "base": null, "refs": { "ListChannelMembershipsForAppInstanceUserResponse$ChannelMemberships": "The token passed by previous API calls until all requested users are returned.
" } }, "ChannelMembershipSummary": { "base": "Summary of the details of a ChannelMembership.
The information for the requested channel memberships.
" } }, "ChannelMembershipType": { "base": null, "refs": { "AppInstanceUserMembershipSummary$Type": "The type of ChannelMembership.
The membership types set for the channel users.
", "BatchCreateChannelMembershipRequest$Type": "The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.
The membership type set for the channel member.
", "CreateChannelMembershipRequest$Type": "The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.
The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned.
The details of a message in a channel.
", "refs": { "GetChannelMessageResponse$ChannelMessage": "The details of and content in the message.
" } }, "ChannelMessagePersistenceType": { "base": null, "refs": { "ChannelMessage$Persistence": "The persistence setting for a channel message.
", "SendChannelMessageRequest$Persistence": "Boolean that controls whether the message is persisted on the back end. Required.
" } }, "ChannelMessageSummary": { "base": "Summary of the messages in a Channel.
The information about, and content of, each requested message.
" } }, "ChannelMessageType": { "base": null, "refs": { "ChannelMessage$Type": "The message type.
", "ChannelMessageSummary$Type": "The type of message.
", "SendChannelMessageRequest$Type": "The type of message, STANDARD or CONTROL.
The mode of the channel.
", "ChannelSummary$Mode": "The mode of the channel.
", "CreateChannelRequest$Mode": "The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.
The mode of the update request.
" } }, "ChannelModeratedByAppInstanceUserSummary": { "base": "Summary of the details of a moderated channel.
", "refs": { "ChannelModeratedByAppInstanceUserSummaryList$member": null, "DescribeChannelModeratedByAppInstanceUserResponse$Channel": "The moderated channel.
" } }, "ChannelModeratedByAppInstanceUserSummaryList": { "base": null, "refs": { "ListChannelsModeratedByAppInstanceUserResponse$Channels": "The moderated channels in the request.
" } }, "ChannelModerator": { "base": "The details of a channel moderator.
", "refs": { "DescribeChannelModeratorResponse$ChannelModerator": "The details of the channel moderator.
" } }, "ChannelModeratorSummary": { "base": "Summary of the details of a ChannelModerator.
The information about and names of each moderator.
" } }, "ChannelPrivacy": { "base": null, "refs": { "Channel$Privacy": "The channel's privacy setting.
", "ChannelSummary$Privacy": "The privacy setting of the channel.
", "CreateChannelRequest$Privacy": "The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.
The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.
Summary of the details of a Channel.
Returns the channel data for an AppInstance.
Summary of the details of a Channel.
The information about each channel.
" } }, "ChimeArn": { "base": null, "refs": { "BatchChannelMemberships$ChannelArn": "The ARN of the channel to which you're adding users.
", "BatchCreateChannelMembershipError$MemberArn": "The ARN of the member that the service couldn't add.
", "BatchCreateChannelMembershipRequest$ChannelArn": "The ARN of the channel to which you're adding users.
", "BatchCreateChannelMembershipRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of a channel.
", "ChannelBan$ChannelArn": "The ARN of the channel from which a member is being banned.
", "ChannelMembership$ChannelArn": "The ARN of the member's channel.
", "ChannelMessage$ChannelArn": "The ARN of the channel.
", "ChannelModerator$ChannelArn": "The ARN of the moderator's channel.
", "ChannelSummary$ChannelArn": "The ARN of the channel.
", "CreateChannelBanRequest$ChannelArn": "The ARN of the ban request.
", "CreateChannelBanRequest$MemberArn": "The ARN of the member being banned.
", "CreateChannelBanRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the response to the ban request.
", "CreateChannelMembershipRequest$ChannelArn": "The ARN of the channel to which you're adding users.
", "CreateChannelMembershipRequest$MemberArn": "The ARN of the member you want to add to the channel.
", "CreateChannelMembershipRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "CreateChannelModeratorRequest$ChannelArn": "The ARN of the channel.
", "CreateChannelModeratorRequest$ChannelModeratorArn": "The ARN of the moderator.
", "CreateChannelModeratorRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "CreateChannelRequest$AppInstanceArn": "The ARN of the channel request.
", "CreateChannelRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "DeleteChannelBanRequest$ChannelArn": "The ARN of the channel from which the AppInstanceUser was banned.
The ARN of the AppInstanceUser that you want to reinstate.
The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel from which you want to remove the user.
", "DeleteChannelMembershipRequest$MemberArn": "The ARN of the member that you're removing from the channel.
", "DeleteChannelMembershipRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "DeleteChannelMessageRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "DeleteChannelModeratorRequest$ChannelModeratorArn": "The ARN of the moderator being deleted.
", "DeleteChannelModeratorRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel being deleted.
", "DeleteChannelRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel from which the user is banned.
", "DescribeChannelBanRequest$MemberArn": "The ARN of the member being banned.
", "DescribeChannelBanRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel to which the user belongs.
", "DescribeChannelMembershipForAppInstanceUserRequest$AppInstanceUserArn": "The ARN of the user in a channel.
", "DescribeChannelMembershipForAppInstanceUserRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "DescribeChannelMembershipRequest$MemberArn": "The ARN of the member.
", "DescribeChannelMembershipRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the moderated channel.
", "DescribeChannelModeratedByAppInstanceUserRequest$AppInstanceUserArn": "The ARN of the AppInstanceUser in the moderated channel.
The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "DescribeChannelModeratorRequest$ChannelModeratorArn": "The ARN of the channel moderator.
", "DescribeChannelModeratorRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "DescribeChannelRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "GetChannelMessageRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN in an Identity.
", "ListChannelBansRequest$ChannelArn": "The ARN of the channel.
", "ListChannelBansRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "ListChannelMembershipsForAppInstanceUserRequest$AppInstanceUserArn": "The ARN of the AppInstanceUsers
The AppInstanceUserArn of the user that makes the API call.
The maximum number of channel memberships that you want returned.
", "ListChannelMembershipsRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "ListChannelMessagesRequest$ChannelArn": "The ARN of the channel.
", "ListChannelMessagesRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel containing the requested messages.
", "ListChannelModeratorsRequest$ChannelArn": "The ARN of the channel.
", "ListChannelModeratorsRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "ListChannelsModeratedByAppInstanceUserRequest$AppInstanceUserArn": "The ARN of the user in the moderated channel.
", "ListChannelsModeratedByAppInstanceUserRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the AppInstance.
The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel containing the messages that you want to redact.
", "RedactChannelMessageRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel containing the messages that you want to redact.
", "SendChannelMessageRequest$ChannelArn": "The ARN of the channel.
", "SendChannelMessageRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "UpdateChannelMessageRequest$ChannelArn": "The ARN of the channel.
", "UpdateChannelMessageRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "UpdateChannelReadMarkerRequest$ChannelArn": "The ARN of the channel.
", "UpdateChannelReadMarkerRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "UpdateChannelRequest$ChannelArn": "The ARN of the channel.
", "UpdateChannelRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
" } }, "ClientRequestToken": { "base": null, "refs": { "CreateChannelRequest$ClientRequestToken": "The client token for the request. An Idempotency token.
The Idempotency token for each client request.
The request could not be processed because of conflict in the current state of the resource.
", "refs": { } }, "Content": { "base": null, "refs": { "ChannelMessage$Content": "The message content.
", "ChannelMessageSummary$Content": "The content of the message.
", "UpdateChannelMessageRequest$Content": "The content of the message being updated.
" } }, "CreateChannelBanRequest": { "base": null, "refs": { } }, "CreateChannelBanResponse": { "base": null, "refs": { } }, "CreateChannelMembershipRequest": { "base": null, "refs": { } }, "CreateChannelMembershipResponse": { "base": null, "refs": { } }, "CreateChannelModeratorRequest": { "base": null, "refs": { } }, "CreateChannelModeratorResponse": { "base": null, "refs": { } }, "CreateChannelRequest": { "base": null, "refs": { } }, "CreateChannelResponse": { "base": null, "refs": { } }, "DeleteChannelBanRequest": { "base": null, "refs": { } }, "DeleteChannelMembershipRequest": { "base": null, "refs": { } }, "DeleteChannelMessageRequest": { "base": null, "refs": { } }, "DeleteChannelModeratorRequest": { "base": null, "refs": { } }, "DeleteChannelRequest": { "base": null, "refs": { } }, "DescribeChannelBanRequest": { "base": null, "refs": { } }, "DescribeChannelBanResponse": { "base": null, "refs": { } }, "DescribeChannelMembershipForAppInstanceUserRequest": { "base": null, "refs": { } }, "DescribeChannelMembershipForAppInstanceUserResponse": { "base": null, "refs": { } }, "DescribeChannelMembershipRequest": { "base": null, "refs": { } }, "DescribeChannelMembershipResponse": { "base": null, "refs": { } }, "DescribeChannelModeratedByAppInstanceUserRequest": { "base": null, "refs": { } }, "DescribeChannelModeratedByAppInstanceUserResponse": { "base": null, "refs": { } }, "DescribeChannelModeratorRequest": { "base": null, "refs": { } }, "DescribeChannelModeratorResponse": { "base": null, "refs": { } }, "DescribeChannelRequest": { "base": null, "refs": { } }, "DescribeChannelResponse": { "base": null, "refs": { } }, "ErrorCode": { "base": null, "refs": { "BadRequestException$Code": null, "BatchCreateChannelMembershipError$ErrorCode": "The error code.
", "ConflictException$Code": null, "ForbiddenException$Code": null, "NotFoundException$Code": null, "ResourceLimitExceededException$Code": null, "ServiceFailureException$Code": null, "ServiceUnavailableException$Code": null, "ThrottledClientException$Code": null, "UnauthorizedClientException$Code": null } }, "ForbiddenException": { "base": "The client is permanently forbidden from making the request.
", "refs": { } }, "GetChannelMessageRequest": { "base": null, "refs": { } }, "GetChannelMessageResponse": { "base": null, "refs": { } }, "GetMessagingSessionEndpointRequest": { "base": null, "refs": { } }, "GetMessagingSessionEndpointResponse": { "base": null, "refs": { } }, "Identity": { "base": "The details of a user.
", "refs": { "BatchChannelMemberships$InvitedBy": "The identifier of the member who invited another member.
", "Channel$CreatedBy": "The AppInstanceUser who created the channel.
The member being banned from the channel.
", "ChannelBan$CreatedBy": "The AppInstanceUser who created the ban.
The member being banned from a channel.
", "ChannelMembership$InvitedBy": "The identifier of the member who invited another member.
", "ChannelMembership$Member": "The data of the channel member.
", "ChannelMembershipSummary$Member": "A member's summary data.
", "ChannelMessage$Sender": "The message sender.
", "ChannelMessageSummary$Sender": "The message sender.
", "ChannelModerator$Moderator": "The moderator's data.
", "ChannelModerator$CreatedBy": "The AppInstanceUser who created the moderator.
The data for a moderator.
", "CreateChannelBanResponse$Member": "The ChannelArn and BannedIdentity of the member in the ban response.
The ARN and metadata of the member being added.
", "CreateChannelModeratorResponse$ChannelModerator": "The ARNs of the channel and the moderator.
", "Members$member": null } }, "ListChannelBansRequest": { "base": null, "refs": { } }, "ListChannelBansResponse": { "base": null, "refs": { } }, "ListChannelMembershipsForAppInstanceUserRequest": { "base": null, "refs": { } }, "ListChannelMembershipsForAppInstanceUserResponse": { "base": null, "refs": { } }, "ListChannelMembershipsRequest": { "base": null, "refs": { } }, "ListChannelMembershipsResponse": { "base": null, "refs": { } }, "ListChannelMessagesRequest": { "base": null, "refs": { } }, "ListChannelMessagesResponse": { "base": null, "refs": { } }, "ListChannelModeratorsRequest": { "base": null, "refs": { } }, "ListChannelModeratorsResponse": { "base": null, "refs": { } }, "ListChannelsModeratedByAppInstanceUserRequest": { "base": null, "refs": { } }, "ListChannelsModeratedByAppInstanceUserResponse": { "base": null, "refs": { } }, "ListChannelsRequest": { "base": null, "refs": { } }, "ListChannelsResponse": { "base": null, "refs": { } }, "MaxResults": { "base": null, "refs": { "ListChannelBansRequest$MaxResults": "The maximum number of bans that you want returned.
", "ListChannelMembershipsForAppInstanceUserRequest$MaxResults": "The maximum number of users that you want returned.
", "ListChannelMembershipsRequest$MaxResults": "The maximum number of channel memberships that you want returned.
", "ListChannelMessagesRequest$MaxResults": "The maximum number of messages that you want returned.
", "ListChannelModeratorsRequest$MaxResults": "The maximum number of moderators that you want returned.
", "ListChannelsModeratedByAppInstanceUserRequest$MaxResults": "The maximum number of channels in the request.
", "ListChannelsRequest$MaxResults": "The maximum number of channels that you want to return.
" } }, "MemberArns": { "base": null, "refs": { "BatchCreateChannelMembershipRequest$MemberArns": "The ARNs of the members you want to add to the channel.
" } }, "Members": { "base": null, "refs": { "BatchChannelMemberships$Members": "The users successfully added to the request.
" } }, "MessageId": { "base": null, "refs": { "ChannelMessage$MessageId": "The ID of a message.
", "ChannelMessageSummary$MessageId": "The ID of the message.
", "DeleteChannelMessageRequest$MessageId": "The ID of the message being deleted.
", "GetChannelMessageRequest$MessageId": "The ID of the message.
", "RedactChannelMessageRequest$MessageId": "The ID of the message being redacted.
", "RedactChannelMessageResponse$MessageId": "The ID of the message being redacted.
", "SendChannelMessageResponse$MessageId": "The ID string assigned to each message.
", "UpdateChannelMessageRequest$MessageId": "The ID string of the message being updated.
", "UpdateChannelMessageResponse$MessageId": "The ID string of the message being updated.
" } }, "MessagingSessionEndpoint": { "base": "The websocket endpoint used to connect to Amazon Chime SDK messaging.
", "refs": { "GetMessagingSessionEndpointResponse$Endpoint": "The endpoint returned in the response.
" } }, "Metadata": { "base": null, "refs": { "Channel$Metadata": "The channel's metadata.
", "ChannelMessage$Metadata": "The message metadata.
", "ChannelMessageSummary$Metadata": "The metadata of the message.
", "ChannelSummary$Metadata": "The metadata of the channel.
", "CreateChannelRequest$Metadata": "The metadata of the creation request. Limited to 1KB and UTF-8.
", "SendChannelMessageRequest$Metadata": "The optional metadata for each message.
", "UpdateChannelMessageRequest$Metadata": "The metadata of the message being updated.
", "UpdateChannelRequest$Metadata": "The metadata for the update request.
" } }, "NextToken": { "base": null, "refs": { "ListChannelBansRequest$NextToken": "The token passed by previous API calls until all requested bans are returned.
", "ListChannelBansResponse$NextToken": "The token passed by previous API calls until all requested bans are returned.
", "ListChannelMembershipsForAppInstanceUserRequest$NextToken": "The token returned from previous API requests until the number of channel memberships is reached.
", "ListChannelMembershipsForAppInstanceUserResponse$NextToken": "The token passed by previous API calls until all requested users are returned.
", "ListChannelMembershipsRequest$NextToken": "The token passed by previous API calls until all requested channel memberships are returned.
", "ListChannelMembershipsResponse$NextToken": "The token passed by previous API calls until all requested channel memberships are returned.
", "ListChannelMessagesRequest$NextToken": "The token passed by previous API calls until all requested messages are returned.
", "ListChannelMessagesResponse$NextToken": "The token passed by previous API calls until all requested messages are returned.
", "ListChannelModeratorsRequest$NextToken": "The token passed by previous API calls until all requested moderators are returned.
", "ListChannelModeratorsResponse$NextToken": "The token passed by previous API calls until all requested moderators are returned.
", "ListChannelsModeratedByAppInstanceUserRequest$NextToken": "The token returned from previous API requests until the number of channels moderated by the user is reached.
", "ListChannelsModeratedByAppInstanceUserResponse$NextToken": "The token returned from previous API requests until the number of channels moderated by the user is reached.
", "ListChannelsRequest$NextToken": "The token passed by previous API calls until all requested channels are returned.
", "ListChannelsResponse$NextToken": "The token returned from previous API requests until the number of channels is reached.
" } }, "NonEmptyContent": { "base": null, "refs": { "SendChannelMessageRequest$Content": "The content of the message.
" } }, "NonEmptyResourceName": { "base": null, "refs": { "Channel$Name": "The name of a channel.
", "ChannelSummary$Name": "The name of the channel.
", "CreateChannelRequest$Name": "The name of the channel.
", "UpdateChannelRequest$Name": "The name of the channel.
" } }, "NonNullableBoolean": { "base": null, "refs": { "ChannelMessage$Redacted": "Hides the content of a message.
", "ChannelMessageSummary$Redacted": "Indicates whether a message was redacted.
" } }, "NotFoundException": { "base": "One or more of the resources in the request does not exist in the system.
", "refs": { } }, "RedactChannelMessageRequest": { "base": null, "refs": { } }, "RedactChannelMessageResponse": { "base": null, "refs": { } }, "ResourceLimitExceededException": { "base": "The request exceeds the resource limit.
", "refs": { } }, "ResourceName": { "base": null, "refs": { "Identity$Name": "The name in an Identity.
" } }, "SendChannelMessageRequest": { "base": null, "refs": { } }, "SendChannelMessageResponse": { "base": null, "refs": { } }, "ServiceFailureException": { "base": "The service encountered an unexpected error.
", "refs": { } }, "ServiceUnavailableException": { "base": "The service is currently unavailable.
", "refs": { } }, "SortOrder": { "base": null, "refs": { "ListChannelMessagesRequest$SortOrder": "The order in which you want messages sorted. Default is Descending, based on time created.
" } }, "String": { "base": null, "refs": { "BadRequestException$Message": null, "BatchCreateChannelMembershipError$ErrorMessage": "The error message.
", "ConflictException$Message": null, "ForbiddenException$Message": null, "NotFoundException$Message": null, "ResourceLimitExceededException$Message": null, "ServiceFailureException$Message": null, "ServiceUnavailableException$Message": null, "ThrottledClientException$Message": null, "UnauthorizedClientException$Message": null } }, "Tag": { "base": "Describes a tag applied to a resource.
", "refs": { "TagList$member": null } }, "TagKey": { "base": null, "refs": { "Tag$Key": "The key of the tag.
" } }, "TagList": { "base": null, "refs": { "CreateChannelRequest$Tags": "The tags for the creation request.
" } }, "TagValue": { "base": null, "refs": { "Tag$Value": "The value of the tag.
" } }, "ThrottledClientException": { "base": "The client exceeded its request rate limit.
", "refs": { } }, "Timestamp": { "base": null, "refs": { "AppInstanceUserMembershipSummary$ReadMarkerTimestamp": "The time at which a message was last read.
", "Channel$CreatedTimestamp": "The time at which the AppInstanceUser created the channel.
The time at which a member sent the last message in the channel.
", "Channel$LastUpdatedTimestamp": "The time at which a channel was last updated.
", "ChannelBan$CreatedTimestamp": "The time at which the ban was created.
", "ChannelMembership$CreatedTimestamp": "The time at which the channel membership was created.
", "ChannelMembership$LastUpdatedTimestamp": "The time at which a channel membership was last updated.
", "ChannelMessage$CreatedTimestamp": "The time at which the message was created.
", "ChannelMessage$LastEditedTimestamp": "The time at which a message was edited.
", "ChannelMessage$LastUpdatedTimestamp": "The time at which a message was updated.
", "ChannelMessageSummary$CreatedTimestamp": "The time at which the message summary was created.
", "ChannelMessageSummary$LastUpdatedTimestamp": "The time at which a message was last updated.
", "ChannelMessageSummary$LastEditedTimestamp": "The time at which a message was last edited.
", "ChannelModerator$CreatedTimestamp": "The time at which the moderator was created.
", "ChannelSummary$LastMessageTimestamp": "The time at which the last message in a channel was sent.
", "ListChannelMessagesRequest$NotBefore": "The initial or starting time stamp for your requested messages.
", "ListChannelMessagesRequest$NotAfter": "The final or ending time stamp for your requested messages.
" } }, "UnauthorizedClientException": { "base": "The client is not currently authorized to make the request.
", "refs": { } }, "UpdateChannelMessageRequest": { "base": null, "refs": { } }, "UpdateChannelMessageResponse": { "base": null, "refs": { } }, "UpdateChannelReadMarkerRequest": { "base": null, "refs": { } }, "UpdateChannelReadMarkerResponse": { "base": null, "refs": { } }, "UpdateChannelRequest": { "base": null, "refs": { } }, "UpdateChannelResponse": { "base": null, "refs": { } }, "UrlType": { "base": null, "refs": { "MessagingSessionEndpoint$Url": "The endpoint to which you establish a websocket connection.
" } } } }