licenses

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

Overview

Name	licenses
Type	Resource
Id	aws.license_manager.licenses

Fields

The following fields are returned by SELECT queries:

get_license

Name	Datatype	Description
beneficiary	string	License beneficiary.
consumption_configuration	object	Configuration for consumption of the license.
create_time	string	License creation time. (pattern: <code>^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(.[0-9]+)?(Z|[+-](?:2[ 0-3]|[0-1][0-9]):[0-5][0-9])+$</code>)
entitlements	array	License entitlements.
home_region	string	Home Region of the license.
issuer	object	License issuer.
license_arn	string	Amazon Resource Name (ARN) of the license. (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>)
license_metadata	array	License metadata.
license_name	string	License name.
product_name	string	Product name.
product_sku	string	Product SKU.
status	string	License status. (AVAILABLE, PENDING_AVAILABLE, DEACTIVATED, SUSPENDED, EXPIRED, PENDING_DELETE, DELETED)
validity	object	Date and time range during which the license is valid, in ISO8601-UTC format.
version	string	License version.

list_licenses

Name	Datatype	Description
licenses	array	License details.
next_token	string	Token for the next set of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_license	select	region		Gets detailed information about the specified license.
list_licenses	select	region		Lists the licenses for your account.
create_license	insert	region, LicenseName, ProductName, ProductSKU, Issuer, HomeRegion, Validity, Entitlements, Beneficiary, ConsumptionConfiguration, ClientToken		Creates a license.
delete_license	delete	region		Deletes the specified license.
checkout_borrow_license	exec	region, LicenseArn, Entitlements, DigitalSignatureMethod, ClientToken		Checks out the specified license for offline use.

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_license

Gets detailed information about the specified license.

SELECT
beneficiary,
consumption_configuration,
create_time,
entitlements,
home_region,
issuer,
license_arn,
license_metadata,
license_name,
product_name,
product_sku,
status,
validity,
version
FROM aws.license_manager.licenses
WHERE region = '{{ region }}' -- required
;

list_licenses

Lists the licenses for your account.

SELECT
licenses,
next_token
FROM aws.license_manager.licenses
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_license

Creates a license.

INSERT INTO aws.license_manager.licenses (
LicenseName,
ProductName,
ProductSKU,
Issuer,
HomeRegion,
Validity,
Entitlements,
Beneficiary,
ConsumptionConfiguration,
LicenseMetadata,
ClientToken,
Tags,
region
)
SELECT 
'{{ LicenseName }}' /* required */,
'{{ ProductName }}' /* required */,
'{{ ProductSKU }}' /* required */,
'{{ Issuer }}' /* required */,
'{{ HomeRegion }}' /* required */,
'{{ Validity }}' /* required */,
'{{ Entitlements }}' /* required */,
'{{ Beneficiary }}' /* required */,
'{{ ConsumptionConfiguration }}' /* required */,
'{{ LicenseMetadata }}',
'{{ ClientToken }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
license_arn,
status,
version
;

Manifest

# Description fields are for documentation purposes
- name: licenses
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the licenses resource.
  - name: LicenseName
    value: "{{ LicenseName }}"
    description: |
      License name.
  - name: ProductName
    value: "{{ ProductName }}"
    description: |
      Product name.
  - name: ProductSKU
    value: "{{ ProductSKU }}"
    description: |
      Product SKU.
  - name: Issuer
    description: |
      License issuer.
    value:
      Name: "{{ Name }}"
      SignKey: "{{ SignKey }}"
  - name: HomeRegion
    value: "{{ HomeRegion }}"
    description: |
      Home Region for the license.
  - name: Validity
    description: |
      Date and time range during which the license is valid, in ISO8601-UTC format.
    value:
      Begin: "{{ Begin }}"
      End: "{{ End }}"
  - name: Entitlements
    description: |
      License entitlements.
    value:
      - Name: "{{ Name }}"
        Value: "{{ Value }}"
        MaxCount: {{ MaxCount }}
        Overage: {{ Overage }}
        Unit: "{{ Unit }}"
        AllowCheckIn: {{ AllowCheckIn }}
  - name: Beneficiary
    value: "{{ Beneficiary }}"
    description: |
      License beneficiary.
  - name: ConsumptionConfiguration
    description: |
      Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.
    value:
      RenewType: "{{ RenewType }}"
      ProvisionalConfiguration:
        MaxTimeToLiveInMinutes: {{ MaxTimeToLiveInMinutes }}
      BorrowConfiguration:
        AllowEarlyCheckIn: {{ AllowEarlyCheckIn }}
        MaxTimeToLiveInMinutes: {{ MaxTimeToLiveInMinutes }}
  - name: LicenseMetadata
    description: |
      Information about the license.
    value:
      - Name: "{{ Name }}"
        Value: "{{ Value }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  - name: Tags
    description: |
      Tags to add to the license. For more information about tagging support in License Manager, see the TagResource operation.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_license

Deletes the specified license.

DELETE FROM aws.license_manager.licenses
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

checkout_borrow_license

Checks out the specified license for offline use.

EXEC aws.license_manager.licenses.checkout_borrow_license 
@region='{{ region }}' --required 
@@json=
'{
"LicenseArn": "{{ LicenseArn }}", 
"Entitlements": "{{ Entitlements }}", 
"DigitalSignatureMethod": "{{ DigitalSignatureMethod }}", 
"NodeId": "{{ NodeId }}", 
"CheckoutMetadata": "{{ CheckoutMetadata }}", 
"ClientToken": "{{ ClientToken }}"
}'
;