Spec-Zone.ru › AWS CLI v2

[ aws . forecast ]

describe-auto-predictor

Описание

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

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

Синтаксис

  describe-auto-predictor
--predictor-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]

Параметры

--predictor-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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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.

Вывод

PredictorArn -> (строка)

Идентификатор ресурса Amazon (ARN) предиктора

PredictorName -> (строка)

Имя предиктора.

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

Количество временных шагов, которые модель предсказывает. Горизонт прогнозирования также называется длиной прогноза.

ForecastTypes -> (список)

Типы прогнозов, используемые во время обучения предиктора. Значение по умолчанию — [“0.1”,”0.5”,”0.9”].

(строка)

ForecastFrequency -> (строка)

Частота прогнозов в прогнозе.

Допустимые интервалы: Y (год), M (месяц), W (неделя), D (день), H (час), 30мин (30 минут), 15мин (15 минут), 10мин (10 минут), 5мин (5 минут) и 1мин (1 минута). Например, «Y» означает каждый год, а «5мин» — каждые пять минут.

ForecastDimensions -> (список)

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

(строка)

DatasetImportJobArns -> (список)

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

(строка)

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

Настройка данных для вашей группы наборов данных и любых дополнительных наборов данных.

DatasetGroupArn -> (строка)

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

AttributeConfigs -> (список)

Параметры агрегирования и заполнения атрибутов в вашей группе наборов данных.

(структура)

Предоставляет информацию о методе преобразования атрибутов.

Следующее — пример использования домена RETAIL:

{

"AttributeName": "demand",

"Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}

}

AttributeName -> (строка)

Имя атрибута, как указано в схеме. Amazon Forecast поддерживает целевое поле целевого временного ряда и связанные временные ряды данных. Например, для домена RETAIL целевой — demand .

Transformations -> (карта)

Параметры метода (пары ключ-значение), представляющие собой карту параметров переопределения. Укажите эти параметры, чтобы переопределить значения по умолчанию. Атрибуты связанных временных рядов не принимают параметры агрегирования.

Следующий список показывает параметры и их допустимые значения для метода функции заполнения для набора данных целевого временного ряда. Значения по умолчанию выделены жирным шрифтом.

  • aggregation : sum , avg , first , min , max
  • frontfill : none
  • middlefill : zero , nan (не число), value , median , mean , min , max
  • backfill : zero , nan , value , median , mean , min , max

Следующий список показывает параметры и их допустимые значения для метода функции связанных временных рядов (значений по умолчанию нет):

  • middlefill : zero , value , median , mean , min , max
  • backfill : zero , value , median , mean , min , max
  • futurefill : zero , value , median , mean , min , max

Для установки метода заполнения в определённое значение, установите параметр fill в value и определите значение в соответствующем параметре _value . Например, для установки заполнения за пропуски в значение 2, включите следующее: "backfill": "value" и "backfill_value":"2" .

key -> (строка)

value -> (строка)

AdditionalDatasets -> (список)

Дополнительные встроенные наборы данных, такие как Праздники и Индекс погоды.

(структура)

Описывает дополнительный набор данных. Этот объект является частью объекта DataConfig. Amazon Forecast поддерживает дополнительные наборы данных Индекс погоды и Праздники.

Индекс погоды

Индекс погоды Amazon Forecast — это встроенный набор данных, который включает историческую и прогнозируемую информацию о погоде в вашу модель. Индекс погоды дополняет ваши наборы данных более чем двухлетними историческими данными о погоде и до 14 дней прогнозируемых данных о погоде. Дополнительная информация в разделе Индекс погоды Amazon Forecast.

Праздники

Праздники — это встроенный набор данных, который включает информацию о национальных праздниках в вашу модель. Он обеспечивает нативную поддержку календарей праздников 66 стран. Чтобы просмотреть календари праздников, обратитесь к библиотеке Jollyday. Дополнительная информация в разделе Дополнительная обработка Праздников.

Name -> (строка)

Имя дополнительного набора данных. Допустимые имена: "holiday" и "weather" .

Configuration -> (карта)

Индекс погоды

Чтобы включить Индекс погоды, не указывайте значение для Configuration .

Праздники

Праздники

Чтобы включить Праздники, установите CountryCode в один из следующих двухбуквенных кодов страны:

  • «AL» - АЛБАНИЯ
  • «AR» - АРГЕНТИНА
  • «AT» - АВСТРИЯ
  • «AU» - АВСТРАЛИЯ
  • «BA» - БОСНИЯ И ГЕРЦЕГОВИНА
  • «BE» - БЕЛЬГИЯ
  • «BG» - БОЛГАРИЯ
  • «BO» - БОЛИВИЯ
  • «BR» - БРАЗИЛИЯ
  • «BY» - БЕЛАРУСЬ
  • …

key -> (строка)

value -> (список)

(строка)

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

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

RoleArn -> (строка)

ARN роли IAM, которую Amazon Forecast может принять для доступа к ключу KMS.

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

KMSKeyArn -> (строка)

Идентификатор ресурса Amazon (ARN) ключа KMS.

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

ARN и состояние предиктора-эталона. Этот параметр действителен только для переобученных или обновлённых предикторов.

Arn -> (строка)

ARN предиктора-эталона.

State -> (строка)

Является ли предиктор-эталон Active или Deleted.

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

Ожидаемое время завершения задачи обучения предиктора в минутах.

Status -> (строка)

Статус предиктора. Состояния включают:

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

Message -> (строка)

В случае ошибки сообщение, подробно описывающее причину ошибки.

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

Метка времени запроса CreateAutoPredictor.

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

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

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

OptimizationMetric -> (строка)

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

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

Предоставляет статус и ARN объяснения Predictor Explainability.

ExplainabilityArn -> (строка)

Идентификатор ресурса Amazon (ARN) объяснения.

Status -> (строка)

Статус объяснения. Состояния включают:

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

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

Объект с идентификатором ресурса Amazon (ARN) и статусом ресурса монитора.

MonitorArn -> (строка)

Идентификатор ресурса Amazon (ARN) ресурса монитора.

Status -> (строка)

Статус монитора. Состояния включают:

  • ACTIVE
  • ACTIVE_STOPPING, ACTIVE_STOPPED
  • UPDATE_IN_PROGRESS
  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

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

Граница времени, которую прогнозирование использует при агрегировании данных.

Month -> (строка)

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

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

День месяца, используемый для временного выравнивания при агрегировании.

DayOfWeek -> (строка)

День недели, используемый для временного выравнивания при агрегировании. День должен быть в верхнем регистре.

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

Час дня, используемый для временного выравнивания при агрегировании.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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