stop_pipe async ¶

async def stop_pipe(
    self,
    name: "capo_pipes.types.pipe_name.PipeName",
    *,
    config_overrides: Optional[AsyncPipesClientConfig] = None,
) -> "capo_pipes.types.stop_pipe_response.StopPipeResponse":
    """<p>Stop 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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_pipes.types.stop_pipe_request.StopPipeRequest]",
    ) -> AsyncOperationResponse[
        "capo_pipes.types.stop_pipe_response.StopPipeResponse"
    ]:
        import capo_pipes._operations.pipes.stop_pipe

        (
            output,
            http_response,
        ) = await capo_pipes._operations.pipes.stop_pipe.async_stop_pipe(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopPipe")
    )
    input_: capo_pipes.types.stop_pipe_request.StopPipeRequest = {"name": name}

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