Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.
See: AWS API Reference for HeadObject.
- headObject :: BucketName -> ObjectKey -> HeadObject
- data HeadObject
- hoIfMatch :: Lens' HeadObject (Maybe Text)
- hoVersionId :: Lens' HeadObject (Maybe ObjectVersionId)
- hoSSECustomerAlgorithm :: Lens' HeadObject (Maybe Text)
- hoSSECustomerKey :: Lens' HeadObject (Maybe Text)
- hoRequestPayer :: Lens' HeadObject (Maybe RequestPayer)
- hoIfModifiedSince :: Lens' HeadObject (Maybe UTCTime)
- hoRange :: Lens' HeadObject (Maybe Text)
- hoIfUnmodifiedSince :: Lens' HeadObject (Maybe UTCTime)
- hoSSECustomerKeyMD5 :: Lens' HeadObject (Maybe Text)
- hoIfNoneMatch :: Lens' HeadObject (Maybe Text)
- hoBucket :: Lens' HeadObject BucketName
- hoKey :: Lens' HeadObject ObjectKey
- headObjectResponse :: Int -> HeadObjectResponse
- data HeadObjectResponse
- horsRequestCharged :: Lens' HeadObjectResponse (Maybe RequestCharged)
- horsETag :: Lens' HeadObjectResponse (Maybe ETag)
- horsVersionId :: Lens' HeadObjectResponse (Maybe ObjectVersionId)
- horsContentLength :: Lens' HeadObjectResponse (Maybe Int)
- horsExpires :: Lens' HeadObjectResponse (Maybe UTCTime)
- horsRestore :: Lens' HeadObjectResponse (Maybe Text)
- horsExpiration :: Lens' HeadObjectResponse (Maybe Text)
- horsDeleteMarker :: Lens' HeadObjectResponse (Maybe Bool)
- horsSSECustomerAlgorithm :: Lens' HeadObjectResponse (Maybe Text)
- horsMissingMeta :: Lens' HeadObjectResponse (Maybe Int)
- horsWebsiteRedirectLocation :: Lens' HeadObjectResponse (Maybe Text)
- horsAcceptRanges :: Lens' HeadObjectResponse (Maybe Text)
- horsStorageClass :: Lens' HeadObjectResponse (Maybe StorageClass)
- horsSSECustomerKeyMD5 :: Lens' HeadObjectResponse (Maybe Text)
- horsSSEKMSKeyId :: Lens' HeadObjectResponse (Maybe Text)
- horsContentEncoding :: Lens' HeadObjectResponse (Maybe Text)
- horsMetadata :: Lens' HeadObjectResponse (HashMap Text Text)
- horsReplicationStatus :: Lens' HeadObjectResponse (Maybe ReplicationStatus)
- horsCacheControl :: Lens' HeadObjectResponse (Maybe Text)
- horsContentLanguage :: Lens' HeadObjectResponse (Maybe Text)
- horsLastModified :: Lens' HeadObjectResponse (Maybe UTCTime)
- horsContentDisposition :: Lens' HeadObjectResponse (Maybe Text)
- horsServerSideEncryption :: Lens' HeadObjectResponse (Maybe ServerSideEncryption)
- horsContentType :: Lens' HeadObjectResponse (Maybe Text)
- horsResponseStatus :: Lens' HeadObjectResponse Int
Creating a Request
Creates a value of HeadObject
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data HeadObject Source
See: headObject
smart constructor.
Request Lenses
hoIfMatch :: Lens' HeadObject (Maybe Text) Source
Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).
hoVersionId :: Lens' HeadObject (Maybe ObjectVersionId) Source
VersionId used to reference a specific version of the object.
hoSSECustomerAlgorithm :: Lens' HeadObject (Maybe Text) Source
Specifies the algorithm to use to when encrypting the object (e.g., AES256).
hoSSECustomerKey :: Lens' HeadObject (Maybe Text) Source
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 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.
hoRequestPayer :: Lens' HeadObject (Maybe RequestPayer) Source
Undocumented member.
hoIfModifiedSince :: Lens' HeadObject (Maybe UTCTime) Source
Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
hoRange :: Lens' HeadObject (Maybe Text) Source
Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
hoIfUnmodifiedSince :: Lens' HeadObject (Maybe UTCTime) Source
Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).
hoSSECustomerKeyMD5 :: Lens' HeadObject (Maybe Text) Source
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 the encryption key was transmitted without error.
hoIfNoneMatch :: Lens' HeadObject (Maybe Text) Source
Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).
hoBucket :: Lens' HeadObject BucketName Source
Undocumented member.
hoKey :: Lens' HeadObject ObjectKey Source
Undocumented member.
Destructuring the Response
Creates a value of HeadObjectResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
horsRequestCharged
horsETag
horsVersionId
horsContentLength
horsExpires
horsRestore
horsExpiration
horsDeleteMarker
horsSSECustomerAlgorithm
horsMissingMeta
horsWebsiteRedirectLocation
horsAcceptRanges
horsStorageClass
horsSSECustomerKeyMD5
horsSSEKMSKeyId
horsContentEncoding
horsMetadata
horsReplicationStatus
horsCacheControl
horsContentLanguage
horsLastModified
horsContentDisposition
horsServerSideEncryption
horsContentType
horsResponseStatus
data HeadObjectResponse Source
See: headObjectResponse
smart constructor.
Response Lenses
horsRequestCharged :: Lens' HeadObjectResponse (Maybe RequestCharged) Source
Undocumented member.
horsETag :: Lens' HeadObjectResponse (Maybe ETag) Source
An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL
horsVersionId :: Lens' HeadObjectResponse (Maybe ObjectVersionId) Source
Version of the object.
horsContentLength :: Lens' HeadObjectResponse (Maybe Int) Source
Size of the body in bytes.
horsExpires :: Lens' HeadObjectResponse (Maybe UTCTime) Source
The date and time at which the object is no longer cacheable.
horsRestore :: Lens' HeadObjectResponse (Maybe Text) Source
Provides information about object restoration operation and expiration time of the restored object copy.
horsExpiration :: Lens' HeadObjectResponse (Maybe Text) Source
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.
horsDeleteMarker :: Lens' HeadObjectResponse (Maybe Bool) Source
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.
horsSSECustomerAlgorithm :: Lens' HeadObjectResponse (Maybe Text) Source
If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
horsMissingMeta :: Lens' HeadObjectResponse (Maybe Int) Source
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.
horsWebsiteRedirectLocation :: Lens' HeadObjectResponse (Maybe Text) Source
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.
horsAcceptRanges :: Lens' HeadObjectResponse (Maybe Text) Source
Undocumented member.
horsStorageClass :: Lens' HeadObjectResponse (Maybe StorageClass) Source
Undocumented member.
horsSSECustomerKeyMD5 :: Lens' HeadObjectResponse (Maybe Text) Source
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.
horsSSEKMSKeyId :: Lens' HeadObjectResponse (Maybe Text) Source
If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
horsContentEncoding :: Lens' HeadObjectResponse (Maybe Text) Source
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.
horsMetadata :: Lens' HeadObjectResponse (HashMap Text Text) Source
A map of metadata to store with the object in S3.
horsReplicationStatus :: Lens' HeadObjectResponse (Maybe ReplicationStatus) Source
Undocumented member.
horsCacheControl :: Lens' HeadObjectResponse (Maybe Text) Source
Specifies caching behavior along the request/reply chain.
horsContentLanguage :: Lens' HeadObjectResponse (Maybe Text) Source
The language the content is in.
horsLastModified :: Lens' HeadObjectResponse (Maybe UTCTime) Source
Last modified date of the object
horsContentDisposition :: Lens' HeadObjectResponse (Maybe Text) Source
Specifies presentational information for the object.
horsServerSideEncryption :: Lens' HeadObjectResponse (Maybe ServerSideEncryption) Source
The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
horsContentType :: Lens' HeadObjectResponse (Maybe Text) Source
A standard MIME type describing the format of the object data.
horsResponseStatus :: Lens' HeadObjectResponse Int Source
The response status code.