@aws-sdk/client-s3 3.325.0 → 3.327.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.
Files changed (96) hide show
  1. package/dist-types/commands/AbortMultipartUploadCommand.d.ts +8 -2
  2. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +41 -14
  3. package/dist-types/commands/CopyObjectCommand.d.ts +194 -144
  4. package/dist-types/commands/CreateBucketCommand.d.ts +134 -118
  5. package/dist-types/commands/CreateMultipartUploadCommand.d.ts +91 -48
  6. package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +6 -2
  7. package/dist-types/commands/DeleteBucketCommand.d.ts +5 -3
  8. package/dist-types/commands/DeleteBucketCorsCommand.d.ts +7 -5
  9. package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +12 -8
  10. package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +5 -2
  11. package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +6 -2
  12. package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +5 -2
  13. package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +9 -5
  14. package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +6 -2
  15. package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +10 -3
  16. package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +8 -3
  17. package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +4 -0
  19. package/dist-types/commands/DeleteObjectCommand.d.ts +19 -11
  20. package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +8 -4
  21. package/dist-types/commands/DeleteObjectsCommand.d.ts +57 -36
  22. package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +6 -2
  23. package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +12 -7
  24. package/dist-types/commands/GetBucketAclCommand.d.ts +35 -10
  25. package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +43 -7
  26. package/dist-types/commands/GetBucketCorsCommand.d.ts +28 -0
  27. package/dist-types/commands/GetBucketEncryptionCommand.d.ts +23 -7
  28. package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +32 -2
  29. package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +35 -2
  30. package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +62 -4
  31. package/dist-types/commands/GetBucketLocationCommand.d.ts +16 -2
  32. package/dist-types/commands/GetBucketLoggingCommand.d.ts +22 -1
  33. package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +31 -6
  34. package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +70 -2
  35. package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +16 -3
  36. package/dist-types/commands/GetBucketPolicyCommand.d.ts +17 -3
  37. package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +9 -1
  38. package/dist-types/commands/GetBucketReplicationCommand.d.ts +69 -0
  39. package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +8 -1
  40. package/dist-types/commands/GetBucketTaggingCommand.d.ts +11 -0
  41. package/dist-types/commands/GetBucketVersioningCommand.d.ts +7 -0
  42. package/dist-types/commands/GetBucketWebsiteCommand.d.ts +32 -3
  43. package/dist-types/commands/GetObjectAclCommand.d.ts +27 -7
  44. package/dist-types/commands/GetObjectAttributesCommand.d.ts +77 -45
  45. package/dist-types/commands/GetObjectCommand.d.ts +159 -112
  46. package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +8 -0
  47. package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +16 -2
  48. package/dist-types/commands/GetObjectRetentionCommand.d.ts +11 -1
  49. package/dist-types/commands/GetObjectTaggingCommand.d.ts +17 -5
  50. package/dist-types/commands/GetObjectTorrentCommand.d.ts +8 -1
  51. package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +12 -1
  52. package/dist-types/commands/HeadBucketCommand.d.ts +23 -9
  53. package/dist-types/commands/HeadObjectCommand.d.ts +77 -33
  54. package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +46 -4
  55. package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +37 -2
  56. package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +43 -5
  57. package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +37 -7
  58. package/dist-types/commands/ListBucketsCommand.d.ts +18 -32
  59. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +39 -2
  60. package/dist-types/commands/ListObjectVersionsCommand.d.ts +53 -6
  61. package/dist-types/commands/ListObjectsCommand.d.ts +34 -0
  62. package/dist-types/commands/ListObjectsV2Command.d.ts +47 -12
  63. package/dist-types/commands/ListPartsCommand.d.ts +40 -4
  64. package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +8 -3
  65. package/dist-types/commands/PutBucketAclCommand.d.ts +118 -111
  66. package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +11 -10
  67. package/dist-types/commands/PutBucketCorsCommand.d.ts +7 -5
  68. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +21 -17
  69. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +35 -59
  70. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +54 -65
  71. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +68 -62
  72. package/dist-types/commands/PutBucketLoggingCommand.d.ts +49 -39
  73. package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +8 -4
  74. package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +13 -12
  75. package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +8 -2
  76. package/dist-types/commands/PutBucketPolicyCommand.d.ts +12 -4
  77. package/dist-types/commands/PutBucketReplicationCommand.d.ts +35 -28
  78. package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +5 -1
  79. package/dist-types/commands/PutBucketTaggingCommand.d.ts +16 -12
  80. package/dist-types/commands/PutBucketVersioningCommand.d.ts +11 -9
  81. package/dist-types/commands/PutBucketWebsiteCommand.d.ts +4 -0
  82. package/dist-types/commands/PutObjectAclCommand.d.ts +129 -119
  83. package/dist-types/commands/PutObjectCommand.d.ts +94 -84
  84. package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +6 -0
  85. package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +13 -8
  86. package/dist-types/commands/PutObjectRetentionCommand.d.ts +9 -4
  87. package/dist-types/commands/PutObjectTaggingCommand.d.ts +13 -9
  88. package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +6 -4
  89. package/dist-types/commands/RestoreObjectCommand.d.ts +182 -199
  90. package/dist-types/commands/SelectObjectContentCommand.d.ts +109 -90
  91. package/dist-types/commands/UploadPartCommand.d.ts +42 -22
  92. package/dist-types/commands/UploadPartCopyCommand.d.ts +85 -63
  93. package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +36 -21
  94. package/dist-types/models/models_0.d.ts +468 -382
  95. package/dist-types/models/models_1.d.ts +82 -80
  96. package/package.json +9 -9
@@ -40,34 +40,37 @@ export interface PutBucketReplicationCommandOutput extends __MetadataBearer {
40
40
  * replication of delete markers differently. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations">Backward Compatibility</a>.</p>
41
41
  * </note>
42
42
  * <p>For information about enabling versioning on a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html">Using Versioning</a>.</p>
43
- * <p>
44
- * <b>Handling Replication of Encrypted Objects</b>
45
- * </p>
46
- * <p>By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side
47
- * encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the
48
- * following: <code>SourceSelectionCriteria</code>, <code>SseKmsEncryptedObjects</code>,
49
- * <code>Status</code>, <code>EncryptionConfiguration</code>, and
50
- * <code>ReplicaKmsKeyID</code>. For information about replication configuration, see
51
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html">Replicating Objects
52
- * Created with SSE Using KMS keys</a>.</p>
53
- * <p>For information on <code>PutBucketReplication</code> errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList">List of
54
- * replication-related error codes</a>
55
- * </p>
56
- * <p>
57
- * <b>Permissions</b>
58
- * </p>
59
- * <p>To create a <code>PutBucketReplication</code> request, you must have <code>s3:PutReplicationConfiguration</code>
60
- * permissions for the bucket.
61
- * </p>
62
- * <p>By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can
63
- * perform this operation. The resource owner can also grant others permissions to perform the
64
- * operation. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a>
65
- * and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your
66
- * Amazon S3 Resources</a>.</p>
67
- * <note>
68
- * <p>To perform this operation, the user or role performing the action must have the
69
- * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">iam:PassRole</a> permission.</p>
70
- * </note>
43
+ * <dl>
44
+ * <dt>Handling Replication of Encrypted Objects</dt>
45
+ * <dd>
46
+ * <p>By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side
47
+ * encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following:
48
+ * <code>SourceSelectionCriteria</code>, <code>SseKmsEncryptedObjects</code>,
49
+ * <code>Status</code>, <code>EncryptionConfiguration</code>, and
50
+ * <code>ReplicaKmsKeyID</code>. For information about replication configuration, see
51
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html">Replicating Objects
52
+ * Created with SSE Using KMS keys</a>.</p>
53
+ * <p>For information on <code>PutBucketReplication</code> errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList">List of
54
+ * replication-related error codes</a>
55
+ * </p>
56
+ * </dd>
57
+ * <dt>Permissions</dt>
58
+ * <dd>
59
+ * <p>To create a <code>PutBucketReplication</code> request, you must have
60
+ * <code>s3:PutReplicationConfiguration</code> permissions for the bucket.
61
+ *
62
+ * </p>
63
+ * <p>By default, a resource owner, in this case the Amazon Web Services account that created the bucket,
64
+ * can perform this operation. The resource owner can also grant others permissions to perform
65
+ * the operation. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
66
+ * Policy</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to
67
+ * Your Amazon S3 Resources</a>.</p>
68
+ * <note>
69
+ * <p>To perform this operation, the user or role performing the action must have the
70
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">iam:PassRole</a> permission.</p>
71
+ * </note>
72
+ * </dd>
73
+ * </dl>
71
74
  * <p>The following operations are related to <code>PutBucketReplication</code>:</p>
72
75
  * <ul>
73
76
  * <li>
@@ -160,6 +163,8 @@ export interface PutBucketReplicationCommandOutput extends __MetadataBearer {
160
163
  * };
161
164
  * const command = new PutBucketReplicationCommand(input);
162
165
  * const response = await client.send(command);
166
+ * // {};
167
+ *
163
168
  * ```
164
169
  *
165
170
  * @param PutBucketReplicationCommandInput - {@link PutBucketReplicationCommandInput}
@@ -168,6 +173,8 @@ export interface PutBucketReplicationCommandOutput extends __MetadataBearer {
168
173
  * @see {@link PutBucketReplicationCommandOutput} for command's `response` shape.
169
174
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
170
175
  *
176
+ * @throws {@link S3ServiceException}
177
+ * <p>Base exception class for all service exceptions from S3 service.</p>
171
178
  *
172
179
  * @example Set replication configuration on a bucket
173
180
  * ```javascript
@@ -23,7 +23,7 @@ export interface PutBucketRequestPaymentCommandOutput extends __MetadataBearer {
23
23
  * for downloads from the bucket. This configuration parameter enables the bucket owner (only)
24
24
  * to specify that the person requesting the download will be charged for the download. For
25
25
  * more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays
26
- * Buckets</a>.</p>
26
+ * Buckets</a>.</p>
27
27
  * <p>The following operations are related to <code>PutBucketRequestPayment</code>:</p>
28
28
  * <ul>
29
29
  * <li>
@@ -54,6 +54,8 @@ export interface PutBucketRequestPaymentCommandOutput extends __MetadataBearer {
54
54
  * };
55
55
  * const command = new PutBucketRequestPaymentCommand(input);
56
56
  * const response = await client.send(command);
57
+ * // {};
58
+ *
57
59
  * ```
58
60
  *
59
61
  * @param PutBucketRequestPaymentCommandInput - {@link PutBucketRequestPaymentCommandInput}
@@ -62,6 +64,8 @@ export interface PutBucketRequestPaymentCommandOutput extends __MetadataBearer {
62
64
  * @see {@link PutBucketRequestPaymentCommandOutput} for command's `response` shape.
63
65
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
64
66
  *
67
+ * @throws {@link S3ServiceException}
68
+ * <p>Base exception class for all service exceptions from S3 service.</p>
65
69
  *
66
70
  * @example Set request payment configuration on a bucket.
67
71
  * ```javascript
@@ -20,23 +20,23 @@ export interface PutBucketTaggingCommandOutput extends __MetadataBearer {
20
20
  /**
21
21
  * @public
22
22
  * <p>Sets the tags for a bucket.</p>
23
- * <p>Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign
24
- * up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of
25
- * combined resources, organize your billing information according to resources with the same
26
- * tag key values. For example, you can tag several resources with a specific application
23
+ * <p>Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,
24
+ * sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost
25
+ * of combined resources, organize your billing information according to resources with the
26
+ * same tag key values. For example, you can tag several resources with a specific application
27
27
  * name, and then organize your billing information to see the total cost of that application
28
- * across several services. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Cost Allocation
29
- * and Tagging</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html">Using Cost Allocation in Amazon S3 Bucket
30
- * Tags</a>.</p>
28
+ * across several services. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Cost Allocation and
29
+ * Tagging</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html">Using Cost Allocation in Amazon S3 Bucket
30
+ * Tags</a>.</p>
31
31
  * <note>
32
- * <p>
33
- * When this operation sets the tags for a bucket, it will overwrite any current tags the
34
- * bucket already has. You cannot use this operation to add tags to an existing list of tags.</p>
32
+ * <p> When this operation sets the tags for a bucket, it will overwrite any current tags
33
+ * the bucket already has. You cannot use this operation to add tags to an existing list of
34
+ * tags.</p>
35
35
  * </note>
36
36
  * <p>To use this operation, you must have permissions to perform the
37
37
  * <code>s3:PutBucketTagging</code> action. The bucket owner has this permission by default
38
- * and 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
39
- * Resources</a>.</p>
38
+ * and 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
39
+ * Access Permissions to Your Amazon S3 Resources</a>.</p>
40
40
  * <p>
41
41
  * <code>PutBucketTagging</code> has the following special errors:</p>
42
42
  * <ul>
@@ -116,6 +116,8 @@ export interface PutBucketTaggingCommandOutput extends __MetadataBearer {
116
116
  * };
117
117
  * const command = new PutBucketTaggingCommand(input);
118
118
  * const response = await client.send(command);
119
+ * // {};
120
+ *
119
121
  * ```
120
122
  *
121
123
  * @param PutBucketTaggingCommandInput - {@link PutBucketTaggingCommandInput}
@@ -124,6 +126,8 @@ export interface PutBucketTaggingCommandOutput extends __MetadataBearer {
124
126
  * @see {@link PutBucketTaggingCommandOutput} for command's `response` shape.
125
127
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
126
128
  *
129
+ * @throws {@link S3ServiceException}
130
+ * <p>Base exception class for all service exceptions from S3 service.</p>
127
131
  *
128
132
  * @example Set tags on a bucket
129
133
  * ```javascript
@@ -30,21 +30,19 @@ export interface PutBucketVersioningCommandOutput extends __MetadataBearer {
30
30
  * <p>If the versioning state has never been set on a bucket, it has no versioning state; a
31
31
  * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a> request does not return a versioning state value.</p>
32
32
  * <p>In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner
33
- * and want to enable MFA Delete in the bucket versioning configuration, you must
34
- * include the <code>x-amz-mfa request</code> header and the
35
- * <code>Status</code> and the <code>MfaDelete</code> request elements in a request to set
36
- * the versioning state of the bucket.</p>
33
+ * and want to enable MFA Delete in the bucket versioning configuration, you must include the
34
+ * <code>x-amz-mfa request</code> header and the <code>Status</code> and the
35
+ * <code>MfaDelete</code> request elements in a request to set the versioning state of the
36
+ * bucket.</p>
37
37
  * <important>
38
- * <p>If you have an object expiration lifecycle policy in your non-versioned bucket and
38
+ * <p>If you have an object expiration lifecycle configuration in your non-versioned bucket and
39
39
  * you want to maintain the same permanent delete behavior when you enable versioning, you
40
- * must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will
40
+ * must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will
41
41
  * manage the deletes of the noncurrent object versions in the version-enabled bucket. (A
42
42
  * version-enabled bucket maintains one current and zero or more noncurrent object
43
43
  * versions.) For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config">Lifecycle and Versioning</a>.</p>
44
44
  * </important>
45
- * <p class="title">
46
- * <b>Related Resources</b>
47
- * </p>
45
+ * <p>The following operations are related to <code>PutBucketVersioning</code>:</p>
48
46
  * <ul>
49
47
  * <li>
50
48
  * <p>
@@ -81,6 +79,8 @@ export interface PutBucketVersioningCommandOutput extends __MetadataBearer {
81
79
  * };
82
80
  * const command = new PutBucketVersioningCommand(input);
83
81
  * const response = await client.send(command);
82
+ * // {};
83
+ *
84
84
  * ```
85
85
  *
86
86
  * @param PutBucketVersioningCommandInput - {@link PutBucketVersioningCommandInput}
@@ -89,6 +89,8 @@ export interface PutBucketVersioningCommandOutput extends __MetadataBearer {
89
89
  * @see {@link PutBucketVersioningCommandOutput} for command's `response` shape.
90
90
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
91
91
  *
92
+ * @throws {@link S3ServiceException}
93
+ * <p>Base exception class for all service exceptions from S3 service.</p>
92
94
  *
93
95
  * @example Set versioning configuration on a bucket
94
96
  * ```javascript
@@ -182,6 +182,8 @@ export interface PutBucketWebsiteCommandOutput extends __MetadataBearer {
182
182
  * };
183
183
  * const command = new PutBucketWebsiteCommand(input);
184
184
  * const response = await client.send(command);
185
+ * // {};
186
+ *
185
187
  * ```
186
188
  *
187
189
  * @param PutBucketWebsiteCommandInput - {@link PutBucketWebsiteCommandInput}
@@ -190,6 +192,8 @@ export interface PutBucketWebsiteCommandOutput extends __MetadataBearer {
190
192
  * @see {@link PutBucketWebsiteCommandOutput} for command's `response` shape.
191
193
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
192
194
  *
195
+ * @throws {@link S3ServiceException}
196
+ * <p>Base exception class for all service exceptions from S3 service.</p>
193
197
  *
194
198
  * @example Set website configuration on a bucket
195
199
  * ```javascript
@@ -24,54 +24,131 @@ export interface PutObjectAclCommandOutput extends PutObjectAclOutput, __Metadat
24
24
  * permission to set the ACL of an object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#permissions">What
25
25
  * permissions can I grant?</a> in the <i>Amazon S3 User Guide</i>.</p>
26
26
  * <p>This action is not supported by Amazon S3 on Outposts.</p>
27
- * <p>Depending on your application needs, you can choose to set
28
- * the ACL on an object using either the request body or the headers. For example, if you have
29
- * an existing application that updates a bucket ACL using the request body, you can continue
30
- * to use that approach. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a> in the <i>Amazon S3 User Guide</i>.</p>
27
+ * <p>Depending on your application needs, you can choose to set the ACL on an object using
28
+ * either the request body or the headers. For example, if you have an existing application
29
+ * that updates a bucket ACL using the request body, you can continue to use that approach.
30
+ * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>
31
+ * in the <i>Amazon S3 User Guide</i>.</p>
31
32
  * <important>
32
- * <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions.
33
- * You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and
34
- * return the <code>AccessControlListNotSupported</code> error code. Requests to read ACLs are still supported.
35
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object ownership</a>
36
- * in the <i>Amazon S3 User Guide</i>.</p>
33
+ * <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs
34
+ * are disabled and no longer affect permissions. You must use policies to grant access to
35
+ * your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return
36
+ * the <code>AccessControlListNotSupported</code> error code. Requests to read ACLs are
37
+ * still supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object
38
+ * ownership</a> in the <i>Amazon S3 User Guide</i>.</p>
37
39
  * </important>
38
- * <p>
39
- * <b>Access Permissions</b>
40
- * </p>
41
- * <p>You can set access permissions using one of the following methods:</p>
42
- * <ul>
43
- * <li>
44
- * <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 supports
45
- * a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set
46
- * of grantees and permissions. Specify the canned ACL name as the value of
47
- * <code>x-amz-ac</code>l. If you use this header, you cannot use other access
48
- * control-specific 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>
49
- * </li>
50
- * <li>
51
- * <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>,
52
- * <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and
53
- * <code>x-amz-grant-full-control</code> headers. When using these headers, you
54
- * specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who
55
- * will receive the permission. If you use these ACL-specific headers, you cannot use
56
- * <code>x-amz-acl</code> header to set a canned ACL. These parameters map to the set
57
- * of permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL)
58
- * Overview</a>.</p>
59
- * <p>You specify each grantee as a type=value pair, where the type is one of the
60
- * following:</p>
40
+ * <dl>
41
+ * <dt>Permissions</dt>
42
+ * <dd>
43
+ * <p>You can set access permissions using one of the following methods:</p>
61
44
  * <ul>
62
45
  * <li>
46
+ * <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 supports
47
+ * a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set
48
+ * of grantees and permissions. Specify the canned ACL name as the value of
49
+ * <code>x-amz-ac</code>l. If you use this header, you cannot use other access
50
+ * control-specific headers in your request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
51
+ * ACL</a>.</p>
52
+ * </li>
53
+ * <li>
54
+ * <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>,
55
+ * <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and
56
+ * <code>x-amz-grant-full-control</code> headers. When using these headers, you
57
+ * specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who
58
+ * will receive the permission. If you use these ACL-specific headers, you cannot use
59
+ * <code>x-amz-acl</code> header to set a canned ACL. These parameters map to the set
60
+ * of permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control
61
+ * List (ACL) Overview</a>.</p>
62
+ * <p>You specify each grantee as a type=value pair, where the type is one of the
63
+ * following:</p>
64
+ * <ul>
65
+ * <li>
66
+ * <p>
67
+ * <code>id</code> – if the value specified is the canonical user ID of an
68
+ * Amazon Web Services account</p>
69
+ * </li>
70
+ * <li>
71
+ * <p>
72
+ * <code>uri</code> – if you are granting permissions to a predefined
73
+ * group</p>
74
+ * </li>
75
+ * <li>
76
+ * <p>
77
+ * <code>emailAddress</code> – if the value specified is the email address of
78
+ * an Amazon Web Services account</p>
79
+ * <note>
80
+ * <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
81
+ * <ul>
82
+ * <li>
83
+ * <p>US East (N. Virginia)</p>
84
+ * </li>
85
+ * <li>
86
+ * <p>US West (N. California)</p>
87
+ * </li>
88
+ * <li>
89
+ * <p> US West (Oregon)</p>
90
+ * </li>
91
+ * <li>
92
+ * <p> Asia Pacific (Singapore)</p>
93
+ * </li>
94
+ * <li>
95
+ * <p>Asia Pacific (Sydney)</p>
96
+ * </li>
97
+ * <li>
98
+ * <p>Asia Pacific (Tokyo)</p>
99
+ * </li>
100
+ * <li>
101
+ * <p>Europe (Ireland)</p>
102
+ * </li>
103
+ * <li>
104
+ * <p>South America (São Paulo)</p>
105
+ * </li>
106
+ * </ul>
107
+ * <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p>
108
+ * </note>
109
+ * </li>
110
+ * </ul>
111
+ * <p>For example, the following <code>x-amz-grant-read</code> header grants list
112
+ * objects permission to the two Amazon Web Services accounts identified by their email
113
+ * addresses.</p>
63
114
  * <p>
64
- * <code>id</code> – if the value specified is the canonical user ID of an Amazon Web Services account</p>
115
+ * <code>x-amz-grant-read: emailAddress="xyz@amazon.com",
116
+ * emailAddress="abc@amazon.com" </code>
117
+ * </p>
65
118
  * </li>
119
+ * </ul>
120
+ * <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do
121
+ * both.</p>
122
+ * </dd>
123
+ * <dt>Grantee Values</dt>
124
+ * <dd>
125
+ * <p>You can specify the person (grantee) to whom you're assigning access rights (using
126
+ * request elements) in the following ways:</p>
127
+ * <ul>
66
128
  * <li>
129
+ * <p>By the person's ID:</p>
67
130
  * <p>
68
- * <code>uri</code> – if you are granting permissions to a predefined
69
- * group</p>
131
+ * <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
132
+ * xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
133
+ * </Grantee></code>
134
+ * </p>
135
+ * <p>DisplayName is optional and ignored in the request.</p>
70
136
  * </li>
71
137
  * <li>
138
+ * <p>By URI:</p>
72
139
  * <p>
73
- * <code>emailAddress</code> – if the value specified is the email address of
74
- * an Amazon Web Services account</p>
140
+ * <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
141
+ * xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code>
142
+ * </p>
143
+ * </li>
144
+ * <li>
145
+ * <p>By Email address:</p>
146
+ * <p>
147
+ * <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
148
+ * xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee></code>
149
+ * </p>
150
+ * <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object
151
+ * acl request, appears as the CanonicalUser.</p>
75
152
  * <note>
76
153
  * <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
77
154
  * <ul>
@@ -104,88 +181,15 @@ export interface PutObjectAclCommandOutput extends PutObjectAclOutput, __Metadat
104
181
  * </note>
105
182
  * </li>
106
183
  * </ul>
107
- * <p>For example, the following <code>x-amz-grant-read</code> header grants list
108
- * objects permission to the two Amazon Web Services accounts identified by their email
109
- * addresses.</p>
110
- * <p>
111
- * <code>x-amz-grant-read: emailAddress="xyz@amazon.com",
112
- * emailAddress="abc@amazon.com" </code>
113
- * </p>
114
- * </li>
115
- * </ul>
116
- * <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do
117
- * both.</p>
118
- * <p>
119
- * <b>Grantee Values</b>
120
- * </p>
121
- * <p>You can specify the person (grantee) to whom you're assigning access rights (using
122
- * request elements) in the following ways:</p>
123
- * <ul>
124
- * <li>
125
- * <p>By the person's ID:</p>
126
- * <p>
127
- * <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
128
- * xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
129
- * </Grantee></code>
130
- * </p>
131
- * <p>DisplayName is optional and ignored in the request.</p>
132
- * </li>
133
- * <li>
134
- * <p>By URI:</p>
135
- * <p>
136
- * <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
137
- * xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code>
138
- * </p>
139
- * </li>
140
- * <li>
141
- * <p>By Email address:</p>
142
- * <p>
143
- * <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
144
- * xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee></code>
145
- * </p>
146
- * <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object
147
- * acl request, appears as the CanonicalUser.</p>
148
- * <note>
149
- * <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
150
- * <ul>
151
- * <li>
152
- * <p>US East (N. Virginia)</p>
153
- * </li>
154
- * <li>
155
- * <p>US West (N. California)</p>
156
- * </li>
157
- * <li>
158
- * <p> US West (Oregon)</p>
159
- * </li>
160
- * <li>
161
- * <p> Asia Pacific (Singapore)</p>
162
- * </li>
163
- * <li>
164
- * <p>Asia Pacific (Sydney)</p>
165
- * </li>
166
- * <li>
167
- * <p>Asia Pacific (Tokyo)</p>
168
- * </li>
169
- * <li>
170
- * <p>Europe (Ireland)</p>
171
- * </li>
172
- * <li>
173
- * <p>South America (São Paulo)</p>
174
- * </li>
175
- * </ul>
176
- * <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p>
177
- * </note>
178
- * </li>
179
- * </ul>
180
- * <p>
181
- * <b>Versioning</b>
182
- * </p>
183
- * <p>The ACL of an object is set at the object version level. By default, PUT sets the ACL of
184
- * the current version of an object. To set the ACL of a different version, use the
185
- * <code>versionId</code> subresource.</p>
186
- * <p class="title">
187
- * <b>Related Resources</b>
188
- * </p>
184
+ * </dd>
185
+ * <dt>Versioning</dt>
186
+ * <dd>
187
+ * <p>The ACL of an object is set at the object version level. By default, PUT sets the ACL of
188
+ * the current version of an object. To set the ACL of a different version, use the
189
+ * <code>versionId</code> subresource.</p>
190
+ * </dd>
191
+ * </dl>
192
+ * <p>The following operations are related to <code>PutObjectAcl</code>:</p>
189
193
  * <ul>
190
194
  * <li>
191
195
  * <p>
@@ -239,6 +243,10 @@ export interface PutObjectAclCommandOutput extends PutObjectAclOutput, __Metadat
239
243
  * };
240
244
  * const command = new PutObjectAclCommand(input);
241
245
  * const response = await client.send(command);
246
+ * // { // PutObjectAclOutput
247
+ * // RequestCharged: "requester",
248
+ * // };
249
+ *
242
250
  * ```
243
251
  *
244
252
  * @param PutObjectAclCommandInput - {@link PutObjectAclCommandInput}
@@ -250,6 +258,8 @@ export interface PutObjectAclCommandOutput extends PutObjectAclOutput, __Metadat
250
258
  * @throws {@link NoSuchKey} (client fault)
251
259
  * <p>The specified key does not exist.</p>
252
260
  *
261
+ * @throws {@link S3ServiceException}
262
+ * <p>Base exception class for all service exceptions from S3 service.</p>
253
263
  *
254
264
  * @example To grant permissions using object ACL
255
265
  * ```javascript