AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . datazone ]

get-notebook-run

Description

Gets the details of a notebook run in an Amazon DataZone domain.

See also: AWS API Documentation

Synopsis

  get-notebook-run
--domain-identifier <value>
--identifier <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>]
[--v2-debug]

Options

--domain-identifier (string)

The identifier of the Amazon DataZone domain in which the notebook run exists.

--identifier (string)

The identifier of the notebook run.

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

id -> (string)

The identifier of the notebook run.

domainId -> (string)

The identifier of the Amazon DataZone domain.

owningProjectId -> (string)

The identifier of the project that owns the notebook run.

notebookId -> (string)

The identifier of the notebook.

scheduleId -> (string)

The identifier of the schedule associated with the notebook run.

status -> (string)

The status of the notebook run.

cellOrder -> (list)

The ordered list of cells in the notebook run.

(structure)

The information about a cell in a notebook run in Amazon DataZone.

metadata -> (map)

The metadata of the notebook run.

key -> (string)

value -> (string)

parameters -> (map)

The sensitive parameters of the notebook run.

key -> (string)

value -> (string)

computeConfiguration -> (structure)

The compute configuration of the notebook run.

instanceType -> (string)

The instance type for the notebook run compute.

environmentVersion -> (string)

The environment version for the notebook run compute.

networkConfiguration -> (structure)

The network configuration of the notebook run.

networkAccessType -> (string)

The network access type for the notebook run. Valid values are PUBLIC_INTERNET_ONLY and VPC_ONLY .

vpcId -> (string)

The identifier of the VPC for the notebook run. This is required when the network access type is VPC_ONLY .

subnetIds -> (list)

The identifiers of the subnets for the notebook run. You can specify up to 10 subnets.

(string)

securityGroupIds -> (list)

The identifiers of the security groups for the notebook run. You can specify up to 5 security groups.

(string)

timeoutConfiguration -> (structure)

The timeout configuration of the notebook run.

runTimeoutInMinutes -> (integer)

The timeout for the notebook run, in minutes. The minimum value is 60 minutes (1 hour), the maximum value is 1440 minutes (24 hours), and the default value is 720 minutes (12 hours).

environmentConfiguration -> (structure)

The environment configuration of the notebook run, including image version and package settings.

imageVersion -> (string)

The image version for the notebook run environment.

packageConfig -> (structure)

The package configuration for the notebook run environment.

packageManager -> (string)

The package manager for the notebook run environment. The default value is UV .

packageSpecification -> (string)

The package specification content for the notebook run environment. The maximum length is 10240 characters.

storageConfiguration -> (structure)

The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.

projectS3Path -> (string)

The Amazon Simple Storage Service path for the project storage.

kmsKeyArn -> (string)

The ARN of the KMS key used for encryption.

triggerSource -> (structure)

The source that triggered the notebook run.

type -> (string)

The type of the trigger source. Valid values are MANUAL , SCHEDULED , and WORKFLOW .

name -> (string)

The name of the trigger source.

error -> (structure)

The error details if the notebook run failed.

message -> (string)

The error message. The maximum length is 1024 characters.

createdAt -> (timestamp)

The timestamp of when the notebook run was created.

createdBy -> (string)

The identifier of the user who created the notebook run.

updatedAt -> (timestamp)

The timestamp of when the notebook run was last updated.

updatedBy -> (string)

The identifier of the user who last updated the notebook run.

startedAt -> (timestamp)

The timestamp of when the notebook run started executing.

completedAt -> (timestamp)

The timestamp of when the notebook run completed.