set-topic-attributes

Описание

Позволяет владельцу темы задать атрибут темы новым значением.

Примечание

Чтобы удалить возможность изменения разрешений темы, необходимо запретить разрешения на действия AddPermission , RemovePermission и SetTopicAttributes в вашей политике IAM.

См. также: Документацию AWS API

Синтаксис

  set-topic-attributes
--topic-arn <value>
--attribute-name <value>
[--attribute-value <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 (строка)

УКАЗАННЫЙ ARN темы для изменения.

--attribute-name (строка)

Словарь атрибутов с соответствующими значениями.

Ниже перечислены имена, описания и значения специальных параметров запроса, используемых действием SetTopicAttributes:

ApplicationSuccessFeedbackRoleArn – Указывает состояние доставки сообщений с ошибкой для темы Amazon SNS, которая подписана на конечную точку приложения платформы.
DeliveryPolicy – Политика, определяющая, как Amazon SNS повторно пытается доставить сообщения с ошибками в конечные точки HTTP/S.
DisplayName – Имя для отображения темы с подписками SMS.
Policy – Политика, определяющая, кто может получить доступ к вашей теме. По умолчанию только владелец темы может публиковать или подписываться на нее.
TracingConfig – Режим трассировки темы Amazon SNS. По умолчанию TracingConfig установлен на PassThrough , и тема передает заголовок трассировки, полученный от издателя Amazon SNS, своим подпискам. Если установлен Active, Amazon SNS передаст данные сегмента X-Ray владельцу учетной записи, если флаг выборки в заголовке трассировки имеет значение true. Это поддерживается только для стандартных тем.
HTTP
- HTTPSuccessFeedbackRoleArn – Указывает состояние успешной доставки сообщений для темы Amazon SNS, подписанной на конечную точку HTTP.
- HTTPSuccessFeedbackSampleRate – Указывает процент успешно доставленных сообщений для выборки для темы Amazon SNS, подписанной на конечную точку HTTP.
- HTTPFailureFeedbackRoleArn – Указывает состояние доставки сообщений с ошибкой для темы Amazon SNS, подписанной на конечную точку HTTP.
Amazon Kinesis Data Firehose
- FirehoseSuccessFeedbackRoleArn – Указывает состояние успешной доставки сообщений для темы Amazon SNS, подписанной на конечную точку Amazon Kinesis Data Firehose.
- FirehoseSuccessFeedbackSampleRate – Указывает процент успешно доставленных сообщений для выборки для темы Amazon SNS, подписанной на конечную точку Amazon Kinesis Data Firehose.
- FirehoseFailureFeedbackRoleArn – Указывает состояние доставки сообщений с ошибкой для темы Amazon SNS, подписанной на конечную точку Amazon Kinesis Data Firehose.
Lambda
- LambdaSuccessFeedbackRoleArn – Указывает состояние успешной доставки сообщений для темы Amazon SNS, подписанной на конечную точку Lambda.
- LambdaSuccessFeedbackSampleRate – Указывает процент успешно доставленных сообщений для выборки для темы Amazon SNS, подписанной на конечную точку Lambda.
- LambdaFailureFeedbackRoleArn – Указывает состояние доставки сообщений с ошибкой для темы Amazon SNS, подписанной на конечную точку Lambda.
Конечная точка приложения платформы
- ApplicationSuccessFeedbackRoleArn – Указывает состояние успешной доставки сообщений для темы Amazon SNS, подписанной на конечную точку приложения Amazon Web Services.
- ApplicationSuccessFeedbackSampleRate – Указывает процент успешно доставленных сообщений для выборки для темы Amazon SNS, подписанной на конечную точку приложения Amazon Web Services.
- ApplicationFailureFeedbackRoleArn – Указывает состояние доставки сообщений с ошибкой для темы Amazon SNS, подписанной на конечную точку приложения Amazon Web Services.

Примечание

Помимо возможности настраивать атрибуты темы для состояния доставки уведомлений, отправленных в конечные точки приложений Amazon SNS, вы также можете настроить атрибуты приложения для состояния доставки push-уведомлений, отправленных в push-уведомления.

Например, Для получения дополнительной информации см. Использование атрибутов приложения Amazon SNS для состояния доставки сообщений.

Amazon SQS
- SQSSuccessFeedbackRoleArn – Указывает состояние успешной доставки сообщений для темы Amazon SNS, подписанной на конечную точку Amazon SQS.
- SQSSuccessFeedbackSampleRate – Указывает процент успешно доставленных сообщений для выборки для темы Amazon SNS, подписанной на конечную точку Amazon SQS.
- SQSFailureFeedbackRoleArn – Указывает состояние доставки сообщений с ошибкой для темы Amazon SNS, подписанной на конечную точку Amazon SQS.

Примечание

Атрибуты <ENDPOINT>SuccessFeedbackRoleArn и <ENDPOINT>FailureFeedbackRoleArn используются для предоставления Amazon SNS права записи для использования CloudWatch Logs от вашего имени. Атрибут <ENDPOINT>SuccessFeedbackSampleRate предназначен для указания процента выборки (0-100) успешно доставленных сообщений. После настройки атрибута <ENDPOINT>FailureFeedbackRoleArn все доставленные сообщения с ошибками генерируют журналы CloudWatch.

Следующий атрибут относится только к шифрованию на стороне сервера:

KmsMasterKeyId – Идентификатор управляемого ключа мастер-ключа (CMK) Amazon Web Services для Amazon SNS или пользовательского CMK. Для получения дополнительной информации см. Термины.
SignatureVersion – Версия подписи соответствует алгоритму хэширования, используемому при создании подписи уведомлений, подтверждений подписки или подтверждений отписки, отправленных Amazon SNS. По умолчанию SignatureVersion установлен на 1.

Следующий атрибут относится только к темам FIFO:

ArchivePolicy – Политика, устанавливающая срок хранения сообщений, хранящихся в архиве сообщений темы Amazon SNS FIFO.
ContentBasedDeduplication – Включает дублирование на основе содержимого для тем FIFO.
- По умолчанию ContentBasedDeduplication установлен на false . Если вы создаете тему FIFO, и этот атрибут имеет значение false, необходимо указать значение параметра MessageDeduplicationId для действия Publish.
- Когда вы устанавливаете ContentBasedDeduplication на true, Amazon SNS использует хэш SHA-256 для генерации MessageDeduplicationId на основе тела сообщения (но не атрибутов сообщения). (Необязательно) Чтобы переопределить сгенерированное значение, вы можете указать значение для параметра MessageDeduplicationId для действия Publish.
FifoThroughputScope – Включает более высокую пропускную способность для вашей темы FIFO, настраивая область дублирования. Этот атрибут имеет два возможных значения:
- Topic – Область дублирования сообщений распространяется на всю тему. Это значение по умолчанию и сохраняет существующее поведение, с максимальной пропускной способностью 3000 сообщений в секунду или 20 МБ в секунду, в зависимости от того, что меньше.
- MessageGroup – Область дублирования находится в каждой отдельной группе сообщений, что обеспечивает более высокую пропускную способность на тему, в зависимости от региональных квот. Для получения дополнительной информации о квотах или для запроса увеличения см. квоты службы Amazon SNS в Общей справке Amazon Web Services.

--attribute-value (строка)

Новое значение атрибута.

--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 (boolean)

Включить отладовую регистрацию.

--endpoint-url (string)

Переопределить стандартный URL команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

json
text
table
yaml
yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла аутентификации.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

on
off
auto

--no-sign-request (boolean)

Не подписывать запросы. Кредиты не будут загружаться, если этот аргумент предоставлен.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться без ожидания таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться без ожидания таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

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

Отключить кли-пейджер для вывода.

--cli-auto-prompt (boolean)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматический запрос параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, аналогичные Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для установки атрибута темы

Следующий set-topic-attributes пример устанавливает атрибут DisplayName для указанной темы.

aws sns set-topic-attributes \
    --topic-arn arn:aws:sns:us-west-2:123456789012:MyTopic \
    --attribute-name DisplayName \
    --attribute-value MyTopicDisplayName

Эта команда не генерирует вывод.

Вывод

Отсутствует