aws-sdk-imagebuilder 1.55.0 → 1.57.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -303,7 +303,9 @@ module Aws::Imagebuilder
303
303
  # @return [String]
304
304
  #
305
305
  # @!attribute [rw] change_description
306
- # The change description of the component.
306
+ # Describes what change has been made in this version of the
307
+ # component, or what makes this version different from other versions
308
+ # of the component.
307
309
  # @return [String]
308
310
  #
309
311
  # @!attribute [rw] type
@@ -461,8 +463,7 @@ module Aws::Imagebuilder
461
463
  include Aws::Structure
462
464
  end
463
465
 
464
- # A group of fields that describe the current status of components that
465
- # are no longer active.
466
+ # A group of fields that describe the current status of components.
466
467
  #
467
468
  # @!attribute [rw] status
468
469
  # The current state of the component.
@@ -928,7 +929,7 @@ module Aws::Imagebuilder
928
929
  # @!attribute [rw] change_description
929
930
  # The change description of the component. Describes what change has
930
931
  # been made in this version, or what makes this version different from
931
- # other versions of this component.
932
+ # other versions of the component.
932
933
  # @return [String]
933
934
  #
934
935
  # @!attribute [rw] platform
@@ -1295,6 +1296,15 @@ module Aws::Imagebuilder
1295
1296
  # Contains settings for vulnerability scans.
1296
1297
  # @return [Types::ImageScanningConfiguration]
1297
1298
  #
1299
+ # @!attribute [rw] workflows
1300
+ # Contains an array of workflow configuration objects.
1301
+ # @return [Array<Types::WorkflowConfiguration>]
1302
+ #
1303
+ # @!attribute [rw] execution_role
1304
+ # The name or Amazon Resource Name (ARN) for the IAM role you create
1305
+ # that grants Image Builder access to perform workflow actions.
1306
+ # @return [String]
1307
+ #
1298
1308
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImagePipelineRequest AWS API Documentation
1299
1309
  #
1300
1310
  class CreateImagePipelineRequest < Struct.new(
@@ -1310,7 +1320,9 @@ module Aws::Imagebuilder
1310
1320
  :status,
1311
1321
  :tags,
1312
1322
  :client_token,
1313
- :image_scanning_configuration)
1323
+ :image_scanning_configuration,
1324
+ :workflows,
1325
+ :execution_role)
1314
1326
  SENSITIVE = []
1315
1327
  include Aws::Structure
1316
1328
  end
@@ -1505,6 +1517,15 @@ module Aws::Imagebuilder
1505
1517
  # Contains settings for vulnerability scans.
1506
1518
  # @return [Types::ImageScanningConfiguration]
1507
1519
  #
1520
+ # @!attribute [rw] workflows
1521
+ # Contains an array of workflow configuration objects.
1522
+ # @return [Array<Types::WorkflowConfiguration>]
1523
+ #
1524
+ # @!attribute [rw] execution_role
1525
+ # The name or Amazon Resource Name (ARN) for the IAM role you create
1526
+ # that grants Image Builder access to perform workflow actions.
1527
+ # @return [String]
1528
+ #
1508
1529
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageRequest AWS API Documentation
1509
1530
  #
1510
1531
  class CreateImageRequest < Struct.new(
@@ -1516,7 +1537,9 @@ module Aws::Imagebuilder
1516
1537
  :enhanced_image_metadata_enabled,
1517
1538
  :tags,
1518
1539
  :client_token,
1519
- :image_scanning_configuration)
1540
+ :image_scanning_configuration,
1541
+ :workflows,
1542
+ :execution_role)
1520
1543
  SENSITIVE = []
1521
1544
  include Aws::Structure
1522
1545
  end
@@ -1684,8 +1707,8 @@ module Aws::Imagebuilder
1684
1707
  # @return [String]
1685
1708
  #
1686
1709
  # @!attribute [rw] execution_role
1687
- # The role name or Amazon Resource Name (ARN) for the IAM role that
1688
- # grants Image Builder access to run lifecycle actions.
1710
+ # The name or Amazon Resource Name (ARN) for the IAM role you create
1711
+ # that grants Image Builder access to run lifecycle actions.
1689
1712
  # @return [String]
1690
1713
  #
1691
1714
  # @!attribute [rw] resource_type
@@ -1753,6 +1776,119 @@ module Aws::Imagebuilder
1753
1776
  include Aws::Structure
1754
1777
  end
1755
1778
 
1779
+ # @!attribute [rw] name
1780
+ # The name of the workflow to create.
1781
+ # @return [String]
1782
+ #
1783
+ # @!attribute [rw] semantic_version
1784
+ # The semantic version of this workflow resource. The semantic version
1785
+ # syntax adheres to the following rules.
1786
+ #
1787
+ # <note markdown="1"> The semantic version has four nodes:
1788
+ # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
1789
+ # assign values for the first three, and can filter on all of them.
1790
+ #
1791
+ # **Assignment:** For the first three nodes you can assign any
1792
+ # positive integer value, including zero, with an upper limit of
1793
+ # 2^30-1, or 1073741823 for each node. Image Builder automatically
1794
+ # assigns the build number to the fourth node.
1795
+ #
1796
+ # **Patterns:** You can use any numeric pattern that adheres to the
1797
+ # assignment requirements for the nodes that you can assign. For
1798
+ # example, you might choose a software version pattern, such as 1.0.0,
1799
+ # or a date, such as 2021.01.01.
1800
+ #
1801
+ # </note>
1802
+ # @return [String]
1803
+ #
1804
+ # @!attribute [rw] description
1805
+ # Describes the workflow.
1806
+ # @return [String]
1807
+ #
1808
+ # @!attribute [rw] change_description
1809
+ # Describes what change has been made in this version of the workflow,
1810
+ # or what makes this version different from other versions of the
1811
+ # workflow.
1812
+ # @return [String]
1813
+ #
1814
+ # @!attribute [rw] data
1815
+ # Contains the UTF-8 encoded YAML document content for the workflow.
1816
+ # Alternatively, you can specify the `uri` of a YAML document file
1817
+ # stored in Amazon S3. However, you cannot specify both properties.
1818
+ # @return [String]
1819
+ #
1820
+ # @!attribute [rw] uri
1821
+ # The `uri` of a YAML component document file. This must be an S3 URL
1822
+ # (`s3://bucket/key`), and the requester must have permission to
1823
+ # access the S3 bucket it points to. If you use Amazon S3, you can
1824
+ # specify component content up to your service quota.
1825
+ #
1826
+ # Alternatively, you can specify the YAML document inline, using the
1827
+ # component `data` property. You cannot specify both properties.
1828
+ # @return [String]
1829
+ #
1830
+ # @!attribute [rw] kms_key_id
1831
+ # The ID of the KMS key that is used to encrypt this workflow
1832
+ # resource.
1833
+ # @return [String]
1834
+ #
1835
+ # @!attribute [rw] tags
1836
+ # Tags that apply to the workflow resource.
1837
+ # @return [Hash<String,String>]
1838
+ #
1839
+ # @!attribute [rw] client_token
1840
+ # Unique, case-sensitive identifier you provide to ensure idempotency
1841
+ # of the request. For more information, see [Ensuring idempotency][1]
1842
+ # in the *Amazon EC2 API Reference*.
1843
+ #
1844
+ # **A suitable default value is auto-generated.** You should normally
1845
+ # not need to pass this option.
1846
+ #
1847
+ #
1848
+ #
1849
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
1850
+ # @return [String]
1851
+ #
1852
+ # @!attribute [rw] type
1853
+ # The phase in the image build process for which the workflow resource
1854
+ # is responsible.
1855
+ # @return [String]
1856
+ #
1857
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateWorkflowRequest AWS API Documentation
1858
+ #
1859
+ class CreateWorkflowRequest < Struct.new(
1860
+ :name,
1861
+ :semantic_version,
1862
+ :description,
1863
+ :change_description,
1864
+ :data,
1865
+ :uri,
1866
+ :kms_key_id,
1867
+ :tags,
1868
+ :client_token,
1869
+ :type)
1870
+ SENSITIVE = []
1871
+ include Aws::Structure
1872
+ end
1873
+
1874
+ # @!attribute [rw] client_token
1875
+ # The client token that uniquely identifies the request.
1876
+ # @return [String]
1877
+ #
1878
+ # @!attribute [rw] workflow_build_version_arn
1879
+ # The Amazon Resource Name (ARN) of the workflow resource that the
1880
+ # request created.
1881
+ # @return [String]
1882
+ #
1883
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateWorkflowResponse AWS API Documentation
1884
+ #
1885
+ class CreateWorkflowResponse < Struct.new(
1886
+ :client_token,
1887
+ :workflow_build_version_arn)
1888
+ SENSITIVE = []
1889
+ include Aws::Structure
1890
+ end
1891
+
1756
1892
  # Amazon Inspector generates a risk score for each finding. This score
1757
1893
  # helps you to prioritize findings, to focus on the most critical
1758
1894
  # findings and the most vulnerable resources. The score uses the Common
@@ -2091,6 +2227,30 @@ module Aws::Imagebuilder
2091
2227
  include Aws::Structure
2092
2228
  end
2093
2229
 
2230
+ # @!attribute [rw] workflow_build_version_arn
2231
+ # The Amazon Resource Name (ARN) of the workflow resource to delete.
2232
+ # @return [String]
2233
+ #
2234
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteWorkflowRequest AWS API Documentation
2235
+ #
2236
+ class DeleteWorkflowRequest < Struct.new(
2237
+ :workflow_build_version_arn)
2238
+ SENSITIVE = []
2239
+ include Aws::Structure
2240
+ end
2241
+
2242
+ # @!attribute [rw] workflow_build_version_arn
2243
+ # The ARN of the workflow resource that this request deleted.
2244
+ # @return [String]
2245
+ #
2246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteWorkflowResponse AWS API Documentation
2247
+ #
2248
+ class DeleteWorkflowResponse < Struct.new(
2249
+ :workflow_build_version_arn)
2250
+ SENSITIVE = []
2251
+ include Aws::Structure
2252
+ end
2253
+
2094
2254
  # Defines the settings for a specific Region.
2095
2255
  #
2096
2256
  # @!attribute [rw] region
@@ -2486,7 +2646,7 @@ module Aws::Imagebuilder
2486
2646
  # @return [String]
2487
2647
  #
2488
2648
  # @!attribute [rw] component
2489
- # The component object associated with the specified ARN.
2649
+ # The component object specified in the request.
2490
2650
  # @return [Types::Component]
2491
2651
  #
2492
2652
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetComponentResponse AWS API Documentation
@@ -2900,6 +3060,11 @@ module Aws::Imagebuilder
2900
3060
  # finished.
2901
3061
  # @return [String]
2902
3062
  #
3063
+ # @!attribute [rw] parallel_group
3064
+ # Test workflows are defined within named runtime groups. The parallel
3065
+ # group is a named group that contains one or more test workflows.
3066
+ # @return [String]
3067
+ #
2903
3068
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetWorkflowExecutionResponse AWS API Documentation
2904
3069
  #
2905
3070
  class GetWorkflowExecutionResponse < Struct.new(
@@ -2915,7 +3080,33 @@ module Aws::Imagebuilder
2915
3080
  :total_steps_failed,
2916
3081
  :total_steps_skipped,
2917
3082
  :start_time,
2918
- :end_time)
3083
+ :end_time,
3084
+ :parallel_group)
3085
+ SENSITIVE = []
3086
+ include Aws::Structure
3087
+ end
3088
+
3089
+ # @!attribute [rw] workflow_build_version_arn
3090
+ # The Amazon Resource Name (ARN) of the workflow resource that you
3091
+ # want to get.
3092
+ # @return [String]
3093
+ #
3094
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetWorkflowRequest AWS API Documentation
3095
+ #
3096
+ class GetWorkflowRequest < Struct.new(
3097
+ :workflow_build_version_arn)
3098
+ SENSITIVE = []
3099
+ include Aws::Structure
3100
+ end
3101
+
3102
+ # @!attribute [rw] workflow
3103
+ # The workflow resource specified in the request.
3104
+ # @return [Types::Workflow]
3105
+ #
3106
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetWorkflowResponse AWS API Documentation
3107
+ #
3108
+ class GetWorkflowResponse < Struct.new(
3109
+ :workflow)
2919
3110
  SENSITIVE = []
2920
3111
  include Aws::Structure
2921
3112
  end
@@ -3213,6 +3404,16 @@ module Aws::Imagebuilder
3213
3404
  # action on the image.
3214
3405
  # @return [String]
3215
3406
  #
3407
+ # @!attribute [rw] execution_role
3408
+ # The name or Amazon Resource Name (ARN) for the IAM role you create
3409
+ # that grants Image Builder access to perform workflow actions.
3410
+ # @return [String]
3411
+ #
3412
+ # @!attribute [rw] workflows
3413
+ # Contains the build and test workflows that are associated with the
3414
+ # image.
3415
+ # @return [Array<Types::WorkflowConfiguration>]
3416
+ #
3216
3417
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Image AWS API Documentation
3217
3418
  #
3218
3419
  class Image < Struct.new(
@@ -3239,7 +3440,9 @@ module Aws::Imagebuilder
3239
3440
  :scan_state,
3240
3441
  :image_scanning_configuration,
3241
3442
  :deprecation_time,
3242
- :lifecycle_execution_id)
3443
+ :lifecycle_execution_id,
3444
+ :execution_role,
3445
+ :workflows)
3243
3446
  SENSITIVE = []
3244
3447
  include Aws::Structure
3245
3448
  end
@@ -3368,6 +3571,15 @@ module Aws::Imagebuilder
3368
3571
  # Contains settings for vulnerability scans.
3369
3572
  # @return [Types::ImageScanningConfiguration]
3370
3573
  #
3574
+ # @!attribute [rw] execution_role
3575
+ # The name or Amazon Resource Name (ARN) for the IAM role you create
3576
+ # that grants Image Builder access to perform workflow actions.
3577
+ # @return [String]
3578
+ #
3579
+ # @!attribute [rw] workflows
3580
+ # Contains the workflows that run for the image pipeline.
3581
+ # @return [Array<Types::WorkflowConfiguration>]
3582
+ #
3371
3583
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImagePipeline AWS API Documentation
3372
3584
  #
3373
3585
  class ImagePipeline < Struct.new(
@@ -3388,7 +3600,9 @@ module Aws::Imagebuilder
3388
3600
  :date_last_run,
3389
3601
  :date_next_run,
3390
3602
  :tags,
3391
- :image_scanning_configuration)
3603
+ :image_scanning_configuration,
3604
+ :execution_role,
3605
+ :workflows)
3392
3606
  SENSITIVE = []
3393
3607
  include Aws::Structure
3394
3608
  end
@@ -4018,7 +4232,7 @@ module Aws::Imagebuilder
4018
4232
  # @!attribute [rw] change_description
4019
4233
  # The change description of the component. This description indicates
4020
4234
  # the change that has been made in this version, or what makes this
4021
- # version different from other versions of this component.
4235
+ # version different from other versions of the component.
4022
4236
  # @return [String]
4023
4237
  #
4024
4238
  # @!attribute [rw] type
@@ -4849,8 +5063,9 @@ module Aws::Imagebuilder
4849
5063
  # @return [String]
4850
5064
  #
4851
5065
  # @!attribute [rw] execution_role
4852
- # The name of the IAM role that Image Builder uses to run the
4853
- # lifecycle policy. This is a custom role that you create.
5066
+ # The name or Amazon Resource Name (ARN) of the IAM role that Image
5067
+ # Builder uses to run the lifecycle policy. This is a custom role that
5068
+ # you create.
4854
5069
  # @return [String]
4855
5070
  #
4856
5071
  # @!attribute [rw] resource_type
@@ -4981,7 +5196,7 @@ module Aws::Imagebuilder
4981
5196
  #
4982
5197
  # @!attribute [rw] tag_map
4983
5198
  # Contains a list of tags that Image Builder uses to skip lifecycle
4984
- # actions for AMIs that have them.
5199
+ # actions for resources that have them.
4985
5200
  # @return [Hash<String,String>]
4986
5201
  #
4987
5202
  # @!attribute [rw] amis
@@ -5006,18 +5221,18 @@ module Aws::Imagebuilder
5006
5221
  # @return [Boolean]
5007
5222
  #
5008
5223
  # @!attribute [rw] regions
5009
- # Specifies Amazon Web Services accounts whose resources are excluded
5010
- # from the lifecycle action.
5224
+ # Configures Amazon Web Services Regions that are excluded from the
5225
+ # lifecycle action.
5011
5226
  # @return [Array<String>]
5012
5227
  #
5013
5228
  # @!attribute [rw] shared_accounts
5014
- # Specifies configuration details for Image Builder to exclude the
5015
- # most recent resources from lifecycle actions.
5229
+ # Specifies Amazon Web Services accounts whose resources are excluded
5230
+ # from the lifecycle action.
5016
5231
  # @return [Array<String>]
5017
5232
  #
5018
5233
  # @!attribute [rw] last_launched
5019
- # Configures Amazon Web Services Regions that are excluded from the
5020
- # lifecycle action.
5234
+ # Specifies configuration details for Image Builder to exclude the
5235
+ # most recent resources from lifecycle actions.
5021
5236
  # @return [Types::LifecyclePolicyDetailExclusionRulesAmisLastLaunched]
5022
5237
  #
5023
5238
  # @!attribute [rw] tag_map
@@ -5165,8 +5380,8 @@ module Aws::Imagebuilder
5165
5380
  # @return [String]
5166
5381
  #
5167
5382
  # @!attribute [rw] execution_role
5168
- # The name of the IAM role that Image Builder uses to run the
5169
- # lifecycle policy.
5383
+ # The name or Amazon Resource Name (ARN) of the IAM role that Image
5384
+ # Builder uses to run the lifecycle policy.
5170
5385
  # @return [String]
5171
5386
  #
5172
5387
  # @!attribute [rw] resource_type
@@ -6193,6 +6408,90 @@ module Aws::Imagebuilder
6193
6408
  include Aws::Structure
6194
6409
  end
6195
6410
 
6411
+ # @!attribute [rw] max_results
6412
+ # The maximum items to return in a request.
6413
+ # @return [Integer]
6414
+ #
6415
+ # @!attribute [rw] next_token
6416
+ # A token to specify where to start paginating. This is the nextToken
6417
+ # from a previously truncated response.
6418
+ # @return [String]
6419
+ #
6420
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListWaitingWorkflowStepsRequest AWS API Documentation
6421
+ #
6422
+ class ListWaitingWorkflowStepsRequest < Struct.new(
6423
+ :max_results,
6424
+ :next_token)
6425
+ SENSITIVE = []
6426
+ include Aws::Structure
6427
+ end
6428
+
6429
+ # @!attribute [rw] steps
6430
+ # An array of the workflow steps that are waiting for action in your
6431
+ # Amazon Web Services account.
6432
+ # @return [Array<Types::WorkflowStepExecution>]
6433
+ #
6434
+ # @!attribute [rw] next_token
6435
+ # The next token used for paginated responses. When this field isn't
6436
+ # empty, there are additional elements that the service hasn't
6437
+ # included in this request. Use this token with the next request to
6438
+ # retrieve additional objects.
6439
+ # @return [String]
6440
+ #
6441
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListWaitingWorkflowStepsResponse AWS API Documentation
6442
+ #
6443
+ class ListWaitingWorkflowStepsResponse < Struct.new(
6444
+ :steps,
6445
+ :next_token)
6446
+ SENSITIVE = []
6447
+ include Aws::Structure
6448
+ end
6449
+
6450
+ # @!attribute [rw] workflow_version_arn
6451
+ # The Amazon Resource Name (ARN) of the workflow resource for which to
6452
+ # get a list of build versions.
6453
+ # @return [String]
6454
+ #
6455
+ # @!attribute [rw] max_results
6456
+ # The maximum items to return in a request.
6457
+ # @return [Integer]
6458
+ #
6459
+ # @!attribute [rw] next_token
6460
+ # A token to specify where to start paginating. This is the nextToken
6461
+ # from a previously truncated response.
6462
+ # @return [String]
6463
+ #
6464
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListWorkflowBuildVersionsRequest AWS API Documentation
6465
+ #
6466
+ class ListWorkflowBuildVersionsRequest < Struct.new(
6467
+ :workflow_version_arn,
6468
+ :max_results,
6469
+ :next_token)
6470
+ SENSITIVE = []
6471
+ include Aws::Structure
6472
+ end
6473
+
6474
+ # @!attribute [rw] workflow_summary_list
6475
+ # A list that contains metadata for the workflow builds that have run
6476
+ # for the workflow resource specified in the request.
6477
+ # @return [Array<Types::WorkflowSummary>]
6478
+ #
6479
+ # @!attribute [rw] next_token
6480
+ # The next token used for paginated responses. When this field isn't
6481
+ # empty, there are additional elements that the service hasn't
6482
+ # included in this request. Use this token with the next request to
6483
+ # retrieve additional objects.
6484
+ # @return [String]
6485
+ #
6486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListWorkflowBuildVersionsResponse AWS API Documentation
6487
+ #
6488
+ class ListWorkflowBuildVersionsResponse < Struct.new(
6489
+ :workflow_summary_list,
6490
+ :next_token)
6491
+ SENSITIVE = []
6492
+ include Aws::Structure
6493
+ end
6494
+
6196
6495
  # @!attribute [rw] max_results
6197
6496
  # The maximum items to return in a request.
6198
6497
  # @return [Integer]
@@ -6327,21 +6626,75 @@ module Aws::Imagebuilder
6327
6626
  include Aws::Structure
6328
6627
  end
6329
6628
 
6330
- # Logging configuration defines where Image Builder uploads your logs.
6629
+ # @!attribute [rw] owner
6630
+ # Used to get a list of workflow build version filtered by the
6631
+ # identity of the creator.
6632
+ # @return [String]
6331
6633
  #
6332
- # @!attribute [rw] s3_logs
6333
- # The Amazon S3 logging configuration.
6334
- # @return [Types::S3Logs]
6634
+ # @!attribute [rw] filters
6635
+ # Used to streamline search results.
6636
+ # @return [Array<Types::Filter>]
6335
6637
  #
6336
- # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Logging AWS API Documentation
6638
+ # @!attribute [rw] by_name
6639
+ # Specify all or part of the workflow name to streamline results.
6640
+ # @return [Boolean]
6337
6641
  #
6338
- class Logging < Struct.new(
6339
- :s3_logs)
6642
+ # @!attribute [rw] max_results
6643
+ # The maximum items to return in a request.
6644
+ # @return [Integer]
6645
+ #
6646
+ # @!attribute [rw] next_token
6647
+ # A token to specify where to start paginating. This is the nextToken
6648
+ # from a previously truncated response.
6649
+ # @return [String]
6650
+ #
6651
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListWorkflowsRequest AWS API Documentation
6652
+ #
6653
+ class ListWorkflowsRequest < Struct.new(
6654
+ :owner,
6655
+ :filters,
6656
+ :by_name,
6657
+ :max_results,
6658
+ :next_token)
6340
6659
  SENSITIVE = []
6341
6660
  include Aws::Structure
6342
6661
  end
6343
6662
 
6344
- # The resources produced by this image.
6663
+ # @!attribute [rw] workflow_version_list
6664
+ # A list of workflow build versions that match the request criteria.
6665
+ # @return [Array<Types::WorkflowVersion>]
6666
+ #
6667
+ # @!attribute [rw] next_token
6668
+ # The next token used for paginated responses. When this field isn't
6669
+ # empty, there are additional elements that the service hasn't
6670
+ # included in this request. Use this token with the next request to
6671
+ # retrieve additional objects.
6672
+ # @return [String]
6673
+ #
6674
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListWorkflowsResponse AWS API Documentation
6675
+ #
6676
+ class ListWorkflowsResponse < Struct.new(
6677
+ :workflow_version_list,
6678
+ :next_token)
6679
+ SENSITIVE = []
6680
+ include Aws::Structure
6681
+ end
6682
+
6683
+ # Logging configuration defines where Image Builder uploads your logs.
6684
+ #
6685
+ # @!attribute [rw] s3_logs
6686
+ # The Amazon S3 logging configuration.
6687
+ # @return [Types::S3Logs]
6688
+ #
6689
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Logging AWS API Documentation
6690
+ #
6691
+ class Logging < Struct.new(
6692
+ :s3_logs)
6693
+ SENSITIVE = []
6694
+ include Aws::Structure
6695
+ end
6696
+
6697
+ # The resources produced by this image.
6345
6698
  #
6346
6699
  # @!attribute [rw] amis
6347
6700
  # The Amazon EC2 AMIs created by this image.
@@ -6778,7 +7131,7 @@ module Aws::Imagebuilder
6778
7131
  include Aws::Structure
6779
7132
  end
6780
7133
 
6781
- # A schedule configures how often and when a pipeline will automatically
7134
+ # A schedule configures when and how often a pipeline will automatically
6782
7135
  # create a new image.
6783
7136
  #
6784
7137
  # @!attribute [rw] schedule_expression
@@ -6831,6 +7184,72 @@ module Aws::Imagebuilder
6831
7184
  include Aws::Structure
6832
7185
  end
6833
7186
 
7187
+ # @!attribute [rw] step_execution_id
7188
+ # Uniquely identifies the workflow step that sent the step action.
7189
+ # @return [String]
7190
+ #
7191
+ # @!attribute [rw] image_build_version_arn
7192
+ # The Amazon Resource Name (ARN) of the image build version to send
7193
+ # action for.
7194
+ # @return [String]
7195
+ #
7196
+ # @!attribute [rw] action
7197
+ # The action for the image creation process to take while a workflow
7198
+ # `WaitForAction` step waits for an asynchronous action to complete.
7199
+ # @return [String]
7200
+ #
7201
+ # @!attribute [rw] reason
7202
+ # The reason why this action is sent.
7203
+ # @return [String]
7204
+ #
7205
+ # @!attribute [rw] client_token
7206
+ # Unique, case-sensitive identifier you provide to ensure idempotency
7207
+ # of the request. For more information, see [Ensuring idempotency][1]
7208
+ # in the *Amazon EC2 API Reference*.
7209
+ #
7210
+ # **A suitable default value is auto-generated.** You should normally
7211
+ # not need to pass this option.
7212
+ #
7213
+ #
7214
+ #
7215
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
7216
+ # @return [String]
7217
+ #
7218
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/SendWorkflowStepActionRequest AWS API Documentation
7219
+ #
7220
+ class SendWorkflowStepActionRequest < Struct.new(
7221
+ :step_execution_id,
7222
+ :image_build_version_arn,
7223
+ :action,
7224
+ :reason,
7225
+ :client_token)
7226
+ SENSITIVE = []
7227
+ include Aws::Structure
7228
+ end
7229
+
7230
+ # @!attribute [rw] step_execution_id
7231
+ # The workflow step that sent the step action.
7232
+ # @return [String]
7233
+ #
7234
+ # @!attribute [rw] image_build_version_arn
7235
+ # The Amazon Resource Name (ARN) of the image build version that
7236
+ # received the action request.
7237
+ # @return [String]
7238
+ #
7239
+ # @!attribute [rw] client_token
7240
+ # The client token that uniquely identifies the request.
7241
+ # @return [String]
7242
+ #
7243
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/SendWorkflowStepActionResponse AWS API Documentation
7244
+ #
7245
+ class SendWorkflowStepActionResponse < Struct.new(
7246
+ :step_execution_id,
7247
+ :image_build_version_arn,
7248
+ :client_token)
7249
+ SENSITIVE = []
7250
+ include Aws::Structure
7251
+ end
7252
+
6834
7253
  # This exception is thrown when the service encounters an unrecoverable
6835
7254
  # exception.
6836
7255
  #
@@ -7241,6 +7660,15 @@ module Aws::Imagebuilder
7241
7660
  # Contains settings for vulnerability scans.
7242
7661
  # @return [Types::ImageScanningConfiguration]
7243
7662
  #
7663
+ # @!attribute [rw] workflows
7664
+ # Contains the workflows to run for the pipeline.
7665
+ # @return [Array<Types::WorkflowConfiguration>]
7666
+ #
7667
+ # @!attribute [rw] execution_role
7668
+ # The name or Amazon Resource Name (ARN) for the IAM role you create
7669
+ # that grants Image Builder access to perform workflow actions.
7670
+ # @return [String]
7671
+ #
7244
7672
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/UpdateImagePipelineRequest AWS API Documentation
7245
7673
  #
7246
7674
  class UpdateImagePipelineRequest < Struct.new(
@@ -7255,7 +7683,9 @@ module Aws::Imagebuilder
7255
7683
  :schedule,
7256
7684
  :status,
7257
7685
  :client_token,
7258
- :image_scanning_configuration)
7686
+ :image_scanning_configuration,
7687
+ :workflows,
7688
+ :execution_role)
7259
7689
  SENSITIVE = []
7260
7690
  include Aws::Structure
7261
7691
  end
@@ -7432,8 +7862,8 @@ module Aws::Imagebuilder
7432
7862
  # @return [String]
7433
7863
  #
7434
7864
  # @!attribute [rw] execution_role
7435
- # The name of the IAM role that Image Builder should use to update the
7436
- # lifecycle policy.
7865
+ # The name or Amazon Resource Name (ARN) of the IAM role that Image
7866
+ # Builder uses to update the lifecycle policy.
7437
7867
  # @return [String]
7438
7868
  #
7439
7869
  # @!attribute [rw] resource_type
@@ -7572,6 +8002,124 @@ module Aws::Imagebuilder
7572
8002
  include Aws::Structure
7573
8003
  end
7574
8004
 
8005
+ # Defines a process that Image Builder uses to build and test images
8006
+ # during the image creation process.
8007
+ #
8008
+ # @!attribute [rw] arn
8009
+ # The Amazon Resource Name (ARN) of the workflow resource.
8010
+ # @return [String]
8011
+ #
8012
+ # @!attribute [rw] name
8013
+ # The name of the workflow resource.
8014
+ # @return [String]
8015
+ #
8016
+ # @!attribute [rw] version
8017
+ # The workflow resource version. Workflow resources are immutable. To
8018
+ # make a change, you can clone a workflow or create a new version.
8019
+ # @return [String]
8020
+ #
8021
+ # @!attribute [rw] description
8022
+ # The description of the workflow.
8023
+ # @return [String]
8024
+ #
8025
+ # @!attribute [rw] change_description
8026
+ # Describes what change has been made in this version of the workflow,
8027
+ # or what makes this version different from other versions of the
8028
+ # workflow.
8029
+ # @return [String]
8030
+ #
8031
+ # @!attribute [rw] type
8032
+ # Specifies the image creation stage that the workflow applies to.
8033
+ # Image Builder currently supports build and test workflows.
8034
+ # @return [String]
8035
+ #
8036
+ # @!attribute [rw] state
8037
+ # Describes the current status of the workflow and the reason for that
8038
+ # status.
8039
+ # @return [Types::WorkflowState]
8040
+ #
8041
+ # @!attribute [rw] owner
8042
+ # The owner of the workflow resource.
8043
+ # @return [String]
8044
+ #
8045
+ # @!attribute [rw] data
8046
+ # Contains the YAML document content for the workflow.
8047
+ # @return [String]
8048
+ #
8049
+ # @!attribute [rw] kms_key_id
8050
+ # The KMS key identifier used to encrypt the workflow resource.
8051
+ # @return [String]
8052
+ #
8053
+ # @!attribute [rw] date_created
8054
+ # The timestamp when Image Builder created the workflow resource.
8055
+ # @return [String]
8056
+ #
8057
+ # @!attribute [rw] tags
8058
+ # The tags that apply to the workflow resource
8059
+ # @return [Hash<String,String>]
8060
+ #
8061
+ # @!attribute [rw] parameters
8062
+ # An array of input parameters that that the image workflow uses to
8063
+ # control actions or configure settings.
8064
+ # @return [Array<Types::WorkflowParameterDetail>]
8065
+ #
8066
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Workflow AWS API Documentation
8067
+ #
8068
+ class Workflow < Struct.new(
8069
+ :arn,
8070
+ :name,
8071
+ :version,
8072
+ :description,
8073
+ :change_description,
8074
+ :type,
8075
+ :state,
8076
+ :owner,
8077
+ :data,
8078
+ :kms_key_id,
8079
+ :date_created,
8080
+ :tags,
8081
+ :parameters)
8082
+ SENSITIVE = []
8083
+ include Aws::Structure
8084
+ end
8085
+
8086
+ # Contains control settings and configurable inputs for a workflow
8087
+ # resource.
8088
+ #
8089
+ # @!attribute [rw] workflow_arn
8090
+ # The Amazon Resource Name (ARN) of the workflow resource.
8091
+ # @return [String]
8092
+ #
8093
+ # @!attribute [rw] parameters
8094
+ # Contains parameter values for each of the parameters that the
8095
+ # workflow document defined for the workflow resource.
8096
+ # @return [Array<Types::WorkflowParameter>]
8097
+ #
8098
+ # @!attribute [rw] parallel_group
8099
+ # Test workflows are defined within named runtime groups called
8100
+ # parallel groups. The parallel group is the named group that contains
8101
+ # this test workflow. Test workflows within a parallel group can run
8102
+ # at the same time. Image Builder starts up to five test workflows in
8103
+ # the group at the same time, and starts additional workflows as
8104
+ # others complete, until all workflows in the group have completed.
8105
+ # This field only applies for test workflows.
8106
+ # @return [String]
8107
+ #
8108
+ # @!attribute [rw] on_failure
8109
+ # The action to take if the workflow fails.
8110
+ # @return [String]
8111
+ #
8112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/WorkflowConfiguration AWS API Documentation
8113
+ #
8114
+ class WorkflowConfiguration < Struct.new(
8115
+ :workflow_arn,
8116
+ :parameters,
8117
+ :parallel_group,
8118
+ :on_failure)
8119
+ SENSITIVE = []
8120
+ include Aws::Structure
8121
+ end
8122
+
7575
8123
  # Metadata that includes details and status from this runtime instance
7576
8124
  # of the workflow.
7577
8125
  #
@@ -7626,6 +8174,11 @@ module Aws::Imagebuilder
7626
8174
  # The timestamp when this runtime instance of the workflow finished.
7627
8175
  # @return [String]
7628
8176
  #
8177
+ # @!attribute [rw] parallel_group
8178
+ # The name of the test group that included the test workflow resource
8179
+ # at runtime.
8180
+ # @return [String]
8181
+ #
7629
8182
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/WorkflowExecutionMetadata AWS API Documentation
7630
8183
  #
7631
8184
  class WorkflowExecutionMetadata < Struct.new(
@@ -7639,7 +8192,126 @@ module Aws::Imagebuilder
7639
8192
  :total_steps_failed,
7640
8193
  :total_steps_skipped,
7641
8194
  :start_time,
7642
- :end_time)
8195
+ :end_time,
8196
+ :parallel_group)
8197
+ SENSITIVE = []
8198
+ include Aws::Structure
8199
+ end
8200
+
8201
+ # Contains a key/value pair that sets the named workflow parameter.
8202
+ #
8203
+ # @!attribute [rw] name
8204
+ # The name of the workflow parameter to set.
8205
+ # @return [String]
8206
+ #
8207
+ # @!attribute [rw] value
8208
+ # Sets the value for the named workflow parameter.
8209
+ # @return [Array<String>]
8210
+ #
8211
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/WorkflowParameter AWS API Documentation
8212
+ #
8213
+ class WorkflowParameter < Struct.new(
8214
+ :name,
8215
+ :value)
8216
+ SENSITIVE = []
8217
+ include Aws::Structure
8218
+ end
8219
+
8220
+ # Defines a parameter that's used to provide configuration details for
8221
+ # the workflow.
8222
+ #
8223
+ # @!attribute [rw] name
8224
+ # The name of this input parameter.
8225
+ # @return [String]
8226
+ #
8227
+ # @!attribute [rw] type
8228
+ # The type of input this parameter provides. The currently supported
8229
+ # value is "string".
8230
+ # @return [String]
8231
+ #
8232
+ # @!attribute [rw] default_value
8233
+ # The default value of this parameter if no input is provided.
8234
+ # @return [Array<String>]
8235
+ #
8236
+ # @!attribute [rw] description
8237
+ # Describes this parameter.
8238
+ # @return [String]
8239
+ #
8240
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/WorkflowParameterDetail AWS API Documentation
8241
+ #
8242
+ class WorkflowParameterDetail < Struct.new(
8243
+ :name,
8244
+ :type,
8245
+ :default_value,
8246
+ :description)
8247
+ SENSITIVE = []
8248
+ include Aws::Structure
8249
+ end
8250
+
8251
+ # A group of fields that describe the current status of workflow.
8252
+ #
8253
+ # @!attribute [rw] status
8254
+ # The current state of the workflow.
8255
+ # @return [String]
8256
+ #
8257
+ # @!attribute [rw] reason
8258
+ # Describes how or why the workflow changed state.
8259
+ # @return [String]
8260
+ #
8261
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/WorkflowState AWS API Documentation
8262
+ #
8263
+ class WorkflowState < Struct.new(
8264
+ :status,
8265
+ :reason)
8266
+ SENSITIVE = []
8267
+ include Aws::Structure
8268
+ end
8269
+
8270
+ # Contains runtime details for an instance of a workflow that ran for
8271
+ # the associated image build version.
8272
+ #
8273
+ # @!attribute [rw] step_execution_id
8274
+ # Uniquely identifies the workflow step that ran for the associated
8275
+ # image build version.
8276
+ # @return [String]
8277
+ #
8278
+ # @!attribute [rw] image_build_version_arn
8279
+ # The Amazon Resource Name (ARN) of the image build version that ran
8280
+ # the workflow.
8281
+ # @return [String]
8282
+ #
8283
+ # @!attribute [rw] workflow_execution_id
8284
+ # Uniquely identifies the runtime instance of the workflow that
8285
+ # contains the workflow step that ran for the associated image build
8286
+ # version.
8287
+ # @return [String]
8288
+ #
8289
+ # @!attribute [rw] workflow_build_version_arn
8290
+ # The ARN of the workflow resource that ran.
8291
+ # @return [String]
8292
+ #
8293
+ # @!attribute [rw] name
8294
+ # The name of the workflow step.
8295
+ # @return [String]
8296
+ #
8297
+ # @!attribute [rw] action
8298
+ # The name of the step action.
8299
+ # @return [String]
8300
+ #
8301
+ # @!attribute [rw] start_time
8302
+ # The timestamp when the workflow step started.
8303
+ # @return [String]
8304
+ #
8305
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/WorkflowStepExecution AWS API Documentation
8306
+ #
8307
+ class WorkflowStepExecution < Struct.new(
8308
+ :step_execution_id,
8309
+ :image_build_version_arn,
8310
+ :workflow_execution_id,
8311
+ :workflow_build_version_arn,
8312
+ :name,
8313
+ :action,
8314
+ :start_time)
7643
8315
  SENSITIVE = []
7644
8316
  include Aws::Structure
7645
8317
  end
@@ -7709,5 +8381,112 @@ module Aws::Imagebuilder
7709
8381
  include Aws::Structure
7710
8382
  end
7711
8383
 
8384
+ # Contains metadata about the workflow resource.
8385
+ #
8386
+ # @!attribute [rw] arn
8387
+ # The Amazon Resource Name (ARN) of the workflow resource.
8388
+ # @return [String]
8389
+ #
8390
+ # @!attribute [rw] name
8391
+ # The name of the workflow.
8392
+ # @return [String]
8393
+ #
8394
+ # @!attribute [rw] version
8395
+ # The version of the workflow.
8396
+ # @return [String]
8397
+ #
8398
+ # @!attribute [rw] description
8399
+ # Describes the workflow.
8400
+ # @return [String]
8401
+ #
8402
+ # @!attribute [rw] change_description
8403
+ # The change description for the current version of the workflow
8404
+ # resource.
8405
+ # @return [String]
8406
+ #
8407
+ # @!attribute [rw] type
8408
+ # The image creation stage that this workflow applies to. Image
8409
+ # Builder currently supports build and test stage workflows.
8410
+ # @return [String]
8411
+ #
8412
+ # @!attribute [rw] owner
8413
+ # The owner of the workflow resource.
8414
+ # @return [String]
8415
+ #
8416
+ # @!attribute [rw] state
8417
+ # Describes the current state of the workflow resource.
8418
+ # @return [Types::WorkflowState]
8419
+ #
8420
+ # @!attribute [rw] date_created
8421
+ # The original creation date of the workflow resource.
8422
+ # @return [String]
8423
+ #
8424
+ # @!attribute [rw] tags
8425
+ # Contains a list of tags that are defined for the workflow.
8426
+ # @return [Hash<String,String>]
8427
+ #
8428
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/WorkflowSummary AWS API Documentation
8429
+ #
8430
+ class WorkflowSummary < Struct.new(
8431
+ :arn,
8432
+ :name,
8433
+ :version,
8434
+ :description,
8435
+ :change_description,
8436
+ :type,
8437
+ :owner,
8438
+ :state,
8439
+ :date_created,
8440
+ :tags)
8441
+ SENSITIVE = []
8442
+ include Aws::Structure
8443
+ end
8444
+
8445
+ # Contains details about this version of the workflow.
8446
+ #
8447
+ # @!attribute [rw] arn
8448
+ # The Amazon Resource Name (ARN) of the workflow resource.
8449
+ # @return [String]
8450
+ #
8451
+ # @!attribute [rw] name
8452
+ # The name of the workflow.
8453
+ # @return [String]
8454
+ #
8455
+ # @!attribute [rw] version
8456
+ # The semantic version of the workflow resource. The format includes
8457
+ # three nodes: &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;.
8458
+ # @return [String]
8459
+ #
8460
+ # @!attribute [rw] description
8461
+ # Describes the workflow.
8462
+ # @return [String]
8463
+ #
8464
+ # @!attribute [rw] type
8465
+ # The image creation stage that this workflow applies to. Image
8466
+ # Builder currently supports build and test stage workflows.
8467
+ # @return [String]
8468
+ #
8469
+ # @!attribute [rw] owner
8470
+ # The owner of the workflow resource.
8471
+ # @return [String]
8472
+ #
8473
+ # @!attribute [rw] date_created
8474
+ # The timestamp when Image Builder created the workflow version.
8475
+ # @return [String]
8476
+ #
8477
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/WorkflowVersion AWS API Documentation
8478
+ #
8479
+ class WorkflowVersion < Struct.new(
8480
+ :arn,
8481
+ :name,
8482
+ :version,
8483
+ :description,
8484
+ :type,
8485
+ :owner,
8486
+ :date_created)
8487
+ SENSITIVE = []
8488
+ include Aws::Structure
8489
+ end
8490
+
7712
8491
  end
7713
8492
  end