Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::get_object_attributes::builders::GetObjectAttributesFluentBuilder

pub struct GetObjectAttributesFluentBuilder { /* private fields */ }

Fluent builder constructing a request to GetObjectAttributes.

Retrieves all the metadata from an object without returning the object itself. This action is useful if you're interested only in an object's metadata. To use GetObjectAttributes, you must have READ access to the object.

GetObjectAttributes combines the functionality of HeadObject and ListParts. All of the data returned with each of those individual calls can be returned with a single call to GetObjectAttributes.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:

• x-amz-server-side-encryption-customer-algorithm

• x-amz-server-side-encryption-customer-key

• x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

• Encryption request headers, such as x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with Amazon Web Services KMS keys stored in Amazon Web Services Key Management Service (SSE-KMS) or server-side encryption with Amazon S3 managed keys (SSE-S3). If your object does use these types of keys, you'll get an HTTP 400 Bad Request error.

• The last modified property in this case is the creation date of the object.

Consider the following when using request headers:

• If both of the If-Match and If-Unmodified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 200 OK and the data requested:

  • If-Match condition evaluates to true.

  • If-Unmodified-Since condition evaluates to false.

• If both of the If-None-Match and If-Modified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 304 Not Modified:

  • If-None-Match condition evaluates to false.

  • If-Modified-Since condition evaluates to true.

For more information about conditional requests, see RFC 7232.

Permissions

The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is versioned, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes permissions for this operation. If the bucket is not versioned, you need the s3:GetObject and s3:GetObjectAttributes permissions. For more information, see Specifying Permissions in a Policy in the Amazon S3 User Guide. If the object that you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

• If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 Not Found ("no such key") error.

• If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden ("access denied") error.

The following actions are related to GetObjectAttributes:

• GetObject

• GetObjectAcl

• GetObjectLegalHold

• GetObjectLockConfiguration

• GetObjectRetention

• GetObjectTagging

• HeadObject

• ListParts

Implementations

impl GetObjectAttributesFluentBuilder

pub fn as_input(&self) -> &GetObjectAttributesInputBuilder

Access the GetObjectAttributes as a reference.

pub async fn send( self ) -> impl Future<Output = Result<GetObjectAttributesOutput, SdkError<GetObjectAttributesError, Response<SdkBody>>>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub async fn customize( self ) -> impl Future<Output = Result<CustomizableOperation<GetObjectAttributesOutput, GetObjectAttributesError, GetObjectAttributesFluentBuilder>, SdkError<GetObjectAttributesError, Response>>>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn bucket( self, input: impl Into<String> ) -> GetObjectAttributesFluentBuilder

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 in the Amazon S3 User Guide.

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? in the Amazon S3 User Guide.

pub fn set_bucket( self, input: Option<String> ) -> GetObjectAttributesFluentBuilder

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 in the Amazon S3 User Guide.

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? in the Amazon S3 User Guide.

pub fn get_bucket(&self) -> &Option<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 in the Amazon S3 User Guide.

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? in the Amazon S3 User Guide.

pub fn key(self, input: impl Into<String>) -> GetObjectAttributesFluentBuilder

The object key.

pub fn set_key(self, input: Option<String>) -> GetObjectAttributesFluentBuilder

The object key.

pub fn get_key(&self) -> &Option<String>

The object key.

pub fn version_id( self, input: impl Into<String> ) -> GetObjectAttributesFluentBuilder

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

pub fn set_version_id( self, input: Option<String> ) -> GetObjectAttributesFluentBuilder

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

pub fn get_version_id(&self) -> &Option<String>

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

pub fn max_parts(self, input: i32) -> GetObjectAttributesFluentBuilder

Sets the maximum number of parts to return.

pub fn set_max_parts( self, input: Option<i32> ) -> GetObjectAttributesFluentBuilder

Sets the maximum number of parts to return.

pub fn get_max_parts(&self) -> &Option<i32>

Sets the maximum number of parts to return.

pub fn part_number_marker( self, input: impl Into<String> ) -> GetObjectAttributesFluentBuilder

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

pub fn set_part_number_marker( self, input: Option<String> ) -> GetObjectAttributesFluentBuilder

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

pub fn get_part_number_marker(&self) -> &Option<String>

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

pub fn sse_customer_algorithm( self, input: impl Into<String> ) -> GetObjectAttributesFluentBuilder

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

pub fn set_sse_customer_algorithm( self, input: Option<String> ) -> GetObjectAttributesFluentBuilder

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

pub fn get_sse_customer_algorithm(&self) -> &Option<String>

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

pub fn sse_customer_key( self, input: impl Into<String> ) -> GetObjectAttributesFluentBuilder

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.

pub fn set_sse_customer_key( self, input: Option<String> ) -> GetObjectAttributesFluentBuilder

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.

pub fn get_sse_customer_key(&self) -> &Option<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.

pub fn sse_customer_key_md5( self, input: impl Into<String> ) -> GetObjectAttributesFluentBuilder

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.

pub fn set_sse_customer_key_md5( self, input: Option<String> ) -> GetObjectAttributesFluentBuilder

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.

pub fn get_sse_customer_key_md5(&self) -> &Option<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.

pub fn request_payer( self, input: RequestPayer ) -> GetObjectAttributesFluentBuilder

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

pub fn set_request_payer( self, input: Option<RequestPayer> ) -> GetObjectAttributesFluentBuilder

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

pub fn get_request_payer(&self) -> &Option<RequestPayer>

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

pub fn expected_bucket_owner( self, input: impl Into<String> ) -> GetObjectAttributesFluentBuilder

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

pub fn set_expected_bucket_owner( self, input: Option<String> ) -> GetObjectAttributesFluentBuilder

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

pub fn get_expected_bucket_owner(&self) -> &Option<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).

pub fn object_attributes( self, input: ObjectAttributes ) -> GetObjectAttributesFluentBuilder

Appends an item to ObjectAttributes.

To override the contents of this collection use set_object_attributes.

Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

pub fn set_object_attributes( self, input: Option<Vec<ObjectAttributes, Global>> ) -> GetObjectAttributesFluentBuilder

Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

pub fn get_object_attributes(&self) -> &Option<Vec<ObjectAttributes, Global>>

Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

Trait Implementations

impl Clone for GetObjectAttributesFluentBuilder

fn clone(&self) -> GetObjectAttributesFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetObjectAttributesFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.