ISNSClient

Interface in AWS.SNS

Interface for SNS service client.

Methods

AddPermission

function AddPermission(const ARequest: ISNSAddPermissionRequest): ISNSAddPermissionResponse;

ISNSAddPermissionRequest → ISNSAddPermissionResponse

Adds a permission to the topic's access control policy.

Parameters

Name	Description
ARequest	A AddPermission request object.

Returns

Response containing AddPermission results.

CheckIfPhoneNumberIsOptedOut

function CheckIfPhoneNumberIsOptedOut( const ARequest: ISNSCheckIfPhoneNumberIsOptedOutRequest): ISNSCheckIfPhoneNumberIsOptedOutResponse; overload;

ISNSCheckIfPhoneNumberIsOptedOutRequest → ISNSCheckIfPhoneNumberIsOptedOutResponse

Checks if a phone number has opted out of receiving SMS messages your AWS account.

Parameters

Name	Description
ARequest	A CheckIfPhoneNumberIsOptedOut request object.

Returns

Response containing CheckIfPhoneNumberIsOptedOut results.

---

function CheckIfPhoneNumberIsOptedOut( const APhoneNumber: string): ISNSCheckIfPhoneNumberIsOptedOutResponse; overload;

ISNSCheckIfPhoneNumberIsOptedOutResponse

Checks if a phone number has opted out of receiving SMS messages your AWS account.

Parameters

Name	Description
APhoneNumber	The phone number for which you want to check the opt-out status.

Returns

Response containing CheckIfPhoneNumberIsOptedOut results.

ConfirmSubscription

function ConfirmSubscription(const ARequest: ISNSConfirmSubscriptionRequest): ISNSConfirmSubscriptionResponse; overload;

ISNSConfirmSubscriptionRequest → ISNSConfirmSubscriptionResponse

Confirm the endpoint owner's intent to receive messages.

Parameters

Name	Description
ARequest	A ConfirmSubscription request object.

Returns

Response containing ConfirmSubscription results.

---

function ConfirmSubscription(const ATopicArn: TARN; AToken: string; AAuthenticateOnUnsubscribe: string = ''): ISNSConfirmSubscriptionResponse; overload;

ISNSConfirmSubscriptionResponse

Confirm the endpoint owner's intent to receive messages.

Parameters

Name	Description
ARequest	A ConfirmSubscription request object.

Returns

Response containing ConfirmSubscription results.

CreatePlatformApplication

function CreatePlatformApplication( const ARequest: ISNSCreatePlatformApplicationRequest): ISNSCreatePlatformApplicationResponse; overload;

ISNSCreatePlatformApplicationRequest → ISNSCreatePlatformApplicationResponse

Creates a platform application for one or more push notification services.

Parameters

Name	Description
ARequest	A CreatePlatformApplication request object.

Returns

Response containing CreatePlatformApplication results.

---

function CreatePlatformApplication(const AName, APlatform, APlatformCredential: string; APlatformPrincipal: string = ''): ISNSCreatePlatformApplicationResponse; overload;

ISNSCreatePlatformApplicationResponse

Creates a platform application for one or more push notification services.

Parameters

Name	Description
AName	A name for the platform application.
APlatform	A push notification platform. One of:|||.
APlatformCredential	The credential received from the notification service.
APlatformPrincipal	The principal received from the notification service.

Returns

Response containing CreatePlatformApplication results.

CreatePlatformEndpoint

function CreatePlatformEndpoint( const ARequest: ISNSCreatePlatformEndpointRequest): ISNSCreatePlatformEndpointResponse; overload;

ISNSCreatePlatformEndpointRequest → ISNSCreatePlatformEndpointResponse

Creates an endpoint for a device and mobile app on a push notification platform.

Parameters

Name	Description
ARequest	A CreatePlatformEndpoint request object.

Returns

Response containing CreatePlatformEndpoint results.

---

function CreatePlatformEndpoint(const APlatformApplicationArn: TARN; AToken: string): ISNSCreatePlatformEndpointResponse; overload;

ISNSCreatePlatformEndpointResponse

Creates an endpoint for a device and mobile app on a push notification platform.

Parameters

Name	Description
APlatformApplicationArn	An Amazon Resource Name (ARN) for a platform application. As returned from CreatePlatformApplication.
AToken	Unique identifier created by the notification service for an app on a device.

