aws-sdk-imagebuilder 1.112.0 → 1.113.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.
@@ -61,8 +61,9 @@ module Aws::Imagebuilder
61
61
  # whether to keep it for the AMI that you create.
62
62
  #
63
63
  # @!attribute [rw] systems_manager_agent
64
- # Contains settings for the Systems Manager agent on your build
65
- # instance.
64
+ # The Systems Manager agent settings for your build instance. This
65
+ # setting applies to Linux and macOS build instances only. Requests
66
+ # that set it for a recipe with a Windows base image are rejected.
66
67
  # @return [Types::SystemsManagerAgent]
67
68
  #
68
69
  # @!attribute [rw] user_data_override
@@ -77,7 +78,7 @@ module Aws::Imagebuilder
77
78
  #
78
79
  # <note markdown="1"> The user data is always base 64 encoded. For example, the following
79
80
  # commands are encoded as
80
- # `IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$`:
81
+ # `IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhcg==`:
81
82
  #
82
83
  # *#!/bin/bash*
83
84
  #
@@ -117,7 +118,8 @@ module Aws::Imagebuilder
117
118
  # @return [String]
118
119
  #
119
120
  # @!attribute [rw] state
120
- # Image status and the reason for that status.
121
+ # The state of the AMI, which includes the status and, if applicable,
122
+ # the reason for that status.
121
123
  # @return [Types::ImageState]
122
124
  #
123
125
  # @!attribute [rw] account_id
@@ -140,16 +142,27 @@ module Aws::Imagebuilder
140
142
  # Define and configure the output AMIs of the pipeline.
141
143
  #
142
144
  # @!attribute [rw] name
143
- # The name of the output AMI.
145
+ # The name of the output AMI. The name must include the `{{
146
+ # imagebuilder:buildDate }}` dynamic tag so that each build produces a
147
+ # uniquely named AMI. If you don't specify a name, Image Builder
148
+ # names the output AMI with the image name followed by the build
149
+ # timestamp, for example `my-image 2022-10-26T22-30-05.912619Z`.
144
150
  # @return [String]
145
151
  #
146
152
  # @!attribute [rw] description
147
- # The description of the AMI distribution configuration. Minimum and
148
- # maximum length are in characters.
153
+ # The description to apply to the distributed AMI. Image Builder sets
154
+ # this as the output AMI's description in each target Region and
155
+ # account. If you don't specify a description, the AMI in the build
156
+ # Region uses the image recipe's description, if the recipe has one.
157
+ # Copies distributed to other Regions and accounts don't receive a
158
+ # default description.
149
159
  # @return [String]
150
160
  #
151
161
  # @!attribute [rw] target_account_ids
152
- # The ID of an account to which you want to distribute an image.
162
+ # The Amazon Web Services account IDs to distribute the AMI to in this
163
+ # Region. Each listed account receives its own copy of the output AMI.
164
+ # If you don't specify accounts, Image Builder distributes the AMI
165
+ # only to your own account.
153
166
  # @return [Array<String>]
154
167
  #
155
168
  # @!attribute [rw] ami_tags
@@ -186,7 +199,9 @@ module Aws::Imagebuilder
186
199
  end
187
200
 
188
201
  # Defines the rules by which an image pipeline is automatically disabled
189
- # when it fails.
202
+ # when it fails. By default, if the schedule doesn't include an
203
+ # auto-disable policy, Image Builder disables the pipeline after 5
204
+ # consecutive failed scheduled builds.
190
205
  #
191
206
  # @!attribute [rw] failure_count
192
207
  # The number of consecutive scheduled image pipeline executions that
@@ -201,8 +216,9 @@ module Aws::Imagebuilder
201
216
  include Aws::Structure
202
217
  end
203
218
 
204
- # You have exceeded the permitted request rate for the specific
205
- # operation.
219
+ # You have exceeded the permitted request rate for the Amazon EC2 APIs
220
+ # that Image Builder calls on your behalf. Retry with an increasing or
221
+ # variable delay between requests.
206
222
  #
207
223
  # @!attribute [rw] message
208
224
  # @return [String]
@@ -222,10 +238,10 @@ module Aws::Imagebuilder
222
238
  #
223
239
  # @!attribute [rw] client_token
224
240
  # A unique, case-sensitive identifier you provide to ensure that the
225
- # operation completes no more than one time. If this token matches a
226
- # previous request, the service ignores the request, but does not
227
- # return an error. For more information, see [Ensuring idempotency][1]
228
- # in the *Amazon EC2 API Reference*.
241
+ # operation runs no more than one time. If you retry a request with
242
+ # the same client token, Image Builder returns the original response
243
+ # without running the operation again. For more information, see
244
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
229
245
  #
230
246
  # **A suitable default value is auto-generated.** You should normally
231
247
  # not need to pass this option.
@@ -274,10 +290,10 @@ module Aws::Imagebuilder
274
290
  #
275
291
  # @!attribute [rw] client_token
276
292
  # A unique, case-sensitive identifier you provide to ensure that the
277
- # operation completes no more than one time. If this token matches a
278
- # previous request, the service ignores the request, but does not
279
- # return an error. For more information, see [Ensuring idempotency][1]
280
- # in the *Amazon EC2 API Reference*.
293
+ # operation runs no more than one time. If you retry a request with
294
+ # the same client token, Image Builder returns the original response
295
+ # without running the operation again. For more information, see
296
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
281
297
  #
282
298
  # **A suitable default value is auto-generated.** You should normally
283
299
  # not need to pass this option.
@@ -297,8 +313,9 @@ module Aws::Imagebuilder
297
313
  end
298
314
 
299
315
  # @!attribute [rw] lifecycle_execution_id
300
- # The unique identifier for the image lifecycle runtime instance that
301
- # was canceled.
316
+ # The unique identifier of the lifecycle execution that the
317
+ # cancellation request applies to. The cancellation completes
318
+ # asynchronously.
302
319
  # @return [String]
303
320
  #
304
321
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CancelLifecycleExecutionResponse AWS API Documentation
@@ -309,10 +326,9 @@ module Aws::Imagebuilder
309
326
  include Aws::Structure
310
327
  end
311
328
 
312
- # These errors are usually caused by a client action, such as using an
313
- # action or resource on behalf of a user that doesn't have permissions
314
- # to use the action or resource, or specifying an invalid resource
315
- # identifier.
329
+ # A generic client error. This error usually indicates that the request
330
+ # failed a validation check, such as when a downstream service rejects a
331
+ # configured value.
316
332
  #
317
333
  # @!attribute [rw] message
318
334
  # @return [String]
@@ -374,7 +390,9 @@ module Aws::Imagebuilder
374
390
  # @return [Array<Types::ComponentParameterDetail>]
375
391
  #
376
392
  # @!attribute [rw] owner
377
- # The owner of the component.
393
+ # The owner of the component. The value is your account ID for
394
+ # components that you own, the sharing account's ID for shared
395
+ # components, or `Amazon`, `ThirdParty`, or `AWSMarketplace`.
378
396
  # @return [String]
379
397
  #
380
398
  # @!attribute [rw] data
@@ -393,7 +411,9 @@ module Aws::Imagebuilder
393
411
  # @return [String]
394
412
  #
395
413
  # @!attribute [rw] encrypted
396
- # The encryption status of the component.
414
+ # Indicates whether the component data is encrypted at rest. Image
415
+ # Builder encrypts all component data at rest, so this value is always
416
+ # `true`. This field is retained for backward compatibility.
397
417
  # @return [Boolean]
398
418
  #
399
419
  # @!attribute [rw] date_created
@@ -446,15 +466,21 @@ module Aws::Imagebuilder
446
466
  include Aws::Structure
447
467
  end
448
468
 
449
- # Configuration details of the component.
469
+ # Configuration details of the component. You can specify each component
470
+ # only once in a recipe, regardless of version. Components with a status
471
+ # of `DEPRECATED` or `DISABLED` can't be added to new recipes.
450
472
  #
451
473
  # @!attribute [rw] component_arn
452
- # The Amazon Resource Name (ARN) of the component.
474
+ # The Amazon Resource Name (ARN) of the component. You can specify a
475
+ # build version ARN, or a component version ARN whose version segments
476
+ # can use `x` wildcards, for example `1.x.x`.
453
477
  # @return [String]
454
478
  #
455
479
  # @!attribute [rw] parameters
456
480
  # A group of parameter settings that Image Builder uses to configure
457
- # the component for a specific recipe.
481
+ # the component for a specific recipe. You must supply a value for
482
+ # every component parameter that has no default value, and you can
483
+ # only supply parameters that the component defines.
458
484
  # @return [Array<Types::ComponentParameter>]
459
485
  #
460
486
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ComponentConfiguration AWS API Documentation
@@ -559,7 +585,8 @@ module Aws::Imagebuilder
559
585
  # A group of fields that describe the current status of components.
560
586
  #
561
587
  # @!attribute [rw] status
562
- # The current state of the component.
588
+ # The current state of the component. Components with a status of
589
+ # `DEPRECATED` or `DISABLED` can't be added to new recipes.
563
590
  # @return [String]
564
591
  #
565
592
  # @!attribute [rw] reason
@@ -610,7 +637,9 @@ module Aws::Imagebuilder
610
637
  # @return [String]
611
638
  #
612
639
  # @!attribute [rw] owner
613
- # The owner of the component.
640
+ # The owner of the component. The value is your account ID for
641
+ # components that you own, the sharing account's ID for shared
642
+ # components, or `Amazon`, `ThirdParty`, or `AWSMarketplace`.
614
643
  # @return [String]
615
644
  #
616
645
  # @!attribute [rw] description
@@ -618,11 +647,11 @@ module Aws::Imagebuilder
618
647
  # @return [String]
619
648
  #
620
649
  # @!attribute [rw] change_description
621
- # The change description for the current version of the component.
650
+ # The change description for this version of the component.
622
651
  # @return [String]
623
652
  #
624
653
  # @!attribute [rw] date_created
625
- # The original creation date of the component.
654
+ # The date that Image Builder created this version of the component.
626
655
  # @return [String]
627
656
  #
628
657
  # @!attribute [rw] tags
@@ -661,8 +690,7 @@ module Aws::Imagebuilder
661
690
  include Aws::Structure
662
691
  end
663
692
 
664
- # The defining characteristics of a specific version of an Amazon Web
665
- # Services TOE component.
693
+ # The defining characteristics of a specific version of a component.
666
694
  #
667
695
  # @!attribute [rw] arn
668
696
  # The Amazon Resource Name (ARN) of the component.
@@ -732,7 +760,9 @@ module Aws::Imagebuilder
732
760
  # @return [String]
733
761
  #
734
762
  # @!attribute [rw] owner
735
- # The owner of the component.
763
+ # The owner of the component. The value is your account ID for
764
+ # components that you own, the sharing account's ID for shared
765
+ # components, or `Amazon`, `ThirdParty`, or `AWSMarketplace`.
736
766
  # @return [String]
737
767
  #
738
768
  # @!attribute [rw] date_created
@@ -766,7 +796,9 @@ module Aws::Imagebuilder
766
796
  include Aws::Structure
767
797
  end
768
798
 
769
- # A container encapsulates the runtime environment for an application.
799
+ # Details of the container images that are output resources of an image
800
+ # build in a given Amazon Web Services Region: the Region, and the URIs
801
+ # of the container images.
770
802
  #
771
803
  # @!attribute [rw] region
772
804
  # Containers and container images are Region-specific. This is the
@@ -786,15 +818,18 @@ module Aws::Imagebuilder
786
818
  include Aws::Structure
787
819
  end
788
820
 
789
- # Container distribution settings for encryption, licensing, and sharing
790
- # in a specific Region.
821
+ # Defines how the output container image is distributed in a specific
822
+ # Amazon Web Services Region: the target repository, the image tags to
823
+ # apply to the distributed image, and an optional description.
791
824
  #
792
825
  # @!attribute [rw] description
793
826
  # The description of the container distribution configuration.
794
827
  # @return [String]
795
828
  #
796
829
  # @!attribute [rw] container_tags
797
- # Tags that are attached to the container distribution configuration.
830
+ # Tags that Image Builder applies to the distributed container image
831
+ # in the target repository. These are repository image tags, not
832
+ # resource tags.
798
833
  # @return [Array<String>]
799
834
  #
800
835
  # @!attribute [rw] target_repository
@@ -812,7 +847,10 @@ module Aws::Imagebuilder
812
847
  include Aws::Structure
813
848
  end
814
849
 
815
- # A container recipe.
850
+ # Defines how Image Builder builds and tests a container image: the base
851
+ # image, components to apply, the Dockerfile template, the build and
852
+ # test instance configuration, and the target repository for the output
853
+ # image.
816
854
  #
817
855
  # @!attribute [rw] arn
818
856
  # The Amazon Resource Name (ARN) of the container recipe.
@@ -846,7 +884,8 @@ module Aws::Imagebuilder
846
884
  # @return [String]
847
885
  #
848
886
  # @!attribute [rw] platform
849
- # The system platform for the container, such as Windows or Linux.
887
+ # The system platform for the container. Container recipes support
888
+ # only the Linux and Windows platforms.
850
889
  # @return [String]
851
890
  #
852
891
  # @!attribute [rw] owner
@@ -880,8 +919,14 @@ module Aws::Imagebuilder
880
919
  #
881
920
  # @!attribute [rw] components
882
921
  # Build and test components that are included in the container recipe.
883
- # Recipes require a minimum of one build component, and can have a
884
- # maximum of 20 build and test components in any combination.
922
+ # A recipe can contain a maximum of 20 build and test components in
923
+ # any combination, by default. This maximum is an adjustable quota.
924
+ # For more information, see [EC2 Image Builder endpoints and
925
+ # quotas][1] in the *Amazon Web Services General Reference*.
926
+ #
927
+ #
928
+ #
929
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html
885
930
  # @return [Array<Types::ComponentConfiguration>]
886
931
  #
887
932
  # @!attribute [rw] instance_configuration
@@ -890,19 +935,26 @@ module Aws::Imagebuilder
890
935
  # @return [Types::InstanceConfiguration]
891
936
  #
892
937
  # @!attribute [rw] dockerfile_template_data
893
- # Dockerfiles are text documents that are used to build Docker
894
- # containers, and ensure that they contain all of the elements
895
- # required by the application running inside. The template data
896
- # consists of contextual variables where Image Builder places build
897
- # information or scripts, based on your container image recipe.
938
+ # The Dockerfile template that Image Builder uses to build the
939
+ # container image. The template can include contextual variables that
940
+ # Image Builder replaces with build information at build time. For the
941
+ # contextual variables that the template can include, see [Create a
942
+ # new version of a container recipe][1] in the *EC2 Image Builder User
943
+ # Guide*.
944
+ #
945
+ #
946
+ #
947
+ # [1]: https://docs.aws.amazon.com/imagebuilder/latest/userguide/create-container-recipes.html
898
948
  # @return [String]
899
949
  #
900
950
  # @!attribute [rw] kms_key_id
901
- # The Amazon Resource Name (ARN) that uniquely identifies which KMS
902
- # key is used to encrypt the container image for distribution to the
903
- # target Region. This can be either the Key ARN or the Alias ARN. For
904
- # more information, see [Key identifiers (KeyId)][1] in the *Key
905
- # Management Service Developer Guide*.
951
+ # The KMS key that Image Builder uses to encrypt the recipe's
952
+ # Dockerfile template data at rest. This can be either the Key ARN or
953
+ # the Alias ARN. For more information, see [Key identifiers
954
+ # (KeyId)][1] in the *Key Management Service Developer Guide*. If you
955
+ # don't specify a key, Image Builder encrypts the template data with
956
+ # a KMS key that Image Builder owns. This key isn't used to encrypt
957
+ # the output container image.
906
958
  #
907
959
  #
908
960
  #
@@ -910,7 +962,11 @@ module Aws::Imagebuilder
910
962
  # @return [String]
911
963
  #
912
964
  # @!attribute [rw] encrypted
913
- # A flag that indicates if the target container is encrypted.
965
+ # Specifies whether the recipe's Dockerfile template data is
966
+ # encrypted at rest. Image Builder encrypts all Dockerfile template
967
+ # data at rest, so this value is always `true`. This field is retained
968
+ # for backward compatibility, and doesn't describe encryption of the
969
+ # output container image.
914
970
  # @return [Boolean]
915
971
  #
916
972
  # @!attribute [rw] parent_image
@@ -959,7 +1015,7 @@ module Aws::Imagebuilder
959
1015
  include Aws::Structure
960
1016
  end
961
1017
 
962
- # A summary of a container recipe
1018
+ # A summary of a container recipe.
963
1019
  #
964
1020
  # @!attribute [rw] arn
965
1021
  # The Amazon Resource Name (ARN) of the container recipe.
@@ -974,7 +1030,8 @@ module Aws::Imagebuilder
974
1030
  # @return [String]
975
1031
  #
976
1032
  # @!attribute [rw] platform
977
- # The system platform for the container, such as Windows or Linux.
1033
+ # The system platform for the container. Container recipes support
1034
+ # only the Linux and Windows platforms.
978
1035
  # @return [String]
979
1036
  #
980
1037
  # @!attribute [rw] owner
@@ -1020,7 +1077,14 @@ module Aws::Imagebuilder
1020
1077
  end
1021
1078
 
1022
1079
  # @!attribute [rw] name
1023
- # The name of the component.
1080
+ # The name of the component. Image Builder generates the component ARN
1081
+ # from a normalized form of the name, so names that differ only in
1082
+ # case, spaces, or underscores count as the same name. If a component
1083
+ # with the same name and semantic version already exists in your
1084
+ # account in the same Amazon Web Services Region, the request creates
1085
+ # a new build version for it. If the content is also identical to the
1086
+ # latest build version, the request fails because the component
1087
+ # already exists.
1024
1088
  # @return [String]
1025
1089
  #
1026
1090
  # @!attribute [rw] semantic_version
@@ -1075,7 +1139,8 @@ module Aws::Imagebuilder
1075
1139
  # The `uri` of a YAML component document file. This must be an S3 URL
1076
1140
  # (`s3://bucket/key`), and you must have permission to access the S3
1077
1141
  # bucket it points to. If you use Amazon S3, you can specify component
1078
- # content up to your service quota.
1142
+ # content up to your service quota for component size, which is 64 KB
1143
+ # by default.
1079
1144
  #
1080
1145
  # Alternatively, you can specify the YAML document inline, using the
1081
1146
  # component `data` property. You cannot specify both properties.
@@ -1085,7 +1150,9 @@ module Aws::Imagebuilder
1085
1150
  # The Amazon Resource Name (ARN) that uniquely identifies the KMS key
1086
1151
  # used to encrypt this component. This can be either the Key ARN or
1087
1152
  # the Alias ARN. For more information, see [Key identifiers
1088
- # (KeyId)][1] in the *Key Management Service Developer Guide*.
1153
+ # (KeyId)][1] in the *Key Management Service Developer Guide*. If you
1154
+ # don't specify a key, Image Builder encrypts the component data with
1155
+ # a KMS key that Image Builder owns.
1089
1156
  #
1090
1157
  #
1091
1158
  #
@@ -1098,10 +1165,10 @@ module Aws::Imagebuilder
1098
1165
  #
1099
1166
  # @!attribute [rw] client_token
1100
1167
  # A unique, case-sensitive identifier you provide to ensure that the
1101
- # operation completes no more than one time. If this token matches a
1102
- # previous request, the service ignores the request, but does not
1103
- # return an error. For more information, see [Ensuring idempotency][1]
1104
- # in the *Amazon EC2 API Reference*.
1168
+ # operation runs no more than one time. If you retry a request with
1169
+ # the same client token, Image Builder returns the original response
1170
+ # without running the operation again. For more information, see
1171
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
1105
1172
  #
1106
1173
  # **A suitable default value is auto-generated.** You should normally
1107
1174
  # not need to pass this option.
@@ -1113,8 +1180,8 @@ module Aws::Imagebuilder
1113
1180
  #
1114
1181
  # @!attribute [rw] dry_run
1115
1182
  # Validates the required permissions and request parameters without
1116
- # making the request. If validation succeeds, the operation returns a
1117
- # `DryRunOperationException` error response.
1183
+ # performing the operation. If validation succeeds, the operation
1184
+ # returns a `DryRunOperationException` error response.
1118
1185
  # @return [Boolean]
1119
1186
  #
1120
1187
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateComponentRequest AWS API Documentation
@@ -1150,8 +1217,10 @@ module Aws::Imagebuilder
1150
1217
  # @return [String]
1151
1218
  #
1152
1219
  # @!attribute [rw] latest_version_references
1153
- # The resource ARNs with different wildcard variations of semantic
1154
- # versioning.
1220
+ # A set of wildcard version ARNs that always reference the latest
1221
+ # version of the resource. ARNs are included for the latest version
1222
+ # overall, and for the latest versions within the same major, minor,
1223
+ # and patch levels.
1155
1224
  # @return [Types::LatestVersionReferences]
1156
1225
  #
1157
1226
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateComponentResponse AWS API Documentation
@@ -1170,7 +1239,11 @@ module Aws::Imagebuilder
1170
1239
  # @return [String]
1171
1240
  #
1172
1241
  # @!attribute [rw] name
1173
- # The name of the container recipe.
1242
+ # The name of the container recipe. The recipe name, combined with the
1243
+ # semantic version, must be unique to your account in each Amazon Web
1244
+ # Services Region. Image Builder generates the container recipe ARN
1245
+ # from a normalized form of the name, so names that differ only in
1246
+ # case, spaces, or underscores count as the same name.
1174
1247
  # @return [String]
1175
1248
  #
1176
1249
  # @!attribute [rw] description
@@ -1199,7 +1272,8 @@ module Aws::Imagebuilder
1199
1272
  # @return [String]
1200
1273
  #
1201
1274
  # @!attribute [rw] components
1202
- # The components included in the container recipe.
1275
+ # The components included in the container recipe. You can specify
1276
+ # each component only one time in a recipe.
1203
1277
  # @return [Array<Types::ComponentConfiguration>]
1204
1278
  #
1205
1279
  # @!attribute [rw] instance_configuration
@@ -1208,26 +1282,43 @@ module Aws::Imagebuilder
1208
1282
  # @return [Types::InstanceConfiguration]
1209
1283
  #
1210
1284
  # @!attribute [rw] dockerfile_template_data
1211
- # The Dockerfile template used to build your image as an inline data
1212
- # blob.
1285
+ # The Dockerfile template used to build your image, as an inline data
1286
+ # blob. You must specify exactly one of the `dockerfileTemplateData`
1287
+ # or `dockerfileTemplateUri` properties. For the contextual variables
1288
+ # that the template can include, see [Create a new version of a
1289
+ # container recipe][1] in the *EC2 Image Builder User Guide*.
1290
+ #
1291
+ #
1292
+ #
1293
+ # [1]: https://docs.aws.amazon.com/imagebuilder/latest/userguide/create-container-recipes.html
1213
1294
  # @return [String]
1214
1295
  #
1215
1296
  # @!attribute [rw] dockerfile_template_uri
1216
- # The Amazon S3 URI for the Dockerfile that is used to build your
1217
- # container image.
1297
+ # The Amazon S3 URI for the Dockerfile template that is used to build
1298
+ # your container image. You must have permission to read the object.
1299
+ # Image Builder reads the object once, when it creates the recipe, and
1300
+ # stores its content in the recipe. Later changes to the S3 object
1301
+ # don't affect the recipe. You must specify exactly one of the
1302
+ # `dockerfileTemplateData` or `dockerfileTemplateUri` properties.
1218
1303
  # @return [String]
1219
1304
  #
1220
1305
  # @!attribute [rw] platform_override
1221
1306
  # Specifies the operating system platform when you use a custom base
1222
- # image.
1307
+ # image. Container recipes support only the Linux and Windows
1308
+ # platforms.
1223
1309
  # @return [String]
1224
1310
  #
1225
1311
  # @!attribute [rw] image_os_version_override
1226
- # Specifies the operating system version for the base image.
1312
+ # Specifies the operating system version for the base image. Use this
1313
+ # property only when the base image is a container image from a
1314
+ # registry. When the base image is an Image Builder image, the
1315
+ # operating system version comes from the parent image.
1227
1316
  # @return [String]
1228
1317
  #
1229
1318
  # @!attribute [rw] parent_image
1230
- # The base image for the container recipe.
1319
+ # The base image for the container recipe. This can be an Image
1320
+ # Builder image resource ARN or a container image URI from a registry,
1321
+ # for example `amazonlinux:latest`.
1231
1322
  # @return [String]
