class Awscr::S3::Client
- Awscr::S3::Client
- Reference
- Object
Overview
An S3 client for interacting with S3.
Creating an S3 Client
client = Client.new("region", "key", "secret")
Client with custom endpoint
client = Client.new("region", "key", "secret", endpoint: "http://test.com")
Client with custom signer algorithm
client = Client.new("region", "key", "secret", signer: :v2)
Defined in:
awscr-s3/client.crConstructors
Instance Method Summary
-
#abort_multipart_upload(bucket : String, object : String, upload_id : String)
Aborts a multi part upload.
-
#batch_delete(bucket, keys : Array(String))
Batch deletes a list of object keys in a single request.
-
#complete_multipart_upload(bucket : String, object : String, upload_id : String, parts : Array(Response::UploadPartOutput))
Complete a multipart upload
-
#delete_bucket(bucket)
Delete a bucket, note: it must be empty
-
#delete_object(bucket, object, headers : Hash(String, String) = Hash(String, String).new)
Delete an object from a bucket, returns
true
if successful,false
otherwise. -
#get_object(bucket, object : String, headers : Hash(String, String) = Hash(String, String).new)
Get the contents of an object in a bucket
-
#get_object(bucket, object : String, headers : Hash(String, String) = Hash(String, String).new, &)
Get the contents of an object in a bucket as an IO object
-
#head_bucket(bucket)
Get information about a bucket, useful for determining if a bucket exists.
-
#head_object(bucket, object : String, headers : Hash(String, String) = Hash(String, String).new)
Get the metadata of an object in a bucket
-
#list_buckets
List s3 buckets
-
#list_objects(bucket, max_keys = nil, prefix = nil)
List all the items in a bucket
-
#put_bucket(bucket, region : String | Nil = nil, headers : Hash(String, String) = Hash(String, String).new)
Create a bucket, optionally place it in a region.
-
#put_object(bucket, object : String, body : IO | String | Bytes, headers : Hash(String, String) = Hash(String, String).new)
Add an object to a bucket.
-
#start_multipart_upload(bucket : String, object : String, headers : Hash(String, String) = Hash(String, String).new)
Start a multipart upload
-
#upload_part(bucket : String, object : String, upload_id : String, part_number : Int32, part : IO | String)
Upload a part, for use in multipart uploading
Constructor Detail
Instance Method Detail
Aborts a multi part upload. Returns true if the abort was a success, false otherwise.
client = Client.new("region", "key", "secret")
resp = client.abort_multipart_upload("bucket1", "obj", "123")
p resp # => true
Batch deletes a list of object keys in a single request.
client = Client.new("region", "key", "secret")
resp = client.batch_delete("bucket1", ["obj", "obj2"])
p resp.success? # => true
Complete a multipart upload
client = Client.new("region", "key", "secret")
resp = client.complete_multipart_upload("bucket1", "obj", "123", parts)
p resp.key # => obj
Delete a bucket, note: it must be empty
client = Client.new("region", "key", "secret")
resp = client.delete_bucket("test")
p resp # => true
Delete an object from a bucket, returns true
if successful, false
otherwise.
client = Client.new("region", "key", "secret")
resp = client.delete_object("bucket1", "obj")
p resp # => true
Get the contents of an object in a bucket
client = Client.new("region", "key", "secret")
resp = client.get_object("bucket1", "obj")
p resp.body # => "MY DATA"
Get the contents of an object in a bucket as an IO object
client = Client.new("region", "key", "secret")
client.get_object("bucket1", "obj") do |resp|
IO.copy(resp.body_io, STDOUT) # => "MY DATA"
end
Get information about a bucket, useful for determining if a bucket exists.
Raises a Http::ServerError
if the bucket does not exist.
client = Client.new("region", "key", "secret")
resp = client.head_bucket("bucket1")
p resp # => true
Get the metadata of an object in a bucket
client = Client.new("region", "key", "secret")
resp = client.head_object("bucket1", "obj")
p resp.size # => 123
p resp.status # => HTTP::Status::OK
p resp.last_modified # => "Wed, 19 Jun 2019 11:55:33 GMT"
List s3 buckets
client = Client.new("region", "key", "secret")
resp = client.list_buckets
p resp.buckets.map(&.name) # => ["bucket1", "bucket2"]
List all the items in a bucket
client = Client.new("region", "key", "secret")
resp = client.list_objects("bucket1", prefix: "test")
p resp.map(&.key) # => ["obj"]
Create a bucket, optionally place it in a region.
client = Client.new("region", "key", "secret")
resp = client.create_bucket("test")
p resp # => true
Add an object to a bucket.
client = Client.new("region", "key", "secret")
resp = client.put_object("bucket1", "obj", "MY DATA")
p resp.key # => "obj"
Start a multipart upload
client = Client.new("region", "key", "secret")
resp = client.start_multipart_upload("bucket1", "obj")
p resp.upload_id # => someid
Upload a part, for use in multipart uploading
client = Client.new("region", "key", "secret")
resp = client.upload_part("bucket1", "obj", "someid", 123, "MY DATA")
p resp.upload_id # => someid