Spec-Zone.ru › AWS CLI v2

[ aws . forecast ]

describe-forecast

Описание

Описывает прогноз, созданный с помощью операции CreateForecast.

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

  • DatasetGroupArn - Группа наборов данных, предоставившая данные обучения.
  • CreationTime
  • LastModificationTime
  • Status
  • Message - Если произошла ошибка, информация об ошибке.

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

Синтаксис

  describe-forecast
--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]

Параметры

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

Amazon Resource Name (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
  • таблица
  • 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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

ForecastArn -> (строка)

ARN прогноза, указанный в запросе.

ForecastName -> (строка)

Название прогноза.

ForecastTypes -> (список)

Квантили, в которых были сгенерированы вероятностные прогнозы.

(строка)

PredictorArn -> (строка)

ARN предиктора, используемого для генерации прогноза.

DatasetGroupArn -> (строка)

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 - Время завершения или завершения с ошибкой задачи.

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

Временные ряды, которые следует включить в прогноз.

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

Подробная информация о файле импорта, содержащем временные ряды, для которых вы хотите создать прогнозы.

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

Источник данных, роль Identity and Access Management (IAM), которая позволяет Amazon Forecast получать доступ к данным, и, необязательно, ключ Key Management Service (KMS).

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

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

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

Attributes -> (список)

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

(структура)

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

AttributeName -> (строка)

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

AttributeType -> (строка)

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

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

Format -> (строка)

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

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

Spec-Zone.ru

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