Package software.amazon.awssdk.services.sagemaker.model

Class DescribeNotebookInstanceResponse

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

        Returns:
        The name of the SageMaker AI notebook instance.

      • 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

      • ipAddressType

        public final IPAddressType ipAddressType()

        The IP address type configured for the notebook instance. Returns ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity.

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

        Returns:
        The IP address type configured for the notebook instance. Returns ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity.
        See Also:
        IPAddressType

      • ipAddressTypeAsString

        public final String ipAddressTypeAsString()

        The IP address type configured for the notebook instance. Returns ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity.

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

        Returns:
        The IP address type configured for the notebook instance. Returns ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity.
        See Also:
        IPAddressType

      • 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 AI 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 AI 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 AI created at the time of creating the instance.

        Returns:
        The network interface IDs that SageMaker AI 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

      • directInternetAccessAsString

        public final String directInternetAccessAsString()

        Describes whether SageMaker AI 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 AI 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 AI 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 AI 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()

        This parameter is no longer supported. Elastic Inference (EI) is no longer available.

        This parameter was used to specify a list of the EI instance types associated with this notebook instance.

        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:
        This parameter is no longer supported. Elastic Inference (EI) is no longer available.

        This parameter was used to specify a list of the EI instance types associated with this notebook instance.

      • 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()

        This parameter is no longer supported. Elastic Inference (EI) is no longer available.

        This parameter was used to specify a list of the EI instance types associated with this notebook instance.

        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:
        This parameter is no longer supported. Elastic Inference (EI) is no longer available.

        This parameter was used to specify a list of the EI instance types associated with this notebook instance.

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

      • 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

      • 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