aws-sdk-codepipeline 1.0.0.rc2 → 1.0.0.rc3

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