Network.AWS.MarketplaceEntitlement

AWS Marketplace Entitlement Service

This reference provides descriptions of the AWS Marketplace Entitlement Service API.

AWS Marketplace Entitlement Service is used to determine the entitlement of a customer to a given product. 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.

Getting Entitlement Records

• GetEntitlements - Gets the entitlements for a Marketplace product.

Service Configuration

marketplaceEntitlement :: Service

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

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by MarketplaceEntitlement.

InvalidParameterException

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

One or more parameters in your request was invalid.

ThrottlingException

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

The calls to the GetEntitlements API are throttled.

InternalServiceErrorException

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

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

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

GetEntitlements

module Network.AWS.MarketplaceEntitlement.GetEntitlements

Types

GetEntitlementFilterName

data GetEntitlementFilterName

Constructors

CustomerIdentifier

Dimension

Instances

Bounded GetEntitlementFilterName

Methods

minBound :: GetEntitlementFilterName

maxBound :: GetEntitlementFilterName

Enum GetEntitlementFilterName

Methods

succ :: GetEntitlementFilterName -> GetEntitlementFilterName

pred :: GetEntitlementFilterName -> GetEntitlementFilterName

toEnum :: Int -> GetEntitlementFilterName

fromEnum :: GetEntitlementFilterName -> Int

enumFrom :: GetEntitlementFilterName -> [GetEntitlementFilterName]

enumFromThen :: GetEntitlementFilterName -> GetEntitlementFilterName -> [GetEntitlementFilterName]

enumFromTo :: GetEntitlementFilterName -> GetEntitlementFilterName -> [GetEntitlementFilterName]

enumFromThenTo :: GetEntitlementFilterName -> GetEntitlementFilterName -> GetEntitlementFilterName -> [GetEntitlementFilterName]

Eq GetEntitlementFilterName

Methods

(==) :: GetEntitlementFilterName -> GetEntitlementFilterName -> Bool

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

Data GetEntitlementFilterName

Methods

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

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

toConstr :: GetEntitlementFilterName -> Constr

dataTypeOf :: GetEntitlementFilterName -> DataType

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

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

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

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

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

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

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

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

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

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

Ord GetEntitlementFilterName

Methods

compare :: GetEntitlementFilterName -> GetEntitlementFilterName -> Ordering

(<) :: GetEntitlementFilterName -> GetEntitlementFilterName -> Bool

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

(>) :: GetEntitlementFilterName -> GetEntitlementFilterName -> Bool

(>=) :: GetEntitlementFilterName -> GetEntitlementFilterName -> Bool

max :: GetEntitlementFilterName -> GetEntitlementFilterName -> GetEntitlementFilterName

min :: GetEntitlementFilterName -> GetEntitlementFilterName -> GetEntitlementFilterName

Read GetEntitlementFilterName

Methods

readsPrec :: Int -> ReadS GetEntitlementFilterName

readList :: ReadS [GetEntitlementFilterName]

readPrec :: ReadPrec GetEntitlementFilterName

readListPrec :: ReadPrec [GetEntitlementFilterName]

Show GetEntitlementFilterName

Methods

showsPrec :: Int -> GetEntitlementFilterName -> ShowS

show :: GetEntitlementFilterName -> String

showList :: [GetEntitlementFilterName] -> ShowS

Generic GetEntitlementFilterName

Associated Types

type Rep GetEntitlementFilterName :: * -> *

Methods

from :: GetEntitlementFilterName -> Rep GetEntitlementFilterName x

to :: Rep GetEntitlementFilterName x -> GetEntitlementFilterName

Hashable GetEntitlementFilterName

Methods

hashWithSalt :: Int -> GetEntitlementFilterName -> Int

hash :: GetEntitlementFilterName -> Int

ToJSON GetEntitlementFilterName

Methods

toJSON :: GetEntitlementFilterName -> Value

toEncoding :: GetEntitlementFilterName -> Encoding

toJSONList :: [GetEntitlementFilterName] -> Value

toEncodingList :: [GetEntitlementFilterName] -> Encoding

NFData GetEntitlementFilterName

Methods

rnf :: GetEntitlementFilterName -> ()

ToHeader GetEntitlementFilterName

Methods

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

ToQuery GetEntitlementFilterName

Methods

toQuery :: GetEntitlementFilterName -> QueryString

ToByteString GetEntitlementFilterName

Methods

toBS :: GetEntitlementFilterName -> ByteString

FromText GetEntitlementFilterName

Methods

parser :: Parser GetEntitlementFilterName

ToText GetEntitlementFilterName

Methods

toText :: GetEntitlementFilterName -> Text

type Rep GetEntitlementFilterName

type Rep GetEntitlementFilterName = D1 * (MetaData "GetEntitlementFilterName" "Network.AWS.MarketplaceEntitlement.Types.Sum" "amazonka-marketplace-entitlement-1.6.0-5CWUo1Wi53RGG1H4JXPUL5" False) ((:+:) * (C1 * (MetaCons "CustomerIdentifier" PrefixI False) (U1 *)) (C1 * (MetaCons "Dimension" PrefixI False) (U1 *)))

Entitlement

data Entitlement

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: entitlement smart constructor.

Instances

Eq Entitlement

Methods

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

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

Data Entitlement

Methods

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

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

toConstr :: Entitlement -> Constr

dataTypeOf :: Entitlement -> DataType

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

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

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

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

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

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

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

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

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

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

Read Entitlement

Methods

readsPrec :: Int -> ReadS Entitlement

readList :: ReadS [Entitlement]

readPrec :: ReadPrec Entitlement

readListPrec :: ReadPrec [Entitlement]

Show Entitlement

Methods

showsPrec :: Int -> Entitlement -> ShowS

show :: Entitlement -> String

showList :: [Entitlement] -> ShowS

Generic Entitlement

Associated Types

type Rep Entitlement :: * -> *

Methods

from :: Entitlement -> Rep Entitlement x

to :: Rep Entitlement x -> Entitlement

Hashable Entitlement

Methods

hashWithSalt :: Int -> Entitlement -> Int

hash :: Entitlement -> Int

FromJSON Entitlement

Methods

parseJSON :: Value -> Parser Entitlement

parseJSONList :: Value -> Parser [Entitlement]

NFData Entitlement

Methods

rnf :: Entitlement -> ()

type Rep Entitlement

type Rep Entitlement = D1 * (MetaData "Entitlement" "Network.AWS.MarketplaceEntitlement.Types.Product" "amazonka-marketplace-entitlement-1.6.0-5CWUo1Wi53RGG1H4JXPUL5" False) (C1 * (MetaCons "Entitlement'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_eDimension") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_eValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EntitlementValue)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_eExpirationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) ((:*:) * (S1 * (MetaSel (Just Symbol "_eCustomerIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_eProductCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))

entitlement :: Entitlement

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

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

• eDimension - 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.
• eValue - The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.
• eExpirationDate - 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.
• eCustomerIdentifier - 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.
• eProductCode - The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.

eDimension :: Lens' Entitlement (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.

eValue :: Lens' Entitlement (Maybe EntitlementValue)

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

eExpirationDate :: Lens' Entitlement (Maybe UTCTime)

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.

eCustomerIdentifier :: Lens' Entitlement (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.

eProductCode :: Lens' Entitlement (Maybe Text)

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

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

See: entitlementValue smart constructor.

Instances

Eq EntitlementValue

Methods

(==) :: EntitlementValue -> EntitlementValue -> Bool

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

Data EntitlementValue

Methods

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

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

toConstr :: EntitlementValue -> Constr

dataTypeOf :: EntitlementValue -> DataType

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

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

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

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

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

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

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

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

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

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

Read EntitlementValue

Methods

readsPrec :: Int -> ReadS EntitlementValue

readList :: ReadS [EntitlementValue]

readPrec :: ReadPrec EntitlementValue

readListPrec :: ReadPrec [EntitlementValue]

Show EntitlementValue

Methods

showsPrec :: Int -> EntitlementValue -> ShowS

show :: EntitlementValue -> String

showList :: [EntitlementValue] -> ShowS

Generic EntitlementValue

Associated Types

type Rep EntitlementValue :: * -> *

Methods

from :: EntitlementValue -> Rep EntitlementValue x

to :: Rep EntitlementValue x -> EntitlementValue

Hashable EntitlementValue

Methods

hashWithSalt :: Int -> EntitlementValue -> Int

hash :: EntitlementValue -> Int

FromJSON EntitlementValue

Methods

parseJSON :: Value -> Parser EntitlementValue

parseJSONList :: Value -> Parser [EntitlementValue]

NFData EntitlementValue

Methods

rnf :: EntitlementValue -> ()

type Rep EntitlementValue

type Rep EntitlementValue = D1 * (MetaData "EntitlementValue" "Network.AWS.MarketplaceEntitlement.Types.Product" "amazonka-marketplace-entitlement-1.6.0-5CWUo1Wi53RGG1H4JXPUL5" False) (C1 * (MetaCons "EntitlementValue'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_evIntegerValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_evDoubleValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Double)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_evStringValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_evBooleanValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))))

entitlementValue :: EntitlementValue

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

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

• evIntegerValue - The IntegerValue field will be populated with an integer value when the entitlement is an integer type. Otherwise, the field will not be set.
• evDoubleValue - The DoubleValue field will be populated with a double value when the entitlement is a double type. Otherwise, the field will not be set.
• evStringValue - The StringValue field will be populated with a string value when the entitlement is a string type. Otherwise, the field will not be set.
• evBooleanValue - The BooleanValue field will be populated with a boolean value when the entitlement is a boolean type. Otherwise, the field will not be set.

evIntegerValue :: Lens' EntitlementValue (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.

evDoubleValue :: Lens' EntitlementValue (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.

evStringValue :: Lens' EntitlementValue (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.

evBooleanValue :: Lens' EntitlementValue (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.