Method: Aws::SageMaker::Client#update_notebook_instance

Defined in:
lib/aws-sdk-sagemaker/client.rb

#update_notebook_instance(params = {}) ⇒ Struct

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. You can also update the VPC security groups.

Examples:

Request syntax with placeholder values


resp = client.update_notebook_instance({
  notebook_instance_name: "NotebookInstanceName", # required
  instance_type: "ml.t2.medium", # accepts ml.t2.medium, ml.t2.large, ml.t2.xlarge, ml.t2.2xlarge, ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge
  role_arn: "RoleArn",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :notebook_instance_name (required, String)

    The name of the notebook instance to update.

  • :instance_type (String)

    The Amazon ML compute instance type.

  • :role_arn (String)

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

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

    </note>
    

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2585
2586
2587
2588
# File 'lib/aws-sdk-sagemaker/client.rb', line 2585

def update_notebook_instance(params = {}, options = {})
  req = build_request(:update_notebook_instance, params)
  req.send_request(options)
end