Skip to content

ChannelMessageSummary

Source code in docs_src/capo_chime_sdk_messaging/types/channel_message_summary.py
class ChannelMessageSummary(TypedDict, closed=True):
    message_id: NotRequired["capo_chime_sdk_messaging.types.message_id.MessageId"]
    """<p>The ID of the message.</p>"""
    content: NotRequired["capo_chime_sdk_messaging.types.content.Content"]
    """<p>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 <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>"""
    metadata: NotRequired["capo_chime_sdk_messaging.types.metadata.Metadata"]
    """<p>The metadata of the message.</p>"""
    type: NotRequired[
        "capo_chime_sdk_messaging.types.channel_message_type.ChannelMessageType"
    ]
    """<p>The type of message.</p>"""
    created_timestamp: NotRequired["capo_chime_sdk_messaging.types.timestamp.Timestamp"]
    """<p>The time at which the message summary was created.</p>"""
    last_updated_timestamp: NotRequired[
        "capo_chime_sdk_messaging.types.timestamp.Timestamp"
    ]
    """<p>The time at which a message was last updated.</p>"""
    last_edited_timestamp: NotRequired[
        "capo_chime_sdk_messaging.types.timestamp.Timestamp"
    ]
    """<p>The time at which a message was last edited.</p>"""
    sender: NotRequired["capo_chime_sdk_messaging.types.identity.Identity"]
    """<p>The message sender.</p>"""
    redacted: "capo_chime_sdk_messaging.types.non_nullable_boolean.NonNullableBoolean"
    """<p>Indicates whether a message was redacted.</p>"""
    status: NotRequired[
        "capo_chime_sdk_messaging.types.channel_message_status_structure.ChannelMessageStatusStructure"
    ]
    """<p>The message status. The status value is <code>SENT</code> for messages sent to a channel without a channel flow. For channels associated with channel flow, the value determines the processing stage.</p>"""
    message_attributes: NotRequired[
        "capo_chime_sdk_messaging.types.message_attribute_map.MessageAttributeMap"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>"""
    content_type: NotRequired["capo_chime_sdk_messaging.types.content_type.ContentType"]
    """<p>The content type of the channel message listed in the summary. For Amazon Lex V2 bot responses, the content type is <code>application/amz-chime-lex-msgs</code> for success responses and <code>application/amz-chime-lex-error</code> for failure responses. For more information, refer to <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>"""
    target: NotRequired["capo_chime_sdk_messaging.types.target_list.TargetList"]
    """<p>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.</p>"""

content instance-attribute

content: NotRequired[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.

content_type instance-attribute

content_type: NotRequired[ContentType]

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.

created_timestamp instance-attribute

created_timestamp: NotRequired[Timestamp]

The time at which the message summary was created.

last_edited_timestamp instance-attribute

last_edited_timestamp: NotRequired[Timestamp]

The time at which a message was last edited.

last_updated_timestamp instance-attribute

last_updated_timestamp: NotRequired[Timestamp]

The time at which a message was last updated.

message_attributes instance-attribute

message_attributes: NotRequired[MessageAttributeMap]

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.

message_id instance-attribute

message_id: NotRequired[MessageId]

The ID of the message.

metadata instance-attribute

metadata: NotRequired[Metadata]

The metadata of the message.

redacted instance-attribute

Indicates whether a message was redacted.

sender instance-attribute

sender: NotRequired[Identity]

The message sender.

status instance-attribute

status: NotRequired[ChannelMessageStatusStructure]

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.

target instance-attribute

target: NotRequired[TargetList]

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 instance-attribute

type: NotRequired[ChannelMessageType]

The type of message.