entitlements

Creates, updates, deletes, gets or lists an entitlements resource.

Overview

Name	entitlements
Type	Resource
Id	aws.marketplace_entitlement.entitlements

Fields

The following fields are returned by SELECT queries:

get_entitlements

Name	Datatype	Description
customer_aws_account_id	string	The CustomerAWSAccountId parameter specifies the AWS account ID of the buyer. (pattern: <code>\S+</code>)
customer_identifier	string	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. (pattern: <code>\S+</code>)
dimension	string	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. (pattern: <code>\S+</code>)
expiration_date	string (date-time)	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.
license_arn	string	The LicenseArn is a unique identifier for a specific granted license. These are used for software purchased through AWS Marketplace.
product_code	string	The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.
value	object	The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_entitlements	select	region		GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier, AWS account ID, license ARN, or product dimensions.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_entitlements

GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier, AWS account ID, license ARN, or product dimensions.

SELECT
customer_aws_account_id,
customer_identifier,
dimension,
expiration_date,
license_arn,
product_code,
value
FROM aws.marketplace_entitlement.entitlements
WHERE region = '{{ region }}' -- required
;