AWS CodeBuild (version v1.*.*)

batch_delete_builds#

Deletes one or more builds.

{
  "ids" : [ "string" ]
}

batch_get_builds#

Gets information about builds.

{
  "ids" : [ "string" ]
}

batch_get_projects#

Gets information about build projects.

{
  "names" : [ "string" ]
}

create_project#

Creates a build project.

{
  "logsConfig" : {
    "cloudWatchLogs" : {
      "groupName" : " The group name of the logs in Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams. ",
      "streamName" : " The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams. ",
      "status" : "The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are:  \n  ENABLED: Amazon CloudWatch Logs are enabled for this build project.  \n  DISABLED: Amazon CloudWatch Logs are not enabled for this build project. "
    },
    "s3Logs" : {
      "encryptionDisabled" : " Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. ",
      "location" : " The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket, and your path prefix is build-log, then acceptable formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log. ",
      "status" : "The current status of the S3 build logs. Valid values are:  \n  ENABLED: S3 build logs are enabled for this build project.  \n  DISABLED: S3 build logs are not enabled for this build project. "
    }
  },
  "cache" : {
    "modes" : [ "string. Possible values: LOCAL_DOCKER_LAYER_CACHE | LOCAL_SOURCE_CACHE | LOCAL_CUSTOM_CACHE" ],
    "location" : "Information about the cache location:   \n  NO_CACHE or LOCAL: This value is ignored.  \n  S3: This is the S3 bucket name/prefix. ",
    "type" : "The type of cache used by the build project. Valid values include:  \n  NO_CACHE: The build project does not use any cache.  \n  S3: The build project reads and writes from and to S3.  \n  LOCAL: The build project stores a cache locally on a build host that is only available to that build host. "
  },
  "secondarySources" : [ {
    "sourceIdentifier" : " An identifier for this project source. ",
    "buildspec" : "The build spec declaration to use for the builds in this build project. \nIf this value is not specified, a build spec must be included along with the source code to be built.",
    "auth" : {
      "resource" : "The resource value that applies to the specified authorization type.",
      "type" : " This data type is deprecated and is no longer accurate or used.   \nThe authorization type to use. The only valid value is OAUTH, which represents the OAuth authorization type."
    },
    "insecureSsl" : "Enable this flag to ignore SSL warnings while connecting to the project source code.",
    "reportBuildStatus" : " Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown. ",
    "gitSubmodulesConfig" : {
      "fetchSubmodules" : " Set to true to fetch Git submodules for your AWS CodeBuild build project. "
    },
    "location" : "Information about the location of the source code to be built. Valid values include:  \n For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.  \n For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).  \n For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following.     The path to the ZIP file that contains the source code (for example,  bucket-name/path/to/object-name.zip).     The path to the folder that contains the source code (for example,  bucket-name/path/to/source-code/folder/).     \n For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.  \n For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH. ",
    "type" : "The type of repository that contains the source code to be built. Valid values include:  \n  BITBUCKET: The source code is in a Bitbucket repository.  \n  CODECOMMIT: The source code is in an AWS CodeCommit repository.  \n  CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS CodePipeline.  \n  GITHUB: The source code is in a GitHub repository.  \n  NO_SOURCE: The project does not have input source code.  \n  S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket. ",
    "gitCloneDepth" : "Information about the Git clone depth for the build project."
  } ],
  "sourceVersion" : " 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:   \n For AWS CodeCommit: the commit ID to use.  \n 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 pr/pull-request-ID (for example pr/25). 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.  \n 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.  \n For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.   \n If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).  \n For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide. ",
  "serviceRole" : "The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.",
  "description" : "A description that makes the build project easy to identify.",
  "source" : {
    "sourceIdentifier" : " An identifier for this project source. ",
    "buildspec" : "The build spec declaration to use for the builds in this build project. \nIf this value is not specified, a build spec must be included along with the source code to be built.",
    "auth" : {
      "resource" : "The resource value that applies to the specified authorization type.",
      "type" : " This data type is deprecated and is no longer accurate or used.   \nThe authorization type to use. The only valid value is OAUTH, which represents the OAuth authorization type."
    },
    "insecureSsl" : "Enable this flag to ignore SSL warnings while connecting to the project source code.",
    "reportBuildStatus" : " Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown. ",
    "gitSubmodulesConfig" : {
      "fetchSubmodules" : " Set to true to fetch Git submodules for your AWS CodeBuild build project. "
    },
    "location" : "Information about the location of the source code to be built. Valid values include:  \n For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.  \n For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).  \n For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following.     The path to the ZIP file that contains the source code (for example,  bucket-name/path/to/object-name.zip).     The path to the folder that contains the source code (for example,  bucket-name/path/to/source-code/folder/).     \n For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.  \n For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH. ",
    "type" : "The type of repository that contains the source code to be built. Valid values include:  \n  BITBUCKET: The source code is in a Bitbucket repository.  \n  CODECOMMIT: The source code is in an AWS CodeCommit repository.  \n  CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS CodePipeline.  \n  GITHUB: The source code is in a GitHub repository.  \n  NO_SOURCE: The project does not have input source code.  \n  S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket. ",
    "gitCloneDepth" : "Information about the Git clone depth for the build project."
  },
  "encryptionKey" : "The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.  \n You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.   \nYou can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).",
  "secondarySourceVersions" : [ {
    "sourceIdentifier" : "An identifier for a source in the build project.",
    "sourceVersion" : "The source version for the corresponding source identifier. If specified, must be one of:  \n For AWS CodeCommit: the commit ID to use.  \n 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 pr/pull-request-ID (for example, pr/25). 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.  \n 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.  \n For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.   \n For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide. "
  } ],
  "secondaryArtifacts" : [ {
    "path" : "Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.   \nFor example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.",
    "encryptionDisabled" : " Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown. ",
    "name" : "Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash (\"/\"), the artifact is stored in the root of the output bucket.   \nFor example:  \n  If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip.   \n  If path is empty, namespaceType is set to NONE, and name is set to \"/\", the output artifact is stored in the root of the output bucket.   \n  If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to \"/\", the output artifact is stored in MyArtifacts/build-ID .  ",
    "location" : "Information about the build output artifact location:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the name of the output bucket. ",
    "packaging" : "The type of build output artifact to create:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, valid values include:    NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.    ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.   ",
    "type" : "The type of build output artifact. Valid values include:  \n  CODEPIPELINE: The build project has build output generated through AWS CodePipeline.  \n  NO_ARTIFACTS: The build project does not produce any build output.  \n  S3: The build project stores build output in Amazon Simple Storage Service (Amazon S3). ",
    "namespaceType" : "Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, valid values include:    BUILD_ID: Include the build ID in the location of the build output artifact.    NONE: Do not include the build ID. This is the default if namespaceType is not specified.     \nFor example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip.",
    "overrideArtifactName" : " If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. ",
    "artifactIdentifier" : " An identifier for this artifact definition. "
  } ],
  "tags" : [ {
    "value" : "The tag's value.",
    "key" : "The tag's key."
  } ],
  "environment" : {
    "registryCredential" : {
      "credential" : " The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.   \n The credential can use the name of the credentials only if they exist in your current region. ",
      "credentialProvider" : " The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager. "
    },
    "image" : "The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:  \n For an image tag: registry/repository:tag. For example, to specify an image with the tag \"latest,\" use registry/repository:latest.  \n For an image digest: registry/repository@digest. For example, to specify an image with the digest \"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,\" use registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf. ",
    "computeType" : "Information about the compute resources the build project uses. Available values include:  \n  BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.  \n  BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.  \n  BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds. ",
    "imagePullCredentialsType" : " The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:   \n  CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.   \n  SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role.    \n When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials. ",
    "environmentVariables" : [ {
      "name" : "The name or key of the environment variable.",
      "type" : "The type of environment variable. Valid values include:  \n  PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store.  \n  PLAINTEXT: An environment variable in plaintext format. ",
      "value" : "The value of the environment variable.  \nWe strongly discourage the use of environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI)."
    } ],
    "privilegedMode" : "Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. \nYou can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file: \nIf the operating system's base image is Ubuntu Linux: \n - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&  \n - timeout 15 sh -c \"until docker info; do echo .; sleep 1; done\"  \nIf the operating system's base image is Alpine Linux and the previous command does not work, add the -t argument to timeout: \n - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&  \n - timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\" ",
    "certificate" : "The certificate to use with this build project.",
    "type" : "The type of build environment to use for related builds."
  },
  "vpcConfig" : {
    "securityGroupIds" : [ "string" ],
    "vpcId" : "The ID of the Amazon VPC.",
    "subnets" : [ "string" ]
  },
  "name" : "The name of the build project.",
  "timeoutInMinutes" : "How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.",
  "queuedTimeoutInMinutes" : " The number of minutes a build is allowed to be queued before it times out. ",
  "badgeEnabled" : "Set this to true to generate a publicly accessible URL for your project's build badge.",
  "artifacts" : {
    "path" : "Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.   \nFor example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.",
    "encryptionDisabled" : " Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown. ",
    "name" : "Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash (\"/\"), the artifact is stored in the root of the output bucket.   \nFor example:  \n  If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip.   \n  If path is empty, namespaceType is set to NONE, and name is set to \"/\", the output artifact is stored in the root of the output bucket.   \n  If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to \"/\", the output artifact is stored in MyArtifacts/build-ID .  ",
    "location" : "Information about the build output artifact location:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the name of the output bucket. ",
    "packaging" : "The type of build output artifact to create:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, valid values include:    NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.    ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.   ",
    "type" : "The type of build output artifact. Valid values include:  \n  CODEPIPELINE: The build project has build output generated through AWS CodePipeline.  \n  NO_ARTIFACTS: The build project does not produce any build output.  \n  S3: The build project stores build output in Amazon Simple Storage Service (Amazon S3). ",
    "namespaceType" : "Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, valid values include:    BUILD_ID: Include the build ID in the location of the build output artifact.    NONE: Do not include the build ID. This is the default if namespaceType is not specified.     \nFor example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip.",
    "overrideArtifactName" : " If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. ",
    "artifactIdentifier" : " An identifier for this artifact definition. "
  }
}

create_webhook#

For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.
If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.

{
  "branchFilter" : "A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.  \n It is recommended that you use filterGroups instead of branchFilter. ",
  "projectName" : "The name of the AWS CodeBuild project.",
  "filterGroups" : [ [ {
    "pattern" : " For a WebHookFilter that uses EVENT type, a comma-separated string that specifies one or more events. For example, the webhook filter PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED allows all push, pull request created, and pull request updated events to trigger a build.  \n For a WebHookFilter that uses any of the other filter types, a regular expression pattern. For example, a WebHookFilter that uses HEAD_REF for its type and the pattern ^refs/heads/ triggers a build when the head reference is a branch with a reference name refs/heads/branch-name. ",
    "type" : " The type of webhook filter. There are five webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, and FILE_PATH.    EVENT   \n A webhook event triggers a build when the provided pattern matches one of four event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, and PULL_REQUEST_REOPENED. The EVENT patterns are specified as a comma-separated string. For example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull request created, and pull request updated events.   \n The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only.     ACTOR_ACCOUNT_ID   \n A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression pattern.    HEAD_REF   \n A webhook event triggers a build when the head reference matches the regular expression pattern. For example, refs/heads/branch-name and refs/tags/tag-name.  \n Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.    BASE_REF   \n A webhook event triggers a build when the base reference matches the regular expression pattern. For example, refs/heads/branch-name.   \n Works with pull request events only.     FILE_PATH   \n A webhook triggers a build when the path of a changed file matches the regular expression pattern.   \n Works with GitHub and GitHub Enterprise push events only. ",
    "excludeMatchedPattern" : " Used to indicate that the pattern determines which webhook events do not trigger a build. If true, then a webhook event that does not match the pattern triggers a build. If false, then a webhook event that matches the pattern triggers a build. "
  } ] ]
}

delete_project#

Deletes a build project.

{
  "name" : "The name of the build project."
}

delete_source_credentials#

Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.

{
  "arn" : " The Amazon Resource Name (ARN) of the token."
}

delete_webhook#

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

{
  "projectName" : "The name of the AWS CodeBuild project."
}

import_source_credentials#

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

{
  "serverType" : " The source provider used for this project. ",
  "shouldOverwrite" : " Set to false to prevent overwriting the repository source credentials. Set to true to overwrite the repository source credentials. The default value is true. ",
  "authType" : " The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the AWS CodeBuild console. ",
  "username" : " The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections. ",
  "token" : " For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password. "
}

invalidate_project_cache#

Resets the cache for a project.

{
  "projectName" : "The name of the AWS CodeBuild build project that the cache is reset for."
}

list_builds#

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

{
  "sortOrder" : "The order to list build IDs. Valid values include:  \n  ASCENDING: List the build IDs in ascending order by build ID.  \n  DESCENDING: List the build IDs in descending order by build ID. "
}

list_builds_for_project#

Gets a list of build IDs for the specified build project, with each build ID representing a single build.

{
  "sortOrder" : "The order to list build IDs. Valid values include:  \n  ASCENDING: List the build IDs in ascending order by build ID.  \n  DESCENDING: List the build IDs in descending order by build ID. ",
  "projectName" : "The name of the AWS CodeBuild project."
}

list_curated_environment_images#

Gets information about Docker images that are managed by AWS CodeBuild.

{ }

list_projects#

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

{
  "sortOrder" : "The order in which to list build projects. Valid values include:  \n  ASCENDING: List in ascending order.  \n  DESCENDING: List in descending order.   \nUse sortBy to specify the criterion to be used to list build project names.",
  "sortBy" : "The criterion to be used to list build project names. Valid values include:  \n  CREATED_TIME: List based on when each build project was created.  \n  LAST_MODIFIED_TIME: List based on when information about each build project was last changed.  \n  NAME: List based on each build project's name.   \nUse sortOrder to specify in what order to list the build project names based on the preceding criteria."
}

list_source_credentials#

Returns a list of SourceCredentialsInfo objects.

{ }

start_build#

Starts running a build.

{
  "imageOverride" : "The name of an image for this build that overrides the one specified in the build project.",
  "privilegedModeOverride" : "Enable this flag to override privileged mode in the build project.",
  "computeTypeOverride" : "The name of a compute type for this build that overrides the one specified in the build project.",
  "environmentTypeOverride" : "A container type for this build that overrides the one specified in the build project.",
  "timeoutInMinutesOverride" : "The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.",
  "imagePullCredentialsTypeOverride" : " The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:   \n  CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.  \n  SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role.    \n When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials. ",
  "queuedTimeoutInMinutesOverride" : " The number of minutes a build is allowed to be queued before it times out. ",
  "environmentVariablesOverride" : [ {
    "name" : "The name or key of the environment variable.",
    "type" : "The type of environment variable. Valid values include:  \n  PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store.  \n  PLAINTEXT: An environment variable in plaintext format. ",
    "value" : "The value of the environment variable.  \nWe strongly discourage the use of environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI)."
  } ],
  "sourceTypeOverride" : "A source input type, for this build, that overrides the source input defined in the build project.",
  "serviceRoleOverride" : "The name of a service role for this build that overrides the one specified in the build project.",
  "cacheOverride" : {
    "modes" : [ "string. Possible values: LOCAL_DOCKER_LAYER_CACHE | LOCAL_SOURCE_CACHE | LOCAL_CUSTOM_CACHE" ],
    "location" : "Information about the cache location:   \n  NO_CACHE or LOCAL: This value is ignored.  \n  S3: This is the S3 bucket name/prefix. ",
    "type" : "The type of cache used by the build project. Valid values include:  \n  NO_CACHE: The build project does not use any cache.  \n  S3: The build project reads and writes from and to S3.  \n  LOCAL: The build project stores a cache locally on a build host that is only available to that build host. "
  },
  "certificateOverride" : "The name of a certificate for this build that overrides the one specified in the build project.",
  "sourceLocationOverride" : "A location that overrides, for this build, the source location for the one defined in the build project.",
  "logsConfigOverride" : {
    "cloudWatchLogs" : {
      "groupName" : " The group name of the logs in Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams. ",
      "streamName" : " The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams. ",
      "status" : "The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are:  \n  ENABLED: Amazon CloudWatch Logs are enabled for this build project.  \n  DISABLED: Amazon CloudWatch Logs are not enabled for this build project. "
    },
    "s3Logs" : {
      "encryptionDisabled" : " Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. ",
      "location" : " The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket, and your path prefix is build-log, then acceptable formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log. ",
      "status" : "The current status of the S3 build logs. Valid values are:  \n  ENABLED: S3 build logs are enabled for this build project.  \n  DISABLED: S3 build logs are not enabled for this build project. "
    }
  },
  "sourceAuthOverride" : {
    "resource" : "The resource value that applies to the specified authorization type.",
    "type" : " This data type is deprecated and is no longer accurate or used.   \nThe authorization type to use. The only valid value is OAUTH, which represents the OAuth authorization type."
  },
  "sourceVersion" : "A version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, must be one of:  \n For AWS CodeCommit: the commit ID to use.  \n 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 pr/pull-request-ID (for example pr/25). 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.  \n 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.  \n For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.   \n If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.  \n For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide. ",
  "reportBuildStatusOverride" : " 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, or Bitbucket, an invalidInputException is thrown. ",
  "artifactsOverride" : {
    "path" : "Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.   \nFor example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.",
    "encryptionDisabled" : " Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown. ",
    "name" : "Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash (\"/\"), the artifact is stored in the root of the output bucket.   \nFor example:  \n  If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip.   \n  If path is empty, namespaceType is set to NONE, and name is set to \"/\", the output artifact is stored in the root of the output bucket.   \n  If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to \"/\", the output artifact is stored in MyArtifacts/build-ID .  ",
    "location" : "Information about the build output artifact location:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the name of the output bucket. ",
    "packaging" : "The type of build output artifact to create:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, valid values include:    NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.    ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.   ",
    "type" : "The type of build output artifact. Valid values include:  \n  CODEPIPELINE: The build project has build output generated through AWS CodePipeline.  \n  NO_ARTIFACTS: The build project does not produce any build output.  \n  S3: The build project stores build output in Amazon Simple Storage Service (Amazon S3). ",
    "namespaceType" : "Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, valid values include:    BUILD_ID: Include the build ID in the location of the build output artifact.    NONE: Do not include the build ID. This is the default if namespaceType is not specified.     \nFor example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip.",
    "overrideArtifactName" : " If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. ",
    "artifactIdentifier" : " An identifier for this artifact definition. "
  },
  "gitCloneDepthOverride" : "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.",
  "secondaryArtifactsOverride" : [ {
    "path" : "Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.   \nFor example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.",
    "encryptionDisabled" : " Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown. ",
    "name" : "Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash (\"/\"), the artifact is stored in the root of the output bucket.   \nFor example:  \n  If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip.   \n  If path is empty, namespaceType is set to NONE, and name is set to \"/\", the output artifact is stored in the root of the output bucket.   \n  If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to \"/\", the output artifact is stored in MyArtifacts/build-ID .  ",
    "location" : "Information about the build output artifact location:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the name of the output bucket. ",
    "packaging" : "The type of build output artifact to create:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, valid values include:    NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.    ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.   ",
    "type" : "The type of build output artifact. Valid values include:  \n  CODEPIPELINE: The build project has build output generated through AWS CodePipeline.  \n  NO_ARTIFACTS: The build project does not produce any build output.  \n  S3: The build project stores build output in Amazon Simple Storage Service (Amazon S3). ",
    "namespaceType" : "Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, valid values include:    BUILD_ID: Include the build ID in the location of the build output artifact.    NONE: Do not include the build ID. This is the default if namespaceType is not specified.     \nFor example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip.",
    "overrideArtifactName" : " If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. ",
    "artifactIdentifier" : " An identifier for this artifact definition. "
  } ],
  "secondarySourcesVersionOverride" : [ {
    "sourceIdentifier" : "An identifier for a source in the build project.",
    "sourceVersion" : "The source version for the corresponding source identifier. If specified, must be one of:  \n For AWS CodeCommit: the commit ID to use.  \n 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 pr/pull-request-ID (for example, pr/25). 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.  \n 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.  \n For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.   \n For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide. "
  } ],
  "buildspecOverride" : "A build spec declaration that overrides, for this build only, the latest one already defined in the build project.",
  "secondarySourcesOverride" : [ {
    "sourceIdentifier" : " An identifier for this project source. ",
    "buildspec" : "The build spec declaration to use for the builds in this build project. \nIf this value is not specified, a build spec must be included along with the source code to be built.",
    "auth" : {
      "resource" : "The resource value that applies to the specified authorization type.",
      "type" : " This data type is deprecated and is no longer accurate or used.   \nThe authorization type to use. The only valid value is OAUTH, which represents the OAuth authorization type."
    },
    "insecureSsl" : "Enable this flag to ignore SSL warnings while connecting to the project source code.",
    "reportBuildStatus" : " Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown. ",
    "gitSubmodulesConfig" : {
      "fetchSubmodules" : " Set to true to fetch Git submodules for your AWS CodeBuild build project. "
    },
    "location" : "Information about the location of the source code to be built. Valid values include:  \n For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.  \n For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).  \n For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following.     The path to the ZIP file that contains the source code (for example,  bucket-name/path/to/object-name.zip).     The path to the folder that contains the source code (for example,  bucket-name/path/to/source-code/folder/).     \n For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.  \n For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH. ",
    "type" : "The type of repository that contains the source code to be built. Valid values include:  \n  BITBUCKET: The source code is in a Bitbucket repository.  \n  CODECOMMIT: The source code is in an AWS CodeCommit repository.  \n  CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS CodePipeline.  \n  GITHUB: The source code is in a GitHub repository.  \n  NO_SOURCE: The project does not have input source code.  \n  S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket. ",
    "gitCloneDepth" : "Information about the Git clone depth for the build project."
  } ],
  "insecureSslOverride" : "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.",
  "projectName" : "The name of the AWS CodeBuild build project to start running a build.",
  "registryCredentialOverride" : {
    "credential" : " The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.   \n The credential can use the name of the credentials only if they exist in your current region. ",
    "credentialProvider" : " The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager. "
  },
  "idempotencyToken" : "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 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error. ",
  "gitSubmodulesConfigOverride" : {
    "fetchSubmodules" : " Set to true to fetch Git submodules for your AWS CodeBuild build project. "
  }
}

