describe-event-aggregates
Описание
Возвращает количество событий каждого типа (проблема, запланированное изменение и уведомление об аккаунте). Если не указаны фильтры, возвращаются подсчёты всех событий в каждой категории.
Примечание
Данный API-запрос использует пагинацию. Укажите параметрnextToken в следующем запросе, чтобы получить больше результатов.См. также: Документацию API AWS
describe-event-aggregates является запросом с пагинацией. Для получения всего набора результатов могут быть выполнены несколько API-запросов. Вы можете отключить пагинацию, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с пагинацией, аргумент --query должен извлекать данные из результатов следующих выражений запроса: eventAggregates
Синтаксис
describe-event-aggregates
[--filter <value>]
--aggregate-field <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]
Параметры
--filter (структура)
Значения для сужения результатов.
eventArns -> (список)
Список ARN событий (уникальные идентификаторы). Например: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
(строка)
eventTypeCodes -> (список)
Список уникальных идентификаторов типов событий. Например, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
(строка)
services -> (список)
Услуги Amazon Web Services, связанные с событием. Например, EC2 , RDS .
(строка)
regions -> (список)
Список регионов Amazon Web Services.
(строка)
availabilityZones -> (список)
Список зон доступности Amazon Web Services.
(строка)
startTimes -> (список)
Список дат и времён начала события.
(структура)
Диапазон дат и времён, используемый объектами EventFilter и EntityFilter. Если from задано и to задано: соответствие элементам, где метка времени (startTime , endTime или lastUpdatedTime ) находится между from и to включительно. Если from задано и to не задано: соответствие элементам, где значение метки времени равно или после from . Если from не задано и to задано: соответствие элементам, где значение метки времени равно или до to .
from -> (метка времени)
to -> (метка времени)
endTimes -> (список)
Список дат и времён окончания события.
(структура)
Диапазон дат и времён, используемый объектами EventFilter и EntityFilter. Если from задано и to задано: соответствие элементам, где метка времени (startTime , endTime или lastUpdatedTime ) находится между from и to включительно. Если from задано и to не задано: соответствие элементам, где значение метки времени равно или после from . Если from не задано и to задано: соответствие элементам, где значение метки времени равно или до to .
from -> (метка времени)
to -> (метка времени)
lastUpdatedTimes -> (список)
Список дат и времён последнего обновления события.
(структура)
Диапазон дат и времён, используемый объектами EventFilter и EntityFilter. Если from задано и to задано: соответствие элементам, где метка времени (startTime , endTime или lastUpdatedTime ) находится между from и to включительно. Если from задано и to не задано: соответствие элементам, где значение метки времени равно или после from . Если from не задано и to задано: соответствие элементам, где значение метки времени равно или до to .
from -> (метка времени)
to -> (метка времени)
entityArns -> (список)
Список ARN сущностей (уникальные идентификаторы).
(строка)
entityValues -> (список)
Список идентификаторов сущностей, таких как ID экземпляров EC2 (i-34ab692e ) или тома EBS (vol-426ab23e ).
(строка)
eventTypeCategories -> (список)
Список кодов категории типов событий. Возможные значения: issue , accountNotification или scheduledChange . В настоящее время значение investigation не поддерживается.
(строка)
tags -> (список)
Карта тегов сущностей, прикреплённых к затронутой сущности.
Примечание
В настоящее время свойствоtags не поддерживается.(карта)
key -> (строка)
value -> (строка)
eventStatusCodes -> (список)
Список кодов состояния событий.
(строка)
Сокращённый синтаксис:
eventArns=string,string,eventTypeCodes=string,string,services=string,string,regions=string,string,availabilityZones=string,string,startTimes=[{from=timestamp,to=timestamp},{from=timestamp,to=timestamp}],endTimes=[{from=timestamp,to=timestamp},{from=timestamp,to=timestamp}],lastUpdatedTimes=[{from=timestamp,to=timestamp},{from=timestamp,to=timestamp}],entityArns=string,string,entityValues=string,string,eventTypeCategories=string,string,tags=[{KeyName1=string,KeyName2=string},{KeyName1=string,KeyName2=string}],eventStatusCodes=string,string
Синтаксис JSON:
{
"eventArns": ["string", ...],
"eventTypeCodes": ["string", ...],
"services": ["string", ...],
"regions": ["string", ...],
"availabilityZones": ["string", ...],
"startTimes": [
{
"from": timestamp,
"to": timestamp
}
...
],
"endTimes": [
{
"from": timestamp,
"to": timestamp
}
...
],
"lastUpdatedTimes": [
{
"from": timestamp,
"to": timestamp
}
...
],
"entityArns": ["string", ...],
"entityValues": ["string", ...],
"eventTypeCategories": ["issue"|"accountNotification"|"scheduledChange"|"investigation", ...],
"tags": [
{"string": "string"
...}
...
],
"eventStatusCodes": ["open"|"closed"|"upcoming", ...]
}
--aggregate-field (строка)
Единственное в настоящее время поддерживаемое значение - eventTypeCategory .
Возможные значения:
eventTypeCategory
--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 (boolean)
Включить отладку логов.
--endpoint-url (string)
Переопределить URL команды заданным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использовать определенный профиль из файла учетных данных.
--region (string)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (string)
Отобразить версию этого инструмента.
--color (string)
Включить/отключить цветной вывод.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (string)
Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (string)
Стиль форматирования, используемый для бинарных блоков. По умолчанию формат — 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 (boolean)
Отключить кли-пагинатор для вывода.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматический запрос параметров ввода CLI.
Вывод
eventAggregates -> (список)
Количество событий в каждой категории, удовлетворяющих необязательным критериям фильтрации.
(структура)
Количество событий каждого типа проблемы. Возвращается операцией DescribeEventAggregates.
aggregateValue -> (строка)
count -> (целое число)
nextToken -> (строка)
nextToken постраничной навигации. Чтобы получить следующую партию результатов, повторно отправьте запрос на поиск и включите возвращенный маркер. Когда все результаты получены, ответ не содержит значения маркера постраничной навигации.
© Copyright 2025, Amazon Web Services. Created using Sphinx.