aws-sdk-s3 1.88.1 → 1.105.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +833 -0
  3. data/LICENSE.txt +202 -0
  4. data/VERSION +1 -0
  5. data/lib/aws-sdk-s3/arn/access_point_arn.rb +14 -11
  6. data/lib/aws-sdk-s3/arn/multi_region_access_point_arn.rb +68 -0
  7. data/lib/aws-sdk-s3/arn/object_lambda_arn.rb +69 -0
  8. data/lib/aws-sdk-s3/arn/outpost_access_point_arn.rb +9 -10
  9. data/lib/aws-sdk-s3/bucket.rb +30 -29
  10. data/lib/aws-sdk-s3/bucket_acl.rb +9 -6
  11. data/lib/aws-sdk-s3/bucket_cors.rb +8 -7
  12. data/lib/aws-sdk-s3/bucket_lifecycle.rb +6 -5
  13. data/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb +3 -3
  14. data/lib/aws-sdk-s3/bucket_logging.rb +6 -6
  15. data/lib/aws-sdk-s3/bucket_notification.rb +4 -4
  16. data/lib/aws-sdk-s3/bucket_policy.rb +6 -5
  17. data/lib/aws-sdk-s3/bucket_request_payment.rb +8 -8
  18. data/lib/aws-sdk-s3/bucket_tagging.rb +6 -5
  19. data/lib/aws-sdk-s3/bucket_versioning.rb +13 -10
  20. data/lib/aws-sdk-s3/bucket_website.rb +6 -5
  21. data/lib/aws-sdk-s3/client.rb +1823 -1323
  22. data/lib/aws-sdk-s3/client_api.rb +65 -1
  23. data/lib/aws-sdk-s3/customizations/bucket.rb +8 -3
  24. data/lib/aws-sdk-s3/customizations/object.rb +41 -16
  25. data/lib/aws-sdk-s3/encryption/client.rb +1 -1
  26. data/lib/aws-sdk-s3/encryption/decrypt_handler.rb +0 -4
  27. data/lib/aws-sdk-s3/encryptionV2/client.rb +1 -1
  28. data/lib/aws-sdk-s3/encryptionV2/decrypt_handler.rb +0 -4
  29. data/lib/aws-sdk-s3/encryptionV2/encrypt_handler.rb +0 -4
  30. data/lib/aws-sdk-s3/errors.rb +1 -1
  31. data/lib/aws-sdk-s3/event_streams.rb +1 -1
  32. data/lib/aws-sdk-s3/file_downloader.rb +6 -1
  33. data/lib/aws-sdk-s3/file_uploader.rb +3 -3
  34. data/lib/aws-sdk-s3/multipart_upload.rb +7 -7
  35. data/lib/aws-sdk-s3/multipart_upload_part.rb +9 -8
  36. data/lib/aws-sdk-s3/object.rb +164 -75
  37. data/lib/aws-sdk-s3/object_acl.rb +10 -7
  38. data/lib/aws-sdk-s3/object_summary.rb +75 -71
  39. data/lib/aws-sdk-s3/object_version.rb +18 -17
  40. data/lib/aws-sdk-s3/plugins/accelerate.rb +7 -1
  41. data/lib/aws-sdk-s3/plugins/arn.rb +91 -42
  42. data/lib/aws-sdk-s3/plugins/bucket_dns.rb +1 -1
  43. data/lib/aws-sdk-s3/plugins/dualstack.rb +25 -31
  44. data/lib/aws-sdk-s3/plugins/get_bucket_location_fix.rb +1 -1
  45. data/lib/aws-sdk-s3/plugins/iad_regional_endpoint.rb +11 -10
  46. data/lib/aws-sdk-s3/plugins/object_lambda_endpoint.rb +25 -0
  47. data/lib/aws-sdk-s3/plugins/s3_signer.rb +35 -5
  48. data/lib/aws-sdk-s3/presigner.rb +19 -5
  49. data/lib/aws-sdk-s3/resource.rb +5 -3
  50. data/lib/aws-sdk-s3/types.rb +1397 -845
  51. data/lib/aws-sdk-s3/waiters.rb +1 -1
  52. data/lib/aws-sdk-s3.rb +2 -2
  53. metadata +17 -12
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -14,7 +14,7 @@ module Aws::S3
14
14
  # upload that Amazon S3 will wait before permanently removing all parts
15
15
  # of the upload. For more information, see [ Aborting Incomplete
16
16
  # Multipart Uploads Using a Bucket Lifecycle Policy][1] in the *Amazon
17
- # Simple Storage Service Developer Guide*.
17
+ # S3 User Guide*.
18
18
  #
19
19
  #
20
20
  #
@@ -67,28 +67,28 @@ module Aws::S3
67
67
  # @!attribute [rw] bucket
68
68
  # The bucket name to which the upload was taking place.
69
69
  #
70
- # When using this API with an access point, you must direct requests
71
- # to the access point hostname. The access point hostname takes the
72
- # form
70
+ # When using this action with an access point, you must direct
71
+ # requests to the access point hostname. The access point hostname
72
+ # takes the form
73
73
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
74
- # When using this operation with an access point through the AWS SDKs,
75
- # you provide the access point ARN in place of the bucket name. For
76
- # more information about access point ARNs, see [Using Access
77
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
74
+ # When using this action with an access point through the Amazon Web
75
+ # Services SDKs, you provide the access point ARN in place of the
76
+ # bucket name. For more information about access point ARNs, see
77
+ # [Using access points][1] in the *Amazon S3 User Guide*.
78
78
  #
79
- # When using this API with Amazon S3 on Outposts, you must direct
79
+ # When using this action with Amazon S3 on Outposts, you must direct
80
80
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
81
81
  # takes the form
82
82
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
83
- # When using this operation using S3 on Outposts through the AWS SDKs,
84
- # you provide the Outposts bucket ARN in place of the bucket name. For
85
- # more information about S3 on Outposts ARNs, see [Using S3 on
86
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
83
+ # When using this action using S3 on Outposts through the Amazon Web
84
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
85
+ # bucket name. For more information about S3 on Outposts ARNs, see
86
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
87
87
  #
88
88
  #
89
89
  #
90
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
91
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
90
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
91
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
92
92
  # @return [String]
93
93
  #
94
94
  # @!attribute [rw] key
@@ -104,7 +104,7 @@ module Aws::S3
104
104
  # request. Bucket owners need not specify this parameter in their
105
105
  # requests. For information about downloading objects from requester
106
106
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
107
- # in the *Amazon S3 Developer Guide*.
107
+ # in the *Amazon S3 User Guide*.
108
108
  #
109
109
  #
110
110
  #
@@ -112,7 +112,7 @@ module Aws::S3
112
112
  # @return [String]
113
113
  #
114
114
  # @!attribute [rw] expected_bucket_owner
115
- # The account id of the expected bucket owner. If the bucket is owned
115
+ # The account ID of the expected bucket owner. If the bucket is owned
116
116
  # by a different account, the request will fail with an HTTP `403
117
117
  # (Access Denied)` error.
118
118
  # @return [String]
@@ -131,7 +131,7 @@ module Aws::S3
131
131
 
132
132
  # Configures the transfer acceleration state for an Amazon S3 bucket.
133
133
  # For more information, see [Amazon S3 Transfer Acceleration][1] in the
134
- # *Amazon Simple Storage Service Developer Guide*.
134
+ # *Amazon S3 User Guide*.
135
135
  #
136
136
  #
137
137
  #
@@ -209,8 +209,7 @@ module Aws::S3
209
209
  #
210
210
  # @!attribute [rw] owner
211
211
  # Specifies the replica ownership. For default and valid values, see
212
- # [PUT bucket replication][1] in the *Amazon Simple Storage Service
213
- # API Reference*.
212
+ # [PUT bucket replication][1] in the *Amazon S3 API Reference*.
214
213
  #
215
214
  #
216
215
  #
@@ -451,8 +450,8 @@ module Aws::S3
451
450
  end
452
451
 
453
452
  # In terms of implementation, a Bucket is a resource. An Amazon S3
454
- # bucket name is globally unique, and the namespace is shared by all AWS
455
- # accounts.
453
+ # bucket name is globally unique, and the namespace is shared by all
454
+ # Amazon Web Services accounts.
456
455
  #
457
456
  # @!attribute [rw] name
458
457
  # The name of the bucket.
@@ -481,10 +480,11 @@ module Aws::S3
481
480
  class BucketAlreadyExists < Aws::EmptyStructure; end
482
481
 
483
482
  # The bucket you tried to create already exists, and you own it. Amazon
484
- # S3 returns this error in all AWS Regions except in the North Virginia
485
- # Region. For legacy compatibility, if you re-create an existing bucket
486
- # that you already own in the North Virginia Region, Amazon S3 returns
487
- # 200 OK and resets the bucket access control lists (ACLs).
483
+ # S3 returns this error in all Amazon Web Services Regions except in the
484
+ # North Virginia Region. For legacy compatibility, if you re-create an
485
+ # existing bucket that you already own in the North Virginia Region,
486
+ # Amazon S3 returns 200 OK and resets the bucket access control lists
487
+ # (ACLs).
488
488
  #
489
489
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/BucketAlreadyOwnedByYou AWS API Documentation
490
490
  #
@@ -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
  #
@@ -590,8 +590,7 @@ module Aws::S3
590
590
  # @!attribute [rw] logging_enabled
591
591
  # Describes where logs are stored and the prefix that Amazon S3
592
592
  # assigns to all log object keys for a bucket. For more information,
593
- # see [PUT Bucket logging][1] in the *Amazon Simple Storage Service
594
- # API Reference*.
593
+ # see [PUT Bucket logging][1] in the *Amazon S3 API Reference*.
595
594
  #
596
595
  #
597
596
  #
@@ -608,8 +607,7 @@ module Aws::S3
608
607
 
609
608
  # Describes the cross-origin access configuration for objects in an
610
609
  # Amazon S3 bucket. For more information, see [Enabling Cross-Origin
611
- # Resource Sharing][1] in the *Amazon Simple Storage Service Developer
612
- # Guide*.
610
+ # Resource Sharing][1] in the *Amazon S3 User Guide*.
613
611
  #
614
612
  #
615
613
  #
@@ -621,6 +619,7 @@ module Aws::S3
621
619
  # {
622
620
  # cors_rules: [ # required
623
621
  # {
622
+ # id: "ID",
624
623
  # allowed_headers: ["AllowedHeader"],
625
624
  # allowed_methods: ["AllowedMethod"], # required
626
625
  # allowed_origins: ["AllowedOrigin"], # required
@@ -649,6 +648,7 @@ module Aws::S3
649
648
  # data as a hash:
650
649
  #
651
650
  # {
651
+ # id: "ID",
652
652
  # allowed_headers: ["AllowedHeader"],
653
653
  # allowed_methods: ["AllowedMethod"], # required
654
654
  # allowed_origins: ["AllowedOrigin"], # required
@@ -656,6 +656,11 @@ module Aws::S3
656
656
  # max_age_seconds: 1,
657
657
  # }
658
658
  #
659
+ # @!attribute [rw] id
660
+ # Unique identifier for the rule. The value cannot be longer than 255
661
+ # characters.
662
+ # @return [String]
663
+ #
659
664
  # @!attribute [rw] allowed_headers
660
665
  # Headers that are specified in the `Access-Control-Request-Headers`
661
666
  # header. These headers are allowed in a preflight OPTIONS request. In
@@ -687,6 +692,7 @@ module Aws::S3
687
692
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CORSRule AWS API Documentation
688
693
  #
689
694
  class CORSRule < Struct.new(
695
+ :id,
690
696
  :allowed_headers,
691
697
  :allowed_methods,
692
698
  :allowed_origins,
@@ -838,7 +844,7 @@ module Aws::S3
838
844
  include Aws::Structure
839
845
  end
840
846
 
841
- # Container for specifying the AWS Lambda notification configuration.
847
+ # Container for specifying the Lambda notification configuration.
842
848
  #
843
849
  # @note When making an API call, you may pass CloudFunctionConfiguration
844
850
  # data as a hash:
@@ -909,30 +915,31 @@ module Aws::S3
909
915
  # @return [String]
910
916
  #
911
917
  # @!attribute [rw] bucket
912
- # The name of the bucket that contains the newly created object.
918
+ # The name of the bucket that contains the newly created object. Does
919
+ # not return the access point ARN or access point alias if used.
913
920
  #
914
- # When using this API with an access point, you must direct requests
915
- # to the access point hostname. The access point hostname takes the
916
- # form
921
+ # When using this action with an access point, you must direct
922
+ # requests to the access point hostname. The access point hostname
923
+ # takes the form
917
924
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
918
- # When using this operation with an access point through the AWS SDKs,
919
- # you provide the access point ARN in place of the bucket name. For
920
- # more information about access point ARNs, see [Using Access
921
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
925
+ # When using this action with an access point through the Amazon Web
926
+ # Services SDKs, you provide the access point ARN in place of the
927
+ # bucket name. For more information about access point ARNs, see
928
+ # [Using access points][1] in the *Amazon S3 User Guide*.
922
929
  #
923
- # When using this API with Amazon S3 on Outposts, you must direct
930
+ # When using this action with Amazon S3 on Outposts, you must direct
924
931
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
925
932
  # takes the form
926
933
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
927
- # When using this operation using S3 on Outposts through the AWS SDKs,
928
- # you provide the Outposts bucket ARN in place of the bucket name. For
929
- # more information about S3 on Outposts ARNs, see [Using S3 on
930
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
934
+ # When using this action using S3 on Outposts through the Amazon Web
935
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
936
+ # bucket name. For more information about S3 on Outposts ARNs, see
937
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
931
938
  #
932
939
  #
933
940
  #
934
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
935
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
941
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
942
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
936
943
  # @return [String]
937
944
  #
938
945
  # @!attribute [rw] key
@@ -957,8 +964,8 @@ module Aws::S3
957
964
  #
958
965
  # @!attribute [rw] server_side_encryption
959
966
  # If you specified server-side encryption either with an Amazon
960
- # S3-managed encryption key or an AWS KMS customer master key (CMK) in
961
- # your initiate multipart upload request, the response includes this
967
+ # S3-managed encryption key or an Amazon Web Services KMS key in your
968
+ # initiate multipart upload request, the response includes this
962
969
  # header. It confirms the encryption algorithm that Amazon S3 used to
963
970
  # encrypt the object.
964
971
  # @return [String]
@@ -969,14 +976,14 @@ module Aws::S3
969
976
  # @return [String]
970
977
  #
971
978
  # @!attribute [rw] ssekms_key_id
972
- # If present, specifies the ID of the AWS Key Management Service (AWS
973
- # KMS) symmetric customer managed customer master key (CMK) that was
974
- # used for the object.
979
+ # If present, specifies the ID of the Amazon Web Services Key
980
+ # Management Service (Amazon Web Services KMS) symmetric customer
981
+ # managed key that was used for the object.
975
982
  # @return [String]
976
983
  #
977
984
  # @!attribute [rw] bucket_key_enabled
978
985
  # Indicates whether the multipart upload uses an S3 Bucket Key for
979
- # server-side encryption with AWS KMS (SSE-KMS).
986
+ # server-side encryption with Amazon Web Services KMS (SSE-KMS).
980
987
  # @return [Boolean]
981
988
  #
982
989
  # @!attribute [rw] request_charged
@@ -1022,6 +1029,29 @@ module Aws::S3
1022
1029
  #
1023
1030
  # @!attribute [rw] bucket
1024
1031
  # Name of the bucket to which the multipart upload was initiated.
1032
+ #
1033
+ # When using this action with an access point, you must direct
1034
+ # requests to the access point hostname. The access point hostname
1035
+ # takes the form
1036
+ # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
1037
+ # When using this action with an access point through the Amazon Web
1038
+ # Services SDKs, you provide the access point ARN in place of the
1039
+ # bucket name. For more information about access point ARNs, see
1040
+ # [Using access points][1] in the *Amazon S3 User Guide*.
1041
+ #
1042
+ # When using this action with Amazon S3 on Outposts, you must direct
1043
+ # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
1044
+ # takes the form
1045
+ # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
1046
+ # When using this action using S3 on Outposts through the Amazon Web
1047
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
1048
+ # bucket name. For more information about S3 on Outposts ARNs, see
1049
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
1050
+ #
1051
+ #
1052
+ #
1053
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
1054
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
1025
1055
  # @return [String]
1026
1056
  #
1027
1057
  # @!attribute [rw] key
@@ -1041,7 +1071,7 @@ module Aws::S3
1041
1071
  # request. Bucket owners need not specify this parameter in their
1042
1072
  # requests. For information about downloading objects from requester
1043
1073
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
1044
- # in the *Amazon S3 Developer Guide*.
1074
+ # in the *Amazon S3 User Guide*.
1045
1075
  #
1046
1076
  #
1047
1077
  #
@@ -1049,7 +1079,7 @@ module Aws::S3
1049
1079
  # @return [String]
1050
1080
  #
1051
1081
  # @!attribute [rw] expected_bucket_owner
1052
- # The account id of the expected bucket owner. If the bucket is owned
1082
+ # The account ID of the expected bucket owner. If the bucket is owned
1053
1083
  # by a different account, the request will fail with an HTTP `403
1054
1084
  # (Access Denied)` error.
1055
1085
  # @return [String]
@@ -1153,6 +1183,14 @@ module Aws::S3
1153
1183
  # `Condition` is specified and sibling `HttpErrorCodeReturnedEquals`
1154
1184
  # is not specified. If both conditions are specified, both must be
1155
1185
  # true for the redirect to be applied.
1186
+ #
1187
+ # Replacement must be made for object keys containing special
1188
+ # characters (such as carriage returns) when using XML requests. For
1189
+ # more information, see [ XML related object key constraints][1].
1190
+ #
1191
+ #
1192
+ #
1193
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
1156
1194
  # @return [String]
1157
1195
  #
1158
1196
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Condition AWS API Documentation
@@ -1208,21 +1246,21 @@ module Aws::S3
1208
1246
  # @return [String]
1209
1247
  #
1210
1248
  # @!attribute [rw] ssekms_key_id
1211
- # If present, specifies the ID of the AWS Key Management Service (AWS
1212
- # KMS) symmetric customer managed customer master key (CMK) that was
1213
- # used for the object.
1249
+ # If present, specifies the ID of the Amazon Web Services Key
1250
+ # Management Service (Amazon Web Services KMS) symmetric customer
1251
+ # managed key that was used for the object.
1214
1252
  # @return [String]
1215
1253
  #
1216
1254
  # @!attribute [rw] ssekms_encryption_context
1217
- # If present, specifies the AWS KMS Encryption Context to use for
1218
- # object encryption. The value of this header is a base64-encoded
1219
- # UTF-8 string holding JSON with the encryption context key-value
1220
- # pairs.
1255
+ # If present, specifies the Amazon Web Services KMS Encryption Context
1256
+ # to use for object encryption. The value of this header is a
1257
+ # base64-encoded UTF-8 string holding JSON with the encryption context
1258
+ # key-value pairs.
1221
1259
  # @return [String]
1222
1260
  #
1223
1261
  # @!attribute [rw] bucket_key_enabled
1224
1262
  # Indicates whether the copied object uses an S3 Bucket Key for
1225
- # server-side encryption with AWS KMS (SSE-KMS).
1263
+ # server-side encryption with Amazon Web Services KMS (SSE-KMS).
1226
1264
  # @return [Boolean]
1227
1265
  #
1228
1266
  # @!attribute [rw] request_charged
@@ -1305,28 +1343,28 @@ module Aws::S3
1305
1343
  # @!attribute [rw] bucket
1306
1344
  # The name of the destination bucket.
1307
1345
  #
1308
- # When using this API with an access point, you must direct requests
1309
- # to the access point hostname. The access point hostname takes the
1310
- # form
1346
+ # When using this action with an access point, you must direct
1347
+ # requests to the access point hostname. The access point hostname
1348
+ # takes the form
1311
1349
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
1312
- # When using this operation with an access point through the AWS SDKs,
1313
- # you provide the access point ARN in place of the bucket name. For
1314
- # more information about access point ARNs, see [Using Access
1315
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
1350
+ # When using this action with an access point through the Amazon Web
1351
+ # Services SDKs, you provide the access point ARN in place of the
1352
+ # bucket name. For more information about access point ARNs, see
1353
+ # [Using access points][1] in the *Amazon S3 User Guide*.
1316
1354
  #
1317
- # When using this API with Amazon S3 on Outposts, you must direct
1355
+ # When using this action with Amazon S3 on Outposts, you must direct
1318
1356
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
1319
1357
  # takes the form
1320
1358
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
1321
- # When using this operation using S3 on Outposts through the AWS SDKs,
1322
- # you provide the Outposts bucket ARN in place of the bucket name. For
1323
- # more information about S3 on Outposts ARNs, see [Using S3 on
1324
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
1359
+ # When using this action using S3 on Outposts through the Amazon Web
1360
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
1361
+ # bucket name. For more information about S3 on Outposts ARNs, see
1362
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
1325
1363
  #
1326
1364
  #
1327
1365
  #
1328
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
1329
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
1366
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
1367
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
1330
1368
  # @return [String]
1331
1369
  #
1332
1370
  # @!attribute [rw] cache_control
@@ -1374,7 +1412,8 @@ module Aws::S3
1374
1412
  # The value must be URL encoded.
1375
1413
  #
1376
1414
  # <note markdown="1"> Amazon S3 supports copy operations using access points only when
1377
- # the source and destination buckets are in the same AWS Region.
1415
+ # the source and destination buckets are in the same Amazon Web
1416
+ # Services Region.
1378
1417
  #
1379
1418
  # </note>
1380
1419
  #
@@ -1395,7 +1434,7 @@ module Aws::S3
1395
1434
  #
1396
1435
  #
1397
1436
  #
1398
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html
1437
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
1399
1438
  # @return [String]
1400
1439
  #
1401
1440
  # @!attribute [rw] copy_source_if_match
@@ -1475,7 +1514,7 @@ module Aws::S3
1475
1514
  # and high availability. Depending on performance needs, you can
1476
1515
  # specify a different Storage Class. Amazon S3 on Outposts only uses
1477
1516
  # the OUTPOSTS Storage Class. For more information, see [Storage
1478
- # Classes][1] in the *Amazon S3 Service Developer Guide*.
1517
+ # Classes][1] in the *Amazon S3 User Guide*.
1479
1518
  #
1480
1519
  #
1481
1520
  #
@@ -1509,12 +1548,13 @@ module Aws::S3
1509
1548
  # @return [String]
1510
1549
  #
1511
1550
  # @!attribute [rw] ssekms_key_id
1512
- # Specifies the AWS KMS key ID to use for object encryption. All GET
1513
- # and PUT requests for an object protected by AWS KMS will fail if not
1514
- # made via SSL or using SigV4. For information about configuring using
1515
- # any of the officially supported AWS SDKs and AWS CLI, see
1551
+ # Specifies the Amazon Web Services KMS key ID to use for object
1552
+ # encryption. All GET and PUT requests for an object protected by
1553
+ # Amazon Web Services KMS will fail if not made via SSL or using
1554
+ # SigV4. For information about configuring using any of the officially
1555
+ # supported Amazon Web Services SDKs and Amazon Web Services CLI, see
1516
1556
  # [Specifying the Signature Version in Request Authentication][1] in
1517
- # the *Amazon S3 Developer Guide*.
1557
+ # the *Amazon S3 User Guide*.
1518
1558
  #
1519
1559
  #
1520
1560
  #
@@ -1522,9 +1562,10 @@ module Aws::S3
1522
1562
  # @return [String]
1523
1563
  #
1524
1564
  # @!attribute [rw] ssekms_encryption_context
1525
- # Specifies the AWS KMS Encryption Context to use for object
1526
- # encryption. The value of this header is a base64-encoded UTF-8
1527
- # string holding JSON with the encryption context key-value pairs.
1565
+ # Specifies the Amazon Web Services KMS Encryption Context to use for
1566
+ # object encryption. The value of this header is a base64-encoded
1567
+ # UTF-8 string holding JSON with the encryption context key-value
1568
+ # pairs.
1528
1569
  # @return [String]
1529
1570
  #
1530
1571
  # @!attribute [rw] bucket_key_enabled
@@ -1533,7 +1574,7 @@ module Aws::S3
1533
1574
  # Setting this header to `true` causes Amazon S3 to use an S3 Bucket
1534
1575
  # Key for object encryption with SSE-KMS.
1535
1576
  #
1536
- # Specifying this header with a COPY operation doesn’t affect
1577
+ # Specifying this header with a COPY action doesn’t affect
1537
1578
  # bucket-level settings for S3 Bucket Key.
1538
1579
  # @return [Boolean]
1539
1580
  #
@@ -1559,7 +1600,7 @@ module Aws::S3
1559
1600
  # request. Bucket owners need not specify this parameter in their
1560
1601
  # requests. For information about downloading objects from requester
1561
1602
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
1562
- # in the *Amazon S3 Developer Guide*.
1603
+ # in the *Amazon S3 User Guide*.
1563
1604
  #
1564
1605
  #
1565
1606
  #
@@ -1587,13 +1628,13 @@ module Aws::S3
1587
1628
  # @return [String]
1588
1629
  #
1589
1630
  # @!attribute [rw] expected_bucket_owner
1590
- # The account id of the expected destination bucket owner. If the
1631
+ # The account ID of the expected destination bucket owner. If the
1591
1632
  # destination bucket is owned by a different account, the request will
1592
1633
  # fail with an HTTP `403 (Access Denied)` error.
1593
1634
  # @return [String]
1594
1635
  #
1595
1636
  # @!attribute [rw] expected_source_bucket_owner
1596
- # The account id of the expected source bucket owner. If the source
1637
+ # The account ID of the expected source bucket owner. If the source
1597
1638
  # bucket is owned by a different account, the request will fail with
1598
1639
  # an HTTP `403 (Access Denied)` error.
1599
1640
  # @return [String]
@@ -1649,12 +1690,11 @@ module Aws::S3
1649
1690
  #
1650
1691
  # @!attribute [rw] etag
1651
1692
  # Returns the ETag of the new object. The ETag reflects only changes
1652
- # to the contents of an object, not its metadata. The source and
1653
- # destination ETag is identical for a successfully copied object.
1693
+ # to the contents of an object, not its metadata.
1654
1694
  # @return [String]
1655
1695
  #
1656
1696
  # @!attribute [rw] last_modified
1657
- # Returns the date that the object was last modified.
1697
+ # Creation date of the object.
1658
1698
  # @return [Time]
1659
1699
  #
1660
1700
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyObjectResult AWS API Documentation
@@ -1765,8 +1805,10 @@ module Aws::S3
1765
1805
  # @return [String]
1766
1806
  #
1767
1807
  # @!attribute [rw] grant_write
1768
- # Allows grantee to create, overwrite, and delete any object in the
1769
- # bucket.
1808
+ # Allows grantee to create new objects in the bucket.
1809
+ #
1810
+ # For the bucket and object owners of existing objects, also allows
1811
+ # deletions and overwrites of those objects.
1770
1812
  # @return [String]
1771
1813
  #
1772
1814
  # @!attribute [rw] grant_write_acp
@@ -1820,29 +1862,30 @@ module Aws::S3
1820
1862
  #
1821
1863
  # @!attribute [rw] bucket
1822
1864
  # The name of the bucket to which the multipart upload was initiated.
1865
+ # Does not return the access point ARN or access point alias if used.
1823
1866
  #
1824
- # When using this API with an access point, you must direct requests
1825
- # to the access point hostname. The access point hostname takes the
1826
- # form
1867
+ # When using this action with an access point, you must direct
1868
+ # requests to the access point hostname. The access point hostname
1869
+ # takes the form
1827
1870
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
1828
- # When using this operation with an access point through the AWS SDKs,
1829
- # you provide the access point ARN in place of the bucket name. For
1830
- # more information about access point ARNs, see [Using Access
1831
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
1871
+ # When using this action with an access point through the Amazon Web
1872
+ # Services SDKs, you provide the access point ARN in place of the
1873
+ # bucket name. For more information about access point ARNs, see
1874
+ # [Using access points][1] in the *Amazon S3 User Guide*.
1832
1875
  #
1833
- # When using this API with Amazon S3 on Outposts, you must direct
1876
+ # When using this action with Amazon S3 on Outposts, you must direct
1834
1877
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
1835
1878
  # takes the form
1836
1879
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
1837
- # When using this operation using S3 on Outposts through the AWS SDKs,
1838
- # you provide the Outposts bucket ARN in place of the bucket name. For
1839
- # more information about S3 on Outposts ARNs, see [Using S3 on
1840
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
1880
+ # When using this action using S3 on Outposts through the Amazon Web
1881
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
1882
+ # bucket name. For more information about S3 on Outposts ARNs, see
1883
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
1841
1884
  #
1842
1885
  #
1843
1886
  #
1844
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
1845
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
1887
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
1888
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
1846
1889
  # @return [String]
1847
1890
  #
1848
1891
  # @!attribute [rw] key
@@ -1872,21 +1915,21 @@ module Aws::S3
1872
1915
  # @return [String]
1873
1916
  #
1874
1917
  # @!attribute [rw] ssekms_key_id
1875
- # If present, specifies the ID of the AWS Key Management Service (AWS
1876
- # KMS) symmetric customer managed customer master key (CMK) that was
1877
- # used for the object.
1918
+ # If present, specifies the ID of the Amazon Web Services Key
1919
+ # Management Service (Amazon Web Services KMS) symmetric customer
1920
+ # managed key that was used for the object.
1878
1921
  # @return [String]
1879
1922
  #
1880
1923
  # @!attribute [rw] ssekms_encryption_context
1881
- # If present, specifies the AWS KMS Encryption Context to use for
1882
- # object encryption. The value of this header is a base64-encoded
1883
- # UTF-8 string holding JSON with the encryption context key-value
1884
- # pairs.
1924
+ # If present, specifies the Amazon Web Services KMS Encryption Context
1925
+ # to use for object encryption. The value of this header is a
1926
+ # base64-encoded UTF-8 string holding JSON with the encryption context
1927
+ # key-value pairs.
1885
1928
  # @return [String]
1886
1929
  #
1887
1930
  # @!attribute [rw] bucket_key_enabled
1888
1931
  # Indicates whether the multipart upload uses an S3 Bucket Key for
1889
- # server-side encryption with AWS KMS (SSE-KMS).
1932
+ # server-side encryption with Amazon Web Services KMS (SSE-KMS).
1890
1933
  # @return [Boolean]
1891
1934
  #
1892
1935
  # @!attribute [rw] request_charged
@@ -1959,28 +2002,28 @@ module Aws::S3
1959
2002
  # @!attribute [rw] bucket
1960
2003
  # The name of the bucket to which to initiate the upload
1961
2004
  #
1962
- # When using this API with an access point, you must direct requests
1963
- # to the access point hostname. The access point hostname takes the
1964
- # form
2005
+ # When using this action with an access point, you must direct
2006
+ # requests to the access point hostname. The access point hostname
2007
+ # takes the form
1965
2008
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
1966
- # When using this operation with an access point through the AWS SDKs,
1967
- # you provide the access point ARN in place of the bucket name. For
1968
- # more information about access point ARNs, see [Using Access
1969
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
2009
+ # When using this action with an access point through the Amazon Web
2010
+ # Services SDKs, you provide the access point ARN in place of the
2011
+ # bucket name. For more information about access point ARNs, see
2012
+ # [Using access points][1] in the *Amazon S3 User Guide*.
1970
2013
  #
1971
- # When using this API with Amazon S3 on Outposts, you must direct
2014
+ # When using this action with Amazon S3 on Outposts, you must direct
1972
2015
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
1973
2016
  # takes the form
1974
2017
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
1975
- # When using this operation using S3 on Outposts through the AWS SDKs,
1976
- # you provide the Outposts bucket ARN in place of the bucket name. For
1977
- # more information about S3 on Outposts ARNs, see [Using S3 on
1978
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
2018
+ # When using this action using S3 on Outposts through the Amazon Web
2019
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
2020
+ # bucket name. For more information about S3 on Outposts ARNs, see
2021
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
1979
2022
  #
1980
2023
  #
1981
2024
  #
1982
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
1983
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
2025
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
2026
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
1984
2027
  # @return [String]
1985
2028
  #
1986
2029
  # @!attribute [rw] cache_control
@@ -2053,7 +2096,7 @@ module Aws::S3
2053
2096
  # and high availability. Depending on performance needs, you can
2054
2097
  # specify a different Storage Class. Amazon S3 on Outposts only uses
2055
2098
  # the OUTPOSTS Storage Class. For more information, see [Storage
2056
- # Classes][1] in the *Amazon S3 Service Developer Guide*.
2099
+ # Classes][1] in the *Amazon S3 User Guide*.
2057
2100
  #
2058
2101
  #
2059
2102
  #
@@ -2087,23 +2130,24 @@ module Aws::S3
2087
2130
  # @return [String]
2088
2131
  #
2089
2132
  # @!attribute [rw] ssekms_key_id
2090
- # Specifies the ID of the symmetric customer managed AWS KMS CMK to
2091
- # use for object encryption. All GET and PUT requests for an object
2092
- # protected by AWS KMS will fail if not made via SSL or using SigV4.
2093
- # For information about configuring using any of the officially
2094
- # supported AWS SDKs and AWS CLI, see [Specifying the Signature
2095
- # Version in Request Authentication][1] in the *Amazon S3 Developer
2096
- # Guide*.
2133
+ # Specifies the ID of the symmetric customer managed key to use for
2134
+ # object encryption. All GET and PUT requests for an object protected
2135
+ # by Amazon Web Services KMS will fail if not made via SSL or using
2136
+ # SigV4. For information about configuring using any of the officially
2137
+ # supported Amazon Web Services SDKs and Amazon Web Services CLI, see
2138
+ # [Specifying the Signature Version in Request Authentication][1] in
2139
+ # the *Amazon S3 User Guide*.
2097
2140
  #
2098
2141
  #
2099
2142
  #
2100
- # [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
2143
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
2101
2144
  # @return [String]
2102
2145
  #
2103
2146
  # @!attribute [rw] ssekms_encryption_context
2104
- # Specifies the AWS KMS Encryption Context to use for object
2105
- # encryption. The value of this header is a base64-encoded UTF-8
2106
- # string holding JSON with the encryption context key-value pairs.
2147
+ # Specifies the Amazon Web Services KMS Encryption Context to use for
2148
+ # object encryption. The value of this header is a base64-encoded
2149
+ # UTF-8 string holding JSON with the encryption context key-value
2150
+ # pairs.
2107
2151
  # @return [String]
2108
2152
  #
2109
2153
  # @!attribute [rw] bucket_key_enabled
@@ -2112,7 +2156,7 @@ module Aws::S3
2112
2156
  # Setting this header to `true` causes Amazon S3 to use an S3 Bucket
2113
2157
  # Key for object encryption with SSE-KMS.
2114
2158
  #
2115
- # Specifying this header with an object operation doesn’t affect
2159
+ # Specifying this header with an object action doesn’t affect
2116
2160
  # bucket-level settings for S3 Bucket Key.
2117
2161
  # @return [Boolean]
2118
2162
  #
@@ -2121,7 +2165,7 @@ module Aws::S3
2121
2165
  # request. Bucket owners need not specify this parameter in their
2122
2166
  # requests. For information about downloading objects from requester
2123
2167
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
2124
- # in the *Amazon S3 Developer Guide*.
2168
+ # in the *Amazon S3 User Guide*.
2125
2169
  #
2126
2170
  #
2127
2171
  #
@@ -2148,7 +2192,7 @@ module Aws::S3
2148
2192
  # @return [String]
2149
2193
  #
2150
2194
  # @!attribute [rw] expected_bucket_owner
2151
- # The account id of the expected bucket owner. If the bucket is owned
2195
+ # The account ID of the expected bucket owner. If the bucket is owned
2152
2196
  # by a different account, the request will fail with an HTTP `403
2153
2197
  # (Access Denied)` error.
2154
2198
  # @return [String]
@@ -2192,6 +2236,14 @@ module Aws::S3
2192
2236
  # The container element for specifying the default Object Lock retention
2193
2237
  # settings for new objects placed in the specified bucket.
2194
2238
  #
2239
+ # <note markdown="1"> * The `DefaultRetention` settings require both a mode and a period.
2240
+ #
2241
+ # * The `DefaultRetention` period can be either `Days` or `Years` but
2242
+ # you must select one. You cannot specify `Days` and `Years` at the
2243
+ # same time.
2244
+ #
2245
+ # </note>
2246
+ #
2195
2247
  # @note When making an API call, you may pass DefaultRetention
2196
2248
  # data as a hash:
2197
2249
  #
@@ -2203,17 +2255,18 @@ module Aws::S3
2203
2255
  #
2204
2256
  # @!attribute [rw] mode
2205
2257
  # The default Object Lock retention mode you want to apply to new
2206
- # objects placed in the specified bucket.
2258
+ # objects placed in the specified bucket. Must be used with either
2259
+ # `Days` or `Years`.
2207
2260
  # @return [String]
2208
2261
  #
2209
2262
  # @!attribute [rw] days
2210
2263
  # The number of days that you want to specify for the default
2211
- # retention period.
2264
+ # retention period. Must be used with `Mode`.
2212
2265
  # @return [Integer]
2213
2266
  #
2214
2267
  # @!attribute [rw] years
2215
2268
  # The number of years that you want to specify for the default
2216
- # retention period.
2269
+ # retention period. Must be used with `Mode`.
2217
2270
  # @return [Integer]
2218
2271
  #
2219
2272
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DefaultRetention AWS API Documentation
@@ -2278,7 +2331,7 @@ module Aws::S3
2278
2331
  # @return [String]
2279
2332
  #
2280
2333
  # @!attribute [rw] expected_bucket_owner
2281
- # The account id of the expected bucket owner. If the bucket is owned
2334
+ # The account ID of the expected bucket owner. If the bucket is owned
2282
2335
  # by a different account, the request will fail with an HTTP `403
2283
2336
  # (Access Denied)` error.
2284
2337
  # @return [String]
@@ -2306,7 +2359,7 @@ module Aws::S3
2306
2359
  # @return [String]
2307
2360
  #
2308
2361
  # @!attribute [rw] expected_bucket_owner
2309
- # The account id of the expected bucket owner. If the bucket is owned
2362
+ # The account ID of the expected bucket owner. If the bucket is owned
2310
2363
  # by a different account, the request will fail with an HTTP `403
2311
2364
  # (Access Denied)` error.
2312
2365
  # @return [String]
@@ -2334,7 +2387,7 @@ module Aws::S3
2334
2387
  # @return [String]
2335
2388
  #
2336
2389
  # @!attribute [rw] expected_bucket_owner
2337
- # The account id of the expected bucket owner. If the bucket is owned
2390
+ # The account ID of the expected bucket owner. If the bucket is owned
2338
2391
  # by a different account, the request will fail with an HTTP `403
2339
2392
  # (Access Denied)` error.
2340
2393
  # @return [String]
@@ -2393,7 +2446,7 @@ module Aws::S3
2393
2446
  # @return [String]
2394
2447
  #
2395
2448
  # @!attribute [rw] expected_bucket_owner
2396
- # The account id of the expected bucket owner. If the bucket is owned
2449
+ # The account ID of the expected bucket owner. If the bucket is owned
2397
2450
  # by a different account, the request will fail with an HTTP `403
2398
2451
  # (Access Denied)` error.
2399
2452
  # @return [String]
@@ -2421,7 +2474,7 @@ module Aws::S3
2421
2474
  # @return [String]
2422
2475
  #
2423
2476
  # @!attribute [rw] expected_bucket_owner
2424
- # The account id of the expected bucket owner. If the bucket is owned
2477
+ # The account ID of the expected bucket owner. If the bucket is owned
2425
2478
  # by a different account, the request will fail with an HTTP `403
2426
2479
  # (Access Denied)` error.
2427
2480
  # @return [String]
@@ -2454,7 +2507,7 @@ module Aws::S3
2454
2507
  # @return [String]
2455
2508
  #
2456
2509
  # @!attribute [rw] expected_bucket_owner
2457
- # The account id of the expected bucket owner. If the bucket is owned
2510
+ # The account ID of the expected bucket owner. If the bucket is owned
2458
2511
  # by a different account, the request will fail with an HTTP `403
2459
2512
  # (Access Denied)` error.
2460
2513
  # @return [String]
@@ -2482,7 +2535,7 @@ module Aws::S3
2482
2535
  # @return [String]
2483
2536
  #
2484
2537
  # @!attribute [rw] expected_bucket_owner
2485
- # The account id of the expected bucket owner. If the bucket is owned
2538
+ # The account ID of the expected bucket owner. If the bucket is owned
2486
2539
  # by a different account, the request will fail with an HTTP `403
2487
2540
  # (Access Denied)` error.
2488
2541
  # @return [String]
@@ -2509,7 +2562,7 @@ module Aws::S3
2509
2562
  # @return [String]
2510
2563
  #
2511
2564
  # @!attribute [rw] expected_bucket_owner
2512
- # The account id of the expected bucket owner. If the bucket is owned
2565
+ # The account ID of the expected bucket owner. If the bucket is owned
2513
2566
  # by a different account, the request will fail with an HTTP `403
2514
2567
  # (Access Denied)` error.
2515
2568
  # @return [String]
@@ -2536,7 +2589,7 @@ module Aws::S3
2536
2589
  # @return [String]
2537
2590
  #
2538
2591
  # @!attribute [rw] expected_bucket_owner
2539
- # The account id of the expected bucket owner. If the bucket is owned
2592
+ # The account ID of the expected bucket owner. If the bucket is owned
2540
2593
  # by a different account, the request will fail with an HTTP `403
2541
2594
  # (Access Denied)` error.
2542
2595
  # @return [String]
@@ -2563,7 +2616,7 @@ module Aws::S3
2563
2616
  # @return [String]
2564
2617
  #
2565
2618
  # @!attribute [rw] expected_bucket_owner
2566
- # The account id of the expected bucket owner. If the bucket is owned
2619
+ # The account ID of the expected bucket owner. If the bucket is owned
2567
2620
  # by a different account, the request will fail with an HTTP `403
2568
2621
  # (Access Denied)` error.
2569
2622
  # @return [String]
@@ -2590,7 +2643,7 @@ module Aws::S3
2590
2643
  # @return [String]
2591
2644
  #
2592
2645
  # @!attribute [rw] expected_bucket_owner
2593
- # The account id of the expected bucket owner. If the bucket is owned
2646
+ # The account ID of the expected bucket owner. If the bucket is owned
2594
2647
  # by a different account, the request will fail with an HTTP `403
2595
2648
  # (Access Denied)` error.
2596
2649
  # @return [String]
@@ -2618,7 +2671,7 @@ module Aws::S3
2618
2671
  # @return [String]
2619
2672
  #
2620
2673
  # @!attribute [rw] expected_bucket_owner
2621
- # The account id of the expected bucket owner. If the bucket is owned
2674
+ # The account ID of the expected bucket owner. If the bucket is owned
2622
2675
  # by a different account, the request will fail with an HTTP `403
2623
2676
  # (Access Denied)` error.
2624
2677
  # @return [String]
@@ -2754,28 +2807,28 @@ module Aws::S3
2754
2807
  # @!attribute [rw] bucket
2755
2808
  # The bucket name of the bucket containing the object.
2756
2809
  #
2757
- # When using this API with an access point, you must direct requests
2758
- # to the access point hostname. The access point hostname takes the
2759
- # form
2810
+ # When using this action with an access point, you must direct
2811
+ # requests to the access point hostname. The access point hostname
2812
+ # takes the form
2760
2813
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
2761
- # When using this operation with an access point through the AWS SDKs,
2762
- # you provide the access point ARN in place of the bucket name. For
2763
- # more information about access point ARNs, see [Using Access
2764
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
2814
+ # When using this action with an access point through the Amazon Web
2815
+ # Services SDKs, you provide the access point ARN in place of the
2816
+ # bucket name. For more information about access point ARNs, see
2817
+ # [Using access points][1] in the *Amazon S3 User Guide*.
2765
2818
  #
2766
- # When using this API with Amazon S3 on Outposts, you must direct
2819
+ # When using this action with Amazon S3 on Outposts, you must direct
2767
2820
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
2768
2821
  # takes the form
2769
2822
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
2770
- # When using this operation using S3 on Outposts through the AWS SDKs,
2771
- # you provide the Outposts bucket ARN in place of the bucket name. For
2772
- # more information about S3 on Outposts ARNs, see [Using S3 on
2773
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
2823
+ # When using this action using S3 on Outposts through the Amazon Web
2824
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
2825
+ # bucket name. For more information about S3 on Outposts ARNs, see
2826
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
2774
2827
  #
2775
2828
  #
2776
2829
  #
2777
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
2778
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
2830
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
2831
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
2779
2832
  # @return [String]
2780
2833
  #
2781
2834
  # @!attribute [rw] key
@@ -2798,7 +2851,7 @@ module Aws::S3
2798
2851
  # request. Bucket owners need not specify this parameter in their
2799
2852
  # requests. For information about downloading objects from requester
2800
2853
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
2801
- # in the *Amazon S3 Developer Guide*.
2854
+ # in the *Amazon S3 User Guide*.
2802
2855
  #
2803
2856
  #
2804
2857
  #
@@ -2807,11 +2860,12 @@ module Aws::S3
2807
2860
  #
2808
2861
  # @!attribute [rw] bypass_governance_retention
2809
2862
  # Indicates whether S3 Object Lock should bypass Governance-mode
2810
- # restrictions to process this operation.
2863
+ # restrictions to process this operation. To use this header, you must
2864
+ # have the `s3:PutBucketPublicAccessBlock` permission.
2811
2865
  # @return [Boolean]
2812
2866
  #
2813
2867
  # @!attribute [rw] expected_bucket_owner
2814
- # The account id of the expected bucket owner. If the bucket is owned
2868
+ # The account ID of the expected bucket owner. If the bucket is owned
2815
2869
  # by a different account, the request will fail with an HTTP `403
2816
2870
  # (Access Denied)` error.
2817
2871
  # @return [String]
@@ -2856,32 +2910,33 @@ module Aws::S3
2856
2910
  # The bucket name containing the objects from which to remove the
2857
2911
  # tags.
2858
2912
  #
2859
- # When using this API with an access point, you must direct requests
2860
- # to the access point hostname. The access point hostname takes the
2861
- # form
2913
+ # When using this action with an access point, you must direct
2914
+ # requests to the access point hostname. The access point hostname
2915
+ # takes the form
2862
2916
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
2863
- # When using this operation with an access point through the AWS SDKs,
2864
- # you provide the access point ARN in place of the bucket name. For
2865
- # more information about access point ARNs, see [Using Access
2866
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
2917
+ # When using this action with an access point through the Amazon Web
2918
+ # Services SDKs, you provide the access point ARN in place of the
2919
+ # bucket name. For more information about access point ARNs, see
2920
+ # [Using access points][1] in the *Amazon S3 User Guide*.
2867
2921
  #
2868
- # When using this API with Amazon S3 on Outposts, you must direct
2922
+ # When using this action with Amazon S3 on Outposts, you must direct
2869
2923
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
2870
2924
  # takes the form
2871
2925
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
2872
- # When using this operation using S3 on Outposts through the AWS SDKs,
2873
- # you provide the Outposts bucket ARN in place of the bucket name. For
2874
- # more information about S3 on Outposts ARNs, see [Using S3 on
2875
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
2926
+ # When using this action using S3 on Outposts through the Amazon Web
2927
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
2928
+ # bucket name. For more information about S3 on Outposts ARNs, see
2929
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
2876
2930
  #
2877
2931
  #
2878
2932
  #
2879
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
2880
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
2933
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
2934
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
2881
2935
  # @return [String]
2882
2936
  #
2883
2937
  # @!attribute [rw] key
2884
- # Name of the object key.
2938
+ # The key that identifies the object in the bucket from which to
2939
+ # remove all tags.
2885
2940
  # @return [String]
2886
2941
  #
2887
2942
  # @!attribute [rw] version_id
@@ -2889,7 +2944,7 @@ module Aws::S3
2889
2944
  # @return [String]
2890
2945
  #
2891
2946
  # @!attribute [rw] expected_bucket_owner
2892
- # The account id of the expected bucket owner. If the bucket is owned
2947
+ # The account ID of the expected bucket owner. If the bucket is owned
2893
2948
  # by a different account, the request will fail with an HTTP `403
2894
2949
  # (Access Denied)` error.
2895
2950
  # @return [String]
@@ -2916,8 +2971,8 @@ module Aws::S3
2916
2971
  # @return [String]
2917
2972
  #
2918
2973
  # @!attribute [rw] errors
2919
- # Container for a failed delete operation that describes the object
2920
- # that Amazon S3 attempted to delete and the error it encountered.
2974
+ # Container for a failed delete action that describes the object that
2975
+ # Amazon S3 attempted to delete and the error it encountered.
2921
2976
  # @return [Array<Types::Error>]
2922
2977
  #
2923
2978
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjectsOutput AWS API Documentation
@@ -2953,28 +3008,28 @@ module Aws::S3
2953
3008
  # @!attribute [rw] bucket
2954
3009
  # The bucket name containing the objects to delete.
2955
3010
  #
2956
- # When using this API with an access point, you must direct requests
2957
- # to the access point hostname. The access point hostname takes the
2958
- # form
3011
+ # When using this action with an access point, you must direct
3012
+ # requests to the access point hostname. The access point hostname
3013
+ # takes the form
2959
3014
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
2960
- # When using this operation with an access point through the AWS SDKs,
2961
- # you provide the access point ARN in place of the bucket name. For
2962
- # more information about access point ARNs, see [Using Access
2963
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
3015
+ # When using this action with an access point through the Amazon Web
3016
+ # Services SDKs, you provide the access point ARN in place of the
3017
+ # bucket name. For more information about access point ARNs, see
3018
+ # [Using access points][1] in the *Amazon S3 User Guide*.
2964
3019
  #
2965
- # When using this API with Amazon S3 on Outposts, you must direct
3020
+ # When using this action with Amazon S3 on Outposts, you must direct
2966
3021
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
2967
3022
  # takes the form
2968
3023
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
2969
- # When using this operation using S3 on Outposts through the AWS SDKs,
2970
- # you provide the Outposts bucket ARN in place of the bucket name. For
2971
- # more information about S3 on Outposts ARNs, see [Using S3 on
2972
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
3024
+ # When using this action using S3 on Outposts through the Amazon Web
3025
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
3026
+ # bucket name. For more information about S3 on Outposts ARNs, see
3027
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
2973
3028
  #
2974
3029
  #
2975
3030
  #
2976
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
2977
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
3031
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
3032
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
2978
3033
  # @return [String]
2979
3034
  #
2980
3035
  # @!attribute [rw] delete
@@ -2993,7 +3048,7 @@ module Aws::S3
2993
3048
  # request. Bucket owners need not specify this parameter in their
2994
3049
  # requests. For information about downloading objects from requester
2995
3050
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
2996
- # in the *Amazon S3 Developer Guide*.
3051
+ # in the *Amazon S3 User Guide*.
2997
3052
  #
2998
3053
  #
2999
3054
  #
@@ -3002,12 +3057,12 @@ module Aws::S3
3002
3057
  #
3003
3058
  # @!attribute [rw] bypass_governance_retention
3004
3059
  # Specifies whether you want to delete this object even if it has a
3005
- # Governance-type Object Lock in place. You must have sufficient
3006
- # permissions to perform this operation.
3060
+ # Governance-type Object Lock in place. To use this header, you must
3061
+ # have the `s3:PutBucketPublicAccessBlock` permission.
3007
3062
  # @return [Boolean]
3008
3063
  #
3009
3064
  # @!attribute [rw] expected_bucket_owner
3010
- # The account id of the expected bucket owner. If the bucket is owned
3065
+ # The account ID of the expected bucket owner. If the bucket is owned
3011
3066
  # by a different account, the request will fail with an HTTP `403
3012
3067
  # (Access Denied)` error.
3013
3068
  # @return [String]
@@ -3039,7 +3094,7 @@ module Aws::S3
3039
3094
  # @return [String]
3040
3095
  #
3041
3096
  # @!attribute [rw] expected_bucket_owner
3042
- # The account id of the expected bucket owner. If the bucket is owned
3097
+ # The account ID of the expected bucket owner. If the bucket is owned
3043
3098
  # by a different account, the request will fail with an HTTP `403
3044
3099
  # (Access Denied)` error.
3045
3100
  # @return [String]
@@ -3126,12 +3181,12 @@ module Aws::S3
3126
3181
  #
3127
3182
  # @!attribute [rw] account
3128
3183
  # Destination bucket owner account ID. In a cross-account scenario, if
3129
- # you direct Amazon S3 to change replica ownership to the AWS account
3130
- # that owns the destination bucket by specifying the
3184
+ # you direct Amazon S3 to change replica ownership to the Amazon Web
3185
+ # Services account that owns the destination bucket by specifying the
3131
3186
  # `AccessControlTranslation` property, this is the account ID of the
3132
3187
  # destination bucket owner. For more information, see [Replication
3133
3188
  # Additional Configuration: Changing the Replica Owner][1] in the
3134
- # *Amazon Simple Storage Service Developer Guide*.
3189
+ # *Amazon S3 User Guide*.
3135
3190
  #
3136
3191
  #
3137
3192
  #
@@ -3144,8 +3199,7 @@ module Aws::S3
3144
3199
  # storage class of the source object to create the object replica.
3145
3200
  #
3146
3201
  # For valid values, see the `StorageClass` element of the [PUT Bucket
3147
- # replication][1] action in the *Amazon Simple Storage Service API
3148
- # Reference*.
3202
+ # replication][1] action in the *Amazon S3 API Reference*.
3149
3203
  #
3150
3204
  #
3151
3205
  #
@@ -3155,10 +3209,10 @@ module Aws::S3
3155
3209
  # @!attribute [rw] access_control_translation
3156
3210
  # Specify this only in a cross-account scenario (where source and
3157
3211
  # destination bucket owners are not the same), and you want to change
3158
- # replica ownership to the AWS account that owns the destination
3159
- # bucket. If this is not specified in the replication configuration,
3160
- # the replicas are owned by same AWS account that owns the source
3161
- # object.
3212
+ # replica ownership to the Amazon Web Services account that owns the
3213
+ # destination bucket. If this is not specified in the replication
3214
+ # configuration, the replicas are owned by same Amazon Web Services
3215
+ # account that owns the source object.
3162
3216
  # @return [Types::AccessControlTranslation]
3163
3217
  #
3164
3218
  # @!attribute [rw] encryption_configuration
@@ -3211,10 +3265,10 @@ module Aws::S3
3211
3265
  #
3212
3266
  # @!attribute [rw] kms_key_id
3213
3267
  # If the encryption type is `aws:kms`, this optional value specifies
3214
- # the ID of the symmetric customer managed AWS KMS CMK to use for
3215
- # encryption of job results. Amazon S3 only supports symmetric CMKs.
3216
- # For more information, see [Using Symmetric and Asymmetric Keys][1]
3217
- # in the *AWS Key Management Service Developer Guide*.
3268
+ # the ID of the symmetric customer managed key to use for encryption
3269
+ # of job results. Amazon S3 only supports symmetric keys. For more
3270
+ # information, see [Using symmetric and asymmetric keys][1] in the
3271
+ # *Amazon Web Services Key Management Service Developer Guide*.
3218
3272
  #
3219
3273
  #
3220
3274
  #
@@ -3248,11 +3302,12 @@ module Aws::S3
3248
3302
  #
3249
3303
  # @!attribute [rw] replica_kms_key_id
3250
3304
  # Specifies the ID (Key ARN or Alias ARN) of the customer managed
3251
- # customer master key (CMK) stored in AWS Key Management Service (KMS)
3252
- # for the destination bucket. Amazon S3 uses this key to encrypt
3253
- # replica objects. Amazon S3 only supports symmetric customer managed
3254
- # CMKs. For more information, see [Using Symmetric and Asymmetric
3255
- # Keys][1] in the *AWS Key Management Service Developer Guide*.
3305
+ # Amazon Web Services KMS key stored in Amazon Web Services Key
3306
+ # Management Service (KMS) for the destination bucket. Amazon S3 uses
3307
+ # this key to encrypt replica objects. Amazon S3 only supports
3308
+ # symmetric, customer managed KMS keys. For more information, see
3309
+ # [Using symmetric and asymmetric keys][1] in the *Amazon Web Services
3310
+ # Key Management Service Developer Guide*.
3256
3311
  #
3257
3312
  #
3258
3313
  #
@@ -3306,9 +3361,9 @@ module Aws::S3
3306
3361
  #
3307
3362
  # * * *Code:* AccountProblem
3308
3363
  #
3309
- # * *Description:* There is a problem with your AWS account that
3310
- # prevents the operation from completing successfully. Contact AWS
3311
- # Support for further assistance.
3364
+ # * *Description:* There is a problem with your Amazon Web Services
3365
+ # account that prevents the action from completing successfully.
3366
+ # Contact Amazon Web Services Support for further assistance.
3312
3367
  #
3313
3368
  # * *HTTP Status Code:* 403 Forbidden
3314
3369
  #
@@ -3317,7 +3372,8 @@ module Aws::S3
3317
3372
  # * * *Code:* AllAccessDisabled
3318
3373
  #
3319
3374
  # * *Description:* All access to this Amazon S3 resource has been
3320
- # disabled. Contact AWS Support for further assistance.
3375
+ # disabled. Contact Amazon Web Services Support for further
3376
+ # assistance.
3321
3377
  #
3322
3378
  # * *HTTP Status Code:* 403 Forbidden
3323
3379
  #
@@ -3362,11 +3418,11 @@ module Aws::S3
3362
3418
  # * * *Code:* BucketAlreadyOwnedByYou
3363
3419
  #
3364
3420
  # * *Description:* The bucket you tried to create already exists,
3365
- # and you own it. Amazon S3 returns this error in all AWS Regions
3366
- # except in the North Virginia Region. For legacy compatibility,
3367
- # if you re-create an existing bucket that you already own in the
3368
- # North Virginia Region, Amazon S3 returns 200 OK and resets the
3369
- # bucket access control lists (ACLs).
3421
+ # and you own it. Amazon S3 returns this error in all Amazon Web
3422
+ # Services Regions except in the North Virginia Region. For legacy
3423
+ # compatibility, if you re-create an existing bucket that you
3424
+ # already own in the North Virginia Region, Amazon S3 returns 200
3425
+ # OK and resets the bucket access control lists (ACLs).
3370
3426
  #
3371
3427
  # * *Code:* 409 Conflict (in all Regions except the North Virginia
3372
3428
  # Region)
@@ -3471,8 +3527,8 @@ module Aws::S3
3471
3527
  #
3472
3528
  # * * *Code:* InvalidAccessKeyId
3473
3529
  #
3474
- # * *Description:* The AWS access key ID you provided does not exist
3475
- # in our records.
3530
+ # * *Description:* The Amazon Web Services access key ID you
3531
+ # provided does not exist in our records.
3476
3532
  #
3477
3533
  # * *HTTP Status Code:* 403 Forbidden
3478
3534
  #
@@ -3540,8 +3596,8 @@ module Aws::S3
3540
3596
  #
3541
3597
  # * * *Code:* InvalidObjectState
3542
3598
  #
3543
- # * *Description:* The operation is not valid for the current state
3544
- # of the object.
3599
+ # * *Description:* The action is not valid for the current state of
3600
+ # the object.
3545
3601
  #
3546
3602
  # * *HTTP Status Code:* 403 Forbidden
3547
3603
  #
@@ -3569,7 +3625,8 @@ module Aws::S3
3569
3625
  # * * *Code:* InvalidPayer
3570
3626
  #
3571
3627
  # * *Description:* All access to this object has been disabled.
3572
- # Please contact AWS Support for further assistance.
3628
+ # Please contact Amazon Web Services Support for further
3629
+ # assistance.
3573
3630
  #
3574
3631
  # * *HTTP Status Code:* 403 Forbidden
3575
3632
  #
@@ -3594,7 +3651,7 @@ module Aws::S3
3594
3651
  #
3595
3652
  # * * *Code:* InvalidRequest
3596
3653
  #
3597
- # * *Description:* Please use AWS4-HMAC-SHA256.
3654
+ # * *Description:* Please use `AWS4-HMAC-SHA256`.
3598
3655
  #
3599
3656
  # * *HTTP Status Code:* 400 Bad Request
3600
3657
  #
@@ -3657,7 +3714,8 @@ module Aws::S3
3657
3714
  # * * *Code:* InvalidRequest
3658
3715
  #
3659
3716
  # * *Description:* Amazon S3 Transfer Acceleration is not supported
3660
- # on this bucket. Contact AWS Support for more information.
3717
+ # on this bucket. Contact Amazon Web Services Support for more
3718
+ # information.
3661
3719
  #
3662
3720
  # * *HTTP Status Code:* 400 Bad Request
3663
3721
  #
@@ -3666,7 +3724,8 @@ module Aws::S3
3666
3724
  # * * *Code:* InvalidRequest
3667
3725
  #
3668
3726
  # * *Description:* Amazon S3 Transfer Acceleration cannot be enabled
3669
- # on this bucket. Contact AWS Support for more information.
3727
+ # on this bucket. Contact Amazon Web Services Support for more
3728
+ # information.
3670
3729
  #
3671
3730
  # * *HTTP Status Code:* 400 Bad Request
3672
3731
  #
@@ -3914,7 +3973,7 @@ module Aws::S3
3914
3973
  #
3915
3974
  # * *Description:* Your account is not signed up for the Amazon S3
3916
3975
  # service. You must sign up before you can use Amazon S3. You can
3917
- # sign up at the following URL: https://aws.amazon.com/s3
3976
+ # sign up at the following URL: [Amazon S3][2]
3918
3977
  #
3919
3978
  # * *HTTP Status Code:* 403 Forbidden
3920
3979
  #
@@ -3922,8 +3981,8 @@ module Aws::S3
3922
3981
  #
3923
3982
  # * * *Code:* OperationAborted
3924
3983
  #
3925
- # * *Description:* A conflicting conditional operation is currently
3926
- # in progress against this resource. Try again.
3984
+ # * *Description:* A conflicting conditional action is currently in
3985
+ # progress against this resource. Try again.
3927
3986
  #
3928
3987
  # * *HTTP Status Code:* 409 Conflict
3929
3988
  #
@@ -4003,9 +4062,10 @@ module Aws::S3
4003
4062
  # * * *Code:* SignatureDoesNotMatch
4004
4063
  #
4005
4064
  # * *Description:* The request signature we calculated does not
4006
- # match the signature you provided. Check your AWS secret access
4007
- # key and signing method. For more information, see [REST
4008
- # Authentication][2] and [SOAP Authentication][3] for details.
4065
+ # match the signature you provided. Check your Amazon Web Services
4066
+ # secret access key and signing method. For more information, see
4067
+ # [REST Authentication][3] and [SOAP Authentication][4] for
4068
+ # details.
4009
4069
  #
4010
4070
  # * *HTTP Status Code:* 403 Forbidden
4011
4071
  #
@@ -4084,8 +4144,9 @@ module Aws::S3
4084
4144
  #
4085
4145
  #
4086
4146
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro
4087
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
4088
- # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/SOAPAuthentication.html
4147
+ # [2]: http://aws.amazon.com/s3
4148
+ # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
4149
+ # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/SOAPAuthentication.html
4089
4150
  # @return [String]
4090
4151
  #
4091
4152
  # @!attribute [rw] message
@@ -4120,6 +4181,14 @@ module Aws::S3
4120
4181
  #
4121
4182
  # @!attribute [rw] key
4122
4183
  # The object key name to use when a 4XX class error occurs.
4184
+ #
4185
+ # Replacement must be made for object keys containing special
4186
+ # characters (such as carriage returns) when using XML requests. For
4187
+ # more information, see [ XML related object key constraints][1].
4188
+ #
4189
+ #
4190
+ #
4191
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
4123
4192
  # @return [String]
4124
4193
  #
4125
4194
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ErrorDocument AWS API Documentation
@@ -4131,9 +4200,12 @@ module Aws::S3
4131
4200
  end
4132
4201
 
4133
4202
  # Optional configuration to replicate existing source bucket objects.
4134
- # For more information, see [Replicating Existing Objects](
4135
- # https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication)
4136
- # in the *Amazon S3 Developer Guide*.
4203
+ # For more information, see [Replicating Existing Objects][1] in the
4204
+ # *Amazon S3 User Guide*.
4205
+ #
4206
+ #
4207
+ #
4208
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication
4137
4209
  #
4138
4210
  # @note When making an API call, you may pass ExistingObjectReplication
4139
4211
  # data as a hash:
@@ -4169,7 +4241,7 @@ module Aws::S3
4169
4241
  # to which the filtering rule applies. The maximum length is 1,024
4170
4242
  # characters. Overlapping prefixes and suffixes are not supported. For
4171
4243
  # more information, see [Configuring Event Notifications][1] in the
4172
- # *Amazon Simple Storage Service Developer Guide*.
4244
+ # *Amazon S3 User Guide*.
4173
4245
  #
4174
4246
  #
4175
4247
  #
@@ -4215,7 +4287,7 @@ module Aws::S3
4215
4287
  # @return [String]
4216
4288
  #
4217
4289
  # @!attribute [rw] expected_bucket_owner
4218
- # The account id of the expected bucket owner. If the bucket is owned
4290
+ # The account ID of the expected bucket owner. If the bucket is owned
4219
4291
  # by a different account, the request will fail with an HTTP `403
4220
4292
  # (Access Denied)` error.
4221
4293
  # @return [String]
@@ -4259,7 +4331,7 @@ module Aws::S3
4259
4331
  # @return [String]
4260
4332
  #
4261
4333
  # @!attribute [rw] expected_bucket_owner
4262
- # The account id of the expected bucket owner. If the bucket is owned
4334
+ # The account ID of the expected bucket owner. If the bucket is owned
4263
4335
  # by a different account, the request will fail with an HTTP `403
4264
4336
  # (Access Denied)` error.
4265
4337
  # @return [String]
@@ -4304,7 +4376,7 @@ module Aws::S3
4304
4376
  # @return [String]
4305
4377
  #
4306
4378
  # @!attribute [rw] expected_bucket_owner
4307
- # The account id of the expected bucket owner. If the bucket is owned
4379
+ # The account ID of the expected bucket owner. If the bucket is owned
4308
4380
  # by a different account, the request will fail with an HTTP `403
4309
4381
  # (Access Denied)` error.
4310
4382
  # @return [String]
@@ -4345,7 +4417,7 @@ module Aws::S3
4345
4417
  # @return [String]
4346
4418
  #
4347
4419
  # @!attribute [rw] expected_bucket_owner
4348
- # The account id of the expected bucket owner. If the bucket is owned
4420
+ # The account ID of the expected bucket owner. If the bucket is owned
4349
4421
  # by a different account, the request will fail with an HTTP `403
4350
4422
  # (Access Denied)` error.
4351
4423
  # @return [String]
@@ -4385,7 +4457,7 @@ module Aws::S3
4385
4457
  # @return [String]
4386
4458
  #
4387
4459
  # @!attribute [rw] expected_bucket_owner
4388
- # The account id of the expected bucket owner. If the bucket is owned
4460
+ # The account ID of the expected bucket owner. If the bucket is owned
4389
4461
  # by a different account, the request will fail with an HTTP `403
4390
4462
  # (Access Denied)` error.
4391
4463
  # @return [String]
@@ -4468,7 +4540,7 @@ module Aws::S3
4468
4540
  # @return [String]
4469
4541
  #
4470
4542
  # @!attribute [rw] expected_bucket_owner
4471
- # The account id of the expected bucket owner. If the bucket is owned
4543
+ # The account ID of the expected bucket owner. If the bucket is owned
4472
4544
  # by a different account, the request will fail with an HTTP `403
4473
4545
  # (Access Denied)` error.
4474
4546
  # @return [String]
@@ -4508,7 +4580,7 @@ module Aws::S3
4508
4580
  # @return [String]
4509
4581
  #
4510
4582
  # @!attribute [rw] expected_bucket_owner
4511
- # The account id of the expected bucket owner. If the bucket is owned
4583
+ # The account ID of the expected bucket owner. If the bucket is owned
4512
4584
  # by a different account, the request will fail with an HTTP `403
4513
4585
  # (Access Denied)` error.
4514
4586
  # @return [String]
@@ -4547,7 +4619,7 @@ module Aws::S3
4547
4619
  # @return [String]
4548
4620
  #
4549
4621
  # @!attribute [rw] expected_bucket_owner
4550
- # The account id of the expected bucket owner. If the bucket is owned
4622
+ # The account ID of the expected bucket owner. If the bucket is owned
4551
4623
  # by a different account, the request will fail with an HTTP `403
4552
4624
  # (Access Denied)` error.
4553
4625
  # @return [String]
@@ -4593,7 +4665,7 @@ module Aws::S3
4593
4665
  # @return [String]
4594
4666
  #
4595
4667
  # @!attribute [rw] expected_bucket_owner
4596
- # The account id of the expected bucket owner. If the bucket is owned
4668
+ # The account ID of the expected bucket owner. If the bucket is owned
4597
4669
  # by a different account, the request will fail with an HTTP `403
4598
4670
  # (Access Denied)` error.
4599
4671
  # @return [String]
@@ -4610,8 +4682,7 @@ module Aws::S3
4610
4682
  # @!attribute [rw] logging_enabled
4611
4683
  # Describes where logs are stored and the prefix that Amazon S3
4612
4684
  # assigns to all log object keys for a bucket. For more information,
4613
- # see [PUT Bucket logging][1] in the *Amazon Simple Storage Service
4614
- # API Reference*.
4685
+ # see [PUT Bucket logging][1] in the *Amazon S3 API Reference*.
4615
4686
  #
4616
4687
  #
4617
4688
  #
@@ -4639,7 +4710,7 @@ module Aws::S3
4639
4710
  # @return [String]
4640
4711
  #
4641
4712
  # @!attribute [rw] expected_bucket_owner
4642
- # The account id of the expected bucket owner. If the bucket is owned
4713
+ # The account ID of the expected bucket owner. If the bucket is owned
4643
4714
  # by a different account, the request will fail with an HTTP `403
4644
4715
  # (Access Denied)` error.
4645
4716
  # @return [String]
@@ -4684,7 +4755,7 @@ module Aws::S3
4684
4755
  # @return [String]
4685
4756
  #
4686
4757
  # @!attribute [rw] expected_bucket_owner
4687
- # The account id of the expected bucket owner. If the bucket is owned
4758
+ # The account ID of the expected bucket owner. If the bucket is owned
4688
4759
  # by a different account, the request will fail with an HTTP `403
4689
4760
  # (Access Denied)` error.
4690
4761
  # @return [String]
@@ -4713,7 +4784,7 @@ module Aws::S3
4713
4784
  # @return [String]
4714
4785
  #
4715
4786
  # @!attribute [rw] expected_bucket_owner
4716
- # The account id of the expected bucket owner. If the bucket is owned
4787
+ # The account ID of the expected bucket owner. If the bucket is owned
4717
4788
  # by a different account, the request will fail with an HTTP `403
4718
4789
  # (Access Denied)` error.
4719
4790
  # @return [String]
@@ -4754,7 +4825,7 @@ module Aws::S3
4754
4825
  # @return [String]
4755
4826
  #
4756
4827
  # @!attribute [rw] expected_bucket_owner
4757
- # The account id of the expected bucket owner. If the bucket is owned
4828
+ # The account ID of the expected bucket owner. If the bucket is owned
4758
4829
  # by a different account, the request will fail with an HTTP `403
4759
4830
  # (Access Denied)` error.
4760
4831
  # @return [String]
@@ -4793,7 +4864,7 @@ module Aws::S3
4793
4864
  # @return [String]
4794
4865
  #
4795
4866
  # @!attribute [rw] expected_bucket_owner
4796
- # The account id of the expected bucket owner. If the bucket is owned
4867
+ # The account ID of the expected bucket owner. If the bucket is owned
4797
4868
  # by a different account, the request will fail with an HTTP `403
4798
4869
  # (Access Denied)` error.
4799
4870
  # @return [String]
@@ -4833,7 +4904,7 @@ module Aws::S3
4833
4904
  # @return [String]
4834
4905
  #
4835
4906
  # @!attribute [rw] expected_bucket_owner
4836
- # The account id of the expected bucket owner. If the bucket is owned
4907
+ # The account ID of the expected bucket owner. If the bucket is owned
4837
4908
  # by a different account, the request will fail with an HTTP `403
4838
4909
  # (Access Denied)` error.
4839
4910
  # @return [String]
@@ -4873,7 +4944,7 @@ module Aws::S3
4873
4944
  # @return [String]
4874
4945
  #
4875
4946
  # @!attribute [rw] expected_bucket_owner
4876
- # The account id of the expected bucket owner. If the bucket is owned
4947
+ # The account ID of the expected bucket owner. If the bucket is owned
4877
4948
  # by a different account, the request will fail with an HTTP `403
4878
4949
  # (Access Denied)` error.
4879
4950
  # @return [String]
@@ -4913,7 +4984,7 @@ module Aws::S3
4913
4984
  # @return [String]
4914
4985
  #
4915
4986
  # @!attribute [rw] expected_bucket_owner
4916
- # The account id of the expected bucket owner. If the bucket is owned
4987
+ # The account ID of the expected bucket owner. If the bucket is owned
4917
4988
  # by a different account, the request will fail with an HTTP `403
4918
4989
  # (Access Denied)` error.
4919
4990
  # @return [String]
@@ -4952,7 +5023,7 @@ module Aws::S3
4952
5023
  # @return [String]
4953
5024
  #
4954
5025
  # @!attribute [rw] expected_bucket_owner
4955
- # The account id of the expected bucket owner. If the bucket is owned
5026
+ # The account ID of the expected bucket owner. If the bucket is owned
4956
5027
  # by a different account, the request will fail with an HTTP `403
4957
5028
  # (Access Denied)` error.
4958
5029
  # @return [String]
@@ -4999,7 +5070,7 @@ module Aws::S3
4999
5070
  # @return [String]
5000
5071
  #
5001
5072
  # @!attribute [rw] expected_bucket_owner
5002
- # The account id of the expected bucket owner. If the bucket is owned
5073
+ # The account ID of the expected bucket owner. If the bucket is owned
5003
5074
  # by a different account, the request will fail with an HTTP `403
5004
5075
  # (Access Denied)` error.
5005
5076
  # @return [String]
@@ -5057,7 +5128,7 @@ module Aws::S3
5057
5128
  # @return [String]
5058
5129
  #
5059
5130
  # @!attribute [rw] expected_bucket_owner
5060
- # The account id of the expected bucket owner. If the bucket is owned
5131
+ # The account ID of the expected bucket owner. If the bucket is owned
5061
5132
  # by a different account, the request will fail with an HTTP `403
5062
5133
  # (Access Denied)` error.
5063
5134
  # @return [String]
@@ -5109,18 +5180,18 @@ module Aws::S3
5109
5180
  # The bucket name that contains the object for which to get the ACL
5110
5181
  # information.
5111
5182
  #
5112
- # When using this API with an access point, you must direct requests
5113
- # to the access point hostname. The access point hostname takes the
5114
- # form
5183
+ # When using this action with an access point, you must direct
5184
+ # requests to the access point hostname. The access point hostname
5185
+ # takes the form
5115
5186
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
5116
- # When using this operation with an access point through the AWS SDKs,
5117
- # you provide the access point ARN in place of the bucket name. For
5118
- # more information about access point ARNs, see [Using Access
5119
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
5187
+ # When using this action with an access point through the Amazon Web
5188
+ # Services SDKs, you provide the access point ARN in place of the
5189
+ # bucket name. For more information about access point ARNs, see
5190
+ # [Using access points][1] in the *Amazon S3 User Guide*.
5120
5191
  #
5121
5192
  #
5122
5193
  #
5123
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
5194
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
5124
5195
  # @return [String]
5125
5196
  #
5126
5197
  # @!attribute [rw] key
@@ -5136,7 +5207,7 @@ module Aws::S3
5136
5207
  # request. Bucket owners need not specify this parameter in their
5137
5208
  # requests. For information about downloading objects from requester
5138
5209
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
5139
- # in the *Amazon S3 Developer Guide*.
5210
+ # in the *Amazon S3 User Guide*.
5140
5211
  #
5141
5212
  #
5142
5213
  #
@@ -5144,7 +5215,7 @@ module Aws::S3
5144
5215
  # @return [String]
5145
5216
  #
5146
5217
  # @!attribute [rw] expected_bucket_owner
5147
- # The account id of the expected bucket owner. If the bucket is owned
5218
+ # The account ID of the expected bucket owner. If the bucket is owned
5148
5219
  # by a different account, the request will fail with an HTTP `403
5149
5220
  # (Access Denied)` error.
5150
5221
  # @return [String]
@@ -5188,18 +5259,18 @@ module Aws::S3
5188
5259
  # The bucket name containing the object whose Legal Hold status you
5189
5260
  # want to retrieve.
5190
5261
  #
5191
- # When using this API with an access point, you must direct requests
5192
- # to the access point hostname. The access point hostname takes the
5193
- # form
5262
+ # When using this action with an access point, you must direct
5263
+ # requests to the access point hostname. The access point hostname
5264
+ # takes the form
5194
5265
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
5195
- # When using this operation with an access point through the AWS SDKs,
5196
- # you provide the access point ARN in place of the bucket name. For
5197
- # more information about access point ARNs, see [Using Access
5198
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
5266
+ # When using this action with an access point through the Amazon Web
5267
+ # Services SDKs, you provide the access point ARN in place of the
5268
+ # bucket name. For more information about access point ARNs, see
5269
+ # [Using access points][1] in the *Amazon S3 User Guide*.
5199
5270
  #
5200
5271
  #
5201
5272
  #
5202
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
5273
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
5203
5274
  # @return [String]
5204
5275
  #
5205
5276
  # @!attribute [rw] key
@@ -5217,7 +5288,7 @@ module Aws::S3
5217
5288
  # request. Bucket owners need not specify this parameter in their
5218
5289
  # requests. For information about downloading objects from requester
5219
5290
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
5220
- # in the *Amazon S3 Developer Guide*.
5291
+ # in the *Amazon S3 User Guide*.
5221
5292
  #
5222
5293
  #
5223
5294
  #
@@ -5225,7 +5296,7 @@ module Aws::S3
5225
5296
  # @return [String]
5226
5297
  #
5227
5298
  # @!attribute [rw] expected_bucket_owner
5228
- # The account id of the expected bucket owner. If the bucket is owned
5299
+ # The account ID of the expected bucket owner. If the bucket is owned
5229
5300
  # by a different account, the request will fail with an HTTP `403
5230
5301
  # (Access Denied)` error.
5231
5302
  # @return [String]
@@ -5265,22 +5336,22 @@ module Aws::S3
5265
5336
  # @!attribute [rw] bucket
5266
5337
  # The bucket whose Object Lock configuration you want to retrieve.
5267
5338
  #
5268
- # When using this API with an access point, you must direct requests
5269
- # to the access point hostname. The access point hostname takes the
5270
- # form
5339
+ # When using this action with an access point, you must direct
5340
+ # requests to the access point hostname. The access point hostname
5341
+ # takes the form
5271
5342
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
5272
- # When using this operation with an access point through the AWS SDKs,
5273
- # you provide the access point ARN in place of the bucket name. For
5274
- # more information about access point ARNs, see [Using Access
5275
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
5343
+ # When using this action with an access point through the Amazon Web
5344
+ # Services SDKs, you provide the access point ARN in place of the
5345
+ # bucket name. For more information about access point ARNs, see
5346
+ # [Using access points][1] in the *Amazon S3 User Guide*.
5276
5347
  #
5277
5348
  #
5278
5349
  #
5279
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
5350
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
5280
5351
  # @return [String]
5281
5352
  #
5282
5353
  # @!attribute [rw] expected_bucket_owner
5283
- # The account id of the expected bucket owner. If the bucket is owned
5354
+ # The account ID of the expected bucket owner. If the bucket is owned
5284
5355
  # by a different account, the request will fail with an HTTP `403
5285
5356
  # (Access Denied)` error.
5286
5357
  # @return [String]
@@ -5316,12 +5387,12 @@ module Aws::S3
5316
5387
  # @return [String]
5317
5388
  #
5318
5389
  # @!attribute [rw] restore
5319
- # Provides information about object restoration operation and
5320
- # expiration time of the restored object copy.
5390
+ # Provides information about object restoration action and expiration
5391
+ # time of the restored object copy.
5321
5392
  # @return [String]
5322
5393
  #
5323
5394
  # @!attribute [rw] last_modified
5324
- # Last modified date of the object
5395
+ # Creation date of the object.
5325
5396
  # @return [Time]
5326
5397
  #
5327
5398
  # @!attribute [rw] content_length
@@ -5408,14 +5479,14 @@ module Aws::S3
5408
5479
  # @return [String]
5409
5480
  #
5410
5481
  # @!attribute [rw] ssekms_key_id
5411
- # If present, specifies the ID of the AWS Key Management Service (AWS
5412
- # KMS) symmetric customer managed customer master key (CMK) that was
5413
- # used for the object.
5482
+ # If present, specifies the ID of the Amazon Web Services Key
5483
+ # Management Service (Amazon Web Services KMS) symmetric customer
5484
+ # managed key that was used for the object.
5414
5485
  # @return [String]
5415
5486
  #
5416
5487
  # @!attribute [rw] bucket_key_enabled
5417
5488
  # Indicates whether the object uses an S3 Bucket Key for server-side
5418
- # encryption with AWS KMS (SSE-KMS).
5489
+ # encryption with Amazon Web Services KMS (SSE-KMS).
5419
5490
  # @return [Boolean]
5420
5491
  #
5421
5492
  # @!attribute [rw] storage_class
@@ -5525,28 +5596,31 @@ module Aws::S3
5525
5596
  # @!attribute [rw] bucket
5526
5597
  # The bucket name containing the object.
5527
5598
  #
5528
- # When using this API with an access point, you must direct requests
5529
- # to the access point hostname. The access point hostname takes the
5530
- # form
5599
+ # When using this action with an access point, you must direct
5600
+ # requests to the access point hostname. The access point hostname
5601
+ # takes the form
5531
5602
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
5532
- # When using this operation with an access point through the AWS SDKs,
5533
- # you provide the access point ARN in place of the bucket name. For
5534
- # more information about access point ARNs, see [Using Access
5535
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
5603
+ # When using this action with an access point through the Amazon Web
5604
+ # Services SDKs, you provide the access point ARN in place of the
5605
+ # bucket name. For more information about access point ARNs, see
5606
+ # [Using access points][1] in the *Amazon S3 User Guide*.
5607
+ #
5608
+ # When using an Object Lambda access point the hostname takes the form
5609
+ # *AccessPointName*-*AccountId*.s3-object-lambda.*Region*.amazonaws.com.
5536
5610
  #
5537
- # When using this API with Amazon S3 on Outposts, you must direct
5611
+ # When using this action with Amazon S3 on Outposts, you must direct
5538
5612
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
5539
5613
  # takes the form
5540
5614
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
5541
- # When using this operation using S3 on Outposts through the AWS SDKs,
5542
- # you provide the Outposts bucket ARN in place of the bucket name. For
5543
- # more information about S3 on Outposts ARNs, see [Using S3 on
5544
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
5615
+ # When using this action using S3 on Outposts through the Amazon Web
5616
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
5617
+ # bucket name. For more information about S3 on Outposts ARNs, see
5618
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
5545
5619
  #
5546
5620
  #
5547
5621
  #
5548
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
5549
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
5622
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
5623
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
5550
5624
  # @return [String]
5551
5625
  #
5552
5626
  # @!attribute [rw] if_match
@@ -5617,14 +5691,14 @@ module Aws::S3
5617
5691
  # @return [String]
5618
5692
  #
5619
5693
  # @!attribute [rw] sse_customer_algorithm
5620
- # Specifies the algorithm to use to when encrypting the object (for
5694
+ # Specifies the algorithm to use to when decrypting the object (for
5621
5695
  # example, AES256).
5622
5696
  # @return [String]
5623
5697
  #
5624
5698
  # @!attribute [rw] sse_customer_key
5625
- # Specifies the customer-provided encryption key for Amazon S3 to use
5626
- # in encrypting data. This value is used to store the object and then
5627
- # it is discarded; Amazon S3 does not store the encryption key. The
5699
+ # Specifies the customer-provided encryption key for Amazon S3 used to
5700
+ # encrypt the data. This value is used to decrypt the object when
5701
+ # recovering it and must match the one used when storing the data. The
5628
5702
  # key must be appropriate for use with the algorithm specified in the
5629
5703
  # `x-amz-server-side-encryption-customer-algorithm` header.
5630
5704
  # @return [String]
@@ -5640,7 +5714,7 @@ module Aws::S3
5640
5714
  # request. Bucket owners need not specify this parameter in their
5641
5715
  # requests. For information about downloading objects from requester
5642
5716
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
5643
- # in the *Amazon S3 Developer Guide*.
5717
+ # in the *Amazon S3 User Guide*.
5644
5718
  #
5645
5719
  #
5646
5720
  #
@@ -5655,7 +5729,7 @@ module Aws::S3
5655
5729
  # @return [Integer]
5656
5730
  #
5657
5731
  # @!attribute [rw] expected_bucket_owner
5658
- # The account id of the expected bucket owner. If the bucket is owned
5732
+ # The account ID of the expected bucket owner. If the bucket is owned
5659
5733
  # by a different account, the request will fail with an HTTP `403
5660
5734
  # (Access Denied)` error.
5661
5735
  # @return [String]
@@ -5714,18 +5788,18 @@ module Aws::S3
5714
5788
  # The bucket name containing the object whose retention settings you
5715
5789
  # want to retrieve.
5716
5790
  #
5717
- # When using this API with an access point, you must direct requests
5718
- # to the access point hostname. The access point hostname takes the
5719
- # form
5791
+ # When using this action with an access point, you must direct
5792
+ # requests to the access point hostname. The access point hostname
5793
+ # takes the form
5720
5794
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
5721
- # When using this operation with an access point through the AWS SDKs,
5722
- # you provide the access point ARN in place of the bucket name. For
5723
- # more information about access point ARNs, see [Using Access
5724
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
5795
+ # When using this action with an access point through the Amazon Web
5796
+ # Services SDKs, you provide the access point ARN in place of the
5797
+ # bucket name. For more information about access point ARNs, see
5798
+ # [Using access points][1] in the *Amazon S3 User Guide*.
5725
5799
  #
5726
5800
  #
5727
5801
  #
5728
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
5802
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
5729
5803
  # @return [String]
5730
5804
  #
5731
5805
  # @!attribute [rw] key
@@ -5743,7 +5817,7 @@ module Aws::S3
5743
5817
  # request. Bucket owners need not specify this parameter in their
5744
5818
  # requests. For information about downloading objects from requester
5745
5819
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
5746
- # in the *Amazon S3 Developer Guide*.
5820
+ # in the *Amazon S3 User Guide*.
5747
5821
  #
5748
5822
  #
5749
5823
  #
@@ -5751,7 +5825,7 @@ module Aws::S3
5751
5825
  # @return [String]
5752
5826
  #
5753
5827
  # @!attribute [rw] expected_bucket_owner
5754
- # The account id of the expected bucket owner. If the bucket is owned
5828
+ # The account ID of the expected bucket owner. If the bucket is owned
5755
5829
  # by a different account, the request will fail with an HTTP `403
5756
5830
  # (Access Denied)` error.
5757
5831
  # @return [String]
@@ -5794,34 +5868,35 @@ module Aws::S3
5794
5868
  # key: "ObjectKey", # required
5795
5869
  # version_id: "ObjectVersionId",
5796
5870
  # expected_bucket_owner: "AccountId",
5871
+ # request_payer: "requester", # accepts requester
5797
5872
  # }
5798
5873
  #
5799
5874
  # @!attribute [rw] bucket
5800
5875
  # The bucket name containing the object for which to get the tagging
5801
5876
  # information.
5802
5877
  #
5803
- # When using this API with an access point, you must direct requests
5804
- # to the access point hostname. The access point hostname takes the
5805
- # form
5878
+ # When using this action with an access point, you must direct
5879
+ # requests to the access point hostname. The access point hostname
5880
+ # takes the form
5806
5881
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
5807
- # When using this operation with an access point through the AWS SDKs,
5808
- # you provide the access point ARN in place of the bucket name. For
5809
- # more information about access point ARNs, see [Using Access
5810
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
5882
+ # When using this action with an access point through the Amazon Web
5883
+ # Services SDKs, you provide the access point ARN in place of the
5884
+ # bucket name. For more information about access point ARNs, see
5885
+ # [Using access points][1] in the *Amazon S3 User Guide*.
5811
5886
  #
5812
- # When using this API with Amazon S3 on Outposts, you must direct
5887
+ # When using this action with Amazon S3 on Outposts, you must direct
5813
5888
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
5814
5889
  # takes the form
5815
5890
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
5816
- # When using this operation using S3 on Outposts through the AWS SDKs,
5817
- # you provide the Outposts bucket ARN in place of the bucket name. For
5818
- # more information about S3 on Outposts ARNs, see [Using S3 on
5819
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
5891
+ # When using this action using S3 on Outposts through the Amazon Web
5892
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
5893
+ # bucket name. For more information about S3 on Outposts ARNs, see
5894
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
5820
5895
  #
5821
5896
  #
5822
5897
  #
5823
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
5824
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
5898
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
5899
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
5825
5900
  # @return [String]
5826
5901
  #
5827
5902
  # @!attribute [rw] key
@@ -5834,18 +5909,31 @@ module Aws::S3
5834
5909
  # @return [String]
5835
5910
  #
5836
5911
  # @!attribute [rw] expected_bucket_owner
5837
- # The account id of the expected bucket owner. If the bucket is owned
5912
+ # The account ID of the expected bucket owner. If the bucket is owned
5838
5913
  # by a different account, the request will fail with an HTTP `403
5839
5914
  # (Access Denied)` error.
5840
5915
  # @return [String]
5841
5916
  #
5917
+ # @!attribute [rw] request_payer
5918
+ # Confirms that the requester knows that they will be charged for the
5919
+ # request. Bucket owners need not specify this parameter in their
5920
+ # requests. For information about downloading objects from requester
5921
+ # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
5922
+ # in the *Amazon S3 User Guide*.
5923
+ #
5924
+ #
5925
+ #
5926
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
5927
+ # @return [String]
5928
+ #
5842
5929
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTaggingRequest AWS API Documentation
5843
5930
  #
5844
5931
  class GetObjectTaggingRequest < Struct.new(
5845
5932
  :bucket,
5846
5933
  :key,
5847
5934
  :version_id,
5848
- :expected_bucket_owner)
5935
+ :expected_bucket_owner,
5936
+ :request_payer)
5849
5937
  SENSITIVE = []
5850
5938
  include Aws::Structure
5851
5939
  end
@@ -5892,7 +5980,7 @@ module Aws::S3
5892
5980
  # request. Bucket owners need not specify this parameter in their
5893
5981
  # requests. For information about downloading objects from requester
5894
5982
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
5895
- # in the *Amazon S3 Developer Guide*.
5983
+ # in the *Amazon S3 User Guide*.
5896
5984
  #
5897
5985
  #
5898
5986
  #
@@ -5900,7 +5988,7 @@ module Aws::S3
5900
5988
  # @return [String]
5901
5989
  #
5902
5990
  # @!attribute [rw] expected_bucket_owner
5903
- # The account id of the expected bucket owner. If the bucket is owned
5991
+ # The account ID of the expected bucket owner. If the bucket is owned
5904
5992
  # by a different account, the request will fail with an HTTP `403
5905
5993
  # (Access Denied)` error.
5906
5994
  # @return [String]
@@ -5943,7 +6031,7 @@ module Aws::S3
5943
6031
  # @return [String]
5944
6032
  #
5945
6033
  # @!attribute [rw] expected_bucket_owner
5946
- # The account id of the expected bucket owner. If the bucket is owned
6034
+ # The account ID of the expected bucket owner. If the bucket is owned
5947
6035
  # by a different account, the request will fail with an HTTP `403
5948
6036
  # (Access Denied)` error.
5949
6037
  # @return [String]
@@ -6032,7 +6120,7 @@ module Aws::S3
6032
6120
  # Email address of the grantee.
6033
6121
  #
6034
6122
  # <note markdown="1"> Using email addresses to specify a grantee is only supported in the
6035
- # following AWS Regions:
6123
+ # following Amazon Web Services Regions:
6036
6124
  #
6037
6125
  # * US East (N. Virginia)
6038
6126
  #
@@ -6051,7 +6139,8 @@ module Aws::S3
6051
6139
  # * South America (São Paulo)
6052
6140
  #
6053
6141
  # For a list of all the Amazon S3 supported Regions and endpoints, see
6054
- # [Regions and Endpoints][1] in the AWS General Reference.
6142
+ # [Regions and Endpoints][1] in the Amazon Web Services General
6143
+ # Reference.
6055
6144
  #
6056
6145
  # </note>
6057
6146
  #
@@ -6095,32 +6184,32 @@ module Aws::S3
6095
6184
  # @!attribute [rw] bucket
6096
6185
  # The bucket name.
6097
6186
  #
6098
- # When using this API with an access point, you must direct requests
6099
- # to the access point hostname. The access point hostname takes the
6100
- # form
6187
+ # When using this action with an access point, you must direct
6188
+ # requests to the access point hostname. The access point hostname
6189
+ # takes the form
6101
6190
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
6102
- # When using this operation with an access point through the AWS SDKs,
6103
- # you provide the access point ARN in place of the bucket name. For
6104
- # more information about access point ARNs, see [Using Access
6105
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
6191
+ # When using this action with an access point through the Amazon Web
6192
+ # Services SDKs, you provide the access point ARN in place of the
6193
+ # bucket name. For more information about access point ARNs, see
6194
+ # [Using access points][1] in the *Amazon S3 User Guide*.
6106
6195
  #
6107
- # When using this API with Amazon S3 on Outposts, you must direct
6196
+ # When using this action with Amazon S3 on Outposts, you must direct
6108
6197
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
6109
6198
  # takes the form
6110
6199
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
6111
- # When using this operation using S3 on Outposts through the AWS SDKs,
6112
- # you provide the Outposts bucket ARN in place of the bucket name. For
6113
- # more information about S3 on Outposts ARNs, see [Using S3 on
6114
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
6200
+ # When using this action using S3 on Outposts through the Amazon Web
6201
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
6202
+ # bucket name. For more information about S3 on Outposts ARNs, see
6203
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
6115
6204
  #
6116
6205
  #
6117
6206
  #
6118
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
6119
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
6207
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
6208
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
6120
6209
  # @return [String]
6121
6210
  #
6122
6211
  # @!attribute [rw] expected_bucket_owner
6123
- # The account id of the expected bucket owner. If the bucket is owned
6212
+ # The account ID of the expected bucket owner. If the bucket is owned
6124
6213
  # by a different account, the request will fail with an HTTP `403
6125
6214
  # (Access Denied)` error.
6126
6215
  # @return [String]
@@ -6160,7 +6249,7 @@ module Aws::S3
6160
6249
  # If an archive copy is already restored, the header value indicates
6161
6250
  # when Amazon S3 is scheduled to delete the object copy. For example:
6162
6251
  #
6163
- # `x-amz-restore: ongoing-request="false", expiry-date="Fri, 23 Dec
6252
+ # `x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec
6164
6253
  # 2012 00:00:00 GMT"`
6165
6254
  #
6166
6255
  # If the object restoration is in progress, the header returns the
@@ -6180,7 +6269,7 @@ module Aws::S3
6180
6269
  # @return [String]
6181
6270
  #
6182
6271
  # @!attribute [rw] last_modified
6183
- # Last modified date of the object
6272
+ # Creation date of the object.
6184
6273
  # @return [Time]
6185
6274
  #
6186
6275
  # @!attribute [rw] content_length
@@ -6242,10 +6331,10 @@ module Aws::S3
6242
6331
  #
6243
6332
  # @!attribute [rw] server_side_encryption
6244
6333
  # If the object is stored using server-side encryption either with an
6245
- # AWS KMS customer master key (CMK) or an Amazon S3-managed encryption
6246
- # key, the response includes this header with the value of the
6247
- # server-side encryption algorithm used when storing this object in
6248
- # Amazon S3 (for example, AES256, aws:kms).
6334
+ # Amazon Web Services KMS key or an Amazon S3-managed encryption key,
6335
+ # the response includes this header with the value of the server-side
6336
+ # encryption algorithm used when storing this object in Amazon S3 (for
6337
+ # example, AES256, aws:kms).
6249
6338
  # @return [String]
6250
6339
  #
6251
6340
  # @!attribute [rw] metadata
@@ -6266,14 +6355,14 @@ module Aws::S3
6266
6355
  # @return [String]
6267
6356
  #
6268
6357
  # @!attribute [rw] ssekms_key_id
6269
- # If present, specifies the ID of the AWS Key Management Service (AWS
6270
- # KMS) symmetric customer managed customer master key (CMK) that was
6271
- # used for the object.
6358
+ # If present, specifies the ID of the Amazon Web Services Key
6359
+ # Management Service (Amazon Web Services KMS) symmetric customer
6360
+ # managed key that was used for the object.
6272
6361
  # @return [String]
6273
6362
  #
6274
6363
  # @!attribute [rw] bucket_key_enabled
6275
6364
  # Indicates whether the object uses an S3 Bucket Key for server-side
6276
- # encryption with AWS KMS (SSE-KMS).
6365
+ # encryption with Amazon Web Services KMS (SSE-KMS).
6277
6366
  # @return [Boolean]
6278
6367
  #
6279
6368
  # @!attribute [rw] storage_class
@@ -6431,28 +6520,28 @@ module Aws::S3
6431
6520
  # @!attribute [rw] bucket
6432
6521
  # The name of the bucket containing the object.
6433
6522
  #
6434
- # When using this API with an access point, you must direct requests
6435
- # to the access point hostname. The access point hostname takes the
6436
- # form
6523
+ # When using this action with an access point, you must direct
6524
+ # requests to the access point hostname. The access point hostname
6525
+ # takes the form
6437
6526
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
6438
- # When using this operation with an access point through the AWS SDKs,
6439
- # you provide the access point ARN in place of the bucket name. For
6440
- # more information about access point ARNs, see [Using Access
6441
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
6527
+ # When using this action with an access point through the Amazon Web
6528
+ # Services SDKs, you provide the access point ARN in place of the
6529
+ # bucket name. For more information about access point ARNs, see
6530
+ # [Using access points][1] in the *Amazon S3 User Guide*.
6442
6531
  #
6443
- # When using this API with Amazon S3 on Outposts, you must direct
6532
+ # When using this action with Amazon S3 on Outposts, you must direct
6444
6533
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
6445
6534
  # takes the form
6446
6535
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
6447
- # When using this operation using S3 on Outposts through the AWS SDKs,
6448
- # you provide the Outposts bucket ARN in place of the bucket name. For
6449
- # more information about S3 on Outposts ARNs, see [Using S3 on
6450
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
6536
+ # When using this action using S3 on Outposts through the Amazon Web
6537
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
6538
+ # bucket name. For more information about S3 on Outposts ARNs, see
6539
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
6451
6540
  #
6452
6541
  #
6453
6542
  #
6454
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
6455
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
6543
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
6544
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
6456
6545
  # @return [String]
6457
6546
  #
6458
6547
  # @!attribute [rw] if_match
@@ -6522,7 +6611,7 @@ module Aws::S3
6522
6611
  # request. Bucket owners need not specify this parameter in their
6523
6612
  # requests. For information about downloading objects from requester
6524
6613
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
6525
- # in the *Amazon S3 Developer Guide*.
6614
+ # in the *Amazon S3 User Guide*.
6526
6615
  #
6527
6616
  #
6528
6617
  #
@@ -6537,7 +6626,7 @@ module Aws::S3
6537
6626
  # @return [Integer]
6538
6627
  #
6539
6628
  # @!attribute [rw] expected_bucket_owner
6540
- # The account id of the expected bucket owner. If the bucket is owned
6629
+ # The account ID of the expected bucket owner. If the bucket is owned
6541
6630
  # by a different account, the request will fail with an HTTP `403
6542
6631
  # (Access Denied)` error.
6543
6632
  # @return [String]
@@ -6578,6 +6667,14 @@ module Aws::S3
6578
6667
  # you make a request to samplebucket/images/ the data that is returned
6579
6668
  # will be for the object with the key name images/index.html) The
6580
6669
  # suffix must not be empty and must not include a slash character.
6670
+ #
6671
+ # Replacement must be made for object keys containing special
6672
+ # characters (such as carriage returns) when using XML requests. For
6673
+ # more information, see [ XML related object key constraints][1].
6674
+ #
6675
+ #
6676
+ #
6677
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
6581
6678
  # @return [String]
6582
6679
  #
6583
6680
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/IndexDocument AWS API Documentation
@@ -6591,8 +6688,9 @@ module Aws::S3
6591
6688
  # Container element that identifies who initiated the multipart upload.
6592
6689
  #
6593
6690
  # @!attribute [rw] id
6594
- # If the principal is an AWS account, it provides the Canonical User
6595
- # ID. If the principal is an IAM User, it provides a user ARN value.
6691
+ # If the principal is an Amazon Web Services account, it provides the
6692
+ # Canonical User ID. If the principal is an IAM User, it provides a
6693
+ # user ARN value.
6596
6694
  # @return [String]
6597
6695
  #
6598
6696
  # @!attribute [rw] display_name
@@ -6790,6 +6888,14 @@ module Aws::S3
6790
6888
  # @!attribute [rw] prefix
6791
6889
  # An object key name prefix that identifies the subset of objects to
6792
6890
  # which the rule applies.
6891
+ #
6892
+ # Replacement must be made for object keys containing special
6893
+ # characters (such as carriage returns) when using XML requests. For
6894
+ # more information, see [ XML related object key constraints][1].
6895
+ #
6896
+ #
6897
+ #
6898
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
6793
6899
  # @return [String]
6794
6900
  #
6795
6901
  # @!attribute [rw] tag
@@ -6831,8 +6937,8 @@ module Aws::S3
6831
6937
  end
6832
6938
 
6833
6939
  # Specifies the inventory configuration for an Amazon S3 bucket. For
6834
- # more information, see [GET Bucket inventory][1] in the *Amazon Simple
6835
- # Storage Service API Reference*.
6940
+ # more information, see [GET Bucket inventory][1] in the *Amazon S3 API
6941
+ # Reference*.
6836
6942
  #
6837
6943
  #
6838
6944
  #
@@ -6863,7 +6969,7 @@ module Aws::S3
6863
6969
  # },
6864
6970
  # id: "InventoryId", # required
6865
6971
  # included_object_versions: "All", # required, accepts All, Current
6866
- # optional_fields: ["Size"], # accepts Size, LastModifiedDate, StorageClass, ETag, IsMultipartUploaded, ReplicationStatus, EncryptionStatus, ObjectLockRetainUntilDate, ObjectLockMode, ObjectLockLegalHoldStatus, IntelligentTieringAccessTier
6972
+ # optional_fields: ["Size"], # accepts Size, LastModifiedDate, StorageClass, ETag, IsMultipartUploaded, ReplicationStatus, EncryptionStatus, ObjectLockRetainUntilDate, ObjectLockMode, ObjectLockLegalHoldStatus, IntelligentTieringAccessTier, BucketKeyStatus
6867
6973
  # schedule: { # required
6868
6974
  # frequency: "Daily", # required, accepts Daily, Weekly
6869
6975
  # },
@@ -7132,8 +7238,7 @@ module Aws::S3
7132
7238
  include Aws::Structure
7133
7239
  end
7134
7240
 
7135
- # A container for specifying the configuration for AWS Lambda
7136
- # notifications.
7241
+ # A container for specifying the configuration for Lambda notifications.
7137
7242
  #
7138
7243
  # @note When making an API call, you may pass LambdaFunctionConfiguration
7139
7244
  # data as a hash:
@@ -7161,14 +7266,14 @@ module Aws::S3
7161
7266
  # @return [String]
7162
7267
  #
7163
7268
  # @!attribute [rw] lambda_function_arn
7164
- # The Amazon Resource Name (ARN) of the AWS Lambda function that
7165
- # Amazon S3 invokes when the specified event type occurs.
7269
+ # The Amazon Resource Name (ARN) of the Lambda function that Amazon S3
7270
+ # invokes when the specified event type occurs.
7166
7271
  # @return [String]
7167
7272
  #
7168
7273
  # @!attribute [rw] events
7169
- # The Amazon S3 bucket event for which to invoke the AWS Lambda
7170
- # function. For more information, see [Supported Event Types][1] in
7171
- # the *Amazon Simple Storage Service Developer Guide*.
7274
+ # The Amazon S3 bucket event for which to invoke the Lambda function.
7275
+ # For more information, see [Supported Event Types][1] in the *Amazon
7276
+ # S3 User Guide*.
7172
7277
  #
7173
7278
  #
7174
7279
  #
@@ -7178,7 +7283,7 @@ module Aws::S3
7178
7283
  # @!attribute [rw] filter
7179
7284
  # Specifies object key name filtering rules. For information about key
7180
7285
  # name filtering, see [Configuring Event Notifications][1] in the
7181
- # *Amazon Simple Storage Service Developer Guide*.
7286
+ # *Amazon S3 User Guide*.
7182
7287
  #
7183
7288
  #
7184
7289
  #
@@ -7344,13 +7449,22 @@ module Aws::S3
7344
7449
  #
7345
7450
  # @!attribute [rw] prefix
7346
7451
  # Prefix identifying one or more objects to which the rule applies.
7347
- # This is No longer used; use `Filter` instead.
7452
+ # This is no longer used; use `Filter` instead.
7453
+ #
7454
+ # Replacement must be made for object keys containing special
7455
+ # characters (such as carriage returns) when using XML requests. For
7456
+ # more information, see [ XML related object key constraints][1].
7457
+ #
7458
+ #
7459
+ #
7460
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
7348
7461
  # @return [String]
7349
7462
  #
7350
7463
  # @!attribute [rw] filter
7351
7464
  # The `Filter` is used to identify objects that a Lifecycle Rule
7352
7465
  # applies to. A `Filter` must have exactly one of `Prefix`, `Tag`, or
7353
- # `And` specified.
7466
+ # `And` specified. `Filter` is required if the `LifecycleRule` does
7467
+ # not containt a `Prefix` element.
7354
7468
  # @return [Types::LifecycleRuleFilter]
7355
7469
  #
7356
7470
  # @!attribute [rw] status
@@ -7386,7 +7500,7 @@ module Aws::S3
7386
7500
  # upload that Amazon S3 will wait before permanently removing all
7387
7501
  # parts of the upload. For more information, see [ Aborting Incomplete
7388
7502
  # Multipart Uploads Using a Bucket Lifecycle Policy][1] in the *Amazon
7389
- # Simple Storage Service Developer Guide*.
7503
+ # S3 User Guide*.
7390
7504
  #
7391
7505
  #
7392
7506
  #
@@ -7470,6 +7584,14 @@ module Aws::S3
7470
7584
  #
7471
7585
  # @!attribute [rw] prefix
7472
7586
  # Prefix identifying one or more objects to which the rule applies.
7587
+ #
7588
+ # Replacement must be made for object keys containing special
7589
+ # characters (such as carriage returns) when using XML requests. For
7590
+ # more information, see [ XML related object key constraints][1].
7591
+ #
7592
+ #
7593
+ #
7594
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
7473
7595
  # @return [String]
7474
7596
  #
7475
7597
  # @!attribute [rw] tag
@@ -7548,7 +7670,7 @@ module Aws::S3
7548
7670
  # @return [String]
7549
7671
  #
7550
7672
  # @!attribute [rw] expected_bucket_owner
7551
- # The account id of the expected bucket owner. If the bucket is owned
7673
+ # The account ID of the expected bucket owner. If the bucket is owned
7552
7674
  # by a different account, the request will fail with an HTTP `403
7553
7675
  # (Access Denied)` error.
7554
7676
  # @return [String]
@@ -7679,7 +7801,7 @@ module Aws::S3
7679
7801
  # @return [String]
7680
7802
  #
7681
7803
  # @!attribute [rw] expected_bucket_owner
7682
- # The account id of the expected bucket owner. If the bucket is owned
7804
+ # The account ID of the expected bucket owner. If the bucket is owned
7683
7805
  # by a different account, the request will fail with an HTTP `403
7684
7806
  # (Access Denied)` error.
7685
7807
  # @return [String]
@@ -7751,7 +7873,7 @@ module Aws::S3
7751
7873
  # @return [String]
7752
7874
  #
7753
7875
  # @!attribute [rw] expected_bucket_owner
7754
- # The account id of the expected bucket owner. If the bucket is owned
7876
+ # The account ID of the expected bucket owner. If the bucket is owned
7755
7877
  # by a different account, the request will fail with an HTTP `403
7756
7878
  # (Access Denied)` error.
7757
7879
  # @return [String]
@@ -7785,6 +7907,7 @@ module Aws::S3
7785
7907
 
7786
7908
  # @!attribute [rw] bucket
7787
7909
  # The name of the bucket to which the multipart upload was initiated.
7910
+ # Does not return the access point ARN or access point alias if used.
7788
7911
  # @return [String]
7789
7912
  #
7790
7913
  # @!attribute [rw] key_marker
@@ -7890,28 +8013,28 @@ module Aws::S3
7890
8013
  # @!attribute [rw] bucket
7891
8014
  # The name of the bucket to which the multipart upload was initiated.
7892
8015
  #
7893
- # When using this API with an access point, you must direct requests
7894
- # to the access point hostname. The access point hostname takes the
7895
- # form
8016
+ # When using this action with an access point, you must direct
8017
+ # requests to the access point hostname. The access point hostname
8018
+ # takes the form
7896
8019
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
7897
- # When using this operation with an access point through the AWS SDKs,
7898
- # you provide the access point ARN in place of the bucket name. For
7899
- # more information about access point ARNs, see [Using Access
7900
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
8020
+ # When using this action with an access point through the Amazon Web
8021
+ # Services SDKs, you provide the access point ARN in place of the
8022
+ # bucket name. For more information about access point ARNs, see
8023
+ # [Using access points][1] in the *Amazon S3 User Guide*.
7901
8024
  #
7902
- # When using this API with Amazon S3 on Outposts, you must direct
8025
+ # When using this action with Amazon S3 on Outposts, you must direct
7903
8026
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
7904
8027
  # takes the form
7905
8028
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
7906
- # When using this operation using S3 on Outposts through the AWS SDKs,
7907
- # you provide the Outposts bucket ARN in place of the bucket name. For
7908
- # more information about S3 on Outposts ARNs, see [Using S3 on
7909
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
8029
+ # When using this action using S3 on Outposts through the Amazon Web
8030
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
8031
+ # bucket name. For more information about S3 on Outposts ARNs, see
8032
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
7910
8033
  #
7911
8034
  #
7912
8035
  #
7913
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
7914
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
8036
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
8037
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
7915
8038
  # @return [String]
7916
8039
  #
7917
8040
  # @!attribute [rw] delimiter
@@ -7972,7 +8095,7 @@ module Aws::S3
7972
8095
  # @return [String]
7973
8096
  #
7974
8097
  # @!attribute [rw] expected_bucket_owner
7975
- # The account id of the expected bucket owner. If the bucket is owned
8098
+ # The account ID of the expected bucket owner. If the bucket is owned
7976
8099
  # by a different account, the request will fail with an HTTP `403
7977
8100
  # (Access Denied)` error.
7978
8101
  # @return [String]
@@ -8130,7 +8253,7 @@ module Aws::S3
8130
8253
  #
8131
8254
  # @!attribute [rw] max_keys
8132
8255
  # Sets the maximum number of keys returned in the response. By default
8133
- # the API returns up to 1,000 key names. The response might contain
8256
+ # the action returns up to 1,000 key names. The response might contain
8134
8257
  # fewer keys but will never contain more. If additional keys satisfy
8135
8258
  # the search criteria, but were not returned because max-keys was
8136
8259
  # exceeded, the response contains
@@ -8152,7 +8275,7 @@ module Aws::S3
8152
8275
  # @return [String]
8153
8276
  #
8154
8277
  # @!attribute [rw] expected_bucket_owner
8155
- # The account id of the expected bucket owner. If the bucket is owned
8278
+ # The account ID of the expected bucket owner. If the bucket is owned
8156
8279
  # by a different account, the request will fail with an HTTP `403
