Skip to content

Update Rule

datazone_update_rule R Documentation

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

Arguments

description

The description of the rule.

detail

The detail of the rule.

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

includeChildDomainUnits

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

name

The name of the rule.

scope

The scrope 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
    )
  ),
  updatedAt = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

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