Spec-Zone.ru › AWS CLI v2

[ aws . neptune ]

describe-events

Описание

Возвращает события, связанные с экземплярами баз данных, группами безопасности баз данных, снимками баз данных и группами параметров баз данных за последние 14 дней. События, относящиеся к конкретному экземпляру базы данных, группе безопасности базы данных, снимку базы данных или группе параметров базы данных, можно получить, указав имя в качестве параметра. По умолчанию возвращается час событий, прошедший с момента текущего.

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

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

Синтаксис

  describe-events
[--source-identifier <value>]
[--source-type <value>]
[--start-time <value>]
[--end-time <value>]
[--duration <value>]
[--event-categories <value>]
[--filters <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]

Параметры

--source-identifier (строка)

Идентификатор источника событий, для которого возвращаются события. Если не указано, в ответ включаются все источники.

Ограничения:

  • Если SourceIdentifier указан, необходимо также указать SourceType.
  • Если тип источника — DBInstance, то необходимо указать DBInstanceIdentifier.
  • Если тип источника — DBSecurityGroup, необходимо указать DBSecurityGroupName.
  • Если тип источника — DBParameterGroup, необходимо указать DBParameterGroupName.
  • Если тип источника — DBSnapshot, необходимо указать DBSnapshotIdentifier.
  • Не может заканчиваться дефисом или содержать два дефиса подряд.

--source-type (строка)

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

Возможные значения:

  • db-instance
  • db-parameter-group
  • db-security-group
  • db-snapshot
  • db-cluster
  • db-cluster-snapshot

--start-time (метка времени)

Начало временного интервала, для которого необходимо получить события, указанное в формате ISO 8601. Дополнительную информацию о формате ISO 8601 можно найти на странице Википедии ISO8601.

Пример: 2009-07-08T18:00Z

--end-time (метка времени)

Конец временного интервала, для которого необходимо получить события, указанный в формате ISO 8601. Дополнительную информацию о формате ISO 8601 можно найти на странице Википедии ISO8601.

Пример: 2009-07-08T18:00Z

--duration (целое число)

Количество минут, для которых необходимо получить события.

По умолчанию: 60

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

Список категорий событий, которые запускают уведомления для подписки на уведомления о событиях.

(строка)

Синтаксис:

"string" "string" ...

--filters (список)

Этот параметр в настоящее время не поддерживается.

(структура)

Этот тип в настоящее время не поддерживается.

Имя -> (строка)

Этот параметр в настоящее время не поддерживается.

Значения -> (список)

Этот параметр в настоящее время не поддерживается.

(строка)

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

Name=string,Values=string,string ...

JSON-синтаксис:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--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 (логическое значение)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (логическое значение)

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

--output (строка)

Стиль форматирования для вывода команды.

  • json
  • текст
  • таблица
  • 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла напрямую независимо от значения cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного значения cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить постраничную обработку для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

Маркер -> (строка)

Необязательный токен постраничной обработки, предоставленный предыдущим запросом Events. Если этот параметр указан, ответ включает только записи после маркера, до значения, указанного параметром MaxRecords.

События -> (список)

Список экземпляров событий.

(структура)

Этот тип данных используется в качестве элемента ответа в действии DescribeEvents.

SourceIdentifier -> (строка)

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

SourceType -> (строка)

Указывает тип источника для этого события.

Сообщение -> (строка)

Предоставляет текст этого события.

EventCategories -> (список)

Указывает категорию события.

(строка)

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

Указывает дату и время события.

SourceArn -> (строка)

Amazon Resource Name (ARN) события.

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

Spec-Zone.ru

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