Skip to content

GetChannelResponse

Source code in docs_src/capo_mediapackagev2/types/get_channel_response.py
class GetChannelResponse(TypedDict, closed=True):
    multiview_configuration: NotRequired[
        "capo_mediapackagev2.types.multiview_configuration.MultiviewConfiguration"
    ]
    """<p>The multiview configuration for the channel. This is present only when <code>InputType</code> is <code>MULTIVIEW</code>.</p>"""
    attached_multiview_channels: NotRequired[
        "capo_mediapackagev2.types.attached_multiview_channel_list.AttachedMultiviewChannelList"
    ]
    """<p>The multiview channels, in the same channel group, that list this channel as an available source. This is a read-only field. You can't delete a channel while any multiview channel still lists it as a source. Use this field to find the multiview channels that you need to update first.</p>"""
    arn: "str"
    """<p>The Amazon Resource Name (ARN) associated with the resource.</p>"""
    channel_name: "str"
    """<p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>"""
    channel_group_name: "str"
    """<p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>"""
    created_at: "datetime.datetime"
    """<p>The date and time the channel was created.</p>"""
    modified_at: "datetime.datetime"
    """<p>The date and time the channel was modified.</p>"""
    reset_at: NotRequired["datetime.datetime"]
    """<p>The time that the channel was last reset.</p>"""
    description: NotRequired[
        "capo_mediapackagev2.types.resource_description.ResourceDescription"
    ]
    """<p>The description for your channel.</p>"""
    ingest_endpoints: NotRequired[
        "capo_mediapackagev2.types.ingest_endpoint_list.IngestEndpointList"
    ]
    input_type: NotRequired["capo_mediapackagev2.types.input_type.InputType"]
    """<p>The input type is an immutable field. It defines whether the channel allows CMAF ingest, HLS ingest, or server-side multiview output. Multiview channels receive no ingest of their own. If unprovided, the value defaults to HLS.</p> <p>The allowed values are:</p> <ul> <li> <p> <code>HLS</code> - The HLS streaming specification (which defines M3U8 manifests and TS segments).</p> </li> <li> <p> <code>CMAF</code> - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).</p> </li> <li> <p> <code>MULTIVIEW</code> – Server-side multiview. The channel receives no ingest of its own. Instead, it composites video from the source channels in its <code>MultiviewConfiguration</code> into a single tiled output stream.</p> </li> </ul>"""
    e_tag: NotRequired["capo_mediapackagev2.types.entity_tag.EntityTag"]
    """<p>The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.</p>"""
    tags: NotRequired["capo_mediapackagev2.types.tag_map.TagMap"]
    """<p>The comma-separated list of tag key:value pairs assigned to the channel.</p>"""
    input_switch_configuration: NotRequired[
        "capo_mediapackagev2.types.input_switch_configuration.InputSwitchConfiguration"
    ]
    """<p>The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when <code>InputType</code> is <code>CMAF</code>.</p>"""
    output_header_configuration: NotRequired[
        "capo_mediapackagev2.types.output_header_configuration.OutputHeaderConfiguration"
    ]
    """<p>The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when <code>InputType</code> is <code>CMAF</code>.</p>"""
    output_locking_mode: NotRequired[
        "capo_mediapackagev2.types.output_locking_mode.OutputLockingMode"
    ]
    """<p>The output locking mode configured for the channel.</p> <p>The allowed values are:</p> <ul> <li> <p> <code>EPOCH_LOCKED</code> - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time.</p> </li> <li> <p> <code>NON_EPOCH_LOCKED</code> - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0.</p> </li> </ul>"""

arn instance-attribute

arn: str

The Amazon Resource Name (ARN) associated with the resource.

attached_multiview_channels instance-attribute

attached_multiview_channels: NotRequired[AttachedMultiviewChannelList]

The multiview channels, in the same channel group, that list this channel as an available source. This is a read-only field. You can't delete a channel while any multiview channel still lists it as a source. Use this field to find the multiview channels that you need to update first.

channel_group_name instance-attribute

channel_group_name: str

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

channel_name instance-attribute

channel_name: str

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

created_at instance-attribute

created_at: datetime

The date and time the channel was created.

description instance-attribute

description: NotRequired[ResourceDescription]

The description for your channel.

e_tag instance-attribute

e_tag: NotRequired[EntityTag]

The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

ingest_endpoints instance-attribute

ingest_endpoints: NotRequired[IngestEndpointList]

input_switch_configuration instance-attribute

input_switch_configuration: NotRequired[InputSwitchConfiguration]

The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when InputType is CMAF.

input_type instance-attribute

input_type: NotRequired[InputType]

The input type is an immutable field. It defines whether the channel allows CMAF ingest, HLS ingest, or server-side multiview output. Multiview channels receive no ingest of their own. If unprovided, the value defaults to HLS.

The allowed values are:

  • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

  • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

  • MULTIVIEW – Server-side multiview. The channel receives no ingest of its own. Instead, it composites video from the source channels in its MultiviewConfiguration into a single tiled output stream.

modified_at instance-attribute

modified_at: datetime

The date and time the channel was modified.

multiview_configuration instance-attribute

multiview_configuration: NotRequired[MultiviewConfiguration]

The multiview configuration for the channel. This is present only when InputType is MULTIVIEW.

output_header_configuration instance-attribute

output_header_configuration: NotRequired[OutputHeaderConfiguration]

The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF.

output_locking_mode instance-attribute

output_locking_mode: NotRequired[OutputLockingMode]

The output locking mode configured for the channel.

The allowed values are:

  • EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time.

  • NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0.

reset_at instance-attribute

reset_at: NotRequired[datetime]

The time that the channel was last reset.

tags instance-attribute

tags: NotRequired[TagMap]

The comma-separated list of tag key:value pairs assigned to the channel.