AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

UpdateNotebookInstanceInput

import "github.com/aws/aws-sdk-go/service/sagemaker"

type UpdateNotebookInstanceInput struct { AcceleratorTypes []*string `type:"list"` AdditionalCodeRepositories []*string `type:"list"` DefaultCodeRepository *string `min:"1" type:"string"` DisassociateAcceleratorTypes *bool `type:"boolean"` DisassociateAdditionalCodeRepositories *bool `type:"boolean"` DisassociateDefaultCodeRepository *bool `type:"boolean"` DisassociateLifecycleConfig *bool `type:"boolean"` InstanceType *string `type:"string" enum:"InstanceType"` LifecycleConfigName *string `type:"string"` NotebookInstanceName *string `type:"string" required:"true"` RoleArn *string `min:"20" type:"string"` VolumeSizeInGB *int64 `min:"5" type:"integer"` }

AcceleratorTypes

Type: []*string

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 (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html).

AdditionalCodeRepositories

Type: []*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 AWS 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 Amazon SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html).

DefaultCodeRepository

Type: *string

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 (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 Amazon SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html).

DisassociateAcceleratorTypes

Type: *bool

A list of the Elastic Inference (EI) instance types to remove from this notebook instance.

DisassociateAdditionalCodeRepositories

Type: *bool

A list of names or URLs of the default Git repositories to remove from this notebook instance.

DisassociateDefaultCodeRepository

Type: *bool

The name or URL of the default Git repository to remove from this notebook instance.

DisassociateLifecycleConfig

Type: *bool

Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance.

InstanceType

Type: *string

The Amazon ML compute instance type.

LifecycleConfigName

Type: *string

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).

NotebookInstanceName

Type: *string

The name of the notebook instance to update.

NotebookInstanceName is a required field

RoleArn

Type: *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 (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html).

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

VolumeSizeInGB

Type: *int64

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

Method

GoString

func (s UpdateNotebookInstanceInput) GoString() string

GoString returns the string representation

SetAcceleratorTypes

func (s *UpdateNotebookInstanceInput) SetAcceleratorTypes(v []*string) *UpdateNotebookInstanceInput

SetAcceleratorTypes sets the AcceleratorTypes field's value.

SetAdditionalCodeRepositories

func (s *UpdateNotebookInstanceInput) SetAdditionalCodeRepositories(v []*string) *UpdateNotebookInstanceInput

SetAdditionalCodeRepositories sets the AdditionalCodeRepositories field's value.

SetDefaultCodeRepository

func (s *UpdateNotebookInstanceInput) SetDefaultCodeRepository(v string) *UpdateNotebookInstanceInput

SetDefaultCodeRepository sets the DefaultCodeRepository field's value.

SetDisassociateAcceleratorTypes

func (s *UpdateNotebookInstanceInput) SetDisassociateAcceleratorTypes(v bool) *UpdateNotebookInstanceInput

SetDisassociateAcceleratorTypes sets the DisassociateAcceleratorTypes field's value.

SetDisassociateAdditionalCodeRepositories

func (s *UpdateNotebookInstanceInput) SetDisassociateAdditionalCodeRepositories(v bool) *UpdateNotebookInstanceInput

SetDisassociateAdditionalCodeRepositories sets the DisassociateAdditionalCodeRepositories field's value.

SetDisassociateDefaultCodeRepository

func (s *UpdateNotebookInstanceInput) SetDisassociateDefaultCodeRepository(v bool) *UpdateNotebookInstanceInput

SetDisassociateDefaultCodeRepository sets the DisassociateDefaultCodeRepository field's value.

SetDisassociateLifecycleConfig

func (s *UpdateNotebookInstanceInput) SetDisassociateLifecycleConfig(v bool) *UpdateNotebookInstanceInput

SetDisassociateLifecycleConfig sets the DisassociateLifecycleConfig field's value.

SetInstanceType

func (s *UpdateNotebookInstanceInput) SetInstanceType(v string) *UpdateNotebookInstanceInput

SetInstanceType sets the InstanceType field's value.

SetLifecycleConfigName

func (s *UpdateNotebookInstanceInput) SetLifecycleConfigName(v string) *UpdateNotebookInstanceInput

SetLifecycleConfigName sets the LifecycleConfigName field's value.

SetNotebookInstanceName

func (s *UpdateNotebookInstanceInput) SetNotebookInstanceName(v string) *UpdateNotebookInstanceInput

SetNotebookInstanceName sets the NotebookInstanceName field's value.

SetRoleArn

func (s *UpdateNotebookInstanceInput) SetRoleArn(v string) *UpdateNotebookInstanceInput

SetRoleArn sets the RoleArn field's value.

SetVolumeSizeInGB

func (s *UpdateNotebookInstanceInput) SetVolumeSizeInGB(v int64) *UpdateNotebookInstanceInput

SetVolumeSizeInGB sets the VolumeSizeInGB field's value.

String

func (s UpdateNotebookInstanceInput) String() string

String returns the string representation

Validate

func (s *UpdateNotebookInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: