Package 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("software.amazon.awssdk:codegen") public final class DescribeNotebookInstanceResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeNotebookInstanceResponse.Builder,DescribeNotebookInstanceResponse>

  • Method Details

    • 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 SageMaker notebook instance.

      Returns:
      The name of the 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:

    • 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:

    • 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:

    • 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:

    • subnetId

      public final String subnetId()

      The ID of the VPC subnet.

      Returns:
      The ID of the VPC subnet.

    • hasSecurityGroups

      public final boolean hasSecurityGroups()
      For responses, this returns true if the service returned a value for the SecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroups() method.

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

    • networkInterfaceId

      public final String networkInterfaceId()

      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.

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

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

    • directInternetAccessAsString

      public final String directInternetAccessAsString()

      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.

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

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAcceleratorTypes() method.

      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()
      For responses, this returns true if the service returned a value for the AcceleratorTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAcceleratorTypes() method.

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

    • hasAdditionalCodeRepositories

      public final boolean hasAdditionalCodeRepositories()
      For responses, this returns true if the service returned a value for the AdditionalCodeRepositories property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalCodeRepositories() method.

      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.

    • 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:

    • 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:

    • platformIdentifier

      public final String platformIdentifier()

      The platform identifier of the notebook instance runtime environment.

      Returns:
      The platform identifier of the notebook instance runtime environment.

    • instanceMetadataServiceConfiguration

      public final InstanceMetadataServiceConfiguration instanceMetadataServiceConfiguration()

      Information on the IMDS configuration of the notebook instance

      Returns:
      Information on the IMDS configuration of the notebook instance

    • 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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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