libZSservicesZSamazonka-marketplace-entitlementZSamazonka-marketplace-entitlement
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MarketplaceEntitlement.Types.Entitlement

Description

 
Synopsis

Documentation

data Entitlement Source #

An entitlement represents capacity in a product owned by the customer. For example, a customer might own some number of users or seats in an SaaS application or some amount of data capacity in a multi-tenant database.

See: newEntitlement smart constructor.

Constructors

Entitlement' 

Fields

  • dimension :: Maybe Text

    The dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.

  • value :: Maybe EntitlementValue

    The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.

  • expirationDate :: Maybe POSIX

    The expiration date represents the minimum date through which this entitlement is expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date is the date at which the customer will renew or cancel their contract. Customers who are opting to renew their contract will still have entitlements with an expiration date.

  • customerIdentifier :: Maybe Text

    The customer identifier is a handle to each unique customer in an application. Customer identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering Service.

  • productCode :: Maybe Text

    The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.

Instances

Instances details
Eq Entitlement Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.Entitlement

Methods

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

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

Read Entitlement Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.Entitlement

Methods

readsPrec :: Int -> ReadS Entitlement #

readList :: ReadS [Entitlement] #

readPrec :: ReadPrec Entitlement #

readListPrec :: ReadPrec [Entitlement] #

Show Entitlement Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.Entitlement

Methods

showsPrec :: Int -> Entitlement -> ShowS #

show :: Entitlement -> String #

showList :: [Entitlement] -> ShowS #

Generic Entitlement Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.Entitlement

Associated Types

type Rep Entitlement :: Type -> Type #

Methods

from :: Entitlement -> Rep Entitlement x #

to :: Rep Entitlement x -> Entitlement #

NFData Entitlement Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.Entitlement

Methods

rnf :: Entitlement -> () #

Hashable Entitlement Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.Entitlement

Methods

hashWithSalt :: Int -> Entitlement -> Int #

hash :: Entitlement -> Int #

FromJSON Entitlement Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.Entitlement

Methods

parseJSON :: Value -> Parser Entitlement #

parseJSONList :: Value -> Parser [Entitlement] #

type Rep Entitlement Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.Entitlement

type Rep Entitlement = D1 ('MetaData "Entitlement" "Amazonka.MarketplaceEntitlement.Types.Entitlement" "libZSservicesZSamazonka-marketplace-entitlementZSamazonka-marketplace-entitlement" 'False) (C1 ('MetaCons "Entitlement'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntitlementValue))) :*: (S1 ('MetaSel ('Just "expirationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "customerIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "productCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newEntitlement :: Entitlement Source #

Create a value of Entitlement 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:dimension:Entitlement', entitlement_dimension - The dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.

$sel:value:Entitlement', entitlement_value - The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.

$sel:expirationDate:Entitlement', entitlement_expirationDate - The expiration date represents the minimum date through which this entitlement is expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date is the date at which the customer will renew or cancel their contract. Customers who are opting to renew their contract will still have entitlements with an expiration date.

$sel:customerIdentifier:Entitlement', entitlement_customerIdentifier - The customer identifier is a handle to each unique customer in an application. Customer identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering Service.

$sel:productCode:Entitlement', entitlement_productCode - The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.

entitlement_dimension :: Lens' Entitlement (Maybe Text) Source #

The dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.

entitlement_value :: Lens' Entitlement (Maybe EntitlementValue) Source #

The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.

entitlement_expirationDate :: Lens' Entitlement (Maybe UTCTime) Source #

The expiration date represents the minimum date through which this entitlement is expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date is the date at which the customer will renew or cancel their contract. Customers who are opting to renew their contract will still have entitlements with an expiration date.

entitlement_customerIdentifier :: Lens' Entitlement (Maybe Text) Source #

The customer identifier is a handle to each unique customer in an application. Customer identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering Service.

entitlement_productCode :: Lens' Entitlement (Maybe Text) Source #

The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.