BatchGetEffectiveLifecyclePolicy - Amazon OpenSearch Serverless


Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.

Request Syntax

{ "resourceIdentifiers": [ { "resource": "string", "type": "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.


The unique identifiers of policy types and resource names.

Type: Array of LifecyclePolicyResourceIdentifier objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: Yes

Response Syntax

{ "effectiveLifecyclePolicyDetails": [ { "noMinRetentionPeriod": boolean, "policyName": "string", "resource": "string", "resourceType": "string", "retentionPeriod": "string", "type": "string" } ], "effectiveLifecyclePolicyErrorDetails": [ { "errorCode": "string", "errorMessage": "string", "resource": "string", "type": "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.


A list of lifecycle policies applied to the OpenSearch Serverless indexes.

Type: Array of EffectiveLifecyclePolicyDetail objects


A list of resources for which retrieval failed.

Type: Array of EffectiveLifecyclePolicyErrorDetail objects


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


Thrown when an error internal to the service occurs while processing a request.

HTTP Status Code: 500


Thrown when the HTTP request contains invalid input or is missing required input.

HTTP Status Code: 400

See Also

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