sns/aws.sdk.kotlin.services.sns

Package-level declarations

Types

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 the Amazon SNS product page. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

addPermission

inline suspend fun SnsClient.addPermission(crossinline block: AddPermissionRequest.Builder.() -> Unit): AddPermissionResponse

Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.

checkIfPhoneNumberIsOptedOut

inline suspend fun SnsClient.checkIfPhoneNumberIsOptedOut(crossinline block: CheckIfPhoneNumberIsOptedOutRequest.Builder.() -> Unit): CheckIfPhoneNumberIsOptedOutResponse

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that is opted out.

confirmSubscription

inline suspend fun SnsClient.confirmSubscription(crossinline block: ConfirmSubscriptionRequest.Builder.() -> Unit): ConfirmSubscriptionResponse

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".

createPlatformApplication

inline suspend fun SnsClient.createPlatformApplication(crossinline block: CreatePlatformApplicationRequest.Builder.() -> Unit): CreatePlatformApplicationResponse

Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.

createPlatformEndpoint

inline suspend fun SnsClient.createPlatformEndpoint(crossinline block: CreatePlatformEndpointRequest.Builder.() -> Unit): CreatePlatformEndpointResponse

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. You can use the returned EndpointArn 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.

createSmsSandboxPhoneNumber

inline suspend fun SnsClient.createSmsSandboxPhoneNumber(crossinline block: CreateSmsSandboxPhoneNumberRequest.Builder.() -> Unit): CreateSmsSandboxPhoneNumberResponse

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

createTopic

inline suspend fun SnsClient.createTopic(crossinline block: CreateTopicRequest.Builder.() -> Unit): CreateTopicResponse

Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide. 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.

deleteEndpoint

inline suspend fun SnsClient.deleteEndpoint(crossinline block: DeleteEndpointRequest.Builder.() -> Unit): DeleteEndpointResponse

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.

deletePlatformApplication

inline suspend fun SnsClient.deletePlatformApplication(crossinline block: DeletePlatformApplicationRequest.Builder.() -> Unit): DeletePlatformApplicationResponse

Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.

deleteSmsSandboxPhoneNumber

inline suspend fun SnsClient.deleteSmsSandboxPhoneNumber(crossinline block: DeleteSmsSandboxPhoneNumberRequest.Builder.() -> Unit): DeleteSmsSandboxPhoneNumberResponse

Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.

deleteTopic

inline suspend fun SnsClient.deleteTopic(crossinline block: DeleteTopicRequest.Builder.() -> Unit): DeleteTopicResponse

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.

getDataProtectionPolicy

inline suspend fun SnsClient.getDataProtectionPolicy(crossinline block: GetDataProtectionPolicyRequest.Builder.() -> Unit): GetDataProtectionPolicyResponse

Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic.

getEndpointAttributes

inline suspend fun SnsClient.getEndpointAttributes(crossinline block: GetEndpointAttributesRequest.Builder.() -> Unit): GetEndpointAttributesResponse

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

getPlatformApplicationAttributes

inline suspend fun SnsClient.getPlatformApplicationAttributes(crossinline block: GetPlatformApplicationAttributesRequest.Builder.() -> Unit): GetPlatformApplicationAttributesResponse

Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.

getSmsAttributes

inline suspend fun SnsClient.getSmsAttributes(crossinline block: GetSmsAttributesRequest.Builder.() -> Unit): GetSmsAttributesResponse

Returns the settings for sending SMS messages from your Amazon Web Services account.

getSmsSandboxAccountStatus

inline suspend fun SnsClient.getSmsSandboxAccountStatus(crossinline block: GetSmsSandboxAccountStatusRequest.Builder.() -> Unit): GetSmsSandboxAccountStatusResponse

Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.

getSubscriptionAttributes

inline suspend fun SnsClient.getSubscriptionAttributes(crossinline block: GetSubscriptionAttributesRequest.Builder.() -> Unit): GetSubscriptionAttributesResponse

Returns all of the properties of a subscription.

getTopicAttributes

inline suspend fun SnsClient.getTopicAttributes(crossinline block: GetTopicAttributesRequest.Builder.() -> Unit): GetTopicAttributesResponse

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

listEndpointsByPlatformApplication

inline suspend fun SnsClient.listEndpointsByPlatformApplication(crossinline block: ListEndpointsByPlatformApplicationRequest.Builder.() -> Unit): ListEndpointsByPlatformApplicationResponse

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) 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.

listOriginationNumbers

