Skip to content

Examples

Index > CodeBuild > Examples

Auto-generated documentation for CodeBuild type annotations stubs module types-aiobotocore-codebuild.

Client

Implicit type annotations

Can be used with types-aioboto3[codebuild] package installed.

Write your CodeBuild code as usual, type checking and code completion should work out of the box.

Client usage example
from aioboto3.session import Session


session = Session()

async with session.client("codebuild") as client:  # (1)
    result = await client.batch_delete_builds()  # (2)
  1. client: CodeBuildClient
  2. result: BatchDeleteBuildsOutputTypeDef
Paginator usage example
from aioboto3.session import Session


session = Session()

async with session.client("codebuild") as client:  # (1)
    paginator = client.get_paginator("describe_code_coverages")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: CodeBuildClient
  2. paginator: DescribeCodeCoveragesPaginator
  3. item: DescribeCodeCoveragesOutputTypeDef

Explicit type annotations

With types-aioboto3-lite[codebuild] or a standalone types_aiobotocore_codebuild package, you have to explicitly specify client: CodeBuildClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

Client usage example
from aioboto3.session import Session

from types_aiobotocore_codebuild.client import CodeBuildClient
from types_aiobotocore_codebuild.type_defs import BatchDeleteBuildsOutputTypeDef
from types_aiobotocore_codebuild.type_defs import BatchDeleteBuildsInputRequestTypeDef


session = Session()

client: CodeBuildClient
async with session.client("codebuild") as client:  # (1)
    kwargs: BatchDeleteBuildsInputRequestTypeDef = {...}  # (2)
    result: BatchDeleteBuildsOutputTypeDef = await client.batch_delete_builds(**kwargs)  # (3)
  1. client: CodeBuildClient
  2. kwargs: BatchDeleteBuildsInputRequestTypeDef
  3. result: BatchDeleteBuildsOutputTypeDef
Paginator usage example
from aioboto3.session import Session

from types_aiobotocore_codebuild.client import CodeBuildClient
from types_aiobotocore_codebuild.paginator import DescribeCodeCoveragesPaginator
from types_aiobotocore_codebuild.type_defs import DescribeCodeCoveragesOutputTypeDef


session = Session()

client: CodeBuildClient
async with session.client("codebuild") as client:  # (1)
    paginator: DescribeCodeCoveragesPaginator = client.get_paginator("describe_code_coverages")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeCodeCoveragesOutputTypeDef
        print(item)  # (3)
  1. client: CodeBuildClient
  2. paginator: DescribeCodeCoveragesPaginator
  3. item: DescribeCodeCoveragesOutputTypeDef