Updates a rule¶

Description¶

Updates 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_update_rule(domainIdentifier, identifier, name, description,
  scope, detail, includeChildDomainUnits)

Arguments¶

domainIdentifier

[required] The ID of the domain in which a rule is to be updated.
identifier

[required] The ID of the rule that is to be updated
name

The name of the rule.
description

The description of the rule.
scope

The scrope of the rule.
detail

The detail of the rule.
includeChildDomainUnits

Specifies whether to update this rule in the child domain units.

Value¶

A list with the following syntax:

list(
  identifier = "string",
  revision = "string",
  name = "string",
  ruleType = "METADATA_FORM_ENFORCEMENT"|"GLOSSARY_TERM_ENFORCEMENT",
  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"
      )
    )
  ),
  detail = list(
    metadataFormEnforcementDetail = list(
      requiredMetadataForms = list(
        list(
          typeIdentifier = "string",
          typeRevision = "string"
        )
      )
    ),
    glossaryTermEnforcementDetail = list(
      requiredGlossaryTermIds = list(
        "string"
      )
    )
  ),
  description = "string",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  updatedAt = as.POSIXct(
    "2015-01-01"
  ),
  createdBy = "string",
  lastUpdatedBy = "string"
)

Request syntax¶

svc$update_rule(
  domainIdentifier = "string",
  identifier = "string",
  name = "string",
  description = "string",
  scope = list(
    assetType = list(
      selectionMode = "ALL"|"SPECIFIC",
      specificAssetTypes = list(
        "string"
      )
    ),
    dataProduct = TRUE|FALSE,
    project = list(
      selectionMode = "ALL"|"SPECIFIC",
      specificProjects = list(
        "string"
      )
    )
  ),
  detail = list(
    metadataFormEnforcementDetail = list(
      requiredMetadataForms = list(
        list(
          typeIdentifier = "string",
          typeRevision = "string"
        )
      )
    ),
    glossaryTermEnforcementDetail = list(
      requiredGlossaryTermIds = list(
        "string"
      )
    )
  ),
  includeChildDomainUnits = TRUE|FALSE
)