@aws-sdk/client-iot-jobs-data-plane 3.686.0 → 3.691.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.
@@ -30,13 +30,13 @@ export interface DescribeJobExecutionRequest {
30
30
  * <p>Optional. When set to true, the response contains the job document. The default is false.</p>
31
31
  * @public
32
32
  */
33
- includeJobDocument?: boolean;
33
+ includeJobDocument?: boolean | undefined;
34
34
  /**
35
35
  * <p>Optional. A number that identifies a particular job execution on a particular device. If not specified,
36
36
  * the latest job execution is returned.</p>
37
37
  * @public
38
38
  */
39
- executionNumber?: number;
39
+ executionNumber?: number | undefined;
40
40
  }
41
41
  /**
42
42
  * @public
@@ -65,61 +65,61 @@ export interface JobExecution {
65
65
  * <p>The unique identifier you assigned to this job when it was created.</p>
66
66
  * @public
67
67
  */
68
- jobId?: string;
68
+ jobId?: string | undefined;
69
69
  /**
70
70
  * <p>The name of the thing that is executing the job.</p>
71
71
  * @public
72
72
  */
73
- thingName?: string;
73
+ thingName?: string | undefined;
74
74
  /**
75
75
  * <p>The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED",
76
76
  * "REJECTED", or "REMOVED".</p>
77
77
  * @public
78
78
  */
79
- status?: JobExecutionStatus;
79
+ status?: JobExecutionStatus | undefined;
80
80
  /**
81
81
  * <p>A collection of name/value pairs that describe the status of the job execution.</p>
82
82
  * @public
83
83
  */
84
- statusDetails?: Record<string, string>;
84
+ statusDetails?: Record<string, string> | undefined;
85
85
  /**
86
86
  * <p>The time, in milliseconds since the epoch, when the job execution was enqueued.</p>
87
87
  * @public
88
88
  */
89
- queuedAt?: number;
89
+ queuedAt?: number | undefined;
90
90
  /**
91
91
  * <p>The time, in milliseconds since the epoch, when the job execution was started.</p>
92
92
  * @public
93
93
  */
94
- startedAt?: number;
94
+ startedAt?: number | undefined;
95
95
  /**
96
96
  * <p>The time, in milliseconds since the epoch, when the job execution was last updated. </p>
97
97
  * @public
98
98
  */
99
- lastUpdatedAt?: number;
99
+ lastUpdatedAt?: number | undefined;
100
100
  /**
101
101
  * <p>The estimated number of seconds that remain before the job execution status will be
102
102
  * changed to <code>TIMED_OUT</code>.</p>
103
103
  * @public
104
104
  */
105
- approximateSecondsBeforeTimedOut?: number;
105
+ approximateSecondsBeforeTimedOut?: number | undefined;
106
106
  /**
107
107
  * <p>The version of the job execution. Job execution versions are incremented each time they are updated by a
108
108
  * device.</p>
109
109
  * @public
110
110
  */
111
- versionNumber?: number;
111
+ versionNumber?: number | undefined;
112
112
  /**
113
113
  * <p>A number that identifies a particular job execution on a particular device. It can be used later in
114
114
  * commands that return or update job execution information.</p>
115
115
  * @public
116
116
  */
117
- executionNumber?: number;
117
+ executionNumber?: number | undefined;
118
118
  /**
119
119
  * <p>The content of the job document.</p>
120
120
  * @public
121
121
  */
122
- jobDocument?: string;
122
+ jobDocument?: string | undefined;
123
123
  }
124
124
  /**
125
125
  * @public
@@ -129,7 +129,7 @@ export interface DescribeJobExecutionResponse {
129
129
  * <p>Contains data about a job execution.</p>
130
130
  * @public
131
131
  */
132
- execution?: JobExecution;
132
+ execution?: JobExecution | undefined;
133
133
  }
134
134
  /**
135
135
  * <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>
@@ -190,7 +190,7 @@ export declare class ThrottlingException extends __BaseException {
190
190
  * <p>The payload associated with the exception.</p>
191
191
  * @public
192
192
  */
193
- payload?: Uint8Array;
193
+ payload?: Uint8Array | undefined;
194
194
  /**
195
195
  * @internal
196
196
  */
@@ -215,33 +215,33 @@ export interface JobExecutionSummary {
215
215
  * <p>The unique identifier you assigned to this job when it was created.</p>
216
216
  * @public
217
217
  */
218
- jobId?: string;
218
+ jobId?: string | undefined;
219
219
  /**
220
220
  * <p>The time, in milliseconds since the epoch, when the job execution was enqueued.</p>
221
221
  * @public
222
222
  */
223
- queuedAt?: number;
223
+ queuedAt?: number | undefined;
224
224
  /**
225
225
  * <p>The time, in milliseconds since the epoch, when the job execution started.</p>
226
226
  * @public
227
227
  */
228
- startedAt?: number;
228
+ startedAt?: number | undefined;
229
229
  /**
230
230
  * <p>The time, in milliseconds since the epoch, when the job execution was last updated.</p>
231
231
  * @public
232
232
  */
233
- lastUpdatedAt?: number;
233
+ lastUpdatedAt?: number | undefined;
234
234
  /**
235
235
  * <p>The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives
236
236
  * an update from a device.</p>
237
237
  * @public
238
238
  */
239
- versionNumber?: number;
239
+ versionNumber?: number | undefined;
240
240
  /**
241
241
  * <p>A number that identifies a particular job execution on a particular device.</p>
242
242
  * @public
243
243
  */
244
- executionNumber?: number;
244
+ executionNumber?: number | undefined;
245
245
  }
246
246
  /**
247
247
  * @public
@@ -251,12 +251,12 @@ export interface GetPendingJobExecutionsResponse {
251
251
  * <p>A list of JobExecutionSummary objects with status IN_PROGRESS.</p>
252
252
  * @public
253
253
  */
254
- inProgressJobs?: JobExecutionSummary[];
254
+ inProgressJobs?: JobExecutionSummary[] | undefined;
255
255
  /**
256
256
  * <p>A list of JobExecutionSummary objects with status QUEUED.</p>
257
257
  * @public
258
258
  */
259
- queuedJobs?: JobExecutionSummary[];
259
+ queuedJobs?: JobExecutionSummary[] | undefined;
260
260
  }
261
261
  /**
262
262
  * <p>An update attempted to change the job execution to a state that is invalid because of the job execution's
@@ -286,7 +286,7 @@ export interface StartNextPendingJobExecutionRequest {
286
286
  * statusDetails are unchanged.</p>
287
287
  * @public
288
288
  */
289
- statusDetails?: Record<string, string>;
289
+ statusDetails?: Record<string, string> | undefined;
290
290
  /**
291
291
  * <p>Specifies the amount of time this device has to finish execution of this job. If the job
292
292
  * execution status is not set to a terminal state before this timer expires, or before the
@@ -297,7 +297,7 @@ export interface StartNextPendingJobExecutionRequest {
297
297
  * the job was created (<code>CreateJob</code> using field <code>timeoutConfig</code>).</p>
298
298
  * @public
299
299
  */
300
- stepTimeoutInMinutes?: number;
300
+ stepTimeoutInMinutes?: number | undefined;
301
301
  }
302
302
  /**
303
303
  * @public
@@ -307,7 +307,7 @@ export interface StartNextPendingJobExecutionResponse {
307
307
  * <p>A JobExecution object.</p>
308
308
  * @public
309
309
  */
310
- execution?: JobExecution;
310
+ execution?: JobExecution | undefined;
311
311
  }
312
312
  /**
313
313
  * @public
@@ -334,7 +334,7 @@ export interface UpdateJobExecutionRequest {
334
334
  * specified, the statusDetails are unchanged.</p>
335
335
  * @public
336
336
  */
337
- statusDetails?: Record<string, string>;
337
+ statusDetails?: Record<string, string> | undefined;
338
338
  /**
339
339
  * <p>Specifies the amount of time this device has to finish execution of this job. If the job
340
340
  * execution status is not set to a terminal state before this timer expires, or before the
@@ -345,7 +345,7 @@ export interface UpdateJobExecutionRequest {
345
345
  * the job was created (<code>CreateJob</code> using field <code>timeoutConfig</code>).</p>
346
346
  * @public
347
347
  */
348
- stepTimeoutInMinutes?: number;
348
+ stepTimeoutInMinutes?: number | undefined;
349
349
  /**
350
350
  * <p>Optional. The expected current version of the job execution. Each time you update the job execution, its
351
351
  * version is incremented. If the version of the job execution stored in Jobs does not match, the update is
@@ -354,23 +354,23 @@ export interface UpdateJobExecutionRequest {
354
354
  * the job execution status data.)</p>
355
355
  * @public
356
356
  */
357
- expectedVersion?: number;
357
+ expectedVersion?: number | undefined;
358
358
  /**
359
359
  * <p>Optional. When included and set to true, the response contains the JobExecutionState data. The default is
360
360
  * false.</p>
361
361
  * @public
362
362
  */
363
- includeJobExecutionState?: boolean;
363
+ includeJobExecutionState?: boolean | undefined;
364
364
  /**
365
365
  * <p>Optional. When set to true, the response contains the job document. The default is false.</p>
366
366
  * @public
367
367
  */
368
- includeJobDocument?: boolean;
368
+ includeJobDocument?: boolean | undefined;
369
369
  /**
370
370
  * <p>Optional. A number that identifies a particular job execution on a particular device.</p>
371
371
  * @public
372
372
  */
373
- executionNumber?: number;
373
+ executionNumber?: number | undefined;
374
374
  }
375
375
  /**
376
376
  * <p>Contains data about the state of a job execution.</p>
@@ -382,18 +382,18 @@ export interface JobExecutionState {
382
382
  * "REJECTED", or "REMOVED".</p>
383
383
  * @public
384
384
  */
385
- status?: JobExecutionStatus;
385
+ status?: JobExecutionStatus | undefined;
386
386
  /**
387
387
  * <p>A collection of name/value pairs that describe the status of the job execution.</p>
388
388
  * @public
389
389
  */
390
- statusDetails?: Record<string, string>;
390
+ statusDetails?: Record<string, string> | undefined;
391
391
  /**
392
392
  * <p>The version of the job execution. Job execution versions are incremented each time they are updated by a
393
393
  * device.</p>
394
394
  * @public
395
395
  */
396
- versionNumber?: number;
396
+ versionNumber?: number | undefined;
397
397
  }
398
398
  /**
399
399
  * @public
@@ -403,10 +403,10 @@ export interface UpdateJobExecutionResponse {
403
403
  * <p>A JobExecutionState object.</p>
404
404
  * @public
405
405
  */
406
- executionState?: JobExecutionState;
406
+ executionState?: JobExecutionState | undefined;
407
407
  /**
408
408
  * <p>The contents of the Job Documents.</p>
409
409
  * @public
410
410
  */
411
- jobDocument?: string;
411
+ jobDocument?: string | undefined;
412
412
  }
@@ -10,8 +10,8 @@ export declare class CertificateValidationException extends __BaseException {
10
10
  export interface DescribeJobExecutionRequest {
11
11
  jobId: string | undefined;
12
12
  thingName: string | undefined;
13
- includeJobDocument?: boolean;
14
- executionNumber?: number;
13
+ includeJobDocument?: boolean | undefined;
14
+ executionNumber?: number | undefined;
15
15
  }
16
16
  export declare const JobExecutionStatus: {
17
17
  readonly CANCELED: "CANCELED";
@@ -26,20 +26,20 @@ export declare const JobExecutionStatus: {
26
26
  export type JobExecutionStatus =
27
27
  (typeof JobExecutionStatus)[keyof typeof JobExecutionStatus];
28
28
  export interface JobExecution {
29
- jobId?: string;
30
- thingName?: string;
31
- status?: JobExecutionStatus;
32
- statusDetails?: Record<string, string>;
33
- queuedAt?: number;
34
- startedAt?: number;
35
- lastUpdatedAt?: number;
36
- approximateSecondsBeforeTimedOut?: number;
37
- versionNumber?: number;
38
- executionNumber?: number;
39
- jobDocument?: string;
29
+ jobId?: string | undefined;
30
+ thingName?: string | undefined;
31
+ status?: JobExecutionStatus | undefined;
32
+ statusDetails?: Record<string, string> | undefined;
33
+ queuedAt?: number | undefined;
34
+ startedAt?: number | undefined;
35
+ lastUpdatedAt?: number | undefined;
36
+ approximateSecondsBeforeTimedOut?: number | undefined;
37
+ versionNumber?: number | undefined;
38
+ executionNumber?: number | undefined;
39
+ jobDocument?: string | undefined;
40
40
  }
41
41
  export interface DescribeJobExecutionResponse {
42
- execution?: JobExecution;
42
+ execution?: JobExecution | undefined;
43
43
  }
44
44
  export declare class InvalidRequestException extends __BaseException {
45
45
  readonly name: "InvalidRequestException";
@@ -72,7 +72,7 @@ export declare class TerminalStateException extends __BaseException {
72
72
  export declare class ThrottlingException extends __BaseException {
73
73
  readonly name: "ThrottlingException";
74
74
  readonly $fault: "client";
75
- payload?: Uint8Array;
75
+ payload?: Uint8Array | undefined;
76
76
  constructor(
77
77
  opts: __ExceptionOptionType<ThrottlingException, __BaseException>
78
78
  );
@@ -81,16 +81,16 @@ export interface GetPendingJobExecutionsRequest {
81
81
  thingName: string | undefined;
82
82
  }
83
83
  export interface JobExecutionSummary {
84
- jobId?: string;
85
- queuedAt?: number;
86
- startedAt?: number;
87
- lastUpdatedAt?: number;
88
- versionNumber?: number;
89
- executionNumber?: number;
84
+ jobId?: string | undefined;
85
+ queuedAt?: number | undefined;
86
+ startedAt?: number | undefined;
87
+ lastUpdatedAt?: number | undefined;
88
+ versionNumber?: number | undefined;
89
+ executionNumber?: number | undefined;
90
90
  }
91
91
  export interface GetPendingJobExecutionsResponse {
92
- inProgressJobs?: JobExecutionSummary[];
93
- queuedJobs?: JobExecutionSummary[];
92
+ inProgressJobs?: JobExecutionSummary[] | undefined;
93
+ queuedJobs?: JobExecutionSummary[] | undefined;
94
94
  }
95
95
  export declare class InvalidStateTransitionException extends __BaseException {
96
96
  readonly name: "InvalidStateTransitionException";
@@ -104,29 +104,29 @@ export declare class InvalidStateTransitionException extends __BaseException {
104
104
  }
105
105
  export interface StartNextPendingJobExecutionRequest {
106
106
  thingName: string | undefined;
107
- statusDetails?: Record<string, string>;
108
- stepTimeoutInMinutes?: number;
107
+ statusDetails?: Record<string, string> | undefined;
108
+ stepTimeoutInMinutes?: number | undefined;
109
109
  }
110
110
  export interface StartNextPendingJobExecutionResponse {
111
- execution?: JobExecution;
111
+ execution?: JobExecution | undefined;
112
112
  }
113
113
  export interface UpdateJobExecutionRequest {
114
114
  jobId: string | undefined;
115
115
  thingName: string | undefined;
116
116
  status: JobExecutionStatus | undefined;
117
- statusDetails?: Record<string, string>;
118
- stepTimeoutInMinutes?: number;
119
- expectedVersion?: number;
120
- includeJobExecutionState?: boolean;
121
- includeJobDocument?: boolean;
122
- executionNumber?: number;
117
+ statusDetails?: Record<string, string> | undefined;
118
+ stepTimeoutInMinutes?: number | undefined;
119
+ expectedVersion?: number | undefined;
120
+ includeJobExecutionState?: boolean | undefined;
121
+ includeJobDocument?: boolean | undefined;
122
+ executionNumber?: number | undefined;
123
123
  }
124
124
  export interface JobExecutionState {
125
- status?: JobExecutionStatus;
126
- statusDetails?: Record<string, string>;
127
- versionNumber?: number;
125
+ status?: JobExecutionStatus | undefined;
126
+ statusDetails?: Record<string, string> | undefined;
127
+ versionNumber?: number | undefined;
128
128
  }
129
129
  export interface UpdateJobExecutionResponse {
130
- executionState?: JobExecutionState;
131
- jobDocument?: string;
130
+ executionState?: JobExecutionState | undefined;
131
+ jobDocument?: string | undefined;
132
132
  }
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.686.0",
4
+ "version": "3.691.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-iot-jobs-data-plane",
@@ -20,19 +20,19 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/client-sso-oidc": "3.686.0",
24
- "@aws-sdk/client-sts": "3.686.0",
25
- "@aws-sdk/core": "3.686.0",
26
- "@aws-sdk/credential-provider-node": "3.686.0",
23
+ "@aws-sdk/client-sso-oidc": "3.691.0",
24
+ "@aws-sdk/client-sts": "3.691.0",
25
+ "@aws-sdk/core": "3.691.0",
26
+ "@aws-sdk/credential-provider-node": "3.691.0",
27
27
  "@aws-sdk/middleware-host-header": "3.686.0",
28
28
  "@aws-sdk/middleware-logger": "3.686.0",
29
29
  "@aws-sdk/middleware-recursion-detection": "3.686.0",
30
- "@aws-sdk/middleware-user-agent": "3.686.0",
30
+ "@aws-sdk/middleware-user-agent": "3.691.0",
31
31
  "@aws-sdk/region-config-resolver": "3.686.0",
32
32
  "@aws-sdk/types": "3.686.0",
33
33
  "@aws-sdk/util-endpoints": "3.686.0",
34
34
  "@aws-sdk/util-user-agent-browser": "3.686.0",
35
- "@aws-sdk/util-user-agent-node": "3.686.0",
35
+ "@aws-sdk/util-user-agent-node": "3.691.0",
36
36
  "@smithy/config-resolver": "^3.0.10",
37
37
  "@smithy/core": "^2.5.1",
38
38
  "@smithy/fetch-http-handler": "^4.0.0",