/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / codebuild.d.ts
codebuild.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class CodeBuild extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: CodeBuild.Types.ClientConfiguration) 13 config: Config & CodeBuild.Types.ClientConfiguration; 14 /** 15 * Deletes one or more builds. 16 */ 17 batchDeleteBuilds(params: CodeBuild.Types.BatchDeleteBuildsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchDeleteBuildsOutput) => void): Request<CodeBuild.Types.BatchDeleteBuildsOutput, AWSError>; 18 /** 19 * Deletes one or more builds. 20 */ 21 batchDeleteBuilds(callback?: (err: AWSError, data: CodeBuild.Types.BatchDeleteBuildsOutput) => void): Request<CodeBuild.Types.BatchDeleteBuildsOutput, AWSError>; 22 /** 23 * Retrieves information about one or more batch builds. 24 */ 25 batchGetBuildBatches(params: CodeBuild.Types.BatchGetBuildBatchesInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetBuildBatchesOutput) => void): Request<CodeBuild.Types.BatchGetBuildBatchesOutput, AWSError>; 26 /** 27 * Retrieves information about one or more batch builds. 28 */ 29 batchGetBuildBatches(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetBuildBatchesOutput) => void): Request<CodeBuild.Types.BatchGetBuildBatchesOutput, AWSError>; 30 /** 31 * Gets information about one or more builds. 32 */ 33 batchGetBuilds(params: CodeBuild.Types.BatchGetBuildsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetBuildsOutput) => void): Request<CodeBuild.Types.BatchGetBuildsOutput, AWSError>; 34 /** 35 * Gets information about one or more builds. 36 */ 37 batchGetBuilds(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetBuildsOutput) => void): Request<CodeBuild.Types.BatchGetBuildsOutput, AWSError>; 38 /** 39 * Gets information about one or more build projects. 40 */ 41 batchGetProjects(params: CodeBuild.Types.BatchGetProjectsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetProjectsOutput) => void): Request<CodeBuild.Types.BatchGetProjectsOutput, AWSError>; 42 /** 43 * Gets information about one or more build projects. 44 */ 45 batchGetProjects(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetProjectsOutput) => void): Request<CodeBuild.Types.BatchGetProjectsOutput, AWSError>; 46 /** 47 * Returns an array of report groups. 48 */ 49 batchGetReportGroups(params: CodeBuild.Types.BatchGetReportGroupsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetReportGroupsOutput) => void): Request<CodeBuild.Types.BatchGetReportGroupsOutput, AWSError>; 50 /** 51 * Returns an array of report groups. 52 */ 53 batchGetReportGroups(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetReportGroupsOutput) => void): Request<CodeBuild.Types.BatchGetReportGroupsOutput, AWSError>; 54 /** 55 * Returns an array of reports. 56 */ 57 batchGetReports(params: CodeBuild.Types.BatchGetReportsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetReportsOutput) => void): Request<CodeBuild.Types.BatchGetReportsOutput, AWSError>; 58 /** 59 * Returns an array of reports. 60 */ 61 batchGetReports(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetReportsOutput) => void): Request<CodeBuild.Types.BatchGetReportsOutput, AWSError>; 62 /** 63 * Creates a build project. 64 */ 65 createProject(params: CodeBuild.Types.CreateProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.CreateProjectOutput) => void): Request<CodeBuild.Types.CreateProjectOutput, AWSError>; 66 /** 67 * Creates a build project. 68 */ 69 createProject(callback?: (err: AWSError, data: CodeBuild.Types.CreateProjectOutput) => void): Request<CodeBuild.Types.CreateProjectOutput, AWSError>; 70 /** 71 * Creates a report group. A report group contains a collection of reports. 72 */ 73 createReportGroup(params: CodeBuild.Types.CreateReportGroupInput, callback?: (err: AWSError, data: CodeBuild.Types.CreateReportGroupOutput) => void): Request<CodeBuild.Types.CreateReportGroupOutput, AWSError>; 74 /** 75 * Creates a report group. A report group contains a collection of reports. 76 */ 77 createReportGroup(callback?: (err: AWSError, data: CodeBuild.Types.CreateReportGroupOutput) => void): Request<CodeBuild.Types.CreateReportGroupOutput, AWSError>; 78 /** 79 * For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository. If you enable webhooks for an CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings. 80 */ 81 createWebhook(params: CodeBuild.Types.CreateWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.CreateWebhookOutput) => void): Request<CodeBuild.Types.CreateWebhookOutput, AWSError>; 82 /** 83 * For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository. If you enable webhooks for an CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings. 84 */ 85 createWebhook(callback?: (err: AWSError, data: CodeBuild.Types.CreateWebhookOutput) => void): Request<CodeBuild.Types.CreateWebhookOutput, AWSError>; 86 /** 87 * Deletes a batch build. 88 */ 89 deleteBuildBatch(params: CodeBuild.Types.DeleteBuildBatchInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteBuildBatchOutput) => void): Request<CodeBuild.Types.DeleteBuildBatchOutput, AWSError>; 90 /** 91 * Deletes a batch build. 92 */ 93 deleteBuildBatch(callback?: (err: AWSError, data: CodeBuild.Types.DeleteBuildBatchOutput) => void): Request<CodeBuild.Types.DeleteBuildBatchOutput, AWSError>; 94 /** 95 * Deletes a build project. When you delete a project, its builds are not deleted. 96 */ 97 deleteProject(params: CodeBuild.Types.DeleteProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteProjectOutput) => void): Request<CodeBuild.Types.DeleteProjectOutput, AWSError>; 98 /** 99 * Deletes a build project. When you delete a project, its builds are not deleted. 100 */ 101 deleteProject(callback?: (err: AWSError, data: CodeBuild.Types.DeleteProjectOutput) => void): Request<CodeBuild.Types.DeleteProjectOutput, AWSError>; 102 /** 103 * Deletes a report. 104 */ 105 deleteReport(params: CodeBuild.Types.DeleteReportInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteReportOutput) => void): Request<CodeBuild.Types.DeleteReportOutput, AWSError>; 106 /** 107 * Deletes a report. 108 */ 109 deleteReport(callback?: (err: AWSError, data: CodeBuild.Types.DeleteReportOutput) => void): Request<CodeBuild.Types.DeleteReportOutput, AWSError>; 110 /** 111 * Deletes a report group. Before you delete a report group, you must delete its reports. 112 */ 113 deleteReportGroup(params: CodeBuild.Types.DeleteReportGroupInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteReportGroupOutput) => void): Request<CodeBuild.Types.DeleteReportGroupOutput, AWSError>; 114 /** 115 * Deletes a report group. Before you delete a report group, you must delete its reports. 116 */ 117 deleteReportGroup(callback?: (err: AWSError, data: CodeBuild.Types.DeleteReportGroupOutput) => void): Request<CodeBuild.Types.DeleteReportGroupOutput, AWSError>; 118 /** 119 * Deletes a resource policy that is identified by its resource ARN. 120 */ 121 deleteResourcePolicy(params: CodeBuild.Types.DeleteResourcePolicyInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteResourcePolicyOutput) => void): Request<CodeBuild.Types.DeleteResourcePolicyOutput, AWSError>; 122 /** 123 * Deletes a resource policy that is identified by its resource ARN. 124 */ 125 deleteResourcePolicy(callback?: (err: AWSError, data: CodeBuild.Types.DeleteResourcePolicyOutput) => void): Request<CodeBuild.Types.DeleteResourcePolicyOutput, AWSError>; 126 /** 127 * Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials. 128 */ 129 deleteSourceCredentials(params: CodeBuild.Types.DeleteSourceCredentialsInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteSourceCredentialsOutput) => void): Request<CodeBuild.Types.DeleteSourceCredentialsOutput, AWSError>; 130 /** 131 * Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials. 132 */ 133 deleteSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.DeleteSourceCredentialsOutput) => void): Request<CodeBuild.Types.DeleteSourceCredentialsOutput, AWSError>; 134 /** 135 * For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository. 136 */ 137 deleteWebhook(params: CodeBuild.Types.DeleteWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteWebhookOutput) => void): Request<CodeBuild.Types.DeleteWebhookOutput, AWSError>; 138 /** 139 * For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository. 140 */ 141 deleteWebhook(callback?: (err: AWSError, data: CodeBuild.Types.DeleteWebhookOutput) => void): Request<CodeBuild.Types.DeleteWebhookOutput, AWSError>; 142 /** 143 * Retrieves one or more code coverage reports. 144 */ 145 describeCodeCoverages(params: CodeBuild.Types.DescribeCodeCoveragesInput, callback?: (err: AWSError, data: CodeBuild.Types.DescribeCodeCoveragesOutput) => void): Request<CodeBuild.Types.DescribeCodeCoveragesOutput, AWSError>; 146 /** 147 * Retrieves one or more code coverage reports. 148 */ 149 describeCodeCoverages(callback?: (err: AWSError, data: CodeBuild.Types.DescribeCodeCoveragesOutput) => void): Request<CodeBuild.Types.DescribeCodeCoveragesOutput, AWSError>; 150 /** 151 * Returns a list of details about test cases for a report. 152 */ 153 describeTestCases(params: CodeBuild.Types.DescribeTestCasesInput, callback?: (err: AWSError, data: CodeBuild.Types.DescribeTestCasesOutput) => void): Request<CodeBuild.Types.DescribeTestCasesOutput, AWSError>; 154 /** 155 * Returns a list of details about test cases for a report. 156 */ 157 describeTestCases(callback?: (err: AWSError, data: CodeBuild.Types.DescribeTestCasesOutput) => void): Request<CodeBuild.Types.DescribeTestCasesOutput, AWSError>; 158 /** 159 * Analyzes and accumulates test report values for the specified test reports. 160 */ 161 getReportGroupTrend(params: CodeBuild.Types.GetReportGroupTrendInput, callback?: (err: AWSError, data: CodeBuild.Types.GetReportGroupTrendOutput) => void): Request<CodeBuild.Types.GetReportGroupTrendOutput, AWSError>; 162 /** 163 * Analyzes and accumulates test report values for the specified test reports. 164 */ 165 getReportGroupTrend(callback?: (err: AWSError, data: CodeBuild.Types.GetReportGroupTrendOutput) => void): Request<CodeBuild.Types.GetReportGroupTrendOutput, AWSError>; 166 /** 167 * Gets a resource policy that is identified by its resource ARN. 168 */ 169 getResourcePolicy(params: CodeBuild.Types.GetResourcePolicyInput, callback?: (err: AWSError, data: CodeBuild.Types.GetResourcePolicyOutput) => void): Request<CodeBuild.Types.GetResourcePolicyOutput, AWSError>; 170 /** 171 * Gets a resource policy that is identified by its resource ARN. 172 */ 173 getResourcePolicy(callback?: (err: AWSError, data: CodeBuild.Types.GetResourcePolicyOutput) => void): Request<CodeBuild.Types.GetResourcePolicyOutput, AWSError>; 174 /** 175 * Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository. 176 */ 177 importSourceCredentials(params: CodeBuild.Types.ImportSourceCredentialsInput, callback?: (err: AWSError, data: CodeBuild.Types.ImportSourceCredentialsOutput) => void): Request<CodeBuild.Types.ImportSourceCredentialsOutput, AWSError>; 178 /** 179 * Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository. 180 */ 181 importSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.ImportSourceCredentialsOutput) => void): Request<CodeBuild.Types.ImportSourceCredentialsOutput, AWSError>; 182 /** 183 * Resets the cache for a project. 184 */ 185 invalidateProjectCache(params: CodeBuild.Types.InvalidateProjectCacheInput, callback?: (err: AWSError, data: CodeBuild.Types.InvalidateProjectCacheOutput) => void): Request<CodeBuild.Types.InvalidateProjectCacheOutput, AWSError>; 186 /** 187 * Resets the cache for a project. 188 */ 189 invalidateProjectCache(callback?: (err: AWSError, data: CodeBuild.Types.InvalidateProjectCacheOutput) => void): Request<CodeBuild.Types.InvalidateProjectCacheOutput, AWSError>; 190 /** 191 * Retrieves the identifiers of your build batches in the current region. 192 */ 193 listBuildBatches(params: CodeBuild.Types.ListBuildBatchesInput, callback?: (err: AWSError, data: CodeBuild.Types.ListBuildBatchesOutput) => void): Request<CodeBuild.Types.ListBuildBatchesOutput, AWSError>; 194 /** 195 * Retrieves the identifiers of your build batches in the current region. 196 */ 197 listBuildBatches(callback?: (err: AWSError, data: CodeBuild.Types.ListBuildBatchesOutput) => void): Request<CodeBuild.Types.ListBuildBatchesOutput, AWSError>; 198 /** 199 * Retrieves the identifiers of the build batches for a specific project. 200 */ 201 listBuildBatchesForProject(params: CodeBuild.Types.ListBuildBatchesForProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.ListBuildBatchesForProjectOutput) => void): Request<CodeBuild.Types.ListBuildBatchesForProjectOutput, AWSError>; 202 /** 203 * Retrieves the identifiers of the build batches for a specific project. 204 */ 205 listBuildBatchesForProject(callback?: (err: AWSError, data: CodeBuild.Types.ListBuildBatchesForProjectOutput) => void): Request<CodeBuild.Types.ListBuildBatchesForProjectOutput, AWSError>; 206 /** 207 * Gets a list of build IDs, with each build ID representing a single build. 208 */ 209 listBuilds(params: CodeBuild.Types.ListBuildsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsOutput) => void): Request<CodeBuild.Types.ListBuildsOutput, AWSError>; 210 /** 211 * Gets a list of build IDs, with each build ID representing a single build. 212 */ 213 listBuilds(callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsOutput) => void): Request<CodeBuild.Types.ListBuildsOutput, AWSError>; 214 /** 215 * Gets a list of build identifiers for the specified build project, with each build identifier representing a single build. 216 */ 217 listBuildsForProject(params: CodeBuild.Types.ListBuildsForProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsForProjectOutput) => void): Request<CodeBuild.Types.ListBuildsForProjectOutput, AWSError>; 218 /** 219 * Gets a list of build identifiers for the specified build project, with each build identifier representing a single build. 220 */ 221 listBuildsForProject(callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsForProjectOutput) => void): Request<CodeBuild.Types.ListBuildsForProjectOutput, AWSError>; 222 /** 223 * Gets information about Docker images that are managed by CodeBuild. 224 */ 225 listCuratedEnvironmentImages(params: CodeBuild.Types.ListCuratedEnvironmentImagesInput, callback?: (err: AWSError, data: CodeBuild.Types.ListCuratedEnvironmentImagesOutput) => void): Request<CodeBuild.Types.ListCuratedEnvironmentImagesOutput, AWSError>; 226 /** 227 * Gets information about Docker images that are managed by CodeBuild. 228 */ 229 listCuratedEnvironmentImages(callback?: (err: AWSError, data: CodeBuild.Types.ListCuratedEnvironmentImagesOutput) => void): Request<CodeBuild.Types.ListCuratedEnvironmentImagesOutput, AWSError>; 230 /** 231 * Gets a list of build project names, with each build project name representing a single build project. 232 */ 233 listProjects(params: CodeBuild.Types.ListProjectsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListProjectsOutput) => void): Request<CodeBuild.Types.ListProjectsOutput, AWSError>; 234 /** 235 * Gets a list of build project names, with each build project name representing a single build project. 236 */ 237 listProjects(callback?: (err: AWSError, data: CodeBuild.Types.ListProjectsOutput) => void): Request<CodeBuild.Types.ListProjectsOutput, AWSError>; 238 /** 239 * Gets a list ARNs for the report groups in the current Amazon Web Services account. 240 */ 241 listReportGroups(params: CodeBuild.Types.ListReportGroupsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListReportGroupsOutput) => void): Request<CodeBuild.Types.ListReportGroupsOutput, AWSError>; 242 /** 243 * Gets a list ARNs for the report groups in the current Amazon Web Services account. 244 */ 245 listReportGroups(callback?: (err: AWSError, data: CodeBuild.Types.ListReportGroupsOutput) => void): Request<CodeBuild.Types.ListReportGroupsOutput, AWSError>; 246 /** 247 * Returns a list of ARNs for the reports in the current Amazon Web Services account. 248 */ 249 listReports(params: CodeBuild.Types.ListReportsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListReportsOutput) => void): Request<CodeBuild.Types.ListReportsOutput, AWSError>; 250 /** 251 * Returns a list of ARNs for the reports in the current Amazon Web Services account. 252 */ 253 listReports(callback?: (err: AWSError, data: CodeBuild.Types.ListReportsOutput) => void): Request<CodeBuild.Types.ListReportsOutput, AWSError>; 254 /** 255 * Returns a list of ARNs for the reports that belong to a ReportGroup. 256 */ 257 listReportsForReportGroup(params: CodeBuild.Types.ListReportsForReportGroupInput, callback?: (err: AWSError, data: CodeBuild.Types.ListReportsForReportGroupOutput) => void): Request<CodeBuild.Types.ListReportsForReportGroupOutput, AWSError>; 258 /** 259 * Returns a list of ARNs for the reports that belong to a ReportGroup. 260 */ 261 listReportsForReportGroup(callback?: (err: AWSError, data: CodeBuild.Types.ListReportsForReportGroupOutput) => void): Request<CodeBuild.Types.ListReportsForReportGroupOutput, AWSError>; 262 /** 263 * Gets a list of projects that are shared with other Amazon Web Services accounts or users. 264 */ 265 listSharedProjects(params: CodeBuild.Types.ListSharedProjectsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListSharedProjectsOutput) => void): Request<CodeBuild.Types.ListSharedProjectsOutput, AWSError>; 266 /** 267 * Gets a list of projects that are shared with other Amazon Web Services accounts or users. 268 */ 269 listSharedProjects(callback?: (err: AWSError, data: CodeBuild.Types.ListSharedProjectsOutput) => void): Request<CodeBuild.Types.ListSharedProjectsOutput, AWSError>; 270 /** 271 * Gets a list of report groups that are shared with other Amazon Web Services accounts or users. 272 */ 273 listSharedReportGroups(params: CodeBuild.Types.ListSharedReportGroupsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListSharedReportGroupsOutput) => void): Request<CodeBuild.Types.ListSharedReportGroupsOutput, AWSError>; 274 /** 275 * Gets a list of report groups that are shared with other Amazon Web Services accounts or users. 276 */ 277 listSharedReportGroups(callback?: (err: AWSError, data: CodeBuild.Types.ListSharedReportGroupsOutput) => void): Request<CodeBuild.Types.ListSharedReportGroupsOutput, AWSError>; 278 /** 279 * Returns a list of SourceCredentialsInfo objects. 280 */ 281 listSourceCredentials(params: CodeBuild.Types.ListSourceCredentialsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListSourceCredentialsOutput) => void): Request<CodeBuild.Types.ListSourceCredentialsOutput, AWSError>; 282 /** 283 * Returns a list of SourceCredentialsInfo objects. 284 */ 285 listSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.ListSourceCredentialsOutput) => void): Request<CodeBuild.Types.ListSourceCredentialsOutput, AWSError>; 286 /** 287 * Stores a resource policy for the ARN of a Project or ReportGroup object. 288 */ 289 putResourcePolicy(params: CodeBuild.Types.PutResourcePolicyInput, callback?: (err: AWSError, data: CodeBuild.Types.PutResourcePolicyOutput) => void): Request<CodeBuild.Types.PutResourcePolicyOutput, AWSError>; 290 /** 291 * Stores a resource policy for the ARN of a Project or ReportGroup object. 292 */ 293 putResourcePolicy(callback?: (err: AWSError, data: CodeBuild.Types.PutResourcePolicyOutput) => void): Request<CodeBuild.Types.PutResourcePolicyOutput, AWSError>; 294 /** 295 * Restarts a build. 296 */ 297 retryBuild(params: CodeBuild.Types.RetryBuildInput, callback?: (err: AWSError, data: CodeBuild.Types.RetryBuildOutput) => void): Request<CodeBuild.Types.RetryBuildOutput, AWSError>; 298 /** 299 * Restarts a build. 300 */ 301 retryBuild(callback?: (err: AWSError, data: CodeBuild.Types.RetryBuildOutput) => void): Request<CodeBuild.Types.RetryBuildOutput, AWSError>; 302 /** 303 * Restarts a failed batch build. Only batch builds that have failed can be retried. 304 */ 305 retryBuildBatch(params: CodeBuild.Types.RetryBuildBatchInput, callback?: (err: AWSError, data: CodeBuild.Types.RetryBuildBatchOutput) => void): Request<CodeBuild.Types.RetryBuildBatchOutput, AWSError>; 306 /** 307 * Restarts a failed batch build. Only batch builds that have failed can be retried. 308 */ 309 retryBuildBatch(callback?: (err: AWSError, data: CodeBuild.Types.RetryBuildBatchOutput) => void): Request<CodeBuild.Types.RetryBuildBatchOutput, AWSError>; 310 /** 311 * Starts running a build. 312 */ 313 startBuild(params: CodeBuild.Types.StartBuildInput, callback?: (err: AWSError, data: CodeBuild.Types.StartBuildOutput) => void): Request<CodeBuild.Types.StartBuildOutput, AWSError>; 314 /** 315 * Starts running a build. 316 */ 317 startBuild(callback?: (err: AWSError, data: CodeBuild.Types.StartBuildOutput) => void): Request<CodeBuild.Types.StartBuildOutput, AWSError>; 318 /** 319 * Starts a batch build for a project. 320 */ 321 startBuildBatch(params: CodeBuild.Types.StartBuildBatchInput, callback?: (err: AWSError, data: CodeBuild.Types.StartBuildBatchOutput) => void): Request<CodeBuild.Types.StartBuildBatchOutput, AWSError>; 322 /** 323 * Starts a batch build for a project. 324 */ 325 startBuildBatch(callback?: (err: AWSError, data: CodeBuild.Types.StartBuildBatchOutput) => void): Request<CodeBuild.Types.StartBuildBatchOutput, AWSError>; 326 /** 327 * Attempts to stop running a build. 328 */ 329 stopBuild(params: CodeBuild.Types.StopBuildInput, callback?: (err: AWSError, data: CodeBuild.Types.StopBuildOutput) => void): Request<CodeBuild.Types.StopBuildOutput, AWSError>; 330 /** 331 * Attempts to stop running a build. 332 */ 333 stopBuild(callback?: (err: AWSError, data: CodeBuild.Types.StopBuildOutput) => void): Request<CodeBuild.Types.StopBuildOutput, AWSError>; 334 /** 335 * Stops a running batch build. 336 */ 337 stopBuildBatch(params: CodeBuild.Types.StopBuildBatchInput, callback?: (err: AWSError, data: CodeBuild.Types.StopBuildBatchOutput) => void): Request<CodeBuild.Types.StopBuildBatchOutput, AWSError>; 338 /** 339 * Stops a running batch build. 340 */ 341 stopBuildBatch(callback?: (err: AWSError, data: CodeBuild.Types.StopBuildBatchOutput) => void): Request<CodeBuild.Types.StopBuildBatchOutput, AWSError>; 342 /** 343 * Changes the settings of a build project. 344 */ 345 updateProject(params: CodeBuild.Types.UpdateProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectOutput) => void): Request<CodeBuild.Types.UpdateProjectOutput, AWSError>; 346 /** 347 * Changes the settings of a build project. 348 */ 349 updateProject(callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectOutput) => void): Request<CodeBuild.Types.UpdateProjectOutput, AWSError>; 350 /** 351 * Changes the public visibility for a project. The project's build results, logs, and artifacts are available to the general public. For more information, see Public build projects in the CodeBuild User Guide. The following should be kept in mind when making your projects public: All of a project's build results, logs, and artifacts, including builds that were run when the project was private, are available to the general public. All build logs and artifacts are available to the public. Environment variables, source code, and other sensitive information may have been output to the build logs and artifacts. You must be careful about what information is output to the build logs. Some best practice are: Do not store sensitive values, especially Amazon Web Services access key IDs and secret access keys, in environment variables. We recommend that you use an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store sensitive values. Follow Best practices for using webhooks in the CodeBuild User Guide to limit which entities can trigger a build, and do not store the buildspec in the project itself, to ensure that your webhooks are as secure as possible. A malicious user can use public builds to distribute malicious artifacts. We recommend that you review all pull requests to verify that the pull request is a legitimate change. We also recommend that you validate any artifacts with their checksums to make sure that the correct artifacts are being downloaded. 352 */ 353 updateProjectVisibility(params: CodeBuild.Types.UpdateProjectVisibilityInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectVisibilityOutput) => void): Request<CodeBuild.Types.UpdateProjectVisibilityOutput, AWSError>; 354 /** 355 * Changes the public visibility for a project. The project's build results, logs, and artifacts are available to the general public. For more information, see Public build projects in the CodeBuild User Guide. The following should be kept in mind when making your projects public: All of a project's build results, logs, and artifacts, including builds that were run when the project was private, are available to the general public. All build logs and artifacts are available to the public. Environment variables, source code, and other sensitive information may have been output to the build logs and artifacts. You must be careful about what information is output to the build logs. Some best practice are: Do not store sensitive values, especially Amazon Web Services access key IDs and secret access keys, in environment variables. We recommend that you use an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store sensitive values. Follow Best practices for using webhooks in the CodeBuild User Guide to limit which entities can trigger a build, and do not store the buildspec in the project itself, to ensure that your webhooks are as secure as possible. A malicious user can use public builds to distribute malicious artifacts. We recommend that you review all pull requests to verify that the pull request is a legitimate change. We also recommend that you validate any artifacts with their checksums to make sure that the correct artifacts are being downloaded. 356 */ 357 updateProjectVisibility(callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectVisibilityOutput) => void): Request<CodeBuild.Types.UpdateProjectVisibilityOutput, AWSError>; 358 /** 359 * Updates a report group. 360 */ 361 updateReportGroup(params: CodeBuild.Types.UpdateReportGroupInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateReportGroupOutput) => void): Request<CodeBuild.Types.UpdateReportGroupOutput, AWSError>; 362 /** 363 * Updates a report group. 364 */ 365 updateReportGroup(callback?: (err: AWSError, data: CodeBuild.Types.UpdateReportGroupOutput) => void): Request<CodeBuild.Types.UpdateReportGroupOutput, AWSError>; 366 /** 367 * Updates the webhook associated with an CodeBuild build project. If you use Bitbucket for your repository, rotateSecret is ignored. 368 */ 369 updateWebhook(params: CodeBuild.Types.UpdateWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateWebhookOutput) => void): Request<CodeBuild.Types.UpdateWebhookOutput, AWSError>; 370 /** 371 * Updates the webhook associated with an CodeBuild build project. If you use Bitbucket for your repository, rotateSecret is ignored. 372 */ 373 updateWebhook(callback?: (err: AWSError, data: CodeBuild.Types.UpdateWebhookOutput) => void): Request<CodeBuild.Types.UpdateWebhookOutput, AWSError>; 374 } 375 declare namespace CodeBuild { 376 export type ArtifactNamespace = "NONE"|"BUILD_ID"|string; 377 export type ArtifactPackaging = "NONE"|"ZIP"|string; 378 export type ArtifactsType = "CODEPIPELINE"|"S3"|"NO_ARTIFACTS"|string; 379 export type AuthType = "OAUTH"|"BASIC_AUTH"|"PERSONAL_ACCESS_TOKEN"|string; 380 export interface BatchDeleteBuildsInput { 381 /** 382 * The IDs of the builds to delete. 383 */ 384 ids: BuildIds; 385 } 386 export interface BatchDeleteBuildsOutput { 387 /** 388 * The IDs of the builds that were successfully deleted. 389 */ 390 buildsDeleted?: BuildIds; 391 /** 392 * Information about any builds that could not be successfully deleted. 393 */ 394 buildsNotDeleted?: BuildsNotDeleted; 395 } 396 export interface BatchGetBuildBatchesInput { 397 /** 398 * An array that contains the batch build identifiers to retrieve. 399 */ 400 ids: BuildBatchIds; 401 } 402 export interface BatchGetBuildBatchesOutput { 403 /** 404 * An array of BuildBatch objects that represent the retrieved batch builds. 405 */ 406 buildBatches?: BuildBatches; 407 /** 408 * An array that contains the identifiers of any batch builds that are not found. 409 */ 410 buildBatchesNotFound?: BuildBatchIds; 411 } 412 export interface BatchGetBuildsInput { 413 /** 414 * The IDs of the builds. 415 */ 416 ids: BuildIds; 417 } 418 export interface BatchGetBuildsOutput { 419 /** 420 * Information about the requested builds. 421 */ 422 builds?: Builds; 423 /** 424 * The IDs of builds for which information could not be found. 425 */ 426 buildsNotFound?: BuildIds; 427 } 428 export interface BatchGetProjectsInput { 429 /** 430 * The names or ARNs of the build projects. To get information about a project shared with your Amazon Web Services account, its ARN must be specified. You cannot specify a shared project using its name. 431 */ 432 names: ProjectNames; 433 } 434 export interface BatchGetProjectsOutput { 435 /** 436 * Information about the requested build projects. 437 */ 438 projects?: Projects; 439 /** 440 * The names of build projects for which information could not be found. 441 */ 442 projectsNotFound?: ProjectNames; 443 } 444 export interface BatchGetReportGroupsInput { 445 /** 446 * An array of report group ARNs that identify the report groups to return. 447 */ 448 reportGroupArns: ReportGroupArns; 449 } 450 export interface BatchGetReportGroupsOutput { 451 /** 452 * The array of report groups returned by BatchGetReportGroups. 453 */ 454 reportGroups?: ReportGroups; 455 /** 456 * An array of ARNs passed to BatchGetReportGroups that are not associated with a ReportGroup. 457 */ 458 reportGroupsNotFound?: ReportGroupArns; 459 } 460 export interface BatchGetReportsInput { 461 /** 462 * An array of ARNs that identify the Report objects to return. 463 */ 464 reportArns: ReportArns; 465 } 466 export interface BatchGetReportsOutput { 467 /** 468 * The array of Report objects returned by BatchGetReports. 469 */ 470 reports?: Reports; 471 /** 472 * An array of ARNs passed to BatchGetReportGroups that are not associated with a Report. 473 */ 474 reportsNotFound?: ReportArns; 475 } 476 export interface BatchRestrictions { 477 /** 478 * Specifies the maximum number of builds allowed. 479 */ 480 maximumBuildsAllowed?: WrapperInt; 481 /** 482 * An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the CodeBuild User Guide for these values. 483 */ 484 computeTypesAllowed?: ComputeTypesAllowed; 485 } 486 export type Boolean = boolean; 487 export type BucketOwnerAccess = "NONE"|"READ_ONLY"|"FULL"|string; 488 export interface Build { 489 /** 490 * The unique ID for the build. 491 */ 492 id?: NonEmptyString; 493 /** 494 * The Amazon Resource Name (ARN) of the build. 495 */ 496 arn?: NonEmptyString; 497 /** 498 * 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. 499 */ 500 buildNumber?: WrapperLong; 501 /** 502 * When the build process started, expressed in Unix time format. 503 */ 504 startTime?: Timestamp; 505 /** 506 * When the build process ended, expressed in Unix time format. 507 */ 508 endTime?: Timestamp; 509 /** 510 * The current build phase. 511 */ 512 currentPhase?: String; 513 /** 514 * 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. 515 */ 516 buildStatus?: StatusType; 517 /** 518 * 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 CodeBuild User Guide. 519 */ 520 sourceVersion?: NonEmptyString; 521 /** 522 * An identifier for the version of this build's source code. For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. For CodePipeline, the source revision provided by CodePipeline. For Amazon S3, this does not apply. 523 */ 524 resolvedSourceVersion?: NonEmptyString; 525 /** 526 * The name of the CodeBuild project. 527 */ 528 projectName?: NonEmptyString; 529 /** 530 * Information about all previous build phases that are complete and information about any current build phase that is not yet complete. 531 */ 532 phases?: BuildPhases; 533 /** 534 * Information about the source code to be built. 535 */ 536 source?: ProjectSource; 537 /** 538 * An array of ProjectSource objects. 539 */ 540 secondarySources?: ProjectSources; 541 /** 542 * An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of: For 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 S3: the version ID of the object that represents the build input ZIP file to use. 543 */ 544 secondarySourceVersions?: ProjectSecondarySourceVersions; 545 /** 546 * Information about the output artifacts for the build. 547 */ 548 artifacts?: BuildArtifacts; 549 /** 550 * An array of ProjectArtifacts objects. 551 */ 552 secondaryArtifacts?: BuildArtifactsList; 553 /** 554 * Information about the cache for the build. 555 */ 556 cache?: ProjectCache; 557 /** 558 * Information about the build environment for this build. 559 */ 560 environment?: ProjectEnvironment; 561 /** 562 * The name of a service role used for this build. 563 */ 564 serviceRole?: NonEmptyString; 565 /** 566 * Information about the build's logs in CloudWatch Logs. 567 */ 568 logs?: LogsLocation; 569 /** 570 * How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed. 571 */ 572 timeoutInMinutes?: WrapperInt; 573 /** 574 * The number of minutes a build is allowed to be queued before it times out. 575 */ 576 queuedTimeoutInMinutes?: WrapperInt; 577 /** 578 * Whether the build is complete. True if complete; otherwise, false. 579 */ 580 buildComplete?: Boolean; 581 /** 582 * The entity that started the build. Valid values include: If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline). If an IAM user started the build, the user's name (for example, MyUserName). If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin. 583 */ 584 initiator?: String; 585 /** 586 * If your 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. 587 */ 588 vpcConfig?: VpcConfig; 589 /** 590 * Describes a network interface. 591 */ 592 networkInterface?: NetworkInterface; 593 /** 594 * The Key Management Service 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>). 595 */ 596 encryptionKey?: NonEmptyString; 597 /** 598 * A list of exported environment variables for this build. Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide. 599 */ 600 exportedEnvironmentVariables?: ExportedEnvironmentVariables; 601 /** 602 * An array of the ARNs associated with this build's reports. 603 */ 604 reportArns?: BuildReportArns; 605 /** 606 * 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. 607 */ 608 fileSystemLocations?: ProjectFileSystemLocations; 609 /** 610 * Contains information about the debug session for this build. 611 */ 612 debugSession?: DebugSession; 613 /** 614 * The ARN of the batch build that this build is a member of, if applicable. 615 */ 616 buildBatchArn?: String; 617 } 618 export interface BuildArtifacts { 619 /** 620 * Information about the location of the build artifacts. 621 */ 622 location?: String; 623 /** 624 * 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. 625 */ 626 sha256sum?: String; 627 /** 628 * 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. 629 */ 630 md5sum?: String; 631 /** 632 * 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. 633 */ 634 overrideArtifactName?: WrapperBoolean; 635 /** 636 * Information that tells you if encryption for build artifacts is disabled. 637 */ 638 encryptionDisabled?: WrapperBoolean; 639 /** 640 * An identifier for this artifact definition. 641 */ 642 artifactIdentifier?: String; 643 bucketOwnerAccess?: BucketOwnerAccess; 644 } 645 export type BuildArtifactsList = BuildArtifacts[]; 646 export interface BuildBatch { 647 /** 648 * The identifier of the batch build. 649 */ 650 id?: NonEmptyString; 651 /** 652 * The ARN of the batch build. 653 */ 654 arn?: NonEmptyString; 655 /** 656 * The date and time that the batch build started. 657 */ 658 startTime?: Timestamp; 659 /** 660 * The date and time that the batch build ended. 661 */ 662 endTime?: Timestamp; 663 /** 664 * The current phase of the batch build. 665 */ 666 currentPhase?: String; 667 /** 668 * The status of the batch build. 669 */ 670 buildBatchStatus?: StatusType; 671 /** 672 * The identifier of the version of the source code to be built. 673 */ 674 sourceVersion?: NonEmptyString; 675 /** 676 * The identifier of the resolved version of this batch build's source code. For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. For CodePipeline, the source revision provided by CodePipeline. For Amazon S3, this does not apply. 677 */ 678 resolvedSourceVersion?: NonEmptyString; 679 /** 680 * The name of the batch build project. 681 */ 682 projectName?: NonEmptyString; 683 /** 684 * An array of BuildBatchPhase objects the specify the phases of the batch build. 685 */ 686 phases?: BuildBatchPhases; 687 source?: ProjectSource; 688 /** 689 * An array of ProjectSource objects that define the sources for the batch build. 690 */ 691 secondarySources?: ProjectSources; 692 /** 693 * An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of: For 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 S3: the version ID of the object that represents the build input ZIP file to use. 694 */ 695 secondarySourceVersions?: ProjectSecondarySourceVersions; 696 /** 697 * A BuildArtifacts object the defines the build artifacts for this batch build. 698 */ 699 artifacts?: BuildArtifacts; 700 /** 701 * An array of BuildArtifacts objects the define the build artifacts for this batch build. 702 */ 703 secondaryArtifacts?: BuildArtifactsList; 704 cache?: ProjectCache; 705 environment?: ProjectEnvironment; 706 /** 707 * The name of a service role used for builds in the batch. 708 */ 709 serviceRole?: NonEmptyString; 710 logConfig?: LogsConfig; 711 /** 712 * Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in. 713 */ 714 buildTimeoutInMinutes?: WrapperInt; 715 /** 716 * Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out. 717 */ 718 queuedTimeoutInMinutes?: WrapperInt; 719 /** 720 * Indicates if the batch build is complete. 721 */ 722 complete?: Boolean; 723 /** 724 * The entity that started the batch build. Valid values include: If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline). If an IAM user started the build, the user's name. If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin. 725 */ 726 initiator?: String; 727 vpcConfig?: VpcConfig; 728 /** 729 * The Key Management Service 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>). 730 */ 731 encryptionKey?: NonEmptyString; 732 /** 733 * 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. 734 */ 735 buildBatchNumber?: WrapperLong; 736 /** 737 * 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. 738 */ 739 fileSystemLocations?: ProjectFileSystemLocations; 740 buildBatchConfig?: ProjectBuildBatchConfig; 741 /** 742 * An array of BuildGroup objects that define the build groups for the batch build. 743 */ 744 buildGroups?: BuildGroups; 745 /** 746 * Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds. 747 */ 748 debugSessionEnabled?: WrapperBoolean; 749 } 750 export interface BuildBatchFilter { 751 /** 752 * The status of the batch builds to retrieve. Only batch builds that have this status will be retrieved. 753 */ 754 status?: StatusType; 755 } 756 export type BuildBatchIds = NonEmptyString[]; 757 export interface BuildBatchPhase { 758 /** 759 * The name of the batch build phase. Valid values include: COMBINE_ARTIFACTS Build output artifacts are being combined and uploaded to the output location. DOWNLOAD_BATCHSPEC The batch build specification is being downloaded. FAILED One or more of the builds failed. IN_PROGRESS The batch build is in progress. STOPPED The batch build was stopped. SUBMITTED The btach build has been submitted. SUCCEEDED The batch build succeeded. 760 */ 761 phaseType?: BuildBatchPhaseType; 762 /** 763 * The current status of the batch build phase. Valid values include: FAILED The build phase failed. FAULT The build phase faulted. IN_PROGRESS The build phase is still in progress. STOPPED The build phase stopped. SUCCEEDED The build phase succeeded. TIMED_OUT The build phase timed out. 764 */ 765 phaseStatus?: StatusType; 766 /** 767 * When the batch build phase started, expressed in Unix time format. 768 */ 769 startTime?: Timestamp; 770 /** 771 * When the batch build phase ended, expressed in Unix time format. 772 */ 773 endTime?: Timestamp; 774 /** 775 * How long, in seconds, between the starting and ending times of the batch build's phase. 776 */ 777 durationInSeconds?: WrapperLong; 778 /** 779 * Additional information about the batch build phase. Especially to help troubleshoot a failed batch build. 780 */ 781 contexts?: PhaseContexts; 782 } 783 export type BuildBatchPhaseType = "SUBMITTED"|"DOWNLOAD_BATCHSPEC"|"IN_PROGRESS"|"COMBINE_ARTIFACTS"|"SUCCEEDED"|"FAILED"|"STOPPED"|string; 784 export type BuildBatchPhases = BuildBatchPhase[]; 785 export type BuildBatches = BuildBatch[]; 786 export interface BuildGroup { 787 /** 788 * Contains the identifier of the build group. 789 */ 790 identifier?: String; 791 /** 792 * An array of strings that contain the identifiers of the build groups that this build group depends on. 793 */ 794 dependsOn?: Identifiers; 795 /** 796 * Specifies if failures in this build group can be ignored. 797 */ 798 ignoreFailure?: Boolean; 799 /** 800 * A BuildSummary object that contains a summary of the current build group. 801 */ 802 currentBuildSummary?: BuildSummary; 803 /** 804 * An array of BuildSummary objects that contain summaries of previous build groups. 805 */ 806 priorBuildSummaryList?: BuildSummaries; 807 } 808 export type BuildGroups = BuildGroup[]; 809 export type BuildIds = NonEmptyString[]; 810 export interface BuildNotDeleted { 811 /** 812 * The ID of the build that could not be successfully deleted. 813 */ 814 id?: NonEmptyString; 815 /** 816 * Additional information about the build that could not be successfully deleted. 817 */ 818 statusCode?: String; 819 } 820 export interface BuildPhase { 821 /** 822 * 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. 823 */ 824 phaseType?: BuildPhaseType; 825 /** 826 * The current status of the build phase. Valid values include: FAILED The build phase failed. FAULT The build phase faulted. IN_PROGRESS The build phase is still in progress. STOPPED The build phase stopped. SUCCEEDED The build phase succeeded. TIMED_OUT The build phase timed out. 827 */ 828 phaseStatus?: StatusType; 829 /** 830 * When the build phase started, expressed in Unix time format. 831 */ 832 startTime?: Timestamp; 833 /** 834 * When the build phase ended, expressed in Unix time format. 835 */ 836 endTime?: Timestamp; 837 /** 838 * How long, in seconds, between the starting and ending times of the build's phase. 839 */ 840 durationInSeconds?: WrapperLong; 841 /** 842 * Additional information about a build phase, especially to help troubleshoot a failed build. 843 */ 844 contexts?: PhaseContexts; 845 } 846 export type BuildPhaseType = "SUBMITTED"|"QUEUED"|"PROVISIONING"|"DOWNLOAD_SOURCE"|"INSTALL"|"PRE_BUILD"|"BUILD"|"POST_BUILD"|"UPLOAD_ARTIFACTS"|"FINALIZING"|"COMPLETED"|string; 847 export type BuildPhases = BuildPhase[]; 848 export type BuildReportArns = String[]; 849 export interface BuildStatusConfig { 850 /** 851 * Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider. Bitbucket This parameter is used for the name parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. GitHub/GitHub Enterprise Server 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. 852 */ 853 context?: String; 854 /** 855 * Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider. Bitbucket This parameter is used for the url parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. GitHub/GitHub Enterprise Server 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. 856 */ 857 targetUrl?: String; 858 } 859 export type BuildSummaries = BuildSummary[]; 860 export interface BuildSummary { 861 /** 862 * The batch build ARN. 863 */ 864 arn?: String; 865 /** 866 * When the build was started, expressed in Unix time format. 867 */ 868 requestedOn?: Timestamp; 869 /** 870 * The status of the build group. FAILED The build group failed. FAULT The build group faulted. IN_PROGRESS The build group is still in progress. STOPPED The build group stopped. SUCCEEDED The build group succeeded. TIMED_OUT The build group timed out. 871 */ 872 buildStatus?: StatusType; 873 /** 874 * A ResolvedArtifact object that represents the primary build artifacts for the build group. 875 */ 876 primaryArtifact?: ResolvedArtifact; 877 /** 878 * An array of ResolvedArtifact objects that represents the secondary build artifacts for the build group. 879 */ 880 secondaryArtifacts?: ResolvedSecondaryArtifacts; 881 } 882 export type Builds = Build[]; 883 export type BuildsNotDeleted = BuildNotDeleted[]; 884 export type CacheMode = "LOCAL_DOCKER_LAYER_CACHE"|"LOCAL_SOURCE_CACHE"|"LOCAL_CUSTOM_CACHE"|string; 885 export type CacheType = "NO_CACHE"|"S3"|"LOCAL"|string; 886 export interface CloudWatchLogsConfig { 887 /** 888 * The current status of the logs in CloudWatch Logs for a build project. Valid values are: ENABLED: CloudWatch Logs are enabled for this build project. DISABLED: CloudWatch Logs are not enabled for this build project. 889 */ 890 status: LogsConfigStatusType; 891 /** 892 * The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams. 893 */ 894 groupName?: String; 895 /** 896 * The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams. 897 */ 898 streamName?: String; 899 } 900 export interface CodeCoverage { 901 /** 902 * The identifier of the code coverage report. 903 */ 904 id?: NonEmptyString; 905 /** 906 * The ARN of the report. 907 */ 908 reportARN?: NonEmptyString; 909 /** 910 * The path of the test report file. 911 */ 912 filePath?: NonEmptyString; 913 /** 914 * The percentage of lines that are covered by your tests. 915 */ 916 lineCoveragePercentage?: Percentage; 917 /** 918 * The number of lines that are covered by your tests. 919 */ 920 linesCovered?: NonNegativeInt; 921 /** 922 * The number of lines that are not covered by your tests. 923 */ 924 linesMissed?: NonNegativeInt; 925 /** 926 * The percentage of branches that are covered by your tests. 927 */ 928 branchCoveragePercentage?: Percentage; 929 /** 930 * The number of conditional branches that are covered by your tests. 931 */ 932 branchesCovered?: NonNegativeInt; 933 /** 934 * The number of conditional branches that are not covered by your tests. 935 */ 936 branchesMissed?: NonNegativeInt; 937 /** 938 * The date and time that the tests were run. 939 */ 940 expired?: Timestamp; 941 } 942 export interface CodeCoverageReportSummary { 943 /** 944 * The percentage of lines that are covered by your tests. 945 */ 946 lineCoveragePercentage?: Percentage; 947 /** 948 * The number of lines that are covered by your tests. 949 */ 950 linesCovered?: NonNegativeInt; 951 /** 952 * The number of lines that are not covered by your tests. 953 */ 954 linesMissed?: NonNegativeInt; 955 /** 956 * The percentage of branches that are covered by your tests. 957 */ 958 branchCoveragePercentage?: Percentage; 959 /** 960 * The number of conditional branches that are covered by your tests. 961 */ 962 branchesCovered?: NonNegativeInt; 963 /** 964 * The number of conditional branches that are not covered by your tests. 965 */ 966 branchesMissed?: NonNegativeInt; 967 } 968 export type CodeCoverages = CodeCoverage[]; 969 export type ComputeType = "BUILD_GENERAL1_SMALL"|"BUILD_GENERAL1_MEDIUM"|"BUILD_GENERAL1_LARGE"|"BUILD_GENERAL1_2XLARGE"|string; 970 export type ComputeTypesAllowed = NonEmptyString[]; 971 export interface CreateProjectInput { 972 /** 973 * The name of the build project. 974 */ 975 name: ProjectName; 976 /** 977 * A description that makes the build project easy to identify. 978 */ 979 description?: ProjectDescription; 980 /** 981 * Information about the build input source code for the build project. 982 */ 983 source: ProjectSource; 984 /** 985 * An array of ProjectSource objects. 986 */ 987 secondarySources?: ProjectSources; 988 /** 989 * 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 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 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 CodeBuild User Guide. 990 */ 991 sourceVersion?: String; 992 /** 993 * An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take precedence over these secondarySourceVersions (at the project level). 994 */ 995 secondarySourceVersions?: ProjectSecondarySourceVersions; 996 /** 997 * Information about the build output artifacts for the build project. 998 */ 999 artifacts: ProjectArtifacts; 1000 /** 1001 * An array of ProjectArtifacts objects. 1002 */ 1003 secondaryArtifacts?: ProjectArtifactsList; 1004 /** 1005 * Stores recently used information so that it can be quickly accessed at a later time. 1006 */ 1007 cache?: ProjectCache; 1008 /** 1009 * Information about the build environment for the build project. 1010 */ 1011 environment: ProjectEnvironment; 1012 /** 1013 * The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account. 1014 */ 1015 serviceRole: NonEmptyString; 1016 /** 1017 * How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes. 1018 */ 1019 timeoutInMinutes?: TimeOut; 1020 /** 1021 * The number of minutes a build is allowed to be queued before it times out. 1022 */ 1023 queuedTimeoutInMinutes?: TimeOut; 1024 /** 1025 * The Key Management Service 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>). 1026 */ 1027 encryptionKey?: NonEmptyString; 1028 /** 1029 * A list of tag key and value pairs associated with this build project. These tags are available for use by Amazon Web Services services that support CodeBuild build project tags. 1030 */ 1031 tags?: TagList; 1032 /** 1033 * VpcConfig enables CodeBuild to access resources in an Amazon VPC. 1034 */ 1035 vpcConfig?: VpcConfig; 1036 /** 1037 * Set this to true to generate a publicly accessible URL for your project's build badge. 1038 */ 1039 badgeEnabled?: WrapperBoolean; 1040 /** 1041 * Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified S3 bucket, or both. 1042 */ 1043 logsConfig?: LogsConfig; 1044 /** 1045 * 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. 1046 */ 1047 fileSystemLocations?: ProjectFileSystemLocations; 1048 /** 1049 * A ProjectBuildBatchConfig object that defines the batch build options for the project. 1050 */ 1051 buildBatchConfig?: ProjectBuildBatchConfig; 1052 /** 1053 * The maximum number of concurrent builds that are allowed for this project. New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run. 1054 */ 1055 concurrentBuildLimit?: WrapperInt; 1056 } 1057 export interface CreateProjectOutput { 1058 /** 1059 * Information about the build project that was created. 1060 */ 1061 project?: Project; 1062 } 1063 export interface CreateReportGroupInput { 1064 /** 1065 * The name of the report group. 1066 */ 1067 name: ReportGroupName; 1068 /** 1069 * The type of report group. 1070 */ 1071 type: ReportType; 1072 /** 1073 * A ReportExportConfig object that contains information about where the report group test results are exported. 1074 */ 1075 exportConfig: ReportExportConfig; 1076 /** 1077 * A list of tag key and value pairs associated with this report group. These tags are available for use by Amazon Web Services services that support CodeBuild report group tags. 1078 */ 1079 tags?: TagList; 1080 } 1081 export interface CreateReportGroupOutput { 1082 /** 1083 * Information about the report group that was created. 1084 */ 1085 reportGroup?: ReportGroup; 1086 } 1087 export interface CreateWebhookInput { 1088 /** 1089 * The name of the CodeBuild project. 1090 */ 1091 projectName: ProjectName; 1092 /** 1093 * 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. 1094 */ 1095 branchFilter?: String; 1096 /** 1097 * 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. 1098 */ 1099 filterGroups?: FilterGroups; 1100 /** 1101 * Specifies the type of build this webhook will trigger. 1102 */ 1103 buildType?: WebhookBuildType; 1104 } 1105 export interface CreateWebhookOutput { 1106 /** 1107 * Information about a webhook that connects repository events to a build project in CodeBuild. 1108 */ 1109 webhook?: Webhook; 1110 } 1111 export type CredentialProviderType = "SECRETS_MANAGER"|string; 1112 export interface DebugSession { 1113 /** 1114 * Specifies if session debugging is enabled for this build. 1115 */ 1116 sessionEnabled?: WrapperBoolean; 1117 /** 1118 * 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. 1119 */ 1120 sessionTarget?: NonEmptyString; 1121 } 1122 export interface DeleteBuildBatchInput { 1123 /** 1124 * The identifier of the batch build to delete. 1125 */ 1126 id: NonEmptyString; 1127 } 1128 export interface DeleteBuildBatchOutput { 1129 /** 1130 * The status code. 1131 */ 1132 statusCode?: String; 1133 /** 1134 * An array of strings that contain the identifiers of the builds that were deleted. 1135 */ 1136 buildsDeleted?: BuildIds; 1137 /** 1138 * An array of BuildNotDeleted objects that specify the builds that could not be deleted. 1139 */ 1140 buildsNotDeleted?: BuildsNotDeleted; 1141 } 1142 export interface DeleteProjectInput { 1143 /** 1144 * The name of the build project. 1145 */ 1146 name: NonEmptyString; 1147 } 1148 export interface DeleteProjectOutput { 1149 } 1150 export interface DeleteReportGroupInput { 1151 /** 1152 * The ARN of the report group to delete. 1153 */ 1154 arn: NonEmptyString; 1155 /** 1156 * If true, deletes any reports that belong to a report group before deleting the report group. If false, you must delete any reports in the report group. 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. 1157 */ 1158 deleteReports?: Boolean; 1159 } 1160 export interface DeleteReportGroupOutput { 1161 } 1162 export interface DeleteReportInput { 1163 /** 1164 * The ARN of the report to delete. 1165 */ 1166 arn: NonEmptyString; 1167 } 1168 export interface DeleteReportOutput { 1169 } 1170 export interface DeleteResourcePolicyInput { 1171 /** 1172 * The ARN of the resource that is associated with the resource policy. 1173 */ 1174 resourceArn: NonEmptyString; 1175 } 1176 export interface DeleteResourcePolicyOutput { 1177 } 1178 export interface DeleteSourceCredentialsInput { 1179 /** 1180 * The Amazon Resource Name (ARN) of the token. 1181 */ 1182 arn: NonEmptyString; 1183 } 1184 export interface DeleteSourceCredentialsOutput { 1185 /** 1186 * The Amazon Resource Name (ARN) of the token. 1187 */ 1188 arn?: NonEmptyString; 1189 } 1190 export interface DeleteWebhookInput { 1191 /** 1192 * The name of the CodeBuild project. 1193 */ 1194 projectName: ProjectName; 1195 } 1196 export interface DeleteWebhookOutput { 1197 } 1198 export interface DescribeCodeCoveragesInput { 1199 /** 1200 * The ARN of the report for which test cases are returned. 1201 */ 1202 reportArn: NonEmptyString; 1203 /** 1204 * 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. 1205 */ 1206 nextToken?: String; 1207 /** 1208 * The maximum number of results to return. 1209 */ 1210 maxResults?: PageSize; 1211 /** 1212 * Specifies if the results are sorted in ascending or descending order. 1213 */ 1214 sortOrder?: SortOrderType; 1215 /** 1216 * Specifies how the results are sorted. Possible values are: FILE_PATH The results are sorted by file path. LINE_COVERAGE_PERCENTAGE The results are sorted by the percentage of lines that are covered. 1217 */ 1218 sortBy?: ReportCodeCoverageSortByType; 1219 /** 1220 * The minimum line coverage percentage to report. 1221 */ 1222 minLineCoveragePercentage?: Percentage; 1223 /** 1224 * The maximum line coverage percentage to report. 1225 */ 1226 maxLineCoveragePercentage?: Percentage; 1227 } 1228 export interface DescribeCodeCoveragesOutput { 1229 /** 1230 * 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. 1231 */ 1232 nextToken?: String; 1233 /** 1234 * An array of CodeCoverage objects that contain the results. 1235 */ 1236 codeCoverages?: CodeCoverages; 1237 } 1238 export interface DescribeTestCasesInput { 1239 /** 1240 * The ARN of the report for which test cases are returned. 1241 */ 1242 reportArn: String; 1243 /** 1244 * 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. 1245 */ 1246 nextToken?: String; 1247 /** 1248 * 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. 1249 */ 1250 maxResults?: PageSize; 1251 /** 1252 * A TestCaseFilter object used to filter the returned reports. 1253 */ 1254 filter?: TestCaseFilter; 1255 } 1256 export interface DescribeTestCasesOutput { 1257 /** 1258 * 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. 1259 */ 1260 nextToken?: String; 1261 /** 1262 * The returned list of test cases. 1263 */ 1264 testCases?: TestCases; 1265 } 1266 export interface EnvironmentImage { 1267 /** 1268 * The name of the Docker image. 1269 */ 1270 name?: String; 1271 /** 1272 * The description of the Docker image. 1273 */ 1274 description?: String; 1275 /** 1276 * A list of environment image versions. 1277 */ 1278 versions?: ImageVersions; 1279 } 1280 export type EnvironmentImages = EnvironmentImage[]; 1281 export interface EnvironmentLanguage { 1282 /** 1283 * The programming language for the Docker images. 1284 */ 1285 language?: LanguageType; 1286 /** 1287 * The list of Docker images that are related by the specified programming language. 1288 */ 1289 images?: EnvironmentImages; 1290 } 1291 export type EnvironmentLanguages = EnvironmentLanguage[]; 1292 export interface EnvironmentPlatform { 1293 /** 1294 * The platform's name. 1295 */ 1296 platform?: PlatformType; 1297 /** 1298 * The list of programming languages that are available for the specified platform. 1299 */ 1300 languages?: EnvironmentLanguages; 1301 } 1302 export type EnvironmentPlatforms = EnvironmentPlatform[]; 1303 export type EnvironmentType = "WINDOWS_CONTAINER"|"LINUX_CONTAINER"|"LINUX_GPU_CONTAINER"|"ARM_CONTAINER"|"WINDOWS_SERVER_2019_CONTAINER"|string; 1304 export interface EnvironmentVariable { 1305 /** 1306 * The name or key of the environment variable. 1307 */ 1308 name: NonEmptyString; 1309 /** 1310 * The value of the environment variable. We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER. 1311 */ 1312 value: String; 1313 /** 1314 * The type of environment variable. Valid values include: PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the CodeBuild User Guide. PLAINTEXT: An environment variable in plain text format. This is the default value. SECRETS_MANAGER: An environment variable stored in Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the CodeBuild User Guide. 1315 */ 1316 type?: EnvironmentVariableType; 1317 } 1318 export type EnvironmentVariableType = "PLAINTEXT"|"PARAMETER_STORE"|"SECRETS_MANAGER"|string; 1319 export type EnvironmentVariables = EnvironmentVariable[]; 1320 export interface ExportedEnvironmentVariable { 1321 /** 1322 * The name of the exported environment variable. 1323 */ 1324 name?: NonEmptyString; 1325 /** 1326 * The value assigned to the exported environment variable. 1327 */ 1328 value?: String; 1329 } 1330 export type ExportedEnvironmentVariables = ExportedEnvironmentVariable[]; 1331 export type FileSystemType = "EFS"|string; 1332 export type FilterGroup = WebhookFilter[]; 1333 export type FilterGroups = FilterGroup[]; 1334 export interface GetReportGroupTrendInput { 1335 /** 1336 * The ARN of the report group that contains the reports to analyze. 1337 */ 1338 reportGroupArn: NonEmptyString; 1339 /** 1340 * The number of reports to analyze. This operation always retrieves the most recent reports. If this parameter is omitted, the most recent 100 reports are analyzed. 1341 */ 1342 numOfReports?: PageSize; 1343 /** 1344 * The test report value to accumulate. This must be one of the following values: Test reports: DURATION Accumulate the test run times for the specified reports. PASS_RATE Accumulate the percentage of tests that passed for the specified test reports. TOTAL Accumulate the total number of tests for the specified test reports. Code coverage reports: BRANCH_COVERAGE Accumulate the branch coverage percentages for the specified test reports. BRANCHES_COVERED Accumulate the branches covered values for the specified test reports. BRANCHES_MISSED Accumulate the branches missed values for the specified test reports. LINE_COVERAGE Accumulate the line coverage percentages for the specified test reports. LINES_COVERED Accumulate the lines covered values for the specified test reports. LINES_MISSED Accumulate the lines not covered values for the specified test reports. 1345 */ 1346 trendField: ReportGroupTrendFieldType; 1347 } 1348 export interface GetReportGroupTrendOutput { 1349 /** 1350 * Contains the accumulated trend data. 1351 */ 1352 stats?: ReportGroupTrendStats; 1353 /** 1354 * An array that contains the raw data for each report. 1355 */ 1356 rawData?: ReportGroupTrendRawDataList; 1357 } 1358 export interface GetResourcePolicyInput { 1359 /** 1360 * The ARN of the resource that is associated with the resource policy. 1361 */ 1362 resourceArn: NonEmptyString; 1363 } 1364 export interface GetResourcePolicyOutput { 1365 /** 1366 * The resource policy for the resource identified by the input ARN parameter. 1367 */ 1368 policy?: NonEmptyString; 1369 } 1370 export type GitCloneDepth = number; 1371 export interface GitSubmodulesConfig { 1372 /** 1373 * Set to true to fetch Git submodules for your CodeBuild build project. 1374 */ 1375 fetchSubmodules: WrapperBoolean; 1376 } 1377 export type Identifiers = NonEmptyString[]; 1378 export type ImagePullCredentialsType = "CODEBUILD"|"SERVICE_ROLE"|string; 1379 export type ImageVersions = String[]; 1380 export interface ImportSourceCredentialsInput { 1381 /** 1382 * The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections. 1383 */ 1384 username?: NonEmptyString; 1385 /** 1386 * For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password. 1387 */ 1388 token: SensitiveNonEmptyString; 1389 /** 1390 * The source provider used for this project. 1391 */ 1392 serverType: ServerType; 1393 /** 1394 * 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 CodeBuild console. 1395 */ 1396 authType: AuthType; 1397 /** 1398 * Set to false to prevent overwriting the repository source credentials. Set to true to overwrite the repository source credentials. The default value is true. 1399 */ 1400 shouldOverwrite?: WrapperBoolean; 1401 } 1402 export interface ImportSourceCredentialsOutput { 1403 /** 1404 * The Amazon Resource Name (ARN) of the token. 1405 */ 1406 arn?: NonEmptyString; 1407 } 1408 export interface InvalidateProjectCacheInput { 1409 /** 1410 * The name of the CodeBuild build project that the cache is reset for. 1411 */ 1412 projectName: NonEmptyString; 1413 } 1414 export interface InvalidateProjectCacheOutput { 1415 } 1416 export type KeyInput = string; 1417 export type LanguageType = "JAVA"|"PYTHON"|"NODE_JS"|"RUBY"|"GOLANG"|"DOCKER"|"ANDROID"|"DOTNET"|"BASE"|"PHP"|string; 1418 export interface ListBuildBatchesForProjectInput { 1419 /** 1420 * The name of the project. 1421 */ 1422 projectName?: NonEmptyString; 1423 /** 1424 * A BuildBatchFilter object that specifies the filters for the search. 1425 */ 1426 filter?: BuildBatchFilter; 1427 /** 1428 * The maximum number of results to return. 1429 */ 1430 maxResults?: PageSize; 1431 /** 1432 * 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. 1433 */ 1434 sortOrder?: SortOrderType; 1435 /** 1436 * 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. 1437 */ 1438 nextToken?: String; 1439 } 1440 export interface ListBuildBatchesForProjectOutput { 1441 /** 1442 * An array of strings that contains the batch build identifiers. 1443 */ 1444 ids?: BuildBatchIds; 1445 /** 1446 * 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. 1447 */ 1448 nextToken?: String; 1449 } 1450 export interface ListBuildBatchesInput { 1451 /** 1452 * A BuildBatchFilter object that specifies the filters for the search. 1453 */ 1454 filter?: BuildBatchFilter; 1455 /** 1456 * The maximum number of results to return. 1457 */ 1458 maxResults?: PageSize; 1459 /** 1460 * 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. 1461 */ 1462 sortOrder?: SortOrderType; 1463 /** 1464 * 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. 1465 */ 1466 nextToken?: String; 1467 } 1468 export interface ListBuildBatchesOutput { 1469 /** 1470 * An array of strings that contains the batch build identifiers. 1471 */ 1472 ids?: BuildBatchIds; 1473 /** 1474 * 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. 1475 */ 1476 nextToken?: String; 1477 } 1478 export interface ListBuildsForProjectInput { 1479 /** 1480 * The name of the CodeBuild project. 1481 */ 1482 projectName: NonEmptyString; 1483 /** 1484 * The order to list results in. The results are sorted by build number, not the build identifier. 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. If the project has more than 100 builds, setting the sort order will result in an error. 1485 */ 1486 sortOrder?: SortOrderType; 1487 /** 1488 * 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. 1489 */ 1490 nextToken?: String; 1491 } 1492 export interface ListBuildsForProjectOutput { 1493 /** 1494 * A list of build IDs for the specified build project, with each build ID representing a single build. 1495 */ 1496 ids?: BuildIds; 1497 /** 1498 * 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. 1499 */ 1500 nextToken?: String; 1501 } 1502 export interface ListBuildsInput { 1503 /** 1504 * 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. 1505 */ 1506 sortOrder?: SortOrderType; 1507 /** 1508 * 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. 1509 */ 1510 nextToken?: String; 1511 } 1512 export interface ListBuildsOutput { 1513 /** 1514 * A list of build IDs, with each build ID representing a single build. 1515 */ 1516 ids?: BuildIds; 1517 /** 1518 * 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. 1519 */ 1520 nextToken?: String; 1521 } 1522 export interface ListCuratedEnvironmentImagesInput { 1523 } 1524 export interface ListCuratedEnvironmentImagesOutput { 1525 /** 1526 * Information about supported platforms for Docker images that are managed by CodeBuild. 1527 */ 1528 platforms?: EnvironmentPlatforms; 1529 } 1530 export interface ListProjectsInput { 1531 /** 1532 * 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. 1533 */ 1534 sortBy?: ProjectSortByType; 1535 /** 1536 * 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. 1537 */ 1538 sortOrder?: SortOrderType; 1539 /** 1540 * 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. 1541 */ 1542 nextToken?: NonEmptyString; 1543 } 1544 export interface ListProjectsOutput { 1545 /** 1546 * 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. 1547 */ 1548 nextToken?: String; 1549 /** 1550 * The list of build project names, with each build project name representing a single build project. 1551 */ 1552 projects?: ProjectNames; 1553 } 1554 export interface ListReportGroupsInput { 1555 /** 1556 * Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING. 1557 */ 1558 sortOrder?: SortOrderType; 1559 /** 1560 * 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. 1561 */ 1562 sortBy?: ReportGroupSortByType; 1563 /** 1564 * 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. 1565 */ 1566 nextToken?: String; 1567 /** 1568 * 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. 1569 */ 1570 maxResults?: PageSize; 1571 } 1572 export interface ListReportGroupsOutput { 1573 /** 1574 * 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. 1575 */ 1576 nextToken?: String; 1577 /** 1578 * The list of ARNs for the report groups in the current Amazon Web Services account. 1579 */ 1580 reportGroups?: ReportGroupArns; 1581 } 1582 export interface ListReportsForReportGroupInput { 1583 /** 1584 * The ARN of the report group for which you want to return report ARNs. 1585 */ 1586 reportGroupArn: String; 1587 /** 1588 * 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. 1589 */ 1590 nextToken?: String; 1591 /** 1592 * Use to specify whether the results are returned in ascending or descending order. 1593 */ 1594 sortOrder?: SortOrderType; 1595 /** 1596 * 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. 1597 */ 1598 maxResults?: PageSize; 1599 /** 1600 * A ReportFilter object used to filter the returned reports. 1601 */ 1602 filter?: ReportFilter; 1603 } 1604 export interface ListReportsForReportGroupOutput { 1605 /** 1606 * 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. 1607 */ 1608 nextToken?: String; 1609 /** 1610 * The list of report ARNs. 1611 */ 1612 reports?: ReportArns; 1613 } 1614 export interface ListReportsInput { 1615 /** 1616 * 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. 1617 */ 1618 sortOrder?: SortOrderType; 1619 /** 1620 * 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. 1621 */ 1622 nextToken?: String; 1623 /** 1624 * 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. 1625 */ 1626 maxResults?: PageSize; 1627 /** 1628 * A ReportFilter object used to filter the returned reports. 1629 */ 1630 filter?: ReportFilter; 1631 } 1632 export interface ListReportsOutput { 1633 /** 1634 * 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. 1635 */ 1636 nextToken?: String; 1637 /** 1638 * The list of returned ARNs for the reports in the current Amazon Web Services account. 1639 */ 1640 reports?: ReportArns; 1641 } 1642 export interface ListSharedProjectsInput { 1643 /** 1644 * The criterion to be used to list build projects shared with the current Amazon Web Services 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. 1645 */ 1646 sortBy?: SharedResourceSortByType; 1647 /** 1648 * The order in which to list shared build projects. Valid values include: ASCENDING: List in ascending order. DESCENDING: List in descending order. 1649 */ 1650 sortOrder?: SortOrderType; 1651 /** 1652 * 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. 1653 */ 1654 maxResults?: PageSize; 1655 /** 1656 * 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. 1657 */ 1658 nextToken?: NonEmptyString; 1659 } 1660 export interface ListSharedProjectsOutput { 1661 /** 1662 * 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. 1663 */ 1664 nextToken?: String; 1665 /** 1666 * The list of ARNs for the build projects shared with the current Amazon Web Services account or user. 1667 */ 1668 projects?: ProjectArns; 1669 } 1670 export interface ListSharedReportGroupsInput { 1671 /** 1672 * The order in which to list shared report groups. Valid values include: ASCENDING: List in ascending order. DESCENDING: List in descending order. 1673 */ 1674 sortOrder?: SortOrderType; 1675 /** 1676 * The criterion to be used to list report groups shared with the current Amazon Web Services 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. 1677 */ 1678 sortBy?: SharedResourceSortByType; 1679 /** 1680 * 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. 1681 */ 1682 nextToken?: String; 1683 /** 1684 * 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. 1685 */ 1686 maxResults?: PageSize; 1687 } 1688 export interface ListSharedReportGroupsOutput { 1689 /** 1690 * 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. 1691 */ 1692 nextToken?: String; 1693 /** 1694 * The list of ARNs for the report groups shared with the current Amazon Web Services account or user. 1695 */ 1696 reportGroups?: ReportGroupArns; 1697 } 1698 export interface ListSourceCredentialsInput { 1699 } 1700 export interface ListSourceCredentialsOutput { 1701 /** 1702 * A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials. 1703 */ 1704 sourceCredentialsInfos?: SourceCredentialsInfos; 1705 } 1706 export interface LogsConfig { 1707 /** 1708 * Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default. 1709 */ 1710 cloudWatchLogs?: CloudWatchLogsConfig; 1711 /** 1712 * Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default. 1713 */ 1714 s3Logs?: S3LogsConfig; 1715 } 1716 export type LogsConfigStatusType = "ENABLED"|"DISABLED"|string; 1717 export interface LogsLocation { 1718 /** 1719 * The name of the CloudWatch Logs group for the build logs. 1720 */ 1721 groupName?: String; 1722 /** 1723 * The name of the CloudWatch Logs stream for the build logs. 1724 */ 1725 streamName?: String; 1726 /** 1727 * The URL to an individual build log in CloudWatch Logs. 1728 */ 1729 deepLink?: String; 1730 /** 1731 * The URL to a build log in an S3 bucket. 1732 */ 1733 s3DeepLink?: String; 1734 /** 1735 * The ARN of 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 CloudWatch Logs. 1736 */ 1737 cloudWatchLogsArn?: String; 1738 /** 1739 * 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. 1740 */ 1741 s3LogsArn?: String; 1742 /** 1743 * Information about CloudWatch Logs for a build project. 1744 */ 1745 cloudWatchLogs?: CloudWatchLogsConfig; 1746 /** 1747 * Information about S3 logs for a build project. 1748 */ 1749 s3Logs?: S3LogsConfig; 1750 } 1751 export interface NetworkInterface { 1752 /** 1753 * The ID of the subnet. 1754 */ 1755 subnetId?: NonEmptyString; 1756 /** 1757 * The ID of the network interface. 1758 */ 1759 networkInterfaceId?: NonEmptyString; 1760 } 1761 export type NonEmptyString = string; 1762 export type NonNegativeInt = number; 1763 export type PageSize = number; 1764 export type Percentage = number; 1765 export interface PhaseContext { 1766 /** 1767 * The status code for the context of the build phase. 1768 */ 1769 statusCode?: String; 1770 /** 1771 * An explanation of the build phase's context. This might include a command ID and an exit code. 1772 */ 1773 message?: String; 1774 } 1775 export type PhaseContexts = PhaseContext[]; 1776 export type PlatformType = "DEBIAN"|"AMAZON_LINUX"|"UBUNTU"|"WINDOWS_SERVER"|string; 1777 export interface Project { 1778 /** 1779 * The name of the build project. 1780 */ 1781 name?: ProjectName; 1782 /** 1783 * The Amazon Resource Name (ARN) of the build project. 1784 */ 1785 arn?: String; 1786 /** 1787 * A description that makes the build project easy to identify. 1788 */ 1789 description?: ProjectDescription; 1790 /** 1791 * Information about the build input source code for this build project. 1792 */ 1793 source?: ProjectSource; 1794 /** 1795 * An array of ProjectSource objects. 1796 */ 1797 secondarySources?: ProjectSources; 1798 /** 1799 * 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 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 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 CodeBuild User Guide. 1800 */ 1801 sourceVersion?: String; 1802 /** 1803 * An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level). 1804 */ 1805 secondarySourceVersions?: ProjectSecondarySourceVersions; 1806 /** 1807 * Information about the build output artifacts for the build project. 1808 */ 1809 artifacts?: ProjectArtifacts; 1810 /** 1811 * An array of ProjectArtifacts objects. 1812 */ 1813 secondaryArtifacts?: ProjectArtifactsList; 1814 /** 1815 * Information about the cache for the build project. 1816 */ 1817 cache?: ProjectCache; 1818 /** 1819 * Information about the build environment for this build project. 1820 */ 1821 environment?: ProjectEnvironment; 1822 /** 1823 * The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account. 1824 */ 1825 serviceRole?: NonEmptyString; 1826 /** 1827 * How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes. 1828 */ 1829 timeoutInMinutes?: TimeOut; 1830 /** 1831 * The number of minutes a build is allowed to be queued before it times out. 1832 */ 1833 queuedTimeoutInMinutes?: TimeOut; 1834 /** 1835 * The Key Management Service 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>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3). 1836 */ 1837 encryptionKey?: NonEmptyString; 1838 /** 1839 * A list of tag key and value pairs associated with this build project. These tags are available for use by Amazon Web Services services that support CodeBuild build project tags. 1840 */ 1841 tags?: TagList; 1842 /** 1843 * When the build project was created, expressed in Unix time format. 1844 */ 1845 created?: Timestamp; 1846 /** 1847 * When the build project's settings were last modified, expressed in Unix time format. 1848 */ 1849 lastModified?: Timestamp; 1850 /** 1851 * Information about a webhook that connects repository events to a build project in CodeBuild. 1852 */ 1853 webhook?: Webhook; 1854 /** 1855 * Information about the VPC configuration that CodeBuild accesses. 1856 */ 1857 vpcConfig?: VpcConfig; 1858 /** 1859 * Information about the build badge for the build project. 1860 */ 1861 badge?: ProjectBadge; 1862 /** 1863 * Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both. 1864 */ 1865 logsConfig?: LogsConfig; 1866 /** 1867 * 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. 1868 */ 1869 fileSystemLocations?: ProjectFileSystemLocations; 1870 /** 1871 * A ProjectBuildBatchConfig object that defines the batch build options for the project. 1872 */ 1873 buildBatchConfig?: ProjectBuildBatchConfig; 1874 /** 1875 * The maximum number of concurrent builds that are allowed for this project. New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run. 1876 */ 1877 concurrentBuildLimit?: WrapperInt; 1878 projectVisibility?: ProjectVisibilityType; 1879 /** 1880 * Contains the project identifier used with the public build APIs. 1881 */ 1882 publicProjectAlias?: NonEmptyString; 1883 /** 1884 * The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds. 1885 */ 1886 resourceAccessRole?: NonEmptyString; 1887 } 1888 export type ProjectArns = NonEmptyString[]; 1889 export interface ProjectArtifacts { 1890 /** 1891 * The type of build output artifact. Valid values include: CODEPIPELINE: The build project has build output generated through 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 S3. 1892 */ 1893 type: ArtifactsType; 1894 /** 1895 * Information about the build output artifact location: If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of 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. 1896 */ 1897 location?: String; 1898 /** 1899 * Along with namespaceType and name, the pattern that CodeBuild uses to name and store the output artifact: If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of 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. 1900 */ 1901 path?: String; 1902 /** 1903 * Along with path and name, the pattern that CodeBuild uses to determine the name and location to store the output artifact: If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of 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. 1904 */ 1905 namespaceType?: ArtifactNamespace; 1906 /** 1907 * Along with path and namespaceType, the pattern that CodeBuild uses to name and store the output artifact: If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of 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>. 1908 */ 1909 name?: String; 1910 /** 1911 * The type of build output artifact to create: If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of 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: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified. ZIP: CodeBuild creates in the output bucket a ZIP file that contains the build output. 1912 */ 1913 packaging?: ArtifactPackaging; 1914 /** 1915 * 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. 1916 */ 1917 overrideArtifactName?: WrapperBoolean; 1918 /** 1919 * Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown. 1920 */ 1921 encryptionDisabled?: WrapperBoolean; 1922 /** 1923 * An identifier for this artifact definition. 1924 */ 1925 artifactIdentifier?: String; 1926 bucketOwnerAccess?: BucketOwnerAccess; 1927 } 1928 export type ProjectArtifactsList = ProjectArtifacts[]; 1929 export interface ProjectBadge { 1930 /** 1931 * Set this to true to generate a publicly accessible URL for your project's build badge. 1932 */ 1933 badgeEnabled?: Boolean; 1934 /** 1935 * The publicly-accessible URL through which you can access the build badge for your project. 1936 */ 1937 badgeRequestUrl?: String; 1938 } 1939 export interface ProjectBuildBatchConfig { 1940 /** 1941 * Specifies the service role ARN for the batch build project. 1942 */ 1943 serviceRole?: NonEmptyString; 1944 /** 1945 * Specifies if the build artifacts for the batch build should be combined into a single artifact location. 1946 */ 1947 combineArtifacts?: WrapperBoolean; 1948 /** 1949 * A BatchRestrictions object that specifies the restrictions for the batch build. 1950 */ 1951 restrictions?: BatchRestrictions; 1952 /** 1953 * Specifies the maximum amount of time, in minutes, that the batch build must be completed in. 1954 */ 1955 timeoutInMins?: WrapperInt; 1956 } 1957 export interface ProjectCache { 1958 /** 1959 * 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. 1960 */ 1961 type: CacheType; 1962 /** 1963 * Information about the cache location: NO_CACHE or LOCAL: This value is ignored. S3: This is the S3 bucket name/prefix. 1964 */ 1965 location?: String; 1966 /** 1967 * An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for LOCAL cache types. Possible values are: LOCAL_SOURCE_CACHE 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 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 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. 1968 */ 1969 modes?: ProjectCacheModes; 1970 } 1971 export type ProjectCacheModes = CacheMode[]; 1972 export type ProjectDescription = string; 1973 export interface ProjectEnvironment { 1974 /** 1975 * 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). The environment types WINDOWS_CONTAINER and WINDOWS_SERVER_2019_CONTAINER are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland). For more information, see Build environment compute types in the CodeBuild user guide. 1976 */ 1977 type: EnvironmentType; 1978 /** 1979 * 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, in the Docker repository that CodeBuild uses to manage its Docker images, this would be aws/codebuild/standard:4.0. For an image digest: <registry>/<repository>@<digest>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use <registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf. For more information, see Docker images provided by CodeBuild in the CodeBuild user guide. 1980 */ 1981 image: NonEmptyString; 1982 /** 1983 * 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 CodeBuild User Guide. 1984 */ 1985 computeType: ComputeType; 1986 /** 1987 * A set of environment variables to make available to builds for this build project. 1988 */ 1989 environmentVariables?: EnvironmentVariables; 1990 /** 1991 * 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" 1992 */ 1993 privilegedMode?: WrapperBoolean; 1994 /** 1995 * The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the CodeBuild User Guide. 1996 */ 1997 certificate?: String; 1998 /** 1999 * The credentials for access to a private registry. 2000 */ 2001 registryCredential?: RegistryCredential; 2002 /** 2003 * The type of credentials CodeBuild uses to pull images in your build. There are two valid values: CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal. SERVICE_ROLE specifies that 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 CodeBuild curated image, you must use CODEBUILD credentials. 2004 */ 2005 imagePullCredentialsType?: ImagePullCredentialsType; 2006 } 2007 export interface ProjectFileSystemLocation { 2008 /** 2009 * The type of the file system. The one supported type is EFS. 2010 */ 2011 type?: FileSystemType; 2012 /** 2013 * 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 Amazon 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. 2014 */ 2015 location?: String; 2016 /** 2017 * The location in the container where you mount the file system. 2018 */ 2019 mountPoint?: String; 2020 /** 2021 * 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. 2022 */ 2023 identifier?: String; 2024 /** 2025 * The mount options for a file system created by Amazon 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. 2026 */ 2027 mountOptions?: String; 2028 } 2029 export type ProjectFileSystemLocations = ProjectFileSystemLocation[]; 2030 export type ProjectName = string; 2031 export type ProjectNames = NonEmptyString[]; 2032 export type ProjectSecondarySourceVersions = ProjectSourceVersion[]; 2033 export type ProjectSortByType = "NAME"|"CREATED_TIME"|"LAST_MODIFIED_TIME"|string; 2034 export interface ProjectSource { 2035 /** 2036 * 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 CodeCommit repository. CODEPIPELINE: The source code settings are specified in the source action of a pipeline in 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 S3 bucket. 2037 */ 2038 type: SourceType; 2039 /** 2040 * 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 CodePipeline, location should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value. For source code in an 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 S3 input bucket, one of the following. The path to the ZIP file that contains the source code (for example, <bucket-name>/<path>/<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 Amazon Web Services account to your GitHub account. Use the 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 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 CodeBuild console.) To instruct 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 Amazon Web Services account to your Bitbucket account. Use the 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 CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH. If you specify CODEPIPELINE for the Type property, don't specify this property. For all of the other types, you must specify Location. 2041 */ 2042 location?: String; 2043 /** 2044 * Information about the Git clone depth for the build project. 2045 */ 2046 gitCloneDepth?: GitCloneDepth; 2047 /** 2048 * Information about the Git submodules configuration for the build project. 2049 */ 2050 gitSubmodulesConfig?: GitSubmodulesConfig; 2051 /** 2052 * 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 Amazon Web Services 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. 2053 */ 2054 buildspec?: String; 2055 /** 2056 * Information about the authorization settings for CodeBuild to access the source code to be built. This information is for the CodeBuild console's use only. Your code should not get or set this information directly. 2057 */ 2058 auth?: SourceAuth; 2059 /** 2060 * 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. To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide. The status of a build triggered by a webhook is always reported to your source provider. If your project's builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect. 2061 */ 2062 reportBuildStatus?: WrapperBoolean; 2063 /** 2064 * 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. 2065 */ 2066 buildStatusConfig?: BuildStatusConfig; 2067 /** 2068 * Enable this flag to ignore SSL warnings while connecting to the project source code. 2069 */ 2070 insecureSsl?: WrapperBoolean; 2071 /** 2072 * An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. 2073 */ 2074 sourceIdentifier?: String; 2075 } 2076 export interface ProjectSourceVersion { 2077 /** 2078 * An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. 2079 */ 2080 sourceIdentifier: String; 2081 /** 2082 * The source version for the corresponding source identifier. If specified, must be one of: For 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 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 CodeBuild User Guide. 2083 */ 2084 sourceVersion: String; 2085 } 2086 export type ProjectSources = ProjectSource[]; 2087 export type ProjectVisibilityType = "PUBLIC_READ"|"PRIVATE"|string; 2088 export type Projects = Project[]; 2089 export interface PutResourcePolicyInput { 2090 /** 2091 * A JSON-formatted resource policy. For more information, see Sharing a Project and Sharing a Report Group in the CodeBuild User Guide. 2092 */ 2093 policy: NonEmptyString; 2094 /** 2095 * The ARN of the Project or ReportGroup resource you want to associate with a resource policy. 2096 */ 2097 resourceArn: NonEmptyString; 2098 } 2099 export interface PutResourcePolicyOutput { 2100 /** 2101 * The ARN of the Project or ReportGroup resource that is associated with a resource policy. 2102 */ 2103 resourceArn?: NonEmptyString; 2104 } 2105 export interface RegistryCredential { 2106 /** 2107 * The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager. The credential can use the name of the credentials only if they exist in your current Amazon Web Services Region. 2108 */ 2109 credential: NonEmptyString; 2110 /** 2111 * The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager. 2112 */ 2113 credentialProvider: CredentialProviderType; 2114 } 2115 export interface Report { 2116 /** 2117 * The ARN of the report run. 2118 */ 2119 arn?: NonEmptyString; 2120 /** 2121 * The type of the report that was run. CODE_COVERAGE A code coverage report. TEST A test report. 2122 */ 2123 type?: ReportType; 2124 /** 2125 * The name of the report that was run. 2126 */ 2127 name?: String; 2128 /** 2129 * The ARN of the report group associated with this report. 2130 */ 2131 reportGroupArn?: NonEmptyString; 2132 /** 2133 * The ARN of the build run that generated this report. 2134 */ 2135 executionId?: String; 2136 /** 2137 * The status of this report. 2138 */ 2139 status?: ReportStatusType; 2140 /** 2141 * The date and time this report run occurred. 2142 */ 2143 created?: Timestamp; 2144 /** 2145 * 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. 2146 */ 2147 expired?: Timestamp; 2148 /** 2149 * Information about where the raw data used to generate this report was exported. 2150 */ 2151 exportConfig?: ReportExportConfig; 2152 /** 2153 * 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. 2154 */ 2155 truncated?: WrapperBoolean; 2156 /** 2157 * A TestReportSummary object that contains information about this test report. 2158 */ 2159 testSummary?: TestReportSummary; 2160 /** 2161 * A CodeCoverageReportSummary object that contains a code coverage summary for this report. 2162 */ 2163 codeCoverageSummary?: CodeCoverageReportSummary; 2164 } 2165 export type ReportArns = NonEmptyString[]; 2166 export type ReportCodeCoverageSortByType = "LINE_COVERAGE_PERCENTAGE"|"FILE_PATH"|string; 2167 export interface ReportExportConfig { 2168 /** 2169 * 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. 2170 */ 2171 exportConfigType?: ReportExportConfigType; 2172 /** 2173 * A S3ReportExportConfig object that contains information about the S3 bucket where the run of a report is exported. 2174 */ 2175 s3Destination?: S3ReportExportConfig; 2176 } 2177 export type ReportExportConfigType = "S3"|"NO_EXPORT"|string; 2178 export interface ReportFilter { 2179 /** 2180 * The status used to filter reports. You can filter using one status only. 2181 */ 2182 status?: ReportStatusType; 2183 } 2184 export interface ReportGroup { 2185 /** 2186 * The ARN of the ReportGroup. 2187 */ 2188 arn?: NonEmptyString; 2189 /** 2190 * The name of the ReportGroup. 2191 */ 2192 name?: ReportGroupName; 2193 /** 2194 * The type of the ReportGroup. This can be one of the following values: CODE_COVERAGE The report group contains code coverage reports. TEST The report group contains test reports. 2195 */ 2196 type?: ReportType; 2197 /** 2198 * Information about the destination where the raw data of this ReportGroup is exported. 2199 */ 2200 exportConfig?: ReportExportConfig; 2201 /** 2202 * The date and time this ReportGroup was created. 2203 */ 2204 created?: Timestamp; 2205 /** 2206 * The date and time this ReportGroup was last modified. 2207 */ 2208 lastModified?: Timestamp; 2209 /** 2210 * A list of tag key and value pairs associated with this report group. These tags are available for use by Amazon Web Services services that support CodeBuild report group tags. 2211 */ 2212 tags?: TagList; 2213 /** 2214 * The status of the report group. This property is read-only. This can be one of the following values: ACTIVE The report group is active. DELETING The report group is in the process of being deleted. 2215 */ 2216 status?: ReportGroupStatusType; 2217 } 2218 export type ReportGroupArns = NonEmptyString[]; 2219 export type ReportGroupName = string; 2220 export type ReportGroupSortByType = "NAME"|"CREATED_TIME"|"LAST_MODIFIED_TIME"|string; 2221 export type ReportGroupStatusType = "ACTIVE"|"DELETING"|string; 2222 export type ReportGroupTrendFieldType = "PASS_RATE"|"DURATION"|"TOTAL"|"LINE_COVERAGE"|"LINES_COVERED"|"LINES_MISSED"|"BRANCH_COVERAGE"|"BRANCHES_COVERED"|"BRANCHES_MISSED"|string; 2223 export type ReportGroupTrendRawDataList = ReportWithRawData[]; 2224 export interface ReportGroupTrendStats { 2225 /** 2226 * Contains the average of all values analyzed. 2227 */ 2228 average?: String; 2229 /** 2230 * Contains the maximum value analyzed. 2231 */ 2232 max?: String; 2233 /** 2234 * Contains the minimum value analyzed. 2235 */ 2236 min?: String; 2237 } 2238 export type ReportGroups = ReportGroup[]; 2239 export type ReportPackagingType = "ZIP"|"NONE"|string; 2240 export type ReportStatusCounts = {[key: string]: WrapperInt}; 2241 export type ReportStatusType = "GENERATING"|"SUCCEEDED"|"FAILED"|"INCOMPLETE"|"DELETING"|string; 2242 export type ReportType = "TEST"|"CODE_COVERAGE"|string; 2243 export interface ReportWithRawData { 2244 /** 2245 * The ARN of the report. 2246 */ 2247 reportArn?: NonEmptyString; 2248 /** 2249 * The value of the requested data field from the report. 2250 */ 2251 data?: String; 2252 } 2253 export type Reports = Report[]; 2254 export interface ResolvedArtifact { 2255 /** 2256 * Specifies the type of artifact. 2257 */ 2258 type?: ArtifactsType; 2259 /** 2260 * The location of the artifact. 2261 */ 2262 location?: String; 2263 /** 2264 * The identifier of the artifact. 2265 */ 2266 identifier?: String; 2267 } 2268 export type ResolvedSecondaryArtifacts = ResolvedArtifact[]; 2269 export interface RetryBuildBatchInput { 2270 /** 2271 * Specifies the identifier of the batch build to restart. 2272 */ 2273 id?: NonEmptyString; 2274 /** 2275 * 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, CodeBuild returns a parameter mismatch error. 2276 */ 2277 idempotencyToken?: String; 2278 /** 2279 * Specifies the type of retry to perform. 2280 */ 2281 retryType?: RetryBuildBatchType; 2282 } 2283 export interface RetryBuildBatchOutput { 2284 buildBatch?: BuildBatch; 2285 } 2286 export type RetryBuildBatchType = "RETRY_ALL_BUILDS"|"RETRY_FAILED_BUILDS"|string; 2287 export interface RetryBuildInput { 2288 /** 2289 * Specifies the identifier of the build to restart. 2290 */ 2291 id?: NonEmptyString; 2292 /** 2293 * 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, CodeBuild returns a parameter mismatch error. 2294 */ 2295 idempotencyToken?: String; 2296 } 2297 export interface RetryBuildOutput { 2298 build?: Build; 2299 } 2300 export interface S3LogsConfig { 2301 /** 2302 * 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. 2303 */ 2304 status: LogsConfigStatusType; 2305 /** 2306 * 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. 2307 */ 2308 location?: String; 2309 /** 2310 * Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. 2311 */ 2312 encryptionDisabled?: WrapperBoolean; 2313 bucketOwnerAccess?: BucketOwnerAccess; 2314 } 2315 export interface S3ReportExportConfig { 2316 /** 2317 * The name of the S3 bucket where the raw data of a report are exported. 2318 */ 2319 bucket?: NonEmptyString; 2320 /** 2321 * The Amazon Web Services account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build. 2322 */ 2323 bucketOwner?: String; 2324 /** 2325 * The path to the exported report's raw data results. 2326 */ 2327 path?: String; 2328 /** 2329 * The type of build output artifact to create. Valid values include: NONE: CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified. ZIP: CodeBuild creates a ZIP file with the raw data in the output bucket. 2330 */ 2331 packaging?: ReportPackagingType; 2332 /** 2333 * The encryption key for the report's encrypted raw data. 2334 */ 2335 encryptionKey?: NonEmptyString; 2336 /** 2337 * A boolean value that specifies if the results of a report are encrypted. 2338 */ 2339 encryptionDisabled?: WrapperBoolean; 2340 } 2341 export type SecurityGroupIds = NonEmptyString[]; 2342 export type SensitiveNonEmptyString = string; 2343 export type ServerType = "GITHUB"|"BITBUCKET"|"GITHUB_ENTERPRISE"|string; 2344 export type SharedResourceSortByType = "ARN"|"MODIFIED_TIME"|string; 2345 export type SortOrderType = "ASCENDING"|"DESCENDING"|string; 2346 export interface SourceAuth { 2347 /** 2348 * 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. 2349 */ 2350 type: SourceAuthType; 2351 /** 2352 * The resource value that applies to the specified authorization type. 2353 */ 2354 resource?: String; 2355 } 2356 export type SourceAuthType = "OAUTH"|string; 2357 export interface SourceCredentialsInfo { 2358 /** 2359 * The Amazon Resource Name (ARN) of the token. 2360 */ 2361 arn?: NonEmptyString; 2362 /** 2363 * The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET. 2364 */ 2365 serverType?: ServerType; 2366 /** 2367 * The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN. 2368 */ 2369 authType?: AuthType; 2370 } 2371 export type SourceCredentialsInfos = SourceCredentialsInfo[]; 2372 export type SourceType = "CODECOMMIT"|"CODEPIPELINE"|"GITHUB"|"S3"|"BITBUCKET"|"GITHUB_ENTERPRISE"|"NO_SOURCE"|string; 2373 export interface StartBuildBatchInput { 2374 /** 2375 * The name of the project. 2376 */ 2377 projectName: NonEmptyString; 2378 /** 2379 * An array of ProjectSource objects that override the secondary sources defined in the batch build project. 2380 */ 2381 secondarySourcesOverride?: ProjectSources; 2382 /** 2383 * An array of ProjectSourceVersion objects that override the secondary source versions in the batch build project. 2384 */ 2385 secondarySourcesVersionOverride?: ProjectSecondarySourceVersions; 2386 /** 2387 * 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: CodeCommit The commit ID, branch, or Git tag to use. 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. 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. Amazon S3 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 CodeBuild User Guide. 2388 */ 2389 sourceVersion?: String; 2390 /** 2391 * An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project. 2392 */ 2393 artifactsOverride?: ProjectArtifacts; 2394 /** 2395 * An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch build project. 2396 */ 2397 secondaryArtifactsOverride?: ProjectArtifactsList; 2398 /** 2399 * An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project. 2400 */ 2401 environmentVariablesOverride?: EnvironmentVariables; 2402 /** 2403 * The source input type that overrides the source input defined in the batch build project. 2404 */ 2405 sourceTypeOverride?: SourceType; 2406 /** 2407 * A location that overrides, for this batch build, the source location defined in the batch build project. 2408 */ 2409 sourceLocationOverride?: String; 2410 /** 2411 * 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. 2412 */ 2413 sourceAuthOverride?: SourceAuth; 2414 /** 2415 * 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. 2416 */ 2417 gitCloneDepthOverride?: GitCloneDepth; 2418 /** 2419 * A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build. 2420 */ 2421 gitSubmodulesConfigOverride?: GitSubmodulesConfig; 2422 /** 2423 * 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 Amazon Web Services 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. 2424 */ 2425 buildspecOverride?: String; 2426 /** 2427 * 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. 2428 */ 2429 insecureSslOverride?: WrapperBoolean; 2430 /** 2431 * 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. 2432 */ 2433 reportBuildBatchStatusOverride?: WrapperBoolean; 2434 /** 2435 * A container type for this batch build that overrides the one specified in the batch build project. 2436 */ 2437 environmentTypeOverride?: EnvironmentType; 2438 /** 2439 * The name of an image for this batch build that overrides the one specified in the batch build project. 2440 */ 2441 imageOverride?: NonEmptyString; 2442 /** 2443 * The name of a compute type for this batch build that overrides the one specified in the batch build project. 2444 */ 2445 computeTypeOverride?: ComputeType; 2446 /** 2447 * The name of a certificate for this batch build that overrides the one specified in the batch build project. 2448 */ 2449 certificateOverride?: String; 2450 /** 2451 * A ProjectCache object that specifies cache overrides. 2452 */ 2453 cacheOverride?: ProjectCache; 2454 /** 2455 * The name of a service role for this batch build that overrides the one specified in the batch build project. 2456 */ 2457 serviceRoleOverride?: NonEmptyString; 2458 /** 2459 * Enable this flag to override privileged mode in the batch build project. 2460 */ 2461 privilegedModeOverride?: WrapperBoolean; 2462 /** 2463 * Overrides the build timeout specified in the batch build project. 2464 */ 2465 buildTimeoutInMinutesOverride?: TimeOut; 2466 /** 2467 * The number of minutes a batch build is allowed to be queued before it times out. 2468 */ 2469 queuedTimeoutInMinutesOverride?: TimeOut; 2470 /** 2471 * The Key Management Service customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts the build output artifacts. 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>). 2472 */ 2473 encryptionKeyOverride?: NonEmptyString; 2474 /** 2475 * 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, CodeBuild returns a parameter mismatch error. 2476 */ 2477 idempotencyToken?: String; 2478 /** 2479 * A LogsConfig object that override the log settings defined in the batch build project. 2480 */ 2481 logsConfigOverride?: LogsConfig; 2482 /** 2483 * A RegistryCredential object that overrides credentials for access to a private registry. 2484 */ 2485 registryCredentialOverride?: RegistryCredential; 2486 /** 2487 * The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values: CODEBUILD Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal. SERVICE_ROLE Specifies that 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 CodeBuild curated image, you must use CODEBUILD credentials. 2488 */ 2489 imagePullCredentialsTypeOverride?: ImagePullCredentialsType; 2490 /** 2491 * A BuildBatchConfigOverride object that contains batch build configuration overrides. 2492 */ 2493 buildBatchConfigOverride?: ProjectBuildBatchConfig; 2494 /** 2495 * Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds. 2496 */ 2497 debugSessionEnabled?: WrapperBoolean; 2498 } 2499 export interface StartBuildBatchOutput { 2500 /** 2501 * A BuildBatch object that contains information about the batch build. 2502 */ 2503 buildBatch?: BuildBatch; 2504 } 2505 export interface StartBuildInput { 2506 /** 2507 * The name of the CodeBuild build project to start running a build. 2508 */ 2509 projectName: NonEmptyString; 2510 /** 2511 * An array of ProjectSource objects. 2512 */ 2513 secondarySourcesOverride?: ProjectSources; 2514 /** 2515 * An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only. 2516 */ 2517 secondarySourcesVersionOverride?: ProjectSecondarySourceVersions; 2518 /** 2519 * 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: CodeCommit The commit ID, branch, or Git tag to use. 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. 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. Amazon S3 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 CodeBuild User Guide. 2520 */ 2521 sourceVersion?: String; 2522 /** 2523 * Build output artifact settings that override, for this build only, the latest ones already defined in the build project. 2524 */ 2525 artifactsOverride?: ProjectArtifacts; 2526 /** 2527 * An array of ProjectArtifacts objects. 2528 */ 2529 secondaryArtifactsOverride?: ProjectArtifactsList; 2530 /** 2531 * A set of environment variables that overrides, for this build only, the latest ones already defined in the build project. 2532 */ 2533 environmentVariablesOverride?: EnvironmentVariables; 2534 /** 2535 * A source input type, for this build, that overrides the source input defined in the build project. 2536 */ 2537 sourceTypeOverride?: SourceType; 2538 /** 2539 * A location that overrides, for this build, the source location for the one defined in the build project. 2540 */ 2541 sourceLocationOverride?: String; 2542 /** 2543 * 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. 2544 */ 2545 sourceAuthOverride?: SourceAuth; 2546 /** 2547 * 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. 2548 */ 2549 gitCloneDepthOverride?: GitCloneDepth; 2550 /** 2551 * Information about the Git submodules configuration for this build of an CodeBuild build project. 2552 */ 2553 gitSubmodulesConfigOverride?: GitSubmodulesConfig; 2554 /** 2555 * 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 Amazon Web Services 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. 2556 */ 2557 buildspecOverride?: String; 2558 /** 2559 * 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. 2560 */ 2561 insecureSslOverride?: WrapperBoolean; 2562 /** 2563 * 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. To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide. The status of a build triggered by a webhook is always reported to your source provider. 2564 */ 2565 reportBuildStatusOverride?: WrapperBoolean; 2566 /** 2567 * 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. 2568 */ 2569 buildStatusConfigOverride?: BuildStatusConfig; 2570 /** 2571 * A container type for this build that overrides the one specified in the build project. 2572 */ 2573 environmentTypeOverride?: EnvironmentType; 2574 /** 2575 * The name of an image for this build that overrides the one specified in the build project. 2576 */ 2577 imageOverride?: NonEmptyString; 2578 /** 2579 * The name of a compute type for this build that overrides the one specified in the build project. 2580 */ 2581 computeTypeOverride?: ComputeType; 2582 /** 2583 * The name of a certificate for this build that overrides the one specified in the build project. 2584 */ 2585 certificateOverride?: String; 2586 /** 2587 * A ProjectCache object specified for this build that overrides the one defined in the build project. 2588 */ 2589 cacheOverride?: ProjectCache; 2590 /** 2591 * The name of a service role for this build that overrides the one specified in the build project. 2592 */ 2593 serviceRoleOverride?: NonEmptyString; 2594 /** 2595 * Enable this flag to override privileged mode in the build project. 2596 */ 2597 privilegedModeOverride?: WrapperBoolean; 2598 /** 2599 * 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. 2600 */ 2601 timeoutInMinutesOverride?: TimeOut; 2602 /** 2603 * The number of minutes a build is allowed to be queued before it times out. 2604 */ 2605 queuedTimeoutInMinutesOverride?: TimeOut; 2606 /** 2607 * The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts. 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>). 2608 */ 2609 encryptionKeyOverride?: NonEmptyString; 2610 /** 2611 * A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error. 2612 */ 2613 idempotencyToken?: String; 2614 /** 2615 * Log settings for this build that override the log settings defined in the build project. 2616 */ 2617 logsConfigOverride?: LogsConfig; 2618 /** 2619 * The credentials for access to a private registry. 2620 */ 2621 registryCredentialOverride?: RegistryCredential; 2622 /** 2623 * The type of credentials CodeBuild uses to pull images in your build. There are two valid values: CODEBUILD Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal. SERVICE_ROLE Specifies that 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 CodeBuild curated image, you must use CODEBUILD credentials. 2624 */ 2625 imagePullCredentialsTypeOverride?: ImagePullCredentialsType; 2626 /** 2627 * Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager. 2628 */ 2629 debugSessionEnabled?: WrapperBoolean; 2630 } 2631 export interface StartBuildOutput { 2632 /** 2633 * Information about the build to be run. 2634 */ 2635 build?: Build; 2636 } 2637 export type StatusType = "SUCCEEDED"|"FAILED"|"FAULT"|"TIMED_OUT"|"IN_PROGRESS"|"STOPPED"|string; 2638 export interface StopBuildBatchInput { 2639 /** 2640 * The identifier of the batch build to stop. 2641 */ 2642 id: NonEmptyString; 2643 } 2644 export interface StopBuildBatchOutput { 2645 buildBatch?: BuildBatch; 2646 } 2647 export interface StopBuildInput { 2648 /** 2649 * The ID of the build. 2650 */ 2651 id: NonEmptyString; 2652 } 2653 export interface StopBuildOutput { 2654 /** 2655 * Information about the build. 2656 */ 2657 build?: Build; 2658 } 2659 export type String = string; 2660 export type Subnets = NonEmptyString[]; 2661 export interface Tag { 2662 /** 2663 * The tag's key. 2664 */ 2665 key?: KeyInput; 2666 /** 2667 * The tag's value. 2668 */ 2669 value?: ValueInput; 2670 } 2671 export type TagList = Tag[]; 2672 export interface TestCase { 2673 /** 2674 * The ARN of the report to which the test case belongs. 2675 */ 2676 reportArn?: NonEmptyString; 2677 /** 2678 * The path to the raw data file that contains the test result. 2679 */ 2680 testRawDataPath?: String; 2681 /** 2682 * 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. 2683 */ 2684 prefix?: String; 2685 /** 2686 * The name of the test case. 2687 */ 2688 name?: String; 2689 /** 2690 * The status returned by the test case after it was run. Valid statuses are SUCCEEDED, FAILED, ERROR, SKIPPED, and UNKNOWN. 2691 */ 2692 status?: String; 2693 /** 2694 * The number of nanoseconds it took to run this test case. 2695 */ 2696 durationInNanoSeconds?: WrapperLong; 2697 /** 2698 * A message associated with a test case. For example, an error message or stack trace. 2699 */ 2700 message?: String; 2701 /** 2702 * 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. 2703 */ 2704 expired?: Timestamp; 2705 } 2706 export interface TestCaseFilter { 2707 /** 2708 * The status used to filter test cases. A TestCaseFilter can have one status. Valid values are: SUCCEEDED FAILED ERROR SKIPPED UNKNOWN 2709 */ 2710 status?: String; 2711 /** 2712 * A keyword that is used to filter on the name or the prefix of the test cases. Only test cases where the keyword is a substring of the name or the prefix will be returned. 2713 */ 2714 keyword?: String; 2715 } 2716 export type TestCases = TestCase[]; 2717 export interface TestReportSummary { 2718 /** 2719 * The number of test cases in this TestReportSummary. The total includes truncated test cases. 2720 */ 2721 total: WrapperInt; 2722 /** 2723 * A map that contains the number of each type of status returned by the test results in this TestReportSummary. 2724 */ 2725 statusCounts: ReportStatusCounts; 2726 /** 2727 * The number of nanoseconds it took to run all of the test cases in this report. 2728 */ 2729 durationInNanoSeconds: WrapperLong; 2730 } 2731 export type TimeOut = number; 2732 export type Timestamp = Date; 2733 export interface UpdateProjectInput { 2734 /** 2735 * The name of the build project. You cannot change a build project's name. 2736 */ 2737 name: NonEmptyString; 2738 /** 2739 * A new or replacement description of the build project. 2740 */ 2741 description?: ProjectDescription; 2742 /** 2743 * Information to be changed about the build input source code for the build project. 2744 */ 2745 source?: ProjectSource; 2746 /** 2747 * An array of ProjectSource objects. 2748 */ 2749 secondarySources?: ProjectSources; 2750 /** 2751 * 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 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 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 CodeBuild User Guide. 2752 */ 2753 sourceVersion?: String; 2754 /** 2755 * An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level). 2756 */ 2757 secondarySourceVersions?: ProjectSecondarySourceVersions; 2758 /** 2759 * Information to be changed about the build output artifacts for the build project. 2760 */ 2761 artifacts?: ProjectArtifacts; 2762 /** 2763 * An array of ProjectSource objects. 2764 */ 2765 secondaryArtifacts?: ProjectArtifactsList; 2766 /** 2767 * Stores recently used information so that it can be quickly accessed at a later time. 2768 */ 2769 cache?: ProjectCache; 2770 /** 2771 * Information to be changed about the build environment for the build project. 2772 */ 2773 environment?: ProjectEnvironment; 2774 /** 2775 * The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account. 2776 */ 2777 serviceRole?: NonEmptyString; 2778 /** 2779 * The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. 2780 */ 2781 timeoutInMinutes?: TimeOut; 2782 /** 2783 * The number of minutes a build is allowed to be queued before it times out. 2784 */ 2785 queuedTimeoutInMinutes?: TimeOut; 2786 /** 2787 * The Key Management Service 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>). 2788 */ 2789 encryptionKey?: NonEmptyString; 2790 /** 2791 * An updated list of tag key and value pairs associated with this build project. These tags are available for use by Amazon Web Services services that support CodeBuild build project tags. 2792 */ 2793 tags?: TagList; 2794 /** 2795 * VpcConfig enables CodeBuild to access resources in an Amazon VPC. 2796 */ 2797 vpcConfig?: VpcConfig; 2798 /** 2799 * Set this to true to generate a publicly accessible URL for your project's build badge. 2800 */ 2801 badgeEnabled?: WrapperBoolean; 2802 /** 2803 * Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both. 2804 */ 2805 logsConfig?: LogsConfig; 2806 /** 2807 * 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. 2808 */ 2809 fileSystemLocations?: ProjectFileSystemLocations; 2810 buildBatchConfig?: ProjectBuildBatchConfig; 2811 /** 2812 * The maximum number of concurrent builds that are allowed for this project. New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run. To remove this limit, set this value to -1. 2813 */ 2814 concurrentBuildLimit?: WrapperInt; 2815 } 2816 export interface UpdateProjectOutput { 2817 /** 2818 * Information about the build project that was changed. 2819 */ 2820 project?: Project; 2821 } 2822 export interface UpdateProjectVisibilityInput { 2823 /** 2824 * The Amazon Resource Name (ARN) of the build project. 2825 */ 2826 projectArn: NonEmptyString; 2827 projectVisibility: ProjectVisibilityType; 2828 /** 2829 * The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds. 2830 */ 2831 resourceAccessRole?: NonEmptyString; 2832 } 2833 export interface UpdateProjectVisibilityOutput { 2834 /** 2835 * The Amazon Resource Name (ARN) of the build project. 2836 */ 2837 projectArn?: NonEmptyString; 2838 /** 2839 * Contains the project identifier used with the public build APIs. 2840 */ 2841 publicProjectAlias?: NonEmptyString; 2842 projectVisibility?: ProjectVisibilityType; 2843 } 2844 export interface UpdateReportGroupInput { 2845 /** 2846 * The ARN of the report group to update. 2847 */ 2848 arn: NonEmptyString; 2849 /** 2850 * 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. 2851 */ 2852 exportConfig?: ReportExportConfig; 2853 /** 2854 * An updated list of tag key and value pairs associated with this report group. These tags are available for use by Amazon Web Services services that support CodeBuild report group tags. 2855 */ 2856 tags?: TagList; 2857 } 2858 export interface UpdateReportGroupOutput { 2859 /** 2860 * Information about the updated report group. 2861 */ 2862 reportGroup?: ReportGroup; 2863 } 2864 export interface UpdateWebhookInput { 2865 /** 2866 * The name of the CodeBuild project. 2867 */ 2868 projectName: ProjectName; 2869 /** 2870 * 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. 2871 */ 2872 branchFilter?: String; 2873 /** 2874 * 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. 2875 */ 2876 rotateSecret?: Boolean; 2877 /** 2878 * 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. 2879 */ 2880 filterGroups?: FilterGroups; 2881 /** 2882 * Specifies the type of build this webhook will trigger. 2883 */ 2884 buildType?: WebhookBuildType; 2885 } 2886 export interface UpdateWebhookOutput { 2887 /** 2888 * Information about a repository's webhook that is associated with a project in CodeBuild. 2889 */ 2890 webhook?: Webhook; 2891 } 2892 export type ValueInput = string; 2893 export interface VpcConfig { 2894 /** 2895 * The ID of the Amazon VPC. 2896 */ 2897 vpcId?: NonEmptyString; 2898 /** 2899 * A list of one or more subnet IDs in your Amazon VPC. 2900 */ 2901 subnets?: Subnets; 2902 /** 2903 * A list of one or more security groups IDs in your Amazon VPC. 2904 */ 2905 securityGroupIds?: SecurityGroupIds; 2906 } 2907 export interface Webhook { 2908 /** 2909 * The URL to the webhook. 2910 */ 2911 url?: NonEmptyString; 2912 /** 2913 * The CodeBuild endpoint where webhook events are sent. 2914 */ 2915 payloadUrl?: NonEmptyString; 2916 /** 2917 * The secret token of the associated repository. A Bitbucket webhook does not support secret. 2918 */ 2919 secret?: NonEmptyString; 2920 /** 2921 * 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. 2922 */ 2923 branchFilter?: String; 2924 /** 2925 * 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. 2926 */ 2927 filterGroups?: FilterGroups; 2928 /** 2929 * Specifies the type of build this webhook will trigger. 2930 */ 2931 buildType?: WebhookBuildType; 2932 /** 2933 * A timestamp that indicates the last time a repository's secret token was modified. 2934 */ 2935 lastModifiedSecret?: Timestamp; 2936 } 2937 export type WebhookBuildType = "BUILD"|"BUILD_BATCH"|string; 2938 export interface WebhookFilter { 2939 /** 2940 * The type of webhook filter. There are six webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH, and COMMIT_MESSAGE. EVENT 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. ACTOR_ACCOUNT_ID A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression pattern. HEAD_REF 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. BASE_REF 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. FILE_PATH 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. COMMIT_MESSAGE 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. 2941 */ 2942 type: WebhookFilterType; 2943 /** 2944 * 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. 2945 */ 2946 pattern: String; 2947 /** 2948 * 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. 2949 */ 2950 excludeMatchedPattern?: WrapperBoolean; 2951 } 2952 export type WebhookFilterType = "EVENT"|"BASE_REF"|"HEAD_REF"|"ACTOR_ACCOUNT_ID"|"FILE_PATH"|"COMMIT_MESSAGE"|string; 2953 export type WrapperBoolean = boolean; 2954 export type WrapperInt = number; 2955 export type WrapperLong = number; 2956 /** 2957 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 2958 */ 2959 export type apiVersion = "2016-10-06"|"latest"|string; 2960 export interface ClientApiVersions { 2961 /** 2962 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 2963 */ 2964 apiVersion?: apiVersion; 2965 } 2966 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 2967 /** 2968 * Contains interfaces for use with the CodeBuild client. 2969 */ 2970 export import Types = CodeBuild; 2971 } 2972 export = CodeBuild;