Class: Aws::S3::ObjectVersion

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-s3/object_version.rb,
lib/aws-sdk-s3/customizations/object_version.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_name, object_key, id, options = {}) ⇒ ObjectVersion #initialize(options = {}) ⇒ ObjectVersion

Returns a new instance of ObjectVersion.

Overloads:

  • #initialize(bucket_name, object_key, id, options = {}) ⇒ ObjectVersion

    Parameters:

    • bucket_name (String)
    • object_key (String)
    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ ObjectVersion

    Options Hash (options):

    • :bucket_name (required, String)
    • :object_key (required, String)
    • :id (required, String)
    • :client (Client) 


26
27
28
29
30
31
32
33
34
 
# File 'lib/aws-sdk-s3/object_version.rb', line 26

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @bucket_name = extract_bucket_name(args, options)
  @object_key = extract_object_key(args, options)
  @id = extract_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#bucket_name ⇒ String

Returns:

  • (String) 


39
40
41
 
# File 'lib/aws-sdk-s3/object_version.rb', line 39

def bucket_name
  @bucket_name
end

#checksum_algorithm ⇒ Array<String>

The algorithm that was used to create a checksum of the object.

Returns:

  • (Array<String>) 


61
62
63
 
# File 'lib/aws-sdk-s3/object_version.rb', line 61

def checksum_algorithm
  data[:checksum_algorithm]
end

#client ⇒ Client

Returns:



125
126
127
 
# File 'lib/aws-sdk-s3/object_version.rb', line 125

def client
  @client
end

#data ⇒ Types::ObjectVersion

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

Returns:

Raises:

  • (NotImplementedError) —

    Raises when #data_loaded? is ‘false`.



140
141
142
143
 
# File 'lib/aws-sdk-s3/object_version.rb', line 140

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.



148
149
150
 
# File 'lib/aws-sdk-s3/object_version.rb', line 148

def data_loaded?
  !!@data
end

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

Examples:

Request syntax with placeholder values


