@aws-sdk/client-s3-control 3.379.1 → 3.385.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +572 -0
- package/package.json +6 -6
|
@@ -6,6 +6,7 @@ import { S3ControlServiceException as __BaseException } from "./S3ControlService
|
|
|
6
6
|
*/
|
|
7
7
|
export interface AbortIncompleteMultipartUpload {
|
|
8
8
|
/**
|
|
9
|
+
* @public
|
|
9
10
|
* <p>Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload to
|
|
10
11
|
* the Outposts bucket.</p>
|
|
11
12
|
*/
|
|
@@ -31,6 +32,7 @@ export type OwnerOverride = (typeof OwnerOverride)[keyof typeof OwnerOverride];
|
|
|
31
32
|
*/
|
|
32
33
|
export interface AccessControlTranslation {
|
|
33
34
|
/**
|
|
35
|
+
* @public
|
|
34
36
|
* <p>Specifies the replica ownership.</p>
|
|
35
37
|
*/
|
|
36
38
|
Owner: OwnerOverride | string | undefined;
|
|
@@ -53,6 +55,7 @@ export type NetworkOrigin = (typeof NetworkOrigin)[keyof typeof NetworkOrigin];
|
|
|
53
55
|
*/
|
|
54
56
|
export interface VpcConfiguration {
|
|
55
57
|
/**
|
|
58
|
+
* @public
|
|
56
59
|
* <p>If this field is specified, this access point will only allow connections from the specified VPC
|
|
57
60
|
* ID.</p>
|
|
58
61
|
*/
|
|
@@ -64,10 +67,12 @@ export interface VpcConfiguration {
|
|
|
64
67
|
*/
|
|
65
68
|
export interface AccessPoint {
|
|
66
69
|
/**
|
|
70
|
+
* @public
|
|
67
71
|
* <p>The name of this access point.</p>
|
|
68
72
|
*/
|
|
69
73
|
Name: string | undefined;
|
|
70
74
|
/**
|
|
75
|
+
* @public
|
|
71
76
|
* <p>Indicates whether this access point allows access from the public internet. If
|
|
72
77
|
* <code>VpcConfiguration</code> is specified for this access point, then
|
|
73
78
|
* <code>NetworkOrigin</code> is <code>VPC</code>, and the access point doesn't allow access from
|
|
@@ -77,6 +82,7 @@ export interface AccessPoint {
|
|
|
77
82
|
*/
|
|
78
83
|
NetworkOrigin: NetworkOrigin | string | undefined;
|
|
79
84
|
/**
|
|
85
|
+
* @public
|
|
80
86
|
* <p>The virtual private cloud (VPC) configuration for this access point, if one exists.</p>
|
|
81
87
|
* <note>
|
|
82
88
|
* <p>This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other
|
|
@@ -85,18 +91,22 @@ export interface AccessPoint {
|
|
|
85
91
|
*/
|
|
86
92
|
VpcConfiguration?: VpcConfiguration;
|
|
87
93
|
/**
|
|
94
|
+
* @public
|
|
88
95
|
* <p>The name of the bucket associated with this access point.</p>
|
|
89
96
|
*/
|
|
90
97
|
Bucket: string | undefined;
|
|
91
98
|
/**
|
|
99
|
+
* @public
|
|
92
100
|
* <p>The ARN for the access point.</p>
|
|
93
101
|
*/
|
|
94
102
|
AccessPointArn?: string;
|
|
95
103
|
/**
|
|
104
|
+
* @public
|
|
96
105
|
* <p>The name or alias of the access point.</p>
|
|
97
106
|
*/
|
|
98
107
|
Alias?: string;
|
|
99
108
|
/**
|
|
109
|
+
* @public
|
|
100
110
|
* <p>The Amazon Web Services account ID associated with the S3 bucket associated with this access point.</p>
|
|
101
111
|
*/
|
|
102
112
|
BucketAccountId?: string;
|
|
@@ -110,6 +120,7 @@ export interface AccessPoint {
|
|
|
110
120
|
*/
|
|
111
121
|
export interface ActivityMetrics {
|
|
112
122
|
/**
|
|
123
|
+
* @public
|
|
113
124
|
* <p>A container that indicates whether activity metrics are enabled.</p>
|
|
114
125
|
*/
|
|
115
126
|
IsEnabled?: boolean;
|
|
@@ -124,6 +135,7 @@ export interface ActivityMetrics {
|
|
|
124
135
|
*/
|
|
125
136
|
export interface AdvancedCostOptimizationMetrics {
|
|
126
137
|
/**
|
|
138
|
+
* @public
|
|
127
139
|
* <p>A container that indicates whether advanced cost-optimization metrics are
|
|
128
140
|
* enabled.</p>
|
|
129
141
|
*/
|
|
@@ -138,6 +150,7 @@ export interface AdvancedCostOptimizationMetrics {
|
|
|
138
150
|
*/
|
|
139
151
|
export interface AdvancedDataProtectionMetrics {
|
|
140
152
|
/**
|
|
153
|
+
* @public
|
|
141
154
|
* <p>A container that indicates whether advanced data-protection metrics are enabled.</p>
|
|
142
155
|
*/
|
|
143
156
|
IsEnabled?: boolean;
|
|
@@ -151,6 +164,7 @@ export interface AdvancedDataProtectionMetrics {
|
|
|
151
164
|
*/
|
|
152
165
|
export interface DetailedStatusCodesMetrics {
|
|
153
166
|
/**
|
|
167
|
+
* @public
|
|
154
168
|
* <p>A container that indicates whether detailed status code metrics are enabled.</p>
|
|
155
169
|
*/
|
|
156
170
|
IsEnabled?: boolean;
|
|
@@ -161,14 +175,17 @@ export interface DetailedStatusCodesMetrics {
|
|
|
161
175
|
*/
|
|
162
176
|
export interface SelectionCriteria {
|
|
163
177
|
/**
|
|
178
|
+
* @public
|
|
164
179
|
* <p>A container for the delimiter of the selection criteria being used.</p>
|
|
165
180
|
*/
|
|
166
181
|
Delimiter?: string;
|
|
167
182
|
/**
|
|
183
|
+
* @public
|
|
168
184
|
* <p>The max depth of the selection criteria</p>
|
|
169
185
|
*/
|
|
170
186
|
MaxDepth?: number;
|
|
171
187
|
/**
|
|
188
|
+
* @public
|
|
172
189
|
* <p>The minimum number of storage bytes percentage whose metrics will be selected.</p>
|
|
173
190
|
* <note>
|
|
174
191
|
* <p>You must choose a value greater than or equal to <code>1.0</code>.</p>
|
|
@@ -182,10 +199,12 @@ export interface SelectionCriteria {
|
|
|
182
199
|
*/
|
|
183
200
|
export interface PrefixLevelStorageMetrics {
|
|
184
201
|
/**
|
|
202
|
+
* @public
|
|
185
203
|
* <p>A container for whether prefix-level storage metrics are enabled.</p>
|
|
186
204
|
*/
|
|
187
205
|
IsEnabled?: boolean;
|
|
188
206
|
/**
|
|
207
|
+
* @public
|
|
189
208
|
* <p></p>
|
|
190
209
|
*/
|
|
191
210
|
SelectionCriteria?: SelectionCriteria;
|
|
@@ -196,6 +215,7 @@ export interface PrefixLevelStorageMetrics {
|
|
|
196
215
|
*/
|
|
197
216
|
export interface PrefixLevel {
|
|
198
217
|
/**
|
|
218
|
+
* @public
|
|
199
219
|
* <p>A container for the prefix-level storage metrics for S3 Storage Lens.</p>
|
|
200
220
|
*/
|
|
201
221
|
StorageMetrics: PrefixLevelStorageMetrics | undefined;
|
|
@@ -207,22 +227,27 @@ export interface PrefixLevel {
|
|
|
207
227
|
*/
|
|
208
228
|
export interface BucketLevel {
|
|
209
229
|
/**
|
|
230
|
+
* @public
|
|
210
231
|
* <p>A container for the bucket-level activity metrics for S3 Storage Lens.</p>
|
|
211
232
|
*/
|
|
212
233
|
ActivityMetrics?: ActivityMetrics;
|
|
213
234
|
/**
|
|
235
|
+
* @public
|
|
214
236
|
* <p>A container for the prefix-level metrics for S3 Storage Lens. </p>
|
|
215
237
|
*/
|
|
216
238
|
PrefixLevel?: PrefixLevel;
|
|
217
239
|
/**
|
|
240
|
+
* @public
|
|
218
241
|
* <p>A container for bucket-level advanced cost-optimization metrics for S3 Storage Lens.</p>
|
|
219
242
|
*/
|
|
220
243
|
AdvancedCostOptimizationMetrics?: AdvancedCostOptimizationMetrics;
|
|
221
244
|
/**
|
|
245
|
+
* @public
|
|
222
246
|
* <p>A container for bucket-level advanced data-protection metrics for S3 Storage Lens.</p>
|
|
223
247
|
*/
|
|
224
248
|
AdvancedDataProtectionMetrics?: AdvancedDataProtectionMetrics;
|
|
225
249
|
/**
|
|
250
|
+
* @public
|
|
226
251
|
* <p>A container for bucket-level detailed status code metrics for S3 Storage Lens.</p>
|
|
227
252
|
*/
|
|
228
253
|
DetailedStatusCodesMetrics?: DetailedStatusCodesMetrics;
|
|
@@ -234,22 +259,27 @@ export interface BucketLevel {
|
|
|
234
259
|
*/
|
|
235
260
|
export interface AccountLevel {
|
|
236
261
|
/**
|
|
262
|
+
* @public
|
|
237
263
|
* <p>A container for S3 Storage Lens activity metrics.</p>
|
|
238
264
|
*/
|
|
239
265
|
ActivityMetrics?: ActivityMetrics;
|
|
240
266
|
/**
|
|
267
|
+
* @public
|
|
241
268
|
* <p>A container for the S3 Storage Lens bucket-level configuration.</p>
|
|
242
269
|
*/
|
|
243
270
|
BucketLevel: BucketLevel | undefined;
|
|
244
271
|
/**
|
|
272
|
+
* @public
|
|
245
273
|
* <p>A container for S3 Storage Lens advanced cost-optimization metrics.</p>
|
|
246
274
|
*/
|
|
247
275
|
AdvancedCostOptimizationMetrics?: AdvancedCostOptimizationMetrics;
|
|
248
276
|
/**
|
|
277
|
+
* @public
|
|
249
278
|
* <p>A container for S3 Storage Lens advanced data-protection metrics.</p>
|
|
250
279
|
*/
|
|
251
280
|
AdvancedDataProtectionMetrics?: AdvancedDataProtectionMetrics;
|
|
252
281
|
/**
|
|
282
|
+
* @public
|
|
253
283
|
* <p>A container for detailed status code metrics. </p>
|
|
254
284
|
*/
|
|
255
285
|
DetailedStatusCodesMetrics?: DetailedStatusCodesMetrics;
|
|
@@ -260,18 +290,22 @@ export interface AccountLevel {
|
|
|
260
290
|
*/
|
|
261
291
|
export interface AsyncErrorDetails {
|
|
262
292
|
/**
|
|
293
|
+
* @public
|
|
263
294
|
* <p>A string that uniquely identifies the error condition.</p>
|
|
264
295
|
*/
|
|
265
296
|
Code?: string;
|
|
266
297
|
/**
|
|
298
|
+
* @public
|
|
267
299
|
* <p>A generic description of the error condition in English.</p>
|
|
268
300
|
*/
|
|
269
301
|
Message?: string;
|
|
270
302
|
/**
|
|
303
|
+
* @public
|
|
271
304
|
* <p>The identifier of the resource associated with the error.</p>
|
|
272
305
|
*/
|
|
273
306
|
Resource?: string;
|
|
274
307
|
/**
|
|
308
|
+
* @public
|
|
275
309
|
* <p>The ID of the request associated with the error.</p>
|
|
276
310
|
*/
|
|
277
311
|
RequestId?: string;
|
|
@@ -298,6 +332,7 @@ export type AsyncOperationName = (typeof AsyncOperationName)[keyof typeof AsyncO
|
|
|
298
332
|
*/
|
|
299
333
|
export interface PublicAccessBlockConfiguration {
|
|
300
334
|
/**
|
|
335
|
+
* @public
|
|
301
336
|
* <p>Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in
|
|
302
337
|
* this account. Setting this element to <code>TRUE</code> causes the following
|
|
303
338
|
* behavior:</p>
|
|
@@ -319,6 +354,7 @@ export interface PublicAccessBlockConfiguration {
|
|
|
319
354
|
*/
|
|
320
355
|
BlockPublicAcls?: boolean;
|
|
321
356
|
/**
|
|
357
|
+
* @public
|
|
322
358
|
* <p>Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting
|
|
323
359
|
* this element to <code>TRUE</code> causes Amazon S3 to ignore all public ACLs on buckets in this
|
|
324
360
|
* account and any objects that they contain. </p>
|
|
@@ -328,6 +364,7 @@ export interface PublicAccessBlockConfiguration {
|
|
|
328
364
|
*/
|
|
329
365
|
IgnorePublicAcls?: boolean;
|
|
330
366
|
/**
|
|
367
|
+
* @public
|
|
331
368
|
* <p>Specifies whether Amazon S3 should block public bucket policies for buckets in this account.
|
|
332
369
|
* Setting this element to <code>TRUE</code> causes Amazon S3 to reject calls to PUT Bucket policy
|
|
333
370
|
* if the specified bucket policy allows public access. </p>
|
|
@@ -336,6 +373,7 @@ export interface PublicAccessBlockConfiguration {
|
|
|
336
373
|
*/
|
|
337
374
|
BlockPublicPolicy?: boolean;
|
|
338
375
|
/**
|
|
376
|
+
* @public
|
|
339
377
|
* <p>Specifies whether Amazon S3 should restrict public bucket policies for buckets in this
|
|
340
378
|
* account. Setting this element to <code>TRUE</code> restricts access to buckets with public
|
|
341
379
|
* policies to only Amazon Web Service principals and authorized users within this
|
|
@@ -353,10 +391,12 @@ export interface PublicAccessBlockConfiguration {
|
|
|
353
391
|
*/
|
|
354
392
|
export interface Region {
|
|
355
393
|
/**
|
|
394
|
+
* @public
|
|
356
395
|
* <p>The name of the associated bucket for the Region.</p>
|
|
357
396
|
*/
|
|
358
397
|
Bucket: string | undefined;
|
|
359
398
|
/**
|
|
399
|
+
* @public
|
|
360
400
|
* <p>The Amazon Web Services account ID that owns the Amazon S3 bucket that's associated with this
|
|
361
401
|
* Multi-Region Access Point.</p>
|
|
362
402
|
*/
|
|
@@ -368,10 +408,12 @@ export interface Region {
|
|
|
368
408
|
*/
|
|
369
409
|
export interface CreateMultiRegionAccessPointInput {
|
|
370
410
|
/**
|
|
411
|
+
* @public
|
|
371
412
|
* <p>The name of the Multi-Region Access Point associated with this request.</p>
|
|
372
413
|
*/
|
|
373
414
|
Name: string | undefined;
|
|
374
415
|
/**
|
|
416
|
+
* @public
|
|
375
417
|
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3
|
|
376
418
|
* account. You can enable the configuration options in any combination. For more information
|
|
377
419
|
* about when Amazon S3 considers a bucket or object public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -379,6 +421,7 @@ export interface CreateMultiRegionAccessPointInput {
|
|
|
379
421
|
*/
|
|
380
422
|
PublicAccessBlock?: PublicAccessBlockConfiguration;
|
|
381
423
|
/**
|
|
424
|
+
* @public
|
|
382
425
|
* <p>The buckets in different Regions that are associated with the Multi-Region Access Point.</p>
|
|
383
426
|
*/
|
|
384
427
|
Regions: Region[] | undefined;
|
|
@@ -389,6 +432,7 @@ export interface CreateMultiRegionAccessPointInput {
|
|
|
389
432
|
*/
|
|
390
433
|
export interface DeleteMultiRegionAccessPointInput {
|
|
391
434
|
/**
|
|
435
|
+
* @public
|
|
392
436
|
* <p>The name of the Multi-Region Access Point associated with this request.</p>
|
|
393
437
|
*/
|
|
394
438
|
Name: string | undefined;
|
|
@@ -399,10 +443,12 @@ export interface DeleteMultiRegionAccessPointInput {
|
|
|
399
443
|
*/
|
|
400
444
|
export interface PutMultiRegionAccessPointPolicyInput {
|
|
401
445
|
/**
|
|
446
|
+
* @public
|
|
402
447
|
* <p>The name of the Multi-Region Access Point associated with the request.</p>
|
|
403
448
|
*/
|
|
404
449
|
Name: string | undefined;
|
|
405
450
|
/**
|
|
451
|
+
* @public
|
|
406
452
|
* <p>The policy details for the <code>PutMultiRegionAccessPoint</code> request.</p>
|
|
407
453
|
*/
|
|
408
454
|
Policy: string | undefined;
|
|
@@ -413,14 +459,17 @@ export interface PutMultiRegionAccessPointPolicyInput {
|
|
|
413
459
|
*/
|
|
414
460
|
export interface AsyncRequestParameters {
|
|
415
461
|
/**
|
|
462
|
+
* @public
|
|
416
463
|
* <p>A container of the parameters for a <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html">CreateMultiRegionAccessPoint</a> request.</p>
|
|
417
464
|
*/
|
|
418
465
|
CreateMultiRegionAccessPointRequest?: CreateMultiRegionAccessPointInput;
|
|
419
466
|
/**
|
|
467
|
+
* @public
|
|
420
468
|
* <p>A container of the parameters for a <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html">DeleteMultiRegionAccessPoint</a> request.</p>
|
|
421
469
|
*/
|
|
422
470
|
DeleteMultiRegionAccessPointRequest?: DeleteMultiRegionAccessPointInput;
|
|
423
471
|
/**
|
|
472
|
+
* @public
|
|
424
473
|
* <p>A container of the parameters for a <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPoint.html">PutMultiRegionAccessPoint</a> request.</p>
|
|
425
474
|
*/
|
|
426
475
|
PutMultiRegionAccessPointPolicyRequest?: PutMultiRegionAccessPointPolicyInput;
|
|
@@ -431,10 +480,12 @@ export interface AsyncRequestParameters {
|
|
|
431
480
|
*/
|
|
432
481
|
export interface MultiRegionAccessPointRegionalResponse {
|
|
433
482
|
/**
|
|
483
|
+
* @public
|
|
434
484
|
* <p>The name of the Region in the Multi-Region Access Point.</p>
|
|
435
485
|
*/
|
|
436
486
|
Name?: string;
|
|
437
487
|
/**
|
|
488
|
+
* @public
|
|
438
489
|
* <p>The current status of the Multi-Region Access Point in this Region.</p>
|
|
439
490
|
*/
|
|
440
491
|
RequestStatus?: string;
|
|
@@ -445,6 +496,7 @@ export interface MultiRegionAccessPointRegionalResponse {
|
|
|
445
496
|
*/
|
|
446
497
|
export interface MultiRegionAccessPointsAsyncResponse {
|
|
447
498
|
/**
|
|
499
|
+
* @public
|
|
448
500
|
* <p>A collection of status information for the different Regions that a Multi-Region Access Point
|
|
449
501
|
* supports.</p>
|
|
450
502
|
*/
|
|
@@ -457,10 +509,12 @@ export interface MultiRegionAccessPointsAsyncResponse {
|
|
|
457
509
|
*/
|
|
458
510
|
export interface AsyncResponseDetails {
|
|
459
511
|
/**
|
|
512
|
+
* @public
|
|
460
513
|
* <p>The details for the Multi-Region Access Point.</p>
|
|
461
514
|
*/
|
|
462
515
|
MultiRegionAccessPointDetails?: MultiRegionAccessPointsAsyncResponse;
|
|
463
516
|
/**
|
|
517
|
+
* @public
|
|
464
518
|
* <p>Error details for an asynchronous request.</p>
|
|
465
519
|
*/
|
|
466
520
|
ErrorDetails?: AsyncErrorDetails;
|
|
@@ -471,26 +525,32 @@ export interface AsyncResponseDetails {
|
|
|
471
525
|
*/
|
|
472
526
|
export interface AsyncOperation {
|
|
473
527
|
/**
|
|
528
|
+
* @public
|
|
474
529
|
* <p>The time that the request was sent to the service.</p>
|
|
475
530
|
*/
|
|
476
531
|
CreationTime?: Date;
|
|
477
532
|
/**
|
|
533
|
+
* @public
|
|
478
534
|
* <p>The specific operation for the asynchronous request.</p>
|
|
479
535
|
*/
|
|
480
536
|
Operation?: AsyncOperationName | string;
|
|
481
537
|
/**
|
|
538
|
+
* @public
|
|
482
539
|
* <p>The request token associated with the request.</p>
|
|
483
540
|
*/
|
|
484
541
|
RequestTokenARN?: string;
|
|
485
542
|
/**
|
|
543
|
+
* @public
|
|
486
544
|
* <p>The parameters associated with the request.</p>
|
|
487
545
|
*/
|
|
488
546
|
RequestParameters?: AsyncRequestParameters;
|
|
489
547
|
/**
|
|
548
|
+
* @public
|
|
490
549
|
* <p>The current status of the request.</p>
|
|
491
550
|
*/
|
|
492
551
|
RequestStatus?: string;
|
|
493
552
|
/**
|
|
553
|
+
* @public
|
|
494
554
|
* <p>The details of the response.</p>
|
|
495
555
|
*/
|
|
496
556
|
ResponseDetails?: AsyncResponseDetails;
|
|
@@ -501,10 +561,12 @@ export interface AsyncOperation {
|
|
|
501
561
|
*/
|
|
502
562
|
export interface AwsLambdaTransformation {
|
|
503
563
|
/**
|
|
564
|
+
* @public
|
|
504
565
|
* <p>The Amazon Resource Name (ARN) of the Lambda function.</p>
|
|
505
566
|
*/
|
|
506
567
|
FunctionArn: string | undefined;
|
|
507
568
|
/**
|
|
569
|
+
* @public
|
|
508
570
|
* <p>Additional JSON that provides supplemental data to the Lambda function used to transform
|
|
509
571
|
* objects.</p>
|
|
510
572
|
*/
|
|
@@ -515,20 +577,24 @@ export interface AwsLambdaTransformation {
|
|
|
515
577
|
*/
|
|
516
578
|
export interface CreateAccessPointRequest {
|
|
517
579
|
/**
|
|
580
|
+
* @public
|
|
518
581
|
* <p>The Amazon Web Services account ID for the account that owns the specified access point.</p>
|
|
519
582
|
*/
|
|
520
583
|
AccountId?: string;
|
|
521
584
|
/**
|
|
585
|
+
* @public
|
|
522
586
|
* <p>The name you want to assign to this access point.</p>
|
|
523
587
|
*/
|
|
524
588
|
Name: string | undefined;
|
|
525
589
|
/**
|
|
590
|
+
* @public
|
|
526
591
|
* <p>The name of the bucket that you want to associate this access point with.</p>
|
|
527
592
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
528
593
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
|
|
529
594
|
*/
|
|
530
595
|
Bucket: string | undefined;
|
|
531
596
|
/**
|
|
597
|
+
* @public
|
|
532
598
|
* <p>If you include this field, Amazon S3 restricts access to this access point to requests from the
|
|
533
599
|
* specified virtual private cloud (VPC).</p>
|
|
534
600
|
* <note>
|
|
@@ -537,11 +603,13 @@ export interface CreateAccessPointRequest {
|
|
|
537
603
|
*/
|
|
538
604
|
VpcConfiguration?: VpcConfiguration;
|
|
539
605
|
/**
|
|
606
|
+
* @public
|
|
540
607
|
* <p> The <code>PublicAccessBlock</code> configuration that you want to apply to the access point.
|
|
541
608
|
* </p>
|
|
542
609
|
*/
|
|
543
610
|
PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
|
|
544
611
|
/**
|
|
612
|
+
* @public
|
|
545
613
|
* <p>The Amazon Web Services account ID associated with the S3 bucket associated with this access point.</p>
|
|
546
614
|
*/
|
|
547
615
|
BucketAccountId?: string;
|
|
@@ -551,6 +619,7 @@ export interface CreateAccessPointRequest {
|
|
|
551
619
|
*/
|
|
552
620
|
export interface CreateAccessPointResult {
|
|
553
621
|
/**
|
|
622
|
+
* @public
|
|
554
623
|
* <p>The ARN of the access point.</p>
|
|
555
624
|
* <note>
|
|
556
625
|
* <p>This is only supported by Amazon S3 on Outposts.</p>
|
|
@@ -558,6 +627,7 @@ export interface CreateAccessPointResult {
|
|
|
558
627
|
*/
|
|
559
628
|
AccessPointArn?: string;
|
|
560
629
|
/**
|
|
630
|
+
* @public
|
|
561
631
|
* <p>The name or alias of the access point.</p>
|
|
562
632
|
*/
|
|
563
633
|
Alias?: string;
|
|
@@ -600,12 +670,16 @@ export type ObjectLambdaContentTransformation = ObjectLambdaContentTransformatio
|
|
|
600
670
|
*/
|
|
601
671
|
export declare namespace ObjectLambdaContentTransformation {
|
|
602
672
|
/**
|
|
673
|
+
* @public
|
|
603
674
|
* <p>A container for an Lambda function.</p>
|
|
604
675
|
*/
|
|
605
676
|
interface AwsLambdaMember {
|
|
606
677
|
AwsLambda: AwsLambdaTransformation;
|
|
607
678
|
$unknown?: never;
|
|
608
679
|
}
|
|
680
|
+
/**
|
|
681
|
+
* @public
|
|
682
|
+
*/
|
|
609
683
|
interface $UnknownMember {
|
|
610
684
|
AwsLambda?: never;
|
|
611
685
|
$unknown: [string, any];
|
|
@@ -622,12 +696,14 @@ export declare namespace ObjectLambdaContentTransformation {
|
|
|
622
696
|
*/
|
|
623
697
|
export interface ObjectLambdaTransformationConfiguration {
|
|
624
698
|
/**
|
|
699
|
+
* @public
|
|
625
700
|
* <p>A container for the action of an Object Lambda Access Point configuration. Valid inputs are
|
|
626
701
|
* <code>GetObject</code>, <code>ListObjects</code>, <code>HeadObject</code>, and
|
|
627
702
|
* <code>ListObjectsV2</code>.</p>
|
|
628
703
|
*/
|
|
629
704
|
Actions: (ObjectLambdaTransformationConfigurationAction | string)[] | undefined;
|
|
630
705
|
/**
|
|
706
|
+
* @public
|
|
631
707
|
* <p>A container for the content transformation of an Object Lambda Access Point configuration.</p>
|
|
632
708
|
*/
|
|
633
709
|
ContentTransformation: ObjectLambdaContentTransformation | undefined;
|
|
@@ -638,20 +714,24 @@ export interface ObjectLambdaTransformationConfiguration {
|
|
|
638
714
|
*/
|
|
639
715
|
export interface ObjectLambdaConfiguration {
|
|
640
716
|
/**
|
|
717
|
+
* @public
|
|
641
718
|
* <p>Standard access point associated with the Object Lambda Access Point.</p>
|
|
642
719
|
*/
|
|
643
720
|
SupportingAccessPoint: string | undefined;
|
|
644
721
|
/**
|
|
722
|
+
* @public
|
|
645
723
|
* <p>A container for whether the CloudWatch metrics configuration is enabled.</p>
|
|
646
724
|
*/
|
|
647
725
|
CloudWatchMetricsEnabled?: boolean;
|
|
648
726
|
/**
|
|
727
|
+
* @public
|
|
649
728
|
* <p>A container for allowed features. Valid inputs are <code>GetObject-Range</code>,
|
|
650
729
|
* <code>GetObject-PartNumber</code>, <code>HeadObject-Range</code>, and
|
|
651
730
|
* <code>HeadObject-PartNumber</code>.</p>
|
|
652
731
|
*/
|
|
653
732
|
AllowedFeatures?: (ObjectLambdaAllowedFeature | string)[];
|
|
654
733
|
/**
|
|
734
|
+
* @public
|
|
655
735
|
* <p>A container for transformation configurations for an Object Lambda Access Point.</p>
|
|
656
736
|
*/
|
|
657
737
|
TransformationConfigurations: ObjectLambdaTransformationConfiguration[] | undefined;
|
|
@@ -661,14 +741,17 @@ export interface ObjectLambdaConfiguration {
|
|
|
661
741
|
*/
|
|
662
742
|
export interface CreateAccessPointForObjectLambdaRequest {
|
|
663
743
|
/**
|
|
744
|
+
* @public
|
|
664
745
|
* <p>The Amazon Web Services account ID for owner of the specified Object Lambda Access Point.</p>
|
|
665
746
|
*/
|
|
666
747
|
AccountId?: string;
|
|
667
748
|
/**
|
|
749
|
+
* @public
|
|
668
750
|
* <p>The name you want to assign to this Object Lambda Access Point.</p>
|
|
669
751
|
*/
|
|
670
752
|
Name: string | undefined;
|
|
671
753
|
/**
|
|
754
|
+
* @public
|
|
672
755
|
* <p>Object Lambda Access Point configuration as a JSON document.</p>
|
|
673
756
|
*/
|
|
674
757
|
Configuration: ObjectLambdaConfiguration | undefined;
|
|
@@ -692,10 +775,12 @@ export type ObjectLambdaAccessPointAliasStatus = (typeof ObjectLambdaAccessPoint
|
|
|
692
775
|
*/
|
|
693
776
|
export interface ObjectLambdaAccessPointAlias {
|
|
694
777
|
/**
|
|
778
|
+
* @public
|
|
695
779
|
* <p>The alias value of the Object Lambda Access Point.</p>
|
|
696
780
|
*/
|
|
697
781
|
Value?: string;
|
|
698
782
|
/**
|
|
783
|
+
* @public
|
|
699
784
|
* <p>The status of the Object Lambda Access Point alias. If the status is <code>PROVISIONING</code>, the Object Lambda Access Point is provisioning the alias and the alias is not ready for use yet. If
|
|
700
785
|
* the status is <code>READY</code>, the Object Lambda Access Point alias is successfully provisioned and ready for use.</p>
|
|
701
786
|
*/
|
|
@@ -706,10 +791,12 @@ export interface ObjectLambdaAccessPointAlias {
|
|
|
706
791
|
*/
|
|
707
792
|
export interface CreateAccessPointForObjectLambdaResult {
|
|
708
793
|
/**
|
|
794
|
+
* @public
|
|
709
795
|
* <p>Specifies the ARN for the Object Lambda Access Point.</p>
|
|
710
796
|
*/
|
|
711
797
|
ObjectLambdaAccessPointArn?: string;
|
|
712
798
|
/**
|
|
799
|
+
* @public
|
|
713
800
|
* <p>The alias of the Object Lambda Access Point.</p>
|
|
714
801
|
*/
|
|
715
802
|
Alias?: ObjectLambdaAccessPointAlias;
|
|
@@ -784,6 +871,7 @@ export type BucketLocationConstraint = (typeof BucketLocationConstraint)[keyof t
|
|
|
784
871
|
*/
|
|
785
872
|
export interface CreateBucketConfiguration {
|
|
786
873
|
/**
|
|
874
|
+
* @public
|
|
787
875
|
* <p>Specifies the Region where the bucket will be created. If you are creating a bucket on
|
|
788
876
|
* the US East (N. Virginia) Region (us-east-1), you do not need to specify the location. </p>
|
|
789
877
|
* <note>
|
|
@@ -797,6 +885,7 @@ export interface CreateBucketConfiguration {
|
|
|
797
885
|
*/
|
|
798
886
|
export interface CreateBucketRequest {
|
|
799
887
|
/**
|
|
888
|
+
* @public
|
|
800
889
|
* <p>The canned ACL to apply to the bucket.</p>
|
|
801
890
|
* <note>
|
|
802
891
|
* <p>This is not supported by Amazon S3 on Outposts buckets.</p>
|
|
@@ -804,10 +893,12 @@ export interface CreateBucketRequest {
|
|
|
804
893
|
*/
|
|
805
894
|
ACL?: BucketCannedACL | string;
|
|
806
895
|
/**
|
|
896
|
+
* @public
|
|
807
897
|
* <p>The name of the bucket.</p>
|
|
808
898
|
*/
|
|
809
899
|
Bucket: string | undefined;
|
|
810
900
|
/**
|
|
901
|
+
* @public
|
|
811
902
|
* <p>The configuration information for the bucket.</p>
|
|
812
903
|
* <note>
|
|
813
904
|
* <p>This is not supported by Amazon S3 on Outposts buckets.</p>
|
|
@@ -815,6 +906,7 @@ export interface CreateBucketRequest {
|
|
|
815
906
|
*/
|
|
816
907
|
CreateBucketConfiguration?: CreateBucketConfiguration;
|
|
817
908
|
/**
|
|
909
|
+
* @public
|
|
818
910
|
* <p>Allows grantee the read, write, read ACP, and write ACP permissions on the
|
|
819
911
|
* bucket.</p>
|
|
820
912
|
* <note>
|
|
@@ -823,6 +915,7 @@ export interface CreateBucketRequest {
|
|
|
823
915
|
*/
|
|
824
916
|
GrantFullControl?: string;
|
|
825
917
|
/**
|
|
918
|
+
* @public
|
|
826
919
|
* <p>Allows grantee to list the objects in the bucket.</p>
|
|
827
920
|
* <note>
|
|
828
921
|
* <p>This is not supported by Amazon S3 on Outposts buckets.</p>
|
|
@@ -830,6 +923,7 @@ export interface CreateBucketRequest {
|
|
|
830
923
|
*/
|
|
831
924
|
GrantRead?: string;
|
|
832
925
|
/**
|
|
926
|
+
* @public
|
|
833
927
|
* <p>Allows grantee to read the bucket ACL.</p>
|
|
834
928
|
* <note>
|
|
835
929
|
* <p>This is not supported by Amazon S3 on Outposts buckets.</p>
|
|
@@ -837,6 +931,7 @@ export interface CreateBucketRequest {
|
|
|
837
931
|
*/
|
|
838
932
|
GrantReadACP?: string;
|
|
839
933
|
/**
|
|
934
|
+
* @public
|
|
840
935
|
* <p>Allows grantee to create, overwrite, and delete any object in the bucket.</p>
|
|
841
936
|
* <note>
|
|
842
937
|
* <p>This is not supported by Amazon S3 on Outposts buckets.</p>
|
|
@@ -844,6 +939,7 @@ export interface CreateBucketRequest {
|
|
|
844
939
|
*/
|
|
845
940
|
GrantWrite?: string;
|
|
846
941
|
/**
|
|
942
|
+
* @public
|
|
847
943
|
* <p>Allows grantee to write the ACL for the applicable bucket.</p>
|
|
848
944
|
* <note>
|
|
849
945
|
* <p>This is not supported by Amazon S3 on Outposts buckets.</p>
|
|
@@ -851,6 +947,7 @@ export interface CreateBucketRequest {
|
|
|
851
947
|
*/
|
|
852
948
|
GrantWriteACP?: string;
|
|
853
949
|
/**
|
|
950
|
+
* @public
|
|
854
951
|
* <p>Specifies whether you want S3 Object Lock to be enabled for the new bucket.</p>
|
|
855
952
|
* <note>
|
|
856
953
|
* <p>This is not supported by Amazon S3 on Outposts buckets.</p>
|
|
@@ -858,6 +955,7 @@ export interface CreateBucketRequest {
|
|
|
858
955
|
*/
|
|
859
956
|
ObjectLockEnabledForBucket?: boolean;
|
|
860
957
|
/**
|
|
958
|
+
* @public
|
|
861
959
|
* <p>The ID of the Outposts where the bucket is being created.</p>
|
|
862
960
|
* <note>
|
|
863
961
|
* <p>This ID is required by Amazon S3 on Outposts buckets.</p>
|
|
@@ -870,10 +968,12 @@ export interface CreateBucketRequest {
|
|
|
870
968
|
*/
|
|
871
969
|
export interface CreateBucketResult {
|
|
872
970
|
/**
|
|
971
|
+
* @public
|
|
873
972
|
* <p>The location of the bucket.</p>
|
|
874
973
|
*/
|
|
875
974
|
Location?: string;
|
|
876
975
|
/**
|
|
976
|
+
* @public
|
|
877
977
|
* <p>The Amazon Resource Name (ARN) of the bucket.</p>
|
|
878
978
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
879
979
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
|
|
@@ -899,6 +999,7 @@ export declare class BadRequestException extends __BaseException {
|
|
|
899
999
|
*/
|
|
900
1000
|
export interface JobManifestLocation {
|
|
901
1001
|
/**
|
|
1002
|
+
* @public
|
|
902
1003
|
* <p>The Amazon Resource Name (ARN) for a manifest object.</p>
|
|
903
1004
|
* <important>
|
|
904
1005
|
* <p>When you're using XML requests, you must
|
|
@@ -909,10 +1010,12 @@ export interface JobManifestLocation {
|
|
|
909
1010
|
*/
|
|
910
1011
|
ObjectArn: string | undefined;
|
|
911
1012
|
/**
|
|
1013
|
+
* @public
|
|
912
1014
|
* <p>The optional version ID to identify a specific version of the manifest object.</p>
|
|
913
1015
|
*/
|
|
914
1016
|
ObjectVersionId?: string;
|
|
915
1017
|
/**
|
|
1018
|
+
* @public
|
|
916
1019
|
* <p>The ETag for the specified manifest object.</p>
|
|
917
1020
|
*/
|
|
918
1021
|
ETag: string | undefined;
|
|
@@ -950,10 +1053,12 @@ export type JobManifestFormat = (typeof JobManifestFormat)[keyof typeof JobManif
|
|
|
950
1053
|
*/
|
|
951
1054
|
export interface JobManifestSpec {
|
|
952
1055
|
/**
|
|
1056
|
+
* @public
|
|
953
1057
|
* <p>Indicates which of the available formats the specified manifest uses.</p>
|
|
954
1058
|
*/
|
|
955
1059
|
Format: JobManifestFormat | string | undefined;
|
|
956
1060
|
/**
|
|
1061
|
+
* @public
|
|
957
1062
|
* <p>If the specified manifest object is in the <code>S3BatchOperations_CSV_20180820</code>
|
|
958
1063
|
* format, this element describes which columns contain the required data.</p>
|
|
959
1064
|
*/
|
|
@@ -965,11 +1070,13 @@ export interface JobManifestSpec {
|
|
|
965
1070
|
*/
|
|
966
1071
|
export interface JobManifest {
|
|
967
1072
|
/**
|
|
1073
|
+
* @public
|
|
968
1074
|
* <p>Describes the format of the specified job's manifest. If the manifest is in CSV format,
|
|
969
1075
|
* also describes the columns contained within the manifest.</p>
|
|
970
1076
|
*/
|
|
971
1077
|
Spec: JobManifestSpec | undefined;
|
|
972
1078
|
/**
|
|
1079
|
+
* @public
|
|
973
1080
|
* <p>Contains the information required to locate the specified job's manifest.</p>
|
|
974
1081
|
*/
|
|
975
1082
|
Location: JobManifestLocation | undefined;
|
|
@@ -994,21 +1101,25 @@ export type ReplicationStatus = (typeof ReplicationStatus)[keyof typeof Replicat
|
|
|
994
1101
|
*/
|
|
995
1102
|
export interface JobManifestGeneratorFilter {
|
|
996
1103
|
/**
|
|
1104
|
+
* @public
|
|
997
1105
|
* <p>Include objects in the generated manifest only if they are eligible for replication
|
|
998
1106
|
* according to the Replication configuration on the source bucket.</p>
|
|
999
1107
|
*/
|
|
1000
1108
|
EligibleForReplication?: boolean;
|
|
1001
1109
|
/**
|
|
1110
|
+
* @public
|
|
1002
1111
|
* <p>If provided, the generated manifest should include only source bucket objects that were
|
|
1003
1112
|
* created after this time.</p>
|
|
1004
1113
|
*/
|
|
1005
1114
|
CreatedAfter?: Date;
|
|
1006
1115
|
/**
|
|
1116
|
+
* @public
|
|
1007
1117
|
* <p>If provided, the generated manifest should include only source bucket objects that were
|
|
1008
1118
|
* created before this time.</p>
|
|
1009
1119
|
*/
|
|
1010
1120
|
CreatedBefore?: Date;
|
|
1011
1121
|
/**
|
|
1122
|
+
* @public
|
|
1012
1123
|
* <p>If provided, the generated manifest should include only source bucket objects that have
|
|
1013
1124
|
* one of the specified Replication statuses.</p>
|
|
1014
1125
|
*/
|
|
@@ -1020,6 +1131,7 @@ export interface JobManifestGeneratorFilter {
|
|
|
1020
1131
|
*/
|
|
1021
1132
|
export interface SSEKMSEncryption {
|
|
1022
1133
|
/**
|
|
1134
|
+
* @public
|
|
1023
1135
|
* <p>Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption
|
|
1024
1136
|
* customer managed key to use for encrypting generated manifest objects.</p>
|
|
1025
1137
|
*/
|
|
@@ -1037,10 +1149,12 @@ export interface SSES3Encryption {
|
|
|
1037
1149
|
*/
|
|
1038
1150
|
export interface GeneratedManifestEncryption {
|
|
1039
1151
|
/**
|
|
1152
|
+
* @public
|
|
1040
1153
|
* <p>Specifies the use of SSE-S3 to encrypt generated manifest objects.</p>
|
|
1041
1154
|
*/
|
|
1042
1155
|
SSES3?: SSES3Encryption;
|
|
1043
1156
|
/**
|
|
1157
|
+
* @public
|
|
1044
1158
|
* <p>Configuration details on how SSE-KMS is used to encrypt generated manifest
|
|
1045
1159
|
* objects.</p>
|
|
1046
1160
|
*/
|
|
@@ -1063,23 +1177,28 @@ export type GeneratedManifestFormat = (typeof GeneratedManifestFormat)[keyof typ
|
|
|
1063
1177
|
*/
|
|
1064
1178
|
export interface S3ManifestOutputLocation {
|
|
1065
1179
|
/**
|
|
1180
|
+
* @public
|
|
1066
1181
|
* <p>The Account ID that owns the bucket the generated manifest is written to.</p>
|
|
1067
1182
|
*/
|
|
1068
1183
|
ExpectedManifestBucketOwner?: string;
|
|
1069
1184
|
/**
|
|
1185
|
+
* @public
|
|
1070
1186
|
* <p>The bucket ARN the generated manifest should be written to.</p>
|
|
1071
1187
|
*/
|
|
1072
1188
|
Bucket: string | undefined;
|
|
1073
1189
|
/**
|
|
1190
|
+
* @public
|
|
1074
1191
|
* <p>Prefix identifying one or more objects to which the manifest applies.</p>
|
|
1075
1192
|
*/
|
|
1076
1193
|
ManifestPrefix?: string;
|
|
1077
1194
|
/**
|
|
1195
|
+
* @public
|
|
1078
1196
|
* <p>Specifies what encryption should be used when the generated manifest objects are
|
|
1079
1197
|
* written.</p>
|
|
1080
1198
|
*/
|
|
1081
1199
|
ManifestEncryption?: GeneratedManifestEncryption;
|
|
1082
1200
|
/**
|
|
1201
|
+
* @public
|
|
1083
1202
|
* <p>The format of the generated manifest.</p>
|
|
1084
1203
|
*/
|
|
1085
1204
|
ManifestFormat: GeneratedManifestFormat | string | undefined;
|
|
@@ -1090,25 +1209,30 @@ export interface S3ManifestOutputLocation {
|
|
|
1090
1209
|
*/
|
|
1091
1210
|
export interface S3JobManifestGenerator {
|
|
1092
1211
|
/**
|
|
1212
|
+
* @public
|
|
1093
1213
|
* <p>The Amazon Web Services account ID that owns the bucket the generated manifest is written to. If
|
|
1094
1214
|
* provided the generated manifest bucket's owner Amazon Web Services account ID must match this value, else
|
|
1095
1215
|
* the job fails.</p>
|
|
1096
1216
|
*/
|
|
1097
1217
|
ExpectedBucketOwner?: string;
|
|
1098
1218
|
/**
|
|
1219
|
+
* @public
|
|
1099
1220
|
* <p>The source bucket used by the ManifestGenerator.</p>
|
|
1100
1221
|
*/
|
|
1101
1222
|
SourceBucket: string | undefined;
|
|
1102
1223
|
/**
|
|
1224
|
+
* @public
|
|
1103
1225
|
* <p>Specifies the location the generated manifest will be written to.</p>
|
|
1104
1226
|
*/
|
|
1105
1227
|
ManifestOutputLocation?: S3ManifestOutputLocation;
|
|
1106
1228
|
/**
|
|
1229
|
+
* @public
|
|
1107
1230
|
* <p>Specifies rules the S3JobManifestGenerator should use to use to decide whether an object
|
|
1108
1231
|
* in the source bucket should or should not be included in the generated job manifest.</p>
|
|
1109
1232
|
*/
|
|
1110
1233
|
Filter?: JobManifestGeneratorFilter;
|
|
1111
1234
|
/**
|
|
1235
|
+
* @public
|
|
1112
1236
|
* <p>Determines whether or not to write the job's generated manifest to a bucket.</p>
|
|
1113
1237
|
*/
|
|
1114
1238
|
EnableManifestOutput: boolean | undefined;
|
|
@@ -1123,12 +1247,16 @@ export type JobManifestGenerator = JobManifestGenerator.S3JobManifestGeneratorMe
|
|
|
1123
1247
|
*/
|
|
1124
1248
|
export declare namespace JobManifestGenerator {
|
|
1125
1249
|
/**
|
|
1250
|
+
* @public
|
|
1126
1251
|
* <p>The S3 job ManifestGenerator's configuration details.</p>
|
|
1127
1252
|
*/
|
|
1128
1253
|
interface S3JobManifestGeneratorMember {
|
|
1129
1254
|
S3JobManifestGenerator: S3JobManifestGenerator;
|
|
1130
1255
|
$unknown?: never;
|
|
1131
1256
|
}
|
|
1257
|
+
/**
|
|
1258
|
+
* @public
|
|
1259
|
+
*/
|
|
1132
1260
|
interface $UnknownMember {
|
|
1133
1261
|
S3JobManifestGenerator?: never;
|
|
1134
1262
|
$unknown: [string, any];
|
|
@@ -1145,6 +1273,7 @@ export declare namespace JobManifestGenerator {
|
|
|
1145
1273
|
*/
|
|
1146
1274
|
export interface LambdaInvokeOperation {
|
|
1147
1275
|
/**
|
|
1276
|
+
* @public
|
|
1148
1277
|
* <p>The Amazon Resource Name (ARN) for the Lambda function that the specified job will
|
|
1149
1278
|
* invoke on every object in the manifest.</p>
|
|
1150
1279
|
*/
|
|
@@ -1188,6 +1317,7 @@ export type S3GlacierJobTier = (typeof S3GlacierJobTier)[keyof typeof S3GlacierJ
|
|
|
1188
1317
|
*/
|
|
1189
1318
|
export interface S3InitiateRestoreObjectOperation {
|
|
1190
1319
|
/**
|
|
1320
|
+
* @public
|
|
1191
1321
|
* <p>This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains
|
|
1192
1322
|
* available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive
|
|
1193
1323
|
* objects require <code>ExpirationInDays</code> set to 1 or greater.</p>
|
|
@@ -1203,6 +1333,7 @@ export interface S3InitiateRestoreObjectOperation {
|
|
|
1203
1333
|
*/
|
|
1204
1334
|
ExpirationInDays?: number;
|
|
1205
1335
|
/**
|
|
1336
|
+
* @public
|
|
1206
1337
|
* <p>S3 Batch Operations supports <code>STANDARD</code> and <code>BULK</code> retrieval tiers, but
|
|
1207
1338
|
* not the <code>EXPEDITED</code> retrieval tier.</p>
|
|
1208
1339
|
*/
|
|
@@ -1227,14 +1358,17 @@ export type S3GranteeTypeIdentifier = (typeof S3GranteeTypeIdentifier)[keyof typ
|
|
|
1227
1358
|
*/
|
|
1228
1359
|
export interface S3Grantee {
|
|
1229
1360
|
/**
|
|
1361
|
+
* @public
|
|
1230
1362
|
* <p></p>
|
|
1231
1363
|
*/
|
|
1232
1364
|
TypeIdentifier?: S3GranteeTypeIdentifier | string;
|
|
1233
1365
|
/**
|
|
1366
|
+
* @public
|
|
1234
1367
|
* <p></p>
|
|
1235
1368
|
*/
|
|
1236
1369
|
Identifier?: string;
|
|
1237
1370
|
/**
|
|
1371
|
+
* @public
|
|
1238
1372
|
* <p></p>
|
|
1239
1373
|
*/
|
|
1240
1374
|
DisplayName?: string;
|
|
@@ -1260,10 +1394,12 @@ export type S3Permission = (typeof S3Permission)[keyof typeof S3Permission];
|
|
|
1260
1394
|
*/
|
|
1261
1395
|
export interface S3Grant {
|
|
1262
1396
|
/**
|
|
1397
|
+
* @public
|
|
1263
1398
|
* <p></p>
|
|
1264
1399
|
*/
|
|
1265
1400
|
Grantee?: S3Grantee;
|
|
1266
1401
|
/**
|
|
1402
|
+
* @public
|
|
1267
1403
|
* <p></p>
|
|
1268
1404
|
*/
|
|
1269
1405
|
Permission?: S3Permission | string;
|
|
@@ -1274,10 +1410,12 @@ export interface S3Grant {
|
|
|
1274
1410
|
*/
|
|
1275
1411
|
export interface S3ObjectOwner {
|
|
1276
1412
|
/**
|
|
1413
|
+
* @public
|
|
1277
1414
|
* <p></p>
|
|
1278
1415
|
*/
|
|
1279
1416
|
ID?: string;
|
|
1280
1417
|
/**
|
|
1418
|
+
* @public
|
|
1281
1419
|
* <p></p>
|
|
1282
1420
|
*/
|
|
1283
1421
|
DisplayName?: string;
|
|
@@ -1288,10 +1426,12 @@ export interface S3ObjectOwner {
|
|
|
1288
1426
|
*/
|
|
1289
1427
|
export interface S3AccessControlList {
|
|
1290
1428
|
/**
|
|
1429
|
+
* @public
|
|
1291
1430
|
* <p></p>
|
|
1292
1431
|
*/
|
|
1293
1432
|
Owner: S3ObjectOwner | undefined;
|
|
1294
1433
|
/**
|
|
1434
|
+
* @public
|
|
1295
1435
|
* <p></p>
|
|
1296
1436
|
*/
|
|
1297
1437
|
Grants?: S3Grant[];
|
|
@@ -1319,10 +1459,12 @@ export type S3CannedAccessControlList = (typeof S3CannedAccessControlList)[keyof
|
|
|
1319
1459
|
*/
|
|
1320
1460
|
export interface S3AccessControlPolicy {
|
|
1321
1461
|
/**
|
|
1462
|
+
* @public
|
|
1322
1463
|
* <p></p>
|
|
1323
1464
|
*/
|
|
1324
1465
|
AccessControlList?: S3AccessControlList;
|
|
1325
1466
|
/**
|
|
1467
|
+
* @public
|
|
1326
1468
|
* <p></p>
|
|
1327
1469
|
*/
|
|
1328
1470
|
CannedAccessControlList?: S3CannedAccessControlList | string;
|
|
@@ -1339,6 +1481,7 @@ export interface S3AccessControlPolicy {
|
|
|
1339
1481
|
*/
|
|
1340
1482
|
export interface S3SetObjectAclOperation {
|
|
1341
1483
|
/**
|
|
1484
|
+
* @public
|
|
1342
1485
|
* <p></p>
|
|
1343
1486
|
*/
|
|
1344
1487
|
AccessControlPolicy?: S3AccessControlPolicy;
|
|
@@ -1387,46 +1530,57 @@ export type S3SSEAlgorithm = (typeof S3SSEAlgorithm)[keyof typeof S3SSEAlgorithm
|
|
|
1387
1530
|
*/
|
|
1388
1531
|
export interface S3ObjectMetadata {
|
|
1389
1532
|
/**
|
|
1533
|
+
* @public
|
|
1390
1534
|
* <p></p>
|
|
1391
1535
|
*/
|
|
1392
1536
|
CacheControl?: string;
|
|
1393
1537
|
/**
|
|
1538
|
+
* @public
|
|
1394
1539
|
* <p></p>
|
|
1395
1540
|
*/
|
|
1396
1541
|
ContentDisposition?: string;
|
|
1397
1542
|
/**
|
|
1543
|
+
* @public
|
|
1398
1544
|
* <p></p>
|
|
1399
1545
|
*/
|
|
1400
1546
|
ContentEncoding?: string;
|
|
1401
1547
|
/**
|
|
1548
|
+
* @public
|
|
1402
1549
|
* <p></p>
|
|
1403
1550
|
*/
|
|
1404
1551
|
ContentLanguage?: string;
|
|
1405
1552
|
/**
|
|
1553
|
+
* @public
|
|
1406
1554
|
* <p></p>
|
|
1407
1555
|
*/
|
|
1408
1556
|
UserMetadata?: Record<string, string>;
|
|
1409
1557
|
/**
|
|
1558
|
+
* @public
|
|
1410
1559
|
* <p></p>
|
|
1411
1560
|
*/
|
|
1412
1561
|
ContentLength?: number;
|
|
1413
1562
|
/**
|
|
1563
|
+
* @public
|
|
1414
1564
|
* <p></p>
|
|
1415
1565
|
*/
|
|
1416
1566
|
ContentMD5?: string;
|
|
1417
1567
|
/**
|
|
1568
|
+
* @public
|
|
1418
1569
|
* <p></p>
|
|
1419
1570
|
*/
|
|
1420
1571
|
ContentType?: string;
|
|
1421
1572
|
/**
|
|
1573
|
+
* @public
|
|
1422
1574
|
* <p></p>
|
|
1423
1575
|
*/
|
|
1424
1576
|
HttpExpiresDate?: Date;
|
|
1425
1577
|
/**
|
|
1578
|
+
* @public
|
|
1426
1579
|
* <p></p>
|
|
1427
1580
|
*/
|
|
1428
1581
|
RequesterCharged?: boolean;
|
|
1429
1582
|
/**
|
|
1583
|
+
* @public
|
|
1430
1584
|
* <p></p>
|
|
1431
1585
|
*/
|
|
1432
1586
|
SSEAlgorithm?: S3SSEAlgorithm | string;
|
|
@@ -1437,10 +1591,12 @@ export interface S3ObjectMetadata {
|
|
|
1437
1591
|
*/
|
|
1438
1592
|
export interface S3Tag {
|
|
1439
1593
|
/**
|
|
1594
|
+
* @public
|
|
1440
1595
|
* <p>Key of the tag</p>
|
|
1441
1596
|
*/
|
|
1442
1597
|
Key: string | undefined;
|
|
1443
1598
|
/**
|
|
1599
|
+
* @public
|
|
1444
1600
|
* <p>Value of the tag</p>
|
|
1445
1601
|
*/
|
|
1446
1602
|
Value: string | undefined;
|
|
@@ -1498,6 +1654,7 @@ export type S3StorageClass = (typeof S3StorageClass)[keyof typeof S3StorageClass
|
|
|
1498
1654
|
*/
|
|
1499
1655
|
export interface S3CopyObjectOperation {
|
|
1500
1656
|
/**
|
|
1657
|
+
* @public
|
|
1501
1658
|
* <p>Specifies the destination bucket
|
|
1502
1659
|
* Amazon Resource Name
|
|
1503
1660
|
* (ARN)
|
|
@@ -1507,54 +1664,66 @@ export interface S3CopyObjectOperation {
|
|
|
1507
1664
|
*/
|
|
1508
1665
|
TargetResource?: string;
|
|
1509
1666
|
/**
|
|
1667
|
+
* @public
|
|
1510
1668
|
* <p></p>
|
|
1511
1669
|
*/
|
|
1512
1670
|
CannedAccessControlList?: S3CannedAccessControlList | string;
|
|
1513
1671
|
/**
|
|
1672
|
+
* @public
|
|
1514
1673
|
* <p></p>
|
|
1515
1674
|
*/
|
|
1516
1675
|
AccessControlGrants?: S3Grant[];
|
|
1517
1676
|
/**
|
|
1677
|
+
* @public
|
|
1518
1678
|
* <p></p>
|
|
1519
1679
|
*/
|
|
1520
1680
|
MetadataDirective?: S3MetadataDirective | string;
|
|
1521
1681
|
/**
|
|
1682
|
+
* @public
|
|
1522
1683
|
* <p></p>
|
|
1523
1684
|
*/
|
|
1524
1685
|
ModifiedSinceConstraint?: Date;
|
|
1525
1686
|
/**
|
|
1687
|
+
* @public
|
|
1526
1688
|
* <p>If you don't provide this parameter, Amazon S3 copies all the metadata from the original
|
|
1527
1689
|
* objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3
|
|
1528
1690
|
* assigns the supplied tags to the new objects.</p>
|
|
1529
1691
|
*/
|
|
1530
1692
|
NewObjectMetadata?: S3ObjectMetadata;
|
|
1531
1693
|
/**
|
|
1694
|
+
* @public
|
|
1532
1695
|
* <p></p>
|
|
1533
1696
|
*/
|
|
1534
1697
|
NewObjectTagging?: S3Tag[];
|
|
1535
1698
|
/**
|
|
1699
|
+
* @public
|
|
1536
1700
|
* <p>Specifies an optional metadata property for website redirects,
|
|
1537
1701
|
* <code>x-amz-website-redirect-location</code>. Allows webpage redirects if the object is
|
|
1538
1702
|
* accessed through a website endpoint.</p>
|
|
1539
1703
|
*/
|
|
1540
1704
|
RedirectLocation?: string;
|
|
1541
1705
|
/**
|
|
1706
|
+
* @public
|
|
1542
1707
|
* <p></p>
|
|
1543
1708
|
*/
|
|
1544
1709
|
RequesterPays?: boolean;
|
|
1545
1710
|
/**
|
|
1711
|
+
* @public
|
|
1546
1712
|
* <p></p>
|
|
1547
1713
|
*/
|
|
1548
1714
|
StorageClass?: S3StorageClass | string;
|
|
1549
1715
|
/**
|
|
1716
|
+
* @public
|
|
1550
1717
|
* <p></p>
|
|
1551
1718
|
*/
|
|
1552
1719
|
UnModifiedSinceConstraint?: Date;
|
|
1553
1720
|
/**
|
|
1721
|
+
* @public
|
|
1554
1722
|
* <p></p>
|
|
1555
1723
|
*/
|
|
1556
1724
|
SSEAwsKmsKeyId?: string;
|
|
1557
1725
|
/**
|
|
1726
|
+
* @public
|
|
1558
1727
|
* <p>Specifies the folder prefix
|
|
1559
1728
|
* that
|
|
1560
1729
|
* you
|
|
@@ -1569,19 +1738,23 @@ export interface S3CopyObjectOperation {
|
|
|
1569
1738
|
*/
|
|
1570
1739
|
TargetKeyPrefix?: string;
|
|
1571
1740
|
/**
|
|
1741
|
+
* @public
|
|
1572
1742
|
* <p>The legal hold status to be applied to all objects in the Batch Operations job.</p>
|
|
1573
1743
|
*/
|
|
1574
1744
|
ObjectLockLegalHoldStatus?: S3ObjectLockLegalHoldStatus | string;
|
|
1575
1745
|
/**
|
|
1746
|
+
* @public
|
|
1576
1747
|
* <p>The retention mode to be applied to all objects in the Batch Operations job.</p>
|
|
1577
1748
|
*/
|
|
1578
1749
|
ObjectLockMode?: S3ObjectLockMode | string;
|
|
1579
1750
|
/**
|
|
1751
|
+
* @public
|
|
1580
1752
|
* <p>The date when the applied object retention configuration expires on all objects in the
|
|
1581
1753
|
* Batch Operations job.</p>
|
|
1582
1754
|
*/
|
|
1583
1755
|
ObjectLockRetainUntilDate?: Date;
|
|
1584
1756
|
/**
|
|
1757
|
+
* @public
|
|
1585
1758
|
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with
|
|
1586
1759
|
* server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to <code>true</code>
|
|
1587
1760
|
* causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.</p>
|
|
@@ -1590,6 +1763,7 @@ export interface S3CopyObjectOperation {
|
|
|
1590
1763
|
*/
|
|
1591
1764
|
BucketKeyEnabled?: boolean;
|
|
1592
1765
|
/**
|
|
1766
|
+
* @public
|
|
1593
1767
|
* <p>Indicates the algorithm
|
|
1594
1768
|
* that
|
|
1595
1769
|
* you want Amazon S3 to use to create the checksum. For more
|
|
@@ -1605,6 +1779,7 @@ export interface S3CopyObjectOperation {
|
|
|
1605
1779
|
*/
|
|
1606
1780
|
export interface S3ObjectLockLegalHold {
|
|
1607
1781
|
/**
|
|
1782
|
+
* @public
|
|
1608
1783
|
* <p>The Object Lock legal hold status to be applied to all objects in the Batch Operations
|
|
1609
1784
|
* job.</p>
|
|
1610
1785
|
*/
|
|
@@ -1623,6 +1798,7 @@ export interface S3ObjectLockLegalHold {
|
|
|
1623
1798
|
*/
|
|
1624
1799
|
export interface S3SetObjectLegalHoldOperation {
|
|
1625
1800
|
/**
|
|
1801
|
+
* @public
|
|
1626
1802
|
* <p>Contains the Object Lock legal hold status to be applied to all objects in the
|
|
1627
1803
|
* Batch Operations job.</p>
|
|
1628
1804
|
*/
|
|
@@ -1650,11 +1826,13 @@ export type S3ObjectLockRetentionMode = (typeof S3ObjectLockRetentionMode)[keyof
|
|
|
1650
1826
|
*/
|
|
1651
1827
|
export interface S3Retention {
|
|
1652
1828
|
/**
|
|
1829
|
+
* @public
|
|
1653
1830
|
* <p>The date when the applied Object Lock retention will expire on all objects set by the
|
|
1654
1831
|
* Batch Operations job.</p>
|
|
1655
1832
|
*/
|
|
1656
1833
|
RetainUntilDate?: Date;
|
|
1657
1834
|
/**
|
|
1835
|
+
* @public
|
|
1658
1836
|
* <p>The Object Lock retention mode to be applied to all objects in the Batch Operations
|
|
1659
1837
|
* job.</p>
|
|
1660
1838
|
*/
|
|
@@ -1671,11 +1849,13 @@ export interface S3Retention {
|
|
|
1671
1849
|
*/
|
|
1672
1850
|
export interface S3SetObjectRetentionOperation {
|
|
1673
1851
|
/**
|
|
1852
|
+
* @public
|
|
1674
1853
|
* <p>Indicates if the action should be applied to objects in the Batch Operations job even if they
|
|
1675
1854
|
* have Object Lock <code> GOVERNANCE</code> type in place.</p>
|
|
1676
1855
|
*/
|
|
1677
1856
|
BypassGovernanceRetention?: boolean;
|
|
1678
1857
|
/**
|
|
1858
|
+
* @public
|
|
1679
1859
|
* <p>Contains the Object Lock retention mode to be applied to all objects in the Batch Operations
|
|
1680
1860
|
* job. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html">Using S3 Object Lock retention
|
|
1681
1861
|
* with S3 Batch Operations</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -1694,6 +1874,7 @@ export interface S3SetObjectRetentionOperation {
|
|
|
1694
1874
|
*/
|
|
1695
1875
|
export interface S3SetObjectTaggingOperation {
|
|
1696
1876
|
/**
|
|
1877
|
+
* @public
|
|
1697
1878
|
* <p></p>
|
|
1698
1879
|
*/
|
|
1699
1880
|
TagSet?: S3Tag[];
|
|
@@ -1713,36 +1894,43 @@ export interface S3ReplicateObjectOperation {
|
|
|
1713
1894
|
*/
|
|
1714
1895
|
export interface JobOperation {
|
|
1715
1896
|
/**
|
|
1897
|
+
* @public
|
|
1716
1898
|
* <p>Directs the specified job to invoke an Lambda function on every object in the
|
|
1717
1899
|
* manifest.</p>
|
|
1718
1900
|
*/
|
|
1719
1901
|
LambdaInvoke?: LambdaInvokeOperation;
|
|
1720
1902
|
/**
|
|
1903
|
+
* @public
|
|
1721
1904
|
* <p>Directs the specified job to run a PUT Copy object call on every object in the
|
|
1722
1905
|
* manifest.</p>
|
|
1723
1906
|
*/
|
|
1724
1907
|
S3PutObjectCopy?: S3CopyObjectOperation;
|
|
1725
1908
|
/**
|
|
1909
|
+
* @public
|
|
1726
1910
|
* <p>Directs the specified job to run a <code>PutObjectAcl</code> call on every object in the
|
|
1727
1911
|
* manifest.</p>
|
|
1728
1912
|
*/
|
|
1729
1913
|
S3PutObjectAcl?: S3SetObjectAclOperation;
|
|
1730
1914
|
/**
|
|
1915
|
+
* @public
|
|
1731
1916
|
* <p>Directs the specified job to run a PUT Object tagging call on every object in the
|
|
1732
1917
|
* manifest.</p>
|
|
1733
1918
|
*/
|
|
1734
1919
|
S3PutObjectTagging?: S3SetObjectTaggingOperation;
|
|
1735
1920
|
/**
|
|
1921
|
+
* @public
|
|
1736
1922
|
* <p>Directs the specified job to execute a DELETE Object tagging call on every object in the
|
|
1737
1923
|
* manifest.</p>
|
|
1738
1924
|
*/
|
|
1739
1925
|
S3DeleteObjectTagging?: S3DeleteObjectTaggingOperation;
|
|
1740
1926
|
/**
|
|
1927
|
+
* @public
|
|
1741
1928
|
* <p>Directs the specified job to initiate restore requests for every archived object in the
|
|
1742
1929
|
* manifest.</p>
|
|
1743
1930
|
*/
|
|
1744
1931
|
S3InitiateRestoreObject?: S3InitiateRestoreObjectOperation;
|
|
1745
1932
|
/**
|
|
1933
|
+
* @public
|
|
1746
1934
|
* <p>Contains the configuration for an S3 Object Lock legal hold operation that an
|
|
1747
1935
|
* S3 Batch Operations job passes
|
|
1748
1936
|
* to
|
|
@@ -1754,6 +1942,7 @@ export interface JobOperation {
|
|
|
1754
1942
|
*/
|
|
1755
1943
|
S3PutObjectLegalHold?: S3SetObjectLegalHoldOperation;
|
|
1756
1944
|
/**
|
|
1945
|
+
* @public
|
|
1757
1946
|
* <p>Contains the configuration parameters for the Object Lock retention action for an
|
|
1758
1947
|
* S3 Batch Operations job. Batch Operations passes every object to the underlying
|
|
1759
1948
|
* <code>PutObjectRetention</code>
|
|
@@ -1763,6 +1952,7 @@ export interface JobOperation {
|
|
|
1763
1952
|
*/
|
|
1764
1953
|
S3PutObjectRetention?: S3SetObjectRetentionOperation;
|
|
1765
1954
|
/**
|
|
1955
|
+
* @public
|
|
1766
1956
|
* <p>Directs the specified job to invoke <code>ReplicateObject</code> on every object in the
|
|
1767
1957
|
* job's manifest.</p>
|
|
1768
1958
|
*/
|
|
@@ -1797,25 +1987,30 @@ export type JobReportScope = (typeof JobReportScope)[keyof typeof JobReportScope
|
|
|
1797
1987
|
*/
|
|
1798
1988
|
export interface JobReport {
|
|
1799
1989
|
/**
|
|
1990
|
+
* @public
|
|
1800
1991
|
* <p>The Amazon Resource Name (ARN) for the bucket where specified job-completion report will
|
|
1801
1992
|
* be stored.</p>
|
|
1802
1993
|
*/
|
|
1803
1994
|
Bucket?: string;
|
|
1804
1995
|
/**
|
|
1996
|
+
* @public
|
|
1805
1997
|
* <p>The format of the specified job-completion report.</p>
|
|
1806
1998
|
*/
|
|
1807
1999
|
Format?: JobReportFormat | string;
|
|
1808
2000
|
/**
|
|
2001
|
+
* @public
|
|
1809
2002
|
* <p>Indicates whether the specified job will generate a job-completion report.</p>
|
|
1810
2003
|
*/
|
|
1811
2004
|
Enabled: boolean | undefined;
|
|
1812
2005
|
/**
|
|
2006
|
+
* @public
|
|
1813
2007
|
* <p>An optional prefix to describe where in the specified bucket the job-completion report
|
|
1814
2008
|
* will be stored. Amazon S3 stores the job-completion report at
|
|
1815
2009
|
* <code><prefix>/job-<job-id>/report.json</code>.</p>
|
|
1816
2010
|
*/
|
|
1817
2011
|
Prefix?: string;
|
|
1818
2012
|
/**
|
|
2013
|
+
* @public
|
|
1819
2014
|
* <p>Indicates whether the job-completion report will include details of all tasks or only
|
|
1820
2015
|
* failed tasks.</p>
|
|
1821
2016
|
*/
|
|
@@ -1826,53 +2021,64 @@ export interface JobReport {
|
|
|
1826
2021
|
*/
|
|
1827
2022
|
export interface CreateJobRequest {
|
|
1828
2023
|
/**
|
|
2024
|
+
* @public
|
|
1829
2025
|
* <p>The Amazon Web Services account ID that creates the job.</p>
|
|
1830
2026
|
*/
|
|
1831
2027
|
AccountId?: string;
|
|
1832
2028
|
/**
|
|
2029
|
+
* @public
|
|
1833
2030
|
* <p>Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is
|
|
1834
2031
|
* only required for jobs created through the Amazon S3 console.</p>
|
|
1835
2032
|
*/
|
|
1836
2033
|
ConfirmationRequired?: boolean;
|
|
1837
2034
|
/**
|
|
2035
|
+
* @public
|
|
1838
2036
|
* <p>The action that you want this job to perform on every object listed in the manifest. For
|
|
1839
2037
|
* more information about the available actions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-actions.html">Operations</a> in the
|
|
1840
2038
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
1841
2039
|
*/
|
|
1842
2040
|
Operation: JobOperation | undefined;
|
|
1843
2041
|
/**
|
|
2042
|
+
* @public
|
|
1844
2043
|
* <p>Configuration parameters for the optional job-completion report.</p>
|
|
1845
2044
|
*/
|
|
1846
2045
|
Report: JobReport | undefined;
|
|
1847
2046
|
/**
|
|
2047
|
+
* @public
|
|
1848
2048
|
* <p>An idempotency token to ensure that you don't accidentally submit the same request
|
|
1849
2049
|
* twice. You can use any string up to the maximum length.</p>
|
|
1850
2050
|
*/
|
|
1851
2051
|
ClientRequestToken?: string;
|
|
1852
2052
|
/**
|
|
2053
|
+
* @public
|
|
1853
2054
|
* <p>Configuration parameters for the manifest.</p>
|
|
1854
2055
|
*/
|
|
1855
2056
|
Manifest?: JobManifest;
|
|
1856
2057
|
/**
|
|
2058
|
+
* @public
|
|
1857
2059
|
* <p>A description for this job. You can use any string within the permitted length.
|
|
1858
2060
|
* Descriptions don't need to be unique and can be used for multiple jobs.</p>
|
|
1859
2061
|
*/
|
|
1860
2062
|
Description?: string;
|
|
1861
2063
|
/**
|
|
2064
|
+
* @public
|
|
1862
2065
|
* <p>The numerical priority for this job. Higher numbers indicate higher priority.</p>
|
|
1863
2066
|
*/
|
|
1864
2067
|
Priority: number | undefined;
|
|
1865
2068
|
/**
|
|
2069
|
+
* @public
|
|
1866
2070
|
* <p>The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will
|
|
1867
2071
|
* use to run this job's action on every object in the manifest.</p>
|
|
1868
2072
|
*/
|
|
1869
2073
|
RoleArn: string | undefined;
|
|
1870
2074
|
/**
|
|
2075
|
+
* @public
|
|
1871
2076
|
* <p>A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.
|
|
1872
2077
|
* </p>
|
|
1873
2078
|
*/
|
|
1874
2079
|
Tags?: S3Tag[];
|
|
1875
2080
|
/**
|
|
2081
|
+
* @public
|
|
1876
2082
|
* <p>The attribute container for the ManifestGenerator details. Jobs must be created with
|
|
1877
2083
|
* either a manifest file or a ManifestGenerator, but not both.</p>
|
|
1878
2084
|
*/
|
|
@@ -1883,6 +2089,7 @@ export interface CreateJobRequest {
|
|
|
1883
2089
|
*/
|
|
1884
2090
|
export interface CreateJobResult {
|
|
1885
2091
|
/**
|
|
2092
|
+
* @public
|
|
1886
2093
|
* <p>The ID for this job. Amazon S3 generates this ID automatically and returns it after a
|
|
1887
2094
|
* successful <code>Create Job</code> request.</p>
|
|
1888
2095
|
*/
|
|
@@ -1932,16 +2139,19 @@ export declare class TooManyRequestsException extends __BaseException {
|
|
|
1932
2139
|
*/
|
|
1933
2140
|
export interface CreateMultiRegionAccessPointRequest {
|
|
1934
2141
|
/**
|
|
2142
|
+
* @public
|
|
1935
2143
|
* <p>The Amazon Web Services account ID for the owner of the Multi-Region Access Point. The owner of the Multi-Region Access Point also must own
|
|
1936
2144
|
* the underlying buckets.</p>
|
|
1937
2145
|
*/
|
|
1938
2146
|
AccountId?: string;
|
|
1939
2147
|
/**
|
|
2148
|
+
* @public
|
|
1940
2149
|
* <p>An idempotency token used to identify the request and guarantee that requests are
|
|
1941
2150
|
* unique.</p>
|
|
1942
2151
|
*/
|
|
1943
2152
|
ClientToken?: string;
|
|
1944
2153
|
/**
|
|
2154
|
+
* @public
|
|
1945
2155
|
* <p>A container element containing details about the Multi-Region Access Point.</p>
|
|
1946
2156
|
*/
|
|
1947
2157
|
Details: CreateMultiRegionAccessPointInput | undefined;
|
|
@@ -1951,6 +2161,7 @@ export interface CreateMultiRegionAccessPointRequest {
|
|
|
1951
2161
|
*/
|
|
1952
2162
|
export interface CreateMultiRegionAccessPointResult {
|
|
1953
2163
|
/**
|
|
2164
|
+
* @public
|
|
1954
2165
|
* <p>The request token associated with the request. You can use this token with <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html">DescribeMultiRegionAccessPointOperation</a> to determine the status of asynchronous
|
|
1955
2166
|
* requests.</p>
|
|
1956
2167
|
*/
|
|
@@ -1961,10 +2172,12 @@ export interface CreateMultiRegionAccessPointResult {
|
|
|
1961
2172
|
*/
|
|
1962
2173
|
export interface DeleteAccessPointRequest {
|
|
1963
2174
|
/**
|
|
2175
|
+
* @public
|
|
1964
2176
|
* <p>The Amazon Web Services account ID for the account that owns the specified access point.</p>
|
|
1965
2177
|
*/
|
|
1966
2178
|
AccountId?: string;
|
|
1967
2179
|
/**
|
|
2180
|
+
* @public
|
|
1968
2181
|
* <p>The name of the access point you want to delete.</p>
|
|
1969
2182
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
1970
2183
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name></code>. For example, to access the access point <code>reports-ap</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap</code>. The value must be URL encoded. </p>
|
|
@@ -1976,10 +2189,12 @@ export interface DeleteAccessPointRequest {
|
|
|
1976
2189
|
*/
|
|
1977
2190
|
export interface DeleteAccessPointForObjectLambdaRequest {
|
|
1978
2191
|
/**
|
|
2192
|
+
* @public
|
|
1979
2193
|
* <p>The account ID for the account that owns the specified Object Lambda Access Point.</p>
|
|
1980
2194
|
*/
|
|
1981
2195
|
AccountId?: string;
|
|
1982
2196
|
/**
|
|
2197
|
+
* @public
|
|
1983
2198
|
* <p>The name of the access point you want to delete.</p>
|
|
1984
2199
|
*/
|
|
1985
2200
|
Name: string | undefined;
|
|
@@ -1989,10 +2204,12 @@ export interface DeleteAccessPointForObjectLambdaRequest {
|
|
|
1989
2204
|
*/
|
|
1990
2205
|
export interface DeleteAccessPointPolicyRequest {
|
|
1991
2206
|
/**
|
|
2207
|
+
* @public
|
|
1992
2208
|
* <p>The account ID for the account that owns the specified access point.</p>
|
|
1993
2209
|
*/
|
|
1994
2210
|
AccountId?: string;
|
|
1995
2211
|
/**
|
|
2212
|
+
* @public
|
|
1996
2213
|
* <p>The name of the access point whose policy you want to delete.</p>
|
|
1997
2214
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
1998
2215
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name></code>. For example, to access the access point <code>reports-ap</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap</code>. The value must be URL encoded. </p>
|
|
@@ -2004,10 +2221,12 @@ export interface DeleteAccessPointPolicyRequest {
|
|
|
2004
2221
|
*/
|
|
2005
2222
|
export interface DeleteAccessPointPolicyForObjectLambdaRequest {
|
|
2006
2223
|
/**
|
|
2224
|
+
* @public
|
|
2007
2225
|
* <p>The account ID for the account that owns the specified Object Lambda Access Point.</p>
|
|
2008
2226
|
*/
|
|
2009
2227
|
AccountId?: string;
|
|
2010
2228
|
/**
|
|
2229
|
+
* @public
|
|
2011
2230
|
* <p>The name of the Object Lambda Access Point you want to delete the policy for.</p>
|
|
2012
2231
|
*/
|
|
2013
2232
|
Name: string | undefined;
|
|
@@ -2017,10 +2236,12 @@ export interface DeleteAccessPointPolicyForObjectLambdaRequest {
|
|
|
2017
2236
|
*/
|
|
2018
2237
|
export interface DeleteBucketRequest {
|
|
2019
2238
|
/**
|
|
2239
|
+
* @public
|
|
2020
2240
|
* <p>The account ID that owns the Outposts bucket.</p>
|
|
2021
2241
|
*/
|
|
2022
2242
|
AccountId?: string;
|
|
2023
2243
|
/**
|
|
2244
|
+
* @public
|
|
2024
2245
|
* <p>Specifies the bucket being deleted.</p>
|
|
2025
2246
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
2026
2247
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
|
|
@@ -2032,10 +2253,12 @@ export interface DeleteBucketRequest {
|
|
|
2032
2253
|
*/
|
|
2033
2254
|
export interface DeleteBucketLifecycleConfigurationRequest {
|
|
2034
2255
|
/**
|
|
2256
|
+
* @public
|
|
2035
2257
|
* <p>The account ID of the lifecycle configuration to delete.</p>
|
|
2036
2258
|
*/
|
|
2037
2259
|
AccountId?: string;
|
|
2038
2260
|
/**
|
|
2261
|
+
* @public
|
|
2039
2262
|
* <p>Specifies the bucket.</p>
|
|
2040
2263
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
2041
2264
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
|
|
@@ -2047,10 +2270,12 @@ export interface DeleteBucketLifecycleConfigurationRequest {
|
|
|
2047
2270
|
*/
|
|
2048
2271
|
export interface DeleteBucketPolicyRequest {
|
|
2049
2272
|
/**
|
|
2273
|
+
* @public
|
|
2050
2274
|
* <p>The account ID of the Outposts bucket.</p>
|
|
2051
2275
|
*/
|
|
2052
2276
|
AccountId?: string;
|
|
2053
2277
|
/**
|
|
2278
|
+
* @public
|
|
2054
2279
|
* <p>Specifies the bucket.</p>
|
|
2055
2280
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
2056
2281
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
|
|
@@ -2062,11 +2287,13 @@ export interface DeleteBucketPolicyRequest {
|
|
|
2062
2287
|
*/
|
|
2063
2288
|
export interface DeleteBucketReplicationRequest {
|
|
2064
2289
|
/**
|
|
2290
|
+
* @public
|
|
2065
2291
|
* <p>The Amazon Web Services account ID of the Outposts bucket to delete the replication configuration
|
|
2066
2292
|
* for.</p>
|
|
2067
2293
|
*/
|
|
2068
2294
|
AccountId?: string;
|
|
2069
2295
|
/**
|
|
2296
|
+
* @public
|
|
2070
2297
|
* <p>Specifies the S3 on Outposts bucket to delete the replication configuration for.</p>
|
|
2071
2298
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
2072
2299
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
|
|
@@ -2078,10 +2305,12 @@ export interface DeleteBucketReplicationRequest {
|
|
|
2078
2305
|
*/
|
|
2079
2306
|
export interface DeleteBucketTaggingRequest {
|
|
2080
2307
|
/**
|
|
2308
|
+
* @public
|
|
2081
2309
|
* <p>The Amazon Web Services account ID of the Outposts bucket tag set to be removed.</p>
|
|
2082
2310
|
*/
|
|
2083
2311
|
AccountId?: string;
|
|
2084
2312
|
/**
|
|
2313
|
+
* @public
|
|
2085
2314
|
* <p>The bucket ARN that has the tag set to be removed.</p>
|
|
2086
2315
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
2087
2316
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
|
|
@@ -2093,10 +2322,12 @@ export interface DeleteBucketTaggingRequest {
|
|
|
2093
2322
|
*/
|
|
2094
2323
|
export interface DeleteJobTaggingRequest {
|
|
2095
2324
|
/**
|
|
2325
|
+
* @public
|
|
2096
2326
|
* <p>The Amazon Web Services account ID associated with the S3 Batch Operations job.</p>
|
|
2097
2327
|
*/
|
|
2098
2328
|
AccountId?: string;
|
|
2099
2329
|
/**
|
|
2330
|
+
* @public
|
|
2100
2331
|
* <p>The ID for the S3 Batch Operations job whose tags you want to delete.</p>
|
|
2101
2332
|
*/
|
|
2102
2333
|
JobId: string | undefined;
|
|
@@ -2124,15 +2355,18 @@ export declare class NotFoundException extends __BaseException {
|
|
|
2124
2355
|
*/
|
|
2125
2356
|
export interface DeleteMultiRegionAccessPointRequest {
|
|
2126
2357
|
/**
|
|
2358
|
+
* @public
|
|
2127
2359
|
* <p>The Amazon Web Services account ID for the owner of the Multi-Region Access Point.</p>
|
|
2128
2360
|
*/
|
|
2129
2361
|
AccountId?: string;
|
|
2130
2362
|
/**
|
|
2363
|
+
* @public
|
|
2131
2364
|
* <p>An idempotency token used to identify the request and guarantee that requests are
|
|
2132
2365
|
* unique.</p>
|
|
2133
2366
|
*/
|
|
2134
2367
|
ClientToken?: string;
|
|
2135
2368
|
/**
|
|
2369
|
+
* @public
|
|
2136
2370
|
* <p>A container element containing details about the Multi-Region Access Point.</p>
|
|
2137
2371
|
*/
|
|
2138
2372
|
Details: DeleteMultiRegionAccessPointInput | undefined;
|
|
@@ -2142,6 +2376,7 @@ export interface DeleteMultiRegionAccessPointRequest {
|
|
|
2142
2376
|
*/
|
|
2143
2377
|
export interface DeleteMultiRegionAccessPointResult {
|
|
2144
2378
|
/**
|
|
2379
|
+
* @public
|
|
2145
2380
|
* <p>The request token associated with the request. You can use this token with <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html">DescribeMultiRegionAccessPointOperation</a> to determine the status of asynchronous
|
|
2146
2381
|
* requests.</p>
|
|
2147
2382
|
*/
|
|
@@ -2152,6 +2387,7 @@ export interface DeleteMultiRegionAccessPointResult {
|
|
|
2152
2387
|
*/
|
|
2153
2388
|
export interface DeletePublicAccessBlockRequest {
|
|
2154
2389
|
/**
|
|
2390
|
+
* @public
|
|
2155
2391
|
* <p>The account ID for the Amazon Web Services account whose <code>PublicAccessBlock</code> configuration
|
|
2156
2392
|
* you want to remove.</p>
|
|
2157
2393
|
*/
|
|
@@ -2162,10 +2398,12 @@ export interface DeletePublicAccessBlockRequest {
|
|
|
2162
2398
|
*/
|
|
2163
2399
|
export interface DeleteStorageLensConfigurationRequest {
|
|
2164
2400
|
/**
|
|
2401
|
+
* @public
|
|
2165
2402
|
* <p>The ID of the S3 Storage Lens configuration.</p>
|
|
2166
2403
|
*/
|
|
2167
2404
|
ConfigId: string | undefined;
|
|
2168
2405
|
/**
|
|
2406
|
+
* @public
|
|
2169
2407
|
* <p>The account ID of the requester.</p>
|
|
2170
2408
|
*/
|
|
2171
2409
|
AccountId?: string;
|
|
@@ -2175,10 +2413,12 @@ export interface DeleteStorageLensConfigurationRequest {
|
|
|
2175
2413
|
*/
|
|
2176
2414
|
export interface DeleteStorageLensConfigurationTaggingRequest {
|
|
2177
2415
|
/**
|
|
2416
|
+
* @public
|
|
2178
2417
|
* <p>The ID of the S3 Storage Lens configuration.</p>
|
|
2179
2418
|
*/
|
|
2180
2419
|
ConfigId: string | undefined;
|
|
2181
2420
|
/**
|
|
2421
|
+
* @public
|
|
2182
2422
|
* <p>The account ID of the requester.</p>
|
|
2183
2423
|
*/
|
|
2184
2424
|
AccountId?: string;
|
|
@@ -2193,10 +2433,12 @@ export interface DeleteStorageLensConfigurationTaggingResult {
|
|
|
2193
2433
|
*/
|
|
2194
2434
|
export interface DescribeJobRequest {
|
|
2195
2435
|
/**
|
|
2436
|
+
* @public
|
|
2196
2437
|
* <p>The Amazon Web Services account ID associated with the S3 Batch Operations job.</p>
|
|
2197
2438
|
*/
|
|
2198
2439
|
AccountId?: string;
|
|
2199
2440
|
/**
|
|
2441
|
+
* @public
|
|
2200
2442
|
* <p>The ID for the job whose information you want to retrieve.</p>
|
|
2201
2443
|
*/
|
|
2202
2444
|
JobId: string | undefined;
|
|
@@ -2207,10 +2449,12 @@ export interface DescribeJobRequest {
|
|
|
2207
2449
|
*/
|
|
2208
2450
|
export interface JobFailure {
|
|
2209
2451
|
/**
|
|
2452
|
+
* @public
|
|
2210
2453
|
* <p>The failure code, if any, for the specified job.</p>
|
|
2211
2454
|
*/
|
|
2212
2455
|
FailureCode?: string;
|
|
2213
2456
|
/**
|
|
2457
|
+
* @public
|
|
2214
2458
|
* <p>The failure reason, if any, for the specified job.</p>
|
|
2215
2459
|
*/
|
|
2216
2460
|
FailureReason?: string;
|
|
@@ -2223,10 +2467,12 @@ export interface JobFailure {
|
|
|
2223
2467
|
*/
|
|
2224
2468
|
export interface S3GeneratedManifestDescriptor {
|
|
2225
2469
|
/**
|
|
2470
|
+
* @public
|
|
2226
2471
|
* <p>The format of the generated manifest.</p>
|
|
2227
2472
|
*/
|
|
2228
2473
|
Format?: GeneratedManifestFormat | string;
|
|
2229
2474
|
/**
|
|
2475
|
+
* @public
|
|
2230
2476
|
* <p>Contains the information required to locate a manifest object.</p>
|
|
2231
2477
|
*/
|
|
2232
2478
|
Location?: JobManifestLocation;
|
|
@@ -2237,6 +2483,7 @@ export interface S3GeneratedManifestDescriptor {
|
|
|
2237
2483
|
*/
|
|
2238
2484
|
export interface JobTimers {
|
|
2239
2485
|
/**
|
|
2486
|
+
* @public
|
|
2240
2487
|
* <p>Indicates the elapsed time in seconds the job has been in the Active job state.</p>
|
|
2241
2488
|
*/
|
|
2242
2489
|
ElapsedTimeInActiveSeconds?: number;
|
|
@@ -2248,18 +2495,22 @@ export interface JobTimers {
|
|
|
2248
2495
|
*/
|
|
2249
2496
|
export interface JobProgressSummary {
|
|
2250
2497
|
/**
|
|
2498
|
+
* @public
|
|
2251
2499
|
* <p></p>
|
|
2252
2500
|
*/
|
|
2253
2501
|
TotalNumberOfTasks?: number;
|
|
2254
2502
|
/**
|
|
2503
|
+
* @public
|
|
2255
2504
|
* <p></p>
|
|
2256
2505
|
*/
|
|
2257
2506
|
NumberOfTasksSucceeded?: number;
|
|
2258
2507
|
/**
|
|
2508
|
+
* @public
|
|
2259
2509
|
* <p></p>
|
|
2260
2510
|
*/
|
|
2261
2511
|
NumberOfTasksFailed?: number;
|
|
2262
2512
|
/**
|
|
2513
|
+
* @public
|
|
2263
2514
|
* <p>The JobTimers attribute of a job's progress summary.</p>
|
|
2264
2515
|
*/
|
|
2265
2516
|
Timers?: JobTimers;
|
|
@@ -2294,78 +2545,95 @@ export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
|
|
|
2294
2545
|
*/
|
|
2295
2546
|
export interface JobDescriptor {
|
|
2296
2547
|
/**
|
|
2548
|
+
* @public
|
|
2297
2549
|
* <p>The ID for the specified job.</p>
|
|
2298
2550
|
*/
|
|
2299
2551
|
JobId?: string;
|
|
2300
2552
|
/**
|
|
2553
|
+
* @public
|
|
2301
2554
|
* <p>Indicates whether confirmation is required before Amazon S3 begins running the specified job.
|
|
2302
2555
|
* Confirmation is required only for jobs created through the Amazon S3 console.</p>
|
|
2303
2556
|
*/
|
|
2304
2557
|
ConfirmationRequired?: boolean;
|
|
2305
2558
|
/**
|
|
2559
|
+
* @public
|
|
2306
2560
|
* <p>The description for this job, if one was provided in this job's <code>Create Job</code>
|
|
2307
2561
|
* request.</p>
|
|
2308
2562
|
*/
|
|
2309
2563
|
Description?: string;
|
|
2310
2564
|
/**
|
|
2565
|
+
* @public
|
|
2311
2566
|
* <p>The Amazon Resource Name (ARN) for this job.</p>
|
|
2312
2567
|
*/
|
|
2313
2568
|
JobArn?: string;
|
|
2314
2569
|
/**
|
|
2570
|
+
* @public
|
|
2315
2571
|
* <p>The current status of the specified job.</p>
|
|
2316
2572
|
*/
|
|
2317
2573
|
Status?: JobStatus | string;
|
|
2318
2574
|
/**
|
|
2575
|
+
* @public
|
|
2319
2576
|
* <p>The configuration information for the specified job's manifest object.</p>
|
|
2320
2577
|
*/
|
|
2321
2578
|
Manifest?: JobManifest;
|
|
2322
2579
|
/**
|
|
2580
|
+
* @public
|
|
2323
2581
|
* <p>The operation that the specified job is configured to run on the objects listed in the
|
|
2324
2582
|
* manifest.</p>
|
|
2325
2583
|
*/
|
|
2326
2584
|
Operation?: JobOperation;
|
|
2327
2585
|
/**
|
|
2586
|
+
* @public
|
|
2328
2587
|
* <p>The priority of the specified job.</p>
|
|
2329
2588
|
*/
|
|
2330
2589
|
Priority?: number;
|
|
2331
2590
|
/**
|
|
2591
|
+
* @public
|
|
2332
2592
|
* <p>Describes the total number of tasks that the specified job has run, the number of tasks
|
|
2333
2593
|
* that succeeded, and the number of tasks that failed.</p>
|
|
2334
2594
|
*/
|
|
2335
2595
|
ProgressSummary?: JobProgressSummary;
|
|
2336
2596
|
/**
|
|
2597
|
+
* @public
|
|
2337
2598
|
* <p>The reason for updating the job.</p>
|
|
2338
2599
|
*/
|
|
2339
2600
|
StatusUpdateReason?: string;
|
|
2340
2601
|
/**
|
|
2602
|
+
* @public
|
|
2341
2603
|
* <p>If the specified job failed, this field contains information describing the
|
|
2342
2604
|
* failure.</p>
|
|
2343
2605
|
*/
|
|
2344
2606
|
FailureReasons?: JobFailure[];
|
|
2345
2607
|
/**
|
|
2608
|
+
* @public
|
|
2346
2609
|
* <p>Contains the configuration information for the job-completion report if you requested
|
|
2347
2610
|
* one in the <code>Create Job</code> request.</p>
|
|
2348
2611
|
*/
|
|
2349
2612
|
Report?: JobReport;
|
|
2350
2613
|
/**
|
|
2614
|
+
* @public
|
|
2351
2615
|
* <p>A timestamp indicating when this job was created.</p>
|
|
2352
2616
|
*/
|
|
2353
2617
|
CreationTime?: Date;
|
|
2354
2618
|
/**
|
|
2619
|
+
* @public
|
|
2355
2620
|
* <p>A timestamp indicating when this job terminated. A job's termination date is the date
|
|
2356
2621
|
* and time when it succeeded, failed, or was canceled.</p>
|
|
2357
2622
|
*/
|
|
2358
2623
|
TerminationDate?: Date;
|
|
2359
2624
|
/**
|
|
2625
|
+
* @public
|
|
2360
2626
|
* <p>The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role assigned to run the tasks
|
|
2361
2627
|
* for this job.</p>
|
|
2362
2628
|
*/
|
|
2363
2629
|
RoleArn?: string;
|
|
2364
2630
|
/**
|
|
2631
|
+
* @public
|
|
2365
2632
|
* <p>The timestamp when this job was suspended, if it has been suspended.</p>
|
|
2366
2633
|
*/
|
|
2367
2634
|
SuspendedDate?: Date;
|
|
2368
2635
|
/**
|
|
2636
|
+
* @public
|
|
2369
2637
|
* <p>The reason why the specified job was suspended. A job is only suspended if you create it
|
|
2370
2638
|
* through the Amazon S3 console. When you create the job, it enters the <code>Suspended</code>
|
|
2371
2639
|
* state to await confirmation before running. After you confirm the job, it automatically
|
|
@@ -2373,10 +2641,12 @@ export interface JobDescriptor {
|
|
|
2373
2641
|
*/
|
|
2374
2642
|
SuspendedCause?: string;
|
|
2375
2643
|
/**
|
|
2644
|
+
* @public
|
|
2376
2645
|
* <p>The manifest generator that was used to generate a job manifest for this job.</p>
|
|
2377
2646
|
*/
|
|
2378
2647
|
ManifestGenerator?: JobManifestGenerator;
|
|
2379
2648
|
/**
|
|
2649
|
+
* @public
|
|
2380
2650
|
* <p>The attribute of the JobDescriptor containing details about the job's generated
|
|
2381
2651
|
* manifest.</p>
|
|
2382
2652
|
*/
|
|
@@ -2387,6 +2657,7 @@ export interface JobDescriptor {
|
|
|
2387
2657
|
*/
|
|
2388
2658
|
export interface DescribeJobResult {
|
|
2389
2659
|
/**
|
|
2660
|
+
* @public
|
|
2390
2661
|
* <p>Contains the configuration parameters and status for the job specified in the
|
|
2391
2662
|
* <code>Describe Job</code> request.</p>
|
|
2392
2663
|
*/
|
|
@@ -2397,10 +2668,12 @@ export interface DescribeJobResult {
|
|
|
2397
2668
|
*/
|
|
2398
2669
|
export interface DescribeMultiRegionAccessPointOperationRequest {
|
|
2399
2670
|
/**
|
|
2671
|
+
* @public
|
|
2400
2672
|
* <p>The Amazon Web Services account ID for the owner of the Multi-Region Access Point.</p>
|
|
2401
2673
|
*/
|
|
2402
2674
|
AccountId?: string;
|
|
2403
2675
|
/**
|
|
2676
|
+
* @public
|
|
2404
2677
|
* <p>The request token associated with the request you want to know about. This request token
|
|
2405
2678
|
* is returned as part of the response when you make an asynchronous request. You provide this
|
|
2406
2679
|
* token to query about the status of the asynchronous action.</p>
|
|
@@ -2412,6 +2685,7 @@ export interface DescribeMultiRegionAccessPointOperationRequest {
|
|
|
2412
2685
|
*/
|
|
2413
2686
|
export interface DescribeMultiRegionAccessPointOperationResult {
|
|
2414
2687
|
/**
|
|
2688
|
+
* @public
|
|
2415
2689
|
* <p>A container element containing the details of the asynchronous operation.</p>
|
|
2416
2690
|
*/
|
|
2417
2691
|
AsyncOperation?: AsyncOperation;
|
|
@@ -2421,10 +2695,12 @@ export interface DescribeMultiRegionAccessPointOperationResult {
|
|
|
2421
2695
|
*/
|
|
2422
2696
|
export interface GetAccessPointRequest {
|
|
2423
2697
|
/**
|
|
2698
|
+
* @public
|
|
2424
2699
|
* <p>The Amazon Web Services account ID for the account that owns the specified access point.</p>
|
|
2425
2700
|
*/
|
|
2426
2701
|
AccountId?: string;
|
|
2427
2702
|
/**
|
|
2703
|
+
* @public
|
|
2428
2704
|
* <p>The name of the access point whose configuration information you want to retrieve.</p>
|
|
2429
2705
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
2430
2706
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name></code>. For example, to access the access point <code>reports-ap</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap</code>. The value must be URL encoded. </p>
|
|
@@ -2436,14 +2712,17 @@ export interface GetAccessPointRequest {
|
|
|
2436
2712
|
*/
|
|
2437
2713
|
export interface GetAccessPointResult {
|
|
2438
2714
|
/**
|
|
2715
|
+
* @public
|
|
2439
2716
|
* <p>The name of the specified access point.</p>
|
|
2440
2717
|
*/
|
|
2441
2718
|
Name?: string;
|
|
2442
2719
|
/**
|
|
2720
|
+
* @public
|
|
2443
2721
|
* <p>The name of the bucket associated with the specified access point.</p>
|
|
2444
2722
|
*/
|
|
2445
2723
|
Bucket?: string;
|
|
2446
2724
|
/**
|
|
2725
|
+
* @public
|
|
2447
2726
|
* <p>Indicates whether this access point allows access from the public internet. If
|
|
2448
2727
|
* <code>VpcConfiguration</code> is specified for this access point, then
|
|
2449
2728
|
* <code>NetworkOrigin</code> is <code>VPC</code>, and the access point doesn't allow access from
|
|
@@ -2454,6 +2733,7 @@ export interface GetAccessPointResult {
|
|
|
2454
2733
|
*/
|
|
2455
2734
|
NetworkOrigin?: NetworkOrigin | string;
|
|
2456
2735
|
/**
|
|
2736
|
+
* @public
|
|
2457
2737
|
* <p>Contains the virtual private cloud (VPC) configuration for the specified access point.</p>
|
|
2458
2738
|
* <note>
|
|
2459
2739
|
* <p>This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other
|
|
@@ -2462,6 +2742,7 @@ export interface GetAccessPointResult {
|
|
|
2462
2742
|
*/
|
|
2463
2743
|
VpcConfiguration?: VpcConfiguration;
|
|
2464
2744
|
/**
|
|
2745
|
+
* @public
|
|
2465
2746
|
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3
|
|
2466
2747
|
* account. You can enable the configuration options in any combination. For more information
|
|
2467
2748
|
* about when Amazon S3 considers a bucket or object public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -2469,22 +2750,27 @@ export interface GetAccessPointResult {
|
|
|
2469
2750
|
*/
|
|
2470
2751
|
PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
|
|
2471
2752
|
/**
|
|
2753
|
+
* @public
|
|
2472
2754
|
* <p>The date and time when the specified access point was created.</p>
|
|
2473
2755
|
*/
|
|
2474
2756
|
CreationDate?: Date;
|
|
2475
2757
|
/**
|
|
2758
|
+
* @public
|
|
2476
2759
|
* <p>The name or alias of the access point.</p>
|
|
2477
2760
|
*/
|
|
2478
2761
|
Alias?: string;
|
|
2479
2762
|
/**
|
|
2763
|
+
* @public
|
|
2480
2764
|
* <p>The ARN of the access point.</p>
|
|
2481
2765
|
*/
|
|
2482
2766
|
AccessPointArn?: string;
|
|
2483
2767
|
/**
|
|
2768
|
+
* @public
|
|
2484
2769
|
* <p>The VPC endpoint for the access point.</p>
|
|
2485
2770
|
*/
|
|
2486
2771
|
Endpoints?: Record<string, string>;
|
|
2487
2772
|
/**
|
|
2773
|
+
* @public
|
|
2488
2774
|
* <p>The Amazon Web Services account ID associated with the S3 bucket associated with this access point.</p>
|
|
2489
2775
|
*/
|
|
2490
2776
|
BucketAccountId?: string;
|
|
@@ -2494,10 +2780,12 @@ export interface GetAccessPointResult {
|
|
|
2494
2780
|
*/
|
|
2495
2781
|
export interface GetAccessPointConfigurationForObjectLambdaRequest {
|
|
2496
2782
|
/**
|
|
2783
|
+
* @public
|
|
2497
2784
|
* <p>The account ID for the account that owns the specified Object Lambda Access Point.</p>
|
|
2498
2785
|
*/
|
|
2499
2786
|
AccountId?: string;
|
|
2500
2787
|
/**
|
|
2788
|
+
* @public
|
|
2501
2789
|
* <p>The name of the Object Lambda Access Point you want to return the configuration for.</p>
|
|
2502
2790
|
*/
|
|
2503
2791
|
Name: string | undefined;
|
|
@@ -2507,6 +2795,7 @@ export interface GetAccessPointConfigurationForObjectLambdaRequest {
|
|
|
2507
2795
|
*/
|
|
2508
2796
|
export interface GetAccessPointConfigurationForObjectLambdaResult {
|
|
2509
2797
|
/**
|
|
2798
|
+
* @public
|
|
2510
2799
|
* <p>Object Lambda Access Point configuration document.</p>
|
|
2511
2800
|
*/
|
|
2512
2801
|
Configuration?: ObjectLambdaConfiguration;
|
|
@@ -2516,10 +2805,12 @@ export interface GetAccessPointConfigurationForObjectLambdaResult {
|
|
|
2516
2805
|
*/
|
|
2517
2806
|
export interface GetAccessPointForObjectLambdaRequest {
|
|
2518
2807
|
/**
|
|
2808
|
+
* @public
|
|
2519
2809
|
* <p>The account ID for the account that owns the specified Object Lambda Access Point.</p>
|
|
2520
2810
|
*/
|
|
2521
2811
|
AccountId?: string;
|
|
2522
2812
|
/**
|
|
2813
|
+
* @public
|
|
2523
2814
|
* <p>The name of the Object Lambda Access Point.</p>
|
|
2524
2815
|
*/
|
|
2525
2816
|
Name: string | undefined;
|
|
@@ -2529,19 +2820,23 @@ export interface GetAccessPointForObjectLambdaRequest {
|
|
|
2529
2820
|
*/
|
|
2530
2821
|
export interface GetAccessPointForObjectLambdaResult {
|
|
2531
2822
|
/**
|
|
2823
|
+
* @public
|
|
2532
2824
|
* <p>The name of the Object Lambda Access Point.</p>
|
|
2533
2825
|
*/
|
|
2534
2826
|
Name?: string;
|
|
2535
2827
|
/**
|
|
2828
|
+
* @public
|
|
2536
2829
|
* <p>Configuration to block all public access. This setting is turned on and can not be
|
|
2537
2830
|
* edited. </p>
|
|
2538
2831
|
*/
|
|
2539
2832
|
PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
|
|
2540
2833
|
/**
|
|
2834
|
+
* @public
|
|
2541
2835
|
* <p>The date and time when the specified Object Lambda Access Point was created.</p>
|
|
2542
2836
|
*/
|
|
2543
2837
|
CreationDate?: Date;
|
|
2544
2838
|
/**
|
|
2839
|
+
* @public
|
|
2545
2840
|
* <p>The alias of the Object Lambda Access Point.</p>
|
|
2546
2841
|
*/
|
|
2547
2842
|
Alias?: ObjectLambdaAccessPointAlias;
|
|
@@ -2551,10 +2846,12 @@ export interface GetAccessPointForObjectLambdaResult {
|
|
|
2551
2846
|
*/
|
|
2552
2847
|
export interface GetAccessPointPolicyRequest {
|
|
2553
2848
|
/**
|
|
2849
|
+
* @public
|
|
2554
2850
|
* <p>The account ID for the account that owns the specified access point.</p>
|
|
2555
2851
|
*/
|
|
2556
2852
|
AccountId?: string;
|
|
2557
2853
|
/**
|
|
2854
|
+
* @public
|
|
2558
2855
|
* <p>The name of the access point whose policy you want to retrieve.</p>
|
|
2559
2856
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
2560
2857
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name></code>. For example, to access the access point <code>reports-ap</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap</code>. The value must be URL encoded. </p>
|
|
@@ -2566,6 +2863,7 @@ export interface GetAccessPointPolicyRequest {
|
|
|
2566
2863
|
*/
|
|
2567
2864
|
export interface GetAccessPointPolicyResult {
|
|
2568
2865
|
/**
|
|
2866
|
+
* @public
|
|
2569
2867
|
* <p>The access point policy associated with the specified access point.</p>
|
|
2570
2868
|
*/
|
|
2571
2869
|
Policy?: string;
|
|
@@ -2575,10 +2873,12 @@ export interface GetAccessPointPolicyResult {
|
|
|
2575
2873
|
*/
|
|
2576
2874
|
export interface GetAccessPointPolicyForObjectLambdaRequest {
|
|
2577
2875
|
/**
|
|
2876
|
+
* @public
|
|
2578
2877
|
* <p>The account ID for the account that owns the specified Object Lambda Access Point.</p>
|
|
2579
2878
|
*/
|
|
2580
2879
|
AccountId?: string;
|
|
2581
2880
|
/**
|
|
2881
|
+
* @public
|
|
2582
2882
|
* <p>The name of the Object Lambda Access Point.</p>
|
|
2583
2883
|
*/
|
|
2584
2884
|
Name: string | undefined;
|
|
@@ -2588,6 +2888,7 @@ export interface GetAccessPointPolicyForObjectLambdaRequest {
|
|
|
2588
2888
|
*/
|
|
2589
2889
|
export interface GetAccessPointPolicyForObjectLambdaResult {
|
|
2590
2890
|
/**
|
|
2891
|
+
* @public
|
|
2591
2892
|
* <p>Object Lambda Access Point resource policy document.</p>
|
|
2592
2893
|
*/
|
|
2593
2894
|
Policy?: string;
|
|
@@ -2597,10 +2898,12 @@ export interface GetAccessPointPolicyForObjectLambdaResult {
|
|
|
2597
2898
|
*/
|
|
2598
2899
|
export interface GetAccessPointPolicyStatusRequest {
|
|
2599
2900
|
/**
|
|
2901
|
+
* @public
|
|
2600
2902
|
* <p>The account ID for the account that owns the specified access point.</p>
|
|
2601
2903
|
*/
|
|
2602
2904
|
AccountId?: string;
|
|
2603
2905
|
/**
|
|
2906
|
+
* @public
|
|
2604
2907
|
* <p>The name of the access point whose policy status you want to retrieve.</p>
|
|
2605
2908
|
*/
|
|
2606
2909
|
Name: string | undefined;
|
|
@@ -2612,6 +2915,7 @@ export interface GetAccessPointPolicyStatusRequest {
|
|
|
2612
2915
|
*/
|
|
2613
2916
|
export interface PolicyStatus {
|
|
2614
2917
|
/**
|
|
2918
|
+
* @public
|
|
2615
2919
|
* <p></p>
|
|
2616
2920
|
*/
|
|
2617
2921
|
IsPublic?: boolean;
|
|
@@ -2621,6 +2925,7 @@ export interface PolicyStatus {
|
|
|
2621
2925
|
*/
|
|
2622
2926
|
export interface GetAccessPointPolicyStatusResult {
|
|
2623
2927
|
/**
|
|
2928
|
+
* @public
|
|
2624
2929
|
* <p>Indicates the current policy status of the specified access point.</p>
|
|
2625
2930
|
*/
|
|
2626
2931
|
PolicyStatus?: PolicyStatus;
|
|
@@ -2630,10 +2935,12 @@ export interface GetAccessPointPolicyStatusResult {
|
|
|
2630
2935
|
*/
|
|
2631
2936
|
export interface GetAccessPointPolicyStatusForObjectLambdaRequest {
|
|
2632
2937
|
/**
|
|
2938
|
+
* @public
|
|
2633
2939
|
* <p>The account ID for the account that owns the specified Object Lambda Access Point.</p>
|
|
2634
2940
|
*/
|
|
2635
2941
|
AccountId?: string;
|
|
2636
2942
|
/**
|
|
2943
|
+
* @public
|
|
2637
2944
|
* <p>The name of the Object Lambda Access Point.</p>
|
|
2638
2945
|
*/
|
|
2639
2946
|
Name: string | undefined;
|
|
@@ -2643,6 +2950,7 @@ export interface GetAccessPointPolicyStatusForObjectLambdaRequest {
|
|
|
2643
2950
|
*/
|
|
2644
2951
|
export interface GetAccessPointPolicyStatusForObjectLambdaResult {
|
|
2645
2952
|
/**
|
|
2953
|
+
* @public
|
|
2646
2954
|
* <p>Indicates whether this access point policy is public. For more information about how Amazon S3
|
|
2647
2955
|
* evaluates policies to determine whether they are public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
2648
2956
|
*/
|
|
@@ -2653,10 +2961,12 @@ export interface GetAccessPointPolicyStatusForObjectLambdaResult {
|
|
|
2653
2961
|
*/
|
|
2654
2962
|
export interface GetBucketRequest {
|
|
2655
2963
|
/**
|
|
2964
|
+
* @public
|
|
2656
2965
|
* <p>The Amazon Web Services account ID of the Outposts bucket.</p>
|
|
2657
2966
|
*/
|
|
2658
2967
|
AccountId?: string;
|
|
2659
2968
|
/**
|
|
2969
|
+
* @public
|
|
2660
2970
|
* <p>Specifies the bucket.</p>
|
|
2661
2971
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
2662
2972
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
|
|
@@ -2668,14 +2978,17 @@ export interface GetBucketRequest {
|
|
|
2668
2978
|
*/
|
|
2669
2979
|
export interface GetBucketResult {
|
|
2670
2980
|
/**
|
|
2981
|
+
* @public
|
|
2671
2982
|
* <p>The Outposts bucket requested.</p>
|
|
2672
2983
|
*/
|
|
2673
2984
|
Bucket?: string;
|
|
2674
2985
|
/**
|
|
2986
|
+
* @public
|
|
2675
2987
|
* <p></p>
|
|
2676
2988
|
*/
|
|
2677
2989
|
PublicAccessBlockEnabled?: boolean;
|
|
2678
2990
|
/**
|
|
2991
|
+
* @public
|
|
2679
2992
|
* <p>The creation date of the Outposts bucket.</p>
|
|
2680
2993
|
*/
|
|
2681
2994
|
CreationDate?: Date;
|
|
@@ -2685,10 +2998,12 @@ export interface GetBucketResult {
|
|
|
2685
2998
|
*/
|
|
2686
2999
|
export interface GetBucketLifecycleConfigurationRequest {
|
|
2687
3000
|
/**
|
|
3001
|
+
* @public
|
|
2688
3002
|
* <p>The Amazon Web Services account ID of the Outposts bucket.</p>
|
|
2689
3003
|
*/
|
|
2690
3004
|
AccountId?: string;
|
|
2691
3005
|
/**
|
|
3006
|
+
* @public
|
|
2692
3007
|
* <p>The Amazon Resource Name (ARN) of the bucket.</p>
|
|
2693
3008
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
2694
3009
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
|
|
@@ -2701,16 +3016,19 @@ export interface GetBucketLifecycleConfigurationRequest {
|
|
|
2701
3016
|
*/
|
|
2702
3017
|
export interface LifecycleExpiration {
|
|
2703
3018
|
/**
|
|
3019
|
+
* @public
|
|
2704
3020
|
* <p>Indicates at what date the object is to be deleted. Should be in GMT ISO 8601
|
|
2705
3021
|
* format.</p>
|
|
2706
3022
|
*/
|
|
2707
3023
|
Date?: Date;
|
|
2708
3024
|
/**
|
|
3025
|
+
* @public
|
|
2709
3026
|
* <p>Indicates the lifetime, in days, of the objects that are subject to the rule. The value
|
|
2710
3027
|
* must be a non-zero positive integer.</p>
|
|
2711
3028
|
*/
|
|
2712
3029
|
Days?: number;
|
|
2713
3030
|
/**
|
|
3031
|
+
* @public
|
|
2714
3032
|
* <p>Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set
|
|
2715
3033
|
* to true, the delete marker will be expired. If set to false, the policy takes no action.
|
|
2716
3034
|
* This cannot be specified with Days or Date in a Lifecycle Expiration Policy.</p>
|
|
@@ -2723,19 +3041,23 @@ export interface LifecycleExpiration {
|
|
|
2723
3041
|
*/
|
|
2724
3042
|
export interface LifecycleRuleAndOperator {
|
|
2725
3043
|
/**
|
|
3044
|
+
* @public
|
|
2726
3045
|
* <p>Prefix identifying one or more objects to which the rule applies.</p>
|
|
2727
3046
|
*/
|
|
2728
3047
|
Prefix?: string;
|
|
2729
3048
|
/**
|
|
3049
|
+
* @public
|
|
2730
3050
|
* <p>All of these tags must exist in the object's tag set in order for the rule to
|
|
2731
3051
|
* apply.</p>
|
|
2732
3052
|
*/
|
|
2733
3053
|
Tags?: S3Tag[];
|
|
2734
3054
|
/**
|
|
3055
|
+
* @public
|
|
2735
3056
|
* <p>Minimum object size to which the rule applies.</p>
|
|
2736
3057
|
*/
|
|
2737
3058
|
ObjectSizeGreaterThan?: number;
|
|
2738
3059
|
/**
|
|
3060
|
+
* @public
|
|
2739
3061
|
* <p>Maximum object size to which the rule applies.</p>
|
|
2740
3062
|
*/
|
|
2741
3063
|
ObjectSizeLessThan?: number;
|
|
@@ -2746,6 +3068,7 @@ export interface LifecycleRuleAndOperator {
|
|
|
2746
3068
|
*/
|
|
2747
3069
|
export interface LifecycleRuleFilter {
|
|
2748
3070
|
/**
|
|
3071
|
+
* @public
|
|
2749
3072
|
* <p>Prefix identifying one or more objects to which the rule applies.</p>
|
|
2750
3073
|
* <important>
|
|
2751
3074
|
* <p>When you're using XML requests, you must
|
|
@@ -2756,18 +3079,22 @@ export interface LifecycleRuleFilter {
|
|
|
2756
3079
|
*/
|
|
2757
3080
|
Prefix?: string;
|
|
2758
3081
|
/**
|
|
3082
|
+
* @public
|
|
2759
3083
|
* <p>A container for a key-value name pair.</p>
|
|
2760
3084
|
*/
|
|
2761
3085
|
Tag?: S3Tag;
|
|
2762
3086
|
/**
|
|
3087
|
+
* @public
|
|
2763
3088
|
* <p>The container for the <code>AND</code> condition for the lifecycle rule.</p>
|
|
2764
3089
|
*/
|
|
2765
3090
|
And?: LifecycleRuleAndOperator;
|
|
2766
3091
|
/**
|
|
3092
|
+
* @public
|
|
2767
3093
|
* <p>Minimum object size to which the rule applies.</p>
|
|
2768
3094
|
*/
|
|
2769
3095
|
ObjectSizeGreaterThan?: number;
|
|
2770
3096
|
/**
|
|
3097
|
+
* @public
|
|
2771
3098
|
* <p>Maximum object size to which the rule applies.</p>
|
|
2772
3099
|
*/
|
|
2773
3100
|
ObjectSizeLessThan?: number;
|
|
@@ -2778,6 +3105,7 @@ export interface LifecycleRuleFilter {
|
|
|
2778
3105
|
*/
|
|
2779
3106
|
export interface NoncurrentVersionExpiration {
|
|
2780
3107
|
/**
|
|
3108
|
+
* @public
|
|
2781
3109
|
* <p>Specifies the number of days an object is noncurrent before Amazon S3 can perform the
|
|
2782
3110
|
* associated action. For information about the noncurrent days calculations, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations">How
|
|
2783
3111
|
* Amazon S3 Calculates When an Object Became Noncurrent</a> in the
|
|
@@ -2785,6 +3113,7 @@ export interface NoncurrentVersionExpiration {
|
|
|
2785
3113
|
*/
|
|
2786
3114
|
NoncurrentDays?: number;
|
|
2787
3115
|
/**
|
|
3116
|
+
* @public
|
|
2788
3117
|
* <p>Specifies how many noncurrent versions S3 on Outposts will retain. If there are this many
|
|
2789
3118
|
* more recent noncurrent versions, S3 on Outposts will take the associated action. For more
|
|
2790
3119
|
* information about noncurrent versions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html">Lifecycle configuration
|
|
@@ -2813,6 +3142,7 @@ export type TransitionStorageClass = (typeof TransitionStorageClass)[keyof typeo
|
|
|
2813
3142
|
*/
|
|
2814
3143
|
export interface NoncurrentVersionTransition {
|
|
2815
3144
|
/**
|
|
3145
|
+
* @public
|
|
2816
3146
|
* <p>Specifies the number of days an object is noncurrent before Amazon S3 can perform the
|
|
2817
3147
|
* associated action. For information about the noncurrent days calculations, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations"> How
|
|
2818
3148
|
* Amazon S3 Calculates How Long an Object Has Been Noncurrent</a> in the
|
|
@@ -2820,6 +3150,7 @@ export interface NoncurrentVersionTransition {
|
|
|
2820
3150
|
*/
|
|
2821
3151
|
NoncurrentDays?: number;
|
|
2822
3152
|
/**
|
|
3153
|
+
* @public
|
|
2823
3154
|
* <p>The class of storage used to store the object.</p>
|
|
2824
3155
|
*/
|
|
2825
3156
|
StorageClass?: TransitionStorageClass | string;
|
|
@@ -2845,16 +3176,19 @@ export type ExpirationStatus = (typeof ExpirationStatus)[keyof typeof Expiration
|
|
|
2845
3176
|
*/
|
|
2846
3177
|
export interface Transition {
|
|
2847
3178
|
/**
|
|
3179
|
+
* @public
|
|
2848
3180
|
* <p>Indicates when objects are transitioned to the specified storage class. The date value
|
|
2849
3181
|
* must be in ISO 8601 format. The time is always midnight UTC.</p>
|
|
2850
3182
|
*/
|
|
2851
3183
|
Date?: Date;
|
|
2852
3184
|
/**
|
|
3185
|
+
* @public
|
|
2853
3186
|
* <p>Indicates the number of days after creation when objects are transitioned to the
|
|
2854
3187
|
* specified storage class. The value must be a positive integer.</p>
|
|
2855
3188
|
*/
|
|
2856
3189
|
Days?: number;
|
|
2857
3190
|
/**
|
|
3191
|
+
* @public
|
|
2858
3192
|
* <p>The storage class to which you want the object to transition.</p>
|
|
2859
3193
|
*/
|
|
2860
3194
|
StorageClass?: TransitionStorageClass | string;
|
|
@@ -2865,24 +3199,29 @@ export interface Transition {
|
|
|
2865
3199
|
*/
|
|
2866
3200
|
export interface LifecycleRule {
|
|
2867
3201
|
/**
|
|
3202
|
+
* @public
|
|
2868
3203
|
* <p>Specifies the expiration for the lifecycle of the object in the form of date, days and,
|
|
2869
3204
|
* whether the object has a delete marker.</p>
|
|
2870
3205
|
*/
|
|
2871
3206
|
Expiration?: LifecycleExpiration;
|
|
2872
3207
|
/**
|
|
3208
|
+
* @public
|
|
2873
3209
|
* <p>Unique identifier for the rule. The value cannot be longer than 255 characters.</p>
|
|
2874
3210
|
*/
|
|
2875
3211
|
ID?: string;
|
|
2876
3212
|
/**
|
|
3213
|
+
* @public
|
|
2877
3214
|
* <p>The container for the filter of lifecycle rule.</p>
|
|
2878
3215
|
*/
|
|
2879
3216
|
Filter?: LifecycleRuleFilter;
|
|
2880
3217
|
/**
|
|
3218
|
+
* @public
|
|
2881
3219
|
* <p>If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not
|
|
2882
3220
|
* currently being applied.</p>
|
|
2883
3221
|
*/
|
|
2884
3222
|
Status: ExpirationStatus | string | undefined;
|
|
2885
3223
|
/**
|
|
3224
|
+
* @public
|
|
2886
3225
|
* <p>Specifies when an Amazon S3 object transitions to a specified storage class.</p>
|
|
2887
3226
|
* <note>
|
|
2888
3227
|
* <p>This is not supported by Amazon S3 on Outposts buckets.</p>
|
|
@@ -2890,6 +3229,7 @@ export interface LifecycleRule {
|
|
|
2890
3229
|
*/
|
|
2891
3230
|
Transitions?: Transition[];
|
|
2892
3231
|
/**
|
|
3232
|
+
* @public
|
|
2893
3233
|
* <p> Specifies the transition rule for the lifecycle rule that describes when noncurrent
|
|
2894
3234
|
* objects transition to a specific storage class. If your bucket is versioning-enabled (or
|
|
2895
3235
|
* versioning is suspended), you can set this action to request that Amazon S3 transition
|
|
@@ -2901,10 +3241,12 @@ export interface LifecycleRule {
|
|
|
2901
3241
|
*/
|
|
2902
3242
|
NoncurrentVersionTransitions?: NoncurrentVersionTransition[];
|
|
2903
3243
|
/**
|
|
3244
|
+
* @public
|
|
2904
3245
|
* <p>The noncurrent version expiration of the lifecycle rule.</p>
|
|
2905
3246
|
*/
|
|
2906
3247
|
NoncurrentVersionExpiration?: NoncurrentVersionExpiration;
|
|
2907
3248
|
/**
|
|
3249
|
+
* @public
|
|
2908
3250
|
* <p>Specifies the days since the initiation of an incomplete multipart upload that Amazon S3
|
|
2909
3251
|
* waits before permanently removing all parts of the upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">
|
|
2910
3252
|
* Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration</a> in the
|
|
@@ -2917,6 +3259,7 @@ export interface LifecycleRule {
|
|
|
2917
3259
|
*/
|
|
2918
3260
|
export interface GetBucketLifecycleConfigurationResult {
|
|
2919
3261
|
/**
|
|
3262
|
+
* @public
|
|
2920
3263
|
* <p>Container for the lifecycle rule of the Outposts bucket.</p>
|
|
2921
3264
|
*/
|
|
2922
3265
|
Rules?: LifecycleRule[];
|
|
@@ -2926,10 +3269,12 @@ export interface GetBucketLifecycleConfigurationResult {
|
|
|
2926
3269
|
*/
|
|
2927
3270
|
export interface GetBucketPolicyRequest {
|
|
2928
3271
|
/**
|
|
3272
|
+
* @public
|
|
2929
3273
|
* <p>The Amazon Web Services account ID of the Outposts bucket.</p>
|
|
2930
3274
|
*/
|
|
2931
3275
|
AccountId?: string;
|
|
2932
3276
|
/**
|
|
3277
|
+
* @public
|
|
2933
3278
|
* <p>Specifies the bucket.</p>
|
|
2934
3279
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
2935
3280
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
|
|
@@ -2941,6 +3286,7 @@ export interface GetBucketPolicyRequest {
|
|
|
2941
3286
|
*/
|
|
2942
3287
|
export interface GetBucketPolicyResult {
|
|
2943
3288
|
/**
|
|
3289
|
+
* @public
|
|
2944
3290
|
* <p>The policy of the Outposts bucket.</p>
|
|
2945
3291
|
*/
|
|
2946
3292
|
Policy?: string;
|
|
@@ -2950,10 +3296,12 @@ export interface GetBucketPolicyResult {
|
|
|
2950
3296
|
*/
|
|
2951
3297
|
export interface GetBucketReplicationRequest {
|
|
2952
3298
|
/**
|
|
3299
|
+
* @public
|
|
2953
3300
|
* <p>The Amazon Web Services account ID of the Outposts bucket.</p>
|
|
2954
3301
|
*/
|
|
2955
3302
|
AccountId?: string;
|
|
2956
3303
|
/**
|
|
3304
|
+
* @public
|
|
2957
3305
|
* <p>Specifies the bucket to get the replication information for.</p>
|
|
2958
3306
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
2959
3307
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
|
|
@@ -2984,6 +3332,7 @@ export type DeleteMarkerReplicationStatus = (typeof DeleteMarkerReplicationStatu
|
|
|
2984
3332
|
*/
|
|
2985
3333
|
export interface DeleteMarkerReplication {
|
|
2986
3334
|
/**
|
|
3335
|
+
* @public
|
|
2987
3336
|
* <p>Indicates whether to replicate delete markers.</p>
|
|
2988
3337
|
*/
|
|
2989
3338
|
Status: DeleteMarkerReplicationStatus | string | undefined;
|
|
@@ -2998,6 +3347,7 @@ export interface DeleteMarkerReplication {
|
|
|
2998
3347
|
*/
|
|
2999
3348
|
export interface EncryptionConfiguration {
|
|
3000
3349
|
/**
|
|
3350
|
+
* @public
|
|
3001
3351
|
* <p>Specifies the ID of the customer managed KMS key that's stored in Key Management Service (KMS)
|
|
3002
3352
|
* for the destination bucket. This ID is either the Amazon Resource Name (ARN) for the
|
|
3003
3353
|
* KMS key or the alias ARN for the KMS key. Amazon S3 uses this KMS key to encrypt
|
|
@@ -3018,6 +3368,7 @@ export interface EncryptionConfiguration {
|
|
|
3018
3368
|
*/
|
|
3019
3369
|
export interface ReplicationTimeValue {
|
|
3020
3370
|
/**
|
|
3371
|
+
* @public
|
|
3021
3372
|
* <p>Contains an integer that specifies the time period in minutes. </p>
|
|
3022
3373
|
* <p>Valid value: 15</p>
|
|
3023
3374
|
*/
|
|
@@ -3041,10 +3392,12 @@ export type MetricsStatus = (typeof MetricsStatus)[keyof typeof MetricsStatus];
|
|
|
3041
3392
|
*/
|
|
3042
3393
|
export interface Metrics {
|
|
3043
3394
|
/**
|
|
3395
|
+
* @public
|
|
3044
3396
|
* <p>Specifies whether replication metrics are enabled. </p>
|
|
3045
3397
|
*/
|
|
3046
3398
|
Status: MetricsStatus | string | undefined;
|
|
3047
3399
|
/**
|
|
3400
|
+
* @public
|
|
3048
3401
|
* <p>A container that specifies the time threshold for emitting the
|
|
3049
3402
|
* <code>s3:Replication:OperationMissedThreshold</code> event. </p>
|
|
3050
3403
|
* <note>
|
|
@@ -3076,10 +3429,12 @@ export type ReplicationTimeStatus = (typeof ReplicationTimeStatus)[keyof typeof
|
|
|
3076
3429
|
*/
|
|
3077
3430
|
export interface ReplicationTime {
|
|
3078
3431
|
/**
|
|
3432
|
+
* @public
|
|
3079
3433
|
* <p>Specifies whether S3 Replication Time Control (S3 RTC) is enabled. </p>
|
|
3080
3434
|
*/
|
|
3081
3435
|
Status: ReplicationTimeStatus | string | undefined;
|
|
3082
3436
|
/**
|
|
3437
|
+
* @public
|
|
3083
3438
|
* <p>A container that specifies the time by which replication should be complete for all
|
|
3084
3439
|
* objects and operations on objects. </p>
|
|
3085
3440
|
*/
|
|
@@ -3111,15 +3466,18 @@ export type ReplicationStorageClass = (typeof ReplicationStorageClass)[keyof typ
|
|
|
3111
3466
|
*/
|
|
3112
3467
|
export interface Destination {
|
|
3113
3468
|
/**
|
|
3469
|
+
* @public
|
|
3114
3470
|
* <p>The destination bucket owner's account ID. </p>
|
|
3115
3471
|
*/
|
|
3116
3472
|
Account?: string;
|
|
3117
3473
|
/**
|
|
3474
|
+
* @public
|
|
3118
3475
|
* <p>The Amazon Resource Name (ARN) of the access point for the destination bucket where you want
|
|
3119
3476
|
* S3 on Outposts to store the replication results.</p>
|
|
3120
3477
|
*/
|
|
3121
3478
|
Bucket: string | undefined;
|
|
3122
3479
|
/**
|
|
3480
|
+
* @public
|
|
3123
3481
|
* <p>A container that specifies S3 Replication Time Control (S3 RTC) settings, including whether S3 RTC is enabled
|
|
3124
3482
|
* and the time when all objects and operations on objects must be replicated. Must be
|
|
3125
3483
|
* specified together with a <code>Metrics</code> block. </p>
|
|
@@ -3129,6 +3487,7 @@ export interface Destination {
|
|
|
3129
3487
|
*/
|
|
3130
3488
|
ReplicationTime?: ReplicationTime;
|
|
3131
3489
|
/**
|
|
3490
|
+
* @public
|
|
3132
3491
|
* <p>Specify this property only in a cross-account scenario (where the source and destination
|
|
3133
3492
|
* bucket owners are not the same), and you want to change replica ownership to the
|
|
3134
3493
|
* Amazon Web Services account that owns the destination bucket. If this property is not specified in the
|
|
@@ -3140,6 +3499,7 @@ export interface Destination {
|
|
|
3140
3499
|
*/
|
|
3141
3500
|
AccessControlTranslation?: AccessControlTranslation;
|
|
3142
3501
|
/**
|
|
3502
|
+
* @public
|
|
3143
3503
|
* <p>A container that provides information about encryption. If
|
|
3144
3504
|
* <code>SourceSelectionCriteria</code> is specified, you must specify this element.</p>
|
|
3145
3505
|
* <note>
|
|
@@ -3148,10 +3508,12 @@ export interface Destination {
|
|
|
3148
3508
|
*/
|
|
3149
3509
|
EncryptionConfiguration?: EncryptionConfiguration;
|
|
3150
3510
|
/**
|
|
3511
|
+
* @public
|
|
3151
3512
|
* <p> A container that specifies replication metrics-related settings. </p>
|
|
3152
3513
|
*/
|
|
3153
3514
|
Metrics?: Metrics;
|
|
3154
3515
|
/**
|
|
3516
|
+
* @public
|
|
3155
3517
|
* <p> The storage class to use when replicating objects. All objects stored on S3 on Outposts
|
|
3156
3518
|
* are stored in the <code>OUTPOSTS</code> storage class. S3 on Outposts uses the
|
|
3157
3519
|
* <code>OUTPOSTS</code> storage class to create the object replicas. </p>
|
|
@@ -3182,6 +3544,7 @@ export type ExistingObjectReplicationStatus = (typeof ExistingObjectReplicationS
|
|
|
3182
3544
|
*/
|
|
3183
3545
|
export interface ExistingObjectReplication {
|
|
3184
3546
|
/**
|
|
3547
|
+
* @public
|
|
3185
3548
|
* <p>Specifies whether Amazon S3 replicates existing source bucket objects. </p>
|
|
3186
3549
|
*/
|
|
3187
3550
|
Status: ExistingObjectReplicationStatus | string | undefined;
|
|
@@ -3204,11 +3567,13 @@ export interface ExistingObjectReplication {
|
|
|
3204
3567
|
*/
|
|
3205
3568
|
export interface ReplicationRuleAndOperator {
|
|
3206
3569
|
/**
|
|
3570
|
+
* @public
|
|
3207
3571
|
* <p>An object key name prefix that identifies the subset of objects that the rule applies
|
|
3208
3572
|
* to.</p>
|
|
3209
3573
|
*/
|
|
3210
3574
|
Prefix?: string;
|
|
3211
3575
|
/**
|
|
3576
|
+
* @public
|
|
3212
3577
|
* <p>An array of tags that contain key and value pairs.</p>
|
|
3213
3578
|
*/
|
|
3214
3579
|
Tags?: S3Tag[];
|
|
@@ -3221,6 +3586,7 @@ export interface ReplicationRuleAndOperator {
|
|
|
3221
3586
|
*/
|
|
3222
3587
|
export interface ReplicationRuleFilter {
|
|
3223
3588
|
/**
|
|
3589
|
+
* @public
|
|
3224
3590
|
* <p>An object key name prefix that identifies the subset of objects that the rule applies
|
|
3225
3591
|
* to.</p>
|
|
3226
3592
|
* <important>
|
|
@@ -3232,10 +3598,12 @@ export interface ReplicationRuleFilter {
|
|
|
3232
3598
|
*/
|
|
3233
3599
|
Prefix?: string;
|
|
3234
3600
|
/**
|
|
3601
|
+
* @public
|
|
3235
3602
|
* <p>A container for a key-value name pair.</p>
|
|
3236
3603
|
*/
|
|
3237
3604
|
Tag?: S3Tag;
|
|
3238
3605
|
/**
|
|
3606
|
+
* @public
|
|
3239
3607
|
* <p>A container for specifying rule filters. The filters determine the subset of objects
|
|
3240
3608
|
* that the rule applies to. This element is required only if you specify more than one
|
|
3241
3609
|
* filter. For example: </p>
|
|
@@ -3281,6 +3649,7 @@ export type ReplicaModificationsStatus = (typeof ReplicaModificationsStatus)[key
|
|
|
3281
3649
|
*/
|
|
3282
3650
|
export interface ReplicaModifications {
|
|
3283
3651
|
/**
|
|
3652
|
+
* @public
|
|
3284
3653
|
* <p>Specifies whether S3 on Outposts replicates modifications to object metadata on
|
|
3285
3654
|
* replicas.</p>
|
|
3286
3655
|
*/
|
|
@@ -3308,6 +3677,7 @@ export type SseKmsEncryptedObjectsStatus = (typeof SseKmsEncryptedObjectsStatus)
|
|
|
3308
3677
|
*/
|
|
3309
3678
|
export interface SseKmsEncryptedObjects {
|
|
3310
3679
|
/**
|
|
3680
|
+
* @public
|
|
3311
3681
|
* <p>Specifies whether Amazon S3 replicates objects that are created with server-side encryption
|
|
3312
3682
|
* by using an KMS key stored in Key Management Service.</p>
|
|
3313
3683
|
*/
|
|
@@ -3321,6 +3691,7 @@ export interface SseKmsEncryptedObjects {
|
|
|
3321
3691
|
*/
|
|
3322
3692
|
export interface SourceSelectionCriteria {
|
|
3323
3693
|
/**
|
|
3694
|
+
* @public
|
|
3324
3695
|
* <p>A filter that you can use to select Amazon S3 objects that are encrypted with server-side
|
|
3325
3696
|
* encryption by using Key Management Service (KMS) keys. If you include
|
|
3326
3697
|
* <code>SourceSelectionCriteria</code> in the replication configuration, this element is
|
|
@@ -3331,6 +3702,7 @@ export interface SourceSelectionCriteria {
|
|
|
3331
3702
|
*/
|
|
3332
3703
|
SseKmsEncryptedObjects?: SseKmsEncryptedObjects;
|
|
3333
3704
|
/**
|
|
3705
|
+
* @public
|
|
3334
3706
|
* <p>A filter that you can use to specify whether replica modification sync is enabled.
|
|
3335
3707
|
* S3 on Outposts replica modification sync can help you keep object metadata synchronized
|
|
3336
3708
|
* between replicas and source objects. By default, S3 on Outposts replicates metadata from the
|
|
@@ -3364,10 +3736,12 @@ export type ReplicationRuleStatus = (typeof ReplicationRuleStatus)[keyof typeof
|
|
|
3364
3736
|
*/
|
|
3365
3737
|
export interface ReplicationRule {
|
|
3366
3738
|
/**
|
|
3739
|
+
* @public
|
|
3367
3740
|
* <p>A unique identifier for the rule. The maximum value is 255 characters.</p>
|
|
3368
3741
|
*/
|
|
3369
3742
|
ID?: string;
|
|
3370
3743
|
/**
|
|
3744
|
+
* @public
|
|
3371
3745
|
* <p>The priority indicates which rule has precedence whenever two or more replication rules
|
|
3372
3746
|
* conflict. S3 on Outposts attempts to replicate objects according to all replication rules.
|
|
3373
3747
|
* However, if there are two or more rules with the same destination Outposts bucket, then objects will
|
|
@@ -3378,6 +3752,7 @@ export interface ReplicationRule {
|
|
|
3378
3752
|
*/
|
|
3379
3753
|
Priority?: number;
|
|
3380
3754
|
/**
|
|
3755
|
+
* @public
|
|
3381
3756
|
* @deprecated
|
|
3382
3757
|
*
|
|
3383
3758
|
* <p>An object key name prefix that identifies the object or objects to which the rule
|
|
@@ -3392,22 +3767,26 @@ export interface ReplicationRule {
|
|
|
3392
3767
|
*/
|
|
3393
3768
|
Prefix?: string;
|
|
3394
3769
|
/**
|
|
3770
|
+
* @public
|
|
3395
3771
|
* <p>A filter that identifies the subset of objects to which the replication rule applies. A
|
|
3396
3772
|
* <code>Filter</code> element must specify exactly one <code>Prefix</code>,
|
|
3397
3773
|
* <code>Tag</code>, or <code>And</code> child element.</p>
|
|
3398
3774
|
*/
|
|
3399
3775
|
Filter?: ReplicationRuleFilter;
|
|
3400
3776
|
/**
|
|
3777
|
+
* @public
|
|
3401
3778
|
* <p>Specifies whether the rule is enabled.</p>
|
|
3402
3779
|
*/
|
|
3403
3780
|
Status: ReplicationRuleStatus | string | undefined;
|
|
3404
3781
|
/**
|
|
3782
|
+
* @public
|
|
3405
3783
|
* <p>A container that describes additional filters for identifying the source Outposts objects that
|
|
3406
3784
|
* you want to replicate. You can choose to enable or disable the replication of these
|
|
3407
3785
|
* objects.</p>
|
|
3408
3786
|
*/
|
|
3409
3787
|
SourceSelectionCriteria?: SourceSelectionCriteria;
|
|
3410
3788
|
/**
|
|
3789
|
+
* @public
|
|
3411
3790
|
* <p>An optional configuration to replicate existing source bucket objects. </p>
|
|
3412
3791
|
* <note>
|
|
3413
3792
|
* <p>This is not supported by Amazon S3 on Outposts buckets.</p>
|
|
@@ -3415,10 +3794,12 @@ export interface ReplicationRule {
|
|
|
3415
3794
|
*/
|
|
3416
3795
|
ExistingObjectReplication?: ExistingObjectReplication;
|
|
3417
3796
|
/**
|
|
3797
|
+
* @public
|
|
3418
3798
|
* <p>A container for information about the replication destination and its configurations.</p>
|
|
3419
3799
|
*/
|
|
3420
3800
|
Destination: Destination | undefined;
|
|
3421
3801
|
/**
|
|
3802
|
+
* @public
|
|
3422
3803
|
* <p>Specifies whether S3 on Outposts replicates delete markers. If you specify a
|
|
3423
3804
|
* <code>Filter</code> element in your replication configuration, you must also include a
|
|
3424
3805
|
* <code>DeleteMarkerReplication</code> element. If your <code>Filter</code> includes a
|
|
@@ -3429,6 +3810,7 @@ export interface ReplicationRule {
|
|
|
3429
3810
|
*/
|
|
3430
3811
|
DeleteMarkerReplication?: DeleteMarkerReplication;
|
|
3431
3812
|
/**
|
|
3813
|
+
* @public
|
|
3432
3814
|
* <p>The Amazon Resource Name (ARN) of the access point for the source Outposts bucket that you want
|
|
3433
3815
|
* S3 on Outposts to replicate the objects from.</p>
|
|
3434
3816
|
*/
|
|
@@ -3441,6 +3823,7 @@ export interface ReplicationRule {
|
|
|
3441
3823
|
*/
|
|
3442
3824
|
export interface ReplicationConfiguration {
|
|
3443
3825
|
/**
|
|
3826
|
+
* @public
|
|
3444
3827
|
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that S3 on Outposts assumes
|
|
3445
3828
|
* when replicating objects. For information about S3 replication on Outposts configuration,
|
|
3446
3829
|
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/outposts-replication-how-setup.html">Setting up
|
|
@@ -3448,6 +3831,7 @@ export interface ReplicationConfiguration {
|
|
|
3448
3831
|
*/
|
|
3449
3832
|
Role: string | undefined;
|
|
3450
3833
|
/**
|
|
3834
|
+
* @public
|
|
3451
3835
|
* <p>A container for one or more replication rules. A replication configuration must have at
|
|
3452
3836
|
* least one rule and can contain an array of 100 rules at the most. </p>
|
|
3453
3837
|
*/
|
|
@@ -3458,6 +3842,7 @@ export interface ReplicationConfiguration {
|
|
|
3458
3842
|
*/
|
|
3459
3843
|
export interface GetBucketReplicationResult {
|
|
3460
3844
|
/**
|
|
3845
|
+
* @public
|
|
3461
3846
|
* <p>A container for one or more replication rules. A replication configuration must have at least one rule and you can add up to 100 rules. The maximum size of a
|
|
3462
3847
|
* replication configuration is 128 KB.</p>
|
|
3463
3848
|
*/
|
|
@@ -3468,10 +3853,12 @@ export interface GetBucketReplicationResult {
|
|
|
3468
3853
|
*/
|
|
3469
3854
|
export interface GetBucketTaggingRequest {
|
|
3470
3855
|
/**
|
|
3856
|
+
* @public
|
|
3471
3857
|
* <p>The Amazon Web Services account ID of the Outposts bucket.</p>
|
|
3472
3858
|
*/
|
|
3473
3859
|
AccountId?: string;
|
|
3474
3860
|
/**
|
|
3861
|
+
* @public
|
|
3475
3862
|
* <p>Specifies the bucket.</p>
|
|
3476
3863
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
3477
3864
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
|
|
@@ -3483,6 +3870,7 @@ export interface GetBucketTaggingRequest {
|
|
|
3483
3870
|
*/
|
|
3484
3871
|
export interface GetBucketTaggingResult {
|
|
3485
3872
|
/**
|
|
3873
|
+
* @public
|
|
3486
3874
|
* <p>The tags set of the Outposts bucket.</p>
|
|
3487
3875
|
*/
|
|
3488
3876
|
TagSet: S3Tag[] | undefined;
|
|
@@ -3492,10 +3880,12 @@ export interface GetBucketTaggingResult {
|
|
|
3492
3880
|
*/
|
|
3493
3881
|
export interface GetBucketVersioningRequest {
|
|
3494
3882
|
/**
|
|
3883
|
+
* @public
|
|
3495
3884
|
* <p>The Amazon Web Services account ID of the S3 on Outposts bucket.</p>
|
|
3496
3885
|
*/
|
|
3497
3886
|
AccountId?: string;
|
|
3498
3887
|
/**
|
|
3888
|
+
* @public
|
|
3499
3889
|
* <p>The S3 on Outposts bucket to return the versioning state for.</p>
|
|
3500
3890
|
*/
|
|
3501
3891
|
Bucket: string | undefined;
|
|
@@ -3529,10 +3919,12 @@ export type BucketVersioningStatus = (typeof BucketVersioningStatus)[keyof typeo
|
|
|
3529
3919
|
*/
|
|
3530
3920
|
export interface GetBucketVersioningResult {
|
|
3531
3921
|
/**
|
|
3922
|
+
* @public
|
|
3532
3923
|
* <p>The versioning state of the S3 on Outposts bucket.</p>
|
|
3533
3924
|
*/
|
|
3534
3925
|
Status?: BucketVersioningStatus | string;
|
|
3535
3926
|
/**
|
|
3927
|
+
* @public
|
|
3536
3928
|
* <p>Specifies whether MFA delete is enabled in the bucket versioning configuration. This
|
|
3537
3929
|
* element is returned only if the bucket has been configured with MFA delete. If MFA delete
|
|
3538
3930
|
* has never been configured for the bucket, this element is not returned.</p>
|
|
@@ -3544,10 +3936,12 @@ export interface GetBucketVersioningResult {
|
|
|
3544
3936
|
*/
|
|
3545
3937
|
export interface GetJobTaggingRequest {
|
|
3546
3938
|
/**
|
|
3939
|
+
* @public
|
|
3547
3940
|
* <p>The Amazon Web Services account ID associated with the S3 Batch Operations job.</p>
|
|
3548
3941
|
*/
|
|
3549
3942
|
AccountId?: string;
|
|
3550
3943
|
/**
|
|
3944
|
+
* @public
|
|
3551
3945
|
* <p>The ID for the S3 Batch Operations job whose tags you want to retrieve.</p>
|
|
3552
3946
|
*/
|
|
3553
3947
|
JobId: string | undefined;
|
|
@@ -3557,6 +3951,7 @@ export interface GetJobTaggingRequest {
|
|
|
3557
3951
|
*/
|
|
3558
3952
|
export interface GetJobTaggingResult {
|
|
3559
3953
|
/**
|
|
3954
|
+
* @public
|
|
3560
3955
|
* <p>The set of tags associated with the S3 Batch Operations job.</p>
|
|
3561
3956
|
*/
|
|
3562
3957
|
Tags?: S3Tag[];
|
|
@@ -3566,10 +3961,12 @@ export interface GetJobTaggingResult {
|
|
|
3566
3961
|
*/
|
|
3567
3962
|
export interface GetMultiRegionAccessPointRequest {
|
|
3568
3963
|
/**
|
|
3964
|
+
* @public
|
|
3569
3965
|
* <p>The Amazon Web Services account ID for the owner of the Multi-Region Access Point.</p>
|
|
3570
3966
|
*/
|
|
3571
3967
|
AccountId?: string;
|
|
3572
3968
|
/**
|
|
3969
|
+
* @public
|
|
3573
3970
|
* <p>The name of the Multi-Region Access Point whose configuration information you want to receive. The name of
|
|
3574
3971
|
* the Multi-Region Access Point is different from the alias. For more information about the distinction between
|
|
3575
3972
|
* the name and the alias of an Multi-Region Access Point, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming">Managing Multi-Region Access Points</a> in the
|
|
@@ -3583,14 +3980,17 @@ export interface GetMultiRegionAccessPointRequest {
|
|
|
3583
3980
|
*/
|
|
3584
3981
|
export interface RegionReport {
|
|
3585
3982
|
/**
|
|
3983
|
+
* @public
|
|
3586
3984
|
* <p>The name of the bucket.</p>
|
|
3587
3985
|
*/
|
|
3588
3986
|
Bucket?: string;
|
|
3589
3987
|
/**
|
|
3988
|
+
* @public
|
|
3590
3989
|
* <p>The name of the Region.</p>
|
|
3591
3990
|
*/
|
|
3592
3991
|
Region?: string;
|
|
3593
3992
|
/**
|
|
3993
|
+
* @public
|
|
3594
3994
|
* <p>The Amazon Web Services account ID that owns the Amazon S3 bucket that's associated with this
|
|
3595
3995
|
* Multi-Region Access Point.</p>
|
|
3596
3996
|
*/
|
|
@@ -3618,19 +4018,23 @@ export type MultiRegionAccessPointStatus = (typeof MultiRegionAccessPointStatus)
|
|
|
3618
4018
|
*/
|
|
3619
4019
|
export interface MultiRegionAccessPointReport {
|
|
3620
4020
|
/**
|
|
4021
|
+
* @public
|
|
3621
4022
|
* <p>The name of the Multi-Region Access Point.</p>
|
|
3622
4023
|
*/
|
|
3623
4024
|
Name?: string;
|
|
3624
4025
|
/**
|
|
4026
|
+
* @public
|
|
3625
4027
|
* <p>The alias for the Multi-Region Access Point. For more information about the distinction between the name
|
|
3626
4028
|
* and the alias of an Multi-Region Access Point, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming">Managing Multi-Region Access Points</a>.</p>
|
|
3627
4029
|
*/
|
|
3628
4030
|
Alias?: string;
|
|
3629
4031
|
/**
|
|
4032
|
+
* @public
|
|
3630
4033
|
* <p>When the Multi-Region Access Point create request was received.</p>
|
|
3631
4034
|
*/
|
|
3632
4035
|
CreatedAt?: Date;
|
|
3633
4036
|
/**
|
|
4037
|
+
* @public
|
|
3634
4038
|
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3
|
|
3635
4039
|
* account. You can enable the configuration options in any combination. For more information
|
|
3636
4040
|
* about when Amazon S3 considers a bucket or object public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -3638,6 +4042,7 @@ export interface MultiRegionAccessPointReport {
|
|
|
3638
4042
|
*/
|
|
3639
4043
|
PublicAccessBlock?: PublicAccessBlockConfiguration;
|
|
3640
4044
|
/**
|
|
4045
|
+
* @public
|
|
3641
4046
|
* <p>The current status of the Multi-Region Access Point.</p>
|
|
3642
4047
|
* <p>
|
|
3643
4048
|
* <code>CREATING</code> and <code>DELETING</code> are temporary states that exist while
|
|
@@ -3648,6 +4053,7 @@ export interface MultiRegionAccessPointReport {
|
|
|
3648
4053
|
*/
|
|
3649
4054
|
Status?: MultiRegionAccessPointStatus | string;
|
|
3650
4055
|
/**
|
|
4056
|
+
* @public
|
|
3651
4057
|
* <p>A collection of the Regions and buckets associated with the Multi-Region Access Point.</p>
|
|
3652
4058
|
*/
|
|
3653
4059
|
Regions?: RegionReport[];
|
|
@@ -3657,6 +4063,7 @@ export interface MultiRegionAccessPointReport {
|
|
|
3657
4063
|
*/
|
|
3658
4064
|
export interface GetMultiRegionAccessPointResult {
|
|
3659
4065
|
/**
|
|
4066
|
+
* @public
|
|
3660
4067
|
* <p>A container element containing the details of the requested Multi-Region Access Point.</p>
|
|
3661
4068
|
*/
|
|
3662
4069
|
AccessPoint?: MultiRegionAccessPointReport;
|
|
@@ -3666,10 +4073,12 @@ export interface GetMultiRegionAccessPointResult {
|
|
|
3666
4073
|
*/
|
|
3667
4074
|
export interface GetMultiRegionAccessPointPolicyRequest {
|
|
3668
4075
|
/**
|
|
4076
|
+
* @public
|
|
3669
4077
|
* <p>The Amazon Web Services account ID for the owner of the Multi-Region Access Point.</p>
|
|
3670
4078
|
*/
|
|
3671
4079
|
AccountId?: string;
|
|
3672
4080
|
/**
|
|
4081
|
+
* @public
|
|
3673
4082
|
* <p>Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more
|
|
3674
4083
|
* information about the distinction between the name and the alias of an Multi-Region Access Point, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming">Managing Multi-Region Access Points</a> in the
|
|
3675
4084
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -3686,6 +4095,7 @@ export interface GetMultiRegionAccessPointPolicyRequest {
|
|
|
3686
4095
|
*/
|
|
3687
4096
|
export interface EstablishedMultiRegionAccessPointPolicy {
|
|
3688
4097
|
/**
|
|
4098
|
+
* @public
|
|
3689
4099
|
* <p>The details of the last established policy.</p>
|
|
3690
4100
|
*/
|
|
3691
4101
|
Policy?: string;
|
|
@@ -3700,6 +4110,7 @@ export interface EstablishedMultiRegionAccessPointPolicy {
|
|
|
3700
4110
|
*/
|
|
3701
4111
|
export interface ProposedMultiRegionAccessPointPolicy {
|
|
3702
4112
|
/**
|
|
4113
|
+
* @public
|
|
3703
4114
|
* <p>The details of the proposed policy.</p>
|
|
3704
4115
|
*/
|
|
3705
4116
|
Policy?: string;
|
|
@@ -3714,10 +4125,12 @@ export interface ProposedMultiRegionAccessPointPolicy {
|
|
|
3714
4125
|
*/
|
|
3715
4126
|
export interface MultiRegionAccessPointPolicyDocument {
|
|
3716
4127
|
/**
|
|
4128
|
+
* @public
|
|
3717
4129
|
* <p>The last established policy for the Multi-Region Access Point.</p>
|
|
3718
4130
|
*/
|
|
3719
4131
|
Established?: EstablishedMultiRegionAccessPointPolicy;
|
|
3720
4132
|
/**
|
|
4133
|
+
* @public
|
|
3721
4134
|
* <p>The proposed policy for the Multi-Region Access Point.</p>
|
|
3722
4135
|
*/
|
|
3723
4136
|
Proposed?: ProposedMultiRegionAccessPointPolicy;
|
|
@@ -3727,6 +4140,7 @@ export interface MultiRegionAccessPointPolicyDocument {
|
|
|
3727
4140
|
*/
|
|
3728
4141
|
export interface GetMultiRegionAccessPointPolicyResult {
|
|
3729
4142
|
/**
|
|
4143
|
+
* @public
|
|
3730
4144
|
* <p>The policy associated with the specified Multi-Region Access Point.</p>
|
|
3731
4145
|
*/
|
|
3732
4146
|
Policy?: MultiRegionAccessPointPolicyDocument;
|
|
@@ -3736,10 +4150,12 @@ export interface GetMultiRegionAccessPointPolicyResult {
|
|
|
3736
4150
|
*/
|
|
3737
4151
|
export interface GetMultiRegionAccessPointPolicyStatusRequest {
|
|
3738
4152
|
/**
|
|
4153
|
+
* @public
|
|
3739
4154
|
* <p>The Amazon Web Services account ID for the owner of the Multi-Region Access Point.</p>
|
|
3740
4155
|
*/
|
|
3741
4156
|
AccountId?: string;
|
|
3742
4157
|
/**
|
|
4158
|
+
* @public
|
|
3743
4159
|
* <p>Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more
|
|
3744
4160
|
* information about the distinction between the name and the alias of an Multi-Region Access Point, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming">Managing Multi-Region Access Points</a> in the
|
|
3745
4161
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -3751,6 +4167,7 @@ export interface GetMultiRegionAccessPointPolicyStatusRequest {
|
|
|
3751
4167
|
*/
|
|
3752
4168
|
export interface GetMultiRegionAccessPointPolicyStatusResult {
|
|
3753
4169
|
/**
|
|
4170
|
+
* @public
|
|
3754
4171
|
* <p>Indicates whether this access point policy is public. For more information about how Amazon S3
|
|
3755
4172
|
* evaluates policies to determine whether they are public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
3756
4173
|
*/
|
|
@@ -3761,10 +4178,12 @@ export interface GetMultiRegionAccessPointPolicyStatusResult {
|
|
|
3761
4178
|
*/
|
|
3762
4179
|
export interface GetMultiRegionAccessPointRoutesRequest {
|
|
3763
4180
|
/**
|
|
4181
|
+
* @public
|
|
3764
4182
|
* <p>The Amazon Web Services account ID for the owner of the Multi-Region Access Point.</p>
|
|
3765
4183
|
*/
|
|
3766
4184
|
AccountId?: string;
|
|
3767
4185
|
/**
|
|
4186
|
+
* @public
|
|
3768
4187
|
* <p>The Multi-Region Access Point ARN.</p>
|
|
3769
4188
|
*/
|
|
3770
4189
|
Mrap: string | undefined;
|
|
@@ -3781,18 +4200,21 @@ export interface GetMultiRegionAccessPointRoutesRequest {
|
|
|
3781
4200
|
*/
|
|
3782
4201
|
export interface MultiRegionAccessPointRoute {
|
|
3783
4202
|
/**
|
|
4203
|
+
* @public
|
|
3784
4204
|
* <p>The name of the Amazon S3 bucket for which you'll submit a routing configuration change.
|
|
3785
4205
|
* Either the <code>Bucket</code> or the <code>Region</code> value must be provided. If both
|
|
3786
4206
|
* are provided, the bucket must be in the specified Region.</p>
|
|
3787
4207
|
*/
|
|
3788
4208
|
Bucket?: string;
|
|
3789
4209
|
/**
|
|
4210
|
+
* @public
|
|
3790
4211
|
* <p>The Amazon Web Services Region to which you'll be submitting a routing configuration change. Either
|
|
3791
4212
|
* the <code>Bucket</code> or the <code>Region</code> value must be provided. If both are
|
|
3792
4213
|
* provided, the bucket must be in the specified Region.</p>
|
|
3793
4214
|
*/
|
|
3794
4215
|
Region?: string;
|
|
3795
4216
|
/**
|
|
4217
|
+
* @public
|
|
3796
4218
|
* <p>The traffic state for the specified bucket or Amazon Web Services Region. </p>
|
|
3797
4219
|
* <p>A value of <code>0</code> indicates a passive state, which means that no new traffic
|
|
3798
4220
|
* will be routed to the Region. </p>
|
|
@@ -3811,10 +4233,12 @@ export interface MultiRegionAccessPointRoute {
|
|
|
3811
4233
|
*/
|
|
3812
4234
|
export interface GetMultiRegionAccessPointRoutesResult {
|
|
3813
4235
|
/**
|
|
4236
|
+
* @public
|
|
3814
4237
|
* <p>The Multi-Region Access Point ARN.</p>
|
|
3815
4238
|
*/
|
|
3816
4239
|
Mrap?: string;
|
|
3817
4240
|
/**
|
|
4241
|
+
* @public
|
|
3818
4242
|
* <p>The different routes that make up the route configuration. Active routes return a value
|
|
3819
4243
|
* of <code>100</code>, and passive routes return a value of <code>0</code>.</p>
|
|
3820
4244
|
*/
|
|
@@ -3825,6 +4249,7 @@ export interface GetMultiRegionAccessPointRoutesResult {
|
|
|
3825
4249
|
*/
|
|
3826
4250
|
export interface GetPublicAccessBlockOutput {
|
|
3827
4251
|
/**
|
|
4252
|
+
* @public
|
|
3828
4253
|
* <p>The <code>PublicAccessBlock</code> configuration currently in effect for this
|
|
3829
4254
|
* Amazon Web Services account.</p>
|
|
3830
4255
|
*/
|
|
@@ -3835,6 +4260,7 @@ export interface GetPublicAccessBlockOutput {
|
|
|
3835
4260
|
*/
|
|
3836
4261
|
export interface GetPublicAccessBlockRequest {
|
|
3837
4262
|
/**
|
|
4263
|
+
* @public
|
|
3838
4264
|
* <p>The account ID for the Amazon Web Services account whose <code>PublicAccessBlock</code> configuration
|
|
3839
4265
|
* you want to retrieve.</p>
|
|
3840
4266
|
*/
|
|
@@ -3860,10 +4286,12 @@ export declare class NoSuchPublicAccessBlockConfiguration extends __BaseExceptio
|
|
|
3860
4286
|
*/
|
|
3861
4287
|
export interface GetStorageLensConfigurationRequest {
|
|
3862
4288
|
/**
|
|
4289
|
+
* @public
|
|
3863
4290
|
* <p>The ID of the Amazon S3 Storage Lens configuration.</p>
|
|
3864
4291
|
*/
|
|
3865
4292
|
ConfigId: string | undefined;
|
|
3866
4293
|
/**
|
|
4294
|
+
* @public
|
|
3867
4295
|
* <p>The account ID of the requester.</p>
|
|
3868
4296
|
*/
|
|
3869
4297
|
AccountId?: string;
|
|
@@ -3874,6 +4302,7 @@ export interface GetStorageLensConfigurationRequest {
|
|
|
3874
4302
|
*/
|
|
3875
4303
|
export interface StorageLensAwsOrg {
|
|
3876
4304
|
/**
|
|
4305
|
+
* @public
|
|
3877
4306
|
* <p>A container for the Amazon Resource Name (ARN) of the Amazon Web Services organization. This property
|
|
3878
4307
|
* is read-only and follows the following format: <code>
|
|
3879
4308
|
* arn:aws:organizations:<i>us-east-1</i>:<i>example-account-id</i>:organization/<i>o-ex2l495dck</i>
|
|
@@ -3890,6 +4319,7 @@ export interface StorageLensAwsOrg {
|
|
|
3890
4319
|
*/
|
|
3891
4320
|
export interface CloudWatchMetrics {
|
|
3892
4321
|
/**
|
|
4322
|
+
* @public
|
|
3893
4323
|
* <p>A container that indicates whether CloudWatch publishing for S3 Storage Lens metrics is enabled. A
|
|
3894
4324
|
* value of <code>true</code> indicates that CloudWatch publishing for S3 Storage Lens metrics is
|
|
3895
4325
|
* enabled.</p>
|
|
@@ -3902,6 +4332,7 @@ export interface CloudWatchMetrics {
|
|
|
3902
4332
|
*/
|
|
3903
4333
|
export interface SSEKMS {
|
|
3904
4334
|
/**
|
|
4335
|
+
* @public
|
|
3905
4336
|
* <p>A container for the ARN of the SSE-KMS encryption. This property is read-only and
|
|
3906
4337
|
* follows the following format: <code>
|
|
3907
4338
|
* arn:aws:kms:<i>us-east-1</i>:<i>example-account-id</i>:key/<i>example-9a73-4afc-8d29-8f5900cef44e</i>
|
|
@@ -3922,10 +4353,12 @@ export interface SSES3 {
|
|
|
3922
4353
|
*/
|
|
3923
4354
|
export interface StorageLensDataExportEncryption {
|
|
3924
4355
|
/**
|
|
4356
|
+
* @public
|
|
3925
4357
|
* <p></p>
|
|
3926
4358
|
*/
|
|
3927
4359
|
SSES3?: SSES3;
|
|
3928
4360
|
/**
|
|
4361
|
+
* @public
|
|
3929
4362
|
* <p></p>
|
|
3930
4363
|
*/
|
|
3931
4364
|
SSEKMS?: SSEKMS;
|
|
@@ -3960,18 +4393,22 @@ export type OutputSchemaVersion = (typeof OutputSchemaVersion)[keyof typeof Outp
|
|
|
3960
4393
|
*/
|
|
3961
4394
|
export interface S3BucketDestination {
|
|
3962
4395
|
/**
|
|
4396
|
+
* @public
|
|
3963
4397
|
* <p></p>
|
|
3964
4398
|
*/
|
|
3965
4399
|
Format: Format | string | undefined;
|
|
3966
4400
|
/**
|
|
4401
|
+
* @public
|
|
3967
4402
|
* <p>The schema version of the export file.</p>
|
|
3968
4403
|
*/
|
|
3969
4404
|
OutputSchemaVersion: OutputSchemaVersion | string | undefined;
|
|
3970
4405
|
/**
|
|
4406
|
+
* @public
|
|
3971
4407
|
* <p>The account ID of the owner of the S3 Storage Lens metrics export bucket.</p>
|
|
3972
4408
|
*/
|
|
3973
4409
|
AccountId?: string;
|
|
3974
4410
|
/**
|
|
4411
|
+
* @public
|
|
3975
4412
|
* <p>The Amazon Resource Name (ARN) of the bucket. This property is read-only and follows the
|
|
3976
4413
|
* following format: <code>
|
|
3977
4414
|
* arn:aws:s3:<i>us-east-1</i>:<i>example-account-id</i>:bucket/<i>your-destination-bucket-name</i>
|
|
@@ -3980,10 +4417,12 @@ export interface S3BucketDestination {
|
|
|
3980
4417
|
*/
|
|
3981
4418
|
Arn: string | undefined;
|
|
3982
4419
|
/**
|
|
4420
|
+
* @public
|
|
3983
4421
|
* <p>The prefix of the destination bucket where the metrics export will be delivered.</p>
|
|
3984
4422
|
*/
|
|
3985
4423
|
Prefix?: string;
|
|
3986
4424
|
/**
|
|
4425
|
+
* @public
|
|
3987
4426
|
* <p>The container for the type encryption of the metrics exports in this bucket.</p>
|
|
3988
4427
|
*/
|
|
3989
4428
|
Encryption?: StorageLensDataExportEncryption;
|
|
@@ -3995,6 +4434,7 @@ export interface S3BucketDestination {
|
|
|
3995
4434
|
*/
|
|
3996
4435
|
export interface StorageLensDataExport {
|
|
3997
4436
|
/**
|
|
4437
|
+
* @public
|
|
3998
4438
|
* <p>A container for the bucket where the S3 Storage Lens metrics export will be located.</p>
|
|
3999
4439
|
* <note>
|
|
4000
4440
|
* <p>This bucket must be located in the same Region as the storage lens configuration.
|
|
@@ -4003,6 +4443,7 @@ export interface StorageLensDataExport {
|
|
|
4003
4443
|
*/
|
|
4004
4444
|
S3BucketDestination?: S3BucketDestination;
|
|
4005
4445
|
/**
|
|
4446
|
+
* @public
|
|
4006
4447
|
* <p>A container for enabling Amazon CloudWatch publishing for S3 Storage Lens metrics.</p>
|
|
4007
4448
|
*/
|
|
4008
4449
|
CloudWatchMetrics?: CloudWatchMetrics;
|
|
@@ -4013,10 +4454,12 @@ export interface StorageLensDataExport {
|
|
|
4013
4454
|
*/
|
|
4014
4455
|
export interface _Exclude {
|
|
4015
4456
|
/**
|
|
4457
|
+
* @public
|
|
4016
4458
|
* <p>A container for the S3 Storage Lens bucket excludes.</p>
|
|
4017
4459
|
*/
|
|
4018
4460
|
Buckets?: string[];
|
|
4019
4461
|
/**
|
|
4462
|
+
* @public
|
|
4020
4463
|
* <p>A container for the S3 Storage Lens Region excludes.</p>
|
|
4021
4464
|
*/
|
|
4022
4465
|
Regions?: string[];
|
|
@@ -4027,10 +4470,12 @@ export interface _Exclude {
|
|
|
4027
4470
|
*/
|
|
4028
4471
|
export interface Include {
|
|
4029
4472
|
/**
|
|
4473
|
+
* @public
|
|
4030
4474
|
* <p>A container for the S3 Storage Lens bucket includes.</p>
|
|
4031
4475
|
*/
|
|
4032
4476
|
Buckets?: string[];
|
|
4033
4477
|
/**
|
|
4478
|
+
* @public
|
|
4034
4479
|
* <p>A container for the S3 Storage Lens Region includes.</p>
|
|
4035
4480
|
*/
|
|
4036
4481
|
Regions?: string[];
|
|
@@ -4041,38 +4486,46 @@ export interface Include {
|
|
|
4041
4486
|
*/
|
|
4042
4487
|
export interface StorageLensConfiguration {
|
|
4043
4488
|
/**
|
|
4489
|
+
* @public
|
|
4044
4490
|
* <p>A container for the Amazon S3 Storage Lens configuration ID.</p>
|
|
4045
4491
|
*/
|
|
4046
4492
|
Id: string | undefined;
|
|
4047
4493
|
/**
|
|
4494
|
+
* @public
|
|
4048
4495
|
* <p>A container for all the account-level configurations of your S3 Storage Lens
|
|
4049
4496
|
* configuration.</p>
|
|
4050
4497
|
*/
|
|
4051
4498
|
AccountLevel: AccountLevel | undefined;
|
|
4052
4499
|
/**
|
|
4500
|
+
* @public
|
|
4053
4501
|
* <p>A container for what is included in this configuration. This container can only be valid
|
|
4054
4502
|
* if there is no <code>Exclude</code> container submitted, and it's not empty. </p>
|
|
4055
4503
|
*/
|
|
4056
4504
|
Include?: Include;
|
|
4057
4505
|
/**
|
|
4506
|
+
* @public
|
|
4058
4507
|
* <p>A container for what is excluded in this configuration. This container can only be valid
|
|
4059
4508
|
* if there is no <code>Include</code> container submitted, and it's not empty. </p>
|
|
4060
4509
|
*/
|
|
4061
4510
|
Exclude?: _Exclude;
|
|
4062
4511
|
/**
|
|
4512
|
+
* @public
|
|
4063
4513
|
* <p>A container to specify the properties of your S3 Storage Lens metrics export including, the
|
|
4064
4514
|
* destination, schema and format.</p>
|
|
4065
4515
|
*/
|
|
4066
4516
|
DataExport?: StorageLensDataExport;
|
|
4067
4517
|
/**
|
|
4518
|
+
* @public
|
|
4068
4519
|
* <p>A container for whether the S3 Storage Lens configuration is enabled.</p>
|
|
4069
4520
|
*/
|
|
4070
4521
|
IsEnabled: boolean | undefined;
|
|
4071
4522
|
/**
|
|
4523
|
+
* @public
|
|
4072
4524
|
* <p>A container for the Amazon Web Services organization for this S3 Storage Lens configuration.</p>
|
|
4073
4525
|
*/
|
|
4074
4526
|
AwsOrg?: StorageLensAwsOrg;
|
|
4075
4527
|
/**
|
|
4528
|
+
* @public
|
|
4076
4529
|
* <p>The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only
|
|
4077
4530
|
* and follows the following format: <code>
|
|
4078
4531
|
* arn:aws:s3:<i>us-east-1</i>:<i>example-account-id</i>:storage-lens/<i>your-dashboard-name</i>
|
|
@@ -4086,6 +4539,7 @@ export interface StorageLensConfiguration {
|
|
|
4086
4539
|
*/
|
|
4087
4540
|
export interface GetStorageLensConfigurationResult {
|
|
4088
4541
|
/**
|
|
4542
|
+
* @public
|
|
4089
4543
|
* <p>The S3 Storage Lens configuration requested.</p>
|
|
4090
4544
|
*/
|
|
4091
4545
|
StorageLensConfiguration?: StorageLensConfiguration;
|
|
@@ -4095,10 +4549,12 @@ export interface GetStorageLensConfigurationResult {
|
|
|
4095
4549
|
*/
|
|
4096
4550
|
export interface GetStorageLensConfigurationTaggingRequest {
|
|
4097
4551
|
/**
|
|
4552
|
+
* @public
|
|
4098
4553
|
* <p>The ID of the Amazon S3 Storage Lens configuration.</p>
|
|
4099
4554
|
*/
|
|
4100
4555
|
ConfigId: string | undefined;
|
|
4101
4556
|
/**
|
|
4557
|
+
* @public
|
|
4102
4558
|
* <p>The account ID of the requester.</p>
|
|
4103
4559
|
*/
|
|
4104
4560
|
AccountId?: string;
|
|
@@ -4109,10 +4565,12 @@ export interface GetStorageLensConfigurationTaggingRequest {
|
|
|
4109
4565
|
*/
|
|
4110
4566
|
export interface StorageLensTag {
|
|
4111
4567
|
/**
|
|
4568
|
+
* @public
|
|
4112
4569
|
* <p></p>
|
|
4113
4570
|
*/
|
|
4114
4571
|
Key: string | undefined;
|
|
4115
4572
|
/**
|
|
4573
|
+
* @public
|
|
4116
4574
|
* <p></p>
|
|
4117
4575
|
*/
|
|
4118
4576
|
Value: string | undefined;
|
|
@@ -4122,6 +4580,7 @@ export interface StorageLensTag {
|
|
|
4122
4580
|
*/
|
|
4123
4581
|
export interface GetStorageLensConfigurationTaggingResult {
|
|
4124
4582
|
/**
|
|
4583
|
+
* @public
|
|
4125
4584
|
* <p>The tags of S3 Storage Lens configuration requested.</p>
|
|
4126
4585
|
*/
|
|
4127
4586
|
Tags?: StorageLensTag[];
|
|
@@ -4131,22 +4590,26 @@ export interface GetStorageLensConfigurationTaggingResult {
|
|
|
4131
4590
|
*/
|
|
4132
4591
|
export interface ListAccessPointsRequest {
|
|
4133
4592
|
/**
|
|
4593
|
+
* @public
|
|
4134
4594
|
* <p>The Amazon Web Services account ID for the account that owns the specified access points.</p>
|
|
4135
4595
|
*/
|
|
4136
4596
|
AccountId?: string;
|
|
4137
4597
|
/**
|
|
4598
|
+
* @public
|
|
4138
4599
|
* <p>The name of the bucket whose associated access points you want to list.</p>
|
|
4139
4600
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
4140
4601
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
|
|
4141
4602
|
*/
|
|
4142
4603
|
Bucket?: string;
|
|
4143
4604
|
/**
|
|
4605
|
+
* @public
|
|
4144
4606
|
* <p>A continuation token. If a previous call to <code>ListAccessPoints</code> returned a
|
|
4145
4607
|
* continuation token in the <code>NextToken</code> field, then providing that value here
|
|
4146
4608
|
* causes Amazon S3 to retrieve the next page of results.</p>
|
|
4147
4609
|
*/
|
|
4148
4610
|
NextToken?: string;
|
|
4149
4611
|
/**
|
|
4612
|
+
* @public
|
|
4150
4613
|
* <p>The maximum number of access points that you want to include in the list. If the specified
|
|
4151
4614
|
* bucket has more than this number of access points, then the response will include a continuation
|
|
4152
4615
|
* token in the <code>NextToken</code> field that you can use to retrieve the next page of
|
|
@@ -4159,11 +4622,13 @@ export interface ListAccessPointsRequest {
|
|
|
4159
4622
|
*/
|
|
4160
4623
|
export interface ListAccessPointsResult {
|
|
4161
4624
|
/**
|
|
4625
|
+
* @public
|
|
4162
4626
|
* <p>Contains identification and configuration information for one or more access points associated
|
|
4163
4627
|
* with the specified bucket.</p>
|
|
4164
4628
|
*/
|
|
4165
4629
|
AccessPointList?: AccessPoint[];
|
|
4166
4630
|
/**
|
|
4631
|
+
* @public
|
|
4167
4632
|
* <p>If the specified bucket has more access points than can be returned in one call to this API,
|
|
4168
4633
|
* this field contains a continuation token that you can provide in subsequent calls to this
|
|
4169
4634
|
* API to retrieve additional access points.</p>
|
|
@@ -4175,16 +4640,19 @@ export interface ListAccessPointsResult {
|
|
|
4175
4640
|
*/
|
|
4176
4641
|
export interface ListAccessPointsForObjectLambdaRequest {
|
|
4177
4642
|
/**
|
|
4643
|
+
* @public
|
|
4178
4644
|
* <p>The account ID for the account that owns the specified Object Lambda Access Point.</p>
|
|
4179
4645
|
*/
|
|
4180
4646
|
AccountId?: string;
|
|
4181
4647
|
/**
|
|
4648
|
+
* @public
|
|
4182
4649
|
* <p>If the list has more access points than can be returned in one call to this API, this field
|
|
4183
4650
|
* contains a continuation token that you can provide in subsequent calls to this API to
|
|
4184
4651
|
* retrieve additional access points.</p>
|
|
4185
4652
|
*/
|
|
4186
4653
|
NextToken?: string;
|
|
4187
4654
|
/**
|
|
4655
|
+
* @public
|
|
4188
4656
|
* <p>The maximum number of access points that you want to include in the list. The response may
|
|
4189
4657
|
* contain fewer access points but will never contain more. If there are more than this number of
|
|
4190
4658
|
* access points, then the response will include a continuation token in the <code>NextToken</code>
|
|
@@ -4199,14 +4667,17 @@ export interface ListAccessPointsForObjectLambdaRequest {
|
|
|
4199
4667
|
*/
|
|
4200
4668
|
export interface ObjectLambdaAccessPoint {
|
|
4201
4669
|
/**
|
|
4670
|
+
* @public
|
|
4202
4671
|
* <p>The name of the Object Lambda Access Point.</p>
|
|
4203
4672
|
*/
|
|
4204
4673
|
Name: string | undefined;
|
|
4205
4674
|
/**
|
|
4675
|
+
* @public
|
|
4206
4676
|
* <p>Specifies the ARN for the Object Lambda Access Point.</p>
|
|
4207
4677
|
*/
|
|
4208
4678
|
ObjectLambdaAccessPointArn?: string;
|
|
4209
4679
|
/**
|
|
4680
|
+
* @public
|
|
4210
4681
|
* <p>The alias of the Object Lambda Access Point.</p>
|
|
4211
4682
|
*/
|
|
4212
4683
|
Alias?: ObjectLambdaAccessPointAlias;
|
|
@@ -4216,10 +4687,12 @@ export interface ObjectLambdaAccessPoint {
|
|
|
4216
4687
|
*/
|
|
4217
4688
|
export interface ListAccessPointsForObjectLambdaResult {
|
|
4218
4689
|
/**
|
|
4690
|
+
* @public
|
|
4219
4691
|
* <p>Returns list of Object Lambda Access Points.</p>
|
|
4220
4692
|
*/
|
|
4221
4693
|
ObjectLambdaAccessPointList?: ObjectLambdaAccessPoint[];
|
|
4222
4694
|
/**
|
|
4695
|
+
* @public
|
|
4223
4696
|
* <p>If the list has more access points than can be returned in one call to this API, this field
|
|
4224
4697
|
* contains a continuation token that you can provide in subsequent calls to this API to
|
|
4225
4698
|
* retrieve additional access points.</p>
|
|
@@ -4257,21 +4730,25 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
4257
4730
|
*/
|
|
4258
4731
|
export interface ListJobsRequest {
|
|
4259
4732
|
/**
|
|
4733
|
+
* @public
|
|
4260
4734
|
* <p>The Amazon Web Services account ID associated with the S3 Batch Operations job.</p>
|
|
4261
4735
|
*/
|
|
4262
4736
|
AccountId?: string;
|
|
4263
4737
|
/**
|
|
4738
|
+
* @public
|
|
4264
4739
|
* <p>The <code>List Jobs</code> request returns jobs that match the statuses listed in this
|
|
4265
4740
|
* element.</p>
|
|
4266
4741
|
*/
|
|
4267
4742
|
JobStatuses?: (JobStatus | string)[];
|
|
4268
4743
|
/**
|
|
4744
|
+
* @public
|
|
4269
4745
|
* <p>A pagination token to request the next page of results. Use the token that Amazon S3 returned
|
|
4270
4746
|
* in the <code>NextToken</code> element of the <code>ListJobsResult</code> from the previous
|
|
4271
4747
|
* <code>List Jobs</code> request.</p>
|
|
4272
4748
|
*/
|
|
4273
4749
|
NextToken?: string;
|
|
4274
4750
|
/**
|
|
4751
|
+
* @public
|
|
4275
4752
|
* <p>The maximum number of jobs that Amazon S3 will include in the <code>List Jobs</code>
|
|
4276
4753
|
* response. If there are more jobs than this number, the response will include a pagination
|
|
4277
4754
|
* token in the <code>NextToken</code> field to enable you to retrieve the next page of
|
|
@@ -4305,37 +4782,45 @@ export type OperationName = (typeof OperationName)[keyof typeof OperationName];
|
|
|
4305
4782
|
*/
|
|
4306
4783
|
export interface JobListDescriptor {
|
|
4307
4784
|
/**
|
|
4785
|
+
* @public
|
|
4308
4786
|
* <p>The ID for the specified job.</p>
|
|
4309
4787
|
*/
|
|
4310
4788
|
JobId?: string;
|
|
4311
4789
|
/**
|
|
4790
|
+
* @public
|
|
4312
4791
|
* <p>The user-specified description that was included in the specified job's <code>Create
|
|
4313
4792
|
* Job</code> request.</p>
|
|
4314
4793
|
*/
|
|
4315
4794
|
Description?: string;
|
|
4316
4795
|
/**
|
|
4796
|
+
* @public
|
|
4317
4797
|
* <p>The operation that the specified job is configured to run on every object listed in the
|
|
4318
4798
|
* manifest.</p>
|
|
4319
4799
|
*/
|
|
4320
4800
|
Operation?: OperationName | string;
|
|
4321
4801
|
/**
|
|
4802
|
+
* @public
|
|
4322
4803
|
* <p>The current priority for the specified job.</p>
|
|
4323
4804
|
*/
|
|
4324
4805
|
Priority?: number;
|
|
4325
4806
|
/**
|
|
4807
|
+
* @public
|
|
4326
4808
|
* <p>The specified job's current status.</p>
|
|
4327
4809
|
*/
|
|
4328
4810
|
Status?: JobStatus | string;
|
|
4329
4811
|
/**
|
|
4812
|
+
* @public
|
|
4330
4813
|
* <p>A timestamp indicating when the specified job was created.</p>
|
|
4331
4814
|
*/
|
|
4332
4815
|
CreationTime?: Date;
|
|
4333
4816
|
/**
|
|
4817
|
+
* @public
|
|
4334
4818
|
* <p>A timestamp indicating when the specified job terminated. A job's termination date is
|
|
4335
4819
|
* the date and time when it succeeded, failed, or was canceled.</p>
|
|
4336
4820
|
*/
|
|
4337
4821
|
TerminationDate?: Date;
|
|
4338
4822
|
/**
|
|
4823
|
+
* @public
|
|
4339
4824
|
* <p>Describes the total number of tasks that the specified job has run, the number of tasks
|
|
4340
4825
|
* that succeeded, and the number of tasks that failed.</p>
|
|
4341
4826
|
*/
|
|
@@ -4346,12 +4831,14 @@ export interface JobListDescriptor {
|
|
|
4346
4831
|
*/
|
|
4347
4832
|
export interface ListJobsResult {
|
|
4348
4833
|
/**
|
|
4834
|
+
* @public
|
|
4349
4835
|
* <p>If the <code>List Jobs</code> request produced more than the maximum number of results,
|
|
4350
4836
|
* you can pass this value into a subsequent <code>List Jobs</code> request in order to
|
|
4351
4837
|
* retrieve the next page of results.</p>
|
|
4352
4838
|
*/
|
|
4353
4839
|
NextToken?: string;
|
|
4354
4840
|
/**
|
|
4841
|
+
* @public
|
|
4355
4842
|
* <p>The list of current jobs and jobs that have ended within the last 30 days.</p>
|
|
4356
4843
|
*/
|
|
4357
4844
|
Jobs?: JobListDescriptor[];
|
|
@@ -4361,14 +4848,17 @@ export interface ListJobsResult {
|
|
|
4361
4848
|
*/
|
|
4362
4849
|
export interface ListMultiRegionAccessPointsRequest {
|
|
4363
4850
|
/**
|
|
4851
|
+
* @public
|
|
4364
4852
|
* <p>The Amazon Web Services account ID for the owner of the Multi-Region Access Point.</p>
|
|
4365
4853
|
*/
|
|
4366
4854
|
AccountId?: string;
|
|
4367
4855
|
/**
|
|
4856
|
+
* @public
|
|
4368
4857
|
* <p>Not currently used. Do not use this parameter.</p>
|
|
4369
4858
|
*/
|
|
4370
4859
|
NextToken?: string;
|
|
4371
4860
|
/**
|
|
4861
|
+
* @public
|
|
4372
4862
|
* <p>Not currently used. Do not use this parameter.</p>
|
|
4373
4863
|
*/
|
|
4374
4864
|
MaxResults?: number;
|
|
@@ -4378,10 +4868,12 @@ export interface ListMultiRegionAccessPointsRequest {
|
|
|
4378
4868
|
*/
|
|
4379
4869
|
export interface ListMultiRegionAccessPointsResult {
|
|
4380
4870
|
/**
|
|
4871
|
+
* @public
|
|
4381
4872
|
* <p>The list of Multi-Region Access Points associated with the user.</p>
|
|
4382
4873
|
*/
|
|
4383
4874
|
AccessPoints?: MultiRegionAccessPointReport[];
|
|
4384
4875
|
/**
|
|
4876
|
+
* @public
|
|
4385
4877
|
* <p>If the specified bucket has more Multi-Region Access Points than can be returned in one call to this
|
|
4386
4878
|
* action, this field contains a continuation token. You can use this token tin subsequent
|
|
4387
4879
|
* calls to this action to retrieve additional Multi-Region Access Points.</p>
|
|
@@ -4393,18 +4885,22 @@ export interface ListMultiRegionAccessPointsResult {
|
|
|
4393
4885
|
*/
|
|
4394
4886
|
export interface ListRegionalBucketsRequest {
|
|
4395
4887
|
/**
|
|
4888
|
+
* @public
|
|
4396
4889
|
* <p>The Amazon Web Services account ID of the Outposts bucket.</p>
|
|
4397
4890
|
*/
|
|
4398
4891
|
AccountId?: string;
|
|
4399
4892
|
/**
|
|
4893
|
+
* @public
|
|
4400
4894
|
* <p></p>
|
|
4401
4895
|
*/
|
|
4402
4896
|
NextToken?: string;
|
|
4403
4897
|
/**
|
|
4898
|
+
* @public
|
|
4404
4899
|
* <p></p>
|
|
4405
4900
|
*/
|
|
4406
4901
|
MaxResults?: number;
|
|
4407
4902
|
/**
|
|
4903
|
+
* @public
|
|
4408
4904
|
* <p>The ID of the Outposts resource.</p>
|
|
4409
4905
|
* <note>
|
|
4410
4906
|
* <p>This ID is required by Amazon S3 on Outposts buckets.</p>
|
|
@@ -4418,22 +4914,27 @@ export interface ListRegionalBucketsRequest {
|
|
|
4418
4914
|
*/
|
|
4419
4915
|
export interface RegionalBucket {
|
|
4420
4916
|
/**
|
|
4917
|
+
* @public
|
|
4421
4918
|
* <p></p>
|
|
4422
4919
|
*/
|
|
4423
4920
|
Bucket: string | undefined;
|
|
4424
4921
|
/**
|
|
4922
|
+
* @public
|
|
4425
4923
|
* <p>The Amazon Resource Name (ARN) for the regional bucket.</p>
|
|
4426
4924
|
*/
|
|
4427
4925
|
BucketArn?: string;
|
|
4428
4926
|
/**
|
|
4927
|
+
* @public
|
|
4429
4928
|
* <p></p>
|
|
4430
4929
|
*/
|
|
4431
4930
|
PublicAccessBlockEnabled: boolean | undefined;
|
|
4432
4931
|
/**
|
|
4932
|
+
* @public
|
|
4433
4933
|
* <p>The creation date of the regional bucket</p>
|
|
4434
4934
|
*/
|
|
4435
4935
|
CreationDate: Date | undefined;
|
|
4436
4936
|
/**
|
|
4937
|
+
* @public
|
|
4437
4938
|
* <p>The Outposts ID of the regional bucket.</p>
|
|
4438
4939
|
*/
|
|
4439
4940
|
OutpostId?: string;
|
|
@@ -4443,10 +4944,12 @@ export interface RegionalBucket {
|
|
|
4443
4944
|
*/
|
|
4444
4945
|
export interface ListRegionalBucketsResult {
|
|
4445
4946
|
/**
|
|
4947
|
+
* @public
|
|
4446
4948
|
* <p></p>
|
|
4447
4949
|
*/
|
|
4448
4950
|
RegionalBucketList?: RegionalBucket[];
|
|
4449
4951
|
/**
|
|
4952
|
+
* @public
|
|
4450
4953
|
* <p>
|
|
4451
4954
|
* <code>NextToken</code> is sent when <code>isTruncated</code> is true, which means there
|
|
4452
4955
|
* are more buckets that can be listed. The next list requests to Amazon S3 can be continued with
|
|
@@ -4460,10 +4963,12 @@ export interface ListRegionalBucketsResult {
|
|
|
4460
4963
|
*/
|
|
4461
4964
|
export interface ListStorageLensConfigurationsRequest {
|
|
4462
4965
|
/**
|
|
4966
|
+
* @public
|
|
4463
4967
|
* <p>The account ID of the requester.</p>
|
|
4464
4968
|
*/
|
|
4465
4969
|
AccountId?: string;
|
|
4466
4970
|
/**
|
|
4971
|
+
* @public
|
|
4467
4972
|
* <p>A pagination token to request the next page of results.</p>
|
|
4468
4973
|
*/
|
|
4469
4974
|
NextToken?: string;
|
|
@@ -4476,19 +4981,23 @@ export interface ListStorageLensConfigurationsRequest {
|
|
|
4476
4981
|
*/
|
|
4477
4982
|
export interface ListStorageLensConfigurationEntry {
|
|
4478
4983
|
/**
|
|
4984
|
+
* @public
|
|
4479
4985
|
* <p>A container for the S3 Storage Lens configuration ID.</p>
|
|
4480
4986
|
*/
|
|
4481
4987
|
Id: string | undefined;
|
|
4482
4988
|
/**
|
|
4989
|
+
* @public
|
|
4483
4990
|
* <p>The ARN of the S3 Storage Lens configuration. This property is read-only.</p>
|
|
4484
4991
|
*/
|
|
4485
4992
|
StorageLensArn: string | undefined;
|
|
4486
4993
|
/**
|
|
4994
|
+
* @public
|
|
4487
4995
|
* <p>A container for the S3 Storage Lens home Region. Your metrics data is stored and retained in
|
|
4488
4996
|
* your designated S3 Storage Lens home Region.</p>
|
|
4489
4997
|
*/
|
|
4490
4998
|
HomeRegion: string | undefined;
|
|
4491
4999
|
/**
|
|
5000
|
+
* @public
|
|
4492
5001
|
* <p>A container for whether the S3 Storage Lens configuration is enabled. This property is
|
|
4493
5002
|
* required.</p>
|
|
4494
5003
|
*/
|
|
@@ -4499,12 +5008,14 @@ export interface ListStorageLensConfigurationEntry {
|
|
|
4499
5008
|
*/
|
|
4500
5009
|
export interface ListStorageLensConfigurationsResult {
|
|
4501
5010
|
/**
|
|
5011
|
+
* @public
|
|
4502
5012
|
* <p>If the request produced more than the maximum number of S3 Storage Lens configuration results,
|
|
4503
5013
|
* you can pass this value into a subsequent request to retrieve the next page of
|
|
4504
5014
|
* results.</p>
|
|
4505
5015
|
*/
|
|
4506
5016
|
NextToken?: string;
|
|
4507
5017
|
/**
|
|
5018
|
+
* @public
|
|
4508
5019
|
* <p>A list of S3 Storage Lens configurations.</p>
|
|
4509
5020
|
*/
|
|
4510
5021
|
StorageLensConfigurationList?: ListStorageLensConfigurationEntry[];
|
|
@@ -4514,14 +5025,17 @@ export interface ListStorageLensConfigurationsResult {
|
|
|
4514
5025
|
*/
|
|
4515
5026
|
export interface PutAccessPointConfigurationForObjectLambdaRequest {
|
|
4516
5027
|
/**
|
|
5028
|
+
* @public
|
|
4517
5029
|
* <p>The account ID for the account that owns the specified Object Lambda Access Point.</p>
|
|
4518
5030
|
*/
|
|
4519
5031
|
AccountId?: string;
|
|
4520
5032
|
/**
|
|
5033
|
+
* @public
|
|
4521
5034
|
* <p>The name of the Object Lambda Access Point.</p>
|
|
4522
5035
|
*/
|
|
4523
5036
|
Name: string | undefined;
|
|
4524
5037
|
/**
|
|
5038
|
+
* @public
|
|
4525
5039
|
* <p>Object Lambda Access Point configuration document.</p>
|
|
4526
5040
|
*/
|
|
4527
5041
|
Configuration: ObjectLambdaConfiguration | undefined;
|
|
@@ -4531,16 +5045,19 @@ export interface PutAccessPointConfigurationForObjectLambdaRequest {
|
|
|
4531
5045
|
*/
|
|
4532
5046
|
export interface PutAccessPointPolicyRequest {
|
|
4533
5047
|
/**
|
|
5048
|
+
* @public
|
|
4534
5049
|
* <p>The Amazon Web Services account ID for owner of the bucket associated with the specified access point.</p>
|
|
4535
5050
|
*/
|
|
4536
5051
|
AccountId?: string;
|
|
4537
5052
|
/**
|
|
5053
|
+
* @public
|
|
4538
5054
|
* <p>The name of the access point that you want to associate with the specified policy.</p>
|
|
4539
5055
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
4540
5056
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name></code>. For example, to access the access point <code>reports-ap</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap</code>. The value must be URL encoded. </p>
|
|
4541
5057
|
*/
|
|
4542
5058
|
Name: string | undefined;
|
|
4543
5059
|
/**
|
|
5060
|
+
* @public
|
|
4544
5061
|
* <p>The policy that you want to apply to the specified access point. For more information about access point
|
|
4545
5062
|
* policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">Managing data access with Amazon S3
|
|
4546
5063
|
* access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -4552,14 +5069,17 @@ export interface PutAccessPointPolicyRequest {
|
|
|
4552
5069
|
*/
|
|
4553
5070
|
export interface PutAccessPointPolicyForObjectLambdaRequest {
|
|
4554
5071
|
/**
|
|
5072
|
+
* @public
|
|
4555
5073
|
* <p>The account ID for the account that owns the specified Object Lambda Access Point.</p>
|
|
4556
5074
|
*/
|
|
4557
5075
|
AccountId?: string;
|
|
4558
5076
|
/**
|
|
5077
|
+
* @public
|
|
4559
5078
|
* <p>The name of the Object Lambda Access Point.</p>
|
|
4560
5079
|
*/
|
|
4561
5080
|
Name: string | undefined;
|
|
4562
5081
|
/**
|
|
5082
|
+
* @public
|
|
4563
5083
|
* <p>Object Lambda Access Point resource policy document.</p>
|
|
4564
5084
|
*/
|
|
4565
5085
|
Policy: string | undefined;
|
|
@@ -4570,6 +5090,7 @@ export interface PutAccessPointPolicyForObjectLambdaRequest {
|
|
|
4570
5090
|
*/
|
|
4571
5091
|
export interface LifecycleConfiguration {
|
|
4572
5092
|
/**
|
|
5093
|
+
* @public
|
|
4573
5094
|
* <p>A lifecycle rule for individual objects in an Outposts bucket. </p>
|
|
4574
5095
|
*/
|
|
4575
5096
|
Rules?: LifecycleRule[];
|
|
@@ -4579,14 +5100,17 @@ export interface LifecycleConfiguration {
|
|
|
4579
5100
|
*/
|
|
4580
5101
|
export interface PutBucketLifecycleConfigurationRequest {
|
|
4581
5102
|
/**
|
|
5103
|
+
* @public
|
|
4582
5104
|
* <p>The Amazon Web Services account ID of the Outposts bucket.</p>
|
|
4583
5105
|
*/
|
|
4584
5106
|
AccountId?: string;
|
|
4585
5107
|
/**
|
|
5108
|
+
* @public
|
|
4586
5109
|
* <p>The name of the bucket for which to set the configuration.</p>
|
|
4587
5110
|
*/
|
|
4588
5111
|
Bucket: string | undefined;
|
|
4589
5112
|
/**
|
|
5113
|
+
* @public
|
|
4590
5114
|
* <p>Container for lifecycle rules. You can add as many as 1,000 rules.</p>
|
|
4591
5115
|
*/
|
|
4592
5116
|
LifecycleConfiguration?: LifecycleConfiguration;
|
|
@@ -4596,16 +5120,19 @@ export interface PutBucketLifecycleConfigurationRequest {
|
|
|
4596
5120
|
*/
|
|
4597
5121
|
export interface PutBucketPolicyRequest {
|
|
4598
5122
|
/**
|
|
5123
|
+
* @public
|
|
4599
5124
|
* <p>The Amazon Web Services account ID of the Outposts bucket.</p>
|
|
4600
5125
|
*/
|
|
4601
5126
|
AccountId?: string;
|
|
4602
5127
|
/**
|
|
5128
|
+
* @public
|
|
4603
5129
|
* <p>Specifies the bucket.</p>
|
|
4604
5130
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
4605
5131
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
|
|
4606
5132
|
*/
|
|
4607
5133
|
Bucket: string | undefined;
|
|
4608
5134
|
/**
|
|
5135
|
+
* @public
|
|
4609
5136
|
* <p>Set this parameter to true to confirm that you want to remove your permissions to change
|
|
4610
5137
|
* this bucket policy in the future.</p>
|
|
4611
5138
|
* <note>
|
|
@@ -4614,6 +5141,7 @@ export interface PutBucketPolicyRequest {
|
|
|
4614
5141
|
*/
|
|
4615
5142
|
ConfirmRemoveSelfBucketAccess?: boolean;
|
|
4616
5143
|
/**
|
|
5144
|
+
* @public
|
|
4617
5145
|
* <p>The bucket policy as a JSON document.</p>
|
|
4618
5146
|
*/
|
|
4619
5147
|
Policy: string | undefined;
|
|
@@ -4623,16 +5151,19 @@ export interface PutBucketPolicyRequest {
|
|
|
4623
5151
|
*/
|
|
4624
5152
|
export interface PutBucketReplicationRequest {
|
|
4625
5153
|
/**
|
|
5154
|
+
* @public
|
|
4626
5155
|
* <p>The Amazon Web Services account ID of the Outposts bucket.</p>
|
|
4627
5156
|
*/
|
|
4628
5157
|
AccountId?: string;
|
|
4629
5158
|
/**
|
|
5159
|
+
* @public
|
|
4630
5160
|
* <p>Specifies the S3 on Outposts bucket to set the configuration for.</p>
|
|
4631
5161
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
4632
5162
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
|
|
4633
5163
|
*/
|
|
4634
5164
|
Bucket: string | undefined;
|
|
4635
5165
|
/**
|
|
5166
|
+
* @public
|
|
4636
5167
|
* <p></p>
|
|
4637
5168
|
*/
|
|
4638
5169
|
ReplicationConfiguration: ReplicationConfiguration | undefined;
|
|
@@ -4643,6 +5174,7 @@ export interface PutBucketReplicationRequest {
|
|
|
4643
5174
|
*/
|
|
4644
5175
|
export interface Tagging {
|
|
4645
5176
|
/**
|
|
5177
|
+
* @public
|
|
4646
5178
|
* <p>A collection for a set of tags.</p>
|
|
4647
5179
|
*/
|
|
4648
5180
|
TagSet: S3Tag[] | undefined;
|
|
@@ -4652,16 +5184,19 @@ export interface Tagging {
|
|
|
4652
5184
|
*/
|
|
4653
5185
|
export interface PutBucketTaggingRequest {
|
|
4654
5186
|
/**
|
|
5187
|
+
* @public
|
|
4655
5188
|
* <p>The Amazon Web Services account ID of the Outposts bucket.</p>
|
|
4656
5189
|
*/
|
|
4657
5190
|
AccountId?: string;
|
|
4658
5191
|
/**
|
|
5192
|
+
* @public
|
|
4659
5193
|
* <p>The Amazon Resource Name (ARN) of the bucket.</p>
|
|
4660
5194
|
* <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
|
|
4661
5195
|
* <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
|
|
4662
5196
|
*/
|
|
4663
5197
|
Bucket: string | undefined;
|
|
4664
5198
|
/**
|
|
5199
|
+
* @public
|
|
4665
5200
|
* <p></p>
|
|
4666
5201
|
*/
|
|
4667
5202
|
Tagging: Tagging | undefined;
|
|
@@ -4685,11 +5220,13 @@ export type MFADelete = (typeof MFADelete)[keyof typeof MFADelete];
|
|
|
4685
5220
|
*/
|
|
4686
5221
|
export interface VersioningConfiguration {
|
|
4687
5222
|
/**
|
|
5223
|
+
* @public
|
|
4688
5224
|
* <p>Specifies whether MFA delete is enabled or disabled in the bucket versioning
|
|
4689
5225
|
* configuration for the S3 on Outposts bucket.</p>
|
|
4690
5226
|
*/
|
|
4691
5227
|
MFADelete?: MFADelete | string;
|
|
4692
5228
|
/**
|
|
5229
|
+
* @public
|
|
4693
5230
|
* <p>Sets the versioning state of the S3 on Outposts bucket.</p>
|
|
4694
5231
|
*/
|
|
4695
5232
|
Status?: BucketVersioningStatus | string;
|
|
@@ -4699,19 +5236,23 @@ export interface VersioningConfiguration {
|
|
|
4699
5236
|
*/
|
|
4700
5237
|
export interface PutBucketVersioningRequest {
|
|
4701
5238
|
/**
|
|
5239
|
+
* @public
|
|
4702
5240
|
* <p>The Amazon Web Services account ID of the S3 on Outposts bucket.</p>
|
|
4703
5241
|
*/
|
|
4704
5242
|
AccountId?: string;
|
|
4705
5243
|
/**
|
|
5244
|
+
* @public
|
|
4706
5245
|
* <p>The S3 on Outposts bucket to set the versioning state for.</p>
|
|
4707
5246
|
*/
|
|
4708
5247
|
Bucket: string | undefined;
|
|
4709
5248
|
/**
|
|
5249
|
+
* @public
|
|
4710
5250
|
* <p>The concatenation of the authentication device's serial number, a space, and the value
|
|
4711
5251
|
* that is displayed on your authentication device.</p>
|
|
4712
5252
|
*/
|
|
4713
5253
|
MFA?: string;
|
|
4714
5254
|
/**
|
|
5255
|
+
* @public
|
|
4715
5256
|
* <p>The root-level tag for the <code>VersioningConfiguration</code> parameters.</p>
|
|
4716
5257
|
*/
|
|
4717
5258
|
VersioningConfiguration: VersioningConfiguration | undefined;
|
|
@@ -4721,14 +5262,17 @@ export interface PutBucketVersioningRequest {
|
|
|
4721
5262
|
*/
|
|
4722
5263
|
export interface PutJobTaggingRequest {
|
|
4723
5264
|
/**
|
|
5265
|
+
* @public
|
|
4724
5266
|
* <p>The Amazon Web Services account ID associated with the S3 Batch Operations job.</p>
|
|
4725
5267
|
*/
|
|
4726
5268
|
AccountId?: string;
|
|
4727
5269
|
/**
|
|
5270
|
+
* @public
|
|
4728
5271
|
* <p>The ID for the S3 Batch Operations job whose tags you want to replace.</p>
|
|
4729
5272
|
*/
|
|
4730
5273
|
JobId: string | undefined;
|
|
4731
5274
|
/**
|
|
5275
|
+
* @public
|
|
4732
5276
|
* <p>The set of tags to associate with the S3 Batch Operations job.</p>
|
|
4733
5277
|
*/
|
|
4734
5278
|
Tags: S3Tag[] | undefined;
|
|
@@ -4756,15 +5300,18 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
4756
5300
|
*/
|
|
4757
5301
|
export interface PutMultiRegionAccessPointPolicyRequest {
|
|
4758
5302
|
/**
|
|
5303
|
+
* @public
|
|
4759
5304
|
* <p>The Amazon Web Services account ID for the owner of the Multi-Region Access Point.</p>
|
|
4760
5305
|
*/
|
|
4761
5306
|
AccountId?: string;
|
|
4762
5307
|
/**
|
|
5308
|
+
* @public
|
|
4763
5309
|
* <p>An idempotency token used to identify the request and guarantee that requests are
|
|
4764
5310
|
* unique.</p>
|
|
4765
5311
|
*/
|
|
4766
5312
|
ClientToken?: string;
|
|
4767
5313
|
/**
|
|
5314
|
+
* @public
|
|
4768
5315
|
* <p>A container element containing the details of the policy for the Multi-Region Access Point.</p>
|
|
4769
5316
|
*/
|
|
4770
5317
|
Details: PutMultiRegionAccessPointPolicyInput | undefined;
|
|
@@ -4774,6 +5321,7 @@ export interface PutMultiRegionAccessPointPolicyRequest {
|
|
|
4774
5321
|
*/
|
|
4775
5322
|
export interface PutMultiRegionAccessPointPolicyResult {
|
|
4776
5323
|
/**
|
|
5324
|
+
* @public
|
|
4777
5325
|
* <p>The request token associated with the request. You can use this token with <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html">DescribeMultiRegionAccessPointOperation</a> to determine the status of asynchronous
|
|
4778
5326
|
* requests.</p>
|
|
4779
5327
|
*/
|
|
@@ -4784,11 +5332,13 @@ export interface PutMultiRegionAccessPointPolicyResult {
|
|
|
4784
5332
|
*/
|
|
4785
5333
|
export interface PutPublicAccessBlockRequest {
|
|
4786
5334
|
/**
|
|
5335
|
+
* @public
|
|
4787
5336
|
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to the specified
|
|
4788
5337
|
* Amazon Web Services account.</p>
|
|
4789
5338
|
*/
|
|
4790
5339
|
PublicAccessBlockConfiguration: PublicAccessBlockConfiguration | undefined;
|
|
4791
5340
|
/**
|
|
5341
|
+
* @public
|
|
4792
5342
|
* <p>The account ID for the Amazon Web Services account whose <code>PublicAccessBlock</code> configuration
|
|
4793
5343
|
* you want to set.</p>
|
|
4794
5344
|
*/
|
|
@@ -4799,18 +5349,22 @@ export interface PutPublicAccessBlockRequest {
|
|
|
4799
5349
|
*/
|
|
4800
5350
|
export interface PutStorageLensConfigurationRequest {
|
|
4801
5351
|
/**
|
|
5352
|
+
* @public
|
|
4802
5353
|
* <p>The ID of the S3 Storage Lens configuration.</p>
|
|
4803
5354
|
*/
|
|
4804
5355
|
ConfigId: string | undefined;
|
|
4805
5356
|
/**
|
|
5357
|
+
* @public
|
|
4806
5358
|
* <p>The account ID of the requester.</p>
|
|
4807
5359
|
*/
|
|
4808
5360
|
AccountId?: string;
|
|
4809
5361
|
/**
|
|
5362
|
+
* @public
|
|
4810
5363
|
* <p>The S3 Storage Lens configuration.</p>
|
|
4811
5364
|
*/
|
|
4812
5365
|
StorageLensConfiguration: StorageLensConfiguration | undefined;
|
|
4813
5366
|
/**
|
|
5367
|
+
* @public
|
|
4814
5368
|
* <p>The tag set of the S3 Storage Lens configuration.</p>
|
|
4815
5369
|
* <note>
|
|
4816
5370
|
* <p>You can set up to a maximum of 50 tags.</p>
|
|
@@ -4823,14 +5377,17 @@ export interface PutStorageLensConfigurationRequest {
|
|
|
4823
5377
|
*/
|
|
4824
5378
|
export interface PutStorageLensConfigurationTaggingRequest {
|
|
4825
5379
|
/**
|
|
5380
|
+
* @public
|
|
4826
5381
|
* <p>The ID of the S3 Storage Lens configuration.</p>
|
|
4827
5382
|
*/
|
|
4828
5383
|
ConfigId: string | undefined;
|
|
4829
5384
|
/**
|
|
5385
|
+
* @public
|
|
4830
5386
|
* <p>The account ID of the requester.</p>
|
|
4831
5387
|
*/
|
|
4832
5388
|
AccountId?: string;
|
|
4833
5389
|
/**
|
|
5390
|
+
* @public
|
|
4834
5391
|
* <p>The tag set of the S3 Storage Lens configuration.</p>
|
|
4835
5392
|
* <note>
|
|
4836
5393
|
* <p>You can set up to a maximum of 50 tags.</p>
|
|
@@ -4848,14 +5405,17 @@ export interface PutStorageLensConfigurationTaggingResult {
|
|
|
4848
5405
|
*/
|
|
4849
5406
|
export interface SubmitMultiRegionAccessPointRoutesRequest {
|
|
4850
5407
|
/**
|
|
5408
|
+
* @public
|
|
4851
5409
|
* <p>The Amazon Web Services account ID for the owner of the Multi-Region Access Point.</p>
|
|
4852
5410
|
*/
|
|
4853
5411
|
AccountId?: string;
|
|
4854
5412
|
/**
|
|
5413
|
+
* @public
|
|
4855
5414
|
* <p>The Multi-Region Access Point ARN.</p>
|
|
4856
5415
|
*/
|
|
4857
5416
|
Mrap: string | undefined;
|
|
4858
5417
|
/**
|
|
5418
|
+
* @public
|
|
4859
5419
|
* <p>The different routes that make up the new route configuration. Active routes return a
|
|
4860
5420
|
* value of <code>100</code>, and passive routes return a value of <code>0</code>.</p>
|
|
4861
5421
|
*/
|
|
@@ -4871,14 +5431,17 @@ export interface SubmitMultiRegionAccessPointRoutesResult {
|
|
|
4871
5431
|
*/
|
|
4872
5432
|
export interface UpdateJobPriorityRequest {
|
|
4873
5433
|
/**
|
|
5434
|
+
* @public
|
|
4874
5435
|
* <p>The Amazon Web Services account ID associated with the S3 Batch Operations job.</p>
|
|
4875
5436
|
*/
|
|
4876
5437
|
AccountId?: string;
|
|
4877
5438
|
/**
|
|
5439
|
+
* @public
|
|
4878
5440
|
* <p>The ID for the job whose priority you want to update.</p>
|
|
4879
5441
|
*/
|
|
4880
5442
|
JobId: string | undefined;
|
|
4881
5443
|
/**
|
|
5444
|
+
* @public
|
|
4882
5445
|
* <p>The priority you want to assign to this job.</p>
|
|
4883
5446
|
*/
|
|
4884
5447
|
Priority: number | undefined;
|
|
@@ -4888,10 +5451,12 @@ export interface UpdateJobPriorityRequest {
|
|
|
4888
5451
|
*/
|
|
4889
5452
|
export interface UpdateJobPriorityResult {
|
|
4890
5453
|
/**
|
|
5454
|
+
* @public
|
|
4891
5455
|
* <p>The ID for the job whose priority Amazon S3 updated.</p>
|
|
4892
5456
|
*/
|
|
4893
5457
|
JobId: string | undefined;
|
|
4894
5458
|
/**
|
|
5459
|
+
* @public
|
|
4895
5460
|
* <p>The new priority assigned to the specified job.</p>
|
|
4896
5461
|
*/
|
|
4897
5462
|
Priority: number | undefined;
|
|
@@ -4926,18 +5491,22 @@ export type RequestedJobStatus = (typeof RequestedJobStatus)[keyof typeof Reques
|
|
|
4926
5491
|
*/
|
|
4927
5492
|
export interface UpdateJobStatusRequest {
|
|
4928
5493
|
/**
|
|
5494
|
+
* @public
|
|
4929
5495
|
* <p>The Amazon Web Services account ID associated with the S3 Batch Operations job.</p>
|
|
4930
5496
|
*/
|
|
4931
5497
|
AccountId?: string;
|
|
4932
5498
|
/**
|
|
5499
|
+
* @public
|
|
4933
5500
|
* <p>The ID of the job whose status you want to update.</p>
|
|
4934
5501
|
*/
|
|
4935
5502
|
JobId: string | undefined;
|
|
4936
5503
|
/**
|
|
5504
|
+
* @public
|
|
4937
5505
|
* <p>The status that you want to move the specified job to.</p>
|
|
4938
5506
|
*/
|
|
4939
5507
|
RequestedJobStatus: RequestedJobStatus | string | undefined;
|
|
4940
5508
|
/**
|
|
5509
|
+
* @public
|
|
4941
5510
|
* <p>A description of the reason why you want to change the specified job's status. This
|
|
4942
5511
|
* field can be any string up to the maximum length.</p>
|
|
4943
5512
|
*/
|
|
@@ -4948,14 +5517,17 @@ export interface UpdateJobStatusRequest {
|
|
|
4948
5517
|
*/
|
|
4949
5518
|
export interface UpdateJobStatusResult {
|
|
4950
5519
|
/**
|
|
5520
|
+
* @public
|
|
4951
5521
|
* <p>The ID for the job whose status was updated.</p>
|
|
4952
5522
|
*/
|
|
4953
5523
|
JobId?: string;
|
|
4954
5524
|
/**
|
|
5525
|
+
* @public
|
|
4955
5526
|
* <p>The current status for the specified job.</p>
|
|
4956
5527
|
*/
|
|
4957
5528
|
Status?: JobStatus | string;
|
|
4958
5529
|
/**
|
|
5530
|
+
* @public
|
|
4959
5531
|
* <p>The reason that the specified job's status was updated.</p>
|
|
4960
5532
|
*/
|
|
4961
5533
|
StatusUpdateReason?: string;
|