amazonka-mediastore-dataplane-2.0: gen/Amazonka/MediaStoreData.hs

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

-- |
-- Module      : Amazonka.MediaStoreData
-- 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 @2017-09-01@ of the AWS service descriptions, licensed under Apache 2.0.
--
-- An AWS Elemental MediaStore asset is an object, similar to an object in
-- the Amazon S3 service. Objects are the fundamental entities that are
-- stored in AWS Elemental MediaStore.
module Amazonka.MediaStoreData
  ( -- * Service Configuration
    defaultService,

    -- * Errors
    -- $errors

    -- ** ContainerNotFoundException
    _ContainerNotFoundException,

    -- ** InternalServerError
    _InternalServerError,

    -- ** ObjectNotFoundException
    _ObjectNotFoundException,

    -- ** RequestedRangeNotSatisfiableException
    _RequestedRangeNotSatisfiableException,

    -- * Waiters
    -- $waiters

    -- * Operations
    -- $operations

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

    -- ** DescribeObject
    DescribeObject (DescribeObject'),
    newDescribeObject,
    DescribeObjectResponse (DescribeObjectResponse'),
    newDescribeObjectResponse,

    -- ** GetObject
    GetObject (GetObject'),
    newGetObject,
    GetObjectResponse (GetObjectResponse'),
    newGetObjectResponse,

    -- ** ListItems (Paginated)
    ListItems (ListItems'),
    newListItems,
    ListItemsResponse (ListItemsResponse'),
    newListItemsResponse,

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

    -- * Types

    -- ** ItemType
    ItemType (..),

    -- ** StorageClass
    StorageClass (..),

    -- ** UploadAvailability
    UploadAvailability (..),

    -- ** Item
    Item (Item'),
    newItem,
  )
where

import Amazonka.MediaStoreData.DeleteObject
import Amazonka.MediaStoreData.DescribeObject
import Amazonka.MediaStoreData.GetObject
import Amazonka.MediaStoreData.Lens
import Amazonka.MediaStoreData.ListItems
import Amazonka.MediaStoreData.PutObject
import Amazonka.MediaStoreData.Types
import Amazonka.MediaStoreData.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 'MediaStoreData'.

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