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

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

API version 2017-01-11 of the Amazon Marketplace Entitlement Service SDK configuration.

Errors

_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #

One or more parameters in your request was invalid.

_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The calls to the GetEntitlements API are throttled.

_InternalServiceErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

GetEntitlementFilterName

newtype GetEntitlementFilterName Source #

Instances

Instances details
Eq GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

Ord GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

Read GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

Show GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

Generic GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

Associated Types

type Rep GetEntitlementFilterName :: Type -> Type #

NFData GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

Hashable GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

ToJSON GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

ToJSONKey GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

FromJSON GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

FromJSONKey GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

ToLog GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

ToHeader GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

ToQuery GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

FromXML GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

ToXML GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

ToByteString GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

FromText GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

ToText GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

type Rep GetEntitlementFilterName Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName

type Rep GetEntitlementFilterName = D1 ('MetaData "GetEntitlementFilterName" "Amazonka.MarketplaceEntitlement.Types.GetEntitlementFilterName" "libZSservicesZSamazonka-marketplace-entitlementZSamazonka-marketplace-entitlement" 'True) (C1 ('MetaCons "GetEntitlementFilterName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromGetEntitlementFilterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Entitlement

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

Read Entitlement Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.Entitlement

Show Entitlement Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.Entitlement

Generic Entitlement Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.Entitlement

Associated Types

type Rep Entitlement :: Type -> Type #

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

FromJSON Entitlement Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.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.

EntitlementValue

data EntitlementValue Source #

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

See: newEntitlementValue smart constructor.

Constructors

EntitlementValue' 

Fields

  • integerValue :: Maybe Int

    The IntegerValue field will be populated with an integer value when the entitlement is an integer type. Otherwise, the field will not be set.

  • doubleValue :: Maybe Double

    The DoubleValue field will be populated with a double value when the entitlement is a double type. Otherwise, the field will not be set.

  • stringValue :: Maybe Text

    The StringValue field will be populated with a string value when the entitlement is a string type. Otherwise, the field will not be set.

  • booleanValue :: Maybe Bool

    The BooleanValue field will be populated with a boolean value when the entitlement is a boolean type. Otherwise, the field will not be set.

Instances

Instances details
Eq EntitlementValue Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.EntitlementValue

Read EntitlementValue Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.EntitlementValue

Show EntitlementValue Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.EntitlementValue

Generic EntitlementValue Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.EntitlementValue

Associated Types

type Rep EntitlementValue :: Type -> Type #

NFData EntitlementValue Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.EntitlementValue

Methods

rnf :: EntitlementValue -> () #

Hashable EntitlementValue Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.EntitlementValue

FromJSON EntitlementValue Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.EntitlementValue

type Rep EntitlementValue Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.Types.EntitlementValue

type Rep EntitlementValue = D1 ('MetaData "EntitlementValue" "Amazonka.MarketplaceEntitlement.Types.EntitlementValue" "libZSservicesZSamazonka-marketplace-entitlementZSamazonka-marketplace-entitlement" 'False) (C1 ('MetaCons "EntitlementValue'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "integerValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "doubleValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "stringValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "booleanValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newEntitlementValue :: EntitlementValue Source #

Create a value of EntitlementValue 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:integerValue:EntitlementValue', entitlementValue_integerValue - The IntegerValue field will be populated with an integer value when the entitlement is an integer type. Otherwise, the field will not be set.

$sel:doubleValue:EntitlementValue', entitlementValue_doubleValue - The DoubleValue field will be populated with a double value when the entitlement is a double type. Otherwise, the field will not be set.

$sel:stringValue:EntitlementValue', entitlementValue_stringValue - The StringValue field will be populated with a string value when the entitlement is a string type. Otherwise, the field will not be set.

$sel:booleanValue:EntitlementValue', entitlementValue_booleanValue - The BooleanValue field will be populated with a boolean value when the entitlement is a boolean type. Otherwise, the field will not be set.

entitlementValue_integerValue :: Lens' EntitlementValue (Maybe Int) Source #

The IntegerValue field will be populated with an integer value when the entitlement is an integer type. Otherwise, the field will not be set.

entitlementValue_doubleValue :: Lens' EntitlementValue (Maybe Double) Source #

The DoubleValue field will be populated with a double value when the entitlement is a double type. Otherwise, the field will not be set.

entitlementValue_stringValue :: Lens' EntitlementValue (Maybe Text) Source #

The StringValue field will be populated with a string value when the entitlement is a string type. Otherwise, the field will not be set.

entitlementValue_booleanValue :: Lens' EntitlementValue (Maybe Bool) Source #

The BooleanValue field will be populated with a boolean value when the entitlement is a boolean type. Otherwise, the field will not be set.