s3control.d.ts
117 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
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
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
import {UseDualstackConfigOptions} from '../lib/config_use_dualstack';
interface Blob {}
declare class S3Control extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: S3Control.Types.ClientConfiguration)
config: Config & S3Control.Types.ClientConfiguration;
/**
* Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide. Using this action with Amazon S3 on Outposts This action: Requires a virtual private cloud (VPC) configuration as S3 on Outposts only supports VPC style access points. Does not support ACL on S3 on Outposts buckets. Does not support Public Access on S3 on Outposts buckets. Does not support object lock for S3 on Outposts buckets. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide . All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to CreateAccessPoint: GetAccessPoint DeleteAccessPoint ListAccessPoints
*/
createAccessPoint(params: S3Control.Types.CreateAccessPointRequest, callback?: (err: AWSError, data: S3Control.Types.CreateAccessPointResult) => void): Request<S3Control.Types.CreateAccessPointResult, AWSError>;
/**
* Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide. Using this action with Amazon S3 on Outposts This action: Requires a virtual private cloud (VPC) configuration as S3 on Outposts only supports VPC style access points. Does not support ACL on S3 on Outposts buckets. Does not support Public Access on S3 on Outposts buckets. Does not support object lock for S3 on Outposts buckets. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide . All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to CreateAccessPoint: GetAccessPoint DeleteAccessPoint ListAccessPoints
*/
createAccessPoint(callback?: (err: AWSError, data: S3Control.Types.CreateAccessPointResult) => void): Request<S3Control.Types.CreateAccessPointResult, AWSError>;
/**
* This API operation creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon Simple Storage Service API. Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide. Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets. S3 on Outposts buckets do not support ACLs. Instead, configure access point policies to manage access to buckets. Public access. Object Lock Bucket Location constraint For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and outpost-id in your API request, see the Example section below. The following actions are related to CreateBucket for Amazon S3 on Outposts: PutObject GetBucket DeleteBucket CreateAccessPoint PutAccessPointPolicy
*/
createBucket(params: S3Control.Types.CreateBucketRequest, callback?: (err: AWSError, data: S3Control.Types.CreateBucketResult) => void): Request<S3Control.Types.CreateBucketResult, AWSError>;
/**
* This API operation creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon Simple Storage Service API. Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide. Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets. S3 on Outposts buckets do not support ACLs. Instead, configure access point policies to manage access to buckets. Public access. Object Lock Bucket Location constraint For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and outpost-id in your API request, see the Example section below. The following actions are related to CreateBucket for Amazon S3 on Outposts: PutObject GetBucket DeleteBucket CreateAccessPoint PutAccessPointPolicy
*/
createBucket(callback?: (err: AWSError, data: S3Control.Types.CreateBucketResult) => void): Request<S3Control.Types.CreateBucketResult, AWSError>;
/**
* S3 Batch Operations performs large-scale Batch Operations on Amazon S3 objects. Batch Operations can run a single operation or action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. This operation creates a S3 Batch Operations job. Related actions include: DescribeJob ListJobs UpdateJobPriority UpdateJobStatus
*/
createJob(params: S3Control.Types.CreateJobRequest, callback?: (err: AWSError, data: S3Control.Types.CreateJobResult) => void): Request<S3Control.Types.CreateJobResult, AWSError>;
/**
* S3 Batch Operations performs large-scale Batch Operations on Amazon S3 objects. Batch Operations can run a single operation or action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. This operation creates a S3 Batch Operations job. Related actions include: DescribeJob ListJobs UpdateJobPriority UpdateJobStatus
*/
createJob(callback?: (err: AWSError, data: S3Control.Types.CreateJobResult) => void): Request<S3Control.Types.CreateJobResult, AWSError>;
/**
* Deletes the specified access point. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the ARN, see the Example section below. The following actions are related to DeleteAccessPoint: CreateAccessPoint GetAccessPoint ListAccessPoints
*/
deleteAccessPoint(params: S3Control.Types.DeleteAccessPointRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified access point. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the ARN, see the Example section below. The following actions are related to DeleteAccessPoint: CreateAccessPoint GetAccessPoint ListAccessPoints
*/
deleteAccessPoint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the access point policy for the specified access point. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to DeleteAccessPointPolicy: PutAccessPointPolicy GetAccessPointPolicy
*/
deleteAccessPointPolicy(params: S3Control.Types.DeleteAccessPointPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the access point policy for the specified access point. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to DeleteAccessPointPolicy: PutAccessPointPolicy GetAccessPointPolicy
*/
deleteAccessPointPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This API operation deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon Simple Storage Service API. Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. Related Resources CreateBucket GetBucket DeleteObject
*/
deleteBucket(params: S3Control.Types.DeleteBucketRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This API operation deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon Simple Storage Service API. Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. Related Resources CreateBucket GetBucket DeleteObject
*/
deleteBucket(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This API action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon Simple Storage Service API. Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide. To use this operation, you must have permission to perform the s3outposts:DeleteLifecycleConfiguration action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. For more information about object expiration, see Elements to Describe Lifecycle Actions. Related actions include: PutBucketLifecycleConfiguration GetBucketLifecycleConfiguration
*/
deleteBucketLifecycleConfiguration(params: S3Control.Types.DeleteBucketLifecycleConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This API action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon Simple Storage Service API. Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide. To use this operation, you must have permission to perform the s3outposts:DeleteLifecycleConfiguration action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. For more information about object expiration, see Elements to Describe Lifecycle Actions. Related actions include: PutBucketLifecycleConfiguration GetBucketLifecycleConfiguration
*/
deleteBucketLifecycleConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This API operation deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon Simple Storage Service API. This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts 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 s3outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account to use this operation. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide. If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied 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 405 Method Not Allowed error. 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. For more information about bucket policies, see Using Bucket Policies and User Policies. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to DeleteBucketPolicy: GetBucketPolicy PutBucketPolicy
*/
deleteBucketPolicy(params: S3Control.Types.DeleteBucketPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This API operation deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon Simple Storage Service API. This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts 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 s3outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account to use this operation. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide. If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied 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 405 Method Not Allowed error. 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. For more information about bucket policies, see Using Bucket Policies and User Policies. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to DeleteBucketPolicy: GetBucketPolicy PutBucketPolicy
*/
deleteBucketPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This API operation deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon Simple Storage Service API. Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide. To use this operation, you must have permission to perform the PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to DeleteBucketTagging: GetBucketTagging PutBucketTagging
*/
deleteBucketTagging(params: S3Control.Types.DeleteBucketTaggingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This API operation deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon Simple Storage Service API. Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide. To use this operation, you must have permission to perform the PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to DeleteBucketTagging: GetBucketTagging PutBucketTagging
*/
deleteBucketTagging(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes the entire tag set from the specified S3 Batch Operations job. To use this operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob GetJobTagging PutJobTagging
*/
deleteJobTagging(params: S3Control.Types.DeleteJobTaggingRequest, callback?: (err: AWSError, data: S3Control.Types.DeleteJobTaggingResult) => void): Request<S3Control.Types.DeleteJobTaggingResult, AWSError>;
/**
* Removes the entire tag set from the specified S3 Batch Operations job. To use this operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob GetJobTagging PutJobTagging
*/
deleteJobTagging(callback?: (err: AWSError, data: S3Control.Types.DeleteJobTaggingResult) => void): Request<S3Control.Types.DeleteJobTaggingResult, AWSError>;
/**
* Removes the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access. Related actions include: GetPublicAccessBlock PutPublicAccessBlock
*/
deletePublicAccessBlock(params: S3Control.Types.DeletePublicAccessBlockRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access. Related actions include: GetPublicAccessBlock PutPublicAccessBlock
*/
deletePublicAccessBlock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob ListJobs UpdateJobPriority UpdateJobStatus
*/
describeJob(params: S3Control.Types.DescribeJobRequest, callback?: (err: AWSError, data: S3Control.Types.DescribeJobResult) => void): Request<S3Control.Types.DescribeJobResult, AWSError>;
/**
* Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob ListJobs UpdateJobPriority UpdateJobStatus
*/
describeJob(callback?: (err: AWSError, data: S3Control.Types.DescribeJobResult) => void): Request<S3Control.Types.DescribeJobResult, AWSError>;
/**
* Returns configuration information about the specified access point. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to GetAccessPoint: CreateAccessPoint DeleteAccessPoint ListAccessPoints
*/
getAccessPoint(params: S3Control.Types.GetAccessPointRequest, callback?: (err: AWSError, data: S3Control.Types.GetAccessPointResult) => void): Request<S3Control.Types.GetAccessPointResult, AWSError>;
/**
* Returns configuration information about the specified access point. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to GetAccessPoint: CreateAccessPoint DeleteAccessPoint ListAccessPoints
*/
getAccessPoint(callback?: (err: AWSError, data: S3Control.Types.GetAccessPointResult) => void): Request<S3Control.Types.GetAccessPointResult, AWSError>;
/**
* Returns the access point policy associated with the specified access point. The following actions are related to GetAccessPointPolicy: PutAccessPointPolicy DeleteAccessPointPolicy
*/
getAccessPointPolicy(params: S3Control.Types.GetAccessPointPolicyRequest, callback?: (err: AWSError, data: S3Control.Types.GetAccessPointPolicyResult) => void): Request<S3Control.Types.GetAccessPointPolicyResult, AWSError>;
/**
* Returns the access point policy associated with the specified access point. The following actions are related to GetAccessPointPolicy: PutAccessPointPolicy DeleteAccessPointPolicy
*/
getAccessPointPolicy(callback?: (err: AWSError, data: S3Control.Types.GetAccessPointPolicyResult) => void): Request<S3Control.Types.GetAccessPointPolicyResult, AWSError>;
/**
* Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
*/
getAccessPointPolicyStatus(params: S3Control.Types.GetAccessPointPolicyStatusRequest, callback?: (err: AWSError, data: S3Control.Types.GetAccessPointPolicyStatusResult) => void): Request<S3Control.Types.GetAccessPointPolicyStatusResult, AWSError>;
/**
* Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
*/
getAccessPointPolicyStatus(callback?: (err: AWSError, data: S3Control.Types.GetAccessPointPolicyStatusResult) => void): Request<S3Control.Types.GetAccessPointPolicyStatusResult, AWSError>;
/**
* Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide. The following actions are related to GetBucket for Amazon S3 on Outposts: PutObject CreateBucket DeleteBucket
*/
getBucket(params: S3Control.Types.GetBucketRequest, callback?: (err: AWSError, data: S3Control.Types.GetBucketResult) => void): Request<S3Control.Types.GetBucketResult, AWSError>;
/**
* Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide. The following actions are related to GetBucket for Amazon S3 on Outposts: PutObject CreateBucket DeleteBucket
*/
getBucket(callback?: (err: AWSError, data: S3Control.Types.GetBucketResult) => void): Request<S3Control.Types.GetBucketResult, AWSError>;
/**
* This API operation gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon Simple Storage Service API. Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon Simple Storage Service Developer Guide. To use this operation, you must have permission to perform the s3outposts:GetLifecycleConfiguration action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. GetBucketLifecycleConfiguration has the following special error: Error code: NoSuchLifecycleConfiguration Description: The lifecycle configuration does not exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client The following actions are related to GetBucketLifecycleConfiguration: PutBucketLifecycleConfiguration DeleteBucketLifecycleConfiguration
*/
getBucketLifecycleConfiguration(params: S3Control.Types.GetBucketLifecycleConfigurationRequest, callback?: (err: AWSError, data: S3Control.Types.GetBucketLifecycleConfigurationResult) => void): Request<S3Control.Types.GetBucketLifecycleConfigurationResult, AWSError>;
/**
* This API operation gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon Simple Storage Service API. Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon Simple Storage Service Developer Guide. To use this operation, you must have permission to perform the s3outposts:GetLifecycleConfiguration action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. GetBucketLifecycleConfiguration has the following special error: Error code: NoSuchLifecycleConfiguration Description: The lifecycle configuration does not exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client The following actions are related to GetBucketLifecycleConfiguration: PutBucketLifecycleConfiguration DeleteBucketLifecycleConfiguration
*/
getBucketLifecycleConfiguration(callback?: (err: AWSError, data: S3Control.Types.GetBucketLifecycleConfigurationResult) => void): Request<S3Control.Types.GetBucketLifecycleConfigurationResult, AWSError>;
/**
* This API action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon Simple Storage Service API. Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide. 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 GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. If you don't have s3outposts:GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied 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 405 Method Not Allowed error. 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. For more information about bucket policies, see Using Bucket Policies and User Policies. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to GetBucketPolicy: GetObject PutBucketPolicy DeleteBucketPolicy
*/
getBucketPolicy(params: S3Control.Types.GetBucketPolicyRequest, callback?: (err: AWSError, data: S3Control.Types.GetBucketPolicyResult) => void): Request<S3Control.Types.GetBucketPolicyResult, AWSError>;
/**
* This API action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon Simple Storage Service API. Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide. 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 GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. If you don't have s3outposts:GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied 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 405 Method Not Allowed error. 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. For more information about bucket policies, see Using Bucket Policies and User Policies. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to GetBucketPolicy: GetObject PutBucketPolicy DeleteBucketPolicy
*/
getBucketPolicy(callback?: (err: AWSError, data: S3Control.Types.GetBucketPolicyResult) => void): Request<S3Control.Types.GetBucketPolicyResult, AWSError>;
/**
* This API operation gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon Simple Storage Service API. Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide. To use this operation, you must have permission to perform the GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. GetBucketTagging has the following special error: Error code: NoSuchTagSetError Description: There is no tag set associated with the bucket. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to GetBucketTagging: PutBucketTagging DeleteBucketTagging
*/
getBucketTagging(params: S3Control.Types.GetBucketTaggingRequest, callback?: (err: AWSError, data: S3Control.Types.GetBucketTaggingResult) => void): Request<S3Control.Types.GetBucketTaggingResult, AWSError>;
/**
* This API operation gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon Simple Storage Service API. Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide. To use this operation, you must have permission to perform the GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. GetBucketTagging has the following special error: Error code: NoSuchTagSetError Description: There is no tag set associated with the bucket. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to GetBucketTagging: PutBucketTagging DeleteBucketTagging
*/
getBucketTagging(callback?: (err: AWSError, data: S3Control.Types.GetBucketTaggingResult) => void): Request<S3Control.Types.GetBucketTaggingResult, AWSError>;
/**
* Returns the tags on an S3 Batch Operations job. To use this operation, you must have permission to perform the s3:GetJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob PutJobTagging DeleteJobTagging
*/
getJobTagging(params: S3Control.Types.GetJobTaggingRequest, callback?: (err: AWSError, data: S3Control.Types.GetJobTaggingResult) => void): Request<S3Control.Types.GetJobTaggingResult, AWSError>;
/**
* Returns the tags on an S3 Batch Operations job. To use this operation, you must have permission to perform the s3:GetJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob PutJobTagging DeleteJobTagging
*/
getJobTagging(callback?: (err: AWSError, data: S3Control.Types.GetJobTaggingResult) => void): Request<S3Control.Types.GetJobTaggingResult, AWSError>;
/**
* Retrieves the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access. Related actions include: DeletePublicAccessBlock PutPublicAccessBlock
*/
getPublicAccessBlock(params: S3Control.Types.GetPublicAccessBlockRequest, callback?: (err: AWSError, data: S3Control.Types.GetPublicAccessBlockOutput) => void): Request<S3Control.Types.GetPublicAccessBlockOutput, AWSError>;
/**
* Retrieves the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access. Related actions include: DeletePublicAccessBlock PutPublicAccessBlock
*/
getPublicAccessBlock(callback?: (err: AWSError, data: S3Control.Types.GetPublicAccessBlockOutput) => void): Request<S3Control.Types.GetPublicAccessBlockOutput, AWSError>;
/**
* Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to ListAccessPoints: CreateAccessPoint DeleteAccessPoint GetAccessPoint
*/
listAccessPoints(params: S3Control.Types.ListAccessPointsRequest, callback?: (err: AWSError, data: S3Control.Types.ListAccessPointsResult) => void): Request<S3Control.Types.ListAccessPointsResult, AWSError>;
/**
* Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to ListAccessPoints: CreateAccessPoint DeleteAccessPoint GetAccessPoint
*/
listAccessPoints(callback?: (err: AWSError, data: S3Control.Types.ListAccessPointsResult) => void): Request<S3Control.Types.ListAccessPointsResult, AWSError>;
/**
* Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob DescribeJob UpdateJobPriority UpdateJobStatus
*/
listJobs(params: S3Control.Types.ListJobsRequest, callback?: (err: AWSError, data: S3Control.Types.ListJobsResult) => void): Request<S3Control.Types.ListJobsResult, AWSError>;
/**
* Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob DescribeJob UpdateJobPriority UpdateJobStatus
*/
listJobs(callback?: (err: AWSError, data: S3Control.Types.ListJobsResult) => void): Request<S3Control.Types.ListJobsResult, AWSError>;
/**
* Returns a list of all Outposts buckets in an Outposts that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and outpost-id in your API request, see the Example section below.
*/
listRegionalBuckets(params: S3Control.Types.ListRegionalBucketsRequest, callback?: (err: AWSError, data: S3Control.Types.ListRegionalBucketsResult) => void): Request<S3Control.Types.ListRegionalBucketsResult, AWSError>;
/**
* Returns a list of all Outposts buckets in an Outposts that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and outpost-id in your API request, see the Example section below.
*/
listRegionalBuckets(callback?: (err: AWSError, data: S3Control.Types.ListRegionalBucketsResult) => void): Request<S3Control.Types.ListRegionalBucketsResult, AWSError>;
/**
* Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to PutAccessPointPolicy: GetAccessPointPolicy DeleteAccessPointPolicy
*/
putAccessPointPolicy(params: S3Control.Types.PutAccessPointPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to PutAccessPointPolicy: GetAccessPointPolicy DeleteAccessPointPolicy
*/
putAccessPointPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This API action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon Simple Storage Service API. Creates a new lifecycle configuration for the Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets can only support a lifecycle that deletes objects after a certain period of time. For more information, see Managing Lifecycle Permissions for Amazon S3 on Outposts. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to PutBucketLifecycleConfiguration: GetBucketLifecycleConfiguration DeleteBucketLifecycleConfiguration
*/
putBucketLifecycleConfiguration(params: S3Control.Types.PutBucketLifecycleConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This API action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon Simple Storage Service API. Creates a new lifecycle configuration for the Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets can only support a lifecycle that deletes objects after a certain period of time. For more information, see Managing Lifecycle Permissions for Amazon S3 on Outposts. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to PutBucketLifecycleConfiguration: GetBucketLifecycleConfiguration DeleteBucketLifecycleConfiguration
*/
putBucketLifecycleConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This API action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon Simple Storage Service API. Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide. If you are using an identity other than the root user of the AWS account that owns the Outposts bucket, the calling identity must have the PutBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this operation. If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied 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 405 Method Not Allowed error. 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. For more information about bucket policies, see Using Bucket Policies and User Policies. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to PutBucketPolicy: GetBucketPolicy DeleteBucketPolicy
*/
putBucketPolicy(params: S3Control.Types.PutBucketPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This API action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon Simple Storage Service API. Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide. If you are using an identity other than the root user of the AWS account that owns the Outposts bucket, the calling identity must have the PutBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this operation. If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied 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 405 Method Not Allowed error. 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. For more information about bucket policies, see Using Bucket Policies and User Policies. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to PutBucketPolicy: GetBucketPolicy DeleteBucketPolicy
*/
putBucketPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This API action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon Simple Storage Service API. Sets the tags for an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide. 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 Cost Allocation and Tagging. 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 Using Cost Allocation in Amazon S3 Bucket Tags. To use this operation, you must have permissions to perform the s3outposts:PutBucketTagging action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. PutBucketTagging has the following special errors: Error code: InvalidTagError 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 User-Defined Tag Restrictions and AWS-Generated Cost Allocation Tag Restrictions. Error code: MalformedXMLError Description: The XML provided does not match the schema. Error code: OperationAbortedError Description: A conflicting conditional operation is currently in progress against this resource. Try again. Error code: InternalError Description: The service was unable to apply the provided tag to the bucket. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to PutBucketTagging: GetBucketTagging DeleteBucketTagging
*/
putBucketTagging(params: S3Control.Types.PutBucketTaggingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* This API action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon Simple Storage Service API. Sets the tags for an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide. 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 Cost Allocation and Tagging. 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 Using Cost Allocation in Amazon S3 Bucket Tags. To use this operation, you must have permissions to perform the s3outposts:PutBucketTagging action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. PutBucketTagging has the following special errors: Error code: InvalidTagError 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 User-Defined Tag Restrictions and AWS-Generated Cost Allocation Tag Restrictions. Error code: MalformedXMLError Description: The XML provided does not match the schema. Error code: OperationAbortedError Description: A conflicting conditional operation is currently in progress against this resource. Try again. Error code: InternalError Description: The service was unable to apply the provided tag to the bucket. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below. The following actions are related to PutBucketTagging: GetBucketTagging DeleteBucketTagging
*/
putBucketTagging(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the supplied tag-set on an S3 Batch Operations job. A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this API action to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags in the Amazon Simple Storage Service Developer Guide. If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing. For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same result without incurring charges. A few things to consider about using tags: Amazon S3 limits the maximum number of tags to 50 tags per job. You can associate up to 50 tags with a job as long as they have unique tag keys. A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length. The key and values are case sensitive. For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide. To use this operation, you must have permission to perform the s3:PutJobTagging action. Related actions include: CreatJob GetJobTagging DeleteJobTagging
*/
putJobTagging(params: S3Control.Types.PutJobTaggingRequest, callback?: (err: AWSError, data: S3Control.Types.PutJobTaggingResult) => void): Request<S3Control.Types.PutJobTaggingResult, AWSError>;
/**
* Sets the supplied tag-set on an S3 Batch Operations job. A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this API action to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags in the Amazon Simple Storage Service Developer Guide. If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing. For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same result without incurring charges. A few things to consider about using tags: Amazon S3 limits the maximum number of tags to 50 tags per job. You can associate up to 50 tags with a job as long as they have unique tag keys. A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length. The key and values are case sensitive. For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide. To use this operation, you must have permission to perform the s3:PutJobTagging action. Related actions include: CreatJob GetJobTagging DeleteJobTagging
*/
putJobTagging(callback?: (err: AWSError, data: S3Control.Types.PutJobTaggingResult) => void): Request<S3Control.Types.PutJobTaggingResult, AWSError>;
/**
* Creates or modifies the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access. Related actions include: GetPublicAccessBlock DeletePublicAccessBlock
*/
putPublicAccessBlock(params: S3Control.Types.PutPublicAccessBlockRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates or modifies the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access. Related actions include: GetPublicAccessBlock DeletePublicAccessBlock
*/
putPublicAccessBlock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob ListJobs DescribeJob UpdateJobStatus
*/
updateJobPriority(params: S3Control.Types.UpdateJobPriorityRequest, callback?: (err: AWSError, data: S3Control.Types.UpdateJobPriorityResult) => void): Request<S3Control.Types.UpdateJobPriorityResult, AWSError>;
/**
* Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob ListJobs DescribeJob UpdateJobStatus
*/
updateJobPriority(callback?: (err: AWSError, data: S3Control.Types.UpdateJobPriorityResult) => void): Request<S3Control.Types.UpdateJobPriorityResult, AWSError>;
/**
* Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob ListJobs DescribeJob UpdateJobStatus
*/
updateJobStatus(params: S3Control.Types.UpdateJobStatusRequest, callback?: (err: AWSError, data: S3Control.Types.UpdateJobStatusResult) => void): Request<S3Control.Types.UpdateJobStatusResult, AWSError>;
/**
* Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob ListJobs DescribeJob UpdateJobStatus
*/
updateJobStatus(callback?: (err: AWSError, data: S3Control.Types.UpdateJobStatusResult) => void): Request<S3Control.Types.UpdateJobStatusResult, AWSError>;
}
declare namespace S3Control {
export interface AbortIncompleteMultipartUpload {
/**
* Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload to the Outposts bucket.
*/
DaysAfterInitiation?: DaysAfterInitiation;
}
export interface AccessPoint {
/**
* The name of this access point.
*/
Name: AccessPointName;
/**
* Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies.
*/
NetworkOrigin: NetworkOrigin;
/**
* The virtual private cloud (VPC) configuration for this access point, if one exists.
*/
VpcConfiguration?: VpcConfiguration;
/**
* The name of the bucket associated with this access point.
*/
Bucket: BucketName;
/**
* The ARN for the access point.
*/
AccessPointArn?: S3AccessPointArn;
}
export type AccessPointList = AccessPoint[];
export type AccessPointName = string;
export type AccountId = string;
export type Boolean = boolean;
export type BucketCannedACL = "private"|"public-read"|"public-read-write"|"authenticated-read"|string;
export type BucketLocationConstraint = "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"|string;
export type BucketName = string;
export type ConfirmRemoveSelfBucketAccess = boolean;
export type ConfirmationRequired = boolean;
export interface CreateAccessPointRequest {
/**
* The AWS account ID for the owner of the bucket for which you want to create an access point.
*/
AccountId: AccountId;
/**
* The name you want to assign to this access point.
*/
Name: AccessPointName;
/**
* The name of the bucket that you want to associate this access point with. For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
*/
Bucket: BucketName;
/**
* If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC). This is required for creating an access point for Amazon S3 on Outposts buckets.
*/
VpcConfiguration?: VpcConfiguration;
PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
}
export interface CreateAccessPointResult {
/**
* The ARN of the access point.
*/
AccessPointArn?: S3AccessPointArn;
}
export interface CreateBucketConfiguration {
/**
* 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. This is not supported by Amazon S3 on Outposts buckets.
*/
LocationConstraint?: BucketLocationConstraint;
}
export interface CreateBucketRequest {
/**
* The canned ACL to apply to the bucket. This is not supported by Amazon S3 on Outposts buckets.
*/
ACL?: BucketCannedACL;
/**
* The name of the bucket.
*/
Bucket: BucketName;
/**
* The configuration information for the bucket. This is not supported by Amazon S3 on Outposts buckets.
*/
CreateBucketConfiguration?: CreateBucketConfiguration;
/**
* Allows grantee the read, write, read ACP, and write ACP permissions on the bucket. This is not supported by Amazon S3 on Outposts buckets.
*/
GrantFullControl?: GrantFullControl;
/**
* Allows grantee to list the objects in the bucket. This is not supported by Amazon S3 on Outposts buckets.
*/
GrantRead?: GrantRead;
/**
* Allows grantee to read the bucket ACL. This is not supported by Amazon S3 on Outposts buckets.
*/
GrantReadACP?: GrantReadACP;
/**
* Allows grantee to create, overwrite, and delete any object in the bucket. This is not supported by Amazon S3 on Outposts buckets.
*/
GrantWrite?: GrantWrite;
/**
* Allows grantee to write the ACL for the applicable bucket. This is not supported by Amazon S3 on Outposts buckets.
*/
GrantWriteACP?: GrantWriteACP;
/**
* Specifies whether you want S3 Object Lock to be enabled for the new bucket. This is not supported by Amazon S3 on Outposts buckets.
*/
ObjectLockEnabledForBucket?: ObjectLockEnabledForBucket;
/**
* The ID of the Outposts where the bucket is being created. This is required by Amazon S3 on Outposts buckets.
*/
OutpostId?: NonEmptyMaxLength64String;
}
export interface CreateBucketResult {
/**
* The location of the bucket.
*/
Location?: Location;
/**
* The Amazon Resource Name (ARN) of the bucket. For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
*/
BucketArn?: S3RegionalBucketArn;
}
export interface CreateJobRequest {
/**
* The AWS account ID that creates the job.
*/
AccountId: AccountId;
/**
* Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.
*/
ConfirmationRequired?: ConfirmationRequired;
/**
* The operation that you want this job to perform on each object listed in the manifest. For more information about the available operations, see Operations in the Amazon Simple Storage Service Developer Guide.
*/
Operation: JobOperation;
/**
* Configuration parameters for the optional job-completion report.
*/
Report: JobReport;
/**
* An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.
*/
ClientRequestToken: NonEmptyMaxLength64String;
/**
* Configuration parameters for the manifest.
*/
Manifest: JobManifest;
/**
* A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.
*/
Description?: NonEmptyMaxLength256String;
/**
* The numerical priority for this job. Higher numbers indicate higher priority.
*/
Priority: JobPriority;
/**
* The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that Batch Operations will use to run this job's operation on each object in the manifest.
*/
RoleArn: IAMRoleArn;
/**
* A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.
*/
Tags?: S3TagSet;
}
export interface CreateJobResult {
/**
* The ID for this job. Amazon S3 generates this ID automatically and returns it after a successful Create Job request.
*/
JobId?: JobId;
}
export type CreationDate = Date;
export type _Date = Date;
export type Days = number;
export type DaysAfterInitiation = number;
export interface DeleteAccessPointPolicyRequest {
/**
* The account ID for the account that owns the specified access point.
*/
AccountId: AccountId;
/**
* The name of the access point whose policy you want to delete. For Amazon S3 on Outposts specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.
*/
Name: AccessPointName;
}
export interface DeleteAccessPointRequest {
/**
* The account ID for the account that owns the specified access point.
*/
AccountId: AccountId;
/**
* The name of the access point you want to delete. For Amazon S3 on Outposts specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.
*/
Name: AccessPointName;
}
export interface DeleteBucketLifecycleConfigurationRequest {
/**
* The account ID of the lifecycle configuration to delete.
*/
AccountId: AccountId;
/**
* The bucket ARN of the bucket. For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
*/
Bucket: BucketName;
}
export interface DeleteBucketPolicyRequest {
/**
* The account ID of the Outposts bucket.
*/
AccountId: AccountId;
/**
* The ARN of the bucket. For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
*/
Bucket: BucketName;
}
export interface DeleteBucketRequest {
/**
* The account ID that owns the Outposts bucket.
*/
AccountId: AccountId;
/**
* Specifies the bucket being deleted. For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
*/
Bucket: BucketName;
}
export interface DeleteBucketTaggingRequest {
/**
* The AWS account ID of the Outposts bucket tag set to be removed.
*/
AccountId: AccountId;
/**
* The bucket ARN that has the tag set to be removed. For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
*/
Bucket: BucketName;
}
export interface DeleteJobTaggingRequest {
/**
* The AWS account ID associated with the S3 Batch Operations job.
*/
AccountId: AccountId;
/**
* The ID for the S3 Batch Operations job whose tags you want to delete.
*/
JobId: JobId;
}
export interface DeleteJobTaggingResult {
}
export interface DeletePublicAccessBlockRequest {
/**
* The account ID for the AWS account whose PublicAccessBlock configuration you want to remove.
*/
AccountId: AccountId;
}
export interface DescribeJobRequest {
/**
*
*/
AccountId: AccountId;
/**
* The ID for the job whose information you want to retrieve.
*/
JobId: JobId;
}
export interface DescribeJobResult {
/**
* Contains the configuration parameters and status for the job specified in the Describe Job request.
*/
Job?: JobDescriptor;
}
export type ExpirationStatus = "Enabled"|"Disabled"|string;
export type ExpiredObjectDeleteMarker = boolean;
export type FunctionArnString = string;
export interface GetAccessPointPolicyRequest {
/**
* The account ID for the account that owns the specified access point.
*/
AccountId: AccountId;
/**
* The name of the access point whose policy you want to retrieve. For Amazon S3 on Outposts specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.
*/
Name: AccessPointName;
}
export interface GetAccessPointPolicyResult {
/**
* The access point policy associated with the specified access point.
*/
Policy?: Policy;
}
export interface GetAccessPointPolicyStatusRequest {
/**
* The account ID for the account that owns the specified access point.
*/
AccountId: AccountId;
/**
* The name of the access point whose policy status you want to retrieve.
*/
Name: AccessPointName;
}
export interface GetAccessPointPolicyStatusResult {
/**
* Indicates the current policy status of the specified access point.
*/
PolicyStatus?: PolicyStatus;
}
export interface GetAccessPointRequest {
/**
* The account ID for the account that owns the specified access point.
*/
AccountId: AccountId;
/**
* The name of the access point whose configuration information you want to retrieve. For Amazon S3 on Outposts specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.
*/
Name: AccessPointName;
}
export interface GetAccessPointResult {
/**
* The name of the specified access point.
*/
Name?: AccessPointName;
/**
* The name of the bucket associated with the specified access point.
*/
Bucket?: BucketName;
/**
* Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies. This will always be true for an Amazon S3 on Outposts access point
*/
NetworkOrigin?: NetworkOrigin;
/**
* Contains the virtual private cloud (VPC) configuration for the specified access point.
*/
VpcConfiguration?: VpcConfiguration;
PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
/**
* The date and time when the specified access point was created.
*/
CreationDate?: CreationDate;
}
export interface GetBucketLifecycleConfigurationRequest {
/**
* The AWS account ID of the Outposts bucket.
*/
AccountId: AccountId;
/**
* The Amazon Resource Name (ARN) of the bucket. For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
*/
Bucket: BucketName;
}
export interface GetBucketLifecycleConfigurationResult {
/**
* Container for the lifecycle rule of the Outposts bucket.
*/
Rules?: LifecycleRules;
}
export interface GetBucketPolicyRequest {
/**
* The AWS account ID of the Outposts bucket.
*/
AccountId: AccountId;
/**
* The ARN of the bucket. For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
*/
Bucket: BucketName;
}
export interface GetBucketPolicyResult {
/**
* The policy of the Outposts bucket.
*/
Policy?: Policy;
}
export interface GetBucketRequest {
/**
* The AWS account ID of the Outposts bucket.
*/
AccountId: AccountId;
/**
* The ARN of the bucket. For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
*/
Bucket: BucketName;
}
export interface GetBucketResult {
/**
* The Outposts bucket requested.
*/
Bucket?: BucketName;
/**
*
*/
PublicAccessBlockEnabled?: PublicAccessBlockEnabled;
/**
* The creation date of the Outposts bucket.
*/
CreationDate?: CreationDate;
}
export interface GetBucketTaggingRequest {
/**
* The AWS account ID of the Outposts bucket.
*/
AccountId: AccountId;
/**
* The ARN of the bucket. For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
*/
Bucket: BucketName;
}
export interface GetBucketTaggingResult {
/**
* The tags set of the Outposts bucket.
*/
TagSet: S3TagSet;
}
export interface GetJobTaggingRequest {
/**
* The AWS account ID associated with the S3 Batch Operations job.
*/
AccountId: AccountId;
/**
* The ID for the S3 Batch Operations job whose tags you want to retrieve.
*/
JobId: JobId;
}
export interface GetJobTaggingResult {
/**
* The set of tags associated with the S3 Batch Operations job.
*/
Tags?: S3TagSet;
}
export interface GetPublicAccessBlockOutput {
/**
* The PublicAccessBlock configuration currently in effect for this AWS account.
*/
PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
}
export interface GetPublicAccessBlockRequest {
/**
* The account ID for the AWS account whose PublicAccessBlock configuration you want to retrieve.
*/
AccountId: AccountId;
}
export type GrantFullControl = string;
export type GrantRead = string;
export type GrantReadACP = string;
export type GrantWrite = string;
export type GrantWriteACP = string;
export type IAMRoleArn = string;
export type ID = string;
export type IsPublic = boolean;
export type JobArn = string;
export type JobCreationTime = Date;
export interface JobDescriptor {
/**
* The ID for the specified job.
*/
JobId?: JobId;
/**
* Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.
*/
ConfirmationRequired?: ConfirmationRequired;
/**
* The description for this job, if one was provided in this job's Create Job request.
*/
Description?: NonEmptyMaxLength256String;
/**
* The Amazon Resource Name (ARN) for this job.
*/
JobArn?: JobArn;
/**
* The current status of the specified job.
*/
Status?: JobStatus;
/**
* The configuration information for the specified job's manifest object.
*/
Manifest?: JobManifest;
/**
* The operation that the specified job is configured to run on the objects listed in the manifest.
*/
Operation?: JobOperation;
/**
* The priority of the specified job.
*/
Priority?: JobPriority;
/**
* Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.
*/
ProgressSummary?: JobProgressSummary;
/**
* The reason for updating the job.
*/
StatusUpdateReason?: JobStatusUpdateReason;
/**
* If the specified job failed, this field contains information describing the failure.
*/
FailureReasons?: JobFailureList;
/**
* Contains the configuration information for the job-completion report if you requested one in the Create Job request.
*/
Report?: JobReport;
/**
* A timestamp indicating when this job was created.
*/
CreationTime?: JobCreationTime;
/**
* A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
*/
TerminationDate?: JobTerminationDate;
/**
* The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.
*/
RoleArn?: IAMRoleArn;
/**
* The timestamp when this job was suspended, if it has been suspended.
*/
SuspendedDate?: SuspendedDate;
/**
* The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.
*/
SuspendedCause?: SuspendedCause;
}
export interface JobFailure {
/**
* The failure code, if any, for the specified job.
*/
FailureCode?: JobFailureCode;
/**
* The failure reason, if any, for the specified job.
*/
FailureReason?: JobFailureReason;
}
export type JobFailureCode = string;
export type JobFailureList = JobFailure[];
export type JobFailureReason = string;
export type JobId = string;
export interface JobListDescriptor {
/**
* The ID for the specified job.
*/
JobId?: JobId;
/**
* The user-specified description that was included in the specified job's Create Job request.
*/
Description?: NonEmptyMaxLength256String;
/**
* The operation that the specified job is configured to run on each object listed in the manifest.
*/
Operation?: OperationName;
/**
* The current priority for the specified job.
*/
Priority?: JobPriority;
/**
* The specified job's current status.
*/
Status?: JobStatus;
/**
* A timestamp indicating when the specified job was created.
*/
CreationTime?: JobCreationTime;
/**
* A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
*/
TerminationDate?: JobTerminationDate;
/**
* Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.
*/
ProgressSummary?: JobProgressSummary;
}
export type JobListDescriptorList = JobListDescriptor[];
export interface JobManifest {
/**
* Describes the format of the specified job's manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.
*/
Spec: JobManifestSpec;
/**
* Contains the information required to locate the specified job's manifest.
*/
Location: JobManifestLocation;
}
export type JobManifestFieldList = JobManifestFieldName[];
export type JobManifestFieldName = "Ignore"|"Bucket"|"Key"|"VersionId"|string;
export type JobManifestFormat = "S3BatchOperations_CSV_20180820"|"S3InventoryReport_CSV_20161130"|string;
export interface JobManifestLocation {
/**
* The Amazon Resource Name (ARN) for a manifest object.
*/
ObjectArn: S3KeyArnString;
/**
* The optional version ID to identify a specific version of the manifest object.
*/
ObjectVersionId?: S3ObjectVersionId;
/**
* The ETag for the specified manifest object.
*/
ETag: NonEmptyMaxLength1024String;
}
export interface JobManifestSpec {
/**
* Indicates which of the available formats the specified manifest uses.
*/
Format: JobManifestFormat;
/**
* If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.
*/
Fields?: JobManifestFieldList;
}
export type JobNumberOfTasksFailed = number;
export type JobNumberOfTasksSucceeded = number;
export interface JobOperation {
/**
* Directs the specified job to invoke an AWS Lambda function on each object in the manifest.
*/
LambdaInvoke?: LambdaInvokeOperation;
/**
* Directs the specified job to run a PUT Copy object call on each object in the manifest.
*/
S3PutObjectCopy?: S3CopyObjectOperation;
/**
* Directs the specified job to run a PUT Object acl call on each object in the manifest.
*/
S3PutObjectAcl?: S3SetObjectAclOperation;
/**
* Directs the specified job to run a PUT Object tagging call on each object in the manifest.
*/
S3PutObjectTagging?: S3SetObjectTaggingOperation;
/**
* Directs the specified job to run an Initiate Glacier Restore call on each object in the manifest.
*/
S3InitiateRestoreObject?: S3InitiateRestoreObjectOperation;
S3PutObjectLegalHold?: S3SetObjectLegalHoldOperation;
S3PutObjectRetention?: S3SetObjectRetentionOperation;
}
export type JobPriority = number;
export interface JobProgressSummary {
/**
*
*/
TotalNumberOfTasks?: JobTotalNumberOfTasks;
/**
*
*/
NumberOfTasksSucceeded?: JobNumberOfTasksSucceeded;
/**
*
*/
NumberOfTasksFailed?: JobNumberOfTasksFailed;
}
export interface JobReport {
/**
* The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.
*/
Bucket?: S3BucketArnString;
/**
* The format of the specified job-completion report.
*/
Format?: JobReportFormat;
/**
* Indicates whether the specified job will generate a job-completion report.
*/
Enabled: Boolean;
/**
* An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.
*/
Prefix?: ReportPrefixString;
/**
* Indicates whether the job-completion report will include details of all tasks or only failed tasks.
*/
ReportScope?: JobReportScope;
}
export type JobReportFormat = "Report_CSV_20180820"|string;
export type JobReportScope = "AllTasks"|"FailedTasksOnly"|string;
export type JobStatus = "Active"|"Cancelled"|"Cancelling"|"Complete"|"Completing"|"Failed"|"Failing"|"New"|"Paused"|"Pausing"|"Preparing"|"Ready"|"Suspended"|string;
export type JobStatusList = JobStatus[];
export type JobStatusUpdateReason = string;
export type JobTerminationDate = Date;
export type JobTotalNumberOfTasks = number;
export type KmsKeyArnString = string;
export interface LambdaInvokeOperation {
/**
* The Amazon Resource Name (ARN) for the AWS Lambda function that the specified job will invoke for each object in the manifest.
*/
FunctionArn?: FunctionArnString;
}
export interface LifecycleConfiguration {
/**
* A lifecycle rule for individual objects in an Outposts bucket.
*/
Rules?: LifecycleRules;
}
export interface LifecycleExpiration {
/**
* Indicates at what date the object is to be deleted. Should be in GMT ISO 8601 format.
*/
Date?: _Date;
/**
* Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
*/
Days?: Days;
/**
* 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.
*/
ExpiredObjectDeleteMarker?: ExpiredObjectDeleteMarker;
}
export interface LifecycleRule {
/**
* Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.
*/
Expiration?: LifecycleExpiration;
/**
* Unique identifier for the rule. The value cannot be longer than 255 characters.
*/
ID?: ID;
/**
* The container for the filter of lifecycle rule.
*/
Filter?: LifecycleRuleFilter;
/**
* If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
*/
Status: ExpirationStatus;
/**
* Specifies when an Amazon S3 object transitions to a specified storage class. This is not supported by Amazon S3 on Outposts buckets.
*/
Transitions?: TransitionList;
/**
* 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. This is not supported by Amazon S3 on Outposts buckets.
*/
NoncurrentVersionTransitions?: NoncurrentVersionTransitionList;
/**
* The noncurrent version expiration of the lifecycle rule. This is not supported by Amazon S3 on Outposts buckets.
*/
NoncurrentVersionExpiration?: NoncurrentVersionExpiration;
/**
* Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon Simple Storage Service Developer Guide.
*/
AbortIncompleteMultipartUpload?: AbortIncompleteMultipartUpload;
}
export interface LifecycleRuleAndOperator {
/**
* Prefix identifying one or more objects to which the rule applies.
*/
Prefix?: Prefix;
/**
* All of these tags must exist in the object's tag set in order for the rule to apply.
*/
Tags?: S3TagSet;
}
export interface LifecycleRuleFilter {
/**
* Prefix identifying one or more objects to which the rule applies.
*/
Prefix?: Prefix;
Tag?: S3Tag;
/**
* The container for the AND condition for the lifecycle rule.
*/
And?: LifecycleRuleAndOperator;
}
export type LifecycleRules = LifecycleRule[];
export interface ListAccessPointsRequest {
/**
* The AWS account ID for owner of the bucket whose access points you want to list.
*/
AccountId: AccountId;
/**
* The name of the bucket whose associated access points you want to list. For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
*/
Bucket?: BucketName;
/**
* A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.
*/
NextToken?: NonEmptyMaxLength1024String;
/**
* The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.
*/
MaxResults?: MaxResults;
}
export interface ListAccessPointsResult {
/**
* Contains identification and configuration information for one or more access points associated with the specified bucket.
*/
AccessPointList?: AccessPointList;
/**
* If the specified bucket has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.
*/
NextToken?: NonEmptyMaxLength1024String;
}
export interface ListJobsRequest {
/**
*
*/
AccountId: AccountId;
/**
* The List Jobs request returns jobs that match the statuses listed in this element.
*/
JobStatuses?: JobStatusList;
/**
* A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.
*/
NextToken?: StringForNextToken;
/**
* The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.
*/
MaxResults?: MaxResults;
}
export interface ListJobsResult {
/**
* If the List Jobs request produced more than the maximum number of results, you can pass this value into a subsequent List Jobs request in order to retrieve the next page of results.
*/
NextToken?: StringForNextToken;
/**
* The list of current jobs and jobs that have ended within the last 30 days.
*/
Jobs?: JobListDescriptorList;
}
export interface ListRegionalBucketsRequest {
/**
* The AWS account ID of the Outposts bucket.
*/
AccountId: AccountId;
/**
*
*/
NextToken?: NonEmptyMaxLength1024String;
/**
*
*/
MaxResults?: MaxResults;
/**
* The ID of the AWS Outposts. This is required by Amazon S3 on Outposts buckets.
*/
OutpostId?: NonEmptyMaxLength64String;
}
export interface ListRegionalBucketsResult {
/**
*
*/
RegionalBucketList?: RegionalBucketList;
/**
* NextToken is sent when isTruncated is true, which means there are more buckets that can be listed. The next list requests to Amazon S3 can be continued with this NextToken. NextToken is obfuscated and is not a real key.
*/
NextToken?: NonEmptyMaxLength1024String;
}
export type Location = string;
export type MaxLength1024String = string;
export type MaxResults = number;
export type NetworkOrigin = "Internet"|"VPC"|string;
export type NonEmptyMaxLength1024String = string;
export type NonEmptyMaxLength2048String = string;
export type NonEmptyMaxLength256String = string;
export type NonEmptyMaxLength64String = string;
export interface NoncurrentVersionExpiration {
/**
* 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 How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.
*/
NoncurrentDays?: Days;
}
export interface NoncurrentVersionTransition {
/**
* 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 How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon Simple Storage Service Developer Guide.
*/
NoncurrentDays?: Days;
/**
* The class of storage used to store the object.
*/
StorageClass?: TransitionStorageClass;
}
export type NoncurrentVersionTransitionList = NoncurrentVersionTransition[];
export type ObjectLockEnabledForBucket = boolean;
export type OperationName = "LambdaInvoke"|"S3PutObjectCopy"|"S3PutObjectAcl"|"S3PutObjectTagging"|"S3InitiateRestoreObject"|"S3PutObjectLegalHold"|"S3PutObjectRetention"|string;
export type Policy = string;
export interface PolicyStatus {
/**
*
*/
IsPublic?: IsPublic;
}
export type Prefix = string;
export interface PublicAccessBlockConfiguration {
/**
* Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior: PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. PUT Object calls fail if the request includes a public ACL. PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs. This is not supported for Amazon S3 on Outposts.
*/
BlockPublicAcls?: Setting;
/**
* Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set. This is not supported for Amazon S3 on Outposts.
*/
IgnorePublicAcls?: Setting;
/**
* Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies. This is not supported for Amazon S3 on Outposts.
*/
BlockPublicPolicy?: Setting;
/**
* Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS services and authorized users within this account. 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. This is not supported for Amazon S3 on Outposts.
*/
RestrictPublicBuckets?: Setting;
}
export type PublicAccessBlockEnabled = boolean;
export interface PutAccessPointPolicyRequest {
/**
* The AWS account ID for owner of the bucket associated with the specified access point.
*/
AccountId: AccountId;
/**
* The name of the access point that you want to associate with the specified policy. For Amazon S3 on Outposts specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.
*/
Name: AccessPointName;
/**
* The policy that you want to apply to the specified access point. For more information about access point policies, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
*/
Policy: Policy;
}
export interface PutBucketLifecycleConfigurationRequest {
/**
* The AWS account ID of the Outposts bucket.
*/
AccountId: AccountId;
/**
* The name of the bucket for which to set the configuration.
*/
Bucket: BucketName;
/**
* Container for lifecycle rules. You can add as many as 1,000 rules.
*/
LifecycleConfiguration?: LifecycleConfiguration;
}
export interface PutBucketPolicyRequest {
/**
* The AWS account ID of the Outposts bucket.
*/
AccountId: AccountId;
/**
* The ARN of the bucket. For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
*/
Bucket: BucketName;
/**
* Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future. This is not supported by Amazon S3 on Outposts buckets.
*/
ConfirmRemoveSelfBucketAccess?: ConfirmRemoveSelfBucketAccess;
/**
* The bucket policy as a JSON document.
*/
Policy: Policy;
}
export interface PutBucketTaggingRequest {
/**
* The AWS account ID of the Outposts bucket.
*/
AccountId: AccountId;
/**
* The Amazon Resource Name (ARN) of the bucket. For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
*/
Bucket: BucketName;
/**
*
*/
Tagging: Tagging;
}
export interface PutJobTaggingRequest {
/**
* The AWS account ID associated with the S3 Batch Operations job.
*/
AccountId: AccountId;
/**
* The ID for the S3 Batch Operations job whose tags you want to replace.
*/
JobId: JobId;
/**
* The set of tags to associate with the S3 Batch Operations job.
*/
Tags: S3TagSet;
}
export interface PutJobTaggingResult {
}
export interface PutPublicAccessBlockRequest {
/**
* The PublicAccessBlock configuration that you want to apply to the specified AWS account.
*/
PublicAccessBlockConfiguration: PublicAccessBlockConfiguration;
/**
* The account ID for the AWS account whose PublicAccessBlock configuration you want to set.
*/
AccountId: AccountId;
}
export interface RegionalBucket {
/**
*
*/
Bucket: BucketName;
/**
* The Amazon Resource Name (ARN) for the regional bucket.
*/
BucketArn?: S3RegionalBucketArn;
/**
*
*/
PublicAccessBlockEnabled: PublicAccessBlockEnabled;
/**
* The creation date of the regional bucket
*/
CreationDate: CreationDate;
/**
* The AWS Outposts ID of the regional bucket.
*/
OutpostId?: NonEmptyMaxLength64String;
}
export type RegionalBucketList = RegionalBucket[];
export type ReportPrefixString = string;
export type RequestedJobStatus = "Cancelled"|"Ready"|string;
export interface S3AccessControlList {
/**
*
*/
Owner: S3ObjectOwner;
/**
*
*/
Grants?: S3GrantList;
}
export interface S3AccessControlPolicy {
/**
*
*/
AccessControlList?: S3AccessControlList;
/**
*
*/
CannedAccessControlList?: S3CannedAccessControlList;
}
export type S3AccessPointArn = string;
export type S3BucketArnString = string;
export type S3CannedAccessControlList = "private"|"public-read"|"public-read-write"|"aws-exec-read"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control"|string;
export type S3ContentLength = number;
export interface S3CopyObjectOperation {
/**
*
*/
TargetResource?: S3BucketArnString;
/**
*
*/
CannedAccessControlList?: S3CannedAccessControlList;
/**
*
*/
AccessControlGrants?: S3GrantList;
/**
*
*/
MetadataDirective?: S3MetadataDirective;
/**
*
*/
ModifiedSinceConstraint?: TimeStamp;
/**
*
*/
NewObjectMetadata?: S3ObjectMetadata;
/**
*
*/
NewObjectTagging?: S3TagSet;
/**
*
*/
RedirectLocation?: NonEmptyMaxLength2048String;
/**
*
*/
RequesterPays?: Boolean;
/**
*
*/
StorageClass?: S3StorageClass;
/**
*
*/
UnModifiedSinceConstraint?: TimeStamp;
/**
*
*/
SSEAwsKmsKeyId?: KmsKeyArnString;
/**
*
*/
TargetKeyPrefix?: NonEmptyMaxLength1024String;
/**
* The legal hold status to be applied to all objects in the Batch Operations job.
*/
ObjectLockLegalHoldStatus?: S3ObjectLockLegalHoldStatus;
/**
* The retention mode to be applied to all objects in the Batch Operations job.
*/
ObjectLockMode?: S3ObjectLockMode;
/**
* The date when the applied object retention configuration expires on all objects in the Batch Operations job.
*/
ObjectLockRetainUntilDate?: TimeStamp;
}
export type S3ExpirationInDays = number;
export type S3GlacierJobTier = "BULK"|"STANDARD"|string;
export interface S3Grant {
/**
*
*/
Grantee?: S3Grantee;
/**
*
*/
Permission?: S3Permission;
}
export type S3GrantList = S3Grant[];
export interface S3Grantee {
/**
*
*/
TypeIdentifier?: S3GranteeTypeIdentifier;
/**
*
*/
Identifier?: NonEmptyMaxLength1024String;
/**
*
*/
DisplayName?: NonEmptyMaxLength1024String;
}
export type S3GranteeTypeIdentifier = "id"|"emailAddress"|"uri"|string;
export interface S3InitiateRestoreObjectOperation {
/**
*
*/
ExpirationInDays?: S3ExpirationInDays;
/**
*
*/
GlacierJobTier?: S3GlacierJobTier;
}
export type S3KeyArnString = string;
export type S3MetadataDirective = "COPY"|"REPLACE"|string;
export interface S3ObjectLockLegalHold {
/**
* The Object Lock legal hold status to be applied to all objects in the Batch Operations job.
*/
Status: S3ObjectLockLegalHoldStatus;
}
export type S3ObjectLockLegalHoldStatus = "OFF"|"ON"|string;
export type S3ObjectLockMode = "COMPLIANCE"|"GOVERNANCE"|string;
export type S3ObjectLockRetentionMode = "COMPLIANCE"|"GOVERNANCE"|string;
export interface S3ObjectMetadata {
/**
*
*/
CacheControl?: NonEmptyMaxLength1024String;
/**
*
*/
ContentDisposition?: NonEmptyMaxLength1024String;
/**
*
*/
ContentEncoding?: NonEmptyMaxLength1024String;
/**
*
*/
ContentLanguage?: NonEmptyMaxLength1024String;
/**
*
*/
UserMetadata?: S3UserMetadata;
/**
*
*/
ContentLength?: S3ContentLength;
/**
*
*/
ContentMD5?: NonEmptyMaxLength1024String;
/**
*
*/
ContentType?: NonEmptyMaxLength1024String;
/**
*
*/
HttpExpiresDate?: TimeStamp;
/**
*
*/
RequesterCharged?: Boolean;
/**
*
*/
SSEAlgorithm?: S3SSEAlgorithm;
}
export interface S3ObjectOwner {
/**
*
*/
ID?: NonEmptyMaxLength1024String;
/**
*
*/
DisplayName?: NonEmptyMaxLength1024String;
}
export type S3ObjectVersionId = string;
export type S3Permission = "FULL_CONTROL"|"READ"|"WRITE"|"READ_ACP"|"WRITE_ACP"|string;
export type S3RegionalBucketArn = string;
export interface S3Retention {
/**
* The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.
*/
RetainUntilDate?: TimeStamp;
/**
* The Object Lock retention mode to be applied to all objects in the Batch Operations job.
*/
Mode?: S3ObjectLockRetentionMode;
}
export type S3SSEAlgorithm = "AES256"|"KMS"|string;
export interface S3SetObjectAclOperation {
/**
*
*/
AccessControlPolicy?: S3AccessControlPolicy;
}
export interface S3SetObjectLegalHoldOperation {
/**
* Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.
*/
LegalHold: S3ObjectLockLegalHold;
}
export interface S3SetObjectRetentionOperation {
/**
* Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.
*/
BypassGovernanceRetention?: Boolean;
/**
* Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
*/
Retention: S3Retention;
}
export interface S3SetObjectTaggingOperation {
/**
*
*/
TagSet?: S3TagSet;
}
export type S3StorageClass = "STANDARD"|"STANDARD_IA"|"ONEZONE_IA"|"GLACIER"|"INTELLIGENT_TIERING"|"DEEP_ARCHIVE"|string;
export interface S3Tag {
/**
*
*/
Key: TagKeyString;
/**
*
*/
Value: TagValueString;
}
export type S3TagSet = S3Tag[];
export type S3UserMetadata = {[key: string]: MaxLength1024String};
export type Setting = boolean;
export type StringForNextToken = string;
export type SuspendedCause = string;
export type SuspendedDate = Date;
export type TagKeyString = string;
export type TagValueString = string;
export interface Tagging {
/**
* A collection for a set of tags.
*/
TagSet: S3TagSet;
}
export type TimeStamp = Date;
export interface Transition {
/**
* 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.
*/
Date?: _Date;
/**
* Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.
*/
Days?: Days;
/**
* The storage class to which you want the object to transition.
*/
StorageClass?: TransitionStorageClass;
}
export type TransitionList = Transition[];
export type TransitionStorageClass = "GLACIER"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"DEEP_ARCHIVE"|string;
export interface UpdateJobPriorityRequest {
/**
*
*/
AccountId: AccountId;
/**
* The ID for the job whose priority you want to update.
*/
JobId: JobId;
/**
* The priority you want to assign to this job.
*/
Priority: JobPriority;
}
export interface UpdateJobPriorityResult {
/**
* The ID for the job whose priority Amazon S3 updated.
*/
JobId: JobId;
/**
* The new priority assigned to the specified job.
*/
Priority: JobPriority;
}
export interface UpdateJobStatusRequest {
/**
*
*/
AccountId: AccountId;
/**
* The ID of the job whose status you want to update.
*/
JobId: JobId;
/**
* The status that you want to move the specified job to.
*/
RequestedJobStatus: RequestedJobStatus;
/**
* A description of the reason why you want to change the specified job's status. This field can be any string up to the maximum length.
*/
StatusUpdateReason?: JobStatusUpdateReason;
}
export interface UpdateJobStatusResult {
/**
* The ID for the job whose status was updated.
*/
JobId?: JobId;
/**
* The current status for the specified job.
*/
Status?: JobStatus;
/**
* The reason that the specified job's status was updated.
*/
StatusUpdateReason?: JobStatusUpdateReason;
}
export interface VpcConfiguration {
/**
* If this field is specified, this access point will only allow connections from the specified VPC ID.
*/
VpcId: VpcId;
}
export type VpcId = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2018-08-20"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & UseDualstackConfigOptions & ClientApiVersions;
/**
* Contains interfaces for use with the S3Control client.
*/
export import Types = S3Control;
}
export = S3Control;