Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListRuleTypes

Lists the rules for the condition. For more information about conditions, see Stage conditions. For more information about rules, see the AWS CodePipeline rule reference.

Request Syntax


{
   "regionFilter": "string",
   "ruleOwnerFilter": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

regionFilter

The rule Region to filter on.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 30.

Required: No

ruleOwnerFilter

The rule owner to filter on.

Type: String

Valid Values: AWS

Required: No

Response Syntax


{
   "ruleTypes": [ 
      { 
         "id": { 
            "category": "string",
            "owner": "string",
            "provider": "string",
            "version": "string"
         },
         "inputArtifactDetails": { 
            "maximumCount": number,
            "minimumCount": number
         },
         "ruleConfigurationProperties": [ 
            { 
               "description": "string",
               "key": boolean,
               "name": "string",
               "queryable": boolean,
               "required": boolean,
               "secret": boolean,
               "type": "string"
            }
         ],
         "settings": { 
            "entityUrlTemplate": "string",
            "executionUrlTemplate": "string",
            "revisionUrlTemplate": "string",
            "thirdPartyConfigurationUrl": "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.

ruleTypes

Lists the rules that are configured for the condition.

Type: Array of RuleType objects

Errors

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

InvalidNextTokenException

The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.

HTTP Status Code: 400

ValidationException

The validation was specified in an invalid format.

HTTP Status Code: 400