Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

list-command-invocations

Описание

Вызов — это копия команды, отправленной на конкретный управляемый узел. Команда может применяться к одному или нескольким управляемым узлам. Вызов команды применяется к одному управляемому узлу. Например, если пользователь запускает SendCommand на трёх управляемых узлах, то для каждого запрошенного идентификатора управляемого узла создаётся вызов команды. ListCommandInvocations отображают состояние выполнения команды.

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

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

Синтаксис

  list-command-invocations
[--command-id <value>]
[--instance-id <value>]
[--filters <value>]
[--details | --no-details]
[--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 (строка)

(Необязательно) Сведения о выполнении команды для определённого идентификатора управляемого узла.

--filters (список)

(Необязательно) Один или несколько фильтров. Используйте фильтр для получения более конкретного списка результатов.

(структура)

Описывает фильтр команды.

Примечание

Идентификатор управляемого узла не может быть указан, когда состояние команды является Pending, так как команда ещё не выполнена на узле.

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

Название фильтра.

Примечание

Фильтр ExecutionStage не может быть использован с операцией ListCommandInvocations, только с операцией ListCommands.

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

Значение фильтра. Допустимые значения для каждого ключа фильтра следующие:

  • InvokedAfter : Укажите метку времени, чтобы ограничить результаты. Например, укажите 2024-07-07T00:00:00Z, чтобы увидеть список выполнений команд, произошедших 7 июля 2021 года и позже.
  • InvokedBefore : Укажите метку времени, чтобы ограничить результаты. Например, укажите 2024-07-07T00:00:00Z, чтобы увидеть список выполнений команд до 7 июля 2021 года.
  • Status : Укажите допустимое состояние команды, чтобы увидеть список всех выполнений команд с этим состоянием. Варианты состояний зависят от вызываемого API. Допустимые значения состояния для ListCommands:
    • Pending
    • InProgress
    • Success
    • Cancelled
    • Failed
    • TimedOut (включает таймауты доставки и выполнения)
    • AccessDenied
    • DeliveryTimedOut
    • ExecutionTimedOut
    • Incomplete
    • NoInstancesInTag
    • LimitExceeded

Допустимые значения состояния для ListCommandInvocations:

  • Pending
  • InProgress
  • Delayed
  • Success
  • Cancelled
  • Failed
  • TimedOut (включает таймауты доставки и выполнения)
  • AccessDenied
  • DeliveryTimedOut
  • ExecutionTimedOut
  • Undeliverable
  • InvalidPlatform
  • Terminated
  • 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"
  }
  ...
]

--details | --no-details (логическое значение)

(Необязательно) Если установлено, возвращает ответ на выполнение команд и любой вывод команды. Значение по умолчанию — false.

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

Для вывода списка вызовов определённой команды

Следующий пример list-command-invocations выводит все вызовы команды.

aws ssm list-command-invocations \
    --command-id "ef7fdfd8-9b57-4151-a15c-db9a12345678" \
    --details

Вывод:

{
    "CommandInvocations": [
        {
            "CommandId": "ef7fdfd8-9b57-4151-a15c-db9a12345678",
            "InstanceId": "i-02573cafcfEXAMPLE",
            "InstanceName": "",
            "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE",
            "DocumentName": "AWS-UpdateSSMAgent",
            "DocumentVersion": "",
            "RequestedDateTime": 1582136283.089,
            "Status": "Success",
            "StatusDetails": "Success",
            "StandardOutputUrl": "",
            "StandardErrorUrl": "",
            "CommandPlugins": [
                {
                    "Name": "aws:updateSsmAgent",
                    "Status": "Success",
                    "StatusDetails": "Success",
                    "ResponseCode": 0,
                    "ResponseStartDateTime": 1582136283.419,
                    "ResponseFinishDateTime": 1582136283.51,
                    "Output": "Updating amazon-ssm-agent from 2.3.842.0 to latest\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/ssm-agent-manifest.json\namazon-ssm-agent 2.3.842.0 has already been installed, update skipped\n",
                    "StandardOutputUrl": "",
                    "StandardErrorUrl": "",
                    "OutputS3Region": "us-east-2",
                    "OutputS3BucketName": "",
                    "OutputS3KeyPrefix": ""
                }
            ],
            "ServiceRole": "",
            "NotificationConfig": {
                "NotificationArn": "",
                "NotificationEvents": [],
                "NotificationType": ""
            },
            "CloudWatchOutputConfig": {
                "CloudWatchLogGroupName": "",
                "CloudWatchOutputEnabled": false
            }
        },
        {
            "CommandId": "ef7fdfd8-9b57-4151-a15c-db9a12345678",
            "InstanceId": "i-0471e04240EXAMPLE",
            "InstanceName": "",
            "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE",
            "DocumentName": "AWS-UpdateSSMAgent",
            "DocumentVersion": "",
            "RequestedDateTime": 1582136283.02,
            "Status": "Success",
            "StatusDetails": "Success",
            "StandardOutputUrl": "",
            "StandardErrorUrl": "",
            "CommandPlugins": [
                {
                    "Name": "aws:updateSsmAgent",
                    "Status": "Success",
                    "StatusDetails": "Success",
                    "ResponseCode": 0,
                    "ResponseStartDateTime": 1582136283.812,
                    "ResponseFinishDateTime": 1582136295.031,
                    "Output": "Updating amazon-ssm-agent from 2.3.672.0 to latest\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/ssm-agent-manifest.json\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/amazon-ssm-agent-updater/2.3.842.0/amazon-ssm-agent-updater-snap-amd64.tar.gz\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/amazon-ssm-agent/2.3.672.0/amazon-ssm-agent-snap-amd64.tar.gz\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/amazon-ssm-agent/2.3.842.0/amazon-ssm-agent-snap-amd64.tar.gz\nInitiating amazon-ssm-agent update to 2.3.842.0\namazon-ssm-agent updated successfully to 2.3.842.0",
                    "StandardOutputUrl": "",
                    "StandardErrorUrl": "",
                    "OutputS3Region": "us-east-2",
                    "OutputS3BucketName": "",
                    "OutputS3KeyPrefix": "8bee3135-398c-4d31-99b6-e42d2EXAMPLE/i-0471e04240EXAMPLE/awsupdateSsmAgent"
                }
            ],
            "ServiceRole": "",
            "NotificationConfig": {
                "NotificationArn": "",
                "NotificationEvents": [],
                "NotificationType": ""
            },
            "CloudWatchOutputConfig": {
                "CloudWatchLogGroupName": "",
                "CloudWatchOutputEnabled": false
            }
        }
    ]
}

Дополнительные сведения см. в разделе Понимание состояний команд в Руководстве пользователя AWS Systems Manager.

Вывод

CommandInvocations -> (список)

(Необязательно) Список всех вызовов.

(структура)

Вызов — это копия команды, отправленной на конкретный управляемый узел. Команда может применяться к одному или нескольким управляемым узлам. Вызов команды применяется к одному управляемому узлу. Например, если пользователь выполняет SendCommand на трех управляемых узлах, то для каждого запрошенного идентификатора управляемого узла создается вызов команды. Вызов команды возвращает статус и подробную информацию о выполнении вами команды.

CommandId -> (строка)

Команда, для которой был запрошен этот вызов.

InstanceId -> (строка)

Идентификатор управляемого узла, для которого был запрошен этот вызов.

InstanceName -> (строка)

Полное доменное имя управляемого узла.

Comment -> (строка)

Указанная пользователем информация о команде, например, краткое описание того, что должна сделать команда.

DocumentName -> (строка)

Имя документа, которое было запрошено для выполнения.

DocumentVersion -> (строка)

Версия документа Systems Manager (SSM).

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

Дата и время отправки запроса на этот управляемый узел.

Status -> (строка)

Указывает, был ли вызов успешным, неудачным или находится в ожидании.

StatusDetails -> (строка)

Подробный статус выполнения команды для каждого вызова (для каждого управляемого узла, на который была нацелена команда). StatusDetails содержит более подробную информацию, чем Status, поскольку включает состояния, полученные в результате ошибок и параметров управления одновременностью. StatusDetails может показывать другие результаты, чем Status. Для получения дополнительной информации об этих статусах см. Раздел «Понимание статусов команд» в руководстве пользователя Amazon Web Services Systems Manager . StatusDetails может принимать следующие значения:

  • Ожидание: команда еще не отправлена на управляемый узел.
  • В процессе: команда отправлена на управляемый узел, но еще не достигла конечного состояния.
  • Успешно: выполнение команды или плагина было успешно завершено. Это конечное состояние.
  • Таймаут доставки: команда не была доставлена на управляемый узел до истечения таймаута доставки. Таймауты доставки не учитываются при подсчете лимита MaxErrors родительской команды, но они влияют на то, является ли статус родительской команды «Успешно» или «Незавершенно». Это конечное состояние.
  • Таймаут выполнения: выполнение команды на управляемом узле началось, но не было завершено до истечения таймаута выполнения. Таймауты выполнения учитываются при подсчете лимита MaxErrors родительской команды. Это конечное состояние.
  • Неудачно: команда не была успешно выполнена на управляемом узле. Для плагина это указывает, что код результата не равен нулю. Для вызова команды это указывает, что код результата для одного или нескольких плагинов не равен нулю. Неудачные вызовы учитываются при подсчете лимита MaxErrors родительской команды. Это конечное состояние.
  • Отменено: команда была прервана до завершения. Это конечное состояние.
  • Невозможно доставить: команду невозможно доставить на управляемый узел. Управляемый узел может отсутствовать или не отвечать. Недоставляемые вызовы не учитываются при подсчете лимита MaxErrors родительской команды и не влияют на то, является ли статус родительской команды «Успешно» или «Незавершенно». Это конечное состояние.
  • Прервано: родительская команда превысила свой лимит MaxErrors, и последующие вызовы команд были отменены системой. Это конечное состояние.
  • Задержка: система пыталась отправить команду на управляемый узел, но не смогла. Система повторно пытается.

TraceOutput -> (строка)

Получает вывод отслеживания, отправленный агентом.

StandardOutputUrl -> (строка)

URL-адрес файла StdOut плагина в Amazon Simple Storage Service (Amazon S3), если для родительской команды был определен S3-ведро. Для вызова StandardOutputUrl заполняется, если для команды определен только один плагин, а S3-ведро определено для команды.

StandardErrorUrl -> (строка)

URL-адрес файла StdErr плагина в Amazon Simple Storage Service (Amazon S3), если для родительской команды было определено S3-ведро. Для вызова StandardErrorUrl заполняется, если для команды определен только один плагин, а S3-ведро определено для команды.

CommandPlugins -> (список)

Плагины, обработанные командой.

(структура)

Описание подробностей плагина.

Name -> (строка)

Имя плагина. Должно быть одним из следующих: aws:updateAgent , aws:domainjoin , aws:applications , aws:runPowerShellScript , aws:psmodule , aws:cloudWatch , aws:runShellScript или aws:updateSSMAgent .

Status -> (строка)

Статус этого плагина. Вы можете выполнить документ с несколькими плагинами.

StatusDetails -> (строка)

Подробный статус выполнения плагина. StatusDetails включает более подробную информацию, чем Status, поскольку включает состояния, полученные в результате ошибок и параметров управления одновременностью. StatusDetails может показывать другие результаты, чем Status. Для получения дополнительной информации об этих статусах см. Раздел «Понимание статусов команд» в руководстве пользователя Amazon Web Services Systems Manager . StatusDetails может принимать следующие значения:

  • Ожидание: команда еще не отправлена на управляемый узел.
  • В процессе: команда отправлена на управляемый узел, но еще не достигла конечного состояния.
  • Успешно: выполнение команды или плагина было успешно завершено. Это конечное состояние.
  • Таймаут доставки: команда не была доставлена на управляемый узел до истечения таймаута доставки. Таймауты доставки не учитываются при подсчете лимита MaxErrors родительской команды, но они влияют на то, является ли статус родительской команды «Успешно» или «Незавершенно». Это конечное состояние.
  • Таймаут выполнения: выполнение команды на управляемом узле началось, но не было завершено до истечения таймаута выполнения. Таймауты выполнения учитываются при подсчете лимита MaxErrors родительской команды. Это конечное состояние.
  • Неудачно: команда не была успешно выполнена на управляемом узле. Для плагина это указывает, что код результата не равен нулю. Для вызова команды это указывает, что код результата для одного или нескольких плагинов не равен нулю. Неудачные вызовы учитываются при подсчете лимита MaxErrors родительской команды. Это конечное состояние.
  • Отменено: команда была прервана до завершения. Это конечное состояние.
  • Невозможно доставить: команду невозможно доставить на управляемый узел. Управляемый узел может отсутствовать или не отвечать. Недоставляемые вызовы не учитываются при подсчете лимита MaxErrors родительской команды и не влияют на то, является ли статус родительской команды «Успешно» или «Незавершенно». Это конечное состояние.
  • Прервано: родительская команда превысила свой лимит MaxErrors, и последующие вызовы команд были отменены системой. Это конечное состояние.

