Skip to content

Channel

Source code in docs_src/capo_chime_sdk_messaging/types/channel.py
class Channel(TypedDict, closed=True):
    name: NotRequired[
        "capo_chime_sdk_messaging.types.non_empty_resource_name.NonEmptyResourceName"
    ]
    """<p>The name of a channel.</p>"""
    channel_arn: NotRequired["capo_chime_sdk_messaging.types.chime_arn.ChimeArn"]
    """<p>The ARN of a channel.</p>"""
    mode: NotRequired["capo_chime_sdk_messaging.types.channel_mode.ChannelMode"]
    """<p>The mode of the channel.</p>"""
    privacy: NotRequired[
        "capo_chime_sdk_messaging.types.channel_privacy.ChannelPrivacy"
    ]
    """<p>The channel's privacy setting.</p>"""
    metadata: NotRequired["capo_chime_sdk_messaging.types.metadata.Metadata"]
    """<p>The channel's metadata.</p>"""
    created_by: NotRequired["capo_chime_sdk_messaging.types.identity.Identity"]
    """<p>The <code>AppInstanceUser</code> who created the channel.</p>"""
    created_timestamp: NotRequired["capo_chime_sdk_messaging.types.timestamp.Timestamp"]
    """<p>The time at which the <code>AppInstanceUser</code> created the channel.</p>"""
    last_message_timestamp: NotRequired[
        "capo_chime_sdk_messaging.types.timestamp.Timestamp"
    ]
    """<p>The time at which a member sent the last message in the channel.</p>"""
    last_updated_timestamp: NotRequired[
        "capo_chime_sdk_messaging.types.timestamp.Timestamp"
    ]
    """<p>The time at which a channel was last updated.</p>"""
    channel_flow_arn: NotRequired["capo_chime_sdk_messaging.types.chime_arn.ChimeArn"]
    """<p>The ARN of the channel flow.</p>"""
    elastic_channel_configuration: NotRequired[
        "capo_chime_sdk_messaging.types.elastic_channel_configuration.ElasticChannelConfiguration"
    ]
    """<p>The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.</p>"""
    expiration_settings: NotRequired[
        "capo_chime_sdk_messaging.types.expiration_settings.ExpirationSettings"
    ]
    """<p>Settings that control when a channel expires.</p>"""

channel_arn instance-attribute

channel_arn: NotRequired[ChimeArn]

The ARN of a channel.

channel_flow_arn instance-attribute

channel_flow_arn: NotRequired[ChimeArn]

The ARN of the channel flow.

created_by instance-attribute

created_by: NotRequired[Identity]

The AppInstanceUser who created the channel.

created_timestamp instance-attribute

created_timestamp: NotRequired[Timestamp]

The time at which the AppInstanceUser created the channel.

elastic_channel_configuration instance-attribute

elastic_channel_configuration: NotRequired[ElasticChannelConfiguration]

The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.

expiration_settings instance-attribute

expiration_settings: NotRequired[ExpirationSettings]

Settings that control when a channel expires.

last_message_timestamp instance-attribute

last_message_timestamp: NotRequired[Timestamp]

The time at which a member sent the last message in the channel.

last_updated_timestamp instance-attribute

last_updated_timestamp: NotRequired[Timestamp]

The time at which a channel was last updated.

metadata instance-attribute

metadata: NotRequired[Metadata]

The channel's metadata.

mode instance-attribute

mode: NotRequired[ChannelMode]

The mode of the channel.

name instance-attribute

name: NotRequired[NonEmptyResourceName]

The name of a channel.

privacy instance-attribute

privacy: NotRequired[ChannelPrivacy]

The channel's privacy setting.