@aws-sdk/client-codecatalyst 3.450.0 → 3.452.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.
Files changed (83) hide show
  1. package/README.md +64 -1
  2. package/dist-cjs/CodeCatalyst.js +10 -0
  3. package/dist-cjs/CodeCatalystClient.js +17 -4
  4. package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
  5. package/dist-cjs/auth/httpAuthSchemeProvider.js +39 -0
  6. package/dist-cjs/commands/GetWorkflowCommand.js +50 -0
  7. package/dist-cjs/commands/GetWorkflowRunCommand.js +50 -0
  8. package/dist-cjs/commands/ListWorkflowRunsCommand.js +50 -0
  9. package/dist-cjs/commands/ListWorkflowsCommand.js +50 -0
  10. package/dist-cjs/commands/StartWorkflowRunCommand.js +50 -0
  11. package/dist-cjs/commands/index.js +5 -0
  12. package/dist-cjs/models/models_0.js +25 -1
  13. package/dist-cjs/pagination/ListWorkflowRunsPaginator.js +29 -0
  14. package/dist-cjs/pagination/ListWorkflowsPaginator.js +29 -0
  15. package/dist-cjs/pagination/index.js +2 -0
  16. package/dist-cjs/protocols/Aws_restJson1.js +441 -5
  17. package/dist-cjs/runtimeConfig.browser.js +11 -0
  18. package/dist-cjs/runtimeConfig.js +10 -0
  19. package/dist-cjs/runtimeConfig.shared.js +10 -0
  20. package/dist-cjs/runtimeExtensions.js +3 -0
  21. package/dist-es/CodeCatalyst.js +10 -0
  22. package/dist-es/CodeCatalystClient.js +17 -4
  23. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  24. package/dist-es/auth/httpAuthSchemeProvider.js +33 -0
  25. package/dist-es/commands/GetWorkflowCommand.js +46 -0
  26. package/dist-es/commands/GetWorkflowRunCommand.js +46 -0
  27. package/dist-es/commands/ListWorkflowRunsCommand.js +46 -0
  28. package/dist-es/commands/ListWorkflowsCommand.js +46 -0
  29. package/dist-es/commands/StartWorkflowRunCommand.js +46 -0
  30. package/dist-es/commands/index.js +5 -0
  31. package/dist-es/models/models_0.js +24 -0
  32. package/dist-es/pagination/ListWorkflowRunsPaginator.js +25 -0
  33. package/dist-es/pagination/ListWorkflowsPaginator.js +25 -0
  34. package/dist-es/pagination/index.js +2 -0
  35. package/dist-es/protocols/Aws_restJson1.js +429 -3
  36. package/dist-es/runtimeConfig.browser.js +11 -0
  37. package/dist-es/runtimeConfig.js +10 -0
  38. package/dist-es/runtimeConfig.shared.js +10 -0
  39. package/dist-es/runtimeExtensions.js +3 -0
  40. package/dist-types/CodeCatalyst.d.ts +59 -1
  41. package/dist-types/CodeCatalystClient.d.ts +36 -6
  42. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  43. package/dist-types/auth/httpAuthSchemeProvider.d.ts +67 -0
  44. package/dist-types/commands/GetWorkflowCommand.d.ts +107 -0
  45. package/dist-types/commands/GetWorkflowRunCommand.d.ts +105 -0
  46. package/dist-types/commands/ListDevEnvironmentsCommand.d.ts +1 -1
  47. package/dist-types/commands/ListEventLogsCommand.d.ts +10 -1
  48. package/dist-types/commands/ListWorkflowRunsCommand.d.ts +114 -0
  49. package/dist-types/commands/ListWorkflowsCommand.d.ts +114 -0
  50. package/dist-types/commands/StartWorkflowRunCommand.d.ts +99 -0
  51. package/dist-types/commands/index.d.ts +5 -0
  52. package/dist-types/extensionConfiguration.d.ts +2 -1
  53. package/dist-types/index.d.ts +24 -1
  54. package/dist-types/models/models_0.d.ts +712 -222
  55. package/dist-types/pagination/ListWorkflowRunsPaginator.d.ts +7 -0
  56. package/dist-types/pagination/ListWorkflowsPaginator.d.ts +7 -0
  57. package/dist-types/pagination/index.d.ts +2 -0
  58. package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
  59. package/dist-types/runtimeConfig.browser.d.ts +3 -1
  60. package/dist-types/runtimeConfig.d.ts +3 -1
  61. package/dist-types/runtimeConfig.native.d.ts +3 -1
  62. package/dist-types/runtimeConfig.shared.d.ts +2 -0
  63. package/dist-types/ts3.4/CodeCatalyst.d.ts +85 -0
  64. package/dist-types/ts3.4/CodeCatalystClient.d.ts +38 -6
  65. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +27 -0
  66. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +40 -0
  67. package/dist-types/ts3.4/commands/GetWorkflowCommand.d.ts +35 -0
  68. package/dist-types/ts3.4/commands/GetWorkflowRunCommand.d.ts +38 -0
  69. package/dist-types/ts3.4/commands/ListWorkflowRunsCommand.d.ts +38 -0
  70. package/dist-types/ts3.4/commands/ListWorkflowsCommand.d.ts +38 -0
  71. package/dist-types/ts3.4/commands/StartWorkflowRunCommand.d.ts +38 -0
  72. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  73. package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -1
  74. package/dist-types/ts3.4/models/models_0.d.ts +190 -61
  75. package/dist-types/ts3.4/pagination/ListWorkflowRunsPaginator.d.ts +11 -0
  76. package/dist-types/ts3.4/pagination/ListWorkflowsPaginator.d.ts +11 -0
  77. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  78. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
  79. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +5 -3
  80. package/dist-types/ts3.4/runtimeConfig.d.ts +5 -3
  81. package/dist-types/ts3.4/runtimeConfig.native.d.ts +5 -3
  82. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -0
  83. package/package.json +38 -34
@@ -516,6 +516,222 @@ export interface GetSpaceResponse {
516
516
  */
517
517
  description?: string;
518
518
  }
519
+ /**
520
+ * @public
521
+ * <p>Information about a filter used to limit results of a query.</p>
522
+ */
523
+ export interface Filter {
524
+ /**
525
+ * @public
526
+ * <p>A key that can be used to sort results.</p>
527
+ */
528
+ key: string | undefined;
529
+ /**
530
+ * @public
531
+ * <p>The values of the key.</p>
532
+ */
533
+ values: string[] | undefined;
534
+ /**
535
+ * @public
536
+ * <p>The operator used to compare the fields.</p>
537
+ */
538
+ comparisonOperator?: string;
539
+ }
540
+ /**
541
+ * @public
542
+ */
543
+ export interface ListDevEnvironmentsRequest {
544
+ /**
545
+ * @public
546
+ * <p>The name of the space.</p>
547
+ */
548
+ spaceName: string | undefined;
549
+ /**
550
+ * @public
551
+ * <p>The name of the project in the space.</p>
552
+ */
553
+ projectName?: string;
554
+ /**
555
+ * @public
556
+ * <p>Information about filters to apply to narrow the results returned in the list.</p>
557
+ */
558
+ filters?: Filter[];
559
+ /**
560
+ * @public
561
+ * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
562
+ */
563
+ nextToken?: string;
564
+ /**
565
+ * @public
566
+ * <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>
567
+ */
568
+ maxResults?: number;
569
+ }
570
+ /**
571
+ * @public
572
+ * <p>Information about an integrated development environment (IDE) used in a Dev Environment.</p>
573
+ */
574
+ export interface Ide {
575
+ /**
576
+ * @public
577
+ * <p>A link to the IDE runtime image.</p>
578
+ */
579
+ runtime?: string;
580
+ /**
581
+ * @public
582
+ * <p>The name of the IDE.</p>
583
+ */
584
+ name?: string;
585
+ }
586
+ /**
587
+ * @public
588
+ * @enum
589
+ */
590
+ export declare const _InstanceType: {
591
+ readonly DEV_STANDARD1_LARGE: "dev.standard1.large";
592
+ readonly DEV_STANDARD1_MEDIUM: "dev.standard1.medium";
593
+ readonly DEV_STANDARD1_SMALL: "dev.standard1.small";
594
+ readonly DEV_STANDARD1_XLARGE: "dev.standard1.xlarge";
595
+ };
596
+ /**
597
+ * @public
598
+ */
599
+ export type _InstanceType = (typeof _InstanceType)[keyof typeof _InstanceType];
600
+ /**
601
+ * @public
602
+ * <p>Information about the persistent storage for a Dev Environment.</p>
603
+ */
604
+ export interface PersistentStorage {
605
+ /**
606
+ * @public
607
+ * <p>The size of the persistent storage in gigabytes (specifically GiB).</p>
608
+ * <note>
609
+ * <p>Valid values for storage are based on memory sizes in 16GB increments. Valid values are
610
+ * 16, 32, and 64.</p>
611
+ * </note>
612
+ */
613
+ sizeInGiB: number | undefined;
614
+ }
615
+ /**
616
+ * @public
617
+ * <p>Information about the source repsitory for a Dev Environment. </p>
618
+ */
619
+ export interface DevEnvironmentRepositorySummary {
620
+ /**
621
+ * @public
622
+ * <p>The name of the source repository.</p>
623
+ */
624
+ repositoryName: string | undefined;
625
+ /**
626
+ * @public
627
+ * <p>The name of the branch in a source repository cloned into the Dev Environment. </p>
628
+ */
629
+ branchName?: string;
630
+ }
631
+ /**
632
+ * @public
633
+ * @enum
634
+ */
635
+ export declare const DevEnvironmentStatus: {
636
+ readonly DELETED: "DELETED";
637
+ readonly DELETING: "DELETING";
638
+ readonly FAILED: "FAILED";
639
+ readonly PENDING: "PENDING";
640
+ readonly RUNNING: "RUNNING";
641
+ readonly STARTING: "STARTING";
642
+ readonly STOPPED: "STOPPED";
643
+ readonly STOPPING: "STOPPING";
644
+ };
645
+ /**
646
+ * @public
647
+ */
648
+ export type DevEnvironmentStatus = (typeof DevEnvironmentStatus)[keyof typeof DevEnvironmentStatus];
649
+ /**
650
+ * @public
651
+ * <p>Information about a Dev Environment. </p>
652
+ */
653
+ export interface DevEnvironmentSummary {
654
+ /**
655
+ * @public
656
+ * <p>The name of the space.</p>
657
+ */
658
+ spaceName?: string;
659
+ /**
660
+ * @public
661
+ * <p>The name of the project in the space.</p>
662
+ */
663
+ projectName?: string;
664
+ /**
665
+ * @public
666
+ * <p>The system-generated unique ID for the Dev Environment. </p>
667
+ */
668
+ id: string | undefined;
669
+ /**
670
+ * @public
671
+ * <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>
672
+ */
673
+ lastUpdatedTime: Date | undefined;
674
+ /**
675
+ * @public
676
+ * <p>The system-generated unique ID of the user who created the Dev Environment. </p>
677
+ */
678
+ creatorId: string | undefined;
679
+ /**
680
+ * @public
681
+ * <p>The status of the Dev Environment. </p>
682
+ */
683
+ status: DevEnvironmentStatus | undefined;
684
+ /**
685
+ * @public
686
+ * <p>The reason for the status.</p>
687
+ */
688
+ statusReason?: string;
689
+ /**
690
+ * @public
691
+ * <p>Information about the repositories that will be cloned into the Dev Environment. If no rvalue is specified, no repository is cloned.</p>
692
+ */
693
+ repositories: DevEnvironmentRepositorySummary[] | undefined;
694
+ /**
695
+ * @public
696
+ * <p>The user-specified alias for the Dev Environment.</p>
697
+ */
698
+ alias?: string;
699
+ /**
700
+ * @public
701
+ * <p>Information about the integrated development environment (IDE) configured for a Dev Environment.</p>
702
+ */
703
+ ides?: Ide[];
704
+ /**
705
+ * @public
706
+ * <p>The Amazon EC2 instace type used for the Dev Environment. </p>
707
+ */
708
+ instanceType: _InstanceType | undefined;
709
+ /**
710
+ * @public
711
+ * <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>
712
+ */
713
+ inactivityTimeoutMinutes: number | undefined;
714
+ /**
715
+ * @public
716
+ * <p>Information about the configuration of persistent storage for the Dev Environment.</p>
717
+ */
718
+ persistentStorage: PersistentStorage | undefined;
719
+ }
720
+ /**
721
+ * @public
722
+ */
723
+ export interface ListDevEnvironmentsResponse {
724
+ /**
725
+ * @public
726
+ * <p>Information about the Dev Environments in a project.</p>
727
+ */
728
+ items: DevEnvironmentSummary[] | undefined;
729
+ /**
730
+ * @public
731
+ * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
732
+ */
733
+ nextToken?: string;
734
+ }
519
735
  /**
520
736
  * @public
521
737
  */
@@ -667,20 +883,6 @@ export interface IdeConfiguration {
667
883
  */
668
884
  name?: string;
669
885
  }
670
- /**
671
- * @public
672
- * @enum
673
- */
674
- export declare const _InstanceType: {
675
- readonly DEV_STANDARD1_LARGE: "dev.standard1.large";
676
- readonly DEV_STANDARD1_MEDIUM: "dev.standard1.medium";
677
- readonly DEV_STANDARD1_SMALL: "dev.standard1.small";
678
- readonly DEV_STANDARD1_XLARGE: "dev.standard1.xlarge";
679
- };
680
- /**
681
- * @public
682
- */
683
- export type _InstanceType = (typeof _InstanceType)[keyof typeof _InstanceType];
684
886
  /**
685
887
  * @public
686
888
  * <p>Information about the configuration of persistent storage for a Dev Environment. </p>
@@ -856,86 +1058,21 @@ export interface GetDevEnvironmentRequest {
856
1058
  }
857
1059
  /**
858
1060
  * @public
859
- * <p>Information about an integrated development environment (IDE) used in a Dev Environment.</p>
860
1061
  */
861
- export interface Ide {
1062
+ export interface GetDevEnvironmentResponse {
862
1063
  /**
863
1064
  * @public
864
- * <p>A link to the IDE runtime image.</p>
1065
+ * <p>The name of the space.</p>
865
1066
  */
866
- runtime?: string;
1067
+ spaceName: string | undefined;
867
1068
  /**
868
1069
  * @public
869
- * <p>The name of the IDE.</p>
1070
+ * <p>The name of the project in the space.</p>
870
1071
  */
871
- name?: string;
872
- }
873
- /**
874
- * @public
875
- * <p>Information about the persistent storage for a Dev Environment.</p>
876
- */
877
- export interface PersistentStorage {
1072
+ projectName: string | undefined;
878
1073
  /**
879
1074
  * @public
880
- * <p>The size of the persistent storage in gigabytes (specifically GiB).</p>
881
- * <note>
882
- * <p>Valid values for storage are based on memory sizes in 16GB increments. Valid values are
883
- * 16, 32, and 64.</p>
884
- * </note>
885
- */
886
- sizeInGiB: number | undefined;
887
- }
888
- /**
889
- * @public
890
- * <p>Information about the source repsitory for a Dev Environment. </p>
891
- */
892
- export interface DevEnvironmentRepositorySummary {
893
- /**
894
- * @public
895
- * <p>The name of the source repository.</p>
896
- */
897
- repositoryName: string | undefined;
898
- /**
899
- * @public
900
- * <p>The name of the branch in a source repository cloned into the Dev Environment. </p>
901
- */
902
- branchName?: string;
903
- }
904
- /**
905
- * @public
906
- * @enum
907
- */
908
- export declare const DevEnvironmentStatus: {
909
- readonly DELETED: "DELETED";
910
- readonly DELETING: "DELETING";
911
- readonly FAILED: "FAILED";
912
- readonly PENDING: "PENDING";
913
- readonly RUNNING: "RUNNING";
914
- readonly STARTING: "STARTING";
915
- readonly STOPPED: "STOPPED";
916
- readonly STOPPING: "STOPPING";
917
- };
918
- /**
919
- * @public
920
- */
921
- export type DevEnvironmentStatus = (typeof DevEnvironmentStatus)[keyof typeof DevEnvironmentStatus];
922
- /**
923
- * @public
924
- */
925
- export interface GetDevEnvironmentResponse {
926
- /**
927
- * @public
928
- * <p>The name of the space.</p>
929
- */
930
- spaceName: string | undefined;
931
- /**
932
- * @public
933
- * <p>The name of the project in the space.</p>
934
- */
935
- projectName: string | undefined;
936
- /**
937
- * @public
938
- * <p>The system-generated unique ID of the Dev Environment. </p>
1075
+ * <p>The system-generated unique ID of the Dev Environment. </p>
939
1076
  */
940
1077
  id: string | undefined;
941
1078
  /**
@@ -989,143 +1126,6 @@ export interface GetDevEnvironmentResponse {
989
1126
  */
990
1127
  persistentStorage: PersistentStorage | undefined;
991
1128
  }
992
- /**
993
- * @public
994
- * <p>Information about a filter used to limit results of a query.</p>
995
- */
996
- export interface Filter {
997
- /**
998
- * @public
999
- * <p>A key that can be used to sort results.</p>
1000
- */
1001
- key: string | undefined;
1002
- /**
1003
- * @public
1004
- * <p>The values of the key.</p>
1005
- */
1006
- values: string[] | undefined;
1007
- /**
1008
- * @public
1009
- * <p>The operator used to compare the fields.</p>
1010
- */
1011
- comparisonOperator?: string;
1012
- }
1013
- /**
1014
- * @public
1015
- */
1016
- export interface ListDevEnvironmentsRequest {
1017
- /**
1018
- * @public
1019
- * <p>The name of the space.</p>
1020
- */
1021
- spaceName: string | undefined;
1022
- /**
1023
- * @public
1024
- * <p>The name of the project in the space.</p>
1025
- */
1026
- projectName: string | undefined;
1027
- /**
1028
- * @public
1029
- * <p>Information about filters to apply to narrow the results returned in the list.</p>
1030
- */
1031
- filters?: Filter[];
1032
- /**
1033
- * @public
1034
- * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
1035
- */
1036
- nextToken?: string;
1037
- /**
1038
- * @public
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>
1040
- */
1041
- maxResults?: number;
1042
- }
1043
- /**
1044
- * @public
1045
- * <p>Information about a Dev Environment. </p>
1046
- */
1047
- export interface DevEnvironmentSummary {
1048
- /**
1049
- * @public
1050
- * <p>The name of the space.</p>
1051
- */
1052
- spaceName?: string;
1053
- /**
1054
- * @public
1055
- * <p>The name of the project in the space.</p>
1056
- */
1057
- projectName?: string;
1058
- /**
1059
- * @public
1060
- * <p>The system-generated unique ID for the Dev Environment. </p>
1061
- */
1062
- id: string | undefined;
1063
- /**
1064
- * @public
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>
1066
- */
1067
- lastUpdatedTime: Date | undefined;
1068
- /**
1069
- * @public
1070
- * <p>The system-generated unique ID of the user who created the Dev Environment. </p>
1071
- */
1072
- creatorId: string | undefined;
1073
- /**
1074
- * @public
1075
- * <p>The status of the Dev Environment. </p>
1076
- */
1077
- status: DevEnvironmentStatus | undefined;
1078
- /**
1079
- * @public
1080
- * <p>The reason for the status.</p>
1081
- */
1082
- statusReason?: string;
1083
- /**
1084
- * @public
1085
- * <p>Information about the repositories that will be cloned into the Dev Environment. If no rvalue is specified, no repository is cloned.</p>
1086
- */
1087
- repositories: DevEnvironmentRepositorySummary[] | undefined;
1088
- /**
1089
- * @public
1090
- * <p>The user-specified alias for the Dev Environment.</p>
1091
- */
1092
- alias?: string;
1093
- /**
1094
- * @public
1095
- * <p>Information about the integrated development environment (IDE) configured for a Dev Environment.</p>
1096
- */
1097
- ides?: Ide[];
1098
- /**
1099
- * @public
1100
- * <p>The Amazon EC2 instace type used for the Dev Environment. </p>
1101
- */
1102
- instanceType: _InstanceType | undefined;
1103
- /**
1104
- * @public
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>
1106
- */
1107
- inactivityTimeoutMinutes: number | undefined;
1108
- /**
1109
- * @public
1110
- * <p>Information about the configuration of persistent storage for the Dev Environment.</p>
1111
- */
1112
- persistentStorage: PersistentStorage | undefined;
1113
- }
1114
- /**
1115
- * @public
1116
- */
1117
- export interface ListDevEnvironmentsResponse {
1118
- /**
1119
- * @public
1120
- * <p>Information about the Dev Environments in a project.</p>
1121
- */
1122
- items: DevEnvironmentSummary[] | undefined;
1123
- /**
1124
- * @public
1125
- * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
1126
- */
1127
- nextToken?: string;
1128
- }
1129
1129
  /**
1130
1130
  * @public
1131
1131
  */
@@ -1617,6 +1617,7 @@ export interface GetProjectResponse {
1617
1617
  * @enum
1618
1618
  */
1619
1619
  export declare const ComparisonOperator: {
1620
+ readonly BEGINS_WITH: "BEGINS_WITH";
1620
1621
  readonly EQUALS: "EQ";
1621
1622
  readonly GREATER_THAN: "GT";
1622
1623
  readonly GREATER_THAN_OR_EQUALS: "GE";
@@ -1633,6 +1634,7 @@ export type ComparisonOperator = (typeof ComparisonOperator)[keyof typeof Compar
1633
1634
  */
1634
1635
  export declare const FilterKey: {
1635
1636
  readonly HAS_ACCESS_TO: "hasAccessTo";
1637
+ readonly NAME: "name";
1636
1638
  };
1637
1639
  /**
1638
1640
  * @public
@@ -2137,6 +2139,494 @@ export interface UpdateProjectResponse {
2137
2139
  */
2138
2140
  description?: string;
2139
2141
  }
2142
+ /**
2143
+ * @public
2144
+ */
2145
+ export interface GetWorkflowRequest {
2146
+ /**
2147
+ * @public
2148
+ * <p>The name of the space.</p>
2149
+ */
2150
+ spaceName: string | undefined;
2151
+ /**
2152
+ * @public
2153
+ * <p>The ID of the workflow. To rerieve a list of workflow IDs, use <a>ListWorkflows</a>.</p>
2154
+ */
2155
+ id: string | undefined;
2156
+ /**
2157
+ * @public
2158
+ * <p>The name of the project in the space.</p>
2159
+ */
2160
+ projectName: string | undefined;
2161
+ }
2162
+ /**
2163
+ * @public
2164
+ * <p>Information about a workflow definition file.</p>
2165
+ */
2166
+ export interface WorkflowDefinition {
2167
+ /**
2168
+ * @public
2169
+ * <p>The path to the workflow definition file stored in the source repository for the project, including the file name.</p>
2170
+ */
2171
+ path: string | undefined;
2172
+ }
2173
+ /**
2174
+ * @public
2175
+ * @enum
2176
+ */
2177
+ export declare const WorkflowRunMode: {
2178
+ readonly PARALLEL: "PARALLEL";
2179
+ readonly QUEUED: "QUEUED";
2180
+ readonly SUPERSEDED: "SUPERSEDED";
2181
+ };
2182
+ /**
2183
+ * @public
2184
+ */
2185
+ export type WorkflowRunMode = (typeof WorkflowRunMode)[keyof typeof WorkflowRunMode];
2186
+ /**
2187
+ * @public
2188
+ * @enum
2189
+ */
2190
+ export declare const WorkflowStatus: {
2191
+ readonly ACTIVE: "ACTIVE";
2192
+ readonly INVALID: "INVALID";
2193
+ };
2194
+ /**
2195
+ * @public
2196
+ */
2197
+ export type WorkflowStatus = (typeof WorkflowStatus)[keyof typeof WorkflowStatus];
2198
+ /**
2199
+ * @public
2200
+ */
2201
+ export interface GetWorkflowResponse {
2202
+ /**
2203
+ * @public
2204
+ * <p>The name of the space.</p>
2205
+ */
2206
+ spaceName: string | undefined;
2207
+ /**
2208
+ * @public
2209
+ * <p>The name of the project in the space.</p>
2210
+ */
2211
+ projectName: string | undefined;
2212
+ /**
2213
+ * @public
2214
+ * <p>The ID of the workflow.</p>
2215
+ */
2216
+ id: string | undefined;
2217
+ /**
2218
+ * @public
2219
+ * <p>The name of the workflow.</p>
2220
+ */
2221
+ name: string | undefined;
2222
+ /**
2223
+ * @public
2224
+ * <p>The name of the source repository where the workflow YAML is stored.</p>
2225
+ */
2226
+ sourceRepositoryName?: string;
2227
+ /**
2228
+ * @public
2229
+ * <p>The name of the branch that contains the workflow YAML.</p>
2230
+ */
2231
+ sourceBranchName?: string;
2232
+ /**
2233
+ * @public
2234
+ * <p>Information about the workflow definition file for the workflow.</p>
2235
+ */
2236
+ definition: WorkflowDefinition | undefined;
2237
+ /**
2238
+ * @public
2239
+ * <p>The date and time the workflow 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>
2240
+ * </p>
2241
+ */
2242
+ createdTime: Date | undefined;
2243
+ /**
2244
+ * @public
2245
+ * <p>The date and time the workflow 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>
2246
+ * </p>
2247
+ */
2248
+ lastUpdatedTime: Date | undefined;
2249
+ /**
2250
+ * @public
2251
+ * <p>The behavior to use when multiple workflows occur at the same time. For more information, see
2252
+ * <a href="https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html">https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html</a> in the Amazon CodeCatalyst User Guide.</p>
2253
+ */
2254
+ runMode: WorkflowRunMode | undefined;
2255
+ /**
2256
+ * @public
2257
+ * <p>The status of the workflow.</p>
2258
+ */
2259
+ status: WorkflowStatus | undefined;
2260
+ }
2261
+ /**
2262
+ * @public
2263
+ * <p>Information used to sort workflows in the returned list.</p>
2264
+ */
2265
+ export interface WorkflowSortCriteria {
2266
+ }
2267
+ /**
2268
+ * @public
2269
+ */
2270
+ export interface ListWorkflowsRequest {
2271
+ /**
2272
+ * @public
2273
+ * <p>The name of the space.</p>
2274
+ */
2275
+ spaceName: string | undefined;
2276
+ /**
2277
+ * @public
2278
+ * <p>The name of the project in the space.</p>
2279
+ */
2280
+ projectName: string | undefined;
2281
+ /**
2282
+ * @public
2283
+ * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
2284
+ */
2285
+ nextToken?: string;
2286
+ /**
2287
+ * @public
2288
+ * <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>
2289
+ */
2290
+ maxResults?: number;
2291
+ /**
2292
+ * @public
2293
+ * <p>Information used to sort the items in the returned list.</p>
2294
+ */
2295
+ sortBy?: WorkflowSortCriteria[];
2296
+ }
2297
+ /**
2298
+ * @public
2299
+ * <p>Information about a workflow definition.</p>
2300
+ */
2301
+ export interface WorkflowDefinitionSummary {
2302
+ /**
2303
+ * @public
2304
+ * <p>The path to the workflow definition file stored in the source repository for the project, including the file name.</p>
2305
+ */
2306
+ path: string | undefined;
2307
+ }
2308
+ /**
2309
+ * @public
2310
+ * <p>Information about a workflow.</p>
2311
+ */
2312
+ export interface WorkflowSummary {
2313
+ /**
2314
+ * @public
2315
+ * <p>The system-generated unique ID of a workflow.</p>
2316
+ */
2317
+ id: string | undefined;
2318
+ /**
2319
+ * @public
2320
+ * <p>The name of the workflow.</p>
2321
+ */
2322
+ name: string | undefined;
2323
+ /**
2324
+ * @public
2325
+ * <p>The name of the source repository where the workflow definition file is stored.</p>
2326
+ */
2327
+ sourceRepositoryName: string | undefined;
2328
+ /**
2329
+ * @public
2330
+ * <p>The name of the branch of the source repository where the workflow definition file is stored.</p>
2331
+ */
2332
+ sourceBranchName: string | undefined;
2333
+ /**
2334
+ * @public
2335
+ * <p>Information about the workflow definition file.</p>
2336
+ */
2337
+ definition: WorkflowDefinitionSummary | undefined;
2338
+ /**
2339
+ * @public
2340
+ * <p>The date and time the workflow 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>
2341
+ * </p>
2342
+ */
2343
+ createdTime: Date | undefined;
2344
+ /**
2345
+ * @public
2346
+ * <p>The date and time the workflow 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>
2347
+ * </p>
2348
+ */
2349
+ lastUpdatedTime: Date | undefined;
2350
+ /**
2351
+ * @public
2352
+ * <p>The run mode of the workflow.</p>
2353
+ */
2354
+ runMode: WorkflowRunMode | undefined;
2355
+ /**
2356
+ * @public
2357
+ * <p>The status of the workflow.</p>
2358
+ */
2359
+ status: WorkflowStatus | undefined;
2360
+ }
2361
+ /**
2362
+ * @public
2363
+ */
2364
+ export interface ListWorkflowsResponse {
2365
+ /**
2366
+ * @public
2367
+ * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
2368
+ */
2369
+ nextToken?: string;
2370
+ /**
2371
+ * @public
2372
+ * <p>Information about the workflows in a project.</p>
2373
+ */
2374
+ items?: WorkflowSummary[];
2375
+ }
2376
+ /**
2377
+ * @public
2378
+ */
2379
+ export interface GetWorkflowRunRequest {
2380
+ /**
2381
+ * @public
2382
+ * <p>The name of the space.</p>
2383
+ */
2384
+ spaceName: string | undefined;
2385
+ /**
2386
+ * @public
2387
+ * <p>The ID of the workflow run. To retrieve a list of workflow run IDs, use <a>ListWorkflowRuns</a>.</p>
2388
+ */
2389
+ id: string | undefined;
2390
+ /**
2391
+ * @public
2392
+ * <p>The name of the project in the space.</p>
2393
+ */
2394
+ projectName: string | undefined;
2395
+ }
2396
+ /**
2397
+ * @public
2398
+ * @enum
2399
+ */
2400
+ export declare const WorkflowRunStatus: {
2401
+ readonly ABANDONED: "ABANDONED";
2402
+ readonly CANCELLED: "CANCELLED";
2403
+ readonly FAILED: "FAILED";
2404
+ readonly IN_PROGRESS: "IN_PROGRESS";
2405
+ readonly NOT_RUN: "NOT_RUN";
2406
+ readonly PROVISIONING: "PROVISIONING";
2407
+ readonly STOPPED: "STOPPED";
2408
+ readonly STOPPING: "STOPPING";
2409
+ readonly SUCCEEDED: "SUCCEEDED";
2410
+ readonly SUPERSEDED: "SUPERSEDED";
2411
+ readonly VALIDATING: "VALIDATING";
2412
+ };
2413
+ /**
2414
+ * @public
2415
+ */
2416
+ export type WorkflowRunStatus = (typeof WorkflowRunStatus)[keyof typeof WorkflowRunStatus];
2417
+ /**
2418
+ * @public
2419
+ * <p>Information about the status of a workflow run.</p>
2420
+ */
2421
+ export interface WorkflowRunStatusReason {
2422
+ }
2423
+ /**
2424
+ * @public
2425
+ */
2426
+ export interface GetWorkflowRunResponse {
2427
+ /**
2428
+ * @public
2429
+ * <p>The name of the space.</p>
2430
+ */
2431
+ spaceName: string | undefined;
2432
+ /**
2433
+ * @public
2434
+ * <p>The name of the project in the space.</p>
2435
+ */
2436
+ projectName: string | undefined;
2437
+ /**
2438
+ * @public
2439
+ * <p>The ID of the workflow run.</p>
2440
+ */
2441
+ id: string | undefined;
2442
+ /**
2443
+ * @public
2444
+ * <p>The ID of the workflow.</p>
2445
+ */
2446
+ workflowId: string | undefined;
2447
+ /**
2448
+ * @public
2449
+ * <p>The status of the workflow run.</p>
2450
+ */
2451
+ status: WorkflowRunStatus | undefined;
2452
+ /**
2453
+ * @public
2454
+ * <p>Information about the reasons for the status of the workflow run.</p>
2455
+ */
2456
+ statusReasons?: WorkflowRunStatusReason[];
2457
+ /**
2458
+ * @public
2459
+ * <p>The date and time the workflow run began, 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>
2460
+ * </p>
2461
+ */
2462
+ startTime: Date | undefined;
2463
+ /**
2464
+ * @public
2465
+ * <p>The date and time the workflow run ended, 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>
2466
+ */
2467
+ endTime?: Date;
2468
+ /**
2469
+ * @public
2470
+ * <p>The date and time the workflow run status 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>
2471
+ * </p>
2472
+ */
2473
+ lastUpdatedTime: Date | undefined;
2474
+ }
2475
+ /**
2476
+ * @public
2477
+ * <p>Information used to sort workflow runs in the returned list.</p>
2478
+ */
2479
+ export interface WorkflowRunSortCriteria {
2480
+ }
2481
+ /**
2482
+ * @public
2483
+ */
2484
+ export interface ListWorkflowRunsRequest {
2485
+ /**
2486
+ * @public
2487
+ * <p>The name of the space.</p>
2488
+ */
2489
+ spaceName: string | undefined;
2490
+ /**
2491
+ * @public
2492
+ * <p>The ID of the workflow. To retrieve a list of workflow IDs, use <a>ListWorkflows</a>.</p>
2493
+ */
2494
+ workflowId?: string;
2495
+ /**
2496
+ * @public
2497
+ * <p>The name of the project in the space.</p>
2498
+ */
2499
+ projectName: string | undefined;
2500
+ /**
2501
+ * @public
2502
+ * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
2503
+ */
2504
+ nextToken?: string;
2505
+ /**
2506
+ * @public
2507
+ * <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>
2508
+ */
2509
+ maxResults?: number;
2510
+ /**
2511
+ * @public
2512
+ * <p>Information used to sort the items in the returned list.</p>
2513
+ */
2514
+ sortBy?: WorkflowRunSortCriteria[];
2515
+ }
2516
+ /**
2517
+ * @public
2518
+ * <p>Information about a workflow run.</p>
2519
+ */
2520
+ export interface WorkflowRunSummary {
2521
+ /**
2522
+ * @public
2523
+ * <p>The system-generated unique ID of the workflow run.</p>
2524
+ */
2525
+ id: string | undefined;
2526
+ /**
2527
+ * @public
2528
+ * <p>The system-generated unique ID of the workflow.</p>
2529
+ */
2530
+ workflowId: string | undefined;
2531
+ /**
2532
+ * @public
2533
+ * <p>The name of the workflow.</p>
2534
+ */
2535
+ workflowName: string | undefined;
2536
+ /**
2537
+ * @public
2538
+ * <p>The status of the workflow run.</p>
2539
+ */
2540
+ status: WorkflowRunStatus | undefined;
2541
+ /**
2542
+ * @public
2543
+ * <p>The reasons for the workflow run status.</p>
2544
+ */
2545
+ statusReasons?: WorkflowRunStatusReason[];
2546
+ /**
2547
+ * @public
2548
+ * <p>The date and time the workflow run began, 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>
2549
+ */
2550
+ startTime: Date | undefined;
2551
+ /**
2552
+ * @public
2553
+ * <p>The date and time the workflow run ended, 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>
2554
+ * </p>
2555
+ */
2556
+ endTime?: Date;
2557
+ /**
2558
+ * @public
2559
+ * <p>The date and time the workflow 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>
2560
+ * </p>
2561
+ */
2562
+ lastUpdatedTime: Date | undefined;
2563
+ }
2564
+ /**
2565
+ * @public
2566
+ */
2567
+ export interface ListWorkflowRunsResponse {
2568
+ /**
2569
+ * @public
2570
+ * <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
2571
+ */
2572
+ nextToken?: string;
2573
+ /**
2574
+ * @public
2575
+ * <p>Information about the runs of a workflow.</p>
2576
+ */
2577
+ items?: WorkflowRunSummary[];
2578
+ }
2579
+ /**
2580
+ * @public
2581
+ */
2582
+ export interface StartWorkflowRunRequest {
2583
+ /**
2584
+ * @public
2585
+ * <p>The name of the space.</p>
2586
+ */
2587
+ spaceName: string | undefined;
2588
+ /**
2589
+ * @public
2590
+ * <p>The name of the project in the space.</p>
2591
+ */
2592
+ projectName: string | undefined;
2593
+ /**
2594
+ * @public
2595
+ * <p>The system-generated unique ID of the workflow. To retrieve a list of workflow IDs, use <a>ListWorkflows</a>.</p>
2596
+ */
2597
+ workflowId: string | undefined;
2598
+ /**
2599
+ * @public
2600
+ * <p>A user-specified idempotency token. Idempotency ensures that an API request completes only once.
2601
+ * 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>
2602
+ */
2603
+ clientToken?: string;
2604
+ }
2605
+ /**
2606
+ * @public
2607
+ */
2608
+ export interface StartWorkflowRunResponse {
2609
+ /**
2610
+ * @public
2611
+ * <p>The name of the space.</p>
2612
+ */
2613
+ spaceName: string | undefined;
2614
+ /**
2615
+ * @public
2616
+ * <p>The name of the project in the space.</p>
2617
+ */
2618
+ projectName: string | undefined;
2619
+ /**
2620
+ * @public
2621
+ * <p>The system-generated unique ID of the workflow run.</p>
2622
+ */
2623
+ id: string | undefined;
2624
+ /**
2625
+ * @public
2626
+ * <p>The system-generated unique ID of the workflow.</p>
2627
+ */
2628
+ workflowId: string | undefined;
2629
+ }
2140
2630
  /**
2141
2631
  * @public
2142
2632
  */