amazonka-marketplace-metering-2.0: Amazon Marketplace Metering SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MarketplaceMetering.Types.UsageRecordResult

Description

 
Synopsis

Documentation

data UsageRecordResult Source #

A UsageRecordResult indicates the status of a given UsageRecord processed by BatchMeterUsage.

See: newUsageRecordResult smart constructor.

Constructors

UsageRecordResult' 

Fields

  • meteringRecordId :: Maybe Text

    The MeteringRecordId is a unique identifier for this metering event.

  • status :: Maybe UsageRecordResultStatus

    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 :: Maybe UsageRecord

    The UsageRecord that was part of the BatchMeterUsage request.

Instances

Instances details
FromJSON UsageRecordResult Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResult

Methods

parseJSON :: Value -> Parser UsageRecordResult #

parseJSONList :: Value -> Parser [UsageRecordResult] #

Generic UsageRecordResult Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResult

Associated Types

type Rep UsageRecordResult :: Type -> Type #

Methods

from :: UsageRecordResult -> Rep UsageRecordResult x #

to :: Rep UsageRecordResult x -> UsageRecordResult #

Read UsageRecordResult Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResult

Methods

readsPrec :: Int -> ReadS UsageRecordResult #

readList :: ReadS [UsageRecordResult] #

readPrec :: ReadPrec UsageRecordResult #

readListPrec :: ReadPrec [UsageRecordResult] #

Show UsageRecordResult Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResult

Methods

showsPrec :: Int -> UsageRecordResult -> ShowS #

show :: UsageRecordResult -> String #

showList :: [UsageRecordResult] -> ShowS #

NFData UsageRecordResult Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResult

Methods

rnf :: UsageRecordResult -> () #

Eq UsageRecordResult Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResult

Methods

(==) :: UsageRecordResult -> UsageRecordResult -> Bool #

(/=) :: UsageRecordResult -> UsageRecordResult -> Bool #

Hashable UsageRecordResult Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResult

Methods

hashWithSalt :: Int -> UsageRecordResult -> Int #

hash :: UsageRecordResult -> Int #

type Rep UsageRecordResult Source # 
Instance details

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResult

type Rep UsageRecordResult = D1 ('MetaData "UsageRecordResult" "Amazonka.MarketplaceMetering.Types.UsageRecordResult" "amazonka-marketplace-metering-2.0-8iXXI93nW7fIf59koqHJQ" 'False) (C1 ('MetaCons "UsageRecordResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "meteringRecordId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageRecordResultStatus)) :*: S1 ('MetaSel ('Just "usageRecord") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageRecord)))))

newUsageRecordResult :: UsageRecordResult Source #

Create a value of UsageRecordResult with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:meteringRecordId:UsageRecordResult', usageRecordResult_meteringRecordId - The MeteringRecordId is a unique identifier for this metering event.

$sel:status:UsageRecordResult', 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.

$sel:usageRecord:UsageRecordResult', usageRecordResult_usageRecord - The UsageRecord that was part of the BatchMeterUsage request.

usageRecordResult_meteringRecordId :: Lens' UsageRecordResult (Maybe Text) Source #

The MeteringRecordId is a unique identifier for this metering event.

usageRecordResult_status :: Lens' UsageRecordResult (Maybe UsageRecordResultStatus) Source #

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_usageRecord :: Lens' UsageRecordResult (Maybe UsageRecord) Source #

The UsageRecord that was part of the BatchMeterUsage request.