notebook_runs

Creates, updates, deletes, gets or lists a notebook_runs resource.

Overview

Name	notebook_runs
Type	Resource
Id	aws.datazone.notebook_runs

Fields

The following fields are returned by SELECT queries:

get_notebook_run

Name	Datatype	Description
id	string	The identifier of the notebook run. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
cell_order	array	The ordered list of cells in the notebook run.
completed_at	string (date-time)	The timestamp of when the notebook run completed.
compute_configuration	object	The compute configuration of the notebook run.
created_at	string (date-time)	The timestamp of when the notebook run was created.
created_by	string	The identifier of the user who created the notebook run.
domain_id	string	The identifier of the Amazon SageMaker Unified Studio domain. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
environment_configuration	object	The environment configuration for a notebook run in Amazon SageMaker Unified Studio.
error	object	The error details if the notebook run failed.
metadata	object	The metadata of the notebook run.
network_configuration	object	The network configuration of the notebook run.
notebook_id	string	The identifier of the notebook. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
owning_project_id	string	The identifier of the project that owns the notebook run. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
parameters	object	The sensitive parameters of the notebook run.
schedule_id	string	The identifier of the schedule associated with the notebook run. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
started_at	string (date-time)	The timestamp of when the notebook run started executing.
status	string	The status of the notebook run. (QUEUED, STARTING, RUNNING, STOPPING, STOPPED, SUCCEEDED, FAILED)
storage_configuration	object	The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.
timeout_configuration	object	The timeout configuration of the notebook run.
trigger_source	object	The source that triggered the notebook run.
updated_at	string (date-time)	The timestamp of when the notebook run was last updated.
updated_by	string	The identifier of the user who last updated the notebook run.

list_notebook_runs

Name	Datatype	Description
id	string	The identifier of the notebook run. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
completed_at	string (date-time)	The timestamp of when the notebook run completed.
created_at	string (date-time)	The timestamp of when the notebook run was created.
created_by	string	The identifier of the user who created the notebook run.
domain_id	string	The identifier of the Amazon SageMaker Unified Studio domain. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
notebook_id	string	The identifier of the notebook. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
owning_project_id	string	The identifier of the project that owns the notebook run. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
schedule_id	string	The identifier of the schedule associated with the notebook run. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
started_at	string (date-time)	The timestamp of when the notebook run started executing.
status	string	The status of a notebook run in Amazon SageMaker Unified Studio. (QUEUED, STARTING, RUNNING, STOPPING, STOPPED, SUCCEEDED, FAILED)
trigger_source	object	The source that triggered the notebook run.
updated_at	string (date-time)	The timestamp of when the notebook run was last updated.
updated_by	string	The identifier of the user who last updated the notebook run.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_notebook_run	select	domain_identifier, identifier, region		Gets the details of a notebook run in Amazon SageMaker Unified Studio.
list_notebook_runs	select	domain_identifier, owningProjectIdentifier, region	notebookIdentifier, status, scheduleIdentifier, maxResults, sortOrder, nextToken	Lists notebook runs in Amazon SageMaker Unified Studio.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_identifier	string	The identifier of the Amazon SageMaker Unified Studio domain in which to list notebook runs.
identifier	string	The identifier of the notebook run.
owningProjectIdentifier	string	The identifier of the project that owns the notebook runs.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of notebook runs to return in a single call. When the number of notebook runs exceeds the value of MaxResults, the response contains a NextToken value.
nextToken	string	When the number of notebook runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notebook runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebookRuns to list the next set of notebook runs.
notebookIdentifier	string	The identifier of the notebook to filter runs by.
scheduleIdentifier	string	The identifier of the schedule to filter notebook runs by.
sortOrder	string	The sort order for the results.
status	string	The status to filter notebook runs by.

SELECT examples

get_notebook_run

Gets the details of a notebook run in Amazon SageMaker Unified Studio.

SELECT
id,
cell_order,
completed_at,
compute_configuration,
created_at,
created_by,
domain_id,
environment_configuration,
error,
metadata,
network_configuration,
notebook_id,
owning_project_id,
parameters,
schedule_id,
started_at,
status,
storage_configuration,
timeout_configuration,
trigger_source,
updated_at,
updated_by
FROM aws.datazone.notebook_runs
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_notebook_runs

Lists notebook runs in Amazon SageMaker Unified Studio.

SELECT
id,
completed_at,
created_at,
created_by,
domain_id,
notebook_id,
owning_project_id,
schedule_id,
started_at,
status,
trigger_source,
updated_at,
updated_by
FROM aws.datazone.notebook_runs
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND owningProjectIdentifier = '{{ owningProjectIdentifier }}' -- required
AND region = '{{ region }}' -- required
AND notebookIdentifier = '{{ notebookIdentifier }}'
AND status = '{{ status }}'
AND scheduleIdentifier = '{{ scheduleIdentifier }}'
AND maxResults = '{{ maxResults }}'
AND sortOrder = '{{ sortOrder }}'
AND nextToken = '{{ nextToken }}'
;