OpenSearchServiceServerless / Client / get_policies_stats

get_policies_stats#

OpenSearchServiceServerless.Client.get_policies_stats()#

Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.

Request Syntax

response = client.get_policies_stats()

Return type:

dict

Returns:

Response Syntax

{
    'AccessPolicyStats': {
        'DataPolicyCount': 123
    },
    'LifecyclePolicyStats': {
        'RetentionPolicyCount': 123
    },
    'SecurityConfigStats': {
        'SamlConfigCount': 123
    },
    'SecurityPolicyStats': {
        'EncryptionPolicyCount': 123,
        'NetworkPolicyCount': 123
    },
    'TotalPolicyCount': 123
}

Response Structure

(dict) –
- AccessPolicyStats (dict) –
  
  Information about the data access policies in your account.
  - DataPolicyCount (integer) –
    
    The number of data access policies in the current account.
- LifecyclePolicyStats (dict) –
  
  Information about the lifecycle policies in your account.
  - RetentionPolicyCount (integer) –
    
    The number of retention lifecycle policies in the current account.
- SecurityConfigStats (dict) –
  
  Information about the security configurations in your account.
  - SamlConfigCount (integer) –
    
    The number of security configurations in the current account.
- SecurityPolicyStats (dict) –
  
  Information about the security policies in your account.
  - EncryptionPolicyCount (integer) –
    
    The number of encryption policies in the current account.
  - NetworkPolicyCount (integer) –
    
    The number of network policies in the current account.
- TotalPolicyCount (integer) –
  
  The total number of OpenSearch Serverless security policies and configurations in your account.

Exceptions

OpenSearchServiceServerless.Client.exceptions.InternalServerException