1232
1323
  #
1233
1324
  # @!attribute [rw] tags
@@ -1239,7 +1330,9 @@ module Aws::Imagebuilder
1239
1330
  # @return [String]
1240
1331
  #
1241
1332
  # @!attribute [rw] target_repository
1242
- # The destination repository for the container image.
1333
+ # The destination repository for the container image. The Amazon ECR
1334
+ # repository must already exist in the Amazon Web Services Region
1335
+ # where the build runs.
1243
1336
  # @return [Types::TargetContainerRepository]
1244
1337
  #
1245
1338
  # @!attribute [rw] kms_key_id
@@ -1256,10 +1349,10 @@ module Aws::Imagebuilder
1256
1349
  #
1257
1350
  # @!attribute [rw] client_token
1258
1351
  # A unique, case-sensitive identifier you provide to ensure that the
1259
- # operation completes no more than one time. If this token matches a
1260
- # previous request, the service ignores the request, but does not
1261
- # return an error. For more information, see [Ensuring idempotency][1]
1262
- # in the *Amazon EC2 API Reference*.
1352
+ # operation runs no more than one time. If you retry a request with
1353
+ # the same client token, Image Builder returns the original response
1354
+ # without running the operation again. For more information, see
1355
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
1263
1356
  #
1264
1357
  # **A suitable default value is auto-generated.** You should normally
1265
1358
  # not need to pass this option.
@@ -1271,8 +1364,8 @@ module Aws::Imagebuilder
1271
1364
  #
1272
1365
  # @!attribute [rw] dry_run
1273
1366
  # Validates the required permissions and request parameters without
1274
- # making the request. If validation succeeds, the operation returns a
1275
- # `DryRunOperationException` error response.
1367
+ # performing the operation. If validation succeeds, the operation
1368
+ # returns a `DryRunOperationException` error response.
1276
1369
  # @return [Boolean]
1277
1370
  #
1278
1371
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateContainerRecipeRequest AWS API Documentation
@@ -1313,8 +1406,10 @@ module Aws::Imagebuilder
1313
1406
  # @return [String]
1314
1407
  #
1315
1408
  # @!attribute [rw] latest_version_references
1316
- # The resource ARNs with different wildcard variations of semantic
1317
- # versioning.
1409
+ # A set of wildcard version ARNs that always reference the latest
1410
+ # version of the resource. ARNs are included for the latest version
1411
+ # overall, and for the latest versions within the same major, minor,
1412
+ # and patch levels.
1318
1413
  # @return [Types::LatestVersionReferences]
1319
1414
  #
1320
1415
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateContainerRecipeResponse AWS API Documentation
@@ -1329,7 +1424,11 @@ module Aws::Imagebuilder
1329
1424
  end
1330
1425
 
1331
1426
  # @!attribute [rw] name
1332
- # The name of the distribution configuration.
1427
+ # The name of the distribution configuration. Distribution
1428
+ # configuration names must be unique to your account in each Amazon
1429
+ # Web Services Region. Image Builder generates the distribution
1430
+ # configuration ARN from a normalized form of the name, so names that
1431
+ # differ only in case, spaces, or underscores count as the same name.
1333
1432
  # @return [String]
1334
1433
  #
1335
1434
  # @!attribute [rw] description
@@ -1337,7 +1436,9 @@ module Aws::Imagebuilder
1337
1436
  # @return [String]
1338
1437
  #
1339
1438
  # @!attribute [rw] distributions
1340
- # The distributions of the distribution configuration.
1439
+ # The distribution settings for the configuration. Each entry defines
1440
+ # how output images are distributed in one target Amazon Web Services
1441
+ # Region. A Region can appear at most once in the list.
1341
1442
  # @return [Array<Types::Distribution>]
1342
1443
  #
1343
1444
  # @!attribute [rw] tags
@@ -1346,10 +1447,10 @@ module Aws::Imagebuilder
1346
1447
  #
1347
1448
  # @!attribute [rw] client_token
1348
1449
  # A unique, case-sensitive identifier you provide to ensure that the
1349
- # operation completes no more than one time. If this token matches a
1350
- # previous request, the service ignores the request, but does not
1351
- # return an error. For more information, see [Ensuring idempotency][1]
1352
- # in the *Amazon EC2 API Reference*.
1450
+ # operation runs no more than one time. If you retry a request with
1451
+ # the same client token, Image Builder returns the original response
1452
+ # without running the operation again. For more information, see
1453
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
1353
1454
  #
1354
1455
  # **A suitable default value is auto-generated.** You should normally
1355
1456
  # not need to pass this option.
@@ -1361,8 +1462,8 @@ module Aws::Imagebuilder
1361
1462
  #
1362
1463
  # @!attribute [rw] dry_run
1363
1464
  # Validates the required permissions and request parameters without
1364
- # making the request. If validation succeeds, the operation returns a
1365
- # `DryRunOperationException` error response.
1465
+ # performing the operation. If validation succeeds, the operation
1466
+ # returns a `DryRunOperationException` error response.
1366
1467
  # @return [Boolean]
1367
1468
  #
1368
1469
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateDistributionConfigurationRequest AWS API Documentation
@@ -1402,7 +1503,11 @@ module Aws::Imagebuilder
1402
1503
  end
1403
1504
 
1404
1505
  # @!attribute [rw] name
1405
- # The name of the image pipeline.
1506
+ # The name of the image pipeline. Pipeline names must be unique to
1507
+ # your account in each Amazon Web Services Region. Image Builder
1508
+ # generates the pipeline ARN from a normalized form of the name, so
1509
+ # names that differ only in case, spaces, or underscores count as the
1510
+ # same name.
1406
1511
  # @return [String]
1407
1512
  #
1408
1513
  # @!attribute [rw] description
@@ -1411,12 +1516,14 @@ module Aws::Imagebuilder
1411
1516
  #
1412
1517
  # @!attribute [rw] image_recipe_arn
1413
1518
  # The Amazon Resource Name (ARN) of the image recipe that configures
1414
- # images created by this image pipeline.
1519
+ # images created by this image pipeline. You must specify either this
1520
+ # property or `containerRecipeArn`, but not both.
1415
1521
  # @return [String]
1416
1522
  #
1417
1523
  # @!attribute [rw] container_recipe_arn
1418
1524
  # The Amazon Resource Name (ARN) of the container recipe that is used
1419
- # to configure images created by this container pipeline.
1525
+ # to configure images created by this container pipeline. You must
1526
+ # specify either this property or `imageRecipeArn`, but not both.
1420
1527
  # @return [String]
1421
1528
  #
1422
1529
  # @!attribute [rw] infrastructure_configuration_arn
@@ -1431,7 +1538,10 @@ module Aws::Imagebuilder
1431
1538
  # @return [String]
1432
1539
  #
1433
1540
  # @!attribute [rw] image_tests_configuration
1434
- # The image test configuration of the image pipeline.
1541
+ # Specifies the test settings that Image Builder applies to images
1542
+ # that this pipeline creates. If you don't provide test settings,
1543
+ # Image Builder stores a default configuration with image tests
1544
+ # enabled.
1435
1545
  # @return [Types::ImageTestsConfiguration]
1436
1546
  #
1437
1547
  # @!attribute [rw] enhanced_image_metadata_enabled
@@ -1441,11 +1551,15 @@ module Aws::Imagebuilder
1441
1551
  # @return [Boolean]
1442
1552
  #
1443
1553
  # @!attribute [rw] schedule
1444
- # The schedule of the image pipeline.
1554
+ # The schedule of the image pipeline. If you don't provide a
1555
+ # schedule, the pipeline runs only when you call
1556
+ # StartImagePipelineExecution.
1445
1557
  # @return [Types::Schedule]
1446
1558
  #
1447
1559
  # @!attribute [rw] status
1448
- # The status of the image pipeline.
1560
+ # The status of the image pipeline. If you don't specify a status, it
1561
+ # defaults to `ENABLED`. A disabled pipeline doesn't run on its
1562
+ # schedule, but you can still start builds manually.
1449
1563
  # @return [String]
1450
1564
  #
1451
1565
  # @!attribute [rw] tags
@@ -1453,15 +1567,18 @@ module Aws::Imagebuilder
1453
1567
  # @return [Hash<String,String>]
1454
1568
  #
1455
1569
  # @!attribute [rw] image_tags
1456
- # The tags to be applied to the images produced by this pipeline.
1570
+ # The tags that Image Builder applies to the Image Builder image
1571
+ # resource that this pipeline's scheduled executions create. These
1572
+ # tags don't apply to the output AMI. To tag output AMIs, use
1573
+ # `amiTags` in the pipeline's distribution configuration.
1457
1574
  # @return [Hash<String,String>]
1458
1575
  #
1459
1576
  # @!attribute [rw] client_token
1460
1577
  # A unique, case-sensitive identifier you provide to ensure that the
1461
- # operation completes no more than one time. If this token matches a
1462
- # previous request, the service ignores the request, but does not
1463
- # return an error. For more information, see [Ensuring idempotency][1]
1464
- # in the *Amazon EC2 API Reference*.
1578
+ # operation runs no more than one time. If you retry a request with
1579
+ # the same client token, Image Builder returns the original response
1580
+ # without running the operation again. For more information, see
1581
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
1465
1582
  #
1466
1583
  # **A suitable default value is auto-generated.** You should normally
1467
1584
  # not need to pass this option.
@@ -1472,11 +1589,14 @@ module Aws::Imagebuilder
1472
1589
  # @return [String]
1473
1590
  #
1474
1591
  # @!attribute [rw] image_scanning_configuration
1475
- # Contains settings for vulnerability scans.
1592
+ # Contains settings for vulnerability scans that Amazon Inspector runs
1593
+ # against the test instance during image creation.
1476
1594
  # @return [Types::ImageScanningConfiguration]
1477
1595
  #
1478
1596
  # @!attribute [rw] workflows
1479
- # Contains an array of workflow configuration objects.
1597
+ # The array of workflow configuration objects for builds that this
1598
+ # pipeline starts. You must also specify `executionRole` when you
1599
+ # provide workflows.
1480
1600
  # @return [Array<Types::WorkflowConfiguration>]
1481
1601
  #
1482
1602
  # @!attribute [rw] execution_role
@@ -1495,8 +1615,8 @@ module Aws::Imagebuilder
1495
1615
  #
1496
1616
  # @!attribute [rw] dry_run
1497
1617
  # Validates the required permissions and request parameters without
1498
- # making the request. If validation succeeds, the operation returns a
1499
- # `DryRunOperationException` error response.
1618
+ # performing the operation. If validation succeeds, the operation
1619
+ # returns a `DryRunOperationException` error response.
1500
1620
  # @return [Boolean]
1501
1621
  #
1502
1622
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImagePipelineRequest AWS API Documentation
@@ -1548,7 +1668,11 @@ module Aws::Imagebuilder
1548
1668
  end
1549
1669
 
1550
1670
  # @!attribute [rw] name
1551
- # The name of the image recipe.
1671
+ # The name of the image recipe. The recipe name, combined with the
1672
+ # semantic version, must be unique to your account in each Amazon Web
1673
+ # Services Region. Image Builder generates the image recipe ARN from a
1674
+ # normalized form of the name, so names that differ only in case,
1675
+ # spaces, or underscores count as the same name.
1552
1676
  # @return [String]
1553
1677
  #
1554
1678
  # @!attribute [rw] description
@@ -1577,7 +1701,11 @@ module Aws::Imagebuilder
1577
1701
  # @return [String]
1578
1702
  #
1579
1703
  # @!attribute [rw] components
1580
- # The components included in the image recipe.
1704
+ # The components included in the image recipe. Components are
1705
+ # optional. A recipe with no components bakes the base image without
1706
+ # additional customization. You can specify each component only one
1707
+ # time in a recipe. Components with a status of `DEPRECATED` or
1708
+ # `DISABLED` can't be added to new recipes.
1581
1709
  # @return [Array<Types::ComponentConfiguration>]
1582
1710
  #
1583
1711
  # @!attribute [rw] parent_image
@@ -1595,12 +1723,14 @@ module Aws::Imagebuilder
1595
1723
  # * Amazon Web Services Marketplace product ID
1596
1724
  #
1597
1725
  # If you enter an AMI ID or an SSM parameter that contains the AMI ID,
1598
- # you must have access to the AMI, and the AMI must be in the source
1599
- # Region.
1726
+ # you must have access to the AMI. The AMI must also be in the Region
1727
+ # where you're creating the recipe.
1600
1728
  # @return [String]
1601
1729
  #
1602
1730
  # @!attribute [rw] block_device_mappings
1603
- # The block device mappings of the image recipe.
1731
+ # The block device mappings that Image Builder applies to the build
1732
+ # instance and the output AMI. For example, you can override the size
1733
+ # of the base image's root volume or attach additional EBS volumes.
1604
1734
  # @return [Array<Types::InstanceBlockDeviceMapping>]
1605
1735
  #
1606
1736
  # @!attribute [rw] tags
@@ -1608,7 +1738,10 @@ module Aws::Imagebuilder
1608
1738
  # @return [Hash<String,String>]
1609
1739
  #
1610
1740
  # @!attribute [rw] working_directory
1611
- # The working directory used during build and test workflows.
1741
+ # The working directory used during build and test workflows. If you
1742
+ # don't specify a working directory, Image Builder uses `/tmp` for
1743
+ # Linux and macOS build instances, and `C:/` for Windows build
1744
+ # instances.
1612
1745
  # @return [String]
1613
1746
  #
1614
1747
  # @!attribute [rw] additional_instance_configuration
@@ -1634,10 +1767,10 @@ module Aws::Imagebuilder
1634
1767
  #
1635
1768
  # @!attribute [rw] client_token
1636
1769
  # A unique, case-sensitive identifier you provide to ensure that the
1637
- # operation completes no more than one time. If this token matches a
1638
- # previous request, the service ignores the request, but does not
1639
- # return an error. For more information, see [Ensuring idempotency][1]
1640
- # in the *Amazon EC2 API Reference*.
1770
+ # operation runs no more than one time. If you retry a request with
1771
+ # the same client token, Image Builder returns the original response
1772
+ # without running the operation again. For more information, see
1773
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
1641
1774
  #
1642
1775
  # **A suitable default value is auto-generated.** You should normally
1643
1776
  # not need to pass this option.
@@ -1649,8 +1782,8 @@ module Aws::Imagebuilder
1649
1782
  #
1650
1783
  # @!attribute [rw] dry_run
1651
1784
  # Validates the required permissions and request parameters without
1652
- # making the request. If validation succeeds, the operation returns a
1653
- # `DryRunOperationException` error response.
1785
+ # performing the operation. If validation succeeds, the operation
1786
+ # returns a `DryRunOperationException` error response.
1654
1787
  # @return [Boolean]
1655
1788
  #
1656
1789
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageRecipeRequest AWS API Documentation
@@ -1687,8 +1820,10 @@ module Aws::Imagebuilder
1687
1820
  # @return [String]
1688
1821
  #
1689
1822
  # @!attribute [rw] latest_version_references
1690
- # The resource ARNs with different wildcard variations of semantic
1691
- # versioning.
1823
+ # A set of wildcard version ARNs that always reference the latest
1824
+ # version of the resource. ARNs are included for the latest version
1825
+ # overall, and for the latest versions within the same major, minor,
1826
+ # and patch levels.
1692
1827
  # @return [Types::LatestVersionReferences]
1693
1828
  #
1694
1829
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageRecipeResponse AWS API Documentation
@@ -1704,17 +1839,22 @@ module Aws::Imagebuilder
1704
1839
 
1705
1840
  # @!attribute [rw] image_recipe_arn
1706
1841
  # The Amazon Resource Name (ARN) of the image recipe that defines how
1707
- # images are configured, tested, and assessed.
1842
+ # images are configured, tested, and assessed. You must specify either
1843
+ # this property or `containerRecipeArn`, but not both.
1708
1844
  # @return [String]
1709
1845
  #
1710
1846
  # @!attribute [rw] container_recipe_arn
1711
1847
  # The Amazon Resource Name (ARN) of the container recipe that defines
1712
- # how images are configured and tested.
1848
+ # how images are configured and tested. You must specify either this
1849
+ # property or `imageRecipeArn`, but not both.
1713
1850
  # @return [String]
1714
1851
  #
1715
1852
  # @!attribute [rw] distribution_configuration_arn
1716
1853
  # The Amazon Resource Name (ARN) of the distribution configuration
1717
- # that defines and configures the outputs of your pipeline.
1854
+ # that defines and configures the outputs of the image build. If you
1855
+ # don't specify a distribution configuration, Image Builder creates
1856
+ # the output image only in the account and Amazon Web Services Region
1857
+ # where the build runs.
1718
1858
  # @return [String]
1719
1859
  #
1720
1860
  # @!attribute [rw] infrastructure_configuration_arn
@@ -1724,7 +1864,8 @@ module Aws::Imagebuilder
1724
1864
  # @return [String]
1725
1865
  #
1726
1866
  # @!attribute [rw] image_tests_configuration
1727
- # The image tests configuration of the image.
1867
+ # Settings that determine whether Image Builder runs tests on the
1868
+ # image after building it. Image tests are enabled by default.
1728
1869
  # @return [Types::ImageTestsConfiguration]
1729
1870
  #
1730
1871
  # @!attribute [rw] enhanced_image_metadata_enabled
@@ -1739,10 +1880,10 @@ module Aws::Imagebuilder
1739
1880
  #
1740
1881
  # @!attribute [rw] client_token
1741
1882
  # A unique, case-sensitive identifier you provide to ensure that the
1742
- # operation completes no more than one time. If this token matches a
1743
- # previous request, the service ignores the request, but does not
1744
- # return an error. For more information, see [Ensuring idempotency][1]
1745
- # in the *Amazon EC2 API Reference*.
1883
+ # operation runs no more than one time. If you retry a request with
1884
+ # the same client token, Image Builder returns the original response
1885
+ # without running the operation again. For more information, see
1886
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
1746
1887
  #
1747
1888
  # **A suitable default value is auto-generated.** You should normally
1748
1889
  # not need to pass this option.
@@ -1753,20 +1894,33 @@ module Aws::Imagebuilder
1753
1894
  # @return [String]
1754
1895
  #
1755
1896
  # @!attribute [rw] image_scanning_configuration
1756
- # Contains settings for vulnerability scans.
1897
+ # Settings for vulnerability scans that Amazon Inspector runs during
1898
+ # image creation. For AMI output, Amazon Inspector scans the test
1899
+ # instance. For container output, Amazon Inspector scans the container
1900
+ # image that Image Builder pushes to the Amazon ECR repository
1901
+ # specified in `ecrConfiguration`.
1757
1902
  # @return [Types::ImageScanningConfiguration]
1758
1903
  #
1759
1904
  # @!attribute [rw] workflows
1760
- # Contains an array of workflow configuration objects.
1905
+ # The array of workflow configuration objects for the build. If you
1906
+ # specify workflows, they replace the default workflows that Image
1907
+ # Builder otherwise runs for the build, and you must also provide an
1908
+ # `executionRole`.
1761
1909
  # @return [Array<Types::WorkflowConfiguration>]
1762
1910
  #
1763
1911
  # @!attribute [rw] execution_role
1764
1912
  # The name or Amazon Resource Name (ARN) for the IAM role you create
1765
- # that grants Image Builder access to perform workflow actions.
1913
+ # that grants Image Builder access to perform workflow actions. This
1914
+ # property is required if you specify `workflows`. If you don't
1915
+ # provide a role, Image Builder uses the Image Builder service-linked
1916
+ # role in your account, and creates it if it doesn't exist.
1766
1917
  # @return [String]
1767
1918
  #
1768
1919
  # @!attribute [rw] logging_configuration
1769
- # The logging configuration for the image build process.
1920
+ # The CloudWatch Logs log group where Image Builder sends the image
1921
+ # build logs. If you specify a log group name outside of the
1922
+ # `/aws/imagebuilder/` namespace, you must also provide an
1923
+ # `executionRole` that has permission to write to that log group.
1770
1924
  # @return [Types::ImageLoggingConfiguration]
1771
1925
  #
1772
1926
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageRequest AWS API Documentation
@@ -1802,8 +1956,10 @@ module Aws::Imagebuilder
1802
1956
  # @return [String]
1803
1957
  #
1804
1958
  # @!attribute [rw] latest_version_references
1805
- # The resource ARNs with different wildcard variations of semantic
1806
- # versioning.
1959
+ # A set of wildcard version ARNs that always reference the latest
1960
+ # version of the resource. ARNs are included for the latest version
1961
+ # overall, and for the latest versions within the same major, minor,
1962
+ # and patch levels.
1807
1963
  # @return [Types::LatestVersionReferences]
1808
1964
  #
1809
1965
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageResponse AWS API Documentation
@@ -1818,7 +1974,11 @@ module Aws::Imagebuilder
1818
1974
  end
1819
1975
 
1820
1976
  # @!attribute [rw] name
1821
- # The name of the infrastructure configuration.
1977
+ # The name of the infrastructure configuration. Infrastructure
1978
+ # configuration names must be unique to your account in each Amazon
1979
+ # Web Services Region. Image Builder generates the infrastructure
1980
+ # configuration ARN from a normalized form of the name, so names that
1981
+ # differ only in case, spaces, or underscores count as the same name.
1822
1982
  # @return [String]
1823
1983
  #
1824
1984
  # @!attribute [rw] description
@@ -1828,12 +1988,16 @@ module Aws::Imagebuilder
1828
1988
  # @!attribute [rw] instance_types
1829
1989
  # The instance types of the infrastructure configuration. You can
1830
1990
  # specify one or more instance types to use for this build. Image
1831
- # Builder picks one of these instance types based on availability.
1991
+ # Builder picks one of these instance types based on availability. If
1992
+ # you don't specify instance types, Image Builder selects compatible
1993
+ # instance types automatically. If you specify a Dedicated Host, Image
1994
+ # Builder uses only instance types that the host supports.
1832
1995
  # @return [Array<String>]
1833
1996
  #
1834
1997
  # @!attribute [rw] instance_profile_name
1835
1998
  # The instance profile to associate with the instance used to
1836
- # customize your Amazon EC2 AMI.
1999
+ # customize your Amazon EC2 AMI. The instance profile must exist in
2000
+ # your account.
1837
2001
  # @return [String]
1838
2002
  #
1839
2003
  # @!attribute [rw] security_group_ids
@@ -1843,11 +2007,15 @@ module Aws::Imagebuilder
1843
2007
  #
1844
2008
  # @!attribute [rw] subnet_id
1845
2009
  # The subnet ID in which to place the instance used to customize your
1846
- # Amazon EC2 AMI.
2010
+ # Amazon EC2 AMI. If you specify `subnetId`, you must also specify one
2011
+ # or more security group IDs in `securityGroupIds`. Otherwise, the
2012
+ # request fails.
1847
2013
  # @return [String]
1848
2014
  #
1849
2015
  # @!attribute [rw] logging
1850
- # The logging configuration of the infrastructure configuration.
2016
+ # The logging configuration of the infrastructure configuration. When
2017
+ # you configure S3 logs, Image Builder writes logs from the build and
2018
+ # test process to the specified bucket under the key prefix.
1851
2019
  # @return [Types::Logging]
1852
2020
  #
1853
2021
  # @!attribute [rw] key_pair
@@ -1864,12 +2032,15 @@ module Aws::Imagebuilder
1864
2032
  #
1865
2033
  # @!attribute [rw] sns_topic_arn
1866
2034
  # The Amazon Resource Name (ARN) of the SNS topic to which Image
1867
- # Builder sends image build event notifications.
2035
+ # Builder sends image build event notifications. Specify a standard
2036
+ # topic. Image Builder doesn't support FIFO topics. Image Builder
2037
+ # validates the topic when you create or update the configuration. You
2038
+ # must have permission to publish to the topic.
1868
2039
  #
1869
- # <note markdown="1"> EC2 Image Builder is unable to send notifications to SNS topics that
1870
- # are encrypted using keys from other accounts. The key that is used
1871
- # to encrypt the SNS topic must reside in the account that the Image
1872
- # Builder service runs under.
2040
+ # <note markdown="1"> EC2 Image Builder can't send notifications to SNS topics that are
2041
+ # encrypted using keys from other accounts. If your SNS topic is
2042
+ # encrypted, the key must be owned by the same account that owns your
2043
+ # Image Builder resources.
1873
2044
  #
1874
2045
  # </note>
1875
2046
  # @return [String]
@@ -1877,12 +2048,28 @@ module Aws::Imagebuilder
1877
2048
  # @!attribute [rw] resource_tags
1878
2049
  # The metadata tags to assign to the Amazon EC2 instance that Image
1879
2050
  # Builder launches during the build process. Tags are formatted as key
1880
- # value pairs.
2051
+ # value pairs. Tag keys can't begin with `aws:` or match one of the
2052
+ # following reserved keys: `CreatedBy`, `Ec2ImageBuilderArn`, `Name`,
2053
+ # or `Tags`.
1881
2054
  # @return [Hash<String,String>]
1882
2055
  #
1883
2056
  # @!attribute [rw] instance_metadata_options
1884
- # The instance metadata options that you can set for the HTTP requests
1885
- # that pipeline builds use to launch EC2 build and test instances.
2057
+ # The instance metadata service (IMDS) settings that Image Builder
2058
+ # applies to the EC2 build and test instances it launches during image
2059
+ # creation. If you don't set these options, the EC2 launch defaults
2060
+ # for the instance apply. For more information about instance metadata
2061
+ # options, see one of the following links:
2062
+ #
2063
+ # * [Configure the instance metadata options][1] in the <i> <i>Amazon
2064
+ # EC2 User Guide</i> </i> for Linux instances.
2065
+ #
2066
+ # * [Configure the instance metadata options][2] in the <i> <i>Amazon
2067
+ # EC2 Windows Guide</i> </i> for Windows instances.
2068
+ #
2069
+ #
2070
+ #
2071
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html
2072
+ # [2]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html
1886
2073
  # @return [Types::InstanceMetadataOptions]
1887
2074
  #
1888
2075
  # @!attribute [rw] tags
@@ -1892,16 +2079,18 @@ module Aws::Imagebuilder
1892
2079
  # @return [Hash<String,String>]
1893
2080
  #
1894
2081
  # @!attribute [rw] placement
1895
- # The instance placement settings that define where the instances that
1896
- # are launched from your image run.
2082
+ # The instance placement settings that define where the build and test
2083
+ # instances that Image Builder launches during image creation run.
2084
+ # These settings don't affect instances that you launch from the
2085
+ # output image.
1897
2086
  # @return [Types::Placement]
1898
2087
  #
1899
2088
  # @!attribute [rw] client_token
1900
2089
  # A unique, case-sensitive identifier you provide to ensure that the
1901
- # operation completes no more than one time. If this token matches a
1902
- # previous request, the service ignores the request, but does not
1903
- # return an error. For more information, see [Ensuring idempotency][1]
1904
- # in the *Amazon EC2 API Reference*.
2090
+ # operation runs no more than one time. If you retry a request with
2091
+ # the same client token, Image Builder returns the original response
2092
+ # without running the operation again. For more information, see
2093
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
1905
2094
  #
1906
2095
  # **A suitable default value is auto-generated.** You should normally
1907
2096
  # not need to pass this option.
@@ -1913,8 +2102,8 @@ module Aws::Imagebuilder
1913
2102
  #
1914
2103
  # @!attribute [rw] dry_run
1915
2104
  # Validates the required permissions and request parameters without
1916
- # making the request. If validation succeeds, the operation returns a
1917
- # `DryRunOperationException` error response.
2105
+ # performing the operation. If validation succeeds, the operation
2106
+ # returns a `DryRunOperationException` error response.
1918
2107
  # @return [Boolean]
1919
2108
  #
1920
2109
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateInfrastructureConfigurationRequest AWS API Documentation
@@ -1964,7 +2153,11 @@ module Aws::Imagebuilder
1964
2153
  end
1965
2154
 
1966
2155
  # @!attribute [rw] name
1967
- # The name of the lifecycle policy to create.
2156
+ # The name of the lifecycle policy to create. Policy names must be
2157
+ # unique to your account in each Amazon Web Services Region. Image
2158
+ # Builder generates the policy ARN from a normalized form of the name,
2159
+ # so names that differ only in case, spaces, or underscores count as
2160
+ # the same name. You can't change the name after creation.
1968
2161
  # @return [String]
1969
2162
  #
1970
2163
  # @!attribute [rw] description
@@ -1972,26 +2165,37 @@ module Aws::Imagebuilder
1972
2165
  # @return [String]
1973
2166
  #
1974
2167
  # @!attribute [rw] status
1975
- # Indicates whether the lifecycle policy resource is enabled.
2168
+ # Indicates whether the lifecycle policy resource is enabled. If you
2169
+ # don't specify a status, it defaults to `ENABLED`. Only enabled
2170
+ # policies run on their schedule.
1976
2171
  # @return [String]
1977
2172
  #
1978
2173
  # @!attribute [rw] execution_role
1979
2174
  # The name or Amazon Resource Name (ARN) for the IAM role you create
1980
- # that grants Image Builder access to run lifecycle actions.
2175
+ # that grants Image Builder access to run lifecycle actions. You must
2176
+ # have permission to pass the role, and the role's trust policy must
2177
+ # allow the Image Builder service principal to assume it.
1981
2178
  # @return [String]
1982
2179
  #
1983
2180
  # @!attribute [rw] resource_type
1984
2181
  # The type of Image Builder resource that the lifecycle policy applies
1985
- # to.
2182
+ # to. The resource type determines the allowed rule actions: policies
2183
+ # for AMI-based Image Builder images support `DELETE`, `DEPRECATE`,
2184
+ # and `DISABLE`, and policies for container-based Image Builder images
2185
+ # support only `DELETE`. You can't change the resource type after
2186
+ # creation.
1986
2187
  # @return [String]
1987
2188
  #
1988
2189
  # @!attribute [rw] policy_details
1989
- # Configuration details for the lifecycle policy rules.
2190
+ # Configuration details for the lifecycle policy rules. A policy can
2191
+ # contain at most one rule per action type: one `DELETE`, one
2192
+ # `DEPRECATE`, and one `DISABLE`.
1990
2193
  # @return [Array<Types::LifecyclePolicyDetail>]
1991
2194
  #
1992
2195
  # @!attribute [rw] resource_selection
1993
2196
  # Selection criteria for the resources that the lifecycle policy
1994
- # applies to.
2197
+ # applies to. You must specify exactly one selection criteria: either
2198
+ # recipes or a tag map, not both.
1995
2199
  # @return [Types::LifecyclePolicyResourceSelection]
1996
2200
  #
1997
2201
  # @!attribute [rw] tags
@@ -2000,10 +2204,10 @@ module Aws::Imagebuilder
2000
2204
  #
2001
2205
  # @!attribute [rw] client_token
2002
2206
  # A unique, case-sensitive identifier you provide to ensure that the
2003
- # operation completes no more than one time. If this token matches a
2004
- # previous request, the service ignores the request, but does not
2005
- # return an error. For more information, see [Ensuring idempotency][1]
2006
- # in the *Amazon EC2 API Reference*.
2207
+ # operation runs no more than one time. If you retry a request with
2208
+ # the same client token, Image Builder returns the original response
2209
+ # without running the operation again. For more information, see
2210
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
2007
2211
  #
2008
2212
  # **A suitable default value is auto-generated.** You should normally
2009
2213
  # not need to pass this option.
@@ -2015,8 +2219,8 @@ module Aws::Imagebuilder
2015
2219
  #
2016
2220
  # @!attribute [rw] dry_run
2017
2221
  # Validates the required permissions and request parameters without
2018
- # making the request. If validation succeeds, the operation returns a
2019
- # `DryRunOperationException` error response.
2222
+ # performing the operation. If validation succeeds, the operation
2223
+ # returns a `DryRunOperationException` error response.
2020
2224
  # @return [Boolean]
2021
2225
  #
2022
2226
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateLifecyclePolicyRequest AWS API Documentation
@@ -2055,7 +2259,14 @@ module Aws::Imagebuilder
2055
2259
  end
2056
2260
 
2057
2261
  # @!attribute [rw] name
2058
- # The name of the workflow to create.
2262
+ # The name of the workflow to create. Image Builder generates the
2263
+ # workflow ARN from a normalized form of the name, so names that
2264
+ # differ only in case, spaces, or underscores count as the same name.
2265
+ # If a workflow with the same name and semantic version already exists
2266
+ # in your account in the same Amazon Web Services Region, the request
2267
+ # creates a new build version for it. If the content is also identical
2268
+ # to the latest build version, the request fails because the workflow
2269
+ # already exists.
2059
2270
  # @return [String]
2060
2271
  #
2061
2272
  # @!attribute [rw] semantic_version
@@ -2090,26 +2301,31 @@ module Aws::Imagebuilder
2090
2301
  # @return [String]
2091
2302
  #
2092
2303
  # @!attribute [rw] data
2093
- # Contains the UTF-8 encoded YAML document content for the workflow.
2094
- # Alternatively, you can specify the `uri` of a YAML document file
2095
- # stored in Amazon S3. However, you cannot specify both properties.
2304
+ # The UTF-8 encoded YAML document content for the workflow, up to
2305
+ # 16,000 characters. For larger documents, store the document in
2306
+ # Amazon S3 and specify the `uri` property instead. You must specify
2307
+ # exactly one of the `data` or `uri` properties.
2096
2308
  # @return [String]
2097
2309
  #
2098
2310
  # @!attribute [rw] uri
2099
- # The `uri` of a YAML component document file. This must be an S3 URL
2100
- # (`s3://bucket/key`), and you must have permission to access the S3
2101
- # bucket it points to. If you use Amazon S3, you can specify component
2102
- # content up to your service quota.
2311
+ # The `uri` of a YAML workflow document file stored in Amazon S3. This
2312
+ # must be an S3 URL (`s3://bucket/key`), and you must have permission
2313
+ # to access the S3 bucket it points to. A workflow document that you
2314
+ # provide from Amazon S3 can be up to your service quota for workflow
2315
+ # size.
2103
2316
  #
2104
2317
  # Alternatively, you can specify the YAML document inline, using the
2105
- # component `data` property. You cannot specify both properties.
2318
+ # workflow `data` property. You must specify exactly one of the `data`
2319
+ # or `uri` properties.
2106
2320
  # @return [String]
2107
2321
  #
2108
2322
  # @!attribute [rw] kms_key_id
2109
2323
  # The Amazon Resource Name (ARN) that uniquely identifies the KMS key
2110
2324
  # used to encrypt this workflow resource. This can be either the Key
2111
2325
  # ARN or the Alias ARN. For more information, see [Key identifiers
2112
- # (KeyId)][1] in the *Key Management Service Developer Guide*.
2326
+ # (KeyId)][1] in the *Key Management Service Developer Guide*. If you
2327
+ # don't specify a key, Image Builder encrypts the workflow document
2328
+ # with a KMS key that Image Builder owns.
2113
2329
  #
2114
2330
  #
2115
2331
  #
@@ -2122,10 +2338,10 @@ module Aws::Imagebuilder
2122
2338
  #
2123
2339
  # @!attribute [rw] client_token
2124
2340
  # A unique, case-sensitive identifier you provide to ensure that the
2125
- # operation completes no more than one time. If this token matches a
2126
- # previous request, the service ignores the request, but does not
2127
- # return an error. For more information, see [Ensuring idempotency][1]
2128
- # in the *Amazon EC2 API Reference*.
2341
+ # operation runs no more than one time. If you retry a request with
2342
+ # the same client token, Image Builder returns the original response
2343
+ # without running the operation again. For more information, see
2344
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
2129
2345
  #
2130
2346
  # **A suitable default value is auto-generated.** You should normally
2131
2347
  # not need to pass this option.
@@ -2136,14 +2352,15 @@ module Aws::Imagebuilder
2136
2352
  # @return [String]
2137
2353
  #
2138
2354
  # @!attribute [rw] type
2139
- # The phase in the image build process for which the workflow resource
2140
- # is responsible.
2355
+ # The image creation stage that this workflow applies to. Image
2356
+ # Builder validates the workflow document steps against the stage you
2357
+ # specify.
2141
2358
  # @return [String]
2142
2359
  #
2143
2360
  # @!attribute [rw] dry_run
2144
2361
  # Validates the required permissions and request parameters without
2145
- # making the request. If validation succeeds, the operation returns a
2146
- # `DryRunOperationException` error response.
2362
+ # performing the operation. If validation succeeds, the operation
2363
+ # returns a `DryRunOperationException` error response.
2147
2364
  # @return [Boolean]
2148
2365
  #
2149
2366
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateWorkflowRequest AWS API Documentation
@@ -2174,8 +2391,10 @@ module Aws::Imagebuilder
2174
2391
  # @return [String]
2175
2392
  #
2176
2393
  # @!attribute [rw] latest_version_references
2177
- # The resource ARNs with different wildcard variations of semantic
2178
- # versioning.
2394
+ # A set of wildcard version ARNs that always reference the latest
2395
+ # version of the resource. ARNs are included for the latest version
2396
+ # overall, and for the latest versions within the same major, minor,
2397
+ # and patch levels.
2179
2398
  # @return [Types::LatestVersionReferences]
2180
2399
  #
2181
2400
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateWorkflowResponse AWS API Documentation
@@ -2188,18 +2407,10 @@ module Aws::Imagebuilder
2188
2407
  include Aws::Structure
2189
2408
  end
2190
2409
 
2191
- # Amazon Inspector generates a risk score for each finding. This score
2192
- # helps you to prioritize findings, to focus on the most critical
2193
- # findings and the most vulnerable resources. The score uses the Common
2194
- # Vulnerability Scoring System (CVSS) format. This format is a
2195
- # modification of the base CVSS score that the National Vulnerability
2196
- # Database (NVD) provides. For more information about severity levels,
2197
- # see [Severity levels for Amazon Inspector findings][1] in the *Amazon
2198
- # Inspector User Guide*.
2199
- #
2200
- #
2201
- #
2202
- # [1]: https://docs.aws.amazon.com/inspector/latest/user/findings-understanding-severity.html
2410
+ # A CVSS score for the vulnerability, as published by the vulnerability
2411
+ # source. Sources include the National Vulnerability Database (NVD) and
2412
+ # the operating system vendor's security feed. A finding can include
2413
+ # CVSS scores from multiple sources and CVSS versions.
2203
2414
  #
2204
2415
  # @!attribute [rw] base_score
2205
2416
  # The CVSS base score.
@@ -2256,7 +2467,8 @@ module Aws::Imagebuilder
2256
2467
  # @return [String]
2257
2468
  #
2258
2469
  # @!attribute [rw] cvss_source
2259
- # The source of the finding.
2470
+ # The source of the CVSS data that the Amazon Inspector score for the
2471
+ # finding is based on, for example NVD or a vendor security feed.
2260
2472
  # @return [String]
2261
2473
  #
2262
2474
  # @!attribute [rw] version
@@ -2272,8 +2484,9 @@ module Aws::Imagebuilder
2272
2484
  # @return [String]
2273
2485
  #
2274
2486
  # @!attribute [rw] adjustments
2275
- # An object that contains details about an adjustment that Amazon
2276
- # Inspector made to the CVSS score for the finding.
2487
+ # The adjustments that Amazon Inspector applied to the base CVSS score
2488
+ # to produce its own score for the finding. The list is empty when
2489
+ # Amazon Inspector made no adjustments.
2277
2490
  # @return [Array<Types::CvssScoreAdjustment>]
2278
2491
  #
2279
2492
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CvssScoreDetails AWS API Documentation
@@ -2554,10 +2767,19 @@ module Aws::Imagebuilder
2554
2767
  end
2555
2768
 
2556
2769
  # @!attribute [rw] source_image
2557
- # The source image to distribute. Specify an AMI identifier, SSM
2558
- # parameter path, or Image Builder image Amazon Resource Name (ARN).
2559
- # When you specify an Image Builder image Amazon Resource Name (ARN),
2560
- # the image must be in the `AVAILABLE` state.
2770
+ # The source image to distribute. You can specify the source in any of
2771
+ # the following formats:
2772
+ #
2773
+ # * An AMI ID.
2774
+ #
2775
+ # * An Amazon Web Services Systems Manager Parameter Store reference,
2776
+ # prefixed by `ssm:`, followed by the parameter name or ARN.
2777
+ #
2778
+ # * An Image Builder image Amazon Resource Name (ARN). An image
2779
+ # version ARN resolves to the latest available build version.
2780
+ #
2781
+ # Whichever format you use, the source must resolve to an AMI in the
2782
+ # current Amazon Web Services Region.
2561
2783
  # @return [String]
2562
2784
  #
2563
2785
  # @!attribute [rw] distribution_configuration_arn
@@ -2573,15 +2795,17 @@ module Aws::Imagebuilder
2573
2795
  # @return [String]
2574
2796
  #
2575
2797
  # @!attribute [rw] tags
2576
- # The tags to apply to the distributed image.
2798
+ # The tags to apply to the new Image Builder image resource that this
2799
+ # operation creates. To tag the output AMIs, use `amiTags` in the
2800
+ # distribution configuration.
2577
2801
  # @return [Hash<String,String>]
2578
2802
  #
2579
2803
  # @!attribute [rw] client_token
2580
2804
  # A unique, case-sensitive identifier you provide to ensure that the
2581
- # operation completes no more than one time. If this token matches a
2582
- # previous request, the service ignores the request, but does not
2583
- # return an error. For more information, see [Ensuring idempotency][1]
2584
- # in the *Amazon EC2 API Reference*.
2805
+ # operation runs no more than one time. If you retry a request with
2806
+ # the same client token, Image Builder returns the original response
2807
+ # without running the operation again. For more information, see
2808
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
2585
2809
  #
2586
2810
  # **A suitable default value is auto-generated.** You should normally
2587
2811
  # not need to pass this option.
@@ -2613,7 +2837,9 @@ module Aws::Imagebuilder
2613
2837
  # @return [String]
2614
2838
  #
2615
2839
  # @!attribute [rw] image_build_version_arn
2616
- # The Amazon Resource Name (ARN) of the image to be distributed.
2840
+ # The Amazon Resource Name (ARN) of the new Image Builder image
2841
+ # resource that this operation creates to track the distribution. Use
2842
+ # this ARN with GetImage to monitor distribution progress.
2617
2843
  # @return [String]
2618
2844
  #
2619
2845
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DistributeImageResponse AWS API Documentation
@@ -2683,7 +2909,14 @@ module Aws::Imagebuilder
2683
2909
  include Aws::Structure
2684
2910
  end
2685
2911
 
2686
- # A distribution configuration.
2912
+ # Defines how Image Builder distributes the output of an image build.
2913
+ # You can configure:
2914
+ #
2915
+ # * The Regions to distribute the image to.
2916
+ #
2917
+ # * The Region-specific settings to apply, such as output AMI names,
2918
+ # launch permissions for other Amazon Web Services accounts, and
2919
+ # target container repositories.
2687
2920
  #
2688
2921
  # @!attribute [rw] arn
2689
2922
  # The Amazon Resource Name (ARN) of the distribution configuration.
@@ -2703,7 +2936,9 @@ module Aws::Imagebuilder
2703
2936
  # @return [Array<Types::Distribution>]
2704
2937
  #
2705
2938
  # @!attribute [rw] timeout_minutes
2706
- # The maximum duration in minutes for this distribution configuration.
2939
+ # A property that Image Builder doesn't use. You can't set this
2940
+ # property when you create or update a distribution configuration, and
2941
+ # it has no effect on distribution behavior.
2707
2942
  # @return [Integer]
2708
2943
  #
2709
2944
  # @!attribute [rw] date_created
@@ -2760,7 +2995,8 @@ module Aws::Imagebuilder
2760
2995
  # @return [Hash<String,String>]
2761
2996
  #
2762
2997
  # @!attribute [rw] regions
2763
- # A list of Regions where the container image is distributed to.
2998
+ # A list of the Regions that the distribution configuration
2999
+ # distributes images to.
2764
3000
  # @return [Array<String>]
2765
3001
  #
2766
3002
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DistributionConfigurationSummary AWS API Documentation
@@ -2876,12 +3112,13 @@ module Aws::Imagebuilder
2876
3112
  # the output container images that Amazon Inspector scans.
2877
3113
  #
2878
3114
  # @!attribute [rw] repository_name
2879
- # The name of the container repository that Amazon Inspector scans to
2880
- # identify findings for your container images. The name includes the
2881
- # path for the repository location. If you don’t provide this
2882
- # information, Image Builder creates a repository in your account
2883
- # named `image-builder-image-scanning-repository` for vulnerability
2884
- # scans of your output container images.
3115
+ # The name of the container repository where Image Builder pushes the
3116
+ # container image for the vulnerability scan. Provide the repository
3117
+ # name only (a namespace path is allowed, but not the registry
3118
+ # hostname); the repository must already exist in your account. If you
3119
+ # don't specify a repository name, Image Builder creates the default
3120
+ # repository `image-builder-image-scanning-repository` in your
3121
+ # account.
2885
3122
  # @return [String]
2886
3123
  #
2887
3124
  # @!attribute [rw] container_tags
@@ -2899,18 +3136,18 @@ module Aws::Imagebuilder
2899
3136
  include Aws::Structure
2900
3137
  end
2901
3138
 
2902
- # Define and configure faster launching for output Windows AMIs.
3139
+ # Defines and configures EC2 Fast Launch for output Windows AMIs.
2903
3140
  #
2904
3141
  # @!attribute [rw] enabled
2905
- # A Boolean that represents the current state of faster launching for
2906
- # the Windows AMI. Set to `true` to start using Windows faster
2907
- # launching, or `false` to stop using it.
3142
+ # Specifies whether to enable Windows fast launch on the output AMI
3143
+ # during distribution. A value of `false` means Image Builder takes no
3144
+ # fast-launch action for this configuration.
2908
3145
  # @return [Boolean]
2909
3146
  #
2910
3147
  # @!attribute [rw] snapshot_configuration
2911
3148
  # Configuration settings for managing the number of snapshots that are
2912
3149
  # created from pre-provisioned instances for the Windows AMI when
2913
- # faster launching is enabled.
3150
+ # Windows fast launch is enabled.
2914
3151
  # @return [Types::FastLaunchSnapshotConfiguration]
2915
3152
  #
2916
3153
  # @!attribute [rw] max_parallel_launches
@@ -2941,7 +3178,7 @@ module Aws::Imagebuilder
2941
3178
  end
2942
3179
 
2943
3180
  # Identifies the launch template that the associated Windows AMI uses
2944
- # for launching an instance when faster launching is enabled.
3181
+ # for launching an instance when Windows fast launch is enabled.
2945
3182
  #
2946
3183
  # <note markdown="1"> You can specify either the `launchTemplateName` or the
2947
3184
  # `launchTemplateId`, but not both.
@@ -2949,18 +3186,18 @@ module Aws::Imagebuilder
2949
3186
  # </note>
2950
3187
  #
2951
3188
  # @!attribute [rw] launch_template_id
2952
- # The ID of the launch template to use for faster launching for a
3189
+ # The ID of the launch template to use for Windows fast launch for a
2953
3190
  # Windows AMI.
2954
3191
  # @return [String]
2955
3192
  #
2956
3193
  # @!attribute [rw] launch_template_name
2957
- # The name of the launch template to use for faster launching for a
3194
+ # The name of the launch template to use for Windows fast launch for a
2958
3195
  # Windows AMI.
2959
3196
  # @return [String]
2960
3197
  #
2961
3198
  # @!attribute [rw] launch_template_version
2962
- # The version of the launch template to use for faster launching for a
2963
- # Windows AMI.
3199
+ # The version of the launch template to use for Windows fast launch
3200
+ # for a Windows AMI.
2964
3201
  # @return [String]
2965
3202
  #
2966
3203
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/FastLaunchLaunchTemplateSpecification AWS API Documentation
@@ -3056,7 +3293,10 @@ module Aws::Imagebuilder
3056
3293
 
3057
3294
  # @!attribute [rw] component_build_version_arn
3058
3295
  # The Amazon Resource Name (ARN) of the component that you want to
3059
- # get. Regex requires the suffix `/\d+$`.
3296
+ # get. You can specify a build version ARN, or a component version
3297
+ # ARN. The version can use the `x` wildcard in trailing positions, for
3298
+ # example `1.0.x` or `1.x.x`. Version ARNs resolve to the latest
3299
+ # available matching component build version.
3060
3300
  # @return [String]
3061
3301
  #
3062
3302
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetComponentRequest AWS API Documentation
@@ -3076,8 +3316,10 @@ module Aws::Imagebuilder
3076
3316
  # @return [Types::Component]
3077
3317
  #
3078
3318
  # @!attribute [rw] latest_version_references
3079
- # The resource ARNs with different wildcard variations of semantic
3080
- # versioning.
3319
+ # A set of wildcard version ARNs that always reference the latest
3320
+ # version of the resource. ARNs are included for the latest version
3321
+ # overall, and for the latest versions within the same major, minor,
3322
+ # and patch levels.
3081
3323
  # @return [Types::LatestVersionReferences]
3082
3324
  #
3083
3325
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetComponentResponse AWS API Documentation
@@ -3108,7 +3350,9 @@ module Aws::Imagebuilder
3108
3350
  # @return [String]
3109
3351
  #
3110
3352
  # @!attribute [rw] policy
3111
- # The container recipe policy object that is returned.
3353
+ # The resource policy for the container recipe, as a JSON policy
3354
+ # document. If no policy has been applied, the response contains an
3355
+ # empty JSON object (`{}`).
3112
3356
  # @return [String]
3113
3357
  #
3114
3358
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetContainerRecipePolicyResponse AWS API Documentation
@@ -3141,8 +3385,10 @@ module Aws::Imagebuilder
3141
3385
  # @return [Types::ContainerRecipe]
3142
3386
  #
3143
3387
  # @!attribute [rw] latest_version_references
3144
- # The resource ARNs with different wildcard variations of semantic
3145
- # versioning.
3388
+ # A set of wildcard version ARNs that always reference the latest
3389
+ # version of the resource. ARNs are included for the latest version
3390
+ # overall, and for the latest versions within the same major, minor,
3391
+ # and patch levels.
3146
3392
  # @return [Types::LatestVersionReferences]
3147
3393
  #
3148
3394
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetContainerRecipeResponse AWS API Documentation
@@ -3233,7 +3479,9 @@ module Aws::Imagebuilder
3233
3479
  # @return [String]
3234
3480
  #
3235
3481
  # @!attribute [rw] policy
3236
- # The image policy object.
3482
+ # The resource policy for the image, as a JSON policy document. If the
3483
+ # image has no policy applied, the response contains an empty JSON
3484
+ # object (`{}`).
3237
3485
  # @return [String]
3238
3486
  #
3239
3487
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImagePolicyResponse AWS API Documentation
@@ -3263,7 +3511,9 @@ module Aws::Imagebuilder
3263
3511
  # @return [String]
3264
3512
  #
3265
3513
  # @!attribute [rw] policy
3266
- # The image recipe policy object.
3514
+ # The resource policy for the image recipe, as a JSON policy document.
3515
+ # If no policy has been applied, the response contains an empty JSON
3516
+ # object (`{}`).
3267
3517
  # @return [String]
3268
3518
  #
3269
3519
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageRecipePolicyResponse AWS API Documentation
@@ -3277,7 +3527,9 @@ module Aws::Imagebuilder
3277
3527
 
3278
3528
  # @!attribute [rw] image_recipe_arn
3279
3529
  # The Amazon Resource Name (ARN) of the image recipe that you want to
3280
- # retrieve.
3530
+ # retrieve. You can use the `x` wildcard in trailing version positions
3531
+ # to retrieve the latest matching version, for example `x.x.x` or
3532
+ # `1.x.x`.
3281
3533
  # @return [String]
3282
3534
  #
3283
3535
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageRecipeRequest AWS API Documentation
@@ -3297,8 +3549,10 @@ module Aws::Imagebuilder
3297
3549
  # @return [Types::ImageRecipe]
3298
3550
  #
3299
3551
  # @!attribute [rw] latest_version_references
3300
- # The resource ARNs with different wildcard variations of semantic
3301
- # versioning.
3552
+ # A set of wildcard version ARNs that always reference the latest
3553
+ # version of the resource. ARNs are included for the latest version
3554
+ # overall, and for the latest versions within the same major, minor,
3555
+ # and patch levels.
3302
3556
  # @return [Types::LatestVersionReferences]
3303
3557
  #
3304
3558
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageRecipeResponse AWS API Documentation
@@ -3313,6 +3567,13 @@ module Aws::Imagebuilder
3313
3567
 
3314
3568
  # @!attribute [rw] image_build_version_arn
3315
3569
  # The Amazon Resource Name (ARN) of the image that you want to get.
3570
+ # You can specify a full build version ARN, or a version ARN with or
3571
+ # without wildcards (`x.x.x`, `1.x.x`, or `1.0.x`). A version or
3572
+ # wildcard ARN resolves to the latest matching build version that has
3573
+ # reached `AVAILABLE` status. Builds that were later deprecated,
3574
+ # disabled, or deleted don't resolve. To get an image in any other
3575
+ # state, such as a failed or in-progress build, specify the full build
3576
+ # version ARN.
3316
3577
  # @return [String]
3317
3578
  #
3318
3579
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageRequest AWS API Documentation
@@ -3332,8 +3593,10 @@ module Aws::Imagebuilder
3332
3593
  # @return [Types::Image]
3333
3594
  #
3334
3595
  # @!attribute [rw] latest_version_references
3335
- # The resource ARNs with different wildcard variations of semantic
3336
- # versioning.
3596
+ # A set of wildcard version ARNs that always reference the latest
3597
+ # version of the resource. ARNs are included for the latest version
3598
+ # overall, and for the latest versions within the same major, minor,
3599
+ # and patch levels.
3337
3600
  # @return [Types::LatestVersionReferences]
3338
3601
  #
3339
3602
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageResponse AWS API Documentation
@@ -3420,8 +3683,7 @@ module Aws::Imagebuilder
3420
3683
  end
3421
3684
 
3422
3685
  # @!attribute [rw] lifecycle_policy
3423
- # The Amazon Resource Name (ARN) of the image lifecycle policy
3424
- # resource that was returned.
3686
+ # The details of the lifecycle policy that the request retrieved.
3425
3687
  # @return [Types::LifecyclePolicy]
3426
3688
  #
3427
3689
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetLifecyclePolicyResponse AWS API Documentation
@@ -3443,8 +3705,8 @@ module Aws::Imagebuilder
3443
3705
  # @return [String]
3444
3706
  #
3445
3707
  # @!attribute [rw] resource_location
3446
- # The bucket path that you can specify to download the resource from
3447
- # Amazon S3.
3708
+ # The Amazon S3 location of the component artifact to retrieve, in
3709
+ # `s3://bucket/key` form.
3448
3710
  # @return [String]
3449
3711
  #
3450
3712
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetMarketplaceResourceRequest AWS API Documentation
@@ -3463,7 +3725,8 @@ module Aws::Imagebuilder
3463
3725
  # @return [String]
3464
3726
  #
3465
3727
  # @!attribute [rw] url
3466
- # The obfuscated S3 URL to download the component artifact from.
3728
+ # A time-limited presigned URL for downloading the component artifact
3729
+ # from Amazon S3.
3467
3730
  # @return [String]
3468
3731
  #
3469
3732
  # @!attribute [rw] data
@@ -3510,8 +3773,8 @@ module Aws::Imagebuilder
3510
3773
  # @return [String]
3511
3774
  #
3512
3775
  # @!attribute [rw] image_build_version_arn
3513
- # The Amazon Resource Name (ARN) of the image resource build version
3514
- # that the specified runtime instance of the workflow created.
3776
+ # The Amazon Resource Name (ARN) of the image build version that owns
3777
+ # the specified runtime instance of the workflow.
3515
3778
  # @return [String]
3516
3779
  #
3517
3780
  # @!attribute [rw] type
@@ -3521,7 +3784,8 @@ module Aws::Imagebuilder
3521
3784
  #
3522
3785
  # @!attribute [rw] status
3523
3786
  # The current runtime status for the specified runtime instance of the
3524
- # workflow.
3787
+ # workflow. `COMPLETED`, `FAILED`, `ROLLBACK_COMPLETED`, `CANCELLED`,
3788
+ # and `SKIPPED` are terminal states.
3525
3789
  # @return [String]
3526
3790
  #
3527
3791
  # @!attribute [rw] message
@@ -3530,9 +3794,11 @@ module Aws::Imagebuilder
3530
3794
  # @return [String]
3531
3795
  #
3532
3796
  # @!attribute [rw] total_step_count
3533
- # The total number of steps in the specified runtime instance of the
3534
- # workflow that ran. This number should equal the sum of the step
3535
- # counts for steps that succeeded, were skipped, and failed.
3797
+ # The total number of steps that the workflow document defines for
3798
+ # this runtime instance of the workflow. Image Builder sets this count
3799
+ # before any steps run. The sum of succeeded, skipped, and failed
3800
+ # steps only reaches this total if every step finishes in one of those
3801
+ # states.
3536
3802
  # @return [Integer]
3537
3803
  #
3538
3804
  # @!attribute [rw] total_steps_succeeded
@@ -3561,8 +3827,9 @@ module Aws::Imagebuilder
3561
3827
  # @return [String]
3562
3828
  #
3563
3829
  # @!attribute [rw] parallel_group
3564
- # Test workflows are defined within named runtime groups. The parallel
3565
- # group is a named group that contains one or more test workflows.
3830
+ # The name of the parallel group that this runtime instance of the
3831
+ # workflow ran in, if configured. Parallel groups apply only to test
3832
+ # workflows.
3566
3833
  # @return [String]
3567
3834
  #
3568
3835
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetWorkflowExecutionResponse AWS API Documentation
@@ -3588,7 +3855,10 @@ module Aws::Imagebuilder
3588
3855
 
3589
3856
  # @!attribute [rw] workflow_build_version_arn
3590
3857
  # The Amazon Resource Name (ARN) of the workflow resource that you
3591
- # want to get.
3858
+ # want to get. You can specify a build version ARN, or a version ARN
3859
+ # with or without wildcards (`x`) in its version segments. Image
3860
+ # Builder resolves version and wildcard ARNs to the most recent
3861
+ # matching build version.
3592
3862
  # @return [String]
3593
3863
  #
3594
3864
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetWorkflowRequest AWS API Documentation
@@ -3604,8 +3874,10 @@ module Aws::Imagebuilder
3604
3874
  # @return [Types::Workflow]
3605
3875
  #
3606
3876
  # @!attribute [rw] latest_version_references
3607
- # The resource ARNs with different wildcard variations of semantic
3608
- # versioning.
3877
+ # A set of wildcard version ARNs that always reference the latest
3878
+ # version of the resource. ARNs are included for the latest version
3879
+ # overall, and for the latest versions within the same major, minor,
3880
+ # and patch levels.
3609
3881
  # @return [Types::LatestVersionReferences]
3610
3882
  #
3611
3883
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetWorkflowResponse AWS API Documentation
@@ -3618,8 +3890,9 @@ module Aws::Imagebuilder
3618
3890
  end
3619
3891
 
3620
3892
  # @!attribute [rw] step_execution_id
3621
- # Use the unique identifier for a specific runtime instance of the
3622
- # workflow step to get runtime details for that step.
3893
+ # The unique identifier for the runtime instance of the workflow step
3894
+ # that you want to get runtime details for. To get the identifiers for
3895
+ # the steps that ran in a workflow, call ListWorkflowStepExecutions.
3623
3896
  # @return [String]
3624
3897
  #
3625
3898
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetWorkflowStepExecutionRequest AWS API Documentation
@@ -3635,7 +3908,7 @@ module Aws::Imagebuilder
3635
3908
  # @return [String]
3636
3909
  #
3637
3910
  # @!attribute [rw] step_execution_id
3638
- # The unique identifier for the runtime version of the workflow step
3911
+ # The unique identifier for the runtime instance of the workflow step
3639
3912
  # that you specified in the request.
3640
3913
  # @return [String]
3641
3914
  #
@@ -3650,8 +3923,8 @@ module Aws::Imagebuilder
3650
3923
  # @return [String]
3651
3924
  #
3652
3925
  # @!attribute [rw] image_build_version_arn
3653
- # The Amazon Resource Name (ARN) of the image resource build version
3654
- # that the specified runtime instance of the workflow step creates.
3926
+ # The Amazon Resource Name (ARN) of the image build version that owns
3927
+ # the specified runtime instance of the workflow step.
3655
3928
  # @return [String]
3656
3929
  #
3657
3930
  # @!attribute [rw] name
@@ -3667,13 +3940,14 @@ module Aws::Imagebuilder
3667
3940
  # @return [String]
3668
3941
  #
3669
3942
  # @!attribute [rw] status
3670
- # The current status for the specified runtime version of the workflow
3671
- # step.
3943
+ # The current status for the specified runtime instance of the
3944
+ # workflow step.
3672
3945
  # @return [String]
3673
3946
  #
3674
3947
  # @!attribute [rw] rollback_status
3675
- # Reports on the rollback status of the specified runtime version of
3676
- # the workflow step, if applicable.
3948
+ # Reports on the rollback status of the specified runtime instance of
3949
+ # the workflow step, if applicable. Rollback runs when the workflow
3950
+ # execution fails, and undoes the work that completed steps performed.
3677
3951
  # @return [String]
3678
3952
  #
3679
3953
  # @!attribute [rw] message
@@ -3683,16 +3957,18 @@ module Aws::Imagebuilder
3683
3957
  #
3684
3958
  # @!attribute [rw] inputs
3685
3959
  # Input parameters that Image Builder provided for the specified
3686
- # runtime instance of the workflow step.
3960
+ # runtime instance of the workflow step, as a JSON-encoded string.
3687
3961
  # @return [String]
3688
3962
  #
3689
3963
  # @!attribute [rw] outputs
3690
- # The file names that the specified runtime version of the workflow
3691
- # step created as output.
3964
+ # The output values that the specified runtime instance of the
3965
+ # workflow step produced, as a JSON-encoded string. For example, a
3966
+ # step that launches an instance outputs the instance ID. If the step
3967
+ # failed, this field contains the error message.
3692
3968
  # @return [String]
3693
3969
  #
3694
3970
  # @!attribute [rw] start_time
3695
- # The timestamp when the specified runtime version of the workflow
3971
+ # The timestamp when the specified runtime instance of the workflow
3696
3972
  # step started.
3697
3973
  # @return [String]
3698
3974
  #
@@ -3702,12 +3978,17 @@ module Aws::Imagebuilder
3702
3978
  # @return [String]
3703
3979
  #
3704
3980
  # @!attribute [rw] on_failure
3705
- # The action to perform if the workflow step fails.
3981
+ # The action that the workflow takes if this step fails, as configured
3982
+ # in the workflow document. `Abort` fails the workflow and rolls back
3983
+ # completed steps. `Continue` proceeds to the next step. If the step
3984
+ # doesn't set a value, it defaults to `Abort`.
3706
3985
  # @return [String]
3707
3986
  #
3708
3987
  # @!attribute [rw] timeout_seconds
3709
3988
  # The maximum duration in seconds for this step to complete its
3710
- # action.
3989
+ # action. If the workflow document doesn't set a timeout for the
3990
+ # step, Image Builder applies the default timeout for the step's
3991
+ # action. This field returns that value.
3711
3992
  # @return [Integer]
3712
3993
  #
3713
3994
  # @!attribute [rw] attempt_number
@@ -3766,9 +4047,10 @@ module Aws::Imagebuilder
3766
4047
 
3767
4048
  # An Image Builder image resource that keeps track of all of the
3768
4049
  # settings used to create, configure, and distribute output for that
3769
- # image. You must specify exactly one recipe for the image – either a
3770
- # container recipe (`containerRecipe`), which creates a container image,
3771
- # or an image recipe (`imageRecipe`), which creates an AMI.
4050
+ # image. An image that Image Builder built from a recipe contains
4051
+ # exactly one recipe – either a container recipe (`containerRecipe`),
4052
+ # which creates a container image, or an image recipe (`imageRecipe`),
4053
+ # which creates an AMI. Imported images don't contain a recipe.
3772
4054
  #
3773
4055
  # @!attribute [rw] arn
3774
4056
  # The Amazon Resource Name (ARN) of the image.
@@ -3855,12 +4137,15 @@ module Aws::Imagebuilder
3855
4137
  # @return [Types::ContainerRecipe]
3856
4138
  #
3857
4139
  # @!attribute [rw] source_pipeline_name
3858
- # The name of the image pipeline that created this image.
4140
+ # The name of the image pipeline that created this image. Image
4141
+ # Builder doesn't return this field for new images. Use
4142
+ # `sourcePipelineArn` instead.
3859
4143
  # @return [String]
3860
4144
  #
3861
4145
  # @!attribute [rw] source_pipeline_arn
3862
4146
  # The Amazon Resource Name (ARN) of the image pipeline that created
3863
- # this image.
4147
+ # this image. This field is only present for images that a pipeline
4148
+ # execution created.
3864
4149
  # @return [String]
3865
4150
  #
3866
4151
  # @!attribute [rw] infrastructure_configuration
@@ -3873,7 +4158,8 @@ module Aws::Imagebuilder
3873
4158
  # @return [Types::DistributionConfiguration]
3874
4159
  #
3875
4160
  # @!attribute [rw] image_tests_configuration
3876
- # The image tests that ran when that Image Builder created this image.
4161
+ # The image test settings that Image Builder used when it created this
4162
+ # image.
3877
4163
  # @return [Types::ImageTestsConfiguration]
3878
4164
  #
3879
4165
  # @!attribute [rw] date_created
@@ -3914,7 +4200,10 @@ module Aws::Imagebuilder
3914
4200
  # @return [Types::ImageScanState]
3915
4201
  #
3916
4202
  # @!attribute [rw] image_scanning_configuration
3917
- # Contains settings for vulnerability scans.
4203
+ # Settings for the vulnerability scans that Amazon Inspector runs for
4204
+ # this image. For AMI output, Amazon Inspector scans the test instance
4205
+ # during image creation. For container output, Amazon Inspector scans
4206
+ # the container image in its Amazon ECR repository.
3918
4207
  # @return [Types::ImageScanningConfiguration]
3919
4208
  #
3920
4209
  # @!attribute [rw] deprecation_time
@@ -3933,8 +4222,8 @@ module Aws::Imagebuilder
3933
4222
  # @return [String]
3934
4223
  #
3935
4224
  # @!attribute [rw] workflows
3936
- # Contains the build and test workflows that are associated with the
3937
- # image.
4225
+ # The build, test, and distribution workflow configurations that are
4226
+ # associated with the image.
3938
4227
  # @return [Array<Types::WorkflowConfiguration>]
3939
4228
  #
3940
4229
  # @!attribute [rw] logging_configuration
@@ -4070,8 +4359,9 @@ module Aws::Imagebuilder
4070
4359
  include Aws::Structure
4071
4360
  end
4072
4361
 
4073
- # A software package that's installed on top of the base image to
4074
- # create a customized image.
4362
+ # A software package that's installed on an image, as detected by
4363
+ # Amazon Web Services Systems Manager Inventory at build time. The list
4364
+ # includes packages that shipped with the base image.
4075
4365
  #
4076
4366
  # @!attribute [rw] package_name
4077
4367
  # The name of the package that's reported to the operating system
@@ -4092,7 +4382,11 @@ module Aws::Imagebuilder
4092
4382
  include Aws::Structure
4093
4383
  end
4094
4384
 
4095
- # Details of an image pipeline.
4385
+ # Defines the automation configuration for building, testing, and
4386
+ # distributing images. A pipeline references the resources that its
4387
+ # builds use, such as the recipe and infrastructure configuration. It
4388
+ # also holds the settings that control its builds, such as the schedule
4389
+ # and custom workflows.
4096
4390
  #
4097
4391
  # @!attribute [rw] arn
4098
4392
  # The Amazon Resource Name (ARN) of the image pipeline.
@@ -4107,7 +4401,8 @@ module Aws::Imagebuilder
4107
4401
  # @return [String]
4108
4402
  #
4109
4403
  # @!attribute [rw] platform
4110
- # The platform of the image pipeline.
4404
+ # The platform of the image pipeline, inherited from the recipe that
4405
+ # the pipeline uses.
4111
4406
  # @return [String]
4112
4407
  #
4113
4408
  # @!attribute [rw] enhanced_image_metadata_enabled
@@ -4145,7 +4440,10 @@ module Aws::Imagebuilder
4145
4440
  # @return [Types::Schedule]
4146
4441
  #
4147
4442
  # @!attribute [rw] status
4148
- # The status of the image pipeline.
4443
+ # The status of the image pipeline. A disabled pipeline doesn't run
4444
+ # on its schedule, but you can still start builds manually. Image
4445
+ # Builder can also disable a pipeline automatically when consecutive
4446
+ # scheduled builds fail.
4149
4447
  # @return [String]
4150
4448
  #
4151
4449
  # @!attribute [rw] date_created
@@ -4157,7 +4455,7 @@ module Aws::Imagebuilder
4157
4455
  # @return [String]
4158
4456
  #
4159
4457
  # @!attribute [rw] date_last_run
4160
- # This is no longer supported, and does not return a value.
4458
+ # The date on which this image pipeline was last run.
4161
4459
  # @return [String]
4162
4460
  #
4163
4461
  # @!attribute [rw] last_run_status
@@ -4174,11 +4472,20 @@ module Aws::Imagebuilder
4174
4472
  # @return [Hash<String,String>]
4175
4473
  #
4176
4474
  # @!attribute [rw] image_scanning_configuration
4177
- # Contains settings for vulnerability scans.
4475
+ # Contains settings for vulnerability scans that Amazon Inspector runs
4476
+ # against the test instance during image creation.
4178
4477
  # @return [Types::ImageScanningConfiguration]
4179
4478
  #
4180
4479
  # @!attribute [rw] image_tags
4181
- # The tags to be applied to the images produced by this pipeline.
4480
+ # The tags that Image Builder applies to the Image Builder image
4481
+ # resource that this pipeline's scheduled executions create. These
4482
+ # tags don't apply to the output AMI. Builds that you start manually
4483
+ # use the tags from the [StartImagePipelineExecution][1] request
4484
+ # instead.
4485
+ #
4486
+ #
4487
+ #
4488
+ # [1]: https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_StartImagePipelineExecution.html
4182
4489
  # @return [Hash<String,String>]
4183
4490
  #
4184
4491
  # @!attribute [rw] execution_role
@@ -4191,7 +4498,8 @@ module Aws::Imagebuilder
4191
4498
  # @return [Array<Types::WorkflowConfiguration>]
4192
4499
  #
4193
4500
  # @!attribute [rw] logging_configuration
4194
- # Defines logging configuration for the output image.
4501
+ # The CloudWatch Logs configuration for the pipeline: the log group
4502
+ # for image build logs and the log group for pipeline execution logs.
4195
4503
  # @return [Types::PipelineLoggingConfiguration]
4196
4504
  #
4197
4505
  # @!attribute [rw] consecutive_failures
@@ -4203,9 +4511,9 @@ module Aws::Imagebuilder
4203
4511
  # failures resets to zero.
4204
4512
  #
4205
4513
  # * If the pipeline execution fails, Image Builder increments the
4206
- # number of consecutive failures. If the failure count exceeds the
4207
- # limit defined in the `AutoDisablePolicy`, Image Builder disables
4208
- # the pipeline.
4514
+ # number of consecutive failures. If the failure count reaches the
4515
+ # limit defined in the AutoDisablePolicy, Image Builder disables the
4516
+ # pipeline.
4209
4517
  #
4210
4518
  # The consecutive failure count is also reset to zero under the
4211
4519
  # following conditions:
@@ -4279,8 +4587,9 @@ module Aws::Imagebuilder
4279
4587
  # @return [String]
4280
4588
  #
4281
4589
  # @!attribute [rw] type
4282
- # Specifies which type of image is created by the recipe - an AMI or a
4283
- # container image.
4590
+ # The output image type. For an image recipe, this is always AMI.
4591
+ # Container images are built from container recipes, a separate
4592
+ # resource. This field isn't currently returned in responses.
4284
4593
  # @return [String]
4285
4594
  #
4286
4595
  # @!attribute [rw] name
@@ -4304,9 +4613,15 @@ module Aws::Imagebuilder
4304
4613
  # @return [String]
4305
4614
  #
4306
4615
  # @!attribute [rw] components
4307
- # The components that are included in the image recipe. Recipes
4308
- # require a minimum of one build component, and can have a maximum of
4309
- # 20 build and test components in any combination.
4616
+ # The components that are included in the image recipe. A recipe can
4617
+ # contain a maximum of 20 build and test components in any
4618
+ # combination, by default. This maximum is an adjustable quota. For
4619
+ # more information, see [EC2 Image Builder endpoints and quotas][1] in
4620
+ # the *Amazon Web Services General Reference*.
4621
+ #
4622
+ #
4623
+ #
4624
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html
4310
4625
  # @return [Array<Types::ComponentConfiguration>]
4311
4626
  #
4312
4627
  # @!attribute [rw] parent_image
@@ -4338,15 +4653,18 @@ module Aws::Imagebuilder
4338
4653
  # @return [Hash<String,String>]
4339
4654
  #
4340
4655
  # @!attribute [rw] working_directory
4341
- # The working directory to be used during build and test workflows.
4656
+ # The working directory used during build and test workflows. If you
4657
+ # don't specify a working directory, Image Builder uses `/tmp` for
4658
+ # Linux and macOS build instances, and `C:/` for Windows build
4659
+ # instances.
4342
4660
  # @return [String]
4343
4661
  #
4344
4662
  # @!attribute [rw] additional_instance_configuration
4345
4663
  # Before you create a new AMI, Image Builder launches temporary Amazon
4346
4664
  # EC2 instances to build and test your image configuration. Instance
4347
4665
  # configuration adds a layer of control over those instances. You can
4348
- # define settings and add scripts to run when an instance is launched
4349
- # from your AMI.
4666
+ # define settings and add scripts to run when Image Builder launches
4667
+ # your build instance.
4350
4668
  # @return [Types::AdditionalInstanceConfiguration]
4351
4669
  #
4352
4670
  # @!attribute [rw] ami_tags
@@ -4427,7 +4745,8 @@ module Aws::Imagebuilder
4427
4745
  include Aws::Structure
4428
4746
  end
4429
4747
 
4430
- # Contains details about a vulnerability scan finding.
4748
+ # Contains details about a vulnerability scan finding that Amazon
4749
+ # Inspector generated for an image.
4431
4750
  #
4432
4751
  # @!attribute [rw] aws_account_id
4433
4752
  # The Amazon Web Services account ID that's associated with the
@@ -4464,7 +4783,13 @@ module Aws::Imagebuilder
4464
4783
  # @return [Types::Remediation]
4465
4784
  #
4466
4785
  # @!attribute [rw] severity
4467
- # The severity of the finding.
4786
+ # The severity of the finding. For more information, see [Severity
4787
+ # levels for Amazon Inspector findings][1] in the *Amazon Inspector
4788
+ # User Guide*.
4789
+ #
4790
+ #
4791
+ #
4792
+ # [1]: https://docs.aws.amazon.com/inspector/latest/user/findings-understanding-severity.html
4468
4793
  # @return [String]
4469
4794
  #
4470
4795
  # @!attribute [rw] first_observed_at
@@ -4490,7 +4815,16 @@ module Aws::Imagebuilder
4490
4815
  #
4491
4816
  # @!attribute [rw] fix_available
4492
4817
  # Details about whether a fix is available for any of the packages
4493
- # that are identified in the finding through a version update.
4818
+ # that are identified in the finding through a version update. Valid
4819
+ # values include:
4820
+ #
4821
+ # * `YES` – A fix is available for all of the packages identified in
4822
+ # the finding.
4823
+ #
4824
+ # * `NO` – No fix is available.
4825
+ #
4826
+ # * `PARTIAL` – A fix is available for some, but not all, of the
4827
+ # packages identified in the finding.
4494
4828
  # @return [String]
4495
4829
  #
4496
4830
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImageScanFinding AWS API Documentation
@@ -4553,7 +4887,18 @@ module Aws::Imagebuilder
4553
4887
  #
4554
4888
  # @!attribute [rw] name
4555
4889
  # The name of the image scan finding filter. Filter names are
4556
- # case-sensitive.
4890
+ # case-sensitive. Valid filter names are:
4891
+ #
4892
+ # * `imageBuildVersionArn` – Filters findings by the image build
4893
+ # version that was scanned.
4894
+ #
4895
+ # * `imagePipelineArn` – Filters findings by the pipeline that created
4896
+ # the scanned image.
4897
+ #
4898
+ # * `vulnerabilityId` – Filters findings by vulnerability ID, for
4899
+ # example a CVE ID.
4900
+ #
4901
+ # * `severity` – Filters findings by severity level.
4557
4902
  # @return [String]
4558
4903
  #
4559
4904
  # @!attribute [rw] values
@@ -4573,7 +4918,11 @@ module Aws::Imagebuilder
4573
4918
  # reason for that status.
4574
4919
  #
4575
4920
  # @!attribute [rw] status
4576
- # The current state of vulnerability scans for the image.
4921
+ # The current state of vulnerability scans for the image. The scan
4922
+ # starts as `PENDING` and moves through `SCANNING` and `COLLECTING` to
4923
+ # `COMPLETED`. Image Builder sets the status to `ABANDONED` if the
4924
+ # image reaches a terminal state before the scan finding collection
4925
+ # completes. A scan can also end as `FAILED` or `TIMED_OUT`.
4577
4926
  # @return [String]
4578
4927
  #
4579
4928
  # @!attribute [rw] reason
@@ -4593,9 +4942,13 @@ module Aws::Imagebuilder
4593
4942
  # scans.
4594
4943
  #
4595
4944
  # @!attribute [rw] image_scanning_enabled
4596
- # A setting that indicates whether Image Builder keeps a snapshot of
4597
- # the vulnerability scans that Amazon Inspector runs against the build
4598
- # instance when you create a new image.
4945
+ # Specifies whether Amazon Inspector scans for vulnerabilities when
4946
+ # you create a new image, and whether Image Builder saves the
4947
+ # findings. Amazon Inspector must be enabled in the account. Image
4948
+ # tests must also be enabled. For AMI output, Amazon Inspector scans
4949
+ # the test instance. For container output, Amazon Inspector scans the
4950
+ # container image that Image Builder pushes to the Amazon ECR
4951
+ # repository from your `ecrConfiguration` settings.
4599
4952
  # @return [Boolean]
4600
4953
  #
4601
4954
  # @!attribute [rw] ecr_configuration
@@ -4614,7 +4967,10 @@ module Aws::Imagebuilder
4614
4967
  # Image status and the reason for that status.
4615
4968
  #
4616
4969
  # @!attribute [rw] status
4617
- # The status of the image.
4970
+ # The status of the image. A new image moves through build, test, and
4971
+ # distribution statuses during creation, and ends in the `AVAILABLE`,
4972
+ # `FAILED`, or `CANCELLED` state. The `DEPRECATED`, `DISABLED`, and
4973
+ # `DELETED` statuses come from later resource management actions.
4618
4974
  # @return [String]
4619
4975
  #
4620
4976
  # @!attribute [rw] reason
@@ -4754,7 +5110,8 @@ module Aws::Imagebuilder
4754
5110
  # @return [Boolean]
4755
5111
  #
4756
5112
  # @!attribute [rw] timeout_minutes
4757
- # The maximum time in minutes that tests are permitted to run.
5113
+ # The maximum time in minutes that tests are permitted to run. If you
5114
+ # don't specify a value, Image Builder stores and returns 720.
4758
5115
  #
4759
5116
  # <note markdown="1"> The timeout property is not currently active. This value is ignored.
4760
5117
  #
@@ -4802,8 +5159,8 @@ module Aws::Imagebuilder
4802
5159
  # @return [String]
4803
5160
  #
4804
5161
  # @!attribute [rw] version
4805
- # Details for a specific version of an Image Builder image. This
4806
- # version follows the semantic version syntax.
5162
+ # The semantic version of the image. This version follows the semantic
5163
+ # version syntax.
4807
5164
  #
4808
5165
  # <note markdown="1"> The semantic version has four nodes:
4809
5166
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
@@ -4833,9 +5190,8 @@ module Aws::Imagebuilder
4833
5190
  # @return [String]
4834
5191
  #
4835
5192
  # @!attribute [rw] os_version
4836
- # The operating system version of the Amazon EC2 build instance. For
4837
- # example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server
4838
- # 2019.
5193
+ # The operating system version of the image. For example, Amazon Linux
5194
+ # 2023 or Microsoft Windows Server 2022.
4839
5195
  # @return [String]
4840
5196
  #
4841
5197
  # @!attribute [rw] owner
@@ -4885,7 +5241,14 @@ module Aws::Imagebuilder
4885
5241
  end
4886
5242
 
4887
5243
  # @!attribute [rw] name
4888
- # The name of the component.
5244
+ # The name of the component. Image Builder generates the component ARN
5245
+ # from a normalized form of the name, so names that differ only in
5246
+ # case, spaces, or underscores count as the same name. If a component
5247
+ # with the same name and semantic version already exists in your
5248
+ # account in the same Amazon Web Services Region, the request creates
5249
+ # a new build version for it. If the content is also identical to the
5250
+ # latest build version, the request fails because the component
5251
+ # already exists.
4889
5252
  # @return [String]
4890
5253
  #
4891
5254
  # @!attribute [rw] semantic_version
@@ -4896,10 +5259,15 @@ module Aws::Imagebuilder
4896
5259
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
4897
5260
  # assign values for the first three, and can filter on all of them.
4898
5261
  #
4899
- # **Filtering:** You can use wildcards (x) to specify the most recent
4900
- # versions or nodes when selecting the base image or components for
4901
- # your recipe. When you use a wildcard in any node, all nodes to the
4902
- # right of the first wildcard must also be wildcards.
5262
+ # **Assignment:** For the first three nodes, you can assign any
5263
+ # positive integer value, including zero. The upper limit is 2^30-1,
5264
+ # or 1073741823, for each node. Image Builder automatically assigns
5265
+ # the build number to the fourth node.
5266
+ #
5267
+ # **Patterns:** You can use any numeric pattern that adheres to the
5268
+ # assignment requirements for the nodes that you can assign. For
5269
+ # example, you might choose a software version pattern, such as 1.0.0,
5270
+ # or a date, such as 2021.01.01.
4903
5271
  #
4904
5272
  # </note>
4905
5273
  # @return [String]
@@ -4929,9 +5297,10 @@ module Aws::Imagebuilder
4929
5297
  # @return [String]
4930
5298
  #
4931
5299
  # @!attribute [rw] data
4932
- # The data of the component. Used to specify the data inline. Either
4933
- # `data` or `uri` can be used to specify the data within the
4934
- # component.
5300
+ # The data of the component. For the `SHELL` format, this is the plain
5301
+ # script content. You must specify exactly one of the `data` or `uri`
5302
+ # properties. For scripts that exceed the inline length constraint,
5303
+ # use the `uri` property.
4935
5304
  # @return [String]
4936
5305
  #
4937
5306
  # @!attribute [rw] uri
@@ -4943,10 +5312,12 @@ module Aws::Imagebuilder
4943
5312
  # @return [String]
4944
5313
  #
4945
5314
  # @!attribute [rw] kms_key_id
4946
- # The Amazon Resource Name (ARN) that uniquely identifies the KMS key
4947
- # used to encrypt this component. This can be either the Key ARN or
4948
- # the Alias ARN. For more information, see [Key identifiers
4949
- # (KeyId)][1] in the *Key Management Service Developer Guide*.
5315
+ # The Amazon Resource Name (ARN) of the KMS key that is used to
5316
+ # encrypt this component. This can be either the Key ARN or the Alias
5317
+ # ARN. For more information, see [Key identifiers (KeyId)][1] in the
5318
+ # *Key Management Service Developer Guide*. If you don't specify a
5319
+ # key, Image Builder encrypts the component data with a KMS key that
5320
+ # Image Builder owns.
4950
5321
  #
4951
5322
  #
4952
5323
  #
@@ -4959,10 +5330,10 @@ module Aws::Imagebuilder
4959
5330
  #
4960
5331
  # @!attribute [rw] client_token
4961
5332
  # A unique, case-sensitive identifier you provide to ensure that the
4962
- # operation completes no more than one time. If this token matches a
4963
- # previous request, the service ignores the request, but does not
4964
- # return an error. For more information, see [Ensuring idempotency][1]
4965
- # in the *Amazon EC2 API Reference*.
5333
+ # operation runs no more than one time. If you retry a request with
5334
+ # the same client token, Image Builder returns the original response
5335
+ # without running the operation again. For more information, see
5336
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
4966
5337
  #
4967
5338
  # **A suitable default value is auto-generated.** You should normally
4968
5339
  # not need to pass this option.
@@ -5015,6 +5386,11 @@ module Aws::Imagebuilder
5015
5386
 
5016
5387
  # @!attribute [rw] name
5017
5388
  # The name of the image resource that's created from the import.
5389
+ # Image Builder generates the image ARN from a normalized form of the
5390
+ # name, so names that differ only in case, spaces, or underscores
5391
+ # count as the same name. If an image with the same name and semantic
5392
+ # version already exists in your account in the same Amazon Web
5393
+ # Services Region, the import creates a new build version for it.
5018
5394
  # @return [String]
5019
5395
  #
5020
5396
  # @!attribute [rw] semantic_version
@@ -5033,14 +5409,16 @@ module Aws::Imagebuilder
5033
5409
  # @return [String]
5034
5410
  #
5035
5411
  # @!attribute [rw] os_version
5036
- # The operating system version for the imported image. Allowed values
5037
- # include the following: `Microsoft Windows 11`.
5412
+ # The operating system version for the imported image. The only
5413
+ # supported value is `Microsoft Windows 11`.
5038
5414
  # @return [String]
5039
5415
  #
5040
5416
  # @!attribute [rw] execution_role
5041
5417
  # The name or Amazon Resource Name (ARN) for the IAM role you create
5042
5418
  # that grants Image Builder access to perform workflow actions to
5043
- # import an image from a Microsoft ISO file.
5419
+ # import an image from a Microsoft ISO file. If you don't provide a
5420
+ # role, Image Builder uses the Image Builder service-linked role in
5421
+ # your account, and creates it if it doesn't exist.
5044
5422
  # @return [String]
5045
5423
  #
5046
5424
  # @!attribute [rw] infrastructure_configuration_arn
@@ -5050,11 +5428,17 @@ module Aws::Imagebuilder
5050
5428
  # @return [String]
5051
5429
  #
5052
5430
  # @!attribute [rw] uri
5053
- # The `uri` of the ISO disk file that's stored in Amazon S3.
5431
+ # The `uri` of the ISO disk file that's stored in Amazon S3, in
5432
+ # `s3://bucket/key` format. The key must end with the `.iso`, `.ISO`,
5433
+ # or `.Iso` extension, and the bucket must be owned by the account
5434
+ # that makes the request.
5054
5435
  # @return [String]
5055
5436
  #
5056
5437
  # @!attribute [rw] logging_configuration
5057
- # The logging configuration for the image build process.
5438
+ # The CloudWatch Logs log group where Image Builder sends the import
5439
+ # logs. If you specify a log group name outside of the
5440
+ # `/aws/imagebuilder/` namespace, you must also provide an
5441
+ # `executionRole` that has permission to write to that log group.
5058
5442
  # @return [Types::ImageLoggingConfiguration]
5059
5443
  #
5060
5444
  # @!attribute [rw] tags
@@ -5071,10 +5455,10 @@ module Aws::Imagebuilder
5071
5455
  #
5072
5456
  # @!attribute [rw] client_token
5073
5457
  # A unique, case-sensitive identifier you provide to ensure that the
5074
- # operation completes no more than one time. If this token matches a
5075
- # previous request, the service ignores the request, but does not
5076
- # return an error. For more information, see [Ensuring idempotency][1]
5077
- # in the *Amazon EC2 API Reference*.
5458
+ # operation runs no more than one time. If you retry a request with
5459
+ # the same client token, Image Builder returns the original response
5460
+ # without running the operation again. For more information, see
5461
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
5078
5462
  #
5079
5463
  # **A suitable default value is auto-generated.** You should normally
5080
5464
  # not need to pass this option.
@@ -5109,8 +5493,10 @@ module Aws::Imagebuilder
5109
5493
  # @return [String]
5110
5494
  #
5111
5495
  # @!attribute [rw] image_build_version_arn
5112
- # The Amazon Resource Name (ARN) of the output AMI that was created
5113
- # from the ISO disk file.
5496
+ # The Amazon Resource Name (ARN) of the Image Builder image resource
5497
+ # that this request created. The AMI doesn't exist yet when the
5498
+ # response returns. The import runs asynchronously, and the output AMI
5499
+ # appears in the image's output resources when the import completes.
5114
5500
  # @return [String]
5115
5501
  #
5116
5502
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImportDiskImageResponse AWS API Documentation
@@ -5124,6 +5510,11 @@ module Aws::Imagebuilder
5124
5510
 
5125
5511
  # @!attribute [rw] name
5126
5512
  # The name of the base image that is created by the import process.
5513
+ # Image Builder generates the image ARN from a normalized form of the
5514
+ # name, so names that differ only in case, spaces, or underscores
5515
+ # count as the same name. If an image with the same name and semantic
5516
+ # version already exists in your account in the same Amazon Web
5517
+ # Services Region, the import creates a new build version for it.
5127
5518
  # @return [String]
5128
5519
  #
5129
5520
  # @!attribute [rw] semantic_version
@@ -5163,13 +5554,15 @@ module Aws::Imagebuilder
5163
5554
  #
5164
5555
  # @!attribute [rw] vm_import_task_id
5165
5556
  # The `importTaskId` (API) or `ImportTaskId` (CLI) from the Amazon EC2
5166
- # VM import process. Image Builder retrieves information from the
5167
- # import process to pull in the AMI that is created from the VM source
5168
- # as the base image for your recipe.
5557
+ # VM import process. The import task doesn't need to be complete when
5558
+ # you call ImportVmImage - Image Builder monitors the task and
5559
+ # finishes creating the image when the task completes.
5169
5560
  # @return [String]
5170
5561
  #
5171
5562
  # @!attribute [rw] logging_configuration
5172
- # The logging configuration for the image build process.
5563
+ # The CloudWatch Logs log group where Image Builder sends the import
5564
+ # logs. For ImportVmImage, the log group name must be within the
5565
+ # `/aws/imagebuilder/` namespace.
5173
5566
  # @return [Types::ImageLoggingConfiguration]
5174
5567
  #
5175
5568
  # @!attribute [rw] tags
@@ -5178,10 +5571,10 @@ module Aws::Imagebuilder
5178
5571
  #
5179
5572
  # @!attribute [rw] client_token
5180
5573
  # A unique, case-sensitive identifier you provide to ensure that the
5181
- # operation completes no more than one time. If this token matches a
5182
- # previous request, the service ignores the request, but does not
5183
- # return an error. For more information, see [Ensuring idempotency][1]
5184
- # in the *Amazon EC2 API Reference*.
5574
+ # operation runs no more than one time. If you retry a request with
5575
+ # the same client token, Image Builder returns the original response
5576
+ # without running the operation again. For more information, see
5577
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
5185
5578
  #
5186
5579
  # **A suitable default value is auto-generated.** You should normally
5187
5580
  # not need to pass this option.
@@ -5212,9 +5605,10 @@ module Aws::Imagebuilder
5212
5605
  # @return [String]
5213
5606
  #
5214
5607
  # @!attribute [rw] image_arn
5215
- # The Amazon Resource Name (ARN) of the AMI that was created during
5216
- # the VM import process. This AMI is used as the base image for the
5217
- # recipe that imported the VM.
5608
+ # The Amazon Resource Name (ARN) of the Image Builder image resource
5609
+ # that this request created. Image Builder records the AMI from the VM
5610
+ # import task in the image's output resources after the task
5611
+ # completes.
5218
5612
  # @return [String]
5219
5613
  #
5220
5614
  # @!attribute [rw] client_token
@@ -5262,7 +5656,9 @@ module Aws::Imagebuilder
5262
5656
  # @return [String]
5263
5657
  #
5264
5658
  # @!attribute [rw] logging
5265
- # The logging configuration of the infrastructure configuration.
5659
+ # The logging configuration of the infrastructure configuration. When
5660
+ # you configure S3 logs, Image Builder writes logs from the build and
5661
+ # test process to the specified bucket under the key prefix.
5266
5662
  # @return [Types::Logging]
5267
5663
  #
5268
5664
  # @!attribute [rw] key_pair
@@ -5270,18 +5666,20 @@ module Aws::Imagebuilder
5270
5666
  # @return [String]
5271
5667
  #
5272
5668
  # @!attribute [rw] terminate_instance_on_failure
5273
- # The terminate instance on failure configuration of the
5274
- # infrastructure configuration.
5669
+ # Indicates whether Image Builder terminates the build and test
5670
+ # instances when the image build fails. When `false`, Image Builder
5671
+ # retains the instance so that you can debug it.
5275
5672
  # @return [Boolean]
5276
5673
  #
5277
5674
  # @!attribute [rw] sns_topic_arn
5278
5675
  # The Amazon Resource Name (ARN) of the SNS topic to which Image
5279
- # Builder sends image build event notifications.
5676
+ # Builder sends image build event notifications. Specify a standard
5677
+ # topic. Image Builder doesn't support FIFO topics.
5280
5678
  #
5281
- # <note markdown="1"> EC2 Image Builder is unable to send notifications to SNS topics that
5282
- # are encrypted using keys from other accounts. The key that is used
5283
- # to encrypt the SNS topic must reside in the account that the Image
5284
- # Builder service runs under.
5679
+ # <note markdown="1"> EC2 Image Builder can't send notifications to SNS topics that are
5680
+ # encrypted using keys from other accounts. If your SNS topic is
5681
+ # encrypted, the key must be owned by the same account that owns your
5682
+ # Image Builder resources.
5285
5683
  #
5286
5684
  # </note>
5287
5685
  # @return [String]
@@ -5295,7 +5693,8 @@ module Aws::Imagebuilder
5295
5693
  # @return [String]
5296
5694
  #
5297
5695
  # @!attribute [rw] resource_tags
5298
- # The tags attached to the resource created by Image Builder.
5696
+ # The metadata tags assigned to the Amazon EC2 build and test
5697
+ # instances that Image Builder launches during image creation.
5299
5698
  # @return [Hash<String,String>]
5300
5699
  #
5301
5700
  # @!attribute [rw] instance_metadata_options
@@ -5308,8 +5707,10 @@ module Aws::Imagebuilder
5308
5707
  # @return [Hash<String,String>]
5309
5708
  #
5310
5709
  # @!attribute [rw] placement
5311
- # The instance placement settings that define where the instances that
5312
- # are launched from your image run.
5710
+ # The instance placement settings that define where the build and test
5711
+ # instances that Image Builder launches during image creation run.
5712
+ # These settings don't affect instances that you launch from the
5713
+ # output image.
5313
5714
  # @return [Types::Placement]
5314
5715
  #
5315
5716
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InfrastructureConfiguration AWS API Documentation
@@ -5336,7 +5737,9 @@ module Aws::Imagebuilder
5336
5737
  include Aws::Structure
5337
5738
  end
5338
5739
 
5339
- # The infrastructure used when building Amazon EC2 AMIs.
5740
+ # Contains a high-level summary of an infrastructure configuration,
5741
+ # including the environment settings that Image Builder uses to build
5742
+ # and test images.
5340
5743
  #
5341
5744
  # @!attribute [rw] arn
5342
5745
  # The Amazon Resource Name (ARN) of the infrastructure configuration.
@@ -5359,7 +5762,8 @@ module Aws::Imagebuilder
5359
5762
  # @return [String]
5360
5763
  #
5361
5764
  # @!attribute [rw] resource_tags
5362
- # The tags attached to the image created by Image Builder.
5765
+ # The metadata tags assigned to the Amazon EC2 build and test
5766
+ # instances that Image Builder launches during image creation.
5363
5767
  # @return [Hash<String,String>]
5364
5768
  #
5365
5769
  # @!attribute [rw] tags
@@ -5375,8 +5779,10 @@ module Aws::Imagebuilder
5375
5779
  # @return [String]
5376
5780
  #
5377
5781
  # @!attribute [rw] placement
5378
- # The instance placement settings that define where the instances that
5379
- # are launched from your image run.
5782
+ # The instance placement settings that define where the build and test
5783
+ # instances that Image Builder launches during image creation run.
5784
+ # These settings don't affect instances that you launch from the
5785
+ # output image.
5380
5786
  # @return [Types::Placement]
5381
5787
  #
5382
5788
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InfrastructureConfigurationSummary AWS API Documentation
@@ -5400,8 +5806,9 @@ module Aws::Imagebuilder
5400
5806
  # Inspector assigned for a finding.
5401
5807
  #
5402
5808
  # @!attribute [rw] adjusted_cvss
5403
- # An object that contains details about an adjustment that Amazon
5404
- # Inspector made to the CVSS score for the finding.
5809
+ # The CVSS score that Amazon Inspector assigned to the finding after
5810
+ # applying its adjustments. It includes the score source, CVSS
5811
+ # version, scoring vector, and the adjustments applied.
5405
5812
  # @return [Types::CvssScoreDetails]
5406
5813
  #
5407
5814
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InspectorScoreDetails AWS API Documentation
@@ -5456,8 +5863,8 @@ module Aws::Imagebuilder
5456
5863
  # @return [String]
5457
5864
  #
5458
5865
  # @!attribute [rw] block_device_mappings
5459
- # Defines the block devices to attach for building an instance from
5460
- # this Image Builder AMI.
5866
+ # Defines the block device mappings for the EC2 instance that Image
5867
+ # Builder launches to build and test your container image.
5461
5868
  # @return [Array<Types::InstanceBlockDeviceMapping>]
5462
5869
  #
5463
5870
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InstanceConfiguration AWS API Documentation
@@ -5469,18 +5876,10 @@ module Aws::Imagebuilder
5469
5876
  include Aws::Structure
5470
5877
  end
5471
5878
 
5472
- # The instance metadata options that apply to the HTTP requests that
5473
- # pipeline builds use to launch EC2 build and test instances. For more
5474
- # information about instance metadata options, see [Configure the
5475
- # instance metadata options][1] in the <i> <i>Amazon EC2 User Guide</i>
5476
- # </i> for Linux instances, or [Configure the instance metadata
5477
- # options][2] in the <i> <i>Amazon EC2 Windows Guide</i> </i> for
5478
- # Windows instances.
5479
- #
5480
- #
5481
- #
5482
- # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html
5483
- # [2]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html
5879
+ # The instance metadata service (IMDS) settings that Image Builder
5880
+ # applies to the EC2 build and test instances it launches. These
5881
+ # settings control how software on those instances retrieves instance
5882
+ # metadata and IAM role credentials.
5484
5883
  #
5485
5884
  # @!attribute [rw] http_tokens
5486
5885
  # Indicates whether a signed token header is required for instance
@@ -5495,14 +5894,22 @@ module Aws::Imagebuilder
5495
5894
  # you include it, version 2.0 credentials are returned for the IAM
5496
5895
  # role. Otherwise, version 1.0 credentials are returned.
5497
5896
  #
5498
- # The default setting is **optional**.
5897
+ # If you don't set a value, the EC2 launch default applies to the
5898
+ # build and test instances. That default depends on the base AMI and
5899
+ # any account-level instance metadata defaults. For more information,
5900
+ # see [Configure the instance metadata options][1] in the <i>
5901
+ # <i>Amazon EC2 User Guide</i> </i>.
5902
+ #
5903
+ #
5904
+ #
5905
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html
5499
5906
  # @return [String]
5500
5907
  #
5501
5908
  # @!attribute [rw] http_put_response_hop_limit
5502
5909
  # Limit the number of hops that an instance metadata request can
5503
- # traverse to reach its destination. The default is one hop. However,
5504
- # if HTTP tokens are required, container image builds need a minimum
5505
- # of two hops.
5910
+ # traverse to reach its destination. If you don't set a value, the
5911
+ # EC2 launch default for the instance applies. If HTTP tokens are
5912
+ # required, container image builds need a minimum of two hops.
5506
5913
  # @return [Integer]
5507
5914
  #
5508
5915
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InstanceMetadataOptions AWS API Documentation
@@ -5527,8 +5934,9 @@ module Aws::Imagebuilder
5527
5934
  include Aws::Structure
5528
5935
  end
5529
5936
 
5530
- # You have specified two or more mutually exclusive parameters. Review
5531
- # the error message for details.
5937
+ # You have specified a combination of parameters that isn't valid. For
5938
+ # example, two mutually exclusive parameters, or a parameter without its
5939
+ # required companion parameter. Review the error message for details.
5532
5940
  #
5533
5941
  # @!attribute [rw] message
5534
5942
  # @return [String]
@@ -5568,7 +5976,8 @@ module Aws::Imagebuilder
5568
5976
  include Aws::Structure
5569
5977
  end
5570
5978
 
5571
- # You have requested an action that that the service doesn't support.
5979
+ # The request is malformed or otherwise invalid. Verify the request and
5980
+ # try again.
5572
5981
  #
5573
5982
  # @!attribute [rw] message
5574
5983
  # @return [String]
@@ -5595,8 +6004,10 @@ module Aws::Imagebuilder
5595
6004
  include Aws::Structure
5596
6005
  end
5597
6006
 
5598
- # The resource ARNs with different wildcard variations of semantic
5599
- # versioning.
6007
+ # A set of wildcard version ARNs that always reference the latest
6008
+ # version of the resource. ARNs are included for the latest version
6009
+ # overall, and for the latest versions within the same major, minor, and
6010
+ # patch levels.
5600
6011
  #
5601
6012
  # @!attribute [rw] latest_version_arn
5602
6013
  # The latest version Amazon Resource Name (ARN) of the Image Builder
@@ -5633,19 +6044,22 @@ module Aws::Imagebuilder
5633
6044
  # permission modification request is sent to the [Amazon EC2
5634
6045
  # ModifyImageAttribute][1] API on behalf of the user for each Region
5635
6046
  # they have selected to distribute the AMI. To make an AMI public, set
5636
- # the launch permission authorized accounts to `all`. See the examples
5637
- # for making an AMI public at [Amazon EC2 ModifyImageAttribute][1].
6047
+ # `userGroups` to the value `all`. See the examples for making an AMI
6048
+ # public at [Amazon EC2 ModifyImageAttribute][1].
5638
6049
  #
5639
6050
  #
5640
6051
  #
5641
6052
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html
5642
6053
  #
5643
6054
  # @!attribute [rw] user_ids
5644
- # The Amazon Web Services account ID.
6055
+ # The Amazon Web Services account IDs to grant launch permission to.
6056
+ # Each listed account can use the distributed AMI to launch instances.
5645
6057
  # @return [Array<String>]
5646
6058
  #
5647
6059
  # @!attribute [rw] user_groups
5648
- # The name of the group.
6060
+ # The name of the group that you want to grant launch permission to.
6061
+ # The only supported value is `all`, which makes the distributed AMI
6062
+ # public.
5649
6063
  # @return [Array<String>]
5650
6064
  #
5651
6065
  # @!attribute [rw] organization_arns
@@ -5691,8 +6105,9 @@ module Aws::Imagebuilder
5691
6105
  # @return [String]
5692
6106
  #
5693
6107
  # @!attribute [rw] set_default_version
5694
- # Set the specified Amazon EC2 launch template as the default launch
5695
- # template for the specified account.
6108
+ # Specifies whether to make the new launch template version that Image
6109
+ # Builder creates the default version of the launch template. If you
6110
+ # don't set a value, Image Builder treats it as `true`.
5696
6111
  # @return [Boolean]
5697
6112
  #
5698
6113
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/LaunchTemplateConfiguration AWS API Documentation
@@ -5716,13 +6131,13 @@ module Aws::Imagebuilder
5716
6131
  # @return [String]
5717
6132
  #
5718
6133
  # @!attribute [rw] resources_impacted_summary
5719
- # Contains information about associated resources that are identified
5720
- # for action by the runtime instance of the lifecycle policy.
6134
+ # A summary flag that indicates whether the lifecycle execution
6135
+ # identified any resources to take lifecycle actions on.
5721
6136
  # @return [Types::LifecycleExecutionResourcesImpactedSummary]
5722
6137
  #
5723
6138
  # @!attribute [rw] state
5724
- # Runtime state that reports if the policy action ran successfully,
5725
- # failed, or was skipped.
6139
+ # Runtime state that reports whether the lifecycle execution is in
6140
+ # progress, succeeded, or failed.
5726
6141
  # @return [Types::LifecycleExecutionState]
5727
6142
  #
5728
6143
  # @!attribute [rw] start_time
@@ -5766,7 +6181,7 @@ module Aws::Imagebuilder
5766
6181
  # @return [String]
5767
6182
  #
5768
6183
  # @!attribute [rw] state
5769
- # The runtime state for the lifecycle execution.
6184
+ # The runtime state of the lifecycle action for this resource.
5770
6185
  # @return [Types::LifecycleExecutionResourceState]
5771
6186
  #
5772
6187
  # @!attribute [rw] action
@@ -5818,8 +6233,8 @@ module Aws::Imagebuilder
5818
6233
  # resource.
5819
6234
  #
5820
6235
  # @!attribute [rw] name
5821
- # The name of the resource that was identified for a lifecycle policy
5822
- # action.
6236
+ # The name of the lifecycle action that was identified for the
6237
+ # resource.
5823
6238
  # @return [String]
5824
6239
  #
5825
6240
  # @!attribute [rw] reason
@@ -5856,12 +6271,12 @@ module Aws::Imagebuilder
5856
6271
  include Aws::Structure
5857
6272
  end
5858
6273
 
5859
- # Contains details for an image resource that was identified for a
5860
- # lifecycle action.
6274
+ # Contains an indicator that shows whether the lifecycle execution
6275
+ # identified any resources to take lifecycle actions on.
5861
6276
  #
5862
6277
  # @!attribute [rw] has_impacted_resources
5863
- # Indicates whether an image resource that was identified for a
5864
- # lifecycle action has associated resources that are also impacted.
6278
+ # Indicates whether the lifecycle execution identified any resources
6279
+ # to take lifecycle actions on.
5865
6280
  # @return [Boolean]
5866
6281
  #
5867
6282
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/LifecycleExecutionResourcesImpactedSummary AWS API Documentation
@@ -5911,7 +6326,8 @@ module Aws::Imagebuilder
5911
6326
  include Aws::Structure
5912
6327
  end
5913
6328
 
5914
- # The configuration details for a lifecycle policy resource.
6329
+ # Defines a lifecycle policy resource: its identity, status, execution
6330
+ # role, resource type, rules, resource selection, timestamps, and tags.
5915
6331
  #
5916
6332
  # @!attribute [rw] arn
5917
6333
  # The Amazon Resource Name (ARN) of the lifecycle policy resource.
@@ -5926,7 +6342,10 @@ module Aws::Imagebuilder
5926
6342
  # @return [String]
5927
6343
  #
5928
6344
  # @!attribute [rw] status
5929
- # Indicates whether the lifecycle policy resource is enabled.
6345
+ # Indicates whether the lifecycle policy resource is enabled. Only
6346
+ # enabled policies run on their schedule. Disabling or deleting a
6347
+ # policy removes its schedule and cancels any in-flight lifecycle
6348
+ # execution.
5930
6349
  # @return [String]
5931
6350
  #
5932
6351
  # @!attribute [rw] execution_role
@@ -5940,7 +6359,9 @@ module Aws::Imagebuilder
5940
6359
  # @return [String]
5941
6360
  #
5942
6361
  # @!attribute [rw] policy_details
5943
- # The configuration details for a lifecycle policy resource.
6362
+ # The list of rules for the lifecycle policy. Each rule pairs an
6363
+ # action with a filter and optional exclusion rules. A policy can
6364
+ # contain at most one rule per action type.
5944
6365
  # @return [Array<Types::LifecyclePolicyDetail>]
5945
6366
  #
5946
6367
  # @!attribute [rw] resource_selection
@@ -5987,7 +6408,9 @@ module Aws::Imagebuilder
5987
6408
  include Aws::Structure
5988
6409
  end
5989
6410
 
5990
- # The configuration details for a lifecycle policy resource.
6411
+ # Defines one lifecycle policy rule: the action to take, the filter that
6412
+ # determines which resources the rule applies to, and optional exclusion
6413
+ # rules.
5991
6414
  #
5992
6415
  # @!attribute [rw] action
5993
6416
  # Configuration details for the policy action.
@@ -6012,14 +6435,23 @@ module Aws::Imagebuilder
6012
6435
  include Aws::Structure
6013
6436
  end
6014
6437
 
6015
- # Contains selection criteria for the lifecycle policy.
6438
+ # Contains the action configuration for a lifecycle policy rule: the
6439
+ # action to take, and which underlying resources the action extends to.
6016
6440
  #
6017
6441
  # @!attribute [rw] type
6018
- # Specifies the lifecycle action to take.
6442
+ # Specifies the lifecycle action to take. `DELETE` deletes the image
6443
+ # resource and, with `includeResources`, also removes distributed
6444
+ # AMIs, snapshots, or container images. `DEPRECATE` and `DISABLE` set
6445
+ # the corresponding status on the image resource and, if
6446
+ # `includeResources.amis` is set, on its distributed AMIs.
6019
6447
  # @return [String]
6020
6448
  #
6021
6449
  # @!attribute [rw] include_resources
6022
- # Specifies the resources that the lifecycle policy applies to.
6450
+ # Specifies which underlying resources the action extends to beyond
6451
+ # the Image Builder image resource itself: distributed AMIs, their
6452
+ # snapshots, or distributed container images. `DELETE` rules can
6453
+ # include all three, `DEPRECATE` and `DISABLE` rules can include AMIs
6454
+ # only, and you can only include snapshots together with AMIs.
6023
6455
  # @return [Types::LifecyclePolicyDetailActionIncludeResources]
6024
6456
  #
6025
6457
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/LifecyclePolicyDetailAction AWS API Documentation
@@ -6093,18 +6525,19 @@ module Aws::Imagebuilder
6093
6525
  # @return [Array<String>]
6094
6526
  #
6095
6527
  # @!attribute [rw] shared_accounts
6096
- # Specifies Amazon Web Services accounts whose resources are excluded
6097
- # from the lifecycle action.
6528
+ # The lifecycle action doesn't apply to AMIs that are shared with any
6529
+ # of the specified Amazon Web Services accounts.
6098
6530
  # @return [Array<String>]
6099
6531
  #
6100
6532
  # @!attribute [rw] last_launched
6101
- # Specifies configuration details for Image Builder to exclude the
6102
- # most recent resources from lifecycle actions.
6533
+ # Configures Image Builder to exclude AMIs that were launched within
6534
+ # the specified time period from lifecycle actions. AMIs with no
6535
+ # recorded last-launched time aren't excluded by this rule.
6103
6536
  # @return [Types::LifecyclePolicyDetailExclusionRulesAmisLastLaunched]
6104
6537
  #
6105
6538
  # @!attribute [rw] tag_map
6106
- # Lists tags that should be excluded from lifecycle actions for the
6107
- # AMIs that have them.
6539
+ # Lifecycle actions don't apply to AMIs that have any of these tags.
6540
+ # Both the key and the value must match.
6108
6541
  # @return [Hash<String,String>]
6109
6542
  #
6110
6543
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/LifecyclePolicyDetailExclusionRulesAmis AWS API Documentation
@@ -6129,8 +6562,7 @@ module Aws::Imagebuilder
6129
6562
  #
6130
6563
  # @!attribute [rw] unit
6131
6564
  # Defines the unit of time that the lifecycle policy uses to calculate
6132
- # elapsed time since the last instance launched from the AMI. For
6133
- # example: days, weeks, months, or years.
6565
+ # elapsed time since the last launch.
6134
6566
  # @return [String]
6135
6567
  #
6136
6568
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/LifecyclePolicyDetailExclusionRulesAmisLastLaunched AWS API Documentation
@@ -6146,7 +6578,8 @@ module Aws::Imagebuilder
6146
6578
  # resource.
6147
6579
  #
6148
6580
  # @!attribute [rw] type
6149
- # Filter resources based on either `age` or `count`.
6581
+ # Filter resources based on either `AGE` or `COUNT`. You can only use
6582
+ # the count filter with the `DELETE` action type.
6150
6583
  # @return [String]
6151
6584
  #
6152
6585
  # @!attribute [rw] value
@@ -6184,7 +6617,8 @@ module Aws::Imagebuilder
6184
6617
  include Aws::Structure
6185
6618
  end
6186
6619
 
6187
- # Resource selection criteria for the lifecycle policy.
6620
+ # Resource selection criteria for the lifecycle policy. You must provide
6621
+ # exactly one selection criteria: either recipes or a tag map, not both.
6188
6622
  #
6189
6623
  # @!attribute [rw] recipes
6190
6624
  # A list of recipes that are used as selection criteria for the output
@@ -6230,8 +6664,7 @@ module Aws::Imagebuilder
6230
6664
  # Contains a summary of lifecycle policy resources.
6231
6665
  #
6232
6666
  # @!attribute [rw] arn
6233
- # The Amazon Resource Name (ARN) of the lifecycle policy summary
6234
- # resource.
6667
+ # The Amazon Resource Name (ARN) of the lifecycle policy.
6235
6668
  # @return [String]
6236
6669
  #
6237
6670
  # @!attribute [rw] name
@@ -6294,8 +6727,10 @@ module Aws::Imagebuilder
6294
6727
  end
6295
6728
 
6296
6729
  # @!attribute [rw] component_version_arn
6297
- # The component version Amazon Resource Name (ARN) whose versions you
6298
- # want to list.
6730
+ # The component version ARN whose build versions you want to list. The
6731
+ # ARN must specify an exact version, without a build number suffix. If
6732
+ # you don't specify an ARN, Image Builder returns build versions for
6733
+ # the components that your account owns.
6299
6734
  # @return [String]
6300
6735
  #
6301
6736
  # @!attribute [rw] max_results
@@ -6322,7 +6757,10 @@ module Aws::Imagebuilder
6322
6757
  # @return [String]
6323
6758
  #
6324
6759
  # @!attribute [rw] component_summary_list
6325
- # The list of component summaries for the specified semantic version.
6760
+ # The list of component summaries. Each summary represents one build
6761
+ # version of the specified component version, or of the components
6762
+ # that your account owns if you didn't specify an ARN. Deprecated
6763
+ # build versions aren't included.
6326
6764
  # @return [Array<Types::ComponentSummary>]
6327
6765
  #
6328
6766
  # @!attribute [rw] next_token
@@ -6346,8 +6784,9 @@ module Aws::Imagebuilder
6346
6784
  # Filters results based on the type of owner for the component. By
6347
6785
  # default, this request returns a list of components that your account
6348
6786
  # owns. To see results for other types of owners, you can specify
6349
- # components that Amazon manages, third party components, or
6350
- # components that other accounts have shared with you.
6787
+ # components that Amazon manages, components from the Amazon Web
6788
+ # Services Marketplace, third party components, or components that
6789
+ # other accounts have shared with you.
6351
6790
  # @return [String]
6352
6791
  #
6353
6792
  # @!attribute [rw] filters
@@ -6359,6 +6798,10 @@ module Aws::Imagebuilder
6359
6798
  #
6360
6799
  # * `platform`
6361
6800
  #
6801
+ # * `productCodes`
6802
+ #
6803
+ # * `status`
6804
+ #
6362
6805
  # * `supportedOsVersion`
6363
6806
  #
6364
6807
  # * `type`
@@ -6367,7 +6810,10 @@ module Aws::Imagebuilder
6367
6810
  # @return [Array<Types::Filter>]
6368
6811
  #
6369
6812
  # @!attribute [rw] by_name
6370
- # Returns the list of components for the specified name.
6813
+ # Specifies whether to return one entry per component name, with all
6814
+ # versions of each component aggregated. Defaults to `false`, which
6815
+ # returns one entry per component version. You can't combine this
6816
+ # option with the `version` filter.
6371
6817
  # @return [Boolean]
6372
6818
  #
6373
6819
  # @!attribute [rw] max_results
@@ -6425,7 +6871,8 @@ module Aws::Imagebuilder
6425
6871
  # @!attribute [rw] owner
6426
6872
  # Returns container recipes belonging to the specified owner, that
6427
6873
  # have been shared with you. You can omit this field to return
6428
- # container recipes belonging to your account.
6874
+ # container recipes belonging to your account. For container recipes,
6875
+ # the valid owner values are `Self`, `Shared`, and `Amazon`.
6429
6876
  # @return [String]
6430
6877
  #
6431
6878
  # @!attribute [rw] filters
@@ -6534,8 +6981,11 @@ module Aws::Imagebuilder
6534
6981
  end
6535
6982
 
6536
6983
  # @!attribute [rw] image_version_arn
6537
- # The Amazon Resource Name (ARN) of the image whose build versions you
6538
- # want to retrieve.
6984
+ # The Amazon Resource Name (ARN) of the image version whose build
6985
+ # versions you want to retrieve. The ARN must specify an exact version
6986
+ # (`<major>.<minor>.<patch>`) - wildcards aren't allowed. This
6987
+ # parameter is optional. If you don't specify it, Image Builder
6988
+ # returns build versions for all of the images in your account.
6539
6989
  # @return [String]
6540
6990
  #
6541
6991
  # @!attribute [rw] filters
@@ -6598,8 +7048,9 @@ module Aws::Imagebuilder
6598
7048
  end
6599
7049
 
6600
7050
  # @!attribute [rw] image_build_version_arn
6601
- # Filter results for the ListImagePackages request by the Image Build
6602
- # Version ARN
7051
+ # The Amazon Resource Name (ARN) of the image build version whose
7052
+ # packages you want to list. The value must be a full build version
7053
+ # ARN.
6603
7054
  # @return [String]
6604
7055
  #
6605
7056
  # @!attribute [rw] max_results
@@ -6830,10 +7281,17 @@ module Aws::Imagebuilder
6830
7281
  end
6831
7282
 
6832
7283
  # @!attribute [rw] filter
6833
- # A filter name and value pair that is used to return a more specific
6834
- # list of results from a list operation. Filters can be used to match
6835
- # a set of resources by specific criteria, such as tags, attributes,
6836
- # or IDs.
7284
+ # A filter name and value pair that determines the type of aggregation
7285
+ # that Image Builder returns. Use one of the following filter names:
7286
+ #
7287
+ # * `imageBuildVersionArn`
7288
+ #
7289
+ # * `imagePipelineArn`
7290
+ #
7291
+ # * `vulnerabilityId`
7292
+ #
7293
+ # If you don't specify a filter, Image Builder returns an aggregation
7294
+ # for your account.
6837
7295
  # @return [Types::Filter]
6838
7296
  #
6839
7297
  # @!attribute [rw] next_token
@@ -6902,13 +7360,16 @@ module Aws::Imagebuilder
6902
7360
  # An array of name value pairs that you can use to filter your
6903
7361
  # results. You can use the following filters to streamline results:
6904
7362
  #
6905
- # * `imageBuildVersionArn`
7363
+ # * `imageBuildVersionArn` – Filters findings by the image build
7364
+ # version that was scanned.
6906
7365
  #
6907
- # * `imagePipelineArn`
7366
+ # * `imagePipelineArn` – Filters findings by the pipeline that created
7367
+ # the scanned image.
6908
7368
  #
6909
- # * `vulnerabilityId`
7369
+ # * `vulnerabilityId` – Filters findings by vulnerability ID, for
7370
+ # example a CVE ID.
6910
7371
  #
6911
- # * `severity`
7372
+ # * `severity` – Filters findings by severity level.
6912
7373
  #
6913
7374
  # If you don't request a filter, then all findings in your account
6914
7375
  # are listed.
@@ -6980,7 +7441,10 @@ module Aws::Imagebuilder
6980
7441
  # @return [Array<Types::Filter>]
6981
7442
  #
6982
7443
  # @!attribute [rw] by_name
6983
- # Requests a list of images with a specific recipe name.
7444
+ # Specifies whether to return one entry per image name, with all
7445
+ # versions of each image aggregated. Defaults to `false`, which
7446
+ # returns one entry per image version. You can't combine this option
7447
+ # with the `version` filter.
6984
7448
  # @return [Boolean]
6985
7449
  #
6986
7450
  # @!attribute [rw] max_results
@@ -6993,7 +7457,9 @@ module Aws::Imagebuilder
6993
7457
  # @return [String]
6994
7458
  #
6995
7459
  # @!attribute [rw] include_deprecated
6996
- # Includes deprecated images in the response list.
7460
+ # Specifies whether to include deprecated Amazon-managed images in the
7461
+ # results. Deprecated images that you own are always returned.
7462
+ # Defaults to `false`.
6997
7463
  # @return [Boolean]
6998
7464
  #
6999
7465
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImagesRequest AWS API Documentation
@@ -7099,14 +7565,14 @@ module Aws::Imagebuilder
7099
7565
  # @return [String]
7100
7566
  #
7101
7567
  # @!attribute [rw] parent_resource_id
7102
- # You can leave this empty to get a list of Image Builder resources
7103
- # that were identified for lifecycle actions.
7104
- #
7105
- # To get a list of associated resources that are impacted for an
7106
- # individual resource (the parent), specify its Amazon Resource Name
7107
- # (ARN). Associated resources are produced from your image and
7108
- # distributed when you run a build, such as AMIs or container images
7109
- # stored in ECR repositories.
7568
+ # The Amazon Resource Name (ARN) of an image build version to get the
7569
+ # output resources for, such as AMIs or container images in Amazon
7570
+ # ECR. You can get this value from the `resourceId` in the top-level
7571
+ # response. If you leave this property empty, the response lists the
7572
+ # Image Builder resources that the lifecycle execution identified for
7573
+ # lifecycle actions. If the image build version that you specify in
7574
+ # `parentResourceId` wasn't part of this lifecycle execution, the
7575
+ # response contains an empty list.
7110
7576
  # @return [String]
7111
7577
  #
7112
7578
  # @!attribute [rw] max_results
@@ -7130,7 +7596,7 @@ module Aws::Imagebuilder
7130
7596
  end
7131
7597
 
7132
7598
  # @!attribute [rw] lifecycle_execution_id
7133
- # Runtime details for the specified runtime instance of the lifecycle
7599
+ # The unique identifier for the runtime instance of the lifecycle
7134
7600
  # policy.
7135
7601
  # @return [String]
7136
7602
  #
@@ -7170,8 +7636,11 @@ module Aws::Imagebuilder
7170
7636
  # @return [String]
7171
7637
  #
7172
7638
  # @!attribute [rw] resource_arn
7173
- # The Amazon Resource Name (ARN) of the resource for which to get a
7174
- # list of lifecycle runtime instances.
7639
+ # The Amazon Resource Name (ARN) of the resource for which to list
7640
+ # lifecycle executions. Specify a lifecycle policy ARN to list its
7641
+ # executions, or an image build version ARN to list the executions
7642
+ # that StartResourceStateUpdate started for that image. Other ARN
7643
+ # types aren't valid for this request.
7175
7644
  # @return [String]
7176
7645
  #
7177
7646
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListLifecycleExecutionsRequest AWS API Documentation
@@ -7205,8 +7674,9 @@ module Aws::Imagebuilder
7205
7674
  end
7206
7675
 
7207
7676
  # @!attribute [rw] filters
7208
- # Streamline results based on one of the following values: `Name`,
7209
- # `Status`.
7677
+ # Use the following filters to streamline results: `name`,
7678
+ # `resourceType`, and `status`. Filter names are matched exactly as
7679
+ # shown.
7210
7680
  # @return [Array<Types::Filter>]
7211
7681
  #
7212
7682
  # @!attribute [rw] max_results
@@ -7294,7 +7764,9 @@ module Aws::Imagebuilder
7294
7764
 
7295
7765
  # @!attribute [rw] steps
7296
7766
  # An array of the workflow steps that are waiting for action in your
7297
- # Amazon Web Services account.
7767
+ # Amazon Web Services account. Each step is paused at a
7768
+ # `WaitForAction` step, and remains in the list until you respond with
7769
+ # SendWorkflowStepAction or the wait times out.
7298
7770
  # @return [Array<Types::WorkflowStepExecution>]
7299
7771
  #
7300
7772
  # @!attribute [rw] next_token
@@ -7315,7 +7787,10 @@ module Aws::Imagebuilder
7315
7787
 
7316
7788
  # @!attribute [rw] workflow_version_arn
7317
7789
  # The Amazon Resource Name (ARN) of the workflow resource for which to
7318
- # get a list of build versions.
7790
+ # get a list of build versions. The version segments can contain
7791
+ # wildcards (`x`) to match multiple versions of the workflow. If you
7792
+ # don't specify an ARN, the response lists build versions for all of
7793
+ # the workflows in your account.
7319
7794
  # @return [String]
7320
7795
  #
7321
7796
  # @!attribute [rw] max_results
@@ -7338,8 +7813,8 @@ module Aws::Imagebuilder
7338
7813
  end
7339
7814
 
7340
7815
  # @!attribute [rw] workflow_summary_list
7341
- # A list that contains metadata for the workflow builds that have run
7342
- # for the workflow resource specified in the request.
7816
+ # A list that contains metadata for the build versions of the workflow
7817
+ # resource specified in the request.
7343
7818
  # @return [Array<Types::WorkflowSummary>]
7344
7819
  #
7345
7820
  # @!attribute [rw] next_token
@@ -7387,8 +7862,10 @@ module Aws::Imagebuilder
7387
7862
  # @return [String]
7388
7863
  #
7389
7864
  # @!attribute [rw] workflow_executions
7390
- # Contains an array of runtime details that represents each time a
7391
- # workflow ran for the requested image build version.
7865
+ # An array of runtime details that represents each time a workflow ran
7866
+ # for the requested image build version. Image Builder retains
7867
+ # workflow execution records for a limited time, so this array can be
7868
+ # empty for older image build versions.
7392
7869
  # @return [Array<Types::WorkflowExecutionMetadata>]
7393
7870
  #
7394
7871
  # @!attribute [rw] image_build_version_arn
@@ -7397,7 +7874,10 @@ module Aws::Imagebuilder
7397
7874
  # @return [String]
7398
7875
  #
7399
7876
  # @!attribute [rw] message
7400
- # The output message from the list action, if applicable.
7877
+ # The failure reason for the image build version, if it's in a failed
7878
+ # state. This comes from the image itself, not from an individual
7879
+ # workflow, so it's available even when no workflow executions remain
7880
+ # for the image.
7401
7881
  # @return [String]
7402
7882
  #
7403
7883
  # @!attribute [rw] next_token
@@ -7494,16 +7974,23 @@ module Aws::Imagebuilder
7494
7974
  end
7495
7975
 
7496
7976
  # @!attribute [rw] owner
7497
- # Used to get a list of workflow build version filtered by the
7498
- # identity of the creator.
7977
+ # Filters results based on the workflow owner. By default, this
7978
+ # request returns the workflows that your account owns (`Self`).
7979
+ # Specify `Amazon` to list the workflows that Image Builder manages.
7980
+ # Image Builder rejects the `Shared` and `ThirdParty` owner values for
7981
+ # workflows, and `AWSMarketplace` returns no results.
7499
7982
  # @return [String]
7500
7983
  #
7501
7984
  # @!attribute [rw] filters
7502
- # Used to streamline search results.
7985
+ # Filters to narrow the list of workflows. You can filter on `name`,
7986
+ # `version`, `description`, and `type`.
7503
7987
  # @return [Array<Types::Filter>]
7504
7988
  #
7505
7989
  # @!attribute [rw] by_name
7506
- # Specify all or part of the workflow name to streamline results.
7990
+ # Specifies whether to return one entry per workflow name, with all
7991
+ # versions of each workflow aggregated. Defaults to `false`, which
7992
+ # returns one entry per workflow version. You can't combine this
7993
+ # option with the `version` filter.
7507
7994
  # @return [Boolean]
7508
7995
  #
7509
7996
  # @!attribute [rw] max_results
@@ -7528,7 +8015,7 @@ module Aws::Imagebuilder
7528
8015
  end
7529
8016
 
7530
8017
  # @!attribute [rw] workflow_version_list
7531
- # A list of workflow build versions that match the request criteria.
8018
+ # A list of workflow versions that match the request criteria.
7532
8019
  # @return [Array<Types::WorkflowVersion>]
7533
8020
  #
7534
8021
  # @!attribute [rw] next_token
@@ -7564,12 +8051,14 @@ module Aws::Imagebuilder
7564
8051
  # The resources produced by this image.
7565
8052
  #
7566
8053
  # @!attribute [rw] amis
7567
- # The Amazon EC2 AMIs created by this image.
8054
+ # The Amazon EC2 AMIs created by this image. The list contains one
8055
+ # entry per AMI, including copies that distribution created in each
8056
+ # target Amazon Web Services Region and account.
7568
8057
  # @return [Array<Types::Ami>]
7569
8058
  #
7570
8059
  # @!attribute [rw] containers
7571
- # Container images that the pipeline has generated and stored in the
7572
- # output repository.
8060
+ # The container images that Image Builder created when it built this
8061
+ # image, stored in the output Amazon ECR repository.
7573
8062
  # @return [Array<Types::Container>]
7574
8063
  #
7575
8064
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/OutputResources AWS API Documentation
@@ -7596,8 +8085,9 @@ module Aws::Imagebuilder
7596
8085
  # @return [String]
7597
8086
  #
7598
8087
  # @!attribute [rw] cvss
7599
- # CVSS scores for one or more vulnerabilities that Amazon Inspector
7600
- # identified for a package.
8088
+ # The CVSS scores for the vulnerability in this finding, as published
8089
+ # by the vulnerability sources. Sources include NVD and the operating
8090
+ # system vendor, and scores can span CVSS versions.
7601
8091
  # @return [Array<Types::CvssScore>]
7602
8092
  #
7603
8093
  # @!attribute [rw] related_vulnerabilities
@@ -7702,17 +8192,13 @@ module Aws::Imagebuilder
7702
8192
  #
7703
8193
  # @!attribute [rw] host_id
7704
8194
  # The ID of the Dedicated Host on which build and test instances run.
7705
- # This only applies if `tenancy` is `host`. If you specify the host
7706
- # ID, you must not specify the resource group ARN. If you specify
7707
- # both, Image Builder returns an error.
8195
+ # This only applies if `tenancy` is `host`.
7708
8196
  # @return [String]
7709
8197
  #
7710
8198
  # @!attribute [rw] host_resource_group_arn
7711
8199
  # The Amazon Resource Name (ARN) of the host resource group in which
7712
8200
  # to launch build and test instances. This only applies if `tenancy`
7713
- # is `host`. If you specify the resource group ARN, you must not
7714
- # specify the host ID. If you specify both, Image Builder returns an
7715
- # error.
8201
+ # is `host`.
7716
8202
  # @return [String]
7717
8203
  #
7718
8204
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Placement AWS API Documentation
@@ -7827,7 +8313,10 @@ module Aws::Imagebuilder
7827
8313
  # @return [String]
7828
8314
  #
7829
8315
  # @!attribute [rw] policy
7830
- # The policy to apply.
8316
+ # The resource policy to apply to the image, as a JSON policy
8317
+ # document. Image Builder validates the policy with Amazon Web
8318
+ # Services RAM before applying it, and rejects invalid policies with
8319
+ # `InvalidParameterValueException`.
7831
8320
  # @return [String]
7832
8321
  #
7833
8322
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/PutImagePolicyRequest AWS API Documentation
@@ -8064,11 +8553,13 @@ module Aws::Imagebuilder
8064
8553
  include Aws::Structure
8065
8554
  end
8066
8555
 
8067
- # The current state of an impacted resource.
8556
+ # The state to apply to the image resource in a resource state update
8557
+ # request.
8068
8558
  #
8069
8559
  # @!attribute [rw] status
8070
- # Shows the current lifecycle policy action that was applied to an
8071
- # impacted resource.
8560
+ # The status to which you want to move the image resource. Set the
8561
+ # status to `AVAILABLE` to restore an image that's currently
8562
+ # deprecated or disabled.
8072
8563
  # @return [String]
8073
8564
  #
8074
8565
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ResourceState AWS API Documentation
@@ -8083,7 +8574,8 @@ module Aws::Imagebuilder
8083
8574
  # ad-hoc lifecycle actions.
8084
8575
  #
8085
8576
  # @!attribute [rw] amis
8086
- # Defines criteria for AMIs that are excluded from lifecycle actions.
8577
+ # Defines criteria for AMIs that Image Builder should exclude from the
8578
+ # resource state update.
8087
8579
  # @return [Types::LifecyclePolicyDetailExclusionRulesAmis]
8088
8580
  #
8089
8581
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ResourceStateUpdateExclusionRules AWS API Documentation
@@ -8094,12 +8586,14 @@ module Aws::Imagebuilder
8094
8586
  include Aws::Structure
8095
8587
  end
8096
8588
 
8097
- # Specifies if the lifecycle policy should apply actions to selected
8098
- # resources.
8589
+ # Specifies which underlying resources the resource state update applies
8590
+ # to, in addition to the Image Builder image resource itself:
8591
+ # distributed AMIs and their snapshots for AMI images, or distributed
8592
+ # container images for container images.
8099
8593
  #
8100
8594
  # @!attribute [rw] amis
8101
8595
  # Specifies whether the lifecycle action should apply to distributed
8102
- # AMIs
8596
+ # AMIs.
8103
8597
  # @return [Boolean]
8104
8598
  #
8105
8599
  # @!attribute [rw] snapshots
@@ -8123,15 +8617,17 @@ module Aws::Imagebuilder
8123
8617
  end
8124
8618
 
8125
8619
  # @!attribute [rw] image_build_version_arn
8126
- # The source image Amazon Resource Name (ARN) to retry.
8620
+ # The Amazon Resource Name (ARN) of the image build version that you
8621
+ # want to retry. The image must be in the `FAILED` or `CANCELLED`
8622
+ # state.
8127
8623
  # @return [String]
8128
8624
  #
8129
8625
  # @!attribute [rw] client_token
8130
8626
  # A unique, case-sensitive identifier you provide to ensure that the
8131
- # operation completes no more than one time. If this token matches a
8132
- # previous request, the service ignores the request, but does not
8133
- # return an error. For more information, see [Ensuring idempotency][1]
8134
- # in the *Amazon EC2 API Reference*.
8627
+ # operation runs no more than one time. If you retry a request with
8628
+ # the same client token, Image Builder returns the original response
8629
+ # without running the operation again. For more information, see
8630
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
8135
8631
  #
8136
8632
  # **A suitable default value is auto-generated.** You should normally
8137
8633
  # not need to pass this option.
@@ -8167,8 +8663,9 @@ module Aws::Imagebuilder
8167
8663
  include Aws::Structure
8168
8664
  end
8169
8665
 
8170
- # Properties that configure export from your build instance to a
8171
- # compatible file format for your VM.
8666
+ # Properties that configure exporting the output image to a disk image
8667
+ # file in an Amazon S3 bucket, in a format that's compatible with your
8668
+ # VMs.
8172
8669
  #
8173
8670
  # @!attribute [rw] role_name
8174
8671
  # The name of the role that grants VM Import/Export permission to
@@ -8211,11 +8708,16 @@ module Aws::Imagebuilder
8211
8708
  # Amazon S3 logging configuration.
8212
8709
  #
8213
8710
  # @!attribute [rw] s3_bucket_name
8214
- # The S3 bucket in which to store the logs.
8711
+ # The name of an existing Amazon S3 bucket where Image Builder saves
8712
+ # build logs. The bucket isn't validated when you create or update
8713
+ # the configuration, and Image Builder doesn't create it. The
8714
+ # instance profile associated with this infrastructure configuration
8715
+ # must have permission to write to the bucket.
8215
8716
  # @return [String]
8216
8717
  #
8217
8718
  # @!attribute [rw] s3_key_prefix
8218
- # The Amazon S3 path to the bucket where the logs are stored.
8719
+ # The Amazon S3 key prefix under which Image Builder writes build and
8720
+ # test logs in the bucket.
8219
8721
  # @return [String]
8220
8722
  #
8221
8723
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/S3Logs AWS API Documentation
@@ -8231,8 +8733,9 @@ module Aws::Imagebuilder
8231
8733
  # create a new image.
8232
8734
  #
8233
8735
  # @!attribute [rw] schedule_expression
8234
- # The cron expression determines how often EC2 Image Builder evaluates
8235
- # your `pipelineExecutionStartCondition`.
8736
+ # The expression determines how often EC2 Image Builder evaluates your
8737
+ # `pipelineExecutionStartCondition`. You can specify a cron
8738
+ # expression, or a rate expression such as `rate(1 day)`.
8236
8739
  #
8237
8740
  # For information on how to format a cron expression in Image Builder,
8238
8741
  # see [Use cron expressions in EC2 Image Builder][1].
@@ -8243,9 +8746,9 @@ module Aws::Imagebuilder
8243
8746
  # @return [String]
8244
8747
  #
8245
8748
  # @!attribute [rw] timezone
8246
- # The timezone that applies to the scheduling expression. For example,
8247
- # "Etc/UTC", "America/Los\_Angeles" in the [IANA timezone
8248
- # format][1]. If not specified this defaults to UTC.
8749
+ # The timezone that applies to the scheduling expression. Specify a
8750
+ # value in [IANA timezone format][1], for example `Etc/UTC` or
8751
+ # `America/Los_Angeles`. If not specified, this defaults to UTC.
8249
8752
  #
8250
8753
  #
8251
8754
  #
@@ -8270,6 +8773,12 @@ module Aws::Imagebuilder
8270
8773
  # * `EXPRESSION_MATCH_ONLY` – This condition builds a new image every
8271
8774
  # time the CRON expression matches the current time.
8272
8775
  #
8776
+ # <note markdown="1"> If the recipe references its base image through an Amazon Web
8777
+ # Services Systems Manager Parameter Store parameter, a change in the
8778
+ # parameter's value also counts as an available dependency update.
8779
+ #
8780
+ # </note>
8781
+ #
8273
8782
  #
8274
8783
  #
8275
8784
  # [1]: https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html
@@ -8292,7 +8801,8 @@ module Aws::Imagebuilder
8292
8801
  end
8293
8802
 
8294
8803
  # @!attribute [rw] step_execution_id
8295
- # Uniquely identifies the workflow step that sent the step action.
8804
+ # Uniquely identifies the waiting workflow step that you send the
8805
+ # action to. To get this identifier, call ListWaitingWorkflowSteps.
8296
8806
  # @return [String]
8297
8807
  #
8298
8808
  # @!attribute [rw] image_build_version_arn
@@ -8304,9 +8814,12 @@ module Aws::Imagebuilder
8304
8814
  # @return [String]
8305
8815
  #
8306
8816
  # @!attribute [rw] action
8307
- # The action to perform on the paused workflow step. The workflow step
8308
- # must be in a waiting state to accept an action. The request fails if
8309
- # the step has already timed out or been actioned.
8817
+ # The action to perform on the paused workflow step. `RESUME`
8818
+ # completes the waiting step, and the workflow continues. `STOP` fails
8819
+ # the step, and the step's `onFailure` setting determines whether the
8820
+ # workflow continues or aborts. The workflow step must be in a waiting
8821
+ # state to accept an action. The request fails if the step has already
8822
+ # timed out or been actioned.
8310
8823
  # @return [String]
8311
8824
  #
8312
8825
  # @!attribute [rw] reason
@@ -8317,10 +8830,10 @@ module Aws::Imagebuilder
8317
8830
  #
8318
8831
  # @!attribute [rw] client_token
8319
8832
  # A unique, case-sensitive identifier you provide to ensure that the
8320
- # operation completes no more than one time. If this token matches a
8321
- # previous request, the service ignores the request, but does not
8322
- # return an error. For more information, see [Ensuring idempotency][1]
8323
- # in the *Amazon EC2 API Reference*.
8833
+ # operation runs no more than one time. If you retry a request with
8834
+ # the same client token, Image Builder returns the original response
8835
+ # without running the operation again. For more information, see
8836
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
8324
8837
  #
8325
8838
  # **A suitable default value is auto-generated.** You should normally
8326
8839
  # not need to pass this option.
@@ -8343,7 +8856,8 @@ module Aws::Imagebuilder
8343
8856
  end
8344
8857
 
8345
8858
  # @!attribute [rw] step_execution_id
8346
- # The workflow step that sent the step action.
8859
+ # The unique identifier for the workflow step that received the
8860
+ # action, as specified in the request.
8347
8861
  # @return [String]
8348
8862
  #
8349
8863
  # @!attribute [rw] image_build_version_arn
@@ -8365,8 +8879,8 @@ module Aws::Imagebuilder
8365
8879
  include Aws::Structure
8366
8880
  end
8367
8881
 
8368
- # This exception is thrown when the service encounters an unrecoverable
8369
- # exception.
8882
+ # An internal server error occurred while Image Builder processed the
8883
+ # request. Retrying the request may succeed.
8370
8884
  #
8371
8885
  # @!attribute [rw] message
8372
8886
  # @return [String]
@@ -8480,10 +8994,10 @@ module Aws::Imagebuilder
8480
8994
  #
8481
8995
  # @!attribute [rw] client_token
8482
8996
  # A unique, case-sensitive identifier you provide to ensure that the
8483
- # operation completes no more than one time. If this token matches a
8484
- # previous request, the service ignores the request, but does not
8485
- # return an error. For more information, see [Ensuring idempotency][1]
8486
- # in the *Amazon EC2 API Reference*.
8997
+ # operation runs no more than one time. If you retry a request with
8998
+ # the same client token, Image Builder returns the original response
8999
+ # without running the operation again. For more information, see
9000
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
8487
9001
  #
8488
9002
  # **A suitable default value is auto-generated.** You should normally
8489
9003
  # not need to pass this option.
@@ -8546,38 +9060,45 @@ module Aws::Imagebuilder
8546
9060
  # @return [Types::ResourceState]
8547
9061
  #
8548
9062
  # @!attribute [rw] execution_role
8549
- # The name or Amazon Resource Name (ARN) of the IAM role that’s used
8550
- # to update image state.
9063
+ # The name or Amazon Resource Name (ARN) of the IAM role that's used
9064
+ # to update image state. You must provide this property together with
9065
+ # `includeResources`. Neither is valid without the other.
8551
9066
  # @return [String]
8552
9067
  #
8553
9068
  # @!attribute [rw] include_resources
8554
- # Specifies which image resources to include in the state update. When
8555
- # specified, the lifecycle action applies to underlying resources.
8556
- # These resources include AMIs, snapshots, and containers in addition
8557
- # to the Image Builder image resource. Requires `executionRole` to
8558
- # also be specified. To delete an image and its underlying resources,
8559
- # you must specify `includeResources`. To delete only the Image
8560
- # Builder image record without affecting underlying resources, use the
8561
- # `DeleteImage` API instead.
9069
+ # Specifies which underlying resources to update, in addition to the
9070
+ # Image Builder image resource itself. Snapshots and containers are
9071
+ # only valid for the `DELETED` state. To set an image to `DELETED`,
9072
+ # you must include its underlying resources. To delete only the Image
9073
+ # Builder image record, use the DeleteImage operation instead.
8562
9074
  # @return [Types::ResourceStateUpdateIncludeResources]
8563
9075
  #
8564
9076
  # @!attribute [rw] exclusion_rules
8565
- # Skip action on the image resource and associated resources if
8566
- # specified exclusion rules are met.
9077
+ # Rules that Image Builder evaluates against each of the image's
9078
+ # AMIs. Matching AMIs and their snapshots are skipped. Exclusion rules
9079
+ # only take effect when the request includes AMIs. If the target state
9080
+ # is `DELETED` and any resource was skipped, the Image Builder image
9081
+ # resource itself is also retained. For the `DEPRECATED` and
9082
+ # `DISABLED` target states, Image Builder updates the image
9083
+ # resource's state regardless of exclusions.
8567
9084
  # @return [Types::ResourceStateUpdateExclusionRules]
8568
9085
  #
8569
9086
  # @!attribute [rw] update_at
8570
- # Specifies the timestamp when the state transition takes effect. Use
8571
- # this parameter only when the target status is `DEPRECATED`. The
8572
- # value must be a future time.
9087
+ # The timestamp that indicates when resources are updated by a
9088
+ # lifecycle action. This property is valid only when the target status
9089
+ # is `DEPRECATED`, and the value must be a future time. If you don't
9090
+ # specify a value, Image Builder begins the state update right away.
9091
+ # For a scheduled deprecation, included AMIs get their EC2 deprecation
9092
+ # time set immediately, and Image Builder schedules the image resource
9093
+ # to transition to `DEPRECATED` at that time.
8573
9094
  # @return [Time]
8574
9095
  #
8575
9096
  # @!attribute [rw] client_token
8576
9097
  # A unique, case-sensitive identifier you provide to ensure that the
8577
- # operation completes no more than one time. If this token matches a
8578
- # previous request, the service ignores the request, but does not
8579
- # return an error. For more information, see [Ensuring idempotency][1]
8580
- # in the *Amazon EC2 API Reference*.
9098
+ # operation runs no more than one time. If you retry a request with
9099
+ # the same client token, Image Builder returns the original response
9100
+ # without running the operation again. For more information, see
9101
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
8581
9102
  #
8582
9103
  # **A suitable default value is auto-generated.** You should normally
8583
9104
  # not need to pass this option.
@@ -8602,8 +9123,10 @@ module Aws::Imagebuilder
8602
9123
  end
8603
9124
 
8604
9125
  # @!attribute [rw] lifecycle_execution_id
8605
- # Identifies the lifecycle runtime instance that started the resource
8606
- # state update.
9126
+ # Identifies the lifecycle execution that performs the resource state
9127
+ # update. Image Builder only returns this field when it started a
9128
+ # lifecycle execution for the update. Use it with
9129
+ # GetLifecycleExecution to track progress.
8607
9130
  # @return [String]
8608
9131
  #
8609
9132
  # @!attribute [rw] resource_arn
@@ -8621,17 +9144,18 @@ module Aws::Imagebuilder
8621
9144
  end
8622
9145
 
8623
9146
  # Contains settings for the Systems Manager agent on your build
8624
- # instance.
9147
+ # instance. This setting applies to Linux and macOS build instances
9148
+ # only. Requests that set it for a recipe with a Windows base image are
9149
+ # rejected.
8625
9150
  #
8626
9151
  # @!attribute [rw] uninstall_after_build
8627
- # Controls whether the Systems Manager agent is removed from your
8628
- # final build image, prior to creating the new AMI. If this is set to
8629
- # true, then the agent is removed from the final image. If it's set
8630
- # to false, then the agent is left in, so that it is included in the
8631
- # new AMI. default value is false.
8632
- #
8633
- # The default behavior of uninstallAfterBuild is to remove the SSM
8634
- # Agent if it was installed by EC2 Image Builder
9152
+ # Specifies whether the Systems Manager agent is removed from your
9153
+ # final build image before Image Builder creates the new AMI. If
9154
+ # `true`, the agent is removed. If `false`, the agent is kept, so that
9155
+ # it's included in the AMI. If you don't set this property, Image
9156
+ # Builder removes the agent only if Image Builder installed the agent
9157
+ # during the build. An agent that was pre-installed on the base image
9158
+ # is kept.
8635
9159
  # @return [Boolean]
8636
9160
  #
8637
9161
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/SystemsManagerAgent AWS API Documentation
@@ -8671,8 +9195,8 @@ module Aws::Imagebuilder
8671
9195
  #
8672
9196
  # @!attribute [rw] repository_name
8673
9197
  # The name of the container repository where the output container
8674
- # image is stored. This name is prefixed by the repository location.
8675
- # For example, `<repository location url>/repository_name`.
9198
+ # image is stored. Provide the repository name only (a namespace path
9199
+ # such as `team-a/my-repo` is allowed, but not the registry hostname).
8676
9200
  # @return [String]
8677
9201
  #
8678
9202
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/TargetContainerRepository AWS API Documentation
@@ -8729,15 +9253,18 @@ module Aws::Imagebuilder
8729
9253
  # @return [String]
8730
9254
  #
8731
9255
  # @!attribute [rw] distributions
8732
- # The distributions of the distribution configuration.
9256
+ # The distribution settings for the configuration. Each entry defines
9257
+ # how output images are distributed in one target Amazon Web Services
9258
+ # Region. A Region can appear at most once in the list. This list
9259
+ # replaces the configuration's existing distributions entirely.
8733
9260
  # @return [Array<Types::Distribution>]
8734
9261
  #
8735
9262
  # @!attribute [rw] client_token
8736
9263
  # A unique, case-sensitive identifier you provide to ensure that the
8737
- # operation completes no more than one time. If this token matches a
8738
- # previous request, the service ignores the request, but does not
8739
- # return an error. For more information, see [Ensuring idempotency][1]
8740
- # in the *Amazon EC2 API Reference*.
9264
+ # operation runs no more than one time. If you retry a request with
9265
+ # the same client token, Image Builder returns the original response
9266
+ # without running the operation again. For more information, see
9267
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
8741
9268
  #
8742
9269
  # **A suitable default value is auto-generated.** You should normally
8743
9270
  # not need to pass this option.
@@ -8792,27 +9319,33 @@ module Aws::Imagebuilder
8792
9319
  #
8793
9320
  # @!attribute [rw] image_recipe_arn
8794
9321
  # The Amazon Resource Name (ARN) of the image recipe that configures
8795
- # images updated by this image pipeline.
9322
+ # images created by this image pipeline. You must specify either this
9323
+ # property or `containerRecipeArn`, but not both.
8796
9324
  # @return [String]
8797
9325
  #
8798
9326
  # @!attribute [rw] container_recipe_arn
8799
- # The Amazon Resource Name (ARN) of the container pipeline to update.
9327
+ # The Amazon Resource Name (ARN) of the container recipe that is used
9328
+ # to configure images created by this container pipeline. You must
9329
+ # specify either this property or `imageRecipeArn`, but not both.
8800
9330
  # @return [String]
8801
9331
  #
8802
9332
  # @!attribute [rw] infrastructure_configuration_arn
8803
9333
  # The Amazon Resource Name (ARN) of the infrastructure configuration
8804
- # that Image Builder uses to build images that this image pipeline has
8805
- # updated.
9334
+ # that Image Builder uses to build images created by this image
9335
+ # pipeline.
8806
9336
  # @return [String]
8807
9337
  #
8808
9338
  # @!attribute [rw] distribution_configuration_arn
8809
9339
  # The Amazon Resource Name (ARN) of the distribution configuration
8810
- # that Image Builder uses to configure and distribute images that this
8811
- # image pipeline has updated.
9340
+ # that Image Builder uses to configure and distribute images created
9341
+ # by this image pipeline.
8812
9342
  # @return [String]
8813
9343
  #
8814
9344
  # @!attribute [rw] image_tests_configuration
8815
- # The image test configuration of the image pipeline.
9345
+ # Specifies the test settings that Image Builder applies to images
9346
+ # that this pipeline creates. If you don't provide test settings,
9347
+ # Image Builder stores a default configuration with image tests
9348
+ # enabled.
8816
9349
  # @return [Types::ImageTestsConfiguration]
8817
9350
  #
8818
9351
  # @!attribute [rw] enhanced_image_metadata_enabled
@@ -8822,19 +9355,24 @@ module Aws::Imagebuilder
8822
9355
  # @return [Boolean]
8823
9356
  #
8824
9357
  # @!attribute [rw] schedule
8825
- # The schedule of the image pipeline.
9358
+ # The schedule of the image pipeline. Because the update replaces the
9359
+ # entire configuration, omitting this property removes any existing
9360
+ # schedule. The pipeline then runs only when you call
9361
+ # StartImagePipelineExecution.
8826
9362
  # @return [Types::Schedule]
8827
9363
  #
8828
9364
  # @!attribute [rw] status
8829
- # The status of the image pipeline.
9365
+ # The status of the image pipeline. Defaults to `ENABLED` when
9366
+ # omitted. To keep a pipeline disabled, include this property set to
9367
+ # `DISABLED` in your update request.
8830
9368
  # @return [String]
8831
9369
  #
8832
9370
  # @!attribute [rw] client_token
8833
9371
  # A unique, case-sensitive identifier you provide to ensure that the
8834
- # operation completes no more than one time. If this token matches a
8835
- # previous request, the service ignores the request, but does not
8836
- # return an error. For more information, see [Ensuring idempotency][1]
8837
- # in the *Amazon EC2 API Reference*.
9372
+ # operation runs no more than one time. If you retry a request with
9373
+ # the same client token, Image Builder returns the original response
9374
+ # without running the operation again. For more information, see
9375
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
8838
9376
  #
8839
9377
  # **A suitable default value is auto-generated.** You should normally
8840
9378
  # not need to pass this option.
@@ -8845,25 +9383,37 @@ module Aws::Imagebuilder
8845
9383
  # @return [String]
8846
9384
  #
8847
9385
  # @!attribute [rw] image_scanning_configuration
8848
- # Contains settings for vulnerability scans.
9386
+ # Contains settings for vulnerability scans that Amazon Inspector runs
9387
+ # against the test instance during image creation.
8849
9388
  # @return [Types::ImageScanningConfiguration]
8850
9389
  #
8851
9390
  # @!attribute [rw] workflows
8852
- # Contains the workflows to run for the pipeline.
9391
+ # The array of workflow configuration objects for builds that this
9392
+ # pipeline starts. You must also specify `executionRole` when you
9393
+ # provide workflows.
8853
9394
  # @return [Array<Types::WorkflowConfiguration>]
8854
9395
  #
8855
9396
  # @!attribute [rw] logging_configuration
8856
- # Update logging configuration for the output image that's created
8857
- # when the pipeline runs.
9397
+ # Specifies the logging configuration for the image pipeline. Use this
9398
+ # to define custom CloudWatch Logs log groups for your pipeline
9399
+ # execution logs and image build logs. The service manages log groups
9400
+ # with names starting with `/aws/imagebuilder/` using the
9401
+ # service-linked role. For custom log group names outside of this
9402
+ # prefix, you must also provide an `executionRole`.
8858
9403
  # @return [Types::PipelineLoggingConfiguration]
8859
9404
  #
8860
9405
  # @!attribute [rw] execution_role
8861
9406
  # The name or Amazon Resource Name (ARN) for the IAM role you create
8862
- # that grants Image Builder access to perform workflow actions.
9407
+ # that grants Image Builder access to perform workflow actions. If you
9408
+ # omit this property, the pipeline reverts to the Image Builder
9409
+ # service-linked role.
8863
9410
  # @return [String]
8864
9411
  #
8865
9412
  # @!attribute [rw] image_tags
8866
- # The tags to be applied to the images produced by this pipeline.
9413
+ # The tags that Image Builder applies to the Image Builder image
9414
+ # resource that this pipeline's scheduled executions create. These
9415
+ # tags don't apply to the output AMI. To tag output AMIs, use
9416
+ # `amiTags` in the pipeline's distribution configuration.
8867
9417
  # @return [Hash<String,String>]
8868
9418
  #
8869
9419
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/UpdateImagePipelineRequest AWS API Documentation
@@ -8924,12 +9474,16 @@ module Aws::Imagebuilder
8924
9474
  # @!attribute [rw] instance_types
8925
9475
  # The instance types of the infrastructure configuration. You can
8926
9476
  # specify one or more instance types to use for this build. Image
8927
- # Builder picks one of these instance types based on availability.
9477
+ # Builder picks one of these instance types based on availability. If
9478
+ # you don't specify instance types, Image Builder selects compatible
9479
+ # instance types automatically. If you specify a Dedicated Host, Image
9480
+ # Builder uses only instance types that the host supports.
8928
9481
  # @return [Array<String>]
8929
9482
  #
8930
9483
  # @!attribute [rw] instance_profile_name
8931
9484
  # The instance profile to associate with the instance used to
8932
- # customize your Amazon EC2 AMI.
9485
+ # customize your Amazon EC2 AMI. The instance profile must exist in
9486
+ # your account.
8933
9487
  # @return [String]
8934
9488
  #
8935
9489
  # @!attribute [rw] security_group_ids
@@ -8938,12 +9492,16 @@ module Aws::Imagebuilder
8938
9492
  # @return [Array<String>]
8939
9493
  #
8940
9494
  # @!attribute [rw] subnet_id
8941
- # The subnet ID to place the instance used to customize your Amazon
8942
- # EC2 AMI in.
9495
+ # The subnet ID in which to place the instance used to customize your
9496
+ # Amazon EC2 AMI. If you specify `subnetId`, you must also specify one
9497
+ # or more security group IDs in `securityGroupIds`. Otherwise, the
9498
+ # request fails.
8943
9499
  # @return [String]
8944
9500
  #
8945
9501
  # @!attribute [rw] logging
8946
- # The logging configuration of the infrastructure configuration.
9502
+ # The logging configuration of the infrastructure configuration. When
9503
+ # you configure S3 logs, Image Builder writes logs from the build and
9504
+ # test process to the specified bucket under the key prefix.
8947
9505
  # @return [Types::Logging]
8948
9506
  #
8949
9507
  # @!attribute [rw] key_pair
@@ -8960,25 +9518,33 @@ module Aws::Imagebuilder
8960
9518
  #
8961
9519
  # @!attribute [rw] sns_topic_arn
8962
9520
  # The Amazon Resource Name (ARN) of the SNS topic to which Image
8963
- # Builder sends image build event notifications.
9521
+ # Builder sends image build event notifications. Specify a standard
9522
+ # topic. Image Builder doesn't support FIFO topics. Image Builder
9523
+ # validates the topic when you create or update the configuration. You
9524
+ # must have permission to publish to the topic.
8964
9525
  #
8965
- # <note markdown="1"> EC2 Image Builder is unable to send notifications to SNS topics that
8966
- # are encrypted using keys from other accounts. The key that is used
8967
- # to encrypt the SNS topic must reside in the account that the Image
8968
- # Builder service runs under.
9526
+ # <note markdown="1"> EC2 Image Builder can't send notifications to SNS topics that are
9527
+ # encrypted using keys from other accounts. If your SNS topic is
9528
+ # encrypted, the key must be owned by the same account that owns your
9529
+ # Image Builder resources.
8969
9530
  #
8970
9531
  # </note>
8971
9532
  # @return [String]
8972
9533
  #
8973
9534
  # @!attribute [rw] resource_tags
8974
- # The tags attached to the resource created by Image Builder.
9535
+ # The metadata tags to assign to the Amazon EC2 instance that Image
9536
+ # Builder launches during the build process. Tags are formatted as key
9537
+ # value pairs. Tag keys can't begin with `aws:` or match one of the
9538
+ # following reserved keys: `CreatedBy`, `Ec2ImageBuilderArn`, `Name`,
9539
+ # or `Tags`.
8975
9540
  # @return [Hash<String,String>]
8976
9541
  #
8977
9542
  # @!attribute [rw] instance_metadata_options
8978
- # The instance metadata options that you can set for the HTTP requests
8979
- # that pipeline builds use to launch EC2 build and test instances. For
8980
- # more information about instance metadata options, see one of the
8981
- # following links:
9543
+ # The instance metadata service (IMDS) settings that Image Builder
9544
+ # applies to the EC2 build and test instances it launches during image
9545
+ # creation. If you don't set these options, the EC2 launch defaults
9546
+ # for the instance apply. For more information about instance metadata
9547
+ # options, see one of the following links:
8982
9548
  #
8983
9549
  # * [Configure the instance metadata options][1] in the <i> <i>Amazon
8984
9550
  # EC2 User Guide</i> </i> for Linux instances.
@@ -8993,16 +9559,18 @@ module Aws::Imagebuilder
8993
9559
  # @return [Types::InstanceMetadataOptions]
8994
9560
  #
8995
9561
  # @!attribute [rw] placement
8996
- # The instance placement settings that define where the instances that
8997
- # are launched from your image run.
9562
+ # The instance placement settings that define where the build and test
9563
+ # instances that Image Builder launches during image creation run.
9564
+ # These settings don't affect instances that you launch from the
9565
+ # output image.
8998
9566
  # @return [Types::Placement]
8999
9567
  #
9000
9568
  # @!attribute [rw] client_token
9001
9569
  # A unique, case-sensitive identifier you provide to ensure that the
9002
- # operation completes no more than one time. If this token matches a
9003
- # previous request, the service ignores the request, but does not
9004
- # return an error. For more information, see [Ensuring idempotency][1]
9005
- # in the *Amazon EC2 API Reference*.
9570
+ # operation runs no more than one time. If you retry a request with
9571
+ # the same client token, Image Builder returns the original response
9572
+ # without running the operation again. For more information, see
9573
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
9006
9574
  #
9007
9575
  # **A suitable default value is auto-generated.** You should normally
9008
9576
  # not need to pass this option.
@@ -9061,20 +9629,26 @@ module Aws::Imagebuilder
9061
9629
  # @return [String]
9062
9630
  #
9063
9631
  # @!attribute [rw] description
9064
- # Optional description for the lifecycle policy.
9632
+ # Optional description for the lifecycle policy. Because the update
9633
+ # replaces the entire configuration, omitting this property removes
9634
+ # any existing description.
9065
9635
  # @return [String]
9066
9636
  #
9067
9637
  # @!attribute [rw] status
9068
- # Indicates whether the lifecycle policy resource is enabled.
9638
+ # Indicates whether the lifecycle policy resource is enabled. Defaults
9639
+ # to `ENABLED` when omitted, so updating a disabled policy without
9640
+ # setting this property re-enables it.
9069
9641
  # @return [String]
9070
9642
  #
9071
9643
  # @!attribute [rw] execution_role
9072
- # The name or Amazon Resource Name (ARN) of the IAM role that Image
9073
- # Builder uses to update the lifecycle policy.
9644
+ # The name or Amazon Resource Name (ARN) for the IAM role you create
9645
+ # that grants Image Builder access to run lifecycle actions.
9074
9646
  # @return [String]
9075
9647
  #
9076
9648
  # @!attribute [rw] resource_type
9077
- # The type of image resource that the lifecycle policy applies to.
9649
+ # The type of image resource that the lifecycle policy applies to. The
9650
+ # value must match the policy's existing resource type. You can't
9651
+ # change the resource type of an existing lifecycle policy.
9078
9652
  # @return [String]
9079
9653
  #
9080
9654
  # @!attribute [rw] policy_details
@@ -9083,15 +9657,16 @@ module Aws::Imagebuilder
9083
9657
  #
9084
9658
  # @!attribute [rw] resource_selection
9085
9659
  # Selection criteria for resources that the lifecycle policy applies
9086
- # to.
9660
+ # to. You must specify exactly one selection criteria: either recipes
9661
+ # or a tag map, not both.
9087
9662
  # @return [Types::LifecyclePolicyResourceSelection]
9088
9663
  #
9089
9664
  # @!attribute [rw] client_token
9090
9665
  # A unique, case-sensitive identifier you provide to ensure that the
9091
- # operation completes no more than one time. If this token matches a
9092
- # previous request, the service ignores the request, but does not
9093
- # return an error. For more information, see [Ensuring idempotency][1]
9094
- # in the *Amazon EC2 API Reference*.
9666
+ # operation runs no more than one time. If you retry a request with
9667
+ # the same client token, Image Builder returns the original response
9668
+ # without running the operation again. For more information, see
9669
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
9095
9670
  #
9096
9671
  # **A suitable default value is auto-generated.** You should normally
9097
9672
  # not need to pass this option.
@@ -9230,8 +9805,8 @@ module Aws::Imagebuilder
9230
9805
  include Aws::Structure
9231
9806
  end
9232
9807
 
9233
- # Defines a process that Image Builder uses to build and test images
9234
- # during the image creation process.
9808
+ # Defines a process that Image Builder runs during the build, test, or
9809
+ # distribution stage of the image creation process.
9235
9810
  #
9236
9811
  # @!attribute [rw] arn
9237
9812
  # The Amazon Resource Name (ARN) of the workflow resource.
@@ -9257,8 +9832,7 @@ module Aws::Imagebuilder
9257
9832
  # @return [String]
9258
9833
  #
9259
9834
  # @!attribute [rw] type
9260
- # Specifies the image creation stage that the workflow applies to.
9261
- # Image Builder currently supports build and test workflows.
9835
+ # The image creation stage that the workflow applies to.
9262
9836
  # @return [String]
9263
9837
  #
9264
9838
  # @!attribute [rw] state
@@ -9290,12 +9864,12 @@ module Aws::Imagebuilder
9290
9864
  # @return [String]
9291
9865
  #
9292
9866
  # @!attribute [rw] tags
9293
- # The tags that apply to the workflow resource
9867
+ # The tags that apply to the workflow resource.
9294
9868
  # @return [Hash<String,String>]
9295
9869
  #
9296
9870
  # @!attribute [rw] parameters
9297
- # An array of input parameters that that the image workflow uses to
9298
- # control actions or configure settings.
9871
+ # An array of input parameters that the image workflow uses to control
9872
+ # actions or configure settings.
9299
9873
  # @return [Array<Types::WorkflowParameterDetail>]
9300
9874
  #
9301
9875
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Workflow AWS API Documentation
@@ -9341,7 +9915,10 @@ module Aws::Imagebuilder
9341
9915
  # @return [String]
9342
9916
  #
9343
9917
  # @!attribute [rw] on_failure
9344
- # The action to take if the workflow fails.
9918
+ # The action to take if the workflow fails. With `CONTINUE`, a failed
9919
+ # workflow is logged and image creation proceeds to the next workflow.
9920
+ # If you don't set a value, the image build fails when the workflow
9921
+ # fails. You can only set this property for test workflows.
9345
9922
  # @return [String]
9346
9923
  #
9347
9924
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/WorkflowConfiguration AWS API Documentation
@@ -9382,9 +9959,11 @@ module Aws::Imagebuilder
9382
9959
  # @return [String]
9383
9960
  #
9384
9961
  # @!attribute [rw] total_step_count
9385
- # The total number of steps in the workflow. This should equal the sum
9386
- # of the step counts for steps that succeeded, were skipped, and
9387
- # failed.
9962
+ # The total number of steps that the workflow document defines for
9963
+ # this runtime instance of the workflow. Image Builder sets this count
9964
+ # before any steps run. The sum of succeeded, skipped, and failed
9965
+ # steps only reaches this total if every step finishes in one of those
9966
+ # states.
9388
9967
  # @return [Integer]
9389
9968
  #
9390
9969
  # @!attribute [rw] total_steps_succeeded
@@ -9415,7 +9994,10 @@ module Aws::Imagebuilder
9415
9994
  # @return [String]
9416
9995
  #
9417
9996
  # @!attribute [rw] retried
9418
- # Indicates retry status for this runtime instance of the workflow.
9997
+ # Indicates whether a retry of the image build superseded this runtime
9998
+ # instance of the workflow. When you retry a failed image build, Image
9999
+ # Builder sets this flag to `true` on the original workflow executions
10000
+ # that the retry re-ran.
9419
10001
  # @return [Boolean]
9420
10002
  #
9421
10003
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/WorkflowExecutionMetadata AWS API Documentation
@@ -9465,8 +10047,8 @@ module Aws::Imagebuilder
9465
10047
  # @return [String]
9466
10048
  #
9467
10049
  # @!attribute [rw] type
9468
- # The type of input this parameter provides. The currently supported
9469
- # value is "string".
10050
+ # The type of input this parameter provides. Supported values are
10051
+ # `string`, `integer`, `boolean`, and `stringList`.
9470
10052
  # @return [String]
9471
10053
  #
9472
10054
  # @!attribute [rw] default_value
@@ -9488,7 +10070,7 @@ module Aws::Imagebuilder
9488
10070
  include Aws::Structure
9489
10071
  end
9490
10072
 
9491
- # A group of fields that describe the current status of workflow.
10073
+ # A group of fields that describe the current status of the workflow.
9492
10074
  #
9493
10075
  # @!attribute [rw] status
9494
10076
  # The current state of the workflow.
@@ -9507,8 +10089,8 @@ module Aws::Imagebuilder
9507
10089
  include Aws::Structure
9508
10090
  end
9509
10091
 
9510
- # Contains runtime details for an instance of a workflow that ran for
9511
- # the associated image build version.
10092
+ # Contains runtime details for a workflow step that has paused at a
10093
+ # `WaitForAction` step, and is waiting for you to send an action.
9512
10094
  #
9513
10095
  # @!attribute [rw] step_execution_id
9514
10096
  # Uniquely identifies the workflow step that ran for the associated
@@ -9587,12 +10169,15 @@ module Aws::Imagebuilder
9587
10169
  # @return [String]
9588
10170
  #
9589
10171
  # @!attribute [rw] inputs
9590
- # Input parameters that Image Builder provides for the workflow step.
10172
+ # Input parameters that Image Builder provides for the workflow step,
10173
+ # as a JSON-encoded string.
9591
10174
  # @return [String]
9592
10175
  #
9593
10176
  # @!attribute [rw] outputs
9594
- # The file names that the workflow step created as output for this
9595
- # runtime instance of the workflow.
10177
+ # The output values that the workflow step produced for this runtime
10178
+ # instance of the workflow, as a JSON-encoded string. For example, a
10179
+ # step that launches an instance outputs the instance ID. If the step
10180
+ # failed, this field contains the error message.
9596
10181
  # @return [String]
9597
10182
  #
9598
10183
  # @!attribute [rw] start_time
@@ -9658,8 +10243,7 @@ module Aws::Imagebuilder
9658
10243
  # @return [String]
9659
10244
  #
9660
10245
  # @!attribute [rw] type
9661
- # The image creation stage that this workflow applies to. Image
9662
- # Builder currently supports build and test stage workflows.
10246
+ # The image creation stage that this workflow applies to.
9663
10247
  # @return [String]
9664
10248
  #
9665
10249
  # @!attribute [rw] owner
@@ -9715,8 +10299,7 @@ module Aws::Imagebuilder
9715
10299
  # @return [String]
9716
10300
  #
9717
10301
  # @!attribute [rw] type
9718
- # The image creation stage that this workflow applies to. Image
9719
- # Builder currently supports build and test stage workflows.
10302
+ # The image creation stage that this workflow applies to.
9720
10303
  # @return [String]
9721
10304
  #
9722
10305
  # @!attribute [rw] owner