:doc:`SageMaker <../../sagemaker>` / Client / update_notebook_instance

************************
update_notebook_instance
************************



.. py:method:: SageMaker.Client.update_notebook_instance(**kwargs)

  

  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.

   

  .. note::

    

    This API can attach lifecycle configurations to notebook instances. Lifecycle configuration scripts execute with root access and the notebook instance's IAM execution role privileges. Principals with this permission and access to lifecycle configurations can execute code with the execution role's credentials. See `Customize a Notebook Instance Using a Lifecycle Configuration Script <https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html>`__ for security best practices.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateNotebookInstance>`_  


  **Request Syntax**
  ::

    response = client.update_notebook_instance(
        NotebookInstanceName='string',
        InstanceType='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.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.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'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.inf1.xlarge'|'ml.inf1.2xlarge'|'ml.inf1.6xlarge'|'ml.inf1.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.inf2.xlarge'|'ml.inf2.8xlarge'|'ml.inf2.24xlarge'|'ml.inf2.48xlarge'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.p6-b200.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge',
        IpAddressType='ipv4'|'dualstack',
        PlatformIdentifier='string',
        RoleArn='string',
        LifecycleConfigName='string',
        DisassociateLifecycleConfig=True|False,
        VolumeSizeInGB=123,
        DefaultCodeRepository='string',
        AdditionalCodeRepositories=[
            'string',
        ],
        AcceleratorTypes=[
            'ml.eia1.medium'|'ml.eia1.large'|'ml.eia1.xlarge'|'ml.eia2.medium'|'ml.eia2.large'|'ml.eia2.xlarge',
        ],
        DisassociateAcceleratorTypes=True|False,
        DisassociateDefaultCodeRepository=True|False,
        DisassociateAdditionalCodeRepositories=True|False,
        RootAccess='Enabled'|'Disabled',
        InstanceMetadataServiceConfiguration={
            'MinimumInstanceMetadataServiceVersion': 'string'
        }
    )
    
  :type NotebookInstanceName: string
  :param NotebookInstanceName: **[REQUIRED]** 

    The name of the notebook instance to update.

    

  
  :type InstanceType: string
  :param InstanceType: 

    The Amazon ML compute instance type.

    

  
  :type IpAddressType: string
  :param IpAddressType: 

    The IP address type for the notebook instance. Specify ``ipv4`` for IPv4-only connectivity or ``dualstack`` for both IPv4 and IPv6 connectivity. The notebook instance must be stopped before updating this setting. When you specify ``dualstack``, the subnet must support IPv6 addressing.

    

  
  :type PlatformIdentifier: string
  :param PlatformIdentifier: 

    The platform identifier of the notebook instance runtime environment.

    

  
  :type RoleArn: string
  :param RoleArn: 

    The Amazon Resource Name (ARN) of the IAM role that SageMaker AI can assume to access the notebook instance. For more information, see `SageMaker AI Roles <https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html>`__.

     

    .. note::

      

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

      

    

  
  :type LifecycleConfigName: string
  :param 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 <https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html>`__.

    

  
  :type DisassociateLifecycleConfig: boolean
  :param 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.

    

  
  :type VolumeSizeInGB: integer
  :param 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 AI 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.

    

  
  :type DefaultCodeRepository: string
  :param 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 <https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html>`__ 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 AI Notebook Instances <https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html>`__.

    

  
  :type AdditionalCodeRepositories: list
  :param 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 <https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html>`__ 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 AI Notebook Instances <https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html>`__.

    

  
    - *(string) --* 

    

  :type AcceleratorTypes: list
  :param AcceleratorTypes: 

    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.

    

  
    - *(string) --* 

    

  :type DisassociateAcceleratorTypes: boolean
  :param DisassociateAcceleratorTypes: 

    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.

    

  
  :type DisassociateDefaultCodeRepository: boolean
  :param 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.

    

  
  :type DisassociateAdditionalCodeRepositories: boolean
  :param 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.

    

  
  :type RootAccess: string
  :param RootAccess: 

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

     

    .. note::

      

      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.

      

    

  
  :type InstanceMetadataServiceConfiguration: dict
  :param InstanceMetadataServiceConfiguration: 

    Information on the IMDS configuration of the notebook instance

    

  
    - **MinimumInstanceMetadataServiceVersion** *(string) --* **[REQUIRED]** 

      Indicates the minimum IMDS version that the notebook instance supports. When passed as part of ``CreateNotebookInstance``, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of ``UpdateNotebookInstance``, there is no default.

      

    
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`SageMaker.Client.exceptions.ResourceLimitExceeded`

  