list-command-executions
Описание
Список всех выполнений команд.
Предупреждение
- Вы должны указать только информацию
startedTimeFilterилиcompletedTimeFilter. Если вы укажете оба фильтра по времени, API вернёт ошибку. Вы можете использовать эту информацию для получения списка выполнений команд в определённый период времени. - Вы должны указать только информацию
commandArnилиthingArnв зависимости от того, хотите ли вы перечислить выполнения для конкретной команды или IoT-вещи. Если вы укажете оба поля, API вернёт ошибку.
Дополнительную информацию о соображениях по использованию этого API см. в разделе Список выполнений команд в вашем аккаунте (CLI).
См. также: Документация API AWS
list-command-executions является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих запросов: commandExecutions
Синтаксис
list-command-executions
[--namespace <value>]
[--status <value>]
[--sort-order <value>]
[--started-time-filter <value>]
[--completed-time-filter <value>]
[--target-arn <value>]
[--command-arn <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]
Параметры
--namespace (строка)
Пространство имён команды.
Возможные значения:
AWS-IoTAWS-IoT-FleetWise
--status (строка)
Список всех выполнений команд для устройства, имеющего определённый статус. Например, вы можете отфильтровать список, чтобы отобразить только выполнения команд, которые завершились неудачей или по истечении времени.
Возможные значения:
CREATEDIN_PROGRESSSUCCEEDEDFAILEDREJECTEDTIMED_OUT
--sort-order (строка)
Указывает, нужно ли перечислять выполнения команд, созданные в порядке возрастания или убывания. По умолчанию API возвращает все команды в порядке убывания на основе времени начала или завершения выполнения, определяемых параметрами startTimeFilter и completeTimeFilter.
Возможные значения:
ASCENDINGDESCENDING
--started-time-filter (структура)
Список всех выполнений команд, которые начались до или после указанной даты и времени. Дата и время используют формат yyyy-MM-dd'T'HH:mm.
after -> (строка)
before -> (строка)
Сокращённый синтаксис:
after=string,before=string
Синтаксис JSON:
{
"after": "string",
"before": "string"
}
--completed-time-filter (структура)
Список всех выполнений команд, которые завершились до или после указанной даты и времени. Дата и время используют формат yyyy-MM-dd'T'HH:mm.
after -> (строка)
before -> (строка)
Сокращённый синтаксис:
after=string,before=string
Синтаксис JSON:
{
"after": "string",
"before": "string"
}
--target-arn (строка)
--command-arn (строка)
--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
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определённого профиля из файла ключей.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/отключение цветного вывода.
- on
- off
- auto
--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.
Вывод
commandExecutions -> (список)
Список выполнений команд.
(структура)
Сводная информация об определённом выполнении команды.
commandArn -> (строка)
executionId -> (строка)
targetArn -> (строка)
status -> (строка)
createdAt -> (метка времени)
startedAt -> (метка времени)
completedAt -> (метка времени)
nextToken -> (строка)
null, если дополнительных результатов нет.
© Copyright 2025, Amazon Web Services. Created using Sphinx.