object_version.delete({
  mfa: "MFA",
  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.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

  • :bypass_governance_retention (Boolean) —

    Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the ‘s3:BypassGovernanceRetention` permission.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:



300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/aws-sdk-s3/object_version.rb', line 300

def delete(options = {})
  options = options.merge(
    bucket: @bucket_name,
    key: @object_key,
    version_id: @id
  )
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_object(options)
  end
  resp.data
end

#etag ⇒ String

The entity tag is an MD5 hash of that version of the object.

Returns:

  • (String) 


55
56
57
 
# File 'lib/aws-sdk-s3/object_version.rb', line 55

def etag
  data[:etag]
end

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

Examples:

Request syntax with placeholder values


object_version.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,
  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",
  checksum_mode: "ENABLED", # accepts ENABLED
})

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 in this header; otherwise, return a ‘412 Precondition Failed` error.

    If both of the ‘If-Match` and `If-Unmodified-Since` headers are present in the request as follows: `If-Match` condition evaluates to `true`, and; `If-Unmodified-Since` condition evaluates to `false`; then, S3 returns `200 OK` and the data requested.

    For more information about conditional requests, see [RFC 7232].

    [1]: tools.ietf.org/html/rfc7232

  • :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` error.

    If both of the ‘If-None-Match` and `If-Modified-Since` headers are present in the request as follows:` If-None-Match` condition evaluates to `false`, and; `If-Modified-Since` condition evaluates to `true`; then, S3 returns `304 Not Modified` status code.

    For more information about conditional requests, see [RFC 7232].

    [1]: tools.ietf.org/html/rfc7232

  • :if_none_match (String) —

    Return the object only if its entity tag (ETag) is different from the one specified in this header; otherwise, return a ‘304 Not Modified` error.

    If both of the ‘If-None-Match` and `If-Modified-Since` headers are present in the request as follows:` If-None-Match` condition evaluates to `false`, and; `If-Modified-Since` condition evaluates to `true`; then, S3 returns `304 Not Modified` HTTP status code.

    For more information about conditional requests, see [RFC 7232].

    [1]: tools.ietf.org/html/rfc7232

  • :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` error.

    If both of the ‘If-Match` and `If-Unmodified-Since` headers are present in the request as follows: `If-Match` condition evaluates to `true`, and; `If-Unmodified-Since` condition evaluates to `false`; then, S3 returns `200 OK` and the data requested.

    For more information about conditional requests, see [RFC 7232].

    [1]: tools.ietf.org/html/rfc7232

  • :range (String) —

    Downloads the specified byte range of an object. For more information about the HTTP Range header, see [www.rfc-editor.org/rfc/rfc9110.html#name-range][1].

    <note markdown=“1”> Amazon S3 doesn’t support retrieving multiple ranges of data per ‘GET` request.

    </note>

    [1]: www.rfc-editor.org/rfc/rfc9110.html#name-range

  • :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.

  • :sse_customer_algorithm (String) —

    Specifies the algorithm to use when decrypting the object (for example, ‘AES256`).

    If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

    • ‘x-amz-server-side-encryption-customer-algorithm`

    • ‘x-amz-server-side-encryption-customer-key`

    • ‘x-amz-server-side-encryption-customer-key-MD5`

    For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

  • :sse_customer_key (String) —

    Specifies the customer-provided encryption key that you originally provided for Amazon S3 to encrypt the data before storing it. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the ‘x-amz-server-side-encryption-customer-algorithm` header.

    If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

    • ‘x-amz-server-side-encryption-customer-algorithm`

    • ‘x-amz-server-side-encryption-customer-key`

    • ‘x-amz-server-side-encryption-customer-key-MD5`

    For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

  • :sse_customer_key_md5 (String) —

    Specifies the 128-bit MD5 digest of the customer-provided 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.

    If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

    • ‘x-amz-server-side-encryption-customer-algorithm`

    • ‘x-amz-server-side-encryption-customer-key`

    • ‘x-amz-server-side-encryption-customer-key-MD5`

    For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

  • :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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

  • :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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

  • :checksum_mode (String) —

    To retrieve the checksum, this mode must be enabled.

    **General purpose buckets** - In addition, if you enable checksum mode and the object is uploaded with a [checksum] and encrypted with an Key Management Service (KMS) key, you must have permission to use the ‘kms:Decrypt` action to retrieve the checksum.

    [1]: docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html

Returns:



536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/aws-sdk-s3/object_version.rb', line 536

def get(options = {}, &block)
  options = options.merge(
    bucket: @bucket_name,
    key: @object_key,
    version_id: @id
  )
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.get_object(options, &block)
  end
  resp.data
end

#head(options = {}) ⇒ Types::HeadObjectOutput

Examples:

Request syntax with placeholder values


object_version.head({
  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,
  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",
  checksum_mode: "ENABLED", # accepts ENABLED
})

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) error.

    If both of the ‘If-Match` and `If-Unmodified-Since` headers are present in the request as follows:

    • ‘If-Match` condition evaluates to `true`, and;

    • ‘If-Unmodified-Since` condition evaluates to `false`;

    Then Amazon S3 returns ‘200 OK` and the data requested.

    For more information about conditional requests, see [RFC 7232].

    [1]: tools.ietf.org/html/rfc7232

  • :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) error.

    If both of the ‘If-None-Match` and `If-Modified-Since` headers are present in the request as follows:

    • ‘If-None-Match` condition evaluates to `false`, and;

    • ‘If-Modified-Since` condition evaluates to `true`;

    Then Amazon S3 returns the ‘304 Not Modified` response code.

    For more information about conditional requests, see [RFC 7232].

    [1]: tools.ietf.org/html/rfc7232

  • :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) error.

    If both of the ‘If-None-Match` and `If-Modified-Since` headers are present in the request as follows:

    • ‘If-None-Match` condition evaluates to `false`, and;

    • ‘If-Modified-Since` condition evaluates to `true`;

    Then Amazon S3 returns the ‘304 Not Modified` response code.

    For more information about conditional requests, see [RFC 7232].

    [1]: tools.ietf.org/html/rfc7232

  • :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) error.

    If both of the ‘If-Match` and `If-Unmodified-Since` headers are present in the request as follows:

    • ‘If-Match` condition evaluates to `true`, and;

    • ‘If-Unmodified-Since` condition evaluates to `false`;

    Then Amazon S3 returns ‘200 OK` and the data requested.

    For more information about conditional requests, see [RFC 7232].

    [1]: tools.ietf.org/html/rfc7232

  • :range (String) —

    HeadObject returns only the metadata for an object. If the Range is satisfiable, only the ‘ContentLength` is affected in the response. If the Range is not satisfiable, S3 returns a `416 - Requested Range Not Satisfiable` error.

  • :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.

  • :sse_customer_algorithm (String) —

    Specifies the algorithm to use when encrypting the object (for example, AES256).

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :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.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :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.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

  • :part_number (Integer) —

    Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a ‘ranged’ HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

  • :checksum_mode (String) —

    To retrieve the checksum, this parameter must be enabled.

    **General purpose buckets** - If you enable checksum mode and the object is uploaded with a [checksum] and encrypted with an Key Management Service (KMS) key, you must have permission to use the ‘kms:Decrypt` action to retrieve the checksum.

    **Directory buckets** - If you enable ‘ChecksumMode` and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the `kms:GenerateDataKey` and `kms:Decrypt` permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.

    [1]: docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html

Returns:



728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/aws-sdk-s3/object_version.rb', line 728

def head(options = {})
  options = options.merge(
    bucket: @bucket_name,
    key: @object_key,
    version_id: @id
  )
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.head_object(options)
  end
  resp.data
end

#id ⇒ String

Returns:

  • (String) 


49
50
51
 
# File 'lib/aws-sdk-s3/object_version.rb', line 49

def id
  @id
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


753
754
755
756
757
758
759
 
# File 'lib/aws-sdk-s3/object_version.rb', line 753

def identifiers
  {
    bucket_name: @bucket_name,
    object_key: @object_key,
    id: @id
  }
end

#is_latest ⇒ Boolean

Specifies whether the object is (true) or is not (false) the latest version of an object.

Returns:

  • (Boolean) 


92
93
94
 
# File 'lib/aws-sdk-s3/object_version.rb', line 92

def is_latest
  data[:is_latest]
end

#key ⇒ String

The object key.

Returns:

  • (String) 


79
80
81
 
# File 'lib/aws-sdk-s3/object_version.rb', line 79

def key
  data[:key]
end

#last_modified ⇒ Time

Date and time when the object was last modified.

Returns:

  • (Time) 


98
99
100
 
# File 'lib/aws-sdk-s3/object_version.rb', line 98

def last_modified
  data[:last_modified]
end

#load ⇒ Object Also known as: reload

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raises:

  • (NotImplementedError) 


131
132
133
134
 
# File 'lib/aws-sdk-s3/object_version.rb', line 131

def load
  msg = "#load is not implemented, data only available via enumeration"
  raise NotImplementedError, msg
end

#object ⇒ Object

Returns:



743
744
745
746
747
748
749
 
# File 'lib/aws-sdk-s3/object_version.rb', line 743

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

#object_key ⇒ String

Returns:

  • (String) 


44
45
46
 
# File 'lib/aws-sdk-s3/object_version.rb', line 44

def object_key
  @object_key
end

#owner ⇒ Types::Owner

Specifies the owner of the object.

Returns:



104
105
106
 
# File 'lib/aws-sdk-s3/object_version.rb', line 104

def owner
  data[:owner]
end

#restore_status ⇒ Types::RestoreStatus

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see [ Working with archived objects] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html

Returns:



118
119
120
 
# File 'lib/aws-sdk-s3/object_version.rb', line 118

def restore_status
  data[:restore_status]
end

#size ⇒ Integer

Size in bytes of the object.

Returns:

  • (Integer) 


67
68
69
 
# File 'lib/aws-sdk-s3/object_version.rb', line 67

def size
  data[:size]
end

#storage_class ⇒ String

The class of storage used to store the object.

Returns:

  • (String) 


73
74
75
 
# File 'lib/aws-sdk-s3/object_version.rb', line 73

def storage_class
  data[:storage_class]
end

#version_id ⇒ String

Version ID of an object.

Returns:

  • (String) 


85
86
87
 
# File 'lib/aws-sdk-s3/object_version.rb', line 85

def version_id
  data[:version_id]
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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/aws-sdk-s3/object_version.rb', line 232

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::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end