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

-- | This operation deletes an archive from a vault. Subsequent requests to
-- initiate a retrieval of this archive will fail. Archive retrievals that are
-- in progress for this archive ID may or may not succeed according to the
-- following scenarios:
--
-- If the archive retrieval job is actively preparing the data for download
-- when Amazon Glacier receives the delete archive request, the archival
-- retrieval operation might fail.  If the archive retrieval job has
-- successfully prepared the archive for download when Amazon Glacier receives
-- the delete archive request, you will be able to download the output.   This
-- operation is idempotent. Attempting to delete an already-deleted archive does
-- not result in an error.
--
-- 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/deleting-an-archive.html Deleting anArchive in Amazon Glacier> and <http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html Delete Archive> in the /Amazon Glacier DeveloperGuide/.
--
-- <http://docs.aws.amazon.com/amazonglacier/latest/dev/api-DeleteArchive.html>
module Network.AWS.Glacier.DeleteArchive
    (
    -- * Request
      DeleteArchive
    -- ** Request constructor
    , deleteArchive
    -- ** Request lenses
    , daAccountId
    , daArchiveId
    , daVaultName

    -- * Response
    , DeleteArchiveResponse
    -- ** Response constructor
    , deleteArchiveResponse
    ) 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 DeleteArchive = DeleteArchive
    { _daAccountId :: Text
    , _daArchiveId :: Text
    , _daVaultName :: Text
    } deriving (Eq, Ord, Read, Show)

-- | 'DeleteArchive' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'daAccountId' @::@ 'Text'
--
-- * 'daArchiveId' @::@ 'Text'
--
-- * 'daVaultName' @::@ 'Text'
--
deleteArchive :: Text -- ^ 'daAccountId'
              -> Text -- ^ 'daVaultName'
              -> Text -- ^ 'daArchiveId'
              -> DeleteArchive
deleteArchive p1 p2 p3 = DeleteArchive
    { _daAccountId = p1
    , _daVaultName = p2
    , _daArchiveId = p3
    }

-- | 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.
daAccountId :: Lens' DeleteArchive Text
daAccountId = lens _daAccountId (\s a -> s { _daAccountId = a })

-- | The ID of the archive to delete.
daArchiveId :: Lens' DeleteArchive Text
daArchiveId = lens _daArchiveId (\s a -> s { _daArchiveId = a })

-- | The name of the vault.
daVaultName :: Lens' DeleteArchive Text
daVaultName = lens _daVaultName (\s a -> s { _daVaultName = a })

data DeleteArchiveResponse = DeleteArchiveResponse
    deriving (Eq, Ord, Read, Show, Generic)

-- | 'DeleteArchiveResponse' constructor.
deleteArchiveResponse :: DeleteArchiveResponse
deleteArchiveResponse = DeleteArchiveResponse

instance ToPath DeleteArchive where
    toPath DeleteArchive{..} = mconcat
        [ "/"
        , toText _daAccountId
        , "/vaults/"
        , toText _daVaultName
        , "/archives/"
        , toText _daArchiveId
        ]

instance ToQuery DeleteArchive where
    toQuery = const mempty

instance ToHeaders DeleteArchive

instance ToJSON DeleteArchive where
    toJSON = const (toJSON Empty)

instance AWSRequest DeleteArchive where
    type Sv DeleteArchive = Glacier
    type Rs DeleteArchive = DeleteArchiveResponse

    request  = delete
    response = nullResponse DeleteArchiveResponse