OpenSearchServiceServerless / Client / batch_get_lifecycle_policy

batch_get_lifecycle_policy#

OpenSearchServiceServerless.Client.batch_get_lifecycle_policy(**kwargs)#

Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

Request Syntax

response = client.batch_get_lifecycle_policy(
    identifiers=[
        {
            'name': 'string',
            'type': 'retention'
        },
    ]
)

Parameters:

identifiers (list) –

[REQUIRED]

The unique identifiers of policy types and policy names.

(dict) –

The unique identifiers of policy types and policy names.
- name (string) – [REQUIRED]
  
  The name of the lifecycle policy.
- type (string) – [REQUIRED]
  
  The type of lifecycle policy.

Return type:

dict

Returns:

Response Syntax

{
    'lifecyclePolicyDetails': [
        {
            'createdDate': 123,
            'description': 'string',
            'lastModifiedDate': 123,
            'name': 'string',
            'policy': {...}|[...]|123|123.4|'string'|True|None,
            'policyVersion': 'string',
            'type': 'retention'
        },
    ],
    'lifecyclePolicyErrorDetails': [
        {
            'errorCode': 'string',
            'errorMessage': 'string',
            'name': 'string',
            'type': 'retention'
        },
    ]
}

Response Structure

(dict) –
- lifecyclePolicyDetails (list) –
  
  A list of lifecycle policies matched to the input policy name and policy type.
  - (dict) –
    
    Details about an OpenSearch Serverless lifecycle policy.
    - createdDate (integer) –
      
      The date the lifecycle policy was created.
    - description (string) –
      
      The description of the lifecycle policy.
    - lastModifiedDate (integer) –
      
      The timestamp of when the lifecycle policy was last modified.
    - name (string) –
      
      The name of the lifecycle policy.
    - policy (document) –
      
      The JSON policy document without any whitespaces.
    - policyVersion (string) –
      
      The version of the lifecycle policy.
    - type (string) –
      
      The type of lifecycle policy.
- lifecyclePolicyErrorDetails (list) –
  
  A list of lifecycle policy names and policy types for which retrieval failed.
  - (dict) –
    
    Error information for an OpenSearch Serverless request.
    - errorCode (string) –
      
      The error code for the request. For example, NOT_FOUND.
    - errorMessage (string) –
      
      A description of the error. For example, The specified Lifecycle Policy is not found.
    - name (string) –
      
      The name of the lifecycle policy.
    - type (string) –
      
      The type of lifecycle policy.

Exceptions

OpenSearchServiceServerless.Client.exceptions.InternalServerException
OpenSearchServiceServerless.Client.exceptions.ValidationException