list_endpoints_by_platform_application¶
Operation¶
list_endpoints_by_platform_application
¶
list_endpoints_by_platform_application(request: ListEndpointsByPlatformApplicationInput | ListEndpointsByPlatformApplicationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListEndpointsByPlatformApplicationInputDict]) -> ListEndpointsByPlatformApplicationOutput
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).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListEndpointsByPlatformApplicationInput | ListEndpointsByPlatformApplicationInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ListEndpointsByPlatformApplicationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListEndpointsByPlatformApplicationOutput
|
An instance of |
list_endpoints_by_platform_application
async
¶
list_endpoints_by_platform_application(request: ListEndpointsByPlatformApplicationInput | ListEndpointsByPlatformApplicationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListEndpointsByPlatformApplicationInputDict]) -> ListEndpointsByPlatformApplicationOutput
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).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListEndpointsByPlatformApplicationInput | ListEndpointsByPlatformApplicationInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ListEndpointsByPlatformApplicationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListEndpointsByPlatformApplicationOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListEndpointsByPlatformApplicationInputDict
¶
Bases: TypedDict
Dictionary form of ListEndpointsByPlatformApplicationInput.
ListEndpointsByPlatformApplicationInput
dataclass
¶
Bases: _SerdeShape
Input for ListEndpointsByPlatformApplication action.
Output¶
ListEndpointsByPlatformApplicationOutput
dataclass
¶
Bases: _SerdeShape
Response for ListEndpointsByPlatformApplication action.
Attributes¶
endpoints
class-attribute
instance-attribute
¶
Endpoints returned for ListEndpointsByPlatformApplication action.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
NextToken string is returned when calling
ListEndpointsByPlatformApplication action if additional records are
available after the first page results.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.