CreateMultipartUpload

CreateMultipartUpload #

Overview #

This operation 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.

AWS API Reference: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html

Method #

CREATEMULTIPARTUPLOAD

Import Parameters #

The request uses the following import parameters.

  • i_bucket_name (bucket in AWS) (Required)

    Name of the bucket.

  • i_region (Required)

    AWS Region of the Amazon S3 Bucket.

  • i_cachecontrol (Cache-Control in AWS)

    Specifies caching behavior along the request/reply chain.

  • i_contentdisposition (Content-Disposition in AWS)

    Specifies presentational information for the object.

  • i_contentencoding (Content-Encoding in AWS)

    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.

  • i_contentlanguage (Content-Language in AWS)

    The language the content is in.

  • i_contenttype (Content-Type in AWS)

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

  • i_expires (Expiresin AWS)

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

  • i_key (Required)

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

  • i_x_amz_acl (x-amz-acl in AWS)

    The canned ACL to apply to the object.

  • i_x_amz_expected_b_owner ( x-amz-expected-bucket-owner in AWS)

    The account id of the expected bucket owner.

  • i_x_amz_grant_full_control (x-amz-grant-full-control in AWS)

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

  • i_x_amz_grant_read (x-amz-grant-read in AWS)

    Allows grantee to read the object data and its metadata.

  • i_x_amz_grant_read_acp (x-amz-grant-read-acp in AWS)

    Allows grantee to read the object ACL.

  • i_x_amz_grant_write_acp (x-amz-grant-write-acp in AWS)

    Allows grantee to write the ACL for the applicable object.

  • i_x_amz_object_lock_legal_hold (x-amz-object-lock-legal-hold in AWS)

    Specifies whether you want to apply a Legal Hold to the uploaded object.

  • i_x_amz_object_lock_mode (x-amz-object-lock-mode in AWS)

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

  • i_x_amz_object_lock_retain_unt (x-amz-object-lock-retain-until-date in AWS)

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

  • i_x_amz_request_payer (x-amz-request-payer in AWS)

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests.

  • i_x_amz_server_side_encryption (x-amz-server-side-encryption in AWS)

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

  • i_x_amz_server_side_kms_key_id (x-amz-server-side-encryption-aws-kms-key-id in AWS)

    Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object encryption.

  • i_x_amz_server_side_enc_contex (x-amz-server-side-encryption-context in AWS)

    Specifies the AWS 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.

  • i_x_amz_server_custom_algorit (x-amz-server-side-encryption-customer-algorithm in AWS)

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

  • i_x_amz_server_custom_key (x-amz-server-side-encryption-customer-key in AWS)

    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.

  • i_x_amz_server_custom_key_md5 (x-amz-server-side-encryption-customer-algorithm in AWS)

    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.

  • i_x_amz_storage_class (x-amz-storage-class in AWS)

    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.

  • i_x_amz_tagging (x-amz-tagging in AWS)

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

  • i_x_amz_website_redirect_locat (x-amz-website-redirect-location in AWS)

    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.


Export Parameters #

This method use the following export parameters:

  • e_http_status

    HTTP Status code.

  • e_response_headers

    Returns information about the request in format Name/Value pair values.

  • e_response_content

    Response content in string format.

  • e_bucket (Bucket in AWS)

    The name of the bucket to which the multipart upload was initiated.

  • e_key (Key in AWS)

    Object key for which the multipart upload was initiated.

  • e_uploadid (UploadId in AWS)

    ID for the initiated multipart upload.