aws-codecommit
Manage AWS CodeCommit repositories
TLDR
Display help
Display help for a specific command
SYNOPSIS
aws codecommit
PARAMETERS
batch-associate-approval-rule-template-with-repositories
Associates an approval rule template with multiple repositories.
batch-describe-merge-conflicts
Returns information about conflicts in a merge operation.
batch-disassociate-approval-rule-template-from-repositories
Disassociates an approval rule template from multiple repositories.
create-approval-rule-template
Creates an approval rule template.
create-branch
Creates a branch in a repository.
create-commit
Creates a commit in a repository.
create-pull-request
Creates a pull request in a repository.
create-repository
Creates a CodeCommit repository.
create-unreferenced-merge-commit
Creates an unreferenced merge commit between two branches.
delete-approval-rule-template
Deletes an approval rule template.
delete-branch
Deletes a branch from a repository.
delete-comment-content
Deletes the content of a comment made on a pull request or commit.
delete-file
Deletes a specified file from a branch.
delete-pull-request-approval-rule
Deletes an approval rule from a pull request.
delete-repository
Deletes a CodeCommit repository.
describe-approval-rule-template
Returns information about an approval rule template.
describe-merge-conflicts
Returns information about merge conflicts.
describe-pull-request-events
Returns information about events related to a pull request.
describe-pull-request
Returns information about a specific pull request.
describe-repository
Returns information about a CodeCommit repository.
get-approval-rule-template
Returns the content of an approval rule template.
get-blob
Retrieves the content of a blob from a repository.
get-branch
Returns information about a branch.
get-comment
Returns information about a comment.
get-comment-reactions
Returns information about reactions to a comment.
get-comments-for-compared-commit
Returns comments for a comparison between two commits.
get-comments-for-pull-request
Returns comments for a pull request.
get-commit
Returns information about a commit.
get-differences
Returns differences between two commits.
get-file
Retrieves the content of a file from a repository.
get-folder
Retrieves metadata about a folder in a repository.
get-merge-commit
Returns information about a merge commit.
get-merge-conflicts
Returns information about conflicts in a merge operation.
get-merge-options
Returns the available merge options for a pull request.
get-pull-request
Returns information about a pull request.
get-pull-request-approval-states
Returns approval states for a pull request.
get-repository
Returns information about a repository.
get-repository-triggers
Returns triggers configured for a repository.
list-approval-rule-templates
Lists approval rule templates.
list-associated-approval-rule-templates-for-repository
Lists approval rule templates associated with a repository.
list-branches
Lists branches in a repository.
list-file-commit-history
Lists commit history for a file.
list-pull-requests
Lists pull requests in a repository.
list-repositories
Lists CodeCommit repositories.
list-repositories-for-approval-rule-template
Lists repositories associated with an approval rule template.
list-tags-for-resource
Lists tags for a CodeCommit resource.
merge-branches-by-fast-forward
Merges two branches using fast-forward.
merge-pull-request-by-fast-forward
Merges a pull request using fast-forward.
merge-pull-request-by-squash
Merges a pull request by squashing commits.
merge-pull-request-by-three-way
Merges a pull request using a three-way merge.
override-pull-request-approval-rules
Overrides approval rules for a pull request.
post-comment-for-compared-commit
Posts a comment for a comparison between two commits.
post-comment-for-pull-request
Posts a comment on a pull request.
post-comment-reply
Posts a reply to a comment.
put-comment-reaction
Adds a reaction to a comment.
put-file
Adds or updates a file in a branch.
put-repository-triggers
Configures triggers for a repository.
tag-resource
Adds tags to a CodeCommit resource.
test-repository-triggers
Tests repository triggers.
untag-resource
Removes tags from a CodeCommit resource.
update-approval-rule-template-content
Updates the content of an approval rule template.
update-approval-rule-template-description
Updates the description of an approval rule template.
update-approval-rule-template-name
Updates the name of an approval rule template.
update-comment
Updates the content of a comment.
update-default-branch
Updates the default branch for a repository.
update-pull-request-approval-rule-content
Updates the content of an approval rule.
update-pull-request-approval-state
Updates the approval state of a pull request.
update-pull-request-description
Updates the description of a pull request.
update-pull-request-status
Updates the status of a pull request.
update-pull-request-title
Updates the title of a pull request.
update-repository-description
Updates the description of a repository.
update-repository-name
Updates the name of a repository.
DESCRIPTION
The `aws codecommit` command is part of the AWS Command Line Interface (CLI) and provides a way to interact with the AWS CodeCommit service from the command line. It allows users to create, manage, and interact with CodeCommit repositories, branches, commits, and pull requests. Using `aws codecommit`, you can automate CodeCommit tasks, integrate them into your scripting workflows, and manage your source code repositories directly from your terminal. This tool simplifies tasks such as creating a new repository, pushing local code changes, listing branches, creating pull requests, and reviewing commit history. By offering a comprehensive set of commands, `aws codecommit` enables streamlined version control and collaboration workflows within the AWS ecosystem, integrating seamlessly with other AWS services and IAM for access control. The CLI removes the necessity to utilize the AWS console when you can perform the same operations directly via the command line. Furthermore, with correct configurations using IAM, it allows different levels of access to the repos.
CAVEATS
Requires AWS CLI to be configured with valid AWS credentials and region. IAM policies must grant appropriate permissions for CodeCommit actions.
CONFIGURATION
The AWS CLI must be configured correctly to use the `aws codecommit` command. This involves setting up AWS credentials (access key ID and secret access key) and the default AWS region. You can configure the AWS CLI using the `aws configure` command or by setting environment variables.
AUTHENTICATION
Authentication is handled by the AWS CLI using IAM roles or user credentials. Ensure that the IAM entity used to execute the `aws codecommit` command has the necessary permissions to perform the desired actions on CodeCommit resources. Example: To create a repository, the IAM user or role must have the `codecommit:CreateRepository` permission.
COMMON USE CASES
Common use cases include
- Automating repository creation and configuration.
- Integrating CodeCommit into CI/CD pipelines for automated builds and deployments.
- Managing branches and pull requests from the command line.
- Scripting tasks such as code reviews and approval workflows.
HISTORY
The `aws codecommit` command was introduced as part of the AWS CLI to provide a programmatic interface for managing CodeCommit repositories. Its development has been driven by the need to automate source code management tasks and integrate them into CI/CD pipelines. Since its introduction, it has been continuously updated with new features and capabilities to support the evolving needs of CodeCommit users, covering all aspects of repository, branch, pull request and approval management.
SEE ALSO
git(1)