Spec-Zone.ru › AWS CLI v2

[ aws . forecast ]

list-what-if-analyses

Описание

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

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

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

Синтаксис

  list-what-if-analyses
[--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. Для включения задач анализа what-if, соответствующих выражению, укажите IS. Для исключения соответствующих задач анализа what-if укажите IS_NOT.
  • Key — Название параметра, по которому следует фильтровать. Допустимые значения — WhatIfAnalysisArn и Status.
  • Value — Значение для сопоставления.

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

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

(структура)

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

Вывод

WhatIfAnalyses -> (список)

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

(структура)

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

WhatIfAnalysisArn -> (строка)

Amazon Resource Name (ARN) анализа what-if.

WhatIfAnalysisName -> (строка)

Имя анализа what-if.

ForecastArn -> (строка)

Amazon Resource Name (ARN) базового прогноза, используемого в этом анализе what-if.

Status -> (строка)

Статус анализа what-if. Возможные состояния:

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

Примечание

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

Message -> (строка)

Если произошла ошибка, информационное сообщение об ошибке.

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

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

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

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

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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