Package software.amazon.awssdk.services.s3.model

Class UploadPartCopyRequest

    • Method Detail

      • copySource

        @Deprecated
public final String copySource()
        Deprecated.
        The copySource parameter has been deprecated in favor of the more user-friendly sourceBucket, sourceKey, and sourceVersionId parameters. The copySource parameter will remain fully functional, but it must not be used in conjunction with its replacement parameters.

        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:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key> . 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:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. 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=<version-id> 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.

        Returns:
        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:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key> . 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:<Region>:<account-id>:outpost/<outpost-id>/object/<key> . 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=<version-id> 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.

      • copySourceIfMatch

        public final String 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.

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

      • copySourceIfModifiedSince

        public final Instant copySourceIfModifiedSince()

        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.

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

      • copySourceIfNoneMatch

        public final String 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.

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

      • copySourceIfUnmodifiedSince

        public final Instant copySourceIfUnmodifiedSince()

        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.

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

      • copySourceRange

        public final String 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.

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

      • partNumber

        public final Integer partNumber()

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

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

      • uploadId

        public final String uploadId()

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

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

      • sseCustomerAlgorithm

        public final String 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.

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

      • sseCustomerKey

        public final String 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.

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

      • sseCustomerKeyMD5

        public final String 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.

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

      • copySourceSSECustomerAlgorithm

        public final String copySourceSSECustomerAlgorithm()

        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.

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

      • copySourceSSECustomerKey

        public final String copySourceSSECustomerKey()

        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.

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

      • copySourceSSECustomerKeyMD5

        public final String copySourceSSECustomerKeyMD5()

        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.

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

      • requestPayer

        public final RequestPayer requestPayer()
        Returns the value of the RequestPayer property for this object.

        If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().

        Returns:
        The value of the RequestPayer property for this object.
        See Also:
        RequestPayer

      • requestPayerAsString

        public final String requestPayerAsString()
        Returns the value of the RequestPayer property for this object.

        If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().

        Returns:
        The value of the RequestPayer property for this object.
        See Also:
        RequestPayer

      • expectedBucketOwner

        public final String expectedBucketOwner()

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

        Returns:
        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).

      • expectedSourceBucketOwner

        public final String expectedSourceBucketOwner()

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

        Returns:
        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).

      • bucket

        @Deprecated
public final String bucket()
        Deprecated.
        Use destinationBucket()

        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.

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

      • destinationBucket

        public final String destinationBucket()

        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.

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

      • key

        @Deprecated
public final String key()
        Deprecated.
        Use destinationKey()

        Object key for which the multipart upload was initiated.

        Returns:
        Object key for which the multipart upload was initiated.

      • destinationKey

        public final String destinationKey()

        Object key for which the multipart upload was initiated.

        Returns:
        Object key for which the multipart upload was initiated.

      • sourceBucket

        public final String sourceBucket()
        The name of the bucket containing the object to copy. The provided input will be URL encoded. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.
        Returns:
        The name of the bucket containing the object to copy. The provided input will be URL encoded. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.

      • sourceKey

        public final String sourceKey()
        The key of the object to copy. The provided input will be URL encoded. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.
        Returns:
        The key of the object to copy. The provided input will be URL encoded. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.

      • sourceVersionId

        public final String sourceVersionId()
        Specifies a particular version of the source object to copy. By default the latest version is copied. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.
        Returns:
        Specifies a particular version of the source object to copy. By default the latest version is copied. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object