Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

describe-event-subscriptions

Описание

Выводит описания всех подписок на уведомления о событиях для учетной записи клиента. Описание подписки включает 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 (строка)

Имя подписки на уведомления о событиях Amazon DocumentDB, которую вы хотите описать.

--filters (список)

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

(структура)

Именованный набор значений фильтра, используемый для получения более конкретного списка результатов. Вы можете использовать фильтр для сопоставления набора ресурсов по определенным критериям, таким как идентификаторы.

Подстановки не поддерживаются в фильтрах.

Name -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

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

Файл сертификата 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.

Вывод

Marker -> (строка)

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

EventSubscriptionsList -> (список)

Список подписок на события.

(структура)

Подробная информация об событии, на которое вы подписаны.

CustomerAwsId -> (строка)

Учетная запись Amazon Web Services, связанная с подпиской на уведомления о событиях Amazon DocumentDB.

CustSubscriptionId -> (строка)

Идентификатор подписки на уведомления о событиях Amazon DocumentDB.

SnsTopicArn -> (строка)

ARN темы Amazon DocumentDB подписки на уведомления о событиях.

Status -> (строка)

Статус подписки на уведомления о событиях Amazon DocumentDB.

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

Может быть одним из следующих: creating , modifying , deleting , active , no-permission , topic-not-exist

Статус no-permission указывает, что у Amazon DocumentDB больше нет разрешения на публикацию в тему SNS. Статус topic-not-exist указывает, что тема была удалена после создания подписки.

SubscriptionCreationTime -> (строка)

Время создания подписки на уведомления о событиях Amazon DocumentDB.

SourceType -> (строка)

Тип источника для подписки на уведомления о событиях Amazon DocumentDB.

SourceIdsList -> (список)

Список идентификаторов источников для подписки на уведомления о событиях Amazon DocumentDB.

(строка)

EventCategoriesList -> (список)

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

(строка)

Enabled -> (булево)

Булевое значение, указывающее, включена ли подписка. Значение true указывает, что подписка включена.

EventSubscriptionArn -> (строка)

Amazon Resource Name (ARN) для подписки на события.

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

Spec-Zone.ru

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