8157
8280
  # (Access Denied)` error.
8158
8281
  # @return [String]
@@ -8218,8 +8341,8 @@ module Aws::S3
8218
8341
  # @return [Integer]
8219
8342
  #
8220
8343
  # @!attribute [rw] common_prefixes
8221
- # All of the keys rolled up in a common prefix count as a single
8222
- # return when calculating the number of returns.
8344
+ # All of the keys (up to 1,000) rolled up in a common prefix count as
8345
+ # a single return when calculating the number of returns.
8223
8346
  #
8224
8347
  # A response can contain CommonPrefixes only if you specify a
8225
8348
  # delimiter.
@@ -8275,28 +8398,28 @@ module Aws::S3
8275
8398
  # @!attribute [rw] bucket
8276
8399
  # The name of the bucket containing the objects.
8277
8400
  #
8278
- # When using this API with an access point, you must direct requests
8279
- # to the access point hostname. The access point hostname takes the
8280
- # form
8401
+ # When using this action with an access point, you must direct
8402
+ # requests to the access point hostname. The access point hostname
8403
+ # takes the form
8281
8404
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
8282
- # When using this operation with an access point through the AWS SDKs,
8283
- # you provide the access point ARN in place of the bucket name. For
8284
- # more information about access point ARNs, see [Using Access
8285
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
8405
+ # When using this action with an access point through the Amazon Web
8406
+ # Services SDKs, you provide the access point ARN in place of the
8407
+ # bucket name. For more information about access point ARNs, see
8408
+ # [Using access points][1] in the *Amazon S3 User Guide*.
8286
8409
  #
8287
- # When using this API with Amazon S3 on Outposts, you must direct
8410
+ # When using this action with Amazon S3 on Outposts, you must direct
8288
8411
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
8289
8412
  # takes the form
8290
8413
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
8291
- # When using this operation using S3 on Outposts through the AWS SDKs,
8292
- # you provide the Outposts bucket ARN in place of the bucket name. For
8293
- # more information about S3 on Outposts ARNs, see [Using S3 on
8294
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
8414
+ # When using this action using S3 on Outposts through the Amazon Web
8415
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
8416
+ # bucket name. For more information about S3 on Outposts ARNs, see
8417
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
8295
8418
  #
8296
8419
  #
8297
8420
  #
8298
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
8299
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
8421
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
8422
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
8300
8423
  # @return [String]
8301
8424
  #
8302
8425
  # @!attribute [rw] delimiter
@@ -8313,12 +8436,14 @@ module Aws::S3
8313
8436
  # @return [String]
8314
8437
  #
8315
8438
  # @!attribute [rw] marker
8316
- # Specifies the key to start with when listing objects in a bucket.
8439
+ # Marker is where you want Amazon S3 to start listing from. Amazon S3
8440
+ # starts listing after this specified key. Marker can be any key in
8441
+ # the bucket.
8317
8442
  # @return [String]
8318
8443
  #
8319
8444
  # @!attribute [rw] max_keys
8320
8445
  # Sets the maximum number of keys returned in the response. By default
8321
- # the API returns up to 1,000 key names. The response might contain
8446
+ # the action returns up to 1,000 key names. The response might contain
8322
8447
  # fewer keys but will never contain more.
8323
8448
  # @return [Integer]
8324
8449
  #
@@ -8333,7 +8458,7 @@ module Aws::S3
8333
8458
  # @return [String]
8334
8459
  #
8335
8460
  # @!attribute [rw] expected_bucket_owner
8336
- # The account id of the expected bucket owner. If the bucket is owned
8461
+ # The account ID of the expected bucket owner. If the bucket is owned
8337
8462
  # by a different account, the request will fail with an HTTP `403
8338
8463
  # (Access Denied)` error.
8339
8464
  # @return [String]
@@ -8366,28 +8491,28 @@ module Aws::S3
8366
8491
  # @!attribute [rw] name
8367
8492
  # The bucket name.
8368
8493
  #
8369
- # When using this API with an access point, you must direct requests
8370
- # to the access point hostname. The access point hostname takes the
8371
- # form
8494
+ # When using this action with an access point, you must direct
8495
+ # requests to the access point hostname. The access point hostname
8496
+ # takes the form
8372
8497
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
8373
- # When using this operation with an access point through the AWS SDKs,
8374
- # you provide the access point ARN in place of the bucket name. For
8375
- # more information about access point ARNs, see [Using Access
8376
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
8498
+ # When using this action with an access point through the Amazon Web
8499
+ # Services SDKs, you provide the access point ARN in place of the
8500
+ # bucket name. For more information about access point ARNs, see
8501
+ # [Using access points][1] in the *Amazon S3 User Guide*.
8377
8502
  #
8378
- # When using this API with Amazon S3 on Outposts, you must direct
8503
+ # When using this action with Amazon S3 on Outposts, you must direct
8379
8504
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
8380
8505
  # takes the form
8381
8506
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
8382
- # When using this operation using S3 on Outposts through the AWS SDKs,
8383
- # you provide the Outposts bucket ARN in place of the bucket name. For
8384
- # more information about S3 on Outposts ARNs, see [Using S3 on
8385
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
8507
+ # When using this action using S3 on Outposts through the Amazon Web
8508
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
8509
+ # bucket name. For more information about S3 on Outposts ARNs, see
8510
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
8386
8511
  #
8387
8512
  #
8388
8513
  #
8389
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
8390
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
8514
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
8515
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
8391
8516
  # @return [String]
8392
8517
  #
8393
8518
  # @!attribute [rw] prefix
@@ -8404,13 +8529,13 @@ module Aws::S3
8404
8529
  #
8405
8530
  # @!attribute [rw] max_keys
8406
8531
  # Sets the maximum number of keys returned in the response. By default
8407
- # the API returns up to 1,000 key names. The response might contain
8532
+ # the action returns up to 1,000 key names. The response might contain
8408
8533
  # fewer keys but will never contain more.
8409
8534
  # @return [Integer]
8410
8535
  #
8411
8536
  # @!attribute [rw] common_prefixes
8412
- # All of the keys rolled up into a common prefix count as a single
8413
- # return when calculating the number of returns.
8537
+ # All of the keys (up to 1,000) rolled up into a common prefix count
8538
+ # as a single return when calculating the number of returns.
8414
8539
  #
8415
8540
  # A response can contain `CommonPrefixes` only if you specify a
8416
8541
  # delimiter.
@@ -8441,8 +8566,8 @@ module Aws::S3
8441
8566
  #
8442
8567
  # @!attribute [rw] key_count
8443
8568
  # KeyCount is the number of keys returned with this request. KeyCount
8444
- # will always be less than equals to MaxKeys field. Say you ask for 50
8445
- # keys, your result will include less than equals 50 keys
8569
+ # will always be less than or equals to MaxKeys field. Say you ask for
8570
+ # 50 keys, your result will include less than equals 50 keys
8446
8571
  # @return [Integer]
8447
8572
  #
8448
8573
  # @!attribute [rw] continuation_token
@@ -8501,28 +8626,28 @@ module Aws::S3
8501
8626
  # @!attribute [rw] bucket
8502
8627
  # Bucket name to list.
8503
8628
  #
8504
- # When using this API with an access point, you must direct requests
8505
- # to the access point hostname. The access point hostname takes the
8506
- # form
8629
+ # When using this action with an access point, you must direct
8630
+ # requests to the access point hostname. The access point hostname
8631
+ # takes the form
8507
8632
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
8508
- # When using this operation with an access point through the AWS SDKs,
8509
- # you provide the access point ARN in place of the bucket name. For
8510
- # more information about access point ARNs, see [Using Access
8511
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
8633
+ # When using this action with an access point through the Amazon Web
8634
+ # Services SDKs, you provide the access point ARN in place of the
8635
+ # bucket name. For more information about access point ARNs, see
8636
+ # [Using access points][1] in the *Amazon S3 User Guide*.
8512
8637
  #
8513
- # When using this API with Amazon S3 on Outposts, you must direct
8638
+ # When using this action with Amazon S3 on Outposts, you must direct
8514
8639
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
8515
8640
  # takes the form
8516
8641
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
8517
- # When using this operation using S3 on Outposts through the AWS SDKs,
8518
- # you provide the Outposts bucket ARN in place of the bucket name. For
8519
- # more information about S3 on Outposts ARNs, see [Using S3 on
8520
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
8642
+ # When using this action using S3 on Outposts through the Amazon Web
8643
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
8644
+ # bucket name. For more information about S3 on Outposts ARNs, see
8645
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
8521
8646
  #
8522
8647
  #
8523
8648
  #
8524
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
8525
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
8649
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
8650
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
8526
8651
  # @return [String]
8527
8652
  #
8528
8653
  # @!attribute [rw] delimiter
@@ -8536,7 +8661,7 @@ module Aws::S3
8536
8661
  #
8537
8662
  # @!attribute [rw] max_keys
8538
8663
  # Sets the maximum number of keys returned in the response. By default
8539
- # the API returns up to 1,000 key names. The response might contain
8664
+ # the action returns up to 1,000 key names. The response might contain
8540
8665
  # fewer keys but will never contain more.
8541
8666
  # @return [Integer]
8542
8667
  #
@@ -8569,7 +8694,7 @@ module Aws::S3
8569
8694
  # @return [String]
8570
8695
  #
8571
8696
  # @!attribute [rw] expected_bucket_owner
8572
- # The account id of the expected bucket owner. If the bucket is owned
8697
+ # The account ID of the expected bucket owner. If the bucket is owned
8573
8698
  # by a different account, the request will fail with an HTTP `403
8574
8699
  # (Access Denied)` error.
8575
8700
  # @return [String]
@@ -8617,6 +8742,7 @@ module Aws::S3
8617
8742
  #
8618
8743
  # @!attribute [rw] bucket
8619
8744
  # The name of the bucket to which the multipart upload was initiated.
8745
+ # Does not return the access point ARN or access point alias if used.
8620
8746
  # @return [String]
8621
8747
  #
8622
8748
  # @!attribute [rw] key
@@ -8658,9 +8784,10 @@ module Aws::S3
8658
8784
  #
8659
8785
  # @!attribute [rw] initiator
8660
8786
  # Container element that identifies who initiated the multipart
8661
- # upload. If the initiator is an AWS account, this element provides
8662
- # the same information as the `Owner` element. If the initiator is an
8663
- # IAM User, this element provides the user ARN and display name.
8787
+ # upload. If the initiator is an Amazon Web Services account, this
8788
+ # element provides the same information as the `Owner` element. If the
8789
+ # initiator is an IAM User, this element provides the user ARN and
8790
+ # display name.
8664
8791
  # @return [Types::Initiator]
8665
8792
  #
8666
8793
  # @!attribute [rw] owner
@@ -8716,28 +8843,28 @@ module Aws::S3
8716
8843
  # @!attribute [rw] bucket
8717
8844
  # The name of the bucket to which the parts are being uploaded.
8718
8845
  #
8719
- # When using this API with an access point, you must direct requests
8720
- # to the access point hostname. The access point hostname takes the
8721
- # form
8846
+ # When using this action with an access point, you must direct
8847
+ # requests to the access point hostname. The access point hostname
8848
+ # takes the form
8722
8849
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
8723
- # When using this operation with an access point through the AWS SDKs,
8724
- # you provide the access point ARN in place of the bucket name. For
8725
- # more information about access point ARNs, see [Using Access
8726
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
8850
+ # When using this action with an access point through the Amazon Web
8851
+ # Services SDKs, you provide the access point ARN in place of the
8852
+ # bucket name. For more information about access point ARNs, see
8853
+ # [Using access points][1] in the *Amazon S3 User Guide*.
8727
8854
  #
8728
- # When using this API with Amazon S3 on Outposts, you must direct
8855
+ # When using this action with Amazon S3 on Outposts, you must direct
8729
8856
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
8730
8857
  # takes the form
8731
8858
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
8732
- # When using this operation using S3 on Outposts through the AWS SDKs,
8733
- # you provide the Outposts bucket ARN in place of the bucket name. For
8734
- # more information about S3 on Outposts ARNs, see [Using S3 on
8735
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
8859
+ # When using this action using S3 on Outposts through the Amazon Web
8860
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
8861
+ # bucket name. For more information about S3 on Outposts ARNs, see
8862
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
8736
8863
  #
8737
8864
  #
8738
8865
  #
8739
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
8740
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
8866
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
8867
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
8741
8868
  # @return [String]
8742
8869
  #
8743
8870
  # @!attribute [rw] key
@@ -8763,7 +8890,7 @@ module Aws::S3
8763
8890
  # request. Bucket owners need not specify this parameter in their
8764
8891
  # requests. For information about downloading objects from requester
8765
8892
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
8766
- # in the *Amazon S3 Developer Guide*.
8893
+ # in the *Amazon S3 User Guide*.
8767
8894
  #
8768
8895
  #
8769
8896
  #
@@ -8771,7 +8898,7 @@ module Aws::S3
8771
8898
  # @return [String]
8772
8899
  #
8773
8900
  # @!attribute [rw] expected_bucket_owner
8774
- # The account id of the expected bucket owner. If the bucket is owned
8901
+ # The account ID of the expected bucket owner. If the bucket is owned
8775
8902
  # by a different account, the request will fail with an HTTP `403
8776
8903
  # (Access Denied)` error.
8777
8904
  # @return [String]
@@ -8792,8 +8919,7 @@ module Aws::S3
8792
8919
 
8793
8920
  # Describes where logs are stored and the prefix that Amazon S3 assigns
8794
8921
  # to all log object keys for a bucket. For more information, see [PUT
8795
- # Bucket logging][1] in the *Amazon Simple Storage Service API
8796
- # Reference*.
8922
+ # Bucket logging][1] in the *Amazon S3 API Reference*.
8797
8923
  #
8798
8924
  #
8799
8925
  #
@@ -8923,6 +9049,7 @@ module Aws::S3
8923
9049
  # value: "Value", # required
8924
9050
  # },
8925
9051
  # ],
9052
+ # access_point_arn: "AccessPointArn",
8926
9053
  # }
8927
9054
  #
8928
9055
  # @!attribute [rw] prefix
@@ -8933,11 +9060,16 @@ module Aws::S3
8933
9060
  # The list of tags used when evaluating an AND predicate.
8934
9061
  # @return [Array<Types::Tag>]
8935
9062
  #
9063
+ # @!attribute [rw] access_point_arn
9064
+ # The access point ARN used when evaluating an AND predicate.
9065
+ # @return [String]
9066
+ #
8936
9067
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/MetricsAndOperator AWS API Documentation
8937
9068
  #
8938
9069
  class MetricsAndOperator < Struct.new(
8939
9070
  :prefix,
8940
- :tags)
9071
+ :tags,
9072
+ :access_point_arn)
8941
9073
  SENSITIVE = []
8942
9074
  include Aws::Structure
8943
9075
  end
@@ -8947,8 +9079,7 @@ module Aws::S3
8947
9079
  # If you're updating an existing metrics configuration, note that this
8948
9080
  # is a full replacement of the existing metrics configuration. If you
8949
9081
  # don't include the elements you want to keep, they are erased. For
8950
- # more information, see [ PUT Bucket metrics][1] in the *Amazon Simple
8951
- # Storage Service API Reference*.
9082
+ # more information, see [PutBucketMetricsConfiguration][1].
8952
9083
  #
8953
9084
  #
8954
9085
  #
@@ -8965,6 +9096,7 @@ module Aws::S3
8965
9096
  # key: "ObjectKey", # required
8966
9097
  # value: "Value", # required
8967
9098
  # },
9099
+ # access_point_arn: "AccessPointArn",
8968
9100
  # and: {
8969
9101
  # prefix: "Prefix",
8970
9102
  # tags: [
@@ -8973,6 +9105,7 @@ module Aws::S3
8973
9105
  # value: "Value", # required
8974
9106
  # },
8975
9107
  # ],
9108
+ # access_point_arn: "AccessPointArn",
8976
9109
  # },
8977
9110
  # },
8978
9111
  # }
@@ -8984,7 +9117,8 @@ module Aws::S3
8984
9117
  # @!attribute [rw] filter
8985
9118
  # Specifies a metrics configuration filter. The metrics configuration
8986
9119
  # will only include objects that meet the filter's criteria. A filter
8987
- # must be a prefix, a tag, or a conjunction (MetricsAndOperator).
9120
+ # must be a prefix, an object tag, an access point ARN, or a
9121
+ # conjunction (MetricsAndOperator).
8988
9122
  # @return [Types::MetricsFilter]
8989
9123
  #
8990
9124
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/MetricsConfiguration AWS API Documentation
@@ -8998,7 +9132,13 @@ module Aws::S3
8998
9132
 
8999
9133
  # Specifies a metrics configuration filter. The metrics configuration
9000
9134
  # only includes objects that meet the filter's criteria. A filter must
9001
- # be a prefix, a tag, or a conjunction (MetricsAndOperator).
9135
+ # be a prefix, an object tag, an access point ARN, or a conjunction
9136
+ # (MetricsAndOperator). For more information, see
9137
+ # [PutBucketMetricsConfiguration][1].
9138
+ #
9139
+ #
9140
+ #
9141
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
9002
9142
  #
9003
9143
  # @note When making an API call, you may pass MetricsFilter
9004
9144
  # data as a hash:
@@ -9009,6 +9149,7 @@ module Aws::S3
9009
9149
  # key: "ObjectKey", # required
9010
9150
  # value: "Value", # required
9011
9151
  # },
9152
+ # access_point_arn: "AccessPointArn",
9012
9153
  # and: {
9013
9154
  # prefix: "Prefix",
9014
9155
  # tags: [
@@ -9017,6 +9158,7 @@ module Aws::S3
9017
9158
  # value: "Value", # required
9018
9159
  # },
9019
9160
  # ],
9161
+ # access_point_arn: "AccessPointArn",
9020
9162
  # },
9021
9163
  # }
9022
9164
  #
@@ -9028,6 +9170,10 @@ module Aws::S3
9028
9170
  # The tag used when evaluating a metrics filter.
9029
9171
  # @return [Types::Tag]
9030
9172
  #
9173
+ # @!attribute [rw] access_point_arn
9174
+ # The access point ARN used when evaluating a metrics filter.
9175
+ # @return [String]
9176
+ #
9031
9177
  # @!attribute [rw] and
9032
9178
  # A conjunction (logical AND) of predicates, which is used in
9033
9179
  # evaluating a metrics filter. The operator must have at least two
@@ -9040,6 +9186,7 @@ module Aws::S3
9040
9186
  class MetricsFilter < Struct.new(
9041
9187
  :prefix,
9042
9188
  :tag,
9189
+ :access_point_arn,
9043
9190
  :and)
9044
9191
  SENSITIVE = []
9045
9192
  include Aws::Structure
@@ -9120,8 +9267,7 @@ module Aws::S3
9120
9267
  # Specifies the number of days an object is noncurrent before Amazon
9121
9268
  # S3 can perform the associated action. For information about the
9122
9269
  # noncurrent days calculations, see [How Amazon S3 Calculates When an
9123
- # Object Became Noncurrent][1] in the *Amazon Simple Storage Service
9124
- # Developer Guide*.
9270
+ # Object Became Noncurrent][1] in the *Amazon S3 User Guide*.
9125
9271
  #
9126
9272
  #
9127
9273
  #
@@ -9157,8 +9303,7 @@ module Aws::S3
9157
9303
  # Specifies the number of days an object is noncurrent before Amazon
9158
9304
  # S3 can perform the associated action. For information about the
9159
9305
  # noncurrent days calculations, see [How Amazon S3 Calculates How Long
9160
- # an Object Has Been Noncurrent][1] in the *Amazon Simple Storage
9161
- # Service Developer Guide*.
9306
+ # an Object Has Been Noncurrent][1] in the *Amazon S3 User Guide*.
9162
9307
  #
9163
9308
  #
9164
9309
  #
@@ -9250,8 +9395,8 @@ module Aws::S3
9250
9395
  # @return [Array<Types::QueueConfiguration>]
9251
9396
  #
9252
9397
  # @!attribute [rw] lambda_function_configurations
9253
- # Describes the AWS Lambda functions to invoke and the events for
9254
- # which to invoke them.
9398
+ # Describes the Lambda functions to invoke and the events for which to
9399
+ # invoke them.
9255
9400
  # @return [Array<Types::LambdaFunctionConfiguration>]
9256
9401
  #
9257
9402
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/NotificationConfiguration AWS API Documentation
@@ -9303,7 +9448,7 @@ module Aws::S3
9303
9448
  # @return [Types::QueueConfigurationDeprecated]
9304
9449
  #
9305
9450
  # @!attribute [rw] cloud_function_configuration
9306
- # Container for specifying the AWS Lambda notification configuration.
9451
+ # Container for specifying the Lambda notification configuration.
9307
9452
  # @return [Types::CloudFunctionConfiguration]
9308
9453
  #
9309
9454
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/NotificationConfigurationDeprecated AWS API Documentation
@@ -9318,7 +9463,7 @@ module Aws::S3
9318
9463
 
9319
9464
  # Specifies object key name filtering rules. For information about key
9320
9465
  # name filtering, see [Configuring Event Notifications][1] in the
9321
- # *Amazon Simple Storage Service Developer Guide*.
9466
+ # *Amazon S3 User Guide*.
9322
9467
  #
9323
9468
  #
9324
9469
  #
@@ -9358,7 +9503,7 @@ module Aws::S3
9358
9503
  # @return [String]
9359
9504
  #
9360
9505
  # @!attribute [rw] last_modified
9361
- # The date the Object was Last Modified
9506
+ # Creation date of the object.
9362
9507
  # @return [Time]
9363
9508
  #
9364
9509
  # @!attribute [rw] etag
@@ -9369,14 +9514,14 @@ module Aws::S3
9369
9514
  # described below:
9370
9515
  #
9371
9516
  # * Objects created by the PUT Object, POST Object, or Copy operation,
9372
- # or through the AWS Management Console, and are encrypted by SSE-S3
9373
- # or plaintext, have ETags that are an MD5 digest of their object
9374
- # data.
9517
+ # or through the Amazon Web Services Management Console, and are
9518
+ # encrypted by SSE-S3 or plaintext, have ETags that are an MD5
9519
+ # digest of their object data.
9375
9520
  #
9376
9521
  # * Objects created by the PUT Object, POST Object, or Copy operation,
9377
- # or through the AWS Management Console, and are encrypted by SSE-C
9378
- # or SSE-KMS, have ETags that are not an MD5 digest of their object
9379
- # data.
9522
+ # or through the Amazon Web Services Management Console, and are
9523
+ # encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5
9524
+ # digest of their object data.
9380
9525
  #
9381
9526
  # * If an object is created by either the Multipart Upload or Part
9382
9527
  # Copy operation, the ETag is not an MD5 digest, regardless of the
@@ -9408,7 +9553,7 @@ module Aws::S3
9408
9553
  include Aws::Structure
9409
9554
  end
9410
9555
 
9411
- # This operation is not allowed against this storage tier.
9556
+ # This action is not allowed against this storage tier.
9412
9557
  #
9413
9558
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectAlreadyInActiveTierError AWS API Documentation
9414
9559
  #
@@ -9425,7 +9570,15 @@ module Aws::S3
9425
9570
  # }
9426
9571
  #
9427
9572
  # @!attribute [rw] key
9428
- # Key name of the object to delete.
9573
+ # Key name of the object.
9574
+ #
9575
+ # Replacement must be made for object keys containing special
9576
+ # characters (such as carriage returns) when using XML requests. For
9577
+ # more information, see [ XML related object key constraints][1].
9578
+ #
9579
+ #
9580
+ #
9581
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
9429
9582
  # @return [String]
9430
9583
  #
9431
9584
  # @!attribute [rw] version_id
@@ -9459,11 +9612,16 @@ module Aws::S3
9459
9612
  #
9460
9613
  # @!attribute [rw] object_lock_enabled
9461
9614
  # Indicates whether this bucket has an Object Lock configuration
9462
- # enabled.
9615
+ # enabled. Enable `ObjectLockEnabled` when you apply
9616
+ # `ObjectLockConfiguration` to a bucket.
9463
9617
  # @return [String]
9464
9618
  #
9465
9619
  # @!attribute [rw] rule
9466
- # The Object Lock rule in place for the specified object.
9620
+ # Specifies the Object Lock rule for the specified object. Enable the
9621
+ # this rule when you apply `ObjectLockConfiguration` to a bucket.
9622
+ # Bucket settings require both a mode and a period. The period can be
9623
+ # either `Days` or `Years` but you must select one. You cannot specify
9624
+ # `Days` and `Years` at the same time.
9467
9625
  # @return [Types::ObjectLockRule]
9468
9626
  #
9469
9627
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectLockConfiguration AWS API Documentation
@@ -9537,8 +9695,11 @@ module Aws::S3
9537
9695
  # }
9538
9696
  #
9539
9697
  # @!attribute [rw] default_retention
9540
- # The default retention period that you want to apply to new objects
9541
- # placed in the specified bucket.
9698
+ # The default Object Lock retention mode and period that you want to
9699
+ # apply to new objects placed in the specified bucket. Bucket settings
9700
+ # require both a mode and a period. The period can be either `Days` or
9701
+ # `Years` but you must select one. You cannot specify `Days` and
9702
+ # `Years` at the same time.
9542
9703
  # @return [Types::DefaultRetention]
9543
9704
  #
9544
9705
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectLockRule AWS API Documentation
@@ -9549,8 +9710,8 @@ module Aws::S3
9549
9710
  include Aws::Structure
9550
9711
  end
9551
9712
 
9552
- # The source object of the COPY operation is not in the active tier and
9553
- # is only stored in Amazon S3 Glacier.
9713
+ # The source object of the COPY action is not in the active tier and is
9714
+ # only stored in Amazon S3 Glacier.
9554
9715
  #
9555
9716
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectNotInActiveTierError AWS API Documentation
9556
9717
  #
@@ -9877,7 +10038,7 @@ module Aws::S3
9877
10038
  # Amazon S3 bucket. You can enable the configuration options in any
9878
10039
  # combination. For more information about when Amazon S3 considers a
9879
10040
  # bucket or object public, see [The Meaning of "Public"][1] in the
9880
- # *Amazon Simple Storage Service Developer Guide*.
10041
+ # *Amazon S3 User Guide*.
9881
10042
  #
9882
10043
  #
9883
10044
  #
@@ -9930,8 +10091,8 @@ module Aws::S3
9930
10091
  # @!attribute [rw] restrict_public_buckets
9931
10092
  # Specifies whether Amazon S3 should restrict public bucket policies
9932
10093
  # for this bucket. Setting this element to `TRUE` restricts access to
9933
- # this bucket to only AWS service principals and authorized users
9934
- # within this account if the bucket has a public policy.
10094
+ # this bucket to only Amazon Web Service principals and authorized
10095
+ # users within this account if the bucket has a public policy.
9935
10096
  #
9936
10097
  # Enabling this setting doesn't affect previously stored bucket
9937
10098
  # policies, except that public and cross-account access within any
@@ -9971,7 +10132,7 @@ module Aws::S3
9971
10132
  # @return [Types::AccelerateConfiguration]
9972
10133
  #
9973
10134
  # @!attribute [rw] expected_bucket_owner
9974
- # The account id of the expected bucket owner. If the bucket is owned
10135
+ # The account ID of the expected bucket owner. If the bucket is owned
9975
10136
  # by a different account, the request will fail with an HTTP `403
9976
10137
  # (Access Denied)` error.
9977
10138
  # @return [String]
@@ -10038,8 +10199,9 @@ module Aws::S3
10038
10199
  # was not corrupted in transit. For more information, go to [RFC
10039
10200
  # 1864.][1]
10040
10201
  #
10041
- # For requests made using the AWS Command Line Interface (CLI) or AWS
10042
- # SDKs, this field is calculated automatically.
10202
+ # For requests made using the Amazon Web Services Command Line
10203
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
10204
+ # calculated automatically.
10043
10205
  #
10044
10206
  #
10045
10207
  #
@@ -10060,8 +10222,10 @@ module Aws::S3
10060
10222
  # @return [String]
10061
10223
  #
10062
10224
  # @!attribute [rw] grant_write
10063
- # Allows grantee to create, overwrite, and delete any object in the
10064
- # bucket.
10225
+ # Allows grantee to create new objects in the bucket.
10226
+ #
10227
+ # For the bucket and object owners of existing objects, also allows
10228
+ # deletions and overwrites of those objects.
10065
10229
  # @return [String]
10066
10230
  #
10067
10231
  # @!attribute [rw] grant_write_acp
@@ -10069,7 +10233,7 @@ module Aws::S3
10069
10233
  # @return [String]
10070
10234
  #
10071
10235
  # @!attribute [rw] expected_bucket_owner
10072
- # The account id of the expected bucket owner. If the bucket is owned
10236
+ # The account ID of the expected bucket owner. If the bucket is owned
10073
10237
  # by a different account, the request will fail with an HTTP `403
10074
10238
  # (Access Denied)` error.
10075
10239
  # @return [String]
@@ -10146,7 +10310,7 @@ module Aws::S3
10146
10310
  # @return [Types::AnalyticsConfiguration]
10147
10311
  #
10148
10312
  # @!attribute [rw] expected_bucket_owner
10149
- # The account id of the expected bucket owner. If the bucket is owned
10313
+ # The account ID of the expected bucket owner. If the bucket is owned
10150
10314
  # by a different account, the request will fail with an HTTP `403
10151
10315
  # (Access Denied)` error.
10152
10316
  # @return [String]
@@ -10170,6 +10334,7 @@ module Aws::S3
10170
10334
  # cors_configuration: { # required
10171
10335
  # cors_rules: [ # required
10172
10336
  # {
10337
+ # id: "ID",
10173
10338
  # allowed_headers: ["AllowedHeader"],
10174
10339
  # allowed_methods: ["AllowedMethod"], # required
10175
10340
  # allowed_origins: ["AllowedOrigin"], # required
@@ -10189,8 +10354,7 @@ module Aws::S3
10189
10354
  # @!attribute [rw] cors_configuration
10190
10355
  # Describes the cross-origin access configuration for objects in an
10191
10356
  # Amazon S3 bucket. For more information, see [Enabling Cross-Origin
10192
- # Resource Sharing][1] in the *Amazon Simple Storage Service Developer
10193
- # Guide*.
10357
+ # Resource Sharing][1] in the *Amazon S3 User Guide*.
10194
10358
  #
10195
10359
  #
10196
10360
  #
@@ -10203,8 +10367,9 @@ module Aws::S3
10203
10367
  # was not corrupted in transit. For more information, go to [RFC
10204
10368
  # 1864.][1]
10205
10369
  #
10206
- # For requests made using the AWS Command Line Interface (CLI) or AWS
10207
- # SDKs, this field is calculated automatically.
10370
+ # For requests made using the Amazon Web Services Command Line
10371
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
10372
+ # calculated automatically.
10208
10373
  #
10209
10374
  #
10210
10375
  #
@@ -10212,7 +10377,7 @@ module Aws::S3
10212
10377
  # @return [String]
10213
10378
  #
10214
10379
  # @!attribute [rw] expected_bucket_owner
10215
- # The account id of the expected bucket owner. If the bucket is owned
10380
+ # The account ID of the expected bucket owner. If the bucket is owned
10216
10381
  # by a different account, the request will fail with an HTTP `403
10217
10382
  # (Access Denied)` error.
10218
10383
  # @return [String]
@@ -10250,11 +10415,10 @@ module Aws::S3
10250
10415
  #
10251
10416
  # @!attribute [rw] bucket
10252
10417
  # Specifies default encryption for a bucket using server-side
10253
- # encryption with Amazon S3-managed keys (SSE-S3) or customer master
10254
- # keys stored in AWS KMS (SSE-KMS). For information about the Amazon
10255
- # S3 default encryption feature, see [Amazon S3 Default Bucket
10256
- # Encryption][1] in the *Amazon Simple Storage Service Developer
10257
- # Guide*.
10418
+ # encryption with Amazon S3-managed keys (SSE-S3) or customer managed
10419
+ # keys (SSE-KMS). For information about the Amazon S3 default
10420
+ # encryption feature, see [Amazon S3 Default Bucket Encryption][1] in
10421
+ # the *Amazon S3 User Guide*.
10258
10422
  #
10259
10423
  #
10260
10424
  #
@@ -10265,8 +10429,9 @@ module Aws::S3
10265
10429
  # The base64-encoded 128-bit MD5 digest of the server-side encryption
10266
10430
  # configuration.
10267
10431
  #
10268
- # For requests made using the AWS Command Line Interface (CLI) or AWS
10269
- # SDKs, this field is calculated automatically.
10432
+ # For requests made using the Amazon Web Services Command Line
10433
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
10434
+ # calculated automatically.
10270
10435
  # @return [String]
10271
10436
  #
10272
10437
  # @!attribute [rw] server_side_encryption_configuration
@@ -10274,7 +10439,7 @@ module Aws::S3
10274
10439
  # @return [Types::ServerSideEncryptionConfiguration]
10275
10440
  #
10276
10441
  # @!attribute [rw] expected_bucket_owner
10277
- # The account id of the expected bucket owner. If the bucket is owned
10442
+ # The account ID of the expected bucket owner. If the bucket is owned
10278
10443
  # by a different account, the request will fail with an HTTP `403
10279
10444
  # (Access Denied)` error.
10280
10445
  # @return [String]
@@ -10375,7 +10540,7 @@ module Aws::S3
10375
10540
  # },
10376
10541
  # id: "InventoryId", # required
10377
10542
  # included_object_versions: "All", # required, accepts All, Current
10378
- # optional_fields: ["Size"], # accepts Size, LastModifiedDate, StorageClass, ETag, IsMultipartUploaded, ReplicationStatus, EncryptionStatus, ObjectLockRetainUntilDate, ObjectLockMode, ObjectLockLegalHoldStatus, IntelligentTieringAccessTier
10543
+ # optional_fields: ["Size"], # accepts Size, LastModifiedDate, StorageClass, ETag, IsMultipartUploaded, ReplicationStatus, EncryptionStatus, ObjectLockRetainUntilDate, ObjectLockMode, ObjectLockLegalHoldStatus, IntelligentTieringAccessTier, BucketKeyStatus
10379
10544
  # schedule: { # required
10380
10545
  # frequency: "Daily", # required, accepts Daily, Weekly
10381
10546
  # },
@@ -10397,7 +10562,7 @@ module Aws::S3
10397
10562
  # @return [Types::InventoryConfiguration]
10398
10563
  #
10399
10564
  # @!attribute [rw] expected_bucket_owner
10400
- # The account id of the expected bucket owner. If the bucket is owned
10565
+ # The account ID of the expected bucket owner. If the bucket is owned
10401
10566
  # by a different account, the request will fail with an HTTP `403
10402
10567
  # (Access Denied)` error.
10403
10568
  # @return [String]
@@ -10479,7 +10644,7 @@ module Aws::S3
10479
10644
  # @return [Types::BucketLifecycleConfiguration]
10480
10645
  #
10481
10646
  # @!attribute [rw] expected_bucket_owner
10482
- # The account id of the expected bucket owner. If the bucket is owned
10647
+ # The account ID of the expected bucket owner. If the bucket is owned
10483
10648
  # by a different account, the request will fail with an HTTP `403
10484
10649
  # (Access Denied)` error.
10485
10650
  # @return [String]
@@ -10536,15 +10701,16 @@ module Aws::S3
10536
10701
  # @return [String]
10537
10702
  #
10538
10703
  # @!attribute [rw] content_md5
10539
- # For requests made using the AWS Command Line Interface (CLI) or AWS
10540
- # SDKs, this field is calculated automatically.
10704
+ # For requests made using the Amazon Web Services Command Line
10705
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
10706
+ # calculated automatically.
10541
10707
  # @return [String]
10542
10708
  #
10543
10709
  # @!attribute [rw] lifecycle_configuration
10544
10710
  # @return [Types::LifecycleConfiguration]
10545
10711
  #
10546
10712
  # @!attribute [rw] expected_bucket_owner
10547
- # The account id of the expected bucket owner. If the bucket is owned
10713
+ # The account ID of the expected bucket owner. If the bucket is owned
10548
10714
  # by a different account, the request will fail with an HTTP `403
10549
10715
  # (Access Denied)` error.
10550
10716
  # @return [String]
@@ -10598,12 +10764,13 @@ module Aws::S3
10598
10764
  # @!attribute [rw] content_md5
10599
10765
  # The MD5 hash of the `PutBucketLogging` request body.
10600
10766
  #
10601
- # For requests made using the AWS Command Line Interface (CLI) or AWS
10602
- # SDKs, this field is calculated automatically.
10767
+ # For requests made using the Amazon Web Services Command Line
10768
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
10769
+ # calculated automatically.
10603
10770
  # @return [String]
10604
10771
  #
10605
10772
  # @!attribute [rw] expected_bucket_owner
10606
- # The account id of the expected bucket owner. If the bucket is owned
10773
+ # The account ID of the expected bucket owner. If the bucket is owned
10607
10774
  # by a different account, the request will fail with an HTTP `403
10608
10775
  # (Access Denied)` error.
10609
10776
  # @return [String]
@@ -10633,6 +10800,7 @@ module Aws::S3
10633
10800
  # key: "ObjectKey", # required
10634
10801
  # value: "Value", # required
10635
10802
  # },
10803
+ # access_point_arn: "AccessPointArn",
10636
10804
  # and: {
10637
10805
  # prefix: "Prefix",
10638
10806
  # tags: [
@@ -10641,6 +10809,7 @@ module Aws::S3
10641
10809
  # value: "Value", # required
10642
10810
  # },
10643
10811
  # ],
10812
+ # access_point_arn: "AccessPointArn",
10644
10813
  # },
10645
10814
  # },
10646
10815
  # },
@@ -10660,7 +10829,7 @@ module Aws::S3
10660
10829
  # @return [Types::MetricsConfiguration]
10661
10830
  #
10662
10831
  # @!attribute [rw] expected_bucket_owner
10663
- # The account id of the expected bucket owner. If the bucket is owned
10832
+ # The account ID of the expected bucket owner. If the bucket is owned
10664
10833
  # by a different account, the request will fail with an HTTP `403
10665
10834
  # (Access Denied)` error.
10666
10835
  # @return [String]
@@ -10748,7 +10917,7 @@ module Aws::S3
10748
10917
  # @return [Types::NotificationConfiguration]
10749
10918
  #
10750
10919
  # @!attribute [rw] expected_bucket_owner
10751
- # The account id of the expected bucket owner. If the bucket is owned
10920
+ # The account ID of the expected bucket owner. If the bucket is owned
10752
10921
  # by a different account, the request will fail with an HTTP `403
10753
10922
  # (Access Denied)` error.
10754
10923
  # @return [String]
@@ -10800,8 +10969,9 @@ module Aws::S3
10800
10969
  # @!attribute [rw] content_md5
10801
10970
  # The MD5 hash of the `PutPublicAccessBlock` request body.
10802
10971
  #
10803
- # For requests made using the AWS Command Line Interface (CLI) or AWS
10804
- # SDKs, this field is calculated automatically.
10972
+ # For requests made using the Amazon Web Services Command Line
10973
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
10974
+ # calculated automatically.
10805
10975
  # @return [String]
10806
10976
  #
10807
10977
  # @!attribute [rw] notification_configuration
@@ -10809,7 +10979,7 @@ module Aws::S3
10809
10979
  # @return [Types::NotificationConfigurationDeprecated]
10810
10980
  #
10811
10981
  # @!attribute [rw] expected_bucket_owner
10812
- # The account id of the expected bucket owner. If the bucket is owned
10982
+ # The account ID of the expected bucket owner. If the bucket is owned
10813
10983
  # by a different account, the request will fail with an HTTP `403
10814
10984
  # (Access Denied)` error.
10815
10985
  # @return [String]
@@ -10849,12 +11019,13 @@ module Aws::S3
10849
11019
  # @!attribute [rw] content_md5
10850
11020
  # The MD5 hash of the `OwnershipControls` request body.
10851
11021
  #
10852
- # For requests made using the AWS Command Line Interface (CLI) or AWS
10853
- # SDKs, this field is calculated automatically.
11022
+ # For requests made using the Amazon Web Services Command Line
11023
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
11024
+ # calculated automatically.
10854
11025
  # @return [String]
10855
11026
  #
10856
11027
  # @!attribute [rw] expected_bucket_owner
10857
- # The account id of the expected bucket owner. If the bucket is owned
11028
+ # The account ID of the expected bucket owner. If the bucket is owned
10858
11029
  # by a different account, the request will fail with an HTTP `403
10859
11030
  # (Access Denied)` error.
10860
11031
  # @return [String]
@@ -10893,8 +11064,9 @@ module Aws::S3
10893
11064
  # @!attribute [rw] content_md5
10894
11065
  # The MD5 hash of the request body.
10895
11066
  #
10896
- # For requests made using the AWS Command Line Interface (CLI) or AWS
10897
- # SDKs, this field is calculated automatically.
11067
+ # For requests made using the Amazon Web Services Command Line
11068
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
11069
+ # calculated automatically.
10898
11070
  # @return [String]
10899
11071
  #
10900
11072
  # @!attribute [rw] confirm_remove_self_bucket_access
@@ -10907,7 +11079,7 @@ module Aws::S3
10907
11079
  # @return [String]
10908
11080
  #
10909
11081
  # @!attribute [rw] expected_bucket_owner
10910
- # The account id of the expected bucket owner. If the bucket is owned
11082
+ # The account ID of the expected bucket owner. If the bucket is owned
10911
11083
  # by a different account, the request will fail with an HTTP `403
10912
11084
  # (Access Denied)` error.
10913
11085
  # @return [String]
@@ -11008,8 +11180,9 @@ module Aws::S3
11008
11180
  # was not corrupted in transit. For more information, see [RFC
11009
11181
  # 1864][1].
11010
11182
  #
11011
- # For requests made using the AWS Command Line Interface (CLI) or AWS
11012
- # SDKs, this field is calculated automatically.
11183
+ # For requests made using the Amazon Web Services Command Line
11184
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
11185
+ # calculated automatically.
11013
11186
  #
11014
11187
  #
11015
11188
  #
@@ -11026,7 +11199,7 @@ module Aws::S3
11026
11199
  # @return [String]
11027
11200
  #
11028
11201
  # @!attribute [rw] expected_bucket_owner
11029
- # The account id of the expected bucket owner. If the bucket is owned
11202
+ # The account ID of the expected bucket owner. If the bucket is owned
11030
11203
  # by a different account, the request will fail with an HTTP `403
11031
11204
  # (Access Denied)` error.
11032
11205
  # @return [String]
@@ -11060,13 +11233,14 @@ module Aws::S3
11060
11233
  # @return [String]
11061
11234
  #
11062
11235
  # @!attribute [rw] content_md5
11063
- # &gt;The base64-encoded 128-bit MD5 digest of the data. You must use
11064
- # this header as a message integrity check to verify that the request
11065
- # body was not corrupted in transit. For more information, see [RFC
11236
+ # The base64-encoded 128-bit MD5 digest of the data. You must use this
11237
+ # header as a message integrity check to verify that the request body
11238
+ # was not corrupted in transit. For more information, see [RFC
11066
11239
  # 1864][1].
11067
11240
  #
11068
- # For requests made using the AWS Command Line Interface (CLI) or AWS
11069
- # SDKs, this field is calculated automatically.
11241
+ # For requests made using the Amazon Web Services Command Line
11242
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
11243
+ # calculated automatically.
11070
11244
  #
11071
11245
  #
11072
11246
  #
@@ -11078,7 +11252,7 @@ module Aws::S3
11078
11252
  # @return [Types::RequestPaymentConfiguration]
11079
11253
  #
11080
11254
  # @!attribute [rw] expected_bucket_owner
11081
- # The account id of the expected bucket owner. If the bucket is owned
11255
+ # The account ID of the expected bucket owner. If the bucket is owned
11082
11256
  # by a different account, the request will fail with an HTTP `403
11083
11257
  # (Access Denied)` error.
11084
11258
  # @return [String]
@@ -11121,8 +11295,9 @@ module Aws::S3
11121
11295
  # was not corrupted in transit. For more information, see [RFC
11122
11296
  # 1864][1].
11123
11297
  #
11124
- # For requests made using the AWS Command Line Interface (CLI) or AWS
11125
- # SDKs, this field is calculated automatically.
11298
+ # For requests made using the Amazon Web Services Command Line
11299
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
11300
+ # calculated automatically.
11126
11301
  #
11127
11302
  #
11128
11303
  #
@@ -11134,7 +11309,7 @@ module Aws::S3
11134
11309
  # @return [Types::Tagging]
11135
11310
  #
11136
11311
  # @!attribute [rw] expected_bucket_owner
11137
- # The account id of the expected bucket owner. If the bucket is owned
11312
+ # The account ID of the expected bucket owner. If the bucket is owned
11138
11313
  # by a different account, the request will fail with an HTTP `403
11139
11314
  # (Access Denied)` error.
11140
11315
  # @return [String]
@@ -11174,8 +11349,9 @@ module Aws::S3
11174
11349
  # body was not corrupted in transit. For more information, see [RFC
11175
11350
  # 1864][1].
11176
11351
  #
11177
- # For requests made using the AWS Command Line Interface (CLI) or AWS
11178
- # SDKs, this field is calculated automatically.
11352
+ # For requests made using the Amazon Web Services Command Line
11353
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
11354
+ # calculated automatically.
11179
11355
  #
11180
11356
  #
11181
11357
  #
@@ -11193,7 +11369,7 @@ module Aws::S3
11193
11369
  # @return [Types::VersioningConfiguration]
11194
11370
  #
11195
11371
  # @!attribute [rw] expected_bucket_owner
11196
- # The account id of the expected bucket owner. If the bucket is owned
11372
+ # The account ID of the expected bucket owner. If the bucket is owned
11197
11373
  # by a different account, the request will fail with an HTTP `403
11198
11374
  # (Access Denied)` error.
11199
11375
  # @return [String]
@@ -11256,8 +11432,9 @@ module Aws::S3
11256
11432
  # was not corrupted in transit. For more information, see [RFC
11257
11433
  # 1864][1].
11258
11434
  #
11259
- # For requests made using the AWS Command Line Interface (CLI) or AWS
11260
- # SDKs, this field is calculated automatically.
11435
+ # For requests made using the Amazon Web Services Command Line
11436
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
11437
+ # calculated automatically.
11261
11438
  #
11262
11439
  #
11263
11440
  #
@@ -11269,7 +11446,7 @@ module Aws::S3
11269
11446
  # @return [Types::WebsiteConfiguration]
11270
11447
  #
11271
11448
  # @!attribute [rw] expected_bucket_owner
11272
- # The account id of the expected bucket owner. If the bucket is owned
11449
+ # The account ID of the expected bucket owner. If the bucket is owned
11273
11450
  # by a different account, the request will fail with an HTTP `403
11274
11451
  # (Access Denied)` error.
11275
11452
  # @return [String]
@@ -11352,18 +11529,18 @@ module Aws::S3
11352
11529
  # The bucket name that contains the object to which you want to attach
11353
11530
  # the ACL.
11354
11531
  #
11355
- # When using this API with an access point, you must direct requests
11356
- # to the access point hostname. The access point hostname takes the
11357
- # form
11532
+ # When using this action with an access point, you must direct
11533
+ # requests to the access point hostname. The access point hostname
11534
+ # takes the form
11358
11535
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
11359
- # When using this operation with an access point through the AWS SDKs,
11360
- # you provide the access point ARN in place of the bucket name. For
11361
- # more information about access point ARNs, see [Using Access
11362
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
11536
+ # When using this action with an access point through the Amazon Web
11537
+ # Services SDKs, you provide the access point ARN in place of the
11538
+ # bucket name. For more information about access point ARNs, see
11539
+ # [Using access points][1] in the *Amazon S3 User Guide*.
11363
11540
  #
11364
11541
  #
11365
11542
  #
11366
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
11543
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
11367
11544
  # @return [String]
11368
11545
  #
11369
11546
  # @!attribute [rw] content_md5
@@ -11372,8 +11549,9 @@ module Aws::S3
11372
11549
  # was not corrupted in transit. For more information, go to [RFC
11373
11550
  # 1864.&gt;][1]
11374
11551
  #
11375
- # For requests made using the AWS Command Line Interface (CLI) or AWS
11376
- # SDKs, this field is calculated automatically.
11552
+ # For requests made using the Amazon Web Services Command Line
11553
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
11554
+ # calculated automatically.
11377
11555
  #
11378
11556
  #
11379
11557
  #
@@ -11400,8 +11578,10 @@ module Aws::S3
11400
11578
  # @return [String]
11401
11579
  #
11402
11580
  # @!attribute [rw] grant_write
11403
- # Allows grantee to create, overwrite, and delete any object in the
11404
- # bucket.
11581
+ # Allows grantee to create new objects in the bucket.
11582
+ #
11583
+ # For the bucket and object owners of existing objects, also allows
11584
+ # deletions and overwrites of those objects.
11405
11585
  # @return [String]
11406
11586
  #
11407
11587
  # @!attribute [rw] grant_write_acp
@@ -11411,30 +11591,30 @@ module Aws::S3
11411
11591
  # @return [String]
11412
11592
  #
11413
11593
  # @!attribute [rw] key
11414
- # Key for which the PUT operation was initiated.
11594
+ # Key for which the PUT action was initiated.
11415
11595
  #
11416
- # When using this API with an access point, you must direct requests
11417
- # to the access point hostname. The access point hostname takes the
11418
- # form
11596
+ # When using this action with an access point, you must direct
11597
+ # requests to the access point hostname. The access point hostname
11598
+ # takes the form
11419
11599
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
11420
- # When using this operation with an access point through the AWS SDKs,
11421
- # you provide the access point ARN in place of the bucket name. For
11422
- # more information about access point ARNs, see [Using Access
11423
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
11600
+ # When using this action with an access point through the Amazon Web
11601
+ # Services SDKs, you provide the access point ARN in place of the
11602
+ # bucket name. For more information about access point ARNs, see
11603
+ # [Using access points][1] in the *Amazon S3 User Guide*.
11424
11604
  #
11425
- # When using this API with Amazon S3 on Outposts, you must direct
11605
+ # When using this action with Amazon S3 on Outposts, you must direct
11426
11606
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
11427
11607
  # takes the form
11428
11608
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
11429
- # When using this operation using S3 on Outposts through the AWS SDKs,
11430
- # you provide the Outposts bucket ARN in place of the bucket name. For
11431
- # more information about S3 on Outposts ARNs, see [Using S3 on
11432
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
11609
+ # When using this action using S3 on Outposts through the Amazon Web
11610
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
11611
+ # bucket name. For more information about S3 on Outposts ARNs, see
11612
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
11433
11613
  #
11434
11614
  #
11435
11615
  #
11436
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
11437
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
11616
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
11617
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
11438
11618
  # @return [String]
11439
11619
  #
11440
11620
  # @!attribute [rw] request_payer
@@ -11442,7 +11622,7 @@ module Aws::S3
11442
11622
  # request. Bucket owners need not specify this parameter in their
11443
11623
  # requests. For information about downloading objects from requester
11444
11624
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
11445
- # in the *Amazon S3 Developer Guide*.
11625
+ # in the *Amazon S3 User Guide*.
11446
11626
  #
11447
11627
  #
11448
11628
  #
@@ -11454,7 +11634,7 @@ module Aws::S3
11454
11634
  # @return [String]
11455
11635
  #
11456
11636
  # @!attribute [rw] expected_bucket_owner
11457
- # The account id of the expected bucket owner. If the bucket is owned
11637
+ # The account ID of the expected bucket owner. If the bucket is owned
11458
11638
  # by a different account, the request will fail with an HTTP `403
11459
11639
  # (Access Denied)` error.
11460
11640
  # @return [String]
@@ -11511,18 +11691,18 @@ module Aws::S3
11511
11691
  # The bucket name containing the object that you want to place a Legal
11512
11692
  # Hold on.
11513
11693
  #
11514
- # When using this API with an access point, you must direct requests
11515
- # to the access point hostname. The access point hostname takes the
11516
- # form
11694
+ # When using this action with an access point, you must direct
11695
+ # requests to the access point hostname. The access point hostname
11696
+ # takes the form
11517
11697
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
11518
- # When using this operation with an access point through the AWS SDKs,
11519
- # you provide the access point ARN in place of the bucket name. For
11520
- # more information about access point ARNs, see [Using Access
11521
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
11698
+ # When using this action with an access point through the Amazon Web
11699
+ # Services SDKs, you provide the access point ARN in place of the
11700
+ # bucket name. For more information about access point ARNs, see
11701
+ # [Using access points][1] in the *Amazon S3 User Guide*.
11522
11702
  #
11523
11703
  #
11524
11704
  #
11525
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
11705
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
11526
11706
  # @return [String]
11527
11707
  #
11528
11708
  # @!attribute [rw] key
@@ -11539,7 +11719,7 @@ module Aws::S3
11539
11719
  # request. Bucket owners need not specify this parameter in their
11540
11720
  # requests. For information about downloading objects from requester
11541
11721
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
11542
- # in the *Amazon S3 Developer Guide*.
11722
+ # in the *Amazon S3 User Guide*.
11543
11723
  #
11544
11724
  #
11545
11725
  #
@@ -11553,12 +11733,13 @@ module Aws::S3
11553
11733
  # @!attribute [rw] content_md5
11554
11734
  # The MD5 hash for the request body.
11555
11735
  #
11556
- # For requests made using the AWS Command Line Interface (CLI) or AWS
11557
- # SDKs, this field is calculated automatically.
11736
+ # For requests made using the Amazon Web Services Command Line
11737
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
11738
+ # calculated automatically.
11558
11739
  # @return [String]
11559
11740
  #
11560
11741
  # @!attribute [rw] expected_bucket_owner
11561
- # The account id of the expected bucket owner. If the bucket is owned
11742
+ # The account ID of the expected bucket owner. If the bucket is owned
11562
11743
  # by a different account, the request will fail with an HTTP `403
11563
11744
  # (Access Denied)` error.
11564
11745
  # @return [String]
@@ -11626,7 +11807,7 @@ module Aws::S3
11626
11807
  # request. Bucket owners need not specify this parameter in their
11627
11808
  # requests. For information about downloading objects from requester
11628
11809
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
11629
- # in the *Amazon S3 Developer Guide*.
11810
+ # in the *Amazon S3 User Guide*.
11630
11811
  #
11631
11812
  #
11632
11813
  #
@@ -11640,12 +11821,13 @@ module Aws::S3
11640
11821
  # @!attribute [rw] content_md5
11641
11822
  # The MD5 hash for the request body.
11642
11823
  #
11643
- # For requests made using the AWS Command Line Interface (CLI) or AWS
11644
- # SDKs, this field is calculated automatically.
11824
+ # For requests made using the Amazon Web Services Command Line
11825
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
11826
+ # calculated automatically.
11645
11827
  # @return [String]
11646
11828
  #
11647
11829
  # @!attribute [rw] expected_bucket_owner
11648
- # The account id of the expected bucket owner. If the bucket is owned
11830
+ # The account ID of the expected bucket owner. If the bucket is owned
11649
11831
  # by a different account, the request will fail with an HTTP `403
11650
11832
  # (Access Denied)` error.
11651
11833
  # @return [String]
@@ -11680,9 +11862,9 @@ module Aws::S3
11680
11862
  # @return [String]
11681
11863
  #
11682
11864
  # @!attribute [rw] server_side_encryption
11683
- # If you specified server-side encryption either with an AWS KMS
11684
- # customer master key (CMK) or Amazon S3-managed encryption key in
11685
- # your PUT request, the response includes this header. It confirms the
11865
+ # If you specified server-side encryption either with an Amazon Web
11866
+ # Services KMS key or Amazon S3-managed encryption key in your PUT
11867
+ # request, the response includes this header. It confirms the
11686
11868
  # encryption algorithm that Amazon S3 used to encrypt the object.
11687
11869
  # @return [String]
11688
11870
  #
@@ -11705,21 +11887,21 @@ module Aws::S3
11705
11887
  #
11706
11888
  # @!attribute [rw] ssekms_key_id
11707
11889
  # If `x-amz-server-side-encryption` is present and has the value of
