Spec-Zone.ru › AWS CLI v2

[ aws . ssm-sap ]

list-operation-events

Описание

Возвращает список событий операций.

Доступные параметры включают OperationID , а также необязательные параметры MaxResults , NextToken и Filters .

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

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

Синтаксис

  list-operation-events
--operation-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]

Параметры

--operation-id (строка)

Идентификатор операции.

--filters (список)

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

Допустимые имена фильтров включают status , resourceID и resourceType . Допустимый оператор для всех трех фильтров — Equals .

(структура)

Конкретный результат, полученный путем указания имени, значения и оператора.

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

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

Значения фильтра. Значения фильтров чувствительны к регистру. Если вы указываете несколько значений для фильтра, они объединяются с помощью ИЛИ, и запрос возвращает все результаты, соответствующие любому из указанных значений.

Оператор -> (строка)

Оператор для фильтра.

Сокращенный синтаксис:

Name=string,Value=string,Operator=string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Value": "string",
    "Operator": "Equals"|"GreaterThanOrEquals"|"LessThanOrEquals"
  }
  ...
]

--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-auto-prompt (логическое)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое)

Отключить автоматическую запрос ввода параметров CLI.

Вывод

OperationEvents -> (список)

Возвращаемый список событий операций, которые соответствуют критериям фильтра.

(структура)

Событие операции возвращает подробную информацию об операции, включая ключевые этапы, которые могут использоваться для мониторинга и отслеживания операций в процессе.

События операций содержат:

  • Описание строки
  • Ресурс, включая его ARN и тип
  • Состояние
  • Сообщение о состоянии строка
  • Отметка времени

Примеры событий операций включают StartApplication или StopApplication.

Описание -> (строка)

Описание события операции. Например, «Остановить экземпляр EC2 i-abcdefgh987654321».

Ресурс -> (структура)

Ресурс, участвующий в событии операции.

Содержит ResourceArn ARN и ResourceType .

ResourceArn -> (строка)

Amazon Resource Name (ARN) исходного ресурса.

Пример ResourceArn : «arn:aws:ec2:us-east-1:111111111111:instance/i-abcdefgh987654321»

ResourceType -> (строка)

Тип ресурса.

Пример ResourceType : «AWS::SystemsManagerSAP::Component» или «AWS::EC2::Instance».

Статус -> (строка)

Состояние события операции. Возможные состояния: IN_PROGRESS , COMPLETED и FAILED .

StatusMessage -> (строка)

Сообщение о состоянии, относящееся к конкретному событию операции.

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

Отметка времени указанного события операции.

NextToken -> (строка)

Токен для получения следующей страницы результатов. Это значение равно null, когда больше результатов возвращать не нужно.

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

Spec-Zone.ru

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