@aws-sdk/client-imagebuilder 3.470.0 → 3.473.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.
- package/README.md +56 -0
- package/dist-cjs/Imagebuilder.js +14 -0
- package/dist-cjs/commands/CreateWorkflowCommand.js +51 -0
- package/dist-cjs/commands/DeleteWorkflowCommand.js +51 -0
- package/dist-cjs/commands/GetWorkflowCommand.js +51 -0
- package/dist-cjs/commands/ListWaitingWorkflowStepsCommand.js +51 -0
- package/dist-cjs/commands/ListWorkflowBuildVersionsCommand.js +51 -0
- package/dist-cjs/commands/ListWorkflowsCommand.js +51 -0
- package/dist-cjs/commands/SendWorkflowStepActionCommand.js +51 -0
- package/dist-cjs/commands/index.js +7 -0
- package/dist-cjs/models/models_0.js +19 -6
- package/dist-cjs/pagination/ListWaitingWorkflowStepsPaginator.js +29 -0
- package/dist-cjs/pagination/ListWorkflowBuildVersionsPaginator.js +29 -0
- package/dist-cjs/pagination/ListWorkflowsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +3 -0
- package/dist-cjs/protocols/Aws_restJson1.js +565 -3
- package/dist-es/Imagebuilder.js +14 -0
- package/dist-es/commands/CreateWorkflowCommand.js +47 -0
- package/dist-es/commands/DeleteWorkflowCommand.js +47 -0
- package/dist-es/commands/GetWorkflowCommand.js +47 -0
- package/dist-es/commands/ListWaitingWorkflowStepsCommand.js +47 -0
- package/dist-es/commands/ListWorkflowBuildVersionsCommand.js +47 -0
- package/dist-es/commands/ListWorkflowsCommand.js +47 -0
- package/dist-es/commands/SendWorkflowStepActionCommand.js +47 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/models/models_0.js +18 -5
- package/dist-es/pagination/ListWaitingWorkflowStepsPaginator.js +25 -0
- package/dist-es/pagination/ListWorkflowBuildVersionsPaginator.js +25 -0
- package/dist-es/pagination/ListWorkflowsPaginator.js +25 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +548 -0
- package/dist-types/Imagebuilder.d.ts +49 -0
- package/dist-types/ImagebuilderClient.d.ts +9 -2
- package/dist-types/commands/CreateImageCommand.d.ts +16 -0
- package/dist-types/commands/CreateImagePipelineCommand.d.ts +16 -0
- package/dist-types/commands/CreateWorkflowCommand.d.ts +126 -0
- package/dist-types/commands/DeleteWorkflowCommand.d.ts +98 -0
- package/dist-types/commands/GetImageCommand.d.ts +16 -0
- package/dist-types/commands/GetImagePipelineCommand.d.ts +16 -0
- package/dist-types/commands/GetWorkflowCommand.d.ts +122 -0
- package/dist-types/commands/GetWorkflowExecutionCommand.d.ts +2 -1
- package/dist-types/commands/GetWorkflowStepExecutionCommand.d.ts +1 -1
- package/dist-types/commands/ListImagePipelinesCommand.d.ts +16 -0
- package/dist-types/commands/ListWaitingWorkflowStepsCommand.d.ts +110 -0
- package/dist-types/commands/ListWorkflowBuildVersionsCommand.d.ts +118 -0
- package/dist-types/commands/ListWorkflowExecutionsCommand.d.ts +2 -1
- package/dist-types/commands/ListWorkflowStepExecutionsCommand.d.ts +2 -2
- package/dist-types/commands/ListWorkflowsCommand.d.ts +119 -0
- package/dist-types/commands/SendWorkflowStepActionCommand.d.ts +115 -0
- package/dist-types/commands/UpdateImagePipelineCommand.d.ts +18 -1
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/models/models_0.d.ts +786 -61
- package/dist-types/pagination/ListWaitingWorkflowStepsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListWorkflowBuildVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListWorkflowsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +63 -0
- package/dist-types/ts3.4/Imagebuilder.d.ts +119 -0
- package/dist-types/ts3.4/ImagebuilderClient.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateWorkflowCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteWorkflowCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetWorkflowCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListWaitingWorkflowStepsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListWorkflowBuildVersionsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListWorkflowsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/SendWorkflowStepActionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +7 -0
- package/dist-types/ts3.4/models/models_0.d.ts +170 -6
- package/dist-types/ts3.4/pagination/ListWaitingWorkflowStepsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListWorkflowBuildVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListWorkflowsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +84 -0
- package/package.json +2 -2
|
@@ -479,8 +479,7 @@ export declare const ComponentStatus: {
|
|
|
479
479
|
export type ComponentStatus = (typeof ComponentStatus)[keyof typeof ComponentStatus];
|
|
480
480
|
/**
|
|
481
481
|
* @public
|
|
482
|
-
* <p>A group of fields that describe the current status of components
|
|
483
|
-
* active.</p>
|
|
482
|
+
* <p>A group of fields that describe the current status of components.</p>
|
|
484
483
|
*/
|
|
485
484
|
export interface ComponentState {
|
|
486
485
|
/**
|
|
@@ -533,7 +532,8 @@ export interface Component {
|
|
|
533
532
|
description?: string;
|
|
534
533
|
/**
|
|
535
534
|
* @public
|
|
536
|
-
* <p>
|
|
535
|
+
* <p>Describes what change has been made in this version of the component,
|
|
536
|
+
* or what makes this version different from other versions of the component.</p>
|
|
537
537
|
*/
|
|
538
538
|
changeDescription?: string;
|
|
539
539
|
/**
|
|
@@ -1221,7 +1221,7 @@ export interface CreateComponentRequest {
|
|
|
1221
1221
|
/**
|
|
1222
1222
|
* @public
|
|
1223
1223
|
* <p>The change description of the component. Describes what change has been made in this
|
|
1224
|
-
* version, or what makes this version different from other versions of
|
|
1224
|
+
* version, or what makes this version different from other versions of the
|
|
1225
1225
|
* component.</p>
|
|
1226
1226
|
*/
|
|
1227
1227
|
changeDescription?: string;
|
|
@@ -1784,6 +1784,67 @@ export interface ImageTestsConfiguration {
|
|
|
1784
1784
|
*/
|
|
1785
1785
|
timeoutMinutes?: number;
|
|
1786
1786
|
}
|
|
1787
|
+
/**
|
|
1788
|
+
* @public
|
|
1789
|
+
* @enum
|
|
1790
|
+
*/
|
|
1791
|
+
export declare const OnWorkflowFailure: {
|
|
1792
|
+
readonly ABORT: "ABORT";
|
|
1793
|
+
readonly CONTINUE: "CONTINUE";
|
|
1794
|
+
};
|
|
1795
|
+
/**
|
|
1796
|
+
* @public
|
|
1797
|
+
*/
|
|
1798
|
+
export type OnWorkflowFailure = (typeof OnWorkflowFailure)[keyof typeof OnWorkflowFailure];
|
|
1799
|
+
/**
|
|
1800
|
+
* @public
|
|
1801
|
+
* <p>Contains a key/value pair that sets the named workflow parameter.</p>
|
|
1802
|
+
*/
|
|
1803
|
+
export interface WorkflowParameter {
|
|
1804
|
+
/**
|
|
1805
|
+
* @public
|
|
1806
|
+
* <p>The name of the workflow parameter to set.</p>
|
|
1807
|
+
*/
|
|
1808
|
+
name: string | undefined;
|
|
1809
|
+
/**
|
|
1810
|
+
* @public
|
|
1811
|
+
* <p>Sets the value for the named workflow parameter.</p>
|
|
1812
|
+
*/
|
|
1813
|
+
value: string[] | undefined;
|
|
1814
|
+
}
|
|
1815
|
+
/**
|
|
1816
|
+
* @public
|
|
1817
|
+
* <p>Contains control settings and configurable inputs for a workflow
|
|
1818
|
+
* resource.</p>
|
|
1819
|
+
*/
|
|
1820
|
+
export interface WorkflowConfiguration {
|
|
1821
|
+
/**
|
|
1822
|
+
* @public
|
|
1823
|
+
* <p>The Amazon Resource Name (ARN) of the workflow resource.</p>
|
|
1824
|
+
*/
|
|
1825
|
+
workflowArn: string | undefined;
|
|
1826
|
+
/**
|
|
1827
|
+
* @public
|
|
1828
|
+
* <p>Contains parameter values for each of the parameters that the workflow
|
|
1829
|
+
* document defined for the workflow resource.</p>
|
|
1830
|
+
*/
|
|
1831
|
+
parameters?: WorkflowParameter[];
|
|
1832
|
+
/**
|
|
1833
|
+
* @public
|
|
1834
|
+
* <p>Test workflows are defined within named runtime groups called parallel groups.
|
|
1835
|
+
* The parallel group is the named group that contains this test workflow. Test
|
|
1836
|
+
* workflows within a parallel group can run at the same time. Image Builder starts up to five
|
|
1837
|
+
* test workflows in the group at the same time, and starts additional workflows as
|
|
1838
|
+
* others complete, until all workflows in the group have completed. This field only
|
|
1839
|
+
* applies for test workflows.</p>
|
|
1840
|
+
*/
|
|
1841
|
+
parallelGroup?: string;
|
|
1842
|
+
/**
|
|
1843
|
+
* @public
|
|
1844
|
+
* <p>The action to take if the workflow fails.</p>
|
|
1845
|
+
*/
|
|
1846
|
+
onFailure?: OnWorkflowFailure;
|
|
1847
|
+
}
|
|
1787
1848
|
/**
|
|
1788
1849
|
* @public
|
|
1789
1850
|
*/
|
|
@@ -1841,6 +1902,17 @@ export interface CreateImageRequest {
|
|
|
1841
1902
|
* <p>Contains settings for vulnerability scans.</p>
|
|
1842
1903
|
*/
|
|
1843
1904
|
imageScanningConfiguration?: ImageScanningConfiguration;
|
|
1905
|
+
/**
|
|
1906
|
+
* @public
|
|
1907
|
+
* <p>Contains an array of workflow configuration objects.</p>
|
|
1908
|
+
*/
|
|
1909
|
+
workflows?: WorkflowConfiguration[];
|
|
1910
|
+
/**
|
|
1911
|
+
* @public
|
|
1912
|
+
* <p>The name or Amazon Resource Name (ARN) for the IAM role you create that grants
|
|
1913
|
+
* Image Builder access to perform workflow actions.</p>
|
|
1914
|
+
*/
|
|
1915
|
+
executionRole?: string;
|
|
1844
1916
|
}
|
|
1845
1917
|
/**
|
|
1846
1918
|
* @public
|
|
@@ -1876,7 +1948,7 @@ export declare const PipelineExecutionStartCondition: {
|
|
|
1876
1948
|
export type PipelineExecutionStartCondition = (typeof PipelineExecutionStartCondition)[keyof typeof PipelineExecutionStartCondition];
|
|
1877
1949
|
/**
|
|
1878
1950
|
* @public
|
|
1879
|
-
* <p>A schedule configures how often
|
|
1951
|
+
* <p>A schedule configures when and how often a pipeline will automatically create a new
|
|
1880
1952
|
* image.</p>
|
|
1881
1953
|
*/
|
|
1882
1954
|
export interface Schedule {
|
|
@@ -1996,6 +2068,17 @@ export interface CreateImagePipelineRequest {
|
|
|
1996
2068
|
* <p>Contains settings for vulnerability scans.</p>
|
|
1997
2069
|
*/
|
|
1998
2070
|
imageScanningConfiguration?: ImageScanningConfiguration;
|
|
2071
|
+
/**
|
|
2072
|
+
* @public
|
|
2073
|
+
* <p>Contains an array of workflow configuration objects.</p>
|
|
2074
|
+
*/
|
|
2075
|
+
workflows?: WorkflowConfiguration[];
|
|
2076
|
+
/**
|
|
2077
|
+
* @public
|
|
2078
|
+
* <p>The name or Amazon Resource Name (ARN) for the IAM role you create that grants
|
|
2079
|
+
* Image Builder access to perform workflow actions.</p>
|
|
2080
|
+
*/
|
|
2081
|
+
executionRole?: string;
|
|
1999
2082
|
}
|
|
2000
2083
|
/**
|
|
2001
2084
|
* @public
|
|
@@ -2389,18 +2472,18 @@ export interface LifecyclePolicyDetailExclusionRulesAmis {
|
|
|
2389
2472
|
isPublic?: boolean;
|
|
2390
2473
|
/**
|
|
2391
2474
|
* @public
|
|
2392
|
-
* <p>
|
|
2475
|
+
* <p>Configures Amazon Web Services Regions that are excluded from the lifecycle action.</p>
|
|
2393
2476
|
*/
|
|
2394
2477
|
regions?: string[];
|
|
2395
2478
|
/**
|
|
2396
2479
|
* @public
|
|
2397
|
-
* <p>Specifies
|
|
2398
|
-
* from lifecycle actions.</p>
|
|
2480
|
+
* <p>Specifies Amazon Web Services accounts whose resources are excluded from the lifecycle action.</p>
|
|
2399
2481
|
*/
|
|
2400
2482
|
sharedAccounts?: string[];
|
|
2401
2483
|
/**
|
|
2402
2484
|
* @public
|
|
2403
|
-
* <p>
|
|
2485
|
+
* <p>Specifies configuration details for Image Builder to exclude the most recent resources
|
|
2486
|
+
* from lifecycle actions.</p>
|
|
2404
2487
|
*/
|
|
2405
2488
|
lastLaunched?: LifecyclePolicyDetailExclusionRulesAmisLastLaunched;
|
|
2406
2489
|
/**
|
|
@@ -2416,7 +2499,7 @@ export interface LifecyclePolicyDetailExclusionRulesAmis {
|
|
|
2416
2499
|
export interface LifecyclePolicyDetailExclusionRules {
|
|
2417
2500
|
/**
|
|
2418
2501
|
* @public
|
|
2419
|
-
* <p>Contains a list of tags that Image Builder uses to skip lifecycle actions for
|
|
2502
|
+
* <p>Contains a list of tags that Image Builder uses to skip lifecycle actions for resources that have them.</p>
|
|
2420
2503
|
*/
|
|
2421
2504
|
tagMap?: Record<string, string>;
|
|
2422
2505
|
/**
|
|
@@ -2574,7 +2657,7 @@ export interface CreateLifecyclePolicyRequest {
|
|
|
2574
2657
|
status?: LifecyclePolicyStatus;
|
|
2575
2658
|
/**
|
|
2576
2659
|
* @public
|
|
2577
|
-
* <p>The
|
|
2660
|
+
* <p>The name or Amazon Resource Name (ARN) for the IAM role you create that grants
|
|
2578
2661
|
* Image Builder access to run lifecycle actions.</p>
|
|
2579
2662
|
*/
|
|
2580
2663
|
executionRole: string | undefined;
|
|
@@ -2621,6 +2704,113 @@ export interface CreateLifecyclePolicyResponse {
|
|
|
2621
2704
|
*/
|
|
2622
2705
|
lifecyclePolicyArn?: string;
|
|
2623
2706
|
}
|
|
2707
|
+
/**
|
|
2708
|
+
* @public
|
|
2709
|
+
* @enum
|
|
2710
|
+
*/
|
|
2711
|
+
export declare const WorkflowType: {
|
|
2712
|
+
readonly BUILD: "BUILD";
|
|
2713
|
+
readonly DISTRIBUTION: "DISTRIBUTION";
|
|
2714
|
+
readonly TEST: "TEST";
|
|
2715
|
+
};
|
|
2716
|
+
/**
|
|
2717
|
+
* @public
|
|
2718
|
+
*/
|
|
2719
|
+
export type WorkflowType = (typeof WorkflowType)[keyof typeof WorkflowType];
|
|
2720
|
+
/**
|
|
2721
|
+
* @public
|
|
2722
|
+
*/
|
|
2723
|
+
export interface CreateWorkflowRequest {
|
|
2724
|
+
/**
|
|
2725
|
+
* @public
|
|
2726
|
+
* <p>The name of the workflow to create.</p>
|
|
2727
|
+
*/
|
|
2728
|
+
name: string | undefined;
|
|
2729
|
+
/**
|
|
2730
|
+
* @public
|
|
2731
|
+
* <p>The semantic version of this workflow resource. The semantic version syntax
|
|
2732
|
+
* adheres to the following rules.</p>
|
|
2733
|
+
* <note>
|
|
2734
|
+
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
2735
|
+
* You can assign values for the first three, and can filter on all of them.</p>
|
|
2736
|
+
* <p>
|
|
2737
|
+
* <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including
|
|
2738
|
+
* zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the
|
|
2739
|
+
* build number to the fourth node.</p>
|
|
2740
|
+
* <p>
|
|
2741
|
+
* <b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for
|
|
2742
|
+
* the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or
|
|
2743
|
+
* a date, such as 2021.01.01.</p>
|
|
2744
|
+
* </note>
|
|
2745
|
+
*/
|
|
2746
|
+
semanticVersion: string | undefined;
|
|
2747
|
+
/**
|
|
2748
|
+
* @public
|
|
2749
|
+
* <p>Describes the workflow.</p>
|
|
2750
|
+
*/
|
|
2751
|
+
description?: string;
|
|
2752
|
+
/**
|
|
2753
|
+
* @public
|
|
2754
|
+
* <p>Describes what change has been made in this version of the workflow, or
|
|
2755
|
+
* what makes this version different from other versions of the workflow.</p>
|
|
2756
|
+
*/
|
|
2757
|
+
changeDescription?: string;
|
|
2758
|
+
/**
|
|
2759
|
+
* @public
|
|
2760
|
+
* <p>Contains the UTF-8 encoded YAML document content for the workflow.
|
|
2761
|
+
* Alternatively, you can specify the <code>uri</code> of a YAML document file stored in
|
|
2762
|
+
* Amazon S3. However, you cannot specify both properties.</p>
|
|
2763
|
+
*/
|
|
2764
|
+
data?: string;
|
|
2765
|
+
/**
|
|
2766
|
+
* @public
|
|
2767
|
+
* <p>The <code>uri</code> of a YAML component document file. This must be an S3 URL
|
|
2768
|
+
* (<code>s3://bucket/key</code>), and the requester must have permission to access the
|
|
2769
|
+
* S3 bucket it points to. If you use Amazon S3, you can specify component content up to your
|
|
2770
|
+
* service quota.</p>
|
|
2771
|
+
* <p>Alternatively, you can specify the YAML document inline, using the component
|
|
2772
|
+
* <code>data</code> property. You cannot specify both properties.</p>
|
|
2773
|
+
*/
|
|
2774
|
+
uri?: string;
|
|
2775
|
+
/**
|
|
2776
|
+
* @public
|
|
2777
|
+
* <p>The ID of the KMS key that is used to encrypt this workflow resource.</p>
|
|
2778
|
+
*/
|
|
2779
|
+
kmsKeyId?: string;
|
|
2780
|
+
/**
|
|
2781
|
+
* @public
|
|
2782
|
+
* <p>Tags that apply to the workflow resource.</p>
|
|
2783
|
+
*/
|
|
2784
|
+
tags?: Record<string, string>;
|
|
2785
|
+
/**
|
|
2786
|
+
* @public
|
|
2787
|
+
* <p>Unique, case-sensitive identifier you provide to ensure
|
|
2788
|
+
* idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>
|
|
2789
|
+
* in the <i>Amazon EC2 API Reference</i>.</p>
|
|
2790
|
+
*/
|
|
2791
|
+
clientToken?: string;
|
|
2792
|
+
/**
|
|
2793
|
+
* @public
|
|
2794
|
+
* <p>The phase in the image build process for which the workflow resource
|
|
2795
|
+
* is responsible.</p>
|
|
2796
|
+
*/
|
|
2797
|
+
type: WorkflowType | undefined;
|
|
2798
|
+
}
|
|
2799
|
+
/**
|
|
2800
|
+
* @public
|
|
2801
|
+
*/
|
|
2802
|
+
export interface CreateWorkflowResponse {
|
|
2803
|
+
/**
|
|
2804
|
+
* @public
|
|
2805
|
+
* <p>The client token that uniquely identifies the request.</p>
|
|
2806
|
+
*/
|
|
2807
|
+
clientToken?: string;
|
|
2808
|
+
/**
|
|
2809
|
+
* @public
|
|
2810
|
+
* <p>The Amazon Resource Name (ARN) of the workflow resource that the request created.</p>
|
|
2811
|
+
*/
|
|
2812
|
+
workflowBuildVersionArn?: string;
|
|
2813
|
+
}
|
|
2624
2814
|
/**
|
|
2625
2815
|
* @public
|
|
2626
2816
|
* <p>Amazon Inspector generates a risk score for each finding. This score helps you to prioritize
|
|
@@ -2916,6 +3106,26 @@ export interface DeleteLifecyclePolicyResponse {
|
|
|
2916
3106
|
*/
|
|
2917
3107
|
lifecyclePolicyArn?: string;
|
|
2918
3108
|
}
|
|
3109
|
+
/**
|
|
3110
|
+
* @public
|
|
3111
|
+
*/
|
|
3112
|
+
export interface DeleteWorkflowRequest {
|
|
3113
|
+
/**
|
|
3114
|
+
* @public
|
|
3115
|
+
* <p>The Amazon Resource Name (ARN) of the workflow resource to delete.</p>
|
|
3116
|
+
*/
|
|
3117
|
+
workflowBuildVersionArn: string | undefined;
|
|
3118
|
+
}
|
|
3119
|
+
/**
|
|
3120
|
+
* @public
|
|
3121
|
+
*/
|
|
3122
|
+
export interface DeleteWorkflowResponse {
|
|
3123
|
+
/**
|
|
3124
|
+
* @public
|
|
3125
|
+
* <p>The ARN of the workflow resource that this request deleted.</p>
|
|
3126
|
+
*/
|
|
3127
|
+
workflowBuildVersionArn?: string;
|
|
3128
|
+
}
|
|
2919
3129
|
/**
|
|
2920
3130
|
* @public
|
|
2921
3131
|
* <p>A distribution configuration.</p>
|
|
@@ -3044,7 +3254,7 @@ export interface GetComponentResponse {
|
|
|
3044
3254
|
requestId?: string;
|
|
3045
3255
|
/**
|
|
3046
3256
|
* @public
|
|
3047
|
-
* <p>The component object
|
|
3257
|
+
* <p>The component object specified in the request.</p>
|
|
3048
3258
|
*/
|
|
3049
3259
|
component?: Component;
|
|
3050
3260
|
}
|
|
@@ -3606,6 +3816,17 @@ export interface Image {
|
|
|
3606
3816
|
* <p>Identifies the last runtime instance of the lifecycle policy to take action on the image.</p>
|
|
3607
3817
|
*/
|
|
3608
3818
|
lifecycleExecutionId?: string;
|
|
3819
|
+
/**
|
|
3820
|
+
* @public
|
|
3821
|
+
* <p>The name or Amazon Resource Name (ARN) for the IAM role you create that grants
|
|
3822
|
+
* Image Builder access to perform workflow actions.</p>
|
|
3823
|
+
*/
|
|
3824
|
+
executionRole?: string;
|
|
3825
|
+
/**
|
|
3826
|
+
* @public
|
|
3827
|
+
* <p>Contains the build and test workflows that are associated with the image.</p>
|
|
3828
|
+
*/
|
|
3829
|
+
workflows?: WorkflowConfiguration[];
|
|
3609
3830
|
}
|
|
3610
3831
|
/**
|
|
3611
3832
|
* @public
|
|
@@ -3733,6 +3954,17 @@ export interface ImagePipeline {
|
|
|
3733
3954
|
* <p>Contains settings for vulnerability scans.</p>
|
|
3734
3955
|
*/
|
|
3735
3956
|
imageScanningConfiguration?: ImageScanningConfiguration;
|
|
3957
|
+
/**
|
|
3958
|
+
* @public
|
|
3959
|
+
* <p>The name or Amazon Resource Name (ARN) for the IAM role you create that grants
|
|
3960
|
+
* Image Builder access to perform workflow actions.</p>
|
|
3961
|
+
*/
|
|
3962
|
+
executionRole?: string;
|
|
3963
|
+
/**
|
|
3964
|
+
* @public
|
|
3965
|
+
* <p>Contains the workflows that run for the image pipeline.</p>
|
|
3966
|
+
*/
|
|
3967
|
+
workflows?: WorkflowConfiguration[];
|
|
3736
3968
|
}
|
|
3737
3969
|
/**
|
|
3738
3970
|
* @public
|
|
@@ -3991,7 +4223,7 @@ export interface LifecyclePolicy {
|
|
|
3991
4223
|
status?: LifecyclePolicyStatus;
|
|
3992
4224
|
/**
|
|
3993
4225
|
* @public
|
|
3994
|
-
* <p>The name of the IAM role that Image Builder uses to run the lifecycle policy.
|
|
4226
|
+
* <p>The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy.
|
|
3995
4227
|
* This is a custom role that you create.</p>
|
|
3996
4228
|
*/
|
|
3997
4229
|
executionRole?: string;
|
|
@@ -4046,93 +4278,233 @@ export interface GetLifecyclePolicyResponse {
|
|
|
4046
4278
|
/**
|
|
4047
4279
|
* @public
|
|
4048
4280
|
*/
|
|
4049
|
-
export interface
|
|
4281
|
+
export interface GetWorkflowRequest {
|
|
4050
4282
|
/**
|
|
4051
4283
|
* @public
|
|
4052
|
-
* <p>
|
|
4053
|
-
* runtime details.</p>
|
|
4284
|
+
* <p>The Amazon Resource Name (ARN) of the workflow resource that you want to get.</p>
|
|
4054
4285
|
*/
|
|
4055
|
-
|
|
4286
|
+
workflowBuildVersionArn: string | undefined;
|
|
4056
4287
|
}
|
|
4057
4288
|
/**
|
|
4058
4289
|
* @public
|
|
4059
|
-
*
|
|
4060
|
-
|
|
4061
|
-
export declare const WorkflowExecutionStatus: {
|
|
4062
|
-
readonly COMPLETED: "COMPLETED";
|
|
4063
|
-
readonly FAILED: "FAILED";
|
|
4064
|
-
readonly PENDING: "PENDING";
|
|
4065
|
-
readonly ROLLBACK_COMPLETED: "ROLLBACK_COMPLETED";
|
|
4066
|
-
readonly ROLLBACK_IN_PROGRESS: "ROLLBACK_IN_PROGRESS";
|
|
4067
|
-
readonly RUNNING: "RUNNING";
|
|
4068
|
-
readonly SKIPPED: "SKIPPED";
|
|
4069
|
-
};
|
|
4070
|
-
/**
|
|
4071
|
-
* @public
|
|
4290
|
+
* <p>Defines a parameter that's used to provide configuration details for the
|
|
4291
|
+
* workflow.</p>
|
|
4072
4292
|
*/
|
|
4073
|
-
export
|
|
4293
|
+
export interface WorkflowParameterDetail {
|
|
4294
|
+
/**
|
|
4295
|
+
* @public
|
|
4296
|
+
* <p>The name of this input parameter.</p>
|
|
4297
|
+
*/
|
|
4298
|
+
name: string | undefined;
|
|
4299
|
+
/**
|
|
4300
|
+
* @public
|
|
4301
|
+
* <p>The type of input this parameter provides. The currently supported value is
|
|
4302
|
+
* "string".</p>
|
|
4303
|
+
*/
|
|
4304
|
+
type: string | undefined;
|
|
4305
|
+
/**
|
|
4306
|
+
* @public
|
|
4307
|
+
* <p>The default value of this parameter if no input is provided.</p>
|
|
4308
|
+
*/
|
|
4309
|
+
defaultValue?: string[];
|
|
4310
|
+
/**
|
|
4311
|
+
* @public
|
|
4312
|
+
* <p>Describes this parameter.</p>
|
|
4313
|
+
*/
|
|
4314
|
+
description?: string;
|
|
4315
|
+
}
|
|
4074
4316
|
/**
|
|
4075
4317
|
* @public
|
|
4076
4318
|
* @enum
|
|
4077
4319
|
*/
|
|
4078
|
-
export declare const
|
|
4079
|
-
readonly
|
|
4080
|
-
readonly DISTRIBUTION: "DISTRIBUTION";
|
|
4081
|
-
readonly TEST: "TEST";
|
|
4320
|
+
export declare const WorkflowStatus: {
|
|
4321
|
+
readonly DEPRECATED: "DEPRECATED";
|
|
4082
4322
|
};
|
|
4083
4323
|
/**
|
|
4084
4324
|
* @public
|
|
4085
4325
|
*/
|
|
4086
|
-
export type
|
|
4326
|
+
export type WorkflowStatus = (typeof WorkflowStatus)[keyof typeof WorkflowStatus];
|
|
4087
4327
|
/**
|
|
4088
4328
|
* @public
|
|
4329
|
+
* <p>A group of fields that describe the current status of workflow.</p>
|
|
4089
4330
|
*/
|
|
4090
|
-
export interface
|
|
4331
|
+
export interface WorkflowState {
|
|
4091
4332
|
/**
|
|
4092
4333
|
* @public
|
|
4093
|
-
* <p>The
|
|
4334
|
+
* <p>The current state of the workflow.</p>
|
|
4094
4335
|
*/
|
|
4095
|
-
|
|
4336
|
+
status?: WorkflowStatus;
|
|
4096
4337
|
/**
|
|
4097
4338
|
* @public
|
|
4098
|
-
* <p>
|
|
4099
|
-
* that defines the specified runtime instance of the workflow.</p>
|
|
4339
|
+
* <p>Describes how or why the workflow changed state.</p>
|
|
4100
4340
|
*/
|
|
4101
|
-
|
|
4341
|
+
reason?: string;
|
|
4342
|
+
}
|
|
4343
|
+
/**
|
|
4344
|
+
* @public
|
|
4345
|
+
* <p>Defines a process that Image Builder uses to build and test images during
|
|
4346
|
+
* the image creation process.</p>
|
|
4347
|
+
*/
|
|
4348
|
+
export interface Workflow {
|
|
4102
4349
|
/**
|
|
4103
4350
|
* @public
|
|
4104
|
-
* <p>The
|
|
4105
|
-
* when it ran the workflow.</p>
|
|
4351
|
+
* <p>The Amazon Resource Name (ARN) of the workflow resource.</p>
|
|
4106
4352
|
*/
|
|
4107
|
-
|
|
4353
|
+
arn?: string;
|
|
4108
4354
|
/**
|
|
4109
4355
|
* @public
|
|
4110
|
-
* <p>The
|
|
4111
|
-
* runtime instance of the workflow created.</p>
|
|
4356
|
+
* <p>The name of the workflow resource.</p>
|
|
4112
4357
|
*/
|
|
4113
|
-
|
|
4358
|
+
name?: string;
|
|
4114
4359
|
/**
|
|
4115
4360
|
* @public
|
|
4116
|
-
* <p>The
|
|
4361
|
+
* <p>The workflow resource version. Workflow resources are immutable.
|
|
4362
|
+
* To make a change, you can clone a workflow or create a new version.</p>
|
|
4117
4363
|
*/
|
|
4118
|
-
|
|
4364
|
+
version?: string;
|
|
4119
4365
|
/**
|
|
4120
4366
|
* @public
|
|
4121
|
-
* <p>The
|
|
4367
|
+
* <p>The description of the workflow.</p>
|
|
4122
4368
|
*/
|
|
4123
|
-
|
|
4369
|
+
description?: string;
|
|
4124
4370
|
/**
|
|
4125
4371
|
* @public
|
|
4126
|
-
* <p>
|
|
4372
|
+
* <p>Describes what change has been made in this version of the workflow, or
|
|
4373
|
+
* what makes this version different from other versions of the workflow.</p>
|
|
4127
4374
|
*/
|
|
4128
|
-
|
|
4375
|
+
changeDescription?: string;
|
|
4129
4376
|
/**
|
|
4130
4377
|
* @public
|
|
4131
|
-
* <p>
|
|
4132
|
-
*
|
|
4133
|
-
* and failed.</p>
|
|
4378
|
+
* <p>Specifies the image creation stage that the workflow applies to. Image Builder
|
|
4379
|
+
* currently supports build and test workflows.</p>
|
|
4134
4380
|
*/
|
|
4135
|
-
|
|
4381
|
+
type?: WorkflowType;
|
|
4382
|
+
/**
|
|
4383
|
+
* @public
|
|
4384
|
+
* <p>Describes the current status of the workflow and the reason for
|
|
4385
|
+
* that status.</p>
|
|
4386
|
+
*/
|
|
4387
|
+
state?: WorkflowState;
|
|
4388
|
+
/**
|
|
4389
|
+
* @public
|
|
4390
|
+
* <p>The owner of the workflow resource.</p>
|
|
4391
|
+
*/
|
|
4392
|
+
owner?: string;
|
|
4393
|
+
/**
|
|
4394
|
+
* @public
|
|
4395
|
+
* <p>Contains the YAML document content for the workflow.</p>
|
|
4396
|
+
*/
|
|
4397
|
+
data?: string;
|
|
4398
|
+
/**
|
|
4399
|
+
* @public
|
|
4400
|
+
* <p>The KMS key identifier used to encrypt the workflow resource.</p>
|
|
4401
|
+
*/
|
|
4402
|
+
kmsKeyId?: string;
|
|
4403
|
+
/**
|
|
4404
|
+
* @public
|
|
4405
|
+
* <p>The timestamp when Image Builder created the workflow resource.</p>
|
|
4406
|
+
*/
|
|
4407
|
+
dateCreated?: string;
|
|
4408
|
+
/**
|
|
4409
|
+
* @public
|
|
4410
|
+
* <p>The tags that apply to the workflow resource</p>
|
|
4411
|
+
*/
|
|
4412
|
+
tags?: Record<string, string>;
|
|
4413
|
+
/**
|
|
4414
|
+
* @public
|
|
4415
|
+
* <p>An array of input parameters that that the image workflow uses
|
|
4416
|
+
* to control actions or configure settings.</p>
|
|
4417
|
+
*/
|
|
4418
|
+
parameters?: WorkflowParameterDetail[];
|
|
4419
|
+
}
|
|
4420
|
+
/**
|
|
4421
|
+
* @public
|
|
4422
|
+
*/
|
|
4423
|
+
export interface GetWorkflowResponse {
|
|
4424
|
+
/**
|
|
4425
|
+
* @public
|
|
4426
|
+
* <p>The workflow resource specified in the request.</p>
|
|
4427
|
+
*/
|
|
4428
|
+
workflow?: Workflow;
|
|
4429
|
+
}
|
|
4430
|
+
/**
|
|
4431
|
+
* @public
|
|
4432
|
+
*/
|
|
4433
|
+
export interface GetWorkflowExecutionRequest {
|
|
4434
|
+
/**
|
|
4435
|
+
* @public
|
|
4436
|
+
* <p>Use the unique identifier for a runtime instance of the workflow to get
|
|
4437
|
+
* runtime details.</p>
|
|
4438
|
+
*/
|
|
4439
|
+
workflowExecutionId: string | undefined;
|
|
4440
|
+
}
|
|
4441
|
+
/**
|
|
4442
|
+
* @public
|
|
4443
|
+
* @enum
|
|
4444
|
+
*/
|
|
4445
|
+
export declare const WorkflowExecutionStatus: {
|
|
4446
|
+
readonly CANCELLED: "CANCELLED";
|
|
4447
|
+
readonly COMPLETED: "COMPLETED";
|
|
4448
|
+
readonly FAILED: "FAILED";
|
|
4449
|
+
readonly PENDING: "PENDING";
|
|
4450
|
+
readonly ROLLBACK_COMPLETED: "ROLLBACK_COMPLETED";
|
|
4451
|
+
readonly ROLLBACK_IN_PROGRESS: "ROLLBACK_IN_PROGRESS";
|
|
4452
|
+
readonly RUNNING: "RUNNING";
|
|
4453
|
+
readonly SKIPPED: "SKIPPED";
|
|
4454
|
+
};
|
|
4455
|
+
/**
|
|
4456
|
+
* @public
|
|
4457
|
+
*/
|
|
4458
|
+
export type WorkflowExecutionStatus = (typeof WorkflowExecutionStatus)[keyof typeof WorkflowExecutionStatus];
|
|
4459
|
+
/**
|
|
4460
|
+
* @public
|
|
4461
|
+
*/
|
|
4462
|
+
export interface GetWorkflowExecutionResponse {
|
|
4463
|
+
/**
|
|
4464
|
+
* @public
|
|
4465
|
+
* <p>The request ID that uniquely identifies this request.</p>
|
|
4466
|
+
*/
|
|
4467
|
+
requestId?: string;
|
|
4468
|
+
/**
|
|
4469
|
+
* @public
|
|
4470
|
+
* <p>The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource
|
|
4471
|
+
* that defines the specified runtime instance of the workflow.</p>
|
|
4472
|
+
*/
|
|
4473
|
+
workflowBuildVersionArn?: string;
|
|
4474
|
+
/**
|
|
4475
|
+
* @public
|
|
4476
|
+
* <p>The unique identifier that Image Builder assigned to keep track of runtime details
|
|
4477
|
+
* when it ran the workflow.</p>
|
|
4478
|
+
*/
|
|
4479
|
+
workflowExecutionId?: string;
|
|
4480
|
+
/**
|
|
4481
|
+
* @public
|
|
4482
|
+
* <p>The Amazon Resource Name (ARN) of the image resource build version that the specified
|
|
4483
|
+
* runtime instance of the workflow created.</p>
|
|
4484
|
+
*/
|
|
4485
|
+
imageBuildVersionArn?: string;
|
|
4486
|
+
/**
|
|
4487
|
+
* @public
|
|
4488
|
+
* <p>The type of workflow that Image Builder ran for the specified runtime instance of the workflow.</p>
|
|
4489
|
+
*/
|
|
4490
|
+
type?: WorkflowType;
|
|
4491
|
+
/**
|
|
4492
|
+
* @public
|
|
4493
|
+
* <p>The current runtime status for the specified runtime instance of the workflow.</p>
|
|
4494
|
+
*/
|
|
4495
|
+
status?: WorkflowExecutionStatus;
|
|
4496
|
+
/**
|
|
4497
|
+
* @public
|
|
4498
|
+
* <p>The output message from the specified runtime instance of the workflow, if applicable.</p>
|
|
4499
|
+
*/
|
|
4500
|
+
message?: string;
|
|
4501
|
+
/**
|
|
4502
|
+
* @public
|
|
4503
|
+
* <p>The total number of steps in the specified runtime instance of the workflow that ran.
|
|
4504
|
+
* This number should equal the sum of the step counts for steps that succeeded, were skipped,
|
|
4505
|
+
* and failed.</p>
|
|
4506
|
+
*/
|
|
4507
|
+
totalStepCount?: number;
|
|
4136
4508
|
/**
|
|
4137
4509
|
* @public
|
|
4138
4510
|
* <p>A runtime count for the number of steps that ran successfully in the specified runtime
|
|
@@ -4161,6 +4533,12 @@ export interface GetWorkflowExecutionResponse {
|
|
|
4161
4533
|
* <p>The timestamp when the specified runtime instance of the workflow finished.</p>
|
|
4162
4534
|
*/
|
|
4163
4535
|
endTime?: string;
|
|
4536
|
+
/**
|
|
4537
|
+
* @public
|
|
4538
|
+
* <p>Test workflows are defined within named runtime groups. The parallel group
|
|
4539
|
+
* is a named group that contains one or more test workflows.</p>
|
|
4540
|
+
*/
|
|
4541
|
+
parallelGroup?: string;
|
|
4164
4542
|
}
|
|
4165
4543
|
/**
|
|
4166
4544
|
* @public
|
|
@@ -4192,6 +4570,7 @@ export type WorkflowStepExecutionRollbackStatus = (typeof WorkflowStepExecutionR
|
|
|
4192
4570
|
* @enum
|
|
4193
4571
|
*/
|
|
4194
4572
|
export declare const WorkflowStepExecutionStatus: {
|
|
4573
|
+
readonly CANCELLED: "CANCELLED";
|
|
4195
4574
|
readonly COMPLETED: "COMPLETED";
|
|
4196
4575
|
readonly FAILED: "FAILED";
|
|
4197
4576
|
readonly PENDING: "PENDING";
|
|
@@ -4348,7 +4727,7 @@ export interface ImportComponentRequest {
|
|
|
4348
4727
|
* @public
|
|
4349
4728
|
* <p>The change description of the component. This description indicates the change that
|
|
4350
4729
|
* has been made in this version, or what makes this version different from other versions
|
|
4351
|
-
* of
|
|
4730
|
+
* of the component.</p>
|
|
4352
4731
|
*/
|
|
4353
4732
|
changeDescription?: string;
|
|
4354
4733
|
/**
|
|
@@ -6291,7 +6670,7 @@ export interface LifecyclePolicySummary {
|
|
|
6291
6670
|
status?: LifecyclePolicyStatus;
|
|
6292
6671
|
/**
|
|
6293
6672
|
* @public
|
|
6294
|
-
* <p>The name of the IAM role that Image Builder uses to run the lifecycle policy.</p>
|
|
6673
|
+
* <p>The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy.</p>
|
|
6295
6674
|
*/
|
|
6296
6675
|
executionRole?: string;
|
|
6297
6676
|
/**
|
|
@@ -6373,6 +6752,180 @@ export interface ListTagsForResourceResponse {
|
|
|
6373
6752
|
*/
|
|
6374
6753
|
tags?: Record<string, string>;
|
|
6375
6754
|
}
|
|
6755
|
+
/**
|
|
6756
|
+
* @public
|
|
6757
|
+
*/
|
|
6758
|
+
export interface ListWaitingWorkflowStepsRequest {
|
|
6759
|
+
/**
|
|
6760
|
+
* @public
|
|
6761
|
+
* <p>The maximum items to return in a request.</p>
|
|
6762
|
+
*/
|
|
6763
|
+
maxResults?: number;
|
|
6764
|
+
/**
|
|
6765
|
+
* @public
|
|
6766
|
+
* <p>A token to specify where to start paginating. This is the nextToken
|
|
6767
|
+
* from a previously truncated response.</p>
|
|
6768
|
+
*/
|
|
6769
|
+
nextToken?: string;
|
|
6770
|
+
}
|
|
6771
|
+
/**
|
|
6772
|
+
* @public
|
|
6773
|
+
* <p>Contains runtime details for an instance of a workflow that ran for the
|
|
6774
|
+
* associated image build version.</p>
|
|
6775
|
+
*/
|
|
6776
|
+
export interface WorkflowStepExecution {
|
|
6777
|
+
/**
|
|
6778
|
+
* @public
|
|
6779
|
+
* <p>Uniquely identifies the workflow step that ran for the associated
|
|
6780
|
+
* image build version.</p>
|
|
6781
|
+
*/
|
|
6782
|
+
stepExecutionId?: string;
|
|
6783
|
+
/**
|
|
6784
|
+
* @public
|
|
6785
|
+
* <p>The Amazon Resource Name (ARN) of the image build version that ran the workflow.</p>
|
|
6786
|
+
*/
|
|
6787
|
+
imageBuildVersionArn?: string;
|
|
6788
|
+
/**
|
|
6789
|
+
* @public
|
|
6790
|
+
* <p>Uniquely identifies the runtime instance of the workflow that contains
|
|
6791
|
+
* the workflow step that ran for the associated image build version.</p>
|
|
6792
|
+
*/
|
|
6793
|
+
workflowExecutionId?: string;
|
|
6794
|
+
/**
|
|
6795
|
+
* @public
|
|
6796
|
+
* <p>The ARN of the workflow resource that ran.</p>
|
|
6797
|
+
*/
|
|
6798
|
+
workflowBuildVersionArn?: string;
|
|
6799
|
+
/**
|
|
6800
|
+
* @public
|
|
6801
|
+
* <p>The name of the workflow step.</p>
|
|
6802
|
+
*/
|
|
6803
|
+
name?: string;
|
|
6804
|
+
/**
|
|
6805
|
+
* @public
|
|
6806
|
+
* <p>The name of the step action.</p>
|
|
6807
|
+
*/
|
|
6808
|
+
action?: string;
|
|
6809
|
+
/**
|
|
6810
|
+
* @public
|
|
6811
|
+
* <p>The timestamp when the workflow step started.</p>
|
|
6812
|
+
*/
|
|
6813
|
+
startTime?: string;
|
|
6814
|
+
}
|
|
6815
|
+
/**
|
|
6816
|
+
* @public
|
|
6817
|
+
*/
|
|
6818
|
+
export interface ListWaitingWorkflowStepsResponse {
|
|
6819
|
+
/**
|
|
6820
|
+
* @public
|
|
6821
|
+
* <p>An array of the workflow steps that are waiting for action in your
|
|
6822
|
+
* Amazon Web Services account.</p>
|
|
6823
|
+
*/
|
|
6824
|
+
steps?: WorkflowStepExecution[];
|
|
6825
|
+
/**
|
|
6826
|
+
* @public
|
|
6827
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
6828
|
+
* there are additional elements that the service hasn't included in this request. Use this token
|
|
6829
|
+
* with the next request to retrieve additional objects.</p>
|
|
6830
|
+
*/
|
|
6831
|
+
nextToken?: string;
|
|
6832
|
+
}
|
|
6833
|
+
/**
|
|
6834
|
+
* @public
|
|
6835
|
+
*/
|
|
6836
|
+
export interface ListWorkflowBuildVersionsRequest {
|
|
6837
|
+
/**
|
|
6838
|
+
* @public
|
|
6839
|
+
* <p>The Amazon Resource Name (ARN) of the workflow resource for which to get a list of build versions.</p>
|
|
6840
|
+
*/
|
|
6841
|
+
workflowVersionArn: string | undefined;
|
|
6842
|
+
/**
|
|
6843
|
+
* @public
|
|
6844
|
+
* <p>The maximum items to return in a request.</p>
|
|
6845
|
+
*/
|
|
6846
|
+
maxResults?: number;
|
|
6847
|
+
/**
|
|
6848
|
+
* @public
|
|
6849
|
+
* <p>A token to specify where to start paginating. This is the nextToken
|
|
6850
|
+
* from a previously truncated response.</p>
|
|
6851
|
+
*/
|
|
6852
|
+
nextToken?: string;
|
|
6853
|
+
}
|
|
6854
|
+
/**
|
|
6855
|
+
* @public
|
|
6856
|
+
* <p>Contains metadata about the workflow resource.</p>
|
|
6857
|
+
*/
|
|
6858
|
+
export interface WorkflowSummary {
|
|
6859
|
+
/**
|
|
6860
|
+
* @public
|
|
6861
|
+
* <p>The Amazon Resource Name (ARN) of the workflow resource.</p>
|
|
6862
|
+
*/
|
|
6863
|
+
arn?: string;
|
|
6864
|
+
/**
|
|
6865
|
+
* @public
|
|
6866
|
+
* <p>The name of the workflow.</p>
|
|
6867
|
+
*/
|
|
6868
|
+
name?: string;
|
|
6869
|
+
/**
|
|
6870
|
+
* @public
|
|
6871
|
+
* <p>The version of the workflow.</p>
|
|
6872
|
+
*/
|
|
6873
|
+
version?: string;
|
|
6874
|
+
/**
|
|
6875
|
+
* @public
|
|
6876
|
+
* <p>Describes the workflow.</p>
|
|
6877
|
+
*/
|
|
6878
|
+
description?: string;
|
|
6879
|
+
/**
|
|
6880
|
+
* @public
|
|
6881
|
+
* <p>The change description for the current version of the workflow resource.</p>
|
|
6882
|
+
*/
|
|
6883
|
+
changeDescription?: string;
|
|
6884
|
+
/**
|
|
6885
|
+
* @public
|
|
6886
|
+
* <p>The image creation stage that this workflow applies to. Image Builder currently
|
|
6887
|
+
* supports build and test stage workflows.</p>
|
|
6888
|
+
*/
|
|
6889
|
+
type?: WorkflowType;
|
|
6890
|
+
/**
|
|
6891
|
+
* @public
|
|
6892
|
+
* <p>The owner of the workflow resource.</p>
|
|
6893
|
+
*/
|
|
6894
|
+
owner?: string;
|
|
6895
|
+
/**
|
|
6896
|
+
* @public
|
|
6897
|
+
* <p>Describes the current state of the workflow resource.</p>
|
|
6898
|
+
*/
|
|
6899
|
+
state?: WorkflowState;
|
|
6900
|
+
/**
|
|
6901
|
+
* @public
|
|
6902
|
+
* <p>The original creation date of the workflow resource.</p>
|
|
6903
|
+
*/
|
|
6904
|
+
dateCreated?: string;
|
|
6905
|
+
/**
|
|
6906
|
+
* @public
|
|
6907
|
+
* <p>Contains a list of tags that are defined for the workflow.</p>
|
|
6908
|
+
*/
|
|
6909
|
+
tags?: Record<string, string>;
|
|
6910
|
+
}
|
|
6911
|
+
/**
|
|
6912
|
+
* @public
|
|
6913
|
+
*/
|
|
6914
|
+
export interface ListWorkflowBuildVersionsResponse {
|
|
6915
|
+
/**
|
|
6916
|
+
* @public
|
|
6917
|
+
* <p>A list that contains metadata for the workflow builds that have run for
|
|
6918
|
+
* the workflow resource specified in the request.</p>
|
|
6919
|
+
*/
|
|
6920
|
+
workflowSummaryList?: WorkflowSummary[];
|
|
6921
|
+
/**
|
|
6922
|
+
* @public
|
|
6923
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
6924
|
+
* there are additional elements that the service hasn't included in this request. Use this token
|
|
6925
|
+
* with the next request to retrieve additional objects.</p>
|
|
6926
|
+
*/
|
|
6927
|
+
nextToken?: string;
|
|
6928
|
+
}
|
|
6376
6929
|
/**
|
|
6377
6930
|
* @public
|
|
6378
6931
|
*/
|
|
@@ -6457,6 +7010,11 @@ export interface WorkflowExecutionMetadata {
|
|
|
6457
7010
|
* <p>The timestamp when this runtime instance of the workflow finished.</p>
|
|
6458
7011
|
*/
|
|
6459
7012
|
endTime?: string;
|
|
7013
|
+
/**
|
|
7014
|
+
* @public
|
|
7015
|
+
* <p>The name of the test group that included the test workflow resource at runtime.</p>
|
|
7016
|
+
*/
|
|
7017
|
+
parallelGroup?: string;
|
|
6460
7018
|
}
|
|
6461
7019
|
/**
|
|
6462
7020
|
* @public
|
|
@@ -6492,6 +7050,96 @@ export interface ListWorkflowExecutionsResponse {
|
|
|
6492
7050
|
*/
|
|
6493
7051
|
nextToken?: string;
|
|
6494
7052
|
}
|
|
7053
|
+
/**
|
|
7054
|
+
* @public
|
|
7055
|
+
*/
|
|
7056
|
+
export interface ListWorkflowsRequest {
|
|
7057
|
+
/**
|
|
7058
|
+
* @public
|
|
7059
|
+
* <p>Used to get a list of workflow build version filtered by the identity of the creator.</p>
|
|
7060
|
+
*/
|
|
7061
|
+
owner?: Ownership;
|
|
7062
|
+
/**
|
|
7063
|
+
* @public
|
|
7064
|
+
* <p>Used to streamline search results.</p>
|
|
7065
|
+
*/
|
|
7066
|
+
filters?: Filter[];
|
|
7067
|
+
/**
|
|
7068
|
+
* @public
|
|
7069
|
+
* <p>Specify all or part of the workflow name to streamline results.</p>
|
|
7070
|
+
*/
|
|
7071
|
+
byName?: boolean;
|
|
7072
|
+
/**
|
|
7073
|
+
* @public
|
|
7074
|
+
* <p>The maximum items to return in a request.</p>
|
|
7075
|
+
*/
|
|
7076
|
+
maxResults?: number;
|
|
7077
|
+
/**
|
|
7078
|
+
* @public
|
|
7079
|
+
* <p>A token to specify where to start paginating. This is the nextToken
|
|
7080
|
+
* from a previously truncated response.</p>
|
|
7081
|
+
*/
|
|
7082
|
+
nextToken?: string;
|
|
7083
|
+
}
|
|
7084
|
+
/**
|
|
7085
|
+
* @public
|
|
7086
|
+
* <p>Contains details about this version of the workflow.</p>
|
|
7087
|
+
*/
|
|
7088
|
+
export interface WorkflowVersion {
|
|
7089
|
+
/**
|
|
7090
|
+
* @public
|
|
7091
|
+
* <p>The Amazon Resource Name (ARN) of the workflow resource.</p>
|
|
7092
|
+
*/
|
|
7093
|
+
arn?: string;
|
|
7094
|
+
/**
|
|
7095
|
+
* @public
|
|
7096
|
+
* <p>The name of the workflow.</p>
|
|
7097
|
+
*/
|
|
7098
|
+
name?: string;
|
|
7099
|
+
/**
|
|
7100
|
+
* @public
|
|
7101
|
+
* <p>The semantic version of the workflow resource. The format includes three nodes: <major>.<minor>.<patch>.</p>
|
|
7102
|
+
*/
|
|
7103
|
+
version?: string;
|
|
7104
|
+
/**
|
|
7105
|
+
* @public
|
|
7106
|
+
* <p>Describes the workflow.</p>
|
|
7107
|
+
*/
|
|
7108
|
+
description?: string;
|
|
7109
|
+
/**
|
|
7110
|
+
* @public
|
|
7111
|
+
* <p>The image creation stage that this workflow applies to. Image Builder currently
|
|
7112
|
+
* supports build and test stage workflows.</p>
|
|
7113
|
+
*/
|
|
7114
|
+
type?: WorkflowType;
|
|
7115
|
+
/**
|
|
7116
|
+
* @public
|
|
7117
|
+
* <p>The owner of the workflow resource.</p>
|
|
7118
|
+
*/
|
|
7119
|
+
owner?: string;
|
|
7120
|
+
/**
|
|
7121
|
+
* @public
|
|
7122
|
+
* <p>The timestamp when Image Builder created the workflow version.</p>
|
|
7123
|
+
*/
|
|
7124
|
+
dateCreated?: string;
|
|
7125
|
+
}
|
|
7126
|
+
/**
|
|
7127
|
+
* @public
|
|
7128
|
+
*/
|
|
7129
|
+
export interface ListWorkflowsResponse {
|
|
7130
|
+
/**
|
|
7131
|
+
* @public
|
|
7132
|
+
* <p>A list of workflow build versions that match the request criteria.</p>
|
|
7133
|
+
*/
|
|
7134
|
+
workflowVersionList?: WorkflowVersion[];
|
|
7135
|
+
/**
|
|
7136
|
+
* @public
|
|
7137
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
7138
|
+
* there are additional elements that the service hasn't included in this request. Use this token
|
|
7139
|
+
* with the next request to retrieve additional objects.</p>
|
|
7140
|
+
*/
|
|
7141
|
+
nextToken?: string;
|
|
7142
|
+
}
|
|
6495
7143
|
/**
|
|
6496
7144
|
* @public
|
|
6497
7145
|
*/
|
|
@@ -6760,6 +7408,72 @@ export interface PutImageRecipePolicyResponse {
|
|
|
6760
7408
|
*/
|
|
6761
7409
|
imageRecipeArn?: string;
|
|
6762
7410
|
}
|
|
7411
|
+
/**
|
|
7412
|
+
* @public
|
|
7413
|
+
* @enum
|
|
7414
|
+
*/
|
|
7415
|
+
export declare const WorkflowStepActionType: {
|
|
7416
|
+
readonly RESUME: "RESUME";
|
|
7417
|
+
readonly STOP: "STOP";
|
|
7418
|
+
};
|
|
7419
|
+
/**
|
|
7420
|
+
* @public
|
|
7421
|
+
*/
|
|
7422
|
+
export type WorkflowStepActionType = (typeof WorkflowStepActionType)[keyof typeof WorkflowStepActionType];
|
|
7423
|
+
/**
|
|
7424
|
+
* @public
|
|
7425
|
+
*/
|
|
7426
|
+
export interface SendWorkflowStepActionRequest {
|
|
7427
|
+
/**
|
|
7428
|
+
* @public
|
|
7429
|
+
* <p>Uniquely identifies the workflow step that sent the step action.</p>
|
|
7430
|
+
*/
|
|
7431
|
+
stepExecutionId: string | undefined;
|
|
7432
|
+
/**
|
|
7433
|
+
* @public
|
|
7434
|
+
* <p>The Amazon Resource Name (ARN) of the image build version to send action for.</p>
|
|
7435
|
+
*/
|
|
7436
|
+
imageBuildVersionArn: string | undefined;
|
|
7437
|
+
/**
|
|
7438
|
+
* @public
|
|
7439
|
+
* <p>The action for the image creation process to take while a workflow
|
|
7440
|
+
* <code>WaitForAction</code> step waits for an asynchronous action to complete.</p>
|
|
7441
|
+
*/
|
|
7442
|
+
action: WorkflowStepActionType | undefined;
|
|
7443
|
+
/**
|
|
7444
|
+
* @public
|
|
7445
|
+
* <p>The reason why this action is sent.</p>
|
|
7446
|
+
*/
|
|
7447
|
+
reason?: string;
|
|
7448
|
+
/**
|
|
7449
|
+
* @public
|
|
7450
|
+
* <p>Unique, case-sensitive identifier you provide to ensure
|
|
7451
|
+
* idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>
|
|
7452
|
+
* in the <i>Amazon EC2 API Reference</i>.</p>
|
|
7453
|
+
*/
|
|
7454
|
+
clientToken?: string;
|
|
7455
|
+
}
|
|
7456
|
+
/**
|
|
7457
|
+
* @public
|
|
7458
|
+
*/
|
|
7459
|
+
export interface SendWorkflowStepActionResponse {
|
|
7460
|
+
/**
|
|
7461
|
+
* @public
|
|
7462
|
+
* <p>The workflow step that sent the step action.</p>
|
|
7463
|
+
*/
|
|
7464
|
+
stepExecutionId?: string;
|
|
7465
|
+
/**
|
|
7466
|
+
* @public
|
|
7467
|
+
* <p>The Amazon Resource Name (ARN) of the image build version that received the action
|
|
7468
|
+
* request.</p>
|
|
7469
|
+
*/
|
|
7470
|
+
imageBuildVersionArn?: string;
|
|
7471
|
+
/**
|
|
7472
|
+
* @public
|
|
7473
|
+
* <p>The client token that uniquely identifies the request.</p>
|
|
7474
|
+
*/
|
|
7475
|
+
clientToken?: string;
|
|
7476
|
+
}
|
|
6763
7477
|
/**
|
|
6764
7478
|
* @public
|
|
6765
7479
|
*/
|
|
@@ -7075,6 +7789,17 @@ export interface UpdateImagePipelineRequest {
|
|
|
7075
7789
|
* <p>Contains settings for vulnerability scans.</p>
|
|
7076
7790
|
*/
|
|
7077
7791
|
imageScanningConfiguration?: ImageScanningConfiguration;
|
|
7792
|
+
/**
|
|
7793
|
+
* @public
|
|
7794
|
+
* <p>Contains the workflows to run for the pipeline.</p>
|
|
7795
|
+
*/
|
|
7796
|
+
workflows?: WorkflowConfiguration[];
|
|
7797
|
+
/**
|
|
7798
|
+
* @public
|
|
7799
|
+
* <p>The name or Amazon Resource Name (ARN) for the IAM role you create that grants
|
|
7800
|
+
* Image Builder access to perform workflow actions.</p>
|
|
7801
|
+
*/
|
|
7802
|
+
executionRole?: string;
|
|
7078
7803
|
}
|
|
7079
7804
|
/**
|
|
7080
7805
|
* @public
|
|
@@ -7243,7 +7968,7 @@ export interface UpdateLifecyclePolicyRequest {
|
|
|
7243
7968
|
status?: LifecyclePolicyStatus;
|
|
7244
7969
|
/**
|
|
7245
7970
|
* @public
|
|
7246
|
-
* <p>The name of the IAM role that Image Builder
|
|
7971
|
+
* <p>The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to update the
|
|
7247
7972
|
* lifecycle policy.</p>
|
|
7248
7973
|
*/
|
|
7249
7974
|
executionRole: string | undefined;
|