BatchGetLifecyclePolicy
Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
Request Syntax
{
"identifiers": [
{
"name": "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.
- identifiers
-
The unique identifiers of policy types and policy names.
Type: Array of LifecyclePolicyIdentifier objects
Array Members: Minimum number of 1 item. Maximum number of 40 items.
Required: Yes
Response Syntax
{
"lifecyclePolicyDetails": [
{
"createdDate": number,
"description": "string",
"lastModifiedDate": number,
"name": "string",
"policy": JSON value,
"policyVersion": "string",
"type": "string"
}
],
"lifecyclePolicyErrorDetails": [
{
"errorCode": "string",
"errorMessage": "string",
"name": "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.
- lifecyclePolicyDetails
-
A list of lifecycle policies matched to the input policy name and policy type.
Type: Array of LifecyclePolicyDetail objects
- lifecyclePolicyErrorDetails
-
A list of lifecycle policy names and policy types for which retrieval failed.
Type: Array of LifecyclePolicyErrorDetail objects
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
