notebook_executions

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

Overview

Name	notebook_executions
Type	Resource
Id	aws.emr.notebook_executions

Fields

The following fields are returned by SELECT queries:

describe_notebook_execution

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the notebook execution. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
editor_id	string	The unique identifier of the Amazon EMR Notebook that is used for the notebook execution. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
end_time	string (date-time)	The timestamp when notebook execution ended.
environment_variables	object	The environment variables associated with the notebook execution.
execution_engine	object	The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.
last_state_change_reason	string	The reason for the latest status change of the notebook execution. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
notebook_execution_id	string	The unique identifier of a notebook execution. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
notebook_execution_name	string	A name for the notebook execution. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
notebook_instance_security_group_id	string	The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
notebook_params	string	Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
notebook_s3_location	object	The Amazon S3 location that stores the notebook execution input.
output_notebook_format	string	The output format for the notebook execution. (HTML)
output_notebook_s3_location	object	The Amazon S3 location for the notebook execution output.
output_notebook_uri	string	The location of the notebook execution's output file in Amazon S3. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
start_time	string (date-time)	The timestamp when notebook execution started.
status	string	The status of the notebook execution. START_PENDING indicates that the cluster has received the execution request but execution has not begun. STARTING indicates that the execution is starting on the cluster. RUNNING indicates that the execution is being processed by the cluster. FINISHING indicates that execution processing is in the final stages. FINISHED indicates that the execution has completed without error. FAILING indicates that the execution is failing and will not finish successfully. FAILED indicates that the execution failed. STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending. STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request. STOPPED indicates that the execution stopped because of a StopNotebookExecution request. (START_PENDING, STARTING, RUNNING, FINISHING, FINISHED, FAILING, FAILED, STOP_PENDING, STOPPING, STOPPED)
tags	array	A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.

list_notebook_executions

Name	Datatype	Description
editor_id	string	The unique identifier of the editor associated with the notebook execution. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
end_time	string (date-time)	The timestamp when notebook execution started.
execution_engine_id	string	The unique ID of the execution engine for the notebook execution. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
notebook_execution_id	string	The unique identifier of the notebook execution. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
notebook_execution_name	string	The name of the notebook execution. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
notebook_s3_location	object	The Amazon S3 location that stores the notebook execution input.
start_time	string (date-time)	The timestamp when notebook execution started.
status	string	The status of the notebook execution. START_PENDING indicates that the cluster has received the execution request but execution has not begun. STARTING indicates that the execution is starting on the cluster. RUNNING indicates that the execution is being processed by the cluster. FINISHING indicates that execution processing is in the final stages. FINISHED indicates that the execution has completed without error. FAILING indicates that the execution is failing and will not finish successfully. FAILED indicates that the execution failed. STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending. STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request. STOPPED indicates that the execution stopped because of a StopNotebookExecution request. (START_PENDING, STARTING, RUNNING, FINISHING, FINISHED, FAILING, FAILED, STOP_PENDING, STOPPING, STOPPED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_notebook_execution	select	region		Provides details of a notebook execution.
list_notebook_executions	select	region		Provides summaries of all notebook executions. You can filter the list based on multiple criteria such as status, time range, and editor id. Returns a maximum of 50 notebook executions and a marker to track the paging of a longer notebook execution list across multiple ListNotebookExecutions calls.

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_notebook_execution

Provides details of a notebook execution.

SELECT
arn,
editor_id,
end_time,
environment_variables,
execution_engine,
last_state_change_reason,
notebook_execution_id,
notebook_execution_name,
notebook_instance_security_group_id,
notebook_params,
notebook_s3_location,
output_notebook_format,
output_notebook_s3_location,
output_notebook_uri,
start_time,
status,
tags
FROM aws.emr.notebook_executions
WHERE region = '{{ region }}' -- required
;

list_notebook_executions

Provides summaries of all notebook executions. You can filter the list based on multiple criteria such as status, time range, and editor id. Returns a maximum of 50 notebook executions and a marker to track the paging of a longer notebook execution list across multiple ListNotebookExecutions calls.

SELECT
editor_id,
end_time,
execution_engine_id,
notebook_execution_id,
notebook_execution_name,
notebook_s3_location,
start_time,
status
FROM aws.emr.notebook_executions
WHERE region = '{{ region }}' -- required
;