OpenSearchServiceServerless / Client / get_account_settings

get_account_settings#

OpenSearchServiceServerless.Client.get_account_settings()#

Returns account-level settings related to OpenSearch Serverless.

See also: AWS API Documentation

Request Syntax

response = client.get_account_settings()
Return type:

dict

Returns:

Response Syntax

{
    'accountSettingsDetail': {
        'capacityLimits': {
            'maxIndexingCapacityInOCU': 123,
            'maxSearchCapacityInOCU': 123
        }
    }
}

Response Structure

  • (dict) –

    • accountSettingsDetail (dict) –

      OpenSearch Serverless-related details for the current account.

      • capacityLimits (dict) –

        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.

        • maxIndexingCapacityInOCU (integer) –

          The maximum indexing capacity for collections.

        • maxSearchCapacityInOCU (integer) –

          The maximum search capacity for collections.

Exceptions

  • OpenSearchServiceServerless.Client.exceptions.InternalServerException

  • OpenSearchServiceServerless.Client.exceptions.ValidationException