endpoints_by_platform_applications

Creates, updates, deletes, gets or lists an endpoints_by_platform_applications resource.

Overview

Name	endpoints_by_platform_applications
Type	Resource
Id	aws.sns.endpoints_by_platform_applications

Fields

The following fields are returned by SELECT queries:

list_endpoints_by_platform_application

Name	Datatype	Description
attributes	string	Attributes for endpoint.
endpoint_arn	string	The EndpointArn for mobile app and device.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_endpoints_by_platform_application	select	PlatformApplicationArn, region	NextToken	Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications. This action is throttled at 30 transactions per second (TPS).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
PlatformApplicationArn	string	PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
region	string	AWS region (default: us-east-1)
NextToken	string	NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

SELECT examples

list_endpoints_by_platform_application

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications. This action is throttled at 30 transactions per second (TPS).

SELECT
attributes,
endpoint_arn
FROM aws.sns.endpoints_by_platform_applications
WHERE PlatformApplicationArn = '{{ PlatformApplicationArn }}' -- required
AND region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
;