@aws-sdk/client-s3 3.414.0 → 3.417.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 (35) hide show
  1. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +6 -6
  2. package/dist-types/commands/CopyObjectCommand.d.ts +90 -76
  3. package/dist-types/commands/CreateBucketCommand.d.ts +63 -37
  4. package/dist-types/commands/CreateMultipartUploadCommand.d.ts +14 -12
  5. package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +3 -3
  6. package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +3 -2
  7. package/dist-types/commands/DeleteObjectsCommand.d.ts +2 -1
  8. package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +2 -1
  9. package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +2 -1
  10. package/dist-types/commands/GetBucketPolicyCommand.d.ts +5 -4
  11. package/dist-types/commands/GetObjectAttributesCommand.d.ts +15 -12
  12. package/dist-types/commands/GetObjectCommand.d.ts +44 -37
  13. package/dist-types/commands/HeadBucketCommand.d.ts +3 -3
  14. package/dist-types/commands/HeadObjectCommand.d.ts +11 -11
  15. package/dist-types/commands/PutBucketAclCommand.d.ts +41 -35
  16. package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +2 -1
  17. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +4 -8
  18. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +5 -4
  19. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +18 -18
  20. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +29 -25
  21. package/dist-types/commands/PutBucketLoggingCommand.d.ts +12 -10
  22. package/dist-types/commands/PutBucketPolicyCommand.d.ts +5 -4
  23. package/dist-types/commands/PutBucketReplicationCommand.d.ts +23 -17
  24. package/dist-types/commands/PutBucketTaggingCommand.d.ts +18 -35
  25. package/dist-types/commands/PutBucketVersioningCommand.d.ts +6 -6
  26. package/dist-types/commands/PutBucketWebsiteCommand.d.ts +1 -0
  27. package/dist-types/commands/PutObjectAclCommand.d.ts +39 -36
  28. package/dist-types/commands/PutObjectTaggingCommand.d.ts +21 -58
  29. package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +1 -1
  30. package/dist-types/commands/RestoreObjectCommand.d.ts +93 -91
  31. package/dist-types/commands/SelectObjectContentCommand.d.ts +46 -40
  32. package/dist-types/commands/UploadPartCopyCommand.d.ts +16 -14
  33. package/dist-types/models/models_0.d.ts +173 -110
  34. package/dist-types/models/models_1.d.ts +25 -13
  35. package/package.json +1 -1
@@ -82,33 +82,36 @@ export interface GetObjectCommandOutput extends Omit<GetObjectOutput, "Body">, _
82
82
  * <dl>
83
83
  * <dt>Permissions</dt>
84
84
  * <dd>
85
- * <p>You need the relevant read object (or version) permission for this operation. For more
86
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
87
- * Policy</a>. If the object that you request doesn’t exist, the error that Amazon S3 returns depends
88
- * on whether you also have the <code>s3:ListBucket</code> permission.</p>
85
+ * <p>You need the relevant read object (or version) permission for this operation.
86
+ * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in
87
+ * a Policy</a>. If the object that you request doesn’t exist, the error that
88
+ * Amazon S3 returns depends on whether you also have the <code>s3:ListBucket</code>
89
+ * permission.</p>
89
90
  * <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3
90
- * returns an HTTP status code 404 (Not Found) error.</p>
91
+ * returns an HTTP status code 404 (Not Found) error.</p>
91
92
  * <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an
92
- * HTTP status code 403 ("access denied") error.</p>
93
+ * HTTP status code 403 ("access denied") error.</p>
93
94
  * </dd>
94
95
  * <dt>Versioning</dt>
95
96
  * <dd>
96
- * <p>By default, the <code>GET</code> action returns the current version of an object. To return a
97
- * different version, use the <code>versionId</code> subresource.</p>
97
+ * <p>By default, the <code>GET</code> action returns the current version of an
98
+ * object. To return a different version, use the <code>versionId</code>
99
+ * subresource.</p>
98
100
  * <note>
99
101
  * <ul>
100
102
  * <li>
101
103
  * <p> If you supply a <code>versionId</code>, you need the
102
- * <code>s3:GetObjectVersion</code> permission to access a specific version of an
103
- * object. If you request a specific version, you do not need to have the
104
- * <code>s3:GetObject</code> permission. If you request the current version
105
- * without a specific version ID, only <code>s3:GetObject</code> permission is
106
- * required. <code>s3:GetObjectVersion</code> permission won't be required.</p>
104
+ * <code>s3:GetObjectVersion</code> permission to access a specific
105
+ * version of an object. If you request a specific version, you do not need
106
+ * to have the <code>s3:GetObject</code> permission. If you request the
107
+ * current version without a specific version ID, only
108
+ * <code>s3:GetObject</code> permission is required.
109
+ * <code>s3:GetObjectVersion</code> permission won't be required.</p>
107
110
  * </li>
108
111
  * <li>
109
- * <p>If the current version of the object is a delete marker, Amazon S3 behaves as if the
110
- * object was deleted and includes <code>x-amz-delete-marker: true</code> in the
111
- * response.</p>
112
+ * <p>If the current version of the object is a delete marker, Amazon S3 behaves
113
+ * as if the object was deleted and includes <code>x-amz-delete-marker:
114
+ * true</code> in the response.</p>
112
115
  * </li>
113
116
  * </ul>
114
117
  * </note>
@@ -116,21 +119,24 @@ export interface GetObjectCommandOutput extends Omit<GetObjectOutput, "Body">, _
116
119
  * </dd>
117
120
  * <dt>Overriding Response Header Values</dt>
118
121
  * <dd>
119
- * <p>There are times when you want to override certain response header values in a <code>GET</code>
120
- * response. For example, you might override the <code>Content-Disposition</code> response
121
- * header value in your <code>GET</code> request.</p>
122
+ * <p>There are times when you want to override certain response header values in a
123
+ * <code>GET</code> response. For example, you might override the
124
+ * <code>Content-Disposition</code> response header value in your <code>GET</code>
125
+ * request.</p>
122
126
  * <p>You can override values for a set of response headers using the following query
123
- * parameters. These response header values are sent only on a successful request, that is,
124
- * when status code 200 OK is returned. The set of headers you can override using these
125
- * parameters is a subset of the headers that Amazon S3 accepts when you create an object. The
126
- * response headers that you can override for the <code>GET</code> response are <code>Content-Type</code>,
127
- * <code>Content-Language</code>, <code>Expires</code>, <code>Cache-Control</code>,
128
- * <code>Content-Disposition</code>, and <code>Content-Encoding</code>. To override these
129
- * header values in the <code>GET</code> response, you use the following request parameters.</p>
127
+ * parameters. These response header values are sent only on a successful request,
128
+ * that is, when status code 200 OK is returned. The set of headers you can override
129
+ * using these parameters is a subset of the headers that Amazon S3 accepts when you
130
+ * create an object. The response headers that you can override for the
131
+ * <code>GET</code> response are <code>Content-Type</code>,
132
+ * <code>Content-Language</code>, <code>Expires</code>,
133
+ * <code>Cache-Control</code>, <code>Content-Disposition</code>, and
134
+ * <code>Content-Encoding</code>. To override these header values in the
135
+ * <code>GET</code> response, you use the following request parameters.</p>
130
136
  * <note>
131
- * <p>You must sign the request, either using an Authorization header or a presigned URL,
132
- * when using these parameters. They cannot be used with an unsigned (anonymous)
133
- * request.</p>
137
+ * <p>You must sign the request, either using an Authorization header or a
138
+ * presigned URL, when using these parameters. They cannot be used with an
139
+ * unsigned (anonymous) request.</p>
134
140
  * </note>
135
141
  * <ul>
136
142
  * <li>
@@ -167,14 +173,15 @@ export interface GetObjectCommandOutput extends Omit<GetObjectOutput, "Body">, _
167
173
  * </dd>
168
174
  * <dt>Overriding Response Header Values</dt>
169
175
  * <dd>
170
- * <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are
171
- * present in the request as follows: <code>If-Match</code> condition evaluates to
172
- * <code>true</code>, and; <code>If-Unmodified-Since</code> condition evaluates to
173
- * <code>false</code>; then, S3 returns 200 OK and the data requested. </p>
174
- * <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are
175
- * present in the request as follows:<code> If-None-Match</code> condition evaluates to
176
- * <code>false</code>, and; <code>If-Modified-Since</code> condition evaluates to
177
- * <code>true</code>; then, S3 returns 304 Not Modified response code.</p>
176
+ * <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code>
177
+ * headers are present in the request as follows: <code>If-Match</code> condition
178
+ * evaluates to <code>true</code>, and; <code>If-Unmodified-Since</code> condition
179
+ * evaluates to <code>false</code>; then, S3 returns 200 OK and the data requested. </p>
180
+ * <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code>
181
+ * headers are present in the request as follows:<code> If-None-Match</code>
182
+ * condition evaluates to <code>false</code>, and; <code>If-Modified-Since</code>
183
+ * condition evaluates to <code>true</code>; then, S3 returns 304 Not Modified
184
+ * response code.</p>
178
185
  * <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
179
186
  * </dd>
180
187
  * </dl>
@@ -34,9 +34,9 @@ export interface HeadBucketCommandOutput extends __MetadataBearer {
34
34
  * <code>s3:ListBucket</code> action. The bucket owner has this permission by default and
35
35
  * 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
36
36
  * Access Permissions to Your Amazon S3 Resources</a>.</p>
37
- * <p>To use this API operation against an access point, you must provide the alias of the access point in place of the
38
- * bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to
39
- * the access point hostname. The access point hostname takes the form
37
+ * <p>To use this API operation against an access point, you must provide the alias of the access point in
38
+ * place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct
39
+ * requests to the access point hostname. The access point hostname takes the form
40
40
  * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com.
41
41
  * When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more
42
42
  * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a>.</p>
@@ -23,9 +23,9 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>The <code>HEAD</code> action retrieves metadata from an object without returning the object itself.
27
- * This action is useful if you're only interested in an object's metadata. To use <code>HEAD</code>, you
28
- * must have READ access to the object.</p>
26
+ * <p>The <code>HEAD</code> action retrieves metadata from an object without returning the
27
+ * object itself. This action is useful if you're only interested in an object's metadata. To
28
+ * use <code>HEAD</code>, you must have READ access to the object.</p>
29
29
  * <p>A <code>HEAD</code> request has the same options as a <code>GET</code> action on an
30
30
  * object. The response is identical to the <code>GET</code> response except that there is no
31
31
  * response body. Because of this, if the <code>HEAD</code> request generates an error, it
@@ -114,18 +114,18 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
114
114
  * <dl>
115
115
  * <dt>Permissions</dt>
116
116
  * <dd>
117
- * <p>You need the relevant read object (or version) permission for this operation. For more
118
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, resources, and condition keys for Amazon S3</a>.
119
- * If the object you request doesn't exist, the error that Amazon S3 returns depends
120
- * on whether you also have the s3:ListBucket permission.</p>
117
+ * <p>You need the relevant read object (or version) permission for this operation.
118
+ * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, resources, and condition
119
+ * keys for Amazon S3</a>. If the object you request doesn't exist, the error that
120
+ * Amazon S3 returns depends on whether you also have the s3:ListBucket permission.</p>
121
121
  * <ul>
122
122
  * <li>
123
- * <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns
124
- * an HTTP status code 404 error.</p>
123
+ * <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3
124
+ * returns an HTTP status code 404 error.</p>
125
125
  * </li>
126
126
  * <li>
127
- * <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP
128
- * status code 403 error.</p>
127
+ * <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns
128
+ * an HTTP status code 403 error.</p>
129
129
  * </li>
130
130
  * </ul>
131
131
  * </dd>
@@ -57,29 +57,33 @@ export interface PutBucketAclCommandOutput extends __MetadataBearer {
57
57
  * <p>You can set access permissions by using one of the following methods:</p>
58
58
  * <ul>
59
59
  * <li>
60
- * <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 supports
61
- * a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL
62
- * has a predefined set of grantees and permissions. Specify the canned ACL name as the
63
- * value of <code>x-amz-acl</code>. If you use this header, you cannot use other access
64
- * 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
65
- * ACL</a>.</p>
60
+ * <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3
61
+ * supports a set of predefined ACLs, known as <i>canned
62
+ * ACLs</i>. Each canned ACL has a predefined set of grantees and
63
+ * permissions. Specify the canned ACL name as the value of
64
+ * <code>x-amz-acl</code>. If you use this header, you cannot use other
65
+ * access control-specific headers in your request. For more information, see
66
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
67
+ * ACL</a>.</p>
66
68
  * </li>
67
69
  * <li>
68
- * <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>,
69
- * <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and
70
- * <code>x-amz-grant-full-control</code> headers. When using these headers, you
71
- * specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who
72
- * will receive the permission. If you use these ACL-specific headers, you cannot use
73
- * the <code>x-amz-acl</code> header to set a canned ACL. These parameters map to the
74
- * set 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
75
- * List (ACL) Overview</a>.</p>
76
- * <p>You specify each grantee as a type=value pair, where the type is one of the
77
- * following:</p>
70
+ * <p>Specify access permissions explicitly with the
71
+ * <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>,
72
+ * <code>x-amz-grant-write-acp</code>, and
73
+ * <code>x-amz-grant-full-control</code> headers. When using these headers,
74
+ * you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3
75
+ * groups) who will receive the permission. If you use these ACL-specific
76
+ * headers, you cannot use the <code>x-amz-acl</code> header to set a canned
77
+ * ACL. These parameters map to the set of permissions that Amazon S3 supports in an
78
+ * ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL)
79
+ * Overview</a>.</p>
80
+ * <p>You specify each grantee as a type=value pair, where the type is one of
81
+ * the following:</p>
78
82
  * <ul>
79
83
  * <li>
80
84
  * <p>
81
- * <code>id</code> – if the value specified is the canonical user ID of an
82
- * Amazon Web Services account</p>
85
+ * <code>id</code> – if the value specified is the canonical user ID
86
+ * of an Amazon Web Services account</p>
83
87
  * </li>
84
88
  * <li>
85
89
  * <p>
@@ -88,8 +92,8 @@ export interface PutBucketAclCommandOutput extends __MetadataBearer {
88
92
  * </li>
89
93
  * <li>
90
94
  * <p>
91
- * <code>emailAddress</code> – if the value specified is the email address of
92
- * an Amazon Web Services account</p>
95
+ * <code>emailAddress</code> – if the value specified is the email
96
+ * address of an Amazon Web Services account</p>
93
97
  * <note>
94
98
  * <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
95
99
  * <ul>
@@ -122,29 +126,31 @@ export interface PutBucketAclCommandOutput extends __MetadataBearer {
122
126
  * </note>
123
127
  * </li>
124
128
  * </ul>
125
- * <p>For example, the following <code>x-amz-grant-write</code> header grants create,
126
- * overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and
127
- * two Amazon Web Services accounts identified by their email addresses.</p>
129
+ * <p>For example, the following <code>x-amz-grant-write</code> header grants
130
+ * create, overwrite, and delete objects permission to LogDelivery group
131
+ * predefined by Amazon S3 and two Amazon Web Services accounts identified by their email
132
+ * addresses.</p>
128
133
  * <p>
129
- * <code>x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery",
130
- * id="111122223333", id="555566667777" </code>
134
+ * <code>x-amz-grant-write:
135
+ * uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333",
136
+ * id="555566667777" </code>
131
137
  * </p>
132
138
  * </li>
133
139
  * </ul>
134
- * <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do
135
- * both.</p>
140
+ * <p>You can use either a canned ACL or specify access permissions explicitly. You
141
+ * cannot do both.</p>
136
142
  * </dd>
137
143
  * <dt>Grantee Values</dt>
138
144
  * <dd>
139
- * <p>You can specify the person (grantee) to whom you're assigning access rights (using
140
- * request elements) in the following ways:</p>
145
+ * <p>You can specify the person (grantee) to whom you're assigning access rights
146
+ * (using request elements) in the following ways:</p>
141
147
  * <ul>
142
148
  * <li>
143
149
  * <p>By the person's ID:</p>
144
150
  * <p>
145
151
  * <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
146
- * xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
147
- * </Grantee></code>
152
+ * xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
153
+ * </Grantee></code>
148
154
  * </p>
149
155
  * <p>DisplayName is optional and ignored in the request</p>
150
156
  * </li>
@@ -152,17 +158,17 @@ export interface PutBucketAclCommandOutput extends __MetadataBearer {
152
158
  * <p>By URI:</p>
153
159
  * <p>
154
160
  * <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
155
- * xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code>
161
+ * xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code>
156
162
  * </p>
157
163
  * </li>
158
164
  * <li>
159
165
  * <p>By Email address:</p>
160
166
  * <p>
161
167
  * <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
162
- * xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>&</Grantee></code>
168
+ * xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>&</Grantee></code>
163
169
  * </p>
164
- * <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object
165
- * acl request, appears as the CanonicalUser. </p>
170
+ * <p>The grantee is resolved to the CanonicalUser and, in a response to a GET
171
+ * Object acl request, appears as the CanonicalUser. </p>
166
172
  * <note>
167
173
  * <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
168
174
  * <ul>
@@ -107,7 +107,8 @@ export interface PutBucketAnalyticsConfigurationCommandOutput extends __Metadata
107
107
  * </ul>
108
108
  * </li>
109
109
  * </ul>
110
- * <p>The following operations are related to <code>PutBucketAnalyticsConfiguration</code>:</p>
110
+ * <p>The following operations are related to
111
+ * <code>PutBucketAnalyticsConfiguration</code>:</p>
111
112
  * <ul>
112
113
  * <li>
113
114
  * <p>
@@ -27,14 +27,10 @@ export interface PutBucketEncryptionCommandOutput extends __MetadataBearer {
27
27
  * and Amazon S3 Bucket Keys for an existing bucket.</p>
28
28
  * <p>By default, all buckets have a default encryption configuration that uses server-side
29
29
  * encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default encryption
30
- * for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS),
31
- * dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side
32
- * encryption with customer-provided keys (SSE-C). If you specify default encryption by using
33
- * SSE-KMS, you can also configure Amazon S3 Bucket Keys. For information about bucket default
34
- * encryption, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 bucket default encryption</a>
35
- * in the <i>Amazon S3 User Guide</i>. For more information about S3 Bucket Keys, see
36
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket
37
- * Keys</a> in the <i>Amazon S3 User Guide</i>.</p>
30
+ * for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or
31
+ * dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you specify default encryption by using
32
+ * SSE-KMS, you can also configure <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket
33
+ * Keys</a>. If you use PutBucketEncryption to set your <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">default bucket encryption</a> to SSE-KMS, you should verify that your KMS key ID is correct. Amazon S3 does not validate the KMS key ID provided in PutBucketEncryption requests.</p>
38
34
  * <important>
39
35
  * <p>This action requires Amazon Web Services Signature Version 4. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">
40
36
  * Authenticating Requests (Amazon Web Services Signature Version 4)</a>. </p>
@@ -52,7 +52,8 @@ export interface PutBucketIntelligentTieringConfigurationCommandOutput extends _
52
52
  * or Deep Archive Access tier.</p>
53
53
  * </note>
54
54
  * <p>
55
- * <code>PutBucketIntelligentTieringConfiguration</code> has the following special errors:</p>
55
+ * <code>PutBucketIntelligentTieringConfiguration</code> has the following special
56
+ * errors:</p>
56
57
  * <dl>
57
58
  * <dt>HTTP 400 Bad Request Error</dt>
58
59
  * <dd>
@@ -72,9 +73,9 @@ export interface PutBucketIntelligentTieringConfigurationCommandOutput extends _
72
73
  * <dt>HTTP 403 Forbidden Error</dt>
73
74
  * <dd>
74
75
  * <p>
75
- * <i>Cause:</i> You are not the owner of the specified bucket,
76
- * or you do not have the <code>s3:PutIntelligentTieringConfiguration</code>
77
- * bucket permission to set the configuration on the bucket. </p>
76
+ * <i>Cause:</i> You are not the owner of the specified bucket, or
77
+ * you do not have the <code>s3:PutIntelligentTieringConfiguration</code> bucket
78
+ * permission to set the configuration on the bucket. </p>
78
79
  * </dd>
79
80
  * </dl>
80
81
  * @example
@@ -47,20 +47,19 @@ export interface PutBucketInventoryConfigurationCommandOutput extends __Metadata
47
47
  * <dt>Permissions</dt>
48
48
  * <dd>
49
49
  * <p>To use this operation, you must have permission to perform the
50
- * <code>s3:PutInventoryConfiguration</code> action. The bucket owner has this permission
51
- * by default and can grant this permission to others. </p>
52
- * <p>The <code>s3:PutInventoryConfiguration</code> permission allows a user to create an
53
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html">S3
54
- * Inventory</a> report that includes all object metadata fields available and to
55
- * specify the destination bucket to store the inventory. A user with read access to objects
56
- * in the destination bucket can also access all object metadata fields that are available in
57
- * the inventory report. </p>
50
+ * <code>s3:PutInventoryConfiguration</code> action. The bucket owner has this
51
+ * permission by default and can grant this permission to others. </p>
52
+ * <p>The <code>s3:PutInventoryConfiguration</code> permission allows a user to
53
+ * create an <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html">S3 Inventory</a>
54
+ * report that includes all object metadata fields available and to specify the
55
+ * destination bucket to store the inventory. A user with read access to objects in
56
+ * the destination bucket can also access all object metadata fields that are
57
+ * available in the inventory report. </p>
58
58
  * <p>To restrict access to an inventory report, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html#example-bucket-policies-use-case-10">Restricting access to an Amazon S3 Inventory report</a> in the
59
- * <i>Amazon S3 User Guide</i>. For more information about the metadata fields
60
- * available in S3 Inventory, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html#storage-inventory-contents">Amazon S3
61
- * Inventory lists</a> in the <i>Amazon S3 User Guide</i>. For more
62
- * 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">Identity and
63
- * access management in Amazon S3</a> in the <i>Amazon S3 User Guide</i>.</p>
59
+ * <i>Amazon S3 User Guide</i>. For more information about the metadata
60
+ * fields available in S3 Inventory, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html#storage-inventory-contents">Amazon S3 Inventory lists</a> in the <i>Amazon S3 User Guide</i>. For
61
+ * 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">Identity and access management in Amazon S3</a> in the
62
+ * <i>Amazon S3 User Guide</i>.</p>
64
63
  * </dd>
65
64
  * </dl>
66
65
  * <p>
@@ -79,17 +78,18 @@ export interface PutBucketInventoryConfigurationCommandOutput extends __Metadata
79
78
  * <i>Code:</i> TooManyConfigurations</p>
80
79
  * <p>
81
80
  * <i>Cause:</i> You are attempting to create a new configuration
82
- * but have already reached the 1,000-configuration limit. </p>
81
+ * but have already reached the 1,000-configuration limit. </p>
83
82
  * </dd>
84
83
  * <dt>HTTP 403 Forbidden Error</dt>
85
84
  * <dd>
86
85
  * <p>
87
- * <i>Cause:</i> You are not the owner of the specified bucket,
88
- * or you do not have the <code>s3:PutInventoryConfiguration</code> bucket
89
- * permission to set the configuration on the bucket. </p>
86
+ * <i>Cause:</i> You are not the owner of the specified bucket, or
87
+ * you do not have the <code>s3:PutInventoryConfiguration</code> bucket permission to
88
+ * set the configuration on the bucket. </p>
90
89
  * </dd>
91
90
  * </dl>
92
- * <p>The following operations are related to <code>PutBucketInventoryConfiguration</code>:</p>
91
+ * <p>The following operations are related to
92
+ * <code>PutBucketInventoryConfiguration</code>:</p>
93
93
  * <ul>
94
94
  * <li>
95
95
  * <p>
@@ -39,40 +39,43 @@ export interface PutBucketLifecycleConfigurationCommandOutput extends __Metadata
39
39
  * <dt>Rules</dt>
40
40
  * <dd>
41
41
  * <p>You specify the lifecycle configuration in your request body. The lifecycle
42
- * configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle
43
- * configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists
44
- * of the following:</p>
42
+ * configuration is specified as XML consisting of one or more rules. An Amazon S3
43
+ * Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable.
44
+ * Each rule consists of the following:</p>
45
45
  * <ul>
46
46
  * <li>
47
- * <p>A filter identifying a subset of objects to which the rule applies. The filter can
48
- * be based on a key name prefix, object tags, or a combination of both.</p>
47
+ * <p>A filter identifying a subset of objects to which the rule applies. The
48
+ * filter can be based on a key name prefix, object tags, or a combination of
49
+ * both.</p>
49
50
  * </li>
50
51
  * <li>
51
52
  * <p>A status indicating whether the rule is in effect.</p>
52
53
  * </li>
53
54
  * <li>
54
- * <p>One or more lifecycle transition and expiration actions that you want Amazon S3 to
55
- * perform on the objects identified by the filter. If the state of your bucket is
56
- * versioning-enabled or versioning-suspended, you can have many versions of the same
57
- * object (one current version and zero or more noncurrent versions). Amazon S3 provides
58
- * predefined actions that you can specify for current and noncurrent object
59
- * versions.</p>
55
+ * <p>One or more lifecycle transition and expiration actions that you want
56
+ * Amazon S3 to perform on the objects identified by the filter. If the state of
57
+ * your bucket is versioning-enabled or versioning-suspended, you can have many
58
+ * versions of the same object (one current version and zero or more noncurrent
59
+ * versions). Amazon S3 provides predefined actions that you can specify for current
60
+ * and noncurrent object versions.</p>
60
61
  * </li>
61
62
  * </ul>
62
- * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a>
63
- * and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html">Lifecycle Configuration Elements</a>.</p>
63
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle
64
+ * Management</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html">Lifecycle Configuration
65
+ * Elements</a>.</p>
64
66
  * </dd>
65
67
  * <dt>Permissions</dt>
66
68
  * <dd>
67
- * <p>By default, all Amazon S3 resources are private, including buckets, objects, and related
68
- * subresources (for example, lifecycle configuration and website configuration). Only the
69
- * resource owner (that is, the Amazon Web Services account that created it) can access the resource. The
70
- * resource owner can optionally grant access permissions to others by writing an access
71
- * policy. For this operation, a user must get the <code>s3:PutLifecycleConfiguration</code>
72
- * permission.</p>
73
- * <p>You can also explicitly deny permissions. An explicit deny also supersedes any other
74
- * permissions. If you want to block users or accounts from removing or deleting objects from
75
- * your bucket, you must deny them permissions for the following actions:</p>
69
+ * <p>By default, all Amazon S3 resources are private, including buckets, objects, and
70
+ * related subresources (for example, lifecycle configuration and website
71
+ * configuration). Only the resource owner (that is, the Amazon Web Services account that created
72
+ * it) can access the resource. The resource owner can optionally grant access
73
+ * permissions to others by writing an access policy. For this operation, a user must
74
+ * get the <code>s3:PutLifecycleConfiguration</code> permission.</p>
75
+ * <p>You can also explicitly deny permissions. An explicit deny also supersedes any
76
+ * other permissions. If you want to block users or accounts from removing or
77
+ * deleting objects from your bucket, you must deny them permissions for the
78
+ * following actions:</p>
76
79
  * <ul>
77
80
  * <li>
78
81
  * <p>
@@ -90,11 +93,12 @@ export interface PutBucketLifecycleConfigurationCommandOutput extends __Metadata
90
93
  * </p>
91
94
  * </li>
92
95
  * </ul>
93
- * <p>For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to
94
- * Your Amazon S3 Resources</a>.</p>
96
+ * <p>For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access
97
+ * Permissions to Your Amazon S3 Resources</a>.</p>
95
98
  * </dd>
96
99
  * </dl>
97
- * <p>The following operations are related to <code>PutBucketLifecycleConfiguration</code>:</p>
100
+ * <p>The following operations are related to
101
+ * <code>PutBucketLifecycleConfiguration</code>:</p>
98
102
  * <ul>
99
103
  * <li>
100
104
  * <p>
@@ -41,15 +41,15 @@ export interface PutBucketLoggingCommandOutput extends __MetadataBearer {
41
41
  * <dl>
42
42
  * <dt>Grantee Values</dt>
43
43
  * <dd>
44
- * <p>You can specify the person (grantee) to whom you're assigning access rights (by using
45
- * request elements) in the following ways:</p>
44
+ * <p>You can specify the person (grantee) to whom you're assigning access rights (by
45
+ * using request elements) in the following ways:</p>
46
46
  * <ul>
47
47
  * <li>
48
48
  * <p>By the person's ID:</p>
49
49
  * <p>
50
50
  * <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
51
- * xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
52
- * </Grantee></code>
51
+ * xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
52
+ * </Grantee></code>
53
53
  * </p>
54
54
  * <p>
55
55
  * <code>DisplayName</code> is optional and ignored in the request.</p>
@@ -58,23 +58,25 @@ export interface PutBucketLoggingCommandOutput extends __MetadataBearer {
58
58
  * <p>By Email address:</p>
59
59
  * <p>
60
60
  * <code> <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
61
- * xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee></code>
61
+ * xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee></code>
62
62
  * </p>
63
- * <p>The grantee is resolved to the <code>CanonicalUser</code> and, in a response to a <code>GETObjectAcl</code>
64
- * request, appears as the CanonicalUser.</p>
63
+ * <p>The grantee is resolved to the <code>CanonicalUser</code> and, in a
64
+ * response to a <code>GETObjectAcl</code> request, appears as the
65
+ * CanonicalUser.</p>
65
66
  * </li>
66
67
  * <li>
67
68
  * <p>By URI:</p>
68
69
  * <p>
69
70
  * <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
70
- * xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code>
71
+ * xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code>
71
72
  * </p>
72
73
  * </li>
73
74
  * </ul>
74
75
  * </dd>
75
76
  * </dl>
76
- * <p>To enable logging, you use <code>LoggingEnabled</code> and its children request elements. To disable
77
- * logging, you use an empty <code>BucketLoggingStatus</code> request element:</p>
77
+ * <p>To enable logging, you use <code>LoggingEnabled</code> and its children request
78
+ * elements. To disable logging, you use an empty <code>BucketLoggingStatus</code> request
79
+ * element:</p>
78
80
  * <p>
79
81
  * <code><BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01"
80
82
  * /></code>
@@ -34,10 +34,11 @@ export interface PutBucketPolicyCommandOutput extends __MetadataBearer {
34
34
  * <important>
35
35
  * <p>To ensure that bucket owners don't inadvertently lock themselves out of their own
36
36
  * buckets, the root principal in a bucket owner's Amazon Web Services account can perform the
37
- * <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and
38
- * <code>DeleteBucketPolicy</code> API actions, even if their bucket policy explicitly
39
- * denies the root principal's access. Bucket owner root principals can only be blocked from performing
40
- * these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.</p>
37
+ * <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and
38
+ * <code>DeleteBucketPolicy</code> API actions, even if their bucket policy explicitly
39
+ * denies the root principal's access. Bucket owner root principals can only be blocked
40
+ * from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations
41
+ * policies.</p>
41
42
  * </important>
42
43
  * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket policy
43
44
  * examples</a>.</p>