Skip to content

ChannelMessage

Source code in docs_src/capo_chime_sdk_messaging/types/channel_message.py
class ChannelMessage(TypedDict, closed=True):
    channel_arn: NotRequired["capo_chime_sdk_messaging.types.chime_arn.ChimeArn"]
    """<p>The ARN of the channel.</p>"""
    message_id: NotRequired["capo_chime_sdk_messaging.types.message_id.MessageId"]
    """<p>The ID of a 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 message metadata.</p>"""
    type: NotRequired[
        "capo_chime_sdk_messaging.types.channel_message_type.ChannelMessageType"
    ]
    """<p>The message type.</p>"""
    created_timestamp: NotRequired["capo_chime_sdk_messaging.types.timestamp.Timestamp"]
    """<p>The time at which the message was created.</p>"""
    last_edited_timestamp: NotRequired[
        "capo_chime_sdk_messaging.types.timestamp.Timestamp"
    ]
    """<p>The time at which a message was edited.</p>"""
    last_updated_timestamp: NotRequired[
        "capo_chime_sdk_messaging.types.timestamp.Timestamp"
    ]
    """<p>The time at which a message was updated.</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>Hides the content of a message.</p>"""
    persistence: NotRequired[
        "capo_chime_sdk_messaging.types.channel_message_persistence_type.ChannelMessagePersistenceType"
    ]
    """<p>The persistence setting for a channel message.</p>"""
    status: NotRequired[
        "capo_chime_sdk_messaging.types.channel_message_status_structure.ChannelMessageStatusStructure"
    ]
    """<p>The status of the channel message.</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>"""
    sub_channel_id: NotRequired[
        "capo_chime_sdk_messaging.types.sub_channel_id.SubChannelId"
    ]
    """<p>The ID of the SubChannel.</p>"""
    content_type: NotRequired["capo_chime_sdk_messaging.types.content_type.ContentType"]
    """<p>The content type of the channel message. 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>"""

channel_arn instance-attribute

channel_arn: NotRequired[ChimeArn]

The ARN of the channel.

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. 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 was created.

last_edited_timestamp instance-attribute

last_edited_timestamp: NotRequired[Timestamp]

The time at which a message was edited.

last_updated_timestamp instance-attribute

last_updated_timestamp: NotRequired[Timestamp]

The time at which a message was 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 a message.

metadata instance-attribute

metadata: NotRequired[Metadata]

The message metadata.

persistence instance-attribute

persistence: NotRequired[ChannelMessagePersistenceType]

The persistence setting for a channel message.

redacted instance-attribute

Hides the content of a message.

sender instance-attribute

sender: NotRequired[Identity]

The message sender.

status instance-attribute

status: NotRequired[ChannelMessageStatusStructure]

The status of the channel message.

sub_channel_id instance-attribute

sub_channel_id: NotRequired[SubChannelId]

The ID of the SubChannel.

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 message type.