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

Inherits:
Struct
  • Object
show all
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:

Instance Attribute Summary collapse

Instance Attribute Details

#access_control_policy ⇒ Types::AccessControlPolicy

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

Returns:



9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
 
# File 'lib/aws-sdk-s3/types.rb', line 9569

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. For more information, see [Canned ACL].

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

Returns:

  • (String) 


9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
 
# File 'lib/aws-sdk-s3/types.rb', line 9569

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

The bucket name that contains the object to which you want to attach the ACL.

When using this API with an access point, 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 operation using an access point through the AWS 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 Simple Storage Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html

Returns:

  • (String) 


9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
 
# File 'lib/aws-sdk-s3/types.rb', line 9569

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

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]: www.ietf.org/rfc/rfc1864.txt

Returns:

  • (String) 


9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
 
# File 'lib/aws-sdk-s3/types.rb', line 9569

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) 


9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
 
# File 'lib/aws-sdk-s3/types.rb', line 9569

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) 


9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
 
# File 'lib/aws-sdk-s3/types.rb', line 9569

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) 


9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
 
# File 'lib/aws-sdk-s3/types.rb', line 9569

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) 


9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
 
# File 'lib/aws-sdk-s3/types.rb', line 9569

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) 


9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
 
# File 'lib/aws-sdk-s3/types.rb', line 9569

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

Key for which the PUT operation was initiated.

Returns:

  • (String) 


9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
 
# File 'lib/aws-sdk-s3/types.rb', line 9569

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

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

Returns:

  • (String) 


9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
 
# File 'lib/aws-sdk-s3/types.rb', line 9569

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) 


9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
 
# File 'lib/aws-sdk-s3/types.rb', line 9569

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