Spec-Zone.ru › AWS CLI v2

[ aws . forecast ]

Список прогнозов what-if

Описание

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

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

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

Синтаксис

  list-what-if-forecasts
[--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, что соответственно указывает, следует ли включать или исключать задачи экспорта прогноза what-if, соответствующие выражению, из списка. Выражение соответствия состоит из ключа и значения.

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

Например, чтобы перечислить все задачи, которые экспортируют прогноз с именем electricityWhatIfForecast, укажите следующий фильтр:

"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast" } ]

(структура)

Описывает фильтр для выбора подмножества объектов. Каждый фильтр состоит из условия и выражения соответствия. Условие может быть 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 (целое число)

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

Вывод

WhatIfForecasts -> (список)

Массив объектов WhatIfForecasts, описывающих соответствующие прогнозы.

(структура)

Предоставляет сводку свойств прогноза what-if, используемых в операции ListWhatIfForecasts. Чтобы получить полный набор свойств, вызовите операцию DescribeWhatIfForecast и укажите WhatIfForecastArn, который указан в сводке.

WhatIfForecastArn -> (строка)

Amazon Resource Name (ARN) прогноза what-if.

WhatIfForecastName -> (строка)

Имя прогноза what-if.

WhatIfAnalysisArn -> (строка)

Amazon Resource Name (ARN) анализа what-if, который содержит этот прогноз what-if.

Состояние -> (строка)

Состояние прогноза what-if. Состояния включают:

  • ACTIVE
  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
  • CREATE_STOPPING, CREATE_STOPPED
  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Примечание

Состояние анализа what-if должно быть ACTIVE, прежде чем вы сможете получить доступ к анализу.

Сообщение -> (строка)

В случае ошибки информационное сообщение об ошибке.

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

Время создания прогноза what-if.

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

Последнее время изменения ресурса. Метка времени зависит от состояния задачи:

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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