@RequiresEnterpriseLicense(allowEval=true) @Connector(name="sns", schemaVersion="1.0", friendlyName="Amazon SNS", minMuleVersion="3.5") public class AmazonSNSConnector extends Object
Constructor and Description |
---|
AmazonSNSConnector() |
Modifier and Type | Method and Description |
---|---|
void |
addPermission(AddPermission addPermission)
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
|
String |
confirmSubscription(ConfirmSubscription confirmSubscription)
The ConfirmSubscription action verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action.
|
String |
createPlatformApplication(CreatePlatformApplication createPlatformApplication)
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.
|
String |
createPlatformEndpoint(CreatePlatformEndpoint createPlatformEndpoint)
Creates an endpoint for a device and mobile app on one of the supported push notification services.
|
String |
createTopic(String topicName)
The CreateTopic action creates a topic to which notifications can be published.
|
void |
deleteEndpoint(String endpointArn)
Deletes the endpoint for a device and mobile app from Amazon SNS.
|
void |
deletePlatformApplication(String platformApplicationArn)
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM.
|
void |
deleteTopic(String topicArn)
The DeleteTopic action deletes a topic and all its subscriptions.
|
com.amazonaws.services.sns.AmazonSNS |
getClient() |
SNSCommonConfig |
getConfig() |
Map<String,String> |
getEndpointAttributes(String endpointArn)
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS.
|
Map<String,String> |
getPlatformApplicationAttributes(String platformApplicationArn)
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
|
Map<String,String> |
getSubscriptionAttributes(String subscriptionArn)
The GetSubscriptionAttributes action returns all of the properties of a subscription.
|
Map<String,String> |
getTopicAttributes(String topicArn)
The GetTopicAttributes action returns all of the properties of a topic.
|
ListEndpointsByPlatform |
listEndpointsByPlatformApplication(EndpointsByPlatform endpointsByPlatform)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS.
|
ListPlatformApplications |
listPlatformApplications(String nextToken)
Lists the platform application objects for the supported push notification services, such as APNS and GCM.
|
ListSubscriptions |
listSubscriptions(String nextToken)
The ListSubscriptions action returns a list of the requester's subscriptions.
|
ListSubscriptionsByTopic |
listSubscriptionsByTopic(SubscriptionsByTopic subscriptionsByTopic)
The SubscriptionsByTopic action returns a list of the subscriptions to a specific topic.
|
ListTopics |
listTopics(String nextTopic)
The ListTopics action returns a list of the requester's topics.
|
String |
publish(Publish publish)
The Publish action sends a message to all of a topic's subscribed endpoints.
|
void |
removePermission(RemovePermission removePermission)
The RemovePermission action removes a statement from a topic's access control policy.
|
void |
setClient(com.amazonaws.services.sns.AmazonSNS client) |
void |
setConfig(SNSCommonConfig config) |
void |
setEndpointAttributes(Endpoint endpointAttributes)
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS.
|
void |
setPlatformApplicationAttributes(PlatformApplication platformApplicationAttributes)
Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
|
void |
setSubscriptionAttributes(SubscriptionAttributes subscriptionAttributes)
The SubscriptionAttributes action allows a subscription owner to set an attribute of the topic to a new value.
|
void |
setTopicAttributes(TopicAttributes topicAttributes)
The TopicAttributes action allows a topic owner to set an attribute of the topic to a new value.
|
String |
subscribe(Subscribe subscribe)
The Subscribe action prepares to subscribe an endpoint by sending the endpoint a confirmation message.
|
void |
unsubscribe(String subscriptionArn)
The Unsubscribe action deletes a subscription.
|
@Processor public void addPermission(@Default(value="#[payload]") @RefOnly AddPermission addPermission)
addPermission
- Container for the parameters to the AddPermission operation.@Processor public String confirmSubscription(@Default(value="#[payload]") ConfirmSubscription confirmSubscription) throws SNSException
confirmSubscription
- Container for the parameters to the ConfirmSubscription operation.SNSException
- Indicates an internal connector error.@Processor public String createPlatformApplication(@Default(value="#[payload]") CreatePlatformApplication createPlatformApplication)
createPlatformApplication
- Container for the parameters to the CreatePlatformApplication operation.@Processor public String createPlatformEndpoint(@Default(value="#[payload]") CreatePlatformEndpoint createPlatformEndpoint)
createPlatformEndpoint
- Container for the parameters to the CreatePlatformEndpoint operation.@Processor public String createTopic(String topicName)
topicName
- The name of the topic you want to create.@Processor public void deleteEndpoint(String endpointArn)
endpointArn
- EndpointArn of endpoint to delete.@Processor public void deletePlatformApplication(String platformApplicationArn)
platformApplicationArn
- PlatformApplicationArn of platform application object to delete.@Processor public void deleteTopic(String topicArn)
topicArn
- The ARN of the topic you want to delete.@Processor public Map<String,String> getEndpointAttributes(String endpointArn)
endpointArn
- EndpointArn for GetEndpointAttributes input.@Processor public Map<String,String> getPlatformApplicationAttributes(String platformApplicationArn)
platformApplicationArn
- PlatformApplicationArn for GetPlatformApplicationAttributesInput.@Processor public Map<String,String> getSubscriptionAttributes(String subscriptionArn)
subscriptionArn
- The ARN of the subscription whose properties you want to get@Processor public Map<String,String> getTopicAttributes(String topicArn)
topicArn
- The ARN of the topic whose properties you want to get.@Processor public ListEndpointsByPlatform listEndpointsByPlatformApplication(@Default(value="#[payload]") EndpointsByPlatform endpointsByPlatform)
endpointsByPlatform
- Container for the parameters to the ListEndpointsByPlatformApplication operation.@Processor public ListPlatformApplications listPlatformApplications(@Optional String nextToken)
nextToken
- NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.@Processor public ListSubscriptions listSubscriptions(@Optional String nextToken) throws SNSException
nextToken
- Token returned by the previous ListSubscriptions requestSNSException
- Indicates an internal connector error.@Processor public ListSubscriptionsByTopic listSubscriptionsByTopic(@Default(value="#[payload]") SubscriptionsByTopic subscriptionsByTopic)
subscriptionsByTopic
- Container for the parameters to the ListSubscriptionsByTopic operation.@Processor public ListTopics listTopics(@Optional String nextTopic)
nextTopic
- Token returned by the previous ListTopics request.@Processor public String publish(@Default(value="#[payload]") Publish publish)
publish
- Container for the parameters to the publish operation.@Processor public void removePermission(@Default(value="#[payload]") RemovePermission removePermission)
removePermission
- Container for the parameters to the RemovePermission operation.@Processor public void setEndpointAttributes(@Default(value="#[payload]") Endpoint endpointAttributes)
endpointAttributes
- Container for the parameters to the SetEndpointAttributes operation.@Processor public void setPlatformApplicationAttributes(@Default(value="#[payload]") PlatformApplication platformApplicationAttributes)
platformApplicationAttributes
- Container for the parameters to the SetPlatformApplicationAttributes operation.@Processor public void setSubscriptionAttributes(@Default(value="#[payload]") SubscriptionAttributes subscriptionAttributes) throws SNSException
subscriptionAttributes
- Container for the parameters to the SetSubscriptionAttributes operation.SNSException
- Indicates an internal connector error.@Processor public void setTopicAttributes(@Default(value="#[payload]") TopicAttributes topicAttributes)
topicAttributes
- Container for the parameters to the SetTopicAttributes operation.@Processor public String subscribe(@Default(value="#[payload]") Subscribe subscribe)
subscribe
- Container for the parameters to the Subscribe operation.@Processor public void unsubscribe(String subscriptionArn)
subscriptionArn
- The ARN of the subscription to be deleted.@NotNull public com.amazonaws.services.sns.AmazonSNS getClient()
public void setClient(@NotNull com.amazonaws.services.sns.AmazonSNS client)
@NotNull public SNSCommonConfig getConfig()
public void setConfig(@NotNull SNSCommonConfig config)
Copyright © 2010–2020. All rights reserved.