Class: Aws::S3::Types::PutObjectAclRequest

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::PutObjectAclRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass PutObjectAclRequest data as a hash:

{
  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",
    },
  },
  bucket: "BucketName", # required
  content_md5: "ContentMD5",
  grant_full_control: "GrantFullControl",
  grant_read: "GrantRead",
  grant_read_acp: "GrantReadACP",
  grant_write: "GrantWrite",
  grant_write_acp: "GrantWriteACP",
  key: "ObjectKey", # required
  request_payer: "requester", # accepts requester
  version_id: "ObjectVersionId",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #access_control_policy ⇒ Types::AccessControlPolicy
• #acl ⇒ String

  The canned ACL to apply to the object.

• #bucket ⇒ String
• #content_md5 ⇒ String
• #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.

• #key ⇒ String
• #request_payer ⇒ String

  Confirms that the requester knows that she or he will be charged for the request.

• #version_id ⇒ String

  VersionId used to reference a specific version of the object.

Instance Attribute Details

#access_control_policy ⇒ Types::AccessControlPolicy

Returns:

• (Types::AccessControlPolicy)

# File 'lib/aws-sdk-s3/types.rb', line 7448

class PutObjectAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :key,
  :request_payer,
  :version_id)
  include Aws::Structure
end

#acl ⇒ String

The canned ACL to apply to the object.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 7448

class PutObjectAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :key,
  :request_payer,
  :version_id)
  include Aws::Structure
end

#bucket ⇒ String

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 7448

class PutObjectAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :key,
  :request_payer,
  :version_id)
  include Aws::Structure
end

#content_md5 ⇒ String

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 7448

class PutObjectAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :key,
  :request_payer,
  :version_id)
  include Aws::Structure
end

#grant_full_control ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 7448

class PutObjectAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :key,
  :request_payer,
  :version_id)
  include Aws::Structure
end

#grant_read ⇒ String

Allows grantee to list the objects in the bucket.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 7448

class PutObjectAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :key,
  :request_payer,
  :version_id)
  include Aws::Structure
end

#grant_read_acp ⇒ String

Allows grantee to read the bucket ACL.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 7448

class PutObjectAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :key,
  :request_payer,
  :version_id)
  include Aws::Structure
end

#grant_write ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 7448

class PutObjectAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :key,
  :request_payer,
  :version_id)
  include Aws::Structure
end

#grant_write_acp ⇒ String

Allows grantee to write the ACL for the applicable bucket.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 7448

class PutObjectAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :key,
  :request_payer,
  :version_id)
  include Aws::Structure
end

#key ⇒ String

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 7448

class PutObjectAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :key,
  :request_payer,
  :version_id)
  include Aws::Structure
end

#request_payer ⇒ String

Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 7448

class PutObjectAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :key,
  :request_payer,
  :version_id)
  include Aws::Structure
end

#version_id ⇒ String

VersionId used to reference a specific version of the object.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 7448

class PutObjectAclRequest < Struct.new(
  :acl,
  :access_control_policy,
  :bucket,
  :content_md5,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :key,
  :request_payer,
  :version_id)
  include Aws::Structure
end