Spec-Zone.ru › AWS CLI v2

[ aws . dms ]

describe-events

Описание

Отображает события для заданного идентификатора источника и типа источника. Вы также можете указать начальное и конечное время. Дополнительную информацию о событиях DMS см. в руководстве пользователя Database Migration Service в разделе «Работа с событиями и уведомлениями».

См. также: Документацию 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 (строка)

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

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

Тип ресурса DMS, генерирующего события.

Допустимые значения: replication-instance | replication-task

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

  • replication-instance

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

Начальное время для отображения событий.

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

Конечное время для отображения событий.

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

Продолжительность отображаемых событий.

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

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

(строка)

Синтаксис:

"string" "string" ...

--filters (список)

Фильтры, применяемые к событиям. Единственный допустимый фильтр — replication-instance-id.

(структура)

Идентифицирует имя и значение объекта фильтра. Этот фильтр используется для ограничения количества и типа объектов DMS, возвращаемых для определенного вызова Describe* или аналогичной операции. Фильтры используются в качестве необязательного параметра для определенных операций API.

Name -> (строка)

Имя фильтра, указанное для операции Describe* или аналогичной операции.

Values -> (список)

Значение фильтра, которое может указывать одно или несколько значений, используемых для сужения возвращаемых результатов.

(строка)

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

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
  • 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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для отображения событий DMS

В следующем примере describe-events отображаются события, возникшие из экземпляра репликации.

aws dms describe-events \
    --source-type "replication-instance"

Вывод:

{
    "Events": [
        {
            "SourceIdentifier": "my-repl-instance",
            "SourceType": "replication-instance",
            "Message": "Replication application shutdown",
            "EventCategories": [],
            "Date": 1590771645.776
        }
    ]
}

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

Вывод

Marker -> (строка)

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

Events -> (список)

Описанные события.

(структура)

Описывает идентифицируемую значимую активность, влияющую на экземпляр или задачу репликации. Этот объект может содержать сообщение, доступные категории событий, дату и источник события, а также тип ресурса DMS.

SourceIdentifier -> (строка)

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

SourceType -> (строка)

Тип ресурса DMS, генерирующего события.

Допустимые значения: replication-instance | endpoint | replication-task

Message -> (строка)

Сообщение события.

EventCategories -> (список)

Категории событий, доступные для указанного типа источника.

(строка)

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

Дата события.

Spec-Zone.ru

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