@aws-sdk/client-codecatalyst 3.379.1 → 3.382.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.
@@ -30,10 +30,12 @@ export declare class ConflictException extends __BaseException {
30
30
  */
31
31
  export interface CreateAccessTokenRequest {
32
32
  /**
33
+ * @public
33
34
  * <p>The friendly name of the personal access token.</p>
34
35
  */
35
36
  name: string | undefined;
36
37
  /**
38
+ * @public
37
39
  * <p>The date and time the personal access token expires, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a>.</p>
38
40
  */
39
41
  expiresTime?: Date;
@@ -43,18 +45,22 @@ export interface CreateAccessTokenRequest {
43
45
  */
44
46
  export interface CreateAccessTokenResponse {
45
47
  /**
48
+ * @public
46
49
  * <p>The secret value of the personal access token.</p>
47
50
  */
48
51
  secret: string | undefined;
49
52
  /**
53
+ * @public
50
54
  * <p>The friendly name of the personal access token.</p>
51
55
  */
52
56
  name: string | undefined;
53
57
  /**
58
+ * @public
54
59
  * <p>The date and time the personal access token expires, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a>. If not specified, the default is one year from creation.</p>
55
60
  */
56
61
  expiresTime: Date | undefined;
57
62
  /**
63
+ * @public
58
64
  * <p>The system-generated unique ID of the access token.</p>
59
65
  */
60
66
  accessTokenId: string | undefined;
@@ -114,6 +120,7 @@ export declare class ValidationException extends __BaseException {
114
120
  */
115
121
  export interface DeleteAccessTokenRequest {
116
122
  /**
123
+ * @public
117
124
  * <p>The ID of the personal access token to delete. You can find the IDs of all PATs associated with your Amazon Web Services Builder ID in a space by calling <a>ListAccessTokens</a>.</p>
118
125
  */
119
126
  id: string | undefined;
@@ -128,10 +135,12 @@ export interface DeleteAccessTokenResponse {
128
135
  */
129
136
  export interface ListAccessTokensRequest {
130
137
  /**
138
+ * @public
131
139
  * <p>The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a <code>NextToken</code> element, which you can use to obtain additional results.</p>
132
140
  */
133
141
  maxResults?: number;
134
142
  /**
143
+ * @public
135
144
  * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
136
145
  */
137
146
  nextToken?: string;
@@ -142,14 +151,17 @@ export interface ListAccessTokensRequest {
142
151
  */
143
152
  export interface AccessTokenSummary {
144
153
  /**
154
+ * @public
145
155
  * <p>The system-generated ID of the personal access token.</p>
146
156
  */
147
157
  id: string | undefined;
148
158
  /**
159
+ * @public
149
160
  * <p>The friendly name of the personal access token.</p>
150
161
  */
151
162
  name: string | undefined;
152
163
  /**
164
+ * @public
153
165
  * <p>The date and time when the personal access token will expire, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a>.</p>
154
166
  */
155
167
  expiresTime?: Date;
@@ -159,10 +171,12 @@ export interface AccessTokenSummary {
159
171
  */
160
172
  export interface ListAccessTokensResponse {
161
173
  /**
174
+ * @public
162
175
  * <p>A list of personal access tokens (PATs) associated with the calling user identity.</p>
163
176
  */
164
177
  items: AccessTokenSummary[] | undefined;
165
178
  /**
179
+ * @public
166
180
  * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
167
181
  */
168
182
  nextToken?: string;
@@ -172,10 +186,12 @@ export interface ListAccessTokensResponse {
172
186
  */
173
187
  export interface GetUserDetailsRequest {
174
188
  /**
189
+ * @public
175
190
  * <p>The system-generated unique ID of the user. </p>
176
191
  */
177
192
  id?: string;
178
193
  /**
194
+ * @public
179
195
  * <p>The name of the user as displayed in Amazon CodeCatalyst.</p>
180
196
  */
181
197
  userName?: string;
@@ -186,10 +202,12 @@ export interface GetUserDetailsRequest {
186
202
  */
187
203
  export interface EmailAddress {
188
204
  /**
205
+ * @public
189
206
  * <p>The email address.</p>
190
207
  */
191
208
  email?: string;
192
209
  /**
210
+ * @public
193
211
  * <p>Whether the email address has been verified.</p>
194
212
  */
195
213
  verified?: boolean;
@@ -199,22 +217,27 @@ export interface EmailAddress {
199
217
  */
200
218
  export interface GetUserDetailsResponse {
201
219
  /**
220
+ * @public
202
221
  * <p>The system-generated unique ID of the user.</p>
203
222
  */
204
223
  userId?: string;
205
224
  /**
225
+ * @public
206
226
  * <p>The name of the user as displayed in Amazon CodeCatalyst.</p>
207
227
  */
208
228
  userName?: string;
209
229
  /**
230
+ * @public
210
231
  * <p>The friendly name displayed for the user in Amazon CodeCatalyst.</p>
211
232
  */
212
233
  displayName?: string;
213
234
  /**
235
+ * @public
214
236
  * <p>The email address provided by the user when they signed up.</p>
215
237
  */
216
238
  primaryEmail?: EmailAddress;
217
239
  /**
240
+ * @public
218
241
  * <p/>
219
242
  */
220
243
  version?: string;
@@ -224,6 +247,7 @@ export interface GetUserDetailsResponse {
224
247
  */
225
248
  export interface DeleteSpaceRequest {
226
249
  /**
250
+ * @public
227
251
  * <p>The name of the space. To retrieve a list of space names, use <a>ListSpaces</a>.</p>
228
252
  */
229
253
  name: string | undefined;
@@ -233,10 +257,12 @@ export interface DeleteSpaceRequest {
233
257
  */
234
258
  export interface DeleteSpaceResponse {
235
259
  /**
260
+ * @public
236
261
  * <p>The name of the space.</p>
237
262
  */
238
263
  name: string | undefined;
239
264
  /**
265
+ * @public
240
266
  * <p>The friendly name of the space displayed to users of the space in Amazon CodeCatalyst.</p>
241
267
  */
242
268
  displayName?: string;
@@ -246,26 +272,32 @@ export interface DeleteSpaceResponse {
246
272
  */
247
273
  export interface ListEventLogsRequest {
248
274
  /**
275
+ * @public
249
276
  * <p>The name of the space.</p>
250
277
  */
251
278
  spaceName: string | undefined;
252
279
  /**
280
+ * @public
253
281
  * <p>The date and time when you want to start retrieving events, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a>.</p>
254
282
  */
255
283
  startTime: Date | undefined;
256
284
  /**
285
+ * @public
257
286
  * <p>The time after which you do not want any events retrieved, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a>.</p>
258
287
  */
259
288
  endTime: Date | undefined;
260
289
  /**
290
+ * @public
261
291
  * <p>The name of the event.</p>
262
292
  */
263
293
  eventName?: string;
264
294
  /**
295
+ * @public
265
296
  * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
266
297
  */
267
298
  nextToken?: string;
268
299
  /**
300
+ * @public
269
301
  * <p>The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a <code>NextToken</code> element, which you can use to obtain additional results.</p>
270
302
  */
271
303
  maxResults?: number;
@@ -288,10 +320,12 @@ export type OperationType = (typeof OperationType)[keyof typeof OperationType];
288
320
  */
289
321
  export interface ProjectInformation {
290
322
  /**
323
+ * @public
291
324
  * <p>The name of the project in the space.</p>
292
325
  */
293
326
  name?: string;
294
327
  /**
328
+ * @public
295
329
  * <p>The system-generated unique ID of the project.</p>
296
330
  */
297
331
  projectId?: string;
@@ -302,10 +336,12 @@ export interface ProjectInformation {
302
336
  */
303
337
  export interface EventPayload {
304
338
  /**
339
+ * @public
305
340
  * <p>The type of content in the event payload.</p>
306
341
  */
307
342
  contentType?: string;
308
343
  /**
344
+ * @public
309
345
  * <p>The data included in the event payload.</p>
310
346
  */
311
347
  data?: string;
@@ -329,18 +365,22 @@ export type UserType = (typeof UserType)[keyof typeof UserType];
329
365
  */
330
366
  export interface UserIdentity {
331
367
  /**
368
+ * @public
332
369
  * <p>The role assigned to the user in a Amazon CodeCatalyst space or project when the event occurred.</p>
333
370
  */
334
371
  userType: UserType | string | undefined;
335
372
  /**
373
+ * @public
336
374
  * <p>The ID of the Amazon CodeCatalyst service principal.</p>
337
375
  */
338
376
  principalId: string | undefined;
339
377
  /**
378
+ * @public
340
379
  * <p>The display name of the user in Amazon CodeCatalyst.</p>
341
380
  */
342
381
  userName?: string;
343
382
  /**
383
+ * @public
344
384
  * <p>The Amazon Web Services account number of the user in Amazon Web Services, if any.</p>
345
385
  */
346
386
  awsAccountId?: string;
@@ -351,62 +391,77 @@ export interface UserIdentity {
351
391
  */
352
392
  export interface EventLogEntry {
353
393
  /**
394
+ * @public
354
395
  * <p>The system-generated unique ID of the event.</p>
355
396
  */
356
397
  id: string | undefined;
357
398
  /**
399
+ * @public
358
400
  * <p>The name of the event.</p>
359
401
  */
360
402
  eventName: string | undefined;
361
403
  /**
404
+ * @public
362
405
  * <p>The type of the event.</p>
363
406
  */
364
407
  eventType: string | undefined;
365
408
  /**
409
+ * @public
366
410
  * <p>The category for the event.</p>
367
411
  */
368
412
  eventCategory: string | undefined;
369
413
  /**
414
+ * @public
370
415
  * <p>The source of the event.</p>
371
416
  */
372
417
  eventSource: string | undefined;
373
418
  /**
419
+ * @public
374
420
  * <p>The time the event took place, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a>.</p>
375
421
  */
376
422
  eventTime: Date | undefined;
377
423
  /**
424
+ * @public
378
425
  * <p>The type of the event.</p>
379
426
  */
380
427
  operationType: OperationType | string | undefined;
381
428
  /**
429
+ * @public
382
430
  * <p>The system-generated unique ID of the user whose actions are recorded in the event.</p>
383
431
  */
384
432
  userIdentity: UserIdentity | undefined;
385
433
  /**
434
+ * @public
386
435
  * <p>Information about the project where the event occurred.</p>
387
436
  */
388
437
  projectInformation?: ProjectInformation;
389
438
  /**
439
+ * @public
390
440
  * <p>The system-generated unique ID of the request.</p>
391
441
  */
392
442
  requestId?: string;
393
443
  /**
444
+ * @public
394
445
  * <p>Information about the payload of the request.</p>
395
446
  */
396
447
  requestPayload?: EventPayload;
397
448
  /**
449
+ * @public
398
450
  * <p>Information about the payload of the response, if any.</p>
399
451
  */
400
452
  responsePayload?: EventPayload;
401
453
  /**
454
+ * @public
402
455
  * <p>The code of the error, if any.</p>
403
456
  */
404
457
  errorCode?: string;
405
458
  /**
459
+ * @public
406
460
  * <p>The IP address of the user whose actions are recorded in the event.</p>
407
461
  */
408
462
  sourceIpAddress?: string;
409
463
  /**
464
+ * @public
410
465
  * <p>The user agent whose actions are recorded in the event.</p>
411
466
  */
412
467
  userAgent?: string;
@@ -416,10 +471,12 @@ export interface EventLogEntry {
416
471
  */
417
472
  export interface ListEventLogsResponse {
418
473
  /**
474
+ * @public
419
475
  * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
420
476
  */
421
477
  nextToken?: string;
422
478
  /**
479
+ * @public
423
480
  * <p>Information about each event retrieved in the list.</p>
424
481
  */
425
482
  items: EventLogEntry[] | undefined;
@@ -429,6 +486,7 @@ export interface ListEventLogsResponse {
429
486
  */
430
487
  export interface GetSpaceRequest {
431
488
  /**
489
+ * @public
432
490
  * <p>The name of the space.</p>
433
491
  */
434
492
  name: string | undefined;
@@ -438,18 +496,22 @@ export interface GetSpaceRequest {
438
496
  */
439
497
  export interface GetSpaceResponse {
440
498
  /**
499
+ * @public
441
500
  * <p>The name of the space.</p>
442
501
  */
443
502
  name: string | undefined;
444
503
  /**
504
+ * @public
445
505
  * <p>The Amazon Web Services Region where the space exists.</p>
446
506
  */
447
507
  regionName: string | undefined;
448
508
  /**
509
+ * @public
449
510
  * <p>The friendly name of the space displayed to users.</p>
450
511
  */
451
512
  displayName?: string;
452
513
  /**
514
+ * @public
453
515
  * <p>The description of the space.</p>
454
516
  */
455
517
  description?: string;
@@ -459,6 +521,7 @@ export interface GetSpaceResponse {
459
521
  */
460
522
  export interface ListSpacesRequest {
461
523
  /**
524
+ * @public
462
525
  * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
463
526
  */
464
527
  nextToken?: string;
@@ -469,19 +532,23 @@ export interface ListSpacesRequest {
469
532
  */
470
533
  export interface SpaceSummary {
471
534
  /**
535
+ * @public
472
536
  * <p>The name of the space.</p>
473
537
  */
474
538
  name: string | undefined;
475
539
  /**
540
+ * @public
476
541
  * <p>The Amazon Web Services Region
477
542
  * where the space exists.</p>
478
543
  */
479
544
  regionName: string | undefined;
480
545
  /**
546
+ * @public
481
547
  * <p>The friendly name of the space displayed to users.</p>
482
548
  */
483
549
  displayName?: string;
484
550
  /**
551
+ * @public
485
552
  * <p>The description of the space.</p>
486
553
  */
487
554
  description?: string;
@@ -491,10 +558,12 @@ export interface SpaceSummary {
491
558
  */
492
559
  export interface ListSpacesResponse {
493
560
  /**
561
+ * @public
494
562
  * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
495
563
  */
496
564
  nextToken?: string;
497
565
  /**
566
+ * @public
498
567
  * <p>Information about the spaces. </p>
499
568
  */
500
569
  items?: SpaceSummary[];
@@ -504,14 +573,17 @@ export interface ListSpacesResponse {
504
573
  */
505
574
  export interface CreateProjectRequest {
506
575
  /**
576
+ * @public
507
577
  * <p>The name of the space.</p>
508
578
  */
509
579
  spaceName: string | undefined;
510
580
  /**
581
+ * @public
511
582
  * <p>The friendly name of the project that will be displayed to users.</p>
512
583
  */
513
584
  displayName: string | undefined;
514
585
  /**
586
+ * @public
515
587
  * <p>The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.</p>
516
588
  */
517
589
  description?: string;
@@ -521,18 +593,22 @@ export interface CreateProjectRequest {
521
593
  */
522
594
  export interface CreateProjectResponse {
523
595
  /**
596
+ * @public
524
597
  * <p>The name of the space.</p>
525
598
  */
526
599
  spaceName?: string;
527
600
  /**
601
+ * @public
528
602
  * <p>The name of the project in the space.</p>
529
603
  */
530
604
  name: string | undefined;
531
605
  /**
606
+ * @public
532
607
  * <p>The friendly name of the project.</p>
533
608
  */
534
609
  displayName?: string;
535
610
  /**
611
+ * @public
536
612
  * <p>The description of the project.</p>
537
613
  */
538
614
  description?: string;
@@ -542,10 +618,12 @@ export interface CreateProjectResponse {
542
618
  */
543
619
  export interface DeleteProjectRequest {
544
620
  /**
621
+ * @public
545
622
  * <p>The name of the space.</p>
546
623
  */
547
624
  spaceName: string | undefined;
548
625
  /**
626
+ * @public
549
627
  * <p>The name of the project in the space. To retrieve a list of project names, use <a>ListProjects</a>.</p>
550
628
  */
551
629
  name: string | undefined;
@@ -555,14 +633,17 @@ export interface DeleteProjectRequest {
555
633
  */
556
634
  export interface DeleteProjectResponse {
557
635
  /**
636
+ * @public
558
637
  * <p>The name of the space.</p>
559
638
  */
560
639
  spaceName: string | undefined;
561
640
  /**
641
+ * @public
562
642
  * <p>The name of the project in the space.</p>
563
643
  */
564
644
  name: string | undefined;
565
645
  /**
646
+ * @public
566
647
  * <p>The friendly name displayed to users of the project in Amazon CodeCatalyst.</p>
567
648
  */
568
649
  displayName?: string;
@@ -573,6 +654,7 @@ export interface DeleteProjectResponse {
573
654
  */
574
655
  export interface IdeConfiguration {
575
656
  /**
657
+ * @public
576
658
  * <p>A link to the IDE runtime image. </p>
577
659
  * <note>
578
660
  * <p>This parameter is not required for <code>VSCode</code>.</p>
@@ -580,6 +662,7 @@ export interface IdeConfiguration {
580
662
  */
581
663
  runtime?: string;
582
664
  /**
665
+ * @public
583
666
  * <p>The name of the IDE. Valid values include <code>Cloud9</code>, <code>IntelliJ</code>, <code>PyCharm</code>, <code>GoLand</code>, and <code>VSCode</code>.</p>
584
667
  */
585
668
  name?: string;
@@ -604,6 +687,7 @@ export type _InstanceType = (typeof _InstanceType)[keyof typeof _InstanceType];
604
687
  */
605
688
  export interface PersistentStorageConfiguration {
606
689
  /**
690
+ * @public
607
691
  * <p>The size of the persistent storage in gigabytes (specifically GiB).</p>
608
692
  * <note>
609
693
  * <p>Valid values for storage are based on memory sizes in 16GB increments. Valid values are
@@ -618,10 +702,12 @@ export interface PersistentStorageConfiguration {
618
702
  */
619
703
  export interface RepositoryInput {
620
704
  /**
705
+ * @public
621
706
  * <p>The name of the source repository.</p>
622
707
  */
623
708
  repositoryName: string | undefined;
624
709
  /**
710
+ * @public
625
711
  * <p>The name of the branch in a source repository.</p>
626
712
  */
627
713
  branchName?: string;
@@ -631,27 +717,33 @@ export interface RepositoryInput {
631
717
  */
632
718
  export interface CreateDevEnvironmentRequest {
633
719
  /**
720
+ * @public
634
721
  * <p>The name of the space.</p>
635
722
  */
636
723
  spaceName: string | undefined;
637
724
  /**
725
+ * @public
638
726
  * <p>The name of the project in the space.</p>
639
727
  */
640
728
  projectName: string | undefined;
641
729
  /**
730
+ * @public
642
731
  * <p>The source repository that contains the branch to clone into the Dev Environment. </p>
643
732
  */
644
733
  repositories?: RepositoryInput[];
645
734
  /**
735
+ * @public
646
736
  * <p>A user-specified idempotency token. Idempotency ensures that an API request completes only once.
647
737
  * With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.</p>
648
738
  */
649
739
  clientToken?: string;
650
740
  /**
741
+ * @public
651
742
  * <p>The user-defined alias for a Dev Environment.</p>
652
743
  */
653
744
  alias?: string;
654
745
  /**
746
+ * @public
655
747
  * <p>Information about the integrated development environment (IDE) configured for a
656
748
  * Dev Environment.</p>
657
749
  * <note>
@@ -661,14 +753,17 @@ export interface CreateDevEnvironmentRequest {
661
753
  */
662
754
  ides?: IdeConfiguration[];
663
755
  /**
756
+ * @public
664
757
  * <p>The Amazon EC2 instace type to use for the Dev Environment. </p>
665
758
  */
666
759
  instanceType: _InstanceType | string | undefined;
667
760
  /**
761
+ * @public
668
762
  * <p>The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.</p>
669
763
  */
670
764
  inactivityTimeoutMinutes?: number;
671
765
  /**
766
+ * @public
672
767
  * <p>Information about the amount of storage allocated to the Dev Environment. </p>
673
768
  * <note>
674
769
  * <p>By default, a Dev Environment is configured to have 16GB of persistent storage when created from the Amazon CodeCatalyst console, but there is no default when programmatically
@@ -684,14 +779,17 @@ export interface CreateDevEnvironmentRequest {
684
779
  */
685
780
  export interface CreateDevEnvironmentResponse {
686
781
  /**
782
+ * @public
687
783
  * <p>The name of the space.</p>
688
784
  */
689
785
  spaceName: string | undefined;
690
786
  /**
787
+ * @public
691
788
  * <p>The name of the project in the space.</p>
692
789
  */
693
790
  projectName: string | undefined;
694
791
  /**
792
+ * @public
695
793
  * <p>The system-generated unique ID of the Dev Environment. </p>
696
794
  */
697
795
  id: string | undefined;
@@ -701,14 +799,17 @@ export interface CreateDevEnvironmentResponse {
701
799
  */
702
800
  export interface DeleteDevEnvironmentRequest {
703
801
  /**
802
+ * @public
704
803
  * <p>The name of the space.</p>
705
804
  */
706
805
  spaceName: string | undefined;
707
806
  /**
807
+ * @public
708
808
  * <p>The name of the project in the space.</p>
709
809
  */
710
810
  projectName: string | undefined;
711
811
  /**
812
+ * @public
712
813
  * <p>The system-generated unique ID of the Dev Environment you want to delete. To retrieve a list of Dev Environment IDs, use <a>ListDevEnvironments</a>.</p>
713
814
  */
714
815
  id: string | undefined;
@@ -718,14 +819,17 @@ export interface DeleteDevEnvironmentRequest {
718
819
  */
719
820
  export interface DeleteDevEnvironmentResponse {
720
821
  /**
822
+ * @public
721
823
  * <p>The name of the space.</p>
722
824
  */
723
825
  spaceName: string | undefined;
724
826
  /**
827
+ * @public
725
828
  * <p>The name of the project in the space.</p>
726
829
  */
727
830
  projectName: string | undefined;
728
831
  /**
832
+ * @public
729
833
  * <p>The system-generated unique ID of the deleted Dev Environment. </p>
730
834
  */
731
835
  id: string | undefined;
@@ -735,14 +839,17 @@ export interface DeleteDevEnvironmentResponse {
735
839
  */
736
840
  export interface GetDevEnvironmentRequest {
737
841
  /**
842
+ * @public
738
843
  * <p>The name of the space.</p>
739
844
  */
740
845
  spaceName: string | undefined;
741
846
  /**
847
+ * @public
742
848
  * <p>The name of the project in the space.</p>
743
849
  */
744
850
  projectName: string | undefined;
745
851
  /**
852
+ * @public
746
853
  * <p>The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use <a>ListDevEnvironments</a>.</p>
747
854
  */
748
855
  id: string | undefined;
@@ -753,10 +860,12 @@ export interface GetDevEnvironmentRequest {
753
860
  */
754
861
  export interface Ide {
755
862
  /**
863
+ * @public
756
864
  * <p>A link to the IDE runtime image.</p>
757
865
  */
758
866
  runtime?: string;
759
867
  /**
868
+ * @public
760
869
  * <p>The name of the IDE.</p>
761
870
  */
762
871
  name?: string;
@@ -767,6 +876,7 @@ export interface Ide {
767
876
  */
768
877
  export interface PersistentStorage {
769
878
  /**
879
+ * @public
770
880
  * <p>The size of the persistent storage in gigabytes (specifically GiB).</p>
771
881
  * <note>
772
882
  * <p>Valid values for storage are based on memory sizes in 16GB increments. Valid values are
@@ -781,10 +891,12 @@ export interface PersistentStorage {
781
891
  */
782
892
  export interface DevEnvironmentRepositorySummary {
783
893
  /**
894
+ * @public
784
895
  * <p>The name of the source repository.</p>
785
896
  */
786
897
  repositoryName: string | undefined;
787
898
  /**
899
+ * @public
788
900
  * <p>The name of the branch in a source repository cloned into the Dev Environment. </p>
789
901
  */
790
902
  branchName?: string;
@@ -812,54 +924,67 @@ export type DevEnvironmentStatus = (typeof DevEnvironmentStatus)[keyof typeof De
812
924
  */
813
925
  export interface GetDevEnvironmentResponse {
814
926
  /**
927
+ * @public
815
928
  * <p>The name of the space.</p>
816
929
  */
817
930
  spaceName: string | undefined;
818
931
  /**
932
+ * @public
819
933
  * <p>The name of the project in the space.</p>
820
934
  */
821
935
  projectName: string | undefined;
822
936
  /**
937
+ * @public
823
938
  * <p>The system-generated unique ID of the Dev Environment. </p>
824
939
  */
825
940
  id: string | undefined;
826
941
  /**
942
+ * @public
827
943
  * <p>The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a>.</p>
828
944
  */
829
945
  lastUpdatedTime: Date | undefined;
830
946
  /**
947
+ * @public
831
948
  * <p>The system-generated unique ID of the user who created the Dev Environment. </p>
832
949
  */
833
950
  creatorId: string | undefined;
834
951
  /**
952
+ * @public
835
953
  * <p>The current status of the Dev Environment.</p>
836
954
  */
837
955
  status: DevEnvironmentStatus | string | undefined;
838
956
  /**
957
+ * @public
839
958
  * <p>The reason for the status.</p>
840
959
  */
841
960
  statusReason?: string;
842
961
  /**
962
+ * @public
843
963
  * <p>The source repository that contains the branch cloned into the Dev Environment. </p>
844
964
  */
845
965
  repositories: DevEnvironmentRepositorySummary[] | undefined;
846
966
  /**
967
+ * @public
847
968
  * <p>The user-specified alias for the Dev Environment. </p>
848
969
  */
849
970
  alias?: string;
850
971
  /**
972
+ * @public
851
973
  * <p>Information about the integrated development environment (IDE) configured for the Dev Environment. </p>
852
974
  */
853
975
  ides?: Ide[];
854
976
  /**
977
+ * @public
855
978
  * <p>The Amazon EC2 instace type to use for the Dev Environment. </p>
856
979
  */
857
980
  instanceType: _InstanceType | string | undefined;
858
981
  /**
982
+ * @public
859
983
  * <p>The amount of time the Dev Environment will run without any activity detected before stopping, in minutes.</p>
860
984
  */
861
985
  inactivityTimeoutMinutes: number | undefined;
862
986
  /**
987
+ * @public
863
988
  * <p>Information about the amount of storage allocated to the Dev Environment. By default, a Dev Environment is configured to have 16GB of persistent storage.</p>
864
989
  */
865
990
  persistentStorage: PersistentStorage | undefined;
@@ -870,14 +995,17 @@ export interface GetDevEnvironmentResponse {
870
995
  */
871
996
  export interface Filter {
872
997
  /**
998
+ * @public
873
999
  * <p>A key that can be used to sort results.</p>
874
1000
  */
875
1001
  key: string | undefined;
876
1002
  /**
1003
+ * @public
877
1004
  * <p>The values of the key.</p>
878
1005
  */
879
1006
  values: string[] | undefined;
880
1007
  /**
1008
+ * @public
881
1009
  * <p>The operator used to compare the fields.</p>
882
1010
  */
883
1011
  comparisonOperator?: string;
@@ -887,22 +1015,27 @@ export interface Filter {
887
1015
  */
888
1016
  export interface ListDevEnvironmentsRequest {
889
1017
  /**
1018
+ * @public
890
1019
  * <p>The name of the space.</p>
891
1020
  */
892
1021
  spaceName: string | undefined;
893
1022
  /**
1023
+ * @public
894
1024
  * <p>The name of the project in the space.</p>
895
1025
  */
896
1026
  projectName: string | undefined;
897
1027
  /**
1028
+ * @public
898
1029
  * <p>Information about filters to apply to narrow the results returned in the list.</p>
899
1030
  */
900
1031
  filters?: Filter[];
901
1032
  /**
1033
+ * @public
902
1034
  * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
903
1035
  */
904
1036
  nextToken?: string;
905
1037
  /**
1038
+ * @public
906
1039
  * <p>The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a <code>NextToken</code> element, which you can use to obtain additional results.</p>
907
1040
  */
908
1041
  maxResults?: number;
@@ -913,54 +1046,67 @@ export interface ListDevEnvironmentsRequest {
913
1046
  */
914
1047
  export interface DevEnvironmentSummary {
915
1048
  /**
1049
+ * @public
916
1050
  * <p>The name of the space.</p>
917
1051
  */
918
1052
  spaceName?: string;
919
1053
  /**
1054
+ * @public
920
1055
  * <p>The name of the project in the space.</p>
921
1056
  */
922
1057
  projectName?: string;
923
1058
  /**
1059
+ * @public
924
1060
  * <p>The system-generated unique ID for the Dev Environment. </p>
925
1061
  */
926
1062
  id: string | undefined;
927
1063
  /**
1064
+ * @public
928
1065
  * <p>The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a>.</p>
929
1066
  */
930
1067
  lastUpdatedTime: Date | undefined;
931
1068
  /**
1069
+ * @public
932
1070
  * <p>The system-generated unique ID of the user who created the Dev Environment. </p>
933
1071
  */
934
1072
  creatorId: string | undefined;
935
1073
  /**
1074
+ * @public
936
1075
  * <p>The status of the Dev Environment. </p>
937
1076
  */
938
1077
  status: DevEnvironmentStatus | string | undefined;
939
1078
  /**
1079
+ * @public
940
1080
  * <p>The reason for the status.</p>
941
1081
  */
942
1082
  statusReason?: string;
943
1083
  /**
1084
+ * @public
944
1085
  * <p>Information about the repositories that will be cloned into the Dev Environment. If no rvalue is specified, no repository is cloned.</p>
945
1086
  */
946
1087
  repositories: DevEnvironmentRepositorySummary[] | undefined;
947
1088
  /**
1089
+ * @public
948
1090
  * <p>The user-specified alias for the Dev Environment.</p>
949
1091
  */
950
1092
  alias?: string;
951
1093
  /**
1094
+ * @public
952
1095
  * <p>Information about the integrated development environment (IDE) configured for a Dev Environment.</p>
953
1096
  */
954
1097
  ides?: Ide[];
955
1098
  /**
1099
+ * @public
956
1100
  * <p>The Amazon EC2 instace type used for the Dev Environment. </p>
957
1101
  */
958
1102
  instanceType: _InstanceType | string | undefined;
959
1103
  /**
1104
+ * @public
960
1105
  * <p>The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Dev Environments consume compute minutes when running.</p>
961
1106
  */
962
1107
  inactivityTimeoutMinutes: number | undefined;
963
1108
  /**
1109
+ * @public
964
1110
  * <p>Information about the configuration of persistent storage for the Dev Environment.</p>
965
1111
  */
966
1112
  persistentStorage: PersistentStorage | undefined;
@@ -970,10 +1116,12 @@ export interface DevEnvironmentSummary {
970
1116
  */
971
1117
  export interface ListDevEnvironmentsResponse {
972
1118
  /**
1119
+ * @public
973
1120
  * <p>Information about the Dev Environments in a project.</p>
974
1121
  */
975
1122
  items: DevEnvironmentSummary[] | undefined;
976
1123
  /**
1124
+ * @public
977
1125
  * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
978
1126
  */
979
1127
  nextToken?: string;
@@ -983,22 +1131,27 @@ export interface ListDevEnvironmentsResponse {
983
1131
  */
984
1132
  export interface ListDevEnvironmentSessionsRequest {
985
1133
  /**
1134
+ * @public
986
1135
  * <p>The name of the space.</p>
987
1136
  */
988
1137
  spaceName: string | undefined;
989
1138
  /**
1139
+ * @public
990
1140
  * <p>The name of the project in the space.</p>
991
1141
  */
992
1142
  projectName: string | undefined;
993
1143
  /**
1144
+ * @public
994
1145
  * <p>The system-generated unique ID of the Dev Environment.</p>
995
1146
  */
996
1147
  devEnvironmentId: string | undefined;
997
1148
  /**
1149
+ * @public
998
1150
  * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
999
1151
  */
1000
1152
  nextToken?: string;
1001
1153
  /**
1154
+ * @public
1002
1155
  * <p>The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a <code>NextToken</code> element, which you can use to obtain additional results.</p>
1003
1156
  */
1004
1157
  maxResults?: number;
@@ -1009,23 +1162,28 @@ export interface ListDevEnvironmentSessionsRequest {
1009
1162
  */
1010
1163
  export interface DevEnvironmentSessionSummary {
1011
1164
  /**
1165
+ * @public
1012
1166
  * <p>The name of the space.</p>
1013
1167
  */
1014
1168
  spaceName: string | undefined;
1015
1169
  /**
1170
+ * @public
1016
1171
  * <p>The name of the project in the space.</p>
1017
1172
  */
1018
1173
  projectName: string | undefined;
1019
1174
  /**
1175
+ * @public
1020
1176
  * <p>The system-generated unique ID of the Dev Environment.</p>
1021
1177
  */
1022
1178
  devEnvironmentId: string | undefined;
1023
1179
  /**
1180
+ * @public
1024
1181
  * <p>The date and time the session started, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a>
1025
1182
  * </p>
1026
1183
  */
1027
1184
  startedTime: Date | undefined;
1028
1185
  /**
1186
+ * @public
1029
1187
  * <p>The system-generated unique ID of the Dev Environment session.</p>
1030
1188
  */
1031
1189
  id: string | undefined;
@@ -1035,10 +1193,12 @@ export interface DevEnvironmentSessionSummary {
1035
1193
  */
1036
1194
  export interface ListDevEnvironmentSessionsResponse {
1037
1195
  /**
1196
+ * @public
1038
1197
  * <p>Information about each session retrieved in the list.</p>
1039
1198
  */
1040
1199
  items: DevEnvironmentSessionSummary[] | undefined;
1041
1200
  /**
1201
+ * @public
1042
1202
  * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
1043
1203
  */
1044
1204
  nextToken?: string;
@@ -1048,26 +1208,32 @@ export interface ListDevEnvironmentSessionsResponse {
1048
1208
  */
1049
1209
  export interface StartDevEnvironmentRequest {
1050
1210
  /**
1211
+ * @public
1051
1212
  * <p>The name of the space.</p>
1052
1213
  */
1053
1214
  spaceName: string | undefined;
1054
1215
  /**
1216
+ * @public
1055
1217
  * <p>The name of the project in the space.</p>
1056
1218
  */
1057
1219
  projectName: string | undefined;
1058
1220
  /**
1221
+ * @public
1059
1222
  * <p>The system-generated unique ID of the Dev Environment. </p>
1060
1223
  */
1061
1224
  id: string | undefined;
1062
1225
  /**
1226
+ * @public
1063
1227
  * <p>Information about the integrated development environment (IDE) configured for a Dev Environment. </p>
1064
1228
  */
1065
1229
  ides?: IdeConfiguration[];
1066
1230
  /**
1231
+ * @public
1067
1232
  * <p>The Amazon EC2 instace type to use for the Dev Environment. </p>
1068
1233
  */
1069
1234
  instanceType?: _InstanceType | string;
1070
1235
  /**
1236
+ * @public
1071
1237
  * <p>The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.</p>
1072
1238
  */
1073
1239
  inactivityTimeoutMinutes?: number;
@@ -1077,18 +1243,22 @@ export interface StartDevEnvironmentRequest {
1077
1243
  */
1078
1244
  export interface StartDevEnvironmentResponse {
1079
1245
  /**
1246
+ * @public
1080
1247
  * <p>The name of the space.</p>
1081
1248
  */
1082
1249
  spaceName: string | undefined;
1083
1250
  /**
1251
+ * @public
1084
1252
  * <p>The name of the project in the space.</p>
1085
1253
  */
1086
1254
  projectName: string | undefined;
1087
1255
  /**
1256
+ * @public
1088
1257
  * <p>The system-generated unique ID of the Dev Environment. </p>
1089
1258
  */
1090
1259
  id: string | undefined;
1091
1260
  /**
1261
+ * @public
1092
1262
  * <p>The status of the Dev Environment. </p>
1093
1263
  */
1094
1264
  status: DevEnvironmentStatus | string | undefined;
@@ -1099,10 +1269,12 @@ export interface StartDevEnvironmentResponse {
1099
1269
  */
1100
1270
  export interface ExecuteCommandSessionConfiguration {
1101
1271
  /**
1272
+ * @public
1102
1273
  * <p>The command used at the beginning of the SSH session to a Dev Environment.</p>
1103
1274
  */
1104
1275
  command: string | undefined;
1105
1276
  /**
1277
+ * @public
1106
1278
  * <p>An array of arguments containing arguments and members.</p>
1107
1279
  */
1108
1280
  arguments?: string[];
@@ -1125,10 +1297,12 @@ export type DevEnvironmentSessionType = (typeof DevEnvironmentSessionType)[keyof
1125
1297
  */
1126
1298
  export interface DevEnvironmentSessionConfiguration {
1127
1299
  /**
1300
+ * @public
1128
1301
  * <p>The type of the session.</p>
1129
1302
  */
1130
1303
  sessionType: DevEnvironmentSessionType | string | undefined;
1131
1304
  /**
1305
+ * @public
1132
1306
  * <p>Information about optional commands that will be run on the Dev Environment when the SSH session begins.</p>
1133
1307
  */
1134
1308
  executeCommandSessionConfiguration?: ExecuteCommandSessionConfiguration;
@@ -1138,18 +1312,22 @@ export interface DevEnvironmentSessionConfiguration {
1138
1312
  */
1139
1313
  export interface StartDevEnvironmentSessionRequest {
1140
1314
  /**
1315
+ * @public
1141
1316
  * <p>The name of the space.</p>
1142
1317
  */
1143
1318
  spaceName: string | undefined;
1144
1319
  /**
1320
+ * @public
1145
1321
  * <p>The name of the project in the space.</p>
1146
1322
  */
1147
1323
  projectName: string | undefined;
1148
1324
  /**
1325
+ * @public
1149
1326
  * <p>The system-generated unique ID of the Dev Environment.</p>
1150
1327
  */
1151
1328
  id: string | undefined;
1152
1329
  /**
1330
+ * @public
1153
1331
  * <p>Information about the configuration of a Dev Environment session.</p>
1154
1332
  */
1155
1333
  sessionConfiguration: DevEnvironmentSessionConfiguration | undefined;
@@ -1160,10 +1338,12 @@ export interface StartDevEnvironmentSessionRequest {
1160
1338
  */
1161
1339
  export interface DevEnvironmentAccessDetails {
1162
1340
  /**
1341
+ * @public
1163
1342
  * <p>The URL used to send commands to and from the Dev Environment.</p>
1164
1343
  */
1165
1344
  streamUrl: string | undefined;
1166
1345
  /**
1346
+ * @public
1167
1347
  * <p>An encrypted token value that contains session and caller information used to authenticate the connection.</p>
1168
1348
  */
1169
1349
  tokenValue: string | undefined;
@@ -1173,22 +1353,27 @@ export interface DevEnvironmentAccessDetails {
1173
1353
  */
1174
1354
  export interface StartDevEnvironmentSessionResponse {
1175
1355
  /**
1356
+ * @public
1176
1357
  * <p>Information about connection details for a Dev Environment.</p>
1177
1358
  */
1178
1359
  accessDetails: DevEnvironmentAccessDetails | undefined;
1179
1360
  /**
1361
+ * @public
1180
1362
  * <p>The system-generated unique ID of the Dev Environment session.</p>
1181
1363
  */
1182
1364
  sessionId?: string;
1183
1365
  /**
1366
+ * @public
1184
1367
  * <p>The name of the space.</p>
1185
1368
  */
1186
1369
  spaceName: string | undefined;
1187
1370
  /**
1371
+ * @public
1188
1372
  * <p>The name of the project in the space.</p>
1189
1373
  */
1190
1374
  projectName: string | undefined;
1191
1375
  /**
1376
+ * @public
1192
1377
  * <p>The system-generated unique ID of the Dev Environment.</p>
1193
1378
  */
1194
1379
  id: string | undefined;
@@ -1198,14 +1383,17 @@ export interface StartDevEnvironmentSessionResponse {
1198
1383
  */
1199
1384
  export interface StopDevEnvironmentRequest {
1200
1385
  /**
1386
+ * @public
1201
1387
  * <p>The name of the space.</p>
1202
1388
  */
1203
1389
  spaceName: string | undefined;
1204
1390
  /**
1391
+ * @public
1205
1392
  * <p>The name of the project in the space.</p>
1206
1393
  */
1207
1394
  projectName: string | undefined;
1208
1395
  /**
1396
+ * @public
1209
1397
  * <p>The system-generated unique ID of the Dev Environment. </p>
1210
1398
  */
1211
1399
  id: string | undefined;
@@ -1215,18 +1403,22 @@ export interface StopDevEnvironmentRequest {
1215
1403
  */
1216
1404
  export interface StopDevEnvironmentResponse {
1217
1405
  /**
1406
+ * @public
1218
1407
  * <p>The name of the space.</p>
1219
1408
  */
1220
1409
  spaceName: string | undefined;
1221
1410
  /**
1411
+ * @public
1222
1412
  * <p>The name of the project in the space.</p>
1223
1413
  */
1224
1414
  projectName: string | undefined;
1225
1415
  /**
1416
+ * @public
1226
1417
  * <p>The system-generated unique ID of the Dev Environment. </p>
1227
1418
  */
1228
1419
  id: string | undefined;
1229
1420
  /**
1421
+ * @public
1230
1422
  * <p>The status of the Dev Environment. </p>
1231
1423
  */
1232
1424
  status: DevEnvironmentStatus | string | undefined;
@@ -1236,18 +1428,22 @@ export interface StopDevEnvironmentResponse {
1236
1428
  */
1237
1429
  export interface StopDevEnvironmentSessionRequest {
1238
1430
  /**
1431
+ * @public
1239
1432
  * <p>The name of the space.</p>
1240
1433
  */
1241
1434
  spaceName: string | undefined;
1242
1435
  /**
1436
+ * @public
1243
1437
  * <p>The name of the project in the space.</p>
1244
1438
  */
1245
1439
  projectName: string | undefined;
1246
1440
  /**
1441
+ * @public
1247
1442
  * <p>The system-generated unique ID of the Dev Environment. To obtain this ID, use <a>ListDevEnvironments</a>.</p>
1248
1443
  */
1249
1444
  id: string | undefined;
1250
1445
  /**
1446
+ * @public
1251
1447
  * <p>The system-generated unique ID of the Dev Environment session. This ID is returned by <a>StartDevEnvironmentSession</a>.</p>
1252
1448
  */
1253
1449
  sessionId: string | undefined;
@@ -1257,18 +1453,22 @@ export interface StopDevEnvironmentSessionRequest {
1257
1453
  */
1258
1454
  export interface StopDevEnvironmentSessionResponse {
1259
1455
  /**
1456
+ * @public
1260
1457
  * <p>The name of the space.</p>
1261
1458
  */
1262
1459
  spaceName: string | undefined;
1263
1460
  /**
1461
+ * @public
1264
1462
  * <p>The name of the project in the space.</p>
1265
1463
  */
1266
1464
  projectName: string | undefined;
1267
1465
  /**
1466
+ * @public
1268
1467
  * <p>The system-generated unique ID of the Dev Environment.</p>
1269
1468
  */
1270
1469
  id: string | undefined;
1271
1470
  /**
1471
+ * @public
1272
1472
  * <p>The system-generated unique ID of the Dev Environment session.</p>
1273
1473
  */
1274
1474
  sessionId: string | undefined;
@@ -1278,26 +1478,32 @@ export interface StopDevEnvironmentSessionResponse {
1278
1478
  */
1279
1479
  export interface UpdateDevEnvironmentRequest {
1280
1480
  /**
1481
+ * @public
1281
1482
  * <p>The name of the space.</p>
1282
1483
  */
1283
1484
  spaceName: string | undefined;
1284
1485
  /**
1486
+ * @public
1285
1487
  * <p>The name of the project in the space.</p>
1286
1488
  */
1287
1489
  projectName: string | undefined;
1288
1490
  /**
1491
+ * @public
1289
1492
  * <p>The system-generated unique ID of the Dev Environment. </p>
1290
1493
  */
1291
1494
  id: string | undefined;
1292
1495
  /**
1496
+ * @public
1293
1497
  * <p>The user-specified alias for the Dev Environment. Changing this value will not cause a restart.</p>
1294
1498
  */
1295
1499
  alias?: string;
1296
1500
  /**
1501
+ * @public
1297
1502
  * <p>Information about the integrated development environment (IDE) configured for a Dev Environment.</p>
1298
1503
  */
1299
1504
  ides?: IdeConfiguration[];
1300
1505
  /**
1506
+ * @public
1301
1507
  * <p>The Amazon EC2 instace type to use for the Dev Environment. </p>
1302
1508
  * <note>
1303
1509
  * <p>Changing this value will cause a restart of the Dev Environment if it is running.</p>
@@ -1305,6 +1511,7 @@ export interface UpdateDevEnvironmentRequest {
1305
1511
  */
1306
1512
  instanceType?: _InstanceType | string;
1307
1513
  /**
1514
+ * @public
1308
1515
  * <p>The amount of time the Dev Environment will run without any activity detected before stopping, in minutes.
1309
1516
  * Only whole integers are allowed. Dev Environments consume compute minutes when running.</p>
1310
1517
  * <note>
@@ -1313,6 +1520,7 @@ export interface UpdateDevEnvironmentRequest {
1313
1520
  */
1314
1521
  inactivityTimeoutMinutes?: number;
1315
1522
  /**
1523
+ * @public
1316
1524
  * <p>A user-specified idempotency token. Idempotency ensures that an API request completes only once.
1317
1525
  * With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.</p>
1318
1526
  */
@@ -1323,34 +1531,42 @@ export interface UpdateDevEnvironmentRequest {
1323
1531
  */
1324
1532
  export interface UpdateDevEnvironmentResponse {
1325
1533
  /**
1534
+ * @public
1326
1535
  * <p>The system-generated unique ID of the Dev Environment. </p>
1327
1536
  */
1328
1537
  id: string | undefined;
1329
1538
  /**
1539
+ * @public
1330
1540
  * <p>The name of the space.</p>
1331
1541
  */
1332
1542
  spaceName: string | undefined;
1333
1543
  /**
1544
+ * @public
1334
1545
  * <p>The name of the project in the space.</p>
1335
1546
  */
1336
1547
  projectName: string | undefined;
1337
1548
  /**
1549
+ * @public
1338
1550
  * <p>The user-specified alias for the Dev Environment.</p>
1339
1551
  */
1340
1552
  alias?: string;
1341
1553
  /**
1554
+ * @public
1342
1555
  * <p>Information about the integrated development environment (IDE) configured for the Dev Environment.</p>
1343
1556
  */
1344
1557
  ides?: IdeConfiguration[];
1345
1558
  /**
1559
+ * @public
1346
1560
  * <p>The Amazon EC2 instace type to use for the Dev Environment. </p>
1347
1561
  */
1348
1562
  instanceType?: _InstanceType | string;
1349
1563
  /**
1564
+ * @public
1350
1565
  * <p>The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. </p>
1351
1566
  */
1352
1567
  inactivityTimeoutMinutes?: number;
1353
1568
  /**
1569
+ * @public
1354
1570
  * <p>A user-specified idempotency token. Idempotency ensures that an API request completes only once.
1355
1571
  * With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.</p>
1356
1572
  */
@@ -1361,10 +1577,12 @@ export interface UpdateDevEnvironmentResponse {
1361
1577
  */
1362
1578
  export interface GetProjectRequest {
1363
1579
  /**
1580
+ * @public
1364
1581
  * <p>The name of the space.</p>
1365
1582
  */
1366
1583
  spaceName: string | undefined;
1367
1584
  /**
1585
+ * @public
1368
1586
  * <p>The name of the project in the space.</p>
1369
1587
  */
1370
1588
  name: string | undefined;
@@ -1374,18 +1592,22 @@ export interface GetProjectRequest {
1374
1592
  */
1375
1593
  export interface GetProjectResponse {
1376
1594
  /**
1595
+ * @public
1377
1596
  * <p>The name of the space.</p>
1378
1597
  */
1379
1598
  spaceName?: string;
1380
1599
  /**
1600
+ * @public
1381
1601
  * <p>The name of the project in the space.</p>
1382
1602
  */
1383
1603
  name: string | undefined;
1384
1604
  /**
1605
+ * @public
1385
1606
  * <p>The friendly name of the project displayed to users in Amazon CodeCatalyst.</p>
1386
1607
  */
1387
1608
  displayName?: string;
1388
1609
  /**
1610
+ * @public
1389
1611
  * <p>The description of the project.</p>
1390
1612
  */
1391
1613
  description?: string;
@@ -1422,14 +1644,17 @@ export type FilterKey = (typeof FilterKey)[keyof typeof FilterKey];
1422
1644
  */
1423
1645
  export interface ProjectListFilter {
1424
1646
  /**
1647
+ * @public
1425
1648
  * <p>A key that can be used to sort results.</p>
1426
1649
  */
1427
1650
  key: FilterKey | string | undefined;
1428
1651
  /**
1652
+ * @public
1429
1653
  * <p>The values of the key.</p>
1430
1654
  */
1431
1655
  values: string[] | undefined;
1432
1656
  /**
1657
+ * @public
1433
1658
  * <p>The operator used to compare the fields.</p>
1434
1659
  */
1435
1660
  comparisonOperator?: ComparisonOperator | string;
@@ -1439,18 +1664,22 @@ export interface ProjectListFilter {
1439
1664
  */
1440
1665
  export interface ListProjectsRequest {
1441
1666
  /**
1667
+ * @public
1442
1668
  * <p>The name of the space.</p>
1443
1669
  */
1444
1670
  spaceName: string | undefined;
1445
1671
  /**
1672
+ * @public
1446
1673
  * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
1447
1674
  */
1448
1675
  nextToken?: string;
1449
1676
  /**
1677
+ * @public
1450
1678
  * <p>The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a <code>NextToken</code> element, which you can use to obtain additional results.</p>
1451
1679
  */
1452
1680
  maxResults?: number;
1453
1681
  /**
1682
+ * @public
1454
1683
  * <p>Information about filters to apply to narrow the results returned in the list.</p>
1455
1684
  */
1456
1685
  filters?: ProjectListFilter[];
@@ -1461,14 +1690,17 @@ export interface ListProjectsRequest {
1461
1690
  */
1462
1691
  export interface ProjectSummary {
1463
1692
  /**
1693
+ * @public
1464
1694
  * <p>The name of the project in the space.</p>
1465
1695
  */
1466
1696
  name: string | undefined;
1467
1697
  /**
1698
+ * @public
1468
1699
  * <p>The friendly name displayed to users of the project in Amazon CodeCatalyst.</p>
1469
1700
  */
1470
1701
  displayName?: string;
1471
1702
  /**
1703
+ * @public
1472
1704
  * <p>The description of the project.</p>
1473
1705
  */
1474
1706
  description?: string;
@@ -1478,10 +1710,12 @@ export interface ProjectSummary {
1478
1710
  */
1479
1711
  export interface ListProjectsResponse {
1480
1712
  /**
1713
+ * @public
1481
1714
  * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
1482
1715
  */
1483
1716
  nextToken?: string;
1484
1717
  /**
1718
+ * @public
1485
1719
  * <p>Information about the projects.</p>
1486
1720
  */
1487
1721
  items?: ProjectSummary[];
@@ -1491,18 +1725,22 @@ export interface ListProjectsResponse {
1491
1725
  */
1492
1726
  export interface CreateSourceRepositoryRequest {
1493
1727
  /**
1728
+ * @public
1494
1729
  * <p>The name of the space.</p>
1495
1730
  */
1496
1731
  spaceName: string | undefined;
1497
1732
  /**
1733
+ * @public
1498
1734
  * <p>The name of the project in the space.</p>
1499
1735
  */
1500
1736
  projectName: string | undefined;
1501
1737
  /**
1738
+ * @public
1502
1739
  * <p>The name of the source repository. For more information about name requirements, see <a href="https://docs.aws.amazon.com/codecatalyst/latest/userguide/source-quotas.html">Quotas for source repositories</a>.</p>
1503
1740
  */
1504
1741
  name: string | undefined;
1505
1742
  /**
1743
+ * @public
1506
1744
  * <p>The description of the source repository.</p>
1507
1745
  */
1508
1746
  description?: string;
@@ -1512,18 +1750,22 @@ export interface CreateSourceRepositoryRequest {
1512
1750
  */
1513
1751
  export interface CreateSourceRepositoryResponse {
1514
1752
  /**
1753
+ * @public
1515
1754
  * <p>The name of the space.</p>
1516
1755
  */
1517
1756
  spaceName: string | undefined;
1518
1757
  /**
1758
+ * @public
1519
1759
  * <p>The name of the project in the space.</p>
1520
1760
  */
1521
1761
  projectName: string | undefined;
1522
1762
  /**
1763
+ * @public
1523
1764
  * <p>The name of the source repository.</p>
1524
1765
  */
1525
1766
  name: string | undefined;
1526
1767
  /**
1768
+ * @public
1527
1769
  * <p>The description of the source repository.</p>
1528
1770
  */
1529
1771
  description?: string;
@@ -1533,14 +1775,17 @@ export interface CreateSourceRepositoryResponse {
1533
1775
  */
1534
1776
  export interface DeleteSourceRepositoryRequest {
1535
1777
  /**
1778
+ * @public
1536
1779
  * <p>The name of the space.</p>
1537
1780
  */
1538
1781
  spaceName: string | undefined;
1539
1782
  /**
1783
+ * @public
1540
1784
  * <p>The name of the project in the space.</p>
1541
1785
  */
1542
1786
  projectName: string | undefined;
1543
1787
  /**
1788
+ * @public
1544
1789
  * <p>The name of the source repository.</p>
1545
1790
  */
1546
1791
  name: string | undefined;
@@ -1550,14 +1795,17 @@ export interface DeleteSourceRepositoryRequest {
1550
1795
  */
1551
1796
  export interface DeleteSourceRepositoryResponse {
1552
1797
  /**
1798
+ * @public
1553
1799
  * <p>The name of the space.</p>
1554
1800
  */
1555
1801
  spaceName: string | undefined;
1556
1802
  /**
1803
+ * @public
1557
1804
  * <p>The name of the project in the space.</p>
1558
1805
  */
1559
1806
  projectName: string | undefined;
1560
1807
  /**
1808
+ * @public
1561
1809
  * <p>The name of the repository.</p>
1562
1810
  */
1563
1811
  name: string | undefined;
@@ -1567,14 +1815,17 @@ export interface DeleteSourceRepositoryResponse {
1567
1815
  */
1568
1816
  export interface GetSourceRepositoryRequest {
1569
1817
  /**
1818
+ * @public
1570
1819
  * <p>The name of the space.</p>
1571
1820
  */
1572
1821
  spaceName: string | undefined;
1573
1822
  /**
1823
+ * @public
1574
1824
  * <p>The name of the project in the space.</p>
1575
1825
  */
1576
1826
  projectName: string | undefined;
1577
1827
  /**
1828
+ * @public
1578
1829
  * <p>The name of the source repository.</p>
1579
1830
  */
1580
1831
  name: string | undefined;
@@ -1584,26 +1835,32 @@ export interface GetSourceRepositoryRequest {
1584
1835
  */
1585
1836
  export interface GetSourceRepositoryResponse {
1586
1837
  /**
1838
+ * @public
1587
1839
  * <p>The name of the space.</p>
1588
1840
  */
1589
1841
  spaceName: string | undefined;
1590
1842
  /**
1843
+ * @public
1591
1844
  * <p>The name of the project in the space.</p>
1592
1845
  */
1593
1846
  projectName: string | undefined;
1594
1847
  /**
1848
+ * @public
1595
1849
  * <p>The name of the source repository.</p>
1596
1850
  */
1597
1851
  name: string | undefined;
1598
1852
  /**
1853
+ * @public
1599
1854
  * <p>The description of the source repository.</p>
1600
1855
  */
1601
1856
  description?: string;
1602
1857
  /**
1858
+ * @public
1603
1859
  * <p>The time the source repository was last updated, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a>.</p>
1604
1860
  */
1605
1861
  lastUpdatedTime: Date | undefined;
1606
1862
  /**
1863
+ * @public
1607
1864
  * <p>The time the source repository was created, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a>.</p>
1608
1865
  */
1609
1866
  createdTime: Date | undefined;
@@ -1613,14 +1870,17 @@ export interface GetSourceRepositoryResponse {
1613
1870
  */
1614
1871
  export interface GetSourceRepositoryCloneUrlsRequest {
1615
1872
  /**
1873
+ * @public
1616
1874
  * <p>The name of the space.</p>
1617
1875
  */
1618
1876
  spaceName: string | undefined;
1619
1877
  /**
1878
+ * @public
1620
1879
  * <p>The name of the project in the space.</p>
1621
1880
  */
1622
1881
  projectName: string | undefined;
1623
1882
  /**
1883
+ * @public
1624
1884
  * <p>The name of the source repository.</p>
1625
1885
  */
1626
1886
  sourceRepositoryName: string | undefined;
@@ -1630,6 +1890,7 @@ export interface GetSourceRepositoryCloneUrlsRequest {
1630
1890
  */
1631
1891
  export interface GetSourceRepositoryCloneUrlsResponse {
1632
1892
  /**
1893
+ * @public
1633
1894
  * <p>The HTTPS URL to use when cloning the source repository.</p>
1634
1895
  */
1635
1896
  https: string | undefined;
@@ -1639,18 +1900,22 @@ export interface GetSourceRepositoryCloneUrlsResponse {
1639
1900
  */
1640
1901
  export interface ListSourceRepositoriesRequest {
1641
1902
  /**
1903
+ * @public
1642
1904
  * <p>The name of the space.</p>
1643
1905
  */
1644
1906
  spaceName: string | undefined;
1645
1907
  /**
1908
+ * @public
1646
1909
  * <p>The name of the project in the space.</p>
1647
1910
  */
1648
1911
  projectName: string | undefined;
1649
1912
  /**
1913
+ * @public
1650
1914
  * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
1651
1915
  */
1652
1916
  nextToken?: string;
1653
1917
  /**
1918
+ * @public
1654
1919
  * <p>The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a <code>NextToken</code> element, which you can use to obtain additional results.</p>
1655
1920
  */
1656
1921
  maxResults?: number;
@@ -1661,22 +1926,27 @@ export interface ListSourceRepositoriesRequest {
1661
1926
  */
1662
1927
  export interface ListSourceRepositoriesItem {
1663
1928
  /**
1929
+ * @public
1664
1930
  * <p>The system-generated unique ID of the source repository.</p>
1665
1931
  */
1666
1932
  id: string | undefined;
1667
1933
  /**
1934
+ * @public
1668
1935
  * <p>The name of the source repository.</p>
1669
1936
  */
1670
1937
  name: string | undefined;
1671
1938
  /**
1939
+ * @public
1672
1940
  * <p>The description of the repository, if any.</p>
1673
1941
  */
1674
1942
  description?: string;
1675
1943
  /**
1944
+ * @public
1676
1945
  * <p>The time the source repository was last updated, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a>.</p>
1677
1946
  */
1678
1947
  lastUpdatedTime: Date | undefined;
1679
1948
  /**
1949
+ * @public
1680
1950
  * <p>The time the source repository was created, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a>.</p>
1681
1951
  */
1682
1952
  createdTime: Date | undefined;
@@ -1686,10 +1956,12 @@ export interface ListSourceRepositoriesItem {
1686
1956
  */
1687
1957
  export interface ListSourceRepositoriesResponse {
1688
1958
  /**
1959
+ * @public
1689
1960
  * <p>Information about the source repositories.</p>
1690
1961
  */
1691
1962
  items?: ListSourceRepositoriesItem[];
1692
1963
  /**
1964
+ * @public
1693
1965
  * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
1694
1966
  */
1695
1967
  nextToken?: string;
@@ -1699,22 +1971,27 @@ export interface ListSourceRepositoriesResponse {
1699
1971
  */
1700
1972
  export interface CreateSourceRepositoryBranchRequest {
1701
1973
  /**
1974
+ * @public
1702
1975
  * <p>The name of the space.</p>
1703
1976
  */
1704
1977
  spaceName: string | undefined;
1705
1978
  /**
1979
+ * @public
1706
1980
  * <p>The name of the project in the space.</p>
1707
1981
  */
1708
1982
  projectName: string | undefined;
1709
1983
  /**
1984
+ * @public
1710
1985
  * <p>The name of the repository where you want to create a branch.</p>
1711
1986
  */
1712
1987
  sourceRepositoryName: string | undefined;
1713
1988
  /**
1989
+ * @public
1714
1990
  * <p>The name for the branch you're creating.</p>
1715
1991
  */
1716
1992
  name: string | undefined;
1717
1993
  /**
1994
+ * @public
1718
1995
  * <p>The commit ID in an existing branch from which you want to create the new branch.</p>
1719
1996
  */
1720
1997
  headCommitId?: string;
@@ -1724,18 +2001,22 @@ export interface CreateSourceRepositoryBranchRequest {
1724
2001
  */
1725
2002
  export interface CreateSourceRepositoryBranchResponse {
1726
2003
  /**
2004
+ * @public
1727
2005
  * <p>The Git reference name of the branch.</p>
1728
2006
  */
1729
2007
  ref?: string;
1730
2008
  /**
2009
+ * @public
1731
2010
  * <p>The name of the newly created branch.</p>
1732
2011
  */
1733
2012
  name?: string;
1734
2013
  /**
2014
+ * @public
1735
2015
  * <p>The time the branch was last updated, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a>.</p>
1736
2016
  */
1737
2017
  lastUpdatedTime?: Date;
1738
2018
  /**
2019
+ * @public
1739
2020
  * <p>The commit ID of the tip of the newly created branch.</p>
1740
2021
  */
1741
2022
  headCommitId?: string;
@@ -1745,22 +2026,27 @@ export interface CreateSourceRepositoryBranchResponse {
1745
2026
  */
1746
2027
  export interface ListSourceRepositoryBranchesRequest {
1747
2028
  /**
2029
+ * @public
1748
2030
  * <p>The name of the space.</p>
1749
2031
  */
1750
2032
  spaceName: string | undefined;
1751
2033
  /**
2034
+ * @public
1752
2035
  * <p>The name of the project in the space.</p>
1753
2036
  */
1754
2037
  projectName: string | undefined;
1755
2038
  /**
2039
+ * @public
1756
2040
  * <p>The name of the source repository.</p>
1757
2041
  */
1758
2042
  sourceRepositoryName: string | undefined;
1759
2043
  /**
2044
+ * @public
1760
2045
  * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
1761
2046
  */
1762
2047
  nextToken?: string;
1763
2048
  /**
2049
+ * @public
1764
2050
  * <p>The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a <code>NextToken</code> element, which you can use to obtain additional results.</p>
1765
2051
  */
1766
2052
  maxResults?: number;
@@ -1771,18 +2057,22 @@ export interface ListSourceRepositoryBranchesRequest {
1771
2057
  */
1772
2058
  export interface ListSourceRepositoryBranchesItem {
1773
2059
  /**
2060
+ * @public
1774
2061
  * <p>The Git reference name of the branch.</p>
1775
2062
  */
1776
2063
  ref?: string;
1777
2064
  /**
2065
+ * @public
1778
2066
  * <p>The name of the branch.</p>
1779
2067
  */
1780
2068
  name?: string;
1781
2069
  /**
2070
+ * @public
1782
2071
  * <p>The time the branch was last updated, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a>.</p>
1783
2072
  */
1784
2073
  lastUpdatedTime?: Date;
1785
2074
  /**
2075
+ * @public
1786
2076
  * <p>The commit ID of the tip of the branch at the time of the request, also known as the head commit.</p>
1787
2077
  */
1788
2078
  headCommitId?: string;
@@ -1792,10 +2082,12 @@ export interface ListSourceRepositoryBranchesItem {
1792
2082
  */
1793
2083
  export interface ListSourceRepositoryBranchesResponse {
1794
2084
  /**
2085
+ * @public
1795
2086
  * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
1796
2087
  */
1797
2088
  nextToken?: string;
1798
2089
  /**
2090
+ * @public
1799
2091
  * <p>Information about the source branches.</p>
1800
2092
  */
1801
2093
  items: ListSourceRepositoryBranchesItem[] | undefined;
@@ -1805,14 +2097,17 @@ export interface ListSourceRepositoryBranchesResponse {
1805
2097
  */
1806
2098
  export interface UpdateProjectRequest {
1807
2099
  /**
2100
+ * @public
1808
2101
  * <p>The name of the space.</p>
1809
2102
  */
1810
2103
  spaceName: string | undefined;
1811
2104
  /**
2105
+ * @public
1812
2106
  * <p>The name of the project.</p>
1813
2107
  */
1814
2108
  name: string | undefined;
1815
2109
  /**
2110
+ * @public
1816
2111
  * <p>The description of the project.</p>
1817
2112
  */
1818
2113
  description?: string;
@@ -1822,18 +2117,22 @@ export interface UpdateProjectRequest {
1822
2117
  */
1823
2118
  export interface UpdateProjectResponse {
1824
2119
  /**
2120
+ * @public
1825
2121
  * <p>The name of the space.</p>
1826
2122
  */
1827
2123
  spaceName?: string;
1828
2124
  /**
2125
+ * @public
1829
2126
  * <p>The name of the project.</p>
1830
2127
  */
1831
2128
  name?: string;
1832
2129
  /**
2130
+ * @public
1833
2131
  * <p>The friendly name of the project displayed to users in Amazon CodeCatalyst.</p>
1834
2132
  */
1835
2133
  displayName?: string;
1836
2134
  /**
2135
+ * @public
1837
2136
  * <p>The description of the project.</p>
1838
2137
  */
1839
2138
  description?: string;
@@ -1843,6 +2142,7 @@ export interface UpdateProjectResponse {
1843
2142
  */
1844
2143
  export interface GetSubscriptionRequest {
1845
2144
  /**
2145
+ * @public
1846
2146
  * <p>The name of the space.</p>
1847
2147
  */
1848
2148
  spaceName: string | undefined;
@@ -1852,10 +2152,12 @@ export interface GetSubscriptionRequest {
1852
2152
  */
1853
2153
  export interface GetSubscriptionResponse {
1854
2154
  /**
2155
+ * @public
1855
2156
  * <p>The type of the billing plan for the space.</p>
1856
2157
  */
1857
2158
  subscriptionType?: string;
1858
2159
  /**
2160
+ * @public
1859
2161
  * <p>The display name of the Amazon Web Services account used for billing for the space.</p>
1860
2162
  */
1861
2163
  awsAccountName?: string;
@@ -1865,10 +2167,12 @@ export interface GetSubscriptionResponse {
1865
2167
  */
1866
2168
  export interface UpdateSpaceRequest {
1867
2169
  /**
2170
+ * @public
1868
2171
  * <p>The name of the space.</p>
1869
2172
  */
1870
2173
  name: string | undefined;
1871
2174
  /**
2175
+ * @public
1872
2176
  * <p>The description of the space.</p>
1873
2177
  */
1874
2178
  description?: string;
@@ -1878,14 +2182,17 @@ export interface UpdateSpaceRequest {
1878
2182
  */
1879
2183
  export interface UpdateSpaceResponse {
1880
2184
  /**
2185
+ * @public
1881
2186
  * <p>The name of the space.</p>
1882
2187
  */
1883
2188
  name?: string;
1884
2189
  /**
2190
+ * @public
1885
2191
  * <p>The friendly name of the space displayed to users in Amazon CodeCatalyst.</p>
1886
2192
  */
1887
2193
  displayName?: string;
1888
2194
  /**
2195
+ * @public
1889
2196
  * <p>The description of the space.</p>
1890
2197
  */
1891
2198
  description?: string;
@@ -1895,6 +2202,7 @@ export interface UpdateSpaceResponse {
1895
2202
  */
1896
2203
  export interface VerifySessionResponse {
1897
2204
  /**
2205
+ * @public
1898
2206
  * <p>The system-generated unique ID of the user in Amazon CodeCatalyst.</p>
1899
2207
  */
1900
2208
  identity?: string;