describe-notebook-instance¶
Description¶
Returns information about a notebook instance.
See also: AWS API Documentation
Synopsis¶
describe-notebook-instance
--notebook-instance-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--notebook-instance-name (string)
The name of the notebook instance that you want information about.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
on
off
auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output¶
NotebookInstanceArn -> (string)
The Amazon Resource Name (ARN) of the notebook instance.
NotebookInstanceName -> (string)
The name of the SageMaker notebook instance.
NotebookInstanceStatus -> (string)
The status of the notebook instance.
FailureReason -> (string)
If status is
Failed, the reason it failed.
Url -> (string)
The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
InstanceType -> (string)
The type of ML compute instance running on the notebook instance.
SubnetId -> (string)
The ID of the VPC subnet.
SecurityGroups -> (list)
The IDs of the VPC security groups.
(string)
RoleArn -> (string)
The Amazon Resource Name (ARN) of the IAM role associated with the instance.
KmsKeyId -> (string)
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 -> (string)
The network interface IDs that SageMaker created at the time of creating the instance.
LastModifiedTime -> (timestamp)
A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
CreationTime -> (timestamp)
A timestamp. Use this parameter to return the time when the notebook instance was created
NotebookInstanceLifecycleConfigName -> (string)
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 -> (string)
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 .
VolumeSizeInGB -> (integer)
The size, in GB, of the ML storage volume attached to the notebook instance.
AcceleratorTypes -> (list)
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 .
(string)
DefaultCodeRepository -> (string)
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 .
AdditionalCodeRepositories -> (list)
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 .
(string)
RootAccess -> (string)
Whether root access is enabled or disabled for users of the notebook instance.
Note
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.
PlatformIdentifier -> (string)
The platform identifier of the notebook instance runtime environment.
InstanceMetadataServiceConfiguration -> (structure)
Information on the IMDS configuration of the notebook instance
MinimumInstanceMetadataServiceVersion -> (string)
Indicates the minimum IMDS version that the notebook instance supports. When passed as part of
CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part ofUpdateNotebookInstance, there is no default.