Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
Parameters:
-
type
(LifecyclePolicyType)
–
The type of lifecycle policy.
-
resources
(Optional[LifecycleResourceFilter], default:
None
)
–
Resource filters that policies can apply to. Currently, the only supported resource type is index.
-
next_token
(Optional[str], default:
None
)
–
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.
-
max_results
(Optional[int], default:
None
)
–
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.
Raises:
Source code in docs_src/capo_opensearchserverless/_services/open_search_serverless.py
| def list_lifecycle_policies(
self,
type: "capo_opensearchserverless.types.lifecycle_policy_type.LifecyclePolicyType",
*,
config_overrides: Optional[OpenSearchServerlessClientConfig] = None,
resources: Optional[
"capo_opensearchserverless.types.lifecycle_resource_filter.LifecycleResourceFilter"
] = None,
next_token: Optional[str] = None,
max_results: Optional[int] = None,
) -> "capo_opensearchserverless.types.list_lifecycle_policies_response.ListLifecyclePoliciesResponse":
"""<p>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>.</p>
Args:
type: <p>The type of lifecycle policy.</p>
resources: <p>Resource filters that policies can apply to. Currently, the only supported resource type is <code>index</code>.</p>
next_token: <p>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.</p>
max_results: <p>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.</p>
Raises:
capo_opensearchserverless.errors.internal_server_exception.InternalServerException: <p>Thrown when an error internal to the service occurs while processing a request.</p>
capo_opensearchserverless.errors.validation_exception.ValidationException: <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
capo_opensearchserverless.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_opensearchserverless.types.list_lifecycle_policies_request.ListLifecyclePoliciesRequest]",
) -> OperationResponse[
"capo_opensearchserverless.types.list_lifecycle_policies_response.ListLifecyclePoliciesResponse"
]:
import capo_opensearchserverless._operations.open_search_serverless.list_lifecycle_policies
output, http_response = (
capo_opensearchserverless._operations.open_search_serverless.list_lifecycle_policies.list_lifecycle_policies(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListLifecyclePolicies")
)
input_: capo_opensearchserverless.types.list_lifecycle_policies_request.ListLifecyclePoliciesRequest = {
"type": type
}
if resources is not None:
input_["resources"] = resources
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|