AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing CodeCommit AWS CodeCommit

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:

Branches, by calling the following:

Files, by calling the following:

Information about committed code in a repository, by calling the following:

Pull requests, by calling the following:

Information about comments in a repository, by calling the following:

Triggers, by calling the following:

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

Inheritance Hierarchy

Amazon.CodeCommit.IAmazonCodeCommit

Namespace: Amazon.CodeCommit
Assembly: AWSSDK.CodeCommit.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonCodeCommit
         IAmazonService, IDisposable

The IAmazonCodeCommit type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method BatchGetRepositories(BatchGetRepositoriesRequest)

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.

Public Method BatchGetRepositoriesAsync(BatchGetRepositoriesRequest, CancellationToken)

Initiates the asynchronous execution of the BatchGetRepositories operation.

Public Method CreateBranch(CreateBranchRequest)

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.

Public Method CreateBranchAsync(CreateBranchRequest, CancellationToken)

Initiates the asynchronous execution of the CreateBranch operation.

Public Method CreatePullRequest(CreatePullRequestRequest)

Creates a pull request in the specified repository.

Public Method CreatePullRequestAsync(CreatePullRequestRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePullRequest operation.

Public Method CreateRepository(CreateRepositoryRequest)

Creates a new, empty repository.

Public Method CreateRepositoryAsync(CreateRepositoryRequest, CancellationToken)

Initiates the asynchronous execution of the CreateRepository operation.

Public Method DeleteBranch(DeleteBranchRequest)

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

Public Method DeleteBranchAsync(DeleteBranchRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteBranch operation.

Public Method DeleteCommentContent(DeleteCommentContentRequest)

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

Public Method DeleteCommentContentAsync(DeleteCommentContentRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteCommentContent operation.

Public Method DeleteRepository(DeleteRepositoryRequest)

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.

Public Method DeleteRepositoryAsync(DeleteRepositoryRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteRepository operation.

Public Method DescribePullRequestEvents(DescribePullRequestEventsRequest)

Returns information about one or more pull request events.

Public Method DescribePullRequestEventsAsync(DescribePullRequestEventsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribePullRequestEvents operation.

Public Method GetBlob(GetBlobRequest)

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

Public Method GetBlobAsync(GetBlobRequest, CancellationToken)

Initiates the asynchronous execution of the GetBlob operation.

Public Method GetBranch(GetBranchRequest)

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

Public Method GetBranchAsync(GetBranchRequest, CancellationToken)

Initiates the asynchronous execution of the GetBranch operation.

Public Method GetComment(GetCommentRequest)

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

Public Method GetCommentAsync(GetCommentRequest, CancellationToken)

Initiates the asynchronous execution of the GetComment operation.

Public Method GetCommentsForComparedCommit(GetCommentsForComparedCommitRequest)

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

Public Method GetCommentsForComparedCommitAsync(GetCommentsForComparedCommitRequest, CancellationToken)

Initiates the asynchronous execution of the GetCommentsForComparedCommit operation.

Public Method GetCommentsForPullRequest(GetCommentsForPullRequestRequest)

Returns comments made on a pull request.

Public Method GetCommentsForPullRequestAsync(GetCommentsForPullRequestRequest, CancellationToken)

Initiates the asynchronous execution of the GetCommentsForPullRequest operation.

Public Method GetCommit(GetCommitRequest)

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

Public Method GetCommitAsync(GetCommitRequest, CancellationToken)

Initiates the asynchronous execution of the GetCommit operation.

Public Method GetDifferences(GetDifferencesRequest)

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.

Public Method GetDifferencesAsync(GetDifferencesRequest, CancellationToken)

Initiates the asynchronous execution of the GetDifferences operation.

Public Method GetMergeConflicts(GetMergeConflictsRequest)

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

Public Method GetMergeConflictsAsync(GetMergeConflictsRequest, CancellationToken)

Initiates the asynchronous execution of the GetMergeConflicts operation.

Public Method GetPullRequest(GetPullRequestRequest)

Gets information about a pull request in a specified repository.

Public Method GetPullRequestAsync(GetPullRequestRequest, CancellationToken)

Initiates the asynchronous execution of the GetPullRequest operation.

Public Method GetRepository(GetRepositoryRequest)

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.

Public Method GetRepositoryAsync(GetRepositoryRequest, CancellationToken)

Initiates the asynchronous execution of the GetRepository operation.

Public Method GetRepositoryTriggers(GetRepositoryTriggersRequest)

Gets information about triggers configured for a repository.

Public Method GetRepositoryTriggersAsync(GetRepositoryTriggersRequest, CancellationToken)

Initiates the asynchronous execution of the GetRepositoryTriggers operation.

Public Method ListBranches(ListBranchesRequest)

Gets information about one or more branches in a repository.

Public Method ListBranchesAsync(ListBranchesRequest, CancellationToken)

Initiates the asynchronous execution of the ListBranches operation.

Public Method ListPullRequests(ListPullRequestsRequest)

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.

Public Method ListPullRequestsAsync(ListPullRequestsRequest, CancellationToken)

Initiates the asynchronous execution of the ListPullRequests operation.

Public Method ListRepositories(ListRepositoriesRequest)

Gets information about one or more repositories.

Public Method ListRepositoriesAsync(ListRepositoriesRequest, CancellationToken)

Initiates the asynchronous execution of the ListRepositories operation.

Public Method MergePullRequestByFastForward(MergePullRequestByFastForwardRequest)

Closes a pull request and 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 option.

Public Method MergePullRequestByFastForwardAsync(MergePullRequestByFastForwardRequest, CancellationToken)

Initiates the asynchronous execution of the MergePullRequestByFastForward operation.

Public Method PostCommentForComparedCommit(PostCommentForComparedCommitRequest)

Posts a comment on the comparison between two commits.

Public Method PostCommentForComparedCommitAsync(PostCommentForComparedCommitRequest, CancellationToken)

Initiates the asynchronous execution of the PostCommentForComparedCommit operation.

Public Method PostCommentForPullRequest(PostCommentForPullRequestRequest)

Posts a comment on a pull request.

Public Method PostCommentForPullRequestAsync(PostCommentForPullRequestRequest, CancellationToken)

Initiates the asynchronous execution of the PostCommentForPullRequest operation.

Public Method PostCommentReply(PostCommentReplyRequest)

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

Public Method PostCommentReplyAsync(PostCommentReplyRequest, CancellationToken)

Initiates the asynchronous execution of the PostCommentReply operation.

Public Method PutFile(PutFileRequest)

Adds or updates a file in an AWS CodeCommit repository.

Public Method PutFileAsync(PutFileRequest, CancellationToken)

Initiates the asynchronous execution of the PutFile operation.

Public Method PutRepositoryTriggers(PutRepositoryTriggersRequest)

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

Public Method PutRepositoryTriggersAsync(PutRepositoryTriggersRequest, CancellationToken)

Initiates the asynchronous execution of the PutRepositoryTriggers operation.

Public Method TestRepositoryTriggers(TestRepositoryTriggersRequest)

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.

Public Method TestRepositoryTriggersAsync(TestRepositoryTriggersRequest, CancellationToken)

Initiates the asynchronous execution of the TestRepositoryTriggers operation.

Public Method UpdateComment(UpdateCommentRequest)

Replaces the contents of a comment.

Public Method UpdateCommentAsync(UpdateCommentRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateComment operation.

Public Method UpdateDefaultBranch(UpdateDefaultBranchRequest)

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.

Public Method UpdateDefaultBranchAsync(UpdateDefaultBranchRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDefaultBranch operation.

Public Method UpdatePullRequestDescription(UpdatePullRequestDescriptionRequest)

Replaces the contents of the description of a pull request.

Public Method UpdatePullRequestDescriptionAsync(UpdatePullRequestDescriptionRequest, CancellationToken)

Initiates the asynchronous execution of the UpdatePullRequestDescription operation.

Public Method UpdatePullRequestStatus(UpdatePullRequestStatusRequest)

Updates the status of a pull request.

Public Method UpdatePullRequestStatusAsync(UpdatePullRequestStatusRequest, CancellationToken)

Initiates the asynchronous execution of the UpdatePullRequestStatus operation.

Public Method UpdatePullRequestTitle(UpdatePullRequestTitleRequest)

Replaces the title of a pull request.

Public Method UpdatePullRequestTitleAsync(UpdatePullRequestTitleRequest, CancellationToken)

Initiates the asynchronous execution of the UpdatePullRequestTitle operation.

Public Method UpdateRepositoryDescription(UpdateRepositoryDescriptionRequest)

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.

Public Method UpdateRepositoryDescriptionAsync(UpdateRepositoryDescriptionRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateRepositoryDescription operation.

Public Method UpdateRepositoryName(UpdateRepositoryNameRequest)

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.

Public Method UpdateRepositoryNameAsync(UpdateRepositoryNameRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateRepositoryName operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms