AWS CodeCommit

(1)

AWS CodeCommit

API Reference

API Version 2015-04-13

(2)

AWS CodeCommit: API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

This is the AWS CodeCommit API Reference. This reference provides descriptions of the operations and data types for AWS CodeCommit API along with usage examples.

You can use the AWS CodeCommit API to work with the following objects:

Repositories, by calling the following:

• BatchGetRepositories (p. 31), which returns information about one or more repositories associated with your AWS account.

• CreateRepository (p. 64), which creates an AWS CodeCommit repository.

• DeleteRepository (p. 97), which deletes an AWS CodeCommit repository.

• GetRepository (p. 199), which returns information about a speciﬁed repository.

• ListRepositories (p. 222), which lists all AWS CodeCommit repositories associated with your AWS account.

• UpdateRepositoryDescription (p. 365), which sets or updates the description of the repository.

• UpdateRepositoryName (p. 368), which changes the name of the repository. If you change the name of a repository, no other users of that repository can access it until you send them the new HTTPS or SSH URL to use.

Branches, by calling the following:

• CreateBranch (p. 39), which creates a branch in a speciﬁed repository.

• DeleteBranch (p. 80), which deletes the speciﬁed branch in a repository unless it is the default branch.

• GetBranch (p. 126), which returns information about a speciﬁed branch.

• ListBranches (p. 214), which lists all branches for a speciﬁed repository.

• UpdateDefaultBranch (p. 340), which changes the default branch for a repository.

Files, by calling the following:

• DeleteFile (p. 87), which deletes the content of a specified file from a specified branch.

• GetBlob (p. 123), which returns the base-64 encoded content of an individual Git blob object in a repository.

• GetFile (p. 159), which returns the base-64 encoded content of a speciﬁed ﬁle.

• GetFolder (p. 164), which returns the contents of a speciﬁed folder or directory.

• PutFile (p. 303), which adds or modifies a single file in a specified repository and branch.

Commits, by calling the following:

• BatchGetCommits (p. 26), which returns information about one or more commits in a repository.

• CreateCommit (p. 43), which creates a commit for changes to a repository.

• GetCommit (p. 150), which returns information about a commit, including commit messages and author and committer information.

• GetDifferences (p. 154), which returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID, or other fully qualified reference).

(18)

Merges, by calling the following:

• BatchDescribeMergeConﬂicts (p. 14), which returns information about conﬂicts in a merge between commits in a repository.

• CreateUnreferencedMergeCommit (p. 69), which creates an unreferenced commit between two branches or commits for the purpose of comparing them and identifying any potential conﬂicts.

• DescribeMergeConflicts (p. 100), which returns information about merge conflicts between the base, source, and destination versions of a file in a potential merge.

• GetMergeCommit (p. 170), which returns information about the merge between a source and destination commit.

• GetMergeConﬂicts (p. 175), which returns information about merge conﬂicts between the source and destination branch in a pull request.

• GetMergeOptions (p. 182), which returns information about the available merge options between two branches or commit speciﬁers.

• MergeBranchesByFastForward (p. 232), which merges two branches using the fast-forward merge option.

• MergeBranchesBySquash (p. 237), which merges two branches using the squash merge option.

• MergeBranchesByThreeWay (p. 245), which merges two branches using the three-way merge option.

Pull requests, by calling the following:

• CreatePullRequest (p. 52), which creates a pull request in a speciﬁed repository.

• CreatePullRequestApprovalRule (p. 59), which creates an approval rule for a speciﬁed pull request.

• DeletePullRequestApprovalRule (p. 93), which deletes an approval rule for a speciﬁed pull request.

• DescribePullRequestEvents (p. 108), which returns information about one or more pull request events.

• EvaluatePullRequestApprovalRules (p. 116), which evaluates whether a pull request has met all the conditions speciﬁed in its associated approval rules.

• GetCommentsForPullRequest (p. 144), which returns information about comments on a speciﬁed pull request.

• GetPullRequest (p. 187), which returns information about a speciﬁed pull request.

• GetPullRequestApprovalStates (p. 191), which returns information about the approval states for a speciﬁed pull request.

• GetPullRequestOverrideState (p. 195), which returns information about whether approval rules have been set aside (overriden) for a pull request, and if so, the Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the pull request.

• ListPullRequests (p. 218), which lists all pull requests for a repository.

• MergePullRequestByFastForward (p. 253), which merges the source destination branch of a pull request into the speciﬁed destination branch for that pull request using the fast-forward merge option.

• MergePullRequestBySquash (p. 259), which merges the source destination branch of a pull request into the speciﬁed destination branch for that pull request using the squash merge option.

• MergePullRequestByThreeWay (p. 268), which merges the source destination branch of a pull request into the speciﬁed destination branch for that pull request using the three-way merge option.

• OverridePullRequestApprovalRules (p. 277), which sets aside all approval rule requirements for a pull request.

• PostCommentForPullRequest (p. 288), which posts a comment to a pull request at the speciﬁed line, ﬁle, or request.

• UpdatePullRequestApprovalRuleContent (p. 343), which updates the structure of an approval rule for a pull request.

(19)

• UpdatePullRequestApprovalState (p. 348), which updates the state of an approval on a pull request.

• UpdatePullRequestDescription (p. 352), which updates the description of a pull request.

• UpdatePullRequestStatus (p. 356), which updates the status of a pull request.

• UpdatePullRequestTitle (p. 361), which updates the title of a pull request.

Approval rule templates, by calling the following:

• AssociateApprovalRuleTemplateWithRepository (p. 7), which associates a template with a speciﬁed repository. After the template is associated with a repository, AWS CodeCommit creates approval rules that match the template conditions on every pull request created in the speciﬁed repository.

• BatchAssociateApprovalRuleTemplateWithRepositories (p. 10), which associates a template with one or more speciﬁed repositories. After the template is associated with a repository, AWS CodeCommit creates approval rules that match the template conditions on every pull request created in the speciﬁed repositories.

• BatchDisassociateApprovalRuleTemplateFromRepositories (p. 22), which removes the association between a template and speciﬁed repositories so that approval rules based on the template are not automatically created when pull requests are created in those repositories.

• CreateApprovalRuleTemplate (p. 35), which creates a template for approval rules that can then be associated with one or more repositories in your AWS account.

• DeleteApprovalRuleTemplate (p. 77), which deletes the speciﬁed template. It does not remove approval rules on pull requests already created with the template.

• DisassociateApprovalRuleTemplateFromRepository (p. 113), which removes the association between a template and a repository so that approval rules based on the template are not automatically created when pull requests are created in the speciﬁed repository.

• GetApprovalRuleTemplate (p. 120), which returns information about an approval rule template.

• ListApprovalRuleTemplates (p. 207), which lists all approval rule templates in the AWS Region in your AWS account.

• ListAssociatedApprovalRuleTemplatesForRepository (p. 210), which lists all approval rule templates that are associated with a speciﬁed repository.

• ListRepositoriesForApprovalRuleTemplate (p. 225), which lists all repositories associated with the speciﬁed approval rule template.

• UpdateApprovalRuleTemplateDescription (p. 330), which updates the description of an approval rule template.

• UpdateApprovalRuleTemplateName (p. 333), which updates the name of an approval rule template.

• UpdateApprovalRuleTemplateContent (p. 326), which updates the content of an approval rule template.

Comments in a repository, by calling the following:

• DeleteCommentContent (p. 84), which deletes the content of a comment on a commit in a repository.

• GetComment (p. 130), which returns information about a comment on a commit.

• GetCommentReactions (p. 134), which returns information about emoji reactions to comments.

• GetCommentsForComparedCommit (p. 138), which returns information about comments on the comparison between two commit speciﬁers in a repository.

• PostCommentForComparedCommit (p. 281), which creates a comment on the comparison between two commit speciﬁers in a repository.

• PostCommentReply (p. 296), which creates a reply to a comment.

• PutCommentReaction (p. 300), which creates or updates an emoji reaction to a comment.

• UpdateComment (p. 336), which updates the content of a comment on a commit in a repository.

(20)

Tags used to tag resources in AWS CodeCommit (not Git tags), by calling the following:

• ListTagsForResource (p. 229), which gets information about AWStags for a speciﬁed Amazon Resource Name (ARN) in AWS CodeCommit.

• TagResource (p. 315), which adds or updates tags for a resource in AWS CodeCommit.

• UntagResource (p. 323), which removes tags for a resource in AWS CodeCommit.

Triggers, by calling the following:

• GetRepositoryTriggers (p. 203), which returns information about triggers conﬁgured for a repository.

• PutRepositoryTriggers (p. 310), which replaces all triggers for a repository and can be used to create or delete triggers.

• TestRepositoryTriggers (p. 318), which tests the functionality of a repository trigger by sending data to the trigger target.

For information about how to use AWS CodeCommit, see the AWS CodeCommit User Guide.

This document was last published on March 6, 2022.

(21)

Actions

The following actions are supported:

• AssociateApprovalRuleTemplateWithRepository (p. 7)

• BatchAssociateApprovalRuleTemplateWithRepositories (p. 10)

• BatchDescribeMergeConﬂicts (p. 14)

• BatchDisassociateApprovalRuleTemplateFromRepositories (p. 22)

• BatchGetCommits (p. 26)

• BatchGetRepositories (p. 31)

• CreateApprovalRuleTemplate (p. 35)

• CreateBranch (p. 39)

• CreateCommit (p. 43)

• CreatePullRequest (p. 52)

• CreatePullRequestApprovalRule (p. 59)

• CreateRepository (p. 64)

• CreateUnreferencedMergeCommit (p. 69)

• DeleteApprovalRuleTemplate (p. 77)

• DeleteBranch (p. 80)

• DeleteCommentContent (p. 84)

• DeleteFile (p. 87)

• DeletePullRequestApprovalRule (p. 93)

• DeleteRepository (p. 97)

• DescribeMergeConﬂicts (p. 100)

• DescribePullRequestEvents (p. 108)

• DisassociateApprovalRuleTemplateFromRepository (p. 113)

• EvaluatePullRequestApprovalRules (p. 116)

• GetApprovalRuleTemplate (p. 120)

• GetBlob (p. 123)

• GetBranch (p. 126)

• GetComment (p. 130)

• GetCommentReactions (p. 134)

• GetCommentsForComparedCommit (p. 138)

• GetCommentsForPullRequest (p. 144)

• GetCommit (p. 150)

• GetDiﬀerences (p. 154)

• GetFile (p. 159)

• GetFolder (p. 164)

• GetMergeCommit (p. 170)

• GetMergeConﬂicts (p. 175)

• GetMergeOptions (p. 182)

• GetPullRequest (p. 187)

• GetPullRequestApprovalStates (p. 191)

• GetPullRequestOverrideState (p. 195)

(22)

• GetRepository (p. 199)

• GetRepositoryTriggers (p. 203)

• ListApprovalRuleTemplates (p. 207)

• ListAssociatedApprovalRuleTemplatesForRepository (p. 210)

• ListBranches (p. 214)

• ListPullRequests (p. 218)

• ListRepositories (p. 222)

• ListRepositoriesForApprovalRuleTemplate (p. 225)

• ListTagsForResource (p. 229)

• MergeBranchesByFastForward (p. 232)

• MergeBranchesBySquash (p. 237)

• MergeBranchesByThreeWay (p. 245)

• MergePullRequestByFastForward (p. 253)

• MergePullRequestBySquash (p. 259)

• MergePullRequestByThreeWay (p. 268)

• OverridePullRequestApprovalRules (p. 277)

• PostCommentForComparedCommit (p. 281)

• PostCommentForPullRequest (p. 288)

• PostCommentReply (p. 296)

• PutCommentReaction (p. 300)

• PutFile (p. 303)

• PutRepositoryTriggers (p. 310)

• TagResource (p. 315)

• TestRepositoryTriggers (p. 318)

• UntagResource (p. 323)

• UpdateApprovalRuleTemplateContent (p. 326)

• UpdateApprovalRuleTemplateDescription (p. 330)

• UpdateApprovalRuleTemplateName (p. 333)

• UpdateComment (p. 336)

• UpdateDefaultBranch (p. 340)

• UpdatePullRequestApprovalRuleContent (p. 343)

• UpdatePullRequestApprovalState (p. 348)

• UpdatePullRequestDescription (p. 352)

• UpdatePullRequestStatus (p. 356)

• UpdatePullRequestTitle (p. 361)

• UpdateRepositoryDescription (p. 365)

• UpdateRepositoryName (p. 368)

(23)

AssociateApprovalRuleTemplateWithRepository

Creates an association between an approval rule template and a specified repository. Then, the next time a pull request is created in the repository where the destination reference (if specified) matches the destination reference (branch) for the pull request, an approval rule that matches the template conditions is automatically created for that pull request. If no destination references are specified in the template, an approval rule that matches the template contents is created for all pull requests in that repository.

Request Syntax

{ "approvalRuleTemplateName": "string", "repositoryName": "string"

}

Request Parameters

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

The request accepts the following data in JSON format.

approvalRuleTemplateName (p. 7)

The name for the approval rule template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes repositoryName (p. 7)

The name of the repository that you want to associate with the template.

Type: String

Pattern: [\w\.-]+

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

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

ApprovalRuleTemplateDoesNotExistException

The speciﬁed approval rule template does not exist. Verify that the name is correct and that you are signed in to the AWS Region where the template was created, and then try again.

(24)

Errors

HTTP Status Code: 400

ApprovalRuleTemplateNameRequiredException

An approval rule template name is required, but was not speciﬁed.

EncryptionIntegrityChecksFailedException An encryption integrity check failed.

EncryptionKeyAccessDeniedException An encryption key could not be accessed.

HTTP Status Code: 400 EncryptionKeyDisabledException

The encryption key is disabled.

EncryptionKeyNotFoundException No encryption key was found.

EncryptionKeyUnavailableException The encryption key is not available.

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 AWS CodeCommit, see Quotas in the AWS CodeCommit User Guide.

HTTP Status Code: 400 InvalidRepositoryNameException

A speciﬁed repository name is not valid.

NoteThis exception occurs only when a speciﬁed repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a speciﬁed repository does not exist.

MaximumRuleTemplatesAssociatedWithRepositoryException

The maximum number of approval rule templates for a repository has been exceeded. You cannot associate more than 25 approval rule templates with a repository.

HTTP Status Code: 400 RepositoryDoesNotExistException

The speciﬁed repository does not exist.

(25)

Examples

RepositoryNameRequiredException

A repository name is required, but was not speciﬁed.

Examples

Example

This example illustrates one usage of AssociateApprovalRuleTemplateWithRepository.

Sample Request

>POST / HTTP/1.1

Host: codecommit.us-east-1.amazonaws.com Accept-Encoding: identity

Content-Length: 226

X-Amz-Target: CodeCommit_20150413.AssociateApprovalRuleTemplateWithRepository 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

{ "repositoryName": "MyDemoRepo",

"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: 1681

Date: Mon, 21 Oxr 2019 22:43:13 GMT

BatchAssociateApprovalRuleTemplateWithRepositories

Creates an association between an approval rule template and one or more speciﬁed repositories.

Request Syntax

{ "approvalRuleTemplateName": "string", "repositoryNames": [ "string" ] }

Request Parameters

The name of the template you want to associate with one or more repositories.

Type: String

Required: Yes repositoryNames (p. 10)

The names of the repositories you want to associate with the template.

NoteThe length constraint limit is for each string in the array. The array itself can be empty.

Type: Array of strings

Pattern: [\w\.-]+

Required: Yes

Response Syntax

{ "associatedRepositoryNames": [ "string" ], "errors": [

{

"errorCode": "string", "errorMessage": "string", "repositoryName": "string"

} ]}

(27)

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 (p. 10)

A list of names of the repositories that have been associated with the template.

Pattern: [\w\.-]+

errors (p. 10)

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 (p. 381) objects

Errors

(28)

Examples

MaximumRepositoryNamesExceededException

The maximum number of allowed repository names was exceeded. Currently, this number is 100.

RepositoryNamesRequiredException

At least one repository name object is required, but was not speciﬁed.

Examples

Example

This example illustrates one usage of BatchAssociateApprovalRuleTemplateWithRepositories.

Sample Request

>POST / HTTP/1.1

Content-Length: 226

X-Amz-Target: CodeCommit_20150413.BatchAssociateApprovalRuleTemplateWithRepositories X-Amz-Date: 20191021T213222Z

{ "approvalRuleTemplateName": "2-approver-rule-for-main", "repositoryNames": [

"MyDemoRepo", "MyOtherDemoRepo"

] }

Sample Response

HTTP/1.1 200 OK

Date: Mon, 21 Oct 2019 22:43:13 GMT

(29)

BatchDescribeMergeConﬂicts

Returns information about one or more merge conﬂicts in the attempted merge of two commit speciﬁers using the squash or three-way merge strategy.

Request Syntax

{ "conflictDetailLevel": "string",

"conflictResolutionStrategy": "string", "destinationCommitSpecifier": "string", "filePaths": [ "string" ],

"maxConflictFiles": number, "maxMergeHunks": number, "mergeOption": "string", "nextToken": "string", "repositoryName": "string", "sourceCommitSpecifier": "string"

}

Request Parameters

conﬂictDetailLevel (p. 14)

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in both branches has differences on the same line.

Type: String

Valid Values: FILE_LEVEL | LINE_LEVEL Required: No

conﬂictResolutionStrategy (p. 14)

Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation is successful.

Type: String

Valid Values: NONE | ACCEPT_SOURCE | ACCEPT_DESTINATION | AUTOMERGE Required: No

destinationCommitSpeciﬁer (p. 14)

The branch, tag, HEAD, or other fully qualiﬁed reference used to identify a commit (for example, a branch name or a full commit ID).

Type: String Required: Yes

(31)

Response Syntax

ﬁlePaths (p. 14)

The path of the target files used to describe the conflicts. If not specified, the default is all conflict files.

Type: Array of strings Required: No

maxConﬂictFiles (p. 14)

The maximum number of ﬁles to include in the output.

Type: Integer Required: No maxMergeHunks (p. 14)

The maximum number of merge hunks to include in the output.

Type: Integer Required: No mergeOption (p. 14)

The merge option or strategy you want to use to merge the code.

Type: String

Valid Values: FAST_FORWARD_MERGE | SQUASH_MERGE | THREE_WAY_MERGE Required: Yes

nextToken (p. 14)

An enumeration token that, when provided in a request, returns the next batch of the results.

Type: String Required: No repositoryName (p. 14)

The name of the repository that contains the merge conﬂicts you want to review.

Type: String

Pattern: [\w\.-]+

Required: Yes

sourceCommitSpeciﬁer (p. 14)

The branch, tag, HEAD, or other fully qualiﬁed reference used to identify a commit (for example, a branch name or a full commit ID).

Type: String Required: Yes

Response Syntax

{

(32)

Response Syntax

"baseCommitId": "string", "conflicts": [

{

"conflictMetadata": {

"contentConflict": boolean, "fileModeConflict": boolean, "fileModes": {

"base": "string", "destination": "string", "source": "string"

},

"filePath": "string", "fileSizes": { "base": number, "destination": number, "source": number },

"isBinaryFile": { "base": boolean, "destination": boolean, "source": boolean },

"mergeOperations": { "destination": "string", "source": "string"

},

"numberOfConflicts": number, "objectTypeConflict": boolean, "objectTypes": {

"base": "string", "destination": "string", "source": "string"

} },

"mergeHunks": [ {

"base": {

"endLine": number, "hunkContent": "string", "startLine": number },

"destination": { "endLine": number, "hunkContent": "string", "startLine": number },

"isConflict": boolean, "source": {

"endLine": number, "hunkContent": "string", "startLine": number }

} ] } ],

"destinationCommitId": "string", "errors": [

{

"exceptionName": "string", "filePath": "string", "message": "string"

} ],

"nextToken": "string", "sourceCommitId": "string"

(33)

Response Elements

}

Response Elements

baseCommitId (p. 15)

The commit ID of the merge base.

Type: String conﬂicts (p. 15)

A list of conflicts for each file, including the conflict metadata and the hunks of the differences between the files.

Type: Array of Conﬂict (p. 395) objects destinationCommitId (p. 15)

The commit ID of the destination commit speciﬁer that was used in the merge evaluation.

Type: String errors (p. 15)

A list of any errors returned while describing the merge conﬂicts for each ﬁle.

Type: Array of BatchDescribeMergeConﬂictsError (p. 382) objects nextToken (p. 15)

An enumeration token that can be used in a request to return the next batch of the results.

Type: String sourceCommitId (p. 15)

The commit ID of the source commit speciﬁer that was used in the merge evaluation.

Type: String

Errors

CommitDoesNotExistException

The specified commit does not exist or no commit was specified, and the specified repository has no default branch.

HTTP Status Code: 400 CommitRequiredException

A commit was not speciﬁed.

(34)

Errors

EncryptionKeyNotFoundException

No encryption key was found.

EncryptionKeyUnavailableException

The encryption key is not available.

HTTP Status Code: 400 InvalidCommitException

The speciﬁed commit is not valid.

InvalidConﬂictDetailLevelException

The speciﬁed conﬂict detail level is not valid.

InvalidConﬂictResolutionStrategyException

The speciﬁed conﬂict resolution strategy is not valid.

InvalidContinuationTokenException

The speciﬁed continuation token is not valid.

HTTP Status Code: 400 InvalidMaxConﬂictFilesException

The specified value for the number of conflict files to return is not valid.

HTTP Status Code: 400 InvalidMaxMergeHunksException

The speciﬁed value for the number of merge hunks to return is not valid.

(35)

Examples

InvalidMergeOptionException

The speciﬁed merge option is not valid for this operation. Not all merge strategies are supported for all operations.

MaximumFileContentToLoadExceededException

The number of ﬁles to load exceeds the allowed limit.

MaximumItemsToCompareExceededException

The number of items to compare between the source or destination branches and the merge base has exceeded the maximum allowed.

HTTP Status Code: 400 MergeOptionRequiredException

A merge option or stategy is required, and none was provided.

TipsDivergenceExceededException

The divergence between the tips of the provided commit speciﬁers is too great to determine

whether there might be any merge conflicts. Locally compare the specifiers using git diff or a diff tool.

Examples

Example

This example illustrates one usage of BatchDescribeMergeConﬂicts.

(36)

Examples

Sample Request

>POST / HTTP/1.1

Content-Length: 226

X-Amz-Target: CodeCommit_20150413.BatchDescribeMergeConflicts X-Amz-Date: 20190428T213222Z

"destinationCommitSpecifier": "bugfix-bug1234", "sourceCommitSpecifier": "main",

"mergeOption": "THREE_WAY_MERGE", "conflictDetailLevel" "LINE_LEVEL", "conflictResolutionStrategy": "NONE", "nextToken": "exampleToken",

}

Sample Response

HTTP/1.1 200 OK

Date: Sun, 28 Apr 2019 22:43:13 GMT {

"conflicts":[

{

"conflictMetadata": { "filePath": "file1.py", "fileSizes": {

"source": 123, "destination": 125, "base": 124

},

"fileModes": {

"source": "EXECUTABLE", "destination": "EXECUTABLE", "base": "EXECUTABLE"

},

"numberOfConflicts", 4, "isBinaryFile": {

"source": false, "destination": false, "base": false

},

"contentConflict": true, "fileModeConflict": false, "mergeOperations": { "source": "M", "destination": "M"

} }

"mergeHunks":[

{

"mergeHunk": {

(37)

BatchDisassociateApprovalRuleTemplateFromRepositories

Removes the association between an approval rule template and one or more speciﬁed repositories.

Request Syntax

{ "approvalRuleTemplateName": "string", "repositoryNames": [ "string" ] }

Request Parameters

The name of the template that you want to disassociate from one or more repositories.

Type: String

Required: Yes repositoryNames (p. 22)

The repository names that you want to disassociate from the approval rule template.

NoteThe length constraint limit is for each string in the array. The array itself can be empty.

Pattern: [\w\.-]+

Required: Yes

Response Syntax

{ "disassociatedRepositoryNames": [ "string" ], "errors": [

{

"errorCode": "string", "errorMessage": "string", "repositoryName": "string"

} ]}

(39)

Response Elements

disassociatedRepositoryNames (p. 22)

A list of repository names that have had their association with the template removed.

Pattern: [\w\.-]+

errors (p. 22)

A list of any errors that might have occurred while attempting to remove the association between the template and the repositories.

Type: Array of BatchDisassociateApprovalRuleTemplateFromRepositoriesError (p. 383) objects

Errors

(40)

Examples

MaximumRepositoryNamesExceededException

The maximum number of allowed repository names was exceeded. Currently, this number is 100.

RepositoryNamesRequiredException

At least one repository name object is required, but was not speciﬁed.

Examples

Example

This example illustrates one usage of BatchDisassociateApprovalRuleTemplateFromRepositories.

Sample Request

>POST / HTTP/1.1

Content-Length: 226

X-Amz-Target: CodeCommit_20150413.BatchDisassociateApprovalRuleTemplateFromRepositories X-Amz-Date: 20191021T213222Z

{ "approvalRuleTemplateName": "2-approver-rule-for-main", "repositoryNames": [

"MyDemoRepo", "MyOtherDemoRepo"

] }

Sample Response

HTTP/1.1 200 OK

Date: Mon, 21 Oxr 2019 22:43:13 GMT

(41)

BatchGetCommits

Returns information about the contents of one or more commits in a repository.

Request Syntax

{ "commitIds": [ "string" ], "repositoryName": "string"

}

Request Parameters

commitIds (p. 26)

The full commit IDs of the commits to get information about.

NoteYou must supply the full SHA IDs of each commit. You cannot use shortened SHA IDs.

Type: Array of strings Required: Yes repositoryName (p. 26)

The name of the repository that contains the commits.

Type: String

Pattern: [\w\.-]+

Required: Yes

Response Syntax

{ "commits": [ {

"additionalData": "string", "author": {

"date": "string", "email": "string", "name": "string"

},

"commitId": "string", "committer": { "date": "string", "email": "string", "name": "string"

},

(43)

Response Elements

"message": "string", "parents": [ "string" ], "treeId": "string"

} ],

"errors": [ {

"commitId": "string", "errorCode": "string", "errorMessage": "string"

} ]}

Response Elements

commits (p. 26)

An array of commit data type objects, each of which contains information about a speciﬁed commit.

Type: Array of Commit (p. 393) objects errors (p. 26)

Returns any commit IDs for which information could not be found. For example, if one of the commit IDs was a shortened SHA ID or that commit was not found in the speciﬁed repository, the ID returns an error object with more information.

Type: Array of BatchGetCommitsError (p. 384) objects

Errors

CommitIdsLimitExceededException

The maximum number of allowed commit IDs in a batch request is 100. Verify that your batch requests contains no more than 100 commit IDs, and then try again.

HTTP Status Code: 400 CommitIdsListRequiredException

A list of commit IDs is required, but was either not speciﬁed or the list was empty.

(44)

Examples

EncryptionKeyDisabledException The encryption key is disabled.

Examples

Example

This example illustrates one usage of BatchGetCommits.

Sample Request

>POST / HTTP/1.1

Content-Length: 105

X-Amz-Target: CodeCommit_20150413.BatchGetCommits X-Amz-Date: 20190724T201222Z

AWS CodeCommit

AWS CodeCommit

API Reference

API Version 2015-04-13

AWS CodeCommit: API Reference

Table of Contents

Welcome

Actions

AssociateApprovalRuleTemplateWithRepository

Request Syntax

Request Parameters

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

BatchAssociateApprovalRuleTemplateWithRepositories

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

BatchDescribeMergeConﬂicts

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

BatchDisassociateApprovalRuleTemplateFromRepositories

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

BatchGetCommits

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Example

Sample Request