Spec-Zone.ru › AWS CLI v2

[ aws . forecast ]

describe-what-if-analysis

Описание

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

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

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

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

Синтаксис

  describe-what-if-analysis
--what-if-analysis-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-analysis-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 для вывода.

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

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

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

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

Вывод

WhatIfAnalysisName -> (строка)

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

WhatIfAnalysisArn -> (строка)

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

ForecastArn -> (строка)

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 — когда задача завершилась или завершилась с ошибкой.

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

Определяет набор временных рядов, которые используются для создания прогнозов в объекте TimeSeriesIdentifiers.

Объекту TimeSeriesIdentifiers необходима следующая информация:

  • DataSource
  • Format
  • Schema

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 -> (список)

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

(структура)

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

AttributeName -> (строка)

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

AttributeType -> (строка)

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

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

Format -> (строка)

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

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

Spec-Zone.ru

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