aws-sdk-codepipeline 1.27.0 → 1.32.1

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 847d358c63dea52617caa84a6e6b9986e4da9213
4
- data.tar.gz: b0c8513603fa7234e7c803127333ee41ab8a2e4c
2
+ SHA256:
3
+ metadata.gz: '05419d3a8869ad06fe162ffe7088114e1501d5f22baf0c4b312f6d524fe3b504'
4
+ data.tar.gz: 960483cf5c27146a0262f49c7a5c04f268b7f20ee9742020f1c04575fccc91e5
5
5
  SHA512:
6
- metadata.gz: 83d9c52769cb1f210e86a1ca85c07057df8812813b657091928521e6934e324623bd6b09c0cc0771ea1f5d0614d472103609d7e9ba733ee62bb5e204152bfb3f
7
- data.tar.gz: 0a59c917aff6836d48381a2d558bd6fc6d7c9b608cf2bb676ede073ec81826594d4d44db20a9bb245d0699a1ee1a05ad5de3656860c41e23dc2ed0a9f3ed6dba
6
+ metadata.gz: 4895798ba86e967f69405539946bdde7078f81feba04744ed29e0022f8c02e0299a999bc436fa3215f4916e9eb0b7853737dfe10365d5dd940d3f20c08482b4a
7
+ data.tar.gz: 6b3dc3b921f1c2258768f990624298014944a7e12fd6d27e275d828583169cae713ef896de065e34c8bc3f66f5feb8e108ffaa16f5a516c87593ea1e835dc745
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-codepipeline/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # code_pipeline = Aws::CodePipeline::Client.new
28
+ # resp = code_pipeline.acknowledge_job(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS CodePipeline all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS CodePipeline are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::CodePipeline::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS CodePipeline API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-codepipeline/customizations'
42
45
  # @service
43
46
  module Aws::CodePipeline
44
47
 
45
- GEM_VERSION = '1.27.0'
48
+ GEM_VERSION = '1.32.1'
46
49
 
47
50
  end
@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
24
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
25
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
26
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
28
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
29
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
30
 
30
31
  Aws::Plugins::GlobalConfiguration.add_identifier(:codepipeline)
31
32
 
32
33
  module Aws::CodePipeline
34
+ # An API client for CodePipeline. To construct a client, you need to configure a `:region` and `:credentials`.
35
+ #
36
+ # client = Aws::CodePipeline::Client.new(
37
+ # region: region_name,
38
+ # credentials: credentials,
39
+ # # ...
40
+ # )
41
+ #
42
+ # For details on configuring region and credentials see
43
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
44
+ #
45
+ # See {#initialize} for a full list of supported configuration options.
33
46
  class Client < Seahorse::Client::Base
34
47
 
35
48
  include Aws::ClientStubs
@@ -57,6 +70,7 @@ module Aws::CodePipeline
57
70
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
71
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
72
  add_plugin(Aws::Plugins::TransferEncoding)
73
+ add_plugin(Aws::Plugins::HttpChecksum)
60
74
  add_plugin(Aws::Plugins::SignatureV4)
61
75
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
62
76
 
@@ -93,7 +107,7 @@ module Aws::CodePipeline
93
107
  # @option options [required, String] :region
94
108
  # The AWS region to connect to. The configured `:region` is
95
109
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
110
+ # a default `:region` is searched for in the following locations:
97
111
  #
98
112
  # * `Aws.config[:region]`
99
113
  # * `ENV['AWS_REGION']`
@@ -108,6 +122,12 @@ module Aws::CodePipeline
108
122
  # When set to `true`, a thread polling for endpoints will be running in
109
123
  # the background every 60 secs (default). Defaults to `false`.
110
124
  #
125
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
126
+ # Used only in `adaptive` retry mode. When true, the request will sleep
127
+ # until there is sufficent client side capacity to retry the request.
128
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
129
+ # not retry instead of sleeping.
130
+ #
111
131
  # @option options [Boolean] :client_side_monitoring (false)
112
132
  # When `true`, client-side metrics will be collected for all API requests from
113
133
  # this client.
@@ -132,6 +152,10 @@ module Aws::CodePipeline
132
152
  # When `true`, an attempt is made to coerce request parameters into
133
153
  # the required types.
134
154
  #
155
+ # @option options [Boolean] :correct_clock_skew (true)
156
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
157
+ # a clock skew correction and retry requests with skewed client clocks.
158
+ #
135
159
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
160
  # Set to true to disable SDK automatically adding host prefix
137
161
  # to default service endpoint when available.
@@ -139,7 +163,7 @@ module Aws::CodePipeline
139
163
  # @option options [String] :endpoint
140
164
  # The client endpoint is normally constructed from the `:region`
141
165
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
166
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
143
167
  #
144
168
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
169
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +178,7 @@ module Aws::CodePipeline
154
178
  # requests fetching endpoints information. Defaults to 60 sec.
155
179
  #
156
180
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
181
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
182
  #
159
183
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
184
  # The log formatter.
@@ -166,15 +190,29 @@ module Aws::CodePipeline
166
190
  # The Logger instance to send log messages to. If this option
167
191
  # is not set, logging will be disabled.
168
192
  #
