The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Paws-0.31
River stage two • 9 direct dependents • 11 total dependents
57 ++
/ Paws::CodeCommit

NAME

Paws::CodeCommit - Perl Interface to AWS AWS CodeCommit

SYNOPSIS

  use Paws;

  my $obj = Paws->service('CodeCommit');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

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

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

METHODS

BatchGetRepositories(RepositoryNames => ArrayRef[Str|Undef])

Each argument is described in detail in: Paws::CodeCommit::BatchGetRepositories

Returns: a Paws::CodeCommit::BatchGetRepositoriesOutput instance

  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.

CreateBranch(BranchName => Str, CommitId => Str, RepositoryName => Str)

Each argument is described in detail in: Paws::CodeCommit::CreateBranch

Returns: nothing

  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.

CreateRepository(RepositoryName => Str, [RepositoryDescription => Str])

Each argument is described in detail in: Paws::CodeCommit::CreateRepository

Returns: a Paws::CodeCommit::CreateRepositoryOutput instance

  Creates a new, empty repository.

DeleteRepository(RepositoryName => Str)

Each argument is described in detail in: Paws::CodeCommit::DeleteRepository

Returns: a Paws::CodeCommit::DeleteRepositoryOutput instance

  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.

GetBlob(BlobId => Str, RepositoryName => Str)

Each argument is described in detail in: Paws::CodeCommit::GetBlob

Returns: a Paws::CodeCommit::GetBlobOutput instance

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

GetBranch([BranchName => Str, RepositoryName => Str])

Each argument is described in detail in: Paws::CodeCommit::GetBranch

Returns: a Paws::CodeCommit::GetBranchOutput instance

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

GetCommit(CommitId => Str, RepositoryName => Str)

Each argument is described in detail in: Paws::CodeCommit::GetCommit

Returns: a Paws::CodeCommit::GetCommitOutput instance

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

GetDifferences(AfterCommitSpecifier => Str, RepositoryName => Str, [AfterPath => Str, BeforeCommitSpecifier => Str, BeforePath => Str, MaxResults => Int, NextToken => Str])

Each argument is described in detail in: Paws::CodeCommit::GetDifferences

Returns: a Paws::CodeCommit::GetDifferencesOutput instance

  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.

GetRepository(RepositoryName => Str)

Each argument is described in detail in: Paws::CodeCommit::GetRepository

Returns: a Paws::CodeCommit::GetRepositoryOutput instance

  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.

GetRepositoryTriggers(RepositoryName => Str)

Each argument is described in detail in: Paws::CodeCommit::GetRepositoryTriggers

Returns: a Paws::CodeCommit::GetRepositoryTriggersOutput instance

  Gets information about triggers configured for a repository.

ListBranches(RepositoryName => Str, [NextToken => Str])

Each argument is described in detail in: Paws::CodeCommit::ListBranches

Returns: a Paws::CodeCommit::ListBranchesOutput instance

  Gets information about one or more branches in a repository.

ListRepositories([NextToken => Str, Order => Str, SortBy => Str])

Each argument is described in detail in: Paws::CodeCommit::ListRepositories

Returns: a Paws::CodeCommit::ListRepositoriesOutput instance

  Gets information about one or more repositories.

PutRepositoryTriggers(RepositoryName => Str, Triggers => ArrayRef[Paws::CodeCommit::RepositoryTrigger])

Each argument is described in detail in: Paws::CodeCommit::PutRepositoryTriggers

Returns: a Paws::CodeCommit::PutRepositoryTriggersOutput instance

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

TestRepositoryTriggers(RepositoryName => Str, Triggers => ArrayRef[Paws::CodeCommit::RepositoryTrigger])

Each argument is described in detail in: Paws::CodeCommit::TestRepositoryTriggers

Returns: a Paws::CodeCommit::TestRepositoryTriggersOutput instance

  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.

UpdateDefaultBranch(DefaultBranchName => Str, RepositoryName => Str)

Each argument is described in detail in: Paws::CodeCommit::UpdateDefaultBranch

Returns: nothing

  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.

UpdateRepositoryDescription(RepositoryName => Str, [RepositoryDescription => Str])

Each argument is described in detail in: Paws::CodeCommit::UpdateRepositoryDescription

Returns: nothing

  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.

UpdateRepositoryName(NewName => Str, OldName => Str)

Each argument is described in detail in: Paws::CodeCommit::UpdateRepositoryName

Returns: nothing

  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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllBranches(sub { },RepositoryName => Str, [NextToken => Str])

ListAllBranches(RepositoryName => Str, [NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - branches, passing the object as the first parameter, and the string 'branches' as the second parameter

If not, it will return a a Paws::CodeCommit::ListBranchesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllRepositories(sub { },[NextToken => Str, Order => Str, SortBy => Str])

ListAllRepositories([NextToken => Str, Order => Str, SortBy => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - repositories, passing the object as the first parameter, and the string 'repositories' as the second parameter

If not, it will return a a Paws::CodeCommit::ListRepositoriesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues