describe-events

Описание

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

Если критерии фильтра не указаны, возвращаются все события. Результаты сортируются по lastModifiedTime, начиная с самого последнего события.

Примечание

При вызове операции DescribeEvents и указании сущности для параметра entityValues, Health может вернуть публичные события, не относящиеся к данному ресурсу. Например, если вы вызываете DescribeEvents и указываете идентификатор экземпляра Amazon Elastic Compute Cloud (Amazon EC2), Health может вернуть события, которые не относятся к этому ресурсу или службе. Для получения событий, относящихся к конкретной службе, используйте параметр services в объекте filter. Дополнительную информацию см. в разделе Событие.
Данная операция API использует пагинацию. Укажите параметр nextToken в следующем запросе, чтобы получить больше результатов.

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

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

Синтаксис

  describe-events
[--filter <value>]
[--locale <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 -> (список)

Список дат и времени окончания события.

(структура)

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

Начальная дата и время диапазона.

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

Конечная дата и время диапазона.

lastUpdatedTimes -> (список)

Список дат и времени последнего обновления события.

(структура)

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", ...]
}

--locale (строка)

Регион (язык) для возврата информации. По умолчанию используется английский (en), и на данный момент это единственное поддерживаемое значение.

--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 для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Пример 1: Список событий AWS Health

Следующий describe-events пример выводит последние события AWS Health.

aws health describe-events \
    --region us-east-1

Вывод:

