Skip to content

Commit b11ed43

Browse files
author
aws-sdk-cpp-automation
committed
Documentation updates for Amazon SNS.
1 parent 9ae103b commit b11ed43

File tree

6 files changed

+505
-158
lines changed

6 files changed

+505
-158
lines changed

aws-cpp-sdk-core/include/aws/core/VersionConfig.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
* SPDX-License-Identifier: Apache-2.0.
44
*/
55

6-
#define AWS_SDK_VERSION_STRING "1.8.125"
6+
#define AWS_SDK_VERSION_STRING "1.8.126"

aws-cpp-sdk-sns/include/aws/sns/SNSClient.h

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,8 @@ namespace Model
225225
* Notification Service (Amazon SNS) is a web service that enables you to build
226226
* distributed web-enabled applications. Applications can use Amazon SNS to easily
227227
* push real-time notification messages to interested subscribers over multiple
228-
* delivery protocols. For more information about this product see <a
229-
* href="http://aws.amazon.com/sns/">https://aws.amazon.com/sns</a>. For detailed
228+
* delivery protocols. For more information about this product see the <a
229+
* href="http://aws.amazon.com/sns/">Amazon SNS product page</a>. For detailed
230230
* information about Amazon SNS features and their associated API calls, see the <a
231231
* href="https://docs.aws.amazon.com/sns/latest/dg/">Amazon SNS Developer
232232
* Guide</a>. </p> <p>For information on the permissions you need to use this API,
@@ -1395,8 +1395,10 @@ namespace Model
13951395
* the <code>MessageAttributes.entry.N</code> parameter. For more information, see
13961396
* <a
13971397
* href="https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html">Publishing
1398-
* to a mobile phone</a> in the <i>Amazon SNS Developer Guide</i>.</p><p><h3>See
1399-
* Also:</h3> <a
1398+
* to a mobile phone</a> in the <i>Amazon SNS Developer Guide</i>.</p> <p>To
1399+
* use this operation, you must grant the Amazon SNS service principal
1400+
* (<code>sns.amazonaws.com</code>) permission to perform the
1401+
* <code>s3:ListBucket</code> action. </p> <p><h3>See Also:</h3> <a
14001402
* href="http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetSMSAttributes">AWS
14011403
* API Reference</a></p>
14021404
*/
@@ -1409,8 +1411,10 @@ namespace Model
14091411
* the <code>MessageAttributes.entry.N</code> parameter. For more information, see
14101412
* <a
14111413
* href="https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html">Publishing
1412-
* to a mobile phone</a> in the <i>Amazon SNS Developer Guide</i>.</p><p><h3>See
1413-
* Also:</h3> <a
1414+
* to a mobile phone</a> in the <i>Amazon SNS Developer Guide</i>.</p> <p>To
1415+
* use this operation, you must grant the Amazon SNS service principal
1416+
* (<code>sns.amazonaws.com</code>) permission to perform the
1417+
* <code>s3:ListBucket</code> action. </p> <p><h3>See Also:</h3> <a
14141418
* href="http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetSMSAttributes">AWS
14151419
* API Reference</a></p>
14161420
*
@@ -1425,8 +1429,10 @@ namespace Model
14251429
* the <code>MessageAttributes.entry.N</code> parameter. For more information, see
14261430
* <a
14271431
* href="https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html">Publishing
1428-
* to a mobile phone</a> in the <i>Amazon SNS Developer Guide</i>.</p><p><h3>See
1429-
* Also:</h3> <a
1432+
* to a mobile phone</a> in the <i>Amazon SNS Developer Guide</i>.</p> <p>To
1433+
* use this operation, you must grant the Amazon SNS service principal
1434+
* (<code>sns.amazonaws.com</code>) permission to perform the
1435+
* <code>s3:ListBucket</code> action. </p> <p><h3>See Also:</h3> <a
14301436
* href="http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetSMSAttributes">AWS
14311437
* API Reference</a></p>
14321438
*

aws-cpp-sdk-sns/include/aws/sns/model/GetSubscriptionAttributesResult.h

