Skip to content

ListRulesRequest

Source code in docs_src/capo_rbin/types/list_rules_request.py
class ListRulesRequest(TypedDict, closed=True):
    max_results: NotRequired["capo_rbin.types.max_results.MaxResults"]
    """<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>"""
    next_token: NotRequired["capo_rbin.types.next_token.NextToken"]
    """<p>The token for the next page of results.</p>"""
    resource_type: "capo_rbin.types.resource_type.ResourceType"
    """<p>The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs are supported.</p> <ul> <li> <p>To list retention rules that retain EBS volumes, specify <code>EBS_VOLUME</code>.</p> </li> <li> <p>To list retention rules that retain EBS snapshots, specify <code>EBS_SNAPSHOT</code>.</p> </li> <li> <p>To list retention rules that retain EBS-backed AMIs, specify <code>EC2_IMAGE</code>.</p> </li> </ul>"""
    resource_tags: NotRequired["capo_rbin.types.resource_tags.ResourceTags"]
    """<p>[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.</p>"""
    lock_state: NotRequired["capo_rbin.types.lock_state.LockState"]
    """<p>The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.</p>"""
    exclude_resource_tags: NotRequired[
        "capo_rbin.types.exclude_resource_tags.ExcludeResourceTags"
    ]
    """<p>[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.</p>"""

exclude_resource_tags instance-attribute

exclude_resource_tags: NotRequired[ExcludeResourceTags]

[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

lock_state instance-attribute

lock_state: NotRequired[LockState]

The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.

next_token instance-attribute

next_token: NotRequired[NextToken]

The token for the next page of results.

resource_tags instance-attribute

resource_tags: NotRequired[ResourceTags]

[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.

resource_type instance-attribute

resource_type: ResourceType

The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs are supported.

  • To list retention rules that retain EBS volumes, specify EBS_VOLUME.

  • To list retention rules that retain EBS snapshots, specify EBS_SNAPSHOT.

  • To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.