Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Returns information about a notebook instance.
Synopsis
- data DescribeNotebookInstance = DescribeNotebookInstance' {}
- newDescribeNotebookInstance :: Text -> DescribeNotebookInstance
- describeNotebookInstance_notebookInstanceName :: Lens' DescribeNotebookInstance Text
- data DescribeNotebookInstanceResponse = DescribeNotebookInstanceResponse' {
- acceleratorTypes :: Maybe [NotebookInstanceAcceleratorType]
- additionalCodeRepositories :: Maybe [Text]
- creationTime :: Maybe POSIX
- defaultCodeRepository :: Maybe Text
- directInternetAccess :: Maybe DirectInternetAccess
- failureReason :: Maybe Text
- instanceMetadataServiceConfiguration :: Maybe InstanceMetadataServiceConfiguration
- instanceType :: Maybe InstanceType
- kmsKeyId :: Maybe Text
- lastModifiedTime :: Maybe POSIX
- networkInterfaceId :: Maybe Text
- notebookInstanceArn :: Maybe Text
- notebookInstanceLifecycleConfigName :: Maybe Text
- notebookInstanceName :: Maybe Text
- notebookInstanceStatus :: Maybe NotebookInstanceStatus
- platformIdentifier :: Maybe Text
- roleArn :: Maybe Text
- rootAccess :: Maybe RootAccess
- securityGroups :: Maybe [Text]
- subnetId :: Maybe Text
- url :: Maybe Text
- volumeSizeInGB :: Maybe Natural
- httpStatus :: Int
- newDescribeNotebookInstanceResponse :: Int -> DescribeNotebookInstanceResponse
- describeNotebookInstanceResponse_acceleratorTypes :: Lens' DescribeNotebookInstanceResponse (Maybe [NotebookInstanceAcceleratorType])
- describeNotebookInstanceResponse_additionalCodeRepositories :: Lens' DescribeNotebookInstanceResponse (Maybe [Text])
- describeNotebookInstanceResponse_creationTime :: Lens' DescribeNotebookInstanceResponse (Maybe UTCTime)
- describeNotebookInstanceResponse_defaultCodeRepository :: Lens' DescribeNotebookInstanceResponse (Maybe Text)
- describeNotebookInstanceResponse_directInternetAccess :: Lens' DescribeNotebookInstanceResponse (Maybe DirectInternetAccess)
- describeNotebookInstanceResponse_failureReason :: Lens' DescribeNotebookInstanceResponse (Maybe Text)
- describeNotebookInstanceResponse_instanceMetadataServiceConfiguration :: Lens' DescribeNotebookInstanceResponse (Maybe InstanceMetadataServiceConfiguration)
- describeNotebookInstanceResponse_instanceType :: Lens' DescribeNotebookInstanceResponse (Maybe InstanceType)
- describeNotebookInstanceResponse_kmsKeyId :: Lens' DescribeNotebookInstanceResponse (Maybe Text)
- describeNotebookInstanceResponse_lastModifiedTime :: Lens' DescribeNotebookInstanceResponse (Maybe UTCTime)
- describeNotebookInstanceResponse_networkInterfaceId :: Lens' DescribeNotebookInstanceResponse (Maybe Text)
- describeNotebookInstanceResponse_notebookInstanceArn :: Lens' DescribeNotebookInstanceResponse (Maybe Text)
- describeNotebookInstanceResponse_notebookInstanceLifecycleConfigName :: Lens' DescribeNotebookInstanceResponse (Maybe Text)
- describeNotebookInstanceResponse_notebookInstanceName :: Lens' DescribeNotebookInstanceResponse (Maybe Text)
- describeNotebookInstanceResponse_notebookInstanceStatus :: Lens' DescribeNotebookInstanceResponse (Maybe NotebookInstanceStatus)
- describeNotebookInstanceResponse_platformIdentifier :: Lens' DescribeNotebookInstanceResponse (Maybe Text)
- describeNotebookInstanceResponse_roleArn :: Lens' DescribeNotebookInstanceResponse (Maybe Text)
- describeNotebookInstanceResponse_rootAccess :: Lens' DescribeNotebookInstanceResponse (Maybe RootAccess)
- describeNotebookInstanceResponse_securityGroups :: Lens' DescribeNotebookInstanceResponse (Maybe [Text])
- describeNotebookInstanceResponse_subnetId :: Lens' DescribeNotebookInstanceResponse (Maybe Text)
- describeNotebookInstanceResponse_url :: Lens' DescribeNotebookInstanceResponse (Maybe Text)
- describeNotebookInstanceResponse_volumeSizeInGB :: Lens' DescribeNotebookInstanceResponse (Maybe Natural)
- describeNotebookInstanceResponse_httpStatus :: Lens' DescribeNotebookInstanceResponse Int
Creating a Request
data DescribeNotebookInstance Source #
See: newDescribeNotebookInstance
smart constructor.
DescribeNotebookInstance' | |
|
Instances
newDescribeNotebookInstance Source #
Create a value of DescribeNotebookInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeNotebookInstance
, describeNotebookInstance_notebookInstanceName
- The name of the notebook instance that you want information about.
Request Lenses
describeNotebookInstance_notebookInstanceName :: Lens' DescribeNotebookInstance Text Source #
The name of the notebook instance that you want information about.
Destructuring the Response
data DescribeNotebookInstanceResponse Source #
See: newDescribeNotebookInstanceResponse
smart constructor.
DescribeNotebookInstanceResponse' | |
|
Instances
newDescribeNotebookInstanceResponse Source #
Create a value of DescribeNotebookInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceleratorTypes:DescribeNotebookInstanceResponse'
, describeNotebookInstanceResponse_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.
DescribeNotebookInstanceResponse
, describeNotebookInstanceResponse_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.
DescribeNotebookInstanceResponse
, describeNotebookInstanceResponse_creationTime
- A timestamp. Use this parameter to return the time when the notebook
instance was created
DescribeNotebookInstanceResponse
, describeNotebookInstanceResponse_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.
$sel:directInternetAccess:DescribeNotebookInstanceResponse'
, describeNotebookInstanceResponse_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.
DescribeNotebookInstanceResponse
, describeNotebookInstanceResponse_failureReason
- If status is Failed
, the reason it failed.
$sel:instanceMetadataServiceConfiguration:DescribeNotebookInstanceResponse'
, describeNotebookInstanceResponse_instanceMetadataServiceConfiguration
- Information on the IMDS configuration of the notebook instance
DescribeNotebookInstanceResponse
, describeNotebookInstanceResponse_instanceType
- The type of ML compute instance running on the notebook instance.
DescribeNotebookInstanceResponse
, describeNotebookInstanceResponse_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.
DescribeNotebookInstanceResponse
, describeNotebookInstanceResponse_lastModifiedTime
- A timestamp. Use this parameter to retrieve the time when the notebook
instance was last modified.
$sel:networkInterfaceId:DescribeNotebookInstanceResponse'
, describeNotebookInstanceResponse_networkInterfaceId
- The network interface IDs that SageMaker created at the time of creating
the instance.
DescribeNotebookInstanceResponse
, describeNotebookInstanceResponse_notebookInstanceArn
- The Amazon Resource Name (ARN) of the notebook instance.
DescribeNotebookInstanceResponse
, describeNotebookInstanceResponse_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
DescribeNotebookInstance
, describeNotebookInstanceResponse_notebookInstanceName
- The name of the SageMaker notebook instance.
DescribeNotebookInstanceResponse
, describeNotebookInstanceResponse_notebookInstanceStatus
- The status of the notebook instance.
$sel:platformIdentifier:DescribeNotebookInstanceResponse'
, describeNotebookInstanceResponse_platformIdentifier
- The platform identifier of the notebook instance runtime environment.
DescribeNotebookInstanceResponse
, describeNotebookInstanceResponse_roleArn
- The Amazon Resource Name (ARN) of the IAM role associated with the
instance.
$sel:rootAccess:DescribeNotebookInstanceResponse'
, describeNotebookInstanceResponse_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.
DescribeNotebookInstanceResponse
, describeNotebookInstanceResponse_securityGroups
- The IDs of the VPC security groups.
$sel:subnetId:DescribeNotebookInstanceResponse'
, describeNotebookInstanceResponse_subnetId
- The ID of the VPC subnet.
DescribeNotebookInstanceResponse
, describeNotebookInstanceResponse_url
- The URL that you use to connect to the Jupyter notebook that is running
in your notebook instance.
DescribeNotebookInstanceResponse
, describeNotebookInstanceResponse_volumeSizeInGB
- The size, in GB, of the ML storage volume attached to the notebook
instance.
$sel:httpStatus:DescribeNotebookInstanceResponse'
, describeNotebookInstanceResponse_httpStatus
- The response's http status code.
Response Lenses
describeNotebookInstanceResponse_acceleratorTypes :: Lens' DescribeNotebookInstanceResponse (Maybe [NotebookInstanceAcceleratorType]) Source #
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.
describeNotebookInstanceResponse_additionalCodeRepositories :: Lens' DescribeNotebookInstanceResponse (Maybe [Text]) Source #
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.
describeNotebookInstanceResponse_creationTime :: Lens' DescribeNotebookInstanceResponse (Maybe UTCTime) Source #
A timestamp. Use this parameter to return the time when the notebook instance was created
describeNotebookInstanceResponse_defaultCodeRepository :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #
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.
describeNotebookInstanceResponse_directInternetAccess :: Lens' DescribeNotebookInstanceResponse (Maybe DirectInternetAccess) Source #
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.
describeNotebookInstanceResponse_failureReason :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #
If status is Failed
, the reason it failed.
describeNotebookInstanceResponse_instanceMetadataServiceConfiguration :: Lens' DescribeNotebookInstanceResponse (Maybe InstanceMetadataServiceConfiguration) Source #
Information on the IMDS configuration of the notebook instance
describeNotebookInstanceResponse_instanceType :: Lens' DescribeNotebookInstanceResponse (Maybe InstanceType) Source #
The type of ML compute instance running on the notebook instance.
describeNotebookInstanceResponse_kmsKeyId :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #
The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
describeNotebookInstanceResponse_lastModifiedTime :: Lens' DescribeNotebookInstanceResponse (Maybe UTCTime) Source #
A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
describeNotebookInstanceResponse_networkInterfaceId :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #
The network interface IDs that SageMaker created at the time of creating the instance.
describeNotebookInstanceResponse_notebookInstanceArn :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the notebook instance.
describeNotebookInstanceResponse_notebookInstanceLifecycleConfigName :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #
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
describeNotebookInstanceResponse_notebookInstanceName :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #
The name of the SageMaker notebook instance.
describeNotebookInstanceResponse_notebookInstanceStatus :: Lens' DescribeNotebookInstanceResponse (Maybe NotebookInstanceStatus) Source #
The status of the notebook instance.
describeNotebookInstanceResponse_platformIdentifier :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #
The platform identifier of the notebook instance runtime environment.
describeNotebookInstanceResponse_roleArn :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role associated with the instance.
describeNotebookInstanceResponse_rootAccess :: Lens' DescribeNotebookInstanceResponse (Maybe RootAccess) Source #
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.
describeNotebookInstanceResponse_securityGroups :: Lens' DescribeNotebookInstanceResponse (Maybe [Text]) Source #
The IDs of the VPC security groups.
describeNotebookInstanceResponse_subnetId :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #
The ID of the VPC subnet.
describeNotebookInstanceResponse_url :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #
The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
describeNotebookInstanceResponse_volumeSizeInGB :: Lens' DescribeNotebookInstanceResponse (Maybe Natural) Source #
The size, in GB, of the ML storage volume attached to the notebook instance.
describeNotebookInstanceResponse_httpStatus :: Lens' DescribeNotebookInstanceResponse Int Source #
The response's http status code.