aws-sdk-s3 1.126.0 → 1.128.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +12 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3/bucket.rb +27 -19
- data/lib/aws-sdk-s3/client.rb +204 -171
- data/lib/aws-sdk-s3/client_api.rb +16 -0
- data/lib/aws-sdk-s3/object_summary.rb +14 -0
- data/lib/aws-sdk-s3/object_version.rb +14 -0
- data/lib/aws-sdk-s3/presigner.rb +4 -2
- data/lib/aws-sdk-s3/types.rb +211 -118
- data/lib/aws-sdk-s3.rb +1 -1
- metadata +6 -6
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -28,6 +28,7 @@ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
30
|
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
|
+
require 'aws-sdk-core/plugins/request_compression.rb'
|
31
32
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
33
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
34
|
require 'aws-sdk-core/plugins/sign.rb'
|
@@ -96,6 +97,7 @@ module Aws::S3
|
|
96
97
|
add_plugin(Aws::Plugins::TransferEncoding)
|
97
98
|
add_plugin(Aws::Plugins::HttpChecksum)
|
98
99
|
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
100
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
99
101
|
add_plugin(Aws::Plugins::DefaultsMode)
|
100
102
|
add_plugin(Aws::Plugins::RecursionDetection)
|
101
103
|
add_plugin(Aws::Plugins::Sign)
|
@@ -235,6 +237,10 @@ module Aws::S3
|
|
235
237
|
# Set to true to disable SDK automatically adding host prefix
|
236
238
|
# to default service endpoint when available.
|
237
239
|
#
|
240
|
+
# @option options [Boolean] :disable_request_compression (false)
|
241
|
+
# When set to 'true' the request body will not be compressed
|
242
|
+
# for supported operations.
|
243
|
+
#
|
238
244
|
# @option options [String] :endpoint
|
239
245
|
# The client endpoint is normally constructed from the `:region`
|
240
246
|
# option. You should only configure an `:endpoint` when connecting
|
@@ -292,6 +298,11 @@ module Aws::S3
|
|
292
298
|
# Used when loading credentials from the shared credentials file
|
293
299
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
294
300
|
#
|
301
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
302
|
+
# The minimum size in bytes that triggers compression for request
|
303
|
+
# bodies. The value must be non-negative integer value between 0
|
304
|
+
# and 10485780 bytes inclusive.
|
305
|
+
#
|
295
306
|
# @option options [Boolean] :require_https_for_sse_cpk (true)
|
296
307
|
# When `true`, the endpoint **must** be HTTPS for all operations
|
297
308
|
# where server-side-encryption is used with customer-provided keys.
|
@@ -513,7 +524,7 @@ module Aws::S3
|
|
513
524
|
# When you use this action with S3 on Outposts through the Amazon Web
|
514
525
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
515
526
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
516
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
527
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
517
528
|
#
|
518
529
|
#
|
519
530
|
#
|
@@ -702,7 +713,7 @@ module Aws::S3
|
|
702
713
|
# When you use this action with S3 on Outposts through the Amazon Web
|
703
714
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
704
715
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
705
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
716
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
706
717
|
#
|
707
718
|
#
|
708
719
|
#
|
@@ -1170,7 +1181,7 @@ module Aws::S3
|
|
1170
1181
|
# When you use this action with S3 on Outposts through the Amazon Web
|
1171
1182
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
1172
1183
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
1173
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
1184
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
1174
1185
|
#
|
1175
1186
|
#
|
1176
1187
|
#
|
@@ -2026,7 +2037,7 @@ module Aws::S3
|
|
2026
2037
|
# When you use this action with S3 on Outposts through the Amazon Web
|
2027
2038
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
2028
2039
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2029
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
2040
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2030
2041
|
#
|
2031
2042
|
#
|
2032
2043
|
#
|
@@ -3111,7 +3122,7 @@ module Aws::S3
|
|
3111
3122
|
# When you use this action with S3 on Outposts through the Amazon Web
|
3112
3123
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
3113
3124
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
3114
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
3125
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
3115
3126
|
#
|
3116
3127
|
#
|
3117
3128
|
#
|
@@ -3247,7 +3258,7 @@ module Aws::S3
|
|
3247
3258
|
# When you use this action with S3 on Outposts through the Amazon Web
|
3248
3259
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
3249
3260
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
3250
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
3261
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
3251
3262
|
#
|
3252
3263
|
#
|
3253
3264
|
#
|
@@ -3395,7 +3406,7 @@ module Aws::S3
|
|
3395
3406
|
# When you use this action with S3 on Outposts through the Amazon Web
|
3396
3407
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
3397
3408
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
3398
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
3409
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
3399
3410
|
#
|
3400
3411
|
#
|
3401
3412
|
#
|
@@ -5770,7 +5781,7 @@ module Aws::S3
|
|
5770
5781
|
# When you use this action with S3 on Outposts through the Amazon Web
|
5771
5782
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
5772
5783
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
5773
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
5784
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
5774
5785
|
#
|
5775
5786
|
#
|
5776
5787
|
#
|
@@ -6357,7 +6368,7 @@ module Aws::S3
|
|
6357
6368
|
# When you use this action with S3 on Outposts through the Amazon Web
|
6358
6369
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
6359
6370
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
6360
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
6371
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
6361
6372
|
#
|
6362
6373
|
#
|
6363
6374
|
#
|
@@ -6410,9 +6421,8 @@ module Aws::S3
|
|
6410
6421
|
# Forbidden` (access denied).
|
6411
6422
|
#
|
6412
6423
|
# @option params [required, Array<String>] :object_attributes
|
6413
|
-
#
|
6414
|
-
#
|
6415
|
-
# returned.
|
6424
|
+
# Specifies the fields at the root level that you want returned in the
|
6425
|
+
# response. Fields that you do not specify are not returned.
|
6416
6426
|
#
|
6417
6427
|
# @return [Types::GetObjectAttributesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6418
6428
|
#
|
@@ -6757,7 +6767,7 @@ module Aws::S3
|
|
6757
6767
|
# When you use this action with S3 on Outposts through the Amazon Web
|
6758
6768
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
6759
6769
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
6760
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
6770
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
6761
6771
|
#
|
6762
6772
|
#
|
6763
6773
|
#
|
@@ -6792,49 +6802,49 @@ module Aws::S3
|
|
6792
6802
|
# * {Types::GetObjectTaggingOutput#tag_set #tag_set} => Array<Types::Tag>
|
6793
6803
|
#
|
6794
6804
|
#
|
6795
|
-
# @example Example: To retrieve tag set of
|
6805
|
+
# @example Example: To retrieve tag set of a specific object version
|
6796
6806
|
#
|
6797
|
-
# # The following example retrieves tag set of an object.
|
6807
|
+
# # The following example retrieves tag set of an object. The request specifies object version.
|
6798
6808
|
#
|
6799
6809
|
# resp = client.get_object_tagging({
|
6800
6810
|
# bucket: "examplebucket",
|
6801
|
-
# key: "
|
6811
|
+
# key: "exampleobject",
|
6812
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
6802
6813
|
# })
|
6803
6814
|
#
|
6804
6815
|
# resp.to_h outputs the following:
|
6805
6816
|
# {
|
6806
6817
|
# tag_set: [
|
6807
6818
|
# {
|
6808
|
-
# key: "
|
6809
|
-
# value: "
|
6810
|
-
# },
|
6811
|
-
# {
|
6812
|
-
# key: "Key3",
|
6813
|
-
# value: "Value3",
|
6819
|
+
# key: "Key1",
|
6820
|
+
# value: "Value1",
|
6814
6821
|
# },
|
6815
6822
|
# ],
|
6816
|
-
# version_id: "
|
6823
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
6817
6824
|
# }
|
6818
6825
|
#
|
6819
|
-
# @example Example: To retrieve tag set of
|
6826
|
+
# @example Example: To retrieve tag set of an object
|
6820
6827
|
#
|
6821
|
-
# # The following example retrieves tag set of an object.
|
6828
|
+
# # The following example retrieves tag set of an object.
|
6822
6829
|
#
|
6823
6830
|
# resp = client.get_object_tagging({
|
6824
6831
|
# bucket: "examplebucket",
|
6825
|
-
# key: "
|
6826
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
6832
|
+
# key: "HappyFace.jpg",
|
6827
6833
|
# })
|
6828
6834
|
#
|
6829
6835
|
# resp.to_h outputs the following:
|
6830
6836
|
# {
|
6831
6837
|
# tag_set: [
|
6832
6838
|
# {
|
6833
|
-
# key: "
|
6834
|
-
# value: "
|
6839
|
+
# key: "Key4",
|
6840
|
+
# value: "Value4",
|
6841
|
+
# },
|
6842
|
+
# {
|
6843
|
+
# key: "Key3",
|
6844
|
+
# value: "Value3",
|
6835
6845
|
# },
|
6836
6846
|
# ],
|
6837
|
-
# version_id: "
|
6847
|
+
# version_id: "null",
|
6838
6848
|
# }
|
6839
6849
|
#
|
6840
6850
|
# @example Request syntax with placeholder values
|
@@ -7090,7 +7100,7 @@ module Aws::S3
|
|
7090
7100
|
# When you use this action with S3 on Outposts through the Amazon Web
|
7091
7101
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
7092
7102
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
7093
|
-
# [What is S3 on Outposts][3] in the *Amazon S3 User Guide*.
|
7103
|
+
# [What is S3 on Outposts?][3] in the *Amazon S3 User Guide*.
|
7094
7104
|
#
|
7095
7105
|
#
|
7096
7106
|
#
|
@@ -7247,7 +7257,7 @@ module Aws::S3
|
|
7247
7257
|
# When you use this action with S3 on Outposts through the Amazon Web
|
7248
7258
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
7249
7259
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
7250
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
7260
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
7251
7261
|
#
|
7252
7262
|
#
|
7253
7263
|
#
|
@@ -7507,7 +7517,7 @@ module Aws::S3
|
|
7507
7517
|
# retrieved.
|
7508
7518
|
#
|
7509
7519
|
# @option params [String] :continuation_token
|
7510
|
-
# The ContinuationToken that represents a placeholder from where this
|
7520
|
+
# The `ContinuationToken` that represents a placeholder from where this
|
7511
7521
|
# request should begin.
|
7512
7522
|
#
|
7513
7523
|
# @option params [String] :expected_bucket_owner
|
@@ -7693,7 +7703,7 @@ module Aws::S3
|
|
7693
7703
|
#
|
7694
7704
|
# @option params [String] :continuation_token
|
7695
7705
|
# The marker used to continue an inventory configuration listing that
|
7696
|
-
# has been truncated. Use the NextContinuationToken from a previously
|
7706
|
+
# has been truncated. Use the `NextContinuationToken` from a previously
|
7697
7707
|
# truncated list response to continue the listing. The continuation
|
7698
7708
|
# token is an opaque value that Amazon S3 understands.
|
7699
7709
|
#
|
@@ -7793,7 +7803,7 @@ module Aws::S3
|
|
7793
7803
|
#
|
7794
7804
|
# @option params [String] :continuation_token
|
7795
7805
|
# The marker that is used to continue a metrics configuration listing
|
7796
|
-
# that has been truncated. Use the NextContinuationToken from a
|
7806
|
+
# that has been truncated. Use the `NextContinuationToken` from a
|
7797
7807
|
# previously truncated list response to continue the listing. The
|
7798
7808
|
# continuation token is an opaque value that Amazon S3 understands.
|
7799
7809
|
#
|
@@ -7972,7 +7982,7 @@ module Aws::S3
|
|
7972
7982
|
# When you use this action with S3 on Outposts through the Amazon Web
|
7973
7983
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
7974
7984
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
7975
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
7985
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
7976
7986
|
#
|
7977
7987
|
#
|
7978
7988
|
#
|
@@ -7991,15 +8001,15 @@ module Aws::S3
|
|
7991
8001
|
#
|
7992
8002
|
# @option params [String] :encoding_type
|
7993
8003
|
# Requests Amazon S3 to encode the object keys in the response and
|
7994
|
-
# specifies the encoding method to use. An object key
|
7995
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
8004
|
+
# specifies the encoding method to use. An object key can contain any
|
8005
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
7996
8006
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
7997
8007
|
# characters that are not supported in XML 1.0, you can add this
|
7998
8008
|
# parameter to request that Amazon S3 encode the keys in the response.
|
7999
8009
|
#
|
8000
8010
|
# @option params [String] :key_marker
|
8001
|
-
# Together with upload-id-marker
|
8002
|
-
# upload after which listing should begin.
|
8011
|
+
# Together with `upload-id-marker`, this parameter specifies the
|
8012
|
+
# multipart upload after which listing should begin.
|
8003
8013
|
#
|
8004
8014
|
# If `upload-id-marker` is not specified, only the keys
|
8005
8015
|
# lexicographically greater than the specified `key-marker` will be
|
@@ -8018,8 +8028,8 @@ module Aws::S3
|
|
8018
8028
|
# @option params [String] :prefix
|
8019
8029
|
# Lists in-progress uploads only for those keys that begin with the
|
8020
8030
|
# specified prefix. You can use prefixes to separate a bucket into
|
8021
|
-
# different grouping of keys. (You can think of using prefix to make
|
8022
|
-
# groups in the same way you'd use a folder in a file system.)
|
8031
|
+
# different grouping of keys. (You can think of using `prefix` to make
|
8032
|
+
# groups in the same way that you'd use a folder in a file system.)
|
8023
8033
|
#
|
8024
8034
|
# @option params [String] :upload_id_marker
|
8025
8035
|
# Together with key-marker, specifies the multipart upload after which
|
@@ -8064,97 +8074,97 @@ module Aws::S3
|
|
8064
8074
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8065
8075
|
#
|
8066
8076
|
#
|
8067
|
-
# @example Example:
|
8077
|
+
# @example Example: To list in-progress multipart uploads on a bucket
|
8068
8078
|
#
|
8069
|
-
# # The following example
|
8070
|
-
# # setup of multipart uploads.
|
8079
|
+
# # The following example lists in-progress multipart uploads on a specific bucket.
|
8071
8080
|
#
|
8072
8081
|
# resp = client.list_multipart_uploads({
|
8073
8082
|
# bucket: "examplebucket",
|
8074
|
-
# key_marker: "nextkeyfrompreviousresponse",
|
8075
|
-
# max_uploads: 2,
|
8076
|
-
# upload_id_marker: "valuefrompreviousresponse",
|
8077
8083
|
# })
|
8078
8084
|
#
|
8079
8085
|
# resp.to_h outputs the following:
|
8080
8086
|
# {
|
8081
|
-
# bucket: "acl1",
|
8082
|
-
# is_truncated: true,
|
8083
|
-
# key_marker: "",
|
8084
|
-
# max_uploads: 2,
|
8085
|
-
# next_key_marker: "someobjectkey",
|
8086
|
-
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
8087
|
-
# upload_id_marker: "",
|
8088
8087
|
# uploads: [
|
8089
8088
|
# {
|
8090
8089
|
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
8091
8090
|
# initiator: {
|
8092
|
-
# display_name: "
|
8091
|
+
# display_name: "display-name",
|
8093
8092
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
8094
8093
|
# },
|
8095
8094
|
# key: "JavaFile",
|
8096
8095
|
# owner: {
|
8097
|
-
# display_name: "
|
8098
|
-
# id: "
|
8096
|
+
# display_name: "display-name",
|
8097
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
8099
8098
|
# },
|
8100
8099
|
# storage_class: "STANDARD",
|
8101
|
-
# upload_id: "
|
8100
|
+
# upload_id: "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
8102
8101
|
# },
|
8103
8102
|
# {
|
8104
8103
|
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
8105
8104
|
# initiator: {
|
8106
|
-
# display_name: "
|
8105
|
+
# display_name: "display-name",
|
8107
8106
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
8108
8107
|
# },
|
8109
8108
|
# key: "JavaFile",
|
8110
8109
|
# owner: {
|
8111
|
-
# display_name: "
|
8110
|
+
# display_name: "display-name",
|
8112
8111
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
8113
8112
|
# },
|
8114
8113
|
# storage_class: "STANDARD",
|
8115
|
-
# upload_id: "
|
8114
|
+
# upload_id: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
8116
8115
|
# },
|
8117
8116
|
# ],
|
8118
8117
|
# }
|
8119
8118
|
#
|
8120
|
-
# @example Example:
|
8119
|
+
# @example Example: List next set of multipart uploads when previous result is truncated
|
8121
8120
|
#
|
8122
|
-
# # The following example
|
8121
|
+
# # The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next
|
8122
|
+
# # setup of multipart uploads.
|
8123
8123
|
#
|
8124
8124
|
# resp = client.list_multipart_uploads({
|
8125
8125
|
# bucket: "examplebucket",
|
8126
|
+
# key_marker: "nextkeyfrompreviousresponse",
|
8127
|
+
# max_uploads: 2,
|
8128
|
+
# upload_id_marker: "valuefrompreviousresponse",
|
8126
8129
|
# })
|
8127
8130
|
#
|
8128
8131
|
# resp.to_h outputs the following:
|
8129
8132
|
# {
|
8133
|
+
# bucket: "acl1",
|
8134
|
+
# is_truncated: true,
|
8135
|
+
# key_marker: "",
|
8136
|
+
# max_uploads: 2,
|
8137
|
+
# next_key_marker: "someobjectkey",
|
8138
|
+
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
8139
|
+
# upload_id_marker: "",
|
8130
8140
|
# uploads: [
|
8131
8141
|
# {
|
8132
8142
|
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
8133
8143
|
# initiator: {
|
8134
|
-
# display_name: "display-name",
|
8144
|
+
# display_name: "ownder-display-name",
|
8135
8145
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
8136
8146
|
# },
|
8137
8147
|
# key: "JavaFile",
|
8138
8148
|
# owner: {
|
8139
|
-
# display_name: "
|
8140
|
-
# id: "
|
8149
|
+
# display_name: "mohanataws",
|
8150
|
+
# id: "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
8141
8151
|
# },
|
8142
8152
|
# storage_class: "STANDARD",
|
8143
|
-
# upload_id: "
|
8153
|
+
# upload_id: "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
8144
8154
|
# },
|
8145
8155
|
# {
|
8146
8156
|
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
8147
8157
|
# initiator: {
|
8148
|
-
# display_name: "display-name",
|
8158
|
+
# display_name: "ownder-display-name",
|
8149
8159
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
8150
8160
|
# },
|
8151
8161
|
# key: "JavaFile",
|
8152
8162
|
# owner: {
|
8153
|
-
# display_name: "display-name",
|
8163
|
+
# display_name: "ownder-display-name",
|
8154
8164
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
8155
8165
|
# },
|
8156
8166
|
# storage_class: "STANDARD",
|
8157
|
-
# upload_id: "
|
8167
|
+
# upload_id: "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
8158
8168
|
# },
|
8159
8169
|
# ],
|
8160
8170
|
# }
|
@@ -8212,10 +8222,10 @@ module Aws::S3
|
|
8212
8222
|
# can also use request parameters as selection criteria to return
|
8213
8223
|
# metadata about a subset of all the object versions.
|
8214
8224
|
#
|
8215
|
-
# To use this operation, you must have
|
8225
|
+
# To use this operation, you must have permission to perform the
|
8216
8226
|
# `s3:ListBucketVersions` action. Be aware of the name difference.
|
8217
8227
|
#
|
8218
|
-
# <note markdown="1"> A 200 OK response can contain valid or invalid XML. Make sure to
|
8228
|
+
# <note markdown="1"> A `200 OK` response can contain valid or invalid XML. Make sure to
|
8219
8229
|
# design your application to parse the contents of the response and
|
8220
8230
|
# handle it appropriately.
|
8221
8231
|
#
|
@@ -8249,14 +8259,14 @@ module Aws::S3
|
|
8249
8259
|
# A delimiter is a character that you specify to group keys. All keys
|
8250
8260
|
# that contain the same string between the `prefix` and the first
|
8251
8261
|
# occurrence of the delimiter are grouped under a single result element
|
8252
|
-
# in CommonPrefixes
|
8253
|
-
# max-keys limitation. These keys are not returned elsewhere in
|
8254
|
-
# response.
|
8262
|
+
# in `CommonPrefixes`. These groups are counted as one result against
|
8263
|
+
# the `max-keys` limitation. These keys are not returned elsewhere in
|
8264
|
+
# the response.
|
8255
8265
|
#
|
8256
8266
|
# @option params [String] :encoding_type
|
8257
8267
|
# Requests Amazon S3 to encode the object keys in the response and
|
8258
|
-
# specifies the encoding method to use. An object key
|
8259
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
8268
|
+
# specifies the encoding method to use. An object key can contain any
|
8269
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
8260
8270
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
8261
8271
|
# characters that are not supported in XML 1.0, you can add this
|
8262
8272
|
# parameter to request that Amazon S3 encode the keys in the response.
|
@@ -8265,20 +8275,20 @@ module Aws::S3
|
|
8265
8275
|
# Specifies the key to start with when listing objects in a bucket.
|
8266
8276
|
#
|
8267
8277
|
# @option params [Integer] :max_keys
|
8268
|
-
# Sets the maximum number of keys returned in the response. By default
|
8278
|
+
# Sets the maximum number of keys returned in the response. By default,
|
8269
8279
|
# the action returns up to 1,000 key names. The response might contain
|
8270
8280
|
# fewer keys but will never contain more. If additional keys satisfy the
|
8271
|
-
# search criteria, but were not returned because max-keys was
|
8272
|
-
# the response contains
|
8273
|
-
# return the additional keys, see key-marker and version-id-marker
|
8281
|
+
# search criteria, but were not returned because `max-keys` was
|
8282
|
+
# exceeded, the response contains `<isTruncated>true</isTruncated>`. To
|
8283
|
+
# return the additional keys, see `key-marker` and `version-id-marker`.
|
8274
8284
|
#
|
8275
8285
|
# @option params [String] :prefix
|
8276
8286
|
# Use this parameter to select only those keys that begin with the
|
8277
8287
|
# specified prefix. You can use prefixes to separate a bucket into
|
8278
|
-
# different groupings of keys. (You can think of using prefix to make
|
8279
|
-
# groups in the same way you'd use a folder in a file system.) You
|
8280
|
-
# use prefix with delimiter to roll up numerous objects into a
|
8281
|
-
# result under CommonPrefixes
|
8288
|
+
# different groupings of keys. (You can think of using `prefix` to make
|
8289
|
+
# groups in the same way that you'd use a folder in a file system.) You
|
8290
|
+
# can use `prefix` with `delimiter` to roll up numerous objects into a
|
8291
|
+
# single result under `CommonPrefixes`.
|
8282
8292
|
#
|
8283
8293
|
# @option params [String] :version_id_marker
|
8284
8294
|
# Specifies the object version you want to start listing from.
|
@@ -8299,6 +8309,10 @@ module Aws::S3
|
|
8299
8309
|
#
|
8300
8310
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
8301
8311
|
#
|
8312
|
+
# @option params [Array<String>] :optional_object_attributes
|
8313
|
+
# Specifies the optional fields that you want returned in the response.
|
8314
|
+
# Fields that you do not specify are not returned.
|
8315
|
+
#
|
8302
8316
|
# @return [Types::ListObjectVersionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8303
8317
|
#
|
8304
8318
|
# * {Types::ListObjectVersionsOutput#is_truncated #is_truncated} => Boolean
|
@@ -8374,6 +8388,7 @@ module Aws::S3
|
|
8374
8388
|
# version_id_marker: "VersionIdMarker",
|
8375
8389
|
# expected_bucket_owner: "AccountId",
|
8376
8390
|
# request_payer: "requester", # accepts requester
|
8391
|
+
# optional_object_attributes: ["RestoreStatus"], # accepts RestoreStatus
|
8377
8392
|
# })
|
8378
8393
|
#
|
8379
8394
|
# @example Response structure
|
@@ -8395,6 +8410,8 @@ module Aws::S3
|
|
8395
8410
|
# resp.versions[0].last_modified #=> Time
|
8396
8411
|
# resp.versions[0].owner.display_name #=> String
|
8397
8412
|
# resp.versions[0].owner.id #=> String
|
8413
|
+
# resp.versions[0].restore_status.is_restore_in_progress #=> Boolean
|
8414
|
+
# resp.versions[0].restore_status.restore_expiry_date #=> Time
|
8398
8415
|
# resp.delete_markers #=> Array
|
8399
8416
|
# resp.delete_markers[0].owner.display_name #=> String
|
8400
8417
|
# resp.delete_markers[0].owner.id #=> String
|
@@ -8468,7 +8485,7 @@ module Aws::S3
|
|
8468
8485
|
# When you use this action with S3 on Outposts through the Amazon Web
|
8469
8486
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
8470
8487
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8471
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
8488
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
8472
8489
|
#
|
8473
8490
|
#
|
8474
8491
|
#
|
@@ -8476,12 +8493,12 @@ module Aws::S3
|
|
8476
8493
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
8477
8494
|
#
|
8478
8495
|
# @option params [String] :delimiter
|
8479
|
-
# A delimiter is a character you use to group keys.
|
8496
|
+
# A delimiter is a character that you use to group keys.
|
8480
8497
|
#
|
8481
8498
|
# @option params [String] :encoding_type
|
8482
8499
|
# Requests Amazon S3 to encode the object keys in the response and
|
8483
|
-
# specifies the encoding method to use. An object key
|
8484
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
8500
|
+
# specifies the encoding method to use. An object key can contain any
|
8501
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
8485
8502
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
8486
8503
|
# characters that are not supported in XML 1.0, you can add this
|
8487
8504
|
# parameter to request that Amazon S3 encode the keys in the response.
|
@@ -8492,7 +8509,7 @@ module Aws::S3
|
|
8492
8509
|
# bucket.
|
8493
8510
|
#
|
8494
8511
|
# @option params [Integer] :max_keys
|
8495
|
-
# Sets the maximum number of keys returned in the response. By default
|
8512
|
+
# Sets the maximum number of keys returned in the response. By default,
|
8496
8513
|
# the action returns up to 1,000 key names. The response might contain
|
8497
8514
|
# fewer keys but will never contain more.
|
8498
8515
|
#
|
@@ -8509,6 +8526,10 @@ module Aws::S3
|
|
8509
8526
|
# a different account, the request fails with the HTTP status code `403
|
8510
8527
|
# Forbidden` (access denied).
|
8511
8528
|
#
|
8529
|
+
# @option params [Array<String>] :optional_object_attributes
|
8530
|
+
# Specifies the optional fields that you want returned in the response.
|
8531
|
+
# Fields that you do not specify are not returned.
|
8532
|
+
#
|
8512
8533
|
# @return [Types::ListObjectsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8513
8534
|
#
|
8514
8535
|
# * {Types::ListObjectsOutput#is_truncated #is_truncated} => Boolean
|
@@ -8575,6 +8596,7 @@ module Aws::S3
|
|
8575
8596
|
# prefix: "Prefix",
|
8576
8597
|
# request_payer: "requester", # accepts requester
|
8577
8598
|
# expected_bucket_owner: "AccountId",
|
8599
|
+
# optional_object_attributes: ["RestoreStatus"], # accepts RestoreStatus
|
8578
8600
|
# })
|
8579
8601
|
#
|
8580
8602
|
# @example Response structure
|
@@ -8592,6 +8614,8 @@ module Aws::S3
|
|
8592
8614
|
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW"
|
8593
8615
|
# resp.contents[0].owner.display_name #=> String
|
8594
8616
|
# resp.contents[0].owner.id #=> String
|
8617
|
+
# resp.contents[0].restore_status.is_restore_in_progress #=> Boolean
|
8618
|
+
# resp.contents[0].restore_status.restore_expiry_date #=> Time
|
8595
8619
|
# resp.name #=> String
|
8596
8620
|
# resp.prefix #=> String
|
8597
8621
|
# resp.delimiter #=> String
|
@@ -8617,21 +8641,23 @@ module Aws::S3
|
|
8617
8641
|
# parse the contents of the response and handle it appropriately.
|
8618
8642
|
# Objects are returned sorted in an ascending order of the respective
|
8619
8643
|
# key names in the list. For more information about listing objects, see
|
8620
|
-
# [Listing object keys programmatically][1]
|
8644
|
+
# [Listing object keys programmatically][1] in the *Amazon S3 User
|
8645
|
+
# Guide*.
|
8621
8646
|
#
|
8622
8647
|
# To use this operation, you must have READ access to the bucket.
|
8623
8648
|
#
|
8624
8649
|
# To use this action in an Identity and Access Management (IAM) policy,
|
8625
|
-
# you must have
|
8650
|
+
# you must have permission to perform the `s3:ListBucket` action. The
|
8626
8651
|
# bucket owner has this permission by default and can grant this
|
8627
8652
|
# permission to others. For more information about permissions, see
|
8628
8653
|
# [Permissions Related to Bucket Subresource Operations][2] and
|
8629
|
-
# [Managing Access Permissions to Your Amazon S3 Resources][3]
|
8654
|
+
# [Managing Access Permissions to Your Amazon S3 Resources][3] in the
|
8655
|
+
# *Amazon S3 User Guide*.
|
8630
8656
|
#
|
8631
8657
|
# This section describes the latest revision of this action. We
|
8632
|
-
# recommend that you use this revised API for application
|
8633
|
-
# For backward compatibility, Amazon S3 continues to
|
8634
|
-
# version of this API, [ListObjects][4].
|
8658
|
+
# recommend that you use this revised API operation for application
|
8659
|
+
# development. For backward compatibility, Amazon S3 continues to
|
8660
|
+
# support the prior version of this API operation, [ListObjects][4].
|
8635
8661
|
#
|
8636
8662
|
# To get a list of your buckets, see [ListBuckets][5].
|
8637
8663
|
#
|
@@ -8672,7 +8698,7 @@ module Aws::S3
|
|
8672
8698
|
# When you use this action with S3 on Outposts through the Amazon Web
|
8673
8699
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
8674
8700
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8675
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
8701
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
8676
8702
|
#
|
8677
8703
|
#
|
8678
8704
|
#
|
@@ -8680,13 +8706,13 @@ module Aws::S3
|
|
8680
8706
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
8681
8707
|
#
|
8682
8708
|
# @option params [String] :delimiter
|
8683
|
-
# A delimiter is a character you use to group keys.
|
8709
|
+
# A delimiter is a character that you use to group keys.
|
8684
8710
|
#
|
8685
8711
|
# @option params [String] :encoding_type
|
8686
8712
|
# Encoding type used by Amazon S3 to encode object keys in the response.
|
8687
8713
|
#
|
8688
8714
|
# @option params [Integer] :max_keys
|
8689
|
-
# Sets the maximum number of keys returned in the response. By default
|
8715
|
+
# Sets the maximum number of keys returned in the response. By default,
|
8690
8716
|
# the action returns up to 1,000 key names. The response might contain
|
8691
8717
|
# fewer keys but will never contain more.
|
8692
8718
|
#
|
@@ -8694,14 +8720,14 @@ module Aws::S3
|
|
8694
8720
|
# Limits the response to keys that begin with the specified prefix.
|
8695
8721
|
#
|
8696
8722
|
# @option params [String] :continuation_token
|
8697
|
-
# ContinuationToken indicates Amazon S3 that the list is being
|
8698
|
-
# on this bucket with a token. ContinuationToken is
|
8699
|
-
# not a real key.
|
8723
|
+
# `ContinuationToken` indicates to Amazon S3 that the list is being
|
8724
|
+
# continued on this bucket with a token. `ContinuationToken` is
|
8725
|
+
# obfuscated and is not a real key.
|
8700
8726
|
#
|
8701
8727
|
# @option params [Boolean] :fetch_owner
|
8702
|
-
# The owner field is not present in
|
8703
|
-
# return owner field with each key in the result then set
|
8704
|
-
#
|
8728
|
+
# The owner field is not present in `ListObjectsV2` by default. If you
|
8729
|
+
# want to return the owner field with each key in the result, then set
|
8730
|
+
# the `FetchOwner` field to `true`.
|
8705
8731
|
#
|
8706
8732
|
# @option params [String] :start_after
|
8707
8733
|
# StartAfter is where you want Amazon S3 to start listing from. Amazon
|
@@ -8718,6 +8744,10 @@ module Aws::S3
|
|
8718
8744
|
# a different account, the request fails with the HTTP status code `403
|
8719
8745
|
# Forbidden` (access denied).
|
8720
8746
|
#
|
8747
|
+
# @option params [Array<String>] :optional_object_attributes
|
8748
|
+
# Specifies the optional fields that you want returned in the response.
|
8749
|
+
# Fields that you do not specify are not returned.
|
8750
|
+
#
|
8721
8751
|
# @return [Types::ListObjectsV2Output] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8722
8752
|
#
|
8723
8753
|
# * {Types::ListObjectsV2Output#is_truncated #is_truncated} => Boolean
|
@@ -8786,6 +8816,7 @@ module Aws::S3
|
|
8786
8816
|
# start_after: "StartAfter",
|
8787
8817
|
# request_payer: "requester", # accepts requester
|
8788
8818
|
# expected_bucket_owner: "AccountId",
|
8819
|
+
# optional_object_attributes: ["RestoreStatus"], # accepts RestoreStatus
|
8789
8820
|
# })
|
8790
8821
|
#
|
8791
8822
|
# @example Response structure
|
@@ -8801,6 +8832,8 @@ module Aws::S3
|
|
8801
8832
|
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW"
|
8802
8833
|
# resp.contents[0].owner.display_name #=> String
|
8803
8834
|
# resp.contents[0].owner.id #=> String
|
8835
|
+
# resp.contents[0].restore_status.is_restore_in_progress #=> Boolean
|
8836
|
+
# resp.contents[0].restore_status.restore_expiry_date #=> Time
|
8804
8837
|
# resp.name #=> String
|
8805
8838
|
# resp.prefix #=> String
|
8806
8839
|
# resp.delimiter #=> String
|
@@ -8889,7 +8922,7 @@ module Aws::S3
|
|
8889
8922
|
# When you use this action with S3 on Outposts through the Amazon Web
|
8890
8923
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
8891
8924
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8892
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
8925
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
8893
8926
|
#
|
8894
8927
|
#
|
8895
8928
|
#
|
@@ -12152,7 +12185,7 @@ module Aws::S3
|
|
12152
12185
|
# When you use this action with S3 on Outposts through the Amazon Web
|
12153
12186
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
12154
12187
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
12155
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
12188
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
12156
12189
|
#
|
12157
12190
|
#
|
12158
12191
|
#
|
@@ -12456,40 +12489,45 @@ module Aws::S3
|
|
12456
12489
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
12457
12490
|
#
|
12458
12491
|
#
|
12459
|
-
# @example Example: To upload
|
12492
|
+
# @example Example: To upload object and specify user-defined metadata
|
12460
12493
|
#
|
12461
|
-
# # The following example
|
12462
|
-
# # S3 returns version ID
|
12494
|
+
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
12495
|
+
# # enabled, S3 returns version ID in response.
|
12463
12496
|
#
|
12464
12497
|
# resp = client.put_object({
|
12465
|
-
# body: "
|
12498
|
+
# body: "filetoupload",
|
12466
12499
|
# bucket: "examplebucket",
|
12467
|
-
# key: "
|
12468
|
-
#
|
12500
|
+
# key: "exampleobject",
|
12501
|
+
# metadata: {
|
12502
|
+
# "metadata1" => "value1",
|
12503
|
+
# "metadata2" => "value2",
|
12504
|
+
# },
|
12469
12505
|
# })
|
12470
12506
|
#
|
12471
12507
|
# resp.to_h outputs the following:
|
12472
12508
|
# {
|
12473
12509
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12474
|
-
# version_id: "
|
12510
|
+
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
12475
12511
|
# }
|
12476
12512
|
#
|
12477
|
-
# @example Example: To upload an object
|
12513
|
+
# @example Example: To upload an object (specify optional headers)
|
12478
12514
|
#
|
12479
|
-
# # The following example uploads
|
12480
|
-
# #
|
12515
|
+
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
|
12516
|
+
# # storage class and use server-side encryption.
|
12481
12517
|
#
|
12482
12518
|
# resp = client.put_object({
|
12483
|
-
#
|
12484
|
-
# body: "filetoupload",
|
12519
|
+
# body: "HappyFace.jpg",
|
12485
12520
|
# bucket: "examplebucket",
|
12486
|
-
# key: "
|
12521
|
+
# key: "HappyFace.jpg",
|
12522
|
+
# server_side_encryption: "AES256",
|
12523
|
+
# storage_class: "STANDARD_IA",
|
12487
12524
|
# })
|
12488
12525
|
#
|
12489
12526
|
# resp.to_h outputs the following:
|
12490
12527
|
# {
|
12491
12528
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12492
|
-
#
|
12529
|
+
# server_side_encryption: "AES256",
|
12530
|
+
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
12493
12531
|
# }
|
12494
12532
|
#
|
12495
12533
|
# @example Example: To create an object.
|
@@ -12508,82 +12546,77 @@ module Aws::S3
|
|
12508
12546
|
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
12509
12547
|
# }
|
12510
12548
|
#
|
12511
|
-
# @example Example: To upload an object and specify
|
12549
|
+
# @example Example: To upload an object and specify canned ACL.
|
12512
12550
|
#
|
12513
|
-
# # The following example uploads
|
12514
|
-
# #
|
12551
|
+
# # The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ
|
12552
|
+
# # access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
|
12515
12553
|
#
|
12516
12554
|
# resp = client.put_object({
|
12555
|
+
# acl: "authenticated-read",
|
12517
12556
|
# body: "filetoupload",
|
12518
12557
|
# bucket: "examplebucket",
|
12519
12558
|
# key: "exampleobject",
|
12520
|
-
# server_side_encryption: "AES256",
|
12521
|
-
# tagging: "key1=value1&key2=value2",
|
12522
12559
|
# })
|
12523
12560
|
#
|
12524
12561
|
# resp.to_h outputs the following:
|
12525
12562
|
# {
|
12526
12563
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12527
|
-
#
|
12528
|
-
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
12564
|
+
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
12529
12565
|
# }
|
12530
12566
|
#
|
12531
|
-
# @example Example: To upload object
|
12567
|
+
# @example Example: To upload an object
|
12532
12568
|
#
|
12533
|
-
# # The following example
|
12534
|
-
# #
|
12569
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
12570
|
+
# # syntax. S3 returns VersionId of the newly created object.
|
12535
12571
|
#
|
12536
12572
|
# resp = client.put_object({
|
12537
|
-
# body: "
|
12573
|
+
# body: "HappyFace.jpg",
|
12538
12574
|
# bucket: "examplebucket",
|
12539
|
-
# key: "
|
12540
|
-
# metadata: {
|
12541
|
-
# "metadata1" => "value1",
|
12542
|
-
# "metadata2" => "value2",
|
12543
|
-
# },
|
12575
|
+
# key: "HappyFace.jpg",
|
12544
12576
|
# })
|
12545
12577
|
#
|
12546
12578
|
# resp.to_h outputs the following:
|
12547
12579
|
# {
|
12548
12580
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12549
|
-
# version_id: "
|
12581
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
12550
12582
|
# }
|
12551
12583
|
#
|
12552
|
-
# @example Example: To upload an object
|
12584
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
12553
12585
|
#
|
12554
|
-
# # The following example uploads an object
|
12555
|
-
# #
|
12586
|
+
# # The following example uploads an object. The request specifies the optional server-side encryption option. The request
|
12587
|
+
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
12556
12588
|
#
|
12557
12589
|
# resp = client.put_object({
|
12558
|
-
# body: "
|
12590
|
+
# body: "filetoupload",
|
12559
12591
|
# bucket: "examplebucket",
|
12560
|
-
# key: "
|
12592
|
+
# key: "exampleobject",
|
12593
|
+
# server_side_encryption: "AES256",
|
12594
|
+
# tagging: "key1=value1&key2=value2",
|
12561
12595
|
# })
|
12562
12596
|
#
|
12563
12597
|
# resp.to_h outputs the following:
|
12564
12598
|
# {
|
12565
12599
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12566
|
-
#
|
12600
|
+
# server_side_encryption: "AES256",
|
12601
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
12567
12602
|
# }
|
12568
12603
|
#
|
12569
|
-
# @example Example: To upload an object
|
12604
|
+
# @example Example: To upload an object and specify optional tags
|
12570
12605
|
#
|
12571
|
-
# # The following example uploads an object. The request specifies optional
|
12572
|
-
# #
|
12606
|
+
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
|
12607
|
+
# # S3 returns version ID of the newly created object.
|
12573
12608
|
#
|
12574
12609
|
# resp = client.put_object({
|
12575
|
-
# body: "HappyFace.jpg",
|
12610
|
+
# body: "c:\\HappyFace.jpg",
|
12576
12611
|
# bucket: "examplebucket",
|
12577
12612
|
# key: "HappyFace.jpg",
|
12578
|
-
#
|
12579
|
-
# storage_class: "STANDARD_IA",
|
12613
|
+
# tagging: "key1=value1&key2=value2",
|
12580
12614
|
# })
|
12581
12615
|
#
|
12582
12616
|
# resp.to_h outputs the following:
|
12583
12617
|
# {
|
12584
12618
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12585
|
-
#
|
12586
|
-
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
12619
|
+
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
12587
12620
|
# }
|
12588
12621
|
#
|
12589
12622
|
# @example Streaming a file from disk
|
@@ -12929,7 +12962,7 @@ module Aws::S3
|
|
12929
12962
|
# When you use this action with S3 on Outposts through the Amazon Web
|
12930
12963
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
12931
12964
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
12932
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
12965
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
12933
12966
|
#
|
12934
12967
|
#
|
12935
12968
|
#
|
@@ -13433,7 +13466,7 @@ module Aws::S3
|
|
13433
13466
|
# When you use this action with S3 on Outposts through the Amazon Web
|
13434
13467
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
13435
13468
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
13436
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
13469
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
13437
13470
|
#
|
13438
13471
|
#
|
13439
13472
|
#
|
@@ -13895,7 +13928,7 @@ module Aws::S3
|
|
13895
13928
|
# When you use this action with S3 on Outposts through the Amazon Web
|
13896
13929
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
13897
13930
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
13898
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
13931
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
13899
13932
|
#
|
13900
13933
|
#
|
13901
13934
|
#
|
@@ -14629,7 +14662,7 @@ module Aws::S3
|
|
14629
14662
|
# When you use this action with S3 on Outposts through the Amazon Web
|
14630
14663
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
14631
14664
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
14632
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
14665
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
14633
14666
|
#
|
14634
14667
|
#
|
14635
14668
|
#
|
@@ -14978,7 +15011,7 @@ module Aws::S3
|
|
14978
15011
|
# When you use this action with S3 on Outposts through the Amazon Web
|
14979
15012
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
14980
15013
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
14981
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
15014
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
14982
15015
|
#
|
14983
15016
|
#
|
14984
15017
|
#
|
@@ -15128,45 +15161,45 @@ module Aws::S3
|
|
15128
15161
|
# * {Types::UploadPartCopyOutput#request_charged #request_charged} => String
|
15129
15162
|
#
|
15130
15163
|
#
|
15131
|
-
# @example Example: To upload a part by copying
|
15164
|
+
# @example Example: To upload a part by copying data from an existing object as data source
|
15132
15165
|
#
|
15133
|
-
# # The following example uploads a part of a multipart upload by copying
|
15134
|
-
# # data source.
|
15166
|
+
# # The following example uploads a part of a multipart upload by copying data from an existing object as data source.
|
15135
15167
|
#
|
15136
15168
|
# resp = client.upload_part_copy({
|
15137
15169
|
# bucket: "examplebucket",
|
15138
15170
|
# copy_source: "/bucketname/sourceobjectkey",
|
15139
|
-
# copy_source_range: "bytes=1-100000",
|
15140
15171
|
# key: "examplelargeobject",
|
15141
|
-
# part_number:
|
15172
|
+
# part_number: 1,
|
15142
15173
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
15143
15174
|
# })
|
15144
15175
|
#
|
15145
15176
|
# resp.to_h outputs the following:
|
15146
15177
|
# {
|
15147
15178
|
# copy_part_result: {
|
15148
|
-
# etag: "\"
|
15149
|
-
# last_modified: Time.parse("2016-12-29T21:
|
15179
|
+
# etag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
|
15180
|
+
# last_modified: Time.parse("2016-12-29T21:24:43.000Z"),
|
15150
15181
|
# },
|
15151
15182
|
# }
|
15152
15183
|
#
|
15153
|
-
# @example Example: To upload a part by copying
|
15184
|
+
# @example Example: To upload a part by copying byte range from an existing object as data source
|
15154
15185
|
#
|
15155
|
-
# # The following example uploads a part of a multipart upload by copying
|
15186
|
+
# # The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as
|
15187
|
+
# # data source.
|
15156
15188
|
#
|
15157
15189
|
# resp = client.upload_part_copy({
|
15158
15190
|
# bucket: "examplebucket",
|
15159
15191
|
# copy_source: "/bucketname/sourceobjectkey",
|
15192
|
+
# copy_source_range: "bytes=1-100000",
|
15160
15193
|
# key: "examplelargeobject",
|
15161
|
-
# part_number:
|
15194
|
+
# part_number: 2,
|
15162
15195
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
15163
15196
|
# })
|
15164
15197
|
#
|
15165
15198
|
# resp.to_h outputs the following:
|
15166
15199
|
# {
|
15167
15200
|
# copy_part_result: {
|
15168
|
-
# etag: "\"
|
15169
|
-
# last_modified: Time.parse("2016-12-29T21:
|
15201
|
+
# etag: "\"65d16d19e65a7508a51f043180edcc36\"",
|
15202
|
+
# last_modified: Time.parse("2016-12-29T21:44:28.000Z"),
|
15170
15203
|
# },
|
15171
15204
|
# }
|
15172
15205
|
#
|
@@ -15614,7 +15647,7 @@ module Aws::S3
|
|
15614
15647
|
params: params,
|
15615
15648
|
config: config)
|
15616
15649
|
context[:gem_name] = 'aws-sdk-s3'
|
15617
|
-
context[:gem_version] = '1.
|
15650
|
+
context[:gem_version] = '1.128.0'
|
15618
15651
|
Seahorse::Client::Request.new(handlers, context)
|
15619
15652
|
end
|
15620
15653
|
|