CodeBuild module#
Index > CodeBuild
Auto-generated documentation for CodeBuild type annotations stubs module mypy-boto3-codebuild.
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 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
- ListBuildBatchesPaginator
- ListBuildBatchesForProjectPaginator
- ListBuildsPaginator
- ListBuildsForProjectPaginator
- ListProjectsPaginator
- ListReportGroupsPaginator
- ListReportsPaginator
- ListReportsForReportGroupPaginator
- 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
- AuthTypeType
- BatchReportModeTypeType
- BucketOwnerAccessType
- BuildBatchPhaseTypeType
- BuildPhaseTypeType
- CacheModeType
- CacheTypeType
- ComputeTypeType
- CredentialProviderTypeType
- DescribeCodeCoveragesPaginatorName
- DescribeTestCasesPaginatorName
- EnvironmentTypeType
- EnvironmentVariableTypeType
- FileSystemTypeType
- FleetContextCodeType
- FleetOverflowBehaviorType
- FleetProxyRuleBehaviorType
- FleetProxyRuleEffectTypeType
- FleetProxyRuleTypeType
- FleetScalingMetricTypeType
- FleetScalingTypeType
- FleetSortByTypeType
- FleetStatusCodeType
- ImagePullCredentialsTypeType
- LanguageTypeType
- ListBuildBatchesForProjectPaginatorName
- ListBuildBatchesPaginatorName
- ListBuildsForProjectPaginatorName
- ListBuildsPaginatorName
- ListProjectsPaginatorName
- ListReportGroupsPaginatorName
- ListReportsForReportGroupPaginatorName
- ListReportsPaginatorName
- ListSharedProjectsPaginatorName
- ListSharedReportGroupsPaginatorName
- LogsConfigStatusTypeType
- PlatformTypeType
- ProjectSortByTypeType
- ProjectVisibilityTypeType
- ReportCodeCoverageSortByTypeType
- ReportExportConfigTypeType
- ReportGroupSortByTypeType
- ReportGroupStatusTypeType
- ReportGroupTrendFieldTypeType
- ReportPackagingTypeType
- ReportStatusTypeType
- ReportTypeType
- RetryBuildBatchTypeType
- ServerTypeType
- SharedResourceSortByTypeType
- SortOrderTypeType
- SourceAuthTypeType
- SourceTypeType
- StatusTypeType
- WebhookBuildTypeType
- WebhookFilterTypeType
- WebhookScopeTypeType
- CodeBuildServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AutoRetryConfigTypeDef
- BatchDeleteBuildsInputRequestTypeDef
- BuildNotDeletedTypeDef
- ResponseMetadataTypeDef
- BatchGetBuildBatchesInputRequestTypeDef
- BatchGetBuildsInputRequestTypeDef
- BatchGetFleetsInputRequestTypeDef
- BatchGetProjectsInputRequestTypeDef
- BatchGetReportGroupsInputRequestTypeDef
- BatchGetReportsInputRequestTypeDef
- BatchRestrictionsOutputTypeDef
- BatchRestrictionsTypeDef
- BuildArtifactsTypeDef
- BuildBatchFilterTypeDef
- PhaseContextTypeDef
- ProjectCacheOutputTypeDef
- ProjectFileSystemLocationTypeDef
- ProjectSourceVersionTypeDef
- VpcConfigOutputTypeDef
- BuildStatusConfigTypeDef
- ResolvedArtifactTypeDef
- DebugSessionTypeDef
- ExportedEnvironmentVariableTypeDef
- NetworkInterfaceTypeDef
- CloudWatchLogsConfigTypeDef
- CodeCoverageReportSummaryTypeDef
- CodeCoverageTypeDef
- TagTypeDef
- VpcConfigTypeDef
- ProjectArtifactsTypeDef
- ProjectCacheTypeDef
- ScopeConfigurationTypeDef
- WebhookFilterTypeDef
- DeleteBuildBatchInputRequestTypeDef
- DeleteFleetInputRequestTypeDef
- DeleteProjectInputRequestTypeDef
- DeleteReportGroupInputRequestTypeDef
- DeleteReportInputRequestTypeDef
- DeleteResourcePolicyInputRequestTypeDef
- DeleteSourceCredentialsInputRequestTypeDef
- DeleteWebhookInputRequestTypeDef
- PaginatorConfigTypeDef
- DescribeCodeCoveragesInputRequestTypeDef
- TestCaseFilterTypeDef
- TestCaseTypeDef
- EnvironmentImageTypeDef
- EnvironmentVariableTypeDef
- FleetProxyRuleOutputTypeDef
- FleetProxyRuleTypeDef
- FleetStatusTypeDef
- GetReportGroupTrendInputRequestTypeDef
- ReportGroupTrendStatsTypeDef
- ReportWithRawDataTypeDef
- GetResourcePolicyInputRequestTypeDef
- GitSubmodulesConfigTypeDef
- ImportSourceCredentialsInputRequestTypeDef
- InvalidateProjectCacheInputRequestTypeDef
- ListBuildsForProjectInputRequestTypeDef
- ListBuildsInputRequestTypeDef
- ListFleetsInputRequestTypeDef
- ListProjectsInputRequestTypeDef
- ListReportGroupsInputRequestTypeDef
- ReportFilterTypeDef
- ListSharedProjectsInputRequestTypeDef
- ListSharedReportGroupsInputRequestTypeDef
- SourceCredentialsInfoTypeDef
- S3LogsConfigTypeDef
- ProjectBadgeTypeDef
- ProjectFleetTypeDef
- RegistryCredentialTypeDef
- SourceAuthTypeDef
- PutResourcePolicyInputRequestTypeDef
- S3ReportExportConfigTypeDef
- TestReportSummaryTypeDef
- RetryBuildBatchInputRequestTypeDef
- RetryBuildInputRequestTypeDef
- TargetTrackingScalingConfigurationTypeDef
- StopBuildBatchInputRequestTypeDef
- StopBuildInputRequestTypeDef
- UpdateProjectVisibilityInputRequestTypeDef
- BatchDeleteBuildsOutputTypeDef
- DeleteBuildBatchOutputTypeDef
- DeleteSourceCredentialsOutputTypeDef
- GetResourcePolicyOutputTypeDef
- ImportSourceCredentialsOutputTypeDef
- ListBuildBatchesForProjectOutputTypeDef
- ListBuildBatchesOutputTypeDef
- ListBuildsForProjectOutputTypeDef
- ListBuildsOutputTypeDef
- ListFleetsOutputTypeDef
- ListProjectsOutputTypeDef
- ListReportGroupsOutputTypeDef
- ListReportsForReportGroupOutputTypeDef
- ListReportsOutputTypeDef
- ListSharedProjectsOutputTypeDef
- ListSharedReportGroupsOutputTypeDef
- PutResourcePolicyOutputTypeDef
- UpdateProjectVisibilityOutputTypeDef
- ProjectBuildBatchConfigOutputTypeDef
- BatchRestrictionsUnionTypeDef
- ListBuildBatchesForProjectInputRequestTypeDef
- ListBuildBatchesInputRequestTypeDef
- BuildBatchPhaseTypeDef
- BuildPhaseTypeDef
- BuildSummaryTypeDef
- DescribeCodeCoveragesOutputTypeDef
- CreateWebhookInputRequestTypeDef
- UpdateWebhookInputRequestTypeDef
- WebhookTypeDef
- DescribeCodeCoveragesInputDescribeCodeCoveragesPaginateTypeDef
- ListBuildBatchesForProjectInputListBuildBatchesForProjectPaginateTypeDef
- ListBuildBatchesInputListBuildBatchesPaginateTypeDef
- ListBuildsForProjectInputListBuildsForProjectPaginateTypeDef
- ListBuildsInputListBuildsPaginateTypeDef
- ListProjectsInputListProjectsPaginateTypeDef
- ListReportGroupsInputListReportGroupsPaginateTypeDef
- ListSharedProjectsInputListSharedProjectsPaginateTypeDef
- ListSharedReportGroupsInputListSharedReportGroupsPaginateTypeDef
- DescribeTestCasesInputDescribeTestCasesPaginateTypeDef
- DescribeTestCasesInputRequestTypeDef
- DescribeTestCasesOutputTypeDef
- EnvironmentLanguageTypeDef
- ProxyConfigurationOutputTypeDef
- FleetProxyRuleUnionTypeDef
- GetReportGroupTrendOutputTypeDef
- ListReportsForReportGroupInputListReportsForReportGroupPaginateTypeDef
- ListReportsForReportGroupInputRequestTypeDef
- ListReportsInputListReportsPaginateTypeDef
- ListReportsInputRequestTypeDef
- ListSourceCredentialsOutputTypeDef
- LogsConfigTypeDef
- LogsLocationTypeDef
- ProjectEnvironmentOutputTypeDef
- ProjectEnvironmentTypeDef
- ProjectSourceTypeDef
- ReportExportConfigTypeDef
- ScalingConfigurationInputTypeDef
- ScalingConfigurationOutputTypeDef
- ProjectBuildBatchConfigTypeDef
- BuildGroupTypeDef
- CreateWebhookOutputTypeDef
- UpdateWebhookOutputTypeDef
- EnvironmentPlatformTypeDef
- ProxyConfigurationTypeDef
- BuildTypeDef
- ProjectTypeDef
- StartBuildInputRequestTypeDef
- CreateReportGroupInputRequestTypeDef
- ReportGroupTypeDef
- ReportTypeDef
- UpdateReportGroupInputRequestTypeDef
- FleetTypeDef
- CreateProjectInputRequestTypeDef
- StartBuildBatchInputRequestTypeDef
- UpdateProjectInputRequestTypeDef
- BuildBatchTypeDef
- ListCuratedEnvironmentImagesOutputTypeDef
- CreateFleetInputRequestTypeDef
- UpdateFleetInputRequestTypeDef
- BatchGetBuildsOutputTypeDef
- RetryBuildOutputTypeDef
- StartBuildOutputTypeDef
- StopBuildOutputTypeDef
- BatchGetProjectsOutputTypeDef
- CreateProjectOutputTypeDef
- UpdateProjectOutputTypeDef
- BatchGetReportGroupsOutputTypeDef
- CreateReportGroupOutputTypeDef
- UpdateReportGroupOutputTypeDef
- BatchGetReportsOutputTypeDef
- BatchGetFleetsOutputTypeDef
- CreateFleetOutputTypeDef
- UpdateFleetOutputTypeDef
- BatchGetBuildBatchesOutputTypeDef
- RetryBuildBatchOutputTypeDef
- StartBuildBatchOutputTypeDef
- StopBuildBatchOutputTypeDef