aws-sdk-s3 1.81.1 → 1.82.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-s3.rb +1 -1
- data/lib/aws-sdk-s3/arn/access_point_arn.rb +62 -0
- data/lib/aws-sdk-s3/arn/outpost_access_point_arn.rb +71 -0
- data/lib/aws-sdk-s3/bucket.rb +1 -1
- data/lib/aws-sdk-s3/client.rb +552 -226
- data/lib/aws-sdk-s3/customizations/bucket.rb +7 -4
- data/lib/aws-sdk-s3/multipart_upload_part.rb +12 -3
- data/lib/aws-sdk-s3/object.rb +13 -4
- data/lib/aws-sdk-s3/object_summary.rb +13 -4
- data/lib/aws-sdk-s3/plugins/arn.rb +187 -0
- data/lib/aws-sdk-s3/plugins/bucket_dns.rb +0 -2
- data/lib/aws-sdk-s3/plugins/bucket_name_restrictions.rb +1 -1
- data/lib/aws-sdk-s3/plugins/s3_signer.rb +29 -7
- data/lib/aws-sdk-s3/types.rb +406 -39
- metadata +7 -5
- data/lib/aws-sdk-s3/plugins/bucket_arn.rb +0 -212
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e842f232d7e50f3e6f5a12aeecd8c1efc1cee2171e92944b773f8b66de1379f5
|
4
|
+
data.tar.gz: f30436b18bccb7cb2d20f8c024c55ea6192638d34089fd43bfef7092e1b1096e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5a0e7f3d81929759b8b9e17c83f9212c40145da665b9b146061a2e6ff6b8ac6b97028d10529fedfbc561be344561098d61c8c0428b60df525dd8265f28879728
|
7
|
+
data.tar.gz: 39403a36b6fadea6ae1c9a4b029650761dc3fbee30db41fd450694dfc1f5a2297fb8012f85f82e418fff52c63e4b36ba6ecc7facb0e5629cd09725b737c659cc
|
data/lib/aws-sdk-s3.rb
CHANGED
@@ -0,0 +1,62 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Aws
|
4
|
+
module S3
|
5
|
+
# @api private
|
6
|
+
class AccessPointARN < 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
|
+
true
|
16
|
+
end
|
17
|
+
|
18
|
+
def support_fips?
|
19
|
+
true
|
20
|
+
end
|
21
|
+
|
22
|
+
def validate_arn!
|
23
|
+
unless @service == 's3'
|
24
|
+
raise ArgumentError, 'Must provide a valid S3 accesspoint ARN.'
|
25
|
+
end
|
26
|
+
|
27
|
+
if @region.empty? || @account_id.empty?
|
28
|
+
raise ArgumentError,
|
29
|
+
'S3 accesspoint 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)
|
56
|
+
sfx = Aws::Partitions::EndpointProvider.dns_suffix_for(region)
|
57
|
+
"#{@access_point_name}-#{@account_id}"\
|
58
|
+
".s3-accesspoint#{'.dualstack' if dualstack}.#{region}.#{sfx}"
|
59
|
+
end
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
@@ -0,0 +1,71 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Aws
|
4
|
+
module S3
|
5
|
+
# @api private
|
6
|
+
class OutpostAccessPointARN < Aws::ARN
|
7
|
+
def initialize(options)
|
8
|
+
super(options)
|
9
|
+
@type, @outpost_id, @subtype, @access_point_name, @extra =
|
10
|
+
@resource.split(/[:,\/]/)
|
11
|
+
end
|
12
|
+
|
13
|
+
attr_reader :outpost_id, :access_point_name
|
14
|
+
|
15
|
+
def support_dualstack?
|
16
|
+
false
|
17
|
+
end
|
18
|
+
|
19
|
+
def support_fips?
|
20
|
+
false
|
21
|
+
end
|
22
|
+
|
23
|
+
def validate_arn!
|
24
|
+
unless @service == 's3-outposts'
|
25
|
+
raise ArgumentError, 'Must provide a valid S3 outposts ARN.'
|
26
|
+
end
|
27
|
+
|
28
|
+
if @region.empty? || @account_id.empty?
|
29
|
+
raise ArgumentError,
|
30
|
+
'S3 accesspoint ARNs must contain both a region '\
|
31
|
+
'and an account id.'
|
32
|
+
end
|
33
|
+
|
34
|
+
if @type != 'outpost' && @subtype != 'accesspoint'
|
35
|
+
raise ArgumentError, 'Invalid ARN, resource format is not correct'
|
36
|
+
end
|
37
|
+
|
38
|
+
if @outpost_id.nil? || @outpost_id.empty?
|
39
|
+
raise ArgumentError, 'Missing ARN outpost id.'
|
40
|
+
end
|
41
|
+
|
42
|
+
if @access_point_name.nil? || @access_point_name.empty?
|
43
|
+
raise ArgumentError, 'Missing ARN accesspoint name.'
|
44
|
+
end
|
45
|
+
|
46
|
+
if @extra
|
47
|
+
raise ArgumentError,
|
48
|
+
'ARN accesspoint resource must be a single value.'
|
49
|
+
end
|
50
|
+
|
51
|
+
unless Seahorse::Util.host_label?(
|
52
|
+
"#{@access_point_name}-#{@account_id}"
|
53
|
+
)
|
54
|
+
raise ArgumentError,
|
55
|
+
"#{@access_point_name}-#{@account_id} is not a valid "\
|
56
|
+
'host label.'
|
57
|
+
end
|
58
|
+
|
59
|
+
unless Seahorse::Util.host_label?(@outpost_id)
|
60
|
+
raise ArgumentError, "#{@outpost_id} is not a valid host label."
|
61
|
+
end
|
62
|
+
end
|
63
|
+
|
64
|
+
# Outpost ARNs currently do not support dualstack
|
65
|
+
def host_url(region, _dualstack = false)
|
66
|
+
"#{@access_point_name}-#{@account_id}.#{@outpost_id}"\
|
67
|
+
".s3-outposts.#{region}.amazonaws.com"
|
68
|
+
end
|
69
|
+
end
|
70
|
+
end
|
71
|
+
end
|
data/lib/aws-sdk-s3/bucket.rb
CHANGED
@@ -347,7 +347,7 @@ module Aws::S3
|
|
347
347
|
# "MetadataKey" => "MetadataValue",
|
348
348
|
# },
|
349
349
|
# server_side_encryption: "AES256", # accepts AES256, aws:kms
|
350
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
|
350
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
|
351
351
|
# website_redirect_location: "WebsiteRedirectLocation",
|
352
352
|
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
353
353
|
# sse_customer_key: "SSECustomerKey",
|
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -28,23 +28,23 @@ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
30
|
require 'aws-sdk-core/plugins/protocols/rest_xml.rb'
|
31
|
-
require 'aws-sdk-s3/plugins/iad_regional_endpoint.rb'
|
32
31
|
require 'aws-sdk-s3/plugins/accelerate.rb'
|
33
|
-
require 'aws-sdk-s3/plugins/
|
34
|
-
require 'aws-sdk-s3/plugins/bucket_arn.rb'
|
32
|
+
require 'aws-sdk-s3/plugins/arn.rb'
|
35
33
|
require 'aws-sdk-s3/plugins/bucket_dns.rb'
|
34
|
+
require 'aws-sdk-s3/plugins/bucket_name_restrictions.rb'
|
35
|
+
require 'aws-sdk-s3/plugins/dualstack.rb'
|
36
36
|
require 'aws-sdk-s3/plugins/expect_100_continue.rb'
|
37
|
-
require 'aws-sdk-s3/plugins/http_200_errors.rb'
|
38
|
-
require 'aws-sdk-s3/plugins/s3_host_id.rb'
|
39
37
|
require 'aws-sdk-s3/plugins/get_bucket_location_fix.rb'
|
38
|
+
require 'aws-sdk-s3/plugins/http_200_errors.rb'
|
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
42
|
require 'aws-sdk-s3/plugins/redirects.rb'
|
43
|
-
require 'aws-sdk-s3/plugins/
|
44
|
-
require 'aws-sdk-s3/plugins/url_encoded_keys.rb'
|
43
|
+
require 'aws-sdk-s3/plugins/s3_host_id.rb'
|
45
44
|
require 'aws-sdk-s3/plugins/s3_signer.rb'
|
46
|
-
require 'aws-sdk-s3/plugins/
|
45
|
+
require 'aws-sdk-s3/plugins/sse_cpk.rb'
|
47
46
|
require 'aws-sdk-s3/plugins/streaming_retry.rb'
|
47
|
+
require 'aws-sdk-s3/plugins/url_encoded_keys.rb'
|
48
48
|
require 'aws-sdk-core/plugins/event_stream_configuration.rb'
|
49
49
|
|
50
50
|
Aws::Plugins::GlobalConfiguration.add_identifier(:s3)
|
@@ -91,23 +91,23 @@ module Aws::S3
|
|
91
91
|
add_plugin(Aws::Plugins::TransferEncoding)
|
92
92
|
add_plugin(Aws::Plugins::HttpChecksum)
|
93
93
|
add_plugin(Aws::Plugins::Protocols::RestXml)
|
94
|
-
add_plugin(Aws::S3::Plugins::IADRegionalEndpoint)
|
95
94
|
add_plugin(Aws::S3::Plugins::Accelerate)
|
96
|
-
add_plugin(Aws::S3::Plugins::
|
97
|
-
add_plugin(Aws::S3::Plugins::BucketARN)
|
95
|
+
add_plugin(Aws::S3::Plugins::ARN)
|
98
96
|
add_plugin(Aws::S3::Plugins::BucketDns)
|
97
|
+
add_plugin(Aws::S3::Plugins::BucketNameRestrictions)
|
98
|
+
add_plugin(Aws::S3::Plugins::Dualstack)
|
99
99
|
add_plugin(Aws::S3::Plugins::Expect100Continue)
|
100
|
-
add_plugin(Aws::S3::Plugins::Http200Errors)
|
101
|
-
add_plugin(Aws::S3::Plugins::S3HostId)
|
102
100
|
add_plugin(Aws::S3::Plugins::GetBucketLocationFix)
|
101
|
+
add_plugin(Aws::S3::Plugins::Http200Errors)
|
102
|
+
add_plugin(Aws::S3::Plugins::IADRegionalEndpoint)
|
103
103
|
add_plugin(Aws::S3::Plugins::LocationConstraint)
|
104
104
|
add_plugin(Aws::S3::Plugins::Md5s)
|
105
105
|
add_plugin(Aws::S3::Plugins::Redirects)
|
106
|
-
add_plugin(Aws::S3::Plugins::
|
107
|
-
add_plugin(Aws::S3::Plugins::UrlEncodedKeys)
|
106
|
+
add_plugin(Aws::S3::Plugins::S3HostId)
|
108
107
|
add_plugin(Aws::S3::Plugins::S3Signer)
|
109
|
-
add_plugin(Aws::S3::Plugins::
|
108
|
+
add_plugin(Aws::S3::Plugins::SseCpk)
|
110
109
|
add_plugin(Aws::S3::Plugins::StreamingRetry)
|
110
|
+
add_plugin(Aws::S3::Plugins::UrlEncodedKeys)
|
111
111
|
add_plugin(Aws::Plugins::EventStreamConfiguration)
|
112
112
|
|
113
113
|
# @overload initialize(options)
|
@@ -330,9 +330,9 @@ module Aws::S3
|
|
330
330
|
# region. Defaults to `legacy` mode using global endpoint.
|
331
331
|
#
|
332
332
|
# @option options [Boolean] :s3_use_arn_region (true)
|
333
|
-
#
|
334
|
-
#
|
335
|
-
# the
|
333
|
+
# For S3 ARNs passed into the `:bucket` parameter, this option will
|
334
|
+
# use the region in the ARN, allowing for cross-region requests to
|
335
|
+
# be made. Set to `false` to use the client's region instead.
|
336
336
|
#
|
337
337
|
# @option options [String] :secret_access_key
|
338
338
|
#
|
@@ -455,9 +455,19 @@ module Aws::S3
|
|
455
455
|
# information about access point ARNs, see [Using Access Points][1] in
|
456
456
|
# the *Amazon Simple Storage Service Developer Guide*.
|
457
457
|
#
|
458
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
459
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
460
|
+
# takes the form
|
461
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
462
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
463
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
464
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
465
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
466
|
+
#
|
458
467
|
#
|
459
468
|
#
|
460
469
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
470
|
+
# [2]: https://docs.aws.amazon.com/
|
461
471
|
#
|
462
472
|
# @option params [required, String] :key
|
463
473
|
# Key of the object for which the multipart upload was initiated.
|
@@ -906,6 +916,28 @@ module Aws::S3
|
|
906
916
|
# @option params [required, String] :bucket
|
907
917
|
# The name of the destination bucket.
|
908
918
|
#
|
919
|
+
# When using this API with an access point, you must direct requests to
|
920
|
+
# the access point hostname. The access point hostname takes the form
|
921
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
922
|
+
# When using this operation using an access point through the AWS SDKs,
|
923
|
+
# you provide the access point ARN in place of the bucket name. For more
|
924
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
925
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
926
|
+
#
|
927
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
928
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
929
|
+
# takes the form
|
930
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
931
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
932
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
933
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
934
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
935
|
+
#
|
936
|
+
#
|
937
|
+
#
|
938
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
939
|
+
# [2]: https://docs.aws.amazon.com/
|
940
|
+
#
|
909
941
|
# @option params [String] :cache_control
|
910
942
|
# Specifies caching behavior along the request/reply chain.
|
911
943
|
#
|
@@ -950,6 +982,15 @@ module Aws::S3
|
|
950
982
|
#
|
951
983
|
# </note>
|
952
984
|
#
|
985
|
+
# Alternatively, for objects accessed through Amazon S3 on Outposts,
|
986
|
+
# specify the ARN of the object as accessed in the format
|
987
|
+
# `arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>`.
|
988
|
+
# For example, to copy the object `reports/january.pdf` through
|
989
|
+
# outpost `my-outpost` owned by account `123456789012` in Region
|
990
|
+
# `us-west-2`, use the URL encoding of
|
991
|
+
# `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf`.
|
992
|
+
# The value must be URL encoded.
|
993
|
+
#
|
953
994
|
# To copy a specific version of an object, append
|
954
995
|
# `?versionId=<version-id>` to the value (for example,
|
955
996
|
# `awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893`).
|
@@ -1158,7 +1199,7 @@ module Aws::S3
|
|
1158
1199
|
# metadata_directive: "COPY", # accepts COPY, REPLACE
|
1159
1200
|
# tagging_directive: "COPY", # accepts COPY, REPLACE
|
1160
1201
|
# server_side_encryption: "AES256", # accepts AES256, aws:kms
|
1161
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
|
1202
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
|
1162
1203
|
# website_redirect_location: "WebsiteRedirectLocation",
|
1163
1204
|
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
1164
1205
|
# sse_customer_key: "SSECustomerKey",
|
@@ -1200,21 +1241,24 @@ module Aws::S3
|
|
1200
1241
|
req.send_request(options)
|
1201
1242
|
end
|
1202
1243
|
|
1203
|
-
# Creates a new bucket. To create a bucket, you must register with
|
1244
|
+
# Creates a new S3 bucket. To create a bucket, you must register with
|
1204
1245
|
# Amazon S3 and have a valid AWS Access Key ID to authenticate requests.
|
1205
1246
|
# Anonymous requests are never allowed to create buckets. By creating
|
1206
1247
|
# the bucket, you become the bucket owner.
|
1207
1248
|
#
|
1208
|
-
# Not every string is an acceptable bucket name. For information
|
1249
|
+
# Not every string is an acceptable bucket name. For information about
|
1209
1250
|
# bucket naming restrictions, see [Working with Amazon S3 Buckets][1].
|
1210
1251
|
#
|
1252
|
+
# If you want to create an **Amazon S3 on Outposts** bucket, see [Create
|
1253
|
+
# Bucket][2].
|
1254
|
+
#
|
1211
1255
|
# By default, the bucket is created in the US East (N. Virginia) Region.
|
1212
1256
|
# You can optionally specify a Region in the request body. You might
|
1213
1257
|
# choose a Region to optimize latency, minimize costs, or address
|
1214
1258
|
# regulatory requirements. For example, if you reside in Europe, you
|
1215
1259
|
# will probably find it advantageous to create buckets in the Europe
|
1216
1260
|
# (Ireland) Region. For more information, see [How to Select a Region
|
1217
|
-
# for Your Buckets][
|
1261
|
+
# for Your Buckets][3].
|
1218
1262
|
#
|
1219
1263
|
# <note markdown="1"> If you send your create bucket request to the `s3.amazonaws.com`
|
1220
1264
|
# endpoint, the request goes to the us-east-1 Region. Accordingly, the
|
@@ -1223,7 +1267,7 @@ module Aws::S3
|
|
1223
1267
|
# another Region where the bucket is to be created. If you create a
|
1224
1268
|
# bucket in a Region other than US East (N. Virginia), your application
|
1225
1269
|
# must be able to handle 307 redirect. For more information, see
|
1226
|
-
# [Virtual Hosting of Buckets][
|
1270
|
+
# [Virtual Hosting of Buckets][4].
|
1227
1271
|
#
|
1228
1272
|
# </note>
|
1229
1273
|
#
|
@@ -1235,14 +1279,14 @@ module Aws::S3
|
|
1235
1279
|
# * Specify a canned ACL using the `x-amz-acl` request header. Amazon S3
|
1236
1280
|
# supports a set of predefined ACLs, known as *canned ACLs*. Each
|
1237
1281
|
# canned ACL has a predefined set of grantees and permissions. For
|
1238
|
-
# more information, see [Canned ACL][
|
1282
|
+
# more information, see [Canned ACL][5].
|
1239
1283
|
#
|
1240
1284
|
# * Specify access permissions explicitly using the `x-amz-grant-read`,
|
1241
1285
|
# `x-amz-grant-write`, `x-amz-grant-read-acp`,
|
1242
1286
|
# `x-amz-grant-write-acp`, and `x-amz-grant-full-control` headers.
|
1243
1287
|
# These headers map to the set of permissions Amazon S3 supports in an
|
1244
1288
|
# ACL. For more information, see [Access Control List (ACL)
|
1245
|
-
# Overview][
|
1289
|
+
# Overview][6].
|
1246
1290
|
#
|
1247
1291
|
# You specify each grantee as a type=value pair, where the type is one
|
1248
1292
|
# of the following:
|
@@ -1275,7 +1319,7 @@ module Aws::S3
|
|
1275
1319
|
# * South America (São Paulo)
|
1276
1320
|
#
|
1277
1321
|
# For a list of all the Amazon S3 supported Regions and endpoints,
|
1278
|
-
# see [Regions and Endpoints][
|
1322
|
+
# see [Regions and Endpoints][7] in the AWS General Reference.
|
1279
1323
|
#
|
1280
1324
|
# </note>
|
1281
1325
|
#
|
@@ -1292,20 +1336,21 @@ module Aws::S3
|
|
1292
1336
|
#
|
1293
1337
|
# The following operations are related to `CreateBucket`\:
|
1294
1338
|
#
|
1295
|
-
# * [PutObject][
|
1339
|
+
# * [PutObject][8]
|
1296
1340
|
#
|
1297
|
-
# * [DeleteBucket][
|
1341
|
+
# * [DeleteBucket][9]
|
1298
1342
|
#
|
1299
1343
|
#
|
1300
1344
|
#
|
1301
1345
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html
|
1302
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1303
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
1304
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
1305
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
1306
|
-
# [6]: https://docs.aws.amazon.com/
|
1307
|
-
# [7]: https://docs.aws.amazon.com/
|
1308
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
1346
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html
|
1347
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro
|
1348
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html
|
1349
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
1350
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
1351
|
+
# [7]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
1352
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
1353
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
|
1309
1354
|
#
|
1310
1355
|
# @option params [String] :acl
|
1311
1356
|
# The canned ACL to apply to the bucket.
|
@@ -1342,33 +1387,33 @@ module Aws::S3
|
|
1342
1387
|
# * {Types::CreateBucketOutput#location #location} => String
|
1343
1388
|
#
|
1344
1389
|
#
|
1345
|
-
# @example Example: To create a bucket
|
1390
|
+
# @example Example: To create a bucket in a specific region
|
1346
1391
|
#
|
1347
|
-
# # The following example creates a bucket.
|
1392
|
+
# # The following example creates a bucket. The request specifies an AWS region where to create the bucket.
|
1348
1393
|
#
|
1349
1394
|
# resp = client.create_bucket({
|
1350
1395
|
# bucket: "examplebucket",
|
1396
|
+
# create_bucket_configuration: {
|
1397
|
+
# location_constraint: "eu-west-1",
|
1398
|
+
# },
|
1351
1399
|
# })
|
1352
1400
|
#
|
1353
1401
|
# resp.to_h outputs the following:
|
1354
1402
|
# {
|
1355
|
-
# location: "/
|
1403
|
+
# location: "http://examplebucket.<Region>.s3.amazonaws.com/",
|
1356
1404
|
# }
|
1357
1405
|
#
|
1358
|
-
# @example Example: To create a bucket
|
1406
|
+
# @example Example: To create a bucket
|
1359
1407
|
#
|
1360
|
-
# # The following example creates a bucket.
|
1408
|
+
# # The following example creates a bucket.
|
1361
1409
|
#
|
1362
1410
|
# resp = client.create_bucket({
|
1363
1411
|
# bucket: "examplebucket",
|
1364
|
-
# create_bucket_configuration: {
|
1365
|
-
# location_constraint: "eu-west-1",
|
1366
|
-
# },
|
1367
1412
|
# })
|
1368
1413
|
#
|
1369
1414
|
# resp.to_h outputs the following:
|
1370
1415
|
# {
|
1371
|
-
# location: "
|
1416
|
+
# location: "/examplebucket",
|
1372
1417
|
# }
|
1373
1418
|
#
|
1374
1419
|
# @example Request syntax with placeholder values
|
@@ -1639,6 +1684,28 @@ module Aws::S3
|
|
1639
1684
|
# @option params [required, String] :bucket
|
1640
1685
|
# The name of the bucket to which to initiate the upload
|
1641
1686
|
#
|
1687
|
+
# When using this API with an access point, you must direct requests to
|
1688
|
+
# the access point hostname. The access point hostname takes the form
|
1689
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
1690
|
+
# When using this operation using an access point through the AWS SDKs,
|
1691
|
+
# you provide the access point ARN in place of the bucket name. For more
|
1692
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
1693
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
1694
|
+
#
|
1695
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
1696
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
1697
|
+
# takes the form
|
1698
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
1699
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
1700
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
1701
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
1702
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
1703
|
+
#
|
1704
|
+
#
|
1705
|
+
#
|
1706
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
1707
|
+
# [2]: https://docs.aws.amazon.com/
|
1708
|
+
#
|
1642
1709
|
# @option params [String] :cache_control
|
1643
1710
|
# Specifies caching behavior along the request/reply chain.
|
1644
1711
|
#
|
@@ -1805,7 +1872,7 @@ module Aws::S3
|
|
1805
1872
|
# "MetadataKey" => "MetadataValue",
|
1806
1873
|
# },
|
1807
1874
|
# server_side_encryption: "AES256", # accepts AES256, aws:kms
|
1808
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
|
1875
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
|
1809
1876
|
# website_redirect_location: "WebsiteRedirectLocation",
|
1810
1877
|
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
1811
1878
|
# sse_customer_key: "SSECustomerKey",
|
@@ -1843,7 +1910,7 @@ module Aws::S3
|
|
1843
1910
|
req.send_request(options)
|
1844
1911
|
end
|
1845
1912
|
|
1846
|
-
# Deletes the bucket. All objects (including all object versions and
|
1913
|
+
# Deletes the S3 bucket. All objects (including all object versions and
|
1847
1914
|
# delete markers) in the bucket must be deleted before the bucket itself
|
1848
1915
|
# can be deleted.
|
1849
1916
|
#
|
@@ -2551,9 +2618,19 @@ module Aws::S3
|
|
2551
2618
|
# information about access point ARNs, see [Using Access Points][1] in
|
2552
2619
|
# the *Amazon Simple Storage Service Developer Guide*.
|
2553
2620
|
#
|
2621
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
2622
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2623
|
+
# takes the form
|
2624
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
2625
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
2626
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
2627
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
2628
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
2629
|
+
#
|
2554
2630
|
#
|
2555
2631
|
#
|
2556
2632
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
2633
|
+
# [2]: https://docs.aws.amazon.com/
|
2557
2634
|
#
|
2558
2635
|
# @option params [required, String] :key
|
2559
2636
|
# Key name of the object to delete.
|
@@ -2594,6 +2671,15 @@ module Aws::S3
|
|
2594
2671
|
# * {Types::DeleteObjectOutput#request_charged #request_charged} => String
|
2595
2672
|
#
|
2596
2673
|
#
|
2674
|
+
# @example Example: To delete an object (from a non-versioned bucket)
|
2675
|
+
#
|
2676
|
+
# # The following example deletes an object from a non-versioned bucket.
|
2677
|
+
#
|
2678
|
+
# resp = client.delete_object({
|
2679
|
+
# bucket: "ExampleBucket",
|
2680
|
+
# key: "HappyFace.jpg",
|
2681
|
+
# })
|
2682
|
+
#
|
2597
2683
|
# @example Example: To delete an object
|
2598
2684
|
#
|
2599
2685
|
# # The following example deletes an object from an S3 bucket.
|
@@ -2607,15 +2693,6 @@ module Aws::S3
|
|
2607
2693
|
# {
|
2608
2694
|
# }
|
2609
2695
|
#
|
2610
|
-
# @example Example: To delete an object (from a non-versioned bucket)
|
2611
|
-
#
|
2612
|
-
# # The following example deletes an object from a non-versioned bucket.
|
2613
|
-
#
|
2614
|
-
# resp = client.delete_object({
|
2615
|
-
# bucket: "ExampleBucket",
|
2616
|
-
# key: "HappyFace.jpg",
|
2617
|
-
# })
|
2618
|
-
#
|
2619
2696
|
# @example Request syntax with placeholder values
|
2620
2697
|
#
|
2621
2698
|
# resp = client.delete_object({
|
@@ -2677,9 +2754,19 @@ module Aws::S3
|
|
2677
2754
|
# information about access point ARNs, see [Using Access Points][1] in
|
2678
2755
|
# the *Amazon Simple Storage Service Developer Guide*.
|
2679
2756
|
#
|
2757
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
2758
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2759
|
+
# takes the form
|
2760
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
2761
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
2762
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
2763
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
2764
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
2765
|
+
#
|
2680
2766
|
#
|
2681
2767
|
#
|
2682
2768
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
2769
|
+
# [2]: https://docs.aws.amazon.com/
|
2683
2770
|
#
|
2684
2771
|
# @option params [required, String] :key
|
2685
2772
|
# Name of the object key.
|
@@ -2697,35 +2784,35 @@ module Aws::S3
|
|
2697
2784
|
# * {Types::DeleteObjectTaggingOutput#version_id #version_id} => String
|
2698
2785
|
#
|
2699
2786
|
#
|
2700
|
-
# @example Example: To remove tag set from an object
|
2787
|
+
# @example Example: To remove tag set from an object
|
2701
2788
|
#
|
2702
|
-
# # The following example removes tag set associated with the specified object
|
2703
|
-
# #
|
2789
|
+
# # The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the
|
2790
|
+
# # operation removes tag set from the latest object version.
|
2704
2791
|
#
|
2705
2792
|
# resp = client.delete_object_tagging({
|
2706
2793
|
# bucket: "examplebucket",
|
2707
2794
|
# key: "HappyFace.jpg",
|
2708
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2709
2795
|
# })
|
2710
2796
|
#
|
2711
2797
|
# resp.to_h outputs the following:
|
2712
2798
|
# {
|
2713
|
-
# version_id: "
|
2799
|
+
# version_id: "null",
|
2714
2800
|
# }
|
2715
2801
|
#
|
2716
|
-
# @example Example: To remove tag set from an object
|
2802
|
+
# @example Example: To remove tag set from an object version
|
2717
2803
|
#
|
2718
|
-
# # The following example removes tag set associated with the specified object.
|
2719
|
-
# #
|
2804
|
+
# # The following example removes tag set associated with the specified object version. The request specifies both the
|
2805
|
+
# # object key and object version.
|
2720
2806
|
#
|
2721
2807
|
# resp = client.delete_object_tagging({
|
2722
2808
|
# bucket: "examplebucket",
|
2723
2809
|
# key: "HappyFace.jpg",
|
2810
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2724
2811
|
# })
|
2725
2812
|
#
|
2726
2813
|
# resp.to_h outputs the following:
|
2727
2814
|
# {
|
2728
|
-
# version_id: "
|
2815
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2729
2816
|
# }
|
2730
2817
|
#
|
2731
2818
|
# @example Request syntax with placeholder values
|
@@ -2814,9 +2901,19 @@ module Aws::S3
|
|
2814
2901
|
# information about access point ARNs, see [Using Access Points][1] in
|
2815
2902
|
# the *Amazon Simple Storage Service Developer Guide*.
|
2816
2903
|
#
|
2904
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
2905
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2906
|
+
# takes the form
|
2907
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
2908
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
2909
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
2910
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
2911
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
2912
|
+
#
|
2817
2913
|
#
|
2818
2914
|
#
|
2819
2915
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
2916
|
+
# [2]: https://docs.aws.amazon.com/
|
2820
2917
|
#
|
2821
2918
|
# @option params [required, Types::Delete] :delete
|
2822
2919
|
# Container for the request.
|
@@ -2855,22 +2952,20 @@ module Aws::S3
|
|
2855
2952
|
# * {Types::DeleteObjectsOutput#errors #errors} => Array<Types::Error>
|
2856
2953
|
#
|
2857
2954
|
#
|
2858
|
-
# @example Example: To delete multiple
|
2955
|
+
# @example Example: To delete multiple objects from a versioned bucket
|
2859
2956
|
#
|
2860
|
-
# # The following example deletes objects from a bucket. The
|
2861
|
-
# #
|
2957
|
+
# # The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the
|
2958
|
+
# # object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
|
2862
2959
|
#
|
2863
2960
|
# resp = client.delete_objects({
|
2864
2961
|
# bucket: "examplebucket",
|
2865
2962
|
# delete: {
|
2866
2963
|
# objects: [
|
2867
2964
|
# {
|
2868
|
-
# key: "
|
2869
|
-
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
2965
|
+
# key: "objectkey1",
|
2870
2966
|
# },
|
2871
2967
|
# {
|
2872
|
-
# key: "
|
2873
|
-
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
2968
|
+
# key: "objectkey2",
|
2874
2969
|
# },
|
2875
2970
|
# ],
|
2876
2971
|
# quiet: false,
|
@@ -2881,30 +2976,34 @@ module Aws::S3
|
|
2881
2976
|
# {
|
2882
2977
|
# deleted: [
|
2883
2978
|
# {
|
2884
|
-
#
|
2885
|
-
#
|
2979
|
+
# delete_marker: true,
|
2980
|
+
# delete_marker_version_id: "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
|
2981
|
+
# key: "objectkey1",
|
2886
2982
|
# },
|
2887
2983
|
# {
|
2888
|
-
#
|
2889
|
-
#
|
2984
|
+
# delete_marker: true,
|
2985
|
+
# delete_marker_version_id: "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
|
2986
|
+
# key: "objectkey2",
|
2890
2987
|
# },
|
2891
2988
|
# ],
|
2892
2989
|
# }
|
2893
2990
|
#
|
2894
|
-
# @example Example: To delete multiple
|
2991
|
+
# @example Example: To delete multiple object versions from a versioned bucket
|
2895
2992
|
#
|
2896
|
-
# # The following example deletes objects from a bucket. The
|
2897
|
-
# #
|
2993
|
+
# # The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object
|
2994
|
+
# # versions and returns the key and versions of deleted objects in the response.
|
2898
2995
|
#
|
2899
2996
|
# resp = client.delete_objects({
|
2900
2997
|
# bucket: "examplebucket",
|
2901
2998
|
# delete: {
|
2902
2999
|
# objects: [
|
2903
3000
|
# {
|
2904
|
-
# key: "
|
3001
|
+
# key: "HappyFace.jpg",
|
3002
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
2905
3003
|
# },
|
2906
3004
|
# {
|
2907
|
-
# key: "
|
3005
|
+
# key: "HappyFace.jpg",
|
3006
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
2908
3007
|
# },
|
2909
3008
|
# ],
|
2910
3009
|
# quiet: false,
|
@@ -2915,14 +3014,12 @@ module Aws::S3
|
|
2915
3014
|
# {
|
2916
3015
|
# deleted: [
|
2917
3016
|
# {
|
2918
|
-
#
|
2919
|
-
#
|
2920
|
-
# key: "objectkey1",
|
3017
|
+
# key: "HappyFace.jpg",
|
3018
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
2921
3019
|
# },
|
2922
3020
|
# {
|
2923
|
-
#
|
2924
|
-
#
|
2925
|
-
# key: "objectkey2",
|
3021
|
+
# key: "HappyFace.jpg",
|
3022
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
2926
3023
|
# },
|
2927
3024
|
# ],
|
2928
3025
|
# }
|
@@ -3061,7 +3158,7 @@ module Aws::S3
|
|
3061
3158
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
3062
3159
|
#
|
3063
3160
|
# @option params [required, String] :bucket
|
3064
|
-
#
|
3161
|
+
# The name of the bucket for which the accelerate configuration is
|
3065
3162
|
# retrieved.
|
3066
3163
|
#
|
3067
3164
|
# @option params [String] :expected_bucket_owner
|
@@ -3578,8 +3675,8 @@ module Aws::S3
|
|
3578
3675
|
# combination of both. Accordingly, this section describes the latest
|
3579
3676
|
# API. The response describes the new filter element that you can use to
|
3580
3677
|
# specify a filter to select a subset of objects to which the rule
|
3581
|
-
# applies. If you are
|
3582
|
-
# configuration, it works. For the earlier API description, see
|
3678
|
+
# applies. If you are using a previous version of the lifecycle
|
3679
|
+
# configuration, it still works. For the earlier API description, see
|
3583
3680
|
# [GetBucketLifecycle][1].
|
3584
3681
|
#
|
3585
3682
|
# </note>
|
@@ -3907,7 +4004,8 @@ module Aws::S3
|
|
3907
4004
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html
|
3908
4005
|
#
|
3909
4006
|
# @option params [required, String] :bucket
|
3910
|
-
#
|
4007
|
+
# The name of the bucket for which to get the notification
|
4008
|
+
# configuration.
|
3911
4009
|
#
|
3912
4010
|
# @option params [String] :expected_bucket_owner
|
3913
4011
|
# The account id of the expected bucket owner. If the bucket is owned by
|
@@ -4040,7 +4138,8 @@ module Aws::S3
|
|
4040
4138
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html
|
4041
4139
|
#
|
4042
4140
|
# @option params [required, String] :bucket
|
4043
|
-
#
|
4141
|
+
# The name of the bucket for which to get the notification
|
4142
|
+
# configuration.
|
4044
4143
|
#
|
4045
4144
|
# @option params [String] :expected_bucket_owner
|
4046
4145
|
# The account id of the expected bucket owner. If the bucket is owned by
|
@@ -4332,7 +4431,7 @@ module Aws::S3
|
|
4332
4431
|
# resp.replication_configuration.rules[0].existing_object_replication.status #=> String, one of "Enabled", "Disabled"
|
4333
4432
|
# resp.replication_configuration.rules[0].destination.bucket #=> String
|
4334
4433
|
# resp.replication_configuration.rules[0].destination.account #=> String
|
4335
|
-
# resp.replication_configuration.rules[0].destination.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE"
|
4434
|
+
# resp.replication_configuration.rules[0].destination.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS"
|
4336
4435
|
# resp.replication_configuration.rules[0].destination.access_control_translation.owner #=> String, one of "Destination"
|
4337
4436
|
# resp.replication_configuration.rules[0].destination.encryption_configuration.replica_kms_key_id #=> String
|
4338
4437
|
# resp.replication_configuration.rules[0].destination.replication_time.status #=> String, one of "Enabled", "Disabled"
|
@@ -4823,9 +4922,19 @@ module Aws::S3
|
|
4823
4922
|
# information about access point ARNs, see [Using Access Points][1] in
|
4824
4923
|
# the *Amazon Simple Storage Service Developer Guide*.
|
4825
4924
|
#
|
4925
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
4926
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
4927
|
+
# takes the form
|
4928
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
4929
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
4930
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
4931
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
4932
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
4933
|
+
#
|
4826
4934
|
#
|
4827
4935
|
#
|
4828
4936
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
4937
|
+
# [2]: https://docs.aws.amazon.com/
|
4829
4938
|
#
|
4830
4939
|
# @option params [String] :if_match
|
4831
4940
|
# Return the object only if its entity tag (ETag) is the same as the one
|
@@ -4955,49 +5064,49 @@ module Aws::S3
|
|
4955
5064
|
# * {Types::GetObjectOutput#object_lock_legal_hold_status #object_lock_legal_hold_status} => String
|
4956
5065
|
#
|
4957
5066
|
#
|
4958
|
-
# @example Example: To retrieve
|
5067
|
+
# @example Example: To retrieve an object
|
4959
5068
|
#
|
4960
|
-
# # The following example retrieves an object for an S3 bucket.
|
4961
|
-
# # specific byte range.
|
5069
|
+
# # The following example retrieves an object for an S3 bucket.
|
4962
5070
|
#
|
4963
5071
|
# resp = client.get_object({
|
4964
5072
|
# bucket: "examplebucket",
|
4965
|
-
# key: "
|
4966
|
-
# range: "bytes=0-9",
|
5073
|
+
# key: "HappyFace.jpg",
|
4967
5074
|
# })
|
4968
5075
|
#
|
4969
5076
|
# resp.to_h outputs the following:
|
4970
5077
|
# {
|
4971
5078
|
# accept_ranges: "bytes",
|
4972
|
-
# content_length:
|
4973
|
-
#
|
4974
|
-
#
|
4975
|
-
#
|
4976
|
-
# last_modified: Time.parse("Thu, 09 Oct 2014 22:57:28 GMT"),
|
5079
|
+
# content_length: 3191,
|
5080
|
+
# content_type: "image/jpeg",
|
5081
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
5082
|
+
# last_modified: Time.parse("Thu, 15 Dec 2016 01:19:41 GMT"),
|
4977
5083
|
# metadata: {
|
4978
5084
|
# },
|
5085
|
+
# tag_count: 2,
|
4979
5086
|
# version_id: "null",
|
4980
5087
|
# }
|
4981
5088
|
#
|
4982
|
-
# @example Example: To retrieve an object
|
5089
|
+
# @example Example: To retrieve a byte range of an object
|
4983
5090
|
#
|
4984
|
-
# # The following example retrieves an object for an S3 bucket.
|
5091
|
+
# # The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a
|
5092
|
+
# # specific byte range.
|
4985
5093
|
#
|
4986
5094
|
# resp = client.get_object({
|
4987
5095
|
# bucket: "examplebucket",
|
4988
|
-
# key: "
|
5096
|
+
# key: "SampleFile.txt",
|
5097
|
+
# range: "bytes=0-9",
|
4989
5098
|
# })
|
4990
5099
|
#
|
4991
5100
|
# resp.to_h outputs the following:
|
4992
5101
|
# {
|
4993
5102
|
# accept_ranges: "bytes",
|
4994
|
-
# content_length:
|
4995
|
-
#
|
4996
|
-
#
|
4997
|
-
#
|
5103
|
+
# content_length: 10,
|
5104
|
+
# content_range: "bytes 0-9/43",
|
5105
|
+
# content_type: "text/plain",
|
5106
|
+
# etag: "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
|
5107
|
+
# last_modified: Time.parse("Thu, 09 Oct 2014 22:57:28 GMT"),
|
4998
5108
|
# metadata: {
|
4999
5109
|
# },
|
5000
|
-
# tag_count: 2,
|
5001
5110
|
# version_id: "null",
|
5002
5111
|
# }
|
5003
5112
|
#
|
@@ -5082,7 +5191,7 @@ module Aws::S3
|
|
5082
5191
|
# resp.sse_customer_algorithm #=> String
|
5083
5192
|
# resp.sse_customer_key_md5 #=> String
|
5084
5193
|
# resp.ssekms_key_id #=> String
|
5085
|
-
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE"
|
5194
|
+
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS"
|
5086
5195
|
# resp.request_charged #=> String, one of "requester"
|
5087
5196
|
# resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA"
|
5088
5197
|
# resp.parts_count #=> Integer
|
@@ -5101,7 +5210,9 @@ module Aws::S3
|
|
5101
5210
|
end
|
5102
5211
|
|
5103
5212
|
# Returns the access control list (ACL) of an object. To use this
|
5104
|
-
# operation, you must have
|
5213
|
+
# operation, you must have `READ_ACP` access to the object.
|
5214
|
+
#
|
5215
|
+
# This action is not supported by Amazon S3 on Outposts.
|
5105
5216
|
#
|
5106
5217
|
# **Versioning**
|
5107
5218
|
#
|
@@ -5254,6 +5365,8 @@ module Aws::S3
|
|
5254
5365
|
# Gets an object's current Legal Hold status. For more information, see
|
5255
5366
|
# [Locking Objects][1].
|
5256
5367
|
#
|
5368
|
+
# This action is not supported by Amazon S3 on Outposts.
|
5369
|
+
#
|
5257
5370
|
#
|
5258
5371
|
#
|
5259
5372
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
@@ -5337,6 +5450,18 @@ module Aws::S3
|
|
5337
5450
|
# @option params [required, String] :bucket
|
5338
5451
|
# The bucket whose Object Lock configuration you want to retrieve.
|
5339
5452
|
#
|
5453
|
+
# When using this API with an access point, you must direct requests to
|
5454
|
+
# the access point hostname. The access point hostname takes the form
|
5455
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5456
|
+
# When using this operation using an access point through the AWS SDKs,
|
5457
|
+
# you provide the access point ARN in place of the bucket name. For more
|
5458
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
5459
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
5460
|
+
#
|
5461
|
+
#
|
5462
|
+
#
|
5463
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
5464
|
+
#
|
5340
5465
|
# @option params [String] :expected_bucket_owner
|
5341
5466
|
# The account id of the expected bucket owner. If the bucket is owned by
|
5342
5467
|
# a different account, the request will fail with an HTTP `403 (Access
|
@@ -5372,6 +5497,8 @@ module Aws::S3
|
|
5372
5497
|
# Retrieves an object's retention settings. For more information, see
|
5373
5498
|
# [Locking Objects][1].
|
5374
5499
|
#
|
5500
|
+
# This action is not supported by Amazon S3 on Outposts.
|
5501
|
+
#
|
5375
5502
|
#
|
5376
5503
|
#
|
5377
5504
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
@@ -5483,9 +5610,19 @@ module Aws::S3
|
|
5483
5610
|
# information about access point ARNs, see [Using Access Points][1] in
|
5484
5611
|
# the *Amazon Simple Storage Service Developer Guide*.
|
5485
5612
|
#
|
5613
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
5614
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5615
|
+
# takes the form
|
5616
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
5617
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
5618
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
5619
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
5620
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
5621
|
+
#
|
5486
5622
|
#
|
5487
5623
|
#
|
5488
5624
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
5625
|
+
# [2]: https://docs.aws.amazon.com/
|
5489
5626
|
#
|
5490
5627
|
# @option params [required, String] :key
|
5491
5628
|
# Object key for which to get the tagging information.
|
@@ -5504,49 +5641,49 @@ module Aws::S3
|
|
5504
5641
|
# * {Types::GetObjectTaggingOutput#tag_set #tag_set} => Array<Types::Tag>
|
5505
5642
|
#
|
5506
5643
|
#
|
5507
|
-
# @example Example: To retrieve tag set of
|
5644
|
+
# @example Example: To retrieve tag set of a specific object version
|
5508
5645
|
#
|
5509
|
-
# # The following example retrieves tag set of an object.
|
5646
|
+
# # The following example retrieves tag set of an object. The request specifies object version.
|
5510
5647
|
#
|
5511
5648
|
# resp = client.get_object_tagging({
|
5512
5649
|
# bucket: "examplebucket",
|
5513
|
-
# key: "
|
5650
|
+
# key: "exampleobject",
|
5651
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
5514
5652
|
# })
|
5515
5653
|
#
|
5516
5654
|
# resp.to_h outputs the following:
|
5517
5655
|
# {
|
5518
5656
|
# tag_set: [
|
5519
5657
|
# {
|
5520
|
-
# key: "
|
5521
|
-
# value: "
|
5522
|
-
# },
|
5523
|
-
# {
|
5524
|
-
# key: "Key3",
|
5525
|
-
# value: "Value3",
|
5658
|
+
# key: "Key1",
|
5659
|
+
# value: "Value1",
|
5526
5660
|
# },
|
5527
5661
|
# ],
|
5528
|
-
# version_id: "
|
5662
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
5529
5663
|
# }
|
5530
5664
|
#
|
5531
|
-
# @example Example: To retrieve tag set of
|
5665
|
+
# @example Example: To retrieve tag set of an object
|
5532
5666
|
#
|
5533
|
-
# # The following example retrieves tag set of an object.
|
5667
|
+
# # The following example retrieves tag set of an object.
|
5534
5668
|
#
|
5535
5669
|
# resp = client.get_object_tagging({
|
5536
5670
|
# bucket: "examplebucket",
|
5537
|
-
# key: "
|
5538
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
5671
|
+
# key: "HappyFace.jpg",
|
5539
5672
|
# })
|
5540
5673
|
#
|
5541
5674
|
# resp.to_h outputs the following:
|
5542
5675
|
# {
|
5543
5676
|
# tag_set: [
|
5544
5677
|
# {
|
5545
|
-
# key: "
|
5546
|
-
# value: "
|
5678
|
+
# key: "Key4",
|
5679
|
+
# value: "Value4",
|
5680
|
+
# },
|
5681
|
+
# {
|
5682
|
+
# key: "Key3",
|
5683
|
+
# value: "Value3",
|
5547
5684
|
# },
|
5548
5685
|
# ],
|
5549
|
-
# version_id: "
|
5686
|
+
# version_id: "null",
|
5550
5687
|
# }
|
5551
5688
|
#
|
5552
5689
|
# @example Request syntax with placeholder values
|
@@ -5574,18 +5711,20 @@ module Aws::S3
|
|
5574
5711
|
req.send_request(options)
|
5575
5712
|
end
|
5576
5713
|
|
5577
|
-
#
|
5714
|
+
# Returns torrent files from a bucket. BitTorrent can save you bandwidth
|
5578
5715
|
# when you're distributing large files. For more information about
|
5579
|
-
# BitTorrent, see [Amazon S3
|
5716
|
+
# BitTorrent, see [Using BitTorrent with Amazon S3][1].
|
5580
5717
|
#
|
5581
|
-
# <note markdown="1"> You can get torrent only for objects that are less than 5 GB in size
|
5582
|
-
# and that are not encrypted using server-side encryption with
|
5718
|
+
# <note markdown="1"> You can get torrent only for objects that are less than 5 GB in size,
|
5719
|
+
# and that are not encrypted using server-side encryption with a
|
5583
5720
|
# customer-provided encryption key.
|
5584
5721
|
#
|
5585
5722
|
# </note>
|
5586
5723
|
#
|
5587
5724
|
# To use GET, you must have READ access to the object.
|
5588
5725
|
#
|
5726
|
+
# This action is not supported by Amazon S3 on Outposts.
|
5727
|
+
#
|
5589
5728
|
# The following operation is related to `GetObjectTorrent`\:
|
5590
5729
|
#
|
5591
5730
|
# * [GetObject][2]
|
@@ -5757,6 +5896,28 @@ module Aws::S3
|
|
5757
5896
|
# @option params [required, String] :bucket
|
5758
5897
|
# The bucket name.
|
5759
5898
|
#
|
5899
|
+
# When using this API with an access point, you must direct requests to
|
5900
|
+
# the access point hostname. The access point hostname takes the form
|
5901
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5902
|
+
# When using this operation using an access point through the AWS SDKs,
|
5903
|
+
# you provide the access point ARN in place of the bucket name. For more
|
5904
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
5905
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
5906
|
+
#
|
5907
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
5908
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5909
|
+
# takes the form
|
5910
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
5911
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
5912
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
5913
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
5914
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
5915
|
+
#
|
5916
|
+
#
|
5917
|
+
#
|
5918
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
5919
|
+
# [2]: https://docs.aws.amazon.com/
|
5920
|
+
#
|
5760
5921
|
# @option params [String] :expected_bucket_owner
|
5761
5922
|
# The account id of the expected bucket owner. If the bucket is owned by
|
5762
5923
|
# a different account, the request will fail with an HTTP `403 (Access
|
@@ -5882,6 +6043,28 @@ module Aws::S3
|
|
5882
6043
|
# @option params [required, String] :bucket
|
5883
6044
|
# The name of the bucket containing the object.
|
5884
6045
|
#
|
6046
|
+
# When using this API with an access point, you must direct requests to
|
6047
|
+
# the access point hostname. The access point hostname takes the form
|
6048
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6049
|
+
# When using this operation using an access point through the AWS SDKs,
|
6050
|
+
# you provide the access point ARN in place of the bucket name. For more
|
6051
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
6052
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
6053
|
+
#
|
6054
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
6055
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
6056
|
+
# takes the form
|
6057
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
6058
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
6059
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
6060
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
6061
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
6062
|
+
#
|
6063
|
+
#
|
6064
|
+
#
|
6065
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
6066
|
+
# [2]: https://docs.aws.amazon.com/
|
6067
|
+
#
|
5885
6068
|
# @option params [String] :if_match
|
5886
6069
|
# Return the object only if its entity tag (ETag) is the same as the one
|
5887
6070
|
# specified, otherwise return a 412 (precondition failed).
|
@@ -6050,7 +6233,7 @@ module Aws::S3
|
|
6050
6233
|
# resp.sse_customer_algorithm #=> String
|
6051
6234
|
# resp.sse_customer_key_md5 #=> String
|
6052
6235
|
# resp.ssekms_key_id #=> String
|
6053
|
-
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE"
|
6236
|
+
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS"
|
6054
6237
|
# resp.request_charged #=> String, one of "requester"
|
6055
6238
|
# resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA"
|
6056
6239
|
# resp.parts_count #=> Integer
|
@@ -6472,7 +6655,7 @@ module Aws::S3
|
|
6472
6655
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
6473
6656
|
#
|
6474
6657
|
# @option params [required, String] :bucket
|
6475
|
-
#
|
6658
|
+
# The name of the bucket to which the multipart upload was initiated.
|
6476
6659
|
#
|
6477
6660
|
# When using this API with an access point, you must direct requests to
|
6478
6661
|
# the access point hostname. The access point hostname takes the form
|
@@ -6482,9 +6665,19 @@ module Aws::S3
|
|
6482
6665
|
# information about access point ARNs, see [Using Access Points][1] in
|
6483
6666
|
# the *Amazon Simple Storage Service Developer Guide*.
|
6484
6667
|
#
|
6668
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
6669
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
6670
|
+
# takes the form
|
6671
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
6672
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
6673
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
6674
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
6675
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
6676
|
+
#
|
6485
6677
|
#
|
6486
6678
|
#
|
6487
6679
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
6680
|
+
# [2]: https://docs.aws.amazon.com/
|
6488
6681
|
#
|
6489
6682
|
# @option params [String] :delimiter
|
6490
6683
|
# Character you use to group keys.
|
@@ -6682,7 +6875,7 @@ module Aws::S3
|
|
6682
6875
|
# resp.uploads[0].upload_id #=> String
|
6683
6876
|
# resp.uploads[0].key #=> String
|
6684
6877
|
# resp.uploads[0].initiated #=> Time
|
6685
|
-
# resp.uploads[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE"
|
6878
|
+
# resp.uploads[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS"
|
6686
6879
|
# resp.uploads[0].owner.display_name #=> String
|
6687
6880
|
# resp.uploads[0].owner.id #=> String
|
6688
6881
|
# resp.uploads[0].initiator.id #=> String
|
@@ -6700,7 +6893,7 @@ module Aws::S3
|
|
6700
6893
|
req.send_request(options)
|
6701
6894
|
end
|
6702
6895
|
|
6703
|
-
# Returns metadata about all of the
|
6896
|
+
# Returns metadata about all versions of the objects in a bucket. You
|
6704
6897
|
# can also use request parameters as selection criteria to return
|
6705
6898
|
# metadata about a subset of all the object versions.
|
6706
6899
|
#
|
@@ -6712,6 +6905,8 @@ module Aws::S3
|
|
6712
6905
|
#
|
6713
6906
|
# To use this operation, you must have READ access to the bucket.
|
6714
6907
|
#
|
6908
|
+
# This action is not supported by Amazon S3 on Outposts.
|
6909
|
+
#
|
6715
6910
|
# The following operations are related to `ListObjectVersions`\:
|
6716
6911
|
#
|
6717
6912
|
# * [ListObjectsV2][1]
|
@@ -6732,18 +6927,6 @@ module Aws::S3
|
|
6732
6927
|
# @option params [required, String] :bucket
|
6733
6928
|
# The bucket name that contains the objects.
|
6734
6929
|
#
|
6735
|
-
# When using this API with an access point, you must direct requests to
|
6736
|
-
# the access point hostname. The access point hostname takes the form
|
6737
|
-
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6738
|
-
# When using this operation using an access point through the AWS SDKs,
|
6739
|
-
# you provide the access point ARN in place of the bucket name. For more
|
6740
|
-
# information about access point ARNs, see [Using Access Points][1] in
|
6741
|
-
# the *Amazon Simple Storage Service Developer Guide*.
|
6742
|
-
#
|
6743
|
-
#
|
6744
|
-
#
|
6745
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
6746
|
-
#
|
6747
6930
|
# @option params [String] :delimiter
|
6748
6931
|
# A delimiter is a character that you specify to group keys. All keys
|
6749
6932
|
# that contain the same string between the `prefix` and the first
|
@@ -6936,6 +7119,28 @@ module Aws::S3
|
|
6936
7119
|
# @option params [required, String] :bucket
|
6937
7120
|
# The name of the bucket containing the objects.
|
6938
7121
|
#
|
7122
|
+
# When using this API with an access point, you must direct requests to
|
7123
|
+
# the access point hostname. The access point hostname takes the form
|
7124
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7125
|
+
# When using this operation using an access point through the AWS SDKs,
|
7126
|
+
# you provide the access point ARN in place of the bucket name. For more
|
7127
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
7128
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
7129
|
+
#
|
7130
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
7131
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7132
|
+
# takes the form
|
7133
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
7134
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
7135
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
7136
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
7137
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
7138
|
+
#
|
7139
|
+
#
|
7140
|
+
#
|
7141
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
7142
|
+
# [2]: https://docs.aws.amazon.com/
|
7143
|
+
#
|
6939
7144
|
# @option params [String] :delimiter
|
6940
7145
|
# A delimiter is a character you use to group keys.
|
6941
7146
|
#
|
@@ -7045,7 +7250,7 @@ module Aws::S3
|
|
7045
7250
|
# resp.contents[0].last_modified #=> Time
|
7046
7251
|
# resp.contents[0].etag #=> String
|
7047
7252
|
# resp.contents[0].size #=> Integer
|
7048
|
-
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE"
|
7253
|
+
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS"
|
7049
7254
|
# resp.contents[0].owner.display_name #=> String
|
7050
7255
|
# resp.contents[0].owner.id #=> String
|
7051
7256
|
# resp.name #=> String
|
@@ -7116,9 +7321,19 @@ module Aws::S3
|
|
7116
7321
|
# information about access point ARNs, see [Using Access Points][1] in
|
7117
7322
|
# the *Amazon Simple Storage Service Developer Guide*.
|
7118
7323
|
#
|
7324
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
7325
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7326
|
+
# takes the form
|
7327
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
7328
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
7329
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
7330
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
7331
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
7332
|
+
#
|
7119
7333
|
#
|
7120
7334
|
#
|
7121
7335
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
7336
|
+
# [2]: https://docs.aws.amazon.com/
|
7122
7337
|
#
|
7123
7338
|
# @option params [String] :delimiter
|
7124
7339
|
# A delimiter is a character you use to group keys.
|
@@ -7236,7 +7451,7 @@ module Aws::S3
|
|
7236
7451
|
# resp.contents[0].last_modified #=> Time
|
7237
7452
|
# resp.contents[0].etag #=> String
|
7238
7453
|
# resp.contents[0].size #=> Integer
|
7239
|
-
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE"
|
7454
|
+
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS"
|
7240
7455
|
# resp.contents[0].owner.display_name #=> String
|
7241
7456
|
# resp.contents[0].owner.id #=> String
|
7242
7457
|
# resp.name #=> String
|
@@ -7302,7 +7517,7 @@ module Aws::S3
|
|
7302
7517
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
7303
7518
|
#
|
7304
7519
|
# @option params [required, String] :bucket
|
7305
|
-
#
|
7520
|
+
# The name of the bucket to which the parts are being uploaded.
|
7306
7521
|
#
|
7307
7522
|
# When using this API with an access point, you must direct requests to
|
7308
7523
|
# the access point hostname. The access point hostname takes the form
|
@@ -7312,9 +7527,19 @@ module Aws::S3
|
|
7312
7527
|
# information about access point ARNs, see [Using Access Points][1] in
|
7313
7528
|
# the *Amazon Simple Storage Service Developer Guide*.
|
7314
7529
|
#
|
7530
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
7531
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7532
|
+
# takes the form
|
7533
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
7534
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
7535
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
7536
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
7537
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
7538
|
+
#
|
7315
7539
|
#
|
7316
7540
|
#
|
7317
7541
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
7542
|
+
# [2]: https://docs.aws.amazon.com/
|
7318
7543
|
#
|
7319
7544
|
# @option params [required, String] :key
|
7320
7545
|
# Object key for which the multipart upload was initiated.
|
@@ -7435,7 +7660,7 @@ module Aws::S3
|
|
7435
7660
|
# resp.initiator.display_name #=> String
|
7436
7661
|
# resp.owner.display_name #=> String
|
7437
7662
|
# resp.owner.id #=> String
|
7438
|
-
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE"
|
7663
|
+
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS"
|
7439
7664
|
# resp.request_charged #=> String, one of "requester"
|
7440
7665
|
#
|
7441
7666
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListParts AWS API Documentation
|
@@ -7494,7 +7719,7 @@ module Aws::S3
|
|
7494
7719
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
7495
7720
|
#
|
7496
7721
|
# @option params [required, String] :bucket
|
7497
|
-
#
|
7722
|
+
# The name of the bucket for which the accelerate configuration is set.
|
7498
7723
|
#
|
7499
7724
|
# @option params [required, Types::AccelerateConfiguration] :accelerate_configuration
|
7500
7725
|
# Container for setting the transfer acceleration state.
|
@@ -9317,7 +9542,7 @@ module Aws::S3
|
|
9317
9542
|
# destination: { # required
|
9318
9543
|
# bucket: "BucketName", # required
|
9319
9544
|
# account: "AccountId",
|
9320
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
|
9545
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
|
9321
9546
|
# access_control_translation: {
|
9322
9547
|
# owner: "Destination", # required, accepts Destination
|
9323
9548
|
# },
|
@@ -9928,7 +10153,7 @@ module Aws::S3
|
|
9928
10153
|
# Object data.
|
9929
10154
|
#
|
9930
10155
|
# @option params [required, String] :bucket
|
9931
|
-
#
|
10156
|
+
# The bucket name to which the PUT operation was initiated.
|
9932
10157
|
#
|
9933
10158
|
# When using this API with an access point, you must direct requests to
|
9934
10159
|
# the access point hostname. The access point hostname takes the form
|
@@ -9938,9 +10163,19 @@ module Aws::S3
|
|
9938
10163
|
# information about access point ARNs, see [Using Access Points][1] in
|
9939
10164
|
# the *Amazon Simple Storage Service Developer Guide*.
|
9940
10165
|
#
|
10166
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
10167
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
10168
|
+
# takes the form
|
10169
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
10170
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
10171
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
10172
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
10173
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
10174
|
+
#
|
9941
10175
|
#
|
9942
10176
|
#
|
9943
10177
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
10178
|
+
# [2]: https://docs.aws.amazon.com/
|
9944
10179
|
#
|
9945
10180
|
# @option params [String] :cache_control
|
9946
10181
|
# Can be used to specify caching behavior along the request/reply chain.
|
@@ -10147,40 +10382,62 @@ module Aws::S3
|
|
10147
10382
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
10148
10383
|
#
|
10149
10384
|
#
|
10150
|
-
# @example Example: To upload an object
|
10385
|
+
# @example Example: To upload an object
|
10151
10386
|
#
|
10152
|
-
# # The following example uploads
|
10153
|
-
# #
|
10387
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
10388
|
+
# # syntax. S3 returns VersionId of the newly created object.
|
10389
|
+
#
|
10390
|
+
# resp = client.put_object({
|
10391
|
+
# body: "HappyFace.jpg",
|
10392
|
+
# bucket: "examplebucket",
|
10393
|
+
# key: "HappyFace.jpg",
|
10394
|
+
# })
|
10395
|
+
#
|
10396
|
+
# resp.to_h outputs the following:
|
10397
|
+
# {
|
10398
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
10399
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
10400
|
+
# }
|
10401
|
+
#
|
10402
|
+
# @example Example: To upload object and specify user-defined metadata
|
10403
|
+
#
|
10404
|
+
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
10405
|
+
# # enabled, S3 returns version ID in response.
|
10154
10406
|
#
|
10155
10407
|
# resp = client.put_object({
|
10156
10408
|
# body: "filetoupload",
|
10157
10409
|
# bucket: "examplebucket",
|
10158
10410
|
# key: "exampleobject",
|
10159
|
-
#
|
10160
|
-
#
|
10411
|
+
# metadata: {
|
10412
|
+
# "metadata1" => "value1",
|
10413
|
+
# "metadata2" => "value2",
|
10414
|
+
# },
|
10161
10415
|
# })
|
10162
10416
|
#
|
10163
10417
|
# resp.to_h outputs the following:
|
10164
10418
|
# {
|
10165
10419
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
10166
|
-
#
|
10167
|
-
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
10420
|
+
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
10168
10421
|
# }
|
10169
10422
|
#
|
10170
|
-
# @example Example: To
|
10423
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
10171
10424
|
#
|
10172
|
-
# # The following example
|
10425
|
+
# # The following example uploads and object. The request specifies the optional server-side encryption option. The request
|
10426
|
+
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
10173
10427
|
#
|
10174
10428
|
# resp = client.put_object({
|
10175
10429
|
# body: "filetoupload",
|
10176
10430
|
# bucket: "examplebucket",
|
10177
|
-
# key: "
|
10431
|
+
# key: "exampleobject",
|
10432
|
+
# server_side_encryption: "AES256",
|
10433
|
+
# tagging: "key1=value1&key2=value2",
|
10178
10434
|
# })
|
10179
10435
|
#
|
10180
10436
|
# resp.to_h outputs the following:
|
10181
10437
|
# {
|
10182
10438
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
10183
|
-
#
|
10439
|
+
# server_side_encryption: "AES256",
|
10440
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
10184
10441
|
# }
|
10185
10442
|
#
|
10186
10443
|
# @example Example: To upload an object and specify optional tags
|
@@ -10221,27 +10478,6 @@ module Aws::S3
|
|
10221
10478
|
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
10222
10479
|
# }
|
10223
10480
|
#
|
10224
|
-
# @example Example: To upload object and specify user-defined metadata
|
10225
|
-
#
|
10226
|
-
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
10227
|
-
# # enabled, S3 returns version ID in response.
|
10228
|
-
#
|
10229
|
-
# resp = client.put_object({
|
10230
|
-
# body: "filetoupload",
|
10231
|
-
# bucket: "examplebucket",
|
10232
|
-
# key: "exampleobject",
|
10233
|
-
# metadata: {
|
10234
|
-
# "metadata1" => "value1",
|
10235
|
-
# "metadata2" => "value2",
|
10236
|
-
# },
|
10237
|
-
# })
|
10238
|
-
#
|
10239
|
-
# resp.to_h outputs the following:
|
10240
|
-
# {
|
10241
|
-
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
10242
|
-
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
10243
|
-
# }
|
10244
|
-
#
|
10245
10481
|
# @example Example: To upload an object and specify canned ACL.
|
10246
10482
|
#
|
10247
10483
|
# # The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ
|
@@ -10260,21 +10496,20 @@ module Aws::S3
|
|
10260
10496
|
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
10261
10497
|
# }
|
10262
10498
|
#
|
10263
|
-
# @example Example: To
|
10499
|
+
# @example Example: To create an object.
|
10264
10500
|
#
|
10265
|
-
# # The following example
|
10266
|
-
# # syntax. S3 returns VersionId of the newly created object.
|
10501
|
+
# # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
|
10267
10502
|
#
|
10268
10503
|
# resp = client.put_object({
|
10269
|
-
# body: "
|
10504
|
+
# body: "filetoupload",
|
10270
10505
|
# bucket: "examplebucket",
|
10271
|
-
# key: "
|
10506
|
+
# key: "objectkey",
|
10272
10507
|
# })
|
10273
10508
|
#
|
10274
10509
|
# resp.to_h outputs the following:
|
10275
10510
|
# {
|
10276
10511
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
10277
|
-
# version_id: "
|
10512
|
+
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
10278
10513
|
# }
|
10279
10514
|
#
|
10280
10515
|
# @example Streaming a file from disk
|
@@ -10306,7 +10541,7 @@ module Aws::S3
|
|
10306
10541
|
# "MetadataKey" => "MetadataValue",
|
10307
10542
|
# },
|
10308
10543
|
# server_side_encryption: "AES256", # accepts AES256, aws:kms
|
10309
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
|
10544
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
|
10310
10545
|
# website_redirect_location: "WebsiteRedirectLocation",
|
10311
10546
|
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
10312
10547
|
# sse_customer_key: "SSECustomerKey",
|
@@ -10343,11 +10578,13 @@ module Aws::S3
|
|
10343
10578
|
end
|
10344
10579
|
|
10345
10580
|
# Uses the `acl` subresource to set the access control list (ACL)
|
10346
|
-
# permissions for
|
10347
|
-
#
|
10581
|
+
# permissions for a new or existing object in an S3 bucket. You must
|
10582
|
+
# have `WRITE_ACP` permission to set the ACL of an object. For more
|
10348
10583
|
# information, see [What permissions can I grant?][1] in the *Amazon
|
10349
10584
|
# Simple Storage Service Developer Guide*.
|
10350
10585
|
#
|
10586
|
+
# This action is not supported by Amazon S3 on Outposts.
|
10587
|
+
#
|
10351
10588
|
# Depending on your application needs, you can choose to set the ACL on
|
10352
10589
|
# an object using either the request body or the headers. For example,
|
10353
10590
|
# if you have an existing application that updates a bucket ACL using
|
@@ -10550,6 +10787,28 @@ module Aws::S3
|
|
10550
10787
|
# @option params [required, String] :key
|
10551
10788
|
# Key for which the PUT operation was initiated.
|
10552
10789
|
#
|
10790
|
+
# When using this API with an access point, you must direct requests to
|
10791
|
+
# the access point hostname. The access point hostname takes the form
|
10792
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
10793
|
+
# When using this operation using an access point through the AWS SDKs,
|
10794
|
+
# you provide the access point ARN in place of the bucket name. For more
|
10795
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
10796
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
10797
|
+
#
|
10798
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
10799
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
10800
|
+
# takes the form
|
10801
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
10802
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
10803
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
10804
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
10805
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
10806
|
+
#
|
10807
|
+
#
|
10808
|
+
#
|
10809
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
10810
|
+
# [2]: https://docs.aws.amazon.com/
|
10811
|
+
#
|
10553
10812
|
# @option params [String] :request_payer
|
10554
10813
|
# Confirms that the requester knows that they will be charged for the
|
10555
10814
|
# request. Bucket owners need not specify this parameter in their
|
@@ -10642,6 +10901,8 @@ module Aws::S3
|
|
10642
10901
|
|
10643
10902
|
# Applies a Legal Hold configuration to the specified object.
|
10644
10903
|
#
|
10904
|
+
# This action is not supported by Amazon S3 on Outposts.
|
10905
|
+
#
|
10645
10906
|
# **Related Resources**
|
10646
10907
|
#
|
10647
10908
|
# * [Locking Objects][1]
|
@@ -10816,6 +11077,8 @@ module Aws::S3
|
|
10816
11077
|
|
10817
11078
|
# Places an Object Retention configuration on an object.
|
10818
11079
|
#
|
11080
|
+
# This action is not supported by Amazon S3 on Outposts.
|
11081
|
+
#
|
10819
11082
|
# **Related Resources**
|
10820
11083
|
#
|
10821
11084
|
# * [Locking Objects][1]
|
@@ -10933,17 +11196,13 @@ module Aws::S3
|
|
10933
11196
|
#
|
10934
11197
|
# **Special Errors**
|
10935
11198
|
#
|
10936
|
-
# *
|
10937
|
-
#
|
10938
|
-
# * <i>Code: InvalidTagError </i>
|
11199
|
+
# * * <i>Code: InvalidTagError </i>
|
10939
11200
|
#
|
10940
11201
|
# * *Cause: The tag provided was not a valid tag. This error can occur
|
10941
11202
|
# if the tag did not pass input validation. For more information,
|
10942
11203
|
# see [Object Tagging][3].*
|
10943
11204
|
#
|
10944
|
-
# *
|
10945
|
-
#
|
10946
|
-
# * <i>Code: MalformedXMLError </i>
|
11205
|
+
# * * <i>Code: MalformedXMLError </i>
|
10947
11206
|
#
|
10948
11207
|
# * *Cause: The XML provided does not match the schema.*
|
10949
11208
|
#
|
@@ -10980,9 +11239,19 @@ module Aws::S3
|
|
10980
11239
|
# information about access point ARNs, see [Using Access Points][1] in
|
10981
11240
|
# the *Amazon Simple Storage Service Developer Guide*.
|
10982
11241
|
#
|
11242
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
11243
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
11244
|
+
# takes the form
|
11245
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
11246
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
11247
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
11248
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
11249
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
11250
|
+
#
|
10983
11251
|
#
|
10984
11252
|
#
|
10985
11253
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
11254
|
+
# [2]: https://docs.aws.amazon.com/
|
10986
11255
|
#
|
10987
11256
|
# @option params [required, String] :key
|
10988
11257
|
# Name of the object key.
|
@@ -11148,7 +11417,9 @@ module Aws::S3
|
|
11148
11417
|
|
11149
11418
|
# Restores an archived copy of an object back into Amazon S3
|
11150
11419
|
#
|
11151
|
-
# This
|
11420
|
+
# This action is not supported by Amazon S3 on Outposts.
|
11421
|
+
#
|
11422
|
+
# This action performs the following types of requests:
|
11152
11423
|
#
|
11153
11424
|
# * `select` - Perform a select query on an archived object
|
11154
11425
|
#
|
@@ -11340,9 +11611,7 @@ module Aws::S3
|
|
11340
11611
|
#
|
11341
11612
|
# **Special Errors**
|
11342
11613
|
#
|
11343
|
-
# *
|
11344
|
-
#
|
11345
|
-
# * *Code: RestoreAlreadyInProgress*
|
11614
|
+
# * * *Code: RestoreAlreadyInProgress*
|
11346
11615
|
#
|
11347
11616
|
# * *Cause: Object restore is already in progress. (This error does
|
11348
11617
|
# not apply to SELECT type requests.)*
|
@@ -11351,9 +11620,7 @@ module Aws::S3
|
|
11351
11620
|
#
|
11352
11621
|
# * *SOAP Fault Code Prefix: Client*
|
11353
11622
|
#
|
11354
|
-
# *
|
11355
|
-
#
|
11356
|
-
# * *Code: GlacierExpeditedRetrievalNotAvailable*
|
11623
|
+
# * * *Code: GlacierExpeditedRetrievalNotAvailable*
|
11357
11624
|
#
|
11358
11625
|
# * *Cause: S3 Glacier expedited retrievals are currently not
|
11359
11626
|
# available. Try again later. (Returned if there is insufficient
|
@@ -11401,9 +11668,19 @@ module Aws::S3
|
|
11401
11668
|
# information about access point ARNs, see [Using Access Points][1] in
|
11402
11669
|
# the *Amazon Simple Storage Service Developer Guide*.
|
11403
11670
|
#
|
11671
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
11672
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
11673
|
+
# takes the form
|
11674
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
11675
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
11676
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
11677
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
11678
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
11679
|
+
#
|
11404
11680
|
#
|
11405
11681
|
#
|
11406
11682
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
11683
|
+
# [2]: https://docs.aws.amazon.com/
|
11407
11684
|
#
|
11408
11685
|
# @option params [required, String] :key
|
11409
11686
|
# Object key for which the operation was initiated.
|
@@ -11538,7 +11815,7 @@ module Aws::S3
|
|
11538
11815
|
# value: "MetadataValue",
|
11539
11816
|
# },
|
11540
11817
|
# ],
|
11541
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
|
11818
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
|
11542
11819
|
# },
|
11543
11820
|
# },
|
11544
11821
|
# },
|
@@ -11568,6 +11845,8 @@ module Aws::S3
|
|
11568
11845
|
# returns only records that match the specified SQL expression. You must
|
11569
11846
|
# also specify the data serialization format for the response.
|
11570
11847
|
#
|
11848
|
+
# This action is not supported by Amazon S3 on Outposts.
|
11849
|
+
#
|
11571
11850
|
# For more information about Amazon S3 Select, see [Selecting Content
|
11572
11851
|
# from Objects][1] in the *Amazon Simple Storage Service Developer
|
11573
11852
|
# Guide*.
|
@@ -12044,9 +12323,7 @@ module Aws::S3
|
|
12044
12323
|
#
|
12045
12324
|
# **Special Errors**
|
12046
12325
|
#
|
12047
|
-
# *
|
12048
|
-
#
|
12049
|
-
# * *Code: NoSuchUpload*
|
12326
|
+
# * * *Code: NoSuchUpload*
|
12050
12327
|
#
|
12051
12328
|
# * *Cause: The specified multipart upload does not exist. The upload
|
12052
12329
|
# ID might be invalid, or the multipart upload might have been
|
@@ -12084,7 +12361,29 @@ module Aws::S3
|
|
12084
12361
|
# Object data.
|
12085
12362
|
#
|
12086
12363
|
# @option params [required, String] :bucket
|
12087
|
-
#
|
12364
|
+
# The name of the bucket to which the multipart upload was initiated.
|
12365
|
+
#
|
12366
|
+
# When using this API with an access point, you must direct requests to
|
12367
|
+
# the access point hostname. The access point hostname takes the form
|
12368
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
12369
|
+
# When using this operation using an access point through the AWS SDKs,
|
12370
|
+
# you provide the access point ARN in place of the bucket name. For more
|
12371
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
12372
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
12373
|
+
#
|
12374
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
12375
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
12376
|
+
# takes the form
|
12377
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
12378
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
12379
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
12380
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
12381
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
12382
|
+
#
|
12383
|
+
#
|
12384
|
+
#
|
12385
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
12386
|
+
# [2]: https://docs.aws.amazon.com/
|
12088
12387
|
#
|
12089
12388
|
# @option params [Integer] :content_length
|
12090
12389
|
# Size of the body in bytes. This parameter is useful when the size of
|
@@ -12291,9 +12590,7 @@ module Aws::S3
|
|
12291
12590
|
#
|
12292
12591
|
# **Special Errors**
|
12293
12592
|
#
|
12294
|
-
# *
|
12295
|
-
#
|
12296
|
-
# * *Code: NoSuchUpload*
|
12593
|
+
# * * *Code: NoSuchUpload*
|
12297
12594
|
#
|
12298
12595
|
# * *Cause: The specified multipart upload does not exist. The upload
|
12299
12596
|
# ID might be invalid, or the multipart upload might have been
|
@@ -12301,9 +12598,7 @@ module Aws::S3
|
|
12301
12598
|
#
|
12302
12599
|
# * *HTTP Status Code: 404 Not Found*
|
12303
12600
|
#
|
12304
|
-
# *
|
12305
|
-
#
|
12306
|
-
# * *Code: InvalidRequest*
|
12601
|
+
# * * *Code: InvalidRequest*
|
12307
12602
|
#
|
12308
12603
|
# * *Cause: The specified copy source is not supported as a byte-range
|
12309
12604
|
# copy source.*
|
@@ -12341,6 +12636,28 @@ module Aws::S3
|
|
12341
12636
|
# @option params [required, String] :bucket
|
12342
12637
|
# The bucket name.
|
12343
12638
|
#
|
12639
|
+
# When using this API with an access point, you must direct requests to
|
12640
|
+
# the access point hostname. The access point hostname takes the form
|
12641
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
12642
|
+
# When using this operation using an access point through the AWS SDKs,
|
12643
|
+
# you provide the access point ARN in place of the bucket name. For more
|
12644
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
12645
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
12646
|
+
#
|
12647
|
+
# When using this API with Amazon S3 on Outposts, you must direct
|
12648
|
+
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
12649
|
+
# takes the form
|
12650
|
+
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
12651
|
+
# When using this operation using S3 on Outposts through the AWS SDKs,
|
12652
|
+
# you provide the Outposts bucket ARN in place of the bucket name. For
|
12653
|
+
# more information about S3 on Outposts ARNs, see [Using S3 on
|
12654
|
+
# Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
|
12655
|
+
#
|
12656
|
+
#
|
12657
|
+
#
|
12658
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
12659
|
+
# [2]: https://docs.aws.amazon.com/
|
12660
|
+
#
|
12344
12661
|
# @option params [required, String] :copy_source
|
12345
12662
|
# Specifies the source object for the copy operation. You specify the
|
12346
12663
|
# value in one of two formats, depending on whether you want to access
|
@@ -12357,9 +12674,9 @@ module Aws::S3
|
|
12357
12674
|
# Resource Name (ARN) of the object as accessed through the access
|
12358
12675
|
# point, in the format
|
12359
12676
|
# `arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>`.
|
12360
|
-
# For example, to copy the object `reports/january.pdf` through
|
12361
|
-
#
|
12362
|
-
#
|
12677
|
+
# For example, to copy the object `reports/january.pdf` through access
|
12678
|
+
# point `my-access-point` owned by account `123456789012` in Region
|
12679
|
+
# `us-west-2`, use the URL encoding of
|
12363
12680
|
# `arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf`.
|
12364
12681
|
# The value must be URL encoded.
|
12365
12682
|
#
|
@@ -12368,6 +12685,15 @@ module Aws::S3
|
|
12368
12685
|
#
|
12369
12686
|
# </note>
|
12370
12687
|
#
|
12688
|
+
# Alternatively, for objects accessed through Amazon S3 on Outposts,
|
12689
|
+
# specify the ARN of the object as accessed in the format
|
12690
|
+
# `arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>`.
|
12691
|
+
# For example, to copy the object `reports/january.pdf` through
|
12692
|
+
# outpost `my-outpost` owned by account `123456789012` in Region
|
12693
|
+
# `us-west-2`, use the URL encoding of
|
12694
|
+
# `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf`.
|
12695
|
+
# The value must be URL encoded.
|
12696
|
+
#
|
12371
12697
|
# To copy a specific version of an object, append
|
12372
12698
|
# `?versionId=<version-id>` to the value (for example,
|
12373
12699
|
# `awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893`).
|
@@ -12572,7 +12898,7 @@ module Aws::S3
|
|
12572
12898
|
params: params,
|
12573
12899
|
config: config)
|
12574
12900
|
context[:gem_name] = 'aws-sdk-s3'
|
12575
|
-
context[:gem_version] = '1.
|
12901
|
+
context[:gem_version] = '1.82.0'
|
12576
12902
|
Seahorse::Client::Request.new(handlers, context)
|
12577
12903
|
end
|
12578
12904
|
|