{
    "events": [
        {
            "arn": "arn:aws:health:us-west-1::event/ECS/AWS_ECS_OPERATIONAL_ISSUE/AWS_ECS_OPERATIONAL_ISSUE_KWQPY_EXAMPLE111",
            "service": "ECS",
            "eventTypeCode": "AWS_ECS_OPERATIONAL_ISSUE",
            "eventTypeCategory": "issue",
            "region": "us-west-1",
            "startTime": 1589077890.53,
            "endTime": 1589086345.597,
            "lastUpdatedTime": 1589086345.905,
            "statusCode": "closed",
            "eventScopeCode": "PUBLIC"
        },
        {
            "arn": "arn:aws:health:global::event/BILLING/AWS_BILLING_NOTIFICATION/AWS_BILLING_NOTIFICATION_6ce1d874-e995-40e2-99cd-EXAMPLE1118b",
            "service": "BILLING",
            "eventTypeCode": "AWS_BILLING_NOTIFICATION",
            "eventTypeCategory": "accountNotification",
            "region": "global",
            "startTime": 1588356000.0,
            "lastUpdatedTime": 1588356524.358,
            "statusCode": "open",
            "eventScopeCode": "ACCOUNT_SPECIFIC"
        },
        {
            "arn": "arn:aws:health:us-west-2::event/CLOUDFORMATION/AWS_CLOUDFORMATION_OPERATIONAL_ISSUE/AWS_CLOUDFORMATION_OPERATIONAL_ISSUE_OHTWY_EXAMPLE111",
            "service": "CLOUDFORMATION",
            "eventTypeCode": "AWS_CLOUDFORMATION_OPERATIONAL_ISSUE",
            "eventTypeCategory": "issue",
            "region": "us-west-2",
            "startTime": 1588279630.761,
            "endTime": 1588284650.0,
            "lastUpdatedTime": 1588284691.941,
            "statusCode": "closed",
            "eventScopeCode": "PUBLIC"
        },
        {
            "arn": "arn:aws:health:ap-northeast-1::event/LAMBDA/AWS_LAMBDA_OPERATIONAL_ISSUE/AWS_LAMBDA_OPERATIONAL_ISSUE_JZDND_EXAMPLE111",
            "service": "LAMBDA",
            "eventTypeCode": "AWS_LAMBDA_OPERATIONAL_ISSUE",
            "eventTypeCategory": "issue",
            "region": "ap-northeast-1",
            "startTime": 1587379534.08,
            "endTime": 1587391771.0,
            "lastUpdatedTime": 1587395689.316,
            "statusCode": "closed",
            "eventScopeCode": "PUBLIC"
        },
        {
            "arn": "arn:aws:health:us-east-1::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_COBXJ_EXAMPLE111",
            "service": "EC2",
            "eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE",
            "eventTypeCategory": "issue",
            "region": "us-east-1",
            "startTime": 1586473044.284,
            "endTime": 1586479706.091,
            "lastUpdatedTime": 1586479706.153,
            "statusCode": "closed",
            "eventScopeCode": "PUBLIC"
        },
        {
            "arn": "arn:aws:health:global::event/SECURITY/AWS_SECURITY_NOTIFICATION/AWS_SECURITY_NOTIFICATION_42007387-8129-42da-8c88-EXAMPLE11139",
            "service": "SECURITY",
            "eventTypeCode": "AWS_SECURITY_NOTIFICATION",
            "eventTypeCategory": "accountNotification",
            "region": "global",
            "startTime": 1585674000.0,
            "lastUpdatedTime": 1585674004.132,
            "statusCode": "open",
            "eventScopeCode": "PUBLIC"
        },
        {
            "arn": "arn:aws:health:global::event/CLOUDFRONT/AWS_CLOUDFRONT_OPERATIONAL_ISSUE/AWS_CLOUDFRONT_OPERATIONAL_ISSUE_FRQXG_EXAMPLE111",
            "service": "CLOUDFRONT",
            "eventTypeCode": "AWS_CLOUDFRONT_OPERATIONAL_ISSUE",
            "eventTypeCategory": "issue",
            "region": "global",
            "startTime": 1585610898.589,
            "endTime": 1585617671.0,
            "lastUpdatedTime": 1585620638.869,
            "statusCode": "closed",
            "eventScopeCode": "PUBLIC"
        },
        {
            "arn": "arn:aws:health:us-east-1::event/SES/AWS_SES_OPERATIONAL_ISSUE/AWS_SES_OPERATIONAL_ISSUE_URNDF_EXAMPLE111",
            "service": "SES",
            "eventTypeCode": "AWS_SES_OPERATIONAL_ISSUE",
            "eventTypeCategory": "issue",
            "region": "us-east-1",
            "startTime": 1585342008.46,
            "endTime": 1585344017.0,
            "lastUpdatedTime": 1585344355.989,
            "statusCode": "closed",
            "eventScopeCode": "PUBLIC"
        },
        {
            "arn": "arn:aws:health:global::event/IAM/AWS_IAM_OPERATIONAL_NOTIFICATION/AWS_IAM_OPERATIONAL_NOTIFICATION_b6771c34-6ecd-4aea-9d3e-EXAMPLE1117e",
            "service": "IAM",
            "eventTypeCode": "AWS_IAM_OPERATIONAL_NOTIFICATION",
            "eventTypeCategory": "accountNotification",
            "region": "global",
            "startTime": 1584978300.0,
            "lastUpdatedTime": 1584978553.572,
            "statusCode": "open",
            "eventScopeCode": "ACCOUNT_SPECIFIC"
        },
        {
            "arn": "arn:aws:health:ap-southeast-2::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_HNGHE_EXAMPLE111",
            "service": "EC2",
            "eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE",
            "eventTypeCategory": "issue",
            "region": "ap-southeast-2",
            "startTime": 1583881487.483,
            "endTime": 1583885056.785,
            "lastUpdatedTime": 1583885057.052,
            "statusCode": "closed",
            "eventScopeCode": "PUBLIC"
        }
    ]
}

Дополнительную информацию см. в руководстве пользователя AWS Health.

Пример 2: Список событий AWS Health по сервису и коду статуса события

Следующий describe-events пример выводит события AWS Health для Amazon Elastic Compute Cloud (Amazon EC2), где статус события — закрыт.

aws health describe-events \
    --filter "services=EC2,eventStatusCodes=closed"

Вывод:

{
    "events": [
        {
            "arn": "arn:aws:health:us-east-1::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_VKTXI_EXAMPLE111",
            "service": "EC2",
            "eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE",
            "eventTypeCategory": "issue",
            "region": "us-east-1",
            "startTime": 1587462325.096,
            "endTime": 1587464204.774,
            "lastUpdatedTime": 1587464204.865,
            "statusCode": "closed",
            "eventScopeCode": "PUBLIC"
        },
        {
            "arn": "arn:aws:health:us-east-1::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_COBXJ_EXAMPLE111",
            "service": "EC2",
            "eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE",
            "eventTypeCategory": "issue",
            "region": "us-east-1",
            "startTime": 1586473044.284,
            "endTime": 1586479706.091,
            "lastUpdatedTime": 1586479706.153,
            "statusCode": "closed",
            "eventScopeCode": "PUBLIC"
        },
        {
            "arn": "arn:aws:health:ap-southeast-2::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_HNGHE_EXAMPLE111",
            "service": "EC2",
            "eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE",
            "eventTypeCategory": "issue",
            "region": "ap-southeast-2",
            "startTime": 1583881487.483,
            "endTime": 1583885056.785,
            "lastUpdatedTime": 1583885057.052,
            "statusCode": "closed",
            "eventScopeCode": "PUBLIC"
        }
    ]
}

Дополнительную информацию см. в руководстве пользователя AWS Health.

Вывод

events -> (список)

События, соответствующие заданным критериям фильтра.

(структура)

Сводная информация об событии Health.

События Health могут быть общедоступными или специфичными для аккаунта:

Общедоступные события могут быть событиями сервиса, которые не являются специфичными для учетной записи Amazon Web Services. Например, если возникла проблема с регионом Amazon Web Services, Health предоставляет информацию о событии, даже если вы не используете сервисы или ресурсы в этом регионе.
События, специфичные для аккаунта, относятся к вашей учетной записи Amazon Web Services или учетной записи в вашей организации. Например, если возникла проблема с Amazon Elastic Compute Cloud в регионе, который вы используете, Health предоставляет информацию об событии и затронутых ресурсах в аккаунте.

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

arn -> (строка)

Уникальный идентификатор события. ARN события имеет формат ``arn:aws:health:event-region ::event/SERVICE /EVENT_TYPE_CODE /EVENT_TYPE_PLUS_ID ``.

Например, ARN события может выглядеть следующим образом:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

service -> (строка)

Сервис Amazon Web Services, затронутый событием. Например, EC2 , RDS .

eventTypeCode -> (строка)

Уникальный идентификатор типа события. Формат — AWS_*SERVICE* _*DESCRIPTION* `` ; for example, ``AWS_EC2_SYSTEM_MAINTENANCE_EVENT .

eventTypeCategory -> (строка)

Список кодов категорий типов событий. Возможные значения — issue , accountNotification или scheduledChange . В настоящее время значение investigation не поддерживается.

region -> (строка)

Имя региона Amazon Web Services события.

availabilityZone -> (строка)

Зона доступности Amazon Web Services события. Например, us-east-1a.

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

Дата и время начала события.

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

Дата и время окончания события.

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

Последняя дата и время обновления события.

statusCode -> (строка)

Последний статус события. Возможные значения — open , closed и upcoming.

eventScopeCode -> (строка)

Этот параметр указывает, является ли событие Health общедоступным событием сервиса Amazon Web Services или событием, специфичным для аккаунта.

Если значение eventScopeCode равно PUBLIC, то значение affectedAccounts всегда пустое.
Если значение eventScopeCode равно ACCOUNT_SPECIFIC, то значение affectedAccounts перечисляет затронутые учетные записи Amazon Web Services в вашей организации. Например, если событие влияет на сервис, такой как Amazon Elastic Compute Cloud, и у вас есть учетные записи Amazon Web Services, которые используют этот сервис, ID этих учетных записей появятся в ответе.
Если значение eventScopeCode равно NONE, то значение eventArn, которое вы указали в запросе, недействительно или не существует.

nextToken -> (строка)

Если результаты поиска большие, возвращается только часть результатов, и в ответе возвращается маркер постраничной навигации nextToken. Чтобы получить следующую партию результатов, повторите запрос поиска и включите возвращённый маркер. Когда все результаты возвращены, ответ не содержит значение маркера постраничной навигации.