Skip to content

RecordingConfiguration

Source code in docs_src/capo_ivs/types/recording_configuration.py
class RecordingConfiguration(TypedDict, closed=True):
    arn: "capo_ivs.types.recording_configuration_arn.RecordingConfigurationArn"
    """<p>Recording-configuration ARN.</p>"""
    name: NotRequired[
        "capo_ivs.types.recording_configuration_name.RecordingConfigurationName"
    ]
    """<p>Recording-configuration name. The value does not need to be unique.</p>"""
    destination_configuration: (
        "capo_ivs.types.destination_configuration.DestinationConfiguration"
    )
    """<p>A complex type that contains information about where recorded video will be stored.</p>"""
    state: "capo_ivs.types.recording_configuration_state.RecordingConfigurationState"
    """<p>Indicates the current state of the recording configuration. When the state is <code>ACTIVE</code>, the configuration is ready for recording a channel stream.</p>"""
    tags: NotRequired["capo_ivs.types.tags.Tags"]
    """<p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.</p>"""
    thumbnail_configuration: NotRequired[
        "capo_ivs.types.thumbnail_configuration.ThumbnailConfiguration"
    ]
    """<p>A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.</p>"""
    recording_reconnect_window_seconds: "capo_ivs.types.recording_reconnect_window_seconds.RecordingReconnectWindowSeconds"
    """<p>If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.</p>"""
    rendition_configuration: NotRequired[
        "capo_ivs.types.rendition_configuration.RenditionConfiguration"
    ]
    """<p>Object that describes which renditions should be recorded for a stream.</p>"""

arn instance-attribute

Recording-configuration ARN.

destination_configuration instance-attribute

destination_configuration: DestinationConfiguration

A complex type that contains information about where recorded video will be stored.

name instance-attribute

name: NotRequired[RecordingConfigurationName]

Recording-configuration name. The value does not need to be unique.

recording_reconnect_window_seconds instance-attribute

recording_reconnect_window_seconds: RecordingReconnectWindowSeconds

If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

rendition_configuration instance-attribute

rendition_configuration: NotRequired[RenditionConfiguration]

Object that describes which renditions should be recorded for a stream.

state instance-attribute

Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

tags instance-attribute

tags: NotRequired[Tags]

Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

thumbnail_configuration instance-attribute

thumbnail_configuration: NotRequired[ThumbnailConfiguration]

A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.