Request Parameters Response Elements Errors Examples See Also

ListEndpointsByPlatformApplication

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).

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

NextToken

NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

Type: String

Required: No

PlatformApplicationArn

PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

Endpoints.member.N

Endpoints returned for ListEndpointsByPlatformApplication action.

Type: Array of Endpoint objects

NextToken

NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AuthorizationError

Indicates that the user has been denied access to the requested resource.

HTTP Status Code: 403

InternalError

Indicates an internal service error.

HTTP Status Code: 500

InvalidParameter

Indicates that a request parameter does not comply with the associated constraints.

HTTP Status Code: 400

NotFound

Indicates that the requested resource does not exist.

HTTP Status Code: 404

Examples

The structure of AUTHPARAMS depends on the signature of the API request. For more information, see Examples of the complete Signature Version 4 signing process (Python) in the Amazon General Reference.

Example

This example illustrates one usage of ListEndpointsByPlatformApplication.

Sample Request


https://sns.us-west-2.amazonaws.com/?Action=ListEndpointsByPlatformApplication
&PlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp
&Version=2010-03-31
&AUTHPARAMS

Sample Response


<ListEndpointsByPlatformApplicationResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/">
    <ListEndpointsByPlatformApplicationResult>
        <Endpoints>
            <member>
                <EndpointArn>arn:aws:sns:us-west-2:123456789012:endpoint/GCM/gcmpushapp/5e3e9847-3183-3f18-a7e8-671c3a57d4b3</EndpointArn>
                <Attributes>
                    <entry>
                        <key>Enabled</key>
                        <value>true</value>
                    </entry>
                    <entry>
                        <key>CustomUserData</key>
                        <value>UserId=27576823</value>
                    </entry>
                    <entry>
                        <key>Token</key>
                        <value>APA91bGi7fFachkC1xjlqT66VYEucGHochmf1VQAr9k...jsM0PKPxKhddCzx6paEsyay9Zn3D4wNUJb8m6HZrBEXAMPLE</value>
                    </entry>
                </Attributes>
            </member>
        </Endpoints>
    </ListEndpointsByPlatformApplicationResult>
    <ResponseMetadata>
        <RequestId>9a48768c-dac8-5a60-aec0-3cc27ea08d96</RequestId>
    </ResponseMetadata>
</ListEndpointsByPlatformApplicationResponse>