Skip to content

CreateLifecyclePolicyRequest

Source code in docs_src/capo_opensearchserverless/types/create_lifecycle_policy_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class CreateLifecyclePolicyRequest(TypedDict, closed=True):
    type: "capo_opensearchserverless.types.lifecycle_policy_type.LifecyclePolicyType"
    """<p>The type of lifecycle policy.</p>"""
    name: "capo_opensearchserverless.types.policy_name.PolicyName"
    """<p>The name of the lifecycle policy.</p>"""
    description: NotRequired[
        "capo_opensearchserverless.types.policy_description.PolicyDescription"
    ]
    """<p>A description of the lifecycle policy.</p>"""
    policy: "capo_opensearchserverless.types.policy_document.PolicyDocument"
    """<p>The JSON policy document to use as the content for the lifecycle policy.</p>"""
    client_token: NotRequired[
        "capo_opensearchserverless.types.client_token.ClientToken"
    ]
    """<p>A unique, case-sensitive identifier to ensure idempotency of the request.</p>"""

client_token instance-attribute 

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier to ensure idempotency of the request.

description instance-attribute 

description: NotRequired[PolicyDescription]

A description of the lifecycle policy.

name instance-attribute 

name: PolicyName

The name of the lifecycle policy.

policy instance-attribute 

policy: PolicyDocument

The JSON policy document to use as the content for the lifecycle policy.

type instance-attribute 

type: LifecyclePolicyType

The type of lifecycle policy.