software.amazon.awssdk.services.sagemaker.model

Class DescribeNotebookInstanceResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

software.amazon.awssdk.services.sagemaker.model.DescribeNotebookInstanceResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeNotebookInstanceResponse.Builder,DescribeNotebookInstanceResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeNotebookInstanceResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeNotebookInstanceResponse.Builder,DescribeNotebookInstanceResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeNotebookInstanceResponse.Builder

Method Summary

Modifier and Type	Method and Description
List<NotebookInstanceAcceleratorType>	acceleratorTypes() A list of the Elastic Inference (EI) instance types associated with this notebook instance.
List<String>	acceleratorTypesAsStrings() A list of the Elastic Inference (EI) instance types associated with this notebook instance.
List<String>	additionalCodeRepositories() An array of up to 3 git repositories associated with the notebook instance.
static DescribeNotebookInstanceResponse.Builder	builder()
Instant	creationTime() A timestamp.
String	defaultCodeRepository() The git repository associated with the notebook instance as its default code repository.
DirectInternetAccess	directInternetAccess() Describes whether Amazon SageMaker provides internet access to the notebook instance.
String	directInternetAccessAsString() Describes whether Amazon SageMaker provides internet access to the notebook instance.
boolean	equals(Object obj)
String	failureReason() If status is failed, the reason it failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
InstanceType	instanceType() The type of ML compute instance running on the notebook instance.
String	instanceTypeAsString() The type of ML compute instance running on the notebook instance.
String	kmsKeyId() AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
Instant	lastModifiedTime() A timestamp.
String	networkInterfaceId() Network interface IDs that Amazon SageMaker created at the time of creating the instance.
String	notebookInstanceArn() The Amazon Resource Name (ARN) of the notebook instance.
String	notebookInstanceLifecycleConfigName() Returns the name of a notebook instance lifecycle configuration.
String	notebookInstanceName() Name of the Amazon SageMaker notebook instance.
NotebookInstanceStatus	notebookInstanceStatus() The status of the notebook instance.
String	notebookInstanceStatusAsString() The status of the notebook instance.
String	roleArn() Amazon Resource Name (ARN) of the IAM role associated with the instance.
List<SdkField<?>>	sdkFields()
List<String>	securityGroups() The IDs of the VPC security groups.
static Class<? extends DescribeNotebookInstanceResponse.Builder>	serializableBuilderClass()
String	subnetId() The ID of the VPC subnet.
DescribeNotebookInstanceResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	url() The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
Integer	volumeSizeInGB() The size, in GB, of the ML storage volume attached to the notebook instance.

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

notebookInstanceArn

public String notebookInstanceArn()

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

Returns:

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

notebookInstanceName

public String notebookInstanceName()

Name of the Amazon SageMaker notebook instance.

Returns:

Name of the Amazon SageMaker notebook instance.

notebookInstanceStatus

public NotebookInstanceStatus notebookInstanceStatus()

The status of the notebook instance.

If the service returns an enum value that is not available in the current SDK version, notebookInstanceStatus will return NotebookInstanceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from notebookInstanceStatusAsString().

Returns:

The status of the notebook instance.

See Also:

NotebookInstanceStatus

notebookInstanceStatusAsString

public String notebookInstanceStatusAsString()

The status of the notebook instance.

If the service returns an enum value that is not available in the current SDK version, notebookInstanceStatus will return NotebookInstanceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from notebookInstanceStatusAsString().

Returns:

The status of the notebook instance.

See Also:

NotebookInstanceStatus

failureReason

public String failureReason()

If status is failed, the reason it failed.

Returns:

If status is failed, the reason it failed.

url

public String url()

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

Returns:

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

instanceType

public InstanceType instanceType()

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

If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

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

See Also:

InstanceType

instanceTypeAsString

public String instanceTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

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

See Also:

InstanceType

subnetId

public String subnetId()

The ID of the VPC subnet.

Returns:

The ID of the VPC subnet.

securityGroups

public List<String> securityGroups()

The IDs of the VPC security groups.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The IDs of the VPC security groups.

roleArn

public String roleArn()

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

Returns:

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

kmsKeyId

public String kmsKeyId()

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

Returns:

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

networkInterfaceId

public String networkInterfaceId()

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

Returns:

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

lastModifiedTime

public Instant lastModifiedTime()

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

Returns:

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

creationTime

public Instant creationTime()

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

Returns:

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

notebookInstanceLifecycleConfigName

public String notebookInstanceLifecycleConfigName()

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

Returns:

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

directInternetAccess

public DirectInternetAccess directInternetAccess()

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.

If the service returns an enum value that is not available in the current SDK version, directInternetAccess will return DirectInternetAccess.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directInternetAccessAsString().

Returns:

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.

See Also:

DirectInternetAccess

directInternetAccessAsString

public String directInternetAccessAsString()

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.

If the service returns an enum value that is not available in the current SDK version, directInternetAccess will return DirectInternetAccess.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directInternetAccessAsString().

Returns:

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.

See Also:

DirectInternetAccess

volumeSizeInGB

public Integer volumeSizeInGB()

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

Returns:

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

acceleratorTypes

public List<NotebookInstanceAcceleratorType> acceleratorTypes()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

acceleratorTypesAsStrings

public List<String> acceleratorTypesAsStrings()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

defaultCodeRepository

public String defaultCodeRepository()

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

Returns:

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

additionalCodeRepositories

public List<String> additionalCodeRepositories()

An array of up to 3 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 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

An array of up to 3 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 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.

toBuilder

public DescribeNotebookInstanceResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeNotebookInstanceResponse.Builder,DescribeNotebookInstanceResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeNotebookInstanceResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeNotebookInstanceResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.