@Generated(value="software.amazon.awssdk:codegen") public final class DescribeNotebookInstanceResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeNotebookInstanceResponse.Builder,DescribeNotebookInstanceResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeNotebookInstanceResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeNotebookInstanceResponse.Builder |
builder() |
Instant |
creationTime()
A timestamp.
|
boolean |
equals(Object obj) |
String |
failureReason()
If staus 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 |
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<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.
|
sdkHttpResponse
copy
public String notebookInstanceArn()
The Amazon Resource Name (ARN) of the notebook instance.
public String notebookInstanceName()
Name of the Amazon SageMaker notebook instance.
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()
.
NotebookInstanceStatus
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()
.
NotebookInstanceStatus
public String failureReason()
If staus is failed, the reason it failed.
public String url()
The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
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()
.
InstanceType
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()
.
InstanceType
public String subnetId()
The ID of the VPC subnet.
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.
public String roleArn()
Amazon Resource Name (ARN) of the IAM role associated with the instance.
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.
public String networkInterfaceId()
Network interface IDs that Amazon SageMaker created at the time of creating the instance.
public Instant lastModifiedTime()
A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
public Instant creationTime()
A timestamp. Use this parameter to return the time when the notebook instance was created
public DescribeNotebookInstanceResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeNotebookInstanceResponse.Builder,DescribeNotebookInstanceResponse>
toBuilder
in class AwsResponse
public static DescribeNotebookInstanceResponse.Builder builder()
public static Class<? extends DescribeNotebookInstanceResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
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.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.