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 three 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)
boolean	equalsBySdkFields(Object obj)
String	failureReason() If status is Failed, the reason it failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAcceleratorTypes() Returns true if the AcceleratorTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasAdditionalCodeRepositories() Returns true if the AdditionalCodeRepositories property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasSecurityGroups() Returns true if the SecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() The 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() The 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() The 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() The Amazon Resource Name (ARN) of the IAM role associated with the instance.
RootAccess	rootAccess() Whether root access is enabled or disabled for users of the notebook instance.
String	rootAccessAsString() Whether root access is enabled or disabled for users of the notebook 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()
String	toString() Returns a string representation of this object.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

notebookInstanceArn

public final String notebookInstanceArn()

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

Returns:

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

notebookInstanceName

public final String notebookInstanceName()

The name of the Amazon SageMaker notebook instance.

Returns:

The name of the Amazon SageMaker notebook instance.

notebookInstanceStatus

public final 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 final 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 final String failureReason()

If status is Failed, the reason it failed.

Returns:

If status is Failed, the reason it failed.

url

public final 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 final 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 final 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 final String subnetId()

The ID of the VPC subnet.

Returns:

The ID of the VPC subnet.

hasSecurityGroups

public final boolean hasSecurityGroups()

Returns true if the SecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

securityGroups

public final List<String> securityGroups()

The IDs of the VPC security groups.

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

You can use hasSecurityGroups() to see if a value was sent in this field.

Returns:

The IDs of the VPC security groups.

roleArn

public final String roleArn()

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

Returns:

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

kmsKeyId

public final String kmsKeyId()

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

Returns:

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

networkInterfaceId

public final String networkInterfaceId()

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

Returns:

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

lastModifiedTime

public final 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 final 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 final 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 final DirectInternetAccess directInternetAccess()

Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the 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, the 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 final String directInternetAccessAsString()

Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the 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, the 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 final 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 final 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.

You can use hasAcceleratorTypes() to see if a value was sent in this field.

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.

hasAcceleratorTypes

public final boolean hasAcceleratorTypes()

Returns true if the AcceleratorTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

acceleratorTypesAsStrings

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

You can use hasAcceleratorTypes() to see if a value was sent in this field.

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

hasAdditionalCodeRepositories

public final boolean hasAdditionalCodeRepositories()

Returns true if the AdditionalCodeRepositories property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

additionalCodeRepositories

public final List<String> additionalCodeRepositories()

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

You can use hasAdditionalCodeRepositories() to see if a value was sent in this field.

Returns:

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

rootAccess

public final RootAccess rootAccess()

Whether root access is enabled or disabled for users of the notebook instance.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

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

Returns:

Whether root access is enabled or disabled for users of the notebook instance.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

See Also:

RootAccess

rootAccessAsString

public final String rootAccessAsString()

Whether root access is enabled or disabled for users of the notebook instance.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

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

Returns:

Whether root access is enabled or disabled for users of the notebook instance.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

See Also:

RootAccess

toBuilder

public DescribeNotebookInstanceResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeNotebookInstanceResponse.Builder,DescribeNotebookInstanceResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeNotebookInstanceResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo