Struct aws_sdk_s3::operation::get_object_attributes::builders::GetObjectAttributesFluentBuilder
source · pub struct GetObjectAttributesFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to GetObjectAttributes
.
Retrieves all the metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata.
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
.
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
- Permissions
-
-
General purpose bucket permissions - To use
GetObjectAttributes
, you must have READ access to the object. The permissions that you need to use this operation with depend on whether the bucket is versioned. If the bucket is versioned, you need both thes3:GetObjectVersion
ands3:GetObjectVersionAttributes
permissions for this operation. If the bucket is not versioned, you need thes3:GetObject
ands3: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 thes3:ListBucket
permission.-
If you have the
s3:ListBucket
permission on the bucket, Amazon S3 returns an HTTP status code404 Not Found
("no such key") error. -
If you don't have the
s3:ListBucket
permission, Amazon S3 returns an HTTP status code403 Forbidden
("access denied") error.
-
-
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the
CreateSession
API operation for session-based authorization. Specifically, you grant thes3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make anotherCreateSession
API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, seeCreateSession
.
-
- Encryption
-
Encryption request headers, like
x-amz-server-side-encryption
, should not be sent forHEAD
requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). Thex-amz-server-side-encryption
header is used when youPUT
an object to S3 and want to specify the encryption method. If you include this header in aGET
request for an object that uses these types of keys, you’ll get an HTTP400 Bad Request
error. It's because the encryption method can't be changed when you retrieve the object.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 to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are:
-
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.
Directory bucket permissions - For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) is supported. -
- Versioning
-
Directory buckets - 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 specifynull
to theversionId
query parameter in the request. - Conditional request headers
-
Consider the following when using request headers:
-
If both of the
If-Match
andIf-Unmodified-Since
headers are present in the request as follows, then Amazon S3 returns the HTTP status code200 OK
and the data requested:-
If-Match
condition evaluates totrue
. -
If-Unmodified-Since
condition evaluates tofalse
.
For more information about conditional requests, see RFC 7232.
-
-
If both of the
If-None-Match
andIf-Modified-Since
headers are present in the request as follows, then Amazon S3 returns the HTTP status code304 Not Modified
:-
If-None-Match
condition evaluates tofalse
. -
If-Modified-Since
condition evaluates totrue
.
For more information about conditional requests, see RFC 7232.
-
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com
.
The following actions are related to GetObjectAttributes
:
Implementations§
source§impl GetObjectAttributesFluentBuilder
impl GetObjectAttributesFluentBuilder
sourcepub fn as_input(&self) -> &GetObjectAttributesInputBuilder
pub fn as_input(&self) -> &GetObjectAttributesInputBuilder
Access the GetObjectAttributes as a reference.
sourcepub async fn send(
self,
) -> Result<GetObjectAttributesOutput, SdkError<GetObjectAttributesError, HttpResponse>>
pub async fn send( self, ) -> Result<GetObjectAttributesOutput, SdkError<GetObjectAttributesError, HttpResponse>>
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.
sourcepub fn customize(
self,
) -> CustomizableOperation<GetObjectAttributesOutput, GetObjectAttributesError, Self>
pub fn customize( self, ) -> CustomizableOperation<GetObjectAttributesOutput, GetObjectAttributesError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn bucket(self, input: impl Into<String>) -> Self
pub fn bucket(self, input: impl Into<String>) -> Self
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 in the Amazon S3 User Guide.
Access points and Object Lambda access points are not supported by directory buckets.
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? in the Amazon S3 User Guide.
sourcepub fn set_bucket(self, input: Option<String>) -> Self
pub fn set_bucket(self, input: Option<String>) -> Self
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 in the Amazon S3 User Guide.
Access points and Object Lambda access points are not supported by directory buckets.
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? in the Amazon S3 User Guide.
sourcepub fn get_bucket(&self) -> &Option<String>
pub fn get_bucket(&self) -> &Option<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 in the Amazon S3 User Guide.
Access points and Object Lambda access points are not supported by directory buckets.
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? in the Amazon S3 User Guide.
sourcepub fn version_id(self, input: impl Into<String>) -> Self
pub fn version_id(self, input: impl Into<String>) -> Self
The version ID used to reference a specific version of the object.
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.
sourcepub fn set_version_id(self, input: Option<String>) -> Self
pub fn set_version_id(self, input: Option<String>) -> Self
The version ID used to reference a specific version of the object.
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.
sourcepub fn get_version_id(&self) -> &Option<String>
pub fn get_version_id(&self) -> &Option<String>
The version ID used to reference a specific version of the object.
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.
sourcepub fn set_max_parts(self, input: Option<i32>) -> Self
pub fn set_max_parts(self, input: Option<i32>) -> Self
Sets the maximum number of parts to return.
sourcepub fn get_max_parts(&self) -> &Option<i32>
pub fn get_max_parts(&self) -> &Option<i32>
Sets the maximum number of parts to return.
sourcepub fn part_number_marker(self, input: impl Into<String>) -> Self
pub fn part_number_marker(self, input: impl Into<String>) -> Self
Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
sourcepub fn set_part_number_marker(self, input: Option<String>) -> Self
pub fn set_part_number_marker(self, input: Option<String>) -> Self
Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
sourcepub fn get_part_number_marker(&self) -> &Option<String>
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.
sourcepub fn sse_customer_algorithm(self, input: impl Into<String>) -> Self
pub fn sse_customer_algorithm(self, input: impl Into<String>) -> Self
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
sourcepub fn set_sse_customer_algorithm(self, input: Option<String>) -> Self
pub fn set_sse_customer_algorithm(self, input: Option<String>) -> Self
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
sourcepub fn get_sse_customer_algorithm(&self) -> &Option<String>
pub fn get_sse_customer_algorithm(&self) -> &Option<String>
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
sourcepub fn sse_customer_key(self, input: impl Into<String>) -> Self
pub fn sse_customer_key(self, input: impl Into<String>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn set_sse_customer_key(self, input: Option<String>) -> Self
pub fn set_sse_customer_key(self, input: Option<String>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn get_sse_customer_key(&self) -> &Option<String>
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.
This functionality is not supported for directory buckets.
sourcepub fn sse_customer_key_md5(self, input: impl Into<String>) -> Self
pub fn sse_customer_key_md5(self, input: impl Into<String>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn set_sse_customer_key_md5(self, input: Option<String>) -> Self
pub fn set_sse_customer_key_md5(self, input: Option<String>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn get_sse_customer_key_md5(&self) -> &Option<String>
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.
This functionality is not supported for directory buckets.
sourcepub fn request_payer(self, input: RequestPayer) -> Self
pub fn request_payer(self, input: RequestPayer) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn set_request_payer(self, input: Option<RequestPayer>) -> Self
pub fn set_request_payer(self, input: Option<RequestPayer>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn get_request_payer(&self) -> &Option<RequestPayer>
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 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.
This functionality is not supported for directory buckets.
sourcepub fn expected_bucket_owner(self, input: impl Into<String>) -> Self
pub fn expected_bucket_owner(self, input: impl Into<String>) -> Self
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).
sourcepub fn set_expected_bucket_owner(self, input: Option<String>) -> Self
pub fn set_expected_bucket_owner(self, input: Option<String>) -> Self
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).
sourcepub fn get_expected_bucket_owner(&self) -> &Option<String>
pub fn get_expected_bucket_owner(&self) -> &Option<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).
sourcepub fn object_attributes(self, input: ObjectAttributes) -> Self
pub fn object_attributes(self, input: ObjectAttributes) -> Self
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.
sourcepub fn set_object_attributes(self, input: Option<Vec<ObjectAttributes>>) -> Self
pub fn set_object_attributes(self, input: Option<Vec<ObjectAttributes>>) -> Self
Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.
sourcepub fn get_object_attributes(&self) -> &Option<Vec<ObjectAttributes>>
pub fn get_object_attributes(&self) -> &Option<Vec<ObjectAttributes>>
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§
source§impl Clone for GetObjectAttributesFluentBuilder
impl Clone for GetObjectAttributesFluentBuilder
source§fn clone(&self) -> GetObjectAttributesFluentBuilder
fn clone(&self) -> GetObjectAttributesFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for GetObjectAttributesFluentBuilder
impl !RefUnwindSafe for GetObjectAttributesFluentBuilder
impl Send for GetObjectAttributesFluentBuilder
impl Sync for GetObjectAttributesFluentBuilder
impl Unpin for GetObjectAttributesFluentBuilder
impl !UnwindSafe for GetObjectAttributesFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)