описание-подписок-на-события
Описание
Перечисляет все подписки на события для учетной записи клиента. Описание подписки включает SubscriptionName , SNSTopicARN , CustomerID , SourceType , SourceID , CreationTime и Status .
Если вы укажете SubscriptionName , этот метод отобразит описание данной подписки.
См. также: Документация API AWS
describe-event-subscriptions является постраничной операцией. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запросов: EventSubscriptionsList
Синтаксис
describe-event-subscriptions
[--subscription-name <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]
Параметры
--subscription-name (строка)
--filters (список)
Фильтры, применяемые к подпискам на события.
Допустимые имена фильтров: event-subscription-arn | event-subscription-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
- текст
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определённого профиля из файла аутентификации.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/окружения.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- вкл
- выкл
- авто
--no-sign-request (логическое)
Не подписывать запросы. Кредиты не будут загружаться, если этот аргумент указан.
--ca-bundle (строка)
Файл сертификата корневого центра для проверки 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.
Описание подписок на события
Следующий пример describe-event-subscriptions перечисляет подписки на события для темы Amazon SNS.
aws dms describe-event-subscriptions
Вывод:
{
"EventSubscriptionsList": [
{
"CustomerAwsId": "123456789012",
"CustSubscriptionId": "my-dms-events",
"SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:my-sns-topic",
"Status": "deleting",
"SubscriptionCreationTime": "2020-05-21 22:28:51.924",
"Enabled": true
}
]
}
Дополнительную информацию см. в разделе Работа с событиями и уведомлениями в Руководстве пользователя AWS Database Migration Service.
Вывод
Marker -> (строка)
MaxRecords.EventSubscriptionsList -> (список)
Список подписок на события.
(структура)
Описывает подписку на уведомления о событиях, созданную операцией CreateEventSubscription.
CustomerAwsId -> (строка)
CustSubscriptionId -> (строка)
SnsTopicArn -> (строка)
Status -> (строка)
Статус подписки на уведомления о событиях DMS.
Ограничения:
Может быть одним из следующих: creating | modifying | deleting | active | no-permission | topic-not-exist
Статус “no-permission” указывает, что у DMS больше нет разрешения на публикацию в тему SNS. Статус “topic-not-exist” указывает, что тема была удалена после создания подписки.
SubscriptionCreationTime -> (строка)
SourceType -> (строка)
Тип ресурса DMS, который генерирует события.
Допустимые значения: replication-instance | replication-server | security-group | replication-task
SourceIdsList -> (список)
Список идентификаторов источников для подписки на события.
(строка)
EventCategoriesList -> (список)
Список категорий событий.
(строка)
Enabled -> (логическое)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|