aws-sdk-s3 1.55.0 → 1.56.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -150,6 +150,8 @@ module Aws::S3
150
150
  Errors = Shapes::ListShape.new(name: 'Errors', flattened: true)
151
151
  Event = Shapes::StringShape.new(name: 'Event')
152
152
  EventList = Shapes::ListShape.new(name: 'EventList', flattened: true)
153
+ ExistingObjectReplication = Shapes::StructureShape.new(name: 'ExistingObjectReplication')
154
+ ExistingObjectReplicationStatus = Shapes::StringShape.new(name: 'ExistingObjectReplicationStatus')
153
155
  Expiration = Shapes::StringShape.new(name: 'Expiration')
154
156
  ExpirationStatus = Shapes::StringShape.new(name: 'ExpirationStatus')
155
157
  ExpiredObjectDeleteMarker = Shapes::BooleanShape.new(name: 'ExpiredObjectDeleteMarker')
@@ -917,6 +919,9 @@ module Aws::S3
917
919
 
918
920
  EventList.member = Shapes::ShapeRef.new(shape: Event)
919
921
 
922
+ ExistingObjectReplication.add_member(:status, Shapes::ShapeRef.new(shape: ExistingObjectReplicationStatus, required: true, location_name: "Status"))
923
+ ExistingObjectReplication.struct_class = Types::ExistingObjectReplication
924
+
920
925
  ExposeHeaders.member = Shapes::ShapeRef.new(shape: ExposeHeader)
921
926
 
922
927
  FilterRule.add_member(:name, Shapes::ShapeRef.new(shape: FilterRuleName, location_name: "Name"))
@@ -1921,6 +1926,7 @@ module Aws::S3
1921
1926
  ReplicationRule.add_member(:filter, Shapes::ShapeRef.new(shape: ReplicationRuleFilter, location_name: "Filter"))
1922
1927
  ReplicationRule.add_member(:status, Shapes::ShapeRef.new(shape: ReplicationRuleStatus, required: true, location_name: "Status"))
1923
1928
  ReplicationRule.add_member(:source_selection_criteria, Shapes::ShapeRef.new(shape: SourceSelectionCriteria, location_name: "SourceSelectionCriteria"))
1929
+ ReplicationRule.add_member(:existing_object_replication, Shapes::ShapeRef.new(shape: ExistingObjectReplication, location_name: "ExistingObjectReplication"))
1924
1930
  ReplicationRule.add_member(:destination, Shapes::ShapeRef.new(shape: Destination, required: true, location_name: "Destination"))
1925
1931
  ReplicationRule.add_member(:delete_marker_replication, Shapes::ShapeRef.new(shape: DeleteMarkerReplication, location_name: "DeleteMarkerReplication"))
1926
1932
  ReplicationRule.struct_class = Types::ReplicationRule
@@ -70,7 +70,8 @@ module Aws::S3
70
70
  data[:storage_class]
71
71
  end
72
72
 
73
-
73
+ # Specifies the owner of the object that is part of the multipart
74
+ # upload.
74
75
  # @return [Types::Owner]
75
76
  def owner
76
77
  data[:owner]
@@ -247,6 +248,7 @@ module Aws::S3
247
248
  # })
248
249
  # @param [Hash] options ({})
249
250
  # @option options [Types::CompletedMultipartUpload] :multipart_upload
251
+ # The container for the multipart upload request information.
250
252
  # @option options [String] :request_payer
251
253
  # Confirms that the requester knows that she or he will be charged for
252
254
  # the request. Bucket owners need not specify this parameter in their
@@ -46,7 +46,7 @@ module Aws::S3
46
46
  data[:delete_marker]
47
47
  end
48
48
 
49
-
49
+ # Indicates that a range of bytes was specifed.
50
50
  # @return [String]
51
51
  def accept_ranges
52
52
  data[:accept_ranges]
@@ -61,8 +61,26 @@ module Aws::S3
61
61
  data[:expiration]
62
62
  end
63
63
 
64
- # Provides information about object restoration operation and expiration
65
- # time of the restored object copy.
64
+ # If the object is an archived object (an object whose storage class is
65
+ # GLACIER), the response includes this header if either the archive
66
+ # restoration is in progress (see RestoreObject or an archive copy is
67
+ # already restored.
68
+ #
69
+ # If an archive copy is already restored, the header value indicates
70
+ # when Amazon S3 is scheduled to delete the object copy. For example:
71
+ #
72
+ # `x-amz-restore: ongoing-request="false", expiry-date="Fri, 23 Dec 2012
73
+ # 00:00:00 GMT"`
74
+ #
75
+ # If the object restoration is in progress, the header returns the value
76
+ # `ongoing-request="true"`.
77
+ #
78
+ # For more information about archiving objects, see [Transitioning
79
+ # Objects: General Considerations][1].
80
+ #
81
+ #
82
+ #
83
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations
66
84
  # @return [String]
67
85
  def restore
68
86
  data[:restore]
@@ -154,8 +172,11 @@ module Aws::S3
154
172
  data[:website_redirect_location]
155
173
  end
156
174
 
157
- # The Server-side encryption algorithm used when storing this object in
158
- # S3 (e.g., AES256, aws:kms).
175
+ # If the object is stored using server-side encryption either with an
176
+ # AWS KMS customer master key (CMK) or an Amazon S3-managed encryption
177
+ # key, the response includes this header with the value of the
178
+ # Server-side encryption algorithm used when storing this object in S3
179
+ # (e.g., AES256, aws:kms).
159
180
  # @return [String]
160
181
  def server_side_encryption
161
182
  data[:server_side_encryption]
@@ -185,13 +206,20 @@ module Aws::S3
185
206
  end
186
207
 
187
208
  # If present, specifies the ID of the AWS Key Management Service (KMS)
188
- # master encryption key that was used for the object.
209
+ # customer master key (CMK) that was used for the object.
189
210
  # @return [String]
190
211
  def ssekms_key_id
191
212
  data[:ssekms_key_id]
192
213
  end
193
214
 
194
-
215
+ # Provides storage class information of the object. Amazon S3 returns
216
+ # this header for all objects except for Standard storage class objects.
217
+ #
218
+ # For more information, see [Storage Classes][1].
219
+ #
220
+ #
221
+ #
222
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
195
223
  # @return [String]
196
224
  def storage_class
197
225
  data[:storage_class]
@@ -204,7 +232,36 @@ module Aws::S3
204
232
  data[:request_charged]
205
233
  end
206
234
 
207
-
235
+ # Amazon S3 can return this header if your request involves a bucket
236
+ # that is either a source or destination in a replication rule.
237
+ #
238
+ # In replication you have a source bucket on which you configure
239
+ # replication and destination bucket where Amazon S3 stores object
240
+ # replicas. When you request an object (GetObject) or object metadata
241
+ # (HeadObject) from these buckets, Amazon S3 will return the
242
+ # x-amz-replication-status header in the response as follows:
243
+ #
244
+ # * If requesting object from the source bucket — Amazon S3 will return
245
+ # the x-amz-replication-status header if object in your request is
246
+ # eligible for replication.
247
+ #
248
+ # For example, suppose in your replication configuration you specify
249
+ # object prefix "TaxDocs" requesting Amazon S3 to replicate objects
250
+ # with key prefix "TaxDocs". Then any objects you upload with this
251
+ # key name prefix, for example "TaxDocs/document1.pdf", is eligible
252
+ # for replication. For any object request with this key name prefix
253
+ # Amazon S3 will return the x-amz-replication-status header with value
254
+ # PENDING, COMPLETED or FAILED indicating object replication status.
255
+ #
256
+ # * If requesting object from the destination bucket — Amazon S3 will
257
+ # return the x-amz-replication-status header with value REPLICA if
258
+ # object in your request is a replica that Amazon S3 created.
259
+ #
260
+ # For more information, see [Replication][1].
261
+ #
262
+ #
263
+ #
264
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html
208
265
  # @return [String]
209
266
  def replication_status
210
267
  data[:replication_status]
@@ -216,19 +273,36 @@ module Aws::S3
216
273
  data[:parts_count]
217
274
  end
218
275
 
219
- # The object lock mode currently in place for this object.
276
+ # The Object Lock mode, if any, that's in effect for this object. This
277
+ # header is only returned if the requester has the
278
+ # `s3:GetObjectRetention` permission. For more information about S3
279
+ # Object Lock, see [Object Lock][1].
280
+ #
281
+ #
282
+ #
283
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
220
284
  # @return [String]
221
285
  def object_lock_mode
222
286
  data[:object_lock_mode]
223
287
  end
224
288
 
225
- # The date and time when this object's object lock expires.
289
+ # The date and time when the Object Lock retention period expires. This
290
+ # header is only returned if the requester has the
291
+ # `s3:GetObjectRetention` permission.
226
292
  # @return [Time]
