Spec-Zone.ru › AWS CLI v2

[ aws . sagemaker ]

list-apps

Описание

Выводит список приложений.

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

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

Синтаксис

  list-apps
[--sort-order <value>]
[--sort-by <value>]
[--domain-id-equals <value>]
[--user-profile-name-equals <value>]
[--space-name-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-order (строка)

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

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

  • Ascending
  • Descending

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

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

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

  • CreationTime

--domain-id-equals (строка)

Параметр для поиска идентификатора домена.

--user-profile-name-equals (строка)

Параметр для поиска по имени профиля пользователя. Если установлен SpaceNameEquals, то это значение нельзя установить.

--space-name-equals (строка)

Параметр для поиска по имени пространства. Если установлен UserProfileNameEquals, то это значение нельзя установить.

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

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

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

Примеры использования см. в разделе «Постраничная обработка» в руководстве пользователя командной строки AWS.

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

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

Примеры использования см. в разделе «Постраничная обработка» в руководстве пользователя командной строки AWS.

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

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

Примеры использования см. в разделе «Постраничная обработка» в руководстве пользователя командной строки AWS.

--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.

Вывод

Приложения -> (список)

Список приложений.

(структура)

Детали приложения Amazon SageMaker AI.

DomainId -> (строка)

Идентификатор домена.

UserProfileName -> (строка)

Имя профиля пользователя.

SpaceName -> (строка)

Имя пространства.

AppType -> (строка)

Тип приложения.

AppName -> (строка)

Имя приложения.

Status -> (строка)

Статус.

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

Время создания.

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

Указывает ARN изображения SageMaker AI и версии изображения SageMaker AI, а также тип экземпляра, на котором работает версия.

Примечание

Когда оба SageMakerImageVersionArn и SageMakerImageArn переданы, используется SageMakerImageVersionArn. Любые обновления SageMakerImageArn не будут иметь эффекта, если SageMakerImageVersionArn уже существует в ResourceSpec, потому что SageMakerImageVersionArn всегда имеет приоритет. Чтобы очистить значение, установленное для SageMakerImageVersionArn, передайте None в качестве значения.

SageMakerImageArn -> (строка)

ARN изображения SageMaker AI, к которому принадлежит версия изображения.

SageMakerImageVersionArn -> (строка)

ARN версии изображения, созданной на экземпляре. Чтобы очистить значение, установленное для SageMakerImageVersionArn, передайте None в качестве значения.

SageMakerImageVersionAlias -> (строка)

SageMakerImageVersionAlias изображения для запуска. Это значение в формате версионирования SemVer 2.0.0.

InstanceType -> (строка)

Тип экземпляра, на котором работает версия изображения.

Примечание

Приложения JupyterServer поддерживают только значение system.

Для приложений KernelGateway значение system преобразуется в ml.t3.medium. Приложения KernelGateway также поддерживают все другие значения для доступных типов экземпляров.

LifecycleConfigArn -> (строка)

Amazon Resource Name (ARN) конфигурации жизненного цикла, присоединённой к ресурсу.

NextToken -> (строка)

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

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

Spec-Zone.ru

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