amazonka-glacier-1.5.0: Amazon Glacier SDK.

Copyright(c) 2013-2017 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.Glacier.CompleteMultipartUpload

Contents

Description

You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob .

In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see Computing Checksums . On the server side, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The ListParts operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue.

Additionally, Amazon Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Amazon Glacier returns an error and the operation fails.

Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .

For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Complete Multipart Upload in the Amazon Glacier Developer Guide .

Synopsis

Creating a Request

completeMultipartUpload Source #

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

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

  • cmuChecksum - The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.
  • cmuArchiveSize - The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.
  • cmuAccountId - The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '- ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (-) in the ID.
  • cmuVaultName - The name of the vault.
  • cmuUploadId - The upload ID of the multipart upload.

data CompleteMultipartUpload Source #

Provides options to complete a multipart upload operation. This informs Amazon Glacier that all the archive parts have been uploaded and Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource.

See: completeMultipartUpload smart constructor.

Instances

Eq CompleteMultipartUpload Source # 
Data CompleteMultipartUpload Source # 

Methods

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

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

toConstr :: CompleteMultipartUpload -> Constr #

dataTypeOf :: CompleteMultipartUpload -> DataType #

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

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

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

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

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

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

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

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

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

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

Read CompleteMultipartUpload Source # 
Show CompleteMultipartUpload Source # 
Generic CompleteMultipartUpload Source # 
Hashable CompleteMultipartUpload Source # 
ToJSON CompleteMultipartUpload Source # 
NFData CompleteMultipartUpload Source # 

Methods

rnf :: CompleteMultipartUpload -> () #

AWSRequest CompleteMultipartUpload Source # 
ToQuery CompleteMultipartUpload Source # 
ToPath CompleteMultipartUpload Source # 
ToHeaders CompleteMultipartUpload Source # 
type Rep CompleteMultipartUpload Source # 
type Rep CompleteMultipartUpload = D1 (MetaData "CompleteMultipartUpload" "Network.AWS.Glacier.CompleteMultipartUpload" "amazonka-glacier-1.5.0-AWAt53IVogG613fTETHcMP" False) (C1 (MetaCons "CompleteMultipartUpload'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cmuChecksum") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cmuArchiveSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cmuAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_cmuVaultName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cmuUploadId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs CompleteMultipartUpload Source # 

Request Lenses

cmuChecksum :: Lens' CompleteMultipartUpload (Maybe Text) Source #

The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.

cmuArchiveSize :: Lens' CompleteMultipartUpload (Maybe Text) Source #

The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.

cmuAccountId :: Lens' CompleteMultipartUpload Text Source #

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '- ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (-) in the ID.

cmuUploadId :: Lens' CompleteMultipartUpload Text Source #

The upload ID of the multipart upload.

Destructuring the Response

archiveCreationOutput :: ArchiveCreationOutput Source #

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

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

  • acoArchiveId - The ID of the archive. This value is also included as part of the location.
  • acoChecksum - The checksum of the archive computed by Amazon Glacier.
  • acoLocation - The relative URI path of the newly added archive resource.

data ArchiveCreationOutput Source #

Contains the Amazon Glacier response to your request.

For information about the underlying REST API, see Upload Archive . For conceptual information, see Working with Archives in Amazon Glacier .

See: archiveCreationOutput smart constructor.

Instances

Eq ArchiveCreationOutput Source # 
Data ArchiveCreationOutput Source # 

Methods

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

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

toConstr :: ArchiveCreationOutput -> Constr #

dataTypeOf :: ArchiveCreationOutput -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ArchiveCreationOutput Source # 
Show ArchiveCreationOutput Source # 
Generic ArchiveCreationOutput Source # 
Hashable ArchiveCreationOutput Source # 
FromJSON ArchiveCreationOutput Source # 
NFData ArchiveCreationOutput Source # 

Methods

rnf :: ArchiveCreationOutput -> () #

type Rep ArchiveCreationOutput Source # 
type Rep ArchiveCreationOutput = D1 (MetaData "ArchiveCreationOutput" "Network.AWS.Glacier.Types.Product" "amazonka-glacier-1.5.0-AWAt53IVogG613fTETHcMP" False) (C1 (MetaCons "ArchiveCreationOutput'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_acoArchiveId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_acoChecksum") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_acoLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

Response Lenses

acoArchiveId :: Lens' ArchiveCreationOutput (Maybe Text) Source #

The ID of the archive. This value is also included as part of the location.

acoChecksum :: Lens' ArchiveCreationOutput (Maybe Text) Source #

The checksum of the archive computed by Amazon Glacier.

acoLocation :: Lens' ArchiveCreationOutput (Maybe Text) Source #

The relative URI path of the newly added archive resource.