Returns

Response containing CreatePlatformEndpoint results.

CreateSMSSandboxPhoneNumber

function CreateSMSSandboxPhoneNumber( const ARequest: ISNSCreateSMSSandboxPhoneNumberRequest): ISNSCreateSMSSandboxPhoneNumberResponse; overload;

ISNSCreateSMSSandboxPhoneNumberRequest → ISNSCreateSMSSandboxPhoneNumberResponse

Adds a destination phone number to an AWS account in the SMS sandbox and sends a one-time password (OTP) to that phone number.

Parameters

Name	Description
ARequest	A CreateSMSSandboxPhoneNumber request object.

Returns

Response containing CreateSMSSandboxPhoneNumber results.

---

function CreateSMSSandboxPhoneNumber(const APhoneNumber: string; ALanguageCode: string = ''): ISNSCreateSMSSandboxPhoneNumberResponse; overload;

ISNSCreateSMSSandboxPhoneNumberResponse

Adds a destination phone number to an AWS account in the SMS sandbox and sends a one-time password (OTP) to that phone number.

Parameters

Name	Description
APhoneNumber	The destination phone number to verify.
ALanguageCode	The language code used for sending the one-time password (OTP).

Returns

Response containing CreateSMSSandboxPhoneNumber results.

CreateTopic

function CreateTopic(const ARequest: ISNSCreateTopicRequest): ISNSCreateTopicResponse; overload;

ISNSCreateTopicRequest → ISNSCreateTopicResponse

Creates a topic to which notifications can be published.

Parameters

Name	Description
ARequest	A CreateTopic request object.

Returns

Response containing CreateTopic results.

---

function CreateTopic(const AName: string): ISNSCreateTopicResponse; overload;

ISNSCreateTopicResponse

Creates a topic to which notifications can be published.

Parameters

Name	Description
AName	A name for the topic you want to create.

Returns

Response containing CreateTopic results.

DeleteEndpoint

function DeleteEndpoint(const ARequest: ISNSDeleteEndpointRequest): ISNSDeleteEndpointResponse; overload;

ISNSDeleteEndpointRequest → ISNSDeleteEndpointResponse

Deletes an endpoint for a device and mobile app.

Parameters

Name	Description
ARequest	A DeleteEndpoint request object.

Returns

Response containing DeleteEndpoint results.

---

function DeleteEndpoint(const AEndpointArn: TARN): ISNSDeleteEndpointResponse; overload;

ISNSDeleteEndpointResponse

Deletes an endpoint for a device and mobile app.

Parameters

Name	Description
AEndpointArn	The Amazon Resource Name (ARN) of the endpoint to delete.

Returns

Response containing DeleteEndpoint results.

DeletePlatformApplication

function DeletePlatformApplication( const ARequest: ISNSDeletePlatformApplicationRequest): ISNSDeletePlatformApplicationResponse; overload;

ISNSDeletePlatformApplicationRequest → ISNSDeletePlatformApplicationResponse

Deletes a platform application.

Parameters

Name	Description
ARequest	A DeletePlatformApplication request object.

Returns

Response containing DeletePlatformApplication results.

---

function DeletePlatformApplication( const APlatformApplicationArn: TARN): ISNSDeletePlatformApplicationResponse; overload;

ISNSDeletePlatformApplicationResponse

Deletes a platform application.

Parameters

Name	Description
APlatformApplicationArn	The Amazon Resource Name (ARN) of the platform application to delete.

Returns

Response containing DeletePlatformApplication results.

DeleteSMSSandboxPhoneNumber

function DeleteSMSSandboxPhoneNumber( const ARequest: ISNSDeleteSMSSandboxPhoneNumberRequest): ISNSDeleteSMSSandboxPhoneNumberResponse; overload;

ISNSDeleteSMSSandboxPhoneNumberRequest → ISNSDeleteSMSSandboxPhoneNumberResponse

Deletes a phone number from the AWS accounts SMS sandbox.

Parameters

Name	Description
ARequest	A DeleteSMSSandboxPhoneNumber request object.

Returns

Response containing DeleteSMSSandboxPhoneNumber results.

---

function DeleteSMSSandboxPhoneNumber(const APhoneNumber: string): ISNSDeleteSMSSandboxPhoneNumberResponse; overload;

ISNSDeleteSMSSandboxPhoneNumberResponse

Deletes a phone number from the AWS accounts SMS sandbox.

Parameters

Name	Description
APhoneNumber	The destination phone number to delete.

Returns

Response containing DeleteSMSSandboxPhoneNumber results.

DeleteTopic

function DeleteTopic(const ARequest: ISNSDeleteTopicRequest): ISNSDeleteTopicResponse; overload;

ISNSDeleteTopicRequest → ISNSDeleteTopicResponse

Deletes a topic and all its subscriptions.

Parameters

Name	Description
ARequest	A DeleteTopic request object.

Returns

Response containing DeleteTopic results.

---

function DeleteTopic(const ATopicArn: TARN): ISNSDeleteTopicResponse; overload;

ISNSDeleteTopicResponse

Deletes a topic and all its subscriptions.

Parameters

Name	Description
ATopicArn	The Amazon Resource Name (ARN) of the topic to delete.

Returns

Response containing DeleteTopic results.

GetDataProtectionPolicy

function GetDataProtectionPolicy( const ARequest: ISNSGetDataProtectionPolicyRequest): ISNSGetDataProtectionPolicyResponse; overload;

ISNSGetDataProtectionPolicyRequest → ISNSGetDataProtectionPolicyResponse

Retrieves the specified inline GetDataProtectionPolicy document stored in a specific Amazon SNS topic.

Parameters

Name	Description
ARequest	A GetDataProtectionPolicy request object.

Returns

Response containing GetDataProtectionPolicy results.

---

function GetDataProtectionPolicy( const AResourceArn: TARN): ISNSGetDataProtectionPolicyResponse; overload;

ISNSGetDataProtectionPolicyResponse

Retrieves the specified inline GetDataProtectionPolicy document stored in a specific Amazon SNS topic.

Parameters

Name	Description
AResourceArn	The Amazon Resource Name (ARN) for the topic to retrieve the DataProtectionPolicy for.

Returns

Response containing GetDataProtectionPolicy results.

GetEndpointAttributes

function GetEndpointAttributes( const ARequest: ISNSGetEndpointAttributesRequest): ISNSGetEndpointAttributesResponse; overload;

ISNSGetEndpointAttributesRequest → ISNSGetEndpointAttributesResponse

Retrieves the attributes for a device endpoint.

Parameters

Name	Description
ARequest	A GetEndpointAttributes request object.

Returns

Response containing GetEndpointAttributes.

---

function GetEndpointAttributes( const AEndpointArn: TARN): ISNSGetEndpointAttributesResponse; overload;

ISNSGetEndpointAttributesResponse

Retrieves the attributes for a device endpoint.

Parameters

Name	Description
AEndpointArn	The Amazon Resource Name (ARN) of the endpoint to retrieve attributes for.

Returns

Response containing GetEndpointAttributes.

GetPlatformApplicationAttributes

function GetPlatformApplicationAttributes( const ARequest: ISNSGetPlatformApplicationAttributesRequest): ISNSGetPlatformApplicationAttributesResponse; overload;

ISNSGetPlatformApplicationAttributesRequest → ISNSGetPlatformApplicationAttributesResponse

Retrieves the attributes for a platform application.

Parameters

Name	Description
ARequest	A GetPlatformApplicationAttributes request object.

Returns

Response containing GetPlatformApplicationAttributes.

---

function GetPlatformApplicationAttributes( const APlatformApplicationArn: TARN): ISNSGetPlatformApplicationAttributesResponse; overload;

ISNSGetPlatformApplicationAttributesResponse

Retrieves the attributes for a platform application.

Parameters

Name	Description
APlatformApplicationArn	The Amazon Resource Name (ARN) for the platform application to get attributes for.

Returns

Response containing GetPlatformApplicationAttributes.

GetSMSAttributes

function GetSMSAttributes(const ARequest: ISNSGetSMSAttributesRequest): ISNSGetSMSAttributesResponse; overload;

ISNSGetSMSAttributesRequest → ISNSGetSMSAttributesResponse

Retreives the attributes for sending SMS messages from your AWS account.

Parameters

Name	Description
ARequest	A GetSMSAttributes request object.

Returns

Response containing GetSMSAttributes results.

---

function GetSMSAttributes(const AAttributes: array of string): ISNSGetSMSAttributesResponse; overload;

ISNSGetSMSAttributesResponse

Retreives the attributes for sending SMS messages from your AWS account.

Parameters

Name	Description
AAttributes	List of attribute names to be retrieved.

Returns

Response containing GetSMSAttributes results.

---

function GetSMSAttributes: ISNSGetSMSAttributesResponse; overload;

ISNSGetSMSAttributesResponse

Retreives the attributes for sending SMS messages from your AWS account.

Returns

Response containing GetSMSAttributes results.

GetSMSSandboxAccountStatus

function GetSMSSandboxAccountStatus( const ARequest: ISNSGetSMSSandboxAccountStatusRequest): ISNSGetSMSSandboxAccountStatusResponse; overload;

ISNSGetSMSSandboxAccountStatusRequest → ISNSGetSMSSandboxAccountStatusResponse

Retrieves the SMS sandbox status for the calling AWS account in the target AWS region.

Parameters

Name	Description
ARequest	A GetSMSSandboxAccountStatus request object.

Returns

Response containing GetSMSSandboxAccountStatus results.

---

function GetSMSSandboxAccountStatus: ISNSGetSMSSandboxAccountStatusResponse; overload;

ISNSGetSMSSandboxAccountStatusResponse

Retrieves the SMS sandbox status for the calling AWS account in the target AWS region.

Returns

Response containing GetSMSSandboxAccountStatus results.

GetSubscriptionAttributes

function GetSubscriptionAttributes( const ARequest: ISNSGetSubscriptionAttributesRequest): ISNSGetSubscriptionAttributesResponse; overload;

ISNSGetSubscriptionAttributesRequest → ISNSGetSubscriptionAttributesResponse

Retrieves the attributes of a subscription.

Parameters

Name	Description
ARequest	A GetSubscriptionAttributes request object.

Returns

Response containing GetSubscriptionAttributes results.

---

function GetSubscriptionAttributes( const ASubscriptionArn: TARN): ISNSGetSubscriptionAttributesResponse; overload;

ISNSGetSubscriptionAttributesResponse

Retrieves the attributes of a subscription.

Parameters

Name	Description
ASubscriptionArn	The Amazon Resource Name (ARN) for the subscription for which to retrieve attributes.

Returns

Response containing GetSubscriptionAttributes results.

GetTopicAttributes

function GetTopicAttributes( const ARequest: ISNSGetTopicAttributesRequest): ISNSGetTopicAttributesResponse; overload;

ISNSGetTopicAttributesRequest → ISNSGetTopicAttributesResponse

Retrieves the attributes of a topic.

Parameters

Name	Description
ARequest	A GetTopicAttributes request object.

Returns

Response containing GetTopicAttributes results.

---

function GetTopicAttributes( const ATopicArn: TARN): ISNSGetTopicAttributesResponse; overload;

ISNSGetTopicAttributesResponse

Retrieves the attributes of a topic.

Parameters

Name	Description
ATopicArn	The Amazon Resource Name (ARN) for the topic to retrieve attributes for.

Returns

Response containing GetTopicAttributes results.

ListEndpointsByPlatformApplication

function ListEndpointsByPlatformApplication( const ARequest: ISNSListEndpointsByPlatformApplicationRequest): ISNSListEndpointsByPlatformApplicationResponse; overload;

ISNSListEndpointsByPlatformApplicationRequest → ISNSListEndpointsByPlatformApplicationResponse

Lists the endpoints for devices of a platform application.

Parameters

Name	Description
ARequest	A ListEndpointsByPlatformApplication request object.

Returns

Response containing ListEndpointsByPlatformApplication results.

---

function ListEndpointsByPlatformApplication( const APlatformApplicationArn: TARN; ANextToken: string = ''): ISNSListEndpointsByPlatformApplicationResponse; overload;

ISNSListEndpointsByPlatformApplicationResponse

Lists the endpoints for devices of a platform application.

Parameters

Name	Description
APlatformApplicationArn	The Amazon Resource Name (ARN) of the platform application for which to list endpoints.
ANextToken	NextToken from a previous call to retrieve paginated results. Results are retrieve in pages of 100.

Returns

Response containing ListEndpointsByPlatformApplication results.

ListOriginationNumbers

function ListOriginationNumbers(const ARequest: ISNSListOriginationNumbersRequest): ISNSListOriginationNumbersResponse; overload;

ISNSListOriginationNumbersRequest → ISNSListOriginationNumbersResponse

