Spec-Zone.ru › AWS CLI v2

[ aws . forecast ]

describe-what-if-forecast

Описание

Описывает прогноз «что-если», созданный с помощью операции CreateWhatIfForecast.

В дополнение к перечислению свойств, предоставленных в запросе CreateWhatIfForecast, эта операция перечисляет следующие свойства:

  • CreationTime
  • LastModificationTime
  • Message — Если произошла ошибка, информация об ошибке.
  • Status

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

Синтаксис

  describe-what-if-forecast
--what-if-forecast-arn <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-arn (строка)

Идентификатор ресурса Amazon (ARN) прогноза «что-если», который вас интересует.

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

Отображение версии этого инструмента.

--color (строка)

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

  • on
  • off
  • auto

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

Вывод

WhatIfForecastName -> (строка)

Имя прогноза «что если».

WhatIfForecastArn -> (строка)

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

WhatIfAnalysisArn -> (строка)

Amazon Resource Name (ARN) анализа «что если», содержащего этот прогноз.

EstimatedTimeRemainingInMinutes -> (целое число)

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

Status -> (строка)

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

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

Примечание

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

Message -> (строка)

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

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

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

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

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

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

TimeSeriesTransformations -> (список)

Массив элементов Action и TimeSeriesConditions, описывающих, какие преобразования были применены к каким временным рядам.

(структура)

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

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

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

AttributeName -> (строка)

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

Operation -> (строка)

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

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

Value -> (двойное число)

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

TimeSeriesConditions -> (список)

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

(структура)

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

AttributeName -> (строка)

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

AttributeValue -> (строка)

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

Condition -> (строка)

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

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

Массив элементов S3Config, Schema и Format, описывающих временной ряд замены.

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

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

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

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

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

Attributes -> (список)

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

(структура)

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

AttributeName -> (строка)

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

AttributeType -> (строка)

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

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

Format -> (строка)

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

TimestampFormat -> (строка)

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

ForecastTypes -> (список)

Квантили, в которых генерируются вероятностные прогнозы. В операции CreateWhatIfForecast вы можете указать до пяти квантилей на прогноз «что если». Если вы не указали квантили, значения по умолчанию — ["0.1", "0.5", "0.9"].

(строка)

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

Spec-Zone.ru

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