@aws-sdk/client-s3 3.303.0 → 3.304.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +31 -2
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +29 -0
- package/dist-types/S3.d.ts +751 -662
- package/dist-types/commands/AbortMultipartUploadCommand.d.ts +2 -2
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +22 -14
- package/dist-types/commands/CopyObjectCommand.d.ts +53 -30
- package/dist-types/commands/CreateBucketCommand.d.ts +22 -14
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +74 -48
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +7 -5
- package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +1 -2
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +5 -5
- package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +4 -3
- package/dist-types/commands/DeleteObjectCommand.d.ts +11 -11
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +2 -4
- package/dist-types/commands/DeleteObjectsCommand.d.ts +13 -14
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +2 -2
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +5 -4
- package/dist-types/commands/GetBucketAclCommand.d.ts +9 -7
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +5 -4
- package/dist-types/commands/GetBucketCorsCommand.d.ts +1 -0
- package/dist-types/commands/GetBucketEncryptionCommand.d.ts +7 -7
- package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +4 -4
- package/dist-types/commands/GetBucketLocationCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +5 -6
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +3 -2
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +4 -3
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +1 -0
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +2 -1
- package/dist-types/commands/GetBucketWebsiteCommand.d.ts +1 -2
- package/dist-types/commands/GetObjectAclCommand.d.ts +5 -4
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +23 -28
- package/dist-types/commands/GetObjectCommand.d.ts +20 -18
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +2 -1
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +5 -5
- package/dist-types/commands/GetObjectTorrentCommand.d.ts +1 -1
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +1 -1
- package/dist-types/commands/HeadBucketCommand.d.ts +15 -9
- package/dist-types/commands/HeadObjectCommand.d.ts +20 -19
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +4 -4
- package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +1 -2
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +5 -5
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +6 -7
- package/dist-types/commands/ListBucketsCommand.d.ts +3 -1
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +2 -2
- package/dist-types/commands/ListObjectVersionsCommand.d.ts +3 -6
- package/dist-types/commands/ListObjectsV2Command.d.ts +11 -12
- package/dist-types/commands/ListPartsCommand.d.ts +3 -4
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +4 -3
- package/dist-types/commands/PutBucketAclCommand.d.ts +15 -12
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +4 -4
- package/dist-types/commands/PutBucketCorsCommand.d.ts +2 -2
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +16 -14
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +7 -8
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +20 -8
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +8 -8
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +11 -7
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +4 -4
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +12 -12
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +4 -2
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +2 -1
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +12 -11
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +12 -12
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +4 -4
- package/dist-types/commands/PutObjectAclCommand.d.ts +17 -13
- package/dist-types/commands/PutObjectCommand.d.ts +44 -53
- package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +7 -8
- package/dist-types/commands/PutObjectRetentionCommand.d.ts +3 -4
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +4 -3
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +1 -1
- package/dist-types/commands/RestoreObjectCommand.d.ts +49 -68
- package/dist-types/commands/SelectObjectContentCommand.d.ts +13 -17
- package/dist-types/commands/UploadPartCommand.d.ts +23 -16
- package/dist-types/commands/UploadPartCopyCommand.d.ts +7 -5
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +32 -21
- package/dist-types/models/models_0.d.ts +460 -362
- package/dist-types/models/models_1.d.ts +81 -76
- package/dist-types/ts3.4/models/models_0.d.ts +30 -28
- package/package.json +1 -1
|
@@ -43,14 +43,15 @@ export interface UploadPartCommandOutput extends UploadPartOutput, __MetadataBea
|
|
|
43
43
|
* identifies a part and also defines its position within the object being created. If you
|
|
44
44
|
* upload a new part using the same part number that was used with a previous part, the
|
|
45
45
|
* previously uploaded part is overwritten.</p>
|
|
46
|
-
* <p>For information about maximum and minimum part sizes and other multipart upload
|
|
46
|
+
* <p>For information about maximum and minimum part sizes and other multipart upload
|
|
47
|
+
* specifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html">Multipart upload limits</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
47
48
|
* <p>To ensure that data is not corrupted when traversing the network, specify the
|
|
48
49
|
* <code>Content-MD5</code> header in the upload part request. Amazon S3 checks the part data
|
|
49
50
|
* against the provided MD5 value. If they do not match, Amazon S3 returns an error. </p>
|
|
50
51
|
* <p>If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the
|
|
51
52
|
* <code>x-amz-content-sha256</code> header as a checksum instead of
|
|
52
|
-
* <code>Content-MD5</code>. For more information see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html">Authenticating
|
|
53
|
-
* 4)</a>. </p>
|
|
53
|
+
* <code>Content-MD5</code>. For more information see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html">Authenticating
|
|
54
|
+
* Requests: Using the Authorization Header (Amazon Web Services Signature Version 4)</a>. </p>
|
|
54
55
|
* <p>
|
|
55
56
|
* <b>Note:</b> After you initiate multipart upload and upload
|
|
56
57
|
* one or more parts, you must either complete or abort multipart upload in order to stop
|
|
@@ -60,23 +61,29 @@ export interface UploadPartCommandOutput extends UploadPartOutput, __MetadataBea
|
|
|
60
61
|
* <p>For more information on multipart uploads, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a> in the
|
|
61
62
|
* <i>Amazon S3 User Guide </i>.</p>
|
|
62
63
|
* <p>For information on the permissions required to use the multipart upload API, go to
|
|
63
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart
|
|
64
|
-
* Permissions</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
65
|
-
* <p>
|
|
66
|
-
* writes it to disks in its data centers and decrypts it
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
64
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart
|
|
65
|
+
* Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
66
|
+
* <p>Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it
|
|
67
|
+
* writes it to disks in its data centers and decrypts it when you access it. You have three
|
|
68
|
+
* mutually exclusive options to protect data using server-side encryption in Amazon S3, depending
|
|
69
|
+
* on how you choose to manage the encryption keys. Specifically, the encryption key options
|
|
70
|
+
* are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys
|
|
71
|
+
* (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by
|
|
72
|
+
* default. You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption
|
|
73
|
+
* with other key options. The option you use depends on whether you want to use KMS keys
|
|
74
|
+
* (SSE-KMS) or provide your own encryption key (SSE-C). If you choose to provide your own
|
|
75
|
+
* encryption key, the request headers you provide in the request must match the headers you
|
|
76
|
+
* used in the request to initiate the upload by using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>.
|
|
77
|
+
* For more information, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side
|
|
78
|
+
* Encryption</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
72
79
|
* <p>Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are
|
|
73
|
-
* using a customer-provided encryption key, you don't need to specify the encryption
|
|
80
|
+
* using a customer-provided encryption key (SSE-C), you don't need to specify the encryption
|
|
74
81
|
* parameters in each UploadPart request. Instead, you only need to specify the server-side
|
|
75
82
|
* encryption parameters in the initial Initiate Multipart request. For more information, see
|
|
76
83
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>.</p>
|
|
77
|
-
* <p>If you requested server-side encryption using a customer-provided encryption key
|
|
78
|
-
* initiate multipart upload request, you must provide identical encryption
|
|
79
|
-
* each part upload using the following headers.</p>
|
|
84
|
+
* <p>If you requested server-side encryption using a customer-provided encryption key (SSE-C)
|
|
85
|
+
* in your initiate multipart upload request, you must provide identical encryption
|
|
86
|
+
* information in each part upload using the following headers.</p>
|
|
80
87
|
* <ul>
|
|
81
88
|
* <li>
|
|
82
89
|
* <p>x-amz-server-side-encryption-customer-algorithm</p>
|
|
@@ -23,7 +23,8 @@ export interface UploadPartCopyCommandOutput extends UploadPartCopyOutput, __Met
|
|
|
23
23
|
* data source by adding the request header <code>x-amz-copy-source</code> in your request and
|
|
24
24
|
* a byte range by adding the request header <code>x-amz-copy-source-range</code> in your
|
|
25
25
|
* request. </p>
|
|
26
|
-
* <p>For information about maximum and minimum part sizes and other multipart upload
|
|
26
|
+
* <p>For information about maximum and minimum part sizes and other multipart upload
|
|
27
|
+
* specifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html">Multipart upload limits</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
27
28
|
* <note>
|
|
28
29
|
* <p>Instead of using an existing object as part data, you might use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>
|
|
29
30
|
* action and provide data in your request.</p>
|
|
@@ -35,13 +36,14 @@ export interface UploadPartCopyCommandOutput extends UploadPartCopyOutput, __Met
|
|
|
35
36
|
* following:</p>
|
|
36
37
|
* <ul>
|
|
37
38
|
* <li>
|
|
38
|
-
* <p>For conceptual information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading
|
|
39
|
-
* Upload</a> in the
|
|
39
|
+
* <p>For conceptual information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading
|
|
40
|
+
* Objects Using Multipart Upload</a> in the
|
|
41
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
40
42
|
* </li>
|
|
41
43
|
* <li>
|
|
42
44
|
* <p>For information about permissions required to use the multipart upload API, see
|
|
43
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload
|
|
44
|
-
*
|
|
45
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and Permissions</a> in the
|
|
46
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
45
47
|
* </li>
|
|
46
48
|
* <li>
|
|
47
49
|
* <p>For information about copying objects using a single atomic action vs. a multipart
|
|
@@ -29,29 +29,40 @@ export interface WriteGetObjectResponseCommandOutput extends __MetadataBearer {
|
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
31
31
|
* @public
|
|
32
|
-
* <p>Passes transformed
|
|
33
|
-
*
|
|
34
|
-
* Object Lambda access points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html">Transforming objects with
|
|
32
|
+
* <p>Passes transformed objects to a <code>GetObject</code> operation when using Object Lambda access points. For
|
|
33
|
+
* information about Object Lambda access points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html">Transforming objects with
|
|
35
34
|
* Object Lambda access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
36
35
|
* <p>This operation supports metadata that can be returned by <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>, in addition to
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
* <p>You can include any number of metadata headers. When including a metadata header, it
|
|
45
|
-
* prefaced with <code>x-amz-meta</code>. For example,
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
* <p>Example
|
|
53
|
-
*
|
|
54
|
-
*
|
|
36
|
+
* <code>RequestRoute</code>, <code>RequestToken</code>, <code>StatusCode</code>,
|
|
37
|
+
* <code>ErrorCode</code>, and <code>ErrorMessage</code>. The <code>GetObject</code>
|
|
38
|
+
* response metadata is supported so that the <code>WriteGetObjectResponse</code> caller,
|
|
39
|
+
* typically an Lambda function, can provide the same metadata when it internally invokes
|
|
40
|
+
* <code>GetObject</code>. When <code>WriteGetObjectResponse</code> is called by a
|
|
41
|
+
* customer-owned Lambda function, the metadata returned to the end user
|
|
42
|
+
* <code>GetObject</code> call might differ from what Amazon S3 would normally return.</p>
|
|
43
|
+
* <p>You can include any number of metadata headers. When including a metadata header, it
|
|
44
|
+
* should be prefaced with <code>x-amz-meta</code>. For example,
|
|
45
|
+
* <code>x-amz-meta-my-custom-header: MyCustomValue</code>. The primary use case for this
|
|
46
|
+
* is to forward <code>GetObject</code> metadata.</p>
|
|
47
|
+
* <p>Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to
|
|
48
|
+
* detect and redact personally identifiable information (PII) and decompress S3 objects.
|
|
49
|
+
* These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and
|
|
50
|
+
* can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.</p>
|
|
51
|
+
* <p>Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a
|
|
52
|
+
* natural language processing (NLP) service using machine learning to find insights and
|
|
53
|
+
* relationships in text. It automatically detects personally identifiable information (PII)
|
|
54
|
+
* such as names, addresses, dates, credit card numbers, and social security numbers from
|
|
55
|
+
* documents in your Amazon S3 bucket. </p>
|
|
56
|
+
* <p>Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural
|
|
57
|
+
* language processing (NLP) service using machine learning to find insights and relationships
|
|
58
|
+
* in text. It automatically redacts personally identifiable information (PII) such as names,
|
|
59
|
+
* addresses, dates, credit card numbers, and social security numbers from documents in your
|
|
60
|
+
* Amazon S3 bucket. </p>
|
|
61
|
+
* <p>Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is
|
|
62
|
+
* equipped to decompress objects stored in S3 in one of six compressed file formats including
|
|
63
|
+
* bzip2, gzip, snappy, zlib, zstandard and ZIP. </p>
|
|
64
|
+
* <p>For information on how to view and use these functions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-examples.html">Using Amazon Web Services built Lambda
|
|
65
|
+
* functions</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
55
66
|
* @example
|
|
56
67
|
* Use a bare-bones client and the command you need to make an API call.
|
|
57
68
|
* ```javascript
|