inline suspend fun SnsClient.listOriginationNumbers(crossinline block: ListOriginationNumbersRequest.Builder.() -> Unit): ListOriginationNumbersResponse

Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide.

listPhoneNumbersOptedOut

inline suspend fun SnsClient.listPhoneNumbersOptedOut(crossinline block: ListPhoneNumbersOptedOutRequest.Builder.() -> Unit): ListPhoneNumbersOptedOutResponse

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

listPlatformApplications

inline suspend fun SnsClient.listPlatformApplications(crossinline block: ListPlatformApplicationsRequest.Builder.() -> Unit): ListPlatformApplicationsResponse

Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). 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.

listSmsSandboxPhoneNumbers

inline suspend fun SnsClient.listSmsSandboxPhoneNumbers(crossinline block: ListSmsSandboxPhoneNumbersRequest.Builder.() -> Unit): ListSmsSandboxPhoneNumbersResponse

Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox.

listSubscriptions

inline suspend fun SnsClient.listSubscriptions(crossinline block: ListSubscriptionsRequest.Builder.() -> Unit): ListSubscriptionsResponse

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.

listSubscriptionsByTopic

inline suspend fun SnsClient.listSubscriptionsByTopic(crossinline block: ListSubscriptionsByTopicRequest.Builder.() -> Unit): ListSubscriptionsByTopicResponse

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.

listTagsForResource

inline suspend fun SnsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.

listTopics

inline suspend fun SnsClient.listTopics(crossinline block: ListTopicsRequest.Builder.() -> Unit): ListTopicsResponse

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.

optInPhoneNumber

inline suspend fun SnsClient.optInPhoneNumber(crossinline block: OptInPhoneNumberRequest.Builder.() -> Unit): OptInPhoneNumberResponse

Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.

publish

inline suspend fun SnsClient.publish(crossinline block: PublishRequest.Builder.() -> Unit): PublishResponse

Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).

publishBatch

inline suspend fun SnsClient.publishBatch(crossinline block: PublishBatchRequest.Builder.() -> Unit): PublishBatchResponse

Publishes up to ten messages to the specified topic. This is a batch version of Publish. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes.

putDataProtectionPolicy

inline suspend fun SnsClient.putDataProtectionPolicy(crossinline block: PutDataProtectionPolicyRequest.Builder.() -> Unit): PutDataProtectionPolicyResponse

Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.

removePermission

inline suspend fun SnsClient.removePermission(crossinline block: RemovePermissionRequest.Builder.() -> Unit): RemovePermissionResponse

Removes a statement from a topic's access control policy.

setEndpointAttributes

inline suspend fun SnsClient.setEndpointAttributes(crossinline block: SetEndpointAttributesRequest.Builder.() -> Unit): SetEndpointAttributesResponse

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

setPlatformApplicationAttributes

inline suspend fun SnsClient.setPlatformApplicationAttributes(crossinline block: SetPlatformApplicationAttributesRequest.Builder.() -> Unit): SetPlatformApplicationAttributesResponse

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). 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.

setSmsAttributes

inline suspend fun SnsClient.setSmsAttributes(crossinline block: SetSmsAttributesRequest.Builder.() -> Unit): SetSmsAttributesResponse

Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.

setSubscriptionAttributes

inline suspend fun SnsClient.setSubscriptionAttributes(crossinline block: SetSubscriptionAttributesRequest.Builder.() -> Unit): SetSubscriptionAttributesResponse

Allows a subscription owner to set an attribute of the subscription to a new value.

setTopicAttributes

inline suspend fun SnsClient.setTopicAttributes(crossinline block: SetTopicAttributesRequest.Builder.() -> Unit): SetTopicAttributesResponse

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

inline suspend fun SnsClient.subscribe(crossinline block: SubscribeRequest.Builder.() -> Unit): SubscribeResponse

Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must run the ConfirmSubscription action to confirm the subscription.

tagResource

inline suspend fun SnsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

unsubscribe

inline suspend fun SnsClient.unsubscribe(crossinline block: UnsubscribeRequest.Builder.() -> Unit): UnsubscribeResponse

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 Amazon Web Services 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.

untagResource

inline suspend fun SnsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

verifySmsSandboxPhoneNumber

inline suspend fun SnsClient.verifySmsSandboxPhoneNumber(crossinline block: VerifySmsSandboxPhoneNumberRequest.Builder.() -> Unit): VerifySmsSandboxPhoneNumberResponse

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

withConfig

fun SnsClient.withConfig(block: SnsClient.Config.Builder.() -> Unit): SnsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.