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' => [ 'AssociateChannelFlow' => 'Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the DisassociateChannelFlow API.
Only administrators or channel moderators can associate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Adds a specified number of users and bots to a channel.
', 'ChannelFlowCallback' => '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:
Update message content or metadata
Deny a message
Make no changes to the message
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 ARN of the AppInstanceUser or AppInstanceBot 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
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:
New and updated messages
Persistent and non-persistent messages
The Standard message type
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.
Adds a member to a channel. The InvitedBy field in ChannelMembership 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 ARN of the AppInstanceUserArn or AppInstanceBot 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 ARN of the AppInstanceUser or AppInstanceBotof 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 ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.
Removes a member from a channel\'s ban list.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
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 ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API to disassociate a channel flow from all channels.
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 ARN of the AppInstanceUser or AppInstanceBot 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Deletes the streaming configurations for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.
Returns the full details of a channel in an Amazon Chime AppInstance.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.
Returns the full details of a user\'s channel membership.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot 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 or AppInstanceBot.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Returns the full details of a channel moderated by the specified AppInstanceUser or AppInstanceBot.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot 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.
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 x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Gets the membership preferences of an AppInstanceUser or AppInstanceBot 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 AppInstanceAdmin 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.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Gets message status for a specified messageId. 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.
Message processed successfully
Ongoing processing
Processing failed
Message denied by the processor
This API does not return statuses for denied messages, because we don\'t store them once the processor denies them.
Only the message sender can invoke this API.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
The details of the endpoint for the messaging session.
', 'GetMessagingStreamingConfigurations' => 'Retrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.
Lists all the users and bots banned from a particular channel.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
', 'ListChannelMemberships' => 'Lists all channel memberships in a channel.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
', 'ListChannelMembershipsForAppInstanceUser' => ' Lists all channels that an AppInstanceUser or AppInstanceBot 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 ARN of the AppInstanceUser or AppInstanceBot 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 ARN of the AppInstanceUser or AppInstanceBot 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 ARN of the AppInstanceUser or AppInstanceBot 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
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.
', 'ListChannelsModeratedByAppInstanceUser' => 'A list of the channels moderated by an AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
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.
', 'ListTagsForResource' => 'Lists the tags applied to an Amazon Chime SDK messaging resource.
', 'PutChannelExpirationSettings' => '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 x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Sets the membership preferences of an AppInstanceUser or AppInstanceBot 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 AppInstanceAdmin 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.
The x-amz-chime-bearer request header is mandatory. Use the ARN of an AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Sets the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.
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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Allows the ChimeBearer to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin role can search across all channels.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Also, STANDARD 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.
CONTROL messages are limited to 30 bytes and do not contain metadata.
Applies the specified tags to the specified Amazon Chime SDK messaging resource.
', 'UntagResource' => 'Removes the specified tags from the specified Amazon Chime SDK messaging resource.
', 'UpdateChannel' => '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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Updates channel flow attributes. This is a developer API.
', 'UpdateChannelMessage' => 'Updates the content of a message.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Enum value that indicates which push notifications to send to the requested member of a channel. ALL sends all push notifications, NONE sends no push notifications, FILTERED sends only filtered push notifications.
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' => [], ], 'CallbackIdType' => [ 'base' => NULL, 'refs' => [ 'ChannelFlowCallbackRequest$CallbackId' => 'The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.
', 'ChannelFlowCallbackResponse$CallbackId' => 'The call back ID passed in the request.
', ], ], 'Channel' => [ 'base' => 'The details of a channel.
', 'refs' => [ 'DescribeChannelResponse$Channel' => 'The channel details.
', ], ], 'ChannelAssociatedWithFlowSummary' => [ 'base' => 'Summary of details of a channel associated with channel flow.
', 'refs' => [ 'ChannelAssociatedWithFlowSummaryList$member' => NULL, ], ], 'ChannelAssociatedWithFlowSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListChannelsAssociatedWithChannelFlowResponse$Channels' => 'The information about each channel.
', ], ], '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.
', ], ], 'ChannelFlow' => [ 'base' => 'The details of a channel flow.
', 'refs' => [ 'DescribeChannelFlowResponse$ChannelFlow' => 'The channel flow details.
', ], ], 'ChannelFlowCallbackRequest' => [ 'base' => NULL, 'refs' => [], ], 'ChannelFlowCallbackResponse' => [ 'base' => NULL, 'refs' => [], ], 'ChannelFlowExecutionOrder' => [ 'base' => NULL, 'refs' => [ 'Processor$ExecutionOrder' => 'The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.
', ], ], 'ChannelFlowSummary' => [ 'base' => 'Summary of details of a channel flow.
', 'refs' => [ 'ChannelFlowSummaryList$member' => NULL, ], ], 'ChannelFlowSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListChannelFlowsResponse$ChannelFlows' => 'The information about each channel flow.
', ], ], 'ChannelId' => [ 'base' => NULL, 'refs' => [ 'CreateChannelRequest$ChannelId' => 'The ID of the channel in the request.
', ], ], 'ChannelMemberArns' => [ 'base' => NULL, 'refs' => [ 'CreateChannelRequest$MemberArns' => 'The ARNs of the channel members in the request.
', ], ], '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 information for the requested channel memberships.
', ], ], 'ChannelMembershipPreferences' => [ 'base' => 'The channel membership preferences for an AppInstanceUser.
The channel membership preferences for an AppInstanceUser .
The channel membership preferences of an AppInstanceUser .
The ARN and metadata of the member being added.
', ], ], '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 members.
', '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 returned as part of ListChannelMemberships if no type is specified. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN.
The details of a message in a channel.
', 'refs' => [ 'GetChannelMessageResponse$ChannelMessage' => 'The details of and content in the message.
', ], ], 'ChannelMessageCallback' => [ 'base' => 'Stores information about a callback.
', 'refs' => [ 'ChannelFlowCallbackRequest$ChannelMessage' => 'Stores information about the processed 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.
', ], ], 'ChannelMessageStatus' => [ 'base' => NULL, 'refs' => [ 'ChannelMessageStatusStructure$Value' => 'The message status value.
', ], ], 'ChannelMessageStatusStructure' => [ 'base' => 'Stores information about a message status.
', 'refs' => [ 'ChannelMessage$Status' => 'The status of the channel message.
', 'ChannelMessageSummary$Status' => 'The message status. The status value is SENT for messages sent to a channel without a channel flow. For channels associated with channel flow, the value determines the processing stage.
The message status and details.
', 'SendChannelMessageResponse$Status' => 'The status of the channel message.
', 'UpdateChannelMessageResponse$Status' => 'The status of the message update.
', ], ], '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.
STANDARD 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.
CONTROL messages are limited to 30 bytes and do not contain metadata.
The mode of the channel.
', 'ChannelAssociatedWithFlowSummary$Mode' => '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.
', ], ], 'ChannelModeratorArns' => [ 'base' => NULL, 'refs' => [ 'CreateChannelRequest$ModeratorArns' => 'The ARNs of the channel moderators in the request.
', ], ], '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.
', 'ChannelAssociatedWithFlowSummary$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.
', 'SearchChannelsResponse$Channels' => 'A list of the channels in the request.
', ], ], 'ChimeArn' => [ 'base' => NULL, 'refs' => [ 'AssociateChannelFlowRequest$ChannelArn' => 'The ARN of the channel.
', 'AssociateChannelFlowRequest$ChannelFlowArn' => 'The ARN of the channel flow.
', 'AssociateChannelFlowRequest$ChimeBearer' => 'The AppInstanceUserArn of the user making the API call.
The ARN of the channel to which you\'re adding members.
', 'BatchCreateChannelMembershipError$MemberArn' => 'The AppInstanceUserArn of the member that the service couldn\'t add.
The ARN of the channel to which you\'re adding users or bots.
', 'BatchCreateChannelMembershipRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of a channel.
', 'Channel$ChannelFlowArn' => 'The ARN of the channel flow.
', 'ChannelAssociatedWithFlowSummary$ChannelArn' => 'The ARN of the channel.
', 'ChannelBan$ChannelArn' => 'The ARN of the channel from which a member is being banned.
', 'ChannelFlow$ChannelFlowArn' => 'The ARN of the channel flow.
', 'ChannelFlowCallbackRequest$ChannelArn' => 'The ARN of the channel.
', 'ChannelFlowCallbackResponse$ChannelArn' => 'The ARN of the channel.
', 'ChannelFlowSummary$ChannelFlowArn' => 'The ARN of the channel flow.
', 'ChannelMemberArns$member' => NULL, '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.
', 'ChannelModeratorArns$member' => NULL, 'ChannelSummary$ChannelArn' => 'The ARN of the channel.
', 'CreateChannelBanRequest$ChannelArn' => 'The ARN of the ban request.
', 'CreateChannelBanRequest$MemberArn' => 'The AppInstanceUserArn of the member being banned.
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the response to the ban request.
', 'CreateChannelFlowRequest$AppInstanceArn' => 'The ARN of the channel flow request.
', 'CreateChannelFlowResponse$ChannelFlowArn' => 'The ARN of the channel flow.
', 'CreateChannelMembershipRequest$ChannelArn' => 'The ARN of the channel to which you\'re adding users.
', 'CreateChannelMembershipRequest$MemberArn' => 'The AppInstanceUserArn of the member you want to add to the channel.
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', 'CreateChannelModeratorRequest$ChannelArn' => 'The ARN of the channel.
', 'CreateChannelModeratorRequest$ChannelModeratorArn' => 'The AppInstanceUserArn of the moderator.
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', 'CreateChannelRequest$AppInstanceArn' => 'The ARN of the channel request.
', 'CreateChannelRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel flow.
', 'DeleteChannelMembershipRequest$ChannelArn' => 'The ARN of the channel from which you want to remove the user.
', 'DeleteChannelMembershipRequest$MemberArn' => 'The AppInstanceUserArn of the member that you\'re removing from the channel.
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', 'DeleteChannelMessageRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', 'DeleteChannelModeratorRequest$ChannelModeratorArn' => 'The AppInstanceUserArn of the moderator being deleted.
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel being deleted.
', 'DeleteChannelRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the streaming configurations being deleted.
', 'DescribeChannelBanRequest$ChannelArn' => 'The ARN of the channel from which the user is banned.
', 'DescribeChannelBanRequest$MemberArn' => 'The AppInstanceUserArn of the member being banned.
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel flow.
', 'DescribeChannelMembershipForAppInstanceUserRequest$ChannelArn' => 'The ARN of the channel to which the user belongs.
', 'DescribeChannelMembershipForAppInstanceUserRequest$AppInstanceUserArn' => 'The ARN of the user or bot in a channel.
', 'DescribeChannelMembershipForAppInstanceUserRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', 'DescribeChannelMembershipRequest$MemberArn' => 'The AppInstanceUserArn of the member.
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the moderated channel.
', 'DescribeChannelModeratedByAppInstanceUserRequest$AppInstanceUserArn' => 'The ARN of the user or bot in the moderated channel.
', 'DescribeChannelModeratedByAppInstanceUserRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', 'DescribeChannelModeratorRequest$ChannelModeratorArn' => 'The AppInstanceUserArn of the channel moderator.
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', 'DescribeChannelRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', 'DisassociateChannelFlowRequest$ChannelFlowArn' => 'The ARN of the channel flow.
', 'DisassociateChannelFlowRequest$ChimeBearer' => 'The AppInstanceUserArn of the user making the API call.
The ARN of the channel.
', 'GetChannelMembershipPreferencesRequest$MemberArn' => 'The AppInstanceUserArn of the member retrieving the preferences.
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', 'GetChannelMessageRequest$ChannelArn' => 'The ARN of the channel.
', 'GetChannelMessageRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel
', 'GetChannelMessageStatusRequest$ChimeBearer' => 'The AppInstanceUserArn of the user making the API call.
The ARN of the streaming configurations.
', 'Identity$Arn' => 'The ARN in an Identity.
', 'ListChannelBansRequest$ChannelArn' => 'The ARN of the channel.
', 'ListChannelBansRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', 'ListChannelFlowsRequest$AppInstanceArn' => 'The ARN of the app instance.
', 'ListChannelMembershipsForAppInstanceUserRequest$AppInstanceUserArn' => 'The ARN of the user or bot.
', 'ListChannelMembershipsForAppInstanceUserRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The maximum number of channel memberships that you want returned.
', 'ListChannelMembershipsRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', 'ListChannelMessagesRequest$ChannelArn' => 'The ARN of the channel.
', 'ListChannelMessagesRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel containing the requested messages.
', 'ListChannelModeratorsRequest$ChannelArn' => 'The ARN of the channel.
', 'ListChannelModeratorsRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', 'ListChannelsAssociatedWithChannelFlowRequest$ChannelFlowArn' => 'The ARN of the channel flow.
', 'ListChannelsModeratedByAppInstanceUserRequest$AppInstanceUserArn' => 'The ARN of the user or bot in the moderated channel.
', 'ListChannelsModeratedByAppInstanceUserRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the AppInstance.
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of elastic channel.
', 'ListSubChannelsRequest$ChimeBearer' => 'The AppInstanceUserArn of the user making the API call.
The ARN of elastic channel.
', 'ListTagsForResourceRequest$ResourceARN' => 'The ARN of the resource.
', 'MemberArns$member' => NULL, 'PutChannelExpirationSettingsRequest$ChannelArn' => 'The ARN of the channel.
', 'PutChannelExpirationSettingsRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The channel ARN.
', 'PutChannelMembershipPreferencesRequest$ChannelArn' => 'The ARN of the channel.
', 'PutChannelMembershipPreferencesRequest$MemberArn' => 'The ARN of the member setting the preferences.
', 'PutChannelMembershipPreferencesRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', 'PutMessagingStreamingConfigurationsRequest$AppInstanceArn' => 'The ARN of the streaming configuration.
', 'RedactChannelMessageRequest$ChannelArn' => 'The ARN of the channel containing the messages that you want to redact.
', 'RedactChannelMessageRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel containing the messages that you want to redact.
', 'SearchChannelsRequest$ChimeBearer' => 'The AppInstanceUserArn of the user making the API call.
The ARN of the channel.
', 'SendChannelMessageRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', 'StreamingConfiguration$ResourceArn' => 'The ARN of the resource in the configuration.
', 'TagResourceRequest$ResourceARN' => 'The resource ARN.
', 'Target$MemberArn' => 'The ARN of the target channel member.
', 'UntagResourceRequest$ResourceARN' => 'The resource ARN.
', 'UpdateChannelFlowRequest$ChannelFlowArn' => 'The ARN of the channel flow.
', 'UpdateChannelFlowResponse$ChannelFlowArn' => 'The ARN of the channel flow.
', 'UpdateChannelMessageRequest$ChannelArn' => 'The ARN of the channel.
', 'UpdateChannelMessageRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', 'UpdateChannelReadMarkerRequest$ChannelArn' => 'The ARN of the channel.
', 'UpdateChannelReadMarkerRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', 'UpdateChannelRequest$ChannelArn' => 'The ARN of the channel.
', 'UpdateChannelRequest$ChimeBearer' => 'The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
The ARN of the channel.
', ], ], 'ClientRequestToken' => [ 'base' => NULL, 'refs' => [ 'CreateChannelFlowRequest$ClientRequestToken' => 'The client token for the request. An Idempotency token.
', '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 content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
', 'ChannelMessageSummary$Content' => 'The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'ChannelMessage$ContentType' => 'The content type of the channel message. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and application/amz-chime-lex-error for failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
The content type of the call-back message. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and application/amz-chime-lex-error for failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
The content type of the channel message listed in the summary. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and application/amz-chime-lex-error for failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
The content type of the channel message.
', 'UpdateChannelMessageRequest$ContentType' => 'The content type of the channel message.
', ], ], 'CreateChannelBanRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateChannelBanResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateChannelFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateChannelFlowResponse' => [ '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' => [], ], 'DeleteChannelFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteChannelMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteChannelMessageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteChannelModeratorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteChannelRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMessagingStreamingConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeChannelBanRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeChannelBanResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeChannelFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeChannelFlowResponse' => [ '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' => [], ], 'DisassociateChannelFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'ElasticChannelConfiguration' => [ 'base' => 'The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.
', 'refs' => [ 'Channel$ElasticChannelConfiguration' => 'The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.
', 'CreateChannelRequest$ElasticChannelConfiguration' => 'The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.
', ], ], '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, ], ], 'ExpirationCriterion' => [ 'base' => NULL, 'refs' => [ 'ExpirationSettings$ExpirationCriterion' => 'The conditions that must be met for a channel to expire.
', ], ], 'ExpirationDays' => [ 'base' => NULL, 'refs' => [ 'ExpirationSettings$ExpirationDays' => 'The period in days after which the system automatically deletes a channel.
', ], ], 'ExpirationSettings' => [ 'base' => 'Settings that control the interval after which a channel is deleted.
', 'refs' => [ 'Channel$ExpirationSettings' => 'Settings that control when a channel expires.
', 'CreateChannelRequest$ExpirationSettings' => 'Settings that control the interval after which the channel is automatically deleted.
', 'PutChannelExpirationSettingsRequest$ExpirationSettings' => 'Settings that control the interval after which a channel is deleted.
', 'PutChannelExpirationSettingsResponse$ExpirationSettings' => 'Settings that control the interval after which a channel is deleted.
', ], ], 'FallbackAction' => [ 'base' => NULL, 'refs' => [ 'Processor$FallbackAction' => 'Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of ABORT and communication with it fails, the processor sets the message status to FAILED and does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action of CONTINUE and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.
The simple JSON object used to send a subset of a push notification to the requested member.
', ], ], 'ForbiddenException' => [ 'base' => 'The client is permanently forbidden from making the request.
', 'refs' => [], ], 'GetChannelMembershipPreferencesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetChannelMembershipPreferencesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetChannelMessageRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetChannelMessageResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetChannelMessageStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetChannelMessageStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMessagingSessionEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMessagingSessionEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMessagingStreamingConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMessagingStreamingConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Identity' => [ 'base' => 'The details of a user or bot.
', '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.
', 'GetChannelMembershipPreferencesResponse$Member' => 'The details of a user.
', 'Members$member' => NULL, 'PutChannelMembershipPreferencesResponse$Member' => 'The details of a user.
', ], ], 'InvocationType' => [ 'base' => NULL, 'refs' => [ 'LambdaConfiguration$InvocationType' => 'Controls how the Lambda function is invoked.
', ], ], 'LambdaConfiguration' => [ 'base' => 'Stores metadata about a Lambda processor.
', 'refs' => [ 'ProcessorConfiguration$Lambda' => 'Indicates that the processor is of type Lambda.
', ], ], 'LambdaFunctionArn' => [ 'base' => NULL, 'refs' => [ 'LambdaConfiguration$ResourceArn' => 'The ARN of the Lambda message processing function.
', ], ], 'ListChannelBansRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListChannelBansResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListChannelFlowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListChannelFlowsResponse' => [ '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' => [], ], 'ListChannelsAssociatedWithChannelFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListChannelsAssociatedWithChannelFlowResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListChannelsModeratedByAppInstanceUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListChannelsModeratedByAppInstanceUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListChannelsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListChannelsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSubChannelsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSubChannelsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListChannelBansRequest$MaxResults' => 'The maximum number of bans that you want returned.
', 'ListChannelFlowsRequest$MaxResults' => 'The maximum number of channel flows that you want to return.
', '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.
', 'ListChannelsAssociatedWithChannelFlowRequest$MaxResults' => 'The maximum number of channels that you want to return.
', 'ListChannelsModeratedByAppInstanceUserRequest$MaxResults' => 'The maximum number of channels in the request.
', 'ListChannelsRequest$MaxResults' => 'The maximum number of channels that you want to return.
', 'ListSubChannelsRequest$MaxResults' => 'The maximum number of sub-channels that you want to return.
', 'SearchChannelsRequest$MaxResults' => 'The maximum number of channels that you want returned.
', ], ], 'MaximumSubChannels' => [ 'base' => NULL, 'refs' => [ 'ElasticChannelConfiguration$MaximumSubChannels' => 'The maximum number of SubChannels that you want to allow in the elastic channel.
', ], ], 'MemberArns' => [ 'base' => NULL, 'refs' => [ 'BatchCreateChannelMembershipRequest$MemberArns' => 'The ARNs of the members you want to add to the channel. Only AppInstanceUsers and AppInstanceBots can be added as a channel member.
The users successfully added to the request.
', ], ], 'MembershipCount' => [ 'base' => NULL, 'refs' => [ 'SubChannelSummary$MembershipCount' => 'The number of members in a SubChannel.
', ], ], 'MessageAttributeMap' => [ 'base' => NULL, 'refs' => [ 'ChannelMessage$MessageAttributes' => 'The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
', 'ChannelMessageCallback$MessageAttributes' => 'The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
', 'ChannelMessageSummary$MessageAttributes' => 'The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
', 'SendChannelMessageRequest$MessageAttributes' => 'The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
The strings in a message attribute value.
', ], ], 'MessageAttributeValue' => [ 'base' => 'A list of message attribute values.
', 'refs' => [ 'MessageAttributeMap$value' => NULL, ], ], 'MessageId' => [ 'base' => NULL, 'refs' => [ 'ChannelMessage$MessageId' => 'The ID of a message.
', 'ChannelMessageCallback$MessageId' => 'The message ID.
', 'ChannelMessageSummary$MessageId' => 'The ID of the message.
', 'DeleteChannelMessageRequest$MessageId' => 'The ID of the message being deleted.
', 'GetChannelMessageRequest$MessageId' => 'The ID of the message.
', 'GetChannelMessageStatusRequest$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.
', ], ], 'MessagingDataType' => [ 'base' => NULL, 'refs' => [ 'StreamingConfiguration$DataType' => 'The data type of the configuration.
', ], ], '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.
', 'ChannelAssociatedWithFlowSummary$Metadata' => 'The channel\'s metadata.
', 'ChannelMessage$Metadata' => 'The message metadata.
', 'ChannelMessageCallback$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.
', ], ], 'MinimumMembershipPercentage' => [ 'base' => NULL, 'refs' => [ 'ElasticChannelConfiguration$MinimumMembershipPercentage' => 'The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel.
', ], ], '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.
', 'ListChannelFlowsRequest$NextToken' => 'The token passed by previous API calls until all requested channel flows are returned.
', 'ListChannelFlowsResponse$NextToken' => 'The token passed by previous API calls until all requested channels 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.
', 'ListChannelsAssociatedWithChannelFlowRequest$NextToken' => 'The token passed by previous API calls until all requested channels are returned.
', 'ListChannelsAssociatedWithChannelFlowResponse$NextToken' => 'The token passed by previous API calls until all requested channels 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.
', 'ListSubChannelsRequest$NextToken' => 'The token passed by previous API calls until all requested sub-channels are returned.
', 'ListSubChannelsResponse$NextToken' => 'The token passed by previous API calls until all requested sub-channels are returned.
', 'SearchChannelsRequest$NextToken' => 'The token returned from previous API requests until the number of channels is reached.
', 'SearchChannelsResponse$NextToken' => 'The token returned from previous API responses until the number of channels is reached.
', ], ], 'NonEmptyContent' => [ 'base' => NULL, 'refs' => [ 'ChannelMessageCallback$Content' => 'The message content. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
', 'SendChannelMessageRequest$Content' => 'The content of the channel message.
', 'UpdateChannelMessageRequest$Content' => 'The content of the channel message.
', ], ], 'NonEmptyResourceName' => [ 'base' => NULL, 'refs' => [ 'Channel$Name' => 'The name of a channel.
', 'ChannelAssociatedWithFlowSummary$Name' => 'The name of the channel flow.
', 'ChannelFlow$Name' => 'The name of the channel flow.
', 'ChannelFlowSummary$Name' => 'The name of the channel flow.
', 'ChannelSummary$Name' => 'The name of the channel.
', 'CreateChannelFlowRequest$Name' => 'The name of the channel flow.
', 'CreateChannelRequest$Name' => 'The name of the channel.
', 'Processor$Name' => 'The name of the channel flow.
', 'UpdateChannelFlowRequest$Name' => 'The name of the channel flow.
', 'UpdateChannelRequest$Name' => 'The name of the channel.
', ], ], 'NonNullableBoolean' => [ 'base' => NULL, 'refs' => [ 'ChannelFlowCallbackRequest$DeleteResource' => 'When a processor determines that a message needs to be DENIED, pass this parameter with a value of true.
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' => [], ], 'Processor' => [ 'base' => 'The information about a processor in a channel flow.
', 'refs' => [ 'ProcessorList$member' => NULL, ], ], 'ProcessorConfiguration' => [ 'base' => 'A processor\'s metadata.
', 'refs' => [ 'Processor$Configuration' => 'The information about the type of processor and its identifier.
', ], ], 'ProcessorList' => [ 'base' => NULL, 'refs' => [ 'ChannelFlow$Processors' => 'Information about the processor Lambda functions.
', 'ChannelFlowSummary$Processors' => 'Information about the processor Lambda functions.
', 'CreateChannelFlowRequest$Processors' => 'Information about the processor Lambda functions.
', 'UpdateChannelFlowRequest$Processors' => 'Information about the processor Lambda functions
', ], ], 'PushNotificationBody' => [ 'base' => NULL, 'refs' => [ 'PushNotificationConfiguration$Body' => 'The body of the push notification.
', ], ], 'PushNotificationConfiguration' => [ 'base' => 'The push notification configuration of the message.
', 'refs' => [ 'ChannelMessageCallback$PushNotification' => 'The push notification configuration of the message.
', 'SendChannelMessageRequest$PushNotification' => 'The push notification configuration of the message.
', ], ], 'PushNotificationPreferences' => [ 'base' => 'The channel membership preferences for push notification.
', 'refs' => [ 'ChannelMembershipPreferences$PushNotifications' => 'The push notification configuration of a message.
', ], ], 'PushNotificationTitle' => [ 'base' => NULL, 'refs' => [ 'PushNotificationConfiguration$Title' => 'The title of the push notification.
', ], ], 'PushNotificationType' => [ 'base' => NULL, 'refs' => [ 'PushNotificationConfiguration$Type' => 'Enum value that indicates the type of the push notification for a message. DEFAULT: Normal mobile push notification. VOIP: VOIP mobile push notification.
The request exceeds the resource limit.
', 'refs' => [], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'Identity$Name' => 'The name in an Identity.
', ], ], 'SearchChannelsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchChannelsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchField' => [ 'base' => 'A Field of the channel that you want to search.
An enum value that indicates the key to search the channel on. MEMBERS allows you to search channels based on memberships. You can use it with the EQUALS operator to get channels whose memberships are equal to the specified values, and with the INCLUDES operator to get channels whose memberships include the specified values.
The operator used to compare field values, currently EQUALS or INCLUDES. Use the EQUALS operator to find channels whose memberships equal the specified values. Use the INCLUDES operator to find channels whose memberships include the specified values.
The values that you want to search for, a list of strings. The values must be AppInstanceUserArns specified as a list of strings.
This operation isn\'t supported for AppInstanceUsers with large number of memberships.
A list of the Field objects in the channel being searched.
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.
', ], ], 'StatusDetail' => [ 'base' => NULL, 'refs' => [ 'ChannelMessageStatusStructure$Detail' => 'Contains more details about the message status.
', ], ], 'StreamingConfiguration' => [ 'base' => 'The configuration for connecting a messaging stream to Amazon Kinesis.
', 'refs' => [ 'StreamingConfigurationList$member' => NULL, ], ], 'StreamingConfigurationList' => [ 'base' => NULL, 'refs' => [ 'GetMessagingStreamingConfigurationsResponse$StreamingConfigurations' => 'The streaming settings.
', 'PutMessagingStreamingConfigurationsRequest$StreamingConfigurations' => 'The streaming configurations.
', 'PutMessagingStreamingConfigurationsResponse$StreamingConfigurations' => 'The requested streaming configurations.
', ], ], '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, ], ], 'SubChannelId' => [ 'base' => NULL, 'refs' => [ 'AppInstanceUserMembershipSummary$SubChannelId' => 'The ID of the SubChannel that the AppInstanceUser is a member of.
The ID of the SubChannel.
', 'BatchCreateChannelMembershipRequest$SubChannelId' => 'The ID of the SubChannel in the request.
Only required when creating membership in a SubChannel for a moderator in an elastic channel.
The ID of the SubChannel that a user belongs to.
', 'ChannelMessage$SubChannelId' => 'The ID of the SubChannel.
', 'ChannelMessageCallback$SubChannelId' => 'The ID of the SubChannel.
', 'CreateChannelMembershipRequest$SubChannelId' => 'The ID of the SubChannel in the request.
Only required when creating membership in a SubChannel for a moderator in an elastic channel.
The ID of the SubChannel in the response.
', 'DeleteChannelMembershipRequest$SubChannelId' => 'The ID of the SubChannel in the request.
Only for use by moderators.
The ID of the SubChannel in the request.
Only required when deleting messages in a SubChannel that the user belongs to.
The ID of the SubChannel in the request. The response contains an ElasticChannelConfiguration object.
Only required to get a user’s SubChannel membership details.
The ID of the SubChannel in the request.
Only required when getting messages in a SubChannel that the user belongs to.
The ID of the SubChannel in the request.
Only required when getting message status in a SubChannel that the user belongs to.
The ID of the SubChannel in the request.
Only required when listing a user\'s memberships in a particular sub-channel of an elastic channel.
The ID of the SubChannel in the request.
Only required when listing the messages in a SubChannel that the user belongs to.
The ID of the SubChannel in the response.
', 'RedactChannelMessageRequest$SubChannelId' => 'The ID of the SubChannel in the request.
', 'RedactChannelMessageResponse$SubChannelId' => 'The ID of the SubChannel in the response.
Only required when redacting messages in a SubChannel that the user belongs to.
The ID of the SubChannel in the request.
', 'SendChannelMessageResponse$SubChannelId' => 'The ID of the SubChannel in the response.
', 'SubChannelSummary$SubChannelId' => 'The unique ID of a SubChannel.
', 'UpdateChannelMessageRequest$SubChannelId' => 'The ID of the SubChannel in the request.
Only required when updating messages in a SubChannel that the user belongs to.
The ID of the SubChannel in the response.
', ], ], 'SubChannelSummary' => [ 'base' => 'Summary of the sub-channels associated with the elastic channel.
', 'refs' => [ 'SubChannelSummaryList$member' => NULL, ], ], 'SubChannelSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListSubChannelsResponse$SubChannels' => 'The information about each sub-channel.
', ], ], 'Tag' => [ 'base' => 'A tag object containing a key-value pair.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'The key in a tag.
', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => 'The tag keys.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateChannelFlowRequest$Tags' => 'The tags for the creation request.
', 'CreateChannelRequest$Tags' => 'The tags for the creation request.
', 'ListTagsForResourceResponse$Tags' => 'The tag key-value pairs.
', 'TagResourceRequest$Tags' => 'The tag key-value pairs.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'The value in a tag.
', ], ], 'Target' => [ 'base' => '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.
', 'refs' => [ 'TargetList$member' => NULL, ], ], 'TargetList' => [ 'base' => NULL, 'refs' => [ 'ChannelMessage$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.
', 'ChannelMessageSummary$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.
', 'SendChannelMessageRequest$Target' => 'The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. 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.
', ], ], 'TargetMembershipsPerSubChannel' => [ 'base' => NULL, 'refs' => [ 'ElasticChannelConfiguration$TargetMembershipsPerSubChannel' => 'The maximum number of members allowed in a SubChannel.
', ], ], 'ThrottledClientException' => [ 'base' => 'The client exceeded its request rate limit.
', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'AppInstanceUserMembershipSummary$ReadMarkerTimestamp' => 'The time at which an AppInstanceUser last marked a channel as read.
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.
', 'ChannelFlow$CreatedTimestamp' => 'The time at which the channel flow was created.
', 'ChannelFlow$LastUpdatedTimestamp' => 'The time at which a channel flow was updated.
', '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 persistent message visible to the caller 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' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateChannelFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateChannelFlowResponse' => [ 'base' => NULL, '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.
', ], ], ],];