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

Description

Derived from API version 2017-01-11 of the AWS service descriptions, licensed under Apache 2.0.

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.
Synopsis

Service Configuration

defaultService :: Service Source #

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 Source #

One or more parameters in your request was invalid.

ThrottlingException

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

The calls to the GetEntitlements API are throttled.

InternalServiceErrorException

_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.

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 (Paginated)

data GetEntitlements Source #

The GetEntitlementsRequest contains parameters for the GetEntitlements operation.

See: newGetEntitlements smart constructor.

Instances

Instances details
Eq GetEntitlements Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Read GetEntitlements Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Show GetEntitlements Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Generic GetEntitlements Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Associated Types

type Rep GetEntitlements :: Type -> Type #

NFData GetEntitlements Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Methods

rnf :: GetEntitlements -> () #

Hashable GetEntitlements Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

ToJSON GetEntitlements Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

AWSPager GetEntitlements Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

AWSRequest GetEntitlements Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Associated Types

type AWSResponse GetEntitlements #

ToHeaders GetEntitlements Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

ToPath GetEntitlements Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

ToQuery GetEntitlements Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

type Rep GetEntitlements Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

type Rep GetEntitlements = D1 ('MetaData "GetEntitlements" "Amazonka.MarketplaceEntitlement.GetEntitlements" "libZSservicesZSamazonka-marketplace-entitlementZSamazonka-marketplace-entitlement" 'False) (C1 ('MetaCons "GetEntitlements'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap GetEntitlementFilterName (NonEmpty Text))))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "productCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetEntitlements Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

newGetEntitlements Source #

Create a value of GetEntitlements 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:nextToken:GetEntitlements', getEntitlements_nextToken - For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.

$sel:filter':GetEntitlements', getEntitlements_filter - Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and then intersected for each filter key.

$sel:maxResults:GetEntitlements', getEntitlements_maxResults - The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements.

$sel:productCode:GetEntitlements', getEntitlements_productCode - Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS Marketplace when the product listing is created.

data GetEntitlementsResponse Source #

The GetEntitlementsRequest contains results from the GetEntitlements operation.

See: newGetEntitlementsResponse smart constructor.

Instances

Instances details
Eq GetEntitlementsResponse Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Read GetEntitlementsResponse Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Show GetEntitlementsResponse Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Generic GetEntitlementsResponse Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Associated Types

type Rep GetEntitlementsResponse :: Type -> Type #

NFData GetEntitlementsResponse Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

Methods

rnf :: GetEntitlementsResponse -> () #

type Rep GetEntitlementsResponse Source # 
Instance details

Defined in Amazonka.MarketplaceEntitlement.GetEntitlements

type Rep GetEntitlementsResponse = D1 ('MetaData "GetEntitlementsResponse" "Amazonka.MarketplaceEntitlement.GetEntitlements" "libZSservicesZSamazonka-marketplace-entitlementZSamazonka-marketplace-entitlement" 'False) (C1 ('MetaCons "GetEntitlementsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "entitlements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Entitlement])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetEntitlementsResponse Source #

Create a value of GetEntitlementsResponse 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:nextToken:GetEntitlements', getEntitlementsResponse_nextToken - For paginated results, use NextToken in subsequent calls to GetEntitlements. If the result contains an empty set of entitlements, NextToken might still be present and should be used.

$sel:entitlements:GetEntitlementsResponse', getEntitlementsResponse_entitlements - The set of entitlements found through the GetEntitlements operation. If the result contains an empty set of entitlements, NextToken might still be present and should be used.

$sel:httpStatus:GetEntitlementsResponse', getEntitlementsResponse_httpStatus - The response's http status code.

Types

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.

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.

EntitlementValue

data EntitlementValue Source #

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

See: newEntitlementValue smart constructor.

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.