Expand description
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, which returns information about one or more repositories associated with your AWS account.
-
CreateRepository, which creates an AWS CodeCommit repository.
-
DeleteRepository, which deletes an AWS CodeCommit repository.
-
GetRepository, which returns information about a specified repository.
-
ListRepositories, which lists all AWS CodeCommit repositories associated with your AWS account.
-
UpdateRepositoryDescription, which sets or updates the description of the repository.
-
UpdateRepositoryName, 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, which creates a branch in a specified repository.
-
DeleteBranch, which deletes the specified branch in a repository unless it is the default branch.
-
GetBranch, which returns information about a specified branch.
-
ListBranches, which lists all branches for a specified repository.
-
UpdateDefaultBranch, which changes the default branch for a repository.
Files, by calling the following:
-
DeleteFile, which deletes the content of a specified file from a specified branch.
-
GetBlob, which returns the base-64 encoded content of an individual Git blob object in a repository.
-
GetFile, which returns the base-64 encoded content of a specified file.
-
GetFolder, which returns the contents of a specified folder or directory.
-
PutFile, which adds or modifies a single file in a specified repository and branch.
Commits, by calling the following:
-
BatchGetCommits, which returns information about one or more commits in a repository.
-
CreateCommit, which creates a commit for changes to a repository.
-
GetCommit, which returns information about a commit, including commit messages and author and committer information.
-
GetDifferences, which returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID, or other fully qualified reference).
Merges, by calling the following:
-
BatchDescribeMergeConflicts, which returns information about conflicts in a merge between commits in a repository.
-
CreateUnreferencedMergeCommit, which creates an unreferenced commit between two branches or commits for the purpose of comparing them and identifying any potential conflicts.
-
DescribeMergeConflicts, which returns information about merge conflicts between the base, source, and destination versions of a file in a potential merge.
-
GetMergeCommit, which returns information about the merge between a source and destination commit.
-
GetMergeConflicts, which returns information about merge conflicts between the source and destination branch in a pull request.
-
GetMergeOptions, which returns information about the available merge options between two branches or commit specifiers.
-
MergeBranchesByFastForward, which merges two branches using the fast-forward merge option.
-
MergeBranchesBySquash, which merges two branches using the squash merge option.
-
MergeBranchesByThreeWay, which merges two branches using the three-way merge option.
Pull requests, by calling the following:
-
CreatePullRequest, which creates a pull request in a specified repository.
-
CreatePullRequestApprovalRule, which creates an approval rule for a specified pull request.
-
DeletePullRequestApprovalRule, which deletes an approval rule for a specified pull request.
-
DescribePullRequestEvents, which returns information about one or more pull request events.
-
EvaluatePullRequestApprovalRules, which evaluates whether a pull request has met all the conditions specified in its associated approval rules.
-
GetCommentsForPullRequest, which returns information about comments on a specified pull request.
-
GetPullRequest, which returns information about a specified pull request.
-
GetPullRequestApprovalStates, which returns information about the approval states for a specified pull request.
-
GetPullRequestOverrideState, 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, which lists all pull requests for a repository.
-
MergePullRequestByFastForward, which merges the source destination branch of a pull request into the specified destination branch for that pull request using the fast-forward merge option.
-
MergePullRequestBySquash, which merges the source destination branch of a pull request into the specified destination branch for that pull request using the squash merge option.
-
MergePullRequestByThreeWay. which merges the source destination branch of a pull request into the specified destination branch for that pull request using the three-way merge option.
-
OverridePullRequestApprovalRules, which sets aside all approval rule requirements for a pull request.
-
PostCommentForPullRequest, which posts a comment to a pull request at the specified line, file, or request.
-
UpdatePullRequestApprovalRuleContent, which updates the structure of an approval rule for a pull request.
-
UpdatePullRequestApprovalState, which updates the state of an approval on a pull request.
-
UpdatePullRequestDescription, which updates the description of a pull request.
-
UpdatePullRequestStatus, which updates the status of a pull request.
-
UpdatePullRequestTitle, which updates the title of a pull request.
Approval rule templates, by calling the following:
-
AssociateApprovalRuleTemplateWithRepository, which associates a template with a specified 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 specified repository.
-
BatchAssociateApprovalRuleTemplateWithRepositories, which associates a template with one or more specified 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 specified repositories.
-
BatchDisassociateApprovalRuleTemplateFromRepositories, which removes the association between a template and specified repositories so that approval rules based on the template are not automatically created when pull requests are created in those repositories.
-
CreateApprovalRuleTemplate, which creates a template for approval rules that can then be associated with one or more repositories in your AWS account.
-
DeleteApprovalRuleTemplate, which deletes the specified template. It does not remove approval rules on pull requests already created with the template.
-
DisassociateApprovalRuleTemplateFromRepository, 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 specified repository.
-
GetApprovalRuleTemplate, which returns information about an approval rule template.
-
ListApprovalRuleTemplates, which lists all approval rule templates in the AWS Region in your AWS account.
-
ListAssociatedApprovalRuleTemplatesForRepository, which lists all approval rule templates that are associated with a specified repository.
-
ListRepositoriesForApprovalRuleTemplate, which lists all repositories associated with the specified approval rule template.
-
UpdateApprovalRuleTemplateDescription, which updates the description of an approval rule template.
-
UpdateApprovalRuleTemplateName, which updates the name of an approval rule template.
-
UpdateApprovalRuleTemplateContent, which updates the content of an approval rule template.
Comments in a repository, by calling the following:
-
DeleteCommentContent, which deletes the content of a comment on a commit in a repository.
-
GetComment, which returns information about a comment on a commit.
-
GetCommentReactions, which returns information about emoji reactions to comments.
-
GetCommentsForComparedCommit, which returns information about comments on the comparison between two commit specifiers in a repository.
-
PostCommentForComparedCommit, which creates a comment on the comparison between two commit specifiers in a repository.
-
PostCommentReply, which creates a reply to a comment.
-
PutCommentReaction, which creates or updates an emoji reaction to a comment.
-
UpdateComment, which updates the content of a comment on a commit in a repository.
Tags used to tag resources in AWS CodeCommit (not Git tags), by calling the following:
-
ListTagsForResource, which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeCommit.
-
TagResource, which adds or updates tags for a resource in AWS CodeCommit.
-
UntagResource, which removes tags for a resource in AWS CodeCommit.
Triggers, by calling the following:
-
GetRepositoryTriggers, which returns information about triggers configured for a repository.
-
PutRepositoryTriggers, which replaces all triggers for a repository and can be used to create or delete triggers.
-
TestRepositoryTriggers, 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.
If you’re using the service, you’re probably looking for CodeCommitClient and CodeCommit.
Structs§
- Approval
Returns information about a specific approval on a pull request.
- Approval
Rule Returns information about an approval rule.
- Approval
Rule Event Metadata Returns information about an event for an approval rule.
- Approval
Rule Overridden Event Metadata Returns information about an override event for approval rules for a pull request.
- Approval
Rule Template Returns information about an approval rule template.
- Approval
State Changed Event Metadata Returns information about a change in the approval state for a pull request.
- Associate
Approval Rule Template With Repository Input - Batch
Associate Approval Rule Template With Repositories Input - Batch
Associate Approval Rule Template With Repositories Output - Batch
Describe Merge Conflicts Input - Batch
Describe Merge Conflicts Output - Batch
Disassociate Approval Rule Template From Repositories Input - Batch
Disassociate Approval Rule Template From Repositories Output - Batch
GetCommits Input - Batch
GetCommits Output - Batch
GetRepositories Input Represents the input of a batch get repositories operation.
- Batch
GetRepositories Output Represents the output of a batch get repositories operation.
- Blob
Metadata Returns information about a specific Git blob object.
- Branch
Info Returns information about a branch.
- Code
Commit Batch Associate Approval Rule Template With Repositories Error Returns information about errors in a BatchAssociateApprovalRuleTemplateWithRepositories operation.
- Code
Commit Batch Describe Merge Conflicts Error Returns information about errors in a BatchDescribeMergeConflicts operation.
- Code
Commit Batch Disassociate Approval Rule Template From Repositories Error Returns information about errors in a BatchDisassociateApprovalRuleTemplateFromRepositories operation.
- Code
Commit Batch GetCommits Error Returns information about errors in a BatchGetCommits operation.
- Code
Commit Client - A client for the CodeCommit API.
- Comment
Returns information about a specific comment.
- Comments
ForCompared Commit Returns information about comments on the comparison between two commits.
- Comments
ForPull Request Returns information about comments on a pull request.
- Commit
Returns information about a specific commit.
- Conflict
Information about conflicts in a merge operation.
- Conflict
Metadata Information about the metadata for a conflict in a merge operation.
- Conflict
Resolution If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a merge.
- Create
Approval Rule Template Input - Create
Approval Rule Template Output - Create
Branch Input Represents the input of a create branch operation.
- Create
Commit Input - Create
Commit Output - Create
Pull Request Approval Rule Input - Create
Pull Request Approval Rule Output - Create
Pull Request Input - Create
Pull Request Output - Create
Repository Input Represents the input of a create repository operation.
- Create
Repository Output Represents the output of a create repository operation.
- Create
Unreferenced Merge Commit Input - Create
Unreferenced Merge Commit Output - Delete
Approval Rule Template Input - Delete
Approval Rule Template Output - Delete
Branch Input Represents the input of a delete branch operation.
- Delete
Branch Output Represents the output of a delete branch operation.
- Delete
Comment Content Input - Delete
Comment Content Output - Delete
File Entry A file that is deleted as part of a commit.
- Delete
File Input - Delete
File Output - Delete
Pull Request Approval Rule Input - Delete
Pull Request Approval Rule Output - Delete
Repository Input Represents the input of a delete repository operation.
- Delete
Repository Output Represents the output of a delete repository operation.
- Describe
Merge Conflicts Input - Describe
Merge Conflicts Output - Describe
Pull Request Events Input - Describe
Pull Request Events Output - Difference
Returns information about a set of differences for a commit specifier.
- Disassociate
Approval Rule Template From Repository Input - Evaluate
Pull Request Approval Rules Input - Evaluate
Pull Request Approval Rules Output - Evaluation
Returns information about the approval rules applied to a pull request and whether conditions have been met.
- File
Returns information about a file in a repository.
- File
Metadata A file to be added, updated, or deleted as part of a commit.
- File
Modes Information about file modes in a merge or pull request.
- File
Sizes Information about the size of files in a merge or pull request.
- Folder
Returns information about a folder in a repository.
- GetApproval
Rule Template Input - GetApproval
Rule Template Output - GetBlob
Input Represents the input of a get blob operation.
- GetBlob
Output Represents the output of a get blob operation.
- GetBranch
Input Represents the input of a get branch operation.
- GetBranch
Output Represents the output of a get branch operation.
- GetComment
Input - GetComment
Output - GetComment
Reactions Input - GetComment
Reactions Output - GetComments
ForCompared Commit Input - GetComments
ForCompared Commit Output - GetComments
ForPull Request Input - GetComments
ForPull Request Output - GetCommit
Input Represents the input of a get commit operation.
- GetCommit
Output Represents the output of a get commit operation.
- GetDifferences
Input - GetDifferences
Output - GetFile
Input - GetFile
Output - GetFolder
Input - GetFolder
Output - GetMerge
Commit Input - GetMerge
Commit Output - GetMerge
Conflicts Input - GetMerge
Conflicts Output - GetMerge
Options Input - GetMerge
Options Output - GetPull
Request Approval States Input - GetPull
Request Approval States Output - GetPull
Request Input - GetPull
Request Output - GetPull
Request Override State Input - GetPull
Request Override State Output - GetRepository
Input Represents the input of a get repository operation.
- GetRepository
Output Represents the output of a get repository operation.
- GetRepository
Triggers Input Represents the input of a get repository triggers operation.
- GetRepository
Triggers Output Represents the output of a get repository triggers operation.
- IsBinary
File Information about whether a file is binary or textual in a merge or pull request operation.
- List
Approval Rule Templates Input - List
Approval Rule Templates Output - List
Associated Approval Rule Templates ForRepository Input - List
Associated Approval Rule Templates ForRepository Output - List
Branches Input Represents the input of a list branches operation.
- List
Branches Output Represents the output of a list branches operation.
- List
Pull Requests Input - List
Pull Requests Output - List
Repositories ForApproval Rule Template Input - List
Repositories ForApproval Rule Template Output - List
Repositories Input Represents the input of a list repositories operation.
- List
Repositories Output Represents the output of a list repositories operation.
- List
Tags ForResource Input - List
Tags ForResource Output - Location
Returns information about the location of a change or comment in the comparison between two commits or a pull request.
- Merge
Branches ByFast Forward Input - Merge
Branches ByFast Forward Output - Merge
Branches BySquash Input - Merge
Branches BySquash Output - Merge
Branches ByThree WayInput - Merge
Branches ByThree WayOutput - Merge
Hunk Information about merge hunks in a merge or pull request operation.
- Merge
Hunk Detail Information about the details of a merge hunk that contains a conflict in a merge or pull request operation.
- Merge
Metadata Returns information about a merge or potential merge between a source reference and a destination reference in a pull request.
- Merge
Operations Information about the file operation conflicts in a merge operation.
- Merge
Pull Request ByFast Forward Input - Merge
Pull Request ByFast Forward Output - Merge
Pull Request BySquash Input - Merge
Pull Request BySquash Output - Merge
Pull Request ByThree WayInput - Merge
Pull Request ByThree WayOutput - Object
Types Information about the type of an object in a merge operation.
- Origin
Approval Rule Template Returns information about the template that created the approval rule for a pull request.
- Override
Pull Request Approval Rules Input - Post
Comment ForCompared Commit Input - Post
Comment ForCompared Commit Output - Post
Comment ForPull Request Input - Post
Comment ForPull Request Output - Post
Comment Reply Input - Post
Comment Reply Output - Pull
Request Returns information about a pull request.
- Pull
Request Created Event Metadata Metadata about the pull request that is used when comparing the pull request source with its destination.
- Pull
Request Event Returns information about a pull request event.
- Pull
Request Merged State Changed Event Metadata Returns information about the change in the merge state for a pull request event.
- Pull
Request Source Reference Updated Event Metadata Information about an update to the source branch of a pull request.
- Pull
Request Status Changed Event Metadata Information about a change to the status of a pull request.
- Pull
Request Target Returns information about a pull request target.
- PutComment
Reaction Input - PutFile
Entry Information about a file added or updated as part of a commit.
- PutFile
Input - PutFile
Output - PutRepository
Triggers Input Represents the input of a put repository triggers operation.
- PutRepository
Triggers Output Represents the output of a put repository triggers operation.
- Reaction
ForComment Information about the reaction values provided by users on a comment.
- Reaction
Value Formats Information about the values for reactions to a comment. AWS CodeCommit supports a limited set of reactions.
- Replace
Content Entry Information about a replacement content entry in the conflict of a merge or pull request operation.
- Repository
Metadata Information about a repository.
- Repository
Name IdPair Information about a repository name and ID.
- Repository
Trigger Information about a trigger for a repository.
- Repository
Trigger Execution Failure A trigger failed to run.
- SetFile
Mode Entry Information about the file mode changes.
- Source
File Specifier Information about a source file that is part of changes made in a commit.
- SubModule
Returns information about a submodule reference in a repository folder.
- Symbolic
Link Returns information about a symbolic link in a repository folder.
- TagResource
Input - Target
Returns information about a target for a pull request.
- Test
Repository Triggers Input Represents the input of a test repository triggers operation.
- Test
Repository Triggers Output Represents the output of a test repository triggers operation.
- Untag
Resource Input - Update
Approval Rule Template Content Input - Update
Approval Rule Template Content Output - Update
Approval Rule Template Description Input - Update
Approval Rule Template Description Output - Update
Approval Rule Template Name Input - Update
Approval Rule Template Name Output - Update
Comment Input - Update
Comment Output - Update
Default Branch Input Represents the input of an update default branch operation.
- Update
Pull Request Approval Rule Content Input - Update
Pull Request Approval Rule Content Output - Update
Pull Request Approval State Input - Update
Pull Request Description Input - Update
Pull Request Description Output - Update
Pull Request Status Input - Update
Pull Request Status Output - Update
Pull Request Title Input - Update
Pull Request Title Output - Update
Repository Description Input Represents the input of an update repository description operation.
- Update
Repository Name Input Represents the input of an update repository description operation.
- User
Info Information about the user who made a specified commit.
Enums§
- Associate
Approval Rule Template With Repository Error - Errors returned by AssociateApprovalRuleTemplateWithRepository
- Batch
Associate Approval Rule Template With Repositories Error - Errors returned by BatchAssociateApprovalRuleTemplateWithRepositories
- Batch
Describe Merge Conflicts Error - Errors returned by BatchDescribeMergeConflicts
- Batch
Disassociate Approval Rule Template From Repositories Error - Errors returned by BatchDisassociateApprovalRuleTemplateFromRepositories
- Batch
GetCommits Error - Errors returned by BatchGetCommits
- Batch
GetRepositories Error - Errors returned by BatchGetRepositories
- Create
Approval Rule Template Error - Errors returned by CreateApprovalRuleTemplate
- Create
Branch Error - Errors returned by CreateBranch
- Create
Commit Error - Errors returned by CreateCommit
- Create
Pull Request Approval Rule Error - Errors returned by CreatePullRequestApprovalRule
- Create
Pull Request Error - Errors returned by CreatePullRequest
- Create
Repository Error - Errors returned by CreateRepository
- Create
Unreferenced Merge Commit Error - Errors returned by CreateUnreferencedMergeCommit
- Delete
Approval Rule Template Error - Errors returned by DeleteApprovalRuleTemplate
- Delete
Branch Error - Errors returned by DeleteBranch
- Delete
Comment Content Error - Errors returned by DeleteCommentContent
- Delete
File Error - Errors returned by DeleteFile
- Delete
Pull Request Approval Rule Error - Errors returned by DeletePullRequestApprovalRule
- Delete
Repository Error - Errors returned by DeleteRepository
- Describe
Merge Conflicts Error - Errors returned by DescribeMergeConflicts
- Describe
Pull Request Events Error - Errors returned by DescribePullRequestEvents
- Disassociate
Approval Rule Template From Repository Error - Errors returned by DisassociateApprovalRuleTemplateFromRepository
- Evaluate
Pull Request Approval Rules Error - Errors returned by EvaluatePullRequestApprovalRules
- GetApproval
Rule Template Error - Errors returned by GetApprovalRuleTemplate
- GetBlob
Error - Errors returned by GetBlob
- GetBranch
Error - Errors returned by GetBranch
- GetComment
Error - Errors returned by GetComment
- GetComment
Reactions Error - Errors returned by GetCommentReactions
- GetComments
ForCompared Commit Error - Errors returned by GetCommentsForComparedCommit
- GetComments
ForPull Request Error - Errors returned by GetCommentsForPullRequest
- GetCommit
Error - Errors returned by GetCommit
- GetDifferences
Error - Errors returned by GetDifferences
- GetFile
Error - Errors returned by GetFile
- GetFolder
Error - Errors returned by GetFolder
- GetMerge
Commit Error - Errors returned by GetMergeCommit
- GetMerge
Conflicts Error - Errors returned by GetMergeConflicts
- GetMerge
Options Error - Errors returned by GetMergeOptions
- GetPull
Request Approval States Error - Errors returned by GetPullRequestApprovalStates
- GetPull
Request Error - Errors returned by GetPullRequest
- GetPull
Request Override State Error - Errors returned by GetPullRequestOverrideState
- GetRepository
Error - Errors returned by GetRepository
- GetRepository
Triggers Error - Errors returned by GetRepositoryTriggers
- List
Approval Rule Templates Error - Errors returned by ListApprovalRuleTemplates
- List
Associated Approval Rule Templates ForRepository Error - Errors returned by ListAssociatedApprovalRuleTemplatesForRepository
- List
Branches Error - Errors returned by ListBranches
- List
Pull Requests Error - Errors returned by ListPullRequests
- List
Repositories Error - Errors returned by ListRepositories
- List
Repositories ForApproval Rule Template Error - Errors returned by ListRepositoriesForApprovalRuleTemplate
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- Merge
Branches ByFast Forward Error - Errors returned by MergeBranchesByFastForward
- Merge
Branches BySquash Error - Errors returned by MergeBranchesBySquash
- Merge
Branches ByThree WayError - Errors returned by MergeBranchesByThreeWay
- Merge
Pull Request ByFast Forward Error - Errors returned by MergePullRequestByFastForward
- Merge
Pull Request BySquash Error - Errors returned by MergePullRequestBySquash
- Merge
Pull Request ByThree WayError - Errors returned by MergePullRequestByThreeWay
- Override
Pull Request Approval Rules Error - Errors returned by OverridePullRequestApprovalRules
- Post
Comment ForCompared Commit Error - Errors returned by PostCommentForComparedCommit
- Post
Comment ForPull Request Error - Errors returned by PostCommentForPullRequest
- Post
Comment Reply Error - Errors returned by PostCommentReply
- PutComment
Reaction Error - Errors returned by PutCommentReaction
- PutFile
Error - Errors returned by PutFile
- PutRepository
Triggers Error - Errors returned by PutRepositoryTriggers
- TagResource
Error - Errors returned by TagResource
- Test
Repository Triggers Error - Errors returned by TestRepositoryTriggers
- Untag
Resource Error - Errors returned by UntagResource
- Update
Approval Rule Template Content Error - Errors returned by UpdateApprovalRuleTemplateContent
- Update
Approval Rule Template Description Error - Errors returned by UpdateApprovalRuleTemplateDescription
- Update
Approval Rule Template Name Error - Errors returned by UpdateApprovalRuleTemplateName
- Update
Comment Error - Errors returned by UpdateComment
- Update
Default Branch Error - Errors returned by UpdateDefaultBranch
- Update
Pull Request Approval Rule Content Error - Errors returned by UpdatePullRequestApprovalRuleContent
- Update
Pull Request Approval State Error - Errors returned by UpdatePullRequestApprovalState
- Update
Pull Request Description Error - Errors returned by UpdatePullRequestDescription
- Update
Pull Request Status Error - Errors returned by UpdatePullRequestStatus
- Update
Pull Request Title Error - Errors returned by UpdatePullRequestTitle
- Update
Repository Description Error - Errors returned by UpdateRepositoryDescription
- Update
Repository Name Error - Errors returned by UpdateRepositoryName
Traits§
- Code
Commit - Trait representing the capabilities of the CodeCommit API. CodeCommit clients implement this trait.