HeadObjectOutput
public struct HeadObjectOutput : AWSShape
Undocumented
-
Declaration
Swift
public static var _members: [AWSShapeMember]
-
Indicates that a range of bytes was specified.
Declaration
Swift
public let acceptRanges: String?
-
Specifies caching behavior along the request/reply chain.
Declaration
Swift
public let cacheControl: String?
-
Specifies presentational information for the object.
Declaration
Swift
public let contentDisposition: String?
-
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
Swift
public let contentEncoding: String?
-
The language the content is in.
Declaration
Swift
public let contentLanguage: String?
-
Size of the body in bytes.
Declaration
Swift
public let contentLength: Int64?
-
A standard MIME type describing the format of the object data.
Declaration
Swift
public let contentType: String?
-
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
Swift
public let deleteMarker: Bool?
-
An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
Declaration
Swift
public let eTag: String?
-
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
Swift
public let expiration: String?
-
The date and time at which the object is no longer cacheable.
Declaration
Swift
public let expires: TimeStamp?
-
Last modified date of the object
Declaration
Swift
public let lastModified: TimeStamp?
-
A map of metadata to store with the object in S3.
Declaration
Swift
public let metadata: [String : String]?
-
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
Swift
public let missingMeta: Int?
-
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
Swift
public let objectLockLegalHoldStatus: ObjectLockLegalHoldStatus?
-
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
Swift
public let objectLockMode: ObjectLockMode?
-
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
Swift
public let objectLockRetainUntilDate: TimeStamp?
-
The count of parts this object has.
Declaration
Swift
public let partsCount: Int?
-
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
Swift
public let replicationStatus: ReplicationStatus?
-
Undocumented
Declaration
Swift
public let requestCharged: RequestCharged?
-
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
Swift
public let restore: String?
-
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
Swift
public let serverSideEncryption: ServerSideEncryption?
-
If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
Declaration
Swift
public let sSECustomerAlgorithm: String?
-
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
Swift
public let sSECustomerKeyMD5: String?
-
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
Swift
public let sSEKMSKeyId: String?
-
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
Swift
public let storageClass: StorageClass?
-
Version of the object.
Declaration
Swift
public let versionId: String?
-
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
Swift
public let websiteRedirectLocation: String?
-
init(acceptRanges:cacheControl:contentDisposition:contentEncoding:contentLanguage:contentLength:contentType:deleteMarker:eTag:expiration:expires:lastModified:metadata:missingMeta:objectLockLegalHoldStatus:objectLockMode:objectLockRetainUntilDate:partsCount:replicationStatus:requestCharged:restore:serverSideEncryption:sSECustomerAlgorithm:sSECustomerKeyMD5:sSEKMSKeyId:storageClass:versionId:websiteRedirectLocation:)
Undocumented
Declaration
Swift
public init(acceptRanges: String? = nil, cacheControl: String? = nil, contentDisposition: String? = nil, contentEncoding: String? = nil, contentLanguage: String? = nil, contentLength: Int64? = nil, contentType: String? = nil, deleteMarker: Bool? = nil, eTag: String? = nil, expiration: String? = nil, expires: TimeStamp? = nil, lastModified: TimeStamp? = nil, metadata: [String : String]? = nil, missingMeta: Int? = nil, objectLockLegalHoldStatus: ObjectLockLegalHoldStatus? = nil, objectLockMode: ObjectLockMode? = nil, objectLockRetainUntilDate: TimeStamp? = nil, partsCount: Int? = nil, replicationStatus: ReplicationStatus? = nil, requestCharged: RequestCharged? = nil, restore: String? = nil, serverSideEncryption: ServerSideEncryption? = nil, sSECustomerAlgorithm: String? = nil, sSECustomerKeyMD5: String? = nil, sSEKMSKeyId: String? = nil, storageClass: StorageClass? = nil, versionId: String? = nil, websiteRedirectLocation: String? = nil)