@aws-sdk/client-iot-jobs-data-plane 3.36.0 → 3.36.1

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.
@@ -1,44 +1,27 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
- /**
3
- * <p>The certificate is invalid.</p>
4
- */
2
+
5
3
  export interface CertificateValidationException extends __SmithyException, $MetadataBearer {
6
4
  name: "CertificateValidationException";
7
5
  $fault: "client";
8
- /**
9
- * <p>Additional information about the exception.</p>
10
- */
6
+
11
7
  message?: string;
12
8
  }
13
9
  export declare namespace CertificateValidationException {
14
- /**
15
- * @internal
16
- */
10
+
17
11
  const filterSensitiveLog: (obj: CertificateValidationException) => any;
18
12
  }
19
13
  export interface DescribeJobExecutionRequest {
20
- /**
21
- * <p>The unique identifier assigned to this job when it was created.</p>
22
- */
14
+
23
15
  jobId: string | undefined;
24
- /**
25
- * <p>The thing name associated with the device the job execution is running on.</p>
26
- */
16
+
27
17
  thingName: string | undefined;
28
- /**
29
- * <p>Optional. When set to true, the response contains the job document. The default is false.</p>
30
- */
18
+
31
19
  includeJobDocument?: boolean;
32
- /**
33
- * <p>Optional. A number that identifies a particular job execution on a particular device. If not specified,
34
- * the latest job execution is returned.</p>
35
- */
20
+
36
21
  executionNumber?: number;
37
22
  }
38
23
  export declare namespace DescribeJobExecutionRequest {
39
- /**
40
- * @internal
41
- */
24
+
42
25
  const filterSensitiveLog: (obj: DescribeJobExecutionRequest) => any;
43
26
  }
44
27
  export declare enum JobExecutionStatus {
@@ -51,385 +34,218 @@ export declare enum JobExecutionStatus {
51
34
  SUCCEEDED = "SUCCEEDED",
52
35
  TIMED_OUT = "TIMED_OUT"
53
36
  }
54
- /**
55
- * <p>Contains data about a job execution.</p>
56
- */
37
+
57
38
  export interface JobExecution {
58
- /**
59
- * <p>The unique identifier you assigned to this job when it was created.</p>
60
- */
39
+
61
40
  jobId?: string;
62
- /**
63
- * <p>The name of the thing that is executing the job.</p>
64
- */
41
+
65
42
  thingName?: string;
66
- /**
67
- * <p>The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED",
68
- * "REJECTED", or "REMOVED".</p>
69
- */
43
+
70
44
  status?: JobExecutionStatus | string;
71
- /**
72
- * <p>A collection of name/value pairs that describe the status of the job execution.</p>
73
- */
45
+
74
46
  statusDetails?: {
75
47
  [key: string]: string;
76
48
  };
77
- /**
78
- * <p>The time, in milliseconds since the epoch, when the job execution was enqueued.</p>
79
- */
49
+
80
50
  queuedAt?: number;
81
- /**
82
- * <p>The time, in milliseconds since the epoch, when the job execution was started.</p>
83
- */
51
+
84
52
  startedAt?: number;
85
- /**
86
- * <p>The time, in milliseconds since the epoch, when the job execution was last updated. </p>
87
- */
53
+
88
54
  lastUpdatedAt?: number;
89
- /**
90
- * <p>The estimated number of seconds that remain before the job execution status will be
91
- * changed to <code>TIMED_OUT</code>.</p>
92
- */
55
+
93
56
  approximateSecondsBeforeTimedOut?: number;
94
- /**
95
- * <p>The version of the job execution. Job execution versions are incremented each time they are updated by a
96
- * device.</p>
97
- */
57
+
98
58
  versionNumber?: number;
99
- /**
100
- * <p>A number that identifies a particular job execution on a particular device. It can be used later in
101
- * commands that return or update job execution information.</p>
102
- */
59
+
103
60
  executionNumber?: number;
104
- /**
105
- * <p>The content of the job document.</p>
106
- */
61
+
107
62
  jobDocument?: string;
108
63
  }
109
64
  export declare namespace JobExecution {
110
- /**
111
- * @internal
112
- */
65
+
113
66
  const filterSensitiveLog: (obj: JobExecution) => any;
114
67
  }
115
68
  export interface DescribeJobExecutionResponse {
116
- /**
117
- * <p>Contains data about a job execution.</p>
118
- */
69
+
119
70
  execution?: JobExecution;
120
71
  }
121
72
  export declare namespace DescribeJobExecutionResponse {
122
- /**
123
- * @internal
124
- */
73
+
125
74
  const filterSensitiveLog: (obj: DescribeJobExecutionResponse) => any;
126
75
  }
127
- /**
128
- * <p>The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.</p>
129
- */
76
+
130
77
  export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
131
78
  name: "InvalidRequestException";
132
79
  $fault: "client";
133
- /**
134
- * <p>The message for the exception.</p>
135
- */
80
+
136
81
  message?: string;
137
82
  }
