forked from withfig/autocomplete
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcloudfront.ts
More file actions
3122 lines (3121 loc) · 157 KB
/
cloudfront.ts
File metadata and controls
3122 lines (3121 loc) · 157 KB
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
const completionSpec: Fig.Spec = {
name: "cloudfront",
description:
"Amazon CloudFront This is the Amazon CloudFront API Reference. 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 Amazon CloudFront Developer Guide",
subcommands: [
{
name: "create-cache-policy",
description:
"Creates a cache policy. After you create a cache policy, you can attach it to one or more cache behaviors. When it\u2019s attached to a cache behavior, the cache policy determines the following: 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. The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache. 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\u2019t find an object in its cache that matches the request\u2019s cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy. For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide",
options: [
{
name: "--cache-policy-config",
description: "A cache policy configuration",
args: {
name: "structure",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-cloud-front-origin-access-identity",
description:
"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 Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide",
options: [
{
name: "--cloud-front-origin-access-identity-config",
description: "The current configuration information for the identity",
args: {
name: "structure",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-distribution",
description:
"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 POST request to the /CloudFront API version/distribution/distribution ID resource. When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, 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 Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide",
options: [
{
name: "--distribution-config",
description: "The distribution's configuration information",
args: {
name: "structure",
},
},
{
name: "--origin-domain-name",
description:
"The domain name for your origin. This argument and --distribution-config are mututally exclusive",
args: {
name: "string",
},
},
{
name: "--default-root-object",
description:
"The object that you want CloudFront to return (for example, index.html) when a viewer request points to your root URL. This argument and --distribution-config are mututally exclusive",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-distribution-with-tags",
description: "Create a new distribution with tags",
options: [
{
name: "--distribution-config-with-tags",
description: "The distribution's configuration information",
args: {
name: "structure",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-field-level-encryption-config",
description: "Create a new field-level encryption configuration",
options: [
{
name: "--field-level-encryption-config",
description:
"The request to create a new field-level encryption configuration",
args: {
name: "structure",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-field-level-encryption-profile",
description: "Create a field-level encryption profile",
options: [
{
name: "--field-level-encryption-profile-config",
description: "The request to create a field-level encryption profile",
args: {
name: "structure",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-invalidation",
description: "Create a new invalidation",
options: [
{
name: "--distribution-id",
description: "The distribution's id",
args: {
name: "string",
},
},
{
name: "--invalidation-batch",
description: "The batch information for the invalidation",
args: {
name: "structure",
},
},
{
name: "--paths",
description:
"The space-separated paths to be invalidated. Note: --invalidation-batch and --paths are mututally exclusive",
args: {
name: "string",
isVariadic: true,
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-key-group",
description:
"Creates a key group that you can use with CloudFront signed URLs and signed cookies. 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 Serving private content in the Amazon CloudFront Developer Guide",
options: [
{
name: "--key-group-config",
description: "A key group configuration",
args: {
name: "structure",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-monitoring-subscription",
description:
"Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost. For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide",
options: [
{
name: "--distribution-id",
description:
"The ID of the distribution that you are enabling metrics for",
args: {
name: "string",
},
},
{
name: "--monitoring-subscription",
description:
"A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution",
args: {
name: "structure",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-origin-request-policy",
description:
"Creates an origin request policy. After you create an origin request policy, you can attach it to one or more cache behaviors. When it\u2019s 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: The request body and the URL path (without the domain name) from the viewer request. The headers that CloudFront automatically includes in every origin request, including Host, User-Agent, and X-Amz-Cf-Id. 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. CloudFront sends a request when it can\u2019t 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 CachePolicy. For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide",
options: [
{
name: "--origin-request-policy-config",
description: "An origin request policy configuration",
args: {
name: "structure",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-public-key",
description:
"Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption",
options: [
{
name: "--public-key-config",
description: "A CloudFront public key configuration",
args: {
name: "structure",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-realtime-log-config",
description:
"Creates a real-time log configuration. 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. For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide",
options: [
{
name: "--end-points",
description:
"Contains information about the Amazon Kinesis data stream where you are sending real-time log data",
args: {
name: "list",
},
},
{
name: "--fields",
description:
"A list of fields to include in each real-time log record. For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide",
args: {
name: "list",
},
},
{
name: "--name",
description:
"A unique name to identify this real-time log configuration",
args: {
name: "string",
},
},
{
name: "--sampling-rate",
description:
"The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive",
args: {
name: "long",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-streaming-distribution",
description:
"This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum",
options: [
{
name: "--streaming-distribution-config",
description: "The streaming distribution's configuration information",
args: {
name: "structure",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-streaming-distribution-with-tags",
description:
"This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum",
options: [
{
name: "--streaming-distribution-config-with-tags",
description: "The streaming distribution's configuration information",
args: {
name: "structure",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "delete-cache-policy",
description:
"Deletes a cache policy. You cannot delete a cache policy if it\u2019s attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy. To delete a cache policy, you must provide the policy\u2019s identifier and version. To get these values, you can use ListCachePolicies or GetCachePolicy",
options: [
{
name: "--id",
description:
"The unique identifier for the cache policy that you are deleting. To get the identifier, you can use ListCachePolicies",
args: {
name: "string",
},
},
{
name: "--if-match",
description:
"The version of the cache policy that you are deleting. The version is the cache policy\u2019s ETag value, which you can get using ListCachePolicies, GetCachePolicy, or GetCachePolicyConfig",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "delete-cloud-front-origin-access-identity",
description: "Delete an origin access identity",
options: [
{
name: "--id",
description: "The origin access identity's ID",
args: {
name: "string",
},
},
{
name: "--if-match",
description:
"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "delete-distribution",
description: "Delete a distribution",
options: [
{
name: "--id",
description: "The distribution ID",
args: {
name: "string",
},
},
{
name: "--if-match",
description:
"The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "delete-field-level-encryption-config",
description: "Remove a field-level encryption configuration",
options: [
{
name: "--id",
description:
"The ID of the configuration you want to delete from CloudFront",
args: {
name: "string",
},
},
{
name: "--if-match",
description:
"The value of the ETag header that you received when retrieving the configuration identity to delete. For example: E2QWRUHAPOMQZL",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "delete-field-level-encryption-profile",
description: "Remove a field-level encryption profile",
options: [
{
name: "--id",
description:
"Request the ID of the profile you want to delete from CloudFront",
args: {
name: "string",
},
},
{
name: "--if-match",
description:
"The value of the ETag header that you received when retrieving the profile to delete. For example: E2QWRUHAPOMQZL",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "delete-key-group",
description:
"Deletes a key group. 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. To delete a key group, you must provide the key group\u2019s identifier and version. To get these values, use ListKeyGroups followed by GetKeyGroup or GetKeyGroupConfig",
options: [
{
name: "--id",
description:
"The identifier of the key group that you are deleting. To get the identifier, use ListKeyGroups",
args: {
name: "string",
},
},
{
name: "--if-match",
description:
"The version of the key group that you are deleting. The version is the key group\u2019s ETag value. To get the ETag, use GetKeyGroup or GetKeyGroupConfig",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "delete-monitoring-subscription",
description:
"Disables additional CloudWatch metrics for the specified CloudFront distribution",
options: [
{
name: "--distribution-id",
description:
"The ID of the distribution that you are disabling metrics for",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "delete-origin-request-policy",
description:
"Deletes an origin request policy. You cannot delete an origin request policy if it\u2019s 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. To delete an origin request policy, you must provide the policy\u2019s identifier and version. To get the identifier, you can use ListOriginRequestPolicies or GetOriginRequestPolicy",
options: [
{
name: "--id",
description:
"The unique identifier for the origin request policy that you are deleting. To get the identifier, you can use ListOriginRequestPolicies",
args: {
name: "string",
},
},
{
name: "--if-match",
description:
"The version of the origin request policy that you are deleting. The version is the origin request policy\u2019s ETag value, which you can get using ListOriginRequestPolicies, GetOriginRequestPolicy, or GetOriginRequestPolicyConfig",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "delete-public-key",
description: "Remove a public key you previously added to CloudFront",
options: [
{
name: "--id",
description:
"The ID of the public key you want to remove from CloudFront",
args: {
name: "string",
},
},
{
name: "--if-match",
description:
"The value of the ETag header that you received when retrieving the public key identity to delete. For example: E2QWRUHAPOMQZL",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "delete-realtime-log-config",
description:
"Deletes a real-time log configuration. You cannot delete a real-time log configuration if it\u2019s 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. To delete a real-time log configuration, you can provide the configuration\u2019s 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",
options: [
{
name: "--name",
description: "The name of the real-time log configuration to delete",
args: {
name: "string",
},
},
{
name: "--arn",
description:
"The Amazon Resource Name (ARN) of the real-time log configuration to delete",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "delete-streaming-distribution",
description:
"Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps. To delete an RTMP distribution using the CloudFront API: Disable the RTMP distribution. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution. Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false. Submit a PUT Streaming Distribution Config 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 If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2. Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted. For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide",
options: [
{
name: "--id",
description: "The distribution ID",
args: {
name: "string",
},
},
{
name: "--if-match",
description:
"The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "get-cache-policy",
description:
"Gets a cache policy, including the following metadata: The policy\u2019s identifier. The date and time when the policy was last modified. To get a cache policy, you must provide the policy\u2019s identifier. If the cache policy is attached to a distribution\u2019s cache behavior, you can get the policy\u2019s identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies",
options: [
{
name: "--id",
description:
"The unique identifier for the cache policy. If the cache policy is attached to a distribution\u2019s cache behavior, you can get the policy\u2019s identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "get-cache-policy-config",
description:
"Gets a cache policy configuration. To get a cache policy configuration, you must provide the policy\u2019s identifier. If the cache policy is attached to a distribution\u2019s cache behavior, you can get the policy\u2019s identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies",
options: [
{
name: "--id",
description:
"The unique identifier for the cache policy. If the cache policy is attached to a distribution\u2019s cache behavior, you can get the policy\u2019s identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "get-cloud-front-origin-access-identity",
description: "Get the information about an origin access identity",
options: [
{
name: "--id",
description: "The identity's ID",
args: {
name: "string",
},
},