get-notebook-run¶

Description¶

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

Synopsis¶

  get-notebook-run
--domain-identifier <value>
--identifier <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--domain-identifier (string) [required]

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

Constraints:

pattern: dzd[-_][a-zA-Z0-9_-]{1,36}

--identifier (string) [required]

The identifier of the notebook run.

Constraints:

pattern: [a-zA-Z0-9_-]{1,36}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

id -> (string)

The identifier of the notebook run.

Constraints:

pattern: [a-zA-Z0-9_-]{1,36}

domainId -> (string)

The identifier of the Amazon DataZone domain.

Constraints:

pattern: dzd[-_][a-zA-Z0-9_-]{1,36}

owningProjectId -> (string)

The identifier of the project that owns the notebook run.

Constraints:

pattern: [a-zA-Z0-9_-]{1,36}

notebookId -> (string)

The identifier of the notebook.

Constraints:

pattern: [a-zA-Z0-9_-]{1,36}

scheduleId -> (string)

The identifier of the schedule associated with the notebook run.

Constraints:

pattern: [a-zA-Z0-9_-]{1,36}

status -> (string)

The status of the notebook run.

Possible values:

QUEUED

STARTING

RUNNING

STOPPING

STOPPED

SUCCEEDED

FAILED

cellOrder -> (list)

The ordered list of cells in the notebook run.

Constraints:

min: 0

max: 200

(structure)

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

metadata -> (map)

The metadata of the notebook run.

Constraints:

min: 0

max: 50

key -> (string)

Constraints:

min: 0

max: 128

value -> (string)

Constraints:

min: 0

max: 1024

parameters -> (map)

The sensitive parameters of the notebook run.

Constraints:

min: 0

max: 50

key -> (string)

Constraints:

min: 0

max: 128

value -> (string)

Constraints:

min: 0

max: 1024

computeConfiguration -> (structure)

The compute configuration of the notebook run.

instanceType -> (string)

The instance type for the notebook run compute.

Constraints:

pattern: (ml|sc)\.[a-z][0-9]+[a-z]*\.[a-z0-9]+

environmentVersion -> (string)

The environment version for the notebook run compute.

networkConfiguration -> (structure)

The network configuration of the notebook run.

networkAccessType -> (string) [required]

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

Possible values:

PUBLIC_INTERNET_ONLY

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.

Constraints:

min: 0

max: 10

(string)

securityGroupIds -> (list)

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

Constraints:

min: 0

max: 5

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

Constraints:

min: 60

max: 1440

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) [required]

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

Possible values:

UV

packageSpecification -> (string)

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

Constraints:

min: 0

max: 10240

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.

Constraints:

min: 1

max: 1024

pattern: s3://.+

kmsKeyArn -> (string)

The ARN of the KMS key used for encryption.

Constraints:

min: 1

max: 1024

pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}

triggerSource -> (structure)

The source that triggered the notebook run.

type -> (string)

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

Possible values:

MANUAL

SCHEDULED

WORKFLOW

name -> (string)

The name of the trigger source.

error -> (structure)

The error details if the notebook run failed.

message -> (string) [required]

The error message. The maximum length is 1024 characters.

Constraints:

min: 0

max: 1024

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.

Table of Contents

Feedback

User Guide