Spec-Zone.ru › AWS CLI v2

[ aws . sagemaker ]

describe-notebook-instance

Описание

Возвращает информацию о экземпляре ноутбука.

См. также: Документацию API AWS

Синтаксис

  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]

Параметры

--notebook-instance-name (строка)

Имя экземпляра ноутбука, о котором требуется информация.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или значение input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выведет пример YAML-ввода, который можно использовать с --cli-input-yaml. Если предоставлено значение output, проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (булево)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать конкретный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл с сертификатами CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде строки, закодированной в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (булево)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

NotebookInstanceArn -> (строка)

Amazon Resource Name (ARN) экземпляра ноутбука.

NotebookInstanceName -> (строка)

Имя экземпляра SageMaker AI ноутбука.

NotebookInstanceStatus -> (строка)

Статус экземпляра ноутбука.

FailureReason -> (строка)

Если статус — Failed, причина сбоя.

Url -> (строка)

URL, который используется для подключения к Jupyter Notebook, запущенному в экземпляре ноутбука.

InstanceType -> (строка)

Тип вычислительного экземпляра ML, работающего на экземпляре ноутбука.

SubnetId -> (строка)

ID подсети VPC.

SecurityGroups -> (список)

ID групп безопасности VPC.

(строка)

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, связанной с экземпляром.

KmsKeyId -> (строка)

ID ключа KMS Amazon Web Services, используемого SageMaker AI для шифрования данных при хранении их на томе хранилища ML, подключенном к экземпляру.

NetworkInterfaceId -> (строка)

ID сетевых интерфейсов, созданных SageMaker AI при создании экземпляра.

LastModifiedTime -> (отметка времени)

Отметка времени. Используйте этот параметр для получения времени последнего изменения экземпляра ноутбука.

CreationTime -> (отметка времени)

Отметка времени. Используйте этот параметр для получения времени создания экземпляра ноутбука.

NotebookInstanceLifecycleConfigName -> (строка)

Возвращает имя конфигурации жизненного цикла экземпляра ноутбука.

Для получения информации о конфигурациях жизненного цикла экземпляров ноутбука, см. Шаг 2.1: (Необязательно) Настройка экземпляра ноутбука

DirectInternetAccess -> (строка)

Описание того, предоставляет ли SageMaker AI доступ к интернету для экземпляра ноутбука. Если это значение установлено в Disabled, экземпляр ноутбука не имеет доступа к интернету и не может подключиться к службам обучения и конечным точкам SageMaker AI.

Для получения дополнительной информации, см. Экземпляры ноутбуков по умолчанию имеют доступ к интернету.

VolumeSizeInGB -> (целое число)

Размер тома хранилища ML, подключенного к экземпляру ноутбука, в ГБ.

AcceleratorTypes -> (список)

Этот параметр больше не поддерживается. Эластичные вычислительные ресурсы (EI) больше недоступны.

Этот параметр использовался для указания списка типов экземпляров EI, связанных с этим экземпляром ноутбука.

(строка)

DefaultCodeRepository -> (строка)

Git-репозиторий, связанный с экземпляром ноутбука в качестве его репозитория кода по умолчанию. Это может быть либо имя Git-репозитория, хранящегося как ресурс в вашей учетной записи, либо URL Git-репозитория в Amazon Web Services CodeCommit или в любом другом Git-репозитории. При открытии экземпляра ноутбука он откроется в каталоге, содержащем этот репозиторий. Для получения дополнительной информации, см. Связывание Git-репозиториев с экземплярами ноутбуков SageMaker AI.

AdditionalCodeRepositories -> (список)

Массив до трех Git-репозиториев, связанных с экземпляром ноутбука. Это могут быть либо имена Git-репозиториев, хранящихся как ресурсы в вашей учетной записи, либо URL Git-репозиториев в Amazon Web Services CodeCommit или в любом другом Git-репозитории. Эти репозитории клонируются на том же уровне, что и репозиторий по умолчанию вашего экземпляра ноутбука. Для получения дополнительной информации, см. Связывание Git-репозиториев с экземплярами ноутбуков SageMaker AI.

(строка)

RootAccess -> (строка)

Включен или выключен доступ root для пользователей экземпляра ноутбука.

Примечание

Конфигурации жизненного цикла нуждаются в доступе root, чтобы настроить экземпляр ноутбука. Из-за этого конфигурации жизненного цикла, связанные с экземпляром ноутбука, всегда работают с доступом root, даже если вы отключили доступ root для пользователей.

PlatformIdentifier -> (строка)

Идентификатор платформы среды выполнения экземпляра ноутбука.

InstanceMetadataServiceConfiguration -> (структура)

Информация о конфигурации IMDS экземпляра ноутбука

MinimumInstanceMetadataServiceVersion -> (строка)

Указывает минимальную версию IMDS, которую поддерживает экземпляр ноутбука. При передаче в CreateNotebookInstance, если значение не выбрано, по умолчанию используется IMDSv1. Это означает, что поддерживаются как IMDSv1, так и IMDSv2. Если передается в UpdateNotebookInstance, по умолчанию нет.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API