Icon

AWS CodeCommit (version v1.*.*)

batch_describe_merge_conflicts

Returns information about one or more merge conflicts in the attempted merge of two commit specifiers using the squash or three-way merge strategy.

Parameters

$body

Type: object

{
"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.",
"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.",
"nextToken" : "An enumeration token that when provided in a request, returns the next batch of the results.",
"maxMergeHunks" : "The maximum number of merge hunks to include in the output.",
"conflictDetailLevel" : "The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.",
"repositoryName" : "The name of the repository that contains the merge conflicts you want to review.",
"mergeOption" : "The merge option or strategy you want to use to merge the code.",
"filePaths" : [ "string" ],
"maxConflictFiles" : "The maximum number of files to include in the output.",
"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 will be successful."
}

batch_get_commits

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

Parameters

$body

Type: object

{
"repositoryName" : "The name of the repository that contains the commits.",
"commitIds" : [ "string" ]
}

batch_get_repositories

Returns information about one or more repositories.
The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

Parameters

$body

Represents the input of a batch get repositories operation.

Type: object

{
"repositoryNames" : [ "string" ]
}

create_branch

Creates a new branch in a repository and points the branch to a commit.
Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.

Parameters

$body

Represents the input of a create branch operation.

Type: object

{
"branchName" : "The name of the new branch to create.",
"commitId" : "The ID of the commit to point the new branch to.",
"repositoryName" : "The name of the repository in which you want to create the new branch."
}

create_commit

Creates a commit for a repository on the tip of a specified branch.

Parameters

$body

Type: object

{
"deleteFiles" : [ {
"filePath" : "The full path of the file that will be deleted, including the name of the file."
} ],
"putFiles" : [ {
"filePath" : "The full path to the file in the repository, including the name of the file.",
"fileMode" : "The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.",
"sourceFile" : {
"filePath" : "The full path to the file, including the name of the file.",
"isMove" : "Whether to remove the source file from the parent commit."
},
"fileContent" : "The content of the file, if a source file is not specified."
} ],
"keepEmptyFolders" : "If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If this is specified as true, a .gitkeep file will be created for empty folders. The default is false.",
"parentCommitId" : "The ID of the commit that is the parent of the commit you will create. If this is an empty repository, this is not required.",
"commitMessage" : "The commit message you want to include as part of creating the commit. Commit messages are limited to 256 KB. If no message is specified, a default message will be used.",
"authorName" : "The name of the author who created the commit. This information will be used as both the author and committer for the commit.",
"branchName" : "The name of the branch where you will create the commit.",
"repositoryName" : "The name of the repository where you will create the commit.",
"email" : "The email address of the person who created the commit.",
"setFileModes" : [ {
"filePath" : "The full path to the file, including the name of the file.",
"fileMode" : "The file mode for the file."
} ]
}

create_pull_request

Creates a pull request in the specified repository.

Parameters

$body

Type: object

{
"clientRequestToken" : "A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token. \nThe AWS SDKs prepopulate client request tokens. If using an AWS SDK, you do not have to generate an idempotency token, as this will be done for you.",
"description" : "A description of the pull request.",
"title" : "The title of the pull request. This title will be used to identify the pull request to other users in the repository.",
"targets" : [ {
"sourceReference" : "The branch of the repository that contains the changes for the pull request. Also known as the source branch.",
"destinationReference" : "The branch of the repository where the pull request changes will be merged into. Also known as the destination branch.",
"repositoryName" : "The name of the repository that contains the pull request."
} ]
}

create_repository

Creates a new, empty repository.

Parameters

$body

Represents the input of a create repository operation.

Type: object

{
"repositoryDescription" : "A comment or description about the new repository. \nThe description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.",
"repositoryName" : "The name of the new repository to be created. \nThe repository name must be unique across the calling AWS account. In addition, repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. For a full description of the limits on repository names, see Limits in the AWS CodeCommit User Guide. The suffix \".git\" is prohibited.",
"tags" : "One or more tag key-value pairs to use when tagging this repository."
}

create_unreferenced_merge_commit

Creates an unreferenced commit that represents the result of merging two branches using a specified merge strategy. This can help you determine the outcome of a potential merge. This API cannot be used with the fast-forward merge strategy, as that strategy does not create a merge commit.
This unreferenced merge commit can only be accessed using the GetCommit API or through git commands such as git fetch. To retrieve this commit, you must specify its commit ID or otherwise reference it.

Parameters

$body

Type: object

{
"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.",
"keepEmptyFolders" : "If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If this is specified as true, a .gitkeep file will be created for empty folders. The default is false.",
"commitMessage" : "The commit message for the unreferenced commit.",
"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.",
"authorName" : "The name of the author who created the unreferenced commit. This information will be used as both the author and committer for the commit.",
"conflictDetailLevel" : "The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.",
"repositoryName" : "The name of the repository where you want to create the unreferenced merge commit.",
"mergeOption" : "The merge option or strategy you want to use to merge the code.",
"email" : "The email address for the person who created the unreferenced commit.",
"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 will be successful.",
"conflictResolution" : {
"deleteFiles" : [ {
"filePath" : "The full path of the file that will be deleted, including the name of the file."
} ],
"replaceContents" : [ {
"replacementType" : "The replacement type to use when determining how to resolve the conflict.",
"filePath" : "The path of the conflicting file.",
"fileMode" : "The file mode to apply during conflict resoltion.",
"content" : "The base-64 encoded content to use when the replacement type is USE_NEW_CONTENT."
} ],
"setFileModes" : [ {
"filePath" : "The full path to the file, including the name of the file.",
"fileMode" : "The file mode for the file."
} ]
}
}

delete_branch

Deletes a branch from a repository, unless that branch is the default branch for the repository.

Parameters

$body

Represents the input of a delete branch operation.

Type: object

{
"branchName" : "The name of the branch to delete.",
"repositoryName" : "The name of the repository that contains the branch to be deleted."
}

delete_comment_content

Deletes the content of a comment made on a change, file, or commit in a repository.

Parameters

$body

Type: object

{
"commentId" : "The unique, system-generated ID of the comment. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest."
}

delete_file

Deletes a specified file from a specified branch. A commit is created on the branch that contains the revision. The file will still exist in the commits prior to the commit that contains the deletion.

Parameters

$body

Type: object

{
"keepEmptyFolders" : "Specifies whether to delete the folder or directory that contains the file you want to delete if that file is the only object in the folder or directory. By default, empty folders will be deleted. This includes empty folders that are part of the directory structure. For example, if the path to a file is dir1/dir2/dir3/dir4, and dir2 and dir3 are empty, deleting the last file in dir4 will also delete the empty folders dir4, dir3, and dir2.",
"parentCommitId" : "The ID of the commit that is the tip of the branch where you want to create the commit that will delete the file. This must be the HEAD commit for the branch. The commit that deletes the file will be created from this commit ID.",
"commitMessage" : "The commit message you want to include as part of deleting the file. Commit messages are limited to 256 KB. If no message is specified, a default message will be used.",
"filePath" : "The fully-qualified path to the file that will be deleted, including the full name and extension of that file. For example, /examples/file.md is a fully qualified path to a file named file.md in a folder named examples.",
"name" : "The name of the author of the commit that deletes the file. If no name is specified, the user's ARN will be used as the author name and committer name.",
"branchName" : "The name of the branch where the commit will be made deleting the file.",
"repositoryName" : "The name of the repository that contains the file to delete.",
"email" : "The email address for the commit that deletes the file. If no email address is specified, the email address will be left blank."
}

delete_repository

Deletes a repository. If a specified repository was already deleted, a null repository ID will be returned.
Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository will fail.

Parameters

$body

Represents the input of a delete repository operation.

Type: object

{
"repositoryName" : "The name of the repository to delete."
}

describe_merge_conflicts

Returns information about one or more merge conflicts in the attempted merge of two commit specifiers using the squash or three-way merge strategy. If the merge option for the attempted merge is specified as FAST_FORWARD_MERGE, an exception will be thrown.

Parameters

$body

Type: object

{
"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.",
"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.",
"nextToken" : "An enumeration token that when provided in a request, returns the next batch of the results.",
"maxMergeHunks" : "The maximum number of merge hunks to include in the output.",
"filePath" : "The path of the target files used to describe the conflicts. ",
"conflictDetailLevel" : "The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.",
"repositoryName" : "The name of the repository where you want to get information about a merge conflict.",
"mergeOption" : "The merge option or strategy you want to use to merge the code.",
"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 will be successful."
}

describe_pull_request_events

Returns information about one or more pull request events.

Parameters

$body

Type: object

{
"pullRequestEventType" : "Optional. The pull request event type about which you want to return information.",
"actorArn" : "The Amazon Resource Name (ARN) of the user whose actions resulted in the event. Examples include updating the pull request with additional commits or changing the status of a pull request.",
"pullRequestId" : "The system-generated ID of the pull request. To get this ID, use ListPullRequests."
}

get_blob

Returns the base-64 encoded content of an individual blob within a repository.

Parameters

$body

Represents the input of a get blob operation.

Type: object

{
"blobId" : "The ID of the blob, which is its SHA-1 pointer.",
"repositoryName" : "The name of the repository that contains the blob."
}

get_branch

Returns information about a repository branch, including its name and the last commit ID.

Parameters

$body

Represents the input of a get branch operation.

Type: object

{
"branchName" : "The name of the branch for which you want to retrieve information.",
"repositoryName" : "The name of the repository that contains the branch for which you want to retrieve information."
}

get_comment

Returns the content of a comment made on a change, file, or commit in a repository.

Parameters

$body

Type: object

{
"commentId" : "The unique, system-generated ID of the comment. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest."
}

get_comments_for_compared_commit

Returns information about comments made on the comparison between two commits.

Parameters

$body

Type: object

{
"beforeCommitId" : "To establish the directionality of the comparison, the full commit ID of the 'before' commit.",
"afterCommitId" : "To establish the directionality of the comparison, the full commit ID of the 'after' commit.",
"repositoryName" : "The name of the repository where you want to compare commits."
}

get_comments_for_pull_request

Returns comments made on a pull request.

Parameters

$body

Type: object

{
"beforeCommitId" : "The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.",
"afterCommitId" : "The full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was made.",
"pullRequestId" : "The system-generated ID of the pull request. To get this ID, use ListPullRequests.",
"repositoryName" : "The name of the repository that contains the pull request."
}

get_commit

Returns information about a commit, including commit message and committer information.

Parameters

$body

Represents the input of a get commit operation.

Type: object

{
"commitId" : "The commit ID. Commit IDs are the full SHA of the commit.",
"repositoryName" : "The name of the repository to which the commit was made."
}

get_differences

Returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified reference). Results can be limited to a specified path.

Parameters

$body

Type: object

{
"beforePath" : "The file path in which to check for differences. Limits the results to this path. Can also be used to specify the previous name of a directory or folder. If beforePath and afterPath are not specified, differences will be shown for all paths.",
"afterCommitSpecifier" : "The branch, tag, HEAD, or other fully qualified reference used to identify a commit.",
"repositoryName" : "The name of the repository where you want to get differences.",
"beforeCommitSpecifier" : "The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, the full commit ID. Optional. If not specified, all changes prior to the afterCommitSpecifier value will be shown. If you do not use beforeCommitSpecifier in your request, consider limiting the results with maxResults.",
"afterPath" : "The file path in which to check differences. Limits the results to this path. Can also be used to specify the changed name of a directory or folder, if it has changed. If not specified, differences will be shown for all paths."
}

get_file

Returns the base-64 encoded contents of a specified file and its metadata.

Parameters

$body

Type: object

{
"commitSpecifier" : "The fully-quaified reference that identifies the commit that contains the file. For example, you could specify a full commit ID, a tag, a branch name, or a reference such as refs/heads/master. If none is provided, then the head commit will be used.",
"filePath" : "The fully-qualified path to the file, including the full name and extension of the file. For example, /examples/file.md is the fully-qualified path to a file named file.md in a folder named examples.",
"repositoryName" : "The name of the repository that contains the file."
}

get_folder

Returns the contents of a specified folder in a repository.

Parameters

$body

Type: object

{
"folderPath" : "The fully-qualified path to the folder whose contents will be returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository. ",
"commitSpecifier" : "A fully-qualified reference used to identify a commit that contains the version of the folder's content to return. A fully-qualified reference can be a commit ID, branch name, tag, or reference such as HEAD. If no specifier is provided, the folder content will be returned as it exists in the HEAD commit.",
"repositoryName" : "The name of the repository."
}

get_merge_commit

Returns information about a specified merge commit.

Parameters

$body

Type: object

{
"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.",
"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.",
"conflictDetailLevel" : "The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.",
"repositoryName" : "The name of the repository that contains the merge commit about which you want to get information.",
"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 will be successful."
}

get_merge_conflicts

Returns information about merge conflicts between the before and after commit IDs for a pull request in a repository.

Parameters

$body

Type: object

{
"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.",
"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.",
"nextToken" : "An enumeration token that when provided in a request, returns the next batch of the results.",
"conflictDetailLevel" : "The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.",
"repositoryName" : "The name of the repository where the pull request was created.",
"mergeOption" : "The merge option or strategy you want to use to merge the code. ",
"maxConflictFiles" : "The maximum number of files to include in the output.",
"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 will be successful."
}

get_merge_options

Returns information about the merge options available for merging two specified branches. For details about why a particular merge option is not available, use GetMergeConflicts or DescribeMergeConflicts.

Parameters

$body

Type: object

{
"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.",
"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.",
"conflictDetailLevel" : "The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.",
"repositoryName" : "The name of the repository that contains the commits about which you want to get merge options.",
"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 will be successful."
}

get_pull_request

Gets information about a pull request in a specified repository.

Parameters

$body

Type: object

{
"pullRequestId" : "The system-generated ID of the pull request. To get this ID, use ListPullRequests."
}

get_repository

Returns information about a repository.
The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

Parameters

$body

Represents the input of a get repository operation.

Type: object

{
"repositoryName" : "The name of the repository to get information about."
}

get_repository_triggers

Gets information about triggers configured for a repository.

Parameters

$body

Represents the input of a get repository triggers operation.

Type: object

{
"repositoryName" : "The name of the repository for which the trigger is configured."
}

list_branches

Gets information about one or more branches in a repository.

Parameters

$body

Represents the input of a list branches operation.

Type: object

{
"repositoryName" : "The name of the repository that contains the branches."
}

list_pull_requests

Returns a list of pull requests for a specified repository. The return list can be refined by pull request status or pull request author ARN.

Parameters

$body

Type: object

{
"authorArn" : "Optional. The Amazon Resource Name (ARN) of the user who created the pull request. If used, this filters the results to pull requests created by that user.",
"pullRequestStatus" : "Optional. The status of the pull request. If used, this refines the results to the pull requests that match the specified status.",
"repositoryName" : "The name of the repository for which you want to list pull requests."
}

list_repositories

Gets information about one or more repositories.

Parameters

$body

Represents the input of a list repositories operation.

Type: object

{
"sortBy" : "The criteria used to sort the results of a list repositories operation.",
"order" : "The order in which to sort the results of a list repositories operation."
}

list_tags_for_resource

Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeCommit. For a list of valid resources in AWS CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User Guide.

Parameters

$body

Type: object

{
"nextToken" : "An enumeration token that when provided in a request, returns the next batch of the results.",
"resourceArn" : "The Amazon Resource Name (ARN) of the resource for which you want to get information about tags, if any."
}

merge_branches_by_fast_forward

Merges two branches using the fast-forward merge strategy.

Parameters

$body

Type: object

{
"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.",
"targetBranch" : "The branch where the merge will be applied.",
"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.",
"repositoryName" : "The name of the repository where you want to merge two branches."
}

merge_branches_by_squash

Merges two branches using the squash merge strategy.

Parameters

$body

Type: object

{
"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.",
"targetBranch" : "The branch where the merge will be applied. ",
"keepEmptyFolders" : "If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If this is specified as true, a .gitkeep file will be created for empty folders. The default is false.",
"commitMessage" : "The commit message for the merge.",
"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.",
"authorName" : "The name of the author who created the commit. This information will be used as both the author and committer for the commit.",
"conflictDetailLevel" : "The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.",
"repositoryName" : "The name of the repository where you want to merge two branches.",
"email" : "The email address of the person merging the branches. This information will be used in the commit information for the merge.",
"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 will be successful.",
"conflictResolution" : {
"deleteFiles" : [ {
"filePath" : "The full path of the file that will be deleted, including the name of the file."
} ],
"replaceContents" : [ {
"replacementType" : "The replacement type to use when determining how to resolve the conflict.",
"filePath" : "The path of the conflicting file.",
"fileMode" : "The file mode to apply during conflict resoltion.",
"content" : "The base-64 encoded content to use when the replacement type is USE_NEW_CONTENT."
} ],
"setFileModes" : [ {
"filePath" : "The full path to the file, including the name of the file.",
"fileMode" : "The file mode for the file."
} ]
}
}

merge_branches_by_three_way

Merges two specified branches using the three-way merge strategy.

Parameters

$body

Type: object

{
"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.",
"targetBranch" : "The branch where the merge will be applied. ",
"keepEmptyFolders" : "If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If this is specified as true, a .gitkeep file will be created for empty folders. The default is false.",
"commitMessage" : "The commit message to include in the commit information for the merge.",
"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.",
"authorName" : "The name of the author who created the commit. This information will be used as both the author and committer for the commit.",
"conflictDetailLevel" : "The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.",
"repositoryName" : "The name of the repository where you want to merge two branches.",
"email" : "The email address of the person merging the branches. This information will be used in the commit information for the merge.",
"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 will be successful.",
"conflictResolution" : {
"deleteFiles" : [ {
"filePath" : "The full path of the file that will be deleted, including the name of the file."
} ],
"replaceContents" : [ {
"replacementType" : "The replacement type to use when determining how to resolve the conflict.",
"filePath" : "The path of the conflicting file.",
"fileMode" : "The file mode to apply during conflict resoltion.",
"content" : "The base-64 encoded content to use when the replacement type is USE_NEW_CONTENT."
} ],
"setFileModes" : [ {
"filePath" : "The full path to the file, including the name of the file.",
"fileMode" : "The file mode for the file."
} ]
}
}

merge_pull_request_by_fast_forward

Attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the fast-forward merge strategy. If the merge is successful, it closes the pull request.

Parameters

$body

Type: object

{
"sourceCommitId" : "The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.",
"pullRequestId" : "The system-generated ID of the pull request. To get this ID, use ListPullRequests.",
"repositoryName" : "The name of the repository where the pull request was created."
}

merge_pull_request_by_squash

Attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the squash merge strategy. If the merge is successful, it closes the pull request.

Parameters

$body

Type: object

{
"keepEmptyFolders" : "If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If this is specified as true, a .gitkeep file will be created for empty folders. The default is false.",
"commitMessage" : "The commit message to include in the commit information for the merge.",
"authorName" : "The name of the author who created the commit. This information will be used as both the author and committer for the commit.",
"conflictDetailLevel" : "The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.",
"sourceCommitId" : "The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.",
"pullRequestId" : "The system-generated ID of the pull request. To get this ID, use ListPullRequests.",
"repositoryName" : "The name of the repository where the pull request was created.",
"email" : "The email address of the person merging the branches. This information will be used in the commit information for the merge.",
"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 will be successful.",
"conflictResolution" : {
"deleteFiles" : [ {
"filePath" : "The full path of the file that will be deleted, including the name of the file."
} ],
"replaceContents" : [ {
"replacementType" : "The replacement type to use when determining how to resolve the conflict.",
"filePath" : "The path of the conflicting file.",
"fileMode" : "The file mode to apply during conflict resoltion.",
"content" : "The base-64 encoded content to use when the replacement type is USE_NEW_CONTENT."
} ],
"setFileModes" : [ {
"filePath" : "The full path to the file, including the name of the file.",
"fileMode" : "The file mode for the file."
} ]
}
}

merge_pull_request_by_three_way

Attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the three-way merge strategy. If the merge is successful, it closes the pull request.

Parameters

$body

Type: object

{
"keepEmptyFolders" : "If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If this is specified as true, a .gitkeep file will be created for empty folders. The default is false.",
"commitMessage" : "The commit message to include in the commit information for the merge.",
"authorName" : "The name of the author who created the commit. This information will be used as both the author and committer for the commit.",
"conflictDetailLevel" : "The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.",
"sourceCommitId" : "The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.",
"pullRequestId" : "The system-generated ID of the pull request. To get this ID, use ListPullRequests.",
"repositoryName" : "The name of the repository where the pull request was created.",
"email" : "The email address of the person merging the branches. This information will be used in the commit information for the merge.",
"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 will be successful.",
"conflictResolution" : {
"deleteFiles" : [ {
"filePath" : "The full path of the file that will be deleted, including the name of the file."
} ],
"replaceContents" : [ {
"replacementType" : "The replacement type to use when determining how to resolve the conflict.",
"filePath" : "The path of the conflicting file.",
"fileMode" : "The file mode to apply during conflict resoltion.",
"content" : "The base-64 encoded content to use when the replacement type is USE_NEW_CONTENT."
} ],
"setFileModes" : [ {
"filePath" : "The full path to the file, including the name of the file.",
"fileMode" : "The file mode for the file."
} ]
}
}

post_comment_for_compared_commit

Posts a comment on the comparison between two commits.

Parameters

$body

Type: object

{
"beforeCommitId" : "To establish the directionality of the comparison, the full commit ID of the 'before' commit. \nThis is required for commenting on any commit unless that commit is the initial commit.",
"clientRequestToken" : "A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.",
"location" : {
"filePath" : "The name of the file being compared, including its extension and subdirectory, if any.",
"relativeFileVersion" : "In a comparison of commits or a pull request, whether the change is in the 'before' or 'after' of that comparison.",
"filePosition" : "The position of a change within a compared file, in line number format."
},
"afterCommitId" : "To establish the directionality of the comparison, the full commit ID of the 'after' commit.",
"repositoryName" : "The name of the repository where you want to post a comment on the comparison between commits.",
"content" : "The content of the comment you want to make."
}

post_comment_for_pull_request

Posts a comment on a pull request.

Parameters

$body

Type: object

{
"beforeCommitId" : "The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.",
"clientRequestToken" : "A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.",
"location" : {
"filePath" : "The name of the file being compared, including its extension and subdirectory, if any.",
"relativeFileVersion" : "In a comparison of commits or a pull request, whether the change is in the 'before' or 'after' of that comparison.",
"filePosition" : "The position of a change within a compared file, in line number format."
},
"afterCommitId" : "The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment.",
"pullRequestId" : "The system-generated ID of the pull request. To get this ID, use ListPullRequests.",
"repositoryName" : "The name of the repository where you want to post a comment on a pull request.",
"content" : "The content of your comment on the change."
}

post_comment_reply

Posts a comment in reply to an existing comment on a comparison between commits or a pull request.

Parameters

$body

Type: object

{
"clientRequestToken" : "A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.",
"inReplyTo" : "The system-generated ID of the comment to which you want to reply. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest.",
"content" : "The contents of your reply to a comment."
}

put_file

Adds or updates a file in a branch in an AWS CodeCommit repository, and generates a commit for the addition in the specified branch.

Parameters

$body

Type: object

{
"parentCommitId" : "The full commit ID of the head commit in the branch where you want to add or update the file. If this is an empty repository, no commit ID is required. If this is not an empty repository, a commit ID is required. \nThe commit ID must match the ID of the head commit at the time of the operation, or an error will occur, and the file will not be added or updated.",
"commitMessage" : "A message about why this file was added or updated. While optional, adding a message is strongly encouraged in order to provide a more useful commit history for your repository.",
"filePath" : "The name of the file you want to add or update, including the relative path to the file in the repository. \nIf the path does not currently exist in the repository, the path will be created as part of adding the file.",
"name" : "The name of the person adding or updating the file. While optional, adding a name is strongly encouraged in order to provide a more useful commit history for your repository.",
"branchName" : "The name of the branch where you want to add or update the file. If this is an empty repository, this branch will be created.",
"fileMode" : "The file mode permissions of the blob. Valid file mode permissions are listed below.",
"repositoryName" : "The name of the repository where you want to add or update the file.",
"fileContent" : "The content of the file, in binary object format. ",
"email" : "An email address for the person adding or updating the file."
}

put_repository_triggers

Replaces all triggers for a repository. This can be used to create or delete triggers.

Parameters

$body

Represents the input ofa put repository triggers operation.

Type: object

{
"repositoryName" : "The name of the repository where you want to create or update the trigger.",
"triggers" : [ {
"destinationArn" : "The ARN of the resource that is the target for a trigger. For example, the ARN of a topic in Amazon SNS.",
"name" : "The name of the trigger.",
"customData" : "Any custom data associated with the trigger that will be included in the information sent to the target of the trigger.",
"branches" : [ "string" ],
"events" : [ "string. Possible values: all | updateReference | createReference | deleteReference" ]
} ]
}

tag_resource

Adds or updates tags for a resource in AWS CodeCommit. For a list of valid resources in AWS CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User Guide.

Parameters

$body

Type: object

{
"resourceArn" : "The Amazon Resource Name (ARN) of the resource to which you want to add or update tags.",
"tags" : "The key-value pair to use when tagging this repository."
}

test_repository_triggers

Tests the functionality of repository triggers by sending information to the trigger target. If real data is available in the repository, the test will send data from the last commit. If no data is available, sample data will be generated.

Parameters

$body

Represents the input of a test repository triggers operation.

Type: object

{
"repositoryName" : "The name of the repository in which to test the triggers.",
"triggers" : [ {
"destinationArn" : "The ARN of the resource that is the target for a trigger. For example, the ARN of a topic in Amazon SNS.",
"name" : "The name of the trigger.",
"customData" : "Any custom data associated with the trigger that will be included in the information sent to the target of the trigger.",
"branches" : [ "string" ],
"events" : [ "string. Possible values: all | updateReference | createReference | deleteReference" ]
} ]
}

untag_resource

Removes tags for a resource in AWS CodeCommit. For a list of valid resources in AWS CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User Guide.

Parameters

$body

Type: object

{
"tagKeys" : [ "string" ],
"resourceArn" : "The Amazon Resource Name (ARN) of the resource to which you want to remove tags."
}

update_comment

Replaces the contents of a comment.

Parameters

$body

Type: object

{
"commentId" : "The system-generated ID of the comment you want to update. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest.",
"content" : "The updated content with which you want to replace the existing content of the comment."
}

update_default_branch

Sets or changes the default branch name for the specified repository.
If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.

Parameters

$body

Represents the input of an update default branch operation.

Type: object

{
"defaultBranchName" : "The name of the branch to set as the default.",
"repositoryName" : "The name of the repository to set or change the default branch for."
}

update_pull_request_description

Replaces the contents of the description of a pull request.

Parameters

$body

Type: object

{
"description" : "The updated content of the description for the pull request. This content will replace the existing description.",
"pullRequestId" : "The system-generated ID of the pull request. To get this ID, use ListPullRequests."
}

update_pull_request_status

Updates the status of a pull request.

Parameters

$body

Type: object

{
"pullRequestStatus" : "The status of the pull request. The only valid operations are to update the status from OPEN to OPEN, OPEN to CLOSED or from from CLOSED to CLOSED.",
"pullRequestId" : "The system-generated ID of the pull request. To get this ID, use ListPullRequests."
}

update_pull_request_title

Replaces the title of a pull request.

Parameters

$body

Type: object

{
"pullRequestId" : "The system-generated ID of the pull request. To get this ID, use ListPullRequests.",
"title" : "The updated title of the pull request. This will replace the existing title."
}

update_repository_description

Sets or changes the comment or description for a repository.
The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

Parameters

$body

Represents the input of an update repository description operation.

Type: object

{
"repositoryDescription" : "The new comment or description for the specified repository. Repository descriptions are limited to 1,000 characters.",
"repositoryName" : "The name of the repository to set or change the comment or description for."
}

update_repository_name

Renames a repository. The repository name must be unique across the calling AWS account. In addition, repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. The suffix ".git" is prohibited. For a full description of the limits on repository names, see Limits in the AWS CodeCommit User Guide.

Parameters

$body

Represents the input of an update repository description operation.

Type: object

{
"newName" : "The new name for the repository.",
"oldName" : "The existing name of the repository."
}