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.

  • DeleteBranch, which deletes the specified branch in a repository unless it is the default branch.

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

Files, by calling the following:

  • DeleteFile, which deletes the content of a specified file from a specified branch.

  • GetFile, which returns the base-64 encoded content of a specified file.

  • GetFolder, which returns the contents of a specified folder or directory.

  • PutFile, which adds or modifies a file in a specified repository and branch.

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

Pull requests, by calling the following:

  • CreatePullRequest, which creates a pull request in a specified repository.

  • DescribePullRequestEvents, which returns information about one or more pull request events.

  • GetCommentsForPullRequest, which returns information about comments on a specified pull request.

  • GetMergeConflicts, which returns information about merge conflicts between the source and destination branch in a pull request.

  • GetPullRequest, which returns information about a specified pull request.

  • ListPullRequests, which lists all pull requests for a repository.

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

  • PostCommentForPullRequest, which posts a comment to a pull request at the specified line, file, or request.

  • UpdatePullRequestDescription, which updates the description of a pull request.

  • UpdatePullRequestStatus, which updates the status of a pull request.

  • UpdatePullRequestTitle, which updates the title of a pull request.

Information about comments in a repository, by calling the following:

  • DeleteCommentContent, which deletes the content of a comment on a commit in a repository.

  • GetComment, which returns information about a comment on a commit.

  • GetCommentsForComparedCommit, which returns information about comments on the comparison between two commit specifiers in a repository.

  • PostCommentForComparedCommit, which creates a comment on the comparison between two commit specifiers in a repository.

  • PostCommentReply, which creates a reply to a comment.

  • UpdateComment, which updates the content of a comment on a commit in a repository.

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

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codecommit-2015-04-13

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.

CreatePullRequest

Targets => ArrayRef[Paws::CodeCommit::Target]
Title => Str
[ClientRequestToken => Str]
[Description => Str]

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

Returns: a Paws::CodeCommit::CreatePullRequestOutput instance

Creates a pull request in the specified repository.

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.

DeleteBranch

BranchName => Str
RepositoryName => Str

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

Returns: a Paws::CodeCommit::DeleteBranchOutput instance

Deletes a branch from a repository, unless that branch is the default branch for the repository.

DeleteCommentContent

CommentId => Str

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

Returns: a Paws::CodeCommit::DeleteCommentContentOutput instance

Deletes the content of a comment made on a change, file, or commit in a repository.

DeleteFile

BranchName => Str
FilePath => Str
ParentCommitId => Str
RepositoryName => Str
[CommitMessage => Str]
[Email => Str]
[KeepEmptyFolders => Bool]
[Name => Str]

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

Returns: a Paws::CodeCommit::DeleteFileOutput instance

Deletes a specified file from a specified branch. A commit is created on the branch that contains the revision. The file will still exist in the commits prior to the commit that contains the deletion.

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.

DescribePullRequestEvents

PullRequestId => Str
[ActorArn => Str]
[MaxResults => Int]
[NextToken => Str]
[PullRequestEventType => Str]

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

Returns: a Paws::CodeCommit::DescribePullRequestEventsOutput instance

Returns information about one or more pull request events.

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.

GetComment

CommentId => Str

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

Returns: a Paws::CodeCommit::GetCommentOutput instance

Returns the content of a comment made on a change, file, or commit in a repository.

GetCommentsForComparedCommit

AfterCommitId => Str
RepositoryName => Str
[BeforeCommitId => Str]
[MaxResults => Int]
[NextToken => Str]

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

Returns: a Paws::CodeCommit::GetCommentsForComparedCommitOutput instance

Returns information about comments made on the comparison between two commits.

GetCommentsForPullRequest

PullRequestId => Str
[AfterCommitId => Str]
[BeforeCommitId => Str]
[MaxResults => Int]
[NextToken => Str]
[RepositoryName => Str]

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

Returns: a Paws::CodeCommit::GetCommentsForPullRequestOutput instance

Returns comments made on a pull request.

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.

GetFile

FilePath => Str
RepositoryName => Str
[CommitSpecifier => Str]

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

Returns: a Paws::CodeCommit::GetFileOutput instance

Returns the base-64 encoded contents of a specified file and its metadata.

GetFolder

FolderPath => Str
RepositoryName => Str
[CommitSpecifier => Str]

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

Returns: a Paws::CodeCommit::GetFolderOutput instance

Returns the contents of a specified folder in a repository.

GetMergeConflicts

DestinationCommitSpecifier => Str
MergeOption => Str
RepositoryName => Str
SourceCommitSpecifier => Str

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

Returns: a Paws::CodeCommit::GetMergeConflictsOutput instance

Returns information about merge conflicts between the before and after commit IDs for a pull request in a repository.

GetPullRequest

PullRequestId => Str

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

Returns: a Paws::CodeCommit::GetPullRequestOutput instance

Gets information about a pull request in a specified repository.

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.

ListPullRequests

RepositoryName => Str
[AuthorArn => Str]
[MaxResults => Int]
[NextToken => Str]
[PullRequestStatus => Str]

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

Returns: a Paws::CodeCommit::ListPullRequestsOutput instance

Returns a list of pull requests for a specified repository. The return list can be refined by pull request status or pull request author ARN.

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.

MergePullRequestByFastForward

PullRequestId => Str
RepositoryName => Str
[SourceCommitId => Str]

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

Returns: a Paws::CodeCommit::MergePullRequestByFastForwardOutput instance

Closes a pull request and 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 option.

PostCommentForComparedCommit

AfterCommitId => Str
Content => Str
RepositoryName => Str
[BeforeCommitId => Str]
[ClientRequestToken => Str]
[Location => Paws::CodeCommit::Location]

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

Returns: a Paws::CodeCommit::PostCommentForComparedCommitOutput instance

Posts a comment on the comparison between two commits.

PostCommentForPullRequest

AfterCommitId => Str
BeforeCommitId => Str
Content => Str
PullRequestId => Str
RepositoryName => Str
[ClientRequestToken => Str]
[Location => Paws::CodeCommit::Location]

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

Returns: a Paws::CodeCommit::PostCommentForPullRequestOutput instance

Posts a comment on a pull request.

PostCommentReply

Content => Str
InReplyTo => Str
[ClientRequestToken => Str]

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

Returns: a Paws::CodeCommit::PostCommentReplyOutput instance

Posts a comment in reply to an existing comment on a comparison between commits or a pull request.

PutFile

BranchName => Str
FileContent => Str
FilePath => Str
RepositoryName => Str
[CommitMessage => Str]
[Email => Str]
[FileMode => Str]
[Name => Str]
[ParentCommitId => Str]

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

Returns: a Paws::CodeCommit::PutFileOutput instance

Adds or updates a file in a branch in an AWS CodeCommit repository, and generates a commit for the addition in the specified branch.

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.

UpdateComment

CommentId => Str
Content => Str

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

Returns: a Paws::CodeCommit::UpdateCommentOutput instance

Replaces the contents of a comment.

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.

UpdatePullRequestDescription

Description => Str
PullRequestId => Str

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

Returns: a Paws::CodeCommit::UpdatePullRequestDescriptionOutput instance

Replaces the contents of the description of a pull request.

UpdatePullRequestStatus

PullRequestId => Str
PullRequestStatus => Str

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

Returns: a Paws::CodeCommit::UpdatePullRequestStatusOutput instance

Updates the status of a pull request.

UpdatePullRequestTitle

PullRequestId => Str
Title => Str

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

Returns: a Paws::CodeCommit::UpdatePullRequestTitleOutput instance

Replaces the title of a pull request.

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 (http://docs.aws.amazon.com/codecommit/latest/userguide/limits.html) in the AWS CodeCommit User Guide.

PAGINATORS

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

DescribeAllPullRequestEvents(sub { },PullRequestId => Str, [ActorArn => Str, MaxResults => Int, NextToken => Str, PullRequestEventType => Str])

DescribeAllPullRequestEvents(PullRequestId => Str, [ActorArn => Str, MaxResults => Int, NextToken => Str, PullRequestEventType => Str])

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

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

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

GetAllCommentsForComparedCommit(sub { },AfterCommitId => Str, RepositoryName => Str, [BeforeCommitId => Str, MaxResults => Int, NextToken => Str])

GetAllCommentsForComparedCommit(AfterCommitId => Str, RepositoryName => Str, [BeforeCommitId => Str, MaxResults => Int, NextToken => Str])

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

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

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

GetAllCommentsForPullRequest(sub { },PullRequestId => Str, [AfterCommitId => Str, BeforeCommitId => Str, MaxResults => Int, NextToken => Str, RepositoryName => Str])

GetAllCommentsForPullRequest(PullRequestId => Str, [AfterCommitId => Str, BeforeCommitId => Str, MaxResults => Int, NextToken => Str, RepositoryName => Str])

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

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

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

GetAllDifferences(sub { },AfterCommitSpecifier => Str, RepositoryName => Str, [AfterPath => Str, BeforeCommitSpecifier => Str, BeforePath => Str, MaxResults => Int, NextToken => Str])

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

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

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

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

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.

ListAllPullRequests(sub { },RepositoryName => Str, [AuthorArn => Str, MaxResults => Int, NextToken => Str, PullRequestStatus => Str])

ListAllPullRequests(RepositoryName => Str, [AuthorArn => Str, MaxResults => Int, NextToken => Str, PullRequestStatus => Str])

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

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

If not, it will return a a Paws::CodeCommit::ListPullRequestsOutput 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