aws-sdk-iotjobsdataplane 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-iotjobsdataplane.rb +47 -0
- data/lib/aws-sdk-iotjobsdataplane/client.rb +392 -0
- data/lib/aws-sdk-iotjobsdataplane/client_api.rb +188 -0
- data/lib/aws-sdk-iotjobsdataplane/customizations.rb +0 -0
- data/lib/aws-sdk-iotjobsdataplane/errors.rb +14 -0
- data/lib/aws-sdk-iotjobsdataplane/resource.rb +23 -0
- data/lib/aws-sdk-iotjobsdataplane/types.rb +341 -0
- metadata +82 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 86eded460ab0b8714947e6a77194b362eaa3512b
|
4
|
+
data.tar.gz: a39f1a14df83bc560a5e54bf9e3a5285b2470f5a
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: ab8d8c26d8dcb867320bfe0f6a546361fc454fadb1a8b36d735d7e0cb8643fd5e092dd77b73daf4511768b31b08617c95d7af8cc72e8e81d24d69131363d8bb8
|
7
|
+
data.tar.gz: 070007e39de49e8526020e0016a4f78a8688853a6cc0ab68da73014ce19100816872657ac8d77005c82a640d90bb8f8ab531887f05ed252aa0126d712405b9ce
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-iotjobsdataplane/types'
|
12
|
+
require_relative 'aws-sdk-iotjobsdataplane/client_api'
|
13
|
+
require_relative 'aws-sdk-iotjobsdataplane/client'
|
14
|
+
require_relative 'aws-sdk-iotjobsdataplane/errors'
|
15
|
+
require_relative 'aws-sdk-iotjobsdataplane/resource'
|
16
|
+
require_relative 'aws-sdk-iotjobsdataplane/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS IoT Jobs Data Plane. This module is available in the
|
19
|
+
# `aws-sdk-iotjobsdataplane` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from AWS IoT Jobs Data Plane all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::IoTJobsDataPlane::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::IoTJobsDataPlane
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,392 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
22
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
23
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
24
|
+
|
25
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:iotjobsdataplane)
|
26
|
+
|
27
|
+
module Aws::IoTJobsDataPlane
|
28
|
+
class Client < Seahorse::Client::Base
|
29
|
+
|
30
|
+
include Aws::ClientStubs
|
31
|
+
|
32
|
+
@identifier = :iotjobsdataplane
|
33
|
+
|
34
|
+
set_api(ClientApi::API)
|
35
|
+
|
36
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
37
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
38
|
+
add_plugin(Aws::Plugins::Logging)
|
39
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
40
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
41
|
+
add_plugin(Aws::Plugins::UserAgent)
|
42
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
43
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
44
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
45
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
46
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
47
|
+
add_plugin(Aws::Plugins::StubResponses)
|
48
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
49
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
50
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
51
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
52
|
+
|
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] :stub_responses (false)
|
130
|
+
# Causes the client to return stubbed responses. By default
|
131
|
+
# fake responses are generated and returned. You can specify
|
132
|
+
# the response data to return or errors to raise by calling
|
133
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
134
|
+
#
|
135
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
136
|
+
# requests are made, and retries are disabled.
|
137
|
+
#
|
138
|
+
# @option options [Boolean] :validate_params (true)
|
139
|
+
# When `true`, request parameters are validated before
|
140
|
+
# sending the request.
|
141
|
+
#
|
142
|
+
def initialize(*args)
|
143
|
+
super
|
144
|
+
end
|
145
|
+
|
146
|
+
# @!group API Operations
|
147
|
+
|
148
|
+
# Gets details of a job execution.
|
149
|
+
#
|
150
|
+
# @option params [required, String] :job_id
|
151
|
+
# The unique identifier assigned to this job when it was created.
|
152
|
+
#
|
153
|
+
# @option params [required, String] :thing_name
|
154
|
+
# The thing name associated with the device the job execution is running
|
155
|
+
# on.
|
156
|
+
#
|
157
|
+
# @option params [Boolean] :include_job_document
|
158
|
+
# Optional. When set to true, the response contains the job document.
|
159
|
+
# The default is false.
|
160
|
+
#
|
161
|
+
# @option params [Integer] :execution_number
|
162
|
+
# Optional. A number that identifies a particular job execution on a
|
163
|
+
# particular device. If not specified, the latest job execution is
|
164
|
+
# returned.
|
165
|
+
#
|
166
|
+
# @return [Types::DescribeJobExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
167
|
+
#
|
168
|
+
# * {Types::DescribeJobExecutionResponse#execution #execution} => Types::JobExecution
|
169
|
+
#
|
170
|
+
# @example Request syntax with placeholder values
|
171
|
+
#
|
172
|
+
# resp = client.describe_job_execution({
|
173
|
+
# job_id: "DescribeJobExecutionJobId", # required
|
174
|
+
# thing_name: "ThingName", # required
|
175
|
+
# include_job_document: false,
|
176
|
+
# execution_number: 1,
|
177
|
+
# })
|
178
|
+
#
|
179
|
+
# @example Response structure
|
180
|
+
#
|
181
|
+
# resp.execution.job_id #=> String
|
182
|
+
# resp.execution.thing_name #=> String
|
183
|
+
# resp.execution.status #=> String, one of "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "REJECTED", "REMOVED", "CANCELED"
|
184
|
+
# resp.execution.status_details #=> Hash
|
185
|
+
# resp.execution.status_details["DetailsKey"] #=> String
|
186
|
+
# resp.execution.queued_at #=> Integer
|
187
|
+
# resp.execution.started_at #=> Integer
|
188
|
+
# resp.execution.last_updated_at #=> Integer
|
189
|
+
# resp.execution.version_number #=> Integer
|
190
|
+
# resp.execution.execution_number #=> Integer
|
191
|
+
# resp.execution.job_document #=> String
|
192
|
+
#
|
193
|
+
# @overload describe_job_execution(params = {})
|
194
|
+
# @param [Hash] params ({})
|
195
|
+
def describe_job_execution(params = {}, options = {})
|
196
|
+
req = build_request(:describe_job_execution, params)
|
197
|
+
req.send_request(options)
|
198
|
+
end
|
199
|
+
|
200
|
+
# Gets the list of all jobs for a thing that are not in a terminal
|
201
|
+
# status.
|
202
|
+
#
|
203
|
+
# @option params [required, String] :thing_name
|
204
|
+
# The name of the thing that is executing the job.
|
205
|
+
#
|
206
|
+
# @return [Types::GetPendingJobExecutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
207
|
+
#
|
208
|
+
# * {Types::GetPendingJobExecutionsResponse#in_progress_jobs #in_progress_jobs} => Array<Types::JobExecutionSummary>
|
209
|
+
# * {Types::GetPendingJobExecutionsResponse#queued_jobs #queued_jobs} => Array<Types::JobExecutionSummary>
|
210
|
+
#
|
211
|
+
# @example Request syntax with placeholder values
|
212
|
+
#
|
213
|
+
# resp = client.get_pending_job_executions({
|
214
|
+
# thing_name: "ThingName", # required
|
215
|
+
# })
|
216
|
+
#
|
217
|
+
# @example Response structure
|
218
|
+
#
|
219
|
+
# resp.in_progress_jobs #=> Array
|
220
|
+
# resp.in_progress_jobs[0].job_id #=> String
|
221
|
+
# resp.in_progress_jobs[0].queued_at #=> Integer
|
222
|
+
# resp.in_progress_jobs[0].started_at #=> Integer
|
223
|
+
# resp.in_progress_jobs[0].last_updated_at #=> Integer
|
224
|
+
# resp.in_progress_jobs[0].version_number #=> Integer
|
225
|
+
# resp.in_progress_jobs[0].execution_number #=> Integer
|
226
|
+
# resp.queued_jobs #=> Array
|
227
|
+
# resp.queued_jobs[0].job_id #=> String
|
228
|
+
# resp.queued_jobs[0].queued_at #=> Integer
|
229
|
+
# resp.queued_jobs[0].started_at #=> Integer
|
230
|
+
# resp.queued_jobs[0].last_updated_at #=> Integer
|
231
|
+
# resp.queued_jobs[0].version_number #=> Integer
|
232
|
+
# resp.queued_jobs[0].execution_number #=> Integer
|
233
|
+
#
|
234
|
+
# @overload get_pending_job_executions(params = {})
|
235
|
+
# @param [Hash] params ({})
|
236
|
+
def get_pending_job_executions(params = {}, options = {})
|
237
|
+
req = build_request(:get_pending_job_executions, params)
|
238
|
+
req.send_request(options)
|
239
|
+
end
|
240
|
+
|
241
|
+
# Gets and starts the next pending (status IN\_PROGRESS or QUEUED) job
|
242
|
+
# execution for a thing.
|
243
|
+
#
|
244
|
+
# @option params [required, String] :thing_name
|
245
|
+
# The name of the thing associated with the device.
|
246
|
+
#
|
247
|
+
# @option params [Hash<String,String>] :status_details
|
248
|
+
# A collection of name/value pairs that describe the status of the job
|
249
|
+
# execution. If not specified, the statusDetails are unchanged.
|
250
|
+
#
|
251
|
+
# @return [Types::StartNextPendingJobExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
252
|
+
#
|
253
|
+
# * {Types::StartNextPendingJobExecutionResponse#execution #execution} => Types::JobExecution
|
254
|
+
#
|
255
|
+
# @example Request syntax with placeholder values
|
256
|
+
#
|
257
|
+
# resp = client.start_next_pending_job_execution({
|
258
|
+
# thing_name: "ThingName", # required
|
259
|
+
# status_details: {
|
260
|
+
# "DetailsKey" => "DetailsValue",
|
261
|
+
# },
|
262
|
+
# })
|
263
|
+
#
|
264
|
+
# @example Response structure
|
265
|
+
#
|
266
|
+
# resp.execution.job_id #=> String
|
267
|
+
# resp.execution.thing_name #=> String
|
268
|
+
# resp.execution.status #=> String, one of "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "REJECTED", "REMOVED", "CANCELED"
|
269
|
+
# resp.execution.status_details #=> Hash
|
270
|
+
# resp.execution.status_details["DetailsKey"] #=> String
|
271
|
+
# resp.execution.queued_at #=> Integer
|
272
|
+
# resp.execution.started_at #=> Integer
|
273
|
+
# resp.execution.last_updated_at #=> Integer
|
274
|
+
# resp.execution.version_number #=> Integer
|
275
|
+
# resp.execution.execution_number #=> Integer
|
276
|
+
# resp.execution.job_document #=> String
|
277
|
+
#
|
278
|
+
# @overload start_next_pending_job_execution(params = {})
|
279
|
+
# @param [Hash] params ({})
|
280
|
+
def start_next_pending_job_execution(params = {}, options = {})
|
281
|
+
req = build_request(:start_next_pending_job_execution, params)
|
282
|
+
req.send_request(options)
|
283
|
+
end
|
284
|
+
|
285
|
+
# Updates the status of a job execution.
|
286
|
+
#
|
287
|
+
# @option params [required, String] :job_id
|
288
|
+
# The unique identifier assigned to this job when it was created.
|
289
|
+
#
|
290
|
+
# @option params [required, String] :thing_name
|
291
|
+
# The name of the thing associated with the device.
|
292
|
+
#
|
293
|
+
# @option params [required, String] :status
|
294
|
+
# The new status for the job execution (IN\_PROGRESS, FAILED, SUCCESS,
|
295
|
+
# or REJECTED). This must be specified on every update.
|
296
|
+
#
|
297
|
+
# @option params [Hash<String,String>] :status_details
|
298
|
+
# Optional. A collection of name/value pairs that describe the status of
|
299
|
+
# the job execution. If not specified, the statusDetails are unchanged.
|
300
|
+
#
|
301
|
+
# @option params [Integer] :expected_version
|
302
|
+
# Optional. The expected current version of the job execution. Each time
|
303
|
+
# you update the job execution, its version is incremented. If the
|
304
|
+
# version of the job execution stored in Jobs does not match, the update
|
305
|
+
# is rejected with a VersionMismatch error, and an ErrorResponse that
|
306
|
+
# contains the current job execution status data is returned. (This
|
307
|
+
# makes it unnecessary to perform a separate DescribeJobExecution
|
308
|
+
# request in order to obtain the job execution status data.)
|
309
|
+
#
|
310
|
+
# @option params [Boolean] :include_job_execution_state
|
311
|
+
# Optional. When included and set to true, the response contains the
|
312
|
+
# JobExecutionState data. The default is false.
|
313
|
+
#
|
314
|
+
# @option params [Boolean] :include_job_document
|
315
|
+
# Optional. When set to true, the response contains the job document.
|
316
|
+
# The default is false.
|
317
|
+
#
|
318
|
+
# @option params [Integer] :execution_number
|
319
|
+
# Optional. A number that identifies a particular job execution on a
|
320
|
+
# particular device.
|
321
|
+
#
|
322
|
+
# @return [Types::UpdateJobExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
323
|
+
#
|
324
|
+
# * {Types::UpdateJobExecutionResponse#execution_state #execution_state} => Types::JobExecutionState
|
325
|
+
# * {Types::UpdateJobExecutionResponse#job_document #job_document} => String
|
326
|
+
#
|
327
|
+
# @example Request syntax with placeholder values
|
328
|
+
#
|
329
|
+
# resp = client.update_job_execution({
|
330
|
+
# job_id: "JobId", # required
|
331
|
+
# thing_name: "ThingName", # required
|
332
|
+
# status: "QUEUED", # required, accepts QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, REJECTED, REMOVED, CANCELED
|
333
|
+
# status_details: {
|
334
|
+
# "DetailsKey" => "DetailsValue",
|
335
|
+
# },
|
336
|
+
# expected_version: 1,
|
337
|
+
# include_job_execution_state: false,
|
338
|
+
# include_job_document: false,
|
339
|
+
# execution_number: 1,
|
340
|
+
# })
|
341
|
+
#
|
342
|
+
# @example Response structure
|
343
|
+
#
|
344
|
+
# resp.execution_state.status #=> String, one of "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "REJECTED", "REMOVED", "CANCELED"
|
345
|
+
# resp.execution_state.status_details #=> Hash
|
346
|
+
# resp.execution_state.status_details["DetailsKey"] #=> String
|
347
|
+
# resp.execution_state.version_number #=> Integer
|
348
|
+
# resp.job_document #=> String
|
349
|
+
#
|
350
|
+
# @overload update_job_execution(params = {})
|
351
|
+
# @param [Hash] params ({})
|
352
|
+
def update_job_execution(params = {}, options = {})
|
353
|
+
req = build_request(:update_job_execution, params)
|
354
|
+
req.send_request(options)
|
355
|
+
end
|
356
|
+
|
357
|
+
# @!endgroup
|
358
|
+
|
359
|
+
# @param params ({})
|
360
|
+
# @api private
|
361
|
+
def build_request(operation_name, params = {})
|
362
|
+
handlers = @handlers.for(operation_name)
|
363
|
+
context = Seahorse::Client::RequestContext.new(
|
364
|
+
operation_name: operation_name,
|
365
|
+
operation: config.api.operation(operation_name),
|
366
|
+
client: self,
|
367
|
+
params: params,
|
368
|
+
config: config)
|
369
|
+
context[:gem_name] = 'aws-sdk-iotjobsdataplane'
|
370
|
+
context[:gem_version] = '1.0.0'
|
371
|
+
Seahorse::Client::Request.new(handlers, context)
|
372
|
+
end
|
373
|
+
|
374
|
+
# @api private
|
375
|
+
# @deprecated
|
376
|
+
def waiter_names
|
377
|
+
[]
|
378
|
+
end
|
379
|
+
|
380
|
+
class << self
|
381
|
+
|
382
|
+
# @api private
|
383
|
+
attr_reader :identifier
|
384
|
+
|
385
|
+
# @api private
|
386
|
+
def errors_module
|
387
|
+
Errors
|
388
|
+
end
|
389
|
+
|
390
|
+
end
|
391
|
+
end
|
392
|
+
end
|
@@ -0,0 +1,188 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::IoTJobsDataPlane
|
9
|
+
# @api private
|
10
|
+
module ClientApi
|
11
|
+
|
12
|
+
include Seahorse::Model
|
13
|
+
|
14
|
+
CertificateValidationException = Shapes::StructureShape.new(name: 'CertificateValidationException')
|
15
|
+
DescribeJobExecutionJobId = Shapes::StringShape.new(name: 'DescribeJobExecutionJobId')
|
16
|
+
DescribeJobExecutionRequest = Shapes::StructureShape.new(name: 'DescribeJobExecutionRequest')
|
17
|
+
DescribeJobExecutionResponse = Shapes::StructureShape.new(name: 'DescribeJobExecutionResponse')
|
18
|
+
DetailsKey = Shapes::StringShape.new(name: 'DetailsKey')
|
19
|
+
DetailsMap = Shapes::MapShape.new(name: 'DetailsMap')
|
20
|
+
DetailsValue = Shapes::StringShape.new(name: 'DetailsValue')
|
21
|
+
ExecutionNumber = Shapes::IntegerShape.new(name: 'ExecutionNumber')
|
22
|
+
ExpectedVersion = Shapes::IntegerShape.new(name: 'ExpectedVersion')
|
23
|
+
GetPendingJobExecutionsRequest = Shapes::StructureShape.new(name: 'GetPendingJobExecutionsRequest')
|
24
|
+
GetPendingJobExecutionsResponse = Shapes::StructureShape.new(name: 'GetPendingJobExecutionsResponse')
|
25
|
+
IncludeExecutionState = Shapes::BooleanShape.new(name: 'IncludeExecutionState')
|
26
|
+
IncludeJobDocument = Shapes::BooleanShape.new(name: 'IncludeJobDocument')
|
27
|
+
InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
|
28
|
+
InvalidStateTransitionException = Shapes::StructureShape.new(name: 'InvalidStateTransitionException')
|
29
|
+
JobDocument = Shapes::StringShape.new(name: 'JobDocument')
|
30
|
+
JobExecution = Shapes::StructureShape.new(name: 'JobExecution')
|
31
|
+
JobExecutionState = Shapes::StructureShape.new(name: 'JobExecutionState')
|
32
|
+
JobExecutionStatus = Shapes::StringShape.new(name: 'JobExecutionStatus')
|
33
|
+
JobExecutionSummary = Shapes::StructureShape.new(name: 'JobExecutionSummary')
|
34
|
+
JobExecutionSummaryList = Shapes::ListShape.new(name: 'JobExecutionSummaryList')
|
35
|
+
JobId = Shapes::StringShape.new(name: 'JobId')
|
36
|
+
LastUpdatedAt = Shapes::IntegerShape.new(name: 'LastUpdatedAt')
|
37
|
+
QueuedAt = Shapes::IntegerShape.new(name: 'QueuedAt')
|
38
|
+
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
39
|
+
ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
|
40
|
+
StartNextPendingJobExecutionRequest = Shapes::StructureShape.new(name: 'StartNextPendingJobExecutionRequest')
|
41
|
+
StartNextPendingJobExecutionResponse = Shapes::StructureShape.new(name: 'StartNextPendingJobExecutionResponse')
|
42
|
+
StartedAt = Shapes::IntegerShape.new(name: 'StartedAt')
|
43
|
+
TerminalStateException = Shapes::StructureShape.new(name: 'TerminalStateException')
|
44
|
+
ThingName = Shapes::StringShape.new(name: 'ThingName')
|
45
|
+
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
46
|
+
UpdateJobExecutionRequest = Shapes::StructureShape.new(name: 'UpdateJobExecutionRequest')
|
47
|
+
UpdateJobExecutionResponse = Shapes::StructureShape.new(name: 'UpdateJobExecutionResponse')
|
48
|
+
VersionNumber = Shapes::IntegerShape.new(name: 'VersionNumber')
|
49
|
+
errorMessage = Shapes::StringShape.new(name: 'errorMessage')
|
50
|
+
|
51
|
+
DescribeJobExecutionRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: DescribeJobExecutionJobId, required: true, location: "uri", location_name: "jobId"))
|
52
|
+
DescribeJobExecutionRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: ThingName, required: true, location: "uri", location_name: "thingName"))
|
53
|
+
DescribeJobExecutionRequest.add_member(:include_job_document, Shapes::ShapeRef.new(shape: IncludeJobDocument, location: "querystring", location_name: "includeJobDocument"))
|
54
|
+
DescribeJobExecutionRequest.add_member(:execution_number, Shapes::ShapeRef.new(shape: ExecutionNumber, location: "querystring", location_name: "executionNumber"))
|
55
|
+
DescribeJobExecutionRequest.struct_class = Types::DescribeJobExecutionRequest
|
56
|
+
|
57
|
+
DescribeJobExecutionResponse.add_member(:execution, Shapes::ShapeRef.new(shape: JobExecution, location_name: "execution"))
|
58
|
+
DescribeJobExecutionResponse.struct_class = Types::DescribeJobExecutionResponse
|
59
|
+
|
60
|
+
DetailsMap.key = Shapes::ShapeRef.new(shape: DetailsKey)
|
61
|
+
DetailsMap.value = Shapes::ShapeRef.new(shape: DetailsValue)
|
62
|
+
|
63
|
+
GetPendingJobExecutionsRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: ThingName, required: true, location: "uri", location_name: "thingName"))
|
64
|
+
GetPendingJobExecutionsRequest.struct_class = Types::GetPendingJobExecutionsRequest
|
65
|
+
|
66
|
+
GetPendingJobExecutionsResponse.add_member(:in_progress_jobs, Shapes::ShapeRef.new(shape: JobExecutionSummaryList, location_name: "inProgressJobs"))
|
67
|
+
GetPendingJobExecutionsResponse.add_member(:queued_jobs, Shapes::ShapeRef.new(shape: JobExecutionSummaryList, location_name: "queuedJobs"))
|
68
|
+
GetPendingJobExecutionsResponse.struct_class = Types::GetPendingJobExecutionsResponse
|
69
|
+
|
70
|
+
JobExecution.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "jobId"))
|
71
|
+
JobExecution.add_member(:thing_name, Shapes::ShapeRef.new(shape: ThingName, location_name: "thingName"))
|
72
|
+
JobExecution.add_member(:status, Shapes::ShapeRef.new(shape: JobExecutionStatus, location_name: "status"))
|
73
|
+
JobExecution.add_member(:status_details, Shapes::ShapeRef.new(shape: DetailsMap, location_name: "statusDetails"))
|
74
|
+
JobExecution.add_member(:queued_at, Shapes::ShapeRef.new(shape: QueuedAt, location_name: "queuedAt"))
|
75
|
+
JobExecution.add_member(:started_at, Shapes::ShapeRef.new(shape: StartedAt, location_name: "startedAt"))
|
76
|
+
JobExecution.add_member(:last_updated_at, Shapes::ShapeRef.new(shape: LastUpdatedAt, location_name: "lastUpdatedAt"))
|
77
|
+
JobExecution.add_member(:version_number, Shapes::ShapeRef.new(shape: VersionNumber, location_name: "versionNumber"))
|
78
|
+
JobExecution.add_member(:execution_number, Shapes::ShapeRef.new(shape: ExecutionNumber, location_name: "executionNumber"))
|
79
|
+
JobExecution.add_member(:job_document, Shapes::ShapeRef.new(shape: JobDocument, location_name: "jobDocument"))
|
80
|
+
JobExecution.struct_class = Types::JobExecution
|
81
|
+
|
82
|
+
JobExecutionState.add_member(:status, Shapes::ShapeRef.new(shape: JobExecutionStatus, location_name: "status"))
|
83
|
+
JobExecutionState.add_member(:status_details, Shapes::ShapeRef.new(shape: DetailsMap, location_name: "statusDetails"))
|
84
|
+
JobExecutionState.add_member(:version_number, Shapes::ShapeRef.new(shape: VersionNumber, location_name: "versionNumber"))
|
85
|
+
JobExecutionState.struct_class = Types::JobExecutionState
|
86
|
+
|
87
|
+
JobExecutionSummary.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "jobId"))
|
88
|
+
JobExecutionSummary.add_member(:queued_at, Shapes::ShapeRef.new(shape: QueuedAt, location_name: "queuedAt"))
|
89
|
+
JobExecutionSummary.add_member(:started_at, Shapes::ShapeRef.new(shape: StartedAt, location_name: "startedAt"))
|
90
|
+
JobExecutionSummary.add_member(:last_updated_at, Shapes::ShapeRef.new(shape: LastUpdatedAt, location_name: "lastUpdatedAt"))
|
91
|
+
JobExecutionSummary.add_member(:version_number, Shapes::ShapeRef.new(shape: VersionNumber, location_name: "versionNumber"))
|
92
|
+
JobExecutionSummary.add_member(:execution_number, Shapes::ShapeRef.new(shape: ExecutionNumber, location_name: "executionNumber"))
|
93
|
+
JobExecutionSummary.struct_class = Types::JobExecutionSummary
|
94
|
+
|
95
|
+
JobExecutionSummaryList.member = Shapes::ShapeRef.new(shape: JobExecutionSummary)
|
96
|
+
|
97
|
+
StartNextPendingJobExecutionRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: ThingName, required: true, location: "uri", location_name: "thingName"))
|
98
|
+
StartNextPendingJobExecutionRequest.add_member(:status_details, Shapes::ShapeRef.new(shape: DetailsMap, location_name: "statusDetails"))
|
99
|
+
StartNextPendingJobExecutionRequest.struct_class = Types::StartNextPendingJobExecutionRequest
|
100
|
+
|
101
|
+
StartNextPendingJobExecutionResponse.add_member(:execution, Shapes::ShapeRef.new(shape: JobExecution, location_name: "execution"))
|
102
|
+
StartNextPendingJobExecutionResponse.struct_class = Types::StartNextPendingJobExecutionResponse
|
103
|
+
|
104
|
+
UpdateJobExecutionRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location: "uri", location_name: "jobId"))
|
105
|
+
UpdateJobExecutionRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: ThingName, required: true, location: "uri", location_name: "thingName"))
|
106
|
+
UpdateJobExecutionRequest.add_member(:status, Shapes::ShapeRef.new(shape: JobExecutionStatus, required: true, location_name: "status"))
|
107
|
+
UpdateJobExecutionRequest.add_member(:status_details, Shapes::ShapeRef.new(shape: DetailsMap, location_name: "statusDetails"))
|
108
|
+
UpdateJobExecutionRequest.add_member(:expected_version, Shapes::ShapeRef.new(shape: ExpectedVersion, location_name: "expectedVersion"))
|
109
|
+
UpdateJobExecutionRequest.add_member(:include_job_execution_state, Shapes::ShapeRef.new(shape: IncludeExecutionState, location_name: "includeJobExecutionState"))
|
110
|
+
UpdateJobExecutionRequest.add_member(:include_job_document, Shapes::ShapeRef.new(shape: IncludeJobDocument, location_name: "includeJobDocument"))
|
111
|
+
UpdateJobExecutionRequest.add_member(:execution_number, Shapes::ShapeRef.new(shape: ExecutionNumber, location_name: "executionNumber"))
|
112
|
+
UpdateJobExecutionRequest.struct_class = Types::UpdateJobExecutionRequest
|
113
|
+
|
114
|
+
UpdateJobExecutionResponse.add_member(:execution_state, Shapes::ShapeRef.new(shape: JobExecutionState, location_name: "executionState"))
|
115
|
+
UpdateJobExecutionResponse.add_member(:job_document, Shapes::ShapeRef.new(shape: JobDocument, location_name: "jobDocument"))
|
116
|
+
UpdateJobExecutionResponse.struct_class = Types::UpdateJobExecutionResponse
|
117
|
+
|
118
|
+
|
119
|
+
# @api private
|
120
|
+
API = Seahorse::Model::Api.new.tap do |api|
|
121
|
+
|
122
|
+
api.version = "2017-09-29"
|
123
|
+
|
124
|
+
api.metadata = {
|
125
|
+
"endpointPrefix" => "data.jobs.iot",
|
126
|
+
"protocol" => "rest-json",
|
127
|
+
"serviceFullName" => "AWS IoT Jobs Data Plane",
|
128
|
+
"signatureVersion" => "v4",
|
129
|
+
"signingName" => "iot-jobs-data",
|
130
|
+
}
|
131
|
+
|
132
|
+
api.add_operation(:describe_job_execution, Seahorse::Model::Operation.new.tap do |o|
|
133
|
+
o.name = "DescribeJobExecution"
|
134
|
+
o.http_method = "GET"
|
135
|
+
o.http_request_uri = "/things/{thingName}/jobs/{jobId}"
|
136
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeJobExecutionRequest)
|
137
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeJobExecutionResponse)
|
138
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
139
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
140
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
141
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
142
|
+
o.errors << Shapes::ShapeRef.new(shape: CertificateValidationException)
|
143
|
+
o.errors << Shapes::ShapeRef.new(shape: TerminalStateException)
|
144
|
+
end)
|
145
|
+
|
146
|
+
api.add_operation(:get_pending_job_executions, Seahorse::Model::Operation.new.tap do |o|
|
147
|
+
o.name = "GetPendingJobExecutions"
|
148
|
+
o.http_method = "GET"
|
149
|
+
o.http_request_uri = "/things/{thingName}/jobs"
|
150
|
+
o.input = Shapes::ShapeRef.new(shape: GetPendingJobExecutionsRequest)
|
151
|
+
o.output = Shapes::ShapeRef.new(shape: GetPendingJobExecutionsResponse)
|
152
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
153
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
154
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
155
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
156
|
+
o.errors << Shapes::ShapeRef.new(shape: CertificateValidationException)
|
157
|
+
end)
|
158
|
+
|
159
|
+
api.add_operation(:start_next_pending_job_execution, Seahorse::Model::Operation.new.tap do |o|
|
160
|
+
o.name = "StartNextPendingJobExecution"
|
161
|
+
o.http_method = "PUT"
|
162
|
+
o.http_request_uri = "/things/{thingName}/jobs/$next"
|
163
|
+
o.input = Shapes::ShapeRef.new(shape: StartNextPendingJobExecutionRequest)
|
164
|
+
o.output = Shapes::ShapeRef.new(shape: StartNextPendingJobExecutionResponse)
|
165
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
166
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
167
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
168
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
169
|
+
o.errors << Shapes::ShapeRef.new(shape: CertificateValidationException)
|
170
|
+
end)
|
171
|
+
|
172
|
+
api.add_operation(:update_job_execution, Seahorse::Model::Operation.new.tap do |o|
|
173
|
+
o.name = "UpdateJobExecution"
|
174
|
+
o.http_method = "POST"
|
175
|
+
o.http_request_uri = "/things/{thingName}/jobs/{jobId}"
|
176
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateJobExecutionRequest)
|
177
|
+
o.output = Shapes::ShapeRef.new(shape: UpdateJobExecutionResponse)
|
178
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
179
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
180
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
181
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
182
|
+
o.errors << Shapes::ShapeRef.new(shape: CertificateValidationException)
|
183
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidStateTransitionException)
|
184
|
+
end)
|
185
|
+
end
|
186
|
+
|
187
|
+
end
|
188
|
+
end
|
File without changes
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::IoTJobsDataPlane
|
9
|
+
module Errors
|
10
|
+
|
11
|
+
extend Aws::Errors::DynamicErrors
|
12
|
+
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::IoTJobsDataPlane
|
9
|
+
class Resource
|
10
|
+
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
16
|
+
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
20
|
+
end
|
21
|
+
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,341 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::IoTJobsDataPlane
|
9
|
+
module Types
|
10
|
+
|
11
|
+
# @note When making an API call, you may pass DescribeJobExecutionRequest
|
12
|
+
# data as a hash:
|
13
|
+
#
|
14
|
+
# {
|
15
|
+
# job_id: "DescribeJobExecutionJobId", # required
|
16
|
+
# thing_name: "ThingName", # required
|
17
|
+
# include_job_document: false,
|
18
|
+
# execution_number: 1,
|
19
|
+
# }
|
20
|
+
#
|
21
|
+
# @!attribute [rw] job_id
|
22
|
+
# The unique identifier assigned to this job when it was created.
|
23
|
+
# @return [String]
|
24
|
+
#
|
25
|
+
# @!attribute [rw] thing_name
|
26
|
+
# The thing name associated with the device the job execution is
|
27
|
+
# running on.
|
28
|
+
# @return [String]
|
29
|
+
#
|
30
|
+
# @!attribute [rw] include_job_document
|
31
|
+
# Optional. When set to true, the response contains the job document.
|
32
|
+
# The default is false.
|
33
|
+
# @return [Boolean]
|
34
|
+
#
|
35
|
+
# @!attribute [rw] execution_number
|
36
|
+
# Optional. A number that identifies a particular job execution on a
|
37
|
+
# particular device. If not specified, the latest job execution is
|
38
|
+
# returned.
|
39
|
+
# @return [Integer]
|
40
|
+
#
|
41
|
+
class DescribeJobExecutionRequest < Struct.new(
|
42
|
+
:job_id,
|
43
|
+
:thing_name,
|
44
|
+
:include_job_document,
|
45
|
+
:execution_number)
|
46
|
+
include Aws::Structure
|
47
|
+
end
|
48
|
+
|
49
|
+
# @!attribute [rw] execution
|
50
|
+
# Contains data about a job execution.
|
51
|
+
# @return [Types::JobExecution]
|
52
|
+
#
|
53
|
+
class DescribeJobExecutionResponse < Struct.new(
|
54
|
+
:execution)
|
55
|
+
include Aws::Structure
|
56
|
+
end
|
57
|
+
|
58
|
+
# @note When making an API call, you may pass GetPendingJobExecutionsRequest
|
59
|
+
# data as a hash:
|
60
|
+
#
|
61
|
+
# {
|
62
|
+
# thing_name: "ThingName", # required
|
63
|
+
# }
|
64
|
+
#
|
65
|
+
# @!attribute [rw] thing_name
|
66
|
+
# The name of the thing that is executing the job.
|
67
|
+
# @return [String]
|
68
|
+
#
|
69
|
+
class GetPendingJobExecutionsRequest < Struct.new(
|
70
|
+
:thing_name)
|
71
|
+
include Aws::Structure
|
72
|
+
end
|
73
|
+
|
74
|
+
# @!attribute [rw] in_progress_jobs
|
75
|
+
# A list of JobExecutionSummary objects with status IN\_PROGRESS.
|
76
|
+
# @return [Array<Types::JobExecutionSummary>]
|
77
|
+
#
|
78
|
+
# @!attribute [rw] queued_jobs
|
79
|
+
# A list of JobExecutionSummary objects with status QUEUED.
|
80
|
+
# @return [Array<Types::JobExecutionSummary>]
|
81
|
+
#
|
82
|
+
class GetPendingJobExecutionsResponse < Struct.new(
|
83
|
+
:in_progress_jobs,
|
84
|
+
:queued_jobs)
|
85
|
+
include Aws::Structure
|
86
|
+
end
|
87
|
+
|
88
|
+
# Contains data about a job execution.
|
89
|
+
#
|
90
|
+
# @!attribute [rw] job_id
|
91
|
+
# The unique identifier you assigned to this job when it was created.
|
92
|
+
# @return [String]
|
93
|
+
#
|
94
|
+
# @!attribute [rw] thing_name
|
95
|
+
# The name of the thing that is executing the job.
|
96
|
+
# @return [String]
|
97
|
+
#
|
98
|
+
# @!attribute [rw] status
|
99
|
+
# The status of the job execution. Can be one of: "QUEUED",
|
100
|
+
# "IN\_PROGRESS", "FAILED", "SUCCESS", "CANCELED",
|
101
|
+
# "REJECTED", or "REMOVED".
|
102
|
+
# @return [String]
|
103
|
+
#
|
104
|
+
# @!attribute [rw] status_details
|
105
|
+
# A collection of name/value pairs that describe the status of the job
|
106
|
+
# execution.
|
107
|
+
# @return [Hash<String,String>]
|
108
|
+
#
|
109
|
+
# @!attribute [rw] queued_at
|
110
|
+
# The time, in milliseconds since the epoch, when the job execution
|
111
|
+
# was enqueued.
|
112
|
+
# @return [Integer]
|
113
|
+
#
|
114
|
+
# @!attribute [rw] started_at
|
115
|
+
# The time, in milliseconds since the epoch, when the job execution
|
116
|
+
# was started.
|
117
|
+
# @return [Integer]
|
118
|
+
#
|
119
|
+
# @!attribute [rw] last_updated_at
|
120
|
+
# The time, in milliseconds since the epoch, when the job execution
|
121
|
+
# was last updated.
|
122
|
+
# @return [Integer]
|
123
|
+
#
|
124
|
+
# @!attribute [rw] version_number
|
125
|
+
# The version of the job execution. Job execution versions are
|
126
|
+
# incremented each time they are updated by a device.
|
127
|
+
# @return [Integer]
|
128
|
+
#
|
129
|
+
# @!attribute [rw] execution_number
|
130
|
+
# A number that identifies a particular job execution on a particular
|
131
|
+
# device. It can be used later in commands that return or update job
|
132
|
+
# execution information.
|
133
|
+
# @return [Integer]
|
134
|
+
#
|
135
|
+
# @!attribute [rw] job_document
|
136
|
+
# The content of the job document.
|
137
|
+
# @return [String]
|
138
|
+
#
|
139
|
+
class JobExecution < Struct.new(
|
140
|
+
:job_id,
|
141
|
+
:thing_name,
|
142
|
+
:status,
|
143
|
+
:status_details,
|
144
|
+
:queued_at,
|
145
|
+
:started_at,
|
146
|
+
:last_updated_at,
|
147
|
+
:version_number,
|
148
|
+
:execution_number,
|
149
|
+
:job_document)
|
150
|
+
include Aws::Structure
|
151
|
+
end
|
152
|
+
|
153
|
+
# Contains data about the state of a job execution.
|
154
|
+
#
|
155
|
+
# @!attribute [rw] status
|
156
|
+
# The status of the job execution. Can be one of: "QUEUED",
|
157
|
+
# "IN\_PROGRESS", "FAILED", "SUCCESS", "CANCELED",
|
158
|
+
# "REJECTED", or "REMOVED".
|
159
|
+
# @return [String]
|
160
|
+
#
|
161
|
+
# @!attribute [rw] status_details
|
162
|
+
# A collection of name/value pairs that describe the status of the job
|
163
|
+
# execution.
|
164
|
+
# @return [Hash<String,String>]
|
165
|
+
#
|
166
|
+
# @!attribute [rw] version_number
|
167
|
+
# The version of the job execution. Job execution versions are
|
168
|
+
# incremented each time they are updated by a device.
|
169
|
+
# @return [Integer]
|
170
|
+
#
|
171
|
+
class JobExecutionState < Struct.new(
|
172
|
+
:status,
|
173
|
+
:status_details,
|
174
|
+
:version_number)
|
175
|
+
include Aws::Structure
|
176
|
+
end
|
177
|
+
|
178
|
+
# Contains a subset of information about a job execution.
|
179
|
+
#
|
180
|
+
# @!attribute [rw] job_id
|
181
|
+
# The unique identifier you assigned to this job when it was created.
|
182
|
+
# @return [String]
|
183
|
+
#
|
184
|
+
# @!attribute [rw] queued_at
|
185
|
+
# The time, in milliseconds since the epoch, when the job execution
|
186
|
+
# was enqueued.
|
187
|
+
# @return [Integer]
|
188
|
+
#
|
189
|
+
# @!attribute [rw] started_at
|
190
|
+
# The time, in milliseconds since the epoch, when the job execution
|
191
|
+
# started.
|
192
|
+
# @return [Integer]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] last_updated_at
|
195
|
+
# The time, in milliseconds since the epoch, when the job execution
|
196
|
+
# was last updated.
|
197
|
+
# @return [Integer]
|
198
|
+
#
|
199
|
+
# @!attribute [rw] version_number
|
200
|
+
# The version of the job execution. Job execution versions are
|
201
|
+
# incremented each time AWS IoT Jobs receives an update from a device.
|
202
|
+
# @return [Integer]
|
203
|
+
#
|
204
|
+
# @!attribute [rw] execution_number
|
205
|
+
# A number that identifies a particular job execution on a particular
|
206
|
+
# device.
|
207
|
+
# @return [Integer]
|
208
|
+
#
|
209
|
+
class JobExecutionSummary < Struct.new(
|
210
|
+
:job_id,
|
211
|
+
:queued_at,
|
212
|
+
:started_at,
|
213
|
+
:last_updated_at,
|
214
|
+
:version_number,
|
215
|
+
:execution_number)
|
216
|
+
include Aws::Structure
|
217
|
+
end
|
218
|
+
|
219
|
+
# @note When making an API call, you may pass StartNextPendingJobExecutionRequest
|
220
|
+
# data as a hash:
|
221
|
+
#
|
222
|
+
# {
|
223
|
+
# thing_name: "ThingName", # required
|
224
|
+
# status_details: {
|
225
|
+
# "DetailsKey" => "DetailsValue",
|
226
|
+
# },
|
227
|
+
# }
|
228
|
+
#
|
229
|
+
# @!attribute [rw] thing_name
|
230
|
+
# The name of the thing associated with the device.
|
231
|
+
# @return [String]
|
232
|
+
#
|
233
|
+
# @!attribute [rw] status_details
|
234
|
+
# A collection of name/value pairs that describe the status of the job
|
235
|
+
# execution. If not specified, the statusDetails are unchanged.
|
236
|
+
# @return [Hash<String,String>]
|
237
|
+
#
|
238
|
+
class StartNextPendingJobExecutionRequest < Struct.new(
|
239
|
+
:thing_name,
|
240
|
+
:status_details)
|
241
|
+
include Aws::Structure
|
242
|
+
end
|
243
|
+
|
244
|
+
# @!attribute [rw] execution
|
245
|
+
# A JobExecution object.
|
246
|
+
# @return [Types::JobExecution]
|
247
|
+
#
|
248
|
+
class StartNextPendingJobExecutionResponse < Struct.new(
|
249
|
+
:execution)
|
250
|
+
include Aws::Structure
|
251
|
+
end
|
252
|
+
|
253
|
+
# @note When making an API call, you may pass UpdateJobExecutionRequest
|
254
|
+
# data as a hash:
|
255
|
+
#
|
256
|
+
# {
|
257
|
+
# job_id: "JobId", # required
|
258
|
+
# thing_name: "ThingName", # required
|
259
|
+
# status: "QUEUED", # required, accepts QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, REJECTED, REMOVED, CANCELED
|
260
|
+
# status_details: {
|
261
|
+
# "DetailsKey" => "DetailsValue",
|
262
|
+
# },
|
263
|
+
# expected_version: 1,
|
264
|
+
# include_job_execution_state: false,
|
265
|
+
# include_job_document: false,
|
266
|
+
# execution_number: 1,
|
267
|
+
# }
|
268
|
+
#
|
269
|
+
# @!attribute [rw] job_id
|
270
|
+
# The unique identifier assigned to this job when it was created.
|
271
|
+
# @return [String]
|
272
|
+
#
|
273
|
+
# @!attribute [rw] thing_name
|
274
|
+
# The name of the thing associated with the device.
|
275
|
+
# @return [String]
|
276
|
+
#
|
277
|
+
# @!attribute [rw] status
|
278
|
+
# The new status for the job execution (IN\_PROGRESS, FAILED, SUCCESS,
|
279
|
+
# or REJECTED). This must be specified on every update.
|
280
|
+
# @return [String]
|
281
|
+
#
|
282
|
+
# @!attribute [rw] status_details
|
283
|
+
# Optional. A collection of name/value pairs that describe the status
|
284
|
+
# of the job execution. If not specified, the statusDetails are
|
285
|
+
# unchanged.
|
286
|
+
# @return [Hash<String,String>]
|
287
|
+
#
|
288
|
+
# @!attribute [rw] expected_version
|
289
|
+
# Optional. The expected current version of the job execution. Each
|
290
|
+
# time you update the job execution, its version is incremented. If
|
291
|
+
# the version of the job execution stored in Jobs does not match, the
|
292
|
+
# update is rejected with a VersionMismatch error, and an
|
293
|
+
# ErrorResponse that contains the current job execution status data is
|
294
|
+
# returned. (This makes it unnecessary to perform a separate
|
295
|
+
# DescribeJobExecution request in order to obtain the job execution
|
296
|
+
# status data.)
|
297
|
+
# @return [Integer]
|
298
|
+
#
|
299
|
+
# @!attribute [rw] include_job_execution_state
|
300
|
+
# Optional. When included and set to true, the response contains the
|
301
|
+
# JobExecutionState data. The default is false.
|
302
|
+
# @return [Boolean]
|
303
|
+
#
|
304
|
+
# @!attribute [rw] include_job_document
|
305
|
+
# Optional. When set to true, the response contains the job document.
|
306
|
+
# The default is false.
|
307
|
+
# @return [Boolean]
|
308
|
+
#
|
309
|
+
# @!attribute [rw] execution_number
|
310
|
+
# Optional. A number that identifies a particular job execution on a
|
311
|
+
# particular device.
|
312
|
+
# @return [Integer]
|
313
|
+
#
|
314
|
+
class UpdateJobExecutionRequest < Struct.new(
|
315
|
+
:job_id,
|
316
|
+
:thing_name,
|
317
|
+
:status,
|
318
|
+
:status_details,
|
319
|
+
:expected_version,
|
320
|
+
:include_job_execution_state,
|
321
|
+
:include_job_document,
|
322
|
+
:execution_number)
|
323
|
+
include Aws::Structure
|
324
|
+
end
|
325
|
+
|
326
|
+
# @!attribute [rw] execution_state
|
327
|
+
# A JobExecutionState object.
|
328
|
+
# @return [Types::JobExecutionState]
|
329
|
+
#
|
330
|
+
# @!attribute [rw] job_document
|
331
|
+
# The contents of the Job Documents.
|
332
|
+
# @return [String]
|
333
|
+
#
|
334
|
+
class UpdateJobExecutionResponse < Struct.new(
|
335
|
+
:execution_state,
|
336
|
+
:job_document)
|
337
|
+
include Aws::Structure
|
338
|
+
end
|
339
|
+
|
340
|
+
end
|
341
|
+
end
|
metadata
ADDED
@@ -0,0 +1,82 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: aws-sdk-iotjobsdataplane
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Amazon Web Services
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-11-29 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: aws-sdk-core
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '3'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '3'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: aws-sigv4
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.0'
|
41
|
+
description: Official AWS Ruby gem for AWS IoT Jobs Data Plane. This gem is part of
|
42
|
+
the AWS SDK for Ruby.
|
43
|
+
email:
|
44
|
+
- trevrowe@amazon.com
|
45
|
+
executables: []
|
46
|
+
extensions: []
|
47
|
+
extra_rdoc_files: []
|
48
|
+
files:
|
49
|
+
- lib/aws-sdk-iotjobsdataplane.rb
|
50
|
+
- lib/aws-sdk-iotjobsdataplane/client.rb
|
51
|
+
- lib/aws-sdk-iotjobsdataplane/client_api.rb
|
52
|
+
- lib/aws-sdk-iotjobsdataplane/customizations.rb
|
53
|
+
- lib/aws-sdk-iotjobsdataplane/errors.rb
|
54
|
+
- lib/aws-sdk-iotjobsdataplane/resource.rb
|
55
|
+
- lib/aws-sdk-iotjobsdataplane/types.rb
|
56
|
+
homepage: http://github.com/aws/aws-sdk-ruby
|
57
|
+
licenses:
|
58
|
+
- Apache-2.0
|
59
|
+
metadata:
|
60
|
+
source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-iotjobsdataplane
|
61
|
+
changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-iotjobsdataplane/CHANGELOG.md
|
62
|
+
post_install_message:
|
63
|
+
rdoc_options: []
|
64
|
+
require_paths:
|
65
|
+
- lib
|
66
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
67
|
+
requirements:
|
68
|
+
- - ">="
|
69
|
+
- !ruby/object:Gem::Version
|
70
|
+
version: '0'
|
71
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
requirements: []
|
77
|
+
rubyforge_project:
|
78
|
+
rubygems_version: 2.5.1
|
79
|
+
signing_key:
|
80
|
+
specification_version: 4
|
81
|
+
summary: AWS SDK for Ruby - AWS IoT Jobs Data Plane
|
82
|
+
test_files: []
|