list-endpoints-by-platform-application
Описание
Выводит список конечных точек и атрибутов конечных точек для устройств в поддерживаемой службе push-уведомлений, такой как GCM (Firebase Cloud Messaging) и APNS. Результаты для ListEndpointsByPlatformApplication имеют постраничную навигацию и возвращают ограниченный список конечных точек, до 100. Если после результатов первой страницы доступны дополнительные записи, то возвращается строка NextToken. Чтобы получить следующую страницу, вызывайте ListEndpointsByPlatformApplication снова, используя строку NextToken, полученную из предыдущего вызова. Когда больше записей возвращать не нужно, NextToken будет равен null. Дополнительную информацию см. в разделе Использование Amazon SNS Mobile Push Notifications.
Этот действие ограничено 30 транзакциями в секунду (TPS).
См. также: Документация AWS API
list-endpoints-by-platform-application — это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную навигацию, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на запросе с постраничной навигацией аргумент --query должен извлечь данные из результатов следующих выражений запроса: Endpoints
Синтаксис
list-endpoints-by-platform-application
--platform-application-arn <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--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 для ListEndpointsByPlatformApplicationInput действия.--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания, с чего начать постраничную навигацию. Это NextToken из ранее обрезанного ответа.
Примеры использования см. в разделе Постраничная навигация в руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов больше, чем указанное значение, в выводе команды предоставляется NextToken. Чтобы продолжить постраничную навигацию, предоставьте значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничная навигация в руководстве пользователя AWS Command Line Interface.
--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-auto-prompt (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросить параметры ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в руководстве пользователя AWS CLI для получения дополнительной информации.
Если не указано иное, все примеры имеют правила цитирования, подобные Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной программы. См. Использование кавычек со строками в руководстве пользователя AWS CLI.
Для вывода списка конечных точек для платформенного приложения
Следующий list-endpoints-by-platform-application пример выводит список конечных точек и атрибутов конечных точек для указанного платформенного приложения.
aws sns list-endpoints-by-platform-application \
--platform-application-arn arn:aws:sns:us-west-2:123456789012:app/GCM/MyApplication
Вывод:
{
"Endpoints": [
{
"Attributes": {
"Token": "EXAMPLE12345...,
"Enabled": "true"
},
"EndpointArn": "arn:aws:sns:us-west-2:123456789012:endpoint/GCM/MyApplication/12345678-abcd-9012-efgh-345678901234"
}
]
}
Вывод
Конечные точки -> (список)
Конечные точки, возвращенные для действия ListEndpointsByPlatformApplication.
(структура)
Конечная точка для мобильного приложения и устройства.
EndpointArn -> (строка)
EndpointArn для мобильного приложения и устройства.Атрибуты -> (массив)
Атрибуты конечной точки.
ключ -> (строка)
значение -> (строка)
NextToken -> (строка)
NextToken возвращается при вызове действия ListEndpointsByPlatformApplication, если после результатов первой страницы доступны дополнительные записи.
© Copyright 2025, Amazon Web Services. Created using Sphinx.