offerings

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

Overview

Name	offerings
Type	Resource
Id	aws.devicefarm.offerings

Fields

The following fields are returned by SELECT queries:

list_offerings

Name	Datatype	Description
id	string	The ID that corresponds to a device offering.
description	string	A string that describes the offering.
platform	string	The platform of the device (for example, ANDROID or IOS). (ANDROID, IOS)
recurring_charges	array	Specifies whether there are recurring charges for the offering.
type_	string	The type of offering (for example, RECURRING) for a device. (RECURRING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_offerings	select	region		Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.
purchase_offering	exec	region, offeringId, quantity		Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.
renew_offering	exec	region, offeringId, quantity		Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

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_offerings

Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

SELECT
id,
description,
platform,
recurring_charges,
type_
FROM aws.devicefarm.offerings
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

purchase_offering

Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

EXEC aws.devicefarm.offerings.purchase_offering 
@region='{{ region }}' --required 
@@json=
'{
"offeringId": "{{ offeringId }}", 
"quantity": {{ quantity }}, 
"offeringPromotionId": "{{ offeringPromotionId }}"
}'
;

renew_offering

Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

EXEC aws.devicefarm.offerings.renew_offering 
@region='{{ region }}' --required 
@@json=
'{
"offeringId": "{{ offeringId }}", 
"quantity": {{ quantity }}
}'
;