Amazonka.MarketplaceMetering.Types

Service Configuration

defaultService :: Service

API version 2016-01-14 of the Amazon Marketplace Metering SDK configuration.

Errors

_CustomerNotEntitledException :: AsError a => Fold a ServiceError

Exception thrown when the customer does not have a valid subscription for the product.

_DisabledApiException :: AsError a => Fold a ServiceError

The API is disabled in the Region.

_DuplicateRequestException :: AsError a => Fold a ServiceError

A metering record has already been emitted by the same EC2 instance, ECS task, or EKS pod for the given {usageDimension, timestamp} with a different usageQuantity.

_ExpiredTokenException :: AsError a => Fold a ServiceError

The submitted registration token has expired. This can happen if the buyer's browser takes too long to redirect to your page, the buyer has resubmitted the registration token, or your application has held on to the registration token for too long. Your SaaS registration website should redeem this token as soon as it is submitted by the buyer's browser.

_InternalServiceErrorException :: AsError a => Fold a ServiceError

An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

_InvalidCustomerIdentifierException :: AsError a => Fold a ServiceError

You have metered usage for a CustomerIdentifier that does not exist.

_InvalidEndpointRegionException :: AsError a => Fold a ServiceError

The endpoint being called is in a AWS Region different from your EC2 instance, ECS task, or EKS pod. The Region of the Metering Service endpoint and the AWS Region of the resource must match.

_InvalidProductCodeException :: AsError a => Fold a ServiceError

The product code passed does not match the product code used for publishing the product.

_InvalidPublicKeyVersionException :: AsError a => Fold a ServiceError

Public Key version is invalid.

_InvalidRegionException :: AsError a => Fold a ServiceError

RegisterUsage must be called in the same AWS Region the ECS task was launched in. This prevents a container from hardcoding a Region (e.g. withRegion(“us-east-1”) when calling RegisterUsage.

_InvalidTagException :: AsError a => Fold a ServiceError

The tag is invalid, or the number of tags is greater than 5.

_InvalidTokenException :: AsError a => Fold a ServiceError

Registration token is invalid.

_InvalidUsageAllocationsException :: AsError a => Fold a ServiceError

The usage allocation objects are invalid, or the number of allocations is greater than 500 for a single usage record.

_InvalidUsageDimensionException :: AsError a => Fold a ServiceError

The usage dimension does not match one of the UsageDimensions associated with products.

_PlatformNotSupportedException :: AsError a => Fold a ServiceError

AWS Marketplace does not support metering usage from the underlying platform. Currently, Amazon ECS, Amazon EKS, and AWS Fargate are supported.

_ThrottlingException :: AsError a => Fold a ServiceError

The calls to the API are throttled.

_TimestampOutOfBoundsException :: AsError a => Fold a ServiceError

The timestamp value passed in the UsageRecord is out of allowed range.

For BatchMeterUsage, if any of the records are outside of the allowed range, the entire batch is not processed. You must remove invalid records and try again.

UsageRecordResultStatus

newtype UsageRecordResultStatus

Constructors

UsageRecordResultStatus'

Fields

• fromUsageRecordResultStatus :: Text

Bundled Patterns

pattern UsageRecordResultStatus_CustomerNotSubscribed :: UsageRecordResultStatus

pattern UsageRecordResultStatus_DuplicateRecord :: UsageRecordResultStatus

pattern UsageRecordResultStatus_Success :: UsageRecordResultStatus

Instances

FromJSON UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

parseJSON :: Value -> Parser UsageRecordResultStatus

parseJSONList :: Value -> Parser [UsageRecordResultStatus]

FromJSONKey UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

fromJSONKey :: FromJSONKeyFunction UsageRecordResultStatus

fromJSONKeyList :: FromJSONKeyFunction [UsageRecordResultStatus]

ToJSON UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

toJSON :: UsageRecordResultStatus -> Value

toEncoding :: UsageRecordResultStatus -> Encoding

toJSONList :: [UsageRecordResultStatus] -> Value

toEncodingList :: [UsageRecordResultStatus] -> Encoding

ToJSONKey UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

toJSONKey :: ToJSONKeyFunction UsageRecordResultStatus

toJSONKeyList :: ToJSONKeyFunction [UsageRecordResultStatus]

ToByteString UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

toBS :: UsageRecordResultStatus -> ByteString

ToHeader UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

toHeader :: HeaderName -> UsageRecordResultStatus -> [Header]

ToLog UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

build :: UsageRecordResultStatus -> ByteStringBuilder

ToQuery UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

toQuery :: UsageRecordResultStatus -> QueryString

FromText UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

fromText :: Text -> Either String UsageRecordResultStatus

ToText UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

toText :: UsageRecordResultStatus -> Text

FromXML UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

parseXML :: [Node] -> Either String UsageRecordResultStatus

ToXML UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

toXML :: UsageRecordResultStatus -> XML

Generic UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Associated Types

type Rep UsageRecordResultStatus :: Type -> Type

Methods

from :: UsageRecordResultStatus -> Rep UsageRecordResultStatus x

to :: Rep UsageRecordResultStatus x -> UsageRecordResultStatus

Read UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

readsPrec :: Int -> ReadS UsageRecordResultStatus

readList :: ReadS [UsageRecordResultStatus]

readPrec :: ReadPrec UsageRecordResultStatus

readListPrec :: ReadPrec [UsageRecordResultStatus]

Show UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

showsPrec :: Int -> UsageRecordResultStatus -> ShowS

show :: UsageRecordResultStatus -> String

showList :: [UsageRecordResultStatus] -> ShowS

NFData UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

rnf :: UsageRecordResultStatus -> ()

Eq UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

(==) :: UsageRecordResultStatus -> UsageRecordResultStatus -> Bool

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

Ord UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

compare :: UsageRecordResultStatus -> UsageRecordResultStatus -> Ordering

(<) :: UsageRecordResultStatus -> UsageRecordResultStatus -> Bool

(<=) :: UsageRecordResultStatus -> UsageRecordResultStatus -> Bool

(>) :: UsageRecordResultStatus -> UsageRecordResultStatus -> Bool

(>=) :: UsageRecordResultStatus -> UsageRecordResultStatus -> Bool

max :: UsageRecordResultStatus -> UsageRecordResultStatus -> UsageRecordResultStatus

min :: UsageRecordResultStatus -> UsageRecordResultStatus -> UsageRecordResultStatus

Hashable UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

Methods

hashWithSalt :: Int -> UsageRecordResultStatus -> Int

hash :: UsageRecordResultStatus -> Int

type Rep UsageRecordResultStatus

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus

type Rep UsageRecordResultStatus = D1 ('MetaData "UsageRecordResultStatus" "Amazonka.MarketplaceMetering.Types.UsageRecordResultStatus" "amazonka-marketplace-metering-2.0-8iXXI93nW7fIf59koqHJQ" 'True) (C1 ('MetaCons "UsageRecordResultStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromUsageRecordResultStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Tag

data Tag

Metadata assigned to an allocation. Each tag is made up of a key and a value.

See: newTag smart constructor.

Constructors

Tag'

Fields

• key :: Text

  One part of a key-value pair that makes up a tag. A key is a label that acts like a category for the specific tag values.

• value :: Text

  One part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.

Instances

FromJSON Tag

Defined in Amazonka.MarketplaceMetering.Types.Tag

Methods

parseJSON :: Value -> Parser Tag

parseJSONList :: Value -> Parser [Tag]

ToJSON Tag

Defined in Amazonka.MarketplaceMetering.Types.Tag

Methods

toJSON :: Tag -> Value

toEncoding :: Tag -> Encoding

toJSONList :: [Tag] -> Value

toEncodingList :: [Tag] -> Encoding

Generic Tag

Defined in Amazonka.MarketplaceMetering.Types.Tag

Associated Types

type Rep Tag :: Type -> Type

Methods

from :: Tag -> Rep Tag x

to :: Rep Tag x -> Tag

Read Tag

Defined in Amazonka.MarketplaceMetering.Types.Tag

Methods

readsPrec :: Int -> ReadS Tag

readList :: ReadS [Tag]

readPrec :: ReadPrec Tag

readListPrec :: ReadPrec [Tag]

Show Tag

Defined in Amazonka.MarketplaceMetering.Types.Tag

Methods

showsPrec :: Int -> Tag -> ShowS

show :: Tag -> String

showList :: [Tag] -> ShowS

NFData Tag

Defined in Amazonka.MarketplaceMetering.Types.Tag

Methods

rnf :: Tag -> ()

Eq Tag

Defined in Amazonka.MarketplaceMetering.Types.Tag

Methods

(==) :: Tag -> Tag -> Bool

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

Hashable Tag

Defined in Amazonka.MarketplaceMetering.Types.Tag

Methods

hashWithSalt :: Int -> Tag -> Int

hash :: Tag -> Int

type Rep Tag

Defined in Amazonka.MarketplaceMetering.Types.Tag

type Rep Tag = D1 ('MetaData "Tag" "Amazonka.MarketplaceMetering.Types.Tag" "amazonka-marketplace-metering-2.0-8iXXI93nW7fIf59koqHJQ" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTag

Arguments

:: Text

$sel:key:Tag'

-> Text

$sel:value:Tag'

-> Tag

Create a value of Tag 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:key:Tag', tag_key - One part of a key-value pair that makes up a tag. A key is a label that acts like a category for the specific tag values.

$sel:value:Tag', tag_value - One part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.

tag_key :: Lens' Tag Text

One part of a key-value pair that makes up a tag. A key is a label that acts like a category for the specific tag values.

tag_value :: Lens' Tag Text

One part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.

UsageAllocation

data UsageAllocation

Usage allocations allow you to split usage into buckets by tags.

Each UsageAllocation indicates the usage quantity for a specific set of tags.

See: newUsageAllocation smart constructor.

Constructors

UsageAllocation'

Fields

• tags :: Maybe (NonEmpty Tag)

  The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out.

• allocatedUsageQuantity :: Natural

  The total quantity allocated to this bucket of usage.

Instances

FromJSON UsageAllocation

Defined in Amazonka.MarketplaceMetering.Types.UsageAllocation

Methods

parseJSON :: Value -> Parser UsageAllocation

parseJSONList :: Value -> Parser [UsageAllocation]

ToJSON UsageAllocation

Defined in Amazonka.MarketplaceMetering.Types.UsageAllocation

Methods

toJSON :: UsageAllocation -> Value

toEncoding :: UsageAllocation -> Encoding

toJSONList :: [UsageAllocation] -> Value

toEncodingList :: [UsageAllocation] -> Encoding

Generic UsageAllocation

Defined in Amazonka.MarketplaceMetering.Types.UsageAllocation

Associated Types

type Rep UsageAllocation :: Type -> Type

Methods

from :: UsageAllocation -> Rep UsageAllocation x

to :: Rep UsageAllocation x -> UsageAllocation

Read UsageAllocation

Defined in Amazonka.MarketplaceMetering.Types.UsageAllocation

Methods

readsPrec :: Int -> ReadS UsageAllocation

readList :: ReadS [UsageAllocation]

readPrec :: ReadPrec UsageAllocation

readListPrec :: ReadPrec [UsageAllocation]

Show UsageAllocation

Defined in Amazonka.MarketplaceMetering.Types.UsageAllocation

Methods

showsPrec :: Int -> UsageAllocation -> ShowS

show :: UsageAllocation -> String

showList :: [UsageAllocation] -> ShowS

NFData UsageAllocation

Defined in Amazonka.MarketplaceMetering.Types.UsageAllocation

Methods

rnf :: UsageAllocation -> ()

Eq UsageAllocation

Defined in Amazonka.MarketplaceMetering.Types.UsageAllocation

Methods

(==) :: UsageAllocation -> UsageAllocation -> Bool

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

Hashable UsageAllocation

Defined in Amazonka.MarketplaceMetering.Types.UsageAllocation

Methods

hashWithSalt :: Int -> UsageAllocation -> Int

hash :: UsageAllocation -> Int

type Rep UsageAllocation

Defined in Amazonka.MarketplaceMetering.Types.UsageAllocation

type Rep UsageAllocation = D1 ('MetaData "UsageAllocation" "Amazonka.MarketplaceMetering.Types.UsageAllocation" "amazonka-marketplace-metering-2.0-8iXXI93nW7fIf59koqHJQ" 'False) (C1 ('MetaCons "UsageAllocation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "allocatedUsageQuantity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))

newUsageAllocation

Arguments

:: Natural

$sel:allocatedUsageQuantity:UsageAllocation'

-> UsageAllocation

Create a value of UsageAllocation 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:tags:UsageAllocation', usageAllocation_tags - The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out.

$sel:allocatedUsageQuantity:UsageAllocation', usageAllocation_allocatedUsageQuantity - The total quantity allocated to this bucket of usage.

usageAllocation_tags :: Lens' UsageAllocation (Maybe (NonEmpty Tag))

The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out.

usageAllocation_allocatedUsageQuantity :: Lens' UsageAllocation Natural

The total quantity allocated to this bucket of usage.

UsageRecord

data UsageRecord

A UsageRecord indicates a quantity of usage for a given product, customer, dimension and time.

Multiple requests with the same UsageRecords as input will be de-duplicated to prevent double charges.

See: newUsageRecord smart constructor.

Constructors

UsageRecord'

Fields

• quantity :: Maybe Natural

  The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.

• usageAllocations :: Maybe (NonEmpty UsageAllocation)

  The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.

• timestamp :: POSIX

  Timestamp, in UTC, for which the usage is being reported.

  Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.

• customerIdentifier :: Text

  The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.

• dimension :: Text

  During the process of registering a product on AWS Marketplace, dimensions are specified. These represent different units of value in your application.

Instances

FromJSON UsageRecord

Defined in Amazonka.MarketplaceMetering.Types.UsageRecord

Methods

parseJSON :: Value -> Parser UsageRecord

parseJSONList :: Value -> Parser [UsageRecord]

ToJSON UsageRecord

Defined in Amazonka.MarketplaceMetering.Types.UsageRecord

Methods

toJSON :: UsageRecord -> Value

toEncoding :: UsageRecord -> Encoding

toJSONList :: [UsageRecord] -> Value

toEncodingList :: [UsageRecord] -> Encoding

Generic UsageRecord

Defined in Amazonka.MarketplaceMetering.Types.UsageRecord

Associated Types

type Rep UsageRecord :: Type -> Type

Methods

from :: UsageRecord -> Rep UsageRecord x

to :: Rep UsageRecord x -> UsageRecord

Read UsageRecord

Defined in Amazonka.MarketplaceMetering.Types.UsageRecord

Methods

readsPrec :: Int -> ReadS UsageRecord

readList :: ReadS [UsageRecord]

readPrec :: ReadPrec UsageRecord

readListPrec :: ReadPrec [UsageRecord]

Show UsageRecord

Defined in Amazonka.MarketplaceMetering.Types.UsageRecord

Methods

showsPrec :: Int -> UsageRecord -> ShowS

show :: UsageRecord -> String

showList :: [UsageRecord] -> ShowS

NFData UsageRecord

Defined in Amazonka.MarketplaceMetering.Types.UsageRecord

Methods

rnf :: UsageRecord -> ()

Eq UsageRecord

Defined in Amazonka.MarketplaceMetering.Types.UsageRecord

Methods

(==) :: UsageRecord -> UsageRecord -> Bool

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

Hashable UsageRecord

Defined in Amazonka.MarketplaceMetering.Types.UsageRecord

Methods

hashWithSalt :: Int -> UsageRecord -> Int

hash :: UsageRecord -> Int

type Rep UsageRecord

Defined in Amazonka.MarketplaceMetering.Types.UsageRecord

type Rep UsageRecord = D1 ('MetaData "UsageRecord" "Amazonka.MarketplaceMetering.Types.UsageRecord" "amazonka-marketplace-metering-2.0-8iXXI93nW7fIf59koqHJQ" 'False) (C1 ('MetaCons "UsageRecord'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "quantity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "usageAllocations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty UsageAllocation)))) :*: (S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: (S1 ('MetaSel ('Just "customerIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "dimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUsageRecord

Arguments

:: UTCTime

$sel:timestamp:UsageRecord'

-> Text

$sel:customerIdentifier:UsageRecord'

-> Text

$sel:dimension:UsageRecord'

-> UsageRecord

Create a value of UsageRecord 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:quantity:UsageRecord', usageRecord_quantity - The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.

$sel:usageAllocations:UsageRecord', usageRecord_usageAllocations - The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.

$sel:timestamp:UsageRecord', usageRecord_timestamp - Timestamp, in UTC, for which the usage is being reported.

Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.

$sel:customerIdentifier:UsageRecord', usageRecord_customerIdentifier - The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.

$sel:dimension:UsageRecord', usageRecord_dimension - During the process of registering a product on AWS Marketplace, dimensions are specified. These represent different units of value in your application.

usageRecord_quantity :: Lens' UsageRecord (Maybe Natural)

The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.

usageRecord_usageAllocations :: Lens' UsageRecord (Maybe (NonEmpty UsageAllocation))

The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.

usageRecord_timestamp :: Lens' UsageRecord UTCTime

Timestamp, in UTC, for which the usage is being reported.

Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.

usageRecord_customerIdentifier :: Lens' UsageRecord Text

The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.

usageRecord_dimension :: Lens' UsageRecord Text

During the process of registering a product on AWS Marketplace, dimensions are specified. These represent different units of value in your application.

UsageRecordResult

data UsageRecordResult

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

FromJSON UsageRecordResult

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResult

Methods

parseJSON :: Value -> Parser UsageRecordResult

parseJSONList :: Value -> Parser [UsageRecordResult]

Generic UsageRecordResult

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

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResult

Methods

readsPrec :: Int -> ReadS UsageRecordResult

readList :: ReadS [UsageRecordResult]

readPrec :: ReadPrec UsageRecordResult

readListPrec :: ReadPrec [UsageRecordResult]

Show UsageRecordResult

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResult

Methods

showsPrec :: Int -> UsageRecordResult -> ShowS

show :: UsageRecordResult -> String

showList :: [UsageRecordResult] -> ShowS

NFData UsageRecordResult

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResult

Methods

rnf :: UsageRecordResult -> ()

Eq UsageRecordResult

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResult

Methods

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

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

Hashable UsageRecordResult

Defined in Amazonka.MarketplaceMetering.Types.UsageRecordResult

Methods

hashWithSalt :: Int -> UsageRecordResult -> Int

hash :: UsageRecordResult -> Int

type Rep UsageRecordResult

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

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)

The MeteringRecordId is a unique identifier for this metering event.

usageRecordResult_status :: Lens' UsageRecordResult (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.

usageRecordResult_usageRecord :: Lens' UsageRecordResult (Maybe UsageRecord)

The UsageRecord that was part of the BatchMeterUsage request.