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_name ⇒ String

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

#client ⇒ Client

Returns:



71
72
73
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_acl.rb', line 71

def client
  @client
end

#data ⇒ Types::GetObjectAclOutput

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

Returns:



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

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.



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

def data_loaded?
  !!@data
end

#grants ⇒ Array<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

#load ⇒ self 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) 


81
82
83
84
85
86
87
88
89
90
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_acl.rb', line 81

def load
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.get_object_acl(
    bucket: @bucket_name,
    key: @object_key
  )
  end
  @data = resp.data
  self
end

#object ⇒ Object

Returns:



344
345
346
347
348
349
350
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_acl.rb', line 344

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

#object_key ⇒ String

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

#owner ⇒ Types::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",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  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.>

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

  • :checksum_algorithm (String) —

    Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • :grant_full_control (String) —

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

    This functionality is not supported for Amazon S3 on Outposts.

  • :grant_read (String) —

    Allows grantee to list the objects in the bucket.

    This functionality is not supported for Amazon S3 on Outposts.

  • :grant_read_acp (String) —

    Allows grantee to read the bucket ACL.

    This functionality is not supported for Amazon S3 on Outposts.

  • :grant_write (String) —

    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.

  • :grant_write_acp (String) —

    Allows grantee to write the ACL for the applicable bucket.

    This functionality is not supported for Amazon S3 on Outposts.

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

  • :version_id (String) —

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

    This functionality is not supported for directory buckets.

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



330
331
332
333
334
335
336
337
338
339
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_acl.rb', line 330

def put(options = {})
  options = options.merge(
    bucket: @bucket_name,
    key: @object_key
  )
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.put_object_acl(options)
  end
  resp.data
end

#request_charged ⇒ String

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

This functionality is not supported for directory buckets.

Returns:

  • (String) 


64
65
66
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_acl.rb', line 64

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/object_acl.rb', line 188

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.feature('resource') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end