@aws-sdk/client-iot-jobs-data-plane 3.696.0 → 3.699.0
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.
- package/README.md +29 -11
- package/dist-cjs/index.js +214 -1
- package/dist-es/IoTJobsDataPlane.js +2 -0
- package/dist-es/commands/StartCommandExecutionCommand.js +22 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +49 -0
- package/dist-es/protocols/Aws_restJson1.js +119 -2
- package/dist-types/IoTJobsDataPlane.d.ts +28 -11
- package/dist-types/IoTJobsDataPlaneClient.d.ts +24 -13
- package/dist-types/commands/DescribeJobExecutionCommand.d.ts +2 -1
- package/dist-types/commands/GetPendingJobExecutionsCommand.d.ts +2 -1
- package/dist-types/commands/StartCommandExecutionCommand.d.ts +104 -0
- package/dist-types/commands/StartNextPendingJobExecutionCommand.d.ts +4 -2
- package/dist-types/commands/UpdateJobExecutionCommand.d.ts +6 -4
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +21 -11
- package/dist-types/models/models_0.d.ts +226 -55
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/IoTJobsDataPlane.d.ts +17 -0
- package/dist-types/ts3.4/IoTJobsDataPlaneClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/StartCommandExecutionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +46 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +7 -5
|
@@ -12,6 +12,70 @@ export declare class CertificateValidationException extends __BaseException {
|
|
|
12
12
|
*/
|
|
13
13
|
constructor(opts: __ExceptionOptionType<CertificateValidationException, __BaseException>);
|
|
14
14
|
}
|
|
15
|
+
/**
|
|
16
|
+
* <p>The list of values used to describe a specific command parameter.</p>
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
export interface CommandParameterValue {
|
|
20
|
+
/**
|
|
21
|
+
* <p>An attribute of type String. For example:</p>
|
|
22
|
+
* <p>
|
|
23
|
+
* <code>"S": "Hello"</code>
|
|
24
|
+
* </p>
|
|
25
|
+
* @public
|
|
26
|
+
*/
|
|
27
|
+
S?: string | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* <p>An attribute of type Boolean. For example:</p>
|
|
30
|
+
* <p>
|
|
31
|
+
* <code>"BOOL": true</code>
|
|
32
|
+
* </p>
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
B?: boolean | undefined;
|
|
36
|
+
/**
|
|
37
|
+
* <p>An attribute of type Integer (Thirty-Two Bits).</p>
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
I?: number | undefined;
|
|
41
|
+
/**
|
|
42
|
+
* <p>An attribute of type Long.</p>
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
L?: number | undefined;
|
|
46
|
+
/**
|
|
47
|
+
* <p>An attribute of type Double (Sixty-Four Bits).</p>
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
D?: number | undefined;
|
|
51
|
+
/**
|
|
52
|
+
* <p>An attribute of type Binary.</p>
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
BIN?: Uint8Array | undefined;
|
|
56
|
+
/**
|
|
57
|
+
* <p>An attribute of type Unsigned Long.</p>
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
UL?: string | undefined;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* <p>A conflict has occurred when performing the API request.</p>
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
export declare class ConflictException extends __BaseException {
|
|
67
|
+
readonly name: "ConflictException";
|
|
68
|
+
readonly $fault: "client";
|
|
69
|
+
/**
|
|
70
|
+
* <p>A conflict occurred while performing the API request on the resource ID.</p>
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
resourceId?: string | undefined;
|
|
74
|
+
/**
|
|
75
|
+
* @internal
|
|
76
|
+
*/
|
|
77
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
78
|
+
}
|
|
15
79
|
/**
|
|
16
80
|
* @public
|
|
17
81
|
*/
|
|
@@ -27,13 +91,14 @@ export interface DescribeJobExecutionRequest {
|
|
|
27
91
|
*/
|
|
28
92
|
thingName: string | undefined;
|
|
29
93
|
/**
|
|
30
|
-
* <p>Optional.
|
|
94
|
+
* <p>Optional. Unless set to false, the response contains the job document. The default is
|
|
95
|
+
* true.</p>
|
|
31
96
|
* @public
|
|
32
97
|
*/
|
|
33
98
|
includeJobDocument?: boolean | undefined;
|
|
34
99
|
/**
|
|
35
|
-
* <p>Optional. A number that identifies a particular job execution on a particular device.
|
|
36
|
-
* the latest job execution is returned.</p>
|
|
100
|
+
* <p>Optional. A number that identifies a particular job execution on a particular device.
|
|
101
|
+
* If not specified, the latest job execution is returned.</p>
|
|
37
102
|
* @public
|
|
38
103
|
*/
|
|
39
104
|
executionNumber?: number | undefined;
|
|
@@ -72,46 +137,50 @@ export interface JobExecution {
|
|
|
72
137
|
*/
|
|
73
138
|
thingName?: string | undefined;
|
|
74
139
|
/**
|
|
75
|
-
* <p>The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED",
|
|
76
|
-
* "REJECTED", or "REMOVED".</p>
|
|
140
|
+
* <p>The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED",
|
|
141
|
+
* "SUCCESS", "CANCELED", "TIMED_OUT", "REJECTED", or "REMOVED".</p>
|
|
77
142
|
* @public
|
|
78
143
|
*/
|
|
79
144
|
status?: JobExecutionStatus | undefined;
|
|
80
145
|
/**
|
|
81
|
-
* <p>A collection of name/value pairs that describe the status of the job
|
|
146
|
+
* <p>A collection of name/value pairs that describe the status of the job
|
|
147
|
+
* execution.</p>
|
|
148
|
+
* <p>The maximum length of the value in the name/value pair is 1,024 characters.</p>
|
|
82
149
|
* @public
|
|
83
150
|
*/
|
|
84
151
|
statusDetails?: Record<string, string> | undefined;
|
|
85
152
|
/**
|
|
86
|
-
* <p>The time, in
|
|
153
|
+
* <p>The time, in seconds since the epoch, when the job execution was enqueued.</p>
|
|
87
154
|
* @public
|
|
88
155
|
*/
|
|
89
156
|
queuedAt?: number | undefined;
|
|
90
157
|
/**
|
|
91
|
-
* <p>The time, in
|
|
158
|
+
* <p>The time, in seconds since the epoch, when the job execution was started.</p>
|
|
92
159
|
* @public
|
|
93
160
|
*/
|
|
94
161
|
startedAt?: number | undefined;
|
|
95
162
|
/**
|
|
96
|
-
* <p>The time, in
|
|
163
|
+
* <p>The time, in seconds since the epoch, when the job execution was last updated.
|
|
164
|
+
* </p>
|
|
97
165
|
* @public
|
|
98
166
|
*/
|
|
99
167
|
lastUpdatedAt?: number | undefined;
|
|
100
168
|
/**
|
|
101
169
|
* <p>The estimated number of seconds that remain before the job execution status will be
|
|
102
|
-
*
|
|
170
|
+
* changed to <code>TIMED_OUT</code>. The actual job execution timeout can occur up to 60
|
|
171
|
+
* seconds later than the estimated duration.</p>
|
|
103
172
|
* @public
|
|
104
173
|
*/
|
|
105
174
|
approximateSecondsBeforeTimedOut?: number | undefined;
|
|
106
175
|
/**
|
|
107
|
-
* <p>The version of the job execution. Job execution versions are incremented each time
|
|
108
|
-
* device.</p>
|
|
176
|
+
* <p>The version of the job execution. Job execution versions are incremented each time
|
|
177
|
+
* they are updated by a device.</p>
|
|
109
178
|
* @public
|
|
110
179
|
*/
|
|
111
180
|
versionNumber?: number | undefined;
|
|
112
181
|
/**
|
|
113
|
-
* <p>A number that identifies a particular job execution on a particular device. It can be
|
|
114
|
-
* commands that return or update job execution information.</p>
|
|
182
|
+
* <p>A number that identifies a particular job execution on a particular device. It can be
|
|
183
|
+
* used later in commands that return or update job execution information.</p>
|
|
115
184
|
* @public
|
|
116
185
|
*/
|
|
117
186
|
executionNumber?: number | undefined;
|
|
@@ -132,7 +201,7 @@ export interface DescribeJobExecutionResponse {
|
|
|
132
201
|
execution?: JobExecution | undefined;
|
|
133
202
|
}
|
|
134
203
|
/**
|
|
135
|
-
* <p>The contents of the request were invalid
|
|
204
|
+
* <p>The contents of the request were invalid.</p>
|
|
136
205
|
* @public
|
|
137
206
|
*/
|
|
138
207
|
export declare class InvalidRequestException extends __BaseException {
|
|
@@ -217,23 +286,24 @@ export interface JobExecutionSummary {
|
|
|
217
286
|
*/
|
|
218
287
|
jobId?: string | undefined;
|
|
219
288
|
/**
|
|
220
|
-
* <p>The time, in
|
|
289
|
+
* <p>The time, in seconds since the epoch, when the job execution was enqueued.</p>
|
|
221
290
|
* @public
|
|
222
291
|
*/
|
|
223
292
|
queuedAt?: number | undefined;
|
|
224
293
|
/**
|
|
225
|
-
* <p>The time, in
|
|
294
|
+
* <p>The time, in seconds since the epoch, when the job execution started.</p>
|
|
226
295
|
* @public
|
|
227
296
|
*/
|
|
228
297
|
startedAt?: number | undefined;
|
|
229
298
|
/**
|
|
230
|
-
* <p>The time, in
|
|
299
|
+
* <p>The time, in seconds since the epoch, when the job execution was last
|
|
300
|
+
* updated.</p>
|
|
231
301
|
* @public
|
|
232
302
|
*/
|
|
233
303
|
lastUpdatedAt?: number | undefined;
|
|
234
304
|
/**
|
|
235
|
-
* <p>The version of the job execution. Job execution versions are incremented each time
|
|
236
|
-
* an update from a device.</p>
|
|
305
|
+
* <p>The version of the job execution. Job execution versions are incremented each time
|
|
306
|
+
* IoT Jobs receives an update from a device.</p>
|
|
237
307
|
* @public
|
|
238
308
|
*/
|
|
239
309
|
versionNumber?: number | undefined;
|
|
@@ -259,9 +329,22 @@ export interface GetPendingJobExecutionsResponse {
|
|
|
259
329
|
queuedJobs?: JobExecutionSummary[] | undefined;
|
|
260
330
|
}
|
|
261
331
|
/**
|
|
262
|
-
* <p>An
|
|
263
|
-
*
|
|
264
|
-
|
|
332
|
+
* <p>An internal server error occurred when performing the API request.</p>
|
|
333
|
+
* @public
|
|
334
|
+
*/
|
|
335
|
+
export declare class InternalServerException extends __BaseException {
|
|
336
|
+
readonly name: "InternalServerException";
|
|
337
|
+
readonly $fault: "server";
|
|
338
|
+
/**
|
|
339
|
+
* @internal
|
|
340
|
+
*/
|
|
341
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
342
|
+
}
|
|
343
|
+
/**
|
|
344
|
+
* <p>An update attempted to change the job execution to a state that is invalid because of
|
|
345
|
+
* the job execution's current state (for example, an attempt to change a request in state
|
|
346
|
+
* SUCCESS to state IN_PROGRESS). In this case, the body of the error message also contains
|
|
347
|
+
* the executionState field.</p>
|
|
265
348
|
* @public
|
|
266
349
|
*/
|
|
267
350
|
export declare class InvalidStateTransitionException extends __BaseException {
|
|
@@ -272,6 +355,81 @@ export declare class InvalidStateTransitionException extends __BaseException {
|
|
|
272
355
|
*/
|
|
273
356
|
constructor(opts: __ExceptionOptionType<InvalidStateTransitionException, __BaseException>);
|
|
274
357
|
}
|
|
358
|
+
/**
|
|
359
|
+
* <p>The service quota has been exceeded for this request.</p>
|
|
360
|
+
* @public
|
|
361
|
+
*/
|
|
362
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
363
|
+
readonly name: "ServiceQuotaExceededException";
|
|
364
|
+
readonly $fault: "client";
|
|
365
|
+
/**
|
|
366
|
+
* @internal
|
|
367
|
+
*/
|
|
368
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
369
|
+
}
|
|
370
|
+
/**
|
|
371
|
+
* @public
|
|
372
|
+
*/
|
|
373
|
+
export interface StartCommandExecutionRequest {
|
|
374
|
+
/**
|
|
375
|
+
* <p>The Amazon Resource Number (ARN) of the device where the command execution is
|
|
376
|
+
* occurring.</p>
|
|
377
|
+
* @public
|
|
378
|
+
*/
|
|
379
|
+
targetArn: string | undefined;
|
|
380
|
+
/**
|
|
381
|
+
* <p>The Amazon Resource Number (ARN) of the command. For example,
|
|
382
|
+
* <code>arn:aws:iot:<region>:<accountid>:command/<commandName></code>
|
|
383
|
+
* </p>
|
|
384
|
+
* @public
|
|
385
|
+
*/
|
|
386
|
+
commandArn: string | undefined;
|
|
387
|
+
/**
|
|
388
|
+
* <p>A list of parameters that are required by the <code>StartCommandExecution</code> API
|
|
389
|
+
* when performing the command on a device.</p>
|
|
390
|
+
* @public
|
|
391
|
+
*/
|
|
392
|
+
parameters?: Record<string, CommandParameterValue> | undefined;
|
|
393
|
+
/**
|
|
394
|
+
* <p>Specifies the amount of time in second the device has to finish the command execution. A
|
|
395
|
+
* timer is started as soon as the command execution is created. If the command execution
|
|
396
|
+
* status is not set to another terminal state before the timer expires, it will automatically
|
|
397
|
+
* update to <code>TIMED_OUT</code>.</p>
|
|
398
|
+
* @public
|
|
399
|
+
*/
|
|
400
|
+
executionTimeoutSeconds?: number | undefined;
|
|
401
|
+
/**
|
|
402
|
+
* <p>The client token is used to implement idempotency. It ensures that the request completes
|
|
403
|
+
* no more than one time. If you retry a request with the same token and the same parameters,
|
|
404
|
+
* the request will complete successfully. However, if you retry the request using the same
|
|
405
|
+
* token but different parameters, an HTTP 409 conflict occurs. If you omit this value, Amazon Web Services
|
|
406
|
+
* SDKs will automatically generate a unique client request.</p>
|
|
407
|
+
* @public
|
|
408
|
+
*/
|
|
409
|
+
clientToken?: string | undefined;
|
|
410
|
+
}
|
|
411
|
+
/**
|
|
412
|
+
* @public
|
|
413
|
+
*/
|
|
414
|
+
export interface StartCommandExecutionResponse {
|
|
415
|
+
/**
|
|
416
|
+
* <p>A unique identifier for the command execution.</p>
|
|
417
|
+
* @public
|
|
418
|
+
*/
|
|
419
|
+
executionId?: string | undefined;
|
|
420
|
+
}
|
|
421
|
+
/**
|
|
422
|
+
* <p>A validation error occurred when performing the API request.</p>
|
|
423
|
+
* @public
|
|
424
|
+
*/
|
|
425
|
+
export declare class ValidationException extends __BaseException {
|
|
426
|
+
readonly name: "ValidationException";
|
|
427
|
+
readonly $fault: "client";
|
|
428
|
+
/**
|
|
429
|
+
* @internal
|
|
430
|
+
*/
|
|
431
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
432
|
+
}
|
|
275
433
|
/**
|
|
276
434
|
* @public
|
|
277
435
|
*/
|
|
@@ -282,19 +440,22 @@ export interface StartNextPendingJobExecutionRequest {
|
|
|
282
440
|
*/
|
|
283
441
|
thingName: string | undefined;
|
|
284
442
|
/**
|
|
285
|
-
* <p>A collection of name/value pairs that describe the status of the job execution. If
|
|
286
|
-
* statusDetails are unchanged.</p>
|
|
443
|
+
* <p>A collection of name/value pairs that describe the status of the job execution. If
|
|
444
|
+
* not specified, the statusDetails are unchanged.</p>
|
|
445
|
+
* <p>The maximum length of the value in the name/value pair is 1,024 characters.</p>
|
|
287
446
|
* @public
|
|
288
447
|
*/
|
|
289
448
|
statusDetails?: Record<string, string> | undefined;
|
|
290
449
|
/**
|
|
291
450
|
* <p>Specifies the amount of time this device has to finish execution of this job. If the job
|
|
292
|
-
*
|
|
293
|
-
*
|
|
294
|
-
*
|
|
295
|
-
*
|
|
296
|
-
*
|
|
297
|
-
*
|
|
451
|
+
* execution status is not set to a terminal state before this timer expires, or before the
|
|
452
|
+
* timer is reset (by calling <code>UpdateJobExecution</code>, setting the status to
|
|
453
|
+
* <code>IN_PROGRESS</code>, and specifying a new timeout value in field
|
|
454
|
+
* <code>stepTimeoutInMinutes</code>) the job execution status will be automatically set to
|
|
455
|
+
* <code>TIMED_OUT</code>. Note that setting the step timeout has no effect on the in
|
|
456
|
+
* progress timeout that may have been specified when the job was created
|
|
457
|
+
* (<code>CreateJob</code> using field <code>timeoutConfig</code>).</p>
|
|
458
|
+
* <p>Valid values for this parameter range from 1 to 10080 (1 minute to 7 days).</p>
|
|
298
459
|
* @public
|
|
299
460
|
*/
|
|
300
461
|
stepTimeoutInMinutes?: number | undefined;
|
|
@@ -324,50 +485,58 @@ export interface UpdateJobExecutionRequest {
|
|
|
324
485
|
*/
|
|
325
486
|
thingName: string | undefined;
|
|
326
487
|
/**
|
|
327
|
-
* <p>The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED).
|
|
328
|
-
* on every update.</p>
|
|
488
|
+
* <p>The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED).
|
|
489
|
+
* This must be specified on every update.</p>
|
|
329
490
|
* @public
|
|
330
491
|
*/
|
|
331
492
|
status: JobExecutionStatus | undefined;
|
|
332
493
|
/**
|
|
333
|
-
* <p> Optional. A collection of name/value pairs that describe the status of the job
|
|
334
|
-
* specified, the statusDetails are unchanged.</p>
|
|
494
|
+
* <p> Optional. A collection of name/value pairs that describe the status of the job
|
|
495
|
+
* execution. If not specified, the statusDetails are unchanged.</p>
|
|
496
|
+
* <p>The maximum length of the value in the name/value pair is 1,024 characters.</p>
|
|
335
497
|
* @public
|
|
336
498
|
*/
|
|
337
499
|
statusDetails?: Record<string, string> | undefined;
|
|
338
500
|
/**
|
|
339
501
|
* <p>Specifies the amount of time this device has to finish execution of this job. If the job
|
|
340
|
-
*
|
|
341
|
-
*
|
|
342
|
-
*
|
|
343
|
-
*
|
|
344
|
-
*
|
|
345
|
-
*
|
|
502
|
+
* execution status is not set to a terminal state before this timer expires, or before the
|
|
503
|
+
* timer is reset (by again calling <code>UpdateJobExecution</code>, setting the status to
|
|
504
|
+
* <code>IN_PROGRESS</code>, and specifying a new timeout value in this field) the job
|
|
505
|
+
* execution status will be automatically set to <code>TIMED_OUT</code>. Note that setting or
|
|
506
|
+
* resetting the step timeout has no effect on the in progress timeout that may have been
|
|
507
|
+
* specified when the job was created (<code>CreateJob</code> using field
|
|
508
|
+
* <code>timeoutConfig</code>).</p>
|
|
509
|
+
* <p>Valid values for this parameter range from 1 to 10080 (1 minute to 7 days). A value of
|
|
510
|
+
* -1 is also valid and will cancel the current step timer (created by an earlier use of
|
|
511
|
+
* <code>UpdateJobExecutionRequest</code>).</p>
|
|
346
512
|
* @public
|
|
347
513
|
*/
|
|
348
514
|
stepTimeoutInMinutes?: number | undefined;
|
|
349
515
|
/**
|
|
350
|
-
* <p>Optional. The expected current version of the job execution. Each time you update the
|
|
351
|
-
* version is incremented. If the version of the job execution stored in
|
|
352
|
-
* rejected with a VersionMismatch error, and an
|
|
353
|
-
*
|
|
354
|
-
*
|
|
516
|
+
* <p>Optional. The expected current version of the job execution. Each time you update the
|
|
517
|
+
* job execution, its version is incremented. If the version of the job execution stored in
|
|
518
|
+
* Jobs does not match, the update is rejected with a VersionMismatch error, and an
|
|
519
|
+
* ErrorResponse that contains the current job execution status data is returned. (This makes
|
|
520
|
+
* it unnecessary to perform a separate DescribeJobExecution request in order to obtain the
|
|
521
|
+
* job execution status data.)</p>
|
|
355
522
|
* @public
|
|
356
523
|
*/
|
|
357
524
|
expectedVersion?: number | undefined;
|
|
358
525
|
/**
|
|
359
|
-
* <p>Optional. When included and set to true, the response contains the JobExecutionState
|
|
360
|
-
* false.</p>
|
|
526
|
+
* <p>Optional. When included and set to true, the response contains the JobExecutionState
|
|
527
|
+
* data. The default is false.</p>
|
|
361
528
|
* @public
|
|
362
529
|
*/
|
|
363
530
|
includeJobExecutionState?: boolean | undefined;
|
|
364
531
|
/**
|
|
365
|
-
* <p>Optional. When set to true, the response contains the job document. The default is
|
|
532
|
+
* <p>Optional. When set to true, the response contains the job document. The default is
|
|
533
|
+
* false.</p>
|
|
366
534
|
* @public
|
|
367
535
|
*/
|
|
368
536
|
includeJobDocument?: boolean | undefined;
|
|
369
537
|
/**
|
|
370
|
-
* <p>Optional. A number that identifies a particular job execution on a particular
|
|
538
|
+
* <p>Optional. A number that identifies a particular job execution on a particular
|
|
539
|
+
* device.</p>
|
|
371
540
|
* @public
|
|
372
541
|
*/
|
|
373
542
|
executionNumber?: number | undefined;
|
|
@@ -378,19 +547,21 @@ export interface UpdateJobExecutionRequest {
|
|
|
378
547
|
*/
|
|
379
548
|
export interface JobExecutionState {
|
|
380
549
|
/**
|
|
381
|
-
* <p>The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED",
|
|
382
|
-
* "REJECTED", or "REMOVED".</p>
|
|
550
|
+
* <p>The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED",
|
|
551
|
+
* "SUCCESS", "CANCELED", "TIMED_OUT", "REJECTED", or "REMOVED".</p>
|
|
383
552
|
* @public
|
|
384
553
|
*/
|
|
385
554
|
status?: JobExecutionStatus | undefined;
|
|
386
555
|
/**
|
|
387
|
-
* <p>A collection of name/value pairs that describe the status of the job
|
|
556
|
+
* <p>A collection of name/value pairs that describe the status of the job
|
|
557
|
+
* execution.</p>
|
|
558
|
+
* <p>The maximum length of the value in the name/value pair is 1,024 characters.</p>
|
|
388
559
|
* @public
|
|
389
560
|
*/
|
|
390
561
|
statusDetails?: Record<string, string> | undefined;
|
|
391
562
|
/**
|
|
392
|
-
* <p>The version of the job execution. Job execution versions are incremented each time
|
|
393
|
-
* device.</p>
|
|
563
|
+
* <p>The version of the job execution. Job execution versions are incremented each time
|
|
564
|
+
* they are updated by a device.</p>
|
|
394
565
|
* @public
|
|
395
566
|
*/
|
|
396
567
|
versionNumber?: number | undefined;
|
|
@@ -2,6 +2,7 @@ import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@s
|
|
|
2
2
|
import { SerdeContext as __SerdeContext } from "@smithy/types";
|
|
3
3
|
import { DescribeJobExecutionCommandInput, DescribeJobExecutionCommandOutput } from "../commands/DescribeJobExecutionCommand";
|
|
4
4
|
import { GetPendingJobExecutionsCommandInput, GetPendingJobExecutionsCommandOutput } from "../commands/GetPendingJobExecutionsCommand";
|
|
5
|
+
import { StartCommandExecutionCommandInput, StartCommandExecutionCommandOutput } from "../commands/StartCommandExecutionCommand";
|
|
5
6
|
import { StartNextPendingJobExecutionCommandInput, StartNextPendingJobExecutionCommandOutput } from "../commands/StartNextPendingJobExecutionCommand";
|
|
6
7
|
import { UpdateJobExecutionCommandInput, UpdateJobExecutionCommandOutput } from "../commands/UpdateJobExecutionCommand";
|
|
7
8
|
/**
|
|
@@ -12,6 +13,10 @@ export declare const se_DescribeJobExecutionCommand: (input: DescribeJobExecutio
|
|
|
12
13
|
* serializeAws_restJson1GetPendingJobExecutionsCommand
|
|
13
14
|
*/
|
|
14
15
|
export declare const se_GetPendingJobExecutionsCommand: (input: GetPendingJobExecutionsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
16
|
+
/**
|
|
17
|
+
* serializeAws_restJson1StartCommandExecutionCommand
|
|
18
|
+
*/
|
|
19
|
+
export declare const se_StartCommandExecutionCommand: (input: StartCommandExecutionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
15
20
|
/**
|
|
16
21
|
* serializeAws_restJson1StartNextPendingJobExecutionCommand
|
|
17
22
|
*/
|
|
@@ -28,6 +33,10 @@ export declare const de_DescribeJobExecutionCommand: (output: __HttpResponse, co
|
|
|
28
33
|
* deserializeAws_restJson1GetPendingJobExecutionsCommand
|
|
29
34
|
*/
|
|
30
35
|
export declare const de_GetPendingJobExecutionsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetPendingJobExecutionsCommandOutput>;
|
|
36
|
+
/**
|
|
37
|
+
* deserializeAws_restJson1StartCommandExecutionCommand
|
|
38
|
+
*/
|
|
39
|
+
export declare const de_StartCommandExecutionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<StartCommandExecutionCommandOutput>;
|
|
31
40
|
/**
|
|
32
41
|
* deserializeAws_restJson1StartNextPendingJobExecutionCommand
|
|
33
42
|
*/
|
|
@@ -7,6 +7,10 @@ import {
|
|
|
7
7
|
GetPendingJobExecutionsCommandInput,
|
|
8
8
|
GetPendingJobExecutionsCommandOutput,
|
|
9
9
|
} from "./commands/GetPendingJobExecutionsCommand";
|
|
10
|
+
import {
|
|
11
|
+
StartCommandExecutionCommandInput,
|
|
12
|
+
StartCommandExecutionCommandOutput,
|
|
13
|
+
} from "./commands/StartCommandExecutionCommand";
|
|
10
14
|
import {
|
|
11
15
|
StartNextPendingJobExecutionCommandInput,
|
|
12
16
|
StartNextPendingJobExecutionCommandOutput,
|
|
@@ -43,6 +47,19 @@ export interface IoTJobsDataPlane {
|
|
|
43
47
|
options: __HttpHandlerOptions,
|
|
44
48
|
cb: (err: any, data?: GetPendingJobExecutionsCommandOutput) => void
|
|
45
49
|
): void;
|
|
50
|
+
startCommandExecution(
|
|
51
|
+
args: StartCommandExecutionCommandInput,
|
|
52
|
+
options?: __HttpHandlerOptions
|
|
53
|
+
): Promise<StartCommandExecutionCommandOutput>;
|
|
54
|
+
startCommandExecution(
|
|
55
|
+
args: StartCommandExecutionCommandInput,
|
|
56
|
+
cb: (err: any, data?: StartCommandExecutionCommandOutput) => void
|
|
57
|
+
): void;
|
|
58
|
+
startCommandExecution(
|
|
59
|
+
args: StartCommandExecutionCommandInput,
|
|
60
|
+
options: __HttpHandlerOptions,
|
|
61
|
+
cb: (err: any, data?: StartCommandExecutionCommandOutput) => void
|
|
62
|
+
): void;
|
|
46
63
|
startNextPendingJobExecution(
|
|
47
64
|
args: StartNextPendingJobExecutionCommandInput,
|
|
48
65
|
options?: __HttpHandlerOptions
|
|
@@ -53,6 +53,10 @@ import {
|
|
|
53
53
|
GetPendingJobExecutionsCommandInput,
|
|
54
54
|
GetPendingJobExecutionsCommandOutput,
|
|
55
55
|
} from "./commands/GetPendingJobExecutionsCommand";
|
|
56
|
+
import {
|
|
57
|
+
StartCommandExecutionCommandInput,
|
|
58
|
+
StartCommandExecutionCommandOutput,
|
|
59
|
+
} from "./commands/StartCommandExecutionCommand";
|
|
56
60
|
import {
|
|
57
61
|
StartNextPendingJobExecutionCommandInput,
|
|
58
62
|
StartNextPendingJobExecutionCommandOutput,
|
|
@@ -71,11 +75,13 @@ export { __Client };
|
|
|
71
75
|
export type ServiceInputTypes =
|
|
72
76
|
| DescribeJobExecutionCommandInput
|
|
73
77
|
| GetPendingJobExecutionsCommandInput
|
|
78
|
+
| StartCommandExecutionCommandInput
|
|
74
79
|
| StartNextPendingJobExecutionCommandInput
|
|
75
80
|
| UpdateJobExecutionCommandInput;
|
|
76
81
|
export type ServiceOutputTypes =
|
|
77
82
|
| DescribeJobExecutionCommandOutput
|
|
78
83
|
| GetPendingJobExecutionsCommandOutput
|
|
84
|
+
| StartCommandExecutionCommandOutput
|
|
79
85
|
| StartNextPendingJobExecutionCommandOutput
|
|
80
86
|
| UpdateJobExecutionCommandOutput;
|
|
81
87
|
export interface ClientDefaults
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import {
|
|
4
|
+
IoTJobsDataPlaneClientResolvedConfig,
|
|
5
|
+
ServiceInputTypes,
|
|
6
|
+
ServiceOutputTypes,
|
|
7
|
+
} from "../IoTJobsDataPlaneClient";
|
|
8
|
+
import {
|
|
9
|
+
StartCommandExecutionRequest,
|
|
10
|
+
StartCommandExecutionResponse,
|
|
11
|
+
} from "../models/models_0";
|
|
12
|
+
export { __MetadataBearer };
|
|
13
|
+
export { $Command };
|
|
14
|
+
export interface StartCommandExecutionCommandInput
|
|
15
|
+
extends StartCommandExecutionRequest {}
|
|
16
|
+
export interface StartCommandExecutionCommandOutput
|
|
17
|
+
extends StartCommandExecutionResponse,
|
|
18
|
+
__MetadataBearer {}
|
|
19
|
+
declare const StartCommandExecutionCommand_base: {
|
|
20
|
+
new (
|
|
21
|
+
input: StartCommandExecutionCommandInput
|
|
22
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
23
|
+
StartCommandExecutionCommandInput,
|
|
24
|
+
StartCommandExecutionCommandOutput,
|
|
25
|
+
IoTJobsDataPlaneClientResolvedConfig,
|
|
26
|
+
ServiceInputTypes,
|
|
27
|
+
ServiceOutputTypes
|
|
28
|
+
>;
|
|
29
|
+
new (
|
|
30
|
+
__0_0: StartCommandExecutionCommandInput
|
|
31
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
32
|
+
StartCommandExecutionCommandInput,
|
|
33
|
+
StartCommandExecutionCommandOutput,
|
|
34
|
+
IoTJobsDataPlaneClientResolvedConfig,
|
|
35
|
+
ServiceInputTypes,
|
|
36
|
+
ServiceOutputTypes
|
|
37
|
+
>;
|
|
38
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
39
|
+
};
|
|
40
|
+
export declare class StartCommandExecutionCommand extends StartCommandExecutionCommand_base {
|
|
41
|
+
protected static __types: {
|
|
42
|
+
api: {
|
|
43
|
+
input: StartCommandExecutionRequest;
|
|
44
|
+
output: StartCommandExecutionResponse;
|
|
45
|
+
};
|
|
46
|
+
sdk: {
|
|
47
|
+
input: StartCommandExecutionCommandInput;
|
|
48
|
+
output: StartCommandExecutionCommandOutput;
|
|
49
|
+
};
|
|
50
|
+
};
|
|
51
|
+
}
|
|
@@ -7,6 +7,21 @@ export declare class CertificateValidationException extends __BaseException {
|
|
|
7
7
|
opts: __ExceptionOptionType<CertificateValidationException, __BaseException>
|
|
8
8
|
);
|
|
9
9
|
}
|
|
10
|
+
export interface CommandParameterValue {
|
|
11
|
+
S?: string | undefined;
|
|
12
|
+
B?: boolean | undefined;
|
|
13
|
+
I?: number | undefined;
|
|
14
|
+
L?: number | undefined;
|
|
15
|
+
D?: number | undefined;
|
|
16
|
+
BIN?: Uint8Array | undefined;
|
|
17
|
+
UL?: string | undefined;
|
|
18
|
+
}
|
|
19
|
+
export declare class ConflictException extends __BaseException {
|
|
20
|
+
readonly name: "ConflictException";
|
|
21
|
+
readonly $fault: "client";
|
|
22
|
+
resourceId?: string | undefined;
|
|
23
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
24
|
+
}
|
|
10
25
|
export interface DescribeJobExecutionRequest {
|
|
11
26
|
jobId: string | undefined;
|
|
12
27
|
thingName: string | undefined;
|
|
@@ -92,6 +107,13 @@ export interface GetPendingJobExecutionsResponse {
|
|
|
92
107
|
inProgressJobs?: JobExecutionSummary[] | undefined;
|
|
93
108
|
queuedJobs?: JobExecutionSummary[] | undefined;
|
|
94
109
|
}
|
|
110
|
+
export declare class InternalServerException extends __BaseException {
|
|
111
|
+
readonly name: "InternalServerException";
|
|
112
|
+
readonly $fault: "server";
|
|
113
|
+
constructor(
|
|
114
|
+
opts: __ExceptionOptionType<InternalServerException, __BaseException>
|
|
115
|
+
);
|
|
116
|
+
}
|
|
95
117
|
export declare class InvalidStateTransitionException extends __BaseException {
|
|
96
118
|
readonly name: "InvalidStateTransitionException";
|
|
97
119
|
readonly $fault: "client";
|
|
@@ -102,6 +124,30 @@ export declare class InvalidStateTransitionException extends __BaseException {
|
|
|
102
124
|
>
|
|
103
125
|
);
|
|
104
126
|
}
|
|
127
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
128
|
+
readonly name: "ServiceQuotaExceededException";
|
|
129
|
+
readonly $fault: "client";
|
|
130
|
+
constructor(
|
|
131
|
+
opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
|
|
132
|
+
);
|
|
133
|
+
}
|
|
134
|
+
export interface StartCommandExecutionRequest {
|
|
135
|
+
targetArn: string | undefined;
|
|
136
|
+
commandArn: string | undefined;
|
|
137
|
+
parameters?: Record<string, CommandParameterValue> | undefined;
|
|
138
|
+
executionTimeoutSeconds?: number | undefined;
|
|
139
|
+
clientToken?: string | undefined;
|
|
140
|
+
}
|
|
141
|
+
export interface StartCommandExecutionResponse {
|
|
142
|
+
executionId?: string | undefined;
|
|
143
|
+
}
|
|
144
|
+
export declare class ValidationException extends __BaseException {
|
|
145
|
+
readonly name: "ValidationException";
|
|
146
|
+
readonly $fault: "client";
|
|
147
|
+
constructor(
|
|
148
|
+
opts: __ExceptionOptionType<ValidationException, __BaseException>
|
|
149
|
+
);
|
|
150
|
+
}
|
|
105
151
|
export interface StartNextPendingJobExecutionRequest {
|
|
106
152
|
thingName: string | undefined;
|
|
107
153
|
statusDetails?: Record<string, string> | undefined;
|