Spec-Zone.ru › AWS CLI v2

[ aws . sns ]

установить-атрибуты-sms

Описание

Используйте этот запрос для установки параметров по умолчанию для отправки SMS-сообщений и получения ежедневных отчётов об использовании SMS.

Вы можете переопределить некоторые из этих настроек для отдельного сообщения, когда используете действие Publish с параметром MessageAttributes.entry.N. Для получения дополнительной информации см. Публикация на мобильный телефон в Руководстве разработчика Amazon SNS.

Примечание

Чтобы использовать эту операцию, вы должны предоставить принципалу службы Amazon SNS (sns.amazonaws.com) разрешение на выполнение действия s3:ListBucket.

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

Синтаксис

  set-sms-attributes
--attributes <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]

Параметры

--attributes (отображение)

Параметры по умолчанию для отправки SMS-сообщений с вашей учётной записью Amazon Web Services. Вы можете задать значения для следующих имён атрибутов:

MonthlySpendLimit – Максимальная сумма в USD, которую вы готовы потратить каждый месяц на отправку SMS-сообщений. Когда Amazon SNS определяет, что отправка SMS-сообщения повлечёт затраты, превышающие этот лимит, она прекращает отправку SMS-сообщений в течение нескольких минут.

Предупреждение

Amazon SNS прекращает отправку SMS-сообщений в течение нескольких минут после превышения лимита. В течение этого промежутка времени, если вы продолжаете отправлять SMS-сообщения, вы понесёте расходы, превышающие ваш лимит.

По умолчанию лимит расходов устанавливается в максимальное значение, разрешённое Amazon SNS. Если вы хотите увеличить лимит, отправьте запрос на повышение лимита SNS. Для поля Новое значение лимита введите желаемый ежемесячный лимит расходов. В поле Описание случая использования объясните, что вы запрашиваете повышение ежемесячного лимита расходов на SMS.

DeliveryStatusIAMRole – ARN роли IAM, позволяющей Amazon SNS записывать журналы о доставке SMS в CloudWatch Logs. Для каждого отправленного SMS-сообщения Amazon SNS записывает журнал, содержащий стоимость сообщения, статус успеха или неудачи, причину неудачи (если сообщение не было доставлено), время ожидания сообщения и другую информацию.

DeliveryStatusSuccessSamplingRate – Процент успешных доставок SMS-сообщений, для которых Amazon SNS запишет журналы в CloudWatch Logs. Значение может быть целым числом от 0 до 100. Например, чтобы записывать журналы только для несостоявшихся доставок, установите это значение в 0. Чтобы записывать журналы для 10% ваших успешных доставок, установите его в 10.

DefaultSenderID – Строка, например, название вашей компании, которая отображается как отправитель на устройстве получателя. Поддержка идентификаторов отправителей варьируется в зависимости от страны. Идентификатор отправителя может содержать 1-11 буквенно-цифровых символов и должен содержать хотя бы одну букву.

DefaultSMSType – Тип SMS-сообщения, который вы будете отправлять по умолчанию. Вы можете назначить следующие значения:

  • Promotional – (По умолчанию) Сообщения, не требующие немедленного ответа, например, маркетинговые сообщения. Amazon SNS оптимизирует доставку сообщения для наименьших затрат.
  • Transactional – Критические сообщения, поддерживающие транзакции клиентов, такие как одноразовые коды для многофакторной аутентификации. Amazon SNS оптимизирует доставку сообщений для достижения наивысшей надёжности.
UsageReportS3Bucket – Имя ведра Amazon S3 для получения ежедневных отчетов об использовании SMS от Amazon SNS. Каждый день Amazon SNS будет отправлять отчёт об использовании в виде файла CSV в ведро. Отчет включает следующую информацию для каждого успешно доставленного SMS-сообщения вашей учётной записью Amazon Web Services:
  • Время публикации сообщения (в UTC)
  • Идентификатор сообщения
  • Номер телефона получателя
  • Тип сообщения
  • Статус доставки
  • Стоимость сообщения (в USD)
  • Номер части (сообщение разбивается на несколько частей, если оно слишком длинное для одного сообщения)
  • Общее количество частей

Для получения отчета ведро должно иметь политику, которая позволяет принципалу службы Amazon SNS выполнять действия s3:PutObject и s3:GetBucketLocation.

Пример политики ведра и отчёт об использовании см. в разделе Мониторинг активности SMS в Руководстве разработчика Amazon SNS.

ключ -> (строка)

значение -> (строка)

Сокращённый синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для установки атрибутов SMS-сообщения

Следующий set-sms-attributes пример устанавливает идентификатор отправителя по умолчанию для SMS-сообщений в MyName.

aws sns set-sms-attributes \
    --attributes DefaultSenderID=MyName

Эта команда не выводит никаких данных.

Вывод

Нет

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

Spec-Zone.ru

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