Lists the calling AWS account's dedicated origination numbers and their metadata.

Parameters

Name	Description
ARequest	A ListOriginationNumbers request object.

Returns

Response containing ListOriginationNumbers results.

---

function ListOriginationNumbers(const AMaxResults: TOptional<Integer>; ANextToken: string = ''): ISNSListOriginationNumbersResponse; overload;

ISNSListOriginationNumbersResponse

Lists the calling AWS account's dedicated origination numbers and their metadata.

Parameters

Name	Description
AMaxResults	The maximum number of origination numbers to return. Valid values range from 1 to 30.
ANextToken	NextToken from a previous call to retrieve paginated results.

Returns

Response containing ListOriginationNumbers results.

ListPhoneNumbersOptedOut

function ListPhoneNumbersOptedOut( const ARequest: ISNSListPhoneNumbersOptedOutRequest): ISNSListPhoneNumbersOptedOutResponse; overload;

ISNSListPhoneNumbersOptedOutRequest → ISNSListPhoneNumbersOptedOutResponse

Retrieves a list of phone numbers that have opted out from receiving SMS messages from your AWS account.

Parameters

Name	Description
ARequest	A ListPhoneNumbersOptedOut request object.

Returns

Response containing ListPhoneNumbersOptedOut results.

---

function ListPhoneNumbersOptedOut( const ANextToken: string = ''): ISNSListPhoneNumbersOptedOutResponse; overload;

ISNSListPhoneNumbersOptedOutResponse

Retrieves a list of phone numbers that have opted out from receiving SMS messages from your AWS account.

Parameters

Name	Description
ANextToken	NextToken from a previous call to retrieve paginated results.

Returns

Response containing ListPhoneNumbersOptedOut results.

ListPlatformApplications

function ListPlatformApplications( const ARequest: ISNSListPlatformApplicationsRequest): ISNSListPlatformApplicationsResponse; overload;

ISNSListPlatformApplicationsRequest → ISNSListPlatformApplicationsResponse

Lists platform applications.

Parameters

Name	Description
ARequest	A ListPlatformApplications request object.

Returns

Response containing ListPlatformApplications results.

---

function ListPlatformApplications( const ANextToken: string): ISNSListPlatformApplicationsResponse; overload;

ISNSListPlatformApplicationsResponse

Lists platform applications.

Parameters

Name	Description
ANextToken	NextToken from a previous call to retrieve paginated results.

Returns

Response containing ListPlatformApplications results.

ListSMSSandboxPhoneNumbers

function ListSMSSandboxPhoneNumbers( const ARequest: ISNSListSMSSandboxPhoneNumbersRequest): ISNSListSMSSandboxPhoneNumbersResponse; overload;

ISNSListSMSSandboxPhoneNumbersRequest → ISNSListSMSSandboxPhoneNumbersResponse

Lists the calling accounts current verified and pending destination phone numbers in the SMS sandbox.

Parameters

Name	Description
ARequest	A ListSMSSandboxPhoneNumbers request object.

Returns

Response containing ListSMSSandboxPhoneNumbers results.

---

function ListSMSSandboxPhoneNumbers( const AMaxResults: TOptional<Integer>; ANextToken: string = ''): ISNSListSMSSandboxPhoneNumbersResponse; overload;

ISNSListSMSSandboxPhoneNumbersResponse

Lists the calling accounts current verified and pending destination phone numbers in the SMS sandbox.

Parameters

Name	Description
AMaxResults	The maximum number of phone numbers to return. Valid values range from 1 to 100.
ANextToken	NextToken from a previous call to retrieve paginated results.

Returns

Response containing ListSMSSandboxPhoneNumbers results.

---

function ListSMSSandboxPhoneNumbers: ISNSListSMSSandboxPhoneNumbersResponse; overload;

ISNSListSMSSandboxPhoneNumbersResponse

Lists the calling accounts current verified and pending destination phone numbers in the SMS sandbox.

Returns

Response containing ListSMSSandboxPhoneNumbers results.

ListSubscriptions

function ListSubscriptions(const ARequest: ISNSListSubscriptionsRequest): ISNSListSubscriptionsResponse; overload;

ISNSListSubscriptionsRequest → ISNSListSubscriptionsResponse

Lists subscriptions.

Parameters

Name	Description
ARequest	A ListSubscriptions request object.

Returns

Response containing ListSubscriptions results.

---

function ListSubscriptions(const ANextToken: string = ''): ISNSListSubscriptionsResponse; overload;

ISNSListSubscriptionsResponse

Lists subscriptions.

Parameters

Name	Description
ANextToken	NextToken from a previous call to retrieve paginated results.

Returns

Response containing ListSubscriptions results.

ListSubscriptionsByTopic

function ListSubscriptionsByTopic( const ARequest: ISNSListSubscriptionsByTopicRequest): ISNSListSubscriptionsByTopicResponse; overload;

ISNSListSubscriptionsByTopicRequest → ISNSListSubscriptionsByTopicResponse

Lists subscriptions for a topic.

Parameters

Name	Description
ARequest	A ListSubscriptionsByTopic request object.

Returns

Response containing ListSubscriptionsByTopic results.

---

function ListSubscriptionsByTopic(const ATopicArn: TARN; ANextToken: string = ''): ISNSListSubscriptionsByTopicResponse; overload;

ISNSListSubscriptionsByTopicResponse

Lists subscriptions for a topic.

Parameters

Name	Description
ATopicArn	The Amazon Resource Name (ARN) of the topic for which to list subscriptions.
ANextToken	NextToken from a previous call to retrieve paginated results.

Returns

Response containing ListSubscriptionsByTopic results.

ListTagsForResource

function ListTagsForResource(const ARequest: ISNSListTagsForResourceRequest): ISNSListTagsForResourceResponse; overload;

ISNSListTagsForResourceRequest → ISNSListTagsForResourceResponse

Lists tags for a topic.

Parameters

Name	Description
ARequest	A ListTagsForResource request object.

Returns

Response containing ListTagsForResource results.

---

function ListTagsForResource(const AResourceArn: TARN): ISNSListTagsForResourceResponse; overload;

ISNSListTagsForResourceResponse

Lists tags for a topic.

Parameters

Name	Description
AResourceArn	The Amazon Resource Name (ARN) for the topic to list tags for.

Returns

Response containing ListTagsForResource results.

ListTopics

function ListTopics(const ARequest: ISNSListTopicsRequest): ISNSListTopicsResponse; overload;

ISNSListTopicsRequest → ISNSListTopicsResponse

Lists topics.

Parameters

Name	Description
ARequest	A ListTopics request object.

Returns

Response containing ListTopics results.

---

function ListTopics(const ANextToken: string = ''): ISNSListTopicsResponse; overload;

ISNSListTopicsResponse

Lists topics.

Parameters

Name	Description
ANextToken	NextToken from a previous call to retrieve paginated results.

Returns

Response containing ListTopics results.

OptInPhoneNumber

function OptInPhoneNumber(const ARequest: ISNSOptInPhoneNumberRequest): ISNSOptInPhoneNumberResponse; overload;

ISNSOptInPhoneNumberRequest → ISNSOptInPhoneNumberResponse

Opts a previously opted out phone number in to receiving SMS messages.

Parameters

Name	Description
ARequest	A OptInPhoneNumber request object.

Returns

Response containing OptInPhoneNumber results.

---

function OptInPhoneNumber(const APhoneNumber: string): ISNSOptInPhoneNumberResponse; overload;

ISNSOptInPhoneNumberResponse

Opts a previously opted out phone number in to receiving SMS messages.

Parameters

Name	Description
APhoneNumber	The phone number to opt-in. Use E.164 format.

Returns

Response containing OptInPhoneNumber results.

Publish

function Publish(const ARequest: ISNSPublishRequest): ISNSPublishResponse;

ISNSPublishRequest → ISNSPublishResponse

Sends a message.

Parameters

Name	Description
ARequest	A Publish request object.

Returns

Response containing Publish results.

PublishBatch

function PublishBatch(const ARequest: ISNSPublishBatchRequest): ISNSPublishBatchResponse;

ISNSPublishBatchRequest → ISNSPublishBatchResponse

Publishes a batch of up to ten messages to a specified topic.

Parameters

Name	Description
ARequest	A PublishBatch request object.

Returns

Response containing PublishBatch results.

PutDataProtectionPolicy

function PutDataProtectionPolicy( const ARequest: ISNSPutDataProtectionPolicyRequest): ISNSPutDataProtectionPolicyResponse; overload;

ISNSPutDataProtectionPolicyRequest → ISNSPutDataProtectionPolicyResponse

Add or update an inline policy document that is stored in the specified Amazon SNS topic.

Parameters

Name	Description
ARequest	A PutDataProtectionPolicy request object.

Returns

Response containing PutDataProtectionPolicy results.

---

function PutDataProtectionPolicy( const ADataProtectionPolicy: string; const AResourceArn: TARN): ISNSPutDataProtectionPolicyResponse; overload;

ISNSPutDataProtectionPolicyResponse

Add or update an inline policy document that is stored in the specified Amazon SNS topic.

///

Parameters

Name	Description
ADataProtectionPolicy	Specify the topic's DataProtectionPolicy as JSON.
AResourceArn	Specify the Amazon Resource Name (ARN) of the topic to add or update its policy.

Returns

Response containing PutDataProtectionPolicy results.

RemovePermission

function RemovePermission(const ARequest: ISNSRemovePermissionRequest): ISNSRemovePermissionResponse; overload;

ISNSRemovePermissionRequest → ISNSRemovePermissionResponse

Removes a permission from a topics access control policy.

Parameters

Name	Description
ARequest	A RemovePermission request object.

Returns

Response containing RemovePermission results.

---

function RemovePermission(const ALabel: string; ATopicArn: TARN): ISNSRemovePermissionResponse; overload;

ISNSRemovePermissionResponse

Removes a permission from a topics access control policy.

Parameters

Name	Description
ALabel	A unique label of the statement you want to remove.
ATopicArn	The Amazon Resource Name (ARN) of the topic whose access control policy you want to modify.

Returns

Response containing RemovePermission results.

SetEndpointAttributes

function SetEndpointAttributes(const ARequest: ISNSSetEndpointAttributesRequest): ISNSSetEndpointAttributesResponse;

ISNSSetEndpointAttributesRequest → ISNSSetEndpointAttributesResponse

Sets attributes on a device endpoint.

Parameters

Name	Description
ARequest	A SetEndpointAttributes request object.

Returns

Response containing SetEndpointAttributes results.

SetPlatformApplicationAttributes

function SetPlatformApplicationAttributes(const ARequest: ISNSSetPlatformApplicationAttributesRequest): ISNSSetPlatformApplicationAttributesResponse;

ISNSSetPlatformApplicationAttributesRequest → ISNSSetPlatformApplicationAttributesResponse

Sets attributes on a platform application.

Parameters

Name	Description
ARequest	A SetPlatformApplicationAttributes request object.

Returns

Response containing SetPlatformApplicationAttributes results.

SetSMSAttributes

function SetSMSAttributes(const ARequest: ISNSSetSMSAttributesRequest): ISNSSetSMSAttributesResponse;

ISNSSetSMSAttributesRequest → ISNSSetSMSAttributesResponse

Sets attributes for sending SMS messages and receiving daily SMS usages reports.

Parameters

Name	Description
ARequest	A SetSMSAttributes request object.

Returns

Response containing SetSMSAttributes results.

SetSubscriptionAttributes

function SetSubscriptionAttributes(const ARequest: ISNSSetSubscriptionAttributesRequest): ISNSSetSubscriptionAttributesResponse; overload;

ISNSSetSubscriptionAttributesRequest → ISNSSetSubscriptionAttributesResponse

Sets attributes of a subscription.

Parameters

Name	Description
ARequest	A SetSubscriptionAttributes request object.

Returns

Response containing SetSubscriptionAttributes results.

---

function SetSubscriptionAttributes(const AAttributeName, AAttributeValue: string; ASubscriptionArn: TARN): ISNSSetSubscriptionAttributesResponse; overload;

ISNSSetSubscriptionAttributesResponse

Sets attributes of a subscription.

Parameters

Name	Description
AAttributeName	The attribute name to set. One of:||||.
AAttributeValue	The new value for the attribute.
ASubscriptionArn	The Amazon Resource Name (ARN) of the subscription for which to set attributes.

Returns

Response containing SetSubscriptionAttributes results.

SetTopicAttributes

function SetTopicAttributes(const ARequest: ISNSSetTopicAttributesRequest): ISNSSetTopicAttributesResponse; overload;

ISNSSetTopicAttributesRequest → ISNSSetTopicAttributesResponse

Sets attributes for a topic.

Parameters

