codecommit: AWS CodeCommit

Description Usage Arguments Value Service syntax Operations Examples

View source: R/paws.R

Description

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:

Commits, by calling the following:

Merges, by calling the following:

Pull requests, by calling the following:

Approval rule templates, by calling the following:

Comments in a repository, by calling the following:

Tags used to tag resources in AWS CodeCommit (not Git tags), by calling the following:

Triggers, by calling the following:

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

Usage

1
codecommit(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

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.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- codecommit(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

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 AWS 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 AWS Region in your AWS 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_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 AWS tags for a specified Amazon Resource Name (ARN) in AWS 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 AWS 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 AWS 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 AWS 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_name Renames a repository

Examples

1
2
3
4
5
6
7
## Not run: 
svc <- codecommit()
svc$associate_approval_rule_template_with_repository(
  Foo = 123
)

## End(Not run)

paws documentation built on Sept. 5, 2021, 5:19 p.m.

Related to codecommit in paws...