Skip to content

EdgeConfig

Source code in docs_src/capo_kinesis_video/types/edge_config.py
class EdgeConfig(TypedDict, closed=True):
    hub_device_arn: "capo_kinesis_video.types.hub_device_arn.HubDeviceArn"
    """<p>The "<b>Internet of Things (IoT) Thing</b>" Arn of the stream.</p>"""
    recorder_config: "capo_kinesis_video.types.recorder_config.RecorderConfig"
    """<p>The recorder configuration consists of the local <code>MediaSourceConfig</code> details, that are used as credentials to access the local media files streamed on the camera. </p>"""
    uploader_config: NotRequired[
        "capo_kinesis_video.types.uploader_config.UploaderConfig"
    ]
    """<p>The uploader configuration contains the <code>ScheduleExpression</code> details that are used to schedule upload jobs for the recorded media files from the Edge Agent to a Kinesis Video Stream.</p>"""
    deletion_config: NotRequired[
        "capo_kinesis_video.types.deletion_config.DeletionConfig"
    ]
    """<p>The deletion configuration is made up of the retention time (<code>EdgeRetentionInHours</code>) and local size configuration (<code>LocalSizeConfig</code>) details that are used to make the deletion.</p>"""

deletion_config instance-attribute

deletion_config: NotRequired[DeletionConfig]

The deletion configuration is made up of the retention time (EdgeRetentionInHours) and local size configuration (LocalSizeConfig) details that are used to make the deletion.

hub_device_arn instance-attribute

hub_device_arn: HubDeviceArn

The "Internet of Things (IoT) Thing" Arn of the stream.

recorder_config instance-attribute

recorder_config: RecorderConfig

The recorder configuration consists of the local MediaSourceConfig details, that are used as credentials to access the local media files streamed on the camera.

uploader_config instance-attribute

uploader_config: NotRequired[UploaderConfig]

The uploader configuration contains the ScheduleExpression details that are used to schedule upload jobs for the recorded media files from the Edge Agent to a Kinesis Video Stream.