Spec-Zone.ru › AWS CLI v2

[ aws . health ]

describe-event-details-for-organization

Описание

Возвращает подробную информацию об одном или нескольких указанных событиях для одной или нескольких учетных записей Amazon Web Services в вашей организации. Эта информация включает стандартные данные о событии (такие как регион Amazon Web Services и служба), описание события и (в зависимости от события) возможные метаданные. Данный оператор не возвращает затронутые сущности, такие как ресурсы, связанные с событием. Чтобы получить затронутые сущности, используйте операцию DescribeAffectedEntitiesForOrganization.

Примечание

Прежде чем вы сможете вызвать эту операцию, вам необходимо сначала включить работу Health с Организациями. Для этого вызовите операцию EnableHealthServiceAccessForOrganization из учетной записи управления вашей организации.

При вызове операции DescribeEventDetailsForOrganization укажите объект organizationEventDetailFilters в запросе. В зависимости от типа события Health, обратите внимание на следующие различия:

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

Дополнительную информацию см. в разделе Событие.

Примечание

Данная операция не поддерживает разрешения на уровне ресурсов. Вы не можете использовать эту операцию для разрешения или запрещения доступа к конкретным событиям Health. Дополнительную информацию см. в разделе Условия на основе ресурсов и действий в руководстве пользователя Health.

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

Синтаксис

  describe-event-details-for-organization
--organization-event-detail-filters <value>
[--locale <value>]
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

--organization-event-detail-filters (список)

Набор JSON-элементов, включающий awsAccountId и eventArn.

(структура)

Значения, используемые для фильтрации результатов операций DescribeEventDetailsForOrganization и DescribeAffectedEntitiesForOrganization.

eventArn -> (строка)

Уникальный идентификатор события. Event 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

awsAccountId -> (строка)

12-значные номера учетных записей Amazon Web Services, содержащие затронутые сущности.

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

eventArn=string,awsAccountId=string ...

Синтаксис JSON:

[
  {
    "eventArn": "string",
    "awsAccountId": "string"
  }
  ...
]

--locale (строка)

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

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные через JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет интерпретироваться буквально. Это параметр не может быть указан вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение null или строка 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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--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.

Вывод

successfulSet -> (список)

Информация об событиях, которые можно было получить.

(структура)

Подробная информация об событии. Сочетание объекта Event, объекта EventDescription и дополнительной метаданных о событии. Возвращается операцией DescribeEventDetailsForOrganization.

awsAccountId -> (строка)

12-значные номера счетов Amazon Web Services, содержащие затронутые сущности.

event -> (структура)

Сводная информация о событии 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, которые используют этот сервис, эти идентификаторы учетных записей будут указаны в ответе.
  • Если значение eventScopeCode равно NONE, то указанный вами в запросе eventArn недействителен или не существует.

eventDescription -> (структура)

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

latestDescription -> (строка)

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

eventMetadata -> (массив)

Дополнительные метаданные о событии.

key -> (строка)

value -> (строка)

failedSet -> (список)

Сообщения об ошибках для событий, которые не удалось получить.

(структура)

Информация об ошибке, возвращаемая, когда операция DescribeEventDetailsForOrganization не может найти указанное событие.

awsAccountId -> (строка)

Информация об ошибке, возвращаемая, когда операция DescribeEventDetailsForOrganization не может найти указанное событие.

eventArn -> (строка)

Уникальный идентификатор события. Ссылка 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

errorName -> (строка)

Название ошибки.

errorMessage -> (строка)

Сообщение, описывающее ошибку.

Если вы вызываете операцию DescribeEventDetailsForOrganization и получаете одну из следующих ошибок, следуйте рекомендациям в сообщении:

  • Мы не нашли общедоступного события, соответствующего вашему запросу. Чтобы найти событие, специфичное для учетной записи, вы должны указать идентификатор учетной записи Amazon Web Services в запросе.
  • Мы не нашли события, специфичного для указанной учетной записи Amazon Web Services. Чтобы найти общедоступное событие, вы должны указать пустое значение для идентификатора учетной записи Amazon Web Services в запросе.
  • Ваша учетная запись Amazon Web Services не включает подписку Amazon Web Services Support, необходимую для использования API Health. Вам нужна подписка Business, Enterprise On-Ramp или Enterprise Support.

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

Spec-Zone.ru

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