SnsClient Class

Member Function Documentation

SnsClient::SnsClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a SnsClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

SnsClient::SnsClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads SnsClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AddPermissionResponse *SnsClient::addPermission(const AddPermissionRequest &request)

Sends request to the SnsClient service, and returns a pointer to an AddPermissionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified

[slot] CheckIfPhoneNumberIsOptedOutResponse *SnsClient::checkIfPhoneNumberIsOptedOut(const CheckIfPhoneNumberIsOptedOutRequest &request)

Sends request to the SnsClient service, and returns a pointer to an CheckIfPhoneNumberIsOptedOutResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>OptInPhoneNumber</code>

[slot] ConfirmSubscriptionResponse *SnsClient::confirmSubscription(const ConfirmSubscriptionRequest &request)

Sends request to the SnsClient service, and returns a pointer to an ConfirmSubscriptionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier <code>Subscribe</code> 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 <code>AuthenticateOnUnsubscribe</code> flag is set to

[slot] CreatePlatformApplicationResponse *SnsClient::createPlatformApplication(const CreatePlatformApplicationRequest &request)

Sends request to the SnsClient service, and returns a pointer to an CreatePlatformApplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>CreatePlatformApplication</code> 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 <code>CreatePlatformApplication</code> is then used as an attribute for the <code>CreatePlatformEndpoint</code> action. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see <a href="http://docs.aws.amazon.com/sns/latest/dg/mobile-push-apns.html">Getting Started with Apple Push Notification Service</a>, <a href="http://docs.aws.amazon.com/sns/latest/dg/mobile-push-adm.html">Getting Started with Amazon Device Messaging</a>, <a href="http://docs.aws.amazon.com/sns/latest/dg/mobile-push-baidu.html">Getting Started with Baidu Cloud Push</a>, <a href="http://docs.aws.amazon.com/sns/latest/dg/mobile-push-gcm.html">Getting Started with Google Cloud Messaging for Android</a>, <a href="http://docs.aws.amazon.com/sns/latest/dg/mobile-push-mpns.html">Getting Started with MPNS</a>, or <a href="http://docs.aws.amazon.com/sns/latest/dg/mobile-push-wns.html">Getting Started with WNS</a>.

[slot] CreatePlatformEndpointResponse *SnsClient::createPlatformEndpoint(const CreatePlatformEndpointRequest &request)

Sends request to the SnsClient service, and returns a pointer to an CreatePlatformEndpointResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. <code>CreatePlatformEndpoint</code> requires the PlatformApplicationArn that is returned from <code>CreatePlatformApplication</code>. The EndpointArn that is returned when using <code>CreatePlatformEndpoint</code> can then be used by the <code>Publish</code> action to send a message to a mobile app or by the <code>Subscribe</code> action for subscription to a topic. The <code>CreatePlatformEndpoint</code> 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 <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>.

</p

When using <code>CreatePlatformEndpoint</code> with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html">Creating an Amazon SNS Endpoint for Baidu</a>.

[slot] CreateTopicResponse *SnsClient::createTopic(const CreateTopicRequest &request)

Sends request to the SnsClient service, and returns a pointer to an CreateTopicResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see <a href="http://aws.amazon.com/sns/">http://aws.amazon.com/sns</a>. 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

[slot] DeleteEndpointResponse *SnsClient::deleteEndpoint(const DeleteEndpointRequest &request)

Sends request to the SnsClient service, and returns a pointer to an DeleteEndpointResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>.

</p

When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the

[slot] DeletePlatformApplicationResponse *SnsClient::deletePlatformApplication(const DeletePlatformApplicationRequest &request)

Sends request to the SnsClient service, and returns a pointer to an DeletePlatformApplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>.

[slot] DeleteTopicResponse *SnsClient::deleteTopic(const DeleteTopicRequest &request)

Sends request to the SnsClient service, and returns a pointer to an DeleteTopicResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] GetEndpointAttributesResponse *SnsClient::getEndpointAttributes(const GetEndpointAttributesRequest &request)

Sends request to the SnsClient service, and returns a pointer to an GetEndpointAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>.

[slot] GetPlatformApplicationAttributesResponse *SnsClient::getPlatformApplicationAttributes(const GetPlatformApplicationAttributesRequest &request)

Sends request to the SnsClient service, and returns a pointer to an GetPlatformApplicationAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>.

[slot] GetSMSAttributesResponse *SnsClient::getSMSAttributes(const GetSMSAttributesRequest &request)

Sends request to the SnsClient service, and returns a pointer to an GetSMSAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the settings for sending SMS messages from your

account>

These settings are set with the <code>SetSMSAttributes</code>

[slot] GetSubscriptionAttributesResponse *SnsClient::getSubscriptionAttributes(const GetSubscriptionAttributesRequest &request)

Sends request to the SnsClient service, and returns a pointer to an GetSubscriptionAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns all of the properties of a

[slot] GetTopicAttributesResponse *SnsClient::getTopicAttributes(const GetTopicAttributesRequest &request)

Sends request to the SnsClient service, and returns a pointer to an GetTopicAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the

[slot] ListEndpointsByPlatformApplicationResponse *SnsClient::listEndpointsByPlatformApplication(const ListEndpointsByPlatformApplicationRequest &request)

Sends request to the SnsClient service, and returns a pointer to an ListEndpointsByPlatformApplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for <code>ListEndpointsByPlatformApplication</code> 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 <code>ListEndpointsByPlatformApplication</code> 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 <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>.

[slot] ListPhoneNumbersOptedOutResponse *SnsClient::listPhoneNumbersOptedOut(const ListPhoneNumbersOptedOutRequest &request)

Sends request to the SnsClient service, and returns a pointer to an ListPhoneNumbersOptedOutResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to

them>

The results for <code>ListPhoneNumbersOptedOut</code> 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 <code>NextToken</code> string will be returned. To receive the next page, you call <code>ListPhoneNumbersOptedOut</code> again using the <code>NextToken</code> string received from the previous call. When there are no more records to return, <code>NextToken</code> will be

[slot] ListPlatformApplicationsResponse *SnsClient::listPlatformApplications(const ListPlatformApplicationsRequest &request)

Sends request to the SnsClient service, and returns a pointer to an ListPlatformApplicationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for <code>ListPlatformApplications</code> are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListPlatformApplications</code> using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>.

[slot] ListSubscriptionsResponse *SnsClient::listSubscriptions(const ListSubscriptionsRequest &request)

Sends request to the SnsClient service, and returns a pointer to an ListSubscriptionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptions</code> call to get further

[slot] ListSubscriptionsByTopicResponse *SnsClient::listSubscriptionsByTopic(const ListSubscriptionsByTopicRequest &request)

Sends request to the SnsClient service, and returns a pointer to an ListSubscriptionsByTopicResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptionsByTopic</code> call to get further

[slot] ListTopicsResponse *SnsClient::listTopics(const ListTopicsRequest &request)

Sends request to the SnsClient service, and returns a pointer to an ListTopicsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListTopics</code> call to get further

[slot] OptInPhoneNumberResponse *SnsClient::optInPhoneNumber(const OptInPhoneNumberRequest &request)

Sends request to the SnsClient service, and returns a pointer to an OptInPhoneNumberResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] PublishResponse *SnsClient::publish(const PublishRequest &request)

Sends request to the SnsClient service, and returns a pointer to an PublishResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sends a message to all of a topic's subscribed endpoints. When a <code>messageId</code> 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 <code>Publish</code> 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 <code>CreatePlatformEndpoint</code> action.

</p

For more information about formatting messages, see <a href="http://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html">Send Custom Platform-Specific Payloads in Messages to Mobile Devices</a>.

[slot] RemovePermissionResponse *SnsClient::removePermission(const RemovePermissionRequest &request)

Sends request to the SnsClient service, and returns a pointer to an RemovePermissionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes a statement from a topic's access control

[slot] SetEndpointAttributesResponse *SnsClient::setEndpointAttributes(const SetEndpointAttributesRequest &request)

Sends request to the SnsClient service, and returns a pointer to an SetEndpointAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>.

[slot] SetPlatformApplicationAttributesResponse *SnsClient::setPlatformApplicationAttributes(const SetPlatformApplicationAttributesRequest &request)

Sends request to the SnsClient service, and returns a pointer to an SetPlatformApplicationAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. For information on configuring attributes for message delivery status, see <a href="http://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html">Using Amazon SNS Application Attributes for Message Delivery Status</a>.

[slot] SetSMSAttributesResponse *SnsClient::setSMSAttributes(const SetSMSAttributesRequest &request)

Sends request to the SnsClient service, and returns a pointer to an SetSMSAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>Publish</code> action with the <code>MessageAttributes.entry.N</code> parameter. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html">Sending an SMS Message</a> in the <i>Amazon SNS Developer

[slot] SetSubscriptionAttributesResponse *SnsClient::setSubscriptionAttributes(const SetSubscriptionAttributesRequest &request)

Sends request to the SnsClient service, and returns a pointer to an SetSubscriptionAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Allows a subscription owner to set an attribute of the topic to a new

[slot] SetTopicAttributesResponse *SnsClient::setTopicAttributes(const SetTopicAttributesRequest &request)

Sends request to the SnsClient service, and returns a pointer to an SetTopicAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Allows a topic owner to set an attribute of the topic to a new

[slot] SubscribeResponse *SnsClient::subscribe(const SubscribeRequest &request)

Sends request to the SnsClient service, and returns a pointer to an SubscribeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the <code>ConfirmSubscription</code> action with the token from the confirmation message. Confirmation tokens are valid for three

[slot] UnsubscribeResponse *SnsClient::unsubscribe(const UnsubscribeRequest &request)

Sends request to the SnsClient service, and returns a pointer to an UnsubscribeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>Unsubscribe</code> 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 <code>Unsubscribe</code> request was