Network.AWS.MarketplaceMetering.BatchMeterUsage

BatchMeterUsage is called from a SaaS application listed on the AWS Marketplace to post metering records for a set of customers.

For identical requests, the API is idempotent; requests can be retried with the same records or a subset of the input records.

Every request to BatchMeterUsage is for one product. If you need to meter usage for multiple products, you must make multiple calls to BatchMeterUsage.

BatchMeterUsage can process up to 25 UsageRecords at a time.

Creating a Request

batchMeterUsage

Arguments

:: Text

bmuProductCode

-> BatchMeterUsage

Creates a value of BatchMeterUsage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• bmuUsageRecords - The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time.
• bmuProductCode - Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.

data BatchMeterUsage

A BatchMeterUsageRequest contains UsageRecords, which indicate quantities of usage within your application.

See: batchMeterUsage smart constructor.

Instances

Eq BatchMeterUsage

Methods

(==) :: BatchMeterUsage -> BatchMeterUsage -> Bool

(/=) :: BatchMeterUsage -> BatchMeterUsage -> Bool

Data BatchMeterUsage

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BatchMeterUsage -> c BatchMeterUsage

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BatchMeterUsage

toConstr :: BatchMeterUsage -> Constr

dataTypeOf :: BatchMeterUsage -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c BatchMeterUsage)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BatchMeterUsage)

gmapT :: (forall b. Data b => b -> b) -> BatchMeterUsage -> BatchMeterUsage

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BatchMeterUsage -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BatchMeterUsage -> r

gmapQ :: (forall d. Data d => d -> u) -> BatchMeterUsage -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> BatchMeterUsage -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BatchMeterUsage -> m BatchMeterUsage

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BatchMeterUsage -> m BatchMeterUsage

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BatchMeterUsage -> m BatchMeterUsage

Read BatchMeterUsage

Methods

readsPrec :: Int -> ReadS BatchMeterUsage

readList :: ReadS [BatchMeterUsage]

readPrec :: ReadPrec BatchMeterUsage

readListPrec :: ReadPrec [BatchMeterUsage]

Show BatchMeterUsage

Methods

showsPrec :: Int -> BatchMeterUsage -> ShowS

show :: BatchMeterUsage -> String

showList :: [BatchMeterUsage] -> ShowS

Generic BatchMeterUsage

Associated Types

type Rep BatchMeterUsage :: * -> *

Methods

from :: BatchMeterUsage -> Rep BatchMeterUsage x

to :: Rep BatchMeterUsage x -> BatchMeterUsage

Hashable BatchMeterUsage

Methods

hashWithSalt :: Int -> BatchMeterUsage -> Int

hash :: BatchMeterUsage -> Int

ToJSON BatchMeterUsage

Methods

toJSON :: BatchMeterUsage -> Value

toEncoding :: BatchMeterUsage -> Encoding

toJSONList :: [BatchMeterUsage] -> Value

toEncodingList :: [BatchMeterUsage] -> Encoding

NFData BatchMeterUsage

Methods

rnf :: BatchMeterUsage -> ()

AWSRequest BatchMeterUsage

Associated Types

type Rs BatchMeterUsage :: *

Methods

request :: BatchMeterUsage -> Request BatchMeterUsage

response :: MonadResource m => Logger -> Service -> Proxy * BatchMeterUsage -> ClientResponse -> m (Response BatchMeterUsage)

ToPath BatchMeterUsage

Methods

toPath :: BatchMeterUsage -> ByteString

ToHeaders BatchMeterUsage

Methods

toHeaders :: BatchMeterUsage -> [Header]

ToQuery BatchMeterUsage

Methods

toQuery :: BatchMeterUsage -> QueryString

type Rep BatchMeterUsage

type Rep BatchMeterUsage = D1 (MetaData "BatchMeterUsage" "Network.AWS.MarketplaceMetering.BatchMeterUsage" "amazonka-marketplace-metering-1.4.5-JZ3hVk5dvwX6ldhauCFg6l" False) (C1 (MetaCons "BatchMeterUsage'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_bmuUsageRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [UsageRecord])) (S1 (MetaSel (Just Symbol "_bmuProductCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs BatchMeterUsage

type Rs BatchMeterUsage = BatchMeterUsageResponse

Request Lenses

bmuUsageRecords :: Lens' BatchMeterUsage [UsageRecord]

The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time.

bmuProductCode :: Lens' BatchMeterUsage Text

Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.

Destructuring the Response

batchMeterUsageResponse

Arguments

:: Int

bmursResponseStatus

-> BatchMeterUsageResponse

Creates a value of BatchMeterUsageResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• bmursResults - Contains all UsageRecords processed by BatchMeterUsage. These records were either honored by AWS Marketplace Metering Service or were invalid.
• bmursUnprocessedRecords - Contains all UsageRecords that were not processed by BatchMeterUsage. This is a list of UsageRecords. You can retry the failed request by making another BatchMeterUsage call with this list as input in the BatchMeterUsageRequest.
• bmursResponseStatus - -- | The response status code.

data BatchMeterUsageResponse

Contains the UsageRecords processed by BatchMeterUsage and any records that have failed due to transient error.

See: batchMeterUsageResponse smart constructor.

Instances

Eq BatchMeterUsageResponse

Methods

(==) :: BatchMeterUsageResponse -> BatchMeterUsageResponse -> Bool

(/=) :: BatchMeterUsageResponse -> BatchMeterUsageResponse -> Bool

Data BatchMeterUsageResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BatchMeterUsageResponse -> c BatchMeterUsageResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BatchMeterUsageResponse

toConstr :: BatchMeterUsageResponse -> Constr

dataTypeOf :: BatchMeterUsageResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c BatchMeterUsageResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BatchMeterUsageResponse)

gmapT :: (forall b. Data b => b -> b) -> BatchMeterUsageResponse -> BatchMeterUsageResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BatchMeterUsageResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BatchMeterUsageResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> BatchMeterUsageResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> BatchMeterUsageResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BatchMeterUsageResponse -> m BatchMeterUsageResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BatchMeterUsageResponse -> m BatchMeterUsageResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BatchMeterUsageResponse -> m BatchMeterUsageResponse

Read BatchMeterUsageResponse

Methods

readsPrec :: Int -> ReadS BatchMeterUsageResponse

readList :: ReadS [BatchMeterUsageResponse]

readPrec :: ReadPrec BatchMeterUsageResponse

readListPrec :: ReadPrec [BatchMeterUsageResponse]

Show BatchMeterUsageResponse

Methods

showsPrec :: Int -> BatchMeterUsageResponse -> ShowS

show :: BatchMeterUsageResponse -> String

showList :: [BatchMeterUsageResponse] -> ShowS

Generic BatchMeterUsageResponse

Associated Types

type Rep BatchMeterUsageResponse :: * -> *

Methods

from :: BatchMeterUsageResponse -> Rep BatchMeterUsageResponse x

to :: Rep BatchMeterUsageResponse x -> BatchMeterUsageResponse

NFData BatchMeterUsageResponse

Methods

rnf :: BatchMeterUsageResponse -> ()

type Rep BatchMeterUsageResponse

type Rep BatchMeterUsageResponse = D1 (MetaData "BatchMeterUsageResponse" "Network.AWS.MarketplaceMetering.BatchMeterUsage" "amazonka-marketplace-metering-1.4.5-JZ3hVk5dvwX6ldhauCFg6l" False) (C1 (MetaCons "BatchMeterUsageResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_bmursResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UsageRecordResult]))) ((:*:) (S1 (MetaSel (Just Symbol "_bmursUnprocessedRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UsageRecord]))) (S1 (MetaSel (Just Symbol "_bmursResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

bmursResults :: Lens' BatchMeterUsageResponse [UsageRecordResult]

Contains all UsageRecords processed by BatchMeterUsage. These records were either honored by AWS Marketplace Metering Service or were invalid.

bmursUnprocessedRecords :: Lens' BatchMeterUsageResponse [UsageRecord]

Contains all UsageRecords that were not processed by BatchMeterUsage. This is a list of UsageRecords. You can retry the failed request by making another BatchMeterUsage call with this list as input in the BatchMeterUsageRequest.

bmursResponseStatus :: Lens' BatchMeterUsageResponse Int

• - | The response status code.