Skip to content

read_pipeline

read_pipeline(
    id: Id, *, config_overrides: Optional[ElasticTranscoderClientConfig] = None
) -> ReadPipelineResponse

The ReadPipeline operation gets detailed information about a pipeline.

Parameters:

  • id (Id) –

    The identifier of the pipeline to read.

Raises:

  • AccessDeniedException –

    General authentication failure. The request was not signed correctly.

  • InternalServiceException –

    Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

  • ResourceNotFoundException –

    The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

  • ValidationException –

    One or more required parameter values were not provided in the request.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_elastic_transcoder/_services/elastic_transcoder.py
def read_pipeline(
    self,
    id: "capo_elastic_transcoder.types.id.Id",
    *,
    config_overrides: Optional[ElasticTranscoderClientConfig] = None,
) -> "capo_elastic_transcoder.types.read_pipeline_response.ReadPipelineResponse":
    """<p>The ReadPipeline operation gets detailed information about a pipeline.</p>

    Args:
        id: <p>The identifier of the pipeline to read.</p>

    Raises:
        capo_elastic_transcoder.errors.access_denied_exception.AccessDeniedException: <p>General authentication failure. The request was not signed correctly.</p>
        capo_elastic_transcoder.errors.incompatible_version_exception.IncompatibleVersionException
        capo_elastic_transcoder.errors.internal_service_exception.InternalServiceException: <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>
        capo_elastic_transcoder.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.</p>
        capo_elastic_transcoder.errors.validation_exception.ValidationException: <p>One or more required parameter values were not provided in the request.</p>
        capo_elastic_transcoder.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_elastic_transcoder.types.read_pipeline_request.ReadPipelineRequest]",
    ) -> OperationResponse[
        "capo_elastic_transcoder.types.read_pipeline_response.ReadPipelineResponse"
    ]:
        import capo_elastic_transcoder._operations.ets_customer_service.read_pipeline

        output, http_response = (
            capo_elastic_transcoder._operations.ets_customer_service.read_pipeline.read_pipeline(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ReadPipeline")
    )
    input_: capo_elastic_transcoder.types.read_pipeline_request.ReadPipelineRequest = {
        "id": id
    }

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