Class: Aws::S3::Waiters::ObjectExists

Inherits:

Object

• Object
• Aws::S3::Waiters::ObjectExists

Defined in:

gems/aws-sdk-s3/lib/aws-sdk-s3/waiters.rb

Instance Method Summary

• #initialize(options) ⇒ ObjectExists constructor

  A new instance of ObjectExists.

• #wait(params = {}) ⇒ Types::HeadObjectOutput

  Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ ObjectExists

Returns a new instance of ObjectExists.

Parameters:

• options (Hash)

Options Hash (options):

• :client (required, Client)
• :max_attempts (Integer) — default: 20
• :delay (Integer) — default: 5
• :before_attempt (Proc)
• :before_wait (Proc)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/waiters.rb', line 174

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 20,
    delay: 5,
    poller: Aws::Waiters::Poller.new(
      operation_name: :head_object,
      acceptors: [
        {
          "expected" => 200,
          "matcher" => "status",
          "state" => "success"
        },
        {
          "expected" => 404,
          "matcher" => "status",
          "state" => "retry"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

#wait(params = {}) ⇒ Types::HeadObjectOutput

Returns a response object which responds to the following methods:

• #delete_marker => Boolean
• #accept_ranges => String
• #expiration => String
• #restore => String
• #archive_status => String
• #last_modified => Time
• #content_length => Integer
• #checksum_crc32 => String
• #checksum_crc32c => String
• #checksum_sha1 => String
• #checksum_sha256 => String
• #etag => String
• #missing_meta => Integer
• #version_id => String
• #cache_control => String
• #content_disposition => String
• #content_encoding => String
• #content_language => String
• #content_type => String
• #expires => Time
• #expires_string => String
• #website_redirect_location => String
• #server_side_encryption => String
• #metadata => Hash<String,String>
• #sse_customer_algorithm => String
• #sse_customer_key_md5 => String
• #ssekms_key_id => String
• #bucket_key_enabled => Boolean
• #storage_class => String
• #request_charged => String
• #replication_status => String
• #parts_count => Integer
• #object_lock_mode => String
• #object_lock_retain_until_date => Time
• #object_lock_legal_hold_status => String

Parameters:

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

  a customizable set of options

Options Hash (params):

• :bucket (required, String) —

  The name of the bucket that contains the object.

  Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

  Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

  Access points and Object Lambda access points are not supported by directory buckets.

  S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

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

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

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

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

• :key (required, String) —

  The object key.

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

• :version_id (String) —

  Version ID used to reference a specific version of the object.

  For directory buckets in this API operation, only the null value of the version ID is supported.

• :sse_customer_algorithm (String) —

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

  This functionality is not supported for directory buckets.

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

  This functionality is not supported for directory buckets.

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

  This functionality is not supported for directory buckets.

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

  This functionality is not supported for directory buckets.

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

Returns:

• (Types::HeadObjectOutput) —

  Returns a response object which responds to the following methods:

  • #delete_marker => Boolean
  • #accept_ranges => String
  • #expiration => String
  • #restore => String
  • #archive_status => String
  • #last_modified => Time
  • #content_length => Integer
  • #checksum_crc32 => String
  • #checksum_crc32c => String
  • #checksum_sha1 => String
  • #checksum_sha256 => String
  • #etag => String
  • #missing_meta => Integer
  • #version_id => String
  • #cache_control => String
  • #content_disposition => String
  • #content_encoding => String
  • #content_language => String
  • #content_type => String
  • #expires => Time
  • #expires_string => String
  • #website_redirect_location => String
  • #server_side_encryption => String
  • #metadata => Hash<String,String>
  • #sse_customer_algorithm => String
  • #sse_customer_key_md5 => String
  • #ssekms_key_id => String
  • #bucket_key_enabled => Boolean
  • #storage_class => String
  • #request_charged => String
  • #replication_status => String
  • #parts_count => Integer
  • #object_lock_mode => String
  • #object_lock_retain_until_date => Time
  • #object_lock_legal_hold_status => String

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/waiters.rb', line 199

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end