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.

DescribeNotebookInstanceOutput

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

type DescribeNotebookInstanceOutput struct { AcceleratorTypes []*string `type:"list"` AdditionalCodeRepositories []*string `type:"list"` CreationTime *time.Time `type:"timestamp"` DefaultCodeRepository *string `min:"1" type:"string"` DirectInternetAccess *string `type:"string" enum:"DirectInternetAccess"` FailureReason *string `type:"string"` InstanceType *string `type:"string" enum:"InstanceType"` KmsKeyId *string `type:"string"` LastModifiedTime *time.Time `type:"timestamp"` NetworkInterfaceId *string `type:"string"` NotebookInstanceArn *string `type:"string"` NotebookInstanceLifecycleConfigName *string `type:"string"` NotebookInstanceName *string `type:"string"` NotebookInstanceStatus *string `type:"string" enum:"NotebookInstanceStatus"` RoleArn *string `min:"20" type:"string"` SecurityGroups []*string `type:"list"` SubnetId *string `type:"string"` Url *string `type:"string"` VolumeSizeInGB *int64 `min:"5" type:"integer"` }

AcceleratorTypes

Type: []*string

A list of the Elastic Inference (EI) instance types associated 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 associated 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).

CreationTime

Type: *time.Time

A timestamp. Use this parameter to return the time when the notebook instance was created

DefaultCodeRepository

Type: *string

The Git repository associated 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).

DirectInternetAccess

Type: *string

Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, he notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default (https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access).

FailureReason

Type: *string

If status is Failed, the reason it failed.

InstanceType

Type: *string

The type of ML compute instance running on the notebook instance.

KmsKeyId

Type: *string

The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

LastModifiedTime

Type: *time.Time

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

NetworkInterfaceId

Type: *string

The network interface IDs that Amazon SageMaker created at the time of creating the instance.

NotebookInstanceArn

Type: *string

The Amazon Resource Name (ARN) of the notebook instance.

NotebookInstanceLifecycleConfigName

Type: *string

Returns the name of a notebook instance lifecycle configuration.

For information about notebook instance 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 Amazon SageMaker notebook instance.

NotebookInstanceStatus

Type: *string

The status of the notebook instance.

RoleArn

Type: *string

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

SecurityGroups

Type: []*string

The IDs of the VPC security groups.

SubnetId

Type: *string

The ID of the VPC subnet.

Url

Type: *string

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

VolumeSizeInGB

Type: *int64

The size, in GB, of the ML storage volume attached to the notebook instance.

Method

GoString

func (s DescribeNotebookInstanceOutput) GoString() string

GoString returns the string representation

SetAcceleratorTypes

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

SetAcceleratorTypes sets the AcceleratorTypes field's value.

SetAdditionalCodeRepositories

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

SetAdditionalCodeRepositories sets the AdditionalCodeRepositories field's value.

SetCreationTime

func (s *DescribeNotebookInstanceOutput) SetCreationTime(v time.Time) *DescribeNotebookInstanceOutput

SetCreationTime sets the CreationTime field's value.

SetDefaultCodeRepository

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

SetDefaultCodeRepository sets the DefaultCodeRepository field's value.

SetDirectInternetAccess

func (s *DescribeNotebookInstanceOutput) SetDirectInternetAccess(v string) *DescribeNotebookInstanceOutput

SetDirectInternetAccess sets the DirectInternetAccess field's value.

SetFailureReason

func (s *DescribeNotebookInstanceOutput) SetFailureReason(v string) *DescribeNotebookInstanceOutput

SetFailureReason sets the FailureReason field's value.

SetInstanceType

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

SetInstanceType sets the InstanceType field's value.

SetKmsKeyId

func (s *DescribeNotebookInstanceOutput) SetKmsKeyId(v string) *DescribeNotebookInstanceOutput

SetKmsKeyId sets the KmsKeyId field's value.

SetLastModifiedTime

func (s *DescribeNotebookInstanceOutput) SetLastModifiedTime(v time.Time) *DescribeNotebookInstanceOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

SetNetworkInterfaceId

func (s *DescribeNotebookInstanceOutput) SetNetworkInterfaceId(v string) *DescribeNotebookInstanceOutput

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

SetNotebookInstanceArn

func (s *DescribeNotebookInstanceOutput) SetNotebookInstanceArn(v string) *DescribeNotebookInstanceOutput

SetNotebookInstanceArn sets the NotebookInstanceArn field's value.

SetNotebookInstanceLifecycleConfigName

func (s *DescribeNotebookInstanceOutput) SetNotebookInstanceLifecycleConfigName(v string) *DescribeNotebookInstanceOutput

SetNotebookInstanceLifecycleConfigName sets the NotebookInstanceLifecycleConfigName field's value.

SetNotebookInstanceName

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

SetNotebookInstanceName sets the NotebookInstanceName field's value.

SetNotebookInstanceStatus

func (s *DescribeNotebookInstanceOutput) SetNotebookInstanceStatus(v string) *DescribeNotebookInstanceOutput

SetNotebookInstanceStatus sets the NotebookInstanceStatus field's value.

SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

SetSecurityGroups

func (s *DescribeNotebookInstanceOutput) SetSecurityGroups(v []*string) *DescribeNotebookInstanceOutput

SetSecurityGroups sets the SecurityGroups field's value.

SetSubnetId

func (s *DescribeNotebookInstanceOutput) SetSubnetId(v string) *DescribeNotebookInstanceOutput

SetSubnetId sets the SubnetId field's value.

SetUrl

func (s *DescribeNotebookInstanceOutput) SetUrl(v string) *DescribeNotebookInstanceOutput

SetUrl sets the Url field's value.

SetVolumeSizeInGB

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

SetVolumeSizeInGB sets the VolumeSizeInGB field's value.

String

func (s DescribeNotebookInstanceOutput) String() string

String returns the string representation

On this page: