View a markdown version of this page

AWS::EMR::NotebookExecution - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::EMR::NotebookExecution

A notebook execution. An execution is a specific instance that an Amazon EMR Notebook is run using the StartNotebookExecution action.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::EMR::NotebookExecution",
  "Properties" : {
      "EnvironmentVariables" : {Key: Value, ...},
      "ExecutionEngine" : ExecutionEngineConfig,
      "NotebookExecutionName" : String,
      "NotebookParams" : String,
      "NotebookS3Location" : NotebookS3Location,
      "OutputNotebookFormat" : String,
      "OutputNotebookS3Location" : OutputNotebookS3Location,
      "Tags" : [ Tag, ... ]
    }
}

Properties

EnvironmentVariables

The environment variables associated with the notebook execution.

Required: No

Type: Object of String

Pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]{0,256}$

Maximum: 10280

Update requires: Replacement

ExecutionEngine

The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.

Required: No

Type: ExecutionEngineConfig

Update requires: Replacement

NotebookExecutionName

A name for the notebook execution.

Required: No

Type: String

Maximum: 256

Update requires: Replacement

NotebookParams

Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.

Required: No

Type: String

Maximum: 10280

Update requires: Replacement

NotebookS3Location

The Amazon S3 location that stores the notebook execution input.

Required: No

Type: NotebookS3Location

Update requires: Replacement

OutputNotebookFormat

The output format for the notebook execution.

Required: No

Type: String

Allowed values: HTML

Update requires: Replacement

OutputNotebookS3Location

The Amazon S3 location for the notebook execution output.

Required: No

Type: OutputNotebookS3Location

Update requires: Replacement

Tags

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.

Required: No

Type: Array of Tag

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the notebook execution.

NotebookExecutionId

The unique identifier of a notebook execution.

StartTime

The timestamp when notebook execution started.

Status

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.