227
293
  def object_lock_retain_until_date
228
294
  data[:object_lock_retain_until_date]
229
295
  end
230
296
 
231
- # The Legal Hold status for the specified object.
297
+ # Specifies whether a legal hold is in effect for this object. This
298
+ # header is only returned if the requester has the
299
+ # `s3:GetObjectLegalHold` permission. This header is not returned if the
300
+ # specified version of this object has never had a legal hold applied.
301
+ # For more information about S3 Object Lock, see [Object Lock][1].
302
+ #
303
+ #
304
+ #
305
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
232
306
  # @return [String]
233
307
  def object_lock_legal_hold_status
234
308
  data[:object_lock_legal_hold_status]
@@ -563,9 +637,9 @@ module Aws::S3
563
637
  # in conjunction with the TaggingDirective. The tag-set must be encoded
564
638
  # as URL Query parameters
565
639
  # @option options [String] :object_lock_mode
566
- # The object lock mode that you want to apply to the copied object.
640
+ # The Object Lock mode that you want to apply to the copied object.
567
641
  # @option options [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
568
- # The date and time when you want the copied object's object lock to
642
+ # The date and time when you want the copied object's Object Lock to
569
643
  # expire.
570
644
  # @option options [String] :object_lock_legal_hold_status
571
645
  # Specifies whether you want to apply a Legal Hold to the copied object.
@@ -591,6 +665,8 @@ module Aws::S3
591
665
  # @option options [String] :mfa
592
666
  # The concatenation of the authentication device's serial number, a
593
667
  # space, and the value that is displayed on your authentication device.
668
+ # Required to permanently delete a versionedobject if versioning is
669
+ # configured with MFA Deleteenabled.
594
670
  # @option options [String] :version_id
595
671
  # VersionId used to reference a specific version of the object.
596
672
  # @option options [String] :request_payer
@@ -600,7 +676,7 @@ module Aws::S3
600
676
  # buckets can be found at
601
677
  # http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
602
678
  # @option options [Boolean] :bypass_governance_retention
603
- # Indicates whether Amazon S3 object lock should bypass governance-mode
679
+ # Indicates whether S3 Object Lock should bypass Governance-mode
604
680
  # restrictions to process this operation.
605
681
  # @return [Types::DeleteObjectOutput]
606
682
  def delete(options = {})
@@ -799,10 +875,10 @@ module Aws::S3
799
875
  # The tag-set for the object. The tag-set must be encoded as URL Query
800
876
  # parameters
801
877
  # @option options [String] :object_lock_mode
802
- # Specifies the object lock mode that you want to apply to the uploaded
878
+ # Specifies the Object Lock mode that you want to apply to the uploaded
803
879
  # object.
804
880
  # @option options [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
805
- # Specifies the date and time when you want the object lock to expire.
881
+ # Specifies the date and time when you want the Object Lock to expire.
806
882
  # @option options [String] :object_lock_legal_hold_status
807
883
  # Specifies whether you want to apply a Legal Hold to the uploaded
808
884
  # object.
@@ -857,30 +933,77 @@ module Aws::S3
857
933
  # })
858
934
  # @param [Hash] options ({})
859
935
  # @option options [String] :acl
860
- # The canned ACL to apply to the object.
936
+ # The canned ACL to apply to the object. For more information, see
937
+ # [Canned ACL][1].
938
+ #
939
+ #
940
+ #
941
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
861
942
  # @option options [String, IO] :body
862
943
  # Object data.
863
944
  # @option options [String] :cache_control
864
- # Specifies caching behavior along the request/reply chain.
945
+ # Can be used to specify caching behavior along the request/reply chain.
946
+ # For more information, see
947
+ # [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9][1].
948
+ #
949
+ #
950
+ #
951
+ # [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9
865
952
  # @option options [String] :content_disposition
866
- # Specifies presentational information for the object.
953
+ # Specifies presentational information for the object. For more
954
+ # information, see
955
+ # [http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1][1].
956
+ #
957
+ #
958
+ #
959
+ # [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1
867
960
  # @option options [String] :content_encoding
868
961
  # Specifies what content encodings have been applied to the object and
869
962
  # thus what decoding mechanisms must be applied to obtain the media-type
870
- # referenced by the Content-Type header field.
963
+ # referenced by the Content-Type header field. For more information, see
964
+ # [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11][1].
965
+ #
966
+ #
967
+ #
968
+ # [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11
871
969
  # @option options [String] :content_language
