Spec-Zone.ru › AWS CLI v2

[ aws . health ]

describe-event-details

Описание

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

Если указанное событие не может быть получено, возвращается сообщение об ошибке для этого события.

Примечание

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

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

Синтаксис

  describe-event-details
--event-arns <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]

Параметры

--event-arns (список)

Список ARNs событий (уникальные идентификаторы). Например: "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"

(строка)

Синтаксис:

"string" "string" ...

--locale (строка)

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

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

--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
  • text
  • таблица
  • 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.

Для вывода информации об AWS Health событии

Следующий describe-event-details пример выводит информацию об указанном событии AWS Health.

aws health describe-event-details \
    --event-arns "arn:aws:health:us-east-1::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_VKTXI_EXAMPLE111" \
    --region us-east-1

Вывод:

{
    "successfulSet": [
        {
            "event": {
                "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"
            },
            "eventDescription": {
                "latestDescription": "[RESOLVED] Increased API Error Rates and Latencies\n\n[02:45 AM PDT] We are investigating increased API error rates and latencies in the US-EAST-1 Region.\n\n[03:16 AM PDT] Between 2:10 AM and 2:59 AM PDT we experienced increased API error rates and latencies in the US-EAST-1 Region. The issue has been resolved and the service is operating normally."
            }
        }
    ],
    "failedSet": []
}

Дополнительную информацию см. в разделе «Панель сведений о событии» в Руководстве пользователя AWS Health.

Вывод

successfulSet -> (список)

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

(структура)

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

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

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

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 -> (структура)

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

latestDescription -> (строка)

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

eventMetadata -> (карта)

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

key -> (строка)

value -> (строка)

failedSet -> (список)

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

(структура)

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

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 -> (строка)

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

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

Spec-Zone.ru

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