AWS SDK Version 2 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.

.NET Framework 3.5
 
 
Implementation for accessing CodeCommit AWS CodeCommit

This is the AWS CodeCommit API Reference. This reference provides descriptions of the AWS CodeCommit API.

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

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.CodeCommit.AmazonCodeCommitClient

Namespace: Amazon.CodeCommit
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C# 
public class AmazonCodeCommitClient : AmazonServiceClient
         IAmazonCodeCommit, IDisposable

The AmazonCodeCommitClient type exposes the following members

Constructors

NameDescription
Public Method AmazonCodeCommitClient() Constructs AmazonCodeCommitClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
Public Method AmazonCodeCommitClient(RegionEndpoint) Constructs AmazonCodeCommitClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
Public Method AmazonCodeCommitClient(AmazonCodeCommitConfig) Constructs AmazonCodeCommitClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
Public Method AmazonCodeCommitClient(AWSCredentials) Constructs AmazonCodeCommitClient with AWS Credentials
Public Method AmazonCodeCommitClient(AWSCredentials, RegionEndpoint) Constructs AmazonCodeCommitClient with AWS Credentials
Public Method AmazonCodeCommitClient(AWSCredentials, AmazonCodeCommitConfig) Constructs AmazonCodeCommitClient with AWS Credentials and an AmazonCodeCommitClient Configuration object.
Public Method AmazonCodeCommitClient(string, string) Constructs AmazonCodeCommitClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonCodeCommitClient(string, string, RegionEndpoint) Constructs AmazonCodeCommitClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonCodeCommitClient(string, string, AmazonCodeCommitConfig) Constructs AmazonCodeCommitClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeCommitClient Configuration object.
Public Method AmazonCodeCommitClient(string, string, string) Constructs AmazonCodeCommitClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonCodeCommitClient(string, string, string, RegionEndpoint) Constructs AmazonCodeCommitClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonCodeCommitClient(string, string, string, AmazonCodeCommitConfig) Constructs AmazonCodeCommitClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeCommitClient Configuration object.

Methods

NameDescription
Public Method BatchGetRepositories(BatchGetRepositoriesRequest) Gets 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 BeginBatchGetRepositories(BatchGetRepositoriesRequest, AsyncCallback, object) Initiates the asynchronous execution of the BatchGetRepositories operation.
Public Method BeginCreateBranch(CreateBranchRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateBranch operation.
Public Method BeginCreateRepository(CreateRepositoryRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateRepository operation.
Public Method BeginDeleteRepository(DeleteRepositoryRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteRepository operation.
Public Method BeginGetBranch(GetBranchRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetBranch operation.
Public Method BeginGetRepository(GetRepositoryRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetRepository operation.
Public Method BeginListBranches(ListBranchesRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListBranches operation.
Public Method BeginListRepositories(ListRepositoriesRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListRepositories operation.
Public Method BeginUpdateDefaultBranch(UpdateDefaultBranchRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateDefaultBranch operation.
Public Method BeginUpdateRepositoryDescription(UpdateRepositoryDescriptionRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateRepositoryDescription operation.
Public Method BeginUpdateRepositoryName(UpdateRepositoryNameRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateRepositoryName 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 CreateRepository(CreateRepositoryRequest) Creates a new, empty repository.
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 Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method EndBatchGetRepositories(IAsyncResult) Finishes the asynchronous execution of the BatchGetRepositories operation.
Public Method EndCreateBranch(IAsyncResult) Finishes the asynchronous execution of the CreateBranch operation.
Public Method EndCreateRepository(IAsyncResult) Finishes the asynchronous execution of the CreateRepository operation.
Public Method EndDeleteRepository(IAsyncResult) Finishes the asynchronous execution of the DeleteRepository operation.
Public Method EndGetBranch(IAsyncResult) Finishes the asynchronous execution of the GetBranch operation.
Public Method EndGetRepository(IAsyncResult) Finishes the asynchronous execution of the GetRepository operation.
Public Method EndListBranches(IAsyncResult) Finishes the asynchronous execution of the ListBranches operation.
Public Method EndListRepositories(IAsyncResult) Finishes the asynchronous execution of the ListRepositories operation.
Public Method EndUpdateDefaultBranch(IAsyncResult) Finishes the asynchronous execution of the UpdateDefaultBranch operation.
Public Method EndUpdateRepositoryDescription(IAsyncResult) Finishes the asynchronous execution of the UpdateRepositoryDescription operation.
Public Method EndUpdateRepositoryName(IAsyncResult) Finishes the asynchronous execution of the UpdateRepositoryName operation.
Public Method GetBranch(GetBranchRequest) Retrieves information about a repository branch, including its name and the last commit ID.
Public Method GetRepository(GetRepositoryRequest) Gets 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 ListBranches(ListBranchesRequest) Gets information about one or more branches in a repository.
Public Method ListRepositories(ListRepositoriesRequest) Gets information about one or more repositories.
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 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 UpdateRepositoryName(UpdateRepositoryNameRequest) Renames a repository.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

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