Skip to content

ListRulesInput

Source code in docs_src/capo_datazone/types/list_rules_input.py
class ListRulesInput(TypedDict, closed=True):
    domain_identifier: "capo_datazone.types.domain_id.DomainId"
    """<p>The ID of the domain in which the rules are to be listed.</p>"""
    target_type: "capo_datazone.types.rule_target_type.RuleTargetType"
    """<p>The target type of the rule.</p>"""
    target_identifier: "str"
    """<p>The target ID of the rule.</p>"""
    rule_type: NotRequired["capo_datazone.types.rule_type.RuleType"]
    """<p>The type of the rule.</p>"""
    action: NotRequired["capo_datazone.types.rule_action.RuleAction"]
    """<p>The action of the rule.</p>"""
    project_ids: NotRequired["capo_datazone.types.project_ids.ProjectIds"]
    """<p>The IDs of projects in which rules are to be listed.</p>"""
    asset_types: NotRequired[
        "capo_datazone.types.asset_type_identifiers.AssetTypeIdentifiers"
    ]
    """<p>The asset types of the rule.</p>"""
    data_product: NotRequired["bool"]
    """<p>The data product of the rule.</p>"""
    include_cascaded: NotRequired["bool"]
    """<p>Specifies whether to include cascading rules in the results.</p>"""
    max_results: NotRequired["int"]
    """<p>The maximum number of rules to return in a single call to <code>ListRules</code>. When the number of rules to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>ListRules</code> to list the next set of rules.</p>"""
    next_token: NotRequired["capo_datazone.types.pagination_token.PaginationToken"]
    """<p>When the number of rules is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of rules, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListRules</code> to list the next set of rules.</p>"""

action instance-attribute

action: NotRequired[RuleAction]

The action of the rule.

asset_types instance-attribute

asset_types: NotRequired[AssetTypeIdentifiers]

The asset types of the rule.

data_product instance-attribute

data_product: NotRequired[bool]

The data product of the rule.

domain_identifier instance-attribute

domain_identifier: DomainId

The ID of the domain in which the rules are to be listed.

include_cascaded instance-attribute

include_cascaded: NotRequired[bool]

Specifies whether to include cascading rules in the results.

max_results instance-attribute

max_results: NotRequired[int]

The maximum number of rules to return in a single call to ListRules. When the number of rules to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListRules to list the next set of rules.

next_token instance-attribute

next_token: NotRequired[PaginationToken]

When the number of rules is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of rules, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListRules to list the next set of rules.

project_ids instance-attribute

project_ids: NotRequired[ProjectIds]

The IDs of projects in which rules are to be listed.

rule_type instance-attribute

rule_type: NotRequired[RuleType]

The type of the rule.

target_identifier instance-attribute

target_identifier: str

The target ID of the rule.

target_type instance-attribute

target_type: RuleTargetType

The target type of the rule.