Skip to content

CodeCommit module#

Index > CodeCommit

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

How to install#

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

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"

Type definitions#

Type annotations for type definitions used in methods and schema.