update_project async ¶

async def update_project(
    self,
    name: "capo_codebuild.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[AsyncCodeBuildClientConfig] = None,
    description: Optional[
        "capo_codebuild.types.project_description.ProjectDescription"
    ] = None,
    source: Optional["capo_codebuild.types.project_source.ProjectSource"] = None,
    secondary_sources: Optional[
        "capo_codebuild.types.project_sources.ProjectSources"
    ] = None,
    source_version: Optional["capo_codebuild.types.string.String"] = None,
    secondary_source_versions: Optional[
        "capo_codebuild.types.project_secondary_source_versions.ProjectSecondarySourceVersions"
    ] = None,
    artifacts: Optional[
        "capo_codebuild.types.project_artifacts.ProjectArtifacts"
    ] = None,
    secondary_artifacts: Optional[
        "capo_codebuild.types.project_artifacts_list.ProjectArtifactsList"
    ] = None,
    cache: Optional["capo_codebuild.types.project_cache.ProjectCache"] = None,
    environment: Optional[
        "capo_codebuild.types.project_environment.ProjectEnvironment"
    ] = None,
    service_role: Optional[
        "capo_codebuild.types.non_empty_string.NonEmptyString"
    ] = None,
    timeout_in_minutes: Optional[
        "capo_codebuild.types.build_time_out.BuildTimeOut"
    ] = None,
    queued_timeout_in_minutes: Optional[
        "capo_codebuild.types.time_out.TimeOut"
    ] = None,
    encryption_key: Optional[
        "capo_codebuild.types.non_empty_string.NonEmptyString"
    ] = None,
    tags: Optional["capo_codebuild.types.tag_list.TagList"] = None,
    vpc_config: Optional["capo_codebuild.types.vpc_config.VpcConfig"] = None,
    badge_enabled: Optional[
        "capo_codebuild.types.wrapper_boolean.WrapperBoolean"
    ] = None,
    logs_config: Optional["capo_codebuild.types.logs_config.LogsConfig"] = None,
    file_system_locations: Optional[
        "capo_codebuild.types.project_file_system_locations.ProjectFileSystemLocations"
    ] = None,
    build_batch_config: Optional[
        "capo_codebuild.types.project_build_batch_config.ProjectBuildBatchConfig"
    ] = None,
    concurrent_build_limit: Optional[
        "capo_codebuild.types.wrapper_int.WrapperInt"
    ] = None,
    auto_retry_limit: Optional[
        "capo_codebuild.types.wrapper_int.WrapperInt"
    ] = None,
) -> "capo_codebuild.types.update_project_output.UpdateProjectOutput":
    """<p>Changes the settings of a build project.</p>

    Args:
        name: <p>The name of the build project.</p> <note> <p>You cannot change a build project's name.</p> </note>
        description: <p>A new or replacement description of the build project.</p>
        source: <p>Information to be changed about the build input source code for the build project.</p>
        secondary_sources: <p> An array of <code>ProjectSource</code> objects. </p>
        source_version: <p> A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of: </p> <ul> <li> <p>For CodeCommit: the commit ID, branch, or Git tag to use.</p> </li> <li> <p>For GitHub: 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> </li> <li> <p>For GitLab: the commit ID, branch, or Git tag to use.</p> </li> <li> <p>For Bitbucket: 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> </li> <li> <p>For Amazon S3: the version ID of the object that represents the build input ZIP file to use.</p> </li> </ul> <p> If <code>sourceVersion</code> is specified at the build level, then that version takes precedence over this <code>sourceVersion</code> (at the project level). </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>
        secondary_source_versions: <p> An array of <code>ProjectSourceVersion</code> objects. If <code>secondarySourceVersions</code> is specified at the build level, then they take over these <code>secondarySourceVersions</code> (at the project level). </p>
        artifacts: <p>Information to be changed about the build output artifacts for the build project.</p>
        secondary_artifacts: <p> An array of <code>ProjectArtifact</code> objects. </p>
        cache: <p>Stores recently used information so that it can be quickly accessed at a later time.</p>
        environment: <p>Information to be changed about the build environment for the build project.</p>
        service_role: <p>The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.</p>
        timeout_in_minutes: <p>The replacement value in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.</p>
        queued_timeout_in_minutes: <p> The number of minutes a build is allowed to be queued before it times out. </p>
        encryption_key: <p>The Key Management Service customer master key (CMK) to be used for encrypting 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>
        tags: <p>An updated list of tag key and value pairs associated with this build project.</p> <p>These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.</p>
        vpc_config: <p>VpcConfig enables CodeBuild to access resources in an Amazon VPC.</p>
        badge_enabled: <p>Set this to true to generate a publicly accessible URL for your project's build badge.</p>
        logs_config: <p> Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both. </p>
        file_system_locations: <p> An array of <code>ProjectFileSystemLocation</code> objects for a CodeBuild build project. A <code>ProjectFileSystemLocation</code> object specifies the <code>identifier</code>, <code>location</code>, <code>mountOptions</code>, <code>mountPoint</code>, and <code>type</code> of a file system created using Amazon Elastic File System. </p>
        concurrent_build_limit: <p>The maximum number of concurrent builds that are allowed for this project.</p> <p>New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.</p> <p>To remove this limit, set this value to -1.</p>
        auto_retry_limit: <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>

    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.update_project_input.UpdateProjectInput]",
    ) -> AsyncOperationResponse[
        "capo_codebuild.types.update_project_output.UpdateProjectOutput"
    ]:
        import capo_codebuild._operations.code_build_20161006.update_project

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateProject")
    )
    input_: capo_codebuild.types.update_project_input.UpdateProjectInput = {
        "name": name
    }
    if description is not None:
        input_["description"] = description
    if source is not None:
        input_["source"] = source
    if secondary_sources is not None:
        input_["secondary_sources"] = secondary_sources
    if source_version is not None:
        input_["source_version"] = source_version
    if secondary_source_versions is not None:
        input_["secondary_source_versions"] = secondary_source_versions
    if artifacts is not None:
        input_["artifacts"] = artifacts
    if secondary_artifacts is not None:
        input_["secondary_artifacts"] = secondary_artifacts
    if cache is not None:
        input_["cache"] = cache
    if environment is not None:
        input_["environment"] = environment
    if service_role is not None:
        input_["service_role"] = service_role
    if timeout_in_minutes is not None:
        input_["timeout_in_minutes"] = timeout_in_minutes
    if queued_timeout_in_minutes is not None:
        input_["queued_timeout_in_minutes"] = queued_timeout_in_minutes
    if encryption_key is not None:
        input_["encryption_key"] = encryption_key
    if tags is not None:
        input_["tags"] = tags
    if vpc_config is not None:
        input_["vpc_config"] = vpc_config
    if badge_enabled is not None:
        input_["badge_enabled"] = badge_enabled
    if logs_config is not None:
        input_["logs_config"] = logs_config
    if file_system_locations is not None:
        input_["file_system_locations"] = file_system_locations
    if build_batch_config is not None:
        input_["build_batch_config"] = build_batch_config
    if concurrent_build_limit is not None:
        input_["concurrent_build_limit"] = concurrent_build_limit
    if auto_retry_limit is not None:
        input_["auto_retry_limit"] = auto_retry_limit

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