Skip to content

start_pipe

start_pipe(
    name: PipeName, *, config_overrides: Optional[PipesClientConfig] = None
) -> StartPipeResponse

Start an existing pipe.

Parameters:

  • name (PipeName) –

    The name of the pipe.

Raises:

Source code in docs_src/capo_pipes/_services/pipes.py
def start_pipe(
    self,
    name: "capo_pipes.types.pipe_name.PipeName",
    *,
    config_overrides: Optional[PipesClientConfig] = None,
) -> "capo_pipes.types.start_pipe_response.StartPipeResponse":
    """<p>Start an existing pipe.</p>

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

    Raises:
        capo_pipes.errors.conflict_exception.ConflictException: <p>An action you attempted resulted in an exception.</p>
        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.start_pipe_request.StartPipeRequest]",
    ) -> OperationResponse[
        "capo_pipes.types.start_pipe_response.StartPipeResponse"
    ]:
        import capo_pipes._operations.pipes.start_pipe

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartPipe")
    )
    input_: capo_pipes.types.start_pipe_request.StartPipeRequest = {"name": name}

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