@aws-sdk/client-imagebuilder 3.896.0 → 3.899.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/dist-cjs/index.js +10 -1
  2. package/dist-es/protocols/Aws_restJson1.js +9 -0
  3. package/dist-types/commands/CreateImageCommand.d.ts +3 -0
  4. package/dist-types/commands/CreateImagePipelineCommand.d.ts +7 -0
  5. package/dist-types/commands/CreateImageRecipeCommand.d.ts +3 -0
  6. package/dist-types/commands/GetImageCommand.d.ts +7 -3
  7. package/dist-types/commands/GetImagePipelineCommand.d.ts +9 -0
  8. package/dist-types/commands/GetImageRecipeCommand.d.ts +3 -0
  9. package/dist-types/commands/ImportDiskImageCommand.d.ts +3 -0
  10. package/dist-types/commands/ImportVmImageCommand.d.ts +3 -0
  11. package/dist-types/commands/ListContainerRecipesCommand.d.ts +1 -0
  12. package/dist-types/commands/ListImageBuildVersionsCommand.d.ts +3 -0
  13. package/dist-types/commands/ListImagePipelineImagesCommand.d.ts +3 -0
  14. package/dist-types/commands/ListImagePipelinesCommand.d.ts +9 -0
  15. package/dist-types/commands/StartImagePipelineExecutionCommand.d.ts +3 -0
  16. package/dist-types/commands/UpdateImagePipelineCommand.d.ts +7 -0
  17. package/dist-types/commands/UpdateInfrastructureConfigurationCommand.d.ts +1 -1
  18. package/dist-types/commands/UpdateLifecyclePolicyCommand.d.ts +1 -2
  19. package/dist-types/models/models_0.d.ts +207 -217
  20. package/dist-types/models/models_1.d.ts +180 -0
  21. package/dist-types/ts3.4/commands/UpdateInfrastructureConfigurationCommand.d.ts +1 -1
  22. package/dist-types/ts3.4/commands/UpdateLifecyclePolicyCommand.d.ts +4 -2
  23. package/dist-types/ts3.4/models/models_0.d.ts +25 -31
  24. package/dist-types/ts3.4/models/models_1.d.ts +40 -0
  25. package/package.json +11 -11
@@ -56,7 +56,8 @@ export interface SystemsManagerAgent {
56
56
  * <p>Controls whether the Systems Manager agent is removed from your final build image, prior to
57
57
  * creating the new AMI. If this is set to true, then the agent is removed from the final
58
58
  * image. If it's set to false, then the agent is left in, so that it is included in the
59
- * new AMI. The default value is false.</p>
59
+ * new AMI. default value is false.</p>
60
+ * <p>The default behavior of uninstallAfterBuild is to remove the SSM Agent if it was installed by EC2 Image Builder</p>
60
61
  * @public
61
62
  */
62
63
  uninstallAfterBuild?: boolean | undefined;
@@ -236,7 +237,9 @@ export interface AmiDistributionConfiguration {
236
237
  */
237
238
  amiTags?: Record<string, string> | undefined;
238
239
  /**
239
- * <p>The KMS key identifier used to encrypt the distributed image.</p>
240
+ * <p>The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt the distributed image.
241
+ * This can be either the Key ARN or the Alias ARN. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">Key identifiers (KeyId)</a>
242
+ * in the <i>Key Management Service Developer Guide</i>.</p>
240
243
  * @public
241
244
  */
242
245
  kmsKeyId?: string | undefined;
@@ -247,6 +250,18 @@ export interface AmiDistributionConfiguration {
247
250
  */
248
251
  launchPermission?: LaunchPermissionConfiguration | undefined;
249
252
  }
253
+ /**
254
+ * <p>Defines the rules by which an image pipeline is automatically disabled when it fails.</p>
255
+ * @public
256
+ */
257
+ export interface AutoDisablePolicy {
258
+ /**
259
+ * <p>The number of consecutive scheduled image pipeline executions that must fail before Image Builder
260
+ * automatically disables the pipeline.</p>
261
+ * @public
262
+ */
263
+ failureCount: number | undefined;
264
+ }
250
265
  /**
251
266
  * @public
252
267
  * @enum
@@ -610,7 +625,8 @@ export interface Component {
610
625
  */
611
626
  data?: string | undefined;
612
627
  /**
613
- * <p>The KMS key identifier used to encrypt the component.</p>
628
+ * <p>The KMS key identifier used to encrypt the component. This can be either the Key ARN or the Alias ARN. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">Key identifiers (KeyId)</a>
629
+ * in the <i>Key Management Service Developer Guide</i>.</p>
614
630
  * @public
615
631
  */
616
632
  kmsKeyId?: string | undefined;
@@ -986,7 +1002,9 @@ export interface EbsInstanceBlockDeviceSpecification {
986
1002
  */
987
1003
  iops?: number | undefined;
988
1004
  /**
989
- * <p>Use to configure the KMS key to use when encrypting the device.</p>
1005
+ * <p>The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device.
1006
+ * This can be either the Key ARN or the Alias ARN. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">Key identifiers (KeyId)</a>
1007
+ * in the <i>Key Management Service Developer Guide</i>.</p>
990
1008
  * @public
991
1009
  */
992
1010
  kmsKeyId?: string | undefined;
@@ -1155,8 +1173,9 @@ export interface ContainerRecipe {
1155
1173
  */
1156
1174
  dockerfileTemplateData?: string | undefined;
1157
1175
  /**
1158
- * <p>Identifies which KMS key is used to encrypt the container image for distribution to
1159
- * the target Region.</p>
1176
+ * <p>The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the container image
1177
+ * for distribution to the target Region. This can be either the Key ARN or the Alias ARN. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">Key identifiers (KeyId)</a>
1178
+ * in the <i>Key Management Service Developer Guide</i>.</p>
1160
1179
  * @public
1161
1180
  */
1162
1181
  kmsKeyId?: string | undefined;
@@ -1233,6 +1252,14 @@ export interface ContainerRecipeSummary {
1233
1252
  * @public
1234
1253
  */
1235
1254
  dateCreated?: string | undefined;
1255
+ /**
1256
+ * <p>The base image for a container build and test instance. This can contain an AMI ID
1257
+ * or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by <code>ssm:</code>,
1258
+ * followed by the parameter name or ARN.</p>
1259
+ * <p>If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.</p>
1260
+ * @public
1261
+ */
1262
+ instanceImage?: string | undefined;
1236
1263
  /**
1237
1264
  * <p>Tags that are attached to the container recipe.</p>
1238
1265
  * @public
@@ -1308,7 +1335,8 @@ export interface CreateComponentRequest {
1308
1335
  */
1309
1336
  uri?: string | undefined;
1310
1337
  /**
1311
- * <p>The ID of the KMS key that is used to encrypt this component.</p>
1338
+ * <p>The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component. This can be either the Key ARN or the Alias ARN. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">Key identifiers (KeyId)</a>
1339
+ * in the <i>Key Management Service Developer Guide</i>.</p>
1312
1340
  * @public
1313
1341
  */
1314
1342
  kmsKeyId?: string | undefined;
@@ -1476,7 +1504,9 @@ export interface CreateContainerRecipeRequest {
1476
1504
  */
1477
1505
  targetRepository: TargetContainerRepository | undefined;
1478
1506
  /**
1479
- * <p>Identifies which KMS key is used to encrypt the Dockerfile template.</p>
1507
+ * <p>The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the Dockerfile
1508
+ * template. This can be either the Key ARN or the Alias ARN. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">Key identifiers (KeyId)</a>
1509
+ * in the <i>Key Management Service Developer Guide</i>.</p>
1480
1510
  * @public
1481
1511
  */
1482
1512
  kmsKeyId?: string | undefined;
@@ -1882,6 +1912,19 @@ export interface ImageTestsConfiguration {
1882
1912
  */
1883
1913
  timeoutMinutes?: number | undefined;
1884
1914
  }
1915
+ /**
1916
+ * <p>The logging configuration that's defined for the image. Image Builder uses the defined settings
1917
+ * to direct execution log output during image creation.</p>
1918
+ * @public
1919
+ */
1920
+ export interface ImageLoggingConfiguration {
1921
+ /**
1922
+ * <p>The log group name that Image Builder uses for image creation. If not specified, the log group
1923
+ * name defaults to <code>/aws/imagebuilder/image-name</code>.</p>
1924
+ * @public
1925
+ */
1926
+ logGroupName?: string | undefined;
1927
+ }
1885
1928
  /**
1886
1929
  * @public
1887
1930
  * @enum
@@ -2011,6 +2054,11 @@ export interface CreateImageRequest {
2011
2054
  * @public
2012
2055
  */
2013
2056
  executionRole?: string | undefined;
2057
+ /**
2058
+ * <p>Define logging configuration for the image build process.</p>
2059
+ * @public
2060
+ */
2061
+ loggingConfiguration?: ImageLoggingConfiguration | undefined;
2014
2062
  }
2015
2063
  /**
2016
2064
  * @public
@@ -2032,6 +2080,25 @@ export interface CreateImageResponse {
2032
2080
  */
2033
2081
  imageBuildVersionArn?: string | undefined;
2034
2082
  }
2083
+ /**
2084
+ * <p>The logging configuration that's defined for pipeline execution.</p>
2085
+ * @public
2086
+ */
2087
+ export interface PipelineLoggingConfiguration {
2088
+ /**
2089
+ * <p>The log group name that Image Builder uses for image creation. If not specified, the log group
2090
+ * name defaults to <code>/aws/imagebuilder/image-name</code>.</p>
2091
+ * @public
2092
+ */
2093
+ imageLogGroupName?: string | undefined;
2094
+ /**
2095
+ * <p>The log group name that Image Builder uses for the log output during creation of a new pipeline.
2096
+ * If not specified, the pipeline log group name defaults to
2097
+ * <code>/aws/imagebuilder/pipeline/pipeline-name</code>.</p>
2098
+ * @public
2099
+ */
2100
+ pipelineLogGroupName?: string | undefined;
2101
+ }
2035
2102
  /**
2036
2103
  * @public
2037
2104
  * @enum
@@ -2088,6 +2155,12 @@ export interface Schedule {
2088
2155
  * @public
2089
2156
  */
2090
2157
  pipelineExecutionStartCondition?: PipelineExecutionStartCondition | undefined;
2158
+ /**
2159
+ * <p>The policy that configures when Image Builder should automatically disable a pipeline that
2160
+ * is failing.</p>
2161
+ * @public
2162
+ */
2163
+ autoDisablePolicy?: AutoDisablePolicy | undefined;
2091
2164
  }
2092
2165
  /**
2093
2166
  * @public
@@ -2189,6 +2262,11 @@ export interface CreateImagePipelineRequest {
2189
2262
  * @public
2190
2263
  */
2191
2264
  executionRole?: string | undefined;
2265
+ /**
2266
+ * <p>Define logging configuration for the image build process.</p>
2267
+ * @public
2268
+ */
2269
+ loggingConfiguration?: PipelineLoggingConfiguration | undefined;
2192
2270
  }
2193
2271
  /**
2194
2272
  * @public
@@ -2291,6 +2369,12 @@ export interface CreateImageRecipeRequest {
2291
2369
  * @public
2292
2370
  */
2293
2371
  additionalInstanceConfiguration?: AdditionalInstanceConfiguration | undefined;
2372
+ /**
2373
+ * <p>Tags that are applied to the AMI that Image Builder creates during the Build phase
2374
+ * prior to image distribution.</p>
2375
+ * @public
2376
+ */
2377
+ amiTags?: Record<string, string> | undefined;
2294
2378
  /**
2295
2379
  * <p>Unique, case-sensitive identifier you provide to ensure
2296
2380
  * idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>
@@ -2958,7 +3042,9 @@ export interface CreateWorkflowRequest {
2958
3042
  */
2959
3043
  uri?: string | undefined;
2960
3044
  /**
2961
- * <p>The ID of the KMS key that is used to encrypt this workflow resource.</p>
3045
+ * <p>The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this workflow resource.
3046
+ * This can be either the Key ARN or the Alias ARN. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">Key identifiers (KeyId)</a>
3047
+ * in the <i>Key Management Service Developer Guide</i>.</p>
2962
3048
  * @public
2963
3049
  */
2964
3050
  kmsKeyId?: string | undefined;
@@ -3676,6 +3762,12 @@ export interface ImageRecipe {
3676
3762
  * @public
3677
3763
  */
3678
3764
  additionalInstanceConfiguration?: AdditionalInstanceConfiguration | undefined;
3765
+ /**
3766
+ * <p>Tags that are applied to the AMI that Image Builder creates during the Build phase
3767
+ * prior to image distribution.</p>
3768
+ * @public
3769
+ */
3770
+ amiTags?: Record<string, string> | undefined;
3679
3771
  }
3680
3772
  /**
3681
3773
  * @public
@@ -3842,8 +3934,9 @@ export interface ImageScanState {
3842
3934
  reason?: string | undefined;
3843
3935
  }
3844
3936
  /**
3845
- * <p>An Image Builder image. You must specify exactly one recipe for the image either a
3846
- * container recipe (<code>containerRecipe</code>), which creates a container image, or an
3937
+ * <p>An Image Builder image resource that keeps track of all of the settings used to create, configure,
3938
+ * and distribute output for that image. You must specify exactly one recipe for the image
3939
+ * either a container recipe (<code>containerRecipe</code>), which creates a container image, or an
3847
3940
  * image recipe (<code>imageRecipe</code>), which creates an AMI.</p>
3848
3941
  * @public
3849
3942
  */
@@ -4039,6 +4132,12 @@ export interface Image {
4039
4132
  * @public
4040
4133
  */
4041
4134
  workflows?: WorkflowConfiguration[] | undefined;
4135
+ /**
4136
+ * <p>The logging configuration that's defined for the image. Image Builder uses the defined settings
4137
+ * to direct execution log output during image creation.</p>
4138
+ * @public
4139
+ */
4140
+ loggingConfiguration?: ImageLoggingConfiguration | undefined;
4042
4141
  }
4043
4142
  /**
4044
4143
  * @public
@@ -4151,6 +4250,13 @@ export interface ImagePipeline {
4151
4250
  * @public
4152
4251
  */
4153
4252
  dateLastRun?: string | undefined;
4253
+ /**
4254
+ * <p>The status of the last image that this pipeline built, such as
4255
+ * <code>BUILDING</code>, <code>TESTING</code>, <code>FAILED</code>,
4256
+ * or <code>AVAILABLE</code>.</p>
4257
+ * @public
4258
+ */
4259
+ lastRunStatus?: ImageStatus | undefined;
4154
4260
  /**
4155
4261
  * <p>The next date when the pipeline is scheduled to run.</p>
4156
4262
  * @public
@@ -4177,6 +4283,40 @@ export interface ImagePipeline {
4177
4283
  * @public
4178
4284
  */
4179
4285
  workflows?: WorkflowConfiguration[] | undefined;
4286
+ /**
4287
+ * <p>Defines logging configuration for the output image.</p>
4288
+ * @public
4289
+ */
4290
+ loggingConfiguration?: PipelineLoggingConfiguration | undefined;
4291
+ /**
4292
+ * <p>Image Builder tracks the number of consecutive failures for scheduled pipeline
4293
+ * executions and takes one of the following actions each time it runs on a schedule:</p>
4294
+ * <ul>
4295
+ * <li>
4296
+ * <p>If the pipeline execution is successful, the number of consecutive
4297
+ * failures resets to zero.</p>
4298
+ * </li>
4299
+ * <li>
4300
+ * <p>If the pipeline execution fails, Image Builder increments the number of
4301
+ * consecutive failures. If the failure count exceeds the limit defined in the
4302
+ * <code>AutoDisablePolicy</code>, Image Builder disables the pipeline.</p>
4303
+ * </li>
4304
+ * </ul>
4305
+ * <p>The consecutive failure count is also reset to zero under the following
4306
+ * conditions:</p>
4307
+ * <ul>
4308
+ * <li>
4309
+ * <p>The pipeline runs manually and succeeds.</p>
4310
+ * </li>
4311
+ * <li>
4312
+ * <p>The pipeline configuration is updated.</p>
4313
+ * </li>
4314
+ * </ul>
4315
+ * <p>If the pipeline runs manually and fails, the count remains the same. The next
4316
+ * scheduled run continues to increment where it left off before.</p>
4317
+ * @public
4318
+ */
4319
+ consecutiveFailures?: number | undefined;
4180
4320
  }
4181
4321
  /**
4182
4322
  * @public
@@ -4661,7 +4801,8 @@ export interface Workflow {
4661
4801
  */
4662
4802
  data?: string | undefined;
4663
4803
  /**
4664
- * <p>The KMS key identifier used to encrypt the workflow resource.</p>
4804
+ * <p>The KMS key identifier used to encrypt the workflow resource. This can be either the Key ARN or the Alias ARN. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">Key identifiers (KeyId)</a>
4805
+ * in the <i>Key Management Service Developer Guide</i>.</p>
4665
4806
  * @public
4666
4807
  */
4667
4808
  kmsKeyId?: string | undefined;
@@ -5026,7 +5167,8 @@ export interface ImportComponentRequest {
5026
5167
  */
5027
5168
  uri?: string | undefined;
5028
5169
  /**
5029
- * <p>The ID of the KMS key that should be used to encrypt this component.</p>
5170
+ * <p>The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component. This can be either the Key ARN or the Alias ARN. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">Key identifiers (KeyId)</a>
5171
+ * in the <i>Key Management Service Developer Guide</i>.</p>
5030
5172
  * @public
5031
5173
  */
5032
5174
  kmsKeyId?: string | undefined;
@@ -5112,6 +5254,11 @@ export interface ImportDiskImageRequest {
5112
5254
  * @public
5113
5255
  */
5114
5256
  uri: string | undefined;
5257
+ /**
5258
+ * <p>Define logging configuration for the image build process.</p>
5259
+ * @public
5260
+ */
5261
+ loggingConfiguration?: ImageLoggingConfiguration | undefined;
5115
5262
  /**
5116
5263
  * <p>Tags that are attached to image resources created from the import.</p>
5117
5264
  * @public
@@ -5189,6 +5336,11 @@ export interface ImportVmImageRequest {
5189
5336
  * @public
5190
5337
  */
5191
5338
  vmImportTaskId: string | undefined;
5339
+ /**
5340
+ * <p>Define logging configuration for the image build process.</p>
5341
+ * @public
5342
+ */
5343
+ loggingConfiguration?: ImageLoggingConfiguration | undefined;
5192
5344
  /**
5193
5345
  * <p>Tags that are attached to the import resources.</p>
5194
5346
  * @public
@@ -5246,7 +5398,7 @@ export interface ListComponentBuildVersionsRequest {
5246
5398
  */
5247
5399
  componentVersionArn?: string | undefined;
5248
5400
  /**
5249
- * <p>The maximum items to return in a request.</p>
5401
+ * <p>Specify the maximum number of items to return in a request.</p>
5250
5402
  * @public
5251
5403
  */
5252
5404
  maxResults?: number | undefined;
@@ -5349,7 +5501,7 @@ export interface ListComponentsRequest {
5349
5501
  */
5350
5502
  byName?: boolean | undefined;
5351
5503
  /**
5352
- * <p>The maximum items to return in a request.</p>
5504
+ * <p>Specify the maximum number of items to return in a request.</p>
5353
5505
  * @public
5354
5506
  */
5355
5507
  maxResults?: number | undefined;
@@ -5425,7 +5577,7 @@ export interface ListContainerRecipesRequest {
5425
5577
  */
5426
5578
  filters?: Filter[] | undefined;
5427
5579
  /**
5428
- * <p>The maximum items to return in a request.</p>
5580
+ * <p>Specify the maximum number of items to return in a request.</p>
5429
5581
  * @public
5430
5582
  */
5431
5583
  maxResults?: number | undefined;
@@ -5468,7 +5620,7 @@ export interface ListDistributionConfigurationsRequest {
5468
5620
  */
5469
5621
  filters?: Filter[] | undefined;
5470
5622
  /**
5471
- * <p>The maximum items to return in a request.</p>
5623
+ * <p>Specify the maximum number of items to return in a request.</p>
5472
5624
  * @public
5473
5625
  */
5474
5626
  maxResults?: number | undefined;
@@ -5544,7 +5696,7 @@ export interface ListImageBuildVersionsRequest {
5544
5696
  */
5545
5697
  filters?: Filter[] | undefined;
5546
5698
  /**
5547
- * <p>The maximum items to return in a request.</p>
5699
+ * <p>Specify the maximum number of items to return in a request.</p>
5548
5700
  * @public
5549
5701
  */
5550
5702
  maxResults?: number | undefined;
@@ -5659,6 +5811,11 @@ export interface ImageSummary {
5659
5811
  * @public
5660
5812
  */
5661
5813
  lifecycleExecutionId?: string | undefined;
5814
+ /**
5815
+ * <p>The logging configuration that's defined for the image.</p>
5816
+ * @public
5817
+ */
5818
+ loggingConfiguration?: ImageLoggingConfiguration | undefined;
5662
5819
  }
5663
5820
  /**
5664
5821
  * @public
@@ -5692,7 +5849,7 @@ export interface ListImagePackagesRequest {
5692
5849
  */
5693
5850
  imageBuildVersionArn: string | undefined;
5694
5851
  /**
5695
- * <p>The maximum items to return in a request.</p>
5852
+ * <p>Specify the maximum number of items to return in a request.</p>
5696
5853
  * @public
5697
5854
  */
5698
5855
  maxResults?: number | undefined;
@@ -5772,7 +5929,7 @@ export interface ListImagePipelineImagesRequest {
5772
5929
  */
5773
5930
  filters?: Filter[] | undefined;
5774
5931
  /**
5775
- * <p>The maximum items to return in a request.</p>
5932
+ * <p>Specify the maximum number of items to return in a request.</p>
5776
5933
  * @public
5777
5934
  */
5778
5935
  maxResults?: number | undefined;
@@ -5847,7 +6004,7 @@ export interface ListImagePipelinesRequest {
5847
6004
  */
5848
6005
  filters?: Filter[] | undefined;
5849
6006
  /**
5850
- * <p>The maximum items to return in a request.</p>
6007
+ * <p>Specify the maximum number of items to return in a request.</p>
5851
6008
  * @public
5852
6009
  */
5853
6010
  maxResults?: number | undefined;
@@ -5885,10 +6042,9 @@ export interface ListImagePipelinesResponse {
5885
6042
  */
5886
6043
  export interface ListImageRecipesRequest {
5887
6044
  /**
5888
- * <p>The owner defines which image recipes you want to list. By default, this request will
5889
- * only show image recipes owned by your account. You can use this field to specify if you
5890
- * want to view image recipes owned by yourself, by Amazon, or those image recipes that
5891
- * have been shared with you by other customers.</p>
6045
+ * <p>You can specify the recipe owner to filter results by that owner. By default, this request will
6046
+ * only show image recipes owned by your account. To filter by a different owner, specify one of the
6047
+ * <code>Valid Values</code> that are listed for this parameter.</p>
5892
6048
  * @public
5893
6049
  */
5894
6050
  owner?: Ownership | undefined;
@@ -5915,7 +6071,7 @@ export interface ListImageRecipesRequest {
5915
6071
  */
5916
6072
  filters?: Filter[] | undefined;
5917
6073
  /**
5918
- * <p>The maximum items to return in a request.</p>
6074
+ * <p>Specify the maximum number of items to return in a request.</p>
5919
6075
  * @public
5920
6076
  */
5921
6077
  maxResults?: number | undefined;
@@ -5977,7 +6133,8 @@ export interface ListImageRecipesResponse {
5977
6133
  */
5978
6134
  requestId?: string | undefined;
5979
6135
  /**
5980
- * <p>The list of image pipelines.</p>
6136
+ * <p>A list of <code>ImageRecipeSummary</code> objects that contain identifying characteristics for the
6137
+ * image recipe, such as the name, the Amazon Resource Name (ARN), and the date created, along with other key details.</p>
5981
6138
  * @public
5982
6139
  */
5983
6140
  imageRecipeSummaryList?: ImageRecipeSummary[] | undefined;
@@ -6039,7 +6196,7 @@ export interface ListImagesRequest {
6039
6196
  */
6040
6197
  byName?: boolean | undefined;
6041
6198
  /**
6042
- * <p>The maximum items to return in a request.</p>
6199
+ * <p>Specify the maximum number of items to return in a request.</p>
6043
6200
  * @public
6044
6201
  */
6045
6202
  maxResults?: number | undefined;
@@ -6381,7 +6538,7 @@ export interface ListImageScanFindingsRequest {
6381
6538
  */
6382
6539
  filters?: ImageScanFindingsFilter[] | undefined;
6383
6540
  /**
6384
- * <p>The maximum items to return in a request.</p>
6541
+ * <p>Specify the maximum number of items to return in a request.</p>
6385
6542
  * @public
6386
6543
  */
6387
6544
  maxResults?: number | undefined;
@@ -6664,7 +6821,7 @@ export interface ListInfrastructureConfigurationsRequest {
6664
6821
  */
6665
6822
  filters?: Filter[] | undefined;
6666
6823
  /**
6667
- * <p>The maximum items to return in a request.</p>
6824
+ * <p>Specify the maximum number of items to return in a request.</p>
6668
6825
  * @public
6669
6826
  */
6670
6827
  maxResults?: number | undefined;
@@ -6772,7 +6929,7 @@ export interface ListLifecycleExecutionResourcesRequest {
6772
6929
  */
6773
6930
  parentResourceId?: string | undefined;
6774
6931
  /**
6775
- * <p>The maximum items to return in a request.</p>
6932
+ * <p>Specify the maximum number of items to return in a request.</p>
6776
6933
  * @public
6777
6934
  */
6778
6935
  maxResults?: number | undefined;
@@ -6960,7 +7117,7 @@ export interface ListLifecycleExecutionResourcesResponse {
6960
7117
  */
6961
7118
  export interface ListLifecycleExecutionsRequest {
6962
7119
  /**
6963
- * <p>The maximum items to return in a request.</p>
7120
+ * <p>Specify the maximum number of items to return in a request.</p>
6964
7121
  * @public
6965
7122
  */
6966
7123
  maxResults?: number | undefined;
@@ -7004,7 +7161,7 @@ export interface ListLifecyclePoliciesRequest {
7004
7161
  */
7005
7162
  filters?: Filter[] | undefined;
7006
7163
  /**
7007
- * <p>The maximum items to return in a request.</p>
7164
+ * <p>Specify the maximum number of items to return in a request.</p>
7008
7165
  * @public
7009
7166
  */
7010
7167
  maxResults?: number | undefined;
@@ -7129,7 +7286,7 @@ export interface ListTagsForResourceResponse {
7129
7286
  */
7130
7287
  export interface ListWaitingWorkflowStepsRequest {
7131
7288
  /**
7132
- * <p>The maximum items to return in a request.</p>
7289
+ * <p>Specify the maximum number of items to return in a request.</p>
7133
7290
  * @public
7134
7291
  */
7135
7292
  maxResults?: number | undefined;
@@ -7212,7 +7369,7 @@ export interface ListWorkflowBuildVersionsRequest {
7212
7369
  */
7213
7370
  workflowVersionArn?: string | undefined;
7214
7371
  /**
7215
- * <p>The maximum items to return in a request.</p>
7372
+ * <p>Specify the maximum number of items to return in a request.</p>
7216
7373
  * @public
7217
7374
  */
7218
7375
  maxResults?: number | undefined;
@@ -7303,7 +7460,7 @@ export interface ListWorkflowBuildVersionsResponse {
7303
7460
  */
7304
7461
  export interface ListWorkflowExecutionsRequest {
7305
7462
  /**
7306
- * <p>The maximum items to return in a request.</p>
7463
+ * <p>Specify the maximum number of items to return in a request.</p>
7307
7464
  * @public
7308
7465
  */
7309
7466
  maxResults?: number | undefined;
@@ -7442,7 +7599,7 @@ export interface ListWorkflowsRequest {
7442
7599
  */
7443
7600
  byName?: boolean | undefined;
7444
7601
  /**
7445
- * <p>The maximum items to return in a request.</p>
7602
+ * <p>Specify the maximum number of items to return in a request.</p>
7446
7603
  * @public
7447
7604
  */
7448
7605
  maxResults?: number | undefined;
@@ -7517,7 +7674,7 @@ export interface ListWorkflowsResponse {
7517
7674
  */
7518
7675
  export interface ListWorkflowStepExecutionsRequest {
7519
7676
  /**
7520
- * <p>The maximum items to return in a request.</p>
7677
+ * <p>Specify the maximum number of items to return in a request.</p>
7521
7678
  * @public
7522
7679
  */
7523
7680
  maxResults?: number | undefined;
@@ -7863,6 +8020,12 @@ export interface StartImagePipelineExecutionRequest {
7863
8020
  * @public
7864
8021
  */
7865
8022
  clientToken?: string | undefined;
8023
+ /**
8024
+ * <p>Specify tags for Image Builder to apply to the image resource that's created
8025
+ * When it starts pipeline execution.</p>
8026
+ * @public
8027
+ */
8028
+ tags?: Record<string, string> | undefined;
7866
8029
  }
7867
8030
  /**
7868
8031
  * @public
@@ -8166,6 +8329,12 @@ export interface UpdateImagePipelineRequest {
8166
8329
  * @public
8167
8330
  */
8168
8331
  workflows?: WorkflowConfiguration[] | undefined;
8332
+ /**
8333
+ * <p>Update logging configuration for the output image that's created when
8334
+ * the pipeline runs.</p>
8335
+ * @public
8336
+ */
8337
+ loggingConfiguration?: PipelineLoggingConfiguration | undefined;
8169
8338
  /**
8170
8339
  * <p>The name or Amazon Resource Name (ARN) for the IAM role you create that grants
8171
8340
  * Image Builder access to perform workflow actions.</p>
@@ -8194,182 +8363,3 @@ export interface UpdateImagePipelineResponse {
8194
8363
  */
8195
8364
  imagePipelineArn?: string | undefined;
8196
8365
  }
8197
- /**
8198
- * @public
8199
- */
8200
- export interface UpdateInfrastructureConfigurationRequest {
8201
- /**
8202
- * <p>The Amazon Resource Name (ARN) of the infrastructure configuration that you want to
8203
- * update.</p>
8204
- * @public
8205
- */
8206
- infrastructureConfigurationArn: string | undefined;
8207
- /**
8208
- * <p>The description of the infrastructure configuration.</p>
8209
- * @public
8210
- */
8211
- description?: string | undefined;
8212
- /**
8213
- * <p>The instance types of the infrastructure configuration. You can specify one or more
8214
- * instance types to use for this build. The service will pick one of these instance types
8215
- * based on availability.</p>
8216
- * @public
8217
- */
8218
- instanceTypes?: string[] | undefined;
8219
- /**
8220
- * <p>The instance profile to associate with the instance used to customize your Amazon EC2
8221
- * AMI.</p>
8222
- * @public
8223
- */
8224
- instanceProfileName: string | undefined;
8225
- /**
8226
- * <p>The security group IDs to associate with the instance used to customize your Amazon EC2
8227
- * AMI.</p>
8228
- * @public
8229
- */
8230
- securityGroupIds?: string[] | undefined;
8231
- /**
8232
- * <p>The subnet ID to place the instance used to customize your Amazon EC2 AMI in.</p>
8233
- * @public
8234
- */
8235
- subnetId?: string | undefined;
8236
- /**
8237
- * <p>The logging configuration of the infrastructure configuration.</p>
8238
- * @public
8239
- */
8240
- logging?: Logging | undefined;
8241
- /**
8242
- * <p>The key pair of the infrastructure configuration. You can use this to log on to and
8243
- * debug the instance used to create your image.</p>
8244
- * @public
8245
- */
8246
- keyPair?: string | undefined;
8247
- /**
8248
- * <p>The terminate instance on failure setting of the infrastructure configuration. Set to
8249
- * false if you want Image Builder to retain the instance used to configure your AMI if the build or
8250
- * test phase of your workflow fails.</p>
8251
- * @public
8252
- */
8253
- terminateInstanceOnFailure?: boolean | undefined;
8254
- /**
8255
- * <p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event
8256
- * notifications.</p>
8257
- * <note>
8258
- * <p>EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys
8259
- * from other accounts. The key that is used to encrypt the SNS topic must reside in the
8260
- * account that the Image Builder service runs under.</p>
8261
- * </note>
8262
- * @public
8263
- */
8264
- snsTopicArn?: string | undefined;
8265
- /**
8266
- * <p>The tags attached to the resource created by Image Builder.</p>
8267
- * @public
8268
- */
8269
- resourceTags?: Record<string, string> | undefined;
8270
- /**
8271
- * <p>The instance metadata options that you can set for the HTTP requests that pipeline
8272
- * builds use to launch EC2 build and test instances. For more information about instance
8273
- * metadata options, see one of the following links:</p>
8274
- * <ul>
8275
- * <li>
8276
- * <p>
8277
- * <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html">Configure the instance metadata options</a> in the
8278
- * <i>
8279
- * <i>Amazon EC2 User Guide</i>
8280
- * </i> for Linux instances.</p>
8281
- * </li>
8282
- * <li>
8283
- * <p>
8284
- * <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html">Configure the instance metadata options</a> in the
8285
- * <i>
8286
- * <i>Amazon EC2 Windows Guide</i>
8287
- * </i> for Windows instances.</p>
8288
- * </li>
8289
- * </ul>
8290
- * @public
8291
- */
8292
- instanceMetadataOptions?: InstanceMetadataOptions | undefined;
8293
- /**
8294
- * <p>The instance placement settings that define where the instances that are launched
8295
- * from your image will run.</p>
8296
- * @public
8297
- */
8298
- placement?: Placement | undefined;
8299
- /**
8300
- * <p>Unique, case-sensitive identifier you provide to ensure
8301
- * idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>
8302
- * in the <i>Amazon EC2 API Reference</i>.</p>
8303
- * @public
8304
- */
8305
- clientToken?: string | undefined;
8306
- }
8307
- /**
8308
- * @public
8309
- */
8310
- export interface UpdateInfrastructureConfigurationResponse {
8311
- /**
8312
- * <p>The request ID that uniquely identifies this request.</p>
8313
- * @public
8314
- */
8315
- requestId?: string | undefined;
8316
- /**
8317
- * <p>The client token that uniquely identifies the request.</p>
8318
- * @public
8319
- */
8320
- clientToken?: string | undefined;
8321
- /**
8322
- * <p>The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by
8323
- * this request.</p>
8324
- * @public
8325
- */
8326
- infrastructureConfigurationArn?: string | undefined;
8327
- }
8328
- /**
8329
- * @public
8330
- */
8331
- export interface UpdateLifecyclePolicyRequest {
8332
- /**
8333
- * <p>The Amazon Resource Name (ARN) of the lifecycle policy resource.</p>
8334
- * @public
8335
- */
8336
- lifecyclePolicyArn: string | undefined;
8337
- /**
8338
- * <p>Optional description for the lifecycle policy.</p>
8339
- * @public
8340
- */
8341
- description?: string | undefined;
8342
- /**
8343
- * <p>Indicates whether the lifecycle policy resource is enabled.</p>
8344
- * @public
8345
- */
8346
- status?: LifecyclePolicyStatus | undefined;
8347
- /**
8348
- * <p>The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to update the
8349
- * lifecycle policy.</p>
8350
- * @public
8351
- */
8352
- executionRole: string | undefined;
8353
- /**
8354
- * <p>The type of image resource that the lifecycle policy applies to.</p>
8355
- * @public
8356
- */
8357
- resourceType: LifecyclePolicyResourceType | undefined;
8358
- /**
8359
- * <p>The configuration details for a lifecycle policy resource.</p>
8360
- * @public
8361
- */
8362
- policyDetails: LifecyclePolicyDetail[] | undefined;
8363
- /**
8364
- * <p>Selection criteria for resources that the lifecycle policy applies to.</p>
8365
- * @public
8366
- */
8367
- resourceSelection: LifecyclePolicyResourceSelection | undefined;
8368
- /**
8369
- * <p>Unique, case-sensitive identifier you provide to ensure
8370
- * idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>
8371
- * in the <i>Amazon EC2 API Reference</i>.</p>
8372
- * @public
8373
- */
8374
- clientToken?: string | undefined;
8375
- }