account_settings

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

Overview

Name	account_settings
Type	Resource
Id	aws.opensearchserverless.account_settings

Fields

The following fields are returned by SELECT queries:

get_account_settings

Name	Datatype	Description
capacity_limits	object	The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_account_settings	select	region		Returns account-level settings related to OpenSearch Serverless.
update_account_settings	update	region		Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.

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_settings

Returns account-level settings related to OpenSearch Serverless.

SELECT
capacity_limits
FROM aws.opensearchserverless.account_settings
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_account_settings

Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.

UPDATE aws.opensearchserverless.account_settings
SET 
capacityLimits = '{{ capacityLimits }}'
WHERE 
region = '{{ region }}' --required
RETURNING
account_settings_detail;