amazonka-s3-2.0: Amazon Simple Storage Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.S3.CreateMultipartUpload

Description

This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request.

For more information about multipart uploads, see Multipart Upload Overview.

If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

For information about the permissions required to use the multipart upload API, see Multipart Upload and Permissions.

For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4).

After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.

You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload.

To perform a multipart upload with encryption using an Amazon Web Services KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions in the Amazon S3 User Guide.

If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.

For more information, see Protecting Data Using Server-Side Encryption.

Access Permissions
When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:
  • Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL.
  • Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Server-Side- Encryption-Specific Request Headers
You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use Amazon Web Services managed encryption keys or provide your own encryption key.

  • Use encryption keys managed by Amazon S3 or customer managed key stored in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request.

    • x-amz-server-side-encryption
    • x-amz-server-side-encryption-aws-kms-key-id
    • x-amz-server-side-encryption-context

    If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key in Amazon Web Services KMS to protect the data.

    All GET and PUT requests for an object protected by Amazon Web Services KMS fail if you don't make them with SSL or by using SigV4.

    For more information about server-side encryption with KMS key (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys.

  • Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.

    • x-amz-server-side-encryption-customer-algorithm
    • x-amz-server-side-encryption-customer-key
    • x-amz-server-side-encryption-customer-key-MD5

    For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys.

Access-Control-List (ACL)-Specific Request Headers
You also can use the following access control–related headers with this operation. 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 access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:
  • Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.

  • Specify access permissions explicitly — To explicitly grant access permissions to specific Amazon Web Services accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:

    • x-amz-grant-read
    • x-amz-grant-write
    • x-amz-grant-read-acp
    • x-amz-grant-write-acp
    • x-amz-grant-full-control

    You specify each grantee as a type=value pair, where the type is one of the following:

    • id – if the value specified is the canonical user ID of an Amazon Web Services account
    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an Amazon Web Services account

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      • US East (N. Virginia)
      • US West (N. California)
      • US West (Oregon)
      • Asia Pacific (Singapore)
      • Asia Pacific (Sydney)
      • Asia Pacific (Tokyo)
      • Europe (Ireland)
      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    x-amz-grant-read: id="11112222333", id="444455556666"

The following operations are related to CreateMultipartUpload:

Synopsis

Creating a Request

data CreateMultipartUpload Source #

See: newCreateMultipartUpload smart constructor.

Constructors

CreateMultipartUpload' 

Fields

  • acl :: Maybe ObjectCannedACL

    The canned ACL to apply to the object.

    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 an object action doesn’t affect bucket-level settings for S3 Bucket Key.

  • cacheControl :: Maybe Text

    Specifies caching behavior along the request/reply chain.

  • checksumAlgorithm :: Maybe ChecksumAlgorithm

    Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

  • contentDisposition :: Maybe Text

    Specifies presentational information for the object.

  • 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.

  • contentLanguage :: Maybe Text

    The language the content is in.

  • contentType :: Maybe Text

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

  • 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.

  • 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 you want to apply a legal hold to the uploaded object.

  • objectLockMode :: Maybe ObjectLockMode

    Specifies the Object Lock mode that you want to apply to the uploaded object.

  • objectLockRetainUntilDate :: Maybe ISO8601

    Specifies the date and time when you want the Object Lock to expire.

  • 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)

    Specifies the ID of the symmetric customer managed key to use for object encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

  • 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.

  • 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.

  • bucket :: BucketName

    The name of the bucket to which to initiate the upload

    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 multipart upload is to be initiated.

Instances

Instances details
ToHeaders CreateMultipartUpload Source # 
Instance details

Defined in Amazonka.S3.CreateMultipartUpload

Methods

toHeaders :: CreateMultipartUpload -> [Header] #

ToPath CreateMultipartUpload Source # 
Instance details

Defined in Amazonka.S3.CreateMultipartUpload

Methods

toPath :: CreateMultipartUpload -> ByteString #

ToQuery CreateMultipartUpload Source # 
Instance details

Defined in Amazonka.S3.CreateMultipartUpload

Methods

toQuery :: CreateMultipartUpload -> QueryString #

AWSRequest CreateMultipartUpload Source # 
Instance details

Defined in Amazonka.S3.CreateMultipartUpload

Associated Types

type AWSResponse CreateMultipartUpload #

Methods

request :: (Service -> Service) -> CreateMultipartUpload -> Request CreateMultipartUpload #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateMultipartUpload -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateMultipartUpload))) #

Generic CreateMultipartUpload Source # 
Instance details

Defined in Amazonka.S3.CreateMultipartUpload

Associated Types

type Rep CreateMultipartUpload :: Type -> Type #

