aws-sdk-s3 1.150.0 → 1.160.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +65 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3/access_grants_credentials_provider.rb +12 -3
- data/lib/aws-sdk-s3/bucket.rb +89 -26
- data/lib/aws-sdk-s3/bucket_acl.rb +3 -3
- data/lib/aws-sdk-s3/bucket_cors.rb +4 -4
- data/lib/aws-sdk-s3/bucket_lifecycle.rb +4 -4
- data/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb +4 -4
- data/lib/aws-sdk-s3/bucket_logging.rb +3 -3
- data/lib/aws-sdk-s3/bucket_notification.rb +3 -3
- data/lib/aws-sdk-s3/bucket_policy.rb +4 -4
- data/lib/aws-sdk-s3/bucket_request_payment.rb +3 -3
- data/lib/aws-sdk-s3/bucket_tagging.rb +4 -4
- data/lib/aws-sdk-s3/bucket_versioning.rb +5 -5
- data/lib/aws-sdk-s3/bucket_website.rb +4 -4
- data/lib/aws-sdk-s3/client.rb +632 -351
- data/lib/aws-sdk-s3/client_api.rb +27 -3
- data/lib/aws-sdk-s3/customizations/bucket.rb +1 -1
- data/lib/aws-sdk-s3/customizations/object.rb +5 -5
- data/lib/aws-sdk-s3/encryption/client.rb +2 -2
- data/lib/aws-sdk-s3/encryption/kms_cipher_provider.rb +2 -2
- data/lib/aws-sdk-s3/encryptionV2/client.rb +2 -2
- data/lib/aws-sdk-s3/encryptionV2/kms_cipher_provider.rb +2 -2
- data/lib/aws-sdk-s3/endpoint_parameters.rb +8 -0
- data/lib/aws-sdk-s3/endpoint_provider.rb +1 -0
- data/lib/aws-sdk-s3/endpoints.rb +100 -1
- data/lib/aws-sdk-s3/file_downloader.rb +1 -1
- data/lib/aws-sdk-s3/file_uploader.rb +1 -1
- data/lib/aws-sdk-s3/multipart_stream_uploader.rb +1 -1
- data/lib/aws-sdk-s3/multipart_upload.rb +24 -4
- data/lib/aws-sdk-s3/multipart_upload_part.rb +3 -3
- data/lib/aws-sdk-s3/object.rb +66 -16
- data/lib/aws-sdk-s3/object_acl.rb +3 -3
- data/lib/aws-sdk-s3/object_copier.rb +1 -1
- data/lib/aws-sdk-s3/object_summary.rb +38 -10
- data/lib/aws-sdk-s3/object_version.rb +40 -9
- data/lib/aws-sdk-s3/plugins/access_grants.rb +75 -5
- data/lib/aws-sdk-s3/plugins/express_session_auth.rb +7 -1
- data/lib/aws-sdk-s3/plugins/http_200_errors.rb +53 -16
- data/lib/aws-sdk-s3/resource.rb +12 -10
- data/lib/aws-sdk-s3/types.rb +340 -62
- data/lib/aws-sdk-s3.rb +1 -1
- data/sig/bucket.rbs +1 -0
- data/sig/client.rbs +27 -1
- data/sig/multipart_upload.rbs +1 -0
- data/sig/object.rbs +7 -0
- data/sig/object_summary.rbs +1 -0
- data/sig/object_version.rbs +6 -0
- data/sig/resource.rbs +4 -1
- data/sig/types.rbs +15 -0
- data/sig/waiters.rbs +12 -0
- metadata +6 -6
data/lib/aws-sdk-s3/types.rb
CHANGED
@@ -1061,6 +1061,27 @@ module Aws::S3
|
|
1061
1061
|
# denied).
|
1062
1062
|
# @return [String]
|
1063
1063
|
#
|
1064
|
+
# @!attribute [rw] if_none_match
|
1065
|
+
# Uploads the object only if the object key name does not already
|
1066
|
+
# exist in the bucket specified. Otherwise, Amazon S3 returns a `412
|
1067
|
+
# Precondition Failed` error.
|
1068
|
+
#
|
1069
|
+
# If a conflicting operation occurs during the upload S3 returns a
|
1070
|
+
# `409 ConditionalRequestConflict` response. On a 409 failure you
|
1071
|
+
# should re-initiate the multipart upload with `CreateMultipartUpload`
|
1072
|
+
# and re-upload each part.
|
1073
|
+
#
|
1074
|
+
# Expects the '*' (asterisk) character.
|
1075
|
+
#
|
1076
|
+
# For more information about conditional requests, see [RFC 7232][1],
|
1077
|
+
# or [Conditional requests][2] in the *Amazon S3 User Guide*.
|
1078
|
+
#
|
1079
|
+
#
|
1080
|
+
#
|
1081
|
+
# [1]: https://tools.ietf.org/html/rfc7232
|
1082
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html
|
1083
|
+
# @return [String]
|
1084
|
+
#
|
1064
1085
|
# @!attribute [rw] sse_customer_algorithm
|
1065
1086
|
# The server-side encryption (SSE) algorithm used to encrypt the
|
1066
1087
|
# object. This parameter is required only when the object was created
|
@@ -1120,6 +1141,7 @@ module Aws::S3
|
|
1120
1141
|
:checksum_sha256,
|
1121
1142
|
:request_payer,
|
1122
1143
|
:expected_bucket_owner,
|
1144
|
+
:if_none_match,
|
1123
1145
|
:sse_customer_algorithm,
|
1124
1146
|
:sse_customer_key,
|
1125
1147
|
:sse_customer_key_md5)
|
@@ -3299,7 +3321,7 @@ module Aws::S3
|
|
3299
3321
|
|
3300
3322
|
# @!attribute [rw] credentials
|
3301
3323
|
# The established temporary security credentials for the created
|
3302
|
-
# session
|
3324
|
+
# session.
|
3303
3325
|
# @return [Types::SessionCredentials]
|
3304
3326
|
#
|
3305
3327
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateSessionOutput AWS API Documentation
|
@@ -3333,8 +3355,9 @@ module Aws::S3
|
|
3333
3355
|
include Aws::Structure
|
3334
3356
|
end
|
3335
3357
|
|
3336
|
-
# The container element for specifying the default Object
|
3337
|
-
# settings for new objects placed in the specified
|
3358
|
+
# The container element for optionally specifying the default Object
|
3359
|
+
# Lock retention settings for new objects placed in the specified
|
3360
|
+
# bucket.
|
3338
3361
|
#
|
3339
3362
|
# <note markdown="1"> * The `DefaultRetention` settings require both a mode and a period.
|
3340
3363
|
#
|
@@ -4390,6 +4413,14 @@ module Aws::S3
|
|
4390
4413
|
# Specifies encryption-related information for an Amazon S3 bucket that
|
4391
4414
|
# is a destination for replicated objects.
|
4392
4415
|
#
|
4416
|
+
# <note markdown="1"> If you're specifying a customer managed KMS key, we recommend using a
|
4417
|
+
# fully qualified KMS key ARN. If you use a KMS key alias instead, then
|
4418
|
+
# KMS resolves the key within the requester’s account. This behavior can
|
4419
|
+
# result in data that's encrypted with a KMS key that belongs to the
|
4420
|
+
# requester, and not the bucket owner.
|
4421
|
+
#
|
4422
|
+
# </note>
|
4423
|
+
#
|
4393
4424
|
# @!attribute [rw] replica_kms_key_id
|
4394
4425
|
# Specifies the ID (Key ARN or Alias ARN) of the customer managed
|
4395
4426
|
# Amazon Web Services KMS key stored in Amazon Web Services Key
|
@@ -7381,6 +7412,15 @@ module Aws::S3
|
|
7381
7412
|
#
|
7382
7413
|
# @!attribute [rw] checksum_mode
|
7383
7414
|
# To retrieve the checksum, this mode must be enabled.
|
7415
|
+
#
|
7416
|
+
# In addition, if you enable checksum mode and the object is uploaded
|
7417
|
+
# with a [checksum][1] and encrypted with an Key Management Service
|
7418
|
+
# (KMS) key, you must have permission to use the `kms:Decrypt` action
|
7419
|
+
# to retrieve the checksum.
|
7420
|
+
#
|
7421
|
+
#
|
7422
|
+
#
|
7423
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html
|
7384
7424
|
# @return [String]
|
7385
7425
|
#
|
7386
7426
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectRequest AWS API Documentation
|
@@ -7802,17 +7842,13 @@ module Aws::S3
|
|
7802
7842
|
#
|
7803
7843
|
# @!attribute [rw] bucket_region
|
7804
7844
|
# The Region that the bucket is located.
|
7805
|
-
#
|
7806
|
-
# <note markdown="1"> This functionality is not supported for directory buckets.
|
7807
|
-
#
|
7808
|
-
# </note>
|
7809
7845
|
# @return [String]
|
7810
7846
|
#
|
7811
7847
|
# @!attribute [rw] access_point_alias
|
7812
7848
|
# Indicates whether the bucket name used in the request is an access
|
7813
7849
|
# point alias.
|
7814
7850
|
#
|
7815
|
-
# <note markdown="1">
|
7851
|
+
# <note markdown="1"> For directory buckets, the value of this field is `false`.
|
7816
7852
|
#
|
7817
7853
|
# </note>
|
7818
7854
|
# @return [Boolean]
|
@@ -8452,6 +8488,30 @@ module Aws::S3
|
|
8452
8488
|
# Not Satisfiable` error.
|
8453
8489
|
# @return [String]
|
8454
8490
|
#
|
8491
|
+
# @!attribute [rw] response_cache_control
|
8492
|
+
# Sets the `Cache-Control` header of the response.
|
8493
|
+
# @return [String]
|
8494
|
+
#
|
8495
|
+
# @!attribute [rw] response_content_disposition
|
8496
|
+
# Sets the `Content-Disposition` header of the response.
|
8497
|
+
# @return [String]
|
8498
|
+
#
|
8499
|
+
# @!attribute [rw] response_content_encoding
|
8500
|
+
# Sets the `Content-Encoding` header of the response.
|
8501
|
+
# @return [String]
|
8502
|
+
#
|
8503
|
+
# @!attribute [rw] response_content_language
|
8504
|
+
# Sets the `Content-Language` header of the response.
|
8505
|
+
# @return [String]
|
8506
|
+
#
|
8507
|
+
# @!attribute [rw] response_content_type
|
8508
|
+
# Sets the `Content-Type` header of the response.
|
8509
|
+
# @return [String]
|
8510
|
+
#
|
8511
|
+
# @!attribute [rw] response_expires
|
8512
|
+
# Sets the `Expires` header of the response.
|
8513
|
+
# @return [Time]
|
8514
|
+
#
|
8455
8515
|
# @!attribute [rw] version_id
|
8456
8516
|
# Version ID used to reference a specific version of the object.
|
8457
8517
|
#
|
@@ -8527,10 +8587,14 @@ module Aws::S3
|
|
8527
8587
|
# @!attribute [rw] checksum_mode
|
8528
8588
|
# To retrieve the checksum, this parameter must be enabled.
|
8529
8589
|
#
|
8530
|
-
# In addition, if you enable
|
8531
|
-
# encrypted with
|
8532
|
-
#
|
8533
|
-
#
|
8590
|
+
# In addition, if you enable checksum mode and the object is uploaded
|
8591
|
+
# with a [checksum][1] and encrypted with an Key Management Service
|
8592
|
+
# (KMS) key, you must have permission to use the `kms:Decrypt` action
|
8593
|
+
# to retrieve the checksum.
|
8594
|
+
#
|
8595
|
+
#
|
8596
|
+
#
|
8597
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html
|
8534
8598
|
# @return [String]
|
8535
8599
|
#
|
8536
8600
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObjectRequest AWS API Documentation
|
@@ -8543,6 +8607,12 @@ module Aws::S3
|
|
8543
8607
|
:if_unmodified_since,
|
8544
8608
|
:key,
|
8545
8609
|
:range,
|
8610
|
+
:response_cache_control,
|
8611
|
+
:response_content_disposition,
|
8612
|
+
:response_content_encoding,
|
8613
|
+
:response_content_language,
|
8614
|
+
:response_content_type,
|
8615
|
+
:response_expires,
|
8546
8616
|
:version_id,
|
8547
8617
|
:sse_customer_algorithm,
|
8548
8618
|
:sse_customer_key,
|
@@ -8559,10 +8629,11 @@ module Aws::S3
|
|
8559
8629
|
#
|
8560
8630
|
# @!attribute [rw] suffix
|
8561
8631
|
# A suffix that is appended to a request that is for a directory on
|
8562
|
-
# the website endpoint (
|
8563
|
-
# you make a request to samplebucket/images
|
8564
|
-
# will be for the object with the key name
|
8565
|
-
# suffix must not be empty and must not
|
8632
|
+
# the website endpoint. (For example, if the suffix is `index.html`
|
8633
|
+
# and you make a request to `samplebucket/images/`, the data that is
|
8634
|
+
# returned will be for the object with the key name
|
8635
|
+
# `images/index.html`.) The suffix must not be empty and must not
|
8636
|
+
# include a slash character.
|
8566
8637
|
#
|
8567
8638
|
# Replacement must be made for object keys containing special
|
8568
8639
|
# characters (such as carriage returns) when using XML requests. For
|
@@ -9495,11 +9566,45 @@ module Aws::S3
|
|
9495
9566
|
# The owner of the buckets listed.
|
9496
9567
|
# @return [Types::Owner]
|
9497
9568
|
#
|
9569
|
+
# @!attribute [rw] continuation_token
|
9570
|
+
# `ContinuationToken` is included in the response when there are more
|
9571
|
+
# buckets that can be listed with pagination. The next `ListBuckets`
|
9572
|
+
# request to Amazon S3 can be continued with this `ContinuationToken`.
|
9573
|
+
# `ContinuationToken` is obfuscated and is not a real bucket.
|
9574
|
+
# @return [String]
|
9575
|
+
#
|
9498
9576
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketsOutput AWS API Documentation
|
9499
9577
|
#
|
9500
9578
|
class ListBucketsOutput < Struct.new(
|
9501
9579
|
:buckets,
|
9502
|
-
:owner
|
9580
|
+
:owner,
|
9581
|
+
:continuation_token)
|
9582
|
+
SENSITIVE = []
|
9583
|
+
include Aws::Structure
|
9584
|
+
end
|
9585
|
+
|
9586
|
+
# @!attribute [rw] max_buckets
|
9587
|
+
# Maximum number of buckets to be returned in response. When the
|
9588
|
+
# number is more than the count of buckets that are owned by an Amazon
|
9589
|
+
# Web Services account, return all the buckets in response.
|
9590
|
+
# @return [Integer]
|
9591
|
+
#
|
9592
|
+
# @!attribute [rw] continuation_token
|
9593
|
+
# `ContinuationToken` indicates to Amazon S3 that the list is being
|
9594
|
+
# continued on this bucket with a token. `ContinuationToken` is
|
9595
|
+
# obfuscated and is not a real key. You can use this
|
9596
|
+
# `ContinuationToken` for pagination of the list results.
|
9597
|
+
#
|
9598
|
+
# Length Constraints: Minimum length of 0. Maximum length of 1024.
|
9599
|
+
#
|
9600
|
+
# Required: No.
|
9601
|
+
# @return [String]
|
9602
|
+
#
|
9603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketsRequest AWS API Documentation
|
9604
|
+
#
|
9605
|
+
class ListBucketsRequest < Struct.new(
|
9606
|
+
:max_buckets,
|
9607
|
+
:continuation_token)
|
9503
9608
|
SENSITIVE = []
|
9504
9609
|
include Aws::Structure
|
9505
9610
|
end
|
@@ -9525,9 +9630,10 @@ module Aws::S3
|
|
9525
9630
|
|
9526
9631
|
# @!attribute [rw] continuation_token
|
9527
9632
|
# `ContinuationToken` indicates to Amazon S3 that the list is being
|
9528
|
-
# continued on this
|
9529
|
-
# obfuscated and is not a real
|
9530
|
-
# `ContinuationToken` for pagination of the list
|
9633
|
+
# continued on buckets in this account with a token.
|
9634
|
+
# `ContinuationToken` is obfuscated and is not a real bucket name. You
|
9635
|
+
# can use this `ContinuationToken` for the pagination of the list
|
9636
|
+
# results.
|
9531
9637
|
# @return [String]
|
9532
9638
|
#
|
9533
9639
|
# @!attribute [rw] max_directory_buckets
|
@@ -9737,12 +9843,26 @@ module Aws::S3
|
|
9737
9843
|
# @return [String]
|
9738
9844
|
#
|
9739
9845
|
# @!attribute [rw] encoding_type
|
9740
|
-
#
|
9741
|
-
#
|
9742
|
-
# Unicode character
|
9743
|
-
# characters, such as characters with an ASCII value
|
9744
|
-
# characters that
|
9745
|
-
# parameter to request that Amazon S3 encode the keys in
|
9846
|
+
# Encoding type used by Amazon S3 to encode the [object keys][1] in
|
9847
|
+
# the response. Responses are encoded only in UTF-8. An object key can
|
9848
|
+
# contain any Unicode character. However, the XML 1.0 parser can't
|
9849
|
+
# parse certain characters, such as characters with an ASCII value
|
9850
|
+
# from 0 to 10. For characters that aren't supported in XML 1.0, you
|
9851
|
+
# can add this parameter to request that Amazon S3 encode the keys in
|
9852
|
+
# the response. For more information about characters to avoid in
|
9853
|
+
# object key names, see [Object key naming guidelines][2].
|
9854
|
+
#
|
9855
|
+
# <note markdown="1"> When using the URL encoding type, non-ASCII characters that are used
|
9856
|
+
# in an object's key name will be percent-encoded according to UTF-8
|
9857
|
+
# code values. For example, the object `test_file(3).png` will appear
|
9858
|
+
# as `test_file%283%29.png`.
|
9859
|
+
#
|
9860
|
+
# </note>
|
9861
|
+
#
|
9862
|
+
#
|
9863
|
+
#
|
9864
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html
|
9865
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines
|
9746
9866
|
# @return [String]
|
9747
9867
|
#
|
9748
9868
|
# @!attribute [rw] key_marker
|
@@ -9967,12 +10087,26 @@ module Aws::S3
|
|
9967
10087
|
# @return [String]
|
9968
10088
|
#
|
9969
10089
|
# @!attribute [rw] encoding_type
|
9970
|
-
#
|
9971
|
-
#
|
9972
|
-
# Unicode character
|
9973
|
-
# characters, such as characters with an ASCII value
|
9974
|
-
# characters that
|
9975
|
-
# parameter to request that Amazon S3 encode the keys in
|
10090
|
+
# Encoding type used by Amazon S3 to encode the [object keys][1] in
|
10091
|
+
# the response. Responses are encoded only in UTF-8. An object key can
|
10092
|
+
# contain any Unicode character. However, the XML 1.0 parser can't
|
10093
|
+
# parse certain characters, such as characters with an ASCII value
|
10094
|
+
# from 0 to 10. For characters that aren't supported in XML 1.0, you
|
10095
|
+
# can add this parameter to request that Amazon S3 encode the keys in
|
10096
|
+
# the response. For more information about characters to avoid in
|
10097
|
+
# object key names, see [Object key naming guidelines][2].
|
10098
|
+
#
|
10099
|
+
# <note markdown="1"> When using the URL encoding type, non-ASCII characters that are used
|
10100
|
+
# in an object's key name will be percent-encoded according to UTF-8
|
10101
|
+
# code values. For example, the object `test_file(3).png` will appear
|
10102
|
+
# as `test_file%283%29.png`.
|
10103
|
+
#
|
10104
|
+
# </note>
|
10105
|
+
#
|
10106
|
+
#
|
10107
|
+
#
|
10108
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html
|
10109
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines
|
9976
10110
|
# @return [String]
|
9977
10111
|
#
|
9978
10112
|
# @!attribute [rw] key_marker
|
@@ -10119,10 +10253,26 @@ module Aws::S3
|
|
10119
10253
|
# @return [Array<Types::CommonPrefix>]
|
10120
10254
|
#
|
10121
10255
|
# @!attribute [rw] encoding_type
|
10122
|
-
# Encoding type used by Amazon S3 to encode object keys in
|
10123
|
-
# response.
|
10124
|
-
#
|
10125
|
-
#
|
10256
|
+
# Encoding type used by Amazon S3 to encode the [object keys][1] in
|
10257
|
+
# the response. Responses are encoded only in UTF-8. An object key can
|
10258
|
+
# contain any Unicode character. However, the XML 1.0 parser can't
|
10259
|
+
# parse certain characters, such as characters with an ASCII value
|
10260
|
+
# from 0 to 10. For characters that aren't supported in XML 1.0, you
|
10261
|
+
# can add this parameter to request that Amazon S3 encode the keys in
|
10262
|
+
# the response. For more information about characters to avoid in
|
10263
|
+
# object key names, see [Object key naming guidelines][2].
|
10264
|
+
#
|
10265
|
+
# <note markdown="1"> When using the URL encoding type, non-ASCII characters that are used
|
10266
|
+
# in an object's key name will be percent-encoded according to UTF-8
|
10267
|
+
# code values. For example, the object `test_file(3).png` will appear
|
10268
|
+
# as `test_file%283%29.png`.
|
10269
|
+
#
|
10270
|
+
# </note>
|
10271
|
+
#
|
10272
|
+
#
|
10273
|
+
#
|
10274
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html
|
10275
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines
|
10126
10276
|
# @return [String]
|
10127
10277
|
#
|
10128
10278
|
# @!attribute [rw] request_charged
|
@@ -10202,12 +10352,26 @@ module Aws::S3
|
|
10202
10352
|
# @return [String]
|
10203
10353
|
#
|
10204
10354
|
# @!attribute [rw] encoding_type
|
10205
|
-
#
|
10206
|
-
#
|
10207
|
-
# Unicode character
|
10208
|
-
# characters, such as characters with an ASCII value
|
10209
|
-
# characters that
|
10210
|
-
# parameter to request that Amazon S3 encode the keys in
|
10355
|
+
# Encoding type used by Amazon S3 to encode the [object keys][1] in
|
10356
|
+
# the response. Responses are encoded only in UTF-8. An object key can
|
10357
|
+
# contain any Unicode character. However, the XML 1.0 parser can't
|
10358
|
+
# parse certain characters, such as characters with an ASCII value
|
10359
|
+
# from 0 to 10. For characters that aren't supported in XML 1.0, you
|
10360
|
+
# can add this parameter to request that Amazon S3 encode the keys in
|
10361
|
+
# the response. For more information about characters to avoid in
|
10362
|
+
# object key names, see [Object key naming guidelines][2].
|
10363
|
+
#
|
10364
|
+
# <note markdown="1"> When using the URL encoding type, non-ASCII characters that are used
|
10365
|
+
# in an object's key name will be percent-encoded according to UTF-8
|
10366
|
+
# code values. For example, the object `test_file(3).png` will appear
|
10367
|
+
# as `test_file%283%29.png`.
|
10368
|
+
#
|
10369
|
+
# </note>
|
10370
|
+
#
|
10371
|
+
#
|
10372
|
+
#
|
10373
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html
|
10374
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines
|
10211
10375
|
# @return [String]
|
10212
10376
|
#
|
10213
10377
|
# @!attribute [rw] marker
|
@@ -10475,10 +10639,26 @@ module Aws::S3
|
|
10475
10639
|
# @return [String]
|
10476
10640
|
#
|
10477
10641
|
# @!attribute [rw] encoding_type
|
10478
|
-
# Encoding type used by Amazon S3 to encode object keys in
|
10479
|
-
# response.
|
10480
|
-
#
|
10481
|
-
#
|
10642
|
+
# Encoding type used by Amazon S3 to encode the [object keys][1] in
|
10643
|
+
# the response. Responses are encoded only in UTF-8. An object key can
|
10644
|
+
# contain any Unicode character. However, the XML 1.0 parser can't
|
10645
|
+
# parse certain characters, such as characters with an ASCII value
|
10646
|
+
# from 0 to 10. For characters that aren't supported in XML 1.0, you
|
10647
|
+
# can add this parameter to request that Amazon S3 encode the keys in
|
10648
|
+
# the response. For more information about characters to avoid in
|
10649
|
+
# object key names, see [Object key naming guidelines][2].
|
10650
|
+
#
|
10651
|
+
# <note markdown="1"> When using the URL encoding type, non-ASCII characters that are used
|
10652
|
+
# in an object's key name will be percent-encoded according to UTF-8
|
10653
|
+
# code values. For example, the object `test_file(3).png` will appear
|
10654
|
+
# as `test_file%283%29.png`.
|
10655
|
+
#
|
10656
|
+
# </note>
|
10657
|
+
#
|
10658
|
+
#
|
10659
|
+
#
|
10660
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html
|
10661
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines
|
10482
10662
|
# @return [String]
|
10483
10663
|
#
|
10484
10664
|
# @!attribute [rw] max_keys
|
@@ -11173,10 +11353,10 @@ module Aws::S3
|
|
11173
11353
|
# @return [Integer]
|
11174
11354
|
#
|
11175
11355
|
# @!attribute [rw] newer_noncurrent_versions
|
11176
|
-
# Specifies how many
|
11177
|
-
#
|
11178
|
-
#
|
11179
|
-
#
|
11356
|
+
# Specifies how many noncurrent versions Amazon S3 will retain. You
|
11357
|
+
# can specify up to 100 noncurrent versions to retain. Amazon S3 will
|
11358
|
+
# permanently delete any additional noncurrent versions beyond the
|
11359
|
+
# specified number to retain. For more information about noncurrent
|
11180
11360
|
# versions, see [Lifecycle configuration elements][1] in the *Amazon
|
11181
11361
|
# S3 User Guide*.
|
11182
11362
|
#
|
@@ -11220,12 +11400,12 @@ module Aws::S3
|
|
11220
11400
|
# @return [String]
|
11221
11401
|
#
|
11222
11402
|
# @!attribute [rw] newer_noncurrent_versions
|
11223
|
-
# Specifies how many
|
11224
|
-
#
|
11225
|
-
#
|
11226
|
-
#
|
11227
|
-
#
|
11228
|
-
# S3 User Guide*.
|
11403
|
+
# Specifies how many noncurrent versions Amazon S3 will retain in the
|
11404
|
+
# same storage class before transitioning objects. You can specify up
|
11405
|
+
# to 100 noncurrent versions to retain. Amazon S3 will transition any
|
11406
|
+
# additional noncurrent versions beyond the specified number to
|
11407
|
+
# retain. For more information about noncurrent versions, see
|
11408
|
+
# [Lifecycle configuration elements][1] in the *Amazon S3 User Guide*.
|
11229
11409
|
#
|
11230
11410
|
#
|
11231
11411
|
#
|
@@ -11932,7 +12112,15 @@ module Aws::S3
|
|
11932
12112
|
#
|
11933
12113
|
# @!attribute [rw] partition_date_source
|
11934
12114
|
# Specifies the partition date source for the partitioned prefix.
|
11935
|
-
# PartitionDateSource can be EventTime or DeliveryTime
|
12115
|
+
# `PartitionDateSource` can be `EventTime` or `DeliveryTime`.
|
12116
|
+
#
|
12117
|
+
# For `DeliveryTime`, the time in the log file names corresponds to
|
12118
|
+
# the delivery time for the log files.
|
12119
|
+
#
|
12120
|
+
# For `EventTime`, The logs delivered are for a specific day only. The
|
12121
|
+
# year, month, and day correspond to the day on which the event
|
12122
|
+
# occurred, and the hour, minutes and seconds are set to 00 in the
|
12123
|
+
# key.
|
11936
12124
|
# @return [String]
|
11937
12125
|
#
|
11938
12126
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PartitionedPrefix AWS API Documentation
|
@@ -12045,8 +12233,9 @@ module Aws::S3
|
|
12045
12233
|
# @!attribute [rw] restrict_public_buckets
|
12046
12234
|
# Specifies whether Amazon S3 should restrict public bucket policies
|
12047
12235
|
# for this bucket. Setting this element to `TRUE` restricts access to
|
12048
|
-
# this bucket to only Amazon Web
|
12049
|
-
# users within this account if the bucket has a public
|
12236
|
+
# this bucket to only Amazon Web Servicesservice principals and
|
12237
|
+
# authorized users within this account if the bucket has a public
|
12238
|
+
# policy.
|
12050
12239
|
#
|
12051
12240
|
# Enabling this setting doesn't affect previously stored bucket
|
12052
12241
|
# policies, except that public and cross-account access within any
|
@@ -14003,6 +14192,26 @@ module Aws::S3
|
|
14003
14192
|
# [1]: https://www.rfc-editor.org/rfc/rfc7234#section-5.3
|
14004
14193
|
# @return [Time]
|
14005
14194
|
#
|
14195
|
+
# @!attribute [rw] if_none_match
|
14196
|
+
# Uploads the object only if the object key name does not already
|
14197
|
+
# exist in the bucket specified. Otherwise, Amazon S3 returns a `412
|
14198
|
+
# Precondition Failed` error.
|
14199
|
+
#
|
14200
|
+
# If a conflicting operation occurs during the upload S3 returns a
|
14201
|
+
# `409 ConditionalRequestConflict` response. On a 409 failure you
|
14202
|
+
# should retry the upload.
|
14203
|
+
#
|
14204
|
+
# Expects the '*' (asterisk) character.
|
14205
|
+
#
|
14206
|
+
# For more information about conditional requests, see [RFC 7232][1],
|
14207
|
+
# or [Conditional requests][2] in the *Amazon S3 User Guide*.
|
14208
|
+
#
|
14209
|
+
#
|
14210
|
+
#
|
14211
|
+
# [1]: https://tools.ietf.org/html/rfc7232
|
14212
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html
|
14213
|
+
# @return [String]
|
14214
|
+
#
|
14006
14215
|
# @!attribute [rw] grant_full_control
|
14007
14216
|
# Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the
|
14008
14217
|
# object.
|
@@ -14289,6 +14498,7 @@ module Aws::S3
|
|
14289
14498
|
:checksum_sha1,
|
14290
14499
|
:checksum_sha256,
|
14291
14500
|
:expires,
|
14501
|
+
:if_none_match,
|
14292
14502
|
:grant_full_control,
|
14293
14503
|
:grant_read,
|
14294
14504
|
:grant_read_acp,
|
@@ -14699,7 +14909,15 @@ module Aws::S3
|
|
14699
14909
|
# The container for the records event.
|
14700
14910
|
#
|
14701
14911
|
# @!attribute [rw] payload
|
14702
|
-
# The byte array of partial, one or more result records.
|
14912
|
+
# The byte array of partial, one or more result records. S3 Select
|
14913
|
+
# doesn't guarantee that a record will be self-contained in one
|
14914
|
+
# record frame. To ensure continuous streaming of data, S3 Select
|
14915
|
+
# might split the same record across multiple record frames instead of
|
14916
|
+
# aggregating the results in memory. Some S3 clients (for example, the
|
14917
|
+
# SDK for Java) handle this behavior by creating a `ByteStream` out of
|
14918
|
+
# the response by default. Other clients might not handle this
|
14919
|
+
# behavior by default. In those cases, you must aggregate the results
|
14920
|
+
# on the client side and parse the response.
|
14703
14921
|
# @return [String]
|
14704
14922
|
#
|
14705
14923
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RecordsEvent AWS API Documentation
|
@@ -15243,7 +15461,15 @@ module Aws::S3
|
|
15243
15461
|
# @return [Types::GlacierJobParameters]
|
15244
15462
|
#
|
15245
15463
|
# @!attribute [rw] type
|
15464
|
+
# Amazon S3 Select is no longer available to new customers. Existing
|
15465
|
+
# customers of Amazon S3 Select can continue to use the feature as
|
15466
|
+
# usual. [Learn more][1]
|
15467
|
+
#
|
15246
15468
|
# Type of restore request.
|
15469
|
+
#
|
15470
|
+
#
|
15471
|
+
#
|
15472
|
+
# [1]: http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/
|
15247
15473
|
# @return [String]
|
15248
15474
|
#
|
15249
15475
|
# @!attribute [rw] tier
|
@@ -15255,7 +15481,15 @@ module Aws::S3
|
|
15255
15481
|
# @return [String]
|
15256
15482
|
#
|
15257
15483
|
# @!attribute [rw] select_parameters
|
15484
|
+
# Amazon S3 Select is no longer available to new customers. Existing
|
15485
|
+
# customers of Amazon S3 Select can continue to use the feature as
|
15486
|
+
# usual. [Learn more][1]
|
15487
|
+
#
|
15258
15488
|
# Describes the parameters for Select job types.
|
15489
|
+
#
|
15490
|
+
#
|
15491
|
+
#
|
15492
|
+
# [1]: http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/
|
15259
15493
|
# @return [Types::SelectParameters]
|
15260
15494
|
#
|
15261
15495
|
# @!attribute [rw] output_location
|
@@ -15586,6 +15820,12 @@ module Aws::S3
|
|
15586
15820
|
include Aws::Structure
|
15587
15821
|
end
|
15588
15822
|
|
15823
|
+
# <note markdown="1"> Learn Amazon S3 Select is no longer available to new customers.
|
15824
|
+
# Existing customers of Amazon S3 Select can continue to use the feature
|
15825
|
+
# as usual. [Learn more][1]
|
15826
|
+
#
|
15827
|
+
# </note>
|
15828
|
+
#
|
15589
15829
|
# Request to filter the contents of an Amazon S3 object based on a
|
15590
15830
|
# simple Structured Query Language (SQL) statement. In the request,
|
15591
15831
|
# along with the SQL expression, you must specify a data serialization
|
@@ -15593,11 +15833,12 @@ module Aws::S3
|
|
15593
15833
|
# object data into records. It returns only records that match the
|
15594
15834
|
# specified SQL expression. You must also specify the data serialization
|
15595
15835
|
# format for the response. For more information, see [S3Select API
|
15596
|
-
# Documentation][
|
15836
|
+
# Documentation][2].
|
15597
15837
|
#
|
15598
15838
|
#
|
15599
15839
|
#
|
15600
|
-
# [1]:
|
15840
|
+
# [1]: http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/
|
15841
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html
|
15601
15842
|
#
|
15602
15843
|
# @!attribute [rw] bucket
|
15603
15844
|
# The S3 bucket.
|
@@ -15709,8 +15950,21 @@ module Aws::S3
|
|
15709
15950
|
include Aws::Structure
|
15710
15951
|
end
|
15711
15952
|
|
15953
|
+
# Amazon S3 Select is no longer available to new customers. Existing
|
15954
|
+
# customers of Amazon S3 Select can continue to use the feature as
|
15955
|
+
# usual. [Learn more][1]
|
15956
|
+
#
|
15712
15957
|
# Describes the parameters for Select job types.
|
15713
15958
|
#
|
15959
|
+
# Learn [How to optimize querying your data in Amazon S3][1] using
|
15960
|
+
# [Amazon Athena][2], [S3 Object Lambda][3], or client-side filtering.
|
15961
|
+
#
|
15962
|
+
#
|
15963
|
+
#
|
15964
|
+
# [1]: http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/
|
15965
|
+
# [2]: https://docs.aws.amazon.com/athena/latest/ug/what-is.html
|
15966
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html
|
15967
|
+
#
|
15714
15968
|
# @!attribute [rw] input_serialization
|
15715
15969
|
# Describes the serialization format of the object.
|
15716
15970
|
# @return [Types::InputSerialization]
|
@@ -15720,7 +15974,15 @@ module Aws::S3
|
|
15720
15974
|
# @return [String]
|
15721
15975
|
#
|
15722
15976
|
# @!attribute [rw] expression
|
15977
|
+
# Amazon S3 Select is no longer available to new customers. Existing
|
15978
|
+
# customers of Amazon S3 Select can continue to use the feature as
|
15979
|
+
# usual. [Learn more][1]
|
15980
|
+
#
|
15723
15981
|
# The expression that is used to query the object.
|
15982
|
+
#
|
15983
|
+
#
|
15984
|
+
#
|
15985
|
+
# [1]: http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/
|
15724
15986
|
# @return [String]
|
15725
15987
|
#
|
15726
15988
|
# @!attribute [rw] output_serialization
|
@@ -15748,6 +16010,14 @@ module Aws::S3
|
|
15748
16010
|
# SSE-KMS. For more information, see [PUT Bucket encryption][1] in the
|
15749
16011
|
# *Amazon S3 API Reference*.
|
15750
16012
|
#
|
16013
|
+
# <note markdown="1"> If you're specifying a customer managed KMS key, we recommend using a
|
16014
|
+
# fully qualified KMS key ARN. If you use a KMS key alias instead, then
|
16015
|
+
# KMS resolves the key within the requester’s account. This behavior can
|
16016
|
+
# result in data that's encrypted with a KMS key that belongs to the
|
16017
|
+
# requester, and not the bucket owner.
|
16018
|
+
#
|
16019
|
+
# </note>
|
16020
|
+
#
|
15751
16021
|
#
|
15752
16022
|
#
|
15753
16023
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html
|
@@ -15816,6 +16086,14 @@ module Aws::S3
|
|
15816
16086
|
|
15817
16087
|
# Specifies the default server-side encryption configuration.
|
15818
16088
|
#
|
16089
|
+
# <note markdown="1"> If you're specifying a customer managed KMS key, we recommend using a
|
16090
|
+
# fully qualified KMS key ARN. If you use a KMS key alias instead, then
|
16091
|
+
# KMS resolves the key within the requester’s account. This behavior can
|
16092
|
+
# result in data that's encrypted with a KMS key that belongs to the
|
16093
|
+
# requester, and not the bucket owner.
|
16094
|
+
#
|
16095
|
+
# </note>
|
16096
|
+
#
|
15819
16097
|
# @!attribute [rw] apply_server_side_encryption_by_default
|
15820
16098
|
# Specifies the default server-side encryption to apply to new objects
|
15821
16099
|
# in the bucket. If a PUT Object request doesn't specify any
|
data/lib/aws-sdk-s3.rb
CHANGED