@aws-sdk/client-codebuild 3.379.1 → 3.385.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -67,6 +67,7 @@ export type AuthType = (typeof AuthType)[keyof typeof AuthType];
67
67
  */
68
68
  export interface BatchDeleteBuildsInput {
69
69
  /**
70
+ * @public
70
71
  * <p>The IDs of the builds to delete.</p>
71
72
  */
72
73
  ids: string[] | undefined;
@@ -77,10 +78,12 @@ export interface BatchDeleteBuildsInput {
77
78
  */
78
79
  export interface BuildNotDeleted {
79
80
  /**
81
+ * @public
80
82
  * <p>The ID of the build that could not be successfully deleted.</p>
81
83
  */
82
84
  id?: string;
83
85
  /**
86
+ * @public
84
87
  * <p>Additional information about the build that could not be successfully deleted.</p>
85
88
  */
86
89
  statusCode?: string;
@@ -90,10 +93,12 @@ export interface BuildNotDeleted {
90
93
  */
91
94
  export interface BatchDeleteBuildsOutput {
92
95
  /**
96
+ * @public
93
97
  * <p>The IDs of the builds that were successfully deleted.</p>
94
98
  */
95
99
  buildsDeleted?: string[];
96
100
  /**
101
+ * @public
97
102
  * <p>Information about any builds that could not be successfully deleted.</p>
98
103
  */
99
104
  buildsNotDeleted?: BuildNotDeleted[];
@@ -115,6 +120,7 @@ export declare class InvalidInputException extends __BaseException {
115
120
  */
116
121
  export interface BatchGetBuildBatchesInput {
117
122
  /**
123
+ * @public
118
124
  * <p>An array that contains the batch build identifiers to retrieve.</p>
119
125
  */
120
126
  ids: string[] | undefined;
@@ -138,10 +144,12 @@ export type BucketOwnerAccess = (typeof BucketOwnerAccess)[keyof typeof BucketOw
138
144
  */
139
145
  export interface BuildArtifacts {
140
146
  /**
147
+ * @public
141
148
  * <p>Information about the location of the build artifacts.</p>
142
149
  */
143
150
  location?: string;
144
151
  /**
152
+ * @public
145
153
  * <p>The SHA-256 hash of the build artifact.</p>
146
154
  * <p>You can use this hash along with a checksum tool to confirm file integrity and
147
155
  * authenticity.</p>
@@ -152,6 +160,7 @@ export interface BuildArtifacts {
152
160
  */
153
161
  sha256sum?: string;
154
162
  /**
163
+ * @public
155
164
  * <p>The MD5 hash of the build artifact.</p>
156
165
  * <p>You can use this hash along with a checksum tool to confirm file integrity and
157
166
  * authenticity.</p>
@@ -162,6 +171,7 @@ export interface BuildArtifacts {
162
171
  */
163
172
  md5sum?: string;
164
173
  /**
174
+ * @public
165
175
  * <p> If this flag is set, a name specified in the buildspec file overrides the artifact
166
176
  * name. The name specified in a buildspec file is calculated at build time and uses the
167
177
  * Shell Command Language. For example, you can append a date and time to your artifact
@@ -169,14 +179,17 @@ export interface BuildArtifacts {
169
179
  */
170
180
  overrideArtifactName?: boolean;
171
181
  /**
182
+ * @public
172
183
  * <p> Information that tells you if encryption for build artifacts is disabled. </p>
173
184
  */
174
185
  encryptionDisabled?: boolean;
175
186
  /**
187
+ * @public
176
188
  * <p> An identifier for this artifact definition. </p>
177
189
  */
178
190
  artifactIdentifier?: string;
179
191
  /**
192
+ * @public
180
193
  * <p>Specifies the bucket owner's access for objects that another account uploads to their
181
194
  * Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has
182
195
  * access to these objects. This property allows you to give the bucket owner access to
@@ -240,10 +253,12 @@ export type BatchReportModeType = (typeof BatchReportModeType)[keyof typeof Batc
240
253
  */
241
254
  export interface BatchRestrictions {
242
255
  /**
256
+ * @public
243
257
  * <p>Specifies the maximum number of builds allowed.</p>
244
258
  */
245
259
  maximumBuildsAllowed?: number;
246
260
  /**
261
+ * @public
247
262
  * <p>An array of strings that specify the compute types that are allowed for the batch
248
263
  * build. See <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html">Build environment
249
264
  * compute types</a> in the <i>CodeBuild User Guide</i> for these values.
@@ -257,24 +272,29 @@ export interface BatchRestrictions {
257
272
  */
258
273
  export interface ProjectBuildBatchConfig {
259
274
  /**
275
+ * @public
260
276
  * <p>Specifies the service role ARN for the batch build project.</p>
261
277
  */
262
278
  serviceRole?: string;
263
279
  /**
280
+ * @public
264
281
  * <p>Specifies if the build artifacts for the batch build should be combined into a single
265
282
  * artifact location.</p>
266
283
  */
267
284
  combineArtifacts?: boolean;
268
285
  /**
286
+ * @public
269
287
  * <p>A <code>BatchRestrictions</code> object that specifies the restrictions for the batch
270
288
  * build.</p>
271
289
  */
272
290
  restrictions?: BatchRestrictions;
273
291
  /**
292
+ * @public
274
293
  * <p>Specifies the maximum amount of time, in minutes, that the batch build must be completed in.</p>
275
294
  */
276
295
  timeoutInMins?: number;
277
296
  /**
297
+ * @public
278
298
  * <p>Specifies how build status reports are sent to the source provider for the batch build. This property is only used
279
299
  * when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise,
280
300
  * and your project is configured to report build statuses to the source provider.</p>
@@ -314,14 +334,17 @@ export type StatusType = (typeof StatusType)[keyof typeof StatusType];
314
334
  */
315
335
  export interface ResolvedArtifact {
316
336
  /**
337
+ * @public
317
338
  * <p>Specifies the type of artifact.</p>
318
339
  */
319
340
  type?: ArtifactsType | string;
320
341
  /**
342
+ * @public
321
343
  * <p>The location of the artifact.</p>
322
344
  */
323
345
  location?: string;
324
346
  /**
347
+ * @public
325
348
  * <p>The identifier of the artifact.</p>
326
349
  */
327
350
  identifier?: string;
@@ -332,14 +355,17 @@ export interface ResolvedArtifact {
332
355
  */
333
356
  export interface BuildSummary {
334
357
  /**
358
+ * @public
335
359
  * <p>The batch build ARN.</p>
336
360
  */
337
361
  arn?: string;
338
362
  /**
363
+ * @public
339
364
  * <p>When the build was started, expressed in Unix time format.</p>
340
365
  */
341
366
  requestedOn?: Date;
342
367
  /**
368
+ * @public
343
369
  * <p>The status of the build group.</p>
344
370
  * <dl>
345
371
  * <dt>FAILED</dt>
@@ -370,11 +396,13 @@ export interface BuildSummary {
370
396
  */
371
397
  buildStatus?: StatusType | string;
372
398
  /**
399
+ * @public
373
400
  * <p>A <code>ResolvedArtifact</code> object that represents the primary build artifacts for the
374
401
  * build group.</p>
375
402
  */
376
403
  primaryArtifact?: ResolvedArtifact;
377
404
  /**
405
+ * @public
378
406
  * <p>An array of <code>ResolvedArtifact</code> objects that represents the secondary build
379
407
  * artifacts for the build group.</p>
380
408
  */
@@ -388,24 +416,29 @@ export interface BuildSummary {
388
416
  */
389
417
  export interface BuildGroup {
390
418
  /**
419
+ * @public
391
420
  * <p>Contains the identifier of the build group.</p>
392
421
  */
393
422
  identifier?: string;
394
423
  /**
424
+ * @public
395
425
  * <p>An array of strings that contain the identifiers of the build groups that this build
396
426
  * group depends on.</p>
397
427
  */
398
428
  dependsOn?: string[];
399
429
  /**
430
+ * @public
400
431
  * <p>Specifies if failures in this build group can be ignored.</p>
401
432
  */
402
433
  ignoreFailure?: boolean;
403
434
  /**
435
+ * @public
404
436
  * <p>A <code>BuildSummary</code> object that contains a summary of the current build
405
437
  * group.</p>
406
438
  */
407
439
  currentBuildSummary?: BuildSummary;
408
440
  /**
441
+ * @public
409
442
  * <p>An array of <code>BuildSummary</code> objects that contain summaries of previous
410
443
  * build groups.</p>
411
444
  */
@@ -443,6 +476,7 @@ export type CacheType = (typeof CacheType)[keyof typeof CacheType];
443
476
  */
444
477
  export interface ProjectCache {
445
478
  /**
479
+ * @public
446
480
  * <p>The type of cache used by the build project. Valid values include:</p>
447
481
  * <ul>
448
482
  * <li>
@@ -462,6 +496,7 @@ export interface ProjectCache {
462
496
  */
463
497
  type: CacheType | string | undefined;
464
498
  /**
499
+ * @public
465
500
  * <p>Information about the cache location: </p>
466
501
  * <ul>
467
502
  * <li>
@@ -476,6 +511,7 @@ export interface ProjectCache {
476
511
  */
477
512
  location?: string;
478
513
  /**
514
+ * @public
479
515
  * <p>An array of strings that specify the local cache modes. You can use one or more local
480
516
  * cache modes at the same time. This is only used for <code>LOCAL</code> cache
481
517
  * types.</p>
@@ -570,10 +606,12 @@ export type EnvironmentVariableType = (typeof EnvironmentVariableType)[keyof typ
570
606
  */
571
607
  export interface EnvironmentVariable {
572
608
  /**
609
+ * @public
573
610
  * <p>The name or key of the environment variable.</p>
574
611
  */
575
612
  name: string | undefined;
576
613
  /**
614
+ * @public
577
615
  * <p>The value of the environment variable.</p>
578
616
  * <important>
579
617
  * <p>We strongly discourage the use of <code>PLAINTEXT</code> environment variables to
@@ -586,6 +624,7 @@ export interface EnvironmentVariable {
586
624
  */
587
625
  value: string | undefined;
588
626
  /**
627
+ * @public
589
628
  * <p>The type of environment variable. Valid values include:</p>
590
629
  * <ul>
591
630
  * <li>
@@ -652,6 +691,7 @@ export type CredentialProviderType = (typeof CredentialProviderType)[keyof typeo
652
691
  */
653
692
  export interface RegistryCredential {
654
693
  /**
694
+ * @public
655
695
  * <p> The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager. </p>
656
696
  * <note>
657
697
  * <p> The <code>credential</code> can use the name of the credentials only if they
@@ -660,6 +700,7 @@ export interface RegistryCredential {
660
700
  */
661
701
  credential: string | undefined;
662
702
  /**
703
+ * @public
663
704
  * <p> The service that created the credentials to access a private Docker registry. The
664
705
  * valid value, SECRETS_MANAGER, is for Secrets Manager. </p>
665
706
  */
@@ -686,6 +727,7 @@ export type EnvironmentType = (typeof EnvironmentType)[keyof typeof EnvironmentT
686
727
  */
687
728
  export interface ProjectEnvironment {
688
729
  /**
730
+ * @public
689
731
  * <p>The type of build environment to use for related builds.</p>
690
732
  * <ul>
691
733
  * <li>
@@ -725,6 +767,7 @@ export interface ProjectEnvironment {
725
767
  */
726
768
  type: EnvironmentType | string | undefined;
727
769
  /**
770
+ * @public
728
771
  * <p>The image tag or image digest that identifies the Docker image to use for this build
729
772
  * project. Use the following formats:</p>
730
773
  * <ul>
@@ -745,6 +788,7 @@ export interface ProjectEnvironment {
745
788
  */
746
789
  image: string | undefined;
747
790
  /**
791
+ * @public
748
792
  * <p>Information about the compute resources the build project uses. Available values
749
793
  * include:</p>
750
794
  * <ul>
@@ -791,11 +835,13 @@ export interface ProjectEnvironment {
791
835
  */
792
836
  computeType: ComputeType | string | undefined;
793
837
  /**
838
+ * @public
794
839
  * <p>A set of environment variables to make available to builds for this build
795
840
  * project.</p>
796
841
  */
797
842
  environmentVariables?: EnvironmentVariable[];
798
843
  /**
844
+ * @public
799
845
  * <p>Enables running the Docker daemon inside a Docker container. Set to true only if the
800
846
  * build project is used to build Docker images. Otherwise, a build that attempts to
801
847
  * interact with the Docker daemon fails. The default setting is <code>false</code>.</p>
@@ -820,16 +866,19 @@ export interface ProjectEnvironment {
820
866
  */
821
867
  privilegedMode?: boolean;
822
868
  /**
869
+ * @public
823
870
  * <p>The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded
824
871
  * certificate for the build project. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate">certificate</a> in the
825
872
  * <i>CodeBuild User Guide</i>.</p>
826
873
  */
827
874
  certificate?: string;
828
875
  /**
876
+ * @public
829
877
  * <p> The credentials for access to a private registry.</p>
830
878
  */
831
879
  registryCredential?: RegistryCredential;
832
880
  /**
881
+ * @public
833
882
  * <p> The type of credentials CodeBuild uses to pull images in your build. There are two valid
834
883
  * values: </p>
835
884
  * <ul>
@@ -870,10 +919,12 @@ export type FileSystemType = (typeof FileSystemType)[keyof typeof FileSystemType
870
919
  */
871
920
  export interface ProjectFileSystemLocation {
872
921
  /**
922
+ * @public
873
923
  * <p> The type of the file system. The one supported type is <code>EFS</code>. </p>
874
924
  */
875
925
  type?: FileSystemType | string;
876
926
  /**
927
+ * @public
877
928
  * <p>A string that specifies the location of the file system created by Amazon EFS. Its
878
929
  * format is <code>efs-dns-name:/directory-path</code>. You can find the DNS name of file
879
930
  * system when you view it in the Amazon EFS console. The directory path is a path to a
@@ -887,10 +938,12 @@ export interface ProjectFileSystemLocation {
887
938
  */
888
939
  location?: string;
889
940
  /**
941
+ * @public
890
942
  * <p>The location in the container where you mount the file system. </p>
891
943
  */
892
944
  mountPoint?: string;
893
945
  /**
946
+ * @public
894
947
  * <p>The name used to access a file system created by Amazon EFS. CodeBuild creates an
895
948
  * environment variable by appending the <code>identifier</code> in all capital letters to
896
949
  * <code>CODEBUILD_</code>. For example, if you specify <code>my_efs</code> for
@@ -900,6 +953,7 @@ export interface ProjectFileSystemLocation {
900
953
  */
901
954
  identifier?: string;
902
955
  /**
956
+ * @public
903
957
  * <p> The mount options for a file system created by Amazon EFS. The default mount options
904
958
  * used by CodeBuild are
905
959
  * <code>nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2</code>. For
@@ -926,6 +980,7 @@ export type LogsConfigStatusType = (typeof LogsConfigStatusType)[keyof typeof Lo
926
980
  */
927
981
  export interface CloudWatchLogsConfig {
928
982
  /**
983
+ * @public
929
984
  * <p>The current status of the logs in CloudWatch Logs for a build project. Valid values are:</p>
930
985
  * <ul>
931
986
  * <li>
@@ -940,11 +995,13 @@ export interface CloudWatchLogsConfig {
940
995
  */
941
996
  status: LogsConfigStatusType | string | undefined;
942
997
  /**
998
+ * @public
943
999
  * <p> The group name of the logs in CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working
944
1000
  * with Log Groups and Log Streams</a>. </p>
945
1001
  */
946
1002
  groupName?: string;
947
1003
  /**
1004
+ * @public
948
1005
  * <p> The prefix of the stream name of the CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working
949
1006
  * with Log Groups and Log Streams</a>. </p>
950
1007
  */
@@ -956,6 +1013,7 @@ export interface CloudWatchLogsConfig {
956
1013
  */
957
1014
  export interface S3LogsConfig {
958
1015
  /**
1016
+ * @public
959
1017
  * <p>The current status of the S3 build logs. Valid values are:</p>
960
1018
  * <ul>
961
1019
  * <li>
@@ -971,6 +1029,7 @@ export interface S3LogsConfig {
971
1029
  */
972
1030
  status: LogsConfigStatusType | string | undefined;
973
1031
  /**
1032
+ * @public
974
1033
  * <p> The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket
975
1034
  * name is <code>my-bucket</code>, and your path prefix is <code>build-log</code>, then
976
1035
  * acceptable formats are <code>my-bucket/build-log</code> or
@@ -978,11 +1037,13 @@ export interface S3LogsConfig {
978
1037
  */
979
1038
  location?: string;
980
1039
  /**
1040
+ * @public
981
1041
  * <p> Set to true if you do not want your S3 build log output encrypted. By default S3
982
1042
  * build logs are encrypted. </p>
983
1043
  */
984
1044
  encryptionDisabled?: boolean;
985
1045
  /**
1046
+ * @public
986
1047
  * <p>Specifies the bucket owner's access for objects that another account uploads to their
987
1048
  * Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has
988
1049
  * access to these objects. This property allows you to give the bucket owner access to
@@ -1035,10 +1096,12 @@ export interface S3LogsConfig {
1035
1096
  */
1036
1097
  export interface LogsConfig {
1037
1098
  /**
1099
+ * @public
1038
1100
  * <p> Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default. </p>
1039
1101
  */
1040
1102
  cloudWatchLogs?: CloudWatchLogsConfig;
1041
1103
  /**
1104
+ * @public
1042
1105
  * <p> Information about logs built to an S3 bucket for a build project. S3 logs are not
1043
1106
  * enabled by default. </p>
1044
1107
  */
@@ -1051,10 +1114,12 @@ export interface LogsConfig {
1051
1114
  */
1052
1115
  export interface PhaseContext {
1053
1116
  /**
1117
+ * @public
1054
1118
  * <p>The status code for the context of the build phase.</p>
1055
1119
  */
1056
1120
  statusCode?: string;
1057
1121
  /**
1122
+ * @public
1058
1123
  * <p>An explanation of the build phase's context. This might include a command ID and an
1059
1124
  * exit code.</p>
1060
1125
  */
@@ -1083,6 +1148,7 @@ export type BuildBatchPhaseType = (typeof BuildBatchPhaseType)[keyof typeof Buil
1083
1148
  */
1084
1149
  export interface BuildBatchPhase {
1085
1150
  /**
1151
+ * @public
1086
1152
  * <p>The name of the batch build phase. Valid values include:</p>
1087
1153
  * <dl>
1088
1154
  * <dt>COMBINE_ARTIFACTS</dt>
@@ -1118,6 +1184,7 @@ export interface BuildBatchPhase {
1118
1184
  */
1119
1185
  phaseType?: BuildBatchPhaseType | string;
1120
1186
  /**
1187
+ * @public
1121
1188
  * <p>The current status of the batch build phase. Valid values include:</p>
1122
1189
  * <dl>
1123
1190
  * <dt>FAILED</dt>
@@ -1148,19 +1215,23 @@ export interface BuildBatchPhase {
1148
1215
  */
1149
1216
  phaseStatus?: StatusType | string;
1150
1217
  /**
1218
+ * @public
1151
1219
  * <p>When the batch build phase started, expressed in Unix time format.</p>
1152
1220
  */
1153
1221
  startTime?: Date;
1154
1222
  /**
1223
+ * @public
1155
1224
  * <p>When the batch build phase ended, expressed in Unix time format.</p>
1156
1225
  */
1157
1226
  endTime?: Date;
1158
1227
  /**
1228
+ * @public
1159
1229
  * <p>How long, in seconds, between the starting and ending times of the batch build's
1160
1230
  * phase.</p>
1161
1231
  */
1162
1232
  durationInSeconds?: number;
1163
1233
  /**
1234
+ * @public
1164
1235
  * <p>Additional information about the batch build phase. Especially to help troubleshoot a
1165
1236
  * failed batch build.</p>
1166
1237
  */
@@ -1186,6 +1257,7 @@ export type SourceAuthType = (typeof SourceAuthType)[keyof typeof SourceAuthType
1186
1257
  */
1187
1258
  export interface SourceAuth {
1188
1259
  /**
1260
+ * @public
1189
1261
  * <note>
1190
1262
  * <p> This data type is deprecated and is no longer accurate or used. </p>
1191
1263
  * </note>
@@ -1194,6 +1266,7 @@ export interface SourceAuth {
1194
1266
  */
1195
1267
  type: SourceAuthType | string | undefined;
1196
1268
  /**
1269
+ * @public
1197
1270
  * <p>The resource value that applies to the specified authorization type.</p>
1198
1271
  */
1199
1272
  resource?: string;
@@ -1205,6 +1278,7 @@ export interface SourceAuth {
1205
1278
  */
1206
1279
  export interface BuildStatusConfig {
1207
1280
  /**
1281
+ * @public
1208
1282
  * <p>Specifies the context of the build status CodeBuild sends to the source provider. The
1209
1283
  * usage of this parameter depends on the source provider.</p>
1210
1284
  * <dl>
@@ -1222,6 +1296,7 @@ export interface BuildStatusConfig {
1222
1296
  */
1223
1297
  context?: string;
1224
1298
  /**
1299
+ * @public
1225
1300
  * <p>Specifies the target url of the build status CodeBuild sends to the source provider. The
1226
1301
  * usage of this parameter depends on the source provider.</p>
1227
1302
  * <dl>
@@ -1246,6 +1321,7 @@ export interface BuildStatusConfig {
1246
1321
  */
1247
1322
  export interface GitSubmodulesConfig {
1248
1323
  /**
1324
+ * @public
1249
1325
  * <p> Set to true to fetch Git submodules for your CodeBuild build project. </p>
1250
1326
  */
1251
1327
  fetchSubmodules: boolean | undefined;
@@ -1273,6 +1349,7 @@ export type SourceType = (typeof SourceType)[keyof typeof SourceType];
1273
1349
  */
1274
1350
  export interface ProjectSource {
1275
1351
  /**
1352
+ * @public
1276
1353
  * <p>The type of repository that contains the source code to be built. Valid values
1277
1354
  * include:</p>
1278
1355
  * <ul>
@@ -1311,6 +1388,7 @@ export interface ProjectSource {
1311
1388
  */
1312
1389
  type: SourceType | string | undefined;
1313
1390
  /**
1391
+ * @public
1314
1392
  * <p>Information about the location of the source code to be built. Valid values
1315
1393
  * include:</p>
1316
1394
  * <ul>
@@ -1373,14 +1451,17 @@ export interface ProjectSource {
1373
1451
  */
1374
1452
  location?: string;
1375
1453
  /**
1454
+ * @public
1376
1455
  * <p>Information about the Git clone depth for the build project.</p>
1377
1456
  */
1378
1457
  gitCloneDepth?: number;
1379
1458
  /**
1459
+ * @public
1380
1460
  * <p> Information about the Git submodules configuration for the build project. </p>
1381
1461
  */
1382
1462
  gitSubmodulesConfig?: GitSubmodulesConfig;
1383
1463
  /**
1464
+ * @public
1384
1465
  * <p>The buildspec file declaration to use for the builds in this build project.</p>
1385
1466
  * <p> If this value is set, it can be either an inline buildspec definition, the path to an
1386
1467
  * alternate buildspec file relative to the value of the built-in
@@ -1393,6 +1474,7 @@ export interface ProjectSource {
1393
1474
  */
1394
1475
  buildspec?: string;
1395
1476
  /**
1477
+ * @public
1396
1478
  * <p>Information about the authorization settings for CodeBuild to access the source code to be
1397
1479
  * built.</p>
1398
1480
  * <p>This information is for the CodeBuild console's use only. Your code should not get or set
@@ -1400,6 +1482,7 @@ export interface ProjectSource {
1400
1482
  */
1401
1483
  auth?: SourceAuth;
1402
1484
  /**
1485
+ * @public
1403
1486
  * <p> Set to true to report the status of a build's start and finish to your source
1404
1487
  * provider. This option is valid only when your source provider is GitHub, GitHub
1405
1488
  * Enterprise, or Bitbucket. If this is set and you use a different source provider, an
@@ -1414,6 +1497,7 @@ export interface ProjectSource {
1414
1497
  */
1415
1498
  reportBuildStatus?: boolean;
1416
1499
  /**
1500
+ * @public
1417
1501
  * <p>Contains information that defines how the build project reports the build status to
1418
1502
  * the source provider. This option is only used when the source provider is
1419
1503
  * <code>GITHUB</code>, <code>GITHUB_ENTERPRISE</code>, or
@@ -1421,11 +1505,13 @@ export interface ProjectSource {
1421
1505
  */
1422
1506
  buildStatusConfig?: BuildStatusConfig;
1423
1507
  /**
1508
+ * @public
1424
1509
  * <p>Enable this flag to ignore SSL warnings while connecting to the project source
1425
1510
  * code.</p>
1426
1511
  */
1427
1512
  insecureSsl?: boolean;
1428
1513
  /**
1514
+ * @public
1429
1515
  * <p>An identifier for this project source. The identifier can only contain
1430
1516
  * alphanumeric characters and underscores, and must be less than 128 characters in length. </p>
1431
1517
  */
@@ -1437,11 +1523,13 @@ export interface ProjectSource {
1437
1523
  */
1438
1524
  export interface ProjectSourceVersion {
1439
1525
  /**
1526
+ * @public
1440
1527
  * <p>An identifier for a source in the build project. The identifier can only contain
1441
1528
  * alphanumeric characters and underscores, and must be less than 128 characters in length. </p>
1442
1529
  */
1443
1530
  sourceIdentifier: string | undefined;
1444
1531
  /**
1532
+ * @public
1445
1533
  * <p>The source version for the corresponding source identifier. If specified, must be one
1446
1534
  * of:</p>
1447
1535
  * <ul>
@@ -1478,14 +1566,17 @@ export interface ProjectSourceVersion {
1478
1566
  */
1479
1567
  export interface VpcConfig {
1480
1568
  /**
1569
+ * @public
1481
1570
  * <p>The ID of the Amazon VPC.</p>
1482
1571
  */
1483
1572
  vpcId?: string;
1484
1573
  /**
1574
+ * @public
1485
1575
  * <p>A list of one or more subnet IDs in your Amazon VPC.</p>
1486
1576
  */
1487
1577
  subnets?: string[];
1488
1578
  /**
1579
+ * @public
1489
1580
  * <p>A list of one or more security groups IDs in your Amazon VPC.</p>
1490
1581
  */
1491
1582
  securityGroupIds?: string[];
@@ -1496,34 +1587,42 @@ export interface VpcConfig {
1496
1587
  */
1497
1588
  export interface BuildBatch {
1498
1589
  /**
1590
+ * @public
1499
1591
  * <p>The identifier of the batch build.</p>
1500
1592
  */
1501
1593
  id?: string;
1502
1594
  /**
1595
+ * @public
1503
1596
  * <p>The ARN of the batch build.</p>
1504
1597
  */
1505
1598
  arn?: string;
1506
1599
  /**
1600
+ * @public
1507
1601
  * <p>The date and time that the batch build started.</p>
1508
1602
  */
1509
1603
  startTime?: Date;
1510
1604
  /**
1605
+ * @public
1511
1606
  * <p>The date and time that the batch build ended.</p>
1512
1607
  */
1513
1608
  endTime?: Date;
1514
1609
  /**
1610
+ * @public
1515
1611
  * <p>The current phase of the batch build.</p>
1516
1612
  */
1517
1613
  currentPhase?: string;
1518
1614
  /**
1615
+ * @public
1519
1616
  * <p>The status of the batch build.</p>
1520
1617
  */
1521
1618
  buildBatchStatus?: StatusType | string;
1522
1619
  /**
1620
+ * @public
1523
1621
  * <p>The identifier of the version of the source code to be built.</p>
1524
1622
  */
1525
1623
  sourceVersion?: string;
1526
1624
  /**
1625
+ * @public
1527
1626
  * <p>The identifier of the resolved version of this batch build's source code.</p>
1528
1627
  * <ul>
1529
1628
  * <li>
@@ -1539,24 +1638,29 @@ export interface BuildBatch {
1539
1638
  */
1540
1639
  resolvedSourceVersion?: string;
1541
1640
  /**
1641
+ * @public
1542
1642
  * <p>The name of the batch build project.</p>
1543
1643
  */
1544
1644
  projectName?: string;
1545
1645
  /**
1646
+ * @public
1546
1647
  * <p>An array of <code>BuildBatchPhase</code> objects the specify the phases of the
1547
1648
  * batch build.</p>
1548
1649
  */
1549
1650
  phases?: BuildBatchPhase[];
1550
1651
  /**
1652
+ * @public
1551
1653
  * <p>Information about the build input source code for the build project.</p>
1552
1654
  */
1553
1655
  source?: ProjectSource;
1554
1656
  /**
1657
+ * @public
1555
1658
  * <p>An array of <code>ProjectSource</code> objects that define the sources for the batch
1556
1659
  * build.</p>
1557
1660
  */
1558
1661
  secondarySources?: ProjectSource[];
1559
1662
  /**
1663
+ * @public
1560
1664
  * <p>An array of <code>ProjectSourceVersion</code> objects. Each
1561
1665
  * <code>ProjectSourceVersion</code> must be one of: </p>
1562
1666
  * <ul>
@@ -1585,46 +1689,56 @@ export interface BuildBatch {
1585
1689
  */
1586
1690
  secondarySourceVersions?: ProjectSourceVersion[];
1587
1691
  /**
1692
+ * @public
1588
1693
  * <p>A <code>BuildArtifacts</code> object the defines the build artifacts for this batch build.</p>
1589
1694
  */
1590
1695
  artifacts?: BuildArtifacts;
1591
1696
  /**
1697
+ * @public
1592
1698
  * <p>An array of <code>BuildArtifacts</code> objects the define the build artifacts
1593
1699
  * for this batch build.</p>
1594
1700
  */
1595
1701
  secondaryArtifacts?: BuildArtifacts[];
1596
1702
  /**
1703
+ * @public
1597
1704
  * <p>Information about the cache for the build project.</p>
1598
1705
  */
1599
1706
  cache?: ProjectCache;
1600
1707
  /**
1708
+ * @public
1601
1709
  * <p>Information about the build environment of the build project.</p>
1602
1710
  */
1603
1711
  environment?: ProjectEnvironment;
1604
1712
  /**
1713
+ * @public
1605
1714
  * <p>The name of a service role used for builds in the batch.</p>
1606
1715
  */
1607
1716
  serviceRole?: string;
1608
1717
  /**
1718
+ * @public
1609
1719
  * <p> Information about logs for a build project. These can be logs in CloudWatch Logs, built in a
1610
1720
  * specified S3 bucket, or both. </p>
1611
1721
  */
1612
1722
  logConfig?: LogsConfig;
1613
1723
  /**
1724
+ * @public
1614
1725
  * <p>Specifies the maximum amount of time, in minutes, that the build in a batch must be
1615
1726
  * completed in.</p>
1616
1727
  */
1617
1728
  buildTimeoutInMinutes?: number;
1618
1729
  /**
1730
+ * @public
1619
1731
  * <p>Specifies the amount of time, in minutes, that the batch build is allowed to be queued
1620
1732
  * before it times out.</p>
1621
1733
  */
1622
1734
  queuedTimeoutInMinutes?: number;
1623
1735
  /**
1736
+ * @public
1624
1737
  * <p>Indicates if the batch build is complete.</p>
1625
1738
  */
1626
1739
  complete?: boolean;
1627
1740
  /**
1741
+ * @public
1628
1742
  * <p>The entity that started the batch build. Valid values include:</p>
1629
1743
  * <ul>
1630
1744
  * <li>
@@ -1642,10 +1756,12 @@ export interface BuildBatch {
1642
1756
  */
1643
1757
  initiator?: string;
1644
1758
  /**
1759
+ * @public
1645
1760
  * <p>Information about the VPC configuration that CodeBuild accesses.</p>
1646
1761
  */
1647
1762
  vpcConfig?: VpcConfig;
1648
1763
  /**
1764
+ * @public
1649
1765
  * <p>The Key Management Service customer master key (CMK) to be used for encrypting the batch build output
1650
1766
  * artifacts.</p>
1651
1767
  * <note>
@@ -1657,6 +1773,7 @@ export interface BuildBatch {
1657
1773
  */
1658
1774
  encryptionKey?: string;
1659
1775
  /**
1776
+ * @public
1660
1777
  * <p>The number of the batch build. For each project, the <code>buildBatchNumber</code> of its
1661
1778
  * first batch build is <code>1</code>. The <code>buildBatchNumber</code> of each subsequent
1662
1779
  * batch build is incremented by <code>1</code>. If a batch build is deleted, the
@@ -1664,6 +1781,7 @@ export interface BuildBatch {
1664
1781
  */
1665
1782
  buildBatchNumber?: number;
1666
1783
  /**
1784
+ * @public
1667
1785
  * <p>An array of <code>ProjectFileSystemLocation</code> objects for the batch build
1668
1786
  * project. A <code>ProjectFileSystemLocation</code> object specifies the
1669
1787
  * <code>identifier</code>, <code>location</code>, <code>mountOptions</code>,
@@ -1672,15 +1790,18 @@ export interface BuildBatch {
1672
1790
  */
1673
1791
  fileSystemLocations?: ProjectFileSystemLocation[];
1674
1792
  /**
1793
+ * @public
1675
1794
  * <p>Contains configuration information about a batch build project.</p>
1676
1795
  */
1677
1796
  buildBatchConfig?: ProjectBuildBatchConfig;
1678
1797
  /**
1798
+ * @public
1679
1799
  * <p>An array of <code>BuildGroup</code> objects that define the build groups for the
1680
1800
  * batch build.</p>
1681
1801
  */
1682
1802
  buildGroups?: BuildGroup[];
1683
1803
  /**
1804
+ * @public
1684
1805
  * <p>Specifies if session debugging is enabled for this batch build. For more information, see
1685
1806
  * <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html">Viewing a running build in Session Manager</a>. Batch session debugging is not supported for matrix batch builds.</p>
1686
1807
  */
@@ -1691,11 +1812,13 @@ export interface BuildBatch {
1691
1812
  */
1692
1813
  export interface BatchGetBuildBatchesOutput {
1693
1814
  /**
1815
+ * @public
1694
1816
  * <p>An array of <code>BuildBatch</code> objects that represent the retrieved batch
1695
1817
  * builds.</p>
1696
1818
  */
1697
1819
  buildBatches?: BuildBatch[];
1698
1820
  /**
1821
+ * @public
1699
1822
  * <p>An array that contains the identifiers of any batch builds that are not found.</p>
1700
1823
  */
1701
1824
  buildBatchesNotFound?: string[];
@@ -1705,6 +1828,7 @@ export interface BatchGetBuildBatchesOutput {
1705
1828
  */
1706
1829
  export interface BatchGetBuildsInput {
1707
1830
  /**
1831
+ * @public
1708
1832
  * <p>The IDs of the builds.</p>
1709
1833
  */
1710
1834
  ids: string[] | undefined;
@@ -1716,10 +1840,12 @@ export interface BatchGetBuildsInput {
1716
1840
  */
1717
1841
  export interface DebugSession {
1718
1842
  /**
1843
+ * @public
1719
1844
  * <p>Specifies if session debugging is enabled for this build.</p>
1720
1845
  */
1721
1846
  sessionEnabled?: boolean;
1722
1847
  /**
1848
+ * @public
1723
1849
  * <p>Contains the identifier of the Session Manager session used for the build. To work with
1724
1850
  * the paused build, you open this session to examine, control, and resume the
1725
1851
  * build.</p>
@@ -1742,10 +1868,12 @@ export interface DebugSession {
1742
1868
  */
1743
1869
  export interface ExportedEnvironmentVariable {
1744
1870
  /**
1871
+ * @public
1745
1872
  * <p>The name of the exported environment variable.</p>
1746
1873
  */
1747
1874
  name?: string;
1748
1875
  /**
1876
+ * @public
1749
1877
  * <p>The value assigned to the exported environment variable.</p>
1750
1878
  */
1751
1879
  value?: string;
@@ -1756,38 +1884,46 @@ export interface ExportedEnvironmentVariable {
1756
1884
  */
1757
1885
  export interface LogsLocation {
1758
1886
  /**
1887
+ * @public
1759
1888
  * <p>The name of the CloudWatch Logs group for the build logs.</p>
1760
1889
  */
1761
1890
  groupName?: string;
1762
1891
  /**
1892
+ * @public
1763
1893
  * <p>The name of the CloudWatch Logs stream for the build logs.</p>
1764
1894
  */
1765
1895
  streamName?: string;
1766
1896
  /**
1897
+ * @public
1767
1898
  * <p>The URL to an individual build log in CloudWatch Logs.</p>
1768
1899
  */
1769
1900
  deepLink?: string;
1770
1901
  /**
1902
+ * @public
1771
1903
  * <p> The URL to a build log in an S3 bucket. </p>
1772
1904
  */
1773
1905
  s3DeepLink?: string;
1774
1906
  /**
1907
+ * @public
1775
1908
  * <p> The ARN of CloudWatch Logs for a build project. Its format is
1776
1909
  * <code>arn:$\{Partition\}:logs:$\{Region\}:$\{Account\}:log-group:$\{LogGroupName\}:log-stream:$\{LogStreamName\}</code>.
1777
1910
  * For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatchlogs.html#amazoncloudwatchlogs-resources-for-iam-policies">Resources Defined by CloudWatch Logs</a>. </p>
1778
1911
  */
1779
1912
  cloudWatchLogsArn?: string;
1780
1913
  /**
1914
+ * @public
1781
1915
  * <p> The ARN of S3 logs for a build project. Its format is
1782
1916
  * <code>arn:$\{Partition\}:s3:::$\{BucketName\}/$\{ObjectName\}</code>. For more
1783
1917
  * information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html#amazons3-resources-for-iam-policies">Resources Defined by Amazon S3</a>. </p>
1784
1918
  */
1785
1919
  s3LogsArn?: string;
1786
1920
  /**
1921
+ * @public
1787
1922
  * <p> Information about CloudWatch Logs for a build project. </p>
1788
1923
  */
1789
1924
  cloudWatchLogs?: CloudWatchLogsConfig;
1790
1925
  /**
1926
+ * @public
1791
1927
  * <p> Information about S3 logs for a build project. </p>
1792
1928
  */
1793
1929
  s3Logs?: S3LogsConfig;
@@ -1798,10 +1934,12 @@ export interface LogsLocation {
1798
1934
  */
1799
1935
  export interface NetworkInterface {
1800
1936
  /**
1937
+ * @public
1801
1938
  * <p>The ID of the subnet.</p>
1802
1939
  */
1803
1940
  subnetId?: string;
1804
1941
  /**
1942
+ * @public
1805
1943
  * <p>The ID of the network interface.</p>
1806
1944
  */
1807
1945
  networkInterfaceId?: string;
@@ -1833,6 +1971,7 @@ export type BuildPhaseType = (typeof BuildPhaseType)[keyof typeof BuildPhaseType
1833
1971
  */
1834
1972
  export interface BuildPhase {
1835
1973
  /**
1974
+ * @public
1836
1975
  * <p>The name of the build phase. Valid values include:</p>
1837
1976
  * <dl>
1838
1977
  * <dt>BUILD</dt>
@@ -1884,6 +2023,7 @@ export interface BuildPhase {
1884
2023
  */
1885
2024
  phaseType?: BuildPhaseType | string;
1886
2025
  /**
2026
+ * @public
1887
2027
  * <p>The current status of the build phase. Valid values include:</p>
1888
2028
  * <dl>
1889
2029
  * <dt>FAILED</dt>
@@ -1914,19 +2054,23 @@ export interface BuildPhase {
1914
2054
  */
1915
2055
  phaseStatus?: StatusType | string;
1916
2056
  /**
2057
+ * @public
1917
2058
  * <p>When the build phase started, expressed in Unix time format.</p>
1918
2059
  */
1919
2060
  startTime?: Date;
1920
2061
  /**
2062
+ * @public
1921
2063
  * <p>When the build phase ended, expressed in Unix time format.</p>
1922
2064
  */
1923
2065
  endTime?: Date;
1924
2066
  /**
2067
+ * @public
1925
2068
  * <p>How long, in seconds, between the starting and ending times of the build's
1926
2069
  * phase.</p>
1927
2070
  */
1928
2071
  durationInSeconds?: number;
1929
2072
  /**
2073
+ * @public
1930
2074
  * <p>Additional information about a build phase, especially to help troubleshoot a failed
1931
2075
  * build.</p>
1932
2076
  */
@@ -1938,14 +2082,17 @@ export interface BuildPhase {
1938
2082
  */
1939
2083
  export interface Build {
1940
2084
  /**
2085
+ * @public
1941
2086
  * <p>The unique ID for the build.</p>
1942
2087
  */
1943
2088
  id?: string;
1944
2089
  /**
2090
+ * @public
1945
2091
  * <p>The Amazon Resource Name (ARN) of the build.</p>
1946
2092
  */
1947
2093
  arn?: string;
1948
2094
  /**
2095
+ * @public
1949
2096
  * <p>The number of the build. For each project, the <code>buildNumber</code> of its first
1950
2097
  * build is <code>1</code>. The <code>buildNumber</code> of each subsequent build is
1951
2098
  * incremented by <code>1</code>. If a build is deleted, the <code>buildNumber</code> of
@@ -1953,18 +2100,22 @@ export interface Build {
1953
2100
  */
1954
2101
  buildNumber?: number;
1955
2102
  /**
2103
+ * @public
1956
2104
  * <p>When the build process started, expressed in Unix time format.</p>
1957
2105
  */
1958
2106
  startTime?: Date;
1959
2107
  /**
2108
+ * @public
1960
2109
  * <p>When the build process ended, expressed in Unix time format.</p>
1961
2110
  */
1962
2111
  endTime?: Date;
1963
2112
  /**
2113
+ * @public
1964
2114
  * <p>The current build phase.</p>
1965
2115
  */
1966
2116
  currentPhase?: string;
1967
2117
  /**
2118
+ * @public
1968
2119
  * <p>The current status of the build. Valid values include:</p>
1969
2120
  * <ul>
1970
2121
  * <li>
@@ -1995,6 +2146,7 @@ export interface Build {
1995
2146
  */
1996
2147
  buildStatus?: StatusType | string;
1997
2148
  /**
2149
+ * @public
1998
2150
  * <p>Any version identifier for the version of the source code to be built. If
1999
2151
  * <code>sourceVersion</code> is specified at the project level, then this
2000
2152
  * <code>sourceVersion</code> (at the build level) takes precedence. </p>
@@ -2003,6 +2155,7 @@ export interface Build {
2003
2155
  */
2004
2156
  sourceVersion?: string;
2005
2157
  /**
2158
+ * @public
2006
2159
  * <p> An identifier for the version of this build's source code. </p>
2007
2160
  * <ul>
2008
2161
  * <li>
@@ -2018,23 +2171,28 @@ export interface Build {
2018
2171
  */
2019
2172
  resolvedSourceVersion?: string;
2020
2173
  /**
2174
+ * @public
2021
2175
  * <p>The name of the CodeBuild project.</p>
2022
2176
  */
2023
2177
  projectName?: string;
2024
2178
  /**
2179
+ * @public
2025
2180
  * <p>Information about all previous build phases that are complete and information about
2026
2181
  * any current build phase that is not yet complete.</p>
2027
2182
  */
2028
2183
  phases?: BuildPhase[];
2029
2184
  /**
2185
+ * @public
2030
2186
  * <p>Information about the source code to be built.</p>
2031
2187
  */
2032
2188
  source?: ProjectSource;
2033
2189
  /**
2190
+ * @public
2034
2191
  * <p> An array of <code>ProjectSource</code> objects. </p>
2035
2192
  */
2036
2193
  secondarySources?: ProjectSource[];
2037
2194
  /**
2195
+ * @public
2038
2196
  * <p> An array of <code>ProjectSourceVersion</code> objects. Each
2039
2197
  * <code>ProjectSourceVersion</code> must be one of: </p>
2040
2198
  * <ul>
@@ -2063,43 +2221,53 @@ export interface Build {
2063
2221
  */
2064
2222
  secondarySourceVersions?: ProjectSourceVersion[];
2065
2223
  /**
2224
+ * @public
2066
2225
  * <p>Information about the output artifacts for the build.</p>
2067
2226
  */
2068
2227
  artifacts?: BuildArtifacts;
2069
2228
  /**
2229
+ * @public
2070
2230
  * <p> An array of <code>ProjectArtifacts</code> objects. </p>
2071
2231
  */
2072
2232
  secondaryArtifacts?: BuildArtifacts[];
2073
2233
  /**
2234
+ * @public
2074
2235
  * <p>Information about the cache for the build.</p>
2075
2236
  */
2076
2237
  cache?: ProjectCache;
2077
2238
  /**
2239
+ * @public
2078
2240
  * <p>Information about the build environment for this build.</p>
2079
2241
  */
2080
2242
  environment?: ProjectEnvironment;
2081
2243
  /**
2244
+ * @public
2082
2245
  * <p>The name of a service role used for this build.</p>
2083
2246
  */
2084
2247
  serviceRole?: string;
2085
2248
  /**
2249
+ * @public
2086
2250
  * <p>Information about the build's logs in CloudWatch Logs.</p>
2087
2251
  */
2088
2252
  logs?: LogsLocation;
2089
2253
  /**
2254
+ * @public
2090
2255
  * <p>How long, in minutes, for CodeBuild to wait before timing out this build if it does not
2091
2256
  * get marked as completed.</p>
2092
2257
  */
2093
2258
  timeoutInMinutes?: number;
2094
2259
  /**
2260
+ * @public
2095
2261
  * <p> The number of minutes a build is allowed to be queued before it times out. </p>
2096
2262
  */
2097
2263
  queuedTimeoutInMinutes?: number;
2098
2264
  /**
2265
+ * @public
2099
2266
  * <p>Whether the build is complete. True if complete; otherwise, false.</p>
2100
2267
  */
2101
2268
  buildComplete?: boolean;
2102
2269
  /**
2270
+ * @public
2103
2271
  * <p>The entity that started the build. Valid values include:</p>
2104
2272
  * <ul>
2105
2273
  * <li>
@@ -2118,6 +2286,7 @@ export interface Build {
2118
2286
  */
2119
2287
  initiator?: string;
2120
2288
  /**
2289
+ * @public
2121
2290
  * <p>If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter
2122
2291
  * that identifies the VPC ID and the list of security group IDs and subnet IDs. The
2123
2292
  * security groups and subnets must belong to the same VPC. You must provide at least one
@@ -2125,10 +2294,12 @@ export interface Build {
2125
2294
  */
2126
2295
  vpcConfig?: VpcConfig;
2127
2296
  /**
2297
+ * @public
2128
2298
  * <p>Describes a network interface.</p>
2129
2299
  */
2130
2300
  networkInterface?: NetworkInterface;
2131
2301
  /**
2302
+ * @public
2132
2303
  * <p>The Key Management Service customer master key (CMK) to be used for encrypting the build output
2133
2304
  * artifacts.</p>
2134
2305
  * <note>
@@ -2140,6 +2311,7 @@ export interface Build {
2140
2311
  */
2141
2312
  encryptionKey?: string;
2142
2313
  /**
2314
+ * @public
2143
2315
  * <p>A list of exported environment variables for this build.</p>
2144
2316
  * <p>Exported environment variables are used in conjunction with CodePipeline to export
2145
2317
  * environment variables from the current build stage to subsequent stages in the pipeline.
@@ -2147,10 +2319,12 @@ export interface Build {
2147
2319
  */
2148
2320
  exportedEnvironmentVariables?: ExportedEnvironmentVariable[];
2149
2321
  /**
2322
+ * @public
2150
2323
  * <p> An array of the ARNs associated with this build's reports. </p>
2151
2324
  */
2152
2325
  reportArns?: string[];
2153
2326
  /**
2327
+ * @public
2154
2328
  * <p>
2155
2329
  * An array of <code>ProjectFileSystemLocation</code> objects for a CodeBuild build project. A <code>ProjectFileSystemLocation</code> object
2156
2330
  * specifies the <code>identifier</code>, <code>location</code>, <code>mountOptions</code>,
@@ -2159,10 +2333,12 @@ export interface Build {
2159
2333
  */
2160
2334
  fileSystemLocations?: ProjectFileSystemLocation[];
2161
2335
  /**
2336
+ * @public
2162
2337
  * <p>Contains information about the debug session for this build.</p>
2163
2338
  */
2164
2339
  debugSession?: DebugSession;
2165
2340
  /**
2341
+ * @public
2166
2342
  * <p>The ARN of the batch build that this build is a member of, if applicable.</p>
2167
2343
  */
2168
2344
  buildBatchArn?: string;
@@ -2172,10 +2348,12 @@ export interface Build {
2172
2348
  */
2173
2349
  export interface BatchGetBuildsOutput {
2174
2350
  /**
2351
+ * @public
2175
2352
  * <p>Information about the requested builds.</p>
2176
2353
  */
2177
2354
  builds?: Build[];
2178
2355
  /**
2356
+ * @public
2179
2357
  * <p>The IDs of builds for which information could not be found.</p>
2180
2358
  */
2181
2359
  buildsNotFound?: string[];
@@ -2185,6 +2363,7 @@ export interface BatchGetBuildsOutput {
2185
2363
  */
2186
2364
  export interface BatchGetProjectsInput {
2187
2365
  /**
2366
+ * @public
2188
2367
  * <p>The names or ARNs of the build projects. To get information about a project shared
2189
2368
  * with your Amazon Web Services account, its ARN must be specified. You cannot specify a shared project
2190
2369
  * using its name.</p>
@@ -2197,6 +2376,7 @@ export interface BatchGetProjectsInput {
2197
2376
  */
2198
2377
  export interface ProjectArtifacts {
2199
2378
  /**
2379
+ * @public
2200
2380
  * <p>The type of build output artifact. Valid values include:</p>
2201
2381
  * <ul>
2202
2382
  * <li>
@@ -2221,6 +2401,7 @@ export interface ProjectArtifacts {
2221
2401
  */
2222
2402
  type: ArtifactsType | string | undefined;
2223
2403
  /**
2404
+ * @public
2224
2405
  * <p>Information about the build output artifact location:</p>
2225
2406
  * <ul>
2226
2407
  * <li>
@@ -2240,6 +2421,7 @@ export interface ProjectArtifacts {
2240
2421
  */
2241
2422
  location?: string;
2242
2423
  /**
2424
+ * @public
2243
2425
  * <p>Along with <code>namespaceType</code> and <code>name</code>, the pattern that CodeBuild
2244
2426
  * uses to name and store the output artifact:</p>
2245
2427
  * <ul>
@@ -2265,6 +2447,7 @@ export interface ProjectArtifacts {
2265
2447
  */
2266
2448
  path?: string;
2267
2449
  /**
2450
+ * @public
2268
2451
  * <p>Along with <code>path</code> and <code>name</code>, the pattern that CodeBuild uses to
2269
2452
  * determine the name and location to store the output artifact:</p>
2270
2453
  * <ul>
@@ -2300,6 +2483,7 @@ export interface ProjectArtifacts {
2300
2483
  */
2301
2484
  namespaceType?: ArtifactNamespace | string;
2302
2485
  /**
2486
+ * @public
2303
2487
  * <p>Along with <code>path</code> and <code>namespaceType</code>, the pattern that CodeBuild
2304
2488
  * uses to name and store the output artifact:</p>
2305
2489
  * <ul>
@@ -2341,6 +2525,7 @@ export interface ProjectArtifacts {
2341
2525
  */
2342
2526
  name?: string;
2343
2527
  /**
2528
+ * @public
2344
2529
  * <p>The type of build output artifact to create:</p>
2345
2530
  * <ul>
2346
2531
  * <li>
@@ -2372,6 +2557,7 @@ export interface ProjectArtifacts {
2372
2557
  */
2373
2558
  packaging?: ArtifactPackaging | string;
2374
2559
  /**
2560
+ * @public
2375
2561
  * <p> If this flag is set, a name specified in the buildspec file overrides the artifact
2376
2562
  * name. The name specified in a buildspec file is calculated at build time and uses the
2377
2563
  * Shell Command Language. For example, you can append a date and time to your artifact
@@ -2379,16 +2565,19 @@ export interface ProjectArtifacts {
2379
2565
  */
2380
2566
  overrideArtifactName?: boolean;
2381
2567
  /**
2568
+ * @public
2382
2569
  * <p> Set to true if you do not want your output artifacts encrypted. This option is valid
2383
2570
  * only if your artifacts type is Amazon S3. If this is set with another artifacts type, an
2384
2571
  * invalidInputException is thrown. </p>
2385
2572
  */
2386
2573
  encryptionDisabled?: boolean;
2387
2574
  /**
2575
+ * @public
2388
2576
  * <p> An identifier for this artifact definition. </p>
2389
2577
  */
2390
2578
  artifactIdentifier?: string;
2391
2579
  /**
2580
+ * @public
2392
2581
  * <p>Specifies the bucket owner's access for objects that another account uploads to their
2393
2582
  * Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has
2394
2583
  * access to these objects. This property allows you to give the bucket owner access to
@@ -2440,11 +2629,13 @@ export interface ProjectArtifacts {
2440
2629
  */
2441
2630
  export interface ProjectBadge {
2442
2631
  /**
2632
+ * @public
2443
2633
  * <p>Set this to true to generate a publicly accessible URL for your project's build
2444
2634
  * badge.</p>
2445
2635
  */
2446
2636
  badgeEnabled?: boolean;
2447
2637
  /**
2638
+ * @public
2448
2639
  * <p>The publicly-accessible URL through which you can access the build badge for your
2449
2640
  * project. </p>
2450
2641
  */
@@ -2469,10 +2660,12 @@ export type ProjectVisibilityType = (typeof ProjectVisibilityType)[keyof typeof
2469
2660
  */
2470
2661
  export interface Tag {
2471
2662
  /**
2663
+ * @public
2472
2664
  * <p>The tag's key.</p>
2473
2665
  */
2474
2666
  key?: string;
2475
2667
  /**
2668
+ * @public
2476
2669
  * <p>The tag's value.</p>
2477
2670
  */
2478
2671
  value?: string;
@@ -2511,6 +2704,7 @@ export type WebhookFilterType = (typeof WebhookFilterType)[keyof typeof WebhookF
2511
2704
  */
2512
2705
  export interface WebhookFilter {
2513
2706
  /**
2707
+ * @public
2514
2708
  * <p> The type of webhook filter. There are six webhook filter types: <code>EVENT</code>,
2515
2709
  * <code>ACTOR_ACCOUNT_ID</code>, <code>HEAD_REF</code>, <code>BASE_REF</code>,
2516
2710
  * <code>FILE_PATH</code>, and <code>COMMIT_MESSAGE</code>. </p>
@@ -2588,6 +2782,7 @@ export interface WebhookFilter {
2588
2782
  */
2589
2783
  type: WebhookFilterType | string | undefined;
2590
2784
  /**
2785
+ * @public
2591
2786
  * <p> For a <code>WebHookFilter</code> that uses <code>EVENT</code> type, a comma-separated
2592
2787
  * string that specifies one or more events. For example, the webhook filter <code>PUSH,
2593
2788
  * PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> allows all push, pull request
@@ -2600,6 +2795,7 @@ export interface WebhookFilter {
2600
2795
  */
2601
2796
  pattern: string | undefined;
2602
2797
  /**
2798
+ * @public
2603
2799
  * <p> Used to indicate that the <code>pattern</code> determines which webhook events do not
2604
2800
  * trigger a build. If true, then a webhook event that does not match the
2605
2801
  * <code>pattern</code> triggers a build. If false, then a webhook event that matches
@@ -2614,14 +2810,17 @@ export interface WebhookFilter {
2614
2810
  */
2615
2811
  export interface Webhook {
2616
2812
  /**
2813
+ * @public
2617
2814
  * <p>The URL to the webhook.</p>
2618
2815
  */
2619
2816
  url?: string;
2620
2817
  /**
2818
+ * @public
2621
2819
  * <p>The CodeBuild endpoint where webhook events are sent.</p>
2622
2820
  */
2623
2821
  payloadUrl?: string;
2624
2822
  /**
2823
+ * @public
2625
2824
  * <p>The secret token of the associated repository. </p>
2626
2825
  * <note>
2627
2826
  * <p>A Bitbucket webhook does not support <code>secret</code>. </p>
@@ -2629,6 +2828,7 @@ export interface Webhook {
2629
2828
  */
2630
2829
  secret?: string;
2631
2830
  /**
2831
+ * @public
2632
2832
  * <p>A regular expression used to determine which repository branches are built when a
2633
2833
  * webhook is triggered. If the name of a branch matches the regular expression, then it is
2634
2834
  * built. If <code>branchFilter</code> is empty, then all branches are built.</p>
@@ -2639,6 +2839,7 @@ export interface Webhook {
2639
2839
  */
2640
2840
  branchFilter?: string;
2641
2841
  /**
2842
+ * @public
2642
2843
  * <p>An array of arrays of <code>WebhookFilter</code> objects used to determine which
2643
2844
  * webhooks are triggered. At least one <code>WebhookFilter</code> in the array must
2644
2845
  * specify <code>EVENT</code> as its <code>type</code>. </p>
@@ -2648,10 +2849,12 @@ export interface Webhook {
2648
2849
  */
2649
2850
  filterGroups?: WebhookFilter[][];
2650
2851
  /**
2852
+ * @public
2651
2853
  * <p>Specifies the type of build this webhook will trigger.</p>
2652
2854
  */
2653
2855
  buildType?: WebhookBuildType | string;
2654
2856
  /**
2857
+ * @public
2655
2858
  * <p>A timestamp that indicates the last time a repository's secret token was modified.
2656
2859
  * </p>
2657
2860
  */
@@ -2663,26 +2866,32 @@ export interface Webhook {
2663
2866
  */
2664
2867
  export interface Project {
2665
2868
  /**
2869
+ * @public
2666
2870
  * <p>The name of the build project.</p>
2667
2871
  */
2668
2872
  name?: string;
2669
2873
  /**
2874
+ * @public
2670
2875
  * <p>The Amazon Resource Name (ARN) of the build project.</p>
2671
2876
  */
2672
2877
  arn?: string;
2673
2878
  /**
2879
+ * @public
2674
2880
  * <p>A description that makes the build project easy to identify.</p>
2675
2881
  */
2676
2882
  description?: string;
2677
2883
  /**
2884
+ * @public
2678
2885
  * <p>Information about the build input source code for this build project.</p>
2679
2886
  */
2680
2887
  source?: ProjectSource;
2681
2888
  /**
2889
+ * @public
2682
2890
  * <p>An array of <code>ProjectSource</code> objects. </p>
2683
2891
  */
2684
2892
  secondarySources?: ProjectSource[];
2685
2893
  /**
2894
+ * @public
2686
2895
  * <p>A version of the build input to be built for this project. If not specified, the
2687
2896
  * latest version is used. If specified, it must be one of:</p>
2688
2897
  * <ul>
@@ -2716,42 +2925,51 @@ export interface Project {
2716
2925
  */
2717
2926
  sourceVersion?: string;
2718
2927
  /**
2928
+ * @public
2719
2929
  * <p>An array of <code>ProjectSourceVersion</code> objects. If
2720
2930
  * <code>secondarySourceVersions</code> is specified at the build level, then they take
2721
2931
  * over these <code>secondarySourceVersions</code> (at the project level). </p>
2722
2932
  */
2723
2933
  secondarySourceVersions?: ProjectSourceVersion[];
2724
2934
  /**
2935
+ * @public
2725
2936
  * <p>Information about the build output artifacts for the build project.</p>
2726
2937
  */
2727
2938
  artifacts?: ProjectArtifacts;
2728
2939
  /**
2940
+ * @public
2729
2941
  * <p>An array of <code>ProjectArtifacts</code> objects. </p>
2730
2942
  */
2731
2943
  secondaryArtifacts?: ProjectArtifacts[];
2732
2944
  /**
2945
+ * @public
2733
2946
  * <p>Information about the cache for the build project.</p>
2734
2947
  */
2735
2948
  cache?: ProjectCache;
2736
2949
  /**
2950
+ * @public
2737
2951
  * <p>Information about the build environment for this build project.</p>
2738
2952
  */
2739
2953
  environment?: ProjectEnvironment;
2740
2954
  /**
2955
+ * @public
2741
2956
  * <p>The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services
2742
2957
  * on behalf of the Amazon Web Services account.</p>
2743
2958
  */
2744
2959
  serviceRole?: string;
2745
2960
  /**
2961
+ * @public
2746
2962
  * <p>How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any
2747
2963
  * related build that did not get marked as completed. The default is 60 minutes.</p>
2748
2964
  */
2749
2965
  timeoutInMinutes?: number;
2750
2966
  /**
2967
+ * @public
2751
2968
  * <p>The number of minutes a build is allowed to be queued before it times out. </p>
2752
2969
  */
2753
2970
  queuedTimeoutInMinutes?: number;
2754
2971
  /**
2972
+ * @public
2755
2973
  * <p>The Key Management Service customer master key (CMK) to be used for encrypting the build output
2756
2974
  * artifacts.</p>
2757
2975
  * <note>
@@ -2765,39 +2983,47 @@ export interface Project {
2765
2983
  */
2766
2984
  encryptionKey?: string;
2767
2985
  /**
2986
+ * @public
2768
2987
  * <p>A list of tag key and value pairs associated with this build project.</p>
2769
2988
  * <p>These tags are available for use by Amazon Web Services services that support CodeBuild build project
2770
2989
  * tags.</p>
2771
2990
  */
2772
2991
  tags?: Tag[];
2773
2992
  /**
2993
+ * @public
2774
2994
  * <p>When the build project was created, expressed in Unix time format.</p>
2775
2995
  */
2776
2996
  created?: Date;
2777
2997
  /**
2998
+ * @public
2778
2999
  * <p>When the build project's settings were last modified, expressed in Unix time
2779
3000
  * format.</p>
2780
3001
  */
2781
3002
  lastModified?: Date;
2782
3003
  /**
3004
+ * @public
2783
3005
  * <p>Information about a webhook that connects repository events to a build project in
2784
3006
  * CodeBuild.</p>
2785
3007
  */
2786
3008
  webhook?: Webhook;
2787
3009
  /**
3010
+ * @public
2788
3011
  * <p>Information about the VPC configuration that CodeBuild accesses.</p>
2789
3012
  */
2790
3013
  vpcConfig?: VpcConfig;
2791
3014
  /**
3015
+ * @public
2792
3016
  * <p>Information about the build badge for the build project.</p>
2793
3017
  */
2794
3018
  badge?: ProjectBadge;
2795
3019
  /**
3020
+ * @public
2796
3021
  * <p>Information about logs for the build project. A project can create logs in CloudWatch Logs, an
2797
3022
  * S3 bucket, or both. </p>
2798
3023
  */
2799
3024
  logsConfig?: LogsConfig;
2800
3025
  /**
3026
+ * @public
2801
3027
  * <p>
2802
3028
  * An array of <code>ProjectFileSystemLocation</code> objects for a CodeBuild build project. A <code>ProjectFileSystemLocation</code> object
2803
3029
  * specifies the <code>identifier</code>, <code>location</code>, <code>mountOptions</code>,
@@ -2806,18 +3032,21 @@ export interface Project {
2806
3032
  */
2807
3033
  fileSystemLocations?: ProjectFileSystemLocation[];
2808
3034
  /**
3035
+ * @public
2809
3036
  * <p>A <a>ProjectBuildBatchConfig</a>
2810
3037
  * object that defines the batch build
2811
3038
  * options for the project.</p>
2812
3039
  */
2813
3040
  buildBatchConfig?: ProjectBuildBatchConfig;
2814
3041
  /**
3042
+ * @public
2815
3043
  * <p>The maximum number of concurrent builds that are allowed for this project.</p>
2816
3044
  * <p>New builds are only started if the current number of builds is less than or equal to this limit.
2817
3045
  * If the current build count meets this limit, new builds are throttled and are not run.</p>
2818
3046
  */
2819
3047
  concurrentBuildLimit?: number;
2820
3048
  /**
3049
+ * @public
2821
3050
  * <p>Specifies the visibility of the project's builds. Possible values are:</p>
2822
3051
  *
2823
3052
  * <dl>
@@ -2833,10 +3062,12 @@ export interface Project {
2833
3062
  */
2834
3063
  projectVisibility?: ProjectVisibilityType | string;
2835
3064
  /**
3065
+ * @public
2836
3066
  * <p>Contains the project identifier used with the public build APIs. </p>
2837
3067
  */
2838
3068
  publicProjectAlias?: string;
2839
3069
  /**
3070
+ * @public
2840
3071
  * <p>The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for
2841
3072
  * the project's builds.</p>
2842
3073
  */
@@ -2847,10 +3078,12 @@ export interface Project {
2847
3078
  */
2848
3079
  export interface BatchGetProjectsOutput {
2849
3080
  /**
3081
+ * @public
2850
3082
  * <p>Information about the requested build projects.</p>
2851
3083
  */
2852
3084
  projects?: Project[];
2853
3085
  /**
3086
+ * @public
2854
3087
  * <p>The names of build projects for which information could not be found.</p>
2855
3088
  */
2856
3089
  projectsNotFound?: string[];
@@ -2860,6 +3093,7 @@ export interface BatchGetProjectsOutput {
2860
3093
  */
2861
3094
  export interface BatchGetReportGroupsInput {
2862
3095
  /**
3096
+ * @public
2863
3097
  * <p>
2864
3098
  * An array of report group ARNs that identify the report groups to return.
2865
3099
  * </p>
@@ -2896,19 +3130,23 @@ export type ReportPackagingType = (typeof ReportPackagingType)[keyof typeof Repo
2896
3130
  */
2897
3131
  export interface S3ReportExportConfig {
2898
3132
  /**
3133
+ * @public
2899
3134
  * <p> The name of the S3 bucket where the raw data of a report are exported. </p>
2900
3135
  */
2901
3136
  bucket?: string;
2902
3137
  /**
3138
+ * @public
2903
3139
  * <p>The Amazon Web Services account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket
2904
3140
  * that is owned by an account other than the account running the build.</p>
2905
3141
  */
2906
3142
  bucketOwner?: string;
2907
3143
  /**
3144
+ * @public
2908
3145
  * <p> The path to the exported report's raw data results. </p>
2909
3146
  */
2910
3147
  path?: string;
2911
3148
  /**
3149
+ * @public
2912
3150
  * <p> The type of build output artifact to create. Valid values include: </p>
2913
3151
  * <ul>
2914
3152
  * <li>
@@ -2925,10 +3163,12 @@ export interface S3ReportExportConfig {
2925
3163
  */
2926
3164
  packaging?: ReportPackagingType | string;
2927
3165
  /**
3166
+ * @public
2928
3167
  * <p> The encryption key for the report's encrypted raw data. </p>
2929
3168
  */
2930
3169
  encryptionKey?: string;
2931
3170
  /**
3171
+ * @public
2932
3172
  * <p> A boolean value that specifies if the results of a report are encrypted. </p>
2933
3173
  */
2934
3174
  encryptionDisabled?: boolean;
@@ -2939,6 +3179,7 @@ export interface S3ReportExportConfig {
2939
3179
  */
2940
3180
  export interface ReportExportConfig {
2941
3181
  /**
3182
+ * @public
2942
3183
  * <p> The export configuration type. Valid values are: </p>
2943
3184
  * <ul>
2944
3185
  * <li>
@@ -2953,6 +3194,7 @@ export interface ReportExportConfig {
2953
3194
  */
2954
3195
  exportConfigType?: ReportExportConfigType | string;
2955
3196
  /**
3197
+ * @public
2956
3198
  * <p> A <code>S3ReportExportConfig</code> object that contains information about the S3
2957
3199
  * bucket where the run of a report is exported. </p>
2958
3200
  */
@@ -2990,16 +3232,19 @@ export type ReportType = (typeof ReportType)[keyof typeof ReportType];
2990
3232
  */
2991
3233
  export interface ReportGroup {
2992
3234
  /**
3235
+ * @public
2993
3236
  * <p>The ARN of the <code>ReportGroup</code>.
2994
3237
  * </p>
2995
3238
  */
2996
3239
  arn?: string;
2997
3240
  /**
3241
+ * @public
2998
3242
  * <p>The name of the <code>ReportGroup</code>.
2999
3243
  * </p>
3000
3244
  */
3001
3245
  name?: string;
3002
3246
  /**
3247
+ * @public
3003
3248
  * <p>The type of the <code>ReportGroup</code>. This can be one of the following
3004
3249
  * values:</p>
3005
3250
  * <dl>
@@ -3015,25 +3260,30 @@ export interface ReportGroup {
3015
3260
  */
3016
3261
  type?: ReportType | string;
3017
3262
  /**
3263
+ * @public
3018
3264
  * <p>Information about the destination where the raw data of this <code>ReportGroup</code>
3019
3265
  * is exported. </p>
3020
3266
  */
3021
3267
  exportConfig?: ReportExportConfig;
3022
3268
  /**
3269
+ * @public
3023
3270
  * <p>The date and time this <code>ReportGroup</code> was created. </p>
3024
3271
  */
3025
3272
  created?: Date;
3026
3273
  /**
3274
+ * @public
3027
3275
  * <p>The date and time this <code>ReportGroup</code> was last modified. </p>
3028
3276
  */
3029
3277
  lastModified?: Date;
3030
3278
  /**
3279
+ * @public
3031
3280
  * <p>A list of tag key and value pairs associated with this report group. </p>
3032
3281
  * <p>These tags are available for use by Amazon Web Services services that support CodeBuild report group
3033
3282
  * tags.</p>
3034
3283
  */
3035
3284
  tags?: Tag[];
3036
3285
  /**
3286
+ * @public
3037
3287
  * <p>The status of the report group. This property is read-only.</p>
3038
3288
  * <p>This can be one of the following values:</p>
3039
3289
  * <dl>
@@ -3054,12 +3304,14 @@ export interface ReportGroup {
3054
3304
  */
3055
3305
  export interface BatchGetReportGroupsOutput {
3056
3306
  /**
3307
+ * @public
3057
3308
  * <p>
3058
3309
  * The array of report groups returned by <code>BatchGetReportGroups</code>.
3059
3310
  * </p>
3060
3311
  */
3061
3312
  reportGroups?: ReportGroup[];
3062
3313
  /**
3314
+ * @public
3063
3315
  * <p>
3064
3316
  * An array of ARNs passed to <code>BatchGetReportGroups</code> that are not associated with a <code>ReportGroup</code>.
3065
3317
  * </p>
@@ -3071,6 +3323,7 @@ export interface BatchGetReportGroupsOutput {
3071
3323
  */
3072
3324
  export interface BatchGetReportsInput {
3073
3325
  /**
3326
+ * @public
3074
3327
  * <p>
3075
3328
  * An array of ARNs that identify the <code>Report</code> objects to return.
3076
3329
  * </p>
@@ -3087,26 +3340,32 @@ export interface BatchGetReportsInput {
3087
3340
  */
3088
3341
  export interface CodeCoverageReportSummary {
3089
3342
  /**
3343
+ * @public
3090
3344
  * <p>The percentage of lines that are covered by your tests.</p>
3091
3345
  */
3092
3346
  lineCoveragePercentage?: number;
3093
3347
  /**
3348
+ * @public
3094
3349
  * <p>The number of lines that are covered by your tests.</p>
3095
3350
  */
3096
3351
  linesCovered?: number;
3097
3352
  /**
3353
+ * @public
3098
3354
  * <p>The number of lines that are not covered by your tests.</p>
3099
3355
  */
3100
3356
  linesMissed?: number;
3101
3357
  /**
3358
+ * @public
3102
3359
  * <p>The percentage of branches that are covered by your tests.</p>
3103
3360
  */
3104
3361
  branchCoveragePercentage?: number;
3105
3362
  /**
3363
+ * @public
3106
3364
  * <p>The number of conditional branches that are covered by your tests.</p>
3107
3365
  */
3108
3366
  branchesCovered?: number;
3109
3367
  /**
3368
+ * @public
3110
3369
  * <p>The number of conditional branches that are not covered by your tests.</p>
3111
3370
  */
3112
3371
  branchesMissed?: number;
@@ -3132,16 +3391,19 @@ export type ReportStatusType = (typeof ReportStatusType)[keyof typeof ReportStat
3132
3391
  */
3133
3392
  export interface TestReportSummary {
3134
3393
  /**
3394
+ * @public
3135
3395
  * <p> The number of test cases in this <code>TestReportSummary</code>. The total includes
3136
3396
  * truncated test cases. </p>
3137
3397
  */
3138
3398
  total: number | undefined;
3139
3399
  /**
3400
+ * @public
3140
3401
  * <p> A map that contains the number of each type of status returned by the test results in
3141
3402
  * this <code>TestReportSummary</code>. </p>
3142
3403
  */
3143
3404
  statusCounts: Record<string, number> | undefined;
3144
3405
  /**
3406
+ * @public
3145
3407
  * <p> The number of nanoseconds it took to run all of the test cases in this report.
3146
3408
  * </p>
3147
3409
  */
@@ -3156,10 +3418,12 @@ export interface TestReportSummary {
3156
3418
  */
3157
3419
  export interface Report {
3158
3420
  /**
3421
+ * @public
3159
3422
  * <p> The ARN of the report run. </p>
3160
3423
  */
3161
3424
  arn?: string;
3162
3425
  /**
3426
+ * @public
3163
3427
  * <p>The type of the report that was run.</p>
3164
3428
  * <dl>
3165
3429
  * <dt>CODE_COVERAGE</dt>
@@ -3174,46 +3438,56 @@ export interface Report {
3174
3438
  */
3175
3439
  type?: ReportType | string;
3176
3440
  /**
3441
+ * @public
3177
3442
  * <p> The name of the report that was run. </p>
3178
3443
  */
3179
3444
  name?: string;
3180
3445
  /**
3446
+ * @public
3181
3447
  * <p> The ARN of the report group associated with this report. </p>
3182
3448
  */
3183
3449
  reportGroupArn?: string;
3184
3450
  /**
3451
+ * @public
3185
3452
  * <p> The ARN of the build run that generated this report. </p>
3186
3453
  */
3187
3454
  executionId?: string;
3188
3455
  /**
3456
+ * @public
3189
3457
  * <p> The status of this report. </p>
3190
3458
  */
3191
3459
  status?: ReportStatusType | string;
3192
3460
  /**
3461
+ * @public
3193
3462
  * <p> The date and time this report run occurred. </p>
3194
3463
  */
3195
3464
  created?: Date;
3196
3465
  /**
3466
+ * @public
3197
3467
  * <p> The date and time a report expires. A report expires 30 days after it is created. An
3198
3468
  * expired report is not available to view in CodeBuild. </p>
3199
3469
  */
3200
3470
  expired?: Date;
3201
3471
  /**
3472
+ * @public
3202
3473
  * <p> Information about where the raw data used to generate this report was exported.
3203
3474
  * </p>
3204
3475
  */
3205
3476
  exportConfig?: ReportExportConfig;
3206
3477
  /**
3478
+ * @public
3207
3479
  * <p> A boolean that specifies if this report run is truncated. The list of test cases is
3208
3480
  * truncated after the maximum number of test cases is reached. </p>
3209
3481
  */
3210
3482
  truncated?: boolean;
3211
3483
  /**
3484
+ * @public
3212
3485
  * <p> A <code>TestReportSummary</code> object that contains information about this test
3213
3486
  * report. </p>
3214
3487
  */
3215
3488
  testSummary?: TestReportSummary;
3216
3489
  /**
3490
+ * @public
3217
3491
  * <p>A <code>CodeCoverageReportSummary</code> object that contains a code coverage summary for
3218
3492
  * this report.</p>
3219
3493
  */
@@ -3224,12 +3498,14 @@ export interface Report {
3224
3498
  */
3225
3499
  export interface BatchGetReportsOutput {
3226
3500
  /**
3501
+ * @public
3227
3502
  * <p>
3228
3503
  * The array of <code>Report</code> objects returned by <code>BatchGetReports</code>.
3229
3504
  * </p>
3230
3505
  */
3231
3506
  reports?: Report[];
3232
3507
  /**
3508
+ * @public
3233
3509
  * <p>
3234
3510
  * An array of ARNs passed to <code>BatchGetReportGroups</code> that are not associated with a <code>Report</code>.
3235
3511
  * </p>
@@ -3242,6 +3518,7 @@ export interface BatchGetReportsOutput {
3242
3518
  */
3243
3519
  export interface BuildBatchFilter {
3244
3520
  /**
3521
+ * @public
3245
3522
  * <p>The status of the batch builds to retrieve. Only batch builds that have this status will
3246
3523
  * be retrieved.</p>
3247
3524
  */
@@ -3252,22 +3529,27 @@ export interface BuildBatchFilter {
3252
3529
  */
3253
3530
  export interface CreateProjectInput {
3254
3531
  /**
3532
+ * @public
3255
3533
  * <p>The name of the build project.</p>
3256
3534
  */
3257
3535
  name: string | undefined;
3258
3536
  /**
3537
+ * @public
3259
3538
  * <p>A description that makes the build project easy to identify.</p>
3260
3539
  */
3261
3540
  description?: string;
3262
3541
  /**
3542
+ * @public
3263
3543
  * <p>Information about the build input source code for the build project.</p>
3264
3544
  */
3265
3545
  source: ProjectSource | undefined;
3266
3546
  /**
3547
+ * @public
3267
3548
  * <p>An array of <code>ProjectSource</code> objects. </p>
3268
3549
  */
3269
3550
  secondarySources?: ProjectSource[];
3270
3551
  /**
3552
+ * @public
3271
3553
  * <p>A version of the build input to be built for this project. If not specified, the latest
3272
3554
  * version is used. If specified, it must be one of: </p>
3273
3555
  * <ul>
@@ -3301,6 +3583,7 @@ export interface CreateProjectInput {
3301
3583
  */
3302
3584
  sourceVersion?: string;
3303
3585
  /**
3586
+ * @public
3304
3587
  * <p>An array of <code>ProjectSourceVersion</code> objects. If
3305
3588
  * <code>secondarySourceVersions</code> is specified at the build level, then they take
3306
3589
  * precedence over these <code>secondarySourceVersions</code> (at the project level).
@@ -3308,37 +3591,45 @@ export interface CreateProjectInput {
3308
3591
  */
3309
3592
  secondarySourceVersions?: ProjectSourceVersion[];
3310
3593
  /**
3594
+ * @public
3311
3595
  * <p>Information about the build output artifacts for the build project.</p>
3312
3596
  */
3313
3597
  artifacts: ProjectArtifacts | undefined;
3314
3598
  /**
3599
+ * @public
3315
3600
  * <p>An array of <code>ProjectArtifacts</code> objects. </p>
3316
3601
  */
3317
3602
  secondaryArtifacts?: ProjectArtifacts[];
3318
3603
  /**
3604
+ * @public
3319
3605
  * <p>Stores recently used information so that it can be quickly accessed at a later
3320
3606
  * time.</p>
3321
3607
  */
3322
3608
  cache?: ProjectCache;
3323
3609
  /**
3610
+ * @public
3324
3611
  * <p>Information about the build environment for the build project.</p>
3325
3612
  */
3326
3613
  environment: ProjectEnvironment | undefined;
3327
3614
  /**
3615
+ * @public
3328
3616
  * <p>The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services
3329
3617
  * on behalf of the Amazon Web Services account.</p>
3330
3618
  */
3331
3619
  serviceRole: string | undefined;
3332
3620
  /**
3621
+ * @public
3333
3622
  * <p>How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before it times out
3334
3623
  * any build that has not been marked as completed. The default is 60 minutes.</p>
3335
3624
  */
3336
3625
  timeoutInMinutes?: number;
3337
3626
  /**
3627
+ * @public
3338
3628
  * <p>The number of minutes a build is allowed to be queued before it times out. </p>
3339
3629
  */
3340
3630
  queuedTimeoutInMinutes?: number;
3341
3631
  /**
3632
+ * @public
3342
3633
  * <p>The Key Management Service customer master key (CMK) to be used for encrypting the build output
3343
3634
  * artifacts.</p>
3344
3635
  * <note>
@@ -3351,26 +3642,31 @@ export interface CreateProjectInput {
3351
3642
  */
3352
3643
  encryptionKey?: string;
3353
3644
  /**
3645
+ * @public
3354
3646
  * <p>A list of tag key and value pairs associated with this build project.</p>
3355
3647
  * <p>These tags are available for use by Amazon Web Services services that support CodeBuild build project
3356
3648
  * tags.</p>
3357
3649
  */
3358
3650
  tags?: Tag[];
3359
3651
  /**
3652
+ * @public
3360
3653
  * <p>VpcConfig enables CodeBuild to access resources in an Amazon VPC.</p>
3361
3654
  */
3362
3655
  vpcConfig?: VpcConfig;
3363
3656
  /**
3657
+ * @public
3364
3658
  * <p>Set this to true to generate a publicly accessible URL for your project's build
3365
3659
  * badge.</p>
3366
3660
  */
3367
3661
  badgeEnabled?: boolean;
3368
3662
  /**
3663
+ * @public
3369
3664
  * <p>Information about logs for the build project. These can be logs in CloudWatch Logs, logs
3370
3665
  * uploaded to a specified S3 bucket, or both. </p>
3371
3666
  */
3372
3667
  logsConfig?: LogsConfig;
3373
3668
  /**
3669
+ * @public
3374
3670
  * <p>
3375
3671
  * An array of <code>ProjectFileSystemLocation</code> objects for a CodeBuild build project. A <code>ProjectFileSystemLocation</code> object
3376
3672
  * specifies the <code>identifier</code>, <code>location</code>, <code>mountOptions</code>,
@@ -3379,12 +3675,14 @@ export interface CreateProjectInput {
3379
3675
  */
3380
3676
  fileSystemLocations?: ProjectFileSystemLocation[];
3381
3677
  /**
3678
+ * @public
3382
3679
  * <p>A <a>ProjectBuildBatchConfig</a>
3383
3680
  * object that defines the batch build options
3384
3681
  * for the project.</p>
3385
3682
  */
3386
3683
  buildBatchConfig?: ProjectBuildBatchConfig;
3387
3684
  /**
3685
+ * @public
3388
3686
  * <p>The maximum number of concurrent builds that are allowed for this project.</p>
3389
3687
  * <p>New builds are only started if the current number of builds is less than or equal to this limit.
3390
3688
  * If the current build count meets this limit, new builds are throttled and are not run.</p>
@@ -3396,6 +3694,7 @@ export interface CreateProjectInput {
3396
3694
  */
3397
3695
  export interface CreateProjectOutput {
3398
3696
  /**
3697
+ * @public
3399
3698
  * <p>Information about the build project that was created.</p>
3400
3699
  */
3401
3700
  project?: Project;
@@ -3418,24 +3717,28 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
3418
3717
  */
3419
3718
  export interface CreateReportGroupInput {
3420
3719
  /**
3720
+ * @public
3421
3721
  * <p>
3422
3722
  * The name of the report group.
3423
3723
  * </p>
3424
3724
  */
3425
3725
  name: string | undefined;
3426
3726
  /**
3727
+ * @public
3427
3728
  * <p>
3428
3729
  * The type of report group.
3429
3730
  * </p>
3430
3731
  */
3431
3732
  type: ReportType | string | undefined;
3432
3733
  /**
3734
+ * @public
3433
3735
  * <p>
3434
3736
  * A <code>ReportExportConfig</code> object that contains information about where the report group test results are exported.
3435
3737
  * </p>
3436
3738
  */
3437
3739
  exportConfig: ReportExportConfig | undefined;
3438
3740
  /**
3741
+ * @public
3439
3742
  * <p>
3440
3743
  * A list of tag key and value pairs associated with this report group.
3441
3744
  * </p>
@@ -3449,6 +3752,7 @@ export interface CreateReportGroupInput {
3449
3752
  */
3450
3753
  export interface CreateReportGroupOutput {
3451
3754
  /**
3755
+ * @public
3452
3756
  * <p>
3453
3757
  * Information about the report group that was created.
3454
3758
  * </p>
@@ -3460,10 +3764,12 @@ export interface CreateReportGroupOutput {
3460
3764
  */
3461
3765
  export interface CreateWebhookInput {
3462
3766
  /**
3767
+ * @public
3463
3768
  * <p>The name of the CodeBuild project.</p>
3464
3769
  */
3465
3770
  projectName: string | undefined;
3466
3771
  /**
3772
+ * @public
3467
3773
  * <p>A regular expression used to determine which repository branches are built when a
3468
3774
  * webhook is triggered. If the name of a branch matches the regular expression, then it is
3469
3775
  * built. If <code>branchFilter</code> is empty, then all branches are built.</p>
@@ -3474,6 +3780,7 @@ export interface CreateWebhookInput {
3474
3780
  */
3475
3781
  branchFilter?: string;
3476
3782
  /**
3783
+ * @public
3477
3784
  * <p>An array of arrays of <code>WebhookFilter</code> objects used to determine which
3478
3785
  * webhooks are triggered. At least one <code>WebhookFilter</code> in the array must
3479
3786
  * specify <code>EVENT</code> as its <code>type</code>. </p>
@@ -3483,6 +3790,7 @@ export interface CreateWebhookInput {
3483
3790
  */
3484
3791
  filterGroups?: WebhookFilter[][];
3485
3792
  /**
3793
+ * @public
3486
3794
  * <p>Specifies the type of build this webhook will trigger.</p>
3487
3795
  */
3488
3796
  buildType?: WebhookBuildType | string;
@@ -3492,6 +3800,7 @@ export interface CreateWebhookInput {
3492
3800
  */
3493
3801
  export interface CreateWebhookOutput {
3494
3802
  /**
3803
+ * @public
3495
3804
  * <p>Information about a webhook that connects repository events to a build project in
3496
3805
  * CodeBuild.</p>
3497
3806
  */
@@ -3526,6 +3835,7 @@ export declare class ResourceNotFoundException extends __BaseException {
3526
3835
  */
3527
3836
  export interface DeleteBuildBatchInput {
3528
3837
  /**
3838
+ * @public
3529
3839
  * <p>The identifier of the batch build to delete.</p>
3530
3840
  */
3531
3841
  id: string | undefined;
@@ -3535,14 +3845,17 @@ export interface DeleteBuildBatchInput {
3535
3845
  */
3536
3846
  export interface DeleteBuildBatchOutput {
3537
3847
  /**
3848
+ * @public
3538
3849
  * <p>The status code.</p>
3539
3850
  */
3540
3851
  statusCode?: string;
3541
3852
  /**
3853
+ * @public
3542
3854
  * <p>An array of strings that contain the identifiers of the builds that were deleted.</p>
3543
3855
  */
3544
3856
  buildsDeleted?: string[];
3545
3857
  /**
3858
+ * @public
3546
3859
  * <p>An array of <code>BuildNotDeleted</code> objects that specify the builds that could not be
3547
3860
  * deleted.</p>
3548
3861
  */
@@ -3553,6 +3866,7 @@ export interface DeleteBuildBatchOutput {
3553
3866
  */
3554
3867
  export interface DeleteProjectInput {
3555
3868
  /**
3869
+ * @public
3556
3870
  * <p>The name of the build project.</p>
3557
3871
  */
3558
3872
  name: string | undefined;
@@ -3567,6 +3881,7 @@ export interface DeleteProjectOutput {
3567
3881
  */
3568
3882
  export interface DeleteReportInput {
3569
3883
  /**
3884
+ * @public
3570
3885
  * <p>
3571
3886
  * The ARN of the report to delete.
3572
3887
  * </p>
@@ -3583,10 +3898,12 @@ export interface DeleteReportOutput {
3583
3898
  */
3584
3899
  export interface DeleteReportGroupInput {
3585
3900
  /**
3901
+ * @public
3586
3902
  * <p>The ARN of the report group to delete. </p>
3587
3903
  */
3588
3904
  arn: string | undefined;
3589
3905
  /**
3906
+ * @public
3590
3907
  * <p>If <code>true</code>, deletes any reports that belong to a report group before deleting
3591
3908
  * the report group. </p>
3592
3909
  * <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
@@ -3605,6 +3922,7 @@ export interface DeleteReportGroupOutput {
3605
3922
  */
3606
3923
  export interface DeleteResourcePolicyInput {
3607
3924
  /**
3925
+ * @public
3608
3926
  * <p> The ARN of the resource that is associated with the resource policy. </p>
3609
3927
  */
3610
3928
  resourceArn: string | undefined;
@@ -3619,6 +3937,7 @@ export interface DeleteResourcePolicyOutput {
3619
3937
  */
3620
3938
  export interface DeleteSourceCredentialsInput {
3621
3939
  /**
3940
+ * @public
3622
3941
  * <p> The Amazon Resource Name (ARN) of the token.</p>
3623
3942
  */
3624
3943
  arn: string | undefined;
@@ -3628,6 +3947,7 @@ export interface DeleteSourceCredentialsInput {
3628
3947
  */
3629
3948
  export interface DeleteSourceCredentialsOutput {
3630
3949
  /**
3950
+ * @public
3631
3951
  * <p> The Amazon Resource Name (ARN) of the token. </p>
3632
3952
  */
3633
3953
  arn?: string;
@@ -3637,6 +3957,7 @@ export interface DeleteSourceCredentialsOutput {
3637
3957
  */
3638
3958
  export interface DeleteWebhookInput {
3639
3959
  /**
3960
+ * @public
3640
3961
  * <p>The name of the CodeBuild project.</p>
3641
3962
  */
3642
3963
  projectName: string | undefined;
@@ -3675,26 +3996,31 @@ export type SortOrderType = (typeof SortOrderType)[keyof typeof SortOrderType];
3675
3996
  */
3676
3997
  export interface DescribeCodeCoveragesInput {
3677
3998
  /**
3999
+ * @public
3678
4000
  * <p>
3679
4001
  * The ARN of the report for which test cases are returned.
3680
4002
  * </p>
3681
4003
  */
3682
4004
  reportArn: string | undefined;
3683
4005
  /**
4006
+ * @public
3684
4007
  * <p>The <code>nextToken</code> value returned from a previous call to
3685
4008
  * <code>DescribeCodeCoverages</code>. This specifies the next item to return. To
3686
4009
  * return the beginning of the list, exclude this parameter.</p>
3687
4010
  */
3688
4011
  nextToken?: string;
3689
4012
  /**
4013
+ * @public
3690
4014
  * <p>The maximum number of results to return.</p>
3691
4015
  */
3692
4016
  maxResults?: number;
3693
4017
  /**
4018
+ * @public
3694
4019
  * <p>Specifies if the results are sorted in ascending or descending order.</p>
3695
4020
  */
3696
4021
  sortOrder?: SortOrderType | string;
3697
4022
  /**
4023
+ * @public
3698
4024
  * <p>Specifies how the results are sorted. Possible values are:</p>
3699
4025
  * <dl>
3700
4026
  * <dt>FILE_PATH</dt>
@@ -3709,10 +4035,12 @@ export interface DescribeCodeCoveragesInput {
3709
4035
  */
3710
4036
  sortBy?: ReportCodeCoverageSortByType | string;
3711
4037
  /**
4038
+ * @public
3712
4039
  * <p>The minimum line coverage percentage to report.</p>
3713
4040
  */
3714
4041
  minLineCoveragePercentage?: number;
3715
4042
  /**
4043
+ * @public
3716
4044
  * <p>The maximum line coverage percentage to report.</p>
3717
4045
  */
3718
4046
  maxLineCoveragePercentage?: number;
@@ -3727,42 +4055,52 @@ export interface DescribeCodeCoveragesInput {
3727
4055
  */
3728
4056
  export interface CodeCoverage {
3729
4057
  /**
4058
+ * @public
3730
4059
  * <p>The identifier of the code coverage report.</p>
3731
4060
  */
3732
4061
  id?: string;
3733
4062
  /**
4063
+ * @public
3734
4064
  * <p>The ARN of the report.</p>
3735
4065
  */
3736
4066
  reportARN?: string;
3737
4067
  /**
4068
+ * @public
3738
4069
  * <p>The path of the test report file.</p>
3739
4070
  */
3740
4071
  filePath?: string;
3741
4072
  /**
4073
+ * @public
3742
4074
  * <p>The percentage of lines that are covered by your tests.</p>
3743
4075
  */
3744
4076
  lineCoveragePercentage?: number;
3745
4077
  /**
4078
+ * @public
3746
4079
  * <p>The number of lines that are covered by your tests.</p>
3747
4080
  */
3748
4081
  linesCovered?: number;
3749
4082
  /**
4083
+ * @public
3750
4084
  * <p>The number of lines that are not covered by your tests.</p>
3751
4085
  */
3752
4086
  linesMissed?: number;
3753
4087
  /**
4088
+ * @public
3754
4089
  * <p>The percentage of branches that are covered by your tests.</p>
3755
4090
  */
3756
4091
  branchCoveragePercentage?: number;
3757
4092
  /**
4093
+ * @public
3758
4094
  * <p>The number of conditional branches that are covered by your tests.</p>
3759
4095
  */
3760
4096
  branchesCovered?: number;
3761
4097
  /**
4098
+ * @public
3762
4099
  * <p>The number of conditional branches that are not covered by your tests.</p>
3763
4100
  */
3764
4101
  branchesMissed?: number;
3765
4102
  /**
4103
+ * @public
3766
4104
  * <p>The date and time that the tests were run.</p>
3767
4105
  */
3768
4106
  expired?: Date;
@@ -3772,11 +4110,13 @@ export interface CodeCoverage {
3772
4110
  */
3773
4111
  export interface DescribeCodeCoveragesOutput {
3774
4112
  /**
4113
+ * @public
3775
4114
  * <p>If there are more items to return, this contains a token that is passed to a subsequent
3776
4115
  * call to <code>DescribeCodeCoverages</code> to retrieve the next set of items.</p>
3777
4116
  */
3778
4117
  nextToken?: string;
3779
4118
  /**
4119
+ * @public
3780
4120
  * <p>An array of <code>CodeCoverage</code> objects that contain the results.</p>
3781
4121
  */
3782
4122
  codeCoverages?: CodeCoverage[];
@@ -3788,6 +4128,7 @@ export interface DescribeCodeCoveragesOutput {
3788
4128
  */
3789
4129
  export interface TestCaseFilter {
3790
4130
  /**
4131
+ * @public
3791
4132
  * <p>The status used to filter test cases. A <code>TestCaseFilter</code> can have one
3792
4133
  * status. Valid values are:</p>
3793
4134
  * <ul>
@@ -3820,6 +4161,7 @@ export interface TestCaseFilter {
3820
4161
  */
3821
4162
  status?: string;
3822
4163
  /**
4164
+ * @public
3823
4165
  * <p>A keyword that is used to filter on the <code>name</code> or the <code>prefix</code>
3824
4166
  * of the test cases. Only test cases where the keyword is a substring of the
3825
4167
  * <code>name</code> or the <code>prefix</code> will be returned.</p>
@@ -3831,12 +4173,14 @@ export interface TestCaseFilter {
3831
4173
  */
3832
4174
  export interface DescribeTestCasesInput {
3833
4175
  /**
4176
+ * @public
3834
4177
  * <p>
3835
4178
  * The ARN of the report for which test cases are returned.
3836
4179
  * </p>
3837
4180
  */
3838
4181
  reportArn: string | undefined;
3839
4182
  /**
4183
+ * @public
3840
4184
  * <p>
3841
4185
  * During a previous call, the maximum number of items that can be returned is the value specified in
3842
4186
  * <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i>
@@ -3847,6 +4191,7 @@ export interface DescribeTestCasesInput {
3847
4191
  */
3848
4192
  nextToken?: string;
3849
4193
  /**
4194
+ * @public
3850
4195
  * <p>
3851
4196
  * The maximum number of paginated test cases returned per response. Use <code>nextToken</code> to iterate pages in
3852
4197
  * the list of returned <code>TestCase</code> objects. The default value is 100.
@@ -3854,6 +4199,7 @@ export interface DescribeTestCasesInput {
3854
4199
  */
3855
4200
  maxResults?: number;
3856
4201
  /**
4202
+ * @public
3857
4203
  * <p>
3858
4204
  * A <code>TestCaseFilter</code> object used to filter the returned reports.
3859
4205
  * </p>
@@ -3867,38 +4213,46 @@ export interface DescribeTestCasesInput {
3867
4213
  */
3868
4214
  export interface TestCase {
3869
4215
  /**
4216
+ * @public
3870
4217
  * <p> The ARN of the report to which the test case belongs. </p>
3871
4218
  */
3872
4219
  reportArn?: string;
3873
4220
  /**
4221
+ * @public
3874
4222
  * <p> The path to the raw data file that contains the test result. </p>
3875
4223
  */
3876
4224
  testRawDataPath?: string;
3877
4225
  /**
4226
+ * @public
3878
4227
  * <p> A string that is applied to a series of related test cases. CodeBuild generates the
3879
4228
  * prefix. The prefix depends on the framework used to generate the tests. </p>
3880
4229
  */
3881
4230
  prefix?: string;
3882
4231
  /**
4232
+ * @public
3883
4233
  * <p> The name of the test case. </p>
3884
4234
  */
3885
4235
  name?: string;
3886
4236
  /**
4237
+ * @public
3887
4238
  * <p> The status returned by the test case after it was run. Valid statuses are
3888
4239
  * <code>SUCCEEDED</code>, <code>FAILED</code>, <code>ERROR</code>,
3889
4240
  * <code>SKIPPED</code>, and <code>UNKNOWN</code>. </p>
3890
4241
  */
3891
4242
  status?: string;
3892
4243
  /**
4244
+ * @public
3893
4245
  * <p> The number of nanoseconds it took to run this test case. </p>
3894
4246
  */
3895
4247
  durationInNanoSeconds?: number;
3896
4248
  /**
4249
+ * @public
3897
4250
  * <p> A message associated with a test case. For example, an error message or stack trace.
3898
4251
  * </p>
3899
4252
  */
3900
4253
  message?: string;
3901
4254
  /**
4255
+ * @public
3902
4256
  * <p> The date and time a test case expires. A test case expires 30 days after it is
3903
4257
  * created. An expired test case is not available to view in CodeBuild. </p>
3904
4258
  */
@@ -3909,6 +4263,7 @@ export interface TestCase {
3909
4263
  */
3910
4264
  export interface DescribeTestCasesOutput {
3911
4265
  /**
4266
+ * @public
3912
4267
  * <p>
3913
4268
  * During a previous call, the maximum number of items that can be returned is the value specified in
3914
4269
  * <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i>
@@ -3919,6 +4274,7 @@ export interface DescribeTestCasesOutput {
3919
4274
  */
3920
4275
  nextToken?: string;
3921
4276
  /**
4277
+ * @public
3922
4278
  * <p>
3923
4279
  * The returned list of test cases.
3924
4280
  * </p>
@@ -3949,16 +4305,19 @@ export type ReportGroupTrendFieldType = (typeof ReportGroupTrendFieldType)[keyof
3949
4305
  */
3950
4306
  export interface GetReportGroupTrendInput {
3951
4307
  /**
4308
+ * @public
3952
4309
  * <p>The ARN of the report group that contains the reports to analyze.</p>
3953
4310
  */
3954
4311
  reportGroupArn: string | undefined;
3955
4312
  /**
4313
+ * @public
3956
4314
  * <p>The number of reports to analyze. This operation always retrieves the most recent
3957
4315
  * reports.</p>
3958
4316
  * <p>If this parameter is omitted, the most recent 100 reports are analyzed.</p>
3959
4317
  */
3960
4318
  numOfReports?: number;
3961
4319
  /**
4320
+ * @public
3962
4321
  * <p>The test report value to accumulate. This must be one of the following values:</p>
3963
4322
  * <dl>
3964
4323
  * <dt>Test reports:</dt>
@@ -4028,10 +4387,12 @@ export interface GetReportGroupTrendInput {
4028
4387
  */
4029
4388
  export interface ReportWithRawData {
4030
4389
  /**
4390
+ * @public
4031
4391
  * <p>The ARN of the report.</p>
4032
4392
  */
4033
4393
  reportArn?: string;
4034
4394
  /**
4395
+ * @public
4035
4396
  * <p>The value of the requested data field from the report.</p>
4036
4397
  */
4037
4398
  data?: string;
@@ -4043,14 +4404,17 @@ export interface ReportWithRawData {
4043
4404
  */
4044
4405
  export interface ReportGroupTrendStats {
4045
4406
  /**
4407
+ * @public
4046
4408
  * <p>Contains the average of all values analyzed.</p>
4047
4409
  */
4048
4410
  average?: string;
4049
4411
  /**
4412
+ * @public
4050
4413
  * <p>Contains the maximum value analyzed.</p>
4051
4414
  */
4052
4415
  max?: string;
4053
4416
  /**
4417
+ * @public
4054
4418
  * <p>Contains the minimum value analyzed.</p>
4055
4419
  */
4056
4420
  min?: string;
@@ -4060,10 +4424,12 @@ export interface ReportGroupTrendStats {
4060
4424
  */
4061
4425
  export interface GetReportGroupTrendOutput {
4062
4426
  /**
4427
+ * @public
4063
4428
  * <p>Contains the accumulated trend data.</p>
4064
4429
  */
4065
4430
  stats?: ReportGroupTrendStats;
4066
4431
  /**
4432
+ * @public
4067
4433
  * <p>An array that contains the raw data for each report.</p>
4068
4434
  */
4069
4435
  rawData?: ReportWithRawData[];
@@ -4073,6 +4439,7 @@ export interface GetReportGroupTrendOutput {
4073
4439
  */
4074
4440
  export interface GetResourcePolicyInput {
4075
4441
  /**
4442
+ * @public
4076
4443
  * <p> The ARN of the resource that is associated with the resource policy. </p>
4077
4444
  */
4078
4445
  resourceArn: string | undefined;
@@ -4082,6 +4449,7 @@ export interface GetResourcePolicyInput {
4082
4449
  */
4083
4450
  export interface GetResourcePolicyOutput {
4084
4451
  /**
4452
+ * @public
4085
4453
  * <p> The resource policy for the resource identified by the input ARN parameter. </p>
4086
4454
  */
4087
4455
  policy?: string;
@@ -4104,26 +4472,31 @@ export type ServerType = (typeof ServerType)[keyof typeof ServerType];
4104
4472
  */
4105
4473
  export interface ImportSourceCredentialsInput {
4106
4474
  /**
4475
+ * @public
4107
4476
  * <p> The Bitbucket username when the <code>authType</code> is BASIC_AUTH. This parameter
4108
4477
  * is not valid for other types of source providers or connections. </p>
4109
4478
  */
4110
4479
  username?: string;
4111
4480
  /**
4481
+ * @public
4112
4482
  * <p> For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket,
4113
4483
  * this is the app password. </p>
4114
4484
  */
4115
4485
  token: string | undefined;
4116
4486
  /**
4487
+ * @public
4117
4488
  * <p> The source provider used for this project. </p>
4118
4489
  */
4119
4490
  serverType: ServerType | string | undefined;
4120
4491
  /**
4492
+ * @public
4121
4493
  * <p> The type of authentication used to connect to a GitHub, GitHub Enterprise, or
4122
4494
  * Bitbucket repository. An OAUTH connection is not supported by the API and must be
4123
4495
  * created using the CodeBuild console. </p>
4124
4496
  */
4125
4497
  authType: AuthType | string | undefined;
4126
4498
  /**
4499
+ * @public
4127
4500
  * <p> Set to <code>false</code> to prevent overwriting the repository source credentials.
4128
4501
  * Set to <code>true</code> to overwrite the repository source credentials. The default
4129
4502
  * value is <code>true</code>. </p>
@@ -4135,6 +4508,7 @@ export interface ImportSourceCredentialsInput {
4135
4508
  */
4136
4509
  export interface ImportSourceCredentialsOutput {
4137
4510
  /**
4511
+ * @public
4138
4512
  * <p> The Amazon Resource Name (ARN) of the token. </p>
4139
4513
  */
4140
4514
  arn?: string;
@@ -4144,6 +4518,7 @@ export interface ImportSourceCredentialsOutput {
4144
4518
  */
4145
4519
  export interface InvalidateProjectCacheInput {
4146
4520
  /**
4521
+ * @public
4147
4522
  * <p>The name of the CodeBuild build project that the cache is reset for.</p>
4148
4523
  */
4149
4524
  projectName: string | undefined;
@@ -4158,14 +4533,17 @@ export interface InvalidateProjectCacheOutput {
4158
4533
  */
4159
4534
  export interface ListBuildBatchesInput {
4160
4535
  /**
4536
+ * @public
4161
4537
  * <p>A <code>BuildBatchFilter</code> object that specifies the filters for the search.</p>
4162
4538
  */
4163
4539
  filter?: BuildBatchFilter;
4164
4540
  /**
4541
+ * @public
4165
4542
  * <p>The maximum number of results to return.</p>
4166
4543
  */
4167
4544
  maxResults?: number;
4168
4545
  /**
4546
+ * @public
4169
4547
  * <p>Specifies the sort order of the returned items. Valid values include:</p>
4170
4548
  * <ul>
4171
4549
  * <li>
@@ -4180,6 +4558,7 @@ export interface ListBuildBatchesInput {
4180
4558
  */
4181
4559
  sortOrder?: SortOrderType | string;
4182
4560
  /**
4561
+ * @public
4183
4562
  * <p>The <code>nextToken</code> value returned from a previous call to
4184
4563
  * <code>ListBuildBatches</code>. This specifies the next item to return. To return the
4185
4564
  * beginning of the list, exclude this parameter.</p>
@@ -4191,10 +4570,12 @@ export interface ListBuildBatchesInput {
4191
4570
  */
4192
4571
  export interface ListBuildBatchesOutput {
4193
4572
  /**
4573
+ * @public
4194
4574
  * <p>An array of strings that contains the batch build identifiers.</p>
4195
4575
  */
4196
4576
  ids?: string[];
4197
4577
  /**
4578
+ * @public
4198
4579
  * <p>If there are more items to return, this contains a token that is passed to a subsequent
4199
4580
  * call to <code>ListBuildBatches</code> to retrieve the next set of items.</p>
4200
4581
  */
@@ -4205,18 +4586,22 @@ export interface ListBuildBatchesOutput {
4205
4586
  */
4206
4587
  export interface ListBuildBatchesForProjectInput {
4207
4588
  /**
4589
+ * @public
4208
4590
  * <p>The name of the project.</p>
4209
4591
  */
4210
4592
  projectName?: string;
4211
4593
  /**
4594
+ * @public
4212
4595
  * <p>A <code>BuildBatchFilter</code> object that specifies the filters for the search.</p>
4213
4596
  */
4214
4597
  filter?: BuildBatchFilter;
4215
4598
  /**
4599
+ * @public
4216
4600
  * <p>The maximum number of results to return.</p>
4217
4601
  */
4218
4602
  maxResults?: number;
4219
4603
  /**
4604
+ * @public
4220
4605
  * <p>Specifies the sort order of the returned items. Valid values include:</p>
4221
4606
  * <ul>
4222
4607
  * <li>
@@ -4233,6 +4618,7 @@ export interface ListBuildBatchesForProjectInput {
4233
4618
  */
4234
4619
  sortOrder?: SortOrderType | string;
4235
4620
  /**
4621
+ * @public
4236
4622
  * <p>The <code>nextToken</code> value returned from a previous call to
4237
4623
  * <code>ListBuildBatchesForProject</code>. This specifies the next item to return. To return the
4238
4624
  * beginning of the list, exclude this parameter.</p>
@@ -4244,10 +4630,12 @@ export interface ListBuildBatchesForProjectInput {
4244
4630
  */
4245
4631
  export interface ListBuildBatchesForProjectOutput {
4246
4632
  /**
4633
+ * @public
4247
4634
  * <p>An array of strings that contains the batch build identifiers.</p>
4248
4635
  */
4249
4636
  ids?: string[];
4250
4637
  /**
4638
+ * @public
4251
4639
  * <p>If there are more items to return, this contains a token that is passed to a
4252
4640
  * subsequent call to <code>ListBuildBatchesForProject</code> to retrieve the next set of
4253
4641
  * items.</p>
@@ -4259,6 +4647,7 @@ export interface ListBuildBatchesForProjectOutput {
4259
4647
  */
4260
4648
  export interface ListBuildsInput {
4261
4649
  /**
4650
+ * @public
4262
4651
  * <p>The order to list build IDs. Valid values include:</p>
4263
4652
  * <ul>
4264
4653
  * <li>
@@ -4275,6 +4664,7 @@ export interface ListBuildsInput {
4275
4664
  */
4276
4665
  sortOrder?: SortOrderType | string;
4277
4666
  /**
4667
+ * @public
4278
4668
  * <p>During a previous call, if there are more than 100 items in the list, only the first
4279
4669
  * 100 items are returned, along with a unique string called a
4280
4670
  * <i>nextToken</i>. To get the next batch of items in the list, call
@@ -4289,10 +4679,12 @@ export interface ListBuildsInput {
4289
4679
  */
4290
4680
  export interface ListBuildsOutput {
4291
4681
  /**
4682
+ * @public
4292
4683
  * <p>A list of build IDs, with each build ID representing a single build.</p>
4293
4684
  */
4294
4685
  ids?: string[];
4295
4686
  /**
4687
+ * @public
4296
4688
  * <p>If there are more than 100 items in the list, only the first 100 items are returned,
4297
4689
  * along with a unique string called a <i>nextToken</i>. To get the next
4298
4690
  * batch of items in the list, call this operation again, adding the next token to the
@@ -4305,10 +4697,12 @@ export interface ListBuildsOutput {
4305
4697
  */
4306
4698
  export interface ListBuildsForProjectInput {
4307
4699
  /**
4700
+ * @public
4308
4701
  * <p>The name of the CodeBuild project.</p>
4309
4702
  */
4310
4703
  projectName: string | undefined;
4311
4704
  /**
4705
+ * @public
4312
4706
  * <p>The order to sort the results in. The results are sorted by build number, not the build
4313
4707
  * identifier. If this is not specified, the results are sorted in descending order.</p>
4314
4708
  * <p>Valid values include:</p>
@@ -4327,6 +4721,7 @@ export interface ListBuildsForProjectInput {
4327
4721
  */
4328
4722
  sortOrder?: SortOrderType | string;
4329
4723
  /**
4724
+ * @public
4330
4725
  * <p>During a previous call, if there are more than 100 items in the list, only the first
4331
4726
  * 100 items are returned, along with a unique string called a
4332
4727
  * <i>nextToken</i>. To get the next batch of items in the list, call
@@ -4341,11 +4736,13 @@ export interface ListBuildsForProjectInput {
4341
4736
  */
4342
4737
  export interface ListBuildsForProjectOutput {
4343
4738
  /**
4739
+ * @public
4344
4740
  * <p>A list of build identifiers for the specified build project, with each build ID representing a
4345
4741
  * single build.</p>
4346
4742
  */
4347
4743
  ids?: string[];
4348
4744
  /**
4745
+ * @public
4349
4746
  * <p>If there are more than 100 items in the list, only the first 100 items are returned,
4350
4747
  * along with a unique string called a <i>nextToken</i>. To get the next
4351
4748
  * batch of items in the list, call this operation again, adding the next token to the
@@ -4364,14 +4761,17 @@ export interface ListCuratedEnvironmentImagesInput {
4364
4761
  */
4365
4762
  export interface EnvironmentImage {
4366
4763
  /**
4764
+ * @public
4367
4765
  * <p>The name of the Docker image.</p>
4368
4766
  */
4369
4767
  name?: string;
4370
4768
  /**
4769
+ * @public
4371
4770
  * <p>The description of the Docker image.</p>
4372
4771
  */
4373
4772
  description?: string;
4374
4773
  /**
4774
+ * @public
4375
4775
  * <p>A list of environment image versions.</p>
4376
4776
  */
4377
4777
  versions?: string[];
@@ -4403,10 +4803,12 @@ export type LanguageType = (typeof LanguageType)[keyof typeof LanguageType];
4403
4803
  */
4404
4804
  export interface EnvironmentLanguage {
4405
4805
  /**
4806
+ * @public
4406
4807
  * <p>The programming language for the Docker images.</p>
4407
4808
  */
4408
4809
  language?: LanguageType | string;
4409
4810
  /**
4811
+ * @public
4410
4812
  * <p>The list of Docker images that are related by the specified programming
4411
4813
  * language.</p>
4412
4814
  */
@@ -4432,10 +4834,12 @@ export type PlatformType = (typeof PlatformType)[keyof typeof PlatformType];
4432
4834
  */
4433
4835
  export interface EnvironmentPlatform {
4434
4836
  /**
4837
+ * @public
4435
4838
  * <p>The platform's name.</p>
4436
4839
  */
4437
4840
  platform?: PlatformType | string;
4438
4841
  /**
4842
+ * @public
4439
4843
  * <p>The list of programming languages that are available for the specified
4440
4844
  * platform.</p>
4441
4845
  */
@@ -4446,6 +4850,7 @@ export interface EnvironmentPlatform {
4446
4850
  */
4447
4851
  export interface ListCuratedEnvironmentImagesOutput {
4448
4852
  /**
4853
+ * @public
4449
4854
  * <p>Information about supported platforms for Docker images that are managed by
4450
4855
  * CodeBuild.</p>
4451
4856
  */
@@ -4469,6 +4874,7 @@ export type ProjectSortByType = (typeof ProjectSortByType)[keyof typeof ProjectS
4469
4874
  */
4470
4875
  export interface ListProjectsInput {
4471
4876
  /**
4877
+ * @public
4472
4878
  * <p>The criterion to be used to list build project names. Valid values include:</p>
4473
4879
  * <ul>
4474
4880
  * <li>
@@ -4491,6 +4897,7 @@ export interface ListProjectsInput {
4491
4897
  */
4492
4898
  sortBy?: ProjectSortByType | string;
4493
4899
  /**
4900
+ * @public
4494
4901
  * <p>The order in which to list build projects. Valid values include:</p>
4495
4902
  * <ul>
4496
4903
  * <li>
@@ -4507,6 +4914,7 @@ export interface ListProjectsInput {
4507
4914
  */
4508
4915
  sortOrder?: SortOrderType | string;
4509
4916
  /**
4917
+ * @public
4510
4918
  * <p>During a previous call, if there are more than 100 items in the list, only the first
4511
4919
  * 100 items are returned, along with a unique string called a
4512
4920
  * <i>nextToken</i>. To get the next batch of items in the list, call
@@ -4521,6 +4929,7 @@ export interface ListProjectsInput {
4521
4929
  */
4522
4930
  export interface ListProjectsOutput {
4523
4931
  /**
4932
+ * @public
4524
4933
  * <p>If there are more than 100 items in the list, only the first 100 items are returned,
4525
4934
  * along with a unique string called a <i>nextToken</i>. To get the next
4526
4935
  * batch of items in the list, call this operation again, adding the next token to the
@@ -4528,6 +4937,7 @@ export interface ListProjectsOutput {
4528
4937
  */
4529
4938
  nextToken?: string;
4530
4939
  /**
4940
+ * @public
4531
4941
  * <p>The list of build project names, with each build project name representing a single
4532
4942
  * build project.</p>
4533
4943
  */
@@ -4551,6 +4961,7 @@ export type ReportGroupSortByType = (typeof ReportGroupSortByType)[keyof typeof
4551
4961
  */
4552
4962
  export interface ListReportGroupsInput {
4553
4963
  /**
4964
+ * @public
4554
4965
  * <p>
4555
4966
  * Used to specify the order to sort the list of returned report groups. Valid values are
4556
4967
  * <code>ASCENDING</code> and <code>DESCENDING</code>.
@@ -4558,6 +4969,7 @@ export interface ListReportGroupsInput {
4558
4969
  */
4559
4970
  sortOrder?: SortOrderType | string;
4560
4971
  /**
4972
+ * @public
4561
4973
  * <p>
4562
4974
  * The criterion to be used to list build report groups. Valid values include:
4563
4975
  * </p>
@@ -4579,6 +4991,7 @@ export interface ListReportGroupsInput {
4579
4991
  */
4580
4992
  sortBy?: ReportGroupSortByType | string;
4581
4993
  /**
4994
+ * @public
4582
4995
  * <p>
4583
4996
  * During a previous call, the maximum number of items that can be returned is the value specified in
4584
4997
  * <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i>
@@ -4589,6 +5002,7 @@ export interface ListReportGroupsInput {
4589
5002
  */
4590
5003
  nextToken?: string;
4591
5004
  /**
5005
+ * @public
4592
5006
  * <p>
4593
5007
  * The maximum number of paginated report groups returned per response. Use <code>nextToken</code> to iterate pages in
4594
5008
  * the list of returned <code>ReportGroup</code> objects. The default value is 100.
@@ -4601,6 +5015,7 @@ export interface ListReportGroupsInput {
4601
5015
  */
4602
5016
  export interface ListReportGroupsOutput {
4603
5017
  /**
5018
+ * @public
4604
5019
  * <p>
4605
5020
  * During a previous call, the maximum number of items that can be returned is the value specified in
4606
5021
  * <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i>
@@ -4611,6 +5026,7 @@ export interface ListReportGroupsOutput {
4611
5026
  */
4612
5027
  nextToken?: string;
4613
5028
  /**
5029
+ * @public
4614
5030
  * <p>
4615
5031
  * The list of ARNs for the report groups in the current Amazon Web Services account.
4616
5032
  * </p>
@@ -4624,6 +5040,7 @@ export interface ListReportGroupsOutput {
4624
5040
  */
4625
5041
  export interface ReportFilter {
4626
5042
  /**
5043
+ * @public
4627
5044
  * <p> The status used to filter reports. You can filter using one status only. </p>
4628
5045
  */
4629
5046
  status?: ReportStatusType | string;
@@ -4633,6 +5050,7 @@ export interface ReportFilter {
4633
5050
  */
4634
5051
  export interface ListReportsInput {
4635
5052
  /**
5053
+ * @public
4636
5054
  * <p>
4637
5055
  * Specifies the sort order for the list of returned reports. Valid values are:
4638
5056
  * </p>
@@ -4651,6 +5069,7 @@ export interface ListReportsInput {
4651
5069
  */
4652
5070
  sortOrder?: SortOrderType | string;
4653
5071
  /**
5072
+ * @public
4654
5073
  * <p>
4655
5074
  * During a previous call, the maximum number of items that can be returned is the value specified in
4656
5075
  * <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i>
@@ -4661,6 +5080,7 @@ export interface ListReportsInput {
4661
5080
  */
4662
5081
  nextToken?: string;
4663
5082
  /**
5083
+ * @public
4664
5084
  * <p>
4665
5085
  * The maximum number of paginated reports returned per response. Use <code>nextToken</code> to iterate pages in
4666
5086
  * the list of returned <code>Report</code> objects. The default value is 100.
@@ -4668,6 +5088,7 @@ export interface ListReportsInput {
4668
5088
  */
4669
5089
  maxResults?: number;
4670
5090
  /**
5091
+ * @public
4671
5092
  * <p>
4672
5093
  * A <code>ReportFilter</code> object used to filter the returned reports.
4673
5094
  * </p>
@@ -4679,6 +5100,7 @@ export interface ListReportsInput {
4679
5100
  */
4680
5101
  export interface ListReportsOutput {
4681
5102
  /**
5103
+ * @public
4682
5104
  * <p>
4683
5105
  * During a previous call, the maximum number of items that can be returned is the value specified in
4684
5106
  * <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i>
@@ -4689,6 +5111,7 @@ export interface ListReportsOutput {
4689
5111
  */
4690
5112
  nextToken?: string;
4691
5113
  /**
5114
+ * @public
4692
5115
  * <p>
4693
5116
  * The list of returned ARNs for the reports in the current Amazon Web Services account.
4694
5117
  * </p>
@@ -4700,12 +5123,14 @@ export interface ListReportsOutput {
4700
5123
  */
4701
5124
  export interface ListReportsForReportGroupInput {
4702
5125
  /**
5126
+ * @public
4703
5127
  * <p>
4704
5128
  * The ARN of the report group for which you want to return report ARNs.
4705
5129
  * </p>
4706
5130
  */
4707
5131
  reportGroupArn: string | undefined;
4708
5132
  /**
5133
+ * @public
4709
5134
  * <p>
4710
5135
  * During a previous call, the maximum number of items that can be returned is the value specified in
4711
5136
  * <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i>
@@ -4716,12 +5141,14 @@ export interface ListReportsForReportGroupInput {
4716
5141
  */
4717
5142
  nextToken?: string;
4718
5143
  /**
5144
+ * @public
4719
5145
  * <p>
4720
5146
  * Use to specify whether the results are returned in ascending or descending order.
4721
5147
  * </p>
4722
5148
  */
4723
5149
  sortOrder?: SortOrderType | string;
4724
5150
  /**
5151
+ * @public
4725
5152
  * <p>
4726
5153
  * The maximum number of paginated reports in this report group returned per response. Use <code>nextToken</code> to iterate pages in
4727
5154
  * the list of returned <code>Report</code> objects. The default value is 100.
@@ -4729,6 +5156,7 @@ export interface ListReportsForReportGroupInput {
4729
5156
  */
4730
5157
  maxResults?: number;
4731
5158
  /**
5159
+ * @public
4732
5160
  * <p>
4733
5161
  * A <code>ReportFilter</code> object used to filter the returned reports.
4734
5162
  * </p>
@@ -4740,6 +5168,7 @@ export interface ListReportsForReportGroupInput {
4740
5168
  */
4741
5169
  export interface ListReportsForReportGroupOutput {
4742
5170
  /**
5171
+ * @public
4743
5172
  * <p>
4744
5173
  * During a previous call, the maximum number of items that can be returned is the value specified in
4745
5174
  * <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i>
@@ -4750,6 +5179,7 @@ export interface ListReportsForReportGroupOutput {
4750
5179
  */
4751
5180
  nextToken?: string;
4752
5181
  /**
5182
+ * @public
4753
5183
  * <p>
4754
5184
  * The list of report ARNs.
4755
5185
  * </p>
@@ -4773,6 +5203,7 @@ export type SharedResourceSortByType = (typeof SharedResourceSortByType)[keyof t
4773
5203
  */
4774
5204
  export interface ListSharedProjectsInput {
4775
5205
  /**
5206
+ * @public
4776
5207
  * <p> The criterion to be used to list build projects shared with the current Amazon Web Services account
4777
5208
  * or user. Valid values include: </p>
4778
5209
  * <ul>
@@ -4789,6 +5220,7 @@ export interface ListSharedProjectsInput {
4789
5220
  */
4790
5221
  sortBy?: SharedResourceSortByType | string;
4791
5222
  /**
5223
+ * @public
4792
5224
  * <p>The order in which to list shared build projects. Valid values include:</p>
4793
5225
  * <ul>
4794
5226
  * <li>
@@ -4803,12 +5235,14 @@ export interface ListSharedProjectsInput {
4803
5235
  */
4804
5236
  sortOrder?: SortOrderType | string;
4805
5237
  /**
5238
+ * @public
4806
5239
  * <p> The maximum number of paginated shared build projects returned per response. Use
4807
5240
  * <code>nextToken</code> to iterate pages in the list of returned <code>Project</code>
4808
5241
  * objects. The default value is 100. </p>
4809
5242
  */
4810
5243
  maxResults?: number;
4811
5244
  /**
5245
+ * @public
4812
5246
  * <p> During a previous call, the maximum number of items that can be returned is the value
4813
5247
  * specified in <code>maxResults</code>. If there more items in the list, then a unique
4814
5248
  * string called a <i>nextToken</i> is returned. To get the next batch of
@@ -4823,6 +5257,7 @@ export interface ListSharedProjectsInput {
4823
5257
  */
4824
5258
  export interface ListSharedProjectsOutput {
4825
5259
  /**
5260
+ * @public
4826
5261
  * <p> During a previous call, the maximum number of items that can be returned is the value
4827
5262
  * specified in <code>maxResults</code>. If there more items in the list, then a unique
4828
5263
  * string called a <i>nextToken</i> is returned. To get the next batch of
@@ -4832,6 +5267,7 @@ export interface ListSharedProjectsOutput {
4832
5267
  */
4833
5268
  nextToken?: string;
4834
5269
  /**
5270
+ * @public
4835
5271
  * <p> The list of ARNs for the build projects shared with the current Amazon Web Services account or user.
4836
5272
  * </p>
4837
5273
  */
@@ -4842,6 +5278,7 @@ export interface ListSharedProjectsOutput {
4842
5278
  */
4843
5279
  export interface ListSharedReportGroupsInput {
4844
5280
  /**
5281
+ * @public
4845
5282
  * <p>The order in which to list shared report groups. Valid values include:</p>
4846
5283
  * <ul>
4847
5284
  * <li>
@@ -4856,6 +5293,7 @@ export interface ListSharedReportGroupsInput {
4856
5293
  */
4857
5294
  sortOrder?: SortOrderType | string;
4858
5295
  /**
5296
+ * @public
4859
5297
  * <p> The criterion to be used to list report groups shared with the current Amazon Web Services account or
4860
5298
  * user. Valid values include: </p>
4861
5299
  * <ul>
@@ -4872,6 +5310,7 @@ export interface ListSharedReportGroupsInput {
4872
5310
  */
4873
5311
  sortBy?: SharedResourceSortByType | string;
4874
5312
  /**
5313
+ * @public
4875
5314
  * <p> During a previous call, the maximum number of items that can be returned is the value
4876
5315
  * specified in <code>maxResults</code>. If there more items in the list, then a unique
4877
5316
  * string called a <i>nextToken</i> is returned. To get the next batch of
@@ -4881,6 +5320,7 @@ export interface ListSharedReportGroupsInput {
4881
5320
  */
4882
5321
  nextToken?: string;
4883
5322
  /**
5323
+ * @public
4884
5324
  * <p> The maximum number of paginated shared report groups per response. Use
4885
5325
  * <code>nextToken</code> to iterate pages in the list of returned
4886
5326
  * <code>ReportGroup</code> objects. The default value is 100. </p>
@@ -4892,6 +5332,7 @@ export interface ListSharedReportGroupsInput {
4892
5332
  */
4893
5333
  export interface ListSharedReportGroupsOutput {
4894
5334
  /**
5335
+ * @public
4895
5336
  * <p> During a previous call, the maximum number of items that can be returned is the value
4896
5337
  * specified in <code>maxResults</code>. If there more items in the list, then a unique
4897
5338
  * string called a <i>nextToken</i> is returned. To get the next batch of
@@ -4901,6 +5342,7 @@ export interface ListSharedReportGroupsOutput {
4901
5342
  */
4902
5343
  nextToken?: string;
4903
5344
  /**
5345
+ * @public
4904
5346
  * <p> The list of ARNs for the report groups shared with the current Amazon Web Services account or user.
4905
5347
  * </p>
4906
5348
  */
@@ -4918,15 +5360,18 @@ export interface ListSourceCredentialsInput {
4918
5360
  */
4919
5361
  export interface SourceCredentialsInfo {
4920
5362
  /**
5363
+ * @public
4921
5364
  * <p> The Amazon Resource Name (ARN) of the token. </p>
4922
5365
  */
4923
5366
  arn?: string;
4924
5367
  /**
5368
+ * @public
4925
5369
  * <p> The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or
4926
5370
  * BITBUCKET. </p>
4927
5371
  */
4928
5372
  serverType?: ServerType | string;
4929
5373
  /**
5374
+ * @public
4930
5375
  * <p> The type of authentication used by the credentials. Valid options are OAUTH,
4931
5376
  * BASIC_AUTH, or PERSONAL_ACCESS_TOKEN. </p>
4932
5377
  */
@@ -4937,6 +5382,7 @@ export interface SourceCredentialsInfo {
4937
5382
  */
4938
5383
  export interface ListSourceCredentialsOutput {
4939
5384
  /**
5385
+ * @public
4940
5386
  * <p> A list of <code>SourceCredentialsInfo</code> objects. Each
4941
5387
  * <code>SourceCredentialsInfo</code> object includes the authentication type, token
4942
5388
  * ARN, and type of source provider for one set of credentials. </p>
@@ -4948,12 +5394,14 @@ export interface ListSourceCredentialsOutput {
4948
5394
  */
4949
5395
  export interface PutResourcePolicyInput {
4950
5396
  /**
5397
+ * @public
4951
5398
  * <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
4952
5399
  * 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>CodeBuild User Guide</i>.
4953
5400
  * </p>
4954
5401
  */
4955
5402
  policy: string | undefined;
4956
5403
  /**
5404
+ * @public
4957
5405
  * <p> The ARN of the <code>Project</code> or <code>ReportGroup</code> resource you want to
4958
5406
  * associate with a resource policy. </p>
4959
5407
  */
@@ -4964,6 +5412,7 @@ export interface PutResourcePolicyInput {
4964
5412
  */
4965
5413
  export interface PutResourcePolicyOutput {
4966
5414
  /**
5415
+ * @public
4967
5416
  * <p> The ARN of the <code>Project</code> or <code>ReportGroup</code> resource that is
4968
5417
  * associated with a resource policy. </p>
4969
5418
  */
@@ -4974,10 +5423,12 @@ export interface PutResourcePolicyOutput {
4974
5423
  */
4975
5424
  export interface RetryBuildInput {
4976
5425
  /**
5426
+ * @public
4977
5427
  * <p>Specifies the identifier of the build to restart.</p>
4978
5428
  */
4979
5429
  id?: string;
4980
5430
  /**
5431
+ * @public
4981
5432
  * <p>A unique, case sensitive identifier you provide to ensure the idempotency of the
4982
5433
  * <code>RetryBuild</code> request. The token is included in the
4983
5434
  * <code>RetryBuild</code> request and is valid for five minutes. If you repeat
@@ -4991,6 +5442,7 @@ export interface RetryBuildInput {
4991
5442
  */
4992
5443
  export interface RetryBuildOutput {
4993
5444
  /**
5445
+ * @public
4994
5446
  * <p>Information about a build.</p>
4995
5447
  */
4996
5448
  build?: Build;
@@ -5012,10 +5464,12 @@ export type RetryBuildBatchType = (typeof RetryBuildBatchType)[keyof typeof Retr
5012
5464
  */
5013
5465
  export interface RetryBuildBatchInput {
5014
5466
  /**
5467
+ * @public
5015
5468
  * <p>Specifies the identifier of the batch build to restart.</p>
5016
5469
  */
5017
5470
  id?: string;
5018
5471
  /**
5472
+ * @public
5019
5473
  * <p>A unique, case sensitive identifier you provide to ensure the idempotency of the
5020
5474
  * <code>RetryBuildBatch</code> request. The token is included in the
5021
5475
  * <code>RetryBuildBatch</code> request and is valid for five minutes. If you repeat
@@ -5024,6 +5478,7 @@ export interface RetryBuildBatchInput {
5024
5478
  */
5025
5479
  idempotencyToken?: string;
5026
5480
  /**
5481
+ * @public
5027
5482
  * <p>Specifies the type of retry to perform.</p>
5028
5483
  */
5029
5484
  retryType?: RetryBuildBatchType | string;
@@ -5033,6 +5488,7 @@ export interface RetryBuildBatchInput {
5033
5488
  */
5034
5489
  export interface RetryBuildBatchOutput {
5035
5490
  /**
5491
+ * @public
5036
5492
  * <p>Contains information about a batch build.</p>
5037
5493
  */
5038
5494
  buildBatch?: BuildBatch;
@@ -5042,19 +5498,23 @@ export interface RetryBuildBatchOutput {
5042
5498
  */
5043
5499
  export interface StartBuildInput {
5044
5500
  /**
5501
+ * @public
5045
5502
  * <p>The name of the CodeBuild build project to start running a build.</p>
5046
5503
  */
5047
5504
  projectName: string | undefined;
5048
5505
  /**
5506
+ * @public
5049
5507
  * <p> An array of <code>ProjectSource</code> objects. </p>
5050
5508
  */
5051
5509
  secondarySourcesOverride?: ProjectSource[];
5052
5510
  /**
5511
+ * @public
5053
5512
  * <p> An array of <code>ProjectSourceVersion</code> objects that specify one or more
5054
5513
  * versions of the project's secondary sources to be used for this build only. </p>
5055
5514
  */
5056
5515
  secondarySourcesVersionOverride?: ProjectSourceVersion[];
5057
5516
  /**
5517
+ * @public
5058
5518
  * <p>The version of the build input to be built, for this build only. If not specified,
5059
5519
  * the latest version is used. If specified, the contents depends on the source
5060
5520
  * provider:</p>
@@ -5092,46 +5552,55 @@ export interface StartBuildInput {
5092
5552
  */
5093
5553
  sourceVersion?: string;
5094
5554
  /**
5555
+ * @public
5095
5556
  * <p>Build output artifact settings that override, for this build only, the latest ones
5096
5557
  * already defined in the build project.</p>
5097
5558
  */
5098
5559
  artifactsOverride?: ProjectArtifacts;
5099
5560
  /**
5561
+ * @public
5100
5562
  * <p> An array of <code>ProjectArtifacts</code> objects. </p>
5101
5563
  */
5102
5564
  secondaryArtifactsOverride?: ProjectArtifacts[];
5103
5565
  /**
5566
+ * @public
5104
5567
  * <p>A set of environment variables that overrides, for this build only, the latest ones
5105
5568
  * already defined in the build project.</p>
5106
5569
  */
5107
5570
  environmentVariablesOverride?: EnvironmentVariable[];
5108
5571
  /**
5572
+ * @public
5109
5573
  * <p>A source input type, for this build, that overrides the source input defined in the
5110
5574
  * build project.</p>
5111
5575
  */
5112
5576
  sourceTypeOverride?: SourceType | string;
5113
5577
  /**
5578
+ * @public
5114
5579
  * <p>A location that overrides, for this build, the source location for the one defined in
5115
5580
  * the build project.</p>
5116
5581
  */
5117
5582
  sourceLocationOverride?: string;
5118
5583
  /**
5584
+ * @public
5119
5585
  * <p>An authorization type for this build that overrides the one defined in the build
5120
5586
  * project. This override applies only if the build project's source is BitBucket or
5121
5587
  * GitHub.</p>
5122
5588
  */
5123
5589
  sourceAuthOverride?: SourceAuth;
5124
5590
  /**
5591
+ * @public
5125
5592
  * <p>The user-defined depth of history, with a minimum value of 0, that overrides, for this
5126
5593
  * build only, any previous depth of history defined in the build project.</p>
5127
5594
  */
5128
5595
  gitCloneDepthOverride?: number;
5129
5596
  /**
5597
+ * @public
5130
5598
  * <p> Information about the Git submodules configuration for this build of an CodeBuild build
5131
5599
  * project. </p>
5132
5600
  */
5133
5601
  gitSubmodulesConfigOverride?: GitSubmodulesConfig;
5134
5602
  /**
5603
+ * @public
5135
5604
  * <p>A buildspec file declaration that overrides, for this build only, the latest one
5136
5605
  * already defined in the build project.</p>
5137
5606
  * <p> If this value is set, it can be either an inline buildspec definition, the path to an
@@ -5145,6 +5614,7 @@ export interface StartBuildInput {
5145
5614
  */
5146
5615
  buildspecOverride?: string;
5147
5616
  /**
5617
+ * @public
5148
5618
  * <p>Enable this flag to override the insecure SSL setting that is specified in the build
5149
5619
  * project. The insecure SSL setting determines whether to ignore SSL warnings while
5150
5620
  * connecting to the project source code. This override applies only if the build's source
@@ -5152,6 +5622,7 @@ export interface StartBuildInput {
5152
5622
  */
5153
5623
  insecureSslOverride?: boolean;
5154
5624
  /**
5625
+ * @public
5155
5626
  * <p> Set to true to report to your source provider the status of a build's start and
5156
5627
  * completion. If you use this option with a source provider other than GitHub, GitHub
5157
5628
  * Enterprise, or Bitbucket, an <code>invalidInputException</code> is thrown. </p>
@@ -5164,6 +5635,7 @@ export interface StartBuildInput {
5164
5635
  */
5165
5636
  reportBuildStatusOverride?: boolean;
5166
5637
  /**
5638
+ * @public
5167
5639
  * <p>Contains information that defines how the build project reports the build status to
5168
5640
  * the source provider. This option is only used when the source provider is
5169
5641
  * <code>GITHUB</code>, <code>GITHUB_ENTERPRISE</code>, or
@@ -5171,49 +5643,59 @@ export interface StartBuildInput {
5171
5643
  */
5172
5644
  buildStatusConfigOverride?: BuildStatusConfig;
5173
5645
  /**
5646
+ * @public
5174
5647
  * <p>A container type for this build that overrides the one specified in the build
5175
5648
  * project.</p>
5176
5649
  */
5177
5650
  environmentTypeOverride?: EnvironmentType | string;
5178
5651
  /**
5652
+ * @public
5179
5653
  * <p>The name of an image for this build that overrides the one specified in the build
5180
5654
  * project.</p>
5181
5655
  */
5182
5656
  imageOverride?: string;
5183
5657
  /**
5658
+ * @public
5184
5659
  * <p>The name of a compute type for this build that overrides the one specified in the
5185
5660
  * build project.</p>
5186
5661
  */
5187
5662
  computeTypeOverride?: ComputeType | string;
5188
5663
  /**
5664
+ * @public
5189
5665
  * <p>The name of a certificate for this build that overrides the one specified in the build
5190
5666
  * project.</p>
5191
5667
  */
5192
5668
  certificateOverride?: string;
5193
5669
  /**
5670
+ * @public
5194
5671
  * <p>A ProjectCache object specified for this build that overrides the one defined in the
5195
5672
  * build project.</p>
5196
5673
  */
5197
5674
  cacheOverride?: ProjectCache;
5198
5675
  /**
5676
+ * @public
5199
5677
  * <p>The name of a service role for this build that overrides the one specified in the
5200
5678
  * build project.</p>
5201
5679
  */
5202
5680
  serviceRoleOverride?: string;
5203
5681
  /**
5682
+ * @public
5204
5683
  * <p>Enable this flag to override privileged mode in the build project.</p>
5205
5684
  */
5206
5685
  privilegedModeOverride?: boolean;
5207
5686
  /**
5687
+ * @public
5208
5688
  * <p>The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this
5209
5689
  * build only, the latest setting already defined in the build project.</p>
5210
5690
  */
5211
5691
  timeoutInMinutesOverride?: number;
5212
5692
  /**
5693
+ * @public
5213
5694
  * <p> The number of minutes a build is allowed to be queued before it times out. </p>
5214
5695
  */
5215
5696
  queuedTimeoutInMinutesOverride?: number;
5216
5697
  /**
5698
+ * @public
5217
5699
  * <p>The Key Management Service customer master key (CMK) that overrides the one specified in the build
5218
5700
  * project. The CMK key encrypts the build output artifacts.</p>
5219
5701
  * <note>
@@ -5225,6 +5707,7 @@ export interface StartBuildInput {
5225
5707
  */
5226
5708
  encryptionKeyOverride?: string;
5227
5709
  /**
5710
+ * @public
5228
5711
  * <p>A unique, case sensitive identifier you provide to ensure the idempotency of the
5229
5712
  * StartBuild request. The token is included in the StartBuild request and is valid for 5
5230
5713
  * minutes. If you repeat the StartBuild request with the same token, but change a
@@ -5232,15 +5715,18 @@ export interface StartBuildInput {
5232
5715
  */
5233
5716
  idempotencyToken?: string;
5234
5717
  /**
5718
+ * @public
5235
5719
  * <p> Log settings for this build that override the log settings defined in the build
5236
5720
  * project. </p>
5237
5721
  */
5238
5722
  logsConfigOverride?: LogsConfig;
5239
5723
  /**
5724
+ * @public
5240
5725
  * <p> The credentials for access to a private registry. </p>
5241
5726
  */
5242
5727
  registryCredentialOverride?: RegistryCredential;
5243
5728
  /**
5729
+ * @public
5244
5730
  * <p>The type of credentials CodeBuild uses to pull images in your build. There are two valid
5245
5731
  * values: </p>
5246
5732
  * <dl>
@@ -5260,6 +5746,7 @@ export interface StartBuildInput {
5260
5746
  */
5261
5747
  imagePullCredentialsTypeOverride?: ImagePullCredentialsType | string;
5262
5748
  /**
5749
+ * @public
5263
5750
  * <p>Specifies if session debugging is enabled for this build. For more information, see
5264
5751
  * <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html">Viewing a running build in Session Manager</a>.</p>
5265
5752
  */
@@ -5270,6 +5757,7 @@ export interface StartBuildInput {
5270
5757
  */
5271
5758
  export interface StartBuildOutput {
5272
5759
  /**
5760
+ * @public
5273
5761
  * <p>Information about the build to be run.</p>
5274
5762
  */
5275
5763
  build?: Build;
@@ -5279,20 +5767,24 @@ export interface StartBuildOutput {
5279
5767
  */
5280
5768
  export interface StartBuildBatchInput {
5281
5769
  /**
5770
+ * @public
5282
5771
  * <p>The name of the project.</p>
5283
5772
  */
5284
5773
  projectName: string | undefined;
5285
5774
  /**
5775
+ * @public
5286
5776
  * <p>An array of <code>ProjectSource</code> objects that override the secondary sources
5287
5777
  * defined in the batch build project.</p>
5288
5778
  */
5289
5779
  secondarySourcesOverride?: ProjectSource[];
5290
5780
  /**
5781
+ * @public
5291
5782
  * <p>An array of <code>ProjectSourceVersion</code> objects that override the secondary source
5292
5783
  * versions in the batch build project.</p>
5293
5784
  */
5294
5785
  secondarySourcesVersionOverride?: ProjectSourceVersion[];
5295
5786
  /**
5787
+ * @public
5296
5788
  * <p>The version of the batch build input to be built, for this build only. If not specified,
5297
5789
  * the latest version is used. If specified, the contents depends on the source
5298
5790
  * provider:</p>
@@ -5330,47 +5822,56 @@ export interface StartBuildBatchInput {
5330
5822
  */
5331
5823
  sourceVersion?: string;
5332
5824
  /**
5825
+ * @public
5333
5826
  * <p>An array of <code>ProjectArtifacts</code> objects that contains information about the
5334
5827
  * build output artifact overrides for the build project.</p>
5335
5828
  */
5336
5829
  artifactsOverride?: ProjectArtifacts;
5337
5830
  /**
5831
+ * @public
5338
5832
  * <p>An array of <code>ProjectArtifacts</code> objects that override the secondary artifacts
5339
5833
  * defined in the batch build project.</p>
5340
5834
  */
5341
5835
  secondaryArtifactsOverride?: ProjectArtifacts[];
5342
5836
  /**
5837
+ * @public
5343
5838
  * <p>An array of <code>EnvironmentVariable</code> objects that override, or add to, the
5344
5839
  * environment variables defined in the batch build project.</p>
5345
5840
  */
5346
5841
  environmentVariablesOverride?: EnvironmentVariable[];
5347
5842
  /**
5843
+ * @public
5348
5844
  * <p>The source input type that overrides the source input defined in the batch
5349
5845
  * build project.</p>
5350
5846
  */
5351
5847
  sourceTypeOverride?: SourceType | string;
5352
5848
  /**
5849
+ * @public
5353
5850
  * <p>A location that overrides, for this batch build, the source location defined in
5354
5851
  * the batch build project.</p>
5355
5852
  */
5356
5853
  sourceLocationOverride?: string;
5357
5854
  /**
5855
+ * @public
5358
5856
  * <p>A <code>SourceAuth</code> object that overrides the one defined in the batch build
5359
5857
  * project. This override applies only if the build project's source is BitBucket or
5360
5858
  * GitHub.</p>
5361
5859
  */
5362
5860
  sourceAuthOverride?: SourceAuth;
5363
5861
  /**
5862
+ * @public
5364
5863
  * <p>The user-defined depth of history, with a minimum value of 0, that overrides, for this
5365
5864
  * batch build only, any previous depth of history defined in the batch build project.</p>
5366
5865
  */
5367
5866
  gitCloneDepthOverride?: number;
5368
5867
  /**
5868
+ * @public
5369
5869
  * <p>A <code>GitSubmodulesConfig</code> object that overrides the Git submodules configuration
5370
5870
  * for this batch build.</p>
5371
5871
  */
5372
5872
  gitSubmodulesConfigOverride?: GitSubmodulesConfig;
5373
5873
  /**
5874
+ * @public
5374
5875
  * <p>A buildspec file declaration that overrides, for this build only, the latest one
5375
5876
  * already defined in the build project.</p>
5376
5877
  * <p>If this value is set, it can be either an inline buildspec definition, the path to an
@@ -5384,6 +5885,7 @@ export interface StartBuildBatchInput {
5384
5885
  */
5385
5886
  buildspecOverride?: string;
5386
5887
  /**
5888
+ * @public
5387
5889
  * <p>Enable this flag to override the insecure SSL setting that is specified in the batch build
5388
5890
  * project. The insecure SSL setting determines whether to ignore SSL warnings while
5389
5891
  * connecting to the project source code. This override applies only if the build's source
@@ -5391,6 +5893,7 @@ export interface StartBuildBatchInput {
5391
5893
  */
5392
5894
  insecureSslOverride?: boolean;
5393
5895
  /**
5896
+ * @public
5394
5897
  * <p>Set to <code>true</code> to report to your source provider the status of a batch build's
5395
5898
  * start and completion. If you use this option with a source provider other than GitHub,
5396
5899
  * GitHub Enterprise, or Bitbucket, an <code>invalidInputException</code> is thrown. </p>
@@ -5401,47 +5904,57 @@ export interface StartBuildBatchInput {
5401
5904
  */
5402
5905
  reportBuildBatchStatusOverride?: boolean;
5403
5906
  /**
5907
+ * @public
5404
5908
  * <p>A container type for this batch build that overrides the one specified in the batch build
5405
5909
  * project.</p>
5406
5910
  */
5407
5911
  environmentTypeOverride?: EnvironmentType | string;
5408
5912
  /**
5913
+ * @public
5409
5914
  * <p>The name of an image for this batch build that overrides the one specified in the batch
5410
5915
  * build project.</p>
5411
5916
  */
5412
5917
  imageOverride?: string;
5413
5918
  /**
5919
+ * @public
5414
5920
  * <p>The name of a compute type for this batch build that overrides the one specified in the
5415
5921
  * batch build project.</p>
5416
5922
  */
5417
5923
  computeTypeOverride?: ComputeType | string;
5418
5924
  /**
5925
+ * @public
5419
5926
  * <p>The name of a certificate for this batch build that overrides the one specified in the batch build
5420
5927
  * project.</p>
5421
5928
  */
5422
5929
  certificateOverride?: string;
5423
5930
  /**
5931
+ * @public
5424
5932
  * <p>A <code>ProjectCache</code> object that specifies cache overrides.</p>
5425
5933
  */
5426
5934
  cacheOverride?: ProjectCache;
5427
5935
  /**
5936
+ * @public
5428
5937
  * <p>The name of a service role for this batch build that overrides the one specified in the
5429
5938
  * batch build project.</p>
5430
5939
  */
5431
5940
  serviceRoleOverride?: string;
5432
5941
  /**
5942
+ * @public
5433
5943
  * <p>Enable this flag to override privileged mode in the batch build project.</p>
5434
5944
  */
5435
5945
  privilegedModeOverride?: boolean;
5436
5946
  /**
5947
+ * @public
5437
5948
  * <p>Overrides the build timeout specified in the batch build project.</p>
5438
5949
  */
5439
5950
  buildTimeoutInMinutesOverride?: number;
5440
5951
  /**
5952
+ * @public
5441
5953
  * <p>The number of minutes a batch build is allowed to be queued before it times out.</p>
5442
5954
  */
5443
5955
  queuedTimeoutInMinutesOverride?: number;
5444
5956
  /**
5957
+ * @public
5445
5958
  * <p>The Key Management Service customer master key (CMK) that overrides the one specified in the batch build
5446
5959
  * project. The CMK key encrypts the build output artifacts.</p>
5447
5960
  * <note>
@@ -5453,6 +5966,7 @@ export interface StartBuildBatchInput {
5453
5966
  */
5454
5967
  encryptionKeyOverride?: string;
5455
5968
  /**
5969
+ * @public
5456
5970
  * <p>A unique, case sensitive identifier you provide to ensure the idempotency of the
5457
5971
  * <code>StartBuildBatch</code> request. The token is included in the
5458
5972
  * <code>StartBuildBatch</code> request and is valid for five minutes. If you repeat
@@ -5461,16 +5975,19 @@ export interface StartBuildBatchInput {
5461
5975
  */
5462
5976
  idempotencyToken?: string;
5463
5977
  /**
5978
+ * @public
5464
5979
  * <p>A <code>LogsConfig</code> object that override the log settings defined in the batch build
5465
5980
  * project.</p>
5466
5981
  */
5467
5982
  logsConfigOverride?: LogsConfig;
5468
5983
  /**
5984
+ * @public
5469
5985
  * <p>A <code>RegistryCredential</code> object that overrides credentials for access to a
5470
5986
  * private registry.</p>
5471
5987
  */
5472
5988
  registryCredentialOverride?: RegistryCredential;
5473
5989
  /**
5990
+ * @public
5474
5991
  * <p>The type of credentials CodeBuild uses to pull images in your batch build. There are two valid
5475
5992
  * values: </p>
5476
5993
  * <dl>
@@ -5490,11 +6007,13 @@ export interface StartBuildBatchInput {
5490
6007
  */
5491
6008
  imagePullCredentialsTypeOverride?: ImagePullCredentialsType | string;
5492
6009
  /**
6010
+ * @public
5493
6011
  * <p>A <code>BuildBatchConfigOverride</code> object that contains batch build configuration
5494
6012
  * overrides.</p>
5495
6013
  */
5496
6014
  buildBatchConfigOverride?: ProjectBuildBatchConfig;
5497
6015
  /**
6016
+ * @public
5498
6017
  * <p>Specifies if session debugging is enabled for this batch build. For more information, see
5499
6018
  * <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html">Viewing a running build in Session Manager</a>. Batch session debugging is not supported for matrix batch builds.</p>
5500
6019
  */
@@ -5505,6 +6024,7 @@ export interface StartBuildBatchInput {
5505
6024
  */
5506
6025
  export interface StartBuildBatchOutput {
5507
6026
  /**
6027
+ * @public
5508
6028
  * <p>A <code>BuildBatch</code> object that contains information about the batch build.</p>
5509
6029
  */
5510
6030
  buildBatch?: BuildBatch;
@@ -5514,6 +6034,7 @@ export interface StartBuildBatchOutput {
5514
6034
  */
5515
6035
  export interface StopBuildInput {
5516
6036
  /**
6037
+ * @public
5517
6038
  * <p>The ID of the build.</p>
5518
6039
  */
5519
6040
  id: string | undefined;
@@ -5523,6 +6044,7 @@ export interface StopBuildInput {
5523
6044
  */
5524
6045
  export interface StopBuildOutput {
5525
6046
  /**
6047
+ * @public
5526
6048
  * <p>Information about the build.</p>
5527
6049
  */
5528
6050
  build?: Build;
@@ -5532,6 +6054,7 @@ export interface StopBuildOutput {
5532
6054
  */
5533
6055
  export interface StopBuildBatchInput {
5534
6056
  /**
6057
+ * @public
5535
6058
  * <p>The identifier of the batch build to stop.</p>
5536
6059
  */
5537
6060
  id: string | undefined;
@@ -5541,6 +6064,7 @@ export interface StopBuildBatchInput {
5541
6064
  */
5542
6065
  export interface StopBuildBatchOutput {
5543
6066
  /**
6067
+ * @public
5544
6068
  * <p>Contains information about a batch build.</p>
5545
6069
  */
5546
6070
  buildBatch?: BuildBatch;
@@ -5550,6 +6074,7 @@ export interface StopBuildBatchOutput {
5550
6074
  */
5551
6075
  export interface UpdateProjectInput {
5552
6076
  /**
6077
+ * @public
5553
6078
  * <p>The name of the build project.</p>
5554
6079
  * <note>
5555
6080
  * <p>You cannot change a build project's name.</p>
@@ -5557,19 +6082,23 @@ export interface UpdateProjectInput {
5557
6082
  */
5558
6083
  name: string | undefined;
5559
6084
  /**
6085
+ * @public
5560
6086
  * <p>A new or replacement description of the build project.</p>
5561
6087
  */
5562
6088
  description?: string;
5563
6089
  /**
6090
+ * @public
5564
6091
  * <p>Information to be changed about the build input source code for the build
5565
6092
  * project.</p>
5566
6093
  */
5567
6094
  source?: ProjectSource;
5568
6095
  /**
6096
+ * @public
5569
6097
  * <p> An array of <code>ProjectSource</code> objects. </p>
5570
6098
  */
5571
6099
  secondarySources?: ProjectSource[];
5572
6100
  /**
6101
+ * @public
5573
6102
  * <p> A version of the build input to be built for this project. If not specified, the
5574
6103
  * latest version is used. If specified, it must be one of: </p>
5575
6104
  * <ul>
@@ -5603,44 +6132,53 @@ export interface UpdateProjectInput {
5603
6132
  */
5604
6133
  sourceVersion?: string;
5605
6134
  /**
6135
+ * @public
5606
6136
  * <p> An array of <code>ProjectSourceVersion</code> objects. If
5607
6137
  * <code>secondarySourceVersions</code> is specified at the build level, then they take
5608
6138
  * over these <code>secondarySourceVersions</code> (at the project level). </p>
5609
6139
  */
5610
6140
  secondarySourceVersions?: ProjectSourceVersion[];
5611
6141
  /**
6142
+ * @public
5612
6143
  * <p>Information to be changed about the build output artifacts for the build
5613
6144
  * project.</p>
5614
6145
  */
5615
6146
  artifacts?: ProjectArtifacts;
5616
6147
  /**
6148
+ * @public
5617
6149
  * <p> An array of <code>ProjectArtifact</code> objects. </p>
5618
6150
  */
5619
6151
  secondaryArtifacts?: ProjectArtifacts[];
5620
6152
  /**
6153
+ * @public
5621
6154
  * <p>Stores recently used information so that it can be quickly accessed at a later
5622
6155
  * time.</p>
5623
6156
  */
5624
6157
  cache?: ProjectCache;
5625
6158
  /**
6159
+ * @public
5626
6160
  * <p>Information to be changed about the build environment for the build project.</p>
5627
6161
  */
5628
6162
  environment?: ProjectEnvironment;
5629
6163
  /**
6164
+ * @public
5630
6165
  * <p>The replacement ARN of the IAM role that enables CodeBuild to interact with dependent
5631
6166
  * Amazon Web Services services on behalf of the Amazon Web Services account.</p>
5632
6167
  */
5633
6168
  serviceRole?: string;
5634
6169
  /**
6170
+ * @public
5635
6171
  * <p>The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before
5636
6172
  * timing out any related build that did not get marked as completed.</p>
5637
6173
  */
5638
6174
  timeoutInMinutes?: number;
5639
6175
  /**
6176
+ * @public
5640
6177
  * <p> The number of minutes a build is allowed to be queued before it times out. </p>
5641
6178
  */
5642
6179
  queuedTimeoutInMinutes?: number;
5643
6180
  /**
6181
+ * @public
5644
6182
  * <p>The Key Management Service customer master key (CMK) to be used for encrypting the build output
5645
6183
  * artifacts.</p>
5646
6184
  * <note>
@@ -5653,26 +6191,31 @@ export interface UpdateProjectInput {
5653
6191
  */
5654
6192
  encryptionKey?: string;
5655
6193
  /**
6194
+ * @public
5656
6195
  * <p>An updated list of tag key and value pairs associated with this build project.</p>
5657
6196
  * <p>These tags are available for use by Amazon Web Services services that support CodeBuild build project
5658
6197
  * tags.</p>
5659
6198
  */
5660
6199
  tags?: Tag[];
5661
6200
  /**
6201
+ * @public
5662
6202
  * <p>VpcConfig enables CodeBuild to access resources in an Amazon VPC.</p>
5663
6203
  */
5664
6204
  vpcConfig?: VpcConfig;
5665
6205
  /**
6206
+ * @public
5666
6207
  * <p>Set this to true to generate a publicly accessible URL for your project's build
5667
6208
  * badge.</p>
5668
6209
  */
5669
6210
  badgeEnabled?: boolean;
5670
6211
  /**
6212
+ * @public
5671
6213
  * <p> Information about logs for the build project. A project can create logs in CloudWatch Logs,
5672
6214
  * logs in an S3 bucket, or both. </p>
5673
6215
  */
5674
6216
  logsConfig?: LogsConfig;
5675
6217
  /**
6218
+ * @public
5676
6219
  * <p>
5677
6220
  * An array of <code>ProjectFileSystemLocation</code> objects for a CodeBuild build project. A <code>ProjectFileSystemLocation</code> object
5678
6221
  * specifies the <code>identifier</code>, <code>location</code>, <code>mountOptions</code>,
@@ -5681,10 +6224,12 @@ export interface UpdateProjectInput {
5681
6224
  */
5682
6225
  fileSystemLocations?: ProjectFileSystemLocation[];
5683
6226
  /**
6227
+ * @public
5684
6228
  * <p>Contains configuration information about a batch build project.</p>
5685
6229
  */
5686
6230
  buildBatchConfig?: ProjectBuildBatchConfig;
5687
6231
  /**
6232
+ * @public
5688
6233
  * <p>The maximum number of concurrent builds that are allowed for this project.</p>
5689
6234
  * <p>New builds are only started if the current number of builds is less than or equal to this limit.
5690
6235
  * If the current build count meets this limit, new builds are throttled and are not run.</p>
@@ -5697,6 +6242,7 @@ export interface UpdateProjectInput {
5697
6242
  */
5698
6243
  export interface UpdateProjectOutput {
5699
6244
  /**
6245
+ * @public
5700
6246
  * <p>Information about the build project that was changed.</p>
5701
6247
  */
5702
6248
  project?: Project;
@@ -5706,10 +6252,12 @@ export interface UpdateProjectOutput {
5706
6252
  */
5707
6253
  export interface UpdateProjectVisibilityInput {
5708
6254
  /**
6255
+ * @public
5709
6256
  * <p>The Amazon Resource Name (ARN) of the build project.</p>
5710
6257
  */
5711
6258
  projectArn: string | undefined;
5712
6259
  /**
6260
+ * @public
5713
6261
  * <p>Specifies the visibility of the project's builds. Possible values are:</p>
5714
6262
  *
5715
6263
  * <dl>
@@ -5725,6 +6273,7 @@ export interface UpdateProjectVisibilityInput {
5725
6273
  */
5726
6274
  projectVisibility: ProjectVisibilityType | string | undefined;
5727
6275
  /**
6276
+ * @public
5728
6277
  * <p>The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for
5729
6278
  * the project's builds.</p>
5730
6279
  */
@@ -5735,14 +6284,17 @@ export interface UpdateProjectVisibilityInput {
5735
6284
  */
5736
6285
  export interface UpdateProjectVisibilityOutput {
5737
6286
  /**
6287
+ * @public
5738
6288
  * <p>The Amazon Resource Name (ARN) of the build project.</p>
5739
6289
  */
5740
6290
  projectArn?: string;
5741
6291
  /**
6292
+ * @public
5742
6293
  * <p>Contains the project identifier used with the public build APIs. </p>
5743
6294
  */
5744
6295
  publicProjectAlias?: string;
5745
6296
  /**
6297
+ * @public
5746
6298
  * <p>Specifies the visibility of the project's builds. Possible values are:</p>
5747
6299
  *
5748
6300
  * <dl>
@@ -5763,12 +6315,14 @@ export interface UpdateProjectVisibilityOutput {
5763
6315
  */
5764
6316
  export interface UpdateReportGroupInput {
5765
6317
  /**
6318
+ * @public
5766
6319
  * <p>
5767
6320
  * The ARN of the report group to update.
5768
6321
  * </p>
5769
6322
  */
5770
6323
  arn: string | undefined;
5771
6324
  /**
6325
+ * @public
5772
6326
  * <p>
5773
6327
  * Used to specify an updated export type. Valid values are:
5774
6328
  * </p>
@@ -5787,6 +6341,7 @@ export interface UpdateReportGroupInput {
5787
6341
  */
5788
6342
  exportConfig?: ReportExportConfig;
5789
6343
  /**
6344
+ * @public
5790
6345
  * <p>
5791
6346
  * An updated list of tag key and value pairs associated with this report group.
5792
6347
  * </p>
@@ -5800,6 +6355,7 @@ export interface UpdateReportGroupInput {
5800
6355
  */
5801
6356
  export interface UpdateReportGroupOutput {
5802
6357
  /**
6358
+ * @public
5803
6359
  * <p>
5804
6360
  * Information about the updated report group.
5805
6361
  * </p>
@@ -5811,10 +6367,12 @@ export interface UpdateReportGroupOutput {
5811
6367
  */
5812
6368
  export interface UpdateWebhookInput {
5813
6369
  /**
6370
+ * @public
5814
6371
  * <p>The name of the CodeBuild project.</p>
5815
6372
  */
5816
6373
  projectName: string | undefined;
5817
6374
  /**
6375
+ * @public
5818
6376
  * <p>A regular expression used to determine which repository branches are built when a
5819
6377
  * webhook is triggered. If the name of a branch matches the regular expression, then it is
5820
6378
  * built. If <code>branchFilter</code> is empty, then all branches are built.</p>
@@ -5825,12 +6383,14 @@ export interface UpdateWebhookInput {
5825
6383
  */
5826
6384
  branchFilter?: string;
5827
6385
  /**
6386
+ * @public
5828
6387
  * <p> A boolean value that specifies whether the associated GitHub repository's secret
5829
6388
  * token should be updated. If you use Bitbucket for your repository,
5830
6389
  * <code>rotateSecret</code> is ignored. </p>
5831
6390
  */
5832
6391
  rotateSecret?: boolean;
5833
6392
  /**
6393
+ * @public
5834
6394
  * <p> An array of arrays of <code>WebhookFilter</code> objects used to determine if a
5835
6395
  * webhook event can trigger a build. A filter group must contain at least one
5836
6396
  * <code>EVENT</code>
@@ -5838,6 +6398,7 @@ export interface UpdateWebhookInput {
5838
6398
  */
5839
6399
  filterGroups?: WebhookFilter[][];
5840
6400
  /**
6401
+ * @public
5841
6402
  * <p>Specifies the type of build this webhook will trigger.</p>
5842
6403
  */
5843
6404
  buildType?: WebhookBuildType | string;
@@ -5847,6 +6408,7 @@ export interface UpdateWebhookInput {
5847
6408
  */
5848
6409
  export interface UpdateWebhookOutput {
5849
6410
  /**
6411
+ * @public
5850
6412
  * <p> Information about a repository's webhook that is associated with a project in CodeBuild.
5851
6413
  * </p>
5852
6414
  */