aws-sdk-codepipeline 1.0.0.rc1

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 ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 59d1991d96fe131efba8ddc8bf833f52a0bdc419
4
+ data.tar.gz: 8cac55ba5c585a91da9b63cdd71104e17f53754c
5
+ SHA512:
6
+ metadata.gz: 907c488514860ae75b47fd1d92db066bd3f083537678fb8689009b3cc27b1ca55c796fc2f642e20892e010921a8ece6a65d03f5044c30acd371731dd7c47a1f2
7
+ data.tar.gz: 2e70910359d4b77402e2276593c6e62fbdf2054d098ae8daf29cfdbc8970405e35cc0281582b24d53b44e3fba471ecf387415d5ad6e4510666e4da5ffdcf399e
@@ -0,0 +1,47 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'aws-sdk-core'
9
+ require 'aws-sigv4'
10
+
11
+ require_relative 'aws-sdk-codepipeline/types'
12
+ require_relative 'aws-sdk-codepipeline/client_api'
13
+ require_relative 'aws-sdk-codepipeline/client'
14
+ require_relative 'aws-sdk-codepipeline/errors'
15
+ require_relative 'aws-sdk-codepipeline/resource'
16
+ require_relative 'aws-sdk-codepipeline/customizations'
17
+
18
+ # This module provides support for AWS CodePipeline. This module is available in the
19
+ # `aws-sdk-codepipeline` gem.
20
+ #
21
+ # # Client
22
+ #
23
+ # The {Client} class provides one method for each API operation. Operation
24
+ # methods each accept a hash of request parameters and return a response
25
+ # structure.
26
+ #
27
+ # See {Client} for more information.
28
+ #
29
+ # # Errors
30
+ #
31
+ # Errors returned from AWS CodePipeline all
32
+ # extend {Errors::ServiceError}.
33
+ #
34
+ # begin
35
+ # # do stuff
36
+ # rescue Aws::CodePipeline::Errors::ServiceError
37
+ # # rescues all service API errors
38
+ # end
39
+ #
40
+ # See {Errors} for more information.
41
+ #
42
+ # @service
43
+ module Aws::CodePipeline
44
+
45
+ GEM_VERSION = '1.0.0.rc1'
46
+
47
+ end
@@ -0,0 +1,1372 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'seahorse/client/plugins/content_length.rb'
9
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
10
+ require 'aws-sdk-core/plugins/logging.rb'
11
+ require 'aws-sdk-core/plugins/param_converter.rb'
12
+ require 'aws-sdk-core/plugins/param_validator.rb'
13
+ require 'aws-sdk-core/plugins/user_agent.rb'
14
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
15
+ require 'aws-sdk-core/plugins/retry_errors.rb'
16
+ require 'aws-sdk-core/plugins/global_configuration.rb'
17
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
+ require 'aws-sdk-core/plugins/response_paging.rb'
19
+ require 'aws-sdk-core/plugins/stub_responses.rb'
20
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
21
+ require 'aws-sdk-core/plugins/signature_v4.rb'
22
+ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
23
+
24
+ Aws::Plugins::GlobalConfiguration.add_identifier(:codepipeline)
25
+
26
+ module Aws
27
+ module CodePipeline
28
+ class Client < Seahorse::Client::Base
29
+
30
+ include Aws::ClientStubs
31
+
32
+ @identifier = :codepipeline
33
+
34
+ set_api(ClientApi::API)
35
+
36
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
37
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
38
+ add_plugin(Aws::Plugins::Logging)
39
+ add_plugin(Aws::Plugins::ParamConverter)
40
+ add_plugin(Aws::Plugins::ParamValidator)
41
+ add_plugin(Aws::Plugins::UserAgent)
42
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
+ add_plugin(Aws::Plugins::RetryErrors)
44
+ add_plugin(Aws::Plugins::GlobalConfiguration)
45
+ add_plugin(Aws::Plugins::RegionalEndpoint)
46
+ add_plugin(Aws::Plugins::ResponsePaging)
47
+ add_plugin(Aws::Plugins::StubResponses)
48
+ add_plugin(Aws::Plugins::IdempotencyToken)
49
+ add_plugin(Aws::Plugins::SignatureV4)
50
+ add_plugin(Aws::Plugins::Protocols::JsonRpc)
51
+
52
+ # @option options [required, Aws::CredentialProvider] :credentials
53
+ # Your AWS credentials. This can be an instance of any one of the
54
+ # following classes:
55
+ #
56
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
57
+ # credentials.
58
+ #
59
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
60
+ # from an EC2 IMDS on an EC2 instance.
61
+ #
62
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
63
+ # shared file, such as `~/.aws/config`.
64
+ #
65
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
66
+ #
67
+ # When `:credentials` are not configured directly, the following
68
+ # locations will be searched for credentials:
69
+ #
70
+ # * `Aws.config[:credentials]`
71
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
72
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
73
+ # * `~/.aws/credentials`
74
+ # * `~/.aws/config`
75
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
76
+ # very aggressive. Construct and pass an instance of
77
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
78
+ # timeouts.
79
+ # @option options [required, String] :region
80
+ # The AWS region to connect to. The configured `:region` is
81
+ # used to determine the service `:endpoint`. When not passed,
82
+ # a default `:region` is search for in the following locations:
83
+ #
84
+ # * `Aws.config[:region]`
85
+ # * `ENV['AWS_REGION']`
86
+ # * `ENV['AMAZON_REGION']`
87
+ # * `ENV['AWS_DEFAULT_REGION']`
88
+ # * `~/.aws/credentials`
89
+ # * `~/.aws/config`
90
+ # @option options [String] :access_key_id
91
+ # @option options [Boolean] :convert_params (true)
92
+ # When `true`, an attempt is made to coerce request parameters into
93
+ # the required types.
94
+ # @option options [String] :endpoint
95
+ # The client endpoint is normally constructed from the `:region`
96
+ # option. You should only configure an `:endpoint` when connecting
97
+ # to test endpoints. This should be avalid HTTP(S) URI.
98
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
99
+ # The log formatter.
100
+ # @option options [Symbol] :log_level (:info)
101
+ # The log level to send messages to the `:logger` at.
102
+ # @option options [Logger] :logger
103
+ # The Logger instance to send log messages to. If this option
104
+ # is not set, logging will be disabled.
105
+ # @option options [String] :profile ("default")
106
+ # Used when loading credentials from the shared credentials file
107
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
108
+ # @option options [Integer] :retry_limit (3)
109
+ # The maximum number of times to retry failed requests. Only
110
+ # ~ 500 level server errors and certain ~ 400 level client errors
111
+ # are retried. Generally, these are throttling errors, data
112
+ # checksum errors, networking errors, timeout errors and auth
113
+ # errors from expired credentials.
114
+ # @option options [String] :secret_access_key
115
+ # @option options [String] :session_token
116
+ # @option options [Boolean] :simple_json (false)
117
+ # Disables request parameter conversion, validation, and formatting.
118
+ # Also disable response data type conversions. This option is useful
119
+ # when you want to ensure the highest level of performance by
120
+ # avoiding overhead of walking request parameters and response data
121
+ # structures.
122
+ #
123
+ # When `:simple_json` is enabled, the request parameters hash must
124
+ # be formatted exactly as the DynamoDB API expects.
125
+ # @option options [Boolean] :stub_responses (false)
126
+ # Causes the client to return stubbed responses. By default
127
+ # fake responses are generated and returned. You can specify
128
+ # the response data to return or errors to raise by calling
129
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
130
+ #
131
+ # ** Please note ** When response stubbing is enabled, no HTTP
132
+ # requests are made, and retries are disabled.
133
+ # @option options [Boolean] :validate_params (true)
134
+ # When `true`, request parameters are validated before
135
+ # sending the request.
136
+ def initialize(*args)
137
+ super
138
+ end
139
+
140
+ # @!group API Operations
141
+
142
+ # Returns information about a specified job and whether that job has
143
+ # been received by the job worker. Only used for custom actions.
144
+ # @option params [required, String] :job_id
145
+ # The unique system-generated ID of the job for which you want to
146
+ # confirm receipt.
147
+ # @option params [required, String] :nonce
148
+ # A system-generated random number that AWS CodePipeline uses to ensure
149
+ # that the job is being worked on by only one job worker. This number
150
+ # must be returned in the response.
151
+ # @return [Types::AcknowledgeJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
152
+ #
153
+ # * {Types::AcknowledgeJobOutput#status #status} => String
154
+ #
155
+ # @example Request syntax with placeholder values
156
+ # resp = client.acknowledge_job({
157
+ # job_id: "JobId", # required
158
+ # nonce: "Nonce", # required
159
+ # })
160
+ #
161
+ # @example Response structure
162
+ # resp.status #=> String, one of "Created", "Queued", "Dispatched", "InProgress", "TimedOut", "Succeeded", "Failed"
163
+ # @overload acknowledge_job(params = {})
164
+ # @param [Hash] params ({})
165
+ def acknowledge_job(params = {}, options = {})
166
+ req = build_request(:acknowledge_job, params)
167
+ req.send_request(options)
168
+ end
169
+
170
+ # Confirms a job worker has received the specified job. Only used for
171
+ # partner actions.
172
+ # @option params [required, String] :job_id
173
+ # The unique system-generated ID of the job.
174
+ # @option params [required, String] :nonce
175
+ # A system-generated random number that AWS CodePipeline uses to ensure
176
+ # that the job is being worked on by only one job worker. This number
177
+ # must be returned in the response.
178
+ # @option params [required, String] :client_token
179
+ # The clientToken portion of the clientId and clientToken pair used to
180
+ # verify that the calling entity is allowed access to the job and its
181
+ # details.
182
+ # @return [Types::AcknowledgeThirdPartyJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
183
+ #
184
+ # * {Types::AcknowledgeThirdPartyJobOutput#status #status} => String
185
+ #
186
+ # @example Request syntax with placeholder values
187
+ # resp = client.acknowledge_third_party_job({
188
+ # job_id: "ThirdPartyJobId", # required
189
+ # nonce: "Nonce", # required
190
+ # client_token: "ClientToken", # required
191
+ # })
192
+ #
193
+ # @example Response structure
194
+ # resp.status #=> String, one of "Created", "Queued", "Dispatched", "InProgress", "TimedOut", "Succeeded", "Failed"
195
+ # @overload acknowledge_third_party_job(params = {})
196
+ # @param [Hash] params ({})
197
+ def acknowledge_third_party_job(params = {}, options = {})
198
+ req = build_request(:acknowledge_third_party_job, params)
199
+ req.send_request(options)
200
+ end
201
+
202
+ # Creates a new custom action that can be used in all pipelines
203
+ # associated with the AWS account. Only used for custom actions.
204
+ # @option params [required, String] :category
205
+ # The category of the custom action, such as a build action or a test
206
+ # action.
207
+ #
208
+ # <note markdown="1"> Although Source and Approval are listed as valid values, they are not
209
+ # currently functional. These values are reserved for future use.
210
+ #
211
+ # </note>
212
+ # @option params [required, String] :provider
213
+ # The provider of the service used in the custom action, such as AWS
214
+ # CodeDeploy.
215
+ # @option params [required, String] :version
216
+ # The version identifier of the custom action.
217
+ # @option params [Types::ActionTypeSettings] :settings
218
+ # Returns information about the settings for an action type.
219
+ # @option params [Array<Types::ActionConfigurationProperty>] :configuration_properties
220
+ # The configuration properties for the custom action.
221
+ #
222
+ # <note markdown="1"> You can refer to a name in the configuration properties of the custom
223
+ # action within the URL templates by following the format of
224
+ # \\\{Config:name\\}, as long as the configuration property is both
225
+ # required and not secret. For more information, see [Create a Custom
226
+ # Action for a Pipeline][1].
227
+ #
228
+ # </note>
229
+ #
230
+ #
231
+ #
232
+ # [1]: http://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html
233
+ # @option params [required, Types::ArtifactDetails] :input_artifact_details
234
+ # Returns information about the details of an artifact.
235
+ # @option params [required, Types::ArtifactDetails] :output_artifact_details
236
+ # Returns information about the details of an artifact.
237
+ # @return [Types::CreateCustomActionTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
238
+ #
239
+ # * {Types::CreateCustomActionTypeOutput#action_type #actionType} => Types::ActionType
240
+ #
241
+ # @example Request syntax with placeholder values
242
+ # resp = client.create_custom_action_type({
243
+ # category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval
244
+ # provider: "ActionProvider", # required
245
+ # version: "Version", # required
246
+ # settings: {
247
+ # third_party_configuration_url: "Url",
248
+ # entity_url_template: "UrlTemplate",
249
+ # execution_url_template: "UrlTemplate",
250
+ # revision_url_template: "UrlTemplate",
251
+ # },
252
+ # configuration_properties: [
253
+ # {
254
+ # name: "ActionConfigurationKey", # required
255
+ # required: false, # required
256
+ # key: false, # required
257
+ # secret: false, # required
258
+ # queryable: false,
259
+ # description: "Description",
260
+ # type: "String", # accepts String, Number, Boolean
261
+ # },
262
+ # ],
263
+ # input_artifact_details: { # required
264
+ # minimum_count: 1, # required
265
+ # maximum_count: 1, # required
266
+ # },
267
+ # output_artifact_details: { # required
268
+ # minimum_count: 1, # required
269
+ # maximum_count: 1, # required
270
+ # },
271
+ # })
272
+ #
273
+ # @example Response structure
274
+ # resp.action_type.id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval"
275
+ # resp.action_type.id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
276
+ # resp.action_type.id.provider #=> String
277
+ # resp.action_type.id.version #=> String
278
+ # resp.action_type.settings.third_party_configuration_url #=> String
279
+ # resp.action_type.settings.entity_url_template #=> String
280
+ # resp.action_type.settings.execution_url_template #=> String
281
+ # resp.action_type.settings.revision_url_template #=> String
282
+ # resp.action_type.action_configuration_properties #=> Array
283
+ # resp.action_type.action_configuration_properties[0].name #=> String
284
+ # resp.action_type.action_configuration_properties[0].required #=> Boolean
285
+ # resp.action_type.action_configuration_properties[0].key #=> Boolean
286
+ # resp.action_type.action_configuration_properties[0].secret #=> Boolean
287
+ # resp.action_type.action_configuration_properties[0].queryable #=> Boolean
288
+ # resp.action_type.action_configuration_properties[0].description #=> String
289
+ # resp.action_type.action_configuration_properties[0].type #=> String, one of "String", "Number", "Boolean"
290
+ # resp.action_type.input_artifact_details.minimum_count #=> Integer
291
+ # resp.action_type.input_artifact_details.maximum_count #=> Integer
292
+ # resp.action_type.output_artifact_details.minimum_count #=> Integer
293
+ # resp.action_type.output_artifact_details.maximum_count #=> Integer
294
+ # @overload create_custom_action_type(params = {})
295
+ # @param [Hash] params ({})
296
+ def create_custom_action_type(params = {}, options = {})
297
+ req = build_request(:create_custom_action_type, params)
298
+ req.send_request(options)
299
+ end
300
+
301
+ # Creates a pipeline.
302
+ # @option params [required, Types::PipelineDeclaration] :pipeline
303
+ # Represents the structure of actions and stages to be performed in the
304
+ # pipeline.
305
+ # @return [Types::CreatePipelineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
306
+ #
307
+ # * {Types::CreatePipelineOutput#pipeline #pipeline} => Types::PipelineDeclaration
308
+ #
309
+ # @example Request syntax with placeholder values
310
+ # resp = client.create_pipeline({
311
+ # pipeline: { # required
312
+ # name: "PipelineName", # required
313
+ # role_arn: "RoleArn", # required
314
+ # artifact_store: { # required
315
+ # type: "S3", # required, accepts S3
316
+ # location: "ArtifactStoreLocation", # required
317
+ # encryption_key: {
318
+ # id: "EncryptionKeyId", # required
319
+ # type: "KMS", # required, accepts KMS
320
+ # },
321
+ # },
322
+ # stages: [ # required
323
+ # {
324
+ # name: "StageName", # required
325
+ # blockers: [
326
+ # {
327
+ # name: "BlockerName", # required
328
+ # type: "Schedule", # required, accepts Schedule
329
+ # },
330
+ # ],
331
+ # actions: [ # required
332
+ # {
333
+ # name: "ActionName", # required
334
+ # action_type_id: { # required
335
+ # category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval
336
+ # owner: "AWS", # required, accepts AWS, ThirdParty, Custom
337
+ # provider: "ActionProvider", # required
338
+ # version: "Version", # required
339
+ # },
340
+ # run_order: 1,
341
+ # configuration: {
342
+ # "ActionConfigurationKey" => "ActionConfigurationValue",
343
+ # },
344
+ # output_artifacts: [
345
+ # {
346
+ # name: "ArtifactName", # required
347
+ # },
348
+ # ],
349
+ # input_artifacts: [
350
+ # {
351
+ # name: "ArtifactName", # required
352
+ # },
353
+ # ],
354
+ # role_arn: "RoleArn",
355
+ # },
356
+ # ],
357
+ # },
358
+ # ],
359
+ # version: 1,
360
+ # },
361
+ # })
362
+ #
363
+ # @example Response structure
364
+ # resp.pipeline.name #=> String
365
+ # resp.pipeline.role_arn #=> String
366
+ # resp.pipeline.artifact_store.type #=> String, one of "S3"
367
+ # resp.pipeline.artifact_store.location #=> String
368
+ # resp.pipeline.artifact_store.encryption_key.id #=> String
369
+ # resp.pipeline.artifact_store.encryption_key.type #=> String, one of "KMS"
370
+ # resp.pipeline.stages #=> Array
371
+ # resp.pipeline.stages[0].name #=> String
372
+ # resp.pipeline.stages[0].blockers #=> Array
373
+ # resp.pipeline.stages[0].blockers[0].name #=> String
374
+ # resp.pipeline.stages[0].blockers[0].type #=> String, one of "Schedule"
375
+ # resp.pipeline.stages[0].actions #=> Array
376
+ # resp.pipeline.stages[0].actions[0].name #=> String
377
+ # resp.pipeline.stages[0].actions[0].action_type_id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval"
378
+ # resp.pipeline.stages[0].actions[0].action_type_id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
379
+ # resp.pipeline.stages[0].actions[0].action_type_id.provider #=> String
380
+ # resp.pipeline.stages[0].actions[0].action_type_id.version #=> String
381
+ # resp.pipeline.stages[0].actions[0].run_order #=> Integer
382
+ # resp.pipeline.stages[0].actions[0].configuration #=> Hash
383
+ # resp.pipeline.stages[0].actions[0].configuration["ActionConfigurationKey"] #=> String
384
+ # resp.pipeline.stages[0].actions[0].output_artifacts #=> Array
385
+ # resp.pipeline.stages[0].actions[0].output_artifacts[0].name #=> String
386
+ # resp.pipeline.stages[0].actions[0].input_artifacts #=> Array
387
+ # resp.pipeline.stages[0].actions[0].input_artifacts[0].name #=> String
388
+ # resp.pipeline.stages[0].actions[0].role_arn #=> String
389
+ # resp.pipeline.version #=> Integer
390
+ # @overload create_pipeline(params = {})
391
+ # @param [Hash] params ({})
392
+ def create_pipeline(params = {}, options = {})
393
+ req = build_request(:create_pipeline, params)
394
+ req.send_request(options)
395
+ end
396
+
397
+ # Marks a custom action as deleted. PollForJobs for the custom action
398
+ # will fail after the action is marked for deletion. Only used for
399
+ # custom actions.
400
+ #
401
+ # You cannot recreate a custom action after it has been deleted unless
402
+ # you increase the version number of the action.
403
+ # @option params [required, String] :category
404
+ # The category of the custom action that you want to delete, such as
405
+ # source or deploy.
406
+ # @option params [required, String] :provider
407
+ # The provider of the service used in the custom action, such as AWS
408
+ # CodeDeploy.
409
+ # @option params [required, String] :version
410
+ # The version of the custom action to delete.
411
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
412
+ #
413
+ # @example Request syntax with placeholder values
414
+ # resp = client.delete_custom_action_type({
415
+ # category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval
416
+ # provider: "ActionProvider", # required
417
+ # version: "Version", # required
418
+ # })
419
+ # @overload delete_custom_action_type(params = {})
420
+ # @param [Hash] params ({})
421
+ def delete_custom_action_type(params = {}, options = {})
422
+ req = build_request(:delete_custom_action_type, params)
423
+ req.send_request(options)
424
+ end
425
+
426
+ # Deletes the specified pipeline.
427
+ # @option params [required, String] :name
428
+ # The name of the pipeline to be deleted.
429
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
430
+ #
431
+ # @example Request syntax with placeholder values
432
+ # resp = client.delete_pipeline({
433
+ # name: "PipelineName", # required
434
+ # })
435
+ # @overload delete_pipeline(params = {})
436
+ # @param [Hash] params ({})
437
+ def delete_pipeline(params = {}, options = {})
438
+ req = build_request(:delete_pipeline, params)
439
+ req.send_request(options)
440
+ end
441
+
442
+ # Prevents artifacts in a pipeline from transitioning to the next stage
443
+ # in the pipeline.
444
+ # @option params [required, String] :pipeline_name
445
+ # The name of the pipeline in which you want to disable the flow of
446
+ # artifacts from one stage to another.
447
+ # @option params [required, String] :stage_name
448
+ # The name of the stage where you want to disable the inbound or
449
+ # outbound transition of artifacts.
450
+ # @option params [required, String] :transition_type
451
+ # Specifies whether artifacts will be prevented from transitioning into
452
+ # the stage and being processed by the actions in that stage (inbound),
453
+ # or prevented from transitioning from the stage after they have been
454
+ # processed by the actions in that stage (outbound).
455
+ # @option params [required, String] :reason
456
+ # The reason given to the user why a stage is disabled, such as waiting
457
+ # for manual approval or manual tests. This message is displayed in the
458
+ # pipeline console UI.
459
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
460
+ #
461
+ # @example Request syntax with placeholder values
462
+ # resp = client.disable_stage_transition({
463
+ # pipeline_name: "PipelineName", # required
464
+ # stage_name: "StageName", # required
465
+ # transition_type: "Inbound", # required, accepts Inbound, Outbound
466
+ # reason: "DisabledReason", # required
467
+ # })
468
+ # @overload disable_stage_transition(params = {})
469
+ # @param [Hash] params ({})
470
+ def disable_stage_transition(params = {}, options = {})
471
+ req = build_request(:disable_stage_transition, params)
472
+ req.send_request(options)
473
+ end
474
+
475
+ # Enables artifacts in a pipeline to transition to a stage in a
476
+ # pipeline.
477
+ # @option params [required, String] :pipeline_name
478
+ # The name of the pipeline in which you want to enable the flow of
479
+ # artifacts from one stage to another.
480
+ # @option params [required, String] :stage_name
481
+ # The name of the stage where you want to enable the transition of
482
+ # artifacts, either into the stage (inbound) or from that stage to the
483
+ # next stage (outbound).
484
+ # @option params [required, String] :transition_type
485
+ # Specifies whether artifacts will be allowed to enter the stage and be
486
+ # processed by the actions in that stage (inbound) or whether
487
+ # already-processed artifacts will be allowed to transition to the next
488
+ # stage (outbound).
489
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
490
+ #
491
+ # @example Request syntax with placeholder values
492
+ # resp = client.enable_stage_transition({
493
+ # pipeline_name: "PipelineName", # required
494
+ # stage_name: "StageName", # required
495
+ # transition_type: "Inbound", # required, accepts Inbound, Outbound
496
+ # })
497
+ # @overload enable_stage_transition(params = {})
498
+ # @param [Hash] params ({})
499
+ def enable_stage_transition(params = {}, options = {})
500
+ req = build_request(:enable_stage_transition, params)
501
+ req.send_request(options)
502
+ end
503
+
504
+ # Returns information about a job. Only used for custom actions.
505
+ #
506
+ # When this API is called, AWS CodePipeline returns temporary
507
+ # credentials for the Amazon S3 bucket used to store artifacts for the
508
+ # pipeline, if the action requires access to that Amazon S3 bucket for
509
+ # input or output artifacts. Additionally, this API returns any secret
510
+ # values defined for the action.
511
+ # @option params [required, String] :job_id
512
+ # The unique system-generated ID for the job.
513
+ # @return [Types::GetJobDetailsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
514
+ #
515
+ # * {Types::GetJobDetailsOutput#job_details #jobDetails} => Types::JobDetails
516
+ #
517
+ # @example Request syntax with placeholder values
518
+ # resp = client.get_job_details({
519
+ # job_id: "JobId", # required
520
+ # })
521
+ #
522
+ # @example Response structure
523
+ # resp.job_details.id #=> String
524
+ # resp.job_details.data.action_type_id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval"
525
+ # resp.job_details.data.action_type_id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
526
+ # resp.job_details.data.action_type_id.provider #=> String
527
+ # resp.job_details.data.action_type_id.version #=> String
528
+ # resp.job_details.data.action_configuration.configuration #=> Hash
529
+ # resp.job_details.data.action_configuration.configuration["ActionConfigurationKey"] #=> String
530
+ # resp.job_details.data.pipeline_context.pipeline_name #=> String
531
+ # resp.job_details.data.pipeline_context.stage.name #=> String
532
+ # resp.job_details.data.pipeline_context.action.name #=> String
533
+ # resp.job_details.data.input_artifacts #=> Array
534
+ # resp.job_details.data.input_artifacts[0].name #=> String
535
+ # resp.job_details.data.input_artifacts[0].revision #=> String
536
+ # resp.job_details.data.input_artifacts[0].location.type #=> String, one of "S3"
537
+ # resp.job_details.data.input_artifacts[0].location.s3_location.bucket_name #=> String
538
+ # resp.job_details.data.input_artifacts[0].location.s3_location.object_key #=> String
539
+ # resp.job_details.data.output_artifacts #=> Array
540
+ # resp.job_details.data.output_artifacts[0].name #=> String
541
+ # resp.job_details.data.output_artifacts[0].revision #=> String
542
+ # resp.job_details.data.output_artifacts[0].location.type #=> String, one of "S3"
543
+ # resp.job_details.data.output_artifacts[0].location.s3_location.bucket_name #=> String
544
+ # resp.job_details.data.output_artifacts[0].location.s3_location.object_key #=> String
545
+ # resp.job_details.data.artifact_credentials.access_key_id #=> String
546
+ # resp.job_details.data.artifact_credentials.secret_access_key #=> String
547
+ # resp.job_details.data.artifact_credentials.session_token #=> String
548
+ # resp.job_details.data.continuation_token #=> String
549
+ # resp.job_details.data.encryption_key.id #=> String
550
+ # resp.job_details.data.encryption_key.type #=> String, one of "KMS"
551
+ # resp.job_details.account_id #=> String
552
+ # @overload get_job_details(params = {})
553
+ # @param [Hash] params ({})
554
+ def get_job_details(params = {}, options = {})
555
+ req = build_request(:get_job_details, params)
556
+ req.send_request(options)
557
+ end
558
+
559
+ # Returns the metadata, structure, stages, and actions of a pipeline.
560
+ # Can be used to return the entire structure of a pipeline in JSON
561
+ # format, which can then be modified and used to update the pipeline
562
+ # structure with UpdatePipeline.
563
+ # @option params [required, String] :name
564
+ # The name of the pipeline for which you want to get information.
565
+ # Pipeline names must be unique under an Amazon Web Services (AWS) user
566
+ # account.
567
+ # @option params [Integer] :version
568
+ # The version number of the pipeline. If you do not specify a version,
569
+ # defaults to the most current version.
570
+ # @return [Types::GetPipelineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
571
+ #
572
+ # * {Types::GetPipelineOutput#pipeline #pipeline} => Types::PipelineDeclaration
573
+ #
574
+ # @example Request syntax with placeholder values
575
+ # resp = client.get_pipeline({
576
+ # name: "PipelineName", # required
577
+ # version: 1,
578
+ # })
579
+ #
580
+ # @example Response structure
581
+ # resp.pipeline.name #=> String
582
+ # resp.pipeline.role_arn #=> String
583
+ # resp.pipeline.artifact_store.type #=> String, one of "S3"
584
+ # resp.pipeline.artifact_store.location #=> String
585
+ # resp.pipeline.artifact_store.encryption_key.id #=> String
586
+ # resp.pipeline.artifact_store.encryption_key.type #=> String, one of "KMS"
587
+ # resp.pipeline.stages #=> Array
588
+ # resp.pipeline.stages[0].name #=> String
589
+ # resp.pipeline.stages[0].blockers #=> Array
590
+ # resp.pipeline.stages[0].blockers[0].name #=> String
591
+ # resp.pipeline.stages[0].blockers[0].type #=> String, one of "Schedule"
592
+ # resp.pipeline.stages[0].actions #=> Array
593
+ # resp.pipeline.stages[0].actions[0].name #=> String
594
+ # resp.pipeline.stages[0].actions[0].action_type_id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval"
595
+ # resp.pipeline.stages[0].actions[0].action_type_id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
596
+ # resp.pipeline.stages[0].actions[0].action_type_id.provider #=> String
597
+ # resp.pipeline.stages[0].actions[0].action_type_id.version #=> String
598
+ # resp.pipeline.stages[0].actions[0].run_order #=> Integer
599
+ # resp.pipeline.stages[0].actions[0].configuration #=> Hash
600
+ # resp.pipeline.stages[0].actions[0].configuration["ActionConfigurationKey"] #=> String
601
+ # resp.pipeline.stages[0].actions[0].output_artifacts #=> Array
602
+ # resp.pipeline.stages[0].actions[0].output_artifacts[0].name #=> String
603
+ # resp.pipeline.stages[0].actions[0].input_artifacts #=> Array
604
+ # resp.pipeline.stages[0].actions[0].input_artifacts[0].name #=> String
605
+ # resp.pipeline.stages[0].actions[0].role_arn #=> String
606
+ # resp.pipeline.version #=> Integer
607
+ # @overload get_pipeline(params = {})
608
+ # @param [Hash] params ({})
609
+ def get_pipeline(params = {}, options = {})
610
+ req = build_request(:get_pipeline, params)
611
+ req.send_request(options)
612
+ end
613
+
614
+ # Returns information about an execution of a pipeline, including
615
+ # details about artifacts, the pipeline execution ID, and the name,
616
+ # version, and status of the pipeline.
617
+ # @option params [required, String] :pipeline_name
618
+ # The name of the pipeline about which you want to get execution
619
+ # details.
620
+ # @option params [required, String] :pipeline_execution_id
621
+ # The ID of the pipeline execution about which you want to get execution
622
+ # details.
623
+ # @return [Types::GetPipelineExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
624
+ #
625
+ # * {Types::GetPipelineExecutionOutput#pipeline_execution #pipelineExecution} => Types::PipelineExecution
626
+ #
627
+ # @example Request syntax with placeholder values
628
+ # resp = client.get_pipeline_execution({
629
+ # pipeline_name: "PipelineName", # required
630
+ # pipeline_execution_id: "PipelineExecutionId", # required
631
+ # })
632
+ #
633
+ # @example Response structure
634
+ # resp.pipeline_execution.pipeline_name #=> String
635
+ # resp.pipeline_execution.pipeline_version #=> Integer
636
+ # resp.pipeline_execution.pipeline_execution_id #=> String
637
+ # resp.pipeline_execution.status #=> String, one of "InProgress", "Succeeded", "Superseded", "Failed"
638
+ # resp.pipeline_execution.artifact_revisions #=> Array
639
+ # resp.pipeline_execution.artifact_revisions[0].name #=> String
640
+ # resp.pipeline_execution.artifact_revisions[0].revision_id #=> String
641
+ # resp.pipeline_execution.artifact_revisions[0].revision_change_identifier #=> String
642
+ # resp.pipeline_execution.artifact_revisions[0].revision_summary #=> String
643
+ # resp.pipeline_execution.artifact_revisions[0].created #=> Time
644
+ # resp.pipeline_execution.artifact_revisions[0].revision_url #=> String
645
+ # @overload get_pipeline_execution(params = {})
646
+ # @param [Hash] params ({})
647
+ def get_pipeline_execution(params = {}, options = {})
648
+ req = build_request(:get_pipeline_execution, params)
649
+ req.send_request(options)
650
+ end
651
+
652
+ # Returns information about the state of a pipeline, including the
653
+ # stages and actions.
654
+ # @option params [required, String] :name
655
+ # The name of the pipeline about which you want to get information.
656
+ # @return [Types::GetPipelineStateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
657
+ #
658
+ # * {Types::GetPipelineStateOutput#pipeline_name #pipelineName} => String
659
+ # * {Types::GetPipelineStateOutput#pipeline_version #pipelineVersion} => Integer
660
+ # * {Types::GetPipelineStateOutput#stage_states #stageStates} => Array&lt;Types::StageState&gt;
661
+ # * {Types::GetPipelineStateOutput#created #created} => Time
662
+ # * {Types::GetPipelineStateOutput#updated #updated} => Time
663
+ #
664
+ # @example Request syntax with placeholder values
665
+ # resp = client.get_pipeline_state({
666
+ # name: "PipelineName", # required
667
+ # })
668
+ #
669
+ # @example Response structure
670
+ # resp.pipeline_name #=> String
671
+ # resp.pipeline_version #=> Integer
672
+ # resp.stage_states #=> Array
673
+ # resp.stage_states[0].stage_name #=> String
674
+ # resp.stage_states[0].inbound_transition_state.enabled #=> Boolean
675
+ # resp.stage_states[0].inbound_transition_state.last_changed_by #=> String
676
+ # resp.stage_states[0].inbound_transition_state.last_changed_at #=> Time
677
+ # resp.stage_states[0].inbound_transition_state.disabled_reason #=> String
678
+ # resp.stage_states[0].action_states #=> Array
679
+ # resp.stage_states[0].action_states[0].action_name #=> String
680
+ # resp.stage_states[0].action_states[0].current_revision.revision_id #=> String
681
+ # resp.stage_states[0].action_states[0].current_revision.revision_change_id #=> String
682
+ # resp.stage_states[0].action_states[0].current_revision.created #=> Time
683
+ # resp.stage_states[0].action_states[0].latest_execution.status #=> String, one of "InProgress", "Succeeded", "Failed"
684
+ # resp.stage_states[0].action_states[0].latest_execution.summary #=> String
685
+ # resp.stage_states[0].action_states[0].latest_execution.last_status_change #=> Time
686
+ # resp.stage_states[0].action_states[0].latest_execution.token #=> String
687
+ # resp.stage_states[0].action_states[0].latest_execution.last_updated_by #=> String
688
+ # resp.stage_states[0].action_states[0].latest_execution.external_execution_id #=> String
689
+ # resp.stage_states[0].action_states[0].latest_execution.external_execution_url #=> String
690
+ # resp.stage_states[0].action_states[0].latest_execution.percent_complete #=> Integer
691
+ # resp.stage_states[0].action_states[0].latest_execution.error_details.code #=> String
692
+ # resp.stage_states[0].action_states[0].latest_execution.error_details.message #=> String
693
+ # resp.stage_states[0].action_states[0].entity_url #=> String
694
+ # resp.stage_states[0].action_states[0].revision_url #=> String
695
+ # resp.stage_states[0].latest_execution.pipeline_execution_id #=> String
696
+ # resp.stage_states[0].latest_execution.status #=> String, one of "InProgress", "Failed", "Succeeded"
697
+ # resp.created #=> Time
698
+ # resp.updated #=> Time
699
+ # @overload get_pipeline_state(params = {})
700
+ # @param [Hash] params ({})
701
+ def get_pipeline_state(params = {}, options = {})
702
+ req = build_request(:get_pipeline_state, params)
703
+ req.send_request(options)
704
+ end
705
+
706
+ # Requests the details of a job for a third party action. Only used for
707
+ # partner actions.
708
+ #
709
+ # When this API is called, AWS CodePipeline returns temporary
710
+ # credentials for the Amazon S3 bucket used to store artifacts for the
711
+ # pipeline, if the action requires access to that Amazon S3 bucket for
712
+ # input or output artifacts. Additionally, this API returns any secret
713
+ # values defined for the action.
714
+ # @option params [required, String] :job_id
715
+ # The unique system-generated ID used for identifying the job.
716
+ # @option params [required, String] :client_token
717
+ # The clientToken portion of the clientId and clientToken pair used to
718
+ # verify that the calling entity is allowed access to the job and its
719
+ # details.
720
+ # @return [Types::GetThirdPartyJobDetailsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
721
+ #
722
+ # * {Types::GetThirdPartyJobDetailsOutput#job_details #jobDetails} => Types::ThirdPartyJobDetails
723
+ #
724
+ # @example Request syntax with placeholder values
725
+ # resp = client.get_third_party_job_details({
726
+ # job_id: "ThirdPartyJobId", # required
727
+ # client_token: "ClientToken", # required
728
+ # })
729
+ #
730
+ # @example Response structure
731
+ # resp.job_details.id #=> String
732
+ # resp.job_details.data.action_type_id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval"
733
+ # resp.job_details.data.action_type_id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
734
+ # resp.job_details.data.action_type_id.provider #=> String
735
+ # resp.job_details.data.action_type_id.version #=> String
736
+ # resp.job_details.data.action_configuration.configuration #=> Hash
737
+ # resp.job_details.data.action_configuration.configuration["ActionConfigurationKey"] #=> String
738
+ # resp.job_details.data.pipeline_context.pipeline_name #=> String
739
+ # resp.job_details.data.pipeline_context.stage.name #=> String
740
+ # resp.job_details.data.pipeline_context.action.name #=> String
741
+ # resp.job_details.data.input_artifacts #=> Array
742
+ # resp.job_details.data.input_artifacts[0].name #=> String
743
+ # resp.job_details.data.input_artifacts[0].revision #=> String
744
+ # resp.job_details.data.input_artifacts[0].location.type #=> String, one of "S3"
745
+ # resp.job_details.data.input_artifacts[0].location.s3_location.bucket_name #=> String
746
+ # resp.job_details.data.input_artifacts[0].location.s3_location.object_key #=> String
747
+ # resp.job_details.data.output_artifacts #=> Array
748
+ # resp.job_details.data.output_artifacts[0].name #=> String
749
+ # resp.job_details.data.output_artifacts[0].revision #=> String
750
+ # resp.job_details.data.output_artifacts[0].location.type #=> String, one of "S3"
751
+ # resp.job_details.data.output_artifacts[0].location.s3_location.bucket_name #=> String
752
+ # resp.job_details.data.output_artifacts[0].location.s3_location.object_key #=> String
753
+ # resp.job_details.data.artifact_credentials.access_key_id #=> String
754
+ # resp.job_details.data.artifact_credentials.secret_access_key #=> String
755
+ # resp.job_details.data.artifact_credentials.session_token #=> String
756
+ # resp.job_details.data.continuation_token #=> String
757
+ # resp.job_details.data.encryption_key.id #=> String
758
+ # resp.job_details.data.encryption_key.type #=> String, one of "KMS"
759
+ # resp.job_details.nonce #=> String
760
+ # @overload get_third_party_job_details(params = {})
761
+ # @param [Hash] params ({})
762
+ def get_third_party_job_details(params = {}, options = {})
763
+ req = build_request(:get_third_party_job_details, params)
764
+ req.send_request(options)
765
+ end
766
+
767
+ # Gets a summary of all AWS CodePipeline action types associated with
768
+ # your account.
769
+ # @option params [String] :action_owner_filter
770
+ # Filters the list of action types to those created by a specified
771
+ # entity.
772
+ # @option params [String] :next_token
773
+ # An identifier that was returned from the previous list action types
774
+ # call, which can be used to return the next set of action types in the
775
+ # list.
776
+ # @return [Types::ListActionTypesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
777
+ #
778
+ # * {Types::ListActionTypesOutput#action_types #actionTypes} => Array&lt;Types::ActionType&gt;
779
+ # * {Types::ListActionTypesOutput#next_token #nextToken} => String
780
+ #
781
+ # @example Request syntax with placeholder values
782
+ # resp = client.list_action_types({
783
+ # action_owner_filter: "AWS", # accepts AWS, ThirdParty, Custom
784
+ # next_token: "NextToken",
785
+ # })
786
+ #
787
+ # @example Response structure
788
+ # resp.action_types #=> Array
789
+ # resp.action_types[0].id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval"
790
+ # resp.action_types[0].id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
791
+ # resp.action_types[0].id.provider #=> String
792
+ # resp.action_types[0].id.version #=> String
793
+ # resp.action_types[0].settings.third_party_configuration_url #=> String
794
+ # resp.action_types[0].settings.entity_url_template #=> String
795
+ # resp.action_types[0].settings.execution_url_template #=> String
796
+ # resp.action_types[0].settings.revision_url_template #=> String
797
+ # resp.action_types[0].action_configuration_properties #=> Array
798
+ # resp.action_types[0].action_configuration_properties[0].name #=> String
799
+ # resp.action_types[0].action_configuration_properties[0].required #=> Boolean
800
+ # resp.action_types[0].action_configuration_properties[0].key #=> Boolean
801
+ # resp.action_types[0].action_configuration_properties[0].secret #=> Boolean
802
+ # resp.action_types[0].action_configuration_properties[0].queryable #=> Boolean
803
+ # resp.action_types[0].action_configuration_properties[0].description #=> String
804
+ # resp.action_types[0].action_configuration_properties[0].type #=> String, one of "String", "Number", "Boolean"
805
+ # resp.action_types[0].input_artifact_details.minimum_count #=> Integer
806
+ # resp.action_types[0].input_artifact_details.maximum_count #=> Integer
807
+ # resp.action_types[0].output_artifact_details.minimum_count #=> Integer
808
+ # resp.action_types[0].output_artifact_details.maximum_count #=> Integer
809
+ # resp.next_token #=> String
810
+ # @overload list_action_types(params = {})
811
+ # @param [Hash] params ({})
812
+ def list_action_types(params = {}, options = {})
813
+ req = build_request(:list_action_types, params)
814
+ req.send_request(options)
815
+ end
816
+
817
+ # Gets a summary of all of the pipelines associated with your account.
818
+ # @option params [String] :next_token
819
+ # An identifier that was returned from the previous list pipelines call,
820
+ # which can be used to return the next set of pipelines in the list.
821
+ # @return [Types::ListPipelinesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
822
+ #
823
+ # * {Types::ListPipelinesOutput#pipelines #pipelines} => Array&lt;Types::PipelineSummary&gt;
824
+ # * {Types::ListPipelinesOutput#next_token #nextToken} => String
825
+ #
826
+ # @example Request syntax with placeholder values
827
+ # resp = client.list_pipelines({
828
+ # next_token: "NextToken",
829
+ # })
830
+ #
831
+ # @example Response structure
832
+ # resp.pipelines #=> Array
833
+ # resp.pipelines[0].name #=> String
834
+ # resp.pipelines[0].version #=> Integer
835
+ # resp.pipelines[0].created #=> Time
836
+ # resp.pipelines[0].updated #=> Time
837
+ # resp.next_token #=> String
838
+ # @overload list_pipelines(params = {})
839
+ # @param [Hash] params ({})
840
+ def list_pipelines(params = {}, options = {})
841
+ req = build_request(:list_pipelines, params)
842
+ req.send_request(options)
843
+ end
844
+
845
+ # Returns information about any jobs for AWS CodePipeline to act upon.
846
+ #
847
+ # When this API is called, AWS CodePipeline returns temporary
848
+ # credentials for the Amazon S3 bucket used to store artifacts for the
849
+ # pipeline, if the action requires access to that Amazon S3 bucket for
850
+ # input or output artifacts. Additionally, this API returns any secret
851
+ # values defined for the action.
852
+ # @option params [required, Types::ActionTypeId] :action_type_id
853
+ # Represents information about an action type.
854
+ # @option params [Integer] :max_batch_size
855
+ # The maximum number of jobs to return in a poll for jobs call.
856
+ # @option params [Hash<String,String>] :query_param
857
+ # A map of property names and values. For an action type with no
858
+ # queryable properties, this value must be null or an empty map. For an
859
+ # action type with a queryable property, you must supply that property
860
+ # as a key in the map. Only jobs whose action configuration matches the
861
+ # mapped value will be returned.
862
+ # @return [Types::PollForJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
863
+ #
864
+ # * {Types::PollForJobsOutput#jobs #jobs} => Array&lt;Types::Job&gt;
865
+ #
866
+ # @example Request syntax with placeholder values
867
+ # resp = client.poll_for_jobs({
868
+ # action_type_id: { # required
869
+ # category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval
870
+ # owner: "AWS", # required, accepts AWS, ThirdParty, Custom
871
+ # provider: "ActionProvider", # required
872
+ # version: "Version", # required
873
+ # },
874
+ # max_batch_size: 1,
875
+ # query_param: {
876
+ # "ActionConfigurationKey" => "ActionConfigurationQueryableValue",
877
+ # },
878
+ # })
879
+ #
880
+ # @example Response structure
881
+ # resp.jobs #=> Array
882
+ # resp.jobs[0].id #=> String
883
+ # resp.jobs[0].data.action_type_id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval"
884
+ # resp.jobs[0].data.action_type_id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
885
+ # resp.jobs[0].data.action_type_id.provider #=> String
886
+ # resp.jobs[0].data.action_type_id.version #=> String
887
+ # resp.jobs[0].data.action_configuration.configuration #=> Hash
888
+ # resp.jobs[0].data.action_configuration.configuration["ActionConfigurationKey"] #=> String
889
+ # resp.jobs[0].data.pipeline_context.pipeline_name #=> String
890
+ # resp.jobs[0].data.pipeline_context.stage.name #=> String
891
+ # resp.jobs[0].data.pipeline_context.action.name #=> String
892
+ # resp.jobs[0].data.input_artifacts #=> Array
893
+ # resp.jobs[0].data.input_artifacts[0].name #=> String
894
+ # resp.jobs[0].data.input_artifacts[0].revision #=> String
895
+ # resp.jobs[0].data.input_artifacts[0].location.type #=> String, one of "S3"
896
+ # resp.jobs[0].data.input_artifacts[0].location.s3_location.bucket_name #=> String
897
+ # resp.jobs[0].data.input_artifacts[0].location.s3_location.object_key #=> String
898
+ # resp.jobs[0].data.output_artifacts #=> Array
899
+ # resp.jobs[0].data.output_artifacts[0].name #=> String
900
+ # resp.jobs[0].data.output_artifacts[0].revision #=> String
901
+ # resp.jobs[0].data.output_artifacts[0].location.type #=> String, one of "S3"
902
+ # resp.jobs[0].data.output_artifacts[0].location.s3_location.bucket_name #=> String
903
+ # resp.jobs[0].data.output_artifacts[0].location.s3_location.object_key #=> String
904
+ # resp.jobs[0].data.artifact_credentials.access_key_id #=> String
905
+ # resp.jobs[0].data.artifact_credentials.secret_access_key #=> String
906
+ # resp.jobs[0].data.artifact_credentials.session_token #=> String
907
+ # resp.jobs[0].data.continuation_token #=> String
908
+ # resp.jobs[0].data.encryption_key.id #=> String
909
+ # resp.jobs[0].data.encryption_key.type #=> String, one of "KMS"
910
+ # resp.jobs[0].nonce #=> String
911
+ # resp.jobs[0].account_id #=> String
912
+ # @overload poll_for_jobs(params = {})
913
+ # @param [Hash] params ({})
914
+ def poll_for_jobs(params = {}, options = {})
915
+ req = build_request(:poll_for_jobs, params)
916
+ req.send_request(options)
917
+ end
918
+
919
+ # Determines whether there are any third party jobs for a job worker to
920
+ # act on. Only used for partner actions.
921
+ #
922
+ # When this API is called, AWS CodePipeline returns temporary
923
+ # credentials for the Amazon S3 bucket used to store artifacts for the
924
+ # pipeline, if the action requires access to that Amazon S3 bucket for
925
+ # input or output artifacts.
926
+ # @option params [required, Types::ActionTypeId] :action_type_id
927
+ # Represents information about an action type.
928
+ # @option params [Integer] :max_batch_size
929
+ # The maximum number of jobs to return in a poll for jobs call.
930
+ # @return [Types::PollForThirdPartyJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
931
+ #
932
+ # * {Types::PollForThirdPartyJobsOutput#jobs #jobs} => Array&lt;Types::ThirdPartyJob&gt;
933
+ #
934
+ # @example Request syntax with placeholder values
935
+ # resp = client.poll_for_third_party_jobs({
936
+ # action_type_id: { # required
937
+ # category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval
938
+ # owner: "AWS", # required, accepts AWS, ThirdParty, Custom
939
+ # provider: "ActionProvider", # required
940
+ # version: "Version", # required
941
+ # },
942
+ # max_batch_size: 1,
943
+ # })
944
+ #
945
+ # @example Response structure
946
+ # resp.jobs #=> Array
947
+ # resp.jobs[0].client_id #=> String
948
+ # resp.jobs[0].job_id #=> String
949
+ # @overload poll_for_third_party_jobs(params = {})
950
+ # @param [Hash] params ({})
951
+ def poll_for_third_party_jobs(params = {}, options = {})
952
+ req = build_request(:poll_for_third_party_jobs, params)
953
+ req.send_request(options)
954
+ end
955
+
956
+ # Provides information to AWS CodePipeline about new revisions to a
957
+ # source.
958
+ # @option params [required, String] :pipeline_name
959
+ # The name of the pipeline that will start processing the revision to
960
+ # the source.
961
+ # @option params [required, String] :stage_name
962
+ # The name of the stage that contains the action that will act upon the
963
+ # revision.
964
+ # @option params [required, String] :action_name
965
+ # The name of the action that will process the revision.
966
+ # @option params [required, Types::ActionRevision] :action_revision
967
+ # Represents information about the version (or revision) of an action.
968
+ # @return [Types::PutActionRevisionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
969
+ #
970
+ # * {Types::PutActionRevisionOutput#new_revision #newRevision} => Boolean
971
+ # * {Types::PutActionRevisionOutput#pipeline_execution_id #pipelineExecutionId} => String
972
+ #
973
+ # @example Request syntax with placeholder values
974
+ # resp = client.put_action_revision({
975
+ # pipeline_name: "PipelineName", # required
976
+ # stage_name: "StageName", # required
977
+ # action_name: "ActionName", # required
978
+ # action_revision: { # required
979
+ # revision_id: "Revision", # required
980
+ # revision_change_id: "RevisionChangeIdentifier", # required
981
+ # created: Time.now, # required
982
+ # },
983
+ # })
984
+ #
985
+ # @example Response structure
986
+ # resp.new_revision #=> Boolean
987
+ # resp.pipeline_execution_id #=> String
988
+ # @overload put_action_revision(params = {})
989
+ # @param [Hash] params ({})
990
+ def put_action_revision(params = {}, options = {})
991
+ req = build_request(:put_action_revision, params)
992
+ req.send_request(options)
993
+ end
994
+
995
+ # Provides the response to a manual approval request to AWS
996
+ # CodePipeline. Valid responses include Approved and Rejected.
997
+ # @option params [required, String] :pipeline_name
998
+ # The name of the pipeline that contains the action.
999
+ # @option params [required, String] :stage_name
1000
+ # The name of the stage that contains the action.
1001
+ # @option params [required, String] :action_name
1002
+ # The name of the action for which approval is requested.
1003
+ # @option params [required, Types::ApprovalResult] :result
1004
+ # Represents information about the result of the approval request.
1005
+ # @option params [required, String] :token
1006
+ # The system-generated token used to identify a unique approval request.
1007
+ # The token for each open approval request can be obtained using the
1008
+ # GetPipelineState action and is used to validate that the approval
1009
+ # request corresponding to this token is still valid.
1010
+ # @return [Types::PutApprovalResultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1011
+ #
1012
+ # * {Types::PutApprovalResultOutput#approved_at #approvedAt} => Time
1013
+ #
1014
+ # @example Request syntax with placeholder values
1015
+ # resp = client.put_approval_result({
1016
+ # pipeline_name: "PipelineName", # required
1017
+ # stage_name: "StageName", # required
1018
+ # action_name: "ActionName", # required
1019
+ # result: { # required
1020
+ # summary: "ApprovalSummary", # required
1021
+ # status: "Approved", # required, accepts Approved, Rejected
1022
+ # },
1023
+ # token: "ApprovalToken", # required
1024
+ # })
1025
+ #
1026
+ # @example Response structure
1027
+ # resp.approved_at #=> Time
1028
+ # @overload put_approval_result(params = {})
1029
+ # @param [Hash] params ({})
1030
+ def put_approval_result(params = {}, options = {})
1031
+ req = build_request(:put_approval_result, params)
1032
+ req.send_request(options)
1033
+ end
1034
+
1035
+ # Represents the failure of a job as returned to the pipeline by a job
1036
+ # worker. Only used for custom actions.
1037
+ # @option params [required, String] :job_id
1038
+ # The unique system-generated ID of the job that failed. This is the
1039
+ # same ID returned from PollForJobs.
1040
+ # @option params [required, Types::FailureDetails] :failure_details
1041
+ # The details about the failure of a job.
1042
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1043
+ #
1044
+ # @example Request syntax with placeholder values
1045
+ # resp = client.put_job_failure_result({
1046
+ # job_id: "JobId", # required
1047
+ # failure_details: { # required
1048
+ # type: "JobFailed", # required, accepts JobFailed, ConfigurationError, PermissionError, RevisionOutOfSync, RevisionUnavailable, SystemUnavailable
1049
+ # message: "Message", # required
1050
+ # external_execution_id: "ExecutionId",
1051
+ # },
1052
+ # })
1053
+ # @overload put_job_failure_result(params = {})
1054
+ # @param [Hash] params ({})
1055
+ def put_job_failure_result(params = {}, options = {})
1056
+ req = build_request(:put_job_failure_result, params)
1057
+ req.send_request(options)
1058
+ end
1059
+
1060
+ # Represents the success of a job as returned to the pipeline by a job
1061
+ # worker. Only used for custom actions.
1062
+ # @option params [required, String] :job_id
1063
+ # The unique system-generated ID of the job that succeeded. This is the
1064
+ # same ID returned from PollForJobs.
1065
+ # @option params [Types::CurrentRevision] :current_revision
1066
+ # The ID of the current revision of the artifact successfully worked
1067
+ # upon by the job.
1068
+ # @option params [String] :continuation_token
1069
+ # A token generated by a job worker, such as an AWS CodeDeploy
1070
+ # deployment ID, that a successful job provides to identify a custom
1071
+ # action in progress. Future jobs will use this token in order to
1072
+ # identify the running instance of the action. It can be reused to
1073
+ # return additional information about the progress of the custom action.
1074
+ # When the action is complete, no continuation token should be supplied.
1075
+ # @option params [Types::ExecutionDetails] :execution_details
1076
+ # The execution details of the successful job, such as the actions taken
1077
+ # by the job worker.
1078
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1079
+ #
1080
+ # @example Request syntax with placeholder values
1081
+ # resp = client.put_job_success_result({
1082
+ # job_id: "JobId", # required
1083
+ # current_revision: {
1084
+ # revision: "Revision", # required
1085
+ # change_identifier: "RevisionChangeIdentifier", # required
1086
+ # created: Time.now,
1087
+ # revision_summary: "RevisionSummary",
1088
+ # },
1089
+ # continuation_token: "ContinuationToken",
1090
+ # execution_details: {
1091
+ # summary: "ExecutionSummary",
1092
+ # external_execution_id: "ExecutionId",
1093
+ # percent_complete: 1,
1094
+ # },
1095
+ # })
1096
+ # @overload put_job_success_result(params = {})
1097
+ # @param [Hash] params ({})
1098
+ def put_job_success_result(params = {}, options = {})
1099
+ req = build_request(:put_job_success_result, params)
1100
+ req.send_request(options)
1101
+ end
1102
+
1103
+ # Represents the failure of a third party job as returned to the
1104
+ # pipeline by a job worker. Only used for partner actions.
1105
+ # @option params [required, String] :job_id
1106
+ # The ID of the job that failed. This is the same ID returned from
1107
+ # PollForThirdPartyJobs.
1108
+ # @option params [required, String] :client_token
1109
+ # The clientToken portion of the clientId and clientToken pair used to
1110
+ # verify that the calling entity is allowed access to the job and its
1111
+ # details.
1112
+ # @option params [required, Types::FailureDetails] :failure_details
1113
+ # Represents information about failure details.
1114
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1115
+ #
1116
+ # @example Request syntax with placeholder values
1117
+ # resp = client.put_third_party_job_failure_result({
1118
+ # job_id: "ThirdPartyJobId", # required
1119
+ # client_token: "ClientToken", # required
1120
+ # failure_details: { # required
1121
+ # type: "JobFailed", # required, accepts JobFailed, ConfigurationError, PermissionError, RevisionOutOfSync, RevisionUnavailable, SystemUnavailable
1122
+ # message: "Message", # required
1123
+ # external_execution_id: "ExecutionId",
1124
+ # },
1125
+ # })
1126
+ # @overload put_third_party_job_failure_result(params = {})
1127
+ # @param [Hash] params ({})
1128
+ def put_third_party_job_failure_result(params = {}, options = {})
1129
+ req = build_request(:put_third_party_job_failure_result, params)
1130
+ req.send_request(options)
1131
+ end
1132
+
1133
+ # Represents the success of a third party job as returned to the
1134
+ # pipeline by a job worker. Only used for partner actions.
1135
+ # @option params [required, String] :job_id
1136
+ # The ID of the job that successfully completed. This is the same ID
1137
+ # returned from PollForThirdPartyJobs.
1138
+ # @option params [required, String] :client_token
1139
+ # The clientToken portion of the clientId and clientToken pair used to
1140
+ # verify that the calling entity is allowed access to the job and its
1141
+ # details.
1142
+ # @option params [Types::CurrentRevision] :current_revision
1143
+ # Represents information about a current revision.
1144
+ # @option params [String] :continuation_token
1145
+ # A token generated by a job worker, such as an AWS CodeDeploy
1146
+ # deployment ID, that a successful job provides to identify a partner
1147
+ # action in progress. Future jobs will use this token in order to
1148
+ # identify the running instance of the action. It can be reused to
1149
+ # return additional information about the progress of the partner
1150
+ # action. When the action is complete, no continuation token should be
1151
+ # supplied.
1152
+ # @option params [Types::ExecutionDetails] :execution_details
1153
+ # The details of the actions taken and results produced on an artifact
1154
+ # as it passes through stages in the pipeline.
1155
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1156
+ #
1157
+ # @example Request syntax with placeholder values
1158
+ # resp = client.put_third_party_job_success_result({
1159
+ # job_id: "ThirdPartyJobId", # required
1160
+ # client_token: "ClientToken", # required
1161
+ # current_revision: {
1162
+ # revision: "Revision", # required
1163
+ # change_identifier: "RevisionChangeIdentifier", # required
1164
+ # created: Time.now,
1165
+ # revision_summary: "RevisionSummary",
1166
+ # },
1167
+ # continuation_token: "ContinuationToken",
1168
+ # execution_details: {
1169
+ # summary: "ExecutionSummary",
1170
+ # external_execution_id: "ExecutionId",
1171
+ # percent_complete: 1,
1172
+ # },
1173
+ # })
1174
+ # @overload put_third_party_job_success_result(params = {})
1175
+ # @param [Hash] params ({})
1176
+ def put_third_party_job_success_result(params = {}, options = {})
1177
+ req = build_request(:put_third_party_job_success_result, params)
1178
+ req.send_request(options)
1179
+ end
1180
+
1181
+ # Resumes the pipeline execution by retrying the last failed actions in
1182
+ # a stage.
1183
+ # @option params [required, String] :pipeline_name
1184
+ # The name of the pipeline that contains the failed stage.
1185
+ # @option params [required, String] :stage_name
1186
+ # The name of the failed stage to be retried.
1187
+ # @option params [required, String] :pipeline_execution_id
1188
+ # The ID of the pipeline execution in the failed stage to be retried.
1189
+ # Use the GetPipelineState action to retrieve the current
1190
+ # pipelineExecutionId of the failed stage
1191
+ # @option params [required, String] :retry_mode
1192
+ # The scope of the retry attempt. Currently, the only supported value is
1193
+ # FAILED\_ACTIONS.
1194
+ # @return [Types::RetryStageExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1195
+ #
1196
+ # * {Types::RetryStageExecutionOutput#pipeline_execution_id #pipelineExecutionId} => String
1197
+ #
1198
+ # @example Request syntax with placeholder values
1199
+ # resp = client.retry_stage_execution({
1200
+ # pipeline_name: "PipelineName", # required
1201
+ # stage_name: "StageName", # required
1202
+ # pipeline_execution_id: "PipelineExecutionId", # required
1203
+ # retry_mode: "FAILED_ACTIONS", # required, accepts FAILED_ACTIONS
1204
+ # })
1205
+ #
1206
+ # @example Response structure
1207
+ # resp.pipeline_execution_id #=> String
1208
+ # @overload retry_stage_execution(params = {})
1209
+ # @param [Hash] params ({})
1210
+ def retry_stage_execution(params = {}, options = {})
1211
+ req = build_request(:retry_stage_execution, params)
1212
+ req.send_request(options)
1213
+ end
1214
+
1215
+ # Starts the specified pipeline. Specifically, it begins processing the
1216
+ # latest commit to the source location specified as part of the
1217
+ # pipeline.
1218
+ # @option params [required, String] :name
1219
+ # The name of the pipeline to start.
1220
+ # @return [Types::StartPipelineExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1221
+ #
1222
+ # * {Types::StartPipelineExecutionOutput#pipeline_execution_id #pipelineExecutionId} => String
1223
+ #
1224
+ # @example Request syntax with placeholder values
1225
+ # resp = client.start_pipeline_execution({
1226
+ # name: "PipelineName", # required
1227
+ # })
1228
+ #
1229
+ # @example Response structure
1230
+ # resp.pipeline_execution_id #=> String
1231
+ # @overload start_pipeline_execution(params = {})
1232
+ # @param [Hash] params ({})
1233
+ def start_pipeline_execution(params = {}, options = {})
1234
+ req = build_request(:start_pipeline_execution, params)
1235
+ req.send_request(options)
1236
+ end
1237
+
1238
+ # Updates a specified pipeline with edits or changes to its structure.
1239
+ # Use a JSON file with the pipeline structure in conjunction with
1240
+ # UpdatePipeline to provide the full structure of the pipeline. Updating
1241
+ # the pipeline increases the version number of the pipeline by 1.
1242
+ # @option params [required, Types::PipelineDeclaration] :pipeline
1243
+ # The name of the pipeline to be updated.
1244
+ # @return [Types::UpdatePipelineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1245
+ #
1246
+ # * {Types::UpdatePipelineOutput#pipeline #pipeline} => Types::PipelineDeclaration
1247
+ #
1248
+ # @example Request syntax with placeholder values
1249
+ # resp = client.update_pipeline({
1250
+ # pipeline: { # required
1251
+ # name: "PipelineName", # required
1252
+ # role_arn: "RoleArn", # required
1253
+ # artifact_store: { # required
1254
+ # type: "S3", # required, accepts S3
1255
+ # location: "ArtifactStoreLocation", # required
1256
+ # encryption_key: {
1257
+ # id: "EncryptionKeyId", # required
1258
+ # type: "KMS", # required, accepts KMS
1259
+ # },
1260
+ # },
1261
+ # stages: [ # required
1262
+ # {
1263
+ # name: "StageName", # required
1264
+ # blockers: [
1265
+ # {
1266
+ # name: "BlockerName", # required
1267
+ # type: "Schedule", # required, accepts Schedule
1268
+ # },
1269
+ # ],
1270
+ # actions: [ # required
1271
+ # {
1272
+ # name: "ActionName", # required
1273
+ # action_type_id: { # required
1274
+ # category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval
1275
+ # owner: "AWS", # required, accepts AWS, ThirdParty, Custom
1276
+ # provider: "ActionProvider", # required
1277
+ # version: "Version", # required
1278
+ # },
1279
+ # run_order: 1,
1280
+ # configuration: {
1281
+ # "ActionConfigurationKey" => "ActionConfigurationValue",
1282
+ # },
1283
+ # output_artifacts: [
1284
+ # {
1285
+ # name: "ArtifactName", # required
1286
+ # },
1287
+ # ],
1288
+ # input_artifacts: [
1289
+ # {
1290
+ # name: "ArtifactName", # required
1291
+ # },
1292
+ # ],
1293
+ # role_arn: "RoleArn",
1294
+ # },
1295
+ # ],
1296
+ # },
1297
+ # ],
1298
+ # version: 1,
1299
+ # },
1300
+ # })
1301
+ #
1302
+ # @example Response structure
1303
+ # resp.pipeline.name #=> String
1304
+ # resp.pipeline.role_arn #=> String
1305
+ # resp.pipeline.artifact_store.type #=> String, one of "S3"
1306
+ # resp.pipeline.artifact_store.location #=> String
1307
+ # resp.pipeline.artifact_store.encryption_key.id #=> String
1308
+ # resp.pipeline.artifact_store.encryption_key.type #=> String, one of "KMS"
1309
+ # resp.pipeline.stages #=> Array
1310
+ # resp.pipeline.stages[0].name #=> String
1311
+ # resp.pipeline.stages[0].blockers #=> Array
1312
+ # resp.pipeline.stages[0].blockers[0].name #=> String
1313
+ # resp.pipeline.stages[0].blockers[0].type #=> String, one of "Schedule"
1314
+ # resp.pipeline.stages[0].actions #=> Array
1315
+ # resp.pipeline.stages[0].actions[0].name #=> String
1316
+ # resp.pipeline.stages[0].actions[0].action_type_id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval"
1317
+ # resp.pipeline.stages[0].actions[0].action_type_id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
1318
+ # resp.pipeline.stages[0].actions[0].action_type_id.provider #=> String
1319
+ # resp.pipeline.stages[0].actions[0].action_type_id.version #=> String
1320
+ # resp.pipeline.stages[0].actions[0].run_order #=> Integer
1321
+ # resp.pipeline.stages[0].actions[0].configuration #=> Hash
1322
+ # resp.pipeline.stages[0].actions[0].configuration["ActionConfigurationKey"] #=> String
1323
+ # resp.pipeline.stages[0].actions[0].output_artifacts #=> Array
1324
+ # resp.pipeline.stages[0].actions[0].output_artifacts[0].name #=> String
1325
+ # resp.pipeline.stages[0].actions[0].input_artifacts #=> Array
1326
+ # resp.pipeline.stages[0].actions[0].input_artifacts[0].name #=> String
1327
+ # resp.pipeline.stages[0].actions[0].role_arn #=> String
1328
+ # resp.pipeline.version #=> Integer
1329
+ # @overload update_pipeline(params = {})
1330
+ # @param [Hash] params ({})
1331
+ def update_pipeline(params = {}, options = {})
1332
+ req = build_request(:update_pipeline, params)
1333
+ req.send_request(options)
1334
+ end
1335
+
1336
+ # @!endgroup
1337
+
1338
+ # @param params ({})
1339
+ # @api private
1340
+ def build_request(operation_name, params = {})
1341
+ handlers = @handlers.for(operation_name)
1342
+ context = Seahorse::Client::RequestContext.new(
1343
+ operation_name: operation_name,
1344
+ operation: config.api.operation(operation_name),
1345
+ client: self,
1346
+ params: params,
1347
+ config: config)
1348
+ context[:gem_name] = 'aws-sdk-codepipeline'
1349
+ context[:gem_version] = '1.0.0.rc1'
1350
+ Seahorse::Client::Request.new(handlers, context)
1351
+ end
1352
+
1353
+ # @api private
1354
+ # @deprecated
1355
+ def waiter_names
1356
+ []
1357
+ end
1358
+
1359
+ class << self
1360
+
1361
+ # @api private
1362
+ attr_reader :identifier
1363
+
1364
+ # @api private
1365
+ def errors_module
1366
+ Errors
1367
+ end
1368
+
1369
+ end
1370
+ end
1371
+ end
1372
+ end