UNPKG

121 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare 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 * Gets information about one or more builds.
24 */
25 batchGetBuilds(params: CodeBuild.Types.BatchGetBuildsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetBuildsOutput) => void): Request<CodeBuild.Types.BatchGetBuildsOutput, AWSError>;
26 /**
27 * Gets information about one or more builds.
28 */
29 batchGetBuilds(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetBuildsOutput) => void): Request<CodeBuild.Types.BatchGetBuildsOutput, AWSError>;
30 /**
31 * Gets information about one or more build projects.
32 */
33 batchGetProjects(params: CodeBuild.Types.BatchGetProjectsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetProjectsOutput) => void): Request<CodeBuild.Types.BatchGetProjectsOutput, AWSError>;
34 /**
35 * Gets information about one or more build projects.
36 */
37 batchGetProjects(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetProjectsOutput) => void): Request<CodeBuild.Types.BatchGetProjectsOutput, AWSError>;
38 /**
39 * Returns an array of report groups.
40 */
41 batchGetReportGroups(params: CodeBuild.Types.BatchGetReportGroupsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetReportGroupsOutput) => void): Request<CodeBuild.Types.BatchGetReportGroupsOutput, AWSError>;
42 /**
43 * Returns an array of report groups.
44 */
45 batchGetReportGroups(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetReportGroupsOutput) => void): Request<CodeBuild.Types.BatchGetReportGroupsOutput, AWSError>;
46 /**
47 * Returns an array of reports.
48 */
49 batchGetReports(params: CodeBuild.Types.BatchGetReportsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetReportsOutput) => void): Request<CodeBuild.Types.BatchGetReportsOutput, AWSError>;
50 /**
51 * Returns an array of reports.
52 */
53 batchGetReports(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetReportsOutput) => void): Request<CodeBuild.Types.BatchGetReportsOutput, AWSError>;
54 /**
55 * Creates a build project.
56 */
57 createProject(params: CodeBuild.Types.CreateProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.CreateProjectOutput) => void): Request<CodeBuild.Types.CreateProjectOutput, AWSError>;
58 /**
59 * Creates a build project.
60 */
61 createProject(callback?: (err: AWSError, data: CodeBuild.Types.CreateProjectOutput) => void): Request<CodeBuild.Types.CreateProjectOutput, AWSError>;
62 /**
63 * Creates a report group. A report group contains a collection of reports.
64 */
65 createReportGroup(params: CodeBuild.Types.CreateReportGroupInput, callback?: (err: AWSError, data: CodeBuild.Types.CreateReportGroupOutput) => void): Request<CodeBuild.Types.CreateReportGroupOutput, AWSError>;
66 /**
67 * Creates a report group. A report group contains a collection of reports.
68 */
69 createReportGroup(callback?: (err: AWSError, data: CodeBuild.Types.CreateReportGroupOutput) => void): Request<CodeBuild.Types.CreateReportGroupOutput, AWSError>;
70 /**
71 * For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository. If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.
72 */
73 createWebhook(params: CodeBuild.Types.CreateWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.CreateWebhookOutput) => void): Request<CodeBuild.Types.CreateWebhookOutput, AWSError>;
74 /**
75 * For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository. If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.
76 */
77 createWebhook(callback?: (err: AWSError, data: CodeBuild.Types.CreateWebhookOutput) => void): Request<CodeBuild.Types.CreateWebhookOutput, AWSError>;
78 /**
79 * Deletes a build project. When you delete a project, its builds are not deleted.
80 */
81 deleteProject(params: CodeBuild.Types.DeleteProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteProjectOutput) => void): Request<CodeBuild.Types.DeleteProjectOutput, AWSError>;
82 /**
83 * Deletes a build project. When you delete a project, its builds are not deleted.
84 */
85 deleteProject(callback?: (err: AWSError, data: CodeBuild.Types.DeleteProjectOutput) => void): Request<CodeBuild.Types.DeleteProjectOutput, AWSError>;
86 /**
87 * Deletes a report.
88 */
89 deleteReport(params: CodeBuild.Types.DeleteReportInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteReportOutput) => void): Request<CodeBuild.Types.DeleteReportOutput, AWSError>;
90 /**
91 * Deletes a report.
92 */
93 deleteReport(callback?: (err: AWSError, data: CodeBuild.Types.DeleteReportOutput) => void): Request<CodeBuild.Types.DeleteReportOutput, AWSError>;
94 /**
95 * DeleteReportGroup: Deletes a report group. Before you delete a report group, you must delete its reports. Use ListReportsForReportGroup to get the reports in a report group. Use DeleteReport to delete the reports. If you call DeleteReportGroup for a report group that contains one or more reports, an exception is thrown.
96 */
97 deleteReportGroup(params: CodeBuild.Types.DeleteReportGroupInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteReportGroupOutput) => void): Request<CodeBuild.Types.DeleteReportGroupOutput, AWSError>;
98 /**
99 * DeleteReportGroup: Deletes a report group. Before you delete a report group, you must delete its reports. Use ListReportsForReportGroup to get the reports in a report group. Use DeleteReport to delete the reports. If you call DeleteReportGroup for a report group that contains one or more reports, an exception is thrown.
100 */
101 deleteReportGroup(callback?: (err: AWSError, data: CodeBuild.Types.DeleteReportGroupOutput) => void): Request<CodeBuild.Types.DeleteReportGroupOutput, AWSError>;
102 /**
103 * Deletes a resource policy that is identified by its resource ARN.
104 */
105 deleteResourcePolicy(params: CodeBuild.Types.DeleteResourcePolicyInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteResourcePolicyOutput) => void): Request<CodeBuild.Types.DeleteResourcePolicyOutput, AWSError>;
106 /**
107 * Deletes a resource policy that is identified by its resource ARN.
108 */
109 deleteResourcePolicy(callback?: (err: AWSError, data: CodeBuild.Types.DeleteResourcePolicyOutput) => void): Request<CodeBuild.Types.DeleteResourcePolicyOutput, AWSError>;
110 /**
111 * Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
112 */
113 deleteSourceCredentials(params: CodeBuild.Types.DeleteSourceCredentialsInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteSourceCredentialsOutput) => void): Request<CodeBuild.Types.DeleteSourceCredentialsOutput, AWSError>;
114 /**
115 * Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
116 */
117 deleteSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.DeleteSourceCredentialsOutput) => void): Request<CodeBuild.Types.DeleteSourceCredentialsOutput, AWSError>;
118 /**
119 * For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository.
120 */
121 deleteWebhook(params: CodeBuild.Types.DeleteWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteWebhookOutput) => void): Request<CodeBuild.Types.DeleteWebhookOutput, AWSError>;
122 /**
123 * For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository.
124 */
125 deleteWebhook(callback?: (err: AWSError, data: CodeBuild.Types.DeleteWebhookOutput) => void): Request<CodeBuild.Types.DeleteWebhookOutput, AWSError>;
126 /**
127 * Returns a list of details about test cases for a report.
128 */
129 describeTestCases(params: CodeBuild.Types.DescribeTestCasesInput, callback?: (err: AWSError, data: CodeBuild.Types.DescribeTestCasesOutput) => void): Request<CodeBuild.Types.DescribeTestCasesOutput, AWSError>;
130 /**
131 * Returns a list of details about test cases for a report.
132 */
133 describeTestCases(callback?: (err: AWSError, data: CodeBuild.Types.DescribeTestCasesOutput) => void): Request<CodeBuild.Types.DescribeTestCasesOutput, AWSError>;
134 /**
135 * Gets a resource policy that is identified by its resource ARN.
136 */
137 getResourcePolicy(params: CodeBuild.Types.GetResourcePolicyInput, callback?: (err: AWSError, data: CodeBuild.Types.GetResourcePolicyOutput) => void): Request<CodeBuild.Types.GetResourcePolicyOutput, AWSError>;
138 /**
139 * Gets a resource policy that is identified by its resource ARN.
140 */
141 getResourcePolicy(callback?: (err: AWSError, data: CodeBuild.Types.GetResourcePolicyOutput) => void): Request<CodeBuild.Types.GetResourcePolicyOutput, AWSError>;
142 /**
143 * Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
144 */
145 importSourceCredentials(params: CodeBuild.Types.ImportSourceCredentialsInput, callback?: (err: AWSError, data: CodeBuild.Types.ImportSourceCredentialsOutput) => void): Request<CodeBuild.Types.ImportSourceCredentialsOutput, AWSError>;
146 /**
147 * Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
148 */
149 importSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.ImportSourceCredentialsOutput) => void): Request<CodeBuild.Types.ImportSourceCredentialsOutput, AWSError>;
150 /**
151 * Resets the cache for a project.
152 */
153 invalidateProjectCache(params: CodeBuild.Types.InvalidateProjectCacheInput, callback?: (err: AWSError, data: CodeBuild.Types.InvalidateProjectCacheOutput) => void): Request<CodeBuild.Types.InvalidateProjectCacheOutput, AWSError>;
154 /**
155 * Resets the cache for a project.
156 */
157 invalidateProjectCache(callback?: (err: AWSError, data: CodeBuild.Types.InvalidateProjectCacheOutput) => void): Request<CodeBuild.Types.InvalidateProjectCacheOutput, AWSError>;
158 /**
159 * Gets a list of build IDs, with each build ID representing a single build.
160 */
161 listBuilds(params: CodeBuild.Types.ListBuildsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsOutput) => void): Request<CodeBuild.Types.ListBuildsOutput, AWSError>;
162 /**
163 * Gets a list of build IDs, with each build ID representing a single build.
164 */
165 listBuilds(callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsOutput) => void): Request<CodeBuild.Types.ListBuildsOutput, AWSError>;
166 /**
167 * Gets a list of build IDs for the specified build project, with each build ID representing a single build.
168 */
169 listBuildsForProject(params: CodeBuild.Types.ListBuildsForProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsForProjectOutput) => void): Request<CodeBuild.Types.ListBuildsForProjectOutput, AWSError>;
170 /**
171 * Gets a list of build IDs for the specified build project, with each build ID representing a single build.
172 */
173 listBuildsForProject(callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsForProjectOutput) => void): Request<CodeBuild.Types.ListBuildsForProjectOutput, AWSError>;
174 /**
175 * Gets information about Docker images that are managed by AWS CodeBuild.
176 */
177 listCuratedEnvironmentImages(params: CodeBuild.Types.ListCuratedEnvironmentImagesInput, callback?: (err: AWSError, data: CodeBuild.Types.ListCuratedEnvironmentImagesOutput) => void): Request<CodeBuild.Types.ListCuratedEnvironmentImagesOutput, AWSError>;
178 /**
179 * Gets information about Docker images that are managed by AWS CodeBuild.
180 */
181 listCuratedEnvironmentImages(callback?: (err: AWSError, data: CodeBuild.Types.ListCuratedEnvironmentImagesOutput) => void): Request<CodeBuild.Types.ListCuratedEnvironmentImagesOutput, AWSError>;
182 /**
183 * Gets a list of build project names, with each build project name representing a single build project.
184 */
185 listProjects(params: CodeBuild.Types.ListProjectsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListProjectsOutput) => void): Request<CodeBuild.Types.ListProjectsOutput, AWSError>;
186 /**
187 * Gets a list of build project names, with each build project name representing a single build project.
188 */
189 listProjects(callback?: (err: AWSError, data: CodeBuild.Types.ListProjectsOutput) => void): Request<CodeBuild.Types.ListProjectsOutput, AWSError>;
190 /**
191 * Gets a list ARNs for the report groups in the current AWS account.
192 */
193 listReportGroups(params: CodeBuild.Types.ListReportGroupsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListReportGroupsOutput) => void): Request<CodeBuild.Types.ListReportGroupsOutput, AWSError>;
194 /**
195 * Gets a list ARNs for the report groups in the current AWS account.
196 */
197 listReportGroups(callback?: (err: AWSError, data: CodeBuild.Types.ListReportGroupsOutput) => void): Request<CodeBuild.Types.ListReportGroupsOutput, AWSError>;
198 /**
199 * Returns a list of ARNs for the reports in the current AWS account.
200 */
201 listReports(params: CodeBuild.Types.ListReportsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListReportsOutput) => void): Request<CodeBuild.Types.ListReportsOutput, AWSError>;
202 /**
203 * Returns a list of ARNs for the reports in the current AWS account.
204 */
205 listReports(callback?: (err: AWSError, data: CodeBuild.Types.ListReportsOutput) => void): Request<CodeBuild.Types.ListReportsOutput, AWSError>;
206 /**
207 * Returns a list of ARNs for the reports that belong to a ReportGroup.
208 */
209 listReportsForReportGroup(params: CodeBuild.Types.ListReportsForReportGroupInput, callback?: (err: AWSError, data: CodeBuild.Types.ListReportsForReportGroupOutput) => void): Request<CodeBuild.Types.ListReportsForReportGroupOutput, AWSError>;
210 /**
211 * Returns a list of ARNs for the reports that belong to a ReportGroup.
212 */
213 listReportsForReportGroup(callback?: (err: AWSError, data: CodeBuild.Types.ListReportsForReportGroupOutput) => void): Request<CodeBuild.Types.ListReportsForReportGroupOutput, AWSError>;
214 /**
215 * Gets a list of projects that are shared with other AWS accounts or users.
216 */
217 listSharedProjects(params: CodeBuild.Types.ListSharedProjectsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListSharedProjectsOutput) => void): Request<CodeBuild.Types.ListSharedProjectsOutput, AWSError>;
218 /**
219 * Gets a list of projects that are shared with other AWS accounts or users.
220 */
221 listSharedProjects(callback?: (err: AWSError, data: CodeBuild.Types.ListSharedProjectsOutput) => void): Request<CodeBuild.Types.ListSharedProjectsOutput, AWSError>;
222 /**
223 * Gets a list of report groups that are shared with other AWS accounts or users.
224 */
225 listSharedReportGroups(params: CodeBuild.Types.ListSharedReportGroupsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListSharedReportGroupsOutput) => void): Request<CodeBuild.Types.ListSharedReportGroupsOutput, AWSError>;
226 /**
227 * Gets a list of report groups that are shared with other AWS accounts or users.
228 */
229 listSharedReportGroups(callback?: (err: AWSError, data: CodeBuild.Types.ListSharedReportGroupsOutput) => void): Request<CodeBuild.Types.ListSharedReportGroupsOutput, AWSError>;
230 /**
231 * Returns a list of SourceCredentialsInfo objects.
232 */
233 listSourceCredentials(params: CodeBuild.Types.ListSourceCredentialsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListSourceCredentialsOutput) => void): Request<CodeBuild.Types.ListSourceCredentialsOutput, AWSError>;
234 /**
235 * Returns a list of SourceCredentialsInfo objects.
236 */
237 listSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.ListSourceCredentialsOutput) => void): Request<CodeBuild.Types.ListSourceCredentialsOutput, AWSError>;
238 /**
239 * Stores a resource policy for the ARN of a Project or ReportGroup object.
240 */
241 putResourcePolicy(params: CodeBuild.Types.PutResourcePolicyInput, callback?: (err: AWSError, data: CodeBuild.Types.PutResourcePolicyOutput) => void): Request<CodeBuild.Types.PutResourcePolicyOutput, AWSError>;
242 /**
243 * Stores a resource policy for the ARN of a Project or ReportGroup object.
244 */
245 putResourcePolicy(callback?: (err: AWSError, data: CodeBuild.Types.PutResourcePolicyOutput) => void): Request<CodeBuild.Types.PutResourcePolicyOutput, AWSError>;
246 /**
247 * Starts running a build.
248 */
249 startBuild(params: CodeBuild.Types.StartBuildInput, callback?: (err: AWSError, data: CodeBuild.Types.StartBuildOutput) => void): Request<CodeBuild.Types.StartBuildOutput, AWSError>;
250 /**
251 * Starts running a build.
252 */
253 startBuild(callback?: (err: AWSError, data: CodeBuild.Types.StartBuildOutput) => void): Request<CodeBuild.Types.StartBuildOutput, AWSError>;
254 /**
255 * Attempts to stop running a build.
256 */
257 stopBuild(params: CodeBuild.Types.StopBuildInput, callback?: (err: AWSError, data: CodeBuild.Types.StopBuildOutput) => void): Request<CodeBuild.Types.StopBuildOutput, AWSError>;
258 /**
259 * Attempts to stop running a build.
260 */
261 stopBuild(callback?: (err: AWSError, data: CodeBuild.Types.StopBuildOutput) => void): Request<CodeBuild.Types.StopBuildOutput, AWSError>;
262 /**
263 * Changes the settings of a build project.
264 */
265 updateProject(params: CodeBuild.Types.UpdateProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectOutput) => void): Request<CodeBuild.Types.UpdateProjectOutput, AWSError>;
266 /**
267 * Changes the settings of a build project.
268 */
269 updateProject(callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectOutput) => void): Request<CodeBuild.Types.UpdateProjectOutput, AWSError>;
270 /**
271 * Updates a report group.
272 */
273 updateReportGroup(params: CodeBuild.Types.UpdateReportGroupInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateReportGroupOutput) => void): Request<CodeBuild.Types.UpdateReportGroupOutput, AWSError>;
274 /**
275 * Updates a report group.
276 */
277 updateReportGroup(callback?: (err: AWSError, data: CodeBuild.Types.UpdateReportGroupOutput) => void): Request<CodeBuild.Types.UpdateReportGroupOutput, AWSError>;
278 /**
279 * Updates the webhook associated with an AWS CodeBuild build project. If you use Bitbucket for your repository, rotateSecret is ignored.
280 */
281 updateWebhook(params: CodeBuild.Types.UpdateWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateWebhookOutput) => void): Request<CodeBuild.Types.UpdateWebhookOutput, AWSError>;
282 /**
283 * Updates the webhook associated with an AWS CodeBuild build project. If you use Bitbucket for your repository, rotateSecret is ignored.
284 */
285 updateWebhook(callback?: (err: AWSError, data: CodeBuild.Types.UpdateWebhookOutput) => void): Request<CodeBuild.Types.UpdateWebhookOutput, AWSError>;
286}
287declare namespace CodeBuild {
288 export type ArtifactNamespace = "NONE"|"BUILD_ID"|string;
289 export type ArtifactPackaging = "NONE"|"ZIP"|string;
290 export type ArtifactsType = "CODEPIPELINE"|"S3"|"NO_ARTIFACTS"|string;
291 export type AuthType = "OAUTH"|"BASIC_AUTH"|"PERSONAL_ACCESS_TOKEN"|string;
292 export interface BatchDeleteBuildsInput {
293 /**
294 * The IDs of the builds to delete.
295 */
296 ids: BuildIds;
297 }
298 export interface BatchDeleteBuildsOutput {
299 /**
300 * The IDs of the builds that were successfully deleted.
301 */
302 buildsDeleted?: BuildIds;
303 /**
304 * Information about any builds that could not be successfully deleted.
305 */
306 buildsNotDeleted?: BuildsNotDeleted;
307 }
308 export interface BatchGetBuildsInput {
309 /**
310 * The IDs of the builds.
311 */
312 ids: BuildIds;
313 }
314 export interface BatchGetBuildsOutput {
315 /**
316 * Information about the requested builds.
317 */
318 builds?: Builds;
319 /**
320 * The IDs of builds for which information could not be found.
321 */
322 buildsNotFound?: BuildIds;
323 }
324 export interface BatchGetProjectsInput {
325 /**
326 * The names or ARNs of the build projects. To get information about a project shared with your AWS account, its ARN must be specified. You cannot specify a shared project using its name.
327 */
328 names: ProjectNames;
329 }
330 export interface BatchGetProjectsOutput {
331 /**
332 * Information about the requested build projects.
333 */
334 projects?: Projects;
335 /**
336 * The names of build projects for which information could not be found.
337 */
338 projectsNotFound?: ProjectNames;
339 }
340 export interface BatchGetReportGroupsInput {
341 /**
342 * An array of report group ARNs that identify the report groups to return.
343 */
344 reportGroupArns: ReportGroupArns;
345 }
346 export interface BatchGetReportGroupsOutput {
347 /**
348 * The array of report groups returned by BatchGetReportGroups.
349 */
350 reportGroups?: ReportGroups;
351 /**
352 * An array of ARNs passed to BatchGetReportGroups that are not associated with a ReportGroup.
353 */
354 reportGroupsNotFound?: ReportGroupArns;
355 }
356 export interface BatchGetReportsInput {
357 /**
358 * An array of ARNs that identify the Report objects to return.
359 */
360 reportArns: ReportArns;
361 }
362 export interface BatchGetReportsOutput {
363 /**
364 * The array of Report objects returned by BatchGetReports.
365 */
366 reports?: Reports;
367 /**
368 * An array of ARNs passed to BatchGetReportGroups that are not associated with a Report.
369 */
370 reportsNotFound?: ReportArns;
371 }
372 export type Boolean = boolean;
373 export interface Build {
374 /**
375 * The unique ID for the build.
376 */
377 id?: NonEmptyString;
378 /**
379 * The Amazon Resource Name (ARN) of the build.
380 */
381 arn?: NonEmptyString;
382 /**
383 * 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.
384 */
385 buildNumber?: WrapperLong;
386 /**
387 * When the build process started, expressed in Unix time format.
388 */
389 startTime?: Timestamp;
390 /**
391 * When the build process ended, expressed in Unix time format.
392 */
393 endTime?: Timestamp;
394 /**
395 * The current build phase.
396 */
397 currentPhase?: String;
398 /**
399 * 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.
400 */
401 buildStatus?: StatusType;
402 /**
403 * Any version identifier for the version of the source code to be built. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence. For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
404 */
405 sourceVersion?: NonEmptyString;
406 /**
407 * An identifier for the version of this build's source code. For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. For AWS CodePipeline, the source revision provided by AWS CodePipeline. For Amazon Simple Storage Service (Amazon S3), this does not apply.
408 */
409 resolvedSourceVersion?: NonEmptyString;
410 /**
411 * The name of the AWS CodeBuild project.
412 */
413 projectName?: NonEmptyString;
414 /**
415 * Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
416 */
417 phases?: BuildPhases;
418 /**
419 * Information about the source code to be built.
420 */
421 source?: ProjectSource;
422 /**
423 * An array of ProjectSource objects.
424 */
425 secondarySources?: ProjectSources;
426 /**
427 * An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of: For AWS CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.
428 */
429 secondarySourceVersions?: ProjectSecondarySourceVersions;
430 /**
431 * Information about the output artifacts for the build.
432 */
433 artifacts?: BuildArtifacts;
434 /**
435 * An array of ProjectArtifacts objects.
436 */
437 secondaryArtifacts?: BuildArtifactsList;
438 /**
439 * Information about the cache for the build.
440 */
441 cache?: ProjectCache;
442 /**
443 * Information about the build environment for this build.
444 */
445 environment?: ProjectEnvironment;
446 /**
447 * The name of a service role used for this build.
448 */
449 serviceRole?: NonEmptyString;
450 /**
451 * Information about the build's logs in Amazon CloudWatch Logs.
452 */
453 logs?: LogsLocation;
454 /**
455 * How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.
456 */
457 timeoutInMinutes?: WrapperInt;
458 /**
459 * The number of minutes a build is allowed to be queued before it times out.
460 */
461 queuedTimeoutInMinutes?: WrapperInt;
462 /**
463 * Whether the build is complete. True if complete; otherwise, false.
464 */
465 buildComplete?: Boolean;
466 /**
467 * The entity that started the build. Valid values include: If AWS CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline). If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example, MyUserName). If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
468 */
469 initiator?: String;
470 /**
471 * If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
472 */
473 vpcConfig?: VpcConfig;
474 /**
475 * Describes a network interface.
476 */
477 networkInterface?: NetworkInterface;
478 /**
479 * The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).
480 */
481 encryptionKey?: NonEmptyString;
482 /**
483 * A list of exported environment variables for this build.
484 */
485 exportedEnvironmentVariables?: ExportedEnvironmentVariables;
486 /**
487 * An array of the ARNs associated with this build's reports.
488 */
489 reportArns?: BuildReportArns;
490 /**
491 * 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.
492 */
493 fileSystemLocations?: ProjectFileSystemLocations;
494 }
495 export interface BuildArtifacts {
496 /**
497 * Information about the location of the build artifacts.
498 */
499 location?: String;
500 /**
501 * 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.
502 */
503 sha256sum?: String;
504 /**
505 * 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.
506 */
507 md5sum?: String;
508 /**
509 * 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.
510 */
511 overrideArtifactName?: WrapperBoolean;
512 /**
513 * Information that tells you if encryption for build artifacts is disabled.
514 */
515 encryptionDisabled?: WrapperBoolean;
516 /**
517 * An identifier for this artifact definition.
518 */
519 artifactIdentifier?: String;
520 }
521 export type BuildArtifactsList = BuildArtifacts[];
522 export type BuildIds = NonEmptyString[];
523 export interface BuildNotDeleted {
524 /**
525 * The ID of the build that could not be successfully deleted.
526 */
527 id?: NonEmptyString;
528 /**
529 * Additional information about the build that could not be successfully deleted.
530 */
531 statusCode?: String;
532 }
533 export interface BuildPhase {
534 /**
535 * 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.
536 */
537 phaseType?: BuildPhaseType;
538 /**
539 * 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. QUEUED: The build has been submitted and is queued behind other submitted builds. STOPPED: The build phase stopped. SUCCEEDED: The build phase succeeded. TIMED_OUT: The build phase timed out.
540 */
541 phaseStatus?: StatusType;
542 /**
543 * When the build phase started, expressed in Unix time format.
544 */
545 startTime?: Timestamp;
546 /**
547 * When the build phase ended, expressed in Unix time format.
548 */
549 endTime?: Timestamp;
550 /**
551 * How long, in seconds, between the starting and ending times of the build's phase.
552 */
553 durationInSeconds?: WrapperLong;
554 /**
555 * Additional information about a build phase, especially to help troubleshoot a failed build.
556 */
557 contexts?: PhaseContexts;
558 }
559 export type BuildPhaseType = "SUBMITTED"|"QUEUED"|"PROVISIONING"|"DOWNLOAD_SOURCE"|"INSTALL"|"PRE_BUILD"|"BUILD"|"POST_BUILD"|"UPLOAD_ARTIFACTS"|"FINALIZING"|"COMPLETED"|string;
560 export type BuildPhases = BuildPhase[];
561 export type BuildReportArns = String[];
562 export type Builds = Build[];
563 export type BuildsNotDeleted = BuildNotDeleted[];
564 export type CacheMode = "LOCAL_DOCKER_LAYER_CACHE"|"LOCAL_SOURCE_CACHE"|"LOCAL_CUSTOM_CACHE"|string;
565 export type CacheType = "NO_CACHE"|"S3"|"LOCAL"|string;
566 export interface CloudWatchLogsConfig {
567 /**
568 * The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are: ENABLED: Amazon CloudWatch Logs are enabled for this build project. DISABLED: Amazon CloudWatch Logs are not enabled for this build project.
569 */
570 status: LogsConfigStatusType;
571 /**
572 * The group name of the logs in Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
573 */
574 groupName?: String;
575 /**
576 * The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
577 */
578 streamName?: String;
579 }
580 export type ComputeType = "BUILD_GENERAL1_SMALL"|"BUILD_GENERAL1_MEDIUM"|"BUILD_GENERAL1_LARGE"|"BUILD_GENERAL1_2XLARGE"|string;
581 export interface CreateProjectInput {
582 /**
583 * The name of the build project.
584 */
585 name: ProjectName;
586 /**
587 * A description that makes the build project easy to identify.
588 */
589 description?: ProjectDescription;
590 /**
591 * Information about the build input source code for the build project.
592 */
593 source: ProjectSource;
594 /**
595 * An array of ProjectSource objects.
596 */
597 secondarySources?: ProjectSources;
598 /**
599 * A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of: For AWS CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use. If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level). For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
600 */
601 sourceVersion?: String;
602 /**
603 * An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take precedence over these secondarySourceVersions (at the project level).
604 */
605 secondarySourceVersions?: ProjectSecondarySourceVersions;
606 /**
607 * Information about the build output artifacts for the build project.
608 */
609 artifacts: ProjectArtifacts;
610 /**
611 * An array of ProjectArtifacts objects.
612 */
613 secondaryArtifacts?: ProjectArtifactsList;
614 /**
615 * Stores recently used information so that it can be quickly accessed at a later time.
616 */
617 cache?: ProjectCache;
618 /**
619 * Information about the build environment for the build project.
620 */
621 environment: ProjectEnvironment;
622 /**
623 * The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
624 */
625 serviceRole: NonEmptyString;
626 /**
627 * How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.
628 */
629 timeoutInMinutes?: TimeOut;
630 /**
631 * The number of minutes a build is allowed to be queued before it times out.
632 */
633 queuedTimeoutInMinutes?: TimeOut;
634 /**
635 * The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).
636 */
637 encryptionKey?: NonEmptyString;
638 /**
639 * A set of tags for this build project. These tags are available for use by AWS services that support AWS CodeBuild build project tags.
640 */
641 tags?: TagList;
642 /**
643 * VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.
644 */
645 vpcConfig?: VpcConfig;
646 /**
647 * Set this to true to generate a publicly accessible URL for your project's build badge.
648 */
649 badgeEnabled?: WrapperBoolean;
650 /**
651 * Information about logs for the build project. These can be logs in Amazon CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.
652 */
653 logsConfig?: LogsConfig;
654 /**
655 * 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.
656 */
657 fileSystemLocations?: ProjectFileSystemLocations;
658 }
659 export interface CreateProjectOutput {
660 /**
661 * Information about the build project that was created.
662 */
663 project?: Project;
664 }
665 export interface CreateReportGroupInput {
666 /**
667 * The name of the report group.
668 */
669 name: ReportGroupName;
670 /**
671 * The type of report group.
672 */
673 type: ReportType;
674 /**
675 * A ReportExportConfig object that contains information about where the report group test results are exported.
676 */
677 exportConfig: ReportExportConfig;
678 }
679 export interface CreateReportGroupOutput {
680 /**
681 * Information about the report group that was created.
682 */
683 reportGroup?: ReportGroup;
684 }
685 export interface CreateWebhookInput {
686 /**
687 * The name of the AWS CodeBuild project.
688 */
689 projectName: ProjectName;
690 /**
691 * 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.
692 */
693 branchFilter?: String;
694 /**
695 * 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.
696 */
697 filterGroups?: FilterGroups;
698 }
699 export interface CreateWebhookOutput {
700 /**
701 * Information about a webhook that connects repository events to a build project in AWS CodeBuild.
702 */
703 webhook?: Webhook;
704 }
705 export type CredentialProviderType = "SECRETS_MANAGER"|string;
706 export interface DeleteProjectInput {
707 /**
708 * The name of the build project.
709 */
710 name: NonEmptyString;
711 }
712 export interface DeleteProjectOutput {
713 }
714 export interface DeleteReportGroupInput {
715 /**
716 * The ARN of the report group to delete.
717 */
718 arn: NonEmptyString;
719 }
720 export interface DeleteReportGroupOutput {
721 }
722 export interface DeleteReportInput {
723 /**
724 * The ARN of the report to delete.
725 */
726 arn: NonEmptyString;
727 }
728 export interface DeleteReportOutput {
729 }
730 export interface DeleteResourcePolicyInput {
731 /**
732 * The ARN of the resource that is associated with the resource policy.
733 */
734 resourceArn: NonEmptyString;
735 }
736 export interface DeleteResourcePolicyOutput {
737 }
738 export interface DeleteSourceCredentialsInput {
739 /**
740 * The Amazon Resource Name (ARN) of the token.
741 */
742 arn: NonEmptyString;
743 }
744 export interface DeleteSourceCredentialsOutput {
745 /**
746 * The Amazon Resource Name (ARN) of the token.
747 */
748 arn?: NonEmptyString;
749 }
750 export interface DeleteWebhookInput {
751 /**
752 * The name of the AWS CodeBuild project.
753 */
754 projectName: ProjectName;
755 }
756 export interface DeleteWebhookOutput {
757 }
758 export interface DescribeTestCasesInput {
759 /**
760 * The ARN of the report for which test cases are returned.
761 */
762 reportArn: String;
763 /**
764 * 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.
765 */
766 nextToken?: String;
767 /**
768 * 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.
769 */
770 maxResults?: PageSize;
771 /**
772 * A TestCaseFilter object used to filter the returned reports.
773 */
774 filter?: TestCaseFilter;
775 }
776 export interface DescribeTestCasesOutput {
777 /**
778 * 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.
779 */
780 nextToken?: String;
781 /**
782 * The returned list of test cases.
783 */
784 testCases?: TestCases;
785 }
786 export interface EnvironmentImage {
787 /**
788 * The name of the Docker image.
789 */
790 name?: String;
791 /**
792 * The description of the Docker image.
793 */
794 description?: String;
795 /**
796 * A list of environment image versions.
797 */
798 versions?: ImageVersions;
799 }
800 export type EnvironmentImages = EnvironmentImage[];
801 export interface EnvironmentLanguage {
802 /**
803 * The programming language for the Docker images.
804 */
805 language?: LanguageType;
806 /**
807 * The list of Docker images that are related by the specified programming language.
808 */
809 images?: EnvironmentImages;
810 }
811 export type EnvironmentLanguages = EnvironmentLanguage[];
812 export interface EnvironmentPlatform {
813 /**
814 * The platform's name.
815 */
816 platform?: PlatformType;
817 /**
818 * The list of programming languages that are available for the specified platform.
819 */
820 languages?: EnvironmentLanguages;
821 }
822 export type EnvironmentPlatforms = EnvironmentPlatform[];
823 export type EnvironmentType = "WINDOWS_CONTAINER"|"LINUX_CONTAINER"|"LINUX_GPU_CONTAINER"|"ARM_CONTAINER"|string;
824 export interface EnvironmentVariable {
825 /**
826 * The name or key of the environment variable.
827 */
828 name: NonEmptyString;
829 /**
830 * The value of the environment variable. We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.
831 */
832 value: String;
833 /**
834 * The type of environment variable. Valid values include: PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. PLAINTEXT: An environment variable in plain text format. This is the default value. SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager.
835 */
836 type?: EnvironmentVariableType;
837 }
838 export type EnvironmentVariableType = "PLAINTEXT"|"PARAMETER_STORE"|"SECRETS_MANAGER"|string;
839 export type EnvironmentVariables = EnvironmentVariable[];
840 export interface ExportedEnvironmentVariable {
841 /**
842 * The name of this exported environment variable.
843 */
844 name?: NonEmptyString;
845 /**
846 * The value assigned to this exported environment variable. During a build, the value of a variable is available starting with the install phase. It can be updated between the start of the install phase and the end of the post_build phase. After the post_build phase ends, the value of exported variables cannot change.
847 */
848 value?: String;
849 }
850 export type ExportedEnvironmentVariables = ExportedEnvironmentVariable[];
851 export type FileSystemType = "EFS"|string;
852 export type FilterGroup = WebhookFilter[];
853 export type FilterGroups = FilterGroup[];
854 export interface GetResourcePolicyInput {
855 /**
856 * The ARN of the resource that is associated with the resource policy.
857 */
858 resourceArn: NonEmptyString;
859 }
860 export interface GetResourcePolicyOutput {
861 /**
862 * The resource policy for the resource identified by the input ARN parameter.
863 */
864 policy?: NonEmptyString;
865 }
866 export type GitCloneDepth = number;
867 export interface GitSubmodulesConfig {
868 /**
869 * Set to true to fetch Git submodules for your AWS CodeBuild build project.
870 */
871 fetchSubmodules: WrapperBoolean;
872 }
873 export type ImagePullCredentialsType = "CODEBUILD"|"SERVICE_ROLE"|string;
874 export type ImageVersions = String[];
875 export interface ImportSourceCredentialsInput {
876 /**
877 * The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.
878 */
879 username?: NonEmptyString;
880 /**
881 * For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.
882 */
883 token: SensitiveNonEmptyString;
884 /**
885 * The source provider used for this project.
886 */
887 serverType: ServerType;
888 /**
889 * The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the AWS CodeBuild console.
890 */
891 authType: AuthType;
892 /**
893 * Set to false to prevent overwriting the repository source credentials. Set to true to overwrite the repository source credentials. The default value is true.
894 */
895 shouldOverwrite?: WrapperBoolean;
896 }
897 export interface ImportSourceCredentialsOutput {
898 /**
899 * The Amazon Resource Name (ARN) of the token.
900 */
901 arn?: NonEmptyString;
902 }
903 export interface InvalidateProjectCacheInput {
904 /**
905 * The name of the AWS CodeBuild build project that the cache is reset for.
906 */
907 projectName: NonEmptyString;
908 }
909 export interface InvalidateProjectCacheOutput {
910 }
911 export type KeyInput = string;
912 export type LanguageType = "JAVA"|"PYTHON"|"NODE_JS"|"RUBY"|"GOLANG"|"DOCKER"|"ANDROID"|"DOTNET"|"BASE"|"PHP"|string;
913 export interface ListBuildsForProjectInput {
914 /**
915 * The name of the AWS CodeBuild project.
916 */
917 projectName: NonEmptyString;
918 /**
919 * 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.
920 */
921 sortOrder?: SortOrderType;
922 /**
923 * 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.
924 */
925 nextToken?: String;
926 }
927 export interface ListBuildsForProjectOutput {
928 /**
929 * A list of build IDs for the specified build project, with each build ID representing a single build.
930 */
931 ids?: BuildIds;
932 /**
933 * 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.
934 */
935 nextToken?: String;
936 }
937 export interface ListBuildsInput {
938 /**
939 * 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.
940 */
941 sortOrder?: SortOrderType;
942 /**
943 * 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.
944 */
945 nextToken?: String;
946 }
947 export interface ListBuildsOutput {
948 /**
949 * A list of build IDs, with each build ID representing a single build.
950 */
951 ids?: BuildIds;
952 /**
953 * 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.
954 */
955 nextToken?: String;
956 }
957 export interface ListCuratedEnvironmentImagesInput {
958 }
959 export interface ListCuratedEnvironmentImagesOutput {
960 /**
961 * Information about supported platforms for Docker images that are managed by AWS CodeBuild.
962 */
963 platforms?: EnvironmentPlatforms;
964 }
965 export interface ListProjectsInput {
966 /**
967 * 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.
968 */
969 sortBy?: ProjectSortByType;
970 /**
971 * 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.
972 */
973 sortOrder?: SortOrderType;
974 /**
975 * 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.
976 */
977 nextToken?: NonEmptyString;
978 }
979 export interface ListProjectsOutput {
980 /**
981 * 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.
982 */
983 nextToken?: String;
984 /**
985 * The list of build project names, with each build project name representing a single build project.
986 */
987 projects?: ProjectNames;
988 }
989 export interface ListReportGroupsInput {
990 /**
991 * Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.
992 */
993 sortOrder?: SortOrderType;
994 /**
995 * 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.
996 */
997 sortBy?: ReportGroupSortByType;
998 /**
999 * 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.
1000 */
1001 nextToken?: String;
1002 /**
1003 * 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.
1004 */
1005 maxResults?: PageSize;
1006 }
1007 export interface ListReportGroupsOutput {
1008 /**
1009 * 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.
1010 */
1011 nextToken?: String;
1012 /**
1013 * The list of ARNs for the report groups in the current AWS account.
1014 */
1015 reportGroups?: ReportGroupArns;
1016 }
1017 export interface ListReportsForReportGroupInput {
1018 /**
1019 * The ARN of the report group for which you want to return report ARNs.
1020 */
1021 reportGroupArn: String;
1022 /**
1023 * 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.
1024 */
1025 nextToken?: String;
1026 /**
1027 * Use to specify whether the results are returned in ascending or descending order.
1028 */
1029 sortOrder?: SortOrderType;
1030 /**
1031 * 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.
1032 */
1033 maxResults?: PageSize;
1034 /**
1035 * A ReportFilter object used to filter the returned reports.
1036 */
1037 filter?: ReportFilter;
1038 }
1039 export interface ListReportsForReportGroupOutput {
1040 /**
1041 * 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.
1042 */
1043 nextToken?: String;
1044 /**
1045 * The list of returned report group ARNs.
1046 */
1047 reports?: ReportArns;
1048 }
1049 export interface ListReportsInput {
1050 /**
1051 * 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.
1052 */
1053 sortOrder?: SortOrderType;
1054 /**
1055 * 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.
1056 */
1057 nextToken?: String;
1058 /**
1059 * 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.
1060 */
1061 maxResults?: PageSize;
1062 /**
1063 * A ReportFilter object used to filter the returned reports.
1064 */
1065 filter?: ReportFilter;
1066 }
1067 export interface ListReportsOutput {
1068 /**
1069 * 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.
1070 */
1071 nextToken?: String;
1072 /**
1073 * The list of returned ARNs for the reports in the current AWS account.
1074 */
1075 reports?: ReportArns;
1076 }
1077 export interface ListSharedProjectsInput {
1078 /**
1079 * The criterion to be used to list build projects shared with the current AWS account or user. Valid values include: ARN: List based on the ARN. MODIFIED_TIME: List based on when information about the shared project was last changed.
1080 */
1081 sortBy?: SharedResourceSortByType;
1082 /**
1083 * The order in which to list shared build projects. Valid values include: ASCENDING: List in ascending order. DESCENDING: List in descending order.
1084 */
1085 sortOrder?: SortOrderType;
1086 /**
1087 * 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.
1088 */
1089 maxResults?: PageSize;
1090 /**
1091 * 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.
1092 */
1093 nextToken?: NonEmptyString;
1094 }
1095 export interface ListSharedProjectsOutput {
1096 /**
1097 * 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.
1098 */
1099 nextToken?: String;
1100 /**
1101 * The list of ARNs for the build projects shared with the current AWS account or user.
1102 */
1103 projects?: ProjectArns;
1104 }
1105 export interface ListSharedReportGroupsInput {
1106 /**
1107 * The order in which to list shared report groups. Valid values include: ASCENDING: List in ascending order. DESCENDING: List in descending order.
1108 */
1109 sortOrder?: SortOrderType;
1110 /**
1111 * The criterion to be used to list report groups shared with the current AWS account or user. Valid values include: ARN: List based on the ARN. MODIFIED_TIME: List based on when information about the shared report group was last changed.
1112 */
1113 sortBy?: SharedResourceSortByType;
1114 /**
1115 * 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.
1116 */
1117 nextToken?: String;
1118 /**
1119 * 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.
1120 */
1121 maxResults?: PageSize;
1122 }
1123 export interface ListSharedReportGroupsOutput {
1124 /**
1125 * 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.
1126 */
1127 nextToken?: String;
1128 /**
1129 * The list of ARNs for the report groups shared with the current AWS account or user.
1130 */
1131 reportGroups?: ReportGroupArns;
1132 }
1133 export interface ListSourceCredentialsInput {
1134 }
1135 export interface ListSourceCredentialsOutput {
1136 /**
1137 * A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials.
1138 */
1139 sourceCredentialsInfos?: SourceCredentialsInfos;
1140 }
1141 export interface LogsConfig {
1142 /**
1143 * Information about Amazon CloudWatch Logs for a build project. Amazon CloudWatch Logs are enabled by default.
1144 */
1145 cloudWatchLogs?: CloudWatchLogsConfig;
1146 /**
1147 * Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.
1148 */
1149 s3Logs?: S3LogsConfig;
1150 }
1151 export type LogsConfigStatusType = "ENABLED"|"DISABLED"|string;
1152 export interface LogsLocation {
1153 /**
1154 * The name of the Amazon CloudWatch Logs group for the build logs.
1155 */
1156 groupName?: String;
1157 /**
1158 * The name of the Amazon CloudWatch Logs stream for the build logs.
1159 */
1160 streamName?: String;
1161 /**
1162 * The URL to an individual build log in Amazon CloudWatch Logs.
1163 */
1164 deepLink?: String;
1165 /**
1166 * The URL to a build log in an S3 bucket.
1167 */
1168 s3DeepLink?: String;
1169 /**
1170 * The ARN of Amazon CloudWatch Logs for a build project. Its format is arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}. For more information, see Resources Defined by Amazon CloudWatch Logs.
1171 */
1172 cloudWatchLogsArn?: String;
1173 /**
1174 * 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.
1175 */
1176 s3LogsArn?: String;
1177 /**
1178 * Information about Amazon CloudWatch Logs for a build project.
1179 */
1180 cloudWatchLogs?: CloudWatchLogsConfig;
1181 /**
1182 * Information about S3 logs for a build project.
1183 */
1184 s3Logs?: S3LogsConfig;
1185 }
1186 export interface NetworkInterface {
1187 /**
1188 * The ID of the subnet.
1189 */
1190 subnetId?: NonEmptyString;
1191 /**
1192 * The ID of the network interface.
1193 */
1194 networkInterfaceId?: NonEmptyString;
1195 }
1196 export type NonEmptyString = string;
1197 export type PageSize = number;
1198 export interface PhaseContext {
1199 /**
1200 * The status code for the context of the build phase.
1201 */
1202 statusCode?: String;
1203 /**
1204 * An explanation of the build phase's context. This might include a command ID and an exit code.
1205 */
1206 message?: String;
1207 }
1208 export type PhaseContexts = PhaseContext[];
1209 export type PlatformType = "DEBIAN"|"AMAZON_LINUX"|"UBUNTU"|"WINDOWS_SERVER"|string;
1210 export interface Project {
1211 /**
1212 * The name of the build project.
1213 */
1214 name?: ProjectName;
1215 /**
1216 * The Amazon Resource Name (ARN) of the build project.
1217 */
1218 arn?: String;
1219 /**
1220 * A description that makes the build project easy to identify.
1221 */
1222 description?: ProjectDescription;
1223 /**
1224 * Information about the build input source code for this build project.
1225 */
1226 source?: ProjectSource;
1227 /**
1228 * An array of ProjectSource objects.
1229 */
1230 secondarySources?: ProjectSources;
1231 /**
1232 * A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of: For AWS CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use. If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level). For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
1233 */
1234 sourceVersion?: String;
1235 /**
1236 * An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
1237 */
1238 secondarySourceVersions?: ProjectSecondarySourceVersions;
1239 /**
1240 * Information about the build output artifacts for the build project.
1241 */
1242 artifacts?: ProjectArtifacts;
1243 /**
1244 * An array of ProjectArtifacts objects.
1245 */
1246 secondaryArtifacts?: ProjectArtifactsList;
1247 /**
1248 * Information about the cache for the build project.
1249 */
1250 cache?: ProjectCache;
1251 /**
1252 * Information about the build environment for this build project.
1253 */
1254 environment?: ProjectEnvironment;
1255 /**
1256 * The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
1257 */
1258 serviceRole?: NonEmptyString;
1259 /**
1260 * How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
1261 */
1262 timeoutInMinutes?: TimeOut;
1263 /**
1264 * The number of minutes a build is allowed to be queued before it times out.
1265 */
1266 queuedTimeoutInMinutes?: TimeOut;
1267 /**
1268 * The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).
1269 */
1270 encryptionKey?: NonEmptyString;
1271 /**
1272 * The tags for this build project. These tags are available for use by AWS services that support AWS CodeBuild build project tags.
1273 */
1274 tags?: TagList;
1275 /**
1276 * When the build project was created, expressed in Unix time format.
1277 */
1278 created?: Timestamp;
1279 /**
1280 * When the build project's settings were last modified, expressed in Unix time format.
1281 */
1282 lastModified?: Timestamp;
1283 /**
1284 * Information about a webhook that connects repository events to a build project in AWS CodeBuild.
1285 */
1286 webhook?: Webhook;
1287 /**
1288 * Information about the VPC configuration that AWS CodeBuild accesses.
1289 */
1290 vpcConfig?: VpcConfig;
1291 /**
1292 * Information about the build badge for the build project.
1293 */
1294 badge?: ProjectBadge;
1295 /**
1296 * Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.
1297 */
1298 logsConfig?: LogsConfig;
1299 /**
1300 * 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.
1301 */
1302 fileSystemLocations?: ProjectFileSystemLocations;
1303 }
1304 export type ProjectArns = NonEmptyString[];
1305 export interface ProjectArtifacts {
1306 /**
1307 * The type of build output artifact. Valid values include: CODEPIPELINE: The build project has build output generated through AWS CodePipeline. The CODEPIPELINE type is not supported for secondaryArtifacts. NO_ARTIFACTS: The build project does not produce any build output. S3: The build project stores build output in Amazon Simple Storage Service (Amazon S3).
1308 */
1309 type: ArtifactsType;
1310 /**
1311 * Information about the build output artifact location: If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild. If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If type is set to S3, this is the name of the output bucket.
1312 */
1313 location?: String;
1314 /**
1315 * Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact: If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used. For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.
1316 */
1317 path?: String;
1318 /**
1319 * Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact: If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If type is set to S3, valid values include: BUILD_ID: Include the build ID in the location of the build output artifact. NONE: Do not include the build ID. This is the default if namespaceType is not specified. For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip.
1320 */
1321 namespaceType?: ArtifactNamespace;
1322 /**
1323 * Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact: If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket. For example: If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip. If path is empty, namespaceType is set to NONE, and name is set to "/", the output artifact is stored in the root of the output bucket. If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "/", the output artifact is stored in MyArtifacts/build-ID .
1324 */
1325 name?: String;
1326 /**
1327 * The type of build output artifact to create: If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild. If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If type is set to S3, valid values include: NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified. ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.
1328 */
1329 packaging?: ArtifactPackaging;
1330 /**
1331 * 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.
1332 */
1333 overrideArtifactName?: WrapperBoolean;
1334 /**
1335 * Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown.
1336 */
1337 encryptionDisabled?: WrapperBoolean;
1338 /**
1339 * An identifier for this artifact definition.
1340 */
1341 artifactIdentifier?: String;
1342 }
1343 export type ProjectArtifactsList = ProjectArtifacts[];
1344 export interface ProjectBadge {
1345 /**
1346 * Set this to true to generate a publicly accessible URL for your project's build badge.
1347 */
1348 badgeEnabled?: Boolean;
1349 /**
1350 * The publicly-accessible URL through which you can access the build badge for your project. The publicly accessible URL through which you can access the build badge for your project.
1351 */
1352 badgeRequestUrl?: String;
1353 }
1354 export interface ProjectCache {
1355 /**
1356 * 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.
1357 */
1358 type: CacheType;
1359 /**
1360 * Information about the cache location: NO_CACHE or LOCAL: This value is ignored. S3: This is the S3 bucket name/prefix.
1361 */
1362 location?: String;
1363 /**
1364 * If you use a LOCAL cache, the local cache mode. You can use one or more local cache modes at the same time. LOCAL_SOURCE_CACHE mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored. LOCAL_DOCKER_LAYER_CACHE mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network. You can use a Docker layer cache in the Linux environment only. The privileged flag must be set so that your project has the required Docker permissions. You should consider the security implications before you use a Docker layer cache. LOCAL_CUSTOM_CACHE mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache: Only directories can be specified for caching. You cannot specify individual files. Symlinks are used to reference cached directories. Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.
1365 */
1366 modes?: ProjectCacheModes;
1367 }
1368 export type ProjectCacheModes = CacheMode[];
1369 export type ProjectDescription = string;
1370 export interface ProjectEnvironment {
1371 /**
1372 * 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 (N. Virginia), 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 (N. Virginia), 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).
1373 */
1374 type: EnvironmentType;
1375 /**
1376 * The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats: For an image tag: registry/repository:tag. For example, to specify an image with the tag "latest," use registry/repository:latest. For an image digest: registry/repository@digest. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
1377 */
1378 image: NonEmptyString;
1379 /**
1380 * Information about the compute resources the build project uses. Available values include: BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds. BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds. BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type. BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed. If you use BUILD_GENERAL1_LARGE: For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds. For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds. For more information, see Build Environment Compute Types in the AWS CodeBuild User Guide.
1381 */
1382 computeType: ComputeType;
1383 /**
1384 * A set of environment variables to make available to builds for this build project.
1385 */
1386 environmentVariables?: EnvironmentVariables;
1387 /**
1388 * 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&amp; - 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&amp; - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"
1389 */
1390 privilegedMode?: WrapperBoolean;
1391 /**
1392 * The certificate to use with this build project.
1393 */
1394 certificate?: String;
1395 /**
1396 * The credentials for access to a private registry.
1397 */
1398 registryCredential?: RegistryCredential;
1399 /**
1400 * The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role. When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.
1401 */
1402 imagePullCredentialsType?: ImagePullCredentialsType;
1403 }
1404 export interface ProjectFileSystemLocation {
1405 /**
1406 * The type of the file system. The one supported type is EFS.
1407 */
1408 type?: FileSystemType;
1409 /**
1410 * A string that specifies the location of the file system created by Amazon EFS. Its format is efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the AWS EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory is my-efs-mount-directory, then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory. The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.
1411 */
1412 location?: String;
1413 /**
1414 * The location in the container where you mount the file system.
1415 */
1416 mountPoint?: String;
1417 /**
1418 * 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.
1419 */
1420 identifier?: String;
1421 /**
1422 * The mount options for a file system created by AWS EFS. The default mount options used by CodeBuild are nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options.
1423 */
1424 mountOptions?: String;
1425 }
1426 export type ProjectFileSystemLocations = ProjectFileSystemLocation[];
1427 export type ProjectName = string;
1428 export type ProjectNames = NonEmptyString[];
1429 export type ProjectSecondarySourceVersions = ProjectSourceVersion[];
1430 export type ProjectSortByType = "NAME"|"CREATED_TIME"|"LAST_MODIFIED_TIME"|string;
1431 export interface ProjectSource {
1432 /**
1433 * The type of repository that contains the source code to be built. Valid values include: BITBUCKET: The source code is in a Bitbucket repository. CODECOMMIT: The source code is in an AWS CodeCommit repository. CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS CodePipeline. GITHUB: The source code is in a GitHub repository. GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise repository. NO_SOURCE: The project does not have input source code. S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
1434 */
1435 type: SourceType;
1436 /**
1437 * Information about the location of the source code to be built. Valid values include: For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value. For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ). For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following. The path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip). The path to the folder that contains the source code (for example, bucket-name/path/to/source-code/folder/). For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH. For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.
1438 */
1439 location?: String;
1440 /**
1441 * Information about the Git clone depth for the build project.
1442 */
1443 gitCloneDepth?: GitCloneDepth;
1444 /**
1445 * Information about the Git submodules configuration for the build project.
1446 */
1447 gitSubmodulesConfig?: GitSubmodulesConfig;
1448 /**
1449 * The buildspec file declaration to use for the builds in this build project. If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
1450 */
1451 buildspec?: String;
1452 /**
1453 * Information about the authorization settings for AWS CodeBuild to access the source code to be built. This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly.
1454 */
1455 auth?: SourceAuth;
1456 /**
1457 * Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown. The status of a build triggered by a webhook is always reported to your source provider.
1458 */
1459 reportBuildStatus?: WrapperBoolean;
1460 /**
1461 * Enable this flag to ignore SSL warnings while connecting to the project source code.
1462 */
1463 insecureSsl?: WrapperBoolean;
1464 /**
1465 * An identifier for this project source.
1466 */
1467 sourceIdentifier?: String;
1468 }
1469 export interface ProjectSourceVersion {
1470 /**
1471 * An identifier for a source in the build project.
1472 */
1473 sourceIdentifier: String;
1474 /**
1475 * The source version for the corresponding source identifier. If specified, must be one of: For AWS CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use. For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
1476 */
1477 sourceVersion: String;
1478 }
1479 export type ProjectSources = ProjectSource[];
1480 export type Projects = Project[];
1481 export interface PutResourcePolicyInput {
1482 /**
1483 * A JSON-formatted resource policy. For more information, see Sharing a Project and Sharing a Report Group in the AWS CodeBuild User Guide.
1484 */
1485 policy: NonEmptyString;
1486 /**
1487 * The ARN of the Project or ReportGroup resource you want to associate with a resource policy.
1488 */
1489 resourceArn: NonEmptyString;
1490 }
1491 export interface PutResourcePolicyOutput {
1492 /**
1493 * The ARN of the Project or ReportGroup resource that is associated with a resource policy.
1494 */
1495 resourceArn?: NonEmptyString;
1496 }
1497 export interface RegistryCredential {
1498 /**
1499 * The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager. The credential can use the name of the credentials only if they exist in your current AWS Region.
1500 */
1501 credential: NonEmptyString;
1502 /**
1503 * The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager.
1504 */
1505 credentialProvider: CredentialProviderType;
1506 }
1507 export interface Report {
1508 /**
1509 * The ARN of the report run.
1510 */
1511 arn?: NonEmptyString;
1512 /**
1513 * The type of the report that was run.
1514 */
1515 type?: ReportType;
1516 /**
1517 * The name of the report that was run.
1518 */
1519 name?: String;
1520 /**
1521 * The ARN of the report group associated with this report.
1522 */
1523 reportGroupArn?: NonEmptyString;
1524 /**
1525 * The ARN of the build run that generated this report.
1526 */
1527 executionId?: String;
1528 /**
1529 * The status of this report.
1530 */
1531 status?: ReportStatusType;
1532 /**
1533 * The date and time this report run occurred.
1534 */
1535 created?: Timestamp;
1536 /**
1537 * 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.
1538 */
1539 expired?: Timestamp;
1540 /**
1541 * Information about where the raw data used to generate this report was exported.
1542 */
1543 exportConfig?: ReportExportConfig;
1544 /**
1545 * 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.
1546 */
1547 truncated?: WrapperBoolean;
1548 /**
1549 * A TestReportSummary object that contains information about this test report.
1550 */
1551 testSummary?: TestReportSummary;
1552 }
1553 export type ReportArns = NonEmptyString[];
1554 export interface ReportExportConfig {
1555 /**
1556 * 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.
1557 */
1558 exportConfigType?: ReportExportConfigType;
1559 /**
1560 * A S3ReportExportConfig object that contains information about the S3 bucket where the run of a report is exported.
1561 */
1562 s3Destination?: S3ReportExportConfig;
1563 }
1564 export type ReportExportConfigType = "S3"|"NO_EXPORT"|string;
1565 export interface ReportFilter {
1566 /**
1567 * The status used to filter reports. You can filter using one status only.
1568 */
1569 status?: ReportStatusType;
1570 }
1571 export interface ReportGroup {
1572 /**
1573 * The ARN of a ReportGroup.
1574 */
1575 arn?: NonEmptyString;
1576 /**
1577 * The name of a ReportGroup.
1578 */
1579 name?: ReportGroupName;
1580 /**
1581 * The type of the ReportGroup. The one valid value is TEST.
1582 */
1583 type?: ReportType;
1584 /**
1585 * Information about the destination where the raw data of this ReportGroup is exported.
1586 */
1587 exportConfig?: ReportExportConfig;
1588 /**
1589 * The date and time this ReportGroup was created.
1590 */
1591 created?: Timestamp;
1592 /**
1593 * The date and time this ReportGroup was last modified.
1594 */
1595 lastModified?: Timestamp;
1596 }
1597 export type ReportGroupArns = NonEmptyString[];
1598 export type ReportGroupName = string;
1599 export type ReportGroupSortByType = "NAME"|"CREATED_TIME"|"LAST_MODIFIED_TIME"|string;
1600 export type ReportGroups = ReportGroup[];
1601 export type ReportPackagingType = "ZIP"|"NONE"|string;
1602 export type ReportStatusCounts = {[key: string]: WrapperInt};
1603 export type ReportStatusType = "GENERATING"|"SUCCEEDED"|"FAILED"|"INCOMPLETE"|"DELETING"|string;
1604 export type ReportType = "TEST"|string;
1605 export type Reports = Report[];
1606 export interface S3LogsConfig {
1607 /**
1608 * 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.
1609 */
1610 status: LogsConfigStatusType;
1611 /**
1612 * 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.
1613 */
1614 location?: String;
1615 /**
1616 * Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
1617 */
1618 encryptionDisabled?: WrapperBoolean;
1619 }
1620 export interface S3ReportExportConfig {
1621 /**
1622 * The name of the S3 bucket where the raw data of a report are exported.
1623 */
1624 bucket?: NonEmptyString;
1625 /**
1626 * The path to the exported report's raw data results.
1627 */
1628 path?: String;
1629 /**
1630 * The type of build output artifact to create. Valid values include: NONE: AWS CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified. ZIP: AWS CodeBuild creates a ZIP file with the raw data in the output bucket.
1631 */
1632 packaging?: ReportPackagingType;
1633 /**
1634 * The encryption key for the report's encrypted raw data.
1635 */
1636 encryptionKey?: NonEmptyString;
1637 /**
1638 * A boolean value that specifies if the results of a report are encrypted.
1639 */
1640 encryptionDisabled?: WrapperBoolean;
1641 }
1642 export type SecurityGroupIds = NonEmptyString[];
1643 export type SensitiveNonEmptyString = string;
1644 export type ServerType = "GITHUB"|"BITBUCKET"|"GITHUB_ENTERPRISE"|string;
1645 export type SharedResourceSortByType = "ARN"|"MODIFIED_TIME"|string;
1646 export type SortOrderType = "ASCENDING"|"DESCENDING"|string;
1647 export interface SourceAuth {
1648 /**
1649 * 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.
1650 */
1651 type: SourceAuthType;
1652 /**
1653 * The resource value that applies to the specified authorization type.
1654 */
1655 resource?: String;
1656 }
1657 export type SourceAuthType = "OAUTH"|string;
1658 export interface SourceCredentialsInfo {
1659 /**
1660 * The Amazon Resource Name (ARN) of the token.
1661 */
1662 arn?: NonEmptyString;
1663 /**
1664 * The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
1665 */
1666 serverType?: ServerType;
1667 /**
1668 * The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.
1669 */
1670 authType?: AuthType;
1671 }
1672 export type SourceCredentialsInfos = SourceCredentialsInfo[];
1673 export type SourceType = "CODECOMMIT"|"CODEPIPELINE"|"GITHUB"|"S3"|"BITBUCKET"|"GITHUB_ENTERPRISE"|"NO_SOURCE"|string;
1674 export interface StartBuildInput {
1675 /**
1676 * The name of the AWS CodeBuild build project to start running a build.
1677 */
1678 projectName: NonEmptyString;
1679 /**
1680 * An array of ProjectSource objects.
1681 */
1682 secondarySourcesOverride?: ProjectSources;
1683 /**
1684 * An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.
1685 */
1686 secondarySourcesVersionOverride?: ProjectSecondarySourceVersions;
1687 /**
1688 * A version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, must be one of: For AWS CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence. For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
1689 */
1690 sourceVersion?: String;
1691 /**
1692 * Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
1693 */
1694 artifactsOverride?: ProjectArtifacts;
1695 /**
1696 * An array of ProjectArtifacts objects.
1697 */
1698 secondaryArtifactsOverride?: ProjectArtifactsList;
1699 /**
1700 * A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
1701 */
1702 environmentVariablesOverride?: EnvironmentVariables;
1703 /**
1704 * A source input type, for this build, that overrides the source input defined in the build project.
1705 */
1706 sourceTypeOverride?: SourceType;
1707 /**
1708 * A location that overrides, for this build, the source location for the one defined in the build project.
1709 */
1710 sourceLocationOverride?: String;
1711 /**
1712 * 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.
1713 */
1714 sourceAuthOverride?: SourceAuth;
1715 /**
1716 * 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.
1717 */
1718 gitCloneDepthOverride?: GitCloneDepth;
1719 /**
1720 * Information about the Git submodules configuration for this build of an AWS CodeBuild build project.
1721 */
1722 gitSubmodulesConfigOverride?: GitSubmodulesConfig;
1723 /**
1724 * A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project. If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
1725 */
1726 buildspecOverride?: String;
1727 /**
1728 * 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.
1729 */
1730 insecureSslOverride?: WrapperBoolean;
1731 /**
1732 * Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown. The status of a build triggered by a webhook is always reported to your source provider.
1733 */
1734 reportBuildStatusOverride?: WrapperBoolean;
1735 /**
1736 * A container type for this build that overrides the one specified in the build project.
1737 */
1738 environmentTypeOverride?: EnvironmentType;
1739 /**
1740 * The name of an image for this build that overrides the one specified in the build project.
1741 */
1742 imageOverride?: NonEmptyString;
1743 /**
1744 * The name of a compute type for this build that overrides the one specified in the build project.
1745 */
1746 computeTypeOverride?: ComputeType;
1747 /**
1748 * The name of a certificate for this build that overrides the one specified in the build project.
1749 */
1750 certificateOverride?: String;
1751 /**
1752 * A ProjectCache object specified for this build that overrides the one defined in the build project.
1753 */
1754 cacheOverride?: ProjectCache;
1755 /**
1756 * The name of a service role for this build that overrides the one specified in the build project.
1757 */
1758 serviceRoleOverride?: NonEmptyString;
1759 /**
1760 * Enable this flag to override privileged mode in the build project.
1761 */
1762 privilegedModeOverride?: WrapperBoolean;
1763 /**
1764 * 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.
1765 */
1766 timeoutInMinutesOverride?: TimeOut;
1767 /**
1768 * The number of minutes a build is allowed to be queued before it times out.
1769 */
1770 queuedTimeoutInMinutesOverride?: TimeOut;
1771 /**
1772 * The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).
1773 */
1774 encryptionKeyOverride?: NonEmptyString;
1775 /**
1776 * A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.
1777 */
1778 idempotencyToken?: String;
1779 /**
1780 * Log settings for this build that override the log settings defined in the build project.
1781 */
1782 logsConfigOverride?: LogsConfig;
1783 /**
1784 * The credentials for access to a private registry.
1785 */
1786 registryCredentialOverride?: RegistryCredential;
1787 /**
1788 * The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role. When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials.
1789 */
1790 imagePullCredentialsTypeOverride?: ImagePullCredentialsType;
1791 }
1792 export interface StartBuildOutput {
1793 /**
1794 * Information about the build to be run.
1795 */
1796 build?: Build;
1797 }
1798 export type StatusType = "SUCCEEDED"|"FAILED"|"FAULT"|"TIMED_OUT"|"IN_PROGRESS"|"STOPPED"|string;
1799 export interface StopBuildInput {
1800 /**
1801 * The ID of the build.
1802 */
1803 id: NonEmptyString;
1804 }
1805 export interface StopBuildOutput {
1806 /**
1807 * Information about the build.
1808 */
1809 build?: Build;
1810 }
1811 export type String = string;
1812 export type Subnets = NonEmptyString[];
1813 export interface Tag {
1814 /**
1815 * The tag's key.
1816 */
1817 key?: KeyInput;
1818 /**
1819 * The tag's value.
1820 */
1821 value?: ValueInput;
1822 }
1823 export type TagList = Tag[];
1824 export interface TestCase {
1825 /**
1826 * The ARN of the report to which the test case belongs.
1827 */
1828 reportArn?: NonEmptyString;
1829 /**
1830 * The path to the raw data file that contains the test result.
1831 */
1832 testRawDataPath?: String;
1833 /**
1834 * 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.
1835 */
1836 prefix?: String;
1837 /**
1838 * The name of the test case.
1839 */
1840 name?: String;
1841 /**
1842 * The status returned by the test case after it was run. Valid statuses are SUCCEEDED, FAILED, ERROR, SKIPPED, and UNKNOWN.
1843 */
1844 status?: String;
1845 /**
1846 * The number of nanoseconds it took to run this test case.
1847 */
1848 durationInNanoSeconds?: WrapperLong;
1849 /**
1850 * A message associated with a test case. For example, an error message or stack trace.
1851 */
1852 message?: String;
1853 /**
1854 * 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.
1855 */
1856 expired?: Timestamp;
1857 }
1858 export interface TestCaseFilter {
1859 /**
1860 * The status used to filter test cases. Valid statuses are SUCCEEDED, FAILED, ERROR, SKIPPED, and UNKNOWN. A TestCaseFilter can have one status.
1861 */
1862 status?: String;
1863 }
1864 export type TestCases = TestCase[];
1865 export interface TestReportSummary {
1866 /**
1867 * The number of test cases in this TestReportSummary. The total includes truncated test cases.
1868 */
1869 total: WrapperInt;
1870 /**
1871 * A map that contains the number of each type of status returned by the test results in this TestReportSummary.
1872 */
1873 statusCounts: ReportStatusCounts;
1874 /**
1875 * The number of nanoseconds it took to run all of the test cases in this report.
1876 */
1877 durationInNanoSeconds: WrapperLong;
1878 }
1879 export type TimeOut = number;
1880 export type Timestamp = Date;
1881 export interface UpdateProjectInput {
1882 /**
1883 * The name of the build project. You cannot change a build project's name.
1884 */
1885 name: NonEmptyString;
1886 /**
1887 * A new or replacement description of the build project.
1888 */
1889 description?: ProjectDescription;
1890 /**
1891 * Information to be changed about the build input source code for the build project.
1892 */
1893 source?: ProjectSource;
1894 /**
1895 * An array of ProjectSource objects.
1896 */
1897 secondarySources?: ProjectSources;
1898 /**
1899 * A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of: For AWS CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use. If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level). For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
1900 */
1901 sourceVersion?: String;
1902 /**
1903 * An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
1904 */
1905 secondarySourceVersions?: ProjectSecondarySourceVersions;
1906 /**
1907 * Information to be changed about the build output artifacts for the build project.
1908 */
1909 artifacts?: ProjectArtifacts;
1910 /**
1911 * An array of ProjectSource objects.
1912 */
1913 secondaryArtifacts?: ProjectArtifactsList;
1914 /**
1915 * Stores recently used information so that it can be quickly accessed at a later time.
1916 */
1917 cache?: ProjectCache;
1918 /**
1919 * Information to be changed about the build environment for the build project.
1920 */
1921 environment?: ProjectEnvironment;
1922 /**
1923 * The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
1924 */
1925 serviceRole?: NonEmptyString;
1926 /**
1927 * The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.
1928 */
1929 timeoutInMinutes?: TimeOut;
1930 /**
1931 * The number of minutes a build is allowed to be queued before it times out.
1932 */
1933 queuedTimeoutInMinutes?: TimeOut;
1934 /**
1935 * The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).
1936 */
1937 encryptionKey?: NonEmptyString;
1938 /**
1939 * The replacement set of tags for this build project. These tags are available for use by AWS services that support AWS CodeBuild build project tags.
1940 */
1941 tags?: TagList;
1942 /**
1943 * VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.
1944 */
1945 vpcConfig?: VpcConfig;
1946 /**
1947 * Set this to true to generate a publicly accessible URL for your project's build badge.
1948 */
1949 badgeEnabled?: WrapperBoolean;
1950 /**
1951 * Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, logs in an S3 bucket, or both.
1952 */
1953 logsConfig?: LogsConfig;
1954 /**
1955 * 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.
1956 */
1957 fileSystemLocations?: ProjectFileSystemLocations;
1958 }
1959 export interface UpdateProjectOutput {
1960 /**
1961 * Information about the build project that was changed.
1962 */
1963 project?: Project;
1964 }
1965 export interface UpdateReportGroupInput {
1966 /**
1967 * The ARN of the report group to update.
1968 */
1969 arn: NonEmptyString;
1970 /**
1971 * 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.
1972 */
1973 exportConfig?: ReportExportConfig;
1974 }
1975 export interface UpdateReportGroupOutput {
1976 /**
1977 * Information about the updated report group.
1978 */
1979 reportGroup?: ReportGroup;
1980 }
1981 export interface UpdateWebhookInput {
1982 /**
1983 * The name of the AWS CodeBuild project.
1984 */
1985 projectName: ProjectName;
1986 /**
1987 * 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.
1988 */
1989 branchFilter?: String;
1990 /**
1991 * 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.
1992 */
1993 rotateSecret?: Boolean;
1994 /**
1995 * 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.
1996 */
1997 filterGroups?: FilterGroups;
1998 }
1999 export interface UpdateWebhookOutput {
2000 /**
2001 * Information about a repository's webhook that is associated with a project in AWS CodeBuild.
2002 */
2003 webhook?: Webhook;
2004 }
2005 export type ValueInput = string;
2006 export interface VpcConfig {
2007 /**
2008 * The ID of the Amazon VPC.
2009 */
2010 vpcId?: NonEmptyString;
2011 /**
2012 * A list of one or more subnet IDs in your Amazon VPC.
2013 */
2014 subnets?: Subnets;
2015 /**
2016 * A list of one or more security groups IDs in your Amazon VPC.
2017 */
2018 securityGroupIds?: SecurityGroupIds;
2019 }
2020 export interface Webhook {
2021 /**
2022 * The URL to the webhook.
2023 */
2024 url?: NonEmptyString;
2025 /**
2026 * The AWS CodeBuild endpoint where webhook events are sent.
2027 */
2028 payloadUrl?: NonEmptyString;
2029 /**
2030 * The secret token of the associated repository. A Bitbucket webhook does not support secret.
2031 */
2032 secret?: NonEmptyString;
2033 /**
2034 * 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.
2035 */
2036 branchFilter?: String;
2037 /**
2038 * 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.
2039 */
2040 filterGroups?: FilterGroups;
2041 /**
2042 * A timestamp that indicates the last time a repository's secret token was modified.
2043 */
2044 lastModifiedSecret?: Timestamp;
2045 }
2046 export interface WebhookFilter {
2047 /**
2048 * The type of webhook filter. There are five webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, and FILE_PATH. EVENT A webhook event triggers a build when the provided pattern matches one of four event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, and PULL_REQUEST_REOPENED. The EVENT patterns are specified as a comma-separated string. For example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull request created, and pull request updated events. 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 GitHub Enterprise push events only.
2049 */
2050 type: WebhookFilterType;
2051 /**
2052 * 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.
2053 */
2054 pattern: String;
2055 /**
2056 * 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.
2057 */
2058 excludeMatchedPattern?: WrapperBoolean;
2059 }
2060 export type WebhookFilterType = "EVENT"|"BASE_REF"|"HEAD_REF"|"ACTOR_ACCOUNT_ID"|"FILE_PATH"|string;
2061 export type WrapperBoolean = boolean;
2062 export type WrapperInt = number;
2063 export type WrapperLong = number;
2064 /**
2065 * 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.
2066 */
2067 export type apiVersion = "2016-10-06"|"latest"|string;
2068 export interface ClientApiVersions {
2069 /**
2070 * 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.
2071 */
2072 apiVersion?: apiVersion;
2073 }
2074 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2075 /**
2076 * Contains interfaces for use with the CodeBuild client.
2077 */
2078 export import Types = CodeBuild;
2079}
2080export = CodeBuild;