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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accelerator_typesArray<String>

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify a list of the EI instance types to associate with this notebook instance.

Returns:

  • (Array<String>)


46432
46433
46434
46435
46436
46437
46438
46439
46440
46441
46442
46443
46444
46445
46446
46447
46448
46449
# File 'lib/aws-sdk-sagemaker/types.rb', line 46432

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,
  :instance_metadata_service_configuration)
  SENSITIVE = []
  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 [Amazon Web Services 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 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

Returns:

  • (Array<String>)


46432
46433
46434
46435
46436
46437
46438
46439
46440
46441
46442
46443
46444
46445
46446
46447
46448
46449
# File 'lib/aws-sdk-sagemaker/types.rb', line 46432

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,
  :instance_metadata_service_configuration)
  SENSITIVE = []
  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 [Amazon Web Services 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 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

Returns:

  • (String)


46432
46433
46434
46435
46436
46437
46438
46439
46440
46441
46442
46443
46444
46445
46446
46447
46448
46449
# File 'lib/aws-sdk-sagemaker/types.rb', line 46432

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,
  :instance_metadata_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#disassociate_accelerator_typesBoolean

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify a list of the EI instance types to remove from this notebook instance.

Returns:

  • (Boolean)


46432
46433
46434
46435
46436
46437
46438
46439
46440
46441
46442
46443
46444
46445
46446
46447
46448
46449
# File 'lib/aws-sdk-sagemaker/types.rb', line 46432

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,
  :instance_metadata_service_configuration)
  SENSITIVE = []
  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)


46432
46433
46434
46435
46436
46437
46438
46439
46440
46441
46442
46443
46444
46445
46446
46447
46448
46449
# File 'lib/aws-sdk-sagemaker/types.rb', line 46432

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,
  :instance_metadata_service_configuration)
  SENSITIVE = []
  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)


46432
46433
46434
46435
46436
46437
46438
46439
46440
46441
46442
46443
46444
46445
46446
46447
46448
46449
# File 'lib/aws-sdk-sagemaker/types.rb', line 46432

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,
  :instance_metadata_service_configuration)
  SENSITIVE = []
  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)


46432
46433
46434
46435
46436
46437
46438
46439
46440
46441
46442
46443
46444
46445
46446
46447
46448
46449
# File 'lib/aws-sdk-sagemaker/types.rb', line 46432

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,
  :instance_metadata_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#instance_metadata_service_configurationTypes::InstanceMetadataServiceConfiguration

Information on the IMDS configuration of the notebook instance



46432
46433
46434
46435
46436
46437
46438
46439
46440
46441
46442
46443
46444
46445
46446
46447
46448
46449
# File 'lib/aws-sdk-sagemaker/types.rb', line 46432

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,
  :instance_metadata_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typeString

The Amazon ML compute instance type.

Returns:

  • (String)


46432
46433
46434
46435
46436
46437
46438
46439
46440
46441
46442
46443
46444
46445
46446
46447
46448
46449
# File 'lib/aws-sdk-sagemaker/types.rb', line 46432

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,
  :instance_metadata_service_configuration)
  SENSITIVE = []
  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].

[1]: docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html

Returns:

  • (String)


46432
46433
46434
46435
46436
46437
46438
46439
46440
46441
46442
46443
46444
46445
46446
46447
46448
46449
# File 'lib/aws-sdk-sagemaker/types.rb', line 46432

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,
  :instance_metadata_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#notebook_instance_nameString

The name of the notebook instance to update.

Returns:

  • (String)


46432
46433
46434
46435
46436
46437
46438
46439
46440
46441
46442
46443
46444
46445
46446
46447
46448
46449
# File 'lib/aws-sdk-sagemaker/types.rb', line 46432

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,
  :instance_metadata_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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

<note markdown=“1”> To be able to pass this role to SageMaker, the caller of this API must have the ‘iam:PassRole` permission.

</note>

[1]: docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html

Returns:

  • (String)


46432
46433
46434
46435
46436
46437
46438
46439
46440
46441
46442
46443
46444
46445
46446
46447
46448
46449
# File 'lib/aws-sdk-sagemaker/types.rb', line 46432

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,
  :instance_metadata_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#root_accessString

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>

Returns:

  • (String)


46432
46433
46434
46435
46436
46437
46438
46439
46440
46441
46442
46443
46444
46445
46446
46447
46448
46449
# File 'lib/aws-sdk-sagemaker/types.rb', line 46432

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,
  :instance_metadata_service_configuration)
  SENSITIVE = []
  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 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)


46432
46433
46434
46435
46436
46437
46438
46439
46440
46441
46442
46443
46444
46445
46446
46447
46448
46449
# File 'lib/aws-sdk-sagemaker/types.rb', line 46432

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,
  :instance_metadata_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end