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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

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

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

Constant Summary collapse

SENSITIVE =
[]

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

Returns:

  • (String)


4811
4812
4813
4814
4815
4816
4817
4818
4819
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4811

class GetObjectAclRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

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


4811
4812
4813
4814
4815
4816
4817
4818
4819
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4811

class GetObjectAclRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#keyString

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

Returns:

  • (String)


4811
4812
4813
4814
4815
4816
4817
4818
4819
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4811

class GetObjectAclRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String)


4811
4812
4813
4814
4815
4816
4817
4818
4819
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4811

class GetObjectAclRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#version_idString

VersionId used to reference a specific version of the object.

Returns:

  • (String)


4811
4812
4813
4814
4815
4816
4817
4818
4819
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4811

class GetObjectAclRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end