Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

get-command-invocation

Описание

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

GetCommandInvocation только показывает статус выполнения плагина в документе. Чтобы получить состояние выполнения команды на конкретном управляемом узле, используйте ListCommandInvocations. Чтобы получить состояние выполнения команды по всем управляемым узлам, используйте ListCommands.

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

Синтаксис

  get-command-invocation
--command-id <value>
--instance-id <value>
[--plugin-name <value>]
[--cli-input-json | --cli-input-yaml]
[--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 (строка)

(Обязательно) Идентификатор управляемого узла, на который нацелена команда. Управляемый узел может быть экземпляром Amazon Elastic Compute Cloud (Amazon EC2), граничным устройством и локальным сервером или виртуальной машиной в вашей гибридной среде, настроенной для Amazon Web Services Systems Manager.

--plugin-name (строка)

Имя шага, для которого вы хотите получить подробные результаты. Если документ содержит только один шаг, вы можете опустить имя и детали для этого шага. Если документ содержит более одного шага, вы должны указать имя шага, для которого хотите просмотреть детали. Убедитесь, что вы указываете имя шага, а не имя плагина, например, aws:RunShellScript.

Чтобы найти PluginName, проверьте содержимое документа и найдите имя шага, для которого вам нужны детали. В качестве альтернативы, используйте ListCommandInvocations с параметрами CommandId и Details. PluginName - это атрибут Name объекта CommandPlugin в списке CommandPlugins.

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

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

Примеры

Примечание

Для использования следующих примеров, вам необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры имеют правила цитирования, похожие на unix-подобные. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Чтобы отобразить детали вызова команды

В следующем примере get-command-invocation примере перечисляются все вызовы указанной команды на указанном экземпляре.

aws ssm get-command-invocation \
    --command-id "ef7fdfd8-9b57-4151-a15c-db9a12345678" \
    --instance-id "i-1234567890abcdef0"

Вывод:

{
    "CommandId": "ef7fdfd8-9b57-4151-a15c-db9a12345678",
    "InstanceId": "i-1234567890abcdef0",
    "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE",
    "DocumentName": "AWS-UpdateSSMAgent",
    "DocumentVersion": "",
    "PluginName": "aws:updateSsmAgent",
    "ResponseCode": 0,
    "ExecutionStartDateTime": "2020-02-19T18:18:03.419Z",
    "ExecutionElapsedTime": "PT0.091S",
    "ExecutionEndDateTime": "2020-02-19T18:18:03.419Z",
    "Status": "Success",
    "StatusDetails": "Success",
    "StandardOutputContent": "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": "",
    "StandardErrorContent": "",
    "StandardErrorUrl": "",
    "CloudWatchOutputConfig": {
        "CloudWatchLogGroupName": "",
        "CloudWatchOutputEnabled": false
    }
}

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

Вывод

CommandId -> (строка)

Идентификатор родительской команды плагина вызова.

InstanceId -> (строка)

Идентификатор управляемого узла, на который нацелена команда. Управляемый узел может быть экземпляром Amazon Elastic Compute Cloud (Amazon EC2), периферийным устройством или локальным сервером или виртуальной машиной в вашей гибридной среде, настроенной для Amazon Web Services Systems Manager.

Comment -> (строка)

Текст комментария к команде.

DocumentName -> (строка)

Имя документа, который был запущен. Например, AWS-RunShellScript .

DocumentVersion -> (строка)

Версия документа Systems Manager (документ SSM), используемая в запросе.

PluginName -> (строка)

Имя плагина или имя шага, для которого предоставляются подробности. Например, aws:RunShellScript — это плагин.

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

Код ответа уровня ошибки для скрипта плагина. Если код ответа равен -1, значит, команда ещё не начала выполняться на управляемом узле или не была получена узлом.

ExecutionStartDateTime -> (строка)

Дата и время начала выполнения плагина. Дата и время записаны в формате ISO 8601. Например, 7 июня 2017 г. записывается как 2017-06-7. Следующая примерная команда Amazon Web Services CLI использует фильтр InvokedBefore.

aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z

Если плагин ещё не начал выполняться, строка пустая.

ExecutionElapsedTime -> (строка)

Прошлое время с момента ExecutionStartDateTime.

ExecutionEndDateTime -> (строка)

Дата и время завершения выполнения плагина. Дата и время записаны в формате ISO 8601. Например, 7 июня 2017 г. записывается как 2017-06-7. Следующая примерная команда Amazon Web Services CLI использует фильтр InvokedAfter.

aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z

Если плагин ещё не начал выполняться, строка пустая.

Status -> (строка)

Статус данного плагина вызова. Этот статус может отличаться от StatusDetails.

StatusDetails -> (строка)

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

  • Pending: Команда ещё не отправлена на управляемый узел.
  • In Progress: Команда отправлена на управляемый узел, но не достигла терминального состояния.
  • Delayed: Система пыталась отправить команду на целевой узел, но целевой узел был недоступен. Управляемый узел может быть недоступен из-за проблем с сетью, остановки узла или по аналогичным причинам. Система будет пытаться отправить команду снова.
  • Success: Команда или плагин были успешно выполнены. Это терминальное состояние.
  • Delivery Timed Out: Команда не была доставлена на управляемый узел до истечения времени ожидания доставки. Временные ограничения доставки не учитываются при подсчёте предела MaxErrors родительской команды, но они влияют на то, является ли статус родительской команды «Успешно» или «Незакончено». Это терминальное состояние.
  • Execution Timed Out: Команда начала выполняться на управляемом узле, но выполнение не было завершено до истечения времени ожидания. Временные ограничения выполнения учитываются при подсчёте предела MaxErrors родительской команды. Это терминальное состояние.
  • Failed: Команда не была успешно выполнена на управляемом узле. Для плагина это указывает на то, что код результата не равен нулю. Для вызова команды это указывает на то, что код результата для одного или нескольких плагинов не равен нулю. Ошибки вызова учитываются при подсчёте предела MaxErrors родительской команды. Это терминальное состояние.
  • Cancelled: Команда была прервана до завершения. Это терминальное состояние.
  • Undeliverable: Команда не может быть доставлена на управляемый узел. Узел может отсутствовать или не отвечать. Недоставляемые вызовы не учитываются при подсчёте предела MaxErrors родительской команды и не влияют на то, является ли статус родительской команды «Успешно» или «Незакончено». Это терминальное состояние.
  • Terminated: Родительская команда превысила свой предел MaxErrors, и последующие вызовы команд были отменены системой. Это терминальное состояние.

StandardOutputContent -> (строка)

Первые 24 000 символов, записанные плагином в stdout. Если команда ещё не завершила выполнение, а ExecutionStatus не имеет ни статуса «Успешно», ни «Ошибка», то эта строка пустая.

StandardOutputUrl -> (строка)

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

StandardErrorContent -> (строка)

Первые 8 000 символов, записанные плагином в stderr. Если команда ещё не завершила выполнение, то эта строка пустая.

StandardErrorUrl -> (строка)

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

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

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

CloudWatchLogGroupName -> (строка)

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

``aws/ssm/SystemsManagerDocumentName ``

CloudWatchOutputEnabled -> (булево)

Включает возможность отправки Systems Manager выходных данных команды в CloudWatch Logs.

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

Spec-Zone.ru

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