aws-sdk-s3 1.91.0 → 1.92.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +7 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3.rb +1 -1
- data/lib/aws-sdk-s3/arn/access_point_arn.rb +2 -2
- data/lib/aws-sdk-s3/arn/object_lambda_arn.rb +66 -0
- data/lib/aws-sdk-s3/arn/outpost_access_point_arn.rb +3 -3
- data/lib/aws-sdk-s3/bucket.rb +6 -6
- data/lib/aws-sdk-s3/bucket_acl.rb +1 -1
- data/lib/aws-sdk-s3/bucket_cors.rb +3 -4
- data/lib/aws-sdk-s3/bucket_lifecycle.rb +2 -2
- data/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb +2 -2
- data/lib/aws-sdk-s3/bucket_logging.rb +1 -1
- data/lib/aws-sdk-s3/bucket_notification.rb +1 -1
- data/lib/aws-sdk-s3/bucket_policy.rb +2 -2
- data/lib/aws-sdk-s3/bucket_request_payment.rb +1 -1
- data/lib/aws-sdk-s3/bucket_tagging.rb +2 -2
- data/lib/aws-sdk-s3/bucket_versioning.rb +3 -3
- data/lib/aws-sdk-s3/bucket_website.rb +2 -2
- data/lib/aws-sdk-s3/client.rb +662 -412
- data/lib/aws-sdk-s3/client_api.rb +58 -0
- data/lib/aws-sdk-s3/multipart_upload.rb +3 -3
- data/lib/aws-sdk-s3/multipart_upload_part.rb +4 -4
- data/lib/aws-sdk-s3/object.rb +9 -9
- data/lib/aws-sdk-s3/object_acl.rb +1 -1
- data/lib/aws-sdk-s3/object_summary.rb +9 -9
- data/lib/aws-sdk-s3/object_version.rb +4 -4
- data/lib/aws-sdk-s3/plugins/arn.rb +20 -13
- data/lib/aws-sdk-s3/plugins/iad_regional_endpoint.rb +9 -9
- data/lib/aws-sdk-s3/plugins/object_lambda_endpoint.rb +25 -0
- data/lib/aws-sdk-s3/plugins/s3_signer.rb +6 -0
- data/lib/aws-sdk-s3/types.rb +466 -159
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d13f63eb47c682e1fc6f5e88e3da2183232c9b7a2914df446d2bf012ec788081
|
4
|
+
data.tar.gz: d264012bd441b374fd2447efd6125a7bc1644711f03c7580135b9ce76bdf7c86
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6dc046ad7ab6155ca64b8f5b0c322c7d2dd92ebeb3dd785b090d254d32f412af3b0438eac41ad60b69e6156ce6fcec4d87deac033ce0a01ae58131ee5b96ea9a
|
7
|
+
data.tar.gz: 2fa9031c44cfc32bb80e2d106ee0e2ea7ad0596e31d70970484574a4819731a6a0ebb47289052f90a4198a9f3eaeee8effdada5cc5833dcf9a4a7989248a8285
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,13 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.92.0 (2021-03-18)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - S3 Object Lambda is a new S3 feature that enables users to apply their own custom code to process the output of a standard S3 GET request by automatically invoking a Lambda function with a GET request
|
8
|
+
|
9
|
+
* Feature - Support S3 Object Lambda ARNs in the `bucket:` parameter.
|
10
|
+
|
4
11
|
1.91.0 (2021-03-10)
|
5
12
|
------------------
|
6
13
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.92.0
|
data/lib/aws-sdk-s3.rb
CHANGED
@@ -21,12 +21,12 @@ module Aws
|
|
21
21
|
|
22
22
|
def validate_arn!
|
23
23
|
unless @service == 's3'
|
24
|
-
raise ArgumentError, 'Must provide a valid S3
|
24
|
+
raise ArgumentError, 'Must provide a valid S3 Access Point ARN.'
|
25
25
|
end
|
26
26
|
|
27
27
|
if @region.empty? || @account_id.empty?
|
28
28
|
raise ArgumentError,
|
29
|
-
'S3
|
29
|
+
'S3 Access Point ARNs must contain both a region '\
|
30
30
|
'and an account id.'
|
31
31
|
end
|
32
32
|
|
@@ -0,0 +1,66 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Aws
|
4
|
+
module S3
|
5
|
+
# @api private
|
6
|
+
class ObjectLambdaARN < Aws::ARN
|
7
|
+
def initialize(options)
|
8
|
+
super(options)
|
9
|
+
@type, @access_point_name, @extra = @resource.split(/[:,\/]/)
|
10
|
+
end
|
11
|
+
|
12
|
+
attr_reader :access_point_name
|
13
|
+
|
14
|
+
def support_dualstack?
|
15
|
+
false
|
16
|
+
end
|
17
|
+
|
18
|
+
def support_fips?
|
19
|
+
true
|
20
|
+
end
|
21
|
+
|
22
|
+
def validate_arn!
|
23
|
+
unless @service == 's3-object-lambda'
|
24
|
+
raise ArgumentError, 'Must provide a valid S3 Object Lambdas ARN.'
|
25
|
+
end
|
26
|
+
|
27
|
+
if @region.empty? || @account_id.empty?
|
28
|
+
raise ArgumentError,
|
29
|
+
'S3 Object Lambdas ARNs must contain both a region '\
|
30
|
+
'and an account id.'
|
31
|
+
end
|
32
|
+
|
33
|
+
if @type != 'accesspoint'
|
34
|
+
raise ArgumentError, 'Invalid ARN, resource format is not correct.'
|
35
|
+
end
|
36
|
+
|
37
|
+
if @access_point_name.nil? || @access_point_name.empty?
|
38
|
+
raise ArgumentError, 'Missing ARN accesspoint name.'
|
39
|
+
end
|
40
|
+
|
41
|
+
if @extra
|
42
|
+
raise ArgumentError,
|
43
|
+
'ARN accesspoint resource must be a single value.'
|
44
|
+
end
|
45
|
+
|
46
|
+
unless Seahorse::Util.host_label?(
|
47
|
+
"#{@access_point_name}-#{@account_id}"
|
48
|
+
)
|
49
|
+
raise ArgumentError,
|
50
|
+
"#{@access_point_name}-#{@account_id} is not a valid "\
|
51
|
+
'host label.'
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
def host_url(region, _dualstack = false, custom_endpoint = nil)
|
56
|
+
pfx = "#{@access_point_name}-#{@account_id}"
|
57
|
+
if custom_endpoint
|
58
|
+
"#{pfx}.#{custom_endpoint}"
|
59
|
+
else
|
60
|
+
sfx = Aws::Partitions::EndpointProvider.dns_suffix_for(region)
|
61
|
+
"#{pfx}.s3-object-lambda.#{region}.#{sfx}"
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
@@ -22,17 +22,17 @@ module Aws
|
|
22
22
|
|
23
23
|
def validate_arn!
|
24
24
|
unless @service == 's3-outposts'
|
25
|
-
raise ArgumentError, 'Must provide a valid S3
|
25
|
+
raise ArgumentError, 'Must provide a valid S3 Outposts ARN.'
|
26
26
|
end
|
27
27
|
|
28
28
|
if @region.empty? || @account_id.empty?
|
29
29
|
raise ArgumentError,
|
30
|
-
'S3
|
30
|
+
'S3 Outpost ARNs must contain both a region '\
|
31
31
|
'and an account id.'
|
32
32
|
end
|
33
33
|
|
34
34
|
if @type != 'outpost' && @subtype != 'accesspoint'
|
35
|
-
raise ArgumentError, 'Invalid ARN, resource format is not correct'
|
35
|
+
raise ArgumentError, 'Invalid ARN, resource format is not correct.'
|
36
36
|
end
|
37
37
|
|
38
38
|
if @outpost_id.nil? || @outpost_id.empty?
|
data/lib/aws-sdk-s3/bucket.rb
CHANGED
@@ -266,7 +266,7 @@ module Aws::S3
|
|
266
266
|
# })
|
267
267
|
# @param [Hash] options ({})
|
268
268
|
# @option options [String] :expected_bucket_owner
|
269
|
-
# The account
|
269
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
270
270
|
# a different account, the request will fail with an HTTP `403 (Access
|
271
271
|
# Denied)` error.
|
272
272
|
# @return [EmptyStructure]
|
@@ -316,7 +316,7 @@ module Aws::S3
|
|
316
316
|
# Governance-type Object Lock in place. You must have sufficient
|
317
317
|
# permissions to perform this operation.
|
318
318
|
# @option options [String] :expected_bucket_owner
|
319
|
-
# The account
|
319
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
320
320
|
# a different account, the request will fail with an HTTP `403 (Access
|
321
321
|
# Denied)` error.
|
322
322
|
# @return [Types::DeleteObjectsOutput]
|
@@ -560,7 +560,7 @@ module Aws::S3
|
|
560
560
|
#
|
561
561
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
562
562
|
# @option options [String] :expected_bucket_owner
|
563
|
-
# The account
|
563
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
564
564
|
# a different account, the request will fail with an HTTP `403 (Access
|
565
565
|
# Denied)` error.
|
566
566
|
# @return [Object]
|
@@ -668,7 +668,7 @@ module Aws::S3
|
|
668
668
|
# list only if they have an upload ID lexicographically greater than the
|
669
669
|
# specified `upload-id-marker`.
|
670
670
|
# @option options [String] :expected_bucket_owner
|
671
|
-
# The account
|
671
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
672
672
|
# a different account, the request will fail with an HTTP `403 (Access
|
673
673
|
# Denied)` error.
|
674
674
|
# @return [MultipartUpload::Collection]
|
@@ -748,7 +748,7 @@ module Aws::S3
|
|
748
748
|
# @option options [String] :version_id_marker
|
749
749
|
# Specifies the object version you want to start listing from.
|
750
750
|
# @option options [String] :expected_bucket_owner
|
751
|
-
# The account
|
751
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
752
752
|
# a different account, the request will fail with an HTTP `403 (Access
|
753
753
|
# Denied)` error.
|
754
754
|
# @return [ObjectVersion::Collection]
|
@@ -804,7 +804,7 @@ module Aws::S3
|
|
804
804
|
# the list objects request in V2 style. Bucket owners need not specify
|
805
805
|
# this parameter in their requests.
|
806
806
|
# @option options [String] :expected_bucket_owner
|
807
|
-
# The account
|
807
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
808
808
|
# a different account, the request will fail with an HTTP `403 (Access
|
809
809
|
# Denied)` error.
|
810
810
|
# @return [ObjectSummary::Collection]
|
@@ -240,7 +240,7 @@ module Aws::S3
|
|
240
240
|
# @option options [String] :grant_write_acp
|
241
241
|
# Allows grantee to write the ACL for the applicable bucket.
|
242
242
|
# @option options [String] :expected_bucket_owner
|
243
|
-
# The account
|
243
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
244
244
|
# a different account, the request will fail with an HTTP `403 (Access
|
245
245
|
# Denied)` error.
|
246
246
|
# @return [EmptyStructure]
|
@@ -182,7 +182,7 @@ module Aws::S3
|
|
182
182
|
# })
|
183
183
|
# @param [Hash] options ({})
|
184
184
|
# @option options [String] :expected_bucket_owner
|
185
|
-
# The account
|
185
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
186
186
|
# a different account, the request will fail with an HTTP `403 (Access
|
187
187
|
# Denied)` error.
|
188
188
|
# @return [EmptyStructure]
|
@@ -214,8 +214,7 @@ module Aws::S3
|
|
214
214
|
# @option options [required, Types::CORSConfiguration] :cors_configuration
|
215
215
|
# Describes the cross-origin access configuration for objects in an
|
216
216
|
# Amazon S3 bucket. For more information, see [Enabling Cross-Origin
|
217
|
-
# Resource Sharing][1] in the *Amazon
|
218
|
-
# Guide*.
|
217
|
+
# Resource Sharing][1] in the *Amazon S3 User Guide*.
|
219
218
|
#
|
220
219
|
#
|
221
220
|
#
|
@@ -232,7 +231,7 @@ module Aws::S3
|
|
232
231
|
#
|
233
232
|
# [1]: http://www.ietf.org/rfc/rfc1864.txt
|
234
233
|
# @option options [String] :expected_bucket_owner
|
235
|
-
# The account
|
234
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
236
235
|
# a different account, the request will fail with an HTTP `403 (Access
|
237
236
|
# Denied)` error.
|
238
237
|
# @return [EmptyStructure]
|
@@ -181,7 +181,7 @@ module Aws::S3
|
|
181
181
|
# })
|
182
182
|
# @param [Hash] options ({})
|
183
183
|
# @option options [String] :expected_bucket_owner
|
184
|
-
# The account
|
184
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
185
185
|
# a different account, the request will fail with an HTTP `403 (Access
|
186
186
|
# Denied)` error.
|
187
187
|
# @return [EmptyStructure]
|
@@ -232,7 +232,7 @@ module Aws::S3
|
|
232
232
|
# SDKs, this field is calculated automatically.
|
233
233
|
# @option options [Types::LifecycleConfiguration] :lifecycle_configuration
|
234
234
|
# @option options [String] :expected_bucket_owner
|
235
|
-
# The account
|
235
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
236
236
|
# a different account, the request will fail with an HTTP `403 (Access
|
237
237
|
# Denied)` error.
|
238
238
|
# @return [EmptyStructure]
|
@@ -181,7 +181,7 @@ module Aws::S3
|
|
181
181
|
# })
|
182
182
|
# @param [Hash] options ({})
|
183
183
|
# @option options [String] :expected_bucket_owner
|
184
|
-
# The account
|
184
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
185
185
|
# a different account, the request will fail with an HTTP `403 (Access
|
186
186
|
# Denied)` error.
|
187
187
|
# @return [EmptyStructure]
|
@@ -249,7 +249,7 @@ module Aws::S3
|
|
249
249
|
# @option options [Types::BucketLifecycleConfiguration] :lifecycle_configuration
|
250
250
|
# Container for lifecycle rules. You can add as many as 1,000 rules.
|
251
251
|
# @option options [String] :expected_bucket_owner
|
252
|
-
# The account
|
252
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
253
253
|
# a different account, the request will fail with an HTTP `403 (Access
|
254
254
|
# Denied)` error.
|
255
255
|
# @return [EmptyStructure]
|
@@ -214,7 +214,7 @@ module Aws::S3
|
|
214
214
|
# For requests made using the AWS Command Line Interface (CLI) or AWS
|
215
215
|
# SDKs, this field is calculated automatically.
|
216
216
|
# @option options [String] :expected_bucket_owner
|
217
|
-
# The account
|
217
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
218
218
|
# a different account, the request will fail with an HTTP `403 (Access
|
219
219
|
# Denied)` error.
|
220
220
|
# @return [EmptyStructure]
|
@@ -253,7 +253,7 @@ module Aws::S3
|
|
253
253
|
# bucket. If this element is empty, notifications are turned off for the
|
254
254
|
# bucket.
|
255
255
|
# @option options [String] :expected_bucket_owner
|
256
|
-
# The account
|
256
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
257
257
|
# a different account, the request will fail with an HTTP `403 (Access
|
258
258
|
# Denied)` error.
|
259
259
|
# @return [EmptyStructure]
|
@@ -181,7 +181,7 @@ module Aws::S3
|
|
181
181
|
# })
|
182
182
|
# @param [Hash] options ({})
|
183
183
|
# @option options [String] :expected_bucket_owner
|
184
|
-
# The account
|
184
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
185
185
|
# a different account, the request will fail with an HTTP `403 (Access
|
186
186
|
# Denied)` error.
|
187
187
|
# @return [EmptyStructure]
|
@@ -211,7 +211,7 @@ module Aws::S3
|
|
211
211
|
# @option options [required, String] :policy
|
212
212
|
# The bucket policy as a JSON document.
|
213
213
|
# @option options [String] :expected_bucket_owner
|
214
|
-
# The account
|
214
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
215
215
|
# a different account, the request will fail with an HTTP `403 (Access
|
216
216
|
# Denied)` error.
|
217
217
|
# @return [EmptyStructure]
|
@@ -198,7 +198,7 @@ module Aws::S3
|
|
198
198
|
# @option options [required, Types::RequestPaymentConfiguration] :request_payment_configuration
|
199
199
|
# Container for Payer.
|
200
200
|
# @option options [String] :expected_bucket_owner
|
201
|
-
# The account
|
201
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
202
202
|
# a different account, the request will fail with an HTTP `403 (Access
|
203
203
|
# Denied)` error.
|
204
204
|
# @return [EmptyStructure]
|
@@ -181,7 +181,7 @@ module Aws::S3
|
|
181
181
|
# })
|
182
182
|
# @param [Hash] options ({})
|
183
183
|
# @option options [String] :expected_bucket_owner
|
184
|
-
# The account
|
184
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
185
185
|
# a different account, the request will fail with an HTTP `403 (Access
|
186
186
|
# Denied)` error.
|
187
187
|
# @return [EmptyStructure]
|
@@ -220,7 +220,7 @@ module Aws::S3
|
|
220
220
|
# @option options [required, Types::Tagging] :tagging
|
221
221
|
# Container for the `TagSet` and `Tag` elements.
|
222
222
|
# @option options [String] :expected_bucket_owner
|
223
|
-
# The account
|
223
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
224
224
|
# a different account, the request will fail with an HTTP `403 (Access
|
225
225
|
# Denied)` error.
|
226
226
|
# @return [EmptyStructure]
|
@@ -207,7 +207,7 @@ module Aws::S3
|
|
207
207
|
# The concatenation of the authentication device's serial number, a
|
208
208
|
# space, and the value that is displayed on your authentication device.
|
209
209
|
# @option options [String] :expected_bucket_owner
|
210
|
-
# The account
|
210
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
211
211
|
# a different account, the request will fail with an HTTP `403 (Access
|
212
212
|
# Denied)` error.
|
213
213
|
# @return [EmptyStructure]
|
@@ -252,7 +252,7 @@ module Aws::S3
|
|
252
252
|
# @option options [required, Types::VersioningConfiguration] :versioning_configuration
|
253
253
|
# Container for setting the versioning state.
|
254
254
|
# @option options [String] :expected_bucket_owner
|
255
|
-
# The account
|
255
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
256
256
|
# a different account, the request will fail with an HTTP `403 (Access
|
257
257
|
# Denied)` error.
|
258
258
|
# @return [EmptyStructure]
|
@@ -286,7 +286,7 @@ module Aws::S3
|
|
286
286
|
# The concatenation of the authentication device's serial number, a
|
287
287
|
# space, and the value that is displayed on your authentication device.
|
288
288
|
# @option options [String] :expected_bucket_owner
|
289
|
-
# The account
|
289
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
290
290
|
# a different account, the request will fail with an HTTP `403 (Access
|
291
291
|
# Denied)` error.
|
292
292
|
# @return [EmptyStructure]
|
@@ -203,7 +203,7 @@ module Aws::S3
|
|
203
203
|
# })
|
204
204
|
# @param [Hash] options ({})
|
205
205
|
# @option options [String] :expected_bucket_owner
|
206
|
-
# The account
|
206
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
207
207
|
# a different account, the request will fail with an HTTP `403 (Access
|
208
208
|
# Denied)` error.
|
209
209
|
# @return [EmptyStructure]
|
@@ -261,7 +261,7 @@ module Aws::S3
|
|
261
261
|
# @option options [required, Types::WebsiteConfiguration] :website_configuration
|
262
262
|
# Container for the request.
|
263
263
|
# @option options [String] :expected_bucket_owner
|
264
|
-
# The account
|
264
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
265
265
|
# a different account, the request will fail with an HTTP `403 (Access
|
266
266
|
# Denied)` error.
|
267
267
|
# @return [EmptyStructure]
|
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -39,6 +39,7 @@ require 'aws-sdk-s3/plugins/http_200_errors.rb'
|
|
39
39
|
require 'aws-sdk-s3/plugins/iad_regional_endpoint.rb'
|
40
40
|
require 'aws-sdk-s3/plugins/location_constraint.rb'
|
41
41
|
require 'aws-sdk-s3/plugins/md5s.rb'
|
42
|
+
require 'aws-sdk-s3/plugins/object_lambda_endpoint.rb'
|
42
43
|
require 'aws-sdk-s3/plugins/redirects.rb'
|
43
44
|
require 'aws-sdk-s3/plugins/s3_host_id.rb'
|
44
45
|
require 'aws-sdk-s3/plugins/s3_signer.rb'
|
@@ -102,6 +103,7 @@ module Aws::S3
|
|
102
103
|
add_plugin(Aws::S3::Plugins::IADRegionalEndpoint)
|
103
104
|
add_plugin(Aws::S3::Plugins::LocationConstraint)
|
104
105
|
add_plugin(Aws::S3::Plugins::Md5s)
|
106
|
+
add_plugin(Aws::S3::Plugins::ObjectLambdaEndpoint)
|
105
107
|
add_plugin(Aws::S3::Plugins::Redirects)
|
106
108
|
add_plugin(Aws::S3::Plugins::S3HostId)
|
107
109
|
add_plugin(Aws::S3::Plugins::S3Signer)
|
@@ -326,8 +328,8 @@ module Aws::S3
|
|
326
328
|
#
|
327
329
|
#
|
328
330
|
# @option options [String] :s3_us_east_1_regional_endpoint ("legacy")
|
329
|
-
#
|
330
|
-
#
|
331
|
+
# Pass in `regional` to enable the `us-east-1` regional endpoint.
|
332
|
+
# Defaults to `legacy` mode which uses the global endpoint.
|
331
333
|
#
|
332
334
|
# @option options [Boolean] :s3_use_arn_region (true)
|
333
335
|
# For S3 ARNs passed into the `:bucket` parameter, this option will
|
@@ -466,8 +468,8 @@ module Aws::S3
|
|
466
468
|
#
|
467
469
|
#
|
468
470
|
#
|
469
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
470
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
471
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
472
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
471
473
|
#
|
472
474
|
# @option params [required, String] :key
|
473
475
|
# Key of the object for which the multipart upload was initiated.
|
@@ -487,7 +489,7 @@ module Aws::S3
|
|
487
489
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
488
490
|
#
|
489
491
|
# @option params [String] :expected_bucket_owner
|
490
|
-
# The account
|
492
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
491
493
|
# a different account, the request will fail with an HTTP `403 (Access
|
492
494
|
# Denied)` error.
|
493
495
|
#
|
@@ -645,7 +647,7 @@ module Aws::S3
|
|
645
647
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
646
648
|
#
|
647
649
|
# @option params [String] :expected_bucket_owner
|
648
|
-
# The account
|
650
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
649
651
|
# a different account, the request will fail with an HTTP `403 (Access
|
650
652
|
# Denied)` error.
|
651
653
|
#
|
@@ -844,7 +846,7 @@ module Aws::S3
|
|
844
846
|
#
|
845
847
|
# If a target object uses SSE-KMS, you can enable an S3 Bucket Key for
|
846
848
|
# the object. For more information, see [Amazon S3 Bucket Keys][9] in
|
847
|
-
# the *Amazon
|
849
|
+
# the *Amazon S3 User Guide*.
|
848
850
|
#
|
849
851
|
# **Access Control List (ACL)-Specific Request Headers**
|
850
852
|
#
|
@@ -937,8 +939,8 @@ module Aws::S3
|
|
937
939
|
#
|
938
940
|
#
|
939
941
|
#
|
940
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
941
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
942
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
943
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
942
944
|
#
|
943
945
|
# @option params [String] :cache_control
|
944
946
|
# Specifies caching behavior along the request/reply chain.
|
@@ -1001,7 +1003,7 @@ module Aws::S3
|
|
1001
1003
|
#
|
1002
1004
|
#
|
1003
1005
|
#
|
1004
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1006
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
|
1005
1007
|
#
|
1006
1008
|
# @option params [String] :copy_source_if_match
|
1007
1009
|
# Copies the object if its entity tag (ETag) matches the specified tag.
|
@@ -1159,12 +1161,12 @@ module Aws::S3
|
|
1159
1161
|
# Specifies whether you want to apply a Legal Hold to the copied object.
|
1160
1162
|
#
|
1161
1163
|
# @option params [String] :expected_bucket_owner
|
1162
|
-
# The account
|
1164
|
+
# The account ID of the expected destination bucket owner. If the
|
1163
1165
|
# destination bucket is owned by a different account, the request will
|
1164
1166
|
# fail with an HTTP `403 (Access Denied)` error.
|
1165
1167
|
#
|
1166
1168
|
# @option params [String] :expected_source_bucket_owner
|
1167
|
-
# The account
|
1169
|
+
# The account ID of the expected source bucket owner. If the source
|
1168
1170
|
# bucket is owned by a different account, the request will fail with an
|
1169
1171
|
# HTTP `403 (Access Denied)` error.
|
1170
1172
|
#
|
@@ -1735,8 +1737,8 @@ module Aws::S3
|
|
1735
1737
|
#
|
1736
1738
|
#
|
1737
1739
|
#
|
1738
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1739
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1740
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
1741
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
1740
1742
|
#
|
1741
1743
|
# @option params [String] :cache_control
|
1742
1744
|
# Specifies caching behavior along the request/reply chain.
|
@@ -1875,7 +1877,7 @@ module Aws::S3
|
|
1875
1877
|
# object.
|
1876
1878
|
#
|
1877
1879
|
# @option params [String] :expected_bucket_owner
|
1878
|
-
# The account
|
1880
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
1879
1881
|
# a different account, the request will fail with an HTTP `403 (Access
|
1880
1882
|
# Denied)` error.
|
1881
1883
|
#
|
@@ -1990,7 +1992,7 @@ module Aws::S3
|
|
1990
1992
|
# Specifies the bucket being deleted.
|
1991
1993
|
#
|
1992
1994
|
# @option params [String] :expected_bucket_owner
|
1993
|
-
# The account
|
1995
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
1994
1996
|
# a different account, the request will fail with an HTTP `403 (Access
|
1995
1997
|
# Denied)` error.
|
1996
1998
|
#
|
@@ -2045,8 +2047,8 @@ module Aws::S3
|
|
2045
2047
|
#
|
2046
2048
|
#
|
2047
2049
|
#
|
2048
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2049
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2050
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2051
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
2050
2052
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
2051
2053
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html
|
2052
2054
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html
|
@@ -2060,7 +2062,7 @@ module Aws::S3
|
|
2060
2062
|
# The ID that identifies the analytics configuration.
|
2061
2063
|
#
|
2062
2064
|
# @option params [String] :expected_bucket_owner
|
2063
|
-
# The account
|
2065
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2064
2066
|
# a different account, the request will fail with an HTTP `403 (Access
|
2065
2067
|
# Denied)` error.
|
2066
2068
|
#
|
@@ -2090,7 +2092,7 @@ module Aws::S3
|
|
2090
2092
|
# default and can grant this permission to others.
|
2091
2093
|
#
|
2092
2094
|
# For information about `cors`, see [Enabling Cross-Origin Resource
|
2093
|
-
# Sharing][1] in the *Amazon
|
2095
|
+
# Sharing][1] in the *Amazon S3 User Guide*.
|
2094
2096
|
#
|
2095
2097
|
# **Related Resources:**
|
2096
2098
|
#
|
@@ -2108,7 +2110,7 @@ module Aws::S3
|
|
2108
2110
|
# Specifies the bucket whose `cors` configuration is being deleted.
|
2109
2111
|
#
|
2110
2112
|
# @option params [String] :expected_bucket_owner
|
2111
|
-
# The account
|
2113
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2112
2114
|
# a different account, the request will fail with an HTTP `403 (Access
|
2113
2115
|
# Denied)` error.
|
2114
2116
|
#
|
@@ -2142,15 +2144,15 @@ module Aws::S3
|
|
2142
2144
|
# This implementation of the DELETE action removes default encryption
|
2143
2145
|
# from the bucket. For information about the Amazon S3 default
|
2144
2146
|
# encryption feature, see [Amazon S3 Default Bucket Encryption][1] in
|
2145
|
-
# the *Amazon
|
2147
|
+
# the *Amazon S3 User Guide*.
|
2146
2148
|
#
|
2147
2149
|
# To use this operation, you must have permissions to perform the
|
2148
2150
|
# `s3:PutEncryptionConfiguration` action. The bucket owner has this
|
2149
2151
|
# permission by default. The bucket owner can grant this permission to
|
2150
2152
|
# others. For more information about permissions, see [Permissions
|
2151
2153
|
# Related to Bucket Subresource Operations][2] and [Managing Access
|
2152
|
-
# Permissions to your Amazon S3 Resources][3] in the *Amazon
|
2153
|
-
#
|
2154
|
+
# Permissions to your Amazon S3 Resources][3] in the *Amazon S3 User
|
2155
|
+
# Guide*.
|
2154
2156
|
#
|
2155
2157
|
# **Related Resources**
|
2156
2158
|
#
|
@@ -2161,8 +2163,8 @@ module Aws::S3
|
|
2161
2163
|
#
|
2162
2164
|
#
|
2163
2165
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
2164
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2165
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2166
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2167
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
2166
2168
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html
|
2167
2169
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html
|
2168
2170
|
#
|
@@ -2171,7 +2173,7 @@ module Aws::S3
|
|
2171
2173
|
# configuration to delete.
|
2172
2174
|
#
|
2173
2175
|
# @option params [String] :expected_bucket_owner
|
2174
|
-
# The account
|
2176
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2175
2177
|
# a different account, the request will fail with an HTTP `403 (Access
|
2176
2178
|
# Denied)` error.
|
2177
2179
|
#
|
@@ -2278,8 +2280,8 @@ module Aws::S3
|
|
2278
2280
|
#
|
2279
2281
|
#
|
2280
2282
|
#
|
2281
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2282
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2283
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2284
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
2283
2285
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
2284
2286
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
2285
2287
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html
|
@@ -2293,7 +2295,7 @@ module Aws::S3
|
|
2293
2295
|
# The ID used to identify the inventory configuration.
|
2294
2296
|
#
|
2295
2297
|
# @option params [String] :expected_bucket_owner
|
2296
|
-
# The account
|
2298
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2297
2299
|
# a different account, the request will fail with an HTTP `403 (Access
|
2298
2300
|
# Denied)` error.
|
2299
2301
|
#
|
@@ -2349,7 +2351,7 @@ module Aws::S3
|
|
2349
2351
|
# The bucket name of the lifecycle to delete.
|
2350
2352
|
#
|
2351
2353
|
# @option params [String] :expected_bucket_owner
|
2352
|
-
# The account
|
2354
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2353
2355
|
# a different account, the request will fail with an HTTP `403 (Access
|
2354
2356
|
# Denied)` error.
|
2355
2357
|
#
|
@@ -2407,8 +2409,8 @@ module Aws::S3
|
|
2407
2409
|
#
|
2408
2410
|
#
|
2409
2411
|
#
|
2410
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2411
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2412
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2413
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
2412
2414
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
2413
2415
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html
|
2414
2416
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
@@ -2421,7 +2423,7 @@ module Aws::S3
|
|
2421
2423
|
# The ID used to identify the metrics configuration.
|
2422
2424
|
#
|
2423
2425
|
# @option params [String] :expected_bucket_owner
|
2424
|
-
# The account
|
2426
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2425
2427
|
# a different account, the request will fail with an HTTP `403 (Access
|
2426
2428
|
# Denied)` error.
|
2427
2429
|
#
|
@@ -2468,7 +2470,7 @@ module Aws::S3
|
|
2468
2470
|
# The Amazon S3 bucket whose `OwnershipControls` you want to delete.
|
2469
2471
|
#
|
2470
2472
|
# @option params [String] :expected_bucket_owner
|
2471
|
-
# The account
|
2473
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2472
2474
|
# a different account, the request will fail with an HTTP `403 (Access
|
2473
2475
|
# Denied)` error.
|
2474
2476
|
#
|
@@ -2525,7 +2527,7 @@ module Aws::S3
|
|
2525
2527
|
# The bucket name.
|
2526
2528
|
#
|
2527
2529
|
# @option params [String] :expected_bucket_owner
|
2528
|
-
# The account
|
2530
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2529
2531
|
# a different account, the request will fail with an HTTP `403 (Access
|
2530
2532
|
# Denied)` error.
|
2531
2533
|
#
|
@@ -2581,8 +2583,8 @@ module Aws::S3
|
|
2581
2583
|
#
|
2582
2584
|
#
|
2583
2585
|
#
|
2584
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2585
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2586
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2587
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
2586
2588
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html
|
2587
2589
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html
|
2588
2590
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html
|
@@ -2591,7 +2593,7 @@ module Aws::S3
|
|
2591
2593
|
# The bucket name.
|
2592
2594
|
#
|
2593
2595
|
# @option params [String] :expected_bucket_owner
|
2594
|
-
# The account
|
2596
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2595
2597
|
# a different account, the request will fail with an HTTP `403 (Access
|
2596
2598
|
# Denied)` error.
|
2597
2599
|
#
|
@@ -2643,7 +2645,7 @@ module Aws::S3
|
|
2643
2645
|
# The bucket that has the tag set to be removed.
|
2644
2646
|
#
|
2645
2647
|
# @option params [String] :expected_bucket_owner
|
2646
|
-
# The account
|
2648
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2647
2649
|
# a different account, the request will fail with an HTTP `403 (Access
|
2648
2650
|
# Denied)` error.
|
2649
2651
|
#
|
@@ -2707,7 +2709,7 @@ module Aws::S3
|
|
2707
2709
|
# configuration.
|
2708
2710
|
#
|
2709
2711
|
# @option params [String] :expected_bucket_owner
|
2710
|
-
# The account
|
2712
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2711
2713
|
# a different account, the request will fail with an HTTP `403 (Access
|
2712
2714
|
# Denied)` error.
|
2713
2715
|
#
|
@@ -2798,8 +2800,8 @@ module Aws::S3
|
|
2798
2800
|
#
|
2799
2801
|
#
|
2800
2802
|
#
|
2801
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2802
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2803
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
2804
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
2803
2805
|
#
|
2804
2806
|
# @option params [required, String] :key
|
2805
2807
|
# Key name of the object to delete.
|
@@ -2829,7 +2831,7 @@ module Aws::S3
|
|
2829
2831
|
# restrictions to process this operation.
|
2830
2832
|
#
|
2831
2833
|
# @option params [String] :expected_bucket_owner
|
2832
|
-
# The account
|
2834
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2833
2835
|
# a different account, the request will fail with an HTTP `403 (Access
|
2834
2836
|
# Denied)` error.
|
2835
2837
|
#
|
@@ -2934,8 +2936,8 @@ module Aws::S3
|
|
2934
2936
|
#
|
2935
2937
|
#
|
2936
2938
|
#
|
2937
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2938
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2939
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
2940
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
2939
2941
|
#
|
2940
2942
|
# @option params [required, String] :key
|
2941
2943
|
# The key that identifies the object in the bucket from which to remove
|
@@ -2945,7 +2947,7 @@ module Aws::S3
|
|
2945
2947
|
# The versionId of the object that the tag-set will be removed from.
|
2946
2948
|
#
|
2947
2949
|
# @option params [String] :expected_bucket_owner
|
2948
|
-
# The account
|
2950
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2949
2951
|
# a different account, the request will fail with an HTTP `403 (Access
|
2950
2952
|
# Denied)` error.
|
2951
2953
|
#
|
@@ -2954,35 +2956,35 @@ module Aws::S3
|
|
2954
2956
|
# * {Types::DeleteObjectTaggingOutput#version_id #version_id} => String
|
2955
2957
|
#
|
2956
2958
|
#
|
2957
|
-
# @example Example: To remove tag set from an object
|
2959
|
+
# @example Example: To remove tag set from an object
|
2958
2960
|
#
|
2959
|
-
# # The following example removes tag set associated with the specified object
|
2960
|
-
# #
|
2961
|
+
# # The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the
|
2962
|
+
# # operation removes tag set from the latest object version.
|
2961
2963
|
#
|
2962
2964
|
# resp = client.delete_object_tagging({
|
2963
2965
|
# bucket: "examplebucket",
|
2964
2966
|
# key: "HappyFace.jpg",
|
2965
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2966
2967
|
# })
|
2967
2968
|
#
|
2968
2969
|
# resp.to_h outputs the following:
|
2969
2970
|
# {
|
2970
|
-
# version_id: "
|
2971
|
+
# version_id: "null",
|
2971
2972
|
# }
|
2972
2973
|
#
|
2973
|
-
# @example Example: To remove tag set from an object
|
2974
|
+
# @example Example: To remove tag set from an object version
|
2974
2975
|
#
|
2975
|
-
# # The following example removes tag set associated with the specified object.
|
2976
|
-
# #
|
2976
|
+
# # The following example removes tag set associated with the specified object version. The request specifies both the
|
2977
|
+
# # object key and object version.
|
2977
2978
|
#
|
2978
2979
|
# resp = client.delete_object_tagging({
|
2979
2980
|
# bucket: "examplebucket",
|
2980
2981
|
# key: "HappyFace.jpg",
|
2982
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2981
2983
|
# })
|
2982
2984
|
#
|
2983
2985
|
# resp.to_h outputs the following:
|
2984
2986
|
# {
|
2985
|
-
# version_id: "
|
2987
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2986
2988
|
# }
|
2987
2989
|
#
|
2988
2990
|
# @example Request syntax with placeholder values
|
@@ -3082,8 +3084,8 @@ module Aws::S3
|
|
3082
3084
|
#
|
3083
3085
|
#
|
3084
3086
|
#
|
3085
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3086
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3087
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
3088
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
3087
3089
|
#
|
3088
3090
|
# @option params [required, Types::Delete] :delete
|
3089
3091
|
# Container for the request.
|
@@ -3111,7 +3113,7 @@ module Aws::S3
|
|
3111
3113
|
# permissions to perform this operation.
|
3112
3114
|
#
|
3113
3115
|
# @option params [String] :expected_bucket_owner
|
3114
|
-
# The account
|
3116
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3115
3117
|
# a different account, the request will fail with an HTTP `403 (Access
|
3116
3118
|
# Denied)` error.
|
3117
3119
|
#
|
@@ -3122,20 +3124,22 @@ module Aws::S3
|
|
3122
3124
|
# * {Types::DeleteObjectsOutput#errors #errors} => Array<Types::Error>
|
3123
3125
|
#
|
3124
3126
|
#
|
3125
|
-
# @example Example: To delete multiple
|
3127
|
+
# @example Example: To delete multiple object versions from a versioned bucket
|
3126
3128
|
#
|
3127
|
-
# # The following example deletes objects from a bucket. The
|
3128
|
-
# #
|
3129
|
+
# # The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object
|
3130
|
+
# # versions and returns the key and versions of deleted objects in the response.
|
3129
3131
|
#
|
3130
3132
|
# resp = client.delete_objects({
|
3131
3133
|
# bucket: "examplebucket",
|
3132
3134
|
# delete: {
|
3133
3135
|
# objects: [
|
3134
3136
|
# {
|
3135
|
-
# key: "
|
3137
|
+
# key: "HappyFace.jpg",
|
3138
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3136
3139
|
# },
|
3137
3140
|
# {
|
3138
|
-
# key: "
|
3141
|
+
# key: "HappyFace.jpg",
|
3142
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3139
3143
|
# },
|
3140
3144
|
# ],
|
3141
3145
|
# quiet: false,
|
@@ -3146,34 +3150,30 @@ module Aws::S3
|
|
3146
3150
|
# {
|
3147
3151
|
# deleted: [
|
3148
3152
|
# {
|
3149
|
-
#
|
3150
|
-
#
|
3151
|
-
# key: "objectkey1",
|
3153
|
+
# key: "HappyFace.jpg",
|
3154
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3152
3155
|
# },
|
3153
3156
|
# {
|
3154
|
-
#
|
3155
|
-
#
|
3156
|
-
# key: "objectkey2",
|
3157
|
+
# key: "HappyFace.jpg",
|
3158
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3157
3159
|
# },
|
3158
3160
|
# ],
|
3159
3161
|
# }
|
3160
3162
|
#
|
3161
|
-
# @example Example: To delete multiple
|
3163
|
+
# @example Example: To delete multiple objects from a versioned bucket
|
3162
3164
|
#
|
3163
|
-
# # The following example deletes objects from a bucket. The
|
3164
|
-
# #
|
3165
|
+
# # The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the
|
3166
|
+
# # object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
|
3165
3167
|
#
|
3166
3168
|
# resp = client.delete_objects({
|
3167
3169
|
# bucket: "examplebucket",
|
3168
3170
|
# delete: {
|
3169
3171
|
# objects: [
|
3170
3172
|
# {
|
3171
|
-
# key: "
|
3172
|
-
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3173
|
+
# key: "objectkey1",
|
3173
3174
|
# },
|
3174
3175
|
# {
|
3175
|
-
# key: "
|
3176
|
-
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3176
|
+
# key: "objectkey2",
|
3177
3177
|
# },
|
3178
3178
|
# ],
|
3179
3179
|
# quiet: false,
|
@@ -3184,12 +3184,14 @@ module Aws::S3
|
|
3184
3184
|
# {
|
3185
3185
|
# deleted: [
|
3186
3186
|
# {
|
3187
|
-
#
|
3188
|
-
#
|
3187
|
+
# delete_marker: true,
|
3188
|
+
# delete_marker_version_id: "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
|
3189
|
+
# key: "objectkey1",
|
3189
3190
|
# },
|
3190
3191
|
# {
|
3191
|
-
#
|
3192
|
-
#
|
3192
|
+
# delete_marker: true,
|
3193
|
+
# delete_marker_version_id: "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
|
3194
|
+
# key: "objectkey2",
|
3193
3195
|
# },
|
3194
3196
|
# ],
|
3195
3197
|
# }
|
@@ -3255,8 +3257,8 @@ module Aws::S3
|
|
3255
3257
|
#
|
3256
3258
|
#
|
3257
3259
|
#
|
3258
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3259
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3260
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3261
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3260
3262
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
|
3261
3263
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html
|
3262
3264
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html
|
@@ -3267,7 +3269,7 @@ module Aws::S3
|
|
3267
3269
|
# to delete.
|
3268
3270
|
#
|
3269
3271
|
# @option params [String] :expected_bucket_owner
|
3270
|
-
# The account
|
3272
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3271
3273
|
# a different account, the request will fail with an HTTP `403 (Access
|
3272
3274
|
# Denied)` error.
|
3273
3275
|
#
|
@@ -3300,8 +3302,8 @@ module Aws::S3
|
|
3300
3302
|
# permission by default. The bucket owner can grant this permission to
|
3301
3303
|
# others. For more information about permissions, see [Permissions
|
3302
3304
|
# Related to Bucket Subresource Operations][1] and [Managing Access
|
3303
|
-
# Permissions to your Amazon S3 Resources][2] in the *Amazon
|
3304
|
-
#
|
3305
|
+
# Permissions to your Amazon S3 Resources][2] in the *Amazon S3 User
|
3306
|
+
# Guide*.
|
3305
3307
|
#
|
3306
3308
|
# You set the Transfer Acceleration state of an existing bucket to
|
3307
3309
|
# `Enabled` or `Suspended` by using the
|
@@ -3312,7 +3314,7 @@ module Aws::S3
|
|
3312
3314
|
# Acceleration state if a state has never been set on the bucket.
|
3313
3315
|
#
|
3314
3316
|
# For more information about transfer acceleration, see [Transfer
|
3315
|
-
# Acceleration][4] in the Amazon
|
3317
|
+
# Acceleration][4] in the Amazon S3 User Guide.
|
3316
3318
|
#
|
3317
3319
|
# **Related Resources**
|
3318
3320
|
#
|
@@ -3322,8 +3324,8 @@ module Aws::S3
|
|
3322
3324
|
#
|
3323
3325
|
#
|
3324
3326
|
#
|
3325
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3326
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3327
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3328
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3327
3329
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html
|
3328
3330
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
3329
3331
|
#
|
@@ -3332,7 +3334,7 @@ module Aws::S3
|
|
3332
3334
|
# retrieved.
|
3333
3335
|
#
|
3334
3336
|
# @option params [String] :expected_bucket_owner
|
3335
|
-
# The account
|
3337
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3336
3338
|
# a different account, the request will fail with an HTTP `403 (Access
|
3337
3339
|
# Denied)` error.
|
3338
3340
|
#
|
@@ -3381,7 +3383,7 @@ module Aws::S3
|
|
3381
3383
|
# Specifies the S3 bucket whose ACL is being requested.
|
3382
3384
|
#
|
3383
3385
|
# @option params [String] :expected_bucket_owner
|
3384
|
-
# The account
|
3386
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3385
3387
|
# a different account, the request will fail with an HTTP `403 (Access
|
3386
3388
|
# Denied)` error.
|
3387
3389
|
#
|
@@ -3427,12 +3429,11 @@ module Aws::S3
|
|
3427
3429
|
# permission by default. The bucket owner can grant this permission to
|
3428
3430
|
# others. For more information about permissions, see [ Permissions
|
3429
3431
|
# Related to Bucket Subresource Operations][1] and [Managing Access
|
3430
|
-
# Permissions to Your Amazon S3 Resources][2] in the *Amazon
|
3431
|
-
#
|
3432
|
+
# Permissions to Your Amazon S3 Resources][2] in the *Amazon S3 User
|
3433
|
+
# Guide*.
|
3432
3434
|
#
|
3433
3435
|
# For information about Amazon S3 analytics feature, see [Amazon S3
|
3434
|
-
# Analytics – Storage Class Analysis][3] in the *Amazon
|
3435
|
-
# Service User Guide*.
|
3436
|
+
# Analytics – Storage Class Analysis][3] in the *Amazon S3 User Guide*.
|
3436
3437
|
#
|
3437
3438
|
# **Related Resources**
|
3438
3439
|
#
|
@@ -3444,8 +3445,8 @@ module Aws::S3
|
|
3444
3445
|
#
|
3445
3446
|
#
|
3446
3447
|
#
|
3447
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3448
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3448
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3449
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3449
3450
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
3450
3451
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
3451
3452
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html
|
@@ -3459,7 +3460,7 @@ module Aws::S3
|
|
3459
3460
|
# The ID that identifies the analytics configuration.
|
3460
3461
|
#
|
3461
3462
|
# @option params [String] :expected_bucket_owner
|
3462
|
-
# The account
|
3463
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3463
3464
|
# a different account, the request will fail with an HTTP `403 (Access
|
3464
3465
|
# Denied)` error.
|
3465
3466
|
#
|
@@ -3525,7 +3526,7 @@ module Aws::S3
|
|
3525
3526
|
# The bucket name for which to get the cors configuration.
|
3526
3527
|
#
|
3527
3528
|
# @option params [String] :expected_bucket_owner
|
3528
|
-
# The account
|
3529
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3529
3530
|
# a different account, the request will fail with an HTTP `403 (Access
|
3530
3531
|
# Denied)` error.
|
3531
3532
|
#
|
@@ -3614,8 +3615,8 @@ module Aws::S3
|
|
3614
3615
|
#
|
3615
3616
|
#
|
3616
3617
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
3617
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3618
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3618
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3619
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3619
3620
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html
|
3620
3621
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html
|
3621
3622
|
#
|
@@ -3624,7 +3625,7 @@ module Aws::S3
|
|
3624
3625
|
# configuration is retrieved.
|
3625
3626
|
#
|
3626
3627
|
# @option params [String] :expected_bucket_owner
|
3627
|
-
# The account
|
3628
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3628
3629
|
# a different account, the request will fail with an HTTP `403 (Access
|
3629
3630
|
# Denied)` error.
|
3630
3631
|
#
|
@@ -3758,8 +3759,8 @@ module Aws::S3
|
|
3758
3759
|
#
|
3759
3760
|
#
|
3760
3761
|
#
|
3761
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3762
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3762
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3763
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3763
3764
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
3764
3765
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
3765
3766
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
|
@@ -3773,7 +3774,7 @@ module Aws::S3
|
|
3773
3774
|
# The ID used to identify the inventory configuration.
|
3774
3775
|
#
|
3775
3776
|
# @option params [String] :expected_bucket_owner
|
3776
|
-
# The account
|
3777
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3777
3778
|
# a different account, the request will fail with an HTTP `403 (Access
|
3778
3779
|
# Denied)` error.
|
3779
3780
|
#
|
@@ -3852,8 +3853,8 @@ module Aws::S3
|
|
3852
3853
|
#
|
3853
3854
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
3854
3855
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
3855
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3856
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3856
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3857
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3857
3858
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
3858
3859
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
3859
3860
|
#
|
@@ -3861,7 +3862,7 @@ module Aws::S3
|
|
3861
3862
|
# The name of the bucket for which to get the lifecycle information.
|
3862
3863
|
#
|
3863
3864
|
# @option params [String] :expected_bucket_owner
|
3864
|
-
# The account
|
3865
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3865
3866
|
# a different account, the request will fail with an HTTP `403 (Access
|
3866
3867
|
# Denied)` error.
|
3867
3868
|
#
|
@@ -3970,8 +3971,8 @@ module Aws::S3
|
|
3970
3971
|
#
|
3971
3972
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html
|
3972
3973
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
3973
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3974
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3974
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3975
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3975
3976
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
3976
3977
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
3977
3978
|
#
|
@@ -3979,7 +3980,7 @@ module Aws::S3
|
|
3979
3980
|
# The name of the bucket for which to get the lifecycle information.
|
3980
3981
|
#
|
3981
3982
|
# @option params [String] :expected_bucket_owner
|
3982
|
-
# The account
|
3983
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3983
3984
|
# a different account, the request will fail with an HTTP `403 (Access
|
3984
3985
|
# Denied)` error.
|
3985
3986
|
#
|
@@ -4077,7 +4078,7 @@ module Aws::S3
|
|
4077
4078
|
# The name of the bucket for which to get the location.
|
4078
4079
|
#
|
4079
4080
|
# @option params [String] :expected_bucket_owner
|
4080
|
-
# The account
|
4081
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4081
4082
|
# a different account, the request will fail with an HTTP `403 (Access
|
4082
4083
|
# Denied)` error.
|
4083
4084
|
#
|
@@ -4138,7 +4139,7 @@ module Aws::S3
|
|
4138
4139
|
# The bucket name for which to get the logging information.
|
4139
4140
|
#
|
4140
4141
|
# @option params [String] :expected_bucket_owner
|
4141
|
-
# The account
|
4142
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4142
4143
|
# a different account, the request will fail with an HTTP `403 (Access
|
4143
4144
|
# Denied)` error.
|
4144
4145
|
#
|
@@ -4201,8 +4202,8 @@ module Aws::S3
|
|
4201
4202
|
#
|
4202
4203
|
#
|
4203
4204
|
#
|
4204
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4205
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4205
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
4206
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
4206
4207
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
4207
4208
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
4208
4209
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html
|
@@ -4216,7 +4217,7 @@ module Aws::S3
|
|
4216
4217
|
# The ID used to identify the metrics configuration.
|
4217
4218
|
#
|
4218
4219
|
# @option params [String] :expected_bucket_owner
|
4219
|
-
# The account
|
4220
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4220
4221
|
# a different account, the request will fail with an HTTP `403 (Access
|
4221
4222
|
# Denied)` error.
|
4222
4223
|
#
|
@@ -4263,7 +4264,7 @@ module Aws::S3
|
|
4263
4264
|
# configuration.
|
4264
4265
|
#
|
4265
4266
|
# @option params [String] :expected_bucket_owner
|
4266
|
-
# The account
|
4267
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4267
4268
|
# a different account, the request will fail with an HTTP `403 (Access
|
4268
4269
|
# Denied)` error.
|
4269
4270
|
#
|
@@ -4397,7 +4398,7 @@ module Aws::S3
|
|
4397
4398
|
# configuration.
|
4398
4399
|
#
|
4399
4400
|
# @option params [String] :expected_bucket_owner
|
4400
|
-
# The account
|
4401
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4401
4402
|
# a different account, the request will fail with an HTTP `403 (Access
|
4402
4403
|
# Denied)` error.
|
4403
4404
|
#
|
@@ -4474,7 +4475,7 @@ module Aws::S3
|
|
4474
4475
|
# retrieve.
|
4475
4476
|
#
|
4476
4477
|
# @option params [String] :expected_bucket_owner
|
4477
|
-
# The account
|
4478
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4478
4479
|
# a different account, the request will fail with an HTTP `403 (Access
|
4479
4480
|
# Denied)` error.
|
4480
4481
|
#
|
@@ -4536,7 +4537,7 @@ module Aws::S3
|
|
4536
4537
|
# The bucket name for which to get the bucket policy.
|
4537
4538
|
#
|
4538
4539
|
# @option params [String] :expected_bucket_owner
|
4539
|
-
# The account
|
4540
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4540
4541
|
# a different account, the request will fail with an HTTP `403 (Access
|
4541
4542
|
# Denied)` error.
|
4542
4543
|
#
|
@@ -4611,7 +4612,7 @@ module Aws::S3
|
|
4611
4612
|
# retrieve.
|
4612
4613
|
#
|
4613
4614
|
# @option params [String] :expected_bucket_owner
|
4614
|
-
# The account
|
4615
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4615
4616
|
# a different account, the request will fail with an HTTP `403 (Access
|
4616
4617
|
# Denied)` error.
|
4617
4618
|
#
|
@@ -4648,7 +4649,7 @@ module Aws::S3
|
|
4648
4649
|
# </note>
|
4649
4650
|
#
|
4650
4651
|
# For information about replication configuration, see [Replication][1]
|
4651
|
-
# in the *Amazon
|
4652
|
+
# in the *Amazon S3 User Guide*.
|
4652
4653
|
#
|
4653
4654
|
# This action requires permissions for the
|
4654
4655
|
# `s3:GetReplicationConfiguration` action. For more information about
|
@@ -4679,7 +4680,7 @@ module Aws::S3
|
|
4679
4680
|
# The bucket name for which to get the replication information.
|
4680
4681
|
#
|
4681
4682
|
# @option params [String] :expected_bucket_owner
|
4682
|
-
# The account
|
4683
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4683
4684
|
# a different account, the request will fail with an HTTP `403 (Access
|
4684
4685
|
# Denied)` error.
|
4685
4686
|
#
|
@@ -4778,7 +4779,7 @@ module Aws::S3
|
|
4778
4779
|
# configuration
|
4779
4780
|
#
|
4780
4781
|
# @option params [String] :expected_bucket_owner
|
4781
|
-
# The account
|
4782
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4782
4783
|
# a different account, the request will fail with an HTTP `403 (Access
|
4783
4784
|
# Denied)` error.
|
4784
4785
|
#
|
@@ -4849,7 +4850,7 @@ module Aws::S3
|
|
4849
4850
|
# The name of the bucket for which to get the tagging information.
|
4850
4851
|
#
|
4851
4852
|
# @option params [String] :expected_bucket_owner
|
4852
|
-
# The account
|
4853
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4853
4854
|
# a different account, the request will fail with an HTTP `403 (Access
|
4854
4855
|
# Denied)` error.
|
4855
4856
|
#
|
@@ -4930,7 +4931,7 @@ module Aws::S3
|
|
4930
4931
|
# The name of the bucket for which to get the versioning information.
|
4931
4932
|
#
|
4932
4933
|
# @option params [String] :expected_bucket_owner
|
4933
|
-
# The account
|
4934
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4934
4935
|
# a different account, the request will fail with an HTTP `403 (Access
|
4935
4936
|
# Denied)` error.
|
4936
4937
|
#
|
@@ -5002,7 +5003,7 @@ module Aws::S3
|
|
5002
5003
|
# The bucket name for which to get the website configuration.
|
5003
5004
|
#
|
5004
5005
|
# @option params [String] :expected_bucket_owner
|
5005
|
-
# The account
|
5006
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5006
5007
|
# a different account, the request will fail with an HTTP `403 (Access
|
5007
5008
|
# Denied)` error.
|
5008
5009
|
#
|
@@ -5243,8 +5244,8 @@ module Aws::S3
|
|
5243
5244
|
#
|
5244
5245
|
#
|
5245
5246
|
#
|
5246
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5247
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5247
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5248
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
5248
5249
|
#
|
5249
5250
|
# @option params [String] :if_match
|
5250
5251
|
# Return the object only if its entity tag (ETag) is the same as the one
|
@@ -5334,7 +5335,7 @@ module Aws::S3
|
|
5334
5335
|
# object.
|
5335
5336
|
#
|
5336
5337
|
# @option params [String] :expected_bucket_owner
|
5337
|
-
# The account
|
5338
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5338
5339
|
# a different account, the request will fail with an HTTP `403 (Access
|
5339
5340
|
# Denied)` error.
|
5340
5341
|
#
|
@@ -5375,49 +5376,49 @@ module Aws::S3
|
|
5375
5376
|
# * {Types::GetObjectOutput#object_lock_legal_hold_status #object_lock_legal_hold_status} => String
|
5376
5377
|
#
|
5377
5378
|
#
|
5378
|
-
# @example Example: To retrieve
|
5379
|
+
# @example Example: To retrieve an object
|
5379
5380
|
#
|
5380
|
-
# # The following example retrieves an object for an S3 bucket.
|
5381
|
-
# # specific byte range.
|
5381
|
+
# # The following example retrieves an object for an S3 bucket.
|
5382
5382
|
#
|
5383
5383
|
# resp = client.get_object({
|
5384
5384
|
# bucket: "examplebucket",
|
5385
|
-
# key: "
|
5386
|
-
# range: "bytes=0-9",
|
5385
|
+
# key: "HappyFace.jpg",
|
5387
5386
|
# })
|
5388
5387
|
#
|
5389
5388
|
# resp.to_h outputs the following:
|
5390
5389
|
# {
|
5391
5390
|
# accept_ranges: "bytes",
|
5392
|
-
# content_length:
|
5393
|
-
#
|
5394
|
-
#
|
5395
|
-
#
|
5396
|
-
# last_modified: Time.parse("Thu, 09 Oct 2014 22:57:28 GMT"),
|
5391
|
+
# content_length: 3191,
|
5392
|
+
# content_type: "image/jpeg",
|
5393
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
5394
|
+
# last_modified: Time.parse("Thu, 15 Dec 2016 01:19:41 GMT"),
|
5397
5395
|
# metadata: {
|
5398
5396
|
# },
|
5397
|
+
# tag_count: 2,
|
5399
5398
|
# version_id: "null",
|
5400
5399
|
# }
|
5401
5400
|
#
|
5402
|
-
# @example Example: To retrieve an object
|
5401
|
+
# @example Example: To retrieve a byte range of an object
|
5403
5402
|
#
|
5404
|
-
# # The following example retrieves an object for an S3 bucket.
|
5403
|
+
# # The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a
|
5404
|
+
# # specific byte range.
|
5405
5405
|
#
|
5406
5406
|
# resp = client.get_object({
|
5407
5407
|
# bucket: "examplebucket",
|
5408
|
-
# key: "
|
5408
|
+
# key: "SampleFile.txt",
|
5409
|
+
# range: "bytes=0-9",
|
5409
5410
|
# })
|
5410
5411
|
#
|
5411
5412
|
# resp.to_h outputs the following:
|
5412
5413
|
# {
|
5413
5414
|
# accept_ranges: "bytes",
|
5414
|
-
# content_length:
|
5415
|
-
#
|
5416
|
-
#
|
5417
|
-
#
|
5415
|
+
# content_length: 10,
|
5416
|
+
# content_range: "bytes 0-9/43",
|
5417
|
+
# content_type: "text/plain",
|
5418
|
+
# etag: "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
|
5419
|
+
# last_modified: Time.parse("Thu, 09 Oct 2014 22:57:28 GMT"),
|
5418
5420
|
# metadata: {
|
5419
5421
|
# },
|
5420
|
-
# tag_count: 2,
|
5421
5422
|
# version_id: "null",
|
5422
5423
|
# }
|
5423
5424
|
#
|
@@ -5560,7 +5561,7 @@ module Aws::S3
|
|
5560
5561
|
#
|
5561
5562
|
#
|
5562
5563
|
#
|
5563
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5564
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5564
5565
|
#
|
5565
5566
|
# @option params [required, String] :key
|
5566
5567
|
# The key of the object for which to get the ACL information.
|
@@ -5580,7 +5581,7 @@ module Aws::S3
|
|
5580
5581
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
5581
5582
|
#
|
5582
5583
|
# @option params [String] :expected_bucket_owner
|
5583
|
-
# The account
|
5584
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5584
5585
|
# a different account, the request will fail with an HTTP `403 (Access
|
5585
5586
|
# Denied)` error.
|
5586
5587
|
#
|
@@ -5697,7 +5698,7 @@ module Aws::S3
|
|
5697
5698
|
#
|
5698
5699
|
#
|
5699
5700
|
#
|
5700
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5701
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5701
5702
|
#
|
5702
5703
|
# @option params [required, String] :key
|
5703
5704
|
# The key name for the object whose Legal Hold status you want to
|
@@ -5719,7 +5720,7 @@ module Aws::S3
|
|
5719
5720
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
5720
5721
|
#
|
5721
5722
|
# @option params [String] :expected_bucket_owner
|
5722
|
-
# The account
|
5723
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5723
5724
|
# a different account, the request will fail with an HTTP `403 (Access
|
5724
5725
|
# Denied)` error.
|
5725
5726
|
#
|
@@ -5772,10 +5773,10 @@ module Aws::S3
|
|
5772
5773
|
#
|
5773
5774
|
#
|
5774
5775
|
#
|
5775
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5776
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5776
5777
|
#
|
5777
5778
|
# @option params [String] :expected_bucket_owner
|
5778
|
-
# The account
|
5779
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5779
5780
|
# a different account, the request will fail with an HTTP `403 (Access
|
5780
5781
|
# Denied)` error.
|
5781
5782
|
#
|
@@ -5829,7 +5830,7 @@ module Aws::S3
|
|
5829
5830
|
#
|
5830
5831
|
#
|
5831
5832
|
#
|
5832
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5833
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5833
5834
|
#
|
5834
5835
|
# @option params [required, String] :key
|
5835
5836
|
# The key name for the object whose retention settings you want to
|
@@ -5851,7 +5852,7 @@ module Aws::S3
|
|
5851
5852
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
5852
5853
|
#
|
5853
5854
|
# @option params [String] :expected_bucket_owner
|
5854
|
-
# The account
|
5855
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5855
5856
|
# a different account, the request will fail with an HTTP `403 (Access
|
5856
5857
|
# Denied)` error.
|
5857
5858
|
#
|
@@ -5934,8 +5935,8 @@ module Aws::S3
|
|
5934
5935
|
#
|
5935
5936
|
#
|
5936
5937
|
#
|
5937
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5938
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5938
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5939
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
5939
5940
|
#
|
5940
5941
|
# @option params [required, String] :key
|
5941
5942
|
# Object key for which to get the tagging information.
|
@@ -5944,7 +5945,7 @@ module Aws::S3
|
|
5944
5945
|
# The versionId of the object for which to get the tagging information.
|
5945
5946
|
#
|
5946
5947
|
# @option params [String] :expected_bucket_owner
|
5947
|
-
# The account
|
5948
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5948
5949
|
# a different account, the request will fail with an HTTP `403 (Access
|
5949
5950
|
# Denied)` error.
|
5950
5951
|
#
|
@@ -5965,49 +5966,49 @@ module Aws::S3
|
|
5965
5966
|
# * {Types::GetObjectTaggingOutput#tag_set #tag_set} => Array<Types::Tag>
|
5966
5967
|
#
|
5967
5968
|
#
|
5968
|
-
# @example Example: To retrieve tag set of
|
5969
|
+
# @example Example: To retrieve tag set of a specific object version
|
5969
5970
|
#
|
5970
|
-
# # The following example retrieves tag set of an object.
|
5971
|
+
# # The following example retrieves tag set of an object. The request specifies object version.
|
5971
5972
|
#
|
5972
5973
|
# resp = client.get_object_tagging({
|
5973
5974
|
# bucket: "examplebucket",
|
5974
|
-
# key: "
|
5975
|
+
# key: "exampleobject",
|
5976
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
5975
5977
|
# })
|
5976
5978
|
#
|
5977
5979
|
# resp.to_h outputs the following:
|
5978
5980
|
# {
|
5979
5981
|
# tag_set: [
|
5980
5982
|
# {
|
5981
|
-
# key: "
|
5982
|
-
# value: "
|
5983
|
-
# },
|
5984
|
-
# {
|
5985
|
-
# key: "Key3",
|
5986
|
-
# value: "Value3",
|
5983
|
+
# key: "Key1",
|
5984
|
+
# value: "Value1",
|
5987
5985
|
# },
|
5988
5986
|
# ],
|
5989
|
-
# version_id: "
|
5987
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
5990
5988
|
# }
|
5991
5989
|
#
|
5992
|
-
# @example Example: To retrieve tag set of
|
5990
|
+
# @example Example: To retrieve tag set of an object
|
5993
5991
|
#
|
5994
|
-
# # The following example retrieves tag set of an object.
|
5992
|
+
# # The following example retrieves tag set of an object.
|
5995
5993
|
#
|
5996
5994
|
# resp = client.get_object_tagging({
|
5997
5995
|
# bucket: "examplebucket",
|
5998
|
-
# key: "
|
5999
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
5996
|
+
# key: "HappyFace.jpg",
|
6000
5997
|
# })
|
6001
5998
|
#
|
6002
5999
|
# resp.to_h outputs the following:
|
6003
6000
|
# {
|
6004
6001
|
# tag_set: [
|
6005
6002
|
# {
|
6006
|
-
# key: "
|
6007
|
-
# value: "
|
6003
|
+
# key: "Key4",
|
6004
|
+
# value: "Value4",
|
6005
|
+
# },
|
6006
|
+
# {
|
6007
|
+
# key: "Key3",
|
6008
|
+
# value: "Value3",
|
6008
6009
|
# },
|
6009
6010
|
# ],
|
6010
|
-
# version_id: "
|
6011
|
+
# version_id: "null",
|
6011
6012
|
# }
|
6012
6013
|
#
|
6013
6014
|
# @example Request syntax with placeholder values
|
@@ -6083,7 +6084,7 @@ module Aws::S3
|
|
6083
6084
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
6084
6085
|
#
|
6085
6086
|
# @option params [String] :expected_bucket_owner
|
6086
|
-
# The account
|
6087
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6087
6088
|
# a different account, the request will fail with an HTTP `403 (Access
|
6088
6089
|
# Denied)` error.
|
6089
6090
|
#
|
@@ -6169,7 +6170,7 @@ module Aws::S3
|
|
6169
6170
|
# configuration you want to retrieve.
|
6170
6171
|
#
|
6171
6172
|
# @option params [String] :expected_bucket_owner
|
6172
|
-
# The account
|
6173
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6173
6174
|
# a different account, the request will fail with an HTTP `403 (Access
|
6174
6175
|
# Denied)` error.
|
6175
6176
|
#
|
@@ -6218,8 +6219,8 @@ module Aws::S3
|
|
6218
6219
|
#
|
6219
6220
|
#
|
6220
6221
|
#
|
6221
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6222
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6222
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6223
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6223
6224
|
#
|
6224
6225
|
# @option params [required, String] :bucket
|
6225
6226
|
# The bucket name.
|
@@ -6243,11 +6244,11 @@ module Aws::S3
|
|
6243
6244
|
#
|
6244
6245
|
#
|
6245
6246
|
#
|
6246
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6247
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6247
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
6248
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
6248
6249
|
#
|
6249
6250
|
# @option params [String] :expected_bucket_owner
|
6250
|
-
# The account
|
6251
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6251
6252
|
# a different account, the request will fail with an HTTP `403 (Access
|
6252
6253
|
# Denied)` error.
|
6253
6254
|
#
|
@@ -6396,8 +6397,8 @@ module Aws::S3
|
|
6396
6397
|
#
|
6397
6398
|
#
|
6398
6399
|
#
|
6399
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6400
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6400
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
6401
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
6401
6402
|
#
|
6402
6403
|
# @option params [String] :if_match
|
6403
6404
|
# Return the object only if its entity tag (ETag) is the same as the one
|
@@ -6469,7 +6470,7 @@ module Aws::S3
|
|
6469
6470
|
# the number of parts in this object.
|
6470
6471
|
#
|
6471
6472
|
# @option params [String] :expected_bucket_owner
|
6472
|
-
# The account
|
6473
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6473
6474
|
# a different account, the request will fail with an HTTP `403 (Access
|
6474
6475
|
# Denied)` error.
|
6475
6476
|
#
|
@@ -6631,8 +6632,8 @@ module Aws::S3
|
|
6631
6632
|
#
|
6632
6633
|
#
|
6633
6634
|
#
|
6634
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6635
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6635
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6636
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6636
6637
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
6637
6638
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html
|
6638
6639
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
@@ -6647,7 +6648,7 @@ module Aws::S3
|
|
6647
6648
|
# request should begin.
|
6648
6649
|
#
|
6649
6650
|
# @option params [String] :expected_bucket_owner
|
6650
|
-
# The account
|
6651
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6651
6652
|
# a different account, the request will fail with an HTTP `403 (Access
|
6652
6653
|
# Denied)` error.
|
6653
6654
|
#
|
@@ -6815,8 +6816,8 @@ module Aws::S3
|
|
6815
6816
|
#
|
6816
6817
|
#
|
6817
6818
|
#
|
6818
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6819
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6819
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6820
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6820
6821
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
6821
6822
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
6822
6823
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
@@ -6833,7 +6834,7 @@ module Aws::S3
|
|
6833
6834
|
# token is an opaque value that Amazon S3 understands.
|
6834
6835
|
#
|
6835
6836
|
# @option params [String] :expected_bucket_owner
|
6836
|
-
# The account
|
6837
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6837
6838
|
# a different account, the request will fail with an HTTP `403 (Access
|
6838
6839
|
# Denied)` error.
|
6839
6840
|
#
|
@@ -6915,8 +6916,8 @@ module Aws::S3
|
|
6915
6916
|
#
|
6916
6917
|
#
|
6917
6918
|
#
|
6918
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6919
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6919
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6920
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6920
6921
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
6921
6922
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
6922
6923
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html
|
@@ -6933,7 +6934,7 @@ module Aws::S3
|
|
6933
6934
|
# continuation token is an opaque value that Amazon S3 understands.
|
6934
6935
|
#
|
6935
6936
|
# @option params [String] :expected_bucket_owner
|
6936
|
-
# The account
|
6937
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6937
6938
|
# a different account, the request will fail with an HTTP `403 (Access
|
6938
6939
|
# Denied)` error.
|
6939
6940
|
#
|
@@ -7103,8 +7104,8 @@ module Aws::S3
|
|
7103
7104
|
#
|
7104
7105
|
#
|
7105
7106
|
#
|
7106
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7107
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7107
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7108
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7108
7109
|
#
|
7109
7110
|
# @option params [String] :delimiter
|
7110
7111
|
# Character you use to group keys.
|
@@ -7157,7 +7158,7 @@ module Aws::S3
|
|
7157
7158
|
# specified `upload-id-marker`.
|
7158
7159
|
#
|
7159
7160
|
# @option params [String] :expected_bucket_owner
|
7160
|
-
# The account
|
7161
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7161
7162
|
# a different account, the request will fail with an HTTP `403 (Access
|
7162
7163
|
# Denied)` error.
|
7163
7164
|
#
|
@@ -7179,97 +7180,97 @@ module Aws::S3
|
|
7179
7180
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7180
7181
|
#
|
7181
7182
|
#
|
7182
|
-
# @example Example:
|
7183
|
+
# @example Example: To list in-progress multipart uploads on a bucket
|
7183
7184
|
#
|
7184
|
-
# # The following example
|
7185
|
-
# # setup of multipart uploads.
|
7185
|
+
# # The following example lists in-progress multipart uploads on a specific bucket.
|
7186
7186
|
#
|
7187
7187
|
# resp = client.list_multipart_uploads({
|
7188
7188
|
# bucket: "examplebucket",
|
7189
|
-
# key_marker: "nextkeyfrompreviousresponse",
|
7190
|
-
# max_uploads: 2,
|
7191
|
-
# upload_id_marker: "valuefrompreviousresponse",
|
7192
7189
|
# })
|
7193
7190
|
#
|
7194
7191
|
# resp.to_h outputs the following:
|
7195
7192
|
# {
|
7196
|
-
# bucket: "acl1",
|
7197
|
-
# is_truncated: true,
|
7198
|
-
# key_marker: "",
|
7199
|
-
# max_uploads: 2,
|
7200
|
-
# next_key_marker: "someobjectkey",
|
7201
|
-
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7202
|
-
# upload_id_marker: "",
|
7203
7193
|
# uploads: [
|
7204
7194
|
# {
|
7205
7195
|
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
7206
7196
|
# initiator: {
|
7207
|
-
# display_name: "
|
7197
|
+
# display_name: "display-name",
|
7208
7198
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7209
7199
|
# },
|
7210
7200
|
# key: "JavaFile",
|
7211
7201
|
# owner: {
|
7212
|
-
# display_name: "
|
7213
|
-
# id: "
|
7202
|
+
# display_name: "display-name",
|
7203
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7214
7204
|
# },
|
7215
7205
|
# storage_class: "STANDARD",
|
7216
|
-
# upload_id: "
|
7206
|
+
# upload_id: "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
7217
7207
|
# },
|
7218
7208
|
# {
|
7219
7209
|
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
7220
7210
|
# initiator: {
|
7221
|
-
# display_name: "
|
7211
|
+
# display_name: "display-name",
|
7222
7212
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7223
7213
|
# },
|
7224
7214
|
# key: "JavaFile",
|
7225
7215
|
# owner: {
|
7226
|
-
# display_name: "
|
7216
|
+
# display_name: "display-name",
|
7227
7217
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7228
7218
|
# },
|
7229
7219
|
# storage_class: "STANDARD",
|
7230
|
-
# upload_id: "
|
7220
|
+
# upload_id: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7231
7221
|
# },
|
7232
7222
|
# ],
|
7233
7223
|
# }
|
7234
7224
|
#
|
7235
|
-
# @example Example:
|
7225
|
+
# @example Example: List next set of multipart uploads when previous result is truncated
|
7236
7226
|
#
|
7237
|
-
# # The following example
|
7227
|
+
# # The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next
|
7228
|
+
# # setup of multipart uploads.
|
7238
7229
|
#
|
7239
7230
|
# resp = client.list_multipart_uploads({
|
7240
7231
|
# bucket: "examplebucket",
|
7232
|
+
# key_marker: "nextkeyfrompreviousresponse",
|
7233
|
+
# max_uploads: 2,
|
7234
|
+
# upload_id_marker: "valuefrompreviousresponse",
|
7241
7235
|
# })
|
7242
7236
|
#
|
7243
7237
|
# resp.to_h outputs the following:
|
7244
7238
|
# {
|
7239
|
+
# bucket: "acl1",
|
7240
|
+
# is_truncated: true,
|
7241
|
+
# key_marker: "",
|
7242
|
+
# max_uploads: 2,
|
7243
|
+
# next_key_marker: "someobjectkey",
|
7244
|
+
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7245
|
+
# upload_id_marker: "",
|
7245
7246
|
# uploads: [
|
7246
7247
|
# {
|
7247
7248
|
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
7248
7249
|
# initiator: {
|
7249
|
-
# display_name: "display-name",
|
7250
|
+
# display_name: "ownder-display-name",
|
7250
7251
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7251
7252
|
# },
|
7252
7253
|
# key: "JavaFile",
|
7253
7254
|
# owner: {
|
7254
|
-
# display_name: "
|
7255
|
-
# id: "
|
7255
|
+
# display_name: "mohanataws",
|
7256
|
+
# id: "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7256
7257
|
# },
|
7257
7258
|
# storage_class: "STANDARD",
|
7258
|
-
# upload_id: "
|
7259
|
+
# upload_id: "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
7259
7260
|
# },
|
7260
7261
|
# {
|
7261
7262
|
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
7262
7263
|
# initiator: {
|
7263
|
-
# display_name: "display-name",
|
7264
|
+
# display_name: "ownder-display-name",
|
7264
7265
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7265
7266
|
# },
|
7266
7267
|
# key: "JavaFile",
|
7267
7268
|
# owner: {
|
7268
|
-
# display_name: "display-name",
|
7269
|
+
# display_name: "ownder-display-name",
|
7269
7270
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7270
7271
|
# },
|
7271
7272
|
# storage_class: "STANDARD",
|
7272
|
-
# upload_id: "
|
7273
|
+
# upload_id: "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7273
7274
|
# },
|
7274
7275
|
# ],
|
7275
7276
|
# }
|
@@ -7393,7 +7394,7 @@ module Aws::S3
|
|
7393
7394
|
# Specifies the object version you want to start listing from.
|
7394
7395
|
#
|
7395
7396
|
# @option params [String] :expected_bucket_owner
|
7396
|
-
# The account
|
7397
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7397
7398
|
# a different account, the request will fail with an HTTP `403 (Access
|
7398
7399
|
# Denied)` error.
|
7399
7400
|
#
|
@@ -7565,8 +7566,8 @@ module Aws::S3
|
|
7565
7566
|
#
|
7566
7567
|
#
|
7567
7568
|
#
|
7568
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7569
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7569
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7570
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7570
7571
|
#
|
7571
7572
|
# @option params [String] :delimiter
|
7572
7573
|
# A delimiter is a character you use to group keys.
|
@@ -7596,7 +7597,7 @@ module Aws::S3
|
|
7596
7597
|
# parameter in their requests.
|
7597
7598
|
#
|
7598
7599
|
# @option params [String] :expected_bucket_owner
|
7599
|
-
# The account
|
7600
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7600
7601
|
# a different account, the request will fail with an HTTP `403 (Access
|
7601
7602
|
# Denied)` error.
|
7602
7603
|
#
|
@@ -7731,8 +7732,8 @@ module Aws::S3
|
|
7731
7732
|
#
|
7732
7733
|
#
|
7733
7734
|
#
|
7734
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7735
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7735
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
7736
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
7736
7737
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html
|
7737
7738
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
|
7738
7739
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
@@ -7761,8 +7762,8 @@ module Aws::S3
|
|
7761
7762
|
#
|
7762
7763
|
#
|
7763
7764
|
#
|
7764
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7765
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7765
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7766
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7766
7767
|
#
|
7767
7768
|
# @option params [String] :delimiter
|
7768
7769
|
# A delimiter is a character you use to group keys.
|
@@ -7799,7 +7800,7 @@ module Aws::S3
|
|
7799
7800
|
# this parameter in their requests.
|
7800
7801
|
#
|
7801
7802
|
# @option params [String] :expected_bucket_owner
|
7802
|
-
# The account
|
7803
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7803
7804
|
# a different account, the request will fail with an HTTP `403 (Access
|
7804
7805
|
# Denied)` error.
|
7805
7806
|
#
|
@@ -7967,8 +7968,8 @@ module Aws::S3
|
|
7967
7968
|
#
|
7968
7969
|
#
|
7969
7970
|
#
|
7970
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7971
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7971
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7972
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7972
7973
|
#
|
7973
7974
|
# @option params [required, String] :key
|
7974
7975
|
# Object key for which the multipart upload was initiated.
|
@@ -7996,7 +7997,7 @@ module Aws::S3
|
|
7996
7997
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
7997
7998
|
#
|
7998
7999
|
# @option params [String] :expected_bucket_owner
|
7999
|
-
# The account
|
8000
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8000
8001
|
# a different account, the request will fail with an HTTP `403 (Access
|
8001
8002
|
# Denied)` error.
|
8002
8003
|
#
|
@@ -8141,8 +8142,8 @@ module Aws::S3
|
|
8141
8142
|
#
|
8142
8143
|
#
|
8143
8144
|
#
|
8144
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8145
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8145
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
8146
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
8146
8147
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html
|
8147
8148
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
8148
8149
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
@@ -8154,7 +8155,7 @@ module Aws::S3
|
|
8154
8155
|
# Container for setting the transfer acceleration state.
|
8155
8156
|
#
|
8156
8157
|
# @option params [String] :expected_bucket_owner
|
8157
|
-
# The account
|
8158
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8158
8159
|
# a different account, the request will fail with an HTTP `403 (Access
|
8159
8160
|
# Denied)` error.
|
8160
8161
|
#
|
@@ -8376,7 +8377,7 @@ module Aws::S3
|
|
8376
8377
|
# Allows grantee to write the ACL for the applicable bucket.
|
8377
8378
|
#
|
8378
8379
|
# @option params [String] :expected_bucket_owner
|
8379
|
-
# The account
|
8380
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8380
8381
|
# a different account, the request will fail with an HTTP `403 (Access
|
8381
8382
|
# Denied)` error.
|
8382
8383
|
#
|
@@ -8498,8 +8499,8 @@ module Aws::S3
|
|
8498
8499
|
#
|
8499
8500
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
8500
8501
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9
|
8501
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8502
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8502
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
8503
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
8503
8504
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html
|
8504
8505
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
8505
8506
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html
|
@@ -8514,7 +8515,7 @@ module Aws::S3
|
|
8514
8515
|
# The configuration and any analyses for the analytics filter.
|
8515
8516
|
#
|
8516
8517
|
# @option params [String] :expected_bucket_owner
|
8517
|
-
# The account
|
8518
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8518
8519
|
# a different account, the request will fail with an HTTP `403 (Access
|
8519
8520
|
# Denied)` error.
|
8520
8521
|
#
|
@@ -8605,7 +8606,7 @@ module Aws::S3
|
|
8605
8606
|
# element.
|
8606
8607
|
#
|
8607
8608
|
# For more information about CORS, go to [Enabling Cross-Origin Resource
|
8608
|
-
# Sharing][1] in the *Amazon
|
8609
|
+
# Sharing][1] in the *Amazon S3 User Guide*.
|
8609
8610
|
#
|
8610
8611
|
# **Related Resources**
|
8611
8612
|
#
|
@@ -8628,8 +8629,7 @@ module Aws::S3
|
|
8628
8629
|
# @option params [required, Types::CORSConfiguration] :cors_configuration
|
8629
8630
|
# Describes the cross-origin access configuration for objects in an
|
8630
8631
|
# Amazon S3 bucket. For more information, see [Enabling Cross-Origin
|
8631
|
-
# Resource Sharing][1] in the *Amazon
|
8632
|
-
# Guide*.
|
8632
|
+
# Resource Sharing][1] in the *Amazon S3 User Guide*.
|
8633
8633
|
#
|
8634
8634
|
#
|
8635
8635
|
#
|
@@ -8648,7 +8648,7 @@ module Aws::S3
|
|
8648
8648
|
# [1]: http://www.ietf.org/rfc/rfc1864.txt
|
8649
8649
|
#
|
8650
8650
|
# @option params [String] :expected_bucket_owner
|
8651
|
-
# The account
|
8651
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8652
8652
|
# a different account, the request will fail with an HTTP `403 (Access
|
8653
8653
|
# Denied)` error.
|
8654
8654
|
#
|
@@ -8735,9 +8735,8 @@ module Aws::S3
|
|
8735
8735
|
# (SSE-KMS). If you specify default encryption using SSE-KMS, you can
|
8736
8736
|
# also configure Amazon S3 Bucket Key. For information about default
|
8737
8737
|
# encryption, see [Amazon S3 default bucket encryption][1] in the
|
8738
|
-
# *Amazon
|
8739
|
-
#
|
8740
|
-
# Storage Service User Guide*.
|
8738
|
+
# *Amazon S3 User Guide*. For more information about S3 Bucket Keys, see
|
8739
|
+
# [Amazon S3 Bucket Keys][2] in the *Amazon S3 User Guide*.
|
8741
8740
|
#
|
8742
8741
|
# This action requires AWS Signature Version 4. For more information,
|
8743
8742
|
# see [ Authenticating Requests (AWS Signature Version 4)][3].
|
@@ -8747,8 +8746,8 @@ module Aws::S3
|
|
8747
8746
|
# permission by default. The bucket owner can grant this permission to
|
8748
8747
|
# others. For more information about permissions, see [Permissions
|
8749
8748
|
# Related to Bucket Subresource Operations][4] and [Managing Access
|
8750
|
-
# Permissions to Your Amazon S3 Resources][5] in the Amazon
|
8751
|
-
#
|
8749
|
+
# Permissions to Your Amazon S3 Resources][5] in the Amazon S3 User
|
8750
|
+
# Guide.
|
8752
8751
|
#
|
8753
8752
|
# **Related Resources**
|
8754
8753
|
#
|
@@ -8761,8 +8760,8 @@ module Aws::S3
|
|
8761
8760
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
8762
8761
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html
|
8763
8762
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
|
8764
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8765
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8763
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
8764
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
8766
8765
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html
|
8767
8766
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html
|
8768
8767
|
#
|
@@ -8788,7 +8787,7 @@ module Aws::S3
|
|
8788
8787
|
# Specifies the default server-side-encryption configuration.
|
8789
8788
|
#
|
8790
8789
|
# @option params [String] :expected_bucket_owner
|
8791
|
-
# The account
|
8790
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8792
8791
|
# a different account, the request will fail with an HTTP `403 (Access
|
8793
8792
|
# Denied)` error.
|
8794
8793
|
#
|
@@ -8959,8 +8958,7 @@ module Aws::S3
|
|
8959
8958
|
# whether to generate the inventory daily or weekly. You can also
|
8960
8959
|
# configure what object metadata to include and whether to inventory all
|
8961
8960
|
# object versions or only current versions. For more information, see
|
8962
|
-
# [Amazon S3 Inventory][1] in the Amazon
|
8963
|
-
# Guide.
|
8961
|
+
# [Amazon S3 Inventory][1] in the Amazon S3 User Guide.
|
8964
8962
|
#
|
8965
8963
|
# You must create a bucket policy on the *destination* bucket to grant
|
8966
8964
|
# permissions to Amazon S3 to write objects to the bucket in the defined
|
@@ -8972,8 +8970,7 @@ module Aws::S3
|
|
8972
8970
|
# permission by default and can grant this permission to others. For
|
8973
8971
|
# more information about permissions, see [Permissions Related to Bucket
|
8974
8972
|
# Subresource Operations][3] and [Managing Access Permissions to Your
|
8975
|
-
# Amazon S3 Resources][4] in the Amazon
|
8976
|
-
# Guide.
|
8973
|
+
# Amazon S3 Resources][4] in the Amazon S3 User Guide.
|
8977
8974
|
#
|
8978
8975
|
# **Special Errors**
|
8979
8976
|
#
|
@@ -9010,8 +9007,8 @@ module Aws::S3
|
|
9010
9007
|
#
|
9011
9008
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
9012
9009
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9
|
9013
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9014
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9010
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
9011
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9015
9012
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
9016
9013
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
9017
9014
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
|
@@ -9027,7 +9024,7 @@ module Aws::S3
|
|
9027
9024
|
# Specifies the inventory configuration.
|
9028
9025
|
#
|
9029
9026
|
# @option params [String] :expected_bucket_owner
|
9030
|
-
# The account
|
9027
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9031
9028
|
# a different account, the request will fail with an HTTP `403 (Access
|
9032
9029
|
# Denied)` error.
|
9033
9030
|
#
|
@@ -9084,8 +9081,8 @@ module Aws::S3
|
|
9084
9081
|
#
|
9085
9082
|
# Creates a new lifecycle configuration for the bucket or replaces an
|
9086
9083
|
# existing lifecycle configuration. For information about lifecycle
|
9087
|
-
# configuration, see [Object Lifecycle Management][2] in the *Amazon
|
9088
|
-
#
|
9084
|
+
# configuration, see [Object Lifecycle Management][2] in the *Amazon S3
|
9085
|
+
# User Guide*.
|
9089
9086
|
#
|
9090
9087
|
# By default, all Amazon S3 resources, including buckets, objects, and
|
9091
9088
|
# related subresources (for example, lifecycle configuration and website
|
@@ -9107,8 +9104,8 @@ module Aws::S3
|
|
9107
9104
|
# * `s3:PutLifecycleConfiguration`
|
9108
9105
|
#
|
9109
9106
|
# For more information about permissions, see [Managing Access
|
9110
|
-
# Permissions to your Amazon S3 Resources][3] in the *Amazon
|
9111
|
-
#
|
9107
|
+
# Permissions to your Amazon S3 Resources][3] in the *Amazon S3 User
|
9108
|
+
# Guide*.
|
9112
9109
|
#
|
9113
9110
|
# For more examples of transitioning objects to storage classes such as
|
9114
9111
|
# STANDARD\_IA or ONEZONE\_IA, see [Examples of Lifecycle
|
@@ -9126,7 +9123,7 @@ module Aws::S3
|
|
9126
9123
|
# the AWS account that created the bucket—can perform any of the
|
9127
9124
|
# operations. A resource owner can also grant others permission to
|
9128
9125
|
# perform the operation. For more information, see the following
|
9129
|
-
# topics in the Amazon
|
9126
|
+
# topics in the Amazon S3 User Guide:
|
9130
9127
|
#
|
9131
9128
|
# * [Specifying Permissions in a Policy][8]
|
9132
9129
|
#
|
@@ -9136,7 +9133,7 @@ module Aws::S3
|
|
9136
9133
|
#
|
9137
9134
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html
|
9138
9135
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
9139
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9136
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9140
9137
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples
|
9141
9138
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html
|
9142
9139
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
@@ -9152,7 +9149,7 @@ module Aws::S3
|
|
9152
9149
|
# @option params [Types::LifecycleConfiguration] :lifecycle_configuration
|
9153
9150
|
#
|
9154
9151
|
# @option params [String] :expected_bucket_owner
|
9155
|
-
# The account
|
9152
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9156
9153
|
# a different account, the request will fail with an HTTP `403 (Access
|
9157
9154
|
# Denied)` error.
|
9158
9155
|
#
|
@@ -9276,7 +9273,7 @@ module Aws::S3
|
|
9276
9273
|
#
|
9277
9274
|
#
|
9278
9275
|
#
|
9279
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9276
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9280
9277
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
9281
9278
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
9282
9279
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html
|
@@ -9291,7 +9288,7 @@ module Aws::S3
|
|
9291
9288
|
# Container for lifecycle rules. You can add as many as 1,000 rules.
|
9292
9289
|
#
|
9293
9290
|
# @option params [String] :expected_bucket_owner
|
9294
|
-
# The account
|
9291
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9295
9292
|
# a different account, the request will fail with an HTTP `403 (Access
|
9296
9293
|
# Denied)` error.
|
9297
9294
|
#
|
@@ -9472,7 +9469,7 @@ module Aws::S3
|
|
9472
9469
|
# SDKs, this field is calculated automatically.
|
9473
9470
|
#
|
9474
9471
|
# @option params [String] :expected_bucket_owner
|
9475
|
-
# The account
|
9472
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9476
9473
|
# a different account, the request will fail with an HTTP `403 (Access
|
9477
9474
|
# Denied)` error.
|
9478
9475
|
#
|
@@ -9575,8 +9572,8 @@ module Aws::S3
|
|
9575
9572
|
#
|
9576
9573
|
#
|
9577
9574
|
#
|
9578
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9579
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9575
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
9576
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9580
9577
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
9581
9578
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html
|
9582
9579
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
@@ -9592,7 +9589,7 @@ module Aws::S3
|
|
9592
9589
|
# Specifies the metrics configuration.
|
9593
9590
|
#
|
9594
9591
|
# @option params [String] :expected_bucket_owner
|
9595
|
-
# The account
|
9592
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9596
9593
|
# a different account, the request will fail with an HTTP `403 (Access
|
9597
9594
|
# Denied)` error.
|
9598
9595
|
#
|
@@ -9654,7 +9651,7 @@ module Aws::S3
|
|
9654
9651
|
# The container for the configuration.
|
9655
9652
|
#
|
9656
9653
|
# @option params [String] :expected_bucket_owner
|
9657
|
-
# The account
|
9654
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9658
9655
|
# a different account, the request will fail with an HTTP `403 (Access
|
9659
9656
|
# Denied)` error.
|
9660
9657
|
#
|
@@ -9774,7 +9771,7 @@ module Aws::S3
|
|
9774
9771
|
# bucket.
|
9775
9772
|
#
|
9776
9773
|
# @option params [String] :expected_bucket_owner
|
9777
|
-
# The account
|
9774
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9778
9775
|
# a different account, the request will fail with an HTTP `403 (Access
|
9779
9776
|
# Denied)` error.
|
9780
9777
|
#
|
@@ -9898,7 +9895,7 @@ module Aws::S3
|
|
9898
9895
|
# SDKs, this field is calculated automatically.
|
9899
9896
|
#
|
9900
9897
|
# @option params [String] :expected_bucket_owner
|
9901
|
-
# The account
|
9898
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9902
9899
|
# a different account, the request will fail with an HTTP `403 (Access
|
9903
9900
|
# Denied)` error.
|
9904
9901
|
#
|
@@ -9979,7 +9976,7 @@ module Aws::S3
|
|
9979
9976
|
# The bucket policy as a JSON document.
|
9980
9977
|
#
|
9981
9978
|
# @option params [String] :expected_bucket_owner
|
9982
|
-
# The account
|
9979
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9983
9980
|
# a different account, the request will fail with an HTTP `403 (Access
|
9984
9981
|
# Denied)` error.
|
9985
9982
|
#
|
@@ -10084,7 +10081,7 @@ module Aws::S3
|
|
10084
10081
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations
|
10085
10082
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html
|
10086
10083
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
10087
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10084
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
10088
10085
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html
|
10089
10086
|
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList
|
10090
10087
|
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html
|
@@ -10113,7 +10110,7 @@ module Aws::S3
|
|
10113
10110
|
# A token to allow Object Lock to be enabled for an existing bucket.
|
10114
10111
|
#
|
10115
10112
|
# @option params [String] :expected_bucket_owner
|
10116
|
-
# The account
|
10113
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10117
10114
|
# a different account, the request will fail with an HTTP `403 (Access
|
10118
10115
|
# Denied)` error.
|
10119
10116
|
#
|
@@ -10260,7 +10257,7 @@ module Aws::S3
|
|
10260
10257
|
# Container for Payer.
|
10261
10258
|
#
|
10262
10259
|
# @option params [String] :expected_bucket_owner
|
10263
|
-
# The account
|
10260
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10264
10261
|
# a different account, the request will fail with an HTTP `403 (Access
|
10265
10262
|
# Denied)` error.
|
10266
10263
|
#
|
@@ -10363,8 +10360,8 @@ module Aws::S3
|
|
10363
10360
|
#
|
10364
10361
|
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html
|
10365
10362
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html
|
10366
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10367
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10363
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
10364
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
10368
10365
|
# [5]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
|
10369
10366
|
# [6]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html
|
10370
10367
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html
|
@@ -10389,7 +10386,7 @@ module Aws::S3
|
|
10389
10386
|
# Container for the `TagSet` and `Tag` elements.
|
10390
10387
|
#
|
10391
10388
|
# @option params [String] :expected_bucket_owner
|
10392
|
-
# The account
|
10389
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10393
10390
|
# a different account, the request will fail with an HTTP `403 (Access
|
10394
10391
|
# Denied)` error.
|
10395
10392
|
#
|
@@ -10509,7 +10506,7 @@ module Aws::S3
|
|
10509
10506
|
# Container for setting the versioning state.
|
10510
10507
|
#
|
10511
10508
|
# @option params [String] :expected_bucket_owner
|
10512
|
-
# The account
|
10509
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10513
10510
|
# a different account, the request will fail with an HTTP `403 (Access
|
10514
10511
|
# Denied)` error.
|
10515
10512
|
#
|
@@ -10616,7 +10613,7 @@ module Aws::S3
|
|
10616
10613
|
# Amazon S3 has a limitation of 50 routing rules per website
|
10617
10614
|
# configuration. If you require more than 50 routing rules, you can use
|
10618
10615
|
# object redirect. For more information, see [Configuring an Object
|
10619
|
-
# Redirect][2] in the *Amazon
|
10616
|
+
# Redirect][2] in the *Amazon S3 User Guide*.
|
10620
10617
|
#
|
10621
10618
|
#
|
10622
10619
|
#
|
@@ -10642,7 +10639,7 @@ module Aws::S3
|
|
10642
10639
|
# Container for the request.
|
10643
10640
|
#
|
10644
10641
|
# @option params [String] :expected_bucket_owner
|
10645
|
-
# The account
|
10642
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10646
10643
|
# a different account, the request will fail with an HTTP `403 (Access
|
10647
10644
|
# Denied)` error.
|
10648
10645
|
#
|
@@ -10748,8 +10745,8 @@ module Aws::S3
|
|
10748
10745
|
#
|
10749
10746
|
# If you request server-side encryption using AWS Key Management Service
|
10750
10747
|
# (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For
|
10751
|
-
# more information, see [Amazon S3 Bucket Keys][3] in the *Amazon
|
10752
|
-
#
|
10748
|
+
# more information, see [Amazon S3 Bucket Keys][3] in the *Amazon S3
|
10749
|
+
# User Guide*.
|
10753
10750
|
#
|
10754
10751
|
# **Access Control List (ACL)-Specific Request Headers**
|
10755
10752
|
#
|
@@ -10836,8 +10833,8 @@ module Aws::S3
|
|
10836
10833
|
#
|
10837
10834
|
#
|
10838
10835
|
#
|
10839
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10840
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10836
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
10837
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
10841
10838
|
#
|
10842
10839
|
# @option params [String] :cache_control
|
10843
10840
|
# Can be used to specify caching behavior along the request/reply chain.
|
@@ -11052,7 +11049,7 @@ module Aws::S3
|
|
11052
11049
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
11053
11050
|
#
|
11054
11051
|
# @option params [String] :expected_bucket_owner
|
11055
|
-
# The account
|
11052
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11056
11053
|
# a different account, the request will fail with an HTTP `403 (Access
|
11057
11054
|
# Denied)` error.
|
11058
11055
|
#
|
@@ -11070,40 +11067,21 @@ module Aws::S3
|
|
11070
11067
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
11071
11068
|
#
|
11072
11069
|
#
|
11073
|
-
# @example Example: To upload an object
|
11070
|
+
# @example Example: To upload an object
|
11074
11071
|
#
|
11075
|
-
# # The following example uploads an object
|
11076
|
-
# # S3 returns
|
11072
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
11073
|
+
# # syntax. S3 returns VersionId of the newly created object.
|
11077
11074
|
#
|
11078
11075
|
# resp = client.put_object({
|
11079
|
-
# body: "
|
11076
|
+
# body: "HappyFace.jpg",
|
11080
11077
|
# bucket: "examplebucket",
|
11081
11078
|
# key: "HappyFace.jpg",
|
11082
|
-
# tagging: "key1=value1&key2=value2",
|
11083
|
-
# })
|
11084
|
-
#
|
11085
|
-
# resp.to_h outputs the following:
|
11086
|
-
# {
|
11087
|
-
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11088
|
-
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
11089
|
-
# }
|
11090
|
-
#
|
11091
|
-
# @example Example: To upload an object and specify canned ACL.
|
11092
|
-
#
|
11093
|
-
# # The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ
|
11094
|
-
# # access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
|
11095
|
-
#
|
11096
|
-
# resp = client.put_object({
|
11097
|
-
# acl: "authenticated-read",
|
11098
|
-
# body: "filetoupload",
|
11099
|
-
# bucket: "examplebucket",
|
11100
|
-
# key: "exampleobject",
|
11101
11079
|
# })
|
11102
11080
|
#
|
11103
11081
|
# resp.to_h outputs the following:
|
11104
11082
|
# {
|
11105
11083
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11106
|
-
# version_id: "
|
11084
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
11107
11085
|
# }
|
11108
11086
|
#
|
11109
11087
|
# @example Example: To create an object.
|
@@ -11122,24 +11100,24 @@ module Aws::S3
|
|
11122
11100
|
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
11123
11101
|
# }
|
11124
11102
|
#
|
11125
|
-
# @example Example: To upload an object
|
11103
|
+
# @example Example: To upload an object (specify optional headers)
|
11126
11104
|
#
|
11127
|
-
# # The following example uploads
|
11128
|
-
# #
|
11105
|
+
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
|
11106
|
+
# # storage class and use server-side encryption.
|
11129
11107
|
#
|
11130
11108
|
# resp = client.put_object({
|
11131
|
-
# body: "
|
11109
|
+
# body: "HappyFace.jpg",
|
11132
11110
|
# bucket: "examplebucket",
|
11133
|
-
# key: "
|
11111
|
+
# key: "HappyFace.jpg",
|
11134
11112
|
# server_side_encryption: "AES256",
|
11135
|
-
#
|
11113
|
+
# storage_class: "STANDARD_IA",
|
11136
11114
|
# })
|
11137
11115
|
#
|
11138
11116
|
# resp.to_h outputs the following:
|
11139
11117
|
# {
|
11140
11118
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11141
11119
|
# server_side_encryption: "AES256",
|
11142
|
-
# version_id: "
|
11120
|
+
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
11143
11121
|
# }
|
11144
11122
|
#
|
11145
11123
|
# @example Example: To upload object and specify user-defined metadata
|
@@ -11163,41 +11141,60 @@ module Aws::S3
|
|
11163
11141
|
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
11164
11142
|
# }
|
11165
11143
|
#
|
11166
|
-
# @example Example: To upload an object
|
11144
|
+
# @example Example: To upload an object and specify canned ACL.
|
11167
11145
|
#
|
11168
|
-
# # The following example uploads
|
11169
|
-
# #
|
11146
|
+
# # The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ
|
11147
|
+
# # access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
|
11170
11148
|
#
|
11171
11149
|
# resp = client.put_object({
|
11172
|
-
#
|
11150
|
+
# acl: "authenticated-read",
|
11151
|
+
# body: "filetoupload",
|
11173
11152
|
# bucket: "examplebucket",
|
11174
|
-
# key: "
|
11153
|
+
# key: "exampleobject",
|
11175
11154
|
# })
|
11176
11155
|
#
|
11177
11156
|
# resp.to_h outputs the following:
|
11178
11157
|
# {
|
11179
11158
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11180
|
-
# version_id: "
|
11159
|
+
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
11181
11160
|
# }
|
11182
11161
|
#
|
11183
|
-
# @example Example: To upload an object
|
11162
|
+
# @example Example: To upload an object and specify optional tags
|
11184
11163
|
#
|
11185
|
-
# # The following example uploads an object. The request specifies optional
|
11186
|
-
# #
|
11164
|
+
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
|
11165
|
+
# # S3 returns version ID of the newly created object.
|
11187
11166
|
#
|
11188
11167
|
# resp = client.put_object({
|
11189
|
-
# body: "HappyFace.jpg",
|
11168
|
+
# body: "c:\\HappyFace.jpg",
|
11190
11169
|
# bucket: "examplebucket",
|
11191
11170
|
# key: "HappyFace.jpg",
|
11171
|
+
# tagging: "key1=value1&key2=value2",
|
11172
|
+
# })
|
11173
|
+
#
|
11174
|
+
# resp.to_h outputs the following:
|
11175
|
+
# {
|
11176
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11177
|
+
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
11178
|
+
# }
|
11179
|
+
#
|
11180
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
11181
|
+
#
|
11182
|
+
# # The following example uploads and object. The request specifies the optional server-side encryption option. The request
|
11183
|
+
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
11184
|
+
#
|
11185
|
+
# resp = client.put_object({
|
11186
|
+
# body: "filetoupload",
|
11187
|
+
# bucket: "examplebucket",
|
11188
|
+
# key: "exampleobject",
|
11192
11189
|
# server_side_encryption: "AES256",
|
11193
|
-
#
|
11190
|
+
# tagging: "key1=value1&key2=value2",
|
11194
11191
|
# })
|
11195
11192
|
#
|
11196
11193
|
# resp.to_h outputs the following:
|
11197
11194
|
# {
|
11198
11195
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11199
11196
|
# server_side_encryption: "AES256",
|
11200
|
-
# version_id: "
|
11197
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
11201
11198
|
# }
|
11202
11199
|
#
|
11203
11200
|
# @example Streaming a file from disk
|
@@ -11270,8 +11267,8 @@ module Aws::S3
|
|
11270
11267
|
# Uses the `acl` subresource to set the access control list (ACL)
|
11271
11268
|
# permissions for a new or existing object in an S3 bucket. You must
|
11272
11269
|
# have `WRITE_ACP` permission to set the ACL of an object. For more
|
11273
|
-
# information, see [What permissions can I grant?][1] in the *Amazon
|
11274
|
-
#
|
11270
|
+
# information, see [What permissions can I grant?][1] in the *Amazon S3
|
11271
|
+
# User Guide*.
|
11275
11272
|
#
|
11276
11273
|
# This action is not supported by Amazon S3 on Outposts.
|
11277
11274
|
#
|
@@ -11445,7 +11442,7 @@ module Aws::S3
|
|
11445
11442
|
#
|
11446
11443
|
#
|
11447
11444
|
#
|
11448
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11445
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11449
11446
|
#
|
11450
11447
|
# @option params [String] :content_md5
|
11451
11448
|
# The base64-encoded 128-bit MD5 digest of the data. This header must be
|
@@ -11507,8 +11504,8 @@ module Aws::S3
|
|
11507
11504
|
#
|
11508
11505
|
#
|
11509
11506
|
#
|
11510
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11511
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11507
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11508
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
11512
11509
|
#
|
11513
11510
|
# @option params [String] :request_payer
|
11514
11511
|
# Confirms that the requester knows that they will be charged for the
|
@@ -11525,7 +11522,7 @@ module Aws::S3
|
|
11525
11522
|
# VersionId used to reference a specific version of the object.
|
11526
11523
|
#
|
11527
11524
|
# @option params [String] :expected_bucket_owner
|
11528
|
-
# The account
|
11525
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11529
11526
|
# a different account, the request will fail with an HTTP `403 (Access
|
11530
11527
|
# Denied)` error.
|
11531
11528
|
#
|
@@ -11628,7 +11625,7 @@ module Aws::S3
|
|
11628
11625
|
#
|
11629
11626
|
#
|
11630
11627
|
#
|
11631
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11628
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11632
11629
|
#
|
11633
11630
|
# @option params [required, String] :key
|
11634
11631
|
# The key name for the object that you want to place a Legal Hold on.
|
@@ -11658,7 +11655,7 @@ module Aws::S3
|
|
11658
11655
|
# SDKs, this field is calculated automatically.
|
11659
11656
|
#
|
11660
11657
|
# @option params [String] :expected_bucket_owner
|
11661
|
-
# The account
|
11658
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11662
11659
|
# a different account, the request will fail with an HTTP `403 (Access
|
11663
11660
|
# Denied)` error.
|
11664
11661
|
#
|
@@ -11741,7 +11738,7 @@ module Aws::S3
|
|
11741
11738
|
# SDKs, this field is calculated automatically.
|
11742
11739
|
#
|
11743
11740
|
# @option params [String] :expected_bucket_owner
|
11744
|
-
# The account
|
11741
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11745
11742
|
# a different account, the request will fail with an HTTP `403 (Access
|
11746
11743
|
# Denied)` error.
|
11747
11744
|
#
|
@@ -11810,7 +11807,7 @@ module Aws::S3
|
|
11810
11807
|
#
|
11811
11808
|
#
|
11812
11809
|
#
|
11813
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11810
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11814
11811
|
#
|
11815
11812
|
# @option params [required, String] :key
|
11816
11813
|
# The key name for the object that you want to apply this Object
|
@@ -11845,7 +11842,7 @@ module Aws::S3
|
|
11845
11842
|
# SDKs, this field is calculated automatically.
|
11846
11843
|
#
|
11847
11844
|
# @option params [String] :expected_bucket_owner
|
11848
|
-
# The account
|
11845
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11849
11846
|
# a different account, the request will fail with an HTTP `403 (Access
|
11850
11847
|
# Denied)` error.
|
11851
11848
|
#
|
@@ -11961,8 +11958,8 @@ module Aws::S3
|
|
11961
11958
|
#
|
11962
11959
|
#
|
11963
11960
|
#
|
11964
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11965
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11961
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11962
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
11966
11963
|
#
|
11967
11964
|
# @option params [required, String] :key
|
11968
11965
|
# Name of the object key.
|
@@ -11980,7 +11977,7 @@ module Aws::S3
|
|
11980
11977
|
# Container for the `TagSet` and `Tag` elements
|
11981
11978
|
#
|
11982
11979
|
# @option params [String] :expected_bucket_owner
|
11983
|
-
# The account
|
11980
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11984
11981
|
# a different account, the request will fail with an HTTP `403 (Access
|
11985
11982
|
# Denied)` error.
|
11986
11983
|
#
|
@@ -12115,7 +12112,7 @@ module Aws::S3
|
|
12115
12112
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status
|
12116
12113
|
#
|
12117
12114
|
# @option params [String] :expected_bucket_owner
|
12118
|
-
# The account
|
12115
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
12119
12116
|
# a different account, the request will fail with an HTTP `403 (Access
|
12120
12117
|
# Denied)` error.
|
12121
12118
|
#
|
@@ -12159,7 +12156,7 @@ module Aws::S3
|
|
12159
12156
|
# default and can grant this permission to others. For more information
|
12160
12157
|
# about permissions, see [Permissions Related to Bucket Subresource
|
12161
12158
|
# Operations][1] and [Managing Access Permissions to Your Amazon S3
|
12162
|
-
# Resources][2] in the *Amazon
|
12159
|
+
# Resources][2] in the *Amazon S3 User Guide*.
|
12163
12160
|
#
|
12164
12161
|
# **Querying Archives with Select Requests**
|
12165
12162
|
#
|
@@ -12169,7 +12166,7 @@ module Aws::S3
|
|
12169
12166
|
# files. You can run queries and custom analytics on your archived data
|
12170
12167
|
# without having to restore your data to a hotter Amazon S3 tier. For an
|
12171
12168
|
# overview about select requests, see [Querying Archived Objects][3] in
|
12172
|
-
# the *Amazon
|
12169
|
+
# the *Amazon S3 User Guide*.
|
12173
12170
|
#
|
12174
12171
|
# When making a select request, do the following:
|
12175
12172
|
#
|
@@ -12179,19 +12176,18 @@ module Aws::S3
|
|
12179
12176
|
# that initiates the job must have permissions to write to the S3
|
12180
12177
|
# bucket. You can specify the storage class and encryption for the
|
12181
12178
|
# output objects stored in the bucket. For more information about
|
12182
|
-
# output, see [Querying Archived Objects][3] in the *Amazon
|
12183
|
-
#
|
12179
|
+
# output, see [Querying Archived Objects][3] in the *Amazon S3 User
|
12180
|
+
# Guide*.
|
12184
12181
|
#
|
12185
12182
|
# For more information about the `S3` structure in the request body,
|
12186
12183
|
# see the following:
|
12187
12184
|
#
|
12188
12185
|
# * [PutObject][4]
|
12189
12186
|
#
|
12190
|
-
# * [Managing Access with ACLs][5] in the *Amazon
|
12191
|
-
# Service User Guide*
|
12187
|
+
# * [Managing Access with ACLs][5] in the *Amazon S3 User Guide*
|
12192
12188
|
#
|
12193
12189
|
# * [Protecting Data Using Server-Side Encryption][6] in the *Amazon
|
12194
|
-
#
|
12190
|
+
# S3 User Guide*
|
12195
12191
|
#
|
12196
12192
|
# * Define the SQL expression for the `SELECT` type of restoration for
|
12197
12193
|
# your query in the request body's `SelectParameters` structure. You
|
@@ -12217,7 +12213,7 @@ module Aws::S3
|
|
12217
12213
|
#
|
12218
12214
|
# For more information about using SQL with S3 Glacier Select restore,
|
12219
12215
|
# see [SQL Reference for Amazon S3 Select and S3 Glacier Select][7] in
|
12220
|
-
# the *Amazon
|
12216
|
+
# the *Amazon S3 User Guide*.
|
12221
12217
|
#
|
12222
12218
|
# When making a select request, you can also do the following:
|
12223
12219
|
#
|
@@ -12296,20 +12292,19 @@ module Aws::S3
|
|
12296
12292
|
#
|
12297
12293
|
# For more information about archive retrieval options and provisioned
|
12298
12294
|
# capacity for `Expedited` data access, see [Restoring Archived
|
12299
|
-
# Objects][8] in the *Amazon
|
12295
|
+
# Objects][8] in the *Amazon S3 User Guide*.
|
12300
12296
|
#
|
12301
12297
|
# You can use Amazon S3 restore speed upgrade to change the restore
|
12302
12298
|
# speed to a faster speed while it is in progress. For more information,
|
12303
12299
|
# see [ Upgrading the speed of an in-progress restore][9] in the *Amazon
|
12304
|
-
#
|
12300
|
+
# S3 User Guide*.
|
12305
12301
|
#
|
12306
12302
|
# To get the status of object restoration, you can send a `HEAD`
|
12307
12303
|
# request. Operations return the `x-amz-restore` header, which provides
|
12308
12304
|
# information about the restoration status, in the response. You can use
|
12309
12305
|
# Amazon S3 event notifications to notify you when a restore is
|
12310
12306
|
# initiated or completed. For more information, see [Configuring Amazon
|
12311
|
-
# S3 Event Notifications][10] in the *Amazon
|
12312
|
-
# Guide*.
|
12307
|
+
# S3 Event Notifications][10] in the *Amazon S3 User Guide*.
|
12313
12308
|
#
|
12314
12309
|
# After restoring an archived object, you can update the restoration
|
12315
12310
|
# period by reissuing the request with a new period. Amazon S3 updates
|
@@ -12325,7 +12320,7 @@ module Aws::S3
|
|
12325
12320
|
# days, Amazon S3 deletes the object in 3 days. For more information
|
12326
12321
|
# about lifecycle configuration, see
|
12327
12322
|
# [PutBucketLifecycleConfiguration][11] and [Object Lifecycle
|
12328
|
-
# Management][12] in *Amazon
|
12323
|
+
# Management][12] in *Amazon S3 User Guide*.
|
12329
12324
|
#
|
12330
12325
|
# **Responses**
|
12331
12326
|
#
|
@@ -12367,12 +12362,12 @@ module Aws::S3
|
|
12367
12362
|
# * [GetBucketNotificationConfiguration][13]
|
12368
12363
|
#
|
12369
12364
|
# * [SQL Reference for Amazon S3 Select and S3 Glacier Select ][7] in
|
12370
|
-
# the *Amazon
|
12365
|
+
# the *Amazon S3 User Guide*
|
12371
12366
|
#
|
12372
12367
|
#
|
12373
12368
|
#
|
12374
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12375
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12369
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
12370
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
12376
12371
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html
|
12377
12372
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
12378
12373
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
@@ -12407,8 +12402,8 @@ module Aws::S3
|
|
12407
12402
|
#
|
12408
12403
|
#
|
12409
12404
|
#
|
12410
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12411
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12405
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
12406
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
12412
12407
|
#
|
12413
12408
|
# @option params [required, String] :key
|
12414
12409
|
# Object key for which the action was initiated.
|
@@ -12431,7 +12426,7 @@ module Aws::S3
|
|
12431
12426
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
12432
12427
|
#
|
12433
12428
|
# @option params [String] :expected_bucket_owner
|
12434
|
-
# The account
|
12429
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
12435
12430
|
# a different account, the request will fail with an HTTP `403 (Access
|
12436
12431
|
# Denied)` error.
|
12437
12432
|
#
|
@@ -12576,11 +12571,11 @@ module Aws::S3
|
|
12576
12571
|
# This action is not supported by Amazon S3 on Outposts.
|
12577
12572
|
#
|
12578
12573
|
# For more information about Amazon S3 Select, see [Selecting Content
|
12579
|
-
# from Objects][1] in the *Amazon
|
12574
|
+
# from Objects][1] in the *Amazon S3 User Guide*.
|
12580
12575
|
#
|
12581
12576
|
# For more information about using SQL with Amazon S3 Select, see [ SQL
|
12582
12577
|
# Reference for Amazon S3 Select and S3 Glacier Select][2] in the
|
12583
|
-
# *Amazon
|
12578
|
+
# *Amazon S3 User Guide*.
|
12584
12579
|
#
|
12585
12580
|
#
|
12586
12581
|
#
|
@@ -12589,7 +12584,7 @@ module Aws::S3
|
|
12589
12584
|
# You must have `s3:GetObject` permission for this operation. Amazon S3
|
12590
12585
|
# Select does not support anonymous access. For more information about
|
12591
12586
|
# permissions, see [Specifying Permissions in a Policy][3] in the
|
12592
|
-
# *Amazon
|
12587
|
+
# *Amazon S3 User Guide*.
|
12593
12588
|
#
|
12594
12589
|
#
|
12595
12590
|
#
|
@@ -12617,8 +12612,7 @@ module Aws::S3
|
|
12617
12612
|
# keys (SSE-C), you must use HTTPS, and you must use the headers that
|
12618
12613
|
# are documented in the [GetObject][4]. For more information about
|
12619
12614
|
# SSE-C, see [Server-Side Encryption (Using Customer-Provided
|
12620
|
-
# Encryption Keys)][5] in the *Amazon
|
12621
|
-
# Guide*.
|
12615
|
+
# Encryption Keys)][5] in the *Amazon S3 User Guide*.
|
12622
12616
|
#
|
12623
12617
|
# For objects that are encrypted with Amazon S3 managed encryption
|
12624
12618
|
# keys (SSE-S3) and customer master keys (CMKs) stored in AWS Key
|
@@ -12626,7 +12620,7 @@ module Aws::S3
|
|
12626
12620
|
# transparently, so you don't need to specify anything. For more
|
12627
12621
|
# information about server-side encryption, including SSE-S3 and
|
12628
12622
|
# SSE-KMS, see [Protecting Data Using Server-Side Encryption][6] in
|
12629
|
-
# the *Amazon
|
12623
|
+
# the *Amazon S3 User Guide*.
|
12630
12624
|
#
|
12631
12625
|
# **Working with the Response Body**
|
12632
12626
|
#
|
@@ -12650,8 +12644,7 @@ module Aws::S3
|
|
12650
12644
|
# * GLACIER, DEEP\_ARCHIVE and REDUCED\_REDUNDANCY storage classes: You
|
12651
12645
|
# cannot specify the GLACIER, DEEP\_ARCHIVE, or `REDUCED_REDUNDANCY`
|
12652
12646
|
# storage classes. For more information, about storage classes see
|
12653
|
-
# [Storage Classes][9] in the *Amazon
|
12654
|
-
# Guide*.
|
12647
|
+
# [Storage Classes][9] in the *Amazon S3 User Guide*.
|
12655
12648
|
#
|
12656
12649
|
#
|
12657
12650
|
#
|
@@ -12750,7 +12743,7 @@ module Aws::S3
|
|
12750
12743
|
# within the last 50 bytes of the file.
|
12751
12744
|
#
|
12752
12745
|
# @option params [String] :expected_bucket_owner
|
12753
|
-
# The account
|
12746
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
12754
12747
|
# a different account, the request will fail with an HTTP `403 (Access
|
12755
12748
|
# Denied)` error.
|
12756
12749
|
#
|
@@ -13017,11 +13010,11 @@ module Aws::S3
|
|
13017
13010
|
# parts storage and stops charging you for the parts storage.
|
13018
13011
|
#
|
13019
13012
|
# For more information on multipart uploads, go to [Multipart Upload
|
13020
|
-
# Overview][4] in the <i>Amazon
|
13013
|
+
# Overview][4] in the <i>Amazon S3 User Guide </i>.
|
13021
13014
|
#
|
13022
13015
|
# For information on the permissions required to use the multipart
|
13023
13016
|
# upload API, go to [Multipart Upload and Permissions][5] in the *Amazon
|
13024
|
-
#
|
13017
|
+
# S3 User Guide*.
|
13025
13018
|
#
|
13026
13019
|
# You can optionally request server-side encryption where Amazon S3
|
13027
13020
|
# encrypts your data as it writes it to disks in its data centers and
|
@@ -13031,8 +13024,7 @@ module Aws::S3
|
|
13031
13024
|
# request headers you provide in the request must match the headers you
|
13032
13025
|
# used in the request to initiate the upload by using
|
13033
13026
|
# [CreateMultipartUpload][2]. For more information, go to [Using
|
13034
|
-
# Server-Side Encryption][6] in the *Amazon
|
13035
|
-
# Guide*.
|
13027
|
+
# Server-Side Encryption][6] in the *Amazon S3 User Guide*.
|
13036
13028
|
#
|
13037
13029
|
# Server-side encryption is supported by the S3 Multipart Upload
|
13038
13030
|
# actions. Unless you are using a customer-provided encryption key, you
|
@@ -13114,8 +13106,8 @@ module Aws::S3
|
|
13114
13106
|
#
|
13115
13107
|
#
|
13116
13108
|
#
|
13117
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13118
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13109
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
13110
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
13119
13111
|
#
|
13120
13112
|
# @option params [Integer] :content_length
|
13121
13113
|
# Size of the body in bytes. This parameter is useful when the size of
|
@@ -13167,7 +13159,7 @@ module Aws::S3
|
|
13167
13159
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
13168
13160
|
#
|
13169
13161
|
# @option params [String] :expected_bucket_owner
|
13170
|
-
# The account
|
13162
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
13171
13163
|
# a different account, the request will fail with an HTTP `403 (Access
|
13172
13164
|
# Denied)` error.
|
13173
13165
|
#
|
@@ -13243,7 +13235,7 @@ module Aws::S3
|
|
13243
13235
|
#
|
13244
13236
|
# The minimum allowable part size for a multipart upload is 5 MB. For
|
13245
13237
|
# more information about multipart upload limits, go to [Quick Facts][1]
|
13246
|
-
# in the *Amazon
|
13238
|
+
# in the *Amazon S3 User Guide*.
|
13247
13239
|
#
|
13248
13240
|
# <note markdown="1"> Instead of using an existing object as part data, you might use the
|
13249
13241
|
# [UploadPart][2] action and provide data in your request.
|
@@ -13259,16 +13251,15 @@ module Aws::S3
|
|
13259
13251
|
# the following:
|
13260
13252
|
#
|
13261
13253
|
# * For conceptual information about multipart uploads, see [Uploading
|
13262
|
-
# Objects Using Multipart Upload][3] in the *Amazon
|
13263
|
-
# Service User Guide*.
|
13254
|
+
# Objects Using Multipart Upload][3] in the *Amazon S3 User Guide*.
|
13264
13255
|
#
|
13265
13256
|
# * For information about permissions required to use the multipart
|
13266
13257
|
# upload API, see [Multipart Upload and Permissions][4] in the *Amazon
|
13267
|
-
#
|
13258
|
+
# S3 User Guide*.
|
13268
13259
|
#
|
13269
13260
|
# * For information about copying objects using a single atomic action
|
13270
13261
|
# vs. the multipart upload, see [Operations on Objects][5] in the
|
13271
|
-
# *Amazon
|
13262
|
+
# *Amazon S3 User Guide*.
|
13272
13263
|
#
|
13273
13264
|
# * For information about using server-side encryption with
|
13274
13265
|
# customer-provided encryption keys with the UploadPartCopy operation,
|
@@ -13389,8 +13380,8 @@ module Aws::S3
|
|
13389
13380
|
#
|
13390
13381
|
#
|
13391
13382
|
#
|
13392
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13393
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13383
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
13384
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
13394
13385
|
#
|
13395
13386
|
# @option params [required, String] :copy_source
|
13396
13387
|
# Specifies the source object for the copy operation. You specify the
|
@@ -13436,7 +13427,7 @@ module Aws::S3
|
|
13436
13427
|
#
|
13437
13428
|
#
|
13438
13429
|
#
|
13439
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13430
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
|
13440
13431
|
#
|
13441
13432
|
# @option params [String] :copy_source_if_match
|
13442
13433
|
# Copies the object if its entity tag (ETag) matches the specified tag.
|
@@ -13513,12 +13504,12 @@ module Aws::S3
|
|
13513
13504
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
13514
13505
|
#
|
13515
13506
|
# @option params [String] :expected_bucket_owner
|
13516
|
-
# The account
|
13507
|
+
# The account ID of the expected destination bucket owner. If the
|
13517
13508
|
# destination bucket is owned by a different account, the request will
|
13518
13509
|
# fail with an HTTP `403 (Access Denied)` error.
|
13519
13510
|
#
|
13520
13511
|
# @option params [String] :expected_source_bucket_owner
|
13521
|
-
# The account
|
13512
|
+
# The account ID of the expected source bucket owner. If the source
|
13522
13513
|
# bucket is owned by a different account, the request will fail with an
|
13523
13514
|
# HTTP `403 (Access Denied)` error.
|
13524
13515
|
#
|
@@ -13534,45 +13525,45 @@ module Aws::S3
|
|
13534
13525
|
# * {Types::UploadPartCopyOutput#request_charged #request_charged} => String
|
13535
13526
|
#
|
13536
13527
|
#
|
13537
|
-
# @example Example: To upload a part by copying
|
13528
|
+
# @example Example: To upload a part by copying data from an existing object as data source
|
13538
13529
|
#
|
13539
|
-
# # The following example uploads a part of a multipart upload by copying
|
13540
|
-
# # data source.
|
13530
|
+
# # The following example uploads a part of a multipart upload by copying data from an existing object as data source.
|
13541
13531
|
#
|
13542
13532
|
# resp = client.upload_part_copy({
|
13543
13533
|
# bucket: "examplebucket",
|
13544
13534
|
# copy_source: "/bucketname/sourceobjectkey",
|
13545
|
-
# copy_source_range: "bytes=1-100000",
|
13546
13535
|
# key: "examplelargeobject",
|
13547
|
-
# part_number:
|
13536
|
+
# part_number: 1,
|
13548
13537
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
13549
13538
|
# })
|
13550
13539
|
#
|
13551
13540
|
# resp.to_h outputs the following:
|
13552
13541
|
# {
|
13553
13542
|
# copy_part_result: {
|
13554
|
-
# etag: "\"
|
13555
|
-
# last_modified: Time.parse("2016-12-29T21:
|
13543
|
+
# etag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
|
13544
|
+
# last_modified: Time.parse("2016-12-29T21:24:43.000Z"),
|
13556
13545
|
# },
|
13557
13546
|
# }
|
13558
13547
|
#
|
13559
|
-
# @example Example: To upload a part by copying
|
13548
|
+
# @example Example: To upload a part by copying byte range from an existing object as data source
|
13560
13549
|
#
|
13561
|
-
# # The following example uploads a part of a multipart upload by copying
|
13550
|
+
# # The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as
|
13551
|
+
# # data source.
|
13562
13552
|
#
|
13563
13553
|
# resp = client.upload_part_copy({
|
13564
13554
|
# bucket: "examplebucket",
|
13565
13555
|
# copy_source: "/bucketname/sourceobjectkey",
|
13556
|
+
# copy_source_range: "bytes=1-100000",
|
13566
13557
|
# key: "examplelargeobject",
|
13567
|
-
# part_number:
|
13558
|
+
# part_number: 2,
|
13568
13559
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
13569
13560
|
# })
|
13570
13561
|
#
|
13571
13562
|
# resp.to_h outputs the following:
|
13572
13563
|
# {
|
13573
13564
|
# copy_part_result: {
|
13574
|
-
# etag: "\"
|
13575
|
-
# last_modified: Time.parse("2016-12-29T21:
|
13565
|
+
# etag: "\"65d16d19e65a7508a51f043180edcc36\"",
|
13566
|
+
# last_modified: Time.parse("2016-12-29T21:44:28.000Z"),
|
13576
13567
|
# },
|
13577
13568
|
# }
|
13578
13569
|
#
|
@@ -13621,6 +13612,265 @@ module Aws::S3
|
|
13621
13612
|
req.send_request(options)
|
13622
13613
|
end
|
13623
13614
|
|
13615
|
+
# Passes transformed objects to a `GetObject` operation when using
|
13616
|
+
# Object Lambda Access Points. For information about Object Lambda
|
13617
|
+
# Access Points, see [Transforming objects with Object Lambda Access
|
13618
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
13619
|
+
#
|
13620
|
+
# This operation supports metadata that can be returned by
|
13621
|
+
# [GetObject][2], in addition to `RequestRoute`, `RequestToken`,
|
13622
|
+
# `StatusCode`, `ErrorCode`, and `ErrorMessage`. The `GetObject`
|
13623
|
+
# response metadata is supported so that the `WriteGetObjectResponse`
|
13624
|
+
# caller, typically an AWS Lambda function, can provide the same
|
13625
|
+
# metadata when it internally invokes `GetObject`. When
|
13626
|
+
# `WriteGetObjectResponse` is called by a customer-owned Lambda
|
13627
|
+
# function, the metadata returned to the end user `GetObject` call might
|
13628
|
+
# differ from what Amazon S3 would normally return.
|
13629
|
+
#
|
13630
|
+
#
|
13631
|
+
#
|
13632
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html
|
13633
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
13634
|
+
#
|
13635
|
+
# @option params [required, String] :request_route
|
13636
|
+
# Route prefix to the HTTP URL generated.
|
13637
|
+
#
|
13638
|
+
# @option params [required, String] :request_token
|
13639
|
+
# A single use encrypted token that maps `WriteGetObjectResponse` to the
|
13640
|
+
# end user `GetObject` request.
|
13641
|
+
#
|
13642
|
+
# @option params [String, IO] :body
|
13643
|
+
# The object data.
|
13644
|
+
#
|
13645
|
+
# @option params [Integer] :status_code
|
13646
|
+
# The integer status code for an HTTP response of a corresponding
|
13647
|
+
# `GetObject` request.
|
13648
|
+
#
|
13649
|
+
# **Status Codes**
|
13650
|
+
#
|
13651
|
+
# * *200 - OK*
|
13652
|
+
#
|
13653
|
+
# * *206 - Partial Content*
|
13654
|
+
#
|
13655
|
+
# * *304 - Not Modified*
|
13656
|
+
#
|
13657
|
+
# * *400 - Bad Request*
|
13658
|
+
#
|
13659
|
+
# * *401 - Unauthorized*
|
13660
|
+
#
|
13661
|
+
# * *403 - Forbidden*
|
13662
|
+
#
|
13663
|
+
# * *404 - Not Found*
|
13664
|
+
#
|
13665
|
+
# * *405 - Method Not Allowed*
|
13666
|
+
#
|
13667
|
+
# * *409 - Conflict*
|
13668
|
+
#
|
13669
|
+
# * *411 - Length Required*
|
13670
|
+
#
|
13671
|
+
# * *412 - Precondition Failed*
|
13672
|
+
#
|
13673
|
+
# * *416 - Range Not Satisfiable*
|
13674
|
+
#
|
13675
|
+
# * *500 - Internal Server Error*
|
13676
|
+
#
|
13677
|
+
# * *503 - Service Unavailable*
|
13678
|
+
#
|
13679
|
+
# @option params [String] :error_code
|
13680
|
+
# A string that uniquely identifies an error condition. Returned in the
|
13681
|
+
# <Code> tag of the error XML response for a corresponding
|
13682
|
+
# `GetObject` call. Cannot be used with a successful `StatusCode` header
|
13683
|
+
# or when the transformed object is provided in the body.
|
13684
|
+
#
|
13685
|
+
# @option params [String] :error_message
|
13686
|
+
# Contains a generic description of the error condition. Returned in the
|
13687
|
+
# <Message> tag of the error XML response for a corresponding
|
13688
|
+
# `GetObject` call. Cannot be used with a successful `StatusCode` header
|
13689
|
+
# or when the transformed object is provided in body.
|
13690
|
+
#
|
13691
|
+
# @option params [String] :accept_ranges
|
13692
|
+
# Indicates that a range of bytes was specified.
|
13693
|
+
#
|
13694
|
+
# @option params [String] :cache_control
|
13695
|
+
# Specifies caching behavior along the request/reply chain.
|
13696
|
+
#
|
13697
|
+
# @option params [String] :content_disposition
|
13698
|
+
# Specifies presentational information for the object.
|
13699
|
+
#
|
13700
|
+
# @option params [String] :content_encoding
|
13701
|
+
# Specifies what content encodings have been applied to the object and
|
13702
|
+
# thus what decoding mechanisms must be applied to obtain the media-type
|
13703
|
+
# referenced by the Content-Type header field.
|
13704
|
+
#
|
13705
|
+
# @option params [String] :content_language
|
13706
|
+
# The language the content is in.
|
13707
|
+
#
|
13708
|
+
# @option params [Integer] :content_length
|
13709
|
+
# The size of the content body in bytes.
|
13710
|
+
#
|
13711
|
+
# @option params [String] :content_range
|
13712
|
+
# The portion of the object returned in the response.
|
13713
|
+
#
|
13714
|
+
# @option params [String] :content_type
|
13715
|
+
# A standard MIME type describing the format of the object data.
|
13716
|
+
#
|
13717
|
+
# @option params [Boolean] :delete_marker
|
13718
|
+
# Specifies whether an object stored in Amazon S3 is (`true`) or is not
|
13719
|
+
# (`false`) a delete marker.
|
13720
|
+
#
|
13721
|
+
# @option params [String] :etag
|
13722
|
+
# An opaque identifier assigned by a web server to a specific version of
|
13723
|
+
# a resource found at a URL.
|
13724
|
+
#
|
13725
|
+
# @option params [Time,DateTime,Date,Integer,String] :expires
|
13726
|
+
# The date and time at which the object is no longer cacheable.
|
13727
|
+
#
|
13728
|
+
# @option params [String] :expiration
|
13729
|
+
# If object stored in Amazon S3 expiration is configured (see PUT Bucket
|
13730
|
+
# lifecycle) it includes expiry-date and rule-id key-value pairs
|
13731
|
+
# providing object expiration information. The value of the rule-id is
|
13732
|
+
# URL encoded.
|
13733
|
+
#
|
13734
|
+
# @option params [Time,DateTime,Date,Integer,String] :last_modified
|
13735
|
+
# The date and time that the object was last modified.
|
13736
|
+
#
|
13737
|
+
# @option params [Integer] :missing_meta
|
13738
|
+
# Set to the number of metadata entries not returned in `x-amz-meta`
|
13739
|
+
# headers. This can happen if you create metadata using an API like SOAP
|
13740
|
+
# that supports more flexible metadata than the REST API. For example,
|
13741
|
+
# using SOAP, you can create metadata whose values are not legal HTTP
|
13742
|
+
# headers.
|
13743
|
+
#
|
13744
|
+
# @option params [Hash<String,String>] :metadata
|
13745
|
+
# A map of metadata to store with the object in S3.
|
13746
|
+
#
|
13747
|
+
# @option params [String] :object_lock_mode
|
13748
|
+
# Indicates whether an object stored in Amazon S3 has Object Lock
|
13749
|
+
# enabled. For more information about S3 Object Lock, see [Object
|
13750
|
+
# Lock][1].
|
13751
|
+
#
|
13752
|
+
#
|
13753
|
+
#
|
13754
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
|
13755
|
+
#
|
13756
|
+
# @option params [String] :object_lock_legal_hold_status
|
13757
|
+
# Indicates whether an object stored in Amazon S3 has an active legal
|
13758
|
+
# hold.
|
13759
|
+
#
|
13760
|
+
# @option params [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
|
13761
|
+
# The date and time when Object Lock is configured to expire.
|
13762
|
+
#
|
13763
|
+
# @option params [Integer] :parts_count
|
13764
|
+
# The count of parts this object has.
|
13765
|
+
#
|
13766
|
+
# @option params [String] :replication_status
|
13767
|
+
# Indicates if request involves bucket that is either a source or
|
13768
|
+
# destination in a Replication rule. For more information about S3
|
13769
|
+
# Replication, see [Replication][1].
|
13770
|
+
#
|
13771
|
+
#
|
13772
|
+
#
|
13773
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html
|
13774
|
+
#
|
13775
|
+
# @option params [String] :request_charged
|
13776
|
+
# If present, indicates that the requester was successfully charged for
|
13777
|
+
# the request.
|
13778
|
+
#
|
13779
|
+
# @option params [String] :restore
|
13780
|
+
# Provides information about object restoration operation and expiration
|
13781
|
+
# time of the restored object copy.
|
13782
|
+
#
|
13783
|
+
# @option params [String] :server_side_encryption
|
13784
|
+
# The server-side encryption algorithm used when storing requested
|
13785
|
+
# object in Amazon S3 (for example, AES256, aws:kms).
|
13786
|
+
#
|
13787
|
+
# @option params [String] :sse_customer_algorithm
|
13788
|
+
# Encryption algorithm used if server-side encryption with a
|
13789
|
+
# customer-provided encryption key was specified for object stored in
|
13790
|
+
# Amazon S3.
|
13791
|
+
#
|
13792
|
+
# @option params [String] :ssekms_key_id
|
13793
|
+
# If present, specifies the ID of the AWS Key Management Service (AWS
|
13794
|
+
# KMS) symmetric customer managed customer master key (CMK) that was
|
13795
|
+
# used for stored in Amazon S3 object.
|
13796
|
+
#
|
13797
|
+
# @option params [String] :sse_customer_key_md5
|
13798
|
+
# 128-bit MD5 digest of customer-provided encryption key used in Amazon
|
13799
|
+
# S3 to encrypt data stored in S3. For more information, see [Protecting
|
13800
|
+
# data using server-side encryption with customer-provided encryption
|
13801
|
+
# keys (SSE-C)][1].
|
13802
|
+
#
|
13803
|
+
#
|
13804
|
+
#
|
13805
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html
|
13806
|
+
#
|
13807
|
+
# @option params [String] :storage_class
|
13808
|
+
# The class of storage used to store object in Amazon S3.
|
13809
|
+
#
|
13810
|
+
# @option params [Integer] :tag_count
|
13811
|
+
# The number of tags, if any, on the object.
|
13812
|
+
#
|
13813
|
+
# @option params [String] :version_id
|
13814
|
+
# An ID used to reference a specific version of the object.
|
13815
|
+
#
|
13816
|
+
# @option params [Boolean] :bucket_key_enabled
|
13817
|
+
# Indicates whether the object stored in Amazon S3 uses an S3 bucket key
|
13818
|
+
# for server-side encryption with AWS KMS (SSE-KMS).
|
13819
|
+
#
|
13820
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
13821
|
+
#
|
13822
|
+
# @example Request syntax with placeholder values
|
13823
|
+
#
|
13824
|
+
# resp = client.write_get_object_response({
|
13825
|
+
# request_route: "RequestRoute", # required
|
13826
|
+
# request_token: "RequestToken", # required
|
13827
|
+
# body: source_file,
|
13828
|
+
# status_code: 1,
|
13829
|
+
# error_code: "ErrorCode",
|
13830
|
+
# error_message: "ErrorMessage",
|
13831
|
+
# accept_ranges: "AcceptRanges",
|
13832
|
+
# cache_control: "CacheControl",
|
13833
|
+
# content_disposition: "ContentDisposition",
|
13834
|
+
# content_encoding: "ContentEncoding",
|
13835
|
+
# content_language: "ContentLanguage",
|
13836
|
+
# content_length: 1,
|
13837
|
+
# content_range: "ContentRange",
|
13838
|
+
# content_type: "ContentType",
|
13839
|
+
# delete_marker: false,
|
13840
|
+
# etag: "ETag",
|
13841
|
+
# expires: Time.now,
|
13842
|
+
# expiration: "Expiration",
|
13843
|
+
# last_modified: Time.now,
|
13844
|
+
# missing_meta: 1,
|
13845
|
+
# metadata: {
|
13846
|
+
# "MetadataKey" => "MetadataValue",
|
13847
|
+
# },
|
13848
|
+
# object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
|
13849
|
+
# object_lock_legal_hold_status: "ON", # accepts ON, OFF
|
13850
|
+
# object_lock_retain_until_date: Time.now,
|
13851
|
+
# parts_count: 1,
|
13852
|
+
# replication_status: "COMPLETE", # accepts COMPLETE, PENDING, FAILED, REPLICA
|
13853
|
+
# request_charged: "requester", # accepts requester
|
13854
|
+
# restore: "Restore",
|
13855
|
+
# server_side_encryption: "AES256", # accepts AES256, aws:kms
|
13856
|
+
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
13857
|
+
# ssekms_key_id: "SSEKMSKeyId",
|
13858
|
+
# sse_customer_key_md5: "SSECustomerKeyMD5",
|
13859
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
|
13860
|
+
# tag_count: 1,
|
13861
|
+
# version_id: "ObjectVersionId",
|
13862
|
+
# bucket_key_enabled: false,
|
13863
|
+
# })
|
13864
|
+
#
|
13865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/WriteGetObjectResponse AWS API Documentation
|
13866
|
+
#
|
13867
|
+
# @overload write_get_object_response(params = {})
|
13868
|
+
# @param [Hash] params ({})
|
13869
|
+
def write_get_object_response(params = {}, options = {})
|
13870
|
+
req = build_request(:write_get_object_response, params)
|
13871
|
+
req.send_request(options)
|
13872
|
+
end
|
13873
|
+
|
13624
13874
|
# @!endgroup
|
13625
13875
|
|
13626
13876
|
# @param params ({})
|
@@ -13634,7 +13884,7 @@ module Aws::S3
|
|
13634
13884
|
params: params,
|
13635
13885
|
config: config)
|
13636
13886
|
context[:gem_name] = 'aws-sdk-s3'
|
13637
|
-
context[:gem_version] = '1.
|
13887
|
+
context[:gem_version] = '1.92.0'
|
13638
13888
|
Seahorse::Client::Request.new(handlers, context)
|
13639
13889
|
end
|
13640
13890
|
|