Spec-Zone.ru › AWS CLI v2

[ aws . kinesisanalytics ]

list-applications

Описание

Примечание

Эта документация предназначена для версии 1 API Amazon Kinesis Data Analytics, которая поддерживает только SQL-приложения. Версия 2 API поддерживает SQL и Java-приложения. Более подробную информацию о версии 2 см. в Документации API Amazon Kinesis Data Analytics V2 .

Возвращает список приложений Amazon Kinesis Analytics в вашем аккаунте. Для каждого приложения в ответе содержится имя приложения, Amazon Resource Name (ARN) и статус. Если ответ возвращает значение HasMoreApplications как true, вы можете отправить другой запрос, добавив ExclusiveStartApplicationName в тело запроса и установив значение последнего имени приложения из предыдущего ответа.

Если вам нужна подробная информация о конкретном приложении, используйте DescribeApplication .

Для выполнения этой операции требуются разрешения для выполнения действия kinesisanalytics:ListApplications.

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

Синтаксис

  list-applications
[--limit <value>]
[--exclusive-start-application-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]

Параметры

--limit (целое число)

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

--exclusive-start-application-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
  • таблица
  • 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 (логическое значение)

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

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

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

Вывод

ApplicationSummaries -> (список)

Список объектов ApplicationSummary.

(структура)

Примечание

Эта документация предназначена для версии 1 API Amazon Kinesis Data Analytics, которая поддерживает только SQL-приложения. Версия 2 API поддерживает SQL и Java-приложения. Более подробную информацию о версии 2 см. в Документации API Amazon Kinesis Data Analytics V2 .

Предоставляет сводную информацию о приложении, включая Amazon Resource Name (ARN), имя и статус.

ApplicationName -> (строка)

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

ApplicationARN -> (строка)

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

ApplicationStatus -> (строка)

Статус приложения.

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

Возвращает true, если для извлечения существует больше приложений.

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

Spec-Zone.ru

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