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 |
Initiates a multipart upload and returns an upload ID.
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
See: AWS API Reference for CreateMultipartUpload.
- createMultipartUpload :: BucketName -> ObjectKey -> CreateMultipartUpload
- data CreateMultipartUpload
- cmuExpires :: Lens' CreateMultipartUpload (Maybe UTCTime)
- cmuGrantReadACP :: Lens' CreateMultipartUpload (Maybe Text)
- cmuSSECustomerAlgorithm :: Lens' CreateMultipartUpload (Maybe Text)
- cmuSSECustomerKey :: Lens' CreateMultipartUpload (Maybe Text)
- cmuRequestPayer :: Lens' CreateMultipartUpload (Maybe RequestPayer)
- cmuGrantWriteACP :: Lens' CreateMultipartUpload (Maybe Text)
- cmuWebsiteRedirectLocation :: Lens' CreateMultipartUpload (Maybe Text)
- cmuGrantRead :: Lens' CreateMultipartUpload (Maybe Text)
- cmuStorageClass :: Lens' CreateMultipartUpload (Maybe StorageClass)
- cmuSSECustomerKeyMD5 :: Lens' CreateMultipartUpload (Maybe Text)
- cmuSSEKMSKeyId :: Lens' CreateMultipartUpload (Maybe Text)
- cmuGrantFullControl :: Lens' CreateMultipartUpload (Maybe Text)
- cmuContentEncoding :: Lens' CreateMultipartUpload (Maybe Text)
- cmuMetadata :: Lens' CreateMultipartUpload (HashMap Text Text)
- cmuCacheControl :: Lens' CreateMultipartUpload (Maybe Text)
- cmuContentLanguage :: Lens' CreateMultipartUpload (Maybe Text)
- cmuACL :: Lens' CreateMultipartUpload (Maybe ObjectCannedACL)
- cmuContentDisposition :: Lens' CreateMultipartUpload (Maybe Text)
- cmuServerSideEncryption :: Lens' CreateMultipartUpload (Maybe ServerSideEncryption)
- cmuContentType :: Lens' CreateMultipartUpload (Maybe Text)
- cmuBucket :: Lens' CreateMultipartUpload BucketName
- cmuKey :: Lens' CreateMultipartUpload ObjectKey
- createMultipartUploadResponse :: Int -> CreateMultipartUploadResponse
- data CreateMultipartUploadResponse
- cmursRequestCharged :: Lens' CreateMultipartUploadResponse (Maybe RequestCharged)
- cmursBucket :: Lens' CreateMultipartUploadResponse (Maybe BucketName)
- cmursSSECustomerAlgorithm :: Lens' CreateMultipartUploadResponse (Maybe Text)
- cmursKey :: Lens' CreateMultipartUploadResponse (Maybe ObjectKey)
- cmursSSECustomerKeyMD5 :: Lens' CreateMultipartUploadResponse (Maybe Text)
- cmursSSEKMSKeyId :: Lens' CreateMultipartUploadResponse (Maybe Text)
- cmursUploadId :: Lens' CreateMultipartUploadResponse (Maybe Text)
- cmursServerSideEncryption :: Lens' CreateMultipartUploadResponse (Maybe ServerSideEncryption)
- cmursResponseStatus :: Lens' CreateMultipartUploadResponse Int
Creating a Request
Creates a value of CreateMultipartUpload
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cmuExpires
cmuGrantReadACP
cmuSSECustomerAlgorithm
cmuSSECustomerKey
cmuRequestPayer
cmuGrantWriteACP
cmuWebsiteRedirectLocation
cmuGrantRead
cmuStorageClass
cmuSSECustomerKeyMD5
cmuSSEKMSKeyId
cmuGrantFullControl
cmuContentEncoding
cmuMetadata
cmuCacheControl
cmuContentLanguage
cmuACL
cmuContentDisposition
cmuServerSideEncryption
cmuContentType
cmuBucket
cmuKey
data CreateMultipartUpload Source
See: createMultipartUpload
smart constructor.
Request Lenses
cmuExpires :: Lens' CreateMultipartUpload (Maybe UTCTime) Source
The date and time at which the object is no longer cacheable.
cmuGrantReadACP :: Lens' CreateMultipartUpload (Maybe Text) Source
Allows grantee to read the object ACL.
cmuSSECustomerAlgorithm :: Lens' CreateMultipartUpload (Maybe Text) Source
Specifies the algorithm to use to when encrypting the object (e.g., AES256).
cmuSSECustomerKey :: Lens' CreateMultipartUpload (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.
cmuRequestPayer :: Lens' CreateMultipartUpload (Maybe RequestPayer) Source
Undocumented member.
cmuGrantWriteACP :: Lens' CreateMultipartUpload (Maybe Text) Source
Allows grantee to write the ACL for the applicable object.
cmuWebsiteRedirectLocation :: Lens' CreateMultipartUpload (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.
cmuGrantRead :: Lens' CreateMultipartUpload (Maybe Text) Source
Allows grantee to read the object data and its metadata.
cmuStorageClass :: Lens' CreateMultipartUpload (Maybe StorageClass) Source
The type of storage to use for the object. Defaults to 'STANDARD'.
cmuSSECustomerKeyMD5 :: Lens' CreateMultipartUpload (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.
cmuSSEKMSKeyId :: Lens' CreateMultipartUpload (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
cmuGrantFullControl :: Lens' CreateMultipartUpload (Maybe Text) Source
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
cmuContentEncoding :: Lens' CreateMultipartUpload (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.
cmuMetadata :: Lens' CreateMultipartUpload (HashMap Text Text) Source
A map of metadata to store with the object in S3.
cmuCacheControl :: Lens' CreateMultipartUpload (Maybe Text) Source
Specifies caching behavior along the request/reply chain.
cmuContentLanguage :: Lens' CreateMultipartUpload (Maybe Text) Source
The language the content is in.
cmuACL :: Lens' CreateMultipartUpload (Maybe ObjectCannedACL) Source
The canned ACL to apply to the object.
cmuContentDisposition :: Lens' CreateMultipartUpload (Maybe Text) Source
Specifies presentational information for the object.
cmuServerSideEncryption :: Lens' CreateMultipartUpload (Maybe ServerSideEncryption) Source
The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
cmuContentType :: Lens' CreateMultipartUpload (Maybe Text) Source
A standard MIME type describing the format of the object data.
cmuBucket :: Lens' CreateMultipartUpload BucketName Source
Undocumented member.
cmuKey :: Lens' CreateMultipartUpload ObjectKey Source
Undocumented member.
Destructuring the Response
createMultipartUploadResponse Source
Creates a value of CreateMultipartUploadResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreateMultipartUploadResponse Source
See: createMultipartUploadResponse
smart constructor.
Response Lenses
cmursRequestCharged :: Lens' CreateMultipartUploadResponse (Maybe RequestCharged) Source
Undocumented member.
cmursBucket :: Lens' CreateMultipartUploadResponse (Maybe BucketName) Source
Name of the bucket to which the multipart upload was initiated.
cmursSSECustomerAlgorithm :: Lens' CreateMultipartUploadResponse (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.
cmursKey :: Lens' CreateMultipartUploadResponse (Maybe ObjectKey) Source
Object key for which the multipart upload was initiated.
cmursSSECustomerKeyMD5 :: Lens' CreateMultipartUploadResponse (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.
cmursSSEKMSKeyId :: Lens' CreateMultipartUploadResponse (Maybe Text) Source
If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
cmursUploadId :: Lens' CreateMultipartUploadResponse (Maybe Text) Source
ID for the initiated multipart upload.
cmursServerSideEncryption :: Lens' CreateMultipartUploadResponse (Maybe ServerSideEncryption) Source
The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
cmursResponseStatus :: Lens' CreateMultipartUploadResponse Int Source
The response status code.