Methods

from :: CreateMultipartUpload -> Rep CreateMultipartUpload x #

to :: Rep CreateMultipartUpload x -> CreateMultipartUpload #

Show CreateMultipartUpload Source # 
Instance details

Defined in Amazonka.S3.CreateMultipartUpload

Methods

showsPrec :: Int -> CreateMultipartUpload -> ShowS #

show :: CreateMultipartUpload -> String #

showList :: [CreateMultipartUpload] -> ShowS #

NFData CreateMultipartUpload Source # 
Instance details

Defined in Amazonka.S3.CreateMultipartUpload

Methods

rnf :: CreateMultipartUpload -> () #

Eq CreateMultipartUpload Source # 
Instance details

Defined in Amazonka.S3.CreateMultipartUpload

Methods

(==) :: CreateMultipartUpload -> CreateMultipartUpload -> Bool #

(/=) :: CreateMultipartUpload -> CreateMultipartUpload -> Bool #

Hashable CreateMultipartUpload Source # 
Instance details

Defined in Amazonka.S3.CreateMultipartUpload

Methods

hashWithSalt :: Int -> CreateMultipartUpload -> Int #

hash :: CreateMultipartUpload -> Int #

type AWSResponse CreateMultipartUpload Source # 
Instance details

Defined in Amazonka.S3.CreateMultipartUpload

type AWSResponse CreateMultipartUpload = CreateMultipartUploadResponse
type Rep CreateMultipartUpload Source # 
Instance details

Defined in Amazonka.S3.CreateMultipartUpload

type Rep CreateMultipartUpload = D1 ('MetaData "CreateMultipartUpload" "Amazonka.S3.CreateMultipartUpload" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "CreateMultipartUpload'" '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 "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 "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)))))))

newCreateMultipartUpload Source #

Arguments

:: BucketName

CreateMultipartUpload

-> ObjectKey

CreateMultipartUpload

-> CreateMultipartUpload 

Create a value of CreateMultipartUpload 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:CreateMultipartUpload', createMultipartUpload_acl - The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

CreateMultipartUpload, createMultipartUpload_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 an object action doesn’t affect bucket-level settings for S3 Bucket Key.

$sel:cacheControl:CreateMultipartUpload', createMultipartUpload_cacheControl - Specifies caching behavior along the request/reply chain.

CreateMultipartUpload, createMultipartUpload_checksumAlgorithm - Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

$sel:contentDisposition:CreateMultipartUpload', createMultipartUpload_contentDisposition - Specifies presentational information for the object.

$sel:contentEncoding:CreateMultipartUpload', createMultipartUpload_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.

$sel:contentLanguage:CreateMultipartUpload', createMultipartUpload_contentLanguage - The language the content is in.

$sel:contentType:CreateMultipartUpload', createMultipartUpload_contentType - A standard MIME type describing the format of the object data.

$sel:expectedBucketOwner:CreateMultipartUpload', createMultipartUpload_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:CreateMultipartUpload', createMultipartUpload_expires - The date and time at which the object is no longer cacheable.

$sel:grantFullControl:CreateMultipartUpload', createMultipartUpload_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:CreateMultipartUpload', createMultipartUpload_grantRead - Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

$sel:grantReadACP:CreateMultipartUpload', createMultipartUpload_grantReadACP - Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

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

This action is not supported by Amazon S3 on Outposts.

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

$sel:objectLockLegalHoldStatus:CreateMultipartUpload', createMultipartUpload_objectLockLegalHoldStatus - Specifies whether you want to apply a legal hold to the uploaded object.

$sel:objectLockMode:CreateMultipartUpload', createMultipartUpload_objectLockMode - Specifies the Object Lock mode that you want to apply to the uploaded object.

$sel:objectLockRetainUntilDate:CreateMultipartUpload', createMultipartUpload_objectLockRetainUntilDate - Specifies the date and time when you want the Object Lock to expire.

$sel:requestPayer:CreateMultipartUpload', createMultipartUpload_requestPayer - Undocumented member.

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

$sel:sSECustomerKey:CreateMultipartUpload', createMultipartUpload_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.

CreateMultipartUpload, createMultipartUpload_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.

CreateMultipartUpload, createMultipartUpload_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.

CreateMultipartUpload, createMultipartUpload_sSEKMSKeyId - Specifies the ID of the symmetric customer managed key to use for object encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

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

CreateMultipartUpload, createMultipartUpload_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.

CreateMultipartUpload, createMultipartUpload_tagging - The tag-set for the object. The tag-set must be encoded as URL Query parameters.

$sel:websiteRedirectLocation:CreateMultipartUpload', createMultipartUpload_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.

CreateMultipartUpload, createMultipartUpload_bucket - The name of the bucket to which to initiate the upload

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.

CreateMultipartUpload, createMultipartUpload_key - Object key for which the multipart upload is to be initiated.

Request Lenses

createMultipartUpload_acl :: Lens' CreateMultipartUpload (Maybe ObjectCannedACL) Source #

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

createMultipartUpload_bucketKeyEnabled :: Lens' CreateMultipartUpload (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 an object action doesn’t affect bucket-level settings for S3 Bucket Key.

createMultipartUpload_cacheControl :: Lens' CreateMultipartUpload (Maybe Text) Source #

Specifies caching behavior along the request/reply chain.

createMultipartUpload_checksumAlgorithm :: Lens' CreateMultipartUpload (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

createMultipartUpload_contentDisposition :: Lens' CreateMultipartUpload (Maybe Text) Source #

Specifies presentational information for the object.

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

createMultipartUpload_contentLanguage :: Lens' CreateMultipartUpload (Maybe Text) Source #

The language the content is in.

createMultipartUpload_contentType :: Lens' CreateMultipartUpload (Maybe Text) Source #

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

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

createMultipartUpload_expires :: Lens' CreateMultipartUpload (Maybe UTCTime) Source #

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

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

createMultipartUpload_grantRead :: Lens' CreateMultipartUpload (Maybe Text) Source #

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

createMultipartUpload_grantReadACP :: Lens' CreateMultipartUpload (Maybe Text) Source #

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

createMultipartUpload_grantWriteACP :: Lens' CreateMultipartUpload (Maybe Text) Source #

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

createMultipartUpload_metadata :: Lens' CreateMultipartUpload (HashMap Text Text) Source #

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

createMultipartUpload_objectLockLegalHoldStatus :: Lens' CreateMultipartUpload (Maybe ObjectLockLegalHoldStatus) Source #

Specifies whether you want to apply a legal hold to the uploaded object.

createMultipartUpload_objectLockMode :: Lens' CreateMultipartUpload (Maybe ObjectLockMode) Source #

Specifies the Object Lock mode that you want to apply to the uploaded object.

createMultipartUpload_objectLockRetainUntilDate :: Lens' CreateMultipartUpload (Maybe UTCTime) Source #

Specifies the date and time when you want the Object Lock to expire.

createMultipartUpload_requestPayer :: Lens' CreateMultipartUpload (Maybe RequestPayer) Source #

Undocumented member.

createMultipartUpload_sSECustomerAlgorithm :: Lens' CreateMultipartUpload (Maybe Text) Source #

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

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

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

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

createMultipartUpload_sSEKMSKeyId :: Lens' CreateMultipartUpload (Maybe Text) Source #

Specifies the ID of the symmetric customer managed key to use for object encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

createMultipartUpload_serverSideEncryption :: Lens' CreateMultipartUpload (Maybe ServerSideEncryption) Source #

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

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

createMultipartUpload_tagging :: Lens' CreateMultipartUpload (Maybe Text) Source #

The tag-set for the object. The tag-set must be encoded as URL Query parameters.

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

createMultipartUpload_bucket :: Lens' CreateMultipartUpload BucketName Source #

The name of the bucket to which to initiate the upload

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.

createMultipartUpload_key :: Lens' CreateMultipartUpload ObjectKey Source #

Object key for which the multipart upload is to be initiated.

Destructuring the Response

data CreateMultipartUploadResponse Source #

See: newCreateMultipartUploadResponse smart constructor.

Constructors

CreateMultipartUploadResponse' 

Fields

  • abortDate :: Maybe RFC822

    If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

    The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines this action.

  • abortRuleId :: Maybe Text

    This header is returned along with the x-amz-abort-date header. It identifies the applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

  • bucket :: Maybe BucketName

    The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

    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.

  • bucketKeyEnabled :: Maybe Bool

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

  • checksumAlgorithm :: Maybe ChecksumAlgorithm

    The algorithm that was used to create a checksum of the object.

  • key :: Maybe ObjectKey

    Object key for which the multipart upload was initiated.

  • 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 present, 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

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

  • httpStatus :: Int

    The response's http status code.

  • uploadId :: Text

    ID for the initiated multipart upload.

Instances

Instances details
Generic CreateMultipartUploadResponse Source # 
Instance details

Defined in Amazonka.S3.CreateMultipartUpload

Associated Types

type Rep CreateMultipartUploadResponse :: Type -> Type #

Methods

from :: CreateMultipartUploadResponse -> Rep CreateMultipartUploadResponse x #

to :: Rep CreateMultipartUploadResponse x -> CreateMultipartUploadResponse #

Show CreateMultipartUploadResponse Source # 
Instance details

Defined in Amazonka.S3.CreateMultipartUpload

Methods

showsPrec :: Int -> CreateMultipartUploadResponse -> ShowS #

show :: CreateMultipartUploadResponse -> String #

showList :: [CreateMultipartUploadResponse] -> ShowS #

NFData CreateMultipartUploadResponse Source # 
Instance details

Defined in Amazonka.S3.CreateMultipartUpload

Methods

rnf :: CreateMultipartUploadResponse -> () #

Eq CreateMultipartUploadResponse Source # 
Instance details

Defined in Amazonka.S3.CreateMultipartUpload

Methods

(==) :: CreateMultipartUploadResponse -> CreateMultipartUploadResponse -> Bool #

(/=) :: CreateMultipartUploadResponse -> CreateMultipartUploadResponse -> Bool #

type Rep CreateMultipartUploadResponse Source # 
Instance details

Defined in Amazonka.S3.CreateMultipartUpload

type Rep CreateMultipartUploadResponse = D1 ('MetaData "CreateMultipartUploadResponse" "Amazonka.S3.CreateMultipartUpload" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "CreateMultipartUploadResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "abortDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RFC822)) :*: (S1 ('MetaSel ('Just "abortRuleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketName)))) :*: ((S1 ('MetaSel ('Just "bucketKeyEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "checksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChecksumAlgorithm))) :*: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectKey)) :*: 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 "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "uploadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateMultipartUploadResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateMultipartUploadResponse'

-> Text

CreateMultipartUploadResponse

-> CreateMultipartUploadResponse 

Create a value of CreateMultipartUploadResponse 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:abortDate:CreateMultipartUploadResponse', createMultipartUploadResponse_abortDate - If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines this action.

$sel:abortRuleId:CreateMultipartUploadResponse', createMultipartUploadResponse_abortRuleId - This header is returned along with the x-amz-abort-date header. It identifies the applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

CreateMultipartUpload, createMultipartUploadResponse_bucket - The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

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.

CreateMultipartUpload, createMultipartUploadResponse_bucketKeyEnabled - Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

CreateMultipartUpload, createMultipartUploadResponse_checksumAlgorithm - The algorithm that was used to create a checksum of the object.

CreateMultipartUpload, createMultipartUploadResponse_key - Object key for which the multipart upload was initiated.

$sel:requestCharged:CreateMultipartUploadResponse', createMultipartUploadResponse_requestCharged - Undocumented member.

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

CreateMultipartUpload, createMultipartUploadResponse_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.

CreateMultipartUpload, createMultipartUploadResponse_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.

CreateMultipartUpload, createMultipartUploadResponse_sSEKMSKeyId - If present, 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.

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

$sel:httpStatus:CreateMultipartUploadResponse', createMultipartUploadResponse_httpStatus - The response's http status code.

CreateMultipartUploadResponse, createMultipartUploadResponse_uploadId - ID for the initiated multipart upload.

Response Lenses

createMultipartUploadResponse_abortDate :: Lens' CreateMultipartUploadResponse (Maybe UTCTime) Source #

If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines this action.

createMultipartUploadResponse_abortRuleId :: Lens' CreateMultipartUploadResponse (Maybe Text) Source #

This header is returned along with the x-amz-abort-date header. It identifies the applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

createMultipartUploadResponse_bucket :: Lens' CreateMultipartUploadResponse (Maybe BucketName) Source #

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

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.

createMultipartUploadResponse_bucketKeyEnabled :: Lens' CreateMultipartUploadResponse (Maybe Bool) Source #

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

createMultipartUploadResponse_checksumAlgorithm :: Lens' CreateMultipartUploadResponse (Maybe ChecksumAlgorithm) Source #

The algorithm that was used to create a checksum of the object.

createMultipartUploadResponse_key :: Lens' CreateMultipartUploadResponse (Maybe ObjectKey) Source #

Object key for which the multipart upload was initiated.

createMultipartUploadResponse_requestCharged :: Lens' CreateMultipartUploadResponse (Maybe RequestCharged) Source #

Undocumented member.

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

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

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

createMultipartUploadResponse_sSEKMSKeyId :: Lens' CreateMultipartUploadResponse (Maybe Text) Source #

If present, 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.

createMultipartUploadResponse_serverSideEncryption :: Lens' CreateMultipartUploadResponse (Maybe ServerSideEncryption) Source #

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

createMultipartUploadResponse_httpStatus :: Lens' CreateMultipartUploadResponse Int Source #

The response's http status code.

createMultipartUploadResponse_uploadId :: Lens' CreateMultipartUploadResponse Text Source #

ID for the initiated multipart upload.