Spec-Zone.ru › AWS CLI v2

[ aws . forecast ]

create-what-if-forecast

Описание

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

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

Синтаксис

  create-what-if-forecast
--what-if-forecast-name <value>
--what-if-analysis-arn <value>
[--time-series-transformations <value>]
[--time-series-replacements-data-source <value>]
[--tags <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-name (строка)

Имя прогноза «что если». Имена должны быть уникальными в рамках каждого анализа «что если».

--what-if-analysis-arn (строка)

Amazon Resource Name (ARN) анализа «что если».

--time-series-transformations (список)

Преобразования, применяемые к базовому временному ряду. Каждое преобразование содержит действие и набор условий. Действие применяется только тогда, когда выполняются все условия. Если условия не указаны, действие применяется ко всем элементам.

(структура)

Функция преобразования — это пара операций, которые выбирают и изменяют строки в связанном временном ряду. Вы выбираете строки, которые хотите, с помощью операции условия, и изменяете строки с помощью операции преобразования. Все условия объединяются с помощью операции И, что означает, что все условия должны быть истинными для применения преобразования. Преобразования применяются в порядке их перечисления.

Действие -> (структура)

Массив действий, определяющих временной ряд и способ его преобразования. Эти преобразования создают новый временной ряд, используемый для анализа «что если».

ИмяАтрибута -> (строка)

Связанный временной ряд, который вы изменяете. Это значение нечувствительно к регистру.

Операция -> (строка)

Операция, применяемая к предоставленному атрибуту. Операции включают:

  • ADD - добавляет Value ко всем строкам AttributeName.
  • SUBTRACT - вычитает Value из всех строк AttributeName.
  • MULTIPLY - умножает все строки AttributeName на Value.
  • DIVIDE - делит все строки AttributeName на Value.

Значение -> (двойное)

Значение, применяемое для выбранного Operation.

TimeSeriesConditions -> (список)

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

(структура)

Создает подмножество элементов в атрибуте, которые модифицируются. Например, вы можете использовать эту операцию для создания подмножества элементов, стоимость которых составляет 5 долларов или меньше. Для этого вы указываете "AttributeName": "price", "AttributeValue": "5" и "Condition": "LESS_THAN". Сочетайте эту операцию с операцией Действие в операции CreateWhatIfForecastRequest$TimeSeriesTransformations, чтобы определить, как изменяется атрибут.

ИмяАтрибута -> (строка)

item_id, имя измерения, имя IM или метка времени, которые вы изменяете.

ЗначениеАтрибута -> (строка)

Значение, применяемое для выбранного Condition.

Условие -> (строка)

Условие для применения. Допустимые значения — EQUALS, NOT_EQUALS, LESS_THAN и GREATER_THAN.

Сокращенная синтаксическая запись:

Action={AttributeName=string,Operation=string,Value=double},TimeSeriesConditions=[{AttributeName=string,AttributeValue=string,Condition=string},{AttributeName=string,AttributeValue=string,Condition=string}] ...

Синтаксис JSON:

[
  {
    "Action": {
      "AttributeName": "string",
      "Operation": "ADD"|"SUBTRACT"|"MULTIPLY"|"DIVIDE",
      "Value": double
    },
    "TimeSeriesConditions": [
      {
        "AttributeName": "string",
        "AttributeValue": "string",
        "Condition": "EQUALS"|"NOT_EQUALS"|"LESS_THAN"|"GREATER_THAN"
      }
      ...
    ]
  }
  ...
]

--time-series-replacements-data-source (структура)

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

Этот набор данных объединяется с исходным временным рядом для создания преобразованного набора данных, используемого для анализа «что если».

Этот набор данных должен содержать элементы для изменения (например, item_id или workforce_type), любые соответствующие измерения, столбец метки времени и по крайней мере один из связанных столбцов временного ряда. Этот файл не должен содержать дублирующих меток времени для одного и того же временного ряда.

Метки времени и item_id, не включенные в этот набор данных, не включаются в анализ «что если».

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

Путь к файлам в ведре Amazon Simple Storage Service (Amazon S3) и роль Identity and Access Management (IAM), которую Amazon Forecast может принять для доступа к файлам. Дополнительно включает ключ Key Management Service (KMS). Этот объект является частью объекта DataSource, отправляемого в запросе CreateDatasetImportJob, и частью объекта DataDestination.

Путь -> (строка)

Путь к ведру 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).

Схема -> (структура)

Определяет поля набора данных.

Атрибуты -> (список)

Массив атрибутов, определяющих имя и тип каждого поля в наборе данных.

(структура)

Атрибут схемы, определяющий поле набора данных. Атрибут схемы требуется для каждого поля в наборе данных. Объект Schema содержит массив объектов SchemaAttribute.

ИмяАтрибута -> (строка)

Имя поля набора данных.

ТипАтрибута -> (строка)

Тип данных поля.

Для набора данных связанного временного ряда, кроме даты, item_id и атрибутов измерений прогноза, все атрибуты должны быть числового типа (целое число/число с плавающей запятой).

Формат -> (строка)

Формат заменяющих данных, CSV или PARQUET.

TimestampFormat -> (строка)

Формат метки времени заменяющих данных.

Синтаксис JSON:

{
  "S3Config": {
    "Path": "string",
    "RoleArn": "string",
    "KMSKeyArn": "string"
  },
  "Schema": {
    "Attributes": [
      {
        "AttributeName": "string",
        "AttributeType": "string"|"integer"|"float"|"timestamp"|"geolocation"
      }
      ...
    ]
  },
  "Format": "string",
  "TimestampFormat": "string"
}

--tags (список)

Список тегов, которые необходимо применить к прогнозу «что если».

(структура)

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

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

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

Ключ -> (строка)

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

Значение -> (строка)

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

Сокращенная синтаксическая запись:

Key=string,Value=string ...

Синтаксис JSON:

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

--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 (boolean)

Включить отладку логирования.

--endpoint-url (string)

Переопределить стандартный URL команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки из конфигурации/среды.

--version (string)

Показать версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

WhatIfForecastArn -> (string)

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

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

Spec-Zone.ru

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