BatchAssociateApprovalRuleTemplateWithRepositories
Creates an association between an approval rule template and one or more specified repositories.
Request Syntax
{
"approvalRuleTemplateName": "string
",
"repositoryNames": [ "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 template you want to associate with one or more repositories.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- repositoryNames
-
The names of the repositories you want to associate with the template.
Note
The length constraint limit is for each string in the array. The array itself can be empty.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[\w\.-]+
Required: Yes
Response Syntax
{
"associatedRepositoryNames": [ "string" ],
"errors": [
{
"errorCode": "string",
"errorMessage": "string",
"repositoryName": "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.
- associatedRepositoryNames
-
A list of names of the repositories that have been associated with the template.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[\w\.-]+
- errors
-
A list of any errors that might have occurred while attempting to create the association between the template and the repositories.
Type: Array of BatchAssociateApprovalRuleTemplateWithRepositoriesError objects
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
- MaximumRepositoryNamesExceededException
-
The maximum number of allowed repository names was exceeded. Currently, this number is 100.
HTTP Status Code: 400
- RepositoryNamesRequiredException
-
At least one repository name object is required, but was not specified.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of BatchAssociateApprovalRuleTemplateWithRepositories.
Sample Request
>POST / HTTP/1.1
Host: codecommit.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 226
X-Amz-Target: CodeCommit_20150413.BatchAssociateApprovalRuleTemplateWithRepositories
X-Amz-Date: 20191021T213222Z
User-Agent: aws-cli/1.16.137 Python/3.6.0 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",
"repositoryNames": [
"MyDemoRepo",
"MyOtherDemoRepo"
]
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 0728aaa8-EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 1681
Date: Mon, 21 Oct 2019 22:43:13 GMT
{
"associatedRepositoryNames": [
"MyDemoRepo",
"MyOtherDemoRepo"
],
"errors": []
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: