paws.storage (version 0.1.11)

s3_complete_multipart_upload: Completes a multipart upload by assembling previously uploaded parts

Description

Completes a multipart upload by assembling previously uploaded parts.

You first initiate the multipart upload and then upload all parts using the upload_part operation. After successfully uploading all relevant parts of an upload, you call this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This operation concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the ETag value, returned after that part was uploaded.

Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded.

Note that if complete_multipart_upload fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices.

For more information about multipart uploads, see Uploading Objects Using Multipart Upload.

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

complete_multipart_upload has the following special errors:

• Error code: EntityTooSmall

  • Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.

  • 400 Bad Request

• Error code: InvalidPart

  • Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.

  • 400 Bad Request

• Error code: InvalidPartOrder

  • Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.

  • 400 Bad Request

• Error code: NoSuchUpload

  • Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

  • 404 Not Found

The following operations are related to complete_multipart_upload:

• create_multipart_upload

• upload_part

• abort_multipart_upload

• list_parts

• list_multipart_uploads

Usage

s3_complete_multipart_upload(Bucket, Key, MultipartUpload, UploadId,
  RequestPayer, ExpectedBucketOwner)

Arguments

Bucket

[required] Name of the bucket to which the multipart upload was initiated.

Key

[required] Object key for which the multipart upload was initiated.

MultipartUpload

The container for the multipart upload request information.

UploadId

[required] ID for the initiated multipart upload.

RequestPayer

ExpectedBucketOwner

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Value

A list with the following syntax:

list(
  Location = "string",
  Bucket = "string",
  Key = "string",
  Expiration = "string",
  ETag = "string",
  ServerSideEncryption = "AES256"|"aws:kms",
  VersionId = "string",
  SSEKMSKeyId = "string",
  BucketKeyEnabled = TRUE|FALSE,
  RequestCharged = "requester"
)

Request syntax

svc$complete_multipart_upload(
  Bucket = "string",
  Key = "string",
  MultipartUpload = list(
    Parts = list(
      list(
        ETag = "string",
        PartNumber = 123
      )
    )
  ),
  UploadId = "string",
  RequestPayer = "requester",
  ExpectedBucketOwner = "string"
)

Examples

# NOT RUN {
# The following example completes a multipart upload.
svc$complete_multipart_upload(
  Bucket = "examplebucket",
  Key = "bigobject",
  MultipartUpload = list(
    Parts = list(
      list(
        ETag = ""d8c2eafd90c266e19ab9dcacc479f8af"",
        PartNumber = "1"
      ),
      list(
        ETag = ""d8c2eafd90c266e19ab9dcacc479f8af"",
        PartNumber = "2"
      )
    )
  ),
  UploadId = "7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91..."
)
# }
# NOT RUN {
# }