aws-sdk-s3 1.88.2 → 1.93.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +741 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-s3.rb +2 -2
- data/lib/aws-sdk-s3/arn/access_point_arn.rb +2 -2
- data/lib/aws-sdk-s3/arn/object_lambda_arn.rb +66 -0
- data/lib/aws-sdk-s3/arn/outpost_access_point_arn.rb +3 -3
- data/lib/aws-sdk-s3/bucket.rb +10 -10
- data/lib/aws-sdk-s3/bucket_acl.rb +2 -2
- data/lib/aws-sdk-s3/bucket_cors.rb +5 -5
- data/lib/aws-sdk-s3/bucket_lifecycle.rb +3 -3
- data/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb +3 -3
- data/lib/aws-sdk-s3/bucket_logging.rb +2 -2
- data/lib/aws-sdk-s3/bucket_notification.rb +2 -2
- data/lib/aws-sdk-s3/bucket_policy.rb +3 -3
- data/lib/aws-sdk-s3/bucket_request_payment.rb +5 -6
- data/lib/aws-sdk-s3/bucket_tagging.rb +3 -3
- data/lib/aws-sdk-s3/bucket_versioning.rb +4 -4
- data/lib/aws-sdk-s3/bucket_website.rb +3 -3
- data/lib/aws-sdk-s3/client.rb +1212 -868
- data/lib/aws-sdk-s3/client_api.rb +62 -1
- data/lib/aws-sdk-s3/errors.rb +1 -1
- data/lib/aws-sdk-s3/event_streams.rb +1 -1
- data/lib/aws-sdk-s3/multipart_upload.rb +4 -4
- data/lib/aws-sdk-s3/multipart_upload_part.rb +5 -5
- data/lib/aws-sdk-s3/object.rb +109 -23
- data/lib/aws-sdk-s3/object_acl.rb +2 -2
- data/lib/aws-sdk-s3/object_summary.rb +22 -22
- data/lib/aws-sdk-s3/object_version.rb +10 -10
- data/lib/aws-sdk-s3/plugins/arn.rb +20 -13
- data/lib/aws-sdk-s3/plugins/iad_regional_endpoint.rb +9 -9
- data/lib/aws-sdk-s3/plugins/object_lambda_endpoint.rb +25 -0
- data/lib/aws-sdk-s3/plugins/s3_signer.rb +6 -0
- data/lib/aws-sdk-s3/resource.rb +1 -1
- data/lib/aws-sdk-s3/types.rb +923 -461
- data/lib/aws-sdk-s3/waiters.rb +1 -1
- metadata +10 -5
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -286,7 +286,7 @@ module Aws::S3
|
|
286
286
|
# @option options [String] :version_id
|
287
287
|
# VersionId used to reference a specific version of the object.
|
288
288
|
# @option options [String] :expected_bucket_owner
|
289
|
-
# The account
|
289
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
290
290
|
# a different account, the request will fail with an HTTP `403 (Access
|
291
291
|
# Denied)` error.
|
292
292
|
# @return [Types::PutObjectAclOutput]
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -42,7 +42,7 @@ module Aws::S3
|
|
42
42
|
@key
|
43
43
|
end
|
44
44
|
|
45
|
-
#
|
45
|
+
# Creation date of the object.
|
46
46
|
# @return [Time]
|
47
47
|
def last_modified
|
48
48
|
data[:last_modified]
|
@@ -375,7 +375,7 @@ module Aws::S3
|
|
375
375
|
#
|
376
376
|
#
|
377
377
|
#
|
378
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
378
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
|
379
379
|
# @option options [String] :copy_source_if_match
|
380
380
|
# Copies the object if its entity tag (ETag) matches the specified tag.
|
381
381
|
# @option options [Time,DateTime,Date,Integer,String] :copy_source_if_modified_since
|
@@ -465,8 +465,8 @@ module Aws::S3
|
|
465
465
|
# Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key
|
466
466
|
# for object encryption with SSE-KMS.
|
467
467
|
#
|
468
|
-
# Specifying this header with a COPY
|
469
|
-
#
|
468
|
+
# Specifying this header with a COPY action doesn’t affect bucket-level
|
469
|
+
# settings for S3 Bucket Key.
|
470
470
|
# @option options [String] :copy_source_sse_customer_algorithm
|
471
471
|
# Specifies the algorithm to use when decrypting the source object (for
|
472
472
|
# example, AES256).
|
@@ -500,11 +500,11 @@ module Aws::S3
|
|
500
500
|
# @option options [String] :object_lock_legal_hold_status
|
501
501
|
# Specifies whether you want to apply a Legal Hold to the copied object.
|
502
502
|
# @option options [String] :expected_bucket_owner
|
503
|
-
# The account
|
503
|
+
# The account ID of the expected destination bucket owner. If the
|
504
504
|
# destination bucket is owned by a different account, the request will
|
505
505
|
# fail with an HTTP `403 (Access Denied)` error.
|
506
506
|
# @option options [String] :expected_source_bucket_owner
|
507
|
-
# The account
|
507
|
+
# The account ID of the expected source bucket owner. If the source
|
508
508
|
# bucket is owned by a different account, the request will fail with an
|
509
509
|
# HTTP `403 (Access Denied)` error.
|
510
510
|
# @return [Types::CopyObjectOutput]
|
@@ -548,7 +548,7 @@ module Aws::S3
|
|
548
548
|
# Indicates whether S3 Object Lock should bypass Governance-mode
|
549
549
|
# restrictions to process this operation.
|
550
550
|
# @option options [String] :expected_bucket_owner
|
551
|
-
# The account
|
551
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
552
552
|
# a different account, the request will fail with an HTTP `403 (Access
|
553
553
|
# Denied)` error.
|
554
554
|
# @return [Types::DeleteObjectOutput]
|
@@ -624,13 +624,13 @@ module Aws::S3
|
|
624
624
|
# @option options [String] :version_id
|
625
625
|
# VersionId used to reference a specific version of the object.
|
626
626
|
# @option options [String] :sse_customer_algorithm
|
627
|
-
# Specifies the algorithm to use to when
|
627
|
+
# Specifies the algorithm to use to when decrypting the object (for
|
628
628
|
# example, AES256).
|
629
629
|
# @option options [String] :sse_customer_key
|
630
|
-
# Specifies the customer-provided encryption key for Amazon S3 to
|
631
|
-
#
|
632
|
-
#
|
633
|
-
# be appropriate for use with the algorithm specified in the
|
630
|
+
# Specifies the customer-provided encryption key for Amazon S3 used to
|
631
|
+
# encrypt the data. This value is used to decrypt the object when
|
632
|
+
# recovering it and must match the one used when storing the data. The
|
633
|
+
# key must be appropriate for use with the algorithm specified in the
|
634
634
|
# `x-amz-server-side-encryption-customer-algorithm` header.
|
635
635
|
# @option options [String] :sse_customer_key_md5
|
636
636
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
@@ -652,7 +652,7 @@ module Aws::S3
|
|
652
652
|
# for the part specified. Useful for downloading just a part of an
|
653
653
|
# object.
|
654
654
|
# @option options [String] :expected_bucket_owner
|
655
|
-
# The account
|
655
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
656
656
|
# a different account, the request will fail with an HTTP `403 (Access
|
657
657
|
# Denied)` error.
|
658
658
|
# @return [Types::GetObjectOutput]
|
@@ -777,7 +777,7 @@ module Aws::S3
|
|
777
777
|
#
|
778
778
|
#
|
779
779
|
#
|
780
|
-
# [1]: https://docs.aws.amazon.com/
|
780
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
|
781
781
|
# @option options [String] :ssekms_encryption_context
|
782
782
|
# Specifies the AWS KMS Encryption Context to use for object encryption.
|
783
783
|
# The value of this header is a base64-encoded UTF-8 string holding JSON
|
@@ -788,7 +788,7 @@ module Aws::S3
|
|
788
788
|
# Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key
|
789
789
|
# for object encryption with SSE-KMS.
|
790
790
|
#
|
791
|
-
# Specifying this header with an object
|
791
|
+
# Specifying this header with an object action doesn’t affect
|
792
792
|
# bucket-level settings for S3 Bucket Key.
|
793
793
|
# @option options [String] :request_payer
|
794
794
|
# Confirms that the requester knows that they will be charged for the
|
@@ -812,7 +812,7 @@ module Aws::S3
|
|
812
812
|
# Specifies whether you want to apply a Legal Hold to the uploaded
|
813
813
|
# object.
|
814
814
|
# @option options [String] :expected_bucket_owner
|
815
|
-
# The account
|
815
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
816
816
|
# a different account, the request will fail with an HTTP `403 (Access
|
817
817
|
# Denied)` error.
|
818
818
|
# @return [MultipartUpload]
|
@@ -1034,8 +1034,8 @@ module Aws::S3
|
|
1034
1034
|
# Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key
|
1035
1035
|
# for object encryption with SSE-KMS.
|
1036
1036
|
#
|
1037
|
-
# Specifying this header with a PUT
|
1038
|
-
#
|
1037
|
+
# Specifying this header with a PUT action doesn’t affect bucket-level
|
1038
|
+
# settings for S3 Bucket Key.
|
1039
1039
|
# @option options [String] :request_payer
|
1040
1040
|
# Confirms that the requester knows that they will be charged for the
|
1041
1041
|
# request. Bucket owners need not specify this parameter in their
|
@@ -1061,7 +1061,7 @@ module Aws::S3
|
|
1061
1061
|
#
|
1062
1062
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
1063
1063
|
# @option options [String] :expected_bucket_owner
|
1064
|
-
# The account
|
1064
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
1065
1065
|
# a different account, the request will fail with an HTTP `403 (Access
|
1066
1066
|
# Denied)` error.
|
1067
1067
|
# @return [Types::PutObjectOutput]
|
@@ -1178,7 +1178,7 @@ module Aws::S3
|
|
1178
1178
|
#
|
1179
1179
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
1180
1180
|
# @option options [String] :expected_bucket_owner
|
1181
|
-
# The account
|
1181
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
1182
1182
|
# a different account, the request will fail with an HTTP `403 (Access
|
1183
1183
|
# Denied)` error.
|
1184
1184
|
# @return [Types::RestoreObjectOutput]
|
@@ -1335,7 +1335,7 @@ module Aws::S3
|
|
1335
1335
|
# Governance-type Object Lock in place. You must have sufficient
|
1336
1336
|
# permissions to perform this operation.
|
1337
1337
|
# @option options [String] :expected_bucket_owner
|
1338
|
-
# The account
|
1338
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
1339
1339
|
# a different account, the request will fail with an HTTP `403 (Access
|
1340
1340
|
# Denied)` error.
|
1341
1341
|
# @return [void]
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -256,7 +256,7 @@ module Aws::S3
|
|
256
256
|
# Indicates whether S3 Object Lock should bypass Governance-mode
|
257
257
|
# restrictions to process this operation.
|
258
258
|
# @option options [String] :expected_bucket_owner
|
259
|
-
# The account
|
259
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
260
260
|
# a different account, the request will fail with an HTTP `403 (Access
|
261
261
|
# Denied)` error.
|
262
262
|
# @return [Types::DeleteObjectOutput]
|
@@ -330,13 +330,13 @@ module Aws::S3
|
|
330
330
|
# @option options [Time,DateTime,Date,Integer,String] :response_expires
|
331
331
|
# Sets the `Expires` header of the response.
|
332
332
|
# @option options [String] :sse_customer_algorithm
|
333
|
-
# Specifies the algorithm to use to when
|
333
|
+
# Specifies the algorithm to use to when decrypting the object (for
|
334
334
|
# example, AES256).
|
335
335
|
# @option options [String] :sse_customer_key
|
336
|
-
# Specifies the customer-provided encryption key for Amazon S3 to
|
337
|
-
#
|
338
|
-
#
|
339
|
-
# be appropriate for use with the algorithm specified in the
|
336
|
+
# Specifies the customer-provided encryption key for Amazon S3 used to
|
337
|
+
# encrypt the data. This value is used to decrypt the object when
|
338
|
+
# recovering it and must match the one used when storing the data. The
|
339
|
+
# key must be appropriate for use with the algorithm specified in the
|
340
340
|
# `x-amz-server-side-encryption-customer-algorithm` header.
|
341
341
|
# @option options [String] :sse_customer_key_md5
|
342
342
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
@@ -358,7 +358,7 @@ module Aws::S3
|
|
358
358
|
# for the part specified. Useful for downloading just a part of an
|
359
359
|
# object.
|
360
360
|
# @option options [String] :expected_bucket_owner
|
361
|
-
# The account
|
361
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
362
362
|
# a different account, the request will fail with an HTTP `403 (Access
|
363
363
|
# Denied)` error.
|
364
364
|
# @return [Types::GetObjectOutput]
|
@@ -442,7 +442,7 @@ module Aws::S3
|
|
442
442
|
# for the part specified. Useful querying about the size of the part and
|
443
443
|
# the number of parts in this object.
|
444
444
|
# @option options [String] :expected_bucket_owner
|
445
|
-
# The account
|
445
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
446
446
|
# a different account, the request will fail with an HTTP `403 (Access
|
447
447
|
# Denied)` error.
|
448
448
|
# @return [Types::HeadObjectOutput]
|
@@ -546,7 +546,7 @@ module Aws::S3
|
|
546
546
|
# Governance-type Object Lock in place. You must have sufficient
|
547
547
|
# permissions to perform this operation.
|
548
548
|
# @option options [String] :expected_bucket_owner
|
549
|
-
# The account
|
549
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
550
550
|
# a different account, the request will fail with an HTTP `403 (Access
|
551
551
|
# Denied)` error.
|
552
552
|
# @return [void]
|
@@ -1,6 +1,7 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
3
|
require_relative '../arn/access_point_arn'
|
4
|
+
require_relative '../arn/object_lambda_arn'
|
4
5
|
require_relative '../arn/outpost_access_point_arn'
|
5
6
|
|
6
7
|
module Aws
|
@@ -22,9 +23,9 @@ be made. Set to `false` to use the client's region instead.
|
|
22
23
|
resolve_s3_use_arn_region(cfg)
|
23
24
|
end
|
24
25
|
|
25
|
-
# param validator is validate:50
|
26
|
+
# param validator is validate:50
|
26
27
|
# endpoint is build:90 (populates the URI for the first time)
|
27
|
-
# endpoint pattern is build:10
|
28
|
+
# endpoint pattern is build:10
|
28
29
|
def add_handlers(handlers, _config)
|
29
30
|
handlers.add(ARNHandler, step: :validate, priority: 75)
|
30
31
|
handlers.add(UrlHandler)
|
@@ -114,15 +115,7 @@ be made. Set to `false` to use the client's region instead.
|
|
114
115
|
def resolve_arn!(member_value, region, use_arn_region)
|
115
116
|
if Aws::ARNParser.arn?(member_value)
|
116
117
|
arn = Aws::ARNParser.parse(member_value)
|
117
|
-
|
118
|
-
s3_arn = Aws::S3::AccessPointARN.new(arn.to_h)
|
119
|
-
elsif arn.resource.start_with?('outpost')
|
120
|
-
s3_arn = Aws::S3::OutpostAccessPointARN.new(arn.to_h)
|
121
|
-
else
|
122
|
-
raise ArgumentError,
|
123
|
-
'Only Access Point and Outpost Access Point type ARNs '\
|
124
|
-
'are currently supported.'
|
125
|
-
end
|
118
|
+
s3_arn = resolve_arn_type!(arn)
|
126
119
|
s3_arn.validate_arn!
|
127
120
|
validate_region_config!(s3_arn, region, use_arn_region)
|
128
121
|
region = s3_arn.region if use_arn_region
|
@@ -142,6 +135,21 @@ be made. Set to `false` to use the client's region instead.
|
|
142
135
|
|
143
136
|
private
|
144
137
|
|
138
|
+
def resolve_arn_type!(arn)
|
139
|
+
case arn.service
|
140
|
+
when 's3'
|
141
|
+
Aws::S3::AccessPointARN.new(arn.to_h)
|
142
|
+
when 's3-outposts'
|
143
|
+
Aws::S3::OutpostAccessPointARN.new(arn.to_h)
|
144
|
+
when 's3-object-lambda'
|
145
|
+
Aws::S3::ObjectLambdaARN.new(arn.to_h)
|
146
|
+
else
|
147
|
+
raise ArgumentError,
|
148
|
+
'Only Access Point, Outposts, and Object Lambdas ARNs '\
|
149
|
+
'are currently supported.'
|
150
|
+
end
|
151
|
+
end
|
152
|
+
|
145
153
|
def resolve_s3_use_arn_region(cfg)
|
146
154
|
value = ENV['AWS_S3_USE_ARN_REGION'] ||
|
147
155
|
Aws.shared_config.s3_use_arn_region(profile: cfg.profile) ||
|
@@ -157,8 +165,7 @@ be made. Set to `false` to use the client's region instead.
|
|
157
165
|
value
|
158
166
|
end
|
159
167
|
|
160
|
-
# Remove ARN from the path
|
161
|
-
# This only works because accesspoints care about the URL
|
168
|
+
# Remove ARN from the path because we've already set the new host
|
162
169
|
def url_path(path, arn)
|
163
170
|
path = path.sub("/#{Seahorse::Util.uri_escape(arn.to_s)}", '')
|
164
171
|
.sub("/#{arn}", '')
|
@@ -10,8 +10,8 @@ module Aws
|
|
10
10
|
default: 'legacy',
|
11
11
|
doc_type: String,
|
12
12
|
docstring: <<-DOCS) do |cfg|
|
13
|
-
|
14
|
-
|
13
|
+
Pass in `regional` to enable the `us-east-1` regional endpoint.
|
14
|
+
Defaults to `legacy` mode which uses the global endpoint.
|
15
15
|
DOCS
|
16
16
|
resolve_iad_regional_endpoint(cfg)
|
17
17
|
end
|
@@ -27,14 +27,14 @@ region. Defaults to `legacy` mode using global endpoint.
|
|
27
27
|
class Handler < Seahorse::Client::Handler
|
28
28
|
|
29
29
|
def call(context)
|
30
|
-
#
|
31
|
-
|
30
|
+
# WriteGetObjectResponse does not have a global endpoint
|
31
|
+
# ARNs are regionalized, so don't touch those either.
|
32
|
+
if context.operation.name != 'WriteGetObjectResponse' &&
|
33
|
+
context.config.s3_us_east_1_regional_endpoint == 'legacy' &&
|
34
|
+
!context.metadata[:s3_arn]
|
32
35
|
host = context.http_request.endpoint.host
|
33
|
-
|
34
|
-
|
35
|
-
legacy_host = IADRegionalEndpoint.legacy_host(host)
|
36
|
-
context.http_request.endpoint.host = legacy_host
|
37
|
-
end
|
36
|
+
legacy_host = IADRegionalEndpoint.legacy_host(host)
|
37
|
+
context.http_request.endpoint.host = legacy_host
|
38
38
|
end
|
39
39
|
@handler.call(context)
|
40
40
|
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Aws
|
4
|
+
module S3
|
5
|
+
module Plugins
|
6
|
+
# WriteGetObjectResponse is called from Lambda after a data transform.
|
7
|
+
# If there is no custom endpoint, we change the endpoint from s3 to
|
8
|
+
# s3-object-lambda just for this operation.
|
9
|
+
class ObjectLambdaEndpoint < Seahorse::Client::Plugin
|
10
|
+
class Handler < Seahorse::Client::Handler
|
11
|
+
def call(context)
|
12
|
+
if context.config.regional_endpoint
|
13
|
+
host = context.http_request.endpoint.host
|
14
|
+
host = host.sub('s3.', 's3-object-lambda.')
|
15
|
+
context.http_request.endpoint.host = host
|
16
|
+
end
|
17
|
+
@handler.call(context)
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
21
|
+
handler(Handler, operations: [:write_get_object_response])
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -79,6 +79,12 @@ module Aws
|
|
79
79
|
region: arn[:resolved_region],
|
80
80
|
credentials: context.config.credentials
|
81
81
|
)
|
82
|
+
elsif context.operation.name == 'WriteGetObjectResponse'
|
83
|
+
S3Signer.build_v4_signer(
|
84
|
+
service: 's3-object-lambda',
|
85
|
+
region: context.config.sigv4_region,
|
86
|
+
credentials: context.config.credentials
|
87
|
+
)
|
82
88
|
else
|
83
89
|
context.config.sigv4_signer
|
84
90
|
end
|
data/lib/aws-sdk-s3/resource.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
data/lib/aws-sdk-s3/types.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -14,7 +14,7 @@ module Aws::S3
|
|
14
14
|
# upload that Amazon S3 will wait before permanently removing all parts
|
15
15
|
# of the upload. For more information, see [ Aborting Incomplete
|
16
16
|
# Multipart Uploads Using a Bucket Lifecycle Policy][1] in the *Amazon
|
17
|
-
#
|
17
|
+
# S3 User Guide*.
|
18
18
|
#
|
19
19
|
#
|
20
20
|
#
|
@@ -67,28 +67,28 @@ module Aws::S3
|
|
67
67
|
# @!attribute [rw] bucket
|
68
68
|
# The bucket name to which the upload was taking place.
|
69
69
|
#
|
70
|
-
# When using this
|
71
|
-
# to the access point hostname. The access point hostname
|
72
|
-
# form
|
70
|
+
# When using this action with an access point, you must direct
|
71
|
+
# requests to the access point hostname. The access point hostname
|
72
|
+
# takes the form
|
73
73
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
74
|
-
# When using this
|
74
|
+
# When using this action with an access point through the AWS SDKs,
|
75
75
|
# you provide the access point ARN in place of the bucket name. For
|
76
76
|
# more information about access point ARNs, see [Using Access
|
77
|
-
# Points][1] in the *Amazon
|
77
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
78
78
|
#
|
79
|
-
# When using this
|
79
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
80
80
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
81
81
|
# takes the form
|
82
82
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
83
|
-
# When using this
|
83
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
84
84
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
85
85
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
86
|
-
# Outposts][2] in the *Amazon
|
86
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
87
87
|
#
|
88
88
|
#
|
89
89
|
#
|
90
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
91
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
90
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
91
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
92
92
|
# @return [String]
|
93
93
|
#
|
94
94
|
# @!attribute [rw] key
|
@@ -112,7 +112,7 @@ module Aws::S3
|
|
112
112
|
# @return [String]
|
113
113
|
#
|
114
114
|
# @!attribute [rw] expected_bucket_owner
|
115
|
-
# The account
|
115
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
116
116
|
# by a different account, the request will fail with an HTTP `403
|
117
117
|
# (Access Denied)` error.
|
118
118
|
# @return [String]
|
@@ -131,7 +131,7 @@ module Aws::S3
|
|
131
131
|
|
132
132
|
# Configures the transfer acceleration state for an Amazon S3 bucket.
|
133
133
|
# For more information, see [Amazon S3 Transfer Acceleration][1] in the
|
134
|
-
# *Amazon
|
134
|
+
# *Amazon S3 User Guide*.
|
135
135
|
#
|
136
136
|
#
|
137
137
|
#
|
@@ -492,7 +492,7 @@ module Aws::S3
|
|
492
492
|
|
493
493
|
# Specifies the lifecycle configuration for objects in an Amazon S3
|
494
494
|
# bucket. For more information, see [Object Lifecycle Management][1] in
|
495
|
-
# the *Amazon
|
495
|
+
# the *Amazon S3 User Guide*.
|
496
496
|
#
|
497
497
|
#
|
498
498
|
#
|
@@ -608,8 +608,7 @@ module Aws::S3
|
|
608
608
|
|
609
609
|
# Describes the cross-origin access configuration for objects in an
|
610
610
|
# Amazon S3 bucket. For more information, see [Enabling Cross-Origin
|
611
|
-
# Resource Sharing][1] in the *Amazon
|
612
|
-
# Guide*.
|
611
|
+
# Resource Sharing][1] in the *Amazon S3 User Guide*.
|
613
612
|
#
|
614
613
|
#
|
615
614
|
#
|
@@ -621,6 +620,7 @@ module Aws::S3
|
|
621
620
|
# {
|
622
621
|
# cors_rules: [ # required
|
623
622
|
# {
|
623
|
+
# id: "ID",
|
624
624
|
# allowed_headers: ["AllowedHeader"],
|
625
625
|
# allowed_methods: ["AllowedMethod"], # required
|
626
626
|
# allowed_origins: ["AllowedOrigin"], # required
|
@@ -649,6 +649,7 @@ module Aws::S3
|
|
649
649
|
# data as a hash:
|
650
650
|
#
|
651
651
|
# {
|
652
|
+
# id: "ID",
|
652
653
|
# allowed_headers: ["AllowedHeader"],
|
653
654
|
# allowed_methods: ["AllowedMethod"], # required
|
654
655
|
# allowed_origins: ["AllowedOrigin"], # required
|
@@ -656,6 +657,11 @@ module Aws::S3
|
|
656
657
|
# max_age_seconds: 1,
|
657
658
|
# }
|
658
659
|
#
|
660
|
+
# @!attribute [rw] id
|
661
|
+
# Unique identifier for the rule. The value cannot be longer than 255
|
662
|
+
# characters.
|
663
|
+
# @return [String]
|
664
|
+
#
|
659
665
|
# @!attribute [rw] allowed_headers
|
660
666
|
# Headers that are specified in the `Access-Control-Request-Headers`
|
661
667
|
# header. These headers are allowed in a preflight OPTIONS request. In
|
@@ -687,6 +693,7 @@ module Aws::S3
|
|
687
693
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CORSRule AWS API Documentation
|
688
694
|
#
|
689
695
|
class CORSRule < Struct.new(
|
696
|
+
:id,
|
690
697
|
:allowed_headers,
|
691
698
|
:allowed_methods,
|
692
699
|
:allowed_origins,
|
@@ -911,28 +918,28 @@ module Aws::S3
|
|
911
918
|
# @!attribute [rw] bucket
|
912
919
|
# The name of the bucket that contains the newly created object.
|
913
920
|
#
|
914
|
-
# When using this
|
915
|
-
# to the access point hostname. The access point hostname
|
916
|
-
# form
|
921
|
+
# When using this action with an access point, you must direct
|
922
|
+
# requests to the access point hostname. The access point hostname
|
923
|
+
# takes the form
|
917
924
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
918
|
-
# When using this
|
925
|
+
# When using this action with an access point through the AWS SDKs,
|
919
926
|
# you provide the access point ARN in place of the bucket name. For
|
920
927
|
# more information about access point ARNs, see [Using Access
|
921
|
-
# Points][1] in the *Amazon
|
928
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
922
929
|
#
|
923
|
-
# When using this
|
930
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
924
931
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
925
932
|
# takes the form
|
926
933
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
927
|
-
# When using this
|
934
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
928
935
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
929
936
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
930
|
-
# Outposts][2] in the *Amazon
|
937
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
931
938
|
#
|
932
939
|
#
|
933
940
|
#
|
934
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
935
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
941
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
942
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
936
943
|
# @return [String]
|
937
944
|
#
|
938
945
|
# @!attribute [rw] key
|
@@ -1049,7 +1056,7 @@ module Aws::S3
|
|
1049
1056
|
# @return [String]
|
1050
1057
|
#
|
1051
1058
|
# @!attribute [rw] expected_bucket_owner
|
1052
|
-
# The account
|
1059
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
1053
1060
|
# by a different account, the request will fail with an HTTP `403
|
1054
1061
|
# (Access Denied)` error.
|
1055
1062
|
# @return [String]
|
@@ -1153,6 +1160,14 @@ module Aws::S3
|
|
1153
1160
|
# `Condition` is specified and sibling `HttpErrorCodeReturnedEquals`
|
1154
1161
|
# is not specified. If both conditions are specified, both must be
|
1155
1162
|
# true for the redirect to be applied.
|
1163
|
+
#
|
1164
|
+
# Replacement must be made for object keys containing special
|
1165
|
+
# characters (such as carriage returns) when using XML requests. For
|
1166
|
+
# more information, see [ XML related object key constraints][1].
|
1167
|
+
#
|
1168
|
+
#
|
1169
|
+
#
|
1170
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
|
1156
1171
|
# @return [String]
|
1157
1172
|
#
|
1158
1173
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Condition AWS API Documentation
|
@@ -1305,28 +1320,28 @@ module Aws::S3
|
|
1305
1320
|
# @!attribute [rw] bucket
|
1306
1321
|
# The name of the destination bucket.
|
1307
1322
|
#
|
1308
|
-
# When using this
|
1309
|
-
# to the access point hostname. The access point hostname
|
1310
|
-
# form
|
1323
|
+
# When using this action with an access point, you must direct
|
1324
|
+
# requests to the access point hostname. The access point hostname
|
1325
|
+
# takes the form
|
1311
1326
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
1312
|
-
# When using this
|
1327
|
+
# When using this action with an access point through the AWS SDKs,
|
1313
1328
|
# you provide the access point ARN in place of the bucket name. For
|
1314
1329
|
# more information about access point ARNs, see [Using Access
|
1315
|
-
# Points][1] in the *Amazon
|
1330
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
1316
1331
|
#
|
1317
|
-
# When using this
|
1332
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
1318
1333
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
1319
1334
|
# takes the form
|
1320
1335
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
1321
|
-
# When using this
|
1336
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
1322
1337
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
1323
1338
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
1324
|
-
# Outposts][2] in the *Amazon
|
1339
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
1325
1340
|
#
|
1326
1341
|
#
|
1327
1342
|
#
|
1328
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1329
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1343
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
1344
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
1330
1345
|
# @return [String]
|
1331
1346
|
#
|
1332
1347
|
# @!attribute [rw] cache_control
|
@@ -1395,7 +1410,7 @@ module Aws::S3
|
|
1395
1410
|
#
|
1396
1411
|
#
|
1397
1412
|
#
|
1398
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1413
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
|
1399
1414
|
# @return [String]
|
1400
1415
|
#
|
1401
1416
|
# @!attribute [rw] copy_source_if_match
|
@@ -1533,7 +1548,7 @@ module Aws::S3
|
|
1533
1548
|
# Setting this header to `true` causes Amazon S3 to use an S3 Bucket
|
1534
1549
|
# Key for object encryption with SSE-KMS.
|
1535
1550
|
#
|
1536
|
-
# Specifying this header with a COPY
|
1551
|
+
# Specifying this header with a COPY action doesn’t affect
|
1537
1552
|
# bucket-level settings for S3 Bucket Key.
|
1538
1553
|
# @return [Boolean]
|
1539
1554
|
#
|
@@ -1587,13 +1602,13 @@ module Aws::S3
|
|
1587
1602
|
# @return [String]
|
1588
1603
|
#
|
1589
1604
|
# @!attribute [rw] expected_bucket_owner
|
1590
|
-
# The account
|
1605
|
+
# The account ID of the expected destination bucket owner. If the
|
1591
1606
|
# destination bucket is owned by a different account, the request will
|
1592
1607
|
# fail with an HTTP `403 (Access Denied)` error.
|
1593
1608
|
# @return [String]
|
1594
1609
|
#
|
1595
1610
|
# @!attribute [rw] expected_source_bucket_owner
|
1596
|
-
# The account
|
1611
|
+
# The account ID of the expected source bucket owner. If the source
|
1597
1612
|
# bucket is owned by a different account, the request will fail with
|
1598
1613
|
# an HTTP `403 (Access Denied)` error.
|
1599
1614
|
# @return [String]
|
@@ -1650,11 +1665,12 @@ module Aws::S3
|
|
1650
1665
|
# @!attribute [rw] etag
|
1651
1666
|
# Returns the ETag of the new object. The ETag reflects only changes
|
1652
1667
|
# to the contents of an object, not its metadata. The source and
|
1653
|
-
# destination ETag is identical for a successfully copied
|
1668
|
+
# destination ETag is identical for a successfully copied
|
1669
|
+
# non-multipart object.
|
1654
1670
|
# @return [String]
|
1655
1671
|
#
|
1656
1672
|
# @!attribute [rw] last_modified
|
1657
|
-
#
|
1673
|
+
# Creation date of the object.
|
1658
1674
|
# @return [Time]
|
1659
1675
|
#
|
1660
1676
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyObjectResult AWS API Documentation
|
@@ -1821,28 +1837,28 @@ module Aws::S3
|
|
1821
1837
|
# @!attribute [rw] bucket
|
1822
1838
|
# The name of the bucket to which the multipart upload was initiated.
|
1823
1839
|
#
|
1824
|
-
# When using this
|
1825
|
-
# to the access point hostname. The access point hostname
|
1826
|
-
# form
|
1840
|
+
# When using this action with an access point, you must direct
|
1841
|
+
# requests to the access point hostname. The access point hostname
|
1842
|
+
# takes the form
|
1827
1843
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
1828
|
-
# When using this
|
1844
|
+
# When using this action with an access point through the AWS SDKs,
|
1829
1845
|
# you provide the access point ARN in place of the bucket name. For
|
1830
1846
|
# more information about access point ARNs, see [Using Access
|
1831
|
-
# Points][1] in the *Amazon
|
1847
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
1832
1848
|
#
|
1833
|
-
# When using this
|
1849
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
1834
1850
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
1835
1851
|
# takes the form
|
1836
1852
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
1837
|
-
# When using this
|
1853
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
1838
1854
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
1839
1855
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
1840
|
-
# Outposts][2] in the *Amazon
|
1856
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
1841
1857
|
#
|
1842
1858
|
#
|
1843
1859
|
#
|
1844
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1845
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1860
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
1861
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
1846
1862
|
# @return [String]
|
1847
1863
|
#
|
1848
1864
|
# @!attribute [rw] key
|
@@ -1959,28 +1975,28 @@ module Aws::S3
|
|
1959
1975
|
# @!attribute [rw] bucket
|
1960
1976
|
# The name of the bucket to which to initiate the upload
|
1961
1977
|
#
|
1962
|
-
# When using this
|
1963
|
-
# to the access point hostname. The access point hostname
|
1964
|
-
# form
|
1978
|
+
# When using this action with an access point, you must direct
|
1979
|
+
# requests to the access point hostname. The access point hostname
|
1980
|
+
# takes the form
|
1965
1981
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
1966
|
-
# When using this
|
1982
|
+
# When using this action with an access point through the AWS SDKs,
|
1967
1983
|
# you provide the access point ARN in place of the bucket name. For
|
1968
1984
|
# more information about access point ARNs, see [Using Access
|
1969
|
-
# Points][1] in the *Amazon
|
1985
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
1970
1986
|
#
|
1971
|
-
# When using this
|
1987
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
1972
1988
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
1973
1989
|
# takes the form
|
1974
1990
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
1975
|
-
# When using this
|
1991
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
1976
1992
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
1977
1993
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
1978
|
-
# Outposts][2] in the *Amazon
|
1994
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
1979
1995
|
#
|
1980
1996
|
#
|
1981
1997
|
#
|
1982
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1983
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1998
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
1999
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
1984
2000
|
# @return [String]
|
1985
2001
|
#
|
1986
2002
|
# @!attribute [rw] cache_control
|
@@ -2097,7 +2113,7 @@ module Aws::S3
|
|
2097
2113
|
#
|
2098
2114
|
#
|
2099
2115
|
#
|
2100
|
-
# [1]: https://docs.aws.amazon.com/
|
2116
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
|
2101
2117
|
# @return [String]
|
2102
2118
|
#
|
2103
2119
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -2112,7 +2128,7 @@ module Aws::S3
|
|
2112
2128
|
# Setting this header to `true` causes Amazon S3 to use an S3 Bucket
|
2113
2129
|
# Key for object encryption with SSE-KMS.
|
2114
2130
|
#
|
2115
|
-
# Specifying this header with an object
|
2131
|
+
# Specifying this header with an object action doesn’t affect
|
2116
2132
|
# bucket-level settings for S3 Bucket Key.
|
2117
2133
|
# @return [Boolean]
|
2118
2134
|
#
|
@@ -2148,7 +2164,7 @@ module Aws::S3
|
|
2148
2164
|
# @return [String]
|
2149
2165
|
#
|
2150
2166
|
# @!attribute [rw] expected_bucket_owner
|
2151
|
-
# The account
|
2167
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
2152
2168
|
# by a different account, the request will fail with an HTTP `403
|
2153
2169
|
# (Access Denied)` error.
|
2154
2170
|
# @return [String]
|
@@ -2192,6 +2208,14 @@ module Aws::S3
|
|
2192
2208
|
# The container element for specifying the default Object Lock retention
|
2193
2209
|
# settings for new objects placed in the specified bucket.
|
2194
2210
|
#
|
2211
|
+
# <note markdown="1"> * The `DefaultRetention` settings require both a mode and a period.
|
2212
|
+
#
|
2213
|
+
# * The `DefaultRetention` period can be either `Days` or `Years` but
|
2214
|
+
# you must select one. You cannot specify `Days` and `Years` at the
|
2215
|
+
# same time.
|
2216
|
+
#
|
2217
|
+
# </note>
|
2218
|
+
#
|
2195
2219
|
# @note When making an API call, you may pass DefaultRetention
|
2196
2220
|
# data as a hash:
|
2197
2221
|
#
|
@@ -2203,17 +2227,18 @@ module Aws::S3
|
|
2203
2227
|
#
|
2204
2228
|
# @!attribute [rw] mode
|
2205
2229
|
# The default Object Lock retention mode you want to apply to new
|
2206
|
-
# objects placed in the specified bucket.
|
2230
|
+
# objects placed in the specified bucket. Must be used with either
|
2231
|
+
# `Days` or `Years`.
|
2207
2232
|
# @return [String]
|
2208
2233
|
#
|
2209
2234
|
# @!attribute [rw] days
|
2210
2235
|
# The number of days that you want to specify for the default
|
2211
|
-
# retention period.
|
2236
|
+
# retention period. Must be used with `Mode`.
|
2212
2237
|
# @return [Integer]
|
2213
2238
|
#
|
2214
2239
|
# @!attribute [rw] years
|
2215
2240
|
# The number of years that you want to specify for the default
|
2216
|
-
# retention period.
|
2241
|
+
# retention period. Must be used with `Mode`.
|
2217
2242
|
# @return [Integer]
|
2218
2243
|
#
|
2219
2244
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DefaultRetention AWS API Documentation
|
@@ -2278,7 +2303,7 @@ module Aws::S3
|
|
2278
2303
|
# @return [String]
|
2279
2304
|
#
|
2280
2305
|
# @!attribute [rw] expected_bucket_owner
|
2281
|
-
# The account
|
2306
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
2282
2307
|
# by a different account, the request will fail with an HTTP `403
|
2283
2308
|
# (Access Denied)` error.
|
2284
2309
|
# @return [String]
|
@@ -2306,7 +2331,7 @@ module Aws::S3
|
|
2306
2331
|
# @return [String]
|
2307
2332
|
#
|
2308
2333
|
# @!attribute [rw] expected_bucket_owner
|
2309
|
-
# The account
|
2334
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
2310
2335
|
# by a different account, the request will fail with an HTTP `403
|
2311
2336
|
# (Access Denied)` error.
|
2312
2337
|
# @return [String]
|
@@ -2334,7 +2359,7 @@ module Aws::S3
|
|
2334
2359
|
# @return [String]
|
2335
2360
|
#
|
2336
2361
|
# @!attribute [rw] expected_bucket_owner
|
2337
|
-
# The account
|
2362
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
2338
2363
|
# by a different account, the request will fail with an HTTP `403
|
2339
2364
|
# (Access Denied)` error.
|
2340
2365
|
# @return [String]
|
@@ -2393,7 +2418,7 @@ module Aws::S3
|
|
2393
2418
|
# @return [String]
|
2394
2419
|
#
|
2395
2420
|
# @!attribute [rw] expected_bucket_owner
|
2396
|
-
# The account
|
2421
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
2397
2422
|
# by a different account, the request will fail with an HTTP `403
|
2398
2423
|
# (Access Denied)` error.
|
2399
2424
|
# @return [String]
|
@@ -2421,7 +2446,7 @@ module Aws::S3
|
|
2421
2446
|
# @return [String]
|
2422
2447
|
#
|
2423
2448
|
# @!attribute [rw] expected_bucket_owner
|
2424
|
-
# The account
|
2449
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
2425
2450
|
# by a different account, the request will fail with an HTTP `403
|
2426
2451
|
# (Access Denied)` error.
|
2427
2452
|
# @return [String]
|
@@ -2454,7 +2479,7 @@ module Aws::S3
|
|
2454
2479
|
# @return [String]
|
2455
2480
|
#
|
2456
2481
|
# @!attribute [rw] expected_bucket_owner
|
2457
|
-
# The account
|
2482
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
2458
2483
|
# by a different account, the request will fail with an HTTP `403
|
2459
2484
|
# (Access Denied)` error.
|
2460
2485
|
# @return [String]
|
@@ -2482,7 +2507,7 @@ module Aws::S3
|
|
2482
2507
|
# @return [String]
|
2483
2508
|
#
|
2484
2509
|
# @!attribute [rw] expected_bucket_owner
|
2485
|
-
# The account
|
2510
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
2486
2511
|
# by a different account, the request will fail with an HTTP `403
|
2487
2512
|
# (Access Denied)` error.
|
2488
2513
|
# @return [String]
|
@@ -2509,7 +2534,7 @@ module Aws::S3
|
|
2509
2534
|
# @return [String]
|
2510
2535
|
#
|
2511
2536
|
# @!attribute [rw] expected_bucket_owner
|
2512
|
-
# The account
|
2537
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
2513
2538
|
# by a different account, the request will fail with an HTTP `403
|
2514
2539
|
# (Access Denied)` error.
|
2515
2540
|
# @return [String]
|
@@ -2536,7 +2561,7 @@ module Aws::S3
|
|
2536
2561
|
# @return [String]
|
2537
2562
|
#
|
2538
2563
|
# @!attribute [rw] expected_bucket_owner
|
2539
|
-
# The account
|
2564
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
2540
2565
|
# by a different account, the request will fail with an HTTP `403
|
2541
2566
|
# (Access Denied)` error.
|
2542
2567
|
# @return [String]
|
@@ -2563,7 +2588,7 @@ module Aws::S3
|
|
2563
2588
|
# @return [String]
|
2564
2589
|
#
|
2565
2590
|
# @!attribute [rw] expected_bucket_owner
|
2566
|
-
# The account
|
2591
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
2567
2592
|
# by a different account, the request will fail with an HTTP `403
|
2568
2593
|
# (Access Denied)` error.
|
2569
2594
|
# @return [String]
|
@@ -2590,7 +2615,7 @@ module Aws::S3
|
|
2590
2615
|
# @return [String]
|
2591
2616
|
#
|
2592
2617
|
# @!attribute [rw] expected_bucket_owner
|
2593
|
-
# The account
|
2618
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
2594
2619
|
# by a different account, the request will fail with an HTTP `403
|
2595
2620
|
# (Access Denied)` error.
|
2596
2621
|
# @return [String]
|
@@ -2618,7 +2643,7 @@ module Aws::S3
|
|
2618
2643
|
# @return [String]
|
2619
2644
|
#
|
2620
2645
|
# @!attribute [rw] expected_bucket_owner
|
2621
|
-
# The account
|
2646
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
2622
2647
|
# by a different account, the request will fail with an HTTP `403
|
2623
2648
|
# (Access Denied)` error.
|
2624
2649
|
# @return [String]
|
@@ -2754,28 +2779,28 @@ module Aws::S3
|
|
2754
2779
|
# @!attribute [rw] bucket
|
2755
2780
|
# The bucket name of the bucket containing the object.
|
2756
2781
|
#
|
2757
|
-
# When using this
|
2758
|
-
# to the access point hostname. The access point hostname
|
2759
|
-
# form
|
2782
|
+
# When using this action with an access point, you must direct
|
2783
|
+
# requests to the access point hostname. The access point hostname
|
2784
|
+
# takes the form
|
2760
2785
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2761
|
-
# When using this
|
2786
|
+
# When using this action with an access point through the AWS SDKs,
|
2762
2787
|
# you provide the access point ARN in place of the bucket name. For
|
2763
2788
|
# more information about access point ARNs, see [Using Access
|
2764
|
-
# Points][1] in the *Amazon
|
2789
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
2765
2790
|
#
|
2766
|
-
# When using this
|
2791
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
2767
2792
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2768
2793
|
# takes the form
|
2769
2794
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
2770
|
-
# When using this
|
2795
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
2771
2796
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
2772
2797
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
2773
|
-
# Outposts][2] in the *Amazon
|
2798
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
2774
2799
|
#
|
2775
2800
|
#
|
2776
2801
|
#
|
2777
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2778
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2802
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
2803
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
2779
2804
|
# @return [String]
|
2780
2805
|
#
|
2781
2806
|
# @!attribute [rw] key
|
@@ -2811,7 +2836,7 @@ module Aws::S3
|
|
2811
2836
|
# @return [Boolean]
|
2812
2837
|
#
|
2813
2838
|
# @!attribute [rw] expected_bucket_owner
|
2814
|
-
# The account
|
2839
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
2815
2840
|
# by a different account, the request will fail with an HTTP `403
|
2816
2841
|
# (Access Denied)` error.
|
2817
2842
|
# @return [String]
|
@@ -2856,32 +2881,33 @@ module Aws::S3
|
|
2856
2881
|
# The bucket name containing the objects from which to remove the
|
2857
2882
|
# tags.
|
2858
2883
|
#
|
2859
|
-
# When using this
|
2860
|
-
# to the access point hostname. The access point hostname
|
2861
|
-
# form
|
2884
|
+
# When using this action with an access point, you must direct
|
2885
|
+
# requests to the access point hostname. The access point hostname
|
2886
|
+
# takes the form
|
2862
2887
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2863
|
-
# When using this
|
2888
|
+
# When using this action with an access point through the AWS SDKs,
|
2864
2889
|
# you provide the access point ARN in place of the bucket name. For
|
2865
2890
|
# more information about access point ARNs, see [Using Access
|
2866
|
-
# Points][1] in the *Amazon
|
2891
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
2867
2892
|
#
|
2868
|
-
# When using this
|
2893
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
2869
2894
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2870
2895
|
# takes the form
|
2871
2896
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
2872
|
-
# When using this
|
2897
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
2873
2898
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
2874
2899
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
2875
|
-
# Outposts][2] in the *Amazon
|
2900
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
2876
2901
|
#
|
2877
2902
|
#
|
2878
2903
|
#
|
2879
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2880
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2904
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
2905
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
2881
2906
|
# @return [String]
|
2882
2907
|
#
|
2883
2908
|
# @!attribute [rw] key
|
2884
|
-
#
|
2909
|
+
# The key that identifies the object in the bucket from which to
|
2910
|
+
# remove all tags.
|
2885
2911
|
# @return [String]
|
2886
2912
|
#
|
2887
2913
|
# @!attribute [rw] version_id
|
@@ -2889,7 +2915,7 @@ module Aws::S3
|
|
2889
2915
|
# @return [String]
|
2890
2916
|
#
|
2891
2917
|
# @!attribute [rw] expected_bucket_owner
|
2892
|
-
# The account
|
2918
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
2893
2919
|
# by a different account, the request will fail with an HTTP `403
|
2894
2920
|
# (Access Denied)` error.
|
2895
2921
|
# @return [String]
|
@@ -2916,8 +2942,8 @@ module Aws::S3
|
|
2916
2942
|
# @return [String]
|
2917
2943
|
#
|
2918
2944
|
# @!attribute [rw] errors
|
2919
|
-
# Container for a failed delete
|
2920
|
-
#
|
2945
|
+
# Container for a failed delete action that describes the object that
|
2946
|
+
# Amazon S3 attempted to delete and the error it encountered.
|
2921
2947
|
# @return [Array<Types::Error>]
|
2922
2948
|
#
|
2923
2949
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjectsOutput AWS API Documentation
|
@@ -2953,28 +2979,28 @@ module Aws::S3
|
|
2953
2979
|
# @!attribute [rw] bucket
|
2954
2980
|
# The bucket name containing the objects to delete.
|
2955
2981
|
#
|
2956
|
-
# When using this
|
2957
|
-
# to the access point hostname. The access point hostname
|
2958
|
-
# form
|
2982
|
+
# When using this action with an access point, you must direct
|
2983
|
+
# requests to the access point hostname. The access point hostname
|
2984
|
+
# takes the form
|
2959
2985
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2960
|
-
# When using this
|
2986
|
+
# When using this action with an access point through the AWS SDKs,
|
2961
2987
|
# you provide the access point ARN in place of the bucket name. For
|
2962
2988
|
# more information about access point ARNs, see [Using Access
|
2963
|
-
# Points][1] in the *Amazon
|
2989
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
2964
2990
|
#
|
2965
|
-
# When using this
|
2991
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
2966
2992
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2967
2993
|
# takes the form
|
2968
2994
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
2969
|
-
# When using this
|
2995
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
2970
2996
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
2971
2997
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
2972
|
-
# Outposts][2] in the *Amazon
|
2998
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
2973
2999
|
#
|
2974
3000
|
#
|
2975
3001
|
#
|
2976
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2977
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3002
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
3003
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
2978
3004
|
# @return [String]
|
2979
3005
|
#
|
2980
3006
|
# @!attribute [rw] delete
|
@@ -3007,7 +3033,7 @@ module Aws::S3
|
|
3007
3033
|
# @return [Boolean]
|
3008
3034
|
#
|
3009
3035
|
# @!attribute [rw] expected_bucket_owner
|
3010
|
-
# The account
|
3036
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
3011
3037
|
# by a different account, the request will fail with an HTTP `403
|
3012
3038
|
# (Access Denied)` error.
|
3013
3039
|
# @return [String]
|
@@ -3039,7 +3065,7 @@ module Aws::S3
|
|
3039
3065
|
# @return [String]
|
3040
3066
|
#
|
3041
3067
|
# @!attribute [rw] expected_bucket_owner
|
3042
|
-
# The account
|
3068
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
3043
3069
|
# by a different account, the request will fail with an HTTP `403
|
3044
3070
|
# (Access Denied)` error.
|
3045
3071
|
# @return [String]
|
@@ -3307,7 +3333,7 @@ module Aws::S3
|
|
3307
3333
|
# * * *Code:* AccountProblem
|
3308
3334
|
#
|
3309
3335
|
# * *Description:* There is a problem with your AWS account that
|
3310
|
-
# prevents the
|
3336
|
+
# prevents the action from completing successfully. Contact AWS
|
3311
3337
|
# Support for further assistance.
|
3312
3338
|
#
|
3313
3339
|
# * *HTTP Status Code:* 403 Forbidden
|
@@ -3540,8 +3566,8 @@ module Aws::S3
|
|
3540
3566
|
#
|
3541
3567
|
# * * *Code:* InvalidObjectState
|
3542
3568
|
#
|
3543
|
-
# * *Description:* The
|
3544
|
-
#
|
3569
|
+
# * *Description:* The action is not valid for the current state of
|
3570
|
+
# the object.
|
3545
3571
|
#
|
3546
3572
|
# * *HTTP Status Code:* 403 Forbidden
|
3547
3573
|
#
|
@@ -3922,8 +3948,8 @@ module Aws::S3
|
|
3922
3948
|
#
|
3923
3949
|
# * * *Code:* OperationAborted
|
3924
3950
|
#
|
3925
|
-
# * *Description:* A conflicting conditional
|
3926
|
-
#
|
3951
|
+
# * *Description:* A conflicting conditional action is currently in
|
3952
|
+
# progress against this resource. Try again.
|
3927
3953
|
#
|
3928
3954
|
# * *HTTP Status Code:* 409 Conflict
|
3929
3955
|
#
|
@@ -4120,6 +4146,14 @@ module Aws::S3
|
|
4120
4146
|
#
|
4121
4147
|
# @!attribute [rw] key
|
4122
4148
|
# The object key name to use when a 4XX class error occurs.
|
4149
|
+
#
|
4150
|
+
# Replacement must be made for object keys containing special
|
4151
|
+
# characters (such as carriage returns) when using XML requests. For
|
4152
|
+
# more information, see [ XML related object key constraints][1].
|
4153
|
+
#
|
4154
|
+
#
|
4155
|
+
#
|
4156
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
|
4123
4157
|
# @return [String]
|
4124
4158
|
#
|
4125
4159
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ErrorDocument AWS API Documentation
|
@@ -4131,9 +4165,12 @@ module Aws::S3
|
|
4131
4165
|
end
|
4132
4166
|
|
4133
4167
|
# Optional configuration to replicate existing source bucket objects.
|
4134
|
-
# For more information, see [Replicating Existing Objects]
|
4135
|
-
#
|
4136
|
-
#
|
4168
|
+
# For more information, see [Replicating Existing Objects][1] in the
|
4169
|
+
# *Amazon S3 Developer Guide*.
|
4170
|
+
#
|
4171
|
+
#
|
4172
|
+
#
|
4173
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication
|
4137
4174
|
#
|
4138
4175
|
# @note When making an API call, you may pass ExistingObjectReplication
|
4139
4176
|
# data as a hash:
|
@@ -4169,7 +4206,7 @@ module Aws::S3
|
|
4169
4206
|
# to which the filtering rule applies. The maximum length is 1,024
|
4170
4207
|
# characters. Overlapping prefixes and suffixes are not supported. For
|
4171
4208
|
# more information, see [Configuring Event Notifications][1] in the
|
4172
|
-
# *Amazon
|
4209
|
+
# *Amazon S3 User Guide*.
|
4173
4210
|
#
|
4174
4211
|
#
|
4175
4212
|
#
|
@@ -4215,7 +4252,7 @@ module Aws::S3
|
|
4215
4252
|
# @return [String]
|
4216
4253
|
#
|
4217
4254
|
# @!attribute [rw] expected_bucket_owner
|
4218
|
-
# The account
|
4255
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4219
4256
|
# by a different account, the request will fail with an HTTP `403
|
4220
4257
|
# (Access Denied)` error.
|
4221
4258
|
# @return [String]
|
@@ -4259,7 +4296,7 @@ module Aws::S3
|
|
4259
4296
|
# @return [String]
|
4260
4297
|
#
|
4261
4298
|
# @!attribute [rw] expected_bucket_owner
|
4262
|
-
# The account
|
4299
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4263
4300
|
# by a different account, the request will fail with an HTTP `403
|
4264
4301
|
# (Access Denied)` error.
|
4265
4302
|
# @return [String]
|
@@ -4304,7 +4341,7 @@ module Aws::S3
|
|
4304
4341
|
# @return [String]
|
4305
4342
|
#
|
4306
4343
|
# @!attribute [rw] expected_bucket_owner
|
4307
|
-
# The account
|
4344
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4308
4345
|
# by a different account, the request will fail with an HTTP `403
|
4309
4346
|
# (Access Denied)` error.
|
4310
4347
|
# @return [String]
|
@@ -4345,7 +4382,7 @@ module Aws::S3
|
|
4345
4382
|
# @return [String]
|
4346
4383
|
#
|
4347
4384
|
# @!attribute [rw] expected_bucket_owner
|
4348
|
-
# The account
|
4385
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4349
4386
|
# by a different account, the request will fail with an HTTP `403
|
4350
4387
|
# (Access Denied)` error.
|
4351
4388
|
# @return [String]
|
@@ -4385,7 +4422,7 @@ module Aws::S3
|
|
4385
4422
|
# @return [String]
|
4386
4423
|
#
|
4387
4424
|
# @!attribute [rw] expected_bucket_owner
|
4388
|
-
# The account
|
4425
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4389
4426
|
# by a different account, the request will fail with an HTTP `403
|
4390
4427
|
# (Access Denied)` error.
|
4391
4428
|
# @return [String]
|
@@ -4468,7 +4505,7 @@ module Aws::S3
|
|
4468
4505
|
# @return [String]
|
4469
4506
|
#
|
4470
4507
|
# @!attribute [rw] expected_bucket_owner
|
4471
|
-
# The account
|
4508
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4472
4509
|
# by a different account, the request will fail with an HTTP `403
|
4473
4510
|
# (Access Denied)` error.
|
4474
4511
|
# @return [String]
|
@@ -4508,7 +4545,7 @@ module Aws::S3
|
|
4508
4545
|
# @return [String]
|
4509
4546
|
#
|
4510
4547
|
# @!attribute [rw] expected_bucket_owner
|
4511
|
-
# The account
|
4548
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4512
4549
|
# by a different account, the request will fail with an HTTP `403
|
4513
4550
|
# (Access Denied)` error.
|
4514
4551
|
# @return [String]
|
@@ -4547,7 +4584,7 @@ module Aws::S3
|
|
4547
4584
|
# @return [String]
|
4548
4585
|
#
|
4549
4586
|
# @!attribute [rw] expected_bucket_owner
|
4550
|
-
# The account
|
4587
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4551
4588
|
# by a different account, the request will fail with an HTTP `403
|
4552
4589
|
# (Access Denied)` error.
|
4553
4590
|
# @return [String]
|
@@ -4593,7 +4630,7 @@ module Aws::S3
|
|
4593
4630
|
# @return [String]
|
4594
4631
|
#
|
4595
4632
|
# @!attribute [rw] expected_bucket_owner
|
4596
|
-
# The account
|
4633
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4597
4634
|
# by a different account, the request will fail with an HTTP `403
|
4598
4635
|
# (Access Denied)` error.
|
4599
4636
|
# @return [String]
|
@@ -4639,7 +4676,7 @@ module Aws::S3
|
|
4639
4676
|
# @return [String]
|
4640
4677
|
#
|
4641
4678
|
# @!attribute [rw] expected_bucket_owner
|
4642
|
-
# The account
|
4679
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4643
4680
|
# by a different account, the request will fail with an HTTP `403
|
4644
4681
|
# (Access Denied)` error.
|
4645
4682
|
# @return [String]
|
@@ -4684,7 +4721,7 @@ module Aws::S3
|
|
4684
4721
|
# @return [String]
|
4685
4722
|
#
|
4686
4723
|
# @!attribute [rw] expected_bucket_owner
|
4687
|
-
# The account
|
4724
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4688
4725
|
# by a different account, the request will fail with an HTTP `403
|
4689
4726
|
# (Access Denied)` error.
|
4690
4727
|
# @return [String]
|
@@ -4713,7 +4750,7 @@ module Aws::S3
|
|
4713
4750
|
# @return [String]
|
4714
4751
|
#
|
4715
4752
|
# @!attribute [rw] expected_bucket_owner
|
4716
|
-
# The account
|
4753
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4717
4754
|
# by a different account, the request will fail with an HTTP `403
|
4718
4755
|
# (Access Denied)` error.
|
4719
4756
|
# @return [String]
|
@@ -4754,7 +4791,7 @@ module Aws::S3
|
|
4754
4791
|
# @return [String]
|
4755
4792
|
#
|
4756
4793
|
# @!attribute [rw] expected_bucket_owner
|
4757
|
-
# The account
|
4794
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4758
4795
|
# by a different account, the request will fail with an HTTP `403
|
4759
4796
|
# (Access Denied)` error.
|
4760
4797
|
# @return [String]
|
@@ -4793,7 +4830,7 @@ module Aws::S3
|
|
4793
4830
|
# @return [String]
|
4794
4831
|
#
|
4795
4832
|
# @!attribute [rw] expected_bucket_owner
|
4796
|
-
# The account
|
4833
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4797
4834
|
# by a different account, the request will fail with an HTTP `403
|
4798
4835
|
# (Access Denied)` error.
|
4799
4836
|
# @return [String]
|
@@ -4833,7 +4870,7 @@ module Aws::S3
|
|
4833
4870
|
# @return [String]
|
4834
4871
|
#
|
4835
4872
|
# @!attribute [rw] expected_bucket_owner
|
4836
|
-
# The account
|
4873
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4837
4874
|
# by a different account, the request will fail with an HTTP `403
|
4838
4875
|
# (Access Denied)` error.
|
4839
4876
|
# @return [String]
|
@@ -4873,7 +4910,7 @@ module Aws::S3
|
|
4873
4910
|
# @return [String]
|
4874
4911
|
#
|
4875
4912
|
# @!attribute [rw] expected_bucket_owner
|
4876
|
-
# The account
|
4913
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4877
4914
|
# by a different account, the request will fail with an HTTP `403
|
4878
4915
|
# (Access Denied)` error.
|
4879
4916
|
# @return [String]
|
@@ -4913,7 +4950,7 @@ module Aws::S3
|
|
4913
4950
|
# @return [String]
|
4914
4951
|
#
|
4915
4952
|
# @!attribute [rw] expected_bucket_owner
|
4916
|
-
# The account
|
4953
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4917
4954
|
# by a different account, the request will fail with an HTTP `403
|
4918
4955
|
# (Access Denied)` error.
|
4919
4956
|
# @return [String]
|
@@ -4952,7 +4989,7 @@ module Aws::S3
|
|
4952
4989
|
# @return [String]
|
4953
4990
|
#
|
4954
4991
|
# @!attribute [rw] expected_bucket_owner
|
4955
|
-
# The account
|
4992
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
4956
4993
|
# by a different account, the request will fail with an HTTP `403
|
4957
4994
|
# (Access Denied)` error.
|
4958
4995
|
# @return [String]
|
@@ -4999,7 +5036,7 @@ module Aws::S3
|
|
4999
5036
|
# @return [String]
|
5000
5037
|
#
|
5001
5038
|
# @!attribute [rw] expected_bucket_owner
|
5002
|
-
# The account
|
5039
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
5003
5040
|
# by a different account, the request will fail with an HTTP `403
|
5004
5041
|
# (Access Denied)` error.
|
5005
5042
|
# @return [String]
|
@@ -5057,7 +5094,7 @@ module Aws::S3
|
|
5057
5094
|
# @return [String]
|
5058
5095
|
#
|
5059
5096
|
# @!attribute [rw] expected_bucket_owner
|
5060
|
-
# The account
|
5097
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
5061
5098
|
# by a different account, the request will fail with an HTTP `403
|
5062
5099
|
# (Access Denied)` error.
|
5063
5100
|
# @return [String]
|
@@ -5109,18 +5146,18 @@ module Aws::S3
|
|
5109
5146
|
# The bucket name that contains the object for which to get the ACL
|
5110
5147
|
# information.
|
5111
5148
|
#
|
5112
|
-
# When using this
|
5113
|
-
# to the access point hostname. The access point hostname
|
5114
|
-
# form
|
5149
|
+
# When using this action with an access point, you must direct
|
5150
|
+
# requests to the access point hostname. The access point hostname
|
5151
|
+
# takes the form
|
5115
5152
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5116
|
-
# When using this
|
5153
|
+
# When using this action with an access point through the AWS SDKs,
|
5117
5154
|
# you provide the access point ARN in place of the bucket name. For
|
5118
5155
|
# more information about access point ARNs, see [Using Access
|
5119
|
-
# Points][1] in the *Amazon
|
5156
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
5120
5157
|
#
|
5121
5158
|
#
|
5122
5159
|
#
|
5123
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5160
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5124
5161
|
# @return [String]
|
5125
5162
|
#
|
5126
5163
|
# @!attribute [rw] key
|
@@ -5144,7 +5181,7 @@ module Aws::S3
|
|
5144
5181
|
# @return [String]
|
5145
5182
|
#
|
5146
5183
|
# @!attribute [rw] expected_bucket_owner
|
5147
|
-
# The account
|
5184
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
5148
5185
|
# by a different account, the request will fail with an HTTP `403
|
5149
5186
|
# (Access Denied)` error.
|
5150
5187
|
# @return [String]
|
@@ -5188,18 +5225,18 @@ module Aws::S3
|
|
5188
5225
|
# The bucket name containing the object whose Legal Hold status you
|
5189
5226
|
# want to retrieve.
|
5190
5227
|
#
|
5191
|
-
# When using this
|
5192
|
-
# to the access point hostname. The access point hostname
|
5193
|
-
# form
|
5228
|
+
# When using this action with an access point, you must direct
|
5229
|
+
# requests to the access point hostname. The access point hostname
|
5230
|
+
# takes the form
|
5194
5231
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5195
|
-
# When using this
|
5232
|
+
# When using this action with an access point through the AWS SDKs,
|
5196
5233
|
# you provide the access point ARN in place of the bucket name. For
|
5197
5234
|
# more information about access point ARNs, see [Using Access
|
5198
|
-
# Points][1] in the *Amazon
|
5235
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
5199
5236
|
#
|
5200
5237
|
#
|
5201
5238
|
#
|
5202
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5239
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5203
5240
|
# @return [String]
|
5204
5241
|
#
|
5205
5242
|
# @!attribute [rw] key
|
@@ -5225,7 +5262,7 @@ module Aws::S3
|
|
5225
5262
|
# @return [String]
|
5226
5263
|
#
|
5227
5264
|
# @!attribute [rw] expected_bucket_owner
|
5228
|
-
# The account
|
5265
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
5229
5266
|
# by a different account, the request will fail with an HTTP `403
|
5230
5267
|
# (Access Denied)` error.
|
5231
5268
|
# @return [String]
|
@@ -5265,22 +5302,22 @@ module Aws::S3
|
|
5265
5302
|
# @!attribute [rw] bucket
|
5266
5303
|
# The bucket whose Object Lock configuration you want to retrieve.
|
5267
5304
|
#
|
5268
|
-
# When using this
|
5269
|
-
# to the access point hostname. The access point hostname
|
5270
|
-
# form
|
5305
|
+
# When using this action with an access point, you must direct
|
5306
|
+
# requests to the access point hostname. The access point hostname
|
5307
|
+
# takes the form
|
5271
5308
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5272
|
-
# When using this
|
5309
|
+
# When using this action with an access point through the AWS SDKs,
|
5273
5310
|
# you provide the access point ARN in place of the bucket name. For
|
5274
5311
|
# more information about access point ARNs, see [Using Access
|
5275
|
-
# Points][1] in the *Amazon
|
5312
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
5276
5313
|
#
|
5277
5314
|
#
|
5278
5315
|
#
|
5279
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5316
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5280
5317
|
# @return [String]
|
5281
5318
|
#
|
5282
5319
|
# @!attribute [rw] expected_bucket_owner
|
5283
|
-
# The account
|
5320
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
5284
5321
|
# by a different account, the request will fail with an HTTP `403
|
5285
5322
|
# (Access Denied)` error.
|
5286
5323
|
# @return [String]
|
@@ -5316,12 +5353,12 @@ module Aws::S3
|
|
5316
5353
|
# @return [String]
|
5317
5354
|
#
|
5318
5355
|
# @!attribute [rw] restore
|
5319
|
-
# Provides information about object restoration
|
5320
|
-
#
|
5356
|
+
# Provides information about object restoration action and expiration
|
5357
|
+
# time of the restored object copy.
|
5321
5358
|
# @return [String]
|
5322
5359
|
#
|
5323
5360
|
# @!attribute [rw] last_modified
|
5324
|
-
#
|
5361
|
+
# Creation date of the object.
|
5325
5362
|
# @return [Time]
|
5326
5363
|
#
|
5327
5364
|
# @!attribute [rw] content_length
|
@@ -5525,28 +5562,28 @@ module Aws::S3
|
|
5525
5562
|
# @!attribute [rw] bucket
|
5526
5563
|
# The bucket name containing the object.
|
5527
5564
|
#
|
5528
|
-
# When using this
|
5529
|
-
# to the access point hostname. The access point hostname
|
5530
|
-
# form
|
5565
|
+
# When using this action with an access point, you must direct
|
5566
|
+
# requests to the access point hostname. The access point hostname
|
5567
|
+
# takes the form
|
5531
5568
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5532
|
-
# When using this
|
5569
|
+
# When using this action with an access point through the AWS SDKs,
|
5533
5570
|
# you provide the access point ARN in place of the bucket name. For
|
5534
5571
|
# more information about access point ARNs, see [Using Access
|
5535
|
-
# Points][1] in the *Amazon
|
5572
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
5536
5573
|
#
|
5537
|
-
# When using this
|
5574
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
5538
5575
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5539
5576
|
# takes the form
|
5540
5577
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
5541
|
-
# When using this
|
5578
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
5542
5579
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
5543
5580
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
5544
|
-
# Outposts][2] in the *Amazon
|
5581
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
5545
5582
|
#
|
5546
5583
|
#
|
5547
5584
|
#
|
5548
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5549
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5585
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5586
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
5550
5587
|
# @return [String]
|
5551
5588
|
#
|
5552
5589
|
# @!attribute [rw] if_match
|
@@ -5617,14 +5654,14 @@ module Aws::S3
|
|
5617
5654
|
# @return [String]
|
5618
5655
|
#
|
5619
5656
|
# @!attribute [rw] sse_customer_algorithm
|
5620
|
-
# Specifies the algorithm to use to when
|
5657
|
+
# Specifies the algorithm to use to when decrypting the object (for
|
5621
5658
|
# example, AES256).
|
5622
5659
|
# @return [String]
|
5623
5660
|
#
|
5624
5661
|
# @!attribute [rw] sse_customer_key
|
5625
|
-
# Specifies the customer-provided encryption key for Amazon S3 to
|
5626
|
-
#
|
5627
|
-
# it
|
5662
|
+
# Specifies the customer-provided encryption key for Amazon S3 used to
|
5663
|
+
# encrypt the data. This value is used to decrypt the object when
|
5664
|
+
# recovering it and must match the one used when storing the data. The
|
5628
5665
|
# key must be appropriate for use with the algorithm specified in the
|
5629
5666
|
# `x-amz-server-side-encryption-customer-algorithm` header.
|
5630
5667
|
# @return [String]
|
@@ -5655,7 +5692,7 @@ module Aws::S3
|
|
5655
5692
|
# @return [Integer]
|
5656
5693
|
#
|
5657
5694
|
# @!attribute [rw] expected_bucket_owner
|
5658
|
-
# The account
|
5695
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
5659
5696
|
# by a different account, the request will fail with an HTTP `403
|
5660
5697
|
# (Access Denied)` error.
|
5661
5698
|
# @return [String]
|
@@ -5714,18 +5751,18 @@ module Aws::S3
|
|
5714
5751
|
# The bucket name containing the object whose retention settings you
|
5715
5752
|
# want to retrieve.
|
5716
5753
|
#
|
5717
|
-
# When using this
|
5718
|
-
# to the access point hostname. The access point hostname
|
5719
|
-
# form
|
5754
|
+
# When using this action with an access point, you must direct
|
5755
|
+
# requests to the access point hostname. The access point hostname
|
5756
|
+
# takes the form
|
5720
5757
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5721
|
-
# When using this
|
5758
|
+
# When using this action with an access point through the AWS SDKs,
|
5722
5759
|
# you provide the access point ARN in place of the bucket name. For
|
5723
5760
|
# more information about access point ARNs, see [Using Access
|
5724
|
-
# Points][1] in the *Amazon
|
5761
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
5725
5762
|
#
|
5726
5763
|
#
|
5727
5764
|
#
|
5728
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5765
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5729
5766
|
# @return [String]
|
5730
5767
|
#
|
5731
5768
|
# @!attribute [rw] key
|
@@ -5751,7 +5788,7 @@ module Aws::S3
|
|
5751
5788
|
# @return [String]
|
5752
5789
|
#
|
5753
5790
|
# @!attribute [rw] expected_bucket_owner
|
5754
|
-
# The account
|
5791
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
5755
5792
|
# by a different account, the request will fail with an HTTP `403
|
5756
5793
|
# (Access Denied)` error.
|
5757
5794
|
# @return [String]
|
@@ -5794,34 +5831,35 @@ module Aws::S3
|
|
5794
5831
|
# key: "ObjectKey", # required
|
5795
5832
|
# version_id: "ObjectVersionId",
|
5796
5833
|
# expected_bucket_owner: "AccountId",
|
5834
|
+
# request_payer: "requester", # accepts requester
|
5797
5835
|
# }
|
5798
5836
|
#
|
5799
5837
|
# @!attribute [rw] bucket
|
5800
5838
|
# The bucket name containing the object for which to get the tagging
|
5801
5839
|
# information.
|
5802
5840
|
#
|
5803
|
-
# When using this
|
5804
|
-
# to the access point hostname. The access point hostname
|
5805
|
-
# form
|
5841
|
+
# When using this action with an access point, you must direct
|
5842
|
+
# requests to the access point hostname. The access point hostname
|
5843
|
+
# takes the form
|
5806
5844
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5807
|
-
# When using this
|
5845
|
+
# When using this action with an access point through the AWS SDKs,
|
5808
5846
|
# you provide the access point ARN in place of the bucket name. For
|
5809
5847
|
# more information about access point ARNs, see [Using Access
|
5810
|
-
# Points][1] in the *Amazon
|
5848
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
5811
5849
|
#
|
5812
|
-
# When using this
|
5850
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
5813
5851
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5814
5852
|
# takes the form
|
5815
5853
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
5816
|
-
# When using this
|
5854
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
5817
5855
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
5818
5856
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
5819
|
-
# Outposts][2] in the *Amazon
|
5857
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
5820
5858
|
#
|
5821
5859
|
#
|
5822
5860
|
#
|
5823
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5824
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5861
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5862
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
5825
5863
|
# @return [String]
|
5826
5864
|
#
|
5827
5865
|
# @!attribute [rw] key
|
@@ -5834,18 +5872,31 @@ module Aws::S3
|
|
5834
5872
|
# @return [String]
|
5835
5873
|
#
|
5836
5874
|
# @!attribute [rw] expected_bucket_owner
|
5837
|
-
# The account
|
5875
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
5838
5876
|
# by a different account, the request will fail with an HTTP `403
|
5839
5877
|
# (Access Denied)` error.
|
5840
5878
|
# @return [String]
|
5841
5879
|
#
|
5880
|
+
# @!attribute [rw] request_payer
|
5881
|
+
# Confirms that the requester knows that they will be charged for the
|
5882
|
+
# request. Bucket owners need not specify this parameter in their
|
5883
|
+
# requests. For information about downloading objects from requester
|
5884
|
+
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
5885
|
+
# in the *Amazon S3 Developer Guide*.
|
5886
|
+
#
|
5887
|
+
#
|
5888
|
+
#
|
5889
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
5890
|
+
# @return [String]
|
5891
|
+
#
|
5842
5892
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTaggingRequest AWS API Documentation
|
5843
5893
|
#
|
5844
5894
|
class GetObjectTaggingRequest < Struct.new(
|
5845
5895
|
:bucket,
|
5846
5896
|
:key,
|
5847
5897
|
:version_id,
|
5848
|
-
:expected_bucket_owner
|
5898
|
+
:expected_bucket_owner,
|
5899
|
+
:request_payer)
|
5849
5900
|
SENSITIVE = []
|
5850
5901
|
include Aws::Structure
|
5851
5902
|
end
|
@@ -5900,7 +5951,7 @@ module Aws::S3
|
|
5900
5951
|
# @return [String]
|
5901
5952
|
#
|
5902
5953
|
# @!attribute [rw] expected_bucket_owner
|
5903
|
-
# The account
|
5954
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
5904
5955
|
# by a different account, the request will fail with an HTTP `403
|
5905
5956
|
# (Access Denied)` error.
|
5906
5957
|
# @return [String]
|
@@ -5943,7 +5994,7 @@ module Aws::S3
|
|
5943
5994
|
# @return [String]
|
5944
5995
|
#
|
5945
5996
|
# @!attribute [rw] expected_bucket_owner
|
5946
|
-
# The account
|
5997
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
5947
5998
|
# by a different account, the request will fail with an HTTP `403
|
5948
5999
|
# (Access Denied)` error.
|
5949
6000
|
# @return [String]
|
@@ -6095,32 +6146,32 @@ module Aws::S3
|
|
6095
6146
|
# @!attribute [rw] bucket
|
6096
6147
|
# The bucket name.
|
6097
6148
|
#
|
6098
|
-
# When using this
|
6099
|
-
# to the access point hostname. The access point hostname
|
6100
|
-
# form
|
6149
|
+
# When using this action with an access point, you must direct
|
6150
|
+
# requests to the access point hostname. The access point hostname
|
6151
|
+
# takes the form
|
6101
6152
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6102
|
-
# When using this
|
6153
|
+
# When using this action with an access point through the AWS SDKs,
|
6103
6154
|
# you provide the access point ARN in place of the bucket name. For
|
6104
6155
|
# more information about access point ARNs, see [Using Access
|
6105
|
-
# Points][1] in the *Amazon
|
6156
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
6106
6157
|
#
|
6107
|
-
# When using this
|
6158
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
6108
6159
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
6109
6160
|
# takes the form
|
6110
6161
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
6111
|
-
# When using this
|
6162
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
6112
6163
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
6113
6164
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
6114
|
-
# Outposts][2] in the *Amazon
|
6165
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
6115
6166
|
#
|
6116
6167
|
#
|
6117
6168
|
#
|
6118
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6119
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6169
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
6170
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
6120
6171
|
# @return [String]
|
6121
6172
|
#
|
6122
6173
|
# @!attribute [rw] expected_bucket_owner
|
6123
|
-
# The account
|
6174
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
6124
6175
|
# by a different account, the request will fail with an HTTP `403
|
6125
6176
|
# (Access Denied)` error.
|
6126
6177
|
# @return [String]
|
@@ -6160,7 +6211,7 @@ module Aws::S3
|
|
6160
6211
|
# If an archive copy is already restored, the header value indicates
|
6161
6212
|
# when Amazon S3 is scheduled to delete the object copy. For example:
|
6162
6213
|
#
|
6163
|
-
# `x-amz-restore: ongoing-request="false", expiry-date="Fri,
|
6214
|
+
# `x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec
|
6164
6215
|
# 2012 00:00:00 GMT"`
|
6165
6216
|
#
|
6166
6217
|
# If the object restoration is in progress, the header returns the
|
@@ -6180,7 +6231,7 @@ module Aws::S3
|
|
6180
6231
|
# @return [String]
|
6181
6232
|
#
|
6182
6233
|
# @!attribute [rw] last_modified
|
6183
|
-
#
|
6234
|
+
# Creation date of the object.
|
6184
6235
|
# @return [Time]
|
6185
6236
|
#
|
6186
6237
|
# @!attribute [rw] content_length
|
@@ -6431,28 +6482,28 @@ module Aws::S3
|
|
6431
6482
|
# @!attribute [rw] bucket
|
6432
6483
|
# The name of the bucket containing the object.
|
6433
6484
|
#
|
6434
|
-
# When using this
|
6435
|
-
# to the access point hostname. The access point hostname
|
6436
|
-
# form
|
6485
|
+
# When using this action with an access point, you must direct
|
6486
|
+
# requests to the access point hostname. The access point hostname
|
6487
|
+
# takes the form
|
6437
6488
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6438
|
-
# When using this
|
6489
|
+
# When using this action with an access point through the AWS SDKs,
|
6439
6490
|
# you provide the access point ARN in place of the bucket name. For
|
6440
6491
|
# more information about access point ARNs, see [Using Access
|
6441
|
-
# Points][1] in the *Amazon
|
6492
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
6442
6493
|
#
|
6443
|
-
# When using this
|
6494
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
6444
6495
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
6445
6496
|
# takes the form
|
6446
6497
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
6447
|
-
# When using this
|
6498
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
6448
6499
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
6449
6500
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
6450
|
-
# Outposts][2] in the *Amazon
|
6501
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
6451
6502
|
#
|
6452
6503
|
#
|
6453
6504
|
#
|
6454
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6455
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6505
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
6506
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
6456
6507
|
# @return [String]
|
6457
6508
|
#
|
6458
6509
|
# @!attribute [rw] if_match
|
@@ -6537,7 +6588,7 @@ module Aws::S3
|
|
6537
6588
|
# @return [Integer]
|
6538
6589
|
#
|
6539
6590
|
# @!attribute [rw] expected_bucket_owner
|
6540
|
-
# The account
|
6591
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
6541
6592
|
# by a different account, the request will fail with an HTTP `403
|
6542
6593
|
# (Access Denied)` error.
|
6543
6594
|
# @return [String]
|
@@ -6578,6 +6629,14 @@ module Aws::S3
|
|
6578
6629
|
# you make a request to samplebucket/images/ the data that is returned
|
6579
6630
|
# will be for the object with the key name images/index.html) The
|
6580
6631
|
# suffix must not be empty and must not include a slash character.
|
6632
|
+
#
|
6633
|
+
# Replacement must be made for object keys containing special
|
6634
|
+
# characters (such as carriage returns) when using XML requests. For
|
6635
|
+
# more information, see [ XML related object key constraints][1].
|
6636
|
+
#
|
6637
|
+
#
|
6638
|
+
#
|
6639
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
|
6581
6640
|
# @return [String]
|
6582
6641
|
#
|
6583
6642
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/IndexDocument AWS API Documentation
|
@@ -6790,6 +6849,14 @@ module Aws::S3
|
|
6790
6849
|
# @!attribute [rw] prefix
|
6791
6850
|
# An object key name prefix that identifies the subset of objects to
|
6792
6851
|
# which the rule applies.
|
6852
|
+
#
|
6853
|
+
# Replacement must be made for object keys containing special
|
6854
|
+
# characters (such as carriage returns) when using XML requests. For
|
6855
|
+
# more information, see [ XML related object key constraints][1].
|
6856
|
+
#
|
6857
|
+
#
|
6858
|
+
#
|
6859
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
|
6793
6860
|
# @return [String]
|
6794
6861
|
#
|
6795
6862
|
# @!attribute [rw] tag
|
@@ -7168,7 +7235,7 @@ module Aws::S3
|
|
7168
7235
|
# @!attribute [rw] events
|
7169
7236
|
# The Amazon S3 bucket event for which to invoke the AWS Lambda
|
7170
7237
|
# function. For more information, see [Supported Event Types][1] in
|
7171
|
-
# the *Amazon
|
7238
|
+
# the *Amazon S3 User Guide*.
|
7172
7239
|
#
|
7173
7240
|
#
|
7174
7241
|
#
|
@@ -7178,7 +7245,7 @@ module Aws::S3
|
|
7178
7245
|
# @!attribute [rw] filter
|
7179
7246
|
# Specifies object key name filtering rules. For information about key
|
7180
7247
|
# name filtering, see [Configuring Event Notifications][1] in the
|
7181
|
-
# *Amazon
|
7248
|
+
# *Amazon S3 User Guide*.
|
7182
7249
|
#
|
7183
7250
|
#
|
7184
7251
|
#
|
@@ -7344,13 +7411,22 @@ module Aws::S3
|
|
7344
7411
|
#
|
7345
7412
|
# @!attribute [rw] prefix
|
7346
7413
|
# Prefix identifying one or more objects to which the rule applies.
|
7347
|
-
# This is
|
7414
|
+
# This is no longer used; use `Filter` instead.
|
7415
|
+
#
|
7416
|
+
# Replacement must be made for object keys containing special
|
7417
|
+
# characters (such as carriage returns) when using XML requests. For
|
7418
|
+
# more information, see [ XML related object key constraints][1].
|
7419
|
+
#
|
7420
|
+
#
|
7421
|
+
#
|
7422
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
|
7348
7423
|
# @return [String]
|
7349
7424
|
#
|
7350
7425
|
# @!attribute [rw] filter
|
7351
7426
|
# The `Filter` is used to identify objects that a Lifecycle Rule
|
7352
7427
|
# applies to. A `Filter` must have exactly one of `Prefix`, `Tag`, or
|
7353
|
-
# `And` specified.
|
7428
|
+
# `And` specified. `Filter` is required if the `LifecycleRule` does
|
7429
|
+
# not containt a `Prefix` element.
|
7354
7430
|
# @return [Types::LifecycleRuleFilter]
|
7355
7431
|
#
|
7356
7432
|
# @!attribute [rw] status
|
@@ -7386,7 +7462,7 @@ module Aws::S3
|
|
7386
7462
|
# upload that Amazon S3 will wait before permanently removing all
|
7387
7463
|
# parts of the upload. For more information, see [ Aborting Incomplete
|
7388
7464
|
# Multipart Uploads Using a Bucket Lifecycle Policy][1] in the *Amazon
|
7389
|
-
#
|
7465
|
+
# S3 User Guide*.
|
7390
7466
|
#
|
7391
7467
|
#
|
7392
7468
|
#
|
@@ -7470,6 +7546,14 @@ module Aws::S3
|
|
7470
7546
|
#
|
7471
7547
|
# @!attribute [rw] prefix
|
7472
7548
|
# Prefix identifying one or more objects to which the rule applies.
|
7549
|
+
#
|
7550
|
+
# Replacement must be made for object keys containing special
|
7551
|
+
# characters (such as carriage returns) when using XML requests. For
|
7552
|
+
# more information, see [ XML related object key constraints][1].
|
7553
|
+
#
|
7554
|
+
#
|
7555
|
+
#
|
7556
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
|
7473
7557
|
# @return [String]
|
7474
7558
|
#
|
7475
7559
|
# @!attribute [rw] tag
|
@@ -7548,7 +7632,7 @@ module Aws::S3
|
|
7548
7632
|
# @return [String]
|
7549
7633
|
#
|
7550
7634
|
# @!attribute [rw] expected_bucket_owner
|
7551
|
-
# The account
|
7635
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
7552
7636
|
# by a different account, the request will fail with an HTTP `403
|
7553
7637
|
# (Access Denied)` error.
|
7554
7638
|
# @return [String]
|
@@ -7679,7 +7763,7 @@ module Aws::S3
|
|
7679
7763
|
# @return [String]
|
7680
7764
|
#
|
7681
7765
|
# @!attribute [rw] expected_bucket_owner
|
7682
|
-
# The account
|
7766
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
7683
7767
|
# by a different account, the request will fail with an HTTP `403
|
7684
7768
|
# (Access Denied)` error.
|
7685
7769
|
# @return [String]
|
@@ -7751,7 +7835,7 @@ module Aws::S3
|
|
7751
7835
|
# @return [String]
|
7752
7836
|
#
|
7753
7837
|
# @!attribute [rw] expected_bucket_owner
|
7754
|
-
# The account
|
7838
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
7755
7839
|
# by a different account, the request will fail with an HTTP `403
|
7756
7840
|
# (Access Denied)` error.
|
7757
7841
|
# @return [String]
|
@@ -7890,28 +7974,28 @@ module Aws::S3
|
|
7890
7974
|
# @!attribute [rw] bucket
|
7891
7975
|
# The name of the bucket to which the multipart upload was initiated.
|
7892
7976
|
#
|
7893
|
-
# When using this
|
7894
|
-
# to the access point hostname. The access point hostname
|
7895
|
-
# form
|
7977
|
+
# When using this action with an access point, you must direct
|
7978
|
+
# requests to the access point hostname. The access point hostname
|
7979
|
+
# takes the form
|
7896
7980
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7897
|
-
# When using this
|
7981
|
+
# When using this action with an access point through the AWS SDKs,
|
7898
7982
|
# you provide the access point ARN in place of the bucket name. For
|
7899
7983
|
# more information about access point ARNs, see [Using Access
|
7900
|
-
# Points][1] in the *Amazon
|
7984
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
7901
7985
|
#
|
7902
|
-
# When using this
|
7986
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
7903
7987
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7904
7988
|
# takes the form
|
7905
7989
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
7906
|
-
# When using this
|
7990
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
7907
7991
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
7908
7992
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
7909
|
-
# Outposts][2] in the *Amazon
|
7993
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
7910
7994
|
#
|
7911
7995
|
#
|
7912
7996
|
#
|
7913
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7914
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7997
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7998
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7915
7999
|
# @return [String]
|
7916
8000
|
#
|
7917
8001
|
# @!attribute [rw] delimiter
|
@@ -7972,7 +8056,7 @@ module Aws::S3
|
|
7972
8056
|
# @return [String]
|
7973
8057
|
#
|
7974
8058
|
# @!attribute [rw] expected_bucket_owner
|
7975
|
-
# The account
|
8059
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
7976
8060
|
# by a different account, the request will fail with an HTTP `403
|
7977
8061
|
# (Access Denied)` error.
|
7978
8062
|
# @return [String]
|
@@ -8130,7 +8214,7 @@ module Aws::S3
|
|
8130
8214
|
#
|
8131
8215
|
# @!attribute [rw] max_keys
|
8132
8216
|
# Sets the maximum number of keys returned in the response. By default
|
8133
|
-
# the
|
8217
|
+
# the action returns up to 1,000 key names. The response might contain
|
8134
8218
|
# fewer keys but will never contain more. If additional keys satisfy
|
8135
8219
|
# the search criteria, but were not returned because max-keys was
|
8136
8220
|
# exceeded, the response contains
|
@@ -8152,7 +8236,7 @@ module Aws::S3
|
|
8152
8236
|
# @return [String]
|
8153
8237
|
#
|
8154
8238
|
# @!attribute [rw] expected_bucket_owner
|
8155
|
-
# The account
|
8239
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
8156
8240
|
# by a different account, the request will fail with an HTTP `403
|
8157
8241
|
# (Access Denied)` error.
|
8158
8242
|
# @return [String]
|
@@ -8218,8 +8302,8 @@ module Aws::S3
|
|
8218
8302
|
# @return [Integer]
|
8219
8303
|
#
|
8220
8304
|
# @!attribute [rw] common_prefixes
|
8221
|
-
# All of the keys rolled up in a common prefix count as
|
8222
|
-
# return when calculating the number of returns.
|
8305
|
+
# All of the keys (up to 1,000) rolled up in a common prefix count as
|
8306
|
+
# a single return when calculating the number of returns.
|
8223
8307
|
#
|
8224
8308
|
# A response can contain CommonPrefixes only if you specify a
|
8225
8309
|
# delimiter.
|
@@ -8275,28 +8359,28 @@ module Aws::S3
|
|
8275
8359
|
# @!attribute [rw] bucket
|
8276
8360
|
# The name of the bucket containing the objects.
|
8277
8361
|
#
|
8278
|
-
# When using this
|
8279
|
-
# to the access point hostname. The access point hostname
|
8280
|
-
# form
|
8362
|
+
# When using this action with an access point, you must direct
|
8363
|
+
# requests to the access point hostname. The access point hostname
|
8364
|
+
# takes the form
|
8281
8365
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
8282
|
-
# When using this
|
8366
|
+
# When using this action with an access point through the AWS SDKs,
|
8283
8367
|
# you provide the access point ARN in place of the bucket name. For
|
8284
8368
|
# more information about access point ARNs, see [Using Access
|
8285
|
-
# Points][1] in the *Amazon
|
8369
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
8286
8370
|
#
|
8287
|
-
# When using this
|
8371
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
8288
8372
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
8289
8373
|
# takes the form
|
8290
8374
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
8291
|
-
# When using this
|
8375
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
8292
8376
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
8293
8377
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
8294
|
-
# Outposts][2] in the *Amazon
|
8378
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
8295
8379
|
#
|
8296
8380
|
#
|
8297
8381
|
#
|
8298
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8299
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8382
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
8383
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
8300
8384
|
# @return [String]
|
8301
8385
|
#
|
8302
8386
|
# @!attribute [rw] delimiter
|
@@ -8318,7 +8402,7 @@ module Aws::S3
|
|
8318
8402
|
#
|
8319
8403
|
# @!attribute [rw] max_keys
|
8320
8404
|
# Sets the maximum number of keys returned in the response. By default
|
8321
|
-
# the
|
8405
|
+
# the action returns up to 1,000 key names. The response might contain
|
8322
8406
|
# fewer keys but will never contain more.
|
8323
8407
|
# @return [Integer]
|
8324
8408
|
#
|
@@ -8333,7 +8417,7 @@ module Aws::S3
|
|
8333
8417
|
# @return [String]
|
8334
8418
|
#
|
8335
8419
|
# @!attribute [rw] expected_bucket_owner
|
8336
|
-
# The account
|
8420
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
8337
8421
|
# by a different account, the request will fail with an HTTP `403
|
8338
8422
|
# (Access Denied)` error.
|
8339
8423
|
# @return [String]
|
@@ -8366,28 +8450,28 @@ module Aws::S3
|
|
8366
8450
|
# @!attribute [rw] name
|
8367
8451
|
# The bucket name.
|
8368
8452
|
#
|
8369
|
-
# When using this
|
8370
|
-
# to the access point hostname. The access point hostname
|
8371
|
-
# form
|
8453
|
+
# When using this action with an access point, you must direct
|
8454
|
+
# requests to the access point hostname. The access point hostname
|
8455
|
+
# takes the form
|
8372
8456
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
8373
|
-
# When using this
|
8457
|
+
# When using this action with an access point through the AWS SDKs,
|
8374
8458
|
# you provide the access point ARN in place of the bucket name. For
|
8375
8459
|
# more information about access point ARNs, see [Using Access
|
8376
|
-
# Points][1] in the *Amazon
|
8460
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
8377
8461
|
#
|
8378
|
-
# When using this
|
8462
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
8379
8463
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
8380
8464
|
# takes the form
|
8381
8465
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
8382
|
-
# When using this
|
8466
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
8383
8467
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
8384
8468
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
8385
|
-
# Outposts][2] in the *Amazon
|
8469
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
8386
8470
|
#
|
8387
8471
|
#
|
8388
8472
|
#
|
8389
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8390
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8473
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
8474
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
8391
8475
|
# @return [String]
|
8392
8476
|
#
|
8393
8477
|
# @!attribute [rw] prefix
|
@@ -8404,13 +8488,13 @@ module Aws::S3
|
|
8404
8488
|
#
|
8405
8489
|
# @!attribute [rw] max_keys
|
8406
8490
|
# Sets the maximum number of keys returned in the response. By default
|
8407
|
-
# the
|
8491
|
+
# the action returns up to 1,000 key names. The response might contain
|
8408
8492
|
# fewer keys but will never contain more.
|
8409
8493
|
# @return [Integer]
|
8410
8494
|
#
|
8411
8495
|
# @!attribute [rw] common_prefixes
|
8412
|
-
# All of the keys rolled up into a common prefix count
|
8413
|
-
# return when calculating the number of returns.
|
8496
|
+
# All of the keys (up to 1,000) rolled up into a common prefix count
|
8497
|
+
# as a single return when calculating the number of returns.
|
8414
8498
|
#
|
8415
8499
|
# A response can contain `CommonPrefixes` only if you specify a
|
8416
8500
|
# delimiter.
|
@@ -8441,8 +8525,8 @@ module Aws::S3
|
|
8441
8525
|
#
|
8442
8526
|
# @!attribute [rw] key_count
|
8443
8527
|
# KeyCount is the number of keys returned with this request. KeyCount
|
8444
|
-
# will always be less than equals to MaxKeys field. Say you ask for
|
8445
|
-
# keys, your result will include less than equals 50 keys
|
8528
|
+
# will always be less than or equals to MaxKeys field. Say you ask for
|
8529
|
+
# 50 keys, your result will include less than equals 50 keys
|
8446
8530
|
# @return [Integer]
|
8447
8531
|
#
|
8448
8532
|
# @!attribute [rw] continuation_token
|
@@ -8501,28 +8585,28 @@ module Aws::S3
|
|
8501
8585
|
# @!attribute [rw] bucket
|
8502
8586
|
# Bucket name to list.
|
8503
8587
|
#
|
8504
|
-
# When using this
|
8505
|
-
# to the access point hostname. The access point hostname
|
8506
|
-
# form
|
8588
|
+
# When using this action with an access point, you must direct
|
8589
|
+
# requests to the access point hostname. The access point hostname
|
8590
|
+
# takes the form
|
8507
8591
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
8508
|
-
# When using this
|
8592
|
+
# When using this action with an access point through the AWS SDKs,
|
8509
8593
|
# you provide the access point ARN in place of the bucket name. For
|
8510
8594
|
# more information about access point ARNs, see [Using Access
|
8511
|
-
# Points][1] in the *Amazon
|
8595
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
8512
8596
|
#
|
8513
|
-
# When using this
|
8597
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
8514
8598
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
8515
8599
|
# takes the form
|
8516
8600
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
8517
|
-
# When using this
|
8601
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
8518
8602
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
8519
8603
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
8520
|
-
# Outposts][2] in the *Amazon
|
8604
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
8521
8605
|
#
|
8522
8606
|
#
|
8523
8607
|
#
|
8524
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8525
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8608
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
8609
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
8526
8610
|
# @return [String]
|
8527
8611
|
#
|
8528
8612
|
# @!attribute [rw] delimiter
|
@@ -8536,7 +8620,7 @@ module Aws::S3
|
|
8536
8620
|
#
|
8537
8621
|
# @!attribute [rw] max_keys
|
8538
8622
|
# Sets the maximum number of keys returned in the response. By default
|
8539
|
-
# the
|
8623
|
+
# the action returns up to 1,000 key names. The response might contain
|
8540
8624
|
# fewer keys but will never contain more.
|
8541
8625
|
# @return [Integer]
|
8542
8626
|
#
|
@@ -8569,7 +8653,7 @@ module Aws::S3
|
|
8569
8653
|
# @return [String]
|
8570
8654
|
#
|
8571
8655
|
# @!attribute [rw] expected_bucket_owner
|
8572
|
-
# The account
|
8656
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
8573
8657
|
# by a different account, the request will fail with an HTTP `403
|
8574
8658
|
# (Access Denied)` error.
|
8575
8659
|
# @return [String]
|
@@ -8716,28 +8800,28 @@ module Aws::S3
|
|
8716
8800
|
# @!attribute [rw] bucket
|
8717
8801
|
# The name of the bucket to which the parts are being uploaded.
|
8718
8802
|
#
|
8719
|
-
# When using this
|
8720
|
-
# to the access point hostname. The access point hostname
|
8721
|
-
# form
|
8803
|
+
# When using this action with an access point, you must direct
|
8804
|
+
# requests to the access point hostname. The access point hostname
|
8805
|
+
# takes the form
|
8722
8806
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
8723
|
-
# When using this
|
8807
|
+
# When using this action with an access point through the AWS SDKs,
|
8724
8808
|
# you provide the access point ARN in place of the bucket name. For
|
8725
8809
|
# more information about access point ARNs, see [Using Access
|
8726
|
-
# Points][1] in the *Amazon
|
8810
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
8727
8811
|
#
|
8728
|
-
# When using this
|
8812
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
8729
8813
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
8730
8814
|
# takes the form
|
8731
8815
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
8732
|
-
# When using this
|
8816
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
8733
8817
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
8734
8818
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
8735
|
-
# Outposts][2] in the *Amazon
|
8819
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
8736
8820
|
#
|
8737
8821
|
#
|
8738
8822
|
#
|
8739
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8740
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8823
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
8824
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
8741
8825
|
# @return [String]
|
8742
8826
|
#
|
8743
8827
|
# @!attribute [rw] key
|
@@ -8771,7 +8855,7 @@ module Aws::S3
|
|
8771
8855
|
# @return [String]
|
8772
8856
|
#
|
8773
8857
|
# @!attribute [rw] expected_bucket_owner
|
8774
|
-
# The account
|
8858
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
8775
8859
|
# by a different account, the request will fail with an HTTP `403
|
8776
8860
|
# (Access Denied)` error.
|
8777
8861
|
# @return [String]
|
@@ -9157,8 +9241,7 @@ module Aws::S3
|
|
9157
9241
|
# Specifies the number of days an object is noncurrent before Amazon
|
9158
9242
|
# S3 can perform the associated action. For information about the
|
9159
9243
|
# noncurrent days calculations, see [How Amazon S3 Calculates How Long
|
9160
|
-
# an Object Has Been Noncurrent][1] in the *Amazon
|
9161
|
-
# Service Developer Guide*.
|
9244
|
+
# an Object Has Been Noncurrent][1] in the *Amazon S3 User Guide*.
|
9162
9245
|
#
|
9163
9246
|
#
|
9164
9247
|
#
|
@@ -9318,7 +9401,7 @@ module Aws::S3
|
|
9318
9401
|
|
9319
9402
|
# Specifies object key name filtering rules. For information about key
|
9320
9403
|
# name filtering, see [Configuring Event Notifications][1] in the
|
9321
|
-
# *Amazon
|
9404
|
+
# *Amazon S3 User Guide*.
|
9322
9405
|
#
|
9323
9406
|
#
|
9324
9407
|
#
|
@@ -9358,7 +9441,7 @@ module Aws::S3
|
|
9358
9441
|
# @return [String]
|
9359
9442
|
#
|
9360
9443
|
# @!attribute [rw] last_modified
|
9361
|
-
#
|
9444
|
+
# Creation date of the object.
|
9362
9445
|
# @return [Time]
|
9363
9446
|
#
|
9364
9447
|
# @!attribute [rw] etag
|
@@ -9408,7 +9491,7 @@ module Aws::S3
|
|
9408
9491
|
include Aws::Structure
|
9409
9492
|
end
|
9410
9493
|
|
9411
|
-
# This
|
9494
|
+
# This action is not allowed against this storage tier.
|
9412
9495
|
#
|
9413
9496
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectAlreadyInActiveTierError AWS API Documentation
|
9414
9497
|
#
|
@@ -9425,7 +9508,15 @@ module Aws::S3
|
|
9425
9508
|
# }
|
9426
9509
|
#
|
9427
9510
|
# @!attribute [rw] key
|
9428
|
-
# Key name of the object
|
9511
|
+
# Key name of the object.
|
9512
|
+
#
|
9513
|
+
# Replacement must be made for object keys containing special
|
9514
|
+
# characters (such as carriage returns) when using XML requests. For
|
9515
|
+
# more information, see [ XML related object key constraints][1].
|
9516
|
+
#
|
9517
|
+
#
|
9518
|
+
#
|
9519
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
|
9429
9520
|
# @return [String]
|
9430
9521
|
#
|
9431
9522
|
# @!attribute [rw] version_id
|
@@ -9459,11 +9550,16 @@ module Aws::S3
|
|
9459
9550
|
#
|
9460
9551
|
# @!attribute [rw] object_lock_enabled
|
9461
9552
|
# Indicates whether this bucket has an Object Lock configuration
|
9462
|
-
# enabled.
|
9553
|
+
# enabled. Enable `ObjectLockEnabled` when you apply
|
9554
|
+
# `ObjectLockConfiguration` to a bucket.
|
9463
9555
|
# @return [String]
|
9464
9556
|
#
|
9465
9557
|
# @!attribute [rw] rule
|
9466
|
-
#
|
9558
|
+
# Specifies the Object Lock rule for the specified object. Enable the
|
9559
|
+
# this rule when you apply `ObjectLockConfiguration` to a bucket.
|
9560
|
+
# Bucket settings require both a mode and a period. The period can be
|
9561
|
+
# either `Days` or `Years` but you must select one. You cannot specify
|
9562
|
+
# `Days` and `Years` at the same time.
|
9467
9563
|
# @return [Types::ObjectLockRule]
|
9468
9564
|
#
|
9469
9565
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectLockConfiguration AWS API Documentation
|
@@ -9537,8 +9633,11 @@ module Aws::S3
|
|
9537
9633
|
# }
|
9538
9634
|
#
|
9539
9635
|
# @!attribute [rw] default_retention
|
9540
|
-
# The default retention period that you want to
|
9541
|
-
# placed in the specified bucket.
|
9636
|
+
# The default Object Lock retention mode and period that you want to
|
9637
|
+
# apply to new objects placed in the specified bucket. Bucket settings
|
9638
|
+
# require both a mode and a period. The period can be either `Days` or
|
9639
|
+
# `Years` but you must select one. You cannot specify `Days` and
|
9640
|
+
# `Years` at the same time.
|
9542
9641
|
# @return [Types::DefaultRetention]
|
9543
9642
|
#
|
9544
9643
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectLockRule AWS API Documentation
|
@@ -9549,8 +9648,8 @@ module Aws::S3
|
|
9549
9648
|
include Aws::Structure
|
9550
9649
|
end
|
9551
9650
|
|
9552
|
-
# The source object of the COPY
|
9553
|
-
#
|
9651
|
+
# The source object of the COPY action is not in the active tier and is
|
9652
|
+
# only stored in Amazon S3 Glacier.
|
9554
9653
|
#
|
9555
9654
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectNotInActiveTierError AWS API Documentation
|
9556
9655
|
#
|
@@ -9877,7 +9976,7 @@ module Aws::S3
|
|
9877
9976
|
# Amazon S3 bucket. You can enable the configuration options in any
|
9878
9977
|
# combination. For more information about when Amazon S3 considers a
|
9879
9978
|
# bucket or object public, see [The Meaning of "Public"][1] in the
|
9880
|
-
# *Amazon
|
9979
|
+
# *Amazon S3 User Guide*.
|
9881
9980
|
#
|
9882
9981
|
#
|
9883
9982
|
#
|
@@ -9971,7 +10070,7 @@ module Aws::S3
|
|
9971
10070
|
# @return [Types::AccelerateConfiguration]
|
9972
10071
|
#
|
9973
10072
|
# @!attribute [rw] expected_bucket_owner
|
9974
|
-
# The account
|
10073
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
9975
10074
|
# by a different account, the request will fail with an HTTP `403
|
9976
10075
|
# (Access Denied)` error.
|
9977
10076
|
# @return [String]
|
@@ -10069,7 +10168,7 @@ module Aws::S3
|
|
10069
10168
|
# @return [String]
|
10070
10169
|
#
|
10071
10170
|
# @!attribute [rw] expected_bucket_owner
|
10072
|
-
# The account
|
10171
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
10073
10172
|
# by a different account, the request will fail with an HTTP `403
|
10074
10173
|
# (Access Denied)` error.
|
10075
10174
|
# @return [String]
|
@@ -10146,7 +10245,7 @@ module Aws::S3
|
|
10146
10245
|
# @return [Types::AnalyticsConfiguration]
|
10147
10246
|
#
|
10148
10247
|
# @!attribute [rw] expected_bucket_owner
|
10149
|
-
# The account
|
10248
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
10150
10249
|
# by a different account, the request will fail with an HTTP `403
|
10151
10250
|
# (Access Denied)` error.
|
10152
10251
|
# @return [String]
|
@@ -10170,6 +10269,7 @@ module Aws::S3
|
|
10170
10269
|
# cors_configuration: { # required
|
10171
10270
|
# cors_rules: [ # required
|
10172
10271
|
# {
|
10272
|
+
# id: "ID",
|
10173
10273
|
# allowed_headers: ["AllowedHeader"],
|
10174
10274
|
# allowed_methods: ["AllowedMethod"], # required
|
10175
10275
|
# allowed_origins: ["AllowedOrigin"], # required
|
@@ -10189,8 +10289,7 @@ module Aws::S3
|
|
10189
10289
|
# @!attribute [rw] cors_configuration
|
10190
10290
|
# Describes the cross-origin access configuration for objects in an
|
10191
10291
|
# Amazon S3 bucket. For more information, see [Enabling Cross-Origin
|
10192
|
-
# Resource Sharing][1] in the *Amazon
|
10193
|
-
# Guide*.
|
10292
|
+
# Resource Sharing][1] in the *Amazon S3 User Guide*.
|
10194
10293
|
#
|
10195
10294
|
#
|
10196
10295
|
#
|
@@ -10212,7 +10311,7 @@ module Aws::S3
|
|
10212
10311
|
# @return [String]
|
10213
10312
|
#
|
10214
10313
|
# @!attribute [rw] expected_bucket_owner
|
10215
|
-
# The account
|
10314
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
10216
10315
|
# by a different account, the request will fail with an HTTP `403
|
10217
10316
|
# (Access Denied)` error.
|
10218
10317
|
# @return [String]
|
@@ -10253,8 +10352,7 @@ module Aws::S3
|
|
10253
10352
|
# encryption with Amazon S3-managed keys (SSE-S3) or customer master
|
10254
10353
|
# keys stored in AWS KMS (SSE-KMS). For information about the Amazon
|
10255
10354
|
# S3 default encryption feature, see [Amazon S3 Default Bucket
|
10256
|
-
# Encryption][1] in the *Amazon
|
10257
|
-
# Guide*.
|
10355
|
+
# Encryption][1] in the *Amazon S3 User Guide*.
|
10258
10356
|
#
|
10259
10357
|
#
|
10260
10358
|
#
|
@@ -10274,7 +10372,7 @@ module Aws::S3
|
|
10274
10372
|
# @return [Types::ServerSideEncryptionConfiguration]
|
10275
10373
|
#
|
10276
10374
|
# @!attribute [rw] expected_bucket_owner
|
10277
|
-
# The account
|
10375
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
10278
10376
|
# by a different account, the request will fail with an HTTP `403
|
10279
10377
|
# (Access Denied)` error.
|
10280
10378
|
# @return [String]
|
@@ -10397,7 +10495,7 @@ module Aws::S3
|
|
10397
10495
|
# @return [Types::InventoryConfiguration]
|
10398
10496
|
#
|
10399
10497
|
# @!attribute [rw] expected_bucket_owner
|
10400
|
-
# The account
|
10498
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
10401
10499
|
# by a different account, the request will fail with an HTTP `403
|
10402
10500
|
# (Access Denied)` error.
|
10403
10501
|
# @return [String]
|
@@ -10479,7 +10577,7 @@ module Aws::S3
|
|
10479
10577
|
# @return [Types::BucketLifecycleConfiguration]
|
10480
10578
|
#
|
10481
10579
|
# @!attribute [rw] expected_bucket_owner
|
10482
|
-
# The account
|
10580
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
10483
10581
|
# by a different account, the request will fail with an HTTP `403
|
10484
10582
|
# (Access Denied)` error.
|
10485
10583
|
# @return [String]
|
@@ -10544,7 +10642,7 @@ module Aws::S3
|
|
10544
10642
|
# @return [Types::LifecycleConfiguration]
|
10545
10643
|
#
|
10546
10644
|
# @!attribute [rw] expected_bucket_owner
|
10547
|
-
# The account
|
10645
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
10548
10646
|
# by a different account, the request will fail with an HTTP `403
|
10549
10647
|
# (Access Denied)` error.
|
10550
10648
|
# @return [String]
|
@@ -10603,7 +10701,7 @@ module Aws::S3
|
|
10603
10701
|
# @return [String]
|
10604
10702
|
#
|
10605
10703
|
# @!attribute [rw] expected_bucket_owner
|
10606
|
-
# The account
|
10704
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
10607
10705
|
# by a different account, the request will fail with an HTTP `403
|
10608
10706
|
# (Access Denied)` error.
|
10609
10707
|
# @return [String]
|
@@ -10660,7 +10758,7 @@ module Aws::S3
|
|
10660
10758
|
# @return [Types::MetricsConfiguration]
|
10661
10759
|
#
|
10662
10760
|
# @!attribute [rw] expected_bucket_owner
|
10663
|
-
# The account
|
10761
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
10664
10762
|
# by a different account, the request will fail with an HTTP `403
|
10665
10763
|
# (Access Denied)` error.
|
10666
10764
|
# @return [String]
|
@@ -10748,7 +10846,7 @@ module Aws::S3
|
|
10748
10846
|
# @return [Types::NotificationConfiguration]
|
10749
10847
|
#
|
10750
10848
|
# @!attribute [rw] expected_bucket_owner
|
10751
|
-
# The account
|
10849
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
10752
10850
|
# by a different account, the request will fail with an HTTP `403
|
10753
10851
|
# (Access Denied)` error.
|
10754
10852
|
# @return [String]
|
@@ -10809,7 +10907,7 @@ module Aws::S3
|
|
10809
10907
|
# @return [Types::NotificationConfigurationDeprecated]
|
10810
10908
|
#
|
10811
10909
|
# @!attribute [rw] expected_bucket_owner
|
10812
|
-
# The account
|
10910
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
10813
10911
|
# by a different account, the request will fail with an HTTP `403
|
10814
10912
|
# (Access Denied)` error.
|
10815
10913
|
# @return [String]
|
@@ -10854,7 +10952,7 @@ module Aws::S3
|
|
10854
10952
|
# @return [String]
|
10855
10953
|
#
|
10856
10954
|
# @!attribute [rw] expected_bucket_owner
|
10857
|
-
# The account
|
10955
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
10858
10956
|
# by a different account, the request will fail with an HTTP `403
|
10859
10957
|
# (Access Denied)` error.
|
10860
10958
|
# @return [String]
|
@@ -10907,7 +11005,7 @@ module Aws::S3
|
|
10907
11005
|
# @return [String]
|
10908
11006
|
#
|
10909
11007
|
# @!attribute [rw] expected_bucket_owner
|
10910
|
-
# The account
|
11008
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
10911
11009
|
# by a different account, the request will fail with an HTTP `403
|
10912
11010
|
# (Access Denied)` error.
|
10913
11011
|
# @return [String]
|
@@ -11026,7 +11124,7 @@ module Aws::S3
|
|
11026
11124
|
# @return [String]
|
11027
11125
|
#
|
11028
11126
|
# @!attribute [rw] expected_bucket_owner
|
11029
|
-
# The account
|
11127
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
11030
11128
|
# by a different account, the request will fail with an HTTP `403
|
11031
11129
|
# (Access Denied)` error.
|
11032
11130
|
# @return [String]
|
@@ -11060,9 +11158,9 @@ module Aws::S3
|
|
11060
11158
|
# @return [String]
|
11061
11159
|
#
|
11062
11160
|
# @!attribute [rw] content_md5
|
11063
|
-
#
|
11064
|
-
#
|
11065
|
-
#
|
11161
|
+
# The base64-encoded 128-bit MD5 digest of the data. You must use this
|
11162
|
+
# header as a message integrity check to verify that the request body
|
11163
|
+
# was not corrupted in transit. For more information, see [RFC
|
11066
11164
|
# 1864][1].
|
11067
11165
|
#
|
11068
11166
|
# For requests made using the AWS Command Line Interface (CLI) or AWS
|
@@ -11078,7 +11176,7 @@ module Aws::S3
|
|
11078
11176
|
# @return [Types::RequestPaymentConfiguration]
|
11079
11177
|
#
|
11080
11178
|
# @!attribute [rw] expected_bucket_owner
|
11081
|
-
# The account
|
11179
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
11082
11180
|
# by a different account, the request will fail with an HTTP `403
|
11083
11181
|
# (Access Denied)` error.
|
11084
11182
|
# @return [String]
|
@@ -11134,7 +11232,7 @@ module Aws::S3
|
|
11134
11232
|
# @return [Types::Tagging]
|
11135
11233
|
#
|
11136
11234
|
# @!attribute [rw] expected_bucket_owner
|
11137
|
-
# The account
|
11235
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
11138
11236
|
# by a different account, the request will fail with an HTTP `403
|
11139
11237
|
# (Access Denied)` error.
|
11140
11238
|
# @return [String]
|
@@ -11193,7 +11291,7 @@ module Aws::S3
|
|
11193
11291
|
# @return [Types::VersioningConfiguration]
|
11194
11292
|
#
|
11195
11293
|
# @!attribute [rw] expected_bucket_owner
|
11196
|
-
# The account
|
11294
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
11197
11295
|
# by a different account, the request will fail with an HTTP `403
|
11198
11296
|
# (Access Denied)` error.
|
11199
11297
|
# @return [String]
|
@@ -11269,7 +11367,7 @@ module Aws::S3
|
|
11269
11367
|
# @return [Types::WebsiteConfiguration]
|
11270
11368
|
#
|
11271
11369
|
# @!attribute [rw] expected_bucket_owner
|
11272
|
-
# The account
|
11370
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
11273
11371
|
# by a different account, the request will fail with an HTTP `403
|
11274
11372
|
# (Access Denied)` error.
|
11275
11373
|
# @return [String]
|
@@ -11352,18 +11450,18 @@ module Aws::S3
|
|
11352
11450
|
# The bucket name that contains the object to which you want to attach
|
11353
11451
|
# the ACL.
|
11354
11452
|
#
|
11355
|
-
# When using this
|
11356
|
-
# to the access point hostname. The access point hostname
|
11357
|
-
# form
|
11453
|
+
# When using this action with an access point, you must direct
|
11454
|
+
# requests to the access point hostname. The access point hostname
|
11455
|
+
# takes the form
|
11358
11456
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11359
|
-
# When using this
|
11457
|
+
# When using this action with an access point through the AWS SDKs,
|
11360
11458
|
# you provide the access point ARN in place of the bucket name. For
|
11361
11459
|
# more information about access point ARNs, see [Using Access
|
11362
|
-
# Points][1] in the *Amazon
|
11460
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
11363
11461
|
#
|
11364
11462
|
#
|
11365
11463
|
#
|
11366
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11464
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11367
11465
|
# @return [String]
|
11368
11466
|
#
|
11369
11467
|
# @!attribute [rw] content_md5
|
@@ -11411,30 +11509,30 @@ module Aws::S3
|
|
11411
11509
|
# @return [String]
|
11412
11510
|
#
|
11413
11511
|
# @!attribute [rw] key
|
11414
|
-
# Key for which the PUT
|
11512
|
+
# Key for which the PUT action was initiated.
|
11415
11513
|
#
|
11416
|
-
# When using this
|
11417
|
-
# to the access point hostname. The access point hostname
|
11418
|
-
# form
|
11514
|
+
# When using this action with an access point, you must direct
|
11515
|
+
# requests to the access point hostname. The access point hostname
|
11516
|
+
# takes the form
|
11419
11517
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11420
|
-
# When using this
|
11518
|
+
# When using this action with an access point through the AWS SDKs,
|
11421
11519
|
# you provide the access point ARN in place of the bucket name. For
|
11422
11520
|
# more information about access point ARNs, see [Using Access
|
11423
|
-
# Points][1] in the *Amazon
|
11521
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
11424
11522
|
#
|
11425
|
-
# When using this
|
11523
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
11426
11524
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
11427
11525
|
# takes the form
|
11428
11526
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
11429
|
-
# When using this
|
11527
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
11430
11528
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
11431
11529
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
11432
|
-
# Outposts][2] in the *Amazon
|
11530
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
11433
11531
|
#
|
11434
11532
|
#
|
11435
11533
|
#
|
11436
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11437
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11534
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11535
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
11438
11536
|
# @return [String]
|
11439
11537
|
#
|
11440
11538
|
# @!attribute [rw] request_payer
|
@@ -11454,7 +11552,7 @@ module Aws::S3
|
|
11454
11552
|
# @return [String]
|
11455
11553
|
#
|
11456
11554
|
# @!attribute [rw] expected_bucket_owner
|
11457
|
-
# The account
|
11555
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
11458
11556
|
# by a different account, the request will fail with an HTTP `403
|
11459
11557
|
# (Access Denied)` error.
|
11460
11558
|
# @return [String]
|
@@ -11511,18 +11609,18 @@ module Aws::S3
|
|
11511
11609
|
# The bucket name containing the object that you want to place a Legal
|
11512
11610
|
# Hold on.
|
11513
11611
|
#
|
11514
|
-
# When using this
|
11515
|
-
# to the access point hostname. The access point hostname
|
11516
|
-
# form
|
11612
|
+
# When using this action with an access point, you must direct
|
11613
|
+
# requests to the access point hostname. The access point hostname
|
11614
|
+
# takes the form
|
11517
11615
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11518
|
-
# When using this
|
11616
|
+
# When using this action with an access point through the AWS SDKs,
|
11519
11617
|
# you provide the access point ARN in place of the bucket name. For
|
11520
11618
|
# more information about access point ARNs, see [Using Access
|
11521
|
-
# Points][1] in the *Amazon
|
11619
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
11522
11620
|
#
|
11523
11621
|
#
|
11524
11622
|
#
|
11525
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11623
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11526
11624
|
# @return [String]
|
11527
11625
|
#
|
11528
11626
|
# @!attribute [rw] key
|
@@ -11558,7 +11656,7 @@ module Aws::S3
|
|
11558
11656
|
# @return [String]
|
11559
11657
|
#
|
11560
11658
|
# @!attribute [rw] expected_bucket_owner
|
11561
|
-
# The account
|
11659
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
11562
11660
|
# by a different account, the request will fail with an HTTP `403
|
11563
11661
|
# (Access Denied)` error.
|
11564
11662
|
# @return [String]
|
@@ -11645,7 +11743,7 @@ module Aws::S3
|
|
11645
11743
|
# @return [String]
|
11646
11744
|
#
|
11647
11745
|
# @!attribute [rw] expected_bucket_owner
|
11648
|
-
# The account
|
11746
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
11649
11747
|
# by a different account, the request will fail with an HTTP `403
|
11650
11748
|
# (Access Denied)` error.
|
11651
11749
|
# @return [String]
|
@@ -11800,30 +11898,30 @@ module Aws::S3
|
|
11800
11898
|
# @return [IO]
|
11801
11899
|
#
|
11802
11900
|
# @!attribute [rw] bucket
|
11803
|
-
# The bucket name to which the PUT
|
11901
|
+
# The bucket name to which the PUT action was initiated.
|
11804
11902
|
#
|
11805
|
-
# When using this
|
11806
|
-
# to the access point hostname. The access point hostname
|
11807
|
-
# form
|
11903
|
+
# When using this action with an access point, you must direct
|
11904
|
+
# requests to the access point hostname. The access point hostname
|
11905
|
+
# takes the form
|
11808
11906
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11809
|
-
# When using this
|
11907
|
+
# When using this action with an access point through the AWS SDKs,
|
11810
11908
|
# you provide the access point ARN in place of the bucket name. For
|
11811
11909
|
# more information about access point ARNs, see [Using Access
|
11812
|
-
# Points][1] in the *Amazon
|
11910
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
11813
11911
|
#
|
11814
|
-
# When using this
|
11912
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
11815
11913
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
11816
11914
|
# takes the form
|
11817
11915
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
11818
|
-
# When using this
|
11916
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
11819
11917
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
11820
11918
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
11821
|
-
# Outposts][2] in the *Amazon
|
11919
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
11822
11920
|
#
|
11823
11921
|
#
|
11824
11922
|
#
|
11825
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11826
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11923
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11924
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
11827
11925
|
# @return [String]
|
11828
11926
|
#
|
11829
11927
|
# @!attribute [rw] cache_control
|
@@ -11933,7 +12031,7 @@ module Aws::S3
|
|
11933
12031
|
# @return [String]
|
11934
12032
|
#
|
11935
12033
|
# @!attribute [rw] key
|
11936
|
-
# Object key for which the PUT
|
12034
|
+
# Object key for which the PUT action was initiated.
|
11937
12035
|
# @return [String]
|
11938
12036
|
#
|
11939
12037
|
# @!attribute [rw] metadata
|
@@ -12031,8 +12129,8 @@ module Aws::S3
|
|
12031
12129
|
# Setting this header to `true` causes Amazon S3 to use an S3 Bucket
|
12032
12130
|
# Key for object encryption with SSE-KMS.
|
12033
12131
|
#
|
12034
|
-
# Specifying this header with a PUT
|
12035
|
-
#
|
12132
|
+
# Specifying this header with a PUT action doesn’t affect bucket-level
|
12133
|
+
# settings for S3 Bucket Key.
|
12036
12134
|
# @return [Boolean]
|
12037
12135
|
#
|
12038
12136
|
# @!attribute [rw] request_payer
|
@@ -12071,7 +12169,7 @@ module Aws::S3
|
|
12071
12169
|
# @return [String]
|
12072
12170
|
#
|
12073
12171
|
# @!attribute [rw] expected_bucket_owner
|
12074
|
-
# The account
|
12172
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
12075
12173
|
# by a different account, the request will fail with an HTTP `403
|
12076
12174
|
# (Access Denied)` error.
|
12077
12175
|
# @return [String]
|
@@ -12149,18 +12247,18 @@ module Aws::S3
|
|
12149
12247
|
# The bucket name that contains the object you want to apply this
|
12150
12248
|
# Object Retention configuration to.
|
12151
12249
|
#
|
12152
|
-
# When using this
|
12153
|
-
# to the access point hostname. The access point hostname
|
12154
|
-
# form
|
12250
|
+
# When using this action with an access point, you must direct
|
12251
|
+
# requests to the access point hostname. The access point hostname
|
12252
|
+
# takes the form
|
12155
12253
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
12156
|
-
# When using this
|
12254
|
+
# When using this action with an access point through the AWS SDKs,
|
12157
12255
|
# you provide the access point ARN in place of the bucket name. For
|
12158
12256
|
# more information about access point ARNs, see [Using Access
|
12159
|
-
# Points][1] in the *Amazon
|
12257
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
12160
12258
|
#
|
12161
12259
|
#
|
12162
12260
|
#
|
12163
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12261
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
12164
12262
|
# @return [String]
|
12165
12263
|
#
|
12166
12264
|
# @!attribute [rw] key
|
@@ -12190,7 +12288,7 @@ module Aws::S3
|
|
12190
12288
|
# @return [String]
|
12191
12289
|
#
|
12192
12290
|
# @!attribute [rw] bypass_governance_retention
|
12193
|
-
# Indicates whether this
|
12291
|
+
# Indicates whether this action should bypass Governance-mode
|
12194
12292
|
# restrictions.
|
12195
12293
|
# @return [Boolean]
|
12196
12294
|
#
|
@@ -12202,7 +12300,7 @@ module Aws::S3
|
|
12202
12300
|
# @return [String]
|
12203
12301
|
#
|
12204
12302
|
# @!attribute [rw] expected_bucket_owner
|
12205
|
-
# The account
|
12303
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
12206
12304
|
# by a different account, the request will fail with an HTTP `403
|
12207
12305
|
# (Access Denied)` error.
|
12208
12306
|
# @return [String]
|
@@ -12251,33 +12349,34 @@ module Aws::S3
|
|
12251
12349
|
# ],
|
12252
12350
|
# },
|
12253
12351
|
# expected_bucket_owner: "AccountId",
|
12352
|
+
# request_payer: "requester", # accepts requester
|
12254
12353
|
# }
|
12255
12354
|
#
|
12256
12355
|
# @!attribute [rw] bucket
|
12257
12356
|
# The bucket name containing the object.
|
12258
12357
|
#
|
12259
|
-
# When using this
|
12260
|
-
# to the access point hostname. The access point hostname
|
12261
|
-
# form
|
12358
|
+
# When using this action with an access point, you must direct
|
12359
|
+
# requests to the access point hostname. The access point hostname
|
12360
|
+
# takes the form
|
12262
12361
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
12263
|
-
# When using this
|
12362
|
+
# When using this action with an access point through the AWS SDKs,
|
12264
12363
|
# you provide the access point ARN in place of the bucket name. For
|
12265
12364
|
# more information about access point ARNs, see [Using Access
|
12266
|
-
# Points][1] in the *Amazon
|
12365
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
12267
12366
|
#
|
12268
|
-
# When using this
|
12367
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
12269
12368
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
12270
12369
|
# takes the form
|
12271
12370
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
12272
|
-
# When using this
|
12371
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
12273
12372
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
12274
12373
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
12275
|
-
# Outposts][2] in the *Amazon
|
12374
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
12276
12375
|
#
|
12277
12376
|
#
|
12278
12377
|
#
|
12279
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12280
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12378
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
12379
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
12281
12380
|
# @return [String]
|
12282
12381
|
#
|
12283
12382
|
# @!attribute [rw] key
|
@@ -12300,11 +12399,23 @@ module Aws::S3
|
|
12300
12399
|
# @return [Types::Tagging]
|
12301
12400
|
#
|
12302
12401
|
# @!attribute [rw] expected_bucket_owner
|
12303
|
-
# The account
|
12402
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
12304
12403
|
# by a different account, the request will fail with an HTTP `403
|
12305
12404
|
# (Access Denied)` error.
|
12306
12405
|
# @return [String]
|
12307
12406
|
#
|
12407
|
+
# @!attribute [rw] request_payer
|
12408
|
+
# Confirms that the requester knows that they will be charged for the
|
12409
|
+
# request. Bucket owners need not specify this parameter in their
|
12410
|
+
# requests. For information about downloading objects from requester
|
12411
|
+
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
12412
|
+
# in the *Amazon S3 Developer Guide*.
|
12413
|
+
#
|
12414
|
+
#
|
12415
|
+
#
|
12416
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
12417
|
+
# @return [String]
|
12418
|
+
#
|
12308
12419
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectTaggingRequest AWS API Documentation
|
12309
12420
|
#
|
12310
12421
|
class PutObjectTaggingRequest < Struct.new(
|
@@ -12313,7 +12424,8 @@ module Aws::S3
|
|
12313
12424
|
:version_id,
|
12314
12425
|
:content_md5,
|
12315
12426
|
:tagging,
|
12316
|
-
:expected_bucket_owner
|
12427
|
+
:expected_bucket_owner,
|
12428
|
+
:request_payer)
|
12317
12429
|
SENSITIVE = []
|
12318
12430
|
include Aws::Structure
|
12319
12431
|
end
|
@@ -12350,7 +12462,7 @@ module Aws::S3
|
|
12350
12462
|
# Amazon S3 bucket. You can enable the configuration options in any
|
12351
12463
|
# combination. For more information about when Amazon S3 considers a
|
12352
12464
|
# bucket or object public, see [The Meaning of "Public"][1] in the
|
12353
|
-
# *Amazon
|
12465
|
+
# *Amazon S3 User Guide*.
|
12354
12466
|
#
|
12355
12467
|
#
|
12356
12468
|
#
|
@@ -12358,7 +12470,7 @@ module Aws::S3
|
|
12358
12470
|
# @return [Types::PublicAccessBlockConfiguration]
|
12359
12471
|
#
|
12360
12472
|
# @!attribute [rw] expected_bucket_owner
|
12361
|
-
# The account
|
12473
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
12362
12474
|
# by a different account, the request will fail with an HTTP `403
|
12363
12475
|
# (Access Denied)` error.
|
12364
12476
|
# @return [String]
|
@@ -12416,7 +12528,7 @@ module Aws::S3
|
|
12416
12528
|
# @!attribute [rw] filter
|
12417
12529
|
# Specifies object key name filtering rules. For information about key
|
12418
12530
|
# name filtering, see [Configuring Event Notifications][1] in the
|
12419
|
-
# *Amazon
|
12531
|
+
# *Amazon S3 User Guide*.
|
12420
12532
|
#
|
12421
12533
|
#
|
12422
12534
|
#
|
@@ -12464,7 +12576,7 @@ module Aws::S3
|
|
12464
12576
|
# @return [String]
|
12465
12577
|
#
|
12466
12578
|
# @!attribute [rw] events
|
12467
|
-
# A collection of bucket events for which to send notifications
|
12579
|
+
# A collection of bucket events for which to send notifications.
|
12468
12580
|
# @return [Array<String>]
|
12469
12581
|
#
|
12470
12582
|
# @!attribute [rw] queue
|
@@ -12535,6 +12647,14 @@ module Aws::S3
|
|
12535
12647
|
# `ReplaceKeyPrefixWith` to `/documents`. Not required if one of the
|
12536
12648
|
# siblings is present. Can be present only if `ReplaceKeyWith` is not
|
12537
12649
|
# provided.
|
12650
|
+
#
|
12651
|
+
# Replacement must be made for object keys containing special
|
12652
|
+
# characters (such as carriage returns) when using XML requests. For
|
12653
|
+
# more information, see [ XML related object key constraints][1].
|
12654
|
+
#
|
12655
|
+
#
|
12656
|
+
#
|
12657
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
|
12538
12658
|
# @return [String]
|
12539
12659
|
#
|
12540
12660
|
# @!attribute [rw] replace_key_with
|
@@ -12542,6 +12662,14 @@ module Aws::S3
|
|
12542
12662
|
# redirect request to `error.html`. Not required if one of the
|
12543
12663
|
# siblings is present. Can be present only if `ReplaceKeyPrefixWith`
|
12544
12664
|
# is not provided.
|
12665
|
+
#
|
12666
|
+
# Replacement must be made for object keys containing special
|
12667
|
+
# characters (such as carriage returns) when using XML requests. For
|
12668
|
+
# more information, see [ XML related object key constraints][1].
|
12669
|
+
#
|
12670
|
+
#
|
12671
|
+
#
|
12672
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
|
12545
12673
|
# @return [String]
|
12546
12674
|
#
|
12547
12675
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Redirect AWS API Documentation
|
@@ -12691,7 +12819,7 @@ module Aws::S3
|
|
12691
12819
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
12692
12820
|
# Management (IAM) role that Amazon S3 assumes when replicating
|
12693
12821
|
# objects. For more information, see [How to Set Up Replication][1] in
|
12694
|
-
# the *Amazon
|
12822
|
+
# the *Amazon S3 User Guide*.
|
12695
12823
|
#
|
12696
12824
|
#
|
12697
12825
|
#
|
@@ -12792,8 +12920,8 @@ module Aws::S3
|
|
12792
12920
|
# will be replicated according to the rule with the highest priority.
|
12793
12921
|
# The higher the number, the higher the priority.
|
12794
12922
|
#
|
12795
|
-
# For more information, see [Replication][1] in the *Amazon
|
12796
|
-
#
|
12923
|
+
# For more information, see [Replication][1] in the *Amazon S3 User
|
12924
|
+
# Guide*.
|
12797
12925
|
#
|
12798
12926
|
#
|
12799
12927
|
#
|
@@ -12805,6 +12933,14 @@ module Aws::S3
|
|
12805
12933
|
# which the rule applies. The maximum prefix length is 1,024
|
12806
12934
|
# characters. To include all objects in a bucket, specify an empty
|
12807
12935
|
# string.
|
12936
|
+
#
|
12937
|
+
# Replacement must be made for object keys containing special
|
12938
|
+
# characters (such as carriage returns) when using XML requests. For
|
12939
|
+
# more information, see [ XML related object key constraints][1].
|
12940
|
+
#
|
12941
|
+
#
|
12942
|
+
#
|
12943
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
|
12808
12944
|
# @return [String]
|
12809
12945
|
#
|
12810
12946
|
# @!attribute [rw] filter
|
@@ -12886,7 +13022,7 @@ module Aws::S3
|
|
12886
13022
|
# filters in an `And` tag.
|
12887
13023
|
#
|
12888
13024
|
# * If you specify a filter based on multiple tags, wrap the `Tag`
|
12889
|
-
# elements in an `And` tag
|
13025
|
+
# elements in an `And` tag.
|
12890
13026
|
#
|
12891
13027
|
# @note When making an API call, you may pass ReplicationRuleAndOperator
|
12892
13028
|
# data as a hash:
|
@@ -12946,6 +13082,14 @@ module Aws::S3
|
|
12946
13082
|
# @!attribute [rw] prefix
|
12947
13083
|
# An object key name prefix that identifies the subset of objects to
|
12948
13084
|
# which the rule applies.
|
13085
|
+
#
|
13086
|
+
# Replacement must be made for object keys containing special
|
13087
|
+
# characters (such as carriage returns) when using XML requests. For
|
13088
|
+
# more information, see [ XML related object key constraints][1].
|
13089
|
+
#
|
13090
|
+
#
|
13091
|
+
#
|
13092
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
|
12949
13093
|
# @return [String]
|
12950
13094
|
#
|
12951
13095
|
# @!attribute [rw] tag
|
@@ -13191,32 +13335,32 @@ module Aws::S3
|
|
13191
13335
|
# @!attribute [rw] bucket
|
13192
13336
|
# The bucket name containing the object to restore.
|
13193
13337
|
#
|
13194
|
-
# When using this
|
13195
|
-
# to the access point hostname. The access point hostname
|
13196
|
-
# form
|
13338
|
+
# When using this action with an access point, you must direct
|
13339
|
+
# requests to the access point hostname. The access point hostname
|
13340
|
+
# takes the form
|
13197
13341
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
13198
|
-
# When using this
|
13342
|
+
# When using this action with an access point through the AWS SDKs,
|
13199
13343
|
# you provide the access point ARN in place of the bucket name. For
|
13200
13344
|
# more information about access point ARNs, see [Using Access
|
13201
|
-
# Points][1] in the *Amazon
|
13345
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
13202
13346
|
#
|
13203
|
-
# When using this
|
13347
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
13204
13348
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
13205
13349
|
# takes the form
|
13206
13350
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
13207
|
-
# When using this
|
13351
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
13208
13352
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
13209
13353
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
13210
|
-
# Outposts][2] in the *Amazon
|
13354
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
13211
13355
|
#
|
13212
13356
|
#
|
13213
13357
|
#
|
13214
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13215
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13358
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
13359
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
13216
13360
|
# @return [String]
|
13217
13361
|
#
|
13218
13362
|
# @!attribute [rw] key
|
13219
|
-
# Object key for which the
|
13363
|
+
# Object key for which the action was initiated.
|
13220
13364
|
# @return [String]
|
13221
13365
|
#
|
13222
13366
|
# @!attribute [rw] version_id
|
@@ -13240,7 +13384,7 @@ module Aws::S3
|
|
13240
13384
|
# @return [String]
|
13241
13385
|
#
|
13242
13386
|
# @!attribute [rw] expected_bucket_owner
|
13243
|
-
# The account
|
13387
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
13244
13388
|
# by a different account, the request will fail with an HTTP `403
|
13245
13389
|
# (Access Denied)` error.
|
13246
13390
|
# @return [String]
|
@@ -13394,8 +13538,7 @@ module Aws::S3
|
|
13394
13538
|
|
13395
13539
|
# Specifies the redirect behavior and when a redirect is applied. For
|
13396
13540
|
# more information about routing rules, see [Configuring advanced
|
13397
|
-
# conditional redirects][1] in the *Amazon
|
13398
|
-
# Developer Guide*.
|
13541
|
+
# conditional redirects][1] in the *Amazon S3 User Guide*.
|
13399
13542
|
#
|
13400
13543
|
#
|
13401
13544
|
#
|
@@ -13444,7 +13587,7 @@ module Aws::S3
|
|
13444
13587
|
# Specifies lifecycle rules for an Amazon S3 bucket. For more
|
13445
13588
|
# information, see [Put Bucket Lifecycle Configuration][1] in the
|
13446
13589
|
# *Amazon Simple Storage Service API Reference*. For examples, see [Put
|
13447
|
-
# Bucket Lifecycle Configuration Examples][2]
|
13590
|
+
# Bucket Lifecycle Configuration Examples][2].
|
13448
13591
|
#
|
13449
13592
|
#
|
13450
13593
|
#
|
@@ -13492,6 +13635,14 @@ module Aws::S3
|
|
13492
13635
|
# @!attribute [rw] prefix
|
13493
13636
|
# Object key prefix that identifies one or more objects to which this
|
13494
13637
|
# rule applies.
|
13638
|
+
#
|
13639
|
+
# Replacement must be made for object keys containing special
|
13640
|
+
# characters (such as carriage returns) when using XML requests. For
|
13641
|
+
# more information, see [ XML related object key constraints][1].
|
13642
|
+
#
|
13643
|
+
#
|
13644
|
+
#
|
13645
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
|
13495
13646
|
# @return [String]
|
13496
13647
|
#
|
13497
13648
|
# @!attribute [rw] status
|
@@ -13503,7 +13654,7 @@ module Aws::S3
|
|
13503
13654
|
# Specifies when an object transitions to a specified storage class.
|
13504
13655
|
# For more information about Amazon S3 lifecycle configuration rules,
|
13505
13656
|
# see [Transitioning Objects Using Amazon S3 Lifecycle][1] in the
|
13506
|
-
# *Amazon
|
13657
|
+
# *Amazon S3 User Guide*.
|
13507
13658
|
#
|
13508
13659
|
#
|
13509
13660
|
#
|
@@ -13535,7 +13686,7 @@ module Aws::S3
|
|
13535
13686
|
# upload that Amazon S3 will wait before permanently removing all
|
13536
13687
|
# parts of the upload. For more information, see [ Aborting Incomplete
|
13537
13688
|
# Multipart Uploads Using a Bucket Lifecycle Policy][1] in the *Amazon
|
13538
|
-
#
|
13689
|
+
# S3 User Guide*.
|
13539
13690
|
#
|
13540
13691
|
#
|
13541
13692
|
#
|
@@ -13902,7 +14053,7 @@ module Aws::S3
|
|
13902
14053
|
# @return [Types::ScanRange]
|
13903
14054
|
#
|
13904
14055
|
# @!attribute [rw] expected_bucket_owner
|
13905
|
-
# The account
|
14056
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
13906
14057
|
# by a different account, the request will fail with an HTTP `403
|
13907
14058
|
# (Access Denied)` error.
|
13908
14059
|
# @return [String]
|
@@ -14107,7 +14258,7 @@ module Aws::S3
|
|
14107
14258
|
# Bucket Key. By default, S3 Bucket Key is not enabled.
|
14108
14259
|
#
|
14109
14260
|
# For more information, see [Amazon S3 Bucket Keys][1] in the *Amazon
|
14110
|
-
#
|
14261
|
+
# S3 User Guide*.
|
14111
14262
|
#
|
14112
14263
|
#
|
14113
14264
|
#
|
@@ -14468,8 +14619,8 @@ module Aws::S3
|
|
14468
14619
|
#
|
14469
14620
|
# @!attribute [rw] events
|
14470
14621
|
# The Amazon S3 bucket event about which to send notifications. For
|
14471
|
-
# more information, see [Supported Event Types][1] in the *Amazon
|
14472
|
-
#
|
14622
|
+
# more information, see [Supported Event Types][1] in the *Amazon S3
|
14623
|
+
# User Guide*.
|
14473
14624
|
#
|
14474
14625
|
#
|
14475
14626
|
#
|
@@ -14479,7 +14630,7 @@ module Aws::S3
|
|
14479
14630
|
# @!attribute [rw] filter
|
14480
14631
|
# Specifies object key name filtering rules. For information about key
|
14481
14632
|
# name filtering, see [Configuring Event Notifications][1] in the
|
14482
|
-
# *Amazon
|
14633
|
+
# *Amazon S3 User Guide*.
|
14483
14634
|
#
|
14484
14635
|
#
|
14485
14636
|
#
|
@@ -14548,8 +14699,8 @@ module Aws::S3
|
|
14548
14699
|
|
14549
14700
|
# Specifies when an object transitions to a specified storage class. For
|
14550
14701
|
# more information about Amazon S3 lifecycle configuration rules, see
|
14551
|
-
# [Transitioning Objects Using Amazon S3 Lifecycle][1] in the *Amazon
|
14552
|
-
#
|
14702
|
+
# [Transitioning Objects Using Amazon S3 Lifecycle][1] in the *Amazon S3
|
14703
|
+
# User Guide*.
|
14553
14704
|
#
|
14554
14705
|
#
|
14555
14706
|
#
|
@@ -14676,28 +14827,28 @@ module Aws::S3
|
|
14676
14827
|
# @!attribute [rw] bucket
|
14677
14828
|
# The bucket name.
|
14678
14829
|
#
|
14679
|
-
# When using this
|
14680
|
-
# to the access point hostname. The access point hostname
|
14681
|
-
# form
|
14830
|
+
# When using this action with an access point, you must direct
|
14831
|
+
# requests to the access point hostname. The access point hostname
|
14832
|
+
# takes the form
|
14682
14833
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
14683
|
-
# When using this
|
14834
|
+
# When using this action with an access point through the AWS SDKs,
|
14684
14835
|
# you provide the access point ARN in place of the bucket name. For
|
14685
14836
|
# more information about access point ARNs, see [Using Access
|
14686
|
-
# Points][1] in the *Amazon
|
14837
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
14687
14838
|
#
|
14688
|
-
# When using this
|
14839
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
14689
14840
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
14690
14841
|
# takes the form
|
14691
14842
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
14692
|
-
# When using this
|
14843
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
14693
14844
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
14694
14845
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
14695
|
-
# Outposts][2] in the *Amazon
|
14846
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
14696
14847
|
#
|
14697
14848
|
#
|
14698
14849
|
#
|
14699
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
14700
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
14850
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
14851
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
14701
14852
|
# @return [String]
|
14702
14853
|
#
|
14703
14854
|
# @!attribute [rw] copy_source
|
@@ -14744,7 +14895,7 @@ module Aws::S3
|
|
14744
14895
|
#
|
14745
14896
|
#
|
14746
14897
|
#
|
14747
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
14898
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
|
14748
14899
|
# @return [String]
|
14749
14900
|
#
|
14750
14901
|
# @!attribute [rw] copy_source_if_match
|
@@ -14839,13 +14990,13 @@ module Aws::S3
|
|
14839
14990
|
# @return [String]
|
14840
14991
|
#
|
14841
14992
|
# @!attribute [rw] expected_bucket_owner
|
14842
|
-
# The account
|
14993
|
+
# The account ID of the expected destination bucket owner. If the
|
14843
14994
|
# destination bucket is owned by a different account, the request will
|
14844
14995
|
# fail with an HTTP `403 (Access Denied)` error.
|
14845
14996
|
# @return [String]
|
14846
14997
|
#
|
14847
14998
|
# @!attribute [rw] expected_source_bucket_owner
|
14848
|
-
# The account
|
14999
|
+
# The account ID of the expected source bucket owner. If the source
|
14849
15000
|
# bucket is owned by a different account, the request will fail with
|
14850
15001
|
# an HTTP `403 (Access Denied)` error.
|
14851
15002
|
# @return [String]
|
@@ -14953,28 +15104,28 @@ module Aws::S3
|
|
14953
15104
|
# @!attribute [rw] bucket
|
14954
15105
|
# The name of the bucket to which the multipart upload was initiated.
|
14955
15106
|
#
|
14956
|
-
# When using this
|
14957
|
-
# to the access point hostname. The access point hostname
|
14958
|
-
# form
|
15107
|
+
# When using this action with an access point, you must direct
|
15108
|
+
# requests to the access point hostname. The access point hostname
|
15109
|
+
# takes the form
|
14959
15110
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
14960
|
-
# When using this
|
15111
|
+
# When using this action with an access point through the AWS SDKs,
|
14961
15112
|
# you provide the access point ARN in place of the bucket name. For
|
14962
15113
|
# more information about access point ARNs, see [Using Access
|
14963
|
-
# Points][1] in the *Amazon
|
15114
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
14964
15115
|
#
|
14965
|
-
# When using this
|
15116
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
14966
15117
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
14967
15118
|
# takes the form
|
14968
15119
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
14969
|
-
# When using this
|
15120
|
+
# When using this action using S3 on Outposts through the AWS SDKs,
|
14970
15121
|
# you provide the Outposts bucket ARN in place of the bucket name. For
|
14971
15122
|
# more information about S3 on Outposts ARNs, see [Using S3 on
|
14972
|
-
# Outposts][2] in the *Amazon
|
15123
|
+
# Outposts][2] in the *Amazon S3 User Guide*.
|
14973
15124
|
#
|
14974
15125
|
#
|
14975
15126
|
#
|
14976
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
14977
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
15127
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
15128
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
14978
15129
|
# @return [String]
|
14979
15130
|
#
|
14980
15131
|
# @!attribute [rw] content_length
|
@@ -15036,7 +15187,7 @@ module Aws::S3
|
|
15036
15187
|
# @return [String]
|
15037
15188
|
#
|
15038
15189
|
# @!attribute [rw] expected_bucket_owner
|
15039
|
-
# The account
|
15190
|
+
# The account ID of the expected bucket owner. If the bucket is owned
|
15040
15191
|
# by a different account, the request will fail with an HTTP `403
|
15041
15192
|
# (Access Denied)` error.
|
15042
15193
|
# @return [String]
|
@@ -15160,6 +15311,317 @@ module Aws::S3
|
|
15160
15311
|
include Aws::Structure
|
15161
15312
|
end
|
15162
15313
|
|
15314
|
+
# @note When making an API call, you may pass WriteGetObjectResponseRequest
|
15315
|
+
# data as a hash:
|
15316
|
+
#
|
15317
|
+
# {
|
15318
|
+
# request_route: "RequestRoute", # required
|
15319
|
+
# request_token: "RequestToken", # required
|
15320
|
+
# body: source_file,
|
15321
|
+
# status_code: 1,
|
15322
|
+
# error_code: "ErrorCode",
|
15323
|
+
# error_message: "ErrorMessage",
|
15324
|
+
# accept_ranges: "AcceptRanges",
|
15325
|
+
# cache_control: "CacheControl",
|
15326
|
+
# content_disposition: "ContentDisposition",
|
15327
|
+
# content_encoding: "ContentEncoding",
|
15328
|
+
# content_language: "ContentLanguage",
|
15329
|
+
# content_length: 1,
|
15330
|
+
# content_range: "ContentRange",
|
15331
|
+
# content_type: "ContentType",
|
15332
|
+
# delete_marker: false,
|
15333
|
+
# etag: "ETag",
|
15334
|
+
# expires: Time.now,
|
15335
|
+
# expiration: "Expiration",
|
15336
|
+
# last_modified: Time.now,
|
15337
|
+
# missing_meta: 1,
|
15338
|
+
# metadata: {
|
15339
|
+
# "MetadataKey" => "MetadataValue",
|
15340
|
+
# },
|
15341
|
+
# object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
|
15342
|
+
# object_lock_legal_hold_status: "ON", # accepts ON, OFF
|
15343
|
+
# object_lock_retain_until_date: Time.now,
|
15344
|
+
# parts_count: 1,
|
15345
|
+
# replication_status: "COMPLETE", # accepts COMPLETE, PENDING, FAILED, REPLICA
|
15346
|
+
# request_charged: "requester", # accepts requester
|
15347
|
+
# restore: "Restore",
|
15348
|
+
# server_side_encryption: "AES256", # accepts AES256, aws:kms
|
15349
|
+
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
15350
|
+
# ssekms_key_id: "SSEKMSKeyId",
|
15351
|
+
# sse_customer_key_md5: "SSECustomerKeyMD5",
|
15352
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
|
15353
|
+
# tag_count: 1,
|
15354
|
+
# version_id: "ObjectVersionId",
|
15355
|
+
# bucket_key_enabled: false,
|
15356
|
+
# }
|
15357
|
+
#
|
15358
|
+
# @!attribute [rw] request_route
|
15359
|
+
# Route prefix to the HTTP URL generated.
|
15360
|
+
# @return [String]
|
15361
|
+
#
|
15362
|
+
# @!attribute [rw] request_token
|
15363
|
+
# A single use encrypted token that maps `WriteGetObjectResponse` to
|
15364
|
+
# the end user `GetObject` request.
|
15365
|
+
# @return [String]
|
15366
|
+
#
|
15367
|
+
# @!attribute [rw] body
|
15368
|
+
# The object data.
|
15369
|
+
# @return [IO]
|
15370
|
+
#
|
15371
|
+
# @!attribute [rw] status_code
|
15372
|
+
# The integer status code for an HTTP response of a corresponding
|
15373
|
+
# `GetObject` request.
|
15374
|
+
#
|
15375
|
+
# **Status Codes**
|
15376
|
+
#
|
15377
|
+
# * *200 - OK*
|
15378
|
+
#
|
15379
|
+
# * *206 - Partial Content*
|
15380
|
+
#
|
15381
|
+
# * *304 - Not Modified*
|
15382
|
+
#
|
15383
|
+
# * *400 - Bad Request*
|
15384
|
+
#
|
15385
|
+
# * *401 - Unauthorized*
|
15386
|
+
#
|
15387
|
+
# * *403 - Forbidden*
|
15388
|
+
#
|
15389
|
+
# * *404 - Not Found*
|
15390
|
+
#
|
15391
|
+
# * *405 - Method Not Allowed*
|
15392
|
+
#
|
15393
|
+
# * *409 - Conflict*
|
15394
|
+
#
|
15395
|
+
# * *411 - Length Required*
|
15396
|
+
#
|
15397
|
+
# * *412 - Precondition Failed*
|
15398
|
+
#
|
15399
|
+
# * *416 - Range Not Satisfiable*
|
15400
|
+
#
|
15401
|
+
# * *500 - Internal Server Error*
|
15402
|
+
#
|
15403
|
+
# * *503 - Service Unavailable*
|
15404
|
+
# @return [Integer]
|
15405
|
+
#
|
15406
|
+
# @!attribute [rw] error_code
|
15407
|
+
# A string that uniquely identifies an error condition. Returned in
|
15408
|
+
# the <Code> tag of the error XML response for a corresponding
|
15409
|
+
# `GetObject` call. Cannot be used with a successful `StatusCode`
|
15410
|
+
# header or when the transformed object is provided in the body. All
|
15411
|
+
# error codes from S3 are sentence-cased. Regex value is
|
15412
|
+
# "^\[A-Z\]\[a-zA-Z\]+$".
|
15413
|
+
# @return [String]
|
15414
|
+
#
|
15415
|
+
# @!attribute [rw] error_message
|
15416
|
+
# Contains a generic description of the error condition. Returned in
|
15417
|
+
# the <Message> tag of the error XML response for a
|
15418
|
+
# corresponding `GetObject` call. Cannot be used with a successful
|
15419
|
+
# `StatusCode` header or when the transformed object is provided in
|
15420
|
+
# body.
|
15421
|
+
# @return [String]
|
15422
|
+
#
|
15423
|
+
# @!attribute [rw] accept_ranges
|
15424
|
+
# Indicates that a range of bytes was specified.
|
15425
|
+
# @return [String]
|
15426
|
+
#
|
15427
|
+
# @!attribute [rw] cache_control
|
15428
|
+
# Specifies caching behavior along the request/reply chain.
|
15429
|
+
# @return [String]
|
15430
|
+
#
|
15431
|
+
# @!attribute [rw] content_disposition
|
15432
|
+
# Specifies presentational information for the object.
|
15433
|
+
# @return [String]
|
15434
|
+
#
|
15435
|
+
# @!attribute [rw] content_encoding
|
15436
|
+
# Specifies what content encodings have been applied to the object and
|
15437
|
+
# thus what decoding mechanisms must be applied to obtain the
|
15438
|
+
# media-type referenced by the Content-Type header field.
|
15439
|
+
# @return [String]
|
15440
|
+
#
|
15441
|
+
# @!attribute [rw] content_language
|
15442
|
+
# The language the content is in.
|
15443
|
+
# @return [String]
|
15444
|
+
#
|
15445
|
+
# @!attribute [rw] content_length
|
15446
|
+
# The size of the content body in bytes.
|
15447
|
+
# @return [Integer]
|
15448
|
+
#
|
15449
|
+
# @!attribute [rw] content_range
|
15450
|
+
# The portion of the object returned in the response.
|
15451
|
+
# @return [String]
|
15452
|
+
#
|
15453
|
+
# @!attribute [rw] content_type
|
15454
|
+
# A standard MIME type describing the format of the object data.
|
15455
|
+
# @return [String]
|
15456
|
+
#
|
15457
|
+
# @!attribute [rw] delete_marker
|
15458
|
+
# Specifies whether an object stored in Amazon S3 is (`true`) or is
|
15459
|
+
# not (`false`) a delete marker.
|
15460
|
+
# @return [Boolean]
|
15461
|
+
#
|
15462
|
+
# @!attribute [rw] etag
|
15463
|
+
# An opaque identifier assigned by a web server to a specific version
|
15464
|
+
# of a resource found at a URL.
|
15465
|
+
# @return [String]
|
15466
|
+
#
|
15467
|
+
# @!attribute [rw] expires
|
15468
|
+
# The date and time at which the object is no longer cacheable.
|
15469
|
+
# @return [Time]
|
15470
|
+
#
|
15471
|
+
# @!attribute [rw] expiration
|
15472
|
+
# If object stored in Amazon S3 expiration is configured (see PUT
|
15473
|
+
# Bucket lifecycle) it includes expiry-date and rule-id key-value
|
15474
|
+
# pairs providing object expiration information. The value of the
|
15475
|
+
# rule-id is URL encoded.
|
15476
|
+
# @return [String]
|
15477
|
+
#
|
15478
|
+
# @!attribute [rw] last_modified
|
15479
|
+
# The date and time that the object was last modified.
|
15480
|
+
# @return [Time]
|
15481
|
+
#
|
15482
|
+
# @!attribute [rw] missing_meta
|
15483
|
+
# Set to the number of metadata entries not returned in `x-amz-meta`
|
15484
|
+
# headers. This can happen if you create metadata using an API like
|
15485
|
+
# SOAP that supports more flexible metadata than the REST API. For
|
15486
|
+
# example, using SOAP, you can create metadata whose values are not
|
15487
|
+
# legal HTTP headers.
|
15488
|
+
# @return [Integer]
|
15489
|
+
#
|
15490
|
+
# @!attribute [rw] metadata
|
15491
|
+
# A map of metadata to store with the object in S3.
|
15492
|
+
# @return [Hash<String,String>]
|
15493
|
+
#
|
15494
|
+
# @!attribute [rw] object_lock_mode
|
15495
|
+
# Indicates whether an object stored in Amazon S3 has Object Lock
|
15496
|
+
# enabled. For more information about S3 Object Lock, see [Object
|
15497
|
+
# Lock][1].
|
15498
|
+
#
|
15499
|
+
#
|
15500
|
+
#
|
15501
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
|
15502
|
+
# @return [String]
|
15503
|
+
#
|
15504
|
+
# @!attribute [rw] object_lock_legal_hold_status
|
15505
|
+
# Indicates whether an object stored in Amazon S3 has an active legal
|
15506
|
+
# hold.
|
15507
|
+
# @return [String]
|
15508
|
+
#
|
15509
|
+
# @!attribute [rw] object_lock_retain_until_date
|
15510
|
+
# The date and time when Object Lock is configured to expire.
|
15511
|
+
# @return [Time]
|
15512
|
+
#
|
15513
|
+
# @!attribute [rw] parts_count
|
15514
|
+
# The count of parts this object has.
|
15515
|
+
# @return [Integer]
|
15516
|
+
#
|
15517
|
+
# @!attribute [rw] replication_status
|
15518
|
+
# Indicates if request involves bucket that is either a source or
|
15519
|
+
# destination in a Replication rule. For more information about S3
|
15520
|
+
# Replication, see [Replication][1].
|
15521
|
+
#
|
15522
|
+
#
|
15523
|
+
#
|
15524
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html
|
15525
|
+
# @return [String]
|
15526
|
+
#
|
15527
|
+
# @!attribute [rw] request_charged
|
15528
|
+
# If present, indicates that the requester was successfully charged
|
15529
|
+
# for the request.
|
15530
|
+
# @return [String]
|
15531
|
+
#
|
15532
|
+
# @!attribute [rw] restore
|
15533
|
+
# Provides information about object restoration operation and
|
15534
|
+
# expiration time of the restored object copy.
|
15535
|
+
# @return [String]
|
15536
|
+
#
|
15537
|
+
# @!attribute [rw] server_side_encryption
|
15538
|
+
# The server-side encryption algorithm used when storing requested
|
15539
|
+
# object in Amazon S3 (for example, AES256, aws:kms).
|
15540
|
+
# @return [String]
|
15541
|
+
#
|
15542
|
+
# @!attribute [rw] sse_customer_algorithm
|
15543
|
+
# Encryption algorithm used if server-side encryption with a
|
15544
|
+
# customer-provided encryption key was specified for object stored in
|
15545
|
+
# Amazon S3.
|
15546
|
+
# @return [String]
|
15547
|
+
#
|
15548
|
+
# @!attribute [rw] ssekms_key_id
|
15549
|
+
# If present, specifies the ID of the AWS Key Management Service (AWS
|
15550
|
+
# KMS) symmetric customer managed customer master key (CMK) that was
|
15551
|
+
# used for stored in Amazon S3 object.
|
15552
|
+
# @return [String]
|
15553
|
+
#
|
15554
|
+
# @!attribute [rw] sse_customer_key_md5
|
15555
|
+
# 128-bit MD5 digest of customer-provided encryption key used in
|
15556
|
+
# Amazon S3 to encrypt data stored in S3. For more information, see
|
15557
|
+
# [Protecting data using server-side encryption with customer-provided
|
15558
|
+
# encryption keys (SSE-C)][1].
|
15559
|
+
#
|
15560
|
+
#
|
15561
|
+
#
|
15562
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html
|
15563
|
+
# @return [String]
|
15564
|
+
#
|
15565
|
+
# @!attribute [rw] storage_class
|
15566
|
+
# The class of storage used to store object in Amazon S3.
|
15567
|
+
# @return [String]
|
15568
|
+
#
|
15569
|
+
# @!attribute [rw] tag_count
|
15570
|
+
# The number of tags, if any, on the object.
|
15571
|
+
# @return [Integer]
|
15572
|
+
#
|
15573
|
+
# @!attribute [rw] version_id
|
15574
|
+
# An ID used to reference a specific version of the object.
|
15575
|
+
# @return [String]
|
15576
|
+
#
|
15577
|
+
# @!attribute [rw] bucket_key_enabled
|
15578
|
+
# Indicates whether the object stored in Amazon S3 uses an S3 bucket
|
15579
|
+
# key for server-side encryption with AWS KMS (SSE-KMS).
|
15580
|
+
# @return [Boolean]
|
15581
|
+
#
|
15582
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/WriteGetObjectResponseRequest AWS API Documentation
|
15583
|
+
#
|
15584
|
+
class WriteGetObjectResponseRequest < Struct.new(
|
15585
|
+
:request_route,
|
15586
|
+
:request_token,
|
15587
|
+
:body,
|
15588
|
+
:status_code,
|
15589
|
+
:error_code,
|
15590
|
+
:error_message,
|
15591
|
+
:accept_ranges,
|
15592
|
+
:cache_control,
|
15593
|
+
:content_disposition,
|
15594
|
+
:content_encoding,
|
15595
|
+
:content_language,
|
15596
|
+
:content_length,
|
15597
|
+
:content_range,
|
15598
|
+
:content_type,
|
15599
|
+
:delete_marker,
|
15600
|
+
:etag,
|
15601
|
+
:expires,
|
15602
|
+
:expiration,
|
15603
|
+
:last_modified,
|
15604
|
+
:missing_meta,
|
15605
|
+
:metadata,
|
15606
|
+
:object_lock_mode,
|
15607
|
+
:object_lock_legal_hold_status,
|
15608
|
+
:object_lock_retain_until_date,
|
15609
|
+
:parts_count,
|
15610
|
+
:replication_status,
|
15611
|
+
:request_charged,
|
15612
|
+
:restore,
|
15613
|
+
:server_side_encryption,
|
15614
|
+
:sse_customer_algorithm,
|
15615
|
+
:ssekms_key_id,
|
15616
|
+
:sse_customer_key_md5,
|
15617
|
+
:storage_class,
|
15618
|
+
:tag_count,
|
15619
|
+
:version_id,
|
15620
|
+
:bucket_key_enabled)
|
15621
|
+
SENSITIVE = [:ssekms_key_id]
|
15622
|
+
include Aws::Structure
|
15623
|
+
end
|
15624
|
+
|
15163
15625
|
# The container for selecting objects from a content event stream.
|
15164
15626
|
#
|
15165
15627
|
# EventStream is an Enumerator of Events.
|