@aws-sdk/client-s3-control 3.48.0 → 3.52.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/CHANGELOG.md +35 -0
- package/README.md +1 -4
- package/dist-cjs/models/models_0.js +89 -4
- package/dist-cjs/protocols/Aws_restXml.js +314 -0
- package/dist-es/models/models_0.js +67 -3
- package/dist-es/protocols/Aws_restXml.js +358 -44
- package/dist-types/S3Control.d.ts +297 -283
- package/dist-types/S3ControlClient.d.ts +1 -4
- package/dist-types/commands/CreateAccessPointCommand.d.ts +7 -7
- package/dist-types/commands/CreateAccessPointForObjectLambdaCommand.d.ts +4 -3
- package/dist-types/commands/CreateBucketCommand.d.ts +14 -9
- package/dist-types/commands/CreateJobCommand.d.ts +3 -4
- package/dist-types/commands/CreateMultiRegionAccessPointCommand.d.ts +9 -10
- package/dist-types/commands/DeleteAccessPointForObjectLambdaCommand.d.ts +2 -1
- package/dist-types/commands/DeleteAccessPointPolicyForObjectLambdaCommand.d.ts +2 -1
- package/dist-types/commands/DeleteBucketCommand.d.ts +5 -6
- package/dist-types/commands/DeleteBucketLifecycleConfigurationCommand.d.ts +8 -7
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +13 -12
- package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +7 -8
- package/dist-types/commands/DeleteJobTaggingCommand.d.ts +3 -2
- package/dist-types/commands/DeleteMultiRegionAccessPointCommand.d.ts +7 -8
- package/dist-types/commands/DeleteStorageLensConfigurationCommand.d.ts +6 -7
- package/dist-types/commands/DeleteStorageLensConfigurationTaggingCommand.d.ts +7 -7
- package/dist-types/commands/DescribeJobCommand.d.ts +1 -2
- package/dist-types/commands/DescribeMultiRegionAccessPointOperationCommand.d.ts +2 -3
- package/dist-types/commands/GetAccessPointConfigurationForObjectLambdaCommand.d.ts +2 -1
- package/dist-types/commands/GetAccessPointPolicyForObjectLambdaCommand.d.ts +2 -1
- package/dist-types/commands/GetAccessPointPolicyStatusCommand.d.ts +3 -1
- package/dist-types/commands/GetBucketCommand.d.ts +10 -12
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +12 -10
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +17 -12
- package/dist-types/commands/GetBucketTaggingCommand.d.ts +7 -7
- package/dist-types/commands/GetMultiRegionAccessPointCommand.d.ts +3 -4
- package/dist-types/commands/GetMultiRegionAccessPointPolicyCommand.d.ts +5 -5
- package/dist-types/commands/GetMultiRegionAccessPointPolicyStatusCommand.d.ts +6 -6
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +2 -2
- package/dist-types/commands/GetStorageLensConfigurationCommand.d.ts +5 -7
- package/dist-types/commands/GetStorageLensConfigurationTaggingCommand.d.ts +7 -6
- package/dist-types/commands/ListAccessPointsCommand.d.ts +4 -4
- package/dist-types/commands/ListAccessPointsForObjectLambdaCommand.d.ts +5 -5
- package/dist-types/commands/ListJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListMultiRegionAccessPointsCommand.d.ts +6 -7
- package/dist-types/commands/ListStorageLensConfigurationsCommand.d.ts +7 -7
- package/dist-types/commands/PutAccessPointConfigurationForObjectLambdaCommand.d.ts +2 -1
- package/dist-types/commands/PutAccessPointPolicyCommand.d.ts +3 -2
- package/dist-types/commands/PutAccessPointPolicyForObjectLambdaCommand.d.ts +3 -3
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +9 -7
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +14 -11
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +22 -20
- package/dist-types/commands/PutJobTaggingCommand.d.ts +16 -14
- package/dist-types/commands/PutMultiRegionAccessPointPolicyCommand.d.ts +7 -7
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +4 -3
- package/dist-types/commands/PutStorageLensConfigurationCommand.d.ts +3 -4
- package/dist-types/commands/PutStorageLensConfigurationTaggingCommand.d.ts +7 -8
- package/dist-types/commands/UpdateJobPriorityCommand.d.ts +1 -2
- package/dist-types/commands/UpdateJobStatusCommand.d.ts +1 -2
- package/dist-types/models/models_0.d.ts +570 -265
- package/dist-types/ts3.4/models/models_0.d.ts +149 -2
- package/package.json +46 -40
|
@@ -24,7 +24,8 @@ export declare enum NetworkOrigin {
|
|
|
24
24
|
*/
|
|
25
25
|
export interface VpcConfiguration {
|
|
26
26
|
/**
|
|
27
|
-
* <p>If this field is specified, this access point will only allow connections from the specified VPC
|
|
27
|
+
* <p>If this field is specified, this access point will only allow connections from the specified VPC
|
|
28
|
+
* ID.</p>
|
|
28
29
|
*/
|
|
29
30
|
VpcId: string | undefined;
|
|
30
31
|
}
|
|
@@ -54,7 +55,8 @@ export interface AccessPoint {
|
|
|
54
55
|
/**
|
|
55
56
|
* <p>The virtual private cloud (VPC) configuration for this access point, if one exists.</p>
|
|
56
57
|
* <note>
|
|
57
|
-
* <p>This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other
|
|
58
|
+
* <p>This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other
|
|
59
|
+
* Amazon Web Services.</p>
|
|
58
60
|
* </note>
|
|
59
61
|
*/
|
|
60
62
|
VpcConfiguration?: VpcConfiguration;
|
|
@@ -223,18 +225,20 @@ export declare enum AsyncOperationName {
|
|
|
223
225
|
PutMultiRegionAccessPointPolicy = "PutMultiRegionAccessPointPolicy"
|
|
224
226
|
}
|
|
225
227
|
/**
|
|
226
|
-
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3
|
|
227
|
-
* You can enable the configuration options in any combination. For more information
|
|
228
|
-
* 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>
|
|
228
|
+
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3
|
|
229
|
+
* account. You can enable the configuration options in any combination. For more information
|
|
230
|
+
* 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>
|
|
229
231
|
* <p>This is not supported for Amazon S3 on Outposts.</p>
|
|
230
232
|
*/
|
|
231
233
|
export interface PublicAccessBlockConfiguration {
|
|
232
234
|
/**
|
|
233
|
-
* <p>Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets
|
|
234
|
-
*
|
|
235
|
+
* <p>Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets
|
|
236
|
+
* in this account. Setting this element to <code>TRUE</code> causes the following
|
|
237
|
+
* behavior:</p>
|
|
235
238
|
* <ul>
|
|
236
239
|
* <li>
|
|
237
|
-
* <p>PUT Bucket acl and PUT Object acl calls fail if the specified ACL is
|
|
240
|
+
* <p>PUT Bucket acl and PUT Object acl calls fail if the specified ACL is
|
|
241
|
+
* public.</p>
|
|
238
242
|
* </li>
|
|
239
243
|
* <li>
|
|
240
244
|
* <p>PUT Object calls fail if the request includes a public ACL.</p>
|
|
@@ -248,9 +252,9 @@ export interface PublicAccessBlockConfiguration {
|
|
|
248
252
|
*/
|
|
249
253
|
BlockPublicAcls?: boolean;
|
|
250
254
|
/**
|
|
251
|
-
* <p>Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting
|
|
252
|
-
* element to <code>TRUE</code> causes Amazon S3 to ignore all public ACLs on buckets in
|
|
253
|
-
* account and any objects that they contain. </p>
|
|
255
|
+
* <p>Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting
|
|
256
|
+
* this element to <code>TRUE</code> causes Amazon S3 to ignore all public ACLs on buckets in
|
|
257
|
+
* this account and any objects that they contain. </p>
|
|
254
258
|
* <p>Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't
|
|
255
259
|
* prevent new public ACLs from being set.</p>
|
|
256
260
|
* <p>This is not supported for Amazon S3 on Outposts.</p>
|
|
@@ -265,12 +269,13 @@ export interface PublicAccessBlockConfiguration {
|
|
|
265
269
|
*/
|
|
266
270
|
BlockPublicPolicy?: boolean;
|
|
267
271
|
/**
|
|
268
|
-
* <p>Specifies whether Amazon S3 should restrict public bucket policies for buckets in this
|
|
269
|
-
* Setting this element to <code>TRUE</code> restricts access to buckets with public
|
|
270
|
-
* to only Amazon Web Service principals and authorized users within this
|
|
271
|
-
*
|
|
272
|
-
*
|
|
273
|
-
*
|
|
272
|
+
* <p>Specifies whether Amazon S3 should restrict public bucket policies for buckets in this
|
|
273
|
+
* account. Setting this element to <code>TRUE</code> restricts access to buckets with public
|
|
274
|
+
* policies to only Amazon Web Service principals and authorized users within this
|
|
275
|
+
* account.</p>
|
|
276
|
+
* <p>Enabling this setting doesn't affect previously stored bucket policies, except that
|
|
277
|
+
* public and cross-account access within any public bucket policy, including non-public
|
|
278
|
+
* delegation to specific accounts, is blocked.</p>
|
|
274
279
|
* <p>This is not supported for Amazon S3 on Outposts.</p>
|
|
275
280
|
*/
|
|
276
281
|
RestrictPublicBuckets?: boolean;
|
|
@@ -297,10 +302,7 @@ export declare namespace Region {
|
|
|
297
302
|
const filterSensitiveLog: (obj: Region) => any;
|
|
298
303
|
}
|
|
299
304
|
/**
|
|
300
|
-
* <p>A container for the information associated with a
|
|
301
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html">CreateMultiRegionAccessPoint</a>
|
|
302
|
-
* request.
|
|
303
|
-
* </p>
|
|
305
|
+
* <p>A container for the information associated with a <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html">CreateMultiRegionAccessPoint</a> request. </p>
|
|
304
306
|
*/
|
|
305
307
|
export interface CreateMultiRegionAccessPointInput {
|
|
306
308
|
/**
|
|
@@ -308,9 +310,9 @@ export interface CreateMultiRegionAccessPointInput {
|
|
|
308
310
|
*/
|
|
309
311
|
Name: string | undefined;
|
|
310
312
|
/**
|
|
311
|
-
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3
|
|
312
|
-
* You can enable the configuration options in any combination. For more information
|
|
313
|
-
* 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>
|
|
313
|
+
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3
|
|
314
|
+
* account. You can enable the configuration options in any combination. For more information
|
|
315
|
+
* 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>
|
|
314
316
|
* <p>This is not supported for Amazon S3 on Outposts.</p>
|
|
315
317
|
*/
|
|
316
318
|
PublicAccessBlock?: PublicAccessBlockConfiguration;
|
|
@@ -326,9 +328,7 @@ export declare namespace CreateMultiRegionAccessPointInput {
|
|
|
326
328
|
const filterSensitiveLog: (obj: CreateMultiRegionAccessPointInput) => any;
|
|
327
329
|
}
|
|
328
330
|
/**
|
|
329
|
-
* <p>A container for the information associated with a
|
|
330
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html">DeleteMultiRegionAccessPoint</a>
|
|
331
|
-
* request.</p>
|
|
331
|
+
* <p>A container for the information associated with a <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html">DeleteMultiRegionAccessPoint</a> request.</p>
|
|
332
332
|
*/
|
|
333
333
|
export interface DeleteMultiRegionAccessPointInput {
|
|
334
334
|
/**
|
|
@@ -343,9 +343,7 @@ export declare namespace DeleteMultiRegionAccessPointInput {
|
|
|
343
343
|
const filterSensitiveLog: (obj: DeleteMultiRegionAccessPointInput) => any;
|
|
344
344
|
}
|
|
345
345
|
/**
|
|
346
|
-
* <p>A container for the information associated with a
|
|
347
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPoint.html">PutMultiRegionAccessPoint</a>
|
|
348
|
-
* request.</p>
|
|
346
|
+
* <p>A container for the information associated with a <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPoint.html">PutMultiRegionAccessPoint</a> request.</p>
|
|
349
347
|
*/
|
|
350
348
|
export interface PutMultiRegionAccessPointPolicyInput {
|
|
351
349
|
/**
|
|
@@ -368,21 +366,15 @@ export declare namespace PutMultiRegionAccessPointPolicyInput {
|
|
|
368
366
|
*/
|
|
369
367
|
export interface AsyncRequestParameters {
|
|
370
368
|
/**
|
|
371
|
-
* <p>A container of the parameters for a
|
|
372
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html">CreateMultiRegionAccessPoint</a>
|
|
373
|
-
* request.</p>
|
|
369
|
+
* <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>
|
|
374
370
|
*/
|
|
375
371
|
CreateMultiRegionAccessPointRequest?: CreateMultiRegionAccessPointInput;
|
|
376
372
|
/**
|
|
377
|
-
* <p>A container of the parameters for a
|
|
378
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html">DeleteMultiRegionAccessPoint</a>
|
|
379
|
-
* request.</p>
|
|
373
|
+
* <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>
|
|
380
374
|
*/
|
|
381
375
|
DeleteMultiRegionAccessPointRequest?: DeleteMultiRegionAccessPointInput;
|
|
382
376
|
/**
|
|
383
|
-
* <p>A container of the parameters for a
|
|
384
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPoint.html">PutMultiRegionAccessPoint</a>
|
|
385
|
-
* request.</p>
|
|
377
|
+
* <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>
|
|
386
378
|
*/
|
|
387
379
|
PutMultiRegionAccessPointPolicyRequest?: PutMultiRegionAccessPointPolicyInput;
|
|
388
380
|
}
|
|
@@ -417,7 +409,7 @@ export declare namespace MultiRegionAccessPointRegionalResponse {
|
|
|
417
409
|
export interface MultiRegionAccessPointsAsyncResponse {
|
|
418
410
|
/**
|
|
419
411
|
* <p>A collection of status information for the different Regions that a Multi-Region Access Point
|
|
420
|
-
*
|
|
412
|
+
* supports.</p>
|
|
421
413
|
*/
|
|
422
414
|
Regions?: MultiRegionAccessPointRegionalResponse[];
|
|
423
415
|
}
|
|
@@ -429,7 +421,7 @@ export declare namespace MultiRegionAccessPointsAsyncResponse {
|
|
|
429
421
|
}
|
|
430
422
|
/**
|
|
431
423
|
* <p>A container for the response details that are returned when querying about an
|
|
432
|
-
*
|
|
424
|
+
* asynchronous request.</p>
|
|
433
425
|
*/
|
|
434
426
|
export interface AsyncResponseDetails {
|
|
435
427
|
/**
|
|
@@ -491,7 +483,8 @@ export interface AwsLambdaTransformation {
|
|
|
491
483
|
*/
|
|
492
484
|
FunctionArn: string | undefined;
|
|
493
485
|
/**
|
|
494
|
-
* <p>Additional JSON that provides supplemental data to the Lambda function used to transform
|
|
486
|
+
* <p>Additional JSON that provides supplemental data to the Lambda function used to transform
|
|
487
|
+
* objects.</p>
|
|
495
488
|
*/
|
|
496
489
|
FunctionPayload?: string;
|
|
497
490
|
}
|
|
@@ -503,7 +496,8 @@ export declare namespace AwsLambdaTransformation {
|
|
|
503
496
|
}
|
|
504
497
|
export interface CreateAccessPointRequest {
|
|
505
498
|
/**
|
|
506
|
-
* <p>The Amazon Web Services account ID for the owner of the bucket for which you want to create an
|
|
499
|
+
* <p>The Amazon Web Services account ID for the owner of the bucket for which you want to create an
|
|
500
|
+
* access point.</p>
|
|
507
501
|
*/
|
|
508
502
|
AccountId?: string;
|
|
509
503
|
/**
|
|
@@ -525,8 +519,7 @@ export interface CreateAccessPointRequest {
|
|
|
525
519
|
*/
|
|
526
520
|
VpcConfiguration?: VpcConfiguration;
|
|
527
521
|
/**
|
|
528
|
-
* <p>
|
|
529
|
-
* The <code>PublicAccessBlock</code> configuration that you want to apply to the access point.
|
|
522
|
+
* <p> The <code>PublicAccessBlock</code> configuration that you want to apply to the access point.
|
|
530
523
|
* </p>
|
|
531
524
|
*/
|
|
532
525
|
PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
|
|
@@ -594,7 +587,8 @@ export declare namespace ObjectLambdaContentTransformation {
|
|
|
594
587
|
*/
|
|
595
588
|
export interface ObjectLambdaTransformationConfiguration {
|
|
596
589
|
/**
|
|
597
|
-
* <p>A container for the action of an Object Lambda Access Point configuration. Valid input is
|
|
590
|
+
* <p>A container for the action of an Object Lambda Access Point configuration. Valid input is
|
|
591
|
+
* <code>GetObject</code>.</p>
|
|
598
592
|
*/
|
|
599
593
|
Actions: (ObjectLambdaTransformationConfigurationAction | string)[] | undefined;
|
|
600
594
|
/**
|
|
@@ -621,8 +615,8 @@ export interface ObjectLambdaConfiguration {
|
|
|
621
615
|
*/
|
|
622
616
|
CloudWatchMetricsEnabled?: boolean;
|
|
623
617
|
/**
|
|
624
|
-
* <p>A container for allowed features. Valid inputs are <code>GetObject-Range</code>
|
|
625
|
-
*
|
|
618
|
+
* <p>A container for allowed features. Valid inputs are <code>GetObject-Range</code> and
|
|
619
|
+
* <code>GetObject-PartNumber</code>.</p>
|
|
626
620
|
*/
|
|
627
621
|
AllowedFeatures?: (ObjectLambdaAllowedFeature | string)[];
|
|
628
622
|
/**
|
|
@@ -694,10 +688,8 @@ export declare type BucketLocationConstraint = "EU" | "ap-northeast-1" | "ap-sou
|
|
|
694
688
|
*/
|
|
695
689
|
export interface CreateBucketConfiguration {
|
|
696
690
|
/**
|
|
697
|
-
* <p>Specifies the Region where the bucket will be created.
|
|
698
|
-
*
|
|
699
|
-
* you do not need to specify the location.
|
|
700
|
-
* </p>
|
|
691
|
+
* <p>Specifies the Region where the bucket will be created. If you are creating a bucket on
|
|
692
|
+
* the US East (N. Virginia) Region (us-east-1), you do not need to specify the location. </p>
|
|
701
693
|
* <note>
|
|
702
694
|
* <p>This is not supported by Amazon S3 on Outposts buckets.</p>
|
|
703
695
|
* </note>
|
|
@@ -730,7 +722,8 @@ export interface CreateBucketRequest {
|
|
|
730
722
|
*/
|
|
731
723
|
CreateBucketConfiguration?: CreateBucketConfiguration;
|
|
732
724
|
/**
|
|
733
|
-
* <p>Allows grantee the read, write, read ACP, and write ACP permissions on the
|
|
725
|
+
* <p>Allows grantee the read, write, read ACP, and write ACP permissions on the
|
|
726
|
+
* bucket.</p>
|
|
734
727
|
* <note>
|
|
735
728
|
* <p>This is not supported by Amazon S3 on Outposts buckets.</p>
|
|
736
729
|
* </note>
|
|
@@ -850,7 +843,8 @@ export declare enum JobManifestFormat {
|
|
|
850
843
|
S3InventoryReport_CSV_20161130 = "S3InventoryReport_CSV_20161130"
|
|
851
844
|
}
|
|
852
845
|
/**
|
|
853
|
-
* <p>Describes the format of a manifest. If the manifest is in CSV format, also describes the
|
|
846
|
+
* <p>Describes the format of a manifest. If the manifest is in CSV format, also describes the
|
|
847
|
+
* columns contained within the manifest.</p>
|
|
854
848
|
*/
|
|
855
849
|
export interface JobManifestSpec {
|
|
856
850
|
/**
|
|
@@ -858,7 +852,8 @@ export interface JobManifestSpec {
|
|
|
858
852
|
*/
|
|
859
853
|
Format: JobManifestFormat | string | undefined;
|
|
860
854
|
/**
|
|
861
|
-
* <p>If the specified manifest object is in the <code>S3BatchOperations_CSV_20180820</code>
|
|
855
|
+
* <p>If the specified manifest object is in the <code>S3BatchOperations_CSV_20180820</code>
|
|
856
|
+
* format, this element describes which columns contain the required data.</p>
|
|
862
857
|
*/
|
|
863
858
|
Fields?: (JobManifestFieldName | string)[];
|
|
864
859
|
}
|
|
@@ -873,7 +868,8 @@ export declare namespace JobManifestSpec {
|
|
|
873
868
|
*/
|
|
874
869
|
export interface JobManifest {
|
|
875
870
|
/**
|
|
876
|
-
* <p>Describes the format of the specified job's manifest. If the manifest is in CSV format,
|
|
871
|
+
* <p>Describes the format of the specified job's manifest. If the manifest is in CSV format,
|
|
872
|
+
* also describes the columns contained within the manifest.</p>
|
|
877
873
|
*/
|
|
878
874
|
Spec: JobManifestSpec | undefined;
|
|
879
875
|
/**
|
|
@@ -887,12 +883,192 @@ export declare namespace JobManifest {
|
|
|
887
883
|
*/
|
|
888
884
|
const filterSensitiveLog: (obj: JobManifest) => any;
|
|
889
885
|
}
|
|
886
|
+
export declare enum ReplicationStatus {
|
|
887
|
+
COMPLETED = "COMPLETED",
|
|
888
|
+
FAILED = "FAILED",
|
|
889
|
+
NONE = "NONE",
|
|
890
|
+
REPLICA = "REPLICA"
|
|
891
|
+
}
|
|
892
|
+
/**
|
|
893
|
+
* <p>The filter used to describe a set of objects for the job's manifest.</p>
|
|
894
|
+
*/
|
|
895
|
+
export interface JobManifestGeneratorFilter {
|
|
896
|
+
/**
|
|
897
|
+
* <p>Include objects in the generated manifest only if they are eligible for replication
|
|
898
|
+
* according to the Replication configuration on the source bucket.</p>
|
|
899
|
+
*/
|
|
900
|
+
EligibleForReplication?: boolean;
|
|
901
|
+
/**
|
|
902
|
+
* <p>If provided, the generated manifest should include only source bucket objects that were
|
|
903
|
+
* created after this time.</p>
|
|
904
|
+
*/
|
|
905
|
+
CreatedAfter?: Date;
|
|
906
|
+
/**
|
|
907
|
+
* <p>If provided, the generated manifest should include only source bucket objects that were
|
|
908
|
+
* created before this time.</p>
|
|
909
|
+
*/
|
|
910
|
+
CreatedBefore?: Date;
|
|
911
|
+
/**
|
|
912
|
+
* <p>If provided, the generated manifest should include only source bucket objects that have
|
|
913
|
+
* one of the specified Replication statuses.</p>
|
|
914
|
+
*/
|
|
915
|
+
ObjectReplicationStatuses?: (ReplicationStatus | string)[];
|
|
916
|
+
}
|
|
917
|
+
export declare namespace JobManifestGeneratorFilter {
|
|
918
|
+
/**
|
|
919
|
+
* @internal
|
|
920
|
+
*/
|
|
921
|
+
const filterSensitiveLog: (obj: JobManifestGeneratorFilter) => any;
|
|
922
|
+
}
|
|
923
|
+
/**
|
|
924
|
+
* <p>Configuration for the use of SSE-KMS to encrypt generated manifest objects.</p>
|
|
925
|
+
*/
|
|
926
|
+
export interface SSEKMSEncryption {
|
|
927
|
+
/**
|
|
928
|
+
* <p>Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed
|
|
929
|
+
* key to use for encrypting generated manifest objects.</p>
|
|
930
|
+
*/
|
|
931
|
+
KeyId: string | undefined;
|
|
932
|
+
}
|
|
933
|
+
export declare namespace SSEKMSEncryption {
|
|
934
|
+
/**
|
|
935
|
+
* @internal
|
|
936
|
+
*/
|
|
937
|
+
const filterSensitiveLog: (obj: SSEKMSEncryption) => any;
|
|
938
|
+
}
|
|
939
|
+
/**
|
|
940
|
+
* <p>Configuration for the use of SSE-S3 to encrypt generated manifest objects.</p>
|
|
941
|
+
*/
|
|
942
|
+
export interface SSES3Encryption {
|
|
943
|
+
}
|
|
944
|
+
export declare namespace SSES3Encryption {
|
|
945
|
+
/**
|
|
946
|
+
* @internal
|
|
947
|
+
*/
|
|
948
|
+
const filterSensitiveLog: (obj: SSES3Encryption) => any;
|
|
949
|
+
}
|
|
950
|
+
/**
|
|
951
|
+
* <p>The encryption configuration to use when storing the generated manifest.</p>
|
|
952
|
+
*/
|
|
953
|
+
export interface GeneratedManifestEncryption {
|
|
954
|
+
/**
|
|
955
|
+
* <p>Specifies the use of SSE-S3 to encrypt generated manifest objects.</p>
|
|
956
|
+
*/
|
|
957
|
+
SSES3?: SSES3Encryption;
|
|
958
|
+
/**
|
|
959
|
+
* <p>Configuration details on how SSE-KMS is used to encrypt generated manifest
|
|
960
|
+
* objects.</p>
|
|
961
|
+
*/
|
|
962
|
+
SSEKMS?: SSEKMSEncryption;
|
|
963
|
+
}
|
|
964
|
+
export declare namespace GeneratedManifestEncryption {
|
|
965
|
+
/**
|
|
966
|
+
* @internal
|
|
967
|
+
*/
|
|
968
|
+
const filterSensitiveLog: (obj: GeneratedManifestEncryption) => any;
|
|
969
|
+
}
|
|
970
|
+
export declare enum GeneratedManifestFormat {
|
|
971
|
+
S3InventoryReport_CSV_20211130 = "S3InventoryReport_CSV_20211130"
|
|
972
|
+
}
|
|
973
|
+
/**
|
|
974
|
+
* <p>Location details for where the generated manifest should be written.</p>
|
|
975
|
+
*/
|
|
976
|
+
export interface S3ManifestOutputLocation {
|
|
977
|
+
/**
|
|
978
|
+
* <p>The Account ID that owns the bucket the generated manifest is written to.</p>
|
|
979
|
+
*/
|
|
980
|
+
ExpectedManifestBucketOwner?: string;
|
|
981
|
+
/**
|
|
982
|
+
* <p>The bucket ARN the generated manifest should be written to.</p>
|
|
983
|
+
*/
|
|
984
|
+
Bucket: string | undefined;
|
|
985
|
+
/**
|
|
986
|
+
* <p>Prefix identifying one or more objects to which the manifest applies.</p>
|
|
987
|
+
*/
|
|
988
|
+
ManifestPrefix?: string;
|
|
989
|
+
/**
|
|
990
|
+
* <p>Specifies what encryption should be used when the generated manifest objects are
|
|
991
|
+
* written.</p>
|
|
992
|
+
*/
|
|
993
|
+
ManifestEncryption?: GeneratedManifestEncryption;
|
|
994
|
+
/**
|
|
995
|
+
* <p>The format of the generated manifest.</p>
|
|
996
|
+
*/
|
|
997
|
+
ManifestFormat: GeneratedManifestFormat | string | undefined;
|
|
998
|
+
}
|
|
999
|
+
export declare namespace S3ManifestOutputLocation {
|
|
1000
|
+
/**
|
|
1001
|
+
* @internal
|
|
1002
|
+
*/
|
|
1003
|
+
const filterSensitiveLog: (obj: S3ManifestOutputLocation) => any;
|
|
1004
|
+
}
|
|
1005
|
+
/**
|
|
1006
|
+
* <p>The container for the service that will create the S3 manifest.</p>
|
|
1007
|
+
*/
|
|
1008
|
+
export interface S3JobManifestGenerator {
|
|
1009
|
+
/**
|
|
1010
|
+
* <p>The Amazon Web Services account ID that owns the bucket the generated manifest is written to. If
|
|
1011
|
+
* provided the generated manifest bucket's owner Amazon Web Services account ID must match this value, else
|
|
1012
|
+
* the job fails.</p>
|
|
1013
|
+
*/
|
|
1014
|
+
ExpectedBucketOwner?: string;
|
|
1015
|
+
/**
|
|
1016
|
+
* <p>The source bucket used by the ManifestGenerator.</p>
|
|
1017
|
+
*/
|
|
1018
|
+
SourceBucket: string | undefined;
|
|
1019
|
+
/**
|
|
1020
|
+
* <p>Specifies the location the generated manifest will be written to.</p>
|
|
1021
|
+
*/
|
|
1022
|
+
ManifestOutputLocation?: S3ManifestOutputLocation;
|
|
1023
|
+
/**
|
|
1024
|
+
* <p>Specifies rules the S3JobManifestGenerator should use to use to decide whether an object
|
|
1025
|
+
* in the source bucket should or should not be included in the generated job manifest.</p>
|
|
1026
|
+
*/
|
|
1027
|
+
Filter?: JobManifestGeneratorFilter;
|
|
1028
|
+
/**
|
|
1029
|
+
* <p>Determines whether or not to write the job's generated manifest to a bucket.</p>
|
|
1030
|
+
*/
|
|
1031
|
+
EnableManifestOutput: boolean | undefined;
|
|
1032
|
+
}
|
|
1033
|
+
export declare namespace S3JobManifestGenerator {
|
|
1034
|
+
/**
|
|
1035
|
+
* @internal
|
|
1036
|
+
*/
|
|
1037
|
+
const filterSensitiveLog: (obj: S3JobManifestGenerator) => any;
|
|
1038
|
+
}
|
|
1039
|
+
/**
|
|
1040
|
+
* <p>Configures the type of the job's ManifestGenerator.</p>
|
|
1041
|
+
*/
|
|
1042
|
+
export declare type JobManifestGenerator = JobManifestGenerator.S3JobManifestGeneratorMember | JobManifestGenerator.$UnknownMember;
|
|
1043
|
+
export declare namespace JobManifestGenerator {
|
|
1044
|
+
/**
|
|
1045
|
+
* <p>The S3 job ManifestGenerator's configuration details.</p>
|
|
1046
|
+
*/
|
|
1047
|
+
interface S3JobManifestGeneratorMember {
|
|
1048
|
+
S3JobManifestGenerator: S3JobManifestGenerator;
|
|
1049
|
+
$unknown?: never;
|
|
1050
|
+
}
|
|
1051
|
+
interface $UnknownMember {
|
|
1052
|
+
S3JobManifestGenerator?: never;
|
|
1053
|
+
$unknown: [string, any];
|
|
1054
|
+
}
|
|
1055
|
+
interface Visitor<T> {
|
|
1056
|
+
S3JobManifestGenerator: (value: S3JobManifestGenerator) => T;
|
|
1057
|
+
_: (name: string, value: any) => T;
|
|
1058
|
+
}
|
|
1059
|
+
const visit: <T>(value: JobManifestGenerator, visitor: Visitor<T>) => T;
|
|
1060
|
+
/**
|
|
1061
|
+
* @internal
|
|
1062
|
+
*/
|
|
1063
|
+
const filterSensitiveLog: (obj: JobManifestGenerator) => any;
|
|
1064
|
+
}
|
|
890
1065
|
/**
|
|
891
1066
|
* <p>Contains the configuration parameters for a <code>Lambda Invoke</code> operation.</p>
|
|
892
1067
|
*/
|
|
893
1068
|
export interface LambdaInvokeOperation {
|
|
894
1069
|
/**
|
|
895
|
-
* <p>The Amazon Resource Name (ARN) for the Lambda function that the specified job will
|
|
1070
|
+
* <p>The Amazon Resource Name (ARN) for the Lambda function that the specified job will
|
|
1071
|
+
* invoke on every object in the manifest.</p>
|
|
896
1072
|
*/
|
|
897
1073
|
FunctionArn?: string;
|
|
898
1074
|
}
|
|
@@ -903,7 +1079,8 @@ export declare namespace LambdaInvokeOperation {
|
|
|
903
1079
|
const filterSensitiveLog: (obj: LambdaInvokeOperation) => any;
|
|
904
1080
|
}
|
|
905
1081
|
/**
|
|
906
|
-
* <p>Contains no configuration parameters because the DELETE Object tagging API only accepts
|
|
1082
|
+
* <p>Contains no configuration parameters because the DELETE Object tagging API only accepts
|
|
1083
|
+
* the bucket name and key name as parameters, which are defined in the job's manifest.</p>
|
|
907
1084
|
*/
|
|
908
1085
|
export interface S3DeleteObjectTaggingOperation {
|
|
909
1086
|
}
|
|
@@ -919,29 +1096,28 @@ export declare enum S3GlacierJobTier {
|
|
|
919
1096
|
}
|
|
920
1097
|
/**
|
|
921
1098
|
* <p>Contains the configuration parameters for an S3 Initiate Restore Object job.
|
|
922
|
-
* S3 Batch Operations passes every object to the underlying POST Object restore API. For
|
|
923
|
-
*
|
|
1099
|
+
* S3 Batch Operations passes every object to the underlying POST Object restore API. For more
|
|
1100
|
+
* information about the parameters for this operation, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOSTrestore.html#RESTObjectPOSTrestore-restore-request">RestoreObject</a>.</p>
|
|
924
1101
|
*/
|
|
925
1102
|
export interface S3InitiateRestoreObjectOperation {
|
|
926
1103
|
/**
|
|
927
|
-
* <p>This argument specifies how long the S3 Glacier
|
|
928
|
-
* S3 Initiate Restore Object jobs that
|
|
929
|
-
*
|
|
930
|
-
*
|
|
931
|
-
*
|
|
932
|
-
*
|
|
933
|
-
*
|
|
934
|
-
*
|
|
935
|
-
*
|
|
936
|
-
* <p>S3 Batch Operations jobs can operate either on S3 Glacier Flexible Retrieval and S3 Glacier Deep Archive storage class
|
|
1104
|
+
* <p>This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains
|
|
1105
|
+
* available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive
|
|
1106
|
+
* objects require <code>ExpirationInDays</code> set to 1 or greater.</p>
|
|
1107
|
+
* <p>Conversely, do <i>not</i> set <code>ExpirationInDays</code> when creating
|
|
1108
|
+
* S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and
|
|
1109
|
+
* Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are
|
|
1110
|
+
* not subject to restore expiry, so specifying <code>ExpirationInDays</code> results in
|
|
1111
|
+
* restore request failure.</p>
|
|
1112
|
+
* <p>S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class
|
|
937
1113
|
* objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier
|
|
938
1114
|
* objects, but not both types in the same job. If you need to restore objects of both types
|
|
939
1115
|
* you <i>must</i> create separate Batch Operations jobs. </p>
|
|
940
1116
|
*/
|
|
941
1117
|
ExpirationInDays?: number;
|
|
942
1118
|
/**
|
|
943
|
-
* <p>S3 Batch Operations supports <code>STANDARD</code> and <code>BULK</code> retrieval tiers,
|
|
944
|
-
*
|
|
1119
|
+
* <p>S3 Batch Operations supports <code>STANDARD</code> and <code>BULK</code> retrieval tiers, but
|
|
1120
|
+
* not the <code>EXPEDITED</code> retrieval tier.</p>
|
|
945
1121
|
*/
|
|
946
1122
|
GlacierJobTier?: S3GlacierJobTier | string;
|
|
947
1123
|
}
|
|
@@ -1072,8 +1248,9 @@ export declare namespace S3AccessControlPolicy {
|
|
|
1072
1248
|
const filterSensitiveLog: (obj: S3AccessControlPolicy) => any;
|
|
1073
1249
|
}
|
|
1074
1250
|
/**
|
|
1075
|
-
* <p>Contains the configuration parameters for a Set Object ACL operation. S3 Batch Operations
|
|
1076
|
-
*
|
|
1251
|
+
* <p>Contains the configuration parameters for a Set Object ACL operation. S3 Batch Operations
|
|
1252
|
+
* passes every object to the underlying PUT Object acl API. For more information about the
|
|
1253
|
+
* parameters for this operation, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTacl.html">PUT Object acl</a>.</p>
|
|
1077
1254
|
*/
|
|
1078
1255
|
export interface S3SetObjectAclOperation {
|
|
1079
1256
|
/**
|
|
@@ -1182,20 +1359,22 @@ export declare enum S3ObjectLockMode {
|
|
|
1182
1359
|
export declare enum S3StorageClass {
|
|
1183
1360
|
DEEP_ARCHIVE = "DEEP_ARCHIVE",
|
|
1184
1361
|
GLACIER = "GLACIER",
|
|
1362
|
+
GLACIER_IR = "GLACIER_IR",
|
|
1185
1363
|
INTELLIGENT_TIERING = "INTELLIGENT_TIERING",
|
|
1186
1364
|
ONEZONE_IA = "ONEZONE_IA",
|
|
1187
1365
|
STANDARD = "STANDARD",
|
|
1188
1366
|
STANDARD_IA = "STANDARD_IA"
|
|
1189
1367
|
}
|
|
1190
1368
|
/**
|
|
1191
|
-
* <p>Contains the configuration parameters for a PUT Copy object operation. S3 Batch Operations
|
|
1192
|
-
*
|
|
1369
|
+
* <p>Contains the configuration parameters for a PUT Copy object operation. S3 Batch Operations
|
|
1370
|
+
* passes every object to the underlying PUT Copy object API. For more information about the
|
|
1371
|
+
* parameters for this operation, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectCOPY.html">PUT Object - Copy</a>.</p>
|
|
1193
1372
|
*/
|
|
1194
1373
|
export interface S3CopyObjectOperation {
|
|
1195
1374
|
/**
|
|
1196
|
-
* <p>Specifies the destination bucket ARN for the batch copy operation.
|
|
1197
|
-
*
|
|
1198
|
-
*
|
|
1375
|
+
* <p>Specifies the destination bucket ARN for the batch copy operation. For example, to copy
|
|
1376
|
+
* objects to a bucket named "destinationBucket", set the TargetResource to
|
|
1377
|
+
* "arn:aws:s3:::destinationBucket".</p>
|
|
1199
1378
|
*/
|
|
1200
1379
|
TargetResource?: string;
|
|
1201
1380
|
/**
|
|
@@ -1215,7 +1394,9 @@ export interface S3CopyObjectOperation {
|
|
|
1215
1394
|
*/
|
|
1216
1395
|
ModifiedSinceConstraint?: Date;
|
|
1217
1396
|
/**
|
|
1218
|
-
* <p
|
|
1397
|
+
* <p>If you don't provide this parameter, Amazon S3 copies all the metadata from the original
|
|
1398
|
+
* objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3
|
|
1399
|
+
* assigns the supplied tags to the new objects.</p>
|
|
1219
1400
|
*/
|
|
1220
1401
|
NewObjectMetadata?: S3ObjectMetadata;
|
|
1221
1402
|
/**
|
|
@@ -1259,8 +1440,8 @@ export interface S3CopyObjectOperation {
|
|
|
1259
1440
|
*/
|
|
1260
1441
|
ObjectLockMode?: S3ObjectLockMode | string;
|
|
1261
1442
|
/**
|
|
1262
|
-
* <p>The date when the applied object retention configuration expires on all objects in
|
|
1263
|
-
*
|
|
1443
|
+
* <p>The date when the applied object retention configuration expires on all objects in the
|
|
1444
|
+
* Batch Operations job.</p>
|
|
1264
1445
|
*/
|
|
1265
1446
|
ObjectLockRetainUntilDate?: Date;
|
|
1266
1447
|
/**
|
|
@@ -1268,7 +1449,7 @@ export interface S3CopyObjectOperation {
|
|
|
1268
1449
|
* server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to <code>true</code>
|
|
1269
1450
|
* causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.</p>
|
|
1270
1451
|
* <p>Specifying this header with an <i>object</i> action doesn’t affect
|
|
1271
|
-
*
|
|
1452
|
+
* <i>bucket-level</i> settings for S3 Bucket Key.</p>
|
|
1272
1453
|
*/
|
|
1273
1454
|
BucketKeyEnabled?: boolean;
|
|
1274
1455
|
}
|
|
@@ -1284,7 +1465,8 @@ export declare namespace S3CopyObjectOperation {
|
|
|
1284
1465
|
*/
|
|
1285
1466
|
export interface S3ObjectLockLegalHold {
|
|
1286
1467
|
/**
|
|
1287
|
-
* <p>The Object Lock legal hold status to be applied to all objects in the Batch Operations
|
|
1468
|
+
* <p>The Object Lock legal hold status to be applied to all objects in the Batch Operations
|
|
1469
|
+
* job.</p>
|
|
1288
1470
|
*/
|
|
1289
1471
|
Status: S3ObjectLockLegalHoldStatus | string | undefined;
|
|
1290
1472
|
}
|
|
@@ -1296,14 +1478,14 @@ export declare namespace S3ObjectLockLegalHold {
|
|
|
1296
1478
|
}
|
|
1297
1479
|
/**
|
|
1298
1480
|
* <p>Contains the configuration for an S3 Object Lock legal hold operation that an
|
|
1299
|
-
* S3 Batch Operations job passes every object to the underlying
|
|
1300
|
-
*
|
|
1301
|
-
*
|
|
1302
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
1481
|
+
* S3 Batch Operations job passes every object to the underlying <code>PutObjectLegalHold</code>
|
|
1482
|
+
* API. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html">Using S3 Object Lock legal hold
|
|
1483
|
+
* with S3 Batch Operations</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1303
1484
|
*/
|
|
1304
1485
|
export interface S3SetObjectLegalHoldOperation {
|
|
1305
1486
|
/**
|
|
1306
|
-
* <p>Contains the Object Lock legal hold status to be applied to all objects in the
|
|
1487
|
+
* <p>Contains the Object Lock legal hold status to be applied to all objects in the
|
|
1488
|
+
* Batch Operations job.</p>
|
|
1307
1489
|
*/
|
|
1308
1490
|
LegalHold: S3ObjectLockLegalHold | undefined;
|
|
1309
1491
|
}
|
|
@@ -1326,11 +1508,13 @@ export declare enum S3ObjectLockRetentionMode {
|
|
|
1326
1508
|
*/
|
|
1327
1509
|
export interface S3Retention {
|
|
1328
1510
|
/**
|
|
1329
|
-
* <p>The date when the applied Object Lock retention will expire on all objects set by the
|
|
1511
|
+
* <p>The date when the applied Object Lock retention will expire on all objects set by the
|
|
1512
|
+
* Batch Operations job.</p>
|
|
1330
1513
|
*/
|
|
1331
1514
|
RetainUntilDate?: Date;
|
|
1332
1515
|
/**
|
|
1333
|
-
* <p>The Object Lock retention mode to be applied to all objects in the Batch Operations
|
|
1516
|
+
* <p>The Object Lock retention mode to be applied to all objects in the Batch Operations
|
|
1517
|
+
* job.</p>
|
|
1334
1518
|
*/
|
|
1335
1519
|
Mode?: S3ObjectLockRetentionMode | string;
|
|
1336
1520
|
}
|
|
@@ -1349,8 +1533,8 @@ export declare namespace S3Retention {
|
|
|
1349
1533
|
*/
|
|
1350
1534
|
export interface S3SetObjectRetentionOperation {
|
|
1351
1535
|
/**
|
|
1352
|
-
* <p>Indicates if the action should be applied to objects in the Batch Operations job even if they
|
|
1353
|
-
* GOVERNANCE</code> type in place.</p>
|
|
1536
|
+
* <p>Indicates if the action should be applied to objects in the Batch Operations job even if they
|
|
1537
|
+
* have Object Lock <code> GOVERNANCE</code> type in place.</p>
|
|
1354
1538
|
*/
|
|
1355
1539
|
BypassGovernanceRetention?: boolean;
|
|
1356
1540
|
/**
|
|
@@ -1367,8 +1551,9 @@ export declare namespace S3SetObjectRetentionOperation {
|
|
|
1367
1551
|
const filterSensitiveLog: (obj: S3SetObjectRetentionOperation) => any;
|
|
1368
1552
|
}
|
|
1369
1553
|
/**
|
|
1370
|
-
* <p>Contains the configuration parameters for a Set Object Tagging operation. S3 Batch Operations
|
|
1371
|
-
*
|
|
1554
|
+
* <p>Contains the configuration parameters for a Set Object Tagging operation. S3 Batch Operations
|
|
1555
|
+
* passes every object to the underlying PUT Object tagging API. For more information about
|
|
1556
|
+
* the parameters for this operation, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTtagging.html">PUT Object tagging</a>.</p>
|
|
1372
1557
|
*/
|
|
1373
1558
|
export interface S3SetObjectTaggingOperation {
|
|
1374
1559
|
/**
|
|
@@ -1382,6 +1567,18 @@ export declare namespace S3SetObjectTaggingOperation {
|
|
|
1382
1567
|
*/
|
|
1383
1568
|
const filterSensitiveLog: (obj: S3SetObjectTaggingOperation) => any;
|
|
1384
1569
|
}
|
|
1570
|
+
/**
|
|
1571
|
+
* <p>Directs the specified job to invoke <code>ReplicateObject</code> on every object in the job's
|
|
1572
|
+
* manifest.</p>
|
|
1573
|
+
*/
|
|
1574
|
+
export interface S3ReplicateObjectOperation {
|
|
1575
|
+
}
|
|
1576
|
+
export declare namespace S3ReplicateObjectOperation {
|
|
1577
|
+
/**
|
|
1578
|
+
* @internal
|
|
1579
|
+
*/
|
|
1580
|
+
const filterSensitiveLog: (obj: S3ReplicateObjectOperation) => any;
|
|
1581
|
+
}
|
|
1385
1582
|
/**
|
|
1386
1583
|
* <p>The operation that you want this job to perform on every object listed in the manifest.
|
|
1387
1584
|
* For more information about the available operations, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html">Operations</a> in the
|
|
@@ -1389,35 +1586,40 @@ export declare namespace S3SetObjectTaggingOperation {
|
|
|
1389
1586
|
*/
|
|
1390
1587
|
export interface JobOperation {
|
|
1391
1588
|
/**
|
|
1392
|
-
* <p>Directs the specified job to invoke an Lambda function on every object in the
|
|
1589
|
+
* <p>Directs the specified job to invoke an Lambda function on every object in the
|
|
1590
|
+
* manifest.</p>
|
|
1393
1591
|
*/
|
|
1394
1592
|
LambdaInvoke?: LambdaInvokeOperation;
|
|
1395
1593
|
/**
|
|
1396
|
-
* <p>Directs the specified job to run a PUT Copy object call on every object in the
|
|
1594
|
+
* <p>Directs the specified job to run a PUT Copy object call on every object in the
|
|
1595
|
+
* manifest.</p>
|
|
1397
1596
|
*/
|
|
1398
1597
|
S3PutObjectCopy?: S3CopyObjectOperation;
|
|
1399
1598
|
/**
|
|
1400
|
-
* <p>Directs the specified job to run a PUT Object acl call on every object in the
|
|
1599
|
+
* <p>Directs the specified job to run a PUT Object acl call on every object in the
|
|
1600
|
+
* manifest.</p>
|
|
1401
1601
|
*/
|
|
1402
1602
|
S3PutObjectAcl?: S3SetObjectAclOperation;
|
|
1403
1603
|
/**
|
|
1404
|
-
* <p>Directs the specified job to run a PUT Object tagging call on every object in the
|
|
1604
|
+
* <p>Directs the specified job to run a PUT Object tagging call on every object in the
|
|
1605
|
+
* manifest.</p>
|
|
1405
1606
|
*/
|
|
1406
1607
|
S3PutObjectTagging?: S3SetObjectTaggingOperation;
|
|
1407
1608
|
/**
|
|
1408
|
-
* <p>Directs the specified job to execute a DELETE Object tagging call on every object in the
|
|
1609
|
+
* <p>Directs the specified job to execute a DELETE Object tagging call on every object in the
|
|
1610
|
+
* manifest.</p>
|
|
1409
1611
|
*/
|
|
1410
1612
|
S3DeleteObjectTagging?: S3DeleteObjectTaggingOperation;
|
|
1411
1613
|
/**
|
|
1412
|
-
* <p>Directs the specified job to initiate restore requests for every archived object in the
|
|
1614
|
+
* <p>Directs the specified job to initiate restore requests for every archived object in the
|
|
1615
|
+
* manifest.</p>
|
|
1413
1616
|
*/
|
|
1414
1617
|
S3InitiateRestoreObject?: S3InitiateRestoreObjectOperation;
|
|
1415
1618
|
/**
|
|
1416
1619
|
* <p>Contains the configuration for an S3 Object Lock legal hold operation that an
|
|
1417
|
-
* S3 Batch Operations job passes every object to the underlying
|
|
1418
|
-
*
|
|
1419
|
-
*
|
|
1420
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
1620
|
+
* S3 Batch Operations job passes every object to the underlying <code>PutObjectLegalHold</code>
|
|
1621
|
+
* API. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html">Using S3 Object Lock legal hold
|
|
1622
|
+
* with S3 Batch Operations</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1421
1623
|
*/
|
|
1422
1624
|
S3PutObjectLegalHold?: S3SetObjectLegalHoldOperation;
|
|
1423
1625
|
/**
|
|
@@ -1428,6 +1630,11 @@ export interface JobOperation {
|
|
|
1428
1630
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
1429
1631
|
*/
|
|
1430
1632
|
S3PutObjectRetention?: S3SetObjectRetentionOperation;
|
|
1633
|
+
/**
|
|
1634
|
+
* <p>Directs the specified job to invoke <code>ReplicateObject</code> on every object in the
|
|
1635
|
+
* job's manifest.</p>
|
|
1636
|
+
*/
|
|
1637
|
+
S3ReplicateObject?: S3ReplicateObjectOperation;
|
|
1431
1638
|
}
|
|
1432
1639
|
export declare namespace JobOperation {
|
|
1433
1640
|
/**
|
|
@@ -1447,7 +1654,8 @@ export declare enum JobReportScope {
|
|
|
1447
1654
|
*/
|
|
1448
1655
|
export interface JobReport {
|
|
1449
1656
|
/**
|
|
1450
|
-
* <p>The Amazon Resource Name (ARN) for the bucket where specified job-completion report will
|
|
1657
|
+
* <p>The Amazon Resource Name (ARN) for the bucket where specified job-completion report will
|
|
1658
|
+
* be stored.</p>
|
|
1451
1659
|
*/
|
|
1452
1660
|
Bucket?: string;
|
|
1453
1661
|
/**
|
|
@@ -1465,7 +1673,8 @@ export interface JobReport {
|
|
|
1465
1673
|
*/
|
|
1466
1674
|
Prefix?: string;
|
|
1467
1675
|
/**
|
|
1468
|
-
* <p>Indicates whether the job-completion report will include details of all tasks or only
|
|
1676
|
+
* <p>Indicates whether the job-completion report will include details of all tasks or only
|
|
1677
|
+
* failed tasks.</p>
|
|
1469
1678
|
*/
|
|
1470
1679
|
ReportScope?: JobReportScope | string;
|
|
1471
1680
|
}
|
|
@@ -1481,12 +1690,13 @@ export interface CreateJobRequest {
|
|
|
1481
1690
|
*/
|
|
1482
1691
|
AccountId?: string;
|
|
1483
1692
|
/**
|
|
1484
|
-
* <p>Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is
|
|
1693
|
+
* <p>Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is
|
|
1694
|
+
* only required for jobs created through the Amazon S3 console.</p>
|
|
1485
1695
|
*/
|
|
1486
1696
|
ConfirmationRequired?: boolean;
|
|
1487
1697
|
/**
|
|
1488
|
-
* <p>The action that you want this job to perform on every object listed in the manifest.
|
|
1489
|
-
*
|
|
1698
|
+
* <p>The action that you want this job to perform on every object listed in the manifest. For
|
|
1699
|
+
* 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
|
|
1490
1700
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
1491
1701
|
*/
|
|
1492
1702
|
Operation: JobOperation | undefined;
|
|
@@ -1495,15 +1705,17 @@ export interface CreateJobRequest {
|
|
|
1495
1705
|
*/
|
|
1496
1706
|
Report: JobReport | undefined;
|
|
1497
1707
|
/**
|
|
1498
|
-
* <p>An idempotency token to ensure that you don't accidentally submit the same request
|
|
1708
|
+
* <p>An idempotency token to ensure that you don't accidentally submit the same request
|
|
1709
|
+
* twice. You can use any string up to the maximum length.</p>
|
|
1499
1710
|
*/
|
|
1500
1711
|
ClientRequestToken?: string;
|
|
1501
1712
|
/**
|
|
1502
1713
|
* <p>Configuration parameters for the manifest.</p>
|
|
1503
1714
|
*/
|
|
1504
|
-
Manifest
|
|
1715
|
+
Manifest?: JobManifest;
|
|
1505
1716
|
/**
|
|
1506
|
-
* <p>A description for this job. You can use any string within the permitted length.
|
|
1717
|
+
* <p>A description for this job. You can use any string within the permitted length.
|
|
1718
|
+
* Descriptions don't need to be unique and can be used for multiple jobs.</p>
|
|
1507
1719
|
*/
|
|
1508
1720
|
Description?: string;
|
|
1509
1721
|
/**
|
|
@@ -1511,15 +1723,20 @@ export interface CreateJobRequest {
|
|
|
1511
1723
|
*/
|
|
1512
1724
|
Priority: number | undefined;
|
|
1513
1725
|
/**
|
|
1514
|
-
* <p>The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role
|
|
1515
|
-
*
|
|
1516
|
-
* manifest.</p>
|
|
1726
|
+
* <p>The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will
|
|
1727
|
+
* use to run this job's action on every object in the manifest.</p>
|
|
1517
1728
|
*/
|
|
1518
1729
|
RoleArn: string | undefined;
|
|
1519
1730
|
/**
|
|
1520
|
-
* <p>A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.
|
|
1731
|
+
* <p>A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.
|
|
1732
|
+
* </p>
|
|
1521
1733
|
*/
|
|
1522
1734
|
Tags?: S3Tag[];
|
|
1735
|
+
/**
|
|
1736
|
+
* <p>The attribute container for the ManifestGenerator details. Jobs must be created with
|
|
1737
|
+
* either a manifest file or a ManifestGenerator, but not both.</p>
|
|
1738
|
+
*/
|
|
1739
|
+
ManifestGenerator?: JobManifestGenerator;
|
|
1523
1740
|
}
|
|
1524
1741
|
export declare namespace CreateJobRequest {
|
|
1525
1742
|
/**
|
|
@@ -1567,12 +1784,12 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe
|
|
|
1567
1784
|
export interface CreateMultiRegionAccessPointRequest {
|
|
1568
1785
|
/**
|
|
1569
1786
|
* <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
|
|
1570
|
-
*
|
|
1787
|
+
* the underlying buckets.</p>
|
|
1571
1788
|
*/
|
|
1572
1789
|
AccountId?: string;
|
|
1573
1790
|
/**
|
|
1574
1791
|
* <p>An idempotency token used to identify the request and guarantee that requests are
|
|
1575
|
-
*
|
|
1792
|
+
* unique.</p>
|
|
1576
1793
|
*/
|
|
1577
1794
|
ClientToken?: string;
|
|
1578
1795
|
/**
|
|
@@ -1588,8 +1805,8 @@ export declare namespace CreateMultiRegionAccessPointRequest {
|
|
|
1588
1805
|
}
|
|
1589
1806
|
export interface CreateMultiRegionAccessPointResult {
|
|
1590
1807
|
/**
|
|
1591
|
-
* <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
|
|
1592
|
-
*
|
|
1808
|
+
* <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
|
|
1809
|
+
* requests.</p>
|
|
1593
1810
|
*/
|
|
1594
1811
|
RequestTokenARN?: string;
|
|
1595
1812
|
}
|
|
@@ -1778,7 +1995,7 @@ export interface DeleteMultiRegionAccessPointRequest {
|
|
|
1778
1995
|
AccountId?: string;
|
|
1779
1996
|
/**
|
|
1780
1997
|
* <p>An idempotency token used to identify the request and guarantee that requests are
|
|
1781
|
-
*
|
|
1998
|
+
* unique.</p>
|
|
1782
1999
|
*/
|
|
1783
2000
|
ClientToken?: string;
|
|
1784
2001
|
/**
|
|
@@ -1794,8 +2011,8 @@ export declare namespace DeleteMultiRegionAccessPointRequest {
|
|
|
1794
2011
|
}
|
|
1795
2012
|
export interface DeleteMultiRegionAccessPointResult {
|
|
1796
2013
|
/**
|
|
1797
|
-
* <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
|
|
1798
|
-
*
|
|
2014
|
+
* <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
|
|
2015
|
+
* requests.</p>
|
|
1799
2016
|
*/
|
|
1800
2017
|
RequestTokenARN?: string;
|
|
1801
2018
|
}
|
|
@@ -1807,8 +2024,8 @@ export declare namespace DeleteMultiRegionAccessPointResult {
|
|
|
1807
2024
|
}
|
|
1808
2025
|
export interface DeletePublicAccessBlockRequest {
|
|
1809
2026
|
/**
|
|
1810
|
-
* <p>The account ID for the Amazon Web Services account whose <code>PublicAccessBlock</code> configuration
|
|
1811
|
-
* to remove.</p>
|
|
2027
|
+
* <p>The account ID for the Amazon Web Services account whose <code>PublicAccessBlock</code> configuration
|
|
2028
|
+
* you want to remove.</p>
|
|
1812
2029
|
*/
|
|
1813
2030
|
AccountId?: string;
|
|
1814
2031
|
}
|
|
@@ -1894,7 +2111,44 @@ export declare namespace JobFailure {
|
|
|
1894
2111
|
const filterSensitiveLog: (obj: JobFailure) => any;
|
|
1895
2112
|
}
|
|
1896
2113
|
/**
|
|
1897
|
-
* <p>Describes the
|
|
2114
|
+
* <p>Describes the specified job's generated manifest. Batch Operations jobs created with a
|
|
2115
|
+
* ManifestGenerator populate details of this descriptor after execution of the
|
|
2116
|
+
* ManifestGenerator.</p>
|
|
2117
|
+
*/
|
|
2118
|
+
export interface S3GeneratedManifestDescriptor {
|
|
2119
|
+
/**
|
|
2120
|
+
* <p>The format of the generated manifest.</p>
|
|
2121
|
+
*/
|
|
2122
|
+
Format?: GeneratedManifestFormat | string;
|
|
2123
|
+
/**
|
|
2124
|
+
* <p>Contains the information required to locate a manifest object.</p>
|
|
2125
|
+
*/
|
|
2126
|
+
Location?: JobManifestLocation;
|
|
2127
|
+
}
|
|
2128
|
+
export declare namespace S3GeneratedManifestDescriptor {
|
|
2129
|
+
/**
|
|
2130
|
+
* @internal
|
|
2131
|
+
*/
|
|
2132
|
+
const filterSensitiveLog: (obj: S3GeneratedManifestDescriptor) => any;
|
|
2133
|
+
}
|
|
2134
|
+
/**
|
|
2135
|
+
* <p>Provides timing details for the job.</p>
|
|
2136
|
+
*/
|
|
2137
|
+
export interface JobTimers {
|
|
2138
|
+
/**
|
|
2139
|
+
* <p>Indicates the elapsed time in seconds the job has been in the Active job state.</p>
|
|
2140
|
+
*/
|
|
2141
|
+
ElapsedTimeInActiveSeconds?: number;
|
|
2142
|
+
}
|
|
2143
|
+
export declare namespace JobTimers {
|
|
2144
|
+
/**
|
|
2145
|
+
* @internal
|
|
2146
|
+
*/
|
|
2147
|
+
const filterSensitiveLog: (obj: JobTimers) => any;
|
|
2148
|
+
}
|
|
2149
|
+
/**
|
|
2150
|
+
* <p>Describes the total number of tasks that the specified job has started, the number of
|
|
2151
|
+
* tasks that succeeded, and the number of tasks that failed.</p>
|
|
1898
2152
|
*/
|
|
1899
2153
|
export interface JobProgressSummary {
|
|
1900
2154
|
/**
|
|
@@ -1909,6 +2163,10 @@ export interface JobProgressSummary {
|
|
|
1909
2163
|
* <p></p>
|
|
1910
2164
|
*/
|
|
1911
2165
|
NumberOfTasksFailed?: number;
|
|
2166
|
+
/**
|
|
2167
|
+
* <p>The JobTimers attribute of a job's progress summary.</p>
|
|
2168
|
+
*/
|
|
2169
|
+
Timers?: JobTimers;
|
|
1912
2170
|
}
|
|
1913
2171
|
export declare namespace JobProgressSummary {
|
|
1914
2172
|
/**
|
|
@@ -1932,7 +2190,8 @@ export declare enum JobStatus {
|
|
|
1932
2190
|
Suspended = "Suspended"
|
|
1933
2191
|
}
|
|
1934
2192
|
/**
|
|
1935
|
-
* <p>A container element for the job configuration and status information returned by a
|
|
2193
|
+
* <p>A container element for the job configuration and status information returned by a
|
|
2194
|
+
* <code>Describe Job</code> request.</p>
|
|
1936
2195
|
*/
|
|
1937
2196
|
export interface JobDescriptor {
|
|
1938
2197
|
/**
|
|
@@ -1940,11 +2199,13 @@ export interface JobDescriptor {
|
|
|
1940
2199
|
*/
|
|
1941
2200
|
JobId?: string;
|
|
1942
2201
|
/**
|
|
1943
|
-
* <p>Indicates whether confirmation is required before Amazon S3 begins running the specified job.
|
|
2202
|
+
* <p>Indicates whether confirmation is required before Amazon S3 begins running the specified job.
|
|
2203
|
+
* Confirmation is required only for jobs created through the Amazon S3 console.</p>
|
|
1944
2204
|
*/
|
|
1945
2205
|
ConfirmationRequired?: boolean;
|
|
1946
2206
|
/**
|
|
1947
|
-
* <p>The description for this job, if one was provided in this job's <code>Create Job</code>
|
|
2207
|
+
* <p>The description for this job, if one was provided in this job's <code>Create Job</code>
|
|
2208
|
+
* request.</p>
|
|
1948
2209
|
*/
|
|
1949
2210
|
Description?: string;
|
|
1950
2211
|
/**
|
|
@@ -1960,7 +2221,8 @@ export interface JobDescriptor {
|
|
|
1960
2221
|
*/
|
|
1961
2222
|
Manifest?: JobManifest;
|
|
1962
2223
|
/**
|
|
1963
|
-
* <p>The operation that the specified job is configured to run on the objects listed in the
|
|
2224
|
+
* <p>The operation that the specified job is configured to run on the objects listed in the
|
|
2225
|
+
* manifest.</p>
|
|
1964
2226
|
*/
|
|
1965
2227
|
Operation?: JobOperation;
|
|
1966
2228
|
/**
|
|
@@ -1977,11 +2239,13 @@ export interface JobDescriptor {
|
|
|
1977
2239
|
*/
|
|
1978
2240
|
StatusUpdateReason?: string;
|
|
1979
2241
|
/**
|
|
1980
|
-
* <p>If the specified job failed, this field contains information describing the
|
|
2242
|
+
* <p>If the specified job failed, this field contains information describing the
|
|
2243
|
+
* failure.</p>
|
|
1981
2244
|
*/
|
|
1982
2245
|
FailureReasons?: JobFailure[];
|
|
1983
2246
|
/**
|
|
1984
|
-
* <p>Contains the configuration information for the job-completion report if you requested
|
|
2247
|
+
* <p>Contains the configuration information for the job-completion report if you requested
|
|
2248
|
+
* one in the <code>Create Job</code> request.</p>
|
|
1985
2249
|
*/
|
|
1986
2250
|
Report?: JobReport;
|
|
1987
2251
|
/**
|
|
@@ -1989,12 +2253,13 @@ export interface JobDescriptor {
|
|
|
1989
2253
|
*/
|
|
1990
2254
|
CreationTime?: Date;
|
|
1991
2255
|
/**
|
|
1992
|
-
* <p>A timestamp indicating when this job terminated. A job's termination date is the date
|
|
2256
|
+
* <p>A timestamp indicating when this job terminated. A job's termination date is the date
|
|
2257
|
+
* and time when it succeeded, failed, or was canceled.</p>
|
|
1993
2258
|
*/
|
|
1994
2259
|
TerminationDate?: Date;
|
|
1995
2260
|
/**
|
|
1996
|
-
* <p>The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role
|
|
1997
|
-
*
|
|
2261
|
+
* <p>The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role assigned to run the tasks
|
|
2262
|
+
* for this job.</p>
|
|
1998
2263
|
*/
|
|
1999
2264
|
RoleArn?: string;
|
|
2000
2265
|
/**
|
|
@@ -2002,10 +2267,21 @@ export interface JobDescriptor {
|
|
|
2002
2267
|
*/
|
|
2003
2268
|
SuspendedDate?: Date;
|
|
2004
2269
|
/**
|
|
2005
|
-
* <p>The reason why the specified job was suspended. A job is only suspended if you create it
|
|
2006
|
-
*
|
|
2270
|
+
* <p>The reason why the specified job was suspended. A job is only suspended if you create it
|
|
2271
|
+
* through the Amazon S3 console. When you create the job, it enters the <code>Suspended</code>
|
|
2272
|
+
* state to await confirmation before running. After you confirm the job, it automatically
|
|
2273
|
+
* exits the <code>Suspended</code> state.</p>
|
|
2007
2274
|
*/
|
|
2008
2275
|
SuspendedCause?: string;
|
|
2276
|
+
/**
|
|
2277
|
+
* <p>The manifest generator that was used to generate a job manifest for this job.</p>
|
|
2278
|
+
*/
|
|
2279
|
+
ManifestGenerator?: JobManifestGenerator;
|
|
2280
|
+
/**
|
|
2281
|
+
* <p>The attribute of the JobDescriptor containing details about the job's generated
|
|
2282
|
+
* manifest.</p>
|
|
2283
|
+
*/
|
|
2284
|
+
GeneratedManifestDescriptor?: S3GeneratedManifestDescriptor;
|
|
2009
2285
|
}
|
|
2010
2286
|
export declare namespace JobDescriptor {
|
|
2011
2287
|
/**
|
|
@@ -2015,7 +2291,8 @@ export declare namespace JobDescriptor {
|
|
|
2015
2291
|
}
|
|
2016
2292
|
export interface DescribeJobResult {
|
|
2017
2293
|
/**
|
|
2018
|
-
* <p>Contains the configuration parameters and status for the job specified in the
|
|
2294
|
+
* <p>Contains the configuration parameters and status for the job specified in the
|
|
2295
|
+
* <code>Describe Job</code> request.</p>
|
|
2019
2296
|
*/
|
|
2020
2297
|
Job?: JobDescriptor;
|
|
2021
2298
|
}
|
|
@@ -2032,8 +2309,8 @@ export interface DescribeMultiRegionAccessPointOperationRequest {
|
|
|
2032
2309
|
AccountId?: string;
|
|
2033
2310
|
/**
|
|
2034
2311
|
* <p>The request token associated with the request you want to know about. This request token
|
|
2035
|
-
*
|
|
2036
|
-
*
|
|
2312
|
+
* is returned as part of the response when you make an asynchronous request. You provide this
|
|
2313
|
+
* token to query about the status of the asynchronous action.</p>
|
|
2037
2314
|
*/
|
|
2038
2315
|
RequestTokenARN: string | undefined;
|
|
2039
2316
|
}
|
|
@@ -2095,14 +2372,15 @@ export interface GetAccessPointResult {
|
|
|
2095
2372
|
/**
|
|
2096
2373
|
* <p>Contains the virtual private cloud (VPC) configuration for the specified access point.</p>
|
|
2097
2374
|
* <note>
|
|
2098
|
-
* <p>This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other
|
|
2375
|
+
* <p>This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other
|
|
2376
|
+
* Amazon Web Services.</p>
|
|
2099
2377
|
* </note>
|
|
2100
2378
|
*/
|
|
2101
2379
|
VpcConfiguration?: VpcConfiguration;
|
|
2102
2380
|
/**
|
|
2103
|
-
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3
|
|
2104
|
-
* You can enable the configuration options in any combination. For more information
|
|
2105
|
-
* 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>
|
|
2381
|
+
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3
|
|
2382
|
+
* account. You can enable the configuration options in any combination. For more information
|
|
2383
|
+
* 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>
|
|
2106
2384
|
* <p>This is not supported for Amazon S3 on Outposts.</p>
|
|
2107
2385
|
*/
|
|
2108
2386
|
PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
|
|
@@ -2181,7 +2459,8 @@ export interface GetAccessPointForObjectLambdaResult {
|
|
|
2181
2459
|
*/
|
|
2182
2460
|
Name?: string;
|
|
2183
2461
|
/**
|
|
2184
|
-
* <p>Configuration to block all public access. This setting is turned on and can not be
|
|
2462
|
+
* <p>Configuration to block all public access. This setting is turned on and can not be
|
|
2463
|
+
* edited. </p>
|
|
2185
2464
|
*/
|
|
2186
2465
|
PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
|
|
2187
2466
|
/**
|
|
@@ -2270,10 +2549,8 @@ export declare namespace GetAccessPointPolicyStatusRequest {
|
|
|
2270
2549
|
const filterSensitiveLog: (obj: GetAccessPointPolicyStatusRequest) => any;
|
|
2271
2550
|
}
|
|
2272
2551
|
/**
|
|
2273
|
-
* <p>Indicates whether this access point policy is public. For more information about how Amazon S3
|
|
2274
|
-
* <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
|
|
2275
|
-
* <i>Amazon S3 User Guide</i>.
|
|
2276
|
-
* </p>
|
|
2552
|
+
* <p>Indicates whether this access point policy is public. For more information about how Amazon S3
|
|
2553
|
+
* 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>
|
|
2277
2554
|
*/
|
|
2278
2555
|
export interface PolicyStatus {
|
|
2279
2556
|
/**
|
|
@@ -2317,10 +2594,8 @@ export declare namespace GetAccessPointPolicyStatusForObjectLambdaRequest {
|
|
|
2317
2594
|
}
|
|
2318
2595
|
export interface GetAccessPointPolicyStatusForObjectLambdaResult {
|
|
2319
2596
|
/**
|
|
2320
|
-
* <p>Indicates whether this access point policy is public. For more information about how Amazon S3
|
|
2321
|
-
* <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
|
|
2322
|
-
* <i>Amazon S3 User Guide</i>.
|
|
2323
|
-
* </p>
|
|
2597
|
+
* <p>Indicates whether this access point policy is public. For more information about how Amazon S3
|
|
2598
|
+
* 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>
|
|
2324
2599
|
*/
|
|
2325
2600
|
PolicyStatus?: PolicyStatus;
|
|
2326
2601
|
}
|
|
@@ -2396,7 +2671,8 @@ export interface LifecycleExpiration {
|
|
|
2396
2671
|
*/
|
|
2397
2672
|
Date?: Date;
|
|
2398
2673
|
/**
|
|
2399
|
-
* <p>Indicates the lifetime, in days, of the objects that are subject to the rule. The value
|
|
2674
|
+
* <p>Indicates the lifetime, in days, of the objects that are subject to the rule. The value
|
|
2675
|
+
* must be a non-zero positive integer.</p>
|
|
2400
2676
|
*/
|
|
2401
2677
|
Days?: number;
|
|
2402
2678
|
/**
|
|
@@ -2421,7 +2697,8 @@ export interface LifecycleRuleAndOperator {
|
|
|
2421
2697
|
*/
|
|
2422
2698
|
Prefix?: string;
|
|
2423
2699
|
/**
|
|
2424
|
-
* <p>All of these tags must exist in the object's tag set in order for the rule to
|
|
2700
|
+
* <p>All of these tags must exist in the object's tag set in order for the rule to
|
|
2701
|
+
* apply.</p>
|
|
2425
2702
|
*/
|
|
2426
2703
|
Tags?: S3Tag[];
|
|
2427
2704
|
}
|
|
@@ -2466,7 +2743,8 @@ export interface NoncurrentVersionExpiration {
|
|
|
2466
2743
|
/**
|
|
2467
2744
|
* <p>Specifies the number of days an object is noncurrent before Amazon S3 can perform the
|
|
2468
2745
|
* 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
|
|
2469
|
-
* Amazon S3 Calculates When an Object Became Noncurrent</a> in the
|
|
2746
|
+
* Amazon S3 Calculates When an Object Became Noncurrent</a> in the
|
|
2747
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
2470
2748
|
*/
|
|
2471
2749
|
NoncurrentDays?: number;
|
|
2472
2750
|
}
|
|
@@ -2482,10 +2760,10 @@ export declare type TransitionStorageClass = "DEEP_ARCHIVE" | "GLACIER" | "INTEL
|
|
|
2482
2760
|
*/
|
|
2483
2761
|
export interface NoncurrentVersionTransition {
|
|
2484
2762
|
/**
|
|
2485
|
-
* <p>Specifies the number of days an object is noncurrent before Amazon S3 can perform the
|
|
2486
|
-
* For information about the noncurrent days calculations, see
|
|
2487
|
-
*
|
|
2488
|
-
*
|
|
2763
|
+
* <p>Specifies the number of days an object is noncurrent before Amazon S3 can perform the
|
|
2764
|
+
* 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
|
|
2765
|
+
* Amazon S3 Calculates How Long an Object Has Been Noncurrent</a> in the
|
|
2766
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
2489
2767
|
*/
|
|
2490
2768
|
NoncurrentDays?: number;
|
|
2491
2769
|
/**
|
|
@@ -2508,13 +2786,13 @@ export declare type ExpirationStatus = "Disabled" | "Enabled";
|
|
|
2508
2786
|
*/
|
|
2509
2787
|
export interface Transition {
|
|
2510
2788
|
/**
|
|
2511
|
-
* <p>Indicates when objects are transitioned to the specified storage class.
|
|
2512
|
-
*
|
|
2789
|
+
* <p>Indicates when objects are transitioned to the specified storage class. The date value
|
|
2790
|
+
* must be in ISO 8601 format. The time is always midnight UTC.</p>
|
|
2513
2791
|
*/
|
|
2514
2792
|
Date?: Date;
|
|
2515
2793
|
/**
|
|
2516
|
-
* <p>Indicates the number of days after creation when objects are transitioned to the
|
|
2517
|
-
* The value must be a positive integer.</p>
|
|
2794
|
+
* <p>Indicates the number of days after creation when objects are transitioned to the
|
|
2795
|
+
* specified storage class. The value must be a positive integer.</p>
|
|
2518
2796
|
*/
|
|
2519
2797
|
Days?: number;
|
|
2520
2798
|
/**
|
|
@@ -2533,8 +2811,8 @@ export declare namespace Transition {
|
|
|
2533
2811
|
*/
|
|
2534
2812
|
export interface LifecycleRule {
|
|
2535
2813
|
/**
|
|
2536
|
-
* <p>Specifies the expiration for the lifecycle of the object in the form of date, days and,
|
|
2537
|
-
* has a delete marker.</p>
|
|
2814
|
+
* <p>Specifies the expiration for the lifecycle of the object in the form of date, days and,
|
|
2815
|
+
* whether the object has a delete marker.</p>
|
|
2538
2816
|
*/
|
|
2539
2817
|
Expiration?: LifecycleExpiration;
|
|
2540
2818
|
/**
|
|
@@ -2546,7 +2824,8 @@ export interface LifecycleRule {
|
|
|
2546
2824
|
*/
|
|
2547
2825
|
Filter?: LifecycleRuleFilter;
|
|
2548
2826
|
/**
|
|
2549
|
-
* <p>If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not
|
|
2827
|
+
* <p>If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not
|
|
2828
|
+
* currently being applied.</p>
|
|
2550
2829
|
*/
|
|
2551
2830
|
Status: ExpirationStatus | string | undefined;
|
|
2552
2831
|
/**
|
|
@@ -2695,9 +2974,9 @@ export interface GetMultiRegionAccessPointRequest {
|
|
|
2695
2974
|
AccountId?: string;
|
|
2696
2975
|
/**
|
|
2697
2976
|
* <p>The name of the Multi-Region Access Point whose configuration information you want to receive. The name of
|
|
2698
|
-
*
|
|
2699
|
-
*
|
|
2700
|
-
*
|
|
2977
|
+
* the Multi-Region Access Point is different from the alias. For more information about the distinction between
|
|
2978
|
+
* 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
|
|
2979
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
2701
2980
|
*/
|
|
2702
2981
|
Name: string | undefined;
|
|
2703
2982
|
}
|
|
@@ -2743,9 +3022,8 @@ export interface MultiRegionAccessPointReport {
|
|
|
2743
3022
|
*/
|
|
2744
3023
|
Name?: string;
|
|
2745
3024
|
/**
|
|
2746
|
-
* <p>The alias for the Multi-Region Access Point. For more information about the distinction between the
|
|
2747
|
-
*
|
|
2748
|
-
* Multi-Region Access Points</a>.</p>
|
|
3025
|
+
* <p>The alias for the Multi-Region Access Point. For more information about the distinction between the name
|
|
3026
|
+
* 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>
|
|
2749
3027
|
*/
|
|
2750
3028
|
Alias?: string;
|
|
2751
3029
|
/**
|
|
@@ -2753,9 +3031,9 @@ export interface MultiRegionAccessPointReport {
|
|
|
2753
3031
|
*/
|
|
2754
3032
|
CreatedAt?: Date;
|
|
2755
3033
|
/**
|
|
2756
|
-
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3
|
|
2757
|
-
* You can enable the configuration options in any combination. For more information
|
|
2758
|
-
* 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>
|
|
3034
|
+
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3
|
|
3035
|
+
* account. You can enable the configuration options in any combination. For more information
|
|
3036
|
+
* 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>
|
|
2759
3037
|
* <p>This is not supported for Amazon S3 on Outposts.</p>
|
|
2760
3038
|
*/
|
|
2761
3039
|
PublicAccessBlock?: PublicAccessBlockConfiguration;
|
|
@@ -2763,10 +3041,10 @@ export interface MultiRegionAccessPointReport {
|
|
|
2763
3041
|
* <p>The current status of the Multi-Region Access Point.</p>
|
|
2764
3042
|
* <p>
|
|
2765
3043
|
* <code>CREATING</code> and <code>DELETING</code> are temporary states that exist while
|
|
2766
|
-
*
|
|
2767
|
-
*
|
|
2768
|
-
*
|
|
2769
|
-
*
|
|
3044
|
+
* the request is propogating and being completed. If a Multi-Region Access Point has a status of
|
|
3045
|
+
* <code>PARTIALLY_CREATED</code>, you can retry creation or send a request to delete the
|
|
3046
|
+
* Multi-Region Access Point. If a Multi-Region Access Point has a status of <code>PARTIALLY_DELETED</code>, you can retry a delete
|
|
3047
|
+
* request to finish the deletion of the Multi-Region Access Point.</p>
|
|
2770
3048
|
*/
|
|
2771
3049
|
Status?: MultiRegionAccessPointStatus | string;
|
|
2772
3050
|
/**
|
|
@@ -2799,9 +3077,8 @@ export interface GetMultiRegionAccessPointPolicyRequest {
|
|
|
2799
3077
|
AccountId?: string;
|
|
2800
3078
|
/**
|
|
2801
3079
|
* <p>Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more
|
|
2802
|
-
*
|
|
2803
|
-
*
|
|
2804
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
3080
|
+
* 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
|
|
3081
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
2805
3082
|
*/
|
|
2806
3083
|
Name: string | undefined;
|
|
2807
3084
|
}
|
|
@@ -2814,9 +3091,9 @@ export declare namespace GetMultiRegionAccessPointPolicyRequest {
|
|
|
2814
3091
|
/**
|
|
2815
3092
|
* <p>The last established access control policy for a Multi-Region Access Point.</p>
|
|
2816
3093
|
* <p>When you update the policy, the update is first listed as the proposed policy. After the
|
|
2817
|
-
*
|
|
2818
|
-
*
|
|
2819
|
-
*
|
|
3094
|
+
* update is finished and all Regions have been updated, the proposed policy is listed as the
|
|
3095
|
+
* established policy. If both policies have the same version number, the proposed policy is
|
|
3096
|
+
* the established policy.</p>
|
|
2820
3097
|
*/
|
|
2821
3098
|
export interface EstablishedMultiRegionAccessPointPolicy {
|
|
2822
3099
|
/**
|
|
@@ -2833,9 +3110,9 @@ export declare namespace EstablishedMultiRegionAccessPointPolicy {
|
|
|
2833
3110
|
/**
|
|
2834
3111
|
* <p>The proposed access control policy for the Multi-Region Access Point.</p>
|
|
2835
3112
|
* <p>When you update the policy, the update is first listed as the proposed policy. After the
|
|
2836
|
-
*
|
|
2837
|
-
*
|
|
2838
|
-
*
|
|
3113
|
+
* update is finished and all Regions have been updated, the proposed policy is listed as the
|
|
3114
|
+
* established policy. If both policies have the same version number, the proposed policy is
|
|
3115
|
+
* the established policy.</p>
|
|
2839
3116
|
*/
|
|
2840
3117
|
export interface ProposedMultiRegionAccessPointPolicy {
|
|
2841
3118
|
/**
|
|
@@ -2852,9 +3129,9 @@ export declare namespace ProposedMultiRegionAccessPointPolicy {
|
|
|
2852
3129
|
/**
|
|
2853
3130
|
* <p>The Multi-Region Access Point access control policy.</p>
|
|
2854
3131
|
* <p>When you update the policy, the update is first listed as the proposed policy. After the
|
|
2855
|
-
*
|
|
2856
|
-
*
|
|
2857
|
-
*
|
|
3132
|
+
* update is finished and all Regions have been updated, the proposed policy is listed as the
|
|
3133
|
+
* established policy. If both policies have the same version number, the proposed policy is
|
|
3134
|
+
* the established policy.</p>
|
|
2858
3135
|
*/
|
|
2859
3136
|
export interface MultiRegionAccessPointPolicyDocument {
|
|
2860
3137
|
/**
|
|
@@ -2891,9 +3168,8 @@ export interface GetMultiRegionAccessPointPolicyStatusRequest {
|
|
|
2891
3168
|
AccountId?: string;
|
|
2892
3169
|
/**
|
|
2893
3170
|
* <p>Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more
|
|
2894
|
-
*
|
|
2895
|
-
*
|
|
2896
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
3171
|
+
* 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
|
|
3172
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
2897
3173
|
*/
|
|
2898
3174
|
Name: string | undefined;
|
|
2899
3175
|
}
|
|
@@ -2905,10 +3181,8 @@ export declare namespace GetMultiRegionAccessPointPolicyStatusRequest {
|
|
|
2905
3181
|
}
|
|
2906
3182
|
export interface GetMultiRegionAccessPointPolicyStatusResult {
|
|
2907
3183
|
/**
|
|
2908
|
-
* <p>Indicates whether this access point policy is public. For more information about how Amazon S3
|
|
2909
|
-
* <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
|
|
2910
|
-
* <i>Amazon S3 User Guide</i>.
|
|
2911
|
-
* </p>
|
|
3184
|
+
* <p>Indicates whether this access point policy is public. For more information about how Amazon S3
|
|
3185
|
+
* 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>
|
|
2912
3186
|
*/
|
|
2913
3187
|
Established?: PolicyStatus;
|
|
2914
3188
|
}
|
|
@@ -2920,7 +3194,8 @@ export declare namespace GetMultiRegionAccessPointPolicyStatusResult {
|
|
|
2920
3194
|
}
|
|
2921
3195
|
export interface GetPublicAccessBlockOutput {
|
|
2922
3196
|
/**
|
|
2923
|
-
* <p>The <code>PublicAccessBlock</code> configuration currently in effect for this
|
|
3197
|
+
* <p>The <code>PublicAccessBlock</code> configuration currently in effect for this
|
|
3198
|
+
* Amazon Web Services account.</p>
|
|
2924
3199
|
*/
|
|
2925
3200
|
PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
|
|
2926
3201
|
}
|
|
@@ -2932,8 +3207,8 @@ export declare namespace GetPublicAccessBlockOutput {
|
|
|
2932
3207
|
}
|
|
2933
3208
|
export interface GetPublicAccessBlockRequest {
|
|
2934
3209
|
/**
|
|
2935
|
-
* <p>The account ID for the Amazon Web Services account whose <code>PublicAccessBlock</code> configuration
|
|
2936
|
-
* to retrieve.</p>
|
|
3210
|
+
* <p>The account ID for the Amazon Web Services account whose <code>PublicAccessBlock</code> configuration
|
|
3211
|
+
* you want to retrieve.</p>
|
|
2937
3212
|
*/
|
|
2938
3213
|
AccountId?: string;
|
|
2939
3214
|
}
|
|
@@ -2945,7 +3220,8 @@ export declare namespace GetPublicAccessBlockRequest {
|
|
|
2945
3220
|
}
|
|
2946
3221
|
/**
|
|
2947
3222
|
* <p>Amazon S3 throws this exception if you make a <code>GetPublicAccessBlock</code> request
|
|
2948
|
-
*
|
|
3223
|
+
* against an account that doesn't have a <code>PublicAccessBlockConfiguration</code>
|
|
3224
|
+
* set.</p>
|
|
2949
3225
|
*/
|
|
2950
3226
|
export interface NoSuchPublicAccessBlockConfiguration extends __SmithyException, $MetadataBearer {
|
|
2951
3227
|
name: "NoSuchPublicAccessBlockConfiguration";
|
|
@@ -2973,9 +3249,9 @@ export declare namespace GetStorageLensConfigurationRequest {
|
|
|
2973
3249
|
*/
|
|
2974
3250
|
export interface StorageLensAwsOrg {
|
|
2975
3251
|
/**
|
|
2976
|
-
* <p>A container for the Amazon Resource Name (ARN) of the Amazon Web Services organization.
|
|
2977
|
-
*
|
|
2978
|
-
*
|
|
3252
|
+
* <p>A container for the Amazon Resource Name (ARN) of the Amazon Web Services organization. This property
|
|
3253
|
+
* is read-only and follows the following format: <code>
|
|
3254
|
+
* arn:aws:organizations:<i>us-east-1</i>:<i>example-account-id</i>:organization/<i>o-ex2l495dck</i>
|
|
2979
3255
|
* </code>
|
|
2980
3256
|
* </p>
|
|
2981
3257
|
*/
|
|
@@ -2989,11 +3265,14 @@ export declare namespace StorageLensAwsOrg {
|
|
|
2989
3265
|
}
|
|
2990
3266
|
/**
|
|
2991
3267
|
* <p>A container for enabling Amazon CloudWatch publishing for S3 Storage Lens metrics.</p>
|
|
2992
|
-
* <p>For more information about publishing S3 Storage Lens metrics to CloudWatch, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_view_metrics_cloudwatch.html">Monitor
|
|
3268
|
+
* <p>For more information about publishing S3 Storage Lens metrics to CloudWatch, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_view_metrics_cloudwatch.html">Monitor
|
|
3269
|
+
* S3 Storage Lens metrics in CloudWatch</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2993
3270
|
*/
|
|
2994
3271
|
export interface CloudWatchMetrics {
|
|
2995
3272
|
/**
|
|
2996
|
-
* <p>A container that indicates whether CloudWatch publishing for S3 Storage Lens metrics is enabled. A
|
|
3273
|
+
* <p>A container that indicates whether CloudWatch publishing for S3 Storage Lens metrics is enabled. A
|
|
3274
|
+
* value of <code>true</code> indicates that CloudWatch publishing for S3 Storage Lens metrics is
|
|
3275
|
+
* enabled.</p>
|
|
2997
3276
|
*/
|
|
2998
3277
|
IsEnabled: boolean | undefined;
|
|
2999
3278
|
}
|
|
@@ -3008,9 +3287,9 @@ export declare namespace CloudWatchMetrics {
|
|
|
3008
3287
|
*/
|
|
3009
3288
|
export interface SSEKMS {
|
|
3010
3289
|
/**
|
|
3011
|
-
* <p>A container for the ARN of the SSE-KMS encryption.
|
|
3012
|
-
*
|
|
3013
|
-
*
|
|
3290
|
+
* <p>A container for the ARN of the SSE-KMS encryption. This property is read-only and
|
|
3291
|
+
* follows the following format: <code>
|
|
3292
|
+
* arn:aws:kms:<i>us-east-1</i>:<i>example-account-id</i>:key/<i>example-9a73-4afc-8d29-8f5900cef44e</i>
|
|
3014
3293
|
* </code>
|
|
3015
3294
|
* </p>
|
|
3016
3295
|
*/
|
|
@@ -3055,7 +3334,8 @@ export declare namespace StorageLensDataExportEncryption {
|
|
|
3055
3334
|
export declare type Format = "CSV" | "Parquet";
|
|
3056
3335
|
export declare type OutputSchemaVersion = "V_1";
|
|
3057
3336
|
/**
|
|
3058
|
-
* <p>A container for the bucket where the Amazon S3 Storage Lens metrics export files are
|
|
3337
|
+
* <p>A container for the bucket where the Amazon S3 Storage Lens metrics export files are
|
|
3338
|
+
* located.</p>
|
|
3059
3339
|
*/
|
|
3060
3340
|
export interface S3BucketDestination {
|
|
3061
3341
|
/**
|
|
@@ -3071,9 +3351,9 @@ export interface S3BucketDestination {
|
|
|
3071
3351
|
*/
|
|
3072
3352
|
AccountId?: string;
|
|
3073
3353
|
/**
|
|
3074
|
-
* <p>The Amazon Resource Name (ARN) of the bucket.
|
|
3075
|
-
*
|
|
3076
|
-
*
|
|
3354
|
+
* <p>The Amazon Resource Name (ARN) of the bucket. This property is read-only and follows the
|
|
3355
|
+
* following format: <code>
|
|
3356
|
+
* arn:aws:s3:<i>us-east-1</i>:<i>example-account-id</i>:bucket/<i>your-destination-bucket-name</i>
|
|
3077
3357
|
* </code>
|
|
3078
3358
|
* </p>
|
|
3079
3359
|
*/
|
|
@@ -3101,7 +3381,8 @@ export interface StorageLensDataExport {
|
|
|
3101
3381
|
/**
|
|
3102
3382
|
* <p>A container for the bucket where the S3 Storage Lens metrics export will be located.</p>
|
|
3103
3383
|
* <note>
|
|
3104
|
-
* <p>This bucket must be located in the same Region as the storage lens configuration.
|
|
3384
|
+
* <p>This bucket must be located in the same Region as the storage lens configuration.
|
|
3385
|
+
* </p>
|
|
3105
3386
|
* </note>
|
|
3106
3387
|
*/
|
|
3107
3388
|
S3BucketDestination?: S3BucketDestination;
|
|
@@ -3178,8 +3459,8 @@ export interface StorageLensConfiguration {
|
|
|
3178
3459
|
*/
|
|
3179
3460
|
Exclude?: _Exclude;
|
|
3180
3461
|
/**
|
|
3181
|
-
* <p>A container to specify the properties of your S3 Storage Lens metrics export including, the
|
|
3182
|
-
* format.</p>
|
|
3462
|
+
* <p>A container to specify the properties of your S3 Storage Lens metrics export including, the
|
|
3463
|
+
* destination, schema and format.</p>
|
|
3183
3464
|
*/
|
|
3184
3465
|
DataExport?: StorageLensDataExport;
|
|
3185
3466
|
/**
|
|
@@ -3191,9 +3472,9 @@ export interface StorageLensConfiguration {
|
|
|
3191
3472
|
*/
|
|
3192
3473
|
AwsOrg?: StorageLensAwsOrg;
|
|
3193
3474
|
/**
|
|
3194
|
-
* <p>The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is
|
|
3195
|
-
*
|
|
3196
|
-
*
|
|
3475
|
+
* <p>The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only
|
|
3476
|
+
* and follows the following format: <code>
|
|
3477
|
+
* arn:aws:s3:<i>us-east-1</i>:<i>example-account-id</i>:storage-lens/<i>your-dashboard-name</i>
|
|
3197
3478
|
* </code>
|
|
3198
3479
|
* </p>
|
|
3199
3480
|
*/
|
|
@@ -3276,14 +3557,16 @@ export interface ListAccessPointsRequest {
|
|
|
3276
3557
|
*/
|
|
3277
3558
|
Bucket?: string;
|
|
3278
3559
|
/**
|
|
3279
|
-
* <p>A continuation token. If a previous call to <code>ListAccessPoints</code> returned a
|
|
3560
|
+
* <p>A continuation token. If a previous call to <code>ListAccessPoints</code> returned a
|
|
3561
|
+
* continuation token in the <code>NextToken</code> field, then providing that value here
|
|
3562
|
+
* causes Amazon S3 to retrieve the next page of results.</p>
|
|
3280
3563
|
*/
|
|
3281
3564
|
NextToken?: string;
|
|
3282
3565
|
/**
|
|
3283
3566
|
* <p>The maximum number of access points that you want to include in the list. If the specified
|
|
3284
|
-
* bucket has more than this number of access points, then the response will include a
|
|
3285
|
-
*
|
|
3286
|
-
*
|
|
3567
|
+
* bucket has more than this number of access points, then the response will include a continuation
|
|
3568
|
+
* token in the <code>NextToken</code> field that you can use to retrieve the next page of
|
|
3569
|
+
* access points.</p>
|
|
3287
3570
|
*/
|
|
3288
3571
|
MaxResults?: number;
|
|
3289
3572
|
}
|
|
@@ -3295,14 +3578,14 @@ export declare namespace ListAccessPointsRequest {
|
|
|
3295
3578
|
}
|
|
3296
3579
|
export interface ListAccessPointsResult {
|
|
3297
3580
|
/**
|
|
3298
|
-
* <p>Contains identification and configuration information for one or more access points
|
|
3299
|
-
*
|
|
3581
|
+
* <p>Contains identification and configuration information for one or more access points associated
|
|
3582
|
+
* with the specified bucket.</p>
|
|
3300
3583
|
*/
|
|
3301
3584
|
AccessPointList?: AccessPoint[];
|
|
3302
3585
|
/**
|
|
3303
|
-
* <p>If the specified bucket has more access points than can be returned in one call to this
|
|
3304
|
-
*
|
|
3305
|
-
*
|
|
3586
|
+
* <p>If the specified bucket has more access points than can be returned in one call to this API,
|
|
3587
|
+
* this field contains a continuation token that you can provide in subsequent calls to this
|
|
3588
|
+
* API to retrieve additional access points.</p>
|
|
3306
3589
|
*/
|
|
3307
3590
|
NextToken?: string;
|
|
3308
3591
|
}
|
|
@@ -3318,13 +3601,16 @@ export interface ListAccessPointsForObjectLambdaRequest {
|
|
|
3318
3601
|
*/
|
|
3319
3602
|
AccountId?: string;
|
|
3320
3603
|
/**
|
|
3321
|
-
* <p>If the list has more access points than can be returned in one call to this
|
|
3322
|
-
*
|
|
3323
|
-
*
|
|
3604
|
+
* <p>If the list has more access points than can be returned in one call to this API, this field
|
|
3605
|
+
* contains a continuation token that you can provide in subsequent calls to this API to
|
|
3606
|
+
* retrieve additional access points.</p>
|
|
3324
3607
|
*/
|
|
3325
3608
|
NextToken?: string;
|
|
3326
3609
|
/**
|
|
3327
|
-
* <p>The maximum number of access points that you want to include in the list.
|
|
3610
|
+
* <p>The maximum number of access points that you want to include in the list. The response may
|
|
3611
|
+
* contain fewer access points but will never contain more. If there are more than this number of
|
|
3612
|
+
* access points, then the response will include a continuation token in the <code>NextToken</code>
|
|
3613
|
+
* field that you can use to retrieve the next page of access points.</p>
|
|
3328
3614
|
*/
|
|
3329
3615
|
MaxResults?: number;
|
|
3330
3616
|
}
|
|
@@ -3335,7 +3621,8 @@ export declare namespace ListAccessPointsForObjectLambdaRequest {
|
|
|
3335
3621
|
const filterSensitiveLog: (obj: ListAccessPointsForObjectLambdaRequest) => any;
|
|
3336
3622
|
}
|
|
3337
3623
|
/**
|
|
3338
|
-
* <p>An access point with an attached Lambda function used to access transformed data from an Amazon S3
|
|
3624
|
+
* <p>An access point with an attached Lambda function used to access transformed data from an Amazon S3
|
|
3625
|
+
* bucket.</p>
|
|
3339
3626
|
*/
|
|
3340
3627
|
export interface ObjectLambdaAccessPoint {
|
|
3341
3628
|
/**
|
|
@@ -3359,9 +3646,9 @@ export interface ListAccessPointsForObjectLambdaResult {
|
|
|
3359
3646
|
*/
|
|
3360
3647
|
ObjectLambdaAccessPointList?: ObjectLambdaAccessPoint[];
|
|
3361
3648
|
/**
|
|
3362
|
-
* <p>If the list has more access points than can be returned in one call to this
|
|
3363
|
-
*
|
|
3364
|
-
*
|
|
3649
|
+
* <p>If the list has more access points than can be returned in one call to this API, this field
|
|
3650
|
+
* contains a continuation token that you can provide in subsequent calls to this API to
|
|
3651
|
+
* retrieve additional access points.</p>
|
|
3365
3652
|
*/
|
|
3366
3653
|
NextToken?: string;
|
|
3367
3654
|
}
|
|
@@ -3393,15 +3680,21 @@ export interface ListJobsRequest {
|
|
|
3393
3680
|
*/
|
|
3394
3681
|
AccountId?: string;
|
|
3395
3682
|
/**
|
|
3396
|
-
* <p>The <code>List Jobs</code> request returns jobs that match the statuses listed in this
|
|
3683
|
+
* <p>The <code>List Jobs</code> request returns jobs that match the statuses listed in this
|
|
3684
|
+
* element.</p>
|
|
3397
3685
|
*/
|
|
3398
3686
|
JobStatuses?: (JobStatus | string)[];
|
|
3399
3687
|
/**
|
|
3400
|
-
* <p>A pagination token to request the next page of results. Use the token that Amazon S3 returned
|
|
3688
|
+
* <p>A pagination token to request the next page of results. Use the token that Amazon S3 returned
|
|
3689
|
+
* in the <code>NextToken</code> element of the <code>ListJobsResult</code> from the previous
|
|
3690
|
+
* <code>List Jobs</code> request.</p>
|
|
3401
3691
|
*/
|
|
3402
3692
|
NextToken?: string;
|
|
3403
3693
|
/**
|
|
3404
|
-
* <p>The maximum number of jobs that Amazon S3 will include in the <code>List Jobs</code>
|
|
3694
|
+
* <p>The maximum number of jobs that Amazon S3 will include in the <code>List Jobs</code>
|
|
3695
|
+
* response. If there are more jobs than this number, the response will include a pagination
|
|
3696
|
+
* token in the <code>NextToken</code> field to enable you to retrieve the next page of
|
|
3697
|
+
* results.</p>
|
|
3405
3698
|
*/
|
|
3406
3699
|
MaxResults?: number;
|
|
3407
3700
|
}
|
|
@@ -3419,10 +3712,12 @@ export declare enum OperationName {
|
|
|
3419
3712
|
S3PutObjectCopy = "S3PutObjectCopy",
|
|
3420
3713
|
S3PutObjectLegalHold = "S3PutObjectLegalHold",
|
|
3421
3714
|
S3PutObjectRetention = "S3PutObjectRetention",
|
|
3422
|
-
S3PutObjectTagging = "S3PutObjectTagging"
|
|
3715
|
+
S3PutObjectTagging = "S3PutObjectTagging",
|
|
3716
|
+
S3ReplicateObject = "S3ReplicateObject"
|
|
3423
3717
|
}
|
|
3424
3718
|
/**
|
|
3425
|
-
* <p>Contains the configuration and status information for a single job retrieved as part of
|
|
3719
|
+
* <p>Contains the configuration and status information for a single job retrieved as part of
|
|
3720
|
+
* a job list.</p>
|
|
3426
3721
|
*/
|
|
3427
3722
|
export interface JobListDescriptor {
|
|
3428
3723
|
/**
|
|
@@ -3430,11 +3725,13 @@ export interface JobListDescriptor {
|
|
|
3430
3725
|
*/
|
|
3431
3726
|
JobId?: string;
|
|
3432
3727
|
/**
|
|
3433
|
-
* <p>The user-specified description that was included in the specified job's <code>Create
|
|
3728
|
+
* <p>The user-specified description that was included in the specified job's <code>Create
|
|
3729
|
+
* Job</code> request.</p>
|
|
3434
3730
|
*/
|
|
3435
3731
|
Description?: string;
|
|
3436
3732
|
/**
|
|
3437
|
-
* <p>The operation that the specified job is configured to run on every object listed in the
|
|
3733
|
+
* <p>The operation that the specified job is configured to run on every object listed in the
|
|
3734
|
+
* manifest.</p>
|
|
3438
3735
|
*/
|
|
3439
3736
|
Operation?: OperationName | string;
|
|
3440
3737
|
/**
|
|
@@ -3450,7 +3747,8 @@ export interface JobListDescriptor {
|
|
|
3450
3747
|
*/
|
|
3451
3748
|
CreationTime?: Date;
|
|
3452
3749
|
/**
|
|
3453
|
-
* <p>A timestamp indicating when the specified job terminated. A job's termination date is
|
|
3750
|
+
* <p>A timestamp indicating when the specified job terminated. A job's termination date is
|
|
3751
|
+
* the date and time when it succeeded, failed, or was canceled.</p>
|
|
3454
3752
|
*/
|
|
3455
3753
|
TerminationDate?: Date;
|
|
3456
3754
|
/**
|
|
@@ -3467,8 +3765,9 @@ export declare namespace JobListDescriptor {
|
|
|
3467
3765
|
}
|
|
3468
3766
|
export interface ListJobsResult {
|
|
3469
3767
|
/**
|
|
3470
|
-
* <p>If the <code>List Jobs</code> request produced more than the maximum number of results,
|
|
3471
|
-
*
|
|
3768
|
+
* <p>If the <code>List Jobs</code> request produced more than the maximum number of results,
|
|
3769
|
+
* you can pass this value into a subsequent <code>List Jobs</code> request in order to
|
|
3770
|
+
* retrieve the next page of results.</p>
|
|
3472
3771
|
*/
|
|
3473
3772
|
NextToken?: string;
|
|
3474
3773
|
/**
|
|
@@ -3509,8 +3808,8 @@ export interface ListMultiRegionAccessPointsResult {
|
|
|
3509
3808
|
AccessPoints?: MultiRegionAccessPointReport[];
|
|
3510
3809
|
/**
|
|
3511
3810
|
* <p>If the specified bucket has more Multi-Region Access Points than can be returned in one call to this
|
|
3512
|
-
*
|
|
3513
|
-
*
|
|
3811
|
+
* action, this field contains a continuation token. You can use this token tin subsequent
|
|
3812
|
+
* calls to this action to retrieve additional Multi-Region Access Points.</p>
|
|
3514
3813
|
*/
|
|
3515
3814
|
NextToken?: string;
|
|
3516
3815
|
}
|
|
@@ -3585,10 +3884,10 @@ export interface ListRegionalBucketsResult {
|
|
|
3585
3884
|
RegionalBucketList?: RegionalBucket[];
|
|
3586
3885
|
/**
|
|
3587
3886
|
* <p>
|
|
3588
|
-
* <code>NextToken</code> is sent when <code>isTruncated</code> is true, which means
|
|
3589
|
-
*
|
|
3590
|
-
*
|
|
3591
|
-
*
|
|
3887
|
+
* <code>NextToken</code> is sent when <code>isTruncated</code> is true, which means there
|
|
3888
|
+
* are more buckets that can be listed. The next list requests to Amazon S3 can be continued with
|
|
3889
|
+
* this <code>NextToken</code>. <code>NextToken</code> is obfuscated and is not a real
|
|
3890
|
+
* key.</p>
|
|
3592
3891
|
*/
|
|
3593
3892
|
NextToken?: string;
|
|
3594
3893
|
}
|
|
@@ -3634,7 +3933,8 @@ export interface ListStorageLensConfigurationEntry {
|
|
|
3634
3933
|
*/
|
|
3635
3934
|
HomeRegion: string | undefined;
|
|
3636
3935
|
/**
|
|
3637
|
-
* <p>A container for whether the S3 Storage Lens configuration is enabled. This property is
|
|
3936
|
+
* <p>A container for whether the S3 Storage Lens configuration is enabled. This property is
|
|
3937
|
+
* required.</p>
|
|
3638
3938
|
*/
|
|
3639
3939
|
IsEnabled?: boolean;
|
|
3640
3940
|
}
|
|
@@ -3694,7 +3994,9 @@ export interface PutAccessPointPolicyRequest {
|
|
|
3694
3994
|
*/
|
|
3695
3995
|
Name: string | undefined;
|
|
3696
3996
|
/**
|
|
3697
|
-
* <p>The policy that you want to apply to the specified access point. For more information about access point
|
|
3997
|
+
* <p>The policy that you want to apply to the specified access point. For more information about access point
|
|
3998
|
+
* policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">Managing data access with Amazon S3
|
|
3999
|
+
* access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3698
4000
|
*/
|
|
3699
4001
|
Policy: string | undefined;
|
|
3700
4002
|
}
|
|
@@ -3771,7 +4073,8 @@ export interface PutBucketPolicyRequest {
|
|
|
3771
4073
|
*/
|
|
3772
4074
|
Bucket: string | undefined;
|
|
3773
4075
|
/**
|
|
3774
|
-
* <p>Set this parameter to true to confirm that you want to remove your permissions to change
|
|
4076
|
+
* <p>Set this parameter to true to confirm that you want to remove your permissions to change
|
|
4077
|
+
* this bucket policy in the future.</p>
|
|
3775
4078
|
* <note>
|
|
3776
4079
|
* <p>This is not supported by Amazon S3 on Outposts buckets.</p>
|
|
3777
4080
|
* </note>
|
|
@@ -3868,7 +4171,7 @@ export interface PutMultiRegionAccessPointPolicyRequest {
|
|
|
3868
4171
|
AccountId?: string;
|
|
3869
4172
|
/**
|
|
3870
4173
|
* <p>An idempotency token used to identify the request and guarantee that requests are
|
|
3871
|
-
*
|
|
4174
|
+
* unique.</p>
|
|
3872
4175
|
*/
|
|
3873
4176
|
ClientToken?: string;
|
|
3874
4177
|
/**
|
|
@@ -3884,8 +4187,8 @@ export declare namespace PutMultiRegionAccessPointPolicyRequest {
|
|
|
3884
4187
|
}
|
|
3885
4188
|
export interface PutMultiRegionAccessPointPolicyResult {
|
|
3886
4189
|
/**
|
|
3887
|
-
* <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
|
|
3888
|
-
*
|
|
4190
|
+
* <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
|
|
4191
|
+
* requests.</p>
|
|
3889
4192
|
*/
|
|
3890
4193
|
RequestTokenARN?: string;
|
|
3891
4194
|
}
|
|
@@ -3897,12 +4200,13 @@ export declare namespace PutMultiRegionAccessPointPolicyResult {
|
|
|
3897
4200
|
}
|
|
3898
4201
|
export interface PutPublicAccessBlockRequest {
|
|
3899
4202
|
/**
|
|
3900
|
-
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to the specified
|
|
4203
|
+
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to the specified
|
|
4204
|
+
* Amazon Web Services account.</p>
|
|
3901
4205
|
*/
|
|
3902
4206
|
PublicAccessBlockConfiguration: PublicAccessBlockConfiguration | undefined;
|
|
3903
4207
|
/**
|
|
3904
|
-
* <p>The account ID for the Amazon Web Services account whose <code>PublicAccessBlock</code> configuration
|
|
3905
|
-
* to set.</p>
|
|
4208
|
+
* <p>The account ID for the Amazon Web Services account whose <code>PublicAccessBlock</code> configuration
|
|
4209
|
+
* you want to set.</p>
|
|
3906
4210
|
*/
|
|
3907
4211
|
AccountId?: string;
|
|
3908
4212
|
}
|
|
@@ -4032,7 +4336,8 @@ export interface UpdateJobStatusRequest {
|
|
|
4032
4336
|
*/
|
|
4033
4337
|
RequestedJobStatus: RequestedJobStatus | string | undefined;
|
|
4034
4338
|
/**
|
|
4035
|
-
* <p>A description of the reason why you want to change the specified job's status. This
|
|
4339
|
+
* <p>A description of the reason why you want to change the specified job's status. This
|
|
4340
|
+
* field can be any string up to the maximum length.</p>
|
|
4036
4341
|
*/
|
|
4037
4342
|
StatusUpdateReason?: string;
|
|
4038
4343
|
}
|