Skip to content

get_media_capture_pipeline

get_media_capture_pipeline(
    media_pipeline_id: GuidString,
    *,
    config_overrides: Optional[ChimeSDKMediaPipelinesClientConfig] = None,
) -> GetMediaCapturePipelineResponse

Gets an existing media pipeline.

Parameters:

  • media_pipeline_id (GuidString) –

    The ID of the pipeline that you want to get.

Raises:

Source code in docs_src/capo_chime_sdk_media_pipelines/_services/chime_sdk_media_pipelines.py
def get_media_capture_pipeline(
    self,
    media_pipeline_id: "capo_chime_sdk_media_pipelines.types.guid_string.GuidString",
    *,
    config_overrides: Optional[ChimeSDKMediaPipelinesClientConfig] = None,
) -> "capo_chime_sdk_media_pipelines.types.get_media_capture_pipeline_response.GetMediaCapturePipelineResponse":
    """<p>Gets an existing media pipeline.</p>

    Args:
        media_pipeline_id: <p>The ID of the pipeline that you want to get.</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.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.
    """

    def _handler(
        req: "OperationRequest[capo_chime_sdk_media_pipelines.types.get_media_capture_pipeline_request.GetMediaCapturePipelineRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_media_pipelines.types.get_media_capture_pipeline_response.GetMediaCapturePipelineResponse"
    ]:
        import capo_chime_sdk_media_pipelines._operations.chime_sdk_media_pipelines_service.get_media_capture_pipeline

        output, http_response = (
            capo_chime_sdk_media_pipelines._operations.chime_sdk_media_pipelines_service.get_media_capture_pipeline.get_media_capture_pipeline(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

        return capo_chime_sdk_media_pipelines.types.get_media_capture_pipeline_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetMediaCapturePipeline", redact_output=_redact_output),
    )
    input_: capo_chime_sdk_media_pipelines.types.get_media_capture_pipeline_request.GetMediaCapturePipelineRequest = {
        "media_pipeline_id": media_pipeline_id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output