Class: Aws::S3::Types::GetObjectAttributesRequest

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::GetObjectAttributesRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

Note:

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

{
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  version_id: "ObjectVersionId",
  max_parts: 1,
  part_number_marker: 1,
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  request_payer: "requester", # accepts requester
  expected_bucket_owner: "AccountId",
  object_attributes: ["ETag"], # required, accepts ETag, Checksum, ObjectParts, StorageClass, ObjectSize
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:sse_customer_key]

Instance Attribute Summary

• #bucket ⇒ String

  The name of the bucket that contains the object.

• #expected_bucket_owner ⇒ String

  The account ID of the expected bucket owner.

• #key ⇒ String

  The object key.

• #max_parts ⇒ Integer

  Sets the maximum number of parts to return.

• #object_attributes ⇒ Array<String>

  An XML header that specifies the fields at the root level that you want returned in the response.

• #part_number_marker ⇒ Integer

  Specifies the part after which listing should begin.

• #request_payer ⇒ String

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

• #sse_customer_algorithm ⇒ String

  Specifies the algorithm to use when encrypting the object (for example, AES256).

• #sse_customer_key ⇒ String

  Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.

• #sse_customer_key_md5 ⇒ String

  Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.

• #version_id ⇒ String

  The version ID used to reference a specific version of the object.

Instance Attribute Details

#bucket ⇒ String

The name of the bucket that contains the object.

When using this action 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 action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see

Using access points][1

in the *Amazon S3 User Guide*.

When using this action 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 action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see

Using Amazon S3 on Outposts][2

in the *Amazon S3 User Guide*.

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

Returns:

• (String)

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

class GetObjectAttributesRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :max_parts,
  :part_number_marker,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :expected_bucket_owner,
  :object_attributes)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

• (String)

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

class GetObjectAttributesRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :max_parts,
  :part_number_marker,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :expected_bucket_owner,
  :object_attributes)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#key ⇒ String

The object key.

Returns:

• (String)

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

class GetObjectAttributesRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :max_parts,
  :part_number_marker,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :expected_bucket_owner,
  :object_attributes)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#max_parts ⇒ Integer

Sets the maximum number of parts to return.

Returns:

• (Integer)

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

class GetObjectAttributesRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :max_parts,
  :part_number_marker,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :expected_bucket_owner,
  :object_attributes)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#object_attributes ⇒ Array<String>

An XML header that specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

Returns:

• (Array<String>)

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

class GetObjectAttributesRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :max_parts,
  :part_number_marker,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :expected_bucket_owner,
  :object_attributes)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#part_number_marker ⇒ Integer

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

Returns:

• (Integer)

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

class GetObjectAttributesRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :max_parts,
  :part_number_marker,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :expected_bucket_owner,
  :object_attributes)
  SENSITIVE = [:sse_customer_key]
  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 Requester Pays Buckets] in the *Amazon S3 User Guide*.

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

Returns:

• (String)

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

class GetObjectAttributesRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :max_parts,
  :part_number_marker,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :expected_bucket_owner,
  :object_attributes)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#sse_customer_algorithm ⇒ String

Specifies the algorithm to use when encrypting the object (for example, AES256).

Returns:

• (String)

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

class GetObjectAttributesRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :max_parts,
  :part_number_marker,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :expected_bucket_owner,
  :object_attributes)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#sse_customer_key ⇒ String

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the ‘x-amz-server-side-encryption-customer-algorithm` header.

Returns:

• (String)

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

class GetObjectAttributesRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :max_parts,
  :part_number_marker,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :expected_bucket_owner,
  :object_attributes)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#sse_customer_key_md5 ⇒ String

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Returns:

• (String)

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

class GetObjectAttributesRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :max_parts,
  :part_number_marker,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :expected_bucket_owner,
  :object_attributes)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#version_id ⇒ String

The version ID used to reference a specific version of the object.

Returns:

• (String)

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

class GetObjectAttributesRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :max_parts,
  :part_number_marker,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :expected_bucket_owner,
  :object_attributes)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end