URI HTTP methods Schemas Properties See also

ListRules

URI

/rules

HTTP methods

GET

Operation ID: ListRules

Lists all readiness rules, or lists the readiness rules for a specific resource type.

Query parameters
Name	Type	Required	Description
`resourceType`	String	False	The resource type that a readiness rule applies to.
`nextToken`	String	False	The token that identifies which batch of results you want to see.
`maxResults`	String	False	The number of objects that you want to return with this call.

Responses
Status code	Response model	Description
`200`	`ListRulesResult`	200 response - Success.
`400`	None	400 response - Multiple causes. For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly.
`403`	None	403 response - Access denied exception. You do not have sufficient access to perform this action.
`429`	None	429 response - Limit exceeded exception or too many requests exception.
`500`	None	500 response - Internal service error or temporary service error. Retry the request.

OPTIONS

Enable CORS by returning correct headers

Responses
Status code	Response model	Description
`200`	None	200 response - Success.

Schemas

Response bodies


{
  "nextToken": "string",
  "rules": [
    {
      "ruleId": "string",
      "ruleDescription": "string",
      "resourceType": "string"
    }
  ]
}

Properties

ListRulesOutput

Readiness rule information, including the resource type, rule ID, and rule description.

Property Type Required Description

Property	Type	Required	Description
`resourceType`	string MaxLength: 64	True	The resource type that the readiness rule applies to.
`ruleDescription`	string MaxLength: 256	True	The description of a readiness rule.
`ruleId`	string MaxLength: 64	True	The ID for the readiness rule.

resourceType

string

MaxLength: 64

True

The resource type that the readiness rule applies to.

ruleDescription

string

MaxLength: 256

True

The description of a readiness rule.

ruleId

string

MaxLength: 64

True

The ID for the readiness rule.

ListRulesResult

The result of a successful ListRules request.

Property	Type	Required	Description
`nextToken`	string	False	The token that identifies which batch of results you want to see.
`rules`	Array of type ListRulesOutput	False	A list of readiness rules for a specific resource type.