Lines changed: 132 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,17 @@ namespace Model
6565
* becomes unavailable) are held in the dead-letter queue for further analysis or
6666
* reprocessing.</p> </li> <li> <p> <code>SubscriptionArn</code> – The
6767
* subscription's ARN.</p> </li> <li> <p> <code>TopicArn</code> – The topic ARN
68-
* that the subscription is associated with.</p> </li> </ul>
68+
* that the subscription is associated with.</p> </li> </ul> <p>The following
69+
* attribute applies only to Amazon Kinesis Data Firehose delivery stream
70+
* subscriptions:</p> <ul> <li> <p> <code>SubscriptionRoleArn</code> – The ARN of
71+
* the IAM role that has the following:</p> <ul> <li> <p>Permission to write to the
72+
* Kinesis Data Firehose delivery stream</p> </li> <li> <p>Amazon SNS listed as a
73+
* trusted entity</p> </li> </ul> <p>Specifying a valid ARN for this attribute is
74+
* required for Kinesis Data Firehose delivery stream subscriptions. For more
75+
* information, see <a
76+
* href="https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html">Fanout
77+
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer
78+
* Guide</i>.</p> </li> </ul>
6979
*/
7080
inline const Aws::Map<Aws::String, Aws::String>& GetAttributes() const{ return m_attributes; }
7181

@@ -95,7 +105,17 @@ namespace Model
95105
* becomes unavailable) are held in the dead-letter queue for further analysis or
96106
* reprocessing.</p> </li> <li> <p> <code>SubscriptionArn</code> – The
97107
* subscription's ARN.</p> </li> <li> <p> <code>TopicArn</code> – The topic ARN
98-
* that the subscription is associated with.</p> </li> </ul>
108+
* that the subscription is associated with.</p> </li> </ul> <p>The following
109+
* attribute applies only to Amazon Kinesis Data Firehose delivery stream
110+
* subscriptions:</p> <ul> <li> <p> <code>SubscriptionRoleArn</code> – The ARN of
111+
* the IAM role that has the following:</p> <ul> <li> <p>Permission to write to the
112+
* Kinesis Data Firehose delivery stream</p> </li> <li> <p>Amazon SNS listed as a
113+
* trusted entity</p> </li> </ul> <p>Specifying a valid ARN for this attribute is
114+
* required for Kinesis Data Firehose delivery stream subscriptions. For more
115+
* information, see <a
116+
* href="https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html">Fanout
117+
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer
118+
* Guide</i>.</p> </li> </ul>
99119
*/
100120
inline void SetAttributes(const Aws::Map<Aws::String, Aws::String>& value) { m_attributes = value; }
101121

@@ -125,7 +145,17 @@ namespace Model
125145
* becomes unavailable) are held in the dead-letter queue for further analysis or
126146
* reprocessing.</p> </li> <li> <p> <code>SubscriptionArn</code> – The
127147
* subscription's ARN.</p> </li> <li> <p> <code>TopicArn</code> – The topic ARN
128-
* that the subscription is associated with.</p> </li> </ul>
148+
* that the subscription is associated with.</p> </li> </ul> <p>The following
149+
* attribute applies only to Amazon Kinesis Data Firehose delivery stream
150+
* subscriptions:</p> <ul> <li> <p> <code>SubscriptionRoleArn</code> – The ARN of
151+
* the IAM role that has the following:</p> <ul> <li> <p>Permission to write to the
152+
* Kinesis Data Firehose delivery stream</p> </li> <li> <p>Amazon SNS listed as a
153+
* trusted entity</p> </li> </ul> <p>Specifying a valid ARN for this attribute is
154+
* required for Kinesis Data Firehose delivery stream subscriptions. For more
155+
* information, see <a
156+
* href="https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html">Fanout
157+
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer
158+
* Guide</i>.</p> </li> </ul>
129159
*/
130160
inline void SetAttributes(Aws::Map<Aws::String, Aws::String>&& value) { m_attributes = std::move(value); }
131161

@@ -155,7 +185,17 @@ namespace Model
155185
* becomes unavailable) are held in the dead-letter queue for further analysis or
156186
* reprocessing.</p> </li> <li> <p> <code>SubscriptionArn</code> – The
157187
* subscription's ARN.</p> </li> <li> <p> <code>TopicArn</code> – The topic ARN
158-
* that the subscription is associated with.</p> </li> </ul>
188+
* that the subscription is associated with.</p> </li> </ul> <p>The following
189+
* attribute applies only to Amazon Kinesis Data Firehose delivery stream
190+
* subscriptions:</p> <ul> <li> <p> <code>SubscriptionRoleArn</code> – The ARN of
191+
* the IAM role that has the following:</p> <ul> <li> <p>Permission to write to the
192+
* Kinesis Data Firehose delivery stream</p> </li> <li> <p>Amazon SNS listed as a
193+
* trusted entity</p> </li> </ul> <p>Specifying a valid ARN for this attribute is
194+
* required for Kinesis Data Firehose delivery stream subscriptions. For more
195+
* information, see <a
196+
* href="https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html">Fanout
197+
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer
198+
* Guide</i>.</p> </li> </ul>
159199
*/
160200
inline GetSubscriptionAttributesResult& WithAttributes(const Aws::Map<Aws::String, Aws::String>& value) { SetAttributes(value); return *this;}
161201

@@ -185,7 +225,17 @@ namespace Model
185225
* becomes unavailable) are held in the dead-letter queue for further analysis or
186226
* reprocessing.</p> </li> <li> <p> <code>SubscriptionArn</code> – The
187227
* subscription's ARN.</p> </li> <li> <p> <code>TopicArn</code> – The topic ARN
188-
* that the subscription is associated with.</p> </li> </ul>
228+
* that the subscription is associated with.</p> </li> </ul> <p>The following
229+
* attribute applies only to Amazon Kinesis Data Firehose delivery stream
230+
* subscriptions:</p> <ul> <li> <p> <code>SubscriptionRoleArn</code> – The ARN of
231+
* the IAM role that has the following:</p> <ul> <li> <p>Permission to write to the
232+
* Kinesis Data Firehose delivery stream</p> </li> <li> <p>Amazon SNS listed as a
233+
* trusted entity</p> </li> </ul> <p>Specifying a valid ARN for this attribute is
234+
* required for Kinesis Data Firehose delivery stream subscriptions. For more
235+
* information, see <a
236+
* href="https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html">Fanout
237+
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer
238+
* Guide</i>.</p> </li> </ul>
189239
*/
190240
inline GetSubscriptionAttributesResult& WithAttributes(Aws::Map<Aws::String, Aws::String>&& value) { SetAttributes(std::move(value)); return *this;}
191241

@@ -215,7 +265,17 @@ namespace Model
215265
* becomes unavailable) are held in the dead-letter queue for further analysis or
216266
* reprocessing.</p> </li> <li> <p> <code>SubscriptionArn</code> – The
217267
* subscription's ARN.</p> </li> <li> <p> <code>TopicArn</code> – The topic ARN
218-
* that the subscription is associated with.</p> </li> </ul>
268+
* that the subscription is associated with.</p> </li> </ul> <p>The following
269+
* attribute applies only to Amazon Kinesis Data Firehose delivery stream
270+
* subscriptions:</p> <ul> <li> <p> <code>SubscriptionRoleArn</code> – The ARN of
271+
* the IAM role that has the following:</p> <ul> <li> <p>Permission to write to the
272+
* Kinesis Data Firehose delivery stream</p> </li> <li> <p>Amazon SNS listed as a
273+
* trusted entity</p> </li> </ul> <p>Specifying a valid ARN for this attribute is
274+
* required for Kinesis Data Firehose delivery stream subscriptions. For more
275+
* information, see <a
276+
* href="https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html">Fanout
277+
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer
278+
* Guide</i>.</p> </li> </ul>
219279
*/
220280
inline GetSubscriptionAttributesResult& AddAttributes(const Aws::String& key, const Aws::String& value) { m_attributes.emplace(key, value); return *this; }
221281

@@ -245,7 +305,17 @@ namespace Model
245305
* becomes unavailable) are held in the dead-letter queue for further analysis or
246306
* reprocessing.</p> </li> <li> <p> <code>SubscriptionArn</code> – The
247307
* subscription's ARN.</p> </li> <li> <p> <code>TopicArn</code> – The topic ARN
248-
* that the subscription is associated with.</p> </li> </ul>
308+
* that the subscription is associated with.</p> </li> </ul> <p>The following
309+
* attribute applies only to Amazon Kinesis Data Firehose delivery stream
310+
* subscriptions:</p> <ul> <li> <p> <code>SubscriptionRoleArn</code> – The ARN of
311+
* the IAM role that has the following:</p> <ul> <li> <p>Permission to write to the
312+
* Kinesis Data Firehose delivery stream</p> </li> <li> <p>Amazon SNS listed as a
313+
* trusted entity</p> </li> </ul> <p>Specifying a valid ARN for this attribute is
314+
* required for Kinesis Data Firehose delivery stream subscriptions. For more
315+
* information, see <a
316+
* href="https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html">Fanout
317+
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer
318+
* Guide</i>.</p> </li> </ul>
249319
*/
250320
inline GetSubscriptionAttributesResult& AddAttributes(Aws::String&& key, const Aws::String& value) { m_attributes.emplace(std::move(key), value); return *this; }
251321

@@ -275,7 +345,17 @@ namespace Model
275345
* becomes unavailable) are held in the dead-letter queue for further analysis or
276346
* reprocessing.</p> </li> <li> <p> <code>SubscriptionArn</code> – The
277347
* subscription's ARN.</p> </li> <li> <p> <code>TopicArn</code> – The topic ARN
278-
* that the subscription is associated with.</p> </li> </ul>
348+
* that the subscription is associated with.</p> </li> </ul> <p>The following
349+
* attribute applies only to Amazon Kinesis Data Firehose delivery stream
350+
* subscriptions:</p> <ul> <li> <p> <code>SubscriptionRoleArn</code> – The ARN of
351+
* the IAM role that has the following:</p> <ul> <li> <p>Permission to write to the
352+
* Kinesis Data Firehose delivery stream</p> </li> <li> <p>Amazon SNS listed as a
353+
* trusted entity</p> </li> </ul> <p>Specifying a valid ARN for this attribute is
354+
* required for Kinesis Data Firehose delivery stream subscriptions. For more
355+
* information, see <a
356+
* href="https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html">Fanout
357+
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer
358+
* Guide</i>.</p> </li> </ul>
279359
*/
280360
inline GetSubscriptionAttributesResult& AddAttributes(const Aws::String& key, Aws::String&& value) { m_attributes.emplace(key, std::move(value)); return *this; }
281361

@@ -305,7 +385,17 @@ namespace Model
305385
* becomes unavailable) are held in the dead-letter queue for further analysis or
306386
* reprocessing.</p> </li> <li> <p> <code>SubscriptionArn</code> – The
307387
* subscription's ARN.</p> </li> <li> <p> <code>TopicArn</code> – The topic ARN
308-
* that the subscription is associated with.</p> </li> </ul>
388+
* that the subscription is associated with.</p> </li> </ul> <p>The following
389+
* attribute applies only to Amazon Kinesis Data Firehose delivery stream
390+
* subscriptions:</p> <ul> <li> <p> <code>SubscriptionRoleArn</code> – The ARN of
391+
* the IAM role that has the following:</p> <ul> <li> <p>Permission to write to the
392+
* Kinesis Data Firehose delivery stream</p> </li> <li> <p>Amazon SNS listed as a
393+
* trusted entity</p> </li> </ul> <p>Specifying a valid ARN for this attribute is
394+
* required for Kinesis Data Firehose delivery stream subscriptions. For more
395+
* information, see <a
396+
* href="https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html">Fanout
397+
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer
398+
* Guide</i>.</p> </li> </ul>
309399
*/
310400
inline GetSubscriptionAttributesResult& AddAttributes(Aws::String&& key, Aws::String&& value) { m_attributes.emplace(std::move(key), std::move(value)); return *this; }
311401

