Skip to content

/AWS1/IF_S3=>UPLOADPARTCOPY()

About UploadPartCopy

Uploads a part by copying data from an existing object as data source. To specify the data source, you add the request header x-amz-copy-source in your request. To specify a byte range, you add the request header x-amz-copy-source-range in your request.

For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.

Instead of copying data from an existing object as part data, you might use the UploadPart action to upload new data as a part of an object in your request.

You must initiate a multipart upload before you can upload any part. In response to your initiate request, Amazon S3 returns the upload ID, a unique identifier that you must include in your upload part request.

For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide. For information about copying objects using a single atomic action vs. a multipart upload, see Operations on Objects in the Amazon S3 User Guide.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.

Authentication and authorization

All UploadPartCopy requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. For more information, see REST Authentication.

Directory buckets - You must use IAM credentials to authenticate and authorize your access to the UploadPartCopy API operation, instead of using the temporary security credentials through the CreateSession API operation.

Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.

Permissions

You must have READ access to the source object and WRITE access to the destination bucket.

  • General purpose bucket permissions - You must have the permissions in a policy based on the bucket types of your source bucket and destination bucket in an UploadPartCopy operation.

    • If the source object is in a general purpose bucket, you must have the s3:GetObject permission to read the source object that is being copied.

    • If the destination bucket is a general purpose bucket, you must have the s3:PutObject permission to write the object copy to the destination bucket.

    • To perform a multipart upload with encryption using an Key Management Service key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey actions on the key. The requester must also have permissions for the kms:GenerateDataKey action for the CreateMultipartUpload API. Then, the requester needs permissions for the kms:Decrypt action on the UploadPart and UploadPartCopy APIs. 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 about KMS permissions, see Protecting data using server-side encryption with KMS in the Amazon S3 User Guide. For information about the permissions required to use the multipart upload API, see Multipart upload and permissions and Multipart upload API and permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types in an UploadPartCopy operation.

    • If the source object that you want to copy is in a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to read the object. By default, the session is in the ReadWrite mode. If you want to restrict the access, you can explicitly set the s3express:SessionMode condition key to ReadOnly on the copy source bucket.

    • If the copy destination is a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to write the object to the destination. The s3express:SessionMode condition key cannot be set to ReadOnly on the copy destination.

    If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

    For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.

Encryption

  • General purpose buckets - For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.

  • Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

    For directory buckets, when you perform a CreateMultipartUpload operation and an UploadPartCopy operation, the request headers you provide in the CreateMultipartUpload request must match the default encryption configuration of the destination bucket.

    S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through UploadPartCopy. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

Special errors

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

    • HTTP Status Code: 404 Not Found

  • Error Code: InvalidRequest

    • Description: The specified copy source is not supported as a byte-range copy source.

    • HTTP Status Code: 400 Bad Request

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.

The following operations are related to UploadPartCopy:

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

Method Signature

METHODS /AWS1/IF_S3~UPLOADPARTCOPY
  IMPORTING
    !IV_BUCKET TYPE /AWS1/S3_BUCKETNAME OPTIONAL
    !IV_COPYSOURCE TYPE /AWS1/S3_COPYSOURCE OPTIONAL
    !IV_COPYSOURCEIFMATCH TYPE /AWS1/S3_COPYSOURCEIFMATCH OPTIONAL
    !IV_COPYSOURCEIFMODIFIEDSINCE TYPE /AWS1/S3_COPYSRCIFMODDEDSINCE OPTIONAL
    !IV_COPYSOURCEIFNONEMATCH TYPE /AWS1/S3_COPYSOURCEIFNONEMATCH OPTIONAL
    !IV_COPYSOURCEIFUNMODDEDSINCE TYPE /AWS1/S3_CPYSRCIFUNMODDEDSINCE OPTIONAL
    !IV_COPYSOURCERANGE TYPE /AWS1/S3_COPYSOURCERANGE OPTIONAL
    !IV_KEY TYPE /AWS1/S3_OBJECTKEY OPTIONAL
    !IV_PARTNUMBER TYPE /AWS1/S3_PARTNUMBER OPTIONAL
    !IV_UPLOADID TYPE /AWS1/S3_MULTIPARTUPLOADID OPTIONAL
    !IV_SSECUSTOMERALGORITHM TYPE /AWS1/S3_SSECUSTOMERALGORITHM OPTIONAL
    !IV_SSECUSTOMERKEY TYPE /AWS1/S3_SSECUSTOMERKEY OPTIONAL
    !IV_SSECUSTOMERKEYMD5 TYPE /AWS1/S3_SSECUSTOMERKEYMD5 OPTIONAL
    !IV_COPYSOURCESSECUSTOMERALG TYPE /AWS1/S3_COPYSOURCESSECUSALG OPTIONAL
    !IV_COPYSOURCESSECUSTOMERKEY TYPE /AWS1/S3_COPYSOURCESSECUSKEY OPTIONAL
    !IV_COPYSOURCESSECUSKEYMD5 TYPE /AWS1/S3_COPYSRCSSECUSKEYMD5 OPTIONAL
    !IV_REQUESTPAYER TYPE /AWS1/S3_REQUESTPAYER OPTIONAL
    !IV_EXPECTEDBUCKETOWNER TYPE /AWS1/S3_ACCOUNTID OPTIONAL
    !IV_EXPECTEDSOURCEBUCKETOWNER TYPE /AWS1/S3_ACCOUNTID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_s3_uploadpartcopyout
  RAISING
    /AWS1/CX_S3_CLIENTEXC
    /AWS1/CX_S3_SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_bucket TYPE /AWS1/S3_BUCKETNAME /AWS1/S3_BUCKETNAME

The bucket name.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, you get an HTTP 400 Bad Request error with the error code InvalidRequest.

Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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.

Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with 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 you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

iv_copysource TYPE /AWS1/S3_COPYSOURCE /AWS1/S3_COPYSOURCE

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

  • For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded.

  • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:::accesspoint//object/. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    • Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the same Amazon Web Services Region.

    • Access points are not supported by directory buckets.

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:::outpost//object/. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded.

If your bucket has versioning enabled, you could have multiple versions of the same object. By default, x-amz-copy-source identifies the current version of the source object to copy. To copy a specific version of the source object to copy, append ?versionId= to the x-amz-copy-source request header (for example, x-amz-copy-source: /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).

If the current version is a delete marker and you don't specify a versionId in the x-amz-copy-source request header, Amazon S3 returns a 404 Not Found error, because the object does not exist. If you specify versionId in the x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns an HTTP 400 Bad Request error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source.

Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.

iv_key TYPE /AWS1/S3_OBJECTKEY /AWS1/S3_OBJECTKEY

Object key for which the multipart upload was initiated.

iv_partnumber TYPE /AWS1/S3_PARTNUMBER /AWS1/S3_PARTNUMBER

Part number of part being copied. This is a positive integer between 1 and 10,000.

iv_uploadid TYPE /AWS1/S3_MULTIPARTUPLOADID /AWS1/S3_MULTIPARTUPLOADID

Upload ID identifying the multipart upload whose part is being copied.

Optional arguments:

iv_copysourceifmatch TYPE /AWS1/S3_COPYSOURCEIFMATCH /AWS1/S3_COPYSOURCEIFMATCH

Copies the object if its entity tag (ETag) matches the specified tag.

If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows:

x-amz-copy-source-if-match condition evaluates to true, and;

x-amz-copy-source-if-unmodified-since condition evaluates to false;

Amazon S3 returns 200 OK and copies the data.

iv_copysourceifmodifiedsince TYPE /AWS1/S3_COPYSRCIFMODDEDSINCE /AWS1/S3_COPYSRCIFMODDEDSINCE

Copies the object if it has been modified since the specified time.

If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows:

x-amz-copy-source-if-none-match condition evaluates to false, and;

x-amz-copy-source-if-modified-since condition evaluates to true;

Amazon S3 returns 412 Precondition Failed response code.

iv_copysourceifnonematch TYPE /AWS1/S3_COPYSOURCEIFNONEMATCH /AWS1/S3_COPYSOURCEIFNONEMATCH

Copies the object if its entity tag (ETag) is different than the specified ETag.

If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows:

x-amz-copy-source-if-none-match condition evaluates to false, and;

x-amz-copy-source-if-modified-since condition evaluates to true;

Amazon S3 returns 412 Precondition Failed response code.

iv_copysourceifunmoddedsince TYPE /AWS1/S3_CPYSRCIFUNMODDEDSINCE /AWS1/S3_CPYSRCIFUNMODDEDSINCE

Copies the object if it hasn't been modified since the specified time.

If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows:

x-amz-copy-source-if-match condition evaluates to true, and;

x-amz-copy-source-if-unmodified-since condition evaluates to false;

Amazon S3 returns 200 OK and copies the data.

iv_copysourcerange TYPE /AWS1/S3_COPYSOURCERANGE /AWS1/S3_COPYSOURCERANGE

The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You can copy a range only if the source object is greater than 5 MB.

iv_ssecustomeralgorithm TYPE /AWS1/S3_SSECUSTOMERALGORITHM /AWS1/S3_SSECUSTOMERALGORITHM

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

This functionality is not supported when the destination bucket is a directory bucket.

iv_ssecustomerkey TYPE /AWS1/S3_SSECUSTOMERKEY /AWS1/S3_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. This must be the same encryption key specified in the initiate multipart upload request.

This functionality is not supported when the destination bucket is a directory bucket.

iv_ssecustomerkeymd5 TYPE /AWS1/S3_SSECUSTOMERKEYMD5 /AWS1/S3_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.

This functionality is not supported when the destination bucket is a directory bucket.

iv_copysourcessecustomeralg TYPE /AWS1/S3_COPYSOURCESSECUSALG /AWS1/S3_COPYSOURCESSECUSALG

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

This functionality is not supported when the source object is in a directory bucket.

iv_copysourcessecustomerkey TYPE /AWS1/S3_COPYSOURCESSECUSKEY /AWS1/S3_COPYSOURCESSECUSKEY

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

This functionality is not supported when the source object is in a directory bucket.

iv_copysourcessecuskeymd5 TYPE /AWS1/S3_COPYSRCSSECUSKEYMD5 /AWS1/S3_COPYSRCSSECUSKEYMD5

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.

This functionality is not supported when the source object is in a directory bucket.

iv_requestpayer TYPE /AWS1/S3_REQUESTPAYER /AWS1/S3_REQUESTPAYER

RequestPayer

iv_expectedbucketowner TYPE /AWS1/S3_ACCOUNTID /AWS1/S3_ACCOUNTID

The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

iv_expectedsourcebucketowner TYPE /AWS1/S3_ACCOUNTID /AWS1/S3_ACCOUNTID

The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

RETURNING

oo_output TYPE REF TO /aws1/cl_s3_uploadpartcopyout /AWS1/CL_S3_UPLOADPARTCOPYOUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->uploadpartcopy(
  iv_bucket = |string|
  iv_copysource = |string|
  iv_copysourceifmatch = |string|
  iv_copysourceifmodifiedsince = '20150101000000.0000000'
  iv_copysourceifnonematch = |string|
  iv_copysourceifunmoddedsince = '20150101000000.0000000'
  iv_copysourcerange = |string|
  iv_copysourcessecuskeymd5 = |string|
  iv_copysourcessecustomeralg = |string|
  iv_copysourcessecustomerkey = |string|
  iv_expectedbucketowner = |string|
  iv_expectedsourcebucketowner = |string|
  iv_key = |string|
  iv_partnumber = 123
  iv_requestpayer = |string|
  iv_ssecustomeralgorithm = |string|
  iv_ssecustomerkey = |string|
  iv_ssecustomerkeymd5 = |string|
  iv_uploadid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_copysourceversionid = lo_result->get_copysourceversionid( ).
  lo_copypartresult = lo_result->get_copypartresult( ).
  IF lo_copypartresult IS NOT INITIAL.
    lv_etag = lo_copypartresult->get_etag( ).
    lv_lastmodified = lo_copypartresult->get_lastmodified( ).
    lv_checksumcrc32 = lo_copypartresult->get_checksumcrc32( ).
    lv_checksumcrc32c = lo_copypartresult->get_checksumcrc32c( ).
    lv_checksumcrc64nvme = lo_copypartresult->get_checksumcrc64nvme( ).
    lv_checksumsha1 = lo_copypartresult->get_checksumsha1( ).
    lv_checksumsha256 = lo_copypartresult->get_checksumsha256( ).
  ENDIF.
  lv_serversideencryption = lo_result->get_serversideencryption( ).
  lv_ssecustomeralgorithm = lo_result->get_ssecustomeralgorithm( ).
  lv_ssecustomerkeymd5 = lo_result->get_ssecustomerkeymd5( ).
  lv_ssekmskeyid = lo_result->get_ssekmskeyid( ).
  lv_bucketkeyenabled = lo_result->get_bucketkeyenabled( ).
  lv_requestcharged = lo_result->get_requestcharged( ).
ENDIF.

To upload a part by copying byte range from an existing object as data source

The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source.

DATA(lo_result) = lo_client->uploadpartcopy(
  iv_bucket = |examplebucket|
  iv_copysource = |/bucketname/sourceobjectkey|
  iv_copysourcerange = |bytes=1-100000|
  iv_key = |examplelargeobject|
  iv_partnumber = 2
  iv_uploadid = |exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--|
).

To upload a part by copying data from an existing object as data source

The following example uploads a part of a multipart upload by copying data from an existing object as data source.

DATA(lo_result) = lo_client->uploadpartcopy(
  iv_bucket = |examplebucket|
  iv_copysource = |/bucketname/sourceobjectkey|
  iv_key = |examplelargeobject|
  iv_partnumber = 1
  iv_uploadid = |exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--|
).