138
83
  export declare namespace InvalidRequestException {
139
- /**
140
- * @internal
141
- */
84
+
142
85
  const filterSensitiveLog: (obj: InvalidRequestException) => any;
143
86
  }
144
- /**
145
- * <p>The specified resource does not exist.</p>
146
- */
87
+
147
88
  export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
148
89
  name: "ResourceNotFoundException";
149
90
  $fault: "client";
150
- /**
151
- * <p>The message for the exception.</p>
152
- */
91
+
153
92
  message?: string;
154
93
  }
155
94
  export declare namespace ResourceNotFoundException {
156
- /**
157
- * @internal
158
- */
95
+
159
96
  const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
160
97
  }
161
- /**
162
- * <p>The service is temporarily unavailable.</p>
163
- */
98
+
164
99
  export interface ServiceUnavailableException extends __SmithyException, $MetadataBearer {
165
100
  name: "ServiceUnavailableException";
166
101
  $fault: "server";
167
- /**
168
- * <p>The message for the exception.</p>
169
- */
102
+
170
103
  message?: string;
171
104
  }
172
105
  export declare namespace ServiceUnavailableException {
173
- /**
174
- * @internal
175
- */
106
+
176
107
  const filterSensitiveLog: (obj: ServiceUnavailableException) => any;
177
108
  }
178
- /**
179
- * <p>The job is in a terminal state.</p>
180
- */
109
+
181
110
  export interface TerminalStateException extends __SmithyException, $MetadataBearer {
182
111
  name: "TerminalStateException";
183
112
  $fault: "client";
184
113
  message?: string;
185
114
  }
186
115
  export declare namespace TerminalStateException {
187
- /**
188
- * @internal
189
- */
116
+
190
117
  const filterSensitiveLog: (obj: TerminalStateException) => any;
191
118
  }
192
- /**
193
- * <p>The rate exceeds the limit.</p>
194
- */
119
+
195
120
  export interface ThrottlingException extends __SmithyException, $MetadataBearer {
196
121
  name: "ThrottlingException";
197
122
  $fault: "client";
198
- /**
199
- * <p>The message associated with the exception.</p>
200
- */
123
+
201
124
  message?: string;
202
- /**
203
- * <p>The payload associated with the exception.</p>
204
- */
125
+
205
126
  payload?: Uint8Array;
206
127
  }
207
128
  export declare namespace ThrottlingException {
208
- /**
209
- * @internal
210
- */
129
+
211
130
  const filterSensitiveLog: (obj: ThrottlingException) => any;
212
131
  }
213
132
  export interface GetPendingJobExecutionsRequest {
214
- /**
215
- * <p>The name of the thing that is executing the job.</p>
216
- */
133
+
217
134
  thingName: string | undefined;
218
135
  }
219
136
  export declare namespace GetPendingJobExecutionsRequest {
220
- /**
221
- * @internal
222
- */
137
+
223
138
  const filterSensitiveLog: (obj: GetPendingJobExecutionsRequest) => any;
224
139
  }
225
- /**
226
- * <p>Contains a subset of information about a job execution.</p>
227
- */
140
+
228
141
  export interface JobExecutionSummary {
229
- /**
230
- * <p>The unique identifier you assigned to this job when it was created.</p>
231
- */
142
+
232
143
  jobId?: string;
233
- /**
234
- * <p>The time, in milliseconds since the epoch, when the job execution was enqueued.</p>
235
- */
144
+
236
145
  queuedAt?: number;
237
- /**
238
- * <p>The time, in milliseconds since the epoch, when the job execution started.</p>
239
- */
146
+
240
147
  startedAt?: number;
241
- /**
242
- * <p>The time, in milliseconds since the epoch, when the job execution was last updated.</p>
243
- */
148
+
244
149
  lastUpdatedAt?: number;
245
- /**
246
- * <p>The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives
247
- * an update from a device.</p>
248
- */
150
+
249
151
  versionNumber?: number;
250
- /**
251
- * <p>A number that identifies a particular job execution on a particular device.</p>
252
- */
152
+
253
153
  executionNumber?: number;
254
154
  }
255
155
  export declare namespace JobExecutionSummary {
256
- /**
257
- * @internal
258
- */
156
+
259
157
  const filterSensitiveLog: (obj: JobExecutionSummary) => any;
260
158
  }
261
159
  export interface GetPendingJobExecutionsResponse {
262
- /**
263
- * <p>A list of JobExecutionSummary objects with status IN_PROGRESS.</p>
264
- */
160
+
265
161
  inProgressJobs?: JobExecutionSummary[];
266
- /**
267
- * <p>A list of JobExecutionSummary objects with status QUEUED.</p>
268
- */
162
+
269
163
  queuedJobs?: JobExecutionSummary[];
270
164
  }
271
165
  export declare namespace GetPendingJobExecutionsResponse {
272
- /**
273
- * @internal
274
- */
166
+
275
167
  const filterSensitiveLog: (obj: GetPendingJobExecutionsResponse) => any;
276
168
  }
277
- /**
278
- * <p>An update attempted to change the job execution to a state that is invalid because of the job execution's
279
- * current state (for example, an attempt to change a request in state SUCCESS to state IN_PROGRESS). In this
280
- * case, the body of the error message also contains the executionState field.</p>
281
- */
169
+
282
170
  export interface InvalidStateTransitionException extends __SmithyException, $MetadataBearer {
283
171
  name: "InvalidStateTransitionException";
284
172
  $fault: "client";
285
173
  message?: string;
286
174
  }
287
175
  export declare namespace InvalidStateTransitionException {
288
- /**
289
- * @internal
290
- */
176
+
291
177
  const filterSensitiveLog: (obj: InvalidStateTransitionException) => any;
292
178
  }
293
179
  export interface StartNextPendingJobExecutionRequest {
294
- /**
295
- * <p>The name of the thing associated with the device.</p>
296
- */
180
+
297
181
  thingName: string | undefined;
298
- /**
299
- * <p>A collection of name/value pairs that describe the status of the job execution. If not specified, the
300
- * statusDetails are unchanged.</p>
301
- */
182
+
302
183
  statusDetails?: {
303
184
  [key: string]: string;
304
185
  };
305
- /**
306
- * <p>Specifies the amount of time this device has to finish execution of this job. If the job
307
- * execution status is not set to a terminal state before this timer expires, or before the
308
- * timer is reset (by calling <code>UpdateJobExecution</code>, setting the status to
309
- * <code>IN_PROGRESS</code> and specifying a new timeout value in field <code>stepTimeoutInMinutes</code>)
310
- * the job execution status will be automatically set to <code>TIMED_OUT</code>. Note that setting
311
- * this timeout has no effect on that job execution timeout which may have been specified when
312
- * the job was created (<code>CreateJob</code> using field <code>timeoutConfig</code>).</p>
313
- */
186
+
314
187
  stepTimeoutInMinutes?: number;
315
188
  }
316
189
  export declare namespace StartNextPendingJobExecutionRequest {
317
- /**
318
- * @internal
319
- */
190
+
320
191
  const filterSensitiveLog: (obj: StartNextPendingJobExecutionRequest) => any;
321
192
  }
322
193
  export interface StartNextPendingJobExecutionResponse {
323
- /**
324
- * <p>A JobExecution object.</p>
325
- */
194
+
326
195
  execution?: JobExecution;
327
196
  }
328
197
  export declare namespace StartNextPendingJobExecutionResponse {
329
- /**
330
- * @internal
331
- */
198
+
332
199
  const filterSensitiveLog: (obj: StartNextPendingJobExecutionResponse) => any;
333
200
  }
334
201
  export interface UpdateJobExecutionRequest {
335
- /**
336
- * <p>The unique identifier assigned to this job when it was created.</p>
337
- */
202
+
338
203
  jobId: string | undefined;
339
- /**
340
- * <p>The name of the thing associated with the device.</p>
341
- */
204
+
342
205
  thingName: string | undefined;
343
- /**
344
- * <p>The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified
345
- * on every update.</p>
346
- */
206
+
347
207
  status: JobExecutionStatus | string | undefined;
348
- /**
349
- * <p> Optional. A collection of name/value pairs that describe the status of the job execution. If not
350
- * specified, the statusDetails are unchanged.</p>
351
- */
208
+
352
209
  statusDetails?: {
353
210
  [key: string]: string;
354
211
  };
355
- /**
356
- * <p>Specifies the amount of time this device has to finish execution of this job. If the job
357
- * execution status is not set to a terminal state before this timer expires, or before the
358
- * timer is reset (by again calling <code>UpdateJobExecution</code>, setting the status to
359
- * <code>IN_PROGRESS</code> and specifying a new timeout value in this field) the job execution
360
- * status will be automatically set to <code>TIMED_OUT</code>. Note that setting or resetting
361
- * this timeout has no effect on that job execution timeout which may have been specified when
362
- * the job was created (<code>CreateJob</code> using field <code>timeoutConfig</code>).</p>
363
- */
212
+
364
213
  stepTimeoutInMinutes?: number;
365
- /**
366
- * <p>Optional. The expected current version of the job execution. Each time you update the job execution, its
367
- * version is incremented. If the version of the job execution stored in Jobs does not match, the update is
368
- * rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data
369
- * is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain
370
- * the job execution status data.)</p>
371
- */
214
+
372
215
  expectedVersion?: number;
373
- /**
374
- * <p>Optional. When included and set to true, the response contains the JobExecutionState data. The default is
375
- * false.</p>
376
- */
216
+
377
217
  includeJobExecutionState?: boolean;
378
- /**
379
- * <p>Optional. When set to true, the response contains the job document. The default is false.</p>
380
- */
218
+
381
219
  includeJobDocument?: boolean;
382
- /**
383
- * <p>Optional. A number that identifies a particular job execution on a particular device.</p>
384
- */
220
+
385
221
  executionNumber?: number;
386
222
  }
387
223
  export declare namespace UpdateJobExecutionRequest {
388
- /**
389
- * @internal
390
- */
224
+
391
225
  const filterSensitiveLog: (obj: UpdateJobExecutionRequest) => any;
392
226
  }
393
- /**
394
- * <p>Contains data about the state of a job execution.</p>
395
- */
227
+
396
228
  export interface JobExecutionState {
397
- /**
398
- * <p>The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED",
399
- * "REJECTED", or "REMOVED".</p>
400
- */
229
+
401
230
  status?: JobExecutionStatus | string;
402
- /**
403
- * <p>A collection of name/value pairs that describe the status of the job execution.</p>
404
- */
231
+
405
232
  statusDetails?: {
406
233
  [key: string]: string;
407
234
  };
408
- /**
409
- * <p>The version of the job execution. Job execution versions are incremented each time they are updated by a
410
- * device.</p>
411
- */
235
+
412
236
  versionNumber?: number;
413
237
  }
414
238
  export declare namespace JobExecutionState {
415
- /**
416
- * @internal
417
- */
239
+
418
240
  const filterSensitiveLog: (obj: JobExecutionState) => any;
419
241
  }
420
242
  export interface UpdateJobExecutionResponse {
421
- /**
422
- * <p>A JobExecutionState object.</p>
423
- */
243
+
424
244
  executionState?: JobExecutionState;
425
- /**
426
- * <p>The contents of the Job Documents.</p>
427
- */
245
+
428
246
  jobDocument?: string;
429
247
  }
430
248
  export declare namespace UpdateJobExecutionResponse {
431
- /**
432
- * @internal
433
- */
249
+
434
250
  const filterSensitiveLog: (obj: UpdateJobExecutionResponse) => any;
435
251
  }
@@ -1,8 +1,6 @@
1
1
  import { FetchHttpHandler } from "@aws-sdk/fetch-http-handler";
2
2
  import { IoTJobsDataPlaneClientConfig } from "./IoTJobsDataPlaneClient";
3
- /**
4
- * @internal
5
- */
3
+
6
4
  export declare const getRuntimeConfig: (config: IoTJobsDataPlaneClientConfig) => {
7
5
  runtime: string;
8
6
  base64Decoder: import("@aws-sdk/types").Decoder;
@@ -1,8 +1,6 @@
1
1
  import { NodeHttpHandler } from "@aws-sdk/node-http-handler";
2
2
  import { IoTJobsDataPlaneClientConfig } from "./IoTJobsDataPlaneClient";
3
- /**
4
- * @internal
5
- */
3
+
6
4
  export declare const getRuntimeConfig: (config: IoTJobsDataPlaneClientConfig) => {
7
5
  runtime: string;
8
6
  base64Decoder: import("@aws-sdk/types").Decoder;
@@ -1,7 +1,5 @@
1
1
  import { IoTJobsDataPlaneClientConfig } from "./IoTJobsDataPlaneClient";
2
- /**
3
- * @internal
4
- */
2
+
5
3
  export declare const getRuntimeConfig: (config: IoTJobsDataPlaneClientConfig) => {
6
4
  runtime: string;
7
5
  sha256: import("@aws-sdk/types").HashConstructor;
@@ -1,8 +1,6 @@
1
1
  import { Logger as __Logger } from "@aws-sdk/types";
2
2
  import { IoTJobsDataPlaneClientConfig } from "./IoTJobsDataPlaneClient";
3
- /**
4
- * @internal
5
- */
3
+
6
4
  export declare const getRuntimeConfig: (config: IoTJobsDataPlaneClientConfig) => {
7
5
  apiVersion: string;
8
6
  disableHostPrefix: boolean;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-iot-jobs-data-plane",
3
3
  "description": "AWS SDK for JavaScript Iot Jobs Data Plane Client for Node.js, Browser and React Native",
4
- "version": "3.36.0",
4
+ "version": "3.36.1",
5
5
  "scripts": {
6
6
  "build": "yarn build:cjs && yarn build:es && yarn build:types",
7
7
  "build:cjs": "tsc -p tsconfig.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "^1.0.0",
23
23
  "@aws-crypto/sha256-js": "^1.0.0",
24
- "@aws-sdk/client-sts": "3.36.0",
24
+ "@aws-sdk/client-sts": "3.36.1",
25
25
  "@aws-sdk/config-resolver": "3.36.0",
26
- "@aws-sdk/credential-provider-node": "3.36.0",
26
+ "@aws-sdk/credential-provider-node": "3.36.1",
27
27
  "@aws-sdk/fetch-http-handler": "3.36.0",
28
28
  "@aws-sdk/hash-node": "3.36.0",
29
29
  "@aws-sdk/invalid-dependency": "3.36.0",