aws-sdk-codepipeline 1.77.0 → 1.78.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.
@@ -1262,6 +1262,20 @@ module Aws::CodePipeline
1262
1262
  include Aws::Structure
1263
1263
  end
1264
1264
 
1265
+ # The conditions for making checks for entry to a stage.
1266
+ #
1267
+ # @!attribute [rw] conditions
1268
+ # The conditions that are configured as entry conditions.
1269
+ # @return [Array<Types::Condition>]
1270
+ #
1271
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/BeforeEntryConditions AWS API Documentation
1272
+ #
1273
+ class BeforeEntryConditions < Struct.new(
1274
+ :conditions)
1275
+ SENSITIVE = []
1276
+ include Aws::Structure
1277
+ end
1278
+
1265
1279
  # Reserved for future use.
1266
1280
  #
1267
1281
  # @!attribute [rw] name
@@ -1307,6 +1321,83 @@ module Aws::CodePipeline
1307
1321
  include Aws::Structure
1308
1322
  end
1309
1323
 
1324
+ # The condition for the stage. A condition is made up of the rules and
1325
+ # the result for the condition.
1326
+ #
1327
+ # @!attribute [rw] result
1328
+ # The action to be done when the condition is met. For example,
1329
+ # rolling back an execution for a failure condition.
1330
+ # @return [String]
1331
+ #
1332
+ # @!attribute [rw] rules
1333
+ # The rules that make up the condition.
1334
+ # @return [Array<Types::RuleDeclaration>]
1335
+ #
1336
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/Condition AWS API Documentation
1337
+ #
1338
+ class Condition < Struct.new(
1339
+ :result,
1340
+ :rules)
1341
+ SENSITIVE = []
1342
+ include Aws::Structure
1343
+ end
1344
+
1345
+ # The run of a condition.
1346
+ #
1347
+ # @!attribute [rw] status
1348
+ # The status of the run for a condition.
1349
+ # @return [String]
1350
+ #
1351
+ # @!attribute [rw] summary
1352
+ # The summary of information about a run for a condition.
1353
+ # @return [String]
1354
+ #
1355
+ # @!attribute [rw] last_status_change
1356
+ # The last status change of the condition.
1357
+ # @return [Time]
1358
+ #
1359
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/ConditionExecution AWS API Documentation
1360
+ #
1361
+ class ConditionExecution < Struct.new(
1362
+ :status,
1363
+ :summary,
1364
+ :last_status_change)
1365
+ SENSITIVE = []
1366
+ include Aws::Structure
1367
+ end
1368
+
1369
+ # Unable to override because the condition does not allow overrides.
1370
+ #
1371
+ # @!attribute [rw] message
1372
+ # @return [String]
1373
+ #
1374
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/ConditionNotOverridableException AWS API Documentation
1375
+ #
1376
+ class ConditionNotOverridableException < Struct.new(
1377
+ :message)
1378
+ SENSITIVE = []
1379
+ include Aws::Structure
1380
+ end
1381
+
1382
+ # Information about the state of the condition.
1383
+ #
1384
+ # @!attribute [rw] latest_execution
1385
+ # The state of the latest run of the rule.
1386
+ # @return [Types::ConditionExecution]
1387
+ #
1388
+ # @!attribute [rw] rule_states
1389
+ # The state of the rules for the condition.
1390
+ # @return [Array<Types::RuleState>]
1391
+ #
1392
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/ConditionState AWS API Documentation
1393
+ #
1394
+ class ConditionState < Struct.new(
1395
+ :latest_execution,
1396
+ :rule_states)
1397
+ SENSITIVE = []
1398
+ include Aws::Structure
1399
+ end
1400
+
1310
1401
  # Your request cannot be handled because the pipeline is busy handling
1311
1402
  # ongoing activities. Try again later.
1312
1403
  #
@@ -1761,10 +1852,15 @@ module Aws::CodePipeline
1761
1852
  # as rolling back the stage.
1762
1853
  # @return [String]
1763
1854
  #
1855
+ # @!attribute [rw] conditions
1856
+ # The conditions that are configured as failure conditions.
1857
+ # @return [Array<Types::Condition>]
1858
+ #
1764
1859
  # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/FailureConditions AWS API Documentation
1765
1860
  #
1766
1861
  class FailureConditions < Struct.new(
1767
- :result)
1862
+ :result,
1863
+ :conditions)
1768
1864
  SENSITIVE = []
1769
1865
  include Aws::Structure
1770
1866
  end
@@ -2743,6 +2839,88 @@ module Aws::CodePipeline
2743
2839
  include Aws::Structure
2744
2840
  end
2745
2841
 
2842
+ # @!attribute [rw] pipeline_name
2843
+ # The name of the pipeline for which you want to get execution summary
2844
+ # information.
2845
+ # @return [String]
2846
+ #
2847
+ # @!attribute [rw] filter
2848
+ # Input information used to filter rule execution history.
2849
+ # @return [Types::RuleExecutionFilter]
2850
+ #
2851
+ # @!attribute [rw] max_results
2852
+ # The maximum number of results to return in a single call. To
2853
+ # retrieve the remaining results, make another call with the returned
2854
+ # nextToken value. Pipeline history is limited to the most recent 12
2855
+ # months, based on pipeline execution start times. Default value is
2856
+ # 100.
2857
+ # @return [Integer]
2858
+ #
2859
+ # @!attribute [rw] next_token
2860
+ # The token that was returned from the previous `ListRuleExecutions`
2861
+ # call, which can be used to return the next set of rule executions in
2862
+ # the list.
2863
+ # @return [String]
2864
+ #
2865
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/ListRuleExecutionsInput AWS API Documentation
2866
+ #
2867
+ class ListRuleExecutionsInput < Struct.new(
2868
+ :pipeline_name,
2869
+ :filter,
2870
+ :max_results,
2871
+ :next_token)
2872
+ SENSITIVE = []
2873
+ include Aws::Structure
2874
+ end
2875
+
2876
+ # @!attribute [rw] rule_execution_details
2877
+ # Details about the output for listing rule executions.
2878
+ # @return [Array<Types::RuleExecutionDetail>]
2879
+ #
2880
+ # @!attribute [rw] next_token
2881
+ # A token that can be used in the next `ListRuleExecutions` call. To
2882
+ # view all items in the list, continue to call this operation with
2883
+ # each subsequent token until no more nextToken values are returned.
2884
+ # @return [String]
2885
+ #
2886
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/ListRuleExecutionsOutput AWS API Documentation
2887
+ #
2888
+ class ListRuleExecutionsOutput < Struct.new(
2889
+ :rule_execution_details,
2890
+ :next_token)
2891
+ SENSITIVE = []
2892
+ include Aws::Structure
2893
+ end
2894
+
2895
+ # @!attribute [rw] rule_owner_filter
2896
+ # The rule owner to filter on.
2897
+ # @return [String]
2898
+ #
2899
+ # @!attribute [rw] region_filter
2900
+ # The rule Region to filter on.
2901
+ # @return [String]
2902
+ #
2903
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/ListRuleTypesInput AWS API Documentation
2904
+ #
2905
+ class ListRuleTypesInput < Struct.new(
2906
+ :rule_owner_filter,
2907
+ :region_filter)
2908
+ SENSITIVE = []
2909
+ include Aws::Structure
2910
+ end
2911
+
2912
+ # @!attribute [rw] rule_types
2913
+ # Lists the rules that are configured for the condition.
2914
+ # @return [Array<Types::RuleType>]
2915
+ #
2916
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/ListRuleTypesOutput AWS API Documentation
2917
+ #
2918
+ class ListRuleTypesOutput < Struct.new(
2919
+ :rule_types)
2920
+ SENSITIVE = []
2921
+ include Aws::Structure
2922
+ end
2923
+
2746
2924
  # @!attribute [rw] resource_arn
2747
2925
  # The Amazon Resource Name (ARN) of the resource to get tags for.
2748
2926
  # @return [String]
@@ -2922,6 +3100,35 @@ module Aws::CodePipeline
2922
3100
  include Aws::Structure
2923
3101
  end
2924
3102
 
3103
+ # @!attribute [rw] pipeline_name
3104
+ # The name of the pipeline with the stage that will override the
3105
+ # condition.
3106
+ # @return [String]
3107
+ #
3108
+ # @!attribute [rw] stage_name
3109
+ # The name of the stage for the override.
3110
+ # @return [String]
3111
+ #
3112
+ # @!attribute [rw] pipeline_execution_id
3113
+ # The ID of the pipeline execution for the override.
3114
+ # @return [String]
3115
+ #
3116
+ # @!attribute [rw] condition_type
3117
+ # The type of condition to override for the stage, such as entry
3118
+ # conditions, failure conditions, or success conditions.
3119
+ # @return [String]
3120
+ #
3121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/OverrideStageConditionInput AWS API Documentation
3122
+ #
3123
+ class OverrideStageConditionInput < Struct.new(
3124
+ :pipeline_name,
3125
+ :stage_name,
3126
+ :pipeline_execution_id,
3127
+ :condition_type)
3128
+ SENSITIVE = []
3129
+ include Aws::Structure
3130
+ end
3131
+
2925
3132
  # Represents information about a pipeline to a job worker.
2926
3133
  #
2927
3134
  # <note markdown="1"> PipelineContext contains `pipelineArn` and `pipelineExecutionId` for
@@ -4011,111 +4218,641 @@ module Aws::CodePipeline
4011
4218
  include Aws::Structure
4012
4219
  end
4013
4220
 
4014
- # The location of the S3 bucket that contains a revision.
4221
+ # Represents information about a rule configuration property.
4015
4222
  #
4016
- # @!attribute [rw] bucket_name
4017
- # The name of the S3 bucket.
4223
+ # @!attribute [rw] name
4224
+ # The name of the rule configuration property.
4018
4225
  # @return [String]
4019
4226
  #
4020
- # @!attribute [rw] object_key
4021
- # The key of the object in the S3 bucket, which uniquely identifies
4022
- # the object in the bucket.
4023
- # @return [String]
4227
+ # @!attribute [rw] required
4228
+ # Whether the configuration property is a required value.
4229
+ # @return [Boolean]
4024
4230
  #
4025
- # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/S3ArtifactLocation AWS API Documentation
4231
+ # @!attribute [rw] key
4232
+ # Whether the configuration property is a key.
4233
+ # @return [Boolean]
4026
4234
  #
4027
- class S3ArtifactLocation < Struct.new(
4028
- :bucket_name,
4029
- :object_key)
4030
- SENSITIVE = []
4031
- include Aws::Structure
4032
- end
4033
-
4034
- # The Amazon S3 artifact location for an action's artifacts.
4235
+ # @!attribute [rw] secret
4236
+ # Whether the configuration property is secret.
4035
4237
  #
4036
- # @!attribute [rw] bucket
4037
- # The Amazon S3 artifact bucket for an action's artifacts.
4238
+ # When updating a pipeline, passing * * * * * without changing
4239
+ # any other values of the action preserves the previous value of the
4240
+ # secret.
4241
+ # @return [Boolean]
4242
+ #
4243
+ # @!attribute [rw] queryable
4244
+ # Indicates whether the property can be queried.
4245
+ #
4246
+ # If you create a pipeline with a condition and rule, and that rule
4247
+ # contains a queryable property, the value for that configuration
4248
+ # property is subject to other restrictions. The value must be less
4249
+ # than or equal to twenty (20) characters. The value can contain only
4250
+ # alphanumeric characters, underscores, and hyphens.
4251
+ # @return [Boolean]
4252
+ #
4253
+ # @!attribute [rw] description
4254
+ # The description of the action configuration property that is
4255
+ # displayed to users.
4038
4256
  # @return [String]
4039
4257
  #
4040
- # @!attribute [rw] key
4041
- # The artifact name.
4258
+ # @!attribute [rw] type
4259
+ # The type of the configuration property.
4042
4260
  # @return [String]
4043
4261
  #
4044
- # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/S3Location AWS API Documentation
4262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/RuleConfigurationProperty AWS API Documentation
4045
4263
  #
4046
- class S3Location < Struct.new(
4047
- :bucket,
4048
- :key)
4264
+ class RuleConfigurationProperty < Struct.new(
4265
+ :name,
4266
+ :required,
4267
+ :key,
4268
+ :secret,
4269
+ :queryable,
4270
+ :description,
4271
+ :type)
4049
4272
  SENSITIVE = []
4050
4273
  include Aws::Structure
4051
4274
  end
4052
4275
 
4053
- # Information about the version (or revision) of a source artifact that
4054
- # initiated a pipeline execution.
4276
+ # Represents information about the rule to be created for an associated
4277
+ # condition. An example would be creating a new rule for an entry
4278
+ # condition, such as a rule that checks for a test result before
4279
+ # allowing the run to enter the deployment stage.
4055
4280
  #
4056
- # @!attribute [rw] action_name
4057
- # The name of the action that processed the revision to the source
4058
- # artifact.
4281
+ # @!attribute [rw] name
4282
+ # The name of the rule that is created for the condition, such as
4283
+ # CheckAllResults.
4059
4284
  # @return [String]
4060
4285
  #
4061
- # @!attribute [rw] revision_id
4062
- # The system-generated unique ID that identifies the revision number
4063
- # of the artifact.
4064
- # @return [String]
4286
+ # @!attribute [rw] rule_type_id
4287
+ # The ID for the rule type, which is made up of the combined values
4288
+ # for category, owner, provider, and version.
4289
+ # @return [Types::RuleTypeId]
4065
4290
  #
4066
- # @!attribute [rw] revision_summary
4067
- # Summary information about the most recent revision of the artifact.
4068
- # For GitHub and CodeCommit repositories, the commit message. For
4069
- # Amazon S3 buckets or actions, the user-provided content of a
4070
- # `codepipeline-artifact-revision-summary` key specified in the object
4071
- # metadata.
4291
+ # @!attribute [rw] configuration
4292
+ # The action configuration fields for the rule.
4293
+ # @return [Hash<String,String>]
4294
+ #
4295
+ # @!attribute [rw] input_artifacts
4296
+ # The input artifacts fields for the rule, such as specifying an input
4297
+ # file for the rule.
4298
+ # @return [Array<Types::InputArtifact>]
4299
+ #
4300
+ # @!attribute [rw] role_arn
4301
+ # The pipeline role ARN associated with the rule.
4072
4302
  # @return [String]
4073
4303
  #
4074
- # @!attribute [rw] revision_url
4075
- # The commit ID for the artifact revision. For artifacts stored in
4076
- # GitHub or CodeCommit repositories, the commit ID is linked to a
4077
- # commit details page.
4304
+ # @!attribute [rw] region
4305
+ # The Region for the condition associated with the rule.
4078
4306
  # @return [String]
4079
4307
  #
4080
- # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/SourceRevision AWS API Documentation
4308
+ # @!attribute [rw] timeout_in_minutes
4309
+ # The action timeout for the rule.
4310
+ # @return [Integer]
4081
4311
  #
4082
- class SourceRevision < Struct.new(
4083
- :action_name,
4084
- :revision_id,
4085
- :revision_summary,
4086
- :revision_url)
4312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/RuleDeclaration AWS API Documentation
4313
+ #
4314
+ class RuleDeclaration < Struct.new(
4315
+ :name,
4316
+ :rule_type_id,
4317
+ :configuration,
4318
+ :input_artifacts,
4319
+ :role_arn,
4320
+ :region,
4321
+ :timeout_in_minutes)
4087
4322
  SENSITIVE = []
4088
4323
  include Aws::Structure
4089
4324
  end
4090
4325
 
4091
- # A list that allows you to specify, or override, the source revision
4092
- # for a pipeline execution that's being started. A source revision is
4093
- # the version with all the changes to your application code, or source
4094
- # artifact, for the pipeline execution.
4326
+ # Represents information about each time a rule is run as part of the
4327
+ # pipeline execution for a pipeline configured with conditions.
4095
4328
  #
4096
- # <note markdown="1"> For the `S3_OBJECT_VERSION_ID` and `S3_OBJECT_KEY` types of source
4097
- # revisions, either of the types can be used independently, or they can
4098
- # be used together to override the source with a specific ObjectKey and
4099
- # VersionID.
4329
+ # @!attribute [rw] rule_execution_id
4330
+ # The execution ID for the run of the rule.
4331
+ # @return [String]
4100
4332
  #
4101
- # </note>
4333
+ # @!attribute [rw] status
4334
+ # The status of the run of the rule, such as FAILED.
4335
+ # @return [String]
4102
4336
  #
4103
- # @!attribute [rw] action_name
4104
- # The name of the action where the override will be applied.
4337
+ # @!attribute [rw] summary
4338
+ # A summary of the run of the rule.
4105
4339
  # @return [String]
4106
4340
  #
4107
- # @!attribute [rw] revision_type
4108
- # The type of source revision, based on the source provider. For
4109
- # example, the revision type for the CodeCommit action provider is the
4110
- # commit ID.
4341
+ # @!attribute [rw] last_status_change
4342
+ # The last status change of the rule.
4343
+ # @return [Time]
4344
+ #
4345
+ # @!attribute [rw] token
4346
+ # The system-generated token used to identify a unique request.
4111
4347
  # @return [String]
4112
4348
  #
4113
- # @!attribute [rw] revision_value
4114
- # The source revision, or version of your source artifact, with the
4115
- # changes that you want to run in the pipeline execution.
4349
+ # @!attribute [rw] last_updated_by
4350
+ # The ARN of the user who last changed the rule.
4116
4351
  # @return [String]
4117
4352
  #
4118
- # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/SourceRevisionOverride AWS API Documentation
4353
+ # @!attribute [rw] external_execution_id
4354
+ # The external ID of the run of the rule.
4355
+ # @return [String]
4356
+ #
4357
+ # @!attribute [rw] external_execution_url
4358
+ # The URL of a resource external to Amazon Web Services that is used
4359
+ # when running the rule (for example, an external repository URL).
4360
+ # @return [String]
4361
+ #
4362
+ # @!attribute [rw] error_details
4363
+ # Represents information about an error in CodePipeline.
4364
+ # @return [Types::ErrorDetails]
4365
+ #
4366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/RuleExecution AWS API Documentation
4367
+ #
4368
+ class RuleExecution < Struct.new(
4369
+ :rule_execution_id,
4370
+ :status,
4371
+ :summary,
4372
+ :last_status_change,
4373
+ :token,
4374
+ :last_updated_by,
4375
+ :external_execution_id,
4376
+ :external_execution_url,
4377
+ :error_details)
4378
+ SENSITIVE = []
4379
+ include Aws::Structure
4380
+ end
4381
+
4382
+ # The details of the runs for a rule and the results produced on an
4383
+ # artifact as it passes through stages in the pipeline.
4384
+ #
4385
+ # @!attribute [rw] pipeline_execution_id
4386
+ # The ID of the pipeline execution in the stage where the rule was
4387
+ # run. Use the GetPipelineState action to retrieve the current
4388
+ # pipelineExecutionId of the stage.
4389
+ # @return [String]
4390
+ #
4391
+ # @!attribute [rw] rule_execution_id
4392
+ # The ID of the run for the rule.
4393
+ # @return [String]
4394
+ #
4395
+ # @!attribute [rw] pipeline_version
4396
+ # The version number of the pipeline with the stage where the rule was
4397
+ # run.
4398
+ # @return [Integer]
4399
+ #
4400
+ # @!attribute [rw] stage_name
4401
+ # The name of the stage where the rule was run.
4402
+ # @return [String]
4403
+ #
4404
+ # @!attribute [rw] rule_name
4405
+ # The name of the rule that was run in the stage.
4406
+ # @return [String]
4407
+ #
4408
+ # @!attribute [rw] start_time
4409
+ # The start time of the rule execution.
4410
+ # @return [Time]
4411
+ #
4412
+ # @!attribute [rw] last_update_time
4413
+ # The date and time of the last change to the rule execution, in
4414
+ # timestamp format.
4415
+ # @return [Time]
4416
+ #
4417
+ # @!attribute [rw] updated_by
4418
+ # The ARN of the user who changed the rule execution details.
4419
+ # @return [String]
4420
+ #
4421
+ # @!attribute [rw] status
4422
+ # The status of the rule execution. Status categories are
4423
+ # `InProgress`, `Succeeded`, and `Failed`.
4424
+ # @return [String]
4425
+ #
4426
+ # @!attribute [rw] input
4427
+ # Input details for the rule execution, such as role ARN, Region, and
4428
+ # input artifacts.
4429
+ # @return [Types::RuleExecutionInput]
4430
+ #
4431
+ # @!attribute [rw] output
4432
+ # Output details for the rule execution, such as the rule execution
4433
+ # result.
4434
+ # @return [Types::RuleExecutionOutput]
4435
+ #
4436
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/RuleExecutionDetail AWS API Documentation
4437
+ #
4438
+ class RuleExecutionDetail < Struct.new(
4439
+ :pipeline_execution_id,
4440
+ :rule_execution_id,
4441
+ :pipeline_version,
4442
+ :stage_name,
4443
+ :rule_name,
4444
+ :start_time,
4445
+ :last_update_time,
4446
+ :updated_by,
4447
+ :status,
4448
+ :input,
4449
+ :output)
4450
+ SENSITIVE = []
4451
+ include Aws::Structure
4452
+ end
4453
+
4454
+ # Filter values for the rule execution.
4455
+ #
4456
+ # @!attribute [rw] pipeline_execution_id
4457
+ # The pipeline execution ID used to filter rule execution history.
4458
+ # @return [String]
4459
+ #
4460
+ # @!attribute [rw] latest_in_pipeline_execution
4461
+ # The field that specifies to filter on the latest execution in the
4462
+ # pipeline.
4463
+ #
4464
+ # <note markdown="1"> Filtering on the latest execution is available for executions run on
4465
+ # or after February 08, 2024.
4466
+ #
4467
+ # </note>
4468
+ # @return [Types::LatestInPipelineExecutionFilter]
4469
+ #
4470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/RuleExecutionFilter AWS API Documentation
4471
+ #
4472
+ class RuleExecutionFilter < Struct.new(
4473
+ :pipeline_execution_id,
4474
+ :latest_in_pipeline_execution)
4475
+ SENSITIVE = []
4476
+ include Aws::Structure
4477
+ end
4478
+
4479
+ # Input information used for a rule execution.
4480
+ #
4481
+ # @!attribute [rw] rule_type_id
4482
+ # The ID for the rule type, which is made up of the combined values
4483
+ # for category, owner, provider, and version.
4484
+ # @return [Types::RuleTypeId]
4485
+ #
4486
+ # @!attribute [rw] configuration
4487
+ # Configuration data for a rule execution, such as the resolved values
4488
+ # for that run.
4489
+ # @return [Hash<String,String>]
4490
+ #
4491
+ # @!attribute [rw] resolved_configuration
4492
+ # Configuration data for a rule execution with all variable references
4493
+ # replaced with their real values for the execution.
4494
+ # @return [Hash<String,String>]
4495
+ #
4496
+ # @!attribute [rw] role_arn
4497
+ # The ARN of the IAM service role that performs the declared rule.
4498
+ # This is assumed through the roleArn for the pipeline.
4499
+ # @return [String]
4500
+ #
4501
+ # @!attribute [rw] region
4502
+ # The Amazon Web Services Region for the rule, such as us-east-1.
4503
+ # @return [String]
4504
+ #
4505
+ # @!attribute [rw] input_artifacts
4506
+ # Details of input artifacts of the rule that correspond to the rule
4507
+ # execution.
4508
+ # @return [Array<Types::ArtifactDetail>]
4509
+ #
4510
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/RuleExecutionInput AWS API Documentation
4511
+ #
4512
+ class RuleExecutionInput < Struct.new(
4513
+ :rule_type_id,
4514
+ :configuration,
4515
+ :resolved_configuration,
4516
+ :role_arn,
4517
+ :region,
4518
+ :input_artifacts)
4519
+ SENSITIVE = []
4520
+ include Aws::Structure
4521
+ end
4522
+
4523
+ # Output details listed for a rule execution, such as the rule execution
4524
+ # result.
4525
+ #
4526
+ # @!attribute [rw] execution_result
4527
+ # Execution result information listed in the output details for a rule
4528
+ # execution.
4529
+ # @return [Types::RuleExecutionResult]
4530
+ #
4531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/RuleExecutionOutput AWS API Documentation
4532
+ #
4533
+ class RuleExecutionOutput < Struct.new(
4534
+ :execution_result)
4535
+ SENSITIVE = []
4536
+ include Aws::Structure
4537
+ end
4538
+
4539
+ # Execution result information, such as the external execution ID.
4540
+ #
4541
+ # @!attribute [rw] external_execution_id
4542
+ # The external ID for the rule execution.
4543
+ # @return [String]
4544
+ #
4545
+ # @!attribute [rw] external_execution_summary
4546
+ # The external provider summary for the rule execution.
4547
+ # @return [String]
4548
+ #
4549
+ # @!attribute [rw] external_execution_url
4550
+ # The deepest external link to the external resource (for example, a
4551
+ # repository URL or deployment endpoint) that is used when running the
4552
+ # rule.
4553
+ # @return [String]
4554
+ #
4555
+ # @!attribute [rw] error_details
4556
+ # Represents information about an error in CodePipeline.
4557
+ # @return [Types::ErrorDetails]
4558
+ #
4559
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/RuleExecutionResult AWS API Documentation
4560
+ #
4561
+ class RuleExecutionResult < Struct.new(
4562
+ :external_execution_id,
4563
+ :external_execution_summary,
4564
+ :external_execution_url,
4565
+ :error_details)
4566
+ SENSITIVE = []
4567
+ include Aws::Structure
4568
+ end
4569
+
4570
+ # The change to a rule that creates a revision of the rule.
4571
+ #
4572
+ # @!attribute [rw] revision_id
4573
+ # The system-generated unique ID that identifies the revision number
4574
+ # of the rule.
4575
+ # @return [String]
4576
+ #
4577
+ # @!attribute [rw] revision_change_id
4578
+ # The unique identifier of the change that set the state to this
4579
+ # revision (for example, a deployment ID or timestamp).
4580
+ # @return [String]
4581
+ #
4582
+ # @!attribute [rw] created
4583
+ # The date and time when the most recent version of the rule was
4584
+ # created, in timestamp format.
4585
+ # @return [Time]
4586
+ #
4587
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/RuleRevision AWS API Documentation
4588
+ #
4589
+ class RuleRevision < Struct.new(
4590
+ :revision_id,
4591
+ :revision_change_id,
4592
+ :created)
4593
+ SENSITIVE = []
4594
+ include Aws::Structure
4595
+ end
4596
+
4597
+ # Returns information about the state of a rule.
4598
+ #
4599
+ # <note markdown="1"> Values returned in the `revisionId` field indicate the rule revision
4600
+ # information, such as the commit ID, for the current state.
4601
+ #
4602
+ # </note>
4603
+ #
4604
+ # @!attribute [rw] rule_name
4605
+ # The name of the rule.
4606
+ # @return [String]
4607
+ #
4608
+ # @!attribute [rw] current_revision
4609
+ # The ID of the current revision of the artifact successfully worked
4610
+ # on by the job.
4611
+ # @return [Types::RuleRevision]
4612
+ #
4613
+ # @!attribute [rw] latest_execution
4614
+ # Represents information about the latest run of an rule.
4615
+ # @return [Types::RuleExecution]
4616
+ #
4617
+ # @!attribute [rw] entity_url
4618
+ # A URL link for more information about the state of the action, such
4619
+ # as a details page.
4620
+ # @return [String]
4621
+ #
4622
+ # @!attribute [rw] revision_url
4623
+ # A URL link for more information about the revision, such as a commit
4624
+ # details page.
4625
+ # @return [String]
4626
+ #
4627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/RuleState AWS API Documentation
4628
+ #
4629
+ class RuleState < Struct.new(
4630
+ :rule_name,
4631
+ :current_revision,
4632
+ :latest_execution,
4633
+ :entity_url,
4634
+ :revision_url)
4635
+ SENSITIVE = []
4636
+ include Aws::Structure
4637
+ end
4638
+
4639
+ # The rule type, which is made up of the combined values for category,
4640
+ # owner, provider, and version.
4641
+ #
4642
+ # @!attribute [rw] id
4643
+ # Represents information about a rule type.
4644
+ # @return [Types::RuleTypeId]
4645
+ #
4646
+ # @!attribute [rw] settings
4647
+ # Returns information about the settings for a rule type.
4648
+ # @return [Types::RuleTypeSettings]
4649
+ #
4650
+ # @!attribute [rw] rule_configuration_properties
4651
+ # The configuration properties for the rule type.
4652
+ # @return [Array<Types::RuleConfigurationProperty>]
4653
+ #
4654
+ # @!attribute [rw] input_artifact_details
4655
+ # Returns information about the details of an artifact.
4656
+ # @return [Types::ArtifactDetails]
4657
+ #
4658
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/RuleType AWS API Documentation
4659
+ #
4660
+ class RuleType < Struct.new(
4661
+ :id,
4662
+ :settings,
4663
+ :rule_configuration_properties,
4664
+ :input_artifact_details)
4665
+ SENSITIVE = []
4666
+ include Aws::Structure
4667
+ end
4668
+
4669
+ # The ID for the rule type, which is made up of the combined values for
4670
+ # category, owner, provider, and version.
4671
+ #
4672
+ # @!attribute [rw] category
4673
+ # A category defines what kind of rule can be run in the stage, and
4674
+ # constrains the provider type for the rule. Valid categories are
4675
+ # limited to one of the following values.
4676
+ #
4677
+ # * INVOKE
4678
+ #
4679
+ # * Approval
4680
+ #
4681
+ # * Rule
4682
+ # @return [String]
4683
+ #
4684
+ # @!attribute [rw] owner
4685
+ # The creator of the rule being called. The valid value for the
4686
+ # `Owner` field in the rule category is `AWS`.
4687
+ # @return [String]
4688
+ #
4689
+ # @!attribute [rw] provider
4690
+ # The provider of the service being called by the rule. Valid
4691
+ # providers are determined by the rulecategory. For example, a managed
4692
+ # rule in the Rule category type has an owner of AWS, which would be
4693
+ # specified as `AWS`.
4694
+ # @return [String]
4695
+ #
4696
+ # @!attribute [rw] version
4697
+ # A string that describes the rule version.
4698
+ # @return [String]
4699
+ #
4700
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/RuleTypeId AWS API Documentation
4701
+ #
4702
+ class RuleTypeId < Struct.new(
4703
+ :category,
4704
+ :owner,
4705
+ :provider,
4706
+ :version)
4707
+ SENSITIVE = []
4708
+ include Aws::Structure
4709
+ end
4710
+
4711
+ # Returns information about the settings for a rule type.
4712
+ #
4713
+ # @!attribute [rw] third_party_configuration_url
4714
+ # The URL of a sign-up page where users can sign up for an external
4715
+ # service and perform initial configuration of the action provided by
4716
+ # that service.
4717
+ # @return [String]
4718
+ #
4719
+ # @!attribute [rw] entity_url_template
4720
+ # The URL returned to the CodePipeline console that provides a deep
4721
+ # link to the resources of the external system, such as the
4722
+ # configuration page for a CodeDeploy deployment group. This link is
4723
+ # provided as part of the action display in the pipeline.
4724
+ # @return [String]
4725
+ #
4726
+ # @!attribute [rw] execution_url_template
4727
+ # The URL returned to the CodePipeline console that contains a link to
4728
+ # the top-level landing page for the external system, such as the
4729
+ # console page for CodeDeploy. This link is shown on the pipeline view
4730
+ # page in the CodePipeline console and provides a link to the
4731
+ # execution entity of the external action.
4732
+ # @return [String]
4733
+ #
4734
+ # @!attribute [rw] revision_url_template
4735
+ # The URL returned to the CodePipeline console that contains a link to
4736
+ # the page where customers can update or change the configuration of
4737
+ # the external action.
4738
+ # @return [String]
4739
+ #
4740
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/RuleTypeSettings AWS API Documentation
4741
+ #
4742
+ class RuleTypeSettings < Struct.new(
4743
+ :third_party_configuration_url,
4744
+ :entity_url_template,
4745
+ :execution_url_template,
4746
+ :revision_url_template)
4747
+ SENSITIVE = []
4748
+ include Aws::Structure
4749
+ end
4750
+
4751
+ # The location of the S3 bucket that contains a revision.
4752
+ #
4753
+ # @!attribute [rw] bucket_name
4754
+ # The name of the S3 bucket.
4755
+ # @return [String]
4756
+ #
4757
+ # @!attribute [rw] object_key
4758
+ # The key of the object in the S3 bucket, which uniquely identifies
4759
+ # the object in the bucket.
4760
+ # @return [String]
4761
+ #
4762
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/S3ArtifactLocation AWS API Documentation
4763
+ #
4764
+ class S3ArtifactLocation < Struct.new(
4765
+ :bucket_name,
4766
+ :object_key)
4767
+ SENSITIVE = []
4768
+ include Aws::Structure
4769
+ end
4770
+
4771
+ # The Amazon S3 artifact location for an action's artifacts.
4772
+ #
4773
+ # @!attribute [rw] bucket
4774
+ # The Amazon S3 artifact bucket for an action's artifacts.
4775
+ # @return [String]
4776
+ #
4777
+ # @!attribute [rw] key
4778
+ # The artifact name.
4779
+ # @return [String]
4780
+ #
4781
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/S3Location AWS API Documentation
4782
+ #
4783
+ class S3Location < Struct.new(
4784
+ :bucket,
4785
+ :key)
4786
+ SENSITIVE = []
4787
+ include Aws::Structure
4788
+ end
4789
+
4790
+ # Information about the version (or revision) of a source artifact that
4791
+ # initiated a pipeline execution.
4792
+ #
4793
+ # @!attribute [rw] action_name
4794
+ # The name of the action that processed the revision to the source
4795
+ # artifact.
4796
+ # @return [String]
4797
+ #
4798
+ # @!attribute [rw] revision_id
4799
+ # The system-generated unique ID that identifies the revision number
4800
+ # of the artifact.
4801
+ # @return [String]
4802
+ #
4803
+ # @!attribute [rw] revision_summary
4804
+ # Summary information about the most recent revision of the artifact.
4805
+ # For GitHub and CodeCommit repositories, the commit message. For
4806
+ # Amazon S3 buckets or actions, the user-provided content of a
4807
+ # `codepipeline-artifact-revision-summary` key specified in the object
4808
+ # metadata.
4809
+ # @return [String]
4810
+ #
4811
+ # @!attribute [rw] revision_url
4812
+ # The commit ID for the artifact revision. For artifacts stored in
4813
+ # GitHub or CodeCommit repositories, the commit ID is linked to a
4814
+ # commit details page.
4815
+ # @return [String]
4816
+ #
4817
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/SourceRevision AWS API Documentation
4818
+ #
4819
+ class SourceRevision < Struct.new(
4820
+ :action_name,
4821
+ :revision_id,
4822
+ :revision_summary,
4823
+ :revision_url)
4824
+ SENSITIVE = []
4825
+ include Aws::Structure
4826
+ end
4827
+
4828
+ # A list that allows you to specify, or override, the source revision
4829
+ # for a pipeline execution that's being started. A source revision is
4830
+ # the version with all the changes to your application code, or source
4831
+ # artifact, for the pipeline execution.
4832
+ #
4833
+ # <note markdown="1"> For the `S3_OBJECT_VERSION_ID` and `S3_OBJECT_KEY` types of source
4834
+ # revisions, either of the types can be used independently, or they can
4835
+ # be used together to override the source with a specific ObjectKey and
4836
+ # VersionID.
4837
+ #
4838
+ # </note>
4839
+ #
4840
+ # @!attribute [rw] action_name
4841
+ # The name of the action where the override will be applied.
4842
+ # @return [String]
4843
+ #
4844
+ # @!attribute [rw] revision_type
4845
+ # The type of source revision, based on the source provider. For
4846
+ # example, the revision type for the CodeCommit action provider is the
4847
+ # commit ID.
4848
+ # @return [String]
4849
+ #
4850
+ # @!attribute [rw] revision_value
4851
+ # The source revision, or version of your source artifact, with the
4852
+ # changes that you want to run in the pipeline execution.
4853
+ # @return [String]
4854
+ #
4855
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/SourceRevisionOverride AWS API Documentation
4119
4856
  #
4120
4857
  class SourceRevisionOverride < Struct.new(
4121
4858
  :action_name,
@@ -4125,6 +4862,45 @@ module Aws::CodePipeline
4125
4862
  include Aws::Structure
4126
4863
  end
4127
4864
 
4865
+ # The state of a run of a condition for a stage.
4866
+ #
4867
+ # @!attribute [rw] latest_execution
4868
+ # Represents information about the latest run of a condition for a
4869
+ # stage.
4870
+ # @return [Types::StageConditionsExecution]
4871
+ #
4872
+ # @!attribute [rw] condition_states
4873
+ # The states of the conditions for a run of a condition for a stage.
4874
+ # @return [Array<Types::ConditionState>]
4875
+ #
4876
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/StageConditionState AWS API Documentation
4877
+ #
4878
+ class StageConditionState < Struct.new(
4879
+ :latest_execution,
4880
+ :condition_states)
4881
+ SENSITIVE = []
4882
+ include Aws::Structure
4883
+ end
4884
+
4885
+ # Represents information about the run of a condition for a stage.
4886
+ #
4887
+ # @!attribute [rw] status
4888
+ # The status of a run of a condition for a stage.
4889
+ # @return [String]
4890
+ #
4891
+ # @!attribute [rw] summary
4892
+ # A summary of the run of the condition for a stage.
4893
+ # @return [String]
4894
+ #
4895
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/StageConditionsExecution AWS API Documentation
4896
+ #
4897
+ class StageConditionsExecution < Struct.new(
4898
+ :status,
4899
+ :summary)
4900
+ SENSITIVE = []
4901
+ include Aws::Structure
4902
+ end
4903
+
4128
4904
  # Represents information about a stage to a job worker.
4129
4905
  #
4130
4906
  # @!attribute [rw] name
@@ -4160,13 +4936,27 @@ module Aws::CodePipeline
4160
4936
  # stage.
4161
4937
  # @return [Types::FailureConditions]
4162
4938
  #
4939
+ # @!attribute [rw] on_success
4940
+ # The method to use when a stage has succeeded. For example,
4941
+ # configuring this field for conditions will allow the stage to
4942
+ # succeed when the conditions are met.
4943
+ # @return [Types::SuccessConditions]
4944
+ #
4945
+ # @!attribute [rw] before_entry
4946
+ # The method to use when a stage allows entry. For example,
4947
+ # configuring this field for conditions will allow entry to the stage
4948
+ # when the conditions are met.
4949
+ # @return [Types::BeforeEntryConditions]
4950
+ #
4163
4951
  # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/StageDeclaration AWS API Documentation
4164
4952
  #
4165
4953
  class StageDeclaration < Struct.new(
4166
4954
  :name,
4167
4955
  :blockers,
4168
4956
  :actions,
4169
- :on_failure)
4957
+ :on_failure,
4958
+ :on_success,
4959
+ :before_entry)
4170
4960
  SENSITIVE = []
4171
4961
  include Aws::Structure
4172
4962
  end
@@ -4244,6 +5034,18 @@ module Aws::CodePipeline
4244
5034
  # ID and status.
4245
5035
  # @return [Types::StageExecution]
4246
5036
  #
5037
+ # @!attribute [rw] before_entry_condition_state
5038
+ # The state of the entry conditions for a stage.
5039
+ # @return [Types::StageConditionState]
5040
+ #
5041
+ # @!attribute [rw] on_success_condition_state
5042
+ # The state of the success conditions for a stage.
5043
+ # @return [Types::StageConditionState]
5044
+ #
5045
+ # @!attribute [rw] on_failure_condition_state
5046
+ # The state of the failure conditions for a stage.
5047
+ # @return [Types::StageConditionState]
5048
+ #
4247
5049
  # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/StageState AWS API Documentation
4248
5050
  #
4249
5051
  class StageState < Struct.new(
@@ -4252,7 +5054,10 @@ module Aws::CodePipeline
4252
5054
  :inbound_executions,
4253
5055
  :inbound_transition_state,
4254
5056
  :action_states,
4255
- :latest_execution)
5057
+ :latest_execution,
5058
+ :before_entry_condition_state,
5059
+ :on_success_condition_state,
5060
+ :on_failure_condition_state)
4256
5061
  SENSITIVE = []
4257
5062
  include Aws::Structure
4258
5063
  end
@@ -4388,6 +5193,20 @@ module Aws::CodePipeline
4388
5193
  include Aws::Structure
4389
5194
  end
4390
5195
 
5196
+ # The conditions for making checks that, if met, succeed a stage.
5197
+ #
5198
+ # @!attribute [rw] conditions
5199
+ # The conditions that are success conditions.
5200
+ # @return [Array<Types::Condition>]
5201
+ #
5202
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/SuccessConditions AWS API Documentation
5203
+ #
5204
+ class SuccessConditions < Struct.new(
5205
+ :conditions)
5206
+ SENSITIVE = []
5207
+ include Aws::Structure
5208
+ end
5209
+
4391
5210
  # A tag is a key-value pair that is used to manage the resource.
4392
5211
  #
4393
5212
  # @!attribute [rw] key