Class: Aws::S3::ObjectAcl

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/object_acl.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, options = {}) ⇒ ObjectAcl #initialize(options = {}) ⇒ ObjectAcl

Returns a new instance of ObjectAcl.

Overloads:

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

    Parameters:

    • bucket_name (String)
    • object_key (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ ObjectAcl

    Options Hash (options):

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


24
25
26
27
28
29
30
31
# File 'gems/aws-sdk-s3/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

Instance Method Details

#bucket_nameString

Returns:

  • (String)


36
37
38
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_acl.rb', line 36

def bucket_name
  @bucket_name
end

#clientClient

Returns:



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

def client
  @client
end

#dataTypes::GetObjectAclOutput

Returns the data for this Aws::S3::ObjectAcl. Calls Client#get_object_acl if #data_loaded? is false.

Returns:



90
91
92
93
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_acl.rb', line 90

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.



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

def data_loaded?
  !!@data
end

#grantsArray<Types::Grant>

A list of grants.

Returns:



53
54
55
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_acl.rb', line 53

def grants
  data[:grants]
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::S3::ObjectAcl. Returns self making it possible to chain methods.

object_acl.reload.data

Returns:

  • (self)


77
78
79
80
81
82
83
84
# File 'gems/aws-sdk-s3/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

#objectObject

Returns:



294
295
296
297
298
299
300
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_acl.rb', line 294

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

#object_keyString

Returns:

  • (String)


41
42
43
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_acl.rb', line 41

def object_key
  @object_key
end

#ownerTypes::Owner

Container for the bucket owner's display name and ID.

Returns:



47
48
49
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_acl.rb', line 47

def owner
  data[:owner]
end

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

Examples:

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

Parameters:

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

    ({})

Options Hash (options):

  • :acl (String)

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

  • :access_control_policy (Types::AccessControlPolicy)

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

  • :content_md5 (String)

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

  • :grant_full_control (String)

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

  • :grant_read (String)

    Allows grantee to list the objects in the bucket.

  • :grant_read_acp (String)

    Allows grantee to read the bucket ACL.

  • :grant_write (String)

    Allows grantee to create, overwrite, and delete any object in the bucket.

  • :grant_write_acp (String)

    Allows grantee to write the ACL for the applicable bucket.

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

  • :version_id (String)

    VersionId used to reference a specific version of the 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:



282
283
284
285
286
287
288
289
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_acl.rb', line 282

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

#request_chargedString

If present, indicates that the requester was successfully charged for the request.

Returns:

  • (String)


60
61
62
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_acl.rb', line 60

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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
# File 'gems/aws-sdk-s3/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