Spec-Zone.ru › AWS CLI v2

[ aws . forecast ]

list-forecasts

Описание

Возвращает список прогнозов, созданных с помощью операции CreateForecast. Для каждого прогноза эта операция возвращает сводку его свойств, включая Amazon Resource Name (ARN). Чтобы получить полный набор свойств, укажите ARN с помощью операции DescribeForecast. Вы можете отфильтровать список, используя массив объектов Filter.

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

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

Синтаксис

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

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

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

"Filters": [ { "Condition": "IS_NOT", "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 (целое число)

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

Вывод

Прогнозы -> (список)

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

(структура)

Предоставляет сводку свойств прогноза, используемых в операции ListForecasts. Чтобы получить полный набор свойств, вызовите операцию DescribeForecast и укажите ForecastArn, указанную в сводке.

ForecastArn -> (строка)

ARN прогноза.

ForecastName -> (строка)

Имя прогноза.

PredictorArn -> (строка)

ARN предиктора, используемого для генерации прогноза.

CreatedUsingAutoPredictor -> (булево)

Является ли прогноз созданным из AutoPredictor.

DatasetGroupArn -> (строка)

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

Статус -> (строка)

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

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

Примечание

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

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

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

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

Время создания задачи создания прогноза.

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

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

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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