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

Class: Aws::S3::Types::GetObjectAclRequest

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

Overview

Note:

When passing GetObjectAclRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  version_id: "ObjectVersionId",
  request_payer: "requester", # accepts requester
  expected_bucket_owner: "AccountId",
  use_accelerate_endpoint: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

The bucket name that contains the object for which to get the ACL information.

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 for which to get the ACL information.

#expected_bucket_ownerString

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.

#keyString

The key of the object for which to get the ACL information.

Returns:

  • (String)

    The key of the object for which to get the ACL information.

#request_payerString

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_endpointBoolean

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

Returns:

#version_idString

VersionId used to reference a specific version of the object.

Returns:

  • (String)

    VersionId used to reference a specific version of the object.