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

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.

Usage example

client = boto3.client("codebuild")

try:
    do_something(client)
except (
    client.AccountLimitExceededException,
    client.ClientError,
    client.InvalidInputException,
    client.OAuthProviderException,
    client.ResourceAlreadyExistsException,
    client.ResourceNotFoundException,
) as e:
    print(e)

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

Method definition

def batch_delete_builds(
    self,
    *,
    ids: Sequence[str],
) -> BatchDeleteBuildsOutputTypeDef:  # (1)
    ...

1. See BatchDeleteBuildsOutputTypeDef

Usage example with kwargs

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

Method definition

def batch_get_build_batches(
    self,
    *,
    ids: Sequence[str],
) -> BatchGetBuildBatchesOutputTypeDef:  # (1)
    ...

1. See BatchGetBuildBatchesOutputTypeDef

Usage example with kwargs

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

Method definition

def batch_get_builds(
    self,
    *,
    ids: Sequence[str],
) -> BatchGetBuildsOutputTypeDef:  # (1)
    ...

1. See BatchGetBuildsOutputTypeDef

Usage example with kwargs

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

parent.batch_get_builds(**kwargs)

1. See BatchGetBuildsInputRequestTypeDef

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

Method definition

def batch_get_projects(
    self,
    *,
    names: Sequence[str],
) -> BatchGetProjectsOutputTypeDef:  # (1)
    ...

1. See BatchGetProjectsOutputTypeDef

Usage example with kwargs

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

Method definition

def batch_get_report_groups(
    self,
    *,
    reportGroupArns: Sequence[str],
) -> BatchGetReportGroupsOutputTypeDef:  # (1)
    ...

1. See BatchGetReportGroupsOutputTypeDef

Usage example with kwargs

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

Method definition

def batch_get_reports(
    self,
    *,
    reportArns: Sequence[str],
) -> BatchGetReportsOutputTypeDef:  # (1)
    ...

1. See BatchGetReportsOutputTypeDef

Usage example with kwargs

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

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

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

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)
    ...

1. See ProjectSourceTypeDef
2. See ProjectArtifactsTypeDef
3. See ProjectEnvironmentTypeDef
4. See ProjectSourceTypeDef
5. See ProjectSourceVersionTypeDef
6. See ProjectArtifactsTypeDef
7. See ProjectCacheTypeDef
8. See TagTypeDef
9. See VpcConfigTypeDef
10. See LogsConfigTypeDef
11. See ProjectFileSystemLocationTypeDef
12. See ProjectBuildBatchConfigTypeDef
13. See CreateProjectOutputTypeDef

Usage example with kwargs

kwargs: CreateProjectInputRequestTypeDef = {  # (1)
    "name": ...,
    "source": ...,
    "artifacts": ...,
    "environment": ...,
    "serviceRole": ...,
}

parent.create_project(**kwargs)

1. See CreateProjectInputRequestTypeDef

create_report_group

Creates a report group.

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

Method definition

def create_report_group(
    self,
    *,
    name: str,
    type: ReportTypeType,  # (1)
    exportConfig: ReportExportConfigTypeDef,  # (2)
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateReportGroupOutputTypeDef:  # (4)
    ...

1. See ReportTypeType
2. See ReportExportConfigTypeDef
3. See TagTypeDef
4. See CreateReportGroupOutputTypeDef

Usage example with kwargs

kwargs: CreateReportGroupInputRequestTypeDef = {  # (1)
    "name": ...,
    "type": ...,
    "exportConfig": ...,
}

parent.create_report_group(**kwargs)

1. See CreateReportGroupInputRequestTypeDef

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

Method definition

def create_webhook(
    self,
    *,
    projectName: str,
    branchFilter: str = ...,
    filterGroups: Sequence[Sequence[WebhookFilterTypeDef]] = ...,  # (1)
    buildType: WebhookBuildTypeType = ...,  # (2)
) -> CreateWebhookOutputTypeDef:  # (3)
    ...

1. See WebhookFilterTypeDef
2. See WebhookBuildTypeType
3. See CreateWebhookOutputTypeDef

Usage example with kwargs

kwargs: CreateWebhookInputRequestTypeDef = {  # (1)
    "projectName": ...,
}

parent.create_webhook(**kwargs)

1. See CreateWebhookInputRequestTypeDef

delete_build_batch

Deletes a batch build.

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

Method definition

def delete_build_batch(
    self,
    *,
    id: str,
) -> DeleteBuildBatchOutputTypeDef:  # (1)
    ...

1. See DeleteBuildBatchOutputTypeDef

Usage example with kwargs

kwargs: DeleteBuildBatchInputRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_build_batch(**kwargs)

1. See DeleteBuildBatchInputRequestTypeDef

delete_project

Deletes a build project.

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

Method definition

def delete_project(
    self,
    *,
    name: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteProjectInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_project(**kwargs)

1. See DeleteProjectInputRequestTypeDef

delete_report

Deletes a report.

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

Method definition

def delete_report(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteReportInputRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_report(**kwargs)

1. See DeleteReportInputRequestTypeDef

delete_report_group

Deletes a report group.

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

Method definition

def delete_report_group(
    self,
    *,
    arn: str,
    deleteReports: bool = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteReportGroupInputRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_report_group(**kwargs)

1. See DeleteReportGroupInputRequestTypeDef

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

Method definition

def delete_resource_policy(
    self,
    *,
    resourceArn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteResourcePolicyInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.delete_resource_policy(**kwargs)

1. See DeleteResourcePolicyInputRequestTypeDef

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. boto3 documentation

Method definition

def delete_source_credentials(
    self,
    *,
    arn: str,
) -> DeleteSourceCredentialsOutputTypeDef:  # (1)
    ...

1. See DeleteSourceCredentialsOutputTypeDef

Usage example with kwargs

kwargs: DeleteSourceCredentialsInputRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_source_credentials(**kwargs)

1. See DeleteSourceCredentialsInputRequestTypeDef

delete_webhook

For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository.

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

Method definition

def delete_webhook(
    self,
    *,
    projectName: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteWebhookInputRequestTypeDef = {  # (1)
    "projectName": ...,
}

parent.delete_webhook(**kwargs)

1. See DeleteWebhookInputRequestTypeDef

describe_code_coverages

Retrieves one or more code coverage reports.

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

Method definition

def describe_code_coverages(
    self,
    *,
    reportArn: str,
    nextToken: str = ...,
    maxResults: int = ...,
    sortOrder: SortOrderTypeType = ...,  # (1)
    sortBy: ReportCodeCoverageSortByTypeType = ...,  # (2)
    minLineCoveragePercentage: float = ...,
    maxLineCoveragePercentage: float = ...,
) -> DescribeCodeCoveragesOutputTypeDef:  # (3)
    ...

1. See SortOrderTypeType
2. See ReportCodeCoverageSortByTypeType
3. See DescribeCodeCoveragesOutputTypeDef

Usage example with kwargs

kwargs: DescribeCodeCoveragesInputRequestTypeDef = {  # (1)
    "reportArn": ...,
}

parent.describe_code_coverages(**kwargs)

1. See DescribeCodeCoveragesInputRequestTypeDef

describe_test_cases

Returns a list of details about test cases for a report.

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

Method definition

def describe_test_cases(
    self,
    *,
    reportArn: str,
    nextToken: str = ...,
    maxResults: int = ...,
    filter: TestCaseFilterTypeDef = ...,  # (1)
) -> DescribeTestCasesOutputTypeDef:  # (2)
    ...

1. See TestCaseFilterTypeDef
2. See DescribeTestCasesOutputTypeDef

Usage example with kwargs

kwargs: DescribeTestCasesInputRequestTypeDef = {  # (1)
    "reportArn": ...,
}

parent.describe_test_cases(**kwargs)

1. See DescribeTestCasesInputRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_report_group_trend

Analyzes and accumulates test report values for the specified test reports.

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

Method definition

def get_report_group_trend(
    self,
    *,
    reportGroupArn: str,
    trendField: ReportGroupTrendFieldTypeType,  # (1)
    numOfReports: int = ...,
) -> GetReportGroupTrendOutputTypeDef:  # (2)
    ...

1. See ReportGroupTrendFieldTypeType
2. See GetReportGroupTrendOutputTypeDef

Usage example with kwargs

kwargs: GetReportGroupTrendInputRequestTypeDef = {  # (1)
    "reportGroupArn": ...,
    "trendField": ...,
}

parent.get_report_group_trend(**kwargs)

1. See GetReportGroupTrendInputRequestTypeDef

get_resource_policy

Gets a resource policy that is identified by its resource ARN.

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

Method definition

def get_resource_policy(
    self,
    *,
    resourceArn: str,
) -> GetResourcePolicyOutputTypeDef:  # (1)
    ...

1. See GetResourcePolicyOutputTypeDef

Usage example with kwargs

kwargs: GetResourcePolicyInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.get_resource_policy(**kwargs)

1. See GetResourcePolicyInputRequestTypeDef

import_source_credentials

Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.

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

Method definition

def import_source_credentials(
    self,
    *,
    token: str,
    serverType: ServerTypeType,  # (1)
    authType: AuthTypeType,  # (2)
    username: str = ...,
    shouldOverwrite: bool = ...,
) -> ImportSourceCredentialsOutputTypeDef:  # (3)
    ...

1. See ServerTypeType
2. See AuthTypeType
3. See ImportSourceCredentialsOutputTypeDef

Usage example with kwargs

kwargs: ImportSourceCredentialsInputRequestTypeDef = {  # (1)
    "token": ...,
    "serverType": ...,
    "authType": ...,
}

parent.import_source_credentials(**kwargs)

1. See ImportSourceCredentialsInputRequestTypeDef

invalidate_project_cache

Resets the cache for a project.

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

Method definition

def invalidate_project_cache(
    self,
    *,
    projectName: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: InvalidateProjectCacheInputRequestTypeDef = {  # (1)
    "projectName": ...,
}

parent.invalidate_project_cache(**kwargs)

1. See InvalidateProjectCacheInputRequestTypeDef

list_build_batches

Retrieves the identifiers of your build batches in the current region.

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

Method definition

def list_build_batches(
    self,
    *,
    filter: BuildBatchFilterTypeDef = ...,  # (1)
    maxResults: int = ...,
    sortOrder: SortOrderTypeType = ...,  # (2)
    nextToken: str = ...,
) -> ListBuildBatchesOutputTypeDef:  # (3)
    ...

1. See BuildBatchFilterTypeDef
2. See SortOrderTypeType
3. See ListBuildBatchesOutputTypeDef

Usage example with kwargs

kwargs: ListBuildBatchesInputRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.list_build_batches(**kwargs)

1. See ListBuildBatchesInputRequestTypeDef

list_build_batches_for_project

Retrieves the identifiers of the build batches for a specific project.

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

Method definition

def list_build_batches_for_project(
    self,
    *,
    projectName: str = ...,
    filter: BuildBatchFilterTypeDef = ...,  # (1)
    maxResults: int = ...,
    sortOrder: SortOrderTypeType = ...,  # (2)
    nextToken: str = ...,
) -> ListBuildBatchesForProjectOutputTypeDef:  # (3)
    ...

1. See BuildBatchFilterTypeDef
2. See SortOrderTypeType
3. See ListBuildBatchesForProjectOutputTypeDef

Usage example with kwargs

kwargs: ListBuildBatchesForProjectInputRequestTypeDef = {  # (1)
    "projectName": ...,
}

parent.list_build_batches_for_project(**kwargs)

1. See ListBuildBatchesForProjectInputRequestTypeDef

list_builds

Gets a list of build IDs, with each build ID representing a single build.

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

Method definition

def list_builds(
    self,
    *,
    sortOrder: SortOrderTypeType = ...,  # (1)
    nextToken: str = ...,
) -> ListBuildsOutputTypeDef:  # (2)
    ...

1. See SortOrderTypeType
2. See ListBuildsOutputTypeDef

Usage example with kwargs

kwargs: ListBuildsInputRequestTypeDef = {  # (1)
    "sortOrder": ...,
}

parent.list_builds(**kwargs)

1. See ListBuildsInputRequestTypeDef

list_builds_for_project

Gets a list of build identifiers for the specified build project, with each build identifier representing a single build.

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

Method definition

def list_builds_for_project(
    self,
    *,
    projectName: str,
    sortOrder: SortOrderTypeType = ...,  # (1)
    nextToken: str = ...,
) -> ListBuildsForProjectOutputTypeDef:  # (2)
    ...

1. See SortOrderTypeType
2. See ListBuildsForProjectOutputTypeDef

Usage example with kwargs

kwargs: ListBuildsForProjectInputRequestTypeDef = {  # (1)
    "projectName": ...,
}

parent.list_builds_for_project(**kwargs)

1. See ListBuildsForProjectInputRequestTypeDef

list_curated_environment_images

Gets information about Docker images that are managed by CodeBuild.

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

Method definition

def list_curated_environment_images(
    self,
) -> ListCuratedEnvironmentImagesOutputTypeDef:  # (1)
    ...

1. See ListCuratedEnvironmentImagesOutputTypeDef

list_projects

Gets a list of build project names, with each build project name representing a single build project.

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

Method definition

def list_projects(
    self,
    *,
    sortBy: ProjectSortByTypeType = ...,  # (1)
    sortOrder: SortOrderTypeType = ...,  # (2)
    nextToken: str = ...,
) -> ListProjectsOutputTypeDef:  # (3)
    ...

1. See ProjectSortByTypeType
2. See SortOrderTypeType
3. See ListProjectsOutputTypeDef

Usage example with kwargs

kwargs: ListProjectsInputRequestTypeDef = {  # (1)
    "sortBy": ...,
}

parent.list_projects(**kwargs)

1. See ListProjectsInputRequestTypeDef

list_report_groups

Gets a list ARNs for the report groups in the current Amazon Web Services account.

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

Method definition

def list_report_groups(
    self,
    *,
    sortOrder: SortOrderTypeType = ...,  # (1)
    sortBy: ReportGroupSortByTypeType = ...,  # (2)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListReportGroupsOutputTypeDef:  # (3)
    ...

1. See SortOrderTypeType
2. See ReportGroupSortByTypeType
3. See ListReportGroupsOutputTypeDef

Usage example with kwargs

kwargs: ListReportGroupsInputRequestTypeDef = {  # (1)
    "sortOrder": ...,
}

parent.list_report_groups(**kwargs)

1. See ListReportGroupsInputRequestTypeDef

list_reports

Returns a list of ARNs for the reports in the current Amazon Web Services account.

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

Method definition

def list_reports(
    self,
    *,
    sortOrder: SortOrderTypeType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
    filter: ReportFilterTypeDef = ...,  # (2)
) -> ListReportsOutputTypeDef:  # (3)
    ...

1. See SortOrderTypeType
2. See ReportFilterTypeDef
3. See ListReportsOutputTypeDef

Usage example with kwargs

kwargs: ListReportsInputRequestTypeDef = {  # (1)
    "sortOrder": ...,
}

parent.list_reports(**kwargs)

1. See ListReportsInputRequestTypeDef

list_reports_for_report_group

Returns a list of ARNs for the reports that belong to a ReportGroup .

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

Method definition

def list_reports_for_report_group(
    self,
    *,
    reportGroupArn: str,
    nextToken: str = ...,
    sortOrder: SortOrderTypeType = ...,  # (1)
    maxResults: int = ...,
    filter: ReportFilterTypeDef = ...,  # (2)
) -> ListReportsForReportGroupOutputTypeDef:  # (3)
    ...

1. See SortOrderTypeType
2. See ReportFilterTypeDef
3. See ListReportsForReportGroupOutputTypeDef

Usage example with kwargs

kwargs: ListReportsForReportGroupInputRequestTypeDef = {  # (1)
    "reportGroupArn": ...,
}

parent.list_reports_for_report_group(**kwargs)

1. See ListReportsForReportGroupInputRequestTypeDef

list_shared_projects

Gets a list of projects that are shared with other Amazon Web Services accounts or users.

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

Method definition

def list_shared_projects(
    self,
    *,
    sortBy: SharedResourceSortByTypeType = ...,  # (1)
    sortOrder: SortOrderTypeType = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSharedProjectsOutputTypeDef:  # (3)
    ...

1. See SharedResourceSortByTypeType
2. See SortOrderTypeType
3. See ListSharedProjectsOutputTypeDef

Usage example with kwargs

kwargs: ListSharedProjectsInputRequestTypeDef = {  # (1)
    "sortBy": ...,
}

parent.list_shared_projects(**kwargs)

1. See ListSharedProjectsInputRequestTypeDef

list_shared_report_groups

Gets a list of report groups that are shared with other Amazon Web Services accounts or users.

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

Method definition

def list_shared_report_groups(
    self,
    *,
    sortOrder: SortOrderTypeType = ...,  # (1)
    sortBy: SharedResourceSortByTypeType = ...,  # (2)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSharedReportGroupsOutputTypeDef:  # (3)
    ...

1. See SortOrderTypeType
2. See SharedResourceSortByTypeType
3. See ListSharedReportGroupsOutputTypeDef

Usage example with kwargs

kwargs: ListSharedReportGroupsInputRequestTypeDef = {  # (1)
    "sortOrder": ...,
}

parent.list_shared_report_groups(**kwargs)

1. See ListSharedReportGroupsInputRequestTypeDef

list_source_credentials

Returns a list of SourceCredentialsInfo objects.

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

Method definition

def list_source_credentials(
    self,
) -> ListSourceCredentialsOutputTypeDef:  # (1)
    ...

1. See ListSourceCredentialsOutputTypeDef

put_resource_policy

Stores a resource policy for the ARN of a Project or ReportGroup object.

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

Method definition

def put_resource_policy(
    self,
    *,
    policy: str,
    resourceArn: str,
) -> PutResourcePolicyOutputTypeDef:  # (1)
    ...

1. See PutResourcePolicyOutputTypeDef

Usage example with kwargs

kwargs: PutResourcePolicyInputRequestTypeDef = {  # (1)
    "policy": ...,
    "resourceArn": ...,
}

parent.put_resource_policy(**kwargs)

1. See PutResourcePolicyInputRequestTypeDef

retry_build

Restarts a build.

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

Method definition

def retry_build(
    self,
    *,
    id: str = ...,
    idempotencyToken: str = ...,
) -> RetryBuildOutputTypeDef:  # (1)
    ...

1. See RetryBuildOutputTypeDef

Usage example with kwargs

kwargs: RetryBuildInputRequestTypeDef = {  # (1)
    "id": ...,
}

parent.retry_build(**kwargs)

1. See RetryBuildInputRequestTypeDef

retry_build_batch

Restarts a failed batch build.

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

Method definition

def retry_build_batch(
    self,
    *,
    id: str = ...,
    idempotencyToken: str = ...,
    retryType: RetryBuildBatchTypeType = ...,  # (1)
) -> RetryBuildBatchOutputTypeDef:  # (2)
    ...

1. See RetryBuildBatchTypeType
2. See RetryBuildBatchOutputTypeDef

Usage example with kwargs

kwargs: RetryBuildBatchInputRequestTypeDef = {  # (1)
    "id": ...,
}

parent.retry_build_batch(**kwargs)

1. See RetryBuildBatchInputRequestTypeDef

start_build

Starts running a build.

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

Method definition

def start_build(
    self,
    *,
    projectName: str,
    secondarySourcesOverride: Sequence[ProjectSourceTypeDef] = ...,  # (1)
    secondarySourcesVersionOverride: Sequence[ProjectSourceVersionTypeDef] = ...,  # (2)
    sourceVersion: str = ...,
    artifactsOverride: ProjectArtifactsTypeDef = ...,  # (3)
    secondaryArtifactsOverride: Sequence[ProjectArtifactsTypeDef] = ...,  # (4)
    environmentVariablesOverride: Sequence[EnvironmentVariableTypeDef] = ...,  # (5)
    sourceTypeOverride: SourceTypeType = ...,  # (6)
    sourceLocationOverride: str = ...,
    sourceAuthOverride: SourceAuthTypeDef = ...,  # (7)
    gitCloneDepthOverride: int = ...,
    gitSubmodulesConfigOverride: GitSubmodulesConfigTypeDef = ...,  # (8)
    buildspecOverride: str = ...,
    insecureSslOverride: bool = ...,
    reportBuildStatusOverride: bool = ...,
    buildStatusConfigOverride: BuildStatusConfigTypeDef = ...,  # (9)
    environmentTypeOverride: EnvironmentTypeType = ...,  # (10)
    imageOverride: str = ...,
    computeTypeOverride: ComputeTypeType = ...,  # (11)
    certificateOverride: str = ...,
    cacheOverride: ProjectCacheTypeDef = ...,  # (12)
    serviceRoleOverride: str = ...,
    privilegedModeOverride: bool = ...,
    timeoutInMinutesOverride: int = ...,
    queuedTimeoutInMinutesOverride: int = ...,
    encryptionKeyOverride: str = ...,
    idempotencyToken: str = ...,
    logsConfigOverride: LogsConfigTypeDef = ...,  # (13)
    registryCredentialOverride: RegistryCredentialTypeDef = ...,  # (14)
    imagePullCredentialsTypeOverride: ImagePullCredentialsTypeType = ...,  # (15)
    debugSessionEnabled: bool = ...,
) -> StartBuildOutputTypeDef:  # (16)
    ...

1. See ProjectSourceTypeDef
2. See ProjectSourceVersionTypeDef
3. See ProjectArtifactsTypeDef
4. See ProjectArtifactsTypeDef
5. See EnvironmentVariableTypeDef
6. See SourceTypeType
7. See SourceAuthTypeDef
8. See GitSubmodulesConfigTypeDef
9. See BuildStatusConfigTypeDef
10. See EnvironmentTypeType
11. See ComputeTypeType
12. See ProjectCacheTypeDef
13. See LogsConfigTypeDef
14. See RegistryCredentialTypeDef
15. See ImagePullCredentialsTypeType
16. See StartBuildOutputTypeDef

Usage example with kwargs

kwargs: StartBuildInputRequestTypeDef = {  # (1)
    "projectName": ...,
}

parent.start_build(**kwargs)

1. See StartBuildInputRequestTypeDef

start_build_batch

Starts a batch build for a project.

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

Method definition

def start_build_batch(
    self,
    *,
    projectName: str,
    secondarySourcesOverride: Sequence[ProjectSourceTypeDef] = ...,  # (1)
    secondarySourcesVersionOverride: Sequence[ProjectSourceVersionTypeDef] = ...,  # (2)
    sourceVersion: str = ...,
    artifactsOverride: ProjectArtifactsTypeDef = ...,  # (3)
    secondaryArtifactsOverride: Sequence[ProjectArtifactsTypeDef] = ...,  # (4)
    environmentVariablesOverride: Sequence[EnvironmentVariableTypeDef] = ...,  # (5)
    sourceTypeOverride: SourceTypeType = ...,  # (6)
    sourceLocationOverride: str = ...,
    sourceAuthOverride: SourceAuthTypeDef = ...,  # (7)
    gitCloneDepthOverride: int = ...,
    gitSubmodulesConfigOverride: GitSubmodulesConfigTypeDef = ...,  # (8)
    buildspecOverride: str = ...,
    insecureSslOverride: bool = ...,
    reportBuildBatchStatusOverride: bool = ...,
    environmentTypeOverride: EnvironmentTypeType = ...,  # (9)
    imageOverride: str = ...,
    computeTypeOverride: ComputeTypeType = ...,  # (10)
    certificateOverride: str = ...,
    cacheOverride: ProjectCacheTypeDef = ...,  # (11)
    serviceRoleOverride: str = ...,
    privilegedModeOverride: bool = ...,
    buildTimeoutInMinutesOverride: int = ...,
    queuedTimeoutInMinutesOverride: int = ...,
    encryptionKeyOverride: str = ...,
    idempotencyToken: str = ...,
    logsConfigOverride: LogsConfigTypeDef = ...,  # (12)
    registryCredentialOverride: RegistryCredentialTypeDef = ...,  # (13)
    imagePullCredentialsTypeOverride: ImagePullCredentialsTypeType = ...,  # (14)
    buildBatchConfigOverride: ProjectBuildBatchConfigTypeDef = ...,  # (15)
    debugSessionEnabled: bool = ...,
) -> StartBuildBatchOutputTypeDef:  # (16)
    ...

1. See ProjectSourceTypeDef
2. See ProjectSourceVersionTypeDef
3. See ProjectArtifactsTypeDef
4. See ProjectArtifactsTypeDef
5. See EnvironmentVariableTypeDef
6. See SourceTypeType
7. See SourceAuthTypeDef
8. See GitSubmodulesConfigTypeDef
9. See EnvironmentTypeType
10. See ComputeTypeType
11. See ProjectCacheTypeDef
12. See LogsConfigTypeDef
13. See RegistryCredentialTypeDef
14. See ImagePullCredentialsTypeType
15. See ProjectBuildBatchConfigTypeDef
16. See StartBuildBatchOutputTypeDef

Usage example with kwargs

kwargs: StartBuildBatchInputRequestTypeDef = {  # (1)
    "projectName": ...,
}

parent.start_build_batch(**kwargs)

1. See StartBuildBatchInputRequestTypeDef

stop_build

Attempts to stop running a build.

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

Method definition

def stop_build(
    self,
    *,
    id: str,
) -> StopBuildOutputTypeDef:  # (1)
    ...

1. See StopBuildOutputTypeDef

Usage example with kwargs

kwargs: StopBuildInputRequestTypeDef = {  # (1)
    "id": ...,
}

parent.stop_build(**kwargs)

1. See StopBuildInputRequestTypeDef

stop_build_batch

Stops a running batch build.

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

Method definition

def stop_build_batch(
    self,
    *,
    id: str,
) -> StopBuildBatchOutputTypeDef:  # (1)
    ...

1. See StopBuildBatchOutputTypeDef

Usage example with kwargs

kwargs: StopBuildBatchInputRequestTypeDef = {  # (1)
    "id": ...,
}

parent.stop_build_batch(**kwargs)

1. See StopBuildBatchInputRequestTypeDef

update_project

Changes the settings of a build project.

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

Method definition

def update_project(
    self,
    *,
    name: str,
    description: str = ...,
    source: ProjectSourceTypeDef = ...,  # (1)
    secondarySources: Sequence[ProjectSourceTypeDef] = ...,  # (2)
    sourceVersion: str = ...,
    secondarySourceVersions: Sequence[ProjectSourceVersionTypeDef] = ...,  # (3)
    artifacts: ProjectArtifactsTypeDef = ...,  # (4)
    secondaryArtifacts: Sequence[ProjectArtifactsTypeDef] = ...,  # (5)
    cache: ProjectCacheTypeDef = ...,  # (6)
    environment: ProjectEnvironmentTypeDef = ...,  # (7)
    serviceRole: str = ...,
    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 = ...,
) -> UpdateProjectOutputTypeDef:  # (13)
    ...

1. See ProjectSourceTypeDef
2. See ProjectSourceTypeDef
3. See ProjectSourceVersionTypeDef
4. See ProjectArtifactsTypeDef
5. See ProjectArtifactsTypeDef
6. See ProjectCacheTypeDef
7. See ProjectEnvironmentTypeDef
8. See TagTypeDef
9. See VpcConfigTypeDef
10. See LogsConfigTypeDef
11. See ProjectFileSystemLocationTypeDef
12. See ProjectBuildBatchConfigTypeDef
13. See UpdateProjectOutputTypeDef

Usage example with kwargs

kwargs: UpdateProjectInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.update_project(**kwargs)

1. See UpdateProjectInputRequestTypeDef

update_project_visibility

Changes the public visibility for a project.

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

Method definition

def update_project_visibility(
    self,
    *,
    projectArn: str,
    projectVisibility: ProjectVisibilityTypeType,  # (1)
    resourceAccessRole: str = ...,
) -> UpdateProjectVisibilityOutputTypeDef:  # (2)
    ...

1. See ProjectVisibilityTypeType
2. See UpdateProjectVisibilityOutputTypeDef

Usage example with kwargs

kwargs: UpdateProjectVisibilityInputRequestTypeDef = {  # (1)
    "projectArn": ...,
    "projectVisibility": ...,
}

parent.update_project_visibility(**kwargs)

1. See UpdateProjectVisibilityInputRequestTypeDef

update_report_group

Updates a report group.

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

Method definition

def update_report_group(
    self,
    *,
    arn: str,
    exportConfig: ReportExportConfigTypeDef = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> UpdateReportGroupOutputTypeDef:  # (3)
    ...

1. See ReportExportConfigTypeDef
2. See TagTypeDef
3. See UpdateReportGroupOutputTypeDef

Usage example with kwargs

kwargs: UpdateReportGroupInputRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.update_report_group(**kwargs)

1. See UpdateReportGroupInputRequestTypeDef

update_webhook

Updates the webhook associated with an CodeBuild build project.

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

Method definition

def update_webhook(
    self,
    *,
    projectName: str,
    branchFilter: str = ...,
    rotateSecret: bool = ...,
    filterGroups: Sequence[Sequence[WebhookFilterTypeDef]] = ...,  # (1)
    buildType: WebhookBuildTypeType = ...,  # (2)
) -> UpdateWebhookOutputTypeDef:  # (3)
    ...

1. See WebhookFilterTypeDef
2. See WebhookBuildTypeType
3. See UpdateWebhookOutputTypeDef

Usage example with kwargs

kwargs: UpdateWebhookInputRequestTypeDef = {  # (1)
    "projectName": ...,
}

parent.update_webhook(**kwargs)

1. See UpdateWebhookInputRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("codebuild").get_paginator method with overloads.

• client.get_paginator("describe_code_coverages") -> DescribeCodeCoveragesPaginator
• client.get_paginator("describe_test_cases") -> DescribeTestCasesPaginator
• client.get_paginator("list_build_batches") -> ListBuildBatchesPaginator
• client.get_paginator("list_build_batches_for_project") -> ListBuildBatchesForProjectPaginator
• client.get_paginator("list_builds") -> ListBuildsPaginator
• client.get_paginator("list_builds_for_project") -> ListBuildsForProjectPaginator
• client.get_paginator("list_projects") -> ListProjectsPaginator
• client.get_paginator("list_report_groups") -> ListReportGroupsPaginator
• client.get_paginator("list_reports") -> ListReportsPaginator
• client.get_paginator("list_reports_for_report_group") -> ListReportsForReportGroupPaginator
• client.get_paginator("list_shared_projects") -> ListSharedProjectsPaginator
• client.get_paginator("list_shared_report_groups") -> ListSharedReportGroupsPaginator