Skip to content

Get Rule

datazone_get_rule R Documentation

Gets the details of a rule in Amazon DataZone

Description

Gets the details of a rule 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_get_rule(domainIdentifier, identifier, revision)

Arguments

domainIdentifier

[required] The ID of the domain where the get_rule action is to be invoked.

identifier

[required] The ID of the rule.

revision

The revision of the rule.

Value

A list with the following syntax: 

list(
  action = "CREATE_SUBSCRIPTION_REQUEST",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  createdBy = "string",
  description = "string",
  detail = list(
    metadataFormEnforcementDetail = list(
      requiredMetadataForms = list(
        list(
          typeIdentifier = "string",
          typeRevision = "string"
        )
      )
    )
  ),
  identifier = "string",
  lastUpdatedBy = "string",
  name = "string",
  revision = "string",
  ruleType = "METADATA_FORM_ENFORCEMENT",
  scope = list(
    assetType = list(
      selectionMode = "ALL"|"SPECIFIC",
      specificAssetTypes = list(
        "string"
      )
    ),
    dataProduct = TRUE|FALSE,
    project = list(
      selectionMode = "ALL"|"SPECIFIC",
      specificProjects = list(
        "string"
      )
    )
  ),
  target = list(
    domainUnitTarget = list(
      domainUnitId = "string",
      includeChildDomainUnits = TRUE|FALSE
    )
  ),
  targetType = "DOMAIN_UNIT",
  updatedAt = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$get_rule(
  domainIdentifier = "string",
  identifier = "string",
  revision = "string"
)