Spec-Zone.ru › AWS CLI v2

[ aws . forecast ]

create-forecast-export-job

Описание

Экспортирует прогноз, созданный операцией CreateForecast, в ваш Amazon Simple Storage Service (Amazon S3) bucket. Имя файла прогноза будет соответствовать следующим соглашениям:

<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>

где компонент <ExportTimestamp> находится в формате Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).

Вы должны указать объект DataDestination, который включает роль Identity and Access Management (IAM), которую Amazon Forecast может использовать для доступа к Amazon S3 bucket. Дополнительную информацию см. в разделе aws-forecast-iam-roles .

Дополнительную информацию см. в разделе howitworks-forecast .

Чтобы получить список всех ваших задач экспорта прогнозов, используйте операцию ListForecastExportJobs.

Примечание

Состояние задачи экспорта прогноза должно быть Status перед тем, как вы сможете получить доступ к прогнозу в вашем Amazon S3 bucket. Чтобы получить состояние, используйте операцию DescribeForecastExportJob.

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

Синтаксис

  create-forecast-export-job
--forecast-export-job-name <value>
--forecast-arn <value>
--destination <value>
[--tags <value>]
[--format <value>]
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

--forecast-export-job-name (строка)

Имя задачи экспорта прогноза.

--forecast-arn (строка)

Amazon Resource Name (ARN) прогноза, который вы хотите экспортировать.

--destination (структура)

Расположение, куда вы хотите сохранить прогноз, и роль Identity and Access Management (IAM), которую Amazon Forecast может использовать для доступа к этому расположению. Прогноз должен быть экспортирован в Amazon S3 bucket.

Если используется шифрование, Destination должен включать ключ Key Management Service (KMS). Роль IAM должна разрешать Amazon Forecast доступ к ключу.

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

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

Path -> (строка)

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

RoleArn -> (строка)

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

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

KMSKeyArn -> (строка)

Amazon Resource Name (ARN) ключа Key Management Service (KMS).

Сокращенный синтаксис:

S3Config={Path=string,RoleArn=string,KMSKeyArn=string}

Синтаксис JSON:

{
  "S3Config": {
    "Path": "string",
    "RoleArn": "string",
    "KMSKeyArn": "string"
  }
}

--tags (список)

Необязательные метки, которые вы применяете к задаче экспорта прогноза для сортировки и организации. Каждая метка состоит из ключа и необязательного значения, которые вы определяете.

Применяются следующие базовые ограничения к меткам:

  • Максимальное количество меток на ресурс - 50.
  • Для каждого ресурса каждый ключ метки должен быть уникальным, и каждый ключ метки может иметь только одно значение.
  • Максимальная длина ключа - 128 символов Unicode в UTF-8.
  • Максимальная длина значения - 256 символов Unicode в UTF-8.
  • Если ваша схема меток используется в нескольких сервисах и ресурсах, имейте в виду, что другие сервисы могут иметь ограничения на разрешенные символы. В общем, разрешены буквы, цифры, пробелы, представляемые в UTF-8, а также следующие символы: + - = . _ : / @.
  • Ключи и значения меток чувствительны к регистру.
  • Не используйте aws: , AWS: или любые комбинации верхнего и нижнего регистра, начинающиеся с таких префиксов, так как они зарезервированы для использования Amazon Web Services. Вы не можете редактировать или удалять ключи меток с этим префиксом. Значения могут иметь такой префикс. Если значение метки имеет aws в качестве префикса, но ключ - нет, Forecast считает это пользовательской меткой и учитывает ее в лимите в 50 меток. Метки с ключом, начинающимся только с префикса aws, не учитываются в лимите меток на ресурс.

(структура)

Необязательные метки, которые вы применяете к ресурсу для сортировки и организации. Каждая метка состоит из ключа и необязательного значения, которые вы определяете.

Применяются следующие базовые ограничения к меткам:

  • Максимальное количество меток на ресурс - 50.
  • Для каждого ресурса каждый ключ метки должен быть уникальным, и каждый ключ метки может иметь только одно значение.
  • Максимальная длина ключа - 128 символов Unicode в UTF-8.
  • Максимальная длина значения - 256 символов Unicode в UTF-8.
  • Если ваша схема меток используется в нескольких сервисах и ресурсах, имейте в виду, что другие сервисы могут иметь ограничения на разрешенные символы. В общем, разрешены буквы, цифры, пробелы, представляемые в UTF-8, а также следующие символы: + - = . _ : / @.
  • Ключи и значения меток чувствительны к регистру.
  • Не используйте aws: , AWS: или любые комбинации верхнего и нижнего регистра, начинающиеся с таких префиксов, так как они зарезервированы для использования Amazon Web Services. Вы не можете редактировать или удалять ключи меток с этим префиксом. Значения могут иметь такой префикс. Если значение метки имеет aws в качестве префикса, но ключ - нет, Forecast считает это пользовательской меткой и учитывает ее в лимите в 50 меток. Метки с ключом, начинающимся только с префикса aws, не учитываются в лимите меток на ресурс.

Key -> (строка)

Одна часть пары ключ-значение, составляющей метку. Ключ - это общая метка, которая действует как категория для более конкретных значений меток.

Value -> (строка)

Необязательная часть пары ключ-значение, составляющей метку. Значение выступает в качестве описателя в рамках категории метки (ключ).

Сокращенный синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--format (строка)

Формат экспортированных данных, CSV или PARQUET. По умолчанию - CSV.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью JSON-строки, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.

--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.

Вывод

ForecastExportJobArn -> (строка)

Amazon Resource Name (ARN) задачи экспорта.

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

Spec-Zone.ru

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