Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListLifecyclePolicies

Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

Request Syntax


{
   "maxResults": number,
   "nextToken": "string",
   "resources": [ "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.

maxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

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

Type: String

Required: No

resources

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

Type: Array of strings

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

Required: No

type

The type of lifecycle policy.

Type: String

Valid Values: retention

Required: Yes

Response Syntax


{
   "lifecyclePolicySummaries": [ 
      { 
         "createdDate": number,
         "description": "string",
         "lastModifiedDate": number,
         "name": "string",
         "policyVersion": "string",
         "type": "string"
      }
   ],
   "nextToken": "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.

lifecyclePolicySummaries

Details about the requested lifecycle policies.

Type: Array of LifecyclePolicySummary objects

nextToken

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

Type: String

Errors

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

InternalServerException

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

HTTP Status Code: 500

ValidationException

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

HTTP Status Code: 400