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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-imagebuilder/client.rb +478 -300
- data/lib/aws-sdk-imagebuilder/client_api.rb +55 -0
- data/lib/aws-sdk-imagebuilder/types.rb +546 -280
- data/lib/aws-sdk-imagebuilder.rb +1 -1
- data/sig/client.rbs +14 -6
- data/sig/types.rbs +46 -0
- metadata +1 -1
|
@@ -474,17 +474,19 @@ module Aws::Imagebuilder
|
|
|
474
474
|
|
|
475
475
|
# @!group API Operations
|
|
476
476
|
|
|
477
|
-
#
|
|
478
|
-
#
|
|
477
|
+
# Cancels the creation of an image. This operation can only be used on
|
|
478
|
+
# images in a non-terminal state.
|
|
479
479
|
#
|
|
480
480
|
# @option params [required, String] :image_build_version_arn
|
|
481
481
|
# The Amazon Resource Name (ARN) of the image that you want to cancel
|
|
482
482
|
# creation for.
|
|
483
483
|
#
|
|
484
484
|
# @option params [required, String] :client_token
|
|
485
|
-
#
|
|
486
|
-
#
|
|
487
|
-
# the
|
|
485
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
486
|
+
# operation completes no more than one time. If this token matches a
|
|
487
|
+
# previous request, the service ignores the request, but does not return
|
|
488
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
489
|
+
# *Amazon EC2 API Reference*.
|
|
488
490
|
#
|
|
489
491
|
# **A suitable default value is auto-generated.** You should normally
|
|
490
492
|
# not need to pass this option.**
|
|
@@ -521,16 +523,18 @@ module Aws::Imagebuilder
|
|
|
521
523
|
req.send_request(options)
|
|
522
524
|
end
|
|
523
525
|
|
|
524
|
-
#
|
|
526
|
+
# Cancels a specific image lifecycle policy runtime instance.
|
|
525
527
|
#
|
|
526
528
|
# @option params [required, String] :lifecycle_execution_id
|
|
527
529
|
# Identifies the specific runtime instance of the image lifecycle to
|
|
528
530
|
# cancel.
|
|
529
531
|
#
|
|
530
532
|
# @option params [required, String] :client_token
|
|
531
|
-
#
|
|
532
|
-
#
|
|
533
|
-
# the
|
|
533
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
534
|
+
# operation completes no more than one time. If this token matches a
|
|
535
|
+
# previous request, the service ignores the request, but does not return
|
|
536
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
537
|
+
# *Amazon EC2 API Reference*.
|
|
534
538
|
#
|
|
535
539
|
# **A suitable default value is auto-generated.** You should normally
|
|
536
540
|
# not need to pass this option.**
|
|
@@ -583,9 +587,9 @@ module Aws::Imagebuilder
|
|
|
583
587
|
# <major>.<minor>.<patch>/<build>. You can
|
|
584
588
|
# assign values for the first three, and can filter on all of them.
|
|
585
589
|
#
|
|
586
|
-
# **Assignment:** For the first three nodes you can assign any positive
|
|
587
|
-
# integer value, including zero
|
|
588
|
-
# 1073741823 for each node. Image Builder automatically assigns the
|
|
590
|
+
# **Assignment:** For the first three nodes, you can assign any positive
|
|
591
|
+
# integer value, including zero. The upper limit is 2^30-1, or
|
|
592
|
+
# 1073741823, for each node. Image Builder automatically assigns the
|
|
589
593
|
# build number to the fourth node.
|
|
590
594
|
#
|
|
591
595
|
# **Patterns:** You can use any numeric pattern that adheres to the
|
|
@@ -618,9 +622,9 @@ module Aws::Imagebuilder
|
|
|
618
622
|
#
|
|
619
623
|
# @option params [String] :uri
|
|
620
624
|
# The `uri` of a YAML component document file. This must be an S3 URL
|
|
621
|
-
# (`s3://bucket/key`), and
|
|
622
|
-
#
|
|
623
|
-
#
|
|
625
|
+
# (`s3://bucket/key`), and you must have permission to access the S3
|
|
626
|
+
# bucket it points to. If you use Amazon S3, you can specify component
|
|
627
|
+
# content up to your service quota.
|
|
624
628
|
#
|
|
625
629
|
# Alternatively, you can specify the YAML document inline, using the
|
|
626
630
|
# component `data` property. You cannot specify both properties.
|
|
@@ -639,9 +643,11 @@ module Aws::Imagebuilder
|
|
|
639
643
|
# The tags that apply to the component.
|
|
640
644
|
#
|
|
641
645
|
# @option params [required, String] :client_token
|
|
642
|
-
#
|
|
643
|
-
#
|
|
644
|
-
# the
|
|
646
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
647
|
+
# operation completes no more than one time. If this token matches a
|
|
648
|
+
# previous request, the service ignores the request, but does not return
|
|
649
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
650
|
+
# *Amazon EC2 API Reference*.
|
|
645
651
|
#
|
|
646
652
|
# **A suitable default value is auto-generated.** You should normally
|
|
647
653
|
# not need to pass this option.**
|
|
@@ -651,10 +657,9 @@ module Aws::Imagebuilder
|
|
|
651
657
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
|
652
658
|
#
|
|
653
659
|
# @option params [Boolean] :dry_run
|
|
654
|
-
# Validates the required permissions
|
|
655
|
-
#
|
|
656
|
-
#
|
|
657
|
-
# `DryRunOperationException`.
|
|
660
|
+
# Validates the required permissions and request parameters without
|
|
661
|
+
# making the request. If validation succeeds, the operation returns a
|
|
662
|
+
# `DryRunOperationException` error response.
|
|
658
663
|
#
|
|
659
664
|
# @return [Types::CreateComponentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
660
665
|
#
|
|
@@ -721,9 +726,9 @@ module Aws::Imagebuilder
|
|
|
721
726
|
# <major>.<minor>.<patch>/<build>. You can
|
|
722
727
|
# assign values for the first three, and can filter on all of them.
|
|
723
728
|
#
|
|
724
|
-
# **Assignment:** For the first three nodes you can assign any positive
|
|
725
|
-
# integer value, including zero
|
|
726
|
-
# 1073741823 for each node. Image Builder automatically assigns the
|
|
729
|
+
# **Assignment:** For the first three nodes, you can assign any positive
|
|
730
|
+
# integer value, including zero. The upper limit is 2^30-1, or
|
|
731
|
+
# 1073741823, for each node. Image Builder automatically assigns the
|
|
727
732
|
# build number to the fourth node.
|
|
728
733
|
#
|
|
729
734
|
# **Patterns:** You can use any numeric pattern that adheres to the
|
|
@@ -745,7 +750,7 @@ module Aws::Imagebuilder
|
|
|
745
750
|
# blob.
|
|
746
751
|
#
|
|
747
752
|
# @option params [String] :dockerfile_template_uri
|
|
748
|
-
# The Amazon S3 URI for the Dockerfile that
|
|
753
|
+
# The Amazon S3 URI for the Dockerfile that is used to build your
|
|
749
754
|
# container image.
|
|
750
755
|
#
|
|
751
756
|
# @option params [String] :platform_override
|
|
@@ -778,9 +783,11 @@ module Aws::Imagebuilder
|
|
|
778
783
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
|
|
779
784
|
#
|
|
780
785
|
# @option params [required, String] :client_token
|
|
781
|
-
#
|
|
782
|
-
#
|
|
783
|
-
# the
|
|
786
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
787
|
+
# operation completes no more than one time. If this token matches a
|
|
788
|
+
# previous request, the service ignores the request, but does not return
|
|
789
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
790
|
+
# *Amazon EC2 API Reference*.
|
|
784
791
|
#
|
|
785
792
|
# **A suitable default value is auto-generated.** You should normally
|
|
786
793
|
# not need to pass this option.**
|
|
@@ -789,6 +796,11 @@ module Aws::Imagebuilder
|
|
|
789
796
|
#
|
|
790
797
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
|
791
798
|
#
|
|
799
|
+
# @option params [Boolean] :dry_run
|
|
800
|
+
# Validates the required permissions and request parameters without
|
|
801
|
+
# making the request. If validation succeeds, the operation returns a
|
|
802
|
+
# `DryRunOperationException` error response.
|
|
803
|
+
#
|
|
792
804
|
# @return [Types::CreateContainerRecipeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
793
805
|
#
|
|
794
806
|
# * {Types::CreateContainerRecipeResponse#request_id #request_id} => String
|
|
@@ -849,6 +861,7 @@ module Aws::Imagebuilder
|
|
|
849
861
|
# },
|
|
850
862
|
# kms_key_id: "NonEmptyString",
|
|
851
863
|
# client_token: "ClientToken", # required
|
|
864
|
+
# dry_run: false,
|
|
852
865
|
# })
|
|
853
866
|
#
|
|
854
867
|
# @example Response structure
|
|
@@ -886,9 +899,11 @@ module Aws::Imagebuilder
|
|
|
886
899
|
# The tags of the distribution configuration.
|
|
887
900
|
#
|
|
888
901
|
# @option params [required, String] :client_token
|
|
889
|
-
#
|
|
890
|
-
#
|
|
891
|
-
# the
|
|
902
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
903
|
+
# operation completes no more than one time. If this token matches a
|
|
904
|
+
# previous request, the service ignores the request, but does not return
|
|
905
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
906
|
+
# *Amazon EC2 API Reference*.
|
|
892
907
|
#
|
|
893
908
|
# **A suitable default value is auto-generated.** You should normally
|
|
894
909
|
# not need to pass this option.**
|
|
@@ -897,6 +912,11 @@ module Aws::Imagebuilder
|
|
|
897
912
|
#
|
|
898
913
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
|
899
914
|
#
|
|
915
|
+
# @option params [Boolean] :dry_run
|
|
916
|
+
# Validates the required permissions and request parameters without
|
|
917
|
+
# making the request. If validation succeeds, the operation returns a
|
|
918
|
+
# `DryRunOperationException` error response.
|
|
919
|
+
#
|
|
900
920
|
# @return [Types::CreateDistributionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
901
921
|
#
|
|
902
922
|
# * {Types::CreateDistributionConfigurationResponse#request_id #request_id} => String
|
|
@@ -976,6 +996,7 @@ module Aws::Imagebuilder
|
|
|
976
996
|
# "TagKey" => "TagValue",
|
|
977
997
|
# },
|
|
978
998
|
# client_token: "ClientToken", # required
|
|
999
|
+
# dry_run: false,
|
|
979
1000
|
# })
|
|
980
1001
|
#
|
|
981
1002
|
# @example Response structure
|
|
@@ -993,10 +1014,10 @@ module Aws::Imagebuilder
|
|
|
993
1014
|
req.send_request(options)
|
|
994
1015
|
end
|
|
995
1016
|
|
|
996
|
-
# Creates a new image
|
|
997
|
-
#
|
|
998
|
-
#
|
|
999
|
-
#
|
|
1017
|
+
# Creates a new image along with all configured output resources defined
|
|
1018
|
+
# in the distribution configuration. You must specify exactly one recipe
|
|
1019
|
+
# for your image, using either a ContainerRecipeArn or an
|
|
1020
|
+
# ImageRecipeArn.
|
|
1000
1021
|
#
|
|
1001
1022
|
# @option params [String] :image_recipe_arn
|
|
1002
1023
|
# The Amazon Resource Name (ARN) of the image recipe that defines how
|
|
@@ -1019,18 +1040,19 @@ module Aws::Imagebuilder
|
|
|
1019
1040
|
# The image tests configuration of the image.
|
|
1020
1041
|
#
|
|
1021
1042
|
# @option params [Boolean] :enhanced_image_metadata_enabled
|
|
1022
|
-
#
|
|
1023
|
-
# including the operating system (OS) version and package
|
|
1024
|
-
#
|
|
1025
|
-
# Image Builder. Enabled by default.
|
|
1043
|
+
# Specifies whether to collect additional information about the image
|
|
1044
|
+
# being created, including the operating system (OS) version and package
|
|
1045
|
+
# list. Defaults to `true`.
|
|
1026
1046
|
#
|
|
1027
1047
|
# @option params [Hash<String,String>] :tags
|
|
1028
1048
|
# The tags of the image.
|
|
1029
1049
|
#
|
|
1030
1050
|
# @option params [required, String] :client_token
|
|
1031
|
-
#
|
|
1032
|
-
#
|
|
1033
|
-
# the
|
|
1051
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
1052
|
+
# operation completes no more than one time. If this token matches a
|
|
1053
|
+
# previous request, the service ignores the request, but does not return
|
|
1054
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
1055
|
+
# *Amazon EC2 API Reference*.
|
|
1034
1056
|
#
|
|
1035
1057
|
# **A suitable default value is auto-generated.** You should normally
|
|
1036
1058
|
# not need to pass this option.**
|
|
@@ -1050,7 +1072,7 @@ module Aws::Imagebuilder
|
|
|
1050
1072
|
# that grants Image Builder access to perform workflow actions.
|
|
1051
1073
|
#
|
|
1052
1074
|
# @option params [Types::ImageLoggingConfiguration] :logging_configuration
|
|
1053
|
-
#
|
|
1075
|
+
# The logging configuration for the image build process.
|
|
1054
1076
|
#
|
|
1055
1077
|
# @return [Types::CreateImageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1056
1078
|
#
|
|
@@ -1120,8 +1142,8 @@ module Aws::Imagebuilder
|
|
|
1120
1142
|
req.send_request(options)
|
|
1121
1143
|
end
|
|
1122
1144
|
|
|
1123
|
-
# Creates a new image pipeline.
|
|
1124
|
-
#
|
|
1145
|
+
# Creates a new image pipeline. Use image pipelines to automate the
|
|
1146
|
+
# creation and distribution of images.
|
|
1125
1147
|
#
|
|
1126
1148
|
# @option params [required, String] :name
|
|
1127
1149
|
# The name of the image pipeline.
|
|
@@ -1130,8 +1152,8 @@ module Aws::Imagebuilder
|
|
|
1130
1152
|
# The description of the image pipeline.
|
|
1131
1153
|
#
|
|
1132
1154
|
# @option params [String] :image_recipe_arn
|
|
1133
|
-
# The Amazon Resource Name (ARN) of the image recipe that
|
|
1134
|
-
#
|
|
1155
|
+
# The Amazon Resource Name (ARN) of the image recipe that configures
|
|
1156
|
+
# images created by this image pipeline.
|
|
1135
1157
|
#
|
|
1136
1158
|
# @option params [String] :container_recipe_arn
|
|
1137
1159
|
# The Amazon Resource Name (ARN) of the container recipe that is used to
|
|
@@ -1139,21 +1161,19 @@ module Aws::Imagebuilder
|
|
|
1139
1161
|
#
|
|
1140
1162
|
# @option params [required, String] :infrastructure_configuration_arn
|
|
1141
1163
|
# The Amazon Resource Name (ARN) of the infrastructure configuration
|
|
1142
|
-
# that
|
|
1164
|
+
# that builds images created by this image pipeline.
|
|
1143
1165
|
#
|
|
1144
1166
|
# @option params [String] :distribution_configuration_arn
|
|
1145
1167
|
# The Amazon Resource Name (ARN) of the distribution configuration that
|
|
1146
|
-
#
|
|
1147
|
-
# pipeline.
|
|
1168
|
+
# configures and distributes images created by this image pipeline.
|
|
1148
1169
|
#
|
|
1149
1170
|
# @option params [Types::ImageTestsConfiguration] :image_tests_configuration
|
|
1150
1171
|
# The image test configuration of the image pipeline.
|
|
1151
1172
|
#
|
|
1152
1173
|
# @option params [Boolean] :enhanced_image_metadata_enabled
|
|
1153
|
-
#
|
|
1154
|
-
# including the operating system (OS) version and package
|
|
1155
|
-
#
|
|
1156
|
-
# Image Builder. Enabled by default.
|
|
1174
|
+
# Specifies whether to collect additional information about the image
|
|
1175
|
+
# being created, including the operating system (OS) version and package
|
|
1176
|
+
# list. Defaults to `true`.
|
|
1157
1177
|
#
|
|
1158
1178
|
# @option params [Types::Schedule] :schedule
|
|
1159
1179
|
# The schedule of the image pipeline.
|
|
@@ -1168,9 +1188,11 @@ module Aws::Imagebuilder
|
|
|
1168
1188
|
# The tags to be applied to the images produced by this pipeline.
|
|
1169
1189
|
#
|
|
1170
1190
|
# @option params [required, String] :client_token
|
|
1171
|
-
#
|
|
1172
|
-
#
|
|
1173
|
-
# the
|
|
1191
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
1192
|
+
# operation completes no more than one time. If this token matches a
|
|
1193
|
+
# previous request, the service ignores the request, but does not return
|
|
1194
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
1195
|
+
# *Amazon EC2 API Reference*.
|
|
1174
1196
|
#
|
|
1175
1197
|
# **A suitable default value is auto-generated.** You should normally
|
|
1176
1198
|
# not need to pass this option.**
|
|
@@ -1197,6 +1219,11 @@ module Aws::Imagebuilder
|
|
|
1197
1219
|
# role. For custom log group names outside of this prefix, you must also
|
|
1198
1220
|
# provide an `executionRole`.
|
|
1199
1221
|
#
|
|
1222
|
+
# @option params [Boolean] :dry_run
|
|
1223
|
+
# Validates the required permissions and request parameters without
|
|
1224
|
+
# making the request. If validation succeeds, the operation returns a
|
|
1225
|
+
# `DryRunOperationException` error response.
|
|
1226
|
+
#
|
|
1200
1227
|
# @return [Types::CreateImagePipelineResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1201
1228
|
#
|
|
1202
1229
|
# * {Types::CreateImagePipelineResponse#request_id #request_id} => String
|
|
@@ -1258,6 +1285,7 @@ module Aws::Imagebuilder
|
|
|
1258
1285
|
# image_log_group_name: "LogGroupName",
|
|
1259
1286
|
# pipeline_log_group_name: "LogGroupName",
|
|
1260
1287
|
# },
|
|
1288
|
+
# dry_run: false,
|
|
1261
1289
|
# })
|
|
1262
1290
|
#
|
|
1263
1291
|
# @example Response structure
|
|
@@ -1292,9 +1320,9 @@ module Aws::Imagebuilder
|
|
|
1292
1320
|
# <major>.<minor>.<patch>/<build>. You can
|
|
1293
1321
|
# assign values for the first three, and can filter on all of them.
|
|
1294
1322
|
#
|
|
1295
|
-
# **Assignment:** For the first three nodes you can assign any positive
|
|
1296
|
-
# integer value, including zero
|
|
1297
|
-
# 1073741823 for each node. Image Builder automatically assigns the
|
|
1323
|
+
# **Assignment:** For the first three nodes, you can assign any positive
|
|
1324
|
+
# integer value, including zero. The upper limit is 2^30-1, or
|
|
1325
|
+
# 1073741823, for each node. Image Builder automatically assigns the
|
|
1298
1326
|
# build number to the fourth node.
|
|
1299
1327
|
#
|
|
1300
1328
|
# **Patterns:** You can use any numeric pattern that adheres to the
|
|
@@ -1334,8 +1362,7 @@ module Aws::Imagebuilder
|
|
|
1334
1362
|
# The working directory used during build and test workflows.
|
|
1335
1363
|
#
|
|
1336
1364
|
# @option params [Types::AdditionalInstanceConfiguration] :additional_instance_configuration
|
|
1337
|
-
#
|
|
1338
|
-
# instances.
|
|
1365
|
+
# The additional settings and launch scripts for your build instances.
|
|
1339
1366
|
#
|
|
1340
1367
|
# @option params [Hash<String,String>] :ami_tags
|
|
1341
1368
|
# Tags that are applied to the AMI that Image Builder creates during the
|
|
@@ -1353,9 +1380,11 @@ module Aws::Imagebuilder
|
|
|
1353
1380
|
# </note>
|
|
1354
1381
|
#
|
|
1355
1382
|
# @option params [required, String] :client_token
|
|
1356
|
-
#
|
|
1357
|
-
#
|
|
1358
|
-
# the
|
|
1383
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
1384
|
+
# operation completes no more than one time. If this token matches a
|
|
1385
|
+
# previous request, the service ignores the request, but does not return
|
|
1386
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
1387
|
+
# *Amazon EC2 API Reference*.
|
|
1359
1388
|
#
|
|
1360
1389
|
# **A suitable default value is auto-generated.** You should normally
|
|
1361
1390
|
# not need to pass this option.**
|
|
@@ -1364,6 +1393,11 @@ module Aws::Imagebuilder
|
|
|
1364
1393
|
#
|
|
1365
1394
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
|
1366
1395
|
#
|
|
1396
|
+
# @option params [Boolean] :dry_run
|
|
1397
|
+
# Validates the required permissions and request parameters without
|
|
1398
|
+
# making the request. If validation succeeds, the operation returns a
|
|
1399
|
+
# `DryRunOperationException` error response.
|
|
1400
|
+
#
|
|
1367
1401
|
# @return [Types::CreateImageRecipeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1368
1402
|
#
|
|
1369
1403
|
# * {Types::CreateImageRecipeResponse#request_id #request_id} => String
|
|
@@ -1421,6 +1455,7 @@ module Aws::Imagebuilder
|
|
|
1421
1455
|
# },
|
|
1422
1456
|
# ami_watermarks: ["AmiWatermarkName"],
|
|
1423
1457
|
# client_token: "ClientToken", # required
|
|
1458
|
+
# dry_run: false,
|
|
1424
1459
|
# })
|
|
1425
1460
|
#
|
|
1426
1461
|
# @example Response structure
|
|
@@ -1454,8 +1489,8 @@ module Aws::Imagebuilder
|
|
|
1454
1489
|
#
|
|
1455
1490
|
# @option params [Array<String>] :instance_types
|
|
1456
1491
|
# The instance types of the infrastructure configuration. You can
|
|
1457
|
-
# specify one or more instance types to use for this build.
|
|
1458
|
-
#
|
|
1492
|
+
# specify one or more instance types to use for this build. Image
|
|
1493
|
+
# Builder picks one of these instance types based on availability.
|
|
1459
1494
|
#
|
|
1460
1495
|
# @option params [required, String] :instance_profile_name
|
|
1461
1496
|
# The instance profile to associate with the instance used to customize
|
|
@@ -1477,14 +1512,14 @@ module Aws::Imagebuilder
|
|
|
1477
1512
|
# log on to and debug the instance used to create your image.
|
|
1478
1513
|
#
|
|
1479
1514
|
# @option params [Boolean] :terminate_instance_on_failure
|
|
1480
|
-
#
|
|
1481
|
-
#
|
|
1482
|
-
#
|
|
1483
|
-
#
|
|
1515
|
+
# Specifies whether to terminate the instance on failure. Set to false
|
|
1516
|
+
# if you want Image Builder to retain the instance used to configure
|
|
1517
|
+
# your AMI if the build or test phase of your workflow fails. Defaults
|
|
1518
|
+
# to `true`.
|
|
1484
1519
|
#
|
|
1485
1520
|
# @option params [String] :sns_topic_arn
|
|
1486
|
-
# The Amazon Resource Name (ARN)
|
|
1487
|
-
# image build event notifications.
|
|
1521
|
+
# The Amazon Resource Name (ARN) of the SNS topic to which Image Builder
|
|
1522
|
+
# sends image build event notifications.
|
|
1488
1523
|
#
|
|
1489
1524
|
# <note markdown="1"> EC2 Image Builder is unable to send notifications to SNS topics that
|
|
1490
1525
|
# are encrypted using keys from other accounts. The key that is used to
|
|
@@ -1509,12 +1544,14 @@ module Aws::Imagebuilder
|
|
|
1509
1544
|
#
|
|
1510
1545
|
# @option params [Types::Placement] :placement
|
|
1511
1546
|
# The instance placement settings that define where the instances that
|
|
1512
|
-
# are launched from your image
|
|
1547
|
+
# are launched from your image run.
|
|
1513
1548
|
#
|
|
1514
1549
|
# @option params [required, String] :client_token
|
|
1515
|
-
#
|
|
1516
|
-
#
|
|
1517
|
-
# the
|
|
1550
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
1551
|
+
# operation completes no more than one time. If this token matches a
|
|
1552
|
+
# previous request, the service ignores the request, but does not return
|
|
1553
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
1554
|
+
# *Amazon EC2 API Reference*.
|
|
1518
1555
|
#
|
|
1519
1556
|
# **A suitable default value is auto-generated.** You should normally
|
|
1520
1557
|
# not need to pass this option.**
|
|
@@ -1523,6 +1560,11 @@ module Aws::Imagebuilder
|
|
|
1523
1560
|
#
|
|
1524
1561
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
|
1525
1562
|
#
|
|
1563
|
+
# @option params [Boolean] :dry_run
|
|
1564
|
+
# Validates the required permissions and request parameters without
|
|
1565
|
+
# making the request. If validation succeeds, the operation returns a
|
|
1566
|
+
# `DryRunOperationException` error response.
|
|
1567
|
+
#
|
|
1526
1568
|
# @return [Types::CreateInfrastructureConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1527
1569
|
#
|
|
1528
1570
|
# * {Types::CreateInfrastructureConfigurationResponse#request_id #request_id} => String
|
|
@@ -1564,6 +1606,7 @@ module Aws::Imagebuilder
|
|
|
1564
1606
|
# host_resource_group_arn: "NonEmptyString",
|
|
1565
1607
|
# },
|
|
1566
1608
|
# client_token: "ClientToken", # required
|
|
1609
|
+
# dry_run: false,
|
|
1567
1610
|
# })
|
|
1568
1611
|
#
|
|
1569
1612
|
# @example Response structure
|
|
@@ -1581,7 +1624,7 @@ module Aws::Imagebuilder
|
|
|
1581
1624
|
req.send_request(options)
|
|
1582
1625
|
end
|
|
1583
1626
|
|
|
1584
|
-
#
|
|
1627
|
+
# Creates a lifecycle policy resource.
|
|
1585
1628
|
#
|
|
1586
1629
|
# @option params [required, String] :name
|
|
1587
1630
|
# The name of the lifecycle policy to create.
|
|
@@ -1611,9 +1654,11 @@ module Aws::Imagebuilder
|
|
|
1611
1654
|
# Tags to apply to the lifecycle policy resource.
|
|
1612
1655
|
#
|
|
1613
1656
|
# @option params [required, String] :client_token
|
|
1614
|
-
#
|
|
1615
|
-
#
|
|
1616
|
-
# the
|
|
1657
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
1658
|
+
# operation completes no more than one time. If this token matches a
|
|
1659
|
+
# previous request, the service ignores the request, but does not return
|
|
1660
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
1661
|
+
# *Amazon EC2 API Reference*.
|
|
1617
1662
|
#
|
|
1618
1663
|
# **A suitable default value is auto-generated.** You should normally
|
|
1619
1664
|
# not need to pass this option.**
|
|
@@ -1622,6 +1667,11 @@ module Aws::Imagebuilder
|
|
|
1622
1667
|
#
|
|
1623
1668
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
|
1624
1669
|
#
|
|
1670
|
+
# @option params [Boolean] :dry_run
|
|
1671
|
+
# Validates the required permissions and request parameters without
|
|
1672
|
+
# making the request. If validation succeeds, the operation returns a
|
|
1673
|
+
# `DryRunOperationException` error response.
|
|
1674
|
+
#
|
|
1625
1675
|
# @return [Types::CreateLifecyclePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1626
1676
|
#
|
|
1627
1677
|
# * {Types::CreateLifecyclePolicyResponse#client_token #client_token} => String
|
|
@@ -1685,6 +1735,7 @@ module Aws::Imagebuilder
|
|
|
1685
1735
|
# "TagKey" => "TagValue",
|
|
1686
1736
|
# },
|
|
1687
1737
|
# client_token: "ClientToken", # required
|
|
1738
|
+
# dry_run: false,
|
|
1688
1739
|
# })
|
|
1689
1740
|
#
|
|
1690
1741
|
# @example Response structure
|
|
@@ -1701,7 +1752,7 @@ module Aws::Imagebuilder
|
|
|
1701
1752
|
req.send_request(options)
|
|
1702
1753
|
end
|
|
1703
1754
|
|
|
1704
|
-
#
|
|
1755
|
+
# Creates a new workflow or a new version of an existing workflow.
|
|
1705
1756
|
#
|
|
1706
1757
|
# @option params [required, String] :name
|
|
1707
1758
|
# The name of the workflow to create.
|
|
@@ -1714,9 +1765,9 @@ module Aws::Imagebuilder
|
|
|
1714
1765
|
# <major>.<minor>.<patch>/<build>. You can
|
|
1715
1766
|
# assign values for the first three, and can filter on all of them.
|
|
1716
1767
|
#
|
|
1717
|
-
# **Assignment:** For the first three nodes you can assign any positive
|
|
1718
|
-
# integer value, including zero
|
|
1719
|
-
# 1073741823 for each node. Image Builder automatically assigns the
|
|
1768
|
+
# **Assignment:** For the first three nodes, you can assign any positive
|
|
1769
|
+
# integer value, including zero. The upper limit is 2^30-1, or
|
|
1770
|
+
# 1073741823, for each node. Image Builder automatically assigns the
|
|
1720
1771
|
# build number to the fourth node.
|
|
1721
1772
|
#
|
|
1722
1773
|
# **Patterns:** You can use any numeric pattern that adheres to the
|
|
@@ -1741,9 +1792,9 @@ module Aws::Imagebuilder
|
|
|
1741
1792
|
#
|
|
1742
1793
|
# @option params [String] :uri
|
|
1743
1794
|
# The `uri` of a YAML component document file. This must be an S3 URL
|
|
1744
|
-
# (`s3://bucket/key`), and
|
|
1745
|
-
#
|
|
1746
|
-
#
|
|
1795
|
+
# (`s3://bucket/key`), and you must have permission to access the S3
|
|
1796
|
+
# bucket it points to. If you use Amazon S3, you can specify component
|
|
1797
|
+
# content up to your service quota.
|
|
1747
1798
|
#
|
|
1748
1799
|
# Alternatively, you can specify the YAML document inline, using the
|
|
1749
1800
|
# component `data` property. You cannot specify both properties.
|
|
@@ -1762,9 +1813,11 @@ module Aws::Imagebuilder
|
|
|
1762
1813
|
# Tags that apply to the workflow resource.
|
|
1763
1814
|
#
|
|
1764
1815
|
# @option params [required, String] :client_token
|
|
1765
|
-
#
|
|
1766
|
-
#
|
|
1767
|
-
# the
|
|
1816
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
1817
|
+
# operation completes no more than one time. If this token matches a
|
|
1818
|
+
# previous request, the service ignores the request, but does not return
|
|
1819
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
1820
|
+
# *Amazon EC2 API Reference*.
|
|
1768
1821
|
#
|
|
1769
1822
|
# **A suitable default value is auto-generated.** You should normally
|
|
1770
1823
|
# not need to pass this option.**
|
|
@@ -1778,10 +1831,9 @@ module Aws::Imagebuilder
|
|
|
1778
1831
|
# is responsible.
|
|
1779
1832
|
#
|
|
1780
1833
|
# @option params [Boolean] :dry_run
|
|
1781
|
-
# Validates the required permissions
|
|
1782
|
-
#
|
|
1783
|
-
#
|
|
1784
|
-
# `DryRunOperationException`.
|
|
1834
|
+
# Validates the required permissions and request parameters without
|
|
1835
|
+
# making the request. If validation succeeds, the operation returns a
|
|
1836
|
+
# `DryRunOperationException` error response.
|
|
1785
1837
|
#
|
|
1786
1838
|
# @return [Types::CreateWorkflowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1787
1839
|
#
|
|
@@ -2057,7 +2109,7 @@ module Aws::Imagebuilder
|
|
|
2057
2109
|
req.send_request(options)
|
|
2058
2110
|
end
|
|
2059
2111
|
|
|
2060
|
-
#
|
|
2112
|
+
# Deletes the specified lifecycle policy resource.
|
|
2061
2113
|
#
|
|
2062
2114
|
# @option params [required, String] :lifecycle_policy_arn
|
|
2063
2115
|
# The Amazon Resource Name (ARN) of the lifecycle policy resource to
|
|
@@ -2138,9 +2190,11 @@ module Aws::Imagebuilder
|
|
|
2138
2190
|
# The tags to apply to the distributed image.
|
|
2139
2191
|
#
|
|
2140
2192
|
# @option params [required, String] :client_token
|
|
2141
|
-
#
|
|
2142
|
-
#
|
|
2143
|
-
# the
|
|
2193
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
2194
|
+
# operation completes no more than one time. If this token matches a
|
|
2195
|
+
# previous request, the service ignores the request, but does not return
|
|
2196
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
2197
|
+
# *Amazon EC2 API Reference*.
|
|
2144
2198
|
#
|
|
2145
2199
|
# **A suitable default value is auto-generated.** You should normally
|
|
2146
2200
|
# not need to pass this option.**
|
|
@@ -2186,7 +2240,7 @@ module Aws::Imagebuilder
|
|
|
2186
2240
|
req.send_request(options)
|
|
2187
2241
|
end
|
|
2188
2242
|
|
|
2189
|
-
#
|
|
2243
|
+
# Retrieves a component object.
|
|
2190
2244
|
#
|
|
2191
2245
|
# @option params [required, String] :component_build_version_arn
|
|
2192
2246
|
# The Amazon Resource Name (ARN) of the component that you want to get.
|
|
@@ -2250,7 +2304,7 @@ module Aws::Imagebuilder
|
|
|
2250
2304
|
req.send_request(options)
|
|
2251
2305
|
end
|
|
2252
2306
|
|
|
2253
|
-
#
|
|
2307
|
+
# Retrieves a component policy.
|
|
2254
2308
|
#
|
|
2255
2309
|
# @option params [required, String] :component_arn
|
|
2256
2310
|
# The Amazon Resource Name (ARN) of the component whose policy you want
|
|
@@ -2382,7 +2436,7 @@ module Aws::Imagebuilder
|
|
|
2382
2436
|
req.send_request(options)
|
|
2383
2437
|
end
|
|
2384
2438
|
|
|
2385
|
-
#
|
|
2439
|
+
# Retrieves a distribution configuration.
|
|
2386
2440
|
#
|
|
2387
2441
|
# @option params [required, String] :distribution_configuration_arn
|
|
2388
2442
|
# The Amazon Resource Name (ARN) of the distribution configuration that
|
|
@@ -2464,7 +2518,7 @@ module Aws::Imagebuilder
|
|
|
2464
2518
|
req.send_request(options)
|
|
2465
2519
|
end
|
|
2466
2520
|
|
|
2467
|
-
#
|
|
2521
|
+
# Retrieves an image.
|
|
2468
2522
|
#
|
|
2469
2523
|
# @option params [required, String] :image_build_version_arn
|
|
2470
2524
|
# The Amazon Resource Name (ARN) of the image that you want to get.
|
|
@@ -2493,6 +2547,23 @@ module Aws::Imagebuilder
|
|
|
2493
2547
|
# resp.image.os_version #=> String
|
|
2494
2548
|
# resp.image.state.status #=> String, one of "PENDING", "CREATING", "BUILDING", "TESTING", "DISTRIBUTING", "INTEGRATING", "AVAILABLE", "CANCELLED", "FAILED", "DEPRECATED", "DELETED", "DISABLED"
|
|
2495
2549
|
# resp.image.state.reason #=> String
|
|
2550
|
+
# resp.image.state.failure_context.image_status #=> String, one of "PENDING", "CREATING", "BUILDING", "TESTING", "DISTRIBUTING", "INTEGRATING", "AVAILABLE", "CANCELLED", "FAILED", "DEPRECATED", "DELETED", "DISABLED"
|
|
2551
|
+
# resp.image.state.failure_context.workflow_execution_id #=> String
|
|
2552
|
+
# resp.image.state.failure_context.workflow_arn #=> String
|
|
2553
|
+
# resp.image.state.failure_context.step_execution_id #=> String
|
|
2554
|
+
# resp.image.state.failure_context.failed_step #=> String
|
|
2555
|
+
# resp.image.state.failure_context.component_failure.component_arn #=> String
|
|
2556
|
+
# resp.image.state.failure_context.component_failure.phase_name #=> String
|
|
2557
|
+
# resp.image.state.failure_context.component_failure.step_name #=> String
|
|
2558
|
+
# resp.image.state.failure_context.component_failure.action #=> String
|
|
2559
|
+
# resp.image.state.failure_context.component_failure.error_message #=> String
|
|
2560
|
+
# resp.image.state.failure_context.distribution_failure.error_message #=> String
|
|
2561
|
+
# resp.image.state.failure_context.distribution_failure.region_failures #=> Array
|
|
2562
|
+
# resp.image.state.failure_context.distribution_failure.region_failures[0].region #=> String
|
|
2563
|
+
# resp.image.state.failure_context.distribution_failure.region_failures[0].status #=> String, one of "FAILED", "CANCELLED", "TIMED_OUT"
|
|
2564
|
+
# resp.image.state.failure_context.distribution_failure.region_failures[0].image_configuration_step #=> String, one of "ASSOCIATE_LICENSES", "UPDATE_LAUNCH_TEMPLATES", "PUT_SSM_PARAMETERS", "UPDATE_FAST_LAUNCH_CONFIGURATIONS", "EXPORT_AMI"
|
|
2565
|
+
# resp.image.state.failure_context.distribution_failure.region_failures[0].error_message #=> String
|
|
2566
|
+
# resp.image.state.failure_context.distribution_failure.region_failures[0].target_account_id #=> String
|
|
2496
2567
|
# resp.image.image_recipe.arn #=> String
|
|
2497
2568
|
# resp.image.image_recipe.type #=> String, one of "AMI", "DOCKER"
|
|
2498
2569
|
# resp.image.image_recipe.name #=> String
|
|
@@ -2655,6 +2726,23 @@ module Aws::Imagebuilder
|
|
|
2655
2726
|
# resp.image.output_resources.amis[0].description #=> String
|
|
2656
2727
|
# resp.image.output_resources.amis[0].state.status #=> String, one of "PENDING", "CREATING", "BUILDING", "TESTING", "DISTRIBUTING", "INTEGRATING", "AVAILABLE", "CANCELLED", "FAILED", "DEPRECATED", "DELETED", "DISABLED"
|
|
2657
2728
|
# resp.image.output_resources.amis[0].state.reason #=> String
|
|
2729
|
+
# resp.image.output_resources.amis[0].state.failure_context.image_status #=> String, one of "PENDING", "CREATING", "BUILDING", "TESTING", "DISTRIBUTING", "INTEGRATING", "AVAILABLE", "CANCELLED", "FAILED", "DEPRECATED", "DELETED", "DISABLED"
|
|
2730
|
+
# resp.image.output_resources.amis[0].state.failure_context.workflow_execution_id #=> String
|
|
2731
|
+
# resp.image.output_resources.amis[0].state.failure_context.workflow_arn #=> String
|
|
2732
|
+
# resp.image.output_resources.amis[0].state.failure_context.step_execution_id #=> String
|
|
2733
|
+
# resp.image.output_resources.amis[0].state.failure_context.failed_step #=> String
|
|
2734
|
+
# resp.image.output_resources.amis[0].state.failure_context.component_failure.component_arn #=> String
|
|
2735
|
+
# resp.image.output_resources.amis[0].state.failure_context.component_failure.phase_name #=> String
|
|
2736
|
+
# resp.image.output_resources.amis[0].state.failure_context.component_failure.step_name #=> String
|
|
2737
|
+
# resp.image.output_resources.amis[0].state.failure_context.component_failure.action #=> String
|
|
2738
|
+
# resp.image.output_resources.amis[0].state.failure_context.component_failure.error_message #=> String
|
|
2739
|
+
# resp.image.output_resources.amis[0].state.failure_context.distribution_failure.error_message #=> String
|
|
2740
|
+
# resp.image.output_resources.amis[0].state.failure_context.distribution_failure.region_failures #=> Array
|
|
2741
|
+
# resp.image.output_resources.amis[0].state.failure_context.distribution_failure.region_failures[0].region #=> String
|
|
2742
|
+
# resp.image.output_resources.amis[0].state.failure_context.distribution_failure.region_failures[0].status #=> String, one of "FAILED", "CANCELLED", "TIMED_OUT"
|
|
2743
|
+
# resp.image.output_resources.amis[0].state.failure_context.distribution_failure.region_failures[0].image_configuration_step #=> String, one of "ASSOCIATE_LICENSES", "UPDATE_LAUNCH_TEMPLATES", "PUT_SSM_PARAMETERS", "UPDATE_FAST_LAUNCH_CONFIGURATIONS", "EXPORT_AMI"
|
|
2744
|
+
# resp.image.output_resources.amis[0].state.failure_context.distribution_failure.region_failures[0].error_message #=> String
|
|
2745
|
+
# resp.image.output_resources.amis[0].state.failure_context.distribution_failure.region_failures[0].target_account_id #=> String
|
|
2658
2746
|
# resp.image.output_resources.amis[0].account_id #=> String
|
|
2659
2747
|
# resp.image.output_resources.containers #=> Array
|
|
2660
2748
|
# resp.image.output_resources.containers[0].region #=> String
|
|
@@ -2696,7 +2784,7 @@ module Aws::Imagebuilder
|
|
|
2696
2784
|
req.send_request(options)
|
|
2697
2785
|
end
|
|
2698
2786
|
|
|
2699
|
-
#
|
|
2787
|
+
# Retrieves an image pipeline.
|
|
2700
2788
|
#
|
|
2701
2789
|
# @option params [required, String] :image_pipeline_arn
|
|
2702
2790
|
# The Amazon Resource Name (ARN) of the image pipeline that you want to
|
|
@@ -2767,7 +2855,7 @@ module Aws::Imagebuilder
|
|
|
2767
2855
|
req.send_request(options)
|
|
2768
2856
|
end
|
|
2769
2857
|
|
|
2770
|
-
#
|
|
2858
|
+
# Retrieves an image policy.
|
|
2771
2859
|
#
|
|
2772
2860
|
# @option params [required, String] :image_arn
|
|
2773
2861
|
# The Amazon Resource Name (ARN) of the image whose policy you want to
|
|
@@ -2798,7 +2886,7 @@ module Aws::Imagebuilder
|
|
|
2798
2886
|
req.send_request(options)
|
|
2799
2887
|
end
|
|
2800
2888
|
|
|
2801
|
-
#
|
|
2889
|
+
# Retrieves an image recipe.
|
|
2802
2890
|
#
|
|
2803
2891
|
# @option params [required, String] :image_recipe_arn
|
|
2804
2892
|
# The Amazon Resource Name (ARN) of the image recipe that you want to
|
|
@@ -2869,7 +2957,7 @@ module Aws::Imagebuilder
|
|
|
2869
2957
|
req.send_request(options)
|
|
2870
2958
|
end
|
|
2871
2959
|
|
|
2872
|
-
#
|
|
2960
|
+
# Retrieves an image recipe policy.
|
|
2873
2961
|
#
|
|
2874
2962
|
# @option params [required, String] :image_recipe_arn
|
|
2875
2963
|
# The Amazon Resource Name (ARN) of the image recipe whose policy you
|
|
@@ -2900,7 +2988,7 @@ module Aws::Imagebuilder
|
|
|
2900
2988
|
req.send_request(options)
|
|
2901
2989
|
end
|
|
2902
2990
|
|
|
2903
|
-
#
|
|
2991
|
+
# Retrieves an infrastructure configuration.
|
|
2904
2992
|
#
|
|
2905
2993
|
# @option params [required, String] :infrastructure_configuration_arn
|
|
2906
2994
|
# The Amazon Resource Name (ARN) of the infrastructure configuration
|
|
@@ -2956,12 +3044,11 @@ module Aws::Imagebuilder
|
|
|
2956
3044
|
req.send_request(options)
|
|
2957
3045
|
end
|
|
2958
3046
|
|
|
2959
|
-
#
|
|
2960
|
-
#
|
|
3047
|
+
# Retrieves the runtime information for a specific runtime instance of
|
|
3048
|
+
# the lifecycle policy.
|
|
2961
3049
|
#
|
|
2962
3050
|
# @option params [required, String] :lifecycle_execution_id
|
|
2963
|
-
#
|
|
2964
|
-
# policy to get runtime details.
|
|
3051
|
+
# The unique identifier for a runtime instance of the lifecycle policy.
|
|
2965
3052
|
#
|
|
2966
3053
|
# @return [Types::GetLifecycleExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2967
3054
|
#
|
|
@@ -2992,7 +3079,7 @@ module Aws::Imagebuilder
|
|
|
2992
3079
|
req.send_request(options)
|
|
2993
3080
|
end
|
|
2994
3081
|
|
|
2995
|
-
#
|
|
3082
|
+
# Retrieves details for the specified image lifecycle policy.
|
|
2996
3083
|
#
|
|
2997
3084
|
# @option params [required, String] :lifecycle_policy_arn
|
|
2998
3085
|
# Specifies the Amazon Resource Name (ARN) of the image lifecycle policy
|
|
@@ -3056,8 +3143,8 @@ module Aws::Imagebuilder
|
|
|
3056
3143
|
req.send_request(options)
|
|
3057
3144
|
end
|
|
3058
3145
|
|
|
3059
|
-
#
|
|
3060
|
-
# requested Amazon Web Services Marketplace resource. For Amazon Web
|
|
3146
|
+
# Verifies the subscription and performs resource dependency checks on
|
|
3147
|
+
# the requested Amazon Web Services Marketplace resource. For Amazon Web
|
|
3061
3148
|
# Services Marketplace components, the response contains fields to
|
|
3062
3149
|
# download the components and their artifacts.
|
|
3063
3150
|
#
|
|
@@ -3102,7 +3189,7 @@ module Aws::Imagebuilder
|
|
|
3102
3189
|
req.send_request(options)
|
|
3103
3190
|
end
|
|
3104
3191
|
|
|
3105
|
-
#
|
|
3192
|
+
# Retrieves a workflow resource object.
|
|
3106
3193
|
#
|
|
3107
3194
|
# @option params [required, String] :workflow_build_version_arn
|
|
3108
3195
|
# The Amazon Resource Name (ARN) of the workflow resource that you want
|
|
@@ -3155,8 +3242,8 @@ module Aws::Imagebuilder
|
|
|
3155
3242
|
req.send_request(options)
|
|
3156
3243
|
end
|
|
3157
3244
|
|
|
3158
|
-
#
|
|
3159
|
-
#
|
|
3245
|
+
# Retrieves runtime information for a specific runtime instance of the
|
|
3246
|
+
# workflow.
|
|
3160
3247
|
#
|
|
3161
3248
|
# @option params [required, String] :workflow_execution_id
|
|
3162
3249
|
# Use the unique identifier for a runtime instance of the workflow to
|
|
@@ -3211,8 +3298,8 @@ module Aws::Imagebuilder
|
|
|
3211
3298
|
req.send_request(options)
|
|
3212
3299
|
end
|
|
3213
3300
|
|
|
3214
|
-
#
|
|
3215
|
-
#
|
|
3301
|
+
# Retrieves runtime information for a specific runtime instance of the
|
|
3302
|
+
# workflow step.
|
|
3216
3303
|
#
|
|
3217
3304
|
# @option params [required, String] :step_execution_id
|
|
3218
3305
|
# Use the unique identifier for a specific runtime instance of the
|
|
@@ -3237,6 +3324,8 @@ module Aws::Imagebuilder
|
|
|
3237
3324
|
# * {Types::GetWorkflowStepExecutionResponse#end_time #end_time} => String
|
|
3238
3325
|
# * {Types::GetWorkflowStepExecutionResponse#on_failure #on_failure} => String
|
|
3239
3326
|
# * {Types::GetWorkflowStepExecutionResponse#timeout_seconds #timeout_seconds} => Integer
|
|
3327
|
+
# * {Types::GetWorkflowStepExecutionResponse#attempt_number #attempt_number} => Integer
|
|
3328
|
+
# * {Types::GetWorkflowStepExecutionResponse#max_attempts #max_attempts} => Integer
|
|
3240
3329
|
#
|
|
3241
3330
|
# @example Request syntax with placeholder values
|
|
3242
3331
|
#
|
|
@@ -3263,6 +3352,8 @@ module Aws::Imagebuilder
|
|
|
3263
3352
|
# resp.end_time #=> String
|
|
3264
3353
|
# resp.on_failure #=> String
|
|
3265
3354
|
# resp.timeout_seconds #=> Integer
|
|
3355
|
+
# resp.attempt_number #=> Integer
|
|
3356
|
+
# resp.max_attempts #=> Integer
|
|
3266
3357
|
#
|
|
3267
3358
|
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetWorkflowStepExecution AWS API Documentation
|
|
3268
3359
|
#
|
|
@@ -3286,11 +3377,10 @@ module Aws::Imagebuilder
|
|
|
3286
3377
|
# <major>.<minor>.<patch>/<build>. You can
|
|
3287
3378
|
# assign values for the first three, and can filter on all of them.
|
|
3288
3379
|
#
|
|
3289
|
-
# **Filtering:**
|
|
3290
|
-
#
|
|
3291
|
-
#
|
|
3292
|
-
#
|
|
3293
|
-
# must also be wildcards.
|
|
3380
|
+
# **Filtering:** You can use wildcards (x) to specify the most recent
|
|
3381
|
+
# versions or nodes when selecting the base image or components for your
|
|
3382
|
+
# recipe. When you use a wildcard in any node, all nodes to the right of
|
|
3383
|
+
# the first wildcard must also be wildcards.
|
|
3294
3384
|
#
|
|
3295
3385
|
# </note>
|
|
3296
3386
|
#
|
|
@@ -3318,10 +3408,10 @@ module Aws::Imagebuilder
|
|
|
3318
3408
|
# `data` or `uri` can be used to specify the data within the component.
|
|
3319
3409
|
#
|
|
3320
3410
|
# @option params [String] :uri
|
|
3321
|
-
# The uri of the component. Must be an Amazon S3 URL and
|
|
3322
|
-
#
|
|
3323
|
-
#
|
|
3324
|
-
#
|
|
3411
|
+
# The uri of the component. Must be an Amazon S3 URL and you must have
|
|
3412
|
+
# permission to access the Amazon S3 bucket. If you use Amazon S3, you
|
|
3413
|
+
# can specify component content up to your service quota. Either `data`
|
|
3414
|
+
# or `uri` can be used to specify the data within the component.
|
|
3325
3415
|
#
|
|
3326
3416
|
# @option params [String] :kms_key_id
|
|
3327
3417
|
# The Amazon Resource Name (ARN) that uniquely identifies the KMS key
|
|
@@ -3337,9 +3427,11 @@ module Aws::Imagebuilder
|
|
|
3337
3427
|
# The tags of the component.
|
|
3338
3428
|
#
|
|
3339
3429
|
# @option params [required, String] :client_token
|
|
3340
|
-
#
|
|
3341
|
-
#
|
|
3342
|
-
# the
|
|
3430
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
3431
|
+
# operation completes no more than one time. If this token matches a
|
|
3432
|
+
# previous request, the service ignores the request, but does not return
|
|
3433
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
3434
|
+
# *Amazon EC2 API Reference*.
|
|
3343
3435
|
#
|
|
3344
3436
|
# **A suitable default value is auto-generated.** You should normally
|
|
3345
3437
|
# not need to pass this option.**
|
|
@@ -3388,7 +3480,7 @@ module Aws::Imagebuilder
|
|
|
3388
3480
|
req.send_request(options)
|
|
3389
3481
|
end
|
|
3390
3482
|
|
|
3391
|
-
#
|
|
3483
|
+
# Imports a Windows operating system image from a verified Microsoft ISO
|
|
3392
3484
|
# disk file. The following disk images are supported:
|
|
3393
3485
|
#
|
|
3394
3486
|
# * Windows 11 Enterprise
|
|
@@ -3427,7 +3519,7 @@ module Aws::Imagebuilder
|
|
|
3427
3519
|
# The `uri` of the ISO disk file that's stored in Amazon S3.
|
|
3428
3520
|
#
|
|
3429
3521
|
# @option params [Types::ImageLoggingConfiguration] :logging_configuration
|
|
3430
|
-
#
|
|
3522
|
+
# The logging configuration for the image build process.
|
|
3431
3523
|
#
|
|
3432
3524
|
# @option params [Hash<String,String>] :tags
|
|
3433
3525
|
# Tags that are attached to image resources created from the import.
|
|
@@ -3439,9 +3531,11 @@ module Aws::Imagebuilder
|
|
|
3439
3531
|
# Specifies Windows settings for ISO imports.
|
|
3440
3532
|
#
|
|
3441
3533
|
# @option params [required, String] :client_token
|
|
3442
|
-
#
|
|
3443
|
-
#
|
|
3444
|
-
# the
|
|
3534
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
3535
|
+
# operation completes no more than one time. If this token matches a
|
|
3536
|
+
# previous request, the service ignores the request, but does not return
|
|
3537
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
3538
|
+
# *Amazon EC2 API Reference*.
|
|
3445
3539
|
#
|
|
3446
3540
|
# **A suitable default value is auto-generated.** You should normally
|
|
3447
3541
|
# not need to pass this option.**
|
|
@@ -3524,9 +3618,9 @@ module Aws::Imagebuilder
|
|
|
3524
3618
|
# <major>.<minor>.<patch>/<build>. You can
|
|
3525
3619
|
# assign values for the first three, and can filter on all of them.
|
|
3526
3620
|
#
|
|
3527
|
-
# **Assignment:** For the first three nodes you can assign any positive
|
|
3528
|
-
# integer value, including zero
|
|
3529
|
-
# 1073741823 for each node. Image Builder automatically assigns the
|
|
3621
|
+
# **Assignment:** For the first three nodes, you can assign any positive
|
|
3622
|
+
# integer value, including zero. The upper limit is 2^30-1, or
|
|
3623
|
+
# 1073741823, for each node. Image Builder automatically assigns the
|
|
3530
3624
|
# build number to the fourth node.
|
|
3531
3625
|
#
|
|
3532
3626
|
# **Patterns:** You can use any numeric pattern that adheres to the
|
|
@@ -3553,15 +3647,17 @@ module Aws::Imagebuilder
|
|
|
3553
3647
|
# base image for your recipe.
|
|
3554
3648
|
#
|
|
3555
3649
|
# @option params [Types::ImageLoggingConfiguration] :logging_configuration
|
|
3556
|
-
#
|
|
3650
|
+
# The logging configuration for the image build process.
|
|
3557
3651
|
#
|
|
3558
3652
|
# @option params [Hash<String,String>] :tags
|
|
3559
3653
|
# Tags that are attached to the import resources.
|
|
3560
3654
|
#
|
|
3561
3655
|
# @option params [required, String] :client_token
|
|
3562
|
-
#
|
|
3563
|
-
#
|
|
3564
|
-
# the
|
|
3656
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
3657
|
+
# operation completes no more than one time. If this token matches a
|
|
3658
|
+
# previous request, the service ignores the request, but does not return
|
|
3659
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
3660
|
+
# *Amazon EC2 API Reference*.
|
|
3565
3661
|
#
|
|
3566
3662
|
# **A suitable default value is auto-generated.** You should normally
|
|
3567
3663
|
# not need to pass this option.**
|
|
@@ -3617,11 +3713,11 @@ module Aws::Imagebuilder
|
|
|
3617
3713
|
# want to list.
|
|
3618
3714
|
#
|
|
3619
3715
|
# @option params [Integer] :max_results
|
|
3620
|
-
#
|
|
3716
|
+
# The maximum number of items to return in a single request.
|
|
3621
3717
|
#
|
|
3622
3718
|
# @option params [String] :next_token
|
|
3623
|
-
# A token to specify where to start paginating.
|
|
3624
|
-
# from a previously truncated response.
|
|
3719
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
3720
|
+
# value from a previously truncated response.
|
|
3625
3721
|
#
|
|
3626
3722
|
# @return [Types::ListComponentBuildVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3627
3723
|
#
|
|
@@ -3680,11 +3776,10 @@ module Aws::Imagebuilder
|
|
|
3680
3776
|
# <major>.<minor>.<patch>/<build>. You can
|
|
3681
3777
|
# assign values for the first three, and can filter on all of them.
|
|
3682
3778
|
#
|
|
3683
|
-
# **Filtering:**
|
|
3684
|
-
#
|
|
3685
|
-
#
|
|
3686
|
-
#
|
|
3687
|
-
# must also be wildcards.
|
|
3779
|
+
# **Filtering:** You can use wildcards (x) to specify the most recent
|
|
3780
|
+
# versions or nodes when selecting the base image or components for your
|
|
3781
|
+
# recipe. When you use a wildcard in any node, all nodes to the right of
|
|
3782
|
+
# the first wildcard must also be wildcards.
|
|
3688
3783
|
#
|
|
3689
3784
|
# </note>
|
|
3690
3785
|
#
|
|
@@ -3714,11 +3809,11 @@ module Aws::Imagebuilder
|
|
|
3714
3809
|
# Returns the list of components for the specified name.
|
|
3715
3810
|
#
|
|
3716
3811
|
# @option params [Integer] :max_results
|
|
3717
|
-
#
|
|
3812
|
+
# The maximum number of items to return in a single request.
|
|
3718
3813
|
#
|
|
3719
3814
|
# @option params [String] :next_token
|
|
3720
|
-
# A token to specify where to start paginating.
|
|
3721
|
-
# from a previously truncated response.
|
|
3815
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
3816
|
+
# value from a previously truncated response.
|
|
3722
3817
|
#
|
|
3723
3818
|
# @return [Types::ListComponentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3724
3819
|
#
|
|
@@ -3791,11 +3886,11 @@ module Aws::Imagebuilder
|
|
|
3791
3886
|
# * `platform`
|
|
3792
3887
|
#
|
|
3793
3888
|
# @option params [Integer] :max_results
|
|
3794
|
-
#
|
|
3889
|
+
# The maximum number of items to return in a single request.
|
|
3795
3890
|
#
|
|
3796
3891
|
# @option params [String] :next_token
|
|
3797
|
-
# A token to specify where to start paginating.
|
|
3798
|
-
# from a previously truncated response.
|
|
3892
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
3893
|
+
# value from a previously truncated response.
|
|
3799
3894
|
#
|
|
3800
3895
|
# @return [Types::ListContainerRecipesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3801
3896
|
#
|
|
@@ -3850,11 +3945,11 @@ module Aws::Imagebuilder
|
|
|
3850
3945
|
# You can filter on `name` to streamline results.
|
|
3851
3946
|
#
|
|
3852
3947
|
# @option params [Integer] :max_results
|
|
3853
|
-
#
|
|
3948
|
+
# The maximum number of items to return in a single request.
|
|
3854
3949
|
#
|
|
3855
3950
|
# @option params [String] :next_token
|
|
3856
|
-
# A token to specify where to start paginating.
|
|
3857
|
-
# from a previously truncated response.
|
|
3951
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
3952
|
+
# value from a previously truncated response.
|
|
3858
3953
|
#
|
|
3859
3954
|
# @return [Types::ListDistributionConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3860
3955
|
#
|
|
@@ -3921,11 +4016,11 @@ module Aws::Imagebuilder
|
|
|
3921
4016
|
# * `version`
|
|
3922
4017
|
#
|
|
3923
4018
|
# @option params [Integer] :max_results
|
|
3924
|
-
#
|
|
4019
|
+
# The maximum number of items to return in a single request.
|
|
3925
4020
|
#
|
|
3926
4021
|
# @option params [String] :next_token
|
|
3927
|
-
# A token to specify where to start paginating.
|
|
3928
|
-
# from a previously truncated response.
|
|
4022
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
4023
|
+
# value from a previously truncated response.
|
|
3929
4024
|
#
|
|
3930
4025
|
# @return [Types::ListImageBuildVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3931
4026
|
#
|
|
@@ -3961,6 +4056,23 @@ module Aws::Imagebuilder
|
|
|
3961
4056
|
# resp.image_summary_list[0].os_version #=> String
|
|
3962
4057
|
# resp.image_summary_list[0].state.status #=> String, one of "PENDING", "CREATING", "BUILDING", "TESTING", "DISTRIBUTING", "INTEGRATING", "AVAILABLE", "CANCELLED", "FAILED", "DEPRECATED", "DELETED", "DISABLED"
|
|
3963
4058
|
# resp.image_summary_list[0].state.reason #=> String
|
|
4059
|
+
# resp.image_summary_list[0].state.failure_context.image_status #=> String, one of "PENDING", "CREATING", "BUILDING", "TESTING", "DISTRIBUTING", "INTEGRATING", "AVAILABLE", "CANCELLED", "FAILED", "DEPRECATED", "DELETED", "DISABLED"
|
|
4060
|
+
# resp.image_summary_list[0].state.failure_context.workflow_execution_id #=> String
|
|
4061
|
+
# resp.image_summary_list[0].state.failure_context.workflow_arn #=> String
|
|
4062
|
+
# resp.image_summary_list[0].state.failure_context.step_execution_id #=> String
|
|
4063
|
+
# resp.image_summary_list[0].state.failure_context.failed_step #=> String
|
|
4064
|
+
# resp.image_summary_list[0].state.failure_context.component_failure.component_arn #=> String
|
|
4065
|
+
# resp.image_summary_list[0].state.failure_context.component_failure.phase_name #=> String
|
|
4066
|
+
# resp.image_summary_list[0].state.failure_context.component_failure.step_name #=> String
|
|
4067
|
+
# resp.image_summary_list[0].state.failure_context.component_failure.action #=> String
|
|
4068
|
+
# resp.image_summary_list[0].state.failure_context.component_failure.error_message #=> String
|
|
4069
|
+
# resp.image_summary_list[0].state.failure_context.distribution_failure.error_message #=> String
|
|
4070
|
+
# resp.image_summary_list[0].state.failure_context.distribution_failure.region_failures #=> Array
|
|
4071
|
+
# resp.image_summary_list[0].state.failure_context.distribution_failure.region_failures[0].region #=> String
|
|
4072
|
+
# resp.image_summary_list[0].state.failure_context.distribution_failure.region_failures[0].status #=> String, one of "FAILED", "CANCELLED", "TIMED_OUT"
|
|
4073
|
+
# resp.image_summary_list[0].state.failure_context.distribution_failure.region_failures[0].image_configuration_step #=> String, one of "ASSOCIATE_LICENSES", "UPDATE_LAUNCH_TEMPLATES", "PUT_SSM_PARAMETERS", "UPDATE_FAST_LAUNCH_CONFIGURATIONS", "EXPORT_AMI"
|
|
4074
|
+
# resp.image_summary_list[0].state.failure_context.distribution_failure.region_failures[0].error_message #=> String
|
|
4075
|
+
# resp.image_summary_list[0].state.failure_context.distribution_failure.region_failures[0].target_account_id #=> String
|
|
3964
4076
|
# resp.image_summary_list[0].owner #=> String
|
|
3965
4077
|
# resp.image_summary_list[0].date_created #=> String
|
|
3966
4078
|
# resp.image_summary_list[0].output_resources.amis #=> Array
|
|
@@ -3970,6 +4082,23 @@ module Aws::Imagebuilder
|
|
|
3970
4082
|
# resp.image_summary_list[0].output_resources.amis[0].description #=> String
|
|
3971
4083
|
# resp.image_summary_list[0].output_resources.amis[0].state.status #=> String, one of "PENDING", "CREATING", "BUILDING", "TESTING", "DISTRIBUTING", "INTEGRATING", "AVAILABLE", "CANCELLED", "FAILED", "DEPRECATED", "DELETED", "DISABLED"
|
|
3972
4084
|
# resp.image_summary_list[0].output_resources.amis[0].state.reason #=> String
|
|
4085
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.image_status #=> String, one of "PENDING", "CREATING", "BUILDING", "TESTING", "DISTRIBUTING", "INTEGRATING", "AVAILABLE", "CANCELLED", "FAILED", "DEPRECATED", "DELETED", "DISABLED"
|
|
4086
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.workflow_execution_id #=> String
|
|
4087
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.workflow_arn #=> String
|
|
4088
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.step_execution_id #=> String
|
|
4089
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.failed_step #=> String
|
|
4090
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.component_failure.component_arn #=> String
|
|
4091
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.component_failure.phase_name #=> String
|
|
4092
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.component_failure.step_name #=> String
|
|
4093
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.component_failure.action #=> String
|
|
4094
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.component_failure.error_message #=> String
|
|
4095
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.distribution_failure.error_message #=> String
|
|
4096
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.distribution_failure.region_failures #=> Array
|
|
4097
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.distribution_failure.region_failures[0].region #=> String
|
|
4098
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.distribution_failure.region_failures[0].status #=> String, one of "FAILED", "CANCELLED", "TIMED_OUT"
|
|
4099
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.distribution_failure.region_failures[0].image_configuration_step #=> String, one of "ASSOCIATE_LICENSES", "UPDATE_LAUNCH_TEMPLATES", "PUT_SSM_PARAMETERS", "UPDATE_FAST_LAUNCH_CONFIGURATIONS", "EXPORT_AMI"
|
|
4100
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.distribution_failure.region_failures[0].error_message #=> String
|
|
4101
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.distribution_failure.region_failures[0].target_account_id #=> String
|
|
3973
4102
|
# resp.image_summary_list[0].output_resources.amis[0].account_id #=> String
|
|
3974
4103
|
# resp.image_summary_list[0].output_resources.containers #=> Array
|
|
3975
4104
|
# resp.image_summary_list[0].output_resources.containers[0].region #=> String
|
|
@@ -3993,7 +4122,7 @@ module Aws::Imagebuilder
|
|
|
3993
4122
|
req.send_request(options)
|
|
3994
4123
|
end
|
|
3995
4124
|
|
|
3996
|
-
#
|
|
4125
|
+
# Lists the packages that are associated with an image build version, as
|
|
3997
4126
|
# determined by Amazon Web Services Systems Manager Inventory at build
|
|
3998
4127
|
# time.
|
|
3999
4128
|
#
|
|
@@ -4002,11 +4131,11 @@ module Aws::Imagebuilder
|
|
|
4002
4131
|
# Version ARN
|
|
4003
4132
|
#
|
|
4004
4133
|
# @option params [Integer] :max_results
|
|
4005
|
-
#
|
|
4134
|
+
# The maximum number of items to return in a single request.
|
|
4006
4135
|
#
|
|
4007
4136
|
# @option params [String] :next_token
|
|
4008
|
-
# A token to specify where to start paginating.
|
|
4009
|
-
# from a previously truncated response.
|
|
4137
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
4138
|
+
# value from a previously truncated response.
|
|
4010
4139
|
#
|
|
4011
4140
|
# @return [Types::ListImagePackagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4012
4141
|
#
|
|
@@ -4055,11 +4184,11 @@ module Aws::Imagebuilder
|
|
|
4055
4184
|
# * `version`
|
|
4056
4185
|
#
|
|
4057
4186
|
# @option params [Integer] :max_results
|
|
4058
|
-
#
|
|
4187
|
+
# The maximum number of items to return in a single request.
|
|
4059
4188
|
#
|
|
4060
4189
|
# @option params [String] :next_token
|
|
4061
|
-
# A token to specify where to start paginating.
|
|
4062
|
-
# from a previously truncated response.
|
|
4190
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
4191
|
+
# value from a previously truncated response.
|
|
4063
4192
|
#
|
|
4064
4193
|
# @return [Types::ListImagePipelineImagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4065
4194
|
#
|
|
@@ -4095,6 +4224,23 @@ module Aws::Imagebuilder
|
|
|
4095
4224
|
# resp.image_summary_list[0].os_version #=> String
|
|
4096
4225
|
# resp.image_summary_list[0].state.status #=> String, one of "PENDING", "CREATING", "BUILDING", "TESTING", "DISTRIBUTING", "INTEGRATING", "AVAILABLE", "CANCELLED", "FAILED", "DEPRECATED", "DELETED", "DISABLED"
|
|
4097
4226
|
# resp.image_summary_list[0].state.reason #=> String
|
|
4227
|
+
# resp.image_summary_list[0].state.failure_context.image_status #=> String, one of "PENDING", "CREATING", "BUILDING", "TESTING", "DISTRIBUTING", "INTEGRATING", "AVAILABLE", "CANCELLED", "FAILED", "DEPRECATED", "DELETED", "DISABLED"
|
|
4228
|
+
# resp.image_summary_list[0].state.failure_context.workflow_execution_id #=> String
|
|
4229
|
+
# resp.image_summary_list[0].state.failure_context.workflow_arn #=> String
|
|
4230
|
+
# resp.image_summary_list[0].state.failure_context.step_execution_id #=> String
|
|
4231
|
+
# resp.image_summary_list[0].state.failure_context.failed_step #=> String
|
|
4232
|
+
# resp.image_summary_list[0].state.failure_context.component_failure.component_arn #=> String
|
|
4233
|
+
# resp.image_summary_list[0].state.failure_context.component_failure.phase_name #=> String
|
|
4234
|
+
# resp.image_summary_list[0].state.failure_context.component_failure.step_name #=> String
|
|
4235
|
+
# resp.image_summary_list[0].state.failure_context.component_failure.action #=> String
|
|
4236
|
+
# resp.image_summary_list[0].state.failure_context.component_failure.error_message #=> String
|
|
4237
|
+
# resp.image_summary_list[0].state.failure_context.distribution_failure.error_message #=> String
|
|
4238
|
+
# resp.image_summary_list[0].state.failure_context.distribution_failure.region_failures #=> Array
|
|
4239
|
+
# resp.image_summary_list[0].state.failure_context.distribution_failure.region_failures[0].region #=> String
|
|
4240
|
+
# resp.image_summary_list[0].state.failure_context.distribution_failure.region_failures[0].status #=> String, one of "FAILED", "CANCELLED", "TIMED_OUT"
|
|
4241
|
+
# resp.image_summary_list[0].state.failure_context.distribution_failure.region_failures[0].image_configuration_step #=> String, one of "ASSOCIATE_LICENSES", "UPDATE_LAUNCH_TEMPLATES", "PUT_SSM_PARAMETERS", "UPDATE_FAST_LAUNCH_CONFIGURATIONS", "EXPORT_AMI"
|
|
4242
|
+
# resp.image_summary_list[0].state.failure_context.distribution_failure.region_failures[0].error_message #=> String
|
|
4243
|
+
# resp.image_summary_list[0].state.failure_context.distribution_failure.region_failures[0].target_account_id #=> String
|
|
4098
4244
|
# resp.image_summary_list[0].owner #=> String
|
|
4099
4245
|
# resp.image_summary_list[0].date_created #=> String
|
|
4100
4246
|
# resp.image_summary_list[0].output_resources.amis #=> Array
|
|
@@ -4104,6 +4250,23 @@ module Aws::Imagebuilder
|
|
|
4104
4250
|
# resp.image_summary_list[0].output_resources.amis[0].description #=> String
|
|
4105
4251
|
# resp.image_summary_list[0].output_resources.amis[0].state.status #=> String, one of "PENDING", "CREATING", "BUILDING", "TESTING", "DISTRIBUTING", "INTEGRATING", "AVAILABLE", "CANCELLED", "FAILED", "DEPRECATED", "DELETED", "DISABLED"
|
|
4106
4252
|
# resp.image_summary_list[0].output_resources.amis[0].state.reason #=> String
|
|
4253
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.image_status #=> String, one of "PENDING", "CREATING", "BUILDING", "TESTING", "DISTRIBUTING", "INTEGRATING", "AVAILABLE", "CANCELLED", "FAILED", "DEPRECATED", "DELETED", "DISABLED"
|
|
4254
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.workflow_execution_id #=> String
|
|
4255
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.workflow_arn #=> String
|
|
4256
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.step_execution_id #=> String
|
|
4257
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.failed_step #=> String
|
|
4258
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.component_failure.component_arn #=> String
|
|
4259
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.component_failure.phase_name #=> String
|
|
4260
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.component_failure.step_name #=> String
|
|
4261
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.component_failure.action #=> String
|
|
4262
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.component_failure.error_message #=> String
|
|
4263
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.distribution_failure.error_message #=> String
|
|
4264
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.distribution_failure.region_failures #=> Array
|
|
4265
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.distribution_failure.region_failures[0].region #=> String
|
|
4266
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.distribution_failure.region_failures[0].status #=> String, one of "FAILED", "CANCELLED", "TIMED_OUT"
|
|
4267
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.distribution_failure.region_failures[0].image_configuration_step #=> String, one of "ASSOCIATE_LICENSES", "UPDATE_LAUNCH_TEMPLATES", "PUT_SSM_PARAMETERS", "UPDATE_FAST_LAUNCH_CONFIGURATIONS", "EXPORT_AMI"
|
|
4268
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.distribution_failure.region_failures[0].error_message #=> String
|
|
4269
|
+
# resp.image_summary_list[0].output_resources.amis[0].state.failure_context.distribution_failure.region_failures[0].target_account_id #=> String
|
|
4107
4270
|
# resp.image_summary_list[0].output_resources.amis[0].account_id #=> String
|
|
4108
4271
|
# resp.image_summary_list[0].output_resources.containers #=> Array
|
|
4109
4272
|
# resp.image_summary_list[0].output_resources.containers[0].region #=> String
|
|
@@ -4145,11 +4308,11 @@ module Aws::Imagebuilder
|
|
|
4145
4308
|
# * `status`
|
|
4146
4309
|
#
|
|
4147
4310
|
# @option params [Integer] :max_results
|
|
4148
|
-
#
|
|
4311
|
+
# The maximum number of items to return in a single request.
|
|
4149
4312
|
#
|
|
4150
4313
|
# @option params [String] :next_token
|
|
4151
|
-
# A token to specify where to start paginating.
|
|
4152
|
-
# from a previously truncated response.
|
|
4314
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
4315
|
+
# value from a previously truncated response.
|
|
4153
4316
|
#
|
|
4154
4317
|
# @return [Types::ListImagePipelinesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4155
4318
|
#
|
|
@@ -4246,11 +4409,11 @@ module Aws::Imagebuilder
|
|
|
4246
4409
|
# * `platform`
|
|
4247
4410
|
#
|
|
4248
4411
|
# @option params [Integer] :max_results
|
|
4249
|
-
#
|
|
4412
|
+
# The maximum number of items to return in a single request.
|
|
4250
4413
|
#
|
|
4251
4414
|
# @option params [String] :next_token
|
|
4252
|
-
# A token to specify where to start paginating.
|
|
4253
|
-
# from a previously truncated response.
|
|
4415
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
4416
|
+
# value from a previously truncated response.
|
|
4254
4417
|
#
|
|
4255
4418
|
# @return [Types::ListImageRecipesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4256
4419
|
#
|
|
@@ -4322,8 +4485,8 @@ module Aws::Imagebuilder
|
|
|
4322
4485
|
# IDs.
|
|
4323
4486
|
#
|
|
4324
4487
|
# @option params [String] :next_token
|
|
4325
|
-
# A token to specify where to start paginating.
|
|
4326
|
-
# from a previously truncated response.
|
|
4488
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
4489
|
+
# value from a previously truncated response.
|
|
4327
4490
|
#
|
|
4328
4491
|
# @return [Types::ListImageScanFindingAggregationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4329
4492
|
#
|
|
@@ -4398,11 +4561,11 @@ module Aws::Imagebuilder
|
|
|
4398
4561
|
# listed.
|
|
4399
4562
|
#
|
|
4400
4563
|
# @option params [Integer] :max_results
|
|
4401
|
-
#
|
|
4564
|
+
# The maximum number of items to return in a single request.
|
|
4402
4565
|
#
|
|
4403
4566
|
# @option params [String] :next_token
|
|
4404
|
-
# A token to specify where to start paginating.
|
|
4405
|
-
# from a previously truncated response.
|
|
4567
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
4568
|
+
# value from a previously truncated response.
|
|
4406
4569
|
#
|
|
4407
4570
|
# @return [Types::ListImageScanFindingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4408
4571
|
#
|
|
@@ -4492,11 +4655,9 @@ module Aws::Imagebuilder
|
|
|
4492
4655
|
# Results.
|
|
4493
4656
|
#
|
|
4494
4657
|
# @option params [String] :owner
|
|
4495
|
-
#
|
|
4496
|
-
#
|
|
4497
|
-
#
|
|
4498
|
-
# Amazon, or those images that have been shared with you by other
|
|
4499
|
-
# customers.
|
|
4658
|
+
# Filters the list to images owned by you, by Amazon, or shared with you
|
|
4659
|
+
# by other accounts. By default, only your account's images are
|
|
4660
|
+
# returned.
|
|
4500
4661
|
#
|
|
4501
4662
|
# @option params [Array<Types::Filter>] :filters
|
|
4502
4663
|
# Use the following filters to streamline results:
|
|
@@ -4515,11 +4676,11 @@ module Aws::Imagebuilder
|
|
|
4515
4676
|
# Requests a list of images with a specific recipe name.
|
|
4516
4677
|
#
|
|
4517
4678
|
# @option params [Integer] :max_results
|
|
4518
|
-
#
|
|
4679
|
+
# The maximum number of items to return in a single request.
|
|
4519
4680
|
#
|
|
4520
4681
|
# @option params [String] :next_token
|
|
4521
|
-
# A token to specify where to start paginating.
|
|
4522
|
-
# from a previously truncated response.
|
|
4682
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
4683
|
+
# value from a previously truncated response.
|
|
4523
4684
|
#
|
|
4524
4685
|
# @option params [Boolean] :include_deprecated
|
|
4525
4686
|
# Includes deprecated images in the response list.
|
|
@@ -4579,11 +4740,11 @@ module Aws::Imagebuilder
|
|
|
4579
4740
|
# You can filter on `name` to streamline results.
|
|
4580
4741
|
#
|
|
4581
4742
|
# @option params [Integer] :max_results
|
|
4582
|
-
#
|
|
4743
|
+
# The maximum number of items to return in a single request.
|
|
4583
4744
|
#
|
|
4584
4745
|
# @option params [String] :next_token
|
|
4585
|
-
# A token to specify where to start paginating.
|
|
4586
|
-
# from a previously truncated response.
|
|
4746
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
4747
|
+
# value from a previously truncated response.
|
|
4587
4748
|
#
|
|
4588
4749
|
# @return [Types::ListInfrastructureConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4589
4750
|
#
|
|
@@ -4637,12 +4798,11 @@ module Aws::Imagebuilder
|
|
|
4637
4798
|
req.send_request(options)
|
|
4638
4799
|
end
|
|
4639
4800
|
|
|
4640
|
-
#
|
|
4801
|
+
# Lists resources that the runtime instance of the image lifecycle
|
|
4641
4802
|
# identified for lifecycle actions.
|
|
4642
4803
|
#
|
|
4643
4804
|
# @option params [required, String] :lifecycle_execution_id
|
|
4644
|
-
#
|
|
4645
|
-
# policy to get runtime details.
|
|
4805
|
+
# The unique identifier for a runtime instance of the lifecycle policy.
|
|
4646
4806
|
#
|
|
4647
4807
|
# @option params [String] :parent_resource_id
|
|
4648
4808
|
# You can leave this empty to get a list of Image Builder resources that
|
|
@@ -4655,11 +4815,11 @@ module Aws::Imagebuilder
|
|
|
4655
4815
|
# stored in ECR repositories.
|
|
4656
4816
|
#
|
|
4657
4817
|
# @option params [Integer] :max_results
|
|
4658
|
-
#
|
|
4818
|
+
# The maximum number of items to return in a single request.
|
|
4659
4819
|
#
|
|
4660
4820
|
# @option params [String] :next_token
|
|
4661
|
-
# A token to specify where to start paginating.
|
|
4662
|
-
# from a previously truncated response.
|
|
4821
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
4822
|
+
# value from a previously truncated response.
|
|
4663
4823
|
#
|
|
4664
4824
|
# @return [Types::ListLifecycleExecutionResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4665
4825
|
#
|
|
@@ -4711,14 +4871,14 @@ module Aws::Imagebuilder
|
|
|
4711
4871
|
req.send_request(options)
|
|
4712
4872
|
end
|
|
4713
4873
|
|
|
4714
|
-
#
|
|
4874
|
+
# Retrieves the lifecycle runtime history for the specified resource.
|
|
4715
4875
|
#
|
|
4716
4876
|
# @option params [Integer] :max_results
|
|
4717
|
-
#
|
|
4877
|
+
# The maximum number of items to return in a single request.
|
|
4718
4878
|
#
|
|
4719
4879
|
# @option params [String] :next_token
|
|
4720
|
-
# A token to specify where to start paginating.
|
|
4721
|
-
# from a previously truncated response.
|
|
4880
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
4881
|
+
# value from a previously truncated response.
|
|
4722
4882
|
#
|
|
4723
4883
|
# @option params [required, String] :resource_arn
|
|
4724
4884
|
# The Amazon Resource Name (ARN) of the resource for which to get a list
|
|
@@ -4760,18 +4920,19 @@ module Aws::Imagebuilder
|
|
|
4760
4920
|
req.send_request(options)
|
|
4761
4921
|
end
|
|
4762
4922
|
|
|
4763
|
-
#
|
|
4923
|
+
# Retrieves a list of lifecycle policies in your Amazon Web Services
|
|
4924
|
+
# account.
|
|
4764
4925
|
#
|
|
4765
4926
|
# @option params [Array<Types::Filter>] :filters
|
|
4766
4927
|
# Streamline results based on one of the following values: `Name`,
|
|
4767
4928
|
# `Status`.
|
|
4768
4929
|
#
|
|
4769
4930
|
# @option params [Integer] :max_results
|
|
4770
|
-
#
|
|
4931
|
+
# The maximum number of items to return in a single request.
|
|
4771
4932
|
#
|
|
4772
4933
|
# @option params [String] :next_token
|
|
4773
|
-
# A token to specify where to start paginating.
|
|
4774
|
-
# from a previously truncated response.
|
|
4934
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
4935
|
+
# value from a previously truncated response.
|
|
4775
4936
|
#
|
|
4776
4937
|
# @return [Types::ListLifecyclePoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4777
4938
|
#
|
|
@@ -4848,15 +5009,15 @@ module Aws::Imagebuilder
|
|
|
4848
5009
|
req.send_request(options)
|
|
4849
5010
|
end
|
|
4850
5011
|
|
|
4851
|
-
#
|
|
4852
|
-
# in your Amazon Web Services account.
|
|
5012
|
+
# Retrieves a list of workflow steps that are waiting for action for
|
|
5013
|
+
# workflows in your Amazon Web Services account.
|
|
4853
5014
|
#
|
|
4854
5015
|
# @option params [Integer] :max_results
|
|
4855
|
-
#
|
|
5016
|
+
# The maximum number of items to return in a single request.
|
|
4856
5017
|
#
|
|
4857
5018
|
# @option params [String] :next_token
|
|
4858
|
-
# A token to specify where to start paginating.
|
|
4859
|
-
# from a previously truncated response.
|
|
5019
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
5020
|
+
# value from a previously truncated response.
|
|
4860
5021
|
#
|
|
4861
5022
|
# @return [Types::ListWaitingWorkflowStepsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4862
5023
|
#
|
|
@@ -4900,11 +5061,11 @@ module Aws::Imagebuilder
|
|
|
4900
5061
|
# get a list of build versions.
|
|
4901
5062
|
#
|
|
4902
5063
|
# @option params [Integer] :max_results
|
|
4903
|
-
#
|
|
5064
|
+
# The maximum number of items to return in a single request.
|
|
4904
5065
|
#
|
|
4905
5066
|
# @option params [String] :next_token
|
|
4906
|
-
# A token to specify where to start paginating.
|
|
4907
|
-
# from a previously truncated response.
|
|
5067
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
5068
|
+
# value from a previously truncated response.
|
|
4908
5069
|
#
|
|
4909
5070
|
# @return [Types::ListWorkflowBuildVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4910
5071
|
#
|
|
@@ -4951,11 +5112,11 @@ module Aws::Imagebuilder
|
|
|
4951
5112
|
# specific image build version.
|
|
4952
5113
|
#
|
|
4953
5114
|
# @option params [Integer] :max_results
|
|
4954
|
-
#
|
|
5115
|
+
# The maximum number of items to return in a single request.
|
|
4955
5116
|
#
|
|
4956
5117
|
# @option params [String] :next_token
|
|
4957
|
-
# A token to specify where to start paginating.
|
|
4958
|
-
# from a previously truncated response.
|
|
5118
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
5119
|
+
# value from a previously truncated response.
|
|
4959
5120
|
#
|
|
4960
5121
|
# @option params [required, String] :image_build_version_arn
|
|
4961
5122
|
# List all workflow runtime instances for the specified image build
|
|
@@ -5013,11 +5174,11 @@ module Aws::Imagebuilder
|
|
|
5013
5174
|
# workflow that you specify in the request.
|
|
5014
5175
|
#
|
|
5015
5176
|
# @option params [Integer] :max_results
|
|
5016
|
-
#
|
|
5177
|
+
# The maximum number of items to return in a single request.
|
|
5017
5178
|
#
|
|
5018
5179
|
# @option params [String] :next_token
|
|
5019
|
-
# A token to specify where to start paginating.
|
|
5020
|
-
# from a previously truncated response.
|
|
5180
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
5181
|
+
# value from a previously truncated response.
|
|
5021
5182
|
#
|
|
5022
5183
|
# @option params [required, String] :workflow_execution_id
|
|
5023
5184
|
# The unique identifier that Image Builder assigned to keep track of
|
|
@@ -5058,6 +5219,8 @@ module Aws::Imagebuilder
|
|
|
5058
5219
|
# resp.steps[0].outputs #=> String
|
|
5059
5220
|
# resp.steps[0].start_time #=> String
|
|
5060
5221
|
# resp.steps[0].end_time #=> String
|
|
5222
|
+
# resp.steps[0].attempt_number #=> Integer
|
|
5223
|
+
# resp.steps[0].max_attempts #=> Integer
|
|
5061
5224
|
# resp.workflow_build_version_arn #=> String
|
|
5062
5225
|
# resp.workflow_execution_id #=> String
|
|
5063
5226
|
# resp.image_build_version_arn #=> String
|
|
@@ -5086,11 +5249,11 @@ module Aws::Imagebuilder
|
|
|
5086
5249
|
# Specify all or part of the workflow name to streamline results.
|
|
5087
5250
|
#
|
|
5088
5251
|
# @option params [Integer] :max_results
|
|
5089
|
-
#
|
|
5252
|
+
# The maximum number of items to return in a single request.
|
|
5090
5253
|
#
|
|
5091
5254
|
# @option params [String] :next_token
|
|
5092
|
-
# A token to specify where to start paginating.
|
|
5093
|
-
# from a previously truncated response.
|
|
5255
|
+
# A token to specify where to start paginating. Use the `nextToken`
|
|
5256
|
+
# value from a previously truncated response.
|
|
5094
5257
|
#
|
|
5095
5258
|
# @return [Types::ListWorkflowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5096
5259
|
#
|
|
@@ -5135,11 +5298,11 @@ module Aws::Imagebuilder
|
|
|
5135
5298
|
req.send_request(options)
|
|
5136
5299
|
end
|
|
5137
5300
|
|
|
5138
|
-
# Applies a policy to a component.
|
|
5139
|
-
#
|
|
5140
|
-
#
|
|
5141
|
-
#
|
|
5142
|
-
#
|
|
5301
|
+
# Applies a policy to a component. To share resources, call the RAM API
|
|
5302
|
+
# [CreateResourceShare][1]. If you call this API, you must also call the
|
|
5303
|
+
# RAM API [PromoteResourceShareCreatedFromPolicy][2] so that the
|
|
5304
|
+
# resource is visible to all principals with whom the resource is
|
|
5305
|
+
# shared.
|
|
5143
5306
|
#
|
|
5144
5307
|
#
|
|
5145
5308
|
#
|
|
@@ -5179,15 +5342,16 @@ module Aws::Imagebuilder
|
|
|
5179
5342
|
req.send_request(options)
|
|
5180
5343
|
end
|
|
5181
5344
|
|
|
5182
|
-
# Applies a policy to a container image.
|
|
5183
|
-
# RAM API CreateResourceShare
|
|
5184
|
-
#
|
|
5185
|
-
# to
|
|
5186
|
-
#
|
|
5187
|
-
#
|
|
5188
|
-
#
|
|
5189
|
-
#
|
|
5190
|
-
#
|
|
5345
|
+
# Applies a policy to a container image. To share resources, call the
|
|
5346
|
+
# RAM API [CreateResourceShare][1]. If you call this API, you must also
|
|
5347
|
+
# call the RAM API [PromoteResourceShareCreatedFromPolicy][2] so that
|
|
5348
|
+
# the resource is visible to all principals with whom the resource is
|
|
5349
|
+
# shared.
|
|
5350
|
+
#
|
|
5351
|
+
#
|
|
5352
|
+
#
|
|
5353
|
+
# [1]: https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html
|
|
5354
|
+
# [2]: https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html
|
|
5191
5355
|
#
|
|
5192
5356
|
# @option params [required, String] :container_recipe_arn
|
|
5193
5357
|
# The Amazon Resource Name (ARN) of the container recipe that this
|
|
@@ -5222,11 +5386,11 @@ module Aws::Imagebuilder
|
|
|
5222
5386
|
req.send_request(options)
|
|
5223
5387
|
end
|
|
5224
5388
|
|
|
5225
|
-
# Applies a policy to an image.
|
|
5226
|
-
# [CreateResourceShare][1]
|
|
5227
|
-
#
|
|
5228
|
-
#
|
|
5229
|
-
#
|
|
5389
|
+
# Applies a policy to an image. To share resources, call the RAM API
|
|
5390
|
+
# [CreateResourceShare][1]. If you call this API, you must also call the
|
|
5391
|
+
# RAM API [PromoteResourceShareCreatedFromPolicy][2] so that the
|
|
5392
|
+
# resource is visible to all principals with whom the resource is
|
|
5393
|
+
# shared.
|
|
5230
5394
|
#
|
|
5231
5395
|
#
|
|
5232
5396
|
#
|
|
@@ -5266,11 +5430,10 @@ module Aws::Imagebuilder
|
|
|
5266
5430
|
req.send_request(options)
|
|
5267
5431
|
end
|
|
5268
5432
|
|
|
5269
|
-
# Applies a policy to an image recipe.
|
|
5270
|
-
#
|
|
5271
|
-
#
|
|
5272
|
-
#
|
|
5273
|
-
# resource to be visible to all principals with whom the resource is
|
|
5433
|
+
# Applies a policy to an image recipe. To share resources, call the RAM
|
|
5434
|
+
# API [CreateResourceShare][1]. If you call this API, you must also call
|
|
5435
|
+
# the RAM API [PromoteResourceShareCreatedFromPolicy][2] so that the
|
|
5436
|
+
# resource is visible to all principals with whom the resource is
|
|
5274
5437
|
# shared.
|
|
5275
5438
|
#
|
|
5276
5439
|
#
|
|
@@ -5311,15 +5474,17 @@ module Aws::Imagebuilder
|
|
|
5311
5474
|
req.send_request(options)
|
|
5312
5475
|
end
|
|
5313
5476
|
|
|
5314
|
-
#
|
|
5477
|
+
# Retries an image distribution or test without rebuilding the image.
|
|
5315
5478
|
#
|
|
5316
5479
|
# @option params [required, String] :image_build_version_arn
|
|
5317
5480
|
# The source image Amazon Resource Name (ARN) to retry.
|
|
5318
5481
|
#
|
|
5319
5482
|
# @option params [required, String] :client_token
|
|
5320
|
-
#
|
|
5321
|
-
#
|
|
5322
|
-
# the
|
|
5483
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
5484
|
+
# operation completes no more than one time. If this token matches a
|
|
5485
|
+
# previous request, the service ignores the request, but does not return
|
|
5486
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
5487
|
+
# *Amazon EC2 API Reference*.
|
|
5323
5488
|
#
|
|
5324
5489
|
# **A suitable default value is auto-generated.** You should normally
|
|
5325
5490
|
# not need to pass this option.**
|
|
@@ -5377,9 +5542,11 @@ module Aws::Imagebuilder
|
|
|
5377
5542
|
# step output references.
|
|
5378
5543
|
#
|
|
5379
5544
|
# @option params [required, String] :client_token
|
|
5380
|
-
#
|
|
5381
|
-
#
|
|
5382
|
-
# the
|
|
5545
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
5546
|
+
# operation completes no more than one time. If this token matches a
|
|
5547
|
+
# previous request, the service ignores the request, but does not return
|
|
5548
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
5549
|
+
# *Amazon EC2 API Reference*.
|
|
5383
5550
|
#
|
|
5384
5551
|
# **A suitable default value is auto-generated.** You should normally
|
|
5385
5552
|
# not need to pass this option.**
|
|
@@ -5426,9 +5593,11 @@ module Aws::Imagebuilder
|
|
|
5426
5593
|
# manually invoke.
|
|
5427
5594
|
#
|
|
5428
5595
|
# @option params [required, String] :client_token
|
|
5429
|
-
#
|
|
5430
|
-
#
|
|
5431
|
-
# the
|
|
5596
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
5597
|
+
# operation completes no more than one time. If this token matches a
|
|
5598
|
+
# previous request, the service ignores the request, but does not return
|
|
5599
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
5600
|
+
# *Amazon EC2 API Reference*.
|
|
5432
5601
|
#
|
|
5433
5602
|
# **A suitable default value is auto-generated.** You should normally
|
|
5434
5603
|
# not need to pass this option.**
|
|
@@ -5438,8 +5607,8 @@ module Aws::Imagebuilder
|
|
|
5438
5607
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
|
5439
5608
|
#
|
|
5440
5609
|
# @option params [Hash<String,String>] :tags
|
|
5441
|
-
#
|
|
5442
|
-
# created
|
|
5610
|
+
# The tags for Image Builder to apply to the image resource that's
|
|
5611
|
+
# created when pipeline execution starts.
|
|
5443
5612
|
#
|
|
5444
5613
|
# @return [Types::StartImagePipelineExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5445
5614
|
#
|
|
@@ -5472,8 +5641,8 @@ module Aws::Imagebuilder
|
|
|
5472
5641
|
req.send_request(options)
|
|
5473
5642
|
end
|
|
5474
5643
|
|
|
5475
|
-
#
|
|
5476
|
-
# specified image resources.
|
|
5644
|
+
# Begins an asynchronous resource state update for lifecycle changes to
|
|
5645
|
+
# the specified image resources.
|
|
5477
5646
|
#
|
|
5478
5647
|
# @option params [required, String] :resource_arn
|
|
5479
5648
|
# The Amazon Resource Name (ARN) of the image build version to update.
|
|
@@ -5510,9 +5679,11 @@ module Aws::Imagebuilder
|
|
|
5510
5679
|
# must be a future time.
|
|
5511
5680
|
#
|
|
5512
5681
|
# @option params [required, String] :client_token
|
|
5513
|
-
#
|
|
5514
|
-
#
|
|
5515
|
-
# the
|
|
5682
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
5683
|
+
# operation completes no more than one time. If this token matches a
|
|
5684
|
+
# previous request, the service ignores the request, but does not return
|
|
5685
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
5686
|
+
# *Amazon EC2 API Reference*.
|
|
5516
5687
|
#
|
|
5517
5688
|
# **A suitable default value is auto-generated.** You should normally
|
|
5518
5689
|
# not need to pass this option.**
|
|
@@ -5625,7 +5796,7 @@ module Aws::Imagebuilder
|
|
|
5625
5796
|
req.send_request(options)
|
|
5626
5797
|
end
|
|
5627
5798
|
|
|
5628
|
-
# Updates a
|
|
5799
|
+
# Updates a distribution configuration. Distribution configurations
|
|
5629
5800
|
# define and configure the outputs of your pipeline.
|
|
5630
5801
|
#
|
|
5631
5802
|
# @option params [required, String] :distribution_configuration_arn
|
|
@@ -5639,9 +5810,11 @@ module Aws::Imagebuilder
|
|
|
5639
5810
|
# The distributions of the distribution configuration.
|
|
5640
5811
|
#
|
|
5641
5812
|
# @option params [required, String] :client_token
|
|
5642
|
-
#
|
|
5643
|
-
#
|
|
5644
|
-
# the
|
|
5813
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
5814
|
+
# operation completes no more than one time. If this token matches a
|
|
5815
|
+
# previous request, the service ignores the request, but does not return
|
|
5816
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
5817
|
+
# *Amazon EC2 API Reference*.
|
|
5645
5818
|
#
|
|
5646
5819
|
# **A suitable default value is auto-generated.** You should normally
|
|
5647
5820
|
# not need to pass this option.**
|
|
@@ -5743,7 +5916,7 @@ module Aws::Imagebuilder
|
|
|
5743
5916
|
req.send_request(options)
|
|
5744
5917
|
end
|
|
5745
5918
|
|
|
5746
|
-
# Updates an image pipeline.
|
|
5919
|
+
# Updates an image pipeline. Use image pipelines to automate the
|
|
5747
5920
|
# creation and distribution of images. You must specify exactly one
|
|
5748
5921
|
# recipe for your image, using either a `containerRecipeArn` or an
|
|
5749
5922
|
# `imageRecipeArn`.
|
|
@@ -5762,8 +5935,8 @@ module Aws::Imagebuilder
|
|
|
5762
5935
|
# The description of the image pipeline.
|
|
5763
5936
|
#
|
|
5764
5937
|
# @option params [String] :image_recipe_arn
|
|
5765
|
-
# The Amazon Resource Name (ARN) of the image recipe that
|
|
5766
|
-
#
|
|
5938
|
+
# The Amazon Resource Name (ARN) of the image recipe that configures
|
|
5939
|
+
# images updated by this image pipeline.
|
|
5767
5940
|
#
|
|
5768
5941
|
# @option params [String] :container_recipe_arn
|
|
5769
5942
|
# The Amazon Resource Name (ARN) of the container pipeline to update.
|
|
@@ -5782,10 +5955,9 @@ module Aws::Imagebuilder
|
|
|
5782
5955
|
# The image test configuration of the image pipeline.
|
|
5783
5956
|
#
|
|
5784
5957
|
# @option params [Boolean] :enhanced_image_metadata_enabled
|
|
5785
|
-
#
|
|
5786
|
-
# including the operating system (OS) version and package
|
|
5787
|
-
#
|
|
5788
|
-
# Image Builder. Enabled by default.
|
|
5958
|
+
# Specifies whether to collect additional information about the image
|
|
5959
|
+
# being created, including the operating system (OS) version and package
|
|
5960
|
+
# list. Defaults to `true`.
|
|
5789
5961
|
#
|
|
5790
5962
|
# @option params [Types::Schedule] :schedule
|
|
5791
5963
|
# The schedule of the image pipeline.
|
|
@@ -5794,9 +5966,11 @@ module Aws::Imagebuilder
|
|
|
5794
5966
|
# The status of the image pipeline.
|
|
5795
5967
|
#
|
|
5796
5968
|
# @option params [required, String] :client_token
|
|
5797
|
-
#
|
|
5798
|
-
#
|
|
5799
|
-
# the
|
|
5969
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
5970
|
+
# operation completes no more than one time. If this token matches a
|
|
5971
|
+
# previous request, the service ignores the request, but does not return
|
|
5972
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
5973
|
+
# *Amazon EC2 API Reference*.
|
|
5800
5974
|
#
|
|
5801
5975
|
# **A suitable default value is auto-generated.** You should normally
|
|
5802
5976
|
# not need to pass this option.**
|
|
@@ -5897,9 +6071,9 @@ module Aws::Imagebuilder
|
|
|
5897
6071
|
req.send_request(options)
|
|
5898
6072
|
end
|
|
5899
6073
|
|
|
5900
|
-
# Updates
|
|
5901
|
-
# configuration defines the environment in which
|
|
5902
|
-
#
|
|
6074
|
+
# Updates an infrastructure configuration. An infrastructure
|
|
6075
|
+
# configuration defines the environment in which Image Builder builds
|
|
6076
|
+
# and tests your image.
|
|
5903
6077
|
#
|
|
5904
6078
|
# @option params [required, String] :infrastructure_configuration_arn
|
|
5905
6079
|
# The Amazon Resource Name (ARN) of the infrastructure configuration
|
|
@@ -5910,8 +6084,8 @@ module Aws::Imagebuilder
|
|
|
5910
6084
|
#
|
|
5911
6085
|
# @option params [Array<String>] :instance_types
|
|
5912
6086
|
# The instance types of the infrastructure configuration. You can
|
|
5913
|
-
# specify one or more instance types to use for this build.
|
|
5914
|
-
#
|
|
6087
|
+
# specify one or more instance types to use for this build. Image
|
|
6088
|
+
# Builder picks one of these instance types based on availability.
|
|
5915
6089
|
#
|
|
5916
6090
|
# @option params [required, String] :instance_profile_name
|
|
5917
6091
|
# The instance profile to associate with the instance used to customize
|
|
@@ -5933,14 +6107,14 @@ module Aws::Imagebuilder
|
|
|
5933
6107
|
# log on to and debug the instance used to create your image.
|
|
5934
6108
|
#
|
|
5935
6109
|
# @option params [Boolean] :terminate_instance_on_failure
|
|
5936
|
-
#
|
|
5937
|
-
#
|
|
5938
|
-
#
|
|
5939
|
-
#
|
|
6110
|
+
# Specifies whether to terminate the instance on failure. Set to false
|
|
6111
|
+
# if you want Image Builder to retain the instance used to configure
|
|
6112
|
+
# your AMI if the build or test phase of your workflow fails. Defaults
|
|
6113
|
+
# to `true`.
|
|
5940
6114
|
#
|
|
5941
6115
|
# @option params [String] :sns_topic_arn
|
|
5942
|
-
# The Amazon Resource Name (ARN)
|
|
5943
|
-
# image build event notifications.
|
|
6116
|
+
# The Amazon Resource Name (ARN) of the SNS topic to which Image Builder
|
|
6117
|
+
# sends image build event notifications.
|
|
5944
6118
|
#
|
|
5945
6119
|
# <note markdown="1"> EC2 Image Builder is unable to send notifications to SNS topics that
|
|
5946
6120
|
# are encrypted using keys from other accounts. The key that is used to
|
|
@@ -5971,12 +6145,14 @@ module Aws::Imagebuilder
|
|
|
5971
6145
|
#
|
|
5972
6146
|
# @option params [Types::Placement] :placement
|
|
5973
6147
|
# The instance placement settings that define where the instances that
|
|
5974
|
-
# are launched from your image
|
|
6148
|
+
# are launched from your image run.
|
|
5975
6149
|
#
|
|
5976
6150
|
# @option params [required, String] :client_token
|
|
5977
|
-
#
|
|
5978
|
-
#
|
|
5979
|
-
# the
|
|
6151
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
6152
|
+
# operation completes no more than one time. If this token matches a
|
|
6153
|
+
# previous request, the service ignores the request, but does not return
|
|
6154
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
6155
|
+
# *Amazon EC2 API Reference*.
|
|
5980
6156
|
#
|
|
5981
6157
|
# **A suitable default value is auto-generated.** You should normally
|
|
5982
6158
|
# not need to pass this option.**
|
|
@@ -6040,7 +6216,7 @@ module Aws::Imagebuilder
|
|
|
6040
6216
|
req.send_request(options)
|
|
6041
6217
|
end
|
|
6042
6218
|
|
|
6043
|
-
#
|
|
6219
|
+
# Updates the specified lifecycle policy.
|
|
6044
6220
|
#
|
|
6045
6221
|
# @option params [required, String] :lifecycle_policy_arn
|
|
6046
6222
|
# The Amazon Resource Name (ARN) of the lifecycle policy resource.
|
|
@@ -6065,9 +6241,11 @@ module Aws::Imagebuilder
|
|
|
6065
6241
|
# Selection criteria for resources that the lifecycle policy applies to.
|
|
6066
6242
|
#
|
|
6067
6243
|
# @option params [required, String] :client_token
|
|
6068
|
-
#
|
|
6069
|
-
#
|
|
6070
|
-
# the
|
|
6244
|
+
# A unique, case-sensitive identifier you provide to ensure that the
|
|
6245
|
+
# operation completes no more than one time. If this token matches a
|
|
6246
|
+
# previous request, the service ignores the request, but does not return
|
|
6247
|
+
# an error. For more information, see [Ensuring idempotency][1] in the
|
|
6248
|
+
# *Amazon EC2 API Reference*.
|
|
6071
6249
|
#
|
|
6072
6250
|
# **A suitable default value is auto-generated.** You should normally
|
|
6073
6251
|
# not need to pass this option.**
|
|
@@ -6168,7 +6346,7 @@ module Aws::Imagebuilder
|
|
|
6168
6346
|
tracer: tracer
|
|
6169
6347
|
)
|
|
6170
6348
|
context[:gem_name] = 'aws-sdk-imagebuilder'
|
|
6171
|
-
context[:gem_version] = '1.
|
|
6349
|
+
context[:gem_version] = '1.112.0'
|
|
6172
6350
|
Seahorse::Client::Request.new(handlers, context)
|
|
6173
6351
|
end
|
|
6174
6352
|
|