872
970
  # The language the content is in.
873
971
  # @option options [Integer] :content_length
874
972
  # Size of the body in bytes. This parameter is useful when the size of
875
- # the body cannot be determined automatically.
973
+ # the body cannot be determined automatically. For more information, see
974
+ # [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13][1].
975
+ #
976
+ #
977
+ #
978
+ # [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13
876
979
  # @option options [String] :content_md5
877
- # The base64-encoded 128-bit MD5 digest of the part data. This parameter
878
- # is auto-populated when using the command from the CLI. This parameted
879
- # is required if object lock parameters are specified.
980
+ # The base64-encoded 128-bit MD5 digest of the message (without the
981
+ # headers) according to RFC 1864. This header can be used as a message
982
+ # integrity check to verify that the data is the same data that was
983
+ # originally sent. Although it is optional, we recommend using the
984
+ # Content-MD5 mechanism as an end-to-end integrity check. For more
985
+ # information about REST request authentication, see [REST
986
+ # Authentication][1].
987
+ #
988
+ #
989
+ #
990
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
880
991
  # @option options [String] :content_type
881
- # A standard MIME type describing the format of the object data.
992
+ # A standard MIME type describing the format of the contents. For more
993
+ # information, see
994
+ # [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17][1].
995
+ #
996
+ #
997
+ #
998
+ # [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
882
999
  # @option options [Time,DateTime,Date,Integer,String] :expires
883
- # The date and time at which the object is no longer cacheable.
1000
+ # The date and time at which the object is no longer cacheable. For more
1001
+ # information, see
1002
+ # [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21][1].
1003
+ #
1004
+ #
1005
+ #
1006
+ # [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21
884
1007
  # @option options [String] :grant_full_control
885
1008
  # Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the
886
1009
  # object.
@@ -896,11 +1019,32 @@ module Aws::S3
896
1019
  # The Server-side encryption algorithm used when storing this object in
897
1020
  # S3 (e.g., AES256, aws:kms).
898
1021
  # @option options [String] :storage_class
899
- # The type of storage to use for the object. Defaults to 'STANDARD'.
1022
+ # If you don't specify, Standard is the default storage class. Amazon
1023
+ # S3 supports other storage classes.
900
1024
  # @option options [String] :website_redirect_location
901
1025
  # If the bucket is configured as a website, redirects requests for this
902
1026
  # object to another object in the same bucket or to an external URL.
903
- # Amazon S3 stores the value of this header in the object metadata.
1027
+ # Amazon S3 stores the value of this header in the object metadata. For
1028
+ # information about object metadata, see .
1029
+ #
1030
+ # In the following example, the request header sets the redirect to an
1031
+ # object (anotherPage.html) in the same bucket:
1032
+ #
1033
+ # `x-amz-website-redirect-location: /anotherPage.html`
1034
+ #
1035
+ # In the following example, the request header sets the object redirect
1036
+ # to another website:
1037
+ #
1038
+ # `x-amz-website-redirect-location: http://www.example.com/`
1039
+ #
1040
+ # For more information about website hosting in Amazon S3, see [Hosting
1041
+ # Websites on Amazon S3][1] and [How to Configure Website Page
1042
+ # Redirects][2].
1043
+ #
1044
+ #
1045
+ #
1046
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
1047
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html
904
1048
  # @option options [String] :sse_customer_algorithm
905
1049
  # Specifies the algorithm to use to when encrypting the object (e.g.,
906
1050
  # AES256).
@@ -915,11 +1059,16 @@ module Aws::S3
915
1059
  # RFC 1321. Amazon S3 uses this header for a message integrity check to
916
1060
  # ensure the encryption key was transmitted without error.
917
1061
  # @option options [String] :ssekms_key_id
918
- # Specifies the AWS KMS key ID to use for object encryption. All GET and
919
- # PUT requests for an object protected by AWS KMS will fail if not made
920
- # via SSL or using SigV4. Documentation on configuring any of the
921
- # officially supported AWS SDKs and CLI can be found at
922
- # http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
1062
+ # If the x-amz-server-side-encryption is present and has the value of
1063
+ # aws:kms, this header specifies the ID of the AWS Key Management
1064
+ # Service (AWS KMS) customer master key (CMK) that was used for the
1065
+ # object.
1066
+ #
1067
+ # If the value of x-amz-server-side-encryption is aws:kms, this header
1068
+ # specifies the ID of the AWS KMS CMK that will be used for the object.
1069
+ # If you specify x-amz-server-side-encryption:aws:kms, but do not
1070
+ # provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses
1071
+ # the AWS managed CMK in AWS to protect the data.
923
1072
  # @option options [String] :ssekms_encryption_context
