DescribeNotebookInstanceResult (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.sagemaker.model

Class DescribeNotebookInstanceResult

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.sagemaker.model.DescribeNotebookInstanceResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeNotebookInstanceResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeNotebookInstanceResult ()

Constructors
Constructor and Description
`DescribeNotebookInstanceResult ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`DescribeNotebookInstanceResult`	`clone ()`
`boolean`	`equals (Object obj)`
`List<String>`	`getAcceleratorTypes ()` A list of the Elastic Inference (EI) instance types associated with this notebook instance.
`List<String>`	`getAdditionalCodeRepositories ()` An array of up to three Git repositories associated with the notebook instance.
`Date`	`getCreationTime ()` A timestamp.
`String`	`getDefaultCodeRepository ()` The Git repository associated with the notebook instance as its default code repository.
`String`	`getDirectInternetAccess ()` Describes whether SageMaker provides internet access to the notebook instance.
`String`	`getFailureReason ()` If status is `Failed`, the reason it failed.
`InstanceMetadataServiceConfiguration`	`getInstanceMetadataServiceConfiguration ()` Information on the IMDS configuration of the notebook instance
`String`	`getInstanceType ()` The type of ML compute instance running on the notebook instance.
`String`	`getKmsKeyId ()` The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
`Date`	`getLastModifiedTime ()` A timestamp.
`String`	`getNetworkInterfaceId ()` The network interface IDs that SageMaker created at the time of creating the instance.
`String`	`getNotebookInstanceArn ()` The Amazon Resource Name (ARN) of the notebook instance.
`String`	`getNotebookInstanceLifecycleConfigName ()` Returns the name of a notebook instance lifecycle configuration.
`String`	`getNotebookInstanceName ()` The name of the SageMaker notebook instance.
`String`	`getNotebookInstanceStatus ()` The status of the notebook instance.
`String`	`getPlatformIdentifier ()` The platform identifier of the notebook instance runtime environment.
`String`	`getRoleArn ()` The Amazon Resource Name (ARN) of the IAM role associated with the instance.
`String`	`getRootAccess ()` Whether root access is enabled or disabled for users of the notebook instance.
`List<String>`	`getSecurityGroups ()` The IDs of the VPC security groups.
`String`	`getSubnetId ()` The ID of the VPC subnet.
`String`	`getUrl ()` The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
`Integer`	`getVolumeSizeInGB ()` The size, in GB, of the ML storage volume attached to the notebook instance.
`int`	`hashCode ()`
`void`	`setAcceleratorTypes (Collection<String> acceleratorTypes)` A list of the Elastic Inference (EI) instance types associated with this notebook instance.
`void`	`setAdditionalCodeRepositories (Collection<String> additionalCodeRepositories)` An array of up to three Git repositories associated with the notebook instance.
`void`	`setCreationTime (Date creationTime)` A timestamp.
`void`	`setDefaultCodeRepository (String defaultCodeRepository)` The Git repository associated with the notebook instance as its default code repository.
`void`	`setDirectInternetAccess (String directInternetAccess)` Describes whether SageMaker provides internet access to the notebook instance.
`void`	`setFailureReason (String failureReason)` If status is `Failed`, the reason it failed.
`void`	`setInstanceMetadataServiceConfiguration (InstanceMetadataServiceConfiguration instanceMetadataServiceConfiguration)` Information on the IMDS configuration of the notebook instance
`void`	`setInstanceType (String instanceType)` The type of ML compute instance running on the notebook instance.
`void`	`setKmsKeyId (String kmsKeyId)` The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
`void`	`setLastModifiedTime (Date lastModifiedTime)` A timestamp.
`void`	`setNetworkInterfaceId (String networkInterfaceId)` The network interface IDs that SageMaker created at the time of creating the instance.
`void`	`setNotebookInstanceArn (String notebookInstanceArn)` The Amazon Resource Name (ARN) of the notebook instance.
`void`	`setNotebookInstanceLifecycleConfigName (String notebookInstanceLifecycleConfigName)` Returns the name of a notebook instance lifecycle configuration.
`void`	`setNotebookInstanceName (String notebookInstanceName)` The name of the SageMaker notebook instance.
`void`	`setNotebookInstanceStatus (String notebookInstanceStatus)` The status of the notebook instance.
`void`	`setPlatformIdentifier (String platformIdentifier)` The platform identifier of the notebook instance runtime environment.
`void`	`setRoleArn (String roleArn)` The Amazon Resource Name (ARN) of the IAM role associated with the instance.
`void`	`setRootAccess (String rootAccess)` Whether root access is enabled or disabled for users of the notebook instance.
`void`	`setSecurityGroups (Collection<String> securityGroups)` The IDs of the VPC security groups.
`void`	`setSubnetId (String subnetId)` The ID of the VPC subnet.
`void`	`setUrl (String url)` The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
`void`	`setVolumeSizeInGB (Integer volumeSizeInGB)` The size, in GB, of the ML storage volume attached to the notebook instance.
`String`	`toString ()` Returns a string representation of this object.
`DescribeNotebookInstanceResult`	`withAcceleratorTypes (Collection<String> acceleratorTypes)` A list of the Elastic Inference (EI) instance types associated with this notebook instance.
`DescribeNotebookInstanceResult`	`withAcceleratorTypes (NotebookInstanceAcceleratorType... acceleratorTypes)` A list of the Elastic Inference (EI) instance types associated with this notebook instance.
`DescribeNotebookInstanceResult`	`withAcceleratorTypes (String... acceleratorTypes)` A list of the Elastic Inference (EI) instance types associated with this notebook instance.
`DescribeNotebookInstanceResult`	`withAdditionalCodeRepositories (Collection<String> additionalCodeRepositories)` An array of up to three Git repositories associated with the notebook instance.
`DescribeNotebookInstanceResult`	`withAdditionalCodeRepositories (String... additionalCodeRepositories)` An array of up to three Git repositories associated with the notebook instance.
`DescribeNotebookInstanceResult`	`withCreationTime (Date creationTime)` A timestamp.
`DescribeNotebookInstanceResult`	`withDefaultCodeRepository (String defaultCodeRepository)` The Git repository associated with the notebook instance as its default code repository.
`DescribeNotebookInstanceResult`	`withDirectInternetAccess (DirectInternetAccess directInternetAccess)` Describes whether SageMaker provides internet access to the notebook instance.
`DescribeNotebookInstanceResult`	`withDirectInternetAccess (String directInternetAccess)` Describes whether SageMaker provides internet access to the notebook instance.
`DescribeNotebookInstanceResult`	`withFailureReason (String failureReason)` If status is `Failed`, the reason it failed.
`DescribeNotebookInstanceResult`	`withInstanceMetadataServiceConfiguration (InstanceMetadataServiceConfiguration instanceMetadataServiceConfiguration)` Information on the IMDS configuration of the notebook instance
`DescribeNotebookInstanceResult`	`withInstanceType (InstanceType instanceType)` The type of ML compute instance running on the notebook instance.
`DescribeNotebookInstanceResult`	`withInstanceType (String instanceType)` The type of ML compute instance running on the notebook instance.
`DescribeNotebookInstanceResult`	`withKmsKeyId (String kmsKeyId)` The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
`DescribeNotebookInstanceResult`	`withLastModifiedTime (Date lastModifiedTime)` A timestamp.
`DescribeNotebookInstanceResult`	`withNetworkInterfaceId (String networkInterfaceId)` The network interface IDs that SageMaker created at the time of creating the instance.
`DescribeNotebookInstanceResult`	`withNotebookInstanceArn (String notebookInstanceArn)` The Amazon Resource Name (ARN) of the notebook instance.
`DescribeNotebookInstanceResult`	`withNotebookInstanceLifecycleConfigName (String notebookInstanceLifecycleConfigName)` Returns the name of a notebook instance lifecycle configuration.
`DescribeNotebookInstanceResult`	`withNotebookInstanceName (String notebookInstanceName)` The name of the SageMaker notebook instance.
`DescribeNotebookInstanceResult`	`withNotebookInstanceStatus (NotebookInstanceStatus notebookInstanceStatus)` The status of the notebook instance.
`DescribeNotebookInstanceResult`	`withNotebookInstanceStatus (String notebookInstanceStatus)` The status of the notebook instance.
`DescribeNotebookInstanceResult`	`withPlatformIdentifier (String platformIdentifier)` The platform identifier of the notebook instance runtime environment.
`DescribeNotebookInstanceResult`	`withRoleArn (String roleArn)` The Amazon Resource Name (ARN) of the IAM role associated with the instance.
`DescribeNotebookInstanceResult`	`withRootAccess (RootAccess rootAccess)` Whether root access is enabled or disabled for users of the notebook instance.
`DescribeNotebookInstanceResult`	`withRootAccess (String rootAccess)` Whether root access is enabled or disabled for users of the notebook instance.
`DescribeNotebookInstanceResult`	`withSecurityGroups (Collection<String> securityGroups)` The IDs of the VPC security groups.
`DescribeNotebookInstanceResult`	`withSecurityGroups (String... securityGroups)` The IDs of the VPC security groups.
`DescribeNotebookInstanceResult`	`withSubnetId (String subnetId)` The ID of the VPC subnet.
`DescribeNotebookInstanceResult`	`withUrl (String url)` The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
`DescribeNotebookInstanceResult`	`withVolumeSizeInGB (Integer volumeSizeInGB)` The size, in GB, of the ML storage volume attached to the notebook instance.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeNotebookInstanceResult
```
public DescribeNotebookInstanceResult()
```
- Method Detail
  - setNotebookInstanceArn
```
public void setNotebookInstanceArn(String notebookInstanceArn)
```
    The Amazon Resource Name (ARN) of the notebook instance.
    
    Parameters:
    
    notebookInstanceArn - The Amazon Resource Name (ARN) of the notebook instance.
  - getNotebookInstanceArn
```
public String getNotebookInstanceArn()
```
    The Amazon Resource Name (ARN) of the notebook instance.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the notebook instance.
  - withNotebookInstanceArn
```
public DescribeNotebookInstanceResult withNotebookInstanceArn(String notebookInstanceArn)
```
    The Amazon Resource Name (ARN) of the notebook instance.
    
    Parameters:
    
    notebookInstanceArn - The Amazon Resource Name (ARN) of the notebook instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotebookInstanceName
```
public void setNotebookInstanceName(String notebookInstanceName)
```
    The name of the SageMaker notebook instance.
    
    Parameters:
    
    notebookInstanceName - The name of the SageMaker notebook instance.
  - getNotebookInstanceName
```
public String getNotebookInstanceName()
```
    The name of the SageMaker notebook instance.
    
    Returns:
    
    The name of the SageMaker notebook instance.
  - withNotebookInstanceName
```
public DescribeNotebookInstanceResult withNotebookInstanceName(String notebookInstanceName)
```
    The name of the SageMaker notebook instance.
    
    Parameters:
    
    notebookInstanceName - The name of the SageMaker notebook instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotebookInstanceStatus
```
public void setNotebookInstanceStatus(String notebookInstanceStatus)
```
    The status of the notebook instance.
    
    Parameters:
    
    notebookInstanceStatus - The status of the notebook instance.
    
    See Also:
    
    NotebookInstanceStatus
  - getNotebookInstanceStatus
```
public String getNotebookInstanceStatus()
```
    The status of the notebook instance.
    
    Returns:
    
    The status of the notebook instance.
    
    See Also:
    
    NotebookInstanceStatus
  - withNotebookInstanceStatus
```
public DescribeNotebookInstanceResult withNotebookInstanceStatus(String notebookInstanceStatus)
```
    The status of the notebook instance.
    
    Parameters:
    
    notebookInstanceStatus - The status of the notebook instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotebookInstanceStatus
  - withNotebookInstanceStatus
```
public DescribeNotebookInstanceResult withNotebookInstanceStatus(NotebookInstanceStatus notebookInstanceStatus)
```
    The status of the notebook instance.
    
    Parameters:
    
    notebookInstanceStatus - The status of the notebook instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotebookInstanceStatus
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    If status is Failed, the reason it failed.
    
    Parameters:
    
    failureReason - If status is Failed, the reason it failed.
  - getFailureReason
```
public String getFailureReason()
```
    If status is Failed, the reason it failed.
    
    Returns:
    
    If status is Failed, the reason it failed.
  - withFailureReason
```
public DescribeNotebookInstanceResult withFailureReason(String failureReason)
```
    If status is Failed, the reason it failed.
    
    Parameters:
    
    failureReason - If status is Failed, the reason it failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUrl
```
public void setUrl(String url)
```
    The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
    
    Parameters:
    
    url - The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
  - getUrl
```
public String getUrl()
```
    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.
  - withUrl
```
public DescribeNotebookInstanceResult withUrl(String url)
```
    The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
    
    Parameters:
    
    url - The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceType
```
public void setInstanceType(String instanceType)
```
    The type of ML compute instance running on the notebook instance.
    
    Parameters:
    
    instanceType - The type of ML compute instance running on the notebook instance.
    
    See Also:
    
    InstanceType
  - getInstanceType
```
public String getInstanceType()
```
    The type of ML compute instance running on the notebook instance.
    
    Returns:
    
    The type of ML compute instance running on the notebook instance.
    
    See Also:
    
    InstanceType
  - withInstanceType
```
public DescribeNotebookInstanceResult withInstanceType(String instanceType)
```
    The type of ML compute instance running on the notebook instance.
    
    Parameters:
    
    instanceType - The type of ML compute instance running on the notebook instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InstanceType
  - withInstanceType
```
public DescribeNotebookInstanceResult withInstanceType(InstanceType instanceType)
```
    The type of ML compute instance running on the notebook instance.
    
    Parameters:
    
    instanceType - The type of ML compute instance running on the notebook instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InstanceType
  - setSubnetId
```
public void setSubnetId(String subnetId)
```
    The ID of the VPC subnet.
    
    Parameters:
    
    subnetId - The ID of the VPC subnet.
  - getSubnetId
```
public String getSubnetId()
```
    The ID of the VPC subnet.
    
    Returns:
    
    The ID of the VPC subnet.
  - withSubnetId
```
public DescribeNotebookInstanceResult withSubnetId(String subnetId)
```
    The ID of the VPC subnet.
    
    Parameters:
    
    subnetId - The ID of the VPC subnet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSecurityGroups
```
public List<String> getSecurityGroups()
```
    The IDs of the VPC security groups.
    
    Returns:
    
    The IDs of the VPC security groups.
  - setSecurityGroups
```
public void setSecurityGroups(Collection<String> securityGroups)
```
    The IDs of the VPC security groups.
    
    Parameters:
    
    securityGroups - The IDs of the VPC security groups.
  - withSecurityGroups
```
public DescribeNotebookInstanceResult withSecurityGroups(String... securityGroups)
```
    The IDs of the VPC security groups.
    
    NOTE: This method appends the values to the existing list (if any). Use setSecurityGroups(java.util.Collection) or withSecurityGroups(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    securityGroups - The IDs of the VPC security groups.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSecurityGroups
```
public DescribeNotebookInstanceResult withSecurityGroups(Collection<String> securityGroups)
```
    The IDs of the VPC security groups.
    
    Parameters:
    
    securityGroups - The IDs of the VPC security groups.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the IAM role associated with the instance.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the IAM role associated with the instance.
  - getRoleArn
```
public String getRoleArn()
```
    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.
  - withRoleArn
```
public DescribeNotebookInstanceResult withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the IAM role associated with the instance.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the IAM role associated with the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
    
    Parameters:
    
    kmsKeyId - The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
    
    Returns:
    
    The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
  - withKmsKeyId
```
public DescribeNotebookInstanceResult withKmsKeyId(String kmsKeyId)
```
    The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
    
    Parameters:
    
    kmsKeyId - The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNetworkInterfaceId
```
public void setNetworkInterfaceId(String networkInterfaceId)
```
    The network interface IDs that SageMaker created at the time of creating the instance.
    
    Parameters:
    
    networkInterfaceId - The network interface IDs that SageMaker created at the time of creating the instance.
  - getNetworkInterfaceId
```
public String getNetworkInterfaceId()
```
    The network interface IDs that SageMaker created at the time of creating the instance.
    
    Returns:
    
    The network interface IDs that SageMaker created at the time of creating the instance.
  - withNetworkInterfaceId
```
public DescribeNotebookInstanceResult withNetworkInterfaceId(String networkInterfaceId)
```
    The network interface IDs that SageMaker created at the time of creating the instance.
    
    Parameters:
    
    networkInterfaceId - The network interface IDs that SageMaker created at the time of creating the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
    
    Parameters:
    
    lastModifiedTime - A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    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.
  - withLastModifiedTime
```
public DescribeNotebookInstanceResult withLastModifiedTime(Date lastModifiedTime)
```
    A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
    
    Parameters:
    
    lastModifiedTime - A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    A timestamp. Use this parameter to return the time when the notebook instance was created
    
    Parameters:
    
    creationTime - A timestamp. Use this parameter to return the time when the notebook instance was created
  - getCreationTime
```
public Date getCreationTime()
```
    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
  - withCreationTime
```
public DescribeNotebookInstanceResult withCreationTime(Date creationTime)
```
    A timestamp. Use this parameter to return the time when the notebook instance was created
    
    Parameters:
    
    creationTime - A timestamp. Use this parameter to return the time when the notebook instance was created
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotebookInstanceLifecycleConfigName
```
public void setNotebookInstanceLifecycleConfigName(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
    
    Parameters:
    
    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
  - getNotebookInstanceLifecycleConfigName
```
public String getNotebookInstanceLifecycleConfigName()
```
    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
  - withNotebookInstanceLifecycleConfigName
```
public DescribeNotebookInstanceResult withNotebookInstanceLifecycleConfigName(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
    
    Parameters:
    
    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 a reference to this object so that method calls can be chained together.
  - setDirectInternetAccess
```
public void setDirectInternetAccess(String directInternetAccess)
```
    Describes whether 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 SageMaker training and endpoint services.
    
    For more information, see Notebook Instances Are Internet-Enabled by Default.
    
    Parameters:
    
    directInternetAccess - Describes whether 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 SageMaker training and endpoint services.
    
    For more information, see Notebook Instances Are Internet-Enabled by Default.
    
    See Also:
    
    DirectInternetAccess
  - getDirectInternetAccess
```
public String getDirectInternetAccess()
```
    Describes whether 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 SageMaker training and endpoint services.
    
    For more information, see Notebook Instances Are Internet-Enabled by Default.
    
    Returns:
    
    Describes whether 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 SageMaker training and endpoint services.
    
    For more information, see Notebook Instances Are Internet-Enabled by Default.
    
    See Also:
    
    DirectInternetAccess
  - withDirectInternetAccess
```
public DescribeNotebookInstanceResult withDirectInternetAccess(String directInternetAccess)
```
    Describes whether 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 SageMaker training and endpoint services.
    
    For more information, see Notebook Instances Are Internet-Enabled by Default.
    
    Parameters:
    
    directInternetAccess - Describes whether 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 SageMaker training and endpoint services.
    
    For more information, see Notebook Instances Are Internet-Enabled by Default.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DirectInternetAccess
  - withDirectInternetAccess
```
public DescribeNotebookInstanceResult withDirectInternetAccess(DirectInternetAccess directInternetAccess)
```
    Describes whether 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 SageMaker training and endpoint services.
    
    For more information, see Notebook Instances Are Internet-Enabled by Default.
    
    Parameters:
    
    directInternetAccess - Describes whether 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 SageMaker training and endpoint services.
    
    For more information, see Notebook Instances Are Internet-Enabled by Default.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DirectInternetAccess
  - setVolumeSizeInGB
```
public void setVolumeSizeInGB(Integer volumeSizeInGB)
```
    The size, in GB, of the ML storage volume attached to the notebook instance.
    
    Parameters:
    
    volumeSizeInGB - The size, in GB, of the ML storage volume attached to the notebook instance.
  - getVolumeSizeInGB
```
public Integer getVolumeSizeInGB()
```
    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.
  - withVolumeSizeInGB
```
public DescribeNotebookInstanceResult withVolumeSizeInGB(Integer volumeSizeInGB)
```
    The size, in GB, of the ML storage volume attached to the notebook instance.
    
    Parameters:
    
    volumeSizeInGB - The size, in GB, of the ML storage volume attached to the notebook instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAcceleratorTypes
```
public List<String> getAcceleratorTypes()
```
    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.
    
    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.
    
    See Also:
    
    NotebookInstanceAcceleratorType
  - setAcceleratorTypes
```
public void setAcceleratorTypes(Collection<String> 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    NotebookInstanceAcceleratorType
  - withAcceleratorTypes
```
public DescribeNotebookInstanceResult withAcceleratorTypes(String... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAcceleratorTypes(java.util.Collection) or withAcceleratorTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotebookInstanceAcceleratorType
  - withAcceleratorTypes
```
public DescribeNotebookInstanceResult withAcceleratorTypes(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotebookInstanceAcceleratorType
  - withAcceleratorTypes
```
public DescribeNotebookInstanceResult withAcceleratorTypes(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotebookInstanceAcceleratorType
  - setDefaultCodeRepository
```
public void setDefaultCodeRepository(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 Amazon Web Services 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 SageMaker Notebook Instances.
    
    Parameters:
    
    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 Amazon Web Services 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 SageMaker Notebook Instances.
  - getDefaultCodeRepository
```
public String getDefaultCodeRepository()
```
    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 Amazon Web Services 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 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 Amazon Web Services 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 SageMaker Notebook Instances.
  - withDefaultCodeRepository
```
public DescribeNotebookInstanceResult withDefaultCodeRepository(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 Amazon Web Services 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 SageMaker Notebook Instances.
    
    Parameters:
    
    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 Amazon Web Services 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 SageMaker Notebook Instances.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAdditionalCodeRepositories
```
public List<String> getAdditionalCodeRepositories()
```
    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 Amazon Web Services 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 SageMaker Notebook Instances.
    
    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 Amazon Web Services 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 SageMaker Notebook Instances.
  - setAdditionalCodeRepositories
```
public void setAdditionalCodeRepositories(Collection<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 Amazon Web Services 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 SageMaker Notebook Instances.
    
    Parameters:
    
    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 Amazon Web Services 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 SageMaker Notebook Instances.
  - withAdditionalCodeRepositories
```
public DescribeNotebookInstanceResult withAdditionalCodeRepositories(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 Amazon Web Services 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 SageMaker Notebook Instances.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdditionalCodeRepositories(java.util.Collection) or withAdditionalCodeRepositories(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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 Amazon Web Services 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 SageMaker Notebook Instances.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdditionalCodeRepositories
```
public DescribeNotebookInstanceResult withAdditionalCodeRepositories(Collection<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 Amazon Web Services 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 SageMaker Notebook Instances.
    
    Parameters:
    
    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 Amazon Web Services 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 SageMaker Notebook Instances.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRootAccess
```
public void setRootAccess(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    RootAccess
  - getRootAccess
```
public String getRootAccess()
```
    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.
    
    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
  - withRootAccess
```
public DescribeNotebookInstanceResult withRootAccess(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RootAccess
  - withRootAccess
```
public DescribeNotebookInstanceResult withRootAccess(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RootAccess
  - setPlatformIdentifier
```
public void setPlatformIdentifier(String platformIdentifier)
```
    The platform identifier of the notebook instance runtime environment.
    
    Parameters:
    
    platformIdentifier - The platform identifier of the notebook instance runtime environment.
  - getPlatformIdentifier
```
public String getPlatformIdentifier()
```
    The platform identifier of the notebook instance runtime environment.
    
    Returns:
    
    The platform identifier of the notebook instance runtime environment.
  - withPlatformIdentifier
```
public DescribeNotebookInstanceResult withPlatformIdentifier(String platformIdentifier)
```
    The platform identifier of the notebook instance runtime environment.
    
    Parameters:
    
    platformIdentifier - The platform identifier of the notebook instance runtime environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceMetadataServiceConfiguration
```
public void setInstanceMetadataServiceConfiguration(InstanceMetadataServiceConfiguration instanceMetadataServiceConfiguration)
```
    Information on the IMDS configuration of the notebook instance
    
    Parameters:
    
    instanceMetadataServiceConfiguration - Information on the IMDS configuration of the notebook instance
  - getInstanceMetadataServiceConfiguration
```
public InstanceMetadataServiceConfiguration getInstanceMetadataServiceConfiguration()
```
    Information on the IMDS configuration of the notebook instance
    
    Returns:
    
    Information on the IMDS configuration of the notebook instance
  - withInstanceMetadataServiceConfiguration
```
public DescribeNotebookInstanceResult withInstanceMetadataServiceConfiguration(InstanceMetadataServiceConfiguration instanceMetadataServiceConfiguration)
```
    Information on the IMDS configuration of the notebook instance
    
    Parameters:
    
    instanceMetadataServiceConfiguration - Information on the IMDS configuration of the notebook instance
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeNotebookInstanceResult clone()
```
    Overrides:
    
    clone in class Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class DescribeNotebookInstanceResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeNotebookInstanceResult

Method Detail

setNotebookInstanceArn

getNotebookInstanceArn

withNotebookInstanceArn

setNotebookInstanceName

getNotebookInstanceName

withNotebookInstanceName

setNotebookInstanceStatus

getNotebookInstanceStatus

withNotebookInstanceStatus

withNotebookInstanceStatus

setFailureReason

getFailureReason

withFailureReason

setUrl

getUrl

withUrl

setInstanceType

getInstanceType

withInstanceType

withInstanceType

setSubnetId

getSubnetId

withSubnetId

getSecurityGroups

setSecurityGroups

withSecurityGroups

withSecurityGroups

setRoleArn

getRoleArn

withRoleArn

setKmsKeyId

getKmsKeyId

withKmsKeyId

setNetworkInterfaceId

getNetworkInterfaceId

withNetworkInterfaceId

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

setCreationTime

getCreationTime

withCreationTime

setNotebookInstanceLifecycleConfigName

getNotebookInstanceLifecycleConfigName

withNotebookInstanceLifecycleConfigName

setDirectInternetAccess

getDirectInternetAccess

withDirectInternetAccess

withDirectInternetAccess

setVolumeSizeInGB

getVolumeSizeInGB

withVolumeSizeInGB

getAcceleratorTypes

setAcceleratorTypes

withAcceleratorTypes

withAcceleratorTypes

withAcceleratorTypes

setDefaultCodeRepository

getDefaultCodeRepository

withDefaultCodeRepository

getAdditionalCodeRepositories

setAdditionalCodeRepositories

withAdditionalCodeRepositories

withAdditionalCodeRepositories

setRootAccess

getRootAccess

withRootAccess

withRootAccess

setPlatformIdentifier

getPlatformIdentifier

withPlatformIdentifier