Skip to content

Commit

Permalink
docs(client-firehose): Updates Amazon Firehose documentation for mess…
Browse files Browse the repository at this point in the history
…age regarding Enforcing Tags IAM Policy.
  • Loading branch information
awstools committed Mar 22, 2024
1 parent 671c5f3 commit 2f7ea8a
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 2 deletions.
3 changes: 3 additions & 0 deletions clients/client-firehose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@
AWS SDK for JavaScript Firehose Client for Node.js, Browser and React Native.

<fullname>Amazon Data Firehose</fullname>
<note>

<p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
</note>
<p>Amazon Data Firehose is a fully managed service that delivers real-time
streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
OpenSearch Service, Amazon Redshift, Splunk, and various other supportd
Expand Down
3 changes: 3 additions & 0 deletions clients/client-firehose/src/Firehose.ts
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,9 @@ export interface Firehose {

/**
* <fullname>Amazon Data Firehose</fullname>
* <note>
* <p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
* </note>
* <p>Amazon Data Firehose is a fully managed service that delivers real-time
* streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
* OpenSearch Service, Amazon Redshift, Splunk, and various other supportd
Expand Down
3 changes: 3 additions & 0 deletions clients/client-firehose/src/FirehoseClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,9 @@ export interface FirehoseClientResolvedConfig extends FirehoseClientResolvedConf

/**
* <fullname>Amazon Data Firehose</fullname>
* <note>
* <p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
* </note>
* <p>Amazon Data Firehose is a fully managed service that delivers real-time
* streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
* OpenSearch Service, Amazon Redshift, Splunk, and various other supportd
Expand Down
3 changes: 3 additions & 0 deletions clients/client-firehose/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
/* eslint-disable */
/**
* <fullname>Amazon Data Firehose</fullname>
* <note>
* <p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
* </note>
* <p>Amazon Data Firehose is a fully managed service that delivers real-time
* streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
* OpenSearch Service, Amazon Redshift, Splunk, and various other supportd
Expand Down
12 changes: 12 additions & 0 deletions clients/client-firehose/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3066,6 +3066,18 @@ export interface CreateDeliveryStreamInput {
* Cost Allocation Tags</a> in the Amazon Web Services Billing and Cost Management User
* Guide.</p>
* <p>You can specify up to 50 tags when creating a delivery stream.</p>
* <p>If you specify tags in the <code>CreateDeliveryStream</code> action, Amazon Data
* Firehose performs an additional authorization on the
* <code>firehose:TagDeliveryStream</code> action to verify if users have permissions to
* create tags. If you do not provide this permission, requests to create new Firehose
* delivery streams with IAM resource tags will fail with an
* <code>AccessDeniedException</code> such as following.</p>
* <p>
* <b>AccessDeniedException</b>
* </p>
* <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>
* <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>
* </p>
* @public
*/
Tags?: Tag[];
Expand Down
4 changes: 2 additions & 2 deletions codegen/sdk-codegen/aws-models/firehose.json
Original file line number Diff line number Diff line change
Expand Up @@ -1019,7 +1019,7 @@
"Tags": {
"target": "com.amazonaws.firehose#TagDeliveryStreamInputTagList",
"traits": {
"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>"
"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>"
}
},
"AmazonOpenSearchServerlessDestinationConfiguration": {
Expand Down Expand Up @@ -2614,7 +2614,7 @@
"name": "firehose"
},
"aws.protocols#awsJson1_1": {},
"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>",
"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>",
"smithy.api#title": "Amazon Kinesis Firehose",
"smithy.api#xmlNamespace": {
"uri": "http://firehose.amazonaws.com/doc/2015-08-04"
Expand Down

0 comments on commit 2f7ea8a

Please sign in to comment.