describe_pipe ¶

def describe_pipe(
    self,
    name: "capo_pipes.types.pipe_name.PipeName",
    *,
    config_overrides: Optional[PipesClientConfig] = None,
) -> "capo_pipes.types.describe_pipe_response.DescribePipeResponse":
    """<p>Get the information about an existing pipe. For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html">Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.</p>

    Args:
        name: <p>The name of the pipe.</p>

    Raises:
        capo_pipes.errors.internal_exception.InternalException: <p>This exception occurs due to unexpected causes.</p>
        capo_pipes.errors.not_found_exception.NotFoundException: <p>An entity that you specified does not exist.</p>
        capo_pipes.errors.throttling_exception.ThrottlingException: <p>An action was throttled.</p>
        capo_pipes.errors.validation_exception.ValidationException: <p>Indicates that an error has occurred while performing a validate operation.</p>
        capo_pipes.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pipes.types.describe_pipe_request.DescribePipeRequest]",
    ) -> OperationResponse[
        "capo_pipes.types.describe_pipe_response.DescribePipeResponse"
    ]:
        import capo_pipes._operations.pipes.describe_pipe

        output, http_response = (
            capo_pipes._operations.pipes.describe_pipe.describe_pipe(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_pipes.types.describe_pipe_response.DescribePipeResponse",
    ) -> dict[str, Any]:
        import capo_pipes.types.describe_pipe_response

        return capo_pipes.types.describe_pipe_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribePipe", redact_output=_redact_output),
    )
    input_: capo_pipes.types.describe_pipe_request.DescribePipeRequest = {
        "name": name
    }

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