stop_build#

Attempts to stop running a build.

{
  "id" : "The ID of the build."
}

update_project#

Changes the settings of a build project.

{
  "logsConfig" : {
    "cloudWatchLogs" : {
      "groupName" : " The group name of the logs in Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams. ",
      "streamName" : " The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams. ",
      "status" : "The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are:  \n  ENABLED: Amazon CloudWatch Logs are enabled for this build project.  \n  DISABLED: Amazon CloudWatch Logs are not enabled for this build project. "
    },
    "s3Logs" : {
      "encryptionDisabled" : " Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. ",
      "location" : " The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket, and your path prefix is build-log, then acceptable formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log. ",
      "status" : "The current status of the S3 build logs. Valid values are:  \n  ENABLED: S3 build logs are enabled for this build project.  \n  DISABLED: S3 build logs are not enabled for this build project. "
    }
  },
  "cache" : {
    "modes" : [ "string. Possible values: LOCAL_DOCKER_LAYER_CACHE | LOCAL_SOURCE_CACHE | LOCAL_CUSTOM_CACHE" ],
    "location" : "Information about the cache location:   \n  NO_CACHE or LOCAL: This value is ignored.  \n  S3: This is the S3 bucket name/prefix. ",
    "type" : "The type of cache used by the build project. Valid values include:  \n  NO_CACHE: The build project does not use any cache.  \n  S3: The build project reads and writes from and to S3.  \n  LOCAL: The build project stores a cache locally on a build host that is only available to that build host. "
  },
  "secondarySources" : [ {
    "sourceIdentifier" : " An identifier for this project source. ",
    "buildspec" : "The build spec declaration to use for the builds in this build project. \nIf this value is not specified, a build spec must be included along with the source code to be built.",
    "auth" : {
      "resource" : "The resource value that applies to the specified authorization type.",
      "type" : " This data type is deprecated and is no longer accurate or used.   \nThe authorization type to use. The only valid value is OAUTH, which represents the OAuth authorization type."
    },
    "insecureSsl" : "Enable this flag to ignore SSL warnings while connecting to the project source code.",
    "reportBuildStatus" : " Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown. ",
    "gitSubmodulesConfig" : {
      "fetchSubmodules" : " Set to true to fetch Git submodules for your AWS CodeBuild build project. "
    },
    "location" : "Information about the location of the source code to be built. Valid values include:  \n For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.  \n For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).  \n For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following.     The path to the ZIP file that contains the source code (for example,  bucket-name/path/to/object-name.zip).     The path to the folder that contains the source code (for example,  bucket-name/path/to/source-code/folder/).     \n For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.  \n For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH. ",
    "type" : "The type of repository that contains the source code to be built. Valid values include:  \n  BITBUCKET: The source code is in a Bitbucket repository.  \n  CODECOMMIT: The source code is in an AWS CodeCommit repository.  \n  CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS CodePipeline.  \n  GITHUB: The source code is in a GitHub repository.  \n  NO_SOURCE: The project does not have input source code.  \n  S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket. ",
    "gitCloneDepth" : "Information about the Git clone depth for the build project."
  } ],
  "sourceVersion" : " 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:   \n For AWS CodeCommit: the commit ID to use.  \n 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 pr/pull-request-ID (for example pr/25). 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.  \n 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.  \n For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.   \n If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).  \n For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide. ",
  "serviceRole" : "The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.",
  "description" : "A new or replacement description of the build project.",
  "source" : {
    "sourceIdentifier" : " An identifier for this project source. ",
    "buildspec" : "The build spec declaration to use for the builds in this build project. \nIf this value is not specified, a build spec must be included along with the source code to be built.",
    "auth" : {
      "resource" : "The resource value that applies to the specified authorization type.",
      "type" : " This data type is deprecated and is no longer accurate or used.   \nThe authorization type to use. The only valid value is OAUTH, which represents the OAuth authorization type."
    },
    "insecureSsl" : "Enable this flag to ignore SSL warnings while connecting to the project source code.",
    "reportBuildStatus" : " Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown. ",
    "gitSubmodulesConfig" : {
      "fetchSubmodules" : " Set to true to fetch Git submodules for your AWS CodeBuild build project. "
    },
    "location" : "Information about the location of the source code to be built. Valid values include:  \n For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.  \n For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).  \n For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following.     The path to the ZIP file that contains the source code (for example,  bucket-name/path/to/object-name.zip).     The path to the folder that contains the source code (for example,  bucket-name/path/to/source-code/folder/).     \n For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.  \n For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH. ",
    "type" : "The type of repository that contains the source code to be built. Valid values include:  \n  BITBUCKET: The source code is in a Bitbucket repository.  \n  CODECOMMIT: The source code is in an AWS CodeCommit repository.  \n  CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS CodePipeline.  \n  GITHUB: The source code is in a GitHub repository.  \n  NO_SOURCE: The project does not have input source code.  \n  S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket. ",
    "gitCloneDepth" : "Information about the Git clone depth for the build project."
  },
  "encryptionKey" : "The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.  \n You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.   \nYou can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).",
  "secondarySourceVersions" : [ {
    "sourceIdentifier" : "An identifier for a source in the build project.",
    "sourceVersion" : "The source version for the corresponding source identifier. If specified, must be one of:  \n For AWS CodeCommit: the commit ID to use.  \n 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 pr/pull-request-ID (for example, pr/25). 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.  \n 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.  \n For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.   \n For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide. "
  } ],
  "secondaryArtifacts" : [ {
    "path" : "Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.   \nFor example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.",
    "encryptionDisabled" : " Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown. ",
    "name" : "Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash (\"/\"), the artifact is stored in the root of the output bucket.   \nFor example:  \n  If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip.   \n  If path is empty, namespaceType is set to NONE, and name is set to \"/\", the output artifact is stored in the root of the output bucket.   \n  If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to \"/\", the output artifact is stored in MyArtifacts/build-ID .  ",
    "location" : "Information about the build output artifact location:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the name of the output bucket. ",
    "packaging" : "The type of build output artifact to create:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, valid values include:    NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.    ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.   ",
    "type" : "The type of build output artifact. Valid values include:  \n  CODEPIPELINE: The build project has build output generated through AWS CodePipeline.  \n  NO_ARTIFACTS: The build project does not produce any build output.  \n  S3: The build project stores build output in Amazon Simple Storage Service (Amazon S3). ",
    "namespaceType" : "Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, valid values include:    BUILD_ID: Include the build ID in the location of the build output artifact.    NONE: Do not include the build ID. This is the default if namespaceType is not specified.     \nFor example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip.",
    "overrideArtifactName" : " If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. ",
    "artifactIdentifier" : " An identifier for this artifact definition. "
  } ],
  "tags" : [ {
    "value" : "The tag's value.",
    "key" : "The tag's key."
  } ],
  "environment" : {
    "registryCredential" : {
      "credential" : " The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.   \n The credential can use the name of the credentials only if they exist in your current region. ",
      "credentialProvider" : " The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager. "
    },
    "image" : "The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:  \n For an image tag: registry/repository:tag. For example, to specify an image with the tag \"latest,\" use registry/repository:latest.  \n For an image digest: registry/repository@digest. For example, to specify an image with the digest \"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,\" use registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf. ",
    "computeType" : "Information about the compute resources the build project uses. Available values include:  \n  BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.  \n  BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.  \n  BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds. ",
    "imagePullCredentialsType" : " The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:   \n  CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.   \n  SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role.    \n When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials. ",
    "environmentVariables" : [ {
      "name" : "The name or key of the environment variable.",
      "type" : "The type of environment variable. Valid values include:  \n  PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store.  \n  PLAINTEXT: An environment variable in plaintext format. ",
      "value" : "The value of the environment variable.  \nWe strongly discourage the use of environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI)."
    } ],
    "privilegedMode" : "Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. \nYou can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file: \nIf the operating system's base image is Ubuntu Linux: \n - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&  \n - timeout 15 sh -c \"until docker info; do echo .; sleep 1; done\"  \nIf the operating system's base image is Alpine Linux and the previous command does not work, add the -t argument to timeout: \n - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&  \n - timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\" ",
    "certificate" : "The certificate to use with this build project.",
    "type" : "The type of build environment to use for related builds."
  },
  "vpcConfig" : {
    "securityGroupIds" : [ "string" ],
    "vpcId" : "The ID of the Amazon VPC.",
    "subnets" : [ "string" ]
  },
  "name" : "The name of the build project.  \nYou cannot change a build project's name.",
  "timeoutInMinutes" : "The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.",
  "queuedTimeoutInMinutes" : " The number of minutes a build is allowed to be queued before it times out. ",
  "badgeEnabled" : "Set this to true to generate a publicly accessible URL for your project's build badge.",
  "artifacts" : {
    "path" : "Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.   \nFor example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.",
    "encryptionDisabled" : " Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown. ",
    "name" : "Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash (\"/\"), the artifact is stored in the root of the output bucket.   \nFor example:  \n  If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip.   \n  If path is empty, namespaceType is set to NONE, and name is set to \"/\", the output artifact is stored in the root of the output bucket.   \n  If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to \"/\", the output artifact is stored in MyArtifacts/build-ID .  ",
    "location" : "Information about the build output artifact location:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, this is the name of the output bucket. ",
    "packaging" : "The type of build output artifact to create:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, valid values include:    NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.    ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.   ",
    "type" : "The type of build output artifact. Valid values include:  \n  CODEPIPELINE: The build project has build output generated through AWS CodePipeline.  \n  NO_ARTIFACTS: The build project does not produce any build output.  \n  S3: The build project stores build output in Amazon Simple Storage Service (Amazon S3). ",
    "namespaceType" : "Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:  \n If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.  \n If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.  \n If type is set to S3, valid values include:    BUILD_ID: Include the build ID in the location of the build output artifact.    NONE: Do not include the build ID. This is the default if namespaceType is not specified.     \nFor example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip.",
    "overrideArtifactName" : " If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. ",
    "artifactIdentifier" : " An identifier for this artifact definition. "
  }
}

update_webhook#

Updates the webhook associated with an AWS CodeBuild build project.
If you use Bitbucket for your repository, rotateSecret is ignored.

{
  "rotateSecret" : " A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored. ",
  "branchFilter" : "A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.  \n It is recommended that you use filterGroups instead of branchFilter. ",
  "projectName" : "The name of the AWS CodeBuild project.",
  "filterGroups" : [ [ {
    "pattern" : " For a WebHookFilter that uses EVENT type, a comma-separated string that specifies one or more events. For example, the webhook filter PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED allows all push, pull request created, and pull request updated events to trigger a build.  \n For a WebHookFilter that uses any of the other filter types, a regular expression pattern. For example, a WebHookFilter that uses HEAD_REF for its type and the pattern ^refs/heads/ triggers a build when the head reference is a branch with a reference name refs/heads/branch-name. ",
    "type" : " The type of webhook filter. There are five webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, and FILE_PATH.    EVENT   \n A webhook event triggers a build when the provided pattern matches one of four event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, and PULL_REQUEST_REOPENED. The EVENT patterns are specified as a comma-separated string. For example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull request created, and pull request updated events.   \n The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only.     ACTOR_ACCOUNT_ID   \n A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression pattern.    HEAD_REF   \n A webhook event triggers a build when the head reference matches the regular expression pattern. For example, refs/heads/branch-name and refs/tags/tag-name.  \n Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.    BASE_REF   \n A webhook event triggers a build when the base reference matches the regular expression pattern. For example, refs/heads/branch-name.   \n Works with pull request events only.     FILE_PATH   \n A webhook triggers a build when the path of a changed file matches the regular expression pattern.   \n Works with GitHub and GitHub Enterprise push events only. ",
    "excludeMatchedPattern" : " Used to indicate that the pattern determines which webhook events do not trigger a build. If true, then a webhook event that does not match the pattern triggers a build. If false, then a webhook event that matches the pattern triggers a build. "
  } ] ]
}