MergeBranchesByThreeWay
Merges two specified branches using the three-way merge strategy.
Request Syntax
{
"authorName": "string
",
"commitMessage": "string
",
"conflictDetailLevel": "string
",
"conflictResolution": {
"deleteFiles": [
{
"filePath": "string
"
}
],
"replaceContents": [
{
"content": blob
,
"fileMode": "string
",
"filePath": "string
",
"replacementType": "string
"
}
],
"setFileModes": [
{
"fileMode": "string
",
"filePath": "string
"
}
]
},
"conflictResolutionStrategy": "string
",
"destinationCommitSpecifier": "string
",
"email": "string
",
"keepEmptyFolders": boolean
,
"repositoryName": "string
",
"sourceCommitSpecifier": "string
",
"targetBranch": "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.
-
The name of the author who created the commit. This information is used as both the author and committer for the commit.
Type: String
Required: No
- commitMessage
-
The commit message to include in the commit information for the merge.
Type: String
Required: No
- conflictDetailLevel
-
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
- conflictResolution
-
If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a merge.
Type: ConflictResolution object
Required: No
- conflictResolutionStrategy
-
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
- destinationCommitSpecifier
-
The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
Type: String
Required: Yes
-
The email address of the person merging the branches. This information is used in the commit information for the merge.
Type: String
Required: No
- keepEmptyFolders
-
If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If true, a .gitkeep file is created for empty folders. The default is false.
Type: Boolean
Required: No
- repositoryName
-
The name of the repository where you want to merge two branches.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[\w\.-]+
Required: Yes
- sourceCommitSpecifier
-
The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
Type: String
Required: Yes
- targetBranch
-
The branch where the merge is applied.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
Response Syntax
{
"commitId": "string",
"treeId": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- BranchDoesNotExistException
-
The specified branch does not exist.
HTTP Status Code: 400
- BranchNameIsTagNameException
-
The specified branch name is not valid because it is a tag name. Enter the name of a branch in the repository. For a list of valid branch names, use ListBranches.
HTTP Status Code: 400
- BranchNameRequiredException
-
A branch name is required, but was not specified.
HTTP Status Code: 400
- CommitDoesNotExistException
-
The specified commit does not exist or no commit was specified, and the specified repository has no default branch.
HTTP Status Code: 400
- CommitMessageLengthExceededException
-
The commit message is too long. Provide a shorter string.
HTTP Status Code: 400
- CommitRequiredException
-
A commit was not specified.
HTTP Status Code: 400
- ConcurrentReferenceUpdateException
-
The merge cannot be completed because the target branch has been modified. Another user might have modified the target branch while the merge was in progress. Wait a few minutes, and then try again.
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
- FileContentSizeLimitExceededException
-
The file cannot be added because it is too large. The maximum file size is 6 MB, and the combined file content change size is 7 MB. Consider making these changes using a Git client.
HTTP Status Code: 400
- FileModeRequiredException
-
The commit cannot be created because no file mode has been specified. A file mode is required to update mode permissions for a file.
HTTP Status Code: 400
- FolderContentSizeLimitExceededException
-
The commit cannot be created because at least one of the overall changes in the commit results in a folder whose contents exceed the limit of 6 MB. Either reduce the number and size of your changes, or split the changes across multiple folders.
HTTP Status Code: 400
- InvalidBranchNameException
-
The specified reference name is not valid.
HTTP Status Code: 400
- InvalidCommitException
-
The specified commit is not valid.
HTTP Status Code: 400
- InvalidConflictDetailLevelException
-
The specified conflict detail level is not valid.
HTTP Status Code: 400
- InvalidConflictResolutionException
-
The specified conflict resolution list is not valid.
HTTP Status Code: 400
- InvalidConflictResolutionStrategyException
-
The specified conflict resolution strategy is not valid.
HTTP Status Code: 400
- InvalidEmailException
-
The specified email address either contains one or more characters that are not allowed, or it exceeds the maximum number of characters allowed for an email address.
HTTP Status Code: 400
- InvalidFileModeException
-
The specified file mode permission is not valid. For a list of valid file mode permissions, see PutFile.
HTTP Status Code: 400
- InvalidPathException
-
The specified path is not valid.
HTTP Status Code: 400
- InvalidReplacementContentException
-
Automerge was specified for resolving the conflict, but the replacement type is not valid or content is missing.
HTTP Status Code: 400
- InvalidReplacementTypeException
-
Automerge was specified for resolving the conflict, but the specified replacement type is not valid.
HTTP Status Code: 400
- InvalidRepositoryNameException
-
A specified repository name is not valid.
Note
This exception occurs only when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
HTTP Status Code: 400
- InvalidTargetBranchException
-
The specified target branch is not valid.
HTTP Status Code: 400
- ManualMergeRequiredException
-
The pull request cannot be merged automatically into the destination branch. You must manually merge the branches and resolve any conflicts.
HTTP Status Code: 400
- MaximumConflictResolutionEntriesExceededException
-
The number of allowed conflict resolution entries was exceeded.
HTTP Status Code: 400
- MaximumFileContentToLoadExceededException
-
The number of files to load exceeds the allowed limit.
HTTP Status Code: 400
- 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
- MultipleConflictResolutionEntriesException
-
More than one conflict resolution entries exists for the conflict. A conflict can have only one conflict resolution entry.
HTTP Status Code: 400
- NameLengthExceededException
-
The user name is not valid because it has exceeded the character limit for author names.
HTTP Status Code: 400
- PathRequiredException
-
The folderPath for a location cannot be null.
HTTP Status Code: 400
- ReplacementContentRequiredException
-
USE_NEW_CONTENT was specified, but no replacement content has been provided.
HTTP Status Code: 400
- ReplacementTypeRequiredException
-
A replacement type is required.
HTTP Status Code: 400
- RepositoryDoesNotExistException
-
The specified repository does not exist.
HTTP Status Code: 400
- RepositoryNameRequiredException
-
A repository name is required, but was not specified.
HTTP Status Code: 400
- TipsDivergenceExceededException
-
The divergence between the tips of the provided commit specifiers is too great to determine whether there might be any merge conflicts. Locally compare the specifiers using
git diff
or a diff tool.HTTP Status Code: 400
Examples
Example
This example illustrates one usage of MergeBranchesByThreeWay.
Sample Request
>POST / HTTP/1.1
Host: codecommit.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 226
X-Amz-Target: CodeCommit_20150413.MergeBranchesByThreeWay
X-Amz-Date: 20190428T213222Z
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",
"destinationCommitSpecifier": "bugfix-bug1234",
"sourceCommitSpecifier": "main",
"authorName": "Jorge Souza",
"email": "jorge_souza@example.com",
"commitMessage": "Merging changes from main before additional testing"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 0728aaa8-EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 1681
Date: Sun, 28 Apr 2019 22:43:13 GMT
{
"commitId": "4f178133EXAMPLE",
"treeId": "389765daEXAMPLE"
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: