stopNotebookRun method

Future<StopNotebookRunOutput> stopNotebookRun({ required String domainIdentifier, required String identifier, String? clientToken, })

Stops a running notebook run in Amazon SageMaker Unified Studio.

May throw AccessDeniedException. May throw ConflictException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

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

Parameter identifier : The identifier of the notebook run to stop.

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

Implementation

Future<StopNotebookRunOutput> stopNotebookRun({
  required String domainIdentifier,
  required String identifier,
  String? clientToken,
}) async {
  final $payload = <String, dynamic>{
    'clientToken': clientToken ?? _s.generateIdempotencyToken(),
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PUT',
    requestUri:
        '/v2/domains/${Uri.encodeComponent(domainIdentifier)}/notebook-runs/${Uri.encodeComponent(identifier)}/stop',
    exceptionFnMap: _exceptionFns,
  );
  return StopNotebookRunOutput.fromJson(response);
}