notebook_exports

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

Overview

Name	notebook_exports
Type	Resource
Id	aws.datazone.notebook_exports

Fields

The following fields are returned by SELECT queries:

get_notebook_export

Name	Datatype	Description
id	string	The identifier of the notebook export. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
completed_at	string (date-time)	The timestamp of when the notebook export completed.
created_at	string (date-time)	The timestamp of when the notebook export was started.
created_by	string	The identifier of the user who started the notebook export.
domain_id	string	The identifier of the Amazon SageMaker Unified Studio domain. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
error	object	The error details if the notebook export failed.
file_format	string	The file format of the notebook export. (PDF, IPYNB)
notebook_id	string	The identifier of the notebook. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
output_location	object	The output location of the exported notebook in Amazon Simple Storage Service.
owning_project_id	string	The identifier of the project that owns the notebook. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
status	string	The status of the notebook export. (IN_PROGRESS, SUCCEEDED, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_notebook_export	select	domain_identifier, identifier, region		Gets the details of a notebook export 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 the notebook export exists.
identifier	string	The identifier of the notebook export.
region	string	AWS region (default: us-east-1)

SELECT examples

get_notebook_export

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

SELECT
id,
completed_at,
created_at,
created_by,
domain_id,
error,
file_format,
notebook_id,
output_location,
owning_project_id,
status
FROM aws.datazone.notebook_exports
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;