193
+ # @option options [Integer] :max_attempts (3)
194
+ # An integer representing the maximum number attempts that will be made for
195
+ # a single request, including the initial attempt. For example,
196
+ # setting this value to 5 will result in a request being retried up to
197
+ # 4 times. Used in `standard` and `adaptive` retry modes.
198
+ #
169
199
  # @option options [String] :profile ("default")
170
200
  # Used when loading credentials from the shared credentials file
171
201
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
202
  #
203
+ # @option options [Proc] :retry_backoff
204
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
205
+ # This option is only used in the `legacy` retry mode.
206
+ #
173
207
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
208
+ # The base delay in seconds used by the default backoff function. This option
209
+ # is only used in the `legacy` retry mode.
175
210
  #
176
211
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
212
+ # A delay randomiser function used by the default backoff function.
213
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
214
+ # otherwise a Proc that takes and returns a number. This option is only used
215
+ # in the `legacy` retry mode.
178
216
  #
179
217
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
218
  #
@@ -182,11 +220,30 @@ module Aws::CodePipeline
182
220
  # The maximum number of times to retry failed requests. Only
183
221
  # ~ 500 level server errors and certain ~ 400 level client errors
184
222
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
223
+ # checksum errors, networking errors, timeout errors, auth errors,
224
+ # endpoint discovery, and errors from expired credentials.
225
+ # This option is only used in the `legacy` retry mode.
187
226
  #
188
227
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
228
+ # The maximum number of seconds to delay between retries (0 for no limit)
229
+ # used by the default backoff function. This option is only used in the
230
+ # `legacy` retry mode.
231
+ #
232
+ # @option options [String] :retry_mode ("legacy")
233
+ # Specifies which retry algorithm to use. Values are:
234
+ #
235
+ # * `legacy` - The pre-existing retry behavior. This is default value if
236
+ # no retry mode is provided.
237
+ #
238
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
239
+ # This includes support for retry quotas, which limit the number of
240
+ # unsuccessful retries a client can make.
241
+ #
242
+ # * `adaptive` - An experimental retry mode that includes all the
243
+ # functionality of `standard` mode along with automatic client side
244
+ # throttling. This is a provisional mode that may change behavior
245
+ # in the future.
246
+ #
190
247
  #
191
248
  # @option options [String] :secret_access_key
192
249
  #
@@ -219,16 +276,15 @@ module Aws::CodePipeline
219
276
  # requests through. Formatted like 'http://proxy.com:123'.
220
277
  #
221
278
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
279
+ # seconds to wait when opening a HTTP session before raising a
223
280
  # `Timeout::Error`.
224
281
  #
225
282
  # @option options [Integer] :http_read_timeout (60) The default
226
283
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
284
+ # safely be set per-request on the session.
229
285
  #
230
286
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
287
+ # seconds a connection is allowed to sit idle before it is
232
288
  # considered stale. Stale connections are closed and removed
233
289
  # from the pool before making a request.
234
290
  #
@@ -237,7 +293,7 @@ module Aws::CodePipeline
237
293
  # request body. This option has no effect unless the request has
238
294
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
295
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
296
+ # request on the session.
241
297
  #
242
298
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
299
  # HTTP debug output will be sent to the `:logger`.
@@ -806,10 +862,10 @@ module Aws::CodePipeline
806
862
  # Returns information about a job. Used for custom actions only.
807
863
  #
808
864
  # When this API is called, AWS CodePipeline returns temporary
809
- # credentials for the Amazon S3 bucket used to store artifacts for the
810
- # pipeline, if the action requires access to that Amazon S3 bucket for
811
- # input or output artifacts. This API also returns any secret values
812
- # defined for the action.
865
+ # credentials for the S3 bucket used to store artifacts for the
866
+ # pipeline, if the action requires access to that S3 bucket for input or
867
+ # output artifacts. This API also returns any secret values defined for
868
+ # the action.
813
869
  #
814
870
  # @option params [required, String] :job_id
815
871
  # The unique system-generated ID for the job.
@@ -969,7 +1025,7 @@ module Aws::CodePipeline
969
1025
  # resp.pipeline_execution.pipeline_name #=> String
970
1026
  # resp.pipeline_execution.pipeline_version #=> Integer
971
1027
  # resp.pipeline_execution.pipeline_execution_id #=> String
972
- # resp.pipeline_execution.status #=> String, one of "InProgress", "Succeeded", "Superseded", "Failed"
1028
+ # resp.pipeline_execution.status #=> String, one of "InProgress", "Stopped", "Stopping", "Succeeded", "Superseded", "Failed"
973
1029
  # resp.pipeline_execution.artifact_revisions #=> Array
974
1030
  # resp.pipeline_execution.artifact_revisions[0].name #=> String
975
1031
  # resp.pipeline_execution.artifact_revisions[0].revision_id #=> String
@@ -1028,7 +1084,7 @@ module Aws::CodePipeline
1028
1084
  # resp.stage_states[0].action_states[0].current_revision.revision_id #=> String
1029
1085
  # resp.stage_states[0].action_states[0].current_revision.revision_change_id #=> String
1030
1086
  # resp.stage_states[0].action_states[0].current_revision.created #=> Time
