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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
|
{
"version": "2.0",
"metadata": {
"apiVersion": "2006-03-01",
"checksumFormat": "md5",
"endpointPrefix": "s3",
"globalEndpoint": "s3.amazonaws.com",
"protocol": "rest-xml",
"serviceAbbreviation": "Amazon S3",
"serviceFullName": "Amazon Simple Storage Service",
"serviceId": "S3",
"signatureVersion": "s3",
"uid": "s3-2006-03-01"
},
"operations": {
"AbortMultipartUpload": {
"name": "AbortMultipartUpload",
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}/{Key+}",
"responseCode": 204
},
"input": {
"shape": "AbortMultipartUploadRequest"
},
"output": {
"shape": "AbortMultipartUploadOutput"
},
"errors": [
{
"shape": "NoSuchUpload"
}
],
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadAbort.html",
"documentation": "<p>This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts. </p> <p>To verify that all parts have been removed, so you don't get charged for the part storage, you should call the <a>ListParts</a> operation and ensure that the parts list is empty.</p> <p>For information about permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload API and Permissions</a>.</p> <p>The following operations are related to <code>AbortMultipartUpload</code>:</p> <ul> <li> <p> <a>CreateMultipartUpload</a> </p> </li> <li> <p> <a>UploadPart</a> </p> </li> <li> <p> <a>CompleteMultipartUpload</a> </p> </li> <li> <p> <a>ListParts</a> </p> </li> <li> <p> <a>ListMultipartUploads</a> </p> </li> </ul>"
},
"CompleteMultipartUpload": {
"name": "CompleteMultipartUpload",
"http": {
"method": "POST",
"requestUri": "/{Bucket}/{Key+}"
},
"input": {
"shape": "CompleteMultipartUploadRequest"
},
"output": {
"shape": "CompleteMultipartUploadOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadComplete.html",
"documentation": "<p>Completes a multipart upload by assembling previously uploaded parts.</p> <p>You first initiate the multipart upload and then upload all parts using the <a>UploadPart</a> operation. After successfully uploading all relevant parts of an upload, you call this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This operation concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the <code>ETag</code> value, returned after that part was uploaded.</p> <p>Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded.</p> <p>Note that if <code>CompleteMultipartUpload</code> fails, applications should be prepared to retry the failed requests. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html\">Amazon S3 Error Best Practices</a>.</p> <p>For more information about multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html\">Uploading Objects Using Multipart Upload</a>.</p> <p>For information about permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload API and Permissions</a>.</p> <p> <code>GetBucketLifecycle</code> has the following special errors:</p> <ul> <li> <p>Error code: <code>EntityTooSmall</code> </p> <ul> <li> <p>Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.</p> </li> <li> <p>400 Bad Request</p> </li> </ul> </li> <li> <p>Error code: <code>InvalidPart</code> </p> <ul> <li> <p>Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.</p> </li> <li> <p>400 Bad Request</p> </li> </ul> </li> <li> <p>Error code: <code>InvalidPartOrder</code> </p> <ul> <li> <p>Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.</p> </li> <li> <p>400 Bad Request</p> </li> </ul> </li> <li> <p>Error code: <code>NoSuchUpload</code> </p> <ul> <li> <p>Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</p> </li> <li> <p>404 Not Found</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>DeleteBucketMetricsConfiguration</code>:</p> <ul> <li> <p> <a>CreateMultipartUpload</a> </p> </li> <li> <p> <a>UploadPart</a> </p> </li> <li> <p> <a>AbortMultipartUpload</a> </p> </li> <li> <p> <a>ListParts</a> </p> </li> <li> <p> <a>ListMultipartUploads</a> </p> </li> </ul>"
},
"CopyObject": {
"name": "CopyObject",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}/{Key+}"
},
"input": {
"shape": "CopyObjectRequest"
},
"output": {
"shape": "CopyObjectOutput"
},
"errors": [
{
"shape": "ObjectNotInActiveTierError"
}
],
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectCOPY.html",
"documentation": "<p>Creates a copy of an object that is already stored in Amazon S3.</p> <note> <p>You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic operation using this API. However, for copying an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html\">Copy Object Using the REST Multipart Upload API</a>.</p> </note> <p>When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html\">Using ACLs</a>.</p> <important> <p>Amazon S3 transfer acceleration does not support cross-region copies. If you request a cross-region copy using a transfer acceleration endpoint, you get a 400 <code>Bad Request</code> error. For more information about transfer acceleration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html\">Transfer Acceleration</a>.</p> </important> <p>All copy requests must be authenticated. Additionally, you must have <i>read</i> access to the source object and <i>write</i> access to the destination bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">REST Authentication</a>. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.</p> <p>To only copy an object under certain conditions, such as whether the <code>Etag</code> matches or whether the object was modified before or after a specified date, use the request parameters <code>x-amz-copy-source-if-match</code>, <code>x-amz-copy-source-if-none-match</code>, <code>x-amz-copy-source-if-unmodified-since</code>, or <code> x-amz-copy-source-if-modified-since</code>.</p> <note> <p>All headers with the <code>x-amz-</code> prefix, including <code>x-amz-copy-source</code>, must be signed.</p> </note> <p>You can use this operation to change the storage class of an object that is already stored in Amazon S3 using the <code>StorageClass</code> parameter. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html\">Storage Classes</a>.</p> <p>The source object that you are copying can be encrypted or unencrypted. If the source object is encrypted, it can be encrypted by server-side encryption using AWS managed encryption keys or by using a customer-provided encryption key. When copying an object, you can request that Amazon S3 encrypt the target object by using either the AWS managed encryption keys or by using your own encryption key. You can do this regardless of the form of server-side encryption that was used to encrypt the source, or even if the source object was not encrypted. For more information about server-side encryption, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html\">Using Server-Side Encryption</a>.</p> <p>A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy operation starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the <code>200 OK</code> response. This means that a <code>200 OK</code> response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.</p> <p>If the copy is successful, you receive a response with information about the copied object.</p> <note> <p>If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.</p> </note> <p>Consider the following when using request headers:</p> <ul> <li> <p> Consideration 1 – If both the <code>x-amz-copy-source-if-match</code> and <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data:</p> <ul> <li> <p> <code>x-amz-copy-source-if-match</code> condition evaluates to true</p> </li> <li> <p> <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to false</p> </li> </ul> </li> <li> <p> Consideration 2 – If both of the <code>x-amz-copy-source-if-none-match</code> and <code>x-amz-copy-source-if-modified-since</code> headers are present in the request and evaluate as follows, Amazon S3 returns the <code>412 Precondition Failed</code> response code:</p> <ul> <li> <p> <code>x-amz-copy-source-if-none-match</code> condition evaluates to false</p> </li> <li> <p> <code>x-amz-copy-source-if-modified-since</code> condition evaluates to true</p> </li> </ul> </li> </ul> <p>The copy request charge is based on the storage class and Region you specify for the destination object. For pricing information, see <a href=\"https://aws.amazon.com/s3/pricing/\">Amazon S3 Pricing</a>.</p> <p>Following are other considerations when using <code>CopyObject</code>:</p> <dl> <dt>Versioning</dt> <dd> <p>By default, <code>x-amz-copy-source</code> identifies the current version of an object to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object was deleted.) To copy a different version, use the <code>versionId</code> subresource.</p> <p>If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the <code>x-amz-version-id</code> response header in the response.</p> <p>If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.</p> <p>If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see .</p> </dd> <dt>Access Permissions</dt> <dd> <p>When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:</p> <ul> <li> <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a>.</p> </li> </ul> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> </dd> <dt>Server-Side- Encryption-Specific Request Headers</dt> <dd> <p>To encrypt the target object, you must provide the appropriate encryption-related request headers. The one you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key. </p> <ul> <li> <p>To encrypt the target object using server-side encryption with an AWS managed encryption key, provide the following request headers, as appropriate.</p> <ul> <li> <p> <code>x-amz-server-side-encryption</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-aws-kms-key-id</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-context</code> </p> </li> </ul> <note> <p>If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but don't provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS CMK, you must provide the <code>x-amz-server-side-encryption-aws-kms-key-id</code> of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> </note> <important> <p>All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.</p> </important> <p>For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">Protecting Data Using Server-Side Encryption with CMKs stored in KMS</a>.</p> </li> <li> <p>To encrypt the target object using server-side encryption with an encryption key that you provide, use the following headers.</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> </li> <li> <p>If the source object is encrypted using server-side encryption with customer-provided encryption keys, you must use the following headers.</p> <ul> <li> <p>x-amz-copy-source-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-copy-source-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-copy-source-server-side-encryption-customer-key-MD5</p> </li> </ul> <p>For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">Protecting Data Using Server-Side Encryption with CMKs stored in Amazon KMS</a>.</p> </li> </ul> </dd> <dt>Access-Control-List (ACL)-Specific Request Headers</dt> <dd> <p>You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html\">Using ACLs</a>. With this operation, you can grant access permissions using one of the following two methods:</p> <ul> <li> <p>Specify a canned ACL (<code>x-amz-acl</code>) — Amazon S3 supports a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees and permissions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a>. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:</p> <ul> <li> <p>x-amz-grant-read</p> </li> <li> <p>x-amz-grant-write</p> </li> <li> <p>x-amz-grant-read-acp</p> </li> <li> <p>x-amz-grant-write-acp</p> </li> <li> <p>x-amz-grant-full-control</p> </li> </ul> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an AWS account</p> </li> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an AWS account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> </ul> <p>For example, the following <code>x-amz-grant-read</code> header grants the AWS accounts identified by email addresses permissions to read object data and its metadata:</p> <p> <code>x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\" </code> </p> </li> </ul> </dd> </dl> <p>The following operations are related to <code>CopyObject</code>:</p> <ul> <li> <p> <a>PutObject</a> </p> </li> <li> <p> <a>GetObject</a> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html\">Copying Objects</a>.</p>",
"alias": "PutObjectCopy"
},
"CreateBucket": {
"name": "CreateBucket",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}"
},
"input": {
"shape": "CreateBucketRequest"
},
"output": {
"shape": "CreateBucketOutput"
},
"errors": [
{
"shape": "BucketAlreadyExists"
},
{
"shape": "BucketAlreadyOwnedByYou"
}
],
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html",
"documentation": "<p>Creates a new bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.</p> <p>Not every string is an acceptable bucket name. For information on bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html\">Working with Amazon S3 Buckets</a>.</p> <p>By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the EU (Ireland) Region. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro\">How to Select a Region for Your Buckets</a>.</p> <note> <p>If you send your create bucket request to the <code>s3.amazonaws.com</code> endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html\">Virtual Hosting of Buckets</a>.</p> </note> <p>When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers.</p> <ul> <li> <p>Specify a canned ACL using the <code>x-amz-acl</code> request header. Amazon S3 supports a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees and permissions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly using the <code>x-amz-grant-read</code>, <code>x-amz-grant-write</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a>.</p> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an AWS account</p> </li> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an AWS account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> </ul> <p>For example, the following <code>x-amz-grant-read</code> header grants the AWS accounts identified by email addresses permissions to read object data and its metadata:</p> <p> <code>x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\" </code> </p> </li> </ul> <note> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> </note> <p>The following operations are related to <code>CreateBucket</code>:</p> <ul> <li> <p> <a>PutObject</a> </p> </li> <li> <p> <a>DeleteBucket</a> </p> </li> </ul>",
"alias": "PutBucket"
},
"CreateMultipartUpload": {
"name": "CreateMultipartUpload",
"http": {
"method": "POST",
"requestUri": "/{Bucket}/{Key+}?uploads"
},
"input": {
"shape": "CreateMultipartUploadRequest"
},
"output": {
"shape": "CreateMultipartUploadOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html",
"documentation": "<p>This operation initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see <a>UploadPart</a>). You also include this upload ID in the final request to either complete or abort the multipart upload request.</p> <p>For more information about multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html\">Multipart Upload Overview</a>.</p> <p>If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort operation and Amazon S3 aborts the multipart upload. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config\">Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy</a>.</p> <p>For information about the permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload API and Permissions</a>.</p> <p>For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html\">Authenticating Requests (AWS Signature Version 4)</a>.</p> <note> <p> After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload. </p> </note> <p>You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use AWS Key Management Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in <a>UploadPart</a>) and <a>UploadPartCopy</a>) requests must match the headers you used in the request to initiate the upload by using <code>CreateMultipartUpload</code>. </p> <p>To perform a multipart upload with encryption using an AWS KMS CMK, the requester must have permission to the <code>kms:Encrypt</code>, <code>kms:Decrypt</code>, <code>kms:ReEncrypt*</code>, <code>kms:GenerateDataKey*</code>, and <code>kms:DescribeKey</code> actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload.</p> <p>If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.</p> <p> For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html\">Protecting Data Using Server-Side Encryption</a>.</p> <dl> <dt>Access Permissions</dt> <dd> <p>When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:</p> <ul> <li> <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a>.</p> </li> </ul> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> </dd> <dt>Server-Side- Encryption-Specific Request Headers</dt> <dd> <p>You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key. </p> <ul> <li> <p>Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request.</p> <ul> <li> <p>x-amz-server-side-encryption</p> </li> <li> <p>x-amz-server-side-encryption-aws-kms-key-id</p> </li> <li> <p>x-amz-server-side-encryption-context</p> </li> </ul> <note> <p>If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but don't provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data.</p> </note> <important> <p>All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.</p> </important> <p>For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS</a>.</p> </li> <li> <p>Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p>For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS</a>.</p> </li> </ul> </dd> <dt>Access-Control-List (ACL)-Specific Request Headers</dt> <dd> <p>You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html\">Using ACLs</a>. With this operation, you can grant access permissions using one of the following two methods:</p> <ul> <li> <p>Specify a canned ACL (<code>x-amz-acl</code>) — Amazon S3 supports a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees and permissions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a>. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:</p> <ul> <li> <p>x-amz-grant-read</p> </li> <li> <p>x-amz-grant-write</p> </li> <li> <p>x-amz-grant-read-acp</p> </li> <li> <p>x-amz-grant-write-acp</p> </li> <li> <p>x-amz-grant-full-control</p> </li> </ul> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an AWS account</p> </li> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an AWS account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> </ul> <p>For example, the following <code>x-amz-grant-read</code> header grants the AWS accounts identified by email addresses permissions to read object data and its metadata:</p> <p> <code>x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\" </code> </p> </li> </ul> </dd> </dl> <p>The following operations are related to <code>CreateMultipartUpload</code>:</p> <ul> <li> <p> <a>UploadPart</a> </p> </li> <li> <p> <a>CompleteMultipartUpload</a> </p> </li> <li> <p> <a>AbortMultipartUpload</a> </p> </li> <li> <p> <a>ListParts</a> </p> </li> <li> <p> <a>ListMultipartUploads</a> </p> </li> </ul>",
"alias": "InitiateMultipartUpload"
},
"DeleteBucket": {
"name": "DeleteBucket",
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}",
"responseCode": 204
},
"input": {
"shape": "DeleteBucketRequest"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETE.html",
"documentation": "<p>Deletes the bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> </p> </li> <li> <p> </p> </li> </ul>"
},
"DeleteBucketAnalyticsConfiguration": {
"name": "DeleteBucketAnalyticsConfiguration",
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?analytics",
"responseCode": 204
},
"input": {
"shape": "DeleteBucketAnalyticsConfigurationRequest"
},
"documentation": "<p>Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).</p> <p>To use this operation, you must have permissions to perform the <code>s3:PutAnalyticsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev//using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about the Amazon S3 analytics feature, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html\">Amazon S3 Analytics – Storage Class Analysis</a>. </p> <p>The following operations are related to <code>DeleteBucketAnalyticsConfiguration</code>:</p> <ul> <li> <p> </p> </li> <li> <p> </p> </li> <li> <p> </p> </li> </ul>"
},
"DeleteBucketCors": {
"name": "DeleteBucketCors",
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?cors",
"responseCode": 204
},
"input": {
"shape": "DeleteBucketCorsRequest"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEcors.html",
"documentation": "<p>Deletes the <code>cors</code> configuration information set for the bucket.</p> <p>To use this operation, you must have permission to perform the <code>s3:PutBucketCORS</code> action. The bucket owner has this permission by default and can grant this permission to others. </p> <p>For information about <code>cors</code>, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html\">Enabling Cross-Origin Resource Sharing</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p class=\"title\"> <b>Related Resources:</b> </p> <ul> <li> <p> </p> </li> <li> <p> <a>RESTOPTIONSobject</a> </p> </li> </ul>"
},
"DeleteBucketEncryption": {
"name": "DeleteBucketEncryption",
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?encryption",
"responseCode": 204
},
"input": {
"shape": "DeleteBucketEncryptionRequest"
},
"documentation": "<p>This implementation of the DELETE operation removes default encryption from the bucket. For information about the Amazon S3 default encryption feature, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev//bucket-encryption.html\">Amazon S3 Default Bucket Encryption</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>To use this operation, you must have permissions to perform the <code>s3:PutEncryptionConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev//using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev//s3-access-control.html\">Managing Access Permissions to your Amazon S3 Resources</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a>PutBucketEncryption</a> </p> </li> <li> <p> <a>GetBucketEncryption</a> </p> </li> </ul>"
},
"DeleteBucketInventoryConfiguration": {
"name": "DeleteBucketInventoryConfiguration",
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?inventory",
"responseCode": 204
},
"input": {
"shape": "DeleteBucketInventoryConfigurationRequest"
},
"documentation": "<p>Deletes an inventory configuration (identified by the inventory ID) from the bucket.</p> <p>To use this operation, you must have permissions to perform the <code>s3:PutInventoryConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about the Amazon S3 inventory feature, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html\">Amazon S3 Inventory</a>.</p> <p>Operations related to <code>DeleteBucketInventoryConfiguration</code> include: </p> <ul> <li> <p> <a>GetBucketInventoryConfiguration</a> </p> </li> <li> <p> <a>PutBucketInventoryConfiguration</a> </p> </li> <li> <p> <a>ListBucketInventoryConfigurations</a> </p> </li> </ul>"
},
"DeleteBucketLifecycle": {
"name": "DeleteBucketLifecycle",
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?lifecycle",
"responseCode": 204
},
"input": {
"shape": "DeleteBucketLifecycleRequest"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETElifecycle.html",
"documentation": "<p>Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.</p> <p>To use this operation, you must have permission to perform the <code>s3:PutLifecycleConfiguration</code> action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others.</p> <p>There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.</p> <p>For more information about the object expiration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions\">Elements to Describe Lifecycle Actions</a>.</p> <p>Related actions include:</p> <ul> <li> <p> <a>PutBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a>GetBucketLifecycleConfiguration</a> </p> </li> </ul>"
},
"DeleteBucketMetricsConfiguration": {
"name": "DeleteBucketMetricsConfiguration",
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?metrics",
"responseCode": 204
},
"input": {
"shape": "DeleteBucketMetricsConfigurationRequest"
},
"documentation": "<p>Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.</p> <p> To use this operation, you must have permissions to perform the <code>s3:PutMetricsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about CloudWatch request metrics for Amazon S3, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html\">Monitoring Metrics with Amazon CloudWatch</a>. </p> <p>The following operations are related to <code>DeleteBucketMetricsConfiguration</code>:</p> <ul> <li> <p> <a>GetBucketMetricsConfiguration</a> </p> </li> <li> <p> <a>PutBucketMetricsConfiguration</a> </p> </li> <li> <p> <a>ListBucketMetricsConfigurations</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html\">Monitoring Metrics with Amazon CloudWatch</a> </p> </li> </ul>"
},
"DeleteBucketPolicy": {
"name": "DeleteBucketPolicy",
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?policy",
"responseCode": 204
},
"input": {
"shape": "DeleteBucketPolicyRequest"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEpolicy.html",
"documentation": "<p>This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the <code>DeleteBucketPolicy</code> permissions on the specified bucket and belong to the bucket owner's account to use this operation. </p> <p>If you don't have <code>DeleteBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error. </p> <important> <p>As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.</p> </important> <p>For more information about bucket policies, see <a href=\" https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html\">Using Bucket Policies and UserPolicies</a>. </p> <p>The following operations are related to <code>DeleteBucketPolicy</code> </p> <ul> <li> <p> <a>CreateBucket</a> </p> </li> <li> <p> <a>DeleteObject</a> </p> </li> </ul>"
},
"DeleteBucketReplication": {
"name": "DeleteBucketReplication",
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?replication",
"responseCode": 204
},
"input": {
"shape": "DeleteBucketReplicationRequest"
},
"documentation": "<p> Deletes the replication configuration from the bucket.</p> <p>To use this operation, you must have permissions to perform the <code>s3:PutReplicationConfiguration</code> action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>. </p> <note> <p>It can take a while for the deletion of a replication configuration to fully propagate.</p> </note> <p> For information about replication configuration, see <a href=\" https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html\">Replication</a> in the <i>Amazon S3 Developer Guide</i>. </p> <p>The following operations are related to <code>DeleteBucketReplication</code>:</p> <ul> <li> <p> <a>PutBucketReplication</a> </p> </li> <li> <p> <a>GetBucketReplication</a> </p> </li> </ul>"
},
"DeleteBucketTagging": {
"name": "DeleteBucketTagging",
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?tagging",
"responseCode": 204
},
"input": {
"shape": "DeleteBucketTaggingRequest"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEtagging.html",
"documentation": "<p>Deletes the tags from the bucket.</p> <p>To use this operation, you must have permission to perform the <code>s3:PutBucketTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others. </p> <p>The following operations are related to <code>DeleteBucketTagging</code>:</p> <ul> <li> <p> <a>GetBucketTagging</a> </p> </li> <li> <p> <a>PutBucketTagging</a> </p> </li> </ul>"
},
"DeleteBucketWebsite": {
"name": "DeleteBucketWebsite",
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?website",
"responseCode": 204
},
"input": {
"shape": "DeleteBucketWebsiteRequest"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEwebsite.html",
"documentation": "<p>This operation removes the website configuration for a bucket. Amazon S3 returns a <code>200 OK</code> response upon successfully deleting a website configuration on the specified bucket. You will get a <code>200 OK</code> response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a <code>404</code> response if the bucket specified in the request does not exist.</p> <p>This DELETE operation requires the <code>S3:DeleteBucketWebsite</code> permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the <code>S3:DeleteBucketWebsite</code> permission. </p> <p>For more information about hosting websites, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html\">Hosting Websites on Amazon S3</a>. </p> <p>The following operations are related to <code>DeleteBucketWebsite</code>:</p> <ul> <li> <p> <a>GetBucketWebsite</a> </p> </li> <li> <p> <a>PutBucketWebsite</a> </p> </li> </ul>"
},
"DeleteObject": {
"name": "DeleteObject",
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}/{Key+}",
"responseCode": 204
},
"input": {
"shape": "DeleteObjectRequest"
},
"output": {
"shape": "DeleteObjectOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectDELETE.html",
"documentation": "<p>Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.</p> <p>To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header, <code>x-amz-delete-marker</code>, to true. </p> <p>If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the <code>x-amz-mfa</code> request header in the DELETE <code>versionId</code> request. Requests that include <code>x-amz-mfa</code> must use HTTPS. </p> <p> For more information about MFA Delete, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html\">Using MFA Delete</a>. To see sample requests that use versioning, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete\">Sample Request</a>. </p> <p>You can delete objects by explicitly calling the DELETE Object API or configure its lifecycle (<a>PutBucketLifecycle</a>) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the <code>s3:DeleteObject</code>, <code>s3:DeleteObjectVersion</code>, and <code>s3:PutLifeCycleConfiguration</code> actions. </p> <p>The following operation is related to <code>DeleteObject</code>:</p> <ul> <li> <p> <a>PutObject</a> </p> </li> </ul>"
},
"DeleteObjectTagging": {
"name": "DeleteObjectTagging",
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}/{Key+}?tagging",
"responseCode": 204
},
"input": {
"shape": "DeleteObjectTaggingRequest"
},
"output": {
"shape": "DeleteObjectTaggingOutput"
},
"documentation": "<p>Removes the entire tag set from the specified object. For more information about managing object tags, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html\"> Object Tagging</a>.</p> <p>To use this operation, you must have permission to perform the <code>s3:DeleteObjectTagging</code> action.</p> <p>To delete tags of a specific object version, add the <code>versionId</code> query parameter in the request. You will need permission for the <code>s3:DeleteObjectVersionTagging</code> action.</p> <p>The following operations are related to <code>DeleteBucketMetricsConfiguration</code>:</p> <ul> <li> <p> <a>PutObjectTagging</a> </p> </li> <li> <p> <a>GetObjectTagging</a> </p> </li> </ul>"
},
"DeleteObjects": {
"name": "DeleteObjects",
"http": {
"method": "POST",
"requestUri": "/{Bucket}?delete"
},
"input": {
"shape": "DeleteObjectsRequest"
},
"output": {
"shape": "DeleteObjectsOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/multiobjectdeleteapi.html",
"documentation": "<p>This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.</p> <p>The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.</p> <p> The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion, the operation does not return any information about the delete in the response body.</p> <p>When performing this operation on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete\"> MFA Delete</a>.</p> <p>Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.</p> <p>The following operations are related to <code>DeleteObjects</code>:</p> <ul> <li> <p> <a>CreateMultipartUpload</a> </p> </li> <li> <p> <a>UploadPart</a> </p> </li> <li> <p> <a>CompleteMultipartUpload</a> </p> </li> <li> <p> <a>ListParts</a> </p> </li> <li> <p> <a>AbortMultipartUpload</a> </p> </li> </ul>",
"alias": "DeleteMultipleObjects"
},
"DeletePublicAccessBlock": {
"name": "DeletePublicAccessBlock",
"http": {
"method": "DELETE",
"requestUri": "/{Bucket}?publicAccessBlock",
"responseCode": 204
},
"input": {
"shape": "DeletePublicAccessBlockRequest"
},
"documentation": "<p>Removes the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use this operation, you must have the <code>s3:PutBucketPublicAccessBlock</code> permission. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>The following operations are related to <code>DeleteBucketMetricsConfiguration</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html\">Using Amazon S3 Block Public Access</a> </p> </li> <li> <p> <a>GetPublicAccessBlock</a> </p> </li> <li> <p> <a>PutPublicAccessBlock</a> </p> </li> <li> <p> <a>GetBucketPolicyStatus</a> </p> </li> </ul>"
},
"GetBucketAccelerateConfiguration": {
"name": "GetBucketAccelerateConfiguration",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?accelerate"
},
"input": {
"shape": "GetBucketAccelerateConfigurationRequest"
},
"output": {
"shape": "GetBucketAccelerateConfigurationOutput"
},
"documentation": "<p>This implementation of the GET operation uses the <code>accelerate</code> subresource to return the Transfer Acceleration state of a bucket, which is either <code>Enabled</code> or <code>Suspended</code>. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetAccelerateConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev//using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev//s3-access-control.html\">Managing Access Permissions to your Amazon S3 Resources</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>You set the Transfer Acceleration state of an existing bucket to <code>Enabled</code> or <code>Suspended</code> by using the <a>PutBucketAccelerateConfiguration</a> operation. </p> <p>A GET <code>accelerate</code> request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket. </p> <p>For more information about transfer acceleration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev//transfer-acceleration.html\">Transfer Acceleration</a> in the Amazon Simple Storage Service Developer Guide.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a>PutBucketAccelerateConfiguration</a> </p> </li> </ul>"
},
"GetBucketAcl": {
"name": "GetBucketAcl",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?acl"
},
"input": {
"shape": "GetBucketAclRequest"
},
"output": {
"shape": "GetBucketAclOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html",
"documentation": "<p>This implementation of the <code>GET</code> operation uses the <code>acl</code> subresource to return the access control list (ACL) of a bucket. To use <code>GET</code> to return the ACL of the bucket, you must have <code>READ_ACP</code> access to the bucket. If <code>READ_ACP</code> permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> </p> </li> </ul>"
},
"GetBucketAnalyticsConfiguration": {
"name": "GetBucketAnalyticsConfiguration",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?analytics"
},
"input": {
"shape": "GetBucketAnalyticsConfigurationRequest"
},
"output": {
"shape": "GetBucketAnalyticsConfigurationOutput"
},
"documentation": "<p>This implementation of the GET operation returns an analytics configuration (identified by the analytics configuration ID) from the bucket.</p> <p>To use this operation, you must have permissions to perform the <code>s3:GetAnalyticsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\"> Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon Simple Storage Service Developer Guide</i>. </p> <p>For information about Amazon S3 analytics feature, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html\">Amazon S3 Analytics – Storage Class Analysis</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> </p> </li> <li> <p> </p> </li> <li> <p> </p> </li> </ul>"
},
"GetBucketCors": {
"name": "GetBucketCors",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?cors"
},
"input": {
"shape": "GetBucketCorsRequest"
},
"output": {
"shape": "GetBucketCorsOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html",
"documentation": "<p>Returns the cors configuration information set for the bucket.</p> <p> To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.</p> <p> For more information about cors, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html\"> Enabling Cross-Origin Resource Sharing</a>.</p> <p>The following operations are related to <code>GetBucketCors</code>:</p> <ul> <li> <p> <a>PutBucketCors</a> </p> </li> <li> <p> <a>DeleteBucketCors</a> </p> </li> </ul>"
},
"GetBucketEncryption": {
"name": "GetBucketEncryption",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?encryption"
},
"input": {
"shape": "GetBucketEncryptionRequest"
},
"output": {
"shape": "GetBucketEncryptionOutput"
},
"documentation": "<p>Returns the default encryption configuration for an Amazon S3 bucket. For information about the Amazon S3 default encryption feature, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html\">Amazon S3 Default Bucket Encryption</a>.</p> <p> To use this operation, you must have permission to perform the <code>s3:GetEncryptionConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>The following operations are related to <code>GetBucketEncryption</code>:</p> <ul> <li> <p> <a>PutBucketEncryption</a> </p> </li> <li> <p> <a>DeleteBucketEncryption</a> </p> </li> </ul>"
},
"GetBucketInventoryConfiguration": {
"name": "GetBucketInventoryConfiguration",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?inventory"
},
"input": {
"shape": "GetBucketInventoryConfigurationRequest"
},
"output": {
"shape": "GetBucketInventoryConfigurationOutput"
},
"documentation": "<p>Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.</p> <p>To use this operation, you must have permissions to perform the <code>s3:GetInventoryConfiguration</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about the Amazon S3 inventory feature, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html\">Amazon S3 Inventory</a>.</p> <p>The following operations are related to <code>GetBucketInventoryConfiguration</code>:</p> <ul> <li> <p> <a>DeleteBucketInventoryConfiguration</a> </p> </li> <li> <p> <a>ListBucketInventoryConfigurations</a> </p> </li> <li> <p> <a>PutBucketInventoryConfiguration</a> </p> </li> </ul>"
},
"GetBucketLifecycle": {
"name": "GetBucketLifecycle",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?lifecycle"
},
"input": {
"shape": "GetBucketLifecycleRequest"
},
"output": {
"shape": "GetBucketLifecycleOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html",
"documentation": "<important> <p>For an updated version of this API, see <a>GetBucketLifecycleConfiguration</a>. If you configured a bucket lifecycle using the <code>filter</code> element, you should see the updated version of this topic. This topic is provided for backward compatibility.</p> </important> <p>Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html\">Object Lifecycle Management</a>.</p> <p> To use this operation, you must have permission to perform the <code>s3:GetLifecycleConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> <code>GetBucketLifecycle</code> has the following special error:</p> <ul> <li> <p>Error code: <code>NoSuchLifecycleConfiguration</code> </p> <ul> <li> <p>Description: The lifecycle configuration does not exist.</p> </li> <li> <p>HTTP Status Code: 404 Not Found</p> </li> <li> <p>SOAP Fault Code Prefix: Client</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>GetBucketLifecycle</code>:</p> <ul> <li> <p> <a>GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a>PutBucketLifecycle</a> </p> </li> <li> <p> <a>DeleteBucketLifecycle</a> </p> </li> </ul>",
"deprecated": true
},
"GetBucketLifecycleConfiguration": {
"name": "GetBucketLifecycleConfiguration",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?lifecycle"
},
"input": {
"shape": "GetBucketLifecycleConfigurationRequest"
},
"output": {
"shape": "GetBucketLifecycleConfigurationOutput"
},
"documentation": "<note> <p>Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are still using previous version of the lifecycle configuration, it works. For the earlier API description, see <a>GetBucketLifecycle</a>.</p> </note> <p>Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html\">Object Lifecycle Management</a>.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetLifecycleConfiguration</code> action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> <code>GetBucketLifecycleConfiguration</code> has the following special error:</p> <ul> <li> <p>Error code: <code>NoSuchLifecycleConfiguration</code> </p> <ul> <li> <p>Description: The lifecycle configuration does not exist.</p> </li> <li> <p>HTTP Status Code: 404 Not Found</p> </li> <li> <p>SOAP Fault Code Prefix: Client</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>DeleteBucketMetricsConfiguration</code>:</p> <ul> <li> <p> <a>GetBucketLifecycle</a> </p> </li> <li> <p> <a>PutBucketLifecycle</a> </p> </li> <li> <p> <a>DeleteBucketLifecycle</a> </p> </li> </ul>"
},
"GetBucketLocation": {
"name": "GetBucketLocation",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?location"
},
"input": {
"shape": "GetBucketLocationRequest"
},
"output": {
"shape": "GetBucketLocationOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html",
"documentation": "<p>Returns the Region the bucket resides in. You set the bucket's Region using the <code>LocationConstraint</code> request parameter in a <code>CreateBucket</code> request. For more information, see <a>CreateBucket</a>.</p> <p> To use this implementation of the operation, you must be the bucket owner.</p> <p>The following operations are related to <code>GetBucketLocation</code>:</p> <ul> <li> <p> <a>GetObject</a> </p> </li> <li> <p> <a>CreateBucket</a> </p> </li> </ul>"
},
"GetBucketLogging": {
"name": "GetBucketLogging",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?logging"
},
"input": {
"shape": "GetBucketLoggingRequest"
},
"output": {
"shape": "GetBucketLoggingOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html",
"documentation": "<p>Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.</p> <p>The following operations are related to <code>GetBucketLogging</code>:</p> <ul> <li> <p> <a>CreateBucket</a> </p> </li> <li> <p> <a>PutBucketLogging</a> </p> </li> </ul>"
},
"GetBucketMetricsConfiguration": {
"name": "GetBucketMetricsConfiguration",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?metrics"
},
"input": {
"shape": "GetBucketMetricsConfigurationRequest"
},
"output": {
"shape": "GetBucketMetricsConfigurationOutput"
},
"documentation": "<p>Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.</p> <p> To use this operation, you must have permissions to perform the <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> For information about CloudWatch request metrics for Amazon S3, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html\">Monitoring Metrics with Amazon CloudWatch</a>.</p> <p>The following operations are related to <code>GetBucketMetricsConfiguration</code>:</p> <ul> <li> <p> <a>PutBucketMetricsConfiguration</a> </p> </li> <li> <p> <a>DeleteBucketMetricsConfiguration</a> </p> </li> <li> <p> <a>ListBucketMetricsConfigurations</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html\">Monitoring Metrics with Amazon CloudWatch</a> </p> </li> </ul>"
},
"GetBucketNotification": {
"name": "GetBucketNotification",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?notification"
},
"input": {
"shape": "GetBucketNotificationConfigurationRequest"
},
"output": {
"shape": "NotificationConfigurationDeprecated"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETnotification.html",
"documentation": "<p> No longer used, see <a>GetBucketNotificationConfiguration</a>.</p>",
"deprecated": true
},
"GetBucketNotificationConfiguration": {
"name": "GetBucketNotificationConfiguration",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?notification"
},
"input": {
"shape": "GetBucketNotificationConfigurationRequest"
},
"output": {
"shape": "NotificationConfiguration"
},
"documentation": "<p>Returns the notification configuration of a bucket.</p> <p>If notifications are not enabled on the bucket, the operation returns an empty <code>NotificationConfiguration</code> element.</p> <p>By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the <code>s3:GetBucketNotification</code> permission.</p> <p>For more information about setting and reading the notification configuration on a bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Setting Up Notification of Bucket Events</a>. For more information about bucket policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html\">Using Bucket Policies</a>.</p> <p>The following operation is related to <code>GetBucketNotification</code>:</p> <ul> <li> <p> <a>PutBucketNotification</a> </p> </li> </ul>"
},
"GetBucketPolicy": {
"name": "GetBucketPolicy",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?policy"
},
"input": {
"shape": "GetBucketPolicyRequest"
},
"output": {
"shape": "GetBucketPolicyOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html",
"documentation": "<p>Returns the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the <code>GetBucketPolicy</code> permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.</p> <p>If you don't have <code>GetBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error.</p> <important> <p>As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.</p> </important> <p>For more information about bucket policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html\">Using Bucket Policies and User Policies</a>.</p> <p>The following operation is related to <code>GetBucketPolicy</code>:</p> <ul> <li> <p> <a>GetObject</a> </p> </li> </ul>"
},
"GetBucketPolicyStatus": {
"name": "GetBucketPolicyStatus",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?policyStatus"
},
"input": {
"shape": "GetBucketPolicyStatusRequest"
},
"output": {
"shape": "GetBucketPolicyStatusOutput"
},
"documentation": "<p>Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the <code>s3:GetBucketPolicyStatus</code> permission. For more information about Amazon S3 permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a>.</p> <p> For more information about when Amazon S3 considers a bucket public, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status\">The Meaning of \"Public\"</a>. </p> <p>The following operations are related to <code>GetBucketPolicyStatus</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html\">Using Amazon S3 Block Public Access</a> </p> </li> <li> <p> <a>GetPublicAccessBlock</a> </p> </li> <li> <p> <a>PutPublicAccessBlock</a> </p> </li> <li> <p> <a>DeletePublicAccessBlock</a> </p> </li> </ul>"
},
"GetBucketReplication": {
"name": "GetBucketReplication",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?replication"
},
"input": {
"shape": "GetBucketReplicationRequest"
},
"output": {
"shape": "GetBucketReplicationOutput"
},
"documentation": "<p>Returns the replication configuration of a bucket.</p> <note> <p> It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result. </p> </note> <p> For information about replication configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html\">Replication</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>This operation requires permissions for the <code>s3:GetReplicationConfiguration</code> action. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html\">Using Bucket Policies and User Policies</a>.</p> <p>If you include the <code>Filter</code> element in a replication configuration, you must also include the <code>DeleteMarkerReplication</code> and <code>Priority</code> elements. The response also returns those elements.</p> <p>For information about <code>GetBucketReplication</code> errors, see <a>ReplicationErrorCodeList</a> </p> <p>The following operations are related to <code>GetBucketReplication</code>:</p> <ul> <li> <p> <a>PutBucketReplication</a> </p> </li> <li> <p> <a>DeleteBucketReplication</a> </p> </li> </ul>"
},
"GetBucketRequestPayment": {
"name": "GetBucketRequestPayment",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?requestPayment"
},
"input": {
"shape": "GetBucketRequestPaymentRequest"
},
"output": {
"shape": "GetBucketRequestPaymentOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html",
"documentation": "<p>Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html\">Requester Pays Buckets</a>.</p> <p>The following operations are related to <code>GetBucketRequestPayment</code>:</p> <ul> <li> <p> <a>ListObjects</a> </p> </li> </ul>"
},
"GetBucketTagging": {
"name": "GetBucketTagging",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?tagging"
},
"input": {
"shape": "GetBucketTaggingRequest"
},
"output": {
"shape": "GetBucketTaggingOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETtagging.html",
"documentation": "<p>Returns the tag set associated with the bucket.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetBucketTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others.</p> <p> <code>GetBucketTagging</code> has the following special error:</p> <ul> <li> <p>Error code: <code>NoSuchTagSetError</code> </p> <ul> <li> <p>Description: There is no tag set associated with the bucket.</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>GetBucketTagging</code>:</p> <ul> <li> <p> <a>PutBucketTagging</a> </p> </li> <li> <p> <a>DeleteBucketTagging</a> </p> </li> </ul>"
},
"GetBucketVersioning": {
"name": "GetBucketVersioning",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?versioning"
},
"input": {
"shape": "GetBucketVersioningRequest"
},
"output": {
"shape": "GetBucketVersioningOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html",
"documentation": "<p>Returns the versioning state of a bucket.</p> <p>To retrieve the versioning state of a bucket, you must be the bucket owner.</p> <p>This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is <code>enabled</code>, the bucket owner must use an authentication device to change the versioning state of the bucket.</p> <p>The following operations are related to <code>GetBucketVersioning</code>:</p> <ul> <li> <p> <a>GetObject</a> </p> </li> <li> <p> <a>PutObject</a> </p> </li> <li> <p> <a>DeleteObject</a> </p> </li> </ul>"
},
"GetBucketWebsite": {
"name": "GetBucketWebsite",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?website"
},
"input": {
"shape": "GetBucketWebsiteRequest"
},
"output": {
"shape": "GetBucketWebsiteOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html",
"documentation": "<p>Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html\">Hosting Websites on Amazon S3</a>. </p> <p>This GET operation requires the <code>S3:GetBucketWebsite</code> permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the <code>S3:GetBucketWebsite</code> permission.</p> <p>The following operations are related to <code>DeleteBucketWebsite</code>:</p> <ul> <li> <p> <a>DeleteBucketWebsite</a> </p> </li> <li> <p> <a>PutBucketWebsite</a> </p> </li> </ul>"
},
"GetObject": {
"name": "GetObject",
"http": {
"method": "GET",
"requestUri": "/{Bucket}/{Key+}"
},
"input": {
"shape": "GetObjectRequest"
},
"output": {
"shape": "GetObjectOutput"
},
"errors": [
{
"shape": "NoSuchKey"
}
],
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html",
"documentation": "<p>Retrieves objects from Amazon S3. To use <code>GET</code>, you must have <code>READ</code> access to the object. If you grant <code>READ</code> access to the anonymous user, you can return the object without using an authorization header.</p> <p>An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object <code>sample.jpg</code>, you can name it <code>photos/2006/February/sample.jpg</code>.</p> <p>To get an object from such a logical hierarchy, specify the full key name for the object in the <code>GET</code> operation. For a virtual hosted-style request example, if you have the object <code>photos/2006/February/sample.jpg</code>, specify the resource as <code>/photos/2006/February/sample.jpg</code>. For a path-style request example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>examplebucket</code>, specify the resource as <code>/examplebucket/photos/2006/February/sample.jpg</code>. For more information about request types, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket\">HTTP Host Header Bucket Specification</a>.</p> <p>To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html\">Amazon S3 Torrent</a>. For more information about returning the ACL of an object, see <a>GetObjectAcl</a>.</p> <p>If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage classes, before you can retrieve the object you must first restore a copy using . Otherwise, this operation returns an <code>InvalidObjectStateError</code> error. For information about restoring archived objects, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html\">Restoring Archived Objects</a>.</p> <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.</p> <p>If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p>For more information about SSE-C, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a>.</p> <p>Assuming you have permission to read object tags (permission for the <code>s3:GetObjectVersionTagging</code> action), the response also returns the <code>x-amz-tagging-count</code> header that provides the count of number of tags associated with the object. You can use <a>GetObjectTagging</a> to retrieve the tag set associated with an object.</p> <p> <b>Permissions</b> </p> <p>You need the <code>s3:GetObject</code> permission for this operation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a>. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the <code>s3:ListBucket</code> permission.</p> <ul> <li> <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 will return an HTTP status code 404 (\"no such key\") error.</p> </li> <li> <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 will return an HTTP status code 403 (\"access denied\") error.</p> </li> </ul> <p> <b>Versioning</b> </p> <p>By default, the GET operation returns the current version of an object. To return a different version, use the <code>versionId</code> subresource.</p> <note> <p>If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes <code>x-amz-delete-marker: true</code> in the response.</p> </note> <p>For more information about versioning, see <a>PutBucketVersioning</a>. </p> <p> <b>Overriding Response Header Values</b> </p> <p>There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.</p> <p>You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are <code>Content-Type</code>, <code>Content-Language</code>, <code>Expires</code>, <code>Cache-Control</code>, <code>Content-Disposition</code>, and <code>Content-Encoding</code>. To override these header values in the GET response, you use the following request parameters.</p> <note> <p>You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.</p> </note> <ul> <li> <p> <code>response-content-type</code> </p> </li> <li> <p> <code>response-content-language</code> </p> </li> <li> <p> <code>response-expires</code> </p> </li> <li> <p> <code>response-cache-control</code> </p> </li> <li> <p> <code>response-content-disposition</code> </p> </li> <li> <p> <code>response-content-encoding</code> </p> </li> </ul> <p> <b>Additional Considerations about Request Headers</b> </p> <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are present in the request as follows: <code>If-Match</code> condition evaluates to <code>true</code>, and; <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>; then, S3 returns 200 OK and the data requested. </p> <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are present in the request as follows:<code> If-None-Match</code> condition evaluates to <code>false</code>, and; <code>If-Modified-Since</code> condition evaluates to <code>true</code>; then, S3 returns 304 Not Modified response code.</p> <p>For more information about conditional requests, see <a href=\"https://tools.ietf.org/html/rfc7232\">RFC 7232</a>.</p> <p>The following operations are related to <code>GetObject</code>:</p> <ul> <li> <p> <a>ListBuckets</a> </p> </li> <li> <p> <a>GetObjectAcl</a> </p> </li> </ul>"
},
"GetObjectAcl": {
"name": "GetObjectAcl",
"http": {
"method": "GET",
"requestUri": "/{Bucket}/{Key+}?acl"
},
"input": {
"shape": "GetObjectAclRequest"
},
"output": {
"shape": "GetObjectAclOutput"
},
"errors": [
{
"shape": "NoSuchKey"
}
],
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETacl.html",
"documentation": "<p>Returns the access control list (ACL) of an object. To use this operation, you must have READ_ACP access to the object.</p> <p> <b>Versioning</b> </p> <p>By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.</p> <p>The following operations are related to <code>GetObjectAcl</code>:</p> <ul> <li> <p> <a>GetObject</a> </p> </li> <li> <p> <a>DeleteObject</a> </p> </li> <li> <p> <a>PutObject</a> </p> </li> </ul>"
},
"GetObjectLegalHold": {
"name": "GetObjectLegalHold",
"http": {
"method": "GET",
"requestUri": "/{Bucket}/{Key+}?legal-hold"
},
"input": {
"shape": "GetObjectLegalHoldRequest"
},
"output": {
"shape": "GetObjectLegalHoldOutput"
},
"documentation": "<p>Gets an object's current Legal Hold status. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a>.</p>"
},
"GetObjectLockConfiguration": {
"name": "GetObjectLockConfiguration",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?object-lock"
},
"input": {
"shape": "GetObjectLockConfigurationRequest"
},
"output": {
"shape": "GetObjectLockConfigurationOutput"
},
"documentation": "<p>Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a>.</p>"
},
"GetObjectRetention": {
"name": "GetObjectRetention",
"http": {
"method": "GET",
"requestUri": "/{Bucket}/{Key+}?retention"
},
"input": {
"shape": "GetObjectRetentionRequest"
},
"output": {
"shape": "GetObjectRetentionOutput"
},
"documentation": "<p>Retrieves an object's retention settings. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a>.</p>"
},
"GetObjectTagging": {
"name": "GetObjectTagging",
"http": {
"method": "GET",
"requestUri": "/{Bucket}/{Key+}?tagging"
},
"input": {
"shape": "GetObjectTaggingRequest"
},
"output": {
"shape": "GetObjectTaggingOutput"
},
"documentation": "<p>Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetObjectTagging</code> action. By default, the GET operation returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the <code>s3:GetObjectVersionTagging</code> action.</p> <p> By default, the bucket owner has this permission and can grant this permission to others.</p> <p> For information about the Amazon S3 object tagging feature, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html\">Object Tagging</a>.</p> <p>The following operation is related to <code>GetObjectTagging</code>:</p> <ul> <li> <p> <a>PutObjectTagging</a> </p> </li> </ul>"
},
"GetObjectTorrent": {
"name": "GetObjectTorrent",
"http": {
"method": "GET",
"requestUri": "/{Bucket}/{Key+}?torrent"
},
"input": {
"shape": "GetObjectTorrentRequest"
},
"output": {
"shape": "GetObjectTorrentOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETtorrent.html",
"documentation": "<p>Return torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html\">Amazon S3 Torrent</a>.</p> <note> <p>You can get torrent only for objects that are less than 5 GB in size and that are not encrypted using server-side encryption with customer-provided encryption key.</p> </note> <p>To use GET, you must have READ access to the object.</p> <p>The following operation is related to <code>GetObjectTorrent</code>:</p> <ul> <li> <p> <a>GetObject</a> </p> </li> </ul>"
},
"GetPublicAccessBlock": {
"name": "GetPublicAccessBlock",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?publicAccessBlock"
},
"input": {
"shape": "GetPublicAccessBlockRequest"
},
"output": {
"shape": "GetPublicAccessBlockOutput"
},
"documentation": "<p>Retrieves the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use this operation, you must have the <code>s3:GetBucketPublicAccessBlock</code> permission. For more information about Amazon S3 permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a>.</p> <important> <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or an object, it checks the <code>PublicAccessBlock</code> configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the <code>PublicAccessBlock</code> settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.</p> </important> <p>For more information about when Amazon S3 considers a bucket or an object public, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status\">The Meaning of \"Public\"</a>.</p> <p>The following operations are related to <code>GetPublicAccessBlock</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html\">Using Amazon S3 Block Public Access</a> </p> </li> <li> <p> <a>PutPublicAccessBlock</a> </p> </li> <li> <p> <a>GetPublicAccessBlock</a> </p> </li> <li> <p> <a>DeletePublicAccessBlock</a> </p> </li> </ul>"
},
"HeadBucket": {
"name": "HeadBucket",
"http": {
"method": "HEAD",
"requestUri": "/{Bucket}"
},
"input": {
"shape": "HeadBucketRequest"
},
"errors": [
{
"shape": "NoSuchBucket"
}
],
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketHEAD.html",
"documentation": "<p>This operation is useful to determine if a bucket exists and you have permission to access it. The operation returns a <code>200 OK</code> if the bucket exists and you have permission to access it. Otherwise, the operation might return responses such as <code>404 Not Found</code> and <code>403 Forbidden</code>. </p> <p>To use this operation, you must have permissions to perform the <code>s3:ListBucket</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p>"
},
"HeadObject": {
"name": "HeadObject",
"http": {
"method": "HEAD",
"requestUri": "/{Bucket}/{Key+}"
},
"input": {
"shape": "HeadObjectRequest"
},
"output": {
"shape": "HeadObjectOutput"
},
"errors": [
{
"shape": "NoSuchKey"
}
],
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html",
"documentation": "<p>The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.</p> <p>A <code>HEAD</code> request has the same options as a <code>GET</code> operation on an object. The response is identical to the <code>GET</code> response except that there is no response body.</p> <p>If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p>For more information about SSE-C, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a>.</p> <note> <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.</p> </note> <p>Request headers are limited to 8 KB in size. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html\">Common Request Headers</a>.</p> <p>Consider the following when using request headers:</p> <ul> <li> <p> Consideration 1 – If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are present in the request as follows:</p> <ul> <li> <p> <code>If-Match</code> condition evaluates to <code>true</code>, and;</p> </li> <li> <p> <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>;</p> </li> </ul> <p>Then Amazon S3 returns <code>200 OK</code> and the data requested.</p> </li> <li> <p> Consideration 2 – If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are present in the request as follows:</p> <ul> <li> <p> <code>If-None-Match</code> condition evaluates to <code>false</code>, and;</p> </li> <li> <p> <code>If-Modified-Since</code> condition evaluates to <code>true</code>;</p> </li> </ul> <p>Then Amazon S3 returns the <code>304 Not Modified</code> response code.</p> </li> </ul> <p>For more information about conditional requests, see <a href=\"https://tools.ietf.org/html/rfc7232\">RFC 7232</a>.</p> <p> <b>Permissions</b> </p> <p>You need the <code>s3:GetObject</code> permission for this operation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a>. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.</p> <ul> <li> <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns an HTTP status code 404 (\"no such key\") error.</p> </li> <li> <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP status code 403 (\"access denied\") error.</p> </li> </ul> <p>The following operation is related to <code>HeadObject</code>:</p> <ul> <li> <p> <a>GetObject</a> </p> </li> </ul>"
},
"ListBucketAnalyticsConfigurations": {
"name": "ListBucketAnalyticsConfigurations",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?analytics"
},
"input": {
"shape": "ListBucketAnalyticsConfigurationsRequest"
},
"output": {
"shape": "ListBucketAnalyticsConfigurationsOutput"
},
"documentation": "<p>Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.</p> <p>This operation supports list pagination and does not return more than 100 configurations at a time. You should always check the <code>IsTruncated</code> element in the response. If there are no more configurations to list, <code>IsTruncated</code> is set to false. If there are more configurations to list, <code>IsTruncated</code> is set to true, and there will be a value in <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value to continue the pagination of the list by passing the value in continuation-token in the request to <code>GET</code> the next page.</p> <p>To use this operation, you must have permissions to perform the <code>s3:GetAnalyticsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about Amazon S3 analytics feature, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html\">Amazon S3 Analytics – Storage Class Analysis</a>. </p> <p>The following operations are related to <code>ListBucketAnalyticsConfigurations</code>:</p> <ul> <li> <p> <a>GetBucketAnalyticsConfiguration</a> </p> </li> <li> <p> <a>DeleteBucketAnalyticsConfiguration</a> </p> </li> <li> <p> <a>PutBucketAnalyticsConfiguration</a> </p> </li> </ul>"
},
"ListBucketInventoryConfigurations": {
"name": "ListBucketInventoryConfigurations",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?inventory"
},
"input": {
"shape": "ListBucketInventoryConfigurationsRequest"
},
"output": {
"shape": "ListBucketInventoryConfigurationsOutput"
},
"documentation": "<p>Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.</p> <p>This operation supports list pagination and does not return more than 100 configurations at a time. Always check the <code>IsTruncated</code> element in the response. If there are no more configurations to list, <code>IsTruncated</code> is set to false. If there are more configurations to list, <code>IsTruncated</code> is set to true, and there is a value in <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value to continue the pagination of the list by passing the value in continuation-token in the request to <code>GET</code> the next page.</p> <p> To use this operation, you must have permissions to perform the <code>s3:GetInventoryConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about the Amazon S3 inventory feature, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html\">Amazon S3 Inventory</a> </p> <p>The following operations are related to <code>ListBucketInventoryConfigurations</code>:</p> <ul> <li> <p> <a>GetBucketInventoryConfiguration</a> </p> </li> <li> <p> <a>DeleteBucketInventoryConfiguration</a> </p> </li> <li> <p> <a>PutBucketInventoryConfiguration</a> </p> </li> </ul>"
},
"ListBucketMetricsConfigurations": {
"name": "ListBucketMetricsConfigurations",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?metrics"
},
"input": {
"shape": "ListBucketMetricsConfigurationsRequest"
},
"output": {
"shape": "ListBucketMetricsConfigurationsOutput"
},
"documentation": "<p>Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.</p> <p>This operation supports list pagination and does not return more than 100 configurations at a time. Always check the <code>IsTruncated</code> element in the response. If there are no more configurations to list, <code>IsTruncated</code> is set to false. If there are more configurations to list, <code>IsTruncated</code> is set to true, and there is a value in <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value to continue the pagination of the list by passing the value in <code>continuation-token</code> in the request to <code>GET</code> the next page.</p> <p>To use this operation, you must have permissions to perform the <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For more information about metrics configurations and CloudWatch request metrics, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html\">Monitoring Metrics with Amazon CloudWatch</a>.</p> <p>The following operations are related to <code>ListBucketMetricsConfigurations</code>:</p> <ul> <li> <p> <a>PutBucketMetricsConfiguration</a> </p> </li> <li> <p> <a>GetBucketMetricsConfiguration</a> </p> </li> <li> <p> <a>DeleteBucketMetricsConfiguration</a> </p> </li> </ul>"
},
"ListBuckets": {
"name": "ListBuckets",
"http": {
"method": "GET",
"requestUri": "/"
},
"output": {
"shape": "ListBucketsOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html",
"documentation": "<p>Returns a list of all buckets owned by the authenticated sender of the request.</p>",
"alias": "GetService"
},
"ListMultipartUploads": {
"name": "ListMultipartUploads",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?uploads"
},
"input": {
"shape": "ListMultipartUploadsRequest"
},
"output": {
"shape": "ListMultipartUploadsOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html",
"documentation": "<p>This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.</p> <p>This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the <code>max-uploads</code> parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an <code>IsTruncated</code> element with the value true. To list the additional multipart uploads, use the <code>key-marker</code> and <code>upload-id-marker</code> request parameters.</p> <p>In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.</p> <p>For more information on multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html\">Uploading Objects Using Multipart Upload</a>.</p> <p>For information on permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload API and Permissions</a>.</p> <p>The following operations are related to <code>ListMultipartUploads</code>:</p> <ul> <li> <p> <a>CreateMultipartUpload</a> </p> </li> <li> <p> <a>UploadPart</a> </p> </li> <li> <p> <a>CompleteMultipartUpload</a> </p> </li> <li> <p> <a>ListParts</a> </p> </li> <li> <p> <a>AbortMultipartUpload</a> </p> </li> </ul>"
},
"ListObjectVersions": {
"name": "ListObjectVersions",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?versions"
},
"input": {
"shape": "ListObjectVersionsRequest"
},
"output": {
"shape": "ListObjectVersionsOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html",
"documentation": "<p>Returns metadata about all of the versions of objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions. </p> <note> <p> A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.</p> </note> <p>To use this operation, you must have READ access to the bucket.</p> <p>The following operations are related to <code>ListObjectVersions</code>:</p> <ul> <li> <p> <a>ListObjectsV2</a> </p> </li> <li> <p> <a>GetObject</a> </p> </li> <li> <p> <a>PutObject</a> </p> </li> <li> <p> <a>DeleteObject</a> </p> </li> </ul>",
"alias": "GetBucketObjectVersions"
},
"ListObjects": {
"name": "ListObjects",
"http": {
"method": "GET",
"requestUri": "/{Bucket}"
},
"input": {
"shape": "ListObjectsRequest"
},
"output": {
"shape": "ListObjectsOutput"
},
"errors": [
{
"shape": "NoSuchBucket"
}
],
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html",
"documentation": "<p>Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.</p> <important> <p>This API has been revised. We recommend that you use the newer version, <a>ListObjectsV2</a>, when developing applications. For backward compatibility, Amazon S3 continues to support <code>ListObjects</code>.</p> </important> <p>The following operations are related to <code>ListObjects</code>:</p> <ul> <li> <p> <a>ListObjectsV2</a> </p> </li> <li> <p> <a>GetObject</a> </p> </li> <li> <p> <a>PutObject</a> </p> </li> <li> <p> <a>CreateBucket</a> </p> </li> <li> <p> <a>ListBuckets</a> </p> </li> </ul>",
"alias": "GetBucket"
},
"ListObjectsV2": {
"name": "ListObjectsV2",
"http": {
"method": "GET",
"requestUri": "/{Bucket}?list-type=2"
},
"input": {
"shape": "ListObjectsV2Request"
},
"output": {
"shape": "ListObjectsV2Output"
},
"errors": [
{
"shape": "NoSuchBucket"
}
],
"documentation": "<p>Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A <code>200 OK</code> response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.</p> <p>To use this operation, you must have READ access to the bucket.</p> <p>To use this operation in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform the <code>s3:ListBucket</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <important> <p>This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, <a>ListObjects</a>.</p> </important> <p>To get a list of your buckets, see <a>ListBuckets</a>.</p> <p>The following operations are related to <code>ListObjectsV2</code>:</p> <ul> <li> <p> <a>GetObject</a> </p> </li> <li> <p> <a>PutObject</a> </p> </li> <li> <p> <a>CreateBucket</a> </p> </li> </ul>"
},
"ListParts": {
"name": "ListParts",
"http": {
"method": "GET",
"requestUri": "/{Bucket}/{Key+}"
},
"input": {
"shape": "ListPartsRequest"
},
"output": {
"shape": "ListPartsOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html",
"documentation": "<p>Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see <a>CreateMultipartUpload</a>). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the <code>max-parts</code> request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an <code>IsTruncated</code> field with the value of true, and a <code>NextPartNumberMarker</code> element. In subsequent <code>ListParts</code> requests you can include the part-number-marker query string parameter and set its value to the <code>NextPartNumberMarker</code> field value from the previous response.</p> <p>For more information on multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html\">Uploading Objects Using Multipart Upload</a>.</p> <p>For information on permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload API and Permissions</a>.</p> <p>The following operations are related to <code>ListParts</code>:</p> <ul> <li> <p> <a>CreateMultipartUpload</a> </p> </li> <li> <p> <a>UploadPart</a> </p> </li> <li> <p> <a>CompleteMultipartUpload</a> </p> </li> <li> <p> <a>AbortMultipartUpload</a> </p> </li> <li> <p> <a>ListMultipartUploads</a> </p> </li> </ul>"
},
"PutBucketAccelerateConfiguration": {
"name": "PutBucketAccelerateConfiguration",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?accelerate"
},
"input": {
"shape": "PutBucketAccelerateConfigurationRequest"
},
"documentation": "<p>Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.</p> <p> To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> The Transfer Acceleration state of a bucket can be set to one of the following two values:</p> <ul> <li> <p> Enabled – Enables accelerated data transfers to the bucket.</p> </li> <li> <p> Suspended – Disables accelerated data transfers to the bucket.</p> </li> </ul> <p>The <a>GetBucketAccelerateConfiguration</a> operation returns the transfer acceleration state of a bucket.</p> <p>After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.</p> <p> The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (\".\").</p> <p> For more information about transfer acceleration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html\">Transfer Acceleration</a>.</p> <p>The following operations are related to <code>PutBucketAccelerateConfiguration</code>:</p> <ul> <li> <p> <a>GetBucketAccelerateConfiguration</a> </p> </li> <li> <p> <a>CreateBucket</a> </p> </li> </ul>"
},
"PutBucketAcl": {
"name": "PutBucketAcl",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?acl"
},
"input": {
"shape": "PutBucketAclRequest"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html",
"documentation": "<p>Sets the permissions on an existing bucket using access control lists (ACL). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html\">Using ACLs</a>. To set the ACL of a bucket, you must have <code>WRITE_ACP</code> permission.</p> <p>You can use one of the following two ways to set a bucket's permissions:</p> <ul> <li> <p>Specify the ACL in the request body</p> </li> <li> <p>Specify permissions using request headers</p> </li> </ul> <note> <p>You cannot specify access permission using both the body and the request headers.</p> </note> <p>Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.</p> <p> <b>Access Permissions</b> </p> <p>You can set access permissions using one of the following methods:</p> <ul> <li> <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 supports a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of <code>x-amz-acl</code>. If you use this header, you cannot use other access control-specific headers in your request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. When using these headers, you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the <code>x-amz-acl</code> header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a>.</p> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an AWS account</p> </li> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an AWS account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> </ul> <p>For example, the following <code>x-amz-grant-write</code> header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two AWS accounts identified by their email addresses.</p> <p> <code>x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\", emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\" </code> </p> </li> </ul> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> <p> <b>Grantee Values</b> </p> <p>You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:</p> <ul> <li> <p>By Email address:</p> <p> <code><Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee></code> </p> <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.</p> </li> <li> <p>By the person's ID:</p> <p> <code><Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee></code> </p> <p>DisplayName is optional and ignored in the request</p> </li> <li> <p>By URI:</p> <p> <code><Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code> </p> </li> </ul> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a>CreateBucket</a> </p> </li> <li> <p> <a>DeleteBucket</a> </p> </li> <li> <p> <a>GetObjectAcl</a> </p> </li> </ul>"
},
"PutBucketAnalyticsConfiguration": {
"name": "PutBucketAnalyticsConfiguration",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?analytics"
},
"input": {
"shape": "PutBucketAnalyticsConfigurationRequest"
},
"documentation": "<p>Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.</p> <p>You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the <code>DataExport</code> request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html\">Amazon S3 Analytics – Storage Class Analysis</a>. </p> <important> <p>You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9\">Granting Permissions for Amazon S3 Inventory and Storage Class Analysis</a>.</p> </important> <p>To use this operation, you must have permissions to perform the <code>s3:PutAnalyticsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p class=\"title\"> <b>Special Errors</b> </p> <ul> <li> <ul> <li> <p> <i>HTTP Error: HTTP 400 Bad Request</i> </p> </li> <li> <p> <i>Code: InvalidArgument</i> </p> </li> <li> <p> <i>Cause: Invalid argument.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>HTTP Error: HTTP 400 Bad Request</i> </p> </li> <li> <p> <i>Code: TooManyConfigurations</i> </p> </li> <li> <p> <i>Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>HTTP Error: HTTP 403 Forbidden</i> </p> </li> <li> <p> <i>Code: AccessDenied</i> </p> </li> <li> <p> <i>Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.</i> </p> </li> </ul> </li> </ul> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> </p> </li> <li> <p> </p> </li> <li> <p> </p> </li> </ul>"
},
"PutBucketCors": {
"name": "PutBucketCors",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?cors"
},
"input": {
"shape": "PutBucketCorsRequest"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTcors.html",
"documentation": "<p>Sets the <code>cors</code> configuration for your bucket. If the configuration exists, Amazon S3 replaces it.</p> <p>To use this operation, you must be allowed to perform the <code>s3:PutBucketCORS</code> action. By default, the bucket owner has this permission and can grant it to others.</p> <p>You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is <code>http://www.example.com</code> to access your Amazon S3 bucket at <code>my.example.bucket.com</code> by using the browser's <code>XMLHttpRequest</code> capability.</p> <p>To enable cross-origin resource sharing (CORS) on a bucket, you add the <code>cors</code> subresource to the bucket. The <code>cors</code> subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size. </p> <p>When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the <code>cors</code> configuration on the bucket and uses the first <code>CORSRule</code> rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:</p> <ul> <li> <p>The request's <code>Origin</code> header must match <code>AllowedOrigin</code> elements.</p> </li> <li> <p>The request method (for example, GET, PUT, HEAD, and so on) or the <code>Access-Control-Request-Method</code> header in case of a pre-flight <code>OPTIONS</code> request must be one of the <code>AllowedMethod</code> elements. </p> </li> <li> <p>Every header specified in the <code>Access-Control-Request-Headers</code> request header of a pre-flight request must match an <code>AllowedHeader</code> element. </p> </li> </ul> <p> For more information about CORS, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html\">Enabling Cross-Origin Resource Sharing</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a>GetBucketCors</a> </p> </li> <li> <p> <a>DeleteBucketCors</a> </p> </li> <li> <p> <a>RESTOPTIONSobject</a> </p> </li> </ul>"
},
"PutBucketEncryption": {
"name": "PutBucketEncryption",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?encryption"
},
"input": {
"shape": "PutBucketEncryptionRequest"
},
"documentation": "<p>This implementation of the <code>PUT</code> operation uses the <code>encryption</code> subresource to set the default encryption state of an existing bucket.</p> <p>This implementation of the <code>PUT</code> operation sets default encryption for a bucket using server-side encryption with Amazon S3-managed keys SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS).</p> <important> <p>This operation requires AWS Signature Version 4. For more information, see <a href=\"sig-v4-authenticating-requests.html\"> Authenticating Requests (AWS Signature Version 4)</a>. </p> </important> <p>To use this operation, you must have permissions to perform the <code>s3:PutEncryptionConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a> in the Amazon Simple Storage Service Developer Guide. </p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a>GetBucketEncryption</a> </p> </li> <li> <p> <a>DeleteBucketEncryption</a> </p> </li> </ul>"
},
"PutBucketInventoryConfiguration": {
"name": "PutBucketInventoryConfiguration",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?inventory"
},
"input": {
"shape": "PutBucketInventoryConfigurationRequest"
},
"documentation": "<p>This implementation of the <code>PUT</code> operation adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket. </p> <p>Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the <i>source</i> bucket, and the bucket where the inventory flat file is stored is called the <i>destination</i> bucket. The <i>destination</i> bucket must be in the same AWS Region as the <i>source</i> bucket. </p> <p>When you configure an inventory for a <i>source</i> bucket, you specify the <i>destination</i> bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev//storage-inventory.html\">Amazon S3 Inventory</a> in the Amazon Simple Storage Service Developer Guide.</p> <important> <p>You must create a bucket policy on the <i>destination</i> bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9\"> Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.</a> </p> </important> <p>To use this operation, you must have permissions to perform the <code>s3:PutInventoryConfiguration</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev//using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev//s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a> in the Amazon Simple Storage Service Developer Guide.</p> <p class=\"title\"> <b>Special Errors</b> </p> <ul> <li> <p class=\"title\"> <b>HTTP 400 Bad Request Error</b> </p> <ul> <li> <p> <i>Code:</i> InvalidArgument</p> </li> <li> <p> <i>Cause:</i> Invalid Argument</p> </li> </ul> </li> <li> <p class=\"title\"> <b>HTTP 400 Bad Request Error</b> </p> <ul> <li> <p> <i>Code:</i> TooManyConfigurations</p> </li> <li> <p> <i>Cause:</i> You are attempting to create a new configuration but have already reached the 1,000-configuration limit. </p> </li> </ul> </li> <li> <p class=\"title\"> <b>HTTP 403 Forbidden Error</b> </p> <ul> <li> <p> <i>Code:</i> AccessDenied</p> </li> <li> <p> <i>Cause:</i> You are not the owner of the specified bucket, or you do not have the <code>s3:PutInventoryConfiguration</code> bucket permission to set the configuration on the bucket </p> </li> </ul> </li> </ul> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a>GetBucketInventoryConfiguration</a> </p> </li> <li> <p> <a>DeleteBucketInventoryConfiguration</a> </p> </li> <li> <p> <a>ListBucketInventoryConfigurations</a> </p> </li> </ul>"
},
"PutBucketLifecycle": {
"name": "PutBucketLifecycle",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?lifecycle"
},
"input": {
"shape": "PutBucketLifecycleRequest"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html",
"documentation": "<important> <p>For an updated version of this API, see <a>PutBucketLifecycleConfiguration</a>. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API. </p> </important> <p>Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev//object-lifecycle-mgmt.html\">Object Lifecycle Management</a> in the <i>Amazon Simple Storage Service Developer Guide</i>. </p> <p>By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the AWS account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the <code>s3:PutLifecycleConfiguration</code> permission.</p> <p>You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: </p> <ul> <li> <p> <code>s3:DeleteObject</code> </p> </li> <li> <p> <code>s3:DeleteObjectVersion</code> </p> </li> <li> <p> <code>s3:PutLifecycleConfiguration</code> </p> </li> </ul> <p>For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev//s3-access-control.html\">Managing Access Permissions to your Amazon S3 Resources</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev//intro-lifecycle-rules.html#lifecycle-configuration-examples\">Examples of Lifecycle Configuration</a>.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a>GetBucketLifecycle</a>(Deprecated)</p> </li> <li> <p> <a>GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> </p> </li> <li> <p>By default, a resource owner—in this case, a bucket owner, which is the AWS account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon Simple Storage Service Developer Guide: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev//using-with-s3-actions.html\">Specifying Permissions in a Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev//s3-access-control.html\">Managing Access Permissions to your Amazon S3 Resources</a> </p> </li> </ul> </li> </ul>",
"deprecated": true
},
"PutBucketLifecycleConfiguration": {
"name": "PutBucketLifecycleConfiguration",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?lifecycle"
},
"input": {
"shape": "PutBucketLifecycleConfigurationRequest"
},
"documentation": "<p>Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <note> <p>Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see <a>PutBucketLifecycle</a>.</p> </note> <p> <b>Rules</b> </p> <p>You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following:</p> <ul> <li> <p>Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.</p> </li> <li> <p>Status whether the rule is in effect.</p> </li> <li> <p>One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html\">Object Lifecycle Management</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html\">Lifecycle Configuration Elements</a>.</p> <p> <b>Permissions</b> </p> <p>By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the AWS account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.</p> <p>You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:</p> <ul> <li> <p>s3:DeleteObject</p> </li> <li> <p>s3:DeleteObjectVersion</p> </li> <li> <p>s3:PutLifecycleConfiguration</p> </li> </ul> <p>For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>The following are related to <code>PutBucketLifecycleConfiguration</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html\">Examples of Lifecycle Configuration</a> </p> </li> <li> <p> <a>GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a>DeleteBucketLifecycle</a> </p> </li> </ul>"
},
"PutBucketLogging": {
"name": "PutBucketLogging",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?logging"
},
"input": {
"shape": "PutBucketLoggingRequest"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlogging.html",
"documentation": "<p>Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.</p> <p>The bucket owner is automatically granted FULL_CONTROL to all logs. You use the <code>Grantee</code> request element to grant access to other people. The <code>Permissions</code> request element specifies the kind of access the grantee has to the logs.</p> <p> <b>Grantee Values</b> </p> <p>You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:</p> <ul> <li> <p>By the person's ID:</p> <p> <code><Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee></code> </p> <p>DisplayName is optional and ignored in the request.</p> </li> <li> <p>By Email address:</p> <p> <code> <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee></code> </p> <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.</p> </li> <li> <p>By URI:</p> <p> <code><Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code> </p> </li> </ul> <p>To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:</p> <p> <code><BucketLoggingStatus xmlns=\"http://doc.s3.amazonaws.com/2006-03-01\" /></code> </p> <p>For more information about server access logging, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerLogs.html\">Server Access Logging</a>. </p> <p>For more information about creating a bucket, see <a>CreateBucket</a>. For more information about returning the logging status of a bucket, see <a>GetBucketLogging</a>.</p> <p>The following operations are related to <code>PutBucketLogging</code>:</p> <ul> <li> <p> <a>PutObject</a> </p> </li> <li> <p> <a>DeleteBucket</a> </p> </li> <li> <p> <a>CreateBucket</a> </p> </li> <li> <p> <a>GetBucketLogging</a> </p> </li> </ul>"
},
"PutBucketMetricsConfiguration": {
"name": "PutBucketMetricsConfiguration",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?metrics"
},
"input": {
"shape": "PutBucketMetricsConfigurationRequest"
},
"documentation": "<p>Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased.</p> <p>To use this operation, you must have permissions to perform the <code>s3:PutMetricsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about CloudWatch request metrics for Amazon S3, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html\">Monitoring Metrics with Amazon CloudWatch</a>.</p> <p>The following operations are related to <code>PutBucketMetricsConfiguration</code>:</p> <ul> <li> <p> <a>DeleteBucketMetricsConfiguration</a> </p> </li> <li> <p> <a>PutBucketMetricsConfiguration</a> </p> </li> <li> <p> <a>ListBucketMetricsConfigurations</a> </p> </li> </ul> <p> <code>GetBucketLifecycle</code> has the following special error:</p> <ul> <li> <p>Error code: <code>TooManyConfigurations</code> </p> <ul> <li> <p>Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.</p> </li> <li> <p>HTTP Status Code: HTTP 400 Bad Request</p> </li> </ul> </li> </ul>"
},
"PutBucketNotification": {
"name": "PutBucketNotification",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?notification"
},
"input": {
"shape": "PutBucketNotificationRequest"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTnotification.html",
"documentation": "<p> No longer used, see the <a>PutBucketNotificationConfiguration</a> operation.</p>",
"deprecated": true
},
"PutBucketNotificationConfiguration": {
"name": "PutBucketNotificationConfiguration",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?notification"
},
"input": {
"shape": "PutBucketNotificationConfigurationRequest"
},
"documentation": "<p>Enables notifications of specified events for a bucket. For more information about event notifications, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Configuring Event Notifications</a>.</p> <p>Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.</p> <p>By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty <code>NotificationConfiguration</code>.</p> <p> <code><NotificationConfiguration></code> </p> <p> <code></NotificationConfiguration></code> </p> <p>This operation replaces the existing notification configuration with the configuration you include in the request body.</p> <p>After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Configuring Notifications for Amazon S3 Events</a>.</p> <p>You can disable notifications by adding the empty NotificationConfiguration element.</p> <p>By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with <code>s3:PutBucketNotification</code> permission.</p> <note> <p>The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add the configuration to your bucket.</p> </note> <p> <b>Responses</b> </p> <p>If the configuration in the request body includes only one <code>TopicConfiguration</code> specifying only the <code>s3:ReducedRedundancyLostObject</code> event type, the response will also include the <code>x-amz-sns-test-message-id</code> header containing the message ID of the test notification sent to the topic.</p> <p>The following operation is related to <code>PutBucketNotificationConfiguration</code>:</p> <ul> <li> <p> <a>GetBucketNotificationConfiguration</a> </p> </li> </ul>"
},
"PutBucketPolicy": {
"name": "PutBucketPolicy",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?policy"
},
"input": {
"shape": "PutBucketPolicyRequest"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html",
"documentation": "<p>Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the <code>PutBucketPolicy</code> permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.</p> <p>If you don't have <code>PutBucketPolic</code>y permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error.</p> <important> <p> As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. </p> </important> <p>For more information about bucket policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html\">Using Bucket Policies and User Policies</a>.</p> <p>The following operations are related to <code>PutBucketPolicy</code>:</p> <ul> <li> <p> <a>CreateBucket</a> </p> </li> <li> <p> <a>DeleteBucket</a> </p> </li> </ul>"
},
"PutBucketReplication": {
"name": "PutBucketReplication",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?replication"
},
"input": {
"shape": "PutBucketReplicationRequest"
},
"documentation": "<p> Creates a replication configuration or replaces an existing one. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html\">Replication</a> in the <i>Amazon S3 Developer Guide</i>. </p> <note> <p>To perform this operation, the user or role performing the operation must have the <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html\">iam:PassRole</a> permission.</p> </note> <p>Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.</p> <p>A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. All rules must specify the same destination bucket.</p> <p>To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: <code>DeleteMarkerReplication</code>, <code>Status</code>, and <code>Priority</code>.</p> <p>For information about enabling versioning on a bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html\">Using Versioning</a>.</p> <p>By default, a resource owner, in this case the AWS account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> <b>Handling Replication of Encrypted Objects</b> </p> <p>By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following: <code>SourceSelectionCriteria</code>, <code>SseKmsEncryptedObjects</code>, <code>Status</code>, <code>EncryptionConfiguration</code>, and <code>ReplicaKmsKeyID</code>. For information about replication configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html\">Replicating Objects Created with SSE Using CMKs stored in AWS KMS</a>.</p> <p>For information on <code>PutBucketReplication</code> errors, see <a>ReplicationErrorCodeList</a> </p> <p>The following operations are related to <code>PutBucketReplication</code>:</p> <ul> <li> <p> <a>GetBucketReplication</a> </p> </li> <li> <p> <a>DeleteBucketReplication</a> </p> </li> </ul>"
},
"PutBucketRequestPayment": {
"name": "PutBucketRequestPayment",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?requestPayment"
},
"input": {
"shape": "PutBucketRequestPaymentRequest"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentPUT.html",
"documentation": "<p>Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html\">Requester Pays Buckets</a>.</p> <p>The following operations are related to <code>PutBucketRequestPayment</code>:</p> <ul> <li> <p> <a>CreateBucket</a> </p> </li> <li> <p> <a>GetBucketRequestPayment</a> </p> </li> </ul>"
},
"PutBucketTagging": {
"name": "PutBucketTagging",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?tagging"
},
"input": {
"shape": "PutBucketTaggingRequest"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTtagging.html",
"documentation": "<p>Sets the tags for a bucket.</p> <p>Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Cost Allocation and Tagging</a>.</p> <note> <p>Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html\">Using Cost Allocation in Amazon S3 Bucket Tags</a>.</p> </note> <p>To use this operation, you must have permissions to perform the <code>s3:PutBucketTagging</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> <code>PutBucketTagging</code> has the following special errors:</p> <ul> <li> <p>Error code: <code>InvalidTagError</code> </p> <ul> <li> <p>Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2//allocation-tag-restrictions.html\">User-Defined Tag Restrictions</a> and <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2//aws-tag-restrictions.html\">AWS-Generated Cost Allocation Tag Restrictions</a>.</p> </li> </ul> </li> <li> <p>Error code: <code>MalformedXMLError</code> </p> <ul> <li> <p>Description: The XML provided does not match the schema.</p> </li> </ul> </li> <li> <p>Error code: <code>OperationAbortedError </code> </p> <ul> <li> <p>Description: A conflicting conditional operation is currently in progress against this resource. Please try again.</p> </li> </ul> </li> <li> <p>Error code: <code>InternalError</code> </p> <ul> <li> <p>Description: The service was unable to apply the provided tag to the bucket.</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>PutBucketTagging</code>:</p> <ul> <li> <p> <a>GetBucketTagging</a> </p> </li> <li> <p> <a>DeleteBucketTagging</a> </p> </li> </ul>"
},
"PutBucketVersioning": {
"name": "PutBucketVersioning",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?versioning"
},
"input": {
"shape": "PutBucketVersioningRequest"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html",
"documentation": "<p>Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.</p> <p>You can set the versioning state with one of the following values:</p> <p> <b>Enabled</b>—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.</p> <p> <b>Suspended</b>—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.</p> <p>If the versioning state has never been set on a bucket, it has no versioning state; a <a>GetBucketVersioning</a> request does not return a versioning state value.</p> <p>If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the <code>x-amz-mfa request</code> header and the <code>Status</code> and the <code>MfaDelete</code> request elements in a request to set the versioning state of the bucket.</p> <important> <p>If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config\">Lifecycle and Versioning</a>.</p> </important> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a>CreateBucket</a> </p> </li> <li> <p> <a>DeleteBucket</a> </p> </li> <li> <p> <a>GetBucketVersioning</a> </p> </li> </ul>"
},
"PutBucketWebsite": {
"name": "PutBucketWebsite",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?website"
},
"input": {
"shape": "PutBucketWebsiteRequest"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html",
"documentation": "<p>Sets the configuration of the website that is specified in the <code>website</code> subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html\">Hosting Websites on Amazon S3</a>.</p> <p>This PUT operation requires the <code>S3:PutBucketWebsite</code> permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the <code>S3:PutBucketWebsite</code> permission.</p> <p>To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket.</p> <ul> <li> <p> <code>WebsiteConfiguration</code> </p> </li> <li> <p> <code>RedirectAllRequestsTo</code> </p> </li> <li> <p> <code>HostName</code> </p> </li> <li> <p> <code>Protocol</code> </p> </li> </ul> <p>If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected. </p> <ul> <li> <p> <code>WebsiteConfiguration</code> </p> </li> <li> <p> <code>IndexDocument</code> </p> </li> <li> <p> <code>Suffix</code> </p> </li> <li> <p> <code>ErrorDocument</code> </p> </li> <li> <p> <code>Key</code> </p> </li> <li> <p> <code>RoutingRules</code> </p> </li> <li> <p> <code>RoutingRule</code> </p> </li> <li> <p> <code>Condition</code> </p> </li> <li> <p> <code>HttpErrorCodeReturnedEquals</code> </p> </li> <li> <p> <code>KeyPrefixEquals</code> </p> </li> <li> <p> <code>Redirect</code> </p> </li> <li> <p> <code>Protocol</code> </p> </li> <li> <p> <code>HostName</code> </p> </li> <li> <p> <code>ReplaceKeyPrefixWith</code> </p> </li> <li> <p> <code>ReplaceKeyWith</code> </p> </li> <li> <p> <code>HttpRedirectCode</code> </p> </li> </ul>"
},
"PutObject": {
"name": "PutObject",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}/{Key+}"
},
"input": {
"shape": "PutObjectRequest"
},
"output": {
"shape": "PutObjectOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUT.html",
"documentation": "<p>Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.</p> <p>Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.</p> <p>Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.</p> <p>To ensure that data is not corrupted traversing the network, use the <code>Content-MD5</code> header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.</p> <note> <p>To configure your application to send the request headers before sending the request body, use the <code>100-continue</code> HTTP status code. For PUT operations, this helps you avoid sending the message body if the message is rejected based on the headers (for example, because authentication fails or a redirect occurs). For more information on the <code>100-continue</code> HTTP status code, see Section 8.2.3 of <a href=\"http://www.ietf.org/rfc/rfc2616.txt\">http://www.ietf.org/rfc/rfc2616.txt</a>.</p> </note> <p>You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use AWS managed encryption keys. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html\">Using Server-Side Encryption</a>.</p> <dl> <dt>Access Permissions</dt> <dd> <p>You can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:</p> <ul> <li> <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a>.</p> </li> </ul> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> </dd> <dt>Server-Side- Encryption-Specific Request Headers</dt> <dd> <p>You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key. </p> <ul> <li> <p>Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request.</p> <ul> <li> <p>x-amz-server-side-encryption</p> </li> <li> <p>x-amz-server-side-encryption-aws-kms-key-id</p> </li> <li> <p>x-amz-server-side-encryption-context</p> </li> </ul> <note> <p>If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but don't provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS CMK, you must provide the <code>x-amz-server-side-encryption-aws-kms-key-id</code> of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> </note> <important> <p>All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.</p> </important> <p>For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">Protecting Data Using Server-Side Encryption with CMKs stored in AWS</a>.</p> </li> <li> <p>Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p>For more information about server-side encryption with CMKs stored in KMS (SSE-KMS), see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">Protecting Data Using Server-Side Encryption with CMKs stored in AWS</a>.</p> </li> </ul> </dd> <dt>Access-Control-List (ACL)-Specific Request Headers</dt> <dd> <p>You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the Access Control List (ACL) on the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html\">Using ACLs</a>. With this operation, you can grant access permissions using one of the following two methods:</p> <ul> <li> <p>Specify a canned ACL (<code>x-amz-acl</code>) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a>. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly use:</p> <ul> <li> <p>x-amz-grant-read</p> </li> <li> <p>x-amz-grant-write</p> </li> <li> <p>x-amz-grant-read-acp</p> </li> <li> <p>x-amz-grant-write-acp</p> </li> <li> <p>x-amz-grant-full-control</p> </li> </ul> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an AWS account</p> <important> <p>Using email addresses to specify a grantee is only supported in the following AWS Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>EU (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region\">Regions and Endpoints</a> in the AWS General Reference</p> </important> </li> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an AWS account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> </ul> <p>For example, the following <code>x-amz-grant-read</code> header grants the AWS accounts identified by email addresses permissions to read object data and its metadata:</p> <p> <code>x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\" </code> </p> </li> </ul> </dd> <dt>Server-Side- Encryption-Specific Request Headers</dt> <dd> <p>You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS-managed encryption keys or provide your own encryption key. </p> <ul> <li> <p>Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request.</p> <ul> <li> <p>x-amz-server-side-encryption</p> </li> <li> <p>x-amz-server-side-encryption-aws-kms-key-id</p> </li> <li> <p>x-amz-server-side-encryption-context</p> </li> </ul> <note> <p>If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but don't provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS CMK, you must provide the <code>x-amz-server-side-encryption-aws-kms-key-id</code> of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> </note> <important> <p>All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.</p> </important> <p>For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS</a>.</p> </li> <li> <p>Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.</p> <note> <p>If you use this feature, the ETag value that Amazon S3 returns in the response is not the MD5 of the object.</p> </note> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p>For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS</a>.</p> </li> </ul> </dd> </dl> <p> <b>Storage Class Options</b> </p> <p>By default, Amazon S3 uses the Standard storage class to store newly created objects. The Standard storage class provides high durability and high availability. You can specify other storage classes depending on the performance needs. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html\">Storage Classes</a> in the Amazon Simple Storage Service Developer Guide.</p> <p> <b>Versioning</b> </p> <p>If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response using the <code>x-amz-version-id response</code> header. If versioning is suspended, Amazon S3 always uses null as the version ID for the object stored. For more information about returning the versioning state of a bucket, see <a>GetBucketVersioning</a>. If you enable versioning for a bucket, when Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a>CopyObject</a> </p> </li> <li> <p> <a>DeleteObject</a> </p> </li> </ul>"
},
"PutObjectAcl": {
"name": "PutObjectAcl",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}/{Key+}?acl"
},
"input": {
"shape": "PutObjectAclRequest"
},
"output": {
"shape": "PutObjectAclOutput"
},
"errors": [
{
"shape": "NoSuchKey"
}
],
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html",
"documentation": "<p>Uses the <code>acl</code> subresource to set the access control list (ACL) permissions for an object that already exists in a bucket. You must have <code>WRITE_ACP</code> permission to set the ACL of an object.</p> <p>Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach.</p> <p> <b>Access Permissions</b> </p> <p>You can set access permissions using one of the following methods:</p> <ul> <li> <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of <code>x-amz-ac</code>l. If you use this header, you cannot use other access control-specific headers in your request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. When using these headers, you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use <code>x-amz-acl</code> header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a>.</p> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an AWS account</p> </li> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an AWS account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> </ul> <p>For example, the following <code>x-amz-grant-read</code> header grants list objects permission to the two AWS accounts identified by their email addresses.</p> <p> <code>x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\" </code> </p> </li> </ul> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> <p> <b>Grantee Values</b> </p> <p>You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:</p> <ul> <li> <p>By Email address:</p> <p> <code><Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee></code> </p> <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.</p> </li> <li> <p>By the person's ID:</p> <p> <code><Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee></code> </p> <p>DisplayName is optional and ignored in the request.</p> </li> <li> <p>By URI:</p> <p> <code><Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code> </p> </li> </ul> <p> <b>Versioning</b> </p> <p>The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the <code>versionId</code> subresource.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a>CopyObject</a> </p> </li> <li> <p> <a>GetObject</a> </p> </li> </ul>"
},
"PutObjectLegalHold": {
"name": "PutObjectLegalHold",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}/{Key+}?legal-hold"
},
"input": {
"shape": "PutObjectLegalHoldRequest"
},
"output": {
"shape": "PutObjectLegalHoldOutput"
},
"documentation": "<p>Applies a Legal Hold configuration to the specified object.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a> </p> </li> </ul>"
},
"PutObjectLockConfiguration": {
"name": "PutObjectLockConfiguration",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?object-lock"
},
"input": {
"shape": "PutObjectLockConfigurationRequest"
},
"output": {
"shape": "PutObjectLockConfigurationOutput"
},
"documentation": "<p>Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.</p> <note> <p> <code>DefaultRetention</code> requires either Days or Years. You can't specify both at the same time.</p> </note> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a> </p> </li> </ul>"
},
"PutObjectRetention": {
"name": "PutObjectRetention",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}/{Key+}?retention"
},
"input": {
"shape": "PutObjectRetentionRequest"
},
"output": {
"shape": "PutObjectRetentionOutput"
},
"documentation": "<p>Places an Object Retention configuration on an object.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a> </p> </li> </ul>"
},
"PutObjectTagging": {
"name": "PutObjectTagging",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}/{Key+}?tagging"
},
"input": {
"shape": "PutObjectTaggingRequest"
},
"output": {
"shape": "PutObjectTaggingOutput"
},
"documentation": "<p>Sets the supplied tag-set to an object that already exists in a bucket</p> <p>A tag is a key-value pair. You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see <a>GetObjectTagging</a>.</p> <p>For tagging-related restrictions related to characters and encodings, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html\">Tag Restrictions</a>. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.</p> <p>To use this operation, you must have permission to perform the <code>s3:PutObjectTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others.</p> <p>To put tags of any other version, use the <code>versionId</code> query parameter. You also need permission for the <code>s3:PutObjectVersionTagging</code> action.</p> <p>For information about the Amazon S3 object tagging feature, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html\">Object Tagging</a>.</p> <p class=\"title\"> <b>Special Errors</b> </p> <ul> <li> <p class=\"title\"> <b/> </p> <ul> <li> <p> <i>Code: InvalidTagError </i> </p> </li> <li> <p> <i>Cause: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html\">Object Tagging</a>.</i> </p> </li> </ul> </li> <li> <p class=\"title\"> <b/> </p> <ul> <li> <p> <i>Code: MalformedXMLError </i> </p> </li> <li> <p> <i>Cause: The XML provided does not match the schema.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: OperationAbortedError </i> </p> </li> <li> <p> <i>Cause: A conflicting conditional operation is currently in progress against this resource. Please try again.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: InternalError</i> </p> </li> <li> <p> <i>Cause: The service was unable to apply the provided tag to the object.</i> </p> </li> </ul> </li> </ul> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a>GetObjectTagging</a> </p> </li> </ul>"
},
"PutPublicAccessBlock": {
"name": "PutPublicAccessBlock",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}?publicAccessBlock"
},
"input": {
"shape": "PutPublicAccessBlockRequest"
},
"documentation": "<p>Creates or modifies the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use this operation, you must have the <code>s3:PutBucketPublicAccessBlock</code> permission. For more information about Amazon S3 permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a>.</p> <important> <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or an object, it checks the <code>PublicAccessBlock</code> configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the <code>PublicAccessBlock</code> configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.</p> </important> <p>For more information about when Amazon S3 considers a bucket or an object public, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status\">The Meaning of \"Public\"</a>.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a>GetPublicAccessBlock</a> </p> </li> <li> <p> <a>DeletePublicAccessBlock</a> </p> </li> <li> <p> <a>GetBucketPolicyStatus</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html\">Using Amazon S3 Block Public Access</a> </p> </li> </ul>"
},
"RestoreObject": {
"name": "RestoreObject",
"http": {
"method": "POST",
"requestUri": "/{Bucket}/{Key+}?restore"
},
"input": {
"shape": "RestoreObjectRequest"
},
"output": {
"shape": "RestoreObjectOutput"
},
"errors": [
{
"shape": "ObjectAlreadyInActiveTierError"
}
],
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectRestore.html",
"documentation": "<p>Restores an archived copy of an object back into Amazon S3</p> <p>This operation performs the following types of requests: </p> <ul> <li> <p> <code>select</code> - Perform a select query on an archived object</p> </li> <li> <p> <code>restore an archive</code> - Restore an archived object</p> </li> </ul> <p>To use this operation, you must have permissions to perform the <code>s3:RestoreObject</code> and <code>s3:GetObject</code> actions. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p> <b>Querying Archives with Select Requests</b> </p> <p>You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html\">Querying Archived Objects</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>When making a select request, do the following:</p> <ul> <li> <p>Define an output location for the select query's output. This must be an Amazon S3 bucket in the same AWS Region as the bucket that contains the archive object that is being queried. The AWS account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html\">Querying Archived Objects</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>For more information about the <code>S3</code> structure in the request body, see the following:</p> <ul> <li> <p> <a>PutObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html\">Managing Access with ACLs</a> in the <i>Amazon Simple Storage Service Developer Guide</i> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html\">Protecting Data Using Server-Side Encryption</a> in the <i>Amazon Simple Storage Service Developer Guide</i> </p> </li> </ul> </li> <li> <p>Define the SQL expression for the <code>SELECT</code> type of restoration for your query in the request body's <code>SelectParameters</code> structure. You can use expressions like the following examples.</p> <ul> <li> <p>The following expression returns all records from the specified object.</p> <p> <code>SELECT * FROM Object</code> </p> </li> <li> <p>Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers.</p> <p> <code>SELECT s._1, s._2 FROM Object s WHERE s._3 > 100</code> </p> </li> <li> <p>If you have headers and you set the <code>fileHeaderInfo</code> in the <code>CSV</code> structure in the request body to <code>USE</code>, you can specify headers in the query. (If you set the <code>fileHeaderInfo</code> field to <code>IGNORE</code>, the first row is skipped for the query.) You cannot mix ordinal positions with header column names. </p> <p> <code>SELECT s.Id, s.FirstName, s.SSN FROM S3Object s</code> </p> </li> </ul> </li> </ul> <p>For more information about using SQL with Glacier Select restore, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html\">SQL Reference for Amazon S3 Select and Glacier Select</a> in the <i>Amazon Simple Storage Service Developer Guide</i>. </p> <p>When making a select request, you can also do the following:</p> <ul> <li> <p>To expedite your queries, specify the <code>Expedited</code> tier. For more information about tiers, see \"Restoring Archives,\" later in this topic.</p> </li> <li> <p>Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.</p> </li> </ul> <p>The following are additional important facts about the select feature:</p> <ul> <li> <p>The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy.</p> </li> <li> <p>You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests.</p> </li> <li> <p> Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response <code>409</code>.</p> </li> </ul> <p> <b>Restoring Archives</b> </p> <p>Objects in the GLACIER and DEEP_ARCHIVE storage classes are archived. To access an archived object, you must first initiate a restore request. This restores a temporary copy of the archived object. In a restore request, you specify the number of days that you want the restored copy to exist. After the specified period, Amazon S3 deletes the temporary copy but the object remains archived in the GLACIER or DEEP_ARCHIVE storage class that object was restored from. </p> <p>To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.</p> <p>The time it takes restore jobs to finish depends on which storage class the object is being restored from and which data access tier you specify. </p> <p>When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the <code>Tier</code> element of the request body: </p> <ul> <li> <p> <b> <code>Expedited</code> </b> - Expedited retrievals allow you to quickly access your data stored in the GLACIER storage class when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals are typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for the DEEP_ARCHIVE storage class.</p> </li> <li> <p> <b> <code>Standard</code> </b> - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for the GLACIER and DEEP_ARCHIVE retrieval requests that do not specify the retrieval option. Standard retrievals typically complete within 3-5 hours from the GLACIER storage class and typically complete within 12 hours from the DEEP_ARCHIVE storage class. </p> </li> <li> <p> <b> <code>Bulk</code> </b> - Bulk retrievals are Amazon S3 Glacier’s lowest-cost retrieval option, enabling you to retrieve large amounts, even petabytes, of data inexpensively in a day. Bulk retrievals typically complete within 5-12 hours from the GLACIER storage class and typically complete within 48 hours from the DEEP_ARCHIVE storage class.</p> </li> </ul> <p>For more information about archive retrieval options and provisioned capacity for <code>Expedited</code> data access, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html\">Restoring Archived Objects</a> in the <i>Amazon Simple Storage Service Developer Guide</i>. </p> <p>You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. You upgrade the speed of an in-progress restoration by issuing another restore request to the same object, setting a new <code>Tier</code> request element. When issuing a request to upgrade the restore tier, you must choose a tier that is faster than the tier that the in-progress restore is using. You must not change any other parameters, such as the <code>Days</code> request element. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html\"> Upgrading the Speed of an In-Progress Restore</a> in the <i>Amazon Simple Storage Service Developer Guide</i>. </p> <p>To get the status of object restoration, you can send a <code>HEAD</code> request. Operations return the <code>x-amz-restore</code> header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Configuring Amazon S3 Event Notifications</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.</p> <p>If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see <a>PutBucketLifecycleConfiguration</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html\">Object Lifecycle Management</a> in <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p> <b>Responses</b> </p> <p>A successful operation returns either the <code>200 OK</code> or <code>202 Accepted</code> status code. </p> <ul> <li> <p>If the object copy is not previously restored, then Amazon S3 returns <code>202 Accepted</code> in the response. </p> </li> <li> <p>If the object copy is previously restored, Amazon S3 returns <code>200 OK</code> in the response. </p> </li> </ul> <p class=\"title\"> <b>Special Errors</b> </p> <ul> <li> <p class=\"title\"> <b/> </p> <ul> <li> <p> <i>Code: RestoreAlreadyInProgress</i> </p> </li> <li> <p> <i>Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)</i> </p> </li> <li> <p> <i>HTTP Status Code: 409 Conflict</i> </p> </li> <li> <p> <i>SOAP Fault Code Prefix: Client</i> </p> </li> </ul> </li> <li> <p class=\"title\"> <b/> </p> <ul> <li> <p> <i>Code: GlacierExpeditedRetrievalNotAvailable</i> </p> </li> <li> <p> <i>Cause: Glacier expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to Standard or Bulk retrievals.)</i> </p> </li> <li> <p> <i>HTTP Status Code: 503</i> </p> </li> <li> <p> <i>SOAP Fault Code Prefix: N/A</i> </p> </li> </ul> </li> </ul> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a>PutBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a>GetBucketNotificationConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html\">SQL Reference for Amazon S3 Select and Glacier Select </a> in the <i>Amazon Simple Storage Service Developer Guide</i> </p> </li> </ul>",
"alias": "PostObjectRestore"
},
"SelectObjectContent": {
"name": "SelectObjectContent",
"http": {
"method": "POST",
"requestUri": "/{Bucket}/{Key+}?select&select-type=2"
},
"input": {
"shape": "SelectObjectContentRequest",
"locationName": "SelectObjectContentRequest",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
},
"output": {
"shape": "SelectObjectContentOutput"
},
"documentation": "<p>This operation filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.</p> <p>For more information about Amazon S3 Select, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html\">Selecting Content from Objects</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>For more information about using SQL with Amazon S3 Select, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html\"> SQL Reference for Amazon S3 Select and Glacier Select</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p/> <p> <b>Permissions</b> </p> <p>You must have <code>s3:GetObject</code> permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p/> <p> <i>Object Data Formats</i> </p> <p>You can use Amazon S3 Select to query objects that have the following format properties:</p> <ul> <li> <p> <i>CSV, JSON, and Parquet</i> - Objects must be in CSV, JSON, or Parquet format.</p> </li> <li> <p> <i>UTF-8</i> - UTF-8 is the only encoding type Amazon S3 Select supports.</p> </li> <li> <p> <i>GZIP or BZIP2</i> - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects.</p> </li> <li> <p> <i>Server-side encryption</i> - Amazon S3 Select supports querying objects that are protected with server-side encryption.</p> <p>For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the <a>GetObject</a>. For more information about SSE-C, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and customer master keys (CMKs) stored in AWS Key Management Service (SSE-KMS), server-side encryption is handled transparently, so you don't need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html\">Protecting Data Using Server-Side Encryption</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> </li> </ul> <p> <b>Working with the Response Body</b> </p> <p>Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a <code>Transfer-Encoding</code> header with <code>chunked</code> as its value in the response. For more information, see <a>RESTSelectObjectAppendix</a> .</p> <p/> <p> <b>GetObject Support</b> </p> <p>The <code>SelectObjectContent</code> operation does not support the following <code>GetObject</code> functionality. For more information, see <a>GetObject</a>.</p> <ul> <li> <p> <code>Range</code>: While you can specify a scan range for a Amazon S3 Select request, see <a>SelectObjectContentRequest$ScanRange</a> in the request parameters below, you cannot specify the range of bytes of an object to return. </p> </li> <li> <p>GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify the GLACIER, DEEP_ARCHIVE, or <code>REDUCED_REDUNDANCY</code> storage classes. For more information, about storage classes see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#storage-class-intro\">Storage Classes</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> </li> </ul> <p/> <p> <b>Special Errors</b> </p> <p>For a list of special errors for this operation and for general information about Amazon S3 errors and a list of error codes, see <a>ErrorResponses</a> </p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a>GetObject</a> </p> </li> <li> <p> <a>GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a>PutBucketLifecycleConfiguration</a> </p> </li> </ul>"
},
"UploadPart": {
"name": "UploadPart",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}/{Key+}"
},
"input": {
"shape": "UploadPartRequest"
},
"output": {
"shape": "UploadPartOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPart.html",
"documentation": "<p>Uploads a part in a multipart upload.</p> <note> <p>In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the <a>UploadPartCopy</a> operation. </p> </note> <p>You must initiate a multipart upload (see <a>CreateMultipartUpload</a>) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request.</p> <p>Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten. Each part must be at least 5 MB in size, except the last part. There is no size limit on the last part of your multipart upload.</p> <p>To ensure that data is not corrupted when traversing the network, specify the <code>Content-MD5</code> header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. </p> <p> <b>Note:</b> After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.</p> <p>For more information on multipart uploads, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html\">Multipart Upload Overview</a> in the <i>Amazon Simple Storage Service Developer Guide </i>.</p> <p>For information on the permissions required to use the multipart upload API, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload API and Permissions</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the AWS managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using <a>CreateMultipartUpload</a>. For more information, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html\">Using Server-Side Encryption</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see <a>CreateMultipartUpload</a>.</p> <p>If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers.</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p class=\"title\"> <b>Special Errors</b> </p> <ul> <li> <p class=\"title\"> <b/> </p> <ul> <li> <p> <i>Code: NoSuchUpload</i> </p> </li> <li> <p> <i>Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</i> </p> </li> <li> <p> <i> HTTP Status Code: 404 Not Found </i> </p> </li> <li> <p> <i>SOAP Fault Code Prefix: Client</i> </p> </li> </ul> </li> </ul> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a>CreateMultipartUpload</a> </p> </li> <li> <p> <a>CompleteMultipartUpload</a> </p> </li> <li> <p> <a>AbortMultipartUpload</a> </p> </li> <li> <p> <a>ListParts</a> </p> </li> <li> <p> <a>ListMultipartUploads</a> </p> </li> </ul>"
},
"UploadPartCopy": {
"name": "UploadPartCopy",
"http": {
"method": "PUT",
"requestUri": "/{Bucket}/{Key+}"
},
"input": {
"shape": "UploadPartCopyRequest"
},
"output": {
"shape": "UploadPartCopyOutput"
},
"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPartCopy.html",
"documentation": "<p>Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header <code>x-amz-copy-source</code> in your request and a byte range by adding the request header <code>x-amz-copy-source-range</code> in your request. </p> <p>The minimum allowable part size for a multipart upload is 5 MB. For more information about multipart upload limits, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/qfacts.html\">Quick Facts</a> in the <i>Amazon Simple Storage Service Developer Guide</i>. </p> <note> <p>Instead of using an existing object as part data, you might use the <a>UploadPart</a> operation and provide data in your request.</p> </note> <p>You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request.</p> <p>For more information about using the <code>UploadPartCopy</code> operation, see the following:</p> <ul> <li> <p>For conceptual information about multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html\">Uploading Objects Using Multipart Upload</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> </li> <li> <p>For information about permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload API and Permissions</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> </li> <li> <p>For information about copying objects using a single atomic operation vs. the multipart upload, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html\">Operations on Objects</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> </li> <li> <p>For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see <a>CopyObject</a> and <a>UploadPart</a>.</p> </li> </ul> <p>Note the following additional considerations about the request headers <code>x-amz-copy-source-if-match</code>, <code>x-amz-copy-source-if-none-match</code>, <code>x-amz-copy-source-if-unmodified-since</code>, and <code>x-amz-copy-source-if-modified-since</code>:</p> <p> </p> <ul> <li> <p> <b>Consideration 1</b> - If both of the <code>x-amz-copy-source-if-match</code> and <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request as follows:</p> <p> <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>, and;</p> <p> <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to <code>false</code>;</p> <p>Amazon S3 returns <code>200 OK</code> and copies the data. </p> </li> <li> <p> <b>Consideration 2</b> - If both of the <code>x-amz-copy-source-if-none-match</code> and <code>x-amz-copy-source-if-modified-since</code> headers are present in the request as follows:</p> <p> <code>x-amz-copy-source-if-none-match</code> condition evaluates to <code>false</code>, and;</p> <p> <code>x-amz-copy-source-if-modified-since</code> condition evaluates to <code>true</code>;</p> <p>Amazon S3 returns <code>412 Precondition Failed</code> response code. </p> </li> </ul> <p> <b>Versioning</b> </p> <p>If your bucket has versioning enabled, you could have multiple versions of the same object. By default, <code>x-amz-copy-source</code> identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in the <code>x-amz-copy-source</code>, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the <code>x-amz-copy-source</code> and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the <code>x-amz-copy-source</code>. </p> <p>You can optionally specify a specific version of the source object to copy by adding the <code>versionId</code> subresource as shown in the following example:</p> <p> <code>x-amz-copy-source: /bucket/object?versionId=version id</code> </p> <p class=\"title\"> <b>Special Errors</b> </p> <ul> <li> <p class=\"title\"> <b/> </p> <ul> <li> <p> <i>Code: NoSuchUpload</i> </p> </li> <li> <p> <i>Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</i> </p> </li> <li> <p> <i>HTTP Status Code: 404 Not Found</i> </p> </li> </ul> </li> <li> <p class=\"title\"> <b/> </p> <ul> <li> <p> <i>Code: InvalidRequest</i> </p> </li> <li> <p> <i>Cause: The specified copy source is not supported as a byte-range copy source.</i> </p> </li> <li> <p> <i>HTTP Status Code: 400 Bad Request</i> </p> </li> </ul> </li> </ul> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a>CreateMultipartUpload</a> </p> </li> <li> <p> <a>UploadPart</a> </p> </li> <li> <p> <a>CompleteMultipartUpload</a> </p> </li> <li> <p> <a>AbortMultipartUpload</a> </p> </li> <li> <p> <a>ListParts</a> </p> </li> <li> <p> <a>ListMultipartUploads</a> </p> </li> </ul>"
}
},
"shapes": {
"AbortDate": {
"type": "timestamp"
},
"AbortIncompleteMultipartUpload": {
"type": "structure",
"members": {
"DaysAfterInitiation": {
"shape": "DaysAfterInitiation",
"documentation": "<p>Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.</p>"
}
},
"documentation": "<p>Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config\"> Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
},
"AbortMultipartUploadOutput": {
"type": "structure",
"members": {
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
}
}
},
"AbortMultipartUploadRequest": {
"type": "structure",
"required": [
"Bucket",
"Key",
"UploadId"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name to which the upload was taking place. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Key of the object for which the multipart upload was initiated.</p>",
"location": "uri",
"locationName": "Key"
},
"UploadId": {
"shape": "MultipartUploadId",
"documentation": "<p>Upload ID that identifies the multipart upload.</p>",
"location": "querystring",
"locationName": "uploadId"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
}
}
},
"AbortRuleId": {
"type": "string"
},
"AccelerateConfiguration": {
"type": "structure",
"members": {
"Status": {
"shape": "BucketAccelerateStatus",
"documentation": "<p>Specifies the transfer acceleration status of the bucket.</p>"
}
},
"documentation": "<p>Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html\">Amazon S3 Transfer Acceleration</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
},
"AcceptRanges": {
"type": "string"
},
"AccessControlPolicy": {
"type": "structure",
"members": {
"Grants": {
"shape": "Grants",
"documentation": "<p>A list of grants.</p>",
"locationName": "AccessControlList"
},
"Owner": {
"shape": "Owner",
"documentation": "<p>Container for the bucket owner's display name and ID.</p>"
}
},
"documentation": "<p>Contains the elements that set the ACL permissions for an object per grantee.</p>"
},
"AccessControlTranslation": {
"type": "structure",
"required": [
"Owner"
],
"members": {
"Owner": {
"shape": "OwnerOverride",
"documentation": "<p>Specifies the replica ownership. For default and valid values, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html\">PUT bucket replication</a> in the <i>Amazon Simple Storage Service API Reference</i>.</p>"
}
},
"documentation": "<p>A container for information about access control for replicas.</p>"
},
"AccountId": {
"type": "string"
},
"AllowQuotedRecordDelimiter": {
"type": "boolean"
},
"AllowedHeader": {
"type": "string"
},
"AllowedHeaders": {
"type": "list",
"member": {
"shape": "AllowedHeader"
},
"flattened": true
},
"AllowedMethod": {
"type": "string"
},
"AllowedMethods": {
"type": "list",
"member": {
"shape": "AllowedMethod"
},
"flattened": true
},
"AllowedOrigin": {
"type": "string"
},
"AllowedOrigins": {
"type": "list",
"member": {
"shape": "AllowedOrigin"
},
"flattened": true
},
"AnalyticsAndOperator": {
"type": "structure",
"members": {
"Prefix": {
"shape": "Prefix",
"documentation": "<p>The prefix to use when evaluating an AND predicate: The prefix that an object must have to be included in the metrics results.</p>"
},
"Tags": {
"shape": "TagSet",
"documentation": "<p>The list of tags to use when evaluating an AND predicate.</p>",
"flattened": true,
"locationName": "Tag"
}
},
"documentation": "<p>A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates in any combination, and an object must match all of the predicates for the filter to apply.</p>"
},
"AnalyticsConfiguration": {
"type": "structure",
"required": [
"Id",
"StorageClassAnalysis"
],
"members": {
"Id": {
"shape": "AnalyticsId",
"documentation": "<p>The ID that identifies the analytics configuration.</p>"
},
"Filter": {
"shape": "AnalyticsFilter",
"documentation": "<p>The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.</p>"
},
"StorageClassAnalysis": {
"shape": "StorageClassAnalysis",
"documentation": "<p> Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes. </p>"
}
},
"documentation": "<p> Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.</p>"
},
"AnalyticsConfigurationList": {
"type": "list",
"member": {
"shape": "AnalyticsConfiguration"
},
"flattened": true
},
"AnalyticsExportDestination": {
"type": "structure",
"required": [
"S3BucketDestination"
],
"members": {
"S3BucketDestination": {
"shape": "AnalyticsS3BucketDestination",
"documentation": "<p>A destination signifying output to an S3 bucket.</p>"
}
},
"documentation": "<p>Where to publish the analytics results.</p>"
},
"AnalyticsFilter": {
"type": "structure",
"members": {
"Prefix": {
"shape": "Prefix",
"documentation": "<p>The prefix to use when evaluating an analytics filter.</p>"
},
"Tag": {
"shape": "Tag",
"documentation": "<p>The tag to use when evaluating an analytics filter.</p>"
},
"And": {
"shape": "AnalyticsAndOperator",
"documentation": "<p>A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.</p>"
}
},
"documentation": "<p>The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.</p>"
},
"AnalyticsId": {
"type": "string"
},
"AnalyticsS3BucketDestination": {
"type": "structure",
"required": [
"Format",
"Bucket"
],
"members": {
"Format": {
"shape": "AnalyticsS3ExportFileFormat",
"documentation": "<p>Specifies the file format used when exporting data to Amazon S3.</p>"
},
"BucketAccountId": {
"shape": "AccountId",
"documentation": "<p>The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data.</p>"
},
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The Amazon Resource Name (ARN) of the bucket to which data is exported.</p>"
},
"Prefix": {
"shape": "Prefix",
"documentation": "<p>The prefix to use when exporting data. The prefix is prepended to all results.</p>"
}
},
"documentation": "<p>Contains information about where to publish the analytics results.</p>"
},
"AnalyticsS3ExportFileFormat": {
"type": "string",
"enum": [
"CSV"
]
},
"Body": {
"type": "blob"
},
"Bucket": {
"type": "structure",
"members": {
"Name": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket.</p>"
},
"CreationDate": {
"shape": "CreationDate",
"documentation": "<p>Date the bucket was created.</p>"
}
},
"documentation": "<p> In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally unique, and the namespace is shared by all AWS accounts. </p>"
},
"BucketAccelerateStatus": {
"type": "string",
"enum": [
"Enabled",
"Suspended"
]
},
"BucketCannedACL": {
"type": "string",
"enum": [
"private",
"public-read",
"public-read-write",
"authenticated-read"
]
},
"BucketLifecycleConfiguration": {
"type": "structure",
"required": [
"Rules"
],
"members": {
"Rules": {
"shape": "LifecycleRules",
"documentation": "<p>A lifecycle rule for individual objects in an Amazon S3 bucket.</p>",
"locationName": "Rule"
}
},
"documentation": "<p>Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html\">Object Lifecycle Management</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
},
"BucketLocationConstraint": {
"type": "string",
"enum": [
"EU",
"eu-west-1",
"us-west-1",
"us-west-2",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
"ap-northeast-1",
"sa-east-1",
"cn-north-1",
"eu-central-1"
]
},
"BucketLoggingStatus": {
"type": "structure",
"members": {
"LoggingEnabled": {
"shape": "LoggingEnabled"
}
},
"documentation": "<p>Container for logging status information.</p>"
},
"BucketLogsPermission": {
"type": "string",
"enum": [
"FULL_CONTROL",
"READ",
"WRITE"
]
},
"BucketName": {
"type": "string"
},
"BucketVersioningStatus": {
"type": "string",
"enum": [
"Enabled",
"Suspended"
]
},
"Buckets": {
"type": "list",
"member": {
"shape": "Bucket",
"locationName": "Bucket"
}
},
"BypassGovernanceRetention": {
"type": "boolean"
},
"BytesProcessed": {
"type": "long"
},
"BytesReturned": {
"type": "long"
},
"BytesScanned": {
"type": "long"
},
"CORSConfiguration": {
"type": "structure",
"required": [
"CORSRules"
],
"members": {
"CORSRules": {
"shape": "CORSRules",
"documentation": "<p>A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.</p>",
"locationName": "CORSRule"
}
},
"documentation": "<p>Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html\">Enabling Cross-Origin Resource Sharing</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
},
"CORSRule": {
"type": "structure",
"required": [
"AllowedMethods",
"AllowedOrigins"
],
"members": {
"AllowedHeaders": {
"shape": "AllowedHeaders",
"documentation": "<p>Headers that are specified in the <code>Access-Control-Request-Headers</code> header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.</p>",
"locationName": "AllowedHeader"
},
"AllowedMethods": {
"shape": "AllowedMethods",
"documentation": "<p>An HTTP method that you allow the origin to execute. Valid values are <code>GET</code>, <code>PUT</code>, <code>HEAD</code>, <code>POST</code>, and <code>DELETE</code>.</p>",
"locationName": "AllowedMethod"
},
"AllowedOrigins": {
"shape": "AllowedOrigins",
"documentation": "<p>One or more origins you want customers to be able to access the bucket from.</p>",
"locationName": "AllowedOrigin"
},
"ExposeHeaders": {
"shape": "ExposeHeaders",
"documentation": "<p>One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript <code>XMLHttpRequest</code> object).</p>",
"locationName": "ExposeHeader"
},
"MaxAgeSeconds": {
"shape": "MaxAgeSeconds",
"documentation": "<p>The time in seconds that your browser is to cache the preflight response for the specified resource.</p>"
}
},
"documentation": "<p>Specifies a cross-origin access rule for an Amazon S3 bucket.</p>"
},
"CORSRules": {
"type": "list",
"member": {
"shape": "CORSRule"
},
"flattened": true
},
"CSVInput": {
"type": "structure",
"members": {
"FileHeaderInfo": {
"shape": "FileHeaderInfo",
"documentation": "<p>Describes the first line of input. Valid values are:</p> <ul> <li> <p> <code>NONE</code>: First line is not a header.</p> </li> <li> <p> <code>IGNORE</code>: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column (<code>SELECT s._1 FROM OBJECT s</code>).</p> </li> <li> <p> <code>Use</code>: First line is a header, and you can use the header value to identify a column in an expression (<code>SELECT \"name\" FROM OBJECT</code>). </p> </li> </ul>"
},
"Comments": {
"shape": "Comments",
"documentation": "<p>A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line.</p>"
},
"QuoteEscapeCharacter": {
"shape": "QuoteEscapeCharacter",
"documentation": "<p>A single character used for escaping the quotation mark character inside an already escaped value. For example, the value \"\"\" a , b \"\"\" is parsed as \" a , b \".</p>"
},
"RecordDelimiter": {
"shape": "RecordDelimiter",
"documentation": "<p>A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.</p>"
},
"FieldDelimiter": {
"shape": "FieldDelimiter",
"documentation": "<p>A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.</p>"
},
"QuoteCharacter": {
"shape": "QuoteCharacter",
"documentation": "<p>A single character used for escaping when the field delimiter is part of the value. For example, if the value is <code>a, b</code>, Amazon S3 wraps this field value in quotation marks, as follows: <code>\" a , b \"</code>.</p> <p>Type: String</p> <p>Default: <code>\"</code> </p> <p>Ancestors: <code>CSV</code> </p>"
},
"AllowQuotedRecordDelimiter": {
"shape": "AllowQuotedRecordDelimiter",
"documentation": "<p>Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.</p>"
}
},
"documentation": "<p>Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.</p>"
},
"CSVOutput": {
"type": "structure",
"members": {
"QuoteFields": {
"shape": "QuoteFields",
"documentation": "<p>Indicates whether to use quotation marks around output fields. </p> <ul> <li> <p> <code>ALWAYS</code>: Always use quotation marks for output fields.</p> </li> <li> <p> <code>ASNEEDED</code>: Use quotation marks for output fields when needed.</p> </li> </ul>"
},
"QuoteEscapeCharacter": {
"shape": "QuoteEscapeCharacter",
"documentation": "<p>The single character used for escaping the quote character inside an already escaped value.</p>"
},
"RecordDelimiter": {
"shape": "RecordDelimiter",
"documentation": "<p>A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.</p>"
},
"FieldDelimiter": {
"shape": "FieldDelimiter",
"documentation": "<p>The value used to separate individual fields in a record. You can specify an arbitrary delimiter.</p>"
},
"QuoteCharacter": {
"shape": "QuoteCharacter",
"documentation": "<p>A single character used for escaping when the field delimiter is part of the value. For example, if the value is <code>a, b</code>, Amazon S3 wraps this field value in quotation marks, as follows: <code>\" a , b \"</code>.</p>"
}
},
"documentation": "<p>Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.</p>"
},
"CacheControl": {
"type": "string"
},
"CloudFunction": {
"type": "string"
},
"CloudFunctionConfiguration": {
"type": "structure",
"members": {
"Id": {
"shape": "NotificationId"
},
"Event": {
"shape": "Event",
"deprecated": true
},
"Events": {
"shape": "EventList",
"documentation": "<p>Bucket events for which to send notifications.</p>",
"locationName": "Event"
},
"CloudFunction": {
"shape": "CloudFunction",
"documentation": "<p>Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.</p>"
},
"InvocationRole": {
"shape": "CloudFunctionInvocationRole",
"documentation": "<p>The role supporting the invocation of the Lambda function</p>"
}
},
"documentation": "<p>Container for specifying the AWS Lambda notification configuration.</p>"
},
"CloudFunctionInvocationRole": {
"type": "string"
},
"Code": {
"type": "string"
},
"Comments": {
"type": "string"
},
"CommonPrefix": {
"type": "structure",
"members": {
"Prefix": {
"shape": "Prefix",
"documentation": "<p>Container for the specified common prefix.</p>"
}
},
"documentation": "<p>Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. </p>"
},
"CommonPrefixList": {
"type": "list",
"member": {
"shape": "CommonPrefix"
},
"flattened": true
},
"CompleteMultipartUploadOutput": {
"type": "structure",
"members": {
"Location": {
"shape": "Location",
"documentation": "<p>The URI that identifies the newly created object.</p>"
},
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket that contains the newly created object.</p>"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>The object key of the newly created object.</p>"
},
"Expiration": {
"shape": "Expiration",
"documentation": "<p>If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.</p>",
"location": "header",
"locationName": "x-amz-expiration"
},
"ETag": {
"shape": "ETag",
"documentation": "<p>Entity tag that identifies the newly created object's data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits.</p>"
},
"ServerSideEncryption": {
"shape": "ServerSideEncryption",
"documentation": "<p>If you specified server-side encryption either with an Amazon S3-managed encryption key or an AWS KMS customer master key (CMK) in your initiate multipart upload request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>Version ID of the newly created object, in case the bucket has versioning turned on.</p>",
"location": "header",
"locationName": "x-amz-version-id"
},
"SSEKMSKeyId": {
"shape": "SSEKMSKeyId",
"documentation": "<p>If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
},
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
}
}
},
"CompleteMultipartUploadRequest": {
"type": "structure",
"required": [
"Bucket",
"Key",
"UploadId"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Name of the bucket to which the multipart upload was initiated.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Object key for which the multipart upload was initiated.</p>",
"location": "uri",
"locationName": "Key"
},
"MultipartUpload": {
"shape": "CompletedMultipartUpload",
"documentation": "<p>The container for the multipart upload request information.</p>",
"locationName": "CompleteMultipartUpload",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
},
"UploadId": {
"shape": "MultipartUploadId",
"documentation": "<p>ID for the initiated multipart upload.</p>",
"location": "querystring",
"locationName": "uploadId"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
}
},
"payload": "MultipartUpload"
},
"CompletedMultipartUpload": {
"type": "structure",
"members": {
"Parts": {
"shape": "CompletedPartList",
"documentation": "<p>Array of CompletedPart data types.</p>",
"locationName": "Part"
}
},
"documentation": "<p>The container for the completed multipart upload details.</p>"
},
"CompletedPart": {
"type": "structure",
"members": {
"ETag": {
"shape": "ETag",
"documentation": "<p>Entity tag returned when the part was uploaded.</p>"
},
"PartNumber": {
"shape": "PartNumber",
"documentation": "<p>Part number that identifies the part. This is a positive integer between 1 and 10,000.</p>"
}
},
"documentation": "<p>Details of the parts that were uploaded.</p>"
},
"CompletedPartList": {
"type": "list",
"member": {
"shape": "CompletedPart"
},
"flattened": true
},
"CompressionType": {
"type": "string",
"enum": [
"NONE",
"GZIP",
"BZIP2"
]
},
"Condition": {
"type": "structure",
"members": {
"HttpErrorCodeReturnedEquals": {
"shape": "HttpErrorCodeReturnedEquals",
"documentation": "<p>The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element <code>Condition</code> is specified and sibling <code>KeyPrefixEquals</code> is not specified. If both are specified, then both must be true for the redirect to be applied.</p>"
},
"KeyPrefixEquals": {
"shape": "KeyPrefixEquals",
"documentation": "<p>The object key name prefix when the redirect is applied. For example, to redirect requests for <code>ExamplePage.html</code>, the key prefix will be <code>ExamplePage.html</code>. To redirect request for all pages with the prefix <code>docs/</code>, the key prefix will be <code>/docs</code>, which identifies all objects in the <code>docs/</code> folder. Required when the parent element <code>Condition</code> is specified and sibling <code>HttpErrorCodeReturnedEquals</code> is not specified. If both conditions are specified, both must be true for the redirect to be applied.</p>"
}
},
"documentation": "<p>A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the <code>/docs</code> folder, redirect to the <code>/documents</code> folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.</p>"
},
"ConfirmRemoveSelfBucketAccess": {
"type": "boolean"
},
"ContentDisposition": {
"type": "string"
},
"ContentEncoding": {
"type": "string"
},
"ContentLanguage": {
"type": "string"
},
"ContentLength": {
"type": "long"
},
"ContentMD5": {
"type": "string"
},
"ContentRange": {
"type": "string"
},
"ContentType": {
"type": "string"
},
"ContinuationEvent": {
"type": "structure",
"members": {},
"documentation": "<p/>",
"event": true
},
"CopyObjectOutput": {
"type": "structure",
"members": {
"CopyObjectResult": {
"shape": "CopyObjectResult",
"documentation": "<p>Container for all response elements.</p>"
},
"Expiration": {
"shape": "Expiration",
"documentation": "<p>If the object expiration is configured, the response includes this header.</p>",
"location": "header",
"locationName": "x-amz-expiration"
},
"CopySourceVersionId": {
"shape": "CopySourceVersionId",
"documentation": "<p>Version of the copied object in the destination bucket.</p>",
"location": "header",
"locationName": "x-amz-copy-source-version-id"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>Version ID of the newly created copy.</p>",
"location": "header",
"locationName": "x-amz-version-id"
},
"ServerSideEncryption": {
"shape": "ServerSideEncryption",
"documentation": "<p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"SSECustomerAlgorithm": {
"shape": "SSECustomerAlgorithm",
"documentation": "<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5": {
"shape": "SSECustomerKeyMD5",
"documentation": "<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId": {
"shape": "SSEKMSKeyId",
"documentation": "<p>If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
},
"SSEKMSEncryptionContext": {
"shape": "SSEKMSEncryptionContext",
"documentation": "<p>If present, specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-context"
},
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
}
},
"payload": "CopyObjectResult"
},
"CopyObjectRequest": {
"type": "structure",
"required": [
"Bucket",
"CopySource",
"Key"
],
"members": {
"ACL": {
"shape": "ObjectCannedACL",
"documentation": "<p>The canned ACL to apply to the object.</p>",
"location": "header",
"locationName": "x-amz-acl"
},
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the destination bucket.</p>",
"location": "uri",
"locationName": "Bucket"
},
"CacheControl": {
"shape": "CacheControl",
"documentation": "<p>Specifies caching behavior along the request/reply chain.</p>",
"location": "header",
"locationName": "Cache-Control"
},
"ContentDisposition": {
"shape": "ContentDisposition",
"documentation": "<p>Specifies presentational information for the object.</p>",
"location": "header",
"locationName": "Content-Disposition"
},
"ContentEncoding": {
"shape": "ContentEncoding",
"documentation": "<p>Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.</p>",
"location": "header",
"locationName": "Content-Encoding"
},
"ContentLanguage": {
"shape": "ContentLanguage",
"documentation": "<p>The language the content is in.</p>",
"location": "header",
"locationName": "Content-Language"
},
"ContentType": {
"shape": "ContentType",
"documentation": "<p>A standard MIME type describing the format of the object data.</p>",
"location": "header",
"locationName": "Content-Type"
},
"CopySource": {
"shape": "CopySource",
"documentation": "<p>The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.</p>",
"location": "header",
"locationName": "x-amz-copy-source"
},
"CopySourceIfMatch": {
"shape": "CopySourceIfMatch",
"documentation": "<p>Copies the object if its entity tag (ETag) matches the specified tag.</p>",
"location": "header",
"locationName": "x-amz-copy-source-if-match"
},
"CopySourceIfModifiedSince": {
"shape": "CopySourceIfModifiedSince",
"documentation": "<p>Copies the object if it has been modified since the specified time.</p>",
"location": "header",
"locationName": "x-amz-copy-source-if-modified-since"
},
"CopySourceIfNoneMatch": {
"shape": "CopySourceIfNoneMatch",
"documentation": "<p>Copies the object if its entity tag (ETag) is different than the specified ETag.</p>",
"location": "header",
"locationName": "x-amz-copy-source-if-none-match"
},
"CopySourceIfUnmodifiedSince": {
"shape": "CopySourceIfUnmodifiedSince",
"documentation": "<p>Copies the object if it hasn't been modified since the specified time.</p>",
"location": "header",
"locationName": "x-amz-copy-source-if-unmodified-since"
},
"Expires": {
"shape": "Expires",
"documentation": "<p>The date and time at which the object is no longer cacheable.</p>",
"location": "header",
"locationName": "Expires"
},
"GrantFullControl": {
"shape": "GrantFullControl",
"documentation": "<p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p>",
"location": "header",
"locationName": "x-amz-grant-full-control"
},
"GrantRead": {
"shape": "GrantRead",
"documentation": "<p>Allows grantee to read the object data and its metadata.</p>",
"location": "header",
"locationName": "x-amz-grant-read"
},
"GrantReadACP": {
"shape": "GrantReadACP",
"documentation": "<p>Allows grantee to read the object ACL.</p>",
"location": "header",
"locationName": "x-amz-grant-read-acp"
},
"GrantWriteACP": {
"shape": "GrantWriteACP",
"documentation": "<p>Allows grantee to write the ACL for the applicable object.</p>",
"location": "header",
"locationName": "x-amz-grant-write-acp"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>The key of the destination object.</p>",
"location": "uri",
"locationName": "Key"
},
"Metadata": {
"shape": "Metadata",
"documentation": "<p>A map of metadata to store with the object in S3.</p>",
"location": "headers",
"locationName": "x-amz-meta-"
},
"MetadataDirective": {
"shape": "MetadataDirective",
"documentation": "<p>Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.</p>",
"location": "header",
"locationName": "x-amz-metadata-directive"
},
"TaggingDirective": {
"shape": "TaggingDirective",
"documentation": "<p>Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.</p>",
"location": "header",
"locationName": "x-amz-tagging-directive"
},
"ServerSideEncryption": {
"shape": "ServerSideEncryption",
"documentation": "<p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"StorageClass": {
"shape": "StorageClass",
"documentation": "<p>The type of storage to use for the object. Defaults to 'STANDARD'.</p>",
"location": "header",
"locationName": "x-amz-storage-class"
},
"WebsiteRedirectLocation": {
"shape": "WebsiteRedirectLocation",
"documentation": "<p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.</p>",
"location": "header",
"locationName": "x-amz-website-redirect-location"
},
"SSECustomerAlgorithm": {
"shape": "SSECustomerAlgorithm",
"documentation": "<p>Specifies the algorithm to use to when encrypting the object (for example, AES256).</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey": {
"shape": "SSECustomerKey",
"documentation": "<p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5": {
"shape": "SSECustomerKeyMD5",
"documentation": "<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId": {
"shape": "SSEKMSKeyId",
"documentation": "<p>Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version\">Specifying the Signature Version in Request Authentication</a> in the <i>Amazon S3 Developer Guide</i>.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
},
"SSEKMSEncryptionContext": {
"shape": "SSEKMSEncryptionContext",
"documentation": "<p>Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-context"
},
"CopySourceSSECustomerAlgorithm": {
"shape": "CopySourceSSECustomerAlgorithm",
"documentation": "<p>Specifies the algorithm to use when decrypting the source object (for example, AES256).</p>",
"location": "header",
"locationName": "x-amz-copy-source-server-side-encryption-customer-algorithm"
},
"CopySourceSSECustomerKey": {
"shape": "CopySourceSSECustomerKey",
"documentation": "<p>Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.</p>",
"location": "header",
"locationName": "x-amz-copy-source-server-side-encryption-customer-key"
},
"CopySourceSSECustomerKeyMD5": {
"shape": "CopySourceSSECustomerKeyMD5",
"documentation": "<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.</p>",
"location": "header",
"locationName": "x-amz-copy-source-server-side-encryption-customer-key-MD5"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
},
"Tagging": {
"shape": "TaggingHeader",
"documentation": "<p>The tag-set for the object destination object this value must be used in conjunction with the <code>TaggingDirective</code>. The tag-set must be encoded as URL Query parameters.</p>",
"location": "header",
"locationName": "x-amz-tagging"
},
"ObjectLockMode": {
"shape": "ObjectLockMode",
"documentation": "<p>The Object Lock mode that you want to apply to the copied object.</p>",
"location": "header",
"locationName": "x-amz-object-lock-mode"
},
"ObjectLockRetainUntilDate": {
"shape": "ObjectLockRetainUntilDate",
"documentation": "<p>The date and time when you want the copied object's Object Lock to expire.</p>",
"location": "header",
"locationName": "x-amz-object-lock-retain-until-date"
},
"ObjectLockLegalHoldStatus": {
"shape": "ObjectLockLegalHoldStatus",
"documentation": "<p>Specifies whether you want to apply a Legal Hold to the copied object.</p>",
"location": "header",
"locationName": "x-amz-object-lock-legal-hold"
}
}
},
"CopyObjectResult": {
"type": "structure",
"members": {
"ETag": {
"shape": "ETag",
"documentation": "<p>Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata. The source and destination ETag is identical for a successfully copied object.</p>"
},
"LastModified": {
"shape": "LastModified",
"documentation": "<p>Returns the date that the object was last modified.</p>"
}
},
"documentation": "<p>Container for all response elements.</p>"
},
"CopyPartResult": {
"type": "structure",
"members": {
"ETag": {
"shape": "ETag",
"documentation": "<p>Entity tag of the object.</p>"
},
"LastModified": {
"shape": "LastModified",
"documentation": "<p>Date and time at which the object was uploaded.</p>"
}
},
"documentation": "<p>Container for all response elements.</p>"
},
"CopySource": {
"type": "string",
"pattern": "\\/.+\\/.+"
},
"CopySourceIfMatch": {
"type": "string"
},
"CopySourceIfModifiedSince": {
"type": "timestamp"
},
"CopySourceIfNoneMatch": {
"type": "string"
},
"CopySourceIfUnmodifiedSince": {
"type": "timestamp"
},
"CopySourceRange": {
"type": "string"
},
"CopySourceSSECustomerAlgorithm": {
"type": "string"
},
"CopySourceSSECustomerKey": {
"type": "blob",
"sensitive": true
},
"CopySourceSSECustomerKeyMD5": {
"type": "string"
},
"CopySourceVersionId": {
"type": "string"
},
"CreateBucketConfiguration": {
"type": "structure",
"members": {
"LocationConstraint": {
"shape": "BucketLocationConstraint",
"documentation": "<p>Specifies the Region where the bucket will be created. If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1).</p>"
}
},
"documentation": "<p>The configuration information for the bucket.</p>"
},
"CreateBucketOutput": {
"type": "structure",
"members": {
"Location": {
"shape": "Location",
"documentation": "<p>Specifies the Region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), you do not need to specify the location.</p>",
"location": "header",
"locationName": "Location"
}
}
},
"CreateBucketRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"ACL": {
"shape": "BucketCannedACL",
"documentation": "<p>The canned ACL to apply to the bucket.</p>",
"location": "header",
"locationName": "x-amz-acl"
},
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket to create.</p>",
"location": "uri",
"locationName": "Bucket"
},
"CreateBucketConfiguration": {
"shape": "CreateBucketConfiguration",
"documentation": "<p>The configuration information for the bucket.</p>",
"locationName": "CreateBucketConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
},
"GrantFullControl": {
"shape": "GrantFullControl",
"documentation": "<p>Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.</p>",
"location": "header",
"locationName": "x-amz-grant-full-control"
},
"GrantRead": {
"shape": "GrantRead",
"documentation": "<p>Allows grantee to list the objects in the bucket.</p>",
"location": "header",
"locationName": "x-amz-grant-read"
},
"GrantReadACP": {
"shape": "GrantReadACP",
"documentation": "<p>Allows grantee to read the bucket ACL.</p>",
"location": "header",
"locationName": "x-amz-grant-read-acp"
},
"GrantWrite": {
"shape": "GrantWrite",
"documentation": "<p>Allows grantee to create, overwrite, and delete any object in the bucket.</p>",
"location": "header",
"locationName": "x-amz-grant-write"
},
"GrantWriteACP": {
"shape": "GrantWriteACP",
"documentation": "<p>Allows grantee to write the ACL for the applicable bucket.</p>",
"location": "header",
"locationName": "x-amz-grant-write-acp"
},
"ObjectLockEnabledForBucket": {
"shape": "ObjectLockEnabledForBucket",
"documentation": "<p>Specifies whether you want S3 Object Lock to be enabled for the new bucket.</p>",
"location": "header",
"locationName": "x-amz-bucket-object-lock-enabled"
}
},
"payload": "CreateBucketConfiguration"
},
"CreateMultipartUploadOutput": {
"type": "structure",
"members": {
"AbortDate": {
"shape": "AbortDate",
"documentation": "<p>If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config\"> Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy</a>.</p> <p>The response also includes the <code>x-amz-abort-rule-id</code> header that provides the ID of the lifecycle configuration rule that defines this action.</p>",
"location": "header",
"locationName": "x-amz-abort-date"
},
"AbortRuleId": {
"shape": "AbortRuleId",
"documentation": "<p>This header is returned along with the <code>x-amz-abort-date</code> header. It identifies the applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.</p>",
"location": "header",
"locationName": "x-amz-abort-rule-id"
},
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Name of the bucket to which the multipart upload was initiated. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"locationName": "Bucket"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Object key for which the multipart upload was initiated.</p>"
},
"UploadId": {
"shape": "MultipartUploadId",
"documentation": "<p>ID for the initiated multipart upload.</p>"
},
"ServerSideEncryption": {
"shape": "ServerSideEncryption",
"documentation": "<p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"SSECustomerAlgorithm": {
"shape": "SSECustomerAlgorithm",
"documentation": "<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5": {
"shape": "SSECustomerKeyMD5",
"documentation": "<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId": {
"shape": "SSEKMSKeyId",
"documentation": "<p>If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
},
"SSEKMSEncryptionContext": {
"shape": "SSEKMSEncryptionContext",
"documentation": "<p>If present, specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-context"
},
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
}
}
},
"CreateMultipartUploadRequest": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"ACL": {
"shape": "ObjectCannedACL",
"documentation": "<p>The canned ACL to apply to the object.</p>",
"location": "header",
"locationName": "x-amz-acl"
},
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket to which to initiate the upload</p>",
"location": "uri",
"locationName": "Bucket"
},
"CacheControl": {
"shape": "CacheControl",
"documentation": "<p>Specifies caching behavior along the request/reply chain.</p>",
"location": "header",
"locationName": "Cache-Control"
},
"ContentDisposition": {
"shape": "ContentDisposition",
"documentation": "<p>Specifies presentational information for the object.</p>",
"location": "header",
"locationName": "Content-Disposition"
},
"ContentEncoding": {
"shape": "ContentEncoding",
"documentation": "<p>Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.</p>",
"location": "header",
"locationName": "Content-Encoding"
},
"ContentLanguage": {
"shape": "ContentLanguage",
"documentation": "<p>The language the content is in.</p>",
"location": "header",
"locationName": "Content-Language"
},
"ContentType": {
"shape": "ContentType",
"documentation": "<p>A standard MIME type describing the format of the object data.</p>",
"location": "header",
"locationName": "Content-Type"
},
"Expires": {
"shape": "Expires",
"documentation": "<p>The date and time at which the object is no longer cacheable.</p>",
"location": "header",
"locationName": "Expires"
},
"GrantFullControl": {
"shape": "GrantFullControl",
"documentation": "<p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p>",
"location": "header",
"locationName": "x-amz-grant-full-control"
},
"GrantRead": {
"shape": "GrantRead",
"documentation": "<p>Allows grantee to read the object data and its metadata.</p>",
"location": "header",
"locationName": "x-amz-grant-read"
},
"GrantReadACP": {
"shape": "GrantReadACP",
"documentation": "<p>Allows grantee to read the object ACL.</p>",
"location": "header",
"locationName": "x-amz-grant-read-acp"
},
"GrantWriteACP": {
"shape": "GrantWriteACP",
"documentation": "<p>Allows grantee to write the ACL for the applicable object.</p>",
"location": "header",
"locationName": "x-amz-grant-write-acp"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Object key for which the multipart upload is to be initiated.</p>",
"location": "uri",
"locationName": "Key"
},
"Metadata": {
"shape": "Metadata",
"documentation": "<p>A map of metadata to store with the object in S3.</p>",
"location": "headers",
"locationName": "x-amz-meta-"
},
"ServerSideEncryption": {
"shape": "ServerSideEncryption",
"documentation": "<p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"StorageClass": {
"shape": "StorageClass",
"documentation": "<p>The type of storage to use for the object. Defaults to 'STANDARD'.</p>",
"location": "header",
"locationName": "x-amz-storage-class"
},
"WebsiteRedirectLocation": {
"shape": "WebsiteRedirectLocation",
"documentation": "<p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.</p>",
"location": "header",
"locationName": "x-amz-website-redirect-location"
},
"SSECustomerAlgorithm": {
"shape": "SSECustomerAlgorithm",
"documentation": "<p>Specifies the algorithm to use to when encrypting the object (for example, AES256).</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey": {
"shape": "SSECustomerKey",
"documentation": "<p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5": {
"shape": "SSECustomerKeyMD5",
"documentation": "<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId": {
"shape": "SSEKMSKeyId",
"documentation": "<p>Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see <a href=\"https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version\">Specifying the Signature Version in Request Authentication</a> in the <i>Amazon S3 Developer Guide</i>.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
},
"SSEKMSEncryptionContext": {
"shape": "SSEKMSEncryptionContext",
"documentation": "<p>Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-context"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
},
"Tagging": {
"shape": "TaggingHeader",
"documentation": "<p>The tag-set for the object. The tag-set must be encoded as URL Query parameters.</p>",
"location": "header",
"locationName": "x-amz-tagging"
},
"ObjectLockMode": {
"shape": "ObjectLockMode",
"documentation": "<p>Specifies the Object Lock mode that you want to apply to the uploaded object.</p>",
"location": "header",
"locationName": "x-amz-object-lock-mode"
},
"ObjectLockRetainUntilDate": {
"shape": "ObjectLockRetainUntilDate",
"documentation": "<p>Specifies the date and time when you want the Object Lock to expire.</p>",
"location": "header",
"locationName": "x-amz-object-lock-retain-until-date"
},
"ObjectLockLegalHoldStatus": {
"shape": "ObjectLockLegalHoldStatus",
"documentation": "<p>Specifies whether you want to apply a Legal Hold to the uploaded object.</p>",
"location": "header",
"locationName": "x-amz-object-lock-legal-hold"
}
}
},
"CreationDate": {
"type": "timestamp"
},
"Date": {
"type": "timestamp",
"timestampFormat": "iso8601"
},
"Days": {
"type": "integer"
},
"DaysAfterInitiation": {
"type": "integer"
},
"DefaultRetention": {
"type": "structure",
"members": {
"Mode": {
"shape": "ObjectLockRetentionMode",
"documentation": "<p>The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.</p>"
},
"Days": {
"shape": "Days",
"documentation": "<p>The number of days that you want to specify for the default retention period.</p>"
},
"Years": {
"shape": "Years",
"documentation": "<p>The number of years that you want to specify for the default retention period.</p>"
}
},
"documentation": "<p>The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket.</p>"
},
"Delete": {
"type": "structure",
"required": [
"Objects"
],
"members": {
"Objects": {
"shape": "ObjectIdentifierList",
"documentation": "<p>The objects to delete.</p>",
"locationName": "Object"
},
"Quiet": {
"shape": "Quiet",
"documentation": "<p>Element to enable quiet mode for the request. When you add this element, you must set its value to true.</p>"
}
},
"documentation": "<p>Container for the objects to delete.</p>"
},
"DeleteBucketAnalyticsConfigurationRequest": {
"type": "structure",
"required": [
"Bucket",
"Id"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket from which an analytics configuration is deleted.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Id": {
"shape": "AnalyticsId",
"documentation": "<p>The ID that identifies the analytics configuration.</p>",
"location": "querystring",
"locationName": "id"
}
}
},
"DeleteBucketCorsRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Specifies the bucket whose <code>cors</code> configuration is being deleted.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"DeleteBucketEncryptionRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket containing the server-side encryption configuration to delete.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"DeleteBucketInventoryConfigurationRequest": {
"type": "structure",
"required": [
"Bucket",
"Id"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket containing the inventory configuration to delete.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Id": {
"shape": "InventoryId",
"documentation": "<p>The ID used to identify the inventory configuration.</p>",
"location": "querystring",
"locationName": "id"
}
}
},
"DeleteBucketLifecycleRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name of the lifecycle to delete.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"DeleteBucketMetricsConfigurationRequest": {
"type": "structure",
"required": [
"Bucket",
"Id"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket containing the metrics configuration to delete.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Id": {
"shape": "MetricsId",
"documentation": "<p>The ID used to identify the metrics configuration.</p>",
"location": "querystring",
"locationName": "id"
}
}
},
"DeleteBucketPolicyRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"DeleteBucketReplicationRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p> The bucket name. </p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"DeleteBucketRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Specifies the bucket being deleted.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"DeleteBucketTaggingRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket that has the tag set to be removed.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"DeleteBucketWebsiteRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name for which you want to remove the website configuration. </p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"DeleteMarker": {
"type": "boolean"
},
"DeleteMarkerEntry": {
"type": "structure",
"members": {
"Owner": {
"shape": "Owner",
"documentation": "<p>The account that created the delete marker.></p>"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>The object key.</p>"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>Version ID of an object.</p>"
},
"IsLatest": {
"shape": "IsLatest",
"documentation": "<p>Specifies whether the object is (true) or is not (false) the latest version of an object.</p>"
},
"LastModified": {
"shape": "LastModified",
"documentation": "<p>Date and time the object was last modified.</p>"
}
},
"documentation": "<p>Information about the delete marker.</p>"
},
"DeleteMarkerReplication": {
"type": "structure",
"members": {
"Status": {
"shape": "DeleteMarkerReplicationStatus",
"documentation": "<p>Indicates whether to replicate delete markers.</p> <note> <p> In the current implementation, Amazon S3 doesn't replicate the delete markers. The status must be <code>Disabled</code>. </p> </note>"
}
},
"documentation": "<p>Specifies whether Amazon S3 replicates the delete markers. If you specify a <code>Filter</code>, you must specify this element. However, in the latest version of replication configuration (when <code>Filter</code> is specified), Amazon S3 doesn't replicate delete markers. Therefore, the <code>DeleteMarkerReplication</code> element can contain only <Status>Disabled</Status>. For an example configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config\">Basic Rule Configuration</a>. </p> <note> <p> If you don't specify the <code>Filter</code> element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, Amazon S3 handled replication of delete markers differently. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations\">Backward Compatibility</a>.</p> </note>"
},
"DeleteMarkerReplicationStatus": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
]
},
"DeleteMarkerVersionId": {
"type": "string"
},
"DeleteMarkers": {
"type": "list",
"member": {
"shape": "DeleteMarkerEntry"
},
"flattened": true
},
"DeleteObjectOutput": {
"type": "structure",
"members": {
"DeleteMarker": {
"shape": "DeleteMarker",
"documentation": "<p>Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.</p>",
"location": "header",
"locationName": "x-amz-delete-marker"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>Returns the version ID of the delete marker created as a result of the DELETE operation.</p>",
"location": "header",
"locationName": "x-amz-version-id"
},
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
}
}
},
"DeleteObjectRequest": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name of the bucket containing the object. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Key name of the object to delete.</p>",
"location": "uri",
"locationName": "Key"
},
"MFA": {
"shape": "MFA",
"documentation": "<p>The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.</p>",
"location": "header",
"locationName": "x-amz-mfa"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>VersionId used to reference a specific version of the object.</p>",
"location": "querystring",
"locationName": "versionId"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
},
"BypassGovernanceRetention": {
"shape": "BypassGovernanceRetention",
"documentation": "<p>Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.</p>",
"location": "header",
"locationName": "x-amz-bypass-governance-retention"
}
}
},
"DeleteObjectTaggingOutput": {
"type": "structure",
"members": {
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>The versionId of the object the tag-set was removed from.</p>",
"location": "header",
"locationName": "x-amz-version-id"
}
}
},
"DeleteObjectTaggingRequest": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name containing the objects from which to remove the tags. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Name of the tag.</p>",
"location": "uri",
"locationName": "Key"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>The versionId of the object that the tag-set will be removed from.</p>",
"location": "querystring",
"locationName": "versionId"
}
}
},
"DeleteObjectsOutput": {
"type": "structure",
"members": {
"Deleted": {
"shape": "DeletedObjects",
"documentation": "<p>Container element for a successful delete. It identifies the object that was successfully deleted.</p>"
},
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
},
"Errors": {
"shape": "Errors",
"documentation": "<p>Container for a failed delete operation that describes the object that Amazon S3 attempted to delete and the error it encountered.</p>",
"locationName": "Error"
}
}
},
"DeleteObjectsRequest": {
"type": "structure",
"required": [
"Bucket",
"Delete"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name containing the objects to delete. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Delete": {
"shape": "Delete",
"documentation": "<p>Container for the request.</p>",
"locationName": "Delete",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
},
"MFA": {
"shape": "MFA",
"documentation": "<p>The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.</p>",
"location": "header",
"locationName": "x-amz-mfa"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
},
"BypassGovernanceRetention": {
"shape": "BypassGovernanceRetention",
"documentation": "<p>Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. You must have sufficient permissions to perform this operation.</p>",
"location": "header",
"locationName": "x-amz-bypass-governance-retention"
}
},
"payload": "Delete"
},
"DeletePublicAccessBlockRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The Amazon S3 bucket whose <code>PublicAccessBlock</code> configuration you want to delete. </p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"DeletedObject": {
"type": "structure",
"members": {
"Key": {
"shape": "ObjectKey",
"documentation": "<p>The name of the deleted object.</p>"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>The version ID of the deleted object.</p>"
},
"DeleteMarker": {
"shape": "DeleteMarker",
"documentation": "<p>Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete marker was created.</p>"
},
"DeleteMarkerVersionId": {
"shape": "DeleteMarkerVersionId",
"documentation": "<p>The version ID of the delete marker created as a result of the DELETE operation. If you delete a specific object version, the value returned by this header is the version ID of the object version deleted.</p>"
}
},
"documentation": "<p>Information about the deleted object.</p>"
},
"DeletedObjects": {
"type": "list",
"member": {
"shape": "DeletedObject"
},
"flattened": true
},
"Delimiter": {
"type": "string"
},
"Description": {
"type": "string"
},
"Destination": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p> The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.</p>"
},
"Account": {
"shape": "AccountId",
"documentation": "<p>Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS account that owns the destination bucket by specifying the <code>AccessControlTranslation</code> property, this is the account ID of the destination bucket owner. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-change-owner.html\">Replication Additional Configuration: Changing the Replica Owner</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
},
"StorageClass": {
"shape": "StorageClass",
"documentation": "<p> The storage class to use when replicating objects, such as standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica. </p> <p>For valid values, see the <code>StorageClass</code> element of the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html\">PUT Bucket replication</a> action in the <i>Amazon Simple Storage Service API Reference</i>.</p>"
},
"AccessControlTranslation": {
"shape": "AccessControlTranslation",
"documentation": "<p>Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object.</p>"
},
"EncryptionConfiguration": {
"shape": "EncryptionConfiguration",
"documentation": "<p>A container that provides information about encryption. If <code>SourceSelectionCriteria</code> is specified, you must specify this element.</p>"
},
"ReplicationTime": {
"shape": "ReplicationTime",
"documentation": "<p> A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a <code>Metrics</code> block. </p>"
},
"Metrics": {
"shape": "Metrics",
"documentation": "<p> A container specifying replication metrics-related settings enabling metrics and Amazon S3 events for S3 Replication Time Control (S3 RTC). Must be specified together with a <code>ReplicationTime</code> block. </p>"
}
},
"documentation": "<p>Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).</p>"
},
"DisplayName": {
"type": "string"
},
"ETag": {
"type": "string"
},
"EmailAddress": {
"type": "string"
},
"EnableRequestProgress": {
"type": "boolean"
},
"EncodingType": {
"type": "string",
"documentation": "<p>Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.</p>",
"enum": [
"url"
]
},
"Encryption": {
"type": "structure",
"required": [
"EncryptionType"
],
"members": {
"EncryptionType": {
"shape": "ServerSideEncryption",
"documentation": "<p>The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).</p>"
},
"KMSKeyId": {
"shape": "SSEKMSKeyId",
"documentation": "<p>If the encryption type is <code>aws:kms</code>, this optional value specifies the ID of the symmetric customer managed AWS KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"KMSContext": {
"shape": "KMSContext",
"documentation": "<p>If the encryption type is <code>aws:kms</code>, this optional value can be used to specify the encryption context for the restore results.</p>"
}
},
"documentation": "<p>Contains the type of server-side encryption used.</p>"
},
"EncryptionConfiguration": {
"type": "structure",
"members": {
"ReplicaKmsKeyID": {
"shape": "ReplicaKmsKeyID",
"documentation": "<p>Specifies the ID (Key ARN or Alias ARN) of the customer managed customer master key (CMK) stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric customer managed CMKs. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
},
"documentation": "<p>Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.</p>"
},
"End": {
"type": "long"
},
"EndEvent": {
"type": "structure",
"members": {},
"documentation": "<p>A message that indicates the request is complete and no more messages will be sent. You should not assume that the request is complete until the client receives an <code>EndEvent</code>.</p>",
"event": true
},
"Error": {
"type": "structure",
"members": {
"Key": {
"shape": "ObjectKey",
"documentation": "<p>The error key.</p>"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>The version ID of the error.</p>"
},
"Code": {
"shape": "Code",
"documentation": "<p>The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type. </p> <p class=\"title\"> <b>Amazon S3 error codes</b> </p> <ul> <li> <ul> <li> <p> <i>Code:</i> AccessDenied </p> </li> <li> <p> <i>Description:</i> Access Denied</p> </li> <li> <p> <i>HTTP Status Code:</i> 403 Forbidden</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> AccountProblem</p> </li> <li> <p> <i>Description:</i> There is a problem with your AWS account that prevents the operation from completing successfully. Contact AWS Support for further assistance.</p> </li> <li> <p> <i>HTTP Status Code:</i> 403 Forbidden</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> AllAccessDisabled</p> </li> <li> <p> <i>Description:</i> All access to this Amazon S3 resource has been disabled. Contact AWS Support for further assistance.</p> </li> <li> <p> <i>HTTP Status Code:</i> 403 Forbidden</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> AmbiguousGrantByEmailAddress</p> </li> <li> <p> <i>Description:</i> The email address you provided is associated with more than one account.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> AuthorizationHeaderMalformed</p> </li> <li> <p> <i>Description:</i> The authorization header you provided is invalid.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>HTTP Status Code:</i> N/A</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> BadDigest</p> </li> <li> <p> <i>Description:</i> The Content-MD5 you specified did not match what we received.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> BucketAlreadyExists</p> </li> <li> <p> <i>Description:</i> The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.</p> </li> <li> <p> <i>HTTP Status Code:</i> 409 Conflict</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> BucketAlreadyOwnedByYou</p> </li> <li> <p> <i>Description:</i> The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all AWS Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).</p> </li> <li> <p> <i>Code:</i> 409 Conflict (in all Regions except the North Virginia Region) </p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> BucketNotEmpty</p> </li> <li> <p> <i>Description:</i> The bucket you tried to delete is not empty.</p> </li> <li> <p> <i>HTTP Status Code:</i> 409 Conflict</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> CredentialsNotSupported</p> </li> <li> <p> <i>Description:</i> This request does not support credentials.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> CrossLocationLoggingProhibited</p> </li> <li> <p> <i>Description:</i> Cross-location logging not allowed. Buckets in one geographic location cannot log information to a bucket in another location.</p> </li> <li> <p> <i>HTTP Status Code:</i> 403 Forbidden</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> EntityTooSmall</p> </li> <li> <p> <i>Description:</i> Your proposed upload is smaller than the minimum allowed object size.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> EntityTooLarge</p> </li> <li> <p> <i>Description:</i> Your proposed upload exceeds the maximum allowed object size.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> ExpiredToken</p> </li> <li> <p> <i>Description:</i> The provided token has expired.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> IllegalVersioningConfigurationException </p> </li> <li> <p> <i>Description:</i> Indicates that the versioning configuration specified in the request is invalid.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> IncompleteBody</p> </li> <li> <p> <i>Description:</i> You did not provide the number of bytes specified by the Content-Length HTTP header</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> IncorrectNumberOfFilesInPostRequest</p> </li> <li> <p> <i>Description:</i> POST requires exactly one file upload per request.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InlineDataTooLarge</p> </li> <li> <p> <i>Description:</i> Inline data exceeds the maximum allowed size.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InternalError</p> </li> <li> <p> <i>Description:</i> We encountered an internal error. Please try again.</p> </li> <li> <p> <i>HTTP Status Code:</i> 500 Internal Server Error</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Server</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidAccessKeyId</p> </li> <li> <p> <i>Description:</i> The AWS access key ID you provided does not exist in our records.</p> </li> <li> <p> <i>HTTP Status Code:</i> 403 Forbidden</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidAddressingHeader</p> </li> <li> <p> <i>Description:</i> You must specify the Anonymous role.</p> </li> <li> <p> <i>HTTP Status Code:</i> N/A</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidArgument</p> </li> <li> <p> <i>Description:</i> Invalid Argument</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidBucketName</p> </li> <li> <p> <i>Description:</i> The specified bucket is not valid.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidBucketState</p> </li> <li> <p> <i>Description:</i> The request is not valid with the current state of the bucket.</p> </li> <li> <p> <i>HTTP Status Code:</i> 409 Conflict</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidDigest</p> </li> <li> <p> <i>Description:</i> The Content-MD5 you specified is not valid.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidEncryptionAlgorithmError</p> </li> <li> <p> <i>Description:</i> The encryption request you specified is not valid. The valid value is AES256.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidLocationConstraint</p> </li> <li> <p> <i>Description:</i> The specified location constraint is not valid. For more information about Regions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro\">How to Select a Region for Your Buckets</a>. </p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidObjectState</p> </li> <li> <p> <i>Description:</i> The operation is not valid for the current state of the object.</p> </li> <li> <p> <i>HTTP Status Code:</i> 403 Forbidden</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidPart</p> </li> <li> <p> <i>Description:</i> One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidPartOrder</p> </li> <li> <p> <i>Description:</i> The list of parts was not in ascending order. Parts list must be specified in order by part number.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidPayer</p> </li> <li> <p> <i>Description:</i> All access to this object has been disabled. Please contact AWS Support for further assistance.</p> </li> <li> <p> <i>HTTP Status Code:</i> 403 Forbidden</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidPolicyDocument</p> </li> <li> <p> <i>Description:</i> The content of the form does not meet the conditions specified in the policy document.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidRange</p> </li> <li> <p> <i>Description:</i> The requested range cannot be satisfied.</p> </li> <li> <p> <i>HTTP Status Code:</i> 416 Requested Range Not Satisfiable</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidRequest</p> </li> <li> <p> <i>Description:</i> Please use AWS4-HMAC-SHA256.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>Code:</i> N/A</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidRequest</p> </li> <li> <p> <i>Description:</i> SOAP requests must be made over an HTTPS connection.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidRequest</p> </li> <li> <p> <i>Description:</i> Amazon S3 Transfer Acceleration is not supported for buckets with non-DNS compliant names.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>Code:</i> N/A</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidRequest</p> </li> <li> <p> <i>Description:</i> Amazon S3 Transfer Acceleration is not supported for buckets with periods (.) in their names.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>Code:</i> N/A</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidRequest</p> </li> <li> <p> <i>Description:</i> Amazon S3 Transfer Accelerate endpoint only supports virtual style requests.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>Code:</i> N/A</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidRequest</p> </li> <li> <p> <i>Description:</i> Amazon S3 Transfer Accelerate is not configured on this bucket.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>Code:</i> N/A</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidRequest</p> </li> <li> <p> <i>Description:</i> Amazon S3 Transfer Accelerate is disabled on this bucket.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>Code:</i> N/A</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidRequest</p> </li> <li> <p> <i>Description:</i> Amazon S3 Transfer Acceleration is not supported on this bucket. Contact AWS Support for more information.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>Code:</i> N/A</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidRequest</p> </li> <li> <p> <i>Description:</i> Amazon S3 Transfer Acceleration cannot be enabled on this bucket. Contact AWS Support for more information.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>Code:</i> N/A</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidSecurity</p> </li> <li> <p> <i>Description:</i> The provided security credentials are not valid.</p> </li> <li> <p> <i>HTTP Status Code:</i> 403 Forbidden</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidSOAPRequest</p> </li> <li> <p> <i>Description:</i> The SOAP request body is invalid.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidStorageClass</p> </li> <li> <p> <i>Description:</i> The storage class you specified is not valid.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidTargetBucketForLogging</p> </li> <li> <p> <i>Description:</i> The target bucket for logging does not exist, is not owned by you, or does not have the appropriate grants for the log-delivery group. </p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidToken</p> </li> <li> <p> <i>Description:</i> The provided token is malformed or otherwise invalid.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> InvalidURI</p> </li> <li> <p> <i>Description:</i> Couldn't parse the specified URI.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> KeyTooLongError</p> </li> <li> <p> <i>Description:</i> Your key is too long.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> MalformedACLError</p> </li> <li> <p> <i>Description:</i> The XML you provided was not well-formed or did not validate against our published schema.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> MalformedPOSTRequest </p> </li> <li> <p> <i>Description:</i> The body of your POST request is not well-formed multipart/form-data.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> MalformedXML</p> </li> <li> <p> <i>Description:</i> This happens when the user sends malformed XML (XML that doesn't conform to the published XSD) for the configuration. The error message is, \"The XML you provided was not well-formed or did not validate against our published schema.\" </p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> MaxMessageLengthExceeded</p> </li> <li> <p> <i>Description:</i> Your request was too big.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> MaxPostPreDataLengthExceededError</p> </li> <li> <p> <i>Description:</i> Your POST request fields preceding the upload file were too large.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> MetadataTooLarge</p> </li> <li> <p> <i>Description:</i> Your metadata headers exceed the maximum allowed metadata size.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> MethodNotAllowed</p> </li> <li> <p> <i>Description:</i> The specified method is not allowed against this resource.</p> </li> <li> <p> <i>HTTP Status Code:</i> 405 Method Not Allowed</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> MissingAttachment</p> </li> <li> <p> <i>Description:</i> A SOAP attachment was expected, but none were found.</p> </li> <li> <p> <i>HTTP Status Code:</i> N/A</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> MissingContentLength</p> </li> <li> <p> <i>Description:</i> You must provide the Content-Length HTTP header.</p> </li> <li> <p> <i>HTTP Status Code:</i> 411 Length Required</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> MissingRequestBodyError</p> </li> <li> <p> <i>Description:</i> This happens when the user sends an empty XML document as a request. The error message is, \"Request body is empty.\" </p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> MissingSecurityElement</p> </li> <li> <p> <i>Description:</i> The SOAP 1.1 request is missing a security element.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> MissingSecurityHeader</p> </li> <li> <p> <i>Description:</i> Your request is missing a required header.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> NoLoggingStatusForKey</p> </li> <li> <p> <i>Description:</i> There is no such thing as a logging status subresource for a key.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> NoSuchBucket</p> </li> <li> <p> <i>Description:</i> The specified bucket does not exist.</p> </li> <li> <p> <i>HTTP Status Code:</i> 404 Not Found</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> NoSuchBucketPolicy</p> </li> <li> <p> <i>Description:</i> The specified bucket does not have a bucket policy.</p> </li> <li> <p> <i>HTTP Status Code:</i> 404 Not Found</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> NoSuchKey</p> </li> <li> <p> <i>Description:</i> The specified key does not exist.</p> </li> <li> <p> <i>HTTP Status Code:</i> 404 Not Found</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> NoSuchLifecycleConfiguration</p> </li> <li> <p> <i>Description:</i> The lifecycle configuration does not exist. </p> </li> <li> <p> <i>HTTP Status Code:</i> 404 Not Found</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> NoSuchUpload</p> </li> <li> <p> <i>Description:</i> The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</p> </li> <li> <p> <i>HTTP Status Code:</i> 404 Not Found</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> NoSuchVersion </p> </li> <li> <p> <i>Description:</i> Indicates that the version ID specified in the request does not match an existing version.</p> </li> <li> <p> <i>HTTP Status Code:</i> 404 Not Found</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> NotImplemented</p> </li> <li> <p> <i>Description:</i> A header you provided implies functionality that is not implemented.</p> </li> <li> <p> <i>HTTP Status Code:</i> 501 Not Implemented</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Server</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> NotSignedUp</p> </li> <li> <p> <i>Description:</i> Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3</p> </li> <li> <p> <i>HTTP Status Code:</i> 403 Forbidden</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> OperationAborted</p> </li> <li> <p> <i>Description:</i> A conflicting conditional operation is currently in progress against this resource. Try again.</p> </li> <li> <p> <i>HTTP Status Code:</i> 409 Conflict</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> PermanentRedirect</p> </li> <li> <p> <i>Description:</i> The bucket you are attempting to access must be addressed using the specified endpoint. Send all future requests to this endpoint.</p> </li> <li> <p> <i>HTTP Status Code:</i> 301 Moved Permanently</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> PreconditionFailed</p> </li> <li> <p> <i>Description:</i> At least one of the preconditions you specified did not hold.</p> </li> <li> <p> <i>HTTP Status Code:</i> 412 Precondition Failed</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> Redirect</p> </li> <li> <p> <i>Description:</i> Temporary redirect.</p> </li> <li> <p> <i>HTTP Status Code:</i> 307 Moved Temporarily</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> RestoreAlreadyInProgress</p> </li> <li> <p> <i>Description:</i> Object restore is already in progress.</p> </li> <li> <p> <i>HTTP Status Code:</i> 409 Conflict</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> RequestIsNotMultiPartContent</p> </li> <li> <p> <i>Description:</i> Bucket POST must be of the enclosure-type multipart/form-data.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> RequestTimeout</p> </li> <li> <p> <i>Description:</i> Your socket connection to the server was not read from or written to within the timeout period.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> RequestTimeTooSkewed</p> </li> <li> <p> <i>Description:</i> The difference between the request time and the server's time is too large.</p> </li> <li> <p> <i>HTTP Status Code:</i> 403 Forbidden</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> RequestTorrentOfBucketError</p> </li> <li> <p> <i>Description:</i> Requesting the torrent file of a bucket is not permitted.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> SignatureDoesNotMatch</p> </li> <li> <p> <i>Description:</i> The request signature we calculated does not match the signature you provided. Check your AWS secret access key and signing method. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">REST Authentication</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/SOAPAuthentication.html\">SOAP Authentication</a> for details.</p> </li> <li> <p> <i>HTTP Status Code:</i> 403 Forbidden</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> ServiceUnavailable</p> </li> <li> <p> <i>Description:</i> Reduce your request rate.</p> </li> <li> <p> <i>HTTP Status Code:</i> 503 Service Unavailable</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Server</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> SlowDown</p> </li> <li> <p> <i>Description:</i> Reduce your request rate.</p> </li> <li> <p> <i>HTTP Status Code:</i> 503 Slow Down</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Server</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> TemporaryRedirect</p> </li> <li> <p> <i>Description:</i> You are being redirected to the bucket while DNS updates.</p> </li> <li> <p> <i>HTTP Status Code:</i> 307 Moved Temporarily</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> TokenRefreshRequired</p> </li> <li> <p> <i>Description:</i> The provided token must be refreshed.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> TooManyBuckets</p> </li> <li> <p> <i>Description:</i> You have attempted to create more buckets than allowed.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> UnexpectedContent</p> </li> <li> <p> <i>Description:</i> This request does not support content.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> UnresolvableGrantByEmailAddress</p> </li> <li> <p> <i>Description:</i> The email address you provided does not match any account on record.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code:</i> UserKeyMustBeSpecified</p> </li> <li> <p> <i>Description:</i> The bucket POST must contain the specified field name. If it is specified, check the order of the fields.</p> </li> <li> <p> <i>HTTP Status Code:</i> 400 Bad Request</p> </li> <li> <p> <i>SOAP Fault Code Prefix:</i> Client</p> </li> </ul> </li> </ul> <p/>"
},
"Message": {
"shape": "Message",
"documentation": "<p>The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.</p>"
}
},
"documentation": "<p>Container for all error elements.</p>"
},
"ErrorDocument": {
"type": "structure",
"required": [
"Key"
],
"members": {
"Key": {
"shape": "ObjectKey",
"documentation": "<p>The object key name to use when a 4XX class error occurs.</p>"
}
},
"documentation": "<p>The error information.</p>"
},
"Errors": {
"type": "list",
"member": {
"shape": "Error"
},
"flattened": true
},
"Event": {
"type": "string",
"documentation": "<p>The bucket event for which to send notifications.</p>",
"enum": [
"s3:ReducedRedundancyLostObject",
"s3:ObjectCreated:*",
"s3:ObjectCreated:Put",
"s3:ObjectCreated:Post",
"s3:ObjectCreated:Copy",
"s3:ObjectCreated:CompleteMultipartUpload",
"s3:ObjectRemoved:*",
"s3:ObjectRemoved:Delete",
"s3:ObjectRemoved:DeleteMarkerCreated",
"s3:ObjectRestore:*",
"s3:ObjectRestore:Post",
"s3:ObjectRestore:Completed",
"s3:Replication:*",
"s3:Replication:OperationFailedReplication",
"s3:Replication:OperationNotTracked",
"s3:Replication:OperationMissedThreshold",
"s3:Replication:OperationReplicatedAfterThreshold"
]
},
"EventList": {
"type": "list",
"member": {
"shape": "Event"
},
"flattened": true
},
"ExistingObjectReplication": {
"type": "structure",
"required": [
"Status"
],
"members": {
"Status": {
"shape": "ExistingObjectReplicationStatus",
"documentation": "<p/>"
}
},
"documentation": "<p>Optional configuration to replicate existing source bucket objects. For more information, see <a href=\" https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication\">Replicating Existing Objects</a> in the <i>Amazon S3 Developer Guide</i>. </p>"
},
"ExistingObjectReplicationStatus": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
]
},
"Expiration": {
"type": "string"
},
"ExpirationStatus": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
]
},
"ExpiredObjectDeleteMarker": {
"type": "boolean"
},
"Expires": {
"type": "timestamp"
},
"ExposeHeader": {
"type": "string"
},
"ExposeHeaders": {
"type": "list",
"member": {
"shape": "ExposeHeader"
},
"flattened": true
},
"Expression": {
"type": "string"
},
"ExpressionType": {
"type": "string",
"enum": [
"SQL"
]
},
"FetchOwner": {
"type": "boolean"
},
"FieldDelimiter": {
"type": "string"
},
"FileHeaderInfo": {
"type": "string",
"enum": [
"USE",
"IGNORE",
"NONE"
]
},
"FilterRule": {
"type": "structure",
"members": {
"Name": {
"shape": "FilterRuleName",
"documentation": "<p>The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Configuring Event Notifications</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
},
"Value": {
"shape": "FilterRuleValue",
"documentation": "<p>The value that the filter searches for in object key names.</p>"
}
},
"documentation": "<p>Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.</p>"
},
"FilterRuleList": {
"type": "list",
"member": {
"shape": "FilterRule"
},
"documentation": "<p>A list of containers for the key-value pair that defines the criteria for the filter rule.</p>",
"flattened": true
},
"FilterRuleName": {
"type": "string",
"enum": [
"prefix",
"suffix"
]
},
"FilterRuleValue": {
"type": "string"
},
"GetBucketAccelerateConfigurationOutput": {
"type": "structure",
"members": {
"Status": {
"shape": "BucketAccelerateStatus",
"documentation": "<p>The accelerate configuration of the bucket.</p>"
}
}
},
"GetBucketAccelerateConfigurationRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Name of the bucket for which the accelerate configuration is retrieved.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetBucketAclOutput": {
"type": "structure",
"members": {
"Owner": {
"shape": "Owner",
"documentation": "<p>Container for the bucket owner's display name and ID.</p>"
},
"Grants": {
"shape": "Grants",
"documentation": "<p>A list of grants.</p>",
"locationName": "AccessControlList"
}
}
},
"GetBucketAclRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Specifies the S3 bucket whose ACL is being requested.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetBucketAnalyticsConfigurationOutput": {
"type": "structure",
"members": {
"AnalyticsConfiguration": {
"shape": "AnalyticsConfiguration",
"documentation": "<p>The configuration and any analyses for the analytics filter.</p>"
}
},
"payload": "AnalyticsConfiguration"
},
"GetBucketAnalyticsConfigurationRequest": {
"type": "structure",
"required": [
"Bucket",
"Id"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket from which an analytics configuration is retrieved.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Id": {
"shape": "AnalyticsId",
"documentation": "<p>The ID that identifies the analytics configuration.</p>",
"location": "querystring",
"locationName": "id"
}
}
},
"GetBucketCorsOutput": {
"type": "structure",
"members": {
"CORSRules": {
"shape": "CORSRules",
"documentation": "<p>A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.</p>",
"locationName": "CORSRule"
}
}
},
"GetBucketCorsRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name for which to get the cors configuration.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetBucketEncryptionOutput": {
"type": "structure",
"members": {
"ServerSideEncryptionConfiguration": {
"shape": "ServerSideEncryptionConfiguration"
}
},
"payload": "ServerSideEncryptionConfiguration"
},
"GetBucketEncryptionRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket from which the server-side encryption configuration is retrieved.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetBucketInventoryConfigurationOutput": {
"type": "structure",
"members": {
"InventoryConfiguration": {
"shape": "InventoryConfiguration",
"documentation": "<p>Specifies the inventory configuration.</p>"
}
},
"payload": "InventoryConfiguration"
},
"GetBucketInventoryConfigurationRequest": {
"type": "structure",
"required": [
"Bucket",
"Id"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket containing the inventory configuration to retrieve.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Id": {
"shape": "InventoryId",
"documentation": "<p>The ID used to identify the inventory configuration.</p>",
"location": "querystring",
"locationName": "id"
}
}
},
"GetBucketLifecycleConfigurationOutput": {
"type": "structure",
"members": {
"Rules": {
"shape": "LifecycleRules",
"documentation": "<p>Container for a lifecycle rule.</p>",
"locationName": "Rule"
}
}
},
"GetBucketLifecycleConfigurationRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket for which to get the lifecycle information.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetBucketLifecycleOutput": {
"type": "structure",
"members": {
"Rules": {
"shape": "Rules",
"documentation": "<p>Container for a lifecycle rule.</p>",
"locationName": "Rule"
}
}
},
"GetBucketLifecycleRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket for which to get the lifecycle information.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetBucketLocationOutput": {
"type": "structure",
"members": {
"LocationConstraint": {
"shape": "BucketLocationConstraint",
"documentation": "<p>Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported location constraints by Region, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region\">Regions and Endpoints</a>.</p>"
}
}
},
"GetBucketLocationRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket for which to get the location.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetBucketLoggingOutput": {
"type": "structure",
"members": {
"LoggingEnabled": {
"shape": "LoggingEnabled"
}
}
},
"GetBucketLoggingRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name for which to get the logging information.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetBucketMetricsConfigurationOutput": {
"type": "structure",
"members": {
"MetricsConfiguration": {
"shape": "MetricsConfiguration",
"documentation": "<p>Specifies the metrics configuration.</p>"
}
},
"payload": "MetricsConfiguration"
},
"GetBucketMetricsConfigurationRequest": {
"type": "structure",
"required": [
"Bucket",
"Id"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket containing the metrics configuration to retrieve.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Id": {
"shape": "MetricsId",
"documentation": "<p>The ID used to identify the metrics configuration.</p>",
"location": "querystring",
"locationName": "id"
}
}
},
"GetBucketNotificationConfigurationRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Name of the bucket for which to get the notification configuration</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetBucketPolicyOutput": {
"type": "structure",
"members": {
"Policy": {
"shape": "Policy",
"documentation": "<p>The bucket policy as a JSON document.</p>"
}
},
"payload": "Policy"
},
"GetBucketPolicyRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name for which to get the bucket policy.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetBucketPolicyStatusOutput": {
"type": "structure",
"members": {
"PolicyStatus": {
"shape": "PolicyStatus",
"documentation": "<p>The policy status for the specified bucket.</p>"
}
},
"payload": "PolicyStatus"
},
"GetBucketPolicyStatusRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the Amazon S3 bucket whose policy status you want to retrieve.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetBucketReplicationOutput": {
"type": "structure",
"members": {
"ReplicationConfiguration": {
"shape": "ReplicationConfiguration"
}
},
"payload": "ReplicationConfiguration"
},
"GetBucketReplicationRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name for which to get the replication information.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetBucketRequestPaymentOutput": {
"type": "structure",
"members": {
"Payer": {
"shape": "Payer",
"documentation": "<p>Specifies who pays for the download and request fees.</p>"
}
}
},
"GetBucketRequestPaymentRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket for which to get the payment request configuration</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetBucketTaggingOutput": {
"type": "structure",
"required": [
"TagSet"
],
"members": {
"TagSet": {
"shape": "TagSet",
"documentation": "<p>Contains the tag set.</p>"
}
}
},
"GetBucketTaggingRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket for which to get the tagging information.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetBucketVersioningOutput": {
"type": "structure",
"members": {
"Status": {
"shape": "BucketVersioningStatus",
"documentation": "<p>The versioning state of the bucket.</p>"
},
"MFADelete": {
"shape": "MFADeleteStatus",
"documentation": "<p>Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.</p>",
"locationName": "MfaDelete"
}
}
},
"GetBucketVersioningRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket for which to get the versioning information.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetBucketWebsiteOutput": {
"type": "structure",
"members": {
"RedirectAllRequestsTo": {
"shape": "RedirectAllRequestsTo",
"documentation": "<p>Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.</p>"
},
"IndexDocument": {
"shape": "IndexDocument",
"documentation": "<p>The name of the index document for the website.</p>"
},
"ErrorDocument": {
"shape": "ErrorDocument",
"documentation": "<p>The name of the error document for the website.</p>"
},
"RoutingRules": {
"shape": "RoutingRules",
"documentation": "<p>Rules that define when a redirect is applied and the redirect behavior.</p>"
}
}
},
"GetBucketWebsiteRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name for which to get the website configuration.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetObjectAclOutput": {
"type": "structure",
"members": {
"Owner": {
"shape": "Owner",
"documentation": "<p> Container for the bucket owner's display name and ID.</p>"
},
"Grants": {
"shape": "Grants",
"documentation": "<p>A list of grants.</p>",
"locationName": "AccessControlList"
},
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
}
}
},
"GetObjectAclRequest": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name that contains the object for which to get the ACL information. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>The key of the object for which to get the ACL information.</p>",
"location": "uri",
"locationName": "Key"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>VersionId used to reference a specific version of the object.</p>",
"location": "querystring",
"locationName": "versionId"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
}
}
},
"GetObjectLegalHoldOutput": {
"type": "structure",
"members": {
"LegalHold": {
"shape": "ObjectLockLegalHold",
"documentation": "<p>The current Legal Hold status for the specified object.</p>"
}
},
"payload": "LegalHold"
},
"GetObjectLegalHoldRequest": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name containing the object whose Legal Hold status you want to retrieve. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>The key name for the object whose Legal Hold status you want to retrieve.</p>",
"location": "uri",
"locationName": "Key"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>The version ID of the object whose Legal Hold status you want to retrieve.</p>",
"location": "querystring",
"locationName": "versionId"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
}
}
},
"GetObjectLockConfigurationOutput": {
"type": "structure",
"members": {
"ObjectLockConfiguration": {
"shape": "ObjectLockConfiguration",
"documentation": "<p>The specified bucket's Object Lock configuration.</p>"
}
},
"payload": "ObjectLockConfiguration"
},
"GetObjectLockConfigurationRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket whose Object Lock configuration you want to retrieve.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GetObjectOutput": {
"type": "structure",
"members": {
"Body": {
"shape": "Body",
"documentation": "<p>Object data.</p>",
"streaming": true
},
"DeleteMarker": {
"shape": "DeleteMarker",
"documentation": "<p>Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.</p>",
"location": "header",
"locationName": "x-amz-delete-marker"
},
"AcceptRanges": {
"shape": "AcceptRanges",
"documentation": "<p>Indicates that a range of bytes was specified.</p>",
"location": "header",
"locationName": "accept-ranges"
},
"Expiration": {
"shape": "Expiration",
"documentation": "<p>If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.</p>",
"location": "header",
"locationName": "x-amz-expiration"
},
"Restore": {
"shape": "Restore",
"documentation": "<p>Provides information about object restoration operation and expiration time of the restored object copy.</p>",
"location": "header",
"locationName": "x-amz-restore"
},
"LastModified": {
"shape": "LastModified",
"documentation": "<p>Last modified date of the object</p>",
"location": "header",
"locationName": "Last-Modified"
},
"ContentLength": {
"shape": "ContentLength",
"documentation": "<p>Size of the body in bytes.</p>",
"location": "header",
"locationName": "Content-Length"
},
"ETag": {
"shape": "ETag",
"documentation": "<p>An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>",
"location": "header",
"locationName": "ETag"
},
"MissingMeta": {
"shape": "MissingMeta",
"documentation": "<p>This is set to the number of metadata entries not returned in <code>x-amz-meta</code> headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.</p>",
"location": "header",
"locationName": "x-amz-missing-meta"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>Version of the object.</p>",
"location": "header",
"locationName": "x-amz-version-id"
},
"CacheControl": {
"shape": "CacheControl",
"documentation": "<p>Specifies caching behavior along the request/reply chain.</p>",
"location": "header",
"locationName": "Cache-Control"
},
"ContentDisposition": {
"shape": "ContentDisposition",
"documentation": "<p>Specifies presentational information for the object.</p>",
"location": "header",
"locationName": "Content-Disposition"
},
"ContentEncoding": {
"shape": "ContentEncoding",
"documentation": "<p>Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.</p>",
"location": "header",
"locationName": "Content-Encoding"
},
"ContentLanguage": {
"shape": "ContentLanguage",
"documentation": "<p>The language the content is in.</p>",
"location": "header",
"locationName": "Content-Language"
},
"ContentRange": {
"shape": "ContentRange",
"documentation": "<p>The portion of the object returned in the response.</p>",
"location": "header",
"locationName": "Content-Range"
},
"ContentType": {
"shape": "ContentType",
"documentation": "<p>A standard MIME type describing the format of the object data.</p>",
"location": "header",
"locationName": "Content-Type"
},
"Expires": {
"shape": "Expires",
"documentation": "<p>The date and time at which the object is no longer cacheable.</p>",
"location": "header",
"locationName": "Expires"
},
"WebsiteRedirectLocation": {
"shape": "WebsiteRedirectLocation",
"documentation": "<p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.</p>",
"location": "header",
"locationName": "x-amz-website-redirect-location"
},
"ServerSideEncryption": {
"shape": "ServerSideEncryption",
"documentation": "<p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"Metadata": {
"shape": "Metadata",
"documentation": "<p>A map of metadata to store with the object in S3.</p>",
"location": "headers",
"locationName": "x-amz-meta-"
},
"SSECustomerAlgorithm": {
"shape": "SSECustomerAlgorithm",
"documentation": "<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5": {
"shape": "SSECustomerKeyMD5",
"documentation": "<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId": {
"shape": "SSEKMSKeyId",
"documentation": "<p>If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
},
"StorageClass": {
"shape": "StorageClass",
"documentation": "<p>Provides storage class information of the object. Amazon S3 returns this header for all objects except for Standard storage class objects.</p>",
"location": "header",
"locationName": "x-amz-storage-class"
},
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
},
"ReplicationStatus": {
"shape": "ReplicationStatus",
"documentation": "<p>Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.</p>",
"location": "header",
"locationName": "x-amz-replication-status"
},
"PartsCount": {
"shape": "PartsCount",
"documentation": "<p>The count of parts this object has.</p>",
"location": "header",
"locationName": "x-amz-mp-parts-count"
},
"TagCount": {
"shape": "TagCount",
"documentation": "<p>The number of tags, if any, on the object.</p>",
"location": "header",
"locationName": "x-amz-tagging-count"
},
"ObjectLockMode": {
"shape": "ObjectLockMode",
"documentation": "<p>The Object Lock mode currently in place for this object.</p>",
"location": "header",
"locationName": "x-amz-object-lock-mode"
},
"ObjectLockRetainUntilDate": {
"shape": "ObjectLockRetainUntilDate",
"documentation": "<p>The date and time when this object's Object Lock will expire.</p>",
"location": "header",
"locationName": "x-amz-object-lock-retain-until-date"
},
"ObjectLockLegalHoldStatus": {
"shape": "ObjectLockLegalHoldStatus",
"documentation": "<p>Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status. </p>",
"location": "header",
"locationName": "x-amz-object-lock-legal-hold"
}
},
"payload": "Body"
},
"GetObjectRequest": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name containing the object. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"IfMatch": {
"shape": "IfMatch",
"documentation": "<p>Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).</p>",
"location": "header",
"locationName": "If-Match"
},
"IfModifiedSince": {
"shape": "IfModifiedSince",
"documentation": "<p>Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).</p>",
"location": "header",
"locationName": "If-Modified-Since"
},
"IfNoneMatch": {
"shape": "IfNoneMatch",
"documentation": "<p>Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).</p>",
"location": "header",
"locationName": "If-None-Match"
},
"IfUnmodifiedSince": {
"shape": "IfUnmodifiedSince",
"documentation": "<p>Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).</p>",
"location": "header",
"locationName": "If-Unmodified-Since"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Key of the object to get.</p>",
"location": "uri",
"locationName": "Key"
},
"Range": {
"shape": "Range",
"documentation": "<p>Downloads the specified range bytes of an object. For more information about the HTTP Range header, see <a href=\"\">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35</a>.</p>",
"location": "header",
"locationName": "Range"
},
"ResponseCacheControl": {
"shape": "ResponseCacheControl",
"documentation": "<p>Sets the <code>Cache-Control</code> header of the response.</p>",
"location": "querystring",
"locationName": "response-cache-control"
},
"ResponseContentDisposition": {
"shape": "ResponseContentDisposition",
"documentation": "<p>Sets the <code>Content-Disposition</code> header of the response</p>",
"location": "querystring",
"locationName": "response-content-disposition"
},
"ResponseContentEncoding": {
"shape": "ResponseContentEncoding",
"documentation": "<p>Sets the <code>Content-Encoding</code> header of the response.</p>",
"location": "querystring",
"locationName": "response-content-encoding"
},
"ResponseContentLanguage": {
"shape": "ResponseContentLanguage",
"documentation": "<p>Sets the <code>Content-Language</code> header of the response.</p>",
"location": "querystring",
"locationName": "response-content-language"
},
"ResponseContentType": {
"shape": "ResponseContentType",
"documentation": "<p>Sets the <code>Content-Type</code> header of the response.</p>",
"location": "querystring",
"locationName": "response-content-type"
},
"ResponseExpires": {
"shape": "ResponseExpires",
"documentation": "<p>Sets the <code>Expires</code> header of the response.</p>",
"location": "querystring",
"locationName": "response-expires"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>VersionId used to reference a specific version of the object.</p>",
"location": "querystring",
"locationName": "versionId"
},
"SSECustomerAlgorithm": {
"shape": "SSECustomerAlgorithm",
"documentation": "<p>Specifies the algorithm to use to when encrypting the object (for example, AES256).</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey": {
"shape": "SSECustomerKey",
"documentation": "<p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5": {
"shape": "SSECustomerKeyMD5",
"documentation": "<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
},
"PartNumber": {
"shape": "PartNumber",
"documentation": "<p>Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.</p>",
"location": "querystring",
"locationName": "partNumber"
}
}
},
"GetObjectRetentionOutput": {
"type": "structure",
"members": {
"Retention": {
"shape": "ObjectLockRetention",
"documentation": "<p>The container element for an object's retention settings.</p>"
}
},
"payload": "Retention"
},
"GetObjectRetentionRequest": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name containing the object whose retention settings you want to retrieve. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>The key name for the object whose retention settings you want to retrieve.</p>",
"location": "uri",
"locationName": "Key"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>The version ID for the object whose retention settings you want to retrieve.</p>",
"location": "querystring",
"locationName": "versionId"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
}
}
},
"GetObjectTaggingOutput": {
"type": "structure",
"required": [
"TagSet"
],
"members": {
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>The versionId of the object for which you got the tagging information.</p>",
"location": "header",
"locationName": "x-amz-version-id"
},
"TagSet": {
"shape": "TagSet",
"documentation": "<p>Contains the tag set.</p>"
}
}
},
"GetObjectTaggingRequest": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name containing the object for which to get the tagging information. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Object key for which to get the tagging information.</p>",
"location": "uri",
"locationName": "Key"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>The versionId of the object for which to get the tagging information.</p>",
"location": "querystring",
"locationName": "versionId"
}
}
},
"GetObjectTorrentOutput": {
"type": "structure",
"members": {
"Body": {
"shape": "Body",
"documentation": "<p>A Bencoded dictionary as defined by the BitTorrent specification</p>",
"streaming": true
},
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
}
},
"payload": "Body"
},
"GetObjectTorrentRequest": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket containing the object for which to get the torrent files.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>The object key for which to get the information.</p>",
"location": "uri",
"locationName": "Key"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
}
}
},
"GetPublicAccessBlockOutput": {
"type": "structure",
"members": {
"PublicAccessBlockConfiguration": {
"shape": "PublicAccessBlockConfiguration",
"documentation": "<p>The <code>PublicAccessBlock</code> configuration currently in effect for this Amazon S3 bucket.</p>"
}
},
"payload": "PublicAccessBlockConfiguration"
},
"GetPublicAccessBlockRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the Amazon S3 bucket whose <code>PublicAccessBlock</code> configuration you want to retrieve. </p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"GlacierJobParameters": {
"type": "structure",
"required": [
"Tier"
],
"members": {
"Tier": {
"shape": "Tier",
"documentation": "<p>Glacier retrieval tier at which the restore will be processed.</p>"
}
},
"documentation": "<p>Container for Glacier job parameters.</p>"
},
"Grant": {
"type": "structure",
"members": {
"Grantee": {
"shape": "Grantee",
"documentation": "<p>The person being granted permissions.</p>"
},
"Permission": {
"shape": "Permission",
"documentation": "<p>Specifies the permission given to the grantee.</p>"
}
},
"documentation": "<p>Container for grant information.</p>"
},
"GrantFullControl": {
"type": "string"
},
"GrantRead": {
"type": "string"
},
"GrantReadACP": {
"type": "string"
},
"GrantWrite": {
"type": "string"
},
"GrantWriteACP": {
"type": "string"
},
"Grantee": {
"type": "structure",
"required": [
"Type"
],
"members": {
"DisplayName": {
"shape": "DisplayName",
"documentation": "<p>Screen name of the grantee.</p>"
},
"EmailAddress": {
"shape": "EmailAddress",
"documentation": "<p>Email address of the grantee.</p>"
},
"ID": {
"shape": "ID",
"documentation": "<p>The canonical user ID of the grantee.</p>"
},
"Type": {
"shape": "Type",
"documentation": "<p>Type of grantee</p>",
"locationName": "xsi:type",
"xmlAttribute": true
},
"URI": {
"shape": "URI",
"documentation": "<p>URI of the grantee group.</p>"
}
},
"documentation": "<p>Container for the person being granted permissions.</p>",
"xmlNamespace": {
"prefix": "xsi",
"uri": "http://www.w3.org/2001/XMLSchema-instance"
}
},
"Grants": {
"type": "list",
"member": {
"shape": "Grant",
"locationName": "Grant"
}
},
"HeadBucketRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name.</p>",
"location": "uri",
"locationName": "Bucket"
}
}
},
"HeadObjectOutput": {
"type": "structure",
"members": {
"DeleteMarker": {
"shape": "DeleteMarker",
"documentation": "<p>Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.</p>",
"location": "header",
"locationName": "x-amz-delete-marker"
},
"AcceptRanges": {
"shape": "AcceptRanges",
"documentation": "<p>Indicates that a range of bytes was specified.</p>",
"location": "header",
"locationName": "accept-ranges"
},
"Expiration": {
"shape": "Expiration",
"documentation": "<p>If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.</p>",
"location": "header",
"locationName": "x-amz-expiration"
},
"Restore": {
"shape": "Restore",
"documentation": "<p>If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see <a>RestoreObject</a> or an archive copy is already restored.</p> <p> If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:</p> <p> <code>x-amz-restore: ongoing-request=\"false\", expiry-date=\"Fri, 23 Dec 2012 00:00:00 GMT\"</code> </p> <p>If the object restoration is in progress, the header returns the value <code>ongoing-request=\"true\"</code>.</p> <p>For more information about archiving objects, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations\">Transitioning Objects: General Considerations</a>.</p>",
"location": "header",
"locationName": "x-amz-restore"
},
"LastModified": {
"shape": "LastModified",
"documentation": "<p>Last modified date of the object</p>",
"location": "header",
"locationName": "Last-Modified"
},
"ContentLength": {
"shape": "ContentLength",
"documentation": "<p>Size of the body in bytes.</p>",
"location": "header",
"locationName": "Content-Length"
},
"ETag": {
"shape": "ETag",
"documentation": "<p>An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>",
"location": "header",
"locationName": "ETag"
},
"MissingMeta": {
"shape": "MissingMeta",
"documentation": "<p>This is set to the number of metadata entries not returned in <code>x-amz-meta</code> headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.</p>",
"location": "header",
"locationName": "x-amz-missing-meta"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>Version of the object.</p>",
"location": "header",
"locationName": "x-amz-version-id"
},
"CacheControl": {
"shape": "CacheControl",
"documentation": "<p>Specifies caching behavior along the request/reply chain.</p>",
"location": "header",
"locationName": "Cache-Control"
},
"ContentDisposition": {
"shape": "ContentDisposition",
"documentation": "<p>Specifies presentational information for the object.</p>",
"location": "header",
"locationName": "Content-Disposition"
},
"ContentEncoding": {
"shape": "ContentEncoding",
"documentation": "<p>Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.</p>",
"location": "header",
"locationName": "Content-Encoding"
},
"ContentLanguage": {
"shape": "ContentLanguage",
"documentation": "<p>The language the content is in.</p>",
"location": "header",
"locationName": "Content-Language"
},
"ContentType": {
"shape": "ContentType",
"documentation": "<p>A standard MIME type describing the format of the object data.</p>",
"location": "header",
"locationName": "Content-Type"
},
"Expires": {
"shape": "Expires",
"documentation": "<p>The date and time at which the object is no longer cacheable.</p>",
"location": "header",
"locationName": "Expires"
},
"WebsiteRedirectLocation": {
"shape": "WebsiteRedirectLocation",
"documentation": "<p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.</p>",
"location": "header",
"locationName": "x-amz-website-redirect-location"
},
"ServerSideEncryption": {
"shape": "ServerSideEncryption",
"documentation": "<p>If the object is stored using server-side encryption either with an AWS KMS customer master key (CMK) or an Amazon S3-managed encryption key, the response includes this header with the value of the server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"Metadata": {
"shape": "Metadata",
"documentation": "<p>A map of metadata to store with the object in S3.</p>",
"location": "headers",
"locationName": "x-amz-meta-"
},
"SSECustomerAlgorithm": {
"shape": "SSECustomerAlgorithm",
"documentation": "<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5": {
"shape": "SSECustomerKeyMD5",
"documentation": "<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId": {
"shape": "SSEKMSKeyId",
"documentation": "<p>If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
},
"StorageClass": {
"shape": "StorageClass",
"documentation": "<p>Provides storage class information of the object. Amazon S3 returns this header for all objects except for Standard storage class objects.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html\">Storage Classes</a>.</p>",
"location": "header",
"locationName": "x-amz-storage-class"
},
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
},
"ReplicationStatus": {
"shape": "ReplicationStatus",
"documentation": "<p>Amazon S3 can return this header if your request involves a bucket that is either a source or destination in a replication rule.</p> <p>In replication, you have a source bucket on which you configure replication and destination bucket where Amazon S3 stores object replicas. When you request an object (<code>GetObject</code>) or object metadata (<code>HeadObject</code>) from these buckets, Amazon S3 will return the <code>x-amz-replication-status</code> header in the response as follows:</p> <ul> <li> <p>If requesting an object from the source bucket — Amazon S3 will return the <code>x-amz-replication-status</code> header if the object in your request is eligible for replication.</p> <p> For example, suppose that in your replication configuration, you specify object prefix <code>TaxDocs</code> requesting Amazon S3 to replicate objects with key prefix <code>TaxDocs</code>. Any objects you upload with this key name prefix, for example <code>TaxDocs/document1.pdf</code>, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the <code>x-amz-replication-status</code> header with value PENDING, COMPLETED or FAILED indicating object replication status.</p> </li> <li> <p>If requesting an object from the destination bucket — Amazon S3 will return the <code>x-amz-replication-status</code> header with value REPLICA if the object in your request is a replica that Amazon S3 created.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Replication</a>.</p>",
"location": "header",
"locationName": "x-amz-replication-status"
},
"PartsCount": {
"shape": "PartsCount",
"documentation": "<p>The count of parts this object has.</p>",
"location": "header",
"locationName": "x-amz-mp-parts-count"
},
"ObjectLockMode": {
"shape": "ObjectLockMode",
"documentation": "<p>The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission. For more information about S3 Object Lock, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Object Lock</a>. </p>",
"location": "header",
"locationName": "x-amz-object-lock-mode"
},
"ObjectLockRetainUntilDate": {
"shape": "ObjectLockRetainUntilDate",
"documentation": "<p>The date and time when the Object Lock retention period expires. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission.</p>",
"location": "header",
"locationName": "x-amz-object-lock-retain-until-date"
},
"ObjectLockLegalHoldStatus": {
"shape": "ObjectLockLegalHoldStatus",
"documentation": "<p>Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectLegalHold</code> permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Object Lock</a>.</p>",
"location": "header",
"locationName": "x-amz-object-lock-legal-hold"
}
}
},
"HeadObjectRequest": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket containing the object.</p>",
"location": "uri",
"locationName": "Bucket"
},
"IfMatch": {
"shape": "IfMatch",
"documentation": "<p>Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).</p>",
"location": "header",
"locationName": "If-Match"
},
"IfModifiedSince": {
"shape": "IfModifiedSince",
"documentation": "<p>Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).</p>",
"location": "header",
"locationName": "If-Modified-Since"
},
"IfNoneMatch": {
"shape": "IfNoneMatch",
"documentation": "<p>Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).</p>",
"location": "header",
"locationName": "If-None-Match"
},
"IfUnmodifiedSince": {
"shape": "IfUnmodifiedSince",
"documentation": "<p>Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).</p>",
"location": "header",
"locationName": "If-Unmodified-Since"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>The object key.</p>",
"location": "uri",
"locationName": "Key"
},
"Range": {
"shape": "Range",
"documentation": "<p>Downloads the specified range bytes of an object. For more information about the HTTP Range header, see <a href=\"\">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35</a>.</p>",
"location": "header",
"locationName": "Range"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>VersionId used to reference a specific version of the object.</p>",
"location": "querystring",
"locationName": "versionId"
},
"SSECustomerAlgorithm": {
"shape": "SSECustomerAlgorithm",
"documentation": "<p>Specifies the algorithm to use to when encrypting the object (for example, AES256).</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey": {
"shape": "SSECustomerKey",
"documentation": "<p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5": {
"shape": "SSECustomerKeyMD5",
"documentation": "<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
},
"PartNumber": {
"shape": "PartNumber",
"documentation": "<p>Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.</p>",
"location": "querystring",
"locationName": "partNumber"
}
}
},
"HostName": {
"type": "string"
},
"HttpErrorCodeReturnedEquals": {
"type": "string"
},
"HttpRedirectCode": {
"type": "string"
},
"ID": {
"type": "string"
},
"IfMatch": {
"type": "string"
},
"IfModifiedSince": {
"type": "timestamp"
},
"IfNoneMatch": {
"type": "string"
},
"IfUnmodifiedSince": {
"type": "timestamp"
},
"IndexDocument": {
"type": "structure",
"required": [
"Suffix"
],
"members": {
"Suffix": {
"shape": "Suffix",
"documentation": "<p>A suffix that is appended to a request that is for a directory on the website endpoint (for example,if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.</p>"
}
},
"documentation": "<p>Container for the <code>Suffix</code> element.</p>"
},
"Initiated": {
"type": "timestamp"
},
"Initiator": {
"type": "structure",
"members": {
"ID": {
"shape": "ID",
"documentation": "<p>If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.</p>"
},
"DisplayName": {
"shape": "DisplayName",
"documentation": "<p>Name of the Principal.</p>"
}
},
"documentation": "<p>Container element that identifies who initiated the multipart upload. </p>"
},
"InputSerialization": {
"type": "structure",
"members": {
"CSV": {
"shape": "CSVInput",
"documentation": "<p>Describes the serialization of a CSV-encoded object.</p>"
},
"CompressionType": {
"shape": "CompressionType",
"documentation": "<p>Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.</p>"
},
"JSON": {
"shape": "JSONInput",
"documentation": "<p>Specifies JSON as object's input serialization format.</p>"
},
"Parquet": {
"shape": "ParquetInput",
"documentation": "<p>Specifies Parquet as object's input serialization format.</p>"
}
},
"documentation": "<p>Describes the serialization format of the object.</p>"
},
"InventoryConfiguration": {
"type": "structure",
"required": [
"Destination",
"IsEnabled",
"Id",
"IncludedObjectVersions",
"Schedule"
],
"members": {
"Destination": {
"shape": "InventoryDestination",
"documentation": "<p>Contains information about where to publish the inventory results.</p>"
},
"IsEnabled": {
"shape": "IsEnabled",
"documentation": "<p>Specifies whether the inventory is enabled or disabled. If set to <code>True</code>, an inventory list is generated. If set to <code>False</code>, no inventory list is generated.</p>"
},
"Filter": {
"shape": "InventoryFilter",
"documentation": "<p>Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.</p>"
},
"Id": {
"shape": "InventoryId",
"documentation": "<p>The ID used to identify the inventory configuration.</p>"
},
"IncludedObjectVersions": {
"shape": "InventoryIncludedObjectVersions",
"documentation": "<p>Object versions to include in the inventory list. If set to <code>All</code>, the list includes all the object versions, which adds the version-related fields <code>VersionId</code>, <code>IsLatest</code>, and <code>DeleteMarker</code> to the list. If set to <code>Current</code>, the list does not contain these version-related fields.</p>"
},
"OptionalFields": {
"shape": "InventoryOptionalFields",
"documentation": "<p>Contains the optional fields that are included in the inventory results.</p>"
},
"Schedule": {
"shape": "InventorySchedule",
"documentation": "<p>Specifies the schedule for generating inventory results.</p>"
}
},
"documentation": "<p>Specifies the inventory configuration for an Amazon S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html\">GET Bucket inventory</a> in the <i>Amazon Simple Storage Service API Reference</i>. </p>"
},
"InventoryConfigurationList": {
"type": "list",
"member": {
"shape": "InventoryConfiguration"
},
"flattened": true
},
"InventoryDestination": {
"type": "structure",
"required": [
"S3BucketDestination"
],
"members": {
"S3BucketDestination": {
"shape": "InventoryS3BucketDestination",
"documentation": "<p>Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.</p>"
}
},
"documentation": "<p>Specifies the inventory configuration for an Amazon S3 bucket.</p>"
},
"InventoryEncryption": {
"type": "structure",
"members": {
"SSES3": {
"shape": "SSES3",
"documentation": "<p>Specifies the use of SSE-S3 to encrypt delivered inventory reports.</p>",
"locationName": "SSE-S3"
},
"SSEKMS": {
"shape": "SSEKMS",
"documentation": "<p>Specifies the use of SSE-KMS to encrypt delivered inventory reports.</p>",
"locationName": "SSE-KMS"
}
},
"documentation": "<p>Contains the type of server-side encryption used to encrypt the inventory results.</p>"
},
"InventoryFilter": {
"type": "structure",
"required": [
"Prefix"
],
"members": {
"Prefix": {
"shape": "Prefix",
"documentation": "<p>The prefix that an object must have to be included in the inventory results.</p>"
}
},
"documentation": "<p>Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.</p>"
},
"InventoryFormat": {
"type": "string",
"enum": [
"CSV",
"ORC",
"Parquet"
]
},
"InventoryFrequency": {
"type": "string",
"enum": [
"Daily",
"Weekly"
]
},
"InventoryId": {
"type": "string"
},
"InventoryIncludedObjectVersions": {
"type": "string",
"enum": [
"All",
"Current"
]
},
"InventoryOptionalField": {
"type": "string",
"enum": [
"Size",
"LastModifiedDate",
"StorageClass",
"ETag",
"IsMultipartUploaded",
"ReplicationStatus",
"EncryptionStatus",
"ObjectLockRetainUntilDate",
"ObjectLockMode",
"ObjectLockLegalHoldStatus",
"IntelligentTieringAccessTier"
]
},
"InventoryOptionalFields": {
"type": "list",
"member": {
"shape": "InventoryOptionalField",
"locationName": "Field"
}
},
"InventoryS3BucketDestination": {
"type": "structure",
"required": [
"Bucket",
"Format"
],
"members": {
"AccountId": {
"shape": "AccountId",
"documentation": "<p>The ID of the account that owns the destination bucket.</p>"
},
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The Amazon Resource Name (ARN) of the bucket where inventory results will be published.</p>"
},
"Format": {
"shape": "InventoryFormat",
"documentation": "<p>Specifies the output format of the inventory results.</p>"
},
"Prefix": {
"shape": "Prefix",
"documentation": "<p>The prefix that is prepended to all inventory results.</p>"
},
"Encryption": {
"shape": "InventoryEncryption",
"documentation": "<p>Contains the type of server-side encryption used to encrypt the inventory results.</p>"
}
},
"documentation": "<p>Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.</p>"
},
"InventorySchedule": {
"type": "structure",
"required": [
"Frequency"
],
"members": {
"Frequency": {
"shape": "InventoryFrequency",
"documentation": "<p>Specifies how frequently inventory results are produced.</p>"
}
},
"documentation": "<p>Specifies the schedule for generating inventory results.</p>"
},
"IsEnabled": {
"type": "boolean"
},
"IsLatest": {
"type": "boolean"
},
"IsPublic": {
"type": "boolean"
},
"IsTruncated": {
"type": "boolean"
},
"JSONInput": {
"type": "structure",
"members": {
"Type": {
"shape": "JSONType",
"documentation": "<p>The type of JSON. Valid values: Document, Lines.</p>"
}
},
"documentation": "<p>Specifies JSON as object's input serialization format.</p>"
},
"JSONOutput": {
"type": "structure",
"members": {
"RecordDelimiter": {
"shape": "RecordDelimiter",
"documentation": "<p>The value used to separate individual records in the output.</p>"
}
},
"documentation": "<p>Specifies JSON as request's output serialization format.</p>"
},
"JSONType": {
"type": "string",
"enum": [
"DOCUMENT",
"LINES"
]
},
"KMSContext": {
"type": "string"
},
"KeyCount": {
"type": "integer"
},
"KeyMarker": {
"type": "string"
},
"KeyPrefixEquals": {
"type": "string"
},
"LambdaFunctionArn": {
"type": "string"
},
"LambdaFunctionConfiguration": {
"type": "structure",
"required": [
"LambdaFunctionArn",
"Events"
],
"members": {
"Id": {
"shape": "NotificationId"
},
"LambdaFunctionArn": {
"shape": "LambdaFunctionArn",
"documentation": "<p>The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the specified event type occurs.</p>",
"locationName": "CloudFunction"
},
"Events": {
"shape": "EventList",
"documentation": "<p>The Amazon S3 bucket event for which to invoke the AWS Lambda function. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Supported Event Types</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"locationName": "Event"
},
"Filter": {
"shape": "NotificationConfigurationFilter"
}
},
"documentation": "<p>A container for specifying the configuration for AWS Lambda notifications.</p>"
},
"LambdaFunctionConfigurationList": {
"type": "list",
"member": {
"shape": "LambdaFunctionConfiguration"
},
"flattened": true
},
"LastModified": {
"type": "timestamp"
},
"LifecycleConfiguration": {
"type": "structure",
"required": [
"Rules"
],
"members": {
"Rules": {
"shape": "Rules",
"documentation": "<p>Specifies lifecycle configuration rules for an Amazon S3 bucket. </p>",
"locationName": "Rule"
}
},
"documentation": "<p>Container for lifecycle rules. You can add as many as 1000 rules.</p>"
},
"LifecycleExpiration": {
"type": "structure",
"members": {
"Date": {
"shape": "Date",
"documentation": "<p>Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.</p>"
},
"Days": {
"shape": "Days",
"documentation": "<p>Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.</p>"
},
"ExpiredObjectDeleteMarker": {
"shape": "ExpiredObjectDeleteMarker",
"documentation": "<p>Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.</p>"
}
},
"documentation": "<p>Container for the expiration for the lifecycle of the object.</p>"
},
"LifecycleRule": {
"type": "structure",
"required": [
"Status"
],
"members": {
"Expiration": {
"shape": "LifecycleExpiration",
"documentation": "<p>Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.</p>"
},
"ID": {
"shape": "ID",
"documentation": "<p>Unique identifier for the rule. The value cannot be longer than 255 characters.</p>"
},
"Prefix": {
"shape": "Prefix",
"documentation": "<p>Prefix identifying one or more objects to which the rule applies. This is No longer used; use <code>Filter</code> instead.</p>",
"deprecated": true
},
"Filter": {
"shape": "LifecycleRuleFilter"
},
"Status": {
"shape": "ExpirationStatus",
"documentation": "<p>If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.</p>"
},
"Transitions": {
"shape": "TransitionList",
"documentation": "<p>Specifies when an Amazon S3 object transitions to a specified storage class.</p>",
"locationName": "Transition"
},
"NoncurrentVersionTransitions": {
"shape": "NoncurrentVersionTransitionList",
"documentation": "<p> Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime. </p>",
"locationName": "NoncurrentVersionTransition"
},
"NoncurrentVersionExpiration": {
"shape": "NoncurrentVersionExpiration"
},
"AbortIncompleteMultipartUpload": {
"shape": "AbortIncompleteMultipartUpload"
}
},
"documentation": "<p>A lifecycle rule for individual objects in an Amazon S3 bucket.</p>"
},
"LifecycleRuleAndOperator": {
"type": "structure",
"members": {
"Prefix": {
"shape": "Prefix",
"documentation": "<p>Prefix identifying one or more objects to which the rule applies.</p>"
},
"Tags": {
"shape": "TagSet",
"documentation": "<p>All of these tags must exist in the object's tag set in order for the rule to apply.</p>",
"flattened": true,
"locationName": "Tag"
}
},
"documentation": "<p>This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.</p>"
},
"LifecycleRuleFilter": {
"type": "structure",
"members": {
"Prefix": {
"shape": "Prefix",
"documentation": "<p>Prefix identifying one or more objects to which the rule applies.</p>"
},
"Tag": {
"shape": "Tag",
"documentation": "<p>This tag must exist in the object's tag set in order for the rule to apply.</p>"
},
"And": {
"shape": "LifecycleRuleAndOperator"
}
},
"documentation": "<p>The <code>Filter</code> is used to identify objects that a Lifecycle Rule applies to. A <code>Filter</code> must have exactly one of <code>Prefix</code>, <code>Tag</code>, or <code>And</code> specified.</p>"
},
"LifecycleRules": {
"type": "list",
"member": {
"shape": "LifecycleRule"
},
"flattened": true
},
"ListBucketAnalyticsConfigurationsOutput": {
"type": "structure",
"members": {
"IsTruncated": {
"shape": "IsTruncated",
"documentation": "<p>Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.</p>"
},
"ContinuationToken": {
"shape": "Token",
"documentation": "<p>The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request.</p>"
},
"NextContinuationToken": {
"shape": "NextToken",
"documentation": "<p> <code>NextContinuationToken</code> is sent when <code>isTruncated</code> is true, which indicates that there are more analytics configurations to list. The next request must include this <code>NextContinuationToken</code>. The token is obfuscated and is not a usable value.</p>"
},
"AnalyticsConfigurationList": {
"shape": "AnalyticsConfigurationList",
"documentation": "<p>The list of analytics configurations for a bucket.</p>",
"locationName": "AnalyticsConfiguration"
}
}
},
"ListBucketAnalyticsConfigurationsRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket from which analytics configurations are retrieved.</p>",
"location": "uri",
"locationName": "Bucket"
},
"ContinuationToken": {
"shape": "Token",
"documentation": "<p>The ContinuationToken that represents a placeholder from where this request should begin.</p>",
"location": "querystring",
"locationName": "continuation-token"
}
}
},
"ListBucketInventoryConfigurationsOutput": {
"type": "structure",
"members": {
"ContinuationToken": {
"shape": "Token",
"documentation": "<p>If sent in the request, the marker that is used as a starting point for this inventory configuration list response.</p>"
},
"InventoryConfigurationList": {
"shape": "InventoryConfigurationList",
"documentation": "<p>The list of inventory configurations for a bucket.</p>",
"locationName": "InventoryConfiguration"
},
"IsTruncated": {
"shape": "IsTruncated",
"documentation": "<p>Tells whether the returned list of inventory configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken is provided for a subsequent request.</p>"
},
"NextContinuationToken": {
"shape": "NextToken",
"documentation": "<p>The marker used to continue this inventory configuration listing. Use the <code>NextContinuationToken</code> from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.</p>"
}
}
},
"ListBucketInventoryConfigurationsRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket containing the inventory configurations to retrieve.</p>",
"location": "uri",
"locationName": "Bucket"
},
"ContinuationToken": {
"shape": "Token",
"documentation": "<p>The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.</p>",
"location": "querystring",
"locationName": "continuation-token"
}
}
},
"ListBucketMetricsConfigurationsOutput": {
"type": "structure",
"members": {
"IsTruncated": {
"shape": "IsTruncated",
"documentation": "<p>Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.</p>"
},
"ContinuationToken": {
"shape": "Token",
"documentation": "<p>The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request.</p>"
},
"NextContinuationToken": {
"shape": "NextToken",
"documentation": "<p>The marker used to continue a metrics configuration listing that has been truncated. Use the <code>NextContinuationToken</code> from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.</p>"
},
"MetricsConfigurationList": {
"shape": "MetricsConfigurationList",
"documentation": "<p>The list of metrics configurations for a bucket.</p>",
"locationName": "MetricsConfiguration"
}
}
},
"ListBucketMetricsConfigurationsRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket containing the metrics configurations to retrieve.</p>",
"location": "uri",
"locationName": "Bucket"
},
"ContinuationToken": {
"shape": "Token",
"documentation": "<p>The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.</p>",
"location": "querystring",
"locationName": "continuation-token"
}
}
},
"ListBucketsOutput": {
"type": "structure",
"members": {
"Buckets": {
"shape": "Buckets",
"documentation": "<p>The list of buckets owned by the requestor.</p>"
},
"Owner": {
"shape": "Owner",
"documentation": "<p>The owner of the buckets listed.</p>"
}
}
},
"ListMultipartUploadsOutput": {
"type": "structure",
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Name of the bucket to which the multipart upload was initiated.</p>"
},
"KeyMarker": {
"shape": "KeyMarker",
"documentation": "<p>The key at or after which the listing began.</p>"
},
"UploadIdMarker": {
"shape": "UploadIdMarker",
"documentation": "<p>Upload ID after which listing began.</p>"
},
"NextKeyMarker": {
"shape": "NextKeyMarker",
"documentation": "<p>When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.</p>"
},
"Prefix": {
"shape": "Prefix",
"documentation": "<p>When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.</p>"
},
"Delimiter": {
"shape": "Delimiter",
"documentation": "<p>Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.</p>"
},
"NextUploadIdMarker": {
"shape": "NextUploadIdMarker",
"documentation": "<p>When a list is truncated, this element specifies the value that should be used for the <code>upload-id-marker</code> request parameter in a subsequent request.</p>"
},
"MaxUploads": {
"shape": "MaxUploads",
"documentation": "<p>Maximum number of multipart uploads that could have been included in the response.</p>"
},
"IsTruncated": {
"shape": "IsTruncated",
"documentation": "<p>Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.</p>"
},
"Uploads": {
"shape": "MultipartUploadList",
"documentation": "<p>Container for elements related to a particular multipart upload. A response can contain zero or more <code>Upload</code> elements.</p>",
"locationName": "Upload"
},
"CommonPrefixes": {
"shape": "CommonPrefixList",
"documentation": "<p>If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a <code>CommonPrefixes</code> element. The distinct key prefixes are returned in the <code>Prefix</code> child element.</p>"
},
"EncodingType": {
"shape": "EncodingType",
"documentation": "<p>Encoding type used by Amazon S3 to encode object keys in the response.</p> <p>If you specify <code>encoding-type</code> request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:</p> <p> <code>Delimiter</code>, <code>KeyMarker</code>, <code>Prefix</code>, <code>NextKeyMarker</code>, <code>Key</code>.</p>"
}
}
},
"ListMultipartUploadsRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Name of the bucket to which the multipart upload was initiated. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Delimiter": {
"shape": "Delimiter",
"documentation": "<p>Character you use to group keys.</p> <p>All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, <code>CommonPrefixes</code>. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under <code>CommonPrefixes</code> result element are not returned elsewhere in the response.</p>",
"location": "querystring",
"locationName": "delimiter"
},
"EncodingType": {
"shape": "EncodingType",
"location": "querystring",
"locationName": "encoding-type"
},
"KeyMarker": {
"shape": "KeyMarker",
"documentation": "<p>Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.</p> <p>If <code>upload-id-marker</code> is not specified, only the keys lexicographically greater than the specified <code>key-marker</code> will be included in the list.</p> <p>If <code>upload-id-marker</code> is specified, any multipart uploads for a key equal to the <code>key-marker</code> might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified <code>upload-id-marker</code>.</p>",
"location": "querystring",
"locationName": "key-marker"
},
"MaxUploads": {
"shape": "MaxUploads",
"documentation": "<p>Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.</p>",
"location": "querystring",
"locationName": "max-uploads"
},
"Prefix": {
"shape": "Prefix",
"documentation": "<p>Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)</p>",
"location": "querystring",
"locationName": "prefix"
},
"UploadIdMarker": {
"shape": "UploadIdMarker",
"documentation": "<p>Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified <code>upload-id-marker</code>.</p>",
"location": "querystring",
"locationName": "upload-id-marker"
}
}
},
"ListObjectVersionsOutput": {
"type": "structure",
"members": {
"IsTruncated": {
"shape": "IsTruncated",
"documentation": "<p>A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.</p>"
},
"KeyMarker": {
"shape": "KeyMarker",
"documentation": "<p>Marks the last key returned in a truncated response.</p>"
},
"VersionIdMarker": {
"shape": "VersionIdMarker",
"documentation": "<p>Marks the last version of the key returned in a truncated response.</p>"
},
"NextKeyMarker": {
"shape": "NextKeyMarker",
"documentation": "<p>When the number of responses exceeds the value of <code>MaxKeys</code>, <code>NextKeyMarker</code> specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.</p>"
},
"NextVersionIdMarker": {
"shape": "NextVersionIdMarker",
"documentation": "<p>When the number of responses exceeds the value of <code>MaxKeys</code>, <code>NextVersionIdMarker</code> specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.</p>"
},
"Versions": {
"shape": "ObjectVersionList",
"documentation": "<p>Container for version information.</p>",
"locationName": "Version"
},
"DeleteMarkers": {
"shape": "DeleteMarkers",
"documentation": "<p>Container for an object that is a delete marker.</p>",
"locationName": "DeleteMarker"
},
"Name": {
"shape": "BucketName",
"documentation": "<p>Bucket name.</p>"
},
"Prefix": {
"shape": "Prefix",
"documentation": "<p>Selects objects that start with the value supplied by this parameter.</p>"
},
"Delimiter": {
"shape": "Delimiter",
"documentation": "<p>The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in <code>CommonPrefixes</code>. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.</p>"
},
"MaxKeys": {
"shape": "MaxKeys",
"documentation": "<p>Specifies the maximum number of objects to return.</p>"
},
"CommonPrefixes": {
"shape": "CommonPrefixList",
"documentation": "<p>All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.</p>"
},
"EncodingType": {
"shape": "EncodingType",
"documentation": "<p> Encoding type used by Amazon S3 to encode object key names in the XML response.</p> <p>If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:</p> <p> <code>KeyMarker, NextKeyMarker, Prefix, Key</code>, and <code>Delimiter</code>.</p>"
}
}
},
"ListObjectVersionsRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name that contains the objects. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Delimiter": {
"shape": "Delimiter",
"documentation": "<p>A delimiter is a character that you specify to group keys. All keys that contain the same string between the <code>prefix</code> and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.</p>",
"location": "querystring",
"locationName": "delimiter"
},
"EncodingType": {
"shape": "EncodingType",
"location": "querystring",
"locationName": "encoding-type"
},
"KeyMarker": {
"shape": "KeyMarker",
"documentation": "<p>Specifies the key to start with when listing objects in a bucket.</p>",
"location": "querystring",
"locationName": "key-marker"
},
"MaxKeys": {
"shape": "MaxKeys",
"documentation": "<p>Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.</p>",
"location": "querystring",
"locationName": "max-keys"
},
"Prefix": {
"shape": "Prefix",
"documentation": "<p>Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes. </p>",
"location": "querystring",
"locationName": "prefix"
},
"VersionIdMarker": {
"shape": "VersionIdMarker",
"documentation": "<p>Specifies the object version you want to start listing from.</p>",
"location": "querystring",
"locationName": "version-id-marker"
}
}
},
"ListObjectsOutput": {
"type": "structure",
"members": {
"IsTruncated": {
"shape": "IsTruncated",
"documentation": "<p>A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.</p>"
},
"Marker": {
"shape": "Marker",
"documentation": "<p>Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.</p>"
},
"NextMarker": {
"shape": "NextMarker",
"documentation": "<p>When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.</p>"
},
"Contents": {
"shape": "ObjectList",
"documentation": "<p>Metadata about each object returned.</p>"
},
"Name": {
"shape": "BucketName",
"documentation": "<p>Bucket name.</p>"
},
"Prefix": {
"shape": "Prefix",
"documentation": "<p>Keys that begin with the indicated prefix.</p>"
},
"Delimiter": {
"shape": "Delimiter",
"documentation": "<p>Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the <code>CommonPrefixes</code> collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the <code>MaxKeys</code> value.</p>"
},
"MaxKeys": {
"shape": "MaxKeys",
"documentation": "<p>The maximum number of keys returned in the response body.</p>"
},
"CommonPrefixes": {
"shape": "CommonPrefixList",
"documentation": "<p>All of the keys rolled up in a common prefix count as a single return when calculating the number of returns. </p> <p>A response can contain CommonPrefixes only if you specify a delimiter.</p> <p>CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by the delimiter.</p> <p> CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.</p> <p>For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.</p>"
},
"EncodingType": {
"shape": "EncodingType",
"documentation": "<p>Encoding type used by Amazon S3 to encode object keys in the response.</p>"
}
}
},
"ListObjectsRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket containing the objects.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Delimiter": {
"shape": "Delimiter",
"documentation": "<p>A delimiter is a character you use to group keys.</p>",
"location": "querystring",
"locationName": "delimiter"
},
"EncodingType": {
"shape": "EncodingType",
"location": "querystring",
"locationName": "encoding-type"
},
"Marker": {
"shape": "Marker",
"documentation": "<p>Specifies the key to start with when listing objects in a bucket.</p>",
"location": "querystring",
"locationName": "marker"
},
"MaxKeys": {
"shape": "MaxKeys",
"documentation": "<p>Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.</p>",
"location": "querystring",
"locationName": "max-keys"
},
"Prefix": {
"shape": "Prefix",
"documentation": "<p>Limits the response to keys that begin with the specified prefix.</p>",
"location": "querystring",
"locationName": "prefix"
},
"RequestPayer": {
"shape": "RequestPayer",
"documentation": "<p>Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.</p>",
"location": "header",
"locationName": "x-amz-request-payer"
}
}
},
"ListObjectsV2Output": {
"type": "structure",
"members": {
"IsTruncated": {
"shape": "IsTruncated",
"documentation": "<p>Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.</p>"
},
"Contents": {
"shape": "ObjectList",
"documentation": "<p>Metadata about each object returned.</p>"
},
"Name": {
"shape": "BucketName",
"documentation": "<p>Bucket name. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
},
"Prefix": {
"shape": "Prefix",
"documentation": "<p> Keys that begin with the indicated prefix.</p>"
},
"Delimiter": {
"shape": "Delimiter",
"documentation": "<p>Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the <code>MaxKeys</code> value.</p>"
},
"MaxKeys": {
"shape": "MaxKeys",
"documentation": "<p>Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.</p>"
},
"CommonPrefixes": {
"shape": "CommonPrefixList",
"documentation": "<p>All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.</p> <p>A response can contain <code>CommonPrefixes</code> only if you specify a delimiter.</p> <p> <code>CommonPrefixes</code> contains all (if there are any) keys between <code>Prefix</code> and the next occurrence of the string specified by a delimiter.</p> <p> <code>CommonPrefixes</code> lists keys that act like subdirectories in the directory specified by <code>Prefix</code>.</p> <p>For example, if the prefix is <code>notes/</code> and the delimiter is a slash (<code>/</code>) as in <code>notes/summer/july</code>, the common prefix is <code>notes/summer/</code>. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns. </p>"
},
"EncodingType": {
"shape": "EncodingType",
"documentation": "<p>Encoding type used by Amazon S3 to encode object key names in the XML response.</p> <p>If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:</p> <p> <code>Delimiter, Prefix, Key,</code> and <code>StartAfter</code>.</p>"
},
"KeyCount": {
"shape": "KeyCount",
"documentation": "<p>KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys </p>"
},
"ContinuationToken": {
"shape": "Token",
"documentation": "<p> If ContinuationToken was sent with the request, it is included in the response.</p>"
},
"NextContinuationToken": {
"shape": "NextToken",
"documentation": "<p> <code>NextContinuationToken</code> is sent when <code>isTruncated</code> is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this <code>NextContinuationToken</code>. <code>NextContinuationToken</code> is obfuscated and is not a real key</p>"
},
"StartAfter": {
"shape": "StartAfter",
"documentation": "<p>If StartAfter was sent with the request, it is included in the response.</p>"
}
}
},
"ListObjectsV2Request": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Bucket name to list. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Delimiter": {
"shape": "Delimiter",
"documentation": "<p>A delimiter is a character you use to group keys.</p>",
"location": "querystring",
"locationName": "delimiter"
},
"EncodingType": {
"shape": "EncodingType",
"documentation": "<p>Encoding type used by Amazon S3 to encode object keys in the response.</p>",
"location": "querystring",
"locationName": "encoding-type"
},
"MaxKeys": {
"shape": "MaxKeys",
"documentation": "<p>Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.</p>",
"location": "querystring",
"locationName": "max-keys"
},
"Prefix": {
"shape": "Prefix",
"documentation": "<p>Limits the response to keys that begin with the specified prefix.</p>",
"location": "querystring",
"locationName": "prefix"
},
"ContinuationToken": {
"shape": "Token",
"documentation": "<p>ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.</p>",
"location": "querystring",
"locationName": "continuation-token"
},
"FetchOwner": {
"shape": "FetchOwner",
"documentation": "<p>The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true.</p>",
"location": "querystring",
"locationName": "fetch-owner"
},
"StartAfter": {
"shape": "StartAfter",
"documentation": "<p>StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.</p>",
"location": "querystring",
"locationName": "start-after"
},
"RequestPayer": {
"shape": "RequestPayer",
"documentation": "<p>Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.</p>",
"location": "header",
"locationName": "x-amz-request-payer"
}
}
},
"ListPartsOutput": {
"type": "structure",
"members": {
"AbortDate": {
"shape": "AbortDate",
"documentation": "<p>If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config\">Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy</a>.</p> <p>The response will also include the <code>x-amz-abort-rule-id</code> header that will provide the ID of the lifecycle configuration rule that defines this action.</p>",
"location": "header",
"locationName": "x-amz-abort-date"
},
"AbortRuleId": {
"shape": "AbortRuleId",
"documentation": "<p>This header is returned along with the <code>x-amz-abort-date</code> header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.</p>",
"location": "header",
"locationName": "x-amz-abort-rule-id"
},
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Name of the bucket to which the multipart upload was initiated.</p>"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Object key for which the multipart upload was initiated.</p>"
},
"UploadId": {
"shape": "MultipartUploadId",
"documentation": "<p>Upload ID identifying the multipart upload whose parts are being listed.</p>"
},
"PartNumberMarker": {
"shape": "PartNumberMarker",
"documentation": "<p>When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.</p>"
},
"NextPartNumberMarker": {
"shape": "NextPartNumberMarker",
"documentation": "<p>When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.</p>"
},
"MaxParts": {
"shape": "MaxParts",
"documentation": "<p>Maximum number of parts that were allowed in the response.</p>"
},
"IsTruncated": {
"shape": "IsTruncated",
"documentation": "<p> Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.</p>"
},
"Parts": {
"shape": "Parts",
"documentation": "<p> Container for elements related to a particular part. A response can contain zero or more <code>Part</code> elements.</p>",
"locationName": "Part"
},
"Initiator": {
"shape": "Initiator",
"documentation": "<p>Container element that identifies who initiated the multipart upload. If the initiator is an AWS account, this element provides the same information as the <code>Owner</code> element. If the initiator is an IAM User, this element provides the user ARN and display name.</p>"
},
"Owner": {
"shape": "Owner",
"documentation": "<p> Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.</p>"
},
"StorageClass": {
"shape": "StorageClass",
"documentation": "<p>Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.</p>"
},
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
}
}
},
"ListPartsRequest": {
"type": "structure",
"required": [
"Bucket",
"Key",
"UploadId"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Name of the bucket to which the parts are being uploaded. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Object key for which the multipart upload was initiated.</p>",
"location": "uri",
"locationName": "Key"
},
"MaxParts": {
"shape": "MaxParts",
"documentation": "<p>Sets the maximum number of parts to return.</p>",
"location": "querystring",
"locationName": "max-parts"
},
"PartNumberMarker": {
"shape": "PartNumberMarker",
"documentation": "<p>Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.</p>",
"location": "querystring",
"locationName": "part-number-marker"
},
"UploadId": {
"shape": "MultipartUploadId",
"documentation": "<p>Upload ID identifying the multipart upload whose parts are being listed.</p>",
"location": "querystring",
"locationName": "uploadId"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
}
}
},
"Location": {
"type": "string"
},
"LocationPrefix": {
"type": "string"
},
"LoggingEnabled": {
"type": "structure",
"required": [
"TargetBucket",
"TargetPrefix"
],
"members": {
"TargetBucket": {
"shape": "TargetBucket",
"documentation": "<p>Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case, you should choose a different <code>TargetPrefix</code> for each source bucket so that the delivered log files can be distinguished by key.</p>"
},
"TargetGrants": {
"shape": "TargetGrants",
"documentation": "<p>Container for granting information.</p>"
},
"TargetPrefix": {
"shape": "TargetPrefix",
"documentation": "<p>A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.</p>"
}
},
"documentation": "<p>Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html\">PUT Bucket logging</a> in the <i>Amazon Simple Storage Service API Reference</i>.</p>"
},
"MFA": {
"type": "string"
},
"MFADelete": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
]
},
"MFADeleteStatus": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
]
},
"Marker": {
"type": "string"
},
"MaxAgeSeconds": {
"type": "integer"
},
"MaxKeys": {
"type": "integer"
},
"MaxParts": {
"type": "integer"
},
"MaxUploads": {
"type": "integer"
},
"Message": {
"type": "string"
},
"Metadata": {
"type": "map",
"key": {
"shape": "MetadataKey"
},
"value": {
"shape": "MetadataValue"
}
},
"MetadataDirective": {
"type": "string",
"enum": [
"COPY",
"REPLACE"
]
},
"MetadataEntry": {
"type": "structure",
"members": {
"Name": {
"shape": "MetadataKey",
"documentation": "<p>Name of the Object.</p>"
},
"Value": {
"shape": "MetadataValue",
"documentation": "<p>Value of the Object.</p>"
}
},
"documentation": "<p>A metadata key-value pair to store with an object.</p>"
},
"MetadataKey": {
"type": "string"
},
"MetadataValue": {
"type": "string"
},
"Metrics": {
"type": "structure",
"required": [
"Status",
"EventThreshold"
],
"members": {
"Status": {
"shape": "MetricsStatus",
"documentation": "<p> Specifies whether the replication metrics are enabled. </p>"
},
"EventThreshold": {
"shape": "ReplicationTimeValue",
"documentation": "<p> A container specifying the time threshold for emitting the <code>s3:Replication:OperationMissedThreshold</code> event. </p>"
}
},
"documentation": "<p> A container specifying replication metrics-related settings enabling metrics and Amazon S3 events for S3 Replication Time Control (S3 RTC). Must be specified together with a <code>ReplicationTime</code> block. </p>"
},
"MetricsAndOperator": {
"type": "structure",
"members": {
"Prefix": {
"shape": "Prefix",
"documentation": "<p>The prefix used when evaluating an AND predicate.</p>"
},
"Tags": {
"shape": "TagSet",
"documentation": "<p>The list of tags used when evaluating an AND predicate.</p>",
"flattened": true,
"locationName": "Tag"
}
},
"documentation": "<p>A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.</p>"
},
"MetricsConfiguration": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"shape": "MetricsId",
"documentation": "<p>The ID used to identify the metrics configuration.</p>"
},
"Filter": {
"shape": "MetricsFilter",
"documentation": "<p>Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator).</p>"
}
},
"documentation": "<p>Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html\"> PUT Bucket metrics</a> in the <i>Amazon Simple Storage Service API Reference</i>.</p>"
},
"MetricsConfigurationList": {
"type": "list",
"member": {
"shape": "MetricsConfiguration"
},
"flattened": true
},
"MetricsFilter": {
"type": "structure",
"members": {
"Prefix": {
"shape": "Prefix",
"documentation": "<p>The prefix used when evaluating a metrics filter.</p>"
},
"Tag": {
"shape": "Tag",
"documentation": "<p>The tag used when evaluating a metrics filter.</p>"
},
"And": {
"shape": "MetricsAndOperator",
"documentation": "<p>A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.</p>"
}
},
"documentation": "<p>Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator).</p>"
},
"MetricsId": {
"type": "string"
},
"MetricsStatus": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
]
},
"Minutes": {
"type": "integer"
},
"MissingMeta": {
"type": "integer"
},
"MultipartUpload": {
"type": "structure",
"members": {
"UploadId": {
"shape": "MultipartUploadId",
"documentation": "<p>Upload ID that identifies the multipart upload.</p>"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Key of the object for which the multipart upload was initiated.</p>"
},
"Initiated": {
"shape": "Initiated",
"documentation": "<p>Date and time at which the multipart upload was initiated.</p>"
},
"StorageClass": {
"shape": "StorageClass",
"documentation": "<p>The class of storage used to store the object.</p>"
},
"Owner": {
"shape": "Owner",
"documentation": "<p>Specifies the owner of the object that is part of the multipart upload. </p>"
},
"Initiator": {
"shape": "Initiator",
"documentation": "<p>Identifies who initiated the multipart upload.</p>"
}
},
"documentation": "<p>Container for the <code>MultipartUpload</code> for the Amazon S3 object.</p>"
},
"MultipartUploadId": {
"type": "string"
},
"MultipartUploadList": {
"type": "list",
"member": {
"shape": "MultipartUpload"
},
"flattened": true
},
"NextKeyMarker": {
"type": "string"
},
"NextMarker": {
"type": "string"
},
"NextPartNumberMarker": {
"type": "integer"
},
"NextToken": {
"type": "string"
},
"NextUploadIdMarker": {
"type": "string"
},
"NextVersionIdMarker": {
"type": "string"
},
"NoncurrentVersionExpiration": {
"type": "structure",
"members": {
"NoncurrentDays": {
"shape": "Days",
"documentation": "<p>Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations\">How Amazon S3 Calculates When an Object Became Noncurrent</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
}
},
"documentation": "<p>Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.</p>"
},
"NoncurrentVersionTransition": {
"type": "structure",
"members": {
"NoncurrentDays": {
"shape": "Days",
"documentation": "<p>Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations\">How Amazon S3 Calculates How Long an Object Has Been Noncurrent</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
},
"StorageClass": {
"shape": "TransitionStorageClass",
"documentation": "<p>The class of storage used to store the object.</p>"
}
},
"documentation": "<p>Container for the transition rule that describes when noncurrent objects transition to the <code>STANDARD_IA</code>, <code>ONEZONE_IA</code>, <code>INTELLIGENT_TIERING</code>, <code>GLACIER</code>, or <code>DEEP_ARCHIVE</code> storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the <code>STANDARD_IA</code>, <code>ONEZONE_IA</code>, <code>INTELLIGENT_TIERING</code>, <code>GLACIER</code>, or <code>DEEP_ARCHIVE</code> storage class at a specific period in the object's lifetime.</p>"
},
"NoncurrentVersionTransitionList": {
"type": "list",
"member": {
"shape": "NoncurrentVersionTransition"
},
"flattened": true
},
"NotificationConfiguration": {
"type": "structure",
"members": {
"TopicConfigurations": {
"shape": "TopicConfigurationList",
"documentation": "<p>The topic to which notifications are sent and the events for which notifications are generated.</p>",
"locationName": "TopicConfiguration"
},
"QueueConfigurations": {
"shape": "QueueConfigurationList",
"documentation": "<p>The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.</p>",
"locationName": "QueueConfiguration"
},
"LambdaFunctionConfigurations": {
"shape": "LambdaFunctionConfigurationList",
"documentation": "<p>Describes the AWS Lambda functions to invoke and the events for which to invoke them.</p>",
"locationName": "CloudFunctionConfiguration"
}
},
"documentation": "<p>A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.</p>"
},
"NotificationConfigurationDeprecated": {
"type": "structure",
"members": {
"TopicConfiguration": {
"shape": "TopicConfigurationDeprecated",
"documentation": "<p>This data type is deprecated. A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events. </p>"
},
"QueueConfiguration": {
"shape": "QueueConfigurationDeprecated",
"documentation": "<p>This data type is deprecated. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events. </p>"
},
"CloudFunctionConfiguration": {
"shape": "CloudFunctionConfiguration",
"documentation": "<p>Container for specifying the AWS Lambda notification configuration.</p>"
}
}
},
"NotificationConfigurationFilter": {
"type": "structure",
"members": {
"Key": {
"shape": "S3KeyFilter",
"locationName": "S3Key"
}
},
"documentation": "<p>Specifies object key name filtering rules. For information about key name filtering, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Configuring Event Notifications</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
},
"NotificationId": {
"type": "string",
"documentation": "<p>An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.</p>"
},
"Object": {
"type": "structure",
"members": {
"Key": {
"shape": "ObjectKey",
"documentation": "<p>The name that you assign to an object. You use the object key to retrieve the object.</p>"
},
"LastModified": {
"shape": "LastModified",
"documentation": "<p>The date the Object was Last Modified</p>"
},
"ETag": {
"shape": "ETag",
"documentation": "<p>The entity tag is an MD5 hash of the object. ETag reflects only changes to the contents of an object, not its metadata.</p>"
},
"Size": {
"shape": "Size",
"documentation": "<p>Size in bytes of the object</p>"
},
"StorageClass": {
"shape": "ObjectStorageClass",
"documentation": "<p>The class of storage used to store the object.</p>"
},
"Owner": {
"shape": "Owner",
"documentation": "<p>The owner of the object</p>"
}
},
"documentation": "<p>An object consists of data and its descriptive metadata.</p>"
},
"ObjectCannedACL": {
"type": "string",
"enum": [
"private",
"public-read",
"public-read-write",
"authenticated-read",
"aws-exec-read",
"bucket-owner-read",
"bucket-owner-full-control"
]
},
"ObjectIdentifier": {
"type": "structure",
"required": [
"Key"
],
"members": {
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Key name of the object to delete.</p>"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>VersionId for the specific version of the object to delete.</p>"
}
},
"documentation": "<p>Object Identifier is unique value to identify objects.</p>"
},
"ObjectIdentifierList": {
"type": "list",
"member": {
"shape": "ObjectIdentifier"
},
"flattened": true
},
"ObjectKey": {
"type": "string",
"min": 1
},
"ObjectList": {
"type": "list",
"member": {
"shape": "Object"
},
"flattened": true
},
"ObjectLockConfiguration": {
"type": "structure",
"members": {
"ObjectLockEnabled": {
"shape": "ObjectLockEnabled",
"documentation": "<p>Indicates whether this bucket has an Object Lock configuration enabled.</p>"
},
"Rule": {
"shape": "ObjectLockRule",
"documentation": "<p>The Object Lock rule in place for the specified object.</p>"
}
},
"documentation": "<p>The container element for Object Lock configuration parameters.</p>"
},
"ObjectLockEnabled": {
"type": "string",
"enum": [
"Enabled"
]
},
"ObjectLockEnabledForBucket": {
"type": "boolean"
},
"ObjectLockLegalHold": {
"type": "structure",
"members": {
"Status": {
"shape": "ObjectLockLegalHoldStatus",
"documentation": "<p>Indicates whether the specified object has a Legal Hold in place.</p>"
}
},
"documentation": "<p>A Legal Hold configuration for an object.</p>"
},
"ObjectLockLegalHoldStatus": {
"type": "string",
"enum": [
"ON",
"OFF"
]
},
"ObjectLockMode": {
"type": "string",
"enum": [
"GOVERNANCE",
"COMPLIANCE"
]
},
"ObjectLockRetainUntilDate": {
"type": "timestamp",
"timestampFormat": "iso8601"
},
"ObjectLockRetention": {
"type": "structure",
"members": {
"Mode": {
"shape": "ObjectLockRetentionMode",
"documentation": "<p>Indicates the Retention mode for the specified object.</p>"
},
"RetainUntilDate": {
"shape": "Date",
"documentation": "<p>The date on which this Object Lock Retention will expire.</p>"
}
},
"documentation": "<p>A Retention configuration for an object.</p>"
},
"ObjectLockRetentionMode": {
"type": "string",
"enum": [
"GOVERNANCE",
"COMPLIANCE"
]
},
"ObjectLockRule": {
"type": "structure",
"members": {
"DefaultRetention": {
"shape": "DefaultRetention",
"documentation": "<p>The default retention period that you want to apply to new objects placed in the specified bucket.</p>"
}
},
"documentation": "<p>The container element for an Object Lock rule.</p>"
},
"ObjectLockToken": {
"type": "string"
},
"ObjectStorageClass": {
"type": "string",
"enum": [
"STANDARD",
"REDUCED_REDUNDANCY",
"GLACIER",
"STANDARD_IA",
"ONEZONE_IA",
"INTELLIGENT_TIERING",
"DEEP_ARCHIVE"
]
},
"ObjectVersion": {
"type": "structure",
"members": {
"ETag": {
"shape": "ETag",
"documentation": "<p>The entity tag is an MD5 hash of that version of the object.</p>"
},
"Size": {
"shape": "Size",
"documentation": "<p>Size in bytes of the object.</p>"
},
"StorageClass": {
"shape": "ObjectVersionStorageClass",
"documentation": "<p>The class of storage used to store the object.</p>"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>The object key.</p>"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>Version ID of an object.</p>"
},
"IsLatest": {
"shape": "IsLatest",
"documentation": "<p>Specifies whether the object is (true) or is not (false) the latest version of an object.</p>"
},
"LastModified": {
"shape": "LastModified",
"documentation": "<p>Date and time the object was last modified.</p>"
},
"Owner": {
"shape": "Owner",
"documentation": "<p>Specifies the owner of the object.</p>"
}
},
"documentation": "<p>The version of an object.</p>"
},
"ObjectVersionId": {
"type": "string"
},
"ObjectVersionList": {
"type": "list",
"member": {
"shape": "ObjectVersion"
},
"flattened": true
},
"ObjectVersionStorageClass": {
"type": "string",
"enum": [
"STANDARD"
]
},
"OutputLocation": {
"type": "structure",
"members": {
"S3": {
"shape": "S3Location",
"documentation": "<p>Describes an S3 location that will receive the results of the restore request.</p>"
}
},
"documentation": "<p>Describes the location where the restore job's output is stored.</p>"
},
"OutputSerialization": {
"type": "structure",
"members": {
"CSV": {
"shape": "CSVOutput",
"documentation": "<p>Describes the serialization of CSV-encoded Select results.</p>"
},
"JSON": {
"shape": "JSONOutput",
"documentation": "<p>Specifies JSON as request's output serialization format.</p>"
}
},
"documentation": "<p>Describes how results of the Select job are serialized.</p>"
},
"Owner": {
"type": "structure",
"members": {
"DisplayName": {
"shape": "DisplayName",
"documentation": "<p>Container for the display name of the owner.</p>"
},
"ID": {
"shape": "ID",
"documentation": "<p>Container for the ID of the owner.</p>"
}
},
"documentation": "<p>Container for the owner's display name and ID.</p>"
},
"OwnerOverride": {
"type": "string",
"enum": [
"Destination"
]
},
"ParquetInput": {
"type": "structure",
"members": {},
"documentation": "<p>Container for Parquet.</p>"
},
"Part": {
"type": "structure",
"members": {
"PartNumber": {
"shape": "PartNumber",
"documentation": "<p>Part number identifying the part. This is a positive integer between 1 and 10,000.</p>"
},
"LastModified": {
"shape": "LastModified",
"documentation": "<p>Date and time at which the part was uploaded.</p>"
},
"ETag": {
"shape": "ETag",
"documentation": "<p>Entity tag returned when the part was uploaded.</p>"
},
"Size": {
"shape": "Size",
"documentation": "<p>Size in bytes of the uploaded part data.</p>"
}
},
"documentation": "<p>Container for elements related to a part.</p>"
},
"PartNumber": {
"type": "integer"
},
"PartNumberMarker": {
"type": "integer"
},
"Parts": {
"type": "list",
"member": {
"shape": "Part"
},
"flattened": true
},
"PartsCount": {
"type": "integer"
},
"Payer": {
"type": "string",
"enum": [
"Requester",
"BucketOwner"
]
},
"Permission": {
"type": "string",
"enum": [
"FULL_CONTROL",
"WRITE",
"WRITE_ACP",
"READ",
"READ_ACP"
]
},
"Policy": {
"type": "string"
},
"PolicyStatus": {
"type": "structure",
"members": {
"IsPublic": {
"shape": "IsPublic",
"documentation": "<p>The policy status for this bucket. <code>TRUE</code> indicates that this bucket is public. <code>FALSE</code> indicates that the bucket is not public.</p>",
"locationName": "IsPublic"
}
},
"documentation": "<p>The container element for a bucket's policy status.</p>"
},
"Prefix": {
"type": "string"
},
"Priority": {
"type": "integer"
},
"Progress": {
"type": "structure",
"members": {
"BytesScanned": {
"shape": "BytesScanned",
"documentation": "<p>The current number of object bytes scanned.</p>"
},
"BytesProcessed": {
"shape": "BytesProcessed",
"documentation": "<p>The current number of uncompressed object bytes processed.</p>"
},
"BytesReturned": {
"shape": "BytesReturned",
"documentation": "<p>The current number of bytes of records payload data returned.</p>"
}
},
"documentation": "<p>This data type contains information about progress of an operation.</p>"
},
"ProgressEvent": {
"type": "structure",
"members": {
"Details": {
"shape": "Progress",
"documentation": "<p>The Progress event details.</p>",
"eventpayload": true
}
},
"documentation": "<p>This data type contains information about the progress event of an operation.</p>",
"event": true
},
"Protocol": {
"type": "string",
"enum": [
"http",
"https"
]
},
"PublicAccessBlockConfiguration": {
"type": "structure",
"members": {
"BlockPublicAcls": {
"shape": "Setting",
"documentation": "<p>Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to <code>TRUE</code> causes the following behavior:</p> <ul> <li> <p>PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.</p> </li> <li> <p>PUT Object calls fail if the request includes a public ACL.</p> </li> <li> <p>PUT Bucket calls fail if the request includes a public ACL.</p> </li> </ul> <p>Enabling this setting doesn't affect existing policies or ACLs.</p>",
"locationName": "BlockPublicAcls"
},
"IgnorePublicAcls": {
"shape": "Setting",
"documentation": "<p>Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to <code>TRUE</code> causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.</p> <p>Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.</p>",
"locationName": "IgnorePublicAcls"
},
"BlockPublicPolicy": {
"shape": "Setting",
"documentation": "<p>Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to <code>TRUE</code> causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. </p> <p>Enabling this setting doesn't affect existing bucket policies.</p>",
"locationName": "BlockPublicPolicy"
},
"RestrictPublicBuckets": {
"shape": "Setting",
"documentation": "<p>Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to <code>TRUE</code> restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy.</p> <p>Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.</p>",
"locationName": "RestrictPublicBuckets"
}
},
"documentation": "<p>The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status\">The Meaning of \"Public\"</a> in the <i>Amazon Simple Storage Service Developer Guide</i>. </p>"
},
"PutBucketAccelerateConfigurationRequest": {
"type": "structure",
"required": [
"Bucket",
"AccelerateConfiguration"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Name of the bucket for which the accelerate configuration is set.</p>",
"location": "uri",
"locationName": "Bucket"
},
"AccelerateConfiguration": {
"shape": "AccelerateConfiguration",
"documentation": "<p>Container for setting the transfer acceleration state.</p>",
"locationName": "AccelerateConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
}
},
"payload": "AccelerateConfiguration"
},
"PutBucketAclRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"ACL": {
"shape": "BucketCannedACL",
"documentation": "<p>The canned ACL to apply to the bucket.</p>",
"location": "header",
"locationName": "x-amz-acl"
},
"AccessControlPolicy": {
"shape": "AccessControlPolicy",
"documentation": "<p>Contains the elements that set the ACL permissions for an object per grantee.</p>",
"locationName": "AccessControlPolicy",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
},
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket to which to apply the ACL.</p>",
"location": "uri",
"locationName": "Bucket"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864.</a> </p>",
"location": "header",
"locationName": "Content-MD5"
},
"GrantFullControl": {
"shape": "GrantFullControl",
"documentation": "<p>Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.</p>",
"location": "header",
"locationName": "x-amz-grant-full-control"
},
"GrantRead": {
"shape": "GrantRead",
"documentation": "<p>Allows grantee to list the objects in the bucket.</p>",
"location": "header",
"locationName": "x-amz-grant-read"
},
"GrantReadACP": {
"shape": "GrantReadACP",
"documentation": "<p>Allows grantee to read the bucket ACL.</p>",
"location": "header",
"locationName": "x-amz-grant-read-acp"
},
"GrantWrite": {
"shape": "GrantWrite",
"documentation": "<p>Allows grantee to create, overwrite, and delete any object in the bucket.</p>",
"location": "header",
"locationName": "x-amz-grant-write"
},
"GrantWriteACP": {
"shape": "GrantWriteACP",
"documentation": "<p>Allows grantee to write the ACL for the applicable bucket.</p>",
"location": "header",
"locationName": "x-amz-grant-write-acp"
}
},
"payload": "AccessControlPolicy"
},
"PutBucketAnalyticsConfigurationRequest": {
"type": "structure",
"required": [
"Bucket",
"Id",
"AnalyticsConfiguration"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket to which an analytics configuration is stored.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Id": {
"shape": "AnalyticsId",
"documentation": "<p>The ID that identifies the analytics configuration.</p>",
"location": "querystring",
"locationName": "id"
},
"AnalyticsConfiguration": {
"shape": "AnalyticsConfiguration",
"documentation": "<p>The configuration and any analyses for the analytics filter.</p>",
"locationName": "AnalyticsConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
}
},
"payload": "AnalyticsConfiguration"
},
"PutBucketCorsRequest": {
"type": "structure",
"required": [
"Bucket",
"CORSConfiguration"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Specifies the bucket impacted by the <code>cors</code>configuration.</p>",
"location": "uri",
"locationName": "Bucket"
},
"CORSConfiguration": {
"shape": "CORSConfiguration",
"documentation": "<p>Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev//cors.html\">Enabling Cross-Origin Resource Sharing</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"locationName": "CORSConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864.</a> </p>",
"location": "header",
"locationName": "Content-MD5"
}
},
"payload": "CORSConfiguration"
},
"PutBucketEncryptionRequest": {
"type": "structure",
"required": [
"Bucket",
"ServerSideEncryptionConfiguration"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or customer master keys stored in AWS KMS (SSE-KMS). For information about the Amazon S3 default encryption feature, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html\">Amazon S3 Default Bucket Encryption</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. This parameter is auto-populated when using the command from the CLI.</p>",
"location": "header",
"locationName": "Content-MD5"
},
"ServerSideEncryptionConfiguration": {
"shape": "ServerSideEncryptionConfiguration",
"locationName": "ServerSideEncryptionConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
}
},
"payload": "ServerSideEncryptionConfiguration"
},
"PutBucketInventoryConfigurationRequest": {
"type": "structure",
"required": [
"Bucket",
"Id",
"InventoryConfiguration"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket where the inventory configuration will be stored.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Id": {
"shape": "InventoryId",
"documentation": "<p>The ID used to identify the inventory configuration.</p>",
"location": "querystring",
"locationName": "id"
},
"InventoryConfiguration": {
"shape": "InventoryConfiguration",
"documentation": "<p>Specifies the inventory configuration.</p>",
"locationName": "InventoryConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
}
},
"payload": "InventoryConfiguration"
},
"PutBucketLifecycleConfigurationRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket for which to set the configuration.</p>",
"location": "uri",
"locationName": "Bucket"
},
"LifecycleConfiguration": {
"shape": "BucketLifecycleConfiguration",
"documentation": "<p>Container for lifecycle rules. You can add as many as 1,000 rules.</p>",
"locationName": "LifecycleConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
}
},
"payload": "LifecycleConfiguration"
},
"PutBucketLifecycleRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p/>",
"location": "uri",
"locationName": "Bucket"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p/>",
"location": "header",
"locationName": "Content-MD5"
},
"LifecycleConfiguration": {
"shape": "LifecycleConfiguration",
"documentation": "<p/>",
"locationName": "LifecycleConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
}
},
"payload": "LifecycleConfiguration"
},
"PutBucketLoggingRequest": {
"type": "structure",
"required": [
"Bucket",
"BucketLoggingStatus"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket for which to set the logging parameters.</p>",
"location": "uri",
"locationName": "Bucket"
},
"BucketLoggingStatus": {
"shape": "BucketLoggingStatus",
"documentation": "<p>Container for logging status information.</p>",
"locationName": "BucketLoggingStatus",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The MD5 hash of the <code>PutBucketLogging</code> request body.</p>",
"location": "header",
"locationName": "Content-MD5"
}
},
"payload": "BucketLoggingStatus"
},
"PutBucketMetricsConfigurationRequest": {
"type": "structure",
"required": [
"Bucket",
"Id",
"MetricsConfiguration"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket for which the metrics configuration is set.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Id": {
"shape": "MetricsId",
"documentation": "<p>The ID used to identify the metrics configuration.</p>",
"location": "querystring",
"locationName": "id"
},
"MetricsConfiguration": {
"shape": "MetricsConfiguration",
"documentation": "<p>Specifies the metrics configuration.</p>",
"locationName": "MetricsConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
}
},
"payload": "MetricsConfiguration"
},
"PutBucketNotificationConfigurationRequest": {
"type": "structure",
"required": [
"Bucket",
"NotificationConfiguration"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket.</p>",
"location": "uri",
"locationName": "Bucket"
},
"NotificationConfiguration": {
"shape": "NotificationConfiguration",
"locationName": "NotificationConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
}
},
"payload": "NotificationConfiguration"
},
"PutBucketNotificationRequest": {
"type": "structure",
"required": [
"Bucket",
"NotificationConfiguration"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket.</p>",
"location": "uri",
"locationName": "Bucket"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The MD5 hash of the <code>PutPublicAccessBlock</code> request body.</p>",
"location": "header",
"locationName": "Content-MD5"
},
"NotificationConfiguration": {
"shape": "NotificationConfigurationDeprecated",
"documentation": "<p>The container for the configuration.</p>",
"locationName": "NotificationConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
}
},
"payload": "NotificationConfiguration"
},
"PutBucketPolicyRequest": {
"type": "structure",
"required": [
"Bucket",
"Policy"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket.</p>",
"location": "uri",
"locationName": "Bucket"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The MD5 hash of the request body.</p>",
"location": "header",
"locationName": "Content-MD5"
},
"ConfirmRemoveSelfBucketAccess": {
"shape": "ConfirmRemoveSelfBucketAccess",
"documentation": "<p>Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.</p>",
"location": "header",
"locationName": "x-amz-confirm-remove-self-bucket-access"
},
"Policy": {
"shape": "Policy",
"documentation": "<p>The bucket policy as a JSON document.</p>"
}
},
"payload": "Policy"
},
"PutBucketReplicationRequest": {
"type": "structure",
"required": [
"Bucket",
"ReplicationConfiguration"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket</p>",
"location": "uri",
"locationName": "Bucket"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864</a>.</p>",
"location": "header",
"locationName": "Content-MD5"
},
"ReplicationConfiguration": {
"shape": "ReplicationConfiguration",
"locationName": "ReplicationConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
},
"Token": {
"shape": "ObjectLockToken",
"documentation": "<p/>",
"location": "header",
"locationName": "x-amz-bucket-object-lock-token"
}
},
"payload": "ReplicationConfiguration"
},
"PutBucketRequestPaymentRequest": {
"type": "structure",
"required": [
"Bucket",
"RequestPaymentConfiguration"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name.</p>",
"location": "uri",
"locationName": "Bucket"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864</a>.</p>",
"location": "header",
"locationName": "Content-MD5"
},
"RequestPaymentConfiguration": {
"shape": "RequestPaymentConfiguration",
"documentation": "<p>Container for Payer.</p>",
"locationName": "RequestPaymentConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
}
},
"payload": "RequestPaymentConfiguration"
},
"PutBucketTaggingRequest": {
"type": "structure",
"required": [
"Bucket",
"Tagging"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name.</p>",
"location": "uri",
"locationName": "Bucket"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864</a>.</p>",
"location": "header",
"locationName": "Content-MD5"
},
"Tagging": {
"shape": "Tagging",
"documentation": "<p>Container for the <code>TagSet</code> and <code>Tag</code> elements.</p>",
"locationName": "Tagging",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
}
},
"payload": "Tagging"
},
"PutBucketVersioningRequest": {
"type": "structure",
"required": [
"Bucket",
"VersioningConfiguration"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name.</p>",
"location": "uri",
"locationName": "Bucket"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864</a>.</p>",
"location": "header",
"locationName": "Content-MD5"
},
"MFA": {
"shape": "MFA",
"documentation": "<p>The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.</p>",
"location": "header",
"locationName": "x-amz-mfa"
},
"VersioningConfiguration": {
"shape": "VersioningConfiguration",
"documentation": "<p>Container for setting the versioning state.</p>",
"locationName": "VersioningConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
}
},
"payload": "VersioningConfiguration"
},
"PutBucketWebsiteRequest": {
"type": "structure",
"required": [
"Bucket",
"WebsiteConfiguration"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name.</p>",
"location": "uri",
"locationName": "Bucket"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864</a>.</p>",
"location": "header",
"locationName": "Content-MD5"
},
"WebsiteConfiguration": {
"shape": "WebsiteConfiguration",
"documentation": "<p>Container for the request.</p>",
"locationName": "WebsiteConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
}
},
"payload": "WebsiteConfiguration"
},
"PutObjectAclOutput": {
"type": "structure",
"members": {
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
}
}
},
"PutObjectAclRequest": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"ACL": {
"shape": "ObjectCannedACL",
"documentation": "<p>The canned ACL to apply to the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p>",
"location": "header",
"locationName": "x-amz-acl"
},
"AccessControlPolicy": {
"shape": "AccessControlPolicy",
"documentation": "<p>Contains the elements that set the ACL permissions for an object per grantee.</p>",
"locationName": "AccessControlPolicy",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
},
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name that contains the object to which you want to attach the ACL. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864.></a> </p>",
"location": "header",
"locationName": "Content-MD5"
},
"GrantFullControl": {
"shape": "GrantFullControl",
"documentation": "<p>Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.</p>",
"location": "header",
"locationName": "x-amz-grant-full-control"
},
"GrantRead": {
"shape": "GrantRead",
"documentation": "<p>Allows grantee to list the objects in the bucket.</p>",
"location": "header",
"locationName": "x-amz-grant-read"
},
"GrantReadACP": {
"shape": "GrantReadACP",
"documentation": "<p>Allows grantee to read the bucket ACL.</p>",
"location": "header",
"locationName": "x-amz-grant-read-acp"
},
"GrantWrite": {
"shape": "GrantWrite",
"documentation": "<p>Allows grantee to create, overwrite, and delete any object in the bucket.</p>",
"location": "header",
"locationName": "x-amz-grant-write"
},
"GrantWriteACP": {
"shape": "GrantWriteACP",
"documentation": "<p>Allows grantee to write the ACL for the applicable bucket.</p>",
"location": "header",
"locationName": "x-amz-grant-write-acp"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Key for which the PUT operation was initiated.</p>",
"location": "uri",
"locationName": "Key"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>VersionId used to reference a specific version of the object.</p>",
"location": "querystring",
"locationName": "versionId"
}
},
"payload": "AccessControlPolicy"
},
"PutObjectLegalHoldOutput": {
"type": "structure",
"members": {
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
}
}
},
"PutObjectLegalHoldRequest": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name containing the object that you want to place a Legal Hold on. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>The key name for the object that you want to place a Legal Hold on.</p>",
"location": "uri",
"locationName": "Key"
},
"LegalHold": {
"shape": "ObjectLockLegalHold",
"documentation": "<p>Container element for the Legal Hold configuration you want to apply to the specified object.</p>",
"locationName": "LegalHold",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>The version ID of the object that you want to place a Legal Hold on.</p>",
"location": "querystring",
"locationName": "versionId"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The MD5 hash for the request body.</p>",
"location": "header",
"locationName": "Content-MD5"
}
},
"payload": "LegalHold"
},
"PutObjectLockConfigurationOutput": {
"type": "structure",
"members": {
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
}
}
},
"PutObjectLockConfigurationRequest": {
"type": "structure",
"required": [
"Bucket"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket whose Object Lock configuration you want to create or replace.</p>",
"location": "uri",
"locationName": "Bucket"
},
"ObjectLockConfiguration": {
"shape": "ObjectLockConfiguration",
"documentation": "<p>The Object Lock configuration that you want to apply to the specified bucket.</p>",
"locationName": "ObjectLockConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
},
"Token": {
"shape": "ObjectLockToken",
"documentation": "<p>A token to allow Object Lock to be enabled for an existing bucket.</p>",
"location": "header",
"locationName": "x-amz-bucket-object-lock-token"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The MD5 hash for the request body.</p>",
"location": "header",
"locationName": "Content-MD5"
}
},
"payload": "ObjectLockConfiguration"
},
"PutObjectOutput": {
"type": "structure",
"members": {
"Expiration": {
"shape": "Expiration",
"documentation": "<p> If the expiration is configured for the object (see <a>PutBucketLifecycleConfiguration</a>), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL encoded.</p>",
"location": "header",
"locationName": "x-amz-expiration"
},
"ETag": {
"shape": "ETag",
"documentation": "<p>Entity tag for the uploaded object.</p>",
"location": "header",
"locationName": "ETag"
},
"ServerSideEncryption": {
"shape": "ServerSideEncryption",
"documentation": "<p>If you specified server-side encryption either with an AWS KMS customer master key (CMK) or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>Version of the object.</p>",
"location": "header",
"locationName": "x-amz-version-id"
},
"SSECustomerAlgorithm": {
"shape": "SSECustomerAlgorithm",
"documentation": "<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5": {
"shape": "SSECustomerKeyMD5",
"documentation": "<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId": {
"shape": "SSEKMSKeyId",
"documentation": "<p>If <code>x-amz-server-side-encryption</code> is present and has the value of <code>aws:kms</code>, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object. </p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
},
"SSEKMSEncryptionContext": {
"shape": "SSEKMSEncryptionContext",
"documentation": "<p>If present, specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-context"
},
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
}
}
},
"PutObjectRequest": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"ACL": {
"shape": "ObjectCannedACL",
"documentation": "<p>The canned ACL to apply to the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p>",
"location": "header",
"locationName": "x-amz-acl"
},
"Body": {
"shape": "Body",
"documentation": "<p>Object data.</p>",
"streaming": true
},
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Bucket name to which the PUT operation was initiated. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"CacheControl": {
"shape": "CacheControl",
"documentation": "<p> Can be used to specify caching behavior along the request/reply chain. For more information, see <a href=\"http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9\">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9</a>.</p>",
"location": "header",
"locationName": "Cache-Control"
},
"ContentDisposition": {
"shape": "ContentDisposition",
"documentation": "<p>Specifies presentational information for the object. For more information, see <a href=\"http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1\">http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1</a>.</p>",
"location": "header",
"locationName": "Content-Disposition"
},
"ContentEncoding": {
"shape": "ContentEncoding",
"documentation": "<p>Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see <a href=\"http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11\">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11</a>.</p>",
"location": "header",
"locationName": "Content-Encoding"
},
"ContentLanguage": {
"shape": "ContentLanguage",
"documentation": "<p>The language the content is in.</p>",
"location": "header",
"locationName": "Content-Language"
},
"ContentLength": {
"shape": "ContentLength",
"documentation": "<p>Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see <a href=\"http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13\">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13</a>.</p>",
"location": "header",
"locationName": "Content-Length"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">REST Authentication</a>.</p>",
"location": "header",
"locationName": "Content-MD5"
},
"ContentType": {
"shape": "ContentType",
"documentation": "<p>A standard MIME type describing the format of the contents. For more information, see <a href=\"http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17\">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17</a>.</p>",
"location": "header",
"locationName": "Content-Type"
},
"Expires": {
"shape": "Expires",
"documentation": "<p>The date and time at which the object is no longer cacheable. For more information, see <a href=\"http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21\">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21</a>.</p>",
"location": "header",
"locationName": "Expires"
},
"GrantFullControl": {
"shape": "GrantFullControl",
"documentation": "<p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p>",
"location": "header",
"locationName": "x-amz-grant-full-control"
},
"GrantRead": {
"shape": "GrantRead",
"documentation": "<p>Allows grantee to read the object data and its metadata.</p>",
"location": "header",
"locationName": "x-amz-grant-read"
},
"GrantReadACP": {
"shape": "GrantReadACP",
"documentation": "<p>Allows grantee to read the object ACL.</p>",
"location": "header",
"locationName": "x-amz-grant-read-acp"
},
"GrantWriteACP": {
"shape": "GrantWriteACP",
"documentation": "<p>Allows grantee to write the ACL for the applicable object.</p>",
"location": "header",
"locationName": "x-amz-grant-write-acp"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Object key for which the PUT operation was initiated.</p>",
"location": "uri",
"locationName": "Key"
},
"Metadata": {
"shape": "Metadata",
"documentation": "<p>A map of metadata to store with the object in S3.</p>",
"location": "headers",
"locationName": "x-amz-meta-"
},
"ServerSideEncryption": {
"shape": "ServerSideEncryption",
"documentation": "<p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"StorageClass": {
"shape": "StorageClass",
"documentation": "<p>If you don't specify, Standard is the default storage class. Amazon S3 supports other storage classes.</p>",
"location": "header",
"locationName": "x-amz-storage-class"
},
"WebsiteRedirectLocation": {
"shape": "WebsiteRedirectLocation",
"documentation": "<p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html\">Object Key and Metadata</a>.</p> <p>In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:</p> <p> <code>x-amz-website-redirect-location: /anotherPage.html</code> </p> <p>In the following example, the request header sets the object redirect to another website:</p> <p> <code>x-amz-website-redirect-location: http://www.example.com/</code> </p> <p>For more information about website hosting in Amazon S3, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html\">Hosting Websites on Amazon S3</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html\">How to Configure Website Page Redirects</a>. </p>",
"location": "header",
"locationName": "x-amz-website-redirect-location"
},
"SSECustomerAlgorithm": {
"shape": "SSECustomerAlgorithm",
"documentation": "<p>Specifies the algorithm to use to when encrypting the object (for example, AES256).</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey": {
"shape": "SSECustomerKey",
"documentation": "<p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5": {
"shape": "SSECustomerKeyMD5",
"documentation": "<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId": {
"shape": "SSEKMSKeyId",
"documentation": "<p>If <code>x-amz-server-side-encryption</code> is present and has the value of <code>aws:kms</code>, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object.</p> <p> If the value of <code>x-amz-server-side-encryption</code> is <code>aws:kms</code>, this header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but do not provide<code> x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the AWS managed CMK in AWS to protect the data.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
},
"SSEKMSEncryptionContext": {
"shape": "SSEKMSEncryptionContext",
"documentation": "<p>Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-context"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
},
"Tagging": {
"shape": "TaggingHeader",
"documentation": "<p>The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, \"Key1=Value1\")</p>",
"location": "header",
"locationName": "x-amz-tagging"
},
"ObjectLockMode": {
"shape": "ObjectLockMode",
"documentation": "<p>The Object Lock mode that you want to apply to this object.</p>",
"location": "header",
"locationName": "x-amz-object-lock-mode"
},
"ObjectLockRetainUntilDate": {
"shape": "ObjectLockRetainUntilDate",
"documentation": "<p>The date and time when you want this object's Object Lock to expire.</p>",
"location": "header",
"locationName": "x-amz-object-lock-retain-until-date"
},
"ObjectLockLegalHoldStatus": {
"shape": "ObjectLockLegalHoldStatus",
"documentation": "<p>Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Object Lock</a>.</p>",
"location": "header",
"locationName": "x-amz-object-lock-legal-hold"
}
},
"payload": "Body"
},
"PutObjectRetentionOutput": {
"type": "structure",
"members": {
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
}
}
},
"PutObjectRetentionRequest": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name that contains the object you want to apply this Object Retention configuration to. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>The key name for the object that you want to apply this Object Retention configuration to.</p>",
"location": "uri",
"locationName": "Key"
},
"Retention": {
"shape": "ObjectLockRetention",
"documentation": "<p>The container element for the Object Retention configuration.</p>",
"locationName": "Retention",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>The version ID for the object that you want to apply this Object Retention configuration to.</p>",
"location": "querystring",
"locationName": "versionId"
},
"BypassGovernanceRetention": {
"shape": "BypassGovernanceRetention",
"documentation": "<p>Indicates whether this operation should bypass Governance-mode restrictions.</p>",
"location": "header",
"locationName": "x-amz-bypass-governance-retention"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The MD5 hash for the request body.</p>",
"location": "header",
"locationName": "Content-MD5"
}
},
"payload": "Retention"
},
"PutObjectTaggingOutput": {
"type": "structure",
"members": {
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>The versionId of the object the tag-set was added to.</p>",
"location": "header",
"locationName": "x-amz-version-id"
}
}
},
"PutObjectTaggingRequest": {
"type": "structure",
"required": [
"Bucket",
"Key",
"Tagging"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name containing the object. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Name of the tag.</p>",
"location": "uri",
"locationName": "Key"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>The versionId of the object that the tag-set will be added to.</p>",
"location": "querystring",
"locationName": "versionId"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The MD5 hash for the request body.</p>",
"location": "header",
"locationName": "Content-MD5"
},
"Tagging": {
"shape": "Tagging",
"documentation": "<p>Container for the <code>TagSet</code> and <code>Tag</code> elements</p>",
"locationName": "Tagging",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
}
},
"payload": "Tagging"
},
"PutPublicAccessBlockRequest": {
"type": "structure",
"required": [
"Bucket",
"PublicAccessBlockConfiguration"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The name of the Amazon S3 bucket whose <code>PublicAccessBlock</code> configuration you want to set.</p>",
"location": "uri",
"locationName": "Bucket"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The MD5 hash of the <code>PutPublicAccessBlock</code> request body. </p>",
"location": "header",
"locationName": "Content-MD5"
},
"PublicAccessBlockConfiguration": {
"shape": "PublicAccessBlockConfiguration",
"documentation": "<p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status\">The Meaning of \"Public\"</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"locationName": "PublicAccessBlockConfiguration",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
}
},
"payload": "PublicAccessBlockConfiguration"
},
"QueueArn": {
"type": "string"
},
"QueueConfiguration": {
"type": "structure",
"required": [
"QueueArn",
"Events"
],
"members": {
"Id": {
"shape": "NotificationId"
},
"QueueArn": {
"shape": "QueueArn",
"documentation": "<p>The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.</p>",
"locationName": "Queue"
},
"Events": {
"shape": "EventList",
"documentation": "<p>A collection of bucket events for which to send notifications</p>",
"locationName": "Event"
},
"Filter": {
"shape": "NotificationConfigurationFilter"
}
},
"documentation": "<p>Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.</p>"
},
"QueueConfigurationDeprecated": {
"type": "structure",
"members": {
"Id": {
"shape": "NotificationId"
},
"Event": {
"shape": "Event",
"deprecated": true
},
"Events": {
"shape": "EventList",
"documentation": "<p>A collection of bucket events for which to send notifications</p>",
"locationName": "Event"
},
"Queue": {
"shape": "QueueArn",
"documentation": "<p>The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type. </p>"
}
},
"documentation": "<p>This data type is deprecated. Use <a>QueueConfiguration</a> for the same purposes. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events. </p>"
},
"QueueConfigurationList": {
"type": "list",
"member": {
"shape": "QueueConfiguration"
},
"flattened": true
},
"Quiet": {
"type": "boolean"
},
"QuoteCharacter": {
"type": "string"
},
"QuoteEscapeCharacter": {
"type": "string"
},
"QuoteFields": {
"type": "string",
"enum": [
"ALWAYS",
"ASNEEDED"
]
},
"Range": {
"type": "string"
},
"RecordDelimiter": {
"type": "string"
},
"RecordsEvent": {
"type": "structure",
"members": {
"Payload": {
"shape": "Body",
"documentation": "<p>The byte array of partial, one or more result records.</p>",
"eventpayload": true
}
},
"documentation": "<p>The container for the records event.</p>",
"event": true
},
"Redirect": {
"type": "structure",
"members": {
"HostName": {
"shape": "HostName",
"documentation": "<p>The host name to use in the redirect request.</p>"
},
"HttpRedirectCode": {
"shape": "HttpRedirectCode",
"documentation": "<p>The HTTP redirect code to use on the response. Not required if one of the siblings is present.</p>"
},
"Protocol": {
"shape": "Protocol",
"documentation": "<p>Protocol to use when redirecting requests. The default is the protocol that is used in the original request.</p>"
},
"ReplaceKeyPrefixWith": {
"shape": "ReplaceKeyPrefixWith",
"documentation": "<p>The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix <code>docs/</code> (objects in the <code>docs/</code> folder) to <code>documents/</code>, you can set a condition block with <code>KeyPrefixEquals</code> set to <code>docs/</code> and in the Redirect set <code>ReplaceKeyPrefixWith</code> to <code>/documents</code>. Not required if one of the siblings is present. Can be present only if <code>ReplaceKeyWith</code> is not provided.</p>"
},
"ReplaceKeyWith": {
"shape": "ReplaceKeyWith",
"documentation": "<p>The specific object key to use in the redirect request. For example, redirect request to <code>error.html</code>. Not required if one of the siblings is present. Can be present only if <code>ReplaceKeyPrefixWith</code> is not provided.</p>"
}
},
"documentation": "<p>Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.</p>"
},
"RedirectAllRequestsTo": {
"type": "structure",
"required": [
"HostName"
],
"members": {
"HostName": {
"shape": "HostName",
"documentation": "<p>Name of the host where requests are redirected.</p>"
},
"Protocol": {
"shape": "Protocol",
"documentation": "<p>Protocol to use when redirecting requests. The default is the protocol that is used in the original request.</p>"
}
},
"documentation": "<p>Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.</p>"
},
"ReplaceKeyPrefixWith": {
"type": "string"
},
"ReplaceKeyWith": {
"type": "string"
},
"ReplicaKmsKeyID": {
"type": "string"
},
"ReplicationConfiguration": {
"type": "structure",
"required": [
"Role",
"Rules"
],
"members": {
"Role": {
"shape": "Role",
"documentation": "<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html\">How to Set Up Replication</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
},
"Rules": {
"shape": "ReplicationRules",
"documentation": "<p>A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules. </p>",
"locationName": "Rule"
}
},
"documentation": "<p>A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.</p>"
},
"ReplicationRule": {
"type": "structure",
"required": [
"Status",
"Destination"
],
"members": {
"ID": {
"shape": "ID",
"documentation": "<p>A unique identifier for the rule. The maximum value is 255 characters.</p>"
},
"Priority": {
"shape": "Priority",
"documentation": "<p>The priority associated with the rule. If you specify multiple rules in a replication configuration, Amazon S3 prioritizes the rules to prevent conflicts when filtering. If two or more rules identify the same object based on a specified filter, the rule with higher priority takes precedence. For example:</p> <ul> <li> <p>Same object quality prefix-based filter criteria if prefixes you specified in multiple rules overlap </p> </li> <li> <p>Same object qualify tag-based filter criteria specified in multiple rules</p> </li> </ul> <p>For more information, see <a href=\" https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html\">Replication</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
},
"Prefix": {
"shape": "Prefix",
"documentation": "<p>An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. </p>",
"deprecated": true
},
"Filter": {
"shape": "ReplicationRuleFilter"
},
"Status": {
"shape": "ReplicationRuleStatus",
"documentation": "<p>Specifies whether the rule is enabled.</p>"
},
"SourceSelectionCriteria": {
"shape": "SourceSelectionCriteria",
"documentation": "<p>A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer master key (CMK) stored in AWS Key Management Service (SSE-KMS).</p>"
},
"ExistingObjectReplication": {
"shape": "ExistingObjectReplication",
"documentation": "<p/>"
},
"Destination": {
"shape": "Destination",
"documentation": "<p>A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).</p>"
},
"DeleteMarkerReplication": {
"shape": "DeleteMarkerReplication"
}
},
"documentation": "<p>Specifies which Amazon S3 objects to replicate and where to store the replicas.</p>"
},
"ReplicationRuleAndOperator": {
"type": "structure",
"members": {
"Prefix": {
"shape": "Prefix",
"documentation": "<p>An object key name prefix that identifies the subset of objects to which the rule applies.</p>"
},
"Tags": {
"shape": "TagSet",
"documentation": "<p>An array of tags containing key and value pairs.</p>",
"flattened": true,
"locationName": "Tag"
}
},
"documentation": "<p>A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. </p> <p>For example:</p> <ul> <li> <p>If you specify both a <code>Prefix</code> and a <code>Tag</code> filter, wrap these filters in an <code>And</code> tag. </p> </li> <li> <p>If you specify a filter based on multiple tags, wrap the <code>Tag</code> elements in an <code>And</code> tag</p> </li> </ul>"
},
"ReplicationRuleFilter": {
"type": "structure",
"members": {
"Prefix": {
"shape": "Prefix",
"documentation": "<p>An object key name prefix that identifies the subset of objects to which the rule applies.</p>"
},
"Tag": {
"shape": "Tag",
"documentation": "<p>A container for specifying a tag key and value. </p> <p>The rule applies only to objects that have the tag in their tag set.</p>"
},
"And": {
"shape": "ReplicationRuleAndOperator",
"documentation": "<p>A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: </p> <ul> <li> <p>If you specify both a <code>Prefix</code> and a <code>Tag</code> filter, wrap these filters in an <code>And</code> tag.</p> </li> <li> <p>If you specify a filter based on multiple tags, wrap the <code>Tag</code> elements in an <code>And</code> tag.</p> </li> </ul>"
}
},
"documentation": "<p>A filter that identifies the subset of objects to which the replication rule applies. A <code>Filter</code> must specify exactly one <code>Prefix</code>, <code>Tag</code>, or an <code>And</code> child element.</p>"
},
"ReplicationRuleStatus": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
]
},
"ReplicationRules": {
"type": "list",
"member": {
"shape": "ReplicationRule"
},
"flattened": true
},
"ReplicationStatus": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"FAILED",
"REPLICA"
]
},
"ReplicationTime": {
"type": "structure",
"required": [
"Status",
"Time"
],
"members": {
"Status": {
"shape": "ReplicationTimeStatus",
"documentation": "<p> Specifies whether the replication time is enabled. </p>"
},
"Time": {
"shape": "ReplicationTimeValue",
"documentation": "<p> A container specifying the time by which replication should be complete for all objects and operations on objects. </p>"
}
},
"documentation": "<p> A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a <code>Metrics</code> block. </p>"
},
"ReplicationTimeStatus": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
]
},
"ReplicationTimeValue": {
"type": "structure",
"members": {
"Minutes": {
"shape": "Minutes",
"documentation": "<p> Contains an integer specifying time in minutes. </p> <p> Valid values: 15 minutes. </p>"
}
},
"documentation": "<p> A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics <code>EventThreshold</code>. </p>"
},
"RequestCharged": {
"type": "string",
"documentation": "<p>If present, indicates that the requester was successfully charged for the request.</p>",
"enum": [
"requester"
]
},
"RequestPayer": {
"type": "string",
"documentation": "<p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html\">Downloading Objects in Requestor Pays Buckets</a> in the <i>Amazon S3 Developer Guide</i>.</p>",
"enum": [
"requester"
]
},
"RequestPaymentConfiguration": {
"type": "structure",
"required": [
"Payer"
],
"members": {
"Payer": {
"shape": "Payer",
"documentation": "<p>Specifies who pays for the download and request fees.</p>"
}
},
"documentation": "<p>Container for Payer.</p>"
},
"RequestProgress": {
"type": "structure",
"members": {
"Enabled": {
"shape": "EnableRequestProgress",
"documentation": "<p>Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default value: FALSE.</p>"
}
},
"documentation": "<p>Container for specifying if periodic <code>QueryProgress</code> messages should be sent.</p>"
},
"ResponseCacheControl": {
"type": "string"
},
"ResponseContentDisposition": {
"type": "string"
},
"ResponseContentEncoding": {
"type": "string"
},
"ResponseContentLanguage": {
"type": "string"
},
"ResponseContentType": {
"type": "string"
},
"ResponseExpires": {
"type": "timestamp"
},
"Restore": {
"type": "string"
},
"RestoreObjectOutput": {
"type": "structure",
"members": {
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
},
"RestoreOutputPath": {
"shape": "RestoreOutputPath",
"documentation": "<p>Indicates the path in the provided S3 output location where Select results will be restored to.</p>",
"location": "header",
"locationName": "x-amz-restore-output-path"
}
}
},
"RestoreObjectRequest": {
"type": "structure",
"required": [
"Bucket",
"Key"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name or containing the object to restore. </p> <p>When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html\">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Object key for which the operation was initiated.</p>",
"location": "uri",
"locationName": "Key"
},
"VersionId": {
"shape": "ObjectVersionId",
"documentation": "<p>VersionId used to reference a specific version of the object.</p>",
"location": "querystring",
"locationName": "versionId"
},
"RestoreRequest": {
"shape": "RestoreRequest",
"locationName": "RestoreRequest",
"xmlNamespace": {
"uri": "http://s3.amazonaws.com/doc/2006-03-01/"
}
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
}
},
"payload": "RestoreRequest"
},
"RestoreOutputPath": {
"type": "string"
},
"RestoreRequest": {
"type": "structure",
"members": {
"Days": {
"shape": "Days",
"documentation": "<p>Lifetime of the active copy in days. Do not use with restores that specify <code>OutputLocation</code>.</p>"
},
"GlacierJobParameters": {
"shape": "GlacierJobParameters",
"documentation": "<p>Glacier related parameters pertaining to this job. Do not use with restores that specify <code>OutputLocation</code>.</p>"
},
"Type": {
"shape": "RestoreRequestType",
"documentation": "<p>Type of restore request.</p>"
},
"Tier": {
"shape": "Tier",
"documentation": "<p>Glacier retrieval tier at which the restore will be processed.</p>"
},
"Description": {
"shape": "Description",
"documentation": "<p>The optional description for the job.</p>"
},
"SelectParameters": {
"shape": "SelectParameters",
"documentation": "<p>Describes the parameters for Select job types.</p>"
},
"OutputLocation": {
"shape": "OutputLocation",
"documentation": "<p>Describes the location where the restore job's output is stored.</p>"
}
},
"documentation": "<p>Container for restore job parameters.</p>"
},
"RestoreRequestType": {
"type": "string",
"enum": [
"SELECT"
]
},
"Role": {
"type": "string"
},
"RoutingRule": {
"type": "structure",
"required": [
"Redirect"
],
"members": {
"Condition": {
"shape": "Condition",
"documentation": "<p>A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the <code>/docs</code> folder, redirect to the <code>/documents</code> folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.</p>"
},
"Redirect": {
"shape": "Redirect",
"documentation": "<p>Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return.</p>"
}
},
"documentation": "<p>Specifies the redirect behavior and when a redirect is applied.</p>"
},
"RoutingRules": {
"type": "list",
"member": {
"shape": "RoutingRule",
"locationName": "RoutingRule"
}
},
"Rule": {
"type": "structure",
"required": [
"Prefix",
"Status"
],
"members": {
"Expiration": {
"shape": "LifecycleExpiration",
"documentation": "<p>Specifies the expiration for the lifecycle of the object.</p>"
},
"ID": {
"shape": "ID",
"documentation": "<p>Unique identifier for the rule. The value can't be longer than 255 characters.</p>"
},
"Prefix": {
"shape": "Prefix",
"documentation": "<p>Object key prefix that identifies one or more objects to which this rule applies.</p>"
},
"Status": {
"shape": "ExpirationStatus",
"documentation": "<p>If <code>Enabled</code>, the rule is currently being applied. If <code>Disabled</code>, the rule is not currently being applied.</p>"
},
"Transition": {
"shape": "Transition",
"documentation": "<p>Specifies when an object transitions to a specified storage class.</p>"
},
"NoncurrentVersionTransition": {
"shape": "NoncurrentVersionTransition"
},
"NoncurrentVersionExpiration": {
"shape": "NoncurrentVersionExpiration"
},
"AbortIncompleteMultipartUpload": {
"shape": "AbortIncompleteMultipartUpload"
}
},
"documentation": "<p>Specifies lifecycle rules for an Amazon S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html\">PUT Bucket lifecycle</a> in the <i>Amazon Simple Storage Service API Reference</i>.</p>"
},
"Rules": {
"type": "list",
"member": {
"shape": "Rule"
},
"flattened": true
},
"S3KeyFilter": {
"type": "structure",
"members": {
"FilterRules": {
"shape": "FilterRuleList",
"locationName": "FilterRule"
}
},
"documentation": "<p>A container for object key name prefix and suffix filtering rules.</p>"
},
"S3Location": {
"type": "structure",
"required": [
"BucketName",
"Prefix"
],
"members": {
"BucketName": {
"shape": "BucketName",
"documentation": "<p>The name of the bucket where the restore results will be placed.</p>"
},
"Prefix": {
"shape": "LocationPrefix",
"documentation": "<p>The prefix that is prepended to the restore results for this request.</p>"
},
"Encryption": {
"shape": "Encryption"
},
"CannedACL": {
"shape": "ObjectCannedACL",
"documentation": "<p>The canned ACL to apply to the restore results.</p>"
},
"AccessControlList": {
"shape": "Grants",
"documentation": "<p>A list of grants that control access to the staged results.</p>"
},
"Tagging": {
"shape": "Tagging",
"documentation": "<p>The tag-set that is applied to the restore results.</p>"
},
"UserMetadata": {
"shape": "UserMetadata",
"documentation": "<p>A list of metadata to store with the restore results in S3.</p>"
},
"StorageClass": {
"shape": "StorageClass",
"documentation": "<p>The class of storage used to store the restore results.</p>"
}
},
"documentation": "<p>Describes an Amazon S3 location that will receive the results of the restore request.</p>"
},
"SSECustomerAlgorithm": {
"type": "string"
},
"SSECustomerKey": {
"type": "blob",
"sensitive": true
},
"SSECustomerKeyMD5": {
"type": "string"
},
"SSEKMS": {
"type": "structure",
"required": [
"KeyId"
],
"members": {
"KeyId": {
"shape": "SSEKMSKeyId",
"documentation": "<p>Specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) to use for encrypting inventory reports.</p>"
}
},
"documentation": "<p>Specifies the use of SSE-KMS to encrypt delivered inventory reports.</p>",
"locationName": "SSE-KMS"
},
"SSEKMSEncryptionContext": {
"type": "string",
"sensitive": true
},
"SSEKMSKeyId": {
"type": "string",
"sensitive": true
},
"SSES3": {
"type": "structure",
"members": {},
"documentation": "<p>Specifies the use of SSE-S3 to encrypt delivered inventory reports.</p>",
"locationName": "SSE-S3"
},
"ScanRange": {
"type": "structure",
"members": {
"Start": {
"shape": "Start",
"documentation": "<p>Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. If only start is supplied, it means scan from that point to the end of the file.For example; <code><scanrange><start>50</start></scanrange></code> means scan from byte 50 until the end of the file.</p>"
},
"End": {
"shape": "End",
"documentation": "<p>Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. If only the End parameter is supplied, it is interpreted to mean scan the last N bytes of the file. For example, <code><scanrange><end>50</end></scanrange></code> means scan the last 50 bytes.</p>"
}
},
"documentation": "<p>Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.</p>"
},
"SelectObjectContentEventStream": {
"type": "structure",
"members": {
"Records": {
"shape": "RecordsEvent",
"documentation": "<p>The Records Event.</p>"
},
"Stats": {
"shape": "StatsEvent",
"documentation": "<p>The Stats Event.</p>"
},
"Progress": {
"shape": "ProgressEvent",
"documentation": "<p>The Progress Event.</p>"
},
"Cont": {
"shape": "ContinuationEvent",
"documentation": "<p>The Continuation Event.</p>"
},
"End": {
"shape": "EndEvent",
"documentation": "<p>The End Event.</p>"
}
},
"documentation": "<p>The container for selecting objects from a content event stream.</p>",
"eventstream": true
},
"SelectObjectContentOutput": {
"type": "structure",
"members": {
"Payload": {
"shape": "SelectObjectContentEventStream",
"documentation": "<p>The array of results.</p>"
}
},
"payload": "Payload"
},
"SelectObjectContentRequest": {
"type": "structure",
"required": [
"Bucket",
"Key",
"Expression",
"ExpressionType",
"InputSerialization",
"OutputSerialization"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The S3 bucket.</p>",
"location": "uri",
"locationName": "Bucket"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>The object key.</p>",
"location": "uri",
"locationName": "Key"
},
"SSECustomerAlgorithm": {
"shape": "SSECustomerAlgorithm",
"documentation": "<p>The SSE Algorithm used to encrypt the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys</a>. </p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey": {
"shape": "SSECustomerKey",
"documentation": "<p>The SSE Customer Key. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys</a>. </p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5": {
"shape": "SSECustomerKeyMD5",
"documentation": "<p>The SSE Customer Key MD5. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys</a>. </p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"Expression": {
"shape": "Expression",
"documentation": "<p>The expression that is used to query the object.</p>"
},
"ExpressionType": {
"shape": "ExpressionType",
"documentation": "<p>The type of the provided expression (for example, SQL).</p>"
},
"RequestProgress": {
"shape": "RequestProgress",
"documentation": "<p>Specifies if periodic request progress information should be enabled.</p>"
},
"InputSerialization": {
"shape": "InputSerialization",
"documentation": "<p>Describes the format of the data in the object that is being queried.</p>"
},
"OutputSerialization": {
"shape": "OutputSerialization",
"documentation": "<p>Describes the format of the data that you want Amazon S3 to return in response.</p>"
},
"ScanRange": {
"shape": "ScanRange",
"documentation": "<p>Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.</p> <p> <code>ScanRange</code>may be used in the following ways:</p> <ul> <li> <p> <code><scanrange><start>50</start><end>100</end></scanrange></code> - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)</p> </li> <li> <p> <code><scanrange><start>50</start></scanrange></code> - process only the records starting after the byte 50</p> </li> <li> <p> <code><scanrange><end>50</end></scanrange></code> - process only the records within the last 50 bytes of the file.</p> </li> </ul>"
}
},
"documentation": "<p>Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records. It returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html\">S3Select API Documentation</a>.</p>"
},
"SelectParameters": {
"type": "structure",
"required": [
"InputSerialization",
"ExpressionType",
"Expression",
"OutputSerialization"
],
"members": {
"InputSerialization": {
"shape": "InputSerialization",
"documentation": "<p>Describes the serialization format of the object.</p>"
},
"ExpressionType": {
"shape": "ExpressionType",
"documentation": "<p>The type of the provided expression (for example, SQL).</p>"
},
"Expression": {
"shape": "Expression",
"documentation": "<p>The expression that is used to query the object.</p>"
},
"OutputSerialization": {
"shape": "OutputSerialization",
"documentation": "<p>Describes how the results of the Select job are serialized.</p>"
}
},
"documentation": "<p>Describes the parameters for Select job types.</p>"
},
"ServerSideEncryption": {
"type": "string",
"enum": [
"AES256",
"aws:kms"
]
},
"ServerSideEncryptionByDefault": {
"type": "structure",
"required": [
"SSEAlgorithm"
],
"members": {
"SSEAlgorithm": {
"shape": "ServerSideEncryption",
"documentation": "<p>Server-side encryption algorithm to use for the default encryption.</p>"
},
"KMSMasterKeyID": {
"shape": "SSEKMSKeyId",
"documentation": "<p>KMS master key ID to use for the default encryption. This parameter is allowed if and only if <code>SSEAlgorithm</code> is set to <code>aws:kms</code>.</p>"
}
},
"documentation": "<p>Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html\">PUT Bucket encryption</a> in the <i>Amazon Simple Storage Service API Reference</i>.</p>"
},
"ServerSideEncryptionConfiguration": {
"type": "structure",
"required": [
"Rules"
],
"members": {
"Rules": {
"shape": "ServerSideEncryptionRules",
"documentation": "<p>Container for information about a particular server-side encryption configuration rule.</p>",
"locationName": "Rule"
}
},
"documentation": "<p>Specifies the default server-side-encryption configuration.</p>"
},
"ServerSideEncryptionRule": {
"type": "structure",
"members": {
"ApplyServerSideEncryptionByDefault": {
"shape": "ServerSideEncryptionByDefault",
"documentation": "<p>Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.</p>"
}
},
"documentation": "<p>Specifies the default server-side encryption configuration.</p>"
},
"ServerSideEncryptionRules": {
"type": "list",
"member": {
"shape": "ServerSideEncryptionRule"
},
"flattened": true
},
"Setting": {
"type": "boolean"
},
"Size": {
"type": "integer"
},
"SourceSelectionCriteria": {
"type": "structure",
"members": {
"SseKmsEncryptedObjects": {
"shape": "SseKmsEncryptedObjects",
"documentation": "<p> A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS. If you include <code>SourceSelectionCriteria</code> in the replication configuration, this element is required. </p>"
}
},
"documentation": "<p>A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer master key (CMK) stored in AWS Key Management Service (SSE-KMS).</p>"
},
"SseKmsEncryptedObjects": {
"type": "structure",
"required": [
"Status"
],
"members": {
"Status": {
"shape": "SseKmsEncryptedObjectsStatus",
"documentation": "<p>Specifies whether Amazon S3 replicates objects created with server-side encryption using a customer master key (CMK) stored in AWS Key Management Service.</p>"
}
},
"documentation": "<p>A container for filter information for the selection of S3 objects encrypted with AWS KMS.</p>"
},
"SseKmsEncryptedObjectsStatus": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
]
},
"Start": {
"type": "long"
},
"StartAfter": {
"type": "string"
},
"Stats": {
"type": "structure",
"members": {
"BytesScanned": {
"shape": "BytesScanned",
"documentation": "<p>The total number of object bytes scanned.</p>"
},
"BytesProcessed": {
"shape": "BytesProcessed",
"documentation": "<p>The total number of uncompressed object bytes processed.</p>"
},
"BytesReturned": {
"shape": "BytesReturned",
"documentation": "<p>The total number of bytes of records payload data returned.</p>"
}
},
"documentation": "<p>Container for the stats details.</p>"
},
"StatsEvent": {
"type": "structure",
"members": {
"Details": {
"shape": "Stats",
"documentation": "<p>The Stats event details.</p>",
"eventpayload": true
}
},
"documentation": "<p>Container for the Stats Event.</p>",
"event": true
},
"StorageClass": {
"type": "string",
"enum": [
"STANDARD",
"REDUCED_REDUNDANCY",
"STANDARD_IA",
"ONEZONE_IA",
"INTELLIGENT_TIERING",
"GLACIER",
"DEEP_ARCHIVE"
]
},
"StorageClassAnalysis": {
"type": "structure",
"members": {
"DataExport": {
"shape": "StorageClassAnalysisDataExport",
"documentation": "<p>Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.</p>"
}
},
"documentation": "<p>Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.</p>"
},
"StorageClassAnalysisDataExport": {
"type": "structure",
"required": [
"OutputSchemaVersion",
"Destination"
],
"members": {
"OutputSchemaVersion": {
"shape": "StorageClassAnalysisSchemaVersion",
"documentation": "<p>The version of the output schema to use when exporting data. Must be <code>V_1</code>.</p>"
},
"Destination": {
"shape": "AnalyticsExportDestination",
"documentation": "<p>The place to store the data for an analysis.</p>"
}
},
"documentation": "<p>Container for data related to the storage class analysis for an Amazon S3 bucket for export.</p>"
},
"StorageClassAnalysisSchemaVersion": {
"type": "string",
"enum": [
"V_1"
]
},
"Suffix": {
"type": "string"
},
"Tag": {
"type": "structure",
"required": [
"Key",
"Value"
],
"members": {
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Name of the tag.</p>"
},
"Value": {
"shape": "Value",
"documentation": "<p>Value of the tag.</p>"
}
},
"documentation": "<p>A container of a key value name pair.</p>"
},
"TagCount": {
"type": "integer"
},
"TagSet": {
"type": "list",
"member": {
"shape": "Tag",
"locationName": "Tag"
}
},
"Tagging": {
"type": "structure",
"required": [
"TagSet"
],
"members": {
"TagSet": {
"shape": "TagSet",
"documentation": "<p>A collection for a set of tags</p>"
}
},
"documentation": "<p>Container for <code>TagSet</code> elements.</p>"
},
"TaggingDirective": {
"type": "string",
"enum": [
"COPY",
"REPLACE"
]
},
"TaggingHeader": {
"type": "string"
},
"TargetBucket": {
"type": "string"
},
"TargetGrant": {
"type": "structure",
"members": {
"Grantee": {
"shape": "Grantee",
"documentation": "<p>Container for the person being granted permissions.</p>"
},
"Permission": {
"shape": "BucketLogsPermission",
"documentation": "<p>Logging permissions assigned to the Grantee for the bucket.</p>"
}
},
"documentation": "<p>Container for granting information.</p>"
},
"TargetGrants": {
"type": "list",
"member": {
"shape": "TargetGrant",
"locationName": "Grant"
}
},
"TargetPrefix": {
"type": "string"
},
"Tier": {
"type": "string",
"enum": [
"Standard",
"Bulk",
"Expedited"
]
},
"Token": {
"type": "string"
},
"TopicArn": {
"type": "string"
},
"TopicConfiguration": {
"type": "structure",
"required": [
"TopicArn",
"Events"
],
"members": {
"Id": {
"shape": "NotificationId"
},
"TopicArn": {
"shape": "TopicArn",
"documentation": "<p>The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.</p>",
"locationName": "Topic"
},
"Events": {
"shape": "EventList",
"documentation": "<p>The Amazon S3 bucket event about which to send notifications. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Supported Event Types</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"locationName": "Event"
},
"Filter": {
"shape": "NotificationConfigurationFilter"
}
},
"documentation": "<p>A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.</p>"
},
"TopicConfigurationDeprecated": {
"type": "structure",
"members": {
"Id": {
"shape": "NotificationId"
},
"Events": {
"shape": "EventList",
"documentation": "<p>A collection of events related to objects</p>",
"locationName": "Event"
},
"Event": {
"shape": "Event",
"documentation": "<p>Bucket event for which to send notifications.</p>",
"deprecated": true
},
"Topic": {
"shape": "TopicArn",
"documentation": "<p>Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.</p>"
}
},
"documentation": "<p>A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events. This data type is deprecated. Use <a>TopicConfiguration</a> instead.</p>"
},
"TopicConfigurationList": {
"type": "list",
"member": {
"shape": "TopicConfiguration"
},
"flattened": true
},
"Transition": {
"type": "structure",
"members": {
"Date": {
"shape": "Date",
"documentation": "<p>Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.</p>"
},
"Days": {
"shape": "Days",
"documentation": "<p>Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.</p>"
},
"StorageClass": {
"shape": "TransitionStorageClass",
"documentation": "<p>The storage class to which you want the object to transition.</p>"
}
},
"documentation": "<p>Specifies when an object transitions to a specified storage class.</p>"
},
"TransitionList": {
"type": "list",
"member": {
"shape": "Transition"
},
"flattened": true
},
"TransitionStorageClass": {
"type": "string",
"enum": [
"GLACIER",
"STANDARD_IA",
"ONEZONE_IA",
"INTELLIGENT_TIERING",
"DEEP_ARCHIVE"
]
},
"Type": {
"type": "string",
"enum": [
"CanonicalUser",
"AmazonCustomerByEmail",
"Group"
]
},
"URI": {
"type": "string"
},
"UploadIdMarker": {
"type": "string"
},
"UploadPartCopyOutput": {
"type": "structure",
"members": {
"CopySourceVersionId": {
"shape": "CopySourceVersionId",
"documentation": "<p>The version of the source object that was copied, if you have enabled versioning on the source bucket.</p>",
"location": "header",
"locationName": "x-amz-copy-source-version-id"
},
"CopyPartResult": {
"shape": "CopyPartResult",
"documentation": "<p>Container for all response elements.</p>"
},
"ServerSideEncryption": {
"shape": "ServerSideEncryption",
"documentation": "<p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"SSECustomerAlgorithm": {
"shape": "SSECustomerAlgorithm",
"documentation": "<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5": {
"shape": "SSECustomerKeyMD5",
"documentation": "<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId": {
"shape": "SSEKMSKeyId",
"documentation": "<p>If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
},
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
}
},
"payload": "CopyPartResult"
},
"UploadPartCopyRequest": {
"type": "structure",
"required": [
"Bucket",
"CopySource",
"Key",
"PartNumber",
"UploadId"
],
"members": {
"Bucket": {
"shape": "BucketName",
"documentation": "<p>The bucket name.</p>",
"location": "uri",
"locationName": "Bucket"
},
"CopySource": {
"shape": "CopySource",
"documentation": "<p>The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.</p>",
"location": "header",
"locationName": "x-amz-copy-source"
},
"CopySourceIfMatch": {
"shape": "CopySourceIfMatch",
"documentation": "<p>Copies the object if its entity tag (ETag) matches the specified tag.</p>",
"location": "header",
"locationName": "x-amz-copy-source-if-match"
},
"CopySourceIfModifiedSince": {
"shape": "CopySourceIfModifiedSince",
"documentation": "<p>Copies the object if it has been modified since the specified time.</p>",
"location": "header",
"locationName": "x-amz-copy-source-if-modified-since"
},
"CopySourceIfNoneMatch": {
"shape": "CopySourceIfNoneMatch",
"documentation": "<p>Copies the object if its entity tag (ETag) is different than the specified ETag.</p>",
"location": "header",
"locationName": "x-amz-copy-source-if-none-match"
},
"CopySourceIfUnmodifiedSince": {
"shape": "CopySourceIfUnmodifiedSince",
"documentation": "<p>Copies the object if it hasn't been modified since the specified time.</p>",
"location": "header",
"locationName": "x-amz-copy-source-if-unmodified-since"
},
"CopySourceRange": {
"shape": "CopySourceRange",
"documentation": "<p>The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You can copy a range only if the source object is greater than 5 MB.</p>",
"location": "header",
"locationName": "x-amz-copy-source-range"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Object key for which the multipart upload was initiated.</p>",
"location": "uri",
"locationName": "Key"
},
"PartNumber": {
"shape": "PartNumber",
"documentation": "<p>Part number of part being copied. This is a positive integer between 1 and 10,000.</p>",
"location": "querystring",
"locationName": "partNumber"
},
"UploadId": {
"shape": "MultipartUploadId",
"documentation": "<p>Upload ID identifying the multipart upload whose part is being copied.</p>",
"location": "querystring",
"locationName": "uploadId"
},
"SSECustomerAlgorithm": {
"shape": "SSECustomerAlgorithm",
"documentation": "<p>Specifies the algorithm to use to when encrypting the object (for example, AES256).</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey": {
"shape": "SSECustomerKey",
"documentation": "<p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the <code>x-amz-server-side-encryption-customer-algorithm</code> header. This must be the same encryption key specified in the initiate multipart upload request.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5": {
"shape": "SSECustomerKeyMD5",
"documentation": "<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"CopySourceSSECustomerAlgorithm": {
"shape": "CopySourceSSECustomerAlgorithm",
"documentation": "<p>Specifies the algorithm to use when decrypting the source object (for example, AES256).</p>",
"location": "header",
"locationName": "x-amz-copy-source-server-side-encryption-customer-algorithm"
},
"CopySourceSSECustomerKey": {
"shape": "CopySourceSSECustomerKey",
"documentation": "<p>Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.</p>",
"location": "header",
"locationName": "x-amz-copy-source-server-side-encryption-customer-key"
},
"CopySourceSSECustomerKeyMD5": {
"shape": "CopySourceSSECustomerKeyMD5",
"documentation": "<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.</p>",
"location": "header",
"locationName": "x-amz-copy-source-server-side-encryption-customer-key-MD5"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
}
}
},
"UploadPartOutput": {
"type": "structure",
"members": {
"ServerSideEncryption": {
"shape": "ServerSideEncryption",
"documentation": "<p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption"
},
"ETag": {
"shape": "ETag",
"documentation": "<p>Entity tag for the uploaded object.</p>",
"location": "header",
"locationName": "ETag"
},
"SSECustomerAlgorithm": {
"shape": "SSECustomerAlgorithm",
"documentation": "<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5": {
"shape": "SSECustomerKeyMD5",
"documentation": "<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId": {
"shape": "SSEKMSKeyId",
"documentation": "<p>If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) was used for the object.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-aws-kms-key-id"
},
"RequestCharged": {
"shape": "RequestCharged",
"location": "header",
"locationName": "x-amz-request-charged"
}
}
},
"UploadPartRequest": {
"type": "structure",
"required": [
"Bucket",
"Key",
"PartNumber",
"UploadId"
],
"members": {
"Body": {
"shape": "Body",
"documentation": "<p>Object data.</p>",
"streaming": true
},
"Bucket": {
"shape": "BucketName",
"documentation": "<p>Name of the bucket to which the multipart upload was initiated.</p>",
"location": "uri",
"locationName": "Bucket"
},
"ContentLength": {
"shape": "ContentLength",
"documentation": "<p>Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.</p>",
"location": "header",
"locationName": "Content-Length"
},
"ContentMD5": {
"shape": "ContentMD5",
"documentation": "<p>The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.</p>",
"location": "header",
"locationName": "Content-MD5"
},
"Key": {
"shape": "ObjectKey",
"documentation": "<p>Object key for which the multipart upload was initiated.</p>",
"location": "uri",
"locationName": "Key"
},
"PartNumber": {
"shape": "PartNumber",
"documentation": "<p>Part number of part being uploaded. This is a positive integer between 1 and 10,000.</p>",
"location": "querystring",
"locationName": "partNumber"
},
"UploadId": {
"shape": "MultipartUploadId",
"documentation": "<p>Upload ID identifying the multipart upload whose part is being uploaded.</p>",
"location": "querystring",
"locationName": "uploadId"
},
"SSECustomerAlgorithm": {
"shape": "SSECustomerAlgorithm",
"documentation": "<p>Specifies the algorithm to use to when encrypting the object (for example, AES256).</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey": {
"shape": "SSECustomerKey",
"documentation": "<p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the <code>x-amz-server-side-encryption-customer-algorithm header</code>. This must be the same encryption key specified in the initiate multipart upload request.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5": {
"shape": "SSECustomerKeyMD5",
"documentation": "<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.</p>",
"location": "header",
"locationName": "x-amz-server-side-encryption-customer-key-MD5"
},
"RequestPayer": {
"shape": "RequestPayer",
"location": "header",
"locationName": "x-amz-request-payer"
}
},
"payload": "Body"
},
"UserMetadata": {
"type": "list",
"member": {
"shape": "MetadataEntry",
"locationName": "MetadataEntry"
}
},
"Value": {
"type": "string"
},
"VersionIdMarker": {
"type": "string"
},
"VersioningConfiguration": {
"type": "structure",
"members": {
"MFADelete": {
"shape": "MFADelete",
"documentation": "<p>Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.</p>",
"locationName": "MfaDelete"
},
"Status": {
"shape": "BucketVersioningStatus",
"documentation": "<p>The versioning state of the bucket.</p>"
}
},
"documentation": "<p>Describes the versioning state of an Amazon S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html\">PUT Bucket versioning</a> in the <i>Amazon Simple Storage Service API Reference</i>.</p>"
},
"WebsiteConfiguration": {
"type": "structure",
"members": {
"ErrorDocument": {
"shape": "ErrorDocument",
"documentation": "<p>The name of the error document for the website.</p>"
},
"IndexDocument": {
"shape": "IndexDocument",
"documentation": "<p>The name of the index document for the website.</p>"
},
"RedirectAllRequestsTo": {
"shape": "RedirectAllRequestsTo",
"documentation": "<p>The redirect behavior for every request to this bucket's website endpoint.</p> <important> <p>If you specify this property, you can't specify any other property.</p> </important>"
},
"RoutingRules": {
"shape": "RoutingRules",
"documentation": "<p>Rules that define when a redirect is applied and the redirect behavior.</p>"
}
},
"documentation": "<p>Specifies website configuration parameters for an Amazon S3 bucket.</p>"
},
"WebsiteRedirectLocation": {
"type": "string"
},
"Years": {
"type": "integer"
}
},
"documentation": "<p/>"
}
|