Name	Description
ARequest	A SetTopicAttributes request object.

Returns

Response containing SetTopicAttributes results.

---

function SetTopicAttributes(const AAttributeName, AAttributeValue: string; ATopicArn: TARN): ISNSSetTopicAttributesResponse; overload;

ISNSSetTopicAttributesResponse

Sets attributes for a topic.

Parameters

Name	Description
AAttributeName	The attribute name to set. One of:||||.
AAttributeValue	The new value for the attribute.
ATopicArn	The Amazon Resource Name (ARN) of the topic for which to set attributes on.

Returns

Response containing SetTopicAttributes results.

Subscribe

function Subscribe(const ARequest: ISNSSubscribeRequest): ISNSSubscribeResponse; overload;

ISNSSubscribeRequest → ISNSSubscribeResponse

Subscribes an endpoint to a topic.

Parameters

Name	Description
ARequest	A Subscribe request object.

Returns

Response containing Subscribe results.

---

function Subscribe(const ATopicArn: TARN; AProtocol: string; AEndpoint: string = ''): ISNSSubscribeResponse; overload;

ISNSSubscribeResponse

Subscribes an endpoint to a topic.

Parameters

Name	Description
ATopicArn	The endpoint to receive notifications.
AProtocol	The protocol to use. One of:||||||||.
AEndpoint	The Amazon Resource Name (ARN) of the topic to subscribe to.

Returns

Response containing Subscribe results.

TagResource

function TagResource(const ARequest: ISNSTagResourceRequest): ISNSTagResourceResponse;

ISNSTagResourceRequest → ISNSTagResourceResponse

Tags a resource.

Parameters

Name	Description
ARequest	A TagResource request object.

Returns

Response containing TagResource results.

Unsubscribe

function Unsubscribe(const ARequest: ISNSUnsubscribeRequest): ISNSUnsubscribeResponse; overload;

ISNSUnsubscribeRequest → ISNSUnsubscribeResponse

Deletes a subscription.

Parameters

Name	Description
ARequest	An Unsubscribe request object.

Returns

Response containing Unsubscribe results.

---

function Unsubscribe(const ASubscriptionArn: TARN): ISNSUnsubscribeResponse; overload;

ISNSUnsubscribeResponse

Deletes a subscription.

Parameters

Name	Description
ASubscriptionArn	The Amazon Resource Name (ARN) for the subscription to unsubscribe from.

Returns

Response containing Unsubscribe results.

UntagResource

function UntagResource(const ARequest: ISNSUntagResourceRequest): ISNSUntagResourceResponse; overload;

ISNSUntagResourceRequest → ISNSUntagResourceResponse

Remove tags from a topic.

Parameters

Name	Description
ARequest	A UntagResource request object.

Returns

Response containing UntagResource results.

---

function UntagResource(const AResourceArn: TARN; ATagKeys: array of string): ISNSUntagResourceResponse; overload;

ISNSUntagResourceResponse

Remove tags from a topic.

Parameters

Name	Description
AResourceArn	The Amazon Resource Name (ARN) of the topic to remove tags from.
ATagKeys	List of tag keys to remove.

Returns

Response containing UntagResource results.

VerifySMSSandboxPhoneNumber

function VerifySMSSandboxPhoneNumber(const ARequest: ISNSVerifySMSSandboxPhoneNumberRequest): ISNSVerifySMSSandboxPhoneNumberResponse; overload;

ISNSVerifySMSSandboxPhoneNumberRequest → ISNSVerifySMSSandboxPhoneNumberResponse

Verifies a destination phone number with a one-time password (OTP) for the calling AWS account.

Parameters

Name	Description
ARequest	A VerifySMSSandboxPhoneNumber request object.

Returns

Response containing VerifySMSSandboxPhoneNumber results.

---

function VerifySMSSandboxPhoneNumber(const AOneTimePassword, APhoneNumber: string): ISNSVerifySMSSandboxPhoneNumberResponse; overload;

ISNSVerifySMSSandboxPhoneNumberResponse

Verifies a destination phone number with a one-time password (OTP) for the calling AWS account.

Parameters

Name	Description
AOneTimePassword	The OTP sent to the destination number from the CreateSMSSandBoxPhoneNumber call.
APhoneNumber	The destination phone number to verify.

Returns

Response containing VerifySMSSandboxPhoneNumber results.