Network.AWS.S3.CreateMultipartUpload

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.

Creating a Request

createMultipartUpload

Arguments

:: BucketName

cmuBucket

-> ObjectKey

cmuKey

-> CreateMultipartUpload

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

See: createMultipartUpload smart constructor.

Instances

Eq CreateMultipartUpload

Data CreateMultipartUpload

Read CreateMultipartUpload

Show CreateMultipartUpload

Generic CreateMultipartUpload

AWSRequest CreateMultipartUpload

ToPath CreateMultipartUpload

ToHeaders CreateMultipartUpload

ToQuery CreateMultipartUpload

type Rep CreateMultipartUpload

type Rs CreateMultipartUpload = CreateMultipartUploadResponse

Request Lenses

cmuExpires :: Lens' CreateMultipartUpload (Maybe UTCTime)

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

cmuGrantReadACP :: Lens' CreateMultipartUpload (Maybe Text)

Allows grantee to read the object ACL.

cmuSSECustomerAlgorithm :: Lens' CreateMultipartUpload (Maybe Text)

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

cmuSSECustomerKey :: Lens' CreateMultipartUpload (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.

cmuRequestPayer :: Lens' CreateMultipartUpload (Maybe RequestPayer)

Undocumented member.

cmuGrantWriteACP :: Lens' CreateMultipartUpload (Maybe Text)

Allows grantee to write the ACL for the applicable object.

cmuWebsiteRedirectLocation :: Lens' CreateMultipartUpload (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.

cmuGrantRead :: Lens' CreateMultipartUpload (Maybe Text)

Allows grantee to read the object data and its metadata.

cmuStorageClass :: Lens' CreateMultipartUpload (Maybe StorageClass)

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

cmuSSECustomerKeyMD5 :: Lens' CreateMultipartUpload (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.

cmuSSEKMSKeyId :: Lens' CreateMultipartUpload (Maybe Text)

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)

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

cmuContentEncoding :: Lens' CreateMultipartUpload (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.

cmuMetadata :: Lens' CreateMultipartUpload (HashMap Text Text)

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

cmuCacheControl :: Lens' CreateMultipartUpload (Maybe Text)

Specifies caching behavior along the request/reply chain.

cmuContentLanguage :: Lens' CreateMultipartUpload (Maybe Text)

The language the content is in.

cmuACL :: Lens' CreateMultipartUpload (Maybe ObjectCannedACL)

The canned ACL to apply to the object.

cmuContentDisposition :: Lens' CreateMultipartUpload (Maybe Text)

Specifies presentational information for the object.

cmuServerSideEncryption :: Lens' CreateMultipartUpload (Maybe ServerSideEncryption)

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

cmuContentType :: Lens' CreateMultipartUpload (Maybe Text)

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

cmuBucket :: Lens' CreateMultipartUpload BucketName

Undocumented member.

cmuKey :: Lens' CreateMultipartUpload ObjectKey

Undocumented member.

Destructuring the Response

createMultipartUploadResponse

Arguments

:: Int

cmursResponseStatus

-> CreateMultipartUploadResponse

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:

• cmursRequestCharged
• cmursBucket
• cmursSSECustomerAlgorithm
• cmursKey
• cmursSSECustomerKeyMD5
• cmursSSEKMSKeyId
• cmursUploadId
• cmursServerSideEncryption
• cmursResponseStatus

data CreateMultipartUploadResponse

See: createMultipartUploadResponse smart constructor.

Instances

Eq CreateMultipartUploadResponse

Data CreateMultipartUploadResponse

Read CreateMultipartUploadResponse

Show CreateMultipartUploadResponse

Generic CreateMultipartUploadResponse

type Rep CreateMultipartUploadResponse

Response Lenses

cmursRequestCharged :: Lens' CreateMultipartUploadResponse (Maybe RequestCharged)

Undocumented member.

cmursBucket :: Lens' CreateMultipartUploadResponse (Maybe BucketName)

Name of the bucket to which the multipart upload was initiated.

cmursSSECustomerAlgorithm :: Lens' CreateMultipartUploadResponse (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.

cmursKey :: Lens' CreateMultipartUploadResponse (Maybe ObjectKey)

Object key for which the multipart upload was initiated.

cmursSSECustomerKeyMD5 :: Lens' CreateMultipartUploadResponse (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.

cmursSSEKMSKeyId :: Lens' CreateMultipartUploadResponse (Maybe Text)

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)

ID for the initiated multipart upload.

cmursServerSideEncryption :: Lens' CreateMultipartUploadResponse (Maybe ServerSideEncryption)

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

cmursResponseStatus :: Lens' CreateMultipartUploadResponse Int

The response status code.