UpdateAccountSettings - Amazon Timestream

UpdateAccountSettings

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.

Note

After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned for query pricing.

Request Syntax

{ "MaxQueryTCU": number, "QueryCompute": { "ComputeMode": "string", "ProvisionedCapacity": { "NotificationConfiguration": { "RoleArn": "string", "SnsConfiguration": { "TopicArn": "string" } }, "TargetQueryTCU": number } }, "QueryPricingModel": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxQueryTCU

The maximum number of compute units 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. The maximum value supported for MaxQueryTCU is 1000. To request an increase to this soft limit, contact AWS Support. For information about the default quota for maxQueryTCU, see Default quotas. This configuration is applicable only for on-demand usage of Timestream Compute Units (TCUs).

The maximum value supported for MaxQueryTCU is 1000. To request an increase to this soft limit, contact AWS Support. For information about the default quota for maxQueryTCU, see Default quotas.

Type: Integer

Required: No

QueryCompute

Modifies the query compute settings configured in your account, including the query pricing model and provisioned Timestream Compute Units (TCUs) in your account. QueryCompute is available only in the Asia Pacific (Mumbai) region.

Note

This API is idempotent, meaning that making the same request multiple times will have the same effect as making the request once.

Type: QueryComputeRequest object

Required: No

QueryPricingModel

The pricing model for queries in an account.

Note

The QueryPricingModel parameter is used by several Timestream operations; however, the UpdateAccountSettings API operation doesn't recognize any values other than COMPUTE_UNITS.

Type: String

Valid Values: BYTES_SCANNED | COMPUTE_UNITS

Required: No

Response Syntax

{ "MaxQueryTCU": number, "QueryCompute": { "ComputeMode": "string", "ProvisionedCapacity": { "ActiveQueryTCU": number, "LastUpdate": { "Status": "string", "StatusMessage": "string", "TargetQueryTCU": number }, "NotificationConfiguration": { "RoleArn": "string", "SnsConfiguration": { "TopicArn": "string" } } } }, "QueryPricingModel": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MaxQueryTCU

The configured maximum number of compute units the service will use at any point in time to serve your queries.

Type: Integer

QueryCompute

Confirms the updated account settings for querying data in your account. QueryCompute is available only in the Asia Pacific (Mumbai) region.

Type: QueryComputeResponse object

QueryPricingModel

The pricing model for an account.

Type: String

Valid Values: BYTES_SCANNED | COMPUTE_UNITS

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have the necessary permissions to access the account settings.

HTTP Status Code: 400

InternalServerException

An internal server error occurred while processing the request.

HTTP Status Code: 400

InvalidEndpointException

The requested endpoint is invalid.

HTTP Status Code: 400

ThrottlingException

The request was throttled due to excessive requests.

HTTP Status Code: 400

ValidationException

Invalid or malformed request.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: