Skip to content

/AWS1/CL_DZN=>LISTRULES()

About ListRules

Lists existing rules. In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

Method Signature

IMPORTING

Required arguments:

IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID /AWS1/DZNDOMAINID

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

IV_TARGETTYPE TYPE /AWS1/DZNRULETARGETTYPE /AWS1/DZNRULETARGETTYPE

The target type of the rule.

IV_TARGETIDENTIFIER TYPE /AWS1/DZNSTRING /AWS1/DZNSTRING

The target ID of the rule.

Optional arguments:

IV_RULETYPE TYPE /AWS1/DZNRULETYPE /AWS1/DZNRULETYPE

The type of the rule.

IV_ACTION TYPE /AWS1/DZNRULEACTION /AWS1/DZNRULEACTION

The action of the rule.

IT_PROJECTIDS TYPE /AWS1/CL_DZNPROJECTIDS_W=>TT_PROJECTIDS TT_PROJECTIDS

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

IT_ASSETTYPES TYPE /AWS1/CL_DZNASSETTYPEIDS_W=>TT_ASSETTYPEIDENTIFIERS TT_ASSETTYPEIDENTIFIERS

The asset types of the rule.

IV_DATAPRODUCT TYPE /AWS1/DZNBOOLEAN /AWS1/DZNBOOLEAN

The data product of the rule.

IV_INCLUDECASCADED TYPE /AWS1/DZNBOOLEAN /AWS1/DZNBOOLEAN

Specifies whether to include cascading rules in the results.

IV_MAXRESULTS TYPE /AWS1/DZNINTEGER /AWS1/DZNINTEGER

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.

IV_NEXTTOKEN TYPE /AWS1/DZNPAGINATIONTOKEN /AWS1/DZNPAGINATIONTOKEN

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_DZNLISTRULESOUTPUT /AWS1/CL_DZNLISTRULESOUTPUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC