Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.S3.UploadPartCopy

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Uploads a part by copying data from an existing object as data source.

Synopsis

uploadPartCopy :: BucketName -> Text -> ObjectKey -> Int -> Text -> UploadPartCopy
data UploadPartCopy
upcCopySourceIfModifiedSince :: Lens' UploadPartCopy (Maybe UTCTime)
upcCopySourceIfUnmodifiedSince :: Lens' UploadPartCopy (Maybe UTCTime)
upcCopySourceRange :: Lens' UploadPartCopy (Maybe Text)
upcCopySourceSSECustomerKeyMD5 :: Lens' UploadPartCopy (Maybe Text)
upcCopySourceIfNoneMatch :: Lens' UploadPartCopy (Maybe Text)
upcSSECustomerAlgorithm :: Lens' UploadPartCopy (Maybe Text)
upcSSECustomerKey :: Lens' UploadPartCopy (Maybe Text)
upcRequestPayer :: Lens' UploadPartCopy (Maybe RequestPayer)
upcCopySourceIfMatch :: Lens' UploadPartCopy (Maybe Text)
upcSSECustomerKeyMD5 :: Lens' UploadPartCopy (Maybe Text)
upcCopySourceSSECustomerKey :: Lens' UploadPartCopy (Maybe Text)
upcCopySourceSSECustomerAlgorithm :: Lens' UploadPartCopy (Maybe Text)
upcBucket :: Lens' UploadPartCopy BucketName
upcCopySource :: Lens' UploadPartCopy Text
upcKey :: Lens' UploadPartCopy ObjectKey
upcPartNumber :: Lens' UploadPartCopy Int
upcUploadId :: Lens' UploadPartCopy Text
uploadPartCopyResponse :: Int -> UploadPartCopyResponse
data UploadPartCopyResponse
upcrsRequestCharged :: Lens' UploadPartCopyResponse (Maybe RequestCharged)
upcrsCopyPartResult :: Lens' UploadPartCopyResponse (Maybe CopyPartResult)
upcrsSSECustomerAlgorithm :: Lens' UploadPartCopyResponse (Maybe Text)
upcrsCopySourceVersionId :: Lens' UploadPartCopyResponse (Maybe Text)
upcrsSSECustomerKeyMD5 :: Lens' UploadPartCopyResponse (Maybe Text)
upcrsSSEKMSKeyId :: Lens' UploadPartCopyResponse (Maybe Text)
upcrsServerSideEncryption :: Lens' UploadPartCopyResponse (Maybe ServerSideEncryption)
upcrsResponseStatus :: Lens' UploadPartCopyResponse Int

Creating a Request

uploadPartCopy Source #

Arguments

:: BucketName	`upcBucket`
-> Text	`upcCopySource`
-> ObjectKey	`upcKey`
-> Int	`upcPartNumber`
-> Text	`upcUploadId`
-> UploadPartCopy

Creates a value of UploadPartCopy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

upcCopySourceIfModifiedSince - Copies the object if it has been modified since the specified time.
upcCopySourceIfUnmodifiedSince - Copies the object if it hasn't been modified since the specified time.
upcCopySourceRange - 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 ten bytes of the source. You can copy a range only if the source object is greater than 5 GB.
upcCopySourceSSECustomerKeyMD5 - 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 the encryption key was transmitted without error.
upcCopySourceIfNoneMatch - Copies the object if its entity tag (ETag) is different than the specified ETag.
upcSSECustomerAlgorithm - Specifies the algorithm to use to when encrypting the object (e.g., AES256).
upcSSECustomerKey - 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 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.
upcRequestPayer - Undocumented member.
upcCopySourceIfMatch - Copies the object if its entity tag (ETag) matches the specified tag.
upcSSECustomerKeyMD5 - 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 the encryption key was transmitted without error.
upcCopySourceSSECustomerKey - 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.
upcCopySourceSSECustomerAlgorithm - Specifies the algorithm to use when decrypting the source object (e.g., AES256).
upcBucket - Undocumented member.
upcCopySource - The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.
upcKey - Undocumented member.
upcPartNumber - Part number of part being copied. This is a positive integer between 1 and 10,000.
upcUploadId - Upload ID identifying the multipart upload whose part is being copied.

data UploadPartCopy Source #

See: uploadPartCopy smart constructor.

Instances

Eq UploadPartCopy Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy Methods (==) :: UploadPartCopy -> UploadPartCopy -> Bool # (/=) :: UploadPartCopy -> UploadPartCopy -> Bool #
Data UploadPartCopy Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UploadPartCopy -> c UploadPartCopy # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UploadPartCopy # toConstr :: UploadPartCopy -> Constr # dataTypeOf :: UploadPartCopy -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UploadPartCopy) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UploadPartCopy) # gmapT :: (forall b. Data b => b -> b) -> UploadPartCopy -> UploadPartCopy # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UploadPartCopy -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UploadPartCopy -> r # gmapQ :: (forall d. Data d => d -> u) -> UploadPartCopy -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UploadPartCopy -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UploadPartCopy -> m UploadPartCopy # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UploadPartCopy -> m UploadPartCopy # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UploadPartCopy -> m UploadPartCopy #
Show UploadPartCopy Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy Methods showsPrec :: Int -> UploadPartCopy -> ShowS # show :: UploadPartCopy -> String # showList :: [UploadPartCopy] -> ShowS #
Generic UploadPartCopy Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy Associated Types type Rep UploadPartCopy :: Type -> Type # Methods from :: UploadPartCopy -> Rep UploadPartCopy x # to :: Rep UploadPartCopy x -> UploadPartCopy #
Hashable UploadPartCopy Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy Methods hashWithSalt :: Int -> UploadPartCopy -> Int # hash :: UploadPartCopy -> Int #
AWSRequest UploadPartCopy Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy Associated Types type Rs UploadPartCopy :: Type # Methods request :: UploadPartCopy -> Request UploadPartCopy # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UploadPartCopy -> ClientResponse -> m (Response UploadPartCopy) #
ToHeaders UploadPartCopy Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy Methods toHeaders :: UploadPartCopy -> [Header] #
ToPath UploadPartCopy Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy Methods toPath :: UploadPartCopy -> ByteString #
ToQuery UploadPartCopy Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy Methods toQuery :: UploadPartCopy -> QueryString #
NFData UploadPartCopy Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy Methods rnf :: UploadPartCopy -> () #
type Rep UploadPartCopy Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy type Rep UploadPartCopy = D1 (MetaData "UploadPartCopy" "Network.AWS.S3.UploadPartCopy" "amazonka-s3-1.6.1-I7VsiKive605KPmKsVgrUz" False) (C1 (MetaCons "UploadPartCopy'" PrefixI True) ((((S1 (MetaSel (Just "_upcCopySourceIfModifiedSince") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RFC822)) :: S1 (MetaSel (Just "_upcCopySourceIfUnmodifiedSince") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RFC822))) :: (S1 (MetaSel (Just "_upcCopySourceRange") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_upcCopySourceSSECustomerKeyMD5") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_upcCopySourceIfNoneMatch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_upcSSECustomerAlgorithm") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_upcSSECustomerKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 (MetaSel (Just "_upcRequestPayer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RequestPayer))))) :: (((S1 (MetaSel (Just "_upcCopySourceIfMatch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_upcSSECustomerKeyMD5") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_upcCopySourceSSECustomerKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 (MetaSel (Just "_upcCopySourceSSECustomerAlgorithm") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_upcBucket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BucketName) :: S1 (MetaSel (Just "_upcCopySource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_upcKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ObjectKey) :: (S1 (MetaSel (Just "_upcPartNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :: S1 (MetaSel (Just "_upcUploadId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))
type Rs UploadPartCopy Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy type Rs UploadPartCopy = UploadPartCopyResponse

Request Lenses

upcCopySourceIfModifiedSince :: Lens' UploadPartCopy (Maybe UTCTime) Source #

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

upcCopySourceIfUnmodifiedSince :: Lens' UploadPartCopy (Maybe UTCTime) Source #

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

upcCopySourceRange :: Lens' UploadPartCopy (Maybe Text) Source #

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 ten bytes of the source. You can copy a range only if the source object is greater than 5 GB.

upcCopySourceSSECustomerKeyMD5 :: Lens' UploadPartCopy (Maybe Text) Source #

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 the encryption key was transmitted without error.

upcCopySourceIfNoneMatch :: Lens' UploadPartCopy (Maybe Text) Source #

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

upcSSECustomerAlgorithm :: Lens' UploadPartCopy (Maybe Text) Source #

Specifies the algorithm to use to when encrypting the object (e.g., AES256).

upcSSECustomerKey :: Lens' UploadPartCopy (Maybe Text) Source #

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

upcRequestPayer :: Lens' UploadPartCopy (Maybe RequestPayer) Source #

Undocumented member.

upcCopySourceIfMatch :: Lens' UploadPartCopy (Maybe Text) Source #

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

upcSSECustomerKeyMD5 :: Lens' UploadPartCopy (Maybe Text) Source #

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 the encryption key was transmitted without error.

upcCopySourceSSECustomerKey :: Lens' UploadPartCopy (Maybe Text) Source #

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.

upcCopySourceSSECustomerAlgorithm :: Lens' UploadPartCopy (Maybe Text) Source #

Specifies the algorithm to use when decrypting the source object (e.g., AES256).

upcBucket :: Lens' UploadPartCopy BucketName Source #

Undocumented member.

upcCopySource :: Lens' UploadPartCopy Text Source #

The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

upcKey :: Lens' UploadPartCopy ObjectKey Source #

Undocumented member.

upcPartNumber :: Lens' UploadPartCopy Int Source #

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

upcUploadId :: Lens' UploadPartCopy Text Source #

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

Destructuring the Response

uploadPartCopyResponse Source #

Arguments

:: Int	`upcrsResponseStatus`
-> UploadPartCopyResponse

Creates a value of UploadPartCopyResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

upcrsRequestCharged - Undocumented member.
upcrsCopyPartResult - Undocumented member.
upcrsSSECustomerAlgorithm - If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
upcrsCopySourceVersionId - The version of the source object that was copied, if you have enabled versioning on the source bucket.
upcrsSSECustomerKeyMD5 - If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
upcrsSSEKMSKeyId - If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
upcrsServerSideEncryption - The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
upcrsResponseStatus - -- | The response status code.

data UploadPartCopyResponse Source #

See: uploadPartCopyResponse smart constructor.

Instances

Eq UploadPartCopyResponse Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy Methods (==) :: UploadPartCopyResponse -> UploadPartCopyResponse -> Bool # (/=) :: UploadPartCopyResponse -> UploadPartCopyResponse -> Bool #
Data UploadPartCopyResponse Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UploadPartCopyResponse -> c UploadPartCopyResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UploadPartCopyResponse # toConstr :: UploadPartCopyResponse -> Constr # dataTypeOf :: UploadPartCopyResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UploadPartCopyResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UploadPartCopyResponse) # gmapT :: (forall b. Data b => b -> b) -> UploadPartCopyResponse -> UploadPartCopyResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UploadPartCopyResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UploadPartCopyResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> UploadPartCopyResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UploadPartCopyResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UploadPartCopyResponse -> m UploadPartCopyResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UploadPartCopyResponse -> m UploadPartCopyResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UploadPartCopyResponse -> m UploadPartCopyResponse #
Show UploadPartCopyResponse Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy Methods showsPrec :: Int -> UploadPartCopyResponse -> ShowS # show :: UploadPartCopyResponse -> String # showList :: [UploadPartCopyResponse] -> ShowS #
Generic UploadPartCopyResponse Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy Associated Types type Rep UploadPartCopyResponse :: Type -> Type # Methods from :: UploadPartCopyResponse -> Rep UploadPartCopyResponse x # to :: Rep UploadPartCopyResponse x -> UploadPartCopyResponse #
NFData UploadPartCopyResponse Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy Methods rnf :: UploadPartCopyResponse -> () #
type Rep UploadPartCopyResponse Source #
Instance details Defined in Network.AWS.S3.UploadPartCopy type Rep UploadPartCopyResponse = D1 (MetaData "UploadPartCopyResponse" "Network.AWS.S3.UploadPartCopy" "amazonka-s3-1.6.1-I7VsiKive605KPmKsVgrUz" False) (C1 (MetaCons "UploadPartCopyResponse'" PrefixI True) (((S1 (MetaSel (Just "_upcrsRequestCharged") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RequestCharged)) :: S1 (MetaSel (Just "_upcrsCopyPartResult") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CopyPartResult))) :: (S1 (MetaSel (Just "_upcrsSSECustomerAlgorithm") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_upcrsCopySourceVersionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_upcrsSSECustomerKeyMD5") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_upcrsSSEKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 (MetaSel (Just "_upcrsServerSideEncryption") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ServerSideEncryption)) :*: S1 (MetaSel (Just "_upcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

upcrsRequestCharged :: Lens' UploadPartCopyResponse (Maybe RequestCharged) Source #

Undocumented member.

upcrsCopyPartResult :: Lens' UploadPartCopyResponse (Maybe CopyPartResult) Source #

Undocumented member.

upcrsSSECustomerAlgorithm :: Lens' UploadPartCopyResponse (Maybe Text) Source #

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

upcrsCopySourceVersionId :: Lens' UploadPartCopyResponse (Maybe Text) Source #

The version of the source object that was copied, if you have enabled versioning on the source bucket.

upcrsSSECustomerKeyMD5 :: Lens' UploadPartCopyResponse (Maybe Text) Source #

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.

upcrsSSEKMSKeyId :: Lens' UploadPartCopyResponse (Maybe Text) Source #

If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.

upcrsServerSideEncryption :: Lens' UploadPartCopyResponse (Maybe ServerSideEncryption) Source #

The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

upcrsResponseStatus :: Lens' UploadPartCopyResponse Int Source #

- | The response status code.