@@ -335,7 +425,17 @@ namespace Model
335425
* becomes unavailable) are held in the dead-letter queue for further analysis or
336426
* reprocessing.</p> </li> <li> <p> <code>SubscriptionArn</code> – The
337427
* subscription's ARN.</p> </li> <li> <p> <code>TopicArn</code> – The topic ARN
338-
* that the subscription is associated with.</p> </li> </ul>
428+
* that the subscription is associated with.</p> </li> </ul> <p>The following
429+
* attribute applies only to Amazon Kinesis Data Firehose delivery stream
430+
* subscriptions:</p> <ul> <li> <p> <code>SubscriptionRoleArn</code> – The ARN of
431+
* the IAM role that has the following:</p> <ul> <li> <p>Permission to write to the
432+
* Kinesis Data Firehose delivery stream</p> </li> <li> <p>Amazon SNS listed as a
433+
* trusted entity</p> </li> </ul> <p>Specifying a valid ARN for this attribute is
434+
* required for Kinesis Data Firehose delivery stream subscriptions. For more
435+
* information, see <a
436+
* href="https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html">Fanout
437+
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer
438+
* Guide</i>.</p> </li> </ul>
339439
*/
340440
inline GetSubscriptionAttributesResult& AddAttributes(const char* key, Aws::String&& value) { m_attributes.emplace(key, std::move(value)); return *this; }
341441

@@ -365,7 +465,17 @@ namespace Model
365465
* becomes unavailable) are held in the dead-letter queue for further analysis or
366466
* reprocessing.</p> </li> <li> <p> <code>SubscriptionArn</code> – The
367467
* subscription's ARN.</p> </li> <li> <p> <code>TopicArn</code> – The topic ARN
368-
* that the subscription is associated with.</p> </li> </ul>
468+
* that the subscription is associated with.</p> </li> </ul> <p>The following
469+
* attribute applies only to Amazon Kinesis Data Firehose delivery stream
470+
* subscriptions:</p> <ul> <li> <p> <code>SubscriptionRoleArn</code> – The ARN of
471+
* the IAM role that has the following:</p> <ul> <li> <p>Permission to write to the
472+
* Kinesis Data Firehose delivery stream</p> </li> <li> <p>Amazon SNS listed as a
473+
* trusted entity</p> </li> </ul> <p>Specifying a valid ARN for this attribute is
474+
* required for Kinesis Data Firehose delivery stream subscriptions. For more
475+
* information, see <a
476+
* href="https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html">Fanout
477+
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer
478+
* Guide</i>.</p> </li> </ul>
369479
*/
370480
inline GetSubscriptionAttributesResult& AddAttributes(Aws::String&& key, const char* value) { m_attributes.emplace(std::move(key), value); return *this; }
371481

@@ -395,7 +505,17 @@ namespace Model
395505
* becomes unavailable) are held in the dead-letter queue for further analysis or
396506
* reprocessing.</p> </li> <li> <p> <code>SubscriptionArn</code> – The
397507
* subscription's ARN.</p> </li> <li> <p> <code>TopicArn</code> – The topic ARN
398-
* that the subscription is associated with.</p> </li> </ul>
508+
* that the subscription is associated with.</p> </li> </ul> <p>The following
509+
* attribute applies only to Amazon Kinesis Data Firehose delivery stream
510+
* subscriptions:</p> <ul> <li> <p> <code>SubscriptionRoleArn</code> – The ARN of
511+
* the IAM role that has the following:</p> <ul> <li> <p>Permission to write to the
512+
* Kinesis Data Firehose delivery stream</p> </li> <li> <p>Amazon SNS listed as a
513+
* trusted entity</p> </li> </ul> <p>Specifying a valid ARN for this attribute is
514+
* required for Kinesis Data Firehose delivery stream subscriptions. For more
515+
* information, see <a
516+
* href="https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html">Fanout
517+
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer
518+
* Guide</i>.</p> </li> </ul>
399519
*/
400520
inline GetSubscriptionAttributesResult& AddAttributes(const char* key, const char* value) { m_attributes.emplace(key, value); return *this; }
401521

0 commit comments

Comments
 (0)