ListRepositoriesForApprovalRuleTemplate
Lists all repositories associated with the specified approval rule template.
Request Syntax
{
"approvalRuleTemplateName": "string
",
"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.
- approvalRuleTemplateName
-
The name of the approval rule template for which you want to list repositories that are associated with that template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- 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
{
"nextToken": "string",
"repositoryNames": [ "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.
- nextToken
-
An enumeration token that allows the operation to batch the next results of the operation.
Type: String
- repositoryNames
-
A list of repository names that are associated with the specified approval rule template.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[\w\.-]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- ApprovalRuleTemplateDoesNotExistException
-
The specified approval rule template does not exist. Verify that the name is correct and that you are signed in to the Amazon Web Services Region where the template was created, and then try again.
HTTP Status Code: 400
- ApprovalRuleTemplateNameRequiredException
-
An approval rule template name is required, but was not specified.
HTTP Status Code: 400
- EncryptionIntegrityChecksFailedException
-
An encryption integrity check failed.
HTTP Status Code: 500
- EncryptionKeyAccessDeniedException
-
An encryption key could not be accessed.
HTTP Status Code: 400
- EncryptionKeyDisabledException
-
The encryption key is disabled.
HTTP Status Code: 400
- EncryptionKeyNotFoundException
-
No encryption key was found.
HTTP Status Code: 400
- EncryptionKeyUnavailableException
-
The encryption key is not available.
HTTP Status Code: 400
- InvalidApprovalRuleTemplateNameException
-
The name of the approval rule template is not valid. Template names must be between 1 and 100 valid characters in length. For more information about limits in Amazon CodeCommit, see Quotas in the Amazon CodeCommit User Guide.
HTTP Status Code: 400
- 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 ListRepositoriesForApprovalRuleTemplate.
Sample Request
POST / HTTP/1.1
Host: codecommit.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 2
X-Amz-Target: CodeCommit_20150413.ListRepositoriesForApprovalRuleTemplate
X-Amz-Date: 20191021T212036Z
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
{
"approvalRuleTemplateName": "2-approver-rule-for-main"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 0728aaa8-EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 721
Date: Mon, 21 Oct 2019 21:20:37 GMT
{
"repositoryNames": [
"MyDemoRepo",
"MyClonedRepo"
]
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: