/
docs-2.json
1863 lines (1863 loc) · 171 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version": "2.0",
"service": "<fullname>AWS CodeBuild</fullname> <p>AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about AWS CodeBuild, see the <i> <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/welcome.html\">AWS CodeBuild User Guide</a>.</i> </p>",
"operations": {
"BatchDeleteBuilds": "<p>Deletes one or more builds.</p>",
"BatchGetBuildBatches": "<p>Retrieves information about one or more batch builds.</p>",
"BatchGetBuilds": "<p>Gets information about one or more builds.</p>",
"BatchGetProjects": "<p>Gets information about one or more build projects.</p>",
"BatchGetReportGroups": "<p> Returns an array of report groups. </p>",
"BatchGetReports": "<p> Returns an array of reports. </p>",
"CreateProject": "<p>Creates a build project.</p>",
"CreateReportGroup": "<p> Creates a report group. A report group contains a collection of reports. </p>",
"CreateWebhook": "<p>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.</p> <important> <p>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 <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-console\">Change a Build Project's Settings</a>.</p> </important>",
"DeleteBuildBatch": "<p>Deletes a batch build.</p>",
"DeleteProject": "<p> Deletes a build project. When you delete a project, its builds are not deleted. </p>",
"DeleteReport": "<p> Deletes a report. </p>",
"DeleteReportGroup": "<p>Deletes a report group. Before you delete a report group, you must delete its reports. </p>",
"DeleteResourcePolicy": "<p> Deletes a resource policy that is identified by its resource ARN. </p>",
"DeleteSourceCredentials": "<p> Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials. </p>",
"DeleteWebhook": "<p>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.</p>",
"DescribeCodeCoverages": "<p>Retrieves one or more code coverage reports.</p>",
"DescribeTestCases": "<p> Returns a list of details about test cases for a report. </p>",
"GetReportGroupTrend": "<p>Analyzes and accumulates test report values for the specified test reports.</p>",
"GetResourcePolicy": "<p> Gets a resource policy that is identified by its resource ARN. </p>",
"ImportSourceCredentials": "<p> Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository. </p>",
"InvalidateProjectCache": "<p>Resets the cache for a project.</p>",
"ListBuildBatches": "<p>Retrieves the identifiers of your build batches in the current region.</p>",
"ListBuildBatchesForProject": "<p>Retrieves the identifiers of the build batches for a specific project.</p>",
"ListBuilds": "<p>Gets a list of build IDs, with each build ID representing a single build.</p>",
"ListBuildsForProject": "<p>Gets a list of build identifiers for the specified build project, with each build identifier representing a single build.</p>",
"ListCuratedEnvironmentImages": "<p>Gets information about Docker images that are managed by AWS CodeBuild.</p>",
"ListProjects": "<p>Gets a list of build project names, with each build project name representing a single build project.</p>",
"ListReportGroups": "<p> Gets a list ARNs for the report groups in the current AWS account. </p>",
"ListReports": "<p> Returns a list of ARNs for the reports in the current AWS account. </p>",
"ListReportsForReportGroup": "<p> Returns a list of ARNs for the reports that belong to a <code>ReportGroup</code>. </p>",
"ListSharedProjects": "<p> Gets a list of projects that are shared with other AWS accounts or users. </p>",
"ListSharedReportGroups": "<p> Gets a list of report groups that are shared with other AWS accounts or users. </p>",
"ListSourceCredentials": "<p> Returns a list of <code>SourceCredentialsInfo</code> objects. </p>",
"PutResourcePolicy": "<p> Stores a resource policy for the ARN of a <code>Project</code> or <code>ReportGroup</code> object. </p>",
"RetryBuild": "<p>Restarts a build.</p>",
"RetryBuildBatch": "<p>Restarts a failed batch build. Only batch builds that have failed can be retried.</p>",
"StartBuild": "<p>Starts running a build.</p>",
"StartBuildBatch": "<p>Starts a batch build for a project.</p>",
"StopBuild": "<p>Attempts to stop running a build.</p>",
"StopBuildBatch": "<p>Stops a running batch build.</p>",
"UpdateProject": "<p>Changes the settings of a build project.</p>",
"UpdateReportGroup": "<p> Updates a report group. </p>",
"UpdateWebhook": "<p> Updates the webhook associated with an AWS CodeBuild build project. </p> <note> <p> If you use Bitbucket for your repository, <code>rotateSecret</code> is ignored. </p> </note>"
},
"shapes": {
"AccountLimitExceededException": {
"base": "<p>An AWS service limit was exceeded for the calling AWS account.</p>",
"refs": {
}
},
"ArtifactNamespace": {
"base": null,
"refs": {
"ProjectArtifacts$namespaceType": "<p>Along with <code>path</code> and <code>name</code>, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, valid values include:</p> <ul> <li> <p> <code>BUILD_ID</code>: Include the build ID in the location of the build output artifact.</p> </li> <li> <p> <code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified.</p> </li> </ul> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in <code>MyArtifacts/<build-ID>/MyArtifact.zip</code>.</p>"
}
},
"ArtifactPackaging": {
"base": null,
"refs": {
"ProjectArtifacts$packaging": "<p>The type of build output artifact to create:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, valid values include:</p> <ul> <li> <p> <code>NONE</code>: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified.</p> </li> <li> <p> <code>ZIP</code>: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.</p> </li> </ul> </li> </ul>"
}
},
"ArtifactsType": {
"base": null,
"refs": {
"ProjectArtifacts$type": "<p>The type of build output artifact. Valid values include:</p> <ul> <li> <p> <code>CODEPIPELINE</code>: The build project has build output generated through AWS CodePipeline. </p> <note> <p>The <code>CODEPIPELINE</code> type is not supported for <code>secondaryArtifacts</code>.</p> </note> </li> <li> <p> <code>NO_ARTIFACTS</code>: The build project does not produce any build output.</p> </li> <li> <p> <code>S3</code>: The build project stores build output in Amazon S3.</p> </li> </ul>",
"ResolvedArtifact$type": "<p>Specifies the type of artifact.</p>"
}
},
"AuthType": {
"base": null,
"refs": {
"ImportSourceCredentialsInput$authType": "<p> 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. </p>",
"SourceCredentialsInfo$authType": "<p> The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN. </p>"
}
},
"BatchDeleteBuildsInput": {
"base": null,
"refs": {
}
},
"BatchDeleteBuildsOutput": {
"base": null,
"refs": {
}
},
"BatchGetBuildBatchesInput": {
"base": null,
"refs": {
}
},
"BatchGetBuildBatchesOutput": {
"base": null,
"refs": {
}
},
"BatchGetBuildsInput": {
"base": null,
"refs": {
}
},
"BatchGetBuildsOutput": {
"base": null,
"refs": {
}
},
"BatchGetProjectsInput": {
"base": null,
"refs": {
}
},
"BatchGetProjectsOutput": {
"base": null,
"refs": {
}
},
"BatchGetReportGroupsInput": {
"base": null,
"refs": {
}
},
"BatchGetReportGroupsOutput": {
"base": null,
"refs": {
}
},
"BatchGetReportsInput": {
"base": null,
"refs": {
}
},
"BatchGetReportsOutput": {
"base": null,
"refs": {
}
},
"BatchRestrictions": {
"base": "<p>Specifies restrictions for the batch build.</p>",
"refs": {
"ProjectBuildBatchConfig$restrictions": "<p>A <code>BatchRestrictions</code> object that specifies the restrictions for the batch build.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"Build$buildComplete": "<p>Whether the build is complete. True if complete; otherwise, false.</p>",
"BuildBatch$complete": "<p>Indicates if the batch build is complete.</p>",
"BuildGroup$ignoreFailure": "<p>Specifies if failures in this build group can be ignored.</p>",
"DeleteReportGroupInput$deleteReports": "<p>If <code>true</code>, deletes any reports that belong to a report group before deleting the report group. </p> <p>If <code>false</code>, you must delete any reports in the report group. Use <a href=\"https://docs.aws.amazon.com/codebuild/latest/APIReference/API_ListReportsForReportGroup.html\">ListReportsForReportGroup</a> to get the reports in a report group. Use <a href=\"https://docs.aws.amazon.com/codebuild/latest/APIReference/API_DeleteReport.html\">DeleteReport</a> to delete the reports. If you call <code>DeleteReportGroup</code> for a report group that contains one or more reports, an exception is thrown. </p>",
"ProjectBadge$badgeEnabled": "<p>Set this to true to generate a publicly accessible URL for your project's build badge.</p>",
"UpdateWebhookInput$rotateSecret": "<p> A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, <code>rotateSecret</code> is ignored. </p>"
}
},
"BucketOwnerAccess": {
"base": "<p>Specifies the access for objects that are uploaded to an Amazon S3 bucket that is owned by another account.</p> <p>By default, only the account that uploads the objects to the bucket has access to these objects. This property allows you to give the bucket owner access to these objects.</p> <dl> <dt>NONE</dt> <dd> <p>The bucket owner does not have access to the objects. This is the default.</p> </dd> <dt>READ_ONLY</dt> <dd> <p>The bucket owner has read only access to the objects. The uploading account retains ownership of the objects.</p> </dd> <dt>FULL</dt> <dd> <p>The bucket owner has full access to the objects. Object ownership is determined by the following criteria:</p> <ul> <li> <p>If the bucket is configured with the <b>Bucket owner preferred</b> setting, the bucket owner owns the objects. The uploading account will have object access as specified by the bucket's policy.</p> </li> <li> <p>Otherwise, the uploading account retains ownership of the objects.</p> </li> </ul> <p>For more information about Amazon S3 object ownership, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html\">Controlling ownership of uploaded objects using S3 Object Ownership</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> </dd> </dl>",
"refs": {
"BuildArtifacts$bucketOwnerAccess": null,
"ProjectArtifacts$bucketOwnerAccess": null,
"S3LogsConfig$bucketOwnerAccess": null
}
},
"Build": {
"base": "<p>Information about a build.</p>",
"refs": {
"Builds$member": null,
"RetryBuildOutput$build": null,
"StartBuildOutput$build": "<p>Information about the build to be run.</p>",
"StopBuildOutput$build": "<p>Information about the build.</p>"
}
},
"BuildArtifacts": {
"base": "<p>Information about build output artifacts.</p>",
"refs": {
"Build$artifacts": "<p>Information about the output artifacts for the build.</p>",
"BuildArtifactsList$member": null,
"BuildBatch$artifacts": "<p>A <code>BuildArtifacts</code> object the defines the build artifacts for this batch build.</p>"
}
},
"BuildArtifactsList": {
"base": null,
"refs": {
"Build$secondaryArtifacts": "<p> An array of <code>ProjectArtifacts</code> objects. </p>",
"BuildBatch$secondaryArtifacts": "<p>An array of <code>BuildArtifacts</code> objects the define the build artifacts for this batch build.</p>"
}
},
"BuildBatch": {
"base": "<p>Contains information about a batch build.</p>",
"refs": {
"BuildBatches$member": null,
"RetryBuildBatchOutput$buildBatch": null,
"StartBuildBatchOutput$buildBatch": "<p>A <code>BuildBatch</code> object that contains information about the batch build.</p>",
"StopBuildBatchOutput$buildBatch": null
}
},
"BuildBatchFilter": {
"base": "<p>Specifies filters when retrieving batch builds.</p>",
"refs": {
"ListBuildBatchesForProjectInput$filter": "<p>A <code>BuildBatchFilter</code> object that specifies the filters for the search.</p>",
"ListBuildBatchesInput$filter": "<p>A <code>BuildBatchFilter</code> object that specifies the filters for the search.</p>"
}
},
"BuildBatchIds": {
"base": null,
"refs": {
"BatchGetBuildBatchesInput$ids": "<p>An array that contains the batch build identifiers to retrieve.</p>",
"BatchGetBuildBatchesOutput$buildBatchesNotFound": "<p>An array that contains the identifiers of any batch builds that are not found.</p>",
"ListBuildBatchesForProjectOutput$ids": "<p>An array of strings that contains the batch build identifiers.</p>",
"ListBuildBatchesOutput$ids": "<p>An array of strings that contains the batch build identifiers.</p>"
}
},
"BuildBatchPhase": {
"base": "<p>Contains information about a stage for a batch build.</p>",
"refs": {
"BuildBatchPhases$member": null
}
},
"BuildBatchPhaseType": {
"base": null,
"refs": {
"BuildBatchPhase$phaseType": "<p>The name of the batch build phase. Valid values include:</p> <dl> <dt>COMBINE_ARTIFACTS</dt> <dd> <p>Build output artifacts are being combined and uploaded to the output location.</p> </dd> <dt>DOWNLOAD_BATCHSPEC</dt> <dd> <p>The batch build specification is being downloaded.</p> </dd> <dt>FAILED</dt> <dd> <p>One or more of the builds failed.</p> </dd> <dt>IN_PROGRESS</dt> <dd> <p>The batch build is in progress.</p> </dd> <dt>STOPPED</dt> <dd> <p>The batch build was stopped.</p> </dd> <dt>SUBMITTED</dt> <dd> <p>The btach build has been submitted.</p> </dd> <dt>SUCCEEDED</dt> <dd> <p>The batch build succeeded.</p> </dd> </dl>"
}
},
"BuildBatchPhases": {
"base": null,
"refs": {
"BuildBatch$phases": "<p>An array of <code>BuildBatchPhase</code> objects the specify the phases of the batch build.</p>"
}
},
"BuildBatches": {
"base": null,
"refs": {
"BatchGetBuildBatchesOutput$buildBatches": "<p>An array of <code>BuildBatch</code> objects that represent the retrieved batch builds.</p>"
}
},
"BuildGroup": {
"base": "<p>Contains information about a batch build build group. Build groups are used to combine builds that can run in parallel, while still being able to set dependencies on other build groups.</p>",
"refs": {
"BuildGroups$member": null
}
},
"BuildGroups": {
"base": null,
"refs": {
"BuildBatch$buildGroups": "<p>An array of <code>BuildGroup</code> objects that define the build groups for the batch build.</p>"
}
},
"BuildIds": {
"base": null,
"refs": {
"BatchDeleteBuildsInput$ids": "<p>The IDs of the builds to delete.</p>",
"BatchDeleteBuildsOutput$buildsDeleted": "<p>The IDs of the builds that were successfully deleted.</p>",
"BatchGetBuildsInput$ids": "<p>The IDs of the builds.</p>",
"BatchGetBuildsOutput$buildsNotFound": "<p>The IDs of builds for which information could not be found.</p>",
"DeleteBuildBatchOutput$buildsDeleted": "<p>An array of strings that contain the identifiers of the builds that were deleted.</p>",
"ListBuildsForProjectOutput$ids": "<p>A list of build IDs for the specified build project, with each build ID representing a single build.</p>",
"ListBuildsOutput$ids": "<p>A list of build IDs, with each build ID representing a single build.</p>"
}
},
"BuildNotDeleted": {
"base": "<p>Information about a build that could not be successfully deleted.</p>",
"refs": {
"BuildsNotDeleted$member": null
}
},
"BuildPhase": {
"base": "<p>Information about a stage for a build.</p>",
"refs": {
"BuildPhases$member": null
}
},
"BuildPhaseType": {
"base": null,
"refs": {
"BuildPhase$phaseType": "<p>The name of the build phase. Valid values include:</p> <ul> <li> <p> <code>BUILD</code>: Core build activities typically occur in this build phase.</p> </li> <li> <p> <code>COMPLETED</code>: The build has been completed.</p> </li> <li> <p> <code>DOWNLOAD_SOURCE</code>: Source code is being downloaded in this build phase.</p> </li> <li> <p> <code>FINALIZING</code>: The build process is completing in this build phase.</p> </li> <li> <p> <code>INSTALL</code>: Installation activities typically occur in this build phase.</p> </li> <li> <p> <code>POST_BUILD</code>: Post-build activities typically occur in this build phase.</p> </li> <li> <p> <code>PRE_BUILD</code>: Pre-build activities typically occur in this build phase.</p> </li> <li> <p> <code>PROVISIONING</code>: The build environment is being set up.</p> </li> <li> <p> <code>QUEUED</code>: The build has been submitted and is queued behind other submitted builds.</p> </li> <li> <p> <code>SUBMITTED</code>: The build has been submitted.</p> </li> <li> <p> <code>UPLOAD_ARTIFACTS</code>: Build output artifacts are being uploaded to the output location.</p> </li> </ul>"
}
},
"BuildPhases": {
"base": null,
"refs": {
"Build$phases": "<p>Information about all previous build phases that are complete and information about any current build phase that is not yet complete.</p>"
}
},
"BuildReportArns": {
"base": null,
"refs": {
"Build$reportArns": "<p> An array of the ARNs associated with this build's reports. </p>"
}
},
"BuildStatusConfig": {
"base": "<p>Contains information that defines how the AWS CodeBuild build project reports the build status to the source provider. </p>",
"refs": {
"ProjectSource$buildStatusConfig": "<p>Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is <code>GITHUB</code>, <code>GITHUB_ENTERPRISE</code>, or <code>BITBUCKET</code>.</p>",
"StartBuildInput$buildStatusConfigOverride": "<p>Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is <code>GITHUB</code>, <code>GITHUB_ENTERPRISE</code>, or <code>BITBUCKET</code>.</p>"
}
},
"BuildSummaries": {
"base": null,
"refs": {
"BuildGroup$priorBuildSummaryList": "<p>An array of <code>BuildSummary</code> objects that contain summaries of previous build groups.</p>"
}
},
"BuildSummary": {
"base": "<p>Contains summary information about a batch build group.</p>",
"refs": {
"BuildGroup$currentBuildSummary": "<p>A <code>BuildSummary</code> object that contains a summary of the current build group.</p>",
"BuildSummaries$member": null
}
},
"Builds": {
"base": null,
"refs": {
"BatchGetBuildsOutput$builds": "<p>Information about the requested builds.</p>"
}
},
"BuildsNotDeleted": {
"base": null,
"refs": {
"BatchDeleteBuildsOutput$buildsNotDeleted": "<p>Information about any builds that could not be successfully deleted.</p>",
"DeleteBuildBatchOutput$buildsNotDeleted": "<p>An array of <code>BuildNotDeleted</code> objects that specify the builds that could not be deleted.</p>"
}
},
"CacheMode": {
"base": null,
"refs": {
"ProjectCacheModes$member": null
}
},
"CacheType": {
"base": null,
"refs": {
"ProjectCache$type": "<p>The type of cache used by the build project. Valid values include:</p> <ul> <li> <p> <code>NO_CACHE</code>: The build project does not use any cache.</p> </li> <li> <p> <code>S3</code>: The build project reads and writes from and to S3.</p> </li> <li> <p> <code>LOCAL</code>: The build project stores a cache locally on a build host that is only available to that build host.</p> </li> </ul>"
}
},
"CloudWatchLogsConfig": {
"base": "<p> Information about Amazon CloudWatch Logs for a build project. </p>",
"refs": {
"LogsConfig$cloudWatchLogs": "<p> Information about Amazon CloudWatch Logs for a build project. Amazon CloudWatch Logs are enabled by default. </p>",
"LogsLocation$cloudWatchLogs": "<p> Information about Amazon CloudWatch Logs for a build project. </p>"
}
},
"CodeCoverage": {
"base": "<p>Contains code coverage report information.</p> <p>Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.</p> <p>Branch coverage determines if your tests cover every possible branch of a control structure, such as an <code>if</code> or <code>case</code> statement.</p>",
"refs": {
"CodeCoverages$member": null
}
},
"CodeCoverageReportSummary": {
"base": "<p>Contains a summary of a code coverage report.</p> <p>Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.</p> <p>Branch coverage determines if your tests cover every possible branch of a control structure, such as an <code>if</code> or <code>case</code> statement.</p>",
"refs": {
"Report$codeCoverageSummary": "<p>A <code>CodeCoverageReportSummary</code> object that contains a code coverage summary for this report.</p>"
}
},
"CodeCoverages": {
"base": null,
"refs": {
"DescribeCodeCoveragesOutput$codeCoverages": "<p>An array of <code>CodeCoverage</code> objects that contain the results.</p>"
}
},
"ComputeType": {
"base": null,
"refs": {
"ProjectEnvironment$computeType": "<p>Information about the compute resources the build project uses. Available values include:</p> <ul> <li> <p> <code>BUILD_GENERAL1_SMALL</code>: Use up to 3 GB memory and 2 vCPUs for builds.</p> </li> <li> <p> <code>BUILD_GENERAL1_MEDIUM</code>: Use up to 7 GB memory and 4 vCPUs for builds.</p> </li> <li> <p> <code>BUILD_GENERAL1_LARGE</code>: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.</p> </li> <li> <p> <code>BUILD_GENERAL1_2XLARGE</code>: 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.</p> </li> </ul> <p> If you use <code>BUILD_GENERAL1_LARGE</code>: </p> <ul> <li> <p> For environment type <code>LINUX_CONTAINER</code>, you can use up to 15 GB memory and 8 vCPUs for builds. </p> </li> <li> <p> For environment type <code>LINUX_GPU_CONTAINER</code>, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.</p> </li> <li> <p> For environment type <code>ARM_CONTAINER</code>, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.</p> </li> </ul> <p> For more information, see <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html\">Build Environment Compute Types</a> in the <i>AWS CodeBuild User Guide.</i> </p>",
"StartBuildBatchInput$computeTypeOverride": "<p>The name of a compute type for this batch build that overrides the one specified in the batch build project.</p>",
"StartBuildInput$computeTypeOverride": "<p>The name of a compute type for this build that overrides the one specified in the build project.</p>"
}
},
"ComputeTypesAllowed": {
"base": null,
"refs": {
"BatchRestrictions$computeTypesAllowed": "<p>An array of strings that specify the compute types that are allowed for the batch build. See <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html\">Build environment compute types</a> in the <i>AWS CodeBuild User Guide</i> for these values. </p>"
}
},
"CreateProjectInput": {
"base": null,
"refs": {
}
},
"CreateProjectOutput": {
"base": null,
"refs": {
}
},
"CreateReportGroupInput": {
"base": null,
"refs": {
}
},
"CreateReportGroupOutput": {
"base": null,
"refs": {
}
},
"CreateWebhookInput": {
"base": null,
"refs": {
}
},
"CreateWebhookOutput": {
"base": null,
"refs": {
}
},
"CredentialProviderType": {
"base": null,
"refs": {
"RegistryCredential$credentialProvider": "<p> The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager. </p>"
}
},
"DebugSession": {
"base": "<p>Contains information about the debug session for a build. For more information, see <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html\">Viewing a running build in Session Manager</a>.</p>",
"refs": {
"Build$debugSession": "<p>Contains information about the debug session for this build.</p>"
}
},
"DeleteBuildBatchInput": {
"base": null,
"refs": {
}
},
"DeleteBuildBatchOutput": {
"base": null,
"refs": {
}
},
"DeleteProjectInput": {
"base": null,
"refs": {
}
},
"DeleteProjectOutput": {
"base": null,
"refs": {
}
},
"DeleteReportGroupInput": {
"base": null,
"refs": {
}
},
"DeleteReportGroupOutput": {
"base": null,
"refs": {
}
},
"DeleteReportInput": {
"base": null,
"refs": {
}
},
"DeleteReportOutput": {
"base": null,
"refs": {
}
},
"DeleteResourcePolicyInput": {
"base": null,
"refs": {
}
},
"DeleteResourcePolicyOutput": {
"base": null,
"refs": {
}
},
"DeleteSourceCredentialsInput": {
"base": null,
"refs": {
}
},
"DeleteSourceCredentialsOutput": {
"base": null,
"refs": {
}
},
"DeleteWebhookInput": {
"base": null,
"refs": {
}
},
"DeleteWebhookOutput": {
"base": null,
"refs": {
}
},
"DescribeCodeCoveragesInput": {
"base": null,
"refs": {
}
},
"DescribeCodeCoveragesOutput": {
"base": null,
"refs": {
}
},
"DescribeTestCasesInput": {
"base": null,
"refs": {
}
},
"DescribeTestCasesOutput": {
"base": null,
"refs": {
}
},
"EnvironmentImage": {
"base": "<p>Information about a Docker image that is managed by AWS CodeBuild.</p>",
"refs": {
"EnvironmentImages$member": null
}
},
"EnvironmentImages": {
"base": null,
"refs": {
"EnvironmentLanguage$images": "<p>The list of Docker images that are related by the specified programming language.</p>"
}
},
"EnvironmentLanguage": {
"base": "<p>A set of Docker images that are related by programming language and are managed by AWS CodeBuild.</p>",
"refs": {
"EnvironmentLanguages$member": null
}
},
"EnvironmentLanguages": {
"base": null,
"refs": {
"EnvironmentPlatform$languages": "<p>The list of programming languages that are available for the specified platform.</p>"
}
},
"EnvironmentPlatform": {
"base": "<p>A set of Docker images that are related by platform and are managed by AWS CodeBuild.</p>",
"refs": {
"EnvironmentPlatforms$member": null
}
},
"EnvironmentPlatforms": {
"base": null,
"refs": {
"ListCuratedEnvironmentImagesOutput$platforms": "<p>Information about supported platforms for Docker images that are managed by AWS CodeBuild.</p>"
}
},
"EnvironmentType": {
"base": null,
"refs": {
"ProjectEnvironment$type": "<p>The type of build environment to use for related builds.</p> <ul> <li> <p>The environment type <code>ARM_CONTAINER</code> 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).</p> </li> <li> <p>The environment type <code>LINUX_CONTAINER</code> with compute type <code>build.general1.2xlarge</code> is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).</p> </li> <li> <p>The environment type <code>LINUX_GPU_CONTAINER</code> is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).</p> </li> </ul>",
"StartBuildBatchInput$environmentTypeOverride": "<p>A container type for this batch build that overrides the one specified in the batch build project.</p>",
"StartBuildInput$environmentTypeOverride": "<p>A container type for this build that overrides the one specified in the build project.</p>"
}
},
"EnvironmentVariable": {
"base": "<p>Information about an environment variable for a build project or a build.</p>",
"refs": {
"EnvironmentVariables$member": null
}
},
"EnvironmentVariableType": {
"base": null,
"refs": {
"EnvironmentVariable$type": "<p>The type of environment variable. Valid values include:</p> <ul> <li> <p> <code>PARAMETER_STORE</code>: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store\">env/parameter-store</a> in the <i>AWS CodeBuild User Guide</i>.</p> </li> <li> <p> <code>PLAINTEXT</code>: An environment variable in plain text format. This is the default value.</p> </li> <li> <p> <code>SECRETS_MANAGER</code>: An environment variable stored in AWS Secrets Manager. To learn how to specify a secrets manager environment variable, see <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager\">env/secrets-manager</a> in the <i>AWS CodeBuild User Guide</i>.</p> </li> </ul>"
}
},
"EnvironmentVariables": {
"base": null,
"refs": {
"ProjectEnvironment$environmentVariables": "<p>A set of environment variables to make available to builds for this build project.</p>",
"StartBuildBatchInput$environmentVariablesOverride": "<p>An array of <code>EnvironmentVariable</code> objects that override, or add to, the environment variables defined in the batch build project.</p>",
"StartBuildInput$environmentVariablesOverride": "<p>A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.</p>"
}
},
"ExportedEnvironmentVariable": {
"base": "<p>Contains information about an exported environment variable. </p> <p>Exported environment variables are used in conjunction with AWS CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html\">Working with variables</a> in the <i>AWS CodePipeline User Guide</i>.</p> <note> <p> During a build, the value of a variable is available starting with the <code>install</code> phase. It can be updated between the start of the <code>install</code> phase and the end of the <code>post_build</code> phase. After the <code>post_build</code> phase ends, the value of exported variables cannot change.</p> </note>",
"refs": {
"ExportedEnvironmentVariables$member": null
}
},
"ExportedEnvironmentVariables": {
"base": null,
"refs": {
"Build$exportedEnvironmentVariables": "<p>A list of exported environment variables for this build.</p> <p>Exported environment variables are used in conjunction with AWS CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html\">Working with variables</a> in the <i>AWS CodePipeline User Guide</i>.</p>"
}
},
"FileSystemType": {
"base": null,
"refs": {
"ProjectFileSystemLocation$type": "<p> The type of the file system. The one supported type is <code>EFS</code>. </p>"
}
},
"FilterGroup": {
"base": null,
"refs": {
"FilterGroups$member": null
}
},
"FilterGroups": {
"base": null,
"refs": {
"CreateWebhookInput$filterGroups": "<p>An array of arrays of <code>WebhookFilter</code> objects used to determine which webhooks are triggered. At least one <code>WebhookFilter</code> in the array must specify <code>EVENT</code> as its <code>type</code>. </p> <p>For a build to be triggered, at least one filter group in the <code>filterGroups</code> array must pass. For a filter group to pass, each of its filters must pass. </p>",
"UpdateWebhookInput$filterGroups": "<p> An array of arrays of <code>WebhookFilter</code> objects used to determine if a webhook event can trigger a build. A filter group must contain at least one <code>EVENT</code> <code>WebhookFilter</code>. </p>",
"Webhook$filterGroups": "<p>An array of arrays of <code>WebhookFilter</code> objects used to determine which webhooks are triggered. At least one <code>WebhookFilter</code> in the array must specify <code>EVENT</code> as its <code>type</code>. </p> <p>For a build to be triggered, at least one filter group in the <code>filterGroups</code> array must pass. For a filter group to pass, each of its filters must pass. </p>"
}
},
"GetReportGroupTrendInput": {
"base": null,
"refs": {
}
},
"GetReportGroupTrendOutput": {
"base": null,
"refs": {
}
},
"GetResourcePolicyInput": {
"base": null,
"refs": {
}
},
"GetResourcePolicyOutput": {
"base": null,
"refs": {
}
},
"GitCloneDepth": {
"base": null,
"refs": {
"ProjectSource$gitCloneDepth": "<p>Information about the Git clone depth for the build project.</p>",
"StartBuildBatchInput$gitCloneDepthOverride": "<p>The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build only, any previous depth of history defined in the batch build project.</p>",
"StartBuildInput$gitCloneDepthOverride": "<p>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.</p>"
}
},
"GitSubmodulesConfig": {
"base": "<p> Information about the Git submodules configuration for an AWS CodeBuild build project. </p>",
"refs": {
"ProjectSource$gitSubmodulesConfig": "<p> Information about the Git submodules configuration for the build project. </p>",
"StartBuildBatchInput$gitSubmodulesConfigOverride": "<p>A <code>GitSubmodulesConfig</code> object that overrides the Git submodules configuration for this batch build.</p>",
"StartBuildInput$gitSubmodulesConfigOverride": "<p> Information about the Git submodules configuration for this build of an AWS CodeBuild build project. </p>"
}
},
"Identifiers": {
"base": null,
"refs": {
"BuildGroup$dependsOn": "<p>An array of strings that contain the identifiers of the build groups that this build group depends on.</p>"
}
},
"ImagePullCredentialsType": {
"base": null,
"refs": {
"ProjectEnvironment$imagePullCredentialsType": "<p> The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: </p> <ul> <li> <p> <code>CODEBUILD</code> specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. </p> </li> <li> <p> <code>SERVICE_ROLE</code> specifies that AWS CodeBuild uses your build project's service role. </p> </li> </ul> <p> 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. </p>",
"StartBuildBatchInput$imagePullCredentialsTypeOverride": "<p>The type of credentials AWS CodeBuild uses to pull images in your batch build. There are two valid values: </p> <dl> <dt>CODEBUILD</dt> <dd> <p>Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.</p> </dd> <dt>SERVICE_ROLE</dt> <dd> <p>Specifies that AWS CodeBuild uses your build project's service role. </p> </dd> </dl> <p>When using a cross-account or private registry image, you must use <code>SERVICE_ROLE</code> credentials. When using an AWS CodeBuild curated image, you must use <code>CODEBUILD</code> credentials. </p>",
"StartBuildInput$imagePullCredentialsTypeOverride": "<p>The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: </p> <dl> <dt>CODEBUILD</dt> <dd> <p>Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.</p> </dd> <dt>SERVICE_ROLE</dt> <dd> <p>Specifies that AWS CodeBuild uses your build project's service role. </p> </dd> </dl> <p>When using a cross-account or private registry image, you must use <code>SERVICE_ROLE</code> credentials. When using an AWS CodeBuild curated image, you must use <code>CODEBUILD</code> credentials. </p>"
}
},
"ImageVersions": {
"base": null,
"refs": {
"EnvironmentImage$versions": "<p>A list of environment image versions.</p>"
}
},
"ImportSourceCredentialsInput": {
"base": null,
"refs": {
}
},
"ImportSourceCredentialsOutput": {
"base": null,
"refs": {
}
},
"InvalidInputException": {
"base": "<p>The input value that was provided is not valid.</p>",
"refs": {
}
},
"InvalidateProjectCacheInput": {
"base": null,
"refs": {
}
},
"InvalidateProjectCacheOutput": {
"base": null,
"refs": {
}
},
"KeyInput": {
"base": null,
"refs": {
"Tag$key": "<p>The tag's key.</p>"
}
},
"LanguageType": {
"base": null,
"refs": {
"EnvironmentLanguage$language": "<p>The programming language for the Docker images.</p>"
}
},
"ListBuildBatchesForProjectInput": {
"base": null,
"refs": {
}
},
"ListBuildBatchesForProjectOutput": {
"base": null,
"refs": {
}
},
"ListBuildBatchesInput": {
"base": null,
"refs": {
}
},
"ListBuildBatchesOutput": {
"base": null,
"refs": {
}
},
"ListBuildsForProjectInput": {
"base": null,
"refs": {
}
},
"ListBuildsForProjectOutput": {
"base": null,
"refs": {
}
},
"ListBuildsInput": {
"base": null,
"refs": {
}
},
"ListBuildsOutput": {
"base": null,
"refs": {
}
},
"ListCuratedEnvironmentImagesInput": {
"base": null,
"refs": {
}
},
"ListCuratedEnvironmentImagesOutput": {
"base": null,
"refs": {
}
},
"ListProjectsInput": {
"base": null,
"refs": {
}
},
"ListProjectsOutput": {
"base": null,
"refs": {
}
},
"ListReportGroupsInput": {
"base": null,
"refs": {
}
},
"ListReportGroupsOutput": {
"base": null,
"refs": {
}
},
"ListReportsForReportGroupInput": {
"base": null,
"refs": {
}
},
"ListReportsForReportGroupOutput": {
"base": null,
"refs": {
}
},
"ListReportsInput": {
"base": null,
"refs": {
}
},
"ListReportsOutput": {
"base": null,
"refs": {
}
},
"ListSharedProjectsInput": {
"base": null,
"refs": {
}
},
"ListSharedProjectsOutput": {
"base": null,
"refs": {
}
},
"ListSharedReportGroupsInput": {
"base": null,
"refs": {
}
},
"ListSharedReportGroupsOutput": {
"base": null,
"refs": {
}
},
"ListSourceCredentialsInput": {
"base": null,
"refs": {
}
},
"ListSourceCredentialsOutput": {
"base": null,
"refs": {
}
},
"LogsConfig": {
"base": "<p> Information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a specified S3 bucket, or both. </p>",
"refs": {
"BuildBatch$logConfig": null,
"CreateProjectInput$logsConfig": "<p>Information about logs for the build project. These can be logs in Amazon CloudWatch Logs, logs uploaded to a specified S3 bucket, or both. </p>",
"Project$logsConfig": "<p>Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both. </p>",
"StartBuildBatchInput$logsConfigOverride": "<p>A <code>LogsConfig</code> object that override the log settings defined in the batch build project.</p>",
"StartBuildInput$logsConfigOverride": "<p> Log settings for this build that override the log settings defined in the build project. </p>",
"UpdateProjectInput$logsConfig": "<p> Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, logs in an S3 bucket, or both. </p>"
}
},
"LogsConfigStatusType": {
"base": null,
"refs": {
"CloudWatchLogsConfig$status": "<p>The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are:</p> <ul> <li> <p> <code>ENABLED</code>: Amazon CloudWatch Logs are enabled for this build project.</p> </li> <li> <p> <code>DISABLED</code>: Amazon CloudWatch Logs are not enabled for this build project.</p> </li> </ul>",
"S3LogsConfig$status": "<p>The current status of the S3 build logs. Valid values are:</p> <ul> <li> <p> <code>ENABLED</code>: S3 build logs are enabled for this build project.</p> </li> <li> <p> <code>DISABLED</code>: S3 build logs are not enabled for this build project.</p> </li> </ul>"
}
},
"LogsLocation": {
"base": "<p>Information about build logs in Amazon CloudWatch Logs.</p>",
"refs": {
"Build$logs": "<p>Information about the build's logs in Amazon CloudWatch Logs.</p>"
}
},
"NetworkInterface": {
"base": "<p>Describes a network interface.</p>",
"refs": {
"Build$networkInterface": "<p>Describes a network interface.</p>"
}
},
"NonEmptyString": {
"base": null,
"refs": {
"Build$id": "<p>The unique ID for the build.</p>",
"Build$arn": "<p>The Amazon Resource Name (ARN) of the build.</p>",
"Build$sourceVersion": "<p>Any version identifier for the version of the source code to be built. If <code>sourceVersion</code> is specified at the project level, then this <code>sourceVersion</code> (at the build level) takes precedence. </p> <p> For more information, see <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html\">Source Version Sample with CodeBuild</a> in the <i>AWS CodeBuild User Guide</i>. </p>",
"Build$resolvedSourceVersion": "<p> An identifier for the version of this build's source code. </p> <ul> <li> <p> For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. </p> </li> <li> <p> For AWS CodePipeline, the source revision provided by AWS CodePipeline. </p> </li> <li> <p> For Amazon S3, this does not apply. </p> </li> </ul>",
"Build$projectName": "<p>The name of the AWS CodeBuild project.</p>",
"Build$serviceRole": "<p>The name of a service role used for this build.</p>",
"Build$encryptionKey": "<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <note> <p> You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </p> </note> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>).</p>",
"BuildBatch$id": "<p>The identifier of the batch build.</p>",
"BuildBatch$arn": "<p>The ARN of the batch build.</p>",
"BuildBatch$sourceVersion": "<p>The identifier of the version of the source code to be built.</p>",
"BuildBatch$resolvedSourceVersion": "<p>The identifier of the resolved version of this batch build's source code.</p> <ul> <li> <p>For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.</p> </li> <li> <p>For AWS CodePipeline, the source revision provided by AWS CodePipeline.</p> </li> <li> <p>For Amazon S3, this does not apply.</p> </li> </ul>",
"BuildBatch$projectName": "<p>The name of the batch build project.</p>",
"BuildBatch$serviceRole": "<p>The name of a service role used for builds in the batch.</p>",
"BuildBatch$encryptionKey": "<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the batch build output artifacts.</p> <note> <p>You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </p> </note> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>).</p>",
"BuildBatchIds$member": null,
"BuildIds$member": null,
"BuildNotDeleted$id": "<p>The ID of the build that could not be successfully deleted.</p>",
"CodeCoverage$id": "<p>The identifier of the code coverage report.</p>",
"CodeCoverage$reportARN": "<p>The ARN of the report.</p>",
"CodeCoverage$filePath": "<p>The path of the test report file.</p>",
"ComputeTypesAllowed$member": null,
"CreateProjectInput$serviceRole": "<p>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.</p>",
"CreateProjectInput$encryptionKey": "<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <note> <p>You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </p> </note> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>). </p>",
"DebugSession$sessionTarget": "<p>Contains the identifier of the Session Manager session used for the build. To work with the paused build, you open this session to examine, control, and resume the build.</p>",
"DeleteBuildBatchInput$id": "<p>The identifier of the batch build to delete.</p>",
"DeleteProjectInput$name": "<p>The name of the build project.</p>",
"DeleteReportGroupInput$arn": "<p>The ARN of the report group to delete. </p>",
"DeleteReportInput$arn": "<p> The ARN of the report to delete. </p>",
"DeleteResourcePolicyInput$resourceArn": "<p> The ARN of the resource that is associated with the resource policy. </p>",
"DeleteSourceCredentialsInput$arn": "<p> The Amazon Resource Name (ARN) of the token.</p>",
"DeleteSourceCredentialsOutput$arn": "<p> The Amazon Resource Name (ARN) of the token. </p>",
"DescribeCodeCoveragesInput$reportArn": "<p> The ARN of the report for which test cases are returned. </p>",
"EnvironmentVariable$name": "<p>The name or key of the environment variable.</p>",
"ExportedEnvironmentVariable$name": "<p>The name of the exported environment variable.</p>",
"GetReportGroupTrendInput$reportGroupArn": "<p>The ARN of the report group that contains the reports to analyze.</p>",
"GetResourcePolicyInput$resourceArn": "<p> The ARN of the resource that is associated with the resource policy. </p>",
"GetResourcePolicyOutput$policy": "<p> The resource policy for the resource identified by the input ARN parameter. </p>",
"Identifiers$member": null,
"ImportSourceCredentialsInput$username": "<p> The Bitbucket username when the <code>authType</code> is BASIC_AUTH. This parameter is not valid for other types of source providers or connections. </p>",
"ImportSourceCredentialsOutput$arn": "<p> The Amazon Resource Name (ARN) of the token. </p>",
"InvalidateProjectCacheInput$projectName": "<p>The name of the AWS CodeBuild build project that the cache is reset for.</p>",
"ListBuildBatchesForProjectInput$projectName": "<p>The name of the project.</p>",
"ListBuildsForProjectInput$projectName": "<p>The name of the AWS CodeBuild project.</p>",
"ListProjectsInput$nextToken": "<p>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 <i>nextToken</i>. 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.</p>",
"ListSharedProjectsInput$nextToken": "<p> During a previous call, the maximum number of items that can be returned is the value specified in <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i> 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. </p>",
"NetworkInterface$subnetId": "<p>The ID of the subnet.</p>",
"NetworkInterface$networkInterfaceId": "<p>The ID of the network interface.</p>",
"Project$serviceRole": "<p>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.</p>",
"Project$encryptionKey": "<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <note> <p>You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </p> </note> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>). </p>",
"ProjectArns$member": null,
"ProjectBuildBatchConfig$serviceRole": "<p>Specifies the service role ARN for the batch build project.</p>",
"ProjectEnvironment$image": "<p>The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:</p> <ul> <li> <p>For an image tag: <code><registry>/<repository>:<tag></code>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be <code>aws/codebuild/standard:4.0</code>. </p> </li> <li> <p>For an image digest: <code><registry>/<repository>@<digest></code>. For example, to specify an image with the digest \"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,\" use <code><registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf</code>.</p> </li> </ul>",
"ProjectNames$member": null,
"PutResourcePolicyInput$policy": "<p> A JSON-formatted resource policy. For more information, see <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/project-sharing.html#project-sharing-share\">Sharing a Project</a> and <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/report-groups-sharing.html#report-groups-sharing-share\">Sharing a Report Group</a> in the <i>AWS CodeBuild User Guide</i>. </p>",
"PutResourcePolicyInput$resourceArn": "<p> The ARN of the <code>Project</code> or <code>ReportGroup</code> resource you want to associate with a resource policy. </p>",
"PutResourcePolicyOutput$resourceArn": "<p> The ARN of the <code>Project</code> or <code>ReportGroup</code> resource that is associated with a resource policy. </p>",
"RegistryCredential$credential": "<p> The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager. </p> <note> <p> The <code>credential</code> can use the name of the credentials only if they exist in your current AWS Region. </p> </note>",
"Report$arn": "<p> The ARN of the report run. </p>",
"Report$reportGroupArn": "<p> The ARN of the report group associated with this report. </p>",
"ReportArns$member": null,
"ReportGroup$arn": "<p>The ARN of the <code>ReportGroup</code>. </p>",
"ReportGroupArns$member": null,
"ReportWithRawData$reportArn": "<p>The ARN of the report.</p>",
"RetryBuildBatchInput$id": "<p>Specifies the identifier of the batch build to restart.</p>",
"RetryBuildInput$id": "<p>Specifies the identifier of the build to restart.</p>",
"S3ReportExportConfig$bucket": "<p> The name of the S3 bucket where the raw data of a report are exported. </p>",
"S3ReportExportConfig$encryptionKey": "<p> The encryption key for the report's encrypted raw data. </p>",
"SecurityGroupIds$member": null,
"SourceCredentialsInfo$arn": "<p> The Amazon Resource Name (ARN) of the token. </p>",
"StartBuildBatchInput$projectName": "<p>The name of the project.</p>",
"StartBuildBatchInput$imageOverride": "<p>The name of an image for this batch build that overrides the one specified in the batch build project.</p>",
"StartBuildBatchInput$serviceRoleOverride": "<p>The name of a service role for this batch build that overrides the one specified in the batch build project.</p>",
"StartBuildBatchInput$encryptionKeyOverride": "<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts the build output artifacts.</p> <note> <p>You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </p> </note> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>).</p>",
"StartBuildInput$projectName": "<p>The name of the AWS CodeBuild build project to start running a build.</p>",
"StartBuildInput$imageOverride": "<p>The name of an image for this build that overrides the one specified in the build project.</p>",
"StartBuildInput$serviceRoleOverride": "<p>The name of a service role for this build that overrides the one specified in the build project.</p>",
"StartBuildInput$encryptionKeyOverride": "<p>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.</p> <note> <p> You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </p> </note> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>).</p>",
"StopBuildBatchInput$id": "<p>The identifier of the batch build to stop.</p>",
"StopBuildInput$id": "<p>The ID of the build.</p>",
"Subnets$member": null,
"TestCase$reportArn": "<p> The ARN of the report to which the test case belongs. </p>",
"UpdateProjectInput$name": "<p>The name of the build project.</p> <note> <p>You cannot change a build project's name.</p> </note>",
"UpdateProjectInput$serviceRole": "<p>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.</p>",
"UpdateProjectInput$encryptionKey": "<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <note> <p> You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </p> </note> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>). </p>",
"UpdateReportGroupInput$arn": "<p> The ARN of the report group to update. </p>",
"VpcConfig$vpcId": "<p>The ID of the Amazon VPC.</p>",
"Webhook$url": "<p>The URL to the webhook.</p>",
"Webhook$payloadUrl": "<p>The AWS CodeBuild endpoint where webhook events are sent.</p>",
"Webhook$secret": "<p>The secret token of the associated repository. </p> <note> <p>A Bitbucket webhook does not support <code>secret</code>. </p> </note>"
}
},
"NonNegativeInt": {
"base": null,
"refs": {
"CodeCoverage$linesCovered": "<p>The number of lines that are covered by your tests.</p>",
"CodeCoverage$linesMissed": "<p>The number of lines that are not covered by your tests.</p>",
"CodeCoverage$branchesCovered": "<p>The number of conditional branches that are covered by your tests.</p>",
"CodeCoverage$branchesMissed": "<p>The number of conditional branches that are not covered by your tests.</p>",
"CodeCoverageReportSummary$linesCovered": "<p>The number of lines that are covered by your tests.</p>",
"CodeCoverageReportSummary$linesMissed": "<p>The number of lines that are not covered by your tests.</p>",
"CodeCoverageReportSummary$branchesCovered": "<p>The number of conditional branches that are covered by your tests.</p>",
"CodeCoverageReportSummary$branchesMissed": "<p>The number of conditional branches that are not covered by your tests.</p>"
}
},
"OAuthProviderException": {
"base": "<p>There was a problem with the underlying OAuth provider.</p>",
"refs": {
}
},
"PageSize": {
"base": null,
"refs": {
"DescribeCodeCoveragesInput$maxResults": "<p>The maximum number of results to return.</p>",
"DescribeTestCasesInput$maxResults": "<p> The maximum number of paginated test cases returned per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>TestCase</code> objects. The default value is 100. </p>",
"GetReportGroupTrendInput$numOfReports": "<p>The number of reports to analyze. This operation always retrieves the most recent reports.</p> <p>If this parameter is omitted, the most recent 100 reports are analyzed.</p>",
"ListBuildBatchesForProjectInput$maxResults": "<p>The maximum number of results to return.</p>",
"ListBuildBatchesInput$maxResults": "<p>The maximum number of results to return.</p>",
"ListReportGroupsInput$maxResults": "<p> The maximum number of paginated report groups returned per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>ReportGroup</code> objects. The default value is 100. </p>",
"ListReportsForReportGroupInput$maxResults": "<p> The maximum number of paginated reports in this report group returned per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>Report</code> objects. The default value is 100. </p>",
"ListReportsInput$maxResults": "<p> The maximum number of paginated reports returned per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>Report</code> objects. The default value is 100. </p>",
"ListSharedProjectsInput$maxResults": "<p> The maximum number of paginated shared build projects returned per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>Project</code> objects. The default value is 100. </p>",
"ListSharedReportGroupsInput$maxResults": "<p> The maximum number of paginated shared report groups per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>ReportGroup</code> objects. The default value is 100. </p>"
}
},
"Percentage": {
"base": null,
"refs": {
"CodeCoverage$lineCoveragePercentage": "<p>The percentage of lines that are covered by your tests.</p>",
"CodeCoverage$branchCoveragePercentage": "<p>The percentage of branches that are covered by your tests.</p>",
"CodeCoverageReportSummary$lineCoveragePercentage": "<p>The percentage of lines that are covered by your tests.</p>",
"CodeCoverageReportSummary$branchCoveragePercentage": "<p>The percentage of branches that are covered by your tests.</p>",
"DescribeCodeCoveragesInput$minLineCoveragePercentage": "<p>The minimum line coverage percentage to report.</p>",
"DescribeCodeCoveragesInput$maxLineCoveragePercentage": "<p>The maximum line coverage percentage to report.</p>"
}
},
"PhaseContext": {
"base": "<p>Additional information about a build phase that has an error. You can use this information for troubleshooting.</p>",
"refs": {
"PhaseContexts$member": null
}
},
"PhaseContexts": {
"base": null,
"refs": {
"BuildBatchPhase$contexts": "<p>Additional information about the batch build phase. Especially to help troubleshoot a failed batch build.</p>",
"BuildPhase$contexts": "<p>Additional information about a build phase, especially to help troubleshoot a failed build.</p>"
}
},
"PlatformType": {