Aws::SageMaker::Model::UpdateNotebookInstanceRequest Class Reference

#include <UpdateNotebookInstanceRequest.h>

Inheritance diagram for Aws::SageMaker::Model::UpdateNotebookInstanceRequest:

Public Member Functions
	UpdateNotebookInstanceRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetNotebookInstanceName () const
bool	NotebookInstanceNameHasBeenSet () const
void	SetNotebookInstanceName (const Aws::String &value)
void	SetNotebookInstanceName (Aws::String &&value)
void	SetNotebookInstanceName (const char *value)
UpdateNotebookInstanceRequest &	WithNotebookInstanceName (const Aws::String &value)
UpdateNotebookInstanceRequest &	WithNotebookInstanceName (Aws::String &&value)
UpdateNotebookInstanceRequest &	WithNotebookInstanceName (const char *value)
const InstanceType &	GetInstanceType () const
bool	InstanceTypeHasBeenSet () const
void	SetInstanceType (const InstanceType &value)
void	SetInstanceType (InstanceType &&value)
UpdateNotebookInstanceRequest &	WithInstanceType (const InstanceType &value)
UpdateNotebookInstanceRequest &	WithInstanceType (InstanceType &&value)
const Aws::String &	GetRoleArn () const
bool	RoleArnHasBeenSet () const
void	SetRoleArn (const Aws::String &value)
void	SetRoleArn (Aws::String &&value)
void	SetRoleArn (const char *value)
UpdateNotebookInstanceRequest &	WithRoleArn (const Aws::String &value)
UpdateNotebookInstanceRequest &	WithRoleArn (Aws::String &&value)
UpdateNotebookInstanceRequest &	WithRoleArn (const char *value)
const Aws::String &	GetLifecycleConfigName () const
bool	LifecycleConfigNameHasBeenSet () const
void	SetLifecycleConfigName (const Aws::String &value)
void	SetLifecycleConfigName (Aws::String &&value)
void	SetLifecycleConfigName (const char *value)
UpdateNotebookInstanceRequest &	WithLifecycleConfigName (const Aws::String &value)
UpdateNotebookInstanceRequest &	WithLifecycleConfigName (Aws::String &&value)
UpdateNotebookInstanceRequest &	WithLifecycleConfigName (const char *value)
bool	GetDisassociateLifecycleConfig () const
bool	DisassociateLifecycleConfigHasBeenSet () const
void	SetDisassociateLifecycleConfig (bool value)
UpdateNotebookInstanceRequest &	WithDisassociateLifecycleConfig (bool value)
int	GetVolumeSizeInGB () const
bool	VolumeSizeInGBHasBeenSet () const
void	SetVolumeSizeInGB (int value)
UpdateNotebookInstanceRequest &	WithVolumeSizeInGB (int value)
const Aws::String &	GetDefaultCodeRepository () const
bool	DefaultCodeRepositoryHasBeenSet () const
void	SetDefaultCodeRepository (const Aws::String &value)
void	SetDefaultCodeRepository (Aws::String &&value)
void	SetDefaultCodeRepository (const char *value)
UpdateNotebookInstanceRequest &	WithDefaultCodeRepository (const Aws::String &value)
UpdateNotebookInstanceRequest &	WithDefaultCodeRepository (Aws::String &&value)
UpdateNotebookInstanceRequest &	WithDefaultCodeRepository (const char *value)
const Aws::Vector< Aws::String > &	GetAdditionalCodeRepositories () const
bool	AdditionalCodeRepositoriesHasBeenSet () const
void	SetAdditionalCodeRepositories (const Aws::Vector< Aws::String > &value)
void	SetAdditionalCodeRepositories (Aws::Vector< Aws::String > &&value)
UpdateNotebookInstanceRequest &	WithAdditionalCodeRepositories (const Aws::Vector< Aws::String > &value)
UpdateNotebookInstanceRequest &	WithAdditionalCodeRepositories (Aws::Vector< Aws::String > &&value)
UpdateNotebookInstanceRequest &	AddAdditionalCodeRepositories (const Aws::String &value)
UpdateNotebookInstanceRequest &	AddAdditionalCodeRepositories (Aws::String &&value)
UpdateNotebookInstanceRequest &	AddAdditionalCodeRepositories (const char *value)
const Aws::Vector< NotebookInstanceAcceleratorType > &	GetAcceleratorTypes () const
bool	AcceleratorTypesHasBeenSet () const
void	SetAcceleratorTypes (const Aws::Vector< NotebookInstanceAcceleratorType > &value)
void	SetAcceleratorTypes (Aws::Vector< NotebookInstanceAcceleratorType > &&value)
UpdateNotebookInstanceRequest &	WithAcceleratorTypes (const Aws::Vector< NotebookInstanceAcceleratorType > &value)
UpdateNotebookInstanceRequest &	WithAcceleratorTypes (Aws::Vector< NotebookInstanceAcceleratorType > &&value)
UpdateNotebookInstanceRequest &	AddAcceleratorTypes (const NotebookInstanceAcceleratorType &value)
UpdateNotebookInstanceRequest &	AddAcceleratorTypes (NotebookInstanceAcceleratorType &&value)
bool	GetDisassociateAcceleratorTypes () const
bool	DisassociateAcceleratorTypesHasBeenSet () const
void	SetDisassociateAcceleratorTypes (bool value)
UpdateNotebookInstanceRequest &	WithDisassociateAcceleratorTypes (bool value)
bool	GetDisassociateDefaultCodeRepository () const
bool	DisassociateDefaultCodeRepositoryHasBeenSet () const
void	SetDisassociateDefaultCodeRepository (bool value)
UpdateNotebookInstanceRequest &	WithDisassociateDefaultCodeRepository (bool value)
bool	GetDisassociateAdditionalCodeRepositories () const
bool	DisassociateAdditionalCodeRepositoriesHasBeenSet () const
void	SetDisassociateAdditionalCodeRepositories (bool value)
UpdateNotebookInstanceRequest &	WithDisassociateAdditionalCodeRepositories (bool value)
const RootAccess &	GetRootAccess () const
bool	RootAccessHasBeenSet () const
void	SetRootAccess (const RootAccess &value)
void	SetRootAccess (RootAccess &&value)
UpdateNotebookInstanceRequest &	WithRootAccess (const RootAccess &value)
UpdateNotebookInstanceRequest &	WithRootAccess (RootAccess &&value)
Public Member Functions inherited from Aws::SageMaker::SageMakerRequest
virtual	~SageMakerRequest ()
void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
Aws::Http::HeaderValueCollection	GetHeaders () const override
Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()
virtual	~AmazonSerializableWebServiceRequest ()
std::shared_ptr< Aws::IOStream >	GetBody () const override
Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()
virtual	~AmazonWebServiceRequest ()=default
virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const
virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const
virtual bool	IsStreaming () const
virtual bool	IsEventStreamRequest () const
virtual bool	SignBody () const
virtual bool	IsChunked () const
virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)
virtual const RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () const
void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)
virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)
virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () const
virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Definition at line 25 of file UpdateNotebookInstanceRequest.h.

Constructor & Destructor Documentation

UpdateNotebookInstanceRequest()

Aws::SageMaker::Model::UpdateNotebookInstanceRequest::UpdateNotebookInstanceRequest

(

)

Member Function Documentation

AcceleratorTypesHasBeenSet()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::AcceleratorTypesHasBeenSet ( ) const

inline

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.

Definition at line 572 of file UpdateNotebookInstanceRequest.h.

AddAcceleratorTypes() [1/2]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::AddAcceleratorTypes ( const NotebookInstanceAcceleratorType &  value )

inline

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.

Definition at line 617 of file UpdateNotebookInstanceRequest.h.

AddAcceleratorTypes() [2/2]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::AddAcceleratorTypes ( NotebookInstanceAcceleratorType &&  value )

inline

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.

Definition at line 626 of file UpdateNotebookInstanceRequest.h.

AddAdditionalCodeRepositories() [1/3]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::AddAdditionalCodeRepositories ( const Aws::String &  value )

inline

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.

Definition at line 527 of file UpdateNotebookInstanceRequest.h.

AddAdditionalCodeRepositories() [2/3]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::AddAdditionalCodeRepositories ( Aws::String &&  value )

inline

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.

Definition at line 540 of file UpdateNotebookInstanceRequest.h.

AddAdditionalCodeRepositories() [3/3]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::AddAdditionalCodeRepositories ( const char *  value )

inline

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.

Definition at line 553 of file UpdateNotebookInstanceRequest.h.

AdditionalCodeRepositoriesHasBeenSet()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::AdditionalCodeRepositoriesHasBeenSet ( ) const

inline

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.

Definition at line 462 of file UpdateNotebookInstanceRequest.h.

DefaultCodeRepositoryHasBeenSet()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::DefaultCodeRepositoryHasBeenSet ( ) const

inline

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.

Definition at line 357 of file UpdateNotebookInstanceRequest.h.

DisassociateAcceleratorTypesHasBeenSet()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::DisassociateAcceleratorTypesHasBeenSet ( ) const

inline

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.

Definition at line 643 of file UpdateNotebookInstanceRequest.h.

DisassociateAdditionalCodeRepositoriesHasBeenSet()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::DisassociateAdditionalCodeRepositoriesHasBeenSet ( ) const

inline

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.

Definition at line 709 of file UpdateNotebookInstanceRequest.h.

DisassociateDefaultCodeRepositoryHasBeenSet()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::DisassociateDefaultCodeRepositoryHasBeenSet ( ) const

inline

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.

Definition at line 676 of file UpdateNotebookInstanceRequest.h.

DisassociateLifecycleConfigHasBeenSet()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::DisassociateLifecycleConfigHasBeenSet ( ) const

inline

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.

Definition at line 273 of file UpdateNotebookInstanceRequest.h.

GetAcceleratorTypes()

const Aws::Vector<NotebookInstanceAcceleratorType>& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::GetAcceleratorTypes ( ) const

inline

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.

Definition at line 563 of file UpdateNotebookInstanceRequest.h.

GetAdditionalCodeRepositories()

const Aws::Vector<Aws::String>& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::GetAdditionalCodeRepositories ( ) const

inline

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.

Definition at line 449 of file UpdateNotebookInstanceRequest.h.

GetDefaultCodeRepository()

const Aws::String& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::GetDefaultCodeRepository ( ) const

inline

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.

Definition at line 344 of file UpdateNotebookInstanceRequest.h.

GetDisassociateAcceleratorTypes()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::GetDisassociateAcceleratorTypes ( ) const

inline

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.

Definition at line 635 of file UpdateNotebookInstanceRequest.h.

GetDisassociateAdditionalCodeRepositories()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::GetDisassociateAdditionalCodeRepositories ( ) const

inline

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.

Definition at line 701 of file UpdateNotebookInstanceRequest.h.

GetDisassociateDefaultCodeRepository()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::GetDisassociateDefaultCodeRepository ( ) const

inline

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.

Definition at line 668 of file UpdateNotebookInstanceRequest.h.

GetDisassociateLifecycleConfig()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::GetDisassociateLifecycleConfig ( ) const

inline

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.

Definition at line 265 of file UpdateNotebookInstanceRequest.h.

GetInstanceType()

const InstanceType& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::GetInstanceType ( ) const

inline

The Amazon ML compute instance type.

Definition at line 85 of file UpdateNotebookInstanceRequest.h.

GetLifecycleConfigName()

const Aws::String& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::GetLifecycleConfigName ( ) const

inline

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.

Definition at line 200 of file UpdateNotebookInstanceRequest.h.

GetNotebookInstanceName()

const Aws::String& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::GetNotebookInstanceName ( ) const

inline

The name of the notebook instance to update.

Definition at line 44 of file UpdateNotebookInstanceRequest.h.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SageMaker::Model::UpdateNotebookInstanceRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::SageMaker::SageMakerRequest.

GetRoleArn()

const Aws::String& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::GetRoleArn ( ) const

inline

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.

Definition at line 121 of file UpdateNotebookInstanceRequest.h.

GetRootAccess()

const RootAccess& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::GetRootAccess ( ) const

inline

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.

Definition at line 735 of file UpdateNotebookInstanceRequest.h.

GetServiceRequestName()

virtual const char* Aws::SageMaker::Model::UpdateNotebookInstanceRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file UpdateNotebookInstanceRequest.h.

GetVolumeSizeInGB()

int Aws::SageMaker::Model::UpdateNotebookInstanceRequest::GetVolumeSizeInGB ( ) const

inline

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.

Definition at line 300 of file UpdateNotebookInstanceRequest.h.

InstanceTypeHasBeenSet()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::InstanceTypeHasBeenSet ( ) const

inline

The Amazon ML compute instance type.

Definition at line 90 of file UpdateNotebookInstanceRequest.h.

LifecycleConfigNameHasBeenSet()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::LifecycleConfigNameHasBeenSet ( ) const

inline

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.

Definition at line 208 of file UpdateNotebookInstanceRequest.h.

NotebookInstanceNameHasBeenSet()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::NotebookInstanceNameHasBeenSet ( ) const

inline

The name of the notebook instance to update.

Definition at line 49 of file UpdateNotebookInstanceRequest.h.

RoleArnHasBeenSet()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::RoleArnHasBeenSet ( ) const

inline

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.

Definition at line 131 of file UpdateNotebookInstanceRequest.h.

RootAccessHasBeenSet()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::RootAccessHasBeenSet ( ) const

inline

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.

Definition at line 744 of file UpdateNotebookInstanceRequest.h.

SerializePayload()

Aws::String Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetAcceleratorTypes() [1/2]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetAcceleratorTypes ( const Aws::Vector< NotebookInstanceAcceleratorType > &  value )

inline

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.

Definition at line 581 of file UpdateNotebookInstanceRequest.h.

SetAcceleratorTypes() [2/2]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetAcceleratorTypes ( Aws::Vector< NotebookInstanceAcceleratorType > &&  value )

inline

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.

Definition at line 590 of file UpdateNotebookInstanceRequest.h.

SetAdditionalCodeRepositories() [1/2]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetAdditionalCodeRepositories ( const Aws::Vector< Aws::String > &  value )

inline

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.

Definition at line 475 of file UpdateNotebookInstanceRequest.h.

SetAdditionalCodeRepositories() [2/2]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetAdditionalCodeRepositories ( Aws::Vector< Aws::String > &&  value )

inline

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.

Definition at line 488 of file UpdateNotebookInstanceRequest.h.

SetDefaultCodeRepository() [1/3]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetDefaultCodeRepository ( const Aws::String &  value )

inline

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.

Definition at line 370 of file UpdateNotebookInstanceRequest.h.

SetDefaultCodeRepository() [2/3]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetDefaultCodeRepository ( Aws::String &&  value )

inline

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.

Definition at line 383 of file UpdateNotebookInstanceRequest.h.

SetDefaultCodeRepository() [3/3]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetDefaultCodeRepository ( const char *  value )

inline

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.

Definition at line 396 of file UpdateNotebookInstanceRequest.h.

SetDisassociateAcceleratorTypes()

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetDisassociateAcceleratorTypes ( bool  value )

inline

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.

Definition at line 651 of file UpdateNotebookInstanceRequest.h.

SetDisassociateAdditionalCodeRepositories()

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetDisassociateAdditionalCodeRepositories ( bool  value )

inline

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.

Definition at line 717 of file UpdateNotebookInstanceRequest.h.

SetDisassociateDefaultCodeRepository()

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetDisassociateDefaultCodeRepository ( bool  value )

inline

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.

Definition at line 684 of file UpdateNotebookInstanceRequest.h.

SetDisassociateLifecycleConfig()

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetDisassociateLifecycleConfig ( bool  value )

inline

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.

Definition at line 281 of file UpdateNotebookInstanceRequest.h.

SetInstanceType() [1/2]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetInstanceType ( const InstanceType &  value )

inline

The Amazon ML compute instance type.

Definition at line 95 of file UpdateNotebookInstanceRequest.h.

SetInstanceType() [2/2]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetInstanceType ( InstanceType &&  value )

inline

The Amazon ML compute instance type.

Definition at line 100 of file UpdateNotebookInstanceRequest.h.

SetLifecycleConfigName() [1/3]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetLifecycleConfigName ( const Aws::String &  value )

inline

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.

Definition at line 216 of file UpdateNotebookInstanceRequest.h.

SetLifecycleConfigName() [2/3]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetLifecycleConfigName ( Aws::String &&  value )

inline

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.

Definition at line 224 of file UpdateNotebookInstanceRequest.h.

SetLifecycleConfigName() [3/3]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetLifecycleConfigName ( const char *  value )

inline

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.

Definition at line 232 of file UpdateNotebookInstanceRequest.h.

SetNotebookInstanceName() [1/3]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetNotebookInstanceName ( const Aws::String &  value )

inline

The name of the notebook instance to update.

Definition at line 54 of file UpdateNotebookInstanceRequest.h.

SetNotebookInstanceName() [2/3]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetNotebookInstanceName ( Aws::String &&  value )

inline

The name of the notebook instance to update.

Definition at line 59 of file UpdateNotebookInstanceRequest.h.

SetNotebookInstanceName() [3/3]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetNotebookInstanceName ( const char *  value )

inline

The name of the notebook instance to update.

Definition at line 64 of file UpdateNotebookInstanceRequest.h.

SetRoleArn() [1/3]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetRoleArn ( const Aws::String &  value )

inline

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.

Definition at line 141 of file UpdateNotebookInstanceRequest.h.

SetRoleArn() [2/3]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetRoleArn ( Aws::String &&  value )

inline

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.

Definition at line 151 of file UpdateNotebookInstanceRequest.h.

SetRoleArn() [3/3]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetRoleArn ( const char *  value )

inline

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.

Definition at line 161 of file UpdateNotebookInstanceRequest.h.

SetRootAccess() [1/2]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetRootAccess ( const RootAccess &  value )

inline

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.

Definition at line 753 of file UpdateNotebookInstanceRequest.h.

SetRootAccess() [2/2]

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetRootAccess ( RootAccess &&  value )

inline

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.

Definition at line 762 of file UpdateNotebookInstanceRequest.h.

SetVolumeSizeInGB()

void Aws::SageMaker::Model::UpdateNotebookInstanceRequest::SetVolumeSizeInGB ( int  value )

inline

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.

Definition at line 320 of file UpdateNotebookInstanceRequest.h.

VolumeSizeInGBHasBeenSet()

bool Aws::SageMaker::Model::UpdateNotebookInstanceRequest::VolumeSizeInGBHasBeenSet ( ) const

inline

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.

Definition at line 310 of file UpdateNotebookInstanceRequest.h.

WithAcceleratorTypes() [1/2]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithAcceleratorTypes ( const Aws::Vector< NotebookInstanceAcceleratorType > &  value )

inline

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.

Definition at line 599 of file UpdateNotebookInstanceRequest.h.

WithAcceleratorTypes() [2/2]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithAcceleratorTypes ( Aws::Vector< NotebookInstanceAcceleratorType > &&  value )

inline

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.

Definition at line 608 of file UpdateNotebookInstanceRequest.h.

WithAdditionalCodeRepositories() [1/2]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithAdditionalCodeRepositories ( const Aws::Vector< Aws::String > &  value )

inline

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.

Definition at line 501 of file UpdateNotebookInstanceRequest.h.

WithAdditionalCodeRepositories() [2/2]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithAdditionalCodeRepositories ( Aws::Vector< Aws::String > &&  value )

inline

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.

Definition at line 514 of file UpdateNotebookInstanceRequest.h.

WithDefaultCodeRepository() [1/3]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithDefaultCodeRepository ( const Aws::String &  value )

inline

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.

Definition at line 409 of file UpdateNotebookInstanceRequest.h.

