@aws-sdk/client-imagebuilder 3.300.0 → 3.303.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 +51 -3
- package/dist-cjs/Imagebuilder.js +90 -0
- package/dist-cjs/commands/GetWorkflowExecutionCommand.js +45 -0
- package/dist-cjs/commands/GetWorkflowStepExecutionCommand.js +45 -0
- package/dist-cjs/commands/ListImageScanFindingAggregationsCommand.js +45 -0
- package/dist-cjs/commands/ListImageScanFindingsCommand.js +45 -0
- package/dist-cjs/commands/ListWorkflowExecutionsCommand.js +45 -0
- package/dist-cjs/commands/ListWorkflowStepExecutionsCommand.js +45 -0
- package/dist-cjs/commands/index.js +6 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +113 -92
- package/dist-cjs/pagination/ListImageScanFindingAggregationsPaginator.js +28 -0
- package/dist-cjs/pagination/ListImageScanFindingsPaginator.js +29 -0
- package/dist-cjs/pagination/ListWorkflowExecutionsPaginator.js +29 -0
- package/dist-cjs/pagination/ListWorkflowStepExecutionsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +4 -0
- package/dist-cjs/protocols/Aws_restJson1.js +945 -13
- package/dist-es/Imagebuilder.js +90 -0
- package/dist-es/commands/GetWorkflowExecutionCommand.js +41 -0
- package/dist-es/commands/GetWorkflowStepExecutionCommand.js +41 -0
- package/dist-es/commands/ListImageScanFindingAggregationsCommand.js +41 -0
- package/dist-es/commands/ListImageScanFindingsCommand.js +41 -0
- package/dist-es/commands/ListWorkflowExecutionsCommand.js +41 -0
- package/dist-es/commands/ListWorkflowStepExecutionsCommand.js +41 -0
- package/dist-es/commands/index.js +6 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +112 -91
- package/dist-es/pagination/ListImageScanFindingAggregationsPaginator.js +24 -0
- package/dist-es/pagination/ListImageScanFindingsPaginator.js +25 -0
- package/dist-es/pagination/ListWorkflowExecutionsPaginator.js +25 -0
- package/dist-es/pagination/ListWorkflowStepExecutionsPaginator.js +25 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +931 -12
- package/dist-types/Imagebuilder.d.ts +165 -75
- package/dist-types/ImagebuilderClient.d.ts +11 -5
- package/dist-types/commands/CancelImageCreationCommand.d.ts +9 -8
- package/dist-types/commands/CreateComponentCommand.d.ts +19 -16
- package/dist-types/commands/CreateContainerRecipeCommand.d.ts +25 -21
- package/dist-types/commands/CreateDistributionConfigurationCommand.d.ts +35 -32
- package/dist-types/commands/CreateImageCommand.d.ts +26 -13
- package/dist-types/commands/CreateImagePipelineCommand.d.ts +25 -13
- package/dist-types/commands/CreateImageRecipeCommand.d.ts +25 -22
- package/dist-types/commands/CreateInfrastructureConfigurationCommand.d.ts +21 -18
- package/dist-types/commands/DeleteComponentCommand.d.ts +10 -9
- package/dist-types/commands/DeleteContainerRecipeCommand.d.ts +9 -8
- package/dist-types/commands/DeleteDistributionConfigurationCommand.d.ts +10 -9
- package/dist-types/commands/DeleteImageCommand.d.ts +17 -15
- package/dist-types/commands/DeleteImagePipelineCommand.d.ts +10 -9
- package/dist-types/commands/DeleteImageRecipeCommand.d.ts +10 -9
- package/dist-types/commands/DeleteInfrastructureConfigurationCommand.d.ts +10 -9
- package/dist-types/commands/GetComponentCommand.d.ts +8 -7
- package/dist-types/commands/GetComponentPolicyCommand.d.ts +5 -4
- package/dist-types/commands/GetContainerRecipeCommand.d.ts +7 -6
- package/dist-types/commands/GetContainerRecipePolicyCommand.d.ts +4 -3
- package/dist-types/commands/GetDistributionConfigurationCommand.d.ts +8 -7
- package/dist-types/commands/GetImageCommand.d.ts +8 -7
- package/dist-types/commands/GetImagePipelineCommand.d.ts +8 -7
- package/dist-types/commands/GetImagePolicyCommand.d.ts +5 -4
- package/dist-types/commands/GetImageRecipeCommand.d.ts +8 -7
- package/dist-types/commands/GetImageRecipePolicyCommand.d.ts +5 -4
- package/dist-types/commands/GetInfrastructureConfigurationCommand.d.ts +8 -7
- package/dist-types/commands/GetWorkflowExecutionCommand.d.ts +85 -0
- package/dist-types/commands/GetWorkflowStepExecutionCommand.d.ts +85 -0
- package/dist-types/commands/ImportComponentCommand.d.ts +12 -11
- package/dist-types/commands/ImportVmImageCommand.d.ts +14 -14
- package/dist-types/commands/ListComponentBuildVersionsCommand.d.ts +9 -7
- package/dist-types/commands/ListComponentsCommand.d.ts +13 -12
- package/dist-types/commands/ListContainerRecipesCommand.d.ts +10 -9
- package/dist-types/commands/ListDistributionConfigurationsCommand.d.ts +10 -9
- package/dist-types/commands/ListImageBuildVersionsCommand.d.ts +11 -10
- package/dist-types/commands/ListImagePackagesCommand.d.ts +9 -7
- package/dist-types/commands/ListImagePipelineImagesCommand.d.ts +10 -9
- package/dist-types/commands/ListImagePipelinesCommand.d.ts +10 -9
- package/dist-types/commands/ListImageRecipesCommand.d.ts +11 -10
- package/dist-types/commands/ListImageScanFindingAggregationsCommand.d.ts +120 -0
- package/dist-types/commands/ListImageScanFindingsCommand.d.ts +96 -0
- package/dist-types/commands/ListImagesCommand.d.ts +12 -11
- package/dist-types/commands/ListInfrastructureConfigurationsCommand.d.ts +11 -10
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -3
- package/dist-types/commands/ListWorkflowExecutionsCommand.d.ts +90 -0
- package/dist-types/commands/ListWorkflowStepExecutionsCommand.d.ts +90 -0
- package/dist-types/commands/PutComponentPolicyCommand.d.ts +10 -9
- package/dist-types/commands/PutContainerRecipePolicyCommand.d.ts +15 -7
- package/dist-types/commands/PutImagePolicyCommand.d.ts +9 -8
- package/dist-types/commands/PutImageRecipePolicyCommand.d.ts +10 -9
- package/dist-types/commands/StartImagePipelineExecutionCommand.d.ts +10 -9
- package/dist-types/commands/TagResourceCommand.d.ts +5 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +5 -4
- package/dist-types/commands/UpdateDistributionConfigurationCommand.d.ts +31 -30
- package/dist-types/commands/UpdateImagePipelineCommand.d.ts +24 -14
- package/dist-types/commands/UpdateInfrastructureConfigurationCommand.d.ts +17 -16
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +1712 -524
- package/dist-types/pagination/ListImageScanFindingAggregationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListImageScanFindingsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListWorkflowExecutionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListWorkflowStepExecutionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/Imagebuilder.d.ts +102 -0
- package/dist-types/ts3.4/ImagebuilderClient.d.ts +36 -0
- package/dist-types/ts3.4/commands/GetWorkflowExecutionCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetWorkflowStepExecutionCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListImageScanFindingAggregationsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListImageScanFindingsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListWorkflowExecutionsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListWorkflowStepExecutionsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +6 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +372 -76
- package/dist-types/ts3.4/pagination/ListImageScanFindingAggregationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListImageScanFindingsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListWorkflowExecutionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListWorkflowStepExecutionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +72 -0
- package/package.json +34 -34
|
@@ -1,28 +1,69 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { ImagebuilderServiceException as __BaseException } from "./ImagebuilderServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
* <p>Includes counts by severity level for medium severity and higher level findings, plus a total
|
|
6
|
+
* for all of the findings for the specified filter.</p>
|
|
7
|
+
*/
|
|
8
|
+
export interface SeverityCounts {
|
|
9
|
+
/**
|
|
10
|
+
* <p>The total number of findings across all severity levels for the specified filter.</p>
|
|
11
|
+
*/
|
|
12
|
+
all?: number;
|
|
13
|
+
/**
|
|
14
|
+
* <p>The number of critical severity findings for the specified filter.</p>
|
|
15
|
+
*/
|
|
16
|
+
critical?: number;
|
|
17
|
+
/**
|
|
18
|
+
* <p>The number of high severity findings for the specified filter.</p>
|
|
19
|
+
*/
|
|
20
|
+
high?: number;
|
|
21
|
+
/**
|
|
22
|
+
* <p>The number of medium severity findings for the specified filter.</p>
|
|
23
|
+
*/
|
|
24
|
+
medium?: number;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* @public
|
|
28
|
+
* <p>Contains counts of vulnerability findings from image scans that run when you create
|
|
29
|
+
* new Image Builder images, or build new versions of existing images. The vulnerability counts are
|
|
30
|
+
* grouped by severity level. The counts are aggregated across resources to create the
|
|
31
|
+
* final tally for the account that owns them.</p>
|
|
32
|
+
*/
|
|
33
|
+
export interface AccountAggregation {
|
|
34
|
+
/**
|
|
35
|
+
* <p>Identifies the account that owns the aggregated resource findings.</p>
|
|
36
|
+
*/
|
|
37
|
+
accountId?: string;
|
|
38
|
+
/**
|
|
39
|
+
* <p>Counts by severity level for medium severity and higher level findings, plus a total
|
|
40
|
+
* for all of the findings.</p>
|
|
41
|
+
*/
|
|
42
|
+
severityCounts?: SeverityCounts;
|
|
43
|
+
}
|
|
3
44
|
/**
|
|
4
45
|
* @public
|
|
5
46
|
* <p>Contains settings for the Systems Manager agent on your build instance.</p>
|
|
6
47
|
*/
|
|
7
48
|
export interface SystemsManagerAgent {
|
|
8
49
|
/**
|
|
9
|
-
* <p>Controls whether the Systems Manager agent is removed from your final build image, prior to
|
|
10
|
-
* the new AMI. If this is set to true, then the agent is removed from the final
|
|
11
|
-
* set to false, then the agent is left in, so that it is included in the
|
|
12
|
-
* value is false.</p>
|
|
50
|
+
* <p>Controls whether the Systems Manager agent is removed from your final build image, prior to
|
|
51
|
+
* creating the new AMI. If this is set to true, then the agent is removed from the final
|
|
52
|
+
* image. If it's set to false, then the agent is left in, so that it is included in the
|
|
53
|
+
* new AMI. The default value is false.</p>
|
|
13
54
|
*/
|
|
14
55
|
uninstallAfterBuild?: boolean;
|
|
15
56
|
}
|
|
16
57
|
/**
|
|
17
58
|
* @public
|
|
18
|
-
* <p>In addition to your infrastructure configuration, these settings provide an extra
|
|
19
|
-
* control over your build instances. You can also specify commands to run on
|
|
20
|
-
* your build instances.</p>
|
|
21
|
-
* <p>Image Builder does not automatically install the Systems Manager agent on Windows instances. If your
|
|
22
|
-
*
|
|
23
|
-
* agent. For Linux instances, if the base image does not already include the Systems Manager agent,
|
|
24
|
-
* installs it. For Linux instances where Image Builder installs the Systems Manager agent, you can
|
|
25
|
-
* whether to keep it for the AMI that you create.</p>
|
|
59
|
+
* <p>In addition to your infrastructure configuration, these settings provide an extra
|
|
60
|
+
* layer of control over your build instances. You can also specify commands to run on
|
|
61
|
+
* launch for all of your build instances.</p>
|
|
62
|
+
* <p>Image Builder does not automatically install the Systems Manager agent on Windows instances. If your base
|
|
63
|
+
* image includes the Systems Manager agent, then the AMI that you create will also include the
|
|
64
|
+
* agent. For Linux instances, if the base image does not already include the Systems Manager agent,
|
|
65
|
+
* Image Builder installs it. For Linux instances where Image Builder installs the Systems Manager agent, you can
|
|
66
|
+
* choose whether to keep it for the AMI that you create.</p>
|
|
26
67
|
*/
|
|
27
68
|
export interface AdditionalInstanceConfiguration {
|
|
28
69
|
/**
|
|
@@ -30,15 +71,16 @@ export interface AdditionalInstanceConfiguration {
|
|
|
30
71
|
*/
|
|
31
72
|
systemsManagerAgent?: SystemsManagerAgent;
|
|
32
73
|
/**
|
|
33
|
-
* <p>Use this property to provide commands or a command script to run when you launch
|
|
34
|
-
*
|
|
35
|
-
* <p>The userDataOverride property replaces any commands that Image Builder might have added to
|
|
36
|
-
* that Systems Manager is installed on your Linux build instance. If you override the user
|
|
37
|
-
* make sure that you add commands to install Systems Manager, if it is not pre-installed on
|
|
38
|
-
* base image.</p>
|
|
74
|
+
* <p>Use this property to provide commands or a command script to run when you launch your
|
|
75
|
+
* build instance.</p>
|
|
76
|
+
* <p>The userDataOverride property replaces any commands that Image Builder might have added to
|
|
77
|
+
* ensure that Systems Manager is installed on your Linux build instance. If you override the user
|
|
78
|
+
* data, make sure that you add commands to install Systems Manager, if it is not pre-installed on
|
|
79
|
+
* your base image.</p>
|
|
39
80
|
* <note>
|
|
40
|
-
* <p>The user data is always base 64 encoded. For example, the
|
|
41
|
-
*
|
|
81
|
+
* <p>The user data is always base 64 encoded. For example, the following commands are
|
|
82
|
+
* encoded as
|
|
83
|
+
* <code>IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$</code>:</p>
|
|
42
84
|
* <p>
|
|
43
85
|
* <i>#!/bin/bash</i>
|
|
44
86
|
* </p>
|
|
@@ -50,23 +92,28 @@ export interface AdditionalInstanceConfiguration {
|
|
|
50
92
|
}
|
|
51
93
|
/**
|
|
52
94
|
* @public
|
|
95
|
+
* @enum
|
|
53
96
|
*/
|
|
54
|
-
export declare
|
|
55
|
-
AVAILABLE
|
|
56
|
-
BUILDING
|
|
57
|
-
CANCELLED
|
|
58
|
-
CREATING
|
|
59
|
-
DELETED
|
|
60
|
-
DEPRECATED
|
|
61
|
-
DISTRIBUTING
|
|
62
|
-
FAILED
|
|
63
|
-
INTEGRATING
|
|
64
|
-
PENDING
|
|
65
|
-
TESTING
|
|
66
|
-
}
|
|
97
|
+
export declare const ImageStatus: {
|
|
98
|
+
readonly AVAILABLE: "AVAILABLE";
|
|
99
|
+
readonly BUILDING: "BUILDING";
|
|
100
|
+
readonly CANCELLED: "CANCELLED";
|
|
101
|
+
readonly CREATING: "CREATING";
|
|
102
|
+
readonly DELETED: "DELETED";
|
|
103
|
+
readonly DEPRECATED: "DEPRECATED";
|
|
104
|
+
readonly DISTRIBUTING: "DISTRIBUTING";
|
|
105
|
+
readonly FAILED: "FAILED";
|
|
106
|
+
readonly INTEGRATING: "INTEGRATING";
|
|
107
|
+
readonly PENDING: "PENDING";
|
|
108
|
+
readonly TESTING: "TESTING";
|
|
109
|
+
};
|
|
110
|
+
/**
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
export type ImageStatus = (typeof ImageStatus)[keyof typeof ImageStatus];
|
|
67
114
|
/**
|
|
68
115
|
* @public
|
|
69
|
-
* <p>
|
|
116
|
+
* <p>Image status and the reason for that status.</p>
|
|
70
117
|
*/
|
|
71
118
|
export interface ImageState {
|
|
72
119
|
/**
|
|
@@ -74,13 +121,13 @@ export interface ImageState {
|
|
|
74
121
|
*/
|
|
75
122
|
status?: ImageStatus | string;
|
|
76
123
|
/**
|
|
77
|
-
* <p>The reason for the image
|
|
124
|
+
* <p>The reason for the status of the image.</p>
|
|
78
125
|
*/
|
|
79
126
|
reason?: string;
|
|
80
127
|
}
|
|
81
128
|
/**
|
|
82
129
|
* @public
|
|
83
|
-
* <p>
|
|
130
|
+
* <p>Details of an Amazon EC2 AMI.</p>
|
|
84
131
|
*/
|
|
85
132
|
export interface Ami {
|
|
86
133
|
/**
|
|
@@ -100,7 +147,7 @@ export interface Ami {
|
|
|
100
147
|
*/
|
|
101
148
|
description?: string;
|
|
102
149
|
/**
|
|
103
|
-
* <p>
|
|
150
|
+
* <p>Image status and the reason for that status.</p>
|
|
104
151
|
*/
|
|
105
152
|
state?: ImageState;
|
|
106
153
|
/**
|
|
@@ -110,11 +157,13 @@ export interface Ami {
|
|
|
110
157
|
}
|
|
111
158
|
/**
|
|
112
159
|
* @public
|
|
113
|
-
* <p>Describes the configuration for a launch permission. The launch permission
|
|
114
|
-
* request is sent to the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html">Amazon EC2
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
160
|
+
* <p>Describes the configuration for a launch permission. The launch permission
|
|
161
|
+
* modification request is sent to the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html">Amazon EC2
|
|
162
|
+
* ModifyImageAttribute</a> API on behalf of the user for each Region they have
|
|
163
|
+
* selected to distribute the AMI. To make an AMI public, set the launch permission
|
|
164
|
+
* authorized accounts to <code>all</code>. See the examples for making an AMI public at
|
|
165
|
+
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html">Amazon EC2
|
|
166
|
+
* ModifyImageAttribute</a>.</p>
|
|
118
167
|
*/
|
|
119
168
|
export interface LaunchPermissionConfiguration {
|
|
120
169
|
/**
|
|
@@ -126,19 +175,21 @@ export interface LaunchPermissionConfiguration {
|
|
|
126
175
|
*/
|
|
127
176
|
userGroups?: string[];
|
|
128
177
|
/**
|
|
129
|
-
* <p>The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more
|
|
130
|
-
* <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">What is
|
|
178
|
+
* <p>The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more
|
|
179
|
+
* information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">What is
|
|
180
|
+
* Organizations?</a>.</p>
|
|
131
181
|
*/
|
|
132
182
|
organizationArns?: string[];
|
|
133
183
|
/**
|
|
134
|
-
* <p>The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.
|
|
135
|
-
* information about key concepts for Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html">Organizations
|
|
184
|
+
* <p>The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.
|
|
185
|
+
* For more information about key concepts for Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html">Organizations
|
|
186
|
+
* terminology and concepts</a>.</p>
|
|
136
187
|
*/
|
|
137
188
|
organizationalUnitArns?: string[];
|
|
138
189
|
}
|
|
139
190
|
/**
|
|
140
191
|
* @public
|
|
141
|
-
* <p>
|
|
192
|
+
* <p>Define and configure the output AMIs of the pipeline.</p>
|
|
142
193
|
*/
|
|
143
194
|
export interface AmiDistributionConfiguration {
|
|
144
195
|
/**
|
|
@@ -146,7 +197,8 @@ export interface AmiDistributionConfiguration {
|
|
|
146
197
|
*/
|
|
147
198
|
name?: string;
|
|
148
199
|
/**
|
|
149
|
-
* <p>The description of the AMI distribution configuration. Minimum and maximum length are
|
|
200
|
+
* <p>The description of the AMI distribution configuration. Minimum and maximum length are
|
|
201
|
+
* in characters.</p>
|
|
150
202
|
*/
|
|
151
203
|
description?: string;
|
|
152
204
|
/**
|
|
@@ -162,19 +214,24 @@ export interface AmiDistributionConfiguration {
|
|
|
162
214
|
*/
|
|
163
215
|
kmsKeyId?: string;
|
|
164
216
|
/**
|
|
165
|
-
* <p>
|
|
166
|
-
* instances.</p>
|
|
217
|
+
* <p>Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to
|
|
218
|
+
* launch instances.</p>
|
|
167
219
|
*/
|
|
168
220
|
launchPermission?: LaunchPermissionConfiguration;
|
|
169
221
|
}
|
|
170
222
|
/**
|
|
171
223
|
* @public
|
|
224
|
+
* @enum
|
|
172
225
|
*/
|
|
173
|
-
export declare
|
|
174
|
-
IMPORT
|
|
175
|
-
SCHEDULED
|
|
176
|
-
USER_INITIATED
|
|
177
|
-
}
|
|
226
|
+
export declare const BuildType: {
|
|
227
|
+
readonly IMPORT: "IMPORT";
|
|
228
|
+
readonly SCHEDULED: "SCHEDULED";
|
|
229
|
+
readonly USER_INITIATED: "USER_INITIATED";
|
|
230
|
+
};
|
|
231
|
+
/**
|
|
232
|
+
* @public
|
|
233
|
+
*/
|
|
234
|
+
export type BuildType = (typeof BuildType)[keyof typeof BuildType];
|
|
178
235
|
/**
|
|
179
236
|
* @public
|
|
180
237
|
* <p>You have exceeded the permitted request rate for the specific operation.</p>
|
|
@@ -192,7 +249,8 @@ export declare class CallRateLimitExceededException extends __BaseException {
|
|
|
192
249
|
*/
|
|
193
250
|
export interface CancelImageCreationRequest {
|
|
194
251
|
/**
|
|
195
|
-
* <p>The Amazon Resource Name (ARN) of the image
|
|
252
|
+
* <p>The Amazon Resource Name (ARN) of the image that you want to cancel creation
|
|
253
|
+
* for.</p>
|
|
196
254
|
*/
|
|
197
255
|
imageBuildVersionArn: string | undefined;
|
|
198
256
|
/**
|
|
@@ -215,15 +273,15 @@ export interface CancelImageCreationResponse {
|
|
|
215
273
|
*/
|
|
216
274
|
clientToken?: string;
|
|
217
275
|
/**
|
|
218
|
-
* <p>The
|
|
276
|
+
* <p>The ARN of the image whose creation this request canceled.</p>
|
|
219
277
|
*/
|
|
220
278
|
imageBuildVersionArn?: string;
|
|
221
279
|
}
|
|
222
280
|
/**
|
|
223
281
|
* @public
|
|
224
|
-
* <p>These errors are usually caused by a client action, such as using an action or
|
|
225
|
-
* behalf of a user that doesn't have permissions to use the action or
|
|
226
|
-
* invalid resource identifier.</p>
|
|
282
|
+
* <p>These errors are usually caused by a client action, such as using an action or
|
|
283
|
+
* resource on behalf of a user that doesn't have permissions to use the action or
|
|
284
|
+
* resource, or specifying an invalid resource identifier.</p>
|
|
227
285
|
*/
|
|
228
286
|
export declare class ClientException extends __BaseException {
|
|
229
287
|
readonly name: "ClientException";
|
|
@@ -247,8 +305,8 @@ export declare class ForbiddenException extends __BaseException {
|
|
|
247
305
|
}
|
|
248
306
|
/**
|
|
249
307
|
* @public
|
|
250
|
-
* <p>You have specified a client token for an operation using parameter values that differ
|
|
251
|
-
* a previous request that used the same client token.</p>
|
|
308
|
+
* <p>You have specified a client token for an operation using parameter values that differ
|
|
309
|
+
* from a previous request that used the same client token.</p>
|
|
252
310
|
*/
|
|
253
311
|
export declare class IdempotentParameterMismatchException extends __BaseException {
|
|
254
312
|
readonly name: "IdempotentParameterMismatchException";
|
|
@@ -260,7 +318,7 @@ export declare class IdempotentParameterMismatchException extends __BaseExceptio
|
|
|
260
318
|
}
|
|
261
319
|
/**
|
|
262
320
|
* @public
|
|
263
|
-
* <p>You have
|
|
321
|
+
* <p>You have requested an action that that the service doesn't support.</p>
|
|
264
322
|
*/
|
|
265
323
|
export declare class InvalidRequestException extends __BaseException {
|
|
266
324
|
readonly name: "InvalidRequestException";
|
|
@@ -285,7 +343,8 @@ export declare class ResourceInUseException extends __BaseException {
|
|
|
285
343
|
}
|
|
286
344
|
/**
|
|
287
345
|
* @public
|
|
288
|
-
* <p>This exception is thrown when the service encounters an unrecoverable
|
|
346
|
+
* <p>This exception is thrown when the service encounters an unrecoverable
|
|
347
|
+
* exception.</p>
|
|
289
348
|
*/
|
|
290
349
|
export declare class ServiceException extends __BaseException {
|
|
291
350
|
readonly name: "ServiceException";
|
|
@@ -309,7 +368,8 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
309
368
|
}
|
|
310
369
|
/**
|
|
311
370
|
* @public
|
|
312
|
-
* <p>Defines a parameter that is used to provide configuration details for the
|
|
371
|
+
* <p>Defines a parameter that is used to provide configuration details for the
|
|
372
|
+
* component.</p>
|
|
313
373
|
*/
|
|
314
374
|
export interface ComponentParameterDetail {
|
|
315
375
|
/**
|
|
@@ -317,7 +377,8 @@ export interface ComponentParameterDetail {
|
|
|
317
377
|
*/
|
|
318
378
|
name: string | undefined;
|
|
319
379
|
/**
|
|
320
|
-
* <p>The type of input this parameter provides. The currently supported value is
|
|
380
|
+
* <p>The type of input this parameter provides. The currently supported value is
|
|
381
|
+
* "string".</p>
|
|
321
382
|
*/
|
|
322
383
|
type: string | undefined;
|
|
323
384
|
/**
|
|
@@ -331,21 +392,31 @@ export interface ComponentParameterDetail {
|
|
|
331
392
|
}
|
|
332
393
|
/**
|
|
333
394
|
* @public
|
|
395
|
+
* @enum
|
|
334
396
|
*/
|
|
335
|
-
export declare
|
|
336
|
-
LINUX
|
|
337
|
-
WINDOWS
|
|
338
|
-
}
|
|
397
|
+
export declare const Platform: {
|
|
398
|
+
readonly LINUX: "Linux";
|
|
399
|
+
readonly WINDOWS: "Windows";
|
|
400
|
+
};
|
|
339
401
|
/**
|
|
340
402
|
* @public
|
|
341
403
|
*/
|
|
342
|
-
export
|
|
343
|
-
|
|
344
|
-
|
|
404
|
+
export type Platform = (typeof Platform)[keyof typeof Platform];
|
|
405
|
+
/**
|
|
406
|
+
* @public
|
|
407
|
+
* @enum
|
|
408
|
+
*/
|
|
409
|
+
export declare const ComponentStatus: {
|
|
410
|
+
readonly DEPRECATED: "DEPRECATED";
|
|
411
|
+
};
|
|
412
|
+
/**
|
|
413
|
+
* @public
|
|
414
|
+
*/
|
|
415
|
+
export type ComponentStatus = (typeof ComponentStatus)[keyof typeof ComponentStatus];
|
|
345
416
|
/**
|
|
346
417
|
* @public
|
|
347
|
-
* <p>A group of fields that describe the current status of components
|
|
348
|
-
*
|
|
418
|
+
* <p>A group of fields that describe the current status of components that are no longer
|
|
419
|
+
* active.</p>
|
|
349
420
|
*/
|
|
350
421
|
export interface ComponentState {
|
|
351
422
|
/**
|
|
@@ -359,11 +430,16 @@ export interface ComponentState {
|
|
|
359
430
|
}
|
|
360
431
|
/**
|
|
361
432
|
* @public
|
|
433
|
+
* @enum
|
|
362
434
|
*/
|
|
363
|
-
export declare
|
|
364
|
-
BUILD
|
|
365
|
-
TEST
|
|
366
|
-
}
|
|
435
|
+
export declare const ComponentType: {
|
|
436
|
+
readonly BUILD: "BUILD";
|
|
437
|
+
readonly TEST: "TEST";
|
|
438
|
+
};
|
|
439
|
+
/**
|
|
440
|
+
* @public
|
|
441
|
+
*/
|
|
442
|
+
export type ComponentType = (typeof ComponentType)[keyof typeof ComponentType];
|
|
367
443
|
/**
|
|
368
444
|
* @public
|
|
369
445
|
* <p>A detailed view of a component.</p>
|
|
@@ -390,8 +466,8 @@ export interface Component {
|
|
|
390
466
|
*/
|
|
391
467
|
changeDescription?: string;
|
|
392
468
|
/**
|
|
393
|
-
* <p>The component type specifies whether Image Builder uses the component to build the image or
|
|
394
|
-
* to test it.</p>
|
|
469
|
+
* <p>The component type specifies whether Image Builder uses the component to build the image or
|
|
470
|
+
* only to test it.</p>
|
|
395
471
|
*/
|
|
396
472
|
type?: ComponentType | string;
|
|
397
473
|
/**
|
|
@@ -400,13 +476,13 @@ export interface Component {
|
|
|
400
476
|
platform?: Platform | string;
|
|
401
477
|
/**
|
|
402
478
|
* <p>The operating system (OS) version supported by the component. If the OS information is
|
|
403
|
-
* available, Image Builder performs a prefix match against the base image OS version during image
|
|
404
|
-
* creation.</p>
|
|
479
|
+
* available, Image Builder performs a prefix match against the base image OS version during image
|
|
480
|
+
* recipe creation.</p>
|
|
405
481
|
*/
|
|
406
482
|
supportedOsVersions?: string[];
|
|
407
483
|
/**
|
|
408
|
-
* <p>Describes the current status of the component. This is used for
|
|
409
|
-
*
|
|
484
|
+
* <p>Describes the current status of the component. This is used for components that are no
|
|
485
|
+
* longer active.</p>
|
|
410
486
|
*/
|
|
411
487
|
state?: ComponentState;
|
|
412
488
|
/**
|
|
@@ -439,13 +515,13 @@ export interface Component {
|
|
|
439
515
|
*/
|
|
440
516
|
tags?: Record<string, string>;
|
|
441
517
|
/**
|
|
442
|
-
* <p>Contains the name of the publisher if this is a third-party component. Otherwise,
|
|
443
|
-
*
|
|
518
|
+
* <p>Contains the name of the publisher if this is a third-party component. Otherwise, this
|
|
519
|
+
* property is empty.</p>
|
|
444
520
|
*/
|
|
445
521
|
publisher?: string;
|
|
446
522
|
/**
|
|
447
|
-
* <p>Indicates whether component source is hidden from view in the console,
|
|
448
|
-
*
|
|
523
|
+
* <p>Indicates whether component source is hidden from view in the console, and from
|
|
524
|
+
* component detail results for API, CLI, or SDK operations.</p>
|
|
449
525
|
*/
|
|
450
526
|
obfuscate?: boolean;
|
|
451
527
|
}
|
|
@@ -465,7 +541,7 @@ export interface ComponentParameter {
|
|
|
465
541
|
}
|
|
466
542
|
/**
|
|
467
543
|
* @public
|
|
468
|
-
* <p>
|
|
544
|
+
* <p>Configuration details of the component.</p>
|
|
469
545
|
*/
|
|
470
546
|
export interface ComponentConfiguration {
|
|
471
547
|
/**
|
|
@@ -473,16 +549,22 @@ export interface ComponentConfiguration {
|
|
|
473
549
|
*/
|
|
474
550
|
componentArn: string | undefined;
|
|
475
551
|
/**
|
|
476
|
-
* <p>A group of parameter settings that Image Builder uses to configure the component for a specific
|
|
552
|
+
* <p>A group of parameter settings that Image Builder uses to configure the component for a specific
|
|
553
|
+
* recipe.</p>
|
|
477
554
|
*/
|
|
478
555
|
parameters?: ComponentParameter[];
|
|
479
556
|
}
|
|
480
557
|
/**
|
|
481
558
|
* @public
|
|
559
|
+
* @enum
|
|
482
560
|
*/
|
|
483
|
-
export declare
|
|
484
|
-
SHELL
|
|
485
|
-
}
|
|
561
|
+
export declare const ComponentFormat: {
|
|
562
|
+
readonly SHELL: "SHELL";
|
|
563
|
+
};
|
|
564
|
+
/**
|
|
565
|
+
* @public
|
|
566
|
+
*/
|
|
567
|
+
export type ComponentFormat = (typeof ComponentFormat)[keyof typeof ComponentFormat];
|
|
486
568
|
/**
|
|
487
569
|
* @public
|
|
488
570
|
* <p>A high-level summary of a component.</p>
|
|
@@ -505,9 +587,9 @@ export interface ComponentSummary {
|
|
|
505
587
|
*/
|
|
506
588
|
platform?: Platform | string;
|
|
507
589
|
/**
|
|
508
|
-
* <p>The operating system (OS) version that the component supports. If the OS information
|
|
509
|
-
* available, Image Builder performs a prefix match against the base image OS version during
|
|
510
|
-
* creation.</p>
|
|
590
|
+
* <p>The operating system (OS) version that the component supports. If the OS information
|
|
591
|
+
* is available, Image Builder performs a prefix match against the base image OS version during
|
|
592
|
+
* image recipe creation.</p>
|
|
511
593
|
*/
|
|
512
594
|
supportedOsVersions?: string[];
|
|
513
595
|
/**
|
|
@@ -515,8 +597,8 @@ export interface ComponentSummary {
|
|
|
515
597
|
*/
|
|
516
598
|
state?: ComponentState;
|
|
517
599
|
/**
|
|
518
|
-
* <p>The component type specifies whether Image Builder uses the component to build the image or
|
|
519
|
-
* to test it.</p>
|
|
600
|
+
* <p>The component type specifies whether Image Builder uses the component to build the image or
|
|
601
|
+
* only to test it.</p>
|
|
520
602
|
*/
|
|
521
603
|
type?: ComponentType | string;
|
|
522
604
|
/**
|
|
@@ -540,13 +622,13 @@ export interface ComponentSummary {
|
|
|
540
622
|
*/
|
|
541
623
|
tags?: Record<string, string>;
|
|
542
624
|
/**
|
|
543
|
-
* <p>Contains the name of the publisher if this is a third-party component. Otherwise,
|
|
544
|
-
*
|
|
625
|
+
* <p>Contains the name of the publisher if this is a third-party component. Otherwise, this
|
|
626
|
+
* property is empty.</p>
|
|
545
627
|
*/
|
|
546
628
|
publisher?: string;
|
|
547
629
|
/**
|
|
548
|
-
* <p>Indicates whether component source is hidden from view in the console,
|
|
549
|
-
*
|
|
630
|
+
* <p>Indicates whether component source is hidden from view in the console, and from
|
|
631
|
+
* component detail results for API, CLI, or SDK operations.</p>
|
|
550
632
|
*/
|
|
551
633
|
obfuscate?: boolean;
|
|
552
634
|
}
|
|
@@ -610,13 +692,13 @@ export interface ComponentVersion {
|
|
|
610
692
|
platform?: Platform | string;
|
|
611
693
|
/**
|
|
612
694
|
* <p>he operating system (OS) version supported by the component. If the OS information is
|
|
613
|
-
* available, a prefix match is performed against the base image OS version during image
|
|
614
|
-
* creation.</p>
|
|
695
|
+
* available, a prefix match is performed against the base image OS version during image
|
|
696
|
+
* recipe creation.</p>
|
|
615
697
|
*/
|
|
616
698
|
supportedOsVersions?: string[];
|
|
617
699
|
/**
|
|
618
|
-
* <p>The type of the component denotes whether the component is used to build the image or
|
|
619
|
-
* to test it.</p>
|
|
700
|
+
* <p>The type of the component denotes whether the component is used to build the image or
|
|
701
|
+
* only to test it.</p>
|
|
620
702
|
*/
|
|
621
703
|
type?: ComponentType | string;
|
|
622
704
|
/**
|
|
@@ -634,7 +716,8 @@ export interface ComponentVersion {
|
|
|
634
716
|
*/
|
|
635
717
|
export interface Container {
|
|
636
718
|
/**
|
|
637
|
-
* <p>Containers and container images are Region-specific. This is the Region context for
|
|
719
|
+
* <p>Containers and container images are Region-specific. This is the Region context for
|
|
720
|
+
* the container.</p>
|
|
638
721
|
*/
|
|
639
722
|
region?: string;
|
|
640
723
|
/**
|
|
@@ -644,10 +727,15 @@ export interface Container {
|
|
|
644
727
|
}
|
|
645
728
|
/**
|
|
646
729
|
* @public
|
|
730
|
+
* @enum
|
|
647
731
|
*/
|
|
648
|
-
export declare
|
|
649
|
-
ECR
|
|
650
|
-
}
|
|
732
|
+
export declare const ContainerRepositoryService: {
|
|
733
|
+
readonly ECR: "ECR";
|
|
734
|
+
};
|
|
735
|
+
/**
|
|
736
|
+
* @public
|
|
737
|
+
*/
|
|
738
|
+
export type ContainerRepositoryService = (typeof ContainerRepositoryService)[keyof typeof ContainerRepositoryService];
|
|
651
739
|
/**
|
|
652
740
|
* @public
|
|
653
741
|
* <p>The container repository where the output container image is stored.</p>
|
|
@@ -658,13 +746,15 @@ export interface TargetContainerRepository {
|
|
|
658
746
|
*/
|
|
659
747
|
service: ContainerRepositoryService | string | undefined;
|
|
660
748
|
/**
|
|
661
|
-
* <p>The name of the container repository where the output container image is stored. This
|
|
749
|
+
* <p>The name of the container repository where the output container image is stored. This
|
|
750
|
+
* name is prefixed by the repository location.</p>
|
|
662
751
|
*/
|
|
663
752
|
repositoryName: string | undefined;
|
|
664
753
|
}
|
|
665
754
|
/**
|
|
666
755
|
* @public
|
|
667
|
-
* <p>Container distribution settings for encryption, licensing, and sharing in a specific
|
|
756
|
+
* <p>Container distribution settings for encryption, licensing, and sharing in a specific
|
|
757
|
+
* Region.</p>
|
|
668
758
|
*/
|
|
669
759
|
export interface ContainerDistributionConfiguration {
|
|
670
760
|
/**
|
|
@@ -682,22 +772,32 @@ export interface ContainerDistributionConfiguration {
|
|
|
682
772
|
}
|
|
683
773
|
/**
|
|
684
774
|
* @public
|
|
775
|
+
* @enum
|
|
685
776
|
*/
|
|
686
|
-
export declare
|
|
687
|
-
DOCKER
|
|
688
|
-
}
|
|
777
|
+
export declare const ContainerType: {
|
|
778
|
+
readonly DOCKER: "DOCKER";
|
|
779
|
+
};
|
|
689
780
|
/**
|
|
690
781
|
* @public
|
|
691
782
|
*/
|
|
692
|
-
export
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
783
|
+
export type ContainerType = (typeof ContainerType)[keyof typeof ContainerType];
|
|
784
|
+
/**
|
|
785
|
+
* @public
|
|
786
|
+
* @enum
|
|
787
|
+
*/
|
|
788
|
+
export declare const EbsVolumeType: {
|
|
789
|
+
readonly GP2: "gp2";
|
|
790
|
+
readonly GP3: "gp3";
|
|
791
|
+
readonly IO1: "io1";
|
|
792
|
+
readonly IO2: "io2";
|
|
793
|
+
readonly SC1: "sc1";
|
|
794
|
+
readonly ST1: "st1";
|
|
795
|
+
readonly STANDARD: "standard";
|
|
796
|
+
};
|
|
797
|
+
/**
|
|
798
|
+
* @public
|
|
799
|
+
*/
|
|
800
|
+
export type EbsVolumeType = (typeof EbsVolumeType)[keyof typeof EbsVolumeType];
|
|
701
801
|
/**
|
|
702
802
|
* @public
|
|
703
803
|
* <p>Amazon EBS-specific block device mapping specifications.</p>
|
|
@@ -733,8 +833,8 @@ export interface EbsInstanceBlockDeviceSpecification {
|
|
|
733
833
|
volumeType?: EbsVolumeType | string;
|
|
734
834
|
/**
|
|
735
835
|
* <p>
|
|
736
|
-
* <b>For GP3 volumes only</b> –
|
|
737
|
-
*
|
|
836
|
+
* <b>For GP3 volumes only</b> – The throughput in MiB/s
|
|
837
|
+
* that the volume supports.</p>
|
|
738
838
|
*/
|
|
739
839
|
throughput?: number;
|
|
740
840
|
}
|
|
@@ -762,17 +862,18 @@ export interface InstanceBlockDeviceMapping {
|
|
|
762
862
|
}
|
|
763
863
|
/**
|
|
764
864
|
* @public
|
|
765
|
-
* <p>Defines a custom base AMI and block device mapping configurations of an instance
|
|
766
|
-
*
|
|
865
|
+
* <p>Defines a custom base AMI and block device mapping configurations of an instance used
|
|
866
|
+
* for building and testing container images.</p>
|
|
767
867
|
*/
|
|
768
868
|
export interface InstanceConfiguration {
|
|
769
869
|
/**
|
|
770
|
-
* <p>The AMI ID to use as the base image for a container build and test instance. If not
|
|
771
|
-
* Image Builder will use the appropriate ECS-optimized AMI as a base image.</p>
|
|
870
|
+
* <p>The AMI ID to use as the base image for a container build and test instance. If not
|
|
871
|
+
* specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.</p>
|
|
772
872
|
*/
|
|
773
873
|
image?: string;
|
|
774
874
|
/**
|
|
775
|
-
* <p>Defines the block devices to attach for building an instance from this Image Builder
|
|
875
|
+
* <p>Defines the block devices to attach for building an instance from this Image Builder
|
|
876
|
+
* AMI.</p>
|
|
776
877
|
*/
|
|
777
878
|
blockDeviceMappings?: InstanceBlockDeviceMapping[];
|
|
778
879
|
}
|
|
@@ -843,20 +944,26 @@ export interface ContainerRecipe {
|
|
|
843
944
|
*/
|
|
844
945
|
version?: string;
|
|
845
946
|
/**
|
|
846
|
-
* <p>Build and test components that are included in the container recipe.
|
|
947
|
+
* <p>Build and test components that are included in the container recipe.
|
|
948
|
+
* Recipes require a minimum of one build component, and can
|
|
847
949
|
* have a maximum of 20 build and test components in any combination.</p>
|
|
848
950
|
*/
|
|
849
951
|
components?: ComponentConfiguration[];
|
|
850
952
|
/**
|
|
851
|
-
* <p>A group of options that can be used to configure an instance for building and testing
|
|
953
|
+
* <p>A group of options that can be used to configure an instance for building and testing
|
|
954
|
+
* container images.</p>
|
|
852
955
|
*/
|
|
853
956
|
instanceConfiguration?: InstanceConfiguration;
|
|
854
957
|
/**
|
|
855
|
-
* <p>Dockerfiles are text documents that are used to build Docker containers, and ensure
|
|
958
|
+
* <p>Dockerfiles are text documents that are used to build Docker containers, and ensure
|
|
959
|
+
* that they contain all of the elements required by the application running inside. The
|
|
960
|
+
* template data consists of contextual variables where Image Builder places build information or
|
|
961
|
+
* scripts, based on your container image recipe.</p>
|
|
856
962
|
*/
|
|
857
963
|
dockerfileTemplateData?: string;
|
|
858
964
|
/**
|
|
859
|
-
* <p>Identifies which KMS key is used to encrypt the container image for distribution to
|
|
965
|
+
* <p>Identifies which KMS key is used to encrypt the container image for distribution to
|
|
966
|
+
* the target Region.</p>
|
|
860
967
|
*/
|
|
861
968
|
kmsKeyId?: string;
|
|
862
969
|
/**
|
|
@@ -931,7 +1038,8 @@ export interface CreateComponentRequest {
|
|
|
931
1038
|
*/
|
|
932
1039
|
name: string | undefined;
|
|
933
1040
|
/**
|
|
934
|
-
* <p>The semantic version of the component. This version follows the semantic version
|
|
1041
|
+
* <p>The semantic version of the component. This version follows the semantic version
|
|
1042
|
+
* syntax.</p>
|
|
935
1043
|
* <note>
|
|
936
1044
|
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
937
1045
|
* You can assign values for the first three, and can filter on all of them.</p>
|
|
@@ -952,7 +1060,8 @@ export interface CreateComponentRequest {
|
|
|
952
1060
|
description?: string;
|
|
953
1061
|
/**
|
|
954
1062
|
* <p>The change description of the component. Describes what change has been made in this
|
|
955
|
-
* version, or what makes this version different from other versions of this
|
|
1063
|
+
* version, or what makes this version different from other versions of this
|
|
1064
|
+
* component.</p>
|
|
956
1065
|
*/
|
|
957
1066
|
changeDescription?: string;
|
|
958
1067
|
/**
|
|
@@ -960,9 +1069,9 @@ export interface CreateComponentRequest {
|
|
|
960
1069
|
*/
|
|
961
1070
|
platform: Platform | string | undefined;
|
|
962
1071
|
/**
|
|
963
|
-
* <p>
|
|
964
|
-
* available, a prefix match is performed against the base image OS version during image
|
|
965
|
-
* creation.</p>
|
|
1072
|
+
* <p>The operating system (OS) version supported by the component. If the OS information is
|
|
1073
|
+
* available, a prefix match is performed against the base image OS version during image
|
|
1074
|
+
* recipe creation.</p>
|
|
966
1075
|
*/
|
|
967
1076
|
supportedOsVersions?: string[];
|
|
968
1077
|
/**
|
|
@@ -973,11 +1082,11 @@ export interface CreateComponentRequest {
|
|
|
973
1082
|
data?: string;
|
|
974
1083
|
/**
|
|
975
1084
|
* <p>The <code>uri</code> of a YAML component document file. This must be an S3 URL
|
|
976
|
-
*
|
|
977
|
-
*
|
|
978
|
-
*
|
|
1085
|
+
* (<code>s3://bucket/key</code>), and the requester must have permission to access the
|
|
1086
|
+
* S3 bucket it points to. If you use Amazon S3, you can specify component content up to your
|
|
1087
|
+
* service quota.</p>
|
|
979
1088
|
* <p>Alternatively, you can specify the YAML document inline, using the component
|
|
980
|
-
*
|
|
1089
|
+
* <code>data</code> property. You cannot specify both properties.</p>
|
|
981
1090
|
*/
|
|
982
1091
|
uri?: string;
|
|
983
1092
|
/**
|
|
@@ -1006,14 +1115,14 @@ export interface CreateComponentResponse {
|
|
|
1006
1115
|
*/
|
|
1007
1116
|
clientToken?: string;
|
|
1008
1117
|
/**
|
|
1009
|
-
* <p>The Amazon Resource Name (ARN) of the component that
|
|
1118
|
+
* <p>The Amazon Resource Name (ARN) of the component that this request created.</p>
|
|
1010
1119
|
*/
|
|
1011
1120
|
componentBuildVersionArn?: string;
|
|
1012
1121
|
}
|
|
1013
1122
|
/**
|
|
1014
1123
|
* @public
|
|
1015
|
-
* <p>You have specified two or more mutually exclusive parameters. Review the error message
|
|
1016
|
-
* details.</p>
|
|
1124
|
+
* <p>You have specified two or more mutually exclusive parameters. Review the error message
|
|
1125
|
+
* for details.</p>
|
|
1017
1126
|
*/
|
|
1018
1127
|
export declare class InvalidParameterCombinationException extends __BaseException {
|
|
1019
1128
|
readonly name: "InvalidParameterCombinationException";
|
|
@@ -1037,7 +1146,9 @@ export declare class InvalidVersionNumberException extends __BaseException {
|
|
|
1037
1146
|
}
|
|
1038
1147
|
/**
|
|
1039
1148
|
* @public
|
|
1040
|
-
* <p>You have exceeded the number of permitted resources or operations for this service.
|
|
1149
|
+
* <p>You have exceeded the number of permitted resources or operations for this service.
|
|
1150
|
+
* For service quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder">EC2 Image Builder endpoints and
|
|
1151
|
+
* quotas</a>.</p>
|
|
1041
1152
|
*/
|
|
1042
1153
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
1043
1154
|
readonly name: "ServiceQuotaExceededException";
|
|
@@ -1064,7 +1175,8 @@ export interface CreateContainerRecipeRequest {
|
|
|
1064
1175
|
*/
|
|
1065
1176
|
description?: string;
|
|
1066
1177
|
/**
|
|
1067
|
-
* <p>The semantic version of the container recipe. This version follows the semantic
|
|
1178
|
+
* <p>The semantic version of the container recipe. This version follows the semantic
|
|
1179
|
+
* version syntax.</p>
|
|
1068
1180
|
* <note>
|
|
1069
1181
|
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
1070
1182
|
* You can assign values for the first three, and can filter on all of them.</p>
|
|
@@ -1080,12 +1192,14 @@ export interface CreateContainerRecipeRequest {
|
|
|
1080
1192
|
*/
|
|
1081
1193
|
semanticVersion: string | undefined;
|
|
1082
1194
|
/**
|
|
1083
|
-
* <p>Components for build and test that are included in the container recipe.
|
|
1195
|
+
* <p>Components for build and test that are included in the container recipe.
|
|
1196
|
+
* Recipes require a minimum of one build component, and can
|
|
1084
1197
|
* have a maximum of 20 build and test components in any combination.</p>
|
|
1085
1198
|
*/
|
|
1086
1199
|
components: ComponentConfiguration[] | undefined;
|
|
1087
1200
|
/**
|
|
1088
|
-
* <p>A group of options that can be used to configure an instance for building and testing
|
|
1201
|
+
* <p>A group of options that can be used to configure an instance for building and testing
|
|
1202
|
+
* container images.</p>
|
|
1089
1203
|
*/
|
|
1090
1204
|
instanceConfiguration?: InstanceConfiguration;
|
|
1091
1205
|
/**
|
|
@@ -1093,7 +1207,8 @@ export interface CreateContainerRecipeRequest {
|
|
|
1093
1207
|
*/
|
|
1094
1208
|
dockerfileTemplateData?: string;
|
|
1095
1209
|
/**
|
|
1096
|
-
* <p>The Amazon S3 URI for the Dockerfile that will be used to build your container
|
|
1210
|
+
* <p>The Amazon S3 URI for the Dockerfile that will be used to build your container
|
|
1211
|
+
* image.</p>
|
|
1097
1212
|
*/
|
|
1098
1213
|
dockerfileTemplateUri?: string;
|
|
1099
1214
|
/**
|
|
@@ -1142,7 +1257,8 @@ export interface CreateContainerRecipeResponse {
|
|
|
1142
1257
|
*/
|
|
1143
1258
|
clientToken?: string;
|
|
1144
1259
|
/**
|
|
1145
|
-
* <p>Returns the Amazon Resource Name (ARN) of the container recipe that the request
|
|
1260
|
+
* <p>Returns the Amazon Resource Name (ARN) of the container recipe that the request
|
|
1261
|
+
* created.</p>
|
|
1146
1262
|
*/
|
|
1147
1263
|
containerRecipeArn?: string;
|
|
1148
1264
|
}
|
|
@@ -1160,11 +1276,11 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
1160
1276
|
}
|
|
1161
1277
|
/**
|
|
1162
1278
|
* @public
|
|
1163
|
-
* <p>Identifies the launch template that the associated Windows AMI uses for
|
|
1164
|
-
*
|
|
1279
|
+
* <p>Identifies the launch template that the associated Windows AMI uses for launching an
|
|
1280
|
+
* instance when faster launching is enabled.</p>
|
|
1165
1281
|
* <note>
|
|
1166
1282
|
* <p>You can specify either the <code>launchTemplateName</code> or the
|
|
1167
|
-
*
|
|
1283
|
+
* <code>launchTemplateId</code>, but not both.</p>
|
|
1168
1284
|
* </note>
|
|
1169
1285
|
*/
|
|
1170
1286
|
export interface FastLaunchLaunchTemplateSpecification {
|
|
@@ -1177,14 +1293,15 @@ export interface FastLaunchLaunchTemplateSpecification {
|
|
|
1177
1293
|
*/
|
|
1178
1294
|
launchTemplateName?: string;
|
|
1179
1295
|
/**
|
|
1180
|
-
* <p>The version of the launch template to use for faster launching for a Windows
|
|
1296
|
+
* <p>The version of the launch template to use for faster launching for a Windows
|
|
1297
|
+
* AMI.</p>
|
|
1181
1298
|
*/
|
|
1182
1299
|
launchTemplateVersion?: string;
|
|
1183
1300
|
}
|
|
1184
1301
|
/**
|
|
1185
1302
|
* @public
|
|
1186
|
-
* <p>Configuration settings for creating and managing pre-provisioned snapshots
|
|
1187
|
-
*
|
|
1303
|
+
* <p>Configuration settings for creating and managing pre-provisioned snapshots for a
|
|
1304
|
+
* fast-launch enabled Windows AMI.</p>
|
|
1188
1305
|
*/
|
|
1189
1306
|
export interface FastLaunchSnapshotConfiguration {
|
|
1190
1307
|
/**
|
|
@@ -1199,15 +1316,14 @@ export interface FastLaunchSnapshotConfiguration {
|
|
|
1199
1316
|
*/
|
|
1200
1317
|
export interface FastLaunchConfiguration {
|
|
1201
1318
|
/**
|
|
1202
|
-
* <p>A Boolean that represents the current state of faster launching for the
|
|
1203
|
-
*
|
|
1204
|
-
*
|
|
1319
|
+
* <p>A Boolean that represents the current state of faster launching for the Windows AMI.
|
|
1320
|
+
* Set to <code>true</code> to start using Windows faster launching, or <code>false</code>
|
|
1321
|
+
* to stop using it.</p>
|
|
1205
1322
|
*/
|
|
1206
1323
|
enabled: boolean | undefined;
|
|
1207
1324
|
/**
|
|
1208
|
-
* <p>Configuration settings for managing the number of snapshots that are
|
|
1209
|
-
*
|
|
1210
|
-
* launching is enabled.</p>
|
|
1325
|
+
* <p>Configuration settings for managing the number of snapshots that are created from
|
|
1326
|
+
* pre-provisioned instances for the Windows AMI when faster launching is enabled.</p>
|
|
1211
1327
|
*/
|
|
1212
1328
|
snapshotConfiguration?: FastLaunchSnapshotConfiguration;
|
|
1213
1329
|
/**
|
|
@@ -1216,8 +1332,8 @@ export interface FastLaunchConfiguration {
|
|
|
1216
1332
|
*/
|
|
1217
1333
|
maxParallelLaunches?: number;
|
|
1218
1334
|
/**
|
|
1219
|
-
* <p>The launch template that the fast-launch enabled Windows AMI uses when it
|
|
1220
|
-
*
|
|
1335
|
+
* <p>The launch template that the fast-launch enabled Windows AMI uses when it launches
|
|
1336
|
+
* Windows instances to create pre-provisioned snapshots.</p>
|
|
1221
1337
|
*/
|
|
1222
1338
|
launchTemplate?: FastLaunchLaunchTemplateSpecification;
|
|
1223
1339
|
/**
|
|
@@ -1239,43 +1355,48 @@ export interface LaunchTemplateConfiguration {
|
|
|
1239
1355
|
*/
|
|
1240
1356
|
accountId?: string;
|
|
1241
1357
|
/**
|
|
1242
|
-
* <p>Set the specified Amazon EC2 launch template as the default launch template for the
|
|
1358
|
+
* <p>Set the specified Amazon EC2 launch template as the default launch template for the
|
|
1359
|
+
* specified account.</p>
|
|
1243
1360
|
*/
|
|
1244
1361
|
setDefaultVersion?: boolean;
|
|
1245
1362
|
}
|
|
1246
1363
|
/**
|
|
1247
1364
|
* @public
|
|
1365
|
+
* @enum
|
|
1248
1366
|
*/
|
|
1249
|
-
export declare
|
|
1250
|
-
RAW
|
|
1251
|
-
VHD
|
|
1252
|
-
VMDK
|
|
1253
|
-
}
|
|
1367
|
+
export declare const DiskImageFormat: {
|
|
1368
|
+
readonly RAW: "RAW";
|
|
1369
|
+
readonly VHD: "VHD";
|
|
1370
|
+
readonly VMDK: "VMDK";
|
|
1371
|
+
};
|
|
1254
1372
|
/**
|
|
1255
1373
|
* @public
|
|
1256
|
-
|
|
1257
|
-
|
|
1374
|
+
*/
|
|
1375
|
+
export type DiskImageFormat = (typeof DiskImageFormat)[keyof typeof DiskImageFormat];
|
|
1376
|
+
/**
|
|
1377
|
+
* @public
|
|
1378
|
+
* <p>Properties that configure export from your build instance to a compatible file format
|
|
1379
|
+
* for your VM.</p>
|
|
1258
1380
|
*/
|
|
1259
1381
|
export interface S3ExportConfiguration {
|
|
1260
1382
|
/**
|
|
1261
|
-
* <p>The name of the role that grants VM Import/Export permission to
|
|
1262
|
-
*
|
|
1383
|
+
* <p>The name of the role that grants VM Import/Export permission to export images to your
|
|
1384
|
+
* S3 bucket.</p>
|
|
1263
1385
|
*/
|
|
1264
1386
|
roleName: string | undefined;
|
|
1265
1387
|
/**
|
|
1266
|
-
* <p>Export the updated image to one of the following supported disk
|
|
1267
|
-
* image formats:</p>
|
|
1388
|
+
* <p>Export the updated image to one of the following supported disk image formats:</p>
|
|
1268
1389
|
* <ul>
|
|
1269
1390
|
* <li>
|
|
1270
1391
|
* <p>
|
|
1271
|
-
* <b>Virtual Hard Disk (VHD)</b> –
|
|
1272
|
-
*
|
|
1392
|
+
* <b>Virtual Hard Disk (VHD)</b> – Compatible
|
|
1393
|
+
* with Citrix Xen and Microsoft Hyper-V virtualization products.</p>
|
|
1273
1394
|
* </li>
|
|
1274
1395
|
* <li>
|
|
1275
1396
|
* <p>
|
|
1276
1397
|
* <b>Stream-optimized ESX Virtual Machine Disk
|
|
1277
|
-
*
|
|
1278
|
-
*
|
|
1398
|
+
* (VMDK)</b> – Compatible with VMware ESX and VMware vSphere
|
|
1399
|
+
* versions 4, 5, and 6.</p>
|
|
1279
1400
|
* </li>
|
|
1280
1401
|
* <li>
|
|
1281
1402
|
* <p>
|
|
@@ -1289,13 +1410,14 @@ export interface S3ExportConfiguration {
|
|
|
1289
1410
|
*/
|
|
1290
1411
|
s3Bucket: string | undefined;
|
|
1291
1412
|
/**
|
|
1292
|
-
* <p>The Amazon S3 path for the bucket where the output disk images for your VM are
|
|
1413
|
+
* <p>The Amazon S3 path for the bucket where the output disk images for your VM are
|
|
1414
|
+
* stored.</p>
|
|
1293
1415
|
*/
|
|
1294
1416
|
s3Prefix?: string;
|
|
1295
1417
|
}
|
|
1296
1418
|
/**
|
|
1297
1419
|
* @public
|
|
1298
|
-
* <p>
|
|
1420
|
+
* <p>Defines the settings for a specific Region.</p>
|
|
1299
1421
|
*/
|
|
1300
1422
|
export interface Distribution {
|
|
1301
1423
|
/**
|
|
@@ -1307,8 +1429,8 @@ export interface Distribution {
|
|
|
1307
1429
|
*/
|
|
1308
1430
|
amiDistributionConfiguration?: AmiDistributionConfiguration;
|
|
1309
1431
|
/**
|
|
1310
|
-
* <p>Container distribution settings for encryption, licensing, and sharing
|
|
1311
|
-
*
|
|
1432
|
+
* <p>Container distribution settings for encryption, licensing, and sharing in a specific
|
|
1433
|
+
* Region.</p>
|
|
1312
1434
|
*/
|
|
1313
1435
|
containerDistributionConfiguration?: ContainerDistributionConfiguration;
|
|
1314
1436
|
/**
|
|
@@ -1317,13 +1439,13 @@ export interface Distribution {
|
|
|
1317
1439
|
*/
|
|
1318
1440
|
licenseConfigurationArns?: string[];
|
|
1319
1441
|
/**
|
|
1320
|
-
* <p>A group of launchTemplateConfiguration settings that apply to image distribution
|
|
1321
|
-
*
|
|
1442
|
+
* <p>A group of launchTemplateConfiguration settings that apply to image distribution for
|
|
1443
|
+
* specified accounts.</p>
|
|
1322
1444
|
*/
|
|
1323
1445
|
launchTemplateConfigurations?: LaunchTemplateConfiguration[];
|
|
1324
1446
|
/**
|
|
1325
|
-
* <p>Configure export settings to deliver disk images created from your image build,
|
|
1326
|
-
*
|
|
1447
|
+
* <p>Configure export settings to deliver disk images created from your image build, using
|
|
1448
|
+
* a file format that is compatible with your VMs in that Region.</p>
|
|
1327
1449
|
*/
|
|
1328
1450
|
s3ExportConfiguration?: S3ExportConfiguration;
|
|
1329
1451
|
/**
|
|
@@ -1336,23 +1458,23 @@ export interface Distribution {
|
|
|
1336
1458
|
*/
|
|
1337
1459
|
export interface CreateDistributionConfigurationRequest {
|
|
1338
1460
|
/**
|
|
1339
|
-
* <p>
|
|
1461
|
+
* <p>The name of the distribution configuration.</p>
|
|
1340
1462
|
*/
|
|
1341
1463
|
name: string | undefined;
|
|
1342
1464
|
/**
|
|
1343
|
-
* <p>
|
|
1465
|
+
* <p>The description of the distribution configuration.</p>
|
|
1344
1466
|
*/
|
|
1345
1467
|
description?: string;
|
|
1346
1468
|
/**
|
|
1347
|
-
* <p>
|
|
1469
|
+
* <p>The distributions of the distribution configuration.</p>
|
|
1348
1470
|
*/
|
|
1349
1471
|
distributions: Distribution[] | undefined;
|
|
1350
1472
|
/**
|
|
1351
|
-
* <p>
|
|
1473
|
+
* <p>The tags of the distribution configuration.</p>
|
|
1352
1474
|
*/
|
|
1353
1475
|
tags?: Record<string, string>;
|
|
1354
1476
|
/**
|
|
1355
|
-
* <p>
|
|
1477
|
+
* <p>The idempotency token of the distribution configuration.</p>
|
|
1356
1478
|
*/
|
|
1357
1479
|
clientToken?: string;
|
|
1358
1480
|
}
|
|
@@ -1361,35 +1483,70 @@ export interface CreateDistributionConfigurationRequest {
|
|
|
1361
1483
|
*/
|
|
1362
1484
|
export interface CreateDistributionConfigurationResponse {
|
|
1363
1485
|
/**
|
|
1364
|
-
* <p>
|
|
1486
|
+
* <p>The request ID that uniquely identifies this request.</p>
|
|
1365
1487
|
*/
|
|
1366
1488
|
requestId?: string;
|
|
1367
1489
|
/**
|
|
1368
|
-
* <p>
|
|
1490
|
+
* <p>The idempotency token used to make this request idempotent.</p>
|
|
1369
1491
|
*/
|
|
1370
1492
|
clientToken?: string;
|
|
1371
1493
|
/**
|
|
1372
|
-
* <p>
|
|
1373
|
-
* request.</p>
|
|
1494
|
+
* <p>The Amazon Resource Name (ARN) of the distribution configuration that was created by
|
|
1495
|
+
* this request.</p>
|
|
1374
1496
|
*/
|
|
1375
1497
|
distributionConfigurationArn?: string;
|
|
1376
1498
|
}
|
|
1377
1499
|
/**
|
|
1378
1500
|
* @public
|
|
1379
|
-
* <p>
|
|
1380
|
-
*
|
|
1381
|
-
|
|
1501
|
+
* <p>Settings that Image Builder uses to configure the ECR repository and the output container
|
|
1502
|
+
* images that Amazon Inspector scans.</p>
|
|
1503
|
+
*/
|
|
1504
|
+
export interface EcrConfiguration {
|
|
1505
|
+
/**
|
|
1506
|
+
* <p>The name of the container repository that Amazon Inspector scans to identify findings for your
|
|
1507
|
+
* container images. The name includes the path for the repository location. If you don’t
|
|
1508
|
+
* provide this information, Image Builder creates a repository in your account named
|
|
1509
|
+
* <code>image-builder-image-scanning-repository</code> for vulnerability scans of your
|
|
1510
|
+
* output container images.</p>
|
|
1511
|
+
*/
|
|
1512
|
+
repositoryName?: string;
|
|
1513
|
+
/**
|
|
1514
|
+
* <p>Tags for Image Builder to apply to the output container image that &INS; scans. Tags can
|
|
1515
|
+
* help you identify and manage your scanned images.</p>
|
|
1516
|
+
*/
|
|
1517
|
+
containerTags?: string[];
|
|
1518
|
+
}
|
|
1519
|
+
/**
|
|
1520
|
+
* @public
|
|
1521
|
+
* <p>Contains settings for Image Builder image resource and container image scans.</p>
|
|
1522
|
+
*/
|
|
1523
|
+
export interface ImageScanningConfiguration {
|
|
1524
|
+
/**
|
|
1525
|
+
* <p>A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that
|
|
1526
|
+
* Amazon Inspector runs against the build instance when you create a new image.</p>
|
|
1527
|
+
*/
|
|
1528
|
+
imageScanningEnabled?: boolean;
|
|
1529
|
+
/**
|
|
1530
|
+
* <p>Contains Amazon ECR settings for vulnerability scans.</p>
|
|
1531
|
+
*/
|
|
1532
|
+
ecrConfiguration?: EcrConfiguration;
|
|
1533
|
+
}
|
|
1534
|
+
/**
|
|
1535
|
+
* @public
|
|
1536
|
+
* <p>Configure image tests for your pipeline build. Tests run after building the image, to
|
|
1537
|
+
* verify that the AMI or container image is valid before distributing it.</p>
|
|
1382
1538
|
*/
|
|
1383
1539
|
export interface ImageTestsConfiguration {
|
|
1384
1540
|
/**
|
|
1385
|
-
* <p>Determines if tests should run after building the image. Image Builder defaults
|
|
1386
|
-
* to
|
|
1541
|
+
* <p>Determines if tests should run after building the image. Image Builder defaults to enable tests
|
|
1542
|
+
* to run following the image build, before image distribution.</p>
|
|
1387
1543
|
*/
|
|
1388
1544
|
imageTestsEnabled?: boolean;
|
|
1389
1545
|
/**
|
|
1390
1546
|
* <p>The maximum time in minutes that tests are permitted to run.</p>
|
|
1391
1547
|
* <note>
|
|
1392
|
-
* <p>The timeoutMinutes attribute is not currently active. This value is
|
|
1548
|
+
* <p>The timeoutMinutes attribute is not currently active. This value is
|
|
1549
|
+
* ignored.</p>
|
|
1393
1550
|
* </note>
|
|
1394
1551
|
*/
|
|
1395
1552
|
timeoutMinutes?: number;
|
|
@@ -1399,177 +1556,197 @@ export interface ImageTestsConfiguration {
|
|
|
1399
1556
|
*/
|
|
1400
1557
|
export interface CreateImageRequest {
|
|
1401
1558
|
/**
|
|
1402
|
-
* <p>
|
|
1559
|
+
* <p>The Amazon Resource Name (ARN) of the image recipe that defines how images are
|
|
1403
1560
|
* configured, tested, and assessed.</p>
|
|
1404
1561
|
*/
|
|
1405
1562
|
imageRecipeArn?: string;
|
|
1406
1563
|
/**
|
|
1407
|
-
* <p>The Amazon Resource Name (ARN) of the container recipe that defines how images are
|
|
1564
|
+
* <p>The Amazon Resource Name (ARN) of the container recipe that defines how images are
|
|
1565
|
+
* configured and tested.</p>
|
|
1408
1566
|
*/
|
|
1409
1567
|
containerRecipeArn?: string;
|
|
1410
1568
|
/**
|
|
1411
|
-
* <p>
|
|
1569
|
+
* <p>The Amazon Resource Name (ARN) of the distribution configuration that defines and
|
|
1412
1570
|
* configures the outputs of your pipeline.</p>
|
|
1413
1571
|
*/
|
|
1414
1572
|
distributionConfigurationArn?: string;
|
|
1415
1573
|
/**
|
|
1416
|
-
* <p>
|
|
1574
|
+
* <p>The Amazon Resource Name (ARN) of the infrastructure configuration that defines the
|
|
1417
1575
|
* environment in which your image will be built and tested.</p>
|
|
1418
1576
|
*/
|
|
1419
1577
|
infrastructureConfigurationArn: string | undefined;
|
|
1420
1578
|
/**
|
|
1421
|
-
* <p>
|
|
1579
|
+
* <p>The image tests configuration of the image.</p>
|
|
1422
1580
|
*/
|
|
1423
1581
|
imageTestsConfiguration?: ImageTestsConfiguration;
|
|
1424
1582
|
/**
|
|
1425
|
-
* <p>
|
|
1583
|
+
* <p>Collects additional information about the image being created, including the operating
|
|
1426
1584
|
* system (OS) version and package list. This information is used to enhance the overall
|
|
1427
1585
|
* experience of using EC2 Image Builder. Enabled by default.</p>
|
|
1428
1586
|
*/
|
|
1429
1587
|
enhancedImageMetadataEnabled?: boolean;
|
|
1430
1588
|
/**
|
|
1431
|
-
* <p>
|
|
1589
|
+
* <p>The tags of the image.</p>
|
|
1432
1590
|
*/
|
|
1433
1591
|
tags?: Record<string, string>;
|
|
1434
1592
|
/**
|
|
1435
|
-
* <p>
|
|
1593
|
+
* <p>The idempotency token used to make this request idempotent.</p>
|
|
1436
1594
|
*/
|
|
1437
1595
|
clientToken?: string;
|
|
1596
|
+
/**
|
|
1597
|
+
* <p>Contains settings for vulnerability scans.</p>
|
|
1598
|
+
*/
|
|
1599
|
+
imageScanningConfiguration?: ImageScanningConfiguration;
|
|
1438
1600
|
}
|
|
1439
1601
|
/**
|
|
1440
1602
|
* @public
|
|
1441
1603
|
*/
|
|
1442
1604
|
export interface CreateImageResponse {
|
|
1443
1605
|
/**
|
|
1444
|
-
* <p>
|
|
1606
|
+
* <p>The request ID that uniquely identifies this request.</p>
|
|
1445
1607
|
*/
|
|
1446
1608
|
requestId?: string;
|
|
1447
1609
|
/**
|
|
1448
|
-
* <p>
|
|
1610
|
+
* <p>The idempotency token used to make this request idempotent.</p>
|
|
1449
1611
|
*/
|
|
1450
1612
|
clientToken?: string;
|
|
1451
1613
|
/**
|
|
1452
|
-
* <p>
|
|
1614
|
+
* <p>The Amazon Resource Name (ARN) of the image that this request created.</p>
|
|
1453
1615
|
*/
|
|
1454
1616
|
imageBuildVersionArn?: string;
|
|
1455
1617
|
}
|
|
1456
1618
|
/**
|
|
1457
1619
|
* @public
|
|
1620
|
+
* @enum
|
|
1458
1621
|
*/
|
|
1459
|
-
export declare
|
|
1460
|
-
EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
|
|
1461
|
-
EXPRESSION_MATCH_ONLY
|
|
1462
|
-
}
|
|
1622
|
+
export declare const PipelineExecutionStartCondition: {
|
|
1623
|
+
readonly EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE: "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE";
|
|
1624
|
+
readonly EXPRESSION_MATCH_ONLY: "EXPRESSION_MATCH_ONLY";
|
|
1625
|
+
};
|
|
1463
1626
|
/**
|
|
1464
1627
|
* @public
|
|
1465
|
-
|
|
1628
|
+
*/
|
|
1629
|
+
export type PipelineExecutionStartCondition = (typeof PipelineExecutionStartCondition)[keyof typeof PipelineExecutionStartCondition];
|
|
1630
|
+
/**
|
|
1631
|
+
* @public
|
|
1632
|
+
* <p>A schedule configures how often and when a pipeline will automatically create a new
|
|
1633
|
+
* image.</p>
|
|
1466
1634
|
*/
|
|
1467
1635
|
export interface Schedule {
|
|
1468
1636
|
/**
|
|
1469
1637
|
* <p>The cron expression determines how often EC2 Image Builder evaluates your
|
|
1470
|
-
*
|
|
1471
|
-
* <p>For information on how to format a cron expression in Image Builder, see <a href="https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html">Use
|
|
1472
|
-
*
|
|
1638
|
+
* <code>pipelineExecutionStartCondition</code>.</p>
|
|
1639
|
+
* <p>For information on how to format a cron expression in Image Builder, see <a href="https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html">Use
|
|
1640
|
+
* cron expressions in EC2 Image Builder</a>.</p>
|
|
1473
1641
|
*/
|
|
1474
1642
|
scheduleExpression?: string;
|
|
1475
1643
|
/**
|
|
1476
1644
|
* <p>The timezone that applies to the scheduling expression. For example, "Etc/UTC",
|
|
1477
|
-
* "America/Los_Angeles" in the <a href="https://www.joda.org/joda-time/timezones.html">IANA
|
|
1478
|
-
* timezone format</a>. If not specified this defaults to UTC.</p>
|
|
1645
|
+
* "America/Los_Angeles" in the <a href="https://www.joda.org/joda-time/timezones.html">IANA timezone format</a>. If not specified this defaults to UTC.</p>
|
|
1479
1646
|
*/
|
|
1480
1647
|
timezone?: string;
|
|
1481
1648
|
/**
|
|
1482
1649
|
* <p>The condition configures when the pipeline should trigger a new image build. When the
|
|
1483
|
-
*
|
|
1484
|
-
*
|
|
1485
|
-
* filters on the base image or components in your image recipe, EC2 Image Builder will
|
|
1486
|
-
* new image only when there are new versions of the image or components in your
|
|
1487
|
-
* match the semantic version filter. When it is set to
|
|
1488
|
-
*
|
|
1489
|
-
* version syntax, see <a href="https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html">CreateComponent</a> in the <i> EC2 Image Builder API
|
|
1490
|
-
* Reference</i>.</p>
|
|
1650
|
+
* <code>pipelineExecutionStartCondition</code> is set to
|
|
1651
|
+
* <code>EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE</code>, and you use semantic
|
|
1652
|
+
* version filters on the base image or components in your image recipe, EC2 Image Builder will
|
|
1653
|
+
* build a new image only when there are new versions of the image or components in your
|
|
1654
|
+
* recipe that match the semantic version filter. When it is set to
|
|
1655
|
+
* <code>EXPRESSION_MATCH_ONLY</code>, it will build a new image every time the CRON
|
|
1656
|
+
* expression matches the current time. For semantic version syntax, see <a href="https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html">CreateComponent</a> in the <i> EC2 Image Builder API Reference</i>.</p>
|
|
1491
1657
|
*/
|
|
1492
1658
|
pipelineExecutionStartCondition?: PipelineExecutionStartCondition | string;
|
|
1493
1659
|
}
|
|
1494
1660
|
/**
|
|
1495
1661
|
* @public
|
|
1662
|
+
* @enum
|
|
1496
1663
|
*/
|
|
1497
|
-
export declare
|
|
1498
|
-
DISABLED
|
|
1499
|
-
ENABLED
|
|
1500
|
-
}
|
|
1664
|
+
export declare const PipelineStatus: {
|
|
1665
|
+
readonly DISABLED: "DISABLED";
|
|
1666
|
+
readonly ENABLED: "ENABLED";
|
|
1667
|
+
};
|
|
1668
|
+
/**
|
|
1669
|
+
* @public
|
|
1670
|
+
*/
|
|
1671
|
+
export type PipelineStatus = (typeof PipelineStatus)[keyof typeof PipelineStatus];
|
|
1501
1672
|
/**
|
|
1502
1673
|
* @public
|
|
1503
1674
|
*/
|
|
1504
1675
|
export interface CreateImagePipelineRequest {
|
|
1505
1676
|
/**
|
|
1506
|
-
* <p>
|
|
1677
|
+
* <p>The name of the image pipeline.</p>
|
|
1507
1678
|
*/
|
|
1508
1679
|
name: string | undefined;
|
|
1509
1680
|
/**
|
|
1510
|
-
* <p>
|
|
1681
|
+
* <p>The description of the image pipeline.</p>
|
|
1511
1682
|
*/
|
|
1512
1683
|
description?: string;
|
|
1513
1684
|
/**
|
|
1514
|
-
* <p>
|
|
1515
|
-
* created by this image pipeline.</p>
|
|
1685
|
+
* <p>The Amazon Resource Name (ARN) of the image recipe that will be used to configure
|
|
1686
|
+
* images created by this image pipeline.</p>
|
|
1516
1687
|
*/
|
|
1517
1688
|
imageRecipeArn?: string;
|
|
1518
1689
|
/**
|
|
1519
|
-
* <p>The Amazon Resource Name (ARN) of the container recipe that is used to configure
|
|
1690
|
+
* <p>The Amazon Resource Name (ARN) of the container recipe that is used to configure
|
|
1691
|
+
* images created by this container pipeline.</p>
|
|
1520
1692
|
*/
|
|
1521
1693
|
containerRecipeArn?: string;
|
|
1522
1694
|
/**
|
|
1523
|
-
* <p>
|
|
1524
|
-
* build images created by this image pipeline.</p>
|
|
1695
|
+
* <p>The Amazon Resource Name (ARN) of the infrastructure configuration that will be used
|
|
1696
|
+
* to build images created by this image pipeline.</p>
|
|
1525
1697
|
*/
|
|
1526
1698
|
infrastructureConfigurationArn: string | undefined;
|
|
1527
1699
|
/**
|
|
1528
|
-
* <p>
|
|
1700
|
+
* <p>The Amazon Resource Name (ARN) of the distribution configuration that will be used to
|
|
1529
1701
|
* configure and distribute images created by this image pipeline.</p>
|
|
1530
1702
|
*/
|
|
1531
1703
|
distributionConfigurationArn?: string;
|
|
1532
1704
|
/**
|
|
1533
|
-
* <p>
|
|
1705
|
+
* <p>The image test configuration of the image pipeline.</p>
|
|
1534
1706
|
*/
|
|
1535
1707
|
imageTestsConfiguration?: ImageTestsConfiguration;
|
|
1536
1708
|
/**
|
|
1537
|
-
* <p>
|
|
1709
|
+
* <p>Collects additional information about the image being created, including the operating
|
|
1538
1710
|
* system (OS) version and package list. This information is used to enhance the overall
|
|
1539
1711
|
* experience of using EC2 Image Builder. Enabled by default.</p>
|
|
1540
1712
|
*/
|
|
1541
1713
|
enhancedImageMetadataEnabled?: boolean;
|
|
1542
1714
|
/**
|
|
1543
|
-
* <p>
|
|
1715
|
+
* <p>The schedule of the image pipeline.</p>
|
|
1544
1716
|
*/
|
|
1545
1717
|
schedule?: Schedule;
|
|
1546
1718
|
/**
|
|
1547
|
-
* <p>
|
|
1719
|
+
* <p>The status of the image pipeline.</p>
|
|
1548
1720
|
*/
|
|
1549
1721
|
status?: PipelineStatus | string;
|
|
1550
1722
|
/**
|
|
1551
|
-
* <p>
|
|
1723
|
+
* <p>The tags of the image pipeline.</p>
|
|
1552
1724
|
*/
|
|
1553
1725
|
tags?: Record<string, string>;
|
|
1554
1726
|
/**
|
|
1555
|
-
* <p>
|
|
1727
|
+
* <p>The idempotency token used to make this request idempotent.</p>
|
|
1556
1728
|
*/
|
|
1557
1729
|
clientToken?: string;
|
|
1730
|
+
/**
|
|
1731
|
+
* <p>Contains settings for vulnerability scans.</p>
|
|
1732
|
+
*/
|
|
1733
|
+
imageScanningConfiguration?: ImageScanningConfiguration;
|
|
1558
1734
|
}
|
|
1559
1735
|
/**
|
|
1560
1736
|
* @public
|
|
1561
1737
|
*/
|
|
1562
1738
|
export interface CreateImagePipelineResponse {
|
|
1563
1739
|
/**
|
|
1564
|
-
* <p>
|
|
1740
|
+
* <p>The request ID that uniquely identifies this request.</p>
|
|
1565
1741
|
*/
|
|
1566
1742
|
requestId?: string;
|
|
1567
1743
|
/**
|
|
1568
|
-
* <p>
|
|
1744
|
+
* <p>The idempotency token used to make this request idempotent.</p>
|
|
1569
1745
|
*/
|
|
1570
1746
|
clientToken?: string;
|
|
1571
1747
|
/**
|
|
1572
|
-
* <p>
|
|
1748
|
+
* <p>The Amazon Resource Name (ARN) of the image pipeline that was created by this
|
|
1749
|
+
* request.</p>
|
|
1573
1750
|
*/
|
|
1574
1751
|
imagePipelineArn?: string;
|
|
1575
1752
|
}
|
|
@@ -1578,15 +1755,16 @@ export interface CreateImagePipelineResponse {
|
|
|
1578
1755
|
*/
|
|
1579
1756
|
export interface CreateImageRecipeRequest {
|
|
1580
1757
|
/**
|
|
1581
|
-
* <p>
|
|
1758
|
+
* <p>The name of the image recipe.</p>
|
|
1582
1759
|
*/
|
|
1583
1760
|
name: string | undefined;
|
|
1584
1761
|
/**
|
|
1585
|
-
* <p>
|
|
1762
|
+
* <p>The description of the image recipe.</p>
|
|
1586
1763
|
*/
|
|
1587
1764
|
description?: string;
|
|
1588
1765
|
/**
|
|
1589
|
-
* <p>The semantic version of the image recipe. This version follows the semantic version
|
|
1766
|
+
* <p>The semantic version of the image recipe. This version follows the semantic version
|
|
1767
|
+
* syntax.</p>
|
|
1590
1768
|
* <note>
|
|
1591
1769
|
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
1592
1770
|
* You can assign values for the first three, and can filter on all of them.</p>
|
|
@@ -1608,10 +1786,10 @@ export interface CreateImageRecipeRequest {
|
|
|
1608
1786
|
/**
|
|
1609
1787
|
* <p>The base image of the image recipe. The value of the string can be the ARN of the base
|
|
1610
1788
|
* image or an AMI ID. The format for the ARN follows this example:
|
|
1611
|
-
*
|
|
1789
|
+
* <code>arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x</code>.
|
|
1612
1790
|
* You can provide the specific version that you want to use, or you can use a wildcard in
|
|
1613
|
-
* all of the fields. If you enter an AMI ID for the string value, you must have access to
|
|
1614
|
-
* and the AMI must be in the same Region in which you are using Image Builder.</p>
|
|
1791
|
+
* all of the fields. If you enter an AMI ID for the string value, you must have access to
|
|
1792
|
+
* the AMI, and the AMI must be in the same Region in which you are using Image Builder.</p>
|
|
1615
1793
|
*/
|
|
1616
1794
|
parentImage: string | undefined;
|
|
1617
1795
|
/**
|
|
@@ -1619,7 +1797,7 @@ export interface CreateImageRecipeRequest {
|
|
|
1619
1797
|
*/
|
|
1620
1798
|
blockDeviceMappings?: InstanceBlockDeviceMapping[];
|
|
1621
1799
|
/**
|
|
1622
|
-
* <p>
|
|
1800
|
+
* <p>The tags of the image recipe.</p>
|
|
1623
1801
|
*/
|
|
1624
1802
|
tags?: Record<string, string>;
|
|
1625
1803
|
/**
|
|
@@ -1648,40 +1826,39 @@ export interface CreateImageRecipeResponse {
|
|
|
1648
1826
|
*/
|
|
1649
1827
|
clientToken?: string;
|
|
1650
1828
|
/**
|
|
1651
|
-
* <p>The Amazon Resource Name (ARN) of the image recipe that was created by this
|
|
1829
|
+
* <p>The Amazon Resource Name (ARN) of the image recipe that was created by this
|
|
1830
|
+
* request.</p>
|
|
1652
1831
|
*/
|
|
1653
1832
|
imageRecipeArn?: string;
|
|
1654
1833
|
}
|
|
1655
1834
|
/**
|
|
1656
1835
|
* @public
|
|
1657
|
-
* <p>The instance metadata options that apply to the HTTP requests that
|
|
1658
|
-
*
|
|
1659
|
-
*
|
|
1660
|
-
*
|
|
1836
|
+
* <p>The instance metadata options that apply to the HTTP requests that pipeline builds use
|
|
1837
|
+
* to launch EC2 build and test instances. For more information about instance metadata
|
|
1838
|
+
* options, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html">Configure the instance metadata options</a> in the
|
|
1839
|
+
* <i>
|
|
1661
1840
|
* <i>Amazon EC2 User Guide</i>
|
|
1662
|
-
* </i>
|
|
1663
|
-
*
|
|
1664
|
-
* the instance metadata options</a> in the <i>
|
|
1841
|
+
* </i> for Linux instances, or <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html">Configure the instance metadata options</a> in the
|
|
1842
|
+
* <i>
|
|
1665
1843
|
* <i>Amazon EC2 Windows Guide</i>
|
|
1666
|
-
* </i>
|
|
1667
|
-
* for Windows instances.</p>
|
|
1844
|
+
* </i> for Windows instances.</p>
|
|
1668
1845
|
*/
|
|
1669
1846
|
export interface InstanceMetadataOptions {
|
|
1670
1847
|
/**
|
|
1671
|
-
* <p>Indicates whether a signed token header is required for instance metadata retrieval
|
|
1672
|
-
* The values affect the response as follows:</p>
|
|
1848
|
+
* <p>Indicates whether a signed token header is required for instance metadata retrieval
|
|
1849
|
+
* requests. The values affect the response as follows:</p>
|
|
1673
1850
|
* <ul>
|
|
1674
1851
|
* <li>
|
|
1675
1852
|
* <p>
|
|
1676
|
-
* <b>required</b> – When you retrieve the
|
|
1677
|
-
*
|
|
1853
|
+
* <b>required</b> – When you retrieve the IAM
|
|
1854
|
+
* role credentials, version 2.0 credentials are returned in all cases.</p>
|
|
1678
1855
|
* </li>
|
|
1679
1856
|
* <li>
|
|
1680
1857
|
* <p>
|
|
1681
|
-
* <b>optional</b> – You can include a signed
|
|
1682
|
-
* in your request to retrieve instance metadata, or you can leave it
|
|
1683
|
-
* include it, version 2.0 credentials are returned for the IAM role.
|
|
1684
|
-
* version 1.0 credentials are returned.</p>
|
|
1858
|
+
* <b>optional</b> – You can include a signed
|
|
1859
|
+
* token header in your request to retrieve instance metadata, or you can leave it
|
|
1860
|
+
* out. If you include it, version 2.0 credentials are returned for the IAM role.
|
|
1861
|
+
* Otherwise, version 1.0 credentials are returned.</p>
|
|
1685
1862
|
* </li>
|
|
1686
1863
|
* </ul>
|
|
1687
1864
|
* <p>The default setting is <b>optional</b>.</p>
|
|
@@ -1732,16 +1909,18 @@ export interface CreateInfrastructureConfigurationRequest {
|
|
|
1732
1909
|
description?: string;
|
|
1733
1910
|
/**
|
|
1734
1911
|
* <p>The instance types of the infrastructure configuration. You can specify one or more
|
|
1735
|
-
* instance types to use for this build. The service will pick one of these instance types
|
|
1736
|
-
* on availability.</p>
|
|
1912
|
+
* instance types to use for this build. The service will pick one of these instance types
|
|
1913
|
+
* based on availability.</p>
|
|
1737
1914
|
*/
|
|
1738
1915
|
instanceTypes?: string[];
|
|
1739
1916
|
/**
|
|
1740
|
-
* <p>The instance profile to associate with the instance used to customize your Amazon EC2
|
|
1917
|
+
* <p>The instance profile to associate with the instance used to customize your Amazon EC2
|
|
1918
|
+
* AMI.</p>
|
|
1741
1919
|
*/
|
|
1742
1920
|
instanceProfileName: string | undefined;
|
|
1743
1921
|
/**
|
|
1744
|
-
* <p>The security group IDs to associate with the instance used to customize your Amazon EC2
|
|
1922
|
+
* <p>The security group IDs to associate with the instance used to customize your Amazon EC2
|
|
1923
|
+
* AMI.</p>
|
|
1745
1924
|
*/
|
|
1746
1925
|
securityGroupIds?: string[];
|
|
1747
1926
|
/**
|
|
@@ -1753,18 +1932,19 @@ export interface CreateInfrastructureConfigurationRequest {
|
|
|
1753
1932
|
*/
|
|
1754
1933
|
logging?: Logging;
|
|
1755
1934
|
/**
|
|
1756
|
-
* <p>The key pair of the infrastructure configuration. You can use this to log on to and
|
|
1757
|
-
* the instance used to create your image.</p>
|
|
1935
|
+
* <p>The key pair of the infrastructure configuration. You can use this to log on to and
|
|
1936
|
+
* debug the instance used to create your image.</p>
|
|
1758
1937
|
*/
|
|
1759
1938
|
keyPair?: string;
|
|
1760
1939
|
/**
|
|
1761
1940
|
* <p>The terminate instance on failure setting of the infrastructure configuration. Set to
|
|
1762
|
-
* false if you want Image Builder to retain the instance used to configure your AMI if the build
|
|
1763
|
-
*
|
|
1941
|
+
* false if you want Image Builder to retain the instance used to configure your AMI if the build or
|
|
1942
|
+
* test phase of your workflow fails.</p>
|
|
1764
1943
|
*/
|
|
1765
1944
|
terminateInstanceOnFailure?: boolean;
|
|
1766
1945
|
/**
|
|
1767
|
-
* <p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event
|
|
1946
|
+
* <p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event
|
|
1947
|
+
* notifications.</p>
|
|
1768
1948
|
* <note>
|
|
1769
1949
|
* <p>EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys
|
|
1770
1950
|
* from other accounts. The key that is used to encrypt the SNS topic must reside in the
|
|
@@ -1777,8 +1957,8 @@ export interface CreateInfrastructureConfigurationRequest {
|
|
|
1777
1957
|
*/
|
|
1778
1958
|
resourceTags?: Record<string, string>;
|
|
1779
1959
|
/**
|
|
1780
|
-
* <p>The instance metadata options that you can set for the HTTP requests that
|
|
1781
|
-
*
|
|
1960
|
+
* <p>The instance metadata options that you can set for the HTTP requests that pipeline
|
|
1961
|
+
* builds use to launch EC2 build and test instances.</p>
|
|
1782
1962
|
*/
|
|
1783
1963
|
instanceMetadataOptions?: InstanceMetadataOptions;
|
|
1784
1964
|
/**
|
|
@@ -1808,6 +1988,79 @@ export interface CreateInfrastructureConfigurationResponse {
|
|
|
1808
1988
|
*/
|
|
1809
1989
|
infrastructureConfigurationArn?: string;
|
|
1810
1990
|
}
|
|
1991
|
+
/**
|
|
1992
|
+
* @public
|
|
1993
|
+
* <p>Amazon Inspector generates a risk score for each finding. This score helps you to prioritize
|
|
1994
|
+
* findings, to focus on the most critical findings and the most vulnerable resources. The
|
|
1995
|
+
* score uses the Common Vulnerability Scoring System (CVSS) format. This format is a
|
|
1996
|
+
* modification of the base CVSS score that the National Vulnerability Database (NVD)
|
|
1997
|
+
* provides. For more information about severity levels, see <a href="https://docs.aws.amazon.com/inspector/latest/user/findings-understanding-severity.html">Severity levels for Amazon Inspector findings</a> in the <i>Amazon Inspector User
|
|
1998
|
+
* Guide</i>.</p>
|
|
1999
|
+
*/
|
|
2000
|
+
export interface CvssScore {
|
|
2001
|
+
/**
|
|
2002
|
+
* <p>The CVSS base score.</p>
|
|
2003
|
+
*/
|
|
2004
|
+
baseScore?: number;
|
|
2005
|
+
/**
|
|
2006
|
+
* <p>The vector string of the CVSS score.</p>
|
|
2007
|
+
*/
|
|
2008
|
+
scoringVector?: string;
|
|
2009
|
+
/**
|
|
2010
|
+
* <p>The CVSS version that generated the score.</p>
|
|
2011
|
+
*/
|
|
2012
|
+
version?: string;
|
|
2013
|
+
/**
|
|
2014
|
+
* <p>The source of the CVSS score.</p>
|
|
2015
|
+
*/
|
|
2016
|
+
source?: string;
|
|
2017
|
+
}
|
|
2018
|
+
/**
|
|
2019
|
+
* @public
|
|
2020
|
+
* <p>Details about an adjustment that Amazon Inspector made to the CVSS score for a finding.</p>
|
|
2021
|
+
*/
|
|
2022
|
+
export interface CvssScoreAdjustment {
|
|
2023
|
+
/**
|
|
2024
|
+
* <p>The metric that Amazon Inspector used to adjust the CVSS score.</p>
|
|
2025
|
+
*/
|
|
2026
|
+
metric?: string;
|
|
2027
|
+
/**
|
|
2028
|
+
* <p>The reason for the CVSS score adjustment.</p>
|
|
2029
|
+
*/
|
|
2030
|
+
reason?: string;
|
|
2031
|
+
}
|
|
2032
|
+
/**
|
|
2033
|
+
* @public
|
|
2034
|
+
* <p>Details about the source of the score, and the factors that determined the adjustments
|
|
2035
|
+
* to create the final score.</p>
|
|
2036
|
+
*/
|
|
2037
|
+
export interface CvssScoreDetails {
|
|
2038
|
+
/**
|
|
2039
|
+
* <p>The source for the CVSS score.</p>
|
|
2040
|
+
*/
|
|
2041
|
+
scoreSource?: string;
|
|
2042
|
+
/**
|
|
2043
|
+
* <p>The source of the finding.</p>
|
|
2044
|
+
*/
|
|
2045
|
+
cvssSource?: string;
|
|
2046
|
+
/**
|
|
2047
|
+
* <p>The CVSS version that generated the score.</p>
|
|
2048
|
+
*/
|
|
2049
|
+
version?: string;
|
|
2050
|
+
/**
|
|
2051
|
+
* <p>The CVSS score.</p>
|
|
2052
|
+
*/
|
|
2053
|
+
score?: number;
|
|
2054
|
+
/**
|
|
2055
|
+
* <p>A vector that measures the severity of the vulnerability.</p>
|
|
2056
|
+
*/
|
|
2057
|
+
scoringVector?: string;
|
|
2058
|
+
/**
|
|
2059
|
+
* <p>An object that contains details about an adjustment that Amazon Inspector made to the CVSS score
|
|
2060
|
+
* for the finding.</p>
|
|
2061
|
+
*/
|
|
2062
|
+
adjustments?: CvssScoreAdjustment[];
|
|
2063
|
+
}
|
|
1811
2064
|
/**
|
|
1812
2065
|
* @public
|
|
1813
2066
|
*/
|
|
@@ -1826,14 +2079,14 @@ export interface DeleteComponentResponse {
|
|
|
1826
2079
|
*/
|
|
1827
2080
|
requestId?: string;
|
|
1828
2081
|
/**
|
|
1829
|
-
* <p>The
|
|
2082
|
+
* <p>The ARN of the component build version that this request deleted.</p>
|
|
1830
2083
|
*/
|
|
1831
2084
|
componentBuildVersionArn?: string;
|
|
1832
2085
|
}
|
|
1833
2086
|
/**
|
|
1834
2087
|
* @public
|
|
1835
|
-
* <p>You have attempted to mutate or delete a resource with a dependency that prohibits
|
|
1836
|
-
* action. See the error message for more details.</p>
|
|
2088
|
+
* <p>You have attempted to mutate or delete a resource with a dependency that prohibits
|
|
2089
|
+
* this action. See the error message for more details.</p>
|
|
1837
2090
|
*/
|
|
1838
2091
|
export declare class ResourceDependencyException extends __BaseException {
|
|
1839
2092
|
readonly name: "ResourceDependencyException";
|
|
@@ -1883,7 +2136,8 @@ export interface DeleteDistributionConfigurationResponse {
|
|
|
1883
2136
|
*/
|
|
1884
2137
|
requestId?: string;
|
|
1885
2138
|
/**
|
|
1886
|
-
* <p>The Amazon Resource Name (ARN) of the distribution configuration that was
|
|
2139
|
+
* <p>The Amazon Resource Name (ARN) of the distribution configuration that was
|
|
2140
|
+
* deleted.</p>
|
|
1887
2141
|
*/
|
|
1888
2142
|
distributionConfigurationArn?: string;
|
|
1889
2143
|
}
|
|
@@ -1905,7 +2159,7 @@ export interface DeleteImageResponse {
|
|
|
1905
2159
|
*/
|
|
1906
2160
|
requestId?: string;
|
|
1907
2161
|
/**
|
|
1908
|
-
* <p>The
|
|
2162
|
+
* <p>The ARN of the Image Builder image resource that this request deleted.</p>
|
|
1909
2163
|
*/
|
|
1910
2164
|
imageBuildVersionArn?: string;
|
|
1911
2165
|
}
|
|
@@ -1971,7 +2225,8 @@ export interface DeleteInfrastructureConfigurationResponse {
|
|
|
1971
2225
|
*/
|
|
1972
2226
|
requestId?: string;
|
|
1973
2227
|
/**
|
|
1974
|
-
* <p>The Amazon Resource Name (ARN) of the infrastructure configuration that was
|
|
2228
|
+
* <p>The Amazon Resource Name (ARN) of the infrastructure configuration that was
|
|
2229
|
+
* deleted.</p>
|
|
1975
2230
|
*/
|
|
1976
2231
|
infrastructureConfigurationArn?: string;
|
|
1977
2232
|
}
|
|
@@ -1993,8 +2248,8 @@ export interface DistributionConfiguration {
|
|
|
1993
2248
|
*/
|
|
1994
2249
|
description?: string;
|
|
1995
2250
|
/**
|
|
1996
|
-
* <p>The distribution objects that apply Region-specific
|
|
1997
|
-
*
|
|
2251
|
+
* <p>The distribution objects that apply Region-specific settings for the deployment of the
|
|
2252
|
+
* image to targeted Regions.</p>
|
|
1998
2253
|
*/
|
|
1999
2254
|
distributions?: Distribution[];
|
|
2000
2255
|
/**
|
|
@@ -2050,9 +2305,9 @@ export interface DistributionConfigurationSummary {
|
|
|
2050
2305
|
}
|
|
2051
2306
|
/**
|
|
2052
2307
|
* @public
|
|
2053
|
-
* <p>A filter name and value pair that is used to return a more specific list of results
|
|
2054
|
-
* list operation. Filters can be used to match a set of resources by specific
|
|
2055
|
-
* tags, attributes, or IDs.</p>
|
|
2308
|
+
* <p>A filter name and value pair that is used to return a more specific list of results
|
|
2309
|
+
* from a list operation. Filters can be used to match a set of resources by specific
|
|
2310
|
+
* criteria, such as tags, attributes, or IDs.</p>
|
|
2056
2311
|
*/
|
|
2057
2312
|
export interface Filter {
|
|
2058
2313
|
/**
|
|
@@ -2069,8 +2324,8 @@ export interface Filter {
|
|
|
2069
2324
|
*/
|
|
2070
2325
|
export interface GetComponentRequest {
|
|
2071
2326
|
/**
|
|
2072
|
-
* <p>The Amazon Resource Name (ARN) of the component that you want to
|
|
2073
|
-
*
|
|
2327
|
+
* <p>The Amazon Resource Name (ARN) of the component that you want to get. Regex requires
|
|
2328
|
+
* the suffix <code>/\d+$</code>.</p>
|
|
2074
2329
|
*/
|
|
2075
2330
|
componentBuildVersionArn: string | undefined;
|
|
2076
2331
|
}
|
|
@@ -2092,7 +2347,8 @@ export interface GetComponentResponse {
|
|
|
2092
2347
|
*/
|
|
2093
2348
|
export interface GetComponentPolicyRequest {
|
|
2094
2349
|
/**
|
|
2095
|
-
* <p>The Amazon Resource Name (ARN) of the component whose policy you want to
|
|
2350
|
+
* <p>The Amazon Resource Name (ARN) of the component whose policy you want to
|
|
2351
|
+
* retrieve.</p>
|
|
2096
2352
|
*/
|
|
2097
2353
|
componentArn: string | undefined;
|
|
2098
2354
|
}
|
|
@@ -2148,7 +2404,8 @@ export interface GetContainerRecipeResponse {
|
|
|
2148
2404
|
*/
|
|
2149
2405
|
export interface GetContainerRecipePolicyRequest {
|
|
2150
2406
|
/**
|
|
2151
|
-
* <p>The Amazon Resource Name (ARN) of the container recipe for the policy being
|
|
2407
|
+
* <p>The Amazon Resource Name (ARN) of the container recipe for the policy being
|
|
2408
|
+
* requested.</p>
|
|
2152
2409
|
*/
|
|
2153
2410
|
containerRecipeArn: string | undefined;
|
|
2154
2411
|
}
|
|
@@ -2193,17 +2450,22 @@ export interface GetDistributionConfigurationResponse {
|
|
|
2193
2450
|
*/
|
|
2194
2451
|
export interface GetImageRequest {
|
|
2195
2452
|
/**
|
|
2196
|
-
* <p>The Amazon Resource Name (ARN) of the image that you want to
|
|
2453
|
+
* <p>The Amazon Resource Name (ARN) of the image that you want to get.</p>
|
|
2197
2454
|
*/
|
|
2198
2455
|
imageBuildVersionArn: string | undefined;
|
|
2199
2456
|
}
|
|
2200
2457
|
/**
|
|
2201
2458
|
* @public
|
|
2459
|
+
* @enum
|
|
2202
2460
|
*/
|
|
2203
|
-
export declare
|
|
2204
|
-
AMI
|
|
2205
|
-
DOCKER
|
|
2206
|
-
}
|
|
2461
|
+
export declare const ImageType: {
|
|
2462
|
+
readonly AMI: "AMI";
|
|
2463
|
+
readonly DOCKER: "DOCKER";
|
|
2464
|
+
};
|
|
2465
|
+
/**
|
|
2466
|
+
* @public
|
|
2467
|
+
*/
|
|
2468
|
+
export type ImageType = (typeof ImageType)[keyof typeof ImageType];
|
|
2207
2469
|
/**
|
|
2208
2470
|
* @public
|
|
2209
2471
|
* <p>An image recipe.</p>
|
|
@@ -2214,8 +2476,8 @@ export interface ImageRecipe {
|
|
|
2214
2476
|
*/
|
|
2215
2477
|
arn?: string;
|
|
2216
2478
|
/**
|
|
2217
|
-
* <p>Specifies which type of image is created by the recipe - an AMI or a
|
|
2218
|
-
*
|
|
2479
|
+
* <p>Specifies which type of image is created by the recipe - an AMI or a container
|
|
2480
|
+
* image.</p>
|
|
2219
2481
|
*/
|
|
2220
2482
|
type?: ImageType | string;
|
|
2221
2483
|
/**
|
|
@@ -2264,22 +2526,27 @@ export interface ImageRecipe {
|
|
|
2264
2526
|
*/
|
|
2265
2527
|
workingDirectory?: string;
|
|
2266
2528
|
/**
|
|
2267
|
-
* <p>Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to
|
|
2268
|
-
*
|
|
2269
|
-
*
|
|
2270
|
-
*
|
|
2529
|
+
* <p>Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test
|
|
2530
|
+
* your image configuration. Instance configuration adds a layer of control over those
|
|
2531
|
+
* instances. You can define settings and add scripts to run when an instance is launched
|
|
2532
|
+
* from your AMI.</p>
|
|
2271
2533
|
*/
|
|
2272
2534
|
additionalInstanceConfiguration?: AdditionalInstanceConfiguration;
|
|
2273
2535
|
}
|
|
2274
2536
|
/**
|
|
2275
2537
|
* @public
|
|
2538
|
+
* @enum
|
|
2276
2539
|
*/
|
|
2277
|
-
export declare
|
|
2278
|
-
AMAZON_MANAGED
|
|
2279
|
-
AWS_MARKETPLACE
|
|
2280
|
-
CUSTOM
|
|
2281
|
-
IMPORTED
|
|
2282
|
-
}
|
|
2540
|
+
export declare const ImageSource: {
|
|
2541
|
+
readonly AMAZON_MANAGED: "AMAZON_MANAGED";
|
|
2542
|
+
readonly AWS_MARKETPLACE: "AWS_MARKETPLACE";
|
|
2543
|
+
readonly CUSTOM: "CUSTOM";
|
|
2544
|
+
readonly IMPORTED: "IMPORTED";
|
|
2545
|
+
};
|
|
2546
|
+
/**
|
|
2547
|
+
* @public
|
|
2548
|
+
*/
|
|
2549
|
+
export type ImageSource = (typeof ImageSource)[keyof typeof ImageSource];
|
|
2283
2550
|
/**
|
|
2284
2551
|
* @public
|
|
2285
2552
|
* <p>Details of the infrastructure configuration.</p>
|
|
@@ -2327,7 +2594,8 @@ export interface InfrastructureConfiguration {
|
|
|
2327
2594
|
*/
|
|
2328
2595
|
terminateInstanceOnFailure?: boolean;
|
|
2329
2596
|
/**
|
|
2330
|
-
* <p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event
|
|
2597
|
+
* <p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event
|
|
2598
|
+
* notifications.</p>
|
|
2331
2599
|
* <note>
|
|
2332
2600
|
* <p>EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys
|
|
2333
2601
|
* from other accounts. The key that is used to encrypt the SNS topic must reside in the
|
|
@@ -2366,15 +2634,48 @@ export interface OutputResources {
|
|
|
2366
2634
|
*/
|
|
2367
2635
|
amis?: Ami[];
|
|
2368
2636
|
/**
|
|
2369
|
-
* <p>Container images that the pipeline has generated and stored in the output
|
|
2637
|
+
* <p>Container images that the pipeline has generated and stored in the output
|
|
2638
|
+
* repository.</p>
|
|
2370
2639
|
*/
|
|
2371
2640
|
containers?: Container[];
|
|
2372
2641
|
}
|
|
2373
2642
|
/**
|
|
2374
2643
|
* @public
|
|
2375
|
-
*
|
|
2376
|
-
|
|
2377
|
-
|
|
2644
|
+
* @enum
|
|
2645
|
+
*/
|
|
2646
|
+
export declare const ImageScanStatus: {
|
|
2647
|
+
readonly ABANDONED: "ABANDONED";
|
|
2648
|
+
readonly COLLECTING: "COLLECTING";
|
|
2649
|
+
readonly COMPLETED: "COMPLETED";
|
|
2650
|
+
readonly FAILED: "FAILED";
|
|
2651
|
+
readonly PENDING: "PENDING";
|
|
2652
|
+
readonly SCANNING: "SCANNING";
|
|
2653
|
+
readonly TIMED_OUT: "TIMED_OUT";
|
|
2654
|
+
};
|
|
2655
|
+
/**
|
|
2656
|
+
* @public
|
|
2657
|
+
*/
|
|
2658
|
+
export type ImageScanStatus = (typeof ImageScanStatus)[keyof typeof ImageScanStatus];
|
|
2659
|
+
/**
|
|
2660
|
+
* @public
|
|
2661
|
+
* <p>Shows the vulnerability scan status for a specific image, and the reason for that
|
|
2662
|
+
* status.</p>
|
|
2663
|
+
*/
|
|
2664
|
+
export interface ImageScanState {
|
|
2665
|
+
/**
|
|
2666
|
+
* <p>The current state of vulnerability scans for the image.</p>
|
|
2667
|
+
*/
|
|
2668
|
+
status?: ImageScanStatus | string;
|
|
2669
|
+
/**
|
|
2670
|
+
* <p>The reason for the scan status for the image.</p>
|
|
2671
|
+
*/
|
|
2672
|
+
reason?: string;
|
|
2673
|
+
}
|
|
2674
|
+
/**
|
|
2675
|
+
* @public
|
|
2676
|
+
* <p>An Image Builder image. You must specify exactly one recipe for the image – either a
|
|
2677
|
+
* container recipe (<code>containerRecipe</code>), which creates a container image, or an
|
|
2678
|
+
* image recipe (<code>imageRecipe</code>), which creates an AMI.</p>
|
|
2378
2679
|
*/
|
|
2379
2680
|
export interface Image {
|
|
2380
2681
|
/**
|
|
@@ -2445,13 +2746,13 @@ export interface Image {
|
|
|
2445
2746
|
*/
|
|
2446
2747
|
state?: ImageState;
|
|
2447
2748
|
/**
|
|
2448
|
-
* <p>For images that distribute an AMI, this is the image recipe that Image Builder used to
|
|
2449
|
-
*
|
|
2749
|
+
* <p>For images that distribute an AMI, this is the image recipe that Image Builder used to create
|
|
2750
|
+
* the image. For container images, this is empty.</p>
|
|
2450
2751
|
*/
|
|
2451
2752
|
imageRecipe?: ImageRecipe;
|
|
2452
2753
|
/**
|
|
2453
|
-
* <p>For container images, this is the container recipe that Image Builder used to create the
|
|
2454
|
-
*
|
|
2754
|
+
* <p>For container images, this is the container recipe that Image Builder used to create the image.
|
|
2755
|
+
* For images that distribute an AMI, this is empty.</p>
|
|
2455
2756
|
*/
|
|
2456
2757
|
containerRecipe?: ContainerRecipe;
|
|
2457
2758
|
/**
|
|
@@ -2487,8 +2788,8 @@ export interface Image {
|
|
|
2487
2788
|
*/
|
|
2488
2789
|
tags?: Record<string, string>;
|
|
2489
2790
|
/**
|
|
2490
|
-
* <p>Indicates the type of build that created this image. The build can be initiated
|
|
2491
|
-
*
|
|
2791
|
+
* <p>Indicates the type of build that created this image. The build can be initiated in the
|
|
2792
|
+
* following ways:</p>
|
|
2492
2793
|
* <ul>
|
|
2493
2794
|
* <li>
|
|
2494
2795
|
* <p>
|
|
@@ -2512,6 +2813,14 @@ export interface Image {
|
|
|
2512
2813
|
* <p>The origin of the base image that Image Builder used to build this image.</p>
|
|
2513
2814
|
*/
|
|
2514
2815
|
imageSource?: ImageSource | string;
|
|
2816
|
+
/**
|
|
2817
|
+
* <p>Contains information about the current state of scans for this image.</p>
|
|
2818
|
+
*/
|
|
2819
|
+
scanState?: ImageScanState;
|
|
2820
|
+
/**
|
|
2821
|
+
* <p>Contains settings for vulnerability scans.</p>
|
|
2822
|
+
*/
|
|
2823
|
+
imageScanningConfiguration?: ImageScanningConfiguration;
|
|
2515
2824
|
}
|
|
2516
2825
|
/**
|
|
2517
2826
|
* @public
|
|
@@ -2557,7 +2866,7 @@ export interface ImagePipeline {
|
|
|
2557
2866
|
*/
|
|
2558
2867
|
platform?: Platform | string;
|
|
2559
2868
|
/**
|
|
2560
|
-
* <p>
|
|
2869
|
+
* <p>Collects additional information about the image being created, including the operating
|
|
2561
2870
|
* system (OS) version and package list. This information is used to enhance the overall
|
|
2562
2871
|
* experience of using EC2 Image Builder. Enabled by default.</p>
|
|
2563
2872
|
*/
|
|
@@ -2568,12 +2877,13 @@ export interface ImagePipeline {
|
|
|
2568
2877
|
*/
|
|
2569
2878
|
imageRecipeArn?: string;
|
|
2570
2879
|
/**
|
|
2571
|
-
* <p>The Amazon Resource Name (ARN) of the container recipe that is used for this
|
|
2880
|
+
* <p>The Amazon Resource Name (ARN) of the container recipe that is used for this
|
|
2881
|
+
* pipeline.</p>
|
|
2572
2882
|
*/
|
|
2573
2883
|
containerRecipeArn?: string;
|
|
2574
2884
|
/**
|
|
2575
|
-
* <p>The Amazon Resource Name (ARN) of the infrastructure configuration associated with
|
|
2576
|
-
* image pipeline.</p>
|
|
2885
|
+
* <p>The Amazon Resource Name (ARN) of the infrastructure configuration associated with
|
|
2886
|
+
* this image pipeline.</p>
|
|
2577
2887
|
*/
|
|
2578
2888
|
infrastructureConfigurationArn?: string;
|
|
2579
2889
|
/**
|
|
@@ -2613,6 +2923,10 @@ export interface ImagePipeline {
|
|
|
2613
2923
|
* <p>The tags of this image pipeline.</p>
|
|
2614
2924
|
*/
|
|
2615
2925
|
tags?: Record<string, string>;
|
|
2926
|
+
/**
|
|
2927
|
+
* <p>Contains settings for vulnerability scans.</p>
|
|
2928
|
+
*/
|
|
2929
|
+
imageScanningConfiguration?: ImageScanningConfiguration;
|
|
2616
2930
|
}
|
|
2617
2931
|
/**
|
|
2618
2932
|
* @public
|
|
@@ -2676,7 +2990,8 @@ export interface GetImageRecipeResponse {
|
|
|
2676
2990
|
*/
|
|
2677
2991
|
export interface GetImageRecipePolicyRequest {
|
|
2678
2992
|
/**
|
|
2679
|
-
* <p>The Amazon Resource Name (ARN) of the image recipe whose policy you want to
|
|
2993
|
+
* <p>The Amazon Resource Name (ARN) of the image recipe whose policy you want to
|
|
2994
|
+
* retrieve.</p>
|
|
2680
2995
|
*/
|
|
2681
2996
|
imageRecipeArn: string | undefined;
|
|
2682
2997
|
}
|
|
@@ -2695,7 +3010,7 @@ export interface GetImageRecipePolicyResponse {
|
|
|
2695
3010
|
}
|
|
2696
3011
|
/**
|
|
2697
3012
|
* @public
|
|
2698
|
-
* <p>
|
|
3013
|
+
* <p>GetInfrastructureConfiguration request object.</p>
|
|
2699
3014
|
*/
|
|
2700
3015
|
export interface GetInfrastructureConfigurationRequest {
|
|
2701
3016
|
/**
|
|
@@ -2721,99 +3036,339 @@ export interface GetInfrastructureConfigurationResponse {
|
|
|
2721
3036
|
/**
|
|
2722
3037
|
* @public
|
|
2723
3038
|
*/
|
|
2724
|
-
export interface
|
|
3039
|
+
export interface GetWorkflowExecutionRequest {
|
|
2725
3040
|
/**
|
|
2726
|
-
* <p>
|
|
3041
|
+
* <p>Use the unique identifier for a runtime instance of the workflow to get
|
|
3042
|
+
* runtime details.</p>
|
|
2727
3043
|
*/
|
|
2728
|
-
|
|
2729
|
-
|
|
2730
|
-
|
|
2731
|
-
|
|
2732
|
-
|
|
2733
|
-
|
|
2734
|
-
|
|
2735
|
-
|
|
2736
|
-
|
|
2737
|
-
|
|
2738
|
-
|
|
2739
|
-
|
|
2740
|
-
|
|
2741
|
-
|
|
3044
|
+
workflowExecutionId: string | undefined;
|
|
3045
|
+
}
|
|
3046
|
+
/**
|
|
3047
|
+
* @public
|
|
3048
|
+
* @enum
|
|
3049
|
+
*/
|
|
3050
|
+
export declare const WorkflowExecutionStatus: {
|
|
3051
|
+
readonly COMPLETED: "COMPLETED";
|
|
3052
|
+
readonly FAILED: "FAILED";
|
|
3053
|
+
readonly PENDING: "PENDING";
|
|
3054
|
+
readonly ROLLBACK_COMPLETED: "ROLLBACK_COMPLETED";
|
|
3055
|
+
readonly ROLLBACK_IN_PROGRESS: "ROLLBACK_IN_PROGRESS";
|
|
3056
|
+
readonly RUNNING: "RUNNING";
|
|
3057
|
+
readonly SKIPPED: "SKIPPED";
|
|
3058
|
+
};
|
|
3059
|
+
/**
|
|
3060
|
+
* @public
|
|
3061
|
+
*/
|
|
3062
|
+
export type WorkflowExecutionStatus = (typeof WorkflowExecutionStatus)[keyof typeof WorkflowExecutionStatus];
|
|
3063
|
+
/**
|
|
3064
|
+
* @public
|
|
3065
|
+
* @enum
|
|
3066
|
+
*/
|
|
3067
|
+
export declare const WorkflowType: {
|
|
3068
|
+
readonly BUILD: "BUILD";
|
|
3069
|
+
readonly DISTRIBUTION: "DISTRIBUTION";
|
|
3070
|
+
readonly TEST: "TEST";
|
|
3071
|
+
};
|
|
3072
|
+
/**
|
|
3073
|
+
* @public
|
|
3074
|
+
*/
|
|
3075
|
+
export type WorkflowType = (typeof WorkflowType)[keyof typeof WorkflowType];
|
|
3076
|
+
/**
|
|
3077
|
+
* @public
|
|
3078
|
+
*/
|
|
3079
|
+
export interface GetWorkflowExecutionResponse {
|
|
2742
3080
|
/**
|
|
2743
|
-
* <p>The
|
|
3081
|
+
* <p>The request ID that uniquely identifies this request.</p>
|
|
2744
3082
|
*/
|
|
2745
|
-
|
|
3083
|
+
requestId?: string;
|
|
2746
3084
|
/**
|
|
2747
|
-
* <p>The
|
|
2748
|
-
*
|
|
3085
|
+
* <p>The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource
|
|
3086
|
+
* that defines the specified runtime instance of the workflow.</p>
|
|
2749
3087
|
*/
|
|
2750
|
-
|
|
3088
|
+
workflowBuildVersionArn?: string;
|
|
2751
3089
|
/**
|
|
2752
|
-
* <p>The
|
|
2753
|
-
*
|
|
3090
|
+
* <p>The unique identifier that Image Builder assigned to keep track of runtime details
|
|
3091
|
+
* when it ran the workflow.</p>
|
|
2754
3092
|
*/
|
|
2755
|
-
|
|
3093
|
+
workflowExecutionId?: string;
|
|
2756
3094
|
/**
|
|
2757
|
-
* <p>The
|
|
3095
|
+
* <p>The Amazon Resource Name (ARN) of the image resource build version that the specified
|
|
3096
|
+
* runtime instance of the workflow created.</p>
|
|
2758
3097
|
*/
|
|
2759
|
-
|
|
3098
|
+
imageBuildVersionArn?: string;
|
|
2760
3099
|
/**
|
|
2761
|
-
* <p>The
|
|
3100
|
+
* <p>The type of workflow that Image Builder ran for the specified runtime instance of the workflow.</p>
|
|
2762
3101
|
*/
|
|
2763
|
-
|
|
3102
|
+
type?: WorkflowType | string;
|
|
2764
3103
|
/**
|
|
2765
|
-
* <p>The
|
|
2766
|
-
* <code>uri</code> can be used to specify the data within the component.</p>
|
|
3104
|
+
* <p>The current runtime status for the specified runtime instance of the workflow.</p>
|
|
2767
3105
|
*/
|
|
2768
|
-
|
|
3106
|
+
status?: WorkflowExecutionStatus | string;
|
|
2769
3107
|
/**
|
|
2770
|
-
* <p>The
|
|
2771
|
-
* access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service
|
|
2772
|
-
* quota. Either <code>data</code> or <code>uri</code> can be used to specify the data within the
|
|
2773
|
-
* component.</p>
|
|
3108
|
+
* <p>The output message from the specified runtime instance of the workflow, if applicable.</p>
|
|
2774
3109
|
*/
|
|
2775
|
-
|
|
3110
|
+
message?: string;
|
|
2776
3111
|
/**
|
|
2777
|
-
* <p>The
|
|
3112
|
+
* <p>The total number of steps in the specified runtime instance of the workflow that ran.
|
|
3113
|
+
* This number should equal the sum of the step counts for steps that succeeded, were skipped,
|
|
3114
|
+
* and failed.</p>
|
|
2778
3115
|
*/
|
|
2779
|
-
|
|
3116
|
+
totalStepCount?: number;
|
|
2780
3117
|
/**
|
|
2781
|
-
* <p>
|
|
3118
|
+
* <p>A runtime count for the number of steps that ran successfully in the specified runtime
|
|
3119
|
+
* instance of the workflow.</p>
|
|
2782
3120
|
*/
|
|
2783
|
-
|
|
3121
|
+
totalStepsSucceeded?: number;
|
|
2784
3122
|
/**
|
|
2785
|
-
* <p>
|
|
3123
|
+
* <p>A runtime count for the number of steps that failed in the specified runtime instance
|
|
3124
|
+
* of the workflow.</p>
|
|
2786
3125
|
*/
|
|
2787
|
-
|
|
2788
|
-
}
|
|
2789
|
-
/**
|
|
2790
|
-
* @public
|
|
2791
|
-
*/
|
|
2792
|
-
export interface ImportComponentResponse {
|
|
3126
|
+
totalStepsFailed?: number;
|
|
2793
3127
|
/**
|
|
2794
|
-
* <p>
|
|
3128
|
+
* <p>A runtime count for the number of steps that were skipped in the specified runtime
|
|
3129
|
+
* instance of the workflow.</p>
|
|
2795
3130
|
*/
|
|
2796
|
-
|
|
3131
|
+
totalStepsSkipped?: number;
|
|
2797
3132
|
/**
|
|
2798
|
-
* <p>The
|
|
3133
|
+
* <p>The timestamp when the specified runtime instance of the workflow started.</p>
|
|
2799
3134
|
*/
|
|
2800
|
-
|
|
3135
|
+
startTime?: string;
|
|
2801
3136
|
/**
|
|
2802
|
-
* <p>The
|
|
3137
|
+
* <p>The timestamp when the specified runtime instance of the workflow finished.</p>
|
|
2803
3138
|
*/
|
|
2804
|
-
|
|
3139
|
+
endTime?: string;
|
|
2805
3140
|
}
|
|
2806
3141
|
/**
|
|
2807
3142
|
* @public
|
|
2808
3143
|
*/
|
|
2809
|
-
export interface
|
|
3144
|
+
export interface GetWorkflowStepExecutionRequest {
|
|
2810
3145
|
/**
|
|
2811
|
-
* <p>
|
|
3146
|
+
* <p>Use the unique identifier for a specific runtime instance of the workflow step to
|
|
3147
|
+
* get runtime details for that step.</p>
|
|
2812
3148
|
*/
|
|
2813
|
-
|
|
3149
|
+
stepExecutionId: string | undefined;
|
|
3150
|
+
}
|
|
3151
|
+
/**
|
|
3152
|
+
* @public
|
|
3153
|
+
* @enum
|
|
3154
|
+
*/
|
|
3155
|
+
export declare const WorkflowStepExecutionRollbackStatus: {
|
|
3156
|
+
readonly COMPLETED: "COMPLETED";
|
|
3157
|
+
readonly FAILED: "FAILED";
|
|
3158
|
+
readonly RUNNING: "RUNNING";
|
|
3159
|
+
readonly SKIPPED: "SKIPPED";
|
|
3160
|
+
};
|
|
3161
|
+
/**
|
|
3162
|
+
* @public
|
|
3163
|
+
*/
|
|
3164
|
+
export type WorkflowStepExecutionRollbackStatus = (typeof WorkflowStepExecutionRollbackStatus)[keyof typeof WorkflowStepExecutionRollbackStatus];
|
|
3165
|
+
/**
|
|
3166
|
+
* @public
|
|
3167
|
+
* @enum
|
|
3168
|
+
*/
|
|
3169
|
+
export declare const WorkflowStepExecutionStatus: {
|
|
3170
|
+
readonly COMPLETED: "COMPLETED";
|
|
3171
|
+
readonly FAILED: "FAILED";
|
|
3172
|
+
readonly PENDING: "PENDING";
|
|
3173
|
+
readonly RUNNING: "RUNNING";
|
|
3174
|
+
readonly SKIPPED: "SKIPPED";
|
|
3175
|
+
};
|
|
3176
|
+
/**
|
|
3177
|
+
* @public
|
|
3178
|
+
*/
|
|
3179
|
+
export type WorkflowStepExecutionStatus = (typeof WorkflowStepExecutionStatus)[keyof typeof WorkflowStepExecutionStatus];
|
|
3180
|
+
/**
|
|
3181
|
+
* @public
|
|
3182
|
+
*/
|
|
3183
|
+
export interface GetWorkflowStepExecutionResponse {
|
|
3184
|
+
/**
|
|
3185
|
+
* <p>The request ID that uniquely identifies this request.</p>
|
|
3186
|
+
*/
|
|
3187
|
+
requestId?: string;
|
|
3188
|
+
/**
|
|
3189
|
+
* <p>The unique identifier for the runtime version of the workflow step that you specified
|
|
3190
|
+
* in the request.</p>
|
|
3191
|
+
*/
|
|
3192
|
+
stepExecutionId?: string;
|
|
3193
|
+
/**
|
|
3194
|
+
* <p>The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource
|
|
3195
|
+
* that defines this workflow step.</p>
|
|
3196
|
+
*/
|
|
3197
|
+
workflowBuildVersionArn?: string;
|
|
3198
|
+
/**
|
|
3199
|
+
* <p>The unique identifier that Image Builder assigned to keep track of runtime details
|
|
3200
|
+
* when it ran the workflow.</p>
|
|
3201
|
+
*/
|
|
3202
|
+
workflowExecutionId?: string;
|
|
3203
|
+
/**
|
|
3204
|
+
* <p>The Amazon Resource Name (ARN) of the image resource build version that the specified
|
|
3205
|
+
* runtime instance of the workflow step creates.</p>
|
|
3206
|
+
*/
|
|
3207
|
+
imageBuildVersionArn?: string;
|
|
3208
|
+
/**
|
|
3209
|
+
* <p>The name of the specified runtime instance of the workflow step.</p>
|
|
3210
|
+
*/
|
|
3211
|
+
name?: string;
|
|
2814
3212
|
/**
|
|
2815
|
-
* <p>
|
|
2816
|
-
|
|
3213
|
+
* <p>Describes the specified workflow step.</p>
|
|
3214
|
+
*/
|
|
3215
|
+
description?: string;
|
|
3216
|
+
/**
|
|
3217
|
+
* <p>The name of the action that the specified step performs.</p>
|
|
3218
|
+
*/
|
|
3219
|
+
action?: string;
|
|
3220
|
+
/**
|
|
3221
|
+
* <p>The current status for the specified runtime version of the workflow step.</p>
|
|
3222
|
+
*/
|
|
3223
|
+
status?: WorkflowStepExecutionStatus | string;
|
|
3224
|
+
/**
|
|
3225
|
+
* <p>Reports on the rollback status of the specified runtime version of the workflow step,
|
|
3226
|
+
* if applicable.</p>
|
|
3227
|
+
*/
|
|
3228
|
+
rollbackStatus?: WorkflowStepExecutionRollbackStatus | string;
|
|
3229
|
+
/**
|
|
3230
|
+
* <p>The output message from the specified runtime instance of the workflow step, if applicable.</p>
|
|
3231
|
+
*/
|
|
3232
|
+
message?: string;
|
|
3233
|
+
/**
|
|
3234
|
+
* <p>Input parameters that Image Builder provided for the specified runtime instance of
|
|
3235
|
+
* the workflow step.</p>
|
|
3236
|
+
*/
|
|
3237
|
+
inputs?: string;
|
|
3238
|
+
/**
|
|
3239
|
+
* <p>The file names that the specified runtime version of the workflow step created as output.</p>
|
|
3240
|
+
*/
|
|
3241
|
+
outputs?: string;
|
|
3242
|
+
/**
|
|
3243
|
+
* <p>The timestamp when the specified runtime version of the workflow step started.</p>
|
|
3244
|
+
*/
|
|
3245
|
+
startTime?: string;
|
|
3246
|
+
/**
|
|
3247
|
+
* <p>The timestamp when the specified runtime instance of the workflow step finished.</p>
|
|
3248
|
+
*/
|
|
3249
|
+
endTime?: string;
|
|
3250
|
+
/**
|
|
3251
|
+
* <p>The action to perform if the workflow step fails.</p>
|
|
3252
|
+
*/
|
|
3253
|
+
onFailure?: string;
|
|
3254
|
+
/**
|
|
3255
|
+
* <p>The maximum duration in seconds for this step to complete its action.</p>
|
|
3256
|
+
*/
|
|
3257
|
+
timeoutSeconds?: number;
|
|
3258
|
+
}
|
|
3259
|
+
/**
|
|
3260
|
+
* @public
|
|
3261
|
+
* <p>Contains vulnerability counts for a specific image.</p>
|
|
3262
|
+
*/
|
|
3263
|
+
export interface ImageAggregation {
|
|
3264
|
+
/**
|
|
3265
|
+
* <p>The Amazon Resource Name (ARN) that identifies the image for this aggregation.</p>
|
|
3266
|
+
*/
|
|
3267
|
+
imageBuildVersionArn?: string;
|
|
3268
|
+
/**
|
|
3269
|
+
* <p>Counts by severity level for medium severity and higher level findings, plus a total
|
|
3270
|
+
* for all of the findings for the specified image.</p>
|
|
3271
|
+
*/
|
|
3272
|
+
severityCounts?: SeverityCounts;
|
|
3273
|
+
}
|
|
3274
|
+
/**
|
|
3275
|
+
* @public
|
|
3276
|
+
*/
|
|
3277
|
+
export interface ImportComponentRequest {
|
|
3278
|
+
/**
|
|
3279
|
+
* <p>The name of the component.</p>
|
|
3280
|
+
*/
|
|
3281
|
+
name: string | undefined;
|
|
3282
|
+
/**
|
|
3283
|
+
* <p>The semantic version of the component. This version follows the semantic version
|
|
3284
|
+
* syntax.</p>
|
|
3285
|
+
* <note>
|
|
3286
|
+
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
3287
|
+
* You can assign values for the first three, and can filter on all of them.</p>
|
|
3288
|
+
* <p>
|
|
3289
|
+
* <b>Filtering:</b> With semantic versioning, you have the flexibility to use wildcards (x)
|
|
3290
|
+
* to specify the most recent versions or nodes when selecting the base image or components for your
|
|
3291
|
+
* recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be
|
|
3292
|
+
* wildcards.</p>
|
|
3293
|
+
* </note>
|
|
3294
|
+
*/
|
|
3295
|
+
semanticVersion: string | undefined;
|
|
3296
|
+
/**
|
|
3297
|
+
* <p>The description of the component. Describes the contents of the component.</p>
|
|
3298
|
+
*/
|
|
3299
|
+
description?: string;
|
|
3300
|
+
/**
|
|
3301
|
+
* <p>The change description of the component. This description indicates the change that
|
|
3302
|
+
* has been made in this version, or what makes this version different from other versions
|
|
3303
|
+
* of this component.</p>
|
|
3304
|
+
*/
|
|
3305
|
+
changeDescription?: string;
|
|
3306
|
+
/**
|
|
3307
|
+
* <p>The type of the component denotes whether the component is used to build the image, or
|
|
3308
|
+
* only to test it.</p>
|
|
3309
|
+
*/
|
|
3310
|
+
type: ComponentType | string | undefined;
|
|
3311
|
+
/**
|
|
3312
|
+
* <p>The format of the resource that you want to import as a component.</p>
|
|
3313
|
+
*/
|
|
3314
|
+
format: ComponentFormat | string | undefined;
|
|
3315
|
+
/**
|
|
3316
|
+
* <p>The platform of the component.</p>
|
|
3317
|
+
*/
|
|
3318
|
+
platform: Platform | string | undefined;
|
|
3319
|
+
/**
|
|
3320
|
+
* <p>The data of the component. Used to specify the data inline. Either <code>data</code>
|
|
3321
|
+
* or <code>uri</code> can be used to specify the data within the component.</p>
|
|
3322
|
+
*/
|
|
3323
|
+
data?: string;
|
|
3324
|
+
/**
|
|
3325
|
+
* <p>The uri of the component. Must be an Amazon S3 URL and the requester must have permission
|
|
3326
|
+
* to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your
|
|
3327
|
+
* service quota. Either <code>data</code> or <code>uri</code> can be used to specify the
|
|
3328
|
+
* data within the component.</p>
|
|
3329
|
+
*/
|
|
3330
|
+
uri?: string;
|
|
3331
|
+
/**
|
|
3332
|
+
* <p>The ID of the KMS key that should be used to encrypt this component.</p>
|
|
3333
|
+
*/
|
|
3334
|
+
kmsKeyId?: string;
|
|
3335
|
+
/**
|
|
3336
|
+
* <p>The tags of the component.</p>
|
|
3337
|
+
*/
|
|
3338
|
+
tags?: Record<string, string>;
|
|
3339
|
+
/**
|
|
3340
|
+
* <p>The idempotency token of the component.</p>
|
|
3341
|
+
*/
|
|
3342
|
+
clientToken?: string;
|
|
3343
|
+
}
|
|
3344
|
+
/**
|
|
3345
|
+
* @public
|
|
3346
|
+
*/
|
|
3347
|
+
export interface ImportComponentResponse {
|
|
3348
|
+
/**
|
|
3349
|
+
* <p>The request ID that uniquely identifies this request.</p>
|
|
3350
|
+
*/
|
|
3351
|
+
requestId?: string;
|
|
3352
|
+
/**
|
|
3353
|
+
* <p>The idempotency token used to make this request idempotent.</p>
|
|
3354
|
+
*/
|
|
3355
|
+
clientToken?: string;
|
|
3356
|
+
/**
|
|
3357
|
+
* <p>The Amazon Resource Name (ARN) of the imported component.</p>
|
|
3358
|
+
*/
|
|
3359
|
+
componentBuildVersionArn?: string;
|
|
3360
|
+
}
|
|
3361
|
+
/**
|
|
3362
|
+
* @public
|
|
3363
|
+
*/
|
|
3364
|
+
export interface ImportVmImageRequest {
|
|
3365
|
+
/**
|
|
3366
|
+
* <p>The name of the base image that is created by the import process.</p>
|
|
3367
|
+
*/
|
|
3368
|
+
name: string | undefined;
|
|
3369
|
+
/**
|
|
3370
|
+
* <p>The semantic version to attach to the base image that was created during the import
|
|
3371
|
+
* process. This version follows the semantic version syntax.</p>
|
|
2817
3372
|
* <note>
|
|
2818
3373
|
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
2819
3374
|
* You can assign values for the first three, and can filter on all of them.</p>
|
|
@@ -2842,8 +3397,8 @@ export interface ImportVmImageRequest {
|
|
|
2842
3397
|
osVersion?: string;
|
|
2843
3398
|
/**
|
|
2844
3399
|
* <p>The <code>importTaskId</code> (API) or <code>ImportTaskId</code> (CLI) from the
|
|
2845
|
-
* Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull
|
|
2846
|
-
*
|
|
3400
|
+
* Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in
|
|
3401
|
+
* the AMI that is created from the VM source as the base image for your recipe.</p>
|
|
2847
3402
|
*/
|
|
2848
3403
|
vmImportTaskId: string | undefined;
|
|
2849
3404
|
/**
|
|
@@ -2866,9 +3421,8 @@ export interface ImportVmImageResponse {
|
|
|
2866
3421
|
*/
|
|
2867
3422
|
requestId?: string;
|
|
2868
3423
|
/**
|
|
2869
|
-
* <p>The Amazon Resource Name (ARN) of the AMI that was created during the VM
|
|
2870
|
-
*
|
|
2871
|
-
* imported the VM.</p>
|
|
3424
|
+
* <p>The Amazon Resource Name (ARN) of the AMI that was created during the VM import
|
|
3425
|
+
* process. This AMI is used as the base image for the recipe that imported the VM.</p>
|
|
2872
3426
|
*/
|
|
2873
3427
|
imageArn?: string;
|
|
2874
3428
|
/**
|
|
@@ -2893,7 +3447,8 @@ export declare class InvalidPaginationTokenException extends __BaseException {
|
|
|
2893
3447
|
*/
|
|
2894
3448
|
export interface ListComponentBuildVersionsRequest {
|
|
2895
3449
|
/**
|
|
2896
|
-
* <p>The component version Amazon Resource Name (ARN) whose versions you want to
|
|
3450
|
+
* <p>The component version Amazon Resource Name (ARN) whose versions you want to
|
|
3451
|
+
* list.</p>
|
|
2897
3452
|
*/
|
|
2898
3453
|
componentVersionArn: string | undefined;
|
|
2899
3454
|
/**
|
|
@@ -2901,8 +3456,8 @@ export interface ListComponentBuildVersionsRequest {
|
|
|
2901
3456
|
*/
|
|
2902
3457
|
maxResults?: number;
|
|
2903
3458
|
/**
|
|
2904
|
-
* <p>A token to specify where to start paginating. This is the NextToken
|
|
2905
|
-
*
|
|
3459
|
+
* <p>A token to specify where to start paginating. This is the NextToken
|
|
3460
|
+
* from a previously truncated response.</p>
|
|
2906
3461
|
*/
|
|
2907
3462
|
nextToken?: string;
|
|
2908
3463
|
}
|
|
@@ -2919,30 +3474,35 @@ export interface ListComponentBuildVersionsResponse {
|
|
|
2919
3474
|
*/
|
|
2920
3475
|
componentSummaryList?: ComponentSummary[];
|
|
2921
3476
|
/**
|
|
2922
|
-
* <p>The next token used for paginated responses. When this
|
|
2923
|
-
*
|
|
2924
|
-
*
|
|
3477
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
3478
|
+
* there are additional elements that the service has'ot included in this request. Use this token
|
|
3479
|
+
* with the next request to retrieve additional objects.</p>
|
|
2925
3480
|
*/
|
|
2926
3481
|
nextToken?: string;
|
|
2927
3482
|
}
|
|
2928
3483
|
/**
|
|
2929
3484
|
* @public
|
|
3485
|
+
* @enum
|
|
2930
3486
|
*/
|
|
2931
|
-
export declare
|
|
2932
|
-
AMAZON
|
|
2933
|
-
SELF
|
|
2934
|
-
SHARED
|
|
2935
|
-
THIRDPARTY
|
|
2936
|
-
}
|
|
3487
|
+
export declare const Ownership: {
|
|
3488
|
+
readonly AMAZON: "Amazon";
|
|
3489
|
+
readonly SELF: "Self";
|
|
3490
|
+
readonly SHARED: "Shared";
|
|
3491
|
+
readonly THIRDPARTY: "ThirdParty";
|
|
3492
|
+
};
|
|
3493
|
+
/**
|
|
3494
|
+
* @public
|
|
3495
|
+
*/
|
|
3496
|
+
export type Ownership = (typeof Ownership)[keyof typeof Ownership];
|
|
2937
3497
|
/**
|
|
2938
3498
|
* @public
|
|
2939
3499
|
*/
|
|
2940
3500
|
export interface ListComponentsRequest {
|
|
2941
3501
|
/**
|
|
2942
3502
|
* <p>Filters results based on the type of owner for the component. By default, this request
|
|
2943
|
-
* returns a list of components that your account owns. To see results for other types of
|
|
2944
|
-
* you can specify components that Amazon manages, third party components, or
|
|
2945
|
-
* other accounts have shared with you.</p>
|
|
3503
|
+
* returns a list of components that your account owns. To see results for other types of
|
|
3504
|
+
* owners, you can specify components that Amazon manages, third party components, or
|
|
3505
|
+
* components that other accounts have shared with you.</p>
|
|
2946
3506
|
*/
|
|
2947
3507
|
owner?: Ownership | string;
|
|
2948
3508
|
/**
|
|
@@ -2990,8 +3550,8 @@ export interface ListComponentsRequest {
|
|
|
2990
3550
|
*/
|
|
2991
3551
|
maxResults?: number;
|
|
2992
3552
|
/**
|
|
2993
|
-
* <p>A token to specify where to start paginating. This is the NextToken
|
|
2994
|
-
*
|
|
3553
|
+
* <p>A token to specify where to start paginating. This is the NextToken
|
|
3554
|
+
* from a previously truncated response.</p>
|
|
2995
3555
|
*/
|
|
2996
3556
|
nextToken?: string;
|
|
2997
3557
|
}
|
|
@@ -3012,9 +3572,9 @@ export interface ListComponentsResponse {
|
|
|
3012
3572
|
*/
|
|
3013
3573
|
componentVersionList?: ComponentVersion[];
|
|
3014
3574
|
/**
|
|
3015
|
-
* <p>The next token used for paginated responses. When this
|
|
3016
|
-
*
|
|
3017
|
-
*
|
|
3575
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
3576
|
+
* there are additional elements that the service has'ot included in this request. Use this token
|
|
3577
|
+
* with the next request to retrieve additional objects.</p>
|
|
3018
3578
|
*/
|
|
3019
3579
|
nextToken?: string;
|
|
3020
3580
|
}
|
|
@@ -3023,7 +3583,9 @@ export interface ListComponentsResponse {
|
|
|
3023
3583
|
*/
|
|
3024
3584
|
export interface ListContainerRecipesRequest {
|
|
3025
3585
|
/**
|
|
3026
|
-
* <p>Returns container recipes belonging to the specified owner, that have been shared with
|
|
3586
|
+
* <p>Returns container recipes belonging to the specified owner, that have been shared with
|
|
3587
|
+
* you. You can omit this field to return container recipes belonging to your
|
|
3588
|
+
* account.</p>
|
|
3027
3589
|
*/
|
|
3028
3590
|
owner?: Ownership | string;
|
|
3029
3591
|
/**
|
|
@@ -3053,11 +3615,12 @@ export interface ListContainerRecipesRequest {
|
|
|
3053
3615
|
*/
|
|
3054
3616
|
filters?: Filter[];
|
|
3055
3617
|
/**
|
|
3056
|
-
* <p>The maximum
|
|
3618
|
+
* <p>The maximum items to return in a request.</p>
|
|
3057
3619
|
*/
|
|
3058
3620
|
maxResults?: number;
|
|
3059
3621
|
/**
|
|
3060
|
-
* <p>
|
|
3622
|
+
* <p>A token to specify where to start paginating. This is the NextToken
|
|
3623
|
+
* from a previously truncated response.</p>
|
|
3061
3624
|
*/
|
|
3062
3625
|
nextToken?: string;
|
|
3063
3626
|
}
|
|
@@ -3074,7 +3637,9 @@ export interface ListContainerRecipesResponse {
|
|
|
3074
3637
|
*/
|
|
3075
3638
|
containerRecipeSummaryList?: ContainerRecipeSummary[];
|
|
3076
3639
|
/**
|
|
3077
|
-
* <p>The next token
|
|
3640
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
3641
|
+
* there are additional elements that the service has'ot included in this request. Use this token
|
|
3642
|
+
* with the next request to retrieve additional objects.</p>
|
|
3078
3643
|
*/
|
|
3079
3644
|
nextToken?: string;
|
|
3080
3645
|
}
|
|
@@ -3091,8 +3656,8 @@ export interface ListDistributionConfigurationsRequest {
|
|
|
3091
3656
|
*/
|
|
3092
3657
|
maxResults?: number;
|
|
3093
3658
|
/**
|
|
3094
|
-
* <p>A token to specify where to start paginating. This is the NextToken
|
|
3095
|
-
*
|
|
3659
|
+
* <p>A token to specify where to start paginating. This is the NextToken
|
|
3660
|
+
* from a previously truncated response.</p>
|
|
3096
3661
|
*/
|
|
3097
3662
|
nextToken?: string;
|
|
3098
3663
|
}
|
|
@@ -3109,9 +3674,9 @@ export interface ListDistributionConfigurationsResponse {
|
|
|
3109
3674
|
*/
|
|
3110
3675
|
distributionConfigurationSummaryList?: DistributionConfigurationSummary[];
|
|
3111
3676
|
/**
|
|
3112
|
-
* <p>The next token used for paginated responses. When this
|
|
3113
|
-
*
|
|
3114
|
-
*
|
|
3677
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
3678
|
+
* there are additional elements that the service has'ot included in this request. Use this token
|
|
3679
|
+
* with the next request to retrieve additional objects.</p>
|
|
3115
3680
|
*/
|
|
3116
3681
|
nextToken?: string;
|
|
3117
3682
|
}
|
|
@@ -3120,7 +3685,8 @@ export interface ListDistributionConfigurationsResponse {
|
|
|
3120
3685
|
*/
|
|
3121
3686
|
export interface ListImageBuildVersionsRequest {
|
|
3122
3687
|
/**
|
|
3123
|
-
* <p>The Amazon Resource Name (ARN) of the image whose build versions you want to
|
|
3688
|
+
* <p>The Amazon Resource Name (ARN) of the image whose build versions you want to
|
|
3689
|
+
* retrieve.</p>
|
|
3124
3690
|
*/
|
|
3125
3691
|
imageVersionArn: string | undefined;
|
|
3126
3692
|
/**
|
|
@@ -3159,8 +3725,8 @@ export interface ListImageBuildVersionsRequest {
|
|
|
3159
3725
|
*/
|
|
3160
3726
|
maxResults?: number;
|
|
3161
3727
|
/**
|
|
3162
|
-
* <p>A token to specify where to start paginating. This is the NextToken
|
|
3163
|
-
*
|
|
3728
|
+
* <p>A token to specify where to start paginating. This is the NextToken
|
|
3729
|
+
* from a previously truncated response.</p>
|
|
3164
3730
|
*/
|
|
3165
3731
|
nextToken?: string;
|
|
3166
3732
|
}
|
|
@@ -3215,8 +3781,8 @@ export interface ImageSummary {
|
|
|
3215
3781
|
*/
|
|
3216
3782
|
tags?: Record<string, string>;
|
|
3217
3783
|
/**
|
|
3218
|
-
* <p>Indicates the type of build that created this image. The build can be initiated
|
|
3219
|
-
*
|
|
3784
|
+
* <p>Indicates the type of build that created this image. The build can be initiated in the
|
|
3785
|
+
* following ways:</p>
|
|
3220
3786
|
* <ul>
|
|
3221
3787
|
* <li>
|
|
3222
3788
|
* <p>
|
|
@@ -3254,9 +3820,9 @@ export interface ListImageBuildVersionsResponse {
|
|
|
3254
3820
|
*/
|
|
3255
3821
|
imageSummaryList?: ImageSummary[];
|
|
3256
3822
|
/**
|
|
3257
|
-
* <p>The next token used for paginated responses. When this
|
|
3258
|
-
*
|
|
3259
|
-
*
|
|
3823
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
3824
|
+
* there are additional elements that the service has'ot included in this request. Use this token
|
|
3825
|
+
* with the next request to retrieve additional objects.</p>
|
|
3260
3826
|
*/
|
|
3261
3827
|
nextToken?: string;
|
|
3262
3828
|
}
|
|
@@ -3269,11 +3835,12 @@ export interface ListImagePackagesRequest {
|
|
|
3269
3835
|
*/
|
|
3270
3836
|
imageBuildVersionArn: string | undefined;
|
|
3271
3837
|
/**
|
|
3272
|
-
* <p>The
|
|
3838
|
+
* <p>The maximum items to return in a request.</p>
|
|
3273
3839
|
*/
|
|
3274
3840
|
maxResults?: number;
|
|
3275
3841
|
/**
|
|
3276
|
-
* <p>A token to specify where to start paginating. This is the NextToken
|
|
3842
|
+
* <p>A token to specify where to start paginating. This is the NextToken
|
|
3843
|
+
* from a previously truncated response.</p>
|
|
3277
3844
|
*/
|
|
3278
3845
|
nextToken?: string;
|
|
3279
3846
|
}
|
|
@@ -3304,7 +3871,9 @@ export interface ListImagePackagesResponse {
|
|
|
3304
3871
|
*/
|
|
3305
3872
|
imagePackageList?: ImagePackage[];
|
|
3306
3873
|
/**
|
|
3307
|
-
* <p>
|
|
3874
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
3875
|
+
* there are additional elements that the service has'ot included in this request. Use this token
|
|
3876
|
+
* with the next request to retrieve additional objects.</p>
|
|
3308
3877
|
*/
|
|
3309
3878
|
nextToken?: string;
|
|
3310
3879
|
}
|
|
@@ -3313,7 +3882,8 @@ export interface ListImagePackagesResponse {
|
|
|
3313
3882
|
*/
|
|
3314
3883
|
export interface ListImagePipelineImagesRequest {
|
|
3315
3884
|
/**
|
|
3316
|
-
* <p>The Amazon Resource Name (ARN) of the image pipeline whose images you want to
|
|
3885
|
+
* <p>The Amazon Resource Name (ARN) of the image pipeline whose images you want to
|
|
3886
|
+
* view.</p>
|
|
3317
3887
|
*/
|
|
3318
3888
|
imagePipelineArn: string | undefined;
|
|
3319
3889
|
/**
|
|
@@ -3337,8 +3907,8 @@ export interface ListImagePipelineImagesRequest {
|
|
|
3337
3907
|
*/
|
|
3338
3908
|
maxResults?: number;
|
|
3339
3909
|
/**
|
|
3340
|
-
* <p>A token to specify where to start paginating. This is the NextToken
|
|
3341
|
-
*
|
|
3910
|
+
* <p>A token to specify where to start paginating. This is the NextToken
|
|
3911
|
+
* from a previously truncated response.</p>
|
|
3342
3912
|
*/
|
|
3343
3913
|
nextToken?: string;
|
|
3344
3914
|
}
|
|
@@ -3355,9 +3925,9 @@ export interface ListImagePipelineImagesResponse {
|
|
|
3355
3925
|
*/
|
|
3356
3926
|
imageSummaryList?: ImageSummary[];
|
|
3357
3927
|
/**
|
|
3358
|
-
* <p>The next token used for paginated responses. When this
|
|
3359
|
-
*
|
|
3360
|
-
*
|
|
3928
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
3929
|
+
* there are additional elements that the service has'ot included in this request. Use this token
|
|
3930
|
+
* with the next request to retrieve additional objects.</p>
|
|
3361
3931
|
*/
|
|
3362
3932
|
nextToken?: string;
|
|
3363
3933
|
}
|
|
@@ -3406,8 +3976,8 @@ export interface ListImagePipelinesRequest {
|
|
|
3406
3976
|
*/
|
|
3407
3977
|
maxResults?: number;
|
|
3408
3978
|
/**
|
|
3409
|
-
* <p>A token to specify where to start paginating. This is the NextToken
|
|
3410
|
-
*
|
|
3979
|
+
* <p>A token to specify where to start paginating. This is the NextToken
|
|
3980
|
+
* from a previously truncated response.</p>
|
|
3411
3981
|
*/
|
|
3412
3982
|
nextToken?: string;
|
|
3413
3983
|
}
|
|
@@ -3424,9 +3994,9 @@ export interface ListImagePipelinesResponse {
|
|
|
3424
3994
|
*/
|
|
3425
3995
|
imagePipelineList?: ImagePipeline[];
|
|
3426
3996
|
/**
|
|
3427
|
-
* <p>The next token used for paginated responses. When this
|
|
3428
|
-
*
|
|
3429
|
-
*
|
|
3997
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
3998
|
+
* there are additional elements that the service has'ot included in this request. Use this token
|
|
3999
|
+
* with the next request to retrieve additional objects.</p>
|
|
3430
4000
|
*/
|
|
3431
4001
|
nextToken?: string;
|
|
3432
4002
|
}
|
|
@@ -3435,10 +4005,10 @@ export interface ListImagePipelinesResponse {
|
|
|
3435
4005
|
*/
|
|
3436
4006
|
export interface ListImageRecipesRequest {
|
|
3437
4007
|
/**
|
|
3438
|
-
* <p>The owner defines which image recipes you want to list. By default, this request will
|
|
3439
|
-
* show image recipes owned by your account. You can use this field to specify if you
|
|
3440
|
-
* view image recipes owned by yourself, by Amazon, or those image recipes that
|
|
3441
|
-
* with you by other customers.</p>
|
|
4008
|
+
* <p>The owner defines which image recipes you want to list. By default, this request will
|
|
4009
|
+
* only show image recipes owned by your account. You can use this field to specify if you
|
|
4010
|
+
* want to view image recipes owned by yourself, by Amazon, or those image recipes that
|
|
4011
|
+
* have been shared with you by other customers.</p>
|
|
3442
4012
|
*/
|
|
3443
4013
|
owner?: Ownership | string;
|
|
3444
4014
|
/**
|
|
@@ -3467,8 +4037,8 @@ export interface ListImageRecipesRequest {
|
|
|
3467
4037
|
*/
|
|
3468
4038
|
maxResults?: number;
|
|
3469
4039
|
/**
|
|
3470
|
-
* <p>A token to specify where to start paginating. This is the NextToken
|
|
3471
|
-
*
|
|
4040
|
+
* <p>A token to specify where to start paginating. This is the NextToken
|
|
4041
|
+
* from a previously truncated response.</p>
|
|
3472
4042
|
*/
|
|
3473
4043
|
nextToken?: string;
|
|
3474
4044
|
}
|
|
@@ -3519,9 +4089,9 @@ export interface ListImageRecipesResponse {
|
|
|
3519
4089
|
*/
|
|
3520
4090
|
imageRecipeSummaryList?: ImageRecipeSummary[];
|
|
3521
4091
|
/**
|
|
3522
|
-
* <p>The next token used for paginated responses. When this
|
|
3523
|
-
*
|
|
3524
|
-
*
|
|
4092
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
4093
|
+
* there are additional elements that the service has'ot included in this request. Use this token
|
|
4094
|
+
* with the next request to retrieve additional objects.</p>
|
|
3525
4095
|
*/
|
|
3526
4096
|
nextToken?: string;
|
|
3527
4097
|
}
|
|
@@ -3530,10 +4100,10 @@ export interface ListImageRecipesResponse {
|
|
|
3530
4100
|
*/
|
|
3531
4101
|
export interface ListImagesRequest {
|
|
3532
4102
|
/**
|
|
3533
|
-
* <p>The owner defines which images you want to list. By default, this request will only
|
|
3534
|
-
* images owned by your account. You can use this field to specify if you want to view
|
|
3535
|
-
* owned by yourself, by Amazon, or those images that have been shared with you by
|
|
3536
|
-
* customers.</p>
|
|
4103
|
+
* <p>The owner defines which images you want to list. By default, this request will only
|
|
4104
|
+
* show images owned by your account. You can use this field to specify if you want to view
|
|
4105
|
+
* images owned by yourself, by Amazon, or those images that have been shared with you by
|
|
4106
|
+
* other customers.</p>
|
|
3537
4107
|
*/
|
|
3538
4108
|
owner?: Ownership | string;
|
|
3539
4109
|
/**
|
|
@@ -3576,8 +4146,8 @@ export interface ListImagesRequest {
|
|
|
3576
4146
|
*/
|
|
3577
4147
|
maxResults?: number;
|
|
3578
4148
|
/**
|
|
3579
|
-
* <p>A token to specify where to start paginating. This is the NextToken
|
|
3580
|
-
*
|
|
4149
|
+
* <p>A token to specify where to start paginating. This is the NextToken
|
|
4150
|
+
* from a previously truncated response.</p>
|
|
3581
4151
|
*/
|
|
3582
4152
|
nextToken?: string;
|
|
3583
4153
|
/**
|
|
@@ -3619,7 +4189,8 @@ export interface ImageVersion {
|
|
|
3619
4189
|
*/
|
|
3620
4190
|
type?: ImageType | string;
|
|
3621
4191
|
/**
|
|
3622
|
-
* <p>Details for a specific version of an Image Builder image. This version follows the semantic
|
|
4192
|
+
* <p>Details for a specific version of an Image Builder image. This version follows the semantic
|
|
4193
|
+
* version syntax.</p>
|
|
3623
4194
|
* <note>
|
|
3624
4195
|
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
3625
4196
|
* You can assign values for the first three, and can filter on all of them.</p>
|
|
@@ -3640,12 +4211,13 @@ export interface ImageVersion {
|
|
|
3640
4211
|
*/
|
|
3641
4212
|
version?: string;
|
|
3642
4213
|
/**
|
|
3643
|
-
* <p>The operating system platform of the image version, for example "Windows" or
|
|
4214
|
+
* <p>The operating system platform of the image version, for example "Windows" or
|
|
4215
|
+
* "Linux".</p>
|
|
3644
4216
|
*/
|
|
3645
4217
|
platform?: Platform | string;
|
|
3646
4218
|
/**
|
|
3647
|
-
* <p>The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2,
|
|
3648
|
-
* Microsoft Windows Server 2019.</p>
|
|
4219
|
+
* <p>The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2,
|
|
4220
|
+
* Ubuntu 18, or Microsoft Windows Server 2019.</p>
|
|
3649
4221
|
*/
|
|
3650
4222
|
osVersion?: string;
|
|
3651
4223
|
/**
|
|
@@ -3657,8 +4229,8 @@ export interface ImageVersion {
|
|
|
3657
4229
|
*/
|
|
3658
4230
|
dateCreated?: string;
|
|
3659
4231
|
/**
|
|
3660
|
-
* <p>Indicates the type of build that created this image. The build can be initiated
|
|
3661
|
-
*
|
|
4232
|
+
* <p>Indicates the type of build that created this image. The build can be initiated in the
|
|
4233
|
+
* following ways:</p>
|
|
3662
4234
|
* <ul>
|
|
3663
4235
|
* <li>
|
|
3664
4236
|
* <p>
|
|
@@ -3705,9 +4277,402 @@ export interface ListImagesResponse {
|
|
|
3705
4277
|
*/
|
|
3706
4278
|
imageVersionList?: ImageVersion[];
|
|
3707
4279
|
/**
|
|
3708
|
-
* <p>The next token used for paginated responses. When this
|
|
3709
|
-
*
|
|
3710
|
-
*
|
|
4280
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
4281
|
+
* there are additional elements that the service has'ot included in this request. Use this token
|
|
4282
|
+
* with the next request to retrieve additional objects.</p>
|
|
4283
|
+
*/
|
|
4284
|
+
nextToken?: string;
|
|
4285
|
+
}
|
|
4286
|
+
/**
|
|
4287
|
+
* @public
|
|
4288
|
+
*/
|
|
4289
|
+
export interface ListImageScanFindingAggregationsRequest {
|
|
4290
|
+
/**
|
|
4291
|
+
* <p>A filter name and value pair that is used to return a more specific list of results
|
|
4292
|
+
* from a list operation. Filters can be used to match a set of resources by specific
|
|
4293
|
+
* criteria, such as tags, attributes, or IDs.</p>
|
|
4294
|
+
*/
|
|
4295
|
+
filter?: Filter;
|
|
4296
|
+
/**
|
|
4297
|
+
* <p>A token to specify where to start paginating. This is the NextToken
|
|
4298
|
+
* from a previously truncated response.</p>
|
|
4299
|
+
*/
|
|
4300
|
+
nextToken?: string;
|
|
4301
|
+
}
|
|
4302
|
+
/**
|
|
4303
|
+
* @public
|
|
4304
|
+
* <p>Contains vulnerability counts for a specific image pipeline.</p>
|
|
4305
|
+
*/
|
|
4306
|
+
export interface ImagePipelineAggregation {
|
|
4307
|
+
/**
|
|
4308
|
+
* <p>The Amazon Resource Name (ARN) that identifies the image pipeline for this
|
|
4309
|
+
* aggregation.</p>
|
|
4310
|
+
*/
|
|
4311
|
+
imagePipelineArn?: string;
|
|
4312
|
+
/**
|
|
4313
|
+
* <p>Counts by severity level for medium severity and higher level findings, plus a total
|
|
4314
|
+
* for all of the findings for the specified image pipeline.</p>
|
|
4315
|
+
*/
|
|
4316
|
+
severityCounts?: SeverityCounts;
|
|
4317
|
+
}
|
|
4318
|
+
/**
|
|
4319
|
+
* @public
|
|
4320
|
+
* <p>Includes counts of image and pipeline resource findings by vulnerability.</p>
|
|
4321
|
+
*/
|
|
4322
|
+
export interface VulnerabilityIdAggregation {
|
|
4323
|
+
/**
|
|
4324
|
+
* <p>The vulnerability Id for this set of counts.</p>
|
|
4325
|
+
*/
|
|
4326
|
+
vulnerabilityId?: string;
|
|
4327
|
+
/**
|
|
4328
|
+
* <p>Counts by severity level for medium severity and higher level findings, plus a total
|
|
4329
|
+
* for all of the findings for the specified vulnerability.</p>
|
|
4330
|
+
*/
|
|
4331
|
+
severityCounts?: SeverityCounts;
|
|
4332
|
+
}
|
|
4333
|
+
/**
|
|
4334
|
+
* @public
|
|
4335
|
+
* <p>This returns exactly one type of aggregation, based on the filter that Image Builder applies in
|
|
4336
|
+
* its API action.</p>
|
|
4337
|
+
*/
|
|
4338
|
+
export interface ImageScanFindingAggregation {
|
|
4339
|
+
/**
|
|
4340
|
+
* <p>Returns an object that contains severity counts based on an account ID.</p>
|
|
4341
|
+
*/
|
|
4342
|
+
accountAggregation?: AccountAggregation;
|
|
4343
|
+
/**
|
|
4344
|
+
* <p>Returns an object that contains severity counts based on the Amazon Resource Name
|
|
4345
|
+
* (ARN) for a specific image.</p>
|
|
4346
|
+
*/
|
|
4347
|
+
imageAggregation?: ImageAggregation;
|
|
4348
|
+
/**
|
|
4349
|
+
* <p>Returns an object that contains severity counts based on an image pipeline ARN.</p>
|
|
4350
|
+
*/
|
|
4351
|
+
imagePipelineAggregation?: ImagePipelineAggregation;
|
|
4352
|
+
/**
|
|
4353
|
+
* <p>Returns an object that contains severity counts based on vulnerability ID.</p>
|
|
4354
|
+
*/
|
|
4355
|
+
vulnerabilityIdAggregation?: VulnerabilityIdAggregation;
|
|
4356
|
+
}
|
|
4357
|
+
/**
|
|
4358
|
+
* @public
|
|
4359
|
+
*/
|
|
4360
|
+
export interface ListImageScanFindingAggregationsResponse {
|
|
4361
|
+
/**
|
|
4362
|
+
* <p>The request ID that uniquely identifies this request.</p>
|
|
4363
|
+
*/
|
|
4364
|
+
requestId?: string;
|
|
4365
|
+
/**
|
|
4366
|
+
* <p>The aggregation type specifies what type of key is used to group the image scan
|
|
4367
|
+
* findings. Image Builder returns results based on the request filter. If you didn't specify a
|
|
4368
|
+
* filter in the request, the type defaults to <code>accountId</code>.</p>
|
|
4369
|
+
* <p class="title">
|
|
4370
|
+
* <b>Aggregation types</b>
|
|
4371
|
+
* </p>
|
|
4372
|
+
* <ul>
|
|
4373
|
+
* <li>
|
|
4374
|
+
* <p>accountId</p>
|
|
4375
|
+
* </li>
|
|
4376
|
+
* <li>
|
|
4377
|
+
* <p>imageBuildVersionArn</p>
|
|
4378
|
+
* </li>
|
|
4379
|
+
* <li>
|
|
4380
|
+
* <p>imagePipelineArn</p>
|
|
4381
|
+
* </li>
|
|
4382
|
+
* <li>
|
|
4383
|
+
* <p>vulnerabilityId</p>
|
|
4384
|
+
* </li>
|
|
4385
|
+
* </ul>
|
|
4386
|
+
* <p>Each aggregation includes counts by severity level for medium severity and higher
|
|
4387
|
+
* level findings, plus a total for all of the findings for each key value.</p>
|
|
4388
|
+
*/
|
|
4389
|
+
aggregationType?: string;
|
|
4390
|
+
/**
|
|
4391
|
+
* <p>An array of image scan finding aggregations that match the filter criteria.</p>
|
|
4392
|
+
*/
|
|
4393
|
+
responses?: ImageScanFindingAggregation[];
|
|
4394
|
+
/**
|
|
4395
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
4396
|
+
* there are additional elements that the service has'ot included in this request. Use this token
|
|
4397
|
+
* with the next request to retrieve additional objects.</p>
|
|
4398
|
+
*/
|
|
4399
|
+
nextToken?: string;
|
|
4400
|
+
}
|
|
4401
|
+
/**
|
|
4402
|
+
* @public
|
|
4403
|
+
* <p>A name value pair that Image Builder applies to streamline results from the
|
|
4404
|
+
* vulnerability scan findings list action.</p>
|
|
4405
|
+
*/
|
|
4406
|
+
export interface ImageScanFindingsFilter {
|
|
4407
|
+
/**
|
|
4408
|
+
* <p>The name of the image scan finding filter. Filter names are case-sensitive.</p>
|
|
4409
|
+
*/
|
|
4410
|
+
name?: string;
|
|
4411
|
+
/**
|
|
4412
|
+
* <p>The filter values. Filter values are case-sensitive.</p>
|
|
4413
|
+
*/
|
|
4414
|
+
values?: string[];
|
|
4415
|
+
}
|
|
4416
|
+
/**
|
|
4417
|
+
* @public
|
|
4418
|
+
*/
|
|
4419
|
+
export interface ListImageScanFindingsRequest {
|
|
4420
|
+
/**
|
|
4421
|
+
* <p>An array of name value pairs that you can use to filter your results. You can use the
|
|
4422
|
+
* following filters to streamline results:</p>
|
|
4423
|
+
* <ul>
|
|
4424
|
+
* <li>
|
|
4425
|
+
* <p>
|
|
4426
|
+
* <code>imageBuildVersionArn</code>
|
|
4427
|
+
* </p>
|
|
4428
|
+
* </li>
|
|
4429
|
+
* <li>
|
|
4430
|
+
* <p>
|
|
4431
|
+
* <code>imagePipelineArn</code>
|
|
4432
|
+
* </p>
|
|
4433
|
+
* </li>
|
|
4434
|
+
* <li>
|
|
4435
|
+
* <p>
|
|
4436
|
+
* <code>vulnerabilityId</code>
|
|
4437
|
+
* </p>
|
|
4438
|
+
* </li>
|
|
4439
|
+
* <li>
|
|
4440
|
+
* <p>
|
|
4441
|
+
* <code>severity</code>
|
|
4442
|
+
* </p>
|
|
4443
|
+
* </li>
|
|
4444
|
+
* </ul>
|
|
4445
|
+
* <p>If you don't request a filter, then all findings in your account are listed.</p>
|
|
4446
|
+
*/
|
|
4447
|
+
filters?: ImageScanFindingsFilter[];
|
|
4448
|
+
/**
|
|
4449
|
+
* <p>The maximum items to return in a request.</p>
|
|
4450
|
+
*/
|
|
4451
|
+
maxResults?: number;
|
|
4452
|
+
/**
|
|
4453
|
+
* <p>A token to specify where to start paginating. This is the NextToken
|
|
4454
|
+
* from a previously truncated response.</p>
|
|
4455
|
+
*/
|
|
4456
|
+
nextToken?: string;
|
|
4457
|
+
}
|
|
4458
|
+
/**
|
|
4459
|
+
* @public
|
|
4460
|
+
* <p>Information about the factors that influenced the score that Amazon Inspector assigned for a
|
|
4461
|
+
* finding.</p>
|
|
4462
|
+
*/
|
|
4463
|
+
export interface InspectorScoreDetails {
|
|
4464
|
+
/**
|
|
4465
|
+
* <p>An object that contains details about an adjustment that Amazon Inspector made to the CVSS score
|
|
4466
|
+
* for the finding.</p>
|
|
4467
|
+
*/
|
|
4468
|
+
adjustedCvss?: CvssScoreDetails;
|
|
4469
|
+
}
|
|
4470
|
+
/**
|
|
4471
|
+
* @public
|
|
4472
|
+
* <p>Information about a vulnerable package that Amazon Inspector identifies in a finding.</p>
|
|
4473
|
+
*/
|
|
4474
|
+
export interface VulnerablePackage {
|
|
4475
|
+
/**
|
|
4476
|
+
* <p>The name of the vulnerable package.</p>
|
|
4477
|
+
*/
|
|
4478
|
+
name?: string;
|
|
4479
|
+
/**
|
|
4480
|
+
* <p>The version of the vulnerable package.</p>
|
|
4481
|
+
*/
|
|
4482
|
+
version?: string;
|
|
4483
|
+
/**
|
|
4484
|
+
* <p>The source layer hash of the vulnerable package.</p>
|
|
4485
|
+
*/
|
|
4486
|
+
sourceLayerHash?: string;
|
|
4487
|
+
/**
|
|
4488
|
+
* <p>The epoch of the vulnerable package.</p>
|
|
4489
|
+
*/
|
|
4490
|
+
epoch?: number;
|
|
4491
|
+
/**
|
|
4492
|
+
* <p>The release of the vulnerable package.</p>
|
|
4493
|
+
*/
|
|
4494
|
+
release?: string;
|
|
4495
|
+
/**
|
|
4496
|
+
* <p>The architecture of the vulnerable package.</p>
|
|
4497
|
+
*/
|
|
4498
|
+
arch?: string;
|
|
4499
|
+
/**
|
|
4500
|
+
* <p>The package manager of the vulnerable package.</p>
|
|
4501
|
+
*/
|
|
4502
|
+
packageManager?: string;
|
|
4503
|
+
/**
|
|
4504
|
+
* <p>The file path of the vulnerable package.</p>
|
|
4505
|
+
*/
|
|
4506
|
+
filePath?: string;
|
|
4507
|
+
/**
|
|
4508
|
+
* <p>The version of the package that contains the vulnerability fix.</p>
|
|
4509
|
+
*/
|
|
4510
|
+
fixedInVersion?: string;
|
|
4511
|
+
/**
|
|
4512
|
+
* <p>The code to run in your environment to update packages with a fix available.</p>
|
|
4513
|
+
*/
|
|
4514
|
+
remediation?: string;
|
|
4515
|
+
}
|
|
4516
|
+
/**
|
|
4517
|
+
* @public
|
|
4518
|
+
* <p>Information about package vulnerability findings.</p>
|
|
4519
|
+
*/
|
|
4520
|
+
export interface PackageVulnerabilityDetails {
|
|
4521
|
+
/**
|
|
4522
|
+
* <p>A unique identifier for this vulnerability.</p>
|
|
4523
|
+
*/
|
|
4524
|
+
vulnerabilityId: string | undefined;
|
|
4525
|
+
/**
|
|
4526
|
+
* <p>The packages that this vulnerability impacts.</p>
|
|
4527
|
+
*/
|
|
4528
|
+
vulnerablePackages?: VulnerablePackage[];
|
|
4529
|
+
/**
|
|
4530
|
+
* <p>The source of the vulnerability information.</p>
|
|
4531
|
+
*/
|
|
4532
|
+
source?: string;
|
|
4533
|
+
/**
|
|
4534
|
+
* <p>CVSS scores for one or more vulnerabilities that Amazon Inspector identified for a
|
|
4535
|
+
* package.</p>
|
|
4536
|
+
*/
|
|
4537
|
+
cvss?: CvssScore[];
|
|
4538
|
+
/**
|
|
4539
|
+
* <p>Vulnerabilities that are often related to the findings for the package.</p>
|
|
4540
|
+
*/
|
|
4541
|
+
relatedVulnerabilities?: string[];
|
|
4542
|
+
/**
|
|
4543
|
+
* <p>A link to the source of the vulnerability information.</p>
|
|
4544
|
+
*/
|
|
4545
|
+
sourceUrl?: string;
|
|
4546
|
+
/**
|
|
4547
|
+
* <p>The severity that the vendor assigned to this vulnerability type.</p>
|
|
4548
|
+
*/
|
|
4549
|
+
vendorSeverity?: string;
|
|
4550
|
+
/**
|
|
4551
|
+
* <p>The date and time when this vulnerability was first added to the vendor's
|
|
4552
|
+
* database.</p>
|
|
4553
|
+
*/
|
|
4554
|
+
vendorCreatedAt?: Date;
|
|
4555
|
+
/**
|
|
4556
|
+
* <p>The date and time when the vendor last updated this vulnerability in their
|
|
4557
|
+
* database.</p>
|
|
4558
|
+
*/
|
|
4559
|
+
vendorUpdatedAt?: Date;
|
|
4560
|
+
/**
|
|
4561
|
+
* <p>Links to web pages that contain details about the vulnerabilities that Amazon Inspector
|
|
4562
|
+
* identified for the package.</p>
|
|
4563
|
+
*/
|
|
4564
|
+
referenceUrls?: string[];
|
|
4565
|
+
}
|
|
4566
|
+
/**
|
|
4567
|
+
* @public
|
|
4568
|
+
* <p>Details about the recommended course of action to remediate the finding.</p>
|
|
4569
|
+
*/
|
|
4570
|
+
export interface RemediationRecommendation {
|
|
4571
|
+
/**
|
|
4572
|
+
* <p>The recommended course of action to remediate the finding.</p>
|
|
4573
|
+
*/
|
|
4574
|
+
text?: string;
|
|
4575
|
+
/**
|
|
4576
|
+
* <p>A link to more information about the recommended remediation for this
|
|
4577
|
+
* vulnerability.</p>
|
|
4578
|
+
*/
|
|
4579
|
+
url?: string;
|
|
4580
|
+
}
|
|
4581
|
+
/**
|
|
4582
|
+
* @public
|
|
4583
|
+
* <p>Information about how to remediate a finding.</p>
|
|
4584
|
+
*/
|
|
4585
|
+
export interface Remediation {
|
|
4586
|
+
/**
|
|
4587
|
+
* <p>An object that contains information about the recommended course of action to
|
|
4588
|
+
* remediate the finding.</p>
|
|
4589
|
+
*/
|
|
4590
|
+
recommendation?: RemediationRecommendation;
|
|
4591
|
+
}
|
|
4592
|
+
/**
|
|
4593
|
+
* @public
|
|
4594
|
+
* <p>Contains details about a vulnerability scan finding.</p>
|
|
4595
|
+
*/
|
|
4596
|
+
export interface ImageScanFinding {
|
|
4597
|
+
/**
|
|
4598
|
+
* <p>The Amazon Web Services account ID that's associated with the finding.</p>
|
|
4599
|
+
*/
|
|
4600
|
+
awsAccountId?: string;
|
|
4601
|
+
/**
|
|
4602
|
+
* <p>The Amazon Resource Name (ARN) of the image build version that's associated with the
|
|
4603
|
+
* finding.</p>
|
|
4604
|
+
*/
|
|
4605
|
+
imageBuildVersionArn?: string;
|
|
4606
|
+
/**
|
|
4607
|
+
* <p>The Amazon Resource Name (ARN) of the image pipeline that's associated with the
|
|
4608
|
+
* finding.</p>
|
|
4609
|
+
*/
|
|
4610
|
+
imagePipelineArn?: string;
|
|
4611
|
+
/**
|
|
4612
|
+
* <p>The type of the finding. Image Builder looks for findings of the type
|
|
4613
|
+
* <code>PACKAGE_VULNERABILITY</code> that apply to output images, and excludes other
|
|
4614
|
+
* types.</p>
|
|
4615
|
+
*/
|
|
4616
|
+
type?: string;
|
|
4617
|
+
/**
|
|
4618
|
+
* <p>The description of the finding.</p>
|
|
4619
|
+
*/
|
|
4620
|
+
description?: string;
|
|
4621
|
+
/**
|
|
4622
|
+
* <p>The title of the finding.</p>
|
|
4623
|
+
*/
|
|
4624
|
+
title?: string;
|
|
4625
|
+
/**
|
|
4626
|
+
* <p>An object that contains the details about how to remediate the finding.</p>
|
|
4627
|
+
*/
|
|
4628
|
+
remediation?: Remediation;
|
|
4629
|
+
/**
|
|
4630
|
+
* <p>The severity of the finding.</p>
|
|
4631
|
+
*/
|
|
4632
|
+
severity?: string;
|
|
4633
|
+
/**
|
|
4634
|
+
* <p>The date and time when the finding was first observed.</p>
|
|
4635
|
+
*/
|
|
4636
|
+
firstObservedAt?: Date;
|
|
4637
|
+
/**
|
|
4638
|
+
* <p>The timestamp when the finding was last updated.</p>
|
|
4639
|
+
*/
|
|
4640
|
+
updatedAt?: Date;
|
|
4641
|
+
/**
|
|
4642
|
+
* <p>The score that Amazon Inspector assigned for the finding.</p>
|
|
4643
|
+
*/
|
|
4644
|
+
inspectorScore?: number;
|
|
4645
|
+
/**
|
|
4646
|
+
* <p>An object that contains details of the Amazon Inspector score.</p>
|
|
4647
|
+
*/
|
|
4648
|
+
inspectorScoreDetails?: InspectorScoreDetails;
|
|
4649
|
+
/**
|
|
4650
|
+
* <p>An object that contains the details of a package vulnerability finding.</p>
|
|
4651
|
+
*/
|
|
4652
|
+
packageVulnerabilityDetails?: PackageVulnerabilityDetails;
|
|
4653
|
+
/**
|
|
4654
|
+
* <p>Details about whether a fix is available for any of the packages that are identified
|
|
4655
|
+
* in the finding through a version update.</p>
|
|
4656
|
+
*/
|
|
4657
|
+
fixAvailable?: string;
|
|
4658
|
+
}
|
|
4659
|
+
/**
|
|
4660
|
+
* @public
|
|
4661
|
+
*/
|
|
4662
|
+
export interface ListImageScanFindingsResponse {
|
|
4663
|
+
/**
|
|
4664
|
+
* <p>The request ID that uniquely identifies this request.</p>
|
|
4665
|
+
*/
|
|
4666
|
+
requestId?: string;
|
|
4667
|
+
/**
|
|
4668
|
+
* <p>The image scan findings for your account that meet your request filter
|
|
4669
|
+
* criteria.</p>
|
|
4670
|
+
*/
|
|
4671
|
+
findings?: ImageScanFinding[];
|
|
4672
|
+
/**
|
|
4673
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
4674
|
+
* there are additional elements that the service has'ot included in this request. Use this token
|
|
4675
|
+
* with the next request to retrieve additional objects.</p>
|
|
3711
4676
|
*/
|
|
3712
4677
|
nextToken?: string;
|
|
3713
4678
|
}
|
|
@@ -3724,8 +4689,8 @@ export interface ListInfrastructureConfigurationsRequest {
|
|
|
3724
4689
|
*/
|
|
3725
4690
|
maxResults?: number;
|
|
3726
4691
|
/**
|
|
3727
|
-
* <p>A token to specify where to start paginating. This is the NextToken
|
|
3728
|
-
*
|
|
4692
|
+
* <p>A token to specify where to start paginating. This is the NextToken
|
|
4693
|
+
* from a previously truncated response.</p>
|
|
3729
4694
|
*/
|
|
3730
4695
|
nextToken?: string;
|
|
3731
4696
|
}
|
|
@@ -3784,9 +4749,9 @@ export interface ListInfrastructureConfigurationsResponse {
|
|
|
3784
4749
|
*/
|
|
3785
4750
|
infrastructureConfigurationSummaryList?: InfrastructureConfigurationSummary[];
|
|
3786
4751
|
/**
|
|
3787
|
-
* <p>The next token used for paginated responses. When this
|
|
3788
|
-
*
|
|
3789
|
-
*
|
|
4752
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
4753
|
+
* there are additional elements that the service has'ot included in this request. Use this token
|
|
4754
|
+
* with the next request to retrieve additional objects.</p>
|
|
3790
4755
|
*/
|
|
3791
4756
|
nextToken?: string;
|
|
3792
4757
|
}
|
|
@@ -3821,6 +4786,214 @@ export interface ListTagsForResourceResponse {
|
|
|
3821
4786
|
*/
|
|
3822
4787
|
tags?: Record<string, string>;
|
|
3823
4788
|
}
|
|
4789
|
+
/**
|
|
4790
|
+
* @public
|
|
4791
|
+
*/
|
|
4792
|
+
export interface ListWorkflowExecutionsRequest {
|
|
4793
|
+
/**
|
|
4794
|
+
* <p>The maximum items to return in a request.</p>
|
|
4795
|
+
*/
|
|
4796
|
+
maxResults?: number;
|
|
4797
|
+
/**
|
|
4798
|
+
* <p>A token to specify where to start paginating. This is the NextToken
|
|
4799
|
+
* from a previously truncated response.</p>
|
|
4800
|
+
*/
|
|
4801
|
+
nextToken?: string;
|
|
4802
|
+
/**
|
|
4803
|
+
* <p>List all workflow runtime instances for the specified image build version
|
|
4804
|
+
* resource ARN.</p>
|
|
4805
|
+
*/
|
|
4806
|
+
imageBuildVersionArn: string | undefined;
|
|
4807
|
+
}
|
|
4808
|
+
/**
|
|
4809
|
+
* @public
|
|
4810
|
+
* <p>Metadata that includes details and status from this runtime instance of the workflow.</p>
|
|
4811
|
+
*/
|
|
4812
|
+
export interface WorkflowExecutionMetadata {
|
|
4813
|
+
/**
|
|
4814
|
+
* <p>The Amazon Resource Name (ARN) of the workflow resource build version that ran.</p>
|
|
4815
|
+
*/
|
|
4816
|
+
workflowBuildVersionArn?: string;
|
|
4817
|
+
/**
|
|
4818
|
+
* <p>Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a
|
|
4819
|
+
* workflow.</p>
|
|
4820
|
+
*/
|
|
4821
|
+
workflowExecutionId?: string;
|
|
4822
|
+
/**
|
|
4823
|
+
* <p>Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.</p>
|
|
4824
|
+
*/
|
|
4825
|
+
type?: WorkflowType | string;
|
|
4826
|
+
/**
|
|
4827
|
+
* <p>The current runtime status for this workflow.</p>
|
|
4828
|
+
*/
|
|
4829
|
+
status?: WorkflowExecutionStatus | string;
|
|
4830
|
+
/**
|
|
4831
|
+
* <p>The runtime output message from the workflow, if applicable.</p>
|
|
4832
|
+
*/
|
|
4833
|
+
message?: string;
|
|
4834
|
+
/**
|
|
4835
|
+
* <p>The total number of steps in the workflow. This should equal the sum of the step
|
|
4836
|
+
* counts for steps that succeeded, were skipped, and failed.</p>
|
|
4837
|
+
*/
|
|
4838
|
+
totalStepCount?: number;
|
|
4839
|
+
/**
|
|
4840
|
+
* <p>A runtime count for the number of steps in the workflow that ran successfully.</p>
|
|
4841
|
+
*/
|
|
4842
|
+
totalStepsSucceeded?: number;
|
|
4843
|
+
/**
|
|
4844
|
+
* <p>A runtime count for the number of steps in the workflow that failed.</p>
|
|
4845
|
+
*/
|
|
4846
|
+
totalStepsFailed?: number;
|
|
4847
|
+
/**
|
|
4848
|
+
* <p>A runtime count for the number of steps in the workflow that were skipped.</p>
|
|
4849
|
+
*/
|
|
4850
|
+
totalStepsSkipped?: number;
|
|
4851
|
+
/**
|
|
4852
|
+
* <p>The timestamp when the runtime instance of this workflow started.</p>
|
|
4853
|
+
*/
|
|
4854
|
+
startTime?: string;
|
|
4855
|
+
/**
|
|
4856
|
+
* <p>The timestamp when this runtime instance of the workflow finished.</p>
|
|
4857
|
+
*/
|
|
4858
|
+
endTime?: string;
|
|
4859
|
+
}
|
|
4860
|
+
/**
|
|
4861
|
+
* @public
|
|
4862
|
+
*/
|
|
4863
|
+
export interface ListWorkflowExecutionsResponse {
|
|
4864
|
+
/**
|
|
4865
|
+
* <p>The request ID that uniquely identifies this request.</p>
|
|
4866
|
+
*/
|
|
4867
|
+
requestId?: string;
|
|
4868
|
+
/**
|
|
4869
|
+
* <p>Contains an array of runtime details that represents each time a workflow ran for
|
|
4870
|
+
* the requested image build version.</p>
|
|
4871
|
+
*/
|
|
4872
|
+
workflowExecutions?: WorkflowExecutionMetadata[];
|
|
4873
|
+
/**
|
|
4874
|
+
* <p>The resource ARN of the image build version for which you requested a list of
|
|
4875
|
+
* workflow runtime details.</p>
|
|
4876
|
+
*/
|
|
4877
|
+
imageBuildVersionArn?: string;
|
|
4878
|
+
/**
|
|
4879
|
+
* <p>The output message from the list action, if applicable.</p>
|
|
4880
|
+
*/
|
|
4881
|
+
message?: string;
|
|
4882
|
+
/**
|
|
4883
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
4884
|
+
* there are additional elements that the service has'ot included in this request. Use this token
|
|
4885
|
+
* with the next request to retrieve additional objects.</p>
|
|
4886
|
+
*/
|
|
4887
|
+
nextToken?: string;
|
|
4888
|
+
}
|
|
4889
|
+
/**
|
|
4890
|
+
* @public
|
|
4891
|
+
*/
|
|
4892
|
+
export interface ListWorkflowStepExecutionsRequest {
|
|
4893
|
+
/**
|
|
4894
|
+
* <p>The maximum items to return in a request.</p>
|
|
4895
|
+
*/
|
|
4896
|
+
maxResults?: number;
|
|
4897
|
+
/**
|
|
4898
|
+
* <p>A token to specify where to start paginating. This is the NextToken
|
|
4899
|
+
* from a previously truncated response.</p>
|
|
4900
|
+
*/
|
|
4901
|
+
nextToken?: string;
|
|
4902
|
+
/**
|
|
4903
|
+
* <p>The unique identifier that Image Builder assigned to keep track of runtime details
|
|
4904
|
+
* when it ran the workflow.</p>
|
|
4905
|
+
*/
|
|
4906
|
+
workflowExecutionId: string | undefined;
|
|
4907
|
+
}
|
|
4908
|
+
/**
|
|
4909
|
+
* @public
|
|
4910
|
+
* <p>Runtime details and status for the workflow step.</p>
|
|
4911
|
+
*/
|
|
4912
|
+
export interface WorkflowStepMetadata {
|
|
4913
|
+
/**
|
|
4914
|
+
* <p>A unique identifier for the workflow step, assigned at runtime.</p>
|
|
4915
|
+
*/
|
|
4916
|
+
stepExecutionId?: string;
|
|
4917
|
+
/**
|
|
4918
|
+
* <p>The name of the workflow step.</p>
|
|
4919
|
+
*/
|
|
4920
|
+
name?: string;
|
|
4921
|
+
/**
|
|
4922
|
+
* <p>Description of the workflow step.</p>
|
|
4923
|
+
*/
|
|
4924
|
+
description?: string;
|
|
4925
|
+
/**
|
|
4926
|
+
* <p>The step action name.</p>
|
|
4927
|
+
*/
|
|
4928
|
+
action?: string;
|
|
4929
|
+
/**
|
|
4930
|
+
* <p>Runtime status for the workflow step.</p>
|
|
4931
|
+
*/
|
|
4932
|
+
status?: WorkflowStepExecutionStatus | string;
|
|
4933
|
+
/**
|
|
4934
|
+
* <p>Reports on the rollback status of the step, if applicable.</p>
|
|
4935
|
+
*/
|
|
4936
|
+
rollbackStatus?: WorkflowStepExecutionRollbackStatus | string;
|
|
4937
|
+
/**
|
|
4938
|
+
* <p>Detailed output message that the workflow step provides at runtime.</p>
|
|
4939
|
+
*/
|
|
4940
|
+
message?: string;
|
|
4941
|
+
/**
|
|
4942
|
+
* <p>Input parameters that Image Builder provides for the workflow step.</p>
|
|
4943
|
+
*/
|
|
4944
|
+
inputs?: string;
|
|
4945
|
+
/**
|
|
4946
|
+
* <p>The file names that the workflow step created as output for this runtime instance of the workflow.</p>
|
|
4947
|
+
*/
|
|
4948
|
+
outputs?: string;
|
|
4949
|
+
/**
|
|
4950
|
+
* <p>The timestamp when the workflow step started.</p>
|
|
4951
|
+
*/
|
|
4952
|
+
startTime?: string;
|
|
4953
|
+
/**
|
|
4954
|
+
* <p>The timestamp when the workflow step finished.</p>
|
|
4955
|
+
*/
|
|
4956
|
+
endTime?: string;
|
|
4957
|
+
}
|
|
4958
|
+
/**
|
|
4959
|
+
* @public
|
|
4960
|
+
*/
|
|
4961
|
+
export interface ListWorkflowStepExecutionsResponse {
|
|
4962
|
+
/**
|
|
4963
|
+
* <p>The request ID that uniquely identifies this request.</p>
|
|
4964
|
+
*/
|
|
4965
|
+
requestId?: string;
|
|
4966
|
+
/**
|
|
4967
|
+
* <p>Contains an array of runtime details that represents each step in this runtime
|
|
4968
|
+
* instance of the workflow.</p>
|
|
4969
|
+
*/
|
|
4970
|
+
steps?: WorkflowStepMetadata[];
|
|
4971
|
+
/**
|
|
4972
|
+
* <p>The build version ARN for the Image Builder workflow resource that defines the steps for
|
|
4973
|
+
* this runtime instance of the workflow.</p>
|
|
4974
|
+
*/
|
|
4975
|
+
workflowBuildVersionArn?: string;
|
|
4976
|
+
/**
|
|
4977
|
+
* <p>The unique identifier that Image Builder assigned to keep track of runtime details
|
|
4978
|
+
* when it ran the workflow.</p>
|
|
4979
|
+
*/
|
|
4980
|
+
workflowExecutionId?: string;
|
|
4981
|
+
/**
|
|
4982
|
+
* <p>The image build version resource ARN that's associated with the specified runtime
|
|
4983
|
+
* instance of the workflow.</p>
|
|
4984
|
+
*/
|
|
4985
|
+
imageBuildVersionArn?: string;
|
|
4986
|
+
/**
|
|
4987
|
+
* <p>The output message from the list action, if applicable.</p>
|
|
4988
|
+
*/
|
|
4989
|
+
message?: string;
|
|
4990
|
+
/**
|
|
4991
|
+
* <p>The next token used for paginated responses. When this field isn't empty,
|
|
4992
|
+
* there are additional elements that the service has'ot included in this request. Use this token
|
|
4993
|
+
* with the next request to retrieve additional objects.</p>
|
|
4994
|
+
*/
|
|
4995
|
+
nextToken?: string;
|
|
4996
|
+
}
|
|
3824
4997
|
/**
|
|
3825
4998
|
* @public
|
|
3826
4999
|
* <p>The value that you provided for the specified parameter is invalid.</p>
|
|
@@ -3838,7 +5011,8 @@ export declare class InvalidParameterValueException extends __BaseException {
|
|
|
3838
5011
|
*/
|
|
3839
5012
|
export interface PutComponentPolicyRequest {
|
|
3840
5013
|
/**
|
|
3841
|
-
* <p>The Amazon Resource Name (ARN) of the component that this policy should be applied
|
|
5014
|
+
* <p>The Amazon Resource Name (ARN) of the component that this policy should be applied
|
|
5015
|
+
* to.</p>
|
|
3842
5016
|
*/
|
|
3843
5017
|
componentArn: string | undefined;
|
|
3844
5018
|
/**
|
|
@@ -3855,7 +5029,8 @@ export interface PutComponentPolicyResponse {
|
|
|
3855
5029
|
*/
|
|
3856
5030
|
requestId?: string;
|
|
3857
5031
|
/**
|
|
3858
|
-
* <p>The Amazon Resource Name (ARN) of the component that this policy was applied
|
|
5032
|
+
* <p>The Amazon Resource Name (ARN) of the component that this policy was applied
|
|
5033
|
+
* to.</p>
|
|
3859
5034
|
*/
|
|
3860
5035
|
componentArn?: string;
|
|
3861
5036
|
}
|
|
@@ -3864,7 +5039,8 @@ export interface PutComponentPolicyResponse {
|
|
|
3864
5039
|
*/
|
|
3865
5040
|
export interface PutContainerRecipePolicyRequest {
|
|
3866
5041
|
/**
|
|
3867
|
-
* <p>The Amazon Resource Name (ARN) of the container recipe that this policy should be
|
|
5042
|
+
* <p>The Amazon Resource Name (ARN) of the container recipe that this policy should be
|
|
5043
|
+
* applied to.</p>
|
|
3868
5044
|
*/
|
|
3869
5045
|
containerRecipeArn: string | undefined;
|
|
3870
5046
|
/**
|
|
@@ -3881,7 +5057,8 @@ export interface PutContainerRecipePolicyResponse {
|
|
|
3881
5057
|
*/
|
|
3882
5058
|
requestId?: string;
|
|
3883
5059
|
/**
|
|
3884
|
-
* <p>The Amazon Resource Name (ARN) of the container recipe that this policy was applied
|
|
5060
|
+
* <p>The Amazon Resource Name (ARN) of the container recipe that this policy was applied
|
|
5061
|
+
* to.</p>
|
|
3885
5062
|
*/
|
|
3886
5063
|
containerRecipeArn?: string;
|
|
3887
5064
|
}
|
|
@@ -3890,7 +5067,8 @@ export interface PutContainerRecipePolicyResponse {
|
|
|
3890
5067
|
*/
|
|
3891
5068
|
export interface PutImagePolicyRequest {
|
|
3892
5069
|
/**
|
|
3893
|
-
* <p>The Amazon Resource Name (ARN) of the image that this policy should be applied
|
|
5070
|
+
* <p>The Amazon Resource Name (ARN) of the image that this policy should be applied
|
|
5071
|
+
* to.</p>
|
|
3894
5072
|
*/
|
|
3895
5073
|
imageArn: string | undefined;
|
|
3896
5074
|
/**
|
|
@@ -3916,7 +5094,8 @@ export interface PutImagePolicyResponse {
|
|
|
3916
5094
|
*/
|
|
3917
5095
|
export interface PutImageRecipePolicyRequest {
|
|
3918
5096
|
/**
|
|
3919
|
-
* <p>The Amazon Resource Name (ARN) of the image recipe that this policy should be applied
|
|
5097
|
+
* <p>The Amazon Resource Name (ARN) of the image recipe that this policy should be applied
|
|
5098
|
+
* to.</p>
|
|
3920
5099
|
*/
|
|
3921
5100
|
imageRecipeArn: string | undefined;
|
|
3922
5101
|
/**
|
|
@@ -3933,7 +5112,8 @@ export interface PutImageRecipePolicyResponse {
|
|
|
3933
5112
|
*/
|
|
3934
5113
|
requestId?: string;
|
|
3935
5114
|
/**
|
|
3936
|
-
* <p>The Amazon Resource Name (ARN) of the image recipe that this policy was applied
|
|
5115
|
+
* <p>The Amazon Resource Name (ARN) of the image recipe that this policy was applied
|
|
5116
|
+
* to.</p>
|
|
3937
5117
|
*/
|
|
3938
5118
|
imageRecipeArn?: string;
|
|
3939
5119
|
}
|
|
@@ -3942,7 +5122,8 @@ export interface PutImageRecipePolicyResponse {
|
|
|
3942
5122
|
*/
|
|
3943
5123
|
export interface StartImagePipelineExecutionRequest {
|
|
3944
5124
|
/**
|
|
3945
|
-
* <p>The Amazon Resource Name (ARN) of the image pipeline that you want to manually
|
|
5125
|
+
* <p>The Amazon Resource Name (ARN) of the image pipeline that you want to manually
|
|
5126
|
+
* invoke.</p>
|
|
3946
5127
|
*/
|
|
3947
5128
|
imagePipelineArn: string | undefined;
|
|
3948
5129
|
/**
|
|
@@ -4008,7 +5189,8 @@ export interface UntagResourceResponse {
|
|
|
4008
5189
|
*/
|
|
4009
5190
|
export interface UpdateDistributionConfigurationRequest {
|
|
4010
5191
|
/**
|
|
4011
|
-
* <p>The Amazon Resource Name (ARN) of the distribution configuration that you want to
|
|
5192
|
+
* <p>The Amazon Resource Name (ARN) of the distribution configuration that you want to
|
|
5193
|
+
* update.</p>
|
|
4012
5194
|
*/
|
|
4013
5195
|
distributionConfigurationArn: string | undefined;
|
|
4014
5196
|
/**
|
|
@@ -4037,8 +5219,8 @@ export interface UpdateDistributionConfigurationResponse {
|
|
|
4037
5219
|
*/
|
|
4038
5220
|
clientToken?: string;
|
|
4039
5221
|
/**
|
|
4040
|
-
* <p>The Amazon Resource Name (ARN) of the distribution configuration that was updated by
|
|
4041
|
-
* request.</p>
|
|
5222
|
+
* <p>The Amazon Resource Name (ARN) of the distribution configuration that was updated by
|
|
5223
|
+
* this request.</p>
|
|
4042
5224
|
*/
|
|
4043
5225
|
distributionConfigurationArn?: string;
|
|
4044
5226
|
}
|
|
@@ -4055,8 +5237,8 @@ export interface UpdateImagePipelineRequest {
|
|
|
4055
5237
|
*/
|
|
4056
5238
|
description?: string;
|
|
4057
5239
|
/**
|
|
4058
|
-
* <p>The Amazon Resource Name (ARN) of the image recipe that will be used to configure
|
|
4059
|
-
* updated by this image pipeline.</p>
|
|
5240
|
+
* <p>The Amazon Resource Name (ARN) of the image recipe that will be used to configure
|
|
5241
|
+
* images updated by this image pipeline.</p>
|
|
4060
5242
|
*/
|
|
4061
5243
|
imageRecipeArn?: string;
|
|
4062
5244
|
/**
|
|
@@ -4064,13 +5246,13 @@ export interface UpdateImagePipelineRequest {
|
|
|
4064
5246
|
*/
|
|
4065
5247
|
containerRecipeArn?: string;
|
|
4066
5248
|
/**
|
|
4067
|
-
* <p>The Amazon Resource Name (ARN) of the infrastructure configuration that
|
|
4068
|
-
* build images
|
|
5249
|
+
* <p>The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to
|
|
5250
|
+
* build images that this image pipeline has updated.</p>
|
|
4069
5251
|
*/
|
|
4070
5252
|
infrastructureConfigurationArn: string | undefined;
|
|
4071
5253
|
/**
|
|
4072
|
-
* <p>The Amazon Resource Name (ARN) of the distribution configuration that
|
|
4073
|
-
* configure and distribute images
|
|
5254
|
+
* <p>The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to
|
|
5255
|
+
* configure and distribute images that this image pipeline has updated.</p>
|
|
4074
5256
|
*/
|
|
4075
5257
|
distributionConfigurationArn?: string;
|
|
4076
5258
|
/**
|
|
@@ -4078,7 +5260,7 @@ export interface UpdateImagePipelineRequest {
|
|
|
4078
5260
|
*/
|
|
4079
5261
|
imageTestsConfiguration?: ImageTestsConfiguration;
|
|
4080
5262
|
/**
|
|
4081
|
-
* <p>
|
|
5263
|
+
* <p>Collects additional information about the image being created, including the operating
|
|
4082
5264
|
* system (OS) version and package list. This information is used to enhance the overall
|
|
4083
5265
|
* experience of using EC2 Image Builder. Enabled by default.</p>
|
|
4084
5266
|
*/
|
|
@@ -4095,6 +5277,10 @@ export interface UpdateImagePipelineRequest {
|
|
|
4095
5277
|
* <p>The idempotency token used to make this request idempotent.</p>
|
|
4096
5278
|
*/
|
|
4097
5279
|
clientToken?: string;
|
|
5280
|
+
/**
|
|
5281
|
+
* <p>Contains settings for vulnerability scans.</p>
|
|
5282
|
+
*/
|
|
5283
|
+
imageScanningConfiguration?: ImageScanningConfiguration;
|
|
4098
5284
|
}
|
|
4099
5285
|
/**
|
|
4100
5286
|
* @public
|
|
@@ -4109,7 +5295,8 @@ export interface UpdateImagePipelineResponse {
|
|
|
4109
5295
|
*/
|
|
4110
5296
|
clientToken?: string;
|
|
4111
5297
|
/**
|
|
4112
|
-
* <p>The Amazon Resource Name (ARN) of the image pipeline that was updated by this
|
|
5298
|
+
* <p>The Amazon Resource Name (ARN) of the image pipeline that was updated by this
|
|
5299
|
+
* request.</p>
|
|
4113
5300
|
*/
|
|
4114
5301
|
imagePipelineArn?: string;
|
|
4115
5302
|
}
|
|
@@ -4128,16 +5315,18 @@ export interface UpdateInfrastructureConfigurationRequest {
|
|
|
4128
5315
|
description?: string;
|
|
4129
5316
|
/**
|
|
4130
5317
|
* <p>The instance types of the infrastructure configuration. You can specify one or more
|
|
4131
|
-
* instance types to use for this build. The service will pick one of these instance types
|
|
4132
|
-
* on availability.</p>
|
|
5318
|
+
* instance types to use for this build. The service will pick one of these instance types
|
|
5319
|
+
* based on availability.</p>
|
|
4133
5320
|
*/
|
|
4134
5321
|
instanceTypes?: string[];
|
|
4135
5322
|
/**
|
|
4136
|
-
* <p>The instance profile to associate with the instance used to customize your Amazon EC2
|
|
5323
|
+
* <p>The instance profile to associate with the instance used to customize your Amazon EC2
|
|
5324
|
+
* AMI.</p>
|
|
4137
5325
|
*/
|
|
4138
5326
|
instanceProfileName: string | undefined;
|
|
4139
5327
|
/**
|
|
4140
|
-
* <p>The security group IDs to associate with the instance used to customize your Amazon EC2
|
|
5328
|
+
* <p>The security group IDs to associate with the instance used to customize your Amazon EC2
|
|
5329
|
+
* AMI.</p>
|
|
4141
5330
|
*/
|
|
4142
5331
|
securityGroupIds?: string[];
|
|
4143
5332
|
/**
|
|
@@ -4149,18 +5338,19 @@ export interface UpdateInfrastructureConfigurationRequest {
|
|
|
4149
5338
|
*/
|
|
4150
5339
|
logging?: Logging;
|
|
4151
5340
|
/**
|
|
4152
|
-
* <p>The key pair of the infrastructure configuration. You can use this to log on to and
|
|
4153
|
-
* the instance used to create your image.</p>
|
|
5341
|
+
* <p>The key pair of the infrastructure configuration. You can use this to log on to and
|
|
5342
|
+
* debug the instance used to create your image.</p>
|
|
4154
5343
|
*/
|
|
4155
5344
|
keyPair?: string;
|
|
4156
5345
|
/**
|
|
4157
5346
|
* <p>The terminate instance on failure setting of the infrastructure configuration. Set to
|
|
4158
|
-
* false if you want Image Builder to retain the instance used to configure your AMI if the build
|
|
4159
|
-
*
|
|
5347
|
+
* false if you want Image Builder to retain the instance used to configure your AMI if the build or
|
|
5348
|
+
* test phase of your workflow fails.</p>
|
|
4160
5349
|
*/
|
|
4161
5350
|
terminateInstanceOnFailure?: boolean;
|
|
4162
5351
|
/**
|
|
4163
|
-
* <p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event
|
|
5352
|
+
* <p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event
|
|
5353
|
+
* notifications.</p>
|
|
4164
5354
|
* <note>
|
|
4165
5355
|
* <p>EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys
|
|
4166
5356
|
* from other accounts. The key that is used to encrypt the SNS topic must reside in the
|
|
@@ -4177,25 +5367,23 @@ export interface UpdateInfrastructureConfigurationRequest {
|
|
|
4177
5367
|
*/
|
|
4178
5368
|
resourceTags?: Record<string, string>;
|
|
4179
5369
|
/**
|
|
4180
|
-
* <p>The instance metadata options that you can set for the HTTP requests that pipeline
|
|
4181
|
-
* use to launch EC2 build and test instances. For more information about instance
|
|
4182
|
-
* options, see one of the following links:</p>
|
|
5370
|
+
* <p>The instance metadata options that you can set for the HTTP requests that pipeline
|
|
5371
|
+
* builds use to launch EC2 build and test instances. For more information about instance
|
|
5372
|
+
* metadata options, see one of the following links:</p>
|
|
4183
5373
|
* <ul>
|
|
4184
5374
|
* <li>
|
|
4185
5375
|
* <p>
|
|
4186
|
-
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html">Configure
|
|
4187
|
-
*
|
|
5376
|
+
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html">Configure the instance metadata options</a> in the
|
|
5377
|
+
* <i>
|
|
4188
5378
|
* <i>Amazon EC2 User Guide</i>
|
|
4189
|
-
* </i>
|
|
4190
|
-
* for Linux instances.</p>
|
|
5379
|
+
* </i> for Linux instances.</p>
|
|
4191
5380
|
* </li>
|
|
4192
5381
|
* <li>
|
|
4193
5382
|
* <p>
|
|
4194
|
-
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html">Configure
|
|
4195
|
-
*
|
|
5383
|
+
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html">Configure the instance metadata options</a> in the
|
|
5384
|
+
* <i>
|
|
4196
5385
|
* <i>Amazon EC2 Windows Guide</i>
|
|
4197
|
-
* </i>
|
|
4198
|
-
* for Windows instances.</p>
|
|
5386
|
+
* </i> for Windows instances.</p>
|
|
4199
5387
|
* </li>
|
|
4200
5388
|
* </ul>
|
|
4201
5389
|
*/
|