metered_products

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

Overview

Name	metered_products
Type	Resource
Id	aws.deadline.metered_products

Fields

The following fields are returned by SELECT queries:

list_metered_products

Name	Datatype	Description
family	string	The family to which the metered product belongs.
port	integer	The port on which the metered product should run.
product_id	string	The product ID. (pattern: <code>[0-9a-z]{1,32}-[.0-9a-z]{1,32}</code>)
vendor	string	The vendor.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_metered_products	select	license_endpoint_id, region	nextToken, maxResults	Lists metered products.
put_metered_product	replace	license_endpoint_id, product_id, region		Adds a metered product.
delete_metered_product	delete	license_endpoint_id, product_id, region		Deletes a metered product.

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
license_endpoint_id	string	The ID of the license endpoint from which to remove the metered product.
product_id	string	The product ID to remove from the license endpoint.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
nextToken	string	The token for the next set of results, or null to start from the beginning.

SELECT examples

list_metered_products

Lists metered products.

SELECT
family,
port,
product_id,
vendor
FROM aws.deadline.metered_products
WHERE license_endpoint_id = '{{ license_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

REPLACE examples

put_metered_product

Adds a metered product.

REPLACE aws.deadline.metered_products
SET 
-- No updatable properties
WHERE 
license_endpoint_id = '{{ license_endpoint_id }}' --required
AND product_id = '{{ product_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_metered_product

Deletes a metered product.

DELETE FROM aws.deadline.metered_products
WHERE license_endpoint_id = '{{ license_endpoint_id }}' --required
AND product_id = '{{ product_id }}' --required
AND region = '{{ region }}' --required
;