@aws-sdk/client-s3 3.844.0 → 3.845.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/README.md +40 -0
- package/dist-cjs/index.js +594 -121
- package/dist-es/S3.js +10 -0
- package/dist-es/commands/CreateBucketMetadataConfigurationCommand.js +31 -0
- package/dist-es/commands/DeleteBucketMetadataConfigurationCommand.js +26 -0
- package/dist-es/commands/GetBucketMetadataConfigurationCommand.js +28 -0
- package/dist-es/commands/ListPartsCommand.js +1 -1
- package/dist-es/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.js +31 -0
- package/dist-es/commands/UpdateBucketMetadataJournalTableConfigurationCommand.js +31 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +16 -24
- package/dist-es/models/models_1.js +24 -0
- package/dist-es/protocols/Aws_restXml.js +325 -3
- package/dist-types/S3.d.ts +35 -0
- package/dist-types/S3Client.d.ts +7 -2
- package/dist-types/commands/AbortMultipartUploadCommand.d.ts +17 -22
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +46 -57
- package/dist-types/commands/CopyObjectCommand.d.ts +95 -106
- package/dist-types/commands/CreateBucketCommand.d.ts +70 -82
- package/dist-types/commands/CreateBucketMetadataConfigurationCommand.d.ts +182 -0
- package/dist-types/commands/CreateBucketMetadataTableConfigurationCommand.d.ts +25 -12
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +88 -113
- package/dist-types/commands/CreateSessionCommand.d.ts +45 -50
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +7 -9
- package/dist-types/commands/DeleteBucketCommand.d.ts +10 -12
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +4 -5
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +16 -18
- package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +4 -6
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +23 -28
- package/dist-types/commands/DeleteBucketMetadataConfigurationCommand.d.ts +114 -0
- package/dist-types/commands/DeleteBucketMetadataTableConfigurationCommand.d.ts +26 -8
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +9 -12
- package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +5 -6
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +20 -23
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +5 -7
- package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +2 -3
- package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +9 -10
- package/dist-types/commands/DeleteObjectCommand.d.ts +37 -23
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +7 -7
- package/dist-types/commands/DeleteObjectsCommand.d.ts +37 -44
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +6 -6
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +14 -17
- package/dist-types/commands/GetBucketAclCommand.d.ts +9 -11
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +8 -11
- package/dist-types/commands/GetBucketCorsCommand.d.ts +4 -6
- package/dist-types/commands/GetBucketEncryptionCommand.d.ts +16 -19
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +6 -8
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +28 -37
- package/dist-types/commands/GetBucketLocationCommand.d.ts +4 -5
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +2 -2
- package/dist-types/commands/GetBucketMetadataConfigurationCommand.d.ts +146 -0
- package/dist-types/commands/GetBucketMetadataTableConfigurationCommand.d.ts +25 -8
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +10 -11
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +7 -8
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +9 -8
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +24 -29
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +5 -6
- package/dist-types/commands/GetBucketReplicationCommand.d.ts +11 -12
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +2 -3
- package/dist-types/commands/GetBucketTaggingCommand.d.ts +2 -3
- package/dist-types/commands/GetBucketVersioningCommand.d.ts +3 -3
- package/dist-types/commands/GetBucketWebsiteCommand.d.ts +6 -7
- package/dist-types/commands/GetObjectAclCommand.d.ts +9 -11
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +55 -70
- package/dist-types/commands/GetObjectCommand.d.ts +66 -81
- package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +1 -2
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +1 -2
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +8 -10
- package/dist-types/commands/GetObjectTorrentCommand.d.ts +4 -5
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +10 -12
- package/dist-types/commands/HeadBucketCommand.d.ts +33 -35
- package/dist-types/commands/HeadObjectCommand.d.ts +50 -62
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +14 -17
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +12 -15
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +15 -18
- package/dist-types/commands/ListBucketsCommand.d.ts +10 -9
- package/dist-types/commands/ListDirectoryBucketsCommand.d.ts +9 -9
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +41 -49
- package/dist-types/commands/ListObjectVersionsCommand.d.ts +7 -9
- package/dist-types/commands/ListObjectsCommand.d.ts +8 -7
- package/dist-types/commands/ListObjectsV2Command.d.ts +28 -31
- package/dist-types/commands/ListPartsCommand.d.ts +21 -24
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +14 -18
- package/dist-types/commands/PutBucketAclCommand.d.ts +51 -62
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +23 -25
- package/dist-types/commands/PutBucketCorsCommand.d.ts +23 -27
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +40 -48
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +11 -12
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +33 -37
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +51 -60
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +26 -33
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +12 -14
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +29 -35
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +4 -6
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +24 -29
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +31 -38
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +4 -5
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +21 -27
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +20 -23
- package/dist-types/commands/PutBucketWebsiteCommand.d.ts +19 -18
- package/dist-types/commands/PutObjectAclCommand.d.ts +53 -61
- package/dist-types/commands/PutObjectCommand.d.ts +56 -66
- package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +1 -3
- package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +10 -11
- package/dist-types/commands/PutObjectRetentionCommand.d.ts +4 -4
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +18 -24
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +10 -12
- package/dist-types/commands/RenameObjectCommand.d.ts +34 -40
- package/dist-types/commands/RestoreObjectCommand.d.ts +76 -85
- package/dist-types/commands/SelectObjectContentCommand.d.ts +50 -59
- package/dist-types/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.d.ts +161 -0
- package/dist-types/commands/UpdateBucketMetadataJournalTableConfigurationCommand.d.ts +113 -0
- package/dist-types/commands/UploadPartCommand.d.ts +64 -74
- package/dist-types/commands/UploadPartCopyCommand.d.ts +80 -96
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +29 -33
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +2688 -3603
- package/dist-types/models/models_1.d.ts +2120 -743
- package/dist-types/protocols/Aws_restXml.d.ts +45 -0
- package/dist-types/ts3.4/S3.d.ts +109 -0
- package/dist-types/ts3.4/S3Client.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateBucketMetadataConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteBucketMetadataConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetBucketMetadataConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListObjectVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListObjectsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListObjectsV2Command.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPartsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketAccelerateConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketAclCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketAnalyticsConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateBucketMetadataJournalTableConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +93 -206
- package/dist-types/ts3.4/models/models_1.d.ts +238 -0
- package/dist-types/ts3.4/protocols/Aws_restXml.d.ts +60 -0
- package/package.json +15 -15
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { ListObjectsV2Output, ListObjectsV2Request } from "../models/
|
|
3
|
+
import { ListObjectsV2Output, ListObjectsV2Request } from "../models/models_1";
|
|
4
4
|
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -27,31 +27,30 @@ declare const ListObjectsV2Command_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns some or all (up to 1,000) of the objects in a bucket with each request. You can
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
30
|
+
* <p>Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the
|
|
31
|
+
* request parameters as selection criteria to return a subset of the objects in a bucket. A <code>200
|
|
32
|
+
* OK</code> response can contain valid or invalid XML. Make sure to design your application to parse the
|
|
33
|
+
* contents of the response and handle it appropriately. For more information about listing objects, see
|
|
34
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html">Listing object
|
|
35
|
+
* keys programmatically</a> in the <i>Amazon S3 User Guide</i>. To get a list of your
|
|
36
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a>.</p>
|
|
37
37
|
* <note>
|
|
38
38
|
* <ul>
|
|
39
39
|
* <li>
|
|
40
40
|
* <p>
|
|
41
41
|
* <b>General purpose bucket</b> - For general purpose buckets,
|
|
42
|
-
*
|
|
43
|
-
*
|
|
42
|
+
* <code>ListObjectsV2</code> doesn't return prefixes that are related only to in-progress
|
|
43
|
+
* multipart uploads.</p>
|
|
44
44
|
* </li>
|
|
45
45
|
* <li>
|
|
46
46
|
* <p>
|
|
47
|
-
* <b>Directory buckets</b> - For
|
|
48
|
-
*
|
|
49
|
-
*
|
|
47
|
+
* <b>Directory buckets</b> - For directory buckets,
|
|
48
|
+
* <code>ListObjectsV2</code> response includes the prefixes that are related only to in-progress
|
|
49
|
+
* multipart uploads. </p>
|
|
50
50
|
* </li>
|
|
51
51
|
* <li>
|
|
52
52
|
* <p>
|
|
53
|
-
* <b>Directory buckets</b> -
|
|
54
|
-
* For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
|
|
53
|
+
* <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
|
|
55
54
|
* </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
|
|
56
55
|
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the
|
|
57
56
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -64,13 +63,12 @@ declare const ListObjectsV2Command_base: {
|
|
|
64
63
|
* <ul>
|
|
65
64
|
* <li>
|
|
66
65
|
* <p>
|
|
67
|
-
* <b>General purpose bucket permissions</b> - To
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
66
|
+
* <b>General purpose bucket permissions</b> - To use this
|
|
67
|
+
* operation, you must have READ access to the bucket. You must have permission to perform the
|
|
68
|
+
* <code>s3:ListBucket</code> action. The bucket owner has this permission by default and can
|
|
69
|
+
* grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access
|
|
70
|
+
* Permissions to Your Amazon S3 Resources</a> in the
|
|
71
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
74
72
|
* </li>
|
|
75
73
|
* <li>
|
|
76
74
|
* <p>
|
|
@@ -88,15 +86,14 @@ declare const ListObjectsV2Command_base: {
|
|
|
88
86
|
* <ul>
|
|
89
87
|
* <li>
|
|
90
88
|
* <p>
|
|
91
|
-
* <b>General purpose bucket</b> - For
|
|
92
|
-
*
|
|
93
|
-
*
|
|
89
|
+
* <b>General purpose bucket</b> - For general purpose buckets,
|
|
90
|
+
* <code>ListObjectsV2</code> returns objects in lexicographical order based on their key
|
|
91
|
+
* names.</p>
|
|
94
92
|
* </li>
|
|
95
93
|
* <li>
|
|
96
94
|
* <p>
|
|
97
|
-
* <b>Directory bucket</b> - For
|
|
98
|
-
*
|
|
99
|
-
* lexicographical order.</p>
|
|
95
|
+
* <b>Directory bucket</b> - For directory buckets,
|
|
96
|
+
* <code>ListObjectsV2</code> does not return objects in lexicographical order.</p>
|
|
100
97
|
* </li>
|
|
101
98
|
* </ul>
|
|
102
99
|
* </dd>
|
|
@@ -108,9 +105,9 @@ declare const ListObjectsV2Command_base: {
|
|
|
108
105
|
* </dd>
|
|
109
106
|
* </dl>
|
|
110
107
|
* <important>
|
|
111
|
-
* <p>This section describes the latest revision of this action. We recommend that you use
|
|
112
|
-
*
|
|
113
|
-
*
|
|
108
|
+
* <p>This section describes the latest revision of this action. We recommend that you use this revised
|
|
109
|
+
* API operation for application development. For backward compatibility, Amazon S3 continues to support the
|
|
110
|
+
* prior version of this API operation, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a>.</p>
|
|
114
111
|
* </important>
|
|
115
112
|
* <p>The following operations are related to <code>ListObjectsV2</code>:</p>
|
|
116
113
|
* <ul>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { ListPartsOutput, ListPartsRequest } from "../models/
|
|
3
|
+
import { ListPartsOutput, ListPartsRequest } from "../models/models_1";
|
|
4
4
|
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -35,22 +35,21 @@ declare const ListPartsCommand_base: {
|
|
|
35
35
|
* Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.</p>
|
|
36
36
|
* </important>
|
|
37
37
|
* <p>Lists the parts that have been uploaded for a specific multipart upload.</p>
|
|
38
|
-
* <p>To use this operation, you must provide the <code>upload ID</code> in the request. You
|
|
39
|
-
*
|
|
40
|
-
* <p>The <code>ListParts</code> request returns a maximum of 1,000 uploaded parts. The limit
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
* <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart
|
|
49
|
-
*
|
|
38
|
+
* <p>To use this operation, you must provide the <code>upload ID</code> in the request. You obtain this
|
|
39
|
+
* uploadID by sending the initiate multipart upload request through <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>.</p>
|
|
40
|
+
* <p>The <code>ListParts</code> request returns a maximum of 1,000 uploaded parts. The limit of 1,000
|
|
41
|
+
* parts is also the default value. You can restrict the number of parts in a response by specifying the
|
|
42
|
+
* <code>max-parts</code> request parameter. If your multipart upload consists of more than 1,000 parts,
|
|
43
|
+
* the response returns an <code>IsTruncated</code> field with the value of <code>true</code>, and a
|
|
44
|
+
* <code>NextPartNumberMarker</code> element. To list remaining uploaded parts, in subsequent
|
|
45
|
+
* <code>ListParts</code> requests, include the <code>part-number-marker</code> query string parameter
|
|
46
|
+
* and set its value to the <code>NextPartNumberMarker</code> field value from the previous
|
|
47
|
+
* response.</p>
|
|
48
|
+
* <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart Upload</a> in
|
|
49
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
50
50
|
* <note>
|
|
51
51
|
* <p>
|
|
52
|
-
* <b>Directory buckets</b> -
|
|
53
|
-
* For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
|
|
52
|
+
* <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
|
|
54
53
|
* </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
|
|
55
54
|
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the
|
|
56
55
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -61,15 +60,13 @@ declare const ListPartsCommand_base: {
|
|
|
61
60
|
* <ul>
|
|
62
61
|
* <li>
|
|
63
62
|
* <p>
|
|
64
|
-
* <b>General purpose bucket permissions</b> - For
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
* <code>kms:Decrypt</code> action for the <code>ListParts</code> request to
|
|
72
|
-
* succeed.</p>
|
|
63
|
+
* <b>General purpose bucket permissions</b> - For information
|
|
64
|
+
* about permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and Permissions</a> in
|
|
65
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
66
|
+
* <p>If the upload was created using server-side encryption with Key Management Service (KMS) keys
|
|
67
|
+
* (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), you must have
|
|
68
|
+
* permission to the <code>kms:Decrypt</code> action for the <code>ListParts</code> request to
|
|
69
|
+
* succeed.</p>
|
|
73
70
|
* </li>
|
|
74
71
|
* <li>
|
|
75
72
|
* <p>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { PutBucketAccelerateConfigurationRequest } from "../models/
|
|
3
|
+
import { PutBucketAccelerateConfigurationRequest } from "../models/models_1";
|
|
4
4
|
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -31,14 +31,12 @@ declare const PutBucketAccelerateConfigurationCommand_base: {
|
|
|
31
31
|
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a
|
|
34
|
-
*
|
|
34
|
+
* bucket-level feature that enables you to perform faster data transfers to Amazon S3.</p>
|
|
35
35
|
* <p> To use this operation, you must have permission to perform the
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
* <p> The Transfer Acceleration state of a bucket can be set to one of the following two
|
|
41
|
-
* values:</p>
|
|
36
|
+
* <code>s3:PutAccelerateConfiguration</code> action. The bucket owner has this permission by default.
|
|
37
|
+
* The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
38
|
+
* Resources</a>.</p>
|
|
39
|
+
* <p> The Transfer Acceleration state of a bucket can be set to one of the following two values:</p>
|
|
42
40
|
* <ul>
|
|
43
41
|
* <li>
|
|
44
42
|
* <p> Enabled – Enables accelerated data transfers to the bucket.</p>
|
|
@@ -47,16 +45,14 @@ declare const PutBucketAccelerateConfigurationCommand_base: {
|
|
|
47
45
|
* <p> Suspended – Disables accelerated data transfers to the bucket.</p>
|
|
48
46
|
* </li>
|
|
49
47
|
* </ul>
|
|
50
|
-
* <p>The <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> action returns the transfer acceleration state
|
|
51
|
-
*
|
|
52
|
-
* <p>After setting the Transfer Acceleration state of a bucket to Enabled, it might take up
|
|
53
|
-
*
|
|
54
|
-
* <p> The name of the bucket used for Transfer Acceleration must be DNS-compliant and must
|
|
55
|
-
*
|
|
56
|
-
* <p> For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer
|
|
57
|
-
*
|
|
58
|
-
* <p>The following operations are related to
|
|
59
|
-
* <code>PutBucketAccelerateConfiguration</code>:</p>
|
|
48
|
+
* <p>The <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> action returns the transfer acceleration state of a
|
|
49
|
+
* bucket.</p>
|
|
50
|
+
* <p>After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty
|
|
51
|
+
* minutes before the data transfer rates to the bucket increase.</p>
|
|
52
|
+
* <p> The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain
|
|
53
|
+
* periods (".").</p>
|
|
54
|
+
* <p> For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a>.</p>
|
|
55
|
+
* <p>The following operations are related to <code>PutBucketAccelerateConfiguration</code>:</p>
|
|
60
56
|
* <ul>
|
|
61
57
|
* <li>
|
|
62
58
|
* <p>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { PutBucketAclRequest } from "../models/
|
|
3
|
+
import { PutBucketAclRequest } from "../models/models_1";
|
|
4
4
|
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -38,9 +38,9 @@ declare const PutBucketAclCommand_base: {
|
|
|
38
38
|
* <note>
|
|
39
39
|
* <p>This operation is not supported for directory buckets.</p>
|
|
40
40
|
* </note>
|
|
41
|
-
* <p>Sets the permissions on an existing bucket using access control lists (ACL). For more
|
|
42
|
-
*
|
|
43
|
-
*
|
|
41
|
+
* <p>Sets the permissions on an existing bucket using access control lists (ACL). For more information,
|
|
42
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. To
|
|
43
|
+
* set the ACL of a bucket, you must have the <code>WRITE_ACP</code> permission.</p>
|
|
44
44
|
* <p>You can use one of the following two ways to set a bucket's permissions:</p>
|
|
45
45
|
* <ul>
|
|
46
46
|
* <li>
|
|
@@ -51,20 +51,18 @@ declare const PutBucketAclCommand_base: {
|
|
|
51
51
|
* </li>
|
|
52
52
|
* </ul>
|
|
53
53
|
* <note>
|
|
54
|
-
* <p>You cannot specify access permission using both the body and the request
|
|
55
|
-
* headers.</p>
|
|
54
|
+
* <p>You cannot specify access permission using both the body and the request headers.</p>
|
|
56
55
|
* </note>
|
|
57
|
-
* <p>Depending on your application needs, you may choose to set the ACL on a bucket using
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
* approach.</p>
|
|
56
|
+
* <p>Depending on your application needs, you may choose to set the ACL on a bucket using either the
|
|
57
|
+
* request body or the headers. For example, if you have an existing application that updates a bucket ACL
|
|
58
|
+
* using the request body, then you can continue to use that approach.</p>
|
|
61
59
|
* <important>
|
|
62
|
-
* <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
60
|
+
* <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled
|
|
61
|
+
* and no longer affect permissions. You must use policies to grant access to your bucket and the objects
|
|
62
|
+
* in it. Requests to set ACLs or update ACLs fail and return the
|
|
63
|
+
* <code>AccessControlListNotSupported</code> error code. Requests to read ACLs are still supported.
|
|
64
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object ownership</a> in
|
|
65
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
68
66
|
* </important>
|
|
69
67
|
* <dl>
|
|
70
68
|
* <dt>Permissions</dt>
|
|
@@ -72,43 +70,37 @@ declare const PutBucketAclCommand_base: {
|
|
|
72
70
|
* <p>You can set access permissions by using one of the following methods:</p>
|
|
73
71
|
* <ul>
|
|
74
72
|
* <li>
|
|
75
|
-
* <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
* access control-specific headers in your request. For more information, see
|
|
81
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
|
|
82
|
-
* ACL</a>.</p>
|
|
73
|
+
* <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 supports a set
|
|
74
|
+
* of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL has a
|
|
75
|
+
* predefined set of grantees and permissions. Specify the canned ACL name as the value of
|
|
76
|
+
* <code>x-amz-acl</code>. If you use this header, you cannot use other access control-specific
|
|
77
|
+
* headers in your request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a>.</p>
|
|
83
78
|
* </li>
|
|
84
79
|
* <li>
|
|
85
|
-
* <p>Specify access permissions explicitly with the
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
* <p>You specify each grantee as a type=value pair, where the type is one of
|
|
96
|
-
* the following:</p>
|
|
80
|
+
* <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>,
|
|
81
|
+
* <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and
|
|
82
|
+
* <code>x-amz-grant-full-control</code> headers. When using these headers, you specify
|
|
83
|
+
* explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the
|
|
84
|
+
* permission. If you use these ACL-specific headers, you cannot use the <code>x-amz-acl</code>
|
|
85
|
+
* header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports
|
|
86
|
+
* in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL)
|
|
87
|
+
* Overview</a>.</p>
|
|
88
|
+
* <p>You specify each grantee as a type=value pair, where the type is one of the
|
|
89
|
+
* following:</p>
|
|
97
90
|
* <ul>
|
|
98
91
|
* <li>
|
|
99
92
|
* <p>
|
|
100
|
-
* <code>id</code> – if the value specified is the canonical user ID
|
|
101
|
-
*
|
|
93
|
+
* <code>id</code> – if the value specified is the canonical user ID of an
|
|
94
|
+
* Amazon Web Services account</p>
|
|
102
95
|
* </li>
|
|
103
96
|
* <li>
|
|
104
97
|
* <p>
|
|
105
|
-
* <code>uri</code> – if you are granting permissions to a predefined
|
|
106
|
-
* group</p>
|
|
98
|
+
* <code>uri</code> – if you are granting permissions to a predefined group</p>
|
|
107
99
|
* </li>
|
|
108
100
|
* <li>
|
|
109
101
|
* <p>
|
|
110
|
-
* <code>emailAddress</code> – if the value specified is the email
|
|
111
|
-
*
|
|
102
|
+
* <code>emailAddress</code> – if the value specified is the email address of an
|
|
103
|
+
* Amazon Web Services account</p>
|
|
112
104
|
* <note>
|
|
113
105
|
* <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
|
|
114
106
|
* <ul>
|
|
@@ -141,34 +133,31 @@ declare const PutBucketAclCommand_base: {
|
|
|
141
133
|
* </note>
|
|
142
134
|
* </li>
|
|
143
135
|
* </ul>
|
|
144
|
-
* <p>For example, the following <code>x-amz-grant-write</code> header grants
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
* addresses.</p>
|
|
136
|
+
* <p>For example, the following <code>x-amz-grant-write</code> header grants create, overwrite,
|
|
137
|
+
* and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts
|
|
138
|
+
* identified by their email addresses.</p>
|
|
148
139
|
* <p>
|
|
149
|
-
* <code>x-amz-grant-write:
|
|
150
|
-
*
|
|
151
|
-
* id="555566667777" </code>
|
|
140
|
+
* <code>x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery",
|
|
141
|
+
* id="111122223333", id="555566667777" </code>
|
|
152
142
|
* </p>
|
|
153
143
|
* </li>
|
|
154
144
|
* </ul>
|
|
155
|
-
* <p>You can use either a canned ACL or specify access permissions explicitly. You
|
|
156
|
-
*
|
|
145
|
+
* <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do
|
|
146
|
+
* both.</p>
|
|
157
147
|
* </dd>
|
|
158
148
|
* <dt>Grantee Values</dt>
|
|
159
149
|
* <dd>
|
|
160
|
-
* <p>You can specify the person (grantee) to whom you're assigning access rights
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
150
|
+
* <p>You can specify the person (grantee) to whom you're assigning access rights (using request
|
|
151
|
+
* elements) in the following ways. For examples of how to specify these grantee values in JSON
|
|
152
|
+
* format, see the Amazon Web Services CLI example in <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html"> Enabling Amazon S3 server
|
|
153
|
+
* access logging</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
165
154
|
* <ul>
|
|
166
155
|
* <li>
|
|
167
156
|
* <p>By the person's ID:</p>
|
|
168
157
|
* <p>
|
|
169
158
|
* <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
170
|
-
*
|
|
171
|
-
*
|
|
159
|
+
* xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
|
|
160
|
+
* </Grantee></code>
|
|
172
161
|
* </p>
|
|
173
162
|
* <p>DisplayName is optional and ignored in the request</p>
|
|
174
163
|
* </li>
|
|
@@ -176,17 +165,17 @@ declare const PutBucketAclCommand_base: {
|
|
|
176
165
|
* <p>By URI:</p>
|
|
177
166
|
* <p>
|
|
178
167
|
* <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
179
|
-
*
|
|
168
|
+
* xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code>
|
|
180
169
|
* </p>
|
|
181
170
|
* </li>
|
|
182
171
|
* <li>
|
|
183
172
|
* <p>By Email address:</p>
|
|
184
173
|
* <p>
|
|
185
174
|
* <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
186
|
-
*
|
|
175
|
+
* xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>&</Grantee></code>
|
|
187
176
|
* </p>
|
|
188
|
-
* <p>The grantee is resolved to the CanonicalUser and, in a response to a GET
|
|
189
|
-
*
|
|
177
|
+
* <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl
|
|
178
|
+
* request, appears as the CanonicalUser. </p>
|
|
190
179
|
* <note>
|
|
191
180
|
* <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
|
|
192
181
|
* <ul>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { PutBucketAnalyticsConfigurationRequest } from "../models/
|
|
3
|
+
import { PutBucketAnalyticsConfigurationRequest } from "../models/models_1";
|
|
4
4
|
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -30,26 +30,25 @@ declare const PutBucketAnalyticsConfigurationCommand_base: {
|
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
|
-
* <p>Sets an analytics configuration for the bucket (specified by the analytics configuration
|
|
34
|
-
*
|
|
35
|
-
* <p>You can choose to have storage class analysis export analysis reports sent to a
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
33
|
+
* <p>Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You
|
|
34
|
+
* can have up to 1,000 analytics configurations per bucket.</p>
|
|
35
|
+
* <p>You can choose to have storage class analysis export analysis reports sent to a comma-separated
|
|
36
|
+
* values (CSV) flat file. See the <code>DataExport</code> request element. Reports are updated daily and
|
|
37
|
+
* are based on the object filters that you configure. When selecting data export, you specify a
|
|
38
|
+
* destination bucket and an optional destination prefix where the file is written. You can export the data
|
|
39
|
+
* to a destination bucket in a different account. However, the destination bucket must be in the same
|
|
40
|
+
* Region as the bucket that you are making the PUT analytics configuration to. For more information, see
|
|
41
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics –
|
|
42
|
+
* Storage Class Analysis</a>. </p>
|
|
43
43
|
* <important>
|
|
44
|
-
* <p>You must create a bucket policy on the destination bucket where the exported file is
|
|
45
|
-
*
|
|
46
|
-
*
|
|
44
|
+
* <p>You must create a bucket policy on the destination bucket where the exported file is written to
|
|
45
|
+
* grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9">Granting
|
|
46
|
+
* Permissions for Amazon S3 Inventory and Storage Class Analysis</a>.</p>
|
|
47
47
|
* </important>
|
|
48
48
|
* <p>To use this operation, you must have permissions to perform the
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
49
|
+
* <code>s3:PutAnalyticsConfiguration</code> action. The bucket owner has this permission by default. The
|
|
50
|
+
* bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
51
|
+
* Resources</a>.</p>
|
|
53
52
|
* <p>
|
|
54
53
|
* <code>PutBucketAnalyticsConfiguration</code> has the following special errors:</p>
|
|
55
54
|
* <ul>
|
|
@@ -86,8 +85,8 @@ declare const PutBucketAnalyticsConfigurationCommand_base: {
|
|
|
86
85
|
* </li>
|
|
87
86
|
* <li>
|
|
88
87
|
* <p>
|
|
89
|
-
* <i>Cause: You are attempting to create a new configuration but have
|
|
90
|
-
*
|
|
88
|
+
* <i>Cause: You are attempting to create a new configuration but have already reached
|
|
89
|
+
* the 1,000-configuration limit.</i>
|
|
91
90
|
* </p>
|
|
92
91
|
* </li>
|
|
93
92
|
* </ul>
|
|
@@ -106,16 +105,15 @@ declare const PutBucketAnalyticsConfigurationCommand_base: {
|
|
|
106
105
|
* </li>
|
|
107
106
|
* <li>
|
|
108
107
|
* <p>
|
|
109
|
-
* <i>Cause: You are not the owner of the specified bucket, or you do
|
|
110
|
-
*
|
|
111
|
-
*
|
|
108
|
+
* <i>Cause: You are not the owner of the specified bucket, or you do not have the
|
|
109
|
+
* s3:PutAnalyticsConfiguration bucket permission to set the configuration on the
|
|
110
|
+
* bucket.</i>
|
|
112
111
|
* </p>
|
|
113
112
|
* </li>
|
|
114
113
|
* </ul>
|
|
115
114
|
* </li>
|
|
116
115
|
* </ul>
|
|
117
|
-
* <p>The following operations are related to
|
|
118
|
-
* <code>PutBucketAnalyticsConfiguration</code>:</p>
|
|
116
|
+
* <p>The following operations are related to <code>PutBucketAnalyticsConfiguration</code>:</p>
|
|
119
117
|
* <ul>
|
|
120
118
|
* <li>
|
|
121
119
|
* <p>
|
|
@@ -30,42 +30,38 @@ declare const PutBucketCorsCommand_base: {
|
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
|
-
* <p>Sets the <code>cors</code> configuration for your bucket. If the configuration exists,
|
|
34
|
-
*
|
|
35
|
-
* <p>To use this operation, you must be allowed to perform the <code>s3:PutBucketCORS</code>
|
|
36
|
-
*
|
|
37
|
-
* <p>You set this configuration on a bucket so that the bucket can service cross-origin
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
* cross-origin request. For a rule to match, the following conditions must be met:</p>
|
|
33
|
+
* <p>Sets the <code>cors</code> configuration for your bucket. If the configuration exists, Amazon S3 replaces
|
|
34
|
+
* it.</p>
|
|
35
|
+
* <p>To use this operation, you must be allowed to perform the <code>s3:PutBucketCORS</code> action. By
|
|
36
|
+
* default, the bucket owner has this permission and can grant it to others.</p>
|
|
37
|
+
* <p>You set this configuration on a bucket so that the bucket can service cross-origin requests. For
|
|
38
|
+
* example, you might want to enable a request whose origin is <code>http://www.example.com</code> to
|
|
39
|
+
* access your Amazon S3 bucket at <code>my.example.bucket.com</code> by using the browser's
|
|
40
|
+
* <code>XMLHttpRequest</code> capability.</p>
|
|
41
|
+
* <p>To enable cross-origin resource sharing (CORS) on a bucket, you add the <code>cors</code>
|
|
42
|
+
* subresource to the bucket. The <code>cors</code> subresource is an XML document in which you configure
|
|
43
|
+
* rules that identify origins and the HTTP methods that can be executed on your bucket. The document is
|
|
44
|
+
* limited to 64 KB in size. </p>
|
|
45
|
+
* <p>When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it
|
|
46
|
+
* evaluates the <code>cors</code> configuration on the bucket and uses the first <code>CORSRule</code>
|
|
47
|
+
* rule that matches the incoming browser request to enable a cross-origin request. For a rule to match,
|
|
48
|
+
* the following conditions must be met:</p>
|
|
50
49
|
* <ul>
|
|
51
50
|
* <li>
|
|
52
|
-
* <p>The request's <code>Origin</code> header must match <code>AllowedOrigin</code>
|
|
53
|
-
* elements.</p>
|
|
51
|
+
* <p>The request's <code>Origin</code> header must match <code>AllowedOrigin</code> elements.</p>
|
|
54
52
|
* </li>
|
|
55
53
|
* <li>
|
|
56
54
|
* <p>The request method (for example, GET, PUT, HEAD, and so on) or the
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
* elements. </p>
|
|
55
|
+
* <code>Access-Control-Request-Method</code> header in case of a pre-flight <code>OPTIONS</code>
|
|
56
|
+
* request must be one of the <code>AllowedMethod</code> elements. </p>
|
|
60
57
|
* </li>
|
|
61
58
|
* <li>
|
|
62
|
-
* <p>Every header specified in the <code>Access-Control-Request-Headers</code> request
|
|
63
|
-
*
|
|
64
|
-
* </p>
|
|
59
|
+
* <p>Every header specified in the <code>Access-Control-Request-Headers</code> request header of a
|
|
60
|
+
* pre-flight request must match an <code>AllowedHeader</code> element. </p>
|
|
65
61
|
* </li>
|
|
66
62
|
* </ul>
|
|
67
|
-
* <p> For more information about CORS, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling Cross-Origin Resource Sharing</a> in
|
|
68
|
-
*
|
|
63
|
+
* <p> For more information about CORS, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling Cross-Origin Resource Sharing</a> in the
|
|
64
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
69
65
|
* <p>The following operations are related to <code>PutBucketCors</code>:</p>
|
|
70
66
|
* <ul>
|
|
71
67
|
* <li>
|