long_term_pricings

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

Overview

Name	long_term_pricings
Type	Resource
Id	aws.snowball.long_term_pricings

Fields

The following fields are returned by SELECT queries:

list_long_term_pricing

Name	Datatype	Description
current_active_job	string	The current active jobs on the device the long-term pricing type. (pattern: <code>(M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
is_long_term_pricing_auto_renew	boolean	If set to true, specifies that the current long-term pricing type for the device should be automatically renewed before the long-term pricing contract expires.
job_ids	array	The IDs of the jobs that are associated with a long-term pricing type.
long_term_pricing_end_date	string (date-time)	The end date the long-term pricing contract.
long_term_pricing_id	string	The ID of the long-term pricing type for the device. (pattern: <code>LTPID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
long_term_pricing_start_date	string (date-time)	The start date of the long-term pricing contract.
long_term_pricing_status	string	The status of the long-term pricing type. (pattern: <code>.*</code>)
long_term_pricing_type	string	The type of long-term pricing that was selected for the device. (OneYear, ThreeYear, OneMonth)
replacement_job	string	A new device that replaces a device that is ordered with long-term pricing. (pattern: <code>(M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
snowball_type	string	The type of Snow Family devices associated with this long-term pricing job. (STANDARD, EDGE, EDGE_C, EDGE_CG, EDGE_S, SNC1_HDD, SNC1_SSD, V3_5C, V3_5S, RACK_5U_C)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_long_term_pricing	select	region		Lists all long-term pricing types.
create_long_term_pricing	insert	region, LongTermPricingType, SnowballType		Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing.
update_long_term_pricing	update	region, LongTermPricingId		Updates the long-term pricing type.

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_long_term_pricing

Lists all long-term pricing types.

SELECT
current_active_job,
is_long_term_pricing_auto_renew,
job_ids,
long_term_pricing_end_date,
long_term_pricing_id,
long_term_pricing_start_date,
long_term_pricing_status,
long_term_pricing_type,
replacement_job,
snowball_type
FROM aws.snowball.long_term_pricings
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_long_term_pricing

Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing.

INSERT INTO aws.snowball.long_term_pricings (
LongTermPricingType,
IsLongTermPricingAutoRenew,
SnowballType,
region
)
SELECT 
'{{ LongTermPricingType }}' /* required */,
{{ IsLongTermPricingAutoRenew }},
'{{ SnowballType }}' /* required */,
'{{ region }}'
RETURNING
long_term_pricing_id
;

Manifest

# Description fields are for documentation purposes
- name: long_term_pricings
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the long_term_pricings resource.
  - name: LongTermPricingType
    value: "{{ LongTermPricingType }}"
    description: |
      The type of long-term pricing option you want for the device, either 1-year or 3-year long-term pricing.
    valid_values: ['OneYear', 'ThreeYear', 'OneMonth']
  - name: IsLongTermPricingAutoRenew
    value: {{ IsLongTermPricingAutoRenew }}
    description: |
      Specifies whether the current long-term pricing type for the device should be renewed.
  - name: SnowballType
    value: "{{ SnowballType }}"
    description: |
      The type of Snow Family devices to use for the long-term pricing job.
    valid_values: ['STANDARD', 'EDGE', 'EDGE_C', 'EDGE_CG', 'EDGE_S', 'SNC1_HDD', 'SNC1_SSD', 'V3_5C', 'V3_5S', 'RACK_5U_C']

UPDATE examples

update_long_term_pricing

Updates the long-term pricing type.

UPDATE aws.snowball.long_term_pricings
SET 
LongTermPricingId = '{{ LongTermPricingId }}',
ReplacementJob = '{{ ReplacementJob }}',
IsLongTermPricingAutoRenew = {{ IsLongTermPricingAutoRenew }}
WHERE 
region = '{{ region }}' --required
AND LongTermPricingId = '{{ LongTermPricingId }}' --required;