CodeBuild module

Index > CodeBuild

Auto-generated documentation for CodeBuild type annotations stubs module mypy-boto3-codebuild.

How to install

Generate locally (recommended)

You can generate type annotations for boto3 package locally with mypy_boto3_builder. Use uv for build isolation.

1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.36.2' mypy_boto3_builder
2. Select boto3-stubs AWS SDK.
3. Add CodeBuild service.
4. 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 CodeBuild.

From PyPI with pip

Install boto3-stubs for CodeBuild service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[codebuild]'

# 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[codebuild]'

# standalone installation
python -m pip install mypy-boto3-codebuild

How to uninstall

python -m pip uninstall -y mypy-boto3-codebuild

Usage

Code samples can be found in Examples.

CodeBuildClient

Type annotations and code completion for boto3.client("codebuild") as CodeBuildClient boto3 documentation

# CodeBuildClient usage example

from boto3.session import Session

from mypy_boto3_codebuild.client import CodeBuildClient

def get_client() -> CodeBuildClient:
    return Session().client("codebuild")

Paginators

Type annotations and code completion for paginators from boto3.client("codebuild").get_paginator("...").

# DescribeCodeCoveragesPaginator usage example

from boto3.session import Session

from mypy_boto3_codebuild.paginator import DescribeCodeCoveragesPaginator

def get_describe_code_coverages_paginator() -> DescribeCodeCoveragesPaginator:
    return Session().client("codebuild").get_paginator("describe_code_coverages"))

• DescribeCodeCoveragesPaginator
• DescribeTestCasesPaginator
• ListBuildBatchesForProjectPaginator
• ListBuildBatchesPaginator
• ListBuildsForProjectPaginator
• ListBuildsPaginator
• ListProjectsPaginator
• ListReportGroupsPaginator
• ListReportsForReportGroupPaginator
• ListReportsPaginator
• ListSharedProjectsPaginator
• ListSharedReportGroupsPaginator

Literals

Type annotations for literals used in methods and schema.

# ArtifactNamespaceType usage example

from mypy_boto3_codebuild.literals import ArtifactNamespaceType

def get_value() -> ArtifactNamespaceType:
    return "BUILD_ID"

• ArtifactNamespaceType
• ArtifactPackagingType
• ArtifactsTypeType