forked from awslabs/aws-sdk-kotlin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
codecatalyst.json
5722 lines (5722 loc) · 256 KB
/
codecatalyst.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"smithy": "2.0",
"shapes": {
"com.amazonaws.codecatalyst#AccessDeniedException": {
"type": "structure",
"members": {
"message": {
"target": "smithy.api#String",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 403
}
},
"com.amazonaws.codecatalyst#AccessToken": {
"type": "resource",
"identifiers": {
"accessTokenId": {
"target": "com.amazonaws.codecatalyst#AccessTokenId"
}
},
"create": {
"target": "com.amazonaws.codecatalyst#CreateAccessToken"
},
"delete": {
"target": "com.amazonaws.codecatalyst#DeleteAccessToken"
},
"list": {
"target": "com.amazonaws.codecatalyst#ListAccessTokens"
}
},
"com.amazonaws.codecatalyst#AccessTokenId": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 36
}
}
},
"com.amazonaws.codecatalyst#AccessTokenName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 100
}
}
},
"com.amazonaws.codecatalyst#AccessTokenSecret": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 4000
},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.codecatalyst#AccessTokenSummaries": {
"type": "list",
"member": {
"target": "com.amazonaws.codecatalyst#AccessTokenSummary"
}
},
"com.amazonaws.codecatalyst#AccessTokenSummary": {
"type": "structure",
"members": {
"id": {
"target": "com.amazonaws.codecatalyst#AccessTokenId",
"traits": {
"smithy.api#documentation": "<p>The system-generated ID of the personal access token.</p>",
"smithy.api#required": {},
"smithy.api#resourceIdentifier": "accessTokenId"
}
},
"name": {
"target": "com.amazonaws.codecatalyst#AccessTokenName",
"traits": {
"smithy.api#documentation": "<p>The friendly name of the personal access token.</p>",
"smithy.api#required": {}
}
},
"expiresTime": {
"target": "com.amazonaws.codecatalyst#Timestamp",
"traits": {
"smithy.api#documentation": "<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>",
"smithy.api#timestampFormat": "date-time"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about a specified personal access token (PAT).</p>"
}
},
"com.amazonaws.codecatalyst#ClientToken": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1024
}
}
},
"com.amazonaws.codecatalyst#CodeCatalyst": {
"type": "service",
"version": "2022-09-28",
"operations": [
{
"target": "com.amazonaws.codecatalyst#GetUserDetails"
},
{
"target": "com.amazonaws.codecatalyst#VerifySession"
}
],
"resources": [
{
"target": "com.amazonaws.codecatalyst#AccessToken"
},
{
"target": "com.amazonaws.codecatalyst#Space"
}
],
"errors": [
{
"target": "com.amazonaws.codecatalyst#AccessDeniedException"
},
{
"target": "com.amazonaws.codecatalyst#ConflictException"
},
{
"target": "com.amazonaws.codecatalyst#ResourceNotFoundException"
},
{
"target": "com.amazonaws.codecatalyst#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.codecatalyst#ThrottlingException"
},
{
"target": "com.amazonaws.codecatalyst#ValidationException"
}
],
"traits": {
"aws.api#service": {
"sdkId": "CodeCatalyst",
"endpointPrefix": "codecatalyst"
},
"aws.protocols#restJson1": {},
"smithy.api#documentation": "<p>Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst \n API to work with the following objects. </p>\n <p>Spaces, by calling the following:</p>\n <ul>\n <li>\n <p>\n <a>DeleteSpace</a>, which deletes a space.</p>\n </li>\n <li>\n <p>\n <a>GetSpace</a>, which returns information about a space.</p>\n </li>\n <li>\n <p>\n <a>GetSubscription</a>, which returns information about the Amazon Web Services account used for billing purposes \n and the billing plan for the space.</p>\n </li>\n <li>\n <p>\n <a>ListSpaces</a>, which retrieves a list of spaces.</p>\n </li>\n <li>\n <p>\n <a>UpdateSpace</a>, which changes one or more values for a space.</p>\n </li>\n </ul>\n <p>Projects, by calling the following:</p>\n <ul>\n <li>\n <p>\n <a>CreateProject</a> which creates a project in a specified space.</p>\n </li>\n <li>\n <p>\n <a>GetProject</a>, which returns information about a project.</p>\n </li>\n <li>\n <p>\n <a>ListProjects</a>, which retrieves a list of projects in a space.</p>\n </li>\n </ul>\n <p>Users, by calling the following:</p>\n <ul>\n <li>\n <p>\n <a>GetUserDetails</a>, which returns information about a user in Amazon CodeCatalyst.</p>\n </li>\n </ul>\n <p>Source repositories, by calling the following:</p>\n <ul>\n <li>\n <p>\n <a>CreateSourceRepository</a>, which creates an empty Git-based source repository in a specified project.</p>\n </li>\n <li>\n <p>\n <a>CreateSourceRepositoryBranch</a>, which creates a branch in a specified repository where you can work on code.</p>\n </li>\n <li>\n <p>\n <a>DeleteSourceRepository</a>, which deletes a source repository.</p>\n </li>\n <li>\n <p>\n <a>GetSourceRepository</a>, which returns information about a source repository.</p>\n </li>\n <li>\n <p>\n <a>GetSourceRepositoryCloneUrls</a>, which returns information about the URLs that can be used with a Git client to clone a source\n repository.</p>\n </li>\n <li>\n <p>\n <a>ListSourceRepositories</a>, which retrieves a list of source repositories in a project.</p>\n </li>\n <li>\n <p>\n <a>ListSourceRepositoryBranches</a>, which retrieves a list of branches in a source repository.</p>\n </li>\n </ul>\n <p>Dev Environments and the Amazon Web Services Toolkits, by calling the following:</p>\n <ul>\n <li>\n <p>\n <a>CreateDevEnvironment</a>, which creates a Dev Environment, \n where you can quickly work on the code stored in the source repositories of your project.</p>\n </li>\n <li>\n <p>\n <a>DeleteDevEnvironment</a>, which deletes a Dev Environment.</p>\n </li>\n <li>\n <p>\n <a>GetDevEnvironment</a>, which returns information about a Dev Environment.</p>\n </li>\n <li>\n <p>\n <a>ListDevEnvironments</a>, which retrieves a list of Dev Environments in a project.</p>\n </li>\n <li>\n <p>\n <a>ListDevEnvironmentSessions</a>, which retrieves a list of active Dev Environment sessions in a project.</p>\n </li>\n <li>\n <p>\n <a>StartDevEnvironment</a>, which starts a specified Dev Environment and puts it into an active state.</p>\n </li>\n <li>\n <p>\n <a>StartDevEnvironmentSession</a>, which starts a session to a specified Dev Environment.</p>\n </li>\n <li>\n <p>\n <a>StopDevEnvironment</a>, which stops a specified Dev Environment and puts it into an stopped state.</p>\n </li>\n <li>\n <p>\n <a>StopDevEnvironmentSession</a>, which stops a session for a specified Dev Environment.</p>\n </li>\n <li>\n <p>\n <a>UpdateDevEnvironment</a>, which changes one or more values for a Dev Environment.</p>\n </li>\n </ul>\n <p>Workflows, by calling the following:</p>\n <ul>\n <li>\n <p>\n <a>GetWorkflow</a>, which returns information about a workflow.</p>\n </li>\n <li>\n <p>\n <a>GetWorkflowRun</a>, which returns information about a specified run of a workflow.</p>\n </li>\n <li>\n <p>\n <a>ListWorkflowRuns</a>, which retrieves a list of runs of a specified workflow.</p>\n </li>\n <li>\n <p>\n <a>ListWorkflows</a>, which retrieves a list of workflows in a specified project.</p>\n </li>\n <li>\n <p>\n <a>StartWorkflowRun</a>, which starts a run of a specified workflow.</p>\n </li>\n </ul>\n <p>Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:</p>\n <ul>\n <li>\n <p>\n <a>CreateAccessToken</a>, which creates a personal access token (PAT) for the current user.</p>\n </li>\n <li>\n <p>\n <a>DeleteAccessToken</a>, which deletes a specified personal access token (PAT).</p>\n </li>\n <li>\n <p>\n <a>ListAccessTokens</a>, which lists all personal access tokens (PATs) associated with a user.</p>\n </li>\n <li>\n <p>\n <a>ListEventLogs</a>, which retrieves a list of events that occurred during a specified time period in a space.</p>\n </li>\n <li>\n <p>\n <a>VerifySession</a>, which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.</p>\n </li>\n </ul>\n <note>\n <p>If you are using the Amazon CodeCatalyst APIs with an SDK or the CLI, you must configure your computer to work with Amazon CodeCatalyst and single sign-on (SSO).\n For more information, see <a href=\"https://docs.aws.amazon.com/codecatalyst/latest/userguide/set-up-cli.html\">Setting up to use the CLI with Amazon CodeCatalyst</a>\n and the SSO documentation for your SDK.</p>\n </note>",
"smithy.api#httpBearerAuth": {},
"smithy.api#title": "Amazon CodeCatalyst",
"smithy.rules#endpointRuleSet": {
"version": "1.0",
"parameters": {
"UseFIPS": {
"builtIn": "AWS::UseFIPS",
"required": true,
"default": false,
"documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.",
"type": "Boolean"
},
"Region": {
"builtIn": "AWS::Region",
"required": false,
"documentation": "The AWS region used to dispatch the request.",
"type": "String"
},
"Endpoint": {
"builtIn": "SDK::Endpoint",
"required": false,
"documentation": "Override the endpoint used to send this request",
"type": "String"
}
},
"rules": [
{
"conditions": [
{
"fn": "isSet",
"argv": [
{
"ref": "Endpoint"
}
]
}
],
"endpoint": {
"url": {
"ref": "Endpoint"
},
"properties": {},
"headers": {}
},
"type": "endpoint"
},
{
"conditions": [
{
"fn": "not",
"argv": [
{
"fn": "isSet",
"argv": [
{
"ref": "Region"
}
]
}
]
},
{
"fn": "aws.partition",
"argv": [
"us-west-2"
],
"assign": "PartitionResult"
}
],
"rules": [
{
"conditions": [
{
"fn": "booleanEquals",
"argv": [
{
"ref": "UseFIPS"
},
true
]
}
],
"rules": [
{
"conditions": [
{
"fn": "booleanEquals",
"argv": [
{
"fn": "getAttr",
"argv": [
{
"ref": "PartitionResult"
},
"supportsFIPS"
]
},
false
]
}
],
"error": "Partition does not support FIPS.",
"type": "error"
},
{
"conditions": [],
"endpoint": {
"url": "https://codecatalyst-fips.global.{PartitionResult#dualStackDnsSuffix}",
"properties": {},
"headers": {}
},
"type": "endpoint"
}
],
"type": "tree"
},
{
"conditions": [],
"endpoint": {
"url": "https://codecatalyst.global.{PartitionResult#dualStackDnsSuffix}",
"properties": {},
"headers": {}
},
"type": "endpoint"
}
],
"type": "tree"
},
{
"conditions": [
{
"fn": "isSet",
"argv": [
{
"ref": "Region"
}
]
},
{
"fn": "aws.partition",
"argv": [
{
"ref": "Region"
}
],
"assign": "PartitionResult"
}
],
"rules": [
{
"conditions": [
{
"fn": "booleanEquals",
"argv": [
{
"ref": "UseFIPS"
},
true
]
}
],
"rules": [
{
"conditions": [
{
"fn": "booleanEquals",
"argv": [
{
"fn": "getAttr",
"argv": [
{
"ref": "PartitionResult"
},
"supportsFIPS"
]
},
false
]
}
],
"error": "Partition does not support FIPS.",
"type": "error"
},
{
"conditions": [],
"endpoint": {
"url": "https://codecatalyst-fips.global.{PartitionResult#dualStackDnsSuffix}",
"properties": {},
"headers": {}
},
"type": "endpoint"
}
],
"type": "tree"
},
{
"conditions": [],
"endpoint": {
"url": "https://codecatalyst.global.{PartitionResult#dualStackDnsSuffix}",
"properties": {},
"headers": {}
},
"type": "endpoint"
}
],
"type": "tree"
}
]
},
"smithy.rules#endpointTests": {
"version": "1",
"testCases": [
{
"documentation": "Override endpoint",
"expect": {
"endpoint": {
"url": "https://test.codecatalyst.global.api.aws"
}
},
"params": {
"Endpoint": "https://test.codecatalyst.global.api.aws"
}
},
{
"documentation": "Default endpoint (region not set)",
"expect": {
"endpoint": {
"url": "https://codecatalyst.global.api.aws"
}
},
"params": {}
},
{
"documentation": "Default FIPS endpoint (region not set)",
"expect": {
"endpoint": {
"url": "https://codecatalyst-fips.global.api.aws"
}
},
"params": {
"UseFIPS": true
}
},
{
"documentation": "Default endpoint (region: aws-global)",
"expect": {
"endpoint": {
"url": "https://codecatalyst.global.api.aws"
}
},
"params": {
"Region": "aws-global"
}
},
{
"documentation": "Default FIPS endpoint (region: aws-global)",
"expect": {
"endpoint": {
"url": "https://codecatalyst-fips.global.api.aws"
}
},
"params": {
"Region": "aws-global",
"UseFIPS": true
}
},
{
"documentation": "Default endpoint for a valid home region (region: us-west-2)",
"expect": {
"endpoint": {
"url": "https://codecatalyst.global.api.aws"
}
},
"params": {
"Region": "us-west-2"
}
},
{
"documentation": "Default FIPS endpoint for a valid home region (region: us-west-2)",
"expect": {
"endpoint": {
"url": "https://codecatalyst-fips.global.api.aws"
}
},
"params": {
"Region": "us-west-2",
"UseFIPS": true
}
},
{
"documentation": "Default endpoint for an unavailable home region (region: us-east-1)",
"expect": {
"endpoint": {
"url": "https://codecatalyst.global.api.aws"
}
},
"params": {
"Region": "us-east-1"
}
},
{
"documentation": "Default FIPS endpoint for an unavailable home region (region: us-east-1)",
"expect": {
"endpoint": {
"url": "https://codecatalyst-fips.global.api.aws"
}
},
"params": {
"Region": "us-east-1",
"UseFIPS": true
}
}
]
}
}
},
"com.amazonaws.codecatalyst#ComparisonOperator": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"name": "EQUALS",
"value": "EQ"
},
{
"name": "GREATER_THAN",
"value": "GT"
},
{
"name": "GREATER_THAN_OR_EQUALS",
"value": "GE"
},
{
"name": "LESS_THAN",
"value": "LT"
},
{
"name": "LESS_THAN_OR_EQUALS",
"value": "LE"
},
{
"name": "BEGINS_WITH",
"value": "BEGINS_WITH"
}
]
}
},
"com.amazonaws.codecatalyst#ConflictException": {
"type": "structure",
"members": {
"message": {
"target": "smithy.api#String",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. \n Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
},
"com.amazonaws.codecatalyst#CreateAccessToken": {
"type": "operation",
"input": {
"target": "com.amazonaws.codecatalyst#CreateAccessTokenRequest"
},
"output": {
"target": "com.amazonaws.codecatalyst#CreateAccessTokenResponse"
},
"traits": {
"smithy.api#documentation": "<p>Creates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password. \n It is associated with your user identity for use across all spaces and projects in Amazon CodeCatalyst. You use PATs to access CodeCatalyst \n from resources that include integrated development environments (IDEs) and Git-based source repositories. \n PATs represent you in Amazon CodeCatalyst and you can manage them in your user settings.For more information, see \n <a href=\"https://docs.aws.amazon.com/codecatalyst/latest/userguide/ipa-tokens-keys.html\">Managing personal access tokens in Amazon CodeCatalyst</a>.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v1/accessTokens",
"code": 201
}
}
},
"com.amazonaws.codecatalyst#CreateAccessTokenRequest": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.codecatalyst#AccessTokenName",
"traits": {
"smithy.api#documentation": "<p>The friendly name of the personal access token.</p>",
"smithy.api#required": {}
}
},
"expiresTime": {
"target": "com.amazonaws.codecatalyst#Timestamp",
"traits": {
"smithy.api#documentation": "<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>",
"smithy.api#timestampFormat": "date-time"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.codecatalyst#CreateAccessTokenResponse": {
"type": "structure",
"members": {
"secret": {
"target": "com.amazonaws.codecatalyst#AccessTokenSecret",
"traits": {
"smithy.api#documentation": "<p>The secret value of the personal access token.</p>",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.codecatalyst#AccessTokenName",
"traits": {
"smithy.api#documentation": "<p>The friendly name of the personal access token.</p>",
"smithy.api#required": {}
}
},
"expiresTime": {
"target": "com.amazonaws.codecatalyst#Timestamp",
"traits": {
"smithy.api#documentation": "<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>",
"smithy.api#required": {},
"smithy.api#timestampFormat": "date-time"
}
},
"accessTokenId": {
"target": "com.amazonaws.codecatalyst#AccessTokenId",
"traits": {
"smithy.api#documentation": "<p>The system-generated unique ID of the access token.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.codecatalyst#CreateDevEnvironment": {
"type": "operation",
"input": {
"target": "com.amazonaws.codecatalyst#CreateDevEnvironmentRequest"
},
"output": {
"target": "com.amazonaws.codecatalyst#CreateDevEnvironmentResponse"
},
"traits": {
"smithy.api#documentation": "<p>Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored \n in the source repositories of your project. </p>\n <note>\n <p>When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these\n defaults apply to a Dev Environment created programmatically.</p>\n </note>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments",
"code": 201
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.codecatalyst#CreateDevEnvironmentRequest": {
"type": "structure",
"members": {
"spaceName": {
"target": "com.amazonaws.codecatalyst#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the space.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"projectName": {
"target": "com.amazonaws.codecatalyst#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the project in the space.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"repositories": {
"target": "com.amazonaws.codecatalyst#RepositoriesInput",
"traits": {
"smithy.api#documentation": "<p>The source repository that contains the branch to clone into the Dev Environment. </p>"
}
},
"clientToken": {
"target": "com.amazonaws.codecatalyst#ClientToken",
"traits": {
"smithy.api#documentation": "<p>A user-specified idempotency token. Idempotency ensures that an API request completes only once. \n 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>"
}
},
"alias": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The user-defined alias for a Dev Environment.</p>",
"smithy.api#length": {
"min": 1,
"max": 128
},
"smithy.api#pattern": "^[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*$"
}
},
"ides": {
"target": "com.amazonaws.codecatalyst#IdeConfigurationList",
"traits": {
"smithy.api#documentation": "<p>Information about the integrated development environment (IDE) configured for a\n Dev Environment.</p>\n <note>\n <p>An IDE is required to create a Dev Environment. For Dev Environment creation, this field\n contains configuration information and must be provided. </p>\n </note>"
}
},
"instanceType": {
"target": "com.amazonaws.codecatalyst#InstanceType",
"traits": {
"smithy.api#documentation": "<p>The Amazon EC2 instace type to use for the Dev Environment. </p>",
"smithy.api#required": {}
}
},
"inactivityTimeoutMinutes": {
"target": "com.amazonaws.codecatalyst#InactivityTimeoutMinutes",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<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>"
}
},
"persistentStorage": {
"target": "com.amazonaws.codecatalyst#PersistentStorageConfiguration",
"traits": {
"smithy.api#documentation": "<p>Information about the amount of storage allocated to the Dev Environment. </p>\n <note>\n <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\n creating a Dev Environment. \n Valid values for persistent storage are based on memory sizes in 16GB increments. Valid\n values are 16, 32, and 64.</p>\n </note>",
"smithy.api#required": {}
}
},
"vpcConnectionName": {
"target": "com.amazonaws.codecatalyst#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the connection that will be used to connect to Amazon VPC, if any.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.codecatalyst#CreateDevEnvironmentResponse": {
"type": "structure",
"members": {
"spaceName": {
"target": "com.amazonaws.codecatalyst#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the space.</p>",
"smithy.api#required": {}
}
},
"projectName": {
"target": "com.amazonaws.codecatalyst#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the project in the space.</p>",
"smithy.api#required": {}
}
},
"id": {
"target": "com.amazonaws.codecatalyst#Uuid",
"traits": {
"smithy.api#documentation": "<p>The system-generated unique ID of the Dev Environment. </p>",
"smithy.api#required": {},
"smithy.api#resourceIdentifier": "devEnvironmentId"
}
},
"vpcConnectionName": {
"target": "com.amazonaws.codecatalyst#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.codecatalyst#CreateProject": {
"type": "operation",
"input": {
"target": "com.amazonaws.codecatalyst#CreateProjectRequest"
},
"output": {
"target": "com.amazonaws.codecatalyst#CreateProjectResponse"
},
"traits": {
"smithy.api#documentation": "<p>Creates a project in a specified space.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v1/spaces/{spaceName}/projects",
"code": 201
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.codecatalyst#CreateProjectRequest": {
"type": "structure",
"members": {
"spaceName": {
"target": "com.amazonaws.codecatalyst#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the space.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"displayName": {
"target": "com.amazonaws.codecatalyst#ProjectDisplayName",
"traits": {
"smithy.api#documentation": "<p>The friendly name of the project that will be displayed to users.</p>",
"smithy.api#required": {}
}
},
"description": {
"target": "com.amazonaws.codecatalyst#ProjectDescription",
"traits": {
"smithy.api#documentation": "<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>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.codecatalyst#CreateProjectResponse": {
"type": "structure",
"members": {
"spaceName": {
"target": "com.amazonaws.codecatalyst#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the space.</p>"
}
},
"name": {
"target": "com.amazonaws.codecatalyst#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the project in the space.</p>",
"smithy.api#required": {},
"smithy.api#resourceIdentifier": "projectName"
}
},
"displayName": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The friendly name of the project.</p>"
}
},
"description": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The description of the project.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.codecatalyst#CreateSourceRepository": {
"type": "operation",
"input": {
"target": "com.amazonaws.codecatalyst#CreateSourceRepositoryRequest"
},
"output": {
"target": "com.amazonaws.codecatalyst#CreateSourceRepositoryResponse"
},
"traits": {
"smithy.api#documentation": "<p>Creates an empty Git-based source repository in a specified project. The repository is\n created with an initial empty commit with a default branch named <code>main</code>.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v1/spaces/{spaceName}/projects/{projectName}/sourceRepositories/{name}",
"code": 201
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.codecatalyst#CreateSourceRepositoryBranch": {
"type": "operation",
"input": {
"target": "com.amazonaws.codecatalyst#CreateSourceRepositoryBranchRequest"
},
"output": {
"target": "com.amazonaws.codecatalyst#CreateSourceRepositoryBranchResponse"
},
"traits": {
"smithy.api#documentation": "<p>Creates a branch in a specified source repository in Amazon CodeCatalyst. </p>\n <note>\n <p>This API only creates a branch in a source repository hosted in Amazon CodeCatalyst. You cannot use this API to create a branch in a linked repository.</p>\n </note>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v1/spaces/{spaceName}/projects/{projectName}/sourceRepositories/{sourceRepositoryName}/branches/{name}",
"code": 201
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.codecatalyst#CreateSourceRepositoryBranchRequest": {
"type": "structure",
"members": {
"spaceName": {
"target": "com.amazonaws.codecatalyst#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the space.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"projectName": {
"target": "com.amazonaws.codecatalyst#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the project in the space.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"sourceRepositoryName": {
"target": "com.amazonaws.codecatalyst#SourceRepositoryNameString",
"traits": {
"smithy.api#documentation": "<p>The name of the repository where you want to create a branch.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.codecatalyst#SourceRepositoryBranchString",
"traits": {
"smithy.api#documentation": "<p>The name for the branch you're creating.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {},
"smithy.api#resourceIdentifier": "sourceRepositoryBranchName"
}
},
"headCommitId": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The commit ID in an existing branch from which you want to create the new branch.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.codecatalyst#CreateSourceRepositoryBranchResponse": {
"type": "structure",
"members": {
"ref": {
"target": "com.amazonaws.codecatalyst#SourceRepositoryBranchRefString",
"traits": {
"smithy.api#documentation": "<p>The Git reference name of the branch.</p>"
}
},
"name": {
"target": "com.amazonaws.codecatalyst#SourceRepositoryBranchString",
"traits": {
"smithy.api#documentation": "<p>The name of the newly created branch.</p>"
}
},
"lastUpdatedTime": {
"target": "com.amazonaws.codecatalyst#Timestamp",
"traits": {
"smithy.api#documentation": "<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>",
"smithy.api#timestampFormat": "date-time"
}
},
"headCommitId": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The commit ID of the tip of the newly created branch.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.codecatalyst#CreateSourceRepositoryRequest": {
"type": "structure",
"members": {
"spaceName": {
"target": "com.amazonaws.codecatalyst#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the space.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"projectName": {
"target": "com.amazonaws.codecatalyst#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the project in the space.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.codecatalyst#SourceRepositoryNameString",
"traits": {
"smithy.api#documentation": "<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>",
"smithy.api#httpLabel": {},
"smithy.api#required": {},
"smithy.api#resourceIdentifier": "sourceRepositoryName"
}
},
"description": {
"target": "com.amazonaws.codecatalyst#SourceRepositoryDescriptionString",
"traits": {
"smithy.api#documentation": "<p>The description of the source repository.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.codecatalyst#CreateSourceRepositoryResponse": {
"type": "structure",
"members": {
"spaceName": {
"target": "com.amazonaws.codecatalyst#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the space.</p>",
"smithy.api#required": {}
}
},
"projectName": {
"target": "com.amazonaws.codecatalyst#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the project in the space.</p>",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.codecatalyst#SourceRepositoryNameString",
"traits": {
"smithy.api#documentation": "<p>The name of the source repository.</p>",
"smithy.api#required": {}
}
},
"description": {
"target": "com.amazonaws.codecatalyst#SourceRepositoryDescriptionString",
"traits": {
"smithy.api#documentation": "<p>The description of the source repository.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.codecatalyst#DeleteAccessToken": {