Spec-Zone.ru › AWS CLI v2

[ aws . sns ]

set-platform-application-attributes

Описание

Устанавливает атрибуты объекта платформенного приложения для поддерживаемых служб push-уведомлений, таких как APNS и GCM (Firebase Cloud Messaging). Дополнительную информацию см. в разделе Использование мобильных push-уведомлений Amazon SNS. Сведения о настройке атрибутов для статуса доставки сообщений см. в разделе Использование атрибутов приложения Amazon SNS для статуса доставки сообщений.

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

Синтаксис

  set-platform-application-attributes
--platform-application-arn <value>
--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]

Параметры

--platform-application-arn (строка)

PlatformApplicationArn для SetPlatformApplicationAttributes действия.

--attributes (массив)

Массив атрибутов платформенного приложения. Атрибуты в этом массиве включают следующее:

  • PlatformCredential – Кредитные данные, полученные от службы уведомлений.
    • Для ADM, PlatformCredential является секретом клиента.
    • Для служб Apple с использованием сертификационных данных, PlatformCredential является закрытым ключом.
    • Для служб Apple с использованием токенов, PlatformCredential является ключом подписи.
    • Для GCM (Firebase Cloud Messaging) с использованием ключевых данных, PlatformPrincipal отсутствует. PlatformCredential является API key.
    • Для GCM (Firebase Cloud Messaging) с использованием токенов, PlatformPrincipal отсутствует. PlatformCredential является файлом закрытого ключа в формате JSON. При использовании AWS CLI, файл должен быть в строковом формате, и специальные символы должны игнорироваться. Для правильного форматирования файла Amazon SNS рекомендует использовать следующую команду: SERVICE_JSON=`jq @json <<< cat service.json`.
  • PlatformPrincipal – Сущность, полученная от службы уведомлений.
    • Для ADM, PlatformPrincipal является идентификатором клиента.
    • Для служб Apple с использованием сертификационных данных, PlatformPrincipal является сертификатом SSL.
    • Для служб Apple с использованием токенов, PlatformPrincipal является идентификатором ключа подписи.
    • Для GCM (Firebase Cloud Messaging) PlatformPrincipal отсутствует.
  • EventEndpointCreated – ARN темы, на которую отправляются уведомления о событии EndpointCreated.
  • EventEndpointDeleted – ARN темы, на которую отправляются уведомления о событии EndpointDeleted.
  • EventEndpointUpdated – ARN темы, на которую отправляются уведомления о событии EndpointUpdate.
  • EventDeliveryFailure – ARN темы, на которую отправляются уведомления о событии DeliveryFailure при сбое доставки Direct Publish (постоянный) на один из конечных пунктов приложения.
  • SuccessFeedbackRoleArn – ARN роли IAM, используемой для предоставления Amazon SNS прав записи для использования CloudWatch Logs от вашего имени.
  • FailureFeedbackRoleArn – ARN роли IAM, используемой для предоставления Amazon SNS прав записи для использования CloudWatch Logs от вашего имени.
  • SuccessFeedbackSampleRate – Процентная ставка выборки (0-100) успешно доставленных сообщений.

Следующие атрибуты применяются только к APNs аутентификации на основе токенов:

  • ApplePlatformTeamID – Идентификатор, присвоенный команде вашей учетной записи разработчика Apple.
  • ApplePlatformBundleID – Идентификатор пакета, присвоенный вашему приложению iOS.

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

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

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

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.

Для установки атрибутов платформенного приложения

Следующий set-platform-application-attributes пример устанавливает атрибут EventDeliveryFailure для указанного платформенного приложения до ARN указанной темы Amazon SNS.

aws sns set-platform-application-attributes \
    --platform-application-arn arn:aws:sns:us-west-2:123456789012:app/GCM/MyApplication \
    --attributes EventDeliveryFailure=arn:aws:sns:us-west-2:123456789012:AnotherTopic

Эта команда не выводит результат.

Вывод

Нет

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

Spec-Zone.ru

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