AWS CodeCommit
CodeCommit
This is the CodeCommit API Reference. This reference provides descriptions of the operations and data types for CodeCommit API along with usage examples.
You can use the CodeCommit API to work with the following objects:
Repositories, by calling the following:
batch_get_repositories, which returns information about one or more repositories associated with your Amazon Web Services account.create_repository, which creates an CodeCommit repository.delete_repository, which deletes an CodeCommit repository.get_repository, which returns information about a specified repository.list_repositories, which lists all CodeCommit repositories associated with your Amazon Web Services account.update_repository_description, which sets or updates the description of the repository.update_repository_encryption_key, which updates the Key Management Service encryption key used to encrypt and decrypt a repository.update_repository_name, 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:
create_branch, which creates a branch in a specified repository.delete_branch, which deletes the specified branch in a repository unless it is the default branch.get_branch, which returns information about a specified branch.list_branches, which lists all branches for a specified repository.update_default_branch, which changes the default branch for a repository.Files, by calling the following:
delete_file, which deletes the content of a specified file from a specified branch.get_blob, which returns the base-64 encoded content of an individual Git blob object in a repository.get_file, which returns the base-64 encoded content of a specified file.get_folder, which returns the contents of a specified folder or directory.list_file_commit_history, which retrieves a list of commits and changes to a specified file.put_file, which adds or modifies a single file in a specified repository and branch.Commits, by calling the following:
batch_get_commits, which returns information about one or more commits in a repository.create_commit, which creates a commit for changes to a repository.get_commit, which returns information about a commit, including commit messages and author and committer information.get_differences, 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:
batch_describe_merge_conflicts, which returns information about conflicts in a merge between commits in a repository.create_unreferenced_merge_commit, which creates an unreferenced commit between two branches or commits for the purpose of comparing them and identifying any potential conflicts.describe_merge_conflicts, which returns information about merge conflicts between the base, source, and destination versions of a file in a potential merge.get_merge_commit, which returns information about the merge between a source and destination commit.get_merge_conflicts, which returns information about merge conflicts between the source and destination branch in a pull request.get_merge_options, which returns information about the available merge options between two branches or commit specifiers.merge_branches_by_fast_forward, which merges two branches using the fast-forward merge option.merge_branches_by_squash, which merges two branches using the squash merge option.merge_branches_by_three_way, which merges two branches using the three-way merge option.Pull requests, by calling the following:
create_pull_request, which creates a pull request in a specified repository.create_pull_request_approval_rule, which creates an approval rule for a specified pull request.delete_pull_request_approval_rule, which deletes an approval rule for a specified pull request.describe_pull_request_events, which returns information about one or more pull request events.evaluate_pull_request_approval_rules, which evaluates whether a pull request has met all the conditions specified in its associated approval rules.get_comments_for_pull_request, which returns information about comments on a specified pull request.get_pull_request, which returns information about a specified pull request.get_pull_request_approval_states, which returns information about the approval states for a specified pull request.get_pull_request_override_state, 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.list_pull_requests, which lists all pull requests for a repository.merge_pull_request_by_fast_forward, 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.merge_pull_request_by_squash, which merges the source destination branch of a pull request into the specified destination branch for that pull request using the squash merge option.merge_pull_request_by_three_way, 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.override_pull_request_approval_rules, which sets aside all approval rule requirements for a pull request.post_comment_for_pull_request, which posts a comment to a pull request at the specified line, file, or request.update_pull_request_approval_rule_content, which updates the structure of an approval rule for a pull request.update_pull_request_approval_state, which updates the state of an approval on a pull request.update_pull_request_description, which updates the description of a pull request.update_pull_request_status, which updates the status of a pull request.update_pull_request_title, which updates the title of a pull request.Approval rule templates, by calling the following:
associate_approval_rule_template_with_repository, which associates a template with a specified repository. After the template is associated with a repository, CodeCommit creates approval rules that match the template conditions on every pull request created in the specified repository.batch_associate_approval_rule_template_with_repositories, which associates a template with one or more specified repositories. After the template is associated with a repository, CodeCommit creates approval rules that match the template conditions on every pull request created in the specified repositories.batch_disassociate_approval_rule_template_from_repositories, 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.create_approval_rule_template, which creates a template for approval rules that can then be associated with one or more repositories in your Amazon Web Services account.delete_approval_rule_template, which deletes the specified template. It does not remove approval rules on pull requests already created with the template.disassociate_approval_rule_template_from_repository, 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.get_approval_rule_template, which returns information about an approval rule template.list_approval_rule_templates, which lists all approval rule templates in the Amazon Web Services Region in your Amazon Web Services account.list_associated_approval_rule_templates_for_repository, which lists all approval rule templates that are associated with a specified repository.list_repositories_for_approval_rule_template, which lists all repositories associated with the specified approval rule template.update_approval_rule_template_description, which updates the description of an approval rule template.update_approval_rule_template_name, which updates the name of an approval rule template.update_approval_rule_template_content, which updates the content of an approval rule template.Comments in a repository, by calling the following:
delete_comment_content, which deletes the content of a comment on a commit in a repository.get_comment, which returns information about a comment on a commit.get_comment_reactions, which returns information about emoji reactions to comments.get_comments_for_compared_commit, which returns information about comments on the comparison between two commit specifiers in a repository.post_comment_for_compared_commit, which creates a comment on the comparison between two commit specifiers in a repository.post_comment_reply, which creates a reply to a comment.put_comment_reaction, which creates or updates an emoji reaction to a comment.update_comment, which updates the content of a comment on a commit in a repository.Tags used to tag resources in CodeCommit (not Git tags), by calling the following:
list_tags_for_resource, which gets information about Amazon Web Servicestags for a specified Amazon Resource Name (ARN) in CodeCommit.tag_resource, which adds or updates tags for a resource in CodeCommit.untag_resource, which removes tags for a resource in CodeCommit.Triggers, by calling the following:
get_repository_triggers, which returns information about triggers configured for a repository.put_repository_triggers, which replaces all triggers for a repository and can be used to create or delete triggers.test_repository_triggers, which tests the functionality of a repository trigger by sending data to the trigger target.For information about how to use CodeCommit, see the CodeCommit User Guide.
codecommit( config = list(), credentials = list(), endpoint = NULL, region = NULL )
config: Optional configuration of credentials, endpoint, and/or region.
credentials :
creds :
profile : The name of a profile to use. If not given, then the default profile is used.
anonymous : Set anonymous credentials.
endpoint : The complete URL to use for the constructed client.
region : The AWS Region used in instantiating the client.
close_connection : Immediately close all HTTP connections.
timeout : The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style : Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials: Optional credentials shorthand for the config parameter
creds :
profile : The name of a profile to use. If not given, then the default profile is used.
anonymous : Set anonymous credentials.
endpoint: Optional shorthand for complete URL to use for the constructed client.
region: Optional shorthand for AWS Region used in instantiating the client.
A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.
CodeCommit
This is the CodeCommit API Reference. This reference provides descriptions of the operations and data types for CodeCommit API along with usage examples.
You can use the CodeCommit API to work with the following objects:
Repositories, by calling the following:
batch_get_repositories, which returns information about one or more repositories associated with your Amazon Web Services account.create_repository, which creates an CodeCommit repository.delete_repository, which deletes an CodeCommit repository.get_repository, which returns information about a specified repository.list_repositories, which lists all CodeCommit repositories associated with your Amazon Web Services account.update_repository_description, which sets or updates the description of the repository.update_repository_encryption_key, which updates the Key Management Service encryption key used to encrypt and decrypt a repository.update_repository_name, 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:
create_branch, which creates a branch in a specified repository.delete_branch, which deletes the specified branch in a repository unless it is the default branch.get_branch, which returns information about a specified branch.list_branches, which lists all branches for a specified repository.update_default_branch, which changes the default branch for a repository.Files, by calling the following:
delete_file, which deletes the content of a specified file from a specified branch.get_blob, which returns the base-64 encoded content of an individual Git blob object in a repository.get_file, which returns the base-64 encoded content of a specified file.get_folder, which returns the contents of a specified folder or directory.list_file_commit_history, which retrieves a list of commits and changes to a specified file.put_file, which adds or modifies a single file in a specified repository and branch.Commits, by calling the following:
batch_get_commits, which returns information about one or more commits in a repository.create_commit, which creates a commit for changes to a repository.get_commit, which returns information about a commit, including commit messages and author and committer information.get_differences, 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:
batch_describe_merge_conflicts, which returns information about conflicts in a merge between commits in a repository.create_unreferenced_merge_commit, which creates an unreferenced commit between two branches or commits for the purpose of comparing them and identifying any potential conflicts.describe_merge_conflicts, which returns information about merge conflicts between the base, source, and destination versions of a file in a potential merge.get_merge_commit, which returns information about the merge between a source and destination commit.get_merge_conflicts, which returns information about merge conflicts between the source and destination branch in a pull request.get_merge_options, which returns information about the available merge options between two branches or commit specifiers.merge_branches_by_fast_forward, which merges two branches using the fast-forward merge option.merge_branches_by_squash, which merges two branches using the squash merge option.merge_branches_by_three_way, which merges two branches using the three-way merge option.Pull requests, by calling the following:
create_pull_request, which creates a pull request in a specified repository.create_pull_request_approval_rule, which creates an approval rule for a specified pull request.delete_pull_request_approval_rule, which deletes an approval rule for a specified pull request.describe_pull_request_events, which returns information about one or more pull request events.evaluate_pull_request_approval_rules, which evaluates whether a pull request has met all the conditions specified in its associated approval rules.get_comments_for_pull_request, which returns information about comments on a specified pull request.get_pull_request, which returns information about a specified pull request.get_pull_request_approval_states, which returns information about the approval states for a specified pull request.get_pull_request_override_state, 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.list_pull_requests, which lists all pull requests for a repository.merge_pull_request_by_fast_forward, 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.merge_pull_request_by_squash, which merges the source destination branch of a pull request into the specified destination branch for that pull request using the squash merge option.merge_pull_request_by_three_way, 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.override_pull_request_approval_rules, which sets aside all approval rule requirements for a pull request.post_comment_for_pull_request, which posts a comment to a pull request at the specified line, file, or request.update_pull_request_approval_rule_content, which updates the structure of an approval rule for a pull request.update_pull_request_approval_state, which updates the state of an approval on a pull request.update_pull_request_description, which updates the description of a pull request.update_pull_request_status, which updates the status of a pull request.update_pull_request_title, which updates the title of a pull request.Approval rule templates, by calling the following:
associate_approval_rule_template_with_repository, which associates a template with a specified repository. After the template is associated with a repository, CodeCommit creates approval rules that match the template conditions on every pull request created in the specified repository.batch_associate_approval_rule_template_with_repositories, which associates a template with one or more specified repositories. After the template is associated with a repository, CodeCommit creates approval rules that match the template conditions on every pull request created in the specified repositories.batch_disassociate_approval_rule_template_from_repositories, 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.create_approval_rule_template, which creates a template for approval rules that can then be associated with one or more repositories in your Amazon Web Services account.delete_approval_rule_template, which deletes the specified template. It does not remove approval rules on pull requests already created with the template.disassociate_approval_rule_template_from_repository, 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.get_approval_rule_template, which returns information about an approval rule template.list_approval_rule_templates, which lists all approval rule templates in the Amazon Web Services Region in your Amazon Web Services account.list_associated_approval_rule_templates_for_repository, which lists all approval rule templates that are associated with a specified repository.list_repositories_for_approval_rule_template, which lists all repositories associated with the specified approval rule template.update_approval_rule_template_description, which updates the description of an approval rule template.update_approval_rule_template_name, which updates the name of an approval rule template.update_approval_rule_template_content, which updates the content of an approval rule template.Comments in a repository, by calling the following:
delete_comment_content, which deletes the content of a comment on a commit in a repository.get_comment, which returns information about a comment on a commit.get_comment_reactions, which returns information about emoji reactions to comments.get_comments_for_compared_commit, which returns information about comments on the comparison between two commit specifiers in a repository.post_comment_for_compared_commit, which creates a comment on the comparison between two commit specifiers in a repository.post_comment_reply, which creates a reply to a comment.put_comment_reaction, which creates or updates an emoji reaction to a comment.update_comment, which updates the content of a comment on a commit in a repository.Tags used to tag resources in CodeCommit (not Git tags), by calling the following:
list_tags_for_resource, which gets information about Amazon Web Servicestags for a specified Amazon Resource Name (ARN) in CodeCommit.tag_resource, which adds or updates tags for a resource in CodeCommit.untag_resource, which removes tags for a resource in CodeCommit.Triggers, by calling the following:
get_repository_triggers, which returns information about triggers configured for a repository.put_repository_triggers, which replaces all triggers for a repository and can be used to create or delete triggers.test_repository_triggers, which tests the functionality of a repository trigger by sending data to the trigger target.For information about how to use CodeCommit, see the CodeCommit User Guide.
svc <- codecommit(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| associate_approval_rule_template_with_repository | Creates an association between an approval rule template and a specified repository |
| batch_associate_approval_rule_template_with_repositories | Creates an association between an approval rule template and one or more specified repositories |
| batch_describe_merge_conflicts | Returns information about one or more merge conflicts in the attempted merge of two commit specifiers using the squash or three-way merge strategy |
| batch_disassociate_approval_rule_template_from_repositories | Removes the association between an approval rule template and one or more specified repositories |
| batch_get_commits | Returns information about the contents of one or more commits in a repository |
| batch_get_repositories | Returns information about one or more repositories |
| create_approval_rule_template | Creates a template for approval rules that can then be associated with one or more repositories in your Amazon Web Services account |
| create_branch | Creates a branch in a repository and points the branch to a commit |
| create_commit | Creates a commit for a repository on the tip of a specified branch |
| create_pull_request | Creates a pull request in the specified repository |
| create_pull_request_approval_rule | Creates an approval rule for a pull request |
| create_repository | Creates a new, empty repository |
| create_unreferenced_merge_commit | Creates an unreferenced commit that represents the result of merging two branches using a specified merge strategy |
| delete_approval_rule_template | Deletes a specified approval rule template |
| delete_branch | Deletes a branch from a repository, unless that branch is the default branch for the repository |
| delete_comment_content | Deletes the content of a comment made on a change, file, or commit in a repository |
| delete_file | Deletes a specified file from a specified branch |
| delete_pull_request_approval_rule | Deletes an approval rule from a specified pull request |
| delete_repository | Deletes a repository |
| describe_merge_conflicts | Returns information about one or more merge conflicts in the attempted merge of two commit specifiers using the squash or three-way merge strategy |
| describe_pull_request_events | Returns information about one or more pull request events |
| disassociate_approval_rule_template_from_repository | 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 |
| evaluate_pull_request_approval_rules | Evaluates whether a pull request has met all the conditions specified in its associated approval rules |
| get_approval_rule_template | Returns information about a specified approval rule template |
| get_blob | Returns the base-64 encoded content of an individual blob in a repository |
| get_branch | Returns information about a repository branch, including its name and the last commit ID |
| get_comment | Returns the content of a comment made on a change, file, or commit in a repository |
| get_comment_reactions | Returns information about reactions to a specified comment ID |
| get_comments_for_compared_commit | Returns information about comments made on the comparison between two commits |
| get_comments_for_pull_request | Returns comments made on a pull request |
| get_commit | Returns information about a commit, including commit message and committer information |
| get_differences | Returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID, or other fully qualified reference) |
| get_file | Returns the base-64 encoded contents of a specified file and its metadata |
| get_folder | Returns the contents of a specified folder in a repository |
| get_merge_commit | Returns information about a specified merge commit |
| get_merge_conflicts | Returns information about merge conflicts between the before and after commit IDs for a pull request in a repository |
| get_merge_options | Returns information about the merge options available for merging two specified branches |
| get_pull_request | Gets information about a pull request in a specified repository |
| get_pull_request_approval_states | Gets information about the approval states for a specified pull request |
| get_pull_request_override_state | Returns information about whether approval rules have been set aside (overridden) 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 |
| get_repository | Returns information about a repository |
| get_repository_triggers | Gets information about triggers configured for a repository |
| list_approval_rule_templates | Lists all approval rule templates in the specified Amazon Web Services Region in your Amazon Web Services account |
| list_associated_approval_rule_templates_for_repository | Lists all approval rule templates that are associated with a specified repository |
| list_branches | Gets information about one or more branches in a repository |
| list_file_commit_history | Retrieves a list of commits and changes to a specified file |
| list_pull_requests | Returns a list of pull requests for a specified repository |
| list_repositories | Gets information about one or more repositories |
| list_repositories_for_approval_rule_template | Lists all repositories associated with the specified approval rule template |
| list_tags_for_resource | Gets information about Amazon Web Servicestags for a specified Amazon Resource Name (ARN) in CodeCommit |
| merge_branches_by_fast_forward | Merges two branches using the fast-forward merge strategy |
| merge_branches_by_squash | Merges two branches using the squash merge strategy |
| merge_branches_by_three_way | Merges two specified branches using the three-way merge strategy |
| merge_pull_request_by_fast_forward | 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 strategy |
| merge_pull_request_by_squash | 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 squash merge strategy |
| merge_pull_request_by_three_way | 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 three-way merge strategy |
| override_pull_request_approval_rules | Sets aside (overrides) all approval rule requirements for a specified pull request |
| post_comment_for_compared_commit | Posts a comment on the comparison between two commits |
| post_comment_for_pull_request | Posts a comment on a pull request |
| post_comment_reply | Posts a comment in reply to an existing comment on a comparison between commits or a pull request |
| put_comment_reaction | Adds or updates a reaction to a specified comment for the user whose identity is used to make the request |
| put_file | Adds or updates a file in a branch in an CodeCommit repository, and generates a commit for the addition in the specified branch |
| put_repository_triggers | Replaces all triggers for a repository |
| tag_resource | Adds or updates tags for a resource in CodeCommit |
| test_repository_triggers | Tests the functionality of repository triggers by sending information to the trigger target |
| untag_resource | Removes tags for a resource in CodeCommit |
| update_approval_rule_template_content | Updates the content of an approval rule template |
| update_approval_rule_template_description | Updates the description for a specified approval rule template |
| update_approval_rule_template_name | Updates the name of a specified approval rule template |
| update_comment | Replaces the contents of a comment |
| update_default_branch | Sets or changes the default branch name for the specified repository |
| update_pull_request_approval_rule_content | Updates the structure of an approval rule created specifically for a pull request |
| update_pull_request_approval_state | Updates the state of a user's approval on a pull request |
| update_pull_request_description | Replaces the contents of the description of a pull request |
| update_pull_request_status | Updates the status of a pull request |
| update_pull_request_title | Replaces the title of a pull request |
| update_repository_description | Sets or changes the comment or description for a repository |
| update_repository_encryption_key | Updates the Key Management Service encryption key used to encrypt and decrypt a CodeCommit repository |
| update_repository_name | Renames a repository |
## Not run: svc <- codecommit() svc$associate_approval_rule_template_with_repository( Foo = 123 ) ## End(Not run)
Useful links