You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutObjectAclRequest as input to an Aws::Client method, you can use a vanilla 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",
  expected_bucket_owner: "AccountId",
  use_accelerate_endpoint: false,
}

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:

#acl ⇒ String

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

Returns:

  • (String) —

    The canned ACL to apply to the object.

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

Returns:

  • (String) —

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

#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 AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

Returns:

  • (String) —

    The base64-encoded 128-bit MD5 digest of the data.

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

  • (String) —

    The account id of the expected bucket owner.

#grant_full_control ⇒ String

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

This action is not supported by Amazon S3 on Outposts.

Returns:

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

This action is not supported by Amazon S3 on Outposts.

Returns:

  • (String) —

    Allows grantee to list the objects in the bucket.

#grant_read_acp ⇒ String

Allows grantee to read the bucket ACL.

This action is not supported by Amazon S3 on Outposts.

Returns:

  • (String) —

    Allows grantee to read the bucket ACL.

#grant_write ⇒ String

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

Returns:

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

This action is not supported by Amazon S3 on Outposts.

Returns:

  • (String) —

    Allows grantee to write the ACL for the applicable bucket.

#key ⇒ String

Key for which the PUT operation was initiated.

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

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Returns:

  • (String) —

    Key for which the PUT operation was initiated.

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

Possible values:

  • requester

Returns:

  • (String) —

    Confirms that the requester knows that they will be charged for the request.

#use_accelerate_endpoint ⇒ Boolean

When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.

Returns:

#version_id ⇒ String

VersionId used to reference a specific version of the object.

Returns:

  • (String) —

    VersionId used to reference a specific version of the object.