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

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>

  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.

**Directory buckets** - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format ‘ Bucket_name.s3express-az_id.region.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format ` bucket_base_name–az-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*.

**Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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][2

in the *Amazon S3 User Guide*.

<note markdown=“1”> Access points and Object Lambda access points are not supported by directory buckets.

</note>

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

What is S3 on Outposts?][3

in the *Amazon S3 User Guide*.

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

Returns:

• (String)

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

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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

• (String)

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

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 6911

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 6911

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>

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 6911

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 6911

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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

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

Returns:

• (String)

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

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

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

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

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.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

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

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.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

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

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.

<note markdown=“1”> S3 Versioning isn’t enabled and supported for directory buckets. For this API operation, only the ‘null` value of the version ID is supported by directory buckets. You can only specify `null` to the `versionId` query parameter in the request.

</note>

Returns:

• (String)

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

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