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.
Returns information about the HeadObject response and response metadata.
Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z
public class GetObjectMetadataResponse : AmazonWebServiceResponse
The GetObjectMetadataResponse type exposes the following members
Name | Description | |
---|---|---|
![]() |
GetObjectMetadataResponse() |
Name | Type | Description | |
---|---|---|---|
![]() |
AcceptRanges | System.String |
Gets and sets the property AcceptRanges. Indicates that a range of bytes was specified. |
![]() |
ArchiveStatus | Amazon.S3.ArchiveStatus |
Gets and sets the property ArchiveStatus. The archive state of the head object. This functionality is not supported for directory buckets. |
![]() |
BucketKeyEnabled | System.Nullable<System.Boolean> |
Gets and sets the property BucketKeyEnabled. Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS). |
![]() |
CacheControl | System.String |
Gets and sets the property CacheControl. Specifies caching behavior along the request/reply chain. |
![]() |
ChecksumCRC32 | System.String |
Gets and sets the property ChecksumCRC32.
The Base64 encoded, 32-bit |
![]() |
ChecksumCRC32C | System.String |
Gets and sets the property ChecksumCRC32C.
The Base64 encoded, 32-bit |
![]() |
ChecksumCRC64NVME | System.String |
Gets and sets the property ChecksumCRC64NVME.
The Base64 encoded, 64-bit |
![]() |
ChecksumSHA1 | System.String |
Gets and sets the property ChecksumSHA1.
The Base64 encoded, 160-bit |
![]() |
ChecksumSHA256 | System.String |
Gets and sets the property ChecksumSHA256.
The Base64 encoded, 256-bit |
![]() |
ChecksumType | Amazon.S3.ChecksumType |
Gets and sets the property ChecksumType.
The checksum type, which determines how part-level checksums are combined to create
an object-level checksum for multipart objects. You can use this header response to
verify that the checksum type that is received is the same checksum type that was
specified in |
![]() |
ContentDisposition | System.String |
Gets and sets the property ContentDisposition. Specifies presentational information for the object. |
![]() |
ContentEncoding | System.String |
Gets and sets the property ContentEncoding. Indicates what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. |
![]() |
ContentLanguage | System.String |
Gets and sets the property ContentLanguage. The language the content is in. |
![]() |
ContentLength | System.Int64 | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
![]() |
ContentRange | System.String |
Gets and sets the property ContentRange.
The portion of the object returned in the response for a |
![]() |
ContentType | System.String |
Gets and sets the property ContentType. A standard MIME type describing the format of the object data. |
![]() |
DeleteMarker | System.String |
Gets and sets the property DeleteMarker. Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response. This functionality is not supported for directory buckets. |
![]() |
ETag | System.String |
Gets and sets the property ETag. An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL. |
![]() |
Expiration | Amazon.S3.Model.Expiration |
Gets and sets the property Expiration.
If the object expiration is configured (see
Object expiration information is not returned in directory buckets and this header
returns the value " |
![]() |
ExpiresString | System.String |
The date and time at which the object is no longer cacheable. |
![]() |
Headers | Amazon.S3.Model.HeadersCollection |
The collection of headers for the request. |
![]() |
HttpStatusCode | System.Net.HttpStatusCode | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
![]() |
LastModified | System.Nullable<System.DateTime> |
Gets and sets the property LastModified. Date and time when the object was last modified. |
![]() |
Metadata | Amazon.S3.Model.MetadataCollection |
The collection of meta data for the request. |
![]() |
MissingMeta | System.Nullable<System.Int32> |
Gets and sets the property MissingMeta.
This is set to the number of metadata entries not returned in This functionality is not supported for directory buckets. |
![]() |
ObjectLockLegalHoldStatus | Amazon.S3.ObjectLockLegalHoldStatus |
Gets and sets the property ObjectLockLegalHoldStatus.
Specifies whether a legal hold is in effect for this object. This header is only returned
if the requester has the This functionality is not supported for directory buckets. |
![]() |
ObjectLockMode | Amazon.S3.ObjectLockMode |
Gets and sets the property ObjectLockMode.
The Object Lock mode, if any, that's in effect for this object. This header is only
returned if the requester has the This functionality is not supported for directory buckets. |
![]() |
ObjectLockRetainUntilDate | System.Nullable<System.DateTime> |
Gets and sets the property ObjectLockRetainUntilDate.
The date and time when the Object Lock retention period expires. This header is only
returned if the requester has the This functionality is not supported for directory buckets. |
![]() |
PartsCount | System.Nullable<System.Int32> |
Gets and sets the property PartsCount.
The count of parts this object has. This value is only returned if you specify |
![]() |
ReplicationStatus | Amazon.S3.ReplicationStatus |
Gets and sets the property ReplicationStatus. Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.
In replication, you have a source bucket on which you configure replication and destination
bucket or buckets where Amazon S3 stores object replicas. When you request an object
(
For more information, see Replication. This functionality is not supported for directory buckets. |
![]() |
RequestCharged | Amazon.S3.RequestCharged |
Gets and sets the property RequestCharged. |
![]() |
ResponseMetadata | Amazon.Runtime.ResponseMetadata | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
![]() |
RestoreExpiration | System.Nullable<System.DateTime> |
Gets and sets the RestoreExpiration property. RestoreExpiration will be set for objects that have been restored from Amazon Glacier. It indicates for those objects how long the restored object will exist. This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects. |
![]() |
RestoreInProgress | System.Nullable<System.Boolean> |
Gets and sets the RestoreInProgress
Will be This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects. |
![]() |
ServerSideEncryptionCustomerMethod | Amazon.S3.ServerSideEncryptionCustomerMethod |
The Server-side encryption algorithm to be used with the customer provided key.
For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3)
( |
![]() |
ServerSideEncryptionCustomerProvidedKeyMD5 | System.String |
Gets and sets the property ServerSideEncryptionCustomerProvidedKeyMD5. If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key. This functionality is not supported for directory buckets. |
![]() |
ServerSideEncryptionKeyManagementServiceKeyId | System.String |
Gets and sets the property ServerSideEncryptionKeyManagementServiceKeyId. If present, indicates the ID of the KMS key that was used for object encryption. |
![]() |
ServerSideEncryptionMethod | Amazon.S3.ServerSideEncryptionMethod |
The server-side encryption algorithm used when storing this object in Amazon S3 or Amazon FSx. The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx. When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is |
![]() |
StorageClass | Amazon.S3.S3StorageClass |
Gets and sets the property StorageClass. Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects. For more information, see Storage Classes. Directory buckets - Directory buckets only support |
![]() |
TagsCount | System.Nullable<System.Int32> |
Gets and sets the property TagsCount. The number of tags, if any, on the object, when you have the relevant permission to read object tags. You can use GetObjectTagging to retrieve the tag set associated with an object. This functionality is not supported for directory buckets. |
![]() |
VersionId | System.String |
Gets and sets the property VersionId. Version ID of the object. This functionality is not supported for directory buckets. |
![]() |
WebsiteRedirectLocation | System.String |
Gets and sets the property WebsiteRedirectLocation. If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. This functionality is not supported for directory buckets. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer