Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.S3.PutObject

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.

Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.

To ensure that data is not corrupted traversing the network, use the Content-MD5 header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

To successfully complete the PutObject request, you must have the s3:PutObject in your IAM permissions.
To successfully change the objects acl of your PutObject request, you must have the s3:PutObjectAcl in your IAM permissions.
The Content-MD5 header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon S3 User Guide.

Server-side Encryption

You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side Encryption.

If you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

Access Control List (ACL)-Specific Request Headers

You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.

If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a 400 error with the error code AccessControlListNotSupported.

For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.

If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.

Storage Class Options

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Versioning

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.

For more information about versioning, see Adding Objects to Versioning Enabled Buckets. For information about returning the versioning state of a bucket, see GetBucketVersioning.

Related Resources

Synopsis

data PutObject = PutObject' {
- acl :: Maybe ObjectCannedACL
- bucketKeyEnabled :: Maybe Bool
- cacheControl :: Maybe Text
- checksumAlgorithm :: Maybe ChecksumAlgorithm
- checksumCRC32 :: Maybe Text
- checksumCRC32C :: Maybe Text
- checksumSHA1 :: Maybe Text
- checksumSHA256 :: Maybe Text
- contentDisposition :: Maybe Text
- contentEncoding :: Maybe Text
- contentLanguage :: Maybe Text
- contentLength :: Maybe Integer
- contentMD5 :: Maybe Text
- contentType :: Maybe Text
- expectedBucketOwner :: Maybe Text
- expires :: Maybe RFC822
- grantFullControl :: Maybe Text
- grantRead :: Maybe Text
- grantReadACP :: Maybe Text
- grantWriteACP :: Maybe Text
- metadata :: HashMap Text Text
- objectLockLegalHoldStatus :: Maybe ObjectLockLegalHoldStatus
- objectLockMode :: Maybe ObjectLockMode
- objectLockRetainUntilDate :: Maybe ISO8601
- requestPayer :: Maybe RequestPayer
- sSECustomerAlgorithm :: Maybe Text
- sSECustomerKey :: Maybe (Sensitive Text)
- sSECustomerKeyMD5 :: Maybe Text
- sSEKMSEncryptionContext :: Maybe (Sensitive Text)
- sSEKMSKeyId :: Maybe (Sensitive Text)
- serverSideEncryption :: Maybe ServerSideEncryption
- storageClass :: Maybe StorageClass
- tagging :: Maybe Text
- websiteRedirectLocation :: Maybe Text
- bucket :: BucketName
- key :: ObjectKey
- body :: RequestBody
}
newPutObject :: BucketName -> ObjectKey -> RequestBody -> PutObject
putObject_acl :: Lens' PutObject (Maybe ObjectCannedACL)
putObject_bucketKeyEnabled :: Lens' PutObject (Maybe Bool)
putObject_cacheControl :: Lens' PutObject (Maybe Text)
putObject_checksumAlgorithm :: Lens' PutObject (Maybe ChecksumAlgorithm)
putObject_checksumCRC32 :: Lens' PutObject (Maybe Text)
putObject_checksumCRC32C :: Lens' PutObject (Maybe Text)
putObject_checksumSHA1 :: Lens' PutObject (Maybe Text)
putObject_checksumSHA256 :: Lens' PutObject (Maybe Text)
putObject_contentDisposition :: Lens' PutObject (Maybe Text)
putObject_contentEncoding :: Lens' PutObject (Maybe Text)
putObject_contentLanguage :: Lens' PutObject (Maybe Text)
putObject_contentLength :: Lens' PutObject (Maybe Integer)
putObject_contentMD5 :: Lens' PutObject (Maybe Text)
putObject_contentType :: Lens' PutObject (Maybe Text)
putObject_expectedBucketOwner :: Lens' PutObject (Maybe Text)
putObject_expires :: Lens' PutObject (Maybe UTCTime)
putObject_grantFullControl :: Lens' PutObject (Maybe Text)
putObject_grantRead :: Lens' PutObject (Maybe Text)
putObject_grantReadACP :: Lens' PutObject (Maybe Text)
putObject_grantWriteACP :: Lens' PutObject (Maybe Text)
putObject_metadata :: Lens' PutObject (HashMap Text Text)
putObject_objectLockLegalHoldStatus :: Lens' PutObject (Maybe ObjectLockLegalHoldStatus)
putObject_objectLockMode :: Lens' PutObject (Maybe ObjectLockMode)
putObject_objectLockRetainUntilDate :: Lens' PutObject (Maybe UTCTime)
putObject_requestPayer :: Lens' PutObject (Maybe RequestPayer)
putObject_sSECustomerAlgorithm :: Lens' PutObject (Maybe Text)
putObject_sSECustomerKey :: Lens' PutObject (Maybe Text)
putObject_sSECustomerKeyMD5 :: Lens' PutObject (Maybe Text)
putObject_sSEKMSEncryptionContext :: Lens' PutObject (Maybe Text)
putObject_sSEKMSKeyId :: Lens' PutObject (Maybe Text)
putObject_serverSideEncryption :: Lens' PutObject (Maybe ServerSideEncryption)
putObject_storageClass :: Lens' PutObject (Maybe StorageClass)
putObject_tagging :: Lens' PutObject (Maybe Text)
putObject_websiteRedirectLocation :: Lens' PutObject (Maybe Text)
putObject_bucket :: Lens' PutObject BucketName
putObject_key :: Lens' PutObject ObjectKey
putObject_body :: Lens' PutObject RequestBody
data PutObjectResponse = PutObjectResponse' {
- bucketKeyEnabled :: Maybe Bool
- checksumCRC32 :: Maybe Text
- checksumCRC32C :: Maybe Text
- checksumSHA1 :: Maybe Text
- checksumSHA256 :: Maybe Text
- eTag :: Maybe ETag
- expiration :: Maybe Text
- requestCharged :: Maybe RequestCharged
- sSECustomerAlgorithm :: Maybe Text
- sSECustomerKeyMD5 :: Maybe Text
- sSEKMSEncryptionContext :: Maybe (Sensitive Text)
- sSEKMSKeyId :: Maybe (Sensitive Text)
- serverSideEncryption :: Maybe ServerSideEncryption
- versionId :: Maybe ObjectVersionId
- httpStatus :: Int
}
newPutObjectResponse :: Int -> PutObjectResponse
putObjectResponse_bucketKeyEnabled :: Lens' PutObjectResponse (Maybe Bool)
putObjectResponse_checksumCRC32 :: Lens' PutObjectResponse (Maybe Text)
putObjectResponse_checksumCRC32C :: Lens' PutObjectResponse (Maybe Text)
putObjectResponse_checksumSHA1 :: Lens' PutObjectResponse (Maybe Text)
putObjectResponse_checksumSHA256 :: Lens' PutObjectResponse (Maybe Text)
putObjectResponse_eTag :: Lens' PutObjectResponse (Maybe ETag)
putObjectResponse_expiration :: Lens' PutObjectResponse (Maybe Text)
putObjectResponse_requestCharged :: Lens' PutObjectResponse (Maybe RequestCharged)
putObjectResponse_sSECustomerAlgorithm :: Lens' PutObjectResponse (Maybe Text)
putObjectResponse_sSECustomerKeyMD5 :: Lens' PutObjectResponse (Maybe Text)
putObjectResponse_sSEKMSEncryptionContext :: Lens' PutObjectResponse (Maybe Text)
putObjectResponse_sSEKMSKeyId :: Lens' PutObjectResponse (Maybe Text)
putObjectResponse_serverSideEncryption :: Lens' PutObjectResponse (Maybe ServerSideEncryption)
putObjectResponse_versionId :: Lens' PutObjectResponse (Maybe ObjectVersionId)
putObjectResponse_httpStatus :: Lens' PutObjectResponse Int

Creating a Request

data PutObject Source #

See: newPutObject smart constructor.

Constructors

PutObject'

Fields

acl :: Maybe ObjectCannedACL
The canned ACL to apply to the object. For more information, see Canned ACL.
This action is not supported by Amazon S3 on Outposts.
bucketKeyEnabled :: Maybe Bool
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.
cacheControl :: Maybe Text
Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
checksumAlgorithm :: Maybe ChecksumAlgorithm
Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
checksumCRC32 :: Maybe Text
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
checksumCRC32C :: Maybe Text
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
checksumSHA1 :: Maybe Text
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
checksumSHA256 :: Maybe Text
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
contentDisposition :: Maybe Text
Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.
contentEncoding :: 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. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.
contentLanguage :: Maybe Text
The language the content is in.
contentLength :: Maybe Integer
Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.
contentMD5 :: Maybe Text
The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.
contentType :: Maybe Text
A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.
expectedBucketOwner :: Maybe Text
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
expires :: Maybe RFC822
The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.
grantFullControl :: Maybe Text
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
This action is not supported by Amazon S3 on Outposts.
grantRead :: Maybe Text
Allows grantee to read the object data and its metadata.
This action is not supported by Amazon S3 on Outposts.
grantReadACP :: Maybe Text
Allows grantee to read the object ACL.
This action is not supported by Amazon S3 on Outposts.
grantWriteACP :: Maybe Text
Allows grantee to write the ACL for the applicable object.
This action is not supported by Amazon S3 on Outposts.
metadata :: HashMap Text Text
A map of metadata to store with the object in S3.
objectLockLegalHoldStatus :: Maybe ObjectLockLegalHoldStatus
Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.
objectLockMode :: Maybe ObjectLockMode
The Object Lock mode that you want to apply to this object.
objectLockRetainUntilDate :: Maybe ISO8601
The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.
requestPayer :: Maybe RequestPayer
sSECustomerAlgorithm :: Maybe Text
Specifies the algorithm to use to when encrypting the object (for example, AES256).
sSECustomerKey :: Maybe (Sensitive 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 S3 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.
sSECustomerKeyMD5 :: 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 that the encryption key was transmitted without error.
sSEKMSEncryptionContext :: Maybe (Sensitive Text)
Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
sSEKMSKeyId :: Maybe (Sensitive Text)
If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetrical customer managed key that was used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key to protect the data. If the KMS key does not exist in the same account issuing the command, you must use the full ARN and not just the ID.
serverSideEncryption :: Maybe ServerSideEncryption
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
storageClass :: Maybe StorageClass
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
tagging :: Maybe Text
The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
websiteRedirectLocation :: 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. For information about object metadata, see Object Key and Metadata.
In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:
```
x-amz-website-redirect-location: /anotherPage.html
```
In the following example, the request header sets the object redirect to another website:
```
x-amz-website-redirect-location: http://www.example.com/
```
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.
bucket :: BucketName
The bucket name to which the PUT action was initiated.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
key :: ObjectKey
Object key for which the PUT action was initiated.
body :: RequestBody
Object data.

Instances

Instances details

ToBody PutObject Source #
Instance details Defined in Amazonka.S3.PutObject Methods toBody :: PutObject -> RequestBody #
ToHeaders PutObject Source #
Instance details Defined in Amazonka.S3.PutObject Methods toHeaders :: PutObject -> [Header] #
ToPath PutObject Source #
Instance details Defined in Amazonka.S3.PutObject Methods toPath :: PutObject -> ByteString #
ToQuery PutObject Source #
Instance details Defined in Amazonka.S3.PutObject Methods toQuery :: PutObject -> QueryString #
AWSRequest PutObject Source #
Instance details Defined in Amazonka.S3.PutObject Associated Types type AWSResponse PutObject # Methods request :: (Service -> Service) -> PutObject -> Request PutObject # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutObject -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutObject))) #
Generic PutObject Source #
Instance details Defined in Amazonka.S3.PutObject Associated Types type Rep PutObject :: Type -> Type # Methods from :: PutObject -> Rep PutObject x # to :: Rep PutObject x -> PutObject #
Show PutObject Source #
Instance details Defined in Amazonka.S3.PutObject Methods showsPrec :: Int -> PutObject -> ShowS # show :: PutObject -> String # showList :: [PutObject] -> ShowS #
type AWSResponse PutObject Source #
Instance details Defined in Amazonka.S3.PutObject type AWSResponse PutObject = PutObjectResponse
type Rep PutObject Source #
Instance details Defined in Amazonka.S3.PutObject type Rep PutObject = D1 ('MetaData "PutObject" "Amazonka.S3.PutObject" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "PutObject'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "acl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectCannedACL)) :: S1 ('MetaSel ('Just "bucketKeyEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "cacheControl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "checksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChecksumAlgorithm)))) :: ((S1 ('MetaSel ('Just "checksumCRC32") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "checksumCRC32C") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "checksumSHA1") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "checksumSHA256") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "contentDisposition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "contentEncoding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "contentLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "contentLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "contentMD5") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "expires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RFC822)) :: (S1 ('MetaSel ('Just "grantFullControl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "grantRead") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))) :: ((((S1 ('MetaSel ('Just "grantReadACP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "grantWriteACP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)) :: S1 ('MetaSel ('Just "objectLockLegalHoldStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectLockLegalHoldStatus)))) :: ((S1 ('MetaSel ('Just "objectLockMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectLockMode)) :: S1 ('MetaSel ('Just "objectLockRetainUntilDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "requestPayer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestPayer)) :: (S1 ('MetaSel ('Just "sSECustomerAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sSECustomerKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))))) :: (((S1 ('MetaSel ('Just "sSECustomerKeyMD5") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sSEKMSEncryptionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "sSEKMSKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "serverSideEncryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServerSideEncryption)) :: S1 ('MetaSel ('Just "storageClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StorageClass))))) :: ((S1 ('MetaSel ('Just "tagging") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "websiteRedirectLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName) :: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectKey) :: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RequestBody))))))))

newPutObject Source #

Arguments

:: BucketName	`PutObject`
-> ObjectKey	`PutObject`
-> RequestBody	`$sel:body:PutObject'`
-> PutObject

Create a value of PutObject with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:acl:PutObject', putObject_acl - The canned ACL to apply to the object. For more information, see Canned ACL.

This action is not supported by Amazon S3 on Outposts.

PutObject, putObject_bucketKeyEnabled - Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

$sel:cacheControl:PutObject', putObject_cacheControl - Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

PutObject, putObject_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

PutObject, putObject_checksumCRC32 - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

PutObject, putObject_checksumCRC32C - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

PutObject, putObject_checksumSHA1 - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

PutObject, putObject_checksumSHA256 - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

$sel:contentDisposition:PutObject', putObject_contentDisposition - Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

$sel:contentEncoding:PutObject', putObject_contentEncoding - 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. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

$sel:contentLanguage:PutObject', putObject_contentLanguage - The language the content is in.

$sel:contentLength:PutObject', putObject_contentLength - Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

$sel:contentMD5:PutObject', putObject_contentMD5 - The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

$sel:contentType:PutObject', putObject_contentType - A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.

$sel:expectedBucketOwner:PutObject', putObject_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

$sel:expires:PutObject', putObject_expires - The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

$sel:grantFullControl:PutObject', putObject_grantFullControl - Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

$sel:grantRead:PutObject', putObject_grantRead - Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

$sel:grantReadACP:PutObject', putObject_grantReadACP - Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

$sel:grantWriteACP:PutObject', putObject_grantWriteACP - Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

$sel:metadata:PutObject', putObject_metadata - A map of metadata to store with the object in S3.

$sel:objectLockLegalHoldStatus:PutObject', putObject_objectLockLegalHoldStatus - Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

$sel:objectLockMode:PutObject', putObject_objectLockMode - The Object Lock mode that you want to apply to this object.

$sel:objectLockRetainUntilDate:PutObject', putObject_objectLockRetainUntilDate - The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.

$sel:requestPayer:PutObject', putObject_requestPayer - Undocumented member.

PutObject, putObject_sSECustomerAlgorithm - Specifies the algorithm to use to when encrypting the object (for example, AES256).

$sel:sSECustomerKey:PutObject', putObject_sSECustomerKey - 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 S3 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.

PutObject, putObject_sSECustomerKeyMD5 - 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 that the encryption key was transmitted without error.

PutObject, putObject_sSEKMSEncryptionContext - Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

PutObject, putObject_sSEKMSKeyId - If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetrical customer managed key that was used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key to protect the data. If the KMS key does not exist in the same account issuing the command, you must use the full ARN and not just the ID.

PutObject, putObject_serverSideEncryption - The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

PutObject, putObject_storageClass - By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

PutObject, putObject_tagging - The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

$sel:websiteRedirectLocation:PutObject', putObject_websiteRedirectLocation - 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. For information about object metadata, see Object Key and Metadata.

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

In the following example, the request header sets the object redirect to another website:

x-amz-website-redirect-location: http://www.example.com/

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

PutObject, putObject_bucket - The bucket name to which the PUT action was initiated.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

PutObject, putObject_key - Object key for which the PUT action was initiated.

$sel:body:PutObject', putObject_body - Object data.

Request Lenses

putObject_acl :: Lens' PutObject (Maybe ObjectCannedACL) Source #

The canned ACL to apply to the object. For more information, see Canned ACL.

This action is not supported by Amazon S3 on Outposts.

putObject_bucketKeyEnabled :: Lens' PutObject (Maybe Bool) Source #

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

putObject_cacheControl :: Lens' PutObject (Maybe Text) Source #

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

putObject_checksumAlgorithm :: Lens' PutObject (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putObject_checksumCRC32 :: Lens' PutObject (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

putObject_checksumCRC32C :: Lens' PutObject (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

putObject_checksumSHA1 :: Lens' PutObject (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

putObject_checksumSHA256 :: Lens' PutObject (Maybe Text) Source #

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

putObject_contentDisposition :: Lens' PutObject (Maybe Text) Source #

Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

putObject_contentEncoding :: 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. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

putObject_contentLanguage :: Lens' PutObject (Maybe Text) Source #

The language the content is in.

putObject_contentLength :: Lens' PutObject (Maybe Integer) Source #

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

putObject_contentMD5 :: Lens' PutObject (Maybe Text) Source #

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

putObject_contentType :: Lens' PutObject (Maybe Text) Source #

A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.

putObject_expectedBucketOwner :: Lens' PutObject (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putObject_expires :: Lens' PutObject (Maybe UTCTime) Source #

The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

putObject_grantFullControl :: Lens' PutObject (Maybe Text) Source #

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

This action is not supported by Amazon S3 on Outposts.

putObject_grantRead :: Lens' PutObject (Maybe Text) Source #

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

putObject_grantReadACP :: Lens' PutObject (Maybe Text) Source #

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

putObject_grantWriteACP :: Lens' PutObject (Maybe Text) Source #

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

putObject_metadata :: Lens' PutObject (HashMap Text Text) Source #

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

putObject_objectLockLegalHoldStatus :: Lens' PutObject (Maybe ObjectLockLegalHoldStatus) Source #

Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

putObject_objectLockMode :: Lens' PutObject (Maybe ObjectLockMode) Source #

The Object Lock mode that you want to apply to this object.

putObject_objectLockRetainUntilDate :: Lens' PutObject (Maybe UTCTime) Source #

The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.

putObject_requestPayer :: Lens' PutObject (Maybe RequestPayer) Source #

Undocumented member.

putObject_sSECustomerAlgorithm :: Lens' PutObject (Maybe Text) Source #

Specifies the algorithm to use to when encrypting the object (for example, AES256).

putObject_sSECustomerKey :: 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 S3 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.

putObject_sSECustomerKeyMD5 :: 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 that the encryption key was transmitted without error.

putObject_sSEKMSEncryptionContext :: Lens' PutObject (Maybe Text) Source #

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

putObject_sSEKMSKeyId :: Lens' PutObject (Maybe Text) Source #

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetrical customer managed key that was used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key to protect the data. If the KMS key does not exist in the same account issuing the command, you must use the full ARN and not just the ID.

putObject_serverSideEncryption :: Lens' PutObject (Maybe ServerSideEncryption) Source #

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

putObject_storageClass :: Lens' PutObject (Maybe StorageClass) Source #

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

putObject_tagging :: Lens' PutObject (Maybe Text) Source #

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

putObject_websiteRedirectLocation :: 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. For information about object metadata, see Object Key and Metadata.

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

In the following example, the request header sets the object redirect to another website:

x-amz-website-redirect-location: http://www.example.com/

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

putObject_bucket :: Lens' PutObject BucketName Source #

The bucket name to which the PUT action was initiated.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

putObject_key :: Lens' PutObject ObjectKey Source #

Object key for which the PUT action was initiated.

putObject_body :: Lens' PutObject RequestBody Source #

Object data.

Destructuring the Response

data PutObjectResponse Source #

See: newPutObjectResponse smart constructor.

Constructors

PutObjectResponse'

Fields

bucketKeyEnabled :: Maybe Bool
Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
checksumCRC32 :: Maybe Text
The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
checksumCRC32C :: Maybe Text
The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
checksumSHA1 :: Maybe Text
The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
checksumSHA256 :: Maybe Text
The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
eTag :: Maybe ETag
Entity tag for the uploaded object.
expiration :: Maybe Text
If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL-encoded.
requestCharged :: Maybe RequestCharged
sSECustomerAlgorithm :: 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.
sSECustomerKeyMD5 :: 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.
sSEKMSEncryptionContext :: Maybe (Sensitive Text)
If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
sSEKMSKeyId :: Maybe (Sensitive Text)
If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.
serverSideEncryption :: Maybe ServerSideEncryption
If you specified server-side encryption either with an Amazon Web Services KMS key or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.
versionId :: Maybe ObjectVersionId
Version of the object.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic PutObjectResponse Source #
Instance details Defined in Amazonka.S3.PutObject Associated Types type Rep PutObjectResponse :: Type -> Type # Methods from :: PutObjectResponse -> Rep PutObjectResponse x # to :: Rep PutObjectResponse x -> PutObjectResponse #
Show PutObjectResponse Source #
Instance details Defined in Amazonka.S3.PutObject Methods showsPrec :: Int -> PutObjectResponse -> ShowS # show :: PutObjectResponse -> String # showList :: [PutObjectResponse] -> ShowS #
NFData PutObjectResponse Source #
Instance details Defined in Amazonka.S3.PutObject Methods rnf :: PutObjectResponse -> () #
Eq PutObjectResponse Source #
Instance details Defined in Amazonka.S3.PutObject Methods (==) :: PutObjectResponse -> PutObjectResponse -> Bool # (/=) :: PutObjectResponse -> PutObjectResponse -> Bool #
type Rep PutObjectResponse Source #
Instance details Defined in Amazonka.S3.PutObject type Rep PutObjectResponse = D1 ('MetaData "PutObjectResponse" "Amazonka.S3.PutObject" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "PutObjectResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bucketKeyEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "checksumCRC32") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "checksumCRC32C") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "checksumSHA1") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "checksumSHA256") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "eTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ETag)) :: S1 ('MetaSel ('Just "expiration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "requestCharged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestCharged)) :: S1 ('MetaSel ('Just "sSECustomerAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sSECustomerKeyMD5") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sSEKMSEncryptionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: ((S1 ('MetaSel ('Just "sSEKMSKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "serverSideEncryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServerSideEncryption))) :: (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectVersionId)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newPutObjectResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutObjectResponse'`
-> PutObjectResponse

Create a value of PutObjectResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

PutObject, putObjectResponse_bucketKeyEnabled - Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

PutObject, putObjectResponse_checksumCRC32 - The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

PutObject, putObjectResponse_checksumCRC32C - The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

PutObject, putObjectResponse_checksumSHA1 - The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

PutObject, putObjectResponse_checksumSHA256 - The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

PutObjectResponse, putObjectResponse_eTag - Entity tag for the uploaded object.

PutObjectResponse, putObjectResponse_expiration - If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL-encoded.

$sel:requestCharged:PutObjectResponse', putObjectResponse_requestCharged - Undocumented member.

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

PutObject, putObjectResponse_sSECustomerKeyMD5 - 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.

PutObject, putObjectResponse_sSEKMSEncryptionContext - If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

PutObject, putObjectResponse_sSEKMSKeyId - If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

PutObject, putObjectResponse_serverSideEncryption - If you specified server-side encryption either with an Amazon Web Services KMS key or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.

PutObjectResponse, putObjectResponse_versionId - Version of the object.

$sel:httpStatus:PutObjectResponse', putObjectResponse_httpStatus - The response's http status code.

Response Lenses

putObjectResponse_bucketKeyEnabled :: Lens' PutObjectResponse (Maybe Bool) Source #

Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

putObjectResponse_checksumCRC32 :: Lens' PutObjectResponse (Maybe Text) Source #

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

putObjectResponse_checksumCRC32C :: Lens' PutObjectResponse (Maybe Text) Source #

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

putObjectResponse_checksumSHA1 :: Lens' PutObjectResponse (Maybe Text) Source #

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

putObjectResponse_checksumSHA256 :: Lens' PutObjectResponse (Maybe Text) Source #

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

putObjectResponse_eTag :: Lens' PutObjectResponse (Maybe ETag) Source #

Entity tag for the uploaded object.

putObjectResponse_expiration :: Lens' PutObjectResponse (Maybe Text) Source #

If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL-encoded.

putObjectResponse_requestCharged :: Lens' PutObjectResponse (Maybe RequestCharged) Source #

Undocumented member.

putObjectResponse_sSECustomerAlgorithm :: 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.

putObjectResponse_sSECustomerKeyMD5 :: 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.

putObjectResponse_sSEKMSEncryptionContext :: Lens' PutObjectResponse (Maybe Text) Source #

If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

putObjectResponse_sSEKMSKeyId :: Lens' PutObjectResponse (Maybe Text) Source #

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

putObjectResponse_serverSideEncryption :: Lens' PutObjectResponse (Maybe ServerSideEncryption) Source #

If you specified server-side encryption either with an Amazon Web Services KMS key or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.

putObjectResponse_versionId :: Lens' PutObjectResponse (Maybe ObjectVersionId) Source #

Version of the object.

putObjectResponse_httpStatus :: Lens' PutObjectResponse Int Source #

The response's http status code.