start_build_batch async ¶

async def start_build_batch(
    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_batch_status_override: Optional[
        "capo_codebuild.types.wrapper_boolean.WrapperBoolean"
    ] = 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,
    build_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,
    build_batch_config_override: Optional[
        "capo_codebuild.types.project_build_batch_config.ProjectBuildBatchConfig"
    ] = None,
    debug_session_enabled: Optional[
        "capo_codebuild.types.wrapper_boolean.WrapperBoolean"
    ] = None,
) -> "capo_codebuild.types.start_build_batch_output.StartBuildBatchOutput":
    """<p>Starts a batch build for a project.</p>

    Args:
        project_name: <p>The name of the project.</p>
        secondary_sources_override: <p>An array of <code>ProjectSource</code> objects that override the secondary sources defined in the batch build project.</p>
        secondary_sources_version_override: <p>An array of <code>ProjectSourceVersion</code> objects that override the secondary source versions in the batch build project.</p>
        source_version: <p>The version of the batch 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>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>An array of <code>ProjectArtifacts</code> objects that contains information about the build output artifact overrides for the build project.</p>
        secondary_artifacts_override: <p>An array of <code>ProjectArtifacts</code> objects that override the secondary artifacts defined in the batch build project.</p>
        environment_variables_override: <p>An array of <code>EnvironmentVariable</code> objects that override, or add to, the environment variables defined in the batch build project.</p>
        source_type_override: <p>The source input type that overrides the source input defined in the batch build project.</p>
        source_location_override: <p>A location that overrides, for this batch build, the source location defined in the batch build project.</p>
        source_auth_override: <p>A <code>SourceAuth</code> object that overrides the one defined in the batch build project. This override applies only if the build project's source is BitBucket or GitHub.</p>
        git_clone_depth_override: <p>The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build only, any previous depth of history defined in the batch build project.</p>
        git_submodules_config_override: <p>A <code>GitSubmodulesConfig</code> object that overrides the Git submodules configuration for this batch build.</p>
        buildspec_override: <p>A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.</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>
        insecure_ssl_override: <p>Enable this flag to override the insecure SSL setting that is specified in the batch 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_batch_status_override: <p>Set to <code>true</code> to report to your source provider the status of a batch build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an <code>invalidInputException</code> is thrown. </p> <note> <p>The status of a build triggered by a webhook is always reported to your source provider. </p> </note>
        environment_type_override: <p>A container type for this batch build that overrides the one specified in the batch build project.</p>
        image_override: <p>The name of an image for this batch build that overrides the one specified in the batch build project.</p>
        compute_type_override: <p>The name of a compute type for this batch build that overrides the one specified in the batch build project.</p>
        certificate_override: <p>The name of a certificate for this batch build that overrides the one specified in the batch build project.</p>
        cache_override: <p>A <code>ProjectCache</code> object that specifies cache overrides.</p>
        service_role_override: <p>The name of a service role for this batch build that overrides the one specified in the batch build project.</p>
        privileged_mode_override: <p>Enable this flag to override privileged mode in the batch build project.</p>
        build_timeout_in_minutes_override: <p>Overrides the build timeout specified in the batch build project.</p>
        queued_timeout_in_minutes_override: <p>The number of minutes a batch 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 batch 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 <code>StartBuildBatch</code> request. The token is included in the <code>StartBuildBatch</code> request and is valid for five minutes. If you repeat the <code>StartBuildBatch</code> request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.</p>
        logs_config_override: <p>A <code>LogsConfig</code> object that override the log settings defined in the batch build project.</p>
        registry_credential_override: <p>A <code>RegistryCredential</code> object that overrides 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 batch 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>
        build_batch_config_override: <p>A <code>BuildBatchConfigOverride</code> object that contains batch build configuration overrides.</p>
        debug_session_enabled: <p>Specifies if session debugging is enabled for this batch 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>. Batch session debugging is not supported for matrix batch builds.</p>

    Raises:
        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_batch_input.StartBuildBatchInput]",
    ) -> AsyncOperationResponse[
        "capo_codebuild.types.start_build_batch_output.StartBuildBatchOutput"
    ]:
        import capo_codebuild._operations.code_build_20161006.start_build_batch

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartBuildBatch")
    )
    input_: capo_codebuild.types.start_build_batch_input.StartBuildBatchInput = {
        "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_batch_status_override is not None:
        input_["report_build_batch_status_override"] = (
            report_build_batch_status_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 build_timeout_in_minutes_override is not None:
        input_["build_timeout_in_minutes_override"] = (
            build_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 build_batch_config_override is not None:
        input_["build_batch_config_override"] = build_batch_config_override
    if debug_session_enabled is not None:
        input_["debug_session_enabled"] = debug_session_enabled

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