AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the GetObjectAttributes operation. 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.
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 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.
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 the s3express:CreateSession
permission to the directory bucket in
a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
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 another CreateSession
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, see CreateSession
.
Encryption request headers, like x-amz-server-side-encryption
, should not be
sent for HEAD
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). The x-amz-server-side-encryption
header is used when
you PUT
an object to S3 and want to specify the encryption method. If you include
this header in a GET
request for an object that uses these types of keys, you’ll
get an HTTP 400 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.
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 specify null
to the versionId
query
parameter in the request.
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
.
For more information about conditional requests, see RFC 7232.
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.
Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com
.
The following actions are related to GetObjectAttributes
:
Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z
public class GetObjectAttributesRequest : AmazonWebServiceRequest IAmazonWebServiceRequest
The GetObjectAttributesRequest type exposes the following members
Name | Description | |
---|---|---|
GetObjectAttributesRequest() |
Name | Type | Description | |
---|---|---|---|
BucketName | System.String |
Gets and sets the property BucketName. 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 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 |
|
ExpectedBucketOwner | System.String |
Gets and sets the property ExpectedBucketOwner.
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
|
|
Key | System.String |
Gets and sets the property Key. The object key. |
|
MaxParts | System.Int32 |
Gets and sets the property MaxParts. Sets the maximum number of parts to return. |
|
ObjectAttributes | System.Collections.Generic.List<Amazon.S3.ObjectAttributes> |
Gets and sets the property ObjectAttributes. Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned. |
|
PartNumberMarker | System.Int32 |
Gets and sets the property PartNumberMarker. Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. |
|
RequestPayer | Amazon.S3.RequestPayer |
Gets and sets the property RequestPayer. |
|
SSECustomerAlgorithm | System.String |
Gets and sets the property SSECustomerAlgorithm. Specifies the algorithm to use to when encrypting the object (for example, AES256). This functionality is not supported for directory buckets. |
|
SSECustomerKey | System.String |
Gets and sets the property SSECustomerKey.
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 This functionality is not supported for directory buckets. |
|
SSECustomerKeyMD5 | System.String |
Gets and sets the property SSECustomerKeyMD5. 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. |
|
VersionId | System.String |
Gets and sets the property VersionId. 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 |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5