Request Parameters Response Elements Errors Examples See Also

ListPlatformApplications

Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for ListPlatformApplications are paginated and return a limited list of applications, 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 ListPlatformApplications 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 15 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 ListPlatformApplications action to retrieve additional records that are available after the first page results.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

NextToken

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

Type: String

PlatformApplications.member.N

Platform applications returned when calling ListPlatformApplications action.

Type: Array of PlatformApplication objects

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

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 AWS General Reference.

Example

This example illustrates one usage of ListPlatformApplications.

Sample Request


https://sns.us-west-2.amazonaws.com/?Action=ListPlatformApplications
&Version=2010-03-31
&AUTHPARAMS

Sample Response


<ListPlatformApplicationsResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/">
    <ListPlatformApplicationsResult>
        <PlatformApplications>
            <member>
                <PlatformApplicationArn>arn:aws:sns:us-west-2:123456789012:app/APNS_SANDBOX/apnspushapp</PlatformApplicationArn>
                <Attributes>
                    <entry>
                        <key>AllowEndpointPolicies</key>
                        <value>false</value>
                    </entry>
                </Attributes>
            </member>
            <member>
                <PlatformApplicationArn>arn:aws:sns:us-west-2:123456789012:app/GCM/gcmpushapp</PlatformApplicationArn>
                <Attributes>
                    <entry>
                        <key>AllowEndpointPolicies</key>
                        <value>false</value>
                    </entry>
                </Attributes>
            </member>
        </PlatformApplications>
    </ListPlatformApplicationsResult>
    <ResponseMetadata>
        <RequestId>315a335e-85d8-52df-9349-791283cbb529</RequestId>
    </ResponseMetadata>
</ListPlatformApplicationsResponse>