DeleteLifecyclePolicy
Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.
Request Syntax
{
"clientToken": "string",
"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.
- clientToken
-
Unique, case-sensitive identifier to ensure idempotency of the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Required: No
- name
-
The name of the policy to delete.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 32.
Pattern:
^[a-z][a-z0-9-]+$Required: Yes
- type
-
The type of lifecycle policy.
Type: String
Valid Values:
retentionRequired: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
HTTP Status Code: 400
- InternalServerException
-
Thrown when an error internal to the service occurs while processing a request.
HTTP Status Code: 500
- ResourceNotFoundException
-
Thrown when accessing or deleting a resource that does not exist.
HTTP Status Code: 400
- 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:
