create-notebook¶

Description¶

Creates a notebook in Amazon SageMaker Unified Studio. A notebook is a collaborative document within a project that contains code cells for interactive computing.

Synopsis¶

  create-notebook
--domain-identifier <value>
--owning-project-identifier <value>
--name <value>
[--description <value>]
[--metadata <value>]
[--parameters <value>]
[--client-token <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 SageMaker Unified Studio domain in which to create the notebook.

Constraints:

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

--owning-project-identifier (string) [required]

The identifier of the project that owns the notebook.

Constraints:

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

--name (string) [required]

The name of the notebook. The name must be between 1 and 256 characters.

Constraints:

min: 1

max: 256

--description (string)

The description of the notebook.

Constraints:

min: 0

max: 2048

--metadata (map)

The metadata for the notebook, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

Constraints:

min: 0

max: 50

key -> (string)

Constraints:

min: 0

max: 128

value -> (string)

Constraints:

min: 0

max: 1024

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--parameters (map)

The sensitive parameters for the notebook, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

Constraints:

min: 0

max: 50

key -> (string)

Constraints:

min: 0

max: 128

value -> (string)

Constraints:

min: 0

max: 1024

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-token (string)

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

Constraints:

min: 1

max: 128

pattern: [\x21-\x7E]+

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

Constraints:

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

name -> (string)

The name of the notebook.

Constraints:

min: 1

max: 256

owningProjectId -> (string)

The identifier of the project that owns the notebook.

Constraints:

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

domainId -> (string)

The identifier of the Amazon SageMaker Unified Studio domain.

Constraints:

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

cellOrder -> (list)

The ordered list of cells in the notebook.

Constraints:

min: 0

max: 200

(structure)

The information about a cell in a notebook run in Amazon SageMaker Unified Studio.

status -> (string)

The status of the notebook.

Possible values:

ACTIVE

ARCHIVED

description -> (string)

The description of the notebook.

Constraints:

min: 0

max: 2048

createdAt -> (timestamp)

The timestamp of when the notebook was created.

createdBy -> (string)

The identifier of the user who created the notebook.

updatedAt -> (timestamp)

The timestamp of when the notebook was last updated.

updatedBy -> (string)

The identifier of the user who last updated the notebook.

lockedBy -> (string)

The identifier of the user who locked the notebook.

lockedAt -> (timestamp)

The timestamp of when the notebook was locked.

lockExpiresAt -> (timestamp)

The timestamp of when the notebook lock expires.

computeId -> (string)

The identifier of the compute associated with the notebook.

Constraints:

min: 0

max: 64

metadata -> (map)

The metadata of the notebook.

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.

Constraints:

min: 0

max: 50

key -> (string)

Constraints:

min: 0

max: 128

value -> (string)

Constraints:

min: 0

max: 1024

environmentConfiguration -> (structure)

The environment configuration of the notebook.

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

error -> (structure)

The error details if the notebook creation failed.

message -> (string) [required]

The error message. The maximum length is 256 characters.

Constraints:

min: 0

max: 256

Table of Contents

Feedback

User Guide