agreement_entitlements

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

Overview

Name	agreement_entitlements
Type	Resource
Id	aws.marketplace_agreement.agreement_entitlements

Fields

The following fields are returned by SELECT queries:

get_agreement_entitlements

Name	Datatype	Description
license_arn	string	The Amazon Resource Name (ARN) of the AWS License Manager license associated with the entitlement. (pattern: <code>arn:aws[a-zA-Z-]*:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}</code>)
registration_token	string	A short-lived token required by acceptors to register their account with the product provider. The token is only valid for 30 minutes after creation and is only applicable for purchase agreements. (pattern: <code>[A-Za-z0-9+/=.:_-]+</code>)
resource	object	The list of resources involved in the agreement.
status	string	The current state of an entitlement. (PROVISIONED, SCHEDULED, PENDING, FAILED, DEPROVISIONED)
status_reason_code	string	Provides more information about the status of an entitlement. (PROVISIONING_IN_PROGRESS, FUTURE_START_DATE, INVALID_PAYMENT_INSTRUMENT, INCOMPATIBLE_CURRENCY, ACCOUNT_SUSPENDED, UNSUPPORTED_OPERATION, AGREEMENT_INACTIVE, AGREEMENT_ACTIVE, PRODUCT_RESTRICTED)
type_	string	The type of entitlement. (pattern: <code>[A-Za-z:]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_agreement_entitlements	select	region		Obtains details about the entitlements of an agreement.

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_agreement_entitlements

Obtains details about the entitlements of an agreement.

SELECT
license_arn,
registration_token,
resource,
status,
status_reason_code,
type_
FROM aws.marketplace_agreement.agreement_entitlements
WHERE region = '{{ region }}' -- required
;