SNS / Client / list_endpoints_by_platform_application

list_endpoints_by_platform_application

SNS.Client.list_endpoints_by_platform_application(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_endpoints_by_platform_application(
    PlatformApplicationArn='string',
    NextToken='string'
)
Parameters:

  • PlatformApplicationArn (string) –

    [REQUIRED]

    PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

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

Return type:

dict

Returns:

Response Syntax

{
    'Endpoints': [
        {
            'EndpointArn': 'string',
            'Attributes': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Response for ListEndpointsByPlatformApplication action.

    • Endpoints (list) –

      Endpoints returned for ListEndpointsByPlatformApplication action.

      • (dict) –

        The endpoint for mobile app and device.

        • EndpointArn (string) –

          The EndpointArn for mobile app and device.

        • Attributes (dict) –

          Attributes for endpoint.

          • (string) –

            • (string) –

    • NextToken (string) –

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

Exceptions

  • SNS.Client.exceptions.InvalidParameterException

  • SNS.Client.exceptions.InternalErrorException

  • SNS.Client.exceptions.AuthorizationErrorException

  • SNS.Client.exceptions.NotFoundException