Spec-Zone.ru › AWS CLI v2

[ aws . forecast ]

list-monitors

Описание

Возвращает список мониторов, созданных с помощью операций CreateMonitor и CreateAutoPredictor. Для каждого ресурса монитора эта операция возвращает сводку его свойств, включая Amazon Resource Name (ARN). Полный набор свойств ресурса монитора можно получить, указав ARN монитора в операции DescribeMonitor.

См. также: AWS API Documentation

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

Синтаксис

  list-monitors
[--filters <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]

Параметры

--filters (список)

Массив фильтров. Для каждого фильтра укажите условие и условие сопоставления. Условие — это либо IS, либо IS_NOT, что определяет, включать или исключать ресурсы, соответствующие условию, из списка. Условие сопоставления состоит из ключа и значения.

Свойства фильтра
  • Condition — Условие, которое нужно применить. Допустимые значения — IS и IS_NOT.
  • Key — Название параметра для фильтрации. Единственное допустимое значение — Status.
  • Value — Значение для сопоставления.

Например, чтобы получить список всех мониторов, статус которых ACTIVE, нужно указать:

"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]

(структура)

Описание фильтра для выбора подмножества объектов. Каждый фильтр состоит из условия и условия сопоставления. Условие — это либо IS, либо IS_NOT, что определяет, включать или исключать объекты, соответствующие условию, соответственно. Условие сопоставления состоит из ключа и значения.

Ключ -> (строка)

Имя параметра для фильтрации.

Значение -> (строка)

Значение для сопоставления.

Условие -> (строка)

Условие, которое нужно применить. Для включения объектов, соответствующих условию, укажите IS. Для исключения соответствующих объектов укажите IS_NOT.

Сокращенный синтаксис:

Key=string,Value=string,Condition=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string",
    "Condition": "IS"|"IS_NOT"
  }
  ...
]

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

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • вкл
  • выкл
  • авто

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

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

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

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Вывод

Monitors -> (список)

Массив объектов, обобщающих свойства каждого монитора.

(структура)

Предоставляет сводку свойств монитора, используемых в операции ListMonitors. Для получения полного набора свойств вызовите операцию DescribeMonitor и укажите перечисленный MonitorArn.

MonitorArn -> (строка)

Amazon Resource Name (ARN) ресурса монитора.

MonitorName -> (строка)

Имя ресурса монитора.

ResourceArn -> (строка)

Amazon Resource Name (ARN) прогнозируемого значения, за которым ведется наблюдение.

Status -> (строка)

Статус монитора. Состояния включают:

  • ACTIVE
  • ACTIVE_STOPPING, ACTIVE_STOPPED
  • UPDATE_IN_PROGRESS
  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

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

Дата создания ресурса монитора.

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

Последний раз, когда был изменен ресурс монитора. Метка времени зависит от статуса задачи:

  • CREATE_PENDING — CreationTime.
  • CREATE_IN_PROGRESS — Текущая метка времени.
  • STOPPED — Время остановки ресурса.
  • ACTIVE или CREATE_FAILED — Время завершения или неудачи создания монитора.

NextToken -> (строка)

Если ответ обрезан, Amazon Forecast возвращает этот маркер. Для получения следующего набора результатов используйте маркер в следующем запросе.

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

Spec-Zone.ru

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