CodeCommitClient#
Index > CodeCommit > CodeCommitClient
Auto-generated documentation for CodeCommit type annotations stubs module types-boto3-codecommit.
CodeCommitClient#
Type annotations and code completion for boto3.client("codecommit")
.
boto3 documentation
# CodeCommitClient usage example
from boto3.session import Session
from types_boto3_codecommit.client import CodeCommitClient
def get_codecommit_client() -> CodeCommitClient:
return Session().client("codecommit")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("codecommit").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("codecommit")
try:
do_something(client)
except (
client.exceptions.ActorDoesNotExistException,
client.exceptions.ApprovalRuleContentRequiredException,
client.exceptions.ApprovalRuleDoesNotExistException,
client.exceptions.ApprovalRuleNameAlreadyExistsException,
client.exceptions.ApprovalRuleNameRequiredException,
client.exceptions.ApprovalRuleTemplateContentRequiredException,
client.exceptions.ApprovalRuleTemplateDoesNotExistException,
client.exceptions.ApprovalRuleTemplateInUseException,
client.exceptions.ApprovalRuleTemplateNameAlreadyExistsException,
client.exceptions.ApprovalRuleTemplateNameRequiredException,
client.exceptions.ApprovalStateRequiredException,
client.exceptions.AuthorDoesNotExistException,
client.exceptions.BeforeCommitIdAndAfterCommitIdAreSameException,
client.exceptions.BlobIdDoesNotExistException,
client.exceptions.BlobIdRequiredException,
client.exceptions.BranchDoesNotExistException,
client.exceptions.BranchNameExistsException,
client.exceptions.BranchNameIsTagNameException,
client.exceptions.BranchNameRequiredException,
client.exceptions.CannotDeleteApprovalRuleFromTemplateException,
client.exceptions.CannotModifyApprovalRuleFromTemplateException,
client.exceptions.ClientError,
client.exceptions.ClientRequestTokenRequiredException,
client.exceptions.CommentContentRequiredException,
client.exceptions.CommentContentSizeLimitExceededException,
client.exceptions.CommentDeletedException,
client.exceptions.CommentDoesNotExistException,
client.exceptions.CommentIdRequiredException,
client.exceptions.CommentNotCreatedByCallerException,
client.exceptions.CommitDoesNotExistException,
client.exceptions.CommitIdDoesNotExistException,
client.exceptions.CommitIdRequiredException,
client.exceptions.CommitIdsLimitExceededException,
client.exceptions.CommitIdsListRequiredException,
client.exceptions.CommitMessageLengthExceededException,
client.exceptions.CommitRequiredException,
client.exceptions.ConcurrentReferenceUpdateException,
client.exceptions.DefaultBranchCannotBeDeletedException,
client.exceptions.DirectoryNameConflictsWithFileNameException,
client.exceptions.EncryptionIntegrityChecksFailedException,
client.exceptions.EncryptionKeyAccessDeniedException,
client.exceptions.EncryptionKeyDisabledException,
client.exceptions.EncryptionKeyInvalidIdException,
client.exceptions.EncryptionKeyInvalidUsageException,
client.exceptions.EncryptionKeyNotFoundException,
client.exceptions.EncryptionKeyRequiredException,
client.exceptions.EncryptionKeyUnavailableException,
client.exceptions.FileContentAndSourceFileSpecifiedException,
client.exceptions.FileContentRequiredException,
client.exceptions.FileContentSizeLimitExceededException,
client.exceptions.FileDoesNotExistException,
client.exceptions.FileEntryRequiredException,
client.exceptions.FileModeRequiredException,
client.exceptions.FileNameConflictsWithDirectoryNameException,
client.exceptions.FilePathConflictsWithSubmodulePathException,
client.exceptions.FileTooLargeException,
client.exceptions.FolderContentSizeLimitExceededException,
client.exceptions.FolderDoesNotExistException,
client.exceptions.IdempotencyParameterMismatchException,
client.exceptions.InvalidActorArnException,
client.exceptions.InvalidApprovalRuleContentException,
client.exceptions.InvalidApprovalRuleNameException,
client.exceptions.InvalidApprovalRuleTemplateContentException,
client.exceptions.InvalidApprovalRuleTemplateDescriptionException,
client.exceptions.InvalidApprovalRuleTemplateNameException,
client.exceptions.InvalidApprovalStateException,
client.exceptions.InvalidAuthorArnException,
client.exceptions.InvalidBlobIdException,
client.exceptions.InvalidBranchNameException,
client.exceptions.InvalidClientRequestTokenException,
client.exceptions.InvalidCommentIdException,
client.exceptions.InvalidCommitException,
client.exceptions.InvalidCommitIdException,
client.exceptions.InvalidConflictDetailLevelException,
client.exceptions.InvalidConflictResolutionException,
client.exceptions.InvalidConflictResolutionStrategyException,
client.exceptions.InvalidContinuationTokenException,
client.exceptions.InvalidDeletionParameterException,
client.exceptions.InvalidDescriptionException,
client.exceptions.InvalidDestinationCommitSpecifierException,
client.exceptions.InvalidEmailException,
client.exceptions.InvalidFileLocationException,
client.exceptions.InvalidFileModeException,
client.exceptions.InvalidFilePositionException,
client.exceptions.InvalidMaxConflictFilesException,
client.exceptions.InvalidMaxMergeHunksException,
client.exceptions.InvalidMaxResultsException,
client.exceptions.InvalidMergeOptionException,
client.exceptions.InvalidOrderException,
client.exceptions.InvalidOverrideStatusException,
client.exceptions.InvalidParentCommitIdException,
client.exceptions.InvalidPathException,
client.exceptions.InvalidPullRequestEventTypeException,
client.exceptions.InvalidPullRequestIdException,
client.exceptions.InvalidPullRequestStatusException,
client.exceptions.InvalidPullRequestStatusUpdateException,
client.exceptions.InvalidReactionUserArnException,
client.exceptions.InvalidReactionValueException,
client.exceptions.InvalidReferenceNameException,
client.exceptions.InvalidRelativeFileVersionEnumException,
client.exceptions.InvalidReplacementContentException,
client.exceptions.InvalidReplacementTypeException,
client.exceptions.InvalidRepositoryDescriptionException,
client.exceptions.InvalidRepositoryNameException,
client.exceptions.InvalidRepositoryTriggerBranchNameException,
client.exceptions.InvalidRepositoryTriggerCustomDataException,
client.exceptions.InvalidRepositoryTriggerDestinationArnException,
client.exceptions.InvalidRepositoryTriggerEventsException,
client.exceptions.InvalidRepositoryTriggerNameException,
client.exceptions.InvalidRepositoryTriggerRegionException,
client.exceptions.InvalidResourceArnException,
client.exceptions.InvalidRevisionIdException,
client.exceptions.InvalidRuleContentSha256Exception,
client.exceptions.InvalidSortByException,
client.exceptions.InvalidSourceCommitSpecifierException,
client.exceptions.InvalidSystemTagUsageException,
client.exceptions.InvalidTagKeysListException,
client.exceptions.InvalidTagsMapException,
client.exceptions.InvalidTargetBranchException,
client.exceptions.InvalidTargetException,
client.exceptions.InvalidTargetsException,
client.exceptions.InvalidTitleException,
client.exceptions.ManualMergeRequiredException,
client.exceptions.MaximumBranchesExceededException,
client.exceptions.MaximumConflictResolutionEntriesExceededException,
client.exceptions.MaximumFileContentToLoadExceededException,
client.exceptions.MaximumFileEntriesExceededException,
client.exceptions.MaximumItemsToCompareExceededException,
client.exceptions.MaximumNumberOfApprovalsExceededException,
client.exceptions.MaximumOpenPullRequestsExceededException,
client.exceptions.MaximumRepositoryNamesExceededException,
client.exceptions.MaximumRepositoryTriggersExceededException,
client.exceptions.MaximumRuleTemplatesAssociatedWithRepositoryException,
client.exceptions.MergeOptionRequiredException,
client.exceptions.MultipleConflictResolutionEntriesException,
client.exceptions.MultipleRepositoriesInPullRequestException,
client.exceptions.NameLengthExceededException,
client.exceptions.NoChangeException,
client.exceptions.NumberOfRuleTemplatesExceededException,
client.exceptions.NumberOfRulesExceededException,
client.exceptions.OperationNotAllowedException,
client.exceptions.OverrideAlreadySetException,
client.exceptions.OverrideStatusRequiredException,
client.exceptions.ParentCommitDoesNotExistException,
client.exceptions.ParentCommitIdOutdatedException,
client.exceptions.ParentCommitIdRequiredException,
client.exceptions.PathDoesNotExistException,
client.exceptions.PathRequiredException,
client.exceptions.PullRequestAlreadyClosedException,
client.exceptions.PullRequestApprovalRulesNotSatisfiedException,
client.exceptions.PullRequestCannotBeApprovedByAuthorException,
client.exceptions.PullRequestDoesNotExistException,
client.exceptions.PullRequestIdRequiredException,
client.exceptions.PullRequestStatusRequiredException,
client.exceptions.PutFileEntryConflictException,
client.exceptions.ReactionLimitExceededException,
client.exceptions.ReactionValueRequiredException,
client.exceptions.ReferenceDoesNotExistException,
client.exceptions.ReferenceNameRequiredException,
client.exceptions.ReferenceTypeNotSupportedException,
client.exceptions.ReplacementContentRequiredException,
client.exceptions.ReplacementTypeRequiredException,
client.exceptions.RepositoryDoesNotExistException,
client.exceptions.RepositoryLimitExceededException,
client.exceptions.RepositoryNameExistsException,
client.exceptions.RepositoryNameRequiredException,
client.exceptions.RepositoryNamesRequiredException,
client.exceptions.RepositoryNotAssociatedWithPullRequestException,
client.exceptions.RepositoryTriggerBranchNameListRequiredException,
client.exceptions.RepositoryTriggerDestinationArnRequiredException,
client.exceptions.RepositoryTriggerEventsListRequiredException,
client.exceptions.RepositoryTriggerNameRequiredException,
client.exceptions.RepositoryTriggersListRequiredException,
client.exceptions.ResourceArnRequiredException,
client.exceptions.RestrictedSourceFileException,
client.exceptions.RevisionIdRequiredException,
client.exceptions.RevisionNotCurrentException,
client.exceptions.SameFileContentException,
client.exceptions.SamePathRequestException,
client.exceptions.SourceAndDestinationAreSameException,
client.exceptions.SourceFileOrContentRequiredException,
client.exceptions.TagKeysListRequiredException,
client.exceptions.TagPolicyException,
client.exceptions.TagsMapRequiredException,
client.exceptions.TargetRequiredException,
client.exceptions.TargetsRequiredException,
client.exceptions.TipOfSourceReferenceIsDifferentException,
client.exceptions.TipsDivergenceExceededException,
client.exceptions.TitleRequiredException,
client.exceptions.TooManyTagsException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from types_boto3_codecommit.client import Exceptions
def handle_error(exc: Exceptions.ActorDoesNotExistException) -> None:
...
Methods#
can_paginate#
Type annotations and code completion for boto3.client("codecommit").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
generate_presigned_url#
Type annotations and code completion for boto3.client("codecommit").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
associate_approval_rule_template_with_repository#
Creates an association between an approval rule template and a specified repository.
Type annotations and code completion for boto3.client("codecommit").associate_approval_rule_template_with_repository
method.
boto3 documentation
# associate_approval_rule_template_with_repository method definition
def associate_approval_rule_template_with_repository(
self,
*,
approvalRuleTemplateName: str,
repositoryName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# associate_approval_rule_template_with_repository method usage example with argument unpacking
kwargs: AssociateApprovalRuleTemplateWithRepositoryInputRequestTypeDef = { # (1)
"approvalRuleTemplateName": ...,
"repositoryName": ...,
}
parent.associate_approval_rule_template_with_repository(**kwargs)
batch_associate_approval_rule_template_with_repositories#
Creates an association between an approval rule template and one or more specified repositories.
Type annotations and code completion for boto3.client("codecommit").batch_associate_approval_rule_template_with_repositories
method.
boto3 documentation
# batch_associate_approval_rule_template_with_repositories method definition
def batch_associate_approval_rule_template_with_repositories(
self,
*,
approvalRuleTemplateName: str,
repositoryNames: Sequence[str],
) -> BatchAssociateApprovalRuleTemplateWithRepositoriesOutputTypeDef: # (1)
...
# batch_associate_approval_rule_template_with_repositories method usage example with argument unpacking
kwargs: BatchAssociateApprovalRuleTemplateWithRepositoriesInputRequestTypeDef = { # (1)
"approvalRuleTemplateName": ...,
"repositoryNames": ...,
}
parent.batch_associate_approval_rule_template_with_repositories(**kwargs)
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.
Type annotations and code completion for boto3.client("codecommit").batch_describe_merge_conflicts
method.
boto3 documentation
# batch_describe_merge_conflicts method definition
def batch_describe_merge_conflicts(
self,
*,
repositoryName: str,
destinationCommitSpecifier: str,
sourceCommitSpecifier: str,
mergeOption: MergeOptionTypeEnumType, # (1)
maxMergeHunks: int = ...,
maxConflictFiles: int = ...,
filePaths: Sequence[str] = ...,
conflictDetailLevel: ConflictDetailLevelTypeEnumType = ..., # (2)
conflictResolutionStrategy: ConflictResolutionStrategyTypeEnumType = ..., # (3)
nextToken: str = ...,
) -> BatchDescribeMergeConflictsOutputTypeDef: # (4)
...
- See MergeOptionTypeEnumType
- See ConflictDetailLevelTypeEnumType
- See ConflictResolutionStrategyTypeEnumType
- See BatchDescribeMergeConflictsOutputTypeDef
# batch_describe_merge_conflicts method usage example with argument unpacking
kwargs: BatchDescribeMergeConflictsInputRequestTypeDef = { # (1)
"repositoryName": ...,
"destinationCommitSpecifier": ...,
"sourceCommitSpecifier": ...,
"mergeOption": ...,
}
parent.batch_describe_merge_conflicts(**kwargs)
batch_disassociate_approval_rule_template_from_repositories#
Removes the association between an approval rule template and one or more specified repositories.
Type annotations and code completion for boto3.client("codecommit").batch_disassociate_approval_rule_template_from_repositories
method.
boto3 documentation
# batch_disassociate_approval_rule_template_from_repositories method definition
def batch_disassociate_approval_rule_template_from_repositories(
self,
*,
approvalRuleTemplateName: str,
repositoryNames: Sequence[str],
) -> BatchDisassociateApprovalRuleTemplateFromRepositoriesOutputTypeDef: # (1)
...
# batch_disassociate_approval_rule_template_from_repositories method usage example with argument unpacking
kwargs: BatchDisassociateApprovalRuleTemplateFromRepositoriesInputRequestTypeDef = { # (1)
"approvalRuleTemplateName": ...,
"repositoryNames": ...,
}
parent.batch_disassociate_approval_rule_template_from_repositories(**kwargs)
batch_get_commits#
Returns information about the contents of one or more commits in a repository.
Type annotations and code completion for boto3.client("codecommit").batch_get_commits
method.
boto3 documentation
# batch_get_commits method definition
def batch_get_commits(
self,
*,
commitIds: Sequence[str],
repositoryName: str,
) -> BatchGetCommitsOutputTypeDef: # (1)
...
# batch_get_commits method usage example with argument unpacking
kwargs: BatchGetCommitsInputRequestTypeDef = { # (1)
"commitIds": ...,
"repositoryName": ...,
}
parent.batch_get_commits(**kwargs)
batch_get_repositories#
Returns information about one or more repositories.
Type annotations and code completion for boto3.client("codecommit").batch_get_repositories
method.
boto3 documentation
# batch_get_repositories method definition
def batch_get_repositories(
self,
*,
repositoryNames: Sequence[str],
) -> BatchGetRepositoriesOutputTypeDef: # (1)
...
# batch_get_repositories method usage example with argument unpacking
kwargs: BatchGetRepositoriesInputRequestTypeDef = { # (1)
"repositoryNames": ...,
}
parent.batch_get_repositories(**kwargs)
create_approval_rule_template#
Creates a template for approval rules that can then be associated with one or more repositories in your Amazon Web Services account.
Type annotations and code completion for boto3.client("codecommit").create_approval_rule_template
method.
boto3 documentation
# create_approval_rule_template method definition
def create_approval_rule_template(
self,
*,
approvalRuleTemplateName: str,
approvalRuleTemplateContent: str,
approvalRuleTemplateDescription: str = ...,
) -> CreateApprovalRuleTemplateOutputTypeDef: # (1)
...
# create_approval_rule_template method usage example with argument unpacking
kwargs: CreateApprovalRuleTemplateInputRequestTypeDef = { # (1)
"approvalRuleTemplateName": ...,
"approvalRuleTemplateContent": ...,
}
parent.create_approval_rule_template(**kwargs)
create_branch#
Creates a branch in a repository and points the branch to a commit.
Type annotations and code completion for boto3.client("codecommit").create_branch
method.
boto3 documentation
# create_branch method definition
def create_branch(
self,
*,
repositoryName: str,
branchName: str,
commitId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# create_branch method usage example with argument unpacking
kwargs: CreateBranchInputRequestTypeDef = { # (1)
"repositoryName": ...,
"branchName": ...,
"commitId": ...,
}
parent.create_branch(**kwargs)
create_commit#
Creates a commit for a repository on the tip of a specified branch.
Type annotations and code completion for boto3.client("codecommit").create_commit
method.
boto3 documentation
# create_commit method definition
def create_commit(
self,
*,
repositoryName: str,
branchName: str,
parentCommitId: str = ...,
authorName: str = ...,
email: str = ...,
commitMessage: str = ...,
keepEmptyFolders: bool = ...,
putFiles: Sequence[PutFileEntryTypeDef] = ..., # (1)
deleteFiles: Sequence[DeleteFileEntryTypeDef] = ..., # (2)
setFileModes: Sequence[SetFileModeEntryTypeDef] = ..., # (3)
) -> CreateCommitOutputTypeDef: # (4)
...
- See PutFileEntryTypeDef
- See DeleteFileEntryTypeDef
- See SetFileModeEntryTypeDef
- See CreateCommitOutputTypeDef
# create_commit method usage example with argument unpacking
kwargs: CreateCommitInputRequestTypeDef = { # (1)
"repositoryName": ...,
"branchName": ...,
}
parent.create_commit(**kwargs)
create_pull_request#
Creates a pull request in the specified repository.
Type annotations and code completion for boto3.client("codecommit").create_pull_request
method.
boto3 documentation
# create_pull_request method definition
def create_pull_request(
self,
*,
title: str,
targets: Sequence[TargetTypeDef], # (1)
description: str = ...,
clientRequestToken: str = ...,
) -> CreatePullRequestOutputTypeDef: # (2)
...
# create_pull_request method usage example with argument unpacking
kwargs: CreatePullRequestInputRequestTypeDef = { # (1)
"title": ...,
"targets": ...,
}
parent.create_pull_request(**kwargs)
create_pull_request_approval_rule#
Creates an approval rule for a pull request.
Type annotations and code completion for boto3.client("codecommit").create_pull_request_approval_rule
method.
boto3 documentation
# create_pull_request_approval_rule method definition
def create_pull_request_approval_rule(
self,
*,
pullRequestId: str,
approvalRuleName: str,
approvalRuleContent: str,
) -> CreatePullRequestApprovalRuleOutputTypeDef: # (1)
...
# create_pull_request_approval_rule method usage example with argument unpacking
kwargs: CreatePullRequestApprovalRuleInputRequestTypeDef = { # (1)
"pullRequestId": ...,
"approvalRuleName": ...,
"approvalRuleContent": ...,
}
parent.create_pull_request_approval_rule(**kwargs)
create_repository#
Creates a new, empty repository.
Type annotations and code completion for boto3.client("codecommit").create_repository
method.
boto3 documentation
# create_repository method definition
def create_repository(
self,
*,
repositoryName: str,
repositoryDescription: str = ...,
tags: Mapping[str, str] = ...,
kmsKeyId: str = ...,
) -> CreateRepositoryOutputTypeDef: # (1)
...
# create_repository method usage example with argument unpacking
kwargs: CreateRepositoryInputRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.create_repository(**kwargs)
create_unreferenced_merge_commit#
Creates an unreferenced commit that represents the result of merging two branches using a specified merge strategy.
Type annotations and code completion for boto3.client("codecommit").create_unreferenced_merge_commit
method.
boto3 documentation
# create_unreferenced_merge_commit method definition
def create_unreferenced_merge_commit(
self,
*,
repositoryName: str,
sourceCommitSpecifier: str,
destinationCommitSpecifier: str,
mergeOption: MergeOptionTypeEnumType, # (1)
conflictDetailLevel: ConflictDetailLevelTypeEnumType = ..., # (2)
conflictResolutionStrategy: ConflictResolutionStrategyTypeEnumType = ..., # (3)
authorName: str = ...,
email: str = ...,
commitMessage: str = ...,
keepEmptyFolders: bool = ...,
conflictResolution: ConflictResolutionTypeDef = ..., # (4)
) -> CreateUnreferencedMergeCommitOutputTypeDef: # (5)
...
- See MergeOptionTypeEnumType
- See ConflictDetailLevelTypeEnumType
- See ConflictResolutionStrategyTypeEnumType
- See ConflictResolutionTypeDef
- See CreateUnreferencedMergeCommitOutputTypeDef
# create_unreferenced_merge_commit method usage example with argument unpacking
kwargs: CreateUnreferencedMergeCommitInputRequestTypeDef = { # (1)
"repositoryName": ...,
"sourceCommitSpecifier": ...,
"destinationCommitSpecifier": ...,
"mergeOption": ...,
}
parent.create_unreferenced_merge_commit(**kwargs)
delete_approval_rule_template#
Deletes a specified approval rule template.
Type annotations and code completion for boto3.client("codecommit").delete_approval_rule_template
method.
boto3 documentation
# delete_approval_rule_template method definition
def delete_approval_rule_template(
self,
*,
approvalRuleTemplateName: str,
) -> DeleteApprovalRuleTemplateOutputTypeDef: # (1)
...
# delete_approval_rule_template method usage example with argument unpacking
kwargs: DeleteApprovalRuleTemplateInputRequestTypeDef = { # (1)
"approvalRuleTemplateName": ...,
}
parent.delete_approval_rule_template(**kwargs)
delete_branch#
Deletes a branch from a repository, unless that branch is the default branch for the repository.
Type annotations and code completion for boto3.client("codecommit").delete_branch
method.
boto3 documentation
# delete_branch method definition
def delete_branch(
self,
*,
repositoryName: str,
branchName: str,
) -> DeleteBranchOutputTypeDef: # (1)
...
# delete_branch method usage example with argument unpacking
kwargs: DeleteBranchInputRequestTypeDef = { # (1)
"repositoryName": ...,
"branchName": ...,
}
parent.delete_branch(**kwargs)
delete_comment_content#
Deletes the content of a comment made on a change, file, or commit in a repository.
Type annotations and code completion for boto3.client("codecommit").delete_comment_content
method.
boto3 documentation
# delete_comment_content method definition
def delete_comment_content(
self,
*,
commentId: str,
) -> DeleteCommentContentOutputTypeDef: # (1)
...
# delete_comment_content method usage example with argument unpacking
kwargs: DeleteCommentContentInputRequestTypeDef = { # (1)
"commentId": ...,
}
parent.delete_comment_content(**kwargs)
delete_file#
Deletes a specified file from a specified branch.
Type annotations and code completion for boto3.client("codecommit").delete_file
method.
boto3 documentation
# delete_file method definition
def delete_file(
self,
*,
repositoryName: str,
branchName: str,
filePath: str,
parentCommitId: str,
keepEmptyFolders: bool = ...,
commitMessage: str = ...,
name: str = ...,
email: str = ...,
) -> DeleteFileOutputTypeDef: # (1)
...
# delete_file method usage example with argument unpacking
kwargs: DeleteFileInputRequestTypeDef = { # (1)
"repositoryName": ...,
"branchName": ...,
"filePath": ...,
"parentCommitId": ...,
}
parent.delete_file(**kwargs)
delete_pull_request_approval_rule#
Deletes an approval rule from a specified pull request.
Type annotations and code completion for boto3.client("codecommit").delete_pull_request_approval_rule
method.
boto3 documentation
# delete_pull_request_approval_rule method definition
def delete_pull_request_approval_rule(
self,
*,
pullRequestId: str,
approvalRuleName: str,
) -> DeletePullRequestApprovalRuleOutputTypeDef: # (1)
...
# delete_pull_request_approval_rule method usage example with argument unpacking
kwargs: DeletePullRequestApprovalRuleInputRequestTypeDef = { # (1)
"pullRequestId": ...,
"approvalRuleName": ...,
}
parent.delete_pull_request_approval_rule(**kwargs)
delete_repository#
Deletes a repository.
Type annotations and code completion for boto3.client("codecommit").delete_repository
method.
boto3 documentation
# delete_repository method definition
def delete_repository(
self,
*,
repositoryName: str,
) -> DeleteRepositoryOutputTypeDef: # (1)
...
# delete_repository method usage example with argument unpacking
kwargs: DeleteRepositoryInputRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.delete_repository(**kwargs)
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.
Type annotations and code completion for boto3.client("codecommit").describe_merge_conflicts
method.
boto3 documentation
# describe_merge_conflicts method definition
def describe_merge_conflicts(
self,
*,
repositoryName: str,
destinationCommitSpecifier: str,
sourceCommitSpecifier: str,
mergeOption: MergeOptionTypeEnumType, # (1)
filePath: str,
maxMergeHunks: int = ...,
conflictDetailLevel: ConflictDetailLevelTypeEnumType = ..., # (2)
conflictResolutionStrategy: ConflictResolutionStrategyTypeEnumType = ..., # (3)
nextToken: str = ...,
) -> DescribeMergeConflictsOutputTypeDef: # (4)
...
- See MergeOptionTypeEnumType
- See ConflictDetailLevelTypeEnumType
- See ConflictResolutionStrategyTypeEnumType
- See DescribeMergeConflictsOutputTypeDef
# describe_merge_conflicts method usage example with argument unpacking
kwargs: DescribeMergeConflictsInputRequestTypeDef = { # (1)
"repositoryName": ...,
"destinationCommitSpecifier": ...,
"sourceCommitSpecifier": ...,
"mergeOption": ...,
"filePath": ...,
}
parent.describe_merge_conflicts(**kwargs)
describe_pull_request_events#
Returns information about one or more pull request events.
Type annotations and code completion for boto3.client("codecommit").describe_pull_request_events
method.
boto3 documentation
# describe_pull_request_events method definition
def describe_pull_request_events(
self,
*,
pullRequestId: str,
pullRequestEventType: PullRequestEventTypeType = ..., # (1)
actorArn: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> DescribePullRequestEventsOutputTypeDef: # (2)
...
# describe_pull_request_events method usage example with argument unpacking
kwargs: DescribePullRequestEventsInputRequestTypeDef = { # (1)
"pullRequestId": ...,
}
parent.describe_pull_request_events(**kwargs)
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.
Type annotations and code completion for boto3.client("codecommit").disassociate_approval_rule_template_from_repository
method.
boto3 documentation
# disassociate_approval_rule_template_from_repository method definition
def disassociate_approval_rule_template_from_repository(
self,
*,
approvalRuleTemplateName: str,
repositoryName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# disassociate_approval_rule_template_from_repository method usage example with argument unpacking
kwargs: DisassociateApprovalRuleTemplateFromRepositoryInputRequestTypeDef = { # (1)
"approvalRuleTemplateName": ...,
"repositoryName": ...,
}
parent.disassociate_approval_rule_template_from_repository(**kwargs)
evaluate_pull_request_approval_rules#
Evaluates whether a pull request has met all the conditions specified in its associated approval rules.
Type annotations and code completion for boto3.client("codecommit").evaluate_pull_request_approval_rules
method.
boto3 documentation
# evaluate_pull_request_approval_rules method definition
def evaluate_pull_request_approval_rules(
self,
*,
pullRequestId: str,
revisionId: str,
) -> EvaluatePullRequestApprovalRulesOutputTypeDef: # (1)
...
# evaluate_pull_request_approval_rules method usage example with argument unpacking
kwargs: EvaluatePullRequestApprovalRulesInputRequestTypeDef = { # (1)
"pullRequestId": ...,
"revisionId": ...,
}
parent.evaluate_pull_request_approval_rules(**kwargs)
get_approval_rule_template#
Returns information about a specified approval rule template.
Type annotations and code completion for boto3.client("codecommit").get_approval_rule_template
method.
boto3 documentation
# get_approval_rule_template method definition
def get_approval_rule_template(
self,
*,
approvalRuleTemplateName: str,
) -> GetApprovalRuleTemplateOutputTypeDef: # (1)
...
# get_approval_rule_template method usage example with argument unpacking
kwargs: GetApprovalRuleTemplateInputRequestTypeDef = { # (1)
"approvalRuleTemplateName": ...,
}
parent.get_approval_rule_template(**kwargs)
get_blob#
Returns the base-64 encoded content of an individual blob in a repository.
Type annotations and code completion for boto3.client("codecommit").get_blob
method.
boto3 documentation
# get_blob method definition
def get_blob(
self,
*,
repositoryName: str,
blobId: str,
) -> GetBlobOutputTypeDef: # (1)
...
# get_blob method usage example with argument unpacking
kwargs: GetBlobInputRequestTypeDef = { # (1)
"repositoryName": ...,
"blobId": ...,
}
parent.get_blob(**kwargs)
get_branch#
Returns information about a repository branch, including its name and the last commit ID.
Type annotations and code completion for boto3.client("codecommit").get_branch
method.
boto3 documentation
# get_branch method definition
def get_branch(
self,
*,
repositoryName: str = ...,
branchName: str = ...,
) -> GetBranchOutputTypeDef: # (1)
...
# get_branch method usage example with argument unpacking
kwargs: GetBranchInputRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.get_branch(**kwargs)
get_comment#
Returns the content of a comment made on a change, file, or commit in a repository.
Type annotations and code completion for boto3.client("codecommit").get_comment
method.
boto3 documentation
# get_comment method definition
def get_comment(
self,
*,
commentId: str,
) -> GetCommentOutputTypeDef: # (1)
...
# get_comment method usage example with argument unpacking
kwargs: GetCommentInputRequestTypeDef = { # (1)
"commentId": ...,
}
parent.get_comment(**kwargs)
get_comment_reactions#
Returns information about reactions to a specified comment ID.
Type annotations and code completion for boto3.client("codecommit").get_comment_reactions
method.
boto3 documentation
# get_comment_reactions method definition
def get_comment_reactions(
self,
*,
commentId: str,
reactionUserArn: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> GetCommentReactionsOutputTypeDef: # (1)
...
# get_comment_reactions method usage example with argument unpacking
kwargs: GetCommentReactionsInputRequestTypeDef = { # (1)
"commentId": ...,
}
parent.get_comment_reactions(**kwargs)
get_comments_for_compared_commit#
Returns information about comments made on the comparison between two commits.
Type annotations and code completion for boto3.client("codecommit").get_comments_for_compared_commit
method.
boto3 documentation
# get_comments_for_compared_commit method definition
def get_comments_for_compared_commit(
self,
*,
repositoryName: str,
afterCommitId: str,
beforeCommitId: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> GetCommentsForComparedCommitOutputTypeDef: # (1)
...
# get_comments_for_compared_commit method usage example with argument unpacking
kwargs: GetCommentsForComparedCommitInputRequestTypeDef = { # (1)
"repositoryName": ...,
"afterCommitId": ...,
}
parent.get_comments_for_compared_commit(**kwargs)
get_comments_for_pull_request#
Returns comments made on a pull request.
Type annotations and code completion for boto3.client("codecommit").get_comments_for_pull_request
method.
boto3 documentation
# get_comments_for_pull_request method definition
def get_comments_for_pull_request(
self,
*,
pullRequestId: str,
repositoryName: str = ...,
beforeCommitId: str = ...,
afterCommitId: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> GetCommentsForPullRequestOutputTypeDef: # (1)
...
# get_comments_for_pull_request method usage example with argument unpacking
kwargs: GetCommentsForPullRequestInputRequestTypeDef = { # (1)
"pullRequestId": ...,
}
parent.get_comments_for_pull_request(**kwargs)
get_commit#
Returns information about a commit, including commit message and committer information.
Type annotations and code completion for boto3.client("codecommit").get_commit
method.
boto3 documentation
# get_commit method definition
def get_commit(
self,
*,
repositoryName: str,
commitId: str,
) -> GetCommitOutputTypeDef: # (1)
...
# get_commit method usage example with argument unpacking
kwargs: GetCommitInputRequestTypeDef = { # (1)
"repositoryName": ...,
"commitId": ...,
}
parent.get_commit(**kwargs)
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).
Type annotations and code completion for boto3.client("codecommit").get_differences
method.
boto3 documentation
# get_differences method definition
def get_differences(
self,
*,
repositoryName: str,
afterCommitSpecifier: str,
beforeCommitSpecifier: str = ...,
beforePath: str = ...,
afterPath: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> GetDifferencesOutputTypeDef: # (1)
...
# get_differences method usage example with argument unpacking
kwargs: GetDifferencesInputRequestTypeDef = { # (1)
"repositoryName": ...,
"afterCommitSpecifier": ...,
}
parent.get_differences(**kwargs)
get_file#
Returns the base-64 encoded contents of a specified file and its metadata.
Type annotations and code completion for boto3.client("codecommit").get_file
method.
boto3 documentation
# get_file method definition
def get_file(
self,
*,
repositoryName: str,
filePath: str,
commitSpecifier: str = ...,
) -> GetFileOutputTypeDef: # (1)
...
# get_file method usage example with argument unpacking
kwargs: GetFileInputRequestTypeDef = { # (1)
"repositoryName": ...,
"filePath": ...,
}
parent.get_file(**kwargs)
get_folder#
Returns the contents of a specified folder in a repository.
Type annotations and code completion for boto3.client("codecommit").get_folder
method.
boto3 documentation
# get_folder method definition
def get_folder(
self,
*,
repositoryName: str,
folderPath: str,
commitSpecifier: str = ...,
) -> GetFolderOutputTypeDef: # (1)
...
# get_folder method usage example with argument unpacking
kwargs: GetFolderInputRequestTypeDef = { # (1)
"repositoryName": ...,
"folderPath": ...,
}
parent.get_folder(**kwargs)
get_merge_commit#
Returns information about a specified merge commit.
Type annotations and code completion for boto3.client("codecommit").get_merge_commit
method.
boto3 documentation
# get_merge_commit method definition
def get_merge_commit(
self,
*,
repositoryName: str,
sourceCommitSpecifier: str,
destinationCommitSpecifier: str,
conflictDetailLevel: ConflictDetailLevelTypeEnumType = ..., # (1)
conflictResolutionStrategy: ConflictResolutionStrategyTypeEnumType = ..., # (2)
) -> GetMergeCommitOutputTypeDef: # (3)
...
- See ConflictDetailLevelTypeEnumType
- See ConflictResolutionStrategyTypeEnumType
- See GetMergeCommitOutputTypeDef
# get_merge_commit method usage example with argument unpacking
kwargs: GetMergeCommitInputRequestTypeDef = { # (1)
"repositoryName": ...,
"sourceCommitSpecifier": ...,
"destinationCommitSpecifier": ...,
}
parent.get_merge_commit(**kwargs)
get_merge_conflicts#
Returns information about merge conflicts between the before and after commit IDs for a pull request in a repository.
Type annotations and code completion for boto3.client("codecommit").get_merge_conflicts
method.
boto3 documentation
# get_merge_conflicts method definition
def get_merge_conflicts(
self,
*,
repositoryName: str,
destinationCommitSpecifier: str,
sourceCommitSpecifier: str,
mergeOption: MergeOptionTypeEnumType, # (1)
conflictDetailLevel: ConflictDetailLevelTypeEnumType = ..., # (2)
maxConflictFiles: int = ...,
conflictResolutionStrategy: ConflictResolutionStrategyTypeEnumType = ..., # (3)
nextToken: str = ...,
) -> GetMergeConflictsOutputTypeDef: # (4)
...
- See MergeOptionTypeEnumType
- See ConflictDetailLevelTypeEnumType
- See ConflictResolutionStrategyTypeEnumType
- See GetMergeConflictsOutputTypeDef
# get_merge_conflicts method usage example with argument unpacking
kwargs: GetMergeConflictsInputRequestTypeDef = { # (1)
"repositoryName": ...,
"destinationCommitSpecifier": ...,
"sourceCommitSpecifier": ...,
"mergeOption": ...,
}
parent.get_merge_conflicts(**kwargs)
get_merge_options#
Returns information about the merge options available for merging two specified branches.
Type annotations and code completion for boto3.client("codecommit").get_merge_options
method.
boto3 documentation
# get_merge_options method definition
def get_merge_options(
self,
*,
repositoryName: str,
sourceCommitSpecifier: str,
destinationCommitSpecifier: str,
conflictDetailLevel: ConflictDetailLevelTypeEnumType = ..., # (1)
conflictResolutionStrategy: ConflictResolutionStrategyTypeEnumType = ..., # (2)
) -> GetMergeOptionsOutputTypeDef: # (3)
...
- See ConflictDetailLevelTypeEnumType
- See ConflictResolutionStrategyTypeEnumType
- See GetMergeOptionsOutputTypeDef
# get_merge_options method usage example with argument unpacking
kwargs: GetMergeOptionsInputRequestTypeDef = { # (1)
"repositoryName": ...,
"sourceCommitSpecifier": ...,
"destinationCommitSpecifier": ...,
}
parent.get_merge_options(**kwargs)
get_pull_request#
Gets information about a pull request in a specified repository.
Type annotations and code completion for boto3.client("codecommit").get_pull_request
method.
boto3 documentation
# get_pull_request method definition
def get_pull_request(
self,
*,
pullRequestId: str,
) -> GetPullRequestOutputTypeDef: # (1)
...
# get_pull_request method usage example with argument unpacking
kwargs: GetPullRequestInputRequestTypeDef = { # (1)
"pullRequestId": ...,
}
parent.get_pull_request(**kwargs)
get_pull_request_approval_states#
Gets information about the approval states for a specified pull request.
Type annotations and code completion for boto3.client("codecommit").get_pull_request_approval_states
method.
boto3 documentation
# get_pull_request_approval_states method definition
def get_pull_request_approval_states(
self,
*,
pullRequestId: str,
revisionId: str,
) -> GetPullRequestApprovalStatesOutputTypeDef: # (1)
...
# get_pull_request_approval_states method usage example with argument unpacking
kwargs: GetPullRequestApprovalStatesInputRequestTypeDef = { # (1)
"pullRequestId": ...,
"revisionId": ...,
}
parent.get_pull_request_approval_states(**kwargs)
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.
Type annotations and code completion for boto3.client("codecommit").get_pull_request_override_state
method.
boto3 documentation
# get_pull_request_override_state method definition
def get_pull_request_override_state(
self,
*,
pullRequestId: str,
revisionId: str,
) -> GetPullRequestOverrideStateOutputTypeDef: # (1)
...
# get_pull_request_override_state method usage example with argument unpacking
kwargs: GetPullRequestOverrideStateInputRequestTypeDef = { # (1)
"pullRequestId": ...,
"revisionId": ...,
}
parent.get_pull_request_override_state(**kwargs)
get_repository#
Returns information about a repository.
Type annotations and code completion for boto3.client("codecommit").get_repository
method.
boto3 documentation
# get_repository method definition
def get_repository(
self,
*,
repositoryName: str,
) -> GetRepositoryOutputTypeDef: # (1)
...
# get_repository method usage example with argument unpacking
kwargs: GetRepositoryInputRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.get_repository(**kwargs)
get_repository_triggers#
Gets information about triggers configured for a repository.
Type annotations and code completion for boto3.client("codecommit").get_repository_triggers
method.
boto3 documentation
# get_repository_triggers method definition
def get_repository_triggers(
self,
*,
repositoryName: str,
) -> GetRepositoryTriggersOutputTypeDef: # (1)
...
# get_repository_triggers method usage example with argument unpacking
kwargs: GetRepositoryTriggersInputRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.get_repository_triggers(**kwargs)
list_approval_rule_templates#
Lists all approval rule templates in the specified Amazon Web Services Region in your Amazon Web Services account.
Type annotations and code completion for boto3.client("codecommit").list_approval_rule_templates
method.
boto3 documentation
# list_approval_rule_templates method definition
def list_approval_rule_templates(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListApprovalRuleTemplatesOutputTypeDef: # (1)
...
# list_approval_rule_templates method usage example with argument unpacking
kwargs: ListApprovalRuleTemplatesInputRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_approval_rule_templates(**kwargs)
list_associated_approval_rule_templates_for_repository#
Lists all approval rule templates that are associated with a specified repository.
Type annotations and code completion for boto3.client("codecommit").list_associated_approval_rule_templates_for_repository
method.
boto3 documentation
# list_associated_approval_rule_templates_for_repository method definition
def list_associated_approval_rule_templates_for_repository(
self,
*,
repositoryName: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListAssociatedApprovalRuleTemplatesForRepositoryOutputTypeDef: # (1)
...
# list_associated_approval_rule_templates_for_repository method usage example with argument unpacking
kwargs: ListAssociatedApprovalRuleTemplatesForRepositoryInputRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.list_associated_approval_rule_templates_for_repository(**kwargs)
list_branches#
Gets information about one or more branches in a repository.
Type annotations and code completion for boto3.client("codecommit").list_branches
method.
boto3 documentation
# list_branches method definition
def list_branches(
self,
*,
repositoryName: str,
nextToken: str = ...,
) -> ListBranchesOutputTypeDef: # (1)
...
# list_branches method usage example with argument unpacking
kwargs: ListBranchesInputRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.list_branches(**kwargs)
list_file_commit_history#
Retrieves a list of commits and changes to a specified file.
Type annotations and code completion for boto3.client("codecommit").list_file_commit_history
method.
boto3 documentation
# list_file_commit_history method definition
def list_file_commit_history(
self,
*,
repositoryName: str,
filePath: str,
commitSpecifier: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListFileCommitHistoryResponseTypeDef: # (1)
...
# list_file_commit_history method usage example with argument unpacking
kwargs: ListFileCommitHistoryRequestRequestTypeDef = { # (1)
"repositoryName": ...,
"filePath": ...,
}
parent.list_file_commit_history(**kwargs)
list_pull_requests#
Returns a list of pull requests for a specified repository.
Type annotations and code completion for boto3.client("codecommit").list_pull_requests
method.
boto3 documentation
# list_pull_requests method definition
def list_pull_requests(
self,
*,
repositoryName: str,
authorArn: str = ...,
pullRequestStatus: PullRequestStatusEnumType = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListPullRequestsOutputTypeDef: # (2)
...
# list_pull_requests method usage example with argument unpacking
kwargs: ListPullRequestsInputRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.list_pull_requests(**kwargs)
list_repositories#
Gets information about one or more repositories.
Type annotations and code completion for boto3.client("codecommit").list_repositories
method.
boto3 documentation
# list_repositories method definition
def list_repositories(
self,
*,
nextToken: str = ...,
sortBy: SortByEnumType = ..., # (1)
order: OrderEnumType = ..., # (2)
) -> ListRepositoriesOutputTypeDef: # (3)
...
- See SortByEnumType
- See OrderEnumType
- See ListRepositoriesOutputTypeDef
# list_repositories method usage example with argument unpacking
kwargs: ListRepositoriesInputRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_repositories(**kwargs)
list_repositories_for_approval_rule_template#
Lists all repositories associated with the specified approval rule template.
Type annotations and code completion for boto3.client("codecommit").list_repositories_for_approval_rule_template
method.
boto3 documentation
# list_repositories_for_approval_rule_template method definition
def list_repositories_for_approval_rule_template(
self,
*,
approvalRuleTemplateName: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListRepositoriesForApprovalRuleTemplateOutputTypeDef: # (1)
...
# list_repositories_for_approval_rule_template method usage example with argument unpacking
kwargs: ListRepositoriesForApprovalRuleTemplateInputRequestTypeDef = { # (1)
"approvalRuleTemplateName": ...,
}
parent.list_repositories_for_approval_rule_template(**kwargs)
list_tags_for_resource#
Gets information about Amazon Web Servicestags for a specified Amazon Resource Name (ARN) in CodeCommit.
Type annotations and code completion for boto3.client("codecommit").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceArn: str,
nextToken: str = ...,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
merge_branches_by_fast_forward#
Merges two branches using the fast-forward merge strategy.
Type annotations and code completion for boto3.client("codecommit").merge_branches_by_fast_forward
method.
boto3 documentation
# merge_branches_by_fast_forward method definition
def merge_branches_by_fast_forward(
self,
*,
repositoryName: str,
sourceCommitSpecifier: str,
destinationCommitSpecifier: str,
targetBranch: str = ...,
) -> MergeBranchesByFastForwardOutputTypeDef: # (1)
...
# merge_branches_by_fast_forward method usage example with argument unpacking
kwargs: MergeBranchesByFastForwardInputRequestTypeDef = { # (1)
"repositoryName": ...,
"sourceCommitSpecifier": ...,
"destinationCommitSpecifier": ...,
}
parent.merge_branches_by_fast_forward(**kwargs)
merge_branches_by_squash#
Merges two branches using the squash merge strategy.
Type annotations and code completion for boto3.client("codecommit").merge_branches_by_squash
method.
boto3 documentation
# merge_branches_by_squash method definition
def merge_branches_by_squash(
self,
*,
repositoryName: str,
sourceCommitSpecifier: str,
destinationCommitSpecifier: str,
targetBranch: str = ...,
conflictDetailLevel: ConflictDetailLevelTypeEnumType = ..., # (1)
conflictResolutionStrategy: ConflictResolutionStrategyTypeEnumType = ..., # (2)
authorName: str = ...,
email: str = ...,
commitMessage: str = ...,
keepEmptyFolders: bool = ...,
conflictResolution: ConflictResolutionTypeDef = ..., # (3)
) -> MergeBranchesBySquashOutputTypeDef: # (4)
...
- See ConflictDetailLevelTypeEnumType
- See ConflictResolutionStrategyTypeEnumType
- See ConflictResolutionTypeDef
- See MergeBranchesBySquashOutputTypeDef
# merge_branches_by_squash method usage example with argument unpacking
kwargs: MergeBranchesBySquashInputRequestTypeDef = { # (1)
"repositoryName": ...,
"sourceCommitSpecifier": ...,
"destinationCommitSpecifier": ...,
}
parent.merge_branches_by_squash(**kwargs)
merge_branches_by_three_way#
Merges two specified branches using the three-way merge strategy.
Type annotations and code completion for boto3.client("codecommit").merge_branches_by_three_way
method.
boto3 documentation
# merge_branches_by_three_way method definition
def merge_branches_by_three_way(
self,
*,
repositoryName: str,
sourceCommitSpecifier: str,
destinationCommitSpecifier: str,
targetBranch: str = ...,
conflictDetailLevel: ConflictDetailLevelTypeEnumType = ..., # (1)
conflictResolutionStrategy: ConflictResolutionStrategyTypeEnumType = ..., # (2)
authorName: str = ...,
email: str = ...,
commitMessage: str = ...,
keepEmptyFolders: bool = ...,
conflictResolution: ConflictResolutionTypeDef = ..., # (3)
) -> MergeBranchesByThreeWayOutputTypeDef: # (4)
...
- See ConflictDetailLevelTypeEnumType
- See ConflictResolutionStrategyTypeEnumType
- See ConflictResolutionTypeDef
- See MergeBranchesByThreeWayOutputTypeDef
# merge_branches_by_three_way method usage example with argument unpacking
kwargs: MergeBranchesByThreeWayInputRequestTypeDef = { # (1)
"repositoryName": ...,
"sourceCommitSpecifier": ...,
"destinationCommitSpecifier": ...,
}
parent.merge_branches_by_three_way(**kwargs)
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.
Type annotations and code completion for boto3.client("codecommit").merge_pull_request_by_fast_forward
method.
boto3 documentation
# merge_pull_request_by_fast_forward method definition
def merge_pull_request_by_fast_forward(
self,
*,
pullRequestId: str,
repositoryName: str,
sourceCommitId: str = ...,
) -> MergePullRequestByFastForwardOutputTypeDef: # (1)
...
# merge_pull_request_by_fast_forward method usage example with argument unpacking
kwargs: MergePullRequestByFastForwardInputRequestTypeDef = { # (1)
"pullRequestId": ...,
"repositoryName": ...,
}
parent.merge_pull_request_by_fast_forward(**kwargs)
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.
Type annotations and code completion for boto3.client("codecommit").merge_pull_request_by_squash
method.
boto3 documentation
# merge_pull_request_by_squash method definition
def merge_pull_request_by_squash(
self,
*,
pullRequestId: str,
repositoryName: str,
sourceCommitId: str = ...,
conflictDetailLevel: ConflictDetailLevelTypeEnumType = ..., # (1)
conflictResolutionStrategy: ConflictResolutionStrategyTypeEnumType = ..., # (2)
commitMessage: str = ...,
authorName: str = ...,
email: str = ...,
keepEmptyFolders: bool = ...,
conflictResolution: ConflictResolutionTypeDef = ..., # (3)
) -> MergePullRequestBySquashOutputTypeDef: # (4)
...
- See ConflictDetailLevelTypeEnumType
- See ConflictResolutionStrategyTypeEnumType
- See ConflictResolutionTypeDef
- See MergePullRequestBySquashOutputTypeDef
# merge_pull_request_by_squash method usage example with argument unpacking
kwargs: MergePullRequestBySquashInputRequestTypeDef = { # (1)
"pullRequestId": ...,
"repositoryName": ...,
}
parent.merge_pull_request_by_squash(**kwargs)
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.
Type annotations and code completion for boto3.client("codecommit").merge_pull_request_by_three_way
method.
boto3 documentation
# merge_pull_request_by_three_way method definition
def merge_pull_request_by_three_way(
self,
*,
pullRequestId: str,
repositoryName: str,
sourceCommitId: str = ...,
conflictDetailLevel: ConflictDetailLevelTypeEnumType = ..., # (1)
conflictResolutionStrategy: ConflictResolutionStrategyTypeEnumType = ..., # (2)
commitMessage: str = ...,
authorName: str = ...,
email: str = ...,
keepEmptyFolders: bool = ...,
conflictResolution: ConflictResolutionTypeDef = ..., # (3)
) -> MergePullRequestByThreeWayOutputTypeDef: # (4)
...
- See ConflictDetailLevelTypeEnumType
- See ConflictResolutionStrategyTypeEnumType
- See ConflictResolutionTypeDef
- See MergePullRequestByThreeWayOutputTypeDef
# merge_pull_request_by_three_way method usage example with argument unpacking
kwargs: MergePullRequestByThreeWayInputRequestTypeDef = { # (1)
"pullRequestId": ...,
"repositoryName": ...,
}
parent.merge_pull_request_by_three_way(**kwargs)
override_pull_request_approval_rules#
Sets aside (overrides) all approval rule requirements for a specified pull request.
Type annotations and code completion for boto3.client("codecommit").override_pull_request_approval_rules
method.
boto3 documentation
# override_pull_request_approval_rules method definition
def override_pull_request_approval_rules(
self,
*,
pullRequestId: str,
revisionId: str,
overrideStatus: OverrideStatusType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# override_pull_request_approval_rules method usage example with argument unpacking
kwargs: OverridePullRequestApprovalRulesInputRequestTypeDef = { # (1)
"pullRequestId": ...,
"revisionId": ...,
"overrideStatus": ...,
}
parent.override_pull_request_approval_rules(**kwargs)
post_comment_for_compared_commit#
Posts a comment on the comparison between two commits.
Type annotations and code completion for boto3.client("codecommit").post_comment_for_compared_commit
method.
boto3 documentation
# post_comment_for_compared_commit method definition
def post_comment_for_compared_commit(
self,
*,
repositoryName: str,
afterCommitId: str,
content: str,
beforeCommitId: str = ...,
location: LocationTypeDef = ..., # (1)
clientRequestToken: str = ...,
) -> PostCommentForComparedCommitOutputTypeDef: # (2)
...
# post_comment_for_compared_commit method usage example with argument unpacking
kwargs: PostCommentForComparedCommitInputRequestTypeDef = { # (1)
"repositoryName": ...,
"afterCommitId": ...,
"content": ...,
}
parent.post_comment_for_compared_commit(**kwargs)
post_comment_for_pull_request#
Posts a comment on a pull request.
Type annotations and code completion for boto3.client("codecommit").post_comment_for_pull_request
method.
boto3 documentation
# post_comment_for_pull_request method definition
def post_comment_for_pull_request(
self,
*,
pullRequestId: str,
repositoryName: str,
beforeCommitId: str,
afterCommitId: str,
content: str,
location: LocationTypeDef = ..., # (1)
clientRequestToken: str = ...,
) -> PostCommentForPullRequestOutputTypeDef: # (2)
...
# post_comment_for_pull_request method usage example with argument unpacking
kwargs: PostCommentForPullRequestInputRequestTypeDef = { # (1)
"pullRequestId": ...,
"repositoryName": ...,
"beforeCommitId": ...,
"afterCommitId": ...,
"content": ...,
}
parent.post_comment_for_pull_request(**kwargs)
post_comment_reply#
Posts a comment in reply to an existing comment on a comparison between commits or a pull request.
Type annotations and code completion for boto3.client("codecommit").post_comment_reply
method.
boto3 documentation
# post_comment_reply method definition
def post_comment_reply(
self,
*,
inReplyTo: str,
content: str,
clientRequestToken: str = ...,
) -> PostCommentReplyOutputTypeDef: # (1)
...
# post_comment_reply method usage example with argument unpacking
kwargs: PostCommentReplyInputRequestTypeDef = { # (1)
"inReplyTo": ...,
"content": ...,
}
parent.post_comment_reply(**kwargs)
put_comment_reaction#
Adds or updates a reaction to a specified comment for the user whose identity is used to make the request.
Type annotations and code completion for boto3.client("codecommit").put_comment_reaction
method.
boto3 documentation
# put_comment_reaction method definition
def put_comment_reaction(
self,
*,
commentId: str,
reactionValue: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# put_comment_reaction method usage example with argument unpacking
kwargs: PutCommentReactionInputRequestTypeDef = { # (1)
"commentId": ...,
"reactionValue": ...,
}
parent.put_comment_reaction(**kwargs)
put_file#
Adds or updates a file in a branch in an CodeCommit repository, and generates a commit for the addition in the specified branch.
Type annotations and code completion for boto3.client("codecommit").put_file
method.
boto3 documentation
# put_file method definition
def put_file(
self,
*,
repositoryName: str,
branchName: str,
fileContent: BlobTypeDef,
filePath: str,
fileMode: FileModeTypeEnumType = ..., # (1)
parentCommitId: str = ...,
commitMessage: str = ...,
name: str = ...,
email: str = ...,
) -> PutFileOutputTypeDef: # (2)
...
# put_file method usage example with argument unpacking
kwargs: PutFileInputRequestTypeDef = { # (1)
"repositoryName": ...,
"branchName": ...,
"fileContent": ...,
"filePath": ...,
}
parent.put_file(**kwargs)
put_repository_triggers#
Replaces all triggers for a repository.
Type annotations and code completion for boto3.client("codecommit").put_repository_triggers
method.
boto3 documentation
# put_repository_triggers method definition
def put_repository_triggers(
self,
*,
repositoryName: str,
triggers: Sequence[RepositoryTriggerUnionTypeDef], # (1)
) -> PutRepositoryTriggersOutputTypeDef: # (2)
...
# put_repository_triggers method usage example with argument unpacking
kwargs: PutRepositoryTriggersInputRequestTypeDef = { # (1)
"repositoryName": ...,
"triggers": ...,
}
parent.put_repository_triggers(**kwargs)
tag_resource#
Adds or updates tags for a resource in CodeCommit.
Type annotations and code completion for boto3.client("codecommit").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
test_repository_triggers#
Tests the functionality of repository triggers by sending information to the trigger target.
Type annotations and code completion for boto3.client("codecommit").test_repository_triggers
method.
boto3 documentation
# test_repository_triggers method definition
def test_repository_triggers(
self,
*,
repositoryName: str,
triggers: Sequence[RepositoryTriggerTypeDef], # (1)
) -> TestRepositoryTriggersOutputTypeDef: # (2)
...
# test_repository_triggers method usage example with argument unpacking
kwargs: TestRepositoryTriggersInputRequestTypeDef = { # (1)
"repositoryName": ...,
"triggers": ...,
}
parent.test_repository_triggers(**kwargs)
untag_resource#
Removes tags for a resource in CodeCommit.
Type annotations and code completion for boto3.client("codecommit").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_approval_rule_template_content#
Updates the content of an approval rule template.
Type annotations and code completion for boto3.client("codecommit").update_approval_rule_template_content
method.
boto3 documentation
# update_approval_rule_template_content method definition
def update_approval_rule_template_content(
self,
*,
approvalRuleTemplateName: str,
newRuleContent: str,
existingRuleContentSha256: str = ...,
) -> UpdateApprovalRuleTemplateContentOutputTypeDef: # (1)
...
# update_approval_rule_template_content method usage example with argument unpacking
kwargs: UpdateApprovalRuleTemplateContentInputRequestTypeDef = { # (1)
"approvalRuleTemplateName": ...,
"newRuleContent": ...,
}
parent.update_approval_rule_template_content(**kwargs)
update_approval_rule_template_description#
Updates the description for a specified approval rule template.
Type annotations and code completion for boto3.client("codecommit").update_approval_rule_template_description
method.
boto3 documentation
# update_approval_rule_template_description method definition
def update_approval_rule_template_description(
self,
*,
approvalRuleTemplateName: str,
approvalRuleTemplateDescription: str,
) -> UpdateApprovalRuleTemplateDescriptionOutputTypeDef: # (1)
...
# update_approval_rule_template_description method usage example with argument unpacking
kwargs: UpdateApprovalRuleTemplateDescriptionInputRequestTypeDef = { # (1)
"approvalRuleTemplateName": ...,
"approvalRuleTemplateDescription": ...,
}
parent.update_approval_rule_template_description(**kwargs)
update_approval_rule_template_name#
Updates the name of a specified approval rule template.
Type annotations and code completion for boto3.client("codecommit").update_approval_rule_template_name
method.
boto3 documentation
# update_approval_rule_template_name method definition
def update_approval_rule_template_name(
self,
*,
oldApprovalRuleTemplateName: str,
newApprovalRuleTemplateName: str,
) -> UpdateApprovalRuleTemplateNameOutputTypeDef: # (1)
...
# update_approval_rule_template_name method usage example with argument unpacking
kwargs: UpdateApprovalRuleTemplateNameInputRequestTypeDef = { # (1)
"oldApprovalRuleTemplateName": ...,
"newApprovalRuleTemplateName": ...,
}
parent.update_approval_rule_template_name(**kwargs)
update_comment#
Replaces the contents of a comment.
Type annotations and code completion for boto3.client("codecommit").update_comment
method.
boto3 documentation
# update_comment method definition
def update_comment(
self,
*,
commentId: str,
content: str,
) -> UpdateCommentOutputTypeDef: # (1)
...
# update_comment method usage example with argument unpacking
kwargs: UpdateCommentInputRequestTypeDef = { # (1)
"commentId": ...,
"content": ...,
}
parent.update_comment(**kwargs)
update_default_branch#
Sets or changes the default branch name for the specified repository.
Type annotations and code completion for boto3.client("codecommit").update_default_branch
method.
boto3 documentation
# update_default_branch method definition
def update_default_branch(
self,
*,
repositoryName: str,
defaultBranchName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# update_default_branch method usage example with argument unpacking
kwargs: UpdateDefaultBranchInputRequestTypeDef = { # (1)
"repositoryName": ...,
"defaultBranchName": ...,
}
parent.update_default_branch(**kwargs)
update_pull_request_approval_rule_content#
Updates the structure of an approval rule created specifically for a pull request.
Type annotations and code completion for boto3.client("codecommit").update_pull_request_approval_rule_content
method.
boto3 documentation
# update_pull_request_approval_rule_content method definition
def update_pull_request_approval_rule_content(
self,
*,
pullRequestId: str,
approvalRuleName: str,
newRuleContent: str,
existingRuleContentSha256: str = ...,
) -> UpdatePullRequestApprovalRuleContentOutputTypeDef: # (1)
...
# update_pull_request_approval_rule_content method usage example with argument unpacking
kwargs: UpdatePullRequestApprovalRuleContentInputRequestTypeDef = { # (1)
"pullRequestId": ...,
"approvalRuleName": ...,
"newRuleContent": ...,
}
parent.update_pull_request_approval_rule_content(**kwargs)
update_pull_request_approval_state#
Updates the state of a user's approval on a pull request.
Type annotations and code completion for boto3.client("codecommit").update_pull_request_approval_state
method.
boto3 documentation
# update_pull_request_approval_state method definition
def update_pull_request_approval_state(
self,
*,
pullRequestId: str,
revisionId: str,
approvalState: ApprovalStateType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# update_pull_request_approval_state method usage example with argument unpacking
kwargs: UpdatePullRequestApprovalStateInputRequestTypeDef = { # (1)
"pullRequestId": ...,
"revisionId": ...,
"approvalState": ...,
}
parent.update_pull_request_approval_state(**kwargs)
update_pull_request_description#
Replaces the contents of the description of a pull request.
Type annotations and code completion for boto3.client("codecommit").update_pull_request_description
method.
boto3 documentation
# update_pull_request_description method definition
def update_pull_request_description(
self,
*,
pullRequestId: str,
description: str,
) -> UpdatePullRequestDescriptionOutputTypeDef: # (1)
...
# update_pull_request_description method usage example with argument unpacking
kwargs: UpdatePullRequestDescriptionInputRequestTypeDef = { # (1)
"pullRequestId": ...,
"description": ...,
}
parent.update_pull_request_description(**kwargs)
update_pull_request_status#
Updates the status of a pull request.
Type annotations and code completion for boto3.client("codecommit").update_pull_request_status
method.
boto3 documentation
# update_pull_request_status method definition
def update_pull_request_status(
self,
*,
pullRequestId: str,
pullRequestStatus: PullRequestStatusEnumType, # (1)
) -> UpdatePullRequestStatusOutputTypeDef: # (2)
...
# update_pull_request_status method usage example with argument unpacking
kwargs: UpdatePullRequestStatusInputRequestTypeDef = { # (1)
"pullRequestId": ...,
"pullRequestStatus": ...,
}
parent.update_pull_request_status(**kwargs)
update_pull_request_title#
Replaces the title of a pull request.
Type annotations and code completion for boto3.client("codecommit").update_pull_request_title
method.
boto3 documentation
# update_pull_request_title method definition
def update_pull_request_title(
self,
*,
pullRequestId: str,
title: str,
) -> UpdatePullRequestTitleOutputTypeDef: # (1)
...
# update_pull_request_title method usage example with argument unpacking
kwargs: UpdatePullRequestTitleInputRequestTypeDef = { # (1)
"pullRequestId": ...,
"title": ...,
}
parent.update_pull_request_title(**kwargs)
update_repository_description#
Sets or changes the comment or description for a repository.
Type annotations and code completion for boto3.client("codecommit").update_repository_description
method.
boto3 documentation
# update_repository_description method definition
def update_repository_description(
self,
*,
repositoryName: str,
repositoryDescription: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# update_repository_description method usage example with argument unpacking
kwargs: UpdateRepositoryDescriptionInputRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.update_repository_description(**kwargs)
update_repository_encryption_key#
Updates the Key Management Service encryption key used to encrypt and decrypt a CodeCommit repository.
Type annotations and code completion for boto3.client("codecommit").update_repository_encryption_key
method.
boto3 documentation
# update_repository_encryption_key method definition
def update_repository_encryption_key(
self,
*,
repositoryName: str,
kmsKeyId: str,
) -> UpdateRepositoryEncryptionKeyOutputTypeDef: # (1)
...
# update_repository_encryption_key method usage example with argument unpacking
kwargs: UpdateRepositoryEncryptionKeyInputRequestTypeDef = { # (1)
"repositoryName": ...,
"kmsKeyId": ...,
}
parent.update_repository_encryption_key(**kwargs)
update_repository_name#
Renames a repository.
Type annotations and code completion for boto3.client("codecommit").update_repository_name
method.
boto3 documentation
# update_repository_name method definition
def update_repository_name(
self,
*,
oldName: str,
newName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# update_repository_name method usage example with argument unpacking
kwargs: UpdateRepositoryNameInputRequestTypeDef = { # (1)
"oldName": ...,
"newName": ...,
}
parent.update_repository_name(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("codecommit").get_paginator
method with overloads.
client.get_paginator("describe_pull_request_events")
-> DescribePullRequestEventsPaginatorclient.get_paginator("get_comments_for_compared_commit")
-> GetCommentsForComparedCommitPaginatorclient.get_paginator("get_comments_for_pull_request")
-> GetCommentsForPullRequestPaginatorclient.get_paginator("get_differences")
-> GetDifferencesPaginatorclient.get_paginator("list_branches")
-> ListBranchesPaginatorclient.get_paginator("list_pull_requests")
-> ListPullRequestsPaginatorclient.get_paginator("list_repositories")
-> ListRepositoriesPaginator