Skip to content

UpdateOriginEndpointRequest

Source code in docs_src/capo_mediapackagev2/types/update_origin_endpoint_request.py
class UpdateOriginEndpointRequest(TypedDict, closed=True):
    channel_group_name: "capo_mediapackagev2.types.resource_name.ResourceName"
    """<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>"""
    channel_name: "capo_mediapackagev2.types.resource_name.ResourceName"
    """<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>"""
    origin_endpoint_name: "capo_mediapackagev2.types.resource_name.ResourceName"
    """<p>The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. </p>"""
    container_type: "capo_mediapackagev2.types.container_type.ContainerType"
    """<p>The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. </p>"""
    segment: NotRequired["capo_mediapackagev2.types.segment.Segment"]
    """<p>The segment configuration, including the segment name, duration, and other configuration values.</p>"""
    description: NotRequired[
        "capo_mediapackagev2.types.resource_description.ResourceDescription"
    ]
    """<p>Any descriptive information that you want to add to the origin endpoint for future identification purposes.</p>"""
    startover_window_seconds: NotRequired["int"]
    """<p>The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).</p>"""
    hls_manifests: NotRequired[
        "capo_mediapackagev2.types.create_hls_manifests.CreateHlsManifests"
    ]
    """<p>An HTTP live streaming (HLS) manifest configuration.</p>"""
    low_latency_hls_manifests: NotRequired[
        "capo_mediapackagev2.types.create_low_latency_hls_manifests.CreateLowLatencyHlsManifests"
    ]
    """<p>A low-latency HLS manifest configuration.</p>"""
    dash_manifests: NotRequired[
        "capo_mediapackagev2.types.create_dash_manifests.CreateDashManifests"
    ]
    """<p>A DASH manifest configuration.</p>"""
    mss_manifests: NotRequired[
        "capo_mediapackagev2.types.create_mss_manifests.CreateMssManifests"
    ]
    """<p>A list of Microsoft Smooth Streaming (MSS) manifest configurations to update for the origin endpoint. This replaces the existing MSS manifest configurations.</p>"""
    force_endpoint_error_configuration: NotRequired[
        "capo_mediapackagev2.types.force_endpoint_error_configuration.ForceEndpointErrorConfiguration"
    ]
    """<p>The failover settings for the endpoint.</p>"""
    uri_separator: NotRequired["capo_mediapackagev2.types.uri_separator.UriSeparator"]
    """<p>The separator character to use in generated URIs for this origin endpoint. This setting applies to all manifest types on the endpoint. If you don't specify a value in the update request, the current value is preserved.</p>"""
    stream_name_output_mode: NotRequired[
        "capo_mediapackagev2.types.stream_name_output_mode.StreamNameOutputMode"
    ]
    """<p>The output mode for stream names in egress manifests. If you provide a value, it must match the current value. You can't change the stream name output mode after you create the endpoint.</p>"""
    e_tag: NotRequired["capo_mediapackagev2.types.entity_tag.EntityTag"]
    """<p>The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.</p>"""

channel_group_name instance-attribute

channel_group_name: ResourceName

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: ResourceName

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.

container_type instance-attribute

container_type: ContainerType

The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file.

dash_manifests instance-attribute

dash_manifests: NotRequired[CreateDashManifests]

A DASH manifest configuration.

description instance-attribute

description: NotRequired[ResourceDescription]

Any descriptive information that you want to add to the origin endpoint for future identification purposes.

e_tag instance-attribute

e_tag: NotRequired[EntityTag]

The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.

force_endpoint_error_configuration instance-attribute

force_endpoint_error_configuration: NotRequired[ForceEndpointErrorConfiguration]

The failover settings for the endpoint.

hls_manifests instance-attribute

hls_manifests: NotRequired[CreateHlsManifests]

An HTTP live streaming (HLS) manifest configuration.

low_latency_hls_manifests instance-attribute

low_latency_hls_manifests: NotRequired[CreateLowLatencyHlsManifests]

A low-latency HLS manifest configuration.

mss_manifests instance-attribute

mss_manifests: NotRequired[CreateMssManifests]

A list of Microsoft Smooth Streaming (MSS) manifest configurations to update for the origin endpoint. This replaces the existing MSS manifest configurations.

origin_endpoint_name instance-attribute

origin_endpoint_name: ResourceName

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

segment instance-attribute

segment: NotRequired[Segment]

The segment configuration, including the segment name, duration, and other configuration values.

startover_window_seconds instance-attribute

startover_window_seconds: NotRequired[int]

The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).

stream_name_output_mode instance-attribute

stream_name_output_mode: NotRequired[StreamNameOutputMode]

The output mode for stream names in egress manifests. If you provide a value, it must match the current value. You can't change the stream name output mode after you create the endpoint.

uri_separator instance-attribute

uri_separator: NotRequired[UriSeparator]

The separator character to use in generated URIs for this origin endpoint. This setting applies to all manifest types on the endpoint. If you don't specify a value in the update request, the current value is preserved.