List Endpoints By Platform Application

sns_list_endpoints_by_platform_application

R Documentation

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS¶

Description¶

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

Usage¶

sns_list_endpoints_by_platform_application(PlatformApplicationArn,
  NextToken)

Arguments¶

PlatformApplicationArn: [required] PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
NextToken: NextToken string is used when calling list_endpoints_by_platform_application action to retrieve additional records that are available after the first page results.

Value¶

A list with the following syntax:

list(
  Endpoints = list(
    list(
      EndpointArn = "string",
      Attributes = list(
        "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_endpoints_by_platform_application(
  PlatformApplicationArn = "string",
  NextToken = "string"
)