aws-sdk-s3 1.92.0 → 1.93.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -73,7 +73,7 @@ module Aws::S3
73
73
  # If an archive copy is already restored, the header value indicates
74
74
  # when Amazon S3 is scheduled to delete the object copy. For example:
75
75
  #
76
- # `x-amz-restore: ongoing-request="false", expiry-date="Fri, 23 Dec 2012
76
+ # `x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012
77
77
  # 00:00:00 GMT"`
78
78
  #
79
79
  # If the object restoration is in progress, the header returns the value
@@ -1448,6 +1448,92 @@ module Aws::S3
1448
1448
  resp.data
1449
1449
  end
1450
1450
 
1451
+ # @example Request syntax with placeholder values
1452
+ #
1453
+ # object.head({
1454
+ # if_match: "IfMatch",
1455
+ # if_modified_since: Time.now,
1456
+ # if_none_match: "IfNoneMatch",
1457
+ # if_unmodified_since: Time.now,
1458
+ # range: "Range",
1459
+ # version_id: "ObjectVersionId",
1460
+ # sse_customer_algorithm: "SSECustomerAlgorithm",
1461
+ # sse_customer_key: "SSECustomerKey",
1462
+ # sse_customer_key_md5: "SSECustomerKeyMD5",
1463
+ # request_payer: "requester", # accepts requester
1464
+ # part_number: 1,
1465
+ # expected_bucket_owner: "AccountId",
1466
+ # })
1467
+ # @param [Hash] options ({})
1468
+ # @option options [String] :if_match
1469
+ # Return the object only if its entity tag (ETag) is the same as the one
1470
+ # specified, otherwise return a 412 (precondition failed).
1471
+ # @option options [Time,DateTime,Date,Integer,String] :if_modified_since
1472
+ # Return the object only if it has been modified since the specified
1473
+ # time, otherwise return a 304 (not modified).
1474
+ # @option options [String] :if_none_match
1475
+ # Return the object only if its entity tag (ETag) is different from the
1476
+ # one specified, otherwise return a 304 (not modified).
1477
+ # @option options [Time,DateTime,Date,Integer,String] :if_unmodified_since
1478
+ # Return the object only if it has not been modified since the specified
1479
+ # time, otherwise return a 412 (precondition failed).
1480
+ # @option options [String] :range
1481
+ # Downloads the specified range bytes of an object. For more information
1482
+ # about the HTTP Range header, see
1483
+ # [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35][1].
1484
+ #
1485
+ # <note markdown="1"> Amazon S3 doesn't support retrieving multiple ranges of data per
1486
+ # `GET` request.
1487
+ #
1488
+ # </note>
1489
+ #
1490
+ #
1491
+ #
1492
+ # [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
1493
+ # @option options [String] :version_id
1494
+ # VersionId used to reference a specific version of the object.
1495
+ # @option options [String] :sse_customer_algorithm
1496
+ # Specifies the algorithm to use to when encrypting the object (for
1497
+ # example, AES256).
1498
+ # @option options [String] :sse_customer_key
1499
+ # Specifies the customer-provided encryption key for Amazon S3 to use in
1500
+ # encrypting data. This value is used to store the object and then it is
1501
+ # discarded; Amazon S3 does not store the encryption key. The key must
1502
+ # be appropriate for use with the algorithm specified in the
1503
+ # `x-amz-server-side-encryption-customer-algorithm` header.
1504
+ # @option options [String] :sse_customer_key_md5
1505
+ # Specifies the 128-bit MD5 digest of the encryption key according to
1506
+ # RFC 1321. Amazon S3 uses this header for a message integrity check to
1507
+ # ensure that the encryption key was transmitted without error.
1508
+ # @option options [String] :request_payer
1509
+ # Confirms that the requester knows that they will be charged for the
1510
+ # request. Bucket owners need not specify this parameter in their
1511
+ # requests. For information about downloading objects from requester
1512
+ # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
1513
+ # in the *Amazon S3 Developer Guide*.
1514
+ #
1515
+ #
1516
+ #
1517
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
1518
+ # @option options [Integer] :part_number
1519
+ # Part number of the object being read. This is a positive integer
1520
+ # between 1 and 10,000. Effectively performs a 'ranged' HEAD request
1521
+ # for the part specified. Useful querying about the size of the part and
1522
+ # the number of parts in this object.
1523
+ # @option options [String] :expected_bucket_owner
1524
+ # The account ID of the expected bucket owner. If the bucket is owned by
1525
+ # a different account, the request will fail with an HTTP `403 (Access
1526
+ # Denied)` error.
1527
+ # @return [Types::HeadObjectOutput]
1528
+ def head(options = {})
1529
+ options = options.merge(
1530
+ bucket: @bucket_name,
1531
+ key: @key
1532
+ )
1533
+ resp = @client.head_object(options)
1534
+ resp.data
1535
+ end
1536
+
1451
1537
  # @!group Associations
1452
1538
 
1453
1539
  # @return [ObjectAcl]
@@ -14,7 +14,7 @@ module Aws::S3
14
14
  # upload that Amazon S3 will wait before permanently removing all parts
15
15
  # of the upload. For more information, see [ Aborting Incomplete
16
16
  # Multipart Uploads Using a Bucket Lifecycle Policy][1] in the *Amazon
17
- # Simple Storage Service Developer Guide*.
17
+ # S3 User Guide*.
18
18
  #
