Spec-Zone.ru › AWS CLI v2

[ aws . forecast ]

Список экспортов объяснимости

Описание

Возвращает список экспортов объяснимости, созданных с помощью операции CreateExplainabilityExport. Данная операция возвращает сводку для каждого экспорта объяснимости. Вы можете фильтровать список, используя массив объектов Filter.

Для получения полного набора свойств конкретного экспорта объяснимости используйте ARN с операцией DescribeExplainability.

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

list-explainability-exports является постраничной операцией. Для получения всего набора результатов может потребоваться несколько вызовов API. Вы можете отключить постраничную навигацию, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной навигацией, аргумент --query должен извлекать данные из результатов следующих выражений запроса: ExplainabilityExports

Синтаксис

  list-explainability-exports
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--filters (список)

Массив фильтров. Для каждого фильтра укажите условие и условие соответствия. Условие может быть IS или IS_NOT , что определяет, нужно ли включать или исключать ресурсы, соответствующие условию соответствия, из списка. Условие соответствия состоит из ключа и значения.

Свойства фильтра
  • Condition — Условие, которое нужно применить. Допустимые значения — IS и IS_NOT.
  • Key — Название параметра для фильтрации. Допустимые значения — ResourceArn и Status.
  • Value — Значение для сопоставления.

(структура)

Описывает фильтр для выбора подмножества объектов. Каждый фильтр состоит из условия и условия соответствия. Условие — это либо IS, либо IS_NOT, что определяет, нужно ли включать или исключать объекты, соответствующие условию соответствия, соответственно. Условие соответствия состоит из ключа и значения.

Ключ -> (строка)

Имя параметра для фильтрации.

Значение -> (строка)

Значение для сопоставления.

Условие -> (строка)

Условие, которое нужно применить. Чтобы включить объекты, соответствующие условию соответствия, укажите IS. Чтобы исключить соответствующие объекты, укажите IS_NOT.

Сокращенный синтаксис:

Key=string,Value=string,Condition=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string",
    "Condition": "IS"|"IS_NOT"
  }
  ...
]

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята дословно. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания точки начала постраничной обработки. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Уменьшение размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной навигации укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.

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

Вывод

ExplainabilityExports -> (список)

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

(структура)

Предоставляет сводку свойств экспорта объяснимости, используемых в операции ListExplainabilityExports. Для получения полного набора свойств вызовите операцию DescribeExplainabilityExport и укажите ExplainabilityExportArn.

ExplainabilityExportArn -> (строка)

Amazon Resource Name (ARN) экспорта объяснимости.

ExplainabilityExportName -> (строка)

Имя экспорта объяснимости.

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

Место назначения для задания экспорта. Укажите путь S3, роль 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).

Status -> (строка)

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

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

Message -> (строка)

Информация о любых ошибках, которые могут возникнуть во время экспорта объяснимости.

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

Время создания экспорта объяснимости.

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

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

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

NextToken -> (строка)

Возвращает этот токен, если ответ усечён. Для получения следующего набора результатов используйте токен в следующем запросе.

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

Spec-Zone.ru

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