get-topic-attributes
Описание
Возвращает все свойства темы. Свойства темы, которые возвращаются, могут отличаться в зависимости от авторизации пользователя.
См. также: Документацию API AWS
Синтаксис
get-topic-attributes
--topic-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]
Параметры
--topic-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
- текст
- таблица
- 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-auto-prompt (логическое значение)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запрошение параметров ввода CLI.
Примеры
Примечание
Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Подробности см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры нужно адаптировать к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Получение атрибутов темы
Следующий get-topic-attributes пример отображает атрибуты указанной темы.
aws sns get-topic-attributes \
--topic-arn "arn:aws:sns:us-west-2:123456789012:my-topic"
Вывод:
{
"Attributes": {
"SubscriptionsConfirmed": "1",
"DisplayName": "my-topic",
"SubscriptionsDeleted": "0",
"EffectiveDeliveryPolicy": "{\"http\":{\"defaultHealthyRetryPolicy\":{\"minDelayTarget\":20,\"maxDelayTarget\":20,\"numRetries\":3,\"numMaxDelayRetries\":0,\"numNoDelayRetries\":0,\"numMinDelayRetries\":0,\"backoffFunction\":\"linear\"},\"disableSubscriptionOverrides\":false}}",
"Owner": "123456789012",
"Policy": "{\"Version\":\"2008-10-17\",\"Id\":\"__default_policy_ID\",\"Statement\":[{\"Sid\":\"__default_statement_ID\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":[\"SNS:Subscribe\",\"SNS:ListSubscriptionsByTopic\",\"SNS:DeleteTopic\",\"SNS:GetTopicAttributes\",\"SNS:Publish\",\"SNS:RemovePermission\",\"SNS:AddPermission\",\"SNS:SetTopicAttributes\"],\"Resource\":\"arn:aws:sns:us-west-2:123456789012:my-topic\",\"Condition\":{\"StringEquals\":{\"AWS:SourceOwner\":\"0123456789012\"}}}]}",
"TopicArn": "arn:aws:sns:us-west-2:123456789012:my-topic",
"SubscriptionsPending": "0"
}
}
Вывод
Атрибуты -> (массив)
Массив атрибутов темы. Атрибуты в этом массиве включают следующие:
-
DeliveryPolicy– JSON-сериализация политики доставки темы. -
DisplayName– Читабельное имя, используемое в полеFromдля уведомлений на конечных точкахemailиemail-json. -
EffectiveDeliveryPolicy– JSON-сериализация эффективной политики доставки с учётом системных значений по умолчанию. -
Owner– Идентификатор учётной записи Amazon Web Services владельца темы. -
Policy– JSON-сериализация политики управления доступом темы. -
SignatureVersion– Версия подписи соответствует алгоритму хэширования, используемому при создании подписи уведомлений, подтверждений подписки или подтверждений отмены подписки, отправляемых Amazon SNS.- По умолчанию
SignatureVersionустановлено в 1. Подпись — это подпись SHA1withRSA, закодированная в Base64. - При установке
SignatureVersionв 2. Amazon SNS использует подпись SHA256withRSA, закодированную в Base64.
Примечание
Если ответ API не содержит атрибут
SignatureVersion, это означает, чтоSignatureVersionдля темы имеет значение 1. - По умолчанию
-
SubscriptionsConfirmed– Количество подтверждённых подписок для темы. -
SubscriptionsDeleted– Количество удалённых подписок для темы. -
SubscriptionsPending– Количество подписок, ожидающих подтверждения для темы. -
TopicArn– ARN темы. -
TracingConfig– Режим трассировки темы Amazon SNS. По умолчаниюTracingConfigустановлен вPassThrough, и тема пропускает через заголовок трассировки, полученный от издателя Amazon SNS, к своим подпискам. При установке вActiveAmazon SNS предоставит данные сегмента X-Ray учётной записи владельца темы, если флаг выборки в заголовке трассировки равен true. Это поддерживается только для стандартных тем.
Следующие атрибуты применимы только к шифрованию на стороне сервера:
-
KmsMasterKeyId- Идентификатор управляемого Amazon Web Services ключа шифрования конечного пользователя (CMK) для Amazon SNS или пользовательского CMK. Дополнительная информация см. в разделе Термины . Дополнительные примеры см. в KeyId в Справочнике по API службы управления ключами.
Следующие атрибуты применимы только к темам FIFO:
-
ArchivePolicy– Политика, устанавливающая срок хранения сообщений, хранящихся в архиве сообщений темы Amazon SNS FIFO. -
BeginningArchiveTime– Наиболее ранняя начальная точка, с которой сообщение в архиве темы можно воспроизвести. Эта точка во времени основана на конфигурируемом сроке хранения сообщений, заданном политикой архивирования сообщений темы. -
ContentBasedDeduplication– Включает дедупликацию на основе содержимого для тем FIFO.- По умолчанию
ContentBasedDeduplicationустановлен вfalse. Если вы создаёте тему FIFO, и этот атрибут равенfalse, необходимо указать значение для параметраMessageDeduplicationIdдля действия Publish. - Когда вы устанавливаете
ContentBasedDeduplicationвtrue, Amazon SNS использует хэш SHA-256 для генерацииMessageDeduplicationId, используя тело сообщения (но не атрибуты сообщения). (Необязательно) Чтобы переопределить сгенерированное значение, можно указать значение для параметраMessageDeduplicationIdдля действияPublish.
- По умолчанию
-
FifoTopic– При установке этого значения вtrueсоздаётся тема FIFO.
ключ -> (строка)
значение -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.