get-subscription-attributes
Описание
Возвращает все свойства подписки.
См. также: Документация API AWS
Синтаксис
get-subscription-attributes
--subscription-arn <value>
[--cli-input-json | --cli-input-yaml]
[--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-arn (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставляемому --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, полученные из JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.
--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
- таблица
- 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.
Получение атрибутов подписки для темы
Следующий get-subscription-attributes отображает атрибуты указанной подписки. Вы можете получить subscription-arn из вывода команды list-subscriptions.
aws sns get-subscription-attributes \
--subscription-arn "arn:aws:sns:us-west-2:123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f"
Вывод:
{
"Attributes": {
"Endpoint": "my-email@example.com",
"Protocol": "email",
"RawMessageDelivery": "false",
"ConfirmationWasAuthenticated": "false",
"Owner": "123456789012",
"SubscriptionArn": "arn:aws:sns:us-west-2:123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f",
"TopicArn": "arn:aws:sns:us-west-2:123456789012:my-topic"
}
}
Вывод
Атрибуты -> (массив)
Массив атрибутов подписки. Атрибуты в этом массиве включают:
-
ConfirmationWasAuthenticated–true, если запрос подтверждения подписки был аутентифицирован. -
DeliveryPolicy– JSON-сериализация политики доставки подписки. -
EffectiveDeliveryPolicy– JSON-сериализация эффективной политики доставки, учитывающая политику доставки темы и системные значения по умолчанию. -
FilterPolicy– JSON-политика фильтрации, назначенная подписке. Дополнительную информацию см. в разделе Фильтрация сообщений Amazon SNS в руководстве разработчика Amazon SNS. -
FilterPolicyScope– Этот атрибут позволяет выбрать область фильтрации, используя один из следующих типов строковых значений:-
MessageAttributes(по умолчанию) – Фильтр применяется к атрибутам сообщения. -
MessageBody– Фильтр применяется к телу сообщения.
-
-
Owner– Идентификатор учетной записи Amazon Web Services владельца подписки. -
PendingConfirmation–true, если подписка не подтверждена. Для подтверждения ожидающей подписки вызовите действиеConfirmSubscriptionс маркером подтверждения. -
RawMessageDelivery–true, если для подписки включена доставка необработанных сообщений. Необработанные сообщения свободны от форматирования JSON и могут быть отправлены на HTTP/S и Amazon SQS конечные точки. -
RedrivePolicy– Если указано, недоставленные сообщения отправляются в указанную очередь мертвых писем Amazon SQS. Сообщения, которые не могут быть доставлены из-за ошибок клиента (например, когда подписной конечной точкой недоступен) или ошибок сервера (например, когда сервис, на котором работает подписной конечной точкой, становится недоступным), хранятся в очереди мертвых писем для дальнейшего анализа или повторной обработки. -
SubscriptionArn– ARN подписки. -
TopicArn– ARN темы, с которой связана подписка.
Следующий атрибут применим только к подпискам потока доставки Amazon Data Firehose:
-
SubscriptionRoleArn– ARN роли IAM, обладающей следующими разрешениями:- Разрешение записи в поток доставки Firehose
- Amazon SNS указана как доверенная сущность
Для подписок потока доставки Firehose необходимо указать действительный ARN для этого атрибута. Дополнительную информацию см. в разделе Fanout в потоки доставки Firehose в руководстве разработчика Amazon SNS.
ключ -> (строка)
значение -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.