ChannelMessage
The details of a message in a channel.
Contents
- ChannelArn
-
The ARN of the channel.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 1600.
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
Required: No
- 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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 4096.
Pattern:
[\s\S]*
Required: No
- 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 andapplication/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.Type: String
Length Constraints: Minimum length of 0. Maximum length of 45.
Pattern:
[\s\S]*
Required: No
- CreatedTimestamp
-
The time at which the message was created.
Type: Timestamp
Required: No
- LastEditedTimestamp
-
The time at which a message was edited.
Type: Timestamp
Required: No
- LastUpdatedTimestamp
-
The time at which a message was updated.
Type: Timestamp
Required: No
- 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.
Type: String to MessageAttributeValue object map
Key Length Constraints: Minimum length of 1. Maximum length of 64.
Key Pattern:
[\s\S]*
Required: No
- MessageId
-
The ID of a message.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[-_a-zA-Z0-9]*
Required: No
- Metadata
-
The message metadata.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
.*
Required: No
- Persistence
-
The persistence setting for a channel message.
Type: String
Valid Values:
PERSISTENT | NON_PERSISTENT
Required: No
- Redacted
-
Hides the content of a message.
Type: Boolean
Required: No
- Sender
-
The message sender.
Type: Identity object
Required: No
- Status
-
The status of the channel message.
Type: ChannelMessageStatusStructure object
Required: No
- SubChannelId
-
The ID of the SubChannel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[-_a-zA-Z0-9]*
Required: No
- 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.
Type: Array of Target objects
Array Members: Fixed number of 1 item.
Required: No
- Type
-
The message type.
Type: String
Valid Values:
STANDARD | CONTROL
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: