Skip to content

list_platform_applications

Operation

list_platform_applications

list_platform_applications(request: ListPlatformApplicationsInput | ListPlatformApplicationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPlatformApplicationsInputDict]) -> ListPlatformApplicationsOutput

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

Parameters:

Name Type Description Default
request ListPlatformApplicationsInput | ListPlatformApplicationsInputDict | 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[ListPlatformApplicationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPlatformApplicationsOutput

An instance of ListPlatformApplicationsOutput.

list_platform_applications async

list_platform_applications(request: ListPlatformApplicationsInput | ListPlatformApplicationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPlatformApplicationsInputDict]) -> ListPlatformApplicationsOutput

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

Parameters:

Name Type Description Default
request ListPlatformApplicationsInput | ListPlatformApplicationsInputDict | 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[ListPlatformApplicationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPlatformApplicationsOutput

An instance of ListPlatformApplicationsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListPlatformApplicationsInputDict

Bases: TypedDict

Dictionary form of ListPlatformApplicationsInput.

Attributes

next_token instance-attribute
next_token: str | None

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

ListPlatformApplicationsInput dataclass

Bases: _SerdeShape

Input for ListPlatformApplications action.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

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

Output

ListPlatformApplicationsOutput dataclass

Bases: _SerdeShape

Response for ListPlatformApplications action.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

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

platform_applications class-attribute instance-attribute
platform_applications: list[PlatformApplication] | None = ...

Platform applications returned when calling ListPlatformApplications action.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.