Spec-Zone.ru › AWS CLI v2

[ aws . sagemaker ]

describe-app

Описание

Описывает приложение.

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

Синтаксис

  describe-app
--domain-id <value>
[--user-profile-name <value>]
[--space-name <value>]
--app-type <value>
--app-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]

Параметры

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

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

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

Имя профиля пользователя. Если это значение не задано, то SpaceName должно быть задано.

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

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

--app-type (строка)

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

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

  • JupyterServer
  • KernelGateway
  • DetailedProfiler
  • TensorBoard
  • CodeEditor
  • JupyterLab
  • RStudioServerPro
  • RSessionGateway
  • Canvas

--app-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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

AppArn -> (строка)

Amazon Resource Name (ARN) приложения.

AppType -> (строка)

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

AppName -> (строка)

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

DomainId -> (строка)

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

UserProfileName -> (строка)

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

SpaceName -> (строка)

Имя пространства. Если это значение не задано, то UserProfileName должно быть задано.

Status -> (строка)

Состояние.

RecoveryMode -> (логическое значение)

Указывает, запущено ли приложение в режиме восстановления.

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

Метка времени последней проверки состояния.

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

Метка времени последней активности пользователя. LastUserActivityTimestamp также обновляется, когда SageMaker AI выполняет проверки состояния без активности пользователя. В результате это значение установлено в такое же значение, как и LastHealthCheckTimestamp.

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

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

Примечание

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

FailureReason -> (строка)

Причина сбоя.

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

Тип экземпляра и Amazon Resource Name (ARN) созданного SageMaker AI образа на экземпляре.

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) конфигурации жизненного цикла, присоединенной к ресурсу.

BuiltInLifecycleConfigArn -> (строка)

Конфигурация жизненного цикла, которая выполняется перед конфигурацией жизненного цикла по умолчанию

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

Spec-Zone.ru

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