Class: Aws::S3::ObjectSummary

#initialize(bucket_name, key, options = {}) ⇒ ObjectSummary
Parameters:
- bucket_name (String)
- key (String)
Options Hash (options):
- :client (Client)
#initialize(options = {}) ⇒ ObjectSummary
Options Hash (options):
- :bucket_name (required, String)
- :key (required, String)
- :client (Client)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 24

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)
  @waiter_block_warned = false
end

Instance Method Details

#acl ⇒ `ObjectAcl`

Returns:

(ObjectAcl)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 1197

def acl
  ObjectAcl.new(
    bucket_name: @bucket_name,
    object_key: @key,
    client: @client
  )
end

#bucket ⇒ `Bucket`

Returns:

(Bucket)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 1206

def bucket
  Bucket.new(
    name: @bucket_name,
    client: @client
  )
end

#bucket_name ⇒ `String`

Returns:

(String)



36
37
38

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 36

def bucket_name
  @bucket_name
end

#client ⇒ `Client`

Returns:

(Client)



95
96
97

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 95

def client
  @client
end

#copy_from(source, options = {}) ⇒ `Object`

Parameters:

source (S3::Object, S3::ObjectVersion, S3::ObjectSummary, String, Hash) —
Where to copy object data from. source must be one of the following:
- Aws::S3::Object
- Aws::S3::ObjectSummary
- Aws::S3::ObjectVersion
- Hash - with :bucket and :key and optional :version_id
- String - formatted like "source-bucket-name/uri-escaped-key" or "source-bucket-name/uri-escaped-key?versionId=version-id"
options (Hash) (defaults to: {}) —
a customizable set of options

See Also:

Aws::S3::Object#copy_from

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 511

def copy_from(options = {})
  options = options.merge(
    bucket: @bucket_name,
    key: @key
  )
  resp = @client.copy_object(options)
  resp.data
end

#copy_to(target, options = {}) ⇒ `Object`

Parameters:

target (S3::Object, String, Hash) —
Where to copy the object data to. target must be one of the following:
- Aws::S3::Object
- Hash - with :bucket and :key
- String - formatted like "target-bucket-name/target-key"

See Also:

Aws::S3::Object#copy_to



24
25
26

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb', line 24

def copy_to(target, options = {})
  object.copy_to(target, options)
end

#data ⇒ `Types::Object`

Returns the data for this Aws::S3::ObjectSummary.

Returns:

(Types::Object) —
Returns the data for this Aws::S3::ObjectSummary.

Raises:

(NotImplementedError) —
Raises when #data_loaded? is false.

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 110

def data
  load unless @data
  @data
end

#data_loaded? ⇒ `Boolean`

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

(Boolean) —
Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



118
119
120

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 118

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ `Types::DeleteObjectOutput`

Examples:

Request syntax with placeholder values


object_summary.delete({
  mfa: "MFA",
  version_id: "ObjectVersionId",
  request_payer: "requester", # accepts requester
  bypass_governance_retention: false,
  expected_bucket_owner: "AccountId",
})

Parameters:

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

Options Hash (options):

:mfa (String) —
The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.
:version_id (String) —
VersionId used to reference a specific version of the object.
:request_payer (String) —
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 Developer Guide.
:bypass_governance_retention (Boolean) —
Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.
:expected_bucket_owner (String) —
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

(Types::DeleteObjectOutput)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 555

def delete(options = {})
  options = options.merge(
    bucket: @bucket_name,
    key: @key
  )
  resp = @client.delete_object(options)
  resp.data
end

#download_file(destination, options = {}) ⇒ `Boolean`

Returns true when the file is downloaded without any errors.

Parameters:

destination (String) —
Where to download the file to.
options (Hash) (defaults to: {}) —
a customizable set of options

Returns:

(Boolean) —
Returns true when the file is downloaded without any errors.

See Also:

Aws::S3::Object#download_file



79
80
81

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb', line 79

def download_file(destination, options = {})
  object.download_file(destination, options)
end

#etag ⇒ `String`

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.
Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.
If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.

Returns:

(String)



70
71
72

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 70

def etag
  data[:etag]
end

#exists?(options = {}) ⇒ `Boolean`

Returns true if the ObjectSummary exists.

Parameters:

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

Returns:

(Boolean) —
Returns true if the ObjectSummary exists.

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 125

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

#get(options = {}, &block) ⇒ `Types::GetObjectOutput`

Examples:

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,
  expected_bucket_owner: "AccountId",
})

Parameters:

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

Options Hash (options):

:if_match (String) —
Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).
:if_modified_since (Time, DateTime, Date, Integer, String) —
Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
:if_none_match (String) —
Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).
:if_unmodified_since (Time, DateTime, Date, Integer, String) —
Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).
:range (String) —
Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.
:response_cache_control (String) —
Sets the Cache-Control header of the response.
:response_content_disposition (String) —
Sets the Content-Disposition header of the response
:response_content_encoding (String) —
Sets the Content-Encoding header of the response.
:response_content_language (String) —
Sets the Content-Language header of the response.
:response_content_type (String) —
Sets the Content-Type header of the response.
:response_expires (Time, DateTime, Date, Integer, String) —
Sets the Expires header of the response.
:version_id (String) —
VersionId used to reference a specific version of the object.
:sse_customer_algorithm (String) —
Specifies the algorithm to use to when encrypting the object (for example, AES256).
:sse_customer_key (String) —
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 S3 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.
:sse_customer_key_md5 (String) —
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 that the encryption key was transmitted without error.
:request_payer (String) —
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 Developer Guide.
:part_number (Integer) —
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.
:expected_bucket_owner (String) —
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

(Types::GetObjectOutput)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 659

def get(options = {}, &block)
  options = options.merge(
    bucket: @bucket_name,
    key: @key
  )
  resp = @client.get_object(options, &block)
  resp.data
end

#initiate_multipart_upload(options = {}) ⇒ `MultipartUpload`

Examples:

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, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
  website_redirect_location: "WebsiteRedirectLocation",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  ssekms_key_id: "SSEKMSKeyId",
  ssekms_encryption_context: "SSEKMSEncryptionContext",
  bucket_key_enabled: false,
  request_payer: "requester", # accepts requester
  tagging: "TaggingHeader",
  object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
  object_lock_retain_until_date: Time.now,
  object_lock_legal_hold_status: "ON", # accepts ON, OFF
  expected_bucket_owner: "AccountId",
})

Parameters:

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

Options Hash (options):

:acl (String) —
The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.
:cache_control (String) —
Specifies caching behavior along the request/reply chain.
:content_disposition (String) —
Specifies presentational information for the object.
:content_encoding (String) —
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.
:content_language (String) —
The language the content is in.
:content_type (String) —
A standard MIME type describing the format of the object data.
:expires (Time, DateTime, Date, Integer, String) —
The date and time at which the object is no longer cacheable.
:grant_full_control (String) —
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.
:grant_read (String) —
Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.
:grant_read_acp (String) —
Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.
:grant_write_acp (String) —
Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.
:metadata (Hash<String,String>) —
A map of metadata to store with the object in S3.
:server_side_encryption (String) —
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
:storage_class (String) —
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.
:website_redirect_location (String) —
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.
:sse_customer_algorithm (String) —
Specifies the algorithm to use to when encrypting the object (for example, AES256).
:sse_customer_key (String) —
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 S3 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.
:sse_customer_key_md5 (String) —
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 that the encryption key was transmitted without error.
:ssekms_key_id (String) —
Specifies the ID of the symmetric customer managed AWS KMS CMK 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. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 Developer Guide.
:ssekms_encryption_context (String) —
Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
:bucket_key_enabled (Boolean) —
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with an object operation doesn’t affect bucket-level settings for S3 Bucket Key.
:request_payer (String) —
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 Developer Guide.
:tagging (String) —
The tag-set for the object. The tag-set must be encoded as URL Query parameters.
:object_lock_mode (String) —
Specifies the Object Lock mode that you want to apply to the uploaded object.
:object_lock_retain_until_date (Time, DateTime, Date, Integer, String) —
Specifies the date and time when you want the Object Lock to expire.
:object_lock_legal_hold_status (String) —
Specifies whether you want to apply a Legal Hold to the uploaded object.
:expected_bucket_owner (String) —
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

(MultipartUpload)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 819

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

#key ⇒ `String`

Returns:

(String)



41
42
43

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 41

def key
  @key
end

#last_modified ⇒ `Time`

The date the Object was Last Modified

Returns:

(Time)



47
48
49

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 47

def last_modified
  data[:last_modified]
end

#move_to(target, options = {}) ⇒ `void`

This method returns an undefined value.

Parameters:

target (S3::Object, String, Hash) —
Where to copy the object data to. target must be one of the following:
- Aws::S3::Object
- Hash - with :bucket and :key
- String - formatted like "target-bucket-name/target-key"

See Also:

Aws::S3::Object#move_to



32
33
34

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb', line 32

def move_to(target, options = {})
  object.move_to(target, options)
end

#multipart_upload(id) ⇒ `MultipartUpload`

Parameters:

id (String)

Returns:

(MultipartUpload)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 1215

def multipart_upload(id)
  MultipartUpload.new(
    bucket_name: @bucket_name,
    object_key: @key,
    id: id,
    client: @client
  )
end

#object ⇒ `Object`

Returns:

(Object)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 1225

def object
  Object.new(
    bucket_name: @bucket_name,
    key: @key,
    client: @client
  )
end

#owner ⇒ `Types::Owner`

The owner of the object

Returns:

(Types::Owner)



88
89
90

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 88

def owner
  data[:owner]
end

#presigned_post(options = {}) ⇒ `PresignedPost`

Parameters:

options (Hash) (defaults to: {}) —
a customizable set of options

Returns:

(PresignedPost)

See Also:

Aws::S3::Object#presigned_post



40
41
42

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb', line 40

def presigned_post(options = {})
  object.presigned_post(options)
end

#presigned_url(http_method, params = {}) ⇒ `String`

Parameters:

http_method (Symbol) —
The HTTP method to generate a presigned URL for. Valid values are :get, :put, :head, and :delete.

params (Hash) (defaults to: {}) —

Additional request parameters to use when generating the pre-signed URL. See the related documentation in Client for accepted params.

HTTP Method	Client Method
`:get`	Client#get_object
`:put`	Client#put_object
`:head`	Client#head_object
`:delete`	Client#delete_object

Returns:

(String)

See Also:

Aws::S3::Object#presigned_url



48
49
50

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb', line 48

def presigned_url(http_method, params = {})
  object.presigned_url(http_method, params)
end

#public_url(options = {}) ⇒ `String`

Parameters:

options (Hash) (defaults to: {}) —
a customizable set of options

Returns:

(String)

See Also:

Aws::S3::Object#public_url



56
57
58

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb', line 56

def public_url(options = {})
  object.public_url(options)
end

#put(options = {}) ⇒ `Types::PutObjectOutput`

Examples:

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, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
  website_redirect_location: "WebsiteRedirectLocation",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  ssekms_key_id: "SSEKMSKeyId",
  ssekms_encryption_context: "SSEKMSEncryptionContext",
  bucket_key_enabled: false,
  request_payer: "requester", # accepts requester
  tagging: "TaggingHeader",
  object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
  object_lock_retain_until_date: Time.now,
  object_lock_legal_hold_status: "ON", # accepts ON, OFF
  expected_bucket_owner: "AccountId",
})

Parameters:

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

Options Hash (options):

:acl (String) —
The canned ACL to apply to the object. For more information, see Canned ACL.

This action is not supported by Amazon S3 on Outposts.
:body (String, StringIO, File) —
Object data.
:cache_control (String) —
Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
:content_disposition (String) —
Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.
:content_encoding (String) —
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. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.
:content_language (String) —
The language the content is in.
:content_length (Integer) —
Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.
:content_md5 (String) —
The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.
:content_type (String) —
A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.
:expires (Time, DateTime, Date, Integer, String) —
The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.
:grant_full_control (String) —
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.
:grant_read (String) —
Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.
:grant_read_acp (String) —
Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.
:grant_write_acp (String) —
Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.
:metadata (Hash<String,String>) —
A map of metadata to store with the object in S3.
:server_side_encryption (String) —
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
:storage_class (String) —
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.
:website_redirect_location (String) —
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. For information about object metadata, see Object Key and Metadata.

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

In the following example, the request header sets the object redirect to another website:

x-amz-website-redirect-location: http://www.example.com/

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.
:sse_customer_algorithm (String) —
Specifies the algorithm to use to when encrypting the object (for example, AES256).
:sse_customer_key (String) —
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 S3 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.
:sse_customer_key_md5 (String) —
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 that the encryption key was transmitted without error.
:ssekms_key_id (String) —
If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object.

If the value of x-amz-server-side-encryption is aws:kms, this header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not providex-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS to protect the data.
:ssekms_encryption_context (String) —
Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
:bucket_key_enabled (Boolean) —
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a PUT operation doesn’t affect bucket-level settings for S3 Bucket Key.
:request_payer (String) —
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 Developer Guide.
:tagging (String) —
The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
:object_lock_mode (String) —
The Object Lock mode that you want to apply to this object.
:object_lock_retain_until_date (Time, DateTime, Date, Integer, String) —
The date and time when you want this object's Object Lock to expire.
:object_lock_legal_hold_status (String) —
Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.
:expected_bucket_owner (String) —
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

(Types::PutObjectOutput)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 1068

def put(options = {})
  options = options.merge(
    bucket: @bucket_name,
    key: @key
  )
  resp = @client.put_object(options)
  resp.data
end

#restore_object(options = {}) ⇒ `Types::RestoreObjectOutput`

Examples:

Request syntax with placeholder values


object_summary.restore_object({
  version_id: "ObjectVersionId",
  restore_request: {
    days: 1,
    glacier_job_parameters: {
      tier: "Standard", # required, accepts Standard, Bulk, Expedited
    },
    type: "SELECT", # accepts SELECT
    tier: "Standard", # accepts Standard, Bulk, Expedited
    description: "Description",
    select_parameters: {
      input_serialization: { # required
        csv: {
          file_header_info: "USE", # accepts USE, IGNORE, NONE
          comments: "Comments",
          quote_escape_character: "QuoteEscapeCharacter",
          record_delimiter: "RecordDelimiter",
          field_delimiter: "FieldDelimiter",
          quote_character: "QuoteCharacter",
          allow_quoted_record_delimiter: false,
        },
        compression_type: "NONE", # accepts NONE, GZIP, BZIP2
        json: {
          type: "DOCUMENT", # accepts DOCUMENT, LINES
        },
        parquet: {
        },
      },
      expression_type: "SQL", # required, accepts SQL
      expression: "Expression", # required
      output_serialization: { # required
        csv: {
          quote_fields: "ALWAYS", # accepts ALWAYS, ASNEEDED
          quote_escape_character: "QuoteEscapeCharacter",
          record_delimiter: "RecordDelimiter",
          field_delimiter: "FieldDelimiter",
          quote_character: "QuoteCharacter",
        },
        json: {
          record_delimiter: "RecordDelimiter",
        },
      },
    },
    output_location: {
      s3: {
        bucket_name: "BucketName", # required
        prefix: "LocationPrefix", # required
        encryption: {
          encryption_type: "AES256", # required, accepts AES256, aws:kms
          kms_key_id: "SSEKMSKeyId",
          kms_context: "KMSContext",
        },
        canned_acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
        access_control_list: [
          {
            grantee: {
              display_name: "DisplayName",
              email_address: "EmailAddress",
              id: "ID",
              type: "CanonicalUser", # required, accepts CanonicalUser, AmazonCustomerByEmail, Group
              uri: "URI",
            },
            permission: "FULL_CONTROL", # accepts FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP
          },
        ],
        tagging: {
          tag_set: [ # required
            {
              key: "ObjectKey", # required
              value: "Value", # required
            },
          ],
        },
        user_metadata: [
          {
            name: "MetadataKey",
            value: "MetadataValue",
          },
        ],
        storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
      },
    },
  },
  request_payer: "requester", # accepts requester
  expected_bucket_owner: "AccountId",
})

Parameters:

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

Options Hash (options):

:version_id (String) —
VersionId used to reference a specific version of the object.
:restore_request (Types::RestoreRequest) —
Container for restore job parameters.
:request_payer (String) —
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 Developer Guide.
:expected_bucket_owner (String) —
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

(Types::RestoreObjectOutput)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 1185

def restore_object(options = {})
  options = options.merge(
    bucket: @bucket_name,
    key: @key
  )
  resp = @client.restore_object(options)
  resp.data
end

#size ⇒ `Integer` Also known as: content_length

Size in bytes of the object

Returns:

(Integer)



76
77
78

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 76

def size
  data[:size]
end

#storage_class ⇒ `String`

The class of storage used to store the object.

Returns:

(String)



82
83
84

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 82

def storage_class
  data[:storage_class]
end

#upload_file(source, options = {}) ⇒ `Boolean`

Returns true when the object is uploaded without any errors.

Parameters:

source (String, Pathname, File, Tempfile) —
A file on the local file system that will be uploaded as this object. This can either be a String or Pathname to the file, an open File object, or an open Tempfile object. If you pass an open File or Tempfile object, then you are responsible for closing it after the upload completes. When using an open Tempfile, rewind it before uploading or else the object will be empty.
options (Hash) (defaults to: {}) —
a customizable set of options

Returns:

(Boolean) —
Returns true when the object is uploaded without any errors.

See Also:

Aws::S3::Object#upload_file



64
65
66

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb', line 64

def upload_file(source, options = {})
  object.upload_file(source, options)
end

#upload_stream(options = {}, &block) ⇒ `Boolean`

Returns true when the object is uploaded without any errors.

Returns:

(Boolean) —
Returns true when the object is uploaded without any errors.

See Also:

Aws::S3::Object#upload_stream



71
72
73

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb', line 71

def upload_stream(options = {}, &block)
  object.upload_stream(options, &block)
end

#version(id) ⇒ `ObjectVersion`

Parameters:

id (String)

Returns:

(ObjectVersion)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 1235

def version(id)
  ObjectVersion.new(
    bucket_name: @bucket_name,
    object_key: @key,
    id: id,
    client: @client
  )
end

#wait_until(options = {}) {|resource| ... } ⇒ `Resource`

Deprecated.

Use [Aws::S3::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged.

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) do |instance|
  instance.state.name == 'running'
end

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

options (Hash) (defaults to: {}) —
a customizable set of options

Options Hash (options):

:max_attempts (Integer) — default: 10 —
Maximum number of
:delay (Integer) — default: 10 —
Delay between each
:before_attempt (Proc) — default: nil —
Callback
:before_wait (Proc) — default: nil —
Callback

Yield Parameters:

resource (Resource) —
to be used in the waiting condition.

Returns:

(Resource) —
if the waiter was successful

Raises:

(Aws::Waiters::Errors::FailureStateError) —
Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

yet successful.
(Aws::Waiters::Errors::UnexpectedError) —
Raised when an error is encountered while polling for a resource that is not expected.
(NotImplementedError) —
Raised when the resource does not

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 254

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end

#wait_until_exists(options = {}, &block) ⇒ `ObjectSummary`

Parameters:

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

Options Hash (options):

:max_attempts (Integer) — default: 20
:delay (Float) — default: 5
:before_attempt (Proc)
:before_wait (Proc)

Returns:

(ObjectSummary)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 142

def wait_until_exists(options = {}, &block)
  options, params = separate_params_and_options(options)
  waiter = Waiters::ObjectExists.new(options)
  yield_waiter_and_warn(waiter, &block) if block_given?
  waiter.wait(params.merge(bucket: @bucket_name,
    key: @key))
  ObjectSummary.new({
    bucket_name: @bucket_name,
    key: @key,
    client: @client
  })
end

#wait_until_not_exists(options = {}, &block) ⇒ `ObjectSummary`

Parameters:

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

Options Hash (options):

:max_attempts (Integer) — default: 20
:delay (Float) — default: 5
:before_attempt (Proc)
:before_wait (Proc)

Returns:

(ObjectSummary)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb', line 161

def wait_until_not_exists(options = {}, &block)
  options, params = separate_params_and_options(options)
  waiter = Waiters::ObjectNotExists.new(options)
  yield_waiter_and_warn(waiter, &block) if block_given?
  waiter.wait(params.merge(bucket: @bucket_name,
    key: @key))
  ObjectSummary.new({
    bucket_name: @bucket_name,
    key: @key,
    client: @client
  })
end

Class: Aws::S3::ObjectSummary

Defined Under Namespace

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_name, key, options = {}) ⇒ ObjectSummary #initialize(options = {}) ⇒ ObjectSummary

Instance Method Details

#acl ⇒ ObjectAcl

#bucket ⇒ Bucket

#bucket_name ⇒ String

#client ⇒ Client

#copy_from(source, options = {}) ⇒ Object

#copy_to(target, options = {}) ⇒ Object

#data ⇒ Types::Object

#data_loaded? ⇒ Boolean

#delete(options = {}) ⇒ Types::DeleteObjectOutput

#download_file(destination, options = {}) ⇒ Boolean

#etag ⇒ String

#exists?(options = {}) ⇒ Boolean

#get(options = {}, &block) ⇒ Types::GetObjectOutput

#initiate_multipart_upload(options = {}) ⇒ MultipartUpload

#key ⇒ String

#last_modified ⇒ Time

#move_to(target, options = {}) ⇒ void

#multipart_upload(id) ⇒ MultipartUpload

#object ⇒ Object

#owner ⇒ Types::Owner

#presigned_post(options = {}) ⇒ PresignedPost

#presigned_url(http_method, params = {}) ⇒ String

#public_url(options = {}) ⇒ String

#put(options = {}) ⇒ Types::PutObjectOutput

#restore_object(options = {}) ⇒ Types::RestoreObjectOutput

#size ⇒ Integer Also known as: content_length

#storage_class ⇒ String

#upload_file(source, options = {}) ⇒ Boolean

#upload_stream(options = {}, &block) ⇒ Boolean

#version(id) ⇒ ObjectVersion

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Basic Usage

Example

Configuration

Callbacks

Handling Errors

#wait_until_exists(options = {}, &block) ⇒ ObjectSummary

#wait_until_not_exists(options = {}, &block) ⇒ ObjectSummary

#initialize(bucket_name, key, options = {}) ⇒ `ObjectSummary` #initialize(options = {}) ⇒ `ObjectSummary`

#acl ⇒ `ObjectAcl`

#bucket ⇒ `Bucket`

#bucket_name ⇒ `String`

#client ⇒ `Client`

#copy_from(source, options = {}) ⇒ `Object`

#copy_to(target, options = {}) ⇒ `Object`

#data ⇒ `Types::Object`

#data_loaded? ⇒ `Boolean`

#delete(options = {}) ⇒ `Types::DeleteObjectOutput`

#download_file(destination, options = {}) ⇒ `Boolean`

#etag ⇒ `String`

#exists?(options = {}) ⇒ `Boolean`

#get(options = {}, &block) ⇒ `Types::GetObjectOutput`

#initiate_multipart_upload(options = {}) ⇒ `MultipartUpload`

#key ⇒ `String`

#last_modified ⇒ `Time`

#move_to(target, options = {}) ⇒ `void`

#multipart_upload(id) ⇒ `MultipartUpload`

#object ⇒ `Object`

#owner ⇒ `Types::Owner`

#presigned_post(options = {}) ⇒ `PresignedPost`

#presigned_url(http_method, params = {}) ⇒ `String`

#public_url(options = {}) ⇒ `String`

#put(options = {}) ⇒ `Types::PutObjectOutput`

#restore_object(options = {}) ⇒ `Types::RestoreObjectOutput`

#size ⇒ `Integer` Also known as: content_length

#storage_class ⇒ `String`

#upload_file(source, options = {}) ⇒ `Boolean`

#upload_stream(options = {}, &block) ⇒ `Boolean`

#version(id) ⇒ `ObjectVersion`

#wait_until(options = {}) {|resource| ... } ⇒ `Resource`

#wait_until_exists(options = {}, &block) ⇒ `ObjectSummary`

#wait_until_not_exists(options = {}, &block) ⇒ `ObjectSummary`