@aws-sdk/client-codecommit-browser

Description

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:

• 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 will be able to access it until you send them the new HTTPS or SSH URL to use.

Branches, by calling the following:

• CreateBranch, which creates a new 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 within 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:

• 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.

• DescribePullRequestEvents, which returns information about one or more pull request events.

• GetCommentsForPullRequest, which returns information about comments on a specified pull request.

• GetPullRequest, which returns information about a specified 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.

• PostCommentForPullRequest, which posts a comment to a pull request at the specified line, file, or 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.

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.

• 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.

• 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.

Installing

To install the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-codecommit-browser

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(CodeCommitClient) and the commands you need, for example BatchDescribeMergeConflictsCommand:

//JavaScript
const {
  CodeCommitClient
} = require("@aws-sdk/client-codecommit-browser/CodeCommitClient");
const {
  BatchDescribeMergeConflictsCommand
} = require("@aws-sdk/client-codecommit-browser/commands/BatchDescribeMergeConflictsCommand");

//TypeScript
import { CodeCommitClient } from "@aws-sdk/client-codecommit-browser/CodeCommitClient";
import { BatchDescribeMergeConflictsCommand } from "@aws-sdk/client-codecommit-browser/commands/BatchDescribeMergeConflictsCommand";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

const codeCommit = new CodeCommitClient({region: 'region'});
//clients can be shared by different commands
const params = {
  repositoryName: /**a string value*/,
  destinationCommitSpecifier: /**a string value*/,
  sourceCommitSpecifier: /**a string value*/,
  mergeOption: /**a string value*/,
};
const batchDescribeMergeConflictsCommand = new BatchDescribeMergeConflictsCommand(params);
codeCommit.send(batchDescribeMergeConflictsCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await codeCommit.send(batchDescribeMergeConflictsCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
codeCommit.send(batchDescribeMergeConflictsCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-codecommit-browser/CodeCommit";
const codeCommit = new AWS.CodeCommit({ region: "region" });
codeCommit.batchDescribeMergeConflicts(params, (err, data) => {
  //do something
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await codeCommit.send(batchDescribeMergeConflictsCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.extendedRequestId}`
  );
  /*
The keys within exceptions are also parsed. You can access them by specifying exception names:
    if(error.name === 'SomeServiceException') {
        const value = error.specialKeyInException;
    }
*/
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.

• Ask a question on StackOverflow and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-codecommit-browser' package is updated. To contribute to SDK you can checkout our code generator package.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.