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

ListRules

Lists existing rules. 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/list-rules/targetType/targetIdentifier?assetTypes=assetTypes&dataProduct=dataProduct&includeCascaded=includeCascaded&maxResults=maxResults&nextToken=nextToken&projectIds=projectIds&ruleAction=action&ruleType=ruleType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

action

The action of the rule.

Valid Values: CREATE_SUBSCRIPTION_REQUEST

assetTypes

The asset types of the rule.

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

Pattern: ^(?!\.)[\w\.]*\w$

dataProduct

The data product of the rule.

domainIdentifier

The ID of the domain in which the rules are to be listed.

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

Required: Yes

includeCascaded

Specifies whether to include cascading rules in the results.

maxResults

The maximum number of rules to return in a single call to ListRules. When the number of rules to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListRules to list the next set of rules.

Valid Range: Minimum value of 25. Maximum value of 50.

nextToken

When the number of rules is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of rules, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListRules to list the next set of rules.

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

projectIds

The IDs of projects in which rules are to be listed.

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

ruleType

The type of the rule.

Valid Values: METADATA_FORM_ENFORCEMENT

targetIdentifier

The target ID of the rule.

Required: Yes

targetType

The target type of the rule.

Valid Values: DOMAIN_UNIT

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "action": "string",
         "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
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items

The results of the ListRules action.

Type: Array of RuleSummary objects

nextToken

Type: String

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

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400