class Aws::S3::ObjectAcl

Public Class Methods

new(*args) click to toggle source

@overload def initialize(bucket_name, object_key, options = {})

@param [String] bucket_name
@param [String] object_key
@option options [Client] :client

@overload def initialize(options = {})

@option options [required, String] :bucket_name
@option options [required, String] :object_key
@option options [Client] :client
# File lib/aws-sdk-s3/object_acl.rb, line 24
def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @bucket_name = extract_bucket_name(args, options)
  @object_key = extract_object_key(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Public Instance Methods

bucket_name() click to toggle source

@return [String]

# File lib/aws-sdk-s3/object_acl.rb, line 36
def bucket_name
  @bucket_name
end
client() click to toggle source

@return [Client]

# File lib/aws-sdk-s3/object_acl.rb, line 67
def client
  @client
end
data() click to toggle source

@return [Types::GetObjectAclOutput]

Returns the data for this {ObjectAcl}. Calls
{Client#get_object_acl} if {#data_loaded?} is `false`.
# File lib/aws-sdk-s3/object_acl.rb, line 90
def data
  load unless @data
  @data
end
data_loaded?() click to toggle source

@return [Boolean]

Returns `true` if this resource is loaded.  Accessing attributes or
{#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-s3/object_acl.rb, line 98
def data_loaded?
  !!@data
end
grants() click to toggle source

A list of grants. @return [Array<Types::Grant>]

# File lib/aws-sdk-s3/object_acl.rb, line 53
def grants
  data[:grants]
end
identifiers() click to toggle source

@deprecated @api private

# File lib/aws-sdk-s3/object_acl.rb, line 318
def identifiers
  {
    bucket_name: @bucket_name,
    object_key: @object_key
  }
end
load() click to toggle source

Loads, or reloads {#data} for the current {ObjectAcl}. Returns `self` making it possible to chain methods.

object_acl.reload.data

@return [self]

# File lib/aws-sdk-s3/object_acl.rb, line 77
def load
  resp = @client.get_object_acl(
    bucket: @bucket_name,
    key: @object_key
  )
  @data = resp.data
  self
end
Also aliased as: reload
object() click to toggle source

@return [Object]

# File lib/aws-sdk-s3/object_acl.rb, line 308
def object
  Object.new(
    bucket_name: @bucket_name,
    key: @object_key,
    client: @client
  )
end
object_key() click to toggle source

@return [String]

# File lib/aws-sdk-s3/object_acl.rb, line 41
def object_key
  @object_key
end
owner() click to toggle source

Container for the bucket owner's display name and ID. @return [Types::Owner]

# File lib/aws-sdk-s3/object_acl.rb, line 47
def owner
  data[:owner]
end
put(options = {}) click to toggle source

@example Request syntax with placeholder values

object_acl.put({
  acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
  access_control_policy: {
    grants: [
      {
        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
      },
    ],
    owner: {
      display_name: "DisplayName",
      id: "ID",
    },
  },
  content_md5: "ContentMD5",
  grant_full_control: "GrantFullControl",
  grant_read: "GrantRead",
  grant_read_acp: "GrantReadACP",
  grant_write: "GrantWrite",
  grant_write_acp: "GrantWriteACP",
  request_payer: "requester", # accepts requester
  version_id: "ObjectVersionId",
  expected_bucket_owner: "AccountId",
})

@param [Hash] options ({}) @option options [String] :acl

The canned ACL to apply to the object. For more information, see
[Canned ACL][1].

[1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL

@option options [Types::AccessControlPolicy] :access_control_policy

Contains the elements that set the ACL permissions for an object per
grantee.

@option options [String] :content_md5

The base64-encoded 128-bit MD5 digest of the data. This header must be
used as a message integrity check to verify that the request body was
not corrupted in transit. For more information, go to [RFC
1864.&gt;][1]

For requests made using the Amazon Web Services Command Line Interface
(CLI) or Amazon Web Services SDKs, this field is calculated
automatically.

[1]: http://www.ietf.org/rfc/rfc1864.txt

@option options [String] :grant_full_control

Allows grantee the read, write, read ACP, and write ACP permissions on
the bucket.

This action is not supported by Amazon S3 on Outposts.

@option options [String] :grant_read

Allows grantee to list the objects in the bucket.

This action is not supported by Amazon S3 on Outposts.

@option options [String] :grant_read_acp

Allows grantee to read the bucket ACL.

This action is not supported by Amazon S3 on Outposts.

@option options [String] :grant_write

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows
deletions and overwrites of those objects.

@option options [String] :grant_write_acp

Allows grantee to write the ACL for the applicable bucket.

This action is not supported by Amazon S3 on Outposts.

@option options [String] :request_payer

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][1]
in the *Amazon S3 User Guide*.

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

@option options [String] :version_id

VersionId used to reference a specific version of the object.

@option options [String] :expected_bucket_owner

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.

@return [Types::PutObjectAclOutput]

# File lib/aws-sdk-s3/object_acl.rb, line 296
def put(options = {})
  options = options.merge(
    bucket: @bucket_name,
    key: @object_key
  )
  resp = @client.put_object_acl(options)
  resp.data
end
reload()
Alias for: load
request_charged() click to toggle source

If present, indicates that the requester was successfully charged for the request. @return [String]

# File lib/aws-sdk-s3/object_acl.rb, line 60
def request_charged
  data[:request_charged]
end
wait_until(options = {}, &block) click to toggle source

@deprecated Use [Aws::S3::Client] wait_until instead

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

@note The waiting operation is performed on a copy. The original resource

remains unchanged.

## 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

@yieldparam [Resource] resource to be used in the waiting condition.

@raise [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.

@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is

encountered while polling for a resource that is not expected.

@raise [NotImplementedError] Raised when the resource does not

@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful

# File lib/aws-sdk-s3/object_acl.rb, line 182
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

Private Instance Methods

extract_bucket_name(args, options) click to toggle source
# File lib/aws-sdk-s3/object_acl.rb, line 328
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
extract_object_key(args, options) click to toggle source
# File lib/aws-sdk-s3/object_acl.rb, line 339
def extract_object_key(args, options)
  value = args[1] || options.delete(:object_key)
  case value
  when String then value
  when nil then raise ArgumentError, "missing required option :object_key"
  else
    msg = "expected :object_key to be a String, got #{value.class}"
    raise ArgumentError, msg
  end
end