Class: Aws::SageMaker::Types::UpdateNotebookInstanceInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::SageMaker::Types::UpdateNotebookInstanceInput
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-sagemaker/types.rb
Overview
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
disassociate_accelerator_types: false,
disassociate_default_code_repository: false,
disassociate_additional_code_repositories: false,
root_access: "Enabled", # accepts Enabled, Disabled
}
Instance Attribute Summary collapse
-
#accelerator_types ⇒ Array<String>
A list of the Elastic Inference (EI) instance types to associate with this notebook instance.
-
#additional_code_repositories ⇒ Array<String>
An array of up to three Git repositories to associate with the notebook instance.
-
#default_code_repository ⇒ String
The Git repository to associate with the notebook instance as its default code repository.
-
#disassociate_accelerator_types ⇒ Boolean
A list of the Elastic Inference (EI) instance types to remove from this notebook instance.
-
#disassociate_additional_code_repositories ⇒ Boolean
A list of names or URLs of the default Git repositories to remove from this notebook instance.
-
#disassociate_default_code_repository ⇒ Boolean
The name or URL of the default Git repository to remove from this notebook instance.
-
#disassociate_lifecycle_config ⇒ Boolean
Set to ‘true` to remove the notebook instance lifecycle configuration currently associated with the notebook instance.
-
#instance_type ⇒ String
The Amazon ML compute instance type.
-
#lifecycle_config_name ⇒ String
The name of a lifecycle configuration to associate with the notebook instance.
-
#notebook_instance_name ⇒ String
The name of the notebook instance to update.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the notebook instance.
-
#root_access ⇒ String
Whether root access is enabled or disabled for users of the notebook instance.
-
#volume_size_in_gb ⇒ Integer
The size, in GB, of the ML storage volume to attach to the notebook instance.
Instance Attribute Details
#accelerator_types ⇒ Array<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].
11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 11453 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_repositories ⇒ Array<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].
[1]: docs.aws.amazon.com/codecommit/latest/userguide/welcome.html [2]: docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html
11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 11453 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_repository ⇒ String
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].
[1]: docs.aws.amazon.com/codecommit/latest/userguide/welcome.html [2]: docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html
11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 11453 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_types ⇒ Boolean
A list of the Elastic Inference (EI) instance types to remove from this notebook instance.
11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 11453 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_repositories ⇒ Boolean
A list of names or URLs of the default Git repositories to remove from this notebook instance.
11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 11453 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_repository ⇒ Boolean
The name or URL of the default Git repository to remove from this notebook instance.
11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 11453 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_config ⇒ Boolean
Set to ‘true` to remove the notebook instance lifecycle configuration currently associated with the notebook instance.
11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 11453 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_type ⇒ String
The Amazon ML compute instance type.
11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 11453 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_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].
[1]: docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html
11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 11453 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_name ⇒ String
The name of the notebook instance to update.
11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 11453 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_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 markdown=“1”> To be able to pass this role to Amazon SageMaker, the caller of this API must have the ‘iam:PassRole` permission.
</note>
[1]: docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html
11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 11453 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_access ⇒ String
Whether root access is enabled or disabled for users of the notebook instance. The default value is ‘Enabled`.
<note markdown=“1”> 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.
</note>
11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 11453 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_gb ⇒ Integer
The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.
11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 11453 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 |