public interface AmazonSNSAsync extends AmazonSNS
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
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 http://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.
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<AddPermissionResult> |
addPermissionAsync(AddPermissionRequest addPermissionRequest)
Adds a statement to a topic's access control policy, granting access for
the specified AWS accounts to the specified actions.
|
Future<AddPermissionResult> |
addPermissionAsync(AddPermissionRequest addPermissionRequest,
AsyncHandler<AddPermissionRequest,AddPermissionResult> asyncHandler)
Adds a statement to a topic's access control policy, granting access for
the specified AWS accounts to the specified actions.
|
Future<AddPermissionResult> |
addPermissionAsync(String topicArn,
String label,
List<String> aWSAccountIds,
List<String> actionNames)
Simplified method form for invoking the AddPermission operation.
|
Future<AddPermissionResult> |
addPermissionAsync(String topicArn,
String label,
List<String> aWSAccountIds,
List<String> actionNames,
AsyncHandler<AddPermissionRequest,AddPermissionResult> asyncHandler)
Simplified method form for invoking the AddPermission operation with an
AsyncHandler.
|
Future<CheckIfPhoneNumberIsOptedOutResult> |
checkIfPhoneNumberIsOptedOutAsync(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest)
Accepts a phone number and indicates whether the phone holder has opted
out of receiving SMS messages from your account.
|
Future<CheckIfPhoneNumberIsOptedOutResult> |
checkIfPhoneNumberIsOptedOutAsync(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest,
AsyncHandler<CheckIfPhoneNumberIsOptedOutRequest,CheckIfPhoneNumberIsOptedOutResult> asyncHandler)
Accepts a phone number and indicates whether the phone holder has opted
out of receiving SMS messages from your account.
|
Future<ConfirmSubscriptionResult> |
confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest)
Verifies an endpoint owner's intent to receive messages by validating the
token sent to the endpoint by an earlier
Subscribe action. |
Future<ConfirmSubscriptionResult> |
confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest,
AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler)
Verifies an endpoint owner's intent to receive messages by validating the
token sent to the endpoint by an earlier
Subscribe action. |
Future<ConfirmSubscriptionResult> |
confirmSubscriptionAsync(String topicArn,
String token)
Simplified method form for invoking the ConfirmSubscription operation.
|
Future<ConfirmSubscriptionResult> |
confirmSubscriptionAsync(String topicArn,
String token,
AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler)
Simplified method form for invoking the ConfirmSubscription operation
with an AsyncHandler.
|
Future<ConfirmSubscriptionResult> |
confirmSubscriptionAsync(String topicArn,
String token,
String authenticateOnUnsubscribe)
Simplified method form for invoking the ConfirmSubscription operation.
|
Future<ConfirmSubscriptionResult> |
confirmSubscriptionAsync(String topicArn,
String token,
String authenticateOnUnsubscribe,
AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler)
Simplified method form for invoking the ConfirmSubscription operation
with an AsyncHandler.
|
Future<CreatePlatformApplicationResult> |
createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest)
Creates a platform application object for one of the supported push
notification services, such as APNS and GCM, to which devices and mobile
apps may register.
|
Future<CreatePlatformApplicationResult> |
createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest,
AsyncHandler<CreatePlatformApplicationRequest,CreatePlatformApplicationResult> asyncHandler)
Creates a platform application object for one of the supported push
notification services, such as APNS and GCM, to which devices and mobile
apps may register.
|
Future<CreatePlatformEndpointResult> |
createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest)
Creates an endpoint for a device and mobile app on one of the supported
push notification services, such as GCM and APNS.
|
Future<CreatePlatformEndpointResult> |
createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest,
AsyncHandler<CreatePlatformEndpointRequest,CreatePlatformEndpointResult> asyncHandler)
Creates an endpoint for a device and mobile app on one of the supported
push notification services, such as GCM and APNS.
|
Future<CreateTopicResult> |
createTopicAsync(CreateTopicRequest createTopicRequest)
Creates a topic to which notifications can be published.
|
Future<CreateTopicResult> |
createTopicAsync(CreateTopicRequest createTopicRequest,
AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler)
Creates a topic to which notifications can be published.
|
Future<CreateTopicResult> |
createTopicAsync(String name)
Simplified method form for invoking the CreateTopic operation.
|
Future<CreateTopicResult> |
createTopicAsync(String name,
AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler)
Simplified method form for invoking the CreateTopic operation with an
AsyncHandler.
|
Future<DeleteEndpointResult> |
deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest)
Deletes the endpoint for a device and mobile app from Amazon SNS.
|
Future<DeleteEndpointResult> |
deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest,
AsyncHandler<DeleteEndpointRequest,DeleteEndpointResult> asyncHandler)
Deletes the endpoint for a device and mobile app from Amazon SNS.
|
Future<DeletePlatformApplicationResult> |
deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest)
Deletes a platform application object for one of the supported push
notification services, such as APNS and GCM.
|
Future<DeletePlatformApplicationResult> |
deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest,
AsyncHandler<DeletePlatformApplicationRequest,DeletePlatformApplicationResult> asyncHandler)
Deletes a platform application object for one of the supported push
notification services, such as APNS and GCM.
|
Future<DeleteTopicResult> |
deleteTopicAsync(DeleteTopicRequest deleteTopicRequest)
Deletes a topic and all its subscriptions.
|
Future<DeleteTopicResult> |
deleteTopicAsync(DeleteTopicRequest deleteTopicRequest,
AsyncHandler<DeleteTopicRequest,DeleteTopicResult> asyncHandler)
Deletes a topic and all its subscriptions.
|
Future<DeleteTopicResult> |
deleteTopicAsync(String topicArn)
Simplified method form for invoking the DeleteTopic operation.
|
Future<DeleteTopicResult> |
deleteTopicAsync(String topicArn,
AsyncHandler<DeleteTopicRequest,DeleteTopicResult> asyncHandler)
Simplified method form for invoking the DeleteTopic operation with an
AsyncHandler.
|
Future<GetEndpointAttributesResult> |
getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest)
Retrieves the endpoint attributes for a device on one of the supported
push notification services, such as GCM and APNS.
|
Future<GetEndpointAttributesResult> |
getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest,
AsyncHandler<GetEndpointAttributesRequest,GetEndpointAttributesResult> asyncHandler)
Retrieves the endpoint attributes for a device on one of the supported
push notification services, such as GCM and APNS.
|
Future<GetPlatformApplicationAttributesResult> |
getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)
Retrieves the attributes of the platform application object for the
supported push notification services, such as APNS and GCM.
|
Future<GetPlatformApplicationAttributesResult> |
getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest,
AsyncHandler<GetPlatformApplicationAttributesRequest,GetPlatformApplicationAttributesResult> asyncHandler)
Retrieves the attributes of the platform application object for the
supported push notification services, such as APNS and GCM.
|
Future<GetSMSAttributesResult> |
getSMSAttributesAsync(GetSMSAttributesRequest getSMSAttributesRequest)
Returns the settings for sending SMS messages from your account.
|
Future<GetSMSAttributesResult> |
getSMSAttributesAsync(GetSMSAttributesRequest getSMSAttributesRequest,
AsyncHandler<GetSMSAttributesRequest,GetSMSAttributesResult> asyncHandler)
Returns the settings for sending SMS messages from your account.
|
Future<GetSubscriptionAttributesResult> |
getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)
Returns all of the properties of a subscription.
|
Future<GetSubscriptionAttributesResult> |
getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest,
AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler)
Returns all of the properties of a subscription.
|
Future<GetSubscriptionAttributesResult> |
getSubscriptionAttributesAsync(String subscriptionArn)
Simplified method form for invoking the GetSubscriptionAttributes
operation.
|
Future<GetSubscriptionAttributesResult> |
getSubscriptionAttributesAsync(String subscriptionArn,
AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler)
Simplified method form for invoking the GetSubscriptionAttributes
operation with an AsyncHandler.
|
Future<GetTopicAttributesResult> |
getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest)
Returns all of the properties of a topic.
|
Future<GetTopicAttributesResult> |
getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest,
AsyncHandler<GetTopicAttributesRequest,GetTopicAttributesResult> asyncHandler)
Returns all of the properties of a topic.
|
Future<GetTopicAttributesResult> |
getTopicAttributesAsync(String topicArn)
Simplified method form for invoking the GetTopicAttributes operation.
|
Future<GetTopicAttributesResult> |
getTopicAttributesAsync(String topicArn,
AsyncHandler<GetTopicAttributesRequest,GetTopicAttributesResult> asyncHandler)
Simplified method form for invoking the GetTopicAttributes operation with
an AsyncHandler.
|
Future<ListEndpointsByPlatformApplicationResult> |
listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)
Lists the endpoints and endpoint attributes for devices in a supported
push notification service, such as GCM and APNS.
|
Future<ListEndpointsByPlatformApplicationResult> |
listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest,
AsyncHandler<ListEndpointsByPlatformApplicationRequest,ListEndpointsByPlatformApplicationResult> asyncHandler)
Lists the endpoints and endpoint attributes for devices in a supported
push notification service, such as GCM and APNS.
|
Future<ListPhoneNumbersOptedOutResult> |
listPhoneNumbersOptedOutAsync(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest)
Returns a list of phone numbers that are opted out, meaning you cannot
send SMS messages to them.
|
Future<ListPhoneNumbersOptedOutResult> |
listPhoneNumbersOptedOutAsync(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest,
AsyncHandler<ListPhoneNumbersOptedOutRequest,ListPhoneNumbersOptedOutResult> asyncHandler)
Returns a list of phone numbers that are opted out, meaning you cannot
send SMS messages to them.
|
Future<ListPlatformApplicationsResult> |
listPlatformApplicationsAsync()
Simplified method form for invoking the ListPlatformApplications
operation.
|
Future<ListPlatformApplicationsResult> |
listPlatformApplicationsAsync(AsyncHandler<ListPlatformApplicationsRequest,ListPlatformApplicationsResult> asyncHandler)
Simplified method form for invoking the ListPlatformApplications
operation with an AsyncHandler.
|
Future<ListPlatformApplicationsResult> |
listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest)
Lists the platform application objects for the supported push
notification services, such as APNS and GCM.
|
Future<ListPlatformApplicationsResult> |
listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest,
AsyncHandler<ListPlatformApplicationsRequest,ListPlatformApplicationsResult> asyncHandler)
Lists the platform application objects for the supported push
notification services, such as APNS and GCM.
|
Future<ListSubscriptionsResult> |
listSubscriptionsAsync()
Simplified method form for invoking the ListSubscriptions operation.
|
Future<ListSubscriptionsResult> |
listSubscriptionsAsync(AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler)
Simplified method form for invoking the ListSubscriptions operation with
an AsyncHandler.
|
Future<ListSubscriptionsResult> |
listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest)
Returns a list of the requester's subscriptions.
|
Future<ListSubscriptionsResult> |
listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest,
AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler)
Returns a list of the requester's subscriptions.
|
Future<ListSubscriptionsResult> |
listSubscriptionsAsync(String nextToken)
Simplified method form for invoking the ListSubscriptions operation.
|
Future<ListSubscriptionsResult> |
listSubscriptionsAsync(String nextToken,
AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler)
Simplified method form for invoking the ListSubscriptions operation with
an AsyncHandler.
|
Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)
Returns a list of the subscriptions to a specific topic.
|
Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest,
AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler)
Returns a list of the subscriptions to a specific topic.
|
Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(String topicArn)
Simplified method form for invoking the ListSubscriptionsByTopic
operation.
|
Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(String topicArn,
AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler)
Simplified method form for invoking the ListSubscriptionsByTopic
operation with an AsyncHandler.
|
Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(String topicArn,
String nextToken)
Simplified method form for invoking the ListSubscriptionsByTopic
operation.
|
Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(String topicArn,
String nextToken,
AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler)
Simplified method form for invoking the ListSubscriptionsByTopic
operation with an AsyncHandler.
|
Future<ListTopicsResult> |
listTopicsAsync()
Simplified method form for invoking the ListTopics operation.
|
Future<ListTopicsResult> |
listTopicsAsync(AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
Simplified method form for invoking the ListTopics operation with an
AsyncHandler.
|
Future<ListTopicsResult> |
listTopicsAsync(ListTopicsRequest listTopicsRequest)
Returns a list of the requester's topics.
|
Future<ListTopicsResult> |
listTopicsAsync(ListTopicsRequest listTopicsRequest,
AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
Returns a list of the requester's topics.
|
Future<ListTopicsResult> |
listTopicsAsync(String nextToken)
Simplified method form for invoking the ListTopics operation.
|
Future<ListTopicsResult> |
listTopicsAsync(String nextToken,
AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
Simplified method form for invoking the ListTopics operation with an
AsyncHandler.
|
Future<OptInPhoneNumberResult> |
optInPhoneNumberAsync(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.
|
Future<OptInPhoneNumberResult> |
optInPhoneNumberAsync(OptInPhoneNumberRequest optInPhoneNumberRequest,
AsyncHandler<OptInPhoneNumberRequest,OptInPhoneNumberResult> asyncHandler)
Use this request to opt in a phone number that is opted out, which
enables you to resume sending SMS messages to the number.
|
Future<PublishResult> |
publishAsync(PublishRequest publishRequest)
Sends a message to all of a topic's subscribed endpoints.
|
Future<PublishResult> |
publishAsync(PublishRequest publishRequest,
AsyncHandler<PublishRequest,PublishResult> asyncHandler)
Sends a message to all of a topic's subscribed endpoints.
|
Future<PublishResult> |
publishAsync(String topicArn,
String message)
Simplified method form for invoking the Publish operation.
|
Future<PublishResult> |
publishAsync(String topicArn,
String message,
AsyncHandler<PublishRequest,PublishResult> asyncHandler)
Simplified method form for invoking the Publish operation with an
AsyncHandler.
|
Future<PublishResult> |
publishAsync(String topicArn,
String message,
String subject)
Simplified method form for invoking the Publish operation.
|
Future<PublishResult> |
publishAsync(String topicArn,
String message,
String subject,
AsyncHandler<PublishRequest,PublishResult> asyncHandler)
Simplified method form for invoking the Publish operation with an
AsyncHandler.
|
Future<RemovePermissionResult> |
removePermissionAsync(RemovePermissionRequest removePermissionRequest)
Removes a statement from a topic's access control policy.
|
Future<RemovePermissionResult> |
removePermissionAsync(RemovePermissionRequest removePermissionRequest,
AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
Removes a statement from a topic's access control policy.
|
Future<RemovePermissionResult> |
removePermissionAsync(String topicArn,
String label)
Simplified method form for invoking the RemovePermission operation.
|
Future<RemovePermissionResult> |
removePermissionAsync(String topicArn,
String label,
AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
Simplified method form for invoking the RemovePermission operation with
an AsyncHandler.
|
Future<SetEndpointAttributesResult> |
setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest)
Sets the attributes for an endpoint for a device on one of the supported
push notification services, such as GCM and APNS.
|
Future<SetEndpointAttributesResult> |
setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest,
AsyncHandler<SetEndpointAttributesRequest,SetEndpointAttributesResult> asyncHandler)
Sets the attributes for an endpoint for a device on one of the supported
push notification services, such as GCM and APNS.
|
Future<SetPlatformApplicationAttributesResult> |
setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)
Sets the attributes of the platform application object for the supported
push notification services, such as APNS and GCM.
|
Future<SetPlatformApplicationAttributesResult> |
setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest,
AsyncHandler<SetPlatformApplicationAttributesRequest,SetPlatformApplicationAttributesResult> asyncHandler)
Sets the attributes of the platform application object for the supported
push notification services, such as APNS and GCM.
|
Future<SetSMSAttributesResult> |
setSMSAttributesAsync(SetSMSAttributesRequest setSMSAttributesRequest)
Use this request to set the default settings for sending SMS messages and
receiving daily SMS usage reports.
|
Future<SetSMSAttributesResult> |
setSMSAttributesAsync(SetSMSAttributesRequest setSMSAttributesRequest,
AsyncHandler<SetSMSAttributesRequest,SetSMSAttributesResult> asyncHandler)
Use this request to set the default settings for sending SMS messages and
receiving daily SMS usage reports.
|
Future<SetSubscriptionAttributesResult> |
setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)
Allows a subscription owner to set an attribute of the topic to a new
value.
|
Future<SetSubscriptionAttributesResult> |
setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest,
AsyncHandler<SetSubscriptionAttributesRequest,SetSubscriptionAttributesResult> asyncHandler)
Allows a subscription owner to set an attribute of the topic to a new
value.
|
Future<SetSubscriptionAttributesResult> |
setSubscriptionAttributesAsync(String subscriptionArn,
String attributeName,
String attributeValue)
Simplified method form for invoking the SetSubscriptionAttributes
operation.
|
Future<SetSubscriptionAttributesResult> |
setSubscriptionAttributesAsync(String subscriptionArn,
String attributeName,
String attributeValue,
AsyncHandler<SetSubscriptionAttributesRequest,SetSubscriptionAttributesResult> asyncHandler)
Simplified method form for invoking the SetSubscriptionAttributes
operation with an AsyncHandler.
|
Future<SetTopicAttributesResult> |
setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest)
Allows a topic owner to set an attribute of the topic to a new value.
|
Future<SetTopicAttributesResult> |
setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest,
AsyncHandler<SetTopicAttributesRequest,SetTopicAttributesResult> asyncHandler)
Allows a topic owner to set an attribute of the topic to a new value.
|
Future<SetTopicAttributesResult> |
setTopicAttributesAsync(String topicArn,
String attributeName,
String attributeValue)
Simplified method form for invoking the SetTopicAttributes operation.
|
Future<SetTopicAttributesResult> |
setTopicAttributesAsync(String topicArn,
String attributeName,
String attributeValue,
AsyncHandler<SetTopicAttributesRequest,SetTopicAttributesResult> asyncHandler)
Simplified method form for invoking the SetTopicAttributes operation with
an AsyncHandler.
|
Future<SubscribeResult> |
subscribeAsync(String topicArn,
String protocol,
String endpoint)
Simplified method form for invoking the Subscribe operation.
|
Future<SubscribeResult> |
subscribeAsync(String topicArn,
String protocol,
String endpoint,
AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)
Simplified method form for invoking the Subscribe operation with an
AsyncHandler.
|
Future<SubscribeResult> |
subscribeAsync(SubscribeRequest subscribeRequest)
Prepares to subscribe an endpoint by sending the endpoint a confirmation
message.
|
Future<SubscribeResult> |
subscribeAsync(SubscribeRequest subscribeRequest,
AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)
Prepares to subscribe an endpoint by sending the endpoint a confirmation
message.
|
Future<UnsubscribeResult> |
unsubscribeAsync(String subscriptionArn)
Simplified method form for invoking the Unsubscribe operation.
|
Future<UnsubscribeResult> |
unsubscribeAsync(String subscriptionArn,
AsyncHandler<UnsubscribeRequest,UnsubscribeResult> asyncHandler)
Simplified method form for invoking the Unsubscribe operation with an
AsyncHandler.
|
Future<UnsubscribeResult> |
unsubscribeAsync(UnsubscribeRequest unsubscribeRequest)
Deletes a subscription.
|
Future<UnsubscribeResult> |
unsubscribeAsync(UnsubscribeRequest unsubscribeRequest,
AsyncHandler<UnsubscribeRequest,UnsubscribeResult> asyncHandler)
Deletes a subscription.
|
addPermission, addPermission, checkIfPhoneNumberIsOptedOut, confirmSubscription, confirmSubscription, confirmSubscription, createPlatformApplication, createPlatformEndpoint, createTopic, createTopic, deleteEndpoint, deletePlatformApplication, deleteTopic, deleteTopic, getCachedResponseMetadata, getEndpointAttributes, getPlatformApplicationAttributes, getSMSAttributes, getSubscriptionAttributes, getSubscriptionAttributes, getTopicAttributes, getTopicAttributes, listEndpointsByPlatformApplication, listPhoneNumbersOptedOut, listPlatformApplications, listPlatformApplications, listSubscriptions, listSubscriptions, listSubscriptions, listSubscriptionsByTopic, listSubscriptionsByTopic, listSubscriptionsByTopic, listTopics, listTopics, listTopics, optInPhoneNumber, publish, publish, publish, removePermission, removePermission, setEndpoint, setEndpointAttributes, setPlatformApplicationAttributes, setRegion, setSMSAttributes, setSubscriptionAttributes, setSubscriptionAttributes, setTopicAttributes, setTopicAttributes, shutdown, subscribe, subscribe, unsubscribe, unsubscribe
Future<AddPermissionResult> addPermissionAsync(AddPermissionRequest addPermissionRequest)
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
addPermissionRequest
- Future<AddPermissionResult> addPermissionAsync(AddPermissionRequest addPermissionRequest, AsyncHandler<AddPermissionRequest,AddPermissionResult> asyncHandler)
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
addPermissionRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AddPermissionResult> addPermissionAsync(String topicArn, String label, List<String> aWSAccountIds, List<String> actionNames)
addPermissionAsync(AddPermissionRequest)
Future<AddPermissionResult> addPermissionAsync(String topicArn, String label, List<String> aWSAccountIds, List<String> actionNames, AsyncHandler<AddPermissionRequest,AddPermissionResult> asyncHandler)
Future<CheckIfPhoneNumberIsOptedOutResult> checkIfPhoneNumberIsOptedOutAsync(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.Future<CheckIfPhoneNumberIsOptedOutResult> checkIfPhoneNumberIsOptedOutAsync(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest, AsyncHandler<CheckIfPhoneNumberIsOptedOutRequest,CheckIfPhoneNumberIsOptedOutResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(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.Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest, AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(String topicArn, String token, String authenticateOnUnsubscribe)
Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(String topicArn, String token, String authenticateOnUnsubscribe, AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler)
Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(String topicArn, String token)
Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(String topicArn, String token, AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler)
Future<CreatePlatformApplicationResult> createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest)
Creates a platform application object for one of the supported push
notification services, such as APNS and GCM, 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 GCM, 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 GCM,
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. For more information, see
Using Amazon SNS Mobile Push Notifications. For more information
about obtaining the PlatformPrincipal and PlatformCredential for each of
the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS.
createPlatformApplicationRequest
- Input for CreatePlatformApplication action.Future<CreatePlatformApplicationResult> createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest, AsyncHandler<CreatePlatformApplicationRequest,CreatePlatformApplicationResult> asyncHandler)
Creates a platform application object for one of the supported push
notification services, such as APNS and GCM, 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 GCM, 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 GCM,
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. For more information, see
Using Amazon SNS Mobile Push Notifications. For more information
about obtaining the PlatformPrincipal and PlatformCredential for each of
the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS.
createPlatformApplicationRequest
- Input for CreatePlatformApplication action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreatePlatformEndpointResult> createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest)
Creates an endpoint for a device and mobile app on one of the supported
push notification services, such as GCM 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.Future<CreatePlatformEndpointResult> createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest, AsyncHandler<CreatePlatformEndpointRequest,CreatePlatformEndpointResult> asyncHandler)
Creates an endpoint for a device and mobile app on one of the supported
push notification services, such as GCM 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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateTopicResult> createTopicAsync(CreateTopicRequest createTopicRequest)
Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see http://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.Future<CreateTopicResult> createTopicAsync(CreateTopicRequest createTopicRequest, AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler)
Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see http://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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateTopicResult> createTopicAsync(String name)
createTopicAsync(CreateTopicRequest)
Future<CreateTopicResult> createTopicAsync(String name, AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler)
Future<DeleteEndpointResult> deleteEndpointAsync(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.Future<DeleteEndpointResult> deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest, AsyncHandler<DeleteEndpointRequest,DeleteEndpointResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeletePlatformApplicationResult> deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest)
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
deletePlatformApplicationRequest
- Input for DeletePlatformApplication action.Future<DeletePlatformApplicationResult> deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest, AsyncHandler<DeletePlatformApplicationRequest,DeletePlatformApplicationResult> asyncHandler)
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
deletePlatformApplicationRequest
- Input for DeletePlatformApplication action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteTopicResult> deleteTopicAsync(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
- Future<DeleteTopicResult> deleteTopicAsync(DeleteTopicRequest deleteTopicRequest, AsyncHandler<DeleteTopicRequest,DeleteTopicResult> asyncHandler)
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
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteTopicResult> deleteTopicAsync(String topicArn)
deleteTopicAsync(DeleteTopicRequest)
Future<DeleteTopicResult> deleteTopicAsync(String topicArn, AsyncHandler<DeleteTopicRequest,DeleteTopicResult> asyncHandler)
Future<GetEndpointAttributesResult> getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest)
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
getEndpointAttributesRequest
- Input for GetEndpointAttributes action.Future<GetEndpointAttributesResult> getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest, AsyncHandler<GetEndpointAttributesRequest,GetEndpointAttributesResult> asyncHandler)
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
getEndpointAttributesRequest
- Input for GetEndpointAttributes action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetPlatformApplicationAttributesResult> getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
getPlatformApplicationAttributesRequest
- Input for GetPlatformApplicationAttributes action.Future<GetPlatformApplicationAttributesResult> getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest, AsyncHandler<GetPlatformApplicationAttributesRequest,GetPlatformApplicationAttributesResult> asyncHandler)
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
getPlatformApplicationAttributesRequest
- Input for GetPlatformApplicationAttributes action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSMSAttributesResult> getSMSAttributesAsync(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.Future<GetSMSAttributesResult> getSMSAttributesAsync(GetSMSAttributesRequest getSMSAttributesRequest, AsyncHandler<GetSMSAttributesRequest,GetSMSAttributesResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)
Returns all of the properties of a subscription.
getSubscriptionAttributesRequest
- Input for GetSubscriptionAttributes.Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest, AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler)
Returns all of the properties of a subscription.
getSubscriptionAttributesRequest
- Input for GetSubscriptionAttributes.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(String subscriptionArn)
Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(String subscriptionArn, AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler)
Future<GetTopicAttributesResult> getTopicAttributesAsync(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.Future<GetTopicAttributesResult> getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest, AsyncHandler<GetTopicAttributesRequest,GetTopicAttributesResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetTopicAttributesResult> getTopicAttributesAsync(String topicArn)
Future<GetTopicAttributesResult> getTopicAttributesAsync(String topicArn, AsyncHandler<GetTopicAttributesRequest,GetTopicAttributesResult> asyncHandler)
Future<ListEndpointsByPlatformApplicationResult> listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)
Lists the endpoints and endpoint attributes for devices in a supported
push notification service, such as GCM 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.
listEndpointsByPlatformApplicationRequest
- Input for ListEndpointsByPlatformApplication action.Future<ListEndpointsByPlatformApplicationResult> listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest, AsyncHandler<ListEndpointsByPlatformApplicationRequest,ListEndpointsByPlatformApplicationResult> asyncHandler)
Lists the endpoints and endpoint attributes for devices in a supported
push notification service, such as GCM 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.
listEndpointsByPlatformApplicationRequest
- Input for ListEndpointsByPlatformApplication action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPhoneNumbersOptedOutResult> listPhoneNumbersOptedOutAsync(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.Future<ListPhoneNumbersOptedOutResult> listPhoneNumbersOptedOutAsync(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest, AsyncHandler<ListPhoneNumbersOptedOutRequest,ListPhoneNumbersOptedOutResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPlatformApplicationsResult> listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest)
Lists the platform application objects for the supported push
notification services, such as APNS and GCM. 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.
listPlatformApplicationsRequest
- Input for ListPlatformApplications action.Future<ListPlatformApplicationsResult> listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest, AsyncHandler<ListPlatformApplicationsRequest,ListPlatformApplicationsResult> asyncHandler)
Lists the platform application objects for the supported push
notification services, such as APNS and GCM. 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.
listPlatformApplicationsRequest
- Input for ListPlatformApplications action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPlatformApplicationsResult> listPlatformApplicationsAsync()
Future<ListPlatformApplicationsResult> listPlatformApplicationsAsync(AsyncHandler<ListPlatformApplicationsRequest,ListPlatformApplicationsResult> asyncHandler)
Future<ListSubscriptionsResult> listSubscriptionsAsync(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.
listSubscriptionsRequest
- Input for ListSubscriptions action.Future<ListSubscriptionsResult> listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest, AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler)
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.
listSubscriptionsRequest
- Input for ListSubscriptions action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListSubscriptionsResult> listSubscriptionsAsync()
Future<ListSubscriptionsResult> listSubscriptionsAsync(AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler)
Future<ListSubscriptionsResult> listSubscriptionsAsync(String nextToken)
Future<ListSubscriptionsResult> listSubscriptionsAsync(String nextToken, AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler)
Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(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.
listSubscriptionsByTopicRequest
- Input for ListSubscriptionsByTopic action.Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest, AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler)
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.
listSubscriptionsByTopicRequest
- Input for ListSubscriptionsByTopic action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(String topicArn)
Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(String topicArn, AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler)
Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(String topicArn, String nextToken)
Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(String topicArn, String nextToken, AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler)
Future<ListTopicsResult> listTopicsAsync(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.
listTopicsRequest
- Future<ListTopicsResult> listTopicsAsync(ListTopicsRequest listTopicsRequest, AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
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.
listTopicsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTopicsResult> listTopicsAsync()
listTopicsAsync(ListTopicsRequest)
Future<ListTopicsResult> listTopicsAsync(AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
Future<ListTopicsResult> listTopicsAsync(String nextToken)
listTopicsAsync(ListTopicsRequest)
Future<ListTopicsResult> listTopicsAsync(String nextToken, AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
Future<OptInPhoneNumberResult> optInPhoneNumberAsync(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.Future<OptInPhoneNumberResult> optInPhoneNumberAsync(OptInPhoneNumberRequest optInPhoneNumberRequest, AsyncHandler<OptInPhoneNumberRequest,OptInPhoneNumberResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PublishResult> publishAsync(PublishRequest publishRequest)
Sends a message to all of a topic's subscribed endpoints. When a
messageId
is returned, the message has been saved and Amazon
SNS will attempt to deliver it to the topic's subscribers shortly. The
format of the outgoing message to each subscribed endpoint depends on the
notification protocol.
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. The second example below shows a request and response for
publishing to a mobile endpoint.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
publishRequest
- Input for Publish action.Future<PublishResult> publishAsync(PublishRequest publishRequest, AsyncHandler<PublishRequest,PublishResult> asyncHandler)
Sends a message to all of a topic's subscribed endpoints. When a
messageId
is returned, the message has been saved and Amazon
SNS will attempt to deliver it to the topic's subscribers shortly. The
format of the outgoing message to each subscribed endpoint depends on the
notification protocol.
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. The second example below shows a request and response for
publishing to a mobile endpoint.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
publishRequest
- Input for Publish action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PublishResult> publishAsync(String topicArn, String message)
publishAsync(PublishRequest)
Future<PublishResult> publishAsync(String topicArn, String message, AsyncHandler<PublishRequest,PublishResult> asyncHandler)
Future<PublishResult> publishAsync(String topicArn, String message, String subject)
publishAsync(PublishRequest)
Future<PublishResult> publishAsync(String topicArn, String message, String subject, AsyncHandler<PublishRequest,PublishResult> asyncHandler)
Future<RemovePermissionResult> removePermissionAsync(RemovePermissionRequest removePermissionRequest)
Removes a statement from a topic's access control policy.
removePermissionRequest
- Input for RemovePermission action.Future<RemovePermissionResult> removePermissionAsync(RemovePermissionRequest removePermissionRequest, AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
Removes a statement from a topic's access control policy.
removePermissionRequest
- Input for RemovePermission action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RemovePermissionResult> removePermissionAsync(String topicArn, String label)
Future<RemovePermissionResult> removePermissionAsync(String topicArn, String label, AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
Future<SetEndpointAttributesResult> setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest)
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
setEndpointAttributesRequest
- Input for SetEndpointAttributes action.Future<SetEndpointAttributesResult> setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest, AsyncHandler<SetEndpointAttributesRequest,SetEndpointAttributesResult> asyncHandler)
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
setEndpointAttributesRequest
- Input for SetEndpointAttributes action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SetPlatformApplicationAttributesResult> setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)
Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. 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.Future<SetPlatformApplicationAttributesResult> setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest, AsyncHandler<SetPlatformApplicationAttributesRequest,SetPlatformApplicationAttributesResult> asyncHandler)
Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. 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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SetSMSAttributesResult> setSMSAttributesAsync(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.Future<SetSMSAttributesResult> setSMSAttributesAsync(SetSMSAttributesRequest setSMSAttributesRequest, AsyncHandler<SetSMSAttributesRequest,SetSMSAttributesResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SetSubscriptionAttributesResult> setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)
Allows a subscription owner to set an attribute of the topic to a new value.
setSubscriptionAttributesRequest
- Input for SetSubscriptionAttributes action.Future<SetSubscriptionAttributesResult> setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest, AsyncHandler<SetSubscriptionAttributesRequest,SetSubscriptionAttributesResult> asyncHandler)
Allows a subscription owner to set an attribute of the topic to a new value.
setSubscriptionAttributesRequest
- Input for SetSubscriptionAttributes action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SetSubscriptionAttributesResult> setSubscriptionAttributesAsync(String subscriptionArn, String attributeName, String attributeValue)
Future<SetSubscriptionAttributesResult> setSubscriptionAttributesAsync(String subscriptionArn, String attributeName, String attributeValue, AsyncHandler<SetSubscriptionAttributesRequest,SetSubscriptionAttributesResult> asyncHandler)
Future<SetTopicAttributesResult> setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest)
Allows a topic owner to set an attribute of the topic to a new value.
setTopicAttributesRequest
- Input for SetTopicAttributes action.Future<SetTopicAttributesResult> setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest, AsyncHandler<SetTopicAttributesRequest,SetTopicAttributesResult> asyncHandler)
Allows a topic owner to set an attribute of the topic to a new value.
setTopicAttributesRequest
- Input for SetTopicAttributes action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SetTopicAttributesResult> setTopicAttributesAsync(String topicArn, String attributeName, String attributeValue)
Future<SetTopicAttributesResult> setTopicAttributesAsync(String topicArn, String attributeName, String attributeValue, AsyncHandler<SetTopicAttributesRequest,SetTopicAttributesResult> asyncHandler)
Future<SubscribeResult> subscribeAsync(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.
subscribeRequest
- Input for Subscribe action.Future<SubscribeResult> subscribeAsync(SubscribeRequest subscribeRequest, AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)
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.
subscribeRequest
- Input for Subscribe action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SubscribeResult> subscribeAsync(String topicArn, String protocol, String endpoint)
subscribeAsync(SubscribeRequest)
Future<SubscribeResult> subscribeAsync(String topicArn, String protocol, String endpoint, AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)
Future<UnsubscribeResult> unsubscribeAsync(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.
unsubscribeRequest
- Input for Unsubscribe action.Future<UnsubscribeResult> unsubscribeAsync(UnsubscribeRequest unsubscribeRequest, AsyncHandler<UnsubscribeRequest,UnsubscribeResult> asyncHandler)
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.
unsubscribeRequest
- Input for Unsubscribe action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UnsubscribeResult> unsubscribeAsync(String subscriptionArn)
unsubscribeAsync(UnsubscribeRequest)
Future<UnsubscribeResult> unsubscribeAsync(String subscriptionArn, AsyncHandler<UnsubscribeRequest,UnsubscribeResult> asyncHandler)
Copyright © 2016. All rights reserved.