ResponseCode -> (целое число)

Числовой код ответа, сгенерированный после выполнения плагина.

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

Время начала выполнения плагина.

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

Время остановки выполнения плагина. Может остановиться преждевременно, если, например, была отправлена команда отмены.

Output -> (строка)

Вывод выполнения плагина.

StandardOutputUrl -> (строка)

URL-адрес полного текста, записанного плагином в stdout в Amazon S3. Если S3-ведро для команды не было указано, то эта строка пуста.

StandardErrorUrl -> (строка)

URL-адрес полного текста, записанного плагином в stderr. Если выполнение еще не завершено, эта строка пуста.

OutputS3Region -> (строка)

(Устарело) Вы больше не можете указать этот параметр. Система его игнорирует. Вместо этого Amazon Web Services Systems Manager автоматически определяет регион S3-ведра.

OutputS3BucketName -> (строка)

S3-ведро, в котором должны храниться ответы на выполнение команд. Этот параметр был запрошен при вызове команды. Например, в следующем ответе:

amzn-s3-demo-bucket/my-prefix/i-02573cafcfEXAMPLE/awsrunShellScript

amzn-s3-demo-bucket — имя S3-ведра;

my-prefix — имя префикса S3;

i-02573cafcfEXAMPLE — идентификатор управляемого узла;

awsrunShellScript — имя плагина.

OutputS3KeyPrefix -> (строка)

Путь к каталогу S3 внутри ведра, где должны храниться ответы на выполнение команд. Этот параметр был запрошен при вызове команды. Например, в следующем ответе:

amzn-s3-demo-bucket/my-prefix/i-02573cafcfEXAMPLE/awsrunShellScript

amzn-s3-demo-bucket — имя S3-ведра;

my-prefix — имя префикса S3;

i-02573cafcfEXAMPLE — идентификатор управляемого узла;

awsrunShellScript — имя плагина.

ServiceRole -> (строка)

Служебная роль Identity and Access Management (IAM), которую Run Command (инструмент в Amazon Web Services Systems Manager) использует для действий от вашего имени при отправке уведомлений о изменениях статуса команды на основе каждого управляемого узла.

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

Настройки для отправки уведомлений о изменениях статуса команды на основе каждого управляемого узла.

NotificationArn -> (строка)

Идентификатор ресурса Amazon (ARN) темы Amazon Simple Notification Service (Amazon SNS). Run Command отправляет уведомления о изменениях статуса команды в эту тему.

NotificationEvents -> (список)

Различные события, для которых вы можете получать уведомления. Дополнительную информацию об этих событиях см. в разделе «Мониторинг изменений статуса Systems Manager с помощью уведомлений Amazon SNS» в руководстве пользователя Amazon Web Services Systems Manager .

(строка)

NotificationType -> (строка)

Тип уведомления.

  • Command : Получать уведомления при изменении статуса команды.
  • Invocation : Для команд, отправленных на несколько управляемых узлов, получать уведомления на основе каждого узла при изменении статуса команды.

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

Информация Amazon CloudWatch Logs, куда Amazon Web Services Systems Manager хочет отправлять вывод команды.

CloudWatchLogGroupName -> (строка)

Имя группы журналов CloudWatch Logs, куда вы хотите отправлять вывод команды. Если вы не укажете имя группы, Amazon Web Services Systems Manager автоматически создаст для вас группу журналов. Имя группы журналов использует следующий формат:

``aws/ssm/SystemsManagerDocumentName ``

CloudWatchOutputEnabled -> (булево значение)

Включает отправку вывода команды в CloudWatch Logs.

NextToken -> (строка)

(Необязательно) Токен для следующего набора элементов. (Вы получили этот токен в предыдущем вызове.)

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

Spec-Zone.ru

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