Menu
AWS Marketplace Entitlement Service
API Reference (API Version 2017-01-11)

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.

Contents

Note

In the following list, the required parameters are described first.

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.

Type: String

Pattern: \S+

Required: No

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.

Type: String

Pattern: \S+

Required: No

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.

Type: Timestamp

Required: No

ProductCode

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

Value

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

Type: EntitlementValue object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: