vm_entitlements

Creates, updates, deletes, gets or lists a vm_entitlements resource.

Overview

Name	vm_entitlements
Type	Resource
Id	aws.evs.vm_entitlements

Fields

The following fields are returned by SELECT queries:

list_vm_entitlements

Name	Datatype	Description
connector_id	string	The unique ID of the connector associated with the entitlement. (pattern: <code>(cnctr-[a-zA-Z0-9]{10})</code>)
environment_id	string	The unique ID of the environment. (pattern: <code>(env-[a-zA-Z0-9]{10})</code>)
error_detail	object	The error details associated with the entitlement, if applicable.
last_synced_at	string (date-time)	The date and time that the entitlement was last synced.
started_at	string (date-time)	The date and time that the entitlement started.
status	string	The status of the entitlement. (CREATING, CREATED, DELETED, AT_RISK, ENTITLEMENT_REMOVED, CREATE_FAILED)
stopped_at	string (date-time)	The date and time that the entitlement stopped.
type_	string	The type of entitlement. (WINDOWS_SERVER)
vm_id	string	The unique ID of the virtual machine. (pattern: <code>vm-[0-9]+</code>)
vm_name	string	The name of the virtual machine.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_vm_entitlements	select	region		Lists the Windows Server License entitlements for virtual machines in an Amazon EVS environment. Returns existing entitlements for virtual machines associated with the specified environment and connector.

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

list_vm_entitlements

Lists the Windows Server License entitlements for virtual machines in an Amazon EVS environment. Returns existing entitlements for virtual machines associated with the specified environment and connector.

SELECT
connector_id,
environment_id,
error_detail,
last_synced_at,
started_at,
status,
stopped_at,
type_,
vm_id,
vm_name
FROM aws.evs.vm_entitlements
WHERE region = '{{ region }}' -- required
;