account_plan_states

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

Overview

Name	account_plan_states
Type	Resource
Id	aws.freetier.account_plan_states

Fields

The following fields are returned by SELECT queries:

get_account_plan_state

Name	Datatype	Description
account_id	string	A unique identifier that identifies the account. (pattern: <code>[0-9]{12}</code>)
account_plan_expiration_date	string (date-time)	The timestamp for when the current account plan expires.
account_plan_remaining_credits	object	The amount of credits remaining for the account.
account_plan_status	string	The current status for the account plan. (NOT_STARTED, ACTIVE, EXPIRED)
account_plan_type	string	The plan type for the account. (FREE, PAID)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_account_plan_state	select	region		This returns all of the information related to the state of the account plan related to Free Tier.

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_account_plan_state

This returns all of the information related to the state of the account plan related to Free Tier.

SELECT
account_id,
account_plan_expiration_date,
account_plan_remaining_credits,
account_plan_status,
account_plan_type
FROM aws.freetier.account_plan_states
WHERE region = '{{ region }}' -- required
;