list-commands
Описание
Отображает команды, запрошенные пользователями учетной записи Amazon Web Services.
См. также: Документацию API AWS
list-commands — это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничную навигацию, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной навигацией, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Commands
Синтаксис
list-commands
[--command-id <value>]
[--instance-id <value>]
[--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]
Параметры
--command-id (строка)
--instance-id (строка)
(Необязательно) Отображает команды, выданные против данного идентификатора управляемого узла.
Примечание
Вы не можете указать идентификатор управляемого узла в той же команде, что иStatus = Pending. Это связано с тем, что команда еще не достигла управляемого узла.--filters (список)
(Необязательно) Один или несколько фильтров. Используйте фильтр для возврата более конкретного списка результатов.
(структура)
Описывает фильтр команд.
Примечание
Идентификатор управляемого узла не может быть указан, когда статус команды равенPending, потому что команда еще не выполнена на узле.key -> (строка)
Имя фильтра.
Примечание
ФильтрExecutionStage не может быть использован с операцией ListCommandInvocations, только с ListCommands.value -> (строка)
Значение фильтра. Допустимые значения для каждого ключа фильтра следующие:
-
InvokedAfter: Укажите отметку времени, чтобы ограничить результаты. Например, укажите
2024-07-07T00:00:00Z, чтобы увидеть список запусков команд, произошедших 7 июля 2021 года и позже. -
InvokedBefore: Укажите отметку времени, чтобы ограничить результаты. Например, укажите
2024-07-07T00:00:00Z, чтобы увидеть список запусков команд до 7 июля 2021 года. -
Status: Укажите допустимый статус команды, чтобы увидеть список всех запусков команд с этим статусом. Допустимые значения статуса зависят от вызываемого API. Значения статуса, которые вы можете указать для
ListCommands:PendingInProgressSuccessCancelledFailed-
TimedOut(включает таймауты доставки и выполнения) AccessDeniedDeliveryTimedOutExecutionTimedOutIncompleteNoInstancesInTagLimitExceeded
Значения статуса, которые вы можете указать для ListCommandInvocations:
PendingInProgressDelayedSuccessCancelledFailed-
TimedOut(включает таймауты доставки и выполнения) AccessDeniedDeliveryTimedOutExecutionTimedOutUndeliverableInvalidPlatformTerminated
-
DocumentName: Укажите имя документа Amazon Web Services Systems Manager (SSM документ), для которого вы хотите увидеть результаты выполнения команды. Например, укажите
AWS-RunPatchBaseline, чтобы увидеть выполнение команд, которые использовали этот SSM документ для выполнения операций по обновлению безопасности на управляемых узлах. -
ExecutionStage: Укажите одно из следующих значений (только для операций
ListCommands):-
Executing: Возвращает список команд, которые в данный момент выполняются. -
Complete: Возвращает список команд, которые уже завершились.
-
Сокращенный синтаксис:
key=string,value=string ...
Синтаксис JSON:
[
{
"key": "InvokedAfter"|"InvokedBefore"|"Status"|"ExecutionStage"|"DocumentName",
"value": "string"
}
...
]
--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.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запроса параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.
Если не указано иное, все примеры имеют правила цитирования, характерные для Unix. Эти примеры необходимо адаптировать к правилам цитирования вашего терминала. См. раздел «Использование кавычек со строками» в Руководстве пользователя AWS CLI.
Пример 1: Получение статуса определенной команды
Следующий list-commands пример извлекает и отображает статус указанной команды.
aws ssm list-commands \
--command-id "0831e1a8-a1ac-4257-a1fd-c831bEXAMPLE"
Пример 2: Получение статуса команд, запрошенных после определенной даты
Следующий list-commands пример извлекает сведения о командах, запрошенных после указанной даты.
aws ssm list-commands \
--filter "key=InvokedAfter,value=2020-02-01T00:00:00Z"
Пример 3: Вывод всех команд, запрошенных в учетной записи AWS
Следующий list-commands пример отображает все команды, запрошенные пользователями в текущей учетной записи AWS и регионе.
aws ssm list-commands
Вывод:
{
"Commands": [
{
"CommandId": "8bee3135-398c-4d31-99b6-e42d2EXAMPLE",
"DocumentName": "AWS-UpdateSSMAgent",
"DocumentVersion": "",
"Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE",
"ExpiresAfter": "2020-02-19T11:28:02.500000-08:00",
"Parameters": {},
"InstanceIds": [
"i-028ea792daEXAMPLE",
"i-02feef8c46EXAMPLE",
"i-038613f3f0EXAMPLE",
"i-03a530a2d4EXAMPLE",
"i-083b678d37EXAMPLE",
"i-0dee81debaEXAMPLE"
],
"Targets": [],
"RequestedDateTime": "2020-02-19T10:18:02.500000-08:00",
"Status": "Success",
"StatusDetails": "Success",
"OutputS3BucketName": "",
"OutputS3KeyPrefix": "",
"MaxConcurrency": "50",
"MaxErrors": "100%",
"TargetCount": 6,
"CompletedCount": 6,
"ErrorCount": 0,
"DeliveryTimedOutCount": 0,
"ServiceRole": "",
"NotificationConfig": {
"NotificationArn": "",
"NotificationEvents": [],
"NotificationType": ""
},
"CloudWatchOutputConfig": {
"CloudWatchLogGroupName": "",
"CloudWatchOutputEnabled": false
}
}
{
"CommandId": "e9ade581-c03d-476b-9b07-26667EXAMPLE",
"DocumentName": "AWS-FindWindowsUpdates",
"DocumentVersion": "1",
"Comment": "",
"ExpiresAfter": "2020-01-24T12:37:31.874000-08:00",
"Parameters": {
"KbArticleIds": [
""
],
"UpdateLevel": [
"All"
]
},
"InstanceIds": [],
"Targets": [
{
"Key": "InstanceIds",
"Values": [
"i-00ec29b21eEXAMPLE",
"i-09911ddd90EXAMPLE"
]
}
],
"RequestedDateTime": "2020-01-24T11:27:31.874000-08:00",
"Status": "Success",
"StatusDetails": "Success",
"OutputS3BucketName": "my-us-east-2-bucket",
"OutputS3KeyPrefix": "my-rc-output",
"MaxConcurrency": "50",
"MaxErrors": "0",
"TargetCount": 2,
"CompletedCount": 2,
"ErrorCount": 0,
"DeliveryTimedOutCount": 0,
"ServiceRole": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM",
"NotificationConfig": {
"NotificationArn": "arn:aws:sns:us-east-2:111222333444:my-us-east-2-notification-arn",
"NotificationEvents": [
"All"
],
"NotificationType": "Invocation"
},
"CloudWatchOutputConfig": {
"CloudWatchLogGroupName": "",
"CloudWatchOutputEnabled": false
}
}
{
"CommandId": "d539b6c3-70e8-4853-80e5-0ce4fEXAMPLE",
"DocumentName": "AWS-RunPatchBaseline",
"DocumentVersion": "1",
"Comment": "",
"ExpiresAfter": "2020-01-24T12:21:04.350000-08:00",
"Parameters": {
"InstallOverrideList": [
""
],
"Operation": [
"Install"
],
"RebootOption": [
"RebootIfNeeded"
],
"SnapshotId": [
""
]
},
"InstanceIds": [],
"Targets": [
{
"Key": "InstanceIds",
"Values": [
"i-00ec29b21eEXAMPLE",
"i-09911ddd90EXAMPLE"
]
}
],
"RequestedDateTime": "2020-01-24T11:11:04.350000-08:00",
"Status": "Success",
"StatusDetails": "Success",
"OutputS3BucketName": "my-us-east-2-bucket",
"OutputS3KeyPrefix": "my-rc-output",
"MaxConcurrency": "50",
"MaxErrors": "0",
"TargetCount": 2,
"CompletedCount": 2,
"ErrorCount": 0,
"DeliveryTimedOutCount": 0,
"ServiceRole": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM",
"NotificationConfig": {
"NotificationArn": "arn:aws:sns:us-east-2:111222333444:my-us-east-2-notification-arn",
"NotificationEvents": [
"All"
],
"NotificationType": "Invocation"
},
"CloudWatchOutputConfig": {
"CloudWatchLogGroupName": "",
"CloudWatchOutputEnabled": false
}
}
]
}
Для получения дополнительной информации см. Запуск команд с помощью Systems Manager Run Command в Руководстве пользователя AWS Systems Manager.
Вывод
Команды -> (список)
(Необязательно) Список команд, запрошенных пользователем.
(структура)
Описание запроса команды.
CommandId -> (строка)
DocumentName -> (строка)
DocumentVersion -> (строка)
Comment -> (строка)
ExpiresAfter -> (метка времени)
DeliveryTimedOut для всех вызовов, имеющих статус InProgress , Pending или Delayed . ExpiresAfter вычисляется на основе общего таймаута для всей команды. Дополнительную информацию см. в руководстве пользователя Amazon Web Services Systems Manager в разделе «Понимание значений таймаута команд».Parameters -> (массив)
Значения параметров, которые должны быть вставлены в документ при выполнении команды.
ключ -> (строка)
значение -> (список)
InstanceIds -> (список)
Идентификаторы управляемых узлов, для которых был запрошен этот запрос.
(строка)
Targets -> (список)
Массив критериев поиска, которые нацелены на управляемые узлы с использованием пары «ключ-значение», которую вы указываете. Параметр Targets требуется, если вы не предоставили один или несколько идентификаторов управляемых узлов в вызове.
(структура)
Массив критериев поиска, которые нацелены на управляемые узлы с использованием пары «ключ-значение», которую вы указываете.
Примечание
Для задач типа «Run Command» в окне обслуживания необходимо указать один или несколько целевых объектов. В зависимости от задачи целевые объекты являются необязательными для других типов задач окна обслуживания (Automation, Lambda и Step Functions). Дополнительную информацию о выполнении задач без указания целевых объектов см. в руководстве пользователя Amazon Web Services Systems Manager в разделе «Регистрация задач окна обслуживания без целевых объектов».Поддерживаемые форматы включают следующие.
Key=tag-key,Values=tag-value-1,tag-value-2
Key=tag:tag-key,Values=tag-valueKey=ResourceGroup,Values=resource-group-nameKey=ParameterValues,Values=value-1,value-2,value-3- Для настройки всех экземпляров в регионе Amazon Web Services:
Key=AWS::EC2::Instance,Values=*Key=InstanceIds,Values=*
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2Key=resource-groups:Name,Values=resource-group-name- Кроме того, окна обслуживания поддерживают нацеливание на типы ресурсов:
Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2- Для настройки всех экземпляров в регионе Amazon Web Services:
Key=InstanceIds,Values=*
Дополнительную информацию о том, как отправлять команды, нацеленные на управляемые узлы с использованием параметров Key,Value , см. в руководстве пользователя Amazon Web Services Systems Manager в разделе «Назначение нескольких управляемых узлов».
Ключ -> (строка)
Значения -> (список)
Критерии, определенные пользователем, которые соответствуют Key . Например, если вы указали tag:ServerRole , вы можете указать value:WebServer , чтобы запустить команду на экземплярах, которые включают теги EC2 ServerRole,WebServer .
В зависимости от типа целевого объекта максимальное количество значений для ключа может быть меньше глобального максимума в 50.
(строка)
RequestedDateTime -> (метка времени)
Status -> (строка)
StatusDetails -> (строка)
Подробный статус выполнения команды. StatusDetails содержит более подробную информацию, чем Status, поскольку включает состояния, полученные из параметров ошибок и одновременного управления. StatusDetails может показывать другие результаты, чем Status. Дополнительную информацию об этих статусах см. в руководстве пользователя Amazon Web Services Systems Manager в разделе «Понимание статусов команд».
- Pending: Команда еще не отправлена ни одному управляемому узлу.
- In Progress: Команда была отправлена хотя бы одному управляемому узлу, но не достигла конечного состояния на всех управляемых узлах.
- Success: Команда успешно выполнилась на всех вызовах. Это конечное состояние.
- Delivery Timed Out: Значение MaxErrors или более вызовов команд показывает состояние Delivery Timed Out. Это конечное состояние.
- Execution Timed Out: Значение MaxErrors или более вызовов команд показывает состояние Execution Timed Out. Это конечное состояние.
- Failed: Значение MaxErrors или более вызовов команд показывает состояние Failed. Это конечное состояние.
- Incomplete: Команда была предпринята на всех управляемых узлах, и один или несколько вызовов не имеют значения Success, но недостаточно вызовов завершились неудачно для того, чтобы статус стал Failed. Это конечное состояние.
- Cancelled: Команда была прервана до завершения. Это конечное состояние.
- Rate Exceeded: Количество управляемых узлов, на которые нацелена команда, превысило ограничение учетной записи для ожидающих вызовов. Система отменила команду до ее запуска на любом управляемом узле. Это конечное состояние.
- Delayed: Система попыталась отправить команду на управляемый узел, но не смогла. Система повторно пытается.
OutputS3Region -> (строка)
OutputS3BucketName -> (строка)
OutputS3KeyPrefix -> (строка)
MaxConcurrency -> (строка)
MaxConcurrency , см. в разделе «Amazon Web Services Systems Manager Run Command» руководства пользователя Amazon Web Services Systems Manager.MaxErrors -> (строка)
0 . Дополнительную информацию о том, как использовать MaxErrors , см. в разделе «Amazon Web Services Systems Manager Run Command» руководства пользователя Amazon Web Services Systems Manager.TargetCount -> (целое число)
CompletedCount -> (целое число)
ErrorCount -> (целое число)
DeliveryTimedOutCount -> (целое число)
ServiceRole -> (строка)
NotificationConfig -> (структура)
Настройки для отправки уведомлений об изменениях статуса команды.
NotificationArn -> (строка)
NotificationEvents -> (список)
Различные события, для которых вы можете получать уведомления. Дополнительную информацию об этих событиях см. в руководстве пользователя Amazon Web Services Systems Manager в разделе «Мониторинг изменений статуса Systems Manager с помощью уведомлений Amazon SNS».
(строка)
NotificationType -> (строка)
Тип уведомления.
-
Command: Получить уведомление, когда статус команды меняется. -
Invocation: Для команд, отправленных на несколько управляемых узлов, получать уведомления на основе каждого узла, когда статус команды меняется.
CloudWatchOutputConfig -> (структура)
Информация Amazon CloudWatch Logs, куда вы хотите, чтобы Amazon Web Services Systems Manager отправлял вывод команды.
CloudWatchLogGroupName -> (строка)
Имя группы журналов CloudWatch Logs, куда вы хотите отправлять вывод команды. Если вы не укажете имя группы, Amazon Web Services Systems Manager автоматически создаст для вас группу журналов. Группа журналов использует следующий формат именования:
CloudWatchOutputEnabled -> (булево)
TimeoutSeconds -> (целое число)
TimeoutSeconds для команды.AlarmConfiguration -> (структура)
Подробная информация для сигнализации CloudWatch, применённой к вашей команде.
IgnorePollAlarmFailure -> (булево)
Alarms -> (список)
Имя сигнализации CloudWatch, указанной в конфигурации.
(структура)
Сигнализация CloudWatch, которую вы применяете к автоматизации или команде.
Name -> (строка)
TriggeredAlarms -> (список)
Сигнализация CloudWatch, которая была вызвана командой.
(структура)
Подробная информация о состоянии вашей сигнализации CloudWatch.
Name -> (строка)
State -> (строка)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.