@Generated(value="software.amazon.awssdk:codegen") public interface SnsAsyncClient extends SdkClient
builder()
method.
Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see https://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.
We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AddPermissionResponse> |
addPermission(AddPermissionRequest addPermissionRequest)
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the
specified actions.
|
default CompletableFuture<AddPermissionResponse> |
addPermission(Consumer<AddPermissionRequest.Builder> addPermissionRequest)
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the
specified actions.
|
static SnsAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
SnsAsyncClient. |
default CompletableFuture<CheckIfPhoneNumberIsOptedOutResponse> |
checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest)
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your
account.
|
default CompletableFuture<CheckIfPhoneNumberIsOptedOutResponse> |
checkIfPhoneNumberIsOptedOut(Consumer<CheckIfPhoneNumberIsOptedOutRequest.Builder> checkIfPhoneNumberIsOptedOutRequest)
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your
account.
|
default CompletableFuture<ConfirmSubscriptionResponse> |
confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest)
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an
earlier
Subscribe action. |
default CompletableFuture<ConfirmSubscriptionResponse> |
confirmSubscription(Consumer<ConfirmSubscriptionRequest.Builder> confirmSubscriptionRequest)
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an
earlier
Subscribe action. |
static SnsAsyncClient |
create()
Create a
SnsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreatePlatformApplicationResponse> |
createPlatformApplication(Consumer<CreatePlatformApplicationRequest.Builder> createPlatformApplicationRequest)
Creates a platform application object for one of the supported push notification services, such as APNS and FCM,
to which devices and mobile apps may register.
|
default CompletableFuture<CreatePlatformApplicationResponse> |
createPlatformApplication(CreatePlatformApplicationRequest createPlatformApplicationRequest)
Creates a platform application object for one of the supported push notification services, such as APNS and FCM,
to which devices and mobile apps may register.
|
default CompletableFuture<CreatePlatformEndpointResponse> |
createPlatformEndpoint(Consumer<CreatePlatformEndpointRequest.Builder> createPlatformEndpointRequest)
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as FCM
and APNS.
|
default CompletableFuture<CreatePlatformEndpointResponse> |
createPlatformEndpoint(CreatePlatformEndpointRequest createPlatformEndpointRequest)
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as FCM
and APNS.
|
default CompletableFuture<CreateTopicResponse> |
createTopic(Consumer<CreateTopicRequest.Builder> createTopicRequest)
Creates a topic to which notifications can be published.
|
default CompletableFuture<CreateTopicResponse> |
createTopic(CreateTopicRequest createTopicRequest)
Creates a topic to which notifications can be published.
|
default CompletableFuture<DeleteEndpointResponse> |
deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest)
Deletes the endpoint for a device and mobile app from Amazon SNS.
|
default CompletableFuture<DeleteEndpointResponse> |
deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
Deletes the endpoint for a device and mobile app from Amazon SNS.
|
default CompletableFuture<DeletePlatformApplicationResponse> |
deletePlatformApplication(Consumer<DeletePlatformApplicationRequest.Builder> deletePlatformApplicationRequest)
Deletes a platform application object for one of the supported push notification services, such as APNS and FCM.
|
default CompletableFuture<DeletePlatformApplicationResponse> |
deletePlatformApplication(DeletePlatformApplicationRequest deletePlatformApplicationRequest)
Deletes a platform application object for one of the supported push notification services, such as APNS and FCM.
|
default CompletableFuture<DeleteTopicResponse> |
deleteTopic(Consumer<DeleteTopicRequest.Builder> deleteTopicRequest)
Deletes a topic and all its subscriptions.
|
default CompletableFuture<DeleteTopicResponse> |
deleteTopic(DeleteTopicRequest deleteTopicRequest)
Deletes a topic and all its subscriptions.
|
default CompletableFuture<GetEndpointAttributesResponse> |
getEndpointAttributes(Consumer<GetEndpointAttributesRequest.Builder> getEndpointAttributesRequest)
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as FCM
and APNS.
|
default CompletableFuture<GetEndpointAttributesResponse> |
getEndpointAttributes(GetEndpointAttributesRequest getEndpointAttributesRequest)
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as FCM
and APNS.
|
default CompletableFuture<GetPlatformApplicationAttributesResponse> |
getPlatformApplicationAttributes(Consumer<GetPlatformApplicationAttributesRequest.Builder> getPlatformApplicationAttributesRequest)
Retrieves the attributes of the platform application object for the supported push notification services, such as
APNS and FCM.
|
default CompletableFuture<GetPlatformApplicationAttributesResponse> |
getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)
Retrieves the attributes of the platform application object for the supported push notification services, such as
APNS and FCM.
|
default CompletableFuture<GetSmsAttributesResponse> |
getSMSAttributes()
Returns the settings for sending SMS messages from your account.
|
default CompletableFuture<GetSmsAttributesResponse> |
getSMSAttributes(Consumer<GetSmsAttributesRequest.Builder> getSmsAttributesRequest)
Returns the settings for sending SMS messages from your account.
|
default CompletableFuture<GetSmsAttributesResponse> |
getSMSAttributes(GetSmsAttributesRequest getSmsAttributesRequest)
Returns the settings for sending SMS messages from your account.
|
default CompletableFuture<GetSubscriptionAttributesResponse> |
getSubscriptionAttributes(Consumer<GetSubscriptionAttributesRequest.Builder> getSubscriptionAttributesRequest)
Returns all of the properties of a subscription.
|
default CompletableFuture<GetSubscriptionAttributesResponse> |
getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)
Returns all of the properties of a subscription.
|
default CompletableFuture<GetTopicAttributesResponse> |
getTopicAttributes(Consumer<GetTopicAttributesRequest.Builder> getTopicAttributesRequest)
Returns all of the properties of a topic.
|
default CompletableFuture<GetTopicAttributesResponse> |
getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest)
Returns all of the properties of a topic.
|
default CompletableFuture<ListEndpointsByPlatformApplicationResponse> |
listEndpointsByPlatformApplication(Consumer<ListEndpointsByPlatformApplicationRequest.Builder> listEndpointsByPlatformApplicationRequest)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as FCM and
APNS.
|
default CompletableFuture<ListEndpointsByPlatformApplicationResponse> |
listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as FCM and
APNS.
|
default ListEndpointsByPlatformApplicationPublisher |
listEndpointsByPlatformApplicationPaginator(Consumer<ListEndpointsByPlatformApplicationRequest.Builder> listEndpointsByPlatformApplicationRequest)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as FCM and
APNS.
|
default ListEndpointsByPlatformApplicationPublisher |
listEndpointsByPlatformApplicationPaginator(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as FCM and
APNS.
|
default CompletableFuture<ListPhoneNumbersOptedOutResponse> |
listPhoneNumbersOptedOut()
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
|
default CompletableFuture<ListPhoneNumbersOptedOutResponse> |
listPhoneNumbersOptedOut(Consumer<ListPhoneNumbersOptedOutRequest.Builder> listPhoneNumbersOptedOutRequest)
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
|
default CompletableFuture<ListPhoneNumbersOptedOutResponse> |
listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest)
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
|
default CompletableFuture<ListPlatformApplicationsResponse> |
listPlatformApplications()
Lists the platform application objects for the supported push notification services, such as APNS and FCM.
|
default CompletableFuture<ListPlatformApplicationsResponse> |
listPlatformApplications(Consumer<ListPlatformApplicationsRequest.Builder> listPlatformApplicationsRequest)
Lists the platform application objects for the supported push notification services, such as APNS and FCM.
|
default CompletableFuture<ListPlatformApplicationsResponse> |
listPlatformApplications(ListPlatformApplicationsRequest listPlatformApplicationsRequest)
Lists the platform application objects for the supported push notification services, such as APNS and FCM.
|
default ListPlatformApplicationsPublisher |
listPlatformApplicationsPaginator()
Lists the platform application objects for the supported push notification services, such as APNS and FCM.
|
default ListPlatformApplicationsPublisher |
listPlatformApplicationsPaginator(Consumer<ListPlatformApplicationsRequest.Builder> listPlatformApplicationsRequest)
Lists the platform application objects for the supported push notification services, such as APNS and FCM.
|
default ListPlatformApplicationsPublisher |
listPlatformApplicationsPaginator(ListPlatformApplicationsRequest listPlatformApplicationsRequest)
Lists the platform application objects for the supported push notification services, such as APNS and FCM.
|
default CompletableFuture<ListSubscriptionsResponse> |
listSubscriptions()
Returns a list of the requester's subscriptions.
|
default CompletableFuture<ListSubscriptionsResponse> |
listSubscriptions(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest)
Returns a list of the requester's subscriptions.
|
default CompletableFuture<ListSubscriptionsResponse> |
listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest)
Returns a list of the requester's subscriptions.
|
default CompletableFuture<ListSubscriptionsByTopicResponse> |
listSubscriptionsByTopic(Consumer<ListSubscriptionsByTopicRequest.Builder> listSubscriptionsByTopicRequest)
Returns a list of the subscriptions to a specific topic.
|
default CompletableFuture<ListSubscriptionsByTopicResponse> |
listSubscriptionsByTopic(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)
Returns a list of the subscriptions to a specific topic.
|
default ListSubscriptionsByTopicPublisher |
listSubscriptionsByTopicPaginator(Consumer<ListSubscriptionsByTopicRequest.Builder> listSubscriptionsByTopicRequest)
Returns a list of the subscriptions to a specific topic.
|
default ListSubscriptionsByTopicPublisher |
listSubscriptionsByTopicPaginator(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)
Returns a list of the subscriptions to a specific topic.
|
default ListSubscriptionsPublisher |
listSubscriptionsPaginator()
Returns a list of the requester's subscriptions.
|
default ListSubscriptionsPublisher |
listSubscriptionsPaginator(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest)
Returns a list of the requester's subscriptions.
|
default ListSubscriptionsPublisher |
listSubscriptionsPaginator(ListSubscriptionsRequest listSubscriptionsRequest)
Returns a list of the requester's subscriptions.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List all tags added to the specified Amazon SNS topic.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List all tags added to the specified Amazon SNS topic.
|
default CompletableFuture<ListTopicsResponse> |
listTopics()
Returns a list of the requester's topics.
|
default CompletableFuture<ListTopicsResponse> |
listTopics(Consumer<ListTopicsRequest.Builder> listTopicsRequest)
Returns a list of the requester's topics.
|
default CompletableFuture<ListTopicsResponse> |
listTopics(ListTopicsRequest listTopicsRequest)
Returns a list of the requester's topics.
|
default ListTopicsPublisher |
listTopicsPaginator()
Returns a list of the requester's topics.
|
default ListTopicsPublisher |
listTopicsPaginator(Consumer<ListTopicsRequest.Builder> listTopicsRequest)
Returns a list of the requester's topics.
|
default ListTopicsPublisher |
listTopicsPaginator(ListTopicsRequest listTopicsRequest)
Returns a list of the requester's topics.
|
default CompletableFuture<OptInPhoneNumberResponse> |
optInPhoneNumber(Consumer<OptInPhoneNumberRequest.Builder> optInPhoneNumberRequest)
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to
the number.
|
default CompletableFuture<OptInPhoneNumberResponse> |
optInPhoneNumber(OptInPhoneNumberRequest optInPhoneNumberRequest)
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to
the number.
|
default CompletableFuture<PublishResponse> |
publish(Consumer<PublishRequest.Builder> publishRequest)
Sends a message to an Amazon SNS topic or sends a text message (SMS message) directly to a phone number.
|
default CompletableFuture<PublishResponse> |
publish(PublishRequest publishRequest)
Sends a message to an Amazon SNS topic or sends a text message (SMS message) directly to a phone number.
|
default CompletableFuture<RemovePermissionResponse> |
removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest)
Removes a statement from a topic's access control policy.
|
default CompletableFuture<RemovePermissionResponse> |
removePermission(RemovePermissionRequest removePermissionRequest)
Removes a statement from a topic's access control policy.
|
default CompletableFuture<SetEndpointAttributesResponse> |
setEndpointAttributes(Consumer<SetEndpointAttributesRequest.Builder> setEndpointAttributesRequest)
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as FCM
and APNS.
|
default CompletableFuture<SetEndpointAttributesResponse> |
setEndpointAttributes(SetEndpointAttributesRequest setEndpointAttributesRequest)
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as FCM
and APNS.
|
default CompletableFuture<SetPlatformApplicationAttributesResponse> |
setPlatformApplicationAttributes(Consumer<SetPlatformApplicationAttributesRequest.Builder> setPlatformApplicationAttributesRequest)
Sets the attributes of the platform application object for the supported push notification services, such as APNS
and FCM.
|
default CompletableFuture<SetPlatformApplicationAttributesResponse> |
setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)
Sets the attributes of the platform application object for the supported push notification services, such as APNS
and FCM.
|
default CompletableFuture<SetSmsAttributesResponse> |
setSMSAttributes(Consumer<SetSmsAttributesRequest.Builder> setSmsAttributesRequest)
Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
|
default CompletableFuture<SetSmsAttributesResponse> |
setSMSAttributes(SetSmsAttributesRequest setSmsAttributesRequest)
Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
|
default CompletableFuture<SetSubscriptionAttributesResponse> |
setSubscriptionAttributes(Consumer<SetSubscriptionAttributesRequest.Builder> setSubscriptionAttributesRequest)
Allows a subscription owner to set an attribute of the subscription to a new value.
|
default CompletableFuture<SetSubscriptionAttributesResponse> |
setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)
Allows a subscription owner to set an attribute of the subscription to a new value.
|
default CompletableFuture<SetTopicAttributesResponse> |
setTopicAttributes(Consumer<SetTopicAttributesRequest.Builder> setTopicAttributesRequest)
Allows a topic owner to set an attribute of the topic to a new value.
|
default CompletableFuture<SetTopicAttributesResponse> |
setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest)
Allows a topic owner to set an attribute of the topic to a new value.
|
default CompletableFuture<SubscribeResponse> |
subscribe(Consumer<SubscribeRequest.Builder> subscribeRequest)
Prepares to subscribe an endpoint by sending the endpoint a confirmation message.
|
default CompletableFuture<SubscribeResponse> |
subscribe(SubscribeRequest subscribeRequest)
Prepares to subscribe an endpoint by sending the endpoint a confirmation message.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Add tags to the specified Amazon SNS topic.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Add tags to the specified Amazon SNS topic.
|
default CompletableFuture<UnsubscribeResponse> |
unsubscribe(Consumer<UnsubscribeRequest.Builder> unsubscribeRequest)
Deletes a subscription.
|
default CompletableFuture<UnsubscribeResponse> |
unsubscribe(UnsubscribeRequest unsubscribeRequest)
Deletes a subscription.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Remove tags from the specified Amazon SNS topic.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Remove tags from the specified Amazon SNS topic.
|
serviceNameclosestatic final String SERVICE_NAME
static SnsAsyncClient create()
SnsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SnsAsyncClientBuilder builder()
SnsAsyncClient.default CompletableFuture<AddPermissionResponse> addPermission(AddPermissionRequest addPermissionRequest)
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
addPermissionRequest - default CompletableFuture<AddPermissionResponse> addPermission(Consumer<AddPermissionRequest.Builder> addPermissionRequest)
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
This is a convenience which creates an instance of the AddPermissionRequest.Builder avoiding the need to
create one manually via AddPermissionRequest.builder()
addPermissionRequest - A Consumer that will call methods on AddPermissionInput.Builder to create a request.default CompletableFuture<CheckIfPhoneNumberIsOptedOutResponse> checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest)
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.
checkIfPhoneNumberIsOptedOutRequest - The input for the CheckIfPhoneNumberIsOptedOut action.default CompletableFuture<CheckIfPhoneNumberIsOptedOutResponse> checkIfPhoneNumberIsOptedOut(Consumer<CheckIfPhoneNumberIsOptedOutRequest.Builder> checkIfPhoneNumberIsOptedOutRequest)
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.
This is a convenience which creates an instance of the CheckIfPhoneNumberIsOptedOutRequest.Builder
avoiding the need to create one manually via CheckIfPhoneNumberIsOptedOutRequest.builder()
checkIfPhoneNumberIsOptedOutRequest - A Consumer that will call methods on CheckIfPhoneNumberIsOptedOutInput.Builder to create a
request. The input for the CheckIfPhoneNumberIsOptedOut action.default CompletableFuture<ConfirmSubscriptionResponse> confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest)
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an
earlier Subscribe action. If the token is valid, the action creates a new subscription and returns
its Amazon Resource Name (ARN). This call requires an AWS signature only when the
AuthenticateOnUnsubscribe flag is set to "true".
confirmSubscriptionRequest - Input for ConfirmSubscription action.default CompletableFuture<ConfirmSubscriptionResponse> confirmSubscription(Consumer<ConfirmSubscriptionRequest.Builder> confirmSubscriptionRequest)
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an
earlier Subscribe action. If the token is valid, the action creates a new subscription and returns
its Amazon Resource Name (ARN). This call requires an AWS signature only when the
AuthenticateOnUnsubscribe flag is set to "true".
This is a convenience which creates an instance of the ConfirmSubscriptionRequest.Builder avoiding the
need to create one manually via ConfirmSubscriptionRequest.builder()
confirmSubscriptionRequest - A Consumer that will call methods on ConfirmSubscriptionInput.Builder to create a request.
Input for ConfirmSubscription action.default CompletableFuture<CreatePlatformApplicationResponse> createPlatformApplication(CreatePlatformApplicationRequest createPlatformApplicationRequest)
Creates a platform application object for one of the supported push notification services, such as APNS and FCM,
to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential
attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from
the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For FCM,
PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also
received from the notification service. For WNS, PlatformPrincipal is "Package Security Identifier". For MPNS,
PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key".
For APNS/APNS_SANDBOX, PlatformCredential is "private key". For FCM, PlatformCredential is "API key". For ADM,
PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential
is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when
using CreatePlatformApplication is then used as an attribute for the
CreatePlatformEndpoint action.
createPlatformApplicationRequest - Input for CreatePlatformApplication action.default CompletableFuture<CreatePlatformApplicationResponse> createPlatformApplication(Consumer<CreatePlatformApplicationRequest.Builder> createPlatformApplicationRequest)
Creates a platform application object for one of the supported push notification services, such as APNS and FCM,
to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential
attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from
the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For FCM,
PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also
received from the notification service. For WNS, PlatformPrincipal is "Package Security Identifier". For MPNS,
PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key".
For APNS/APNS_SANDBOX, PlatformCredential is "private key". For FCM, PlatformCredential is "API key". For ADM,
PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential
is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when
using CreatePlatformApplication is then used as an attribute for the
CreatePlatformEndpoint action.
This is a convenience which creates an instance of the CreatePlatformApplicationRequest.Builder avoiding
the need to create one manually via CreatePlatformApplicationRequest.builder()
createPlatformApplicationRequest - A Consumer that will call methods on CreatePlatformApplicationInput.Builder to create a
request. Input for CreatePlatformApplication action.default CompletableFuture<CreatePlatformEndpointResponse> createPlatformEndpoint(CreatePlatformEndpointRequest createPlatformEndpointRequest)
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as FCM
and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from
CreatePlatformApplication. The EndpointArn that is returned when using
CreatePlatformEndpoint can then be used by the Publish action to send a message to a
mobile app or by the Subscribe action for subscription to a topic. The
CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the
same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more
information, see Using Amazon SNS Mobile
Push Notifications.
When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId.
The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint
for Baidu.
createPlatformEndpointRequest - Input for CreatePlatformEndpoint action.default CompletableFuture<CreatePlatformEndpointResponse> createPlatformEndpoint(Consumer<CreatePlatformEndpointRequest.Builder> createPlatformEndpointRequest)
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as FCM
and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from
CreatePlatformApplication. The EndpointArn that is returned when using
CreatePlatformEndpoint can then be used by the Publish action to send a message to a
mobile app or by the Subscribe action for subscription to a topic. The
CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the
same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more
information, see Using Amazon SNS Mobile
Push Notifications.
When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId.
The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint
for Baidu.
This is a convenience which creates an instance of the CreatePlatformEndpointRequest.Builder avoiding the
need to create one manually via CreatePlatformEndpointRequest.builder()
createPlatformEndpointRequest - A Consumer that will call methods on CreatePlatformEndpointInput.Builder to create a
request. Input for CreatePlatformEndpoint action.default CompletableFuture<CreateTopicResponse> createTopic(CreateTopicRequest createTopicRequest)
Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
createTopicRequest - Input for CreateTopic action.default CompletableFuture<CreateTopicResponse> createTopic(Consumer<CreateTopicRequest.Builder> createTopicRequest)
Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
This is a convenience which creates an instance of the CreateTopicRequest.Builder avoiding the need to
create one manually via CreateTopicRequest.builder()
createTopicRequest - A Consumer that will call methods on CreateTopicInput.Builder to create a request. Input
for CreateTopic action.default CompletableFuture<DeleteEndpointResponse> deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.
deleteEndpointRequest - Input for DeleteEndpoint action.default CompletableFuture<DeleteEndpointResponse> deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest)
Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.
This is a convenience which creates an instance of the DeleteEndpointRequest.Builder avoiding the need to
create one manually via DeleteEndpointRequest.builder()
deleteEndpointRequest - A Consumer that will call methods on DeleteEndpointInput.Builder to create a request.
Input for DeleteEndpoint action.default CompletableFuture<DeletePlatformApplicationResponse> deletePlatformApplication(DeletePlatformApplicationRequest deletePlatformApplicationRequest)
Deletes a platform application object for one of the supported push notification services, such as APNS and FCM. For more information, see Using Amazon SNS Mobile Push Notifications.
deletePlatformApplicationRequest - Input for DeletePlatformApplication action.default CompletableFuture<DeletePlatformApplicationResponse> deletePlatformApplication(Consumer<DeletePlatformApplicationRequest.Builder> deletePlatformApplicationRequest)
Deletes a platform application object for one of the supported push notification services, such as APNS and FCM. For more information, see Using Amazon SNS Mobile Push Notifications.
This is a convenience which creates an instance of the DeletePlatformApplicationRequest.Builder avoiding
the need to create one manually via DeletePlatformApplicationRequest.builder()
deletePlatformApplicationRequest - A Consumer that will call methods on DeletePlatformApplicationInput.Builder to create a
request. Input for DeletePlatformApplication action.default CompletableFuture<DeleteTopicResponse> deleteTopic(DeleteTopicRequest deleteTopicRequest)
Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
deleteTopicRequest - default CompletableFuture<DeleteTopicResponse> deleteTopic(Consumer<DeleteTopicRequest.Builder> deleteTopicRequest)
Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
This is a convenience which creates an instance of the DeleteTopicRequest.Builder avoiding the need to
create one manually via DeleteTopicRequest.builder()
deleteTopicRequest - A Consumer that will call methods on DeleteTopicInput.Builder to create a request.default CompletableFuture<GetEndpointAttributesResponse> getEndpointAttributes(GetEndpointAttributesRequest getEndpointAttributesRequest)
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as FCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
getEndpointAttributesRequest - Input for GetEndpointAttributes action.default CompletableFuture<GetEndpointAttributesResponse> getEndpointAttributes(Consumer<GetEndpointAttributesRequest.Builder> getEndpointAttributesRequest)
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as FCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
This is a convenience which creates an instance of the GetEndpointAttributesRequest.Builder avoiding the
need to create one manually via GetEndpointAttributesRequest.builder()
getEndpointAttributesRequest - A Consumer that will call methods on GetEndpointAttributesInput.Builder to create a
request. Input for GetEndpointAttributes action.default CompletableFuture<GetPlatformApplicationAttributesResponse> getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and FCM. For more information, see Using Amazon SNS Mobile Push Notifications.
getPlatformApplicationAttributesRequest - Input for GetPlatformApplicationAttributes action.default CompletableFuture<GetPlatformApplicationAttributesResponse> getPlatformApplicationAttributes(Consumer<GetPlatformApplicationAttributesRequest.Builder> getPlatformApplicationAttributesRequest)
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and FCM. For more information, see Using Amazon SNS Mobile Push Notifications.
This is a convenience which creates an instance of the GetPlatformApplicationAttributesRequest.Builder
avoiding the need to create one manually via GetPlatformApplicationAttributesRequest.builder()
getPlatformApplicationAttributesRequest - A Consumer that will call methods on GetPlatformApplicationAttributesInput.Builder to
create a request. Input for GetPlatformApplicationAttributes action.default CompletableFuture<GetSmsAttributesResponse> getSMSAttributes(GetSmsAttributesRequest getSmsAttributesRequest)
Returns the settings for sending SMS messages from your account.
These settings are set with the SetSMSAttributes action.
getSmsAttributesRequest - The input for the GetSMSAttributes request.default CompletableFuture<GetSmsAttributesResponse> getSMSAttributes(Consumer<GetSmsAttributesRequest.Builder> getSmsAttributesRequest)
Returns the settings for sending SMS messages from your account.
These settings are set with the SetSMSAttributes action.
This is a convenience which creates an instance of the GetSmsAttributesRequest.Builder avoiding the need
to create one manually via GetSmsAttributesRequest.builder()
getSmsAttributesRequest - A Consumer that will call methods on GetSMSAttributesInput.Builder to create a request.
The input for the GetSMSAttributes request.default CompletableFuture<GetSmsAttributesResponse> getSMSAttributes()
Returns the settings for sending SMS messages from your account.
These settings are set with the SetSMSAttributes action.
default CompletableFuture<GetSubscriptionAttributesResponse> getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)
Returns all of the properties of a subscription.
getSubscriptionAttributesRequest - Input for GetSubscriptionAttributes.default CompletableFuture<GetSubscriptionAttributesResponse> getSubscriptionAttributes(Consumer<GetSubscriptionAttributesRequest.Builder> getSubscriptionAttributesRequest)
Returns all of the properties of a subscription.
This is a convenience which creates an instance of the GetSubscriptionAttributesRequest.Builder avoiding
the need to create one manually via GetSubscriptionAttributesRequest.builder()
getSubscriptionAttributesRequest - A Consumer that will call methods on GetSubscriptionAttributesInput.Builder to create a
request. Input for GetSubscriptionAttributes.default CompletableFuture<GetTopicAttributesResponse> getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest)
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
getTopicAttributesRequest - Input for GetTopicAttributes action.default CompletableFuture<GetTopicAttributesResponse> getTopicAttributes(Consumer<GetTopicAttributesRequest.Builder> getTopicAttributesRequest)
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
This is a convenience which creates an instance of the GetTopicAttributesRequest.Builder avoiding the
need to create one manually via GetTopicAttributesRequest.builder()
getTopicAttributesRequest - A Consumer that will call methods on GetTopicAttributesInput.Builder to create a request.
Input for GetTopicAttributes action.default CompletableFuture<ListEndpointsByPlatformApplicationResponse> listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as FCM 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).
listEndpointsByPlatformApplicationRequest - Input for ListEndpointsByPlatformApplication action.default CompletableFuture<ListEndpointsByPlatformApplicationResponse> listEndpointsByPlatformApplication(Consumer<ListEndpointsByPlatformApplicationRequest.Builder> listEndpointsByPlatformApplicationRequest)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as FCM 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).
This is a convenience which creates an instance of the ListEndpointsByPlatformApplicationRequest.Builder
avoiding the need to create one manually via ListEndpointsByPlatformApplicationRequest.builder()
listEndpointsByPlatformApplicationRequest - A Consumer that will call methods on ListEndpointsByPlatformApplicationInput.Builder to
create a request. Input for ListEndpointsByPlatformApplication action.default ListEndpointsByPlatformApplicationPublisher listEndpointsByPlatformApplicationPaginator(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as FCM 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).
This is a variant of
listEndpointsByPlatformApplication(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sns.paginators.ListEndpointsByPlatformApplicationPublisher publisher = client.listEndpointsByPlatformApplicationPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sns.paginators.ListEndpointsByPlatformApplicationPublisher publisher = client.listEndpointsByPlatformApplicationPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEndpointsByPlatformApplication(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationRequest)
operation.
listEndpointsByPlatformApplicationRequest - Input for ListEndpointsByPlatformApplication action.default ListEndpointsByPlatformApplicationPublisher listEndpointsByPlatformApplicationPaginator(Consumer<ListEndpointsByPlatformApplicationRequest.Builder> listEndpointsByPlatformApplicationRequest)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as FCM 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).
This is a variant of
listEndpointsByPlatformApplication(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sns.paginators.ListEndpointsByPlatformApplicationPublisher publisher = client.listEndpointsByPlatformApplicationPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sns.paginators.ListEndpointsByPlatformApplicationPublisher publisher = client.listEndpointsByPlatformApplicationPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEndpointsByPlatformApplication(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationRequest)
operation.
This is a convenience which creates an instance of the ListEndpointsByPlatformApplicationRequest.Builder
avoiding the need to create one manually via ListEndpointsByPlatformApplicationRequest.builder()
listEndpointsByPlatformApplicationRequest - A Consumer that will call methods on ListEndpointsByPlatformApplicationInput.Builder to
create a request. Input for ListEndpointsByPlatformApplication action.default CompletableFuture<ListPhoneNumbersOptedOutResponse> listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest)
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone
numbers. If additional phone numbers are available after the first page of results, then a NextToken
string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the
NextToken string received from the previous call. When there are no more records to return,
NextToken will be null.
listPhoneNumbersOptedOutRequest - The input for the ListPhoneNumbersOptedOut action.default CompletableFuture<ListPhoneNumbersOptedOutResponse> listPhoneNumbersOptedOut(Consumer<ListPhoneNumbersOptedOutRequest.Builder> listPhoneNumbersOptedOutRequest)
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone
numbers. If additional phone numbers are available after the first page of results, then a NextToken
string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the
NextToken string received from the previous call. When there are no more records to return,
NextToken will be null.
This is a convenience which creates an instance of the ListPhoneNumbersOptedOutRequest.Builder avoiding
the need to create one manually via ListPhoneNumbersOptedOutRequest.builder()
listPhoneNumbersOptedOutRequest - A Consumer that will call methods on ListPhoneNumbersOptedOutInput.Builder to create a
request. The input for the ListPhoneNumbersOptedOut action.default CompletableFuture<ListPhoneNumbersOptedOutResponse> listPhoneNumbersOptedOut()
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone
numbers. If additional phone numbers are available after the first page of results, then a NextToken
string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the
NextToken string received from the previous call. When there are no more records to return,
NextToken will be null.
default CompletableFuture<ListPlatformApplicationsResponse> listPlatformApplications(ListPlatformApplicationsRequest listPlatformApplicationsRequest)
Lists the platform application objects for the supported push notification services, such as APNS and FCM. 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).
listPlatformApplicationsRequest - Input for ListPlatformApplications action.default CompletableFuture<ListPlatformApplicationsResponse> listPlatformApplications(Consumer<ListPlatformApplicationsRequest.Builder> listPlatformApplicationsRequest)
Lists the platform application objects for the supported push notification services, such as APNS and FCM. 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).
This is a convenience which creates an instance of the ListPlatformApplicationsRequest.Builder avoiding
the need to create one manually via ListPlatformApplicationsRequest.builder()
listPlatformApplicationsRequest - A Consumer that will call methods on ListPlatformApplicationsInput.Builder to create a
request. Input for ListPlatformApplications action.default CompletableFuture<ListPlatformApplicationsResponse> listPlatformApplications()
Lists the platform application objects for the supported push notification services, such as APNS and FCM. 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).
default ListPlatformApplicationsPublisher listPlatformApplicationsPaginator()
Lists the platform application objects for the supported push notification services, such as APNS and FCM. 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).
This is a variant of
listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsPublisher publisher = client.listPlatformApplicationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsPublisher publisher = client.listPlatformApplicationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListPlatformApplicationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest)
operation.
default ListPlatformApplicationsPublisher listPlatformApplicationsPaginator(ListPlatformApplicationsRequest listPlatformApplicationsRequest)
Lists the platform application objects for the supported push notification services, such as APNS and FCM. 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).
This is a variant of
listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsPublisher publisher = client.listPlatformApplicationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsPublisher publisher = client.listPlatformApplicationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListPlatformApplicationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest)
operation.
listPlatformApplicationsRequest - Input for ListPlatformApplications action.default ListPlatformApplicationsPublisher listPlatformApplicationsPaginator(Consumer<ListPlatformApplicationsRequest.Builder> listPlatformApplicationsRequest)
Lists the platform application objects for the supported push notification services, such as APNS and FCM. 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).
This is a variant of
listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsPublisher publisher = client.listPlatformApplicationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsPublisher publisher = client.listPlatformApplicationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListPlatformApplicationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest)
operation.
This is a convenience which creates an instance of the ListPlatformApplicationsRequest.Builder avoiding
the need to create one manually via ListPlatformApplicationsRequest.builder()
listPlatformApplicationsRequest - A Consumer that will call methods on ListPlatformApplicationsInput.Builder to create a
request. Input for ListPlatformApplications action.default CompletableFuture<ListSubscriptionsResponse> listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest)
Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If
there are more subscriptions, a NextToken is also returned. Use the NextToken parameter
in a new ListSubscriptions call to get further results.
This action is throttled at 30 transactions per second (TPS).
listSubscriptionsRequest - Input for ListSubscriptions action.default CompletableFuture<ListSubscriptionsResponse> listSubscriptions(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest)
Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If
there are more subscriptions, a NextToken is also returned. Use the NextToken parameter
in a new ListSubscriptions call to get further results.
This action is throttled at 30 transactions per second (TPS).
This is a convenience which creates an instance of the ListSubscriptionsRequest.Builder avoiding the need
to create one manually via ListSubscriptionsRequest.builder()
listSubscriptionsRequest - A Consumer that will call methods on ListSubscriptionsInput.Builder to create a request.
Input for ListSubscriptions action.default CompletableFuture<ListSubscriptionsResponse> listSubscriptions()
Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If
there are more subscriptions, a NextToken is also returned. Use the NextToken parameter
in a new ListSubscriptions call to get further results.
This action is throttled at 30 transactions per second (TPS).
default CompletableFuture<ListSubscriptionsByTopicResponse> listSubscriptionsByTopic(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)
Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to
100. If there are more subscriptions, a NextToken is also returned. Use the NextToken
parameter in a new ListSubscriptionsByTopic call to get further results.
This action is throttled at 30 transactions per second (TPS).
listSubscriptionsByTopicRequest - Input for ListSubscriptionsByTopic action.default CompletableFuture<ListSubscriptionsByTopicResponse> listSubscriptionsByTopic(Consumer<ListSubscriptionsByTopicRequest.Builder> listSubscriptionsByTopicRequest)
Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to
100. If there are more subscriptions, a NextToken is also returned. Use the NextToken
parameter in a new ListSubscriptionsByTopic call to get further results.
This action is throttled at 30 transactions per second (TPS).
This is a convenience which creates an instance of the ListSubscriptionsByTopicRequest.Builder avoiding
the need to create one manually via ListSubscriptionsByTopicRequest.builder()
listSubscriptionsByTopicRequest - A Consumer that will call methods on ListSubscriptionsByTopicInput.Builder to create a
request. Input for ListSubscriptionsByTopic action.default ListSubscriptionsByTopicPublisher listSubscriptionsByTopicPaginator(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)
Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to
100. If there are more subscriptions, a NextToken is also returned. Use the NextToken
parameter in a new ListSubscriptionsByTopic call to get further results.
This action is throttled at 30 transactions per second (TPS).
This is a variant of
listSubscriptionsByTopic(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sns.paginators.ListSubscriptionsByTopicPublisher publisher = client.listSubscriptionsByTopicPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sns.paginators.ListSubscriptionsByTopicPublisher publisher = client.listSubscriptionsByTopicPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSubscriptionsByTopic(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicRequest)
operation.
listSubscriptionsByTopicRequest - Input for ListSubscriptionsByTopic action.default ListSubscriptionsByTopicPublisher listSubscriptionsByTopicPaginator(Consumer<ListSubscriptionsByTopicRequest.Builder> listSubscriptionsByTopicRequest)
Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to
100. If there are more subscriptions, a NextToken is also returned. Use the NextToken
parameter in a new ListSubscriptionsByTopic call to get further results.
This action is throttled at 30 transactions per second (TPS).
This is a variant of
listSubscriptionsByTopic(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sns.paginators.ListSubscriptionsByTopicPublisher publisher = client.listSubscriptionsByTopicPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sns.paginators.ListSubscriptionsByTopicPublisher publisher = client.listSubscriptionsByTopicPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSubscriptionsByTopic(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicRequest)
operation.
This is a convenience which creates an instance of the ListSubscriptionsByTopicRequest.Builder avoiding
the need to create one manually via ListSubscriptionsByTopicRequest.builder()
listSubscriptionsByTopicRequest - A Consumer that will call methods on ListSubscriptionsByTopicInput.Builder to create a
request. Input for ListSubscriptionsByTopic action.default ListSubscriptionsPublisher listSubscriptionsPaginator()
Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If
there are more subscriptions, a NextToken is also returned. Use the NextToken parameter
in a new ListSubscriptions call to get further results.
This action is throttled at 30 transactions per second (TPS).
This is a variant of
listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sns.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sns.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListSubscriptionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sns.model.ListSubscriptionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest) operation.
default ListSubscriptionsPublisher listSubscriptionsPaginator(ListSubscriptionsRequest listSubscriptionsRequest)
Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If
there are more subscriptions, a NextToken is also returned. Use the NextToken parameter
in a new ListSubscriptions call to get further results.
This action is throttled at 30 transactions per second (TPS).
This is a variant of
listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sns.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sns.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListSubscriptionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sns.model.ListSubscriptionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest) operation.
listSubscriptionsRequest - Input for ListSubscriptions action.default ListSubscriptionsPublisher listSubscriptionsPaginator(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest)
Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If
there are more subscriptions, a NextToken is also returned. Use the NextToken parameter
in a new ListSubscriptions call to get further results.
This action is throttled at 30 transactions per second (TPS).
This is a variant of
listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sns.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sns.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListSubscriptionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sns.model.ListSubscriptionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest) operation.
This is a convenience which creates an instance of the ListSubscriptionsRequest.Builder avoiding the need
to create one manually via ListSubscriptionsRequest.builder()
listSubscriptionsRequest - A Consumer that will call methods on ListSubscriptionsInput.Builder to create a request.
Input for ListSubscriptions action.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<ListTopicsResponse> listTopics(ListTopicsRequest listTopicsRequest)
Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are
more topics, a NextToken is also returned. Use the NextToken parameter in a new
ListTopics call to get further results.
This action is throttled at 30 transactions per second (TPS).
listTopicsRequest - default CompletableFuture<ListTopicsResponse> listTopics(Consumer<ListTopicsRequest.Builder> listTopicsRequest)
Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are
more topics, a NextToken is also returned. Use the NextToken parameter in a new
ListTopics call to get further results.
This action is throttled at 30 transactions per second (TPS).
This is a convenience which creates an instance of the ListTopicsRequest.Builder avoiding the need to
create one manually via ListTopicsRequest.builder()
listTopicsRequest - A Consumer that will call methods on ListTopicsInput.Builder to create a request.default CompletableFuture<ListTopicsResponse> listTopics()
Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are
more topics, a NextToken is also returned. Use the NextToken parameter in a new
ListTopics call to get further results.
This action is throttled at 30 transactions per second (TPS).
default ListTopicsPublisher listTopicsPaginator()
Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are
more topics, a NextToken is also returned. Use the NextToken parameter in a new
ListTopics call to get further results.
This action is throttled at 30 transactions per second (TPS).
This is a variant of listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sns.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sns.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListTopicsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sns.model.ListTopicsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest) operation.
default ListTopicsPublisher listTopicsPaginator(ListTopicsRequest listTopicsRequest)
Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are
more topics, a NextToken is also returned. Use the NextToken parameter in a new
ListTopics call to get further results.
This action is throttled at 30 transactions per second (TPS).
This is a variant of listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sns.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sns.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListTopicsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sns.model.ListTopicsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest) operation.
listTopicsRequest - default ListTopicsPublisher listTopicsPaginator(Consumer<ListTopicsRequest.Builder> listTopicsRequest)
Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are
more topics, a NextToken is also returned. Use the NextToken parameter in a new
ListTopics call to get further results.
This action is throttled at 30 transactions per second (TPS).
This is a variant of listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sns.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sns.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListTopicsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sns.model.ListTopicsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest) operation.
This is a convenience which creates an instance of the ListTopicsRequest.Builder avoiding the need to
create one manually via ListTopicsRequest.builder()
listTopicsRequest - A Consumer that will call methods on ListTopicsInput.Builder to create a request.default CompletableFuture<OptInPhoneNumberResponse> optInPhoneNumber(OptInPhoneNumberRequest optInPhoneNumberRequest)
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
You can opt in a phone number only once every 30 days.
optInPhoneNumberRequest - Input for the OptInPhoneNumber action.default CompletableFuture<OptInPhoneNumberResponse> optInPhoneNumber(Consumer<OptInPhoneNumberRequest.Builder> optInPhoneNumberRequest)
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
You can opt in a phone number only once every 30 days.
This is a convenience which creates an instance of the OptInPhoneNumberRequest.Builder avoiding the need
to create one manually via OptInPhoneNumberRequest.builder()
optInPhoneNumberRequest - A Consumer that will call methods on OptInPhoneNumberInput.Builder to create a request.
Input for the OptInPhoneNumber action.default CompletableFuture<PublishResponse> publish(PublishRequest publishRequest)
Sends a message to an Amazon SNS topic or sends a text message (SMS message) directly to a phone number.
If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.
When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it
shortly.
To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle
device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned
when making a call with the CreatePlatformEndpoint action.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
publishRequest - Input for Publish action.default CompletableFuture<PublishResponse> publish(Consumer<PublishRequest.Builder> publishRequest)
Sends a message to an Amazon SNS topic or sends a text message (SMS message) directly to a phone number.
If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.
When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it
shortly.
To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle
device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned
when making a call with the CreatePlatformEndpoint action.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
This is a convenience which creates an instance of the PublishRequest.Builder avoiding the need to create
one manually via PublishRequest.builder()
publishRequest - A Consumer that will call methods on PublishInput.Builder to create a request. Input for
Publish action.default CompletableFuture<RemovePermissionResponse> removePermission(RemovePermissionRequest removePermissionRequest)
Removes a statement from a topic's access control policy.
removePermissionRequest - Input for RemovePermission action.default CompletableFuture<RemovePermissionResponse> removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest)
Removes a statement from a topic's access control policy.
This is a convenience which creates an instance of the RemovePermissionRequest.Builder avoiding the need
to create one manually via RemovePermissionRequest.builder()
removePermissionRequest - A Consumer that will call methods on RemovePermissionInput.Builder to create a request.
Input for RemovePermission action.default CompletableFuture<SetEndpointAttributesResponse> setEndpointAttributes(SetEndpointAttributesRequest setEndpointAttributesRequest)
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as FCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
setEndpointAttributesRequest - Input for SetEndpointAttributes action.default CompletableFuture<SetEndpointAttributesResponse> setEndpointAttributes(Consumer<SetEndpointAttributesRequest.Builder> setEndpointAttributesRequest)
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as FCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
This is a convenience which creates an instance of the SetEndpointAttributesRequest.Builder avoiding the
need to create one manually via SetEndpointAttributesRequest.builder()
setEndpointAttributesRequest - A Consumer that will call methods on SetEndpointAttributesInput.Builder to create a
request. Input for SetEndpointAttributes action.default CompletableFuture<SetPlatformApplicationAttributesResponse> setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)
Sets the attributes of the platform application object for the supported push notification services, such as APNS and FCM. For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.
setPlatformApplicationAttributesRequest - Input for SetPlatformApplicationAttributes action.default CompletableFuture<SetPlatformApplicationAttributesResponse> setPlatformApplicationAttributes(Consumer<SetPlatformApplicationAttributesRequest.Builder> setPlatformApplicationAttributesRequest)
Sets the attributes of the platform application object for the supported push notification services, such as APNS and FCM. For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.
This is a convenience which creates an instance of the SetPlatformApplicationAttributesRequest.Builder
avoiding the need to create one manually via SetPlatformApplicationAttributesRequest.builder()
setPlatformApplicationAttributesRequest - A Consumer that will call methods on SetPlatformApplicationAttributesInput.Builder to
create a request. Input for SetPlatformApplicationAttributes action.default CompletableFuture<SetSmsAttributesResponse> setSMSAttributes(SetSmsAttributesRequest setSmsAttributesRequest)
Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
You can override some of these settings for a single message when you use the Publish action with
the MessageAttributes.entry.N parameter. For more information, see Sending an SMS Message in the
Amazon SNS Developer Guide.
setSmsAttributesRequest - The input for the SetSMSAttributes action.default CompletableFuture<SetSmsAttributesResponse> setSMSAttributes(Consumer<SetSmsAttributesRequest.Builder> setSmsAttributesRequest)
Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
You can override some of these settings for a single message when you use the Publish action with
the MessageAttributes.entry.N parameter. For more information, see Sending an SMS Message in the
Amazon SNS Developer Guide.
This is a convenience which creates an instance of the SetSmsAttributesRequest.Builder avoiding the need
to create one manually via SetSmsAttributesRequest.builder()
setSmsAttributesRequest - A Consumer that will call methods on SetSMSAttributesInput.Builder to create a request.
The input for the SetSMSAttributes action.default CompletableFuture<SetSubscriptionAttributesResponse> setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)
Allows a subscription owner to set an attribute of the subscription to a new value.
setSubscriptionAttributesRequest - Input for SetSubscriptionAttributes action.default CompletableFuture<SetSubscriptionAttributesResponse> setSubscriptionAttributes(Consumer<SetSubscriptionAttributesRequest.Builder> setSubscriptionAttributesRequest)
Allows a subscription owner to set an attribute of the subscription to a new value.
This is a convenience which creates an instance of the SetSubscriptionAttributesRequest.Builder avoiding
the need to create one manually via SetSubscriptionAttributesRequest.builder()
setSubscriptionAttributesRequest - A Consumer that will call methods on SetSubscriptionAttributesInput.Builder to create a
request. Input for SetSubscriptionAttributes action.default CompletableFuture<SetTopicAttributesResponse> setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest)
Allows a topic owner to set an attribute of the topic to a new value.
setTopicAttributesRequest - Input for SetTopicAttributes action.default CompletableFuture<SetTopicAttributesResponse> setTopicAttributes(Consumer<SetTopicAttributesRequest.Builder> setTopicAttributesRequest)
Allows a topic owner to set an attribute of the topic to a new value.
This is a convenience which creates an instance of the SetTopicAttributesRequest.Builder avoiding the
need to create one manually via SetTopicAttributesRequest.builder()
setTopicAttributesRequest - A Consumer that will call methods on SetTopicAttributesInput.Builder to create a request.
Input for SetTopicAttributes action.default CompletableFuture<SubscribeResponse> subscribe(SubscribeRequest subscribeRequest)
Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a
subscription, the endpoint owner must call the ConfirmSubscription action with the token from the
confirmation message. Confirmation tokens are valid for three days.
This action is throttled at 100 transactions per second (TPS).
subscribeRequest - Input for Subscribe action.default CompletableFuture<SubscribeResponse> subscribe(Consumer<SubscribeRequest.Builder> subscribeRequest)
Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a
subscription, the endpoint owner must call the ConfirmSubscription action with the token from the
confirmation message. Confirmation tokens are valid for three days.
This action is throttled at 100 transactions per second (TPS).
This is a convenience which creates an instance of the SubscribeRequest.Builder avoiding the need to
create one manually via SubscribeRequest.builder()
subscribeRequest - A Consumer that will call methods on SubscribeInput.Builder to create a request. Input for
Subscribe action.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
When you use topic tags, keep the following guidelines in mind:
Adding more than 50 tags to a topic isn't recommended.
Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
Tagging actions are limited to 10 TPS per AWS account, per AWS region. If your application requires a higher throughput, file a technical support request.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
When you use topic tags, keep the following guidelines in mind:
Adding more than 50 tags to a topic isn't recommended.
Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
Tagging actions are limited to 10 TPS per AWS account, per AWS region. If your application requires a higher throughput, file a technical support request.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UnsubscribeResponse> unsubscribe(UnsubscribeRequest unsubscribeRequest)
Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the
subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the
Unsubscribe call does not require authentication and the requester is not the subscription owner, a
final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the
topic if the Unsubscribe request was unintended.
This action is throttled at 100 transactions per second (TPS).
unsubscribeRequest - Input for Unsubscribe action.default CompletableFuture<UnsubscribeResponse> unsubscribe(Consumer<UnsubscribeRequest.Builder> unsubscribeRequest)
Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the
subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the
Unsubscribe call does not require authentication and the requester is not the subscription owner, a
final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the
topic if the Unsubscribe request was unintended.
This action is throttled at 100 transactions per second (TPS).
This is a convenience which creates an instance of the UnsubscribeRequest.Builder avoiding the need to
create one manually via UnsubscribeRequest.builder()
unsubscribeRequest - A Consumer that will call methods on UnsubscribeInput.Builder to create a request. Input
for Unsubscribe action.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.Copyright © 2020. All rights reserved.