924
1073
  # Specifies the AWS KMS Encryption Context to use for object encryption.
925
1074
  # The value of this header is a base64-encoded UTF-8 string holding JSON
@@ -934,11 +1083,16 @@ module Aws::S3
934
1083
  # The tag-set for the object. The tag-set must be encoded as URL Query
935
1084
  # parameters. (For example, "Key1=Value1")
936
1085
  # @option options [String] :object_lock_mode
937
- # The object lock mode that you want to apply to this object.
1086
+ # The Object Lock mode that you want to apply to this object.
938
1087
  # @option options [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
939
- # The date and time when you want this object's object lock to expire.
1088
+ # The date and time when you want this object's Object Lock to expire.
940
1089
  # @option options [String] :object_lock_legal_hold_status
941
- # The Legal Hold status that you want to apply to the specified object.
1090
+ # Specifies whether a legal hold will be applied to this object. For
1091
+ # more information about S3 Object Lock, see [Object Lock][1].
1092
+ #
1093
+ #
1094
+ #
1095
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
942
1096
  # @return [Types::PutObjectOutput]
943
1097
  def put(options = {})
944
1098
  options = options.merge(
@@ -1038,7 +1192,9 @@ module Aws::S3
1038
1192
  # })
1039
1193
  # @param [Hash] options ({})
1040
1194
  # @option options [String] :version_id
1195
+ # VersionId used to reference a specific version of the object.
1041
1196
  # @option options [Types::RestoreRequest] :restore_request
1197
+ # Container for restore job parameters.
1042
1198
  # @option options [String] :request_payer
1043
1199
  # Confirms that the requester knows that she or he will be charged for
1044
1200
  # the request. Bucket owners need not specify this parameter in their
@@ -1170,6 +1326,8 @@ module Aws::S3
1170
1326
  # @option options [String] :mfa
1171
1327
  # The concatenation of the authentication device's serial number, a
1172
1328
  # space, and the value that is displayed on your authentication device.
1329
+ # Required to permanently delete a versioned object if versioning is
1330
+ # configured with MFA Delete enabled.
1173
1331
  # @option options [String] :request_payer
1174
1332
  # Confirms that the requester knows that she or he will be charged for
1175
1333
  # the request. Bucket owners need not specify this parameter in their
@@ -1178,7 +1336,7 @@ module Aws::S3
1178
1336
  # http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
1179
1337
  # @option options [Boolean] :bypass_governance_retention
1180
1338
  # Specifies whether you want to delete this object even if it has a
1181
- # Governance-type object lock in place. You must have sufficient
1339
+ # Governance-type Object Lock in place. You must have sufficient
1182
1340
  # permissions to perform this operation.
1183
1341
  # @return [void]
1184
1342
  def batch_delete!(options = {})
@@ -38,7 +38,7 @@ module Aws::S3
38
38
  @object_key
39
39
  end
40
40
 
41
-
41
+ # Container for the bucket owner's display name and ID.
42
42
  # @return [Types::Owner]
43
43
  def owner
44
44
  data[:owner]
@@ -225,11 +225,24 @@ module Aws::S3
225
225
  # })
226
226
  # @param [Hash] options ({})
227
227
  # @option options [String] :acl
228
- # The canned ACL to apply to the object.
228
+ # The canned ACL to apply to the object. For more information, see
229
+ # [Canned ACL][1]
230
+ #
231
+ #
232
+ #
233
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
229
234
  # @option options [Types::AccessControlPolicy] :access_control_policy
230
235
  # Contains the elements that set the ACL permissions for an object per
231
236
  # grantee.
232
237
  # @option options [String] :content_md5
238
+ # The base64-encoded 128-bit MD5 digest of the data. This header must be
239
+ # used as a message integrity check to verify that the request body was
240
+ # not corrupted in transit. For more information, go to [RFC
241
+ # 1864.>][1]
242
+ #
243
+ #
244
+ #
245
+ # [1]: http://www.ietf.org/rfc/rfc1864.txt
233
246
  # @option options [String] :grant_full_control
234
247
  # Allows grantee the read, write, read ACP, and write ACP permissions on
235
248
  # the bucket.