Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetRule

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.

Request Syntax


GET /v2/domains/domainIdentifier/rules/identifier?revision=revision HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the domain where the GetRule action is to be invoked.

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

identifier

The ID of the rule.

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Required: Yes

revision

The revision of the rule.

Length Constraints: Minimum length of 1. Maximum length of 64.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "action": "string",
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "detail": { ... },
   "identifier": "string",
   "lastUpdatedBy": "string",
   "name": "string",
   "revision": "string",
   "ruleType": "string",
   "scope": { 
      "assetType": { 
         "selectionMode": "string",
         "specificAssetTypes": [ "string" ]
      },
      "dataProduct": boolean,
      "project": { 
         "selectionMode": "string",
         "specificProjects": [ "string" ]
      }
   },
   "target": { ... },
   "targetType": "string",
   "updatedAt": number
}