Skip to content

Commit b381cca

Browse files
author
awstools
committed
docs(client-sns): Doc-only update for SNS. These changes include customer-reported issues and TXC3 updates.
1 parent 7dd6fdf commit b381cca

File tree

3 files changed

+30
-31
lines changed

3 files changed

+30
-31
lines changed

‎clients/client-sns/src/commands/CreatePlatformApplicationCommand.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -38,24 +38,24 @@ export interface CreatePlatformApplicationCommandOutput extends CreatePlatformAp
3838
* the notification service.</p>
3939
* <ul>
4040
* <li>
41-
* <p>For <code>ADM</code>, <code>PlatformPrincipal</code> is <code>client id</code>
41+
* <p>For ADM, <code>PlatformPrincipal</code> is <code>client id</code>
4242
* and <code>PlatformCredential</code> is <code>client secret</code>.</p>
4343
* </li>
4444
* <li>
45-
* <p>For <code>Baidu</code>, <code>PlatformPrincipal</code> is <code>API key</code>
46-
* and <code>PlatformCredential</code> is <code>secret key</code>.</p>
47-
* </li>
48-
* <li>
49-
* <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using certificate
45+
* <p>For APNS and <code>APNS_SANDBOX</code> using certificate
5046
* credentials, <code>PlatformPrincipal</code> is <code>SSL certificate</code> and
5147
* <code>PlatformCredential</code> is <code>private key</code>.</p>
5248
* </li>
5349
* <li>
54-
* <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using token credentials,
50+
* <p>For APNS and <code>APNS_SANDBOX</code> using token credentials,
5551
* <code>PlatformPrincipal</code> is <code>signing key ID</code> and
5652
* <code>PlatformCredential</code> is <code>signing key</code>.</p>
5753
* </li>
5854
* <li>
55+
* <p>For Baidu, <code>PlatformPrincipal</code> is <code>API key</code>
56+
* and <code>PlatformCredential</code> is <code>secret key</code>.</p>
57+
* </li>
58+
* <li>
5959
* <p>For GCM (Firebase Cloud Messaging) using key credentials, there is no
6060
* <code>PlatformPrincipal</code>. The <code>PlatformCredential</code> is
6161
* <code>API key</code>.</p>
@@ -69,12 +69,12 @@ export interface CreatePlatformApplicationCommandOutput extends CreatePlatformAp
6969
* @json <<< cat service.json`</code>.</p>
7070
* </li>
7171
* <li>
72-
* <p>For <code>MPNS</code>, <code>PlatformPrincipal</code> is <code>TLS
72+
* <p>For MPNS, <code>PlatformPrincipal</code> is <code>TLS
7373
* certificate</code> and <code>PlatformCredential</code> is <code>private
7474
* key</code>.</p>
7575
* </li>
7676
* <li>
77-
* <p>For <code>WNS</code>, <code>PlatformPrincipal</code> is <code>Package Security
77+
* <p>For WNS, <code>PlatformPrincipal</code> is <code>Package Security
7878
* Identifier</code> and <code>PlatformCredential</code> is <code>secret
7979
* key</code>.</p>
8080
* </li>

‎clients/client-sns/src/models/models_0.ts

+15-16
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,7 @@ export interface CreateTopicInput {
515515

516516
/**
517517
* <p>A map of attributes with their corresponding values.</p>
518-
* <p>The following lists the names, descriptions, and values of the special request
518+
* <p>The following lists names, descriptions, and values of the special request
519519
* parameters that the <code>CreateTopic</code> action uses:</p>
520520
* <ul>
521521
* <li>
@@ -1124,22 +1124,22 @@ export interface GetSubscriptionAttributesResponse {
11241124
* with.</p>
11251125
* </li>
11261126
* </ul>
1127-
* <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p>
1127+
* <p>The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:</p>
11281128
* <ul>
11291129
* <li>
11301130
* <p>
11311131
* <code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
11321132
* <ul>
11331133
* <li>
1134-
* <p>Permission to write to the Kinesis Data Firehose delivery stream</p>
1134+
* <p>Permission to write to the Firehose delivery stream</p>
11351135
* </li>
11361136
* <li>
11371137
* <p>Amazon SNS listed as a trusted entity</p>
11381138
* </li>
11391139
* </ul>
1140-
* <p>Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions.
1140+
* <p>Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions.
11411141
* For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout
1142-
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
1142+
* to Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
11431143
* </li>
11441144
* </ul>
11451145
* @public
@@ -2157,9 +2157,8 @@ export interface PublishInput {
21572157
* <p>Optional parameter to be used as the "Subject" line when the message is delivered to
21582158
* email endpoints. This field will also be included, if present, in the standard JSON
21592159
* messages delivered to other endpoints.</p>
2160-
* <p>Constraints: Subjects must be ASCII text that begins with a letter, number, or
2161-
* punctuation mark; must not include line breaks or control characters; and must be less
2162-
* than 100 characters long.</p>
2160+
* <p>Constraints: Subjects must be UTF-8 text with no line breaks or control characters,
2161+
* and less than 100 characters long.</p>
21632162
* @public
21642163
*/
21652164
Subject?: string;
@@ -2960,22 +2959,22 @@ export interface SetSubscriptionAttributesInput {
29602959
* in the dead-letter queue for further analysis or reprocessing.</p>
29612960
* </li>
29622961
* </ul>
2963-
* <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p>
2962+
* <p>The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:</p>
29642963
* <ul>
29652964
* <li>
29662965
* <p>
29672966
* <code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
29682967
* <ul>
29692968
* <li>
2970-
* <p>Permission to write to the Kinesis Data Firehose delivery stream</p>
2969+
* <p>Permission to write to the Firehose delivery stream</p>
29712970
* </li>
29722971
* <li>
29732972
* <p>Amazon SNS listed as a trusted entity</p>
29742973
* </li>
29752974
* </ul>
2976-
* <p>Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions.
2975+
* <p>Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions.
29772976
* For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout
2978-
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
2977+
* to Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
29792978
* </li>
29802979
* </ul>
29812980
* @public
@@ -3374,22 +3373,22 @@ export interface SubscribeInput {
33743373
* in the dead-letter queue for further analysis or reprocessing.</p>
33753374
* </li>
33763375
* </ul>
3377-
* <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p>
3376+
* <p>The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:</p>
33783377
* <ul>
33793378
* <li>
33803379
* <p>
33813380
* <code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
33823381
* <ul>
33833382
* <li>
3384-
* <p>Permission to write to the Kinesis Data Firehose delivery stream</p>
3383+
* <p>Permission to write to the Firehose delivery stream</p>
33853384
* </li>
33863385
* <li>
33873386
* <p>Amazon SNS listed as a trusted entity</p>
33883387
* </li>
33893388
* </ul>
3390-
* <p>Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions.
3389+
* <p>Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions.
33913390
* For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout
3392-
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
3391+
* to Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
33933392
* </li>
33943393
* </ul>
33953394
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</p>

0 commit comments

Comments
 (0)