AWSS3ReplicateObjectRequest

Objective-C

@interface AWSS3ReplicateObjectRequest

Swift

class AWSS3ReplicateObjectRequest
  • ACL

    The canned ACL to apply to the object.

    This action is not supported by Amazon S3 on Outposts.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ObjectCannedACL ACL;

    Swift

    var acl: AWSS3ObjectCannedACL { get set }

  • The name of the destination bucket.

    When using this API 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 operation with an access point through the AWS 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 Simple Storage Service Developer Guide.

    When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable bucket;

    Swift

    var bucket: String? { get set }

  • Specifies caching behavior along the request/reply chain.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable cacheControl;

    Swift

    var cacheControl: String? { get set }

  • Specifies presentational information for the object.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable contentDisposition;

    Swift

    var contentDisposition: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable contentEncoding;

    Swift

    var contentEncoding: String? { get set }

  • The language the content is in.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable contentLanguage;

    Swift

    var contentLanguage: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable contentType;

    Swift

    var contentType: String? { get set }

  • 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 the 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 AWS Region.

      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.

    To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don’t specify a version ID, Amazon S3 copies the latest version of the source object.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable replicateSource;

    Swift

    var replicateSource: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable replicateSourceIfMatch;

    Swift

    var replicateSourceIfMatch: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable replicateSourceIfModifiedSince;

    Swift

    var replicateSourceIfModifiedSince: Date? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable replicateSourceIfNoneMatch;

    Swift

    var replicateSourceIfNoneMatch: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable replicateSourceIfUnmodifiedSince;

    Swift

    var replicateSourceIfUnmodifiedSince: Date? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable replicateSourceSSECustomerAlgorithm;

    Swift

    var replicateSourceSSECustomerAlgorithm: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable replicateSourceSSECustomerKey;

    Swift

    var replicateSourceSSECustomerKey: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable replicateSourceSSECustomerKeyMD5;

    Swift

    var replicateSourceSSECustomerKeyMD5: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable expectedBucketOwner;

    Swift

    var expectedBucketOwner: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable expectedSourceBucketOwner;

    Swift

    var expectedSourceBucketOwner: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable expires;

    Swift

    var expires: Date? { get set }

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

    This action is not supported by Amazon S3 on Outposts.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable grantFullControl;

    Swift

    var grantFullControl: String? { get set }

  • Allows grantee to read the object data and its metadata.

    This action is not supported by Amazon S3 on Outposts.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable grantRead;

    Swift

    var grantRead: String? { get set }

  • Allows grantee to read the object ACL.

    This action is not supported by Amazon S3 on Outposts.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable grantReadACP;

    Swift

    var grantReadACP: String? { get set }

  • Allows grantee to write the ACL for the applicable object.

    This action is not supported by Amazon S3 on Outposts.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable grantWriteACP;

    Swift

    var grantWriteACP: String? { get set }
  • key

    The key of the destination object.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable key;

    Swift

    var key: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable metadata;

    Swift

    var metadata: [String : String]? { get set }

  • Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3MetadataDirective metadataDirective;

    Swift

    var metadataDirective: AWSS3MetadataDirective { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ObjectLockLegalHoldStatus objectLockLegalHoldStatus;

    Swift

    var objectLockLegalHoldStatus: AWSS3ObjectLockLegalHoldStatus { get set }

  • The Object Lock mode that you want to apply to the copied object.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ObjectLockMode objectLockMode;

    Swift

    var objectLockMode: AWSS3ObjectLockMode { get set }

  • The date and time when you want the copied object’s Object Lock to expire.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable objectLockRetainUntilDate;

    Swift

    var objectLockRetainUntilDate: Date? { get set }

  • Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 Developer Guide.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3RequestPayer requestPayer;

    Swift

    var requestPayer: AWSS3RequestPayer { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable SSECustomerAlgorithm;

    Swift

    var sseCustomerAlgorithm: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable SSECustomerKey;

    Swift

    var sseCustomerKey: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable SSECustomerKeyMD5;

    Swift

    var sseCustomerKeyMD5: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable SSEKMSEncryptionContext;

    Swift

    var ssekmsEncryptionContext: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable SSEKMSKeyId;

    Swift

    var ssekmsKeyId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ServerSideEncryption serverSideEncryption;

    Swift

    var serverSideEncryption: AWSS3ServerSideEncryption { get set }

  • 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 Service Developer Guide.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3StorageClass storageClass;

    Swift

    var storageClass: AWSS3StorageClass { get set }

  • The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable tagging;

    Swift

    var tagging: String? { get set }

  • Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3TaggingDirective taggingDirective;

    Swift

    var taggingDirective: AWSS3TaggingDirective { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable websiteRedirectLocation;

    Swift

    var websiteRedirectLocation: String? { get set }