list-forecast-export-jobs
Описание
Возвращает список задач экспорта прогнозов, созданных с помощью операции CreateForecastExportJob. Для каждой задачи экспорта прогноза эта операция возвращает сводку её свойств, включая Amazon Resource Name (ARN). Для получения полного набора свойств используйте ARN с операцией DescribeForecastExportJob. Вы можете фильтровать список, используя массив объектов Filter.
См. также: Документацию API AWS
list-forecast-export-jobs является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: ForecastExportJobs
Синтаксис
list-forecast-export-jobs
[--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— Название параметра, по которому необходимо фильтровать. Допустимые значения —ForecastArnиStatus. -
Value— Значение для сопоставления.
Например, чтобы вывести все задачи, которые экспортируют прогноз под названием electricityforecast, укажите следующий фильтр:
"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ](структура)
Описание фильтра для выбора подмножества объектов. Каждый фильтр состоит из условия и выражения соответствия. Условие — это либо 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 CLI.
--page-size (целое число)
Размер каждой страницы, получаемой при обращении к службе AWS. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству обращений к службе AWS, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов службы AWS.
Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS CLI.
--max-items (целое число)
Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода предоставьте значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS CLI.
--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
- text
- таблица
- 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.
Вывод
ForecastExportJobs -> (список)
Массив объектов, обобщающих свойства каждого задания экспорта прогноза.
(структура)
Предоставляет сводку свойств задания экспорта прогноза, используемых в операции ListForecastExportJobs. Чтобы получить полный набор свойств, вызовите операцию DescribeForecastExportJob и укажите перечисленные ForecastExportJobArn .
ForecastExportJobArn -> (строка)
ForecastExportJobName -> (строка)
Destination -> (структура)
Путь к ведру Amazon Simple Storage Service (Amazon S3), куда экспортируется прогноз.
S3Config -> (структура)
Путь к ведру Amazon Simple Storage Service (Amazon S3) вместе с учетными данными для доступа к ведру.
Path -> (строка)
RoleArn -> (строка)
ARN роли Identity and Access Management (IAM), которую Amazon Forecast может использовать для доступа к ведру или файлам Amazon S3. Если вы предоставляете значение для ключа KMSKeyArn, роль должна разрешать доступ к этому ключу.
Передача роли между учетными записями Amazon Web Services запрещена. Если вы передадите роль, которая не принадлежит вашей учетной записи, будет получена ошибка InvalidInputException.
KMSKeyArn -> (строка)
Status -> (строка)
Состояние задания экспорта прогноза. Состояния включают:
ACTIVE-
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILED -
CREATE_STOPPING,CREATE_STOPPED -
DELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
Примечание
Состояние задания экспорта прогноза должно бытьACTIVE, прежде чем вы сможете получить доступ к прогнозу в вашем ведре S3.Message -> (строка)
CreationTime -> (метка времени)
LastModificationTime -> (метка времени)
Последнее время изменения ресурса. Метка времени зависит от состояния задания:
-
CREATE_PENDING-CreationTime. -
CREATE_IN_PROGRESS- Текущая метка времени. -
CREATE_STOPPING- Текущая метка времени. -
CREATE_STOPPED- Время остановки задания. -
ACTIVEилиCREATE_FAILED- Время завершения или завершения с ошибкой задания.
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.