Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141891,2951.1 MB

Creates 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.

post/v2/domains/{domainIdentifier}/rules

Path parameters

domainIdentifierstring required

The ID of the domain where the rule is created.

Request body

namestring password required

The name of the rule.

action'CREATE_LISTING_CHANGE_SET' | 'CREATE_SUBSCRIPTION_REQUEST' required

The action of the rule.

descriptionstring password

The description of the rule.

clientTokenstring

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

Response

Success

identifierstring required

The ID of the rule.

namestring password required

The name of the rule.

ruleType'METADATA_FORM_ENFORCEMENT' | 'GLOSSARY_TERM_ENFORCEMENT' required

The type of the rule.

action'CREATE_LISTING_CHANGE_SET' | 'CREATE_SUBSCRIPTION_REQUEST' required

The action of the rule.

targetType'DOMAIN_UNIT'

The target type of the rule.

descriptionstring password

The description of the rule.

createdAtstring date-time required

The timestamp at which the rule is created.

createdBystring required

The user who creates the rule.