AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about AWS CodeBuild, see the AWS CodeBuild User Guide.
AWS CodeBuild supports these operations:
BatchDeleteBuilds: Deletes one or more builds.
BatchGetBuilds: Gets information about one or more builds.
BatchGetProjects: Gets information about one or more build projects. A build project defines how AWS CodeBuild runs a build. This includes information such as where to get the source code to build, the build environment to use, the build commands to run, and where to store the build output. A build environment is a representation of operating system, programming language runtime, and tools that AWS CodeBuild uses to run a build. You can add tags to build projects to help manage your resources and costs.
BatchGetReportGroups: Returns an array of report groups.
BatchGetReports: Returns an array of reports.
CreateProject: Creates a build project.
CreateReportGroup: Creates a report group. A report group contains a collection of reports.
CreateWebhook: 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.
DeleteProject: Deletes a build project.
DeleteReport: Deletes a report.
DeleteReportGroup: Deletes a report group.
DeleteResourcePolicy: Deletes a resource policy that is identified by its resource ARN.
DeleteSourceCredentials: Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
DeleteWebhook: 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.
DescribeTestCases: Returns a list of details about test cases for a report.
GetResourcePolicy: Gets a resource policy that is identified by its resource ARN.
ImportSourceCredentials: Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
InvalidateProjectCache: Resets the cache for a project.
ListBuilds: Gets a list of build IDs, with each build ID representing a single build.
ListBuildsForProject: Gets a list of build IDs for the specified build project, with each build ID representing a single build.
ListCuratedEnvironmentImages: Gets information about Docker images that are managed by AWS CodeBuild.
ListProjects: Gets a list of build project names, with each build project name representing a single build project.
ListReportGroups: Gets a list ARNs for the report groups in the current AWS account.
ListReports: Gets a list ARNs for the reports in the current AWS account.
ListReportsForReportGroup: Returns a list of ARNs for the reports that belong to a ReportGroup.
ListSharedProjects: Gets a list of ARNs associated with projects shared with the current AWS account or user.
ListSharedReportGroups: Gets a list of ARNs associated with report groups shared with the current AWS account or user
ListSourceCredentials: Returns a list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials.
PutResourcePolicy: Stores a resource policy for the ARN of a Project or ReportGroup object.
StartBuild: Starts running a build.
StopBuild: Attempts to stop running a build.
UpdateProject: Changes the settings of an existing build project.
UpdateReportGroup: Changes a report group.
UpdateWebhook: Changes the settings of an existing webhook.
Deletes one or more builds.
", "BatchGetBuildBatches": "Retrieves information about one or more batch builds.
", "BatchGetBuilds": "Gets information about one or more builds.
", "BatchGetProjects": "Gets information about one or more build projects.
", "BatchGetReportGroups": "Returns an array of report groups.
", "BatchGetReports": "Returns an array of reports.
", "CreateProject": "Creates a build project.
", "CreateReportGroup": "Creates a report group. A report group contains a collection of reports.
", "CreateWebhook": "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.
Deletes a batch build.
", "DeleteProject": "Deletes a build project. When you delete a project, its builds are not deleted.
", "DeleteReport": "Deletes a report.
", "DeleteReportGroup": " DeleteReportGroup: Deletes a report group. Before you delete a report group, you must delete its reports. Use ListReportsForReportGroup to get the reports in a report group. Use DeleteReport to delete the reports. If you call DeleteReportGroup for a report group that contains one or more reports, an exception is thrown.
Deletes a resource policy that is identified by its resource ARN.
", "DeleteSourceCredentials": "Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
", "DeleteWebhook": "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.
", "DescribeCodeCoverages": "Retrieves one or more code coverage reports.
", "DescribeTestCases": "Returns a list of details about test cases for a report.
", "GetResourcePolicy": "Gets a resource policy that is identified by its resource ARN.
", "ImportSourceCredentials": "Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
", "InvalidateProjectCache": "Resets the cache for a project.
", "ListBuildBatches": "Retrieves the identifiers of your build batches in the current region.
", "ListBuildBatchesForProject": "Retrieves the identifiers of the build batches for a specific project.
", "ListBuilds": "Gets a list of build IDs, with each build ID representing a single build.
", "ListBuildsForProject": "Gets a list of build IDs for the specified build project, with each build ID representing a single build.
", "ListCuratedEnvironmentImages": "Gets information about Docker images that are managed by AWS CodeBuild.
", "ListProjects": "Gets a list of build project names, with each build project name representing a single build project.
", "ListReportGroups": "Gets a list ARNs for the report groups in the current AWS account.
", "ListReports": "Returns a list of ARNs for the reports in the current AWS account.
", "ListReportsForReportGroup": " Returns a list of ARNs for the reports that belong to a ReportGroup.
Gets a list of projects that are shared with other AWS accounts or users.
", "ListSharedReportGroups": "Gets a list of report groups that are shared with other AWS accounts or users.
", "ListSourceCredentials": " Returns a list of SourceCredentialsInfo objects.
Stores a resource policy for the ARN of a Project or ReportGroup object.
Restarts a build.
", "RetryBuildBatch": "Restarts a batch build.
", "StartBuild": "Starts running a build.
", "StartBuildBatch": "Starts a batch build for a project.
", "StopBuild": "Attempts to stop running a build.
", "StopBuildBatch": "Stops a running batch build.
", "UpdateProject": "Changes the settings of a build project.
", "UpdateReportGroup": "Updates a report group.
", "UpdateWebhook": "Updates the webhook associated with an AWS CodeBuild build project.
If you use Bitbucket for your repository, rotateSecret is ignored.
An AWS service limit was exceeded for the calling AWS account.
", "refs": { } }, "ArtifactNamespace": { "base": null, "refs": { "ProjectArtifacts$namespaceType": "Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:
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.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
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.
For 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.
The type of build output artifact to create:
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.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
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.
The type of build output artifact. Valid values include:
CODEPIPELINE: The build project has build output generated through AWS CodePipeline.
The CODEPIPELINE type is not supported for secondaryArtifacts.
NO_ARTIFACTS: The build project does not produce any build output.
S3: The build project stores build output in Amazon Simple Storage Service (Amazon S3).
Specifies the type of artifact.
" } }, "AuthType": { "base": null, "refs": { "ImportSourceCredentialsInput$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.
", "SourceCredentialsInfo$authType": "The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.
" } }, "BatchDeleteBuildsInput": { "base": null, "refs": { } }, "BatchDeleteBuildsOutput": { "base": null, "refs": { } }, "BatchGetBuildBatchesInput": { "base": null, "refs": { } }, "BatchGetBuildBatchesOutput": { "base": null, "refs": { } }, "BatchGetBuildsInput": { "base": null, "refs": { } }, "BatchGetBuildsOutput": { "base": null, "refs": { } }, "BatchGetProjectsInput": { "base": null, "refs": { } }, "BatchGetProjectsOutput": { "base": null, "refs": { } }, "BatchGetReportGroupsInput": { "base": null, "refs": { } }, "BatchGetReportGroupsOutput": { "base": null, "refs": { } }, "BatchGetReportsInput": { "base": null, "refs": { } }, "BatchGetReportsOutput": { "base": null, "refs": { } }, "BatchRestrictions": { "base": "Specifies restrictions for the batch build.
", "refs": { "ProjectBuildBatchConfig$restrictions": "A BatchRestrictions object that specifies the restrictions for the batch build.
Whether the build is complete. True if complete; otherwise, false.
", "BuildBatch$complete": "Indicates if the batch build is complete.
", "BuildGroup$ignoreFailure": "Specifies if failures in this build group can be ignored.
", "ProjectBadge$badgeEnabled": "Set this to true to generate a publicly accessible URL for your project's build badge.
", "UpdateWebhookInput$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.
Information about a build.
", "refs": { "Builds$member": null, "RetryBuildOutput$build": null, "StartBuildOutput$build": "Information about the build to be run.
", "StopBuildOutput$build": "Information about the build.
" } }, "BuildArtifacts": { "base": "Information about build output artifacts.
", "refs": { "Build$artifacts": "Information about the output artifacts for the build.
", "BuildArtifactsList$member": null, "BuildBatch$artifacts": "A BuildArtifacts object the defines the build artifacts for this batch build.
An array of ProjectArtifacts objects.
An array of BuildArtifacts objects the define the build artifacts for this batch build.
Contains information about a batch build.
", "refs": { "BuildBatches$member": null, "RetryBuildBatchOutput$buildBatch": null, "StartBuildBatchOutput$buildBatch": "A BuildBatch object that contains information about the batch build.
Specifies filters when retrieving batch builds.
", "refs": { "ListBuildBatchesForProjectInput$filter": "A BuildBatchFilter object that specifies the filters for the search.
A BuildBatchFilter object that specifies the filters for the search.
An array that contains the batch build identifiers to retrieve.
", "BatchGetBuildBatchesOutput$buildBatchesNotFound": "An array that contains the identifiers of any batch builds that are not found.
", "ListBuildBatchesForProjectOutput$ids": "An array of strings that contains the batch build identifiers.
", "ListBuildBatchesOutput$ids": "An array of strings that contains the batch build identifiers.
" } }, "BuildBatchPhase": { "base": "Contains information about a stage for a batch build.
", "refs": { "BuildBatchPhases$member": null } }, "BuildBatchPhaseType": { "base": null, "refs": { "BuildBatchPhase$phaseType": "The name of the batch build phase. Valid values include:
Build output artifacts are being combined and uploaded to the output location.
The batch build specification is being downloaded.
One or more of the builds failed.
The batch build is in progress.
The batch build was stopped.
The btach build has been submitted.
The batch build succeeded.
An array of BuildBatchPhase objects the specify the phases of the batch build.
An array of BuildBatch objects that represent the retrieved batch builds.
Contains information about a batch build build group. Build groups are used to combine builds that can run in parallel, while still being able to set dependencies on other build groups.
", "refs": { "BuildGroups$member": null } }, "BuildGroups": { "base": null, "refs": { "BuildBatch$buildGroups": "An array of BuildGroup objects that define the build groups for the batch build.
The IDs of the builds to delete.
", "BatchDeleteBuildsOutput$buildsDeleted": "The IDs of the builds that were successfully deleted.
", "BatchGetBuildsInput$ids": "The IDs of the builds.
", "BatchGetBuildsOutput$buildsNotFound": "The IDs of builds for which information could not be found.
", "DeleteBuildBatchOutput$buildsDeleted": "An array of strings that contain the identifiers of the builds that were deleted.
", "ListBuildsForProjectOutput$ids": "A list of build IDs for the specified build project, with each build ID representing a single build.
", "ListBuildsOutput$ids": "A list of build IDs, with each build ID representing a single build.
" } }, "BuildNotDeleted": { "base": "Information about a build that could not be successfully deleted.
", "refs": { "BuildsNotDeleted$member": null } }, "BuildPhase": { "base": "Information about a stage for a build.
", "refs": { "BuildPhases$member": null } }, "BuildPhaseType": { "base": null, "refs": { "BuildPhase$phaseType": "The name of the build phase. Valid values include:
BUILD: Core build activities typically occur in this build phase.
COMPLETED: The build has been completed.
DOWNLOAD_SOURCE: Source code is being downloaded in this build phase.
FINALIZING: The build process is completing in this build phase.
INSTALL: Installation activities typically occur in this build phase.
POST_BUILD: Post-build activities typically occur in this build phase.
PRE_BUILD: Pre-build activities typically occur in this build phase.
PROVISIONING: The build environment is being set up.
QUEUED: The build has been submitted and is queued behind other submitted builds.
SUBMITTED: The build has been submitted.
UPLOAD_ARTIFACTS: Build output artifacts are being uploaded to the output location.
Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
" } }, "BuildReportArns": { "base": null, "refs": { "Build$reportArns": "An array of the ARNs associated with this build's reports.
" } }, "BuildStatusConfig": { "base": "Contains information that defines how the AWS CodeBuild build project reports the build status to the source provider.
", "refs": { "ProjectSource$buildStatusConfig": "Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
An array of BuildSummary objects that contain summaries of previous build groups.
Contains summary information about a batch build group.
", "refs": { "BuildGroup$currentBuildSummary": "A BuildSummary object that contains a summary of the current build group.
Information about the requested builds.
" } }, "BuildsNotDeleted": { "base": null, "refs": { "BatchDeleteBuildsOutput$buildsNotDeleted": "Information about any builds that could not be successfully deleted.
", "DeleteBuildBatchOutput$buildsNotDeleted": "An array of BuildNotDeleted objects that specify the builds that could not be deleted.
The type of cache used by the build project. Valid values include:
NO_CACHE: The build project does not use any cache.
S3: The build project reads and writes from and to S3.
LOCAL: The build project stores a cache locally on a build host that is only available to that build host.
Information about Amazon CloudWatch Logs for a build project.
", "refs": { "LogsConfig$cloudWatchLogs": "Information about Amazon CloudWatch Logs for a build project. Amazon CloudWatch Logs are enabled by default.
", "LogsLocation$cloudWatchLogs": "Information about Amazon CloudWatch Logs for a build project.
" } }, "CodeCoverage": { "base": "Contains code coverage report information.
Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.
Branch coverage determines if your tests cover every possible branch of a control structure, such as an if or case statement.
Contains a summary of a code coverage report.
Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.
Branch coverage determines if your tests cover every possible branch of a control structure, such as an if or case statement.
A CodeCoverageReportSummary object that contains a code coverage summary for this report.
An array of CodeCoverage objects that contain the results.
Information about the compute resources the build project uses. Available values include:
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see Build Environment Compute Types in the AWS CodeBuild User Guide.
", "StartBuildBatchInput$computeTypeOverride": "The name of a compute type for this batch build that overrides the one specified in the batch build project.
", "StartBuildInput$computeTypeOverride": "The name of a compute type for this build that overrides the one specified in the build project.
" } }, "ComputeTypesAllowed": { "base": null, "refs": { "BatchRestrictions$computeTypesAllowed": "An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the AWS CodeBuild User Guide for these values.
" } }, "CreateProjectInput": { "base": null, "refs": { } }, "CreateProjectOutput": { "base": null, "refs": { } }, "CreateReportGroupInput": { "base": null, "refs": { } }, "CreateReportGroupOutput": { "base": null, "refs": { } }, "CreateWebhookInput": { "base": null, "refs": { } }, "CreateWebhookOutput": { "base": null, "refs": { } }, "CredentialProviderType": { "base": null, "refs": { "RegistryCredential$credentialProvider": "The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager.
" } }, "DebugSession": { "base": "Contains information about the debug session for a build. For more information, see Viewing a running build in Session Manager.
", "refs": { "Build$debugSession": "Contains information about the debug session for this build.
" } }, "DeleteBuildBatchInput": { "base": null, "refs": { } }, "DeleteBuildBatchOutput": { "base": null, "refs": { } }, "DeleteProjectInput": { "base": null, "refs": { } }, "DeleteProjectOutput": { "base": null, "refs": { } }, "DeleteReportGroupInput": { "base": null, "refs": { } }, "DeleteReportGroupOutput": { "base": null, "refs": { } }, "DeleteReportInput": { "base": null, "refs": { } }, "DeleteReportOutput": { "base": null, "refs": { } }, "DeleteResourcePolicyInput": { "base": null, "refs": { } }, "DeleteResourcePolicyOutput": { "base": null, "refs": { } }, "DeleteSourceCredentialsInput": { "base": null, "refs": { } }, "DeleteSourceCredentialsOutput": { "base": null, "refs": { } }, "DeleteWebhookInput": { "base": null, "refs": { } }, "DeleteWebhookOutput": { "base": null, "refs": { } }, "DescribeCodeCoveragesInput": { "base": null, "refs": { } }, "DescribeCodeCoveragesOutput": { "base": null, "refs": { } }, "DescribeTestCasesInput": { "base": null, "refs": { } }, "DescribeTestCasesOutput": { "base": null, "refs": { } }, "EnvironmentImage": { "base": "Information about a Docker image that is managed by AWS CodeBuild.
", "refs": { "EnvironmentImages$member": null } }, "EnvironmentImages": { "base": null, "refs": { "EnvironmentLanguage$images": "The list of Docker images that are related by the specified programming language.
" } }, "EnvironmentLanguage": { "base": "A set of Docker images that are related by programming language and are managed by AWS CodeBuild.
", "refs": { "EnvironmentLanguages$member": null } }, "EnvironmentLanguages": { "base": null, "refs": { "EnvironmentPlatform$languages": "The list of programming languages that are available for the specified platform.
" } }, "EnvironmentPlatform": { "base": "A set of Docker images that are related by platform and are managed by AWS CodeBuild.
", "refs": { "EnvironmentPlatforms$member": null } }, "EnvironmentPlatforms": { "base": null, "refs": { "ListCuratedEnvironmentImagesOutput$platforms": "Information about supported platforms for Docker images that are managed by AWS CodeBuild.
" } }, "EnvironmentType": { "base": null, "refs": { "ProjectEnvironment$type": "The type of build environment to use for related builds.
The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).
The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).
A container type for this batch build that overrides the one specified in the batch build project.
", "StartBuildInput$environmentTypeOverride": "A container type for this build that overrides the one specified in the build project.
" } }, "EnvironmentVariable": { "base": "Information about an environment variable for a build project or a build.
", "refs": { "EnvironmentVariables$member": null } }, "EnvironmentVariableType": { "base": null, "refs": { "EnvironmentVariable$type": "The type of environment variable. Valid values include:
PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see parameter store reference-key in the buildspec file.
PLAINTEXT: An environment variable in plain text format. This is the default value.
SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager. To learn how to specify a secrets manager environment variable, see secrets manager reference-key in the buildspec file.
A set of environment variables to make available to builds for this build project.
", "StartBuildBatchInput$environmentVariablesOverride": "An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.
A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
" } }, "ExportedEnvironmentVariable": { "base": "Information about an exported environment variable.
", "refs": { "ExportedEnvironmentVariables$member": null } }, "ExportedEnvironmentVariables": { "base": null, "refs": { "Build$exportedEnvironmentVariables": "A list of exported environment variables for this build.
" } }, "FileSystemType": { "base": null, "refs": { "ProjectFileSystemLocation$type": " The type of the file system. The one supported type is EFS.
An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.
For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.
An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must contain at least one EVENT WebhookFilter.
An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.
For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.
Information about the Git clone depth for the build project.
", "StartBuildBatchInput$gitCloneDepthOverride": "The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build only, any previous depth of history defined in the batch build project.
", "StartBuildInput$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.
" } }, "GitSubmodulesConfig": { "base": "Information about the Git submodules configuration for an AWS CodeBuild build project.
", "refs": { "ProjectSource$gitSubmodulesConfig": "Information about the Git submodules configuration for the build project.
", "StartBuildBatchInput$gitSubmodulesConfigOverride": "A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.
Information about the Git submodules configuration for this build of an AWS CodeBuild build project.
" } }, "Identifiers": { "base": null, "refs": { "BuildGroup$dependsOn": "An array of strings that contain the identifiers of the build groups that this build group depends on.
" } }, "ImagePullCredentialsType": { "base": null, "refs": { "ProjectEnvironment$imagePullCredentialsType": "The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
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.
SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role.
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.
", "StartBuildBatchInput$imagePullCredentialsTypeOverride": "The type of credentials AWS CodeBuild uses to pull images in your batch build. There are two valid values:
Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
Specifies that AWS CodeBuild uses your build project's service role.
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.
The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
Specifies that AWS CodeBuild uses your build project's service role.
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.
A list of environment image versions.
" } }, "ImportSourceCredentialsInput": { "base": null, "refs": { } }, "ImportSourceCredentialsOutput": { "base": null, "refs": { } }, "InvalidInputException": { "base": "The input value that was provided is not valid.
", "refs": { } }, "InvalidateProjectCacheInput": { "base": null, "refs": { } }, "InvalidateProjectCacheOutput": { "base": null, "refs": { } }, "KeyInput": { "base": null, "refs": { "Tag$key": "The tag's key.
" } }, "LanguageType": { "base": null, "refs": { "EnvironmentLanguage$language": "The programming language for the Docker images.
" } }, "ListBuildBatchesForProjectInput": { "base": null, "refs": { } }, "ListBuildBatchesForProjectOutput": { "base": null, "refs": { } }, "ListBuildBatchesInput": { "base": null, "refs": { } }, "ListBuildBatchesOutput": { "base": null, "refs": { } }, "ListBuildsForProjectInput": { "base": null, "refs": { } }, "ListBuildsForProjectOutput": { "base": null, "refs": { } }, "ListBuildsInput": { "base": null, "refs": { } }, "ListBuildsOutput": { "base": null, "refs": { } }, "ListCuratedEnvironmentImagesInput": { "base": null, "refs": { } }, "ListCuratedEnvironmentImagesOutput": { "base": null, "refs": { } }, "ListProjectsInput": { "base": null, "refs": { } }, "ListProjectsOutput": { "base": null, "refs": { } }, "ListReportGroupsInput": { "base": null, "refs": { } }, "ListReportGroupsOutput": { "base": null, "refs": { } }, "ListReportsForReportGroupInput": { "base": null, "refs": { } }, "ListReportsForReportGroupOutput": { "base": null, "refs": { } }, "ListReportsInput": { "base": null, "refs": { } }, "ListReportsOutput": { "base": null, "refs": { } }, "ListSharedProjectsInput": { "base": null, "refs": { } }, "ListSharedProjectsOutput": { "base": null, "refs": { } }, "ListSharedReportGroupsInput": { "base": null, "refs": { } }, "ListSharedReportGroupsOutput": { "base": null, "refs": { } }, "ListSourceCredentialsInput": { "base": null, "refs": { } }, "ListSourceCredentialsOutput": { "base": null, "refs": { } }, "LogsConfig": { "base": "Information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a specified S3 bucket, or both.
", "refs": { "BuildBatch$logConfig": null, "CreateProjectInput$logsConfig": "Information about logs for the build project. These can be logs in Amazon CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.
", "Project$logsConfig": "Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.
", "StartBuildBatchInput$logsConfigOverride": "A LogsConfig object that override the log settings defined in the batch build project.
Log settings for this build that override the log settings defined in the build project.
", "UpdateProjectInput$logsConfig": "Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, logs in an S3 bucket, or both.
" } }, "LogsConfigStatusType": { "base": null, "refs": { "CloudWatchLogsConfig$status": "The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are:
ENABLED: Amazon CloudWatch Logs are enabled for this build project.
DISABLED: Amazon CloudWatch Logs are not enabled for this build project.
The current status of the S3 build logs. Valid values are:
ENABLED: S3 build logs are enabled for this build project.
DISABLED: S3 build logs are not enabled for this build project.
Information about build logs in Amazon CloudWatch Logs.
", "refs": { "Build$logs": "Information about the build's logs in Amazon CloudWatch Logs.
" } }, "NetworkInterface": { "base": "Describes a network interface.
", "refs": { "Build$networkInterface": "Describes a network interface.
" } }, "NonEmptyString": { "base": null, "refs": { "Build$id": "The unique ID for the build.
", "Build$arn": "The Amazon Resource Name (ARN) of the build.
", "Build$sourceVersion": "Any version identifier for the version of the source code to be built. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
", "Build$resolvedSourceVersion": "An identifier for the version of this build's source code.
For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For AWS CodePipeline, the source revision provided by AWS CodePipeline.
For Amazon Simple Storage Service (Amazon S3), this does not apply.
The name of the AWS CodeBuild project.
", "Build$serviceRole": "The name of a service role used for this build.
", "Build$encryptionKey": "The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).
The identifier of the batch build.
", "BuildBatch$arn": "The ARN of the batch build.
", "BuildBatch$sourceVersion": "The identifier of the version of the source code to be built.
", "BuildBatch$resolvedSourceVersion": "The identifier of the resolved version of this batch build's source code.
For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For AWS CodePipeline, the source revision provided by AWS CodePipeline.
For Amazon Simple Storage Service (Amazon S3), this does not apply.
The name of the batch build project.
", "BuildBatch$serviceRole": "The name of a service role used for builds in the batch.
", "BuildBatch$encryptionKey": "The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the batch build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).
The ID of the build that could not be successfully deleted.
", "CodeCoverage$id": "The identifier of the code coverage report.
", "CodeCoverage$reportARN": "The ARN of the report.
", "CodeCoverage$filePath": "The path of the test report file.
", "ComputeTypesAllowed$member": null, "CreateProjectInput$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.
", "CreateProjectInput$encryptionKey": "The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).
Contains the identifier of the Session Manager session used for the build. To work with the paused build, you open this session to examine, control, and resume the build.
", "DeleteBuildBatchInput$id": "The identifier of the batch build to delete.
", "DeleteProjectInput$name": "The name of the build project.
", "DeleteReportGroupInput$arn": "The ARN of the report group to delete.
", "DeleteReportInput$arn": "The ARN of the report to delete.
", "DeleteResourcePolicyInput$resourceArn": "The ARN of the resource that is associated with the resource policy.
", "DeleteSourceCredentialsInput$arn": "The Amazon Resource Name (ARN) of the token.
", "DeleteSourceCredentialsOutput$arn": "The Amazon Resource Name (ARN) of the token.
", "DescribeCodeCoveragesInput$reportArn": "The ARN of the report for which test cases are returned.
", "EnvironmentVariable$name": "The name or key of the environment variable.
", "ExportedEnvironmentVariable$name": "The name of this exported environment variable.
", "GetResourcePolicyInput$resourceArn": "The ARN of the resource that is associated with the resource policy.
", "GetResourcePolicyOutput$policy": "The resource policy for the resource identified by the input ARN parameter.
", "Identifiers$member": null, "ImportSourceCredentialsInput$username": " The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.
The Amazon Resource Name (ARN) of the token.
", "InvalidateProjectCacheInput$projectName": "The name of the AWS CodeBuild build project that the cache is reset for.
", "ListBuildBatchesForProjectInput$projectName": "The name of the project.
", "ListBuildsForProjectInput$projectName": "The name of the AWS CodeBuild project.
", "ListProjectsInput$nextToken": "During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
", "ListSharedProjectsInput$nextToken": " During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
The ID of the subnet.
", "NetworkInterface$networkInterfaceId": "The ID of the network interface.
", "Project$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.
", "Project$encryptionKey": "The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).
Specifies the service role ARN for the batch build project.
", "ProjectEnvironment$image": "The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:
For an image tag: registry/repository:tag. For example, to specify an image with the tag \"latest,\" use registry/repository:latest.
For an image digest: registry/repository@digest. For example, to specify an image with the digest \"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,\" use registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
A JSON-formatted resource policy. For more information, see Sharing a Project and Sharing a Report Group in the AWS CodeBuild User Guide.
", "PutResourcePolicyInput$resourceArn": " The ARN of the Project or ReportGroup resource you want to associate with a resource policy.
The ARN of the Project or ReportGroup resource that is associated with a resource policy.
The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.
The credential can use the name of the credentials only if they exist in your current AWS Region.
The ARN of the report run.
", "Report$reportGroupArn": "The ARN of the report group associated with this report.
", "ReportArns$member": null, "ReportGroup$arn": " The ARN of a ReportGroup.
Specifies the identifier of the batch build to restart.
", "RetryBuildInput$id": "Specifies the identifier of the build to restart.
", "S3ReportExportConfig$bucket": "The name of the S3 bucket where the raw data of a report are exported.
", "S3ReportExportConfig$encryptionKey": "The encryption key for the report's encrypted raw data.
", "SecurityGroupIds$member": null, "SourceCredentialsInfo$arn": "The Amazon Resource Name (ARN) of the token.
", "StartBuildBatchInput$projectName": "The name of the project.
", "StartBuildBatchInput$imageOverride": "The name of an image for this batch build that overrides the one specified in the batch build project.
", "StartBuildBatchInput$serviceRoleOverride": "The name of a service role for this batch build that overrides the one specified in the batch build project.
", "StartBuildBatchInput$encryptionKeyOverride": "The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).
The name of the AWS CodeBuild build project to start running a build.
", "StartBuildInput$imageOverride": "The name of an image for this build that overrides the one specified in the build project.
", "StartBuildInput$serviceRoleOverride": "The name of a service role for this build that overrides the one specified in the build project.
", "StartBuildInput$encryptionKeyOverride": "The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).
The identifier of the batch build to stop.
", "StopBuildInput$id": "The ID of the build.
", "Subnets$member": null, "TestCase$reportArn": "The ARN of the report to which the test case belongs.
", "UpdateProjectInput$name": "The name of the build project.
You cannot change a build project's name.
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.
", "UpdateProjectInput$encryptionKey": "The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).
The ARN of the report group to update.
", "VpcConfig$vpcId": "The ID of the Amazon VPC.
", "Webhook$url": "The URL to the webhook.
", "Webhook$payloadUrl": "The AWS CodeBuild endpoint where webhook events are sent.
", "Webhook$secret": "The secret token of the associated repository.
A Bitbucket webhook does not support secret.
The number of lines that are covered by your tests.
", "CodeCoverage$linesMissed": "The number of lines that are not covered by your tests.
", "CodeCoverage$branchesCovered": "The number of conditional branches that are covered by your tests.
", "CodeCoverage$branchesMissed": "The number of conditional branches that are not covered by your tests.
", "CodeCoverageReportSummary$linesCovered": "The number of lines that are covered by your tests.
", "CodeCoverageReportSummary$linesMissed": "The number of lines that are not covered by your tests.
", "CodeCoverageReportSummary$branchesCovered": "The number of conditional branches that are covered by your tests.
", "CodeCoverageReportSummary$branchesMissed": "The number of conditional branches that are not covered by your tests.
" } }, "OAuthProviderException": { "base": "There was a problem with the underlying OAuth provider.
", "refs": { } }, "PageSize": { "base": null, "refs": { "DescribeCodeCoveragesInput$maxResults": "The maximum number of results to return.
", "DescribeTestCasesInput$maxResults": " The maximum number of paginated test cases returned per response. Use nextToken to iterate pages in the list of returned TestCase objects. The default value is 100.
The maximum number of results to return.
", "ListBuildBatchesInput$maxResults": "The maximum number of results to return.
", "ListReportGroupsInput$maxResults": " The maximum number of paginated report groups returned per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.
The maximum number of paginated reports in this report group returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.
The maximum number of paginated reports returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.
The maximum number of paginated shared build projects returned per response. Use nextToken to iterate pages in the list of returned Project objects. The default value is 100.
The maximum number of paginated shared report groups per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.
The percentage of lines that are covered by your tests.
", "CodeCoverage$branchCoveragePercentage": "The percentage of branches that are covered by your tests.
", "CodeCoverageReportSummary$lineCoveragePercentage": "The percentage of lines that are covered by your tests.
", "CodeCoverageReportSummary$branchCoveragePercentage": "The percentage of branches that are covered by your tests.
", "DescribeCodeCoveragesInput$minLineCoveragePercentage": "The minimum line coverage percentage to report.
", "DescribeCodeCoveragesInput$maxLineCoveragePercentage": "The maximum line coverage percentage to report.
" } }, "PhaseContext": { "base": "Additional information about a build phase that has an error. You can use this information for troubleshooting.
", "refs": { "PhaseContexts$member": null } }, "PhaseContexts": { "base": null, "refs": { "BuildBatchPhase$contexts": "Additional information about the batch build phase. Especially to help troubleshoot a failed btach build.
", "BuildPhase$contexts": "Additional information about a build phase, especially to help troubleshoot a failed build.
" } }, "PlatformType": { "base": null, "refs": { "EnvironmentPlatform$platform": "The platform's name.
" } }, "Project": { "base": "Information about a build project.
", "refs": { "CreateProjectOutput$project": "Information about the build project that was created.
", "Projects$member": null, "UpdateProjectOutput$project": "Information about the build project that was changed.
" } }, "ProjectArns": { "base": null, "refs": { "ListSharedProjectsOutput$projects": "The list of ARNs for the build projects shared with the current AWS account or user.
" } }, "ProjectArtifacts": { "base": "Information about the build output artifacts for the build project.
", "refs": { "CreateProjectInput$artifacts": "Information about the build output artifacts for the build project.
", "Project$artifacts": "Information about the build output artifacts for the build project.
", "ProjectArtifactsList$member": null, "StartBuildBatchInput$artifactsOverride": "An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.
Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
", "UpdateProjectInput$artifacts": "Information to be changed about the build output artifacts for the build project.
" } }, "ProjectArtifactsList": { "base": null, "refs": { "CreateProjectInput$secondaryArtifacts": "An array of ProjectArtifacts objects.
An array of ProjectArtifacts objects.
An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch build project.
An array of ProjectArtifacts objects.
An array of ProjectSource objects.
Information about the build badge for the build project.
", "refs": { "Project$badge": "Information about the build badge for the build project.
" } }, "ProjectBuildBatchConfig": { "base": "Contains configuration information about a batch build project.
", "refs": { "BuildBatch$buildBatchConfig": null, "CreateProjectInput$buildBatchConfig": "A ProjectBuildBatchConfig object that defines the batch build options for the project.
", "Project$buildBatchConfig": "A ProjectBuildBatchConfig object that defines the batch build options for the project.
", "StartBuildBatchInput$buildBatchConfigOverride": "A BuildBatchConfigOverride object that contains batch build configuration overrides.
Information about the cache for the build project.
", "refs": { "Build$cache": "Information about the cache for the build.
", "BuildBatch$cache": null, "CreateProjectInput$cache": "Stores recently used information so that it can be quickly accessed at a later time.
", "Project$cache": "Information about the cache for the build project.
", "StartBuildBatchInput$cacheOverride": "A ProjectCache object that specifies cache overrides.
A ProjectCache object specified for this build that overrides the one defined in the build project.
", "UpdateProjectInput$cache": "Stores recently used information so that it can be quickly accessed at a later time.
" } }, "ProjectCacheModes": { "base": null, "refs": { "ProjectCache$modes": " If you use a LOCAL cache, the local cache mode. You can use one or more local cache modes at the same time.
LOCAL_SOURCE_CACHE mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.
LOCAL_DOCKER_LAYER_CACHE mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.
You can use a Docker layer cache in the Linux environment only.
The privileged flag must be set so that your project has the required Docker permissions.
You should consider the security implications before you use a Docker layer cache.
LOCAL_CUSTOM_CACHE mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:
Only directories can be specified for caching. You cannot specify individual files.
Symlinks are used to reference cached directories.
Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.
A description that makes the build project easy to identify.
", "Project$description": "A description that makes the build project easy to identify.
", "UpdateProjectInput$description": "A new or replacement description of the build project.
" } }, "ProjectEnvironment": { "base": "Information about the build environment of the build project.
", "refs": { "Build$environment": "Information about the build environment for this build.
", "BuildBatch$environment": null, "CreateProjectInput$environment": "Information about the build environment for the build project.
", "Project$environment": "Information about the build environment for this build project.
", "UpdateProjectInput$environment": "Information to be changed about the build environment for the build project.
" } }, "ProjectFileSystemLocation": { "base": "Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?
", "refs": { "ProjectFileSystemLocations$member": null } }, "ProjectFileSystemLocations": { "base": null, "refs": { "Build$fileSystemLocations": " An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
An array of ProjectFileSystemLocation objects for the batch build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
The name of the build project.
", "CreateWebhookInput$projectName": "The name of the AWS CodeBuild project.
", "DeleteWebhookInput$projectName": "The name of the AWS CodeBuild project.
", "Project$name": "The name of the build project.
", "UpdateWebhookInput$projectName": "The name of the AWS CodeBuild project.
" } }, "ProjectNames": { "base": null, "refs": { "BatchGetProjectsInput$names": "The names or ARNs of the build projects. To get information about a project shared with your AWS account, its ARN must be specified. You cannot specify a shared project using its name.
", "BatchGetProjectsOutput$projectsNotFound": "The names of build projects for which information could not be found.
", "ListProjectsOutput$projects": "The list of build project names, with each build project name representing a single build project.
" } }, "ProjectSecondarySourceVersions": { "base": null, "refs": { "Build$secondarySourceVersions": " An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For AWS CodeCommit: the commit ID, branch, or Git tag to use.
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.
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.
For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.
An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For AWS CodeCommit: the commit ID, branch, or Git tag to use.
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.
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.
For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take precedence over these secondarySourceVersions (at the project level).
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
An array of ProjectSourceVersion objects that override the secondary source versions in the batch build project.
An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
The criterion to be used to list build project names. Valid values include:
CREATED_TIME: List based on when each build project was created.
LAST_MODIFIED_TIME: List based on when information about each build project was last changed.
NAME: List based on each build project's name.
Use sortOrder to specify in what order to list the build project names based on the preceding criteria.
Information about the build input source code for the build project.
", "refs": { "Build$source": "Information about the source code to be built.
", "BuildBatch$source": null, "CreateProjectInput$source": "Information about the build input source code for the build project.
", "Project$source": "Information about the build input source code for this build project.
", "ProjectSources$member": null, "UpdateProjectInput$source": "Information to be changed about the build input source code for the build project.
" } }, "ProjectSourceVersion": { "base": "A source identifier and its corresponding version.
", "refs": { "ProjectSecondarySourceVersions$member": null } }, "ProjectSources": { "base": null, "refs": { "Build$secondarySources": " An array of ProjectSource objects.
An array of ProjectSource objects that define the sources for the batch build.
An array of ProjectSource objects.
An array of ProjectSource objects.
An array of ProjectSource objects that override the secondary sources defined in the batch build project.
An array of ProjectSource objects.
An array of ProjectSource objects.
Information about the requested build projects.
" } }, "PutResourcePolicyInput": { "base": null, "refs": { } }, "PutResourcePolicyOutput": { "base": null, "refs": { } }, "RegistryCredential": { "base": "Information about credentials that provide access to a private Docker registry. When this is set:
imagePullCredentialsType must be set to SERVICE_ROLE.
images cannot be curated or an Amazon ECR image.
For more information, see Private Registry with AWS Secrets Manager Sample for AWS CodeBuild.
", "refs": { "ProjectEnvironment$registryCredential": "The credentials for access to a private registry.
", "StartBuildBatchInput$registryCredentialOverride": "A RegistryCredential object that overrides credentials for access to a private registry.
The credentials for access to a private registry.
" } }, "Report": { "base": "Information about the results from running a series of test cases during the run of a build project. The test cases are specified in the buildspec for the build project using one or more paths to the test case files. You can specify any type of tests you want, such as unit tests, integration tests, and functional tests.
", "refs": { "Reports$member": null } }, "ReportArns": { "base": null, "refs": { "BatchGetReportsInput$reportArns": " An array of ARNs that identify the Report objects to return.
An array of ARNs passed to BatchGetReportGroups that are not associated with a Report.
The list of report ARNs.
", "ListReportsOutput$reports": "The list of returned ARNs for the reports in the current AWS account.
" } }, "ReportCodeCoverageSortByType": { "base": null, "refs": { "DescribeCodeCoveragesInput$sortBy": "Specifies how the results are sorted. Possible values are:
The results are sorted by file path.
The results are sorted by the percentage of lines that are covered.
Information about the location where the run of a report is exported.
", "refs": { "CreateReportGroupInput$exportConfig": " A ReportExportConfig object that contains information about where the report group test results are exported.
Information about where the raw data used to generate this report was exported.
", "ReportGroup$exportConfig": " Information about the destination where the raw data of this ReportGroup is exported.
Used to specify an updated export type. Valid values are:
S3: The report results are exported to an S3 bucket.
NO_EXPORT: The report results are not exported.
The export configuration type. Valid values are:
S3: The report results are exported to an S3 bucket.
NO_EXPORT: The report results are not exported.
A filter used to return reports with the status specified by the input status parameter.
A ReportFilter object used to filter the returned reports.
A ReportFilter object used to filter the returned reports.
A series of reports. Each report contains information about the results from running a series of test cases. You specify the test cases for a report group in the buildspec for a build project using one or more paths to the test case files.
", "refs": { "CreateReportGroupOutput$reportGroup": "Information about the report group that was created.
", "ReportGroups$member": null, "UpdateReportGroupOutput$reportGroup": "Information about the updated report group.
" } }, "ReportGroupArns": { "base": null, "refs": { "BatchGetReportGroupsInput$reportGroupArns": "An array of report group ARNs that identify the report groups to return.
", "BatchGetReportGroupsOutput$reportGroupsNotFound": " An array of ARNs passed to BatchGetReportGroups that are not associated with a ReportGroup.
The list of ARNs for the report groups in the current AWS account.
", "ListSharedReportGroupsOutput$reportGroups": "The list of ARNs for the report groups shared with the current AWS account or user.
" } }, "ReportGroupName": { "base": null, "refs": { "CreateReportGroupInput$name": "The name of the report group.
", "ReportGroup$name": " The name of a ReportGroup.
The criterion to be used to list build report groups. Valid values include:
CREATED_TIME: List based on when each report group was created.
LAST_MODIFIED_TIME: List based on when each report group was last changed.
NAME: List based on each report group's name.
The array of report groups returned by BatchGetReportGroups.
The type of build output artifact to create. Valid values include:
NONE: AWS CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified.
ZIP: AWS CodeBuild creates a ZIP file with the raw data in the output bucket.
A map that contains the number of each type of status returned by the test results in this TestReportSummary.
The status of this report.
", "ReportFilter$status": "The status used to filter reports. You can filter using one status only.
" } }, "ReportType": { "base": null, "refs": { "CreateReportGroupInput$type": "The type of report group.
", "Report$type": "The type of the report that was run.
A code coverage report.
A test report.
The type of the ReportGroup. The one valid value is TEST.
The array of Report objects returned by BatchGetReports.
Represents a resolved build artifact. A resolve artifact is an artifact that is built and deployed to the destination, such as Amazon Simple Storage Service (Amazon S3).
", "refs": { "BuildSummary$primaryArtifact": "A ResolvedArtifact object that represents the primary build artifacts for the build group.
An array of ResolvedArtifact objects that represents the secondary build artifacts for the build group.
The specified AWS resource cannot be created, because an AWS resource with the same settings already exists.
", "refs": { } }, "ResourceNotFoundException": { "base": "The specified AWS resource cannot be found.
", "refs": { } }, "RetryBuildBatchInput": { "base": null, "refs": { } }, "RetryBuildBatchOutput": { "base": null, "refs": { } }, "RetryBuildBatchType": { "base": null, "refs": { "RetryBuildBatchInput$retryType": "Specifies the type of retry to perform.
" } }, "RetryBuildInput": { "base": null, "refs": { } }, "RetryBuildOutput": { "base": null, "refs": { } }, "S3LogsConfig": { "base": "Information about S3 logs for a build project.
", "refs": { "LogsConfig$s3Logs": "Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.
", "LogsLocation$s3Logs": "Information about S3 logs for a build project.
" } }, "S3ReportExportConfig": { "base": "Information about the S3 bucket where the raw data of a report are exported.
", "refs": { "ReportExportConfig$s3Destination": " A S3ReportExportConfig object that contains information about the S3 bucket where the run of a report is exported.
A list of one or more security groups IDs in your Amazon VPC.
" } }, "SensitiveNonEmptyString": { "base": null, "refs": { "ImportSourceCredentialsInput$token": "For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.
" } }, "ServerType": { "base": null, "refs": { "ImportSourceCredentialsInput$serverType": "The source provider used for this project.
", "SourceCredentialsInfo$serverType": "The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
" } }, "SharedResourceSortByType": { "base": null, "refs": { "ListSharedProjectsInput$sortBy": "The criterion to be used to list build projects shared with the current AWS account or user. Valid values include:
ARN: List based on the ARN.
MODIFIED_TIME: List based on when information about the shared project was last changed.
The criterion to be used to list report groups shared with the current AWS account or user. Valid values include:
ARN: List based on the ARN.
MODIFIED_TIME: List based on when information about the shared report group was last changed.
Specifies if the results are sorted in ascending or descending order.
", "ListBuildBatchesForProjectInput$sortOrder": "Specifies the sort order of the returned items. Valid values include:
ASCENDING: List the batch build identifiers in ascending order by identifier.
DESCENDING: List the batch build identifiers in descending order by identifier.
Specifies the sort order of the returned items. Valid values include:
ASCENDING: List the batch build identifiers in ascending order by identifier.
DESCENDING: List the batch build identifiers in descending order by identifier.
The order to list build IDs. Valid values include:
ASCENDING: List the build IDs in ascending order by build ID.
DESCENDING: List the build IDs in descending order by build ID.
The order to list build IDs. Valid values include:
ASCENDING: List the build IDs in ascending order by build ID.
DESCENDING: List the build IDs in descending order by build ID.
The order in which to list build projects. Valid values include:
ASCENDING: List in ascending order.
DESCENDING: List in descending order.
Use sortBy to specify the criterion to be used to list build project names.
Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.
Use to specify whether the results are returned in ascending or descending order.
", "ListReportsInput$sortOrder": "Specifies the sort order for the list of returned reports. Valid values are:
ASCENDING: return reports in chronological order based on their creation date.
DESCENDING: return reports in the reverse chronological order based on their creation date.
The order in which to list shared build projects. Valid values include:
ASCENDING: List in ascending order.
DESCENDING: List in descending order.
The order in which to list shared report groups. Valid values include:
ASCENDING: List in ascending order.
DESCENDING: List in descending order.
Information about the authorization settings for AWS CodeBuild to access the source code to be built.
This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly.
", "refs": { "ProjectSource$auth": "Information about the authorization settings for AWS CodeBuild to access the source code to be built.
This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly.
", "StartBuildBatchInput$sourceAuthOverride": "A SourceAuth object that overrides the one defined in the batch build project. This override applies only if the build project's source is BitBucket or GitHub.
An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.
" } }, "SourceAuthType": { "base": null, "refs": { "SourceAuth$type": "This data type is deprecated and is no longer accurate or used.
The authorization type to use. The only valid value is OAUTH, which represents the OAuth authorization type.
Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository.
", "refs": { "SourceCredentialsInfos$member": null } }, "SourceCredentialsInfos": { "base": null, "refs": { "ListSourceCredentialsOutput$sourceCredentialsInfos": " A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials.
The type of repository that contains the source code to be built. Valid values include:
BITBUCKET: The source code is in a Bitbucket repository.
CODECOMMIT: The source code is in an AWS CodeCommit repository.
CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS CodePipeline.
GITHUB: The source code is in a GitHub or GitHub Enterprise Cloud repository.
GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.
NO_SOURCE: The project does not have input source code.
S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
The source input type that overrides the source input defined in the batch build project.
", "StartBuildInput$sourceTypeOverride": "A source input type, for this build, that overrides the source input defined in the build project.
" } }, "StartBuildBatchInput": { "base": null, "refs": { } }, "StartBuildBatchOutput": { "base": null, "refs": { } }, "StartBuildInput": { "base": null, "refs": { } }, "StartBuildOutput": { "base": null, "refs": { } }, "StatusType": { "base": null, "refs": { "Build$buildStatus": "The current status of the build. Valid values include:
FAILED: The build failed.
FAULT: The build faulted.
IN_PROGRESS: The build is still in progress.
STOPPED: The build stopped.
SUCCEEDED: The build succeeded.
TIMED_OUT: The build timed out.
The status of the batch build.
", "BuildBatchFilter$status": "The status of the batch builds to retrieve. Only batch builds that have this status will be retrieved.
", "BuildBatchPhase$phaseStatus": "The current status of the batch build phase. Valid values include:
The build phase failed.
The build phase faulted.
The build phase is still in progress.
The build has been submitted and is queued behind other submitted builds.
The build phase stopped.
The build phase succeeded.
The build phase timed out.
The current status of the build phase. Valid values include:
The build phase failed.
The build phase faulted.
The build phase is still in progress.
The build has been submitted and is queued behind other submitted builds.
The build phase stopped.
The build phase succeeded.
The build phase timed out.
The status of the build group.
The build group failed.
The build group faulted.
The build group is still in progress.
The build group stopped.
The build group succeeded.
The build group timed out.
The current build phase.
", "Build$initiator": "The entity that started the build. Valid values include:
If AWS CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).
If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example, MyUserName).
If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
The ARN of the batch build that this build is a member of, if applicable.
", "BuildArtifacts$location": "Information about the location of the build artifacts.
", "BuildArtifacts$sha256sum": "The SHA-256 hash of the build artifact.
You can use this hash along with a checksum tool to confirm file integrity and authenticity.
This value is available only if the build project's packaging value is set to ZIP.
The MD5 hash of the build artifact.
You can use this hash along with a checksum tool to confirm file integrity and authenticity.
This value is available only if the build project's packaging value is set to ZIP.
An identifier for this artifact definition.
", "BuildBatch$currentPhase": "The current phase of the batch build.
", "BuildBatch$initiator": "The entity that started the batch build. Valid values include:
If AWS CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).
If an AWS Identity and Access Management (IAM) user started the build, the user's name.
If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
Contains the identifier of the build group.
", "BuildNotDeleted$statusCode": "Additional information about the build that could not be successfully deleted.
", "BuildReportArns$member": null, "BuildStatusConfig$context": "Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
This parameter is used for the name parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.
This parameter is used for the context parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
This parameter is used for the url parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.
This parameter is used for the target_url parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
The batch build ARN.
", "CloudWatchLogsConfig$groupName": "The group name of the logs in Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
", "CloudWatchLogsConfig$streamName": "The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
", "CreateProjectInput$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:
For AWS CodeCommit: the commit ID, branch, or Git tag to use.
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.
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.
For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
", "CreateWebhookInput$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.
It is recommended that you use filterGroups instead of branchFilter.
The status code.
", "DescribeCodeCoveragesInput$nextToken": "The nextToken value returned from a previous call to DescribeCodeCoverages. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
If there are more items to return, this contains a token that is passed to a subsequent call to DescribeCodeCoverages to retrieve the next set of items.
The ARN of the report for which test cases are returned.
", "DescribeTestCasesInput$nextToken": " During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
The name of the Docker image.
", "EnvironmentImage$description": "The description of the Docker image.
", "EnvironmentVariable$value": "The value of the environment variable.
We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.
The value assigned to this exported environment variable.
During a build, the value of a variable is available starting with the install phase. It can be updated between the start of the install phase and the end of the post_build phase. After the post_build phase ends, the value of exported variables cannot change.
The nextToken value returned from a previous call to ListBuildBatchesForProject. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
If there are more items to return, this contains a token that is passed to a subsequent call to ListBuildBatchesForProject to retrieve the next set of items.
The nextToken value returned from a previous call to ListBuildBatches. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
If there are more items to return, this contains a token that is passed to a subsequent call to ListBuildBatches to retrieve the next set of items.
During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
", "ListBuildsForProjectOutput$nextToken": "If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.
", "ListBuildsInput$nextToken": "During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
", "ListBuildsOutput$nextToken": "If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.
", "ListProjectsOutput$nextToken": "If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.
", "ListReportGroupsInput$nextToken": " During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
The ARN of the report group for which you want to return report ARNs.
", "ListReportsForReportGroupInput$nextToken": " During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
The name of the Amazon CloudWatch Logs group for the build logs.
", "LogsLocation$streamName": "The name of the Amazon CloudWatch Logs stream for the build logs.
", "LogsLocation$deepLink": "The URL to an individual build log in Amazon CloudWatch Logs.
", "LogsLocation$s3DeepLink": "The URL to a build log in an S3 bucket.
", "LogsLocation$cloudWatchLogsArn": " The ARN of Amazon CloudWatch Logs for a build project. Its format is arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}. For more information, see Resources Defined by Amazon CloudWatch Logs.
The ARN of S3 logs for a build project. Its format is arn:${Partition}:s3:::${BucketName}/${ObjectName}. For more information, see Resources Defined by Amazon S3.
The status code for the context of the build phase.
", "PhaseContext$message": "An explanation of the build phase's context. This might include a command ID and an exit code.
", "Project$arn": "The Amazon Resource Name (ARN) of the build project.
", "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:
For AWS CodeCommit: the commit ID, branch, or Git tag to use.
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.
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.
For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
", "ProjectArtifacts$location": "Information about the build output artifact location:
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.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, this is the name of the output bucket.
Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:
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.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.
For 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.
Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:
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.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
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.
For example:
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.
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.
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 .
An identifier for this artifact definition.
", "ProjectBadge$badgeRequestUrl": "The publicly-accessible URL through which you can access the build badge for your project.
The publicly accessible URL through which you can access the build badge for your project.
", "ProjectCache$location": "Information about the cache location:
NO_CACHE or LOCAL: This value is ignored.
S3: This is the S3 bucket name/prefix.
The certificate to use with this build project.
", "ProjectFileSystemLocation$location": " A string that specifies the location of the file system created by Amazon EFS. Its format is efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the AWS EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory is my-efs-mount-directory, then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.
The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.
The location in the container where you mount the file system.
", "ProjectFileSystemLocation$identifier": " The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the identifier in all capital letters to CODEBUILD_. For example, if you specify my-efs for identifier, a new environment variable is create named CODEBUILD_MY-EFS.
The identifier is used to mount your file system.
The mount options for a file system created by AWS EFS. The default mount options used by CodeBuild are nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options.
Information about the location of the source code to be built. Valid values include:
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.
For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).
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/).
For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. 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.
For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. 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.
The buildspec file declaration to use for the builds in this build project.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
An identifier for this project source.
", "ProjectSourceVersion$sourceIdentifier": "An identifier for a source in the build project.
", "ProjectSourceVersion$sourceVersion": "The source version for the corresponding source identifier. If specified, must be one of:
For AWS CodeCommit: the commit ID, branch, or Git tag to use.
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.
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.
For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
", "Report$name": "The name of the report that was run.
", "Report$executionId": "The ARN of the build run that generated this report.
", "ReportStatusCounts$key": null, "ResolvedArtifact$location": "The location of the artifact.
", "ResolvedArtifact$identifier": "The identifier of the artifact.
", "RetryBuildBatchInput$idempotencyToken": "A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuildBatch request. The token is included in the RetryBuildBatch request and is valid for five minutes. If you repeat the RetryBuildBatch request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.
A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuild request. The token is included in the RetryBuild request and is valid for five minutes. If you repeat the RetryBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.
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.
The path to the exported report's raw data results.
", "SourceAuth$resource": "The resource value that applies to the specified authorization type.
", "StartBuildBatchInput$sourceVersion": "The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:
The commit ID, branch, or Git tag to use.
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.
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.
The version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
", "StartBuildBatchInput$sourceLocationOverride": "A location that overrides, for this batch build, the source location defined in the batch build project.
", "StartBuildBatchInput$buildspecOverride": "A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
The name of a certificate for this batch build that overrides the one specified in the batch build project.
", "StartBuildBatchInput$idempotencyToken": "A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch request. The token is included in the StartBuildBatch request and is valid for five minutes. If you repeat the StartBuildBatch request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.
The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:
The commit ID, branch, or Git tag to use.
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.
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.
The version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
", "StartBuildInput$sourceLocationOverride": "A location that overrides, for this build, the source location for the one defined in the build project.
", "StartBuildInput$buildspecOverride": "A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
The name of a certificate for this build that overrides the one specified in the build project.
", "StartBuildInput$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 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.
", "TestCase$testRawDataPath": "The path to the raw data file that contains the test result.
", "TestCase$prefix": "A string that is applied to a series of related test cases. CodeBuild generates the prefix. The prefix depends on the framework used to generate the tests.
", "TestCase$name": "The name of the test case.
", "TestCase$status": " The status returned by the test case after it was run. Valid statuses are SUCCEEDED, FAILED, ERROR, SKIPPED, and UNKNOWN.
A message associated with a test case. For example, an error message or stack trace.
", "TestCaseFilter$status": " The status used to filter test cases. Valid statuses are SUCCEEDED, FAILED, ERROR, SKIPPED, and UNKNOWN. A TestCaseFilter can have one status.
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:
For AWS CodeCommit: the commit ID, branch, or Git tag to use.
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.
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.
For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
", "UpdateWebhookInput$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.
It is recommended that you use filterGroups instead of 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.
It is recommended that you use filterGroups instead of branchFilter.
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.
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.
A list of one or more subnet IDs in your Amazon VPC.
" } }, "Tag": { "base": "A tag, consisting of a key and a value.
This tag is available for use by AWS services that support tags in AWS CodeBuild.
", "refs": { "TagList$member": null } }, "TagList": { "base": null, "refs": { "CreateProjectInput$tags": "A list of tag key and value pairs associated with this build project.
These tags are available for use by AWS services that support AWS CodeBuild build project tags.
", "CreateReportGroupInput$tags": "A list of tag key and value pairs associated with this report group.
These tags are available for use by AWS services that support AWS CodeBuild report group tags.
", "Project$tags": "A list of tag key and value pairs associated with this build project.
These tags are available for use by AWS services that support AWS CodeBuild build project tags.
", "ReportGroup$tags": "A list of tag key and value pairs associated with this report group.
These tags are available for use by AWS services that support AWS CodeBuild report group tags.
", "UpdateProjectInput$tags": "An updated list of tag key and value pairs associated with this build project.
These tags are available for use by AWS services that support AWS CodeBuild build project tags.
", "UpdateReportGroupInput$tags": "An updated list of tag key and value pairs associated with this report group.
These tags are available for use by AWS services that support AWS CodeBuild report group tags.
" } }, "TestCase": { "base": "Information about a test case created using a framework such as NUnit or Cucumber. A test case might be a unit test or a configuration test.
", "refs": { "TestCases$member": null } }, "TestCaseFilter": { "base": "A filter used to return specific types of test cases.
", "refs": { "DescribeTestCasesInput$filter": " A TestCaseFilter object used to filter the returned reports.
The returned list of test cases.
" } }, "TestReportSummary": { "base": "Information about a test report.
", "refs": { "Report$testSummary": " A TestReportSummary object that contains information about this test report.
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.
", "CreateProjectInput$queuedTimeoutInMinutes": "The number of minutes a build is allowed to be queued before it times out.
", "Project$timeoutInMinutes": "How long, 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. The default is 60 minutes.
", "Project$queuedTimeoutInMinutes": "The number of minutes a build is allowed to be queued before it times out.
", "StartBuildBatchInput$buildTimeoutInMinutesOverride": "Overrides the build timeout specified in the batch build project.
", "StartBuildBatchInput$queuedTimeoutInMinutesOverride": "The number of minutes a batch build is allowed to be queued before it times out.
", "StartBuildInput$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.
", "StartBuildInput$queuedTimeoutInMinutesOverride": "The number of minutes a build is allowed to be queued before it times out.
", "UpdateProjectInput$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.
", "UpdateProjectInput$queuedTimeoutInMinutes": "The number of minutes a build is allowed to be queued before it times out.
" } }, "Timestamp": { "base": null, "refs": { "Build$startTime": "When the build process started, expressed in Unix time format.
", "Build$endTime": "When the build process ended, expressed in Unix time format.
", "BuildBatch$startTime": "The date and time that the batch build started.
", "BuildBatch$endTime": "The date and time that the batch build ended.
", "BuildBatchPhase$startTime": "When the batch build phase started, expressed in Unix time format.
", "BuildBatchPhase$endTime": "When the batch build phase ended, expressed in Unix time format.
", "BuildPhase$startTime": "When the build phase started, expressed in Unix time format.
", "BuildPhase$endTime": "When the build phase ended, expressed in Unix time format.
", "BuildSummary$requestedOn": "When the build was started, expressed in Unix time format.
", "CodeCoverage$expired": "The date and time that the tests were run.
", "Project$created": "When the build project was created, expressed in Unix time format.
", "Project$lastModified": "When the build project's settings were last modified, expressed in Unix time format.
", "Report$created": "The date and time this report run occurred.
", "Report$expired": "The date and time a report expires. A report expires 30 days after it is created. An expired report is not available to view in CodeBuild.
", "ReportGroup$created": " The date and time this ReportGroup was created.
The date and time this ReportGroup was last modified.
The date and time a test case expires. A test case expires 30 days after it is created. An expired test case is not available to view in CodeBuild.
", "Webhook$lastModifiedSecret": "A timestamp that indicates the last time a repository's secret token was modified.
" } }, "UpdateProjectInput": { "base": null, "refs": { } }, "UpdateProjectOutput": { "base": null, "refs": { } }, "UpdateReportGroupInput": { "base": null, "refs": { } }, "UpdateReportGroupOutput": { "base": null, "refs": { } }, "UpdateWebhookInput": { "base": null, "refs": { } }, "UpdateWebhookOutput": { "base": null, "refs": { } }, "ValueInput": { "base": null, "refs": { "Tag$value": "The tag's value.
" } }, "VpcConfig": { "base": "Information about the VPC configuration that AWS CodeBuild accesses.
", "refs": { "Build$vpcConfig": "If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
", "BuildBatch$vpcConfig": null, "CreateProjectInput$vpcConfig": "VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.
", "Project$vpcConfig": "Information about the VPC configuration that AWS CodeBuild accesses.
", "UpdateProjectInput$vpcConfig": "VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.
" } }, "Webhook": { "base": "Information about a webhook that connects repository events to a build project in AWS CodeBuild.
", "refs": { "CreateWebhookOutput$webhook": "Information about a webhook that connects repository events to a build project in AWS CodeBuild.
", "Project$webhook": "Information about a webhook that connects repository events to a build project in AWS CodeBuild.
", "UpdateWebhookOutput$webhook": "Information about a repository's webhook that is associated with a project in AWS CodeBuild.
" } }, "WebhookBuildType": { "base": null, "refs": { "CreateWebhookInput$buildType": "Specifies the type of build this webhook will trigger.
", "UpdateWebhookInput$buildType": "Specifies the type of build this webhook will trigger.
", "Webhook$buildType": "Specifies the type of build this webhook will trigger.
" } }, "WebhookFilter": { "base": "A filter used to determine which webhooks trigger a build.
", "refs": { "FilterGroup$member": null } }, "WebhookFilterType": { "base": null, "refs": { "WebhookFilter$type": " The type of webhook filter. There are six webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH, and COMMIT_MESSAGE.
A webhook event triggers a build when the provided pattern matches one of five event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED, and PULL_REQUEST_MERGED. 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.
The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only.
A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression pattern.
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.
Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
A webhook event triggers a build when the base reference matches the regular expression pattern. For example, refs/heads/branch-name.
Works with pull request events only.
A webhook triggers a build when the path of a changed file matches the regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.
A webhook triggers a build when the head commit message matches the regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.
If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec 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.
", "BuildArtifacts$encryptionDisabled": "Information that tells you if encryption for build artifacts is disabled.
", "CreateProjectInput$badgeEnabled": "Set this to true to generate a publicly accessible URL for your project's build badge.
", "DebugSession$sessionEnabled": "Specifies if session debugging is enabled for this build.
", "GitSubmodulesConfig$fetchSubmodules": "Set to true to fetch Git submodules for your AWS CodeBuild build project.
", "ImportSourceCredentialsInput$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.
If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec 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.
", "ProjectArtifacts$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.
", "ProjectBuildBatchConfig$combineArtifacts": "Specifies if the build artifacts for the batch build should be combined into a single artifact location.
", "ProjectEnvironment$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. The default setting is false.
You 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:
If the operating system's base image is Ubuntu Linux:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&
- timeout 15 sh -c \"until docker info; do echo .; sleep 1; done\"
If the operating system's base image is Alpine Linux and the previous command does not work, add the -t argument to timeout:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&
- timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"
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.
The status of a build triggered by a webhook is always reported to your source provider.
Enable this flag to ignore SSL warnings while connecting to the project source code.
", "Report$truncated": "A boolean that specifies if this report run is truncated. The list of test cases is truncated after the maximum number of test cases is reached.
", "S3LogsConfig$encryptionDisabled": "Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
", "S3ReportExportConfig$encryptionDisabled": "A boolean value that specifies if the results of a report are encrypted.
", "StartBuildBatchInput$insecureSslOverride": "Enable this flag to override the insecure SSL setting that is specified in the batch build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.
", "StartBuildBatchInput$reportBuildBatchStatusOverride": "Set to true to report to your source provider the status of a batch build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.
The status of a build triggered by a webhook is always reported to your source provider.
Enable this flag to override privileged mode in the batch build project.
", "StartBuildInput$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.
", "StartBuildInput$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.
The status of a build triggered by a webhook is always reported to your source provider.
Enable this flag to override privileged mode in the build project.
", "StartBuildInput$debugSessionEnabled": "Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.
", "UpdateProjectInput$badgeEnabled": "Set this to true to generate a publicly accessible URL for your project's build badge.
", "WebhookFilter$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.
Specifies the maximum number of builds allowed.
", "Build$timeoutInMinutes": "How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.
", "Build$queuedTimeoutInMinutes": "The number of minutes a build is allowed to be queued before it times out.
", "BuildBatch$buildTimeoutInMinutes": "Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.
", "BuildBatch$queuedTimeoutInMinutes": "Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.
", "ProjectBuildBatchConfig$timeoutInMins": "Specifies the maximum amount of time, in minutes, that the batch build must be completed in.
", "ReportStatusCounts$value": null, "TestReportSummary$total": " The number of test cases in this TestReportSummary. The total includes truncated test cases.
The number of the build. For each project, the buildNumber of its first build is 1. The buildNumber of each subsequent build is incremented by 1. If a build is deleted, the buildNumber of other builds does not change.
The number of the batch build. For each project, the buildBatchNumber of its first batch build is 1. The buildBatchNumber of each subsequent batch build is incremented by 1. If a batch build is deleted, the buildBatchNumber of other batch builds does not change.
How long, in seconds, between the starting and ending times of the batch build's phase.
", "BuildPhase$durationInSeconds": "How long, in seconds, between the starting and ending times of the build's phase.
", "TestCase$durationInNanoSeconds": "The number of nanoseconds it took to run this test case.
", "TestReportSummary$durationInNanoSeconds": "The number of nanoseconds it took to run all of the test cases in this report.
" } } } }