amazonka-s3-1.6.1: Amazon Simple Storage Service SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.S3.UploadPart

Contents

Description

Uploads a part in a multipart upload.

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

Synopsis

Creating a Request

uploadPart Source #

Arguments

:: BucketName

upBucket

-> ObjectKey

upKey

-> Int

upPartNumber

-> Text

upUploadId

-> RqBody

upBody

-> UploadPart 

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

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

  • upContentLength - Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
  • upSSECustomerAlgorithm - Specifies the algorithm to use to when encrypting the object (e.g., AES256).
  • upSSECustomerKey - 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.
  • upRequestPayer - Undocumented member.
  • upSSECustomerKeyMD5 - 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.
  • upContentMD5 - The base64-encoded 128-bit MD5 digest of the part data.
  • upBucket - Name of the bucket to which the multipart upload was initiated.
  • upKey - Object key for which the multipart upload was initiated.
  • upPartNumber - Part number of part being uploaded. This is a positive integer between 1 and 10,000.
  • upUploadId - Upload ID identifying the multipart upload whose part is being uploaded.
  • upBody - Object data.

data UploadPart Source #

See: uploadPart smart constructor.

Instances
Show UploadPart Source # 
Instance details

Defined in Network.AWS.S3.UploadPart

Methods

showsPrec :: Int -> UploadPart -> ShowS #

show :: UploadPart -> String #

showList :: [UploadPart] -> ShowS #

Generic UploadPart Source # 
Instance details

Defined in Network.AWS.S3.UploadPart

Associated Types

type Rep UploadPart :: Type -> Type #

Methods

from :: UploadPart -> Rep UploadPart x #

to :: Rep UploadPart x -> UploadPart #

AWSRequest UploadPart Source # 
Instance details

Defined in Network.AWS.S3.UploadPart

Associated Types

type Rs UploadPart :: Type #

Methods

request :: UploadPart -> Request UploadPart #

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UploadPart -> ClientResponse -> m (Response UploadPart) #

ToBody UploadPart Source # 
Instance details

Defined in Network.AWS.S3.UploadPart

Methods

toBody :: UploadPart -> RqBody #

ToHeaders UploadPart Source # 
Instance details

Defined in Network.AWS.S3.UploadPart

Methods

toHeaders :: UploadPart -> [Header] #

ToPath UploadPart Source # 
Instance details

Defined in Network.AWS.S3.UploadPart

Methods

toPath :: UploadPart -> ByteString #

ToQuery UploadPart Source # 
Instance details

Defined in Network.AWS.S3.UploadPart

Methods

toQuery :: UploadPart -> QueryString #

type Rep UploadPart Source # 
Instance details

Defined in Network.AWS.S3.UploadPart

type Rep UploadPart = D1 (MetaData "UploadPart" "Network.AWS.S3.UploadPart" "amazonka-s3-1.6.1-I7VsiKive605KPmKsVgrUz" False) (C1 (MetaCons "UploadPart'" PrefixI True) (((S1 (MetaSel (Just "_upContentLength") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 (MetaSel (Just "_upSSECustomerAlgorithm") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_upSSECustomerKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 (MetaSel (Just "_upRequestPayer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RequestPayer)) :*: S1 (MetaSel (Just "_upSSECustomerKeyMD5") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_upContentMD5") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_upBucket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BucketName) :*: S1 (MetaSel (Just "_upKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ObjectKey))) :*: (S1 (MetaSel (Just "_upPartNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: (S1 (MetaSel (Just "_upUploadId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_upBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RqBody))))))
type Rs UploadPart Source # 
Instance details

Defined in Network.AWS.S3.UploadPart

type Rs UploadPart = UploadPartResponse

Request Lenses

upContentLength :: Lens' UploadPart (Maybe Integer) Source #

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

upSSECustomerAlgorithm :: Lens' UploadPart (Maybe Text) Source #

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

upSSECustomerKey :: Lens' UploadPart (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.

upRequestPayer :: Lens' UploadPart (Maybe RequestPayer) Source #

Undocumented member.

upSSECustomerKeyMD5 :: Lens' UploadPart (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.

upContentMD5 :: Lens' UploadPart (Maybe Text) Source #

The base64-encoded 128-bit MD5 digest of the part data.

upBucket :: Lens' UploadPart BucketName Source #

Name of the bucket to which the multipart upload was initiated.

upKey :: Lens' UploadPart ObjectKey Source #

Object key for which the multipart upload was initiated.

upPartNumber :: Lens' UploadPart Int Source #

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

upUploadId :: Lens' UploadPart Text Source #

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

upBody :: Lens' UploadPart RqBody Source #

Object data.

Destructuring the Response

uploadPartResponse Source #

Arguments

:: Int

uprsResponseStatus

-> UploadPartResponse 

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

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

  • uprsRequestCharged - Undocumented member.
  • uprsETag - Entity tag for the uploaded object.
  • uprsSSECustomerAlgorithm - If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
  • uprsSSECustomerKeyMD5 - 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.
  • uprsSSEKMSKeyId - If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
  • uprsServerSideEncryption - The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
  • uprsResponseStatus - -- | The response status code.

data UploadPartResponse Source #

See: uploadPartResponse smart constructor.

Instances
Eq UploadPartResponse Source # 
Instance details

Defined in Network.AWS.S3.UploadPart

Methods

(==) :: UploadPartResponse -> UploadPartResponse -> Bool #

(/=) :: UploadPartResponse -> UploadPartResponse -> Bool #

Data UploadPartResponse Source # 
Instance details

Defined in Network.AWS.S3.UploadPart

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UploadPartResponse -> c UploadPartResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UploadPartResponse #

toConstr :: UploadPartResponse -> Constr #

dataTypeOf :: UploadPartResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UploadPartResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UploadPartResponse) #

gmapT :: (forall b. Data b => b -> b) -> UploadPartResponse -> UploadPartResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UploadPartResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UploadPartResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> UploadPartResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UploadPartResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UploadPartResponse -> m UploadPartResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UploadPartResponse -> m UploadPartResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UploadPartResponse -> m UploadPartResponse #

Show UploadPartResponse Source # 
Instance details

Defined in Network.AWS.S3.UploadPart

Methods

showsPrec :: Int -> UploadPartResponse -> ShowS #

show :: UploadPartResponse -> String #

showList :: [UploadPartResponse] -> ShowS #

Generic UploadPartResponse Source # 
Instance details

Defined in Network.AWS.S3.UploadPart

Associated Types

type Rep UploadPartResponse :: Type -> Type #

Methods

from :: UploadPartResponse -> Rep UploadPartResponse x #

to :: Rep UploadPartResponse x -> UploadPartResponse #

NFData UploadPartResponse Source # 
Instance details

Defined in Network.AWS.S3.UploadPart

Methods

rnf :: UploadPartResponse -> () #

type Rep UploadPartResponse Source # 
Instance details

Defined in Network.AWS.S3.UploadPart

type Rep UploadPartResponse = D1 (MetaData "UploadPartResponse" "Network.AWS.S3.UploadPart" "amazonka-s3-1.6.1-I7VsiKive605KPmKsVgrUz" False) (C1 (MetaCons "UploadPartResponse'" PrefixI True) ((S1 (MetaSel (Just "_uprsRequestCharged") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RequestCharged)) :*: (S1 (MetaSel (Just "_uprsETag") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ETag)) :*: S1 (MetaSel (Just "_uprsSSECustomerAlgorithm") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_uprsSSECustomerKeyMD5") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_uprsSSEKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :*: (S1 (MetaSel (Just "_uprsServerSideEncryption") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ServerSideEncryption)) :*: S1 (MetaSel (Just "_uprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

uprsRequestCharged :: Lens' UploadPartResponse (Maybe RequestCharged) Source #

Undocumented member.

uprsETag :: Lens' UploadPartResponse (Maybe ETag) Source #

Entity tag for the uploaded object.

uprsSSECustomerAlgorithm :: Lens' UploadPartResponse (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.

uprsSSECustomerKeyMD5 :: Lens' UploadPartResponse (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.

uprsSSEKMSKeyId :: Lens' UploadPartResponse (Maybe Text) Source #

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

uprsServerSideEncryption :: Lens' UploadPartResponse (Maybe ServerSideEncryption) Source #

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

uprsResponseStatus :: Lens' UploadPartResponse Int Source #

  • - | The response status code.