Amazonka.SageMaker.UpdateNotebookInstance

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.

Creating a Request

data UpdateNotebookInstance

See: newUpdateNotebookInstance smart constructor.

Constructors

UpdateNotebookInstance'

Fields

• acceleratorTypes :: Maybe [NotebookInstanceAcceleratorType]

  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.

• additionalCodeRepositories :: Maybe [Text]

  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.

• defaultCodeRepository :: Maybe Text

  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.

• disassociateAcceleratorTypes :: Maybe Bool

  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.

• disassociateAdditionalCodeRepositories :: Maybe Bool

  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.

• disassociateDefaultCodeRepository :: Maybe Bool

  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.

• disassociateLifecycleConfig :: Maybe Bool

  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.

• instanceMetadataServiceConfiguration :: Maybe InstanceMetadataServiceConfiguration

  Information on the IMDS configuration of the notebook instance

• instanceType :: Maybe InstanceType

  The Amazon ML compute instance type.

• lifecycleConfigName :: Maybe Text

  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.

• roleArn :: Maybe Text

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

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

• rootAccess :: Maybe RootAccess

  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.

• volumeSizeInGB :: Maybe Natural

  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.

• notebookInstanceName :: Text

  The name of the notebook instance to update.

Instances

ToJSON UpdateNotebookInstance

Defined in Amazonka.SageMaker.UpdateNotebookInstance

Methods

toJSON :: UpdateNotebookInstance -> Value

toEncoding :: UpdateNotebookInstance -> Encoding

toJSONList :: [UpdateNotebookInstance] -> Value

toEncodingList :: [UpdateNotebookInstance] -> Encoding

ToHeaders UpdateNotebookInstance

Defined in Amazonka.SageMaker.UpdateNotebookInstance

Methods

toHeaders :: UpdateNotebookInstance -> [Header]

ToPath UpdateNotebookInstance

Defined in Amazonka.SageMaker.UpdateNotebookInstance

Methods

toPath :: UpdateNotebookInstance -> ByteString

ToQuery UpdateNotebookInstance

Defined in Amazonka.SageMaker.UpdateNotebookInstance

Methods

toQuery :: UpdateNotebookInstance -> QueryString

AWSRequest UpdateNotebookInstance

Defined in Amazonka.SageMaker.UpdateNotebookInstance

Associated Types

type AWSResponse UpdateNotebookInstance

Methods

request :: (Service -> Service) -> UpdateNotebookInstance -> Request UpdateNotebookInstance

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateNotebookInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateNotebookInstance)))

Generic UpdateNotebookInstance

Defined in Amazonka.SageMaker.UpdateNotebookInstance

Associated Types

type Rep UpdateNotebookInstance :: Type -> Type

Methods

from :: UpdateNotebookInstance -> Rep UpdateNotebookInstance x

to :: Rep UpdateNotebookInstance x -> UpdateNotebookInstance

Read UpdateNotebookInstance

Defined in Amazonka.SageMaker.UpdateNotebookInstance

Methods

readsPrec :: Int -> ReadS UpdateNotebookInstance

readList :: ReadS [UpdateNotebookInstance]

readPrec :: ReadPrec UpdateNotebookInstance

readListPrec :: ReadPrec [UpdateNotebookInstance]

Show UpdateNotebookInstance

Defined in Amazonka.SageMaker.UpdateNotebookInstance

Methods

showsPrec :: Int -> UpdateNotebookInstance -> ShowS

show :: UpdateNotebookInstance -> String

showList :: [UpdateNotebookInstance] -> ShowS

NFData UpdateNotebookInstance

Defined in Amazonka.SageMaker.UpdateNotebookInstance

Methods

rnf :: UpdateNotebookInstance -> ()

Eq UpdateNotebookInstance

Defined in Amazonka.SageMaker.UpdateNotebookInstance

Methods

(==) :: UpdateNotebookInstance -> UpdateNotebookInstance -> Bool

(/=) :: UpdateNotebookInstance -> UpdateNotebookInstance -> Bool

Hashable UpdateNotebookInstance

Defined in Amazonka.SageMaker.UpdateNotebookInstance

Methods

hashWithSalt :: Int -> UpdateNotebookInstance -> Int

hash :: UpdateNotebookInstance -> Int

type AWSResponse UpdateNotebookInstance

Defined in Amazonka.SageMaker.UpdateNotebookInstance

type AWSResponse UpdateNotebookInstance = UpdateNotebookInstanceResponse

type Rep UpdateNotebookInstance

Defined in Amazonka.SageMaker.UpdateNotebookInstance

type Rep UpdateNotebookInstance = D1 ('MetaData "UpdateNotebookInstance" "Amazonka.SageMaker.UpdateNotebookInstance" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "UpdateNotebookInstance'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "acceleratorTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NotebookInstanceAcceleratorType])) :*: (S1 ('MetaSel ('Just "additionalCodeRepositories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "defaultCodeRepository") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "disassociateAcceleratorTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "disassociateAdditionalCodeRepositories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "disassociateDefaultCodeRepository") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "disassociateLifecycleConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "instanceMetadataServiceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceMetadataServiceConfiguration)) :*: (S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceType)) :*: S1 ('MetaSel ('Just "lifecycleConfigName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "rootAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RootAccess))) :*: (S1 ('MetaSel ('Just "volumeSizeInGB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "notebookInstanceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateNotebookInstance

Arguments

:: Text

UpdateNotebookInstance

-> UpdateNotebookInstance

Create a value of UpdateNotebookInstance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:acceleratorTypes:UpdateNotebookInstance', updateNotebookInstance_acceleratorTypes - 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.

UpdateNotebookInstance, updateNotebookInstance_additionalCodeRepositories - 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.

UpdateNotebookInstance, updateNotebookInstance_defaultCodeRepository - 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.

$sel:disassociateAcceleratorTypes:UpdateNotebookInstance', updateNotebookInstance_disassociateAcceleratorTypes - 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.

$sel:disassociateAdditionalCodeRepositories:UpdateNotebookInstance', updateNotebookInstance_disassociateAdditionalCodeRepositories - 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.

$sel:disassociateDefaultCodeRepository:UpdateNotebookInstance', updateNotebookInstance_disassociateDefaultCodeRepository - 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.

$sel:disassociateLifecycleConfig:UpdateNotebookInstance', updateNotebookInstance_disassociateLifecycleConfig - 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.

$sel:instanceMetadataServiceConfiguration:UpdateNotebookInstance', updateNotebookInstance_instanceMetadataServiceConfiguration - Information on the IMDS configuration of the notebook instance

UpdateNotebookInstance, updateNotebookInstance_instanceType - The Amazon ML compute instance type.

$sel:lifecycleConfigName:UpdateNotebookInstance', updateNotebookInstance_lifecycleConfigName - 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.

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

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

$sel:rootAccess:UpdateNotebookInstance', updateNotebookInstance_rootAccess - 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.

UpdateNotebookInstance, updateNotebookInstance_volumeSizeInGB - 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.

UpdateNotebookInstance, updateNotebookInstance_notebookInstanceName - The name of the notebook instance to update.

Request Lenses

updateNotebookInstance_acceleratorTypes :: Lens' UpdateNotebookInstance (Maybe [NotebookInstanceAcceleratorType])

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.

updateNotebookInstance_additionalCodeRepositories :: Lens' UpdateNotebookInstance (Maybe [Text])

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.

updateNotebookInstance_defaultCodeRepository :: Lens' UpdateNotebookInstance (Maybe Text)

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.

updateNotebookInstance_disassociateAcceleratorTypes :: Lens' UpdateNotebookInstance (Maybe Bool)

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.

updateNotebookInstance_disassociateAdditionalCodeRepositories :: Lens' UpdateNotebookInstance (Maybe Bool)

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.

updateNotebookInstance_disassociateDefaultCodeRepository :: Lens' UpdateNotebookInstance (Maybe Bool)

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.

updateNotebookInstance_disassociateLifecycleConfig :: Lens' UpdateNotebookInstance (Maybe Bool)

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.

updateNotebookInstance_instanceMetadataServiceConfiguration :: Lens' UpdateNotebookInstance (Maybe InstanceMetadataServiceConfiguration)

Information on the IMDS configuration of the notebook instance

updateNotebookInstance_instanceType :: Lens' UpdateNotebookInstance (Maybe InstanceType)

The Amazon ML compute instance type.

updateNotebookInstance_lifecycleConfigName :: Lens' UpdateNotebookInstance (Maybe Text)

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.

updateNotebookInstance_roleArn :: Lens' UpdateNotebookInstance (Maybe Text)

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

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

updateNotebookInstance_rootAccess :: Lens' UpdateNotebookInstance (Maybe RootAccess)

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.

updateNotebookInstance_volumeSizeInGB :: Lens' UpdateNotebookInstance (Maybe Natural)

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.

updateNotebookInstance_notebookInstanceName :: Lens' UpdateNotebookInstance Text

The name of the notebook instance to update.

Destructuring the Response

data UpdateNotebookInstanceResponse

See: newUpdateNotebookInstanceResponse smart constructor.

Constructors

UpdateNotebookInstanceResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateNotebookInstanceResponse

Defined in Amazonka.SageMaker.UpdateNotebookInstance

Associated Types

type Rep UpdateNotebookInstanceResponse :: Type -> Type

Methods

from :: UpdateNotebookInstanceResponse -> Rep UpdateNotebookInstanceResponse x

to :: Rep UpdateNotebookInstanceResponse x -> UpdateNotebookInstanceResponse

Read UpdateNotebookInstanceResponse

Defined in Amazonka.SageMaker.UpdateNotebookInstance

Methods

readsPrec :: Int -> ReadS UpdateNotebookInstanceResponse

readList :: ReadS [UpdateNotebookInstanceResponse]

readPrec :: ReadPrec UpdateNotebookInstanceResponse

readListPrec :: ReadPrec [UpdateNotebookInstanceResponse]

Show UpdateNotebookInstanceResponse

Defined in Amazonka.SageMaker.UpdateNotebookInstance

Methods

showsPrec :: Int -> UpdateNotebookInstanceResponse -> ShowS

show :: UpdateNotebookInstanceResponse -> String

showList :: [UpdateNotebookInstanceResponse] -> ShowS

NFData UpdateNotebookInstanceResponse

Defined in Amazonka.SageMaker.UpdateNotebookInstance

Methods

rnf :: UpdateNotebookInstanceResponse -> ()

Eq UpdateNotebookInstanceResponse

Defined in Amazonka.SageMaker.UpdateNotebookInstance

Methods

(==) :: UpdateNotebookInstanceResponse -> UpdateNotebookInstanceResponse -> Bool

(/=) :: UpdateNotebookInstanceResponse -> UpdateNotebookInstanceResponse -> Bool

type Rep UpdateNotebookInstanceResponse

Defined in Amazonka.SageMaker.UpdateNotebookInstance

type Rep UpdateNotebookInstanceResponse = D1 ('MetaData "UpdateNotebookInstanceResponse" "Amazonka.SageMaker.UpdateNotebookInstance" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "UpdateNotebookInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateNotebookInstanceResponse

Arguments

:: Int

$sel:httpStatus:UpdateNotebookInstanceResponse'

-> UpdateNotebookInstanceResponse

Create a value of UpdateNotebookInstanceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateNotebookInstanceResponse', updateNotebookInstanceResponse_httpStatus - The response's http status code.

Response Lenses

updateNotebookInstanceResponse_httpStatus :: Lens' UpdateNotebookInstanceResponse Int

The response's http status code.