aws-sdk-s3 1.124.0 → 1.128.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 +22 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3/bucket.rb +61 -31
- data/lib/aws-sdk-s3/client.rb +453 -407
- data/lib/aws-sdk-s3/client_api.rb +24 -0
- data/lib/aws-sdk-s3/endpoints.rb +1 -0
- data/lib/aws-sdk-s3/object.rb +36 -37
- data/lib/aws-sdk-s3/object_summary.rb +45 -32
- data/lib/aws-sdk-s3/object_version.rb +14 -0
- data/lib/aws-sdk-s3/presigner.rb +4 -2
- data/lib/aws-sdk-s3/types.rb +371 -204
- data/lib/aws-sdk-s3.rb +1 -1
- metadata +6 -6
data/lib/aws-sdk-s3/types.rb
CHANGED
@@ -65,7 +65,7 @@ module Aws::S3
|
|
65
65
|
# When you use this action with S3 on Outposts through the Amazon Web
|
66
66
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
67
67
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
68
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
68
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
69
69
|
#
|
70
70
|
#
|
71
71
|
#
|
@@ -718,7 +718,7 @@ module Aws::S3
|
|
718
718
|
# When you use this action with S3 on Outposts through the Amazon Web
|
719
719
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
720
720
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
721
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
721
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
722
722
|
#
|
723
723
|
#
|
724
724
|
#
|
@@ -806,7 +806,7 @@ module Aws::S3
|
|
806
806
|
#
|
807
807
|
# @!attribute [rw] server_side_encryption
|
808
808
|
# The server-side encryption algorithm used when storing this object
|
809
|
-
# in Amazon S3 (for example, AES256
|
809
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
810
810
|
# @return [String]
|
811
811
|
#
|
812
812
|
# @!attribute [rw] version_id
|
@@ -815,14 +815,15 @@ module Aws::S3
|
|
815
815
|
# @return [String]
|
816
816
|
#
|
817
817
|
# @!attribute [rw] ssekms_key_id
|
818
|
-
# If present, specifies the ID of the
|
819
|
-
#
|
820
|
-
#
|
818
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
819
|
+
# symmetric encryption customer managed key that was used for the
|
820
|
+
# object.
|
821
821
|
# @return [String]
|
822
822
|
#
|
823
823
|
# @!attribute [rw] bucket_key_enabled
|
824
824
|
# Indicates whether the multipart upload uses an S3 Bucket Key for
|
825
|
-
# server-side encryption with
|
825
|
+
# server-side encryption with Key Management Service (KMS) keys
|
826
|
+
# (SSE-KMS).
|
826
827
|
# @return [Boolean]
|
827
828
|
#
|
828
829
|
# @!attribute [rw] request_charged
|
@@ -870,7 +871,7 @@ module Aws::S3
|
|
870
871
|
# When you use this action with S3 on Outposts through the Amazon Web
|
871
872
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
872
873
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
873
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
874
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
874
875
|
#
|
875
876
|
#
|
876
877
|
#
|
@@ -1172,7 +1173,7 @@ module Aws::S3
|
|
1172
1173
|
#
|
1173
1174
|
# @!attribute [rw] server_side_encryption
|
1174
1175
|
# The server-side encryption algorithm used when storing this object
|
1175
|
-
# in Amazon S3 (for example, AES256
|
1176
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
1176
1177
|
# @return [String]
|
1177
1178
|
#
|
1178
1179
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -1189,9 +1190,9 @@ module Aws::S3
|
|
1189
1190
|
# @return [String]
|
1190
1191
|
#
|
1191
1192
|
# @!attribute [rw] ssekms_key_id
|
1192
|
-
# If present, specifies the ID of the
|
1193
|
-
#
|
1194
|
-
#
|
1193
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
1194
|
+
# symmetric encryption customer managed key that was used for the
|
1195
|
+
# object.
|
1195
1196
|
# @return [String]
|
1196
1197
|
#
|
1197
1198
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -1203,7 +1204,8 @@ module Aws::S3
|
|
1203
1204
|
#
|
1204
1205
|
# @!attribute [rw] bucket_key_enabled
|
1205
1206
|
# Indicates whether the copied object uses an S3 Bucket Key for
|
1206
|
-
# server-side encryption with
|
1207
|
+
# server-side encryption with Key Management Service (KMS) keys
|
1208
|
+
# (SSE-KMS).
|
1207
1209
|
# @return [Boolean]
|
1208
1210
|
#
|
1209
1211
|
# @!attribute [rw] request_charged
|
@@ -1254,7 +1256,7 @@ module Aws::S3
|
|
1254
1256
|
# When you use this action with S3 on Outposts through the Amazon Web
|
1255
1257
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
1256
1258
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
1257
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
1259
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
1258
1260
|
#
|
1259
1261
|
#
|
1260
1262
|
#
|
@@ -1410,7 +1412,7 @@ module Aws::S3
|
|
1410
1412
|
#
|
1411
1413
|
# @!attribute [rw] server_side_encryption
|
1412
1414
|
# The server-side encryption algorithm used when storing this object
|
1413
|
-
# in Amazon S3 (for example, AES256
|
1415
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
1414
1416
|
# @return [String]
|
1415
1417
|
#
|
1416
1418
|
# @!attribute [rw] storage_class
|
@@ -1455,13 +1457,12 @@ module Aws::S3
|
|
1455
1457
|
# @return [String]
|
1456
1458
|
#
|
1457
1459
|
# @!attribute [rw] ssekms_key_id
|
1458
|
-
# Specifies the
|
1459
|
-
#
|
1460
|
-
#
|
1461
|
-
#
|
1462
|
-
#
|
1463
|
-
# [
|
1464
|
-
# the *Amazon S3 User Guide*.
|
1460
|
+
# Specifies the KMS key ID to use for object encryption. All GET and
|
1461
|
+
# PUT requests for an object protected by KMS will fail if they're
|
1462
|
+
# not made via SSL or using SigV4. For information about configuring
|
1463
|
+
# any of the officially supported Amazon Web Services SDKs and Amazon
|
1464
|
+
# Web Services CLI, see [Specifying the Signature Version in Request
|
1465
|
+
# Authentication][1] in the *Amazon S3 User Guide*.
|
1465
1466
|
#
|
1466
1467
|
#
|
1467
1468
|
#
|
@@ -1477,9 +1478,9 @@ module Aws::S3
|
|
1477
1478
|
#
|
1478
1479
|
# @!attribute [rw] bucket_key_enabled
|
1479
1480
|
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
1480
|
-
# encryption with server-side encryption using
|
1481
|
-
# Setting this header to `true` causes Amazon S3
|
1482
|
-
# Key for object encryption with SSE-KMS.
|
1481
|
+
# encryption with server-side encryption using Key Management Service
|
1482
|
+
# (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
|
1483
|
+
# to use an S3 Bucket Key for object encryption with SSE-KMS.
|
1483
1484
|
#
|
1484
1485
|
# Specifying this header with a COPY action doesn’t affect
|
1485
1486
|
# bucket-level settings for S3 Bucket Key.
|
@@ -1894,7 +1895,7 @@ module Aws::S3
|
|
1894
1895
|
# When you use this action with S3 on Outposts through the Amazon Web
|
1895
1896
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
1896
1897
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
1897
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
1898
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
1898
1899
|
#
|
1899
1900
|
#
|
1900
1901
|
#
|
@@ -1912,7 +1913,7 @@ module Aws::S3
|
|
1912
1913
|
#
|
1913
1914
|
# @!attribute [rw] server_side_encryption
|
1914
1915
|
# The server-side encryption algorithm used when storing this object
|
1915
|
-
# in Amazon S3 (for example, AES256
|
1916
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
1916
1917
|
# @return [String]
|
1917
1918
|
#
|
1918
1919
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -1929,9 +1930,9 @@ module Aws::S3
|
|
1929
1930
|
# @return [String]
|
1930
1931
|
#
|
1931
1932
|
# @!attribute [rw] ssekms_key_id
|
1932
|
-
# If present, specifies the ID of the
|
1933
|
-
#
|
1934
|
-
#
|
1933
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
1934
|
+
# symmetric encryption customer managed key that was used for the
|
1935
|
+
# object.
|
1935
1936
|
# @return [String]
|
1936
1937
|
#
|
1937
1938
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -1943,7 +1944,8 @@ module Aws::S3
|
|
1943
1944
|
#
|
1944
1945
|
# @!attribute [rw] bucket_key_enabled
|
1945
1946
|
# Indicates whether the multipart upload uses an S3 Bucket Key for
|
1946
|
-
# server-side encryption with
|
1947
|
+
# server-side encryption with Key Management Service (KMS) keys
|
1948
|
+
# (SSE-KMS).
|
1947
1949
|
# @return [Boolean]
|
1948
1950
|
#
|
1949
1951
|
# @!attribute [rw] request_charged
|
@@ -2000,7 +2002,7 @@ module Aws::S3
|
|
2000
2002
|
# When you use this action with S3 on Outposts through the Amazon Web
|
2001
2003
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
2002
2004
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2003
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
2005
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2004
2006
|
#
|
2005
2007
|
#
|
2006
2008
|
#
|
@@ -2069,7 +2071,7 @@ module Aws::S3
|
|
2069
2071
|
#
|
2070
2072
|
# @!attribute [rw] server_side_encryption
|
2071
2073
|
# The server-side encryption algorithm used when storing this object
|
2072
|
-
# in Amazon S3 (for example, AES256
|
2074
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
2073
2075
|
# @return [String]
|
2074
2076
|
#
|
2075
2077
|
# @!attribute [rw] storage_class
|
@@ -2114,11 +2116,11 @@ module Aws::S3
|
|
2114
2116
|
# @!attribute [rw] ssekms_key_id
|
2115
2117
|
# Specifies the ID of the symmetric encryption customer managed key to
|
2116
2118
|
# use for object encryption. All GET and PUT requests for an object
|
2117
|
-
# protected by
|
2118
|
-
#
|
2119
|
-
#
|
2120
|
-
#
|
2121
|
-
#
|
2119
|
+
# protected by KMS will fail if they're not made via SSL or using
|
2120
|
+
# SigV4. For information about configuring any of the officially
|
2121
|
+
# supported Amazon Web Services SDKs and Amazon Web Services CLI, see
|
2122
|
+
# [Specifying the Signature Version in Request Authentication][1] in
|
2123
|
+
# the *Amazon S3 User Guide*.
|
2122
2124
|
#
|
2123
2125
|
#
|
2124
2126
|
#
|
@@ -2134,9 +2136,9 @@ module Aws::S3
|
|
2134
2136
|
#
|
2135
2137
|
# @!attribute [rw] bucket_key_enabled
|
2136
2138
|
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
2137
|
-
# encryption with server-side encryption using
|
2138
|
-
# Setting this header to `true` causes Amazon S3
|
2139
|
-
# Key for object encryption with SSE-KMS.
|
2139
|
+
# encryption with server-side encryption using Key Management Service
|
2140
|
+
# (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
|
2141
|
+
# to use an S3 Bucket Key for object encryption with SSE-KMS.
|
2140
2142
|
#
|
2141
2143
|
# Specifying this header with an object action doesn’t affect
|
2142
2144
|
# bucket-level settings for S3 Bucket Key.
|
@@ -2266,7 +2268,7 @@ module Aws::S3
|
|
2266
2268
|
# Container for the objects to delete.
|
2267
2269
|
#
|
2268
2270
|
# @!attribute [rw] objects
|
2269
|
-
# The
|
2271
|
+
# The object to delete.
|
2270
2272
|
# @return [Array<Types::ObjectIdentifier>]
|
2271
2273
|
#
|
2272
2274
|
# @!attribute [rw] quiet
|
@@ -2669,7 +2671,7 @@ module Aws::S3
|
|
2669
2671
|
# When you use this action with S3 on Outposts through the Amazon Web
|
2670
2672
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
2671
2673
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2672
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
2674
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2673
2675
|
#
|
2674
2676
|
#
|
2675
2677
|
#
|
@@ -2762,7 +2764,7 @@ module Aws::S3
|
|
2762
2764
|
# When you use this action with S3 on Outposts through the Amazon Web
|
2763
2765
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
2764
2766
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2765
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
2767
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2766
2768
|
#
|
2767
2769
|
#
|
2768
2770
|
#
|
@@ -2840,7 +2842,7 @@ module Aws::S3
|
|
2840
2842
|
# When you use this action with S3 on Outposts through the Amazon Web
|
2841
2843
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
2842
2844
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2843
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
2845
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2844
2846
|
#
|
2845
2847
|
#
|
2846
2848
|
#
|
@@ -3061,8 +3063,8 @@ module Aws::S3
|
|
3061
3063
|
# the ID of the symmetric encryption customer managed key to use for
|
3062
3064
|
# encryption of job results. Amazon S3 only supports symmetric
|
3063
3065
|
# encryption KMS keys. For more information, see [Asymmetric keys in
|
3064
|
-
#
|
3065
|
-
#
|
3066
|
+
# KMS][1] in the *Amazon Web Services Key Management Service Developer
|
3067
|
+
# Guide*.
|
3066
3068
|
#
|
3067
3069
|
#
|
3068
3070
|
#
|
@@ -4040,10 +4042,16 @@ module Aws::S3
|
|
4040
4042
|
# The accelerate configuration of the bucket.
|
4041
4043
|
# @return [String]
|
4042
4044
|
#
|
4045
|
+
# @!attribute [rw] request_charged
|
4046
|
+
# If present, indicates that the requester was successfully charged
|
4047
|
+
# for the request.
|
4048
|
+
# @return [String]
|
4049
|
+
#
|
4043
4050
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfigurationOutput AWS API Documentation
|
4044
4051
|
#
|
4045
4052
|
class GetBucketAccelerateConfigurationOutput < Struct.new(
|
4046
|
-
:status
|
4053
|
+
:status,
|
4054
|
+
:request_charged)
|
4047
4055
|
SENSITIVE = []
|
4048
4056
|
include Aws::Structure
|
4049
4057
|
end
|
@@ -4059,11 +4067,24 @@ module Aws::S3
|
|
4059
4067
|
# `403 Forbidden` (access denied).
|
4060
4068
|
# @return [String]
|
4061
4069
|
#
|
4070
|
+
# @!attribute [rw] request_payer
|
4071
|
+
# Confirms that the requester knows that they will be charged for the
|
4072
|
+
# request. Bucket owners need not specify this parameter in their
|
4073
|
+
# requests. For information about downloading objects from Requester
|
4074
|
+
# Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
|
4075
|
+
# in the *Amazon S3 User Guide*.
|
4076
|
+
#
|
4077
|
+
#
|
4078
|
+
#
|
4079
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
4080
|
+
# @return [String]
|
4081
|
+
#
|
4062
4082
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfigurationRequest AWS API Documentation
|
4063
4083
|
#
|
4064
4084
|
class GetBucketAccelerateConfigurationRequest < Struct.new(
|
4065
4085
|
:bucket,
|
4066
|
-
:expected_bucket_owner
|
4086
|
+
:expected_bucket_owner,
|
4087
|
+
:request_payer)
|
4067
4088
|
SENSITIVE = []
|
4068
4089
|
include Aws::Structure
|
4069
4090
|
end
|
@@ -5025,7 +5046,7 @@ module Aws::S3
|
|
5025
5046
|
# When you use this action with S3 on Outposts through the Amazon Web
|
5026
5047
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
5027
5048
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
5028
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
5049
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
5029
5050
|
#
|
5030
5051
|
#
|
5031
5052
|
#
|
@@ -5088,9 +5109,8 @@ module Aws::S3
|
|
5088
5109
|
# @return [String]
|
5089
5110
|
#
|
5090
5111
|
# @!attribute [rw] object_attributes
|
5091
|
-
#
|
5092
|
-
#
|
5093
|
-
# not returned.
|
5112
|
+
# Specifies the fields at the root level that you want returned in the
|
5113
|
+
# response. Fields that you do not specify are not returned.
|
5094
5114
|
# @return [Array<String>]
|
5095
5115
|
#
|
5096
5116
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAttributesRequest AWS API Documentation
|
@@ -5370,7 +5390,7 @@ module Aws::S3
|
|
5370
5390
|
#
|
5371
5391
|
# @!attribute [rw] server_side_encryption
|
5372
5392
|
# The server-side encryption algorithm used when storing this object
|
5373
|
-
# in Amazon S3 (for example, AES256
|
5393
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
5374
5394
|
# @return [String]
|
5375
5395
|
#
|
5376
5396
|
# @!attribute [rw] metadata
|
@@ -5391,14 +5411,14 @@ module Aws::S3
|
|
5391
5411
|
# @return [String]
|
5392
5412
|
#
|
5393
5413
|
# @!attribute [rw] ssekms_key_id
|
5394
|
-
# If present, specifies the ID of the
|
5395
|
-
#
|
5396
|
-
#
|
5414
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
5415
|
+
# symmetric encryption customer managed key that was used for the
|
5416
|
+
# object.
|
5397
5417
|
# @return [String]
|
5398
5418
|
#
|
5399
5419
|
# @!attribute [rw] bucket_key_enabled
|
5400
5420
|
# Indicates whether the object uses an S3 Bucket Key for server-side
|
5401
|
-
# encryption with
|
5421
|
+
# encryption with Key Management Service (KMS) keys (SSE-KMS).
|
5402
5422
|
# @return [Boolean]
|
5403
5423
|
#
|
5404
5424
|
# @!attribute [rw] storage_class
|
@@ -5507,7 +5527,7 @@ module Aws::S3
|
|
5507
5527
|
# When you use this action with S3 on Outposts through the Amazon Web
|
5508
5528
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
5509
5529
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
5510
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
5530
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
5511
5531
|
#
|
5512
5532
|
#
|
5513
5533
|
#
|
@@ -5766,7 +5786,7 @@ module Aws::S3
|
|
5766
5786
|
# When you use this action with S3 on Outposts through the Amazon Web
|
5767
5787
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
5768
5788
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
5769
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
5789
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
5770
5790
|
#
|
5771
5791
|
#
|
5772
5792
|
#
|
@@ -6024,7 +6044,7 @@ module Aws::S3
|
|
6024
6044
|
# When you use this action with S3 on Outposts through the Amazon Web
|
6025
6045
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
6026
6046
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
6027
|
-
# [What is S3 on Outposts][3] in the *Amazon S3 User Guide*.
|
6047
|
+
# [What is S3 on Outposts?][3] in the *Amazon S3 User Guide*.
|
6028
6048
|
#
|
6029
6049
|
#
|
6030
6050
|
#
|
@@ -6208,7 +6228,7 @@ module Aws::S3
|
|
6208
6228
|
#
|
6209
6229
|
# @!attribute [rw] server_side_encryption
|
6210
6230
|
# The server-side encryption algorithm used when storing this object
|
6211
|
-
# in Amazon S3 (for example, AES256
|
6231
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
6212
6232
|
# @return [String]
|
6213
6233
|
#
|
6214
6234
|
# @!attribute [rw] metadata
|
@@ -6229,14 +6249,14 @@ module Aws::S3
|
|
6229
6249
|
# @return [String]
|
6230
6250
|
#
|
6231
6251
|
# @!attribute [rw] ssekms_key_id
|
6232
|
-
# If present, specifies the ID of the
|
6233
|
-
#
|
6234
|
-
#
|
6252
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
6253
|
+
# symmetric encryption customer managed key that was used for the
|
6254
|
+
# object.
|
6235
6255
|
# @return [String]
|
6236
6256
|
#
|
6237
6257
|
# @!attribute [rw] bucket_key_enabled
|
6238
6258
|
# Indicates whether the object uses an S3 Bucket Key for server-side
|
6239
|
-
# encryption with
|
6259
|
+
# encryption with Key Management Service (KMS) keys (SSE-KMS).
|
6240
6260
|
# @return [Boolean]
|
6241
6261
|
#
|
6242
6262
|
# @!attribute [rw] storage_class
|
@@ -6397,7 +6417,7 @@ module Aws::S3
|
|
6397
6417
|
# When you use this action with S3 on Outposts through the Amazon Web
|
6398
6418
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
6399
6419
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
6400
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
6420
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
6401
6421
|
#
|
6402
6422
|
#
|
6403
6423
|
#
|
@@ -7221,8 +7241,8 @@ module Aws::S3
|
|
7221
7241
|
# @return [String]
|
7222
7242
|
#
|
7223
7243
|
# @!attribute [rw] continuation_token
|
7224
|
-
# The ContinuationToken that represents a placeholder from where
|
7225
|
-
# request should begin.
|
7244
|
+
# The `ContinuationToken` that represents a placeholder from where
|
7245
|
+
# this request should begin.
|
7226
7246
|
# @return [String]
|
7227
7247
|
#
|
7228
7248
|
# @!attribute [rw] expected_bucket_owner
|
@@ -7334,9 +7354,9 @@ module Aws::S3
|
|
7334
7354
|
#
|
7335
7355
|
# @!attribute [rw] continuation_token
|
7336
7356
|
# The marker used to continue an inventory configuration listing that
|
7337
|
-
# has been truncated. Use the NextContinuationToken from a
|
7338
|
-
# truncated list response to continue the listing. The
|
7339
|
-
# token is an opaque value that Amazon S3 understands.
|
7357
|
+
# has been truncated. Use the `NextContinuationToken` from a
|
7358
|
+
# previously truncated list response to continue the listing. The
|
7359
|
+
# continuation token is an opaque value that Amazon S3 understands.
|
7340
7360
|
# @return [String]
|
7341
7361
|
#
|
7342
7362
|
# @!attribute [rw] expected_bucket_owner
|
@@ -7397,7 +7417,7 @@ module Aws::S3
|
|
7397
7417
|
#
|
7398
7418
|
# @!attribute [rw] continuation_token
|
7399
7419
|
# The marker that is used to continue a metrics configuration listing
|
7400
|
-
# that has been truncated. Use the NextContinuationToken from a
|
7420
|
+
# that has been truncated. Use the `NextContinuationToken` from a
|
7401
7421
|
# previously truncated list response to continue the listing. The
|
7402
7422
|
# continuation token is an opaque value that Amazon S3 understands.
|
7403
7423
|
# @return [String]
|
@@ -7500,13 +7520,18 @@ module Aws::S3
|
|
7500
7520
|
# Encoding type used by Amazon S3 to encode object keys in the
|
7501
7521
|
# response.
|
7502
7522
|
#
|
7503
|
-
# If you specify `encoding-type` request parameter, Amazon S3
|
7504
|
-
# this element in the response, and returns encoded key name
|
7505
|
-
# the following response elements:
|
7523
|
+
# If you specify the `encoding-type` request parameter, Amazon S3
|
7524
|
+
# includes this element in the response, and returns encoded key name
|
7525
|
+
# values in the following response elements:
|
7506
7526
|
#
|
7507
7527
|
# `Delimiter`, `KeyMarker`, `Prefix`, `NextKeyMarker`, `Key`.
|
7508
7528
|
# @return [String]
|
7509
7529
|
#
|
7530
|
+
# @!attribute [rw] request_charged
|
7531
|
+
# If present, indicates that the requester was successfully charged
|
7532
|
+
# for the request.
|
7533
|
+
# @return [String]
|
7534
|
+
#
|
7510
7535
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploadsOutput AWS API Documentation
|
7511
7536
|
#
|
7512
7537
|
class ListMultipartUploadsOutput < Struct.new(
|
@@ -7521,7 +7546,8 @@ module Aws::S3
|
|
7521
7546
|
:is_truncated,
|
7522
7547
|
:uploads,
|
7523
7548
|
:common_prefixes,
|
7524
|
-
:encoding_type
|
7549
|
+
:encoding_type,
|
7550
|
+
:request_charged)
|
7525
7551
|
SENSITIVE = []
|
7526
7552
|
include Aws::Structure
|
7527
7553
|
end
|
@@ -7545,7 +7571,7 @@ module Aws::S3
|
|
7545
7571
|
# When you use this action with S3 on Outposts through the Amazon Web
|
7546
7572
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
7547
7573
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
7548
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
7574
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
7549
7575
|
#
|
7550
7576
|
#
|
7551
7577
|
#
|
@@ -7567,15 +7593,15 @@ module Aws::S3
|
|
7567
7593
|
#
|
7568
7594
|
# @!attribute [rw] encoding_type
|
7569
7595
|
# Requests Amazon S3 to encode the object keys in the response and
|
7570
|
-
# specifies the encoding method to use. An object key
|
7571
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
7596
|
+
# specifies the encoding method to use. An object key can contain any
|
7597
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
7572
7598
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
7573
7599
|
# characters that are not supported in XML 1.0, you can add this
|
7574
7600
|
# parameter to request that Amazon S3 encode the keys in the response.
|
7575
7601
|
# @return [String]
|
7576
7602
|
#
|
7577
7603
|
# @!attribute [rw] key_marker
|
7578
|
-
# Together with upload-id-marker
|
7604
|
+
# Together with `upload-id-marker`, this parameter specifies the
|
7579
7605
|
# multipart upload after which listing should begin.
|
7580
7606
|
#
|
7581
7607
|
# If `upload-id-marker` is not specified, only the keys
|
@@ -7597,8 +7623,8 @@ module Aws::S3
|
|
7597
7623
|
# @!attribute [rw] prefix
|
7598
7624
|
# Lists in-progress uploads only for those keys that begin with the
|
7599
7625
|
# specified prefix. You can use prefixes to separate a bucket into
|
7600
|
-
# different grouping of keys. (You can think of using prefix to make
|
7601
|
-
# groups in the same way you'd use a folder in a file system.)
|
7626
|
+
# different grouping of keys. (You can think of using `prefix` to make
|
7627
|
+
# groups in the same way that you'd use a folder in a file system.)
|
7602
7628
|
# @return [String]
|
7603
7629
|
#
|
7604
7630
|
# @!attribute [rw] upload_id_marker
|
@@ -7616,6 +7642,18 @@ module Aws::S3
|
|
7616
7642
|
# `403 Forbidden` (access denied).
|
7617
7643
|
# @return [String]
|
7618
7644
|
#
|
7645
|
+
# @!attribute [rw] request_payer
|
7646
|
+
# Confirms that the requester knows that they will be charged for the
|
7647
|
+
# request. Bucket owners need not specify this parameter in their
|
7648
|
+
# requests. For information about downloading objects from Requester
|
7649
|
+
# Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
|
7650
|
+
# in the *Amazon S3 User Guide*.
|
7651
|
+
#
|
7652
|
+
#
|
7653
|
+
#
|
7654
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
7655
|
+
# @return [String]
|
7656
|
+
#
|
7619
7657
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploadsRequest AWS API Documentation
|
7620
7658
|
#
|
7621
7659
|
class ListMultipartUploadsRequest < Struct.new(
|
@@ -7626,7 +7664,8 @@ module Aws::S3
|
|
7626
7664
|
:max_uploads,
|
7627
7665
|
:prefix,
|
7628
7666
|
:upload_id_marker,
|
7629
|
-
:expected_bucket_owner
|
7667
|
+
:expected_bucket_owner,
|
7668
|
+
:request_payer)
|
7630
7669
|
SENSITIVE = []
|
7631
7670
|
include Aws::Structure
|
7632
7671
|
end
|
@@ -7634,9 +7673,9 @@ module Aws::S3
|
|
7634
7673
|
# @!attribute [rw] is_truncated
|
7635
7674
|
# A flag that indicates whether Amazon S3 returned all of the results
|
7636
7675
|
# that satisfied the search criteria. If your results were truncated,
|
7637
|
-
# you can make a follow-up paginated request using the
|
7638
|
-
# and NextVersionIdMarker response parameters as a
|
7639
|
-
# another request to return the rest of the results.
|
7676
|
+
# you can make a follow-up paginated request by using the
|
7677
|
+
# `NextKeyMarker` and `NextVersionIdMarker` response parameters as a
|
7678
|
+
# starting place in another request to return the rest of the results.
|
7640
7679
|
# @return [Boolean]
|
7641
7680
|
#
|
7642
7681
|
# @!attribute [rw] key_marker
|
@@ -7658,7 +7697,7 @@ module Aws::S3
|
|
7658
7697
|
# When the number of responses exceeds the value of `MaxKeys`,
|
7659
7698
|
# `NextVersionIdMarker` specifies the first object version not
|
7660
7699
|
# returned that satisfies the search criteria. Use this value for the
|
7661
|
-
# version-id-marker request parameter in a subsequent request.
|
7700
|
+
# `version-id-marker` request parameter in a subsequent request.
|
7662
7701
|
# @return [String]
|
7663
7702
|
#
|
7664
7703
|
# @!attribute [rw] versions
|
@@ -7683,7 +7722,7 @@ module Aws::S3
|
|
7683
7722
|
# that you specify to group keys. All keys that contain the same
|
7684
7723
|
# string between the prefix and the first occurrence of the delimiter
|
7685
7724
|
# are grouped under a single result element in `CommonPrefixes`. These
|
7686
|
-
# groups are counted as one result against the max-keys limitation.
|
7725
|
+
# groups are counted as one result against the `max-keys` limitation.
|
7687
7726
|
# These keys are not returned elsewhere in the response.
|
7688
7727
|
# @return [String]
|
7689
7728
|
#
|
@@ -7700,13 +7739,18 @@ module Aws::S3
|
|
7700
7739
|
# Encoding type used by Amazon S3 to encode object key names in the
|
7701
7740
|
# XML response.
|
7702
7741
|
#
|
7703
|
-
# If you specify encoding-type request parameter, Amazon S3
|
7704
|
-
# this element in the response, and returns encoded key name
|
7705
|
-
# the following response elements:
|
7742
|
+
# If you specify the `encoding-type` request parameter, Amazon S3
|
7743
|
+
# includes this element in the response, and returns encoded key name
|
7744
|
+
# values in the following response elements:
|
7706
7745
|
#
|
7707
7746
|
# `KeyMarker, NextKeyMarker, Prefix, Key`, and `Delimiter`.
|
7708
7747
|
# @return [String]
|
7709
7748
|
#
|
7749
|
+
# @!attribute [rw] request_charged
|
7750
|
+
# If present, indicates that the requester was successfully charged
|
7751
|
+
# for the request.
|
7752
|
+
# @return [String]
|
7753
|
+
#
|
7710
7754
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersionsOutput AWS API Documentation
|
7711
7755
|
#
|
7712
7756
|
class ListObjectVersionsOutput < Struct.new(
|
@@ -7722,7 +7766,8 @@ module Aws::S3
|
|
7722
7766
|
:delimiter,
|
7723
7767
|
:max_keys,
|
7724
7768
|
:common_prefixes,
|
7725
|
-
:encoding_type
|
7769
|
+
:encoding_type,
|
7770
|
+
:request_charged)
|
7726
7771
|
SENSITIVE = []
|
7727
7772
|
include Aws::Structure
|
7728
7773
|
end
|
@@ -7735,15 +7780,15 @@ module Aws::S3
|
|
7735
7780
|
# A delimiter is a character that you specify to group keys. All keys
|
7736
7781
|
# that contain the same string between the `prefix` and the first
|
7737
7782
|
# occurrence of the delimiter are grouped under a single result
|
7738
|
-
# element in CommonPrefixes
|
7739
|
-
# against the max-keys limitation. These keys are not returned
|
7783
|
+
# element in `CommonPrefixes`. These groups are counted as one result
|
7784
|
+
# against the `max-keys` limitation. These keys are not returned
|
7740
7785
|
# elsewhere in the response.
|
7741
7786
|
# @return [String]
|
7742
7787
|
#
|
7743
7788
|
# @!attribute [rw] encoding_type
|
7744
7789
|
# Requests Amazon S3 to encode the object keys in the response and
|
7745
|
-
# specifies the encoding method to use. An object key
|
7746
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
7790
|
+
# specifies the encoding method to use. An object key can contain any
|
7791
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
7747
7792
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
7748
7793
|
# characters that are not supported in XML 1.0, you can add this
|
7749
7794
|
# parameter to request that Amazon S3 encode the keys in the response.
|
@@ -7754,22 +7799,22 @@ module Aws::S3
|
|
7754
7799
|
# @return [String]
|
7755
7800
|
#
|
7756
7801
|
# @!attribute [rw] max_keys
|
7757
|
-
# Sets the maximum number of keys returned in the response. By
|
7758
|
-
# the action returns up to 1,000 key names. The response
|
7759
|
-
# fewer keys but will never contain more. If additional
|
7760
|
-
# the search criteria, but were not returned because
|
7761
|
-
# exceeded, the response contains
|
7762
|
-
#
|
7763
|
-
#
|
7802
|
+
# Sets the maximum number of keys returned in the response. By
|
7803
|
+
# default, the action returns up to 1,000 key names. The response
|
7804
|
+
# might contain fewer keys but will never contain more. If additional
|
7805
|
+
# keys satisfy the search criteria, but were not returned because
|
7806
|
+
# `max-keys` was exceeded, the response contains
|
7807
|
+
# `<isTruncated>true</isTruncated>`. To return the additional keys,
|
7808
|
+
# see `key-marker` and `version-id-marker`.
|
7764
7809
|
# @return [Integer]
|
7765
7810
|
#
|
7766
7811
|
# @!attribute [rw] prefix
|
7767
7812
|
# Use this parameter to select only those keys that begin with the
|
7768
7813
|
# specified prefix. You can use prefixes to separate a bucket into
|
7769
|
-
# different groupings of keys. (You can think of using prefix to
|
7770
|
-
# groups in the same way you'd use a folder in a file
|
7771
|
-
# can use prefix with delimiter to roll up numerous
|
7772
|
-
# single result under CommonPrefixes
|
7814
|
+
# different groupings of keys. (You can think of using `prefix` to
|
7815
|
+
# make groups in the same way that you'd use a folder in a file
|
7816
|
+
# system.) You can use `prefix` with `delimiter` to roll up numerous
|
7817
|
+
# objects into a single result under `CommonPrefixes`.
|
7773
7818
|
# @return [String]
|
7774
7819
|
#
|
7775
7820
|
# @!attribute [rw] version_id_marker
|
@@ -7782,6 +7827,23 @@ module Aws::S3
|
|
7782
7827
|
# `403 Forbidden` (access denied).
|
7783
7828
|
# @return [String]
|
7784
7829
|
#
|
7830
|
+
# @!attribute [rw] request_payer
|
7831
|
+
# Confirms that the requester knows that they will be charged for the
|
7832
|
+
# request. Bucket owners need not specify this parameter in their
|
7833
|
+
# requests. For information about downloading objects from Requester
|
7834
|
+
# Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
|
7835
|
+
# in the *Amazon S3 User Guide*.
|
7836
|
+
#
|
7837
|
+
#
|
7838
|
+
#
|
7839
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
7840
|
+
# @return [String]
|
7841
|
+
#
|
7842
|
+
# @!attribute [rw] optional_object_attributes
|
7843
|
+
# Specifies the optional fields that you want returned in the
|
7844
|
+
# response. Fields that you do not specify are not returned.
|
7845
|
+
# @return [Array<String>]
|
7846
|
+
#
|
7785
7847
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersionsRequest AWS API Documentation
|
7786
7848
|
#
|
7787
7849
|
class ListObjectVersionsRequest < Struct.new(
|
@@ -7792,7 +7854,9 @@ module Aws::S3
|
|
7792
7854
|
:max_keys,
|
7793
7855
|
:prefix,
|
7794
7856
|
:version_id_marker,
|
7795
|
-
:expected_bucket_owner
|
7857
|
+
:expected_bucket_owner,
|
7858
|
+
:request_payer,
|
7859
|
+
:optional_object_attributes)
|
7796
7860
|
SENSITIVE = []
|
7797
7861
|
include Aws::Structure
|
7798
7862
|
end
|
@@ -7808,14 +7872,18 @@ module Aws::S3
|
|
7808
7872
|
# @return [String]
|
7809
7873
|
#
|
7810
7874
|
# @!attribute [rw] next_marker
|
7811
|
-
# When response is truncated (the IsTruncated element value in
|
7812
|
-
# response is true), you can use the key name in this field as
|
7813
|
-
# in the subsequent request to get next set
|
7814
|
-
# lists objects in alphabetical order
|
7815
|
-
#
|
7816
|
-
#
|
7817
|
-
#
|
7818
|
-
#
|
7875
|
+
# When the response is truncated (the `IsTruncated` element value in
|
7876
|
+
# the response is `true`), you can use the key name in this field as
|
7877
|
+
# the `marker` parameter in the subsequent request to get the next set
|
7878
|
+
# of objects. Amazon S3 lists objects in alphabetical order.
|
7879
|
+
#
|
7880
|
+
# <note markdown="1"> This element is returned only if you have the `delimiter` request
|
7881
|
+
# parameter specified. If the response does not include the
|
7882
|
+
# `NextMarker` element and it is truncated, you can use the value of
|
7883
|
+
# the last `Key` element in the response as the `marker` parameter in
|
7884
|
+
# the subsequent request to get the next set of object keys.
|
7885
|
+
#
|
7886
|
+
# </note>
|
7819
7887
|
# @return [String]
|
7820
7888
|
#
|
7821
7889
|
# @!attribute [rw] contents
|
@@ -7846,19 +7914,20 @@ module Aws::S3
|
|
7846
7914
|
# All of the keys (up to 1,000) rolled up in a common prefix count as
|
7847
7915
|
# a single return when calculating the number of returns.
|
7848
7916
|
#
|
7849
|
-
# A response can contain CommonPrefixes only if you specify a
|
7917
|
+
# A response can contain `CommonPrefixes` only if you specify a
|
7850
7918
|
# delimiter.
|
7851
7919
|
#
|
7852
|
-
# CommonPrefixes contains all (if there are any) keys between
|
7853
|
-
# and the next occurrence of the string specified by the
|
7920
|
+
# `CommonPrefixes` contains all (if there are any) keys between
|
7921
|
+
# `Prefix` and the next occurrence of the string specified by the
|
7922
|
+
# delimiter.
|
7854
7923
|
#
|
7855
|
-
# CommonPrefixes lists keys that act like subdirectories in the
|
7856
|
-
# directory specified by Prefix
|
7924
|
+
# `CommonPrefixes` lists keys that act like subdirectories in the
|
7925
|
+
# directory specified by `Prefix`.
|
7857
7926
|
#
|
7858
|
-
# For example, if the prefix is notes
|
7859
|
-
# (
|
7860
|
-
# of the keys that roll up into a common prefix
|
7861
|
-
# return when calculating the number of returns.
|
7927
|
+
# For example, if the prefix is `notes/` and the delimiter is a slash
|
7928
|
+
# (`/`), as in `notes/summer/july`, the common prefix is
|
7929
|
+
# `notes/summer/`. All of the keys that roll up into a common prefix
|
7930
|
+
# count as a single return when calculating the number of returns.
|
7862
7931
|
# @return [Array<Types::CommonPrefix>]
|
7863
7932
|
#
|
7864
7933
|
# @!attribute [rw] encoding_type
|
@@ -7866,6 +7935,11 @@ module Aws::S3
|
|
7866
7935
|
# response.
|
7867
7936
|
# @return [String]
|
7868
7937
|
#
|
7938
|
+
# @!attribute [rw] request_charged
|
7939
|
+
# If present, indicates that the requester was successfully charged
|
7940
|
+
# for the request.
|
7941
|
+
# @return [String]
|
7942
|
+
#
|
7869
7943
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsOutput AWS API Documentation
|
7870
7944
|
#
|
7871
7945
|
class ListObjectsOutput < Struct.new(
|
@@ -7878,7 +7952,8 @@ module Aws::S3
|
|
7878
7952
|
:delimiter,
|
7879
7953
|
:max_keys,
|
7880
7954
|
:common_prefixes,
|
7881
|
-
:encoding_type
|
7955
|
+
:encoding_type,
|
7956
|
+
:request_charged)
|
7882
7957
|
SENSITIVE = []
|
7883
7958
|
include Aws::Structure
|
7884
7959
|
end
|
@@ -7902,7 +7977,7 @@ module Aws::S3
|
|
7902
7977
|
# When you use this action with S3 on Outposts through the Amazon Web
|
7903
7978
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
7904
7979
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
7905
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
7980
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
7906
7981
|
#
|
7907
7982
|
#
|
7908
7983
|
#
|
@@ -7911,13 +7986,13 @@ module Aws::S3
|
|
7911
7986
|
# @return [String]
|
7912
7987
|
#
|
7913
7988
|
# @!attribute [rw] delimiter
|
7914
|
-
# A delimiter is a character you use to group keys.
|
7989
|
+
# A delimiter is a character that you use to group keys.
|
7915
7990
|
# @return [String]
|
7916
7991
|
#
|
7917
7992
|
# @!attribute [rw] encoding_type
|
7918
7993
|
# Requests Amazon S3 to encode the object keys in the response and
|
7919
|
-
# specifies the encoding method to use. An object key
|
7920
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
7994
|
+
# specifies the encoding method to use. An object key can contain any
|
7995
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
7921
7996
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
7922
7997
|
# characters that are not supported in XML 1.0, you can add this
|
7923
7998
|
# parameter to request that Amazon S3 encode the keys in the response.
|
@@ -7930,9 +8005,9 @@ module Aws::S3
|
|
7930
8005
|
# @return [String]
|
7931
8006
|
#
|
7932
8007
|
# @!attribute [rw] max_keys
|
7933
|
-
# Sets the maximum number of keys returned in the response. By
|
7934
|
-
# the action returns up to 1,000 key names. The response
|
7935
|
-
# fewer keys but will never contain more.
|
8008
|
+
# Sets the maximum number of keys returned in the response. By
|
8009
|
+
# default, the action returns up to 1,000 key names. The response
|
8010
|
+
# might contain fewer keys but will never contain more.
|
7936
8011
|
# @return [Integer]
|
7937
8012
|
#
|
7938
8013
|
# @!attribute [rw] prefix
|
@@ -7951,6 +8026,11 @@ module Aws::S3
|
|
7951
8026
|
# `403 Forbidden` (access denied).
|
7952
8027
|
# @return [String]
|
7953
8028
|
#
|
8029
|
+
# @!attribute [rw] optional_object_attributes
|
8030
|
+
# Specifies the optional fields that you want returned in the
|
8031
|
+
# response. Fields that you do not specify are not returned.
|
8032
|
+
# @return [Array<String>]
|
8033
|
+
#
|
7954
8034
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsRequest AWS API Documentation
|
7955
8035
|
#
|
7956
8036
|
class ListObjectsRequest < Struct.new(
|
@@ -7961,15 +8041,17 @@ module Aws::S3
|
|
7961
8041
|
:max_keys,
|
7962
8042
|
:prefix,
|
7963
8043
|
:request_payer,
|
7964
|
-
:expected_bucket_owner
|
8044
|
+
:expected_bucket_owner,
|
8045
|
+
:optional_object_attributes)
|
7965
8046
|
SENSITIVE = []
|
7966
8047
|
include Aws::Structure
|
7967
8048
|
end
|
7968
8049
|
|
7969
8050
|
# @!attribute [rw] is_truncated
|
7970
|
-
# Set to false if all of the results were returned. Set to true if
|
8051
|
+
# Set to `false` if all of the results were returned. Set to `true` if
|
7971
8052
|
# more keys are available to return. If the number of results exceeds
|
7972
|
-
# that specified by MaxKeys
|
8053
|
+
# that specified by `MaxKeys`, all of the results might not be
|
8054
|
+
# returned.
|
7973
8055
|
# @return [Boolean]
|
7974
8056
|
#
|
7975
8057
|
# @!attribute [rw] contents
|
@@ -7995,7 +8077,7 @@ module Aws::S3
|
|
7995
8077
|
# When you use this action with S3 on Outposts through the Amazon Web
|
7996
8078
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
7997
8079
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
7998
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
8080
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
7999
8081
|
#
|
8000
8082
|
#
|
8001
8083
|
#
|
@@ -8008,17 +8090,17 @@ module Aws::S3
|
|
8008
8090
|
# @return [String]
|
8009
8091
|
#
|
8010
8092
|
# @!attribute [rw] delimiter
|
8011
|
-
# Causes keys that contain the same string between the prefix and
|
8012
|
-
# first occurrence of the delimiter to be rolled up into a single
|
8013
|
-
# result element in the CommonPrefixes collection. These rolled-up
|
8093
|
+
# Causes keys that contain the same string between the `prefix` and
|
8094
|
+
# the first occurrence of the delimiter to be rolled up into a single
|
8095
|
+
# result element in the `CommonPrefixes` collection. These rolled-up
|
8014
8096
|
# keys are not returned elsewhere in the response. Each rolled-up
|
8015
8097
|
# result counts as only one return against the `MaxKeys` value.
|
8016
8098
|
# @return [String]
|
8017
8099
|
#
|
8018
8100
|
# @!attribute [rw] max_keys
|
8019
|
-
# Sets the maximum number of keys returned in the response. By
|
8020
|
-
# the action returns up to 1,000 key names. The response
|
8021
|
-
# fewer keys but will never contain more.
|
8101
|
+
# Sets the maximum number of keys returned in the response. By
|
8102
|
+
# default, the action returns up to 1,000 key names. The response
|
8103
|
+
# might contain fewer keys but will never contain more.
|
8022
8104
|
# @return [Integer]
|
8023
8105
|
#
|
8024
8106
|
# @!attribute [rw] common_prefixes
|
@@ -8045,7 +8127,7 @@ module Aws::S3
|
|
8045
8127
|
# Encoding type used by Amazon S3 to encode object key names in the
|
8046
8128
|
# XML response.
|
8047
8129
|
#
|
8048
|
-
# If you specify the encoding-type request parameter, Amazon S3
|
8130
|
+
# If you specify the `encoding-type` request parameter, Amazon S3
|
8049
8131
|
# includes this element in the response, and returns encoded key name
|
8050
8132
|
# values in the following response elements:
|
8051
8133
|
#
|
@@ -8053,13 +8135,14 @@ module Aws::S3
|
|
8053
8135
|
# @return [String]
|
8054
8136
|
#
|
8055
8137
|
# @!attribute [rw] key_count
|
8056
|
-
# KeyCount is the number of keys returned with this request.
|
8057
|
-
# will always be less than or equal to the `MaxKeys` field.
|
8058
|
-
# ask for 50 keys, your result will include 50
|
8138
|
+
# `KeyCount` is the number of keys returned with this request.
|
8139
|
+
# `KeyCount` will always be less than or equal to the `MaxKeys` field.
|
8140
|
+
# For example, if you ask for 50 keys, your result will include 50
|
8141
|
+
# keys or fewer.
|
8059
8142
|
# @return [Integer]
|
8060
8143
|
#
|
8061
8144
|
# @!attribute [rw] continuation_token
|
8062
|
-
# If ContinuationToken was sent with the request, it is included in
|
8145
|
+
# If `ContinuationToken` was sent with the request, it is included in
|
8063
8146
|
# the response.
|
8064
8147
|
# @return [String]
|
8065
8148
|
#
|
@@ -8076,6 +8159,11 @@ module Aws::S3
|
|
8076
8159
|
# response.
|
8077
8160
|
# @return [String]
|
8078
8161
|
#
|
8162
|
+
# @!attribute [rw] request_charged
|
8163
|
+
# If present, indicates that the requester was successfully charged
|
8164
|
+
# for the request.
|
8165
|
+
# @return [String]
|
8166
|
+
#
|
8079
8167
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2Output AWS API Documentation
|
8080
8168
|
#
|
8081
8169
|
class ListObjectsV2Output < Struct.new(
|
@@ -8090,7 +8178,8 @@ module Aws::S3
|
|
8090
8178
|
:key_count,
|
8091
8179
|
:continuation_token,
|
8092
8180
|
:next_continuation_token,
|
8093
|
-
:start_after
|
8181
|
+
:start_after,
|
8182
|
+
:request_charged)
|
8094
8183
|
SENSITIVE = []
|
8095
8184
|
include Aws::Structure
|
8096
8185
|
end
|
@@ -8114,7 +8203,7 @@ module Aws::S3
|
|
8114
8203
|
# When you use this action with S3 on Outposts through the Amazon Web
|
8115
8204
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
8116
8205
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8117
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
8206
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
8118
8207
|
#
|
8119
8208
|
#
|
8120
8209
|
#
|
@@ -8123,7 +8212,7 @@ module Aws::S3
|
|
8123
8212
|
# @return [String]
|
8124
8213
|
#
|
8125
8214
|
# @!attribute [rw] delimiter
|
8126
|
-
# A delimiter is a character you use to group keys.
|
8215
|
+
# A delimiter is a character that you use to group keys.
|
8127
8216
|
# @return [String]
|
8128
8217
|
#
|
8129
8218
|
# @!attribute [rw] encoding_type
|
@@ -8132,9 +8221,9 @@ module Aws::S3
|
|
8132
8221
|
# @return [String]
|
8133
8222
|
#
|
8134
8223
|
# @!attribute [rw] max_keys
|
8135
|
-
# Sets the maximum number of keys returned in the response. By
|
8136
|
-
# the action returns up to 1,000 key names. The response
|
8137
|
-
# fewer keys but will never contain more.
|
8224
|
+
# Sets the maximum number of keys returned in the response. By
|
8225
|
+
# default, the action returns up to 1,000 key names. The response
|
8226
|
+
# might contain fewer keys but will never contain more.
|
8138
8227
|
# @return [Integer]
|
8139
8228
|
#
|
8140
8229
|
# @!attribute [rw] prefix
|
@@ -8142,15 +8231,15 @@ module Aws::S3
|
|
8142
8231
|
# @return [String]
|
8143
8232
|
#
|
8144
8233
|
# @!attribute [rw] continuation_token
|
8145
|
-
# ContinuationToken indicates Amazon S3 that the list is being
|
8146
|
-
# continued on this bucket with a token. ContinuationToken is
|
8234
|
+
# `ContinuationToken` indicates to Amazon S3 that the list is being
|
8235
|
+
# continued on this bucket with a token. `ContinuationToken` is
|
8147
8236
|
# obfuscated and is not a real key.
|
8148
8237
|
# @return [String]
|
8149
8238
|
#
|
8150
8239
|
# @!attribute [rw] fetch_owner
|
8151
|
-
# The owner field is not present in
|
8152
|
-
# return owner field with each key in the result then set
|
8153
|
-
#
|
8240
|
+
# The owner field is not present in `ListObjectsV2` by default. If you
|
8241
|
+
# want to return the owner field with each key in the result, then set
|
8242
|
+
# the `FetchOwner` field to `true`.
|
8154
8243
|
# @return [Boolean]
|
8155
8244
|
#
|
8156
8245
|
# @!attribute [rw] start_after
|
@@ -8171,6 +8260,11 @@ module Aws::S3
|
|
8171
8260
|
# `403 Forbidden` (access denied).
|
8172
8261
|
# @return [String]
|
8173
8262
|
#
|
8263
|
+
# @!attribute [rw] optional_object_attributes
|
8264
|
+
# Specifies the optional fields that you want returned in the
|
8265
|
+
# response. Fields that you do not specify are not returned.
|
8266
|
+
# @return [Array<String>]
|
8267
|
+
#
|
8174
8268
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2Request AWS API Documentation
|
8175
8269
|
#
|
8176
8270
|
class ListObjectsV2Request < Struct.new(
|
@@ -8183,7 +8277,8 @@ module Aws::S3
|
|
8183
8277
|
:fetch_owner,
|
8184
8278
|
:start_after,
|
8185
8279
|
:request_payer,
|
8186
|
-
:expected_bucket_owner
|
8280
|
+
:expected_bucket_owner,
|
8281
|
+
:optional_object_attributes)
|
8187
8282
|
SENSITIVE = []
|
8188
8283
|
include Aws::Structure
|
8189
8284
|
end
|
@@ -8234,7 +8329,7 @@ module Aws::S3
|
|
8234
8329
|
#
|
8235
8330
|
# @!attribute [rw] next_part_number_marker
|
8236
8331
|
# When a list is truncated, this element specifies the last part in
|
8237
|
-
# the list, as well as the value to use for the part-number-marker
|
8332
|
+
# the list, as well as the value to use for the `part-number-marker`
|
8238
8333
|
# request parameter in a subsequent request.
|
8239
8334
|
# @return [Integer]
|
8240
8335
|
#
|
@@ -8323,7 +8418,7 @@ module Aws::S3
|
|
8323
8418
|
# When you use this action with S3 on Outposts through the Amazon Web
|
8324
8419
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
8325
8420
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8326
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
8421
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
8327
8422
|
#
|
8328
8423
|
#
|
8329
8424
|
#
|
@@ -8467,11 +8562,11 @@ module Aws::S3
|
|
8467
8562
|
# A metadata key-value pair to store with an object.
|
8468
8563
|
#
|
8469
8564
|
# @!attribute [rw] name
|
8470
|
-
# Name of the
|
8565
|
+
# Name of the object.
|
8471
8566
|
# @return [String]
|
8472
8567
|
#
|
8473
8568
|
# @!attribute [rw] value
|
8474
|
-
# Value of the
|
8569
|
+
# Value of the object.
|
8475
8570
|
# @return [String]
|
8476
8571
|
#
|
8477
8572
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/MetadataEntry AWS API Documentation
|
@@ -8886,6 +8981,18 @@ module Aws::S3
|
|
8886
8981
|
# The owner of the object
|
8887
8982
|
# @return [Types::Owner]
|
8888
8983
|
#
|
8984
|
+
# @!attribute [rw] restore_status
|
8985
|
+
# Specifies the restoration status of an object. Objects in certain
|
8986
|
+
# storage classes must be restored before they can be retrieved. For
|
8987
|
+
# more information about these storage classes and how to work with
|
8988
|
+
# archived objects, see [ Working with archived objects][1] in the
|
8989
|
+
# *Amazon S3 User Guide*.
|
8990
|
+
#
|
8991
|
+
#
|
8992
|
+
#
|
8993
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html
|
8994
|
+
# @return [Types::RestoreStatus]
|
8995
|
+
#
|
8889
8996
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Object AWS API Documentation
|
8890
8997
|
#
|
8891
8998
|
class Object < Struct.new(
|
@@ -8895,7 +9002,8 @@ module Aws::S3
|
|
8895
9002
|
:checksum_algorithm,
|
8896
9003
|
:size,
|
8897
9004
|
:storage_class,
|
8898
|
-
:owner
|
9005
|
+
:owner,
|
9006
|
+
:restore_status)
|
8899
9007
|
SENSITIVE = []
|
8900
9008
|
include Aws::Structure
|
8901
9009
|
end
|
@@ -9130,6 +9238,18 @@ module Aws::S3
|
|
9130
9238
|
# Specifies the owner of the object.
|
9131
9239
|
# @return [Types::Owner]
|
9132
9240
|
#
|
9241
|
+
# @!attribute [rw] restore_status
|
9242
|
+
# Specifies the restoration status of an object. Objects in certain
|
9243
|
+
# storage classes must be restored before they can be retrieved. For
|
9244
|
+
# more information about these storage classes and how to work with
|
9245
|
+
# archived objects, see [ Working with archived objects][1] in the
|
9246
|
+
# *Amazon S3 User Guide*.
|
9247
|
+
#
|
9248
|
+
#
|
9249
|
+
#
|
9250
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html
|
9251
|
+
# @return [Types::RestoreStatus]
|
9252
|
+
#
|
9133
9253
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectVersion AWS API Documentation
|
9134
9254
|
#
|
9135
9255
|
class ObjectVersion < Struct.new(
|
@@ -9141,7 +9261,8 @@ module Aws::S3
|
|
9141
9261
|
:version_id,
|
9142
9262
|
:is_latest,
|
9143
9263
|
:last_modified,
|
9144
|
-
:owner
|
9264
|
+
:owner,
|
9265
|
+
:restore_status)
|
9145
9266
|
SENSITIVE = []
|
9146
9267
|
include Aws::Structure
|
9147
9268
|
end
|
@@ -10597,7 +10718,7 @@ module Aws::S3
|
|
10597
10718
|
# When you use this action with S3 on Outposts through the Amazon Web
|
10598
10719
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
10599
10720
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
10600
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
10721
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
10601
10722
|
#
|
10602
10723
|
#
|
10603
10724
|
#
|
@@ -10904,7 +11025,7 @@ module Aws::S3
|
|
10904
11025
|
#
|
10905
11026
|
# @!attribute [rw] server_side_encryption
|
10906
11027
|
# The server-side encryption algorithm used when storing this object
|
10907
|
-
# in Amazon S3 (for example, AES256
|
11028
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
10908
11029
|
# @return [String]
|
10909
11030
|
#
|
10910
11031
|
# @!attribute [rw] version_id
|
@@ -10925,10 +11046,10 @@ module Aws::S3
|
|
10925
11046
|
# @return [String]
|
10926
11047
|
#
|
10927
11048
|
# @!attribute [rw] ssekms_key_id
|
10928
|
-
# If `x-amz-server-side-encryption`
|
10929
|
-
# this header specifies the ID of the
|
10930
|
-
#
|
10931
|
-
#
|
11049
|
+
# If `x-amz-server-side-encryption` has a valid value of `aws:kms` or
|
11050
|
+
# `aws:kms:dsse`, this header specifies the ID of the Key Management
|
11051
|
+
# Service (KMS) symmetric encryption customer managed key that was
|
11052
|
+
# used for the object.
|
10932
11053
|
# @return [String]
|
10933
11054
|
#
|
10934
11055
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -10942,7 +11063,8 @@ module Aws::S3
|
|
10942
11063
|
#
|
10943
11064
|
# @!attribute [rw] bucket_key_enabled
|
10944
11065
|
# Indicates whether the uploaded object uses an S3 Bucket Key for
|
10945
|
-
# server-side encryption with
|
11066
|
+
# server-side encryption with Key Management Service (KMS) keys
|
11067
|
+
# (SSE-KMS).
|
10946
11068
|
# @return [Boolean]
|
10947
11069
|
#
|
10948
11070
|
# @!attribute [rw] request_charged
|
@@ -11005,7 +11127,7 @@ module Aws::S3
|
|
11005
11127
|
# When you use this action with S3 on Outposts through the Amazon Web
|
11006
11128
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
11007
11129
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
11008
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
11130
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
11009
11131
|
#
|
11010
11132
|
#
|
11011
11133
|
#
|
@@ -11194,7 +11316,7 @@ module Aws::S3
|
|
11194
11316
|
#
|
11195
11317
|
# @!attribute [rw] server_side_encryption
|
11196
11318
|
# The server-side encryption algorithm used when storing this object
|
11197
|
-
# in Amazon S3 (for example, AES256
|
11319
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
11198
11320
|
# @return [String]
|
11199
11321
|
#
|
11200
11322
|
# @!attribute [rw] storage_class
|
@@ -11258,15 +11380,16 @@ module Aws::S3
|
|
11258
11380
|
# @return [String]
|
11259
11381
|
#
|
11260
11382
|
# @!attribute [rw] ssekms_key_id
|
11261
|
-
# If `x-amz-server-side-encryption` has a valid value of `aws:kms
|
11262
|
-
# this header specifies the ID of the
|
11263
|
-
#
|
11264
|
-
#
|
11265
|
-
# `x-amz-server-side-encryption:aws:kms
|
11383
|
+
# If `x-amz-server-side-encryption` has a valid value of `aws:kms` or
|
11384
|
+
# `aws:kms:dsse`, this header specifies the ID of the Key Management
|
11385
|
+
# Service (KMS) symmetric encryption customer managed key that was
|
11386
|
+
# used for the object. If you specify
|
11387
|
+
# `x-amz-server-side-encryption:aws:kms` or
|
11388
|
+
# `x-amz-server-side-encryption:aws:kms:dsse`, but do not provide`
|
11266
11389
|
# x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the
|
11267
|
-
# Amazon Web Services managed key to protect the data. If
|
11268
|
-
# does not exist in the same account issuing the
|
11269
|
-
# the full ARN and not just the ID.
|
11390
|
+
# Amazon Web Services managed key (`aws/s3`) to protect the data. If
|
11391
|
+
# the KMS key does not exist in the same account that's issuing the
|
11392
|
+
# command, you must use the full ARN and not just the ID.
|
11270
11393
|
# @return [String]
|
11271
11394
|
#
|
11272
11395
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -11280,9 +11403,9 @@ module Aws::S3
|
|
11280
11403
|
#
|
11281
11404
|
# @!attribute [rw] bucket_key_enabled
|
11282
11405
|
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
11283
|
-
# encryption with server-side encryption using
|
11284
|
-
# Setting this header to `true` causes Amazon S3
|
11285
|
-
# Key for object encryption with SSE-KMS.
|
11406
|
+
# encryption with server-side encryption using Key Management Service
|
11407
|
+
# (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
|
11408
|
+
# to use an S3 Bucket Key for object encryption with SSE-KMS.
|
11286
11409
|
#
|
11287
11410
|
# Specifying this header with a PUT action doesn’t affect bucket-level
|
11288
11411
|
# settings for S3 Bucket Key.
|
@@ -11513,7 +11636,7 @@ module Aws::S3
|
|
11513
11636
|
# When you use this action with S3 on Outposts through the Amazon Web
|
11514
11637
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
11515
11638
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
11516
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
11639
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
11517
11640
|
#
|
11518
11641
|
#
|
11519
11642
|
#
|
@@ -12181,7 +12304,7 @@ module Aws::S3
|
|
12181
12304
|
# When you use this action with S3 on Outposts through the Amazon Web
|
12182
12305
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
12183
12306
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
12184
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
12307
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
12185
12308
|
#
|
12186
12309
|
#
|
12187
12310
|
#
|
@@ -12299,6 +12422,49 @@ module Aws::S3
|
|
12299
12422
|
include Aws::Structure
|
12300
12423
|
end
|
12301
12424
|
|
12425
|
+
# Specifies the restoration status of an object. Objects in certain
|
12426
|
+
# storage classes must be restored before they can be retrieved. For
|
12427
|
+
# more information about these storage classes and how to work with
|
12428
|
+
# archived objects, see [ Working with archived objects][1] in the
|
12429
|
+
# *Amazon S3 User Guide*.
|
12430
|
+
#
|
12431
|
+
#
|
12432
|
+
#
|
12433
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html
|
12434
|
+
#
|
12435
|
+
# @!attribute [rw] is_restore_in_progress
|
12436
|
+
# Specifies whether the object is currently being restored. If the
|
12437
|
+
# object restoration is in progress, the header returns the value
|
12438
|
+
# `TRUE`. For example:
|
12439
|
+
#
|
12440
|
+
# `x-amz-optional-object-attributes: IsRestoreInProgress="true"`
|
12441
|
+
#
|
12442
|
+
# If the object restoration has completed, the header returns the
|
12443
|
+
# value `FALSE`. For example:
|
12444
|
+
#
|
12445
|
+
# `x-amz-optional-object-attributes: IsRestoreInProgress="false",
|
12446
|
+
# RestoreExpiryDate="2012-12-21T00:00:00.000Z"`
|
12447
|
+
#
|
12448
|
+
# If the object hasn't been restored, there is no header response.
|
12449
|
+
# @return [Boolean]
|
12450
|
+
#
|
12451
|
+
# @!attribute [rw] restore_expiry_date
|
12452
|
+
# Indicates when the restored copy will expire. This value is
|
12453
|
+
# populated only if the object has already been restored. For example:
|
12454
|
+
#
|
12455
|
+
# `x-amz-optional-object-attributes: IsRestoreInProgress="false",
|
12456
|
+
# RestoreExpiryDate="2012-12-21T00:00:00.000Z"`
|
12457
|
+
# @return [Time]
|
12458
|
+
#
|
12459
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreStatus AWS API Documentation
|
12460
|
+
#
|
12461
|
+
class RestoreStatus < Struct.new(
|
12462
|
+
:is_restore_in_progress,
|
12463
|
+
:restore_expiry_date)
|
12464
|
+
SENSITIVE = []
|
12465
|
+
include Aws::Structure
|
12466
|
+
end
|
12467
|
+
|
12302
12468
|
# Specifies the redirect behavior and when a redirect is applied. For
|
12303
12469
|
# more information about routing rules, see [Configuring advanced
|
12304
12470
|
# conditional redirects][1] in the *Amazon S3 User Guide*.
|
@@ -12495,9 +12661,9 @@ module Aws::S3
|
|
12495
12661
|
# Specifies the use of SSE-KMS to encrypt delivered inventory reports.
|
12496
12662
|
#
|
12497
12663
|
# @!attribute [rw] key_id
|
12498
|
-
# Specifies the ID of the
|
12499
|
-
#
|
12500
|
-
#
|
12664
|
+
# Specifies the ID of the Key Management Service (KMS) symmetric
|
12665
|
+
# encryption customer managed key to use for encrypting inventory
|
12666
|
+
# reports.
|
12501
12667
|
# @return [String]
|
12502
12668
|
#
|
12503
12669
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SSEKMS AWS API Documentation
|
@@ -13171,7 +13337,7 @@ module Aws::S3
|
|
13171
13337
|
#
|
13172
13338
|
# @!attribute [rw] server_side_encryption
|
13173
13339
|
# The server-side encryption algorithm used when storing this object
|
13174
|
-
# in Amazon S3 (for example, AES256
|
13340
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
13175
13341
|
# @return [String]
|
13176
13342
|
#
|
13177
13343
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -13188,14 +13354,15 @@ module Aws::S3
|
|
13188
13354
|
# @return [String]
|
13189
13355
|
#
|
13190
13356
|
# @!attribute [rw] ssekms_key_id
|
13191
|
-
# If present, specifies the ID of the
|
13192
|
-
#
|
13193
|
-
#
|
13357
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
13358
|
+
# symmetric encryption customer managed key that was used for the
|
13359
|
+
# object.
|
13194
13360
|
# @return [String]
|
13195
13361
|
#
|
13196
13362
|
# @!attribute [rw] bucket_key_enabled
|
13197
13363
|
# Indicates whether the multipart upload uses an S3 Bucket Key for
|
13198
|
-
# server-side encryption with
|
13364
|
+
# server-side encryption with Key Management Service (KMS) keys
|
13365
|
+
# (SSE-KMS).
|
13199
13366
|
# @return [Boolean]
|
13200
13367
|
#
|
13201
13368
|
# @!attribute [rw] request_charged
|
@@ -13237,7 +13404,7 @@ module Aws::S3
|
|
13237
13404
|
# When you use this action with S3 on Outposts through the Amazon Web
|
13238
13405
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
13239
13406
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
13240
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
13407
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
13241
13408
|
#
|
13242
13409
|
#
|
13243
13410
|
#
|
@@ -13424,7 +13591,7 @@ module Aws::S3
|
|
13424
13591
|
|
13425
13592
|
# @!attribute [rw] server_side_encryption
|
13426
13593
|
# The server-side encryption algorithm used when storing this object
|
13427
|
-
# in Amazon S3 (for example, AES256
|
13594
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
13428
13595
|
# @return [String]
|
13429
13596
|
#
|
13430
13597
|
# @!attribute [rw] etag
|
@@ -13497,14 +13664,14 @@ module Aws::S3
|
|
13497
13664
|
# @return [String]
|
13498
13665
|
#
|
13499
13666
|
# @!attribute [rw] ssekms_key_id
|
13500
|
-
# If present, specifies the ID of the
|
13501
|
-
#
|
13502
|
-
# customer managed key was used for the object.
|
13667
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
13668
|
+
# symmetric encryption customer managed key was used for the object.
|
13503
13669
|
# @return [String]
|
13504
13670
|
#
|
13505
13671
|
# @!attribute [rw] bucket_key_enabled
|
13506
13672
|
# Indicates whether the multipart upload uses an S3 Bucket Key for
|
13507
|
-
# server-side encryption with
|
13673
|
+
# server-side encryption with Key Management Service (KMS) keys
|
13674
|
+
# (SSE-KMS).
|
13508
13675
|
# @return [Boolean]
|
13509
13676
|
#
|
13510
13677
|
# @!attribute [rw] request_charged
|
@@ -13553,7 +13720,7 @@ module Aws::S3
|
|
13553
13720
|
# When you use this action with S3 on Outposts through the Amazon Web
|
13554
13721
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
13555
13722
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
13556
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
13723
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
13557
13724
|
#
|
13558
13725
|
#
|
13559
13726
|
#
|