DataZone / Client / stop_notebook_run

stop_notebook_run

DataZone.Client.stop_notebook_run(**kwargs)

Stops a running notebook run in Amazon SageMaker Unified Studio.

See also: AWS API Documentation

Request Syntax

response = client.stop_notebook_run(
    domainIdentifier='string',
    identifier='string',
    clientToken='string'
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

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

• identifier (string) –

  [REQUIRED]

  The identifier of the notebook run to stop.

• clientToken (string) –

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

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'domainId': 'string',
    'owningProjectId': 'string',
    'status': 'QUEUED'|'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'
}

Response Structure

• (dict) –

  • id (string) –

    The identifier of the notebook run.

  • domainId (string) –

    The identifier of the Amazon SageMaker Unified Studio domain.

  • owningProjectId (string) –

    The identifier of the project that owns the notebook run.

  • status (string) –

    The status of the notebook run.

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.ResourceNotFoundException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ConflictException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException