describe-event-subscriptions
Описание
Отображает описания всех подписок уведомлений о событиях Amazon Redshift для учетной записи клиента. Если вы укажете имя подписки, отображает описание для этой подписки.
Если вы укажете и ключи тегов, и значения тегов в одном запросе, Amazon Redshift возвращает все подписки уведомлений о событиях, соответствующие любому сочетанию указанных ключей и значений. Например, если у вас есть ключи тегов owner и environment, и значения тегов admin и test, возвращаются все подписки, имеющие любое сочетание этих значений.
Если оба ключа и значения тегов опущены из запроса, подписки возвращаются независимо от наличия связанных с ними ключей или значений тегов.
См. также: Документация API AWS
describe-event-subscriptions является постраничной операцией. Для получения всего набора результатов могут быть отправлены несколько запросов API. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлечь данные из результатов следующих выражений запроса: EventSubscriptionsList
Синтаксис
describe-event-subscriptions
[--subscription-name <value>]
[--tag-keys <value>]
[--tag-values <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 (строка)
--tag-keys (список)
Ключ или ключи тега, для которых вы хотите получить все соответствующие подписки уведомлений о событиях, связанные с указанным ключом или ключами. Например, предположим, что у вас есть подписки, помеченные ключами owner и environment. Если вы укажете оба эти ключа тега в запросе, Amazon Redshift вернёт ответ с подписками, у которых есть хотя бы один или оба эти ключа тега.
(строка)
Синтаксис:
"string" "string" ...
--tag-values (список)
Значение или значения тега, для которых вы хотите получить все соответствующие подписки уведомлений о событиях, связанные с указанным значением или значениями тега. Например, предположим, что у вас есть подписки, помеченные значениями admin и test. Если вы укажете оба этих значения тега в запросе, Amazon Redshift вернёт ответ с подписками, у которых есть хотя бы одно или оба этих значения тега.
(строка)
Синтаксис:
"string" "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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство «Начало работы» в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры потребуется адаптировать к правилам цитирования вашей оболочки. Подробнее см. раздел «Использование кавычек со строками» в Руководстве пользователя AWS CLI.
Для описания подписок на события
Следующий пример describe-event-subscriptions отображает подписки на уведомления о событиях для указанной подписки.
aws redshift describe-event-subscriptions \
--subscription-name mysubscription
Вывод:
{
"EventSubscriptionsList": [
{
"CustomerAwsId": "123456789012",
"CustSubscriptionId": "mysubscription",
"SnsTopicArn": "arn:aws:sns:us-west-2:123456789012:MySNStopic",
"Status": "active",
"SubscriptionCreationTime": "2019-12-09T21:50:21.332Z",
"SourceIdsList": [],
"EventCategoriesList": [
"management"
],
"Severity": "ERROR",
"Enabled": true,
"Tags": []
}
]
}
Дополнительная информация доступна в разделе «Подписка на уведомления о событиях Amazon Redshift» в Руководстве по управлению кластером Amazon Redshift.
Вывод
Маркер -> (строка)
Marker и повторив команду. Если поле Marker пусто, все записи ответа были получены для запроса.EventSubscriptionsList -> (список)
Список подписок на события.
(структура)
Описание подписки на события.
CustomerAwsId -> (строка)
CustSubscriptionId -> (строка)
SnsTopicArn -> (строка)
Status -> (строка)
Состояние подписки на уведомления об событиях Amazon Redshift.
Ограничения:
- Может быть одним из следующих: active | no-permission | topic-not-exist
- Состояние «no-permission» указывает, что у Amazon Redshift больше нет разрешения публиковать в тему Amazon SNS. Состояние «topic-not-exist» указывает, что тема была удалена после создания подписки.
SubscriptionCreationTime -> (временная метка)
SourceType -> (строка)
SourceIdsList -> (список)
Список источников, которые публикуют события в подписку на уведомления об событиях Amazon Redshift.
(строка)
EventCategoriesList -> (список)
Список категорий событий Amazon Redshift, указанных в подписке на уведомления об событиях.
Значения: Конфигурация, Управление, Мониторинг, Безопасность, Ожидание
(строка)
Severity -> (строка)
Уровень события, указанный в подписке на уведомления об событиях Amazon Redshift.
Значения: ERROR, INFO
Enabled -> (булево)
true указывает, что подписка включена.Tags -> (список)
Список тегов для подписки на события.
(структура)
Тег, состоящий из пары имя/значение для ресурса.
Key -> (строка)
Value -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.