Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1446252177.2 KB

Returns a list of OpenSearch Serverless lifecycle policies. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list">Viewing data lifecycle policies</a>.

post/#X-Amz-Target=OpenSearchServerless.ListLifecyclePolicies

Headers

X-Amz-Target'OpenSearchServerless.ListLifecyclePolicies' required

Request body

type'retention' required

The type of lifecycle policy.

resourcesLifecycleResource[]

Resource filters that policies can apply to. Currently, the only supported resource type is <code>index</code>.

nextTokenstring

If your initial <code>ListLifecyclePolicies</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListLifecyclePolicies</code> operations, which returns results in the next page.

maxResultsinteger

An optional parameter that specifies the maximum number of results to return. You can use use <code>nextToken</code> to get the next page of results. The default is 10.

Response

Success

nextTokenstring

When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.