Class GetObjectMetadataResponse
Returns information about the HeadObject response and response metadata.
public class GetObjectMetadataResponse : AmazonWebServiceResponse
- Inheritance
-
GetObjectMetadataResponse
Constructors
GetObjectMetadataResponse()
public GetObjectMetadataResponse()
Properties
AcceptRanges
Gets and sets the AcceptRanges.
public string AcceptRanges { get; set; }
Property Value
ArchiveStatus
The archive state of the head object.
public ArchiveStatus ArchiveStatus { get; set; }
Property Value
BucketKeyEnabled
Gets and sets the property BucketKeyEnabled.
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
public bool BucketKeyEnabled { get; set; }
Property Value
ChecksumCRC32
Gets and sets the property ChecksumCRC32.
The base64-encoded, 32-bit CRC32 checksum of the object.
public string ChecksumCRC32 { get; set; }
Property Value
ChecksumCRC32C
Gets and sets the property ChecksumCRC32C.
The base64-encoded, 32-bit CRC32C checksum of the object.
public string ChecksumCRC32C { get; set; }
Property Value
ChecksumSHA1
Gets and sets the property ChecksumSHA1.
The base64-encoded, 160-bit SHA-1 digest of the object.
public string ChecksumSHA1 { get; set; }
Property Value
ChecksumSHA256
Gets and sets the property ChecksumSHA256.
The base64-encoded, 256-bit SHA-256 digest of the object.
public string ChecksumSHA256 { get; set; }
Property Value
ContentRange
Gets and sets the ContentRange.
public string ContentRange { get; set; }
Property Value
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.
public string DeleteMarker { get; set; }
Property Value
ETag
An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL
public string ETag { get; set; }
Property Value
Expiration
Gets and sets the Expiration property. Specifies the expiration date for the object and the rule governing the expiration. Is null if expiration is not applicable.
public Expiration Expiration { get; set; }
Property Value
Expires
The date and time at which the object is no longer cacheable.
public DateTime Expires { get; set; }
Property Value
Headers
The collection of headers for the request.
public HeadersCollection Headers { get; }
Property Value
LastModified
Last modified date of the object
public DateTime LastModified { get; set; }
Property Value
Metadata
The collection of meta data for the request.
public MetadataCollection Metadata { get; }
Property Value
MissingMeta
This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
public int MissingMeta { get; set; }
Property Value
ObjectLockLegalHoldStatus
Gets and sets the property ObjectLockLegalHoldStatus.
The Legal Hold status for the specified object.
public ObjectLockLegalHoldStatus ObjectLockLegalHoldStatus { get; set; }
Property Value
ObjectLockMode
Gets and sets the property ObjectLockMode.
The Object Lock mode currently in place for this object.
public ObjectLockMode ObjectLockMode { get; set; }
Property Value
ObjectLockRetainUntilDate
Gets and sets the property ObjectLockRetainUntilDate.
The date and time when this object's Object Lock will expire.
public DateTime ObjectLockRetainUntilDate { get; set; }
Property Value
PartsCount
The count of parts this object has.
public int? PartsCount { get; set; }
Property Value
- int?
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 (
GetObject
) or
object metadata (HeadObject
) from these buckets, Amazon S3 will
return the x-amz-replication-status
header in the response as follows:
-
If requesting an object from the source bucket, Amazon S3 will return the
header if the object in your request is eligible for replication.x-amz-replication-status
For example, suppose that in your replication configuration, you specify object prefix
requesting Amazon S3 to replicate objects with key prefixTaxDocs
. Any objects you upload with this key name prefix, for exampleTaxDocs
, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return theTaxDocs/document1.pdf
header with value PENDING, COMPLETED or FAILED indicating object replication status.x-amz-replication-status
-
If requesting an object from a destination bucket, Amazon S3 will return the
header with value REPLICA if the object in your request is a replica that Amazon S3 created.x-amz-replication-status
-
When replicating objects to multiple destination buckets the
header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.x-amz-replication-status
For more information, see Replication.
public ReplicationStatus ReplicationStatus { get; set; }
Property Value
RequestCharged
If present, indicates that the requester was successfully charged for the request.
public RequestCharged RequestCharged { get; set; }
Property Value
RestoreExpiration
Gets and sets the RestoreExpiration property.
RestoreExpiration will be set for objects that have been restored from Amazon Glacier.
It indiciates for those objects how long the restored object will exist.
public DateTime? RestoreExpiration { get; set; }
Property Value
RestoreInProgress
Gets and sets the RestoreInProgress Will be true when the object is in the process of being restored from Amazon Glacier.
public bool RestoreInProgress { get; set; }
Property Value
ServerSideEncryptionCustomerMethod
The Server-side encryption algorithm to be used with the customer provided key.
public ServerSideEncryptionCustomerMethod ServerSideEncryptionCustomerMethod { get; set; }
Property Value
ServerSideEncryptionKeyManagementServiceKeyId
The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object.
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for the object.
public string ServerSideEncryptionKeyManagementServiceKeyId { get; set; }
Property Value
ServerSideEncryptionMethod
The Server-side encryption algorithm used when storing this object in S3.
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256,
aws:kms
).
public ServerSideEncryptionMethod ServerSideEncryptionMethod { get; set; }
Property Value
StorageClass
The class of storage used to store the object.
public S3StorageClass StorageClass { get; set; }
Property Value
VersionId
Version of the object.
public string VersionId { get; set; }
Property Value
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.
public string WebsiteRedirectLocation { get; set; }