Skip to content

Commit 2f7ea8a

Browse files
author
awstools
committedMar 22, 2024
docs(client-firehose): Updates Amazon Firehose documentation for message regarding Enforcing Tags IAM Policy.
1 parent 671c5f3 commit 2f7ea8a

File tree

6 files changed

+26
-2
lines changed

6 files changed

+26
-2
lines changed
 

‎clients/client-firehose/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@
77
AWS SDK for JavaScript Firehose Client for Node.js, Browser and React Native.
88

99
<fullname>Amazon Data Firehose</fullname>
10+
<note>
1011

12+
<p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
13+
</note>
1114
<p>Amazon Data Firehose is a fully managed service that delivers real-time
1215
streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
1316
OpenSearch Service, Amazon Redshift, Splunk, and various other supportd

‎clients/client-firehose/src/Firehose.ts

+3
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,9 @@ export interface Firehose {
275275

276276
/**
277277
* <fullname>Amazon Data Firehose</fullname>
278+
* <note>
279+
* <p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
280+
* </note>
278281
* <p>Amazon Data Firehose is a fully managed service that delivers real-time
279282
* streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
280283
* OpenSearch Service, Amazon Redshift, Splunk, and various other supportd

‎clients/client-firehose/src/FirehoseClient.ts

+3
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,9 @@ export interface FirehoseClientResolvedConfig extends FirehoseClientResolvedConf
307307

308308
/**
309309
* <fullname>Amazon Data Firehose</fullname>
310+
* <note>
311+
* <p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
312+
* </note>
310313
* <p>Amazon Data Firehose is a fully managed service that delivers real-time
311314
* streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
312315
* OpenSearch Service, Amazon Redshift, Splunk, and various other supportd

‎clients/client-firehose/src/index.ts

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
/* eslint-disable */
33
/**
44
* <fullname>Amazon Data Firehose</fullname>
5+
* <note>
6+
* <p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
7+
* </note>
58
* <p>Amazon Data Firehose is a fully managed service that delivers real-time
69
* streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
710
* OpenSearch Service, Amazon Redshift, Splunk, and various other supportd

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

+12
Original file line numberDiff line numberDiff line change
@@ -3066,6 +3066,18 @@ export interface CreateDeliveryStreamInput {
30663066
* Cost Allocation Tags</a> in the Amazon Web Services Billing and Cost Management User
30673067
* Guide.</p>
30683068
* <p>You can specify up to 50 tags when creating a delivery stream.</p>
3069+
* <p>If you specify tags in the <code>CreateDeliveryStream</code> action, Amazon Data
3070+
* Firehose performs an additional authorization on the
3071+
* <code>firehose:TagDeliveryStream</code> action to verify if users have permissions to
3072+
* create tags. If you do not provide this permission, requests to create new Firehose
3073+
* delivery streams with IAM resource tags will fail with an
3074+
* <code>AccessDeniedException</code> such as following.</p>
3075+
* <p>
3076+
* <b>AccessDeniedException</b>
3077+
* </p>
3078+
* <p>User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.</p>
3079+
* <p>For an example IAM policy, see <a href="https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples">Tag example.</a>
3080+
* </p>
30693081
* @public
30703082
*/
30713083
Tags?: Tag[];

‎codegen/sdk-codegen/aws-models/firehose.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1019,7 +1019,7 @@
10191019
"Tags": {
10201020
"target": "com.amazonaws.firehose#TagDeliveryStreamInputTagList",
10211021
"traits": {
1022-
"smithy.api#documentation": "<p>A set of tags to assign to the delivery stream. A tag is a key-value pair that you can\n define and assign to Amazon Web Services resources. Tags are metadata. For example, you can\n add friendly names and descriptions or other types of information that can help you\n distinguish the delivery stream. For more information about tags, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Using\n Cost Allocation Tags</a> in the Amazon Web Services Billing and Cost Management User\n Guide.</p>\n <p>You can specify up to 50 tags when creating a delivery stream.</p>"
1022+
"smithy.api#documentation": "<p>A set of tags to assign to the delivery stream. A tag is a key-value pair that you can\n define and assign to Amazon Web Services resources. Tags are metadata. For example, you can\n add friendly names and descriptions or other types of information that can help you\n distinguish the delivery stream. For more information about tags, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Using\n Cost Allocation Tags</a> in the Amazon Web Services Billing and Cost Management User\n Guide.</p>\n <p>You can specify up to 50 tags when creating a delivery stream.</p>\n <p>If you specify tags in the <code>CreateDeliveryStream</code> action, Amazon Data\n Firehose performs an additional authorization on the\n <code>firehose:TagDeliveryStream</code> action to verify if users have permissions to\n create tags. If you do not provide this permission, requests to create new Firehose\n delivery streams with IAM resource tags will fail with an\n <code>AccessDeniedException</code> such as following.</p>\n <p>\n <b>AccessDeniedException</b>\n </p>\n <p>User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.</p>\n <p>For an example IAM policy, see <a href=\"https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples\">Tag example.</a>\n </p>"
10231023
}
10241024
},
10251025
"AmazonOpenSearchServerlessDestinationConfiguration": {
@@ -2614,7 +2614,7 @@
26142614
"name": "firehose"
26152615
},
26162616
"aws.protocols#awsJson1_1": {},
2617-
"smithy.api#documentation": "<fullname>Amazon Data Firehose</fullname>\n <p>Amazon Data Firehose is a fully managed service that delivers real-time\n streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon\n OpenSearch Service, Amazon Redshift, Splunk, and various other supportd\n destinations.</p>",
2617+
"smithy.api#documentation": "<fullname>Amazon Data Firehose</fullname>\n <note>\n <p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>\n </note>\n <p>Amazon Data Firehose is a fully managed service that delivers real-time\n streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon\n OpenSearch Service, Amazon Redshift, Splunk, and various other supportd\n destinations.</p>",
26182618
"smithy.api#title": "Amazon Kinesis Firehose",
26192619
"smithy.api#xmlNamespace": {
26202620
"uri": "http://firehose.amazonaws.com/doc/2015-08-04"

0 commit comments

Comments
 (0)
Please sign in to comment.