CopyObjectRequest

public struct CopyObjectRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]
  • acl

    The canned ACL to apply to the object.

    Declaration

    Swift

    public let acl: ObjectCannedACL?

  • The name of the destination bucket.

    Declaration

    Swift

    public let bucket: String

  • Specifies caching behavior along the request/reply chain.

    Declaration

    Swift

    public let cacheControl: String?

  • Specifies presentational information for the object.

    Declaration

    Swift

    public let contentDisposition: String?

  • 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

    Swift

    public let contentEncoding: String?

  • The language the content is in.

    Declaration

    Swift

    public let contentLanguage: String?

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

    Declaration

    Swift

    public let contentType: String?

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

    Swift

    public let copySource: String

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

    Declaration

    Swift

    public let copySourceIfMatch: String?

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

    Declaration

    Swift

    public let copySourceIfModifiedSince: TimeStamp?

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

    Declaration

    Swift

    public let copySourceIfNoneMatch: String?

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

    Declaration

    Swift

    public let copySourceIfUnmodifiedSince: TimeStamp?

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

    Declaration

    Swift

    public let copySourceSSECustomerAlgorithm: String?

  • 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

    Swift

    public let copySourceSSECustomerKey: String?

  • 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

    Swift

    public let copySourceSSECustomerKeyMD5: String?

  • 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

    Swift

    public let expectedBucketOwner: String?

  • 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

    Swift

    public let expectedSourceBucketOwner: String?

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

    Declaration

    Swift

    public let expires: TimeStamp?

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

    Declaration

    Swift

    public let grantFullControl: String?

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

    Declaration

    Swift

    public let grantRead: String?

  • Allows grantee to read the object ACL.

    Declaration

    Swift

    public let grantReadACP: String?

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

    Declaration

    Swift

    public let grantWriteACP: String?
  • key

    The key of the destination object.

    Declaration

    Swift

    public let key: String

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

    Declaration

    Swift

    public let metadata: [String : String]?

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

    Declaration

    Swift

    public let metadataDirective: MetadataDirective?

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

    Declaration

    Swift

    public let objectLockLegalHoldStatus: ObjectLockLegalHoldStatus?

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

    Declaration

    Swift

    public let objectLockMode: ObjectLockMode?

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

    Declaration

    Swift

    public let objectLockRetainUntilDate: TimeStamp?

  • Undocumented

    Declaration

    Swift

    public let requestPayer: RequestPayer?

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

    Declaration

    Swift

    public let serverSideEncryption: ServerSideEncryption?

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

    Declaration

    Swift

    public let sSECustomerAlgorithm: String?

  • 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

    Swift

    public let sSECustomerKey: String?

  • 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

    Swift

    public let sSECustomerKeyMD5: String?

  • 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

    Swift

    public let sSEKMSEncryptionContext: String?

  • 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

    Swift

    public let sSEKMSKeyId: String?

  • The type of storage to use for the object. Defaults to ‘STANDARD’.

    Declaration

    Swift

    public let storageClass: StorageClass?

  • 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

    Swift

    public let tagging: String?

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

    Declaration

    Swift

    public let taggingDirective: TaggingDirective?

  • 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

    Swift

    public let websiteRedirectLocation: String?

  • Undocumented

    Declaration

    Swift

    public init(acl: ObjectCannedACL? = nil, bucket: String, cacheControl: String? = nil, contentDisposition: String? = nil, contentEncoding: String? = nil, contentLanguage: String? = nil, contentType: String? = nil, copySource: String, copySourceIfMatch: String? = nil, copySourceIfModifiedSince: TimeStamp? = nil, copySourceIfNoneMatch: String? = nil, copySourceIfUnmodifiedSince: TimeStamp? = nil, copySourceSSECustomerAlgorithm: String? = nil, copySourceSSECustomerKey: String? = nil, copySourceSSECustomerKeyMD5: String? = nil, expectedBucketOwner: String? = nil, expectedSourceBucketOwner: String? = nil, expires: TimeStamp? = nil, grantFullControl: String? = nil, grantRead: String? = nil, grantReadACP: String? = nil, grantWriteACP: String? = nil, key: String, metadata: [String : String]? = nil, metadataDirective: MetadataDirective? = nil, objectLockLegalHoldStatus: ObjectLockLegalHoldStatus? = nil, objectLockMode: ObjectLockMode? = nil, objectLockRetainUntilDate: TimeStamp? = nil, requestPayer: RequestPayer? = nil, serverSideEncryption: ServerSideEncryption? = nil, sSECustomerAlgorithm: String? = nil, sSECustomerKey: String? = nil, sSECustomerKeyMD5: String? = nil, sSEKMSEncryptionContext: String? = nil, sSEKMSKeyId: String? = nil, storageClass: StorageClass? = nil, tagging: String? = nil, taggingDirective: TaggingDirective? = nil, websiteRedirectLocation: String? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws