Skip to content

CodeBuildClient#

Index > CodeBuild > CodeBuildClient

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

CodeBuildClient#

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

# CodeBuildClient usage example

from boto3.session import Session
from mypy_boto3_codebuild.client import CodeBuildClient

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

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("codebuild").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("codebuild")

try:
    do_something(client)
except (
    client.exceptions.AccountLimitExceededException,
    client.exceptions.ClientError,
    client.exceptions.InvalidInputException,
    client.exceptions.OAuthProviderException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceNotFoundException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_codebuild.client import Exceptions

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

Methods#

batch_delete_builds#

Deletes one or more builds.

Type annotations and code completion for boto3.client("codebuild").batch_delete_builds method. boto3 documentation

# batch_delete_builds method definition

def batch_delete_builds(
    self,
    *,
    ids: Sequence[str],
) -> BatchDeleteBuildsOutputTypeDef:  # (1)
    ...
  1. See BatchDeleteBuildsOutputTypeDef
# batch_delete_builds method usage example with argument unpacking

kwargs: BatchDeleteBuildsInputRequestTypeDef = {  # (1)
    "ids": ...,
}

parent.batch_delete_builds(**kwargs)
  1. See BatchDeleteBuildsInputRequestTypeDef

batch_get_build_batches#

Retrieves information about one or more batch builds.

Type annotations and code completion for boto3.client("codebuild").batch_get_build_batches method. boto3 documentation

# batch_get_build_batches method definition

def batch_get_build_batches(
    self,
    *,
    ids: Sequence[str],
) -> BatchGetBuildBatchesOutputTypeDef:  # (1)
    ...
  1. See BatchGetBuildBatchesOutputTypeDef
# batch_get_build_batches method usage example with argument unpacking

kwargs: BatchGetBuildBatchesInputRequestTypeDef = {  # (1)
    "ids": ...,
}

parent.batch_get_build_batches(**kwargs)
  1. See BatchGetBuildBatchesInputRequestTypeDef

batch_get_builds#

Gets information about one or more builds.

Type annotations and code completion for boto3.client("codebuild").batch_get_builds method. boto3 documentation

# batch_get_builds method definition

def batch_get_builds(
    self,
    *,
    ids: Sequence[str],
) -> BatchGetBuildsOutputTypeDef:  # (1)
    ...
  1. See BatchGetBuildsOutputTypeDef
# batch_get_builds method usage example with argument unpacking

kwargs: BatchGetBuildsInputRequestTypeDef = {  # (1)
    "ids": ...,
}

parent.batch_get_builds(**kwargs)
  1. See BatchGetBuildsInputRequestTypeDef

batch_get_fleets#

Gets information about one or more compute fleets.

Type annotations and code completion for boto3.client("codebuild").batch_get_fleets method. boto3 documentation

# batch_get_fleets method definition

def batch_get_fleets(
    self,
    *,
    names: Sequence[str],
) -> BatchGetFleetsOutputTypeDef:  # (1)
    ...
  1. See BatchGetFleetsOutputTypeDef
# batch_get_fleets method usage example with argument unpacking

kwargs: BatchGetFleetsInputRequestTypeDef = {  # (1)
    "names": ...,
}

parent.batch_get_fleets(**kwargs)
  1. See BatchGetFleetsInputRequestTypeDef

batch_get_projects#

Gets information about one or more build projects.

Type annotations and code completion for boto3.client("codebuild").batch_get_projects method. boto3 documentation

# batch_get_projects method definition

def batch_get_projects(
    self,
    *,
    names: Sequence[str],
) -> BatchGetProjectsOutputTypeDef:  # (1)
    ...
  1. See BatchGetProjectsOutputTypeDef
# batch_get_projects method usage example with argument unpacking

kwargs: BatchGetProjectsInputRequestTypeDef = {  # (1)
    "names": ...,
}

parent.batch_get_projects(**kwargs)
  1. See BatchGetProjectsInputRequestTypeDef

batch_get_report_groups#

Returns an array of report groups.

Type annotations and code completion for boto3.client("codebuild").batch_get_report_groups method. boto3 documentation

# batch_get_report_groups method definition

def batch_get_report_groups(
    self,
    *,
    reportGroupArns: Sequence[str],
) -> BatchGetReportGroupsOutputTypeDef:  # (1)
    ...
  1. See BatchGetReportGroupsOutputTypeDef
# batch_get_report_groups method usage example with argument unpacking

kwargs: BatchGetReportGroupsInputRequestTypeDef = {  # (1)
    "reportGroupArns": ...,
}

parent.batch_get_report_groups(**kwargs)
  1. See BatchGetReportGroupsInputRequestTypeDef

batch_get_reports#

Returns an array of reports.

Type annotations and code completion for boto3.client("codebuild").batch_get_reports method. boto3 documentation

# batch_get_reports method definition

def batch_get_reports(
    self,
    *,
    reportArns: Sequence[str],
) -> BatchGetReportsOutputTypeDef:  # (1)
    ...
  1. See BatchGetReportsOutputTypeDef
# batch_get_reports method usage example with argument unpacking

kwargs: BatchGetReportsInputRequestTypeDef = {  # (1)
    "reportArns": ...,
}

parent.batch_get_reports(**kwargs)
  1. See BatchGetReportsInputRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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

# can_paginate method definition

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

close#

Closes underlying endpoint connections.

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

# close method definition

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

create_fleet#

Creates a compute fleet.

Type annotations and code completion for boto3.client("codebuild").create_fleet method. boto3 documentation

# create_fleet method definition

def create_fleet(
    self,
    *,
    name: str,
    baseCapacity: int,
    environmentType: EnvironmentTypeType,  # (1)
    computeType: ComputeTypeType,  # (2)
    scalingConfiguration: ScalingConfigurationInputTypeDef = ...,  # (3)
    overflowBehavior: FleetOverflowBehaviorType = ...,  # (4)
    vpcConfig: Union[VpcConfigTypeDef, VpcConfigOutputTypeDef] = ...,  # (5)
    fleetServiceRole: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (6)
) -> CreateFleetOutputTypeDef:  # (7)
    ...
  1. See EnvironmentTypeType
  2. See ComputeTypeType
  3. See ScalingConfigurationInputTypeDef
  4. See FleetOverflowBehaviorType
  5. See VpcConfigTypeDef VpcConfigOutputTypeDef
  6. See TagTypeDef
  7. See CreateFleetOutputTypeDef
# create_fleet method usage example with argument unpacking

kwargs: CreateFleetInputRequestTypeDef = {  # (1)
    "name": ...,
    "baseCapacity": ...,
    "environmentType": ...,
    "computeType": ...,
}

parent.create_fleet(**kwargs)
  1. See CreateFleetInputRequestTypeDef

create_project#

Creates a build project.

Type annotations and code completion for boto3.client("codebuild").create_project method.