{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DerivingStrategies #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE PatternSynonyms #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.DynamoDB.Types.ReturnConsumedCapacity
-- 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)
module Amazonka.DynamoDB.Types.ReturnConsumedCapacity
  ( ReturnConsumedCapacity
      ( ..,
        ReturnConsumedCapacity_INDEXES,
        ReturnConsumedCapacity_NONE,
        ReturnConsumedCapacity_TOTAL
      ),
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Prelude as Prelude

-- | Determines the level of detail about provisioned throughput consumption
-- that is returned in the response:
--
-- -   @INDEXES@ - The response includes the aggregate @ConsumedCapacity@
--     for the operation, together with @ConsumedCapacity@ for each table
--     and secondary index that was accessed.
--
--     Note that some operations, such as @GetItem@ and @BatchGetItem@, do
--     not access any indexes at all. In these cases, specifying @INDEXES@
--     will only return @ConsumedCapacity@ information for table(s).
--
-- -   @TOTAL@ - The response includes only the aggregate
--     @ConsumedCapacity@ for the operation.
--
-- -   @NONE@ - No @ConsumedCapacity@ details are included in the response.
newtype ReturnConsumedCapacity = ReturnConsumedCapacity'
  { ReturnConsumedCapacity -> Text
fromReturnConsumedCapacity ::
      Core.Text
  }
  deriving stock
    ( Int -> ReturnConsumedCapacity -> ShowS
[ReturnConsumedCapacity] -> ShowS
ReturnConsumedCapacity -> String
(Int -> ReturnConsumedCapacity -> ShowS)
-> (ReturnConsumedCapacity -> String)
-> ([ReturnConsumedCapacity] -> ShowS)
-> Show ReturnConsumedCapacity
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ReturnConsumedCapacity] -> ShowS
$cshowList :: [ReturnConsumedCapacity] -> ShowS
show :: ReturnConsumedCapacity -> String
$cshow :: ReturnConsumedCapacity -> String
showsPrec :: Int -> ReturnConsumedCapacity -> ShowS
$cshowsPrec :: Int -> ReturnConsumedCapacity -> ShowS
Prelude.Show,
      ReadPrec [ReturnConsumedCapacity]
ReadPrec ReturnConsumedCapacity
Int -> ReadS ReturnConsumedCapacity
ReadS [ReturnConsumedCapacity]
(Int -> ReadS ReturnConsumedCapacity)
-> ReadS [ReturnConsumedCapacity]
-> ReadPrec ReturnConsumedCapacity
-> ReadPrec [ReturnConsumedCapacity]
-> Read ReturnConsumedCapacity
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ReturnConsumedCapacity]
$creadListPrec :: ReadPrec [ReturnConsumedCapacity]
readPrec :: ReadPrec ReturnConsumedCapacity
$creadPrec :: ReadPrec ReturnConsumedCapacity
readList :: ReadS [ReturnConsumedCapacity]
$creadList :: ReadS [ReturnConsumedCapacity]
readsPrec :: Int -> ReadS ReturnConsumedCapacity
$creadsPrec :: Int -> ReadS ReturnConsumedCapacity
Prelude.Read,
      ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool
(ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool)
-> (ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool)
-> Eq ReturnConsumedCapacity
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool
$c/= :: ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool
== :: ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool
$c== :: ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool
Prelude.Eq,
      Eq ReturnConsumedCapacity
Eq ReturnConsumedCapacity
-> (ReturnConsumedCapacity -> ReturnConsumedCapacity -> Ordering)
-> (ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool)
-> (ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool)
-> (ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool)
-> (ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool)
-> (ReturnConsumedCapacity
    -> ReturnConsumedCapacity -> ReturnConsumedCapacity)
-> (ReturnConsumedCapacity
    -> ReturnConsumedCapacity -> ReturnConsumedCapacity)
-> Ord ReturnConsumedCapacity
ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool
ReturnConsumedCapacity -> ReturnConsumedCapacity -> Ordering
ReturnConsumedCapacity
-> ReturnConsumedCapacity -> ReturnConsumedCapacity
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
min :: ReturnConsumedCapacity
-> ReturnConsumedCapacity -> ReturnConsumedCapacity
$cmin :: ReturnConsumedCapacity
-> ReturnConsumedCapacity -> ReturnConsumedCapacity
max :: ReturnConsumedCapacity
-> ReturnConsumedCapacity -> ReturnConsumedCapacity
$cmax :: ReturnConsumedCapacity
-> ReturnConsumedCapacity -> ReturnConsumedCapacity
>= :: ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool
$c>= :: ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool
> :: ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool
$c> :: ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool
<= :: ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool
$c<= :: ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool
< :: ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool
$c< :: ReturnConsumedCapacity -> ReturnConsumedCapacity -> Bool
compare :: ReturnConsumedCapacity -> ReturnConsumedCapacity -> Ordering
$ccompare :: ReturnConsumedCapacity -> ReturnConsumedCapacity -> Ordering
$cp1Ord :: Eq ReturnConsumedCapacity
Prelude.Ord,
      (forall x. ReturnConsumedCapacity -> Rep ReturnConsumedCapacity x)
-> (forall x.
    Rep ReturnConsumedCapacity x -> ReturnConsumedCapacity)
-> Generic ReturnConsumedCapacity
forall x. Rep ReturnConsumedCapacity x -> ReturnConsumedCapacity
forall x. ReturnConsumedCapacity -> Rep ReturnConsumedCapacity x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ReturnConsumedCapacity x -> ReturnConsumedCapacity
$cfrom :: forall x. ReturnConsumedCapacity -> Rep ReturnConsumedCapacity x
Prelude.Generic
    )
  deriving newtype
    ( Int -> ReturnConsumedCapacity -> Int
ReturnConsumedCapacity -> Int
(Int -> ReturnConsumedCapacity -> Int)
-> (ReturnConsumedCapacity -> Int)
-> Hashable ReturnConsumedCapacity
forall a. (Int -> a -> Int) -> (a -> Int) -> Hashable a
hash :: ReturnConsumedCapacity -> Int
$chash :: ReturnConsumedCapacity -> Int
hashWithSalt :: Int -> ReturnConsumedCapacity -> Int
$chashWithSalt :: Int -> ReturnConsumedCapacity -> Int
Prelude.Hashable,
      ReturnConsumedCapacity -> ()
(ReturnConsumedCapacity -> ()) -> NFData ReturnConsumedCapacity
forall a. (a -> ()) -> NFData a
rnf :: ReturnConsumedCapacity -> ()
$crnf :: ReturnConsumedCapacity -> ()
Prelude.NFData,
      Text -> Either String ReturnConsumedCapacity
(Text -> Either String ReturnConsumedCapacity)
-> FromText ReturnConsumedCapacity
forall a. (Text -> Either String a) -> FromText a
fromText :: Text -> Either String ReturnConsumedCapacity
$cfromText :: Text -> Either String ReturnConsumedCapacity
Core.FromText,
      ReturnConsumedCapacity -> Text
(ReturnConsumedCapacity -> Text) -> ToText ReturnConsumedCapacity
forall a. (a -> Text) -> ToText a
toText :: ReturnConsumedCapacity -> Text
$ctoText :: ReturnConsumedCapacity -> Text
Core.ToText,
      ReturnConsumedCapacity -> ByteString
(ReturnConsumedCapacity -> ByteString)
-> ToByteString ReturnConsumedCapacity
forall a. (a -> ByteString) -> ToByteString a
toBS :: ReturnConsumedCapacity -> ByteString
$ctoBS :: ReturnConsumedCapacity -> ByteString
Core.ToByteString,
      ReturnConsumedCapacity -> ByteStringBuilder
(ReturnConsumedCapacity -> ByteStringBuilder)
-> ToLog ReturnConsumedCapacity
forall a. (a -> ByteStringBuilder) -> ToLog a
build :: ReturnConsumedCapacity -> ByteStringBuilder
$cbuild :: ReturnConsumedCapacity -> ByteStringBuilder
Core.ToLog,
      HeaderName -> ReturnConsumedCapacity -> [Header]
(HeaderName -> ReturnConsumedCapacity -> [Header])
-> ToHeader ReturnConsumedCapacity
forall a. (HeaderName -> a -> [Header]) -> ToHeader a
toHeader :: HeaderName -> ReturnConsumedCapacity -> [Header]
$ctoHeader :: HeaderName -> ReturnConsumedCapacity -> [Header]
Core.ToHeader,
      ReturnConsumedCapacity -> QueryString
(ReturnConsumedCapacity -> QueryString)
-> ToQuery ReturnConsumedCapacity
forall a. (a -> QueryString) -> ToQuery a
toQuery :: ReturnConsumedCapacity -> QueryString
$ctoQuery :: ReturnConsumedCapacity -> QueryString
Core.ToQuery,
      Value -> Parser [ReturnConsumedCapacity]
Value -> Parser ReturnConsumedCapacity
(Value -> Parser ReturnConsumedCapacity)
-> (Value -> Parser [ReturnConsumedCapacity])
-> FromJSON ReturnConsumedCapacity
forall a.
(Value -> Parser a) -> (Value -> Parser [a]) -> FromJSON a
parseJSONList :: Value -> Parser [ReturnConsumedCapacity]
$cparseJSONList :: Value -> Parser [ReturnConsumedCapacity]
parseJSON :: Value -> Parser ReturnConsumedCapacity
$cparseJSON :: Value -> Parser ReturnConsumedCapacity
Core.FromJSON,
      FromJSONKeyFunction [ReturnConsumedCapacity]
FromJSONKeyFunction ReturnConsumedCapacity
FromJSONKeyFunction ReturnConsumedCapacity
-> FromJSONKeyFunction [ReturnConsumedCapacity]
-> FromJSONKey ReturnConsumedCapacity
forall a.
FromJSONKeyFunction a -> FromJSONKeyFunction [a] -> FromJSONKey a
fromJSONKeyList :: FromJSONKeyFunction [ReturnConsumedCapacity]
$cfromJSONKeyList :: FromJSONKeyFunction [ReturnConsumedCapacity]
fromJSONKey :: FromJSONKeyFunction ReturnConsumedCapacity
$cfromJSONKey :: FromJSONKeyFunction ReturnConsumedCapacity
Core.FromJSONKey,
      [ReturnConsumedCapacity] -> Encoding
[ReturnConsumedCapacity] -> Value
ReturnConsumedCapacity -> Encoding
ReturnConsumedCapacity -> Value
(ReturnConsumedCapacity -> Value)
-> (ReturnConsumedCapacity -> Encoding)
-> ([ReturnConsumedCapacity] -> Value)
-> ([ReturnConsumedCapacity] -> Encoding)
-> ToJSON ReturnConsumedCapacity
forall a.
(a -> Value)
-> (a -> Encoding)
-> ([a] -> Value)
-> ([a] -> Encoding)
-> ToJSON a
toEncodingList :: [ReturnConsumedCapacity] -> Encoding
$ctoEncodingList :: [ReturnConsumedCapacity] -> Encoding
toJSONList :: [ReturnConsumedCapacity] -> Value
$ctoJSONList :: [ReturnConsumedCapacity] -> Value
toEncoding :: ReturnConsumedCapacity -> Encoding
$ctoEncoding :: ReturnConsumedCapacity -> Encoding
toJSON :: ReturnConsumedCapacity -> Value
$ctoJSON :: ReturnConsumedCapacity -> Value
Core.ToJSON,
      ToJSONKeyFunction [ReturnConsumedCapacity]
ToJSONKeyFunction ReturnConsumedCapacity
ToJSONKeyFunction ReturnConsumedCapacity
-> ToJSONKeyFunction [ReturnConsumedCapacity]
-> ToJSONKey ReturnConsumedCapacity
forall a.
ToJSONKeyFunction a -> ToJSONKeyFunction [a] -> ToJSONKey a
toJSONKeyList :: ToJSONKeyFunction [ReturnConsumedCapacity]
$ctoJSONKeyList :: ToJSONKeyFunction [ReturnConsumedCapacity]
toJSONKey :: ToJSONKeyFunction ReturnConsumedCapacity
$ctoJSONKey :: ToJSONKeyFunction ReturnConsumedCapacity
Core.ToJSONKey,
      [Node] -> Either String ReturnConsumedCapacity
([Node] -> Either String ReturnConsumedCapacity)
-> FromXML ReturnConsumedCapacity
forall a. ([Node] -> Either String a) -> FromXML a
parseXML :: [Node] -> Either String ReturnConsumedCapacity
$cparseXML :: [Node] -> Either String ReturnConsumedCapacity
Core.FromXML,
      ReturnConsumedCapacity -> XML
(ReturnConsumedCapacity -> XML) -> ToXML ReturnConsumedCapacity
forall a. (a -> XML) -> ToXML a
toXML :: ReturnConsumedCapacity -> XML
$ctoXML :: ReturnConsumedCapacity -> XML
Core.ToXML
    )

pattern ReturnConsumedCapacity_INDEXES :: ReturnConsumedCapacity
pattern $bReturnConsumedCapacity_INDEXES :: ReturnConsumedCapacity
$mReturnConsumedCapacity_INDEXES :: forall r.
ReturnConsumedCapacity -> (Void# -> r) -> (Void# -> r) -> r
ReturnConsumedCapacity_INDEXES = ReturnConsumedCapacity' "INDEXES"

pattern ReturnConsumedCapacity_NONE :: ReturnConsumedCapacity
pattern $bReturnConsumedCapacity_NONE :: ReturnConsumedCapacity
$mReturnConsumedCapacity_NONE :: forall r.
ReturnConsumedCapacity -> (Void# -> r) -> (Void# -> r) -> r
ReturnConsumedCapacity_NONE = ReturnConsumedCapacity' "NONE"

pattern ReturnConsumedCapacity_TOTAL :: ReturnConsumedCapacity
pattern $bReturnConsumedCapacity_TOTAL :: ReturnConsumedCapacity
$mReturnConsumedCapacity_TOTAL :: forall r.
ReturnConsumedCapacity -> (Void# -> r) -> (Void# -> r) -> r
ReturnConsumedCapacity_TOTAL = ReturnConsumedCapacity' "TOTAL"

{-# COMPLETE
  ReturnConsumedCapacity_INDEXES,
  ReturnConsumedCapacity_NONE,
  ReturnConsumedCapacity_TOTAL,
  ReturnConsumedCapacity'
  #-}