@aws-sdk/client-imagebuilder 3.315.0 → 3.316.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.
@@ -56,527 +56,350 @@ import { UpdateDistributionConfigurationCommandInput, UpdateDistributionConfigur
56
56
  import { UpdateImagePipelineCommandInput, UpdateImagePipelineCommandOutput } from "./commands/UpdateImagePipelineCommand";
57
57
  import { UpdateInfrastructureConfigurationCommandInput, UpdateInfrastructureConfigurationCommandOutput } from "./commands/UpdateInfrastructureConfigurationCommand";
58
58
  import { ImagebuilderClient } from "./ImagebuilderClient";
59
- /**
60
- * @public
61
- * <p>EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the
62
- * creation, management, and deployment of customized, secure, and up-to-date
63
- * "golden" server images that are pre-installed and pre-configured with software
64
- * and settings to meet specific IT standards.</p>
65
- */
66
- export declare class Imagebuilder extends ImagebuilderClient {
59
+ export interface Imagebuilder {
67
60
  /**
68
- * @public
69
- * <p>CancelImageCreation cancels the creation of Image. This operation can only be used on
70
- * images in a non-terminal state.</p>
61
+ * @see {@link CancelImageCreationCommand}
71
62
  */
72
63
  cancelImageCreation(args: CancelImageCreationCommandInput, options?: __HttpHandlerOptions): Promise<CancelImageCreationCommandOutput>;
73
64
  cancelImageCreation(args: CancelImageCreationCommandInput, cb: (err: any, data?: CancelImageCreationCommandOutput) => void): void;
74
65
  cancelImageCreation(args: CancelImageCreationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelImageCreationCommandOutput) => void): void;
75
66
  /**
76
- * @public
77
- * <p>Creates a new component that can be used to build, validate, test, and assess your
78
- * image. The component is based on a YAML document that you specify using exactly one of
79
- * the following methods:</p>
80
- * <ul>
81
- * <li>
82
- * <p>Inline, using the <code>data</code> property in the request body.</p>
83
- * </li>
84
- * <li>
85
- * <p>A URL that points to a YAML document file stored in Amazon S3, using the
86
- * <code>uri</code> property in the request body.</p>
87
- * </li>
88
- * </ul>
67
+ * @see {@link CreateComponentCommand}
89
68
  */
90
69
  createComponent(args: CreateComponentCommandInput, options?: __HttpHandlerOptions): Promise<CreateComponentCommandOutput>;
91
70
  createComponent(args: CreateComponentCommandInput, cb: (err: any, data?: CreateComponentCommandOutput) => void): void;
92
71
  createComponent(args: CreateComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateComponentCommandOutput) => void): void;
93
72
  /**
94
- * @public
95
- * <p>Creates a new container recipe. Container recipes define how images are configured,
96
- * tested, and assessed.</p>
73
+ * @see {@link CreateContainerRecipeCommand}
97
74
  */
98
75
  createContainerRecipe(args: CreateContainerRecipeCommandInput, options?: __HttpHandlerOptions): Promise<CreateContainerRecipeCommandOutput>;
99
76
  createContainerRecipe(args: CreateContainerRecipeCommandInput, cb: (err: any, data?: CreateContainerRecipeCommandOutput) => void): void;
100
77
  createContainerRecipe(args: CreateContainerRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContainerRecipeCommandOutput) => void): void;
101
78
  /**
102
- * @public
103
- * <p>Creates a new distribution configuration. Distribution configurations define and
104
- * configure the outputs of your pipeline.</p>
79
+ * @see {@link CreateDistributionConfigurationCommand}
105
80
  */
106
81
  createDistributionConfiguration(args: CreateDistributionConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<CreateDistributionConfigurationCommandOutput>;
107
82
  createDistributionConfiguration(args: CreateDistributionConfigurationCommandInput, cb: (err: any, data?: CreateDistributionConfigurationCommandOutput) => void): void;
108
83
  createDistributionConfiguration(args: CreateDistributionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDistributionConfigurationCommandOutput) => void): void;
109
84
  /**
110
- * @public
111
- * <p>Creates a new image. This request will create a new image along with all of the
112
- * configured output resources defined in the distribution configuration. You must specify
113
- * exactly one recipe for your image, using either a ContainerRecipeArn or an
114
- * ImageRecipeArn.</p>
85
+ * @see {@link CreateImageCommand}
115
86
  */
116
87
  createImage(args: CreateImageCommandInput, options?: __HttpHandlerOptions): Promise<CreateImageCommandOutput>;
117
88
  createImage(args: CreateImageCommandInput, cb: (err: any, data?: CreateImageCommandOutput) => void): void;
118
89
  createImage(args: CreateImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateImageCommandOutput) => void): void;
119
90
  /**
120
- * @public
121
- * <p>Creates a new image pipeline. Image pipelines enable you to automate the creation and
122
- * distribution of images.</p>
91
+ * @see {@link CreateImagePipelineCommand}
123
92
  */
124
93
  createImagePipeline(args: CreateImagePipelineCommandInput, options?: __HttpHandlerOptions): Promise<CreateImagePipelineCommandOutput>;
125
94
  createImagePipeline(args: CreateImagePipelineCommandInput, cb: (err: any, data?: CreateImagePipelineCommandOutput) => void): void;
126
95
  createImagePipeline(args: CreateImagePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateImagePipelineCommandOutput) => void): void;
127
96
  /**
128
- * @public
129
- * <p>Creates a new image recipe. Image recipes define how images are configured, tested,
130
- * and assessed.</p>
97
+ * @see {@link CreateImageRecipeCommand}
131
98
  */
132
99
  createImageRecipe(args: CreateImageRecipeCommandInput, options?: __HttpHandlerOptions): Promise<CreateImageRecipeCommandOutput>;
133
100
  createImageRecipe(args: CreateImageRecipeCommandInput, cb: (err: any, data?: CreateImageRecipeCommandOutput) => void): void;
134
101
  createImageRecipe(args: CreateImageRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateImageRecipeCommandOutput) => void): void;
135
102
  /**
136
- * @public
137
- * <p>Creates a new infrastructure configuration. An infrastructure configuration defines
138
- * the environment in which your image will be built and tested.</p>
103
+ * @see {@link CreateInfrastructureConfigurationCommand}
139
104
  */
140
105
  createInfrastructureConfiguration(args: CreateInfrastructureConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<CreateInfrastructureConfigurationCommandOutput>;
141
106
  createInfrastructureConfiguration(args: CreateInfrastructureConfigurationCommandInput, cb: (err: any, data?: CreateInfrastructureConfigurationCommandOutput) => void): void;
142
107
  createInfrastructureConfiguration(args: CreateInfrastructureConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInfrastructureConfigurationCommandOutput) => void): void;
143
108
  /**
144
- * @public
145
- * <p>Deletes a component build version.</p>
109
+ * @see {@link DeleteComponentCommand}
146
110
  */
147
111
  deleteComponent(args: DeleteComponentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteComponentCommandOutput>;
148
112
  deleteComponent(args: DeleteComponentCommandInput, cb: (err: any, data?: DeleteComponentCommandOutput) => void): void;
149
113
  deleteComponent(args: DeleteComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteComponentCommandOutput) => void): void;
150
114
  /**
151
- * @public
152
- * <p>Deletes a container recipe.</p>
115
+ * @see {@link DeleteContainerRecipeCommand}
153
116
  */
154
117
  deleteContainerRecipe(args: DeleteContainerRecipeCommandInput, options?: __HttpHandlerOptions): Promise<DeleteContainerRecipeCommandOutput>;
155
118
  deleteContainerRecipe(args: DeleteContainerRecipeCommandInput, cb: (err: any, data?: DeleteContainerRecipeCommandOutput) => void): void;
156
119
  deleteContainerRecipe(args: DeleteContainerRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContainerRecipeCommandOutput) => void): void;
157
120
  /**
158
- * @public
159
- * <p>Deletes a distribution configuration.</p>
121
+ * @see {@link DeleteDistributionConfigurationCommand}
160
122
  */
161
123
  deleteDistributionConfiguration(args: DeleteDistributionConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDistributionConfigurationCommandOutput>;
162
124
  deleteDistributionConfiguration(args: DeleteDistributionConfigurationCommandInput, cb: (err: any, data?: DeleteDistributionConfigurationCommandOutput) => void): void;
163
125
  deleteDistributionConfiguration(args: DeleteDistributionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDistributionConfigurationCommandOutput) => void): void;
164
126
  /**
165
- * @public
166
- * <p>Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container
167
- * images that are created during the image build process. You must clean those up
168
- * separately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI
169
- * commands.</p>
170
- * <ul>
171
- * <li>
172
- * <p>To deregister an EC2 Linux AMI, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/deregister-ami.html">Deregister your
173
- * Linux AMI</a> in the <i>
174
- * <i>Amazon EC2 User Guide</i>
175
- * </i>.</p>
176
- * </li>
177
- * <li>
178
- * <p>To deregister an EC2 Windows AMI, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/deregister-ami.html">Deregister your
179
- * Windows AMI</a> in the <i>
180
- * <i>Amazon EC2 Windows Guide</i>
181
- * </i>.</p>
182
- * </li>
183
- * <li>
184
- * <p>To delete a container image from Amazon ECR, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/delete_image.html">Deleting
185
- * an image</a> in the <i>Amazon ECR User Guide</i>.</p>
186
- * </li>
187
- * </ul>
127
+ * @see {@link DeleteImageCommand}
188
128
  */
189
129
  deleteImage(args: DeleteImageCommandInput, options?: __HttpHandlerOptions): Promise<DeleteImageCommandOutput>;
190
130
  deleteImage(args: DeleteImageCommandInput, cb: (err: any, data?: DeleteImageCommandOutput) => void): void;
191
131
  deleteImage(args: DeleteImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImageCommandOutput) => void): void;
192
132
  /**
193
- * @public
194
- * <p>Deletes an image pipeline.</p>
133
+ * @see {@link DeleteImagePipelineCommand}
195
134
  */
196
135
  deleteImagePipeline(args: DeleteImagePipelineCommandInput, options?: __HttpHandlerOptions): Promise<DeleteImagePipelineCommandOutput>;
197
136
  deleteImagePipeline(args: DeleteImagePipelineCommandInput, cb: (err: any, data?: DeleteImagePipelineCommandOutput) => void): void;
198
137
  deleteImagePipeline(args: DeleteImagePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImagePipelineCommandOutput) => void): void;
199
138
  /**
200
- * @public
201
- * <p>Deletes an image recipe.</p>
139
+ * @see {@link DeleteImageRecipeCommand}
202
140
  */
203
141
  deleteImageRecipe(args: DeleteImageRecipeCommandInput, options?: __HttpHandlerOptions): Promise<DeleteImageRecipeCommandOutput>;
204
142
  deleteImageRecipe(args: DeleteImageRecipeCommandInput, cb: (err: any, data?: DeleteImageRecipeCommandOutput) => void): void;
205
143
  deleteImageRecipe(args: DeleteImageRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImageRecipeCommandOutput) => void): void;
206
144
  /**
207
- * @public
208
- * <p>Deletes an infrastructure configuration.</p>
145
+ * @see {@link DeleteInfrastructureConfigurationCommand}
209
146
  */
210
147
  deleteInfrastructureConfiguration(args: DeleteInfrastructureConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteInfrastructureConfigurationCommandOutput>;
211
148
  deleteInfrastructureConfiguration(args: DeleteInfrastructureConfigurationCommandInput, cb: (err: any, data?: DeleteInfrastructureConfigurationCommandOutput) => void): void;
212
149
  deleteInfrastructureConfiguration(args: DeleteInfrastructureConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInfrastructureConfigurationCommandOutput) => void): void;
213
150
  /**
214
- * @public
215
- * <p>Gets a component object.</p>
151
+ * @see {@link GetComponentCommand}
216
152
  */
217
153
  getComponent(args: GetComponentCommandInput, options?: __HttpHandlerOptions): Promise<GetComponentCommandOutput>;
218
154
  getComponent(args: GetComponentCommandInput, cb: (err: any, data?: GetComponentCommandOutput) => void): void;
219
155
  getComponent(args: GetComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComponentCommandOutput) => void): void;
220
156
  /**
221
- * @public
222
- * <p>Gets a component policy.</p>
157
+ * @see {@link GetComponentPolicyCommand}
223
158
  */
224
159
  getComponentPolicy(args: GetComponentPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetComponentPolicyCommandOutput>;
225
160
  getComponentPolicy(args: GetComponentPolicyCommandInput, cb: (err: any, data?: GetComponentPolicyCommandOutput) => void): void;
226
161
  getComponentPolicy(args: GetComponentPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComponentPolicyCommandOutput) => void): void;
227
162
  /**
228
- * @public
229
- * <p>Retrieves a container recipe.</p>
163
+ * @see {@link GetContainerRecipeCommand}
230
164
  */
231
165
  getContainerRecipe(args: GetContainerRecipeCommandInput, options?: __HttpHandlerOptions): Promise<GetContainerRecipeCommandOutput>;
232
166
  getContainerRecipe(args: GetContainerRecipeCommandInput, cb: (err: any, data?: GetContainerRecipeCommandOutput) => void): void;
233
167
  getContainerRecipe(args: GetContainerRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContainerRecipeCommandOutput) => void): void;
234
168
  /**
235
- * @public
236
- * <p>Retrieves the policy for a container recipe.</p>
169
+ * @see {@link GetContainerRecipePolicyCommand}
237
170
  */
238
171
  getContainerRecipePolicy(args: GetContainerRecipePolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetContainerRecipePolicyCommandOutput>;
239
172
  getContainerRecipePolicy(args: GetContainerRecipePolicyCommandInput, cb: (err: any, data?: GetContainerRecipePolicyCommandOutput) => void): void;
240
173
  getContainerRecipePolicy(args: GetContainerRecipePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContainerRecipePolicyCommandOutput) => void): void;
241
174
  /**
242
- * @public
243
- * <p>Gets a distribution configuration.</p>
175
+ * @see {@link GetDistributionConfigurationCommand}
244
176
  */
245
177
  getDistributionConfiguration(args: GetDistributionConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetDistributionConfigurationCommandOutput>;
246
178
  getDistributionConfiguration(args: GetDistributionConfigurationCommandInput, cb: (err: any, data?: GetDistributionConfigurationCommandOutput) => void): void;
247
179
  getDistributionConfiguration(args: GetDistributionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDistributionConfigurationCommandOutput) => void): void;
248
180
  /**
249
- * @public
250
- * <p>Gets an image.</p>
181
+ * @see {@link GetImageCommand}
251
182
  */
252
183
  getImage(args: GetImageCommandInput, options?: __HttpHandlerOptions): Promise<GetImageCommandOutput>;
253
184
  getImage(args: GetImageCommandInput, cb: (err: any, data?: GetImageCommandOutput) => void): void;
254
185
  getImage(args: GetImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImageCommandOutput) => void): void;
255
186
  /**
256
- * @public
257
- * <p>Gets an image pipeline.</p>
187
+ * @see {@link GetImagePipelineCommand}
258
188
  */
259
189
  getImagePipeline(args: GetImagePipelineCommandInput, options?: __HttpHandlerOptions): Promise<GetImagePipelineCommandOutput>;
260
190
  getImagePipeline(args: GetImagePipelineCommandInput, cb: (err: any, data?: GetImagePipelineCommandOutput) => void): void;
261
191
  getImagePipeline(args: GetImagePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImagePipelineCommandOutput) => void): void;
262
192
  /**
263
- * @public
264
- * <p>Gets an image policy.</p>
193
+ * @see {@link GetImagePolicyCommand}
265
194
  */
266
195
  getImagePolicy(args: GetImagePolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetImagePolicyCommandOutput>;
267
196
  getImagePolicy(args: GetImagePolicyCommandInput, cb: (err: any, data?: GetImagePolicyCommandOutput) => void): void;
268
197
  getImagePolicy(args: GetImagePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImagePolicyCommandOutput) => void): void;
269
198
  /**
270
- * @public
271
- * <p>Gets an image recipe.</p>
199
+ * @see {@link GetImageRecipeCommand}
272
200
  */
273
201
  getImageRecipe(args: GetImageRecipeCommandInput, options?: __HttpHandlerOptions): Promise<GetImageRecipeCommandOutput>;
274
202
  getImageRecipe(args: GetImageRecipeCommandInput, cb: (err: any, data?: GetImageRecipeCommandOutput) => void): void;
275
203
  getImageRecipe(args: GetImageRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImageRecipeCommandOutput) => void): void;
276
204
  /**
277
- * @public
278
- * <p>Gets an image recipe policy.</p>
205
+ * @see {@link GetImageRecipePolicyCommand}
279
206
  */
280
207
  getImageRecipePolicy(args: GetImageRecipePolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetImageRecipePolicyCommandOutput>;
281
208
  getImageRecipePolicy(args: GetImageRecipePolicyCommandInput, cb: (err: any, data?: GetImageRecipePolicyCommandOutput) => void): void;
282
209
  getImageRecipePolicy(args: GetImageRecipePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImageRecipePolicyCommandOutput) => void): void;
283
210
  /**
284
- * @public
285
- * <p>Gets an infrastructure configuration.</p>
211
+ * @see {@link GetInfrastructureConfigurationCommand}
286
212
  */
287
213
  getInfrastructureConfiguration(args: GetInfrastructureConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetInfrastructureConfigurationCommandOutput>;
288
214
  getInfrastructureConfiguration(args: GetInfrastructureConfigurationCommandInput, cb: (err: any, data?: GetInfrastructureConfigurationCommandOutput) => void): void;
289
215
  getInfrastructureConfiguration(args: GetInfrastructureConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInfrastructureConfigurationCommandOutput) => void): void;
290
216
  /**
291
- * @public
292
- * <p>Get the runtime information that was logged for a specific runtime instance
293
- * of the workflow.</p>
217
+ * @see {@link GetWorkflowExecutionCommand}
294
218
  */
295
219
  getWorkflowExecution(args: GetWorkflowExecutionCommandInput, options?: __HttpHandlerOptions): Promise<GetWorkflowExecutionCommandOutput>;
296
220
  getWorkflowExecution(args: GetWorkflowExecutionCommandInput, cb: (err: any, data?: GetWorkflowExecutionCommandOutput) => void): void;
297
221
  getWorkflowExecution(args: GetWorkflowExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowExecutionCommandOutput) => void): void;
298
222
  /**
299
- * @public
300
- * <p>Get the runtime information that was logged for a specific runtime instance of
301
- * the workflow step.</p>
223
+ * @see {@link GetWorkflowStepExecutionCommand}
302
224
  */
303
225
  getWorkflowStepExecution(args: GetWorkflowStepExecutionCommandInput, options?: __HttpHandlerOptions): Promise<GetWorkflowStepExecutionCommandOutput>;
304
226
  getWorkflowStepExecution(args: GetWorkflowStepExecutionCommandInput, cb: (err: any, data?: GetWorkflowStepExecutionCommandOutput) => void): void;
305
227
  getWorkflowStepExecution(args: GetWorkflowStepExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowStepExecutionCommandOutput) => void): void;
306
228
  /**
307
- * @public
308
- * <p>Imports a component and transforms its data into a component document.</p>
229
+ * @see {@link ImportComponentCommand}
309
230
  */
310
231
  importComponent(args: ImportComponentCommandInput, options?: __HttpHandlerOptions): Promise<ImportComponentCommandOutput>;
311
232
  importComponent(args: ImportComponentCommandInput, cb: (err: any, data?: ImportComponentCommandOutput) => void): void;
312
233
  importComponent(args: ImportComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportComponentCommandOutput) => void): void;
313
234
  /**
314
- * @public
315
- * <p>When you export your virtual machine (VM) from its virtualization environment, that
316
- * process creates a set of one or more disk container files that act as snapshots of your
317
- * VM’s environment, settings, and data. The Amazon EC2 API <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportImage.html">ImportImage</a>
318
- * action uses those files to import your VM and create an AMI. To import using the CLI
319
- * command, see <a href="https://docs.aws.amazon.com/cli/latest/reference/ec2/import-image.html">import-image</a>
320
- * </p>
321
- * <p>You can reference the task ID from the VM import to pull in the AMI that the import
322
- * created as the base image for your Image Builder recipe.</p>
235
+ * @see {@link ImportVmImageCommand}
323
236
  */
324
237
  importVmImage(args: ImportVmImageCommandInput, options?: __HttpHandlerOptions): Promise<ImportVmImageCommandOutput>;
325
238
  importVmImage(args: ImportVmImageCommandInput, cb: (err: any, data?: ImportVmImageCommandOutput) => void): void;
326
239
  importVmImage(args: ImportVmImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportVmImageCommandOutput) => void): void;
327
240
  /**
328
- * @public
329
- * <p>Returns the list of component build versions for the specified semantic
330
- * version.</p>
331
- * <note>
332
- * <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
333
- * You can assign values for the first three, and can filter on all of them.</p>
334
- * <p>
335
- * <b>Filtering:</b> With semantic versioning, you have the flexibility to use wildcards (x)
336
- * to specify the most recent versions or nodes when selecting the base image or components for your
337
- * recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be
338
- * wildcards.</p>
339
- * </note>
241
+ * @see {@link ListComponentBuildVersionsCommand}
340
242
  */
341
243
  listComponentBuildVersions(args: ListComponentBuildVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListComponentBuildVersionsCommandOutput>;
342
244
  listComponentBuildVersions(args: ListComponentBuildVersionsCommandInput, cb: (err: any, data?: ListComponentBuildVersionsCommandOutput) => void): void;
343
245
  listComponentBuildVersions(args: ListComponentBuildVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentBuildVersionsCommandOutput) => void): void;
344
246
  /**
345
- * @public
346
- * <p>Returns the list of components that can be filtered by name, or by using the listed
347
- * <code>filters</code> to streamline results. Newly created components can take up to
348
- * two minutes to appear in the ListComponents API Results.</p>
349
- * <note>
350
- * <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
351
- * You can assign values for the first three, and can filter on all of them.</p>
352
- * <p>
353
- * <b>Filtering:</b> With semantic versioning, you have the flexibility to use wildcards (x)
354
- * to specify the most recent versions or nodes when selecting the base image or components for your
355
- * recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be
356
- * wildcards.</p>
357
- * </note>
247
+ * @see {@link ListComponentsCommand}
358
248
  */
359
249
  listComponents(args: ListComponentsCommandInput, options?: __HttpHandlerOptions): Promise<ListComponentsCommandOutput>;
360
250
  listComponents(args: ListComponentsCommandInput, cb: (err: any, data?: ListComponentsCommandOutput) => void): void;
361
251
  listComponents(args: ListComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentsCommandOutput) => void): void;
362
252
  /**
363
- * @public
364
- * <p>Returns a list of container recipes.</p>
253
+ * @see {@link ListContainerRecipesCommand}
365
254
  */
366
255
  listContainerRecipes(args: ListContainerRecipesCommandInput, options?: __HttpHandlerOptions): Promise<ListContainerRecipesCommandOutput>;
367
256
  listContainerRecipes(args: ListContainerRecipesCommandInput, cb: (err: any, data?: ListContainerRecipesCommandOutput) => void): void;
368
257
  listContainerRecipes(args: ListContainerRecipesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContainerRecipesCommandOutput) => void): void;
369
258
  /**
370
- * @public
371
- * <p>Returns a list of distribution configurations.</p>
259
+ * @see {@link ListDistributionConfigurationsCommand}
372
260
  */
373
261
  listDistributionConfigurations(args: ListDistributionConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<ListDistributionConfigurationsCommandOutput>;
374
262
  listDistributionConfigurations(args: ListDistributionConfigurationsCommandInput, cb: (err: any, data?: ListDistributionConfigurationsCommandOutput) => void): void;
375
263
  listDistributionConfigurations(args: ListDistributionConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDistributionConfigurationsCommandOutput) => void): void;
376
264
  /**
377
- * @public
378
- * <p>Returns a list of image build versions.</p>
265
+ * @see {@link ListImageBuildVersionsCommand}
379
266
  */
380
267
  listImageBuildVersions(args: ListImageBuildVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListImageBuildVersionsCommandOutput>;
381
268
  listImageBuildVersions(args: ListImageBuildVersionsCommandInput, cb: (err: any, data?: ListImageBuildVersionsCommandOutput) => void): void;
382
269
  listImageBuildVersions(args: ListImageBuildVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImageBuildVersionsCommandOutput) => void): void;
383
270
  /**
384
- * @public
385
- * <p>List the Packages that are associated with an Image Build Version, as determined by
386
- * Amazon Web Services Systems Manager Inventory at build time.</p>
271
+ * @see {@link ListImagePackagesCommand}
387
272
  */
388
273
  listImagePackages(args: ListImagePackagesCommandInput, options?: __HttpHandlerOptions): Promise<ListImagePackagesCommandOutput>;
389
274
  listImagePackages(args: ListImagePackagesCommandInput, cb: (err: any, data?: ListImagePackagesCommandOutput) => void): void;
390
275
  listImagePackages(args: ListImagePackagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImagePackagesCommandOutput) => void): void;
391
276
  /**
392
- * @public
393
- * <p>Returns a list of images created by the specified pipeline.</p>
277
+ * @see {@link ListImagePipelineImagesCommand}
394
278
  */
395
279
  listImagePipelineImages(args: ListImagePipelineImagesCommandInput, options?: __HttpHandlerOptions): Promise<ListImagePipelineImagesCommandOutput>;
396
280
  listImagePipelineImages(args: ListImagePipelineImagesCommandInput, cb: (err: any, data?: ListImagePipelineImagesCommandOutput) => void): void;
397
281
  listImagePipelineImages(args: ListImagePipelineImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImagePipelineImagesCommandOutput) => void): void;
398
282
  /**
399
- * @public
400
- * <p>Returns a list of image pipelines.</p>
283
+ * @see {@link ListImagePipelinesCommand}
401
284
  */
402
285
  listImagePipelines(args: ListImagePipelinesCommandInput, options?: __HttpHandlerOptions): Promise<ListImagePipelinesCommandOutput>;
403
286
  listImagePipelines(args: ListImagePipelinesCommandInput, cb: (err: any, data?: ListImagePipelinesCommandOutput) => void): void;
404
287
  listImagePipelines(args: ListImagePipelinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImagePipelinesCommandOutput) => void): void;
405
288
  /**
406
- * @public
407
- * <p>Returns a list of image recipes.</p>
289
+ * @see {@link ListImageRecipesCommand}
408
290
  */
409
291
  listImageRecipes(args: ListImageRecipesCommandInput, options?: __HttpHandlerOptions): Promise<ListImageRecipesCommandOutput>;
410
292
  listImageRecipes(args: ListImageRecipesCommandInput, cb: (err: any, data?: ListImageRecipesCommandOutput) => void): void;
411
293
  listImageRecipes(args: ListImageRecipesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImageRecipesCommandOutput) => void): void;
412
294
  /**
413
- * @public
414
- * <p>Returns the list of images that you have access to. Newly created images can take up
415
- * to two minutes to appear in the ListImages API Results.</p>
295
+ * @see {@link ListImagesCommand}
416
296
  */
417
297
  listImages(args: ListImagesCommandInput, options?: __HttpHandlerOptions): Promise<ListImagesCommandOutput>;
418
298
  listImages(args: ListImagesCommandInput, cb: (err: any, data?: ListImagesCommandOutput) => void): void;
419
299
  listImages(args: ListImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImagesCommandOutput) => void): void;
420
300
  /**
421
- * @public
422
- * <p>Returns a list of image scan aggregations for your account. You can filter by the type
423
- * of key that Image Builder uses to group results. For example, if you want to get a list of
424
- * findings by severity level for one of your pipelines, you might specify your pipeline
425
- * with the <code>imagePipelineArn</code> filter. If you don't specify a filter, Image Builder
426
- * returns an aggregation for your account.</p>
427
- * <p>To streamline results, you can use the following filters in your request:</p>
428
- * <ul>
429
- * <li>
430
- * <p>
431
- * <code>accountId</code>
432
- * </p>
433
- * </li>
434
- * <li>
435
- * <p>
436
- * <code>imageBuildVersionArn</code>
437
- * </p>
438
- * </li>
439
- * <li>
440
- * <p>
441
- * <code>imagePipelineArn</code>
442
- * </p>
443
- * </li>
444
- * <li>
445
- * <p>
446
- * <code>vulnerabilityId</code>
447
- * </p>
448
- * </li>
449
- * </ul>
301
+ * @see {@link ListImageScanFindingAggregationsCommand}
450
302
  */
451
303
  listImageScanFindingAggregations(args: ListImageScanFindingAggregationsCommandInput, options?: __HttpHandlerOptions): Promise<ListImageScanFindingAggregationsCommandOutput>;
452
304
  listImageScanFindingAggregations(args: ListImageScanFindingAggregationsCommandInput, cb: (err: any, data?: ListImageScanFindingAggregationsCommandOutput) => void): void;
453
305
  listImageScanFindingAggregations(args: ListImageScanFindingAggregationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImageScanFindingAggregationsCommandOutput) => void): void;
454
306
  /**
455
- * @public
456
- * <p>Returns a list of image scan findings for your account.</p>
307
+ * @see {@link ListImageScanFindingsCommand}
457
308
  */
458
309
  listImageScanFindings(args: ListImageScanFindingsCommandInput, options?: __HttpHandlerOptions): Promise<ListImageScanFindingsCommandOutput>;
459
310
  listImageScanFindings(args: ListImageScanFindingsCommandInput, cb: (err: any, data?: ListImageScanFindingsCommandOutput) => void): void;
460
311
  listImageScanFindings(args: ListImageScanFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImageScanFindingsCommandOutput) => void): void;
461
312
  /**
462
- * @public
463
- * <p>Returns a list of infrastructure configurations.</p>
313
+ * @see {@link ListInfrastructureConfigurationsCommand}
464
314
  */
465
315
  listInfrastructureConfigurations(args: ListInfrastructureConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<ListInfrastructureConfigurationsCommandOutput>;
466
316
  listInfrastructureConfigurations(args: ListInfrastructureConfigurationsCommandInput, cb: (err: any, data?: ListInfrastructureConfigurationsCommandOutput) => void): void;
467
317
  listInfrastructureConfigurations(args: ListInfrastructureConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInfrastructureConfigurationsCommandOutput) => void): void;
468
318
  /**
469
- * @public
470
- * <p>Returns the list of tags for the specified resource.</p>
319
+ * @see {@link ListTagsForResourceCommand}
471
320
  */
472
321
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
473
322
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
474
323
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
475
324
  /**
476
- * @public
477
- * <p>Returns a list of workflow runtime instance metadata objects for a specific image build
478
- * version.</p>
325
+ * @see {@link ListWorkflowExecutionsCommand}
479
326
  */
480
327
  listWorkflowExecutions(args: ListWorkflowExecutionsCommandInput, options?: __HttpHandlerOptions): Promise<ListWorkflowExecutionsCommandOutput>;
481
328
  listWorkflowExecutions(args: ListWorkflowExecutionsCommandInput, cb: (err: any, data?: ListWorkflowExecutionsCommandOutput) => void): void;
482
329
  listWorkflowExecutions(args: ListWorkflowExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkflowExecutionsCommandOutput) => void): void;
483
330
  /**
484
- * @public
485
- * <p>Shows runtime data for each step in a runtime instance of the workflow
486
- * that you specify in the request.</p>
331
+ * @see {@link ListWorkflowStepExecutionsCommand}
487
332
  */
488
333
  listWorkflowStepExecutions(args: ListWorkflowStepExecutionsCommandInput, options?: __HttpHandlerOptions): Promise<ListWorkflowStepExecutionsCommandOutput>;
489
334
  listWorkflowStepExecutions(args: ListWorkflowStepExecutionsCommandInput, cb: (err: any, data?: ListWorkflowStepExecutionsCommandOutput) => void): void;
490
335
  listWorkflowStepExecutions(args: ListWorkflowStepExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkflowStepExecutionsCommandOutput) => void): void;
491
336
  /**
492
- * @public
493
- * <p>Applies a policy to a component. We recommend that you call the RAM API <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html">CreateResourceShare</a> to share resources. If you call the Image Builder API
494
- * <code>PutComponentPolicy</code>, you must also call the RAM API <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html">PromoteResourceShareCreatedFromPolicy</a> in order for the resource to be
495
- * visible to all principals with whom the resource is shared.</p>
337
+ * @see {@link PutComponentPolicyCommand}
496
338
  */
497
339
  putComponentPolicy(args: PutComponentPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutComponentPolicyCommandOutput>;
498
340
  putComponentPolicy(args: PutComponentPolicyCommandInput, cb: (err: any, data?: PutComponentPolicyCommandOutput) => void): void;
499
341
  putComponentPolicy(args: PutComponentPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutComponentPolicyCommandOutput) => void): void;
500
342
  /**
501
- * @public
502
- * <p>Applies a policy to a container image. We recommend that you call the RAM API
503
- * CreateResourceShare
504
- * (https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html) to share
505
- * resources. If you call the Image Builder API <code>PutContainerImagePolicy</code>, you must also
506
- * call the RAM API PromoteResourceShareCreatedFromPolicy
507
- * (https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html)
508
- * in order for the resource to be visible to all principals with whom the resource is
509
- * shared.</p>
343
+ * @see {@link PutContainerRecipePolicyCommand}
510
344
  */
511
345
  putContainerRecipePolicy(args: PutContainerRecipePolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutContainerRecipePolicyCommandOutput>;
512
346
  putContainerRecipePolicy(args: PutContainerRecipePolicyCommandInput, cb: (err: any, data?: PutContainerRecipePolicyCommandOutput) => void): void;
513
347
  putContainerRecipePolicy(args: PutContainerRecipePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutContainerRecipePolicyCommandOutput) => void): void;
514
348
  /**
515
- * @public
516
- * <p>Applies a policy to an image. We recommend that you call the RAM API <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html">CreateResourceShare</a> to share resources. If you call the Image Builder API
517
- * <code>PutImagePolicy</code>, you must also call the RAM API <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html">PromoteResourceShareCreatedFromPolicy</a> in order for the resource to be
518
- * visible to all principals with whom the resource is shared.</p>
349
+ * @see {@link PutImagePolicyCommand}
519
350
  */
520
351
  putImagePolicy(args: PutImagePolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutImagePolicyCommandOutput>;
521
352
  putImagePolicy(args: PutImagePolicyCommandInput, cb: (err: any, data?: PutImagePolicyCommandOutput) => void): void;
522
353
  putImagePolicy(args: PutImagePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutImagePolicyCommandOutput) => void): void;
523
354
  /**
524
- * @public
525
- * <p>Applies a policy to an image recipe. We recommend that you call the RAM API <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html">CreateResourceShare</a> to share resources. If you call the Image Builder API
526
- * <code>PutImageRecipePolicy</code>, you must also call the RAM API <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html">PromoteResourceShareCreatedFromPolicy</a> in order for the resource to be
527
- * visible to all principals with whom the resource is shared.</p>
355
+ * @see {@link PutImageRecipePolicyCommand}
528
356
  */
529
357
  putImageRecipePolicy(args: PutImageRecipePolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutImageRecipePolicyCommandOutput>;
530
358
  putImageRecipePolicy(args: PutImageRecipePolicyCommandInput, cb: (err: any, data?: PutImageRecipePolicyCommandOutput) => void): void;
531
359
  putImageRecipePolicy(args: PutImageRecipePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutImageRecipePolicyCommandOutput) => void): void;
532
360
  /**
533
- * @public
534
- * <p>Manually triggers a pipeline to create an image.</p>
361
+ * @see {@link StartImagePipelineExecutionCommand}
535
362
  */
536
363
  startImagePipelineExecution(args: StartImagePipelineExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StartImagePipelineExecutionCommandOutput>;
537
364
  startImagePipelineExecution(args: StartImagePipelineExecutionCommandInput, cb: (err: any, data?: StartImagePipelineExecutionCommandOutput) => void): void;
538
365
  startImagePipelineExecution(args: StartImagePipelineExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartImagePipelineExecutionCommandOutput) => void): void;
539
366
  /**
540
- * @public
541
- * <p>Adds a tag to a resource.</p>
367
+ * @see {@link TagResourceCommand}
542
368
  */
543
369
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
544
370
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
545
371
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
546
372
  /**
547
- * @public
548
- * <p>Removes a tag from a resource.</p>
373
+ * @see {@link UntagResourceCommand}
549
374
  */
550
375
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
551
376
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
552
377
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
553
378
  /**
554
- * @public
555
- * <p>Updates a new distribution configuration. Distribution configurations define and
556
- * configure the outputs of your pipeline.</p>
379
+ * @see {@link UpdateDistributionConfigurationCommand}
557
380
  */
558
381
  updateDistributionConfiguration(args: UpdateDistributionConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDistributionConfigurationCommandOutput>;
559
382
  updateDistributionConfiguration(args: UpdateDistributionConfigurationCommandInput, cb: (err: any, data?: UpdateDistributionConfigurationCommandOutput) => void): void;
560
383
  updateDistributionConfiguration(args: UpdateDistributionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDistributionConfigurationCommandOutput) => void): void;
561
384
  /**
562
- * @public
563
- * <p>Updates an image pipeline. Image pipelines enable you to automate the creation and
564
- * distribution of images.</p>
565
- * <note>
566
- * <p>UpdateImagePipeline does not support selective updates for the pipeline. You must
567
- * specify all of the required properties in the update request, not just the
568
- * properties that have changed.</p>
569
- * </note>
385
+ * @see {@link UpdateImagePipelineCommand}
570
386
  */
571
387
  updateImagePipeline(args: UpdateImagePipelineCommandInput, options?: __HttpHandlerOptions): Promise<UpdateImagePipelineCommandOutput>;
572
388
  updateImagePipeline(args: UpdateImagePipelineCommandInput, cb: (err: any, data?: UpdateImagePipelineCommandOutput) => void): void;
573
389
  updateImagePipeline(args: UpdateImagePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateImagePipelineCommandOutput) => void): void;
574
390
  /**
575
- * @public
576
- * <p>Updates a new infrastructure configuration. An infrastructure configuration defines
577
- * the environment in which your image will be built and tested.</p>
391
+ * @see {@link UpdateInfrastructureConfigurationCommand}
578
392
  */
579
393
  updateInfrastructureConfiguration(args: UpdateInfrastructureConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateInfrastructureConfigurationCommandOutput>;
580
394
  updateInfrastructureConfiguration(args: UpdateInfrastructureConfigurationCommandInput, cb: (err: any, data?: UpdateInfrastructureConfigurationCommandOutput) => void): void;
581
395
  updateInfrastructureConfiguration(args: UpdateInfrastructureConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInfrastructureConfigurationCommandOutput) => void): void;
582
396
  }
397
+ /**
398
+ * @public
399
+ * <p>EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the
400
+ * creation, management, and deployment of customized, secure, and up-to-date
401
+ * "golden" server images that are pre-installed and pre-configured with software
402
+ * and settings to meet specific IT standards.</p>
403
+ */
404
+ export declare class Imagebuilder extends ImagebuilderClient implements Imagebuilder {
405
+ }
@@ -224,7 +224,7 @@ import {
224
224
  UpdateInfrastructureConfigurationCommandOutput,
225
225
  } from "./commands/UpdateInfrastructureConfigurationCommand";
226
226
  import { ImagebuilderClient } from "./ImagebuilderClient";
227
- export declare class Imagebuilder extends ImagebuilderClient {
227
+ export interface Imagebuilder {
228
228
  cancelImageCreation(
229
229
  args: CancelImageCreationCommandInput,
230
230
  options?: __HttpHandlerOptions
@@ -972,3 +972,6 @@ export declare class Imagebuilder extends ImagebuilderClient {
972
972
  ) => void
973
973
  ): void;
974
974
  }
975
+ export declare class Imagebuilder
976
+ extends ImagebuilderClient
977
+ implements Imagebuilder {}