amazonka-s3-1.3.4: Amazon Simple Storage Service SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.S3.PutObject

Contents

Description

Adds an object to a bucket.

See: AWS API Reference for PutObject.

Synopsis

Creating a Request

Request Lenses

poContentLength :: Lens' PutObject (Maybe Int) Source

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

poExpires :: Lens' PutObject (Maybe UTCTime) Source

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

poGrantReadACP :: Lens' PutObject (Maybe Text) Source

Allows grantee to read the object ACL.

poSSECustomerAlgorithm :: Lens' PutObject (Maybe Text) Source

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

poSSECustomerKey :: Lens' PutObject (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.

poGrantWriteACP :: Lens' PutObject (Maybe Text) Source

Allows grantee to write the ACL for the applicable object.

poWebsiteRedirectLocation :: Lens' PutObject (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.

poGrantRead :: Lens' PutObject (Maybe Text) Source

Allows grantee to read the object data and its metadata.

poStorageClass :: Lens' PutObject (Maybe StorageClass) Source

The type of storage to use for the object. Defaults to 'STANDARD'.

poSSECustomerKeyMD5 :: Lens' PutObject (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.

poSSEKMSKeyId :: Lens' PutObject (Maybe Text) Source

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

poGrantFullControl :: Lens' PutObject (Maybe Text) Source

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

poContentEncoding :: Lens' PutObject (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.

poContentMD5 :: Lens' PutObject (Maybe Text) Source

Undocumented member.

poMetadata :: Lens' PutObject (HashMap Text Text) Source

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

poCacheControl :: Lens' PutObject (Maybe Text) Source

Specifies caching behavior along the request/reply chain.

poContentLanguage :: Lens' PutObject (Maybe Text) Source

The language the content is in.

poACL :: Lens' PutObject (Maybe ObjectCannedACL) Source

The canned ACL to apply to the object.

poContentDisposition :: Lens' PutObject (Maybe Text) Source

Specifies presentational information for the object.

poServerSideEncryption :: Lens' PutObject (Maybe ServerSideEncryption) Source

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

poContentType :: Lens' PutObject (Maybe Text) Source

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

poBucket :: Lens' PutObject BucketName Source

Undocumented member.

poKey :: Lens' PutObject ObjectKey Source

Undocumented member.

Destructuring the Response

Response Lenses

porsETag :: Lens' PutObjectResponse (Maybe ETag) Source

Entity tag for the uploaded object.

porsExpiration :: Lens' PutObjectResponse (Maybe Text) Source

If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.

porsSSECustomerAlgorithm :: Lens' PutObjectResponse (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.

porsSSECustomerKeyMD5 :: Lens' PutObjectResponse (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.

porsSSEKMSKeyId :: Lens' PutObjectResponse (Maybe Text) Source

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

porsServerSideEncryption :: Lens' PutObjectResponse (Maybe ServerSideEncryption) Source

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