Copyright	(c) 2013-2021 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

Amazonka.Glacier.CompleteMultipartUpload

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

You call this operation to inform Amazon S3 Glacier (Glacier) that all the archive parts have been uploaded and that Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, 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, Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, 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, Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, 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

data CompleteMultipartUpload = CompleteMultipartUpload' {
- accountId :: Text
- vaultName :: Text
- uploadId :: Text
- archiveSize :: Text
- checksum :: Text
}
newCompleteMultipartUpload :: Text -> Text -> Text -> Text -> Text -> CompleteMultipartUpload
completeMultipartUpload_accountId :: Lens' CompleteMultipartUpload Text
completeMultipartUpload_vaultName :: Lens' CompleteMultipartUpload Text
completeMultipartUpload_uploadId :: Lens' CompleteMultipartUpload Text
completeMultipartUpload_archiveSize :: Lens' CompleteMultipartUpload Text
completeMultipartUpload_checksum :: Lens' CompleteMultipartUpload Text
data ArchiveCreationOutput = ArchiveCreationOutput' {
- archiveId :: Maybe Text
- checksum :: Maybe Text
- location :: Maybe Text
}
newArchiveCreationOutput :: ArchiveCreationOutput
archiveCreationOutput_archiveId :: Lens' ArchiveCreationOutput (Maybe Text)
archiveCreationOutput_checksum :: Lens' ArchiveCreationOutput (Maybe Text)
archiveCreationOutput_location :: Lens' ArchiveCreationOutput (Maybe Text)

Creating a Request

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 S3 Glacier (Glacier) can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Glacier returns the URI path of the newly created archive resource.

See: newCompleteMultipartUpload smart constructor.

Constructors

CompleteMultipartUpload'

Fields

accountId :: Text
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 S3 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.
vaultName :: Text
The name of the vault.
uploadId :: Text
The upload ID of the multipart upload.
archiveSize :: Text
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.
checksum :: Text
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 S3 Glacier (Glacier), Glacier returns an error and the request fails.

Instances

Instances details

Eq CompleteMultipartUpload Source #
Instance details Defined in Amazonka.Glacier.CompleteMultipartUpload Methods (==) :: CompleteMultipartUpload -> CompleteMultipartUpload -> Bool # (/=) :: CompleteMultipartUpload -> CompleteMultipartUpload -> Bool #
Read CompleteMultipartUpload Source #
Instance details Defined in Amazonka.Glacier.CompleteMultipartUpload Methods readsPrec :: Int -> ReadS CompleteMultipartUpload # readList :: ReadS [CompleteMultipartUpload] # readPrec :: ReadPrec CompleteMultipartUpload # readListPrec :: ReadPrec [CompleteMultipartUpload] #
Show CompleteMultipartUpload Source #
Instance details Defined in Amazonka.Glacier.CompleteMultipartUpload Methods showsPrec :: Int -> CompleteMultipartUpload -> ShowS # show :: CompleteMultipartUpload -> String # showList :: [CompleteMultipartUpload] -> ShowS #
Generic CompleteMultipartUpload Source #
Instance details Defined in Amazonka.Glacier.CompleteMultipartUpload Associated Types type Rep CompleteMultipartUpload :: Type -> Type # Methods from :: CompleteMultipartUpload -> Rep CompleteMultipartUpload x # to :: Rep CompleteMultipartUpload x -> CompleteMultipartUpload #
NFData CompleteMultipartUpload Source #
Instance details Defined in Amazonka.Glacier.CompleteMultipartUpload Methods rnf :: CompleteMultipartUpload -> () #
Hashable CompleteMultipartUpload Source #
Instance details Defined in Amazonka.Glacier.CompleteMultipartUpload Methods hashWithSalt :: Int -> CompleteMultipartUpload -> Int # hash :: CompleteMultipartUpload -> Int #
ToJSON CompleteMultipartUpload Source #
Instance details Defined in Amazonka.Glacier.CompleteMultipartUpload Methods toJSON :: CompleteMultipartUpload -> Value # toEncoding :: CompleteMultipartUpload -> Encoding # toJSONList :: [CompleteMultipartUpload] -> Value # toEncodingList :: [CompleteMultipartUpload] -> Encoding #
AWSRequest CompleteMultipartUpload Source #
Instance details Defined in Amazonka.Glacier.CompleteMultipartUpload Associated Types type AWSResponse CompleteMultipartUpload # Methods request :: CompleteMultipartUpload -> Request CompleteMultipartUpload # response :: MonadResource m => Logger -> Service -> Proxy CompleteMultipartUpload -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CompleteMultipartUpload))) #
ToHeaders CompleteMultipartUpload Source #
Instance details Defined in Amazonka.Glacier.CompleteMultipartUpload Methods toHeaders :: CompleteMultipartUpload -> [Header] #
ToPath CompleteMultipartUpload Source #
Instance details Defined in Amazonka.Glacier.CompleteMultipartUpload Methods toPath :: CompleteMultipartUpload -> ByteString #
ToQuery CompleteMultipartUpload Source #
Instance details Defined in Amazonka.Glacier.CompleteMultipartUpload Methods toQuery :: CompleteMultipartUpload -> QueryString #
type Rep CompleteMultipartUpload Source #
Instance details Defined in Amazonka.Glacier.CompleteMultipartUpload type Rep CompleteMultipartUpload = D1 ('MetaData "CompleteMultipartUpload" "Amazonka.Glacier.CompleteMultipartUpload" "libZSservicesZSamazonka-glacierZSamazonka-glacier" 'False) (C1 ('MetaCons "CompleteMultipartUpload'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "vaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "uploadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "archiveSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "checksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CompleteMultipartUpload Source #
Instance details Defined in Amazonka.Glacier.CompleteMultipartUpload type AWSResponse CompleteMultipartUpload = ArchiveCreationOutput

newCompleteMultipartUpload Source #

Arguments

:: Text	`$sel:accountId:CompleteMultipartUpload'`
-> Text	`$sel:vaultName:CompleteMultipartUpload'`
-> Text	`$sel:uploadId:CompleteMultipartUpload'`
-> Text	`$sel:archiveSize:CompleteMultipartUpload'`
-> Text	`$sel:checksum:CompleteMultipartUpload'`
-> CompleteMultipartUpload

Create a value of CompleteMultipartUpload with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accountId:CompleteMultipartUpload', completeMultipartUpload_accountId - 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 S3 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.

$sel:vaultName:CompleteMultipartUpload', completeMultipartUpload_vaultName - The name of the vault.

$sel:uploadId:CompleteMultipartUpload', completeMultipartUpload_uploadId - The upload ID of the multipart upload.

$sel:archiveSize:CompleteMultipartUpload', completeMultipartUpload_archiveSize - 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.

$sel:checksum:CompleteMultipartUpload', completeMultipartUpload_checksum - 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 S3 Glacier (Glacier), Glacier returns an error and the request fails.

Request Lenses

completeMultipartUpload_accountId :: 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 S3 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.

completeMultipartUpload_vaultName :: Lens' CompleteMultipartUpload Text Source #

The name of the vault.

completeMultipartUpload_uploadId :: Lens' CompleteMultipartUpload Text Source #

The upload ID of the multipart upload.

completeMultipartUpload_archiveSize :: Lens' CompleteMultipartUpload 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.

completeMultipartUpload_checksum :: Lens' CompleteMultipartUpload 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 S3 Glacier (Glacier), Glacier returns an error and the request fails.

Destructuring the Response

data ArchiveCreationOutput Source #

Contains the Amazon S3 Glacier response to your request.

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

See: newArchiveCreationOutput smart constructor.

Constructors

ArchiveCreationOutput'
Fields archiveId :: Maybe Text The ID of the archive. This value is also included as part of the location. checksum :: Maybe Text The checksum of the archive computed by Amazon S3 Glacier. location :: Maybe Text The relative URI path of the newly added archive resource.

Instances

Instances details

Eq ArchiveCreationOutput Source #
Instance details Defined in Amazonka.Glacier.Types.ArchiveCreationOutput Methods (==) :: ArchiveCreationOutput -> ArchiveCreationOutput -> Bool # (/=) :: ArchiveCreationOutput -> ArchiveCreationOutput -> Bool #
Read ArchiveCreationOutput Source #
Instance details Defined in Amazonka.Glacier.Types.ArchiveCreationOutput Methods readsPrec :: Int -> ReadS ArchiveCreationOutput # readList :: ReadS [ArchiveCreationOutput] # readPrec :: ReadPrec ArchiveCreationOutput # readListPrec :: ReadPrec [ArchiveCreationOutput] #
Show ArchiveCreationOutput Source #
Instance details Defined in Amazonka.Glacier.Types.ArchiveCreationOutput Methods showsPrec :: Int -> ArchiveCreationOutput -> ShowS # show :: ArchiveCreationOutput -> String # showList :: [ArchiveCreationOutput] -> ShowS #
Generic ArchiveCreationOutput Source #
Instance details Defined in Amazonka.Glacier.Types.ArchiveCreationOutput Associated Types type Rep ArchiveCreationOutput :: Type -> Type # Methods from :: ArchiveCreationOutput -> Rep ArchiveCreationOutput x # to :: Rep ArchiveCreationOutput x -> ArchiveCreationOutput #
NFData ArchiveCreationOutput Source #
Instance details Defined in Amazonka.Glacier.Types.ArchiveCreationOutput Methods rnf :: ArchiveCreationOutput -> () #
Hashable ArchiveCreationOutput Source #
Instance details Defined in Amazonka.Glacier.Types.ArchiveCreationOutput Methods hashWithSalt :: Int -> ArchiveCreationOutput -> Int # hash :: ArchiveCreationOutput -> Int #
FromJSON ArchiveCreationOutput Source #
Instance details Defined in Amazonka.Glacier.Types.ArchiveCreationOutput Methods parseJSON :: Value -> Parser ArchiveCreationOutput # parseJSONList :: Value -> Parser [ArchiveCreationOutput] #
type Rep ArchiveCreationOutput Source #
Instance details Defined in Amazonka.Glacier.Types.ArchiveCreationOutput type Rep ArchiveCreationOutput = D1 ('MetaData "ArchiveCreationOutput" "Amazonka.Glacier.Types.ArchiveCreationOutput" "libZSservicesZSamazonka-glacierZSamazonka-glacier" 'False) (C1 ('MetaCons "ArchiveCreationOutput'" 'PrefixI 'True) (S1 ('MetaSel ('Just "archiveId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "checksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newArchiveCreationOutput :: ArchiveCreationOutput Source #

Create a value of ArchiveCreationOutput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:archiveId:ArchiveCreationOutput', archiveCreationOutput_archiveId - The ID of the archive. This value is also included as part of the location.

$sel:checksum:ArchiveCreationOutput', archiveCreationOutput_checksum - The checksum of the archive computed by Amazon S3 Glacier.

$sel:location:ArchiveCreationOutput', archiveCreationOutput_location - The relative URI path of the newly added archive resource.

Response Lenses

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

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

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

The checksum of the archive computed by Amazon S3 Glacier.

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

The relative URI path of the newly added archive resource.