11708
- # `aws:kms`, this header specifies the ID of the AWS Key Management
11709
- # Service (AWS KMS) symmetric customer managed customer master key
11710
- # (CMK) that was used for the object.
11890
+ # `aws:kms`, this header specifies the ID of the Amazon Web Services
11891
+ # Key Management Service (Amazon Web Services KMS) symmetric customer
11892
+ # managed key that was used for the object.
11711
11893
  # @return [String]
11712
11894
  #
11713
11895
  # @!attribute [rw] ssekms_encryption_context
11714
- # If present, specifies the AWS KMS Encryption Context to use for
11715
- # object encryption. The value of this header is a base64-encoded
11716
- # UTF-8 string holding JSON with the encryption context key-value
11717
- # pairs.
11896
+ # If present, specifies the Amazon Web Services KMS Encryption Context
11897
+ # to use for object encryption. The value of this header is a
11898
+ # base64-encoded UTF-8 string holding JSON with the encryption context
11899
+ # key-value pairs.
11718
11900
  # @return [String]
11719
11901
  #
11720
11902
  # @!attribute [rw] bucket_key_enabled
11721
11903
  # Indicates whether the uploaded object uses an S3 Bucket Key for
11722
- # server-side encryption with AWS KMS (SSE-KMS).
11904
+ # server-side encryption with Amazon Web Services KMS (SSE-KMS).
11723
11905
  # @return [Boolean]
11724
11906
  #
11725
11907
  # @!attribute [rw] request_charged
@@ -11800,30 +11982,30 @@ module Aws::S3
11800
11982
  # @return [IO]
11801
11983
  #
11802
11984
  # @!attribute [rw] bucket
11803
- # The bucket name to which the PUT operation was initiated.
11985
+ # The bucket name to which the PUT action was initiated.
11804
11986
  #
11805
- # When using this API with an access point, you must direct requests
11806
- # to the access point hostname. The access point hostname takes the
11807
- # form
11987
+ # When using this action with an access point, you must direct
11988
+ # requests to the access point hostname. The access point hostname
11989
+ # takes the form
11808
11990
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
11809
- # When using this operation with an access point through the AWS SDKs,
11810
- # you provide the access point ARN in place of the bucket name. For
11811
- # more information about access point ARNs, see [Using Access
11812
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
11991
+ # When using this action with an access point through the Amazon Web
11992
+ # Services SDKs, you provide the access point ARN in place of the
11993
+ # bucket name. For more information about access point ARNs, see
11994
+ # [Using access points][1] in the *Amazon S3 User Guide*.
11813
11995
  #
11814
- # When using this API with Amazon S3 on Outposts, you must direct
11996
+ # When using this action with Amazon S3 on Outposts, you must direct
11815
11997
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
11816
11998
  # takes the form
11817
11999
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
11818
- # When using this operation using S3 on Outposts through the AWS SDKs,
11819
- # you provide the Outposts bucket ARN in place of the bucket name. For
11820
- # more information about S3 on Outposts ARNs, see [Using S3 on
11821
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
12000
+ # When using this action using S3 on Outposts through the Amazon Web
12001
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
12002
+ # bucket name. For more information about S3 on Outposts ARNs, see
12003
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
11822
12004
  #
11823
12005
  #
11824
12006
  #
11825
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
11826
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
12007
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
12008
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
11827
12009
  # @return [String]
11828
12010
  #
11829
12011
  # @!attribute [rw] cache_control
@@ -11933,7 +12115,7 @@ module Aws::S3
11933
12115
  # @return [String]
11934
12116
  #
11935
12117
  # @!attribute [rw] key
11936
- # Object key for which the PUT operation was initiated.
12118
+ # Object key for which the PUT action was initiated.
11937
12119
  # @return [String]
11938
12120
  #
11939
12121
  # @!attribute [rw] metadata
@@ -11951,7 +12133,7 @@ module Aws::S3
11951
12133
  # and high availability. Depending on performance needs, you can
11952
12134
  # specify a different Storage Class. Amazon S3 on Outposts only uses
11953
12135
  # the OUTPOSTS Storage Class. For more information, see [Storage
11954
- # Classes][1] in the *Amazon S3 Service Developer Guide*.
12136
+ # Classes][1] in the *Amazon S3 User Guide*.
11955
12137
  #
11956
12138
  #
11957
12139
  #
@@ -12007,22 +12189,21 @@ module Aws::S3
12007
12189
  #
12008
12190
  # @!attribute [rw] ssekms_key_id
12009
12191
  # If `x-amz-server-side-encryption` is present and has the value of
12010
- # `aws:kms`, this header specifies the ID of the AWS Key Management
12011
- # Service (AWS KMS) symmetrical customer managed customer master key
12012
- # (CMK) that was used for the object.
12013
- #
12014
- # If the value of `x-amz-server-side-encryption` is `aws:kms`, this
12015
- # header specifies the ID of the symmetric customer managed AWS KMS
12016
- # CMK that will be used for the object. If you specify
12192
+ # `aws:kms`, this header specifies the ID of the Amazon Web Services
12193
+ # Key Management Service (Amazon Web Services KMS) symmetrical
12194
+ # customer managed key that was used for the object. If you specify
12017
12195
  # `x-amz-server-side-encryption:aws:kms`, but do not provide`
12018
- # x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the AWS
12019
- # managed CMK in AWS to protect the data.
12196
+ # x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the
12197
+ # Amazon Web Services managed key to protect the data. If the KMS key
12198
+ # does not exist in the same account issuing the command, you must use
12199
+ # the full ARN and not just the ID.
12020
12200
  # @return [String]
12021
12201
  #
12022
12202
  # @!attribute [rw] ssekms_encryption_context
12023
- # Specifies the AWS KMS Encryption Context to use for object
12024
- # encryption. The value of this header is a base64-encoded UTF-8
12025
- # string holding JSON with the encryption context key-value pairs.
12203
+ # Specifies the Amazon Web Services KMS Encryption Context to use for
12204
+ # object encryption. The value of this header is a base64-encoded
12205
+ # UTF-8 string holding JSON with the encryption context key-value
12206
+ # pairs.
12026
12207
  # @return [String]
12027
12208
  #
12028
12209
  # @!attribute [rw] bucket_key_enabled
@@ -12031,8 +12212,8 @@ module Aws::S3
12031
12212
  # Setting this header to `true` causes Amazon S3 to use an S3 Bucket
12032
12213
  # Key for object encryption with SSE-KMS.
12033
12214
  #
12034
- # Specifying this header with a PUT operation doesn’t affect
12035
- # bucket-level settings for S3 Bucket Key.
12215
+ # Specifying this header with a PUT action doesn’t affect bucket-level
12216
+ # settings for S3 Bucket Key.
12036
12217
  # @return [Boolean]
12037
12218
  #
12038
12219
  # @!attribute [rw] request_payer
@@ -12040,7 +12221,7 @@ module Aws::S3
12040
12221
  # request. Bucket owners need not specify this parameter in their
12041
12222
  # requests. For information about downloading objects from requester
12042
12223
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
12043
- # in the *Amazon S3 Developer Guide*.
12224
+ # in the *Amazon S3 User Guide*.
12044
12225
  #
12045
12226
  #
12046
12227
  #
@@ -12058,7 +12239,7 @@ module Aws::S3
12058
12239
  #
12059
12240
  # @!attribute [rw] object_lock_retain_until_date
12060
12241
  # The date and time when you want this object's Object Lock to
12061
- # expire.
12242
+ # expire. Must be formatted as a timestamp parameter.
12062
12243
  # @return [Time]
12063
12244
  #
12064
12245
  # @!attribute [rw] object_lock_legal_hold_status
@@ -12071,7 +12252,7 @@ module Aws::S3
12071
12252
  # @return [String]
12072
12253
  #
12073
12254
  # @!attribute [rw] expected_bucket_owner
12074
- # The account id of the expected bucket owner. If the bucket is owned
12255
+ # The account ID of the expected bucket owner. If the bucket is owned
12075
12256
  # by a different account, the request will fail with an HTTP `403
12076
12257
  # (Access Denied)` error.
12077
12258
  # @return [String]
@@ -12149,18 +12330,18 @@ module Aws::S3
12149
12330
  # The bucket name that contains the object you want to apply this
12150
12331
  # Object Retention configuration to.
12151
12332
  #
12152
- # When using this API with an access point, you must direct requests
12153
- # to the access point hostname. The access point hostname takes the
12154
- # form
12333
+ # When using this action with an access point, you must direct
12334
+ # requests to the access point hostname. The access point hostname
12335
+ # takes the form
12155
12336
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
12156
- # When using this operation with an access point through the AWS SDKs,
12157
- # you provide the access point ARN in place of the bucket name. For
12158
- # more information about access point ARNs, see [Using Access
12159
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
12337
+ # When using this action with an access point through the Amazon Web
12338
+ # Services SDKs, you provide the access point ARN in place of the
12339
+ # bucket name. For more information about access point ARNs, see
12340
+ # [Using access points][1] in the *Amazon S3 User Guide*.
12160
12341
  #
12161
12342
  #
12162
12343
  #
12163
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
12344
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
12164
12345
  # @return [String]
12165
12346
  #
12166
12347
  # @!attribute [rw] key
@@ -12177,7 +12358,7 @@ module Aws::S3
12177
12358
  # request. Bucket owners need not specify this parameter in their
12178
12359
  # requests. For information about downloading objects from requester
12179
12360
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
12180
- # in the *Amazon S3 Developer Guide*.
12361
+ # in the *Amazon S3 User Guide*.
12181
12362
  #
12182
12363
  #
12183
12364
  #
@@ -12190,19 +12371,20 @@ module Aws::S3
12190
12371
  # @return [String]
12191
12372
  #
12192
12373
  # @!attribute [rw] bypass_governance_retention
12193
- # Indicates whether this operation should bypass Governance-mode
12374
+ # Indicates whether this action should bypass Governance-mode
12194
12375
  # restrictions.
12195
12376
  # @return [Boolean]
12196
12377
  #
12197
12378
  # @!attribute [rw] content_md5
12198
12379
  # The MD5 hash for the request body.
12199
12380
  #
12200
- # For requests made using the AWS Command Line Interface (CLI) or AWS
12201
- # SDKs, this field is calculated automatically.
12381
+ # For requests made using the Amazon Web Services Command Line
12382
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
12383
+ # calculated automatically.
12202
12384
  # @return [String]
12203
12385
  #
12204
12386
  # @!attribute [rw] expected_bucket_owner
12205
- # The account id of the expected bucket owner. If the bucket is owned
12387
+ # The account ID of the expected bucket owner. If the bucket is owned
12206
12388
  # by a different account, the request will fail with an HTTP `403
12207
12389
  # (Access Denied)` error.
12208
12390
  # @return [String]
@@ -12251,33 +12433,34 @@ module Aws::S3
12251
12433
  # ],
12252
12434
  # },
12253
12435
  # expected_bucket_owner: "AccountId",
12436
+ # request_payer: "requester", # accepts requester
12254
12437
  # }
12255
12438
  #
12256
12439
  # @!attribute [rw] bucket
12257
12440
  # The bucket name containing the object.
12258
12441
  #
12259
- # When using this API with an access point, you must direct requests
12260
- # to the access point hostname. The access point hostname takes the
12261
- # form
12442
+ # When using this action with an access point, you must direct
12443
+ # requests to the access point hostname. The access point hostname
12444
+ # takes the form
12262
12445
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
12263
- # When using this operation with an access point through the AWS SDKs,
12264
- # you provide the access point ARN in place of the bucket name. For
12265
- # more information about access point ARNs, see [Using Access
12266
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
12446
+ # When using this action with an access point through the Amazon Web
12447
+ # Services SDKs, you provide the access point ARN in place of the
12448
+ # bucket name. For more information about access point ARNs, see
12449
+ # [Using access points][1] in the *Amazon S3 User Guide*.
12267
12450
  #
12268
- # When using this API with Amazon S3 on Outposts, you must direct
12451
+ # When using this action with Amazon S3 on Outposts, you must direct
12269
12452
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
12270
12453
  # takes the form
12271
12454
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
12272
- # When using this operation using S3 on Outposts through the AWS SDKs,
12273
- # you provide the Outposts bucket ARN in place of the bucket name. For
12274
- # more information about S3 on Outposts ARNs, see [Using S3 on
12275
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
12455
+ # When using this action using S3 on Outposts through the Amazon Web
12456
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
12457
+ # bucket name. For more information about S3 on Outposts ARNs, see
12458
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
12276
12459
  #
12277
12460
  #
12278
12461
  #
12279
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
12280
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
12462
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
12463
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
12281
12464
  # @return [String]
12282
12465
  #
12283
12466
  # @!attribute [rw] key
@@ -12291,8 +12474,9 @@ module Aws::S3
12291
12474
  # @!attribute [rw] content_md5
12292
12475
  # The MD5 hash for the request body.
12293
12476
  #
12294
- # For requests made using the AWS Command Line Interface (CLI) or AWS
12295
- # SDKs, this field is calculated automatically.
12477
+ # For requests made using the Amazon Web Services Command Line
12478
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
12479
+ # calculated automatically.
12296
12480
  # @return [String]
12297
12481
  #
12298
12482
  # @!attribute [rw] tagging
@@ -12300,11 +12484,23 @@ module Aws::S3
12300
12484
  # @return [Types::Tagging]
12301
12485
  #
12302
12486
  # @!attribute [rw] expected_bucket_owner
12303
- # The account id of the expected bucket owner. If the bucket is owned
12487
+ # The account ID of the expected bucket owner. If the bucket is owned
12304
12488
  # by a different account, the request will fail with an HTTP `403
12305
12489
  # (Access Denied)` error.
12306
12490
  # @return [String]
12307
12491
  #
12492
+ # @!attribute [rw] request_payer
12493
+ # Confirms that the requester knows that they will be charged for the
12494
+ # request. Bucket owners need not specify this parameter in their
12495
+ # requests. For information about downloading objects from requester
12496
+ # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
12497
+ # in the *Amazon S3 User Guide*.
12498
+ #
12499
+ #
12500
+ #
12501
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
12502
+ # @return [String]
12503
+ #
12308
12504
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectTaggingRequest AWS API Documentation
12309
12505
  #
12310
12506
  class PutObjectTaggingRequest < Struct.new(
@@ -12313,7 +12509,8 @@ module Aws::S3
12313
12509
  :version_id,
12314
12510
  :content_md5,
12315
12511
  :tagging,
12316
- :expected_bucket_owner)
12512
+ :expected_bucket_owner,
12513
+ :request_payer)
12317
12514
  SENSITIVE = []
12318
12515
  include Aws::Structure
12319
12516
  end
@@ -12341,8 +12538,9 @@ module Aws::S3
12341
12538
  # @!attribute [rw] content_md5
12342
12539
  # The MD5 hash of the `PutPublicAccessBlock` request body.
12343
12540
  #
12344
- # For requests made using the AWS Command Line Interface (CLI) or AWS
12345
- # SDKs, this field is calculated automatically.
12541
+ # For requests made using the Amazon Web Services Command Line
12542
+ # Interface (CLI) or Amazon Web Services SDKs, this field is
12543
+ # calculated automatically.
12346
12544
  # @return [String]
12347
12545
  #
12348
12546
  # @!attribute [rw] public_access_block_configuration
@@ -12350,7 +12548,7 @@ module Aws::S3
12350
12548
  # Amazon S3 bucket. You can enable the configuration options in any
12351
12549
  # combination. For more information about when Amazon S3 considers a
12352
12550
  # bucket or object public, see [The Meaning of "Public"][1] in the
12353
- # *Amazon Simple Storage Service Developer Guide*.
12551
+ # *Amazon S3 User Guide*.
12354
12552
  #
12355
12553
  #
12356
12554
  #
@@ -12358,7 +12556,7 @@ module Aws::S3
12358
12556
  # @return [Types::PublicAccessBlockConfiguration]
12359
12557
  #
12360
12558
  # @!attribute [rw] expected_bucket_owner
12361
- # The account id of the expected bucket owner. If the bucket is owned
12559
+ # The account ID of the expected bucket owner. If the bucket is owned
12362
12560
  # by a different account, the request will fail with an HTTP `403
12363
12561
  # (Access Denied)` error.
12364
12562
  # @return [String]
@@ -12416,7 +12614,7 @@ module Aws::S3
12416
12614
  # @!attribute [rw] filter
12417
12615
  # Specifies object key name filtering rules. For information about key
12418
12616
  # name filtering, see [Configuring Event Notifications][1] in the
12419
- # *Amazon Simple Storage Service Developer Guide*.
12617
+ # *Amazon S3 User Guide*.
12420
12618
  #
12421
12619
  #
12422
12620
  #
@@ -12464,7 +12662,7 @@ module Aws::S3
12464
12662
  # @return [String]
12465
12663
  #
12466
12664
  # @!attribute [rw] events
12467
- # A collection of bucket events for which to send notifications
12665
+ # A collection of bucket events for which to send notifications.
12468
12666
  # @return [Array<String>]
12469
12667
  #
12470
12668
  # @!attribute [rw] queue
@@ -12535,6 +12733,14 @@ module Aws::S3
12535
12733
  # `ReplaceKeyPrefixWith` to `/documents`. Not required if one of the
12536
12734
  # siblings is present. Can be present only if `ReplaceKeyWith` is not
12537
12735
  # provided.
12736
+ #
12737
+ # Replacement must be made for object keys containing special
12738
+ # characters (such as carriage returns) when using XML requests. For
12739
+ # more information, see [ XML related object key constraints][1].
12740
+ #
12741
+ #
12742
+ #
12743
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
12538
12744
  # @return [String]
12539
12745
  #
12540
12746
  # @!attribute [rw] replace_key_with
@@ -12542,6 +12748,14 @@ module Aws::S3
12542
12748
  # redirect request to `error.html`. Not required if one of the
12543
12749
  # siblings is present. Can be present only if `ReplaceKeyPrefixWith`
12544
12750
  # is not provided.
12751
+ #
12752
+ # Replacement must be made for object keys containing special
12753
+ # characters (such as carriage returns) when using XML requests. For
12754
+ # more information, see [ XML related object key constraints][1].
12755
+ #
12756
+ #
12757
+ #
12758
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
12545
12759
  # @return [String]
12546
12760
  #
12547
12761
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Redirect AWS API Documentation
@@ -12688,10 +12902,10 @@ module Aws::S3
12688
12902
  # }
12689
12903
  #
12690
12904
  # @!attribute [rw] role
12691
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
12692
- # Management (IAM) role that Amazon S3 assumes when replicating
12693
- # objects. For more information, see [How to Set Up Replication][1] in
12694
- # the *Amazon Simple Storage Service Developer Guide*.
12905
+ # The Amazon Resource Name (ARN) of the Identity and Access Management
12906
+ # (IAM) role that Amazon S3 assumes when replicating objects. For more
12907
+ # information, see [How to Set Up Replication][1] in the *Amazon S3
12908
+ # User Guide*.
12695
12909
  #
12696
12910
  #
12697
12911
  #
@@ -12792,8 +13006,8 @@ module Aws::S3
12792
13006
  # will be replicated according to the rule with the highest priority.
12793
13007
  # The higher the number, the higher the priority.
12794
13008
  #
12795
- # For more information, see [Replication][1] in the *Amazon Simple
12796
- # Storage Service Developer Guide*.
13009
+ # For more information, see [Replication][1] in the *Amazon S3 User
13010
+ # Guide*.
12797
13011
  #
12798
13012
  #
12799
13013
  #
@@ -12805,6 +13019,14 @@ module Aws::S3
12805
13019
  # which the rule applies. The maximum prefix length is 1,024
12806
13020
  # characters. To include all objects in a bucket, specify an empty
12807
13021
  # string.
13022
+ #
13023
+ # Replacement must be made for object keys containing special
13024
+ # characters (such as carriage returns) when using XML requests. For
13025
+ # more information, see [ XML related object key constraints][1].
13026
+ #
13027
+ #
13028
+ #
13029
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
12808
13030
  # @return [String]
12809
13031
  #
12810
13032
  # @!attribute [rw] filter
@@ -12822,8 +13044,8 @@ module Aws::S3
12822
13044
  # source objects that you want to replicate. You can choose to enable
12823
13045
  # or disable the replication of these objects. Currently, Amazon S3
12824
13046
  # supports only the filter that you can specify for objects created
12825
- # with server-side encryption using a customer master key (CMK) stored
12826
- # in AWS Key Management Service (SSE-KMS).
13047
+ # with server-side encryption using a customer managed key stored in
13048
+ # Amazon Web Services Key Management Service (SSE-KMS).
12827
13049
  # @return [Types::SourceSelectionCriteria]
12828
13050
  #
12829
13051
  # @!attribute [rw] existing_object_replication
@@ -12886,7 +13108,7 @@ module Aws::S3
12886
13108
  # filters in an `And` tag.
12887
13109
  #
12888
13110
  # * If you specify a filter based on multiple tags, wrap the `Tag`
12889
- # elements in an `And` tag
13111
+ # elements in an `And` tag.
12890
13112
  #
12891
13113
  # @note When making an API call, you may pass ReplicationRuleAndOperator
12892
13114
  # data as a hash:
@@ -12946,6 +13168,14 @@ module Aws::S3
12946
13168
  # @!attribute [rw] prefix
12947
13169
  # An object key name prefix that identifies the subset of objects to
12948
13170
  # which the rule applies.
13171
+ #
13172
+ # Replacement must be made for object keys containing special
13173
+ # characters (such as carriage returns) when using XML requests. For
13174
+ # more information, see [ XML related object key constraints][1].
13175
+ #
13176
+ #
13177
+ #
13178
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
12949
13179
  # @return [String]
12950
13180
  #
12951
13181
  # @!attribute [rw] tag
@@ -13022,7 +13252,7 @@ module Aws::S3
13022
13252
  # @!attribute [rw] minutes
13023
13253
  # Contains an integer specifying time in minutes.
13024
13254
  #
13025
- # Valid values: 15 minutes.
13255
+ # Valid value: 15
13026
13256
  # @return [Integer]
13027
13257
  #
13028
13258
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ReplicationTimeValue AWS API Documentation
@@ -13191,32 +13421,32 @@ module Aws::S3
13191
13421
  # @!attribute [rw] bucket
13192
13422
  # The bucket name containing the object to restore.
13193
13423
  #
13194
- # When using this API with an access point, you must direct requests
13195
- # to the access point hostname. The access point hostname takes the
13196
- # form
13424
+ # When using this action with an access point, you must direct
13425
+ # requests to the access point hostname. The access point hostname
13426
+ # takes the form
13197
13427
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
13198
- # When using this operation with an access point through the AWS SDKs,
13199
- # you provide the access point ARN in place of the bucket name. For
13200
- # more information about access point ARNs, see [Using Access
13201
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
13428
+ # When using this action with an access point through the Amazon Web
13429
+ # Services SDKs, you provide the access point ARN in place of the
13430
+ # bucket name. For more information about access point ARNs, see
13431
+ # [Using access points][1] in the *Amazon S3 User Guide*.
13202
13432
  #
13203
- # When using this API with Amazon S3 on Outposts, you must direct
13433
+ # When using this action with Amazon S3 on Outposts, you must direct
13204
13434
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
13205
13435
  # takes the form
13206
13436
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
13207
- # When using this operation using S3 on Outposts through the AWS SDKs,
13208
- # you provide the Outposts bucket ARN in place of the bucket name. For
13209
- # more information about S3 on Outposts ARNs, see [Using S3 on
13210
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
13437
+ # When using this action using S3 on Outposts through the Amazon Web
13438
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
13439
+ # bucket name. For more information about S3 on Outposts ARNs, see
13440
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
13211
13441
  #
13212
13442
  #
13213
13443
  #
13214
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
13215
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
13444
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
13445
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
13216
13446
  # @return [String]
13217
13447
  #
13218
13448
  # @!attribute [rw] key
13219
- # Object key for which the operation was initiated.
13449
+ # Object key for which the action was initiated.
13220
13450
  # @return [String]
13221
13451
  #
13222
13452
  # @!attribute [rw] version_id
@@ -13232,7 +13462,7 @@ module Aws::S3
13232
13462
  # request. Bucket owners need not specify this parameter in their
13233
13463
  # requests. For information about downloading objects from requester
13234
13464
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
13235
- # in the *Amazon S3 Developer Guide*.
13465
+ # in the *Amazon S3 User Guide*.
13236
13466
  #
13237
13467
  #
13238
13468
  #
@@ -13240,7 +13470,7 @@ module Aws::S3
13240
13470
  # @return [String]
13241
13471
  #
13242
13472
  # @!attribute [rw] expected_bucket_owner
13243
- # The account id of the expected bucket owner. If the bucket is owned
13473
+ # The account ID of the expected bucket owner. If the bucket is owned
13244
13474
  # by a different account, the request will fail with an HTTP `403
13245
13475
  # (Access Denied)` error.
13246
13476
  # @return [String]
@@ -13394,8 +13624,7 @@ module Aws::S3
13394
13624
 
13395
13625
  # Specifies the redirect behavior and when a redirect is applied. For
13396
13626
  # more information about routing rules, see [Configuring advanced
13397
- # conditional redirects][1] in the *Amazon Simple Storage Service
13398
- # Developer Guide*.
13627
+ # conditional redirects][1] in the *Amazon S3 User Guide*.
13399
13628
  #
13400
13629
  #
13401
13630
  #
@@ -13443,8 +13672,8 @@ module Aws::S3
13443
13672
 
13444
13673
  # Specifies lifecycle rules for an Amazon S3 bucket. For more
13445
13674
  # information, see [Put Bucket Lifecycle Configuration][1] in the
13446
- # *Amazon Simple Storage Service API Reference*. For examples, see [Put
13447
- # Bucket Lifecycle Configuration Examples][2]
13675
+ # *Amazon S3 API Reference*. For examples, see [Put Bucket Lifecycle
13676
+ # Configuration Examples][2].
13448
13677
  #
13449
13678
  #
13450
13679
  #
@@ -13492,6 +13721,14 @@ module Aws::S3
13492
13721
  # @!attribute [rw] prefix
13493
13722
  # Object key prefix that identifies one or more objects to which this
13494
13723
  # rule applies.
13724
+ #
13725
+ # Replacement must be made for object keys containing special
13726
+ # characters (such as carriage returns) when using XML requests. For
13727
+ # more information, see [ XML related object key constraints][1].
13728
+ #
13729
+ #
13730
+ #
13731
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints
13495
13732
  # @return [String]
13496
13733
  #
13497
13734
  # @!attribute [rw] status
@@ -13503,7 +13740,7 @@ module Aws::S3
13503
13740
  # Specifies when an object transitions to a specified storage class.
13504
13741
  # For more information about Amazon S3 lifecycle configuration rules,
13505
13742
  # see [Transitioning Objects Using Amazon S3 Lifecycle][1] in the
13506
- # *Amazon Simple Storage Service Developer Guide*.
13743
+ # *Amazon S3 User Guide*.
13507
13744
  #
13508
13745
  #
13509
13746
  #
@@ -13535,7 +13772,7 @@ module Aws::S3
13535
13772
  # upload that Amazon S3 will wait before permanently removing all
13536
13773
  # parts of the upload. For more information, see [ Aborting Incomplete
13537
13774
  # Multipart Uploads Using a Bucket Lifecycle Policy][1] in the *Amazon
13538
- # Simple Storage Service Developer Guide*.
13775
+ # S3 User Guide*.
13539
13776
  #
13540
13777
  #
13541
13778
  #
@@ -13686,8 +13923,8 @@ module Aws::S3
13686
13923
  # }
13687
13924
  #
13688
13925
  # @!attribute [rw] key_id
13689
- # Specifies the ID of the AWS Key Management Service (AWS KMS)
13690
- # symmetric customer managed customer master key (CMK) to use for
13926
+ # Specifies the ID of the Amazon Web Services Key Management Service
13927
+ # (Amazon Web Services KMS) symmetric customer managed key to use for
13691
13928
  # encrypting inventory reports.
13692
13929
  # @return [String]
13693
13930
  #
@@ -13902,7 +14139,7 @@ module Aws::S3
13902
14139
  # @return [Types::ScanRange]
13903
14140
  #
13904
14141
  # @!attribute [rw] expected_bucket_owner
13905
- # The account id of the expected bucket owner. If the bucket is owned
14142
+ # The account ID of the expected bucket owner. If the bucket is owned
13906
14143
  # by a different account, the request will fail with an HTTP `403
13907
14144
  # (Access Denied)` error.
13908
14145
  # @return [String]
@@ -13995,8 +14232,8 @@ module Aws::S3
13995
14232
  # Describes the default server-side encryption to apply to new objects
13996
14233
  # in the bucket. If a PUT Object request doesn't specify any
13997
14234
  # server-side encryption, this default encryption will be applied. For
13998
- # more information, see [PUT Bucket encryption][1] in the *Amazon Simple
13999
- # Storage Service API Reference*.
14235
+ # more information, see [PUT Bucket encryption][1] in the *Amazon S3 API
14236
+ # Reference*.
14000
14237
  #
14001
14238
  #
14002
14239
  #
@@ -14015,13 +14252,14 @@ module Aws::S3
14015
14252
  # @return [String]
14016
14253
  #
14017
14254
  # @!attribute [rw] kms_master_key_id
14018
- # AWS Key Management Service (KMS) customer master key ID to use for
14019
- # the default encryption. This parameter is allowed if and only if
14020
- # `SSEAlgorithm` is set to `aws:kms`.
14255
+ # Amazon Web Services Key Management Service (KMS) customer Amazon Web
14256
+ # Services KMS key ID to use for the default encryption. This
14257
+ # parameter is allowed if and only if `SSEAlgorithm` is set to
14258
+ # `aws:kms`.
14021
14259
  #
14022
14260
  # You can specify the key ID or the Amazon Resource Name (ARN) of the
14023
- # CMK. However, if you are using encryption with cross-account
14024
- # operations, you must use a fully qualified CMK ARN. For more
14261
+ # KMS key. However, if you are using encryption with cross-account
14262
+ # operations, you must use a fully qualified KMS key ARN. For more
14025
14263
  # information, see [Using encryption for cross-account operations][1].
14026
14264
  #
14027
14265
  # **For example:**
@@ -14031,9 +14269,10 @@ module Aws::S3
14031
14269
  # * Key ARN:
14032
14270
  # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
14033
14271
  #
14034
- # Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For
14035
- # more information, see [Using Symmetric and Asymmetric Keys][2] in
14036
- # the *AWS Key Management Service Developer Guide*.
14272
+ # Amazon S3 only supports symmetric KMS keys and not asymmetric KMS
14273
+ # keys. For more information, see [Using symmetric and asymmetric
14274
+ # keys][2] in the *Amazon Web Services Key Management Service
14275
+ # Developer Guide*.
14037
14276
  #
14038
14277
  #
14039
14278
  #
@@ -14107,7 +14346,7 @@ module Aws::S3
14107
14346
  # Bucket Key. By default, S3 Bucket Key is not enabled.
14108
14347
  #
14109
14348
  # For more information, see [Amazon S3 Bucket Keys][1] in the *Amazon
14110
- # Simple Storage Service Developer Guide*.
14349
+ # S3 User Guide*.
14111
14350
  #
14112
14351
  #
14113
14352
  #
@@ -14127,8 +14366,8 @@ module Aws::S3
14127
14366
  # source objects that you want to replicate. You can choose to enable or
14128
14367
  # disable the replication of these objects. Currently, Amazon S3
14129
14368
  # supports only the filter that you can specify for objects created with
14130
- # server-side encryption using a customer master key (CMK) stored in AWS
14131
- # Key Management Service (SSE-KMS).
14369
+ # server-side encryption using a customer managed key stored in Amazon
14370
+ # Web Services Key Management Service (SSE-KMS).
14132
14371
  #
14133
14372
  # @note When making an API call, you may pass SourceSelectionCriteria
14134
14373
  # data as a hash:
@@ -14144,7 +14383,7 @@ module Aws::S3
14144
14383
  #
14145
14384
  # @!attribute [rw] sse_kms_encrypted_objects
14146
14385
  # A container for filter information for the selection of Amazon S3
14147
- # objects encrypted with AWS KMS. If you include
14386
+ # objects encrypted with Amazon Web Services KMS. If you include
14148
14387
  # `SourceSelectionCriteria` in the replication configuration, this
14149
14388
  # element is required.
14150
14389
  # @return [Types::SseKmsEncryptedObjects]
@@ -14173,7 +14412,7 @@ module Aws::S3
14173
14412
  end
14174
14413
 
14175
14414
  # A container for filter information for the selection of S3 objects
14176
- # encrypted with AWS KMS.
14415
+ # encrypted with Amazon Web Services KMS.
14177
14416
  #
14178
14417
  # @note When making an API call, you may pass SseKmsEncryptedObjects
14179
14418
  # data as a hash:
@@ -14184,8 +14423,8 @@ module Aws::S3
14184
14423
  #
14185
14424
  # @!attribute [rw] status
14186
14425
  # Specifies whether Amazon S3 replicates objects created with
14187
- # server-side encryption using a customer master key (CMK) stored in
14188
- # AWS Key Management Service.
14426
+ # server-side encryption using an Amazon Web Services KMS key stored
14427
+ # in Amazon Web Services Key Management Service.
14189
14428
  # @return [String]
14190
14429
  #
14191
14430
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SseKmsEncryptedObjects AWS API Documentation
@@ -14468,8 +14707,8 @@ module Aws::S3
14468
14707
  #
14469
14708
  # @!attribute [rw] events
14470
14709
  # The Amazon S3 bucket event about which to send notifications. For
14471
- # more information, see [Supported Event Types][1] in the *Amazon
14472
- # Simple Storage Service Developer Guide*.
14710
+ # more information, see [Supported Event Types][1] in the *Amazon S3
14711
+ # User Guide*.
14473
14712
  #
14474
14713
  #
14475
14714
  #
@@ -14479,7 +14718,7 @@ module Aws::S3
14479
14718
  # @!attribute [rw] filter
14480
14719
  # Specifies object key name filtering rules. For information about key
14481
14720
  # name filtering, see [Configuring Event Notifications][1] in the
14482
- # *Amazon Simple Storage Service Developer Guide*.
14721
+ # *Amazon S3 User Guide*.
14483
14722
  #
14484
14723
  #
14485
14724
  #
@@ -14548,8 +14787,8 @@ module Aws::S3
14548
14787
 
14549
14788
  # Specifies when an object transitions to a specified storage class. For
14550
14789
  # more information about Amazon S3 lifecycle configuration rules, see
14551
- # [Transitioning Objects Using Amazon S3 Lifecycle][1] in the *Amazon
14552
- # Simple Storage Service Developer Guide*.
14790
+ # [Transitioning Objects Using Amazon S3 Lifecycle][1] in the *Amazon S3
14791
+ # User Guide*.
14553
14792
  #
14554
14793
  #
14555
14794
  #
@@ -14618,14 +14857,14 @@ module Aws::S3
14618
14857
  # @return [String]
14619
14858
  #
14620
14859
  # @!attribute [rw] ssekms_key_id
14621
- # If present, specifies the ID of the AWS Key Management Service (AWS
14622
- # KMS) symmetric customer managed customer master key (CMK) that was
14623
- # used for the object.
14860
+ # If present, specifies the ID of the Amazon Web Services Key
14861
+ # Management Service (Amazon Web Services KMS) symmetric customer
14862
+ # managed key that was used for the object.
14624
14863
  # @return [String]
14625
14864
  #
14626
14865
  # @!attribute [rw] bucket_key_enabled
14627
14866
  # Indicates whether the multipart upload uses an S3 Bucket Key for
14628
- # server-side encryption with AWS KMS (SSE-KMS).
14867
+ # server-side encryption with Amazon Web Services KMS (SSE-KMS).
14629
14868
  # @return [Boolean]
14630
14869
  #
14631
14870
  # @!attribute [rw] request_charged
@@ -14676,28 +14915,28 @@ module Aws::S3
14676
14915
  # @!attribute [rw] bucket
14677
14916
  # The bucket name.
14678
14917
  #
14679
- # When using this API with an access point, you must direct requests
14680
- # to the access point hostname. The access point hostname takes the
14681
- # form
14918
+ # When using this action with an access point, you must direct
14919
+ # requests to the access point hostname. The access point hostname
14920
+ # takes the form
14682
14921
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
14683
- # When using this operation with an access point through the AWS SDKs,
14684
- # you provide the access point ARN in place of the bucket name. For
14685
- # more information about access point ARNs, see [Using Access
14686
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
14922
+ # When using this action with an access point through the Amazon Web
14923
+ # Services SDKs, you provide the access point ARN in place of the
14924
+ # bucket name. For more information about access point ARNs, see
14925
+ # [Using access points][1] in the *Amazon S3 User Guide*.
14687
14926
  #
14688
- # When using this API with Amazon S3 on Outposts, you must direct
14927
+ # When using this action with Amazon S3 on Outposts, you must direct
14689
14928
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
14690
14929
  # takes the form
14691
14930
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
14692
- # When using this operation using S3 on Outposts through the AWS SDKs,
14693
- # you provide the Outposts bucket ARN in place of the bucket name. For
14694
- # more information about S3 on Outposts ARNs, see [Using S3 on
14695
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
14931
+ # When using this action using S3 on Outposts through the Amazon Web
14932
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
14933
+ # bucket name. For more information about S3 on Outposts ARNs, see
14934
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
14696
14935
  #
14697
14936
  #
14698
14937
  #
14699
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
14700
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
14938
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
14939
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
14701
14940
  # @return [String]
14702
14941
  #
14703
14942
  # @!attribute [rw] copy_source
@@ -14723,7 +14962,8 @@ module Aws::S3
14723
14962
  # The value must be URL encoded.
14724
14963
  #
14725
14964
  # <note markdown="1"> Amazon S3 supports copy operations using access points only when
14726
- # the source and destination buckets are in the same AWS Region.
14965
+ # the source and destination buckets are in the same Amazon Web
14966
+ # Services Region.
14727
14967
  #
14728
14968
  # </note>
14729
14969
  #
@@ -14744,7 +14984,7 @@ module Aws::S3
14744
14984
  #
14745
14985
  #
14746
14986
  #
14747
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html
14987
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
14748
14988
  # @return [String]
14749
14989
  #
14750
14990
  # @!attribute [rw] copy_source_if_match
@@ -14831,7 +15071,7 @@ module Aws::S3
14831
15071
  # request. Bucket owners need not specify this parameter in their
14832
15072
  # requests. For information about downloading objects from requester
14833
15073
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
14834
- # in the *Amazon S3 Developer Guide*.
15074
+ # in the *Amazon S3 User Guide*.
14835
15075
  #
14836
15076
  #
14837
15077
  #
@@ -14839,13 +15079,13 @@ module Aws::S3
14839
15079
  # @return [String]
14840
15080
  #
14841
15081
  # @!attribute [rw] expected_bucket_owner
14842
- # The account id of the expected destination bucket owner. If the
15082
+ # The account ID of the expected destination bucket owner. If the
14843
15083
  # destination bucket is owned by a different account, the request will
14844
15084
  # fail with an HTTP `403 (Access Denied)` error.
14845
15085
  # @return [String]
14846
15086
  #
14847
15087
  # @!attribute [rw] expected_source_bucket_owner
14848
- # The account id of the expected source bucket owner. If the source
15088
+ # The account ID of the expected source bucket owner. If the source
14849
15089
  # bucket is owned by a different account, the request will fail with
14850
15090
  # an HTTP `403 (Access Denied)` error.
14851
15091
  # @return [String]
@@ -14899,14 +15139,14 @@ module Aws::S3
14899
15139
  # @return [String]
14900
15140
  #
14901
15141
  # @!attribute [rw] ssekms_key_id
14902
- # If present, specifies the ID of the AWS Key Management Service (AWS
14903
- # KMS) symmetric customer managed customer master key (CMK) was used
14904
- # for the object.
15142
+ # If present, specifies the ID of the Amazon Web Services Key
15143
+ # Management Service (Amazon Web Services KMS) symmetric customer
15144
+ # managed key was used for the object.
14905
15145
  # @return [String]
14906
15146
  #
14907
15147
  # @!attribute [rw] bucket_key_enabled
14908
15148
  # Indicates whether the multipart upload uses an S3 Bucket Key for
14909
- # server-side encryption with AWS KMS (SSE-KMS).
15149
+ # server-side encryption with Amazon Web Services KMS (SSE-KMS).
14910
15150
  # @return [Boolean]
14911
15151
  #
14912
15152
  # @!attribute [rw] request_charged
@@ -14953,28 +15193,28 @@ module Aws::S3
14953
15193
  # @!attribute [rw] bucket
14954
15194
  # The name of the bucket to which the multipart upload was initiated.
14955
15195
  #
14956
- # When using this API with an access point, you must direct requests
14957
- # to the access point hostname. The access point hostname takes the
14958
- # form
15196
+ # When using this action with an access point, you must direct
15197
+ # requests to the access point hostname. The access point hostname
15198
+ # takes the form
14959
15199
  # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
14960
- # When using this operation with an access point through the AWS SDKs,
14961
- # you provide the access point ARN in place of the bucket name. For
14962
- # more information about access point ARNs, see [Using Access
14963
- # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
15200
+ # When using this action with an access point through the Amazon Web
15201
+ # Services SDKs, you provide the access point ARN in place of the
15202
+ # bucket name. For more information about access point ARNs, see
15203
+ # [Using access points][1] in the *Amazon S3 User Guide*.
14964
15204
  #
14965
- # When using this API with Amazon S3 on Outposts, you must direct
15205
+ # When using this action with Amazon S3 on Outposts, you must direct
14966
15206
  # requests to the S3 on Outposts hostname. The S3 on Outposts hostname
14967
15207
  # takes the form
14968
15208
  # *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
14969
- # When using this operation using S3 on Outposts through the AWS SDKs,
14970
- # you provide the Outposts bucket ARN in place of the bucket name. For
14971
- # more information about S3 on Outposts ARNs, see [Using S3 on
14972
- # Outposts][2] in the *Amazon Simple Storage Service Developer Guide*.
15209
+ # When using this action using S3 on Outposts through the Amazon Web
15210
+ # Services SDKs, you provide the Outposts bucket ARN in place of the
15211
+ # bucket name. For more information about S3 on Outposts ARNs, see
15212
+ # [Using S3 on Outposts][2] in the *Amazon S3 User Guide*.
14973
15213
  #
14974
15214
  #
14975
15215
  #
14976
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
14977
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
15216
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
15217
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
14978
15218
  # @return [String]
14979
15219
  #
14980
15220
  # @!attribute [rw] content_length
@@ -15028,7 +15268,7 @@ module Aws::S3
15028
15268
  # request. Bucket owners need not specify this parameter in their
15029
15269
  # requests. For information about downloading objects from requester
15030
15270
  # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
15031
- # in the *Amazon S3 Developer Guide*.
15271
+ # in the *Amazon S3 User Guide*.
15032
15272
  #
15033
15273
  #
15034
15274
  #
@@ -15036,7 +15276,7 @@ module Aws::S3
15036
15276
  # @return [String]
15037
15277
  #
15038
15278
  # @!attribute [rw] expected_bucket_owner
15039
- # The account id of the expected bucket owner. If the bucket is owned
15279
+ # The account ID of the expected bucket owner. If the bucket is owned
15040
15280
  # by a different account, the request will fail with an HTTP `403
15041
15281
  # (Access Denied)` error.
15042
15282
  # @return [String]
@@ -15061,8 +15301,8 @@ module Aws::S3
15061
15301
  end
15062
15302
 
15063
15303
  # Describes the versioning state of an Amazon S3 bucket. For more
15064
- # information, see [PUT Bucket versioning][1] in the *Amazon Simple
15065
- # Storage Service API Reference*.
15304
+ # information, see [PUT Bucket versioning][1] in the *Amazon S3 API
15305
+ # Reference*.
15066
15306
  #
15067
15307
  #
15068
15308
  #
@@ -15160,6 +15400,318 @@ module Aws::S3
15160
15400
  include Aws::Structure
15161
15401
  end
15162
15402
 
15403
+ # @note When making an API call, you may pass WriteGetObjectResponseRequest
15404
+ # data as a hash:
15405
+ #
15406
+ # {
15407
+ # request_route: "RequestRoute", # required
15408
+ # request_token: "RequestToken", # required
15409
+ # body: source_file,
15410
+ # status_code: 1,
15411
+ # error_code: "ErrorCode",
15412
+ # error_message: "ErrorMessage",
15413
+ # accept_ranges: "AcceptRanges",
15414
+ # cache_control: "CacheControl",
15415
+ # content_disposition: "ContentDisposition",
15416
+ # content_encoding: "ContentEncoding",
15417
+ # content_language: "ContentLanguage",
15418
+ # content_length: 1,
15419
+ # content_range: "ContentRange",
15420
+ # content_type: "ContentType",
15421
+ # delete_marker: false,
15422
+ # etag: "ETag",
15423
+ # expires: Time.now,
15424
+ # expiration: "Expiration",
15425
+ # last_modified: Time.now,
15426
+ # missing_meta: 1,
15427
+ # metadata: {
15428
+ # "MetadataKey" => "MetadataValue",
15429
+ # },
15430
+ # object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
15431
+ # object_lock_legal_hold_status: "ON", # accepts ON, OFF
15432
+ # object_lock_retain_until_date: Time.now,
15433
+ # parts_count: 1,
15434
+ # replication_status: "COMPLETE", # accepts COMPLETE, PENDING, FAILED, REPLICA
15435
+ # request_charged: "requester", # accepts requester
15436
+ # restore: "Restore",
15437
+ # server_side_encryption: "AES256", # accepts AES256, aws:kms
15438
+ # sse_customer_algorithm: "SSECustomerAlgorithm",
15439
+ # ssekms_key_id: "SSEKMSKeyId",
15440
+ # sse_customer_key_md5: "SSECustomerKeyMD5",
15441
+ # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
15442
+ # tag_count: 1,
15443
+ # version_id: "ObjectVersionId",
15444
+ # bucket_key_enabled: false,
15445
+ # }
15446
+ #
15447
+ # @!attribute [rw] request_route
15448
+ # Route prefix to the HTTP URL generated.
15449
+ # @return [String]
15450
+ #
15451
+ # @!attribute [rw] request_token
15452
+ # A single use encrypted token that maps `WriteGetObjectResponse` to
15453
+ # the end user `GetObject` request.
15454
+ # @return [String]
15455
+ #
15456
+ # @!attribute [rw] body
15457
+ # The object data.
15458
+ # @return [IO]
15459
+ #
15460
+ # @!attribute [rw] status_code
15461
+ # The integer status code for an HTTP response of a corresponding
15462
+ # `GetObject` request.
15463
+ #
15464
+ # **Status Codes**
15465
+ #
15466
+ # * *200 - OK*
15467
+ #
15468
+ # * *206 - Partial Content*
15469
+ #
15470
+ # * *304 - Not Modified*
15471
+ #
15472
+ # * *400 - Bad Request*
15473
+ #
15474
+ # * *401 - Unauthorized*
15475
+ #
15476
+ # * *403 - Forbidden*
15477
+ #
15478
+ # * *404 - Not Found*
15479
+ #
15480
+ # * *405 - Method Not Allowed*
15481
+ #
15482
+ # * *409 - Conflict*
15483
+ #
15484
+ # * *411 - Length Required*
15485
+ #
15486
+ # * *412 - Precondition Failed*
15487
+ #
15488
+ # * *416 - Range Not Satisfiable*
15489
+ #
15490
+ # * *500 - Internal Server Error*
15491
+ #
15492
+ # * *503 - Service Unavailable*
15493
+ # @return [Integer]
15494
+ #
15495
+ # @!attribute [rw] error_code
15496
+ # A string that uniquely identifies an error condition. Returned in
15497
+ # the &lt;Code&gt; tag of the error XML response for a corresponding
15498
+ # `GetObject` call. Cannot be used with a successful `StatusCode`
15499
+ # header or when the transformed object is provided in the body. All
15500
+ # error codes from S3 are sentence-cased. Regex value is
15501
+ # "^\[A-Z\]\[a-zA-Z\]+$".
15502
+ # @return [String]
15503
+ #
15504
+ # @!attribute [rw] error_message
15505
+ # Contains a generic description of the error condition. Returned in
15506
+ # the &lt;Message&gt; tag of the error XML response for a
15507
+ # corresponding `GetObject` call. Cannot be used with a successful
15508
+ # `StatusCode` header or when the transformed object is provided in
15509
+ # body.
15510
+ # @return [String]
15511
+ #
15512
+ # @!attribute [rw] accept_ranges
15513
+ # Indicates that a range of bytes was specified.
15514
+ # @return [String]
15515
+ #
15516
+ # @!attribute [rw] cache_control
15517
+ # Specifies caching behavior along the request/reply chain.
15518
+ # @return [String]
15519
+ #
15520
+ # @!attribute [rw] content_disposition
15521
+ # Specifies presentational information for the object.
15522
+ # @return [String]
15523
+ #
15524
+ # @!attribute [rw] content_encoding
15525
+ # Specifies what content encodings have been applied to the object and
15526
+ # thus what decoding mechanisms must be applied to obtain the
15527
+ # media-type referenced by the Content-Type header field.
15528
+ # @return [String]
15529
+ #
15530
+ # @!attribute [rw] content_language
15531
+ # The language the content is in.
15532
+ # @return [String]
15533
+ #
15534
+ # @!attribute [rw] content_length
15535
+ # The size of the content body in bytes.
15536
+ # @return [Integer]
15537
+ #
15538
+ # @!attribute [rw] content_range
15539
+ # The portion of the object returned in the response.
15540
+ # @return [String]
15541
+ #
15542
+ # @!attribute [rw] content_type
15543
+ # A standard MIME type describing the format of the object data.
15544
+ # @return [String]
15545
+ #
15546
+ # @!attribute [rw] delete_marker
15547
+ # Specifies whether an object stored in Amazon S3 is (`true`) or is
15548
+ # not (`false`) a delete marker.
15549
+ # @return [Boolean]
15550
+ #
15551
+ # @!attribute [rw] etag
15552
+ # An opaque identifier assigned by a web server to a specific version
15553
+ # of a resource found at a URL.
15554
+ # @return [String]
15555
+ #
15556
+ # @!attribute [rw] expires
15557
+ # The date and time at which the object is no longer cacheable.
15558
+ # @return [Time]
15559
+ #
15560
+ # @!attribute [rw] expiration
15561
+ # If object stored in Amazon S3 expiration is configured (see PUT
15562
+ # Bucket lifecycle) it includes expiry-date and rule-id key-value
15563
+ # pairs providing object expiration information. The value of the
15564
+ # rule-id is URL encoded.
15565
+ # @return [String]
15566
+ #
15567
+ # @!attribute [rw] last_modified
15568
+ # The date and time that the object was last modified.
15569
+ # @return [Time]
15570
+ #
15571
+ # @!attribute [rw] missing_meta
15572
+ # Set to the number of metadata entries not returned in `x-amz-meta`
15573
+ # headers. This can happen if you create metadata using an API like
15574
+ # SOAP that supports more flexible metadata than the REST API. For
15575
+ # example, using SOAP, you can create metadata whose values are not
15576
+ # legal HTTP headers.
15577
+ # @return [Integer]
15578
+ #
15579
+ # @!attribute [rw] metadata
15580
+ # A map of metadata to store with the object in S3.
15581
+ # @return [Hash<String,String>]
15582
+ #
15583
+ # @!attribute [rw] object_lock_mode
15584
+ # Indicates whether an object stored in Amazon S3 has Object Lock
15585
+ # enabled. For more information about S3 Object Lock, see [Object
15586
+ # Lock][1].
15587
+ #
15588
+ #
15589
+ #
15590
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
15591
+ # @return [String]
15592
+ #
15593
+ # @!attribute [rw] object_lock_legal_hold_status
15594
+ # Indicates whether an object stored in Amazon S3 has an active legal
15595
+ # hold.
15596
+ # @return [String]
15597
+ #
15598
+ # @!attribute [rw] object_lock_retain_until_date
15599
+ # The date and time when Object Lock is configured to expire.
15600
+ # @return [Time]
15601
+ #
15602
+ # @!attribute [rw] parts_count
15603
+ # The count of parts this object has.
15604
+ # @return [Integer]
15605
+ #
15606
+ # @!attribute [rw] replication_status
15607
+ # Indicates if request involves bucket that is either a source or
15608
+ # destination in a Replication rule. For more information about S3
15609
+ # Replication, see [Replication][1].
15610
+ #
15611
+ #
15612
+ #
15613
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html
15614
+ # @return [String]
15615
+ #
15616
+ # @!attribute [rw] request_charged
15617
+ # If present, indicates that the requester was successfully charged
15618
+ # for the request.
15619
+ # @return [String]
15620
+ #
15621
+ # @!attribute [rw] restore
15622
+ # Provides information about object restoration operation and
15623
+ # expiration time of the restored object copy.
15624
+ # @return [String]
15625
+ #
15626
+ # @!attribute [rw] server_side_encryption
15627
+ # The server-side encryption algorithm used when storing requested
15628
+ # object in Amazon S3 (for example, AES256, aws:kms).
15629
+ # @return [String]
15630
+ #
15631
+ # @!attribute [rw] sse_customer_algorithm
15632
+ # Encryption algorithm used if server-side encryption with a
15633
+ # customer-provided encryption key was specified for object stored in
15634
+ # Amazon S3.
15635
+ # @return [String]
15636
+ #
15637
+ # @!attribute [rw] ssekms_key_id
15638
+ # If present, specifies the ID of the Amazon Web Services Key
15639
+ # Management Service (Amazon Web Services KMS) symmetric customer
15640
+ # managed key that was used for stored in Amazon S3 object.
15641
+ # @return [String]
15642
+ #
15643
+ # @!attribute [rw] sse_customer_key_md5
15644
+ # 128-bit MD5 digest of customer-provided encryption key used in
15645
+ # Amazon S3 to encrypt data stored in S3. For more information, see
15646
+ # [Protecting data using server-side encryption with customer-provided
15647
+ # encryption keys (SSE-C)][1].
15648
+ #
15649
+ #
15650
+ #
15651
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html
15652
+ # @return [String]
15653
+ #
15654
+ # @!attribute [rw] storage_class
15655
+ # The class of storage used to store object in Amazon S3.
15656
+ # @return [String]
15657
+ #
15658
+ # @!attribute [rw] tag_count
15659
+ # The number of tags, if any, on the object.
15660
+ # @return [Integer]
15661
+ #
15662
+ # @!attribute [rw] version_id
15663
+ # An ID used to reference a specific version of the object.
15664
+ # @return [String]
15665
+ #
15666
+ # @!attribute [rw] bucket_key_enabled
15667
+ # Indicates whether the object stored in Amazon S3 uses an S3 bucket
15668
+ # key for server-side encryption with Amazon Web Services KMS
15669
+ # (SSE-KMS).
15670
+ # @return [Boolean]
15671
+ #
15672
+ # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/WriteGetObjectResponseRequest AWS API Documentation
15673
+ #
15674
+ class WriteGetObjectResponseRequest < Struct.new(
15675
+ :request_route,
15676
+ :request_token,
15677
+ :body,
15678
+ :status_code,
15679
+ :error_code,
15680
+ :error_message,
15681
+ :accept_ranges,
15682
+ :cache_control,
15683
+ :content_disposition,
15684
+ :content_encoding,
15685
+ :content_language,
15686
+ :content_length,
15687
+ :content_range,
15688
+ :content_type,
15689
+ :delete_marker,
15690
+ :etag,
15691
+ :expires,
15692
+ :expiration,
15693
+ :last_modified,
15694
+ :missing_meta,
15695
+ :metadata,
15696
+ :object_lock_mode,
15697
+ :object_lock_legal_hold_status,
15698
+ :object_lock_retain_until_date,
15699
+ :parts_count,
15700
+ :replication_status,
15701
+ :request_charged,
15702
+ :restore,
15703
+ :server_side_encryption,
15704
+ :sse_customer_algorithm,
15705
+ :ssekms_key_id,
15706
+ :sse_customer_key_md5,
15707
+ :storage_class,
15708
+ :tag_count,
15709
+ :version_id,
15710
+ :bucket_key_enabled)
15711
+ SENSITIVE = [:ssekms_key_id]
15712
+ include Aws::Structure
15713
+ end
15714
+
15163
15715
  # The container for selecting objects from a content event stream.
15164
15716
  #
15165
15717
  # EventStream is an Enumerator of Events.