Spec-Zone.ru › AWS CLI v2

[ aws . forecast ]

описание-объяснимости

Описание

Описывает ресурс Объяснимости, созданный с помощью операции CreateExplainability.

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

Синопсис

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

Параметры

--explainability-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
  • текст
  • таблица
  • 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.

Вывод

ExplainabilityArn -> (строка)

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

ExplainabilityName -> (строка)

Имя ресурса Объяснимости.

ResourceArn -> (строка)

Идентификатор ресурса Amazon (ARN) предиктора или прогноза, используемого для создания ресурса Объяснимости.

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

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

TimeSeriesGranularity -> (строка)

Для создания Объяснимости для всех временных рядов в наборах данных используйте ALL . Для создания Объяснимости для определённых временных рядов в наборах данных используйте SPECIFIC .

Укажите временные ряды, загрузив CSV- или Parquet-файл в Amazon S3, и укажите расположение в типе данных DataDestination.

TimePointGranularity -> (строка)

Для создания Объяснимости для всех временных точек в горизонте прогноза используйте ALL . Для создания Объяснимости для определённых временных точек в горизонте прогноза используйте SPECIFIC .

Укажите временные точки с параметрами StartDateTime и EndDateTime в операции CreateExplainability.

EnableVisualization -> (булево)

Включена ли визуализация для ресурса Объяснимости.

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

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

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

Путь к данным, хранящимся в хранилище Amazon Simple Storage Service (Amazon S3), а также учетные данные для доступа к данным.

Path -> (строка)

Путь к ведру Amazon Simple Storage Service (Amazon S3) или файлам в ведре Amazon S3.

RoleArn -> (строка)

ARN роли управления доступом (IAM), которую Amazon Forecast может использовать для доступа к ведру Amazon S3 или файлам. Если вы предоставили значение для ключа KMSKeyArn, роль должна позволять доступ к ключу.

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

KMSKeyArn -> (строка)

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

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

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

Attributes -> (список)

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

(структура)

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

AttributeName -> (строка)

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

AttributeType -> (строка)

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

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

StartDateTime -> (строка)

Если TimePointGranularity установлено в SPECIFIC, первая временная точка в Объяснимости.

EndDateTime -> (строка)

Если TimePointGranularity установлено в SPECIFIC, последняя временная точка в Объяснимости.

EstimatedTimeRemainingInMinutes -> (целое число с плавающей точкой)

Ожидаемое оставшееся время в минутах для завершения задания CreateExplainability.

Message -> (строка)

В случае ошибки, сообщение об ошибке.

Status -> (строка)

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

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

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

Время создания ресурса Объяснимости.

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

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

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

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

Spec-Zone.ru

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