WithDefaultCodeRepository() [2/3]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithDefaultCodeRepository ( Aws::String &&  value )

inline

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.

Definition at line 422 of file UpdateNotebookInstanceRequest.h.

WithDefaultCodeRepository() [3/3]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithDefaultCodeRepository ( const char *  value )

inline

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.

Definition at line 435 of file UpdateNotebookInstanceRequest.h.

WithDisassociateAcceleratorTypes()

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithDisassociateAcceleratorTypes ( bool  value )

inline

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.

Definition at line 659 of file UpdateNotebookInstanceRequest.h.

WithDisassociateAdditionalCodeRepositories()

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithDisassociateAdditionalCodeRepositories ( bool  value )

inline

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.

Definition at line 725 of file UpdateNotebookInstanceRequest.h.

WithDisassociateDefaultCodeRepository()

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithDisassociateDefaultCodeRepository ( bool  value )

inline

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.

Definition at line 692 of file UpdateNotebookInstanceRequest.h.

WithDisassociateLifecycleConfig()

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithDisassociateLifecycleConfig ( bool  value )

inline

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.

Definition at line 289 of file UpdateNotebookInstanceRequest.h.

WithInstanceType() [1/2]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithInstanceType ( const InstanceType &  value )

inline

The Amazon ML compute instance type.

Definition at line 105 of file UpdateNotebookInstanceRequest.h.

WithInstanceType() [2/2]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithInstanceType ( InstanceType &&  value )

inline

The Amazon ML compute instance type.

Definition at line 110 of file UpdateNotebookInstanceRequest.h.

WithLifecycleConfigName() [1/3]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithLifecycleConfigName ( const Aws::String &  value )

inline

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.

Definition at line 240 of file UpdateNotebookInstanceRequest.h.

WithLifecycleConfigName() [2/3]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithLifecycleConfigName ( Aws::String &&  value )

inline

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.

Definition at line 248 of file UpdateNotebookInstanceRequest.h.

WithLifecycleConfigName() [3/3]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithLifecycleConfigName ( const char *  value )

inline

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.

Definition at line 256 of file UpdateNotebookInstanceRequest.h.

WithNotebookInstanceName() [1/3]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithNotebookInstanceName ( const Aws::String &  value )

inline

The name of the notebook instance to update.

Definition at line 69 of file UpdateNotebookInstanceRequest.h.

WithNotebookInstanceName() [2/3]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithNotebookInstanceName ( Aws::String &&  value )

inline

The name of the notebook instance to update.

Definition at line 74 of file UpdateNotebookInstanceRequest.h.

WithNotebookInstanceName() [3/3]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithNotebookInstanceName ( const char *  value )

inline

The name of the notebook instance to update.

Definition at line 79 of file UpdateNotebookInstanceRequest.h.

WithRoleArn() [1/3]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithRoleArn ( const Aws::String &  value )

inline

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.

Definition at line 171 of file UpdateNotebookInstanceRequest.h.

WithRoleArn() [2/3]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithRoleArn ( Aws::String &&  value )

inline

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.

Definition at line 181 of file UpdateNotebookInstanceRequest.h.

WithRoleArn() [3/3]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithRoleArn ( const char *  value )

inline

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.

Definition at line 191 of file UpdateNotebookInstanceRequest.h.

WithRootAccess() [1/2]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithRootAccess ( const RootAccess &  value )

inline

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.

Definition at line 771 of file UpdateNotebookInstanceRequest.h.

WithRootAccess() [2/2]

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithRootAccess ( RootAccess &&  value )

inline

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.

Definition at line 780 of file UpdateNotebookInstanceRequest.h.

WithVolumeSizeInGB()

UpdateNotebookInstanceRequest& Aws::SageMaker::Model::UpdateNotebookInstanceRequest::WithVolumeSizeInGB ( int  value )

inline

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.

Definition at line 330 of file UpdateNotebookInstanceRequest.h.

---

The documentation for this class was generated from the following file:

• aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/UpdateNotebookInstanceRequest.h