Network.AWS.S3.GetObject

Retrieves objects from Amazon S3.

See: AWS API Reference for GetObject.

Creating a Request

getObject

Arguments

:: BucketName

goBucket

-> ObjectKey

goKey

-> GetObject

Creates a value of GetObject with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• goIfMatch
• goVersionId
• goResponseContentType
• goResponseContentDisposition
• goResponseContentLanguage
• goSSECustomerAlgorithm
• goSSECustomerKey
• goRequestPayer
• goResponseContentEncoding
• goIfModifiedSince
• goRange
• goIfUnmodifiedSince
• goSSECustomerKeyMD5
• goResponseCacheControl
• goResponseExpires
• goIfNoneMatch
• goBucket
• goKey

data GetObject

See: getObject smart constructor.

Instances

Eq GetObject

Data GetObject

Read GetObject

Show GetObject

Generic GetObject

AWSRequest GetObject

ToPath GetObject

ToHeaders GetObject

ToQuery GetObject

type Rep GetObject

type Rs GetObject = GetObjectResponse

Request Lenses

goIfMatch :: Lens' GetObject (Maybe Text)

Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

goVersionId :: Lens' GetObject (Maybe ObjectVersionId)

VersionId used to reference a specific version of the object.

goResponseContentType :: Lens' GetObject (Maybe Text)

Sets the Content-Type header of the response.

goResponseContentDisposition :: Lens' GetObject (Maybe Text)

Sets the Content-Disposition header of the response

goResponseContentLanguage :: Lens' GetObject (Maybe Text)

Sets the Content-Language header of the response.

goSSECustomerAlgorithm :: Lens' GetObject (Maybe Text)

Specifies the algorithm to use to when encrypting the object (e.g., AES256).

goSSECustomerKey :: Lens' GetObject (Maybe Text)

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.

goRequestPayer :: Lens' GetObject (Maybe RequestPayer)

Undocumented member.

goResponseContentEncoding :: Lens' GetObject (Maybe Text)

Sets the Content-Encoding header of the response.

goIfModifiedSince :: Lens' GetObject (Maybe UTCTime)

Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

goRange :: Lens' GetObject (Maybe Text)

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.

goIfUnmodifiedSince :: Lens' GetObject (Maybe UTCTime)

Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

goSSECustomerKeyMD5 :: Lens' GetObject (Maybe Text)

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.

goResponseCacheControl :: Lens' GetObject (Maybe Text)

Sets the Cache-Control header of the response.

goResponseExpires :: Lens' GetObject (Maybe UTCTime)

Sets the Expires header of the response.

goIfNoneMatch :: Lens' GetObject (Maybe Text)

Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

goBucket :: Lens' GetObject BucketName

Undocumented member.

goKey :: Lens' GetObject ObjectKey

Undocumented member.

Destructuring the Response

getObjectResponse

Arguments

:: Int

gorsResponseStatus

-> RsBody

gorsBody

-> GetObjectResponse

Creates a value of GetObjectResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gorsRequestCharged
• gorsETag
• gorsVersionId
• gorsContentLength
• gorsExpires
• gorsRestore
• gorsExpiration
• gorsDeleteMarker
• gorsSSECustomerAlgorithm
• gorsMissingMeta
• gorsWebsiteRedirectLocation
• gorsAcceptRanges
• gorsStorageClass
• gorsSSECustomerKeyMD5
• gorsSSEKMSKeyId
• gorsContentEncoding
• gorsMetadata
• gorsReplicationStatus
• gorsCacheControl
• gorsContentLanguage
• gorsLastModified
• gorsContentDisposition
• gorsContentRange
• gorsServerSideEncryption
• gorsContentType
• gorsResponseStatus
• gorsBody

data GetObjectResponse

See: getObjectResponse smart constructor.

Instances

Show GetObjectResponse

Generic GetObjectResponse

type Rep GetObjectResponse

Response Lenses

gorsRequestCharged :: Lens' GetObjectResponse (Maybe RequestCharged)

Undocumented member.

gorsETag :: Lens' GetObjectResponse (Maybe ETag)

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

gorsVersionId :: Lens' GetObjectResponse (Maybe ObjectVersionId)

Version of the object.

gorsContentLength :: Lens' GetObjectResponse (Maybe Int)

Size of the body in bytes.

gorsExpires :: Lens' GetObjectResponse (Maybe UTCTime)

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

gorsRestore :: Lens' GetObjectResponse (Maybe Text)

Provides information about object restoration operation and expiration time of the restored object copy.

gorsExpiration :: Lens' GetObjectResponse (Maybe Text)

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.

gorsDeleteMarker :: Lens' GetObjectResponse (Maybe Bool)

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.

gorsSSECustomerAlgorithm :: Lens' GetObjectResponse (Maybe Text)

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

gorsMissingMeta :: Lens' GetObjectResponse (Maybe Int)

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.

gorsWebsiteRedirectLocation :: Lens' GetObjectResponse (Maybe Text)

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.

gorsAcceptRanges :: Lens' GetObjectResponse (Maybe Text)

Undocumented member.

gorsStorageClass :: Lens' GetObjectResponse (Maybe StorageClass)

Undocumented member.

gorsSSECustomerKeyMD5 :: Lens' GetObjectResponse (Maybe Text)

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.

gorsSSEKMSKeyId :: Lens' GetObjectResponse (Maybe Text)

If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.

gorsContentEncoding :: Lens' GetObjectResponse (Maybe Text)

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.

gorsMetadata :: Lens' GetObjectResponse (HashMap Text Text)

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

gorsReplicationStatus :: Lens' GetObjectResponse (Maybe ReplicationStatus)

Undocumented member.

gorsCacheControl :: Lens' GetObjectResponse (Maybe Text)

Specifies caching behavior along the request/reply chain.

gorsContentLanguage :: Lens' GetObjectResponse (Maybe Text)

The language the content is in.

gorsLastModified :: Lens' GetObjectResponse (Maybe UTCTime)

Last modified date of the object

gorsContentDisposition :: Lens' GetObjectResponse (Maybe Text)

Specifies presentational information for the object.

gorsContentRange :: Lens' GetObjectResponse (Maybe Text)

The portion of the object returned in the response.

gorsServerSideEncryption :: Lens' GetObjectResponse (Maybe ServerSideEncryption)

The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

gorsContentType :: Lens' GetObjectResponse (Maybe Text)

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

gorsResponseStatus :: Lens' GetObjectResponse Int

The response status code.

gorsBody :: Lens' GetObjectResponse RsBody

Object data.