Skip to content

create_media_insights_pipeline async

create_media_insights_pipeline(
    media_insights_pipeline_configuration_arn: Arn,
    *,
    config_overrides: Optional[AsyncChimeSDKMediaPipelinesClientConfig] = None,
    kinesis_video_stream_source_runtime_configuration: Optional[
        KinesisVideoStreamSourceRuntimeConfiguration
    ] = None,
    media_insights_runtime_metadata: Optional[MediaInsightsRuntimeMetadata] = None,
    kinesis_video_stream_recording_source_runtime_configuration: Optional[
        KinesisVideoStreamRecordingSourceRuntimeConfiguration
    ] = None,
    s3_recording_sink_runtime_configuration: Optional[
        S3RecordingSinkRuntimeConfiguration
    ] = None,
    tags: Optional[TagList] = None,
    client_request_token: Optional[ClientRequestToken] = None,
) -> CreateMediaInsightsPipelineResponse

Creates a media insights pipeline.

Parameters:

  • media_insights_pipeline_configuration_arn (Arn) –

    The ARN of the pipeline's configuration.

  • kinesis_video_stream_source_runtime_configuration (Optional[KinesisVideoStreamSourceRuntimeConfiguration], default: None ) –

    The runtime configuration for the Kinesis video stream source of the media insights pipeline.

  • media_insights_runtime_metadata (Optional[MediaInsightsRuntimeMetadata], default: None ) –

    The runtime metadata for the media insights pipeline. Consists of a key-value map of strings.

  • kinesis_video_stream_recording_source_runtime_configuration (Optional[KinesisVideoStreamRecordingSourceRuntimeConfiguration], default: None ) –

    The runtime configuration for the Kinesis video recording stream source.

  • s3_recording_sink_runtime_configuration (Optional[S3RecordingSinkRuntimeConfiguration], default: None ) –

    The runtime configuration for the S3 recording sink. If specified, the settings in this structure override any settings in S3RecordingSinkConfiguration.

  • tags (Optional[TagList], default: None ) –

    The tags assigned to the media insights pipeline.

  • client_request_token (Optional[ClientRequestToken], default: None ) –

    The unique identifier for the media insights pipeline request.

Raises:

Source code in docs_src/capo_chime_sdk_media_pipelines/_services/async_chime_sdk_media_pipelines.py
async def create_media_insights_pipeline(
    self,
    media_insights_pipeline_configuration_arn: "capo_chime_sdk_media_pipelines.types.arn.Arn",
    *,
    config_overrides: Optional[AsyncChimeSDKMediaPipelinesClientConfig] = None,
    kinesis_video_stream_source_runtime_configuration: Optional[
        "capo_chime_sdk_media_pipelines.types.kinesis_video_stream_source_runtime_configuration.KinesisVideoStreamSourceRuntimeConfiguration"
    ] = None,
    media_insights_runtime_metadata: Optional[
        "capo_chime_sdk_media_pipelines.types.media_insights_runtime_metadata.MediaInsightsRuntimeMetadata"
    ] = None,
    kinesis_video_stream_recording_source_runtime_configuration: Optional[
        "capo_chime_sdk_media_pipelines.types.kinesis_video_stream_recording_source_runtime_configuration.KinesisVideoStreamRecordingSourceRuntimeConfiguration"
    ] = None,
    s3_recording_sink_runtime_configuration: Optional[
        "capo_chime_sdk_media_pipelines.types.s3_recording_sink_runtime_configuration.S3RecordingSinkRuntimeConfiguration"
    ] = None,
    tags: Optional["capo_chime_sdk_media_pipelines.types.tag_list.TagList"] = None,
    client_request_token: Optional[
        "capo_chime_sdk_media_pipelines.types.client_request_token.ClientRequestToken"
    ] = None,
) -> "capo_chime_sdk_media_pipelines.types.create_media_insights_pipeline_response.CreateMediaInsightsPipelineResponse":
    """<p>Creates a media insights pipeline.</p>

    Args:
        media_insights_pipeline_configuration_arn: <p>The ARN of the pipeline's configuration.</p>
        kinesis_video_stream_source_runtime_configuration: <p>The runtime configuration for the Kinesis video stream source of the media insights pipeline.</p>
        media_insights_runtime_metadata: <p>The runtime metadata for the media insights pipeline. Consists of a key-value map of strings.</p>
        kinesis_video_stream_recording_source_runtime_configuration: <p>The runtime configuration for the Kinesis video recording stream source.</p>
        s3_recording_sink_runtime_configuration: <p>The runtime configuration for the S3 recording sink. If specified, the settings in this structure override any settings in <code>S3RecordingSinkConfiguration</code>.</p>
        tags: <p>The tags assigned to the media insights pipeline.</p>
        client_request_token: <p>The unique identifier for the media insights pipeline request.</p>

    Raises:
        capo_chime_sdk_media_pipelines.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_media_pipelines.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_media_pipelines.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system.</p>
        capo_chime_sdk_media_pipelines.errors.resource_limit_exceeded_exception.ResourceLimitExceededException: <p>The request exceeds the resource limit.</p>
        capo_chime_sdk_media_pipelines.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_media_pipelines.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_media_pipelines.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime_sdk_media_pipelines.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime_sdk_media_pipelines.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime_sdk_media_pipelines.types.create_media_insights_pipeline_request.CreateMediaInsightsPipelineRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime_sdk_media_pipelines.types.create_media_insights_pipeline_response.CreateMediaInsightsPipelineResponse"
    ]:
        import capo_chime_sdk_media_pipelines._operations.chime_sdk_media_pipelines_service.create_media_insights_pipeline

        (
            output,
            http_response,
        ) = await capo_chime_sdk_media_pipelines._operations.chime_sdk_media_pipelines_service.create_media_insights_pipeline.async_create_media_insights_pipeline(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_chime_sdk_media_pipelines.types.create_media_insights_pipeline_request.CreateMediaInsightsPipelineRequest",
    ) -> dict[str, Any]:
        import capo_chime_sdk_media_pipelines.types.create_media_insights_pipeline_request

        return capo_chime_sdk_media_pipelines.types.create_media_insights_pipeline_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_chime_sdk_media_pipelines.types.create_media_insights_pipeline_response.CreateMediaInsightsPipelineResponse",
    ) -> dict[str, Any]:
        import capo_chime_sdk_media_pipelines.types.create_media_insights_pipeline_response

        return capo_chime_sdk_media_pipelines.types.create_media_insights_pipeline_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreateMediaInsightsPipeline",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_chime_sdk_media_pipelines.types.create_media_insights_pipeline_request.CreateMediaInsightsPipelineRequest = {
        "media_insights_pipeline_configuration_arn": media_insights_pipeline_configuration_arn
    }
    if kinesis_video_stream_source_runtime_configuration is not None:
        input_["kinesis_video_stream_source_runtime_configuration"] = (
            kinesis_video_stream_source_runtime_configuration
        )
    if media_insights_runtime_metadata is not None:
        input_["media_insights_runtime_metadata"] = media_insights_runtime_metadata
    if kinesis_video_stream_recording_source_runtime_configuration is not None:
        input_["kinesis_video_stream_recording_source_runtime_configuration"] = (
            kinesis_video_stream_recording_source_runtime_configuration
        )
    if s3_recording_sink_runtime_configuration is not None:
        input_["s3_recording_sink_runtime_configuration"] = (
            s3_recording_sink_runtime_configuration
        )
    if tags is not None:
        input_["tags"] = tags
    if client_request_token is None:
        client_request_token = str(uuid.uuid4())
    input_["client_request_token"] = client_request_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output