Skip to content

list_platform_applications async

list_platform_applications(
    *,
    config_overrides: Optional[AsyncSNSClientConfig] = None,
    next_token: Optional[String] = None,
) -> ListPlatformApplicationsResponse

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:

  • next_token (Optional[String], default: None ) –

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

Raises:

Source code in docs_src/capo_sns/_services/async_sns.py
async def list_platform_applications(
    self,
    *,
    config_overrides: Optional[AsyncSNSClientConfig] = None,
    next_token: Optional["capo_sns.types.string.String"] = None,
) -> "capo_sns.types.list_platform_applications_response.ListPlatformApplicationsResponse":
    """<p>Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for <code>ListPlatformApplications</code> 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 <code>ListPlatformApplications</code> using the NextToken string received from the previous call. When there are no more records to return, <code>NextToken</code> will be null. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p> <p>This action is throttled at 15 transactions per second (TPS).</p>

    Args:
        next_token: <p> <code>NextToken</code> string is used when calling <code>ListPlatformApplications</code> action to retrieve additional records that are available after the first page results.</p>

    Raises:
        capo_sns.errors.authorization_error_exception.AuthorizationErrorException: <p>Indicates that the user has been denied access to the requested resource.</p>
        capo_sns.errors.internal_error_exception.InternalErrorException: <p>Indicates an internal service error.</p>
        capo_sns.errors.invalid_parameter_exception.InvalidParameterException: <p>Indicates that a request parameter does not comply with the associated constraints.</p>
        capo_sns.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sns.types.list_platform_applications_input.ListPlatformApplicationsInput]",
    ) -> AsyncOperationResponse[
        "capo_sns.types.list_platform_applications_response.ListPlatformApplicationsResponse"
    ]:
        import capo_sns._operations.amazon_simple_notification_service.list_platform_applications

        (
            output,
            http_response,
        ) = await capo_sns._operations.amazon_simple_notification_service.list_platform_applications.async_list_platform_applications(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPlatformApplications")
    )
    input_: capo_sns.types.list_platform_applications_input.ListPlatformApplicationsInput = {}
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output