account_settings
Creates, updates, deletes, gets or lists an account_settings resource.
Overview
| Name | account_settings |
| Type | Resource |
| Id | aws.timestream_query.account_settings |
Fields
The following fields are returned by SELECT queries:
- describe_account_settings
| Name | Datatype | Description |
|---|---|---|
max_query_tcu | integer | The maximum number of Timestream compute units (TCUs) the service will use at any point in time to serve your queries. To run queries, you must set a minimum capacity of 4 TCU. You can set the maximum number of TCU in multiples of 4, for example, 4, 8, 16, 32, and so on. This configuration is applicable only for on-demand usage of (TCUs). |
query_compute | object | An object that contains the usage settings for Timestream Compute Units (TCUs) in your account for the query workload. |
query_pricing_model | string | The pricing model for queries in your account. The QueryPricingModel parameter is used by several Timestream operations; however, the UpdateAccountSettings API operation doesn't recognize any values other than COMPUTE_UNITS. (BYTES_SCANNED, COMPUTE_UNITS) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_account_settings | select | region | Describes the settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload. You're charged only for the duration of compute units used for your workloads. | |
update_account_settings | update | region | Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured. If you reduce the value of MaxQueryTCU to a desired configuration, the new value can take up to 24 hours to be effective. After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned for query pricing. |
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 settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload. You're charged only for the duration of compute units used for your workloads.
SELECT
max_query_tcu,
query_compute,
query_pricing_model
FROM aws.timestream_query.account_settings
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- update_account_settings
Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured. If you reduce the value of MaxQueryTCU to a desired configuration, the new value can take up to 24 hours to be effective. After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned for query pricing.
UPDATE aws.timestream_query.account_settings
SET
MaxQueryTCU = {{ MaxQueryTCU }},
QueryPricingModel = '{{ QueryPricingModel }}',
QueryCompute = '{{ QueryCompute }}'
WHERE
region = '{{ region }}' --required
RETURNING
max_query_tcu,
query_compute,
query_pricing_model;