@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
|
@@ -39,51 +39,46 @@ declare const GetBucketPolicyCommand_base: {
|
|
|
39
39
|
* <dl>
|
|
40
40
|
* <dt>Permissions</dt>
|
|
41
41
|
* <dd>
|
|
42
|
-
* <p>If you are using an identity other than the root user of the Amazon Web Services account that
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
* returns a <code>405 Method Not Allowed</code> error.</p>
|
|
42
|
+
* <p>If you are using an identity other than the root user of the Amazon Web Services account that owns the
|
|
43
|
+
* bucket, the calling identity must both have the <code>GetBucketPolicy</code> permissions on the
|
|
44
|
+
* specified bucket and belong to the bucket owner's account in order to use this operation.</p>
|
|
45
|
+
* <p>If you don't have <code>GetBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access
|
|
46
|
+
* Denied</code> error. If you have the correct permissions, but you're not using an identity that
|
|
47
|
+
* belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code>
|
|
48
|
+
* error.</p>
|
|
50
49
|
* <important>
|
|
51
|
-
* <p>To ensure that bucket owners don't inadvertently lock themselves out of
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* Amazon Web Services Organizations policies.</p>
|
|
50
|
+
* <p>To ensure that bucket owners don't inadvertently lock themselves out of their own buckets,
|
|
51
|
+
* the root principal in a bucket owner's Amazon Web Services account can perform the
|
|
52
|
+
* <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and
|
|
53
|
+
* <code>DeleteBucketPolicy</code> API actions, even if their bucket policy explicitly denies the
|
|
54
|
+
* root principal's access. Bucket owner root principals can only be blocked from performing these
|
|
55
|
+
* API actions by VPC endpoint policies and Amazon Web Services Organizations policies.</p>
|
|
58
56
|
* </important>
|
|
59
57
|
* <ul>
|
|
60
58
|
* <li>
|
|
61
59
|
* <p>
|
|
62
60
|
* <b>General purpose bucket permissions</b> - The
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
61
|
+
* <code>s3:GetBucketPolicy</code> permission is required in a policy. For more information
|
|
62
|
+
* about general purpose buckets bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User
|
|
63
|
+
* Policies</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
66
64
|
* </li>
|
|
67
65
|
* <li>
|
|
68
66
|
* <p>
|
|
69
|
-
* <b>Directory bucket permissions</b> -
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
* For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
67
|
+
* <b>Directory bucket permissions</b> - To grant access to
|
|
68
|
+
* this API operation, you must have the <code>s3express:GetBucketPolicy</code> permission in
|
|
69
|
+
* an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.
|
|
70
|
+
* For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
74
71
|
* </li>
|
|
75
72
|
* </ul>
|
|
76
73
|
* </dd>
|
|
77
74
|
* <dt>Example bucket policies</dt>
|
|
78
75
|
* <dd>
|
|
79
76
|
* <p>
|
|
80
|
-
* <b>General purpose buckets example bucket policies</b>
|
|
81
|
-
*
|
|
82
|
-
* examples</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
77
|
+
* <b>General purpose buckets example bucket policies</b> - See <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket policy
|
|
78
|
+
* examples</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
83
79
|
* <p>
|
|
84
|
-
* <b>Directory bucket example bucket policies</b>
|
|
85
|
-
*
|
|
86
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
80
|
+
* <b>Directory bucket example bucket policies</b> - See <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html">Example
|
|
81
|
+
* bucket policies for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
87
82
|
* </dd>
|
|
88
83
|
* <dt>HTTP Host header syntax</dt>
|
|
89
84
|
* <dd>
|
|
@@ -30,17 +30,16 @@ declare const GetBucketPolicyStatusCommand_base: {
|
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
|
-
* <p>Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
33
|
+
* <p>Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to
|
|
34
|
+
* use this operation, you must have the <code>s3:GetBucketPolicyStatus</code> permission. For more
|
|
35
|
+
* information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
|
|
36
|
+
* Policy</a>.</p>
|
|
37
37
|
* <p> For more information about when Amazon S3 considers a bucket 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>. </p>
|
|
38
38
|
* <p>The following operations are related to <code>GetBucketPolicyStatus</code>:</p>
|
|
39
39
|
* <ul>
|
|
40
40
|
* <li>
|
|
41
41
|
* <p>
|
|
42
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using Amazon S3 Block
|
|
43
|
-
* Public Access</a>
|
|
42
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using Amazon S3 Block Public Access</a>
|
|
44
43
|
* </p>
|
|
45
44
|
* </li>
|
|
46
45
|
* <li>
|
|
@@ -32,20 +32,19 @@ declare const GetBucketReplicationCommand_base: {
|
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Returns the replication configuration of a bucket.</p>
|
|
34
34
|
* <note>
|
|
35
|
-
* <p> It can take a while to propagate the put or delete a replication configuration to
|
|
36
|
-
*
|
|
37
|
-
* result. </p>
|
|
35
|
+
* <p> It can take a while to propagate the put or delete a replication configuration to all Amazon S3
|
|
36
|
+
* systems. Therefore, a get request soon after put or delete can return a wrong result. </p>
|
|
38
37
|
* </note>
|
|
39
38
|
* <p> For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the
|
|
40
|
-
*
|
|
41
|
-
* <p>This action requires permissions for the <code>s3:GetReplicationConfiguration</code>
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
* <p>If you include the <code>Filter</code> element in a replication configuration, you must
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
* <p>For information about <code>GetBucketReplication</code> errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList">List of
|
|
48
|
-
*
|
|
39
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
40
|
+
* <p>This action requires permissions for the <code>s3:GetReplicationConfiguration</code> action. For
|
|
41
|
+
* more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User
|
|
42
|
+
* Policies</a>.</p>
|
|
43
|
+
* <p>If you include the <code>Filter</code> element in a replication configuration, you must also include
|
|
44
|
+
* the <code>DeleteMarkerReplication</code> and <code>Priority</code> elements. The response also returns
|
|
45
|
+
* those elements.</p>
|
|
46
|
+
* <p>For information about <code>GetBucketReplication</code> errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList">List of replication-related
|
|
47
|
+
* error codes</a>
|
|
49
48
|
* </p>
|
|
50
49
|
* <p>The following operations are related to <code>GetBucketReplication</code>:</p>
|
|
51
50
|
* <ul>
|
|
@@ -30,9 +30,8 @@ declare const GetBucketRequestPaymentCommand_base: {
|
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
|
-
* <p>Returns the request payment configuration of a bucket. To use this version of the
|
|
34
|
-
*
|
|
35
|
-
* Buckets</a>.</p>
|
|
33
|
+
* <p>Returns the request payment configuration of a bucket. To use this version of the operation, you
|
|
34
|
+
* must be the bucket owner. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays Buckets</a>.</p>
|
|
36
35
|
* <p>The following operations are related to <code>GetBucketRequestPayment</code>:</p>
|
|
37
36
|
* <ul>
|
|
38
37
|
* <li>
|
|
@@ -31,9 +31,8 @@ declare const GetBucketTaggingCommand_base: {
|
|
|
31
31
|
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Returns the tag set associated with the bucket.</p>
|
|
34
|
-
* <p>To use this operation, you must have permission to perform the
|
|
35
|
-
*
|
|
36
|
-
* permission and can grant this permission to others.</p>
|
|
34
|
+
* <p>To use this operation, you must have permission to perform the <code>s3:GetBucketTagging</code>
|
|
35
|
+
* action. By default, the bucket owner has this permission and can grant this permission to others.</p>
|
|
37
36
|
* <p>
|
|
38
37
|
* <code>GetBucketTagging</code> has the following special error:</p>
|
|
39
38
|
* <ul>
|
|
@@ -32,9 +32,9 @@ declare const GetBucketVersioningCommand_base: {
|
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Returns the versioning state of a bucket.</p>
|
|
34
34
|
* <p>To retrieve the versioning state of a bucket, you must be the bucket owner.</p>
|
|
35
|
-
* <p>This implementation also returns the MFA Delete status of the versioning state. If the
|
|
36
|
-
*
|
|
37
|
-
*
|
|
35
|
+
* <p>This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete
|
|
36
|
+
* status is <code>enabled</code>, the bucket owner must use an authentication device to change the
|
|
37
|
+
* versioning state of the bucket.</p>
|
|
38
38
|
* <p>The following operations are related to <code>GetBucketVersioning</code>:</p>
|
|
39
39
|
* <ul>
|
|
40
40
|
* <li>
|
|
@@ -30,13 +30,12 @@ declare const GetBucketWebsiteCommand_base: {
|
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
|
-
* <p>Returns the website configuration for a bucket. To host website on Amazon S3, you can
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* them the <code>S3:GetBucketWebsite</code> permission.</p>
|
|
33
|
+
* <p>Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket
|
|
34
|
+
* as website by adding a website configuration. For more information about hosting websites, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a>. </p>
|
|
35
|
+
* <p>This GET action requires the <code>S3:GetBucketWebsite</code> permission. By default, only the
|
|
36
|
+
* bucket owner can read the bucket website configuration. However, bucket owners can allow other users to
|
|
37
|
+
* read the website configuration by writing a bucket policy granting them the
|
|
38
|
+
* <code>S3:GetBucketWebsite</code> permission.</p>
|
|
40
39
|
* <p>The following operations are related to <code>GetBucketWebsite</code>:</p>
|
|
41
40
|
* <ul>
|
|
42
41
|
* <li>
|
|
@@ -31,20 +31,18 @@ declare const GetObjectAclCommand_base: {
|
|
|
31
31
|
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Returns the access control list (ACL) of an object. To use this operation, you must have
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
34
|
+
* <code>s3:GetObjectAcl</code> permissions or <code>READ_ACP</code> access to the object. For more
|
|
35
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#acl-access-policy-permission-mapping">Mapping of ACL
|
|
36
|
+
* permissions and access policy permissions</a> in the <i>Amazon S3 User Guide</i>
|
|
37
37
|
* </p>
|
|
38
38
|
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
39
|
-
* <p>By default, GET returns ACL information about the current version of an object. To
|
|
40
|
-
*
|
|
39
|
+
* <p>By default, GET returns ACL information about the current version of an object. To return ACL
|
|
40
|
+
* information about a different version, use the versionId subresource.</p>
|
|
41
41
|
* <note>
|
|
42
|
-
* <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership,
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
* ownership and disabling ACLs</a> in the
|
|
47
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
42
|
+
* <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read
|
|
43
|
+
* ACLs are still supported and return the <code>bucket-owner-full-control</code> ACL with the owner
|
|
44
|
+
* being the account that created the bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling object ownership and
|
|
45
|
+
* disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
48
46
|
* </note>
|
|
49
47
|
* <p>The following operations are related to <code>GetObjectAcl</code>:</p>
|
|
50
48
|
* <ul>
|
|
@@ -27,16 +27,15 @@ declare const GetObjectAttributesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves all of the metadata from an object without returning the object itself. This
|
|
31
|
-
*
|
|
30
|
+
* <p>Retrieves all of the metadata from an object without returning the object itself. This operation is
|
|
31
|
+
* useful if you're interested only in an object's metadata. </p>
|
|
32
32
|
* <p>
|
|
33
|
-
* <code>GetObjectAttributes</code> combines the functionality of <code>HeadObject</code>
|
|
34
|
-
*
|
|
35
|
-
*
|
|
33
|
+
* <code>GetObjectAttributes</code> combines the functionality of <code>HeadObject</code> and
|
|
34
|
+
* <code>ListParts</code>. All of the data returned with both of those individual calls can be returned
|
|
35
|
+
* with a single call to <code>GetObjectAttributes</code>.</p>
|
|
36
36
|
* <note>
|
|
37
37
|
* <p>
|
|
38
|
-
* <b>Directory buckets</b> -
|
|
39
|
-
* 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>
|
|
38
|
+
* <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>
|
|
40
39
|
* </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
|
|
41
40
|
* <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
|
|
42
41
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -47,37 +46,33 @@ declare const GetObjectAttributesCommand_base: {
|
|
|
47
46
|
* <ul>
|
|
48
47
|
* <li>
|
|
49
48
|
* <p>
|
|
50
|
-
* <b>General purpose bucket permissions</b> - To
|
|
51
|
-
*
|
|
52
|
-
* <p>The other permissions that you need to use this operation depend on
|
|
53
|
-
*
|
|
49
|
+
* <b>General purpose bucket permissions</b> - To use
|
|
50
|
+
* <code>GetObjectAttributes</code>, you must have READ access to the object.</p>
|
|
51
|
+
* <p>The other permissions that you need to use this operation depend on whether the bucket is
|
|
52
|
+
* versioned and if a version ID is passed in the <code>GetObjectAttributes</code> request. </p>
|
|
54
53
|
* <ul>
|
|
55
54
|
* <li>
|
|
56
|
-
* <p>If you pass a version ID in your request, you need both the
|
|
57
|
-
*
|
|
55
|
+
* <p>If you pass a version ID in your request, you need both the
|
|
56
|
+
* <code>s3:GetObjectVersion</code> and <code>s3:GetObjectVersionAttributes</code>
|
|
57
|
+
* permissions.</p>
|
|
58
58
|
* </li>
|
|
59
59
|
* <li>
|
|
60
60
|
* <p>If you do not pass a version ID in your request, you need the
|
|
61
|
-
*
|
|
62
|
-
* permissions. </p>
|
|
61
|
+
* <code>s3:GetObject</code> and <code>s3:GetObjectAttributes</code> permissions. </p>
|
|
63
62
|
* </li>
|
|
64
63
|
* </ul>
|
|
65
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
* not exist, the error Amazon S3 returns depends on whether you also have the
|
|
70
|
-
* <code>s3:ListBucket</code> permission.</p>
|
|
64
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
|
|
65
|
+
* Policy</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
66
|
+
* <p>If the object that you request does not exist, the error Amazon S3 returns depends on whether
|
|
67
|
+
* you also have the <code>s3:ListBucket</code> permission.</p>
|
|
71
68
|
* <ul>
|
|
72
69
|
* <li>
|
|
73
|
-
* <p>If you have the <code>s3:ListBucket</code> permission on the
|
|
74
|
-
*
|
|
75
|
-
* ("no such key") error.</p>
|
|
70
|
+
* <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns an
|
|
71
|
+
* HTTP status code <code>404 Not Found</code> ("no such key") error.</p>
|
|
76
72
|
* </li>
|
|
77
73
|
* <li>
|
|
78
|
-
* <p>If you don't have the <code>s3:ListBucket</code> permission, Amazon S3
|
|
79
|
-
*
|
|
80
|
-
* denied") error.</p>
|
|
74
|
+
* <p>If you don't have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP
|
|
75
|
+
* status code <code>403 Forbidden</code> ("access denied") error.</p>
|
|
81
76
|
* </li>
|
|
82
77
|
* </ul>
|
|
83
78
|
* </li>
|
|
@@ -90,34 +85,30 @@ declare const GetObjectAttributesCommand_base: {
|
|
|
90
85
|
* <code>CreateSession</code>
|
|
91
86
|
* </a>.</p>
|
|
92
87
|
* <p>If
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
* key.</p>
|
|
88
|
+
* the
|
|
89
|
+
* object is encrypted with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and
|
|
90
|
+
* <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies
|
|
91
|
+
* for the KMS key.</p>
|
|
98
92
|
* </li>
|
|
99
93
|
* </ul>
|
|
100
94
|
* </dd>
|
|
101
95
|
* <dt>Encryption</dt>
|
|
102
96
|
* <dd>
|
|
103
97
|
* <note>
|
|
104
|
-
* <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>,
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
* error. It's because the encryption method can't be changed when you retrieve
|
|
114
|
-
* the object.</p>
|
|
98
|
+
* <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not be
|
|
99
|
+
* sent for <code>HEAD</code> requests if your object uses server-side encryption with Key Management Service
|
|
100
|
+
* (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or
|
|
101
|
+
* server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The
|
|
102
|
+
* <code>x-amz-server-side-encryption</code> header is used when you <code>PUT</code> an object
|
|
103
|
+
* to S3 and want to specify the encryption method. If you include this header in a
|
|
104
|
+
* <code>GET</code> request for an object that uses these types of keys, you’ll get an HTTP
|
|
105
|
+
* <code>400 Bad Request</code> error. It's because the encryption method can't be changed when
|
|
106
|
+
* you retrieve the object.</p>
|
|
115
107
|
* </note>
|
|
116
|
-
* <p>If you encrypted an object when you stored the object in Amazon S3 by using server-side encryption
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
* headers are: </p>
|
|
108
|
+
* <p>If you encrypted an object when you stored the object in Amazon S3 by using server-side encryption
|
|
109
|
+
* with customer-provided encryption keys (SSE-C), then when you retrieve the metadata from the
|
|
110
|
+
* object, you must use the following headers. These headers provide the server with the encryption
|
|
111
|
+
* key required to retrieve the object's metadata. The headers are: </p>
|
|
121
112
|
* <ul>
|
|
122
113
|
* <li>
|
|
123
114
|
* <p>
|
|
@@ -135,13 +126,12 @@ declare const GetObjectAttributesCommand_base: {
|
|
|
135
126
|
* </p>
|
|
136
127
|
* </li>
|
|
137
128
|
* </ul>
|
|
138
|
-
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side
|
|
139
|
-
*
|
|
140
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
129
|
+
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption (Using
|
|
130
|
+
* Customer-Provided Encryption Keys)</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
141
131
|
* <note>
|
|
142
132
|
* <p>
|
|
143
133
|
* <b>Directory bucket permissions</b> -
|
|
144
|
-
*
|
|
134
|
+
* For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your
|
|
145
135
|
* <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects
|
|
146
136
|
* are automatically encrypted with the desired encryption settings. For more
|
|
147
137
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about the encryption overriding behaviors in directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html">Specifying server-side encryption with KMS for new object uploads</a>.</p>
|
|
@@ -150,47 +140,42 @@ declare const GetObjectAttributesCommand_base: {
|
|
|
150
140
|
* <dt>Versioning</dt>
|
|
151
141
|
* <dd>
|
|
152
142
|
* <p>
|
|
153
|
-
* <b>Directory buckets</b> -
|
|
154
|
-
*
|
|
155
|
-
*
|
|
143
|
+
* <b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <code>null</code> value of the version ID is supported by directory buckets.
|
|
144
|
+
* You can only specify <code>null</code> to the <code>versionId</code> query parameter in the
|
|
145
|
+
* request.</p>
|
|
156
146
|
* </dd>
|
|
157
147
|
* <dt>Conditional request headers</dt>
|
|
158
148
|
* <dd>
|
|
159
149
|
* <p>Consider the following when using request headers:</p>
|
|
160
150
|
* <ul>
|
|
161
151
|
* <li>
|
|
162
|
-
* <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code>
|
|
163
|
-
*
|
|
164
|
-
*
|
|
152
|
+
* <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are
|
|
153
|
+
* present in the request as follows, then Amazon S3 returns the HTTP status code <code>200 OK</code>
|
|
154
|
+
* and the data requested:</p>
|
|
165
155
|
* <ul>
|
|
166
156
|
* <li>
|
|
167
157
|
* <p>
|
|
168
|
-
* <code>If-Match</code> condition evaluates to
|
|
169
|
-
* <code>true</code>.</p>
|
|
158
|
+
* <code>If-Match</code> condition evaluates to <code>true</code>.</p>
|
|
170
159
|
* </li>
|
|
171
160
|
* <li>
|
|
172
161
|
* <p>
|
|
173
|
-
* <code>If-Unmodified-Since</code> condition evaluates to
|
|
174
|
-
* <code>false</code>.</p>
|
|
162
|
+
* <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>.</p>
|
|
175
163
|
* </li>
|
|
176
164
|
* </ul>
|
|
177
165
|
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
|
|
178
166
|
* </li>
|
|
179
167
|
* <li>
|
|
180
|
-
* <p>If both of the <code>If-None-Match</code> and
|
|
181
|
-
*
|
|
182
|
-
*
|
|
183
|
-
* Modified</code>:</p>
|
|
168
|
+
* <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are
|
|
169
|
+
* present in the request as follows, then Amazon S3 returns the HTTP status code <code>304 Not
|
|
170
|
+
* Modified</code>:</p>
|
|
184
171
|
* <ul>
|
|
185
172
|
* <li>
|
|
186
173
|
* <p>
|
|
187
|
-
* <code>If-None-Match</code> condition evaluates to
|
|
188
|
-
* <code>false</code>.</p>
|
|
174
|
+
* <code>If-None-Match</code> condition evaluates to <code>false</code>.</p>
|
|
189
175
|
* </li>
|
|
190
176
|
* <li>
|
|
191
177
|
* <p>
|
|
192
|
-
* <code>If-Modified-Since</code> condition evaluates to
|
|
193
|
-
* <code>true</code>.</p>
|
|
178
|
+
* <code>If-Modified-Since</code> condition evaluates to <code>true</code>.</p>
|
|
194
179
|
* </li>
|
|
195
180
|
* </ul>
|
|
196
181
|
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
|