1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
|
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
module Aws
module S3
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html
class Object
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#initialize-instance_method
def initialize: (String bucket_name, String key, Hash[Symbol, untyped] options) -> void
| (bucket_name: String, key: String, ?client: Client) -> void
| (Hash[Symbol, untyped] args) -> void
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#bucket_name-instance_method
def bucket_name: () -> String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#key-instance_method
def key: () -> String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#delete_marker-instance_method
def delete_marker: () -> bool
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#accept_ranges-instance_method
def accept_ranges: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#expiration-instance_method
def expiration: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#restore-instance_method
def restore: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#archive_status-instance_method
def archive_status: () -> ("ARCHIVE_ACCESS" | "DEEP_ARCHIVE_ACCESS")
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#last_modified-instance_method
def last_modified: () -> ::Time
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#content_length-instance_method
def content_length: () -> ::Integer
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#checksum_crc32-instance_method
def checksum_crc32: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#checksum_crc32c-instance_method
def checksum_crc32c: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#checksum_sha1-instance_method
def checksum_sha1: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#checksum_sha256-instance_method
def checksum_sha256: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#etag-instance_method
def etag: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#missing_meta-instance_method
def missing_meta: () -> ::Integer
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#version_id-instance_method
def version_id: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#cache_control-instance_method
def cache_control: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#content_disposition-instance_method
def content_disposition: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#content_encoding-instance_method
def content_encoding: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#content_language-instance_method
def content_language: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#content_type-instance_method
def content_type: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#expires-instance_method
def expires: () -> ::Time
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#expires_string-instance_method
def expires_string: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#website_redirect_location-instance_method
def website_redirect_location: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#server_side_encryption-instance_method
def server_side_encryption: () -> ("AES256" | "aws:kms" | "aws:kms:dsse")
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#metadata-instance_method
def metadata: () -> ::Hash[::String, ::String]
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#sse_customer_algorithm-instance_method
def sse_customer_algorithm: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#sse_customer_key_md5-instance_method
def sse_customer_key_md5: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#ssekms_key_id-instance_method
def ssekms_key_id: () -> ::String
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#bucket_key_enabled-instance_method
def bucket_key_enabled: () -> bool
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#storage_class-instance_method
def storage_class: () -> ("STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA" | "ONEZONE_IA" | "INTELLIGENT_TIERING" | "GLACIER" | "DEEP_ARCHIVE" | "OUTPOSTS" | "GLACIER_IR" | "SNOW" | "EXPRESS_ONEZONE")
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#request_charged-instance_method
def request_charged: () -> ("requester")
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#replication_status-instance_method
def replication_status: () -> ("COMPLETE" | "PENDING" | "FAILED" | "REPLICA" | "COMPLETED")
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#parts_count-instance_method
def parts_count: () -> ::Integer
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#object_lock_mode-instance_method
def object_lock_mode: () -> ("GOVERNANCE" | "COMPLIANCE")
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#object_lock_retain_until_date-instance_method
def object_lock_retain_until_date: () -> ::Time
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#object_lock_legal_hold_status-instance_method
def object_lock_legal_hold_status: () -> ("ON" | "OFF")
def client: () -> Client
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#load-instance_method
def load: () -> self
alias reload load
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#data-instance_method
def data: () -> Types::HeadObjectOutput
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#data_loaded?-instance_method
def data_loaded?: () -> bool
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#exists?-instance_method
def exists?: (?max_attempts: Integer, ?delay: Numeric, ?before_attempt: (^(Integer attempts) -> void), ?before_wait: (^(Integer attempts, untyped response) -> void)) -> bool
| (?Hash[Symbol, untyped]) -> bool
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#wait_until_exists-instance_method
def wait_until_exists: (?max_attempts: Integer, ?delay: Numeric, ?before_attempt: (^(Integer attempts) -> void), ?before_wait: (^(Integer attempts, untyped response) -> void)) ?{ (untyped waiter) -> void } -> Object
| (?Hash[Symbol, untyped]) ?{ (untyped waiter) -> void } -> Object
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#wait_until_not_exists-instance_method
def wait_until_not_exists: (?max_attempts: Integer, ?delay: Numeric, ?before_attempt: (^(Integer attempts) -> void), ?before_wait: (^(Integer attempts, untyped response) -> void)) ?{ (untyped waiter) -> void } -> Object
| (?Hash[Symbol, untyped]) ?{ (untyped waiter) -> void } -> Object
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#copy_from-instance_method
def copy_from: (
?acl: ("private" | "public-read" | "public-read-write" | "authenticated-read" | "aws-exec-read" | "bucket-owner-read" | "bucket-owner-full-control"),
?cache_control: ::String,
?checksum_algorithm: ("CRC32" | "CRC32C" | "SHA1" | "SHA256"),
?content_disposition: ::String,
?content_encoding: ::String,
?content_language: ::String,
?content_type: ::String,
copy_source: ::String,
?copy_source_if_match: ::String,
?copy_source_if_modified_since: ::Time,
?copy_source_if_none_match: ::String,
?copy_source_if_unmodified_since: ::Time,
?expires: ::Time,
?grant_full_control: ::String,
?grant_read: ::String,
?grant_read_acp: ::String,
?grant_write_acp: ::String,
?metadata: Hash[::String, ::String],
?metadata_directive: ("COPY" | "REPLACE"),
?tagging_directive: ("COPY" | "REPLACE"),
?server_side_encryption: ("AES256" | "aws:kms" | "aws:kms:dsse"),
?storage_class: ("STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA" | "ONEZONE_IA" | "INTELLIGENT_TIERING" | "GLACIER" | "DEEP_ARCHIVE" | "OUTPOSTS" | "GLACIER_IR" | "SNOW" | "EXPRESS_ONEZONE"),
?website_redirect_location: ::String,
?sse_customer_algorithm: ::String,
?sse_customer_key: ::String,
?sse_customer_key_md5: ::String,
?ssekms_key_id: ::String,
?ssekms_encryption_context: ::String,
?bucket_key_enabled: bool,
?copy_source_sse_customer_algorithm: ::String,
?copy_source_sse_customer_key: ::String,
?copy_source_sse_customer_key_md5: ::String,
?request_payer: ("requester"),
?tagging: ::String,
?object_lock_mode: ("GOVERNANCE" | "COMPLIANCE"),
?object_lock_retain_until_date: ::Time,
?object_lock_legal_hold_status: ("ON" | "OFF"),
?expected_bucket_owner: ::String,
?expected_source_bucket_owner: ::String
) -> Types::CopyObjectOutput
| (?Hash[Symbol, untyped]) -> Types::CopyObjectOutput
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#delete-instance_method
def delete: (
?mfa: ::String,
?version_id: ::String,
?request_payer: ("requester"),
?bypass_governance_retention: bool,
?expected_bucket_owner: ::String
) -> Types::DeleteObjectOutput
| (?Hash[Symbol, untyped]) -> Types::DeleteObjectOutput
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#get-instance_method
def get: (
?if_match: ::String,
?if_modified_since: ::Time,
?if_none_match: ::String,
?if_unmodified_since: ::Time,
?range: ::String,
?response_cache_control: ::String,
?response_content_disposition: ::String,
?response_content_encoding: ::String,
?response_content_language: ::String,
?response_content_type: ::String,
?response_expires: ::Time,
?version_id: ::String,
?sse_customer_algorithm: ::String,
?sse_customer_key: ::String,
?sse_customer_key_md5: ::String,
?request_payer: ("requester"),
?part_number: ::Integer,
?expected_bucket_owner: ::String,
?checksum_mode: ("ENABLED")
) -> Types::GetObjectOutput
| (?Hash[Symbol, untyped]) -> Types::GetObjectOutput
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#initiate_multipart_upload-instance_method
def initiate_multipart_upload: (
?acl: ("private" | "public-read" | "public-read-write" | "authenticated-read" | "aws-exec-read" | "bucket-owner-read" | "bucket-owner-full-control"),
?cache_control: ::String,
?content_disposition: ::String,
?content_encoding: ::String,
?content_language: ::String,
?content_type: ::String,
?expires: ::Time,
?grant_full_control: ::String,
?grant_read: ::String,
?grant_read_acp: ::String,
?grant_write_acp: ::String,
?metadata: Hash[::String, ::String],
?server_side_encryption: ("AES256" | "aws:kms" | "aws:kms:dsse"),
?storage_class: ("STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA" | "ONEZONE_IA" | "INTELLIGENT_TIERING" | "GLACIER" | "DEEP_ARCHIVE" | "OUTPOSTS" | "GLACIER_IR" | "SNOW" | "EXPRESS_ONEZONE"),
?website_redirect_location: ::String,
?sse_customer_algorithm: ::String,
?sse_customer_key: ::String,
?sse_customer_key_md5: ::String,
?ssekms_key_id: ::String,
?ssekms_encryption_context: ::String,
?bucket_key_enabled: bool,
?request_payer: ("requester"),
?tagging: ::String,
?object_lock_mode: ("GOVERNANCE" | "COMPLIANCE"),
?object_lock_retain_until_date: ::Time,
?object_lock_legal_hold_status: ("ON" | "OFF"),
?expected_bucket_owner: ::String,
?checksum_algorithm: ("CRC32" | "CRC32C" | "SHA1" | "SHA256")
) -> MultipartUpload
| (?Hash[Symbol, untyped]) -> MultipartUpload
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#put-instance_method
def put: (
?acl: ("private" | "public-read" | "public-read-write" | "authenticated-read" | "aws-exec-read" | "bucket-owner-read" | "bucket-owner-full-control"),
?body: ::String | ::StringIO | ::File,
?cache_control: ::String,
?content_disposition: ::String,
?content_encoding: ::String,
?content_language: ::String,
?content_length: ::Integer,
?content_md5: ::String,
?content_type: ::String,
?checksum_algorithm: ("CRC32" | "CRC32C" | "SHA1" | "SHA256"),
?checksum_crc32: ::String,
?checksum_crc32c: ::String,
?checksum_sha1: ::String,
?checksum_sha256: ::String,
?expires: ::Time,
?if_none_match: ::String,
?grant_full_control: ::String,
?grant_read: ::String,
?grant_read_acp: ::String,
?grant_write_acp: ::String,
?metadata: Hash[::String, ::String],
?server_side_encryption: ("AES256" | "aws:kms" | "aws:kms:dsse"),
?storage_class: ("STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA" | "ONEZONE_IA" | "INTELLIGENT_TIERING" | "GLACIER" | "DEEP_ARCHIVE" | "OUTPOSTS" | "GLACIER_IR" | "SNOW" | "EXPRESS_ONEZONE"),
?website_redirect_location: ::String,
?sse_customer_algorithm: ::String,
?sse_customer_key: ::String,
?sse_customer_key_md5: ::String,
?ssekms_key_id: ::String,
?ssekms_encryption_context: ::String,
?bucket_key_enabled: bool,
?request_payer: ("requester"),
?tagging: ::String,
?object_lock_mode: ("GOVERNANCE" | "COMPLIANCE"),
?object_lock_retain_until_date: ::Time,
?object_lock_legal_hold_status: ("ON" | "OFF"),
?expected_bucket_owner: ::String
) -> Types::PutObjectOutput
| (?Hash[Symbol, untyped]) -> Types::PutObjectOutput
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#restore_object-instance_method
def restore_object: (
?version_id: ::String,
?restore_request: {
days: ::Integer?,
glacier_job_parameters: {
tier: ("Standard" | "Bulk" | "Expedited")
}?,
type: ("SELECT")?,
tier: ("Standard" | "Bulk" | "Expedited")?,
description: ::String?,
select_parameters: {
input_serialization: {
csv: {
file_header_info: ("USE" | "IGNORE" | "NONE")?,
comments: ::String?,
quote_escape_character: ::String?,
record_delimiter: ::String?,
field_delimiter: ::String?,
quote_character: ::String?,
allow_quoted_record_delimiter: bool?
}?,
compression_type: ("NONE" | "GZIP" | "BZIP2")?,
json: {
type: ("DOCUMENT" | "LINES")?
}?,
parquet: {
}?
},
expression_type: ("SQL"),
expression: ::String,
output_serialization: {
csv: {
quote_fields: ("ALWAYS" | "ASNEEDED")?,
quote_escape_character: ::String?,
record_delimiter: ::String?,
field_delimiter: ::String?,
quote_character: ::String?
}?,
json: {
record_delimiter: ::String?
}?
}
}?,
output_location: {
s3: {
bucket_name: ::String,
prefix: ::String,
encryption: {
encryption_type: ("AES256" | "aws:kms" | "aws:kms:dsse"),
kms_key_id: ::String?,
kms_context: ::String?
}?,
canned_acl: ("private" | "public-read" | "public-read-write" | "authenticated-read" | "aws-exec-read" | "bucket-owner-read" | "bucket-owner-full-control")?,
access_control_list: Array[
{
grantee: {
display_name: ::String?,
email_address: ::String?,
id: ::String?,
type: ("CanonicalUser" | "AmazonCustomerByEmail" | "Group"),
uri: ::String?
}?,
permission: ("FULL_CONTROL" | "WRITE" | "WRITE_ACP" | "READ" | "READ_ACP")?
},
]?,
tagging: {
tag_set: Array[
{
key: ::String,
value: ::String
},
]
}?,
user_metadata: Array[
{
name: ::String?,
value: ::String?
},
]?,
storage_class: ("STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA" | "ONEZONE_IA" | "INTELLIGENT_TIERING" | "GLACIER" | "DEEP_ARCHIVE" | "OUTPOSTS" | "GLACIER_IR" | "SNOW" | "EXPRESS_ONEZONE")?
}?
}?
},
?request_payer: ("requester"),
?checksum_algorithm: ("CRC32" | "CRC32C" | "SHA1" | "SHA256"),
?expected_bucket_owner: ::String
) -> Types::RestoreObjectOutput
| (?Hash[Symbol, untyped]) -> Types::RestoreObjectOutput
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#head-instance_method
def head: (
?if_match: ::String,
?if_modified_since: ::Time,
?if_none_match: ::String,
?if_unmodified_since: ::Time,
?range: ::String,
?response_cache_control: ::String,
?response_content_disposition: ::String,
?response_content_encoding: ::String,
?response_content_language: ::String,
?response_content_type: ::String,
?response_expires: ::Time,
?version_id: ::String,
?sse_customer_algorithm: ::String,
?sse_customer_key: ::String,
?sse_customer_key_md5: ::String,
?request_payer: ("requester"),
?part_number: ::Integer,
?expected_bucket_owner: ::String,
?checksum_mode: ("ENABLED")
) -> Types::HeadObjectOutput
| (?Hash[Symbol, untyped]) -> Types::HeadObjectOutput
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#acl-instance_method
def acl: () -> ObjectAcl
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#bucket-instance_method
def bucket: () -> Bucket
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#multipart_upload-instance_method
def multipart_upload: (String id) -> MultipartUpload
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#version-instance_method
def version: (String id) -> ObjectVersion
class Collection < ::Aws::Resources::Collection[Object]
def batch_delete!: (
?mfa: ::String,
?request_payer: ("requester"),
?bypass_governance_retention: bool,
?expected_bucket_owner: ::String,
?checksum_algorithm: ("CRC32" | "CRC32C" | "SHA1" | "SHA256")
) -> void
| (?Hash[Symbol, untyped]) -> void
end
end
end
end
|
