Spec-Zone.ru › AWS CLI v2

[ aws . forecast ]

list-what-if-forecast-exports

Описание

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

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

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

Синтаксис

  list-what-if-forecast-exports
[--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 — Имя параметра, по которому нужно фильтровать. Допустимые значения — WhatIfForecastExportArn и Status.
  • Value — Значение для соответствия.

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

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

(структура)

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

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

WhatIfForecastExports -> (список)

Массив объектов WhatIfForecastExports, описывающих сопоставленные прогнозы «что, если».

(структура)

Предоставляет сводку свойств прогноза «что, если» используемых в операции ListWhatIfForecastExports. Для получения полного набора свойств, вызовите операцию DescribeWhatIfForecastExport, и укажите WhatIfForecastExportArn, указанное в сводке.

WhatIfForecastExportArn -> (строка)

Идентификатор ресурса Amazon (ARN) экспорта прогноза «что, если».

WhatIfForecastArns -> (список)

Массив идентификаторов ресурса Amazon (ARN), определяющих прогнозы «что, если», включенные в экспорт.

(строка)

WhatIfForecastExportName -> (строка)

Имя экспорта прогноза «что, если».

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

Путь к ведру Amazon Simple Storage Service (Amazon S3), в котором экспортируется прогноз.

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

Путь к ведру Amazon Simple Storage Service (Amazon S3) вместе с учетными данными для доступа к ведру.

Path -> (строка)

Путь к ведру Amazon Simple Storage Service (Amazon S3) или файлам в ведре Amazon S3.

RoleArn -> (строка)

ARN роли управления доступом и ресурсами (IAM), которую Amazon Forecast может использовать для доступа к ведру Amazon S3 или файлам. Если вы предоставите значение для ключа KMSKeyArn, роль должна разрешить доступ к ключу.

Передача роли между учетными записями Amazon Web Services запрещена. Если вы передадите роль, которая не в вашей учетной записи, вы получите ошибку InvalidInputException.

KMSKeyArn -> (строка)

Идентификатор ресурса Amazon (ARN) ключа управления ключами (KMS).

Status -> (строка)

Статус экспорта прогноза «что, если». Возможные состояния:

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

Примечание

Status анализа «что, если» должен быть ACTIVE, прежде чем вы сможете получить доступ к анализу.

Message -> (строка)

При возникновении ошибки - информационное сообщение об ошибке.

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

Время создания экспорта прогноза «что, если».

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

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

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

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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