Список объяснений
Описание
Возвращает список ресурсов Объяснений, созданных с помощью операции CreateExplainability. Данная операция возвращает сводку для каждого Объяснения. Вы можете отфильтровать список, используя массив объектов Filter.
Для получения полных свойств конкретного ресурса Объяснения используйте ARN с помощью операции DescribeExplainability.
См. также: Документацию API AWS
list-explainabilities является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько API-запросов. Вы можете отключить постраничную навигацию, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной навигацией, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Explainabilities
Синтаксис
list-explainabilities
[--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 (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь тайм-аута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения к сокету в секундах. Если значение установлено в 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.
Вывод
Объяснения -> (список)
Массив объектов, которые суммируют свойства каждого ресурса Объяснения.
(структура)
Предоставляет сводку свойств Объяснения, используемых в операции ListExplainabilities. Для получения полного набора свойств вызовите операцию DescribeExplainability и укажите перечисленные ExplainabilityArn.
ExplainabilityArn -> (строка)
ExplainabilityName -> (строка)
ResourceArn -> (строка)
ExplainabilityConfig -> (структура)
Настройки конфигурации, определяющие гранулярность временных рядов и точек времени для Объяснения.
TimeSeriesGranularity -> (строка)
Для создания Объяснения для всех временных рядов в ваших наборах данных используйте ALL. Для создания Объяснения для определенных временных рядов в ваших наборах данных используйте SPECIFIC.
Укажите временные ряды, загрузив CSV или Parquet-файл в Amazon S3-ведро и установив местоположение в типе данных DataDestination.
TimePointGranularity -> (строка)
Для создания Объяснения для всех точек времени в вашем горизонте прогнозирования используйте ALL. Для создания Объяснения для определенных точек времени в вашем горизонте прогнозирования используйте SPECIFIC.
Укажите точки времени с помощью параметров StartDateTime и EndDateTime в операции CreateExplainability.
Статус -> (строка)
Состояние Объяснения. Состояния включают:
ACTIVE-
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILED -
CREATE_STOPPING,CREATE_STOPPED -
DELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
Сообщение -> (строка)
Время создания -> (метка времени)
Последнее время изменения -> (метка времени)
Последнее время изменения ресурса. Метка времени зависит от состояния задачи:
-
CREATE_PENDING—CreationTime. -
CREATE_IN_PROGRESS— текущая метка времени. -
CREATE_STOPPING— текущая метка времени. -
CREATE_STOPPED— когда задача остановилась. -
ACTIVEилиCREATE_FAILED— когда задача завершилась или потерпела неудачу.
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.