accounts

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

Overview

Name	accounts
Type	Resource
Id	aws.apigateway.accounts

Fields

The following fields are returned by SELECT queries:

get_account

Name	Datatype	Description
api_key_version	string	The version of the API keys used for the account.
cloudwatch_role_arn	string	The ARN of an Amazon CloudWatch role for the current Account.
features	array	A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".
throttle_settings	object	The API request rate limits.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_account	select	region		Gets information about the current Account resource.
update_account	update	region		Changes information about the current Account resource.

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

Gets information about the current Account resource.

SELECT
api_key_version,
cloudwatch_role_arn,
features,
throttle_settings
FROM aws.apigateway.accounts
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_account

Changes information about the current Account resource.

UPDATE aws.apigateway.accounts
SET 
patchOperations = '{{ patchOperations }}'
WHERE 
region = '{{ region }}' --required
RETURNING
api_key_version,
cloudwatch_role_arn,
features,
throttle_settings;