1031
- # resp.stage_states[0].action_states[0].latest_execution.status #=> String, one of "InProgress", "Succeeded", "Failed"
1087
+ # resp.stage_states[0].action_states[0].latest_execution.status #=> String, one of "InProgress", "Abandoned", "Succeeded", "Failed"
1032
1088
  # resp.stage_states[0].action_states[0].latest_execution.summary #=> String
1033
1089
  # resp.stage_states[0].action_states[0].latest_execution.last_status_change #=> Time
1034
1090
  # resp.stage_states[0].action_states[0].latest_execution.token #=> String
@@ -1041,7 +1097,7 @@ module Aws::CodePipeline
1041
1097
  # resp.stage_states[0].action_states[0].entity_url #=> String
1042
1098
  # resp.stage_states[0].action_states[0].revision_url #=> String
1043
1099
  # resp.stage_states[0].latest_execution.pipeline_execution_id #=> String
1044
- # resp.stage_states[0].latest_execution.status #=> String, one of "InProgress", "Failed", "Succeeded"
1100
+ # resp.stage_states[0].latest_execution.status #=> String, one of "InProgress", "Failed", "Stopped", "Stopping", "Succeeded"
1045
1101
  # resp.created #=> Time
1046
1102
  # resp.updated #=> Time
1047
1103
  #
@@ -1058,10 +1114,10 @@ module Aws::CodePipeline
1058
1114
  # partner actions only.
1059
1115
  #
1060
1116
  # When this API is called, AWS CodePipeline returns temporary
1061
- # credentials for the Amazon S3 bucket used to store artifacts for the
1062
- # pipeline, if the action requires access to that Amazon S3 bucket for
1063
- # input or output artifacts. This API also returns any secret values
1064
- # defined for the action.
1117
+ # credentials for the S3 bucket used to store artifacts for the
1118
+ # pipeline, if the action requires access to that S3 bucket for input or
1119
+ # output artifacts. This API also returns any secret values defined for
1120
+ # the action.
1065
1121
  #
1066
1122
  # @option params [required, String] :job_id
1067
1123
  # The unique system-generated ID used for identifying the job.
@@ -1156,6 +1212,8 @@ module Aws::CodePipeline
1156
1212
  # * {Types::ListActionExecutionsOutput#action_execution_details #action_execution_details} => Array&lt;Types::ActionExecutionDetail&gt;
1157
1213
  # * {Types::ListActionExecutionsOutput#next_token #next_token} => String
1158
1214
  #
1215
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1216
+ #
1159
1217
  # @example Request syntax with placeholder values
1160
1218
  #
1161
1219
  # resp = client.list_action_executions({
@@ -1177,7 +1235,7 @@ module Aws::CodePipeline
1177
1235
  # resp.action_execution_details[0].action_name #=> String
1178
1236
  # resp.action_execution_details[0].start_time #=> Time
1179
1237
  # resp.action_execution_details[0].last_update_time #=> Time
1180
- # resp.action_execution_details[0].status #=> String, one of "InProgress", "Succeeded", "Failed"
1238
+ # resp.action_execution_details[0].status #=> String, one of "InProgress", "Abandoned", "Succeeded", "Failed"
1181
1239
  # resp.action_execution_details[0].input.action_type_id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval"
1182
1240
  # resp.action_execution_details[0].input.action_type_id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
1183
1241
  # resp.action_execution_details[0].input.action_type_id.provider #=> String
@@ -1230,6 +1288,8 @@ module Aws::CodePipeline
1230
1288
  # * {Types::ListActionTypesOutput#action_types #action_types} => Array&lt;Types::ActionType&gt;
1231
1289
  # * {Types::ListActionTypesOutput#next_token #next_token} => String
1232
1290
  #
1291
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1292
+ #
1233
1293
  # @example Request syntax with placeholder values
1234
1294
  #
1235
1295
  # resp = client.list_action_types({
@@ -1293,6 +1353,8 @@ module Aws::CodePipeline
1293
1353
  # * {Types::ListPipelineExecutionsOutput#pipeline_execution_summaries #pipeline_execution_summaries} => Array&lt;Types::PipelineExecutionSummary&gt;
1294
1354
  # * {Types::ListPipelineExecutionsOutput#next_token #next_token} => String
1295
1355
  #
1356
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1357
+ #
1296
1358
  # @example Request syntax with placeholder values
1297
1359
  #
1298
1360
  # resp = client.list_pipeline_executions({
@@ -1305,7 +1367,7 @@ module Aws::CodePipeline
1305
1367
  #
1306
1368
  # resp.pipeline_execution_summaries #=> Array
1307
1369
  # resp.pipeline_execution_summaries[0].pipeline_execution_id #=> String
1308
- # resp.pipeline_execution_summaries[0].status #=> String, one of "InProgress", "Succeeded", "Superseded", "Failed"
1370
+ # resp.pipeline_execution_summaries[0].status #=> String, one of "InProgress", "Stopped", "Stopping", "Succeeded", "Superseded", "Failed"
1309
1371
  # resp.pipeline_execution_summaries[0].start_time #=> Time
1310
1372
  # resp.pipeline_execution_summaries[0].last_update_time #=> Time
1311
1373
  # resp.pipeline_execution_summaries[0].source_revisions #=> Array
@@ -1315,6 +1377,7 @@ module Aws::CodePipeline
1315
1377
  # resp.pipeline_execution_summaries[0].source_revisions[0].revision_url #=> String
1316
1378
  # resp.pipeline_execution_summaries[0].trigger.trigger_type #=> String, one of "CreatePipeline", "StartPipelineExecution", "PollForSourceChanges", "Webhook", "CloudWatchEvent", "PutActionRevision"
1317
1379
  # resp.pipeline_execution_summaries[0].trigger.trigger_detail #=> String
1380
+ # resp.pipeline_execution_summaries[0].stop_trigger.reason #=> String
1318
1381
  # resp.next_token #=> String
1319
1382
  #
1320
1383
  # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/ListPipelineExecutions AWS API Documentation
@@ -1337,6 +1400,8 @@ module Aws::CodePipeline
1337
1400
  # * {Types::ListPipelinesOutput#pipelines #pipelines} => Array&lt;Types::PipelineSummary&gt;
1338
1401
  # * {Types::ListPipelinesOutput#next_token #next_token} => String
1339
1402
  #
1403
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1404
+ #
1340
1405
  # @example Request syntax with placeholder values
1341
1406
  #
1342
1407
  # resp = client.list_pipelines({
@@ -1380,6 +1445,8 @@ module Aws::CodePipeline
1380
1445
  # * {Types::ListTagsForResourceOutput#tags #tags} => Array&lt;Types::Tag&gt;
1381
1446
  # * {Types::ListTagsForResourceOutput#next_token #next_token} => String
1382
1447
  #
1448
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1449
+ #
1383
1450
  # @example Request syntax with placeholder values
1384
1451
  #
1385
1452
  # resp = client.list_tags_for_resource({
@@ -1422,6 +1489,8 @@ module Aws::CodePipeline
1422
1489
  # * {Types::ListWebhooksOutput#webhooks #webhooks} => Array&lt;Types::ListWebhookItem&gt;
1423
1490
  # * {Types::ListWebhooksOutput#next_token #next_token} => String
1424
1491
  #
1492
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1493
+ #
1425
1494
  # @example Request syntax with placeholder values
1426
1495
  #
1427
1496
  # resp = client.list_webhooks({
@@ -1466,10 +1535,10 @@ module Aws::CodePipeline
1466
1535
  # the owner field, the `PollForJobs` action returns an error.
1467
1536
  #
1468
1537
  # When this API is called, AWS CodePipeline returns temporary
1469
- # credentials for the Amazon S3 bucket used to store artifacts for the
1470
- # pipeline, if the action requires access to that Amazon S3 bucket for
1471
- # input or output artifacts. This API also returns any secret values
1472
- # defined for the action.
1538
+ # credentials for the S3 bucket used to store artifacts for the
1539
+ # pipeline, if the action requires access to that S3 bucket for input or
1540
+ # output artifacts. This API also returns any secret values defined for
1541
+ # the action.
1473
1542
  #
1474
1543
  # @option params [required, Types::ActionTypeId] :action_type_id
1475
1544
  # Represents information about an action type.
@@ -1553,9 +1622,9 @@ module Aws::CodePipeline
1553
1622
  # act on. Used for partner actions only.
1554
1623
  #
1555
1624
  # When this API is called, AWS CodePipeline returns temporary
1556
- # credentials for the Amazon S3 bucket used to store artifacts for the
1557
- # pipeline, if the action requires access to that Amazon S3 bucket for
1558
- # input or output artifacts.
1625
+ # credentials for the S3 bucket used to store artifacts for the
1626
+ # pipeline, if the action requires access to that S3 bucket for input or
1627
+ # output artifacts.
1559
1628
  #
1560
1629
  # @option params [required, Types::ActionTypeId] :action_type_id
1561
1630
  # Represents information about an action type.
@@ -2069,6 +2138,59 @@ module Aws::CodePipeline
2069
2138
  req.send_request(options)
2070
2139
  end
2071
2140
 
2141
+ # Stops the specified pipeline execution. You choose to either stop the
2142
+ # pipeline execution by completing in-progress actions without starting
2143
+ # subsequent actions, or by abandoning in-progress actions. While
2144
+ # completing or abandoning in-progress actions, the pipeline execution
2145
+ # is in a `Stopping` state. After all in-progress actions are completed
2146
+ # or abandoned, the pipeline execution is in a `Stopped` state.
2147
+ #
2148
+ # @option params [required, String] :pipeline_name
2149
+ # The name of the pipeline to stop.
2150
+ #
2151
+ # @option params [required, String] :pipeline_execution_id
2152
+ # The ID of the pipeline execution to be stopped in the current stage.
2153
+ # Use the `GetPipelineState` action to retrieve the current
2154
+ # pipelineExecutionId.
2155
+ #
2156
+ # @option params [Boolean] :abandon
2157
+ # Use this option to stop the pipeline execution by abandoning, rather
2158
+ # than finishing, in-progress actions.
2159
+ #
2160
+ # <note markdown="1"> This option can lead to failed or out-of-sequence tasks.
2161
+ #
2162
+ # </note>
2163
+ #
2164
+ # @option params [String] :reason
2165
+ # Use this option to enter comments, such as the reason the pipeline was
2166
+ # stopped.
2167
+ #
2168
+ # @return [Types::StopPipelineExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2169
+ #
2170
+ # * {Types::StopPipelineExecutionOutput#pipeline_execution_id #pipeline_execution_id} => String
2171
+ #
2172
+ # @example Request syntax with placeholder values
2173
+ #
2174
+ # resp = client.stop_pipeline_execution({
2175
+ # pipeline_name: "PipelineName", # required
2176
+ # pipeline_execution_id: "PipelineExecutionId", # required
2177
+ # abandon: false,
2178
+ # reason: "StopPipelineExecutionReason",
2179
+ # })
2180
+ #
2181
+ # @example Response structure
2182
+ #
2183
+ # resp.pipeline_execution_id #=> String
2184
+ #
2185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/StopPipelineExecution AWS API Documentation
2186
+ #
2187
+ # @overload stop_pipeline_execution(params = {})
2188
+ # @param [Hash] params ({})
2189
+ def stop_pipeline_execution(params = {}, options = {})
2190
+ req = build_request(:stop_pipeline_execution, params)
2191
+ req.send_request(options)
2192
+ end
2193
+
2072
2194
  # Adds to or modifies the tags of the given resource. Tags are metadata
2073
2195
  # that can be used to manage a resource.
2074
2196
  #
@@ -2265,7 +2387,7 @@ module Aws::CodePipeline
2265
2387
  params: params,
2266
2388
  config: config)
2267
2389
  context[:gem_name] = 'aws-sdk-codepipeline'
2268
- context[:gem_version] = '1.27.0'
2390
+ context[:gem_version] = '1.32.1'
2269
2391
  Seahorse::Client::Request.new(handlers, context)
2270
2392
  end
2271
2393
 
@@ -97,6 +97,7 @@ module Aws::CodePipeline
97
97
  Description = Shapes::StringShape.new(name: 'Description')
98
98
  DisableStageTransitionInput = Shapes::StructureShape.new(name: 'DisableStageTransitionInput')
99
99
  DisabledReason = Shapes::StringShape.new(name: 'DisabledReason')
100
+ DuplicatedStopRequestException = Shapes::StructureShape.new(name: 'DuplicatedStopRequestException')
100
101
  EnableStageTransitionInput = Shapes::StructureShape.new(name: 'EnableStageTransitionInput')
101
102
  Enabled = Shapes::BooleanShape.new(name: 'Enabled')
102
103
  EncryptionKey = Shapes::StructureShape.new(name: 'EncryptionKey')
@@ -184,6 +185,7 @@ module Aws::CodePipeline
184
185
  PipelineExecution = Shapes::StructureShape.new(name: 'PipelineExecution')
185
186
  PipelineExecutionId = Shapes::StringShape.new(name: 'PipelineExecutionId')
186
187
  PipelineExecutionNotFoundException = Shapes::StructureShape.new(name: 'PipelineExecutionNotFoundException')
188
+ PipelineExecutionNotStoppableException = Shapes::StructureShape.new(name: 'PipelineExecutionNotStoppableException')
187
189
  PipelineExecutionStatus = Shapes::StringShape.new(name: 'PipelineExecutionStatus')
188
190
  PipelineExecutionSummary = Shapes::StructureShape.new(name: 'PipelineExecutionSummary')
189
191
  PipelineExecutionSummaryList = Shapes::ListShape.new(name: 'PipelineExecutionSummaryList')
@@ -247,6 +249,10 @@ module Aws::CodePipeline
247
249
  StageTransitionType = Shapes::StringShape.new(name: 'StageTransitionType')
248
250
  StartPipelineExecutionInput = Shapes::StructureShape.new(name: 'StartPipelineExecutionInput')
249
251
  StartPipelineExecutionOutput = Shapes::StructureShape.new(name: 'StartPipelineExecutionOutput')
252
+ StopExecutionTrigger = Shapes::StructureShape.new(name: 'StopExecutionTrigger')
253
+ StopPipelineExecutionInput = Shapes::StructureShape.new(name: 'StopPipelineExecutionInput')
254
+ StopPipelineExecutionOutput = Shapes::StructureShape.new(name: 'StopPipelineExecutionOutput')
255
+ StopPipelineExecutionReason = Shapes::StringShape.new(name: 'StopPipelineExecutionReason')
250
256
  String = Shapes::StringShape.new(name: 'String')
251
257
  Tag = Shapes::StructureShape.new(name: 'Tag')
252
258
  TagKey = Shapes::StringShape.new(name: 'TagKey')
@@ -389,6 +395,8 @@ module Aws::CodePipeline
389
395
  ActionExecutionResult.add_member(:external_execution_url, Shapes::ShapeRef.new(shape: Url, location_name: "externalExecutionUrl"))
390
396
  ActionExecutionResult.struct_class = Types::ActionExecutionResult
391
397
 
398
+ ActionNotFoundException.struct_class = Types::ActionNotFoundException
399
+
392
400
  ActionRevision.add_member(:revision_id, Shapes::ShapeRef.new(shape: Revision, required: true, location_name: "revisionId"))
393
401
  ActionRevision.add_member(:revision_change_id, Shapes::ShapeRef.new(shape: RevisionChangeIdentifier, required: true, location_name: "revisionChangeId"))
394
402
  ActionRevision.add_member(:created, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "created"))
@@ -418,12 +426,16 @@ module Aws::CodePipeline
418
426
 
419
427
  ActionTypeList.member = Shapes::ShapeRef.new(shape: ActionType)
420
428
 
429
+ ActionTypeNotFoundException.struct_class = Types::ActionTypeNotFoundException
430
+
421
431
  ActionTypeSettings.add_member(:third_party_configuration_url, Shapes::ShapeRef.new(shape: Url, location_name: "thirdPartyConfigurationUrl"))
422
432
  ActionTypeSettings.add_member(:entity_url_template, Shapes::ShapeRef.new(shape: UrlTemplate, location_name: "entityUrlTemplate"))
423
433
  ActionTypeSettings.add_member(:execution_url_template, Shapes::ShapeRef.new(shape: UrlTemplate, location_name: "executionUrlTemplate"))
424
434
  ActionTypeSettings.add_member(:revision_url_template, Shapes::ShapeRef.new(shape: UrlTemplate, location_name: "revisionUrlTemplate"))
425
435
  ActionTypeSettings.struct_class = Types::ActionTypeSettings
426
436
 
437
+ ApprovalAlreadyCompletedException.struct_class = Types::ApprovalAlreadyCompletedException
438
+
427
439
  ApprovalResult.add_member(:summary, Shapes::ShapeRef.new(shape: ApprovalSummary, required: true, location_name: "summary"))
428
440
  ApprovalResult.add_member(:status, Shapes::ShapeRef.new(shape: ApprovalStatus, required: true, location_name: "status"))
429
441
  ApprovalResult.struct_class = Types::ApprovalResult
@@ -526,6 +538,9 @@ module Aws::CodePipeline
526
538
  DisableStageTransitionInput.add_member(:reason, Shapes::ShapeRef.new(shape: DisabledReason, required: true, location_name: "reason"))
527
539
  DisableStageTransitionInput.struct_class = Types::DisableStageTransitionInput
528
540
 
541
+ DuplicatedStopRequestException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "message"))
542
+ DuplicatedStopRequestException.struct_class = Types::DuplicatedStopRequestException
543
+
529
544
  EnableStageTransitionInput.add_member(:pipeline_name, Shapes::ShapeRef.new(shape: PipelineName, required: true, location_name: "pipelineName"))
530
545
  EnableStageTransitionInput.add_member(:stage_name, Shapes::ShapeRef.new(shape: StageName, required: true, location_name: "stageName"))
531
546
  EnableStageTransitionInput.add_member(:transition_type, Shapes::ShapeRef.new(shape: StageTransitionType, required: true, location_name: "transitionType"))
@@ -596,12 +611,36 @@ module Aws::CodePipeline
596
611
 
597
612
  InputArtifactList.member = Shapes::ShapeRef.new(shape: InputArtifact)
598
613
 
614
+ InvalidActionDeclarationException.struct_class = Types::InvalidActionDeclarationException
615
+
616
+ InvalidApprovalTokenException.struct_class = Types::InvalidApprovalTokenException
617
+
599
618
  InvalidArnException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "message"))
600
619
  InvalidArnException.struct_class = Types::InvalidArnException
601
620
 
621
+ InvalidBlockerDeclarationException.struct_class = Types::InvalidBlockerDeclarationException
622
+
623
+ InvalidClientTokenException.struct_class = Types::InvalidClientTokenException
624
+
625
+ InvalidJobException.struct_class = Types::InvalidJobException
626
+
627
+ InvalidJobStateException.struct_class = Types::InvalidJobStateException
628
+
629
+ InvalidNextTokenException.struct_class = Types::InvalidNextTokenException
630
+
631
+ InvalidNonceException.struct_class = Types::InvalidNonceException
632
+
633
+ InvalidStageDeclarationException.struct_class = Types::InvalidStageDeclarationException
634
+
635
+ InvalidStructureException.struct_class = Types::InvalidStructureException
636
+
602
637
  InvalidTagsException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "message"))
603
638
  InvalidTagsException.struct_class = Types::InvalidTagsException
604
639
 
640
+ InvalidWebhookAuthenticationParametersException.struct_class = Types::InvalidWebhookAuthenticationParametersException
641
+
642
+ InvalidWebhookFilterPatternException.struct_class = Types::InvalidWebhookFilterPatternException
643
+
605
644
  Job.add_member(:id, Shapes::ShapeRef.new(shape: JobId, location_name: "id"))
606
645
  Job.add_member(:data, Shapes::ShapeRef.new(shape: JobData, location_name: "data"))
607
646
  Job.add_member(:nonce, Shapes::ShapeRef.new(shape: Nonce, location_name: "nonce"))
@@ -625,6 +664,10 @@ module Aws::CodePipeline
625
664
 
626
665
  JobList.member = Shapes::ShapeRef.new(shape: Job)
627
666
 
667
+ JobNotFoundException.struct_class = Types::JobNotFoundException
668
+
669
+ LimitExceededException.struct_class = Types::LimitExceededException
670
+
628
671
  ListActionExecutionsInput.add_member(:pipeline_name, Shapes::ShapeRef.new(shape: PipelineName, required: true, location_name: "pipelineName"))
629
672
  ListActionExecutionsInput.add_member(:filter, Shapes::ShapeRef.new(shape: ActionExecutionFilter, location_name: "filter"))
630
673
  ListActionExecutionsInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
@@ -685,6 +728,8 @@ module Aws::CodePipeline
685
728
  ListWebhooksOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
686
729
  ListWebhooksOutput.struct_class = Types::ListWebhooksOutput
687
730
 
731
+ NotLatestPipelineExecutionException.struct_class = Types::NotLatestPipelineExecutionException
732
+
688
733
  OutputArtifact.add_member(:name, Shapes::ShapeRef.new(shape: ArtifactName, required: true, location_name: "name"))
689
734
  OutputArtifact.struct_class = Types::OutputArtifact
690
735
 
@@ -718,12 +763,18 @@ module Aws::CodePipeline
718
763
  PipelineExecution.add_member(:artifact_revisions, Shapes::ShapeRef.new(shape: ArtifactRevisionList, location_name: "artifactRevisions"))
719
764
  PipelineExecution.struct_class = Types::PipelineExecution
720
765
 
766
+ PipelineExecutionNotFoundException.struct_class = Types::PipelineExecutionNotFoundException
767
+
768
+ PipelineExecutionNotStoppableException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "message"))
769
+ PipelineExecutionNotStoppableException.struct_class = Types::PipelineExecutionNotStoppableException
770
+
721
771
  PipelineExecutionSummary.add_member(:pipeline_execution_id, Shapes::ShapeRef.new(shape: PipelineExecutionId, location_name: "pipelineExecutionId"))
722
772
  PipelineExecutionSummary.add_member(:status, Shapes::ShapeRef.new(shape: PipelineExecutionStatus, location_name: "status"))
723
773
  PipelineExecutionSummary.add_member(:start_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "startTime"))
724
774
  PipelineExecutionSummary.add_member(:last_update_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateTime"))
725
775
  PipelineExecutionSummary.add_member(:source_revisions, Shapes::ShapeRef.new(shape: SourceRevisionList, location_name: "sourceRevisions"))
726
776
  PipelineExecutionSummary.add_member(:trigger, Shapes::ShapeRef.new(shape: ExecutionTrigger, location_name: "trigger"))
777
+ PipelineExecutionSummary.add_member(:stop_trigger, Shapes::ShapeRef.new(shape: StopExecutionTrigger, location_name: "stopTrigger"))
727
778
  PipelineExecutionSummary.struct_class = Types::PipelineExecutionSummary
728
779
 
729
780
  PipelineExecutionSummaryList.member = Shapes::ShapeRef.new(shape: PipelineExecutionSummary)
@@ -735,6 +786,10 @@ module Aws::CodePipeline
735
786
  PipelineMetadata.add_member(:updated, Shapes::ShapeRef.new(shape: Timestamp, location_name: "updated"))
736
787
  PipelineMetadata.struct_class = Types::PipelineMetadata
737
788
 
789
+ PipelineNameInUseException.struct_class = Types::PipelineNameInUseException
790
+
791
+ PipelineNotFoundException.struct_class = Types::PipelineNotFoundException
792
+
738
793
  PipelineStageDeclarationList.member = Shapes::ShapeRef.new(shape: StageDeclaration)
739
794
 
740
795
  PipelineSummary.add_member(:name, Shapes::ShapeRef.new(shape: PipelineName, location_name: "name"))
@@ -743,6 +798,8 @@ module Aws::CodePipeline
743
798
  PipelineSummary.add_member(:updated, Shapes::ShapeRef.new(shape: Timestamp, location_name: "updated"))
744
799
  PipelineSummary.struct_class = Types::PipelineSummary
745
800
 
801
+ PipelineVersionNotFoundException.struct_class = Types::PipelineVersionNotFoundException
802
+
746
803
  PollForJobsInput.add_member(:action_type_id, Shapes::ShapeRef.new(shape: ActionTypeId, required: true, location_name: "actionTypeId"))
747
804
  PollForJobsInput.add_member(:max_batch_size, Shapes::ShapeRef.new(shape: MaxBatchSize, location_name: "maxBatchSize"))
748
805
  PollForJobsInput.add_member(:query_param, Shapes::ShapeRef.new(shape: QueryParamMap, location_name: "queryParam"))
@@ -819,6 +876,8 @@ module Aws::CodePipeline
819
876
  ResolvedActionConfigurationMap.key = Shapes::ShapeRef.new(shape: String)
820
877
  ResolvedActionConfigurationMap.value = Shapes::ShapeRef.new(shape: String)
821
878
 
879
+ ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
880
+
822
881
  RetryStageExecutionInput.add_member(:pipeline_name, Shapes::ShapeRef.new(shape: PipelineName, required: true, location_name: "pipelineName"))
823
882
  RetryStageExecutionInput.add_member(:stage_name, Shapes::ShapeRef.new(shape: StageName, required: true, location_name: "stageName"))
824
883
  RetryStageExecutionInput.add_member(:pipeline_execution_id, Shapes::ShapeRef.new(shape: PipelineExecutionId, required: true, location_name: "pipelineExecutionId"))
@@ -860,6 +919,10 @@ module Aws::CodePipeline
860
919
  StageExecution.add_member(:status, Shapes::ShapeRef.new(shape: StageExecutionStatus, required: true, location_name: "status"))
861
920
  StageExecution.struct_class = Types::StageExecution
862
921
 
922
+ StageNotFoundException.struct_class = Types::StageNotFoundException
923
+
924
+ StageNotRetryableException.struct_class = Types::StageNotRetryableException
925
+
863
926
  StageState.add_member(:stage_name, Shapes::ShapeRef.new(shape: StageName, location_name: "stageName"))
864
927
  StageState.add_member(:inbound_transition_state, Shapes::ShapeRef.new(shape: TransitionState, location_name: "inboundTransitionState"))
865
928
  StageState.add_member(:action_states, Shapes::ShapeRef.new(shape: ActionStateList, location_name: "actionStates"))
@@ -875,6 +938,18 @@ module Aws::CodePipeline
875
938
  StartPipelineExecutionOutput.add_member(:pipeline_execution_id, Shapes::ShapeRef.new(shape: PipelineExecutionId, location_name: "pipelineExecutionId"))
876
939
  StartPipelineExecutionOutput.struct_class = Types::StartPipelineExecutionOutput
877
940
 
941
+ StopExecutionTrigger.add_member(:reason, Shapes::ShapeRef.new(shape: StopPipelineExecutionReason, location_name: "reason"))
942
+ StopExecutionTrigger.struct_class = Types::StopExecutionTrigger
943
+
944
+ StopPipelineExecutionInput.add_member(:pipeline_name, Shapes::ShapeRef.new(shape: PipelineName, required: true, location_name: "pipelineName"))
945
+ StopPipelineExecutionInput.add_member(:pipeline_execution_id, Shapes::ShapeRef.new(shape: PipelineExecutionId, required: true, location_name: "pipelineExecutionId"))
946
+ StopPipelineExecutionInput.add_member(:abandon, Shapes::ShapeRef.new(shape: Boolean, location_name: "abandon"))
947
+ StopPipelineExecutionInput.add_member(:reason, Shapes::ShapeRef.new(shape: StopPipelineExecutionReason, location_name: "reason"))
948
+ StopPipelineExecutionInput.struct_class = Types::StopPipelineExecutionInput
949
+
950
+ StopPipelineExecutionOutput.add_member(:pipeline_execution_id, Shapes::ShapeRef.new(shape: PipelineExecutionId, location_name: "pipelineExecutionId"))
951
+ StopPipelineExecutionOutput.struct_class = Types::StopPipelineExecutionOutput
952
+
878
953
  Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKey, required: true, location_name: "key"))
879
954
  Tag.add_member(:value, Shapes::ShapeRef.new(shape: TagValue, required: true, location_name: "value"))
880
955
  Tag.struct_class = Types::Tag
@@ -931,6 +1006,8 @@ module Aws::CodePipeline
931
1006
  UpdatePipelineOutput.add_member(:pipeline, Shapes::ShapeRef.new(shape: PipelineDeclaration, location_name: "pipeline"))
932
1007
  UpdatePipelineOutput.struct_class = Types::UpdatePipelineOutput
933
1008
 
1009
+ ValidationException.struct_class = Types::ValidationException
1010
+
934
1011
  WebhookAuthConfiguration.add_member(:allowed_ip_range, Shapes::ShapeRef.new(shape: WebhookAuthConfigurationAllowedIPRange, location_name: "AllowedIPRange"))
935
1012
  WebhookAuthConfiguration.add_member(:secret_token, Shapes::ShapeRef.new(shape: WebhookAuthConfigurationSecretToken, location_name: "SecretToken"))
936
1013
  WebhookAuthConfiguration.struct_class = Types::WebhookAuthConfiguration
@@ -951,6 +1028,8 @@ module Aws::CodePipeline
951
1028
 
952
1029
  WebhookList.member = Shapes::ShapeRef.new(shape: ListWebhookItem)
953
1030
 
1031
+ WebhookNotFoundException.struct_class = Types::WebhookNotFoundException
1032
+
954
1033
 
955
1034
  # @api private
956
1035
  API = Seahorse::Model::Api.new.tap do |api|
@@ -1381,6 +1460,18 @@ module Aws::CodePipeline
1381
1460
  o.errors << Shapes::ShapeRef.new(shape: PipelineNotFoundException)
1382
1461
  end)
1383
1462
 
1463
+ api.add_operation(:stop_pipeline_execution, Seahorse::Model::Operation.new.tap do |o|
1464
+ o.name = "StopPipelineExecution"
1465
+ o.http_method = "POST"
1466
+ o.http_request_uri = "/"
1467
+ o.input = Shapes::ShapeRef.new(shape: StopPipelineExecutionInput)
1468
+ o.output = Shapes::ShapeRef.new(shape: StopPipelineExecutionOutput)
1469
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
1470
+ o.errors << Shapes::ShapeRef.new(shape: PipelineNotFoundException)
1471
+ o.errors << Shapes::ShapeRef.new(shape: PipelineExecutionNotStoppableException)
1472
+ o.errors << Shapes::ShapeRef.new(shape: DuplicatedStopRequestException)
1473
+ end)
1474
+
1384
1475
  api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
1385
1476
  o.name = "TagResource"
1386
1477
  o.http_method = "POST"