Spec-Zone.ru › AWS CLI v2

[ aws . sagemaker ]

list-notebook-instances

Описание

Возвращает список экземпляров SageMaker AI ноутбуков в учетной записи запросителя в регионе Amazon Web Services.

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

list-notebook-instances является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: NotebookInstances

Синтаксис

  list-notebook-instances
[--sort-by <value>]
[--sort-order <value>]
[--name-contains <value>]
[--creation-time-before <value>]
[--creation-time-after <value>]
[--last-modified-time-before <value>]
[--last-modified-time-after <value>]
[--status-equals <value>]
[--notebook-instance-lifecycle-config-name-contains <value>]
[--default-code-repository-contains <value>]
[--additional-code-repository-equals <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--sort-by (строка)

Поле для сортировки результатов. По умолчанию Name.

Возможные значения:

  • Name
  • CreationTime
  • Status

--sort-order (строка)

Порядок сортировки результатов.

Возможные значения:

  • Ascending
  • Descending

--name-contains (строка)

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

--creation-time-before (метка времени)

Фильтр, который возвращает только экземпляры ноутбуков, созданные до указанного времени (метка времени).

--creation-time-after (метка времени)

Фильтр, который возвращает только экземпляры ноутбуков, созданные после указанного времени (метка времени).

--last-modified-time-before (метка времени)

Фильтр, который возвращает только экземпляры ноутбуков, изменённые до указанного времени (метка времени).

--last-modified-time-after (метка времени)

Фильтр, который возвращает только экземпляры ноутбуков, изменённые после указанного времени (метка времени).

--status-equals (строка)

Фильтр, который возвращает только экземпляры ноутбуков с указанным статусом.

Возможные значения:

  • Pending
  • InService
  • Stopping
  • Stopped
  • Failed
  • Deleting
  • Updating

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

Строка в имени конфигурации жизненного цикла экземпляра ноутбука, связанного с этим экземпляром ноутбука. Этот фильтр возвращает только экземпляры ноутбуков, связанные с конфигурацией жизненного цикла, имя которой содержит указанную строку.

--default-code-repository-contains (строка)

Строка в имени или URL репозитория Git, связанного с этим экземпляром ноутбука. Этот фильтр возвращает только экземпляры ноутбуков, связанные с репозиторием Git, имя которого содержит указанную строку.

--additional-code-repository-equals (строка)

Фильтр, который возвращает только экземпляры ноутбуков, связанные с указанным репозиторием Git.

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

--starting-token (строка)

Токен для указания места начала постраничной обработки. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--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
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • включено
  • выключено
  • авто

--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 (булево)

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

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

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

Вывод

NextToken -> (строка)

Если ответ на предыдущий запрос ListNotebookInstances был усечен, SageMaker AI возвращает этот токен. Чтобы получить следующий набор экземпляров ноутбуков, используйте токен в следующем запросе.

NotebookInstances -> (список)

Массив объектов NotebookInstanceSummary, по одному для каждого экземпляра ноутбука.

(структура)

Предоставляет сводную информацию об экземпляре SageMaker AI ноутбука.

NotebookInstanceName -> (строка)

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

NotebookInstanceArn -> (строка)

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

NotebookInstanceStatus -> (строка)

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

Url -> (строка)

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

InstanceType -> (строка)

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

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

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

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

Метка времени, показывающая, когда экземпляр ноутбука был изменён последний раз.

NotebookInstanceLifecycleConfigName -> (строка)

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

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

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.

(строка)

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

Spec-Zone.ru

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