19
19
  #
20
20
  #
@@ -74,7 +74,7 @@ module Aws::S3
74
74
  # When using this action with an access point through the AWS SDKs,
75
75
  # you provide the access point ARN in place of the bucket name. For
76
76
  # more information about access point ARNs, see [Using Access
77
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
77
+ # Points][1] in the *Amazon S3 User Guide*.
78
78
  #
79
79
  # When using this action with Amazon S3 on Outposts, you must direct
80
80
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -83,7 +83,7 @@ module Aws::S3
83
83
  # When using this action using S3 on Outposts through the AWS SDKs,
84
84
  # you provide the Outposts bucket ARN in place of the bucket name. For
85
85
  # more information about S3 on Outposts ARNs, see [Using S3 on
86
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
86
+ # Outposts][2] in the *Amazon S3 User Guide*.
87
87
  #
88
88
  #
89
89
  #
@@ -131,7 +131,7 @@ module Aws::S3
131
131
 
132
132
  # Configures the transfer acceleration state for an Amazon S3 bucket.
133
133
  # For more information, see [Amazon S3 Transfer Acceleration][1] in the
134
- # *Amazon Simple Storage Service Developer Guide*.
134
+ # *Amazon S3 User Guide*.
135
135
  #
136
136
  #
137
137
  #
@@ -492,7 +492,7 @@ module Aws::S3
492
492
 
493
493
  # Specifies the lifecycle configuration for objects in an Amazon S3
494
494
  # bucket. For more information, see [Object Lifecycle Management][1] in
495
- # the *Amazon Simple Storage Service Developer Guide*.
495
+ # the *Amazon S3 User Guide*.
496
496
  #
497
497
  #
498
498
  #
@@ -608,8 +608,7 @@ module Aws::S3
608
608
 
609
609
  # Describes the cross-origin access configuration for objects in an
610
610
  # Amazon S3 bucket. For more information, see [Enabling Cross-Origin
611
- # Resource Sharing][1] in the *Amazon Simple Storage Service Developer
612
- # Guide*.
611
+ # Resource Sharing][1] in the *Amazon S3 User Guide*.
613
612
  #
614
613
  #
615
614
  #
@@ -926,7 +925,7 @@ module Aws::S3
926
925
  # When using this action with an access point through the AWS SDKs,
927
926
  # you provide the access point ARN in place of the bucket name. For
928
927
  # more information about access point ARNs, see [Using Access
929
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
928
+ # Points][1] in the *Amazon S3 User Guide*.
930
929
  #
931
930
  # When using this action with Amazon S3 on Outposts, you must direct
932
931
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -935,7 +934,7 @@ module Aws::S3
935
934
  # When using this action using S3 on Outposts through the AWS SDKs,
936
935
  # you provide the Outposts bucket ARN in place of the bucket name. For
937
936
  # more information about S3 on Outposts ARNs, see [Using S3 on
938
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
937
+ # Outposts][2] in the *Amazon S3 User Guide*.
939
938
  #
940
939
  #
941
940
  #
@@ -1328,7 +1327,7 @@ module Aws::S3
1328
1327
  # When using this action with an access point through the AWS SDKs,
1329
1328
  # you provide the access point ARN in place of the bucket name. For
1330
1329
  # more information about access point ARNs, see [Using Access
1331
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
1330
+ # Points][1] in the *Amazon S3 User Guide*.
1332
1331
  #
1333
1332
  # When using this action with Amazon S3 on Outposts, you must direct
1334
1333
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -1337,7 +1336,7 @@ module Aws::S3
1337
1336
  # When using this action using S3 on Outposts through the AWS SDKs,
1338
1337
  # you provide the Outposts bucket ARN in place of the bucket name. For
1339
1338
  # more information about S3 on Outposts ARNs, see [Using S3 on
1340
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
1339
+ # Outposts][2] in the *Amazon S3 User Guide*.
1341
1340
  #
1342
1341
  #
1343
1342
  #
@@ -1845,7 +1844,7 @@ module Aws::S3
1845
1844
  # When using this action with an access point through the AWS SDKs,
1846
1845
  # you provide the access point ARN in place of the bucket name. For
1847
1846
  # more information about access point ARNs, see [Using Access
1848
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
1847
+ # Points][1] in the *Amazon S3 User Guide*.
1849
1848
  #
1850
1849
  # When using this action with Amazon S3 on Outposts, you must direct
1851
1850
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -1854,7 +1853,7 @@ module Aws::S3
1854
1853
  # When using this action using S3 on Outposts through the AWS SDKs,
1855
1854
  # you provide the Outposts bucket ARN in place of the bucket name. For
1856
1855
  # more information about S3 on Outposts ARNs, see [Using S3 on
1857
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
1856
+ # Outposts][2] in the *Amazon S3 User Guide*.
1858
1857
  #
1859
1858
  #
1860
1859
  #
@@ -1983,7 +1982,7 @@ module Aws::S3
1983
1982
  # When using this action with an access point through the AWS SDKs,
1984
1983
  # you provide the access point ARN in place of the bucket name. For
1985
1984
  # more information about access point ARNs, see [Using Access
1986
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
1985
+ # Points][1] in the *Amazon S3 User Guide*.
1987
1986
  #
1988
1987
  # When using this action with Amazon S3 on Outposts, you must direct
1989
1988
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -1992,7 +1991,7 @@ module Aws::S3
1992
1991
  # When using this action using S3 on Outposts through the AWS SDKs,
1993
1992
  # you provide the Outposts bucket ARN in place of the bucket name. For
1994
1993
  # more information about S3 on Outposts ARNs, see [Using S3 on
1995
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
1994
+ # Outposts][2] in the *Amazon S3 User Guide*.
1996
1995
  #
1997
1996
  #
1998
1997
  #
@@ -2209,6 +2208,14 @@ module Aws::S3
2209
2208
  # The container element for specifying the default Object Lock retention
2210
2209
  # settings for new objects placed in the specified bucket.
2211
2210
  #
2211
+ # <note markdown="1"> * The `DefaultRetention` settings require both a mode and a period.
2212
+ #
2213
+ # * The `DefaultRetention` period can be either `Days` or `Years` but
2214
+ # you must select one. You cannot specify `Days` and `Years` at the
2215
+ # same time.
2216
+ #
2217
+ # </note>
2218
+ #
2212
2219
  # @note When making an API call, you may pass DefaultRetention
2213
2220
  # data as a hash:
2214
2221
  #
@@ -2220,17 +2227,18 @@ module Aws::S3
2220
2227
  #
2221
2228
  # @!attribute [rw] mode
2222
2229
  # The default Object Lock retention mode you want to apply to new
2223
- # objects placed in the specified bucket.
2230
+ # objects placed in the specified bucket. Must be used with either
2231
+ # `Days` or `Years`.
2224
2232
  # @return [String]
2225
2233
  #
2226
2234
  # @!attribute [rw] days
2227
2235
  # The number of days that you want to specify for the default
2228
- # retention period.
2236
+ # retention period. Must be used with `Mode`.
2229
2237
  # @return [Integer]
2230
2238
  #
2231
2239
  # @!attribute [rw] years
2232
2240
  # The number of years that you want to specify for the default
2233
- # retention period.
2241
+ # retention period. Must be used with `Mode`.
2234
2242
  # @return [Integer]
2235
2243
  #
2236
2244
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DefaultRetention AWS API Documentation
@@ -2778,7 +2786,7 @@ module Aws::S3
2778
2786
  # When using this action with an access point through the AWS SDKs,
2779
2787
  # you provide the access point ARN in place of the bucket name. For
2780
2788
  # more information about access point ARNs, see [Using Access
2781
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
2789
+ # Points][1] in the *Amazon S3 User Guide*.
2782
2790
  #
2783
2791
  # When using this action with Amazon S3 on Outposts, you must direct
2784
2792
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -2787,7 +2795,7 @@ module Aws::S3
2787
2795
  # When using this action using S3 on Outposts through the AWS SDKs,
2788
2796
  # you provide the Outposts bucket ARN in place of the bucket name. For
2789
2797
  # more information about S3 on Outposts ARNs, see [Using S3 on
2790
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
2798
+ # Outposts][2] in the *Amazon S3 User Guide*.
2791
2799
  #
2792
2800
  #
2793
2801
  #
@@ -2880,7 +2888,7 @@ module Aws::S3
2880
2888
  # When using this action with an access point through the AWS SDKs,
2881
2889
  # you provide the access point ARN in place of the bucket name. For
2882
2890
  # more information about access point ARNs, see [Using Access
2883
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
2891
+ # Points][1] in the *Amazon S3 User Guide*.
2884
2892
  #
2885
2893
  # When using this action with Amazon S3 on Outposts, you must direct
2886
2894
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -2889,7 +2897,7 @@ module Aws::S3
2889
2897
  # When using this action using S3 on Outposts through the AWS SDKs,
2890
2898
  # you provide the Outposts bucket ARN in place of the bucket name. For
2891
2899
  # more information about S3 on Outposts ARNs, see [Using S3 on
2892
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
2900
+ # Outposts][2] in the *Amazon S3 User Guide*.
2893
2901
  #
2894
2902
  #
2895
2903
  #
@@ -2978,7 +2986,7 @@ module Aws::S3
2978
2986
  # When using this action with an access point through the AWS SDKs,
2979
2987
  # you provide the access point ARN in place of the bucket name. For
2980
2988
  # more information about access point ARNs, see [Using Access
2981
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
2989
+ # Points][1] in the *Amazon S3 User Guide*.
2982
2990
  #
2983
2991
  # When using this action with Amazon S3 on Outposts, you must direct
2984
2992
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -2987,7 +2995,7 @@ module Aws::S3
2987
2995
  # When using this action using S3 on Outposts through the AWS SDKs,
2988
2996
  # you provide the Outposts bucket ARN in place of the bucket name. For
2989
2997
  # more information about S3 on Outposts ARNs, see [Using S3 on
2990
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
2998
+ # Outposts][2] in the *Amazon S3 User Guide*.
2991
2999
  #
2992
3000
  #
2993
3001
  #
@@ -4198,7 +4206,7 @@ module Aws::S3
4198
4206
  # to which the filtering rule applies. The maximum length is 1,024
4199
4207
  # characters. Overlapping prefixes and suffixes are not supported. For
4200
4208
  # more information, see [Configuring Event Notifications][1] in the
4201
- # *Amazon Simple Storage Service Developer Guide*.
4209
+ # *Amazon S3 User Guide*.
4202
4210
  #
4203
4211
  #
4204
4212
  #
@@ -5145,7 +5153,7 @@ module Aws::S3
5145
5153
  # When using this action with an access point through the AWS SDKs,
5146
5154
  # you provide the access point ARN in place of the bucket name. For
5147
5155
  # more information about access point ARNs, see [Using Access
5148
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
5156
+ # Points][1] in the *Amazon S3 User Guide*.
5149
5157
  #
5150
5158
  #
5151
5159
  #
@@ -5224,7 +5232,7 @@ module Aws::S3
5224
5232
  # When using this action with an access point through the AWS SDKs,
5225
5233
  # you provide the access point ARN in place of the bucket name. For
5226
5234
  # more information about access point ARNs, see [Using Access
5227
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
5235
+ # Points][1] in the *Amazon S3 User Guide*.
5228
5236
  #
5229
5237
  #
5230
5238
  #
@@ -5301,7 +5309,7 @@ module Aws::S3
5301
5309
  # When using this action with an access point through the AWS SDKs,
5302
5310
  # you provide the access point ARN in place of the bucket name. For
5303
5311
  # more information about access point ARNs, see [Using Access
5304
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
5312
+ # Points][1] in the *Amazon S3 User Guide*.
5305
5313
  #
5306
5314
  #
5307
5315
  #
@@ -5561,7 +5569,7 @@ module Aws::S3
5561
5569
  # When using this action with an access point through the AWS SDKs,
5562
5570
  # you provide the access point ARN in place of the bucket name. For
5563
5571
  # more information about access point ARNs, see [Using Access
5564
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
5572
+ # Points][1] in the *Amazon S3 User Guide*.
5565
5573
  #
5566
5574
  # When using this action with Amazon S3 on Outposts, you must direct
5567
5575
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -5570,7 +5578,7 @@ module Aws::S3
5570
5578
  # When using this action using S3 on Outposts through the AWS SDKs,
5571
5579
  # you provide the Outposts bucket ARN in place of the bucket name. For
5572
5580
  # more information about S3 on Outposts ARNs, see [Using S3 on
5573
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
5581
+ # Outposts][2] in the *Amazon S3 User Guide*.
5574
5582
  #
5575
5583
  #
5576
5584
  #
@@ -5750,7 +5758,7 @@ module Aws::S3
5750
5758
  # When using this action with an access point through the AWS SDKs,
5751
5759
  # you provide the access point ARN in place of the bucket name. For
5752
5760
  # more information about access point ARNs, see [Using Access
5753
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
5761
+ # Points][1] in the *Amazon S3 User Guide*.
5754
5762
  #
5755
5763
  #
5756
5764
  #
@@ -5837,7 +5845,7 @@ module Aws::S3
5837
5845
  # When using this action with an access point through the AWS SDKs,
5838
5846
  # you provide the access point ARN in place of the bucket name. For
5839
5847
  # more information about access point ARNs, see [Using Access
5840
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
5848
+ # Points][1] in the *Amazon S3 User Guide*.
5841
5849
  #
5842
5850
  # When using this action with Amazon S3 on Outposts, you must direct
5843
5851
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -5846,7 +5854,7 @@ module Aws::S3
5846
5854
  # When using this action using S3 on Outposts through the AWS SDKs,
5847
5855
  # you provide the Outposts bucket ARN in place of the bucket name. For
5848
5856
  # more information about S3 on Outposts ARNs, see [Using S3 on
5849
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
5857
+ # Outposts][2] in the *Amazon S3 User Guide*.
5850
5858
  #
5851
5859
  #
5852
5860
  #
@@ -6145,7 +6153,7 @@ module Aws::S3
6145
6153
  # When using this action with an access point through the AWS SDKs,
6146
6154
  # you provide the access point ARN in place of the bucket name. For
6147
6155
  # more information about access point ARNs, see [Using Access
6148
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
6156
+ # Points][1] in the *Amazon S3 User Guide*.
6149
6157
  #
6150
6158
  # When using this action with Amazon S3 on Outposts, you must direct
6151
6159
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -6154,7 +6162,7 @@ module Aws::S3
6154
6162
  # When using this action using S3 on Outposts through the AWS SDKs,
6155
6163
  # you provide the Outposts bucket ARN in place of the bucket name. For
6156
6164
  # more information about S3 on Outposts ARNs, see [Using S3 on
6157
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
6165
+ # Outposts][2] in the *Amazon S3 User Guide*.
6158
6166
  #
6159
6167
  #
6160
6168
  #
@@ -6203,7 +6211,7 @@ module Aws::S3
6203
6211
  # If an archive copy is already restored, the header value indicates
6204
6212
  # when Amazon S3 is scheduled to delete the object copy. For example:
6205
6213
  #
6206
- # `x-amz-restore: ongoing-request="false", expiry-date="Fri, 23 Dec
6214
+ # `x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec
6207
6215
  # 2012 00:00:00 GMT"`
6208
6216
  #
6209
6217
  # If the object restoration is in progress, the header returns the
@@ -6481,7 +6489,7 @@ module Aws::S3
6481
6489
  # When using this action with an access point through the AWS SDKs,
6482
6490
  # you provide the access point ARN in place of the bucket name. For
6483
6491
  # more information about access point ARNs, see [Using Access
6484
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
6492
+ # Points][1] in the *Amazon S3 User Guide*.
6485
6493
  #
6486
6494
  # When using this action with Amazon S3 on Outposts, you must direct
6487
6495
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -6490,7 +6498,7 @@ module Aws::S3
6490
6498
  # When using this action using S3 on Outposts through the AWS SDKs,
6491
6499
  # you provide the Outposts bucket ARN in place of the bucket name. For
6492
6500
  # more information about S3 on Outposts ARNs, see [Using S3 on
6493
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
6501
+ # Outposts][2] in the *Amazon S3 User Guide*.
6494
6502
  #
6495
6503
  #
6496
6504
  #
@@ -7227,7 +7235,7 @@ module Aws::S3
7227
7235
  # @!attribute [rw] events
7228
7236
  # The Amazon S3 bucket event for which to invoke the AWS Lambda
7229
7237
  # function. For more information, see [Supported Event Types][1] in
7230
- # the *Amazon Simple Storage Service Developer Guide*.
7238
+ # the *Amazon S3 User Guide*.
7231
7239
  #
7232
7240
  #
7233
7241
  #
@@ -7237,7 +7245,7 @@ module Aws::S3
7237
7245
  # @!attribute [rw] filter
7238
7246
  # Specifies object key name filtering rules. For information about key
7239
7247
  # name filtering, see [Configuring Event Notifications][1] in the
7240
- # *Amazon Simple Storage Service Developer Guide*.
7248
+ # *Amazon S3 User Guide*.
7241
7249
  #
7242
7250
  #
7243
7251
  #
@@ -7403,7 +7411,7 @@ module Aws::S3
7403
7411
  #
7404
7412
  # @!attribute [rw] prefix
7405
7413
  # Prefix identifying one or more objects to which the rule applies.
7406
- # This is No longer used; use `Filter` instead.
7414
+ # This is no longer used; use `Filter` instead.
7407
7415
  #
7408
7416
  # Replacement must be made for object keys containing special
7409
7417
  # characters (such as carriage returns) when using XML requests. For
@@ -7417,7 +7425,8 @@ module Aws::S3
7417
7425
  # @!attribute [rw] filter
7418
7426
  # The `Filter` is used to identify objects that a Lifecycle Rule
7419
7427
  # applies to. A `Filter` must have exactly one of `Prefix`, `Tag`, or
7420
- # `And` specified.
7428
+ # `And` specified. `Filter` is required if the `LifecycleRule` does
7429
+ # not containt a `Prefix` element.
7421
7430
  # @return [Types::LifecycleRuleFilter]
7422
7431
  #
7423
7432
  # @!attribute [rw] status
@@ -7453,7 +7462,7 @@ module Aws::S3
7453
7462
  # upload that Amazon S3 will wait before permanently removing all
7454
7463
  # parts of the upload. For more information, see [ Aborting Incomplete
7455
7464
  # Multipart Uploads Using a Bucket Lifecycle Policy][1] in the *Amazon
7456
- # Simple Storage Service Developer Guide*.
7465
+ # S3 User Guide*.
7457
7466
  #
7458
7467
  #
7459
7468
  #
@@ -7972,7 +7981,7 @@ module Aws::S3
7972
7981
  # When using this action with an access point through the AWS SDKs,
7973
7982
  # you provide the access point ARN in place of the bucket name. For
7974
7983
  # more information about access point ARNs, see [Using Access
7975
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
7984
+ # Points][1] in the *Amazon S3 User Guide*.
7976
7985
  #
7977
7986
  # When using this action with Amazon S3 on Outposts, you must direct
7978
7987
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -7981,7 +7990,7 @@ module Aws::S3
7981
7990
  # When using this action using S3 on Outposts through the AWS SDKs,
7982
7991
  # you provide the Outposts bucket ARN in place of the bucket name. For
7983
7992
  # more information about S3 on Outposts ARNs, see [Using S3 on
7984
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
7993
+ # Outposts][2] in the *Amazon S3 User Guide*.
7985
7994
  #
7986
7995
  #
7987
7996
  #
@@ -8357,7 +8366,7 @@ module Aws::S3
8357
8366
  # When using this action with an access point through the AWS SDKs,
8358
8367
  # you provide the access point ARN in place of the bucket name. For
8359
8368
  # more information about access point ARNs, see [Using Access
8360
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
8369
+ # Points][1] in the *Amazon S3 User Guide*.
8361
8370
  #
8362
8371
  # When using this action with Amazon S3 on Outposts, you must direct
8363
8372
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -8366,7 +8375,7 @@ module Aws::S3
8366
8375
  # When using this action using S3 on Outposts through the AWS SDKs,
8367
8376
  # you provide the Outposts bucket ARN in place of the bucket name. For
8368
8377
  # more information about S3 on Outposts ARNs, see [Using S3 on
8369
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
8378
+ # Outposts][2] in the *Amazon S3 User Guide*.
8370
8379
  #
8371
8380
  #
8372
8381
  #
@@ -8448,7 +8457,7 @@ module Aws::S3
8448
8457
  # When using this action with an access point through the AWS SDKs,
8449
8458
  # you provide the access point ARN in place of the bucket name. For
8450
8459
  # more information about access point ARNs, see [Using Access
8451
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
8460
+ # Points][1] in the *Amazon S3 User Guide*.
8452
8461
  #
8453
8462
  # When using this action with Amazon S3 on Outposts, you must direct
8454
8463
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -8457,7 +8466,7 @@ module Aws::S3
8457
8466
  # When using this action using S3 on Outposts through the AWS SDKs,
8458
8467
  # you provide the Outposts bucket ARN in place of the bucket name. For
8459
8468
  # more information about S3 on Outposts ARNs, see [Using S3 on
8460
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
8469
+ # Outposts][2] in the *Amazon S3 User Guide*.
8461
8470
  #
8462
8471
  #
8463
8472
  #
@@ -8583,7 +8592,7 @@ module Aws::S3
8583
8592
  # When using this action with an access point through the AWS SDKs,
8584
8593
  # you provide the access point ARN in place of the bucket name. For
8585
8594
  # more information about access point ARNs, see [Using Access
8586
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
8595
+ # Points][1] in the *Amazon S3 User Guide*.
8587
8596
  #
8588
8597
  # When using this action with Amazon S3 on Outposts, you must direct
8589
8598
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -8592,7 +8601,7 @@ module Aws::S3
8592
8601
  # When using this action using S3 on Outposts through the AWS SDKs,
8593
8602
  # you provide the Outposts bucket ARN in place of the bucket name. For
8594
8603
  # more information about S3 on Outposts ARNs, see [Using S3 on
8595
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
8604
+ # Outposts][2] in the *Amazon S3 User Guide*.
8596
8605
  #
8597
8606
  #
8598
8607
  #
@@ -8798,7 +8807,7 @@ module Aws::S3
8798
8807
  # When using this action with an access point through the AWS SDKs,
8799
8808
  # you provide the access point ARN in place of the bucket name. For
8800
8809
  # more information about access point ARNs, see [Using Access
8801
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
8810
+ # Points][1] in the *Amazon S3 User Guide*.
8802
8811
  #
8803
8812
  # When using this action with Amazon S3 on Outposts, you must direct
8804
8813
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -8807,7 +8816,7 @@ module Aws::S3
8807
8816
  # When using this action using S3 on Outposts through the AWS SDKs,
8808
8817
  # you provide the Outposts bucket ARN in place of the bucket name. For
8809
8818
  # more information about S3 on Outposts ARNs, see [Using S3 on
8810
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
8819
+ # Outposts][2] in the *Amazon S3 User Guide*.
8811
8820
  #
8812
8821
  #
8813
8822
  #
@@ -9232,8 +9241,7 @@ module Aws::S3
9232
9241
  # Specifies the number of days an object is noncurrent before Amazon
9233
9242
  # S3 can perform the associated action. For information about the
9234
9243
  # noncurrent days calculations, see [How Amazon S3 Calculates How Long
9235
- # an Object Has Been Noncurrent][1] in the *Amazon Simple Storage
9236
- # Service Developer Guide*.
9244
+ # an Object Has Been Noncurrent][1] in the *Amazon S3 User Guide*.
9237
9245
  #
9238
9246
  #
9239
9247
  #
@@ -9393,7 +9401,7 @@ module Aws::S3
9393
9401
 
9394
9402
  # Specifies object key name filtering rules. For information about key
9395
9403
  # name filtering, see [Configuring Event Notifications][1] in the
9396
- # *Amazon Simple Storage Service Developer Guide*.
9404
+ # *Amazon S3 User Guide*.
9397
9405
  #
9398
9406
  #
9399
9407
  #
@@ -9542,11 +9550,16 @@ module Aws::S3
9542
9550
  #
9543
9551
  # @!attribute [rw] object_lock_enabled
9544
9552
  # Indicates whether this bucket has an Object Lock configuration
9545
- # enabled.
9553
+ # enabled. Enable `ObjectLockEnabled` when you apply
9554
+ # `ObjectLockConfiguration` to a bucket.
9546
9555
  # @return [String]
9547
9556
  #
9548
9557
  # @!attribute [rw] rule
9549
- # The Object Lock rule in place for the specified object.
9558
+ # Specifies the Object Lock rule for the specified object. Enable the
9559
+ # this rule when you apply `ObjectLockConfiguration` to a bucket.
9560
+ # Bucket settings require both a mode and a period. The period can be
9561
+ # either `Days` or `Years` but you must select one. You cannot specify
9562
+ # `Days` and `Years` at the same time.
9550
9563
  # @return [Types::ObjectLockRule]
9551
9564
  #
9552
9565
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectLockConfiguration AWS API Documentation
@@ -9620,8 +9633,11 @@ module Aws::S3
9620
9633
  # }
9621
9634
  #
9622
9635
  # @!attribute [rw] default_retention
9623
- # The default retention period that you want to apply to new objects
9624
- # placed in the specified bucket.
9636
+ # The default Object Lock retention mode and period that you want to
9637
+ # apply to new objects placed in the specified bucket. Bucket settings
9638
+ # require both a mode and a period. The period can be either `Days` or
9639
+ # `Years` but you must select one. You cannot specify `Days` and
9640
+ # `Years` at the same time.
9625
9641
  # @return [Types::DefaultRetention]
9626
9642
  #
9627
9643
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectLockRule AWS API Documentation
@@ -10336,8 +10352,7 @@ module Aws::S3
10336
10352
  # encryption with Amazon S3-managed keys (SSE-S3) or customer master
10337
10353
  # keys stored in AWS KMS (SSE-KMS). For information about the Amazon
10338
10354
  # S3 default encryption feature, see [Amazon S3 Default Bucket
10339
- # Encryption][1] in the *Amazon Simple Storage Service Developer
10340
- # Guide*.
10355
+ # Encryption][1] in the *Amazon S3 User Guide*.
10341
10356
  #
10342
10357
  #
10343
10358
  #
@@ -11442,7 +11457,7 @@ module Aws::S3
11442
11457
  # When using this action with an access point through the AWS SDKs,
11443
11458
  # you provide the access point ARN in place of the bucket name. For
11444
11459
  # more information about access point ARNs, see [Using Access
11445
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
11460
+ # Points][1] in the *Amazon S3 User Guide*.
11446
11461
  #
11447
11462
  #
11448
11463
  #
@@ -11503,7 +11518,7 @@ module Aws::S3
11503
11518
  # When using this action with an access point through the AWS SDKs,
11504
11519
  # you provide the access point ARN in place of the bucket name. For
11505
11520
  # more information about access point ARNs, see [Using Access
11506
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
11521
+ # Points][1] in the *Amazon S3 User Guide*.
11507
11522
  #
11508
11523
  # When using this action with Amazon S3 on Outposts, you must direct
11509
11524
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -11512,7 +11527,7 @@ module Aws::S3
11512
11527
  # When using this action using S3 on Outposts through the AWS SDKs,
11513
11528
  # you provide the Outposts bucket ARN in place of the bucket name. For
11514
11529
  # more information about S3 on Outposts ARNs, see [Using S3 on
11515
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
11530
+ # Outposts][2] in the *Amazon S3 User Guide*.
11516
11531
  #
11517
11532
  #
11518
11533
  #
@@ -11601,7 +11616,7 @@ module Aws::S3
11601
11616
  # When using this action with an access point through the AWS SDKs,
11602
11617
  # you provide the access point ARN in place of the bucket name. For
11603
11618
  # more information about access point ARNs, see [Using Access
11604
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
11619
+ # Points][1] in the *Amazon S3 User Guide*.
11605
11620
  #
11606
11621
  #
11607
11622
  #
@@ -11892,7 +11907,7 @@ module Aws::S3
11892
11907
  # When using this action with an access point through the AWS SDKs,
11893
11908
  # you provide the access point ARN in place of the bucket name. For
11894
11909
  # more information about access point ARNs, see [Using Access
11895
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
11910
+ # Points][1] in the *Amazon S3 User Guide*.
11896
11911
  #
11897
11912
  # When using this action with Amazon S3 on Outposts, you must direct
11898
11913
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -11901,7 +11916,7 @@ module Aws::S3
11901
11916
  # When using this action using S3 on Outposts through the AWS SDKs,
11902
11917
  # you provide the Outposts bucket ARN in place of the bucket name. For
11903
11918
  # more information about S3 on Outposts ARNs, see [Using S3 on
11904
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
11919
+ # Outposts][2] in the *Amazon S3 User Guide*.
11905
11920
  #
11906
11921
  #
11907
11922
  #
@@ -12239,7 +12254,7 @@ module Aws::S3
12239
12254
  # When using this action with an access point through the AWS SDKs,
12240
12255
  # you provide the access point ARN in place of the bucket name. For
12241
12256
  # more information about access point ARNs, see [Using Access
12242
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
12257
+ # Points][1] in the *Amazon S3 User Guide*.
12243
12258
  #
12244
12259
  #
12245
12260
  #
@@ -12347,7 +12362,7 @@ module Aws::S3
12347
12362
  # When using this action with an access point through the AWS SDKs,
12348
12363
  # you provide the access point ARN in place of the bucket name. For
12349
12364
  # more information about access point ARNs, see [Using Access
12350
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
12365
+ # Points][1] in the *Amazon S3 User Guide*.
12351
12366
  #
12352
12367
  # When using this action with Amazon S3 on Outposts, you must direct
12353
12368
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -12356,7 +12371,7 @@ module Aws::S3
12356
12371
  # When using this action using S3 on Outposts through the AWS SDKs,
12357
12372
  # you provide the Outposts bucket ARN in place of the bucket name. For
12358
12373
  # more information about S3 on Outposts ARNs, see [Using S3 on
12359
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
12374
+ # Outposts][2] in the *Amazon S3 User Guide*.
12360
12375
  #
12361
12376
  #
12362
12377
  #
@@ -12447,7 +12462,7 @@ module Aws::S3
12447
12462
  # Amazon S3 bucket. You can enable the configuration options in any
12448
12463
  # combination. For more information about when Amazon S3 considers a
12449
12464
  # bucket or object public, see [The Meaning of "Public"][1] in the
12450
- # *Amazon Simple Storage Service Developer Guide*.
12465
+ # *Amazon S3 User Guide*.
12451
12466
  #
12452
12467
  #
12453
12468
  #
@@ -12513,7 +12528,7 @@ module Aws::S3
12513
12528
  # @!attribute [rw] filter
12514
12529
  # Specifies object key name filtering rules. For information about key
12515
12530
  # name filtering, see [Configuring Event Notifications][1] in the
12516
- # *Amazon Simple Storage Service Developer Guide*.
12531
+ # *Amazon S3 User Guide*.
12517
12532
  #
12518
12533
  #
12519
12534
  #
@@ -12804,7 +12819,7 @@ module Aws::S3
12804
12819
  # The Amazon Resource Name (ARN) of the AWS Identity and Access
12805
12820
  # Management (IAM) role that Amazon S3 assumes when replicating
12806
12821
  # objects. For more information, see [How to Set Up Replication][1] in
12807
- # the *Amazon Simple Storage Service Developer Guide*.
12822
+ # the *Amazon S3 User Guide*.
12808
12823
  #
12809
12824
  #
12810
12825
  #
@@ -12905,8 +12920,8 @@ module Aws::S3
12905
12920
  # will be replicated according to the rule with the highest priority.
12906
12921
  # The higher the number, the higher the priority.
12907
12922
  #
12908
- # For more information, see [Replication][1] in the *Amazon Simple
12909
- # Storage Service Developer Guide*.
12923
+ # For more information, see [Replication][1] in the *Amazon S3 User
12924
+ # Guide*.
12910
12925
  #
12911
12926
  #
12912
12927
  #
@@ -13327,7 +13342,7 @@ module Aws::S3
13327
13342
  # When using this action with an access point through the AWS SDKs,
13328
13343
  # you provide the access point ARN in place of the bucket name. For
13329
13344
  # more information about access point ARNs, see [Using Access
13330
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
13345
+ # Points][1] in the *Amazon S3 User Guide*.
13331
13346
  #
13332
13347
  # When using this action with Amazon S3 on Outposts, you must direct
13333
13348
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -13336,7 +13351,7 @@ module Aws::S3
13336
13351
  # When using this action using S3 on Outposts through the AWS SDKs,
13337
13352
  # you provide the Outposts bucket ARN in place of the bucket name. For
13338
13353
  # more information about S3 on Outposts ARNs, see [Using S3 on
13339
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
13354
+ # Outposts][2] in the *Amazon S3 User Guide*.
13340
13355
  #
13341
13356
  #
13342
13357
  #
@@ -13671,7 +13686,7 @@ module Aws::S3
13671
13686
  # upload that Amazon S3 will wait before permanently removing all
13672
13687
  # parts of the upload. For more information, see [ Aborting Incomplete
13673
13688
  # Multipart Uploads Using a Bucket Lifecycle Policy][1] in the *Amazon
13674
- # Simple Storage Service Developer Guide*.
13689
+ # S3 User Guide*.
13675
13690
  #
13676
13691
  #
13677
13692
  #
@@ -14615,7 +14630,7 @@ module Aws::S3
14615
14630
  # @!attribute [rw] filter
14616
14631
  # Specifies object key name filtering rules. For information about key
14617
14632
  # name filtering, see [Configuring Event Notifications][1] in the
14618
- # *Amazon Simple Storage Service Developer Guide*.
14633
+ # *Amazon S3 User Guide*.
14619
14634
  #
14620
14635
  #
14621
14636
  #
@@ -14819,7 +14834,7 @@ module Aws::S3
14819
14834
  # When using this action with an access point through the AWS SDKs,
14820
14835
  # you provide the access point ARN in place of the bucket name. For
14821
14836
  # more information about access point ARNs, see [Using Access
14822
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
14837
+ # Points][1] in the *Amazon S3 User Guide*.
14823
14838
  #
14824
14839
  # When using this action with Amazon S3 on Outposts, you must direct
14825
14840
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -14828,7 +14843,7 @@ module Aws::S3
14828
14843
  # When using this action using S3 on Outposts through the AWS SDKs,
14829
14844
  # you provide the Outposts bucket ARN in place of the bucket name. For
14830
14845
  # more information about S3 on Outposts ARNs, see [Using S3 on
14831
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
14846
+ # Outposts][2] in the *Amazon S3 User Guide*.
14832
14847
  #
14833
14848
  #
14834
14849
  #
@@ -15096,7 +15111,7 @@ module Aws::S3
15096
15111
  # When using this action with an access point through the AWS SDKs,
15097
15112
  # you provide the access point ARN in place of the bucket name. For
15098
15113
  # more information about access point ARNs, see [Using Access
15099
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
15114
+ # Points][1] in the *Amazon S3 User Guide*.
15100
15115
  #
15101
15116
  # When using this action with Amazon S3 on Outposts, you must direct
15102
15117
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
@@ -15105,7 +15120,7 @@ module Aws::S3
15105
15120
  # When using this action using S3 on Outposts through the AWS SDKs,
15106
15121
  # you provide the Outposts bucket ARN in place of the bucket name. For
15107
15122
  # more information about S3 on Outposts ARNs, see [Using S3 on
15108
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
15123
+ # Outposts][2] in the *Amazon S3 User Guide*.
15109
15124
  #
15110
15125
  #
15111
15126
  #
@@ -15392,7 +15407,9 @@ module Aws::S3
15392
15407
  # A string that uniquely identifies an error condition. Returned in
15393
15408
  # the &lt;Code&gt; tag of the error XML response for a corresponding
15394
15409
  # `GetObject` call. Cannot be used with a successful `StatusCode`
15395
- # header or when the transformed object is provided in the body.
15410
+ # header or when the transformed object is provided in the body. All
15411
+ # error codes from S3 are sentence-cased. Regex value is
15412
+ # "^\[A-Z\]\[a-zA-Z\]+$".
15396
15413
  # @return [String]
15397
15414
  #
15398
15415
  # @!attribute [rw] error_message