Skip to content

MediaCapturePipeline

Source code in docs_src/capo_chime_sdk_media_pipelines/types/media_capture_pipeline.py
class MediaCapturePipeline(TypedDict, closed=True):
    media_pipeline_id: NotRequired[
        "capo_chime_sdk_media_pipelines.types.guid_string.GuidString"
    ]
    """<p>The ID of a media pipeline.</p>"""
    media_pipeline_arn: NotRequired[
        "capo_chime_sdk_media_pipelines.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>The ARN of the media capture pipeline</p>"""
    source_type: NotRequired[
        "capo_chime_sdk_media_pipelines.types.media_pipeline_source_type.MediaPipelineSourceType"
    ]
    """<p>Source type from which media artifacts are saved. You must use <code>ChimeMeeting</code>.</p>"""
    source_arn: NotRequired["capo_chime_sdk_media_pipelines.types.arn.Arn"]
    """<p>ARN of the source from which the media artifacts are saved.</p>"""
    status: NotRequired[
        "capo_chime_sdk_media_pipelines.types.media_pipeline_status.MediaPipelineStatus"
    ]
    """<p>The status of the media pipeline.</p>"""
    sink_type: NotRequired[
        "capo_chime_sdk_media_pipelines.types.media_pipeline_sink_type.MediaPipelineSinkType"
    ]
    """<p>Destination type to which the media artifacts are saved. You must use an S3 Bucket.</p>"""
    sink_arn: NotRequired["capo_chime_sdk_media_pipelines.types.arn.Arn"]
    """<p>ARN of the destination to which the media artifacts are saved.</p>"""
    created_timestamp: NotRequired[
        "capo_chime_sdk_media_pipelines.types.iso8601_timestamp.Iso8601Timestamp"
    ]
    """<p>The time at which the pipeline was created, in ISO 8601 format.</p>"""
    updated_timestamp: NotRequired[
        "capo_chime_sdk_media_pipelines.types.iso8601_timestamp.Iso8601Timestamp"
    ]
    """<p>The time at which the pipeline was updated, in ISO 8601 format.</p>"""
    chime_sdk_meeting_configuration: NotRequired[
        "capo_chime_sdk_media_pipelines.types.chime_sdk_meeting_configuration.ChimeSdkMeetingConfiguration"
    ]
    """<p>The configuration for a specified media pipeline. <code>SourceType</code> must be <code>ChimeSdkMeeting</code>.</p>"""
    sse_aws_key_management_params: NotRequired[
        "capo_chime_sdk_media_pipelines.types.sse_aws_key_management_params.SseAwsKeyManagementParams"
    ]
    """<p>An object that contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.</p>"""
    sink_iam_role_arn: NotRequired["capo_chime_sdk_media_pipelines.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the sink role to be used with <code>AwsKmsKeyId</code> in <code>SseAwsKeyManagementParams</code>.</p>"""

chime_sdk_meeting_configuration instance-attribute

chime_sdk_meeting_configuration: NotRequired[ChimeSdkMeetingConfiguration]

The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

created_timestamp instance-attribute

created_timestamp: NotRequired[Iso8601Timestamp]

The time at which the pipeline was created, in ISO 8601 format.

media_pipeline_arn instance-attribute

media_pipeline_arn: NotRequired[AmazonResourceName]

The ARN of the media capture pipeline

media_pipeline_id instance-attribute

media_pipeline_id: NotRequired[GuidString]

The ID of a media pipeline.

sink_arn instance-attribute

sink_arn: NotRequired[Arn]

ARN of the destination to which the media artifacts are saved.

sink_iam_role_arn instance-attribute

sink_iam_role_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams.

sink_type instance-attribute

sink_type: NotRequired[MediaPipelineSinkType]

Destination type to which the media artifacts are saved. You must use an S3 Bucket.

source_arn instance-attribute

source_arn: NotRequired[Arn]

ARN of the source from which the media artifacts are saved.

source_type instance-attribute

source_type: NotRequired[MediaPipelineSourceType]

Source type from which media artifacts are saved. You must use ChimeMeeting.

sse_aws_key_management_params instance-attribute

sse_aws_key_management_params: NotRequired[SseAwsKeyManagementParams]

An object that contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.

status instance-attribute

status: NotRequired[MediaPipelineStatus]

The status of the media pipeline.

updated_timestamp instance-attribute

updated_timestamp: NotRequired[Iso8601Timestamp]

The time at which the pipeline was updated, in ISO 8601 format.