baiji v0.6.11 Baiji.CodeCommit

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
  • `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
Information about committed code in a repository, by calling the following:
  • `GetBlob`, which returns the base-64 encoded content of an individual Git blob object within 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)
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](http://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html).

Link to this section Summary

Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Returns information about one or more repositories

Creates a new branch in a repository and points the branch to a commit

Creates a new, empty repository

Deletes a repository. If a specified repository was already deleted, a null repository ID will be returned

Returns the base-64 encoded content of an individual blob within a repository

Returns information about a repository branch, including its name and the last commit ID

Returns information about a commit, including commit message and committer information

Returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified reference). Results can be limited to a specified path

Returns information about a repository

Gets information about triggers configured for a repository

Gets information about one or more branches in a repository

Gets information about one or more repositories

Replaces all triggers for a repository. This can be used to create or delete triggers

Tests the functionality of repository triggers by sending information to the trigger target. If real data is available in the repository, the test will send data from the last commit. If no data is available, sample data will be generated

Sets or changes the default branch name for the specified repository

Sets or changes the comment or description for a repository

Renames a repository. The repository name must be unique across the calling AWS account. In addition, repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. The suffix “.git” is prohibited. For a full description of the limits on repository names, see Limits in the AWS CodeCommit User Guide

Link to this section Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Link to this function batch_get_repositories(input \\ %{}, options \\ [])

Returns 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.
Link to this function create_branch(input \\ %{}, options \\ [])

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.
Link to this function create_repository(input \\ %{}, options \\ [])

Creates a new, empty repository.

Link to this function delete_repository(input \\ %{}, options \\ [])

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.
Link to this function get_blob(input \\ %{}, options \\ [])

Returns the base-64 encoded content of an individual blob within a repository.

Link to this function get_branch(input \\ %{}, options \\ [])

Returns information about a repository branch, including its name and the last commit ID.

Link to this function get_commit(input \\ %{}, options \\ [])

Returns information about a commit, including commit message and committer information.

Link to this function get_differences(input \\ %{}, options \\ [])

Returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified reference). Results can be limited to a specified path.

Link to this function get_repository(input \\ %{}, options \\ [])

Returns 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.
Link to this function get_repository_triggers(input \\ %{}, options \\ [])

Gets information about triggers configured for a repository.

Link to this function list_branches(input \\ %{}, options \\ [])

Gets information about one or more branches in a repository.

Link to this function list_repositories(input \\ %{}, options \\ [])

Gets information about one or more repositories.

Link to this function put_repository_triggers(input \\ %{}, options \\ [])

Replaces all triggers for a repository. This can be used to create or delete triggers.

Link to this function test_repository_triggers(input \\ %{}, options \\ [])

Tests the functionality of repository triggers by sending information to the trigger target. If real data is available in the repository, the test will send data from the last commit. If no data is available, sample data will be generated.

Link to this function update_default_branch(input \\ %{}, options \\ [])

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.
Link to this function update_repository_description(input \\ %{}, options \\ [])

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.
Link to this function update_repository_name(input \\ %{}, options \\ [])

Renames a repository. The repository name must be unique across the calling AWS account. In addition, repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. The suffix “.git” is prohibited. For a full description of the limits on repository names, see Limits in the AWS CodeCommit User Guide.