Skip to content

Commit

Permalink
docs(client-sns): Doc-only update for SNS. These changes include cust…
Browse files Browse the repository at this point in the history 
…omer-reported issues and TXC3 updates.
  • Loading branch information
awstools committed Jun 6, 2024
1 parent 7dd6fdf commit b381cca
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 31 deletions.
18 changes: 9 additions & 9 deletions clients/client-sns/src/commands/CreatePlatformApplicationCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,24 +38,24 @@ export interface CreatePlatformApplicationCommandOutput extends CreatePlatformAp
* the notification service.</p>
* <ul>
* <li>
* <p>For <code>ADM</code>, <code>PlatformPrincipal</code> is <code>client id</code>
* <p>For ADM, <code>PlatformPrincipal</code> is <code>client id</code>
* and <code>PlatformCredential</code> is <code>client secret</code>.</p>
* </li>
* <li>
* <p>For <code>Baidu</code>, <code>PlatformPrincipal</code> is <code>API key</code>
* and <code>PlatformCredential</code> is <code>secret key</code>.</p>
* </li>
* <li>
* <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using certificate
* <p>For APNS and <code>APNS_SANDBOX</code> using certificate
* credentials, <code>PlatformPrincipal</code> is <code>SSL certificate</code> and
* <code>PlatformCredential</code> is <code>private key</code>.</p>
* </li>
* <li>
* <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using token credentials,
* <p>For APNS and <code>APNS_SANDBOX</code> using token credentials,
* <code>PlatformPrincipal</code> is <code>signing key ID</code> and
* <code>PlatformCredential</code> is <code>signing key</code>.</p>
* </li>
* <li>
* <p>For Baidu, <code>PlatformPrincipal</code> is <code>API key</code>
* and <code>PlatformCredential</code> is <code>secret key</code>.</p>
* </li>
* <li>
* <p>For GCM (Firebase Cloud Messaging) using key credentials, there is no
* <code>PlatformPrincipal</code>. The <code>PlatformCredential</code> is
* <code>API key</code>.</p>
Expand All @@ -69,12 +69,12 @@ export interface CreatePlatformApplicationCommandOutput extends CreatePlatformAp
* @json <<< cat service.json`</code>.</p>
* </li>
* <li>
* <p>For <code>MPNS</code>, <code>PlatformPrincipal</code> is <code>TLS
* <p>For MPNS, <code>PlatformPrincipal</code> is <code>TLS
* certificate</code> and <code>PlatformCredential</code> is <code>private
* key</code>.</p>
* </li>
* <li>
* <p>For <code>WNS</code>, <code>PlatformPrincipal</code> is <code>Package Security
* <p>For WNS, <code>PlatformPrincipal</code> is <code>Package Security
* Identifier</code> and <code>PlatformCredential</code> is <code>secret
* key</code>.</p>
* </li>
Expand Down
31 changes: 15 additions & 16 deletions clients/client-sns/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@ export interface CreateTopicInput {

/**
* <p>A map of attributes with their corresponding values.</p>
* <p>The following lists the names, descriptions, and values of the special request
* <p>The following lists names, descriptions, and values of the special request
* parameters that the <code>CreateTopic</code> action uses:</p>
* <ul>
* <li>
Expand Down Expand Up @@ -1124,22 +1124,22 @@ export interface GetSubscriptionAttributesResponse {
* with.</p>
* </li>
* </ul>
* <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p>
* <p>The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:</p>
* <ul>
* <li>
* <p>
* <code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
* <ul>
* <li>
* <p>Permission to write to the Kinesis Data Firehose delivery stream</p>
* <p>Permission to write to the Firehose delivery stream</p>
* </li>
* <li>
* <p>Amazon SNS listed as a trusted entity</p>
* </li>
* </ul>
* <p>Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions.
* <p>Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions.
* For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
* to Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
* </li>
* </ul>
* @public
Expand Down Expand Up @@ -2157,9 +2157,8 @@ export interface PublishInput {
* <p>Optional parameter to be used as the "Subject" line when the message is delivered to
* email endpoints. This field will also be included, if present, in the standard JSON
* messages delivered to other endpoints.</p>
* <p>Constraints: Subjects must be ASCII text that begins with a letter, number, or
* punctuation mark; must not include line breaks or control characters; and must be less
* than 100 characters long.</p>
* <p>Constraints: Subjects must be UTF-8 text with no line breaks or control characters,
* and less than 100 characters long.</p>
* @public
*/
Subject?: string;
Expand Down Expand Up @@ -2960,22 +2959,22 @@ export interface SetSubscriptionAttributesInput {
* in the dead-letter queue for further analysis or reprocessing.</p>
* </li>
* </ul>
* <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p>
* <p>The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:</p>
* <ul>
* <li>
* <p>
* <code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
* <ul>
* <li>
* <p>Permission to write to the Kinesis Data Firehose delivery stream</p>
* <p>Permission to write to the Firehose delivery stream</p>
* </li>
* <li>
* <p>Amazon SNS listed as a trusted entity</p>
* </li>
* </ul>
* <p>Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions.
* <p>Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions.
* For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
* to Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
* </li>
* </ul>
* @public
Expand Down Expand Up @@ -3374,22 +3373,22 @@ export interface SubscribeInput {
* in the dead-letter queue for further analysis or reprocessing.</p>
* </li>
* </ul>
* <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p>
* <p>The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:</p>
* <ul>
* <li>
* <p>
* <code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
* <ul>
* <li>
* <p>Permission to write to the Kinesis Data Firehose delivery stream</p>
* <p>Permission to write to the Firehose delivery stream</p>
* </li>
* <li>
* <p>Amazon SNS listed as a trusted entity</p>
* </li>
* </ul>
* <p>Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions.
* <p>Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions.
* For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
* to Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
* </li>
* </ul>
* <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>
Expand Down
Loading

0 comments on commit b381cca

Please sign in to comment.