Spec-Zone.ru › AWS CLI v2

[ aws . forecast ]

create-what-if-forecast-export

Описание

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

≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>

Компонент <ExportTimestamp> использует формат Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).

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

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

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

Примечание

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

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

Синтаксис

  create-what-if-forecast-export
--what-if-forecast-export-name <value>
--what-if-forecast-arns <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]

Параметры

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

Имя прогноза what-if, который требуется экспортировать.

--what-if-forecast-arns (список)

Список Amazon Resource Names (ARN) прогнозов what-if, которые требуется экспортировать.

(строка)

Синтаксис:

"string" "string" ...

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

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

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

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

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

Path -> (строка)

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

RoleArn -> (строка)

ARN роли Identity and Access Management (IAM), которую Amazon Forecast может использовать для доступа к Amazon S3 бакету или файлам. Если вы предоставите значение для ключа 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 (список)

Список тегов для применения к прогнозу what-if.

(структура)

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

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

  • Максимальное количество тегов на ресурс - 50.
  • Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
  • Максимальная длина ключа - 128 символов Юникода в UTF-8.
  • Максимальная длина значения - 256 символов Юникода в 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.

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

Вывод

WhatIfForecastExportArn -> (строка)

Amazon Resource Name (ARN) прогноза what-if.

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

Spec-Zone.ru

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