ListApprovalRuleTemplates
Lists all approval rule templates in the specified AWS Region in your AWS account. If an AWS Region is not specified, the AWS Region where you are signed in is used.
Request Syntax
{
"maxResults": number
,
"nextToken": "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.
- maxResults
-
A non-zero, non-negative integer used to limit the number of returned results.
Type: Integer
Required: No
- nextToken
-
An enumeration token that, when provided in a request, returns the next batch of the results.
Type: String
Required: No
Response Syntax
{
"approvalRuleTemplateNames": [ "string" ],
"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.
- approvalRuleTemplateNames
-
The names of all the approval rule templates found in the AWS Region for your AWS account.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 100.
- nextToken
-
An enumeration token that allows the operation to batch the next results of the operation.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidContinuationTokenException
-
The specified continuation token is not valid.
HTTP Status Code: 400
- InvalidMaxResultsException
-
The specified number of maximum results is not valid.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of ListApprovalRuleTemplates.
Sample Request
POST / HTTP/1.1
Host: codecommit.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 33
X-Amz-Target: CodeCommit_20150413.ListApprovalRuleTemplates
X-Amz-Date: 20191021T230050Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/10
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151028/us-east-1/codecommit/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE
{}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 0728aaa8-EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 248
Date: Mon, 21 Oct 2019 23:00:52 GMT
{
"approvalRuleTemplateNames": [
"2-approver-rule-for-main",
"1-approver-rule-for-all-pull-requests"
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: