/
docs-2.json
4016 lines (4016 loc) · 373 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version": "2.0",
"service": "<fullname>Amazon CloudFront</fullname> <p>This is the <i>Amazon CloudFront API Reference</i>. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the <i>Amazon CloudFront Developer Guide</i>.</p>",
"operations": {
"AssociateAlias": "<p>Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.</p> <p>With this operation you can move an alias that’s already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.</p> <p>To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-move\">Moving an alternate domain name to a different distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"CreateCachePolicy": "<p>Creates a cache policy.</p> <p>After you create a cache policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the cache policy determines the following:</p> <ul> <li> <p>The values that CloudFront includes in the <i>cache key</i>. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.</p> </li> <li> <p>The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.</p> </li> </ul> <p>The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find an object in its cache that matches the request’s cache key. If you want to send values to the origin but <i>not</i> include them in the cache key, use <code>OriginRequestPolicy</code>.</p> <p>For more information about cache policies, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html\">Controlling the cache key</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"CreateCloudFrontOriginAccessIdentity": "<p>Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"CreateDistribution": "<p>Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a <code>POST</code> request to the <code>/<i>CloudFront API version</i>/distribution</code>/<code>distribution ID</code> resource.</p> <important> <p>When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html\">UpdateDistribution</a>, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-overview-required-fields.html\">Required Fields for Create Distribution and Update Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </important>",
"CreateDistributionWithTags": "<p>Create a new distribution with tags.</p>",
"CreateFieldLevelEncryptionConfig": "<p>Create a new field-level encryption configuration.</p>",
"CreateFieldLevelEncryptionProfile": "<p>Create a field-level encryption profile.</p>",
"CreateFunction": "<p>Creates a CloudFront function.</p> <p>To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function.</p> <p>When you create a function, it’s in the <code>DEVELOPMENT</code> stage. In this stage, you can test the function with <code>TestFunction</code>, and update it with <code>UpdateFunction</code>.</p> <p>When you’re ready to use your function with a CloudFront distribution, use <code>PublishFunction</code> to copy the function from the <code>DEVELOPMENT</code> stage to <code>LIVE</code>. When it’s live, you can attach the function to a distribution’s cache behavior, using the function’s ARN.</p>",
"CreateInvalidation": "<p>Create a new invalidation. </p>",
"CreateKeyGroup": "<p>Creates a key group that you can use with <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">CloudFront signed URLs and signed cookies</a>.</p> <p>To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving private content</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"CreateMonitoringSubscription": "<p>Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/viewing-cloudfront-metrics.html#monitoring-console.distributions-additional\">Viewing additional CloudFront distribution metrics</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"CreateOriginAccessControl": "<p>Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.</p> <p>For an Amazon S3 origin, this makes it possible to block public access to the Amazon S3 bucket so that viewers (users) can access the content in the bucket only through CloudFront.</p> <p>For more information about using a CloudFront origin access control, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html\">Restricting access to an Amazon S3 origin</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"CreateOriginRequestPolicy": "<p>Creates an origin request policy.</p> <p>After you create an origin request policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:</p> <ul> <li> <p>The request body and the URL path (without the domain name) from the viewer request.</p> </li> <li> <p>The headers that CloudFront automatically includes in every origin request, including <code>Host</code>, <code>User-Agent</code>, and <code>X-Amz-Cf-Id</code>.</p> </li> <li> <p>All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.</p> </li> </ul> <p>CloudFront sends a request when it can’t find a valid object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use <code>CachePolicy</code>.</p> <p>For more information about origin request policies, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html\">Controlling origin requests</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"CreatePublicKey": "<p>Uploads a public key to CloudFront that you can use with <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">signed URLs and signed cookies</a>, or with <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html\">field-level encryption</a>.</p>",
"CreateRealtimeLogConfig": "<p>Creates a real-time log configuration.</p> <p>After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream.</p> <p>For more information about real-time log configurations, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html\">Real-time logs</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"CreateResponseHeadersPolicy": "<p>Creates a response headers policy.</p> <p>A response headers policy contains information about a set of HTTP response headers and their values. To create a response headers policy, you provide some metadata about the policy, and a set of configurations that specify the response headers.</p> <p>After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it’s attached to a cache behavior, CloudFront adds the headers in the policy to HTTP responses that it sends for requests that match the cache behavior.</p>",
"CreateStreamingDistribution": "<p>This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, <a href=\"http://forums.aws.amazon.com/ann.jspa?annID=7356\">read the announcement</a> on the Amazon CloudFront discussion forum.</p>",
"CreateStreamingDistributionWithTags": "<p>This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, <a href=\"http://forums.aws.amazon.com/ann.jspa?annID=7356\">read the announcement</a> on the Amazon CloudFront discussion forum.</p>",
"DeleteCachePolicy": "<p>Deletes a cache policy.</p> <p>You cannot delete a cache policy if it’s attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy.</p> <p>To delete a cache policy, you must provide the policy’s identifier and version. To get these values, you can use <code>ListCachePolicies</code> or <code>GetCachePolicy</code>.</p>",
"DeleteCloudFrontOriginAccessIdentity": "<p>Delete an origin access identity. </p>",
"DeleteDistribution": "<p>Delete a distribution. </p>",
"DeleteFieldLevelEncryptionConfig": "<p>Remove a field-level encryption configuration.</p>",
"DeleteFieldLevelEncryptionProfile": "<p>Remove a field-level encryption profile.</p>",
"DeleteFunction": "<p>Deletes a CloudFront function.</p> <p>You cannot delete a function if it’s associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function.</p> <p>To delete a function, you must provide the function’s name and version (<code>ETag</code> value). To get these values, you can use <code>ListFunctions</code> and <code>DescribeFunction</code>.</p>",
"DeleteKeyGroup": "<p>Deletes a key group.</p> <p>You cannot delete a key group that is referenced in a cache behavior. First update your distributions to remove the key group from all cache behaviors, then delete the key group.</p> <p>To delete a key group, you must provide the key group’s identifier and version. To get these values, use <code>ListKeyGroups</code> followed by <code>GetKeyGroup</code> or <code>GetKeyGroupConfig</code>.</p>",
"DeleteMonitoringSubscription": "<p>Disables additional CloudWatch metrics for the specified CloudFront distribution.</p>",
"DeleteOriginAccessControl": "<p>Deletes a CloudFront origin access control.</p> <p>You cannot delete an origin access control if it's in use. First, update all distributions to remove the origin access control from all origins, then delete the origin access control.</p>",
"DeleteOriginRequestPolicy": "<p>Deletes an origin request policy.</p> <p>You cannot delete an origin request policy if it’s attached to any cache behaviors. First update your distributions to remove the origin request policy from all cache behaviors, then delete the origin request policy.</p> <p>To delete an origin request policy, you must provide the policy’s identifier and version. To get the identifier, you can use <code>ListOriginRequestPolicies</code> or <code>GetOriginRequestPolicy</code>.</p>",
"DeletePublicKey": "<p>Remove a public key you previously added to CloudFront.</p>",
"DeleteRealtimeLogConfig": "<p>Deletes a real-time log configuration.</p> <p>You cannot delete a real-time log configuration if it’s attached to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors, then delete the real-time log configuration.</p> <p>To delete a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to delete.</p>",
"DeleteResponseHeadersPolicy": "<p>Deletes a response headers policy.</p> <p>You cannot delete a response headers policy if it’s attached to a cache behavior. First update your distributions to remove the response headers policy from all cache behaviors, then delete the response headers policy.</p> <p>To delete a response headers policy, you must provide the policy’s identifier and version. To get these values, you can use <code>ListResponseHeadersPolicies</code> or <code>GetResponseHeadersPolicy</code>. </p>",
"DeleteStreamingDistribution": "<p>Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.</p> <p> <b>To delete an RTMP distribution using the CloudFront API</b>:</p> <ol> <li> <p>Disable the RTMP distribution.</p> </li> <li> <p>Submit a <code>GET Streaming Distribution Config</code> request to get the current configuration and the <code>Etag</code> header for the distribution. </p> </li> <li> <p>Update the XML document that was returned in the response to your <code>GET Streaming Distribution Config</code> request to change the value of <code>Enabled</code> to <code>false</code>.</p> </li> <li> <p>Submit a <code>PUT Streaming Distribution Config</code> request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Streaming Distribution Config</code> request in Step 2.</p> </li> <li> <p>Review the response to the <code>PUT Streaming Distribution Config</code> request to confirm that the distribution was successfully disabled.</p> </li> <li> <p>Submit a <code>GET Streaming Distribution Config</code> request to confirm that your changes have propagated. When propagation is complete, the value of <code>Status</code> is <code>Deployed</code>.</p> </li> <li> <p>Submit a <code>DELETE Streaming Distribution</code> request. Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Streaming Distribution Config</code> request in Step 2.</p> </li> <li> <p>Review the response to your <code>DELETE Streaming Distribution</code> request to confirm that the distribution was successfully deleted.</p> </li> </ol> <p>For information about deleting a distribution using the CloudFront console, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html\">Deleting a Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"DescribeFunction": "<p>Gets configuration information and metadata about a CloudFront function, but not the function’s code. To get a function’s code, use <code>GetFunction</code>.</p> <p>To get configuration information and metadata about a function, you must provide the function’s name and stage. To get these values, you can use <code>ListFunctions</code>.</p>",
"GetCachePolicy": "<p>Gets a cache policy, including the following metadata:</p> <ul> <li> <p>The policy’s identifier.</p> </li> <li> <p>The date and time when the policy was last modified.</p> </li> </ul> <p>To get a cache policy, you must provide the policy’s identifier. If the cache policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using <code>ListDistributions</code> or <code>GetDistribution</code>. If the cache policy is not attached to a cache behavior, you can get the identifier using <code>ListCachePolicies</code>.</p>",
"GetCachePolicyConfig": "<p>Gets a cache policy configuration.</p> <p>To get a cache policy configuration, you must provide the policy’s identifier. If the cache policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using <code>ListDistributions</code> or <code>GetDistribution</code>. If the cache policy is not attached to a cache behavior, you can get the identifier using <code>ListCachePolicies</code>.</p>",
"GetCloudFrontOriginAccessIdentity": "<p>Get the information about an origin access identity. </p>",
"GetCloudFrontOriginAccessIdentityConfig": "<p>Get the configuration information about an origin access identity. </p>",
"GetDistribution": "<p>Get the information about a distribution.</p>",
"GetDistributionConfig": "<p>Get the configuration information about a distribution. </p>",
"GetFieldLevelEncryption": "<p>Get the field-level encryption configuration information.</p>",
"GetFieldLevelEncryptionConfig": "<p>Get the field-level encryption configuration information.</p>",
"GetFieldLevelEncryptionProfile": "<p>Get the field-level encryption profile information.</p>",
"GetFieldLevelEncryptionProfileConfig": "<p>Get the field-level encryption profile configuration information.</p>",
"GetFunction": "<p>Gets the code of a CloudFront function. To get configuration information and metadata about a function, use <code>DescribeFunction</code>.</p> <p>To get a function’s code, you must provide the function’s name and stage. To get these values, you can use <code>ListFunctions</code>.</p>",
"GetInvalidation": "<p>Get the information about an invalidation. </p>",
"GetKeyGroup": "<p>Gets a key group, including the date and time when the key group was last modified.</p> <p>To get a key group, you must provide the key group’s identifier. If the key group is referenced in a distribution’s cache behavior, you can get the key group’s identifier using <code>ListDistributions</code> or <code>GetDistribution</code>. If the key group is not referenced in a cache behavior, you can get the identifier using <code>ListKeyGroups</code>.</p>",
"GetKeyGroupConfig": "<p>Gets a key group configuration.</p> <p>To get a key group configuration, you must provide the key group’s identifier. If the key group is referenced in a distribution’s cache behavior, you can get the key group’s identifier using <code>ListDistributions</code> or <code>GetDistribution</code>. If the key group is not referenced in a cache behavior, you can get the identifier using <code>ListKeyGroups</code>.</p>",
"GetMonitoringSubscription": "<p>Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.</p>",
"GetOriginAccessControl": "<p>Gets a CloudFront origin access control, including its unique identifier.</p>",
"GetOriginAccessControlConfig": "<p>Gets a CloudFront origin access control configuration.</p>",
"GetOriginRequestPolicy": "<p>Gets an origin request policy, including the following metadata:</p> <ul> <li> <p>The policy’s identifier.</p> </li> <li> <p>The date and time when the policy was last modified.</p> </li> </ul> <p>To get an origin request policy, you must provide the policy’s identifier. If the origin request policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using <code>ListDistributions</code> or <code>GetDistribution</code>. If the origin request policy is not attached to a cache behavior, you can get the identifier using <code>ListOriginRequestPolicies</code>.</p>",
"GetOriginRequestPolicyConfig": "<p>Gets an origin request policy configuration.</p> <p>To get an origin request policy configuration, you must provide the policy’s identifier. If the origin request policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using <code>ListDistributions</code> or <code>GetDistribution</code>. If the origin request policy is not attached to a cache behavior, you can get the identifier using <code>ListOriginRequestPolicies</code>.</p>",
"GetPublicKey": "<p>Gets a public key.</p>",
"GetPublicKeyConfig": "<p>Gets a public key configuration.</p>",
"GetRealtimeLogConfig": "<p>Gets a real-time log configuration.</p> <p>To get a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to get.</p>",
"GetResponseHeadersPolicy": "<p>Gets a response headers policy, including metadata (the policy’s identifier and the date and time when the policy was last modified).</p> <p>To get a response headers policy, you must provide the policy’s identifier. If the response headers policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using <code>ListDistributions</code> or <code>GetDistribution</code>. If the response headers policy is not attached to a cache behavior, you can get the identifier using <code>ListResponseHeadersPolicies</code>.</p>",
"GetResponseHeadersPolicyConfig": "<p>Gets a response headers policy configuration.</p> <p>To get a response headers policy configuration, you must provide the policy’s identifier. If the response headers policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using <code>ListDistributions</code> or <code>GetDistribution</code>. If the response headers policy is not attached to a cache behavior, you can get the identifier using <code>ListResponseHeadersPolicies</code>.</p>",
"GetStreamingDistribution": "<p>Gets information about a specified RTMP distribution, including the distribution configuration.</p>",
"GetStreamingDistributionConfig": "<p>Get the configuration information about a streaming distribution. </p>",
"ListCachePolicies": "<p>Gets a list of cache policies.</p> <p>You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.</p> <p>You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <code>NextMarker</code> value from the current response as the <code>Marker</code> value in the subsequent request.</p>",
"ListCloudFrontOriginAccessIdentities": "<p>Lists origin access identities.</p>",
"ListConflictingAliases": "<p>Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don’t own.</p> <p>Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided alias. For example, if you provide <code>www.example.com</code> as input, the returned list can include <code>www.example.com</code> and the overlapping wildcard alternate domain name (<code>*.example.com</code>), if they exist. If you provide <code>*.example.com</code> as input, the returned list can include <code>*.example.com</code> and any alternate domain names covered by that wildcard (for example, <code>www.example.com</code>, <code>test.example.com</code>, <code>dev.example.com</code>, and so on), if they exist.</p> <p>To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-move\">Moving an alternate domain name to a different distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <code>NextMarker</code> value from the current response as the <code>Marker</code> value in the subsequent request.</p>",
"ListDistributions": "<p>List CloudFront distributions.</p>",
"ListDistributionsByCachePolicyId": "<p>Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified cache policy.</p> <p>You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <code>NextMarker</code> value from the current response as the <code>Marker</code> value in the subsequent request.</p>",
"ListDistributionsByKeyGroup": "<p>Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.</p> <p>You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <code>NextMarker</code> value from the current response as the <code>Marker</code> value in the subsequent request.</p>",
"ListDistributionsByOriginRequestPolicyId": "<p>Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified origin request policy.</p> <p>You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <code>NextMarker</code> value from the current response as the <code>Marker</code> value in the subsequent request.</p>",
"ListDistributionsByRealtimeLogConfig": "<p>Gets a list of distributions that have a cache behavior that’s associated with the specified real-time log configuration.</p> <p>You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.</p> <p>You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <code>NextMarker</code> value from the current response as the <code>Marker</code> value in the subsequent request. </p>",
"ListDistributionsByResponseHeadersPolicyId": "<p>Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified response headers policy.</p> <p>You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <code>NextMarker</code> value from the current response as the <code>Marker</code> value in the subsequent request.</p>",
"ListDistributionsByWebACLId": "<p>List the distributions that are associated with a specified WAF web ACL.</p>",
"ListFieldLevelEncryptionConfigs": "<p>List all field-level encryption configurations that have been created in CloudFront for this account.</p>",
"ListFieldLevelEncryptionProfiles": "<p>Request a list of field-level encryption profiles that have been created in CloudFront for this account.</p>",
"ListFunctions": "<p>Gets a list of all CloudFront functions in your Amazon Web Services account.</p> <p>You can optionally apply a filter to return only the functions that are in the specified stage, either <code>DEVELOPMENT</code> or <code>LIVE</code>.</p> <p>You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <code>NextMarker</code> value from the current response as the <code>Marker</code> value in the subsequent request.</p>",
"ListInvalidations": "<p>Lists invalidation batches. </p>",
"ListKeyGroups": "<p>Gets a list of key groups.</p> <p>You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <code>NextMarker</code> value from the current response as the <code>Marker</code> value in the subsequent request.</p>",
"ListOriginAccessControls": "<p>Gets the list of CloudFront origin access controls in this Amazon Web Services account.</p> <p>You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send another request that specifies the <code>NextMarker</code> value from the current response as the <code>Marker</code> value in the next request.</p>",
"ListOriginRequestPolicies": "<p>Gets a list of origin request policies.</p> <p>You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.</p> <p>You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <code>NextMarker</code> value from the current response as the <code>Marker</code> value in the subsequent request.</p>",
"ListPublicKeys": "<p>List all public keys that have been added to CloudFront for this account.</p>",
"ListRealtimeLogConfigs": "<p>Gets a list of real-time log configurations.</p> <p>You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <code>NextMarker</code> value from the current response as the <code>Marker</code> value in the subsequent request. </p>",
"ListResponseHeadersPolicies": "<p>Gets a list of response headers policies.</p> <p>You can optionally apply a filter to get only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.</p> <p>You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <code>NextMarker</code> value from the current response as the <code>Marker</code> value in the subsequent request.</p>",
"ListStreamingDistributions": "<p>List streaming distributions. </p>",
"ListTagsForResource": "<p>List tags for a CloudFront resource.</p>",
"PublishFunction": "<p>Publishes a CloudFront function by copying the function code from the <code>DEVELOPMENT</code> stage to <code>LIVE</code>. This automatically updates all cache behaviors that are using this function to use the newly published copy in the <code>LIVE</code> stage.</p> <p>When a function is published to the <code>LIVE</code> stage, you can attach the function to a distribution’s cache behavior, using the function’s Amazon Resource Name (ARN).</p> <p>To publish a function, you must provide the function’s name and version (<code>ETag</code> value). To get these values, you can use <code>ListFunctions</code> and <code>DescribeFunction</code>.</p>",
"TagResource": "<p>Add tags to a CloudFront resource.</p>",
"TestFunction": "<p>Tests a CloudFront function.</p> <p>To test a function, you provide an <i>event object</i> that represents an HTTP request or response that your CloudFront distribution could receive in production. CloudFront runs the function, passing it the event object that you provided, and returns the function’s result (the modified event object) in the response. The response also contains function logs and error messages, if any exist. For more information about testing functions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managing-functions.html#test-function\">Testing functions</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>To test a function, you provide the function’s name and version (<code>ETag</code> value) along with the event object. To get the function’s name and version, you can use <code>ListFunctions</code> and <code>DescribeFunction</code>.</p>",
"UntagResource": "<p>Remove tags from a CloudFront resource.</p>",
"UpdateCachePolicy": "<p>Updates a cache policy configuration.</p> <p>When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:</p> <ol> <li> <p>Use <code>GetCachePolicyConfig</code> to get the current configuration.</p> </li> <li> <p>Locally modify the fields in the cache policy configuration that you want to update.</p> </li> <li> <p>Call <code>UpdateCachePolicy</code> by providing the entire cache policy configuration, including the fields that you modified and those that you didn’t.</p> </li> </ol>",
"UpdateCloudFrontOriginAccessIdentity": "<p>Update an origin access identity. </p>",
"UpdateDistribution": "<p>Updates the configuration for a web distribution. </p> <important> <p>When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-overview-required-fields.html\">Required Fields for Create Distribution and Update Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </important> <p>The update process includes getting the current distribution configuration, updating the XML document that is returned to make your changes, and then submitting an <code>UpdateDistribution</code> request to make the updates.</p> <p>For information about updating a distribution using the CloudFront console instead, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-creating-console.html\">Creating a Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p> <b>To update a web distribution using the CloudFront API</b> </p> <ol> <li> <p>Submit a <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistributionConfig.html\">GetDistributionConfig</a> request to get the current configuration and an <code>Etag</code> header for the distribution.</p> <note> <p>If you update the distribution again, you must get a new <code>Etag</code> header.</p> </note> </li> <li> <p>Update the XML document that was returned in the response to your <code>GetDistributionConfig</code> request to include your changes. </p> <important> <p>When you edit the XML file, be aware of the following:</p> <ul> <li> <p>You must strip out the ETag parameter that is returned.</p> </li> <li> <p>Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution.</p> </li> <li> <p>You can't change the value of <code>CallerReference</code>. If you try to change this value, CloudFront returns an <code>IllegalUpdate</code> error. </p> </li> <li> <p>The new configuration replaces the existing configuration; the values that you specify in an <code>UpdateDistribution</code> request are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, <code>CNAME</code>), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding <code>Quantity</code> element.</p> </li> </ul> </important> </li> <li> <p>Submit an <code>UpdateDistribution</code> request to update the configuration for your distribution:</p> <ul> <li> <p>In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a <code>DistributionConfig</code> element.</p> </li> <li> <p>Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GetDistributionConfig</code> request in Step 1.</p> </li> </ul> </li> <li> <p>Review the response to the <code>UpdateDistribution</code> request to confirm that the configuration was successfully updated.</p> </li> <li> <p>Optional: Submit a <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistribution.html\">GetDistribution</a> request to confirm that your changes have propagated. When propagation is complete, the value of <code>Status</code> is <code>Deployed</code>.</p> </li> </ol>",
"UpdateFieldLevelEncryptionConfig": "<p>Update a field-level encryption configuration. </p>",
"UpdateFieldLevelEncryptionProfile": "<p>Update a field-level encryption profile. </p>",
"UpdateFunction": "<p>Updates a CloudFront function.</p> <p>You can update a function’s code or the comment that describes the function. You cannot update a function’s name.</p> <p>To update a function, you provide the function’s name and version (<code>ETag</code> value) along with the updated function code. To get the name and version, you can use <code>ListFunctions</code> and <code>DescribeFunction</code>.</p>",
"UpdateKeyGroup": "<p>Updates a key group.</p> <p>When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group:</p> <ol> <li> <p>Get the current key group with <code>GetKeyGroup</code> or <code>GetKeyGroupConfig</code>.</p> </li> <li> <p>Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.</p> </li> <li> <p>Call <code>UpdateKeyGroup</code> with the entire key group object, including the fields that you modified and those that you didn’t.</p> </li> </ol>",
"UpdateOriginAccessControl": "<p>Updates a CloudFront origin access control.</p>",
"UpdateOriginRequestPolicy": "<p>Updates an origin request policy configuration.</p> <p>When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration:</p> <ol> <li> <p>Use <code>GetOriginRequestPolicyConfig</code> to get the current configuration.</p> </li> <li> <p>Locally modify the fields in the origin request policy configuration that you want to update.</p> </li> <li> <p>Call <code>UpdateOriginRequestPolicy</code> by providing the entire origin request policy configuration, including the fields that you modified and those that you didn’t.</p> </li> </ol>",
"UpdatePublicKey": "<p>Update public key information. Note that the only value you can change is the comment.</p>",
"UpdateRealtimeLogConfig": "<p>Updates a real-time log configuration.</p> <p>When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:</p> <ol> <li> <p>Call <code>GetRealtimeLogConfig</code> to get the current real-time log configuration.</p> </li> <li> <p>Locally modify the parameters in the real-time log configuration that you want to update.</p> </li> <li> <p>Call this API (<code>UpdateRealtimeLogConfig</code>) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn’t.</p> </li> </ol> <p>You cannot update a real-time log configuration’s <code>Name</code> or <code>ARN</code>.</p>",
"UpdateResponseHeadersPolicy": "<p>Updates a response headers policy.</p> <p>When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration:</p> <ol> <li> <p>Use <code>GetResponseHeadersPolicyConfig</code> to get the current policy’s configuration.</p> </li> <li> <p>Modify the fields in the response headers policy configuration that you want to update.</p> </li> <li> <p>Call <code>UpdateResponseHeadersPolicy</code>, providing the entire response headers policy configuration, including the fields that you modified and those that you didn’t.</p> </li> </ol>",
"UpdateStreamingDistribution": "<p>Update a streaming distribution. </p>"
},
"shapes": {
"AccessControlAllowHeadersList": {
"base": null,
"refs": {
"ResponseHeadersPolicyAccessControlAllowHeaders$Items": "<p>The list of HTTP header names. You can specify <code>*</code> to allow all headers.</p>"
}
},
"AccessControlAllowMethodsList": {
"base": null,
"refs": {
"ResponseHeadersPolicyAccessControlAllowMethods$Items": "<p>The list of HTTP methods. Valid values are:</p> <ul> <li> <p> <code>GET</code> </p> </li> <li> <p> <code>DELETE</code> </p> </li> <li> <p> <code>HEAD</code> </p> </li> <li> <p> <code>OPTIONS</code> </p> </li> <li> <p> <code>PATCH</code> </p> </li> <li> <p> <code>POST</code> </p> </li> <li> <p> <code>PUT</code> </p> </li> <li> <p> <code>ALL</code> </p> </li> </ul> <p> <code>ALL</code> is a special value that includes all of the listed HTTP methods.</p>"
}
},
"AccessControlAllowOriginsList": {
"base": null,
"refs": {
"ResponseHeadersPolicyAccessControlAllowOrigins$Items": "<p>The list of origins (domain names). You can specify <code>*</code> to allow all origins.</p>"
}
},
"AccessControlExposeHeadersList": {
"base": null,
"refs": {
"ResponseHeadersPolicyAccessControlExposeHeaders$Items": "<p>The list of HTTP headers. You can specify <code>*</code> to expose all headers.</p>"
}
},
"AccessDenied": {
"base": "<p>Access denied.</p>",
"refs": {
}
},
"ActiveTrustedKeyGroups": {
"base": "<p>A list of key groups, and the public keys in each key group, that CloudFront can use to verify the signatures of signed URLs and signed cookies.</p>",
"refs": {
"Distribution$ActiveTrustedKeyGroups": "<p>CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using key groups. This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.</p>"
}
},
"ActiveTrustedSigners": {
"base": "<p>A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.</p>",
"refs": {
"Distribution$ActiveTrustedSigners": "<important> <p>We recommend using <code>TrustedKeyGroups</code> instead of <code>TrustedSigners</code>.</p> </important> <p>CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using trusted signers. This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.</p>",
"StreamingDistribution$ActiveTrustedSigners": "<p>A complex type that lists the Amazon Web Services accounts, if any, that you included in the <code>TrustedSigners</code> complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.</p> <p>The <code>Signer</code> complex type lists the Amazon Web Services account number of the trusted signer or <code>self</code> if the signer is the Amazon Web Services account that created the distribution. The <code>Signer</code> element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's Amazon Web Services account. If no <code>KeyPairId</code> element appears for a <code>Signer</code>, that signer can't create signed URLs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>"
}
},
"AliasICPRecordal": {
"base": "<p>Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions. The status is returned in the CloudFront response; you can't configure it yourself.</p> <p>For more information about ICP recordals, see <a href=\"https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html\"> Signup, Accounts, and Credentials</a> in <i>Getting Started with Amazon Web Services services in China</i>.</p>",
"refs": {
"AliasICPRecordals$member": null
}
},
"AliasICPRecordals": {
"base": null,
"refs": {
"Distribution$AliasICPRecordals": "<p>Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.</p> <p>For more information about ICP recordals, see <a href=\"https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html\"> Signup, Accounts, and Credentials</a> in <i>Getting Started with Amazon Web Services services in China</i>.</p>",
"DistributionSummary$AliasICPRecordals": "<p>Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.</p> <p>For more information about ICP recordals, see <a href=\"https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html\"> Signup, Accounts, and Credentials</a> in <i>Getting Started with Amazon Web Services services in China</i>.</p>"
}
},
"AliasList": {
"base": null,
"refs": {
"Aliases$Items": "<p>A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.</p>"
}
},
"Aliases": {
"base": "<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution. </p>",
"refs": {
"DistributionConfig$Aliases": "<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.</p>",
"DistributionSummary$Aliases": "<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.</p>",
"StreamingDistributionConfig$Aliases": "<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution. </p>",
"StreamingDistributionSummary$Aliases": "<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.</p>"
}
},
"AllowedMethods": {
"base": "<p>A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:</p> <ul> <li> <p>CloudFront forwards only <code>GET</code> and <code>HEAD</code> requests.</p> </li> <li> <p>CloudFront forwards only <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests.</p> </li> <li> <p>CloudFront forwards <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and <code>DELETE</code> requests.</p> </li> </ul> <p>If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.</p>",
"refs": {
"CacheBehavior$AllowedMethods": null,
"DefaultCacheBehavior$AllowedMethods": null
}
},
"AssociateAliasRequest": {
"base": null,
"refs": {
}
},
"AwsAccountNumberList": {
"base": null,
"refs": {
"TrustedSigners$Items": "<p>A list of Amazon Web Services account identifiers.</p>"
}
},
"BatchTooLarge": {
"base": "<p>Invalidation batch specified is too large.</p>",
"refs": {
}
},
"CNAMEAlreadyExists": {
"base": "<p>The CNAME specified is already defined for CloudFront.</p>",
"refs": {
}
},
"CacheBehavior": {
"base": "<p>A complex type that describes how CloudFront processes requests.</p> <p>You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.</p> <p>For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html\">Quotas</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you don’t want to specify any cache behaviors, include only an empty <code>CacheBehaviors</code> element. Don’t include an empty <code>CacheBehavior</code> element because this is invalid.</p> <p>To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty <code>CacheBehaviors</code> element.</p> <p>To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.</p> <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>",
"refs": {
"CacheBehaviorList$member": null
}
},
"CacheBehaviorList": {
"base": null,
"refs": {
"CacheBehaviors$Items": "<p>Optional: A complex type that contains cache behaviors for this distribution. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>"
}
},
"CacheBehaviors": {
"base": "<p>A complex type that contains zero or more <code>CacheBehavior</code> elements. </p>",
"refs": {
"DistributionConfig$CacheBehaviors": "<p>A complex type that contains zero or more <code>CacheBehavior</code> elements. </p>",
"DistributionSummary$CacheBehaviors": "<p>A complex type that contains zero or more <code>CacheBehavior</code> elements.</p>"
}
},
"CachePolicy": {
"base": "<p>A cache policy.</p> <p>When it’s attached to a cache behavior, the cache policy determines the following:</p> <ul> <li> <p>The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.</p> </li> <li> <p>The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.</p> </li> </ul> <p>The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find a valid object in its cache that matches the request’s cache key. If you want to send values to the origin but <i>not</i> include them in the cache key, use <code>OriginRequestPolicy</code>.</p>",
"refs": {
"CachePolicySummary$CachePolicy": "<p>The cache policy.</p>",
"CreateCachePolicyResult$CachePolicy": "<p>A cache policy.</p>",
"GetCachePolicyResult$CachePolicy": "<p>The cache policy.</p>",
"UpdateCachePolicyResult$CachePolicy": "<p>A cache policy.</p>"
}
},
"CachePolicyAlreadyExists": {
"base": "<p>A cache policy with this name already exists. You must provide a unique name. To modify an existing cache policy, use <code>UpdateCachePolicy</code>.</p>",
"refs": {
}
},
"CachePolicyConfig": {
"base": "<p>A cache policy configuration.</p> <p>This configuration determines the following:</p> <ul> <li> <p>The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.</p> </li> <li> <p>The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.</p> </li> </ul> <p>The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find a valid object in its cache that matches the request’s cache key. If you want to send values to the origin but <i>not</i> include them in the cache key, use <code>OriginRequestPolicy</code>.</p>",
"refs": {
"CachePolicy$CachePolicyConfig": "<p>The cache policy configuration.</p>",
"CreateCachePolicyRequest$CachePolicyConfig": "<p>A cache policy configuration.</p>",
"GetCachePolicyConfigResult$CachePolicyConfig": "<p>The cache policy configuration.</p>",
"UpdateCachePolicyRequest$CachePolicyConfig": "<p>A cache policy configuration.</p>"
}
},
"CachePolicyCookieBehavior": {
"base": null,
"refs": {
"CachePolicyCookiesConfig$CookieBehavior": "<p>Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:</p> <ul> <li> <p> <code>none</code> – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to <code>none</code>, any cookies that are listed in an <code>OriginRequestPolicy</code> <i>are</i> included in origin requests.</p> </li> <li> <p> <code>whitelist</code> – The cookies in viewer requests that are listed in the <code>CookieNames</code> type are included in the cache key and automatically included in requests that CloudFront sends to the origin.</p> </li> <li> <p> <code>allExcept</code> – All cookies in viewer requests that are <i> <b>not</b> </i> listed in the <code>CookieNames</code> type are included in the cache key and automatically included in requests that CloudFront sends to the origin.</p> </li> <li> <p> <code>all</code> – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.</p> </li> </ul>"
}
},
"CachePolicyCookiesConfig": {
"base": "<p>An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.</p>",
"refs": {
"ParametersInCacheKeyAndForwardedToOrigin$CookiesConfig": "<p>An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.</p>"
}
},
"CachePolicyHeaderBehavior": {
"base": null,
"refs": {
"CachePolicyHeadersConfig$HeaderBehavior": "<p>Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:</p> <ul> <li> <p> <code>none</code> – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to <code>none</code>, any headers that are listed in an <code>OriginRequestPolicy</code> <i>are</i> included in origin requests.</p> </li> <li> <p> <code>whitelist</code> – The HTTP headers that are listed in the <code>Headers</code> type are included in the cache key and are automatically included in requests that CloudFront sends to the origin.</p> </li> </ul>"
}
},
"CachePolicyHeadersConfig": {
"base": "<p>An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.</p>",
"refs": {
"ParametersInCacheKeyAndForwardedToOrigin$HeadersConfig": "<p>An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.</p>"
}
},
"CachePolicyInUse": {
"base": "<p>Cannot delete the cache policy because it is attached to one or more cache behaviors.</p>",
"refs": {
}
},
"CachePolicyList": {
"base": "<p>A list of cache policies.</p>",
"refs": {
"ListCachePoliciesResult$CachePolicyList": "<p>A list of cache policies.</p>"
}
},
"CachePolicyQueryStringBehavior": {
"base": null,
"refs": {
"CachePolicyQueryStringsConfig$QueryStringBehavior": "<p>Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:</p> <ul> <li> <p> <code>none</code> – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to <code>none</code>, any query strings that are listed in an <code>OriginRequestPolicy</code> <i>are</i> included in origin requests.</p> </li> <li> <p> <code>whitelist</code> – The query strings in viewer requests that are listed in the <code>QueryStringNames</code> type are included in the cache key and automatically included in requests that CloudFront sends to the origin.</p> </li> <li> <p> <code>allExcept</code> – All query strings in viewer requests that are <i> <b>not</b> </i> listed in the <code>QueryStringNames</code> type are included in the cache key and automatically included in requests that CloudFront sends to the origin.</p> </li> <li> <p> <code>all</code> – All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.</p> </li> </ul>"
}
},
"CachePolicyQueryStringsConfig": {
"base": "<p>An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.</p>",
"refs": {
"ParametersInCacheKeyAndForwardedToOrigin$QueryStringsConfig": "<p>An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.</p>"
}
},
"CachePolicySummary": {
"base": "<p>Contains a cache policy.</p>",
"refs": {
"CachePolicySummaryList$member": null
}
},
"CachePolicySummaryList": {
"base": null,
"refs": {
"CachePolicyList$Items": "<p>Contains the cache policies in the list.</p>"
}
},
"CachePolicyType": {
"base": null,
"refs": {
"CachePolicySummary$Type": "<p>The type of cache policy, either <code>managed</code> (created by Amazon Web Services) or <code>custom</code> (created in this Amazon Web Services account).</p>",
"ListCachePoliciesRequest$Type": "<p>A filter to return only the specified kinds of cache policies. Valid values are:</p> <ul> <li> <p> <code>managed</code> – Returns only the managed policies created by Amazon Web Services.</p> </li> <li> <p> <code>custom</code> – Returns only the custom policies created in your Amazon Web Services account.</p> </li> </ul>"
}
},
"CachedMethods": {
"base": "<p>A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:</p> <ul> <li> <p>CloudFront caches responses to <code>GET</code> and <code>HEAD</code> requests.</p> </li> <li> <p>CloudFront caches responses to <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests.</p> </li> </ul> <p>If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. </p>",
"refs": {
"AllowedMethods$CachedMethods": null
}
},
"CannotChangeImmutablePublicKeyFields": {
"base": "<p>You can't change the value of a public key.</p>",
"refs": {
}
},
"CertificateSource": {
"base": null,
"refs": {
"ViewerCertificate$CertificateSource": "<p>This field is deprecated. Use one of the following fields instead:</p> <ul> <li> <p> <code>ACMCertificateArn</code> </p> </li> <li> <p> <code>IAMCertificateId</code> </p> </li> <li> <p> <code>CloudFrontDefaultCertificate</code> </p> </li> </ul>"
}
},
"CloudFrontOriginAccessIdentity": {
"base": "<p>CloudFront origin access identity.</p>",
"refs": {
"CreateCloudFrontOriginAccessIdentityResult$CloudFrontOriginAccessIdentity": "<p>The origin access identity's information.</p>",
"GetCloudFrontOriginAccessIdentityResult$CloudFrontOriginAccessIdentity": "<p>The origin access identity's information.</p>",
"UpdateCloudFrontOriginAccessIdentityResult$CloudFrontOriginAccessIdentity": "<p>The origin access identity's information.</p>"
}
},
"CloudFrontOriginAccessIdentityAlreadyExists": {
"base": "<p>If the <code>CallerReference</code> is a value you already sent in a previous request to create an identity but the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is different from the original request, CloudFront returns a <code>CloudFrontOriginAccessIdentityAlreadyExists</code> error. </p>",
"refs": {
}
},
"CloudFrontOriginAccessIdentityConfig": {
"base": "<p>Origin access identity configuration. Send a <code>GET</code> request to the <code>/<i>CloudFront API version</i>/CloudFront/identity ID/config</code> resource. </p>",
"refs": {
"CloudFrontOriginAccessIdentity$CloudFrontOriginAccessIdentityConfig": "<p>The current configuration information for the identity. </p>",
"CreateCloudFrontOriginAccessIdentityRequest$CloudFrontOriginAccessIdentityConfig": "<p>The current configuration information for the identity.</p>",
"GetCloudFrontOriginAccessIdentityConfigResult$CloudFrontOriginAccessIdentityConfig": "<p>The origin access identity's configuration information. </p>",
"UpdateCloudFrontOriginAccessIdentityRequest$CloudFrontOriginAccessIdentityConfig": "<p>The identity's configuration information.</p>"
}
},
"CloudFrontOriginAccessIdentityInUse": {
"base": "<p>The Origin Access Identity specified is already in use.</p>",
"refs": {
}
},
"CloudFrontOriginAccessIdentityList": {
"base": "<p>Lists the origin access identities for CloudFront.Send a <code>GET</code> request to the <code>/<i>CloudFront API version</i>/origin-access-identity/cloudfront</code> resource. The response includes a <code>CloudFrontOriginAccessIdentityList</code> element with zero or more <code>CloudFrontOriginAccessIdentitySummary</code> child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the <code>MaxItems</code> and <code>Marker</code> parameters.</p>",
"refs": {
"ListCloudFrontOriginAccessIdentitiesResult$CloudFrontOriginAccessIdentityList": "<p>The <code>CloudFrontOriginAccessIdentityList</code> type. </p>"
}
},
"CloudFrontOriginAccessIdentitySummary": {
"base": "<p>Summary of the information about a CloudFront origin access identity.</p>",
"refs": {
"CloudFrontOriginAccessIdentitySummaryList$member": null
}
},
"CloudFrontOriginAccessIdentitySummaryList": {
"base": null,
"refs": {
"CloudFrontOriginAccessIdentityList$Items": "<p>A complex type that contains one <code>CloudFrontOriginAccessIdentitySummary</code> element for each origin access identity that was created by the current Amazon Web Services account.</p>"
}
},
"CommentType": {
"base": null,
"refs": {
"DistributionConfig$Comment": "<p>An optional comment to describe the distribution. The comment cannot be longer than 128 characters.</p>"
}
},
"ConflictingAlias": {
"base": "<p>An alias (also called a CNAME) and the CloudFront distribution and Amazon Web Services account ID that it’s associated with. The distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don’t own.</p>",
"refs": {
"ConflictingAliases$member": null
}
},
"ConflictingAliases": {
"base": null,
"refs": {
"ConflictingAliasesList$Items": "<p>Contains the conflicting aliases in the list.</p>"
}
},
"ConflictingAliasesList": {
"base": "<p>A list of aliases (also called CNAMEs) and the CloudFront distributions and Amazon Web Services accounts that they are associated with. In the list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don’t own.</p>",
"refs": {
"ListConflictingAliasesResult$ConflictingAliasesList": "<p>A list of conflicting aliases.</p>"
}
},
"ContentTypeProfile": {
"base": "<p>A field-level encryption content type profile. </p>",
"refs": {
"ContentTypeProfileList$member": null
}
},
"ContentTypeProfileConfig": {
"base": "<p>The configuration for a field-level encryption content type-profile mapping. </p>",
"refs": {
"FieldLevelEncryptionConfig$ContentTypeProfileConfig": "<p>A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.</p>",
"FieldLevelEncryptionSummary$ContentTypeProfileConfig": "<p> A summary of a content type-profile mapping. </p>"
}
},
"ContentTypeProfileList": {
"base": null,
"refs": {
"ContentTypeProfiles$Items": "<p>Items in a field-level encryption content type-profile mapping. </p>"
}
},
"ContentTypeProfiles": {
"base": "<p>Field-level encryption content type-profile. </p>",
"refs": {
"ContentTypeProfileConfig$ContentTypeProfiles": "<p>The configuration for a field-level encryption content type-profile. </p>"
}
},
"CookieNameList": {
"base": null,
"refs": {
"CookieNames$Items": "<p>A list of cookie names.</p>"
}
},
"CookieNames": {
"base": "<p>Contains a list of cookie names.</p>",
"refs": {
"CachePolicyCookiesConfig$Cookies": null,
"CookiePreference$WhitelistedNames": "<p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</p> <p>If you want to include cookies in the cache key, use a cache policy. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy\">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy\">Creating origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>Required if you specify <code>whitelist</code> for the value of <code>Forward</code>. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.</p> <p>If you specify <code>all</code> or <code>none</code> for the value of <code>Forward</code>, omit <code>WhitelistedNames</code>. If you change the value of <code>Forward</code> from <code>whitelist</code> to <code>all</code> or <code>none</code> and you don't delete the <code>WhitelistedNames</code> element and its child elements, CloudFront deletes them automatically.</p> <p>For the current limit on the number of cookie names that you can whitelist for each cache behavior, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront\"> CloudFront Limits</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"OriginRequestPolicyCookiesConfig$Cookies": null
}
},
"CookiePreference": {
"base": "<p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</p> <p>If you want to include cookies in the cache key, use <code>CookiesConfig</code> in a cache policy. See <code>CachePolicy</code>.</p> <p>If you want to send cookies to the origin but not include them in the cache key, use <code>CookiesConfig</code> in an origin request policy. See <code>OriginRequestPolicy</code>.</p> <p>A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html\">Caching Content Based on Cookies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"refs": {
"ForwardedValues$Cookies": "<p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</p> <p>If you want to include cookies in the cache key, use a cache policy. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy\">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy\">Creating origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html\">How CloudFront Forwards, Caches, and Logs Cookies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
}
},
"CreateCachePolicyRequest": {
"base": null,
"refs": {
}
},
"CreateCachePolicyResult": {
"base": null,
"refs": {
}
},
"CreateCloudFrontOriginAccessIdentityRequest": {
"base": "<p>The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html\"> Restricting Access to Amazon S3 Content by Using an Origin Access Identity</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>",
"refs": {
}
},
"CreateCloudFrontOriginAccessIdentityResult": {
"base": "<p>The returned result of the corresponding request.</p>",
"refs": {
}
},
"CreateDistributionRequest": {
"base": "<p>The request to create a new distribution.</p>",
"refs": {
}
},
"CreateDistributionResult": {
"base": "<p>The returned result of the corresponding request.</p>",
"refs": {
}
},
"CreateDistributionWithTagsRequest": {
"base": "<p>The request to create a new distribution with tags. </p>",
"refs": {
}
},
"CreateDistributionWithTagsResult": {
"base": "<p>The returned result of the corresponding request. </p>",
"refs": {
}
},
"CreateFieldLevelEncryptionConfigRequest": {
"base": null,
"refs": {
}
},
"CreateFieldLevelEncryptionConfigResult": {
"base": null,
"refs": {
}
},
"CreateFieldLevelEncryptionProfileRequest": {
"base": null,
"refs": {
}
},
"CreateFieldLevelEncryptionProfileResult": {
"base": null,
"refs": {
}
},
"CreateFunctionRequest": {
"base": null,
"refs": {
}
},
"CreateFunctionResult": {
"base": null,
"refs": {
}
},
"CreateInvalidationRequest": {
"base": "<p>The request to create an invalidation.</p>",
"refs": {
}
},
"CreateInvalidationResult": {
"base": "<p>The returned result of the corresponding request.</p>",
"refs": {
}
},
"CreateKeyGroupRequest": {
"base": null,
"refs": {
}
},
"CreateKeyGroupResult": {
"base": null,
"refs": {
}
},
"CreateMonitoringSubscriptionRequest": {
"base": null,
"refs": {
}
},
"CreateMonitoringSubscriptionResult": {
"base": null,
"refs": {
}
},
"CreateOriginAccessControlRequest": {
"base": null,
"refs": {
}
},
"CreateOriginAccessControlResult": {
"base": null,
"refs": {
}
},
"CreateOriginRequestPolicyRequest": {
"base": null,
"refs": {
}
},
"CreateOriginRequestPolicyResult": {
"base": null,
"refs": {
}
},
"CreatePublicKeyRequest": {
"base": null,
"refs": {
}
},
"CreatePublicKeyResult": {
"base": null,
"refs": {
}
},
"CreateRealtimeLogConfigRequest": {
"base": null,
"refs": {
}
},
"CreateRealtimeLogConfigResult": {
"base": null,
"refs": {
}
},
"CreateResponseHeadersPolicyRequest": {
"base": null,
"refs": {
}
},
"CreateResponseHeadersPolicyResult": {
"base": null,
"refs": {
}
},
"CreateStreamingDistributionRequest": {
"base": "<p>The request to create a new streaming distribution.</p>",
"refs": {
}
},
"CreateStreamingDistributionResult": {
"base": "<p>The returned result of the corresponding request.</p>",
"refs": {
}
},
"CreateStreamingDistributionWithTagsRequest": {
"base": "<p>The request to create a new streaming distribution with tags.</p>",
"refs": {
}
},
"CreateStreamingDistributionWithTagsResult": {
"base": "<p>The returned result of the corresponding request. </p>",
"refs": {
}
},
"CustomErrorResponse": {
"base": "<p>A complex type that controls:</p> <ul> <li> <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. </p> </li> <li> <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p> </li> </ul> <p>For more information about custom error pages, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"refs": {
"CustomErrorResponseList$member": null
}
},
"CustomErrorResponseList": {
"base": null,
"refs": {
"CustomErrorResponses$Items": "<p>A complex type that contains a <code>CustomErrorResponse</code> element for each HTTP status code for which you want to specify a custom error page and/or a caching duration. </p>"
}
},
"CustomErrorResponses": {
"base": "<p>A complex type that controls:</p> <ul> <li> <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.</p> </li> <li> <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p> </li> </ul> <p>For more information about custom error pages, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"refs": {
"DistributionConfig$CustomErrorResponses": "<p>A complex type that controls the following:</p> <ul> <li> <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.</p> </li> <li> <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p> </li> </ul> <p>For more information about custom error pages, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"DistributionSummary$CustomErrorResponses": "<p>A complex type that contains zero or more <code>CustomErrorResponses</code> elements.</p>"
}
},
"CustomHeaders": {
"base": "<p>A complex type that contains the list of Custom Headers for each origin. </p>",
"refs": {
"Origin$CustomHeaders": "<p>A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html\">Adding Custom Headers to Origin Requests</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
}
},
"CustomOriginConfig": {
"base": "<p>A custom origin. A custom origin is any origin that is <i>not</i> an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html\">configured with static website hosting</a> <i>is</i> a custom origin.</p>",
"refs": {
"Origin$CustomOriginConfig": "<p>Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the <code>S3OriginConfig</code> type instead.</p>"
}
},
"DefaultCacheBehavior": {
"base": "<p>A complex type that describes the default cache behavior if you don’t specify a <code>CacheBehavior</code> element or if request URLs don’t match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>",
"refs": {
"DistributionConfig$DefaultCacheBehavior": "<p>A complex type that describes the default cache behavior if you don't specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>",
"DistributionSummary$DefaultCacheBehavior": "<p>A complex type that describes the default cache behavior if you don't specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>"
}
},
"DeleteCachePolicyRequest": {
"base": null,
"refs": {
}
},
"DeleteCloudFrontOriginAccessIdentityRequest": {
"base": "<p>Deletes a origin access identity.</p>",
"refs": {
}
},
"DeleteDistributionRequest": {
"base": "<p>This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.</p> <p> <b>To delete a web distribution using the CloudFront API:</b> </p> <ol> <li> <p>Disable the web distribution </p> </li> <li> <p>Submit a <code>GET Distribution Config</code> request to get the current configuration and the <code>Etag</code> header for the distribution.</p> </li> <li> <p>Update the XML document that was returned in the response to your <code>GET Distribution Config</code> request to change the value of <code>Enabled</code> to <code>false</code>.</p> </li> <li> <p>Submit a <code>PUT Distribution Config</code> request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Distribution Config</code> request in Step 2.</p> </li> <li> <p>Review the response to the <code>PUT Distribution Config</code> request to confirm that the distribution was successfully disabled.</p> </li> <li> <p>Submit a <code>GET Distribution</code> request to confirm that your changes have propagated. When propagation is complete, the value of <code>Status</code> is <code>Deployed</code>.</p> </li> <li> <p>Submit a <code>DELETE Distribution</code> request. Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Distribution Config</code> request in Step 6.</p> </li> <li> <p>Review the response to your <code>DELETE Distribution</code> request to confirm that the distribution was successfully deleted.</p> </li> </ol> <p>For information about deleting a distribution using the CloudFront console, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html\">Deleting a Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"refs": {
}
},
"DeleteFieldLevelEncryptionConfigRequest": {
"base": null,
"refs": {
}
},
"DeleteFieldLevelEncryptionProfileRequest": {
"base": null,
"refs": {
}
},
"DeleteFunctionRequest": {
"base": null,
"refs": {
}
},
"DeleteKeyGroupRequest": {
"base": null,
"refs": {
}
},
"DeleteMonitoringSubscriptionRequest": {
"base": null,
"refs": {
}
},
"DeleteMonitoringSubscriptionResult": {
"base": null,
"refs": {
}
},
"DeleteOriginAccessControlRequest": {
"base": null,
"refs": {
}
},
"DeleteOriginRequestPolicyRequest": {
"base": null,
"refs": {
}
},
"DeletePublicKeyRequest": {
"base": null,
"refs": {
}
},
"DeleteRealtimeLogConfigRequest": {
"base": null,
"refs": {
}
},
"DeleteResponseHeadersPolicyRequest": {
"base": null,
"refs": {
}
},
"DeleteStreamingDistributionRequest": {
"base": "<p>The request to delete a streaming distribution.</p>",
"refs": {
}
},
"DescribeFunctionRequest": {
"base": null,
"refs": {
}
},
"DescribeFunctionResult": {
"base": null,
"refs": {
}
},
"Distribution": {
"base": "<p>A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.</p>",
"refs": {
"CreateDistributionResult$Distribution": "<p>The distribution's information.</p>",
"CreateDistributionWithTagsResult$Distribution": "<p>The distribution's information. </p>",
"GetDistributionResult$Distribution": "<p>The distribution's information.</p>",
"UpdateDistributionResult$Distribution": "<p>The distribution's information.</p>"
}
},
"DistributionAlreadyExists": {
"base": "<p>The caller reference you attempted to create the distribution with is associated with another distribution.</p>",
"refs": {
}
},
"DistributionConfig": {
"base": "<p>A distribution configuration.</p>",
"refs": {
"CreateDistributionRequest$DistributionConfig": "<p>The distribution's configuration information.</p>",
"Distribution$DistributionConfig": "<p>The current configuration information for the distribution. Send a <code>GET</code> request to the <code>/<i>CloudFront API version</i>/distribution ID/config</code> resource.</p>",
"DistributionConfigWithTags$DistributionConfig": "<p>A distribution configuration.</p>",
"GetDistributionConfigResult$DistributionConfig": "<p>The distribution's configuration information.</p>",
"UpdateDistributionRequest$DistributionConfig": "<p>The distribution's configuration information.</p>"
}
},
"DistributionConfigWithTags": {
"base": "<p>A distribution Configuration and a list of tags to be associated with the distribution.</p>",
"refs": {
"CreateDistributionWithTagsRequest$DistributionConfigWithTags": "<p>The distribution's configuration information. </p>"
}
},
"DistributionIdList": {
"base": "<p>A list of distribution IDs.</p>",
"refs": {
"ListDistributionsByCachePolicyIdResult$DistributionIdList": "<p>A list of distribution IDs.</p>",
"ListDistributionsByKeyGroupResult$DistributionIdList": null,
"ListDistributionsByOriginRequestPolicyIdResult$DistributionIdList": "<p>A list of distribution IDs.</p>",
"ListDistributionsByResponseHeadersPolicyIdResult$DistributionIdList": null
}
},
"DistributionIdListSummary": {
"base": null,
"refs": {
"DistributionIdList$Items": "<p>Contains the distribution IDs in the list.</p>"
}
},
"DistributionList": {
"base": "<p>A distribution list.</p>",
"refs": {
"ListDistributionsByRealtimeLogConfigResult$DistributionList": null,
"ListDistributionsByWebACLIdResult$DistributionList": "<p>The <code>DistributionList</code> type. </p>",
"ListDistributionsResult$DistributionList": "<p>The <code>DistributionList</code> type. </p>"
}
},
"DistributionNotDisabled": {
"base": "<p>The specified CloudFront distribution is not disabled. You must disable the distribution before you can delete it.</p>",
"refs": {
}
},
"DistributionSummary": {
"base": "<p>A summary of the information about a CloudFront distribution.</p>",
"refs": {
"DistributionSummaryList$member": null
}
},
"DistributionSummaryList": {
"base": null,
"refs": {
"DistributionList$Items": "<p>A complex type that contains one <code>DistributionSummary</code> element for each distribution that was created by the current Amazon Web Services account.</p>"
}
},
"EncryptionEntities": {
"base": "<p>Complex data type for field-level encryption profiles that includes all of the encryption entities. </p>",
"refs": {
"FieldLevelEncryptionProfileConfig$EncryptionEntities": "<p>A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.</p>",
"FieldLevelEncryptionProfileSummary$EncryptionEntities": "<p>A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.</p>"
}
},
"EncryptionEntity": {
"base": "<p>Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications. </p>",
"refs": {
"EncryptionEntityList$member": null
}
},
"EncryptionEntityList": {
"base": null,
"refs": {
"EncryptionEntities$Items": "<p>An array of field patterns in a field-level encryption content type-profile mapping. </p>"
}
},
"EndPoint": {
"base": "<p>Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.</p>",
"refs": {
"EndPointList$member": null
}
},
"EndPointList": {
"base": null,
"refs": {
"CreateRealtimeLogConfigRequest$EndPoints": "<p>Contains information about the Amazon Kinesis data stream where you are sending real-time log data.</p>",
"RealtimeLogConfig$EndPoints": "<p>Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.</p>",
"UpdateRealtimeLogConfigRequest$EndPoints": "<p>Contains information about the Amazon Kinesis data stream where you are sending real-time log data.</p>"
}
},
"EventType": {
"base": null,
"refs": {
"FunctionAssociation$EventType": "<p>The event type of the function, either <code>viewer-request</code> or <code>viewer-response</code>. You cannot use origin-facing event types (<code>origin-request</code> and <code>origin-response</code>) with a CloudFront function.</p>",
"LambdaFunctionAssociation$EventType": "<p>Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:</p> <ul> <li> <p> <code>viewer-request</code>: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache. </p> </li> <li> <p> <code>origin-request</code>: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.</p> </li> <li> <p> <code>origin-response</code>: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.</p> </li> <li> <p> <code>viewer-response</code>: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.</p> <p>If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.</p> </li> </ul>"
}
},
"FieldLevelEncryption": {
"base": "<p>A complex data type that includes the profile configurations and other options specified for field-level encryption. </p>",
"refs": {
"CreateFieldLevelEncryptionConfigResult$FieldLevelEncryption": "<p>Returned when you create a new field-level encryption configuration.</p>",
"GetFieldLevelEncryptionResult$FieldLevelEncryption": "<p>Return the field-level encryption configuration information.</p>",
"UpdateFieldLevelEncryptionConfigResult$FieldLevelEncryption": "<p>Return the results of updating the configuration.</p>"
}
},
"FieldLevelEncryptionConfig": {
"base": "<p>A complex data type that includes the profile configurations specified for field-level encryption. </p>",
"refs": {
"CreateFieldLevelEncryptionConfigRequest$FieldLevelEncryptionConfig": "<p>The request to create a new field-level encryption configuration.</p>",
"FieldLevelEncryption$FieldLevelEncryptionConfig": "<p>A complex data type that includes the profile configurations specified for field-level encryption. </p>",
"GetFieldLevelEncryptionConfigResult$FieldLevelEncryptionConfig": "<p>Return the field-level encryption configuration information.</p>",
"UpdateFieldLevelEncryptionConfigRequest$FieldLevelEncryptionConfig": "<p>Request to update a field-level encryption configuration. </p>"
}
},
"FieldLevelEncryptionConfigAlreadyExists": {
"base": "<p>The specified configuration for field-level encryption already exists.</p>",
"refs": {
}
},
"FieldLevelEncryptionConfigInUse": {
"base": "<p>The specified configuration for field-level encryption is in use.</p>",
"refs": {
}
},
"FieldLevelEncryptionList": {
"base": "<p>List of field-level encrpytion configurations.</p>",
"refs": {
"ListFieldLevelEncryptionConfigsResult$FieldLevelEncryptionList": "<p>Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.</p>"
}
},
"FieldLevelEncryptionProfile": {
"base": "<p>A complex data type for field-level encryption profiles.</p>",
"refs": {
"CreateFieldLevelEncryptionProfileResult$FieldLevelEncryptionProfile": "<p>Returned when you create a new field-level encryption profile.</p>",
"GetFieldLevelEncryptionProfileResult$FieldLevelEncryptionProfile": "<p>Return the field-level encryption profile information.</p>",
"UpdateFieldLevelEncryptionProfileResult$FieldLevelEncryptionProfile": "<p>Return the results of updating the profile.</p>"
}
},
"FieldLevelEncryptionProfileAlreadyExists": {
"base": "<p>The specified profile for field-level encryption already exists.</p>",
"refs": {
}
},
"FieldLevelEncryptionProfileConfig": {
"base": "<p>A complex data type of profiles for the field-level encryption.</p>",
"refs": {
"CreateFieldLevelEncryptionProfileRequest$FieldLevelEncryptionProfileConfig": "<p>The request to create a field-level encryption profile.</p>",
"FieldLevelEncryptionProfile$FieldLevelEncryptionProfileConfig": "<p>A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.</p>",
"GetFieldLevelEncryptionProfileConfigResult$FieldLevelEncryptionProfileConfig": "<p>Return the field-level encryption profile configuration information.</p>",
"UpdateFieldLevelEncryptionProfileRequest$FieldLevelEncryptionProfileConfig": "<p>Request to update a field-level encryption profile. </p>"
}
},
"FieldLevelEncryptionProfileInUse": {
"base": "<p>The specified profile for field-level encryption is in use.</p>",
"refs": {
}
},
"FieldLevelEncryptionProfileList": {
"base": "<p>List of field-level encryption profiles.</p>",
"refs": {
"ListFieldLevelEncryptionProfilesResult$FieldLevelEncryptionProfileList": "<p>Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.</p>"
}
},
"FieldLevelEncryptionProfileSizeExceeded": {
"base": "<p>The maximum size of a profile for field-level encryption was exceeded.</p>",
"refs": {
}
},
"FieldLevelEncryptionProfileSummary": {
"base": "<p>The field-level encryption profile summary.</p>",
"refs": {
"FieldLevelEncryptionProfileSummaryList$member": null
}
},
"FieldLevelEncryptionProfileSummaryList": {
"base": null,
"refs": {
"FieldLevelEncryptionProfileList$Items": "<p>The field-level encryption profile items.</p>"
}
},
"FieldLevelEncryptionSummary": {
"base": "<p>A summary of a field-level encryption item.</p>",
"refs": {
"FieldLevelEncryptionSummaryList$member": null
}
},
"FieldLevelEncryptionSummaryList": {
"base": null,
"refs": {
"FieldLevelEncryptionList$Items": "<p>An array of field-level encryption items.</p>"
}
},
"FieldList": {
"base": null,
"refs": {
"CreateRealtimeLogConfigRequest$Fields": "<p>A list of fields to include in each real-time log record.</p> <p>For more information about fields, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields\">Real-time log configuration fields</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"RealtimeLogConfig$Fields": "<p>A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.</p> <p>For more information about fields, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields\">Real-time log configuration fields</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"UpdateRealtimeLogConfigRequest$Fields": "<p>A list of fields to include in each real-time log record.</p> <p>For more information about fields, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields\">Real-time log configuration fields</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
}
},
"FieldPatternList": {
"base": null,
"refs": {
"FieldPatterns$Items": "<p>An array of the field-level encryption field patterns.</p>"
}
},
"FieldPatterns": {
"base": "<p>A complex data type that includes the field patterns to match for field-level encryption.</p>",
"refs": {
"EncryptionEntity$FieldPatterns": "<p>Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive. </p>"
}
},
"Format": {
"base": null,
"refs": {
"ContentTypeProfile$Format": "<p>The format for a field-level encryption content type-profile mapping. </p>"
}
},
"ForwardedValues": {
"base": "<p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</p> <p>If you want to include values in the cache key, use a cache policy. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy\">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy\">Creating origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.</p>",
"refs": {
"CacheBehavior$ForwardedValues": "<p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html\">Working with policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to include values in the cache key, use a cache policy. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy\">Creating cache policies</a> or <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html\">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy\">Creating origin request policies</a> or <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html\">Using the managed origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>A <code>CacheBehavior</code> must include either a <code>CachePolicyId</code> or <code>ForwardedValues</code>. We recommend that you use a <code>CachePolicyId</code>.</p> <p>A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.</p>",
"DefaultCacheBehavior$ForwardedValues": "<p>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html\">Working with policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to include values in the cache key, use a cache policy. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy\">Creating cache policies</a> or <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html\">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy\">Creating origin request policies</a> or <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html\">Using the managed origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>A <code>DefaultCacheBehavior</code> must include either a <code>CachePolicyId</code> or <code>ForwardedValues</code>. We recommend that you use a <code>CachePolicyId</code>.</p> <p>A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.</p>"
}
},
"FrameOptionsList": {
"base": null,
"refs": {
"ResponseHeadersPolicyFrameOptions$FrameOption": "<p>The value of the <code>X-Frame-Options</code> HTTP response header. Valid values are <code>DENY</code> and <code>SAMEORIGIN</code>. </p> <p>For more information about these values, see <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options\">X-Frame-Options</a> in the MDN Web Docs.</p>"
}
},
"FunctionARN": {
"base": null,
"refs": {
"FunctionAssociation$FunctionARN": "<p>The Amazon Resource Name (ARN) of the function.</p>"
}
},
"FunctionAlreadyExists": {
"base": "<p>A function with the same name already exists in this Amazon Web Services account. To create a function, you must provide a unique name. To update an existing function, use <code>UpdateFunction</code>.</p>",
"refs": {
}
},
"FunctionAssociation": {
"base": "<p>A CloudFront function that is associated with a cache behavior in a CloudFront distribution.</p>",
"refs": {
"FunctionAssociationList$member": null
}
},
"FunctionAssociationList": {
"base": null,
"refs": {
"FunctionAssociations$Items": "<p>The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. CloudFront functions must be published to the <code>LIVE</code> stage to associate them with a cache behavior.</p>"
}