Skip to content

CreateMediaCapturePipelineRequest

Source code in docs_src/capo_chime_sdk_media_pipelines/types/create_media_capture_pipeline_request.py
class CreateMediaCapturePipelineRequest(TypedDict, closed=True):
    source_type: "capo_chime_sdk_media_pipelines.types.media_pipeline_source_type.MediaPipelineSourceType"
    """<p>Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.</p>"""
    source_arn: "capo_chime_sdk_media_pipelines.types.arn.Arn"
    """<p>ARN of the source from which the media artifacts are captured.</p>"""
    sink_type: "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: "capo_chime_sdk_media_pipelines.types.arn.Arn"
    """<p>The ARN of the sink type.</p>"""
    client_request_token: NotRequired[
        "capo_chime_sdk_media_pipelines.types.client_request_token.ClientRequestToken"
    ]
    """<p>The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.</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>. Can only interact with <code>S3Bucket</code> sink type. The role must belong to the caller’s account and be able to act on behalf of the caller during the API call. All minimum policy permissions requirements for the caller to perform sink-related actions are the same for <code>SinkIamRoleArn</code>.</p> <p>Additionally, the role must have permission to <code>kms:GenerateDataKey</code> using KMS key supplied as <code>AwsKmsKeyId</code> in <code>SseAwsKeyManagementParams</code>. If media concatenation will be required later, the role must also have permission to <code>kms:Decrypt</code> for the same KMS key.</p>"""
    tags: NotRequired["capo_chime_sdk_media_pipelines.types.tag_list.TagList"]
    """<p>The tag key-value pairs.</p>"""

chime_sdk_meeting_configuration instance-attribute

chime_sdk_meeting_configuration: NotRequired[ChimeSdkMeetingConfiguration]

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

client_request_token instance-attribute

client_request_token: NotRequired[ClientRequestToken]

The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.

sink_arn instance-attribute

sink_arn: Arn

The ARN of the sink type.

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. Can only interact with S3Bucket sink type. The role must belong to the caller’s account and be able to act on behalf of the caller during the API call. All minimum policy permissions requirements for the caller to perform sink-related actions are the same for SinkIamRoleArn.

Additionally, the role must have permission to kms:GenerateDataKey using KMS key supplied as AwsKmsKeyId in SseAwsKeyManagementParams. If media concatenation will be required later, the role must also have permission to kms:Decrypt for the same KMS key.

sink_type instance-attribute

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

source_arn instance-attribute

source_arn: Arn

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

source_type instance-attribute

Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.

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.

tags instance-attribute

tags: NotRequired[TagList]

The tag key-value pairs.