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)
...
# batch_delete_builds method usage example with argument unpacking
kwargs: BatchDeleteBuildsInputRequestTypeDef = { # (1)
"ids": ...,
}
parent.batch_delete_builds(**kwargs)
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)
...
# batch_get_build_batches method usage example with argument unpacking
kwargs: BatchGetBuildBatchesInputRequestTypeDef = { # (1)
"ids": ...,
}
parent.batch_get_build_batches(**kwargs)
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)
...
# batch_get_builds method usage example with argument unpacking
kwargs: BatchGetBuildsInputRequestTypeDef = { # (1)
"ids": ...,
}
parent.batch_get_builds(**kwargs)
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)
...
# batch_get_projects method usage example with argument unpacking
kwargs: BatchGetProjectsInputRequestTypeDef = { # (1)
"names": ...,
}
parent.batch_get_projects(**kwargs)
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)
...
# batch_get_report_groups method usage example with argument unpacking
kwargs: BatchGetReportGroupsInputRequestTypeDef = { # (1)
"reportGroupArns": ...,
}
parent.batch_get_report_groups(**kwargs)
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)
...
# batch_get_reports method usage example with argument unpacking
kwargs: BatchGetReportsInputRequestTypeDef = { # (1)
"reportArns": ...,
}
parent.batch_get_reports(**kwargs)
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_project#
Creates a build project.
Type annotations and code completion for boto3.client("codebuild").create_project
method.
boto3 documentation
# create_project method definition
def create_project(
self,
*,
name: str,
source: ProjectSourceTypeDef, # (1)
artifacts: ProjectArtifactsTypeDef, # (2)
environment: ProjectEnvironmentTypeDef, # (3)
serviceRole: str,
description: str = ...,
secondarySources: Sequence[ProjectSourceTypeDef] = ..., # (4)
sourceVersion: str = ...,
secondarySourceVersions: Sequence[ProjectSourceVersionTypeDef] = ..., # (5)
secondaryArtifacts: Sequence[ProjectArtifactsTypeDef] = ..., # (6)
cache: ProjectCacheTypeDef = ..., # (7)
timeoutInMinutes: int = ...,
queuedTimeoutInMinutes: int = ...,
encryptionKey: str = ...,
tags: Sequence[TagTypeDef] = ..., # (8)
vpcConfig: VpcConfigTypeDef = ..., # (9)
badgeEnabled: bool = ...,
logsConfig: LogsConfigTypeDef = ..., # (10)
fileSystemLocations: Sequence[ProjectFileSystemLocationTypeDef] = ..., # (11)
buildBatchConfig: ProjectBuildBatchConfigTypeDef = ..., # (12)
concurrentBuildLimit: int = ...,
) -> CreateProjectOutputTypeDef: # (13)
...
- See ProjectSourceTypeDef
- See ProjectArtifactsTypeDef
- See ProjectEnvironmentTypeDef
- See ProjectSourceTypeDef
- See ProjectSourceVersionTypeDef
- See ProjectArtifactsTypeDef
- See ProjectCacheTypeDef
- See TagTypeDef
- See VpcConfigTypeDef
- See LogsConfigTypeDef
- See ProjectFileSystemLocationTypeDef
- See ProjectBuildBatchConfigTypeDef
- See CreateProjectOutputTypeDef
# create_project method usage example with argument unpacking
kwargs: CreateProjectInputRequestTypeDef = { # (1)
"name": ...,
"source": ...,
"artifacts": ...,
"environment": ...,
"serviceRole": ...,
}
parent.create_project(**kwargs)
create_report_group#
Creates a report group.
Type annotations and code completion for boto3.client("codebuild").create_report_group
method.
boto3 documentation
# create_report_group method definition
def create_report_group(
self,
*,
name: str,
type: ReportTypeType, # (1)
exportConfig: ReportExportConfigTypeDef, # (2)
tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateReportGroupOutputTypeDef: # (4)
...
# create_report_group method usage example with argument unpacking
kwargs: CreateReportGroupInputRequestTypeDef = { # (1)
"name": ...,
"type": ...,
"exportConfig": ...,
}
parent.create_report_group(**kwargs)
create_webhook#
For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.
Type annotations and code completion for boto3.client("codebuild").create_webhook
method.
boto3 documentation
# create_webhook method definition
def create_webhook(
self,
*,
projectName: str,
branchFilter: str = ...,
filterGroups: Sequence[Sequence[WebhookFilterTypeDef]] = ..., # (1)
buildType: WebhookBuildTypeType = ..., # (2)
) -> CreateWebhookOutputTypeDef: # (3)
...
# create_webhook method usage example with argument unpacking
kwargs: CreateWebhookInputRequestTypeDef = { # (1)
"projectName": ...,
}
parent.create_webhook(**kwargs)
delete_build_batch#
Deletes a batch build.
Type annotations and code completion for boto3.client("codebuild").delete_build_batch
method.
boto3 documentation
# delete_build_batch method definition
def delete_build_batch(
self,
*,
id: str,
) -> DeleteBuildBatchOutputTypeDef: # (1)
...
# delete_build_batch method usage example with argument unpacking
kwargs: DeleteBuildBatchInputRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_build_batch(**kwargs)
delete_project#
Deletes a build project.
Type annotations and code completion for boto3.client("codebuild").delete_project
method.
boto3 documentation
# delete_project method definition
def delete_project(
self,
*,
name: str,
) -> Dict[str, Any]:
...
# delete_project method usage example with argument unpacking
kwargs: DeleteProjectInputRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_project(**kwargs)
delete_report#
Deletes a report.
Type annotations and code completion for boto3.client("codebuild").delete_report
method.
boto3 documentation
# delete_report method definition
def delete_report(
self,
*,
arn: str,
) -> Dict[str, Any]:
...
# delete_report method usage example with argument unpacking
kwargs: DeleteReportInputRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_report(**kwargs)
delete_report_group#
Deletes a report group.
Type annotations and code completion for boto3.client("codebuild").delete_report_group
method.
boto3 documentation
# delete_report_group method definition
def delete_report_group(
self,
*,
arn: str,
deleteReports: bool = ...,
) -> Dict[str, Any]:
...
# delete_report_group method usage example with argument unpacking
kwargs: DeleteReportGroupInputRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_report_group(**kwargs)
delete_resource_policy#
Deletes a resource policy that is identified by its resource ARN.
Type annotations and code completion for boto3.client("codebuild").delete_resource_policy
method.
boto3 documentation
# delete_resource_policy method definition
def delete_resource_policy(
self,
*,
resourceArn: str,
) -> Dict[str, Any]:
...
# delete_resource_policy method usage example with argument unpacking
kwargs: DeleteResourcePolicyInputRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.delete_resource_policy(**kwargs)
delete_source_credentials#
Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
Type annotations and code completion for boto3.client("codebuild").delete_source_credentials
method.