aws-sdk-s3 1.57.0 → 1.58.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/lib/aws-sdk-s3.rb +1 -1
- data/lib/aws-sdk-s3/bucket.rb +39 -29
- data/lib/aws-sdk-s3/bucket_acl.rb +1 -0
- data/lib/aws-sdk-s3/bucket_cors.rb +3 -2
- data/lib/aws-sdk-s3/bucket_lifecycle.rb +1 -0
- data/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb +1 -0
- data/lib/aws-sdk-s3/bucket_logging.rb +1 -0
- data/lib/aws-sdk-s3/bucket_notification.rb +1 -0
- data/lib/aws-sdk-s3/bucket_policy.rb +1 -0
- data/lib/aws-sdk-s3/bucket_request_payment.rb +1 -0
- data/lib/aws-sdk-s3/bucket_tagging.rb +2 -1
- data/lib/aws-sdk-s3/bucket_versioning.rb +1 -0
- data/lib/aws-sdk-s3/bucket_website.rb +1 -0
- data/lib/aws-sdk-s3/client.rb +882 -581
- data/lib/aws-sdk-s3/customizations/bucket.rb +41 -14
- data/lib/aws-sdk-s3/multipart_upload.rb +22 -9
- data/lib/aws-sdk-s3/multipart_upload_part.rb +34 -25
- data/lib/aws-sdk-s3/object.rb +156 -115
- data/lib/aws-sdk-s3/object_acl.rb +9 -4
- data/lib/aws-sdk-s3/object_summary.rb +126 -86
- data/lib/aws-sdk-s3/object_version.rb +56 -39
- data/lib/aws-sdk-s3/plugins/bucket_arn.rb +212 -0
- data/lib/aws-sdk-s3/plugins/bucket_dns.rb +7 -7
- data/lib/aws-sdk-s3/plugins/bucket_name_restrictions.rb +23 -3
- data/lib/aws-sdk-s3/types.rb +792 -410
- metadata +3 -2
@@ -0,0 +1,212 @@
|
|
1
|
+
module Aws
|
2
|
+
module S3
|
3
|
+
module Plugins
|
4
|
+
# When an accesspoint ARN is provided for :bucket in S3 operations, this
|
5
|
+
# plugin resolves the request endpoint from the ARN when possible.
|
6
|
+
class BucketARN < Seahorse::Client::Plugin
|
7
|
+
option(
|
8
|
+
:s3_use_arn_region,
|
9
|
+
default: true,
|
10
|
+
doc_type: 'Boolean',
|
11
|
+
docstring: <<-DOCS) do |cfg|
|
12
|
+
By default, the SDK will use the S3 ARN region, and cross-region
|
13
|
+
requests could be made. Set to `false` to not use the region from
|
14
|
+
the S3 ARN.
|
15
|
+
DOCS
|
16
|
+
resolve_s3_use_arn_region(cfg)
|
17
|
+
end
|
18
|
+
|
19
|
+
def add_handlers(handlers, _config)
|
20
|
+
handlers.add(Handler)
|
21
|
+
end
|
22
|
+
|
23
|
+
# @api private
|
24
|
+
class Handler < Seahorse::Client::Handler
|
25
|
+
def call(context)
|
26
|
+
bucket_member = _bucket_member(context.operation.input.shape)
|
27
|
+
if bucket_member && (bucket = context.params[bucket_member])
|
28
|
+
_resolved_bucket, resolved_region, arn = BucketARN.resolve_arn!(
|
29
|
+
bucket,
|
30
|
+
context.config.region,
|
31
|
+
context.config.s3_use_arn_region
|
32
|
+
)
|
33
|
+
if arn
|
34
|
+
if arn.resource.start_with?('accesspoint')
|
35
|
+
validate_config!(context.config)
|
36
|
+
context.config.region = resolved_region
|
37
|
+
end
|
38
|
+
|
39
|
+
dualstack = extract_dualstack_config!(context)
|
40
|
+
|
41
|
+
BucketARN.resolve_url!(
|
42
|
+
context.http_request.endpoint,
|
43
|
+
arn,
|
44
|
+
dualstack
|
45
|
+
)
|
46
|
+
end
|
47
|
+
end
|
48
|
+
@handler.call(context)
|
49
|
+
end
|
50
|
+
|
51
|
+
private
|
52
|
+
|
53
|
+
def _bucket_member(input)
|
54
|
+
input.members.each do |member, ref|
|
55
|
+
return member if ref.shape.name == 'BucketName'
|
56
|
+
end
|
57
|
+
nil
|
58
|
+
end
|
59
|
+
|
60
|
+
# other plugins use dualstack so disable it when we're done
|
61
|
+
def extract_dualstack_config!(context)
|
62
|
+
dualstack = context[:use_dualstack_endpoint]
|
63
|
+
context[:use_dualstack_endpoint] = false if dualstack
|
64
|
+
dualstack
|
65
|
+
end
|
66
|
+
|
67
|
+
def validate_config!(config)
|
68
|
+
unless config.regional_endpoint
|
69
|
+
raise ArgumentError,
|
70
|
+
'Cannot provide both an accesspoint ARN and :endpoint.'
|
71
|
+
end
|
72
|
+
|
73
|
+
if config.use_accelerate_endpoint
|
74
|
+
raise ArgumentError,
|
75
|
+
'Cannot provide both an accesspoint ARN and setting '\
|
76
|
+
':use_accelerate_endpoint to true.'
|
77
|
+
end
|
78
|
+
|
79
|
+
if config.force_path_style
|
80
|
+
raise ArgumentError,
|
81
|
+
'Cannot provide both an accesspoint ARN and setting '\
|
82
|
+
':force_path_style to true.'
|
83
|
+
end
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
class << self
|
88
|
+
|
89
|
+
# @api private
|
90
|
+
def resolve_arn!(bucket_name, region, s3_use_arn_region)
|
91
|
+
if Aws::ARNParser.arn?(bucket_name)
|
92
|
+
arn = Aws::ARNParser.parse(bucket_name)
|
93
|
+
validate_s3_arn!(arn)
|
94
|
+
validate_region!(arn, region, s3_use_arn_region)
|
95
|
+
if arn.resource.start_with?('accesspoint')
|
96
|
+
region = arn.region if s3_use_arn_region
|
97
|
+
[bucket_name, region, arn]
|
98
|
+
else
|
99
|
+
raise ArgumentError,
|
100
|
+
'Only accesspoint type ARNs are currently supported.'
|
101
|
+
end
|
102
|
+
else
|
103
|
+
[bucket_name, region]
|
104
|
+
end
|
105
|
+
end
|
106
|
+
|
107
|
+
# @api private
|
108
|
+
def resolve_url!(url, arn, dualstack = false)
|
109
|
+
if arn.resource.start_with?('accesspoint')
|
110
|
+
url.host = accesspoint_arn_host(arn, dualstack)
|
111
|
+
else
|
112
|
+
raise ArgumentError,
|
113
|
+
'Only accesspoint type ARNs are currently supported.'
|
114
|
+
end
|
115
|
+
url.path = url_path(url.path, arn)
|
116
|
+
url
|
117
|
+
end
|
118
|
+
|
119
|
+
private
|
120
|
+
|
121
|
+
def accesspoint_arn_host(arn, dualstack)
|
122
|
+
_resource_type, resource_name = parse_resource(arn.resource)
|
123
|
+
accesspoint = "#{resource_name}-#{arn.account_id}"
|
124
|
+
accesspoint << '.s3-accesspoint'
|
125
|
+
accesspoint << '.dualstack' if dualstack
|
126
|
+
sfx = Aws::Partitions::EndpointProvider.dns_suffix_for(arn.region)
|
127
|
+
accesspoint << ".#{arn.region}.#{sfx}"
|
128
|
+
accesspoint
|
129
|
+
end
|
130
|
+
|
131
|
+
def parse_resource(str)
|
132
|
+
slash = str.index('/') || str.length
|
133
|
+
colon = str.index(':') || str.length
|
134
|
+
delimiter = slash < colon ? slash : colon
|
135
|
+
if delimiter < str.length
|
136
|
+
[str[0..(delimiter - 1)], str[(delimiter + 1)..-1]]
|
137
|
+
else
|
138
|
+
[nil, str]
|
139
|
+
end
|
140
|
+
end
|
141
|
+
|
142
|
+
def resolve_s3_use_arn_region(cfg)
|
143
|
+
value = ENV['AWS_S3_USE_ARN_REGION'] ||
|
144
|
+
Aws.shared_config.s3_use_arn_region(profile: cfg.profile) ||
|
145
|
+
'true'
|
146
|
+
|
147
|
+
# Raise if provided value is not true or false
|
148
|
+
if value != 'true' && value != 'false'
|
149
|
+
raise ArgumentError,
|
150
|
+
'Must provide either `true` or `false` for '\
|
151
|
+
's3_use_arn_region profile option or for '\
|
152
|
+
'ENV[\'AWS_S3_USE_ARN_REGION\']'
|
153
|
+
end
|
154
|
+
|
155
|
+
value == 'true'
|
156
|
+
end
|
157
|
+
|
158
|
+
def url_path(path, arn)
|
159
|
+
path = path.sub("/#{Seahorse::Util.uri_escape(arn.to_s)}", '')
|
160
|
+
.sub("/#{arn}", '')
|
161
|
+
"/#{path}" unless path.match(/^\//)
|
162
|
+
path
|
163
|
+
end
|
164
|
+
|
165
|
+
def validate_s3_arn!(arn)
|
166
|
+
_resource_type, resource_name = parse_resource(arn.resource)
|
167
|
+
|
168
|
+
unless arn.service == 's3'
|
169
|
+
raise ArgumentError, 'Must provide an S3 ARN.'
|
170
|
+
end
|
171
|
+
|
172
|
+
if arn.region.empty? || arn.account_id.empty?
|
173
|
+
raise ArgumentError,
|
174
|
+
'S3 Access Point ARNs must contain both a valid region '\
|
175
|
+
' and a valid account id.'
|
176
|
+
end
|
177
|
+
|
178
|
+
if resource_name.include?(':') || resource_name.include?('/')
|
179
|
+
raise ArgumentError,
|
180
|
+
'ARN resource id must be a single value.'
|
181
|
+
end
|
182
|
+
|
183
|
+
unless Plugins::BucketDns.valid_subdomain?(
|
184
|
+
"#{resource_name}-#{arn.account_id}"
|
185
|
+
)
|
186
|
+
raise ArgumentError,
|
187
|
+
"#{resource_name}-#{arn.account_id} is not a "\
|
188
|
+
'valid subdomain.'
|
189
|
+
end
|
190
|
+
end
|
191
|
+
|
192
|
+
def validate_region!(arn, region, s3_use_arn_region)
|
193
|
+
if region.include?('fips')
|
194
|
+
raise ArgumentError,
|
195
|
+
'FIPS client regions are currently not supported with '\
|
196
|
+
'accesspoint ARNs.'
|
197
|
+
end
|
198
|
+
|
199
|
+
if s3_use_arn_region &&
|
200
|
+
!Aws::Partitions.partition(arn.partition).region?(region)
|
201
|
+
raise Aws::Errors::InvalidARNPartitionError
|
202
|
+
end
|
203
|
+
|
204
|
+
if !s3_use_arn_region && region != arn.region
|
205
|
+
raise Aws::Errors::InvalidARNRegionError
|
206
|
+
end
|
207
|
+
end
|
208
|
+
end
|
209
|
+
end
|
210
|
+
end
|
211
|
+
end
|
212
|
+
end
|
@@ -38,11 +38,9 @@ request URI and never moved to the host as a sub-domain.
|
|
38
38
|
def move_dns_compat_bucket_to_subdomain(context)
|
39
39
|
bucket_name = context.params[:bucket]
|
40
40
|
endpoint = context.http_request.endpoint
|
41
|
-
if
|
42
|
-
|
43
|
-
|
44
|
-
context.operation_name.to_s != 'get_bucket_location'
|
45
|
-
then
|
41
|
+
if bucket_name &&
|
42
|
+
BucketDns.dns_compatible?(bucket_name, https?(endpoint)) &&
|
43
|
+
context.operation_name.to_s != 'get_bucket_location'
|
46
44
|
move_bucket_to_subdomain(bucket_name, endpoint)
|
47
45
|
end
|
48
46
|
end
|
@@ -73,8 +71,10 @@ request URI and never moved to the host as a sub-domain.
|
|
73
71
|
end
|
74
72
|
end
|
75
73
|
|
76
|
-
|
77
|
-
|
74
|
+
# Checks for a valid RFC-3986 host name
|
75
|
+
# @see https://tools.ietf.org/html/rfc3986#section-3.2.2
|
76
|
+
# @param [String] bucket_name
|
77
|
+
# @return [Boolean]
|
78
78
|
def valid_subdomain?(bucket_name)
|
79
79
|
bucket_name.size < 64 &&
|
80
80
|
bucket_name =~ /^[a-z0-9][a-z0-9.-]+[a-z0-9]$/ &&
|
@@ -5,14 +5,34 @@ module Aws
|
|
5
5
|
class BucketNameRestrictions < Seahorse::Client::Plugin
|
6
6
|
class Handler < Seahorse::Client::Handler
|
7
7
|
|
8
|
+
# Useful because Aws::S3::Errors::SignatureDoesNotMatch is thrown
|
9
|
+
# when passed a bucket with a forward slash. Instead provide a more
|
10
|
+
# helpful error. Ideally should not be a plugin?
|
8
11
|
def call(context)
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
+
bucket_member = _bucket_member(context.operation.input.shape)
|
13
|
+
if bucket_member && (bucket = context.params[bucket_member])
|
14
|
+
_resolved_bucket, _resolved_region, arn = BucketARN.resolve_arn!(
|
15
|
+
bucket,
|
16
|
+
context.config.region,
|
17
|
+
context.config.s3_use_arn_region
|
18
|
+
)
|
19
|
+
if !arn && bucket.include?('/')
|
20
|
+
raise ArgumentError,
|
21
|
+
'bucket name must not contain a forward-slash (/)'
|
22
|
+
end
|
12
23
|
end
|
13
24
|
@handler.call(context)
|
14
25
|
end
|
15
26
|
|
27
|
+
private
|
28
|
+
|
29
|
+
def _bucket_member(input)
|
30
|
+
input.members.each do |member, ref|
|
31
|
+
return member if ref.shape.name == 'BucketName'
|
32
|
+
end
|
33
|
+
nil
|
34
|
+
end
|
35
|
+
|
16
36
|
end
|
17
37
|
|
18
38
|
handler(Handler)
|
data/lib/aws-sdk-s3/types.rb
CHANGED
@@ -60,7 +60,20 @@ module Aws::S3
|
|
60
60
|
# }
|
61
61
|
#
|
62
62
|
# @!attribute [rw] bucket
|
63
|
-
# The bucket to which the upload was taking place.
|
63
|
+
# The bucket name to which the upload was taking place.
|
64
|
+
#
|
65
|
+
# When using this API with an access point, you must direct requests
|
66
|
+
# to the access point hostname. The access point hostname takes the
|
67
|
+
# form
|
68
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
69
|
+
# When using this operation using an access point through the AWS
|
70
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
71
|
+
# For more information about access point ARNs, see [Using Access
|
72
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
73
|
+
#
|
74
|
+
#
|
75
|
+
#
|
76
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
64
77
|
# @return [String]
|
65
78
|
#
|
66
79
|
# @!attribute [rw] key
|
@@ -74,9 +87,13 @@ module Aws::S3
|
|
74
87
|
# @!attribute [rw] request_payer
|
75
88
|
# Confirms that the requester knows that she or he will be charged for
|
76
89
|
# the request. Bucket owners need not specify this parameter in their
|
77
|
-
# requests.
|
78
|
-
# buckets
|
79
|
-
#
|
90
|
+
# requests. For information about downloading objects from Requester
|
91
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
92
|
+
# in the *Amazon S3 Developer Guide*.
|
93
|
+
#
|
94
|
+
#
|
95
|
+
#
|
96
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
80
97
|
# @return [String]
|
81
98
|
#
|
82
99
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AbortMultipartUploadRequest AWS API Documentation
|
@@ -618,7 +635,7 @@ module Aws::S3
|
|
618
635
|
include Aws::Structure
|
619
636
|
end
|
620
637
|
|
621
|
-
# Describes how
|
638
|
+
# Describes how an uncompressed comma-separated values (CSV)-formatted
|
622
639
|
# input object is formatted.
|
623
640
|
#
|
624
641
|
# @note When making an API call, you may pass CSVInput
|
@@ -791,7 +808,7 @@ module Aws::S3
|
|
791
808
|
# @return [String]
|
792
809
|
#
|
793
810
|
# @!attribute [rw] invocation_role
|
794
|
-
# The role supporting the invocation of the
|
811
|
+
# The role supporting the invocation of the Lambda function
|
795
812
|
# @return [String]
|
796
813
|
#
|
797
814
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CloudFunctionConfiguration AWS API Documentation
|
@@ -864,8 +881,8 @@ module Aws::S3
|
|
864
881
|
# @return [String]
|
865
882
|
#
|
866
883
|
# @!attribute [rw] ssekms_key_id
|
867
|
-
# If present, specifies the ID of the AWS Key Management Service (
|
868
|
-
# customer master key (CMK) that was used for the object.
|
884
|
+
# If present, specifies the ID of the AWS Key Management Service (AWS
|
885
|
+
# KMS) customer master key (CMK) that was used for the object.
|
869
886
|
# @return [String]
|
870
887
|
#
|
871
888
|
# @!attribute [rw] request_charged
|
@@ -925,9 +942,13 @@ module Aws::S3
|
|
925
942
|
# @!attribute [rw] request_payer
|
926
943
|
# Confirms that the requester knows that she or he will be charged for
|
927
944
|
# the request. Bucket owners need not specify this parameter in their
|
928
|
-
# requests.
|
929
|
-
# buckets
|
930
|
-
#
|
945
|
+
# requests. For information about downloading objects from Requester
|
946
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
947
|
+
# in the *Amazon S3 Developer Guide*.
|
948
|
+
#
|
949
|
+
#
|
950
|
+
#
|
951
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
931
952
|
# @return [String]
|
932
953
|
#
|
933
954
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CompleteMultipartUploadRequest AWS API Documentation
|
@@ -1021,7 +1042,7 @@ module Aws::S3
|
|
1021
1042
|
# example, to redirect requests for `ExamplePage.html`, the key prefix
|
1022
1043
|
# will be `ExamplePage.html`. To redirect request for all pages with
|
1023
1044
|
# the prefix `docs/`, the key prefix will be `/docs`, which identifies
|
1024
|
-
# all objects in the docs
|
1045
|
+
# all objects in the `docs/` folder. Required when the parent element
|
1025
1046
|
# `Condition` is specified and sibling `HttpErrorCodeReturnedEquals`
|
1026
1047
|
# is not specified. If both conditions are specified, both must be
|
1027
1048
|
# true for the redirect to be applied.
|
@@ -1060,8 +1081,8 @@ module Aws::S3
|
|
1060
1081
|
# @return [String]
|
1061
1082
|
#
|
1062
1083
|
# @!attribute [rw] server_side_encryption
|
1063
|
-
# The
|
1064
|
-
# in S3 (
|
1084
|
+
# The server-side encryption algorithm used when storing this object
|
1085
|
+
# in Amazon S3 (for example, AES256, aws:kms).
|
1065
1086
|
# @return [String]
|
1066
1087
|
#
|
1067
1088
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -1073,13 +1094,13 @@ module Aws::S3
|
|
1073
1094
|
# @!attribute [rw] sse_customer_key_md5
|
1074
1095
|
# If server-side encryption with a customer-provided encryption key
|
1075
1096
|
# was requested, the response will include this header to provide
|
1076
|
-
# round
|
1097
|
+
# round-trip message integrity verification of the customer-provided
|
1077
1098
|
# encryption key.
|
1078
1099
|
# @return [String]
|
1079
1100
|
#
|
1080
1101
|
# @!attribute [rw] ssekms_key_id
|
1081
|
-
# If present, specifies the ID of the AWS Key Management Service (
|
1082
|
-
# customer master key (CMK) that was used for the object.
|
1102
|
+
# If present, specifies the ID of the AWS Key Management Service (AWS
|
1103
|
+
# KMS) customer master key (CMK) that was used for the object.
|
1083
1104
|
# @return [String]
|
1084
1105
|
#
|
1085
1106
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -1249,8 +1270,8 @@ module Aws::S3
|
|
1249
1270
|
# @return [String]
|
1250
1271
|
#
|
1251
1272
|
# @!attribute [rw] server_side_encryption
|
1252
|
-
# The
|
1253
|
-
# in S3 (
|
1273
|
+
# The server-side encryption algorithm used when storing this object
|
1274
|
+
# in Amazon S3 (for example, AES256, aws:kms).
|
1254
1275
|
# @return [String]
|
1255
1276
|
#
|
1256
1277
|
# @!attribute [rw] storage_class
|
@@ -1265,30 +1286,35 @@ module Aws::S3
|
|
1265
1286
|
# @return [String]
|
1266
1287
|
#
|
1267
1288
|
# @!attribute [rw] sse_customer_algorithm
|
1268
|
-
# Specifies the algorithm to use to when encrypting the object (
|
1269
|
-
# AES256).
|
1289
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
1290
|
+
# example, AES256).
|
1270
1291
|
# @return [String]
|
1271
1292
|
#
|
1272
1293
|
# @!attribute [rw] sse_customer_key
|
1273
1294
|
# Specifies the customer-provided encryption key for Amazon S3 to use
|
1274
1295
|
# in encrypting data. This value is used to store the object and then
|
1275
|
-
# it is discarded; Amazon does not store the encryption key. The
|
1276
|
-
# must be appropriate for use with the algorithm specified in the
|
1277
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
1296
|
+
# it is discarded; Amazon S3 does not store the encryption key. The
|
1297
|
+
# key must be appropriate for use with the algorithm specified in the
|
1298
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
1278
1299
|
# @return [String]
|
1279
1300
|
#
|
1280
1301
|
# @!attribute [rw] sse_customer_key_md5
|
1281
1302
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
1282
1303
|
# RFC 1321. Amazon S3 uses this header for a message integrity check
|
1283
|
-
# to ensure the encryption key was transmitted without error.
|
1304
|
+
# to ensure that the encryption key was transmitted without error.
|
1284
1305
|
# @return [String]
|
1285
1306
|
#
|
1286
1307
|
# @!attribute [rw] ssekms_key_id
|
1287
1308
|
# Specifies the AWS KMS key ID to use for object encryption. All GET
|
1288
1309
|
# and PUT requests for an object protected by AWS KMS will fail if not
|
1289
|
-
# made via SSL or using SigV4.
|
1290
|
-
# officially supported AWS SDKs and CLI
|
1291
|
-
#
|
1310
|
+
# made via SSL or using SigV4. For information about configuring using
|
1311
|
+
# any of the officially supported AWS SDKs and AWS CLI, see
|
1312
|
+
# [Specifying the Signature Version in Request Authentication][1] in
|
1313
|
+
# the *Amazon S3 Developer Guide*.
|
1314
|
+
#
|
1315
|
+
#
|
1316
|
+
#
|
1317
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
|
1292
1318
|
# @return [String]
|
1293
1319
|
#
|
1294
1320
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -1299,7 +1325,7 @@ module Aws::S3
|
|
1299
1325
|
#
|
1300
1326
|
# @!attribute [rw] copy_source_sse_customer_algorithm
|
1301
1327
|
# Specifies the algorithm to use when decrypting the source object
|
1302
|
-
# (
|
1328
|
+
# (for example, AES256).
|
1303
1329
|
# @return [String]
|
1304
1330
|
#
|
1305
1331
|
# @!attribute [rw] copy_source_sse_customer_key
|
@@ -1311,21 +1337,25 @@ module Aws::S3
|
|
1311
1337
|
# @!attribute [rw] copy_source_sse_customer_key_md5
|
1312
1338
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
1313
1339
|
# RFC 1321. Amazon S3 uses this header for a message integrity check
|
1314
|
-
# to ensure the encryption key was transmitted without error.
|
1340
|
+
# to ensure that the encryption key was transmitted without error.
|
1315
1341
|
# @return [String]
|
1316
1342
|
#
|
1317
1343
|
# @!attribute [rw] request_payer
|
1318
1344
|
# Confirms that the requester knows that she or he will be charged for
|
1319
1345
|
# the request. Bucket owners need not specify this parameter in their
|
1320
|
-
# requests.
|
1321
|
-
# buckets
|
1322
|
-
#
|
1346
|
+
# requests. For information about downloading objects from Requester
|
1347
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
1348
|
+
# in the *Amazon S3 Developer Guide*.
|
1349
|
+
#
|
1350
|
+
#
|
1351
|
+
#
|
1352
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
1323
1353
|
# @return [String]
|
1324
1354
|
#
|
1325
1355
|
# @!attribute [rw] tagging
|
1326
1356
|
# The tag-set for the object destination object this value must be
|
1327
|
-
# used in conjunction with the TaggingDirective
|
1328
|
-
# encoded as URL Query parameters
|
1357
|
+
# used in conjunction with the `TaggingDirective`. The tag-set must be
|
1358
|
+
# encoded as URL Query parameters.
|
1329
1359
|
# @return [String]
|
1330
1360
|
#
|
1331
1361
|
# @!attribute [rw] object_lock_mode
|
@@ -1385,7 +1415,7 @@ module Aws::S3
|
|
1385
1415
|
include Aws::Structure
|
1386
1416
|
end
|
1387
1417
|
|
1388
|
-
#
|
1418
|
+
# Container for all response elements.
|
1389
1419
|
#
|
1390
1420
|
# @!attribute [rw] etag
|
1391
1421
|
# Returns the ETag of the new object. The ETag reflects only changes
|
@@ -1433,8 +1463,8 @@ module Aws::S3
|
|
1433
1463
|
# }
|
1434
1464
|
#
|
1435
1465
|
# @!attribute [rw] location_constraint
|
1436
|
-
# Specifies the
|
1437
|
-
# specify a
|
1466
|
+
# Specifies the Region where the bucket will be created. If you don't
|
1467
|
+
# specify a Region, the bucket is created in the US East (N. Virginia)
|
1438
1468
|
# Region (us-east-1).
|
1439
1469
|
# @return [String]
|
1440
1470
|
#
|
@@ -1446,8 +1476,8 @@ module Aws::S3
|
|
1446
1476
|
end
|
1447
1477
|
|
1448
1478
|
# @!attribute [rw] location
|
1449
|
-
# Specifies the
|
1450
|
-
# creating a bucket on the US East (N. Virginia)
|
1479
|
+
# Specifies the Region where the bucket will be created. If you are
|
1480
|
+
# creating a bucket on the US East (N. Virginia) Region (us-east-1),
|
1451
1481
|
# you do not need to specify the location.
|
1452
1482
|
# @return [String]
|
1453
1483
|
#
|
@@ -1538,7 +1568,7 @@ module Aws::S3
|
|
1538
1568
|
# information, see [ Aborting Incomplete Multipart Uploads Using a
|
1539
1569
|
# Bucket Lifecycle Policy][1].
|
1540
1570
|
#
|
1541
|
-
# The response also includes the x-amz-abort-rule-id header that
|
1571
|
+
# The response also includes the `x-amz-abort-rule-id` header that
|
1542
1572
|
# provides the ID of the lifecycle configuration rule that defines
|
1543
1573
|
# this action.
|
1544
1574
|
#
|
@@ -1548,13 +1578,26 @@ module Aws::S3
|
|
1548
1578
|
# @return [Time]
|
1549
1579
|
#
|
1550
1580
|
# @!attribute [rw] abort_rule_id
|
1551
|
-
# This header is returned along with the x-amz-abort-date header. It
|
1581
|
+
# This header is returned along with the `x-amz-abort-date` header. It
|
1552
1582
|
# identifies the applicable lifecycle configuration rule that defines
|
1553
1583
|
# the action to abort incomplete multipart uploads.
|
1554
1584
|
# @return [String]
|
1555
1585
|
#
|
1556
1586
|
# @!attribute [rw] bucket
|
1557
1587
|
# Name of the bucket to which the multipart upload was initiated.
|
1588
|
+
#
|
1589
|
+
# When using this API with an access point, you must direct requests
|
1590
|
+
# to the access point hostname. The access point hostname takes the
|
1591
|
+
# form
|
1592
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
1593
|
+
# When using this operation using an access point through the AWS
|
1594
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
1595
|
+
# For more information about access point ARNs, see [Using Access
|
1596
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
1597
|
+
#
|
1598
|
+
#
|
1599
|
+
#
|
1600
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
1558
1601
|
# @return [String]
|
1559
1602
|
#
|
1560
1603
|
# @!attribute [rw] key
|
@@ -1566,8 +1609,8 @@ module Aws::S3
|
|
1566
1609
|
# @return [String]
|
1567
1610
|
#
|
1568
1611
|
# @!attribute [rw] server_side_encryption
|
1569
|
-
# The
|
1570
|
-
# in S3 (
|
1612
|
+
# The server-side encryption algorithm used when storing this object
|
1613
|
+
# in Amazon S3 (for example, AES256, aws:kms).
|
1571
1614
|
# @return [String]
|
1572
1615
|
#
|
1573
1616
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -1579,13 +1622,13 @@ module Aws::S3
|
|
1579
1622
|
# @!attribute [rw] sse_customer_key_md5
|
1580
1623
|
# If server-side encryption with a customer-provided encryption key
|
1581
1624
|
# was requested, the response will include this header to provide
|
1582
|
-
# round
|
1625
|
+
# round-trip message integrity verification of the customer-provided
|
1583
1626
|
# encryption key.
|
1584
1627
|
# @return [String]
|
1585
1628
|
#
|
1586
1629
|
# @!attribute [rw] ssekms_key_id
|
1587
|
-
# If present, specifies the ID of the AWS Key Management Service (
|
1588
|
-
# customer master key (CMK) that was used for the object.
|
1630
|
+
# If present, specifies the ID of the AWS Key Management Service (AWS
|
1631
|
+
# KMS) customer master key (CMK) that was used for the object.
|
1589
1632
|
# @return [String]
|
1590
1633
|
#
|
1591
1634
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -1712,8 +1755,8 @@ module Aws::S3
|
|
1712
1755
|
# @return [Hash<String,String>]
|
1713
1756
|
#
|
1714
1757
|
# @!attribute [rw] server_side_encryption
|
1715
|
-
# The
|
1716
|
-
# in S3 (
|
1758
|
+
# The server-side encryption algorithm used when storing this object
|
1759
|
+
# in Amazon S3 (for example, AES256, aws:kms).
|
1717
1760
|
# @return [String]
|
1718
1761
|
#
|
1719
1762
|
# @!attribute [rw] storage_class
|
@@ -1728,30 +1771,35 @@ module Aws::S3
|
|
1728
1771
|
# @return [String]
|
1729
1772
|
#
|
1730
1773
|
# @!attribute [rw] sse_customer_algorithm
|
1731
|
-
# Specifies the algorithm to use to when encrypting the object (
|
1732
|
-
# AES256).
|
1774
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
1775
|
+
# example, AES256).
|
1733
1776
|
# @return [String]
|
1734
1777
|
#
|
1735
1778
|
# @!attribute [rw] sse_customer_key
|
1736
1779
|
# Specifies the customer-provided encryption key for Amazon S3 to use
|
1737
1780
|
# in encrypting data. This value is used to store the object and then
|
1738
|
-
# it is discarded; Amazon does not store the encryption key. The
|
1739
|
-
# must be appropriate for use with the algorithm specified in the
|
1740
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
1781
|
+
# it is discarded; Amazon S3 does not store the encryption key. The
|
1782
|
+
# key must be appropriate for use with the algorithm specified in the
|
1783
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
1741
1784
|
# @return [String]
|
1742
1785
|
#
|
1743
1786
|
# @!attribute [rw] sse_customer_key_md5
|
1744
1787
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
1745
1788
|
# RFC 1321. Amazon S3 uses this header for a message integrity check
|
1746
|
-
# to ensure the encryption key was transmitted without error.
|
1789
|
+
# to ensure that the encryption key was transmitted without error.
|
1747
1790
|
# @return [String]
|
1748
1791
|
#
|
1749
1792
|
# @!attribute [rw] ssekms_key_id
|
1750
1793
|
# Specifies the AWS KMS key ID to use for object encryption. All GET
|
1751
1794
|
# and PUT requests for an object protected by AWS KMS will fail if not
|
1752
|
-
# made via SSL or using SigV4.
|
1753
|
-
# officially supported AWS SDKs and CLI
|
1754
|
-
#
|
1795
|
+
# made via SSL or using SigV4. For information about configuring using
|
1796
|
+
# any of the officially supported AWS SDKs and AWS CLI, see
|
1797
|
+
# [Specifying the Signature Version in Request Authentication][1] in
|
1798
|
+
# the *Amazon S3 Developer Guide*.
|
1799
|
+
#
|
1800
|
+
#
|
1801
|
+
#
|
1802
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
|
1755
1803
|
# @return [String]
|
1756
1804
|
#
|
1757
1805
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -1763,14 +1811,18 @@ module Aws::S3
|
|
1763
1811
|
# @!attribute [rw] request_payer
|
1764
1812
|
# Confirms that the requester knows that she or he will be charged for
|
1765
1813
|
# the request. Bucket owners need not specify this parameter in their
|
1766
|
-
# requests.
|
1767
|
-
# buckets
|
1768
|
-
#
|
1814
|
+
# requests. For information about downloading objects from Requester
|
1815
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
1816
|
+
# in the *Amazon S3 Developer Guide*.
|
1817
|
+
#
|
1818
|
+
#
|
1819
|
+
#
|
1820
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
1769
1821
|
# @return [String]
|
1770
1822
|
#
|
1771
1823
|
# @!attribute [rw] tagging
|
1772
1824
|
# The tag-set for the object. The tag-set must be encoded as URL Query
|
1773
|
-
# parameters
|
1825
|
+
# parameters.
|
1774
1826
|
# @return [String]
|
1775
1827
|
#
|
1776
1828
|
# @!attribute [rw] object_lock_mode
|
@@ -2151,7 +2203,7 @@ module Aws::S3
|
|
2151
2203
|
# <Status>Disabled</Status>. For an example configuration,
|
2152
2204
|
# see [Basic Rule Configuration][1].
|
2153
2205
|
#
|
2154
|
-
# <note markdown="1"> If you don't specify the Filter element, Amazon S3 assumes the
|
2206
|
+
# <note markdown="1"> If you don't specify the `Filter` element, Amazon S3 assumes that the
|
2155
2207
|
# replication configuration is the earlier version, V1. In the earlier
|
2156
2208
|
# version, Amazon S3 handled replication of delete markers differently.
|
2157
2209
|
# For more information, see [Backward Compatibility][2].
|
@@ -2224,6 +2276,19 @@ module Aws::S3
|
|
2224
2276
|
#
|
2225
2277
|
# @!attribute [rw] bucket
|
2226
2278
|
# The bucket name of the bucket containing the object.
|
2279
|
+
#
|
2280
|
+
# When using this API with an access point, you must direct requests
|
2281
|
+
# to the access point hostname. The access point hostname takes the
|
2282
|
+
# form
|
2283
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2284
|
+
# When using this operation using an access point through the AWS
|
2285
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
2286
|
+
# For more information about access point ARNs, see [Using Access
|
2287
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
2288
|
+
#
|
2289
|
+
#
|
2290
|
+
#
|
2291
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
2227
2292
|
# @return [String]
|
2228
2293
|
#
|
2229
2294
|
# @!attribute [rw] key
|
@@ -2233,8 +2298,8 @@ module Aws::S3
|
|
2233
2298
|
# @!attribute [rw] mfa
|
2234
2299
|
# The concatenation of the authentication device's serial number, a
|
2235
2300
|
# space, and the value that is displayed on your authentication
|
2236
|
-
# device. Required to permanently delete a
|
2237
|
-
# versioning is configured with MFA
|
2301
|
+
# device. Required to permanently delete a versioned object if
|
2302
|
+
# versioning is configured with MFA delete enabled.
|
2238
2303
|
# @return [String]
|
2239
2304
|
#
|
2240
2305
|
# @!attribute [rw] version_id
|
@@ -2244,9 +2309,13 @@ module Aws::S3
|
|
2244
2309
|
# @!attribute [rw] request_payer
|
2245
2310
|
# Confirms that the requester knows that she or he will be charged for
|
2246
2311
|
# the request. Bucket owners need not specify this parameter in their
|
2247
|
-
# requests.
|
2248
|
-
# buckets
|
2249
|
-
#
|
2312
|
+
# requests. For information about downloading objects from Requester
|
2313
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
2314
|
+
# in the *Amazon S3 Developer Guide*.
|
2315
|
+
#
|
2316
|
+
#
|
2317
|
+
#
|
2318
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
2250
2319
|
# @return [String]
|
2251
2320
|
#
|
2252
2321
|
# @!attribute [rw] bypass_governance_retention
|
@@ -2287,7 +2356,21 @@ module Aws::S3
|
|
2287
2356
|
# }
|
2288
2357
|
#
|
2289
2358
|
# @!attribute [rw] bucket
|
2290
|
-
# The bucket containing the objects from which to remove the
|
2359
|
+
# The bucket name containing the objects from which to remove the
|
2360
|
+
# tags.
|
2361
|
+
#
|
2362
|
+
# When using this API with an access point, you must direct requests
|
2363
|
+
# to the access point hostname. The access point hostname takes the
|
2364
|
+
# form
|
2365
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2366
|
+
# When using this operation using an access point through the AWS
|
2367
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
2368
|
+
# For more information about access point ARNs, see [Using Access
|
2369
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
2370
|
+
#
|
2371
|
+
#
|
2372
|
+
#
|
2373
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
2291
2374
|
# @return [String]
|
2292
2375
|
#
|
2293
2376
|
# @!attribute [rw] key
|
@@ -2352,6 +2435,19 @@ module Aws::S3
|
|
2352
2435
|
#
|
2353
2436
|
# @!attribute [rw] bucket
|
2354
2437
|
# The bucket name containing the objects to delete.
|
2438
|
+
#
|
2439
|
+
# When using this API with an access point, you must direct requests
|
2440
|
+
# to the access point hostname. The access point hostname takes the
|
2441
|
+
# form
|
2442
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2443
|
+
# When using this operation using an access point through the AWS
|
2444
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
2445
|
+
# For more information about access point ARNs, see [Using Access
|
2446
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
2447
|
+
#
|
2448
|
+
#
|
2449
|
+
#
|
2450
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
2355
2451
|
# @return [String]
|
2356
2452
|
#
|
2357
2453
|
# @!attribute [rw] delete
|
@@ -2362,15 +2458,19 @@ module Aws::S3
|
|
2362
2458
|
# The concatenation of the authentication device's serial number, a
|
2363
2459
|
# space, and the value that is displayed on your authentication
|
2364
2460
|
# device. Required to permanently delete a versioned object if
|
2365
|
-
# versioning is configured with MFA
|
2461
|
+
# versioning is configured with MFA delete enabled.
|
2366
2462
|
# @return [String]
|
2367
2463
|
#
|
2368
2464
|
# @!attribute [rw] request_payer
|
2369
2465
|
# Confirms that the requester knows that she or he will be charged for
|
2370
2466
|
# the request. Bucket owners need not specify this parameter in their
|
2371
|
-
# requests.
|
2372
|
-
# buckets
|
2373
|
-
#
|
2467
|
+
# requests. For information about downloading objects from Requester
|
2468
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
2469
|
+
# in the *Amazon S3 Developer Guide*.
|
2470
|
+
#
|
2471
|
+
#
|
2472
|
+
#
|
2473
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
2374
2474
|
# @return [String]
|
2375
2475
|
#
|
2376
2476
|
# @!attribute [rw] bypass_governance_retention
|
@@ -2444,7 +2544,8 @@ module Aws::S3
|
|
2444
2544
|
end
|
2445
2545
|
|
2446
2546
|
# Specifies information about where to publish analysis or configuration
|
2447
|
-
# results for an Amazon S3 bucket
|
2547
|
+
# results for an Amazon S3 bucket and S3 Replication Time Control (S3
|
2548
|
+
# RTC).
|
2448
2549
|
#
|
2449
2550
|
# @note When making an API call, you may pass Destination
|
2450
2551
|
# data as a hash:
|
@@ -2484,8 +2585,8 @@ module Aws::S3
|
|
2484
2585
|
# that owns the destination bucket by specifying the
|
2485
2586
|
# `AccessControlTranslation` property, this is the account ID of the
|
2486
2587
|
# destination bucket owner. For more information, see [Replication
|
2487
|
-
# Additional Configuration:
|
2488
|
-
# Simple Storage Service Developer Guide*.
|
2588
|
+
# Additional Configuration: Changing the Replica Owner][1] in the
|
2589
|
+
# *Amazon Simple Storage Service Developer Guide*.
|
2489
2590
|
#
|
2490
2591
|
#
|
2491
2592
|
#
|
@@ -2522,17 +2623,16 @@ module Aws::S3
|
|
2522
2623
|
# @return [Types::EncryptionConfiguration]
|
2523
2624
|
#
|
2524
2625
|
# @!attribute [rw] replication_time
|
2525
|
-
# A container specifying
|
2526
|
-
#
|
2527
|
-
#
|
2626
|
+
# A container specifying S3 Replication Time Control (S3 RTC),
|
2627
|
+
# including whether S3 RTC is enabled and the time when all objects
|
2628
|
+
# and operations on objects must be replicated. Must be specified
|
2629
|
+
# together with a `Metrics` block.
|
2528
2630
|
# @return [Types::ReplicationTime]
|
2529
2631
|
#
|
2530
2632
|
# @!attribute [rw] metrics
|
2531
|
-
# A container specifying replication metrics-related
|
2532
|
-
#
|
2533
|
-
#
|
2534
|
-
# related to specific metrics or events. Must be specified together
|
2535
|
-
# with a `ReplicationTime` block.
|
2633
|
+
# A container specifying replication metrics-related settings enabling
|
2634
|
+
# metrics and Amazon S3 events for S3 Replication Time Control (S3
|
2635
|
+
# RTC). Must be specified together with a `ReplicationTime` block.
|
2536
2636
|
# @return [Types::Metrics]
|
2537
2637
|
#
|
2538
2638
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Destination AWS API Documentation
|
@@ -2561,16 +2661,16 @@ module Aws::S3
|
|
2561
2661
|
#
|
2562
2662
|
# @!attribute [rw] encryption_type
|
2563
2663
|
# The server-side encryption algorithm used when storing job results
|
2564
|
-
# in Amazon S3 (
|
2664
|
+
# in Amazon S3 (for example, AES256, aws:kms).
|
2565
2665
|
# @return [String]
|
2566
2666
|
#
|
2567
2667
|
# @!attribute [rw] kms_key_id
|
2568
|
-
# If the encryption type is aws:kms
|
2569
|
-
# AWS KMS key ID to use for encryption of job results.
|
2668
|
+
# If the encryption type is `aws:kms`, this optional value specifies
|
2669
|
+
# the AWS KMS key ID to use for encryption of job results.
|
2570
2670
|
# @return [String]
|
2571
2671
|
#
|
2572
2672
|
# @!attribute [rw] kms_context
|
2573
|
-
# If the encryption type is aws:kms
|
2673
|
+
# If the encryption type is `aws:kms`, this optional value can be used
|
2574
2674
|
# to specify the encryption context for the restore results.
|
2575
2675
|
# @return [String]
|
2576
2676
|
#
|
@@ -2701,13 +2801,13 @@ module Aws::S3
|
|
2701
2801
|
#
|
2702
2802
|
# * *Description:* The bucket you tried to create already exists,
|
2703
2803
|
# and you own it. Amazon S3 returns this error in all AWS Regions
|
2704
|
-
# except in the North Virginia
|
2804
|
+
# except in the North Virginia Region. For legacy compatibility,
|
2705
2805
|
# if you re-create an existing bucket that you already own in the
|
2706
|
-
# North Virginia
|
2806
|
+
# North Virginia Region, Amazon S3 returns 200 OK and resets the
|
2707
2807
|
# bucket access control lists (ACLs).
|
2708
2808
|
#
|
2709
|
-
# * *Code:* 409 Conflict (in all
|
2710
|
-
#
|
2809
|
+
# * *Code:* 409 Conflict (in all Regions except the North Virginia
|
2810
|
+
# Region)
|
2711
2811
|
#
|
2712
2812
|
# * *SOAP Fault Code Prefix:* Client
|
2713
2813
|
#
|
@@ -3466,9 +3566,10 @@ module Aws::S3
|
|
3466
3566
|
include Aws::Structure
|
3467
3567
|
end
|
3468
3568
|
|
3469
|
-
#
|
3470
|
-
#
|
3471
|
-
# replication
|
3569
|
+
# Optional configuration to replicate existing source bucket objects.
|
3570
|
+
# For more information, see [Replicating Existing Objects](
|
3571
|
+
# https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication)
|
3572
|
+
# in the *Amazon S3 Developer Guide*.
|
3472
3573
|
#
|
3473
3574
|
# @note When making an API call, you may pass ExistingObjectReplication
|
3474
3575
|
# data as a hash:
|
@@ -3478,7 +3579,6 @@ module Aws::S3
|
|
3478
3579
|
# }
|
3479
3580
|
#
|
3480
3581
|
# @!attribute [rw] status
|
3481
|
-
# Specifies whether existing object replication is enabled.
|
3482
3582
|
# @return [String]
|
3483
3583
|
#
|
3484
3584
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ExistingObjectReplication AWS API Documentation
|
@@ -3738,7 +3838,7 @@ module Aws::S3
|
|
3738
3838
|
# }
|
3739
3839
|
#
|
3740
3840
|
# @!attribute [rw] bucket
|
3741
|
-
# The name of the bucket for which to
|
3841
|
+
# The name of the bucket for which to get the lifecycle information.
|
3742
3842
|
# @return [String]
|
3743
3843
|
#
|
3744
3844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycleConfigurationRequest AWS API Documentation
|
@@ -3767,7 +3867,7 @@ module Aws::S3
|
|
3767
3867
|
# }
|
3768
3868
|
#
|
3769
3869
|
# @!attribute [rw] bucket
|
3770
|
-
# The name of the bucket for which to
|
3870
|
+
# The name of the bucket for which to get the lifecycle information.
|
3771
3871
|
# @return [String]
|
3772
3872
|
#
|
3773
3873
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycleRequest AWS API Documentation
|
@@ -3778,8 +3878,8 @@ module Aws::S3
|
|
3778
3878
|
end
|
3779
3879
|
|
3780
3880
|
# @!attribute [rw] location_constraint
|
3781
|
-
# Specifies the
|
3782
|
-
# Amazon S3 supported location constraints by
|
3881
|
+
# Specifies the Region where the bucket resides. For a list of all the
|
3882
|
+
# Amazon S3 supported location constraints by Region, see [Regions and
|
3783
3883
|
# Endpoints][1].
|
3784
3884
|
#
|
3785
3885
|
#
|
@@ -4166,7 +4266,21 @@ module Aws::S3
|
|
4166
4266
|
# }
|
4167
4267
|
#
|
4168
4268
|
# @!attribute [rw] bucket
|
4169
|
-
# The bucket name
|
4269
|
+
# The bucket name that contains the object for which to get the ACL
|
4270
|
+
# information.
|
4271
|
+
#
|
4272
|
+
# When using this API with an access point, you must direct requests
|
4273
|
+
# to the access point hostname. The access point hostname takes the
|
4274
|
+
# form
|
4275
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
4276
|
+
# When using this operation using an access point through the AWS
|
4277
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
4278
|
+
# For more information about access point ARNs, see [Using Access
|
4279
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
4280
|
+
#
|
4281
|
+
#
|
4282
|
+
#
|
4283
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
4170
4284
|
# @return [String]
|
4171
4285
|
#
|
4172
4286
|
# @!attribute [rw] key
|
@@ -4180,9 +4294,13 @@ module Aws::S3
|
|
4180
4294
|
# @!attribute [rw] request_payer
|
4181
4295
|
# Confirms that the requester knows that she or he will be charged for
|
4182
4296
|
# the request. Bucket owners need not specify this parameter in their
|
4183
|
-
# requests.
|
4184
|
-
# buckets
|
4185
|
-
#
|
4297
|
+
# requests. For information about downloading objects from Requester
|
4298
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
4299
|
+
# in the *Amazon S3 Developer Guide*.
|
4300
|
+
#
|
4301
|
+
#
|
4302
|
+
#
|
4303
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
4186
4304
|
# @return [String]
|
4187
4305
|
#
|
4188
4306
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAclRequest AWS API Documentation
|
@@ -4217,8 +4335,21 @@ module Aws::S3
|
|
4217
4335
|
# }
|
4218
4336
|
#
|
4219
4337
|
# @!attribute [rw] bucket
|
4220
|
-
# The bucket containing the object whose Legal Hold status you
|
4221
|
-
# retrieve.
|
4338
|
+
# The bucket name containing the object whose Legal Hold status you
|
4339
|
+
# want to retrieve.
|
4340
|
+
#
|
4341
|
+
# When using this API with an access point, you must direct requests
|
4342
|
+
# to the access point hostname. The access point hostname takes the
|
4343
|
+
# form
|
4344
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
4345
|
+
# When using this operation using an access point through the AWS
|
4346
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
4347
|
+
# For more information about access point ARNs, see [Using Access
|
4348
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
4349
|
+
#
|
4350
|
+
#
|
4351
|
+
#
|
4352
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
4222
4353
|
# @return [String]
|
4223
4354
|
#
|
4224
4355
|
# @!attribute [rw] key
|
@@ -4234,9 +4365,13 @@ module Aws::S3
|
|
4234
4365
|
# @!attribute [rw] request_payer
|
4235
4366
|
# Confirms that the requester knows that she or he will be charged for
|
4236
4367
|
# the request. Bucket owners need not specify this parameter in their
|
4237
|
-
# requests.
|
4238
|
-
# buckets
|
4239
|
-
#
|
4368
|
+
# requests. For information about downloading objects from Requester
|
4369
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
4370
|
+
# in the *Amazon S3 Developer Guide*.
|
4371
|
+
#
|
4372
|
+
#
|
4373
|
+
#
|
4374
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
4240
4375
|
# @return [String]
|
4241
4376
|
#
|
4242
4377
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLegalHoldRequest AWS API Documentation
|
@@ -4289,13 +4424,13 @@ module Aws::S3
|
|
4289
4424
|
# @return [Boolean]
|
4290
4425
|
#
|
4291
4426
|
# @!attribute [rw] accept_ranges
|
4292
|
-
# Indicates that a range of bytes was
|
4427
|
+
# Indicates that a range of bytes was specified.
|
4293
4428
|
# @return [String]
|
4294
4429
|
#
|
4295
4430
|
# @!attribute [rw] expiration
|
4296
4431
|
# If the object expiration is configured (see PUT Bucket lifecycle),
|
4297
4432
|
# the response includes this header. It includes the expiry-date and
|
4298
|
-
# rule-id key
|
4433
|
+
# rule-id key-value pairs providing object expiration information. The
|
4299
4434
|
# value of the rule-id is URL encoded.
|
4300
4435
|
# @return [String]
|
4301
4436
|
#
|
@@ -4314,13 +4449,13 @@ module Aws::S3
|
|
4314
4449
|
#
|
4315
4450
|
# @!attribute [rw] etag
|
4316
4451
|
# An ETag is an opaque identifier assigned by a web server to a
|
4317
|
-
# specific version of a resource found at a URL
|
4452
|
+
# specific version of a resource found at a URL.
|
4318
4453
|
# @return [String]
|
4319
4454
|
#
|
4320
4455
|
# @!attribute [rw] missing_meta
|
4321
4456
|
# This is set to the number of metadata entries not returned in
|
4322
|
-
# x-amz-meta headers. This can happen if you create metadata using
|
4323
|
-
# API like SOAP that supports more flexible metadata than the REST
|
4457
|
+
# `x-amz-meta` headers. This can happen if you create metadata using
|
4458
|
+
# an API like SOAP that supports more flexible metadata than the REST
|
4324
4459
|
# API. For example, using SOAP, you can create metadata whose values
|
4325
4460
|
# are not legal HTTP headers.
|
4326
4461
|
# @return [Integer]
|
@@ -4370,8 +4505,8 @@ module Aws::S3
|
|
4370
4505
|
# @return [String]
|
4371
4506
|
#
|
4372
4507
|
# @!attribute [rw] server_side_encryption
|
4373
|
-
# The
|
4374
|
-
# in S3 (
|
4508
|
+
# The server-side encryption algorithm used when storing this object
|
4509
|
+
# in Amazon S3 (for example, AES256, aws:kms).
|
4375
4510
|
# @return [String]
|
4376
4511
|
#
|
4377
4512
|
# @!attribute [rw] metadata
|
@@ -4387,13 +4522,13 @@ module Aws::S3
|
|
4387
4522
|
# @!attribute [rw] sse_customer_key_md5
|
4388
4523
|
# If server-side encryption with a customer-provided encryption key
|
4389
4524
|
# was requested, the response will include this header to provide
|
4390
|
-
# round
|
4525
|
+
# round-trip message integrity verification of the customer-provided
|
4391
4526
|
# encryption key.
|
4392
4527
|
# @return [String]
|
4393
4528
|
#
|
4394
4529
|
# @!attribute [rw] ssekms_key_id
|
4395
|
-
# If present, specifies the ID of the AWS Key Management Service (
|
4396
|
-
# customer master key (CMK) that was used for the object.
|
4530
|
+
# If present, specifies the ID of the AWS Key Management Service (AWS
|
4531
|
+
# KMS) customer master key (CMK) that was used for the object.
|
4397
4532
|
# @return [String]
|
4398
4533
|
#
|
4399
4534
|
# @!attribute [rw] storage_class
|
@@ -4499,6 +4634,19 @@ module Aws::S3
|
|
4499
4634
|
#
|
4500
4635
|
# @!attribute [rw] bucket
|
4501
4636
|
# The bucket name containing the object.
|
4637
|
+
#
|
4638
|
+
# When using this API with an access point, you must direct requests
|
4639
|
+
# to the access point hostname. The access point hostname takes the
|
4640
|
+
# form
|
4641
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
4642
|
+
# When using this operation using an access point through the AWS
|
4643
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
4644
|
+
# For more information about access point ARNs, see [Using Access
|
4645
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
4646
|
+
#
|
4647
|
+
#
|
4648
|
+
#
|
4649
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
4502
4650
|
# @return [String]
|
4503
4651
|
#
|
4504
4652
|
# @!attribute [rw] if_match
|
@@ -4527,32 +4675,32 @@ module Aws::S3
|
|
4527
4675
|
#
|
4528
4676
|
# @!attribute [rw] range
|
4529
4677
|
# Downloads the specified range bytes of an object. For more
|
4530
|
-
# information about the HTTP Range header,
|
4531
|
-
# http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
|
4678
|
+
# information about the HTTP Range header, see
|
4679
|
+
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35]().
|
4532
4680
|
# @return [String]
|
4533
4681
|
#
|
4534
4682
|
# @!attribute [rw] response_cache_control
|
4535
|
-
# Sets the Cache-Control header of the response.
|
4683
|
+
# Sets the `Cache-Control` header of the response.
|
4536
4684
|
# @return [String]
|
4537
4685
|
#
|
4538
4686
|
# @!attribute [rw] response_content_disposition
|
4539
|
-
# Sets the Content-Disposition header of the response
|
4687
|
+
# Sets the `Content-Disposition` header of the response
|
4540
4688
|
# @return [String]
|
4541
4689
|
#
|
4542
4690
|
# @!attribute [rw] response_content_encoding
|
4543
|
-
# Sets the Content-Encoding header of the response.
|
4691
|
+
# Sets the `Content-Encoding` header of the response.
|
4544
4692
|
# @return [String]
|
4545
4693
|
#
|
4546
4694
|
# @!attribute [rw] response_content_language
|
4547
|
-
# Sets the Content-Language header of the response.
|
4695
|
+
# Sets the `Content-Language` header of the response.
|
4548
4696
|
# @return [String]
|
4549
4697
|
#
|
4550
4698
|
# @!attribute [rw] response_content_type
|
4551
|
-
# Sets the Content-Type header of the response.
|
4699
|
+
# Sets the `Content-Type` header of the response.
|
4552
4700
|
# @return [String]
|
4553
4701
|
#
|
4554
4702
|
# @!attribute [rw] response_expires
|
4555
|
-
# Sets the Expires header of the response.
|
4703
|
+
# Sets the `Expires` header of the response.
|
4556
4704
|
# @return [Time]
|
4557
4705
|
#
|
4558
4706
|
# @!attribute [rw] version_id
|
@@ -4560,30 +4708,34 @@ module Aws::S3
|
|
4560
4708
|
# @return [String]
|
4561
4709
|
#
|
4562
4710
|
# @!attribute [rw] sse_customer_algorithm
|
4563
|
-
# Specifies the algorithm to use to when encrypting the object (
|
4564
|
-
# AES256).
|
4711
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
4712
|
+
# example, AES256).
|
4565
4713
|
# @return [String]
|
4566
4714
|
#
|
4567
4715
|
# @!attribute [rw] sse_customer_key
|
4568
4716
|
# Specifies the customer-provided encryption key for Amazon S3 to use
|
4569
4717
|
# in encrypting data. This value is used to store the object and then
|
4570
|
-
# it is discarded; Amazon does not store the encryption key. The
|
4571
|
-
# must be appropriate for use with the algorithm specified in the
|
4572
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
4718
|
+
# it is discarded; Amazon S3 does not store the encryption key. The
|
4719
|
+
# key must be appropriate for use with the algorithm specified in the
|
4720
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
4573
4721
|
# @return [String]
|
4574
4722
|
#
|
4575
4723
|
# @!attribute [rw] sse_customer_key_md5
|
4576
4724
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
4577
4725
|
# RFC 1321. Amazon S3 uses this header for a message integrity check
|
4578
|
-
# to ensure the encryption key was transmitted without error.
|
4726
|
+
# to ensure that the encryption key was transmitted without error.
|
4579
4727
|
# @return [String]
|
4580
4728
|
#
|
4581
4729
|
# @!attribute [rw] request_payer
|
4582
4730
|
# Confirms that the requester knows that she or he will be charged for
|
4583
4731
|
# the request. Bucket owners need not specify this parameter in their
|
4584
|
-
# requests.
|
4585
|
-
# buckets
|
4586
|
-
#
|
4732
|
+
# requests. For information about downloading objects from Requester
|
4733
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
4734
|
+
# in the *Amazon S3 Developer Guide*.
|
4735
|
+
#
|
4736
|
+
#
|
4737
|
+
#
|
4738
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
4587
4739
|
# @return [String]
|
4588
4740
|
#
|
4589
4741
|
# @!attribute [rw] part_number
|
@@ -4640,8 +4792,21 @@ module Aws::S3
|
|
4640
4792
|
# }
|
4641
4793
|
#
|
4642
4794
|
# @!attribute [rw] bucket
|
4643
|
-
# The bucket containing the object whose retention settings you
|
4644
|
-
# to retrieve.
|
4795
|
+
# The bucket name containing the object whose retention settings you
|
4796
|
+
# want to retrieve.
|
4797
|
+
#
|
4798
|
+
# When using this API with an access point, you must direct requests
|
4799
|
+
# to the access point hostname. The access point hostname takes the
|
4800
|
+
# form
|
4801
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
4802
|
+
# When using this operation using an access point through the AWS
|
4803
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
4804
|
+
# For more information about access point ARNs, see [Using Access
|
4805
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
4806
|
+
#
|
4807
|
+
#
|
4808
|
+
#
|
4809
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
4645
4810
|
# @return [String]
|
4646
4811
|
#
|
4647
4812
|
# @!attribute [rw] key
|
@@ -4657,9 +4822,13 @@ module Aws::S3
|
|
4657
4822
|
# @!attribute [rw] request_payer
|
4658
4823
|
# Confirms that the requester knows that she or he will be charged for
|
4659
4824
|
# the request. Bucket owners need not specify this parameter in their
|
4660
|
-
# requests.
|
4661
|
-
# buckets
|
4662
|
-
#
|
4825
|
+
# requests. For information about downloading objects from Requester
|
4826
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
4827
|
+
# in the *Amazon S3 Developer Guide*.
|
4828
|
+
#
|
4829
|
+
#
|
4830
|
+
#
|
4831
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
4663
4832
|
# @return [String]
|
4664
4833
|
#
|
4665
4834
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectRetentionRequest AWS API Documentation
|
@@ -4701,6 +4870,19 @@ module Aws::S3
|
|
4701
4870
|
# @!attribute [rw] bucket
|
4702
4871
|
# The bucket name containing the object for which to get the tagging
|
4703
4872
|
# information.
|
4873
|
+
#
|
4874
|
+
# When using this API with an access point, you must direct requests
|
4875
|
+
# to the access point hostname. The access point hostname takes the
|
4876
|
+
# form
|
4877
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
4878
|
+
# When using this operation using an access point through the AWS
|
4879
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
4880
|
+
# For more information about access point ARNs, see [Using Access
|
4881
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
4882
|
+
#
|
4883
|
+
#
|
4884
|
+
#
|
4885
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
4704
4886
|
# @return [String]
|
4705
4887
|
#
|
4706
4888
|
# @!attribute [rw] key
|
@@ -4759,9 +4941,13 @@ module Aws::S3
|
|
4759
4941
|
# @!attribute [rw] request_payer
|
4760
4942
|
# Confirms that the requester knows that she or he will be charged for
|
4761
4943
|
# the request. Bucket owners need not specify this parameter in their
|
4762
|
-
# requests.
|
4763
|
-
# buckets
|
4764
|
-
#
|
4944
|
+
# requests. For information about downloading objects from Requester
|
4945
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
4946
|
+
# in the *Amazon S3 Developer Guide*.
|
4947
|
+
#
|
4948
|
+
#
|
4949
|
+
#
|
4950
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
4765
4951
|
# @return [String]
|
4766
4952
|
#
|
4767
4953
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTorrentRequest AWS API Documentation
|
@@ -4925,13 +5111,13 @@ module Aws::S3
|
|
4925
5111
|
# @return [Boolean]
|
4926
5112
|
#
|
4927
5113
|
# @!attribute [rw] accept_ranges
|
4928
|
-
# Indicates that a range of bytes was
|
5114
|
+
# Indicates that a range of bytes was specified.
|
4929
5115
|
# @return [String]
|
4930
5116
|
#
|
4931
5117
|
# @!attribute [rw] expiration
|
4932
5118
|
# If the object expiration is configured (see PUT Bucket lifecycle),
|
4933
5119
|
# the response includes this header. It includes the expiry-date and
|
4934
|
-
# rule-id key
|
5120
|
+
# rule-id key-value pairs providing object expiration information. The
|
4935
5121
|
# value of the rule-id is URL encoded.
|
4936
5122
|
# @return [String]
|
4937
5123
|
#
|
@@ -4968,13 +5154,13 @@ module Aws::S3
|
|
4968
5154
|
#
|
4969
5155
|
# @!attribute [rw] etag
|
4970
5156
|
# An ETag is an opaque identifier assigned by a web server to a
|
4971
|
-
# specific version of a resource found at a URL
|
5157
|
+
# specific version of a resource found at a URL.
|
4972
5158
|
# @return [String]
|
4973
5159
|
#
|
4974
5160
|
# @!attribute [rw] missing_meta
|
4975
5161
|
# This is set to the number of metadata entries not returned in
|
4976
|
-
# x-amz-meta headers. This can happen if you create metadata using
|
4977
|
-
# API like SOAP that supports more flexible metadata than the REST
|
5162
|
+
# `x-amz-meta` headers. This can happen if you create metadata using
|
5163
|
+
# an API like SOAP that supports more flexible metadata than the REST
|
4978
5164
|
# API. For example, using SOAP, you can create metadata whose values
|
4979
5165
|
# are not legal HTTP headers.
|
4980
5166
|
# @return [Integer]
|
@@ -5023,8 +5209,8 @@ module Aws::S3
|
|
5023
5209
|
# If the object is stored using server-side encryption either with an
|
5024
5210
|
# AWS KMS customer master key (CMK) or an Amazon S3-managed encryption
|
5025
5211
|
# key, the response includes this header with the value of the
|
5026
|
-
#
|
5027
|
-
# (
|
5212
|
+
# server-side encryption algorithm used when storing this object in
|
5213
|
+
# Amazon S3 (for example, AES256, aws:kms).
|
5028
5214
|
# @return [String]
|
5029
5215
|
#
|
5030
5216
|
# @!attribute [rw] metadata
|
@@ -5040,13 +5226,13 @@ module Aws::S3
|
|
5040
5226
|
# @!attribute [rw] sse_customer_key_md5
|
5041
5227
|
# If server-side encryption with a customer-provided encryption key
|
5042
5228
|
# was requested, the response will include this header to provide
|
5043
|
-
# round
|
5229
|
+
# round-trip message integrity verification of the customer-provided
|
5044
5230
|
# encryption key.
|
5045
5231
|
# @return [String]
|
5046
5232
|
#
|
5047
5233
|
# @!attribute [rw] ssekms_key_id
|
5048
|
-
# If present, specifies the ID of the AWS Key Management Service (
|
5049
|
-
# customer master key (CMK) that was used for the object.
|
5234
|
+
# If present, specifies the ID of the AWS Key Management Service (AWS
|
5235
|
+
# KMS) customer master key (CMK) that was used for the object.
|
5050
5236
|
# @return [String]
|
5051
5237
|
#
|
5052
5238
|
# @!attribute [rw] storage_class
|
@@ -5070,28 +5256,29 @@ module Aws::S3
|
|
5070
5256
|
# Amazon S3 can return this header if your request involves a bucket
|
5071
5257
|
# that is either a source or destination in a replication rule.
|
5072
5258
|
#
|
5073
|
-
# In replication you have a source bucket on which you configure
|
5259
|
+
# In replication, you have a source bucket on which you configure
|
5074
5260
|
# replication and destination bucket where Amazon S3 stores object
|
5075
|
-
# replicas. When you request an object (GetObject) or object
|
5076
|
-
# (HeadObject) from these buckets, Amazon S3 will return
|
5077
|
-
# x-amz-replication-status header in the response as follows:
|
5261
|
+
# replicas. When you request an object (`GetObject`) or object
|
5262
|
+
# metadata (`HeadObject`) from these buckets, Amazon S3 will return
|
5263
|
+
# the `x-amz-replication-status` header in the response as follows:
|
5078
5264
|
#
|
5079
|
-
# * If requesting object from the source bucket — Amazon S3 will
|
5080
|
-
# return the x-amz-replication-status header if object in your
|
5265
|
+
# * If requesting an object from the source bucket — Amazon S3 will
|
5266
|
+
# return the `x-amz-replication-status` header if the object in your
|
5081
5267
|
# request is eligible for replication.
|
5082
5268
|
#
|
5083
|
-
# For example, suppose in your replication configuration you
|
5084
|
-
# object prefix
|
5085
|
-
# objects with key prefix
|
5086
|
-
#
|
5087
|
-
#
|
5088
|
-
# name prefix Amazon S3 will return the x-amz-replication-status
|
5269
|
+
# For example, suppose that in your replication configuration, you
|
5270
|
+
# specify object prefix `TaxDocs` requesting Amazon S3 to replicate
|
5271
|
+
# objects with key prefix `TaxDocs`. Any objects you upload with
|
5272
|
+
# this key name prefix, for example `TaxDocs/document1.pdf`, are
|
5273
|
+
# eligible for replication. For any object request with this key
|
5274
|
+
# name prefix, Amazon S3 will return the `x-amz-replication-status`
|
5089
5275
|
# header with value PENDING, COMPLETED or FAILED indicating object
|
5090
5276
|
# replication status.
|
5091
5277
|
#
|
5092
|
-
# * If requesting object from the destination bucket — Amazon S3
|
5093
|
-
# return the x-amz-replication-status header with value
|
5094
|
-
# object in your request is a replica that Amazon S3
|
5278
|
+
# * If requesting an object from the destination bucket — Amazon S3
|
5279
|
+
# will return the `x-amz-replication-status` header with value
|
5280
|
+
# REPLICA if the object in your request is a replica that Amazon S3
|
5281
|
+
# created.
|
5095
5282
|
#
|
5096
5283
|
# For more information, see [Replication][1].
|
5097
5284
|
#
|
@@ -5218,8 +5405,8 @@ module Aws::S3
|
|
5218
5405
|
#
|
5219
5406
|
# @!attribute [rw] range
|
5220
5407
|
# Downloads the specified range bytes of an object. For more
|
5221
|
-
# information about the HTTP Range header,
|
5222
|
-
# http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
|
5408
|
+
# information about the HTTP Range header, see
|
5409
|
+
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35]().
|
5223
5410
|
# @return [String]
|
5224
5411
|
#
|
5225
5412
|
# @!attribute [rw] version_id
|
@@ -5227,30 +5414,34 @@ module Aws::S3
|
|
5227
5414
|
# @return [String]
|
5228
5415
|
#
|
5229
5416
|
# @!attribute [rw] sse_customer_algorithm
|
5230
|
-
# Specifies the algorithm to use to when encrypting the object (
|
5231
|
-
# AES256).
|
5417
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
5418
|
+
# example, AES256).
|
5232
5419
|
# @return [String]
|
5233
5420
|
#
|
5234
5421
|
# @!attribute [rw] sse_customer_key
|
5235
5422
|
# Specifies the customer-provided encryption key for Amazon S3 to use
|
5236
5423
|
# in encrypting data. This value is used to store the object and then
|
5237
|
-
# it is discarded; Amazon does not store the encryption key. The
|
5238
|
-
# must be appropriate for use with the algorithm specified in the
|
5239
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
5424
|
+
# it is discarded; Amazon S3 does not store the encryption key. The
|
5425
|
+
# key must be appropriate for use with the algorithm specified in the
|
5426
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
5240
5427
|
# @return [String]
|
5241
5428
|
#
|
5242
5429
|
# @!attribute [rw] sse_customer_key_md5
|
5243
5430
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
5244
5431
|
# RFC 1321. Amazon S3 uses this header for a message integrity check
|
5245
|
-
# to ensure the encryption key was transmitted without error.
|
5432
|
+
# to ensure that the encryption key was transmitted without error.
|
5246
5433
|
# @return [String]
|
5247
5434
|
#
|
5248
5435
|
# @!attribute [rw] request_payer
|
5249
5436
|
# Confirms that the requester knows that she or he will be charged for
|
5250
5437
|
# the request. Bucket owners need not specify this parameter in their
|
5251
|
-
# requests.
|
5252
|
-
# buckets
|
5253
|
-
#
|
5438
|
+
# requests. For information about downloading objects from Requester
|
5439
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
5440
|
+
# in the *Amazon S3 Developer Guide*.
|
5441
|
+
#
|
5442
|
+
#
|
5443
|
+
#
|
5444
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
5254
5445
|
# @return [String]
|
5255
5446
|
#
|
5256
5447
|
# @!attribute [rw] part_number
|
@@ -5279,7 +5470,7 @@ module Aws::S3
|
|
5279
5470
|
include Aws::Structure
|
5280
5471
|
end
|
5281
5472
|
|
5282
|
-
# Container for the Suffix element.
|
5473
|
+
# Container for the `Suffix` element.
|
5283
5474
|
#
|
5284
5475
|
# @note When making an API call, you may pass IndexDocument
|
5285
5476
|
# data as a hash:
|
@@ -5290,10 +5481,10 @@ module Aws::S3
|
|
5290
5481
|
#
|
5291
5482
|
# @!attribute [rw] suffix
|
5292
5483
|
# A suffix that is appended to a request that is for a directory on
|
5293
|
-
# the website endpoint (
|
5294
|
-
# a request to samplebucket/images/ the data that is returned
|
5295
|
-
# for the object with the key name images/index.html) The
|
5296
|
-
# not be empty and must not include a slash character.
|
5484
|
+
# the website endpoint (for example,if the suffix is index.html and
|
5485
|
+
# you make a request to samplebucket/images/ the data that is returned
|
5486
|
+
# will be for the object with the key name images/index.html) The
|
5487
|
+
# suffix must not be empty and must not include a slash character.
|
5297
5488
|
# @return [String]
|
5298
5489
|
#
|
5299
5490
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/IndexDocument AWS API Documentation
|
@@ -5303,7 +5494,7 @@ module Aws::S3
|
|
5303
5494
|
include Aws::Structure
|
5304
5495
|
end
|
5305
5496
|
|
5306
|
-
# Container element that identifies who initiated the
|
5497
|
+
# Container element that identifies who initiated the multipart upload.
|
5307
5498
|
#
|
5308
5499
|
# @!attribute [rw] id
|
5309
5500
|
# If the principal is an AWS account, it provides the Canonical User
|
@@ -5508,11 +5699,11 @@ module Aws::S3
|
|
5508
5699
|
# }
|
5509
5700
|
#
|
5510
5701
|
# @!attribute [rw] sses3
|
5511
|
-
# Specifies the use of SSE-S3 to encrypt delivered
|
5702
|
+
# Specifies the use of SSE-S3 to encrypt delivered inventory reports.
|
5512
5703
|
# @return [Types::SSES3]
|
5513
5704
|
#
|
5514
5705
|
# @!attribute [rw] ssekms
|
5515
|
-
# Specifies the use of SSE-KMS to encrypt delivered
|
5706
|
+
# Specifies the use of SSE-KMS to encrypt delivered inventory reports.
|
5516
5707
|
# @return [Types::SSEKMS]
|
5517
5708
|
#
|
5518
5709
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/InventoryEncryption AWS API Documentation
|
@@ -5570,7 +5761,7 @@ module Aws::S3
|
|
5570
5761
|
# @return [String]
|
5571
5762
|
#
|
5572
5763
|
# @!attribute [rw] bucket
|
5573
|
-
# The Amazon
|
5764
|
+
# The Amazon Resource Name (ARN) of the bucket where inventory results
|
5574
5765
|
# will be published.
|
5575
5766
|
# @return [String]
|
5576
5767
|
#
|
@@ -5867,12 +6058,13 @@ module Aws::S3
|
|
5867
6058
|
#
|
5868
6059
|
# @!attribute [rw] prefix
|
5869
6060
|
# Prefix identifying one or more objects to which the rule applies.
|
5870
|
-
# This is No longer used; use Filter instead.
|
6061
|
+
# This is No longer used; use `Filter` instead.
|
5871
6062
|
# @return [String]
|
5872
6063
|
#
|
5873
6064
|
# @!attribute [rw] filter
|
5874
|
-
# The Filter is used to identify objects that a Lifecycle Rule
|
5875
|
-
# to. A Filter must have exactly one of Prefix
|
6065
|
+
# The `Filter` is used to identify objects that a Lifecycle Rule
|
6066
|
+
# applies to. A `Filter` must have exactly one of `Prefix`, `Tag`, or
|
6067
|
+
# `And` specified.
|
5876
6068
|
# @return [Types::LifecycleRuleFilter]
|
5877
6069
|
#
|
5878
6070
|
# @!attribute [rw] status
|
@@ -5887,11 +6079,11 @@ module Aws::S3
|
|
5887
6079
|
#
|
5888
6080
|
# @!attribute [rw] noncurrent_version_transitions
|
5889
6081
|
# Specifies the transition rule for the lifecycle rule that describes
|
5890
|
-
# when noncurrent objects transition to
|
5891
|
-
#
|
5892
|
-
#
|
5893
|
-
#
|
5894
|
-
#
|
6082
|
+
# when noncurrent objects transition to a specific storage class. If
|
6083
|
+
# your bucket is versioning-enabled (or versioning is suspended), you
|
6084
|
+
# can set this action to request that Amazon S3 transition noncurrent
|
6085
|
+
# object versions to a specific storage class at a set period in the
|
6086
|
+
# object's lifetime.
|
5895
6087
|
# @return [Array<Types::NoncurrentVersionTransition>]
|
5896
6088
|
#
|
5897
6089
|
# @!attribute [rw] noncurrent_version_expiration
|
@@ -5964,8 +6156,9 @@ module Aws::S3
|
|
5964
6156
|
include Aws::Structure
|
5965
6157
|
end
|
5966
6158
|
|
5967
|
-
# The Filter is used to identify objects that a Lifecycle Rule applies
|
5968
|
-
# to. A Filter must have exactly one of Prefix
|
6159
|
+
# The `Filter` is used to identify objects that a Lifecycle Rule applies
|
6160
|
+
# to. A `Filter` must have exactly one of `Prefix`, `Tag`, or `And`
|
6161
|
+
# specified.
|
5969
6162
|
#
|
5970
6163
|
# @note When making an API call, you may pass LifecycleRuleFilter
|
5971
6164
|
# data as a hash:
|
@@ -6025,9 +6218,9 @@ module Aws::S3
|
|
6025
6218
|
# @return [String]
|
6026
6219
|
#
|
6027
6220
|
# @!attribute [rw] next_continuation_token
|
6028
|
-
# NextContinuationToken is sent when isTruncated is true, which
|
6221
|
+
# `NextContinuationToken` is sent when `isTruncated` is true, which
|
6029
6222
|
# indicates that there are more analytics configurations to list. The
|
6030
|
-
# next request must include this NextContinuationToken
|
6223
|
+
# next request must include this `NextContinuationToken`. The token is
|
6031
6224
|
# obfuscated and is not a usable value.
|
6032
6225
|
# @return [String]
|
6033
6226
|
#
|
@@ -6088,7 +6281,7 @@ module Aws::S3
|
|
6088
6281
|
#
|
6089
6282
|
# @!attribute [rw] next_continuation_token
|
6090
6283
|
# The marker used to continue this inventory configuration listing.
|
6091
|
-
# Use the NextContinuationToken from this response to continue the
|
6284
|
+
# Use the `NextContinuationToken` from this response to continue the
|
6092
6285
|
# listing in a subsequent request. The continuation token is an opaque
|
6093
6286
|
# value that Amazon S3 understands.
|
6094
6287
|
# @return [String]
|
@@ -6146,7 +6339,7 @@ module Aws::S3
|
|
6146
6339
|
#
|
6147
6340
|
# @!attribute [rw] next_continuation_token
|
6148
6341
|
# The marker used to continue a metrics configuration listing that has
|
6149
|
-
# been truncated. Use the NextContinuationToken from a previously
|
6342
|
+
# been truncated. Use the `NextContinuationToken` from a previously
|
6150
6343
|
# truncated list response to continue the listing. The continuation
|
6151
6344
|
# token is an opaque value that Amazon S3 understands.
|
6152
6345
|
# @return [String]
|
@@ -6241,7 +6434,7 @@ module Aws::S3
|
|
6241
6434
|
#
|
6242
6435
|
# @!attribute [rw] next_upload_id_marker
|
6243
6436
|
# When a list is truncated, this element specifies the value that
|
6244
|
-
# should be used for the upload-id-marker request parameter in a
|
6437
|
+
# should be used for the `upload-id-marker` request parameter in a
|
6245
6438
|
# subsequent request.
|
6246
6439
|
# @return [String]
|
6247
6440
|
#
|
@@ -6259,14 +6452,14 @@ module Aws::S3
|
|
6259
6452
|
#
|
6260
6453
|
# @!attribute [rw] uploads
|
6261
6454
|
# Container for elements related to a particular multipart upload. A
|
6262
|
-
# response can contain zero or more Upload elements.
|
6455
|
+
# response can contain zero or more `Upload` elements.
|
6263
6456
|
# @return [Array<Types::MultipartUpload>]
|
6264
6457
|
#
|
6265
6458
|
# @!attribute [rw] common_prefixes
|
6266
6459
|
# If you specify a delimiter in the request, then the result returns
|
6267
6460
|
# each distinct key prefix containing the delimiter in a
|
6268
|
-
# CommonPrefixes element. The distinct key prefixes are returned in
|
6269
|
-
# the Prefix child element.
|
6461
|
+
# `CommonPrefixes` element. The distinct key prefixes are returned in
|
6462
|
+
# the `Prefix` child element.
|
6270
6463
|
# @return [Array<Types::CommonPrefix>]
|
6271
6464
|
#
|
6272
6465
|
# @!attribute [rw] encoding_type
|
@@ -6313,6 +6506,19 @@ module Aws::S3
|
|
6313
6506
|
#
|
6314
6507
|
# @!attribute [rw] bucket
|
6315
6508
|
# Name of the bucket to which the multipart upload was initiated.
|
6509
|
+
#
|
6510
|
+
# When using this API with an access point, you must direct requests
|
6511
|
+
# to the access point hostname. The access point hostname takes the
|
6512
|
+
# form
|
6513
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6514
|
+
# When using this operation using an access point through the AWS
|
6515
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
6516
|
+
# For more information about access point ARNs, see [Using Access
|
6517
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
6518
|
+
#
|
6519
|
+
#
|
6520
|
+
#
|
6521
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
6316
6522
|
# @return [String]
|
6317
6523
|
#
|
6318
6524
|
# @!attribute [rw] delimiter
|
@@ -6369,7 +6575,7 @@ module Aws::S3
|
|
6369
6575
|
# upload-id-marker parameter is ignored. Otherwise, any multipart
|
6370
6576
|
# uploads for a key equal to the key-marker might be included in the
|
6371
6577
|
# list only if they have an upload ID lexicographically greater than
|
6372
|
-
# the specified upload-id-marker
|
6578
|
+
# the specified `upload-id-marker`.
|
6373
6579
|
# @return [String]
|
6374
6580
|
#
|
6375
6581
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploadsRequest AWS API Documentation
|
@@ -6386,32 +6592,32 @@ module Aws::S3
|
|
6386
6592
|
end
|
6387
6593
|
|
6388
6594
|
# @!attribute [rw] is_truncated
|
6389
|
-
# A flag that indicates whether
|
6390
|
-
#
|
6391
|
-
#
|
6392
|
-
#
|
6393
|
-
#
|
6595
|
+
# A flag that indicates whether Amazon S3 returned all of the results
|
6596
|
+
# that satisfied the search criteria. If your results were truncated,
|
6597
|
+
# you can make a follow-up paginated request using the NextKeyMarker
|
6598
|
+
# and NextVersionIdMarker response parameters as a starting place in
|
6599
|
+
# another request to return the rest of the results.
|
6394
6600
|
# @return [Boolean]
|
6395
6601
|
#
|
6396
6602
|
# @!attribute [rw] key_marker
|
6397
|
-
# Marks the last
|
6603
|
+
# Marks the last key returned in a truncated response.
|
6398
6604
|
# @return [String]
|
6399
6605
|
#
|
6400
6606
|
# @!attribute [rw] version_id_marker
|
6401
|
-
# Marks the last version of the
|
6607
|
+
# Marks the last version of the key returned in a truncated response.
|
6402
6608
|
# @return [String]
|
6403
6609
|
#
|
6404
6610
|
# @!attribute [rw] next_key_marker
|
6405
|
-
# When the number of responses exceeds the value of MaxKeys
|
6406
|
-
# NextKeyMarker specifies the first key not returned that satisfies
|
6611
|
+
# When the number of responses exceeds the value of `MaxKeys`,
|
6612
|
+
# `NextKeyMarker` specifies the first key not returned that satisfies
|
6407
6613
|
# the search criteria. Use this value for the key-marker request
|
6408
6614
|
# parameter in a subsequent request.
|
6409
6615
|
# @return [String]
|
6410
6616
|
#
|
6411
6617
|
# @!attribute [rw] next_version_id_marker
|
6412
|
-
# When the number of responses exceeds the value of MaxKeys
|
6413
|
-
# NextVersionIdMarker specifies the first object version not
|
6414
|
-
# that satisfies the search criteria. Use this value for the
|
6618
|
+
# When the number of responses exceeds the value of `MaxKeys`,
|
6619
|
+
# `NextVersionIdMarker` specifies the first object version not
|
6620
|
+
# returned that satisfies the search criteria. Use this value for the
|
6415
6621
|
# version-id-marker request parameter in a subsequent request.
|
6416
6622
|
# @return [String]
|
6417
6623
|
#
|
@@ -6424,7 +6630,7 @@ module Aws::S3
|
|
6424
6630
|
# @return [Array<Types::DeleteMarkerEntry>]
|
6425
6631
|
#
|
6426
6632
|
# @!attribute [rw] name
|
6427
|
-
# Bucket
|
6633
|
+
# Bucket name.
|
6428
6634
|
# @return [String]
|
6429
6635
|
#
|
6430
6636
|
# @!attribute [rw] prefix
|
@@ -6433,10 +6639,10 @@ module Aws::S3
|
|
6433
6639
|
# @return [String]
|
6434
6640
|
#
|
6435
6641
|
# @!attribute [rw] delimiter
|
6436
|
-
# The
|
6642
|
+
# The delimiter grouping the included keys. A delimiter is a character
|
6437
6643
|
# that you specify to group keys. All keys that contain the same
|
6438
6644
|
# string between the prefix and the first occurrence of the delimiter
|
6439
|
-
# are grouped under a single result element in CommonPrefixes
|
6645
|
+
# are grouped under a single result element in `CommonPrefixes`. These
|
6440
6646
|
# groups are counted as one result against the max-keys limitation.
|
6441
6647
|
# These keys are not returned elsewhere in the response.
|
6442
6648
|
# @return [String]
|
@@ -6494,7 +6700,20 @@ module Aws::S3
|
|
6494
6700
|
# }
|
6495
6701
|
#
|
6496
6702
|
# @!attribute [rw] bucket
|
6497
|
-
# The name
|
6703
|
+
# The bucket name that contains the objects.
|
6704
|
+
#
|
6705
|
+
# When using this API with an access point, you must direct requests
|
6706
|
+
# to the access point hostname. The access point hostname takes the
|
6707
|
+
# form
|
6708
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6709
|
+
# When using this operation using an access point through the AWS
|
6710
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
6711
|
+
# For more information about access point ARNs, see [Using Access
|
6712
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
6713
|
+
#
|
6714
|
+
#
|
6715
|
+
#
|
6716
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
6498
6717
|
# @return [String]
|
6499
6718
|
#
|
6500
6719
|
# @!attribute [rw] delimiter
|
@@ -6555,8 +6774,8 @@ module Aws::S3
|
|
6555
6774
|
end
|
6556
6775
|
|
6557
6776
|
# @!attribute [rw] is_truncated
|
6558
|
-
# A flag that indicates whether
|
6559
|
-
#
|
6777
|
+
# A flag that indicates whether Amazon S3 returned all of the results
|
6778
|
+
# that satisfied the search criteria.
|
6560
6779
|
# @return [Boolean]
|
6561
6780
|
#
|
6562
6781
|
# @!attribute [rw] marker
|
@@ -6580,7 +6799,7 @@ module Aws::S3
|
|
6580
6799
|
# @return [Array<Types::Object>]
|
6581
6800
|
#
|
6582
6801
|
# @!attribute [rw] name
|
6583
|
-
#
|
6802
|
+
# Bucket name.
|
6584
6803
|
# @return [String]
|
6585
6804
|
#
|
6586
6805
|
# @!attribute [rw] prefix
|
@@ -6590,9 +6809,9 @@ module Aws::S3
|
|
6590
6809
|
# @!attribute [rw] delimiter
|
6591
6810
|
# Causes keys that contain the same string between the prefix and the
|
6592
6811
|
# first occurrence of the delimiter to be rolled up into a single
|
6593
|
-
# result element in the CommonPrefixes collection. These rolled-up
|
6812
|
+
# result element in the `CommonPrefixes` collection. These rolled-up
|
6594
6813
|
# keys are not returned elsewhere in the response. Each rolled-up
|
6595
|
-
# result counts as only one return against the MaxKeys value.
|
6814
|
+
# result counts as only one return against the `MaxKeys` value.
|
6596
6815
|
# @return [String]
|
6597
6816
|
#
|
6598
6817
|
# @!attribute [rw] max_keys
|
@@ -6712,7 +6931,20 @@ module Aws::S3
|
|
6712
6931
|
# @return [Array<Types::Object>]
|
6713
6932
|
#
|
6714
6933
|
# @!attribute [rw] name
|
6715
|
-
#
|
6934
|
+
# Bucket name.
|
6935
|
+
#
|
6936
|
+
# When using this API with an access point, you must direct requests
|
6937
|
+
# to the access point hostname. The access point hostname takes the
|
6938
|
+
# form
|
6939
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6940
|
+
# When using this operation using an access point through the AWS
|
6941
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
6942
|
+
# For more information about access point ARNs, see [Using Access
|
6943
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
6944
|
+
#
|
6945
|
+
#
|
6946
|
+
#
|
6947
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
6716
6948
|
# @return [String]
|
6717
6949
|
#
|
6718
6950
|
# @!attribute [rw] prefix
|
@@ -6724,7 +6956,7 @@ module Aws::S3
|
|
6724
6956
|
# first occurrence of the delimiter to be rolled up into a single
|
6725
6957
|
# result element in the CommonPrefixes collection. These rolled-up
|
6726
6958
|
# keys are not returned elsewhere in the response. Each rolled-up
|
6727
|
-
# result counts as only one return against the MaxKeys value.
|
6959
|
+
# result counts as only one return against the `MaxKeys` value.
|
6728
6960
|
# @return [String]
|
6729
6961
|
#
|
6730
6962
|
# @!attribute [rw] max_keys
|
@@ -6775,11 +7007,11 @@ module Aws::S3
|
|
6775
7007
|
# @return [String]
|
6776
7008
|
#
|
6777
7009
|
# @!attribute [rw] next_continuation_token
|
6778
|
-
# NextContinuationToken is sent when isTruncated is true which
|
6779
|
-
# there are more keys in the bucket that can be listed. The next
|
6780
|
-
# requests to Amazon S3 can be continued with this
|
6781
|
-
# NextContinuationToken
|
6782
|
-
# not a real key
|
7010
|
+
# `NextContinuationToken` is sent when `isTruncated` is true, which
|
7011
|
+
# means there are more keys in the bucket that can be listed. The next
|
7012
|
+
# list requests to Amazon S3 can be continued with this
|
7013
|
+
# `NextContinuationToken`. `NextContinuationToken` is obfuscated and
|
7014
|
+
# is not a real key
|
6783
7015
|
# @return [String]
|
6784
7016
|
#
|
6785
7017
|
# @!attribute [rw] start_after
|
@@ -6821,7 +7053,20 @@ module Aws::S3
|
|
6821
7053
|
# }
|
6822
7054
|
#
|
6823
7055
|
# @!attribute [rw] bucket
|
6824
|
-
#
|
7056
|
+
# Bucket name to list.
|
7057
|
+
#
|
7058
|
+
# When using this API with an access point, you must direct requests
|
7059
|
+
# to the access point hostname. The access point hostname takes the
|
7060
|
+
# form
|
7061
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7062
|
+
# When using this operation using an access point through the AWS
|
7063
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
7064
|
+
# For more information about access point ARNs, see [Using Access
|
7065
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
7066
|
+
#
|
7067
|
+
#
|
7068
|
+
#
|
7069
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
6825
7070
|
# @return [String]
|
6826
7071
|
#
|
6827
7072
|
# @!attribute [rw] delimiter
|
@@ -6851,7 +7096,7 @@ module Aws::S3
|
|
6851
7096
|
# @!attribute [rw] fetch_owner
|
6852
7097
|
# The owner field is not present in listV2 by default, if you want to
|
6853
7098
|
# return owner field with each key in the result then set the fetch
|
6854
|
-
# owner field to true
|
7099
|
+
# owner field to true.
|
6855
7100
|
# @return [Boolean]
|
6856
7101
|
#
|
6857
7102
|
# @!attribute [rw] start_after
|
@@ -6890,7 +7135,7 @@ module Aws::S3
|
|
6890
7135
|
# [Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle
|
6891
7136
|
# Policy][1].
|
6892
7137
|
#
|
6893
|
-
# The response will also include the x-amz-abort-rule-id header that
|
7138
|
+
# The response will also include the `x-amz-abort-rule-id` header that
|
6894
7139
|
# will provide the ID of the lifecycle configuration rule that defines
|
6895
7140
|
# this action.
|
6896
7141
|
#
|
@@ -6900,7 +7145,7 @@ module Aws::S3
|
|
6900
7145
|
# @return [Time]
|
6901
7146
|
#
|
6902
7147
|
# @!attribute [rw] abort_rule_id
|
6903
|
-
# This header is returned along with the x-amz-abort-date header. It
|
7148
|
+
# This header is returned along with the `x-amz-abort-date` header. It
|
6904
7149
|
# identifies applicable lifecycle configuration rule that defines the
|
6905
7150
|
# action to abort incomplete multipart uploads.
|
6906
7151
|
# @return [String]
|
@@ -6943,14 +7188,14 @@ module Aws::S3
|
|
6943
7188
|
#
|
6944
7189
|
# @!attribute [rw] parts
|
6945
7190
|
# Container for elements related to a particular part. A response can
|
6946
|
-
# contain zero or more Part elements.
|
7191
|
+
# contain zero or more `Part` elements.
|
6947
7192
|
# @return [Array<Types::Part>]
|
6948
7193
|
#
|
6949
7194
|
# @!attribute [rw] initiator
|
6950
7195
|
# Container element that identifies who initiated the multipart
|
6951
7196
|
# upload. If the initiator is an AWS account, this element provides
|
6952
|
-
# the same information as the Owner element. If the initiator is an
|
6953
|
-
# IAM User,
|
7197
|
+
# the same information as the `Owner` element. If the initiator is an
|
7198
|
+
# IAM User, this element provides the user ARN and display name.
|
6954
7199
|
# @return [Types::Initiator]
|
6955
7200
|
#
|
6956
7201
|
# @!attribute [rw] owner
|
@@ -7002,7 +7247,20 @@ module Aws::S3
|
|
7002
7247
|
# }
|
7003
7248
|
#
|
7004
7249
|
# @!attribute [rw] bucket
|
7005
|
-
# Name of the bucket to which the parts are being uploaded
|
7250
|
+
# Name of the bucket to which the parts are being uploaded.
|
7251
|
+
#
|
7252
|
+
# When using this API with an access point, you must direct requests
|
7253
|
+
# to the access point hostname. The access point hostname takes the
|
7254
|
+
# form
|
7255
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7256
|
+
# When using this operation using an access point through the AWS
|
7257
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
7258
|
+
# For more information about access point ARNs, see [Using Access
|
7259
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
7260
|
+
#
|
7261
|
+
#
|
7262
|
+
#
|
7263
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
7006
7264
|
# @return [String]
|
7007
7265
|
#
|
7008
7266
|
# @!attribute [rw] key
|
@@ -7026,9 +7284,13 @@ module Aws::S3
|
|
7026
7284
|
# @!attribute [rw] request_payer
|
7027
7285
|
# Confirms that the requester knows that she or he will be charged for
|
7028
7286
|
# the request. Bucket owners need not specify this parameter in their
|
7029
|
-
# requests.
|
7030
|
-
# buckets
|
7031
|
-
#
|
7287
|
+
# requests. For information about downloading objects from Requester
|
7288
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
7289
|
+
# in the *Amazon S3 Developer Guide*.
|
7290
|
+
#
|
7291
|
+
#
|
7292
|
+
#
|
7293
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
7032
7294
|
# @return [String]
|
7033
7295
|
#
|
7034
7296
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListPartsRequest AWS API Documentation
|
@@ -7077,8 +7339,8 @@ module Aws::S3
|
|
7077
7339
|
# logs. You can have your logs delivered to any bucket that you own,
|
7078
7340
|
# including the same bucket that is being logged. You can also
|
7079
7341
|
# configure multiple buckets to deliver their logs to the same target
|
7080
|
-
# bucket. In this case you should choose a different TargetPrefix
|
7081
|
-
# each source bucket so that the delivered log files can be
|
7342
|
+
# bucket. In this case, you should choose a different `TargetPrefix`
|
7343
|
+
# for each source bucket so that the delivered log files can be
|
7082
7344
|
# distinguished by key.
|
7083
7345
|
# @return [String]
|
7084
7346
|
#
|
@@ -7127,11 +7389,9 @@ module Aws::S3
|
|
7127
7389
|
include Aws::Structure
|
7128
7390
|
end
|
7129
7391
|
|
7130
|
-
# A container specifying replication metrics-related
|
7131
|
-
#
|
7132
|
-
#
|
7133
|
-
# to specific metrics or events. Must be specified together with a
|
7134
|
-
# `ReplicationTime` block.
|
7392
|
+
# A container specifying replication metrics-related settings enabling
|
7393
|
+
# metrics and Amazon S3 events for S3 Replication Time Control (S3 RTC).
|
7394
|
+
# Must be specified together with a `ReplicationTime` block.
|
7135
7395
|
#
|
7136
7396
|
# @note When making an API call, you may pass Metrics
|
7137
7397
|
# data as a hash:
|
@@ -7295,7 +7555,7 @@ module Aws::S3
|
|
7295
7555
|
include Aws::Structure
|
7296
7556
|
end
|
7297
7557
|
|
7298
|
-
# Container for the MultipartUpload for the Amazon S3 object.
|
7558
|
+
# Container for the `MultipartUpload` for the Amazon S3 object.
|
7299
7559
|
#
|
7300
7560
|
# @!attribute [rw] upload_id
|
7301
7561
|
# Upload ID that identifies the multipart upload.
|
@@ -7351,8 +7611,8 @@ module Aws::S3
|
|
7351
7611
|
# Specifies the number of days an object is noncurrent before Amazon
|
7352
7612
|
# S3 can perform the associated action. For information about the
|
7353
7613
|
# noncurrent days calculations, see [How Amazon S3 Calculates When an
|
7354
|
-
# Object Became Noncurrent][1] in the Amazon Simple Storage Service
|
7355
|
-
# Developer Guide
|
7614
|
+
# Object Became Noncurrent][1] in the *Amazon Simple Storage Service
|
7615
|
+
# Developer Guide*.
|
7356
7616
|
#
|
7357
7617
|
#
|
7358
7618
|
#
|
@@ -7386,13 +7646,13 @@ module Aws::S3
|
|
7386
7646
|
# @!attribute [rw] noncurrent_days
|
7387
7647
|
# Specifies the number of days an object is noncurrent before Amazon
|
7388
7648
|
# S3 can perform the associated action. For information about the
|
7389
|
-
# noncurrent days calculations, see [How Amazon S3 Calculates
|
7390
|
-
# Object
|
7391
|
-
# Developer Guide*.
|
7649
|
+
# noncurrent days calculations, see [How Amazon S3 Calculates How Long
|
7650
|
+
# an Object Has Been Noncurrent][1] in the *Amazon Simple Storage
|
7651
|
+
# Service Developer Guide*.
|
7392
7652
|
#
|
7393
7653
|
#
|
7394
7654
|
#
|
7395
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
7655
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations
|
7396
7656
|
# @return [Integer]
|
7397
7657
|
#
|
7398
7658
|
# @!attribute [rw] storage_class
|
@@ -7518,7 +7778,7 @@ module Aws::S3
|
|
7518
7778
|
# }
|
7519
7779
|
#
|
7520
7780
|
# @!attribute [rw] topic_configuration
|
7521
|
-
# This data type is
|
7781
|
+
# This data type is deprecated. A container for specifying the
|
7522
7782
|
# configuration for publication of messages to an Amazon Simple
|
7523
7783
|
# Notification Service (Amazon SNS) topic when Amazon S3 detects
|
7524
7784
|
# specified events.
|
@@ -7749,7 +8009,7 @@ module Aws::S3
|
|
7749
8009
|
# The version of an object.
|
7750
8010
|
#
|
7751
8011
|
# @!attribute [rw] etag
|
7752
|
-
# The entity tag is an MD5 hash of that version of the object
|
8012
|
+
# The entity tag is an MD5 hash of that version of the object.
|
7753
8013
|
# @return [String]
|
7754
8014
|
#
|
7755
8015
|
# @!attribute [rw] size
|
@@ -7778,7 +8038,7 @@ module Aws::S3
|
|
7778
8038
|
# @return [Time]
|
7779
8039
|
#
|
7780
8040
|
# @!attribute [rw] owner
|
7781
|
-
# Specifies the
|
8041
|
+
# Specifies the owner of the object.
|
7782
8042
|
# @return [Types::Owner]
|
7783
8043
|
#
|
7784
8044
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectVersion AWS API Documentation
|
@@ -7886,7 +8146,7 @@ module Aws::S3
|
|
7886
8146
|
include Aws::Structure
|
7887
8147
|
end
|
7888
8148
|
|
7889
|
-
# Container for the owner's display name and ID
|
8149
|
+
# Container for the owner's display name and ID.
|
7890
8150
|
#
|
7891
8151
|
# @note When making an API call, you may pass Owner
|
7892
8152
|
# data as a hash:
|
@@ -7897,11 +8157,11 @@ module Aws::S3
|
|
7897
8157
|
# }
|
7898
8158
|
#
|
7899
8159
|
# @!attribute [rw] display_name
|
7900
|
-
# Container for the display name of the owner
|
8160
|
+
# Container for the display name of the owner.
|
7901
8161
|
# @return [String]
|
7902
8162
|
#
|
7903
8163
|
# @!attribute [rw] id
|
7904
|
-
# Container for the ID of the owner
|
8164
|
+
# Container for the ID of the owner.
|
7905
8165
|
# @return [String]
|
7906
8166
|
#
|
7907
8167
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Owner AWS API Documentation
|
@@ -8005,11 +8265,11 @@ module Aws::S3
|
|
8005
8265
|
# Amazon S3 bucket. You can enable the configuration options in any
|
8006
8266
|
# combination. For more information about when Amazon S3 considers a
|
8007
8267
|
# bucket or object public, see [The Meaning of "Public"][1] in the
|
8008
|
-
# Amazon Simple Storage Service Developer Guide
|
8268
|
+
# *Amazon Simple Storage Service Developer Guide*.
|
8009
8269
|
#
|
8010
8270
|
#
|
8011
8271
|
#
|
8012
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
8272
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status
|
8013
8273
|
#
|
8014
8274
|
# @note When making an API call, you may pass PublicAccessBlockConfiguration
|
8015
8275
|
# data as a hash:
|
@@ -8284,8 +8544,8 @@ module Aws::S3
|
|
8284
8544
|
# @!attribute [rw] cors_configuration
|
8285
8545
|
# Describes the cross-origin access configuration for objects in an
|
8286
8546
|
# Amazon S3 bucket. For more information, see [Enabling Cross-Origin
|
8287
|
-
# Resource Sharing][1] in the Amazon Simple Storage Service Developer
|
8288
|
-
# Guide
|
8547
|
+
# Resource Sharing][1] in the *Amazon Simple Storage Service Developer
|
8548
|
+
# Guide*.
|
8289
8549
|
#
|
8290
8550
|
#
|
8291
8551
|
#
|
@@ -8980,7 +9240,7 @@ module Aws::S3
|
|
8980
9240
|
# @return [String]
|
8981
9241
|
#
|
8982
9242
|
# @!attribute [rw] tagging
|
8983
|
-
# Container for the TagSet and Tag elements.
|
9243
|
+
# Container for the `TagSet` and `Tag` elements.
|
8984
9244
|
# @return [Types::Tagging]
|
8985
9245
|
#
|
8986
9246
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketTaggingRequest AWS API Documentation
|
@@ -9152,7 +9412,7 @@ module Aws::S3
|
|
9152
9412
|
#
|
9153
9413
|
# @!attribute [rw] acl
|
9154
9414
|
# The canned ACL to apply to the object. For more information, see
|
9155
|
-
# [Canned ACL][1]
|
9415
|
+
# [Canned ACL][1].
|
9156
9416
|
#
|
9157
9417
|
#
|
9158
9418
|
#
|
@@ -9165,7 +9425,21 @@ module Aws::S3
|
|
9165
9425
|
# @return [Types::AccessControlPolicy]
|
9166
9426
|
#
|
9167
9427
|
# @!attribute [rw] bucket
|
9168
|
-
# The name
|
9428
|
+
# The bucket name that contains the object to which you want to attach
|
9429
|
+
# the ACL.
|
9430
|
+
#
|
9431
|
+
# When using this API with an access point, you must direct requests
|
9432
|
+
# to the access point hostname. The access point hostname takes the
|
9433
|
+
# form
|
9434
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
9435
|
+
# When using this operation using an access point through the AWS
|
9436
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
9437
|
+
# For more information about access point ARNs, see [Using Access
|
9438
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
9439
|
+
#
|
9440
|
+
#
|
9441
|
+
#
|
9442
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
9169
9443
|
# @return [String]
|
9170
9444
|
#
|
9171
9445
|
# @!attribute [rw] content_md5
|
@@ -9208,9 +9482,13 @@ module Aws::S3
|
|
9208
9482
|
# @!attribute [rw] request_payer
|
9209
9483
|
# Confirms that the requester knows that she or he will be charged for
|
9210
9484
|
# the request. Bucket owners need not specify this parameter in their
|
9211
|
-
# requests.
|
9212
|
-
# buckets
|
9213
|
-
#
|
9485
|
+
# requests. For information about downloading objects from Requester
|
9486
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
9487
|
+
# in the *Amazon S3 Developer Guide*.
|
9488
|
+
#
|
9489
|
+
#
|
9490
|
+
#
|
9491
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
9214
9492
|
# @return [String]
|
9215
9493
|
#
|
9216
9494
|
# @!attribute [rw] version_id
|
@@ -9262,8 +9540,21 @@ module Aws::S3
|
|
9262
9540
|
# }
|
9263
9541
|
#
|
9264
9542
|
# @!attribute [rw] bucket
|
9265
|
-
# The bucket containing the object that you want to place a Legal
|
9266
|
-
# on.
|
9543
|
+
# The bucket name containing the object that you want to place a Legal
|
9544
|
+
# Hold on.
|
9545
|
+
#
|
9546
|
+
# When using this API with an access point, you must direct requests
|
9547
|
+
# to the access point hostname. The access point hostname takes the
|
9548
|
+
# form
|
9549
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
9550
|
+
# When using this operation using an access point through the AWS
|
9551
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
9552
|
+
# For more information about access point ARNs, see [Using Access
|
9553
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
9554
|
+
#
|
9555
|
+
#
|
9556
|
+
#
|
9557
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
9267
9558
|
# @return [String]
|
9268
9559
|
#
|
9269
9560
|
# @!attribute [rw] key
|
@@ -9278,9 +9569,13 @@ module Aws::S3
|
|
9278
9569
|
# @!attribute [rw] request_payer
|
9279
9570
|
# Confirms that the requester knows that she or he will be charged for
|
9280
9571
|
# the request. Bucket owners need not specify this parameter in their
|
9281
|
-
# requests.
|
9282
|
-
# buckets
|
9283
|
-
#
|
9572
|
+
# requests. For information about downloading objects from Requester
|
9573
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
9574
|
+
# in the *Amazon S3 Developer Guide*.
|
9575
|
+
#
|
9576
|
+
#
|
9577
|
+
#
|
9578
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
9284
9579
|
# @return [String]
|
9285
9580
|
#
|
9286
9581
|
# @!attribute [rw] version_id
|
@@ -9348,9 +9643,13 @@ module Aws::S3
|
|
9348
9643
|
# @!attribute [rw] request_payer
|
9349
9644
|
# Confirms that the requester knows that she or he will be charged for
|
9350
9645
|
# the request. Bucket owners need not specify this parameter in their
|
9351
|
-
# requests.
|
9352
|
-
# buckets
|
9353
|
-
#
|
9646
|
+
# requests. For information about downloading objects from Requester
|
9647
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
9648
|
+
# in the *Amazon S3 Developer Guide*.
|
9649
|
+
#
|
9650
|
+
#
|
9651
|
+
#
|
9652
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
9354
9653
|
# @return [String]
|
9355
9654
|
#
|
9356
9655
|
# @!attribute [rw] token
|
@@ -9404,14 +9703,14 @@ module Aws::S3
|
|
9404
9703
|
# @!attribute [rw] sse_customer_key_md5
|
9405
9704
|
# If server-side encryption with a customer-provided encryption key
|
9406
9705
|
# was requested, the response will include this header to provide
|
9407
|
-
# round
|
9706
|
+
# round-trip message integrity verification of the customer-provided
|
9408
9707
|
# encryption key.
|
9409
9708
|
# @return [String]
|
9410
9709
|
#
|
9411
9710
|
# @!attribute [rw] ssekms_key_id
|
9412
|
-
# If
|
9413
|
-
# aws:kms
|
9414
|
-
# Service (KMS) customer master key (CMK) that was used for the
|
9711
|
+
# If `x-amz-server-side-encryption` is present and has the value of
|
9712
|
+
# `aws:kms`, this header specifies the ID of the AWS Key Management
|
9713
|
+
# Service (AWS KMS) customer master key (CMK) that was used for the
|
9415
9714
|
# object.
|
9416
9715
|
# @return [String]
|
9417
9716
|
#
|
@@ -9494,7 +9793,20 @@ module Aws::S3
|
|
9494
9793
|
# @return [IO]
|
9495
9794
|
#
|
9496
9795
|
# @!attribute [rw] bucket
|
9497
|
-
#
|
9796
|
+
# Bucket name to which the PUT operation was initiated.
|
9797
|
+
#
|
9798
|
+
# When using this API with an access point, you must direct requests
|
9799
|
+
# to the access point hostname. The access point hostname takes the
|
9800
|
+
# form
|
9801
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
9802
|
+
# When using this operation using an access point through the AWS
|
9803
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
9804
|
+
# For more information about access point ARNs, see [Using Access
|
9805
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
9806
|
+
#
|
9807
|
+
#
|
9808
|
+
#
|
9809
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
9498
9810
|
# @return [String]
|
9499
9811
|
#
|
9500
9812
|
# @!attribute [rw] cache_control
|
@@ -9604,8 +9916,8 @@ module Aws::S3
|
|
9604
9916
|
# @return [Hash<String,String>]
|
9605
9917
|
#
|
9606
9918
|
# @!attribute [rw] server_side_encryption
|
9607
|
-
# The
|
9608
|
-
# in S3 (
|
9919
|
+
# The server-side encryption algorithm used when storing this object
|
9920
|
+
# in Amazon S3 (for example, AES256, aws:kms).
|
9609
9921
|
# @return [String]
|
9610
9922
|
#
|
9611
9923
|
# @!attribute [rw] storage_class
|
@@ -9617,7 +9929,8 @@ module Aws::S3
|
|
9617
9929
|
# If the bucket is configured as a website, redirects requests for
|
9618
9930
|
# this object to another object in the same bucket or to an external
|
9619
9931
|
# URL. Amazon S3 stores the value of this header in the object
|
9620
|
-
# metadata. For information about object metadata, see
|
9932
|
+
# metadata. For information about object metadata, see [Object Key and
|
9933
|
+
# Metadata][1].
|
9621
9934
|
#
|
9622
9935
|
# In the following example, the request header sets the redirect to an
|
9623
9936
|
# object (anotherPage.html) in the same bucket:
|
@@ -9630,45 +9943,46 @@ module Aws::S3
|
|
9630
9943
|
# `x-amz-website-redirect-location: http://www.example.com/`
|
9631
9944
|
#
|
9632
9945
|
# For more information about website hosting in Amazon S3, see
|
9633
|
-
# [Hosting Websites on Amazon S3][
|
9634
|
-
# Page Redirects][
|
9946
|
+
# [Hosting Websites on Amazon S3][2] and [How to Configure Website
|
9947
|
+
# Page Redirects][3].
|
9635
9948
|
#
|
9636
9949
|
#
|
9637
9950
|
#
|
9638
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
9639
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
9951
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html
|
9952
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
|
9953
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html
|
9640
9954
|
# @return [String]
|
9641
9955
|
#
|
9642
9956
|
# @!attribute [rw] sse_customer_algorithm
|
9643
|
-
# Specifies the algorithm to use to when encrypting the object (
|
9644
|
-
# AES256).
|
9957
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
9958
|
+
# example, AES256).
|
9645
9959
|
# @return [String]
|
9646
9960
|
#
|
9647
9961
|
# @!attribute [rw] sse_customer_key
|
9648
9962
|
# Specifies the customer-provided encryption key for Amazon S3 to use
|
9649
9963
|
# in encrypting data. This value is used to store the object and then
|
9650
|
-
# it is discarded; Amazon does not store the encryption key. The
|
9651
|
-
# must be appropriate for use with the algorithm specified in the
|
9652
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
9964
|
+
# it is discarded; Amazon S3 does not store the encryption key. The
|
9965
|
+
# key must be appropriate for use with the algorithm specified in the
|
9966
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
9653
9967
|
# @return [String]
|
9654
9968
|
#
|
9655
9969
|
# @!attribute [rw] sse_customer_key_md5
|
9656
9970
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
9657
9971
|
# RFC 1321. Amazon S3 uses this header for a message integrity check
|
9658
|
-
# to ensure the encryption key was transmitted without error.
|
9972
|
+
# to ensure that the encryption key was transmitted without error.
|
9659
9973
|
# @return [String]
|
9660
9974
|
#
|
9661
9975
|
# @!attribute [rw] ssekms_key_id
|
9662
|
-
# If
|
9663
|
-
# aws:kms
|
9976
|
+
# If `x-amz-server-side-encryption` is present and has the value of
|
9977
|
+
# `aws:kms`, this header specifies the ID of the AWS Key Management
|
9664
9978
|
# Service (AWS KMS) customer master key (CMK) that was used for the
|
9665
9979
|
# object.
|
9666
9980
|
#
|
9667
|
-
# If the value of x-amz-server-side-encryption is aws:kms
|
9668
|
-
# specifies the ID of the AWS KMS CMK that will be used for the
|
9669
|
-
# object. If you specify x-amz-server-side-encryption:aws:kms
|
9670
|
-
# not provide x-amz-server-side-encryption-aws-kms-key-id
|
9671
|
-
# uses the AWS managed CMK in AWS to protect the data.
|
9981
|
+
# If the value of `x-amz-server-side-encryption` is `aws:kms`, this
|
9982
|
+
# header specifies the ID of the AWS KMS CMK that will be used for the
|
9983
|
+
# object. If you specify `x-amz-server-side-encryption:aws:kms`, but
|
9984
|
+
# do not provide` x-amz-server-side-encryption-aws-kms-key-id`, Amazon
|
9985
|
+
# S3 uses the AWS managed CMK in AWS to protect the data.
|
9672
9986
|
# @return [String]
|
9673
9987
|
#
|
9674
9988
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -9680,9 +9994,13 @@ module Aws::S3
|
|
9680
9994
|
# @!attribute [rw] request_payer
|
9681
9995
|
# Confirms that the requester knows that she or he will be charged for
|
9682
9996
|
# the request. Bucket owners need not specify this parameter in their
|
9683
|
-
# requests.
|
9684
|
-
# buckets
|
9685
|
-
#
|
9997
|
+
# requests. For information about downloading objects from Requester
|
9998
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
9999
|
+
# in the *Amazon S3 Developer Guide*.
|
10000
|
+
#
|
10001
|
+
#
|
10002
|
+
#
|
10003
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
9686
10004
|
# @return [String]
|
9687
10005
|
#
|
9688
10006
|
# @!attribute [rw] tagging
|
@@ -9773,8 +10091,21 @@ module Aws::S3
|
|
9773
10091
|
# }
|
9774
10092
|
#
|
9775
10093
|
# @!attribute [rw] bucket
|
9776
|
-
# The bucket that contains the object you want to apply this
|
9777
|
-
# Retention configuration to.
|
10094
|
+
# The bucket name that contains the object you want to apply this
|
10095
|
+
# Object Retention configuration to.
|
10096
|
+
#
|
10097
|
+
# When using this API with an access point, you must direct requests
|
10098
|
+
# to the access point hostname. The access point hostname takes the
|
10099
|
+
# form
|
10100
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
10101
|
+
# When using this operation using an access point through the AWS
|
10102
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
10103
|
+
# For more information about access point ARNs, see [Using Access
|
10104
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
10105
|
+
#
|
10106
|
+
#
|
10107
|
+
#
|
10108
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
9778
10109
|
# @return [String]
|
9779
10110
|
#
|
9780
10111
|
# @!attribute [rw] key
|
@@ -9789,9 +10120,13 @@ module Aws::S3
|
|
9789
10120
|
# @!attribute [rw] request_payer
|
9790
10121
|
# Confirms that the requester knows that she or he will be charged for
|
9791
10122
|
# the request. Bucket owners need not specify this parameter in their
|
9792
|
-
# requests.
|
9793
|
-
# buckets
|
9794
|
-
#
|
10123
|
+
# requests. For information about downloading objects from Requester
|
10124
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
10125
|
+
# in the *Amazon S3 Developer Guide*.
|
10126
|
+
#
|
10127
|
+
#
|
10128
|
+
#
|
10129
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
9795
10130
|
# @return [String]
|
9796
10131
|
#
|
9797
10132
|
# @!attribute [rw] version_id
|
@@ -9851,7 +10186,20 @@ module Aws::S3
|
|
9851
10186
|
# }
|
9852
10187
|
#
|
9853
10188
|
# @!attribute [rw] bucket
|
9854
|
-
# The bucket containing the object.
|
10189
|
+
# The bucket name containing the object.
|
10190
|
+
#
|
10191
|
+
# When using this API with an access point, you must direct requests
|
10192
|
+
# to the access point hostname. The access point hostname takes the
|
10193
|
+
# form
|
10194
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
10195
|
+
# When using this operation using an access point through the AWS
|
10196
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
10197
|
+
# For more information about access point ARNs, see [Using Access
|
10198
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
10199
|
+
#
|
10200
|
+
#
|
10201
|
+
#
|
10202
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
9855
10203
|
# @return [String]
|
9856
10204
|
#
|
9857
10205
|
# @!attribute [rw] key
|
@@ -9867,7 +10215,7 @@ module Aws::S3
|
|
9867
10215
|
# @return [String]
|
9868
10216
|
#
|
9869
10217
|
# @!attribute [rw] tagging
|
9870
|
-
# Container for the TagSet and Tag elements
|
10218
|
+
# Container for the `TagSet` and `Tag` elements
|
9871
10219
|
# @return [Types::Tagging]
|
9872
10220
|
#
|
9873
10221
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectTaggingRequest AWS API Documentation
|
@@ -9961,7 +10309,7 @@ module Aws::S3
|
|
9961
10309
|
# @return [String]
|
9962
10310
|
#
|
9963
10311
|
# @!attribute [rw] events
|
9964
|
-
# A collection of bucket events for which to send
|
10312
|
+
# A collection of bucket events for which to send notifications
|
9965
10313
|
# @return [Array<String>]
|
9966
10314
|
#
|
9967
10315
|
# @!attribute [rw] filter
|
@@ -9984,10 +10332,10 @@ module Aws::S3
|
|
9984
10332
|
include Aws::Structure
|
9985
10333
|
end
|
9986
10334
|
|
9987
|
-
# This data type is deprecated.
|
9988
|
-
#
|
9989
|
-
#
|
9990
|
-
#
|
10335
|
+
# This data type is deprecated. Use QueueConfiguration for the same
|
10336
|
+
# purposes. This data type specifies the configuration for publishing
|
10337
|
+
# messages to an Amazon Simple Queue Service (Amazon SQS) queue when
|
10338
|
+
# Amazon S3 detects specified events.
|
9991
10339
|
#
|
9992
10340
|
# @note When making an API call, you may pass QueueConfigurationDeprecated
|
9993
10341
|
# data as a hash:
|
@@ -10010,7 +10358,7 @@ module Aws::S3
|
|
10010
10358
|
# @return [String]
|
10011
10359
|
#
|
10012
10360
|
# @!attribute [rw] events
|
10013
|
-
# A collection of bucket events for which to send
|
10361
|
+
# A collection of bucket events for which to send notifications
|
10014
10362
|
# @return [Array<String>]
|
10015
10363
|
#
|
10016
10364
|
# @!attribute [rw] queue
|
@@ -10295,19 +10643,19 @@ module Aws::S3
|
|
10295
10643
|
# same object based on a specified filter, the rule with higher
|
10296
10644
|
# priority takes precedence. For example:
|
10297
10645
|
#
|
10298
|
-
# * Same object quality prefix
|
10646
|
+
# * Same object quality prefix-based filter criteria if prefixes you
|
10299
10647
|
# specified in multiple rules overlap
|
10300
10648
|
#
|
10301
|
-
# * Same object qualify tag
|
10649
|
+
# * Same object qualify tag-based filter criteria specified in
|
10302
10650
|
# multiple rules
|
10303
10651
|
#
|
10304
10652
|
# For more information, see [Replication](
|
10305
10653
|
# https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in
|
10306
|
-
# the *Amazon
|
10654
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
10307
10655
|
# @return [Integer]
|
10308
10656
|
#
|
10309
10657
|
# @!attribute [rw] prefix
|
10310
|
-
# An object
|
10658
|
+
# An object key name prefix that identifies the object or objects to
|
10311
10659
|
# which the rule applies. The maximum prefix length is 1,024
|
10312
10660
|
# characters. To include all objects in a bucket, specify an empty
|
10313
10661
|
# string.
|
@@ -10333,13 +10681,12 @@ module Aws::S3
|
|
10333
10681
|
# @return [Types::SourceSelectionCriteria]
|
10334
10682
|
#
|
10335
10683
|
# @!attribute [rw] existing_object_replication
|
10336
|
-
# A container that specifies information about existing object
|
10337
|
-
# replication. You can choose whether to enable or disable the
|
10338
|
-
# replication of existing objects.
|
10339
10684
|
# @return [Types::ExistingObjectReplication]
|
10340
10685
|
#
|
10341
10686
|
# @!attribute [rw] destination
|
10342
|
-
# A container for information about the replication destination
|
10687
|
+
# A container for information about the replication destination and
|
10688
|
+
# its configurations including enabling the S3 Replication Time
|
10689
|
+
# Control (S3 RTC).
|
10343
10690
|
# @return [Types::Destination]
|
10344
10691
|
#
|
10345
10692
|
# @!attribute [rw] delete_marker_replication
|
@@ -10351,9 +10698,9 @@ module Aws::S3
|
|
10351
10698
|
# <Status>Disabled</Status>. For an example configuration,
|
10352
10699
|
# see [Basic Rule Configuration][1].
|
10353
10700
|
#
|
10354
|
-
# <note markdown="1"> If you don't specify the Filter element, Amazon S3 assumes
|
10355
|
-
# replication configuration is the earlier version, V1. In the
|
10356
|
-
# version, Amazon S3 handled replication of delete markers
|
10701
|
+
# <note markdown="1"> If you don't specify the `Filter` element, Amazon S3 assumes that
|
10702
|
+
# the replication configuration is the earlier version, V1. In the
|
10703
|
+
# earlier version, Amazon S3 handled replication of delete markers
|
10357
10704
|
# differently. For more information, see [Backward Compatibility][2].
|
10358
10705
|
#
|
10359
10706
|
# </note>
|
@@ -10385,11 +10732,11 @@ module Aws::S3
|
|
10385
10732
|
#
|
10386
10733
|
# For example:
|
10387
10734
|
#
|
10388
|
-
# * If you specify both a Prefix and a Tag filter, wrap these
|
10389
|
-
# an And tag.
|
10735
|
+
# * If you specify both a `Prefix` and a `Tag` filter, wrap these
|
10736
|
+
# filters in an `And` tag.
|
10390
10737
|
#
|
10391
|
-
# * If you specify a filter based on multiple tags, wrap the Tag
|
10392
|
-
# elements in an And tag
|
10738
|
+
# * If you specify a filter based on multiple tags, wrap the `Tag`
|
10739
|
+
# elements in an `And` tag
|
10393
10740
|
#
|
10394
10741
|
# @note When making an API call, you may pass ReplicationRuleAndOperator
|
10395
10742
|
# data as a hash:
|
@@ -10405,7 +10752,7 @@ module Aws::S3
|
|
10405
10752
|
# }
|
10406
10753
|
#
|
10407
10754
|
# @!attribute [rw] prefix
|
10408
|
-
# An object
|
10755
|
+
# An object key name prefix that identifies the subset of objects to
|
10409
10756
|
# which the rule applies.
|
10410
10757
|
# @return [String]
|
10411
10758
|
#
|
@@ -10446,7 +10793,7 @@ module Aws::S3
|
|
10446
10793
|
# }
|
10447
10794
|
#
|
10448
10795
|
# @!attribute [rw] prefix
|
10449
|
-
# An object
|
10796
|
+
# An object key name prefix that identifies the subset of objects to
|
10450
10797
|
# which the rule applies.
|
10451
10798
|
# @return [String]
|
10452
10799
|
#
|
@@ -10477,9 +10824,10 @@ module Aws::S3
|
|
10477
10824
|
include Aws::Structure
|
10478
10825
|
end
|
10479
10826
|
|
10480
|
-
# A container specifying
|
10481
|
-
#
|
10482
|
-
#
|
10827
|
+
# A container specifying S3 Replication Time Control (S3 RTC) related
|
10828
|
+
# information, including whether S3 RTC is enabled and the time when all
|
10829
|
+
# objects and operations on objects must be replicated. Must be
|
10830
|
+
# specified together with a `Metrics` block.
|
10483
10831
|
#
|
10484
10832
|
# @note When making an API call, you may pass ReplicationTime
|
10485
10833
|
# data as a hash:
|
@@ -10496,8 +10844,8 @@ module Aws::S3
|
|
10496
10844
|
# @return [String]
|
10497
10845
|
#
|
10498
10846
|
# @!attribute [rw] time
|
10499
|
-
# A container specifying the time by which replication should
|
10500
|
-
# for all objects and operations on objects.
|
10847
|
+
# A container specifying the time by which replication should be
|
10848
|
+
# complete for all objects and operations on objects.
|
10501
10849
|
# @return [Types::ReplicationTimeValue]
|
10502
10850
|
#
|
10503
10851
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ReplicationTime AWS API Documentation
|
@@ -10508,7 +10856,8 @@ module Aws::S3
|
|
10508
10856
|
include Aws::Structure
|
10509
10857
|
end
|
10510
10858
|
|
10511
|
-
# A container specifying the time value
|
10859
|
+
# A container specifying the time value for S3 Replication Time Control
|
10860
|
+
# (S3 RTC) and replication metrics `EventThreshold`.
|
10512
10861
|
#
|
10513
10862
|
# @note When making an API call, you may pass ReplicationTimeValue
|
10514
10863
|
# data as a hash:
|
@@ -10519,6 +10868,8 @@ module Aws::S3
|
|
10519
10868
|
#
|
10520
10869
|
# @!attribute [rw] minutes
|
10521
10870
|
# Contains an integer specifying time in minutes.
|
10871
|
+
#
|
10872
|
+
# Valid values: 15 minutes.
|
10522
10873
|
# @return [Integer]
|
10523
10874
|
#
|
10524
10875
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ReplicationTimeValue AWS API Documentation
|
@@ -10548,8 +10899,8 @@ module Aws::S3
|
|
10548
10899
|
include Aws::Structure
|
10549
10900
|
end
|
10550
10901
|
|
10551
|
-
# Container for
|
10552
|
-
# sent.
|
10902
|
+
# Container for specifying if periodic `QueryProgress` messages should
|
10903
|
+
# be sent.
|
10553
10904
|
#
|
10554
10905
|
# @note When making an API call, you may pass RequestProgress
|
10555
10906
|
# data as a hash:
|
@@ -10680,7 +11031,20 @@ module Aws::S3
|
|
10680
11031
|
# }
|
10681
11032
|
#
|
10682
11033
|
# @!attribute [rw] bucket
|
10683
|
-
# The bucket name.
|
11034
|
+
# The bucket name or containing the object to restore.
|
11035
|
+
#
|
11036
|
+
# When using this API with an access point, you must direct requests
|
11037
|
+
# to the access point hostname. The access point hostname takes the
|
11038
|
+
# form
|
11039
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11040
|
+
# When using this operation using an access point through the AWS
|
11041
|
+
# SDKs, you provide the access point ARN in place of the bucket name.
|
11042
|
+
# For more information about access point ARNs, see [Using Access
|
11043
|
+
# Points][1] in the *Amazon Simple Storage Service Developer Guide*.
|
11044
|
+
#
|
11045
|
+
#
|
11046
|
+
#
|
11047
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
10684
11048
|
# @return [String]
|
10685
11049
|
#
|
10686
11050
|
# @!attribute [rw] key
|
@@ -10698,9 +11062,13 @@ module Aws::S3
|
|
10698
11062
|
# @!attribute [rw] request_payer
|
10699
11063
|
# Confirms that the requester knows that she or he will be charged for
|
10700
11064
|
# the request. Bucket owners need not specify this parameter in their
|
10701
|
-
# requests.
|
10702
|
-
# buckets
|
10703
|
-
#
|
11065
|
+
# requests. For information about downloading objects from Requester
|
11066
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
11067
|
+
# in the *Amazon S3 Developer Guide*.
|
11068
|
+
#
|
11069
|
+
#
|
11070
|
+
#
|
11071
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
10704
11072
|
# @return [String]
|
10705
11073
|
#
|
10706
11074
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreObjectRequest AWS API Documentation
|
@@ -10803,12 +11171,12 @@ module Aws::S3
|
|
10803
11171
|
#
|
10804
11172
|
# @!attribute [rw] days
|
10805
11173
|
# Lifetime of the active copy in days. Do not use with restores that
|
10806
|
-
# specify OutputLocation
|
11174
|
+
# specify `OutputLocation`.
|
10807
11175
|
# @return [Integer]
|
10808
11176
|
#
|
10809
11177
|
# @!attribute [rw] glacier_job_parameters
|
10810
11178
|
# Glacier related parameters pertaining to this job. Do not use with
|
10811
|
-
# restores that specify OutputLocation
|
11179
|
+
# restores that specify `OutputLocation`.
|
10812
11180
|
# @return [Types::GlacierJobParameters]
|
10813
11181
|
#
|
10814
11182
|
# @!attribute [rw] type
|
@@ -11006,7 +11374,7 @@ module Aws::S3
|
|
11006
11374
|
# }
|
11007
11375
|
#
|
11008
11376
|
# @!attribute [rw] filter_rules
|
11009
|
-
# A list of containers for the key
|
11377
|
+
# A list of containers for the key-value pair that defines the
|
11010
11378
|
# criteria for the filter rule.
|
11011
11379
|
# @return [Array<Types::FilterRule>]
|
11012
11380
|
#
|
@@ -11017,8 +11385,8 @@ module Aws::S3
|
|
11017
11385
|
include Aws::Structure
|
11018
11386
|
end
|
11019
11387
|
|
11020
|
-
# Describes an S3 location that will receive the results of the
|
11021
|
-
# request.
|
11388
|
+
# Describes an Amazon S3 location that will receive the results of the
|
11389
|
+
# restore request.
|
11022
11390
|
#
|
11023
11391
|
# @note When making an API call, you may pass S3Location
|
11024
11392
|
# data as a hash:
|
@@ -11108,7 +11476,7 @@ module Aws::S3
|
|
11108
11476
|
include Aws::Structure
|
11109
11477
|
end
|
11110
11478
|
|
11111
|
-
# Specifies the use of SSE-KMS to encrypt delivered
|
11479
|
+
# Specifies the use of SSE-KMS to encrypt delivered inventory reports.
|
11112
11480
|
#
|
11113
11481
|
# @note When making an API call, you may pass SSEKMS
|
11114
11482
|
# data as a hash:
|
@@ -11118,8 +11486,8 @@ module Aws::S3
|
|
11118
11486
|
# }
|
11119
11487
|
#
|
11120
11488
|
# @!attribute [rw] key_id
|
11121
|
-
# Specifies the ID of the AWS Key Management Service (KMS)
|
11122
|
-
# master key (CMK) to use for encrypting
|
11489
|
+
# Specifies the ID of the AWS Key Management Service (AWS KMS)
|
11490
|
+
# customer master key (CMK) to use for encrypting inventory reports.
|
11123
11491
|
# @return [String]
|
11124
11492
|
#
|
11125
11493
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SSEKMS AWS API Documentation
|
@@ -11129,7 +11497,7 @@ module Aws::S3
|
|
11129
11497
|
include Aws::Structure
|
11130
11498
|
end
|
11131
11499
|
|
11132
|
-
# Specifies the use of SSE-S3 to encrypt delivered
|
11500
|
+
# Specifies the use of SSE-S3 to encrypt delivered inventory reports.
|
11133
11501
|
#
|
11134
11502
|
# @api private
|
11135
11503
|
#
|
@@ -11137,6 +11505,12 @@ module Aws::S3
|
|
11137
11505
|
#
|
11138
11506
|
class SSES3 < Aws::EmptyStructure; end
|
11139
11507
|
|
11508
|
+
# Specifies the byte range of the object to get the records from. A
|
11509
|
+
# record is processed when its first byte is contained by the range.
|
11510
|
+
# This parameter is optional, but when specified, it must not be empty.
|
11511
|
+
# See RFC 2616, Section 14.35.1 about how to specify the start and end
|
11512
|
+
# of the range.
|
11513
|
+
#
|
11140
11514
|
# @note When making an API call, you may pass ScanRange
|
11141
11515
|
# data as a hash:
|
11142
11516
|
#
|
@@ -11158,7 +11532,7 @@ module Aws::S3
|
|
11158
11532
|
# Valid values: non-negative integers. The default value is one less
|
11159
11533
|
# than the size of the object being queried. If only the End parameter
|
11160
11534
|
# is supplied, it is interpreted to mean scan the last N bytes of the
|
11161
|
-
# file. For example
|
11535
|
+
# file. For example, `<scanrange><end>50</end></scanrange>` means scan
|
11162
11536
|
# the last 50 bytes.
|
11163
11537
|
# @return [Integer]
|
11164
11538
|
#
|
@@ -11253,7 +11627,7 @@ module Aws::S3
|
|
11253
11627
|
#
|
11254
11628
|
# @!attribute [rw] sse_customer_algorithm
|
11255
11629
|
# The SSE Algorithm used to encrypt the object. For more information,
|
11256
|
-
# see [
|
11630
|
+
# see [Server-Side Encryption (Using Customer-Provided Encryption
|
11257
11631
|
# Keys][1].
|
11258
11632
|
#
|
11259
11633
|
#
|
@@ -11262,7 +11636,7 @@ module Aws::S3
|
|
11262
11636
|
# @return [String]
|
11263
11637
|
#
|
11264
11638
|
# @!attribute [rw] sse_customer_key
|
11265
|
-
# The SSE Customer Key. For more information, see [
|
11639
|
+
# The SSE Customer Key. For more information, see [Server-Side
|
11266
11640
|
# Encryption (Using Customer-Provided Encryption Keys][1].
|
11267
11641
|
#
|
11268
11642
|
#
|
@@ -11271,7 +11645,7 @@ module Aws::S3
|
|
11271
11645
|
# @return [String]
|
11272
11646
|
#
|
11273
11647
|
# @!attribute [rw] sse_customer_key_md5
|
11274
|
-
# The SSE Customer Key MD5. For more information, see [
|
11648
|
+
# The SSE Customer Key MD5. For more information, see [Server-Side
|
11275
11649
|
# Encryption (Using Customer-Provided Encryption Keys][1].
|
11276
11650
|
#
|
11277
11651
|
#
|
@@ -11284,7 +11658,7 @@ module Aws::S3
|
|
11284
11658
|
# @return [String]
|
11285
11659
|
#
|
11286
11660
|
# @!attribute [rw] expression_type
|
11287
|
-
# The type of the provided expression (for example
|
11661
|
+
# The type of the provided expression (for example, SQL).
|
11288
11662
|
# @return [String]
|
11289
11663
|
#
|
11290
11664
|
# @!attribute [rw] request_progress
|
@@ -11383,7 +11757,7 @@ module Aws::S3
|
|
11383
11757
|
# @return [Types::InputSerialization]
|
11384
11758
|
#
|
11385
11759
|
# @!attribute [rw] expression_type
|
11386
|
-
# The type of the provided expression (
|
11760
|
+
# The type of the provided expression (for example, SQL).
|
11387
11761
|
# @return [String]
|
11388
11762
|
#
|
11389
11763
|
# @!attribute [rw] expression
|
@@ -11676,7 +12050,7 @@ module Aws::S3
|
|
11676
12050
|
include Aws::Structure
|
11677
12051
|
end
|
11678
12052
|
|
11679
|
-
# Container for TagSet elements.
|
12053
|
+
# Container for `TagSet` elements.
|
11680
12054
|
#
|
11681
12055
|
# @note When making an API call, you may pass Tagging
|
11682
12056
|
# data as a hash:
|
@@ -11691,7 +12065,7 @@ module Aws::S3
|
|
11691
12065
|
# }
|
11692
12066
|
#
|
11693
12067
|
# @!attribute [rw] tag_set
|
11694
|
-
# A collection for a
|
12068
|
+
# A collection for a set of tags
|
11695
12069
|
# @return [Array<Types::Tag>]
|
11696
12070
|
#
|
11697
12071
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Tagging AWS API Documentation
|
@@ -11800,8 +12174,8 @@ module Aws::S3
|
|
11800
12174
|
|
11801
12175
|
# A container for specifying the configuration for publication of
|
11802
12176
|
# messages to an Amazon Simple Notification Service (Amazon SNS) topic
|
11803
|
-
# when Amazon S3 detects specified events. This data type is
|
11804
|
-
#
|
12177
|
+
# when Amazon S3 detects specified events. This data type is deprecated.
|
12178
|
+
# Use TopicConfiguration instead.
|
11805
12179
|
#
|
11806
12180
|
# @note When making an API call, you may pass TopicConfigurationDeprecated
|
11807
12181
|
# data as a hash:
|
@@ -11888,8 +12262,8 @@ module Aws::S3
|
|
11888
12262
|
# @return [Types::CopyPartResult]
|
11889
12263
|
#
|
11890
12264
|
# @!attribute [rw] server_side_encryption
|
11891
|
-
# The
|
11892
|
-
# in S3 (
|
12265
|
+
# The server-side encryption algorithm used when storing this object
|
12266
|
+
# in Amazon S3 (for example, AES256, aws:kms).
|
11893
12267
|
# @return [String]
|
11894
12268
|
#
|
11895
12269
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -11901,13 +12275,13 @@ module Aws::S3
|
|
11901
12275
|
# @!attribute [rw] sse_customer_key_md5
|
11902
12276
|
# If server-side encryption with a customer-provided encryption key
|
11903
12277
|
# was requested, the response will include this header to provide
|
11904
|
-
# round
|
12278
|
+
# round-trip message integrity verification of the customer-provided
|
11905
12279
|
# encryption key.
|
11906
12280
|
# @return [String]
|
11907
12281
|
#
|
11908
12282
|
# @!attribute [rw] ssekms_key_id
|
11909
|
-
# If present, specifies the ID of the AWS Key Management Service (
|
11910
|
-
# customer master key (CMK) that was used for the object.
|
12283
|
+
# If present, specifies the ID of the AWS Key Management Service (AWS
|
12284
|
+
# KMS) customer master key (CMK) that was used for the object.
|
11911
12285
|
# @return [String]
|
11912
12286
|
#
|
11913
12287
|
# @!attribute [rw] request_charged
|
@@ -11983,8 +12357,8 @@ module Aws::S3
|
|
11983
12357
|
# The range of bytes to copy from the source object. The range value
|
11984
12358
|
# must use the form bytes=first-last, where the first and last are the
|
11985
12359
|
# zero-based byte offsets to copy. For example, bytes=0-9 indicates
|
11986
|
-
# that you want to copy the first
|
11987
|
-
#
|
12360
|
+
# that you want to copy the first 10 bytes of the source. You can copy
|
12361
|
+
# a range only if the source object is greater than 5 MB.
|
11988
12362
|
# @return [String]
|
11989
12363
|
#
|
11990
12364
|
# @!attribute [rw] key
|
@@ -12002,29 +12376,29 @@ module Aws::S3
|
|
12002
12376
|
# @return [String]
|
12003
12377
|
#
|
12004
12378
|
# @!attribute [rw] sse_customer_algorithm
|
12005
|
-
# Specifies the algorithm to use to when encrypting the object (
|
12006
|
-
# AES256).
|
12379
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
12380
|
+
# example, AES256).
|
12007
12381
|
# @return [String]
|
12008
12382
|
#
|
12009
12383
|
# @!attribute [rw] sse_customer_key
|
12010
12384
|
# Specifies the customer-provided encryption key for Amazon S3 to use
|
12011
12385
|
# in encrypting data. This value is used to store the object and then
|
12012
|
-
# it is discarded; Amazon does not store the encryption key. The
|
12013
|
-
# must be appropriate for use with the algorithm specified in the
|
12014
|
-
# x-amz-server-side-encryption-customer-algorithm header. This
|
12015
|
-
# be the same encryption key specified in the initiate multipart
|
12386
|
+
# it is discarded; Amazon S3 does not store the encryption key. The
|
12387
|
+
# key must be appropriate for use with the algorithm specified in the
|
12388
|
+
# `x-amz-server-side-encryption-customer-algorithm` header. This
|
12389
|
+
# must be the same encryption key specified in the initiate multipart
|
12016
12390
|
# upload request.
|
12017
12391
|
# @return [String]
|
12018
12392
|
#
|
12019
12393
|
# @!attribute [rw] sse_customer_key_md5
|
12020
12394
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
12021
12395
|
# RFC 1321. Amazon S3 uses this header for a message integrity check
|
12022
|
-
# to ensure the encryption key was transmitted without error.
|
12396
|
+
# to ensure that the encryption key was transmitted without error.
|
12023
12397
|
# @return [String]
|
12024
12398
|
#
|
12025
12399
|
# @!attribute [rw] copy_source_sse_customer_algorithm
|
12026
12400
|
# Specifies the algorithm to use when decrypting the source object
|
12027
|
-
# (
|
12401
|
+
# (for example, AES256).
|
12028
12402
|
# @return [String]
|
12029
12403
|
#
|
12030
12404
|
# @!attribute [rw] copy_source_sse_customer_key
|
@@ -12036,15 +12410,19 @@ module Aws::S3
|
|
12036
12410
|
# @!attribute [rw] copy_source_sse_customer_key_md5
|
12037
12411
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
12038
12412
|
# RFC 1321. Amazon S3 uses this header for a message integrity check
|
12039
|
-
# to ensure the encryption key was transmitted without error.
|
12413
|
+
# to ensure that the encryption key was transmitted without error.
|
12040
12414
|
# @return [String]
|
12041
12415
|
#
|
12042
12416
|
# @!attribute [rw] request_payer
|
12043
12417
|
# Confirms that the requester knows that she or he will be charged for
|
12044
12418
|
# the request. Bucket owners need not specify this parameter in their
|
12045
|
-
# requests.
|
12046
|
-
# buckets
|
12047
|
-
#
|
12419
|
+
# requests. For information about downloading objects from Requester
|
12420
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
12421
|
+
# in the *Amazon S3 Developer Guide*.
|
12422
|
+
#
|
12423
|
+
#
|
12424
|
+
#
|
12425
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
12048
12426
|
# @return [String]
|
12049
12427
|
#
|
12050
12428
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPartCopyRequest AWS API Documentation
|
@@ -12071,8 +12449,8 @@ module Aws::S3
|
|
12071
12449
|
end
|
12072
12450
|
|
12073
12451
|
# @!attribute [rw] server_side_encryption
|
12074
|
-
# The
|
12075
|
-
# in S3 (
|
12452
|
+
# The server-side encryption algorithm used when storing this object
|
12453
|
+
# in Amazon S3 (for example, AES256, aws:kms).
|
12076
12454
|
# @return [String]
|
12077
12455
|
#
|
12078
12456
|
# @!attribute [rw] etag
|
@@ -12088,13 +12466,13 @@ module Aws::S3
|
|
12088
12466
|
# @!attribute [rw] sse_customer_key_md5
|
12089
12467
|
# If server-side encryption with a customer-provided encryption key
|
12090
12468
|
# was requested, the response will include this header to provide
|
12091
|
-
# round
|
12469
|
+
# round-trip message integrity verification of the customer-provided
|
12092
12470
|
# encryption key.
|
12093
12471
|
# @return [String]
|
12094
12472
|
#
|
12095
12473
|
# @!attribute [rw] ssekms_key_id
|
12096
|
-
# If present, specifies the ID of the AWS Key Management Service (
|
12097
|
-
# customer master key (CMK) was used for the object.
|
12474
|
+
# If present, specifies the ID of the AWS Key Management Service (AWS
|
12475
|
+
# KMS) customer master key (CMK) was used for the object.
|
12098
12476
|
# @return [String]
|
12099
12477
|
#
|
12100
12478
|
# @!attribute [rw] request_charged
|
@@ -12147,7 +12525,7 @@ module Aws::S3
|
|
12147
12525
|
# @!attribute [rw] content_md5
|
12148
12526
|
# The base64-encoded 128-bit MD5 digest of the part data. This
|
12149
12527
|
# parameter is auto-populated when using the command from the CLI.
|
12150
|
-
# This
|
12528
|
+
# This parameter is required if object lock parameters are specified.
|
12151
12529
|
# @return [String]
|
12152
12530
|
#
|
12153
12531
|
# @!attribute [rw] key
|
@@ -12165,32 +12543,36 @@ module Aws::S3
|
|
12165
12543
|
# @return [String]
|
12166
12544
|
#
|
12167
12545
|
# @!attribute [rw] sse_customer_algorithm
|
12168
|
-
# Specifies the algorithm to use to when encrypting the object (
|
12169
|
-
# AES256).
|
12546
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
12547
|
+
# example, AES256).
|
12170
12548
|
# @return [String]
|
12171
12549
|
#
|
12172
12550
|
# @!attribute [rw] sse_customer_key
|
12173
12551
|
# Specifies the customer-provided encryption key for Amazon S3 to use
|
12174
12552
|
# in encrypting data. This value is used to store the object and then
|
12175
|
-
# it is discarded; Amazon does not store the encryption key. The
|
12176
|
-
# must be appropriate for use with the algorithm specified in the
|
12177
|
-
# x-amz-server-side-encryption-customer-algorithm header
|
12178
|
-
# be the same encryption key specified in the initiate multipart
|
12553
|
+
# it is discarded; Amazon S3 does not store the encryption key. The
|
12554
|
+
# key must be appropriate for use with the algorithm specified in the
|
12555
|
+
# `x-amz-server-side-encryption-customer-algorithm header`. This
|
12556
|
+
# must be the same encryption key specified in the initiate multipart
|
12179
12557
|
# upload request.
|
12180
12558
|
# @return [String]
|
12181
12559
|
#
|
12182
12560
|
# @!attribute [rw] sse_customer_key_md5
|
12183
12561
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
12184
12562
|
# RFC 1321. Amazon S3 uses this header for a message integrity check
|
12185
|
-
# to ensure the encryption key was transmitted without error.
|
12563
|
+
# to ensure that the encryption key was transmitted without error.
|
12186
12564
|
# @return [String]
|
12187
12565
|
#
|
12188
12566
|
# @!attribute [rw] request_payer
|
12189
12567
|
# Confirms that the requester knows that she or he will be charged for
|
12190
12568
|
# the request. Bucket owners need not specify this parameter in their
|
12191
|
-
# requests.
|
12192
|
-
# buckets
|
12193
|
-
#
|
12569
|
+
# requests. For information about downloading objects from Requester
|
12570
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
12571
|
+
# in the *Amazon S3 Developer Guide*.
|
12572
|
+
#
|
12573
|
+
#
|
12574
|
+
#
|
12575
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
12194
12576
|
# @return [String]
|
12195
12577
|
#
|
12196
12578
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPartRequest AWS API Documentation
|
@@ -12308,7 +12690,7 @@ module Aws::S3
|
|
12308
12690
|
include Aws::Structure
|
12309
12691
|
end
|
12310
12692
|
|
12311
|
-
# The
|
12693
|
+
# The container for selecting objects from a content event stream.
|
12312
12694
|
#
|
12313
12695
|
# EventStream is an Enumerator of Events.
|
12314
12696
|
# #event_types #=> Array, returns all modeled event types in the stream
|