account_settings

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

Overview

Name	account_settings
Type	Resource
Id	aws.kinesis.account_settings

Fields

The following fields are returned by SELECT queries:

describe_account_settings

Name	Datatype	Description
earliest_allowed_end_at	string (date-time)	The earliest timestamp when the commitment can be ended.
ended_at	string (date-time)	The timestamp when the commitment was ended.
started_at	string (date-time)	The timestamp when the commitment was started.
status	string	The current status of the minimum throughput billing commitment. (ENABLED, DISABLED, ENABLED_UNTIL_EARLIEST_ALLOWED_END)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_account_settings	select	region		Describes the account-level settings for Amazon Kinesis Data Streams. This operation returns information about the minimum throughput billing commitments and other account-level configurations. This API has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. TPS over 5 will initiate the LimitExceededException.
update_account_settings	update	region, MinimumThroughputBillingCommitment		Updates the account-level settings for Amazon Kinesis Data Streams. Updating account settings is a synchronous operation. Upon receiving the request, Kinesis Data Streams will return immediately with your account’s updated settings. API limits Certain account configurations have minimum commitment windows. Attempting to update your settings prior to the end of the minimum commitment window might have certain restrictions. This API has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. TPS over 5 will initiate the LimitExceededException.

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

describe_account_settings

Describes the account-level settings for Amazon Kinesis Data Streams. This operation returns information about the minimum throughput billing commitments and other account-level configurations. This API has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. TPS over 5 will initiate the LimitExceededException.

SELECT
earliest_allowed_end_at,
ended_at,
started_at,
status
FROM aws.kinesis.account_settings
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_account_settings

Updates the account-level settings for Amazon Kinesis Data Streams. Updating account settings is a synchronous operation. Upon receiving the request, Kinesis Data Streams will return immediately with your account’s updated settings. API limits Certain account configurations have minimum commitment windows. Attempting to update your settings prior to the end of the minimum commitment window might have certain restrictions. This API has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. TPS over 5 will initiate the LimitExceededException.

UPDATE aws.kinesis.account_settings
SET 
MinimumThroughputBillingCommitment = '{{ MinimumThroughputBillingCommitment }}'
WHERE 
region = '{{ region }}' --required
AND MinimumThroughputBillingCommitment = '{{ MinimumThroughputBillingCommitment }}' --required
RETURNING
minimum_throughput_billing_commitment;