CodeCommitClient

Index > CodeCommit > CodeCommitClient

Auto-generated documentation for CodeCommit type annotations stubs module mypy-boto3-codecommit.

CodeCommitClient

Type annotations and code completion for boto3.client("codecommit"). boto3 documentation

Usage example

from boto3.session import Session
from mypy_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.

Usage example

client = boto3.client("codecommit")

try:
    do_something(client)
except (
    client.ActorDoesNotExistException,
    client.ApprovalRuleContentRequiredException,
    client.ApprovalRuleDoesNotExistException,
    client.ApprovalRuleNameAlreadyExistsException,
    client.ApprovalRuleNameRequiredException,
    client.ApprovalRuleTemplateContentRequiredException,
    client.ApprovalRuleTemplateDoesNotExistException,
    client.ApprovalRuleTemplateInUseException,
    client.ApprovalRuleTemplateNameAlreadyExistsException,
    client.ApprovalRuleTemplateNameRequiredException,
    client.ApprovalStateRequiredException,
    client.AuthorDoesNotExistException,
    client.BeforeCommitIdAndAfterCommitIdAreSameException,
    client.BlobIdDoesNotExistException,
    client.BlobIdRequiredException,
    client.BranchDoesNotExistException,
    client.BranchNameExistsException,
    client.BranchNameIsTagNameException,
    client.BranchNameRequiredException,
    client.CannotDeleteApprovalRuleFromTemplateException,
    client.CannotModifyApprovalRuleFromTemplateException,
    client.ClientError,
    client.ClientRequestTokenRequiredException,
    client.CommentContentRequiredException,
    client.CommentContentSizeLimitExceededException,
    client.CommentDeletedException,
    client.CommentDoesNotExistException,
    client.CommentIdRequiredException,
    client.CommentNotCreatedByCallerException,
    client.CommitDoesNotExistException,
    client.CommitIdDoesNotExistException,
    client.CommitIdRequiredException,
    client.CommitIdsLimitExceededException,
    client.CommitIdsListRequiredException,
    client.CommitMessageLengthExceededException,
    client.CommitRequiredException,
    client.ConcurrentReferenceUpdateException,
    client.DefaultBranchCannotBeDeletedException,
    client.DirectoryNameConflictsWithFileNameException,
    client.EncryptionIntegrityChecksFailedException,
    client.EncryptionKeyAccessDeniedException,
    client.EncryptionKeyDisabledException,
    client.EncryptionKeyNotFoundException,
    client.EncryptionKeyUnavailableException,
    client.FileContentAndSourceFileSpecifiedException,
    client.FileContentRequiredException,
    client.FileContentSizeLimitExceededException,
    client.FileDoesNotExistException,
    client.FileEntryRequiredException,
    client.FileModeRequiredException,
    client.FileNameConflictsWithDirectoryNameException,
    client.FilePathConflictsWithSubmodulePathException,
    client.FileTooLargeException,
    client.FolderContentSizeLimitExceededException,
    client.FolderDoesNotExistException,
    client.IdempotencyParameterMismatchException,
    client.InvalidActorArnException,
    client.InvalidApprovalRuleContentException,
    client.InvalidApprovalRuleNameException,
    client.InvalidApprovalRuleTemplateContentException,
    client.InvalidApprovalRuleTemplateDescriptionException,
    client.InvalidApprovalRuleTemplateNameException,
    client.InvalidApprovalStateException,
    client.InvalidAuthorArnException,
    client.InvalidBlobIdException,
    client.InvalidBranchNameException,
    client.InvalidClientRequestTokenException,
    client.InvalidCommentIdException,
    client.InvalidCommitException,
    client.InvalidCommitIdException,
    client.InvalidConflictDetailLevelException,
    client.InvalidConflictResolutionException,
    client.InvalidConflictResolutionStrategyException,
    client.InvalidContinuationTokenException,
    client.InvalidDeletionParameterException,
    client.InvalidDescriptionException,
    client.InvalidDestinationCommitSpecifierException,
    client.InvalidEmailException,
    client.InvalidFileLocationException,
    client.InvalidFileModeException,
    client.InvalidFilePositionException,
    client.InvalidMaxConflictFilesException,
    client.InvalidMaxMergeHunksException,
    client.InvalidMaxResultsException,
    client.InvalidMergeOptionException,
    client.InvalidOrderException,
    client.InvalidOverrideStatusException,
    client.InvalidParentCommitIdException,
    client.InvalidPathException,
    client.InvalidPullRequestEventTypeException,
    client.InvalidPullRequestIdException,
    client.InvalidPullRequestStatusException,
    client.InvalidPullRequestStatusUpdateException,
    client.InvalidReactionUserArnException,
    client.InvalidReactionValueException,
    client.InvalidReferenceNameException,
    client.InvalidRelativeFileVersionEnumException,
    client.InvalidReplacementContentException,
    client.InvalidReplacementTypeException,
    client.InvalidRepositoryDescriptionException,
    client.InvalidRepositoryNameException,
    client.InvalidRepositoryTriggerBranchNameException,
    client.InvalidRepositoryTriggerCustomDataException,
    client.InvalidRepositoryTriggerDestinationArnException,
    client.InvalidRepositoryTriggerEventsException,
    client.InvalidRepositoryTriggerNameException,
    client.InvalidRepositoryTriggerRegionException,
    client.InvalidResourceArnException,
    client.InvalidRevisionIdException,
    client.InvalidRuleContentSha256Exception,
    client.InvalidSortByException,
    client.InvalidSourceCommitSpecifierException,
    client.InvalidSystemTagUsageException,
    client.InvalidTagKeysListException,
    client.InvalidTagsMapException,
    client.InvalidTargetBranchException,
    client.InvalidTargetException,
    client.InvalidTargetsException,
    client.InvalidTitleException,
    client.ManualMergeRequiredException,
    client.MaximumBranchesExceededException,
    client.MaximumConflictResolutionEntriesExceededException,
    client.MaximumFileContentToLoadExceededException,
    client.MaximumFileEntriesExceededException,
    client.MaximumItemsToCompareExceededException,
    client.MaximumNumberOfApprovalsExceededException,
    client.MaximumOpenPullRequestsExceededException,
    client.MaximumRepositoryNamesExceededException,
    client.MaximumRepositoryTriggersExceededException,
    client.MaximumRuleTemplatesAssociatedWithRepositoryException,
    client.MergeOptionRequiredException,
    client.MultipleConflictResolutionEntriesException,
    client.MultipleRepositoriesInPullRequestException,
    client.NameLengthExceededException,
    client.NoChangeException,
    client.NumberOfRuleTemplatesExceededException,
    client.NumberOfRulesExceededException,
    client.OverrideAlreadySetException,
    client.OverrideStatusRequiredException,
    client.ParentCommitDoesNotExistException,
    client.ParentCommitIdOutdatedException,
    client.ParentCommitIdRequiredException,
    client.PathDoesNotExistException,
    client.PathRequiredException,
    client.PullRequestAlreadyClosedException,
    client.PullRequestApprovalRulesNotSatisfiedException,
    client.PullRequestCannotBeApprovedByAuthorException,
    client.PullRequestDoesNotExistException,
    client.PullRequestIdRequiredException,
    client.PullRequestStatusRequiredException,
    client.PutFileEntryConflictException,
    client.ReactionLimitExceededException,
    client.ReactionValueRequiredException,
    client.ReferenceDoesNotExistException,
    client.ReferenceNameRequiredException,
    client.ReferenceTypeNotSupportedException,
    client.ReplacementContentRequiredException,
    client.ReplacementTypeRequiredException,
    client.RepositoryDoesNotExistException,
    client.RepositoryLimitExceededException,
    client.RepositoryNameExistsException,
    client.RepositoryNameRequiredException,
    client.RepositoryNamesRequiredException,
    client.RepositoryNotAssociatedWithPullRequestException,
    client.RepositoryTriggerBranchNameListRequiredException,
    client.RepositoryTriggerDestinationArnRequiredException,
    client.RepositoryTriggerEventsListRequiredException,
    client.RepositoryTriggerNameRequiredException,
    client.RepositoryTriggersListRequiredException,
    client.ResourceArnRequiredException,
    client.RestrictedSourceFileException,
    client.RevisionIdRequiredException,
    client.RevisionNotCurrentException,
    client.SameFileContentException,
    client.SamePathRequestException,
    client.SourceAndDestinationAreSameException,
    client.SourceFileOrContentRequiredException,
    client.TagKeysListRequiredException,
    client.TagPolicyException,
    client.TagsMapRequiredException,
    client.TargetRequiredException,
    client.TargetsRequiredException,
    client.TipOfSourceReferenceIsDifferentException,
    client.TipsDivergenceExceededException,
    client.TitleRequiredException,
    client.TooManyTagsException,
) as e:
    print(e)

Type checking example

from mypy_boto3_codecommit.client import Exceptions

def handle_error(exc: Exceptions.ActorDoesNotExistException) -> None:
    ...

Methods

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

Method definition

def associate_approval_rule_template_with_repository(
    self,
    *,
    approvalRuleTemplateName: str,
    repositoryName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: AssociateApprovalRuleTemplateWithRepositoryInputRequestTypeDef = {  # (1)
    "approvalRuleTemplateName": ...,
    "repositoryName": ...,
}

parent.associate_approval_rule_template_with_repository(**kwargs)

1. See AssociateApprovalRuleTemplateWithRepositoryInputRequestTypeDef

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

Method definition

def batch_associate_approval_rule_template_with_repositories(
    self,
    *,
    approvalRuleTemplateName: str,
    repositoryNames: Sequence[str],
) -> BatchAssociateApprovalRuleTemplateWithRepositoriesOutputTypeDef:  # (1)
    ...

1. See BatchAssociateApprovalRuleTemplateWithRepositoriesOutputTypeDef

Usage example with kwargs

kwargs: BatchAssociateApprovalRuleTemplateWithRepositoriesInputRequestTypeDef = {  # (1)
    "approvalRuleTemplateName": ...,
    "repositoryNames": ...,
}

parent.batch_associate_approval_rule_template_with_repositories(**kwargs)

1. See BatchAssociateApprovalRuleTemplateWithRepositoriesInputRequestTypeDef

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

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

1. See MergeOptionTypeEnumType
2. See ConflictDetailLevelTypeEnumType
3. See ConflictResolutionStrategyTypeEnumType
4. See BatchDescribeMergeConflictsOutputTypeDef

Usage example with kwargs

kwargs: BatchDescribeMergeConflictsInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "destinationCommitSpecifier": ...,
    "sourceCommitSpecifier": ...,
    "mergeOption": ...,
}

parent.batch_describe_merge_conflicts(**kwargs)

1. See BatchDescribeMergeConflictsInputRequestTypeDef

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

Method definition

def batch_disassociate_approval_rule_template_from_repositories(
    self,
    *,
    approvalRuleTemplateName: str,
    repositoryNames: Sequence[str],
) -> BatchDisassociateApprovalRuleTemplateFromRepositoriesOutputTypeDef:  # (1)
    ...

1. See BatchDisassociateApprovalRuleTemplateFromRepositoriesOutputTypeDef

Usage example with kwargs

kwargs: BatchDisassociateApprovalRuleTemplateFromRepositoriesInputRequestTypeDef = {  # (1)
    "approvalRuleTemplateName": ...,
    "repositoryNames": ...,
}

parent.batch_disassociate_approval_rule_template_from_repositories(**kwargs)

1. See BatchDisassociateApprovalRuleTemplateFromRepositoriesInputRequestTypeDef

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

Method definition

def batch_get_commits(
    self,
    *,
    commitIds: Sequence[str],
    repositoryName: str,
) -> BatchGetCommitsOutputTypeDef:  # (1)
    ...

1. See BatchGetCommitsOutputTypeDef

Usage example with kwargs

kwargs: BatchGetCommitsInputRequestTypeDef = {  # (1)
    "commitIds": ...,
    "repositoryName": ...,
}

parent.batch_get_commits(**kwargs)

1. See BatchGetCommitsInputRequestTypeDef

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

Method definition

def batch_get_repositories(
    self,
    *,
    repositoryNames: Sequence[str],
) -> BatchGetRepositoriesOutputTypeDef:  # (1)
    ...

1. See BatchGetRepositoriesOutputTypeDef

Usage example with kwargs

kwargs: BatchGetRepositoriesInputRequestTypeDef = {  # (1)
    "repositoryNames": ...,
}

parent.batch_get_repositories(**kwargs)

1. See BatchGetRepositoriesInputRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("codecommit").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("codecommit").close method. boto3 documentation

Method definition

def close(
    self,
) -> None:
    ...

create_approval_rule_template

Creates a template for approval rules that can then be associated with one or more repositories in your AWS account.

Type annotations and code completion for boto3.client("codecommit").create_approval_rule_template method. boto3 documentation

Method definition

def create_approval_rule_template(
    self,
    *,
    approvalRuleTemplateName: str,
    approvalRuleTemplateContent: str,
    approvalRuleTemplateDescription: str = ...,
) -> CreateApprovalRuleTemplateOutputTypeDef:  # (1)
    ...

1. See CreateApprovalRuleTemplateOutputTypeDef

Usage example with kwargs

kwargs: CreateApprovalRuleTemplateInputRequestTypeDef = {  # (1)
    "approvalRuleTemplateName": ...,
    "approvalRuleTemplateContent": ...,
}

parent.create_approval_rule_template(**kwargs)

1. See CreateApprovalRuleTemplateInputRequestTypeDef

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

Method definition

def create_branch(
    self,
    *,
    repositoryName: str,
    branchName: str,
    commitId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: CreateBranchInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "branchName": ...,
    "commitId": ...,
}

parent.create_branch(**kwargs)

1. See CreateBranchInputRequestTypeDef

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

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

1. See PutFileEntryTypeDef
2. See DeleteFileEntryTypeDef
3. See SetFileModeEntryTypeDef
4. See CreateCommitOutputTypeDef

Usage example with kwargs

kwargs: CreateCommitInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "branchName": ...,
}

parent.create_commit(**kwargs)

1. See CreateCommitInputRequestTypeDef

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

Method definition

def create_pull_request(
    self,
    *,
    title: str,
    targets: Sequence[TargetTypeDef],  # (1)
    description: str = ...,
    clientRequestToken: str = ...,
) -> CreatePullRequestOutputTypeDef:  # (2)
    ...

1. See TargetTypeDef
2. See CreatePullRequestOutputTypeDef

Usage example with kwargs

kwargs: CreatePullRequestInputRequestTypeDef = {  # (1)
    "title": ...,
    "targets": ...,
}

parent.create_pull_request(**kwargs)

1. See CreatePullRequestInputRequestTypeDef

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

Method definition

def create_pull_request_approval_rule(
    self,
    *,
    pullRequestId: str,
    approvalRuleName: str,
    approvalRuleContent: str,
) -> CreatePullRequestApprovalRuleOutputTypeDef:  # (1)
    ...

1. See CreatePullRequestApprovalRuleOutputTypeDef

Usage example with kwargs

kwargs: CreatePullRequestApprovalRuleInputRequestTypeDef = {  # (1)
    "pullRequestId": ...,
    "approvalRuleName": ...,
    "approvalRuleContent": ...,
}

parent.create_pull_request_approval_rule(**kwargs)

1. See CreatePullRequestApprovalRuleInputRequestTypeDef

create_repository

Creates a new, empty repository.

Type annotations and code completion for boto3.client("codecommit").create_repository method. boto3 documentation

Method definition

def create_repository(
    self,
    *,
    repositoryName: str,
    repositoryDescription: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateRepositoryOutputTypeDef:  # (1)
    ...

1. See CreateRepositoryOutputTypeDef

Usage example with kwargs

kwargs: CreateRepositoryInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
}

parent.create_repository(**kwargs)

1. See CreateRepositoryInputRequestTypeDef

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

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

1. See MergeOptionTypeEnumType
2. See ConflictDetailLevelTypeEnumType
3. See ConflictResolutionStrategyTypeEnumType
4. See ConflictResolutionTypeDef
5. See CreateUnreferencedMergeCommitOutputTypeDef

Usage example with kwargs

kwargs: CreateUnreferencedMergeCommitInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "sourceCommitSpecifier": ...,
    "destinationCommitSpecifier": ...,
    "mergeOption": ...,
}

parent.create_unreferenced_merge_commit(**kwargs)

1. See CreateUnreferencedMergeCommitInputRequestTypeDef

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

Method definition

def delete_approval_rule_template(
    self,
    *,
    approvalRuleTemplateName: str,
) -> DeleteApprovalRuleTemplateOutputTypeDef:  # (1)
    ...

1. See DeleteApprovalRuleTemplateOutputTypeDef

Usage example with kwargs

kwargs: DeleteApprovalRuleTemplateInputRequestTypeDef = {  # (1)
    "approvalRuleTemplateName": ...,
}

parent.delete_approval_rule_template(**kwargs)

1. See DeleteApprovalRuleTemplateInputRequestTypeDef

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

Method definition

def delete_branch(
    self,
    *,
    repositoryName: str,
    branchName: str,
) -> DeleteBranchOutputTypeDef:  # (1)
    ...

1. See DeleteBranchOutputTypeDef

Usage example with kwargs

kwargs: DeleteBranchInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "branchName": ...,
}

parent.delete_branch(**kwargs)

1. See DeleteBranchInputRequestTypeDef

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

Method definition

def delete_comment_content(
    self,
    *,
    commentId: str,
) -> DeleteCommentContentOutputTypeDef:  # (1)
    ...

1. See DeleteCommentContentOutputTypeDef

Usage example with kwargs

kwargs: DeleteCommentContentInputRequestTypeDef = {  # (1)
    "commentId": ...,
}

parent.delete_comment_content(**kwargs)

1. See DeleteCommentContentInputRequestTypeDef

delete_file

Deletes a specified file from a specified branch.

Type annotations and code completion for boto3.client("codecommit").delete_file method. boto3 documentation

Method definition

def delete_file(
    self,
    *,
    repositoryName: str,
    branchName: str,
    filePath: str,
    parentCommitId: str,
    keepEmptyFolders: bool = ...,
    commitMessage: str = ...,
    name: str = ...,
    email: str = ...,
) -> DeleteFileOutputTypeDef:  # (1)
    ...

1. See DeleteFileOutputTypeDef

Usage example with kwargs

kwargs: DeleteFileInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "branchName": ...,
    "filePath": ...,
    "parentCommitId": ...,
}

parent.delete_file(**kwargs)

1. See DeleteFileInputRequestTypeDef

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

Method definition

def delete_pull_request_approval_rule(
    self,
    *,
    pullRequestId: str,
    approvalRuleName: str,
) -> DeletePullRequestApprovalRuleOutputTypeDef:  # (1)
    ...

1. See DeletePullRequestApprovalRuleOutputTypeDef

Usage example with kwargs

kwargs: DeletePullRequestApprovalRuleInputRequestTypeDef = {  # (1)
    "pullRequestId": ...,
    "approvalRuleName": ...,
}

parent.delete_pull_request_approval_rule(**kwargs)

1. See DeletePullRequestApprovalRuleInputRequestTypeDef

delete_repository

Deletes a repository.

Type annotations and code completion for boto3.client("codecommit").delete_repository method. boto3 documentation

Method definition

def delete_repository(
    self,
    *,
    repositoryName: str,
) -> DeleteRepositoryOutputTypeDef:  # (1)
    ...

1. See DeleteRepositoryOutputTypeDef

Usage example with kwargs

kwargs: DeleteRepositoryInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
}

parent.delete_repository(**kwargs)

1. See DeleteRepositoryInputRequestTypeDef

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

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

1. See MergeOptionTypeEnumType
2. See ConflictDetailLevelTypeEnumType
3. See ConflictResolutionStrategyTypeEnumType
4. See DescribeMergeConflictsOutputTypeDef

Usage example with kwargs

kwargs: DescribeMergeConflictsInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "destinationCommitSpecifier": ...,
    "sourceCommitSpecifier": ...,
    "mergeOption": ...,
    "filePath": ...,
}

parent.describe_merge_conflicts(**kwargs)

1. See DescribeMergeConflictsInputRequestTypeDef

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

Method definition

def describe_pull_request_events(
    self,
    *,
    pullRequestId: str,
    pullRequestEventType: PullRequestEventTypeType = ...,  # (1)
    actorArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> DescribePullRequestEventsOutputTypeDef:  # (2)
    ...

1. See PullRequestEventTypeType
2. See DescribePullRequestEventsOutputTypeDef

Usage example with kwargs

kwargs: DescribePullRequestEventsInputRequestTypeDef = {  # (1)
    "pullRequestId": ...,
}

parent.describe_pull_request_events(**kwargs)

1. See DescribePullRequestEventsInputRequestTypeDef

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

Method definition

def disassociate_approval_rule_template_from_repository(
    self,
    *,
    approvalRuleTemplateName: str,
    repositoryName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DisassociateApprovalRuleTemplateFromRepositoryInputRequestTypeDef = {  # (1)
    "approvalRuleTemplateName": ...,
    "repositoryName": ...,
}

parent.disassociate_approval_rule_template_from_repository(**kwargs)

1. See DisassociateApprovalRuleTemplateFromRepositoryInputRequestTypeDef

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

Method definition

def evaluate_pull_request_approval_rules(
    self,
    *,
    pullRequestId: str,
    revisionId: str,
) -> EvaluatePullRequestApprovalRulesOutputTypeDef:  # (1)
    ...

1. See EvaluatePullRequestApprovalRulesOutputTypeDef

Usage example with kwargs

kwargs: EvaluatePullRequestApprovalRulesInputRequestTypeDef = {  # (1)
    "pullRequestId": ...,
    "revisionId": ...,
}

parent.evaluate_pull_request_approval_rules(**kwargs)

1. See EvaluatePullRequestApprovalRulesInputRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("codecommit").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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

Method definition

def get_approval_rule_template(
    self,
    *,
    approvalRuleTemplateName: str,
) -> GetApprovalRuleTemplateOutputTypeDef:  # (1)
    ...

1. See GetApprovalRuleTemplateOutputTypeDef

Usage example with kwargs

kwargs: GetApprovalRuleTemplateInputRequestTypeDef = {  # (1)
    "approvalRuleTemplateName": ...,
}

parent.get_approval_rule_template(**kwargs)

1. See GetApprovalRuleTemplateInputRequestTypeDef

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

Method definition

def get_blob(
    self,
    *,
    repositoryName: str,
    blobId: str,
) -> GetBlobOutputTypeDef:  # (1)
    ...

1. See GetBlobOutputTypeDef

Usage example with kwargs

kwargs: GetBlobInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "blobId": ...,
}

parent.get_blob(**kwargs)

1. See GetBlobInputRequestTypeDef

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

Method definition

def get_branch(
    self,
    *,
    repositoryName: str = ...,
    branchName: str = ...,
) -> GetBranchOutputTypeDef:  # (1)
    ...

1. See GetBranchOutputTypeDef

Usage example with kwargs

kwargs: GetBranchInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
}

parent.get_branch(**kwargs)

1. See GetBranchInputRequestTypeDef

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

Method definition

def get_comment(
    self,
    *,
    commentId: str,
) -> GetCommentOutputTypeDef:  # (1)
    ...

1. See GetCommentOutputTypeDef

Usage example with kwargs

kwargs: GetCommentInputRequestTypeDef = {  # (1)
    "commentId": ...,
}

parent.get_comment(**kwargs)

1. See GetCommentInputRequestTypeDef

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

Method definition

def get_comment_reactions(
    self,
    *,
    commentId: str,
    reactionUserArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetCommentReactionsOutputTypeDef:  # (1)
    ...

1. See GetCommentReactionsOutputTypeDef

Usage example with kwargs

kwargs: GetCommentReactionsInputRequestTypeDef = {  # (1)
    "commentId": ...,
}

parent.get_comment_reactions(**kwargs)

1. See GetCommentReactionsInputRequestTypeDef

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

Method definition

def get_comments_for_compared_commit(
    self,
    *,
    repositoryName: str,
    afterCommitId: str,
    beforeCommitId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetCommentsForComparedCommitOutputTypeDef:  # (1)
    ...

1. See GetCommentsForComparedCommitOutputTypeDef

Usage example with kwargs

kwargs: GetCommentsForComparedCommitInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "afterCommitId": ...,
}

parent.get_comments_for_compared_commit(**kwargs)

1. See GetCommentsForComparedCommitInputRequestTypeDef

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

Method definition

def get_comments_for_pull_request(
    self,
    *,
    pullRequestId: str,
    repositoryName: str = ...,
    beforeCommitId: str = ...,
    afterCommitId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetCommentsForPullRequestOutputTypeDef:  # (1)
    ...

1. See GetCommentsForPullRequestOutputTypeDef

Usage example with kwargs

kwargs: GetCommentsForPullRequestInputRequestTypeDef = {  # (1)
    "pullRequestId": ...,
}

parent.get_comments_for_pull_request(**kwargs)

1. See GetCommentsForPullRequestInputRequestTypeDef

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

Method definition

def get_commit(
    self,
    *,
    repositoryName: str,
    commitId: str,
) -> GetCommitOutputTypeDef:  # (1)
    ...

1. See GetCommitOutputTypeDef

Usage example with kwargs

kwargs: GetCommitInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "commitId": ...,
}

parent.get_commit(**kwargs)

1. See GetCommitInputRequestTypeDef

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

Method definition

def get_differences(
    self,
    *,
    repositoryName: str,
    afterCommitSpecifier: str,
    beforeCommitSpecifier: str = ...,
    beforePath: str = ...,
    afterPath: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetDifferencesOutputTypeDef:  # (1)
    ...

1. See GetDifferencesOutputTypeDef

Usage example with kwargs

kwargs: GetDifferencesInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "afterCommitSpecifier": ...,
}

parent.get_differences(**kwargs)

1. See GetDifferencesInputRequestTypeDef

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

Method definition

def get_file(
    self,
    *,
    repositoryName: str,
    filePath: str,
    commitSpecifier: str = ...,
) -> GetFileOutputTypeDef:  # (1)
    ...

1. See GetFileOutputTypeDef

Usage example with kwargs

kwargs: GetFileInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "filePath": ...,
}

parent.get_file(**kwargs)

1. See GetFileInputRequestTypeDef

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

Method definition

def get_folder(
    self,
    *,
    repositoryName: str,
    folderPath: str,
    commitSpecifier: str = ...,
) -> GetFolderOutputTypeDef:  # (1)
    ...

1. See GetFolderOutputTypeDef

Usage example with kwargs

kwargs: GetFolderInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "folderPath": ...,
}

parent.get_folder(**kwargs)

1. See GetFolderInputRequestTypeDef

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

Method definition

def get_merge_commit(
    self,
    *,
    repositoryName: str,
    sourceCommitSpecifier: str,
    destinationCommitSpecifier: str,
    conflictDetailLevel: ConflictDetailLevelTypeEnumType = ...,  # (1)
    conflictResolutionStrategy: ConflictResolutionStrategyTypeEnumType = ...,  # (2)
) -> GetMergeCommitOutputTypeDef:  # (3)
    ...

1. See ConflictDetailLevelTypeEnumType
2. See ConflictResolutionStrategyTypeEnumType
3. See GetMergeCommitOutputTypeDef

Usage example with kwargs

kwargs: GetMergeCommitInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "sourceCommitSpecifier": ...,
    "destinationCommitSpecifier": ...,
}

parent.get_merge_commit(**kwargs)

1. See GetMergeCommitInputRequestTypeDef

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

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

1. See MergeOptionTypeEnumType
2. See ConflictDetailLevelTypeEnumType
3. See ConflictResolutionStrategyTypeEnumType
4. See GetMergeConflictsOutputTypeDef

Usage example with kwargs

kwargs: GetMergeConflictsInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "destinationCommitSpecifier": ...,
    "sourceCommitSpecifier": ...,
    "mergeOption": ...,
}

parent.get_merge_conflicts(**kwargs)

1. See GetMergeConflictsInputRequestTypeDef

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

Method definition

def get_merge_options(
    self,
    *,
    repositoryName: str,
    sourceCommitSpecifier: str,
    destinationCommitSpecifier: str,
    conflictDetailLevel: ConflictDetailLevelTypeEnumType = ...,  # (1)
    conflictResolutionStrategy: ConflictResolutionStrategyTypeEnumType = ...,  # (2)
) -> GetMergeOptionsOutputTypeDef:  # (3)
    ...

1. See ConflictDetailLevelTypeEnumType
2. See ConflictResolutionStrategyTypeEnumType
3. See GetMergeOptionsOutputTypeDef

Usage example with kwargs

kwargs: GetMergeOptionsInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "sourceCommitSpecifier": ...,
    "destinationCommitSpecifier": ...,
}

parent.get_merge_options(**kwargs)

1. See GetMergeOptionsInputRequestTypeDef

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

Method definition

def get_pull_request(
    self,
    *,
    pullRequestId: str,
) -> GetPullRequestOutputTypeDef:  # (1)
    ...

1. See GetPullRequestOutputTypeDef

Usage example with kwargs

kwargs: GetPullRequestInputRequestTypeDef = {  # (1)
    "pullRequestId": ...,
}

parent.get_pull_request(**kwargs)

1. See GetPullRequestInputRequestTypeDef

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

Method definition

def get_pull_request_approval_states(
    self,
    *,
    pullRequestId: str,
    revisionId: str,
) -> GetPullRequestApprovalStatesOutputTypeDef:  # (1)
    ...

1. See GetPullRequestApprovalStatesOutputTypeDef

Usage example with kwargs

kwargs: GetPullRequestApprovalStatesInputRequestTypeDef = {  # (1)
    "pullRequestId": ...,
    "revisionId": ...,
}

parent.get_pull_request_approval_states(**kwargs)

1. See GetPullRequestApprovalStatesInputRequestTypeDef

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

Method definition

def get_pull_request_override_state(
    self,
    *,
    pullRequestId: str,
    revisionId: str,
) -> GetPullRequestOverrideStateOutputTypeDef:  # (1)
    ...

1. See GetPullRequestOverrideStateOutputTypeDef

Usage example with kwargs

kwargs: GetPullRequestOverrideStateInputRequestTypeDef = {  # (1)
    "pullRequestId": ...,
    "revisionId": ...,
}

parent.get_pull_request_override_state(**kwargs)

1. See GetPullRequestOverrideStateInputRequestTypeDef

get_repository

Returns information about a repository.

Type annotations and code completion for boto3.client("codecommit").get_repository method. boto3 documentation

Method definition

def get_repository(
    self,
    *,
    repositoryName: str,
) -> GetRepositoryOutputTypeDef:  # (1)
    ...

1. See GetRepositoryOutputTypeDef

Usage example with kwargs

kwargs: GetRepositoryInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
}

parent.get_repository(**kwargs)

1. See GetRepositoryInputRequestTypeDef

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

Method definition

def get_repository_triggers(
    self,
    *,
    repositoryName: str,
) -> GetRepositoryTriggersOutputTypeDef:  # (1)
    ...

1. See GetRepositoryTriggersOutputTypeDef

Usage example with kwargs

kwargs: GetRepositoryTriggersInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
}

parent.get_repository_triggers(**kwargs)

1. See GetRepositoryTriggersInputRequestTypeDef

list_approval_rule_templates

Lists all approval rule templates in the specified AWS Region in your AWS account.

Type annotations and code completion for boto3.client("codecommit").list_approval_rule_templates method.