start_build async ¶

async def start_build(
    self,
    project_name: "capo_codebuild.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[AsyncCodeBuildClientConfig] = None,
    secondary_sources_override: Optional[
        "capo_codebuild.types.project_sources.ProjectSources"
    ] = None,
    secondary_sources_version_override: Optional[
        "capo_codebuild.types.project_secondary_source_versions.ProjectSecondarySourceVersions"
    ] = None,
    source_version: Optional["capo_codebuild.types.string.String"] = None,
    artifacts_override: Optional[
        "capo_codebuild.types.project_artifacts.ProjectArtifacts"
    ] = None,
    secondary_artifacts_override: Optional[
        "capo_codebuild.types.project_artifacts_list.ProjectArtifactsList"
    ] = None,
    environment_variables_override: Optional[
        "capo_codebuild.types.environment_variables.EnvironmentVariables"
    ] = None,
    source_type_override: Optional[
        "capo_codebuild.types.source_type.SourceType"
    ] = None,
    source_location_override: Optional["capo_codebuild.types.string.String"] = None,
    source_auth_override: Optional[
        "capo_codebuild.types.source_auth.SourceAuth"
    ] = None,
    git_clone_depth_override: Optional[
        "capo_codebuild.types.git_clone_depth.GitCloneDepth"
    ] = None,
    git_submodules_config_override: Optional[
        "capo_codebuild.types.git_submodules_config.GitSubmodulesConfig"
    ] = None,
    buildspec_override: Optional["capo_codebuild.types.string.String"] = None,
    insecure_ssl_override: Optional[
        "capo_codebuild.types.wrapper_boolean.WrapperBoolean"
    ] = None,
    report_build_status_override: Optional[
        "capo_codebuild.types.wrapper_boolean.WrapperBoolean"
    ] = None,
    build_status_config_override: Optional[
        "capo_codebuild.types.build_status_config.BuildStatusConfig"
    ] = None,
    environment_type_override: Optional[
        "capo_codebuild.types.environment_type.EnvironmentType"
    ] = None,
    image_override: Optional[
        "capo_codebuild.types.non_empty_string.NonEmptyString"
    ] = None,
    compute_type_override: Optional[
        "capo_codebuild.types.compute_type.ComputeType"
    ] = None,
    certificate_override: Optional["capo_codebuild.types.string.String"] = None,
    cache_override: Optional[
        "capo_codebuild.types.project_cache.ProjectCache"
    ] = None,
    service_role_override: Optional[
        "capo_codebuild.types.non_empty_string.NonEmptyString"
    ] = None,
    privileged_mode_override: Optional[
        "capo_codebuild.types.wrapper_boolean.WrapperBoolean"
    ] = None,
    timeout_in_minutes_override: Optional[
        "capo_codebuild.types.build_time_out.BuildTimeOut"
    ] = None,
    queued_timeout_in_minutes_override: Optional[
        "capo_codebuild.types.time_out.TimeOut"
    ] = None,
    encryption_key_override: Optional[
        "capo_codebuild.types.non_empty_string.NonEmptyString"
    ] = None,
    idempotency_token: Optional["capo_codebuild.types.string.String"] = None,
    logs_config_override: Optional[
        "capo_codebuild.types.logs_config.LogsConfig"
    ] = None,
    registry_credential_override: Optional[
        "capo_codebuild.types.registry_credential.RegistryCredential"
    ] = None,
    image_pull_credentials_type_override: Optional[
        "capo_codebuild.types.image_pull_credentials_type.ImagePullCredentialsType"
    ] = None,
    debug_session_enabled: Optional[
        "capo_codebuild.types.wrapper_boolean.WrapperBoolean"
    ] = None,
    fleet_override: Optional[
        "capo_codebuild.types.project_fleet.ProjectFleet"
    ] = None,
    auto_retry_limit_override: Optional[
        "capo_codebuild.types.wrapper_int.WrapperInt"
    ] = None,
    host_kernel_override: Optional[
        "capo_codebuild.types.host_kernel.HostKernel"
    ] = None,
) -> "capo_codebuild.types.start_build_output.StartBuildOutput":
    """<p>Starts running a build with the settings defined in the project. These setting include: how to run a build, where to get the source code, which build environment to use, which build commands to run, and where to store the build output.</p> <p>You can also start a build run by overriding some of the build settings in the project. The overrides only apply for that specific start build request. The settings in the project are unaltered.</p>

    Args:
        project_name: <p>The name of the CodeBuild build project to start running a build.</p>
        secondary_sources_override: <p> An array of <code>ProjectSource</code> objects. </p>
        secondary_sources_version_override: <p> An array of <code>ProjectSourceVersion</code> objects that specify one or more versions of the project's secondary sources to be used for this build only. </p>
        source_version: <p>The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:</p> <dl> <dt>CodeCommit</dt> <dd> <p>The commit ID, branch, or Git tag to use.</p> </dd> <dt>GitHub</dt> <dd> <p>The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p> </dd> <dt>GitLab</dt> <dd> <p>The commit ID, branch, or Git tag to use.</p> </dd> <dt>Bitbucket</dt> <dd> <p>The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p> </dd> <dt>Amazon S3</dt> <dd> <p>The version ID of the object that represents the build input ZIP file to use.</p> </dd> </dl> <p>If <code>sourceVersion</code> is specified at the project level, then this <code>sourceVersion</code> (at the build level) takes precedence. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>CodeBuild User Guide</i>. </p>
        artifacts_override: <p>Build output artifact settings that override, for this build only, the latest ones already defined in the build project.</p>
        secondary_artifacts_override: <p> An array of <code>ProjectArtifacts</code> objects. </p>
        environment_variables_override: <p>A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.</p>
        source_type_override: <p>A source input type, for this build, that overrides the source input defined in the build project.</p>
        source_location_override: <p>A location that overrides, for this build, the source location for the one defined in the build project.</p>
        source_auth_override: <p>An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket, GitHub, GitLab, or GitLab Self Managed.</p>
        git_clone_depth_override: <p>The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.</p>
        git_submodules_config_override: <p> Information about the Git submodules configuration for this build of an CodeBuild build project. </p>
        buildspec_override: <p>A buildspec file declaration that overrides the latest one defined in the build project, for this build only. The buildspec defined on the project is not changed.</p> <p>If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, <code>arn:aws:s3:::my-codebuild-sample2/buildspec.yml</code>). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>.</p> <note> <p>Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket. Alternatively, you can restrict overrides to the buildspec by using a condition key: <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/action-context-keys.html#action-context-keys-example-overridebuildspec.html">Prevent unauthorized modifications to project buildspec</a>.</p> </note>
        insecure_ssl_override: <p>Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.</p>
        report_build_status_override: <p> Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket, an <code>invalidInputException</code> is thrown. </p> <p>To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html">Source provider access</a> in the <i>CodeBuild User Guide</i>.</p> <note> <p> The status of a build triggered by a webhook is always reported to your source provider. </p> </note>
        build_status_config_override: <p>Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is <code>GITHUB</code>, <code>GITHUB_ENTERPRISE</code>, or <code>BITBUCKET</code>.</p>
        environment_type_override: <p>A container type for this build that overrides the one specified in the build project.</p>
        image_override: <p>The name of an image for this build that overrides the one specified in the build project.</p>
        compute_type_override: <p>The name of a compute type for this build that overrides the one specified in the build project.</p>
        certificate_override: <p>The name of a certificate for this build that overrides the one specified in the build project.</p>
        cache_override: <p>A ProjectCache object specified for this build that overrides the one defined in the build project.</p>
        service_role_override: <p>The name of a service role for this build that overrides the one specified in the build project.</p>
        privileged_mode_override: <p>Enable this flag to override privileged mode in the build project.</p>
        timeout_in_minutes_override: <p>The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the latest setting already defined in the build project.</p>
        queued_timeout_in_minutes_override: <p> The number of minutes a build is allowed to be queued before it times out. </p>
        encryption_key_override: <p>The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.</p> <note> <p> You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </p> </note> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>).</p>
        idempotency_token: <p>A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error. </p>
        logs_config_override: <p> Log settings for this build that override the log settings defined in the build project. </p>
        registry_credential_override: <p> The credentials for access to a private registry. </p>
        image_pull_credentials_type_override: <p>The type of credentials CodeBuild uses to pull images in your build. There are two valid values: </p> <dl> <dt>CODEBUILD</dt> <dd> <p>Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.</p> </dd> <dt>SERVICE_ROLE</dt> <dd> <p>Specifies that CodeBuild uses your build project's service role. </p> </dd> </dl> <p>When using a cross-account or private registry image, you must use <code>SERVICE_ROLE</code> credentials. When using an CodeBuild curated image, you must use <code>CODEBUILD</code> credentials. </p>
        debug_session_enabled: <p>Specifies if session debugging is enabled for this build. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html">Viewing a running build in Session Manager</a>.</p>
        fleet_override: <p>A ProjectFleet object specified for this build that overrides the one defined in the build project.</p>
        auto_retry_limit_override: <p>The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the <code>RetryBuild</code> API to automatically retry your build for up to 2 additional times.</p>
        host_kernel_override: <p>The host operating system kernel for this build that overrides the one specified in the build project.</p>

    Raises:
        capo_codebuild.errors.account_limit_exceeded_exception.AccountLimitExceededException: <p>An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.</p>
        capo_codebuild.errors.invalid_input_exception.InvalidInputException: <p>The input value that was provided is not valid.</p>
        capo_codebuild.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified Amazon Web Services resource cannot be found.</p>
        capo_codebuild.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codebuild.types.start_build_input.StartBuildInput]",
    ) -> AsyncOperationResponse[
        "capo_codebuild.types.start_build_output.StartBuildOutput"
    ]:
        import capo_codebuild._operations.code_build_20161006.start_build

        (
            output,
            http_response,
        ) = await capo_codebuild._operations.code_build_20161006.start_build.async_start_build(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartBuild")
    )
    input_: capo_codebuild.types.start_build_input.StartBuildInput = {
        "project_name": project_name
    }
    if secondary_sources_override is not None:
        input_["secondary_sources_override"] = secondary_sources_override
    if secondary_sources_version_override is not None:
        input_["secondary_sources_version_override"] = (
            secondary_sources_version_override
        )
    if source_version is not None:
        input_["source_version"] = source_version
    if artifacts_override is not None:
        input_["artifacts_override"] = artifacts_override
    if secondary_artifacts_override is not None:
        input_["secondary_artifacts_override"] = secondary_artifacts_override
    if environment_variables_override is not None:
        input_["environment_variables_override"] = environment_variables_override
    if source_type_override is not None:
        input_["source_type_override"] = source_type_override
    if source_location_override is not None:
        input_["source_location_override"] = source_location_override
    if source_auth_override is not None:
        input_["source_auth_override"] = source_auth_override
    if git_clone_depth_override is not None:
        input_["git_clone_depth_override"] = git_clone_depth_override
    if git_submodules_config_override is not None:
        input_["git_submodules_config_override"] = git_submodules_config_override
    if buildspec_override is not None:
        input_["buildspec_override"] = buildspec_override
    if insecure_ssl_override is not None:
        input_["insecure_ssl_override"] = insecure_ssl_override
    if report_build_status_override is not None:
        input_["report_build_status_override"] = report_build_status_override
    if build_status_config_override is not None:
        input_["build_status_config_override"] = build_status_config_override
    if environment_type_override is not None:
        input_["environment_type_override"] = environment_type_override
    if image_override is not None:
        input_["image_override"] = image_override
    if compute_type_override is not None:
        input_["compute_type_override"] = compute_type_override
    if certificate_override is not None:
        input_["certificate_override"] = certificate_override
    if cache_override is not None:
        input_["cache_override"] = cache_override
    if service_role_override is not None:
        input_["service_role_override"] = service_role_override
    if privileged_mode_override is not None:
        input_["privileged_mode_override"] = privileged_mode_override
    if timeout_in_minutes_override is not None:
        input_["timeout_in_minutes_override"] = timeout_in_minutes_override
    if queued_timeout_in_minutes_override is not None:
        input_["queued_timeout_in_minutes_override"] = (
            queued_timeout_in_minutes_override
        )
    if encryption_key_override is not None:
        input_["encryption_key_override"] = encryption_key_override
    if idempotency_token is not None:
        input_["idempotency_token"] = idempotency_token
    if logs_config_override is not None:
        input_["logs_config_override"] = logs_config_override
    if registry_credential_override is not None:
        input_["registry_credential_override"] = registry_credential_override
    if image_pull_credentials_type_override is not None:
        input_["image_pull_credentials_type_override"] = (
            image_pull_credentials_type_override
        )
    if debug_session_enabled is not None:
        input_["debug_session_enabled"] = debug_session_enabled
    if fleet_override is not None:
        input_["fleet_override"] = fleet_override
    if auto_retry_limit_override is not None:
        input_["auto_retry_limit_override"] = auto_retry_limit_override
    if host_kernel_override is not None:
        input_["host_kernel_override"] = host_kernel_override

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output