forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcodebuild-2016-10-06.normal.json
1090 lines (1090 loc) · 50.3 KB
/
codebuild-2016-10-06.normal.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",
"metadata":{
"apiVersion":"2016-10-06",
"endpointPrefix":"codebuild",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS CodeBuild",
"signatureVersion":"v4",
"targetPrefix":"CodeBuild_20161006",
"uid":"codebuild-2016-10-06"
},
"operations":{
"BatchGetBuilds":{
"name":"BatchGetBuilds",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchGetBuildsInput"},
"output":{"shape":"BatchGetBuildsOutput"},
"errors":[
{"shape":"InvalidInputException"}
],
"documentation":"<p>Gets information about builds.</p>"
},
"BatchGetProjects":{
"name":"BatchGetProjects",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchGetProjectsInput"},
"output":{"shape":"BatchGetProjectsOutput"},
"errors":[
{"shape":"InvalidInputException"}
],
"documentation":"<p>Gets information about build projects.</p>"
},
"CreateProject":{
"name":"CreateProject",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateProjectInput"},
"output":{"shape":"CreateProjectOutput"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"AccountLimitExceededException"}
],
"documentation":"<p>Creates a build project.</p>"
},
"DeleteProject":{
"name":"DeleteProject",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteProjectInput"},
"output":{"shape":"DeleteProjectOutput"},
"errors":[
{"shape":"InvalidInputException"}
],
"documentation":"<p>Deletes a build project.</p>"
},
"ListBuilds":{
"name":"ListBuilds",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListBuildsInput"},
"output":{"shape":"ListBuildsOutput"},
"errors":[
{"shape":"InvalidInputException"}
],
"documentation":"<p>Gets a list of build IDs, with each build ID representing a single build.</p>"
},
"ListBuildsForProject":{
"name":"ListBuildsForProject",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListBuildsForProjectInput"},
"output":{"shape":"ListBuildsForProjectOutput"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Gets a list of build IDs for the specified build project, with each build ID representing a single build.</p>"
},
"ListCuratedEnvironmentImages":{
"name":"ListCuratedEnvironmentImages",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListCuratedEnvironmentImagesInput"},
"output":{"shape":"ListCuratedEnvironmentImagesOutput"},
"documentation":"<p>Gets information about Docker images that are managed by AWS CodeBuild.</p>"
},
"ListProjects":{
"name":"ListProjects",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListProjectsInput"},
"output":{"shape":"ListProjectsOutput"},
"errors":[
{"shape":"InvalidInputException"}
],
"documentation":"<p>Gets a list of build project names, with each build project name representing a single build project.</p>"
},
"StartBuild":{
"name":"StartBuild",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartBuildInput"},
"output":{"shape":"StartBuildOutput"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccountLimitExceededException"}
],
"documentation":"<p>Starts running a build.</p>"
},
"StopBuild":{
"name":"StopBuild",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopBuildInput"},
"output":{"shape":"StopBuildOutput"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Attempts to stop running a build.</p>"
},
"UpdateProject":{
"name":"UpdateProject",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateProjectInput"},
"output":{"shape":"UpdateProjectOutput"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Changes the settings of a build project.</p>"
}
},
"shapes":{
"AccountLimitExceededException":{
"type":"structure",
"members":{
},
"documentation":"<p>An AWS service limit was exceeded for the calling AWS account.</p>",
"exception":true
},
"ArtifactNamespace":{
"type":"string",
"enum":[
"NONE",
"BUILD_ID"
]
},
"ArtifactPackaging":{
"type":"string",
"enum":[
"NONE",
"ZIP"
]
},
"ArtifactsType":{
"type":"string",
"enum":[
"CODEPIPELINE",
"S3",
"NO_ARTIFACTS"
]
},
"BatchGetBuildsInput":{
"type":"structure",
"required":["ids"],
"members":{
"ids":{
"shape":"BuildIds",
"documentation":"<p>The IDs of the builds.</p>"
}
}
},
"BatchGetBuildsOutput":{
"type":"structure",
"members":{
"builds":{
"shape":"Builds",
"documentation":"<p>Information about the requested builds.</p>"
},
"buildsNotFound":{
"shape":"BuildIds",
"documentation":"<p>The IDs of builds for which information could not be found.</p>"
}
}
},
"BatchGetProjectsInput":{
"type":"structure",
"required":["names"],
"members":{
"names":{
"shape":"ProjectNames",
"documentation":"<p>The names of the build projects.</p>"
}
}
},
"BatchGetProjectsOutput":{
"type":"structure",
"members":{
"projects":{
"shape":"Projects",
"documentation":"<p>Information about the requested build projects.</p>"
},
"projectsNotFound":{
"shape":"ProjectNames",
"documentation":"<p>The names of build projects for which information could not be found.</p>"
}
}
},
"Boolean":{"type":"boolean"},
"Build":{
"type":"structure",
"members":{
"id":{
"shape":"NonEmptyString",
"documentation":"<p>The unique ID for the build.</p>"
},
"arn":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Resource Name (ARN) of the build.</p>"
},
"startTime":{
"shape":"Timestamp",
"documentation":"<p>When the build process started, expressed in Unix time format.</p>"
},
"endTime":{
"shape":"Timestamp",
"documentation":"<p>When the build process ended, expressed in Unix time format.</p>"
},
"currentPhase":{
"shape":"String",
"documentation":"<p>The current build phase.</p>"
},
"buildStatus":{
"shape":"StatusType",
"documentation":"<p>The current status of the build. Valid values include:</p> <ul> <li> <p> <code>FAILED</code>: The build failed.</p> </li> <li> <p> <code>FAULT</code>: The build faulted.</p> </li> <li> <p> <code>IN_PROGRESS</code>: The build is still in progress.</p> </li> <li> <p> <code>STOPPED</code>: The build stopped.</p> </li> <li> <p> <code>SUCCEEDED</code>: The build succeeded.</p> </li> <li> <p> <code>TIMED_OUT</code>: The build timed out.</p> </li> </ul>"
},
"sourceVersion":{
"shape":"NonEmptyString",
"documentation":"<p>Any version identifier for the version of the source code to be built.</p>"
},
"projectName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the build project.</p>"
},
"phases":{
"shape":"BuildPhases",
"documentation":"<p>Information about all previous build phases that are completed and information about any current build phase that is not yet complete.</p>"
},
"source":{
"shape":"ProjectSource",
"documentation":"<p>Information about the source code to be built.</p>"
},
"artifacts":{
"shape":"BuildArtifacts",
"documentation":"<p>Information about the output artifacts for the build.</p>"
},
"environment":{
"shape":"ProjectEnvironment",
"documentation":"<p>Information about the build environment for this build.</p>"
},
"logs":{
"shape":"LogsLocation",
"documentation":"<p>Information about the build's logs in Amazon CloudWatch Logs.</p>"
},
"timeoutInMinutes":{
"shape":"WrapperInt",
"documentation":"<p>How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.</p>"
},
"buildComplete":{
"shape":"Boolean",
"documentation":"<p>Whether the build has finished. True if completed; otherwise, false.</p>"
},
"initiator":{
"shape":"String",
"documentation":"<p>The entity that started the build. Valid values include:</p> <ul> <li> <p>If AWS CodePipeline started the build, the pipeline's name (for example, <code>codepipeline/my-demo-pipeline</code>).</p> </li> <li> <p>If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example <code>MyUserName</code>).</p> </li> <li> <p>If the Jenkins plugin for AWS CodeBuild started the build, the string <code>CodeBuild-Jenkins-Plugin</code>.</p> </li> </ul>"
}
},
"documentation":"<p>Information about a build.</p>"
},
"BuildArtifacts":{
"type":"structure",
"members":{
"location":{
"shape":"String",
"documentation":"<p>Information about the location of the build artifacts.</p>"
},
"sha256sum":{
"shape":"String",
"documentation":"<p>The SHA-256 hash of the build artifact.</p> <p>You can use this hash along with a checksum tool to confirm both file integrity and authenticity.</p> <note> <p>This value is available only if the build project's <code>packaging</code> value is set to <code>ZIP</code>.</p> </note>"
},
"md5sum":{
"shape":"String",
"documentation":"<p>The MD5 hash of the build artifact.</p> <p>You can use this hash along with a checksum tool to confirm both file integrity and authenticity.</p> <note> <p>This value is available only if the build project's <code>packaging</code> value is set to <code>ZIP</code>.</p> </note>"
}
},
"documentation":"<p>Information about build output artifacts.</p>"
},
"BuildIds":{
"type":"list",
"member":{"shape":"NonEmptyString"},
"max":100,
"min":1
},
"BuildPhase":{
"type":"structure",
"members":{
"phaseType":{
"shape":"BuildPhaseType",
"documentation":"<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>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>"
},
"phaseStatus":{
"shape":"StatusType",
"documentation":"<p>The current status of the build phase. Valid values include:</p> <ul> <li> <p> <code>FAILED</code>: The build phase failed.</p> </li> <li> <p> <code>FAULT</code>: The build phase faulted.</p> </li> <li> <p> <code>IN_PROGRESS</code>: The build phase is still in progress.</p> </li> <li> <p> <code>STOPPED</code>: The build phase stopped.</p> </li> <li> <p> <code>SUCCEEDED</code>: The build phase succeeded.</p> </li> <li> <p> <code>TIMED_OUT</code>: The build phase timed out.</p> </li> </ul>"
},
"startTime":{
"shape":"Timestamp",
"documentation":"<p>When the build phase started, expressed in Unix time format.</p>"
},
"endTime":{
"shape":"Timestamp",
"documentation":"<p>When the build phase ended, expressed in Unix time format.</p>"
},
"durationInSeconds":{
"shape":"WrapperLong",
"documentation":"<p>How long, in seconds, between the starting and ending times of the build's phase.</p>"
},
"contexts":{
"shape":"PhaseContexts",
"documentation":"<p>Additional information about a build phase, especially to help troubleshoot a failed build.</p>"
}
},
"documentation":"<p>Information about a stage for a build.</p>"
},
"BuildPhaseType":{
"type":"string",
"enum":[
"SUBMITTED",
"PROVISIONING",
"DOWNLOAD_SOURCE",
"INSTALL",
"PRE_BUILD",
"BUILD",
"POST_BUILD",
"UPLOAD_ARTIFACTS",
"FINALIZING",
"COMPLETED"
]
},
"BuildPhases":{
"type":"list",
"member":{"shape":"BuildPhase"}
},
"Builds":{
"type":"list",
"member":{"shape":"Build"}
},
"ComputeType":{
"type":"string",
"enum":[
"BUILD_GENERAL1_SMALL",
"BUILD_GENERAL1_MEDIUM",
"BUILD_GENERAL1_LARGE"
]
},
"CreateProjectInput":{
"type":"structure",
"required":[
"name",
"source",
"artifacts",
"environment"
],
"members":{
"name":{
"shape":"ProjectName",
"documentation":"<p>The name of the build project.</p>"
},
"description":{
"shape":"ProjectDescription",
"documentation":"<p>A description that makes the build project easy to identify.</p>"
},
"source":{
"shape":"ProjectSource",
"documentation":"<p>Information about the build input source code for the build project.</p>"
},
"artifacts":{
"shape":"ProjectArtifacts",
"documentation":"<p>Information about the build output artifacts for the build project.</p>"
},
"environment":{
"shape":"ProjectEnvironment",
"documentation":"<p>Information about the build environment for the build project.</p>"
},
"serviceRole":{
"shape":"NonEmptyString",
"documentation":"<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>"
},
"timeoutInMinutes":{
"shape":"TimeOut",
"documentation":"<p>How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any build that has not been marked as completed. The default is 60 minutes.</p>"
},
"encryptionKey":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>A set of tags for this build project.</p> <p>These tags are available for use by AWS services that support AWS CodeBuild build project tags.</p>"
}
}
},
"CreateProjectOutput":{
"type":"structure",
"members":{
"project":{
"shape":"Project",
"documentation":"<p>Information about the build project that was created.</p>"
}
}
},
"DeleteProjectInput":{
"type":"structure",
"required":["name"],
"members":{
"name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the build project.</p>"
}
}
},
"DeleteProjectOutput":{
"type":"structure",
"members":{
}
},
"EnvironmentImage":{
"type":"structure",
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of the Docker image.</p>"
},
"description":{
"shape":"String",
"documentation":"<p>The description of the Docker image.</p>"
}
},
"documentation":"<p>Information about a Docker image that is managed by AWS CodeBuild.</p>"
},
"EnvironmentImages":{
"type":"list",
"member":{"shape":"EnvironmentImage"}
},
"EnvironmentLanguage":{
"type":"structure",
"members":{
"language":{
"shape":"LanguageType",
"documentation":"<p>The programming language for the Docker images.</p>"
},
"images":{
"shape":"EnvironmentImages",
"documentation":"<p>The list of Docker images that are related by the specified programming language.</p>"
}
},
"documentation":"<p>A set of Docker images that are related by programming language and are managed by AWS CodeBuild.</p>"
},
"EnvironmentLanguages":{
"type":"list",
"member":{"shape":"EnvironmentLanguage"}
},
"EnvironmentPlatform":{
"type":"structure",
"members":{
"platform":{
"shape":"PlatformType",
"documentation":"<p>The platform's name.</p>"
},
"languages":{
"shape":"EnvironmentLanguages",
"documentation":"<p>The list of programming languages that are available for the specified platform.</p>"
}
},
"documentation":"<p>A set of Docker images that are related by platform and are managed by AWS CodeBuild.</p>"
},
"EnvironmentPlatforms":{
"type":"list",
"member":{"shape":"EnvironmentPlatform"}
},
"EnvironmentType":{
"type":"string",
"enum":["LINUX_CONTAINER"]
},
"EnvironmentVariable":{
"type":"structure",
"required":[
"name",
"value"
],
"members":{
"name":{
"shape":"NonEmptyString",
"documentation":"<p>The name or key of the environment variable.</p>"
},
"value":{
"shape":"String",
"documentation":"<p>The value of the environment variable.</p>"
}
},
"documentation":"<p>Information about an environment variable for a build project or a build.</p>"
},
"EnvironmentVariables":{
"type":"list",
"member":{"shape":"EnvironmentVariable"}
},
"InvalidInputException":{
"type":"structure",
"members":{
},
"documentation":"<p>The input value that was provided is not valid.</p>",
"exception":true
},
"KeyInput":{
"type":"string",
"max":127,
"min":1,
"pattern":"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=@+\\\\-]*)$"
},
"LanguageType":{
"type":"string",
"enum":[
"JAVA",
"PYTHON",
"NODE_JS",
"RUBY",
"GOLANG",
"DOCKER",
"ANDROID",
"BASE"
]
},
"ListBuildsForProjectInput":{
"type":"structure",
"required":["projectName"],
"members":{
"projectName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the build project.</p>"
},
"sortOrder":{
"shape":"SortOrderType",
"documentation":"<p>The order to list build IDs. Valid values include:</p> <ul> <li> <p> <code>ASCENDING</code>: List the build IDs in ascending order by build ID.</p> </li> <li> <p> <code>DESCENDING</code>: List the build IDs in descending order by build ID.</p> </li> </ul>"
},
"nextToken":{
"shape":"String",
"documentation":"<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>next token</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>"
}
}
},
"ListBuildsForProjectOutput":{
"type":"structure",
"members":{
"ids":{
"shape":"BuildIds",
"documentation":"<p>A list of build IDs for the specified build project, with each build ID representing a single build.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>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>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call.</p>"
}
}
},
"ListBuildsInput":{
"type":"structure",
"members":{
"sortOrder":{
"shape":"SortOrderType",
"documentation":"<p>The order to list build IDs. Valid values include:</p> <ul> <li> <p> <code>ASCENDING</code>: List the build IDs in ascending order by build ID.</p> </li> <li> <p> <code>DESCENDING</code>: List the build IDs in descending order by build ID.</p> </li> </ul>"
},
"nextToken":{
"shape":"String",
"documentation":"<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>next token</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>"
}
}
},
"ListBuildsOutput":{
"type":"structure",
"members":{
"ids":{
"shape":"BuildIds",
"documentation":"<p>A list of build IDs, with each build ID representing a single build.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>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>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call.</p>"
}
}
},
"ListCuratedEnvironmentImagesInput":{
"type":"structure",
"members":{
}
},
"ListCuratedEnvironmentImagesOutput":{
"type":"structure",
"members":{
"platforms":{
"shape":"EnvironmentPlatforms",
"documentation":"<p>Information about supported platforms for Docker images that are managed by AWS CodeBuild.</p>"
}
}
},
"ListProjectsInput":{
"type":"structure",
"members":{
"sortBy":{
"shape":"ProjectSortByType",
"documentation":"<p>The criterion to be used to list build project names. Valid values include:</p> <ul> <li> <p> <code>CREATED_TIME</code>: List the build project names based on when each build project was created.</p> </li> <li> <p> <code>LAST_MODIFIED_TIME</code>: List the build project names based on when information about each build project was last changed.</p> </li> <li> <p> <code>NAME</code>: List the build project names based on each build project's name.</p> </li> </ul> <p>Use <code>sortOrder</code> to specify in what order to list the build project names based on the preceding criteria.</p>"
},
"sortOrder":{
"shape":"SortOrderType",
"documentation":"<p>The order in which to list build projects. Valid values include:</p> <ul> <li> <p> <code>ASCENDING</code>: List the build project names in ascending order.</p> </li> <li> <p> <code>DESCENDING</code>: List the build project names in descending order.</p> </li> </ul> <p>Use <code>sortBy</code> to specify the criterion to be used to list build project names.</p>"
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<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>next token</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>"
}
}
},
"ListProjectsOutput":{
"type":"structure",
"members":{
"nextToken":{
"shape":"String",
"documentation":"<p>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>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call.</p>"
},
"projects":{
"shape":"ProjectNames",
"documentation":"<p>The list of build project names, with each build project name representing a single build project.</p>"
}
}
},
"LogsLocation":{
"type":"structure",
"members":{
"groupName":{
"shape":"String",
"documentation":"<p>The name of the Amazon CloudWatch Logs group for the build logs.</p>"
},
"streamName":{
"shape":"String",
"documentation":"<p>The name of the Amazon CloudWatch Logs stream for the build logs.</p>"
},
"deepLink":{
"shape":"String",
"documentation":"<p>The URL to an individual build log in Amazon CloudWatch Logs.</p>"
}
},
"documentation":"<p>Information about build logs in Amazon CloudWatch Logs.</p>"
},
"NonEmptyString":{
"type":"string",
"min":1
},
"PhaseContext":{
"type":"structure",
"members":{
"statusCode":{
"shape":"String",
"documentation":"<p>The status code for the context of the build phase.</p>"
},
"message":{
"shape":"String",
"documentation":"<p>An explanation of the build phase's context. This explanation might include a command ID and an exit code.</p>"
}
},
"documentation":"<p>Additional information about a build phase that has an error. You can use this information to help troubleshoot a failed build.</p>"
},
"PhaseContexts":{
"type":"list",
"member":{"shape":"PhaseContext"}
},
"PlatformType":{
"type":"string",
"enum":[
"DEBIAN",
"AMAZON_LINUX",
"UBUNTU"
]
},
"Project":{
"type":"structure",
"members":{
"name":{
"shape":"ProjectName",
"documentation":"<p>The name of the build project.</p>"
},
"arn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the build project.</p>"
},
"description":{
"shape":"ProjectDescription",
"documentation":"<p>A description that makes the build project easy to identify.</p>"
},
"source":{
"shape":"ProjectSource",
"documentation":"<p>Information about the build input source code for this build project.</p>"
},
"artifacts":{
"shape":"ProjectArtifacts",
"documentation":"<p>Information about the build output artifacts for the build project.</p>"
},
"environment":{
"shape":"ProjectEnvironment",
"documentation":"<p>Information about the build environment for this build project.</p>"
},
"serviceRole":{
"shape":"NonEmptyString",
"documentation":"<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>"
},
"timeoutInMinutes":{
"shape":"TimeOut",
"documentation":"<p>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.</p>"
},
"encryptionKey":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>This is expressed either as the CMK's Amazon Resource Name (ARN) or, if specified, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>The tags for this build project.</p> <p>These tags are available for use by AWS services that support AWS CodeBuild build project tags.</p>"
},
"created":{
"shape":"Timestamp",
"documentation":"<p>When the build project was created, expressed in Unix time format.</p>"
},
"lastModified":{
"shape":"Timestamp",
"documentation":"<p>When the build project's settings were last modified, expressed in Unix time format.</p>"
}
},
"documentation":"<p>Information about a build project.</p>"
},
"ProjectArtifacts":{
"type":"structure",
"required":["type"],
"members":{
"type":{
"shape":"ArtifactsType",
"documentation":"<p>The type of build output artifact. Valid values include:</p> <ul> <li> <p> <code>CODEPIPELINE</code>: The build project will have build output generated through AWS CodePipeline.</p> </li> <li> <p> <code>NO_ARTIFACTS</code>: The build project will not produce any build output.</p> </li> <li> <p> <code>S3</code>: The build project will store build output in Amazon Simple Storage Service (Amazon S3).</p> </li> </ul>"
},
"location":{
"shape":"String",
"documentation":"<p>Information about the build output artifact location, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket.</p> </li> </ul>"
},
"path":{
"shape":"String",
"documentation":"<p>Along with <code>namespaceType</code> and <code>name</code>, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore 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>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the path to the output artifact. If <code>path</code> is not specified, then <code>path</code> will not be used.</p> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact would be stored in the output bucket at <code>MyArtifacts/MyArtifact.zip</code>.</p>"
},
"namespaceType":{
"shape":"ArtifactNamespace",
"documentation":"<p>Along with <code>path</code> and <code>name</code>, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore 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>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, then 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>, then the output artifact would be stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>.</p>"
},
"name":{
"shape":"String",
"documentation":"<p>Along with <code>path</code> and <code>namespaceType</code>, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore 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>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output artifact object.</p> </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>, then the output artifact would be stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>.</p>"
},
"packaging":{
"shape":"ArtifactPackaging",
"documentation":"<p>The type of build output artifact to create, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore 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>, then this value will be ignored if specified, because no build output will be 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 will create in the output bucket a folder containing the build output. This is the default if <code>packaging</code> is not specified.</p> </li> <li> <p> <code>ZIP</code>: AWS CodeBuild will create in the output bucket a ZIP file containing the build output.</p> </li> </ul> </li> </ul>"
}
},
"documentation":"<p>Information about the build output artifacts for the build project.</p>"
},
"ProjectDescription":{
"type":"string",
"max":255,
"min":0
},
"ProjectEnvironment":{
"type":"structure",
"required":[
"type",
"image",
"computeType"
],
"members":{
"type":{
"shape":"EnvironmentType",
"documentation":"<p>The type of build environment to use for related builds.</p>"
},
"image":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the Docker image to use for this build project.</p>"
},
"computeType":{
"shape":"ComputeType",
"documentation":"<p>Information about the compute resources the build project will use. 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 15 GB memory and 8 vCPUs for builds.</p> </li> </ul>"
},
"environmentVariables":{
"shape":"EnvironmentVariables",
"documentation":"<p>A set of environment variables to make available to builds for this build project.</p>"
}
},
"documentation":"<p>Information about the build environment of the build project.</p>"
},
"ProjectName":{
"type":"string",
"max":255,
"min":2,
"pattern":"[A-Za-z0-9][A-Za-z0-9\\-_]{1,254}"
},
"ProjectNames":{
"type":"list",
"member":{"shape":"NonEmptyString"},
"max":100,
"min":1
},
"ProjectSortByType":{
"type":"string",
"enum":[
"NAME",
"CREATED_TIME",
"LAST_MODIFIED_TIME"
]
},
"ProjectSource":{
"type":"structure",
"required":["type"],
"members":{
"type":{
"shape":"SourceType",
"documentation":"<p>The type of repository that contains the source code to be built. Valid values include:</p> <ul> <li> <p> <code>CODECOMMIT</code>: The source code is in an AWS CodeCommit repository.</p> </li> <li> <p> <code>CODEPIPELINE</code>: The source code settings are specified in the source action of a pipeline in AWS CodePipeline.</p> </li> <li> <p> <code>GITHUB</code>: The source code is in a GitHub repository.</p> </li> <li> <p> <code>S3</code>: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.</p> </li> </ul>"
},
"location":{
"shape":"String",
"documentation":"<p>Information about the location of the source code to be built. Valid values include:</p> <ul> <li> <p>For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, <code>location</code> should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.</p> </li> <li> <p>For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, <code>https://git-codecommit.<i>region-ID</i>.amazonaws.com/v1/repos/<i>repo-name</i> </code>).</p> </li> <li> <p>For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, <code> <i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>object-name</i>.zip</code>)</p> </li> <li> <p>For source code in a GitHub repository, instead of specifying a value here, you connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project, and follow the on-screen instructions to complete the connection. (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> </ul>"
},
"buildspec":{
"shape":"String",
"documentation":"<p>The build spec declaration to use for the builds in this build project.</p> <p>If this value is not specified, a build spec must be included along with the source code to be built.</p>"
},
"auth":{
"shape":"SourceAuth",
"documentation":"<p>Information about the authorization settings for AWS CodeBuild to access the source code to be built.</p> <p>This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source <code>type</code> value is <code>GITHUB</code>).</p>"
}
},
"documentation":"<p>Information about the build input source code for the build project.</p>"
},
"Projects":{
"type":"list",
"member":{"shape":"Project"}
},
"ResourceAlreadyExistsException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified AWS resource cannot be created, because an AWS resource with the same settings already exists.</p>",
"exception":true
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified AWS resource cannot be found.</p>",
"exception":true
},
"SortOrderType":{
"type":"string",
"enum":[
"ASCENDING",
"DESCENDING"
]
},
"SourceAuth":{
"type":"structure",
"required":["type"],
"members":{
"type":{
"shape":"SourceAuthType",
"documentation":"<p>The authorization type to use. The only valid value is <code>OAUTH</code>, which represents the OAuth authorization type.</p>"
},
"resource":{
"shape":"String",
"documentation":"<p>The resource value that applies to the specified authorization type.</p>"
}
},
"documentation":"<p>Information about the authorization settings for AWS CodeBuild to access the source code to be built.</p> <p>This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source <code>type</code> value is <code>GITHUB</code>).</p>"
},
"SourceAuthType":{
"type":"string",
"enum":["OAUTH"]
},
"SourceType":{
"type":"string",
"enum":[
"CODECOMMIT",
"CODEPIPELINE",
"GITHUB",
"S3"
]
},
"StartBuildInput":{
"type":"structure",
"required":["projectName"],
"members":{
"projectName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the build project to start running a build.</p>"
},
"sourceVersion":{
"shape":"String",
"documentation":"<p>A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:</p> <ul> <li> <p>For AWS CodeCommit or GitHub: the commit ID to use.</p> </li> <li> <p>For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.</p> </li> </ul>"
},
"artifactsOverride":{
"shape":"ProjectArtifacts",
"documentation":"<p>Build output artifact settings that override, for this build only, the latest ones already defined in the build project.</p>"
},
"environmentVariablesOverride":{
"shape":"EnvironmentVariables",
"documentation":"<p>A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.</p>"
},
"buildspecOverride":{
"shape":"String",
"documentation":"<p>A build spec declaration that overrides, for this build only, the latest one already defined in the build project.</p>"
},
"timeoutInMinutesOverride":{
"shape":"TimeOut",
"documentation":"<p>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.</p>"
}
}
},
"StartBuildOutput":{
"type":"structure",
"members":{
"build":{
"shape":"Build",
"documentation":"<p>Information about the build to be run.</p>"
}
}
},
"StatusType":{
"type":"string",
"enum":[
"SUCCEEDED",
"FAILED",
"FAULT",
"TIMED_OUT",
"IN_PROGRESS",
"STOPPED"
]
},
"StopBuildInput":{
"type":"structure",
"required":["id"],
"members":{
"id":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the build.</p>"
}
}
},
"StopBuildOutput":{
"type":"structure",
"members":{
"build":{
"shape":"Build",
"documentation":"<p>Information about the build.</p>"
}
}