aws-sdk-imagebuilder 1.111.0 → 1.112.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.
@@ -221,8 +221,10 @@ module Aws::Imagebuilder
221
221
  # @return [String]
222
222
  #
223
223
  # @!attribute [rw] client_token
224
- # Unique, case-sensitive identifier you provide to ensure idempotency
225
- # of the request. For more information, see [Ensuring idempotency][1]
224
+ # 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]
226
228
  # in the *Amazon EC2 API Reference*.
227
229
  #
228
230
  # **A suitable default value is auto-generated.** You should normally
@@ -271,8 +273,10 @@ module Aws::Imagebuilder
271
273
  # @return [String]
272
274
  #
273
275
  # @!attribute [rw] client_token
274
- # Unique, case-sensitive identifier you provide to ensure idempotency
275
- # of the request. For more information, see [Ensuring idempotency][1]
276
+ # 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]
276
280
  # in the *Amazon EC2 API Reference*.
277
281
  #
278
282
  # **A suitable default value is auto-generated.** You should normally
@@ -462,6 +466,46 @@ module Aws::Imagebuilder
462
466
  include Aws::Structure
463
467
  end
464
468
 
469
+ # Contains details about the component that caused the image creation
470
+ # process to fail. The details identify the first step that failed when
471
+ # the component ran.
472
+ #
473
+ # @!attribute [rw] component_arn
474
+ # The Amazon Resource Name (ARN) of the component build version that
475
+ # failed.
476
+ # @return [String]
477
+ #
478
+ # @!attribute [rw] phase_name
479
+ # The name of the phase in the component document where the failure
480
+ # occurred, such as `build`, `validate`, or `test`.
481
+ # @return [String]
482
+ #
483
+ # @!attribute [rw] step_name
484
+ # The name of the step in the component document that failed.
485
+ # @return [String]
486
+ #
487
+ # @!attribute [rw] action
488
+ # The action that the failed step runs, for example `ExecuteBash`.
489
+ # @return [String]
490
+ #
491
+ # @!attribute [rw] error_message
492
+ # The error message from the step that failed. Image Builder truncates
493
+ # messages that are longer than 1024 characters. The component log in
494
+ # Amazon CloudWatch Logs contains the full output.
495
+ # @return [String]
496
+ #
497
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ComponentFailureContext AWS API Documentation
498
+ #
499
+ class ComponentFailureContext < Struct.new(
500
+ :component_arn,
501
+ :phase_name,
502
+ :step_name,
503
+ :action,
504
+ :error_message)
505
+ SENSITIVE = []
506
+ include Aws::Structure
507
+ end
508
+
465
509
  # Contains a key/value pair that sets the named component parameter.
466
510
  #
467
511
  # @!attribute [rw] name
@@ -650,21 +694,20 @@ module Aws::Imagebuilder
650
694
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
651
695
  # assign values for the first three, and can filter on all of them.
652
696
  #
653
- # **Assignment:** For the first three nodes you can assign any
654
- # positive integer value, including zero, with an upper limit of
655
- # 2^30-1, or 1073741823 for each node. Image Builder automatically
656
- # assigns the build number to the fourth node.
697
+ # **Assignment:** For the first three nodes, you can assign any
698
+ # positive integer value, including zero. The upper limit is 2^30-1,
699
+ # or 1073741823, for each node. Image Builder automatically assigns
700
+ # the build number to the fourth node.
657
701
  #
658
702
  # **Patterns:** You can use any numeric pattern that adheres to the
659
703
  # assignment requirements for the nodes that you can assign. For
660
704
  # example, you might choose a software version pattern, such as 1.0.0,
661
705
  # or a date, such as 2021.01.01.
662
706
  #
663
- # **Filtering:** With semantic versioning, you have the flexibility to
664
- # use wildcards (x) to specify the most recent versions or nodes when
665
- # selecting the base image or components for your recipe. When you use
666
- # a wildcard in any node, all nodes to the right of the first wildcard
667
- # must also be wildcards.
707
+ # **Filtering:** You can use wildcards (x) to specify the most recent
708
+ # versions or nodes when selecting the base image or components for
709
+ # your recipe. When you use a wildcard in any node, all nodes to the
710
+ # right of the first wildcard must also be wildcards.
668
711
  #
669
712
  # </note>
670
713
  # @return [String]
@@ -678,9 +721,9 @@ module Aws::Imagebuilder
678
721
  # @return [String]
679
722
  #
680
723
  # @!attribute [rw] supported_os_versions
681
- # he operating system (OS) version supported by the component. If the
682
- # OS information is available, a prefix match is performed against the
683
- # base image OS version during image recipe creation.
724
+ # The operating system (OS) version supported by the component. If OS
725
+ # information is available, Image Builder performs a prefix match
726
+ # against the base image OS version during image recipe creation.
684
727
  # @return [Array<String>]
685
728
  #
686
729
  # @!attribute [rw] type
@@ -817,21 +860,20 @@ module Aws::Imagebuilder
817
860
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
818
861
  # assign values for the first three, and can filter on all of them.
819
862
  #
820
- # **Assignment:** For the first three nodes you can assign any
821
- # positive integer value, including zero, with an upper limit of
822
- # 2^30-1, or 1073741823 for each node. Image Builder automatically
823
- # assigns the build number to the fourth node.
863
+ # **Assignment:** For the first three nodes, you can assign any
864
+ # positive integer value, including zero. The upper limit is 2^30-1,
865
+ # or 1073741823, for each node. Image Builder automatically assigns
866
+ # the build number to the fourth node.
824
867
  #
825
868
  # **Patterns:** You can use any numeric pattern that adheres to the
826
869
  # assignment requirements for the nodes that you can assign. For
827
870
  # example, you might choose a software version pattern, such as 1.0.0,
828
871
  # or a date, such as 2021.01.01.
829
872
  #
830
- # **Filtering:** With semantic versioning, you have the flexibility to
831
- # use wildcards (x) to specify the most recent versions or nodes when
832
- # selecting the base image or components for your recipe. When you use
833
- # a wildcard in any node, all nodes to the right of the first wildcard
834
- # must also be wildcards.
873
+ # **Filtering:** You can use wildcards (x) to specify the most recent
874
+ # versions or nodes when selecting the base image or components for
875
+ # your recipe. When you use a wildcard in any node, all nodes to the
876
+ # right of the first wildcard must also be wildcards.
835
877
  #
836
878
  # </note>
837
879
  # @return [String]
@@ -989,10 +1031,10 @@ module Aws::Imagebuilder
989
1031
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
990
1032
  # assign values for the first three, and can filter on all of them.
991
1033
  #
992
- # **Assignment:** For the first three nodes you can assign any
993
- # positive integer value, including zero, with an upper limit of
994
- # 2^30-1, or 1073741823 for each node. Image Builder automatically
995
- # assigns the build number to the fourth node.
1034
+ # **Assignment:** For the first three nodes, you can assign any
1035
+ # positive integer value, including zero. The upper limit is 2^30-1,
1036
+ # or 1073741823, for each node. Image Builder automatically assigns
1037
+ # the build number to the fourth node.
996
1038
  #
997
1039
  # **Patterns:** You can use any numeric pattern that adheres to the
998
1040
  # assignment requirements for the nodes that you can assign. For
@@ -1031,9 +1073,9 @@ module Aws::Imagebuilder
1031
1073
  #
1032
1074
  # @!attribute [rw] uri
1033
1075
  # The `uri` of a YAML component document file. This must be an S3 URL
1034
- # (`s3://bucket/key`), and the requester must have permission to
1035
- # access the S3 bucket it points to. If you use Amazon S3, you can
1036
- # specify component content up to your service quota.
1076
+ # (`s3://bucket/key`), and you must have permission to access the S3
1077
+ # bucket it points to. If you use Amazon S3, you can specify component
1078
+ # content up to your service quota.
1037
1079
  #
1038
1080
  # Alternatively, you can specify the YAML document inline, using the
1039
1081
  # component `data` property. You cannot specify both properties.
@@ -1055,8 +1097,10 @@ module Aws::Imagebuilder
1055
1097
  # @return [Hash<String,String>]
1056
1098
  #
1057
1099
  # @!attribute [rw] client_token
1058
- # Unique, case-sensitive identifier you provide to ensure idempotency
1059
- # of the request. For more information, see [Ensuring idempotency][1]
1100
+ # 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]
1060
1104
  # in the *Amazon EC2 API Reference*.
1061
1105
  #
1062
1106
  # **A suitable default value is auto-generated.** You should normally
@@ -1068,10 +1112,9 @@ module Aws::Imagebuilder
1068
1112
  # @return [String]
1069
1113
  #
1070
1114
  # @!attribute [rw] dry_run
1071
- # Validates the required permissions for the operation and the request
1072
- # parameters, without actually making the request, and provides an
1073
- # error response. Upon a successful request, the error response is
1074
- # `DryRunOperationException`.
1115
+ # Validates the required permissions and request parameters without
1116
+ # making the request. If validation succeeds, the operation returns a
1117
+ # `DryRunOperationException` error response.
1075
1118
  # @return [Boolean]
1076
1119
  #
1077
1120
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateComponentRequest AWS API Documentation
@@ -1142,10 +1185,10 @@ module Aws::Imagebuilder
1142
1185
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
1143
1186
  # assign values for the first three, and can filter on all of them.
1144
1187
  #
1145
- # **Assignment:** For the first three nodes you can assign any
1146
- # positive integer value, including zero, with an upper limit of
1147
- # 2^30-1, or 1073741823 for each node. Image Builder automatically
1148
- # assigns the build number to the fourth node.
1188
+ # **Assignment:** For the first three nodes, you can assign any
1189
+ # positive integer value, including zero. The upper limit is 2^30-1,
1190
+ # or 1073741823, for each node. Image Builder automatically assigns
1191
+ # the build number to the fourth node.
1149
1192
  #
1150
1193
  # **Patterns:** You can use any numeric pattern that adheres to the
1151
1194
  # assignment requirements for the nodes that you can assign. For
@@ -1170,7 +1213,7 @@ module Aws::Imagebuilder
1170
1213
  # @return [String]
1171
1214
  #
1172
1215
  # @!attribute [rw] dockerfile_template_uri
1173
- # The Amazon S3 URI for the Dockerfile that will be used to build your
1216
+ # The Amazon S3 URI for the Dockerfile that is used to build your
1174
1217
  # container image.
1175
1218
  # @return [String]
1176
1219
  #
@@ -1212,8 +1255,10 @@ module Aws::Imagebuilder
1212
1255
  # @return [String]
1213
1256
  #
1214
1257
  # @!attribute [rw] client_token
1215
- # Unique, case-sensitive identifier you provide to ensure idempotency
1216
- # of the request. For more information, see [Ensuring idempotency][1]
1258
+ # 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]
1217
1262
  # in the *Amazon EC2 API Reference*.
1218
1263
  #
1219
1264
  # **A suitable default value is auto-generated.** You should normally
@@ -1224,6 +1269,12 @@ module Aws::Imagebuilder
1224
1269
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
1225
1270
  # @return [String]
1226
1271
  #
1272
+ # @!attribute [rw] dry_run
1273
+ # Validates the required permissions and request parameters without
1274
+ # making the request. If validation succeeds, the operation returns a
1275
+ # `DryRunOperationException` error response.
1276
+ # @return [Boolean]
1277
+ #
1227
1278
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateContainerRecipeRequest AWS API Documentation
1228
1279
  #
1229
1280
  class CreateContainerRecipeRequest < Struct.new(
@@ -1242,7 +1293,8 @@ module Aws::Imagebuilder
1242
1293
  :working_directory,
1243
1294
  :target_repository,
1244
1295
  :kms_key_id,
1245
- :client_token)
1296
+ :client_token,
1297
+ :dry_run)
1246
1298
  SENSITIVE = []
1247
1299
  include Aws::Structure
1248
1300
  end
@@ -1293,8 +1345,10 @@ module Aws::Imagebuilder
1293
1345
  # @return [Hash<String,String>]
1294
1346
  #
1295
1347
  # @!attribute [rw] client_token
1296
- # Unique, case-sensitive identifier you provide to ensure idempotency
1297
- # of the request. For more information, see [Ensuring idempotency][1]
1348
+ # 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]
1298
1352
  # in the *Amazon EC2 API Reference*.
1299
1353
  #
1300
1354
  # **A suitable default value is auto-generated.** You should normally
@@ -1305,6 +1359,12 @@ module Aws::Imagebuilder
1305
1359
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
1306
1360
  # @return [String]
1307
1361
  #
1362
+ # @!attribute [rw] dry_run
1363
+ # Validates the required permissions and request parameters without
1364
+ # making the request. If validation succeeds, the operation returns a
1365
+ # `DryRunOperationException` error response.
1366
+ # @return [Boolean]
1367
+ #
1308
1368
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateDistributionConfigurationRequest AWS API Documentation
1309
1369
  #
1310
1370
  class CreateDistributionConfigurationRequest < Struct.new(
@@ -1312,7 +1372,8 @@ module Aws::Imagebuilder
1312
1372
  :description,
1313
1373
  :distributions,
1314
1374
  :tags,
1315
- :client_token)
1375
+ :client_token,
1376
+ :dry_run)
1316
1377
  SENSITIVE = []
1317
1378
  include Aws::Structure
1318
1379
  end
@@ -1349,8 +1410,8 @@ module Aws::Imagebuilder
1349
1410
  # @return [String]
1350
1411
  #
1351
1412
  # @!attribute [rw] image_recipe_arn
1352
- # The Amazon Resource Name (ARN) of the image recipe that will be used
1353
- # to configure images created by this image pipeline.
1413
+ # The Amazon Resource Name (ARN) of the image recipe that configures
1414
+ # images created by this image pipeline.
1354
1415
  # @return [String]
1355
1416
  #
1356
1417
  # @!attribute [rw] container_recipe_arn
@@ -1360,13 +1421,13 @@ module Aws::Imagebuilder
1360
1421
  #
1361
1422
  # @!attribute [rw] infrastructure_configuration_arn
1362
1423
  # The Amazon Resource Name (ARN) of the infrastructure configuration
1363
- # that will be used to build images created by this image pipeline.
1424
+ # that builds images created by this image pipeline.
1364
1425
  # @return [String]
1365
1426
  #
1366
1427
  # @!attribute [rw] distribution_configuration_arn
1367
1428
  # The Amazon Resource Name (ARN) of the distribution configuration
1368
- # that will be used to configure and distribute images created by this
1369
- # image pipeline.
1429
+ # that configures and distributes images created by this image
1430
+ # pipeline.
1370
1431
  # @return [String]
1371
1432
  #
1372
1433
  # @!attribute [rw] image_tests_configuration
@@ -1374,10 +1435,9 @@ module Aws::Imagebuilder
1374
1435
  # @return [Types::ImageTestsConfiguration]
1375
1436
  #
1376
1437
  # @!attribute [rw] enhanced_image_metadata_enabled
1377
- # Collects additional information about the image being created,
1378
- # including the operating system (OS) version and package list. This
1379
- # information is used to enhance the overall experience of using EC2
1380
- # Image Builder. Enabled by default.
1438
+ # Specifies whether to collect additional information about the image
1439
+ # being created, including the operating system (OS) version and
1440
+ # package list. Defaults to `true`.
1381
1441
  # @return [Boolean]
1382
1442
  #
1383
1443
  # @!attribute [rw] schedule
@@ -1397,8 +1457,10 @@ module Aws::Imagebuilder
1397
1457
  # @return [Hash<String,String>]
1398
1458
  #
1399
1459
  # @!attribute [rw] client_token
1400
- # Unique, case-sensitive identifier you provide to ensure idempotency
1401
- # of the request. For more information, see [Ensuring idempotency][1]
1460
+ # 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]
1402
1464
  # in the *Amazon EC2 API Reference*.
1403
1465
  #
1404
1466
  # **A suitable default value is auto-generated.** You should normally
@@ -1431,6 +1493,12 @@ module Aws::Imagebuilder
1431
1493
  # prefix, you must also provide an `executionRole`.
1432
1494
  # @return [Types::PipelineLoggingConfiguration]
1433
1495
  #
1496
+ # @!attribute [rw] dry_run
1497
+ # Validates the required permissions and request parameters without
1498
+ # making the request. If validation succeeds, the operation returns a
1499
+ # `DryRunOperationException` error response.
1500
+ # @return [Boolean]
1501
+ #
1434
1502
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImagePipelineRequest AWS API Documentation
1435
1503
  #
1436
1504
  class CreateImagePipelineRequest < Struct.new(
@@ -1450,7 +1518,8 @@ module Aws::Imagebuilder
1450
1518
  :image_scanning_configuration,
1451
1519
  :workflows,
1452
1520
  :execution_role,
1453
- :logging_configuration)
1521
+ :logging_configuration,
1522
+ :dry_run)
1454
1523
  SENSITIVE = []
1455
1524
  include Aws::Structure
1456
1525
  end
@@ -1494,10 +1563,10 @@ module Aws::Imagebuilder
1494
1563
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
1495
1564
  # assign values for the first three, and can filter on all of them.
1496
1565
  #
1497
- # **Assignment:** For the first three nodes you can assign any
1498
- # positive integer value, including zero, with an upper limit of
1499
- # 2^30-1, or 1073741823 for each node. Image Builder automatically
1500
- # assigns the build number to the fourth node.
1566
+ # **Assignment:** For the first three nodes, you can assign any
1567
+ # positive integer value, including zero. The upper limit is 2^30-1,
1568
+ # or 1073741823, for each node. Image Builder automatically assigns
1569
+ # the build number to the fourth node.
1501
1570
  #
1502
1571
  # **Patterns:** You can use any numeric pattern that adheres to the
1503
1572
  # assignment requirements for the nodes that you can assign. For
@@ -1543,8 +1612,7 @@ module Aws::Imagebuilder
1543
1612
  # @return [String]
1544
1613
  #
1545
1614
  # @!attribute [rw] additional_instance_configuration
1546
- # Specify additional settings and launch scripts for your build
1547
- # instances.
1615
+ # The additional settings and launch scripts for your build instances.
1548
1616
  # @return [Types::AdditionalInstanceConfiguration]
1549
1617
  #
1550
1618
  # @!attribute [rw] ami_tags
@@ -1565,8 +1633,10 @@ module Aws::Imagebuilder
1565
1633
  # @return [Array<String>]
1566
1634
  #
1567
1635
  # @!attribute [rw] client_token
1568
- # Unique, case-sensitive identifier you provide to ensure idempotency
1569
- # of the request. For more information, see [Ensuring idempotency][1]
1636
+ # 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]
1570
1640
  # in the *Amazon EC2 API Reference*.
1571
1641
  #
1572
1642
  # **A suitable default value is auto-generated.** You should normally
@@ -1577,6 +1647,12 @@ module Aws::Imagebuilder
1577
1647
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
1578
1648
  # @return [String]
1579
1649
  #
1650
+ # @!attribute [rw] dry_run
1651
+ # Validates the required permissions and request parameters without
1652
+ # making the request. If validation succeeds, the operation returns a
1653
+ # `DryRunOperationException` error response.
1654
+ # @return [Boolean]
1655
+ #
1580
1656
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageRecipeRequest AWS API Documentation
1581
1657
  #
1582
1658
  class CreateImageRecipeRequest < Struct.new(
@@ -1591,7 +1667,8 @@ module Aws::Imagebuilder
1591
1667
  :additional_instance_configuration,
1592
1668
  :ami_tags,
1593
1669
  :ami_watermarks,
1594
- :client_token)
1670
+ :client_token,
1671
+ :dry_run)
1595
1672
  SENSITIVE = []
1596
1673
  include Aws::Structure
1597
1674
  end
@@ -1651,10 +1728,9 @@ module Aws::Imagebuilder
1651
1728
  # @return [Types::ImageTestsConfiguration]
1652
1729
  #
1653
1730
  # @!attribute [rw] enhanced_image_metadata_enabled
1654
- # Collects additional information about the image being created,
1655
- # including the operating system (OS) version and package list. This
1656
- # information is used to enhance the overall experience of using EC2
1657
- # Image Builder. Enabled by default.
1731
+ # Specifies whether to collect additional information about the image
1732
+ # being created, including the operating system (OS) version and
1733
+ # package list. Defaults to `true`.
1658
1734
  # @return [Boolean]
1659
1735
  #
1660
1736
  # @!attribute [rw] tags
@@ -1662,8 +1738,10 @@ module Aws::Imagebuilder
1662
1738
  # @return [Hash<String,String>]
1663
1739
  #
1664
1740
  # @!attribute [rw] client_token
1665
- # Unique, case-sensitive identifier you provide to ensure idempotency
1666
- # of the request. For more information, see [Ensuring idempotency][1]
1741
+ # 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]
1667
1745
  # in the *Amazon EC2 API Reference*.
1668
1746
  #
1669
1747
  # **A suitable default value is auto-generated.** You should normally
@@ -1688,7 +1766,7 @@ module Aws::Imagebuilder
1688
1766
  # @return [String]
1689
1767
  #
1690
1768
  # @!attribute [rw] logging_configuration
1691
- # Define logging configuration for the image build process.
1769
+ # The logging configuration for the image build process.
1692
1770
  # @return [Types::ImageLoggingConfiguration]
1693
1771
  #
1694
1772
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageRequest AWS API Documentation
@@ -1749,8 +1827,8 @@ module Aws::Imagebuilder
1749
1827
  #
1750
1828
  # @!attribute [rw] instance_types
1751
1829
  # The instance types of the infrastructure configuration. You can
1752
- # specify one or more instance types to use for this build. The
1753
- # service will pick one of these instance types based on availability.
1830
+ # specify one or more instance types to use for this build. Image
1831
+ # Builder picks one of these instance types based on availability.
1754
1832
  # @return [Array<String>]
1755
1833
  #
1756
1834
  # @!attribute [rw] instance_profile_name
@@ -1778,15 +1856,15 @@ module Aws::Imagebuilder
1778
1856
  # @return [String]
1779
1857
  #
1780
1858
  # @!attribute [rw] terminate_instance_on_failure
1781
- # The terminate instance on failure setting of the infrastructure
1782
- # configuration. Set to false if you want Image Builder to retain the
1783
- # instance used to configure your AMI if the build or test phase of
1784
- # your workflow fails.
1859
+ # Specifies whether to terminate the instance on failure. Set to false
1860
+ # if you want Image Builder to retain the instance used to configure
1861
+ # your AMI if the build or test phase of your workflow fails. Defaults
1862
+ # to `true`.
1785
1863
  # @return [Boolean]
1786
1864
  #
1787
1865
  # @!attribute [rw] sns_topic_arn
1788
- # The Amazon Resource Name (ARN) for the SNS topic to which we send
1789
- # image build event notifications.
1866
+ # The Amazon Resource Name (ARN) of the SNS topic to which Image
1867
+ # Builder sends image build event notifications.
1790
1868
  #
1791
1869
  # <note markdown="1"> EC2 Image Builder is unable to send notifications to SNS topics that
1792
1870
  # are encrypted using keys from other accounts. The key that is used
@@ -1815,12 +1893,14 @@ module Aws::Imagebuilder
1815
1893
  #
1816
1894
  # @!attribute [rw] placement
1817
1895
  # The instance placement settings that define where the instances that
1818
- # are launched from your image will run.
1896
+ # are launched from your image run.
1819
1897
  # @return [Types::Placement]
1820
1898
  #
1821
1899
  # @!attribute [rw] client_token
1822
- # Unique, case-sensitive identifier you provide to ensure idempotency
1823
- # of the request. For more information, see [Ensuring idempotency][1]
1900
+ # 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]
1824
1904
  # in the *Amazon EC2 API Reference*.
1825
1905
  #
1826
1906
  # **A suitable default value is auto-generated.** You should normally
@@ -1831,6 +1911,12 @@ module Aws::Imagebuilder
1831
1911
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
1832
1912
  # @return [String]
1833
1913
  #
1914
+ # @!attribute [rw] dry_run
1915
+ # Validates the required permissions and request parameters without
1916
+ # making the request. If validation succeeds, the operation returns a
1917
+ # `DryRunOperationException` error response.
1918
+ # @return [Boolean]
1919
+ #
1834
1920
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateInfrastructureConfigurationRequest AWS API Documentation
1835
1921
  #
1836
1922
  class CreateInfrastructureConfigurationRequest < Struct.new(
@@ -1848,7 +1934,8 @@ module Aws::Imagebuilder
1848
1934
  :instance_metadata_options,
1849
1935
  :tags,
1850
1936
  :placement,
1851
- :client_token)
1937
+ :client_token,
1938
+ :dry_run)
1852
1939
  SENSITIVE = []
1853
1940
  include Aws::Structure
1854
1941
  end
@@ -1912,8 +1999,10 @@ module Aws::Imagebuilder
1912
1999
  # @return [Hash<String,String>]
1913
2000
  #
1914
2001
  # @!attribute [rw] client_token
1915
- # Unique, case-sensitive identifier you provide to ensure idempotency
1916
- # of the request. For more information, see [Ensuring idempotency][1]
2002
+ # 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]
1917
2006
  # in the *Amazon EC2 API Reference*.
1918
2007
  #
1919
2008
  # **A suitable default value is auto-generated.** You should normally
@@ -1924,6 +2013,12 @@ module Aws::Imagebuilder
1924
2013
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
1925
2014
  # @return [String]
1926
2015
  #
2016
+ # @!attribute [rw] dry_run
2017
+ # Validates the required permissions and request parameters without
2018
+ # making the request. If validation succeeds, the operation returns a
2019
+ # `DryRunOperationException` error response.
2020
+ # @return [Boolean]
2021
+ #
1927
2022
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateLifecyclePolicyRequest AWS API Documentation
1928
2023
  #
1929
2024
  class CreateLifecyclePolicyRequest < Struct.new(
@@ -1935,7 +2030,8 @@ module Aws::Imagebuilder
1935
2030
  :policy_details,
1936
2031
  :resource_selection,
1937
2032
  :tags,
1938
- :client_token)
2033
+ :client_token,
2034
+ :dry_run)
1939
2035
  SENSITIVE = []
1940
2036
  include Aws::Structure
1941
2037
  end
@@ -1970,10 +2066,10 @@ module Aws::Imagebuilder
1970
2066
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
1971
2067
  # assign values for the first three, and can filter on all of them.
1972
2068
  #
1973
- # **Assignment:** For the first three nodes you can assign any
1974
- # positive integer value, including zero, with an upper limit of
1975
- # 2^30-1, or 1073741823 for each node. Image Builder automatically
1976
- # assigns the build number to the fourth node.
2069
+ # **Assignment:** For the first three nodes, you can assign any
2070
+ # positive integer value, including zero. The upper limit is 2^30-1,
2071
+ # or 1073741823, for each node. Image Builder automatically assigns
2072
+ # the build number to the fourth node.
1977
2073
  #
1978
2074
  # **Patterns:** You can use any numeric pattern that adheres to the
1979
2075
  # assignment requirements for the nodes that you can assign. For
@@ -2001,9 +2097,9 @@ module Aws::Imagebuilder
2001
2097
  #
2002
2098
  # @!attribute [rw] uri
2003
2099
  # The `uri` of a YAML component document file. This must be an S3 URL
2004
- # (`s3://bucket/key`), and the requester must have permission to
2005
- # access the S3 bucket it points to. If you use Amazon S3, you can
2006
- # specify component content up to your service quota.
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.
2007
2103
  #
2008
2104
  # Alternatively, you can specify the YAML document inline, using the
2009
2105
  # component `data` property. You cannot specify both properties.
@@ -2025,8 +2121,10 @@ module Aws::Imagebuilder
2025
2121
  # @return [Hash<String,String>]
2026
2122
  #
2027
2123
  # @!attribute [rw] client_token
2028
- # Unique, case-sensitive identifier you provide to ensure idempotency
2029
- # of the request. For more information, see [Ensuring idempotency][1]
2124
+ # 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]
2030
2128
  # in the *Amazon EC2 API Reference*.
2031
2129
  #
2032
2130
  # **A suitable default value is auto-generated.** You should normally
@@ -2043,10 +2141,9 @@ module Aws::Imagebuilder
2043
2141
  # @return [String]
2044
2142
  #
2045
2143
  # @!attribute [rw] dry_run
2046
- # Validates the required permissions for the operation and the request
2047
- # parameters, without actually making the request, and provides an
2048
- # error response. Upon a successful request, the error response is
2049
- # `DryRunOperationException`.
2144
+ # Validates the required permissions and request parameters without
2145
+ # making the request. If validation succeeds, the operation returns a
2146
+ # `DryRunOperationException` error response.
2050
2147
  # @return [Boolean]
2051
2148
  #
2052
2149
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateWorkflowRequest AWS API Documentation
@@ -2480,8 +2577,10 @@ module Aws::Imagebuilder
2480
2577
  # @return [Hash<String,String>]
2481
2578
  #
2482
2579
  # @!attribute [rw] client_token
2483
- # Unique, case-sensitive identifier you provide to ensure idempotency
2484
- # of the request. For more information, see [Ensuring idempotency][1]
2580
+ # 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]
2485
2584
  # in the *Amazon EC2 API Reference*.
2486
2585
  #
2487
2586
  # **A suitable default value is auto-generated.** You should normally
@@ -2678,6 +2777,28 @@ module Aws::Imagebuilder
2678
2777
  include Aws::Structure
2679
2778
  end
2680
2779
 
2780
+ # Contains details about a failure that occurred while Image Builder
2781
+ # distributed the image or applied configuration to the distributed
2782
+ # image.
2783
+ #
2784
+ # @!attribute [rw] error_message
2785
+ # The error message for the distribution failure.
2786
+ # @return [String]
2787
+ #
2788
+ # @!attribute [rw] region_failures
2789
+ # The details about the failure for each Region where the image
2790
+ # didn't finish distribution or configuration.
2791
+ # @return [Array<Types::RegionFailure>]
2792
+ #
2793
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DistributionFailureContext AWS API Documentation
2794
+ #
2795
+ class DistributionFailureContext < Struct.new(
2796
+ :error_message,
2797
+ :region_failures)
2798
+ SENSITIVE = []
2799
+ include Aws::Structure
2800
+ end
2801
+
2681
2802
  # The dry run operation of the resource was successful, and no resources
2682
2803
  # or mutations were actually performed due to the dry run flag in the
2683
2804
  # request.
@@ -2696,15 +2817,16 @@ module Aws::Imagebuilder
2696
2817
  # Amazon EBS-specific block device mapping specifications.
2697
2818
  #
2698
2819
  # @!attribute [rw] encrypted
2699
- # Use to configure device encryption.
2820
+ # Specifies whether to encrypt the device.
2700
2821
  # @return [Boolean]
2701
2822
  #
2702
2823
  # @!attribute [rw] delete_on_termination
2703
- # Use to configure delete on termination of the associated device.
2824
+ # Specifies whether to delete the associated device on termination.
2704
2825
  # @return [Boolean]
2705
2826
  #
2706
2827
  # @!attribute [rw] iops
2707
- # Use to configure device IOPS.
2828
+ # The IOPS value for the device. Required only when volumeType is io1
2829
+ # or io2.
2708
2830
  # @return [Integer]
2709
2831
  #
2710
2832
  # @!attribute [rw] kms_key_id
@@ -2723,11 +2845,11 @@ module Aws::Imagebuilder
2723
2845
  # @return [String]
2724
2846
  #
2725
2847
  # @!attribute [rw] volume_size
2726
- # Use to override the device's volume size.
2848
+ # Overrides the volume size for the device.
2727
2849
  # @return [Integer]
2728
2850
  #
2729
2851
  # @!attribute [rw] volume_type
2730
- # Use to override the device's volume type.
2852
+ # Overrides the volume type for the device.
2731
2853
  # @return [String]
2732
2854
  #
2733
2855
  # @!attribute [rw] throughput
@@ -3259,8 +3381,8 @@ module Aws::Imagebuilder
3259
3381
  end
3260
3382
 
3261
3383
  # @!attribute [rw] lifecycle_execution_id
3262
- # Use the unique identifier for a runtime instance of the lifecycle
3263
- # policy to get runtime details.
3384
+ # The unique identifier for a runtime instance of the lifecycle
3385
+ # policy.
3264
3386
  # @return [String]
3265
3387
  #
3266
3388
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetLifecycleExecutionRequest AWS API Documentation
@@ -3588,6 +3710,19 @@ module Aws::Imagebuilder
3588
3710
  # action.
3589
3711
  # @return [Integer]
3590
3712
  #
3713
+ # @!attribute [rw] attempt_number
3714
+ # The current attempt number for the specified runtime instance of the
3715
+ # workflow step. The first run is attempt one. The number increases by
3716
+ # one for each retry.
3717
+ # @return [Integer]
3718
+ #
3719
+ # @!attribute [rw] max_attempts
3720
+ # The maximum number of attempts allowed for the specified runtime
3721
+ # instance of the workflow step, based on the retry configuration in
3722
+ # the workflow document. If the step doesn't configure retries, the
3723
+ # maximum is one attempt.
3724
+ # @return [Integer]
3725
+ #
3591
3726
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetWorkflowStepExecutionResponse AWS API Documentation
3592
3727
  #
3593
3728
  class GetWorkflowStepExecutionResponse < Struct.new(
@@ -3607,7 +3742,9 @@ module Aws::Imagebuilder
3607
3742
  :start_time,
3608
3743
  :end_time,
3609
3744
  :on_failure,
3610
- :timeout_seconds)
3745
+ :timeout_seconds,
3746
+ :attempt_number,
3747
+ :max_attempts)
3611
3748
  SENSITIVE = []
3612
3749
  include Aws::Structure
3613
3750
  end
@@ -3667,21 +3804,20 @@ module Aws::Imagebuilder
3667
3804
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
3668
3805
  # assign values for the first three, and can filter on all of them.
3669
3806
  #
3670
- # **Assignment:** For the first three nodes you can assign any
3671
- # positive integer value, including zero, with an upper limit of
3672
- # 2^30-1, or 1073741823 for each node. Image Builder automatically
3673
- # assigns the build number to the fourth node.
3807
+ # **Assignment:** For the first three nodes, you can assign any
3808
+ # positive integer value, including zero. The upper limit is 2^30-1,
3809
+ # or 1073741823, for each node. Image Builder automatically assigns
3810
+ # the build number to the fourth node.
3674
3811
  #
3675
3812
  # **Patterns:** You can use any numeric pattern that adheres to the
3676
3813
  # assignment requirements for the nodes that you can assign. For
3677
3814
  # example, you might choose a software version pattern, such as 1.0.0,
3678
3815
  # or a date, such as 2021.01.01.
3679
3816
  #
3680
- # **Filtering:** With semantic versioning, you have the flexibility to
3681
- # use wildcards (x) to specify the most recent versions or nodes when
3682
- # selecting the base image or components for your recipe. When you use
3683
- # a wildcard in any node, all nodes to the right of the first wildcard
3684
- # must also be wildcards.
3817
+ # **Filtering:** You can use wildcards (x) to specify the most recent
3818
+ # versions or nodes when selecting the base image or components for
3819
+ # your recipe. When you use a wildcard in any node, all nodes to the
3820
+ # right of the first wildcard must also be wildcards.
3685
3821
  #
3686
3822
  # </note>
3687
3823
  # @return [String]
@@ -3863,6 +3999,59 @@ module Aws::Imagebuilder
3863
3999
  include Aws::Structure
3864
4000
  end
3865
4001
 
4002
+ # Contains details about the failure when the image creation process
4003
+ # fails. Properties appear in the failure context when the related
4004
+ # information is available for the failure.
4005
+ #
4006
+ # @!attribute [rw] image_status
4007
+ # The status that the image had when the failure occurred. This
4008
+ # indicates the stage of the image creation process where the image
4009
+ # failed, for example `BUILDING` or `DISTRIBUTING`.
4010
+ # @return [String]
4011
+ #
4012
+ # @!attribute [rw] workflow_execution_id
4013
+ # The unique identifier of the workflow execution that was running
4014
+ # when the image failed.
4015
+ # @return [String]
4016
+ #
4017
+ # @!attribute [rw] workflow_arn
4018
+ # The Amazon Resource Name (ARN) of the workflow build version that
4019
+ # was running when the image failed.
4020
+ # @return [String]
4021
+ #
4022
+ # @!attribute [rw] step_execution_id
4023
+ # The unique identifier of the workflow step execution that failed.
4024
+ # @return [String]
4025
+ #
4026
+ # @!attribute [rw] failed_step
4027
+ # The name of the workflow step that failed, as it appears in the
4028
+ # workflow document.
4029
+ # @return [String]
4030
+ #
4031
+ # @!attribute [rw] component_failure
4032
+ # The details about the component that failed, if the failure occurred
4033
+ # while a component was running.
4034
+ # @return [Types::ComponentFailureContext]
4035
+ #
4036
+ # @!attribute [rw] distribution_failure
4037
+ # The details about the distribution failure, if the failure occurred
4038
+ # while Image Builder distributed or configured the image.
4039
+ # @return [Types::DistributionFailureContext]
4040
+ #
4041
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImageFailureContext AWS API Documentation
4042
+ #
4043
+ class ImageFailureContext < Struct.new(
4044
+ :image_status,
4045
+ :workflow_execution_id,
4046
+ :workflow_arn,
4047
+ :step_execution_id,
4048
+ :failed_step,
4049
+ :component_failure,
4050
+ :distribution_failure)
4051
+ SENSITIVE = []
4052
+ include Aws::Structure
4053
+ end
4054
+
3866
4055
  # The logging configuration that's defined for the image. Image Builder
3867
4056
  # uses the defined settings to direct execution log output during image
3868
4057
  # creation.
@@ -3922,10 +4111,9 @@ module Aws::Imagebuilder
3922
4111
  # @return [String]
3923
4112
  #
3924
4113
  # @!attribute [rw] enhanced_image_metadata_enabled
3925
- # Collects additional information about the image being created,
3926
- # including the operating system (OS) version and package list. This
3927
- # information is used to enhance the overall experience of using EC2
3928
- # Image Builder. Enabled by default.
4114
+ # Specifies whether to collect additional information about the image
4115
+ # being created, including the operating system (OS) version and
4116
+ # package list. Defaults to `true`.
3929
4117
  # @return [Boolean]
3930
4118
  #
3931
4119
  # @!attribute [rw] image_recipe_arn
@@ -4433,11 +4621,18 @@ module Aws::Imagebuilder
4433
4621
  # The reason for the status of the image.
4434
4622
  # @return [String]
4435
4623
  #
4624
+ # @!attribute [rw] failure_context
4625
+ # The details about the failure, for images that failed to complete.
4626
+ # Image Builder only sets this property when the image status is
4627
+ # `FAILED`.
4628
+ # @return [Types::ImageFailureContext]
4629
+ #
4436
4630
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImageState AWS API Documentation
4437
4631
  #
4438
4632
  class ImageState < Struct.new(
4439
4633
  :status,
4440
- :reason)
4634
+ :reason,
4635
+ :failure_context)
4441
4636
  SENSITIVE = []
4442
4637
  include Aws::Structure
4443
4638
  end
@@ -4553,9 +4748,9 @@ module Aws::Imagebuilder
4553
4748
  # before distributing it.
4554
4749
  #
4555
4750
  # @!attribute [rw] image_tests_enabled
4556
- # Determines if tests should run after building the image. Image
4557
- # Builder defaults to enable tests to run following the image build,
4558
- # before image distribution.
4751
+ # Specifies whether tests run after building the image. When enabled,
4752
+ # tests run after the image build and before image distribution.
4753
+ # Defaults to `true`.
4559
4754
  # @return [Boolean]
4560
4755
  #
4561
4756
  # @!attribute [rw] timeout_minutes
@@ -4614,21 +4809,20 @@ module Aws::Imagebuilder
4614
4809
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
4615
4810
  # assign values for the first three, and can filter on all of them.
4616
4811
  #
4617
- # **Assignment:** For the first three nodes you can assign any
4618
- # positive integer value, including zero, with an upper limit of
4619
- # 2^30-1, or 1073741823 for each node. Image Builder automatically
4620
- # assigns the build number to the fourth node.
4812
+ # **Assignment:** For the first three nodes, you can assign any
4813
+ # positive integer value, including zero. The upper limit is 2^30-1,
4814
+ # or 1073741823, for each node. Image Builder automatically assigns
4815
+ # the build number to the fourth node.
4621
4816
  #
4622
4817
  # **Patterns:** You can use any numeric pattern that adheres to the
4623
4818
  # assignment requirements for the nodes that you can assign. For
4624
4819
  # example, you might choose a software version pattern, such as 1.0.0,
4625
4820
  # or a date, such as 2021.01.01.
4626
4821
  #
4627
- # **Filtering:** With semantic versioning, you have the flexibility to
4628
- # use wildcards (x) to specify the most recent versions or nodes when
4629
- # selecting the base image or components for your recipe. When you use
4630
- # a wildcard in any node, all nodes to the right of the first wildcard
4631
- # must also be wildcards.
4822
+ # **Filtering:** You can use wildcards (x) to specify the most recent
4823
+ # versions or nodes when selecting the base image or components for
4824
+ # your recipe. When you use a wildcard in any node, all nodes to the
4825
+ # right of the first wildcard must also be wildcards.
4632
4826
  #
4633
4827
  # </note>
4634
4828
  # @return [String]
@@ -4702,11 +4896,10 @@ module Aws::Imagebuilder
4702
4896
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
4703
4897
  # assign values for the first three, and can filter on all of them.
4704
4898
  #
4705
- # **Filtering:** With semantic versioning, you have the flexibility to
4706
- # use wildcards (x) to specify the most recent versions or nodes when
4707
- # selecting the base image or components for your recipe. When you use
4708
- # a wildcard in any node, all nodes to the right of the first wildcard
4709
- # must also be wildcards.
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.
4710
4903
  #
4711
4904
  # </note>
4712
4905
  # @return [String]
@@ -4742,11 +4935,11 @@ module Aws::Imagebuilder
4742
4935
  # @return [String]
4743
4936
  #
4744
4937
  # @!attribute [rw] uri
4745
- # The uri of the component. Must be an Amazon S3 URL and the requester
4746
- # must have permission to access the Amazon S3 bucket. If you use
4747
- # Amazon S3, you can specify component content up to your service
4748
- # quota. Either `data` or `uri` can be used to specify the data within
4749
- # the component.
4938
+ # The uri of the component. Must be an Amazon S3 URL and you must have
4939
+ # permission to access the Amazon S3 bucket. If you use Amazon S3, you
4940
+ # can specify component content up to your service quota. Either
4941
+ # `data` or `uri` can be used to specify the data within the
4942
+ # component.
4750
4943
  # @return [String]
4751
4944
  #
4752
4945
  # @!attribute [rw] kms_key_id
@@ -4765,8 +4958,10 @@ module Aws::Imagebuilder
4765
4958
  # @return [Hash<String,String>]
4766
4959
  #
4767
4960
  # @!attribute [rw] client_token
4768
- # Unique, case-sensitive identifier you provide to ensure idempotency
4769
- # of the request. For more information, see [Ensuring idempotency][1]
4961
+ # 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]
4770
4965
  # in the *Amazon EC2 API Reference*.
4771
4966
  #
4772
4967
  # **A suitable default value is auto-generated.** You should normally
@@ -4859,7 +5054,7 @@ module Aws::Imagebuilder
4859
5054
  # @return [String]
4860
5055
  #
4861
5056
  # @!attribute [rw] logging_configuration
4862
- # Define logging configuration for the image build process.
5057
+ # The logging configuration for the image build process.
4863
5058
  # @return [Types::ImageLoggingConfiguration]
4864
5059
  #
4865
5060
  # @!attribute [rw] tags
@@ -4875,8 +5070,10 @@ module Aws::Imagebuilder
4875
5070
  # @return [Types::WindowsConfiguration]
4876
5071
  #
4877
5072
  # @!attribute [rw] client_token
4878
- # Unique, case-sensitive identifier you provide to ensure idempotency
4879
- # of the request. For more information, see [Ensuring idempotency][1]
5073
+ # 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]
4880
5077
  # in the *Amazon EC2 API Reference*.
4881
5078
  #
4882
5079
  # **A suitable default value is auto-generated.** You should normally
@@ -4938,10 +5135,10 @@ module Aws::Imagebuilder
4938
5135
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
4939
5136
  # assign values for the first three, and can filter on all of them.
4940
5137
  #
4941
- # **Assignment:** For the first three nodes you can assign any
4942
- # positive integer value, including zero, with an upper limit of
4943
- # 2^30-1, or 1073741823 for each node. Image Builder automatically
4944
- # assigns the build number to the fourth node.
5138
+ # **Assignment:** For the first three nodes, you can assign any
5139
+ # positive integer value, including zero. The upper limit is 2^30-1,
5140
+ # or 1073741823, for each node. Image Builder automatically assigns
5141
+ # the build number to the fourth node.
4945
5142
  #
4946
5143
  # **Patterns:** You can use any numeric pattern that adheres to the
4947
5144
  # assignment requirements for the nodes that you can assign. For
@@ -4972,7 +5169,7 @@ module Aws::Imagebuilder
4972
5169
  # @return [String]
4973
5170
  #
4974
5171
  # @!attribute [rw] logging_configuration
4975
- # Define logging configuration for the image build process.
5172
+ # The logging configuration for the image build process.
4976
5173
  # @return [Types::ImageLoggingConfiguration]
4977
5174
  #
4978
5175
  # @!attribute [rw] tags
@@ -4980,8 +5177,10 @@ module Aws::Imagebuilder
4980
5177
  # @return [Hash<String,String>]
4981
5178
  #
4982
5179
  # @!attribute [rw] client_token
4983
- # Unique, case-sensitive identifier you provide to ensure idempotency
4984
- # of the request. For more information, see [Ensuring idempotency][1]
5180
+ # 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]
4985
5184
  # in the *Amazon EC2 API Reference*.
4986
5185
  #
4987
5186
  # **A suitable default value is auto-generated.** You should normally
@@ -5076,8 +5275,8 @@ module Aws::Imagebuilder
5076
5275
  # @return [Boolean]
5077
5276
  #
5078
5277
  # @!attribute [rw] sns_topic_arn
5079
- # The Amazon Resource Name (ARN) for the SNS topic to which we send
5080
- # image build event notifications.
5278
+ # The Amazon Resource Name (ARN) of the SNS topic to which Image
5279
+ # Builder sends image build event notifications.
5081
5280
  #
5082
5281
  # <note markdown="1"> EC2 Image Builder is unable to send notifications to SNS topics that
5083
5282
  # are encrypted using keys from other accounts. The key that is used
@@ -5110,7 +5309,7 @@ module Aws::Imagebuilder
5110
5309
  #
5111
5310
  # @!attribute [rw] placement
5112
5311
  # The instance placement settings that define where the instances that
5113
- # are launched from your image will run.
5312
+ # are launched from your image run.
5114
5313
  # @return [Types::Placement]
5115
5314
  #
5116
5315
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InfrastructureConfiguration AWS API Documentation
@@ -5177,7 +5376,7 @@ module Aws::Imagebuilder
5177
5376
  #
5178
5377
  # @!attribute [rw] placement
5179
5378
  # The instance placement settings that define where the instances that
5180
- # are launched from your image will run.
5379
+ # are launched from your image run.
5181
5380
  # @return [Types::Placement]
5182
5381
  #
5183
5382
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InfrastructureConfigurationSummary AWS API Documentation
@@ -5221,15 +5420,15 @@ module Aws::Imagebuilder
5221
5420
  # @return [String]
5222
5421
  #
5223
5422
  # @!attribute [rw] ebs
5224
- # Use to manage Amazon EBS-specific configuration for this mapping.
5423
+ # The Amazon EBS-specific configuration for this mapping.
5225
5424
  # @return [Types::EbsInstanceBlockDeviceSpecification]
5226
5425
  #
5227
5426
  # @!attribute [rw] virtual_name
5228
- # Use to manage instance ephemeral devices.
5427
+ # The virtual device name for instance ephemeral devices.
5229
5428
  # @return [String]
5230
5429
  #
5231
5430
  # @!attribute [rw] no_device
5232
- # Use to remove a mapping from the base image.
5431
+ # Specifies a mapping to remove from the base image.
5233
5432
  # @return [String]
5234
5433
  #
5235
5434
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InstanceBlockDeviceMapping AWS API Documentation
@@ -6100,12 +6299,12 @@ module Aws::Imagebuilder
6100
6299
  # @return [String]
6101
6300
  #
6102
6301
  # @!attribute [rw] max_results
6103
- # Specify the maximum number of items to return in a request.
6302
+ # The maximum number of items to return in a single request.
6104
6303
  # @return [Integer]
6105
6304
  #
6106
6305
  # @!attribute [rw] next_token
6107
- # A token to specify where to start paginating. This is the nextToken
6108
- # from a previously truncated response.
6306
+ # A token to specify where to start paginating. Use the `nextToken`
6307
+ # value from a previously truncated response.
6109
6308
  # @return [String]
6110
6309
  #
6111
6310
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListComponentBuildVersionsRequest AWS API Documentation
@@ -6172,12 +6371,12 @@ module Aws::Imagebuilder
6172
6371
  # @return [Boolean]
6173
6372
  #
6174
6373
  # @!attribute [rw] max_results
6175
- # Specify the maximum number of items to return in a request.
6374
+ # The maximum number of items to return in a single request.
6176
6375
  # @return [Integer]
6177
6376
  #
6178
6377
  # @!attribute [rw] next_token
6179
- # A token to specify where to start paginating. This is the nextToken
6180
- # from a previously truncated response.
6378
+ # A token to specify where to start paginating. Use the `nextToken`
6379
+ # value from a previously truncated response.
6181
6380
  # @return [String]
6182
6381
  #
6183
6382
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListComponentsRequest AWS API Documentation
@@ -6242,12 +6441,12 @@ module Aws::Imagebuilder
6242
6441
  # @return [Array<Types::Filter>]
6243
6442
  #
6244
6443
  # @!attribute [rw] max_results
6245
- # Specify the maximum number of items to return in a request.
6444
+ # The maximum number of items to return in a single request.
6246
6445
  # @return [Integer]
6247
6446
  #
6248
6447
  # @!attribute [rw] next_token
6249
- # A token to specify where to start paginating. This is the nextToken
6250
- # from a previously truncated response.
6448
+ # A token to specify where to start paginating. Use the `nextToken`
6449
+ # value from a previously truncated response.
6251
6450
  # @return [String]
6252
6451
  #
6253
6452
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListContainerRecipesRequest AWS API Documentation
@@ -6291,12 +6490,12 @@ module Aws::Imagebuilder
6291
6490
  # @return [Array<Types::Filter>]
6292
6491
  #
6293
6492
  # @!attribute [rw] max_results
6294
- # Specify the maximum number of items to return in a request.
6493
+ # The maximum number of items to return in a single request.
6295
6494
  # @return [Integer]
6296
6495
  #
6297
6496
  # @!attribute [rw] next_token
6298
- # A token to specify where to start paginating. This is the nextToken
6299
- # from a previously truncated response.
6497
+ # A token to specify where to start paginating. Use the `nextToken`
6498
+ # value from a previously truncated response.
6300
6499
  # @return [String]
6301
6500
  #
6302
6501
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListDistributionConfigurationsRequest AWS API Documentation
@@ -6354,12 +6553,12 @@ module Aws::Imagebuilder
6354
6553
  # @return [Array<Types::Filter>]
6355
6554
  #
6356
6555
  # @!attribute [rw] max_results
6357
- # Specify the maximum number of items to return in a request.
6556
+ # The maximum number of items to return in a single request.
6358
6557
  # @return [Integer]
6359
6558
  #
6360
6559
  # @!attribute [rw] next_token
6361
- # A token to specify where to start paginating. This is the nextToken
6362
- # from a previously truncated response.
6560
+ # A token to specify where to start paginating. Use the `nextToken`
6561
+ # value from a previously truncated response.
6363
6562
  # @return [String]
6364
6563
  #
6365
6564
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImageBuildVersionsRequest AWS API Documentation
@@ -6404,12 +6603,12 @@ module Aws::Imagebuilder
6404
6603
  # @return [String]
6405
6604
  #
6406
6605
  # @!attribute [rw] max_results
6407
- # Specify the maximum number of items to return in a request.
6606
+ # The maximum number of items to return in a single request.
6408
6607
  # @return [Integer]
6409
6608
  #
6410
6609
  # @!attribute [rw] next_token
6411
- # A token to specify where to start paginating. This is the nextToken
6412
- # from a previously truncated response.
6610
+ # A token to specify where to start paginating. Use the `nextToken`
6611
+ # value from a previously truncated response.
6413
6612
  # @return [String]
6414
6613
  #
6415
6614
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImagePackagesRequest AWS API Documentation
@@ -6461,12 +6660,12 @@ module Aws::Imagebuilder
6461
6660
  # @return [Array<Types::Filter>]
6462
6661
  #
6463
6662
  # @!attribute [rw] max_results
6464
- # Specify the maximum number of items to return in a request.
6663
+ # The maximum number of items to return in a single request.
6465
6664
  # @return [Integer]
6466
6665
  #
6467
6666
  # @!attribute [rw] next_token
6468
- # A token to specify where to start paginating. This is the nextToken
6469
- # from a previously truncated response.
6667
+ # A token to specify where to start paginating. Use the `nextToken`
6668
+ # value from a previously truncated response.
6470
6669
  # @return [String]
6471
6670
  #
6472
6671
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImagePipelineImagesRequest AWS API Documentation
@@ -6522,12 +6721,12 @@ module Aws::Imagebuilder
6522
6721
  # @return [Array<Types::Filter>]
6523
6722
  #
6524
6723
  # @!attribute [rw] max_results
6525
- # Specify the maximum number of items to return in a request.
6724
+ # The maximum number of items to return in a single request.
6526
6725
  # @return [Integer]
6527
6726
  #
6528
6727
  # @!attribute [rw] next_token
6529
- # A token to specify where to start paginating. This is the nextToken
6530
- # from a previously truncated response.
6728
+ # A token to specify where to start paginating. Use the `nextToken`
6729
+ # value from a previously truncated response.
6531
6730
  # @return [String]
6532
6731
  #
6533
6732
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImagePipelinesRequest AWS API Documentation
@@ -6583,12 +6782,12 @@ module Aws::Imagebuilder
6583
6782
  # @return [Array<Types::Filter>]
6584
6783
  #
6585
6784
  # @!attribute [rw] max_results
6586
- # Specify the maximum number of items to return in a request.
6785
+ # The maximum number of items to return in a single request.
6587
6786
  # @return [Integer]
6588
6787
  #
6589
6788
  # @!attribute [rw] next_token
6590
- # A token to specify where to start paginating. This is the nextToken
6591
- # from a previously truncated response.
6789
+ # A token to specify where to start paginating. Use the `nextToken`
6790
+ # value from a previously truncated response.
6592
6791
  # @return [String]
6593
6792
  #
6594
6793
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImageRecipesRequest AWS API Documentation
@@ -6638,8 +6837,8 @@ module Aws::Imagebuilder
6638
6837
  # @return [Types::Filter]
6639
6838
  #
6640
6839
  # @!attribute [rw] next_token
6641
- # A token to specify where to start paginating. This is the nextToken
6642
- # from a previously truncated response.
6840
+ # A token to specify where to start paginating. Use the `nextToken`
6841
+ # value from a previously truncated response.
6643
6842
  # @return [String]
6644
6843
  #
6645
6844
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImageScanFindingAggregationsRequest AWS API Documentation
@@ -6716,12 +6915,12 @@ module Aws::Imagebuilder
6716
6915
  # @return [Array<Types::ImageScanFindingsFilter>]
6717
6916
  #
6718
6917
  # @!attribute [rw] max_results
6719
- # Specify the maximum number of items to return in a request.
6918
+ # The maximum number of items to return in a single request.
6720
6919
  # @return [Integer]
6721
6920
  #
6722
6921
  # @!attribute [rw] next_token
6723
- # A token to specify where to start paginating. This is the nextToken
6724
- # from a previously truncated response.
6922
+ # A token to specify where to start paginating. Use the `nextToken`
6923
+ # value from a previously truncated response.
6725
6924
  # @return [String]
6726
6925
  #
6727
6926
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImageScanFindingsRequest AWS API Documentation
@@ -6761,11 +6960,9 @@ module Aws::Imagebuilder
6761
6960
  end
6762
6961
 
6763
6962
  # @!attribute [rw] owner
6764
- # The owner defines which images you want to list. By default, this
6765
- # request will only show images owned by your account. You can use
6766
- # this field to specify if you want to view images owned by yourself,
6767
- # by Amazon, or those images that have been shared with you by other
6768
- # customers.
6963
+ # Filters the list to images owned by you, by Amazon, or shared with
6964
+ # you by other accounts. By default, only your account's images are
6965
+ # returned.
6769
6966
  # @return [String]
6770
6967
  #
6771
6968
  # @!attribute [rw] filters
@@ -6787,12 +6984,12 @@ module Aws::Imagebuilder
6787
6984
  # @return [Boolean]
6788
6985
  #
6789
6986
  # @!attribute [rw] max_results
6790
- # Specify the maximum number of items to return in a request.
6987
+ # The maximum number of items to return in a single request.
6791
6988
  # @return [Integer]
6792
6989
  #
6793
6990
  # @!attribute [rw] next_token
6794
- # A token to specify where to start paginating. This is the nextToken
6795
- # from a previously truncated response.
6991
+ # A token to specify where to start paginating. Use the `nextToken`
6992
+ # value from a previously truncated response.
6796
6993
  # @return [String]
6797
6994
  #
6798
6995
  # @!attribute [rw] include_deprecated
@@ -6823,11 +7020,10 @@ module Aws::Imagebuilder
6823
7020
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
6824
7021
  # assign values for the first three, and can filter on all of them.
6825
7022
  #
6826
- # **Filtering:** With semantic versioning, you have the flexibility to
6827
- # use wildcards (x) to specify the most recent versions or nodes when
6828
- # selecting the base image or components for your recipe. When you use
6829
- # a wildcard in any node, all nodes to the right of the first wildcard
6830
- # must also be wildcards.
7023
+ # **Filtering:** You can use wildcards (x) to specify the most recent
7024
+ # versions or nodes when selecting the base image or components for
7025
+ # your recipe. When you use a wildcard in any node, all nodes to the
7026
+ # right of the first wildcard must also be wildcards.
6831
7027
  #
6832
7028
  # </note>
6833
7029
  # @return [Array<Types::ImageVersion>]
@@ -6854,12 +7050,12 @@ module Aws::Imagebuilder
6854
7050
  # @return [Array<Types::Filter>]
6855
7051
  #
6856
7052
  # @!attribute [rw] max_results
6857
- # Specify the maximum number of items to return in a request.
7053
+ # The maximum number of items to return in a single request.
6858
7054
  # @return [Integer]
6859
7055
  #
6860
7056
  # @!attribute [rw] next_token
6861
- # A token to specify where to start paginating. This is the nextToken
6862
- # from a previously truncated response.
7057
+ # A token to specify where to start paginating. Use the `nextToken`
7058
+ # value from a previously truncated response.
6863
7059
  # @return [String]
6864
7060
  #
6865
7061
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListInfrastructureConfigurationsRequest AWS API Documentation
@@ -6898,8 +7094,8 @@ module Aws::Imagebuilder
6898
7094
  end
6899
7095
 
6900
7096
  # @!attribute [rw] lifecycle_execution_id
6901
- # Use the unique identifier for a runtime instance of the lifecycle
6902
- # policy to get runtime details.
7097
+ # The unique identifier for a runtime instance of the lifecycle
7098
+ # policy.
6903
7099
  # @return [String]
6904
7100
  #
6905
7101
  # @!attribute [rw] parent_resource_id
@@ -6914,12 +7110,12 @@ module Aws::Imagebuilder
6914
7110
  # @return [String]
6915
7111
  #
6916
7112
  # @!attribute [rw] max_results
6917
- # Specify the maximum number of items to return in a request.
7113
+ # The maximum number of items to return in a single request.
6918
7114
  # @return [Integer]
6919
7115
  #
6920
7116
  # @!attribute [rw] next_token
6921
- # A token to specify where to start paginating. This is the nextToken
6922
- # from a previously truncated response.
7117
+ # A token to specify where to start paginating. Use the `nextToken`
7118
+ # value from a previously truncated response.
6923
7119
  # @return [String]
6924
7120
  #
6925
7121
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListLifecycleExecutionResourcesRequest AWS API Documentation
@@ -6965,12 +7161,12 @@ module Aws::Imagebuilder
6965
7161
  end
6966
7162
 
6967
7163
  # @!attribute [rw] max_results
6968
- # Specify the maximum number of items to return in a request.
7164
+ # The maximum number of items to return in a single request.
6969
7165
  # @return [Integer]
6970
7166
  #
6971
7167
  # @!attribute [rw] next_token
6972
- # A token to specify where to start paginating. This is the nextToken
6973
- # from a previously truncated response.
7168
+ # A token to specify where to start paginating. Use the `nextToken`
7169
+ # value from a previously truncated response.
6974
7170
  # @return [String]
6975
7171
  #
6976
7172
  # @!attribute [rw] resource_arn
@@ -7014,12 +7210,12 @@ module Aws::Imagebuilder
7014
7210
  # @return [Array<Types::Filter>]
7015
7211
  #
7016
7212
  # @!attribute [rw] max_results
7017
- # Specify the maximum number of items to return in a request.
7213
+ # The maximum number of items to return in a single request.
7018
7214
  # @return [Integer]
7019
7215
  #
7020
7216
  # @!attribute [rw] next_token
7021
- # A token to specify where to start paginating. This is the nextToken
7022
- # from a previously truncated response.
7217
+ # A token to specify where to start paginating. Use the `nextToken`
7218
+ # value from a previously truncated response.
7023
7219
  # @return [String]
7024
7220
  #
7025
7221
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListLifecyclePoliciesRequest AWS API Documentation
@@ -7079,12 +7275,12 @@ module Aws::Imagebuilder
7079
7275
  end
7080
7276
 
7081
7277
  # @!attribute [rw] max_results
7082
- # Specify the maximum number of items to return in a request.
7278
+ # The maximum number of items to return in a single request.
7083
7279
  # @return [Integer]
7084
7280
  #
7085
7281
  # @!attribute [rw] next_token
7086
- # A token to specify where to start paginating. This is the nextToken
7087
- # from a previously truncated response.
7282
+ # A token to specify where to start paginating. Use the `nextToken`
7283
+ # value from a previously truncated response.
7088
7284
  # @return [String]
7089
7285
  #
7090
7286
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListWaitingWorkflowStepsRequest AWS API Documentation
@@ -7123,12 +7319,12 @@ module Aws::Imagebuilder
7123
7319
  # @return [String]
7124
7320
  #
7125
7321
  # @!attribute [rw] max_results
7126
- # Specify the maximum number of items to return in a request.
7322
+ # The maximum number of items to return in a single request.
7127
7323
  # @return [Integer]
7128
7324
  #
7129
7325
  # @!attribute [rw] next_token
7130
- # A token to specify where to start paginating. This is the nextToken
7131
- # from a previously truncated response.
7326
+ # A token to specify where to start paginating. Use the `nextToken`
7327
+ # value from a previously truncated response.
7132
7328
  # @return [String]
7133
7329
  #
7134
7330
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListWorkflowBuildVersionsRequest AWS API Documentation
@@ -7163,12 +7359,12 @@ module Aws::Imagebuilder
7163
7359
  end
7164
7360
 
7165
7361
  # @!attribute [rw] max_results
7166
- # Specify the maximum number of items to return in a request.
7362
+ # The maximum number of items to return in a single request.
7167
7363
  # @return [Integer]
7168
7364
  #
7169
7365
  # @!attribute [rw] next_token
7170
- # A token to specify where to start paginating. This is the nextToken
7171
- # from a previously truncated response.
7366
+ # A token to specify where to start paginating. Use the `nextToken`
7367
+ # value from a previously truncated response.
7172
7368
  # @return [String]
7173
7369
  #
7174
7370
  # @!attribute [rw] image_build_version_arn
@@ -7224,12 +7420,12 @@ module Aws::Imagebuilder
7224
7420
  end
7225
7421
 
7226
7422
  # @!attribute [rw] max_results
7227
- # Specify the maximum number of items to return in a request.
7423
+ # The maximum number of items to return in a single request.
7228
7424
  # @return [Integer]
7229
7425
  #
7230
7426
  # @!attribute [rw] next_token
7231
- # A token to specify where to start paginating. This is the nextToken
7232
- # from a previously truncated response.
7427
+ # A token to specify where to start paginating. Use the `nextToken`
7428
+ # value from a previously truncated response.
7233
7429
  # @return [String]
7234
7430
  #
7235
7431
  # @!attribute [rw] workflow_execution_id
@@ -7311,12 +7507,12 @@ module Aws::Imagebuilder
7311
7507
  # @return [Boolean]
7312
7508
  #
7313
7509
  # @!attribute [rw] max_results
7314
- # Specify the maximum number of items to return in a request.
7510
+ # The maximum number of items to return in a single request.
7315
7511
  # @return [Integer]
7316
7512
  #
7317
7513
  # @!attribute [rw] next_token
7318
- # A token to specify where to start paginating. This is the nextToken
7319
- # from a previously truncated response.
7514
+ # A token to specify where to start paginating. Use the `nextToken`
7515
+ # value from a previously truncated response.
7320
7516
  # @return [String]
7321
7517
  #
7322
7518
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListWorkflowsRequest AWS API Documentation
@@ -7697,6 +7893,48 @@ module Aws::Imagebuilder
7697
7893
  include Aws::Structure
7698
7894
  end
7699
7895
 
7896
+ # Contains details about a distribution or image configuration failure
7897
+ # for a single Region.
7898
+ #
7899
+ # @!attribute [rw] region
7900
+ # The Region where the failure occurred.
7901
+ # @return [String]
7902
+ #
7903
+ # @!attribute [rw] status
7904
+ # The failure status for the Region. Indicates whether the process
7905
+ # failed, was canceled, or timed out.
7906
+ # @return [String]
7907
+ #
7908
+ # @!attribute [rw] image_configuration_step
7909
+ # The image configuration step where the failure occurred. Image
7910
+ # Builder sets this property when the failure happened during
7911
+ # post-distribution configuration, such as launch template updates or
7912
+ # virtual machine (VM) export. This property doesn't appear for
7913
+ # failures that occurred while Image Builder copied the image to the
7914
+ # Region.
7915
+ # @return [String]
7916
+ #
7917
+ # @!attribute [rw] error_message
7918
+ # The error message for the failure in the Region.
7919
+ # @return [String]
7920
+ #
7921
+ # @!attribute [rw] target_account_id
7922
+ # The account ID of the account that the image was distributed to in
7923
+ # the Region.
7924
+ # @return [String]
7925
+ #
7926
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/RegionFailure AWS API Documentation
7927
+ #
7928
+ class RegionFailure < Struct.new(
7929
+ :region,
7930
+ :status,
7931
+ :image_configuration_step,
7932
+ :error_message,
7933
+ :target_account_id)
7934
+ SENSITIVE = []
7935
+ include Aws::Structure
7936
+ end
7937
+
7700
7938
  # Controls Secure Boot and UEFI data settings for the resulting image
7701
7939
  # during ISO imports. For more information, see [UEFI Secure Boot for
7702
7940
  # Amazon EC2 instances][1] in the <i> <i>Amazon EC2 User Guide</i> </i>.
@@ -7889,8 +8127,10 @@ module Aws::Imagebuilder
7889
8127
  # @return [String]
7890
8128
  #
7891
8129
  # @!attribute [rw] client_token
7892
- # Unique, case-sensitive identifier you provide to ensure idempotency
7893
- # of the request. For more information, see [Ensuring idempotency][1]
8130
+ # 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]
7894
8134
  # in the *Amazon EC2 API Reference*.
7895
8135
  #
7896
8136
  # **A suitable default value is auto-generated.** You should normally
@@ -8076,8 +8316,10 @@ module Aws::Imagebuilder
8076
8316
  # @return [String]
8077
8317
  #
8078
8318
  # @!attribute [rw] client_token
8079
- # Unique, case-sensitive identifier you provide to ensure idempotency
8080
- # of the request. For more information, see [Ensuring idempotency][1]
8319
+ # 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]
8081
8323
  # in the *Amazon EC2 API Reference*.
8082
8324
  #
8083
8325
  # **A suitable default value is auto-generated.** You should normally
@@ -8217,8 +8459,8 @@ module Aws::Imagebuilder
8217
8459
  # @return [String]
8218
8460
  #
8219
8461
  # @!attribute [rw] data_type
8220
- # The data type specifies what type of value the Parameter contains.
8221
- # We recommend that you use data type `aws:ec2:image`.
8462
+ # The type of value the parameter contains. We recommend the
8463
+ # `aws:ec2:image` data type.
8222
8464
  # @return [String]
8223
8465
  #
8224
8466
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/SsmParameterConfiguration AWS API Documentation
@@ -8237,8 +8479,10 @@ module Aws::Imagebuilder
8237
8479
  # @return [String]
8238
8480
  #
8239
8481
  # @!attribute [rw] client_token
8240
- # Unique, case-sensitive identifier you provide to ensure idempotency
8241
- # of the request. For more information, see [Ensuring idempotency][1]
8482
+ # 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]
8242
8486
  # in the *Amazon EC2 API Reference*.
8243
8487
  #
8244
8488
  # **A suitable default value is auto-generated.** You should normally
@@ -8250,8 +8494,8 @@ module Aws::Imagebuilder
8250
8494
  # @return [String]
8251
8495
  #
8252
8496
  # @!attribute [rw] tags
8253
- # Specify tags for Image Builder to apply to the image resource
8254
- # that's created When it starts pipeline execution.
8497
+ # The tags for Image Builder to apply to the image resource that's
8498
+ # created when pipeline execution starts.
8255
8499
  # @return [Hash<String,String>]
8256
8500
  #
8257
8501
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/StartImagePipelineExecutionRequest AWS API Documentation
@@ -8329,8 +8573,10 @@ module Aws::Imagebuilder
8329
8573
  # @return [Time]
8330
8574
  #
8331
8575
  # @!attribute [rw] client_token
8332
- # Unique, case-sensitive identifier you provide to ensure idempotency
8333
- # of the request. For more information, see [Ensuring idempotency][1]
8576
+ # 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]
8334
8580
  # in the *Amazon EC2 API Reference*.
8335
8581
  #
8336
8582
  # **A suitable default value is auto-generated.** You should normally
@@ -8487,8 +8733,10 @@ module Aws::Imagebuilder
8487
8733
  # @return [Array<Types::Distribution>]
8488
8734
  #
8489
8735
  # @!attribute [rw] client_token
8490
- # Unique, case-sensitive identifier you provide to ensure idempotency
8491
- # of the request. For more information, see [Ensuring idempotency][1]
8736
+ # 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]
8492
8740
  # in the *Amazon EC2 API Reference*.
8493
8741
  #
8494
8742
  # **A suitable default value is auto-generated.** You should normally
@@ -8543,8 +8791,8 @@ module Aws::Imagebuilder
8543
8791
  # @return [String]
8544
8792
  #
8545
8793
  # @!attribute [rw] image_recipe_arn
8546
- # The Amazon Resource Name (ARN) of the image recipe that will be used
8547
- # to configure images updated by this image pipeline.
8794
+ # The Amazon Resource Name (ARN) of the image recipe that configures
8795
+ # images updated by this image pipeline.
8548
8796
  # @return [String]
8549
8797
  #
8550
8798
  # @!attribute [rw] container_recipe_arn
@@ -8568,10 +8816,9 @@ module Aws::Imagebuilder
8568
8816
  # @return [Types::ImageTestsConfiguration]
8569
8817
  #
8570
8818
  # @!attribute [rw] enhanced_image_metadata_enabled
8571
- # Collects additional information about the image being created,
8572
- # including the operating system (OS) version and package list. This
8573
- # information is used to enhance the overall experience of using EC2
8574
- # Image Builder. Enabled by default.
8819
+ # Specifies whether to collect additional information about the image
8820
+ # being created, including the operating system (OS) version and
8821
+ # package list. Defaults to `true`.
8575
8822
  # @return [Boolean]
8576
8823
  #
8577
8824
  # @!attribute [rw] schedule
@@ -8583,8 +8830,10 @@ module Aws::Imagebuilder
8583
8830
  # @return [String]
8584
8831
  #
8585
8832
  # @!attribute [rw] client_token
8586
- # Unique, case-sensitive identifier you provide to ensure idempotency
8587
- # of the request. For more information, see [Ensuring idempotency][1]
8833
+ # 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]
8588
8837
  # in the *Amazon EC2 API Reference*.
8589
8838
  #
8590
8839
  # **A suitable default value is auto-generated.** You should normally
@@ -8674,8 +8923,8 @@ module Aws::Imagebuilder
8674
8923
  #
8675
8924
  # @!attribute [rw] instance_types
8676
8925
  # The instance types of the infrastructure configuration. You can
8677
- # specify one or more instance types to use for this build. The
8678
- # service will pick one of these instance types based on availability.
8926
+ # specify one or more instance types to use for this build. Image
8927
+ # Builder picks one of these instance types based on availability.
8679
8928
  # @return [Array<String>]
8680
8929
  #
8681
8930
  # @!attribute [rw] instance_profile_name
@@ -8703,15 +8952,15 @@ module Aws::Imagebuilder
8703
8952
  # @return [String]
8704
8953
  #
8705
8954
  # @!attribute [rw] terminate_instance_on_failure
8706
- # The terminate instance on failure setting of the infrastructure
8707
- # configuration. Set to false if you want Image Builder to retain the
8708
- # instance used to configure your AMI if the build or test phase of
8709
- # your workflow fails.
8955
+ # Specifies whether to terminate the instance on failure. Set to false
8956
+ # if you want Image Builder to retain the instance used to configure
8957
+ # your AMI if the build or test phase of your workflow fails. Defaults
8958
+ # to `true`.
8710
8959
  # @return [Boolean]
8711
8960
  #
8712
8961
  # @!attribute [rw] sns_topic_arn
8713
- # The Amazon Resource Name (ARN) for the SNS topic to which we send
8714
- # image build event notifications.
8962
+ # The Amazon Resource Name (ARN) of the SNS topic to which Image
8963
+ # Builder sends image build event notifications.
8715
8964
  #
8716
8965
  # <note markdown="1"> EC2 Image Builder is unable to send notifications to SNS topics that
8717
8966
  # are encrypted using keys from other accounts. The key that is used
@@ -8745,12 +8994,14 @@ module Aws::Imagebuilder
8745
8994
  #
8746
8995
  # @!attribute [rw] placement
8747
8996
  # The instance placement settings that define where the instances that
8748
- # are launched from your image will run.
8997
+ # are launched from your image run.
8749
8998
  # @return [Types::Placement]
8750
8999
  #
8751
9000
  # @!attribute [rw] client_token
8752
- # Unique, case-sensitive identifier you provide to ensure idempotency
8753
- # of the request. For more information, see [Ensuring idempotency][1]
9001
+ # 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]
8754
9005
  # in the *Amazon EC2 API Reference*.
8755
9006
  #
8756
9007
  # **A suitable default value is auto-generated.** You should normally
@@ -8836,8 +9087,10 @@ module Aws::Imagebuilder
8836
9087
  # @return [Types::LifecyclePolicyResourceSelection]
8837
9088
  #
8838
9089
  # @!attribute [rw] client_token
8839
- # Unique, case-sensitive identifier you provide to ensure idempotency
8840
- # of the request. For more information, see [Ensuring idempotency][1]
9090
+ # 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]
8841
9094
  # in the *Amazon EC2 API Reference*.
8842
9095
  #
8843
9096
  # **A suitable default value is auto-generated.** You should normally
@@ -9350,6 +9603,17 @@ module Aws::Imagebuilder
9350
9603
  # The timestamp when the workflow step finished.
9351
9604
  # @return [String]
9352
9605
  #
9606
+ # @!attribute [rw] attempt_number
9607
+ # The current attempt number for the workflow step. The first run is
9608
+ # attempt one. The number increases by one for each retry.
9609
+ # @return [Integer]
9610
+ #
9611
+ # @!attribute [rw] max_attempts
9612
+ # The maximum number of attempts allowed for the workflow step, based
9613
+ # on the retry configuration in the workflow document. If the step
9614
+ # doesn't configure retries, the maximum is one attempt.
9615
+ # @return [Integer]
9616
+ #
9353
9617
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/WorkflowStepMetadata AWS API Documentation
9354
9618
  #
9355
9619
  class WorkflowStepMetadata < Struct.new(
@@ -9363,7 +9627,9 @@ module Aws::Imagebuilder
9363
9627
  :inputs,
9364
9628
  :outputs,
9365
9629
  :start_time,
9366
- :end_time)
9630
+ :end_time,
9631
+ :attempt_number,
9632
+ :max_attempts)
9367
9633
  SENSITIVE = []
9368
9634
  include Aws::Structure
9369
9635
  end