[ aws . opsworkscm ]
describe-events
Описание
Описывает события для указанного сервера. Результаты упорядочены по времени, причём самые новые события идут первыми.
Данная операция является синхронной.
Исключение ResourceNotFoundException возникает, когда сервер не существует. Исключение ValidationException возникает, когда параметры запроса неверны.
См. также: Документация API AWS
Данная операция является постраничной. Для получения всего набора результатов могут потребоваться несколько API-вызовов. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе, содержащем постраничную информацию, аргумент --query должен извлекать данные из результатов следующих выражений запроса: ServerEvents
Синтаксис
describe-events
--server-name <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]
Параметры
--server-name (строка)
--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.
Для описания событий
Следующий пример describe-events возвращает информацию обо всех событиях, связанных с указанным сервером Chef Automate.
aws opsworks-cm describe-events \
--server-name 'automate-06'
Вывод для каждой записи события, возвращённой командой, аналогичен следующему примеру:
{
"ServerEvents": [
{
"CreatedAt": 2016-07-29T13:38:47.520Z,
"LogUrl": "https://s3.amazonaws.com/<bucket-name>/automate-06-20160729133847520",
"Message": "Updates successfully installed.",
"ServerName": "automate-06"
}
]
}
Дополнительную информацию см. в разделе «Общие советы по устранению неполадок» в Руководстве пользователя AWS OpsWorks.
Вывод
ServerEvents -> (список)
Содержит ответ на запрос DescribeEvents.
(структура)
Событие, связанное с сервером, например, начало обслуживания или резервного копирования.
CreatedAt -> (метка времени)
ServerName -> (строка)
Message -> (строка)
LogUrl -> (строка)
NextToken -> (строка)
DescribeEvents, присвоив маркер из предыдущих результатов параметру nextToken. Если больше результатов нет, значение параметра nextToken объекта ответа равно null. Указание значения nextToken, не возвращённого в предыдущих результатах, приведёт к возникновению InvalidNextTokenException.
© Copyright 2025, Amazon Web Services. Created using Sphinx.