@aws-sdk/client-sns 3.295.0 → 3.297.0

package/dist-types/SNS.d.ts

@@ -43,6 +43,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
 import { VerifySMSSandboxPhoneNumberCommandInput, VerifySMSSandboxPhoneNumberCommandOutput } from "./commands/VerifySMSSandboxPhoneNumberCommand";
 import { SNSClient } from "./SNSClient";
 /**
+ * @public
  * <fullname>Amazon Simple Notification Service</fullname>
  *          <p>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
@@ -59,6 +60,7 @@ import { SNSClient } from "./SNSClient";
  */
 export declare class SNS extends SNSClient {
     /**
+     * @public
      * <p>Adds a statement to a topic's access control policy, granting access for the specified
      *             Amazon Web Services accounts to the specified actions.</p>
      *          <note>
@@ -71,6 +73,7 @@ export declare class SNS extends SNSClient {
     addPermission(args: AddPermissionCommandInput, cb: (err: any, data?: AddPermissionCommandOutput) => void): void;
     addPermission(args: AddPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddPermissionCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.</p>
@@ -81,6 +84,7 @@ export declare class SNS extends SNSClient {
     checkIfPhoneNumberIsOptedOut(args: CheckIfPhoneNumberIsOptedOutCommandInput, cb: (err: any, data?: CheckIfPhoneNumberIsOptedOutCommandOutput) => void): void;
     checkIfPhoneNumberIsOptedOut(args: CheckIfPhoneNumberIsOptedOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CheckIfPhoneNumberIsOptedOutCommandOutput) => void): void;
     /**
+     * @public
      * <p>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
@@ -91,6 +95,7 @@ export declare class SNS extends SNSClient {
     confirmSubscription(args: ConfirmSubscriptionCommandInput, cb: (err: any, data?: ConfirmSubscriptionCommandOutput) => void): void;
     confirmSubscription(args: ConfirmSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmSubscriptionCommandOutput) => void): void;
     /**
+     * @public
      * <p>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 <code>PlatformPrincipal</code> and
@@ -141,6 +146,7 @@ export declare class SNS extends SNSClient {
     createPlatformApplication(args: CreatePlatformApplicationCommandInput, cb: (err: any, data?: CreatePlatformApplicationCommandOutput) => void): void;
     createPlatformApplication(args: CreatePlatformApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlatformApplicationCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.
      *                 <code>CreatePlatformEndpoint</code> requires the <code>PlatformApplicationArn</code>
@@ -160,6 +166,7 @@ export declare class SNS extends SNSClient {
     createPlatformEndpoint(args: CreatePlatformEndpointCommandInput, cb: (err: any, data?: CreatePlatformEndpointCommandOutput) => void): void;
     createPlatformEndpoint(args: CreatePlatformEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlatformEndpointCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.</p>
      *          <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
@@ -175,6 +182,7 @@ export declare class SNS extends SNSClient {
     createSMSSandboxPhoneNumber(args: CreateSMSSandboxPhoneNumberCommandInput, cb: (err: any, data?: CreateSMSSandboxPhoneNumberCommandOutput) => void): void;
     createSMSSandboxPhoneNumber(args: CreateSMSSandboxPhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSMSSandboxPhoneNumberCommandOutput) => void): void;
     /**
+     * @public
      * <p>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 <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html">Creating an Amazon SNS
      *                 topic</a> in the <i>Amazon SNS Developer Guide</i>. This action is
@@ -185,6 +193,7 @@ export declare class SNS extends SNSClient {
     createTopic(args: CreateTopicCommandInput, cb: (err: any, data?: CreateTopicCommandOutput) => void): void;
     createTopic(args: CreateTopicCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTopicCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the endpoint for a device and mobile app from Amazon SNS. This action is
      *             idempotent. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push
      *             Notifications</a>. </p>
@@ -195,6 +204,7 @@ export declare class SNS extends SNSClient {
     deleteEndpoint(args: DeleteEndpointCommandInput, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void;
     deleteEndpoint(args: DeleteEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void;
     /**
+     * @public
      * <p>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
      *                 <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS
@@ -204,6 +214,7 @@ export declare class SNS extends SNSClient {
     deletePlatformApplication(args: DeletePlatformApplicationCommandInput, cb: (err: any, data?: DeletePlatformApplicationCommandOutput) => void): void;
     deletePlatformApplication(args: DeletePlatformApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePlatformApplicationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes an Amazon Web Services account's verified or pending phone number from the SMS
      *             sandbox.</p>
      *          <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
@@ -219,6 +230,7 @@ export declare class SNS extends SNSClient {
     deleteSMSSandboxPhoneNumber(args: DeleteSMSSandboxPhoneNumberCommandInput, cb: (err: any, data?: DeleteSMSSandboxPhoneNumberCommandOutput) => void): void;
     deleteSMSSandboxPhoneNumber(args: DeleteSMSSandboxPhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSMSSandboxPhoneNumberCommandOutput) => void): void;
     /**
+     * @public
      * <p>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
@@ -228,6 +240,7 @@ export declare class SNS extends SNSClient {
     deleteTopic(args: DeleteTopicCommandInput, cb: (err: any, data?: DeleteTopicCommandOutput) => void): void;
     deleteTopic(args: DeleteTopicCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTopicCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the specified inline <code>DataProtectionPolicy</code> document that is
      *             stored in the specified Amazon SNS topic. </p>
      */
@@ -235,6 +248,7 @@ export declare class SNS extends SNSClient {
     getDataProtectionPolicy(args: GetDataProtectionPolicyCommandInput, cb: (err: any, data?: GetDataProtectionPolicyCommandOutput) => void): void;
     getDataProtectionPolicy(args: GetDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataProtectionPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>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 <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>
@@ -243,6 +257,7 @@ export declare class SNS extends SNSClient {
     getEndpointAttributes(args: GetEndpointAttributesCommandInput, cb: (err: any, data?: GetEndpointAttributesCommandOutput) => void): void;
     getEndpointAttributes(args: GetEndpointAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEndpointAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>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 <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>
@@ -251,6 +266,7 @@ export declare class SNS extends SNSClient {
     getPlatformApplicationAttributes(args: GetPlatformApplicationAttributesCommandInput, cb: (err: any, data?: GetPlatformApplicationAttributesCommandOutput) => void): void;
     getPlatformApplicationAttributes(args: GetPlatformApplicationAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPlatformApplicationAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns the settings for sending SMS messages from your Amazon Web Services account.</p>
      *          <p>These settings are set with the <code>SetSMSAttributes</code> action.</p>
      */
@@ -258,6 +274,7 @@ export declare class SNS extends SNSClient {
     getSMSAttributes(args: GetSMSAttributesCommandInput, cb: (err: any, data?: GetSMSAttributesCommandOutput) => void): void;
     getSMSAttributes(args: GetSMSAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSMSAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target
      *             Amazon Web Services Region.</p>
      *          <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
@@ -273,12 +290,14 @@ export declare class SNS extends SNSClient {
     getSMSSandboxAccountStatus(args: GetSMSSandboxAccountStatusCommandInput, cb: (err: any, data?: GetSMSSandboxAccountStatusCommandOutput) => void): void;
     getSMSSandboxAccountStatus(args: GetSMSSandboxAccountStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSMSSandboxAccountStatusCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns all of the properties of a subscription.</p>
      */
     getSubscriptionAttributes(args: GetSubscriptionAttributesCommandInput, options?: __HttpHandlerOptions): Promise<GetSubscriptionAttributesCommandOutput>;
     getSubscriptionAttributes(args: GetSubscriptionAttributesCommandInput, cb: (err: any, data?: GetSubscriptionAttributesCommandOutput) => void): void;
     getSubscriptionAttributes(args: GetSubscriptionAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSubscriptionAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns all of the properties of a topic. Topic properties returned might differ based
      *             on the authorization of the user.</p>
      */
@@ -286,6 +305,7 @@ export declare class SNS extends SNSClient {
     getTopicAttributes(args: GetTopicAttributesCommandInput, cb: (err: any, data?: GetTopicAttributesCommandOutput) => void): void;
     getTopicAttributes(args: GetTopicAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTopicAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>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
      *                 <code>ListEndpointsByPlatformApplication</code> are paginated and return a limited
@@ -301,6 +321,7 @@ export declare class SNS extends SNSClient {
     listEndpointsByPlatformApplication(args: ListEndpointsByPlatformApplicationCommandInput, cb: (err: any, data?: ListEndpointsByPlatformApplicationCommandOutput) => void): void;
     listEndpointsByPlatformApplication(args: ListEndpointsByPlatformApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEndpointsByPlatformApplicationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata.
      *             For more information about origination numbers, see <a href="https://docs.aws.amazon.com/sns/latest/dg/channels-sms-originating-identities-origination-numbers.html">Origination numbers</a> in the <i>Amazon SNS Developer
      *             Guide</i>.</p>
@@ -309,6 +330,7 @@ export declare class SNS extends SNSClient {
     listOriginationNumbers(args: ListOriginationNumbersCommandInput, cb: (err: any, data?: ListOriginationNumbersCommandOutput) => void): void;
     listOriginationNumbers(args: ListOriginationNumbersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOriginationNumbersCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns a list of phone numbers that are opted out, meaning you cannot send SMS
      *             messages to them.</p>
      *          <p>The results for <code>ListPhoneNumbersOptedOut</code> are paginated, and each page
@@ -322,6 +344,7 @@ export declare class SNS extends SNSClient {
     listPhoneNumbersOptedOut(args: ListPhoneNumbersOptedOutCommandInput, cb: (err: any, data?: ListPhoneNumbersOptedOutCommandOutput) => void): void;
     listPhoneNumbersOptedOut(args: ListPhoneNumbersOptedOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPhoneNumbersOptedOutCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the platform application objects for the supported push notification services,
      *             such as APNS and GCM (Firebase Cloud Messaging). The results for
      *                 <code>ListPlatformApplications</code> are paginated and return a limited list of
@@ -337,6 +360,7 @@ export declare class SNS extends SNSClient {
     listPlatformApplications(args: ListPlatformApplicationsCommandInput, cb: (err: any, data?: ListPlatformApplicationsCommandOutput) => void): void;
     listPlatformApplications(args: ListPlatformApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPlatformApplicationsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the calling Amazon Web Services account's current verified and pending destination phone
      *             numbers in the SMS sandbox.</p>
      *          <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
@@ -352,6 +376,7 @@ export declare class SNS extends SNSClient {
     listSMSSandboxPhoneNumbers(args: ListSMSSandboxPhoneNumbersCommandInput, cb: (err: any, data?: ListSMSSandboxPhoneNumbersCommandOutput) => void): void;
     listSMSSandboxPhoneNumbers(args: ListSMSSandboxPhoneNumbersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSMSSandboxPhoneNumbersCommandOutput) => void): void;
     /**
+     * @public
      * <p>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
@@ -362,6 +387,7 @@ export declare class SNS extends SNSClient {
     listSubscriptions(args: ListSubscriptionsCommandInput, cb: (err: any, data?: ListSubscriptionsCommandOutput) => void): void;
     listSubscriptions(args: ListSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubscriptionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>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
@@ -372,6 +398,7 @@ export declare class SNS extends SNSClient {
     listSubscriptionsByTopic(args: ListSubscriptionsByTopicCommandInput, cb: (err: any, data?: ListSubscriptionsByTopicCommandOutput) => void): void;
     listSubscriptionsByTopic(args: ListSubscriptionsByTopicCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubscriptionsByTopicCommandOutput) => void): void;
     /**
+     * @public
      * <p>List all tags added to the specified Amazon SNS topic. For an overview, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html">Amazon SNS Tags</a> in the
      *                 <i>Amazon Simple Notification Service Developer Guide</i>.</p>
      */
@@ -379,6 +406,7 @@ export declare class SNS extends SNSClient {
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>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
@@ -389,6 +417,7 @@ export declare class SNS extends SNSClient {
     listTopics(args: ListTopicsCommandInput, cb: (err: any, data?: ListTopicsCommandOutput) => void): void;
     listTopics(args: ListTopicsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTopicsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Use this request to opt in a phone number that is opted out, which enables you to
      *             resume sending SMS messages to the number.</p>
      *          <p>You can opt in a phone number only once every 30 days.</p>
@@ -397,6 +426,7 @@ export declare class SNS extends SNSClient {
     optInPhoneNumber(args: OptInPhoneNumberCommandInput, cb: (err: any, data?: OptInPhoneNumberCommandOutput) => void): void;
     optInPhoneNumber(args: OptInPhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OptInPhoneNumberCommandOutput) => void): void;
     /**
+     * @public
      * <p>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
      *                 <code>TargetArn</code>).</p>
@@ -420,6 +450,7 @@ export declare class SNS extends SNSClient {
     publish(args: PublishCommandInput, cb: (err: any, data?: PublishCommandOutput) => void): void;
     publish(args: PublishCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishCommandOutput) => void): void;
     /**
+     * @public
      * <p>Publishes up to ten messages to the specified topic. This is a batch version of
      *                 <code>Publish</code>. 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
@@ -446,6 +477,7 @@ export declare class SNS extends SNSClient {
     publishBatch(args: PublishBatchCommandInput, cb: (err: any, data?: PublishBatchCommandOutput) => void): void;
     publishBatch(args: PublishBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishBatchCommandOutput) => void): void;
     /**
+     * @public
      * <p>Adds or updates an inline policy document that is stored in the specified Amazon SNS
      *             topic.</p>
      */
@@ -453,6 +485,7 @@ export declare class SNS extends SNSClient {
     putDataProtectionPolicy(args: PutDataProtectionPolicyCommandInput, cb: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void): void;
     putDataProtectionPolicy(args: PutDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes a statement from a topic's access control policy.</p>
      *          <note>
      *             <p>To remove the ability to change topic permissions, you must deny permissions to
@@ -464,6 +497,7 @@ export declare class SNS extends SNSClient {
     removePermission(args: RemovePermissionCommandInput, cb: (err: any, data?: RemovePermissionCommandOutput) => void): void;
     removePermission(args: RemovePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemovePermissionCommandOutput) => void): void;
     /**
+     * @public
      * <p>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 <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>
@@ -472,6 +506,7 @@ export declare class SNS extends SNSClient {
     setEndpointAttributes(args: SetEndpointAttributesCommandInput, cb: (err: any, data?: SetEndpointAttributesCommandOutput) => void): void;
     setEndpointAttributes(args: SetEndpointAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetEndpointAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>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 <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. For information on configuring
@@ -482,6 +517,7 @@ export declare class SNS extends SNSClient {
     setPlatformApplicationAttributes(args: SetPlatformApplicationAttributesCommandInput, cb: (err: any, data?: SetPlatformApplicationAttributesCommandOutput) => void): void;
     setPlatformApplicationAttributes(args: SetPlatformApplicationAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetPlatformApplicationAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Use this request to set the default settings for sending SMS messages and receiving
      *             daily SMS usage reports.</p>
      *          <p>You can override some of these settings for a single message when you use the
@@ -498,6 +534,7 @@ export declare class SNS extends SNSClient {
     setSMSAttributes(args: SetSMSAttributesCommandInput, cb: (err: any, data?: SetSMSAttributesCommandOutput) => void): void;
     setSMSAttributes(args: SetSMSAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetSMSAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Allows a subscription owner to set an attribute of the subscription to a new
      *             value.</p>
      */
@@ -505,6 +542,7 @@ export declare class SNS extends SNSClient {
     setSubscriptionAttributes(args: SetSubscriptionAttributesCommandInput, cb: (err: any, data?: SetSubscriptionAttributesCommandOutput) => void): void;
     setSubscriptionAttributes(args: SetSubscriptionAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetSubscriptionAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Allows a topic owner to set an attribute of the topic to a new value.</p>
      *          <note>
      *             <p>To remove the ability to change topic permissions, you must deny permissions to
@@ -516,6 +554,7 @@ export declare class SNS extends SNSClient {
     setTopicAttributes(args: SetTopicAttributesCommandInput, cb: (err: any, data?: SetTopicAttributesCommandOutput) => void): void;
     setTopicAttributes(args: SetTopicAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetTopicAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>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 <code>ConfirmSubscription</code> action to confirm the subscription.</p>
@@ -527,6 +566,7 @@ export declare class SNS extends SNSClient {
     subscribe(args: SubscribeCommandInput, cb: (err: any, data?: SubscribeCommandOutput) => void): void;
     subscribe(args: SubscribeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubscribeCommandOutput) => void): void;
     /**
+     * @public
      * <p>Add tags to the specified Amazon SNS topic. For an overview, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html">Amazon SNS Tags</a> in the
      *                 <i>Amazon SNS Developer Guide</i>.</p>
      *          <p>When you use topic tags, keep the following guidelines in mind:</p>
@@ -555,6 +595,7 @@ export declare class SNS extends SNSClient {
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>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 <code>Unsubscribe</code> call does not require
@@ -572,6 +613,7 @@ export declare class SNS extends SNSClient {
     unsubscribe(args: UnsubscribeCommandInput, cb: (err: any, data?: UnsubscribeCommandOutput) => void): void;
     unsubscribe(args: UnsubscribeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnsubscribeCommandOutput) => void): void;
     /**
+     * @public
      * <p>Remove tags from the specified Amazon SNS topic. For an overview, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html">Amazon SNS Tags</a> in the
      *                 <i>Amazon SNS Developer Guide</i>.</p>
      */
@@ -579,6 +621,7 @@ export declare class SNS extends SNSClient {
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Verifies a destination phone number with a one-time password (OTP) for the calling
      *             Amazon Web Services account.</p>
      *          <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the

package/dist-types/SNSClient.d.ts

@@ -50,15 +50,24 @@ import { UnsubscribeCommandInput, UnsubscribeCommandOutput } from "./commands/Un
 import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
 import { VerifySMSSandboxPhoneNumberCommandInput, VerifySMSSandboxPhoneNumberCommandOutput } from "./commands/VerifySMSSandboxPhoneNumberCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = AddPermissionCommandInput | CheckIfPhoneNumberIsOptedOutCommandInput | ConfirmSubscriptionCommandInput | CreatePlatformApplicationCommandInput | CreatePlatformEndpointCommandInput | CreateSMSSandboxPhoneNumberCommandInput | CreateTopicCommandInput | DeleteEndpointCommandInput | DeletePlatformApplicationCommandInput | DeleteSMSSandboxPhoneNumberCommandInput | DeleteTopicCommandInput | GetDataProtectionPolicyCommandInput | GetEndpointAttributesCommandInput | GetPlatformApplicationAttributesCommandInput | GetSMSAttributesCommandInput | GetSMSSandboxAccountStatusCommandInput | GetSubscriptionAttributesCommandInput | GetTopicAttributesCommandInput | ListEndpointsByPlatformApplicationCommandInput | ListOriginationNumbersCommandInput | ListPhoneNumbersOptedOutCommandInput | ListPlatformApplicationsCommandInput | ListSMSSandboxPhoneNumbersCommandInput | ListSubscriptionsByTopicCommandInput | ListSubscriptionsCommandInput | ListTagsForResourceCommandInput | ListTopicsCommandInput | OptInPhoneNumberCommandInput | PublishBatchCommandInput | PublishCommandInput | PutDataProtectionPolicyCommandInput | RemovePermissionCommandInput | SetEndpointAttributesCommandInput | SetPlatformApplicationAttributesCommandInput | SetSMSAttributesCommandInput | SetSubscriptionAttributesCommandInput | SetTopicAttributesCommandInput | SubscribeCommandInput | TagResourceCommandInput | UnsubscribeCommandInput | UntagResourceCommandInput | VerifySMSSandboxPhoneNumberCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = AddPermissionCommandOutput | CheckIfPhoneNumberIsOptedOutCommandOutput | ConfirmSubscriptionCommandOutput | CreatePlatformApplicationCommandOutput | CreatePlatformEndpointCommandOutput | CreateSMSSandboxPhoneNumberCommandOutput | CreateTopicCommandOutput | DeleteEndpointCommandOutput | DeletePlatformApplicationCommandOutput | DeleteSMSSandboxPhoneNumberCommandOutput | DeleteTopicCommandOutput | GetDataProtectionPolicyCommandOutput | GetEndpointAttributesCommandOutput | GetPlatformApplicationAttributesCommandOutput | GetSMSAttributesCommandOutput | GetSMSSandboxAccountStatusCommandOutput | GetSubscriptionAttributesCommandOutput | GetTopicAttributesCommandOutput | ListEndpointsByPlatformApplicationCommandOutput | ListOriginationNumbersCommandOutput | ListPhoneNumbersOptedOutCommandOutput | ListPlatformApplicationsCommandOutput | ListSMSSandboxPhoneNumbersCommandOutput | ListSubscriptionsByTopicCommandOutput | ListSubscriptionsCommandOutput | ListTagsForResourceCommandOutput | ListTopicsCommandOutput | OptInPhoneNumberCommandOutput | PublishBatchCommandOutput | PublishCommandOutput | PutDataProtectionPolicyCommandOutput | RemovePermissionCommandOutput | SetEndpointAttributesCommandOutput | SetPlatformApplicationAttributesCommandOutput | SetSMSAttributesCommandOutput | SetSubscriptionAttributesCommandOutput | SetTopicAttributesCommandOutput | SubscribeCommandOutput | TagResourceCommandOutput | UnsubscribeCommandOutput | UntagResourceCommandOutput | VerifySMSSandboxPhoneNumberCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -148,23 +157,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type SNSClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of SNSClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of SNSClient class constructor that set the region, credentials and other options.
  */
 export interface SNSClientConfig extends SNSClientConfigType {
 }
+/**
+ * @public
+ */
 type SNSClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of SNSClient class. This is resolved and normalized from the {@link SNSClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of SNSClient class. This is resolved and normalized from the {@link SNSClientConfig | constructor configuration interface}.
  */
 export interface SNSClientResolvedConfig extends SNSClientResolvedConfigType {
 }
 /**
+ * @public
  * <fullname>Amazon Simple Notification Service</fullname>
  *          <p>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

package/dist-types/commands/AddPermissionCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AddPermissionInput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
 /**
+ * @public
+ *
  * The input for {@link AddPermissionCommand}.
  */
 export interface AddPermissionCommandInput extends AddPermissionInput {
 }
 /**
+ * @public
+ *
  * The output of {@link AddPermissionCommand}.
  */
 export interface AddPermissionCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds a statement to a topic's access control policy, granting access for the specified
  *             Amazon Web Services accounts to the specified actions.</p>
  *          <note>
@@ -31,6 +36,8 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param AddPermissionCommandInput - {@link AddPermissionCommandInput}
+ * @returns {@link AddPermissionCommandOutput}
  * @see {@link AddPermissionCommandInput} for command's `input` shape.
  * @see {@link AddPermissionCommandOutput} for command's `response` shape.
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -53,11 +60,20 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {
 export declare class AddPermissionCommand extends $Command<AddPermissionCommandInput, AddPermissionCommandOutput, SNSClientResolvedConfig> {
     readonly input: AddPermissionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: AddPermissionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AddPermissionCommandInput, AddPermissionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CheckIfPhoneNumberIsOptedOutCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CheckIfPhoneNumberIsOptedOutInput, CheckIfPhoneNumberIsOptedOutResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
 /**
+ * @public
+ *
  * The input for {@link CheckIfPhoneNumberIsOptedOutCommand}.
  */
 export interface CheckIfPhoneNumberIsOptedOutCommandInput extends CheckIfPhoneNumberIsOptedOutInput {
 }
 /**
+ * @public
+ *
  * The output of {@link CheckIfPhoneNumberIsOptedOutCommand}.
  */
 export interface CheckIfPhoneNumberIsOptedOutCommandOutput extends CheckIfPhoneNumberIsOptedOutResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>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.</p>
@@ -29,6 +34,8 @@ export interface CheckIfPhoneNumberIsOptedOutCommandOutput extends CheckIfPhoneN
  * const response = await client.send(command);
  * ```
  *
+ * @param CheckIfPhoneNumberIsOptedOutCommandInput - {@link CheckIfPhoneNumberIsOptedOutCommandInput}
+ * @returns {@link CheckIfPhoneNumberIsOptedOutCommandOutput}
  * @see {@link CheckIfPhoneNumberIsOptedOutCommandInput} for command's `input` shape.
  * @see {@link CheckIfPhoneNumberIsOptedOutCommandOutput} for command's `response` shape.
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -51,11 +58,20 @@ export interface CheckIfPhoneNumberIsOptedOutCommandOutput extends CheckIfPhoneN
 export declare class CheckIfPhoneNumberIsOptedOutCommand extends $Command<CheckIfPhoneNumberIsOptedOutCommandInput, CheckIfPhoneNumberIsOptedOutCommandOutput, SNSClientResolvedConfig> {
     readonly input: CheckIfPhoneNumberIsOptedOutCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CheckIfPhoneNumberIsOptedOutCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CheckIfPhoneNumberIsOptedOutCommandInput, CheckIfPhoneNumberIsOptedOutCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ConfirmSubscriptionCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ConfirmSubscriptionInput, ConfirmSubscriptionResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
 /**
+ * @public
+ *
  * The input for {@link ConfirmSubscriptionCommand}.
  */
 export interface ConfirmSubscriptionCommandInput extends ConfirmSubscriptionInput {
 }
 /**
+ * @public
+ *
  * The output of {@link ConfirmSubscriptionCommand}.
  */
 export interface ConfirmSubscriptionCommandOutput extends ConfirmSubscriptionResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>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
@@ -29,6 +34,8 @@ export interface ConfirmSubscriptionCommandOutput extends ConfirmSubscriptionRes
  * const response = await client.send(command);
  * ```
  *
+ * @param ConfirmSubscriptionCommandInput - {@link ConfirmSubscriptionCommandInput}
+ * @returns {@link ConfirmSubscriptionCommandOutput}
  * @see {@link ConfirmSubscriptionCommandInput} for command's `input` shape.
  * @see {@link ConfirmSubscriptionCommandOutput} for command's `response` shape.
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -60,11 +67,20 @@ export interface ConfirmSubscriptionCommandOutput extends ConfirmSubscriptionRes
 export declare class ConfirmSubscriptionCommand extends $Command<ConfirmSubscriptionCommandInput, ConfirmSubscriptionCommandOutput, SNSClientResolvedConfig> {
     readonly input: ConfirmSubscriptionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ConfirmSubscriptionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ConfirmSubscriptionCommandInput, ConfirmSubscriptionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreatePlatformApplicationCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreatePlatformApplicationInput, CreatePlatformApplicationResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
 /**
+ * @public
+ *
  * The input for {@link CreatePlatformApplicationCommand}.
  */
 export interface CreatePlatformApplicationCommandInput extends CreatePlatformApplicationInput {
 }
 /**
+ * @public
+ *
  * The output of {@link CreatePlatformApplicationCommand}.
  */
 export interface CreatePlatformApplicationCommandOutput extends CreatePlatformApplicationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>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 <code>PlatformPrincipal</code> and
@@ -69,6 +74,8 @@ export interface CreatePlatformApplicationCommandOutput extends CreatePlatformAp
  * const response = await client.send(command);
  * ```
  *
+ * @param CreatePlatformApplicationCommandInput - {@link CreatePlatformApplicationCommandInput}
+ * @returns {@link CreatePlatformApplicationCommandOutput}
  * @see {@link CreatePlatformApplicationCommandInput} for command's `input` shape.
  * @see {@link CreatePlatformApplicationCommandOutput} for command's `response` shape.
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -88,11 +95,20 @@ export interface CreatePlatformApplicationCommandOutput extends CreatePlatformAp
 export declare class CreatePlatformApplicationCommand extends $Command<CreatePlatformApplicationCommandInput, CreatePlatformApplicationCommandOutput, SNSClientResolvedConfig> {
     readonly input: CreatePlatformApplicationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreatePlatformApplicationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreatePlatformApplicationCommandInput, CreatePlatformApplicationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }