Skip to content

Commit 85a220c

Browse files
author
awstools
committed
docs(client-cloudfront): Doc only update for CloudFront that fixes customer-reported issue
1 parent c8b653f commit 85a220c

File tree

5 files changed

+12
-11
lines changed

5 files changed

+12
-11
lines changed

Diff for: clients/client-cloudfront/src/commands/ListTagsForResourceCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ
2828
export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResult, __MetadataBearer {}
2929

3030
/**
31-
* <p>List tags for a CloudFront resource.</p>
31+
* <p>List tags for a CloudFront resource. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tagging.html">Tagging a distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

Diff for: clients/client-cloudfront/src/commands/TagResourceCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface TagResourceCommandInput extends TagResourceRequest {}
2828
export interface TagResourceCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Add tags to a CloudFront resource.</p>
31+
* <p>Add tags to a CloudFront resource. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tagging.html">Tagging a distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

Diff for: clients/client-cloudfront/src/commands/UntagResourceCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {}
2828
export interface UntagResourceCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Remove tags from a CloudFront resource.</p>
31+
* <p>Remove tags from a CloudFront resource. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tagging.html">Tagging a distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

Diff for: clients/client-cloudfront/src/models/models_0.ts

+4-3
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ export interface CachedMethods {
294294

295295
/**
296296
* <p>A complex type that contains the HTTP methods that you want CloudFront to cache responses
297-
* to.</p>
297+
* to. Valid values for <code>CachedMethods</code> include <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code>, depending on which caching option you choose. For more information, see the preceding section.</p>
298298
* @public
299299
*/
300300
Items: Method[] | undefined;
@@ -944,8 +944,9 @@ export type ViewerProtocolPolicy = (typeof ViewerProtocolPolicy)[keyof typeof Vi
944944
* you can add to a distribution, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> in the
945945
* <i>Amazon CloudFront Developer Guide</i>.</p>
946946
* <p>If you don't want to specify any cache behaviors, include only an empty
947-
* <code>CacheBehaviors</code> element. For more information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CacheBehaviors.html">CacheBehaviors</a>. Don't include an empty
948-
* <code>CacheBehavior</code> element because this is invalid.</p>
947+
* <code>CacheBehaviors</code> element. Don't specify an empty individual
948+
* <code>CacheBehavior</code> element, because this is invalid. For more information,
949+
* see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CacheBehaviors.html">CacheBehaviors</a>. </p>
949950
* <p>To delete all cache behaviors in an existing distribution, update the distribution
950951
* configuration and include only an empty <code>CacheBehaviors</code> element.</p>
951952
* <p>To add, change, or remove one or more cache behaviors, update the distribution

Diff for: codegen/sdk-codegen/aws-models/cloudfront.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,7 @@
434434
}
435435
},
436436
"traits": {
437-
"smithy.api#documentation": "<p>A complex type that describes how CloudFront processes requests.</p>\n <p>You must create at least as many cache behaviors (including the default cache\n\t\t\tbehavior) as you have origins if you want CloudFront to serve objects from all of the origins.\n\t\t\tEach cache behavior specifies the one origin from which you want CloudFront to get objects. If\n\t\t\tyou have two origins and only the default cache behavior, the default cache behavior\n\t\t\twill cause CloudFront to get objects from one of the origins, but the other origin is never\n\t\t\tused.</p>\n <p>For the current quota (formerly known as limit) on the number of cache behaviors that\n\t\t\tyou can add to a distribution, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html\">Quotas</a> in the\n\t\t\t<i>Amazon CloudFront Developer Guide</i>.</p>\n <p>If you don't want to specify any cache behaviors, include only an empty\n\t\t\t<code>CacheBehaviors</code> element. For more information, see <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CacheBehaviors.html\">CacheBehaviors</a>. Don't include an empty\n\t\t\t\t<code>CacheBehavior</code> element because this is invalid.</p>\n <p>To delete all cache behaviors in an existing distribution, update the distribution\n\t\t\tconfiguration and include only an empty <code>CacheBehaviors</code> element.</p>\n <p>To add, change, or remove one or more cache behaviors, update the distribution\n\t\t\tconfiguration and specify all of the cache behaviors that you want to include in the\n\t\t\tupdated distribution.</p>\n <p>For more information about cache behaviors, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior\">Cache Behavior Settings</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
437+
"smithy.api#documentation": "<p>A complex type that describes how CloudFront processes requests.</p>\n <p>You must create at least as many cache behaviors (including the default cache\n\t\t\tbehavior) as you have origins if you want CloudFront to serve objects from all of the origins.\n\t\t\tEach cache behavior specifies the one origin from which you want CloudFront to get objects. If\n\t\t\tyou have two origins and only the default cache behavior, the default cache behavior\n\t\t\twill cause CloudFront to get objects from one of the origins, but the other origin is never\n\t\t\tused.</p>\n <p>For the current quota (formerly known as limit) on the number of cache behaviors that\n\t\t\tyou can add to a distribution, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html\">Quotas</a> in the\n\t\t\t<i>Amazon CloudFront Developer Guide</i>.</p>\n <p>If you don't want to specify any cache behaviors, include only an empty\n\t\t\t\t<code>CacheBehaviors</code> element. Don't specify an empty individual\n\t\t\t\t<code>CacheBehavior</code> element, because this is invalid. For more information,\n\t\t\tsee <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CacheBehaviors.html\">CacheBehaviors</a>. </p>\n <p>To delete all cache behaviors in an existing distribution, update the distribution\n\t\t\tconfiguration and include only an empty <code>CacheBehaviors</code> element.</p>\n <p>To add, change, or remove one or more cache behaviors, update the distribution\n\t\t\tconfiguration and specify all of the cache behaviors that you want to include in the\n\t\t\tupdated distribution.</p>\n <p>For more information about cache behaviors, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior\">Cache Behavior Settings</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
438438
}
439439
},
440440
"com.amazonaws.cloudfront#CacheBehaviorList": {
@@ -795,7 +795,7 @@
795795
"Items": {
796796
"target": "com.amazonaws.cloudfront#MethodsList",
797797
"traits": {
798-
"smithy.api#documentation": "<p>A complex type that contains the HTTP methods that you want CloudFront to cache responses\n\t\t\tto.</p>",
798+
"smithy.api#documentation": "<p>A complex type that contains the HTTP methods that you want CloudFront to cache responses\n\t\t\tto. Valid values for <code>CachedMethods</code> include <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code>, depending on which caching option you choose. For more information, see the preceding section.</p>",
799799
"smithy.api#required": {}
800800
}
801801
}
@@ -12307,7 +12307,7 @@
1230712307
}
1230812308
],
1230912309
"traits": {
12310-
"smithy.api#documentation": "<p>List tags for a CloudFront resource.</p>",
12310+
"smithy.api#documentation": "<p>List tags for a CloudFront resource. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tagging.html\">Tagging a distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
1231112311
"smithy.api#http": {
1231212312
"method": "GET",
1231312313
"uri": "/2020-05-31/tagging",
@@ -15810,7 +15810,7 @@
1581015810
}
1581115811
],
1581215812
"traits": {
15813-
"smithy.api#documentation": "<p>Add tags to a CloudFront resource.</p>",
15813+
"smithy.api#documentation": "<p>Add tags to a CloudFront resource. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tagging.html\">Tagging a distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
1581415814
"smithy.api#http": {
1581515815
"method": "POST",
1581615816
"uri": "/2020-05-31/tagging?Operation=Tag",
@@ -16835,7 +16835,7 @@
1683516835
}
1683616836
],
1683716837
"traits": {
16838-
"smithy.api#documentation": "<p>Remove tags from a CloudFront resource.</p>",
16838+
"smithy.api#documentation": "<p>Remove tags from a CloudFront resource. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tagging.html\">Tagging a distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
1683916839
"smithy.api#http": {
1684016840
"method": "POST",
1684116841
"uri": "/2020-05-31/tagging?Operation=Untag",

0 commit comments

Comments
 (0)