Class: AWS::S3::Client

Inherits:
Core::Client show all
Extended by:
Validators
Includes:
Core::UriEscape, Validators
Defined in:
lib/aws/s3/client.rb,
lib/aws/s3/client/xml.rb

Overview

Client class for Amazon Simple Storage Service (S3).

Defined Under Namespace

Modules: Validators

Constant Summary collapse

API_VERSION = 
'2006-03-01'
XMLNS = 
"http://s3.amazonaws.com/doc/#{API_VERSION}/"

Instance Attribute Summary

Attributes inherited from Core::Client

#config, #http_read_timeout

Instance Method Summary collapse

Methods included from Validators

dns_compatible_bucket_name?, json_validation_message, path_style_bucket_name?, require_acl!, require_bucket_name!, require_policy!, require_upload_id!, valid_bucket_name?, validate!, validate_bucket_name!, validate_key!, validate_parts!

Methods included from Core::UriEscape

#escape, #escape_path

Methods inherited from Core::Client

#initialize, #operations, #with_http_handler, #with_options

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#abort_multipart_upload(options = {}) ⇒ Core::Response

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :key (required, String)
  • :upload_id (required, String)

Returns:



1012
1013
1014
1015
1016
1017
1018
 
# File 'lib/aws/s3/client.rb', line 1012

object_method(:abort_multipart_upload, :delete) do
  configure_request do |req, options|
      require_upload_id!(options[:upload_id])
    super(req, options)
    req.add_param('uploadId', options[:upload_id])
  end
end

#complete_multipart_upload(options = {}) ⇒ Core::Response

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :key (required, String)
  • :upload_id (required, String)
  • :parts (required, Array<String>)

Returns:



978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/aws/s3/client.rb', line 978

object_method(:complete_multipart_upload, :post,
              XML::CompleteMultipartUpload) do
  configure_request do |req, options|
    require_upload_id!(options[:upload_id])
    validate_parts!(options[:parts])
    super(req, options)
    req.add_param('uploadId', options[:upload_id])
    parts_xml = options[:parts].map do |part|
      "<Part>"+
        "<PartNumber>#{part[:part_number].to_i}</PartNumber>"+
        "<ETag>#{REXML::Text.normalize(part[:etag].to_s)}</ETag>"+
        "</Part>"
    end.join
    req.body =
      "<CompleteMultipartUpload>#{parts_xml}</CompleteMultipartUpload>"
  end

  process_response do |response|
    add_sse_to_response(response)
    response.data[:version_id] =
      response.http_response.header('x-amz-version-id')
  end

  simulate_response do |response|
    response.data[:version_id] = nil
  end
end

#copy_object(options = {}) ⇒ Core::Response

Copies an object from one key to another.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String) —

    Name of the bucket to copy a object into.

  • :key (required, String) —

    Where (object key) in the bucket the object should be copied to.

  • :copy_source (required, String) —

    The source bucket name and key, joined by a forward slash (‘/’). This string must be URL-encoded. Additionally, you must have read access to the source object.

  • :acl (String) —

    A canned ACL (e.g. ‘private’, ‘public-read’, etc). See the S3 API documentation for a complete list of valid values.

  • :grant_read (String)
  • :grant_write (String)
  • :grant_read_acp (String)
  • :grant_write_acp (String)
  • :grant_full_control (String)

Returns:



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'lib/aws/s3/client.rb', line 1060

object_method(:copy_object, :put, :header_options => {
  :acl => 'x-amz-acl',
  :grant_read => 'x-amz-grant-read',
  :grant_write => 'x-amz-grant-write',
  :grant_read_acp => 'x-amz-grant-read-acp',
  :grant_write_acp => 'x-amz-grant-write-acp',
  :grant_full_control => 'x-amz-grant-full-control',
  :copy_source => 'x-amz-copy-source',
  :cache_control => 'Cache-Control',
  :metadata_directive => 'x-amz-metadata-directive',
  :storage_class => 'x-amz-storage-class',
  :server_side_encryption => 'x-amz-server-side-encryption',
  :content_type => 'Content-Type',
}) do

  configure_request do |req, options|
    # TODO : validate metadata directive COPY / REPLACE
    # TODO : validate storage class STANDARD / REDUCED_REDUNDANCY
    # TODO : add validations for storage class in other places used
    validate!(:copy_source, options[:copy_source]) do
      "may not be blank" if options[:copy_source].to_s.empty?
    end
    options = options.merge(:copy_source => escape_path(options[:copy_source]))
    options[:server_side_encryption] =
      options[:server_side_encryption].to_s.upcase if
      options[:server_side_encryption].kind_of?(Symbol)
    super(req, options)
    req.metadata = options[:metadata]
    req.storage_class = options[:storage_class]
    if options[:version_id]
      req.headers['x-amz-copy-source'] += "?versionId=#{options[:version_id]}"
    end
  end

  process_response do |response|
    response.data[:version_id] =
      response.http_response.header('x-amz-version-id')
    response.data[:etag] = response.http_response.header('ETag')
    if time = response.http_response.header('Last-Modified')
      response.data[:last_modified] = Time.parse(time)
    end
    add_sse_to_response(response)
  end

end

#create_bucket(options = {}) ⇒ Core::Response Also known as: put_bucket

Creates a bucket.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :acl (String) —

    A canned ACL (e.g. ‘private’, ‘public-read’, etc). See the S3 API documentation for a complete list of valid values.

  • :grant_read (String)
  • :grant_write (String)
  • :grant_read_acp (String)
  • :grant_write_acp (String)
  • :grant_full_control (String)

Returns:



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/aws/s3/client.rb', line 128

bucket_method(:create_bucket, :put, :header_options => {
  :acl => 'x-amz-acl',
  :grant_read => 'x-amz-grant-read',
  :grant_write => 'x-amz-grant-write',
  :grant_read_acp => 'x-amz-grant-read-acp',
  :grant_write_acp => 'x-amz-grant-write-acp',
  :grant_full_control => 'x-amz-grant-full-control',
}) do

  configure_request do |req, options|
    validate_bucket_name!(options[:bucket_name])
    if location = options[:location_constraint]
      xmlns = "http://s3.amazonaws.com/doc/#{API_VERSION}/"
      req.body = <<-XML
        <CreateBucketConfiguration xmlns="#{xmlns}">
          <LocationConstraint>#{location}</LocationConstraint>
        </CreateBucketConfiguration>
      XML
    end
    super(req, options)
  end

end

#delete_bucket(options = {}) ⇒ Core::Response

Deletes an empty bucket.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)

Returns:



158
 
# File 'lib/aws/s3/client.rb', line 158

bucket_method(:delete_bucket, :delete)

#delete_bucket_lifecycle_configuration(options = {}) ⇒ Core::Response

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)

Returns:



200
201
202
203
204
205
206
207
 
# File 'lib/aws/s3/client.rb', line 200

bucket_method(:delete_bucket_lifecycle_configuration, :delete) do

  configure_request do |req, options|
    req.add_param('lifecycle')
    super(req, options)
  end

end

#delete_bucket_policy(options = {}) ⇒ Core::Response

Deletes the access policy for a bucket.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)

Returns:



265
 
# File 'lib/aws/s3/client.rb', line 265

bucket_method(:delete_bucket_policy, :delete, 'policy')

#delete_object(options = {}) ⇒ Core::Response

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :key (required, String)
  • :version_id (String)

Returns:



782
783
784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'lib/aws/s3/client.rb', line 782

object_method(:delete_object, :delete) do

  configure_request do |req, options|
    super(req, options)
    if options[:version_id]
      req.add_param('versionId', options[:version_id])
    end
  end

  process_response do |resp|
    resp.data[:version_id] = resp.http_response.header('x-amz-version-id')
  end

end

#delete_objects(options = {}) ⇒ Core::Response

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :keys (required, Array<String>)
  • :quiet (Boolean) — default: true

Returns:



904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'lib/aws/s3/client.rb', line 904

bucket_method(:delete_objects, :post, 'delete', XML::DeleteObjects) do
  configure_request do |req, options|

    super(req, options)

    quiet = options.key?(:quiet) ? options[:quiet] : true

    # previously named this option :objects, since renamed
    keys = options[:objects] || options[:keys]

    objects = keys.inject('') do |xml,o|
      xml << "<Object><Key>#{o[:key]}</Key>"
      xml << "<VersionId>#{o[:version_id]}</VersionId>" if o[:version_id]
      xml << "</Object>"
    end

    xml = '<?xml version="1.0" encoding="UTF-8"?>'
    xml << "<Delete><Quiet>#{quiet}</Quiet>#{objects}</Delete>"

    req.body = xml

    md5 = Base64.encode64(Digest::MD5.digest(xml)).strip

    req.headers['content-md5'] = md5

  end
end

#get_bucket_acl(options = {}) ⇒ Core::Response

Gets the access control list for a bucket.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)

Returns:



422
 
# File 'lib/aws/s3/client.rb', line 422

bucket_method(:get_bucket_acl, :get, 'acl', XML::GetBucketAcl)

#get_bucket_lifecycle_configuration(options = {}) ⇒ Core::Response

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)

Returns:



182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/aws/s3/client.rb', line 182

bucket_method(:get_bucket_lifecycle_configuration, :get) do

  configure_request do |req, options|
    req.add_param('lifecycle')
    super(req, options)
  end

  process_response do |resp|
    xml = resp.http_response.body
    resp.data = XML::GetBucketLifecycleConfiguration.parse(xml)
  end

end

#get_bucket_location(options = {}) ⇒ Core::Response

Gets the bucket’s location constraint.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)

Returns:



294
295
296
297
298
299
300
301
302
 
# File 'lib/aws/s3/client.rb', line 294

bucket_method(:get_bucket_location, :get, 'location') do

  process_response do |response|
    regex = />(.*)<\/LocationConstraint>/
    matches = response.http_response.body.match(regex)
    response.data[:location_constraint] = matches ? matches[1] : nil
  end

end

#get_bucket_policy(options = {}) ⇒ Core::Response

Gets the access policy for a bucket.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)

Returns:



252
253
254
255
256
257
258
 
# File 'lib/aws/s3/client.rb', line 252

bucket_method(:get_bucket_policy, :get, 'policy') do

  process_response do |resp|
    resp.data[:policy] = resp.http_response.body
  end

end

#get_bucket_versioning(options = {}) ⇒ Core::Response

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)

Returns:



308
309
 
# File 'lib/aws/s3/client.rb', line 308

bucket_method(:get_bucket_versioning, :get, 'versioning',
XML::GetBucketVersioning)

#get_object(options = {}) ⇒ Core::Response

Gets the data for a key.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :key (required, String)
  • :if_modified_since (Time) —

    If specified, the response will contain an additional :modified value that returns true if the object was modified after the given time. If :modified is false, then the response :data value will be nil.

  • :if_unmodified_since (Time) —

    If specified, the response will contain an additional :unmodified value that is true if the object was not modified after the given time. If :unmodified returns false, the :data value will be nil.

  • :if_match (String) —

    If specified, the response will contain an additional :matches value that is true if the object ETag matches the value for this option. If :matches is false, the :data value of the response will be nil.

  • :if_none_match (String) —

    If specified, the response will contain an additional :matches value that is true if and only if the object ETag matches the value for this option. If :matches is true, the :data value of the response will be nil.

  • :range (Range<Integer>) —

    A byte range of data to request.

Returns:



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
 
# File 'lib/aws/s3/client.rb', line 677

object_method(:get_object, :get,
              :header_options => {
                :if_modified_since => "If-Modified-Since",
                :if_unmodified_since => "If-Unmodified-Since",
                :if_match => "If-Match",
                :if_none_match => "If-None-Match"
              }) do
  configure_request do |req, options|

    super(req, options)

    if options[:version_id]
      req.add_param('versionId', options[:version_id])
    end

    ["If-Modified-Since",
     "If-Unmodified-Since"].each do |date_header|
      case value = req.headers[date_header]
      when DateTime
        req.headers[date_header] = Time.parse(value.to_s).rfc2822
      when Time
        req.headers[date_header] = value.rfc2822
      end
    end

    if options[:range]
      range = options[:range]
      range = "bytes=#{range.first}-#{range.last}" if range.is_a?(Range)
      req.headers['Range'] = range
    end

  end

  process_response do |resp|
    resp.data[:data] = resp.http_response.body
    resp.data[:version_id] = resp.http_response.header('x-amz-version-id')
    add_sse_to_response(resp)
  end
end

#get_object_acl(options = {}) ⇒ Core::Response

Gets the access control list for an object.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :key (required, String)

Returns:



516
 
# File 'lib/aws/s3/client.rb', line 516

object_method(:get_object_acl, :get, 'acl', XML::GetBucketAcl)

#head_object(options = {}) ⇒ Core::Response

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :key (required, String)
  • :version_id (String)

Returns:



723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
 
# File 'lib/aws/s3/client.rb', line 723

object_method(:head_object, :head) do

  configure_request do |req, options|
    super(req, options)
    if options[:version_id]
      req.add_param('versionId', options[:version_id])
    end
  end

  process_response do |resp|

    # create a hash of user-supplied metadata
    meta = {}
    resp.http_response.headers.each_pair do |name,value|
      if name =~ /^x-amz-meta-(.+)$/i
        meta[$1] = [value].flatten.join
      end
    end
    meta
    resp.data[:meta] = meta

    if expiry = resp.http_response.headers['x-amz-expiration']
      expiry.first =~ /^expiry-date="(.+)", rule-id="(.+)"$/
      exp_date = DateTime.parse($1)
      exp_rule_id = $2
    else
      exp_date = nil
      exp_rule_id = nil
    end

    resp.data[:expiration_date] = exp_date
    resp.data[:expiration_rule_id] = exp_rule_id

    {
      'x-amz-version-id' => :version_id,
      'content-type' => :content_type,
      'etag' => :etag,
    }.each_pair do |header,method|
      resp.data[method] = resp.http_response.header(header)
    end

    if time = resp.http_response.header('Last-Modified')
      resp.data[:last_modified] = Time.parse(time)
    end

    resp.data[:content_length] =
      resp.http_response.header('content-length').to_i

    add_sse_to_response(resp)

  end
end

#initiate_multipart_upload(options = {}) ⇒ Core::Response

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :key (required, String)
  • :metadata (Hash)
  • :acl (Symbol)
  • :cache_control (String)
  • :content_disposition (String)
  • :content_encoding (String)
  • :content_type (String)
  • :storage_class (String)
  • :server_side_encryption (String)
  • :expires (String)
  • :acl (String) —

    A canned ACL (e.g. ‘private’, ‘public-read’, etc). See the S3 API documentation for a complete list of valid values.

  • :grant_read (String)
  • :grant_write (String)
  • :grant_read_acp (String)
  • :grant_write_acp (String)
  • :grant_full_control (String)

Returns:



841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'lib/aws/s3/client.rb', line 841

object_method(:initiate_multipart_upload, :post, 'uploads',
              XML::InitiateMultipartUpload,
              :header_options => {
                :acl => 'x-amz-acl',
                :grant_read => 'x-amz-grant-read',
                :grant_write => 'x-amz-grant-write',
                :grant_read_acp => 'x-amz-grant-read-acp',
                :grant_write_acp => 'x-amz-grant-write-acp',
                :grant_full_control => 'x-amz-grant-full-control',
                :cache_control => 'Cache-Control',
                :content_disposition => 'Content-Disposition',
                :content_encoding => 'Content-Encoding',
                :content_type => 'Content-Type',
                :storage_class => 'x-amz-storage-class',
                :server_side_encryption => 'x-amz-server-side-encryption',
                :expires => 'Expires'
              }) do

  configure_request do |req, options|
    options[:server_side_encryption] =
      options[:server_side_encryption].to_s.upcase if
      options[:server_side_encryption].kind_of?(Symbol)
    super(req, options)
    req.metadata = options[:metadata]
    req.storage_class = options[:storage_class]
  end

  process_response do |response|
    add_sse_to_response(response)
  end
end

#list_buckets(options = {}) ⇒ Core::Response

Parameters:

  • options (Hash) (defaults to: {})

Returns:



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/aws/s3/client.rb', line 212

add_client_request_method(:list_buckets) do

  configure_request do |req, options|
    req.http_method = "GET"
  end

  process_response do |resp|
    resp.data = XML::ListBuckets.parse(resp.http_response.body)
  end

  simulate_response do |resp|
    resp.data = Core::XML::Parser.new(XML::ListBuckets.rules).simulate
  end

end

#list_multipart_uploads(options = {}) ⇒ Core::Response

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :delimiter (String)
  • :key_marker (String)
  • :max_keys (String)
  • :upload_id_marker (String)
  • :max_uploads (String)
  • :prefix (String)

Returns:



883
884
885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/aws/s3/client.rb', line 883

bucket_method(:list_multipart_uploads,
              :get, 'uploads',
              XML::ListMultipartUploads) do
  configure_request do |req, options|
    super(req, options)
    params = %w(delimiter key_marker max_keys) +
      %w(upload_id_marker max_uploads prefix)
    params.each do |param|
      if options[param.to_sym]
        req.add_param(param.gsub(/_/, '-'), options[param.to_sym])
      end
    end
  end
end

#list_object_versions(options = {}) ⇒ Core::Response

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :prefix (String)
  • :delimiter (String)
  • :max_keys (String)
  • :key_marker (String)
  • :version_id_marker (String)

Returns:



320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/aws/s3/client.rb', line 320

bucket_method(:list_object_versions, :get, 'versions',
  XML::ListObjectVersions) do

  configure_request do |req, options|
    super(req, options)
    params = %w(delimiter key_marker max_keys prefix version_id_marker)
    params.each do |param|
      if options[param.to_sym]
        req.add_param(param.gsub(/_/, '-'), options[param.to_sym])
      end
    end
  end

end

#list_objects(options = {}) ⇒ Core::Response Also known as: get_bucket

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :delimiter (String)
  • :marker (String)
  • :max_keys (String)
  • :prefix (String)

Returns:



805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/aws/s3/client.rb', line 805

bucket_method(:list_objects, :get, XML::ListObjects) do
  configure_request do |req, options|
    super(req, options)
    params = %w(delimiter marker max_keys prefix)
    params.each do |param|
      if options[param.to_sym]
        req.add_param(param.gsub(/_/, '-'), options[param.to_sym])
      end
    end
  end
end

#list_parts(options = {}) ⇒ Core::Response

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :key (required, String)
  • :upload_id (required, String)
  • :max_parts (Integer)
  • :part_number_marker (Integer)

Returns:



1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/aws/s3/client.rb', line 1028

object_method(:list_parts, :get, XML::ListParts) do

  configure_request do |req, options|
      require_upload_id!(options[:upload_id])
    super(req, options)
    req.add_param('uploadId', options[:upload_id])
    req.add_param('max-parts', options[:max_parts])
    req.add_param('part-number-marker', options[:part_number_marker])
  end

end

#put_bucket_acl(options = {}) ⇒ Core::Response Also known as: set_bucket_acl

Sets the access control list for a bucket. You must specify an ACL via one of the following methods:

  • as a canned ACL (via :acl)

  • as a list of grants (via the :grant_* options)

  • as an access control policy document (via :access_control_policy)

Examples:

Using a canned acl

s3_client.put_bucket_acl(
  :bucket_name => 'bucket-name',
  :acl => 'public-read')

Using grants

s3_client.put_bucket_acl(
  :bucket_name => 'bucket-name',
  :grant_read => 'uri="http://acs.amazonaws.com/groups/global/AllUsers"',
  :grant_full_control => 'emailAddress="[email protected]", id="8a9...fa7"')

Using an access control policy document

policy_xml = <<-XML
  <AccessControlPolicy xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Owner>
      <ID>852b113e7a2f25102679df27bb0ae12b3f85be6BucketOwnerCanonicalUserID</ID>
      <DisplayName>OwnerDisplayName</DisplayName>
    </Owner>
    <AccessControlList>
      <Grant>
        <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser">
          <ID>BucketOwnerCanonicalUserID</ID>
          <DisplayName>OwnerDisplayName</DisplayName>
        </Grantee>
        <Permission>FULL_CONTROL</Permission>
      </Grant>
      <Grant>
        <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group">
          <URI xmlns="">http://acs.amazonaws.com/groups/global/AllUsers</URI>
        </Grantee>
        <Permission xmlns="">READ</Permission>
      </Grant>
    </AccessControlList>
  </AccessControlPolicy>

XML
s3_client.put_bucket_acl(
  :bucket_name => 'bucket-name',
  :access_control_policy => policy_xml)

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :access_control_policy (String) —

    An access control policy description as a string of XML. See the S3 API documentation for a description.

  • :acl (String) —

    A canned ACL (e.g. ‘private’, ‘public-read’, etc). See the S3 API documentation for a complete list of valid values.

  • :grant_read (String)
  • :grant_write (String)
  • :grant_read_acp (String)
  • :grant_write_acp (String)
  • :grant_full_control (String)

Returns:



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aws/s3/client.rb', line 397

bucket_method(:put_bucket_acl, :put, 'acl', :header_options => {
  :acl => 'x-amz-acl',
  :grant_read => 'x-amz-grant-read',
  :grant_write => 'x-amz-grant-write',
  :grant_read_acp => 'x-amz-grant-read-acp',
  :grant_write_acp => 'x-amz-grant-write-acp',
  :grant_full_control => 'x-amz-grant-full-control',
}) do

  configure_request do |req, options|
    move_access_control_policy(options)
    require_acl!(options)
    super(req, options)
    req.body = options[:access_control_policy] if
       options[:access_control_policy]
  end

end

#put_object(options = {}) ⇒ Core::Response

Puts data into an object, replacing the current contents.

s3_client.put_object({
  :bucket_name => 'bucket-name',
  :key => 'readme.txt',
  :data => 'This is the readme for ...',
})

Block Form

In block form, this method yields a stream to the block that accepts data chunks. For example:

s3_client.put_object(
  :bucket_name => 'mybucket',
  :key => 'some/key'
  :content_length => File.size('myfile')
) do |buffer|

  File.open('myfile') do |io|
    buffer.write(io.read(length)) until io.eof?
  end

end

This form is useful if you need finer control over how potentially large amounts of data are read from another source before being sent to S3; for example, if you are using a non-blocking IO model and reading from a large file on disk or from another network stream. Some HTTP handlers do not support streaming request bodies, so if you plan to upload large objects using this interface you should make sure the HTTP handler you configure for the client meets your needs.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :key (required, String)
  • :data (required, String, Pathname, File, IO) —

    The data to upload. This can be provided as a string, a Pathname object, or any object that responds to #read and #eof? (e.g. IO, File, Tempfile, StringIO, etc).

  • :content_length (Integer) —

    Required if you are using block form to write data or if it is not possible to determine the size of :data. A best effort is made to determine the content length of strings, files, tempfiles, io objects, and any object that responds to #length or #size.

  • :metadata (Hash) —

    A hash of metadata to be included with the object. These will be sent to S3 as headers prefixed with x-amz-meta.

  • :acl (Symbol) — default: :private —

    A canned access control policy. Accepted values include:

    • :private

    • :public_read

    • …

  • :storage_class+ (Symbol) — default: :standard —

    Controls whether Reduced Redundancy Storage is enabled for the object. Valid values are :standard and :reduced_redundancy.

  • :cache_control (String) —

    Can be used to specify caching behavior.

  • :content_disposition (String) —

    Specifies presentational information.

  • :content_encoding (String) —

    Specifies the content encoding.

  • :content_md5 (String) —

    The base64 encoded content md5 of the :data.

  • :content_type (String) —

    Specifies the content type.

  • :expires (String)
  • :acl (String) —

    A canned ACL (e.g. ‘private’, ‘public-read’, etc). See the S3 API documentation for a complete list of valid values.

  • :grant_read (String)
  • :grant_write (String)
  • :grant_read_acp (String)
  • :grant_write_acp (String)
  • :grant_full_control (String)

Returns:



601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/aws/s3/client.rb', line 601

object_method(:put_object, :put, :header_options => {
  :acl => 'x-amz-acl',
  :grant_read => 'x-amz-grant-read',
  :grant_write => 'x-amz-grant-write',
  :grant_read_acp => 'x-amz-grant-read-acp',
  :grant_write_acp => 'x-amz-grant-write-acp',
  :grant_full_control => 'x-amz-grant-full-control',
  :content_md5 => 'Content-MD5',
  :cache_control => 'Cache-Control',
  :content_disposition => 'Content-Disposition',
  :content_encoding => 'Content-Encoding',
  :content_type => 'Content-Type',
  :storage_class => 'x-amz-storage-class',
  :server_side_encryption => 'x-amz-server-side-encryption',
  :expires => 'Expires'
}) do

  configure_request do |request, options, block|
    options[:server_side_encryption] =
      options[:server_side_encryption].to_s.upcase if
      options[:server_side_encryption].kind_of?(Symbol)
    super(request, options)
    set_request_data(request, options, block)
    request.metadata = options[:metadata]
    request.storage_class = options[:storage_class]
  end

  process_response do |response|

    response.data[:version_id] =
      response.http_response.header('x-amz-version-id')

    response.data[:etag] = response.http_response.header('ETag')

    if time = response.http_response.header('Last-Modified')
      response.data[:last_modified] = Time.parse(time)
    end

    add_sse_to_response(response)
  end

  simulate_response do |response|
    response.data[:etag] = 'abc123'
    response.data[:version_id] = nil
  end

end

#put_object_acl(options = {}) ⇒ Core::Response Also known as: set_object_acl

Sets the access control list for an object. You must specify an ACL via one of the following methods:

  • as a canned ACL (via :acl)

  • as a list of grants (via the :grant_* options)

  • as an access control policy document (via :access_control_policy)

Examples:

Using a canned acl

s3_client.put_object_acl(
  :bucket_name => 'bucket-name',
  :key => 'object-key',
  :acl => 'public-read')

Using grants

s3_client.put_bucket_acl(
  :bucket_name => 'bucket-name',
  :key => 'object-key',
  :grant_read => 'uri="http://acs.amazonaws.com/groups/global/AllUsers"',
  :grant_full_control => 'emailAddress="[email protected]", id="8a9...fa7"')

Using an access control policy document

policy_xml = <<-XML
  <AccessControlPolicy xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Owner>
      <ID>852b113e7a2f25102679df27bb0ae12b3f85be6BucketOwnerCanonicalUserID</ID>
      <DisplayName>OwnerDisplayName</DisplayName>
    </Owner>
    <AccessControlList>
      <Grant>
        <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser">
          <ID>BucketOwnerCanonicalUserID</ID>
          <DisplayName>OwnerDisplayName</DisplayName>
        </Grantee>
        <Permission>FULL_CONTROL</Permission>
      </Grant>
      <Grant>
        <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group">
          <URI xmlns="">http://acs.amazonaws.com/groups/global/AllUsers</URI>
        </Grantee>
        <Permission xmlns="">READ</Permission>
      </Grant>
    </AccessControlList>
  </AccessControlPolicy>

XML
s3_client.put_bucket_acl(
  :bucket_name => 'bucket-name',
  :key => 'object-key',
  :access_control_policy => policy_xml)

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :key (required, String)
  • :access_control_policy (String) —

    An access control policy description as a string of XML. See the S3 API documentation for a description.

  • :acl (String) —

    A canned ACL (e.g. ‘private’, ‘public-read’, etc). See the S3 API documentation for a complete list of valid values.

  • :grant_read (String)
  • :grant_write (String)
  • :grant_read_acp (String)
  • :grant_write_acp (String)
  • :grant_full_control (String)

Returns:



490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/aws/s3/client.rb', line 490

object_method(:put_object_acl, :put, 'acl', :header_options => {
  :acl => 'x-amz-acl',
  :grant_read => 'x-amz-grant-read',
  :grant_write => 'x-amz-grant-write',
  :grant_read_acp => 'x-amz-grant-read-acp',
  :grant_write_acp => 'x-amz-grant-write-acp',
  :grant_full_control => 'x-amz-grant-full-control',
}) do

  configure_request do |req, options|
    move_access_control_policy(options)
    require_acl!(options)
    super(req, options)
    req.body = options[:access_control_policy] if
       options[:access_control_policy]
  end

end

#set_bucket_lifecycle_configuration(options = {}) ⇒ Core::Response

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :lifecycle_configuration (required, String)

Returns:



165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/aws/s3/client.rb', line 165

bucket_method(:set_bucket_lifecycle_configuration, :put) do

  configure_request do |req, options|
    xml = options[:lifecycle_configuration]
    md5 = Base64.encode64(Digest::MD5.digest(xml)).strip
    req.add_param('lifecycle')
    req.body = xml
    req.headers['content-md5'] = md5
    super(req, options)
  end

end

#set_bucket_policy(options = {}) ⇒ Core::Response

Sets the access policy for a bucket.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :policy (required, String) —

    This can be a String or any object that responds to #to_json.

Returns:



235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/aws/s3/client.rb', line 235

bucket_method(:set_bucket_policy, :put, 'policy') do

  configure_request do |req, options|
    require_policy!(options[:policy])
    super(req, options)
    policy = options[:policy]
    policy = policy.to_json unless policy.respond_to?(:to_str)
    req.body = policy
  end

end

#set_bucket_versioning(options = {}) ⇒ Core::Response

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :state (required, String)

Returns:



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/aws/s3/client.rb', line 272

bucket_method(:set_bucket_versioning, :put, 'versioning') do

  configure_request do |req, options|
    state = options[:state].to_s.downcase.capitalize
    unless state =~ /^(Enabled|Suspended)$/
      raise ArgumentError, "invalid versioning state `#{state}`"
    end
    super(req, options)
    req.body = <<-XML.strip
      <VersioningConfiguration xmlns="#{XMLNS}">
        <Status>#{state}</Status>
      </VersioningConfiguration>
    XML
  end

end

#upload_part(options = {}) ⇒ Core::Response

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :bucket_name (required, String)
  • :key (required, String)
  • :data (required, String, Pathname, File, IO) —

    The data to upload. This can be provided as a string, a Pathname object, or any object that responds to #read and #eof? (e.g. IO, File, Tempfile, StringIO, etc).

  • :upload_id (required, String)
  • :part_number (required, Integer)

Returns:



943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'lib/aws/s3/client.rb', line 943

object_method(:upload_part, :put,
              :header_options => {
                :content_md5 => 'Content-MD5'
              }) do
  configure_request do |request, options, block|
      require_upload_id!(options[:upload_id])
    validate!("part_number", options[:part_number]) do
      "must not be blank" if options[:part_number].to_s.empty?
    end
    super(request, options)
    set_request_data(request, options, block)
    request.add_param('uploadId', options[:upload_id])
    request.add_param('partNumber', options[:part_number])
  end

  process_response do |response|
    response.data[:etag] = response.http_response.header('ETag')
    if time = response.http_response.header('Last-Modified')
      response.data[:last_modified] = Time.parse(time)
    end
    add_sse_to_response(response)
  end

  simulate_response do |response|
    response.data[:etag] = 'abc123'
  end
end