{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

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

-- |
-- Module      : Amazonka.MarketplaceMetering.Types.UsageRecordResult
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.MarketplaceMetering.Types.UsageRecordResult where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.MarketplaceMetering.Types.UsageRecord
import Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus
import qualified Amazonka.Prelude as Prelude

-- | A @UsageRecordResult@ indicates the status of a given @UsageRecord@
-- processed by @BatchMeterUsage@.
--
-- /See:/ 'newUsageRecordResult' smart constructor.
data UsageRecordResult = UsageRecordResult'
  { -- | The @MeteringRecordId@ is a unique identifier for this metering event.
    UsageRecordResult -> Maybe Text
meteringRecordId :: Prelude.Maybe Prelude.Text,
    -- | The @UsageRecordResult@ @Status@ indicates the status of an individual
    -- @UsageRecord@ processed by @BatchMeterUsage@.
    --
    -- -   /Success/- The @UsageRecord@ was accepted and honored by
    --     @BatchMeterUsage@.
    --
    -- -   /CustomerNotSubscribed/- The @CustomerIdentifier@ specified is not
    --     able to use your product. The @UsageRecord@ was not honored. There
    --     are three causes for this result:
    --
    --     -   The customer identifier is invalid.
    --
    --     -   The customer identifier provided in the metering record does not
    --         have an active agreement or subscription with this product.
    --         Future @UsageRecords@ for this customer will fail until the
    --         customer subscribes to your product.
    --
    --     -   The customer\'s AWS account was suspended.
    --
    -- -   /DuplicateRecord/- Indicates that the @UsageRecord@ was invalid and
    --     not honored. A previously metered @UsageRecord@ had the same
    --     customer, dimension, and time, but a different quantity.
    UsageRecordResult -> Maybe UsageRecordResultStatus
status :: Prelude.Maybe UsageRecordResultStatus,
    -- | The @UsageRecord@ that was part of the @BatchMeterUsage@ request.
    UsageRecordResult -> Maybe UsageRecord
usageRecord :: Prelude.Maybe UsageRecord
  }
  deriving (UsageRecordResult -> UsageRecordResult -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: UsageRecordResult -> UsageRecordResult -> Bool
$c/= :: UsageRecordResult -> UsageRecordResult -> Bool
== :: UsageRecordResult -> UsageRecordResult -> Bool
$c== :: UsageRecordResult -> UsageRecordResult -> Bool
Prelude.Eq, ReadPrec [UsageRecordResult]
ReadPrec UsageRecordResult
Int -> ReadS UsageRecordResult
ReadS [UsageRecordResult]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [UsageRecordResult]
$creadListPrec :: ReadPrec [UsageRecordResult]
readPrec :: ReadPrec UsageRecordResult
$creadPrec :: ReadPrec UsageRecordResult
readList :: ReadS [UsageRecordResult]
$creadList :: ReadS [UsageRecordResult]
readsPrec :: Int -> ReadS UsageRecordResult
$creadsPrec :: Int -> ReadS UsageRecordResult
Prelude.Read, Int -> UsageRecordResult -> ShowS
[UsageRecordResult] -> ShowS
UsageRecordResult -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [UsageRecordResult] -> ShowS
$cshowList :: [UsageRecordResult] -> ShowS
show :: UsageRecordResult -> String
$cshow :: UsageRecordResult -> String
showsPrec :: Int -> UsageRecordResult -> ShowS
$cshowsPrec :: Int -> UsageRecordResult -> ShowS
Prelude.Show, forall x. Rep UsageRecordResult x -> UsageRecordResult
forall x. UsageRecordResult -> Rep UsageRecordResult x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep UsageRecordResult x -> UsageRecordResult
$cfrom :: forall x. UsageRecordResult -> Rep UsageRecordResult x
Prelude.Generic)

-- |
-- Create a value of 'UsageRecordResult' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'meteringRecordId', 'usageRecordResult_meteringRecordId' - The @MeteringRecordId@ is a unique identifier for this metering event.
--
-- 'status', 'usageRecordResult_status' - The @UsageRecordResult@ @Status@ indicates the status of an individual
-- @UsageRecord@ processed by @BatchMeterUsage@.
--
-- -   /Success/- The @UsageRecord@ was accepted and honored by
--     @BatchMeterUsage@.
--
-- -   /CustomerNotSubscribed/- The @CustomerIdentifier@ specified is not
--     able to use your product. The @UsageRecord@ was not honored. There
--     are three causes for this result:
--
--     -   The customer identifier is invalid.
--
--     -   The customer identifier provided in the metering record does not
--         have an active agreement or subscription with this product.
--         Future @UsageRecords@ for this customer will fail until the
--         customer subscribes to your product.
--
--     -   The customer\'s AWS account was suspended.
--
-- -   /DuplicateRecord/- Indicates that the @UsageRecord@ was invalid and
--     not honored. A previously metered @UsageRecord@ had the same
--     customer, dimension, and time, but a different quantity.
--
-- 'usageRecord', 'usageRecordResult_usageRecord' - The @UsageRecord@ that was part of the @BatchMeterUsage@ request.
newUsageRecordResult ::
  UsageRecordResult
newUsageRecordResult :: UsageRecordResult
newUsageRecordResult =
  UsageRecordResult'
    { $sel:meteringRecordId:UsageRecordResult' :: Maybe Text
meteringRecordId =
        forall a. Maybe a
Prelude.Nothing,
      $sel:status:UsageRecordResult' :: Maybe UsageRecordResultStatus
status = forall a. Maybe a
Prelude.Nothing,
      $sel:usageRecord:UsageRecordResult' :: Maybe UsageRecord
usageRecord = forall a. Maybe a
Prelude.Nothing
    }

-- | The @MeteringRecordId@ is a unique identifier for this metering event.
usageRecordResult_meteringRecordId :: Lens.Lens' UsageRecordResult (Prelude.Maybe Prelude.Text)
usageRecordResult_meteringRecordId :: Lens' UsageRecordResult (Maybe Text)
usageRecordResult_meteringRecordId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UsageRecordResult' {Maybe Text
meteringRecordId :: Maybe Text
$sel:meteringRecordId:UsageRecordResult' :: UsageRecordResult -> Maybe Text
meteringRecordId} -> Maybe Text
meteringRecordId) (\s :: UsageRecordResult
s@UsageRecordResult' {} Maybe Text
a -> UsageRecordResult
s {$sel:meteringRecordId:UsageRecordResult' :: Maybe Text
meteringRecordId = Maybe Text
a} :: UsageRecordResult)

-- | The @UsageRecordResult@ @Status@ indicates the status of an individual
-- @UsageRecord@ processed by @BatchMeterUsage@.
--
-- -   /Success/- The @UsageRecord@ was accepted and honored by
--     @BatchMeterUsage@.
--
-- -   /CustomerNotSubscribed/- The @CustomerIdentifier@ specified is not
--     able to use your product. The @UsageRecord@ was not honored. There
--     are three causes for this result:
--
--     -   The customer identifier is invalid.
--
--     -   The customer identifier provided in the metering record does not
--         have an active agreement or subscription with this product.
--         Future @UsageRecords@ for this customer will fail until the
--         customer subscribes to your product.
--
--     -   The customer\'s AWS account was suspended.
--
-- -   /DuplicateRecord/- Indicates that the @UsageRecord@ was invalid and
--     not honored. A previously metered @UsageRecord@ had the same
--     customer, dimension, and time, but a different quantity.
usageRecordResult_status :: Lens.Lens' UsageRecordResult (Prelude.Maybe UsageRecordResultStatus)
usageRecordResult_status :: Lens' UsageRecordResult (Maybe UsageRecordResultStatus)
usageRecordResult_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UsageRecordResult' {Maybe UsageRecordResultStatus
status :: Maybe UsageRecordResultStatus
$sel:status:UsageRecordResult' :: UsageRecordResult -> Maybe UsageRecordResultStatus
status} -> Maybe UsageRecordResultStatus
status) (\s :: UsageRecordResult
s@UsageRecordResult' {} Maybe UsageRecordResultStatus
a -> UsageRecordResult
s {$sel:status:UsageRecordResult' :: Maybe UsageRecordResultStatus
status = Maybe UsageRecordResultStatus
a} :: UsageRecordResult)

-- | The @UsageRecord@ that was part of the @BatchMeterUsage@ request.
usageRecordResult_usageRecord :: Lens.Lens' UsageRecordResult (Prelude.Maybe UsageRecord)
usageRecordResult_usageRecord :: Lens' UsageRecordResult (Maybe UsageRecord)
usageRecordResult_usageRecord = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UsageRecordResult' {Maybe UsageRecord
usageRecord :: Maybe UsageRecord
$sel:usageRecord:UsageRecordResult' :: UsageRecordResult -> Maybe UsageRecord
usageRecord} -> Maybe UsageRecord
usageRecord) (\s :: UsageRecordResult
s@UsageRecordResult' {} Maybe UsageRecord
a -> UsageRecordResult
s {$sel:usageRecord:UsageRecordResult' :: Maybe UsageRecord
usageRecord = Maybe UsageRecord
a} :: UsageRecordResult)

instance Data.FromJSON UsageRecordResult where
  parseJSON :: Value -> Parser UsageRecordResult
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"UsageRecordResult"
      ( \Object
x ->
          Maybe Text
-> Maybe UsageRecordResultStatus
-> Maybe UsageRecord
-> UsageRecordResult
UsageRecordResult'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"MeteringRecordId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Status")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"UsageRecord")
      )

instance Prelude.Hashable UsageRecordResult where
  hashWithSalt :: Int -> UsageRecordResult -> Int
hashWithSalt Int
_salt UsageRecordResult' {Maybe Text
Maybe UsageRecord
Maybe UsageRecordResultStatus
usageRecord :: Maybe UsageRecord
status :: Maybe UsageRecordResultStatus
meteringRecordId :: Maybe Text
$sel:usageRecord:UsageRecordResult' :: UsageRecordResult -> Maybe UsageRecord
$sel:status:UsageRecordResult' :: UsageRecordResult -> Maybe UsageRecordResultStatus
$sel:meteringRecordId:UsageRecordResult' :: UsageRecordResult -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
meteringRecordId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe UsageRecordResultStatus
status
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe UsageRecord
usageRecord

instance Prelude.NFData UsageRecordResult where
  rnf :: UsageRecordResult -> ()
rnf UsageRecordResult' {Maybe Text
Maybe UsageRecord
Maybe UsageRecordResultStatus
usageRecord :: Maybe UsageRecord
status :: Maybe UsageRecordResultStatus
meteringRecordId :: Maybe Text
$sel:usageRecord:UsageRecordResult' :: UsageRecordResult -> Maybe UsageRecord
$sel:status:UsageRecordResult' :: UsageRecordResult -> Maybe UsageRecordResultStatus
$sel:meteringRecordId:UsageRecordResult' :: UsageRecordResult -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
meteringRecordId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe UsageRecordResultStatus
status
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe UsageRecord
usageRecord