AWSS3HeadObjectOutput

Objective-C

@interface AWSS3HeadObjectOutput

Swift

class AWSS3HeadObjectOutput

  • Indicates that a range of bytes was specified.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable acceptRanges;

    Swift

    var acceptRanges: String? { get set }

  • Specifies caching behavior along the request/reply chain.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable cacheControl;

    Swift

    var cacheControl: String? { get set }

  • Specifies presentational information for the object.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable contentDisposition;

    Swift

    var contentDisposition: String? { get set }

  • Specifies 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable contentEncoding;

    Swift

    var contentEncoding: String? { get set }

  • The language the content is in.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable contentLanguage;

    Swift

    var contentLanguage: String? { get set }

  • Size of the body in bytes.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable contentLength;

    Swift

    var contentLength: NSNumber? { get set }

  • A standard MIME type describing the format of the object data.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable contentType;

    Swift

    var contentType: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable deleteMarker;

    Swift

    var deleteMarker: NSNumber? { get set }

  • An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable ETag;

    Swift

    var eTag: String? { get set }

  • If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable expiration;

    Swift

    var expiration: String? { get set }

  • The date and time at which the object is no longer cacheable.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable expires;

    Swift

    var expires: Date? { get set }

  • Last modified date of the object

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable lastModified;

    Swift

    var lastModified: Date? { get set }

  • A map of metadata to store with the object in S3.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable metadata;

    Swift

    var metadata: [String : String]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable missingMeta;

    Swift

    var missingMeta: NSNumber? { get set }

  • Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ObjectLockLegalHoldStatus objectLockLegalHoldStatus;

    Swift

    var objectLockLegalHoldStatus: AWSS3ObjectLockLegalHoldStatus { get set }

  • The Object Lock mode, if any, that’s in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ObjectLockMode objectLockMode;

    Swift

    var objectLockMode: AWSS3ObjectLockMode { get set }

  • The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable objectLockRetainUntilDate;

    Swift

    var objectLockRetainUntilDate: Date? { get set }

  • The count of parts this object has.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable partsCount;

    Swift

    var partsCount: NSNumber? { get set }

  • Amazon S3 can return this header if your request involves a bucket that is either a source or destination in a replication rule.

    In replication, you have a source bucket on which you configure replication and destination bucket 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 x-amz-replication-status header if the object in your request is eligible for replication.

      For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.

    • If requesting an object from the destination bucket — Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created.

    For more information, see Replication.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ReplicationStatus replicationStatus;

    Swift

    var replicationStatus: AWSS3ReplicationStatus { get set }

  • If present, indicates that the requester was successfully charged for the request.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3RequestCharged requestCharged;

    Swift

    var requestCharged: AWSS3RequestCharged { get set }

  • If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

    If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

    x-amz-restore: ongoing-request="false", expiry-date="Fri, 23 Dec 2012 00:00:00 GMT"

    If the object restoration is in progress, the header returns the value ongoing-request="true".

    For more information about archiving objects, see Transitioning Objects: General Considerations.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable restore;

    Swift

    var restore: String? { get set }

  • If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable SSECustomerAlgorithm;

    Swift

    var sseCustomerAlgorithm: String? { get set }

  • If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable SSECustomerKeyMD5;

    Swift

    var sseCustomerKeyMD5: String? { get set }

  • If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable SSEKMSKeyId;

    Swift

    var ssekmsKeyId: String? { get set }

  • If the object is stored using server-side encryption either with an AWS KMS customer master key (CMK) or an Amazon S3-managed encryption key, the response includes this header with the value of the server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ServerSideEncryption serverSideEncryption;

    Swift

    var serverSideEncryption: AWSS3ServerSideEncryption { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSS3StorageClass storageClass;

    Swift

    var storageClass: AWSS3StorageClass { get set }

  • Version of the object.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable versionId;

    Swift

    var versionId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable websiteRedirectLocation;

    Swift

    var websiteRedirectLocation: String? { get set }