UNPKG

5.24 kBJSONView Raw
1{
2 "version": "2.0",
3 "metadata": {
4 "apiVersion": "2017-09-29",
5 "endpointPrefix": "data.jobs.iot",
6 "protocol": "rest-json",
7 "serviceFullName": "AWS IoT Jobs Data Plane",
8 "serviceId": "IoT Jobs Data Plane",
9 "signatureVersion": "v4",
10 "signingName": "iot-jobs-data",
11 "uid": "iot-jobs-data-2017-09-29"
12 },
13 "operations": {
14 "DescribeJobExecution": {
15 "http": {
16 "method": "GET",
17 "requestUri": "/things/{thingName}/jobs/{jobId}"
18 },
19 "input": {
20 "type": "structure",
21 "required": [
22 "jobId",
23 "thingName"
24 ],
25 "members": {
26 "jobId": {
27 "location": "uri",
28 "locationName": "jobId"
29 },
30 "thingName": {
31 "location": "uri",
32 "locationName": "thingName"
33 },
34 "includeJobDocument": {
35 "location": "querystring",
36 "locationName": "includeJobDocument",
37 "type": "boolean"
38 },
39 "executionNumber": {
40 "location": "querystring",
41 "locationName": "executionNumber",
42 "type": "long"
43 }
44 }
45 },
46 "output": {
47 "type": "structure",
48 "members": {
49 "execution": {
50 "shape": "S7"
51 }
52 }
53 }
54 },
55 "GetPendingJobExecutions": {
56 "http": {
57 "method": "GET",
58 "requestUri": "/things/{thingName}/jobs"
59 },
60 "input": {
61 "type": "structure",
62 "required": [
63 "thingName"
64 ],
65 "members": {
66 "thingName": {
67 "location": "uri",
68 "locationName": "thingName"
69 }
70 }
71 },
72 "output": {
73 "type": "structure",
74 "members": {
75 "inProgressJobs": {
76 "shape": "Sl"
77 },
78 "queuedJobs": {
79 "shape": "Sl"
80 }
81 }
82 }
83 },
84 "StartNextPendingJobExecution": {
85 "http": {
86 "method": "PUT",
87 "requestUri": "/things/{thingName}/jobs/$next"
88 },
89 "input": {
90 "type": "structure",
91 "required": [
92 "thingName"
93 ],
94 "members": {
95 "thingName": {
96 "location": "uri",
97 "locationName": "thingName"
98 },
99 "statusDetails": {
100 "shape": "Sa"
101 },
102 "stepTimeoutInMinutes": {
103 "type": "long"
104 }
105 }
106 },
107 "output": {
108 "type": "structure",
109 "members": {
110 "execution": {
111 "shape": "S7"
112 }
113 }
114 }
115 },
116 "UpdateJobExecution": {
117 "http": {
118 "requestUri": "/things/{thingName}/jobs/{jobId}"
119 },
120 "input": {
121 "type": "structure",
122 "required": [
123 "jobId",
124 "thingName",
125 "status"
126 ],
127 "members": {
128 "jobId": {
129 "location": "uri",
130 "locationName": "jobId"
131 },
132 "thingName": {
133 "location": "uri",
134 "locationName": "thingName"
135 },
136 "status": {},
137 "statusDetails": {
138 "shape": "Sa"
139 },
140 "stepTimeoutInMinutes": {
141 "type": "long"
142 },
143 "expectedVersion": {
144 "type": "long"
145 },
146 "includeJobExecutionState": {
147 "type": "boolean"
148 },
149 "includeJobDocument": {
150 "type": "boolean"
151 },
152 "executionNumber": {
153 "type": "long"
154 }
155 }
156 },
157 "output": {
158 "type": "structure",
159 "members": {
160 "executionState": {
161 "type": "structure",
162 "members": {
163 "status": {},
164 "statusDetails": {
165 "shape": "Sa"
166 },
167 "versionNumber": {
168 "type": "long"
169 }
170 }
171 },
172 "jobDocument": {}
173 }
174 }
175 }
176 },
177 "shapes": {
178 "S7": {
179 "type": "structure",
180 "members": {
181 "jobId": {},
182 "thingName": {},
183 "status": {},
184 "statusDetails": {
185 "shape": "Sa"
186 },
187 "queuedAt": {
188 "type": "long"
189 },
190 "startedAt": {
191 "type": "long"
192 },
193 "lastUpdatedAt": {
194 "type": "long"
195 },
196 "approximateSecondsBeforeTimedOut": {
197 "type": "long"
198 },
199 "versionNumber": {
200 "type": "long"
201 },
202 "executionNumber": {
203 "type": "long"
204 },
205 "jobDocument": {}
206 }
207 },
208 "Sa": {
209 "type": "map",
210 "key": {},
211 "value": {}
212 },
213 "Sl": {
214 "type": "list",
215 "member": {
216 "type": "structure",
217 "members": {
218 "jobId": {},
219 "queuedAt": {
220 "type": "long"
221 },
222 "startedAt": {
223 "type": "long"
224 },
225 "lastUpdatedAt": {
226 "type": "long"
227 },
228 "versionNumber": {
229 "type": "long"
230 },
231 "executionNumber": {
232 "type": "long"
233 }
234 }
235 }
236 }
237 }
238}
\No newline at end of file