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 ]

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.

See also: AWS API Documentation

Synopsis

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

--owning-project-identifier (string)

The identifier of the project that owns the notebook.

--name (string)

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

--description (string)

The description of the notebook.

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

key -> (string)

value -> (string)

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.

key -> (string)

value -> (string)

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.

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

name -> (string)

The name of the notebook.

owningProjectId -> (string)

The identifier of the project that owns the notebook.

domainId -> (string)

The identifier of the Amazon SageMaker Unified Studio domain.

cellOrder -> (list)

The ordered list of cells in the notebook.

(structure)

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

status -> (string)

The status of the notebook.

description -> (string)

The description of the notebook.

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.

metadata -> (map)

The metadata of the notebook.

key -> (string)

value -> (string)

parameters -> (map)

The sensitive parameters of the notebook.

key -> (string)

value -> (string)

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)

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.

error -> (structure)

The error details if the notebook creation failed.

message -> (string)

The error message. The maximum length is 256 characters.