AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . emr ]

describe-notebook-execution

Description

Provides details of a notebook execution.

See also: AWS API Documentation

Synopsis

  describe-notebook-execution
--notebook-execution-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--notebook-execution-id (string)

The unique identifier of the notebook execution.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

NotebookExecution -> (structure)

Properties of the notebook execution.

NotebookExecutionId -> (string)

The unique identifier of a notebook execution.

EditorId -> (string)

The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.

ExecutionEngine -> (structure)

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

Id -> (string)

The unique identifier of the execution engine. For an Amazon EMR cluster, this is the cluster ID.

Type -> (string)

The type of execution engine. A value of EMR specifies an Amazon EMR cluster.

MasterInstanceSecurityGroupId -> (string)

An optional unique ID of an Amazon EC2 security group to associate with the master instance of the Amazon EMR cluster for this notebook execution. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the EMR Management Guide .

ExecutionRoleArn -> (string)

The execution role ARN required for the notebook execution.

NotebookExecutionName -> (string)

A name for the notebook execution.

NotebookParams -> (string)

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

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.

StartTime -> (timestamp)

The timestamp when notebook execution started.

EndTime -> (timestamp)

The timestamp when notebook execution ended.

Arn -> (string)

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

OutputNotebookURI -> (string)

The location of the notebook execution's output file in Amazon S3.

LastStateChangeReason -> (string)

The reason for the latest status change of the notebook execution.

NotebookInstanceSecurityGroupId -> (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 .

Tags -> (list)

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.

(structure)

A key-value pair containing user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters .

Key -> (string)

A user-defined key, which is the minimum required information for a valid tag. For more information, see Tag .

Value -> (string)

A user-defined value, which is optional in a tag. For more information, see Tag Clusters .

NotebookS3Location -> (structure)

The Amazon S3 location that stores the notebook execution input.

Bucket -> (string)

The Amazon S3 bucket that stores the notebook execution input.

Key -> (string)

The key to the Amazon S3 location that stores the notebook execution input.

OutputNotebookS3Location -> (structure)

The Amazon S3 location for the notebook execution output.

Bucket -> (string)

The Amazon S3 bucket that stores the notebook execution output.

Key -> (string)

The key to the Amazon S3 location that stores the notebook execution output.

OutputNotebookFormat -> (string)

The output format for the notebook execution.

EnvironmentVariables -> (map)

The environment variables associated with the notebook execution.

key -> (string)

value -> (string)