CompleteMultipartUpload.hs

{-# LANGUAGE DataKinds                   #-}
{-# LANGUAGE DeriveGeneric               #-}
{-# LANGUAGE FlexibleInstances           #-}
{-# LANGUAGE GeneralizedNewtypeDeriving  #-}
{-# LANGUAGE LambdaCase                  #-}
{-# LANGUAGE NoImplicitPrelude           #-}
{-# LANGUAGE OverloadedStrings           #-}
{-# LANGUAGE RecordWildCards             #-}
{-# LANGUAGE TypeFamilies                #-}

{-# OPTIONS_GHC -fno-warn-unused-imports #-}

-- Module      : Network.AWS.Glacier.CompleteMultipartUpload
-- Copyright   : (c) 2013-2014 Brendan Hay <brendan.g.hay@gmail.com>
-- License     : This Source Code Form is subject to the terms of
--               the Mozilla Public License, v. 2.0.
--               A copy of the MPL can be found in the LICENSE file or
--               you can obtain it at http://mozilla.org/MPL/2.0/.
-- Maintainer  : Brendan Hay <brendan.g.hay@gmail.com>
-- Stability   : experimental
-- Portability : non-portable (GHC extensions)
--
-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- | 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 <http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html 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 <http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html Access Control Using AWS Identityand Access Management (IAM)>.
--
-- For conceptual information and underlying REST API, go to <http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html Uploading LargeArchives in Parts (Multipart Upload)> and <http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-complete-upload.html Complete Multipart Upload> in the /Amazon Glacier Developer Guide/.
--
-- <http://docs.aws.amazon.com/amazonglacier/latest/dev/api-CompleteMultipartUpload.html>
module Network.AWS.Glacier.CompleteMultipartUpload
    (
    -- * Request
      CompleteMultipartUpload
    -- ** Request constructor
    , completeMultipartUpload
    -- ** Request lenses
    , cmuAccountId
    , cmuArchiveSize
    , cmuChecksum
    , cmuUploadId
    , cmuVaultName

    -- * Response
    , CompleteMultipartUploadResponse
    -- ** Response constructor
    , completeMultipartUploadResponse
    -- ** Response lenses
    , cmurArchiveId
    , cmurChecksum
    , cmurLocation
    ) where

import Network.AWS.Data (Object)
import Network.AWS.Prelude
import Network.AWS.Request.RestJSON
import Network.AWS.Glacier.Types
import qualified GHC.Exts

data CompleteMultipartUpload = CompleteMultipartUpload
    { _cmuAccountId   :: Text
    , _cmuArchiveSize :: Maybe Text
    , _cmuChecksum    :: Maybe Text
    , _cmuUploadId    :: Text
    , _cmuVaultName   :: Text
    } deriving (Eq, Ord, Read, Show)

-- | 'CompleteMultipartUpload' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'cmuAccountId' @::@ 'Text'
--
-- * 'cmuArchiveSize' @::@ 'Maybe' 'Text'
--
-- * 'cmuChecksum' @::@ 'Maybe' 'Text'
--
-- * 'cmuUploadId' @::@ 'Text'
--
-- * 'cmuVaultName' @::@ 'Text'
--
completeMultipartUpload :: Text -- ^ 'cmuAccountId'
                        -> Text -- ^ 'cmuVaultName'
                        -> Text -- ^ 'cmuUploadId'
                        -> CompleteMultipartUpload
completeMultipartUpload p1 p2 p3 = CompleteMultipartUpload
    { _cmuAccountId   = p1
    , _cmuVaultName   = p2
    , _cmuUploadId    = p3
    , _cmuArchiveSize = Nothing
    , _cmuChecksum    = Nothing
    }

-- | The 'AccountId' is the AWS Account ID. You can specify either the AWS Account
-- ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID
-- associated with the credentials used to sign the request. If you specify your
-- Account ID, do not include hyphens in it.
cmuAccountId :: Lens' CompleteMultipartUpload Text
cmuAccountId = lens _cmuAccountId (\s a -> s { _cmuAccountId = a })

-- | 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.
cmuArchiveSize :: Lens' CompleteMultipartUpload (Maybe Text)
cmuArchiveSize = lens _cmuArchiveSize (\s a -> s { _cmuArchiveSize = a })

-- | 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.
cmuChecksum :: Lens' CompleteMultipartUpload (Maybe Text)
cmuChecksum = lens _cmuChecksum (\s a -> s { _cmuChecksum = a })

-- | The upload ID of the multipart upload.
cmuUploadId :: Lens' CompleteMultipartUpload Text
cmuUploadId = lens _cmuUploadId (\s a -> s { _cmuUploadId = a })

-- | The name of the vault.
cmuVaultName :: Lens' CompleteMultipartUpload Text
cmuVaultName = lens _cmuVaultName (\s a -> s { _cmuVaultName = a })

data CompleteMultipartUploadResponse = CompleteMultipartUploadResponse
    { _cmurArchiveId :: Maybe Text
    , _cmurChecksum  :: Maybe Text
    , _cmurLocation  :: Maybe Text
    } deriving (Eq, Ord, Read, Show)

-- | 'CompleteMultipartUploadResponse' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'cmurArchiveId' @::@ 'Maybe' 'Text'
--
-- * 'cmurChecksum' @::@ 'Maybe' 'Text'
--
-- * 'cmurLocation' @::@ 'Maybe' 'Text'
--
completeMultipartUploadResponse :: CompleteMultipartUploadResponse
completeMultipartUploadResponse = CompleteMultipartUploadResponse
    { _cmurLocation  = Nothing
    , _cmurChecksum  = Nothing
    , _cmurArchiveId = Nothing
    }

-- | The ID of the archive. This value is also included as part of the location.
cmurArchiveId :: Lens' CompleteMultipartUploadResponse (Maybe Text)
cmurArchiveId = lens _cmurArchiveId (\s a -> s { _cmurArchiveId = a })

-- | The checksum of the archive computed by Amazon Glacier.
cmurChecksum :: Lens' CompleteMultipartUploadResponse (Maybe Text)
cmurChecksum = lens _cmurChecksum (\s a -> s { _cmurChecksum = a })

-- | The relative URI path of the newly added archive resource.
cmurLocation :: Lens' CompleteMultipartUploadResponse (Maybe Text)
cmurLocation = lens _cmurLocation (\s a -> s { _cmurLocation = a })

instance ToPath CompleteMultipartUpload where
    toPath CompleteMultipartUpload{..} = mconcat
        [ "/"
        , toText _cmuAccountId
        , "/vaults/"
        , toText _cmuVaultName
        , "/multipart-uploads/"
        , toText _cmuUploadId
        ]

instance ToQuery CompleteMultipartUpload where
    toQuery = const mempty

instance ToHeaders CompleteMultipartUpload where
    toHeaders CompleteMultipartUpload{..} = mconcat
        [ "x-amz-archive-size"     =: _cmuArchiveSize
        , "x-amz-sha256-tree-hash" =: _cmuChecksum
        ]

instance ToJSON CompleteMultipartUpload where
    toJSON = const (toJSON Empty)

instance AWSRequest CompleteMultipartUpload where
    type Sv CompleteMultipartUpload = Glacier
    type Rs CompleteMultipartUpload = CompleteMultipartUploadResponse

    request  = post
    response = headerResponse $ \h -> CompleteMultipartUploadResponse
        <$> h ~:? "x-amz-archive-id"
        <*> h ~:? "x-amz-sha256-tree-hash"
        <*> h ~:? "Location"