@aws-sdk/client-sns 3.262.0 → 3.264.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/dist-cjs/endpoint/ruleset.js +3 -3
  2. package/dist-es/endpoint/ruleset.js +3 -3
  3. package/dist-types/SNS.d.ts +63 -63
  4. package/dist-types/SNSClient.d.ts +3 -3
  5. package/dist-types/commands/AddPermissionCommand.d.ts +2 -2
  6. package/dist-types/commands/CheckIfPhoneNumberIsOptedOutCommand.d.ts +1 -1
  7. package/dist-types/commands/CreatePlatformApplicationCommand.d.ts +10 -10
  8. package/dist-types/commands/CreatePlatformEndpointCommand.d.ts +1 -1
  9. package/dist-types/commands/CreateSMSSandboxPhoneNumberCommand.d.ts +1 -1
  10. package/dist-types/commands/DeleteEndpointCommand.d.ts +1 -1
  11. package/dist-types/commands/DeleteSMSSandboxPhoneNumberCommand.d.ts +1 -1
  12. package/dist-types/commands/GetSMSAttributesCommand.d.ts +1 -1
  13. package/dist-types/commands/GetSMSSandboxAccountStatusCommand.d.ts +1 -1
  14. package/dist-types/commands/ListEndpointsByPlatformApplicationCommand.d.ts +1 -1
  15. package/dist-types/commands/ListPhoneNumbersOptedOutCommand.d.ts +1 -1
  16. package/dist-types/commands/ListPlatformApplicationsCommand.d.ts +1 -1
  17. package/dist-types/commands/ListSMSSandboxPhoneNumbersCommand.d.ts +1 -1
  18. package/dist-types/commands/ListSubscriptionsByTopicCommand.d.ts +1 -1
  19. package/dist-types/commands/ListSubscriptionsCommand.d.ts +1 -1
  20. package/dist-types/commands/ListTopicsCommand.d.ts +1 -1
  21. package/dist-types/commands/OptInPhoneNumberCommand.d.ts +1 -1
  22. package/dist-types/commands/PublishBatchCommand.d.ts +7 -7
  23. package/dist-types/commands/PublishCommand.d.ts +6 -6
  24. package/dist-types/commands/RemovePermissionCommand.d.ts +2 -2
  25. package/dist-types/commands/SetSMSAttributesCommand.d.ts +3 -3
  26. package/dist-types/commands/SetTopicAttributesCommand.d.ts +2 -2
  27. package/dist-types/commands/SubscribeCommand.d.ts +2 -2
  28. package/dist-types/commands/TagResourceCommand.d.ts +7 -7
  29. package/dist-types/commands/UnsubscribeCommand.d.ts +3 -3
  30. package/dist-types/commands/VerifySMSSandboxPhoneNumberCommand.d.ts +1 -1
  31. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  32. package/dist-types/models/models_0.d.ts +480 -379
  33. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  34. package/package.json +4 -4
@@ -9,7 +9,7 @@ export interface GetSMSAttributesCommandOutput extends GetSMSAttributesResponse,
9
9
  }
10
10
  /**
11
11
  * <p>Returns the settings for sending SMS messages from your Amazon Web Services account.</p>
12
- * <p>These settings are set with the <code>SetSMSAttributes</code> action.</p>
12
+ * <p>These settings are set with the <code>SetSMSAttributes</code> action.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -10,7 +10,7 @@ export interface GetSMSSandboxAccountStatusCommandOutput extends GetSMSSandboxAc
10
10
  /**
11
11
  * <p>Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target
12
12
  * Amazon Web Services Region.</p>
13
- * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
13
+ * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
14
14
  * <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
15
15
  * you to try Amazon SNS features without risking your reputation as an SMS sender. While your
16
16
  * Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send
@@ -17,7 +17,7 @@ export interface ListEndpointsByPlatformApplicationCommandOutput extends ListEnd
17
17
  * received from the previous call. When there are no more records to return, NextToken
18
18
  * will be null. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push
19
19
  * Notifications</a>. </p>
20
- * <p>This action is throttled at 30 transactions per second (TPS).</p>
20
+ * <p>This action is throttled at 30 transactions per second (TPS).</p>
21
21
  * @example
22
22
  * Use a bare-bones client and the command you need to make an API call.
23
23
  * ```javascript
@@ -10,7 +10,7 @@ export interface ListPhoneNumbersOptedOutCommandOutput extends ListPhoneNumbersO
10
10
  /**
11
11
  * <p>Returns a list of phone numbers that are opted out, meaning you cannot send SMS
12
12
  * messages to them.</p>
13
- * <p>The results for <code>ListPhoneNumbersOptedOut</code> are paginated, and each page
13
+ * <p>The results for <code>ListPhoneNumbersOptedOut</code> are paginated, and each page
14
14
  * returns up to 100 phone numbers. If additional phone numbers are available after the
15
15
  * first page of results, then a <code>NextToken</code> string will be returned. To receive
16
16
  * the next page, you call <code>ListPhoneNumbersOptedOut</code> again using the
@@ -17,7 +17,7 @@ export interface ListPlatformApplicationsCommandOutput extends ListPlatformAppli
17
17
  * previous call. When there are no more records to return, <code>NextToken</code> will be
18
18
  * null. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push
19
19
  * Notifications</a>. </p>
20
- * <p>This action is throttled at 15 transactions per second (TPS).</p>
20
+ * <p>This action is throttled at 15 transactions per second (TPS).</p>
21
21
  * @example
22
22
  * Use a bare-bones client and the command you need to make an API call.
23
23
  * ```javascript
@@ -10,7 +10,7 @@ export interface ListSMSSandboxPhoneNumbersCommandOutput extends ListSMSSandboxP
10
10
  /**
11
11
  * <p>Lists the calling Amazon Web Services account's current verified and pending destination phone
12
12
  * numbers in the SMS sandbox.</p>
13
- * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
13
+ * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
14
14
  * <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
15
15
  * you to try Amazon SNS features without risking your reputation as an SMS sender. While your
16
16
  * Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send
@@ -12,7 +12,7 @@ export interface ListSubscriptionsByTopicCommandOutput extends ListSubscriptions
12
12
  * list of subscriptions, up to 100. If there are more subscriptions, a
13
13
  * <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in
14
14
  * a new <code>ListSubscriptionsByTopic</code> call to get further results.</p>
15
- * <p>This action is throttled at 30 transactions per second (TPS).</p>
15
+ * <p>This action is throttled at 30 transactions per second (TPS).</p>
16
16
  * @example
17
17
  * Use a bare-bones client and the command you need to make an API call.
18
18
  * ```javascript
@@ -12,7 +12,7 @@ export interface ListSubscriptionsCommandOutput extends ListSubscriptionsRespons
12
12
  * subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is
13
13
  * also returned. Use the <code>NextToken</code> parameter in a new
14
14
  * <code>ListSubscriptions</code> call to get further results.</p>
15
- * <p>This action is throttled at 30 transactions per second (TPS).</p>
15
+ * <p>This action is throttled at 30 transactions per second (TPS).</p>
16
16
  * @example
17
17
  * Use a bare-bones client and the command you need to make an API call.
18
18
  * ```javascript
@@ -12,7 +12,7 @@ export interface ListTopicsCommandOutput extends ListTopicsResponse, __MetadataB
12
12
  * up to 100. If there are more topics, a <code>NextToken</code> is also returned. Use the
13
13
  * <code>NextToken</code> parameter in a new <code>ListTopics</code> call to get
14
14
  * further results.</p>
15
- * <p>This action is throttled at 30 transactions per second (TPS).</p>
15
+ * <p>This action is throttled at 30 transactions per second (TPS).</p>
16
16
  * @example
17
17
  * Use a bare-bones client and the command you need to make an API call.
18
18
  * ```javascript
@@ -10,7 +10,7 @@ export interface OptInPhoneNumberCommandOutput extends OptInPhoneNumberResponse,
10
10
  /**
11
11
  * <p>Use this request to opt in a phone number that is opted out, which enables you to
12
12
  * resume sending SMS messages to the number.</p>
13
- * <p>You can opt in a phone number only once every 30 days.</p>
13
+ * <p>You can opt in a phone number only once every 30 days.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
@@ -12,22 +12,22 @@ export interface PublishBatchCommandOutput extends PublishBatchResponse, __Metad
12
12
  * <code>Publish</code>. For FIFO topics, multiple messages within a single batch are
13
13
  * published in the order they are sent, and messages are deduplicated within the batch and
14
14
  * across batches for 5 minutes.</p>
15
- * <p>The result of publishing each message is reported individually in the response.
15
+ * <p>The result of publishing each message is reported individually in the response.
16
16
  * Because the batch request can result in a combination of successful and unsuccessful
17
17
  * actions, you should check for batch errors even when the call returns an HTTP status
18
18
  * code of <code>200</code>.</p>
19
- * <p>The maximum allowed individual message size and the maximum total payload size (the
19
+ * <p>The maximum allowed individual message size and the maximum total payload size (the
20
20
  * sum of the individual lengths of all of the batched messages) are both 256 KB (262,144
21
21
  * bytes). </p>
22
- * <p>Some actions take lists of parameters. These lists are specified using the
22
+ * <p>Some actions take lists of parameters. These lists are specified using the
23
23
  * <code>param.n</code> notation. Values of <code>n</code> are integers starting from
24
24
  * 1. For example, a parameter list with two elements looks like this: </p>
25
- * <p>&AttributeName.1=first</p>
26
- * <p>&AttributeName.2=second</p>
27
- * <p>If you send a batch message to a topic, Amazon SNS publishes the batch message to each
25
+ * <p>&AttributeName.1=first</p>
26
+ * <p>&AttributeName.2=second</p>
27
+ * <p>If you send a batch message to a topic, Amazon SNS publishes the batch message to each
28
28
  * endpoint that is subscribed to the topic. The format of the batch message depends on the
29
29
  * notification protocol for each subscribed endpoint.</p>
30
- * <p>When a <code>messageId</code> is returned, the batch message is saved and Amazon SNS
30
+ * <p>When a <code>messageId</code> is returned, the batch message is saved and Amazon SNS
31
31
  * immediately delivers the message to subscribers.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
@@ -11,21 +11,21 @@ export interface PublishCommandOutput extends PublishResponse, __MetadataBearer
11
11
  * <p>Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone
12
12
  * number, or a message to a mobile platform endpoint (when you specify the
13
13
  * <code>TargetArn</code>).</p>
14
- * <p>If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is
14
+ * <p>If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is
15
15
  * subscribed to the topic. The format of the message depends on the notification protocol
16
16
  * for each subscribed endpoint.</p>
17
- * <p>When a <code>messageId</code> is returned, the message is saved and Amazon SNS immediately
17
+ * <p>When a <code>messageId</code> is returned, the message is saved and Amazon SNS immediately
18
18
  * delivers it to subscribers.</p>
19
- * <p>To use the <code>Publish</code> action for publishing a message to a mobile endpoint,
19
+ * <p>To use the <code>Publish</code> action for publishing a message to a mobile endpoint,
20
20
  * such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for
21
21
  * the TargetArn parameter. The EndpointArn is returned when making a call with the
22
22
  * <code>CreatePlatformEndpoint</code> action. </p>
23
- * <p>For more information about formatting messages, see <a href="https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html">Send Custom
23
+ * <p>For more information about formatting messages, see <a href="https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html">Send Custom
24
24
  * Platform-Specific Payloads in Messages to Mobile Devices</a>. </p>
25
- * <important>
25
+ * <important>
26
26
  * <p>You can publish messages only to topics and endpoints in the same
27
27
  * Amazon Web Services Region.</p>
28
- * </important>
28
+ * </important>
29
29
  * @example
30
30
  * Use a bare-bones client and the command you need to make an API call.
31
31
  * ```javascript
@@ -9,11 +9,11 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
11
  * <p>Removes a statement from a topic's access control policy.</p>
12
- * <note>
12
+ * <note>
13
13
  * <p>To remove the ability to change topic permissions, you must deny permissions to
14
14
  * the <code>AddPermission</code>, <code>RemovePermission</code>, and
15
15
  * <code>SetTopicAttributes</code> actions in your IAM policy.</p>
16
- * </note>
16
+ * </note>
17
17
  * @example
18
18
  * Use a bare-bones client and the command you need to make an API call.
19
19
  * ```javascript
@@ -10,15 +10,15 @@ export interface SetSMSAttributesCommandOutput extends SetSMSAttributesResponse,
10
10
  /**
11
11
  * <p>Use this request to set the default settings for sending SMS messages and receiving
12
12
  * daily SMS usage reports.</p>
13
- * <p>You can override some of these settings for a single message when you use the
13
+ * <p>You can override some of these settings for a single message when you use the
14
14
  * <code>Publish</code> action with the <code>MessageAttributes.entry.N</code>
15
15
  * parameter. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html">Publishing to a mobile phone</a>
16
16
  * in the <i>Amazon SNS Developer Guide</i>.</p>
17
- * <note>
17
+ * <note>
18
18
  * <p>To use this operation, you must grant the Amazon SNS service principal
19
19
  * (<code>sns.amazonaws.com</code>) permission to perform the
20
20
  * <code>s3:ListBucket</code> action. </p>
21
- * </note>
21
+ * </note>
22
22
  * @example
23
23
  * Use a bare-bones client and the command you need to make an API call.
24
24
  * ```javascript
@@ -9,11 +9,11 @@ export interface SetTopicAttributesCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
11
  * <p>Allows a topic owner to set an attribute of the topic to a new value.</p>
12
- * <note>
12
+ * <note>
13
13
  * <p>To remove the ability to change topic permissions, you must deny permissions to
14
14
  * the <code>AddPermission</code>, <code>RemovePermission</code>, and
15
15
  * <code>SetTopicAttributes</code> actions in your IAM policy.</p>
16
- * </note>
16
+ * </note>
17
17
  * @example
18
18
  * Use a bare-bones client and the command you need to make an API call.
19
19
  * ```javascript
@@ -11,9 +11,9 @@ export interface SubscribeCommandOutput extends SubscribeResponse, __MetadataBea
11
11
  * <p>Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or
12
12
  * if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must
13
13
  * run the <code>ConfirmSubscription</code> action to confirm the subscription.</p>
14
- * <p>You call the <code>ConfirmSubscription</code> action with the token from the
14
+ * <p>You call the <code>ConfirmSubscription</code> action with the token from the
15
15
  * subscription response. Confirmation tokens are valid for three days.</p>
16
- * <p>This action is throttled at 100 transactions per second (TPS).</p>
16
+ * <p>This action is throttled at 100 transactions per second (TPS).</p>
17
17
  * @example
18
18
  * Use a bare-bones client and the command you need to make an API call.
19
19
  * ```javascript
@@ -10,24 +10,24 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
10
10
  /**
11
11
  * <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
12
12
  * <i>Amazon SNS Developer Guide</i>.</p>
13
- * <p>When you use topic tags, keep the following guidelines in mind:</p>
14
- * <ul>
13
+ * <p>When you use topic tags, keep the following guidelines in mind:</p>
14
+ * <ul>
15
15
  * <li>
16
- * <p>Adding more than 50 tags to a topic isn't recommended.</p>
16
+ * <p>Adding more than 50 tags to a topic isn't recommended.</p>
17
17
  * </li>
18
18
  * <li>
19
- * <p>Tags don't have any semantic meaning. Amazon SNS interprets tags as character
19
+ * <p>Tags don't have any semantic meaning. Amazon SNS interprets tags as character
20
20
  * strings.</p>
21
21
  * </li>
22
22
  * <li>
23
- * <p>Tags are case-sensitive.</p>
23
+ * <p>Tags are case-sensitive.</p>
24
24
  * </li>
25
25
  * <li>
26
- * <p>A new tag with a key identical to that of an existing tag overwrites the
26
+ * <p>A new tag with a key identical to that of an existing tag overwrites the
27
27
  * existing tag.</p>
28
28
  * </li>
29
29
  * <li>
30
- * <p>Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If
30
+ * <p>Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If
31
31
  * your application requires a higher throughput, file a <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=technical">technical support request</a>.</p>
32
32
  * </li>
33
33
  * </ul>
@@ -14,12 +14,12 @@ export interface UnsubscribeCommandOutput extends __MetadataBearer {
14
14
  * authentication and the requester is not the subscription owner, a final cancellation
15
15
  * message is delivered to the endpoint, so that the endpoint owner can easily resubscribe
16
16
  * to the topic if the <code>Unsubscribe</code> request was unintended.</p>
17
- * <note>
17
+ * <note>
18
18
  * <p>Amazon SQS queue subscriptions require authentication for deletion. Only the owner of
19
19
  * the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services
20
20
  * signature.</p>
21
- * </note>
22
- * <p>This action is throttled at 100 transactions per second (TPS).</p>
21
+ * </note>
22
+ * <p>This action is throttled at 100 transactions per second (TPS).</p>
23
23
  * @example
24
24
  * Use a bare-bones client and the command you need to make an API call.
25
25
  * ```javascript
@@ -10,7 +10,7 @@ export interface VerifySMSSandboxPhoneNumberCommandOutput extends VerifySMSSandb
10
10
  /**
11
11
  * <p>Verifies a destination phone number with a one-time password (OTP) for the calling
12
12
  * Amazon Web Services account.</p>
13
- * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
13
+ * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
14
14
  * <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
15
15
  * you to try Amazon SNS features without risking your reputation as an SMS sender. While your
16
16
  * Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export interface EndpointParameters extends __EndpointParameters {
15
- Region?: string;
15
+ Region: string;
16
16
  UseDualStack?: boolean;
17
17
  UseFIPS?: boolean;
18
18
  Endpoint?: string;