aws-sdk-s3 1.0.0.rc1

data/lib/aws-sdk-s3/object_summary.rb

@@ -0,0 +1,794 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module S3
+    class ObjectSummary
+
+      extend Aws::Deprecations
+
+      # @overload def initialize(bucket_name, key, options = {})
+      #   @param [String] bucket_name
+      #   @param [String] key
+      #   @option options [Client] :client
+      # @overload def initialize(options = {})
+      #   @option options [required, String] :bucket_name
+      #   @option options [required, String] :key
+      #   @option options [Client] :client
+      def initialize(*args)
+        options = Hash === args.last ? args.pop.dup : {}
+        @bucket_name = extract_bucket_name(args, options)
+        @key = extract_key(args, options)
+        @data = options.delete(:data)
+        @client = options.delete(:client) || Client.new(options)
+      end
+
+      # @!group Read-Only Attributes
+
+      # @return [String]
+      def bucket_name
+        @bucket_name
+      end
+
+      # @return [String]
+      def key
+        @key
+      end
+
+      # @return [Time]
+      def last_modified
+        data.last_modified
+      end
+
+      # @return [String]
+      def etag
+        data.etag
+      end
+
+      # @return [Integer]
+      def size
+        data.size
+      end
+
+      # The class of storage used to store the object.
+      # @return [String]
+      def storage_class
+        data.storage_class
+      end
+
+      # @return [Types::Owner]
+      def owner
+        data.owner
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # @raise [Errors::ResourceNotLoadable]
+      # @api private
+      def load
+        msg = "#load is not implemented, data only available via enumeration"
+        raise Errors::ResourceNotLoadable, msg
+      end
+      alias :reload :load
+
+      # @raise [Errors::ResourceNotLoadableError] Raises when {#data_loaded?} is `false`.
+      # @return [Types::Object]
+      #   Returns the data for this {ObjectSummary}.
+      def data
+        load unless @data
+        @data
+      end
+
+      # @return [Boolean]
+      #   Returns `true` if this resource is loaded.  Accessing attributes or
+      #   {#data} on an unloaded resource will trigger a call to {#load}.
+      def data_loaded?
+        !!@data
+      end
+
+      # @param [Hash] options ({})
+      # @return [Boolean]
+      #   Returns `true` if the ObjectSummary exists.
+      def exists?(options = {})
+        begin
+          wait_until_exists(options.merge(max_attempts: 1))
+          true
+        rescue Aws::Waiters::Errors::UnexpectedError => e
+          raise e.error
+        rescue Aws::Waiters::Errors::WaiterFailed
+          false
+        end
+      end
+
+      # @param [Hash] options ({})
+      # @option options [Integer] :max_attempts (20)
+      # @option options [Float] :delay (5)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      # @return [ObjectSummary]
+      def wait_until_exists(options = {})
+        options, params = separate_params_and_options(options)
+        waiter = Waiters::ObjectExists.new(options)
+        yield_waiter_and_warn(waiter, &Proc.new) if block_given?
+        waiter.wait(params.merge(bucket: @bucket_name,
+          key: @key))
+        ObjectSummary.new({
+          bucket_name: @bucket_name,
+          key: @key,
+          client: @client
+        })
+      end
+
+      # @param [Hash] options ({})
+      # @option options [Integer] :max_attempts (20)
+      # @option options [Float] :delay (5)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      # @return [ObjectSummary]
+      def wait_until_not_exists(options = {})
+        options, params = separate_params_and_options(options)
+        waiter = Waiters::ObjectNotExists.new(options)
+        yield_waiter_and_warn(waiter, &Proc.new) if block_given?
+        waiter.wait(params.merge(bucket: @bucket_name,
+          key: @key))
+        ObjectSummary.new({
+          bucket_name: @bucket_name,
+          key: @key,
+          client: @client
+        })
+      end
+
+      # @!group Actions
+
+      # @example Request syntax with placeholder values
+      #
+      #   object_summary.copy_from({
+      #     acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
+      #     cache_control: "CacheControl",
+      #     content_disposition: "ContentDisposition",
+      #     content_encoding: "ContentEncoding",
+      #     content_language: "ContentLanguage",
+      #     content_type: "ContentType",
+      #     copy_source: "CopySource", # required
+      #     copy_source_if_match: "CopySourceIfMatch",
+      #     copy_source_if_modified_since: Time.now,
+      #     copy_source_if_none_match: "CopySourceIfNoneMatch",
+      #     copy_source_if_unmodified_since: Time.now,
+      #     expires: Time.now,
+      #     grant_full_control: "GrantFullControl",
+      #     grant_read: "GrantRead",
+      #     grant_read_acp: "GrantReadACP",
+      #     grant_write_acp: "GrantWriteACP",
+      #     metadata: {
+      #       "MetadataKey" => "MetadataValue",
+      #     },
+      #     metadata_directive: "COPY", # accepts COPY, REPLACE
+      #     server_side_encryption: "AES256", # accepts AES256, aws:kms
+      #     storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA
+      #     website_redirect_location: "WebsiteRedirectLocation",
+      #     sse_customer_algorithm: "SSECustomerAlgorithm",
+      #     sse_customer_key: "SSECustomerKey",
+      #     sse_customer_key_md5: "SSECustomerKeyMD5",
+      #     ssekms_key_id: "SSEKMSKeyId",
+      #     copy_source_sse_customer_algorithm: "CopySourceSSECustomerAlgorithm",
+      #     copy_source_sse_customer_key: "CopySourceSSECustomerKey",
+      #     copy_source_sse_customer_key_md5: "CopySourceSSECustomerKeyMD5",
+      #     request_payer: "requester", # accepts requester
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :acl
+      #   The canned ACL to apply to the object.
+      # @option options [String] :cache_control
+      #   Specifies caching behavior along the request/reply chain.
+      # @option options [String] :content_disposition
+      #   Specifies presentational information for the object.
+      # @option options [String] :content_encoding
+      #   Specifies what content encodings have been applied to the object and
+      #   thus what decoding mechanisms must be applied to obtain the media-type
+      #   referenced by the Content-Type header field.
+      # @option options [String] :content_language
+      #   The language the content is in.
+      # @option options [String] :content_type
+      #   A standard MIME type describing the format of the object data.
+      # @option options [required, String] :copy_source
+      #   The name of the source bucket and key name of the source object,
+      #   separated by a slash (/). Must be URL-encoded.
+      # @option options [String] :copy_source_if_match
+      #   Copies the object if its entity tag (ETag) matches the specified tag.
+      # @option options [Time,DateTime,Date,Integer,String] :copy_source_if_modified_since
+      #   Copies the object if it has been modified since the specified time.
+      # @option options [String] :copy_source_if_none_match
+      #   Copies the object if its entity tag (ETag) is different than the
+      #   specified ETag.
+      # @option options [Time,DateTime,Date,Integer,String] :copy_source_if_unmodified_since
+      #   Copies the object if it hasn't been modified since the specified
+      #   time.
+      # @option options [Time,DateTime,Date,Integer,String] :expires
+      #   The date and time at which the object is no longer cacheable.
+      # @option options [String] :grant_full_control
+      #   Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the
+      #   object.
+      # @option options [String] :grant_read
+      #   Allows grantee to read the object data and its metadata.
+      # @option options [String] :grant_read_acp
+      #   Allows grantee to read the object ACL.
+      # @option options [String] :grant_write_acp
+      #   Allows grantee to write the ACL for the applicable object.
+      # @option options [Hash<String,String>] :metadata
+      #   A map of metadata to store with the object in S3.
+      # @option options [String] :metadata_directive
+      #   Specifies whether the metadata is copied from the source object or
+      #   replaced with metadata provided in the request.
+      # @option options [String] :server_side_encryption
+      #   The Server-side encryption algorithm used when storing this object in
+      #   S3 (e.g., AES256, aws:kms).
+      # @option options [String] :storage_class
+      #   The type of storage to use for the object. Defaults to 'STANDARD'.
+      # @option options [String] :website_redirect_location
+      #   If the bucket is configured as a website, redirects requests for this
+      #   object to another object in the same bucket or to an external URL.
+      #   Amazon S3 stores the value of this header in the object metadata.
+      # @option options [String] :sse_customer_algorithm
+      #   Specifies the algorithm to use to when encrypting the object (e.g.,
+      #   AES256).
+      # @option options [String] :sse_customer_key
+      #   Specifies the customer-provided encryption key for Amazon S3 to use in
+      #   encrypting data. This value is used to store the object and then it is
+      #   discarded; Amazon does not store the encryption key. The key must be
+      #   appropriate for use with the algorithm specified in the
+      #   x-amz-server-side​-encryption​-customer-algorithm header.
+      # @option options [String] :sse_customer_key_md5
+      #   Specifies the 128-bit MD5 digest of the encryption key according to
+      #   RFC 1321. Amazon S3 uses this header for a message integrity check to
+      #   ensure the encryption key was transmitted without error.
+      # @option options [String] :ssekms_key_id
+      #   Specifies the AWS KMS key ID to use for object encryption. All GET and
+      #   PUT requests for an object protected by AWS KMS will fail if not made
+      #   via SSL or using SigV4. Documentation on configuring any of the
+      #   officially supported AWS SDKs and CLI can be found at
+      #   http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
+      # @option options [String] :copy_source_sse_customer_algorithm
+      #   Specifies the algorithm to use when decrypting the source object
+      #   (e.g., AES256).
+      # @option options [String] :copy_source_sse_customer_key
+      #   Specifies the customer-provided encryption key for Amazon S3 to use to
+      #   decrypt the source object. The encryption key provided in this header
+      #   must be one that was used when the source object was created.
+      # @option options [String] :copy_source_sse_customer_key_md5
+      #   Specifies the 128-bit MD5 digest of the encryption key according to
+      #   RFC 1321. Amazon S3 uses this header for a message integrity check to
+      #   ensure the encryption key was transmitted without error.
+      # @option options [String] :request_payer
+      #   Confirms that the requester knows that she or he will be charged for
+      #   the request. Bucket owners need not specify this parameter in their
+      #   requests. Documentation on downloading objects from requester pays
+      #   buckets can be found at
+      #   http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
+      # @return [Types::CopyObjectOutput]
+      def copy_from(options = {})
+        options = options.merge(
+          bucket: @bucket_name,
+          key: @key
+        )
+        resp = @client.copy_object(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   object_summary.delete({
+      #     mfa: "MFA",
+      #     version_id: "ObjectVersionId",
+      #     request_payer: "requester", # accepts requester
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :mfa
+      #   The concatenation of the authentication device's serial number, a
+      #   space, and the value that is displayed on your authentication device.
+      # @option options [String] :version_id
+      #   VersionId used to reference a specific version of the object.
+      # @option options [String] :request_payer
+      #   Confirms that the requester knows that she or he will be charged for
+      #   the request. Bucket owners need not specify this parameter in their
+      #   requests. Documentation on downloading objects from requester pays
+      #   buckets can be found at
+      #   http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
+      # @return [Types::DeleteObjectOutput]
+      def delete(options = {})
+        options = options.merge(
+          bucket: @bucket_name,
+          key: @key
+        )
+        resp = @client.delete_object(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   object_summary.get({
+      #     if_match: "IfMatch",
+      #     if_modified_since: Time.now,
+      #     if_none_match: "IfNoneMatch",
+      #     if_unmodified_since: Time.now,
+      #     range: "Range",
+      #     response_cache_control: "ResponseCacheControl",
+      #     response_content_disposition: "ResponseContentDisposition",
+      #     response_content_encoding: "ResponseContentEncoding",
+      #     response_content_language: "ResponseContentLanguage",
+      #     response_content_type: "ResponseContentType",
+      #     response_expires: Time.now,
+      #     version_id: "ObjectVersionId",
+      #     sse_customer_algorithm: "SSECustomerAlgorithm",
+      #     sse_customer_key: "SSECustomerKey",
+      #     sse_customer_key_md5: "SSECustomerKeyMD5",
+      #     request_payer: "requester", # accepts requester
+      #     part_number: 1,
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :if_match
+      #   Return the object only if its entity tag (ETag) is the same as the one
+      #   specified, otherwise return a 412 (precondition failed).
+      # @option options [Time,DateTime,Date,Integer,String] :if_modified_since
+      #   Return the object only if it has been modified since the specified
+      #   time, otherwise return a 304 (not modified).
+      # @option options [String] :if_none_match
+      #   Return the object only if its entity tag (ETag) is different from the
+      #   one specified, otherwise return a 304 (not modified).
+      # @option options [Time,DateTime,Date,Integer,String] :if_unmodified_since
+      #   Return the object only if it has not been modified since the specified
+      #   time, otherwise return a 412 (precondition failed).
+      # @option options [String] :range
+      #   Downloads the specified range bytes of an object. For more information
+      #   about the HTTP Range header, go to
+      #   http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
+      # @option options [String] :response_cache_control
+      #   Sets the Cache-Control header of the response.
+      # @option options [String] :response_content_disposition
+      #   Sets the Content-Disposition header of the response
+      # @option options [String] :response_content_encoding
+      #   Sets the Content-Encoding header of the response.
+      # @option options [String] :response_content_language
+      #   Sets the Content-Language header of the response.
+      # @option options [String] :response_content_type
+      #   Sets the Content-Type header of the response.
+      # @option options [Time,DateTime,Date,Integer,String] :response_expires
+      #   Sets the Expires header of the response.
+      # @option options [String] :version_id
+      #   VersionId used to reference a specific version of the object.
+      # @option options [String] :sse_customer_algorithm
+      #   Specifies the algorithm to use to when encrypting the object (e.g.,
+      #   AES256).
+      # @option options [String] :sse_customer_key
+      #   Specifies the customer-provided encryption key for Amazon S3 to use in
+      #   encrypting data. This value is used to store the object and then it is
+      #   discarded; Amazon does not store the encryption key. The key must be
+      #   appropriate for use with the algorithm specified in the
+      #   x-amz-server-side​-encryption​-customer-algorithm header.
+      # @option options [String] :sse_customer_key_md5
+      #   Specifies the 128-bit MD5 digest of the encryption key according to
+      #   RFC 1321. Amazon S3 uses this header for a message integrity check to
+      #   ensure the encryption key was transmitted without error.
+      # @option options [String] :request_payer
+      #   Confirms that the requester knows that she or he will be charged for
+      #   the request. Bucket owners need not specify this parameter in their
+      #   requests. Documentation on downloading objects from requester pays
+      #   buckets can be found at
+      #   http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
+      # @option options [Integer] :part_number
+      #   Part number of the object being read. This is a positive integer
+      #   between 1 and 10,000. Effectively performs a 'ranged' GET request
+      #   for the part specified. Useful for downloading just a part of an
+      #   object.
+      # @return [Types::GetObjectOutput]
+      def get(options = {})
+        options = options.merge(
+          bucket: @bucket_name,
+          key: @key
+        )
+        resp = @client.get_object(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   multipartupload = object_summary.initiate_multipart_upload({
+      #     acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
+      #     cache_control: "CacheControl",
+      #     content_disposition: "ContentDisposition",
+      #     content_encoding: "ContentEncoding",
+      #     content_language: "ContentLanguage",
+      #     content_type: "ContentType",
+      #     expires: Time.now,
+      #     grant_full_control: "GrantFullControl",
+      #     grant_read: "GrantRead",
+      #     grant_read_acp: "GrantReadACP",
+      #     grant_write_acp: "GrantWriteACP",
+      #     metadata: {
+      #       "MetadataKey" => "MetadataValue",
+      #     },
+      #     server_side_encryption: "AES256", # accepts AES256, aws:kms
+      #     storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA
+      #     website_redirect_location: "WebsiteRedirectLocation",
+      #     sse_customer_algorithm: "SSECustomerAlgorithm",
+      #     sse_customer_key: "SSECustomerKey",
+      #     sse_customer_key_md5: "SSECustomerKeyMD5",
+      #     ssekms_key_id: "SSEKMSKeyId",
+      #     request_payer: "requester", # accepts requester
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :acl
+      #   The canned ACL to apply to the object.
+      # @option options [String] :cache_control
+      #   Specifies caching behavior along the request/reply chain.
+      # @option options [String] :content_disposition
+      #   Specifies presentational information for the object.
+      # @option options [String] :content_encoding
+      #   Specifies what content encodings have been applied to the object and
+      #   thus what decoding mechanisms must be applied to obtain the media-type
+      #   referenced by the Content-Type header field.
+      # @option options [String] :content_language
+      #   The language the content is in.
+      # @option options [String] :content_type
+      #   A standard MIME type describing the format of the object data.
+      # @option options [Time,DateTime,Date,Integer,String] :expires
+      #   The date and time at which the object is no longer cacheable.
+      # @option options [String] :grant_full_control
+      #   Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the
+      #   object.
+      # @option options [String] :grant_read
+      #   Allows grantee to read the object data and its metadata.
+      # @option options [String] :grant_read_acp
+      #   Allows grantee to read the object ACL.
+      # @option options [String] :grant_write_acp
+      #   Allows grantee to write the ACL for the applicable object.
+      # @option options [Hash<String,String>] :metadata
+      #   A map of metadata to store with the object in S3.
+      # @option options [String] :server_side_encryption
+      #   The Server-side encryption algorithm used when storing this object in
+      #   S3 (e.g., AES256, aws:kms).
+      # @option options [String] :storage_class
+      #   The type of storage to use for the object. Defaults to 'STANDARD'.
+      # @option options [String] :website_redirect_location
+      #   If the bucket is configured as a website, redirects requests for this
+      #   object to another object in the same bucket or to an external URL.
+      #   Amazon S3 stores the value of this header in the object metadata.
+      # @option options [String] :sse_customer_algorithm
+      #   Specifies the algorithm to use to when encrypting the object (e.g.,
+      #   AES256).
+      # @option options [String] :sse_customer_key
+      #   Specifies the customer-provided encryption key for Amazon S3 to use in
+      #   encrypting data. This value is used to store the object and then it is
+      #   discarded; Amazon does not store the encryption key. The key must be
+      #   appropriate for use with the algorithm specified in the
+      #   x-amz-server-side​-encryption​-customer-algorithm header.
+      # @option options [String] :sse_customer_key_md5
+      #   Specifies the 128-bit MD5 digest of the encryption key according to
+      #   RFC 1321. Amazon S3 uses this header for a message integrity check to
+      #   ensure the encryption key was transmitted without error.
+      # @option options [String] :ssekms_key_id
+      #   Specifies the AWS KMS key ID to use for object encryption. All GET and
+      #   PUT requests for an object protected by AWS KMS will fail if not made
+      #   via SSL or using SigV4. Documentation on configuring any of the
+      #   officially supported AWS SDKs and CLI can be found at
+      #   http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
+      # @option options [String] :request_payer
+      #   Confirms that the requester knows that she or he will be charged for
+      #   the request. Bucket owners need not specify this parameter in their
+      #   requests. Documentation on downloading objects from requester pays
+      #   buckets can be found at
+      #   http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
+      # @return [MultipartUpload]
+      def initiate_multipart_upload(options = {})
+        options = options.merge(
+          bucket: @bucket_name,
+          key: @key
+        )
+        resp = @client.create_multipart_upload(options)
+        MultipartUpload.new(
+          bucket_name: @bucket_name,
+          object_key: @key,
+          id: resp.data.upload_id,
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   object_summary.put({
+      #     acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
+      #     body: source_file,
+      #     cache_control: "CacheControl",
+      #     content_disposition: "ContentDisposition",
+      #     content_encoding: "ContentEncoding",
+      #     content_language: "ContentLanguage",
+      #     content_length: 1,
+      #     content_md5: "ContentMD5",
+      #     content_type: "ContentType",
+      #     expires: Time.now,
+      #     grant_full_control: "GrantFullControl",
+      #     grant_read: "GrantRead",
+      #     grant_read_acp: "GrantReadACP",
+      #     grant_write_acp: "GrantWriteACP",
+      #     metadata: {
+      #       "MetadataKey" => "MetadataValue",
+      #     },
+      #     server_side_encryption: "AES256", # accepts AES256, aws:kms
+      #     storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA
+      #     website_redirect_location: "WebsiteRedirectLocation",
+      #     sse_customer_algorithm: "SSECustomerAlgorithm",
+      #     sse_customer_key: "SSECustomerKey",
+      #     sse_customer_key_md5: "SSECustomerKeyMD5",
+      #     ssekms_key_id: "SSEKMSKeyId",
+      #     request_payer: "requester", # accepts requester
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :acl
+      #   The canned ACL to apply to the object.
+      # @option options [String, IO] :body
+      #   Object data.
+      # @option options [String] :cache_control
+      #   Specifies caching behavior along the request/reply chain.
+      # @option options [String] :content_disposition
+      #   Specifies presentational information for the object.
+      # @option options [String] :content_encoding
+      #   Specifies what content encodings have been applied to the object and
+      #   thus what decoding mechanisms must be applied to obtain the media-type
+      #   referenced by the Content-Type header field.
+      # @option options [String] :content_language
+      #   The language the content is in.
+      # @option options [Integer] :content_length
+      #   Size of the body in bytes. This parameter is useful when the size of
+      #   the body cannot be determined automatically.
+      # @option options [String] :content_md5
+      #   The base64-encoded 128-bit MD5 digest of the part data.
+      # @option options [String] :content_type
+      #   A standard MIME type describing the format of the object data.
+      # @option options [Time,DateTime,Date,Integer,String] :expires
+      #   The date and time at which the object is no longer cacheable.
+      # @option options [String] :grant_full_control
+      #   Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the
+      #   object.
+      # @option options [String] :grant_read
+      #   Allows grantee to read the object data and its metadata.
+      # @option options [String] :grant_read_acp
+      #   Allows grantee to read the object ACL.
+      # @option options [String] :grant_write_acp
+      #   Allows grantee to write the ACL for the applicable object.
+      # @option options [Hash<String,String>] :metadata
+      #   A map of metadata to store with the object in S3.
+      # @option options [String] :server_side_encryption
+      #   The Server-side encryption algorithm used when storing this object in
+      #   S3 (e.g., AES256, aws:kms).
+      # @option options [String] :storage_class
+      #   The type of storage to use for the object. Defaults to 'STANDARD'.
+      # @option options [String] :website_redirect_location
+      #   If the bucket is configured as a website, redirects requests for this
+      #   object to another object in the same bucket or to an external URL.
+      #   Amazon S3 stores the value of this header in the object metadata.
+      # @option options [String] :sse_customer_algorithm
+      #   Specifies the algorithm to use to when encrypting the object (e.g.,
+      #   AES256).
+      # @option options [String] :sse_customer_key
+      #   Specifies the customer-provided encryption key for Amazon S3 to use in
+      #   encrypting data. This value is used to store the object and then it is
+      #   discarded; Amazon does not store the encryption key. The key must be
+      #   appropriate for use with the algorithm specified in the
+      #   x-amz-server-side​-encryption​-customer-algorithm header.
+      # @option options [String] :sse_customer_key_md5
+      #   Specifies the 128-bit MD5 digest of the encryption key according to
+      #   RFC 1321. Amazon S3 uses this header for a message integrity check to
+      #   ensure the encryption key was transmitted without error.
+      # @option options [String] :ssekms_key_id
+      #   Specifies the AWS KMS key ID to use for object encryption. All GET and
+      #   PUT requests for an object protected by AWS KMS will fail if not made
+      #   via SSL or using SigV4. Documentation on configuring any of the
+      #   officially supported AWS SDKs and CLI can be found at
+      #   http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
+      # @option options [String] :request_payer
+      #   Confirms that the requester knows that she or he will be charged for
+      #   the request. Bucket owners need not specify this parameter in their
+      #   requests. Documentation on downloading objects from requester pays
+      #   buckets can be found at
+      #   http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
+      # @return [Types::PutObjectOutput]
+      def put(options = {})
+        options = options.merge(
+          bucket: @bucket_name,
+          key: @key
+        )
+        resp = @client.put_object(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   object_summary.restore_object({
+      #     version_id: "ObjectVersionId",
+      #     restore_request: {
+      #       days: 1, # required
+      #       glacier_job_parameters: {
+      #         tier: "Standard", # required, accepts Standard, Bulk, Expedited
+      #       },
+      #     },
+      #     request_payer: "requester", # accepts requester
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :version_id
+      # @option options [Types::RestoreRequest] :restore_request
+      # @option options [String] :request_payer
+      #   Confirms that the requester knows that she or he will be charged for
+      #   the request. Bucket owners need not specify this parameter in their
+      #   requests. Documentation on downloading objects from requester pays
+      #   buckets can be found at
+      #   http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
+      # @return [Types::RestoreObjectOutput]
+      def restore_object(options = {})
+        options = options.merge(
+          bucket: @bucket_name,
+          key: @key
+        )
+        resp = @client.restore_object(options)
+        resp.data
+      end
+
+      # @!group Associations
+
+      # @return [ObjectAcl]
+      def acl
+        ObjectAcl.new(
+          bucket_name: @bucket_name,
+          object_key: @key,
+          client: @client
+        )
+      end
+
+      # @return [Bucket]
+      def bucket
+        Bucket.new(
+          name: @bucket_name,
+          client: @client
+        )
+      end
+
+      # @param [String] id
+      # @return [MultipartUpload]
+      def multipart_upload(id)
+        MultipartUpload.new(
+          bucket_name: @bucket_name,
+          object_key: @key,
+          id: id,
+          client: @client
+        )
+      end
+
+      # @return [Object]
+      def object
+        Object.new(
+          bucket_name: @bucket_name,
+          key: @key,
+          client: @client
+        )
+      end
+
+      # @param [String] id
+      # @return [ObjectVersion]
+      def version(id)
+        ObjectVersion.new(
+          bucket_name: @bucket_name,
+          object_key: @key,
+          id: id,
+          client: @client
+        )
+      end
+
+      # @deprecated
+      # @api private
+      def identifiers
+        {
+          bucket_name: @bucket_name,
+          key: @key
+        }
+      end
+      deprecated(:identifiers)
+
+      private
+
+      def extract_bucket_name(args, options)
+        value = args[0] || options.delete(:bucket_name)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :bucket_name"
+        else
+          msg = "expected :bucket_name to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      def extract_key(args, options)
+        value = args[1] || options.delete(:key)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :key"
+        else
+          msg = "expected :key to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      def yield_waiter_and_warn(waiter, &block)
+        if !@waiter_block_warned
+          msg = "pass options to configure the waiter; "
+          msg << "yielding the waiter is deprecated"
+          warn(msg)
+          @waiter_block_warned = true
+        end
+        yield(waiter.waiter)
+      end
+
+      def separate_params_and_options(options)
+        opts = Set.new([:client, :max_attempts, :delay, :before_attempt, :before_wait])
+        waiter_opts = {}
+        waiter_params = {}
+        options.each_pair do |key, value|
+          if opts.include?(key)
+            waiter_opts[key] = value
+          else
+            waiter_params[key] = value
+          end
+        end
+        waiter_opts[:client] ||= @client
+        [waiter_opts, waiter_params]
+      end
+
+      class Collection < Aws::Resources::Collection
+
+        # @!group Batch Actions
+
+        # @example Request syntax with placeholder values
+        #
+        #   object_summary.batch_delete!({
+        #     mfa: "MFA",
+        #     request_payer: "requester", # accepts requester
+        #   })
+        # @param options ({})
+        # @option options [String] :mfa
+        #   The concatenation of the authentication device's serial number, a
+        #   space, and the value that is displayed on your authentication device.
+        # @option options [String] :request_payer
+        #   Confirms that the requester knows that she or he will be charged for
+        #   the request. Bucket owners need not specify this parameter in their
+        #   requests. Documentation on downloading objects from requester pays
+        #   buckets can be found at
+        #   http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
+        # @return [void]
+        def batch_delete!(options = {})
+          batch_enum.each do |batch|
+            params = Aws::Util.copy_hash(options)
+            params[:bucket] = batch[0].bucket_name
+            params[:delete] ||= {}
+            params[:delete][:objects] ||= []
+            batch.each do |item|
+              params[:delete][:objects] << {
+                key: item.key
+              }
+            end
+            batch[0].client.delete_objects(params)
+          end
+          nil
+        end
+
+        # @!endgroup
+
+      end
+    end
+  end
+end