stop_notebook_run `async` ¶

stop_notebook_run(
    domain_identifier: DomainId,
    identifier: NotebookRunId,
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> StopNotebookRunOutput

Stops a running notebook run in Amazon SageMaker Unified Studio.

Parameters:

domain_identifier (DomainId) –

The identifier of the Amazon SageMaker Unified Studio domain in which the notebook run is stopped.
identifier (NotebookRunId) –

The identifier of the notebook run to stop.
client_token (Optional[ClientToken], default: None ) –

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ThrottlingException –

The request was denied due to request throttling.
UnauthorizedException –

You do not have permission to perform this action.
ConflictException –

There is a conflict while performing this action.
InternalServerException –

The request has failed because of an unknown error, exception or failure.
ResourceNotFoundException –

The specified resource cannot be found.
ValidationException –

The input fails to satisfy the constraints specified by the Amazon Web Services service.
UnknownServiceError –

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

Source code in docs_src/capo_datazone/_services/async_data_zone.py

async def stop_notebook_run(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    identifier: "capo_datazone.types.notebook_run_id.NotebookRunId",
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
    client_token: Optional["capo_datazone.types.client_token.ClientToken"] = None,
) -> "capo_datazone.types.stop_notebook_run_output.StopNotebookRunOutput":
    """<p>Stops a running <a href="https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/notebooks.html">notebook run</a> in Amazon SageMaker Unified Studio.</p>

    Args:
        domain_identifier: <p>The identifier of the Amazon SageMaker Unified Studio domain in which the notebook run is stopped.</p>
        identifier: <p>The identifier of the notebook run to stop.</p>
        client_token: <p>A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</p>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.conflict_exception.ConflictException: <p>There is a conflict while performing this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource cannot be found.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_datazone.types.stop_notebook_run_input.StopNotebookRunInput]",
    ) -> AsyncOperationResponse[
        "capo_datazone.types.stop_notebook_run_output.StopNotebookRunOutput"
    ]:
        import capo_datazone._operations.data_zone.stop_notebook_run

        (
            output,
            http_response,
        ) = await capo_datazone._operations.data_zone.stop_notebook_run.async_stop_notebook_run(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopNotebookRun")
    )
    input_: capo_datazone.types.stop_notebook_run_input.StopNotebookRunInput = {
        "domain_identifier": domain_identifier,
        "identifier": identifier,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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

stop_notebook_run async ¶

stop_notebook_run `async` ¶