CodeCommit module#
Index > CodeCommit
Auto-generated documentation for CodeCommit type annotations stubs module mypy-boto3-codecommit.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.22' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
CodeCommit
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and CodeCommit
.
From PyPI with pip#
Install boto3-stubs
for CodeCommit
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[codecommit]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[codecommit]'
# standalone installation
python -m pip install mypy-boto3-codecommit
How to uninstall#
python -m pip uninstall -y mypy-boto3-codecommit
Usage#
Code samples can be found in Examples.
CodeCommitClient#
Type annotations and code completion for boto3.client("codecommit")
as CodeCommitClient
boto3 documentation
# CodeCommitClient usage example
from boto3.session import Session
from mypy_boto3_codecommit.client import CodeCommitClient
def get_client() -> CodeCommitClient:
return Session().client("codecommit")
Paginators#
Type annotations and code completion for paginators
from boto3.client("codecommit").get_paginator("...")
.
# DescribePullRequestEventsPaginator usage example
from boto3.session import Session
from mypy_boto3_codecommit.paginator import DescribePullRequestEventsPaginator
def get_describe_pull_request_events_paginator() -> DescribePullRequestEventsPaginator:
return Session().client("codecommit").get_paginator("describe_pull_request_events"))
- DescribePullRequestEventsPaginator
- GetCommentsForComparedCommitPaginator
- GetCommentsForPullRequestPaginator
- GetDifferencesPaginator
- ListBranchesPaginator
- ListPullRequestsPaginator
- ListRepositoriesPaginator
Literals#
Type annotations for literals used in methods and schema.
# ApprovalStateType usage example
from mypy_boto3_codecommit.literals import ApprovalStateType
def get_value() -> ApprovalStateType:
return "APPROVE"
- ApprovalStateType
- BatchGetRepositoriesErrorCodeEnumType
- ChangeTypeEnumType
- ConflictDetailLevelTypeEnumType
- ConflictResolutionStrategyTypeEnumType
- DescribePullRequestEventsPaginatorName
- FileModeTypeEnumType
- GetCommentsForComparedCommitPaginatorName
- GetCommentsForPullRequestPaginatorName
- GetDifferencesPaginatorName
- ListBranchesPaginatorName
- ListPullRequestsPaginatorName
- ListRepositoriesPaginatorName
- MergeOptionTypeEnumType
- ObjectTypeEnumType
- OrderEnumType
- OverrideStatusType
- PullRequestEventTypeType
- PullRequestStatusEnumType
- RelativeFileVersionEnumType
- ReplacementTypeEnumType
- RepositoryTriggerEventEnumType
- SortByEnumType
- CodeCommitServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- ApprovalRuleEventMetadataTypeDef
- ApprovalRuleOverriddenEventMetadataTypeDef
- ApprovalRuleTemplateTypeDef
- OriginApprovalRuleTemplateTypeDef
- ApprovalStateChangedEventMetadataTypeDef
- ApprovalTypeDef
- AssociateApprovalRuleTemplateWithRepositoryInputTypeDef
- BatchAssociateApprovalRuleTemplateWithRepositoriesErrorTypeDef
- BatchAssociateApprovalRuleTemplateWithRepositoriesInputTypeDef
- ResponseMetadataTypeDef
- BatchDescribeMergeConflictsErrorTypeDef
- BatchDescribeMergeConflictsInputTypeDef
- BatchDisassociateApprovalRuleTemplateFromRepositoriesErrorTypeDef
- BatchDisassociateApprovalRuleTemplateFromRepositoriesInputTypeDef
- BatchGetCommitsErrorTypeDef
- BatchGetCommitsInputTypeDef
- BatchGetRepositoriesErrorTypeDef
- BatchGetRepositoriesInputTypeDef
- RepositoryMetadataTypeDef
- BlobMetadataTypeDef
- BlobTypeDef
- BranchInfoTypeDef
- CommentTypeDef
- LocationTypeDef
- UserInfoTypeDef
- FileModesTypeDef
- FileSizesTypeDef
- IsBinaryFileTypeDef
- MergeOperationsTypeDef
- ObjectTypesTypeDef
- DeleteFileEntryTypeDef
- SetFileModeEntryTypeDef
- CreateApprovalRuleTemplateInputTypeDef
- CreateBranchInputTypeDef
- FileMetadataTypeDef
- CreatePullRequestApprovalRuleInputTypeDef
- TargetTypeDef
- CreateRepositoryInputTypeDef
- DeleteApprovalRuleTemplateInputTypeDef
- DeleteBranchInputTypeDef
- DeleteCommentContentInputTypeDef
- DeleteFileInputTypeDef
- DeletePullRequestApprovalRuleInputTypeDef
- DeleteRepositoryInputTypeDef
- DescribeMergeConflictsInputTypeDef
- PaginatorConfigTypeDef
- DescribePullRequestEventsInputTypeDef
- DisassociateApprovalRuleTemplateFromRepositoryInputTypeDef
- EvaluatePullRequestApprovalRulesInputTypeDef
- EvaluationTypeDef
- FileTypeDef
- FolderTypeDef
- GetApprovalRuleTemplateInputTypeDef
- GetBlobInputTypeDef
- GetBranchInputTypeDef
- GetCommentInputTypeDef
- GetCommentReactionsInputTypeDef
- GetCommentsForComparedCommitInputTypeDef
- GetCommentsForPullRequestInputTypeDef
- GetCommitInputTypeDef
- GetDifferencesInputTypeDef
- GetFileInputTypeDef
- GetFolderInputTypeDef
- SubModuleTypeDef
- SymbolicLinkTypeDef
- GetMergeCommitInputTypeDef
- GetMergeConflictsInputTypeDef
- GetMergeOptionsInputTypeDef
- GetPullRequestApprovalStatesInputTypeDef
- GetPullRequestInputTypeDef
- GetPullRequestOverrideStateInputTypeDef
- GetRepositoryInputTypeDef
- GetRepositoryTriggersInputTypeDef
- RepositoryTriggerOutputTypeDef
- ListApprovalRuleTemplatesInputTypeDef
- ListAssociatedApprovalRuleTemplatesForRepositoryInputTypeDef
- ListBranchesInputTypeDef
- ListFileCommitHistoryRequestTypeDef
- ListPullRequestsInputTypeDef
- ListRepositoriesForApprovalRuleTemplateInputTypeDef
- ListRepositoriesInputTypeDef
- RepositoryNameIdPairTypeDef
- ListTagsForResourceInputTypeDef
- MergeBranchesByFastForwardInputTypeDef
- MergeHunkDetailTypeDef
- MergeMetadataTypeDef
- MergePullRequestByFastForwardInputTypeDef
- OverridePullRequestApprovalRulesInputTypeDef
- PostCommentReplyInputTypeDef
- PullRequestCreatedEventMetadataTypeDef
- PullRequestSourceReferenceUpdatedEventMetadataTypeDef
- PullRequestStatusChangedEventMetadataTypeDef
- PutCommentReactionInputTypeDef
- SourceFileSpecifierTypeDef
- ReactionValueFormatsTypeDef
- RepositoryTriggerExecutionFailureTypeDef
- RepositoryTriggerTypeDef
- TagResourceInputTypeDef
- UntagResourceInputTypeDef
- UpdateApprovalRuleTemplateContentInputTypeDef
- UpdateApprovalRuleTemplateDescriptionInputTypeDef
- UpdateApprovalRuleTemplateNameInputTypeDef
- UpdateCommentInputTypeDef
- UpdateDefaultBranchInputTypeDef
- UpdatePullRequestApprovalRuleContentInputTypeDef
- UpdatePullRequestApprovalStateInputTypeDef
- UpdatePullRequestDescriptionInputTypeDef
- UpdatePullRequestStatusInputTypeDef
- UpdatePullRequestTitleInputTypeDef
- UpdateRepositoryDescriptionInputTypeDef
- UpdateRepositoryEncryptionKeyInputTypeDef
- UpdateRepositoryNameInputTypeDef
- ApprovalRuleTypeDef
- BatchAssociateApprovalRuleTemplateWithRepositoriesOutputTypeDef
- CreateApprovalRuleTemplateOutputTypeDef
- CreateUnreferencedMergeCommitOutputTypeDef
- DeleteApprovalRuleTemplateOutputTypeDef
- DeleteFileOutputTypeDef
- DeletePullRequestApprovalRuleOutputTypeDef
- DeleteRepositoryOutputTypeDef
- EmptyResponseMetadataTypeDef
- GetApprovalRuleTemplateOutputTypeDef
- GetBlobOutputTypeDef
- GetFileOutputTypeDef
- GetMergeCommitOutputTypeDef
- GetMergeOptionsOutputTypeDef
- GetPullRequestApprovalStatesOutputTypeDef
- GetPullRequestOverrideStateOutputTypeDef
- ListApprovalRuleTemplatesOutputTypeDef
- ListAssociatedApprovalRuleTemplatesForRepositoryOutputTypeDef
- ListBranchesOutputTypeDef
- ListPullRequestsOutputTypeDef
- ListRepositoriesForApprovalRuleTemplateOutputTypeDef
- ListTagsForResourceOutputTypeDef
- MergeBranchesByFastForwardOutputTypeDef
- MergeBranchesBySquashOutputTypeDef
- MergeBranchesByThreeWayOutputTypeDef
- PutFileOutputTypeDef
- PutRepositoryTriggersOutputTypeDef
- UpdateApprovalRuleTemplateContentOutputTypeDef
- UpdateApprovalRuleTemplateDescriptionOutputTypeDef
- UpdateApprovalRuleTemplateNameOutputTypeDef
- UpdateRepositoryEncryptionKeyOutputTypeDef
- BatchDisassociateApprovalRuleTemplateFromRepositoriesOutputTypeDef
- BatchGetRepositoriesOutputTypeDef
- CreateRepositoryOutputTypeDef
- GetRepositoryOutputTypeDef
- DifferenceTypeDef
- PutFileInputTypeDef
- ReplaceContentEntryTypeDef
- DeleteBranchOutputTypeDef
- GetBranchOutputTypeDef
- DeleteCommentContentOutputTypeDef
- GetCommentOutputTypeDef
- PostCommentReplyOutputTypeDef
- UpdateCommentOutputTypeDef
- CommentsForComparedCommitTypeDef
- CommentsForPullRequestTypeDef
- PostCommentForComparedCommitInputTypeDef
- PostCommentForComparedCommitOutputTypeDef
- PostCommentForPullRequestInputTypeDef
- PostCommentForPullRequestOutputTypeDef
- CommitTypeDef
- ConflictMetadataTypeDef
- CreateCommitOutputTypeDef
- CreatePullRequestInputTypeDef
- DescribePullRequestEventsInputPaginateTypeDef
- GetCommentsForComparedCommitInputPaginateTypeDef
- GetCommentsForPullRequestInputPaginateTypeDef
- GetDifferencesInputPaginateTypeDef
- ListBranchesInputPaginateTypeDef
- ListPullRequestsInputPaginateTypeDef
- ListRepositoriesInputPaginateTypeDef
- EvaluatePullRequestApprovalRulesOutputTypeDef
- GetFolderOutputTypeDef
- GetRepositoryTriggersOutputTypeDef
- ListRepositoriesOutputTypeDef
- MergeHunkTypeDef
- PullRequestMergedStateChangedEventMetadataTypeDef
- PullRequestTargetTypeDef
- PutFileEntryTypeDef
- ReactionForCommentTypeDef
- TestRepositoryTriggersOutputTypeDef
- RepositoryTriggerUnionTypeDef
- CreatePullRequestApprovalRuleOutputTypeDef
- UpdatePullRequestApprovalRuleContentOutputTypeDef
- GetDifferencesOutputTypeDef
- ConflictResolutionTypeDef
- GetCommentsForComparedCommitOutputTypeDef
- GetCommentsForPullRequestOutputTypeDef
- BatchGetCommitsOutputTypeDef
- FileVersionTypeDef
- GetCommitOutputTypeDef
- GetMergeConflictsOutputTypeDef
- ConflictTypeDef
- DescribeMergeConflictsOutputTypeDef
- PullRequestEventTypeDef
- PullRequestTypeDef
- CreateCommitInputTypeDef
- GetCommentReactionsOutputTypeDef
- PutRepositoryTriggersInputTypeDef
- TestRepositoryTriggersInputTypeDef
- CreateUnreferencedMergeCommitInputTypeDef
- MergeBranchesBySquashInputTypeDef
- MergeBranchesByThreeWayInputTypeDef
- MergePullRequestBySquashInputTypeDef
- MergePullRequestByThreeWayInputTypeDef
- ListFileCommitHistoryResponseTypeDef
- BatchDescribeMergeConflictsOutputTypeDef
- DescribePullRequestEventsOutputTypeDef
- CreatePullRequestOutputTypeDef
- GetPullRequestOutputTypeDef
- MergePullRequestByFastForwardOutputTypeDef
- MergePullRequestBySquashOutputTypeDef
- MergePullRequestByThreeWayOutputTypeDef
- UpdatePullRequestDescriptionOutputTypeDef
- UpdatePullRequestStatusOutputTypeDef
- UpdatePullRequestTitleOutputTypeDef