Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . sagemaker ]

update-notebook-instance

Description

Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements. You can also update the VPC security groups.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-notebook-instance
--notebook-instance-name <value>
[--instance-type <value>]
[--role-arn <value>]
[--lifecycle-config-name <value>]
[--disassociate-lifecycle-config | --no-disassociate-lifecycle-config]
[--volume-size-in-gb <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--notebook-instance-name (string)

The name of the notebook instance to update.

--instance-type (string)

The Amazon ML compute instance type.

Possible values:

  • ml.t2.medium
  • ml.t2.large
  • ml.t2.xlarge
  • ml.t2.2xlarge
  • ml.t3.medium
  • ml.t3.large
  • ml.t3.xlarge
  • ml.t3.2xlarge
  • ml.m4.xlarge
  • ml.m4.2xlarge
  • ml.m4.4xlarge
  • ml.m4.10xlarge
  • ml.m4.16xlarge
  • ml.m5.xlarge
  • ml.m5.2xlarge
  • ml.m5.4xlarge
  • ml.m5.12xlarge
  • ml.m5.24xlarge
  • ml.c4.xlarge
  • ml.c4.2xlarge
  • ml.c4.4xlarge
  • ml.c4.8xlarge
  • ml.c5.xlarge
  • ml.c5.2xlarge
  • ml.c5.4xlarge
  • ml.c5.9xlarge
  • ml.c5.18xlarge
  • ml.c5d.xlarge
  • ml.c5d.2xlarge
  • ml.c5d.4xlarge
  • ml.c5d.9xlarge
  • ml.c5d.18xlarge
  • ml.p2.xlarge
  • ml.p2.8xlarge
  • ml.p2.16xlarge
  • ml.p3.2xlarge
  • ml.p3.8xlarge
  • ml.p3.16xlarge

--role-arn (string)

The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the notebook instance. For more information, see Amazon SageMaker Roles .

Note

To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.

--lifecycle-config-name (string)

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance .

--disassociate-lifecycle-config | --no-disassociate-lifecycle-config (boolean)

Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance.

--volume-size-in-gb (integer)

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

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

See 'aws help' for descriptions of global parameters.

Output