codecommit/aws.sdk.kotlin.services.codecommit

Package-level declarations

Types

This is the CodeCommit API Reference. This reference provides descriptions of the operations and data types for CodeCommit API along with usage examples.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

associateApprovalRuleTemplateWithRepository

inline suspend fun CodeCommitClient.associateApprovalRuleTemplateWithRepository(crossinline block: AssociateApprovalRuleTemplateWithRepositoryRequest.Builder.() -> Unit): AssociateApprovalRuleTemplateWithRepositoryResponse

Creates an association between an approval rule template and a specified repository. Then, the next time a pull request is created in the repository where the destination reference (if specified) matches the destination reference (branch) for the pull request, an approval rule that matches the template conditions is automatically created for that pull request. If no destination references are specified in the template, an approval rule that matches the template contents is created for all pull requests in that repository.

batchAssociateApprovalRuleTemplateWithRepositories

inline suspend fun CodeCommitClient.batchAssociateApprovalRuleTemplateWithRepositories(crossinline block: BatchAssociateApprovalRuleTemplateWithRepositoriesRequest.Builder.() -> Unit): BatchAssociateApprovalRuleTemplateWithRepositoriesResponse

Creates an association between an approval rule template and one or more specified repositories.

batchDescribeMergeConflicts

inline suspend fun CodeCommitClient.batchDescribeMergeConflicts(crossinline block: BatchDescribeMergeConflictsRequest.Builder.() -> Unit): BatchDescribeMergeConflictsResponse

Returns information about one or more merge conflicts in the attempted merge of two commit specifiers using the squash or three-way merge strategy.

batchDisassociateApprovalRuleTemplateFromRepositories

inline suspend fun CodeCommitClient.batchDisassociateApprovalRuleTemplateFromRepositories(crossinline block: BatchDisassociateApprovalRuleTemplateFromRepositoriesRequest.Builder.() -> Unit): BatchDisassociateApprovalRuleTemplateFromRepositoriesResponse

Removes the association between an approval rule template and one or more specified repositories.

batchGetCommits

inline suspend fun CodeCommitClient.batchGetCommits(crossinline block: BatchGetCommitsRequest.Builder.() -> Unit): BatchGetCommitsResponse

Returns information about the contents of one or more commits in a repository.

batchGetRepositories

inline suspend fun CodeCommitClient.batchGetRepositories(crossinline block: BatchGetRepositoriesRequest.Builder.() -> Unit): BatchGetRepositoriesResponse

Returns information about one or more repositories.

createApprovalRuleTemplate

inline suspend fun CodeCommitClient.createApprovalRuleTemplate(crossinline block: CreateApprovalRuleTemplateRequest.Builder.() -> Unit): CreateApprovalRuleTemplateResponse

Creates a template for approval rules that can then be associated with one or more repositories in your Amazon Web Services account. When you associate a template with a repository, CodeCommit creates an approval rule that matches the conditions of the template for all pull requests that meet the conditions of the template. For more information, see AssociateApprovalRuleTemplateWithRepository.

createBranch

inline suspend fun CodeCommitClient.createBranch(crossinline block: CreateBranchRequest.Builder.() -> Unit): CreateBranchResponse

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

createCommit

inline suspend fun CodeCommitClient.createCommit(crossinline block: CreateCommitRequest.Builder.() -> Unit): CreateCommitResponse

Creates a commit for a repository on the tip of a specified branch.

createPullRequest

inline suspend fun CodeCommitClient.createPullRequest(crossinline block: CreatePullRequestRequest.Builder.() -> Unit): CreatePullRequestResponse

Creates a pull request in the specified repository.

createPullRequestApprovalRule

inline suspend fun CodeCommitClient.createPullRequestApprovalRule(crossinline block: CreatePullRequestApprovalRuleRequest.Builder.() -> Unit): CreatePullRequestApprovalRuleResponse

Creates an approval rule for a pull request.

createRepository

inline suspend fun CodeCommitClient.createRepository(crossinline block: CreateRepositoryRequest.Builder.() -> Unit): CreateRepositoryResponse

Creates a new, empty repository.

createUnreferencedMergeCommit

inline suspend fun CodeCommitClient.createUnreferencedMergeCommit(crossinline block: CreateUnreferencedMergeCommitRequest.Builder.() -> Unit): CreateUnreferencedMergeCommitResponse

Creates an unreferenced commit that represents the result of merging two branches using a specified merge strategy. This can help you determine the outcome of a potential merge. This API cannot be used with the fast-forward merge strategy because that strategy does not create a merge commit.

deleteApprovalRuleTemplate

inline suspend fun CodeCommitClient.deleteApprovalRuleTemplate(crossinline block: DeleteApprovalRuleTemplateRequest.Builder.() -> Unit): DeleteApprovalRuleTemplateResponse

Deletes a specified approval rule template. Deleting a template does not remove approval rules on pull requests already created with the template.

deleteBranch

inline suspend fun CodeCommitClient.deleteBranch(crossinline block: DeleteBranchRequest.Builder.() -> Unit): DeleteBranchResponse

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

deleteCommentContent

inline suspend fun CodeCommitClient.deleteCommentContent(crossinline block: DeleteCommentContentRequest.Builder.() -> Unit): DeleteCommentContentResponse

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

deleteFile

inline suspend fun CodeCommitClient.deleteFile(crossinline block: DeleteFileRequest.Builder.() -> Unit): DeleteFileResponse

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

deletePullRequestApprovalRule

inline suspend fun CodeCommitClient.deletePullRequestApprovalRule(crossinline block: DeletePullRequestApprovalRuleRequest.Builder.() -> Unit): DeletePullRequestApprovalRuleResponse

Deletes an approval rule from a specified pull request. Approval rules can be deleted from a pull request only if the pull request is open, and if the approval rule was created specifically for a pull request and not generated from an approval rule template associated with the repository where the pull request was created. You cannot delete an approval rule from a merged or closed pull request.

deleteRepository

inline suspend fun CodeCommitClient.deleteRepository(crossinline block: DeleteRepositoryRequest.Builder.() -> Unit): DeleteRepositoryResponse

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

describeMergeConflicts

inline suspend fun CodeCommitClient.describeMergeConflicts(crossinline block: DescribeMergeConflictsRequest.Builder.() -> Unit): DescribeMergeConflictsResponse

Returns information about one or more merge conflicts in the attempted merge of two commit specifiers using the squash or three-way merge strategy. If the merge option for the attempted merge is specified as FAST_FORWARD_MERGE, an exception is thrown.

describePullRequestEvents

inline suspend fun CodeCommitClient.describePullRequestEvents(crossinline block: DescribePullRequestEventsRequest.Builder.() -> Unit): DescribePullRequestEventsResponse

Returns information about one or more pull request events.

disassociateApprovalRuleTemplateFromRepository

inline suspend fun CodeCommitClient.disassociateApprovalRuleTemplateFromRepository(crossinline block: DisassociateApprovalRuleTemplateFromRepositoryRequest.Builder.() -> Unit): DisassociateApprovalRuleTemplateFromRepositoryResponse

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. This does not delete any approval rules previously created for pull requests through the template association.

evaluatePullRequestApprovalRules

inline suspend fun CodeCommitClient.evaluatePullRequestApprovalRules(crossinline block: EvaluatePullRequestApprovalRulesRequest.Builder.() -> Unit): EvaluatePullRequestApprovalRulesResponse

Evaluates whether a pull request has met all the conditions specified in its associated approval rules.

getApprovalRuleTemplate

inline suspend fun CodeCommitClient.getApprovalRuleTemplate(crossinline block: GetApprovalRuleTemplateRequest.Builder.() -> Unit): GetApprovalRuleTemplateResponse

Returns information about a specified approval rule template.

getBlob

inline suspend fun CodeCommitClient.getBlob(crossinline block: GetBlobRequest.Builder.() -> Unit): GetBlobResponse

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

getBranch

inline suspend fun CodeCommitClient.getBranch(crossinline block: GetBranchRequest.Builder.() -> Unit): GetBranchResponse

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

getComment

inline suspend fun CodeCommitClient.getComment(crossinline block: GetCommentRequest.Builder.() -> Unit): GetCommentResponse

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

getCommentReactions

inline suspend fun CodeCommitClient.getCommentReactions(crossinline block: GetCommentReactionsRequest.Builder.() -> Unit): GetCommentReactionsResponse

Returns information about reactions to a specified comment ID. Reactions from users who have been deleted will not be included in the count.

getCommentsForComparedCommit

inline suspend fun CodeCommitClient.getCommentsForComparedCommit(crossinline block: GetCommentsForComparedCommitRequest.Builder.() -> Unit): GetCommentsForComparedCommitResponse

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

getCommentsForPullRequest

inline suspend fun CodeCommitClient.getCommentsForPullRequest(crossinline block: GetCommentsForPullRequestRequest.Builder.() -> Unit): GetCommentsForPullRequestResponse

Returns comments made on a pull request.

getCommit

inline suspend fun CodeCommitClient.getCommit(crossinline block: GetCommitRequest.Builder.() -> Unit): GetCommitResponse

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

getDifferences

inline suspend fun CodeCommitClient.getDifferences(crossinline block: GetDifferencesRequest.Builder.() -> Unit): GetDifferencesResponse

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

inline suspend fun CodeCommitClient.getFile(crossinline block: GetFileRequest.Builder.() -> Unit): GetFileResponse

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

getFolder

inline suspend fun CodeCommitClient.getFolder(crossinline block: GetFolderRequest.Builder.() -> Unit): GetFolderResponse

Returns the contents of a specified folder in a repository.

getMergeCommit

inline suspend fun CodeCommitClient.getMergeCommit(crossinline block: GetMergeCommitRequest.Builder.() -> Unit): GetMergeCommitResponse

Returns information about a specified merge commit.

getMergeConflicts

inline suspend fun CodeCommitClient.getMergeConflicts(crossinline block: GetMergeConflictsRequest.Builder.() -> Unit): GetMergeConflictsResponse

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

getMergeOptions

inline suspend fun CodeCommitClient.getMergeOptions(crossinline block: GetMergeOptionsRequest.Builder.() -> Unit): GetMergeOptionsResponse

Returns information about the merge options available for merging two specified branches. For details about why a merge option is not available, use GetMergeConflicts or DescribeMergeConflicts.

getPullRequest

inline suspend fun CodeCommitClient.getPullRequest(crossinline block: GetPullRequestRequest.Builder.() -> Unit): GetPullRequestResponse

Gets information about a pull request in a specified repository.

getPullRequestApprovalStates

inline suspend fun CodeCommitClient.getPullRequestApprovalStates(crossinline block: GetPullRequestApprovalStatesRequest.Builder.() -> Unit): GetPullRequestApprovalStatesResponse

Gets information about the approval states for a specified pull request. Approval states only apply to pull requests that have one or more approval rules applied to them.

getPullRequestOverrideState

inline suspend fun CodeCommitClient.getPullRequestOverrideState(crossinline block: GetPullRequestOverrideStateRequest.Builder.() -> Unit): GetPullRequestOverrideStateResponse

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.

getRepository

inline suspend fun CodeCommitClient.getRepository(crossinline block: GetRepositoryRequest.Builder.() -> Unit): GetRepositoryResponse

Returns information about a repository.

getRepositoryTriggers

inline suspend fun CodeCommitClient.getRepositoryTriggers(crossinline block: GetRepositoryTriggersRequest.Builder.() -> Unit): GetRepositoryTriggersResponse

Gets information about triggers configured for a repository.

listApprovalRuleTemplates

inline suspend fun CodeCommitClient.listApprovalRuleTemplates(crossinline block: ListApprovalRuleTemplatesRequest.Builder.() -> Unit): ListApprovalRuleTemplatesResponse

Lists all approval rule templates in the specified Amazon Web Services Region in your Amazon Web Services account. If an Amazon Web Services Region is not specified, the Amazon Web Services Region where you are signed in is used.

listAssociatedApprovalRuleTemplatesForRepository

inline suspend fun CodeCommitClient.listAssociatedApprovalRuleTemplatesForRepository(crossinline block: ListAssociatedApprovalRuleTemplatesForRepositoryRequest.Builder.() -> Unit): ListAssociatedApprovalRuleTemplatesForRepositoryResponse

Lists all approval rule templates that are associated with a specified repository.

listBranches

inline suspend fun CodeCommitClient.listBranches(crossinline block: ListBranchesRequest.Builder.() -> Unit): ListBranchesResponse

Gets information about one or more branches in a repository.

listFileCommitHistory

inline suspend fun CodeCommitClient.listFileCommitHistory(crossinline block: ListFileCommitHistoryRequest.Builder.() -> Unit): ListFileCommitHistoryResponse

Retrieves a list of commits and changes to a specified file.

listPullRequests

inline suspend fun CodeCommitClient.listPullRequests(crossinline block: ListPullRequestsRequest.Builder.() -> Unit): ListPullRequestsResponse

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

inline suspend fun CodeCommitClient.listRepositories(crossinline block: ListRepositoriesRequest.Builder.() -> Unit): ListRepositoriesResponse

Gets information about one or more repositories.

listRepositoriesForApprovalRuleTemplate

inline suspend fun CodeCommitClient.listRepositoriesForApprovalRuleTemplate(crossinline block: ListRepositoriesForApprovalRuleTemplateRequest.Builder.() -> Unit): ListRepositoriesForApprovalRuleTemplateResponse

Lists all repositories associated with the specified approval rule template.

listTagsForResource

inline suspend fun CodeCommitClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Gets information about Amazon Web Servicestags for a specified Amazon Resource Name (ARN) in CodeCommit. For a list of valid resources in CodeCommit, see CodeCommit Resources and Operations in the* CodeCommit User Guide*.

mergeBranchesByFastForward

inline suspend fun CodeCommitClient.mergeBranchesByFastForward(crossinline block: MergeBranchesByFastForwardRequest.Builder.() -> Unit): MergeBranchesByFastForwardResponse

Merges two branches using the fast-forward merge strategy.

mergeBranchesBySquash

inline suspend fun CodeCommitClient.mergeBranchesBySquash(crossinline block: MergeBranchesBySquashRequest.Builder.() -> Unit): MergeBranchesBySquashResponse

Merges two branches using the squash merge strategy.

mergeBranchesByThreeWay

inline suspend fun CodeCommitClient.mergeBranchesByThreeWay(crossinline block: MergeBranchesByThreeWayRequest.Builder.() -> Unit): MergeBranchesByThreeWayResponse

Merges two specified branches using the three-way merge strategy.

mergePullRequestByFastForward

inline suspend fun CodeCommitClient.mergePullRequestByFastForward(crossinline block: MergePullRequestByFastForwardRequest.Builder.() -> Unit): MergePullRequestByFastForwardResponse

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. If the merge is successful, it closes the pull request.

mergePullRequestBySquash

inline suspend fun CodeCommitClient.mergePullRequestBySquash(crossinline block: MergePullRequestBySquashRequest.Builder.() -> Unit): MergePullRequestBySquashResponse

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. If the merge is successful, it closes the pull request.

mergePullRequestByThreeWay

inline suspend fun CodeCommitClient.mergePullRequestByThreeWay(crossinline block: MergePullRequestByThreeWayRequest.Builder.() -> Unit): MergePullRequestByThreeWayResponse

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. If the merge is successful, it closes the pull request.

overridePullRequestApprovalRules

inline suspend fun CodeCommitClient.overridePullRequestApprovalRules(crossinline block: OverridePullRequestApprovalRulesRequest.Builder.() -> Unit): OverridePullRequestApprovalRulesResponse

Sets aside (overrides) all approval rule requirements for a specified pull request.

postCommentForComparedCommit

inline suspend fun CodeCommitClient.postCommentForComparedCommit(crossinline block: PostCommentForComparedCommitRequest.Builder.() -> Unit): PostCommentForComparedCommitResponse

Posts a comment on the comparison between two commits.

postCommentForPullRequest

inline suspend fun CodeCommitClient.postCommentForPullRequest(crossinline block: PostCommentForPullRequestRequest.Builder.() -> Unit): PostCommentForPullRequestResponse

Posts a comment on a pull request.

postCommentReply

inline suspend fun CodeCommitClient.postCommentReply(crossinline block: PostCommentReplyRequest.Builder.() -> Unit): PostCommentReplyResponse

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

putCommentReaction

inline suspend fun CodeCommitClient.putCommentReaction(crossinline block: PutCommentReactionRequest.Builder.() -> Unit): PutCommentReactionResponse

Adds or updates a reaction to a specified comment for the user whose identity is used to make the request. You can only add or update a reaction for yourself. You cannot add, modify, or delete a reaction for another user.

putFile

inline suspend fun CodeCommitClient.putFile(crossinline block: PutFileRequest.Builder.() -> Unit): PutFileResponse

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

putRepositoryTriggers

inline suspend fun CodeCommitClient.putRepositoryTriggers(crossinline block: PutRepositoryTriggersRequest.Builder.() -> Unit): PutRepositoryTriggersResponse

Replaces all triggers for a repository. Used to create or delete triggers.

tagResource

inline suspend fun CodeCommitClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds or updates tags for a resource in CodeCommit. For a list of valid resources in CodeCommit, see CodeCommit Resources and Operations in the CodeCommit User Guide.

testRepositoryTriggers

inline suspend fun CodeCommitClient.testRepositoryTriggers(crossinline block: TestRepositoryTriggersRequest.Builder.() -> Unit): TestRepositoryTriggersResponse

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

untagResource

inline suspend fun CodeCommitClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags for a resource in CodeCommit. For a list of valid resources in CodeCommit, see CodeCommit Resources and Operations in the CodeCommit User Guide.

updateApprovalRuleTemplateContent

inline suspend fun CodeCommitClient.updateApprovalRuleTemplateContent(crossinline block: UpdateApprovalRuleTemplateContentRequest.Builder.() -> Unit): UpdateApprovalRuleTemplateContentResponse

Updates the content of an approval rule template. You can change the number of required approvals, the membership of the approval rule, and whether an approval pool is defined.

updateApprovalRuleTemplateDescription

inline suspend fun CodeCommitClient.updateApprovalRuleTemplateDescription(crossinline block: UpdateApprovalRuleTemplateDescriptionRequest.Builder.() -> Unit): UpdateApprovalRuleTemplateDescriptionResponse

Updates the description for a specified approval rule template.

updateApprovalRuleTemplateName

inline suspend fun CodeCommitClient.updateApprovalRuleTemplateName(crossinline block: UpdateApprovalRuleTemplateNameRequest.Builder.() -> Unit): UpdateApprovalRuleTemplateNameResponse

Updates the name of a specified approval rule template.

updateComment

inline suspend fun CodeCommitClient.updateComment(crossinline block: UpdateCommentRequest.Builder.() -> Unit): UpdateCommentResponse

Replaces the contents of a comment.

updateDefaultBranch

inline suspend fun CodeCommitClient.updateDefaultBranch(crossinline block: UpdateDefaultBranchRequest.Builder.() -> Unit): UpdateDefaultBranchResponse

Sets or changes the default branch name for the specified repository.

updatePullRequestApprovalRuleContent

inline suspend fun CodeCommitClient.updatePullRequestApprovalRuleContent(crossinline block: UpdatePullRequestApprovalRuleContentRequest.Builder.() -> Unit): UpdatePullRequestApprovalRuleContentResponse

Updates the structure of an approval rule created specifically for a pull request. For example, you can change the number of required approvers and the approval pool for approvers.

updatePullRequestApprovalState

inline suspend fun CodeCommitClient.updatePullRequestApprovalState(crossinline block: UpdatePullRequestApprovalStateRequest.Builder.() -> Unit): UpdatePullRequestApprovalStateResponse

Updates the state of a user's approval on a pull request. The user is derived from the signed-in account when the request is made.

updatePullRequestDescription

inline suspend fun CodeCommitClient.updatePullRequestDescription(crossinline block: UpdatePullRequestDescriptionRequest.Builder.() -> Unit): UpdatePullRequestDescriptionResponse

Replaces the contents of the description of a pull request.

updatePullRequestStatus

inline suspend fun CodeCommitClient.updatePullRequestStatus(crossinline block: UpdatePullRequestStatusRequest.Builder.() -> Unit): UpdatePullRequestStatusResponse

Updates the status of a pull request.

updatePullRequestTitle

inline suspend fun CodeCommitClient.updatePullRequestTitle(crossinline block: UpdatePullRequestTitleRequest.Builder.() -> Unit): UpdatePullRequestTitleResponse

Replaces the title of a pull request.

updateRepositoryDescription

inline suspend fun CodeCommitClient.updateRepositoryDescription(crossinline block: UpdateRepositoryDescriptionRequest.Builder.() -> Unit): UpdateRepositoryDescriptionResponse

Sets or changes the comment or description for a repository.

updateRepositoryEncryptionKey

inline suspend fun CodeCommitClient.updateRepositoryEncryptionKey(crossinline block: UpdateRepositoryEncryptionKeyRequest.Builder.() -> Unit): UpdateRepositoryEncryptionKeyResponse

Updates the Key Management Service encryption key used to encrypt and decrypt a CodeCommit repository.

updateRepositoryName

inline suspend fun CodeCommitClient.updateRepositoryName(crossinline block: UpdateRepositoryNameRequest.Builder.() -> Unit): UpdateRepositoryNameResponse

Renames a repository. The repository name must be unique across the calling Amazon Web Services account. Repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. The suffix .git is prohibited. For more information about the limits on repository names, see Quotas in the CodeCommit User Guide.

withConfig

fun CodeCommitClient.withConfig(block: CodeCommitClient.Config.Builder.() -> Unit): CodeCommitClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.