Lists existing rules¶

Description¶

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.

Usage¶

datazone_list_rules(domainIdentifier, targetType, targetIdentifier,
  ruleType, action, projectIds, assetTypes, dataProduct, includeCascaded,
  maxResults, nextToken)

Arguments¶

• domainIdentifier

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

• targetType

  [required] The target type of the rule.

• targetIdentifier

  [required] The target ID of the rule.

• ruleType

  The type of the rule.

• action

  The action of the rule.

• projectIds

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

• assetTypes

  The asset types of the rule.

• dataProduct

  The data product of the rule.

• includeCascaded

  Specifies whether to include cascading rules in the results.

• maxResults

  The maximum number of rules to return in a single call to list_rules. 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 list_rules to list the next set of rules.

• nextToken

  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 list_rules to list the next set of rules.

Value¶

A list with the following syntax:

list(
  items = list(
    list(
      identifier = "string",
      revision = "string",
      ruleType = "METADATA_FORM_ENFORCEMENT"|"GLOSSARY_TERM_ENFORCEMENT",
      name = "string",
      targetType = "DOMAIN_UNIT",
      target = list(
        domainUnitTarget = list(
          domainUnitId = "string",
          includeChildDomainUnits = TRUE|FALSE
        )
      ),
      action = "CREATE_LISTING_CHANGE_SET"|"CREATE_SUBSCRIPTION_REQUEST",
      scope = list(
        assetType = list(
          selectionMode = "ALL"|"SPECIFIC",
          specificAssetTypes = list(
            "string"
          )
        ),
        dataProduct = TRUE|FALSE,
        project = list(
          selectionMode = "ALL"|"SPECIFIC",
          specificProjects = list(
            "string"
          )
        )
      ),
      updatedAt = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedBy = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_rules(
  domainIdentifier = "string",
  targetType = "DOMAIN_UNIT",
  targetIdentifier = "string",
  ruleType = "METADATA_FORM_ENFORCEMENT"|"GLOSSARY_TERM_ENFORCEMENT",
  action = "CREATE_LISTING_CHANGE_SET"|"CREATE_SUBSCRIPTION_REQUEST",
  projectIds = list(
    "string"
  ),
  assetTypes = list(
    "string"
  ),
  dataProduct = TRUE|FALSE,
  includeCascaded = TRUE|FALSE,
  maxResults = 123,
  nextToken = "string"
)