describe-events-for-organization
Описание
Возвращает информацию об событиях по всей вашей организации в Organizations. Вы можете использовать параметр ``filters``, чтобы указать события, которые хотите получить. События возвращаются в сводной форме и не включают затронутые аккаунты, подробное описание, дополнительную метаданные, зависящую от типа события, или затронутые ресурсы. Чтобы получить эту информацию, используйте следующие операции:
- DescribeAffectedAccountsForOrganization
- DescribeEventDetailsForOrganization
- DescribeAffectedEntitiesForOrganization
Если вы не укажете filter , то DescribeEventsForOrganizations вернёт все события по всей вашей организации. Результаты сортируются по lastModifiedTime , начиная с самого последнего события.
Дополнительную информацию о различных типах событий Health см. в разделе Событие.
Прежде чем вы сможете вызвать эту операцию, необходимо сначала включить Health для работы с Organizations. Для этого вызовите операцию EnableHealthServiceAccessForOrganization из учётной записи управления вашей организацией.
Примечание
Данная операция API использует пагинацию. Укажите параметрnextToken в следующем запросе, чтобы получить больше результатов.См. также: Документация AWS API
describe-events-for-organization является операцией с пагинацией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить пагинацию, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с пагинацией, аргумент --query должен извлекать данные из результатов следующих выражений запросов: events
Синтаксис
describe-events-for-organization
[--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 (структура)
Значения для сужения результатов.
eventTypeCodes -> (список)
Список уникальных идентификаторов типов событий. Например, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
(строка)
awsAccountIds -> (список)
Список 12-значных номеров счетов Amazon Web Services, содержащих затронутые сущности.
(строка)
services -> (список)
Услуги Amazon Web Services, связанные с событием. Например, EC2 , RDS .
(строка)
regions -> (список)
Список областей Amazon Web Services.
(строка)
startTime -> (структура)
Диапазон дат и времени, используемый объектами EventFilter и EntityFilter. Если from установлено и to установлено: соответствие элементам, где временная метка (startTime , endTime или lastUpdatedTime ) находится между from и to включительно. Если from установлено и to не установлено: соответствие элементам, где значение временной метки равно или после from . Если from не установлено и to установлено: соответствие элементам, где значение временной метки равно или до to .
from -> (временная метка)
to -> (временная метка)
endTime -> (структура)
Диапазон дат и времени, используемый объектами EventFilter и EntityFilter. Если from установлено и to установлено: соответствие элементам, где временная метка (startTime , endTime или lastUpdatedTime ) находится между from и to включительно. Если from установлено и to не установлено: соответствие элементам, где значение временной метки равно или после from . Если from не установлено и to установлено: соответствие элементам, где значение временной метки равно или до to .
from -> (временная метка)
to -> (временная метка)
lastUpdatedTime -> (структура)
Диапазон дат и времени, используемый объектами EventFilter и EntityFilter. Если from установлено и to установлено: соответствие элементам, где временная метка (startTime , endTime или lastUpdatedTime ) находится между from и to включительно. Если from установлено и to не установлено: соответствие элементам, где значение временной метки равно или после from . Если from не установлено и to установлено: соответствие элементам, где значение временной метки равно или до to .
from -> (временная метка)
to -> (временная метка)
entityArns -> (список)
Список entity ARNs (уникальных идентификаторов).
(строка)
entityValues -> (список)
Список идентификаторов сущностей, таких как ID экземпляра EC2 (i-34ab692e) или объёмы EBS (vol-426ab23e).
(строка)
eventTypeCategories -> (список)
Список кодов категорий типа события. Возможные значения: issue , accountNotification или scheduledChange . В настоящее время значение investigation не поддерживается.
(строка)
eventStatusCodes -> (список)
Список кодов состояния события.
(строка)
Краткая форма синтаксиса:
eventTypeCodes=string,string,awsAccountIds=string,string,services=string,string,regions=string,string,startTime={from=timestamp,to=timestamp},endTime={from=timestamp,to=timestamp},lastUpdatedTime={from=timestamp,to=timestamp},entityArns=string,string,entityValues=string,string,eventTypeCategories=string,string,eventStatusCodes=string,string
Синтаксис JSON:
{
"eventTypeCodes": ["string", ...],
"awsAccountIds": ["string", ...],
"services": ["string", ...],
"regions": ["string", ...],
"startTime": {
"from": timestamp,
"to": timestamp
},
"endTime": {
"from": timestamp,
"to": timestamp
},
"lastUpdatedTime": {
"from": timestamp,
"to": timestamp
},
"entityArns": ["string", ...],
"entityValues": ["string", ...],
"eventTypeCategories": ["issue"|"accountNotification"|"scheduledChange"|"investigation", ...],
"eventStatusCodes": ["open"|"closed"|"upcoming", ...]
}
--locale (строка)
--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.
Вывод
events -> (список)
События, соответствующие заданным критериям фильтрации.
(структура)
Сводная информация о событии, возвращаемая операцией DescribeEventsForOrganization.
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-DEF456service -> (строка)
eventTypeCode -> (строка)
AWS_SERVICE_DESCRIPTION. Например, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.eventTypeCategory -> (строка)
issue, accountNotification или scheduledChange. В настоящее время значение investigation не поддерживается.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, которое вы указали в запросе, недействительно или не существует.
region -> (строка)
startTime -> (временная метка)
endTime -> (временная метка)
lastUpdatedTime -> (временная метка)
statusCode -> (строка)
open, closed и upcoming.nextToken -> (строка)
nextToken. Чтобы получить следующую партию результатов, необходимо повторно выполнить запрос поиска и включить возвращенный маркер. Когда все результаты возвращены, в ответе отсутствует значение маркера постраничной навигации.
© Copyright 2025, Amazon Web Services. Created using Sphinx.