You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SageMaker::Types::UpdateNotebookInstanceInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass UpdateNotebookInstanceInput data as a hash:

{
  notebook_instance_name: "NotebookInstanceName", # required
  instance_type: "ml.t2.medium", # accepts 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: "RoleArn",
  lifecycle_config_name: "NotebookInstanceLifecycleConfigName",
  disassociate_lifecycle_config: false,
  volume_size_in_gb: 1,
  default_code_repository: "CodeRepositoryNameOrUrl",
  additional_code_repositories: ["CodeRepositoryNameOrUrl"],
  accelerator_types: ["ml.eia1.medium"], # accepts ml.eia1.medium, ml.eia1.large, ml.eia1.xlarge, ml.eia2.medium, ml.eia2.large, ml.eia2.xlarge
  disassociate_accelerator_types: false,
  disassociate_default_code_repository: false,
  disassociate_additional_code_repositories: false,
  root_access: "Enabled", # accepts Enabled, Disabled
}

Instance Attribute Summary collapse

Instance Attribute Details

#accelerator_typesArray<String>

A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

Returns:

  • (Array<String>)


12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 12279

class UpdateNotebookInstanceInput < Struct.new(
  :notebook_instance_name,
  :instance_type,
  :role_arn,
  :lifecycle_config_name,
  :disassociate_lifecycle_config,
  :volume_size_in_gb,
  :default_code_repository,
  :additional_code_repositories,
  :accelerator_types,
  :disassociate_accelerator_types,
  :disassociate_default_code_repository,
  :disassociate_additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#additional_code_repositoriesArray<String>

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

Returns:

  • (Array<String>)


12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 12279

class UpdateNotebookInstanceInput < Struct.new(
  :notebook_instance_name,
  :instance_type,
  :role_arn,
  :lifecycle_config_name,
  :disassociate_lifecycle_config,
  :volume_size_in_gb,
  :default_code_repository,
  :additional_code_repositories,
  :accelerator_types,
  :disassociate_accelerator_types,
  :disassociate_default_code_repository,
  :disassociate_additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#default_code_repositoryString

The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

Returns:

  • (String)


12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 12279

class UpdateNotebookInstanceInput < Struct.new(
  :notebook_instance_name,
  :instance_type,
  :role_arn,
  :lifecycle_config_name,
  :disassociate_lifecycle_config,
  :volume_size_in_gb,
  :default_code_repository,
  :additional_code_repositories,
  :accelerator_types,
  :disassociate_accelerator_types,
  :disassociate_default_code_repository,
  :disassociate_additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#disassociate_accelerator_typesBoolean

A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.

Returns:

  • (Boolean)


12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 12279

class UpdateNotebookInstanceInput < Struct.new(
  :notebook_instance_name,
  :instance_type,
  :role_arn,
  :lifecycle_config_name,
  :disassociate_lifecycle_config,
  :volume_size_in_gb,
  :default_code_repository,
  :additional_code_repositories,
  :accelerator_types,
  :disassociate_accelerator_types,
  :disassociate_default_code_repository,
  :disassociate_additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#disassociate_additional_code_repositoriesBoolean

A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

Returns:

  • (Boolean)


12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 12279

class UpdateNotebookInstanceInput < Struct.new(
  :notebook_instance_name,
  :instance_type,
  :role_arn,
  :lifecycle_config_name,
  :disassociate_lifecycle_config,
  :volume_size_in_gb,
  :default_code_repository,
  :additional_code_repositories,
  :accelerator_types,
  :disassociate_accelerator_types,
  :disassociate_default_code_repository,
  :disassociate_additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#disassociate_default_code_repositoryBoolean

The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

Returns:

  • (Boolean)


12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 12279

class UpdateNotebookInstanceInput < Struct.new(
  :notebook_instance_name,
  :instance_type,
  :role_arn,
  :lifecycle_config_name,
  :disassociate_lifecycle_config,
  :volume_size_in_gb,
  :default_code_repository,
  :additional_code_repositories,
  :accelerator_types,
  :disassociate_accelerator_types,
  :disassociate_default_code_repository,
  :disassociate_additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#disassociate_lifecycle_configBoolean

Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.

Returns:

  • (Boolean)


12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 12279

class UpdateNotebookInstanceInput < Struct.new(
  :notebook_instance_name,
  :instance_type,
  :role_arn,
  :lifecycle_config_name,
  :disassociate_lifecycle_config,
  :volume_size_in_gb,
  :default_code_repository,
  :additional_code_repositories,
  :accelerator_types,
  :disassociate_accelerator_types,
  :disassociate_default_code_repository,
  :disassociate_additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#instance_typeString

The Amazon ML compute instance type.

Returns:

  • (String)


12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 12279

class UpdateNotebookInstanceInput < Struct.new(
  :notebook_instance_name,
  :instance_type,
  :role_arn,
  :lifecycle_config_name,
  :disassociate_lifecycle_config,
  :volume_size_in_gb,
  :default_code_repository,
  :additional_code_repositories,
  :accelerator_types,
  :disassociate_accelerator_types,
  :disassociate_default_code_repository,
  :disassociate_additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#lifecycle_config_nameString

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.

Returns:

  • (String)


12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 12279

class UpdateNotebookInstanceInput < Struct.new(
  :notebook_instance_name,
  :instance_type,
  :role_arn,
  :lifecycle_config_name,
  :disassociate_lifecycle_config,
  :volume_size_in_gb,
  :default_code_repository,
  :additional_code_repositories,
  :accelerator_types,
  :disassociate_accelerator_types,
  :disassociate_default_code_repository,
  :disassociate_additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#notebook_instance_nameString

The name of the notebook instance to update.

Returns:

  • (String)


12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 12279

class UpdateNotebookInstanceInput < Struct.new(
  :notebook_instance_name,
  :instance_type,
  :role_arn,
  :lifecycle_config_name,
  :disassociate_lifecycle_config,
  :volume_size_in_gb,
  :default_code_repository,
  :additional_code_repositories,
  :accelerator_types,
  :disassociate_accelerator_types,
  :disassociate_default_code_repository,
  :disassociate_additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#role_arnString

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.

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

Returns:

  • (String)


12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 12279

class UpdateNotebookInstanceInput < Struct.new(
  :notebook_instance_name,
  :instance_type,
  :role_arn,
  :lifecycle_config_name,
  :disassociate_lifecycle_config,
  :volume_size_in_gb,
  :default_code_repository,
  :additional_code_repositories,
  :accelerator_types,
  :disassociate_accelerator_types,
  :disassociate_default_code_repository,
  :disassociate_additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#root_accessString

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.

Returns:

  • (String)


12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 12279

class UpdateNotebookInstanceInput < Struct.new(
  :notebook_instance_name,
  :instance_type,
  :role_arn,
  :lifecycle_config_name,
  :disassociate_lifecycle_config,
  :volume_size_in_gb,
  :default_code_repository,
  :additional_code_repositories,
  :accelerator_types,
  :disassociate_accelerator_types,
  :disassociate_default_code_repository,
  :disassociate_additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#volume_size_in_gbInteger

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so Amazon SageMaker can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.

Returns:

  • (Integer)


12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 12279

class UpdateNotebookInstanceInput < Struct.new(
  :notebook_instance_name,
  :instance_type,
  :role_arn,
  :lifecycle_config_name,
  :disassociate_lifecycle_config,
  :volume_size_in_gb,
  :default_code_repository,
  :additional_code_repositories,
  :accelerator_types,
  :disassociate_accelerator_types,
  :disassociate_default_code_repository,
  :disassociate_additional_code_repositories,
  :root_access)
  include Aws::Structure
end