amazonka-backupstorage-2.0: gen/Amazonka/BackupStorage.hs

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

-- |
-- Module      : Amazonka.BackupStorage
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Derived from API version @2018-04-10@ of the AWS service descriptions, licensed under Apache 2.0.
--
-- The frontend service for Cryo Storage.
module Amazonka.BackupStorage
  ( -- * Service Configuration
    defaultService,

    -- * Errors
    -- $errors

    -- ** AccessDeniedException
    _AccessDeniedException,

    -- ** DataAlreadyExistsException
    _DataAlreadyExistsException,

    -- ** IllegalArgumentException
    _IllegalArgumentException,

    -- ** KMSInvalidKeyUsageException
    _KMSInvalidKeyUsageException,

    -- ** NotReadableInputStreamException
    _NotReadableInputStreamException,

    -- ** ResourceNotFoundException
    _ResourceNotFoundException,

    -- ** RetryableException
    _RetryableException,

    -- ** ServiceInternalException
    _ServiceInternalException,

    -- ** ServiceUnavailableException
    _ServiceUnavailableException,

    -- ** ThrottlingException
    _ThrottlingException,

    -- * Waiters
    -- $waiters

    -- * Operations
    -- $operations

    -- ** DeleteObject
    DeleteObject (DeleteObject'),
    newDeleteObject,
    DeleteObjectResponse (DeleteObjectResponse'),
    newDeleteObjectResponse,

    -- ** GetChunk
    GetChunk (GetChunk'),
    newGetChunk,
    GetChunkResponse (GetChunkResponse'),
    newGetChunkResponse,

    -- ** GetObjectMetadata
    GetObjectMetadata (GetObjectMetadata'),
    newGetObjectMetadata,
    GetObjectMetadataResponse (GetObjectMetadataResponse'),
    newGetObjectMetadataResponse,

    -- ** ListChunks
    ListChunks (ListChunks'),
    newListChunks,
    ListChunksResponse (ListChunksResponse'),
    newListChunksResponse,

    -- ** ListObjects
    ListObjects (ListObjects'),
    newListObjects,
    ListObjectsResponse (ListObjectsResponse'),
    newListObjectsResponse,

    -- ** NotifyObjectComplete
    NotifyObjectComplete (NotifyObjectComplete'),
    newNotifyObjectComplete,
    NotifyObjectCompleteResponse (NotifyObjectCompleteResponse'),
    newNotifyObjectCompleteResponse,

    -- ** PutChunk
    PutChunk (PutChunk'),
    newPutChunk,
    PutChunkResponse (PutChunkResponse'),
    newPutChunkResponse,

    -- ** PutObject
    PutObject (PutObject'),
    newPutObject,
    PutObjectResponse (PutObjectResponse'),
    newPutObjectResponse,

    -- ** StartObject
    StartObject (StartObject'),
    newStartObject,
    StartObjectResponse (StartObjectResponse'),
    newStartObjectResponse,

    -- * Types

    -- ** DataChecksumAlgorithm
    DataChecksumAlgorithm (..),

    -- ** SummaryChecksumAlgorithm
    SummaryChecksumAlgorithm (..),

    -- ** BackupObject
    BackupObject (BackupObject'),
    newBackupObject,

    -- ** Chunk
    Chunk (Chunk'),
    newChunk,
  )
where

import Amazonka.BackupStorage.DeleteObject
import Amazonka.BackupStorage.GetChunk
import Amazonka.BackupStorage.GetObjectMetadata
import Amazonka.BackupStorage.Lens
import Amazonka.BackupStorage.ListChunks
import Amazonka.BackupStorage.ListObjects
import Amazonka.BackupStorage.NotifyObjectComplete
import Amazonka.BackupStorage.PutChunk
import Amazonka.BackupStorage.PutObject
import Amazonka.BackupStorage.StartObject
import Amazonka.BackupStorage.Types
import Amazonka.BackupStorage.Waiters

-- $errors
-- Error matchers are designed for use with the functions provided by
-- <http://hackage.haskell.org/package/lens/docs/Control-Exception-Lens.html Control.Exception.Lens>.
-- This allows catching (and rethrowing) service specific errors returned
-- by 'BackupStorage'.

-- $operations
-- Some AWS operations return results that are incomplete and require subsequent
-- requests in order to obtain the entire result set. The process of sending
-- subsequent requests to continue where a previous request left off is called
-- pagination. For example, the 'ListObjects' operation of Amazon S3 returns up to
-- 1000 objects at a time, and you must send subsequent requests with the
-- appropriate Marker in order to retrieve the next page of results.
--
-- Operations that have an 'AWSPager' instance can transparently perform subsequent
-- requests, correctly setting Markers and other request facets to iterate through
-- the entire result set of a truncated API operation. Operations which support
-- this have an additional note in the documentation.
--
-- Many operations have the ability to filter results on the server side. See the
-- individual operation parameters for details.

-- $waiters
-- Waiters poll by repeatedly sending a request until some remote success condition
-- configured by the 'Wait' specification is fulfilled. The 'Wait' specification
-- determines how many attempts should be made, in addition to delay and retry strategies.