SNS / Client / list_platform_applications

list_platform_applications#

SNS.Client.list_platform_applications(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_platform_applications(
    NextToken='string'
)
Parameters:

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

Return type:

dict

Returns:

Response Syntax

{
    'PlatformApplications': [
        {
            'PlatformApplicationArn': 'string',
            'Attributes': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Response for ListPlatformApplications action.

    • PlatformApplications (list) –

      Platform applications returned when calling ListPlatformApplications action.

      • (dict) –

        Platform application object.

        • PlatformApplicationArn (string) –

          PlatformApplicationArn for platform application object.

        • Attributes (dict) –

          Attributes for platform application object.

          • (string) –

            • (string) –

    • NextToken (string) –

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

Exceptions

  • SNS.Client.exceptions.InvalidParameterException

  • SNS.Client.exceptions.InternalErrorException

  • SNS.Client.exceptions.AuthorizationErrorException