@aws-sdk/client-iot-jobs-data-plane 3.295.0 → 3.297.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.
@@ -5,6 +5,7 @@ import { StartNextPendingJobExecutionCommandInput, StartNextPendingJobExecutionC
5
5
  import { UpdateJobExecutionCommandInput, UpdateJobExecutionCommandOutput } from "./commands/UpdateJobExecutionCommand";
6
6
  import { IoTJobsDataPlaneClient } from "./IoTJobsDataPlaneClient";
7
7
  /**
8
+ * @public
8
9
  * <p>AWS IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to
9
10
  * and executed on one or more devices connected to AWS IoT. For example, you can define a job that instructs a
10
11
  * set of devices to download and install application or firmware updates, reboot, rotate certificates, or perform
@@ -19,24 +20,28 @@ import { IoTJobsDataPlaneClient } from "./IoTJobsDataPlaneClient";
19
20
  */
20
21
  export declare class IoTJobsDataPlane extends IoTJobsDataPlaneClient {
21
22
  /**
23
+ * @public
22
24
  * <p>Gets details of a job execution.</p>
23
25
  */
24
26
  describeJobExecution(args: DescribeJobExecutionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeJobExecutionCommandOutput>;
25
27
  describeJobExecution(args: DescribeJobExecutionCommandInput, cb: (err: any, data?: DescribeJobExecutionCommandOutput) => void): void;
26
28
  describeJobExecution(args: DescribeJobExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobExecutionCommandOutput) => void): void;
27
29
  /**
30
+ * @public
28
31
  * <p>Gets the list of all jobs for a thing that are not in a terminal status.</p>
29
32
  */
30
33
  getPendingJobExecutions(args: GetPendingJobExecutionsCommandInput, options?: __HttpHandlerOptions): Promise<GetPendingJobExecutionsCommandOutput>;
31
34
  getPendingJobExecutions(args: GetPendingJobExecutionsCommandInput, cb: (err: any, data?: GetPendingJobExecutionsCommandOutput) => void): void;
32
35
  getPendingJobExecutions(args: GetPendingJobExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPendingJobExecutionsCommandOutput) => void): void;
33
36
  /**
37
+ * @public
34
38
  * <p>Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.</p>
35
39
  */
36
40
  startNextPendingJobExecution(args: StartNextPendingJobExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StartNextPendingJobExecutionCommandOutput>;
37
41
  startNextPendingJobExecution(args: StartNextPendingJobExecutionCommandInput, cb: (err: any, data?: StartNextPendingJobExecutionCommandOutput) => void): void;
38
42
  startNextPendingJobExecution(args: StartNextPendingJobExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartNextPendingJobExecutionCommandOutput) => void): void;
39
43
  /**
44
+ * @public
40
45
  * <p>Updates the status of a job execution.</p>
41
46
  */
42
47
  updateJobExecution(args: UpdateJobExecutionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateJobExecutionCommandOutput>;
@@ -12,15 +12,24 @@ import { GetPendingJobExecutionsCommandInput, GetPendingJobExecutionsCommandOutp
12
12
  import { StartNextPendingJobExecutionCommandInput, StartNextPendingJobExecutionCommandOutput } from "./commands/StartNextPendingJobExecutionCommand";
13
13
  import { UpdateJobExecutionCommandInput, UpdateJobExecutionCommandOutput } from "./commands/UpdateJobExecutionCommand";
14
14
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
15
+ /**
16
+ * @public
17
+ */
15
18
  export type ServiceInputTypes = DescribeJobExecutionCommandInput | GetPendingJobExecutionsCommandInput | StartNextPendingJobExecutionCommandInput | UpdateJobExecutionCommandInput;
19
+ /**
20
+ * @public
21
+ */
16
22
  export type ServiceOutputTypes = DescribeJobExecutionCommandOutput | GetPendingJobExecutionsCommandOutput | StartNextPendingJobExecutionCommandOutput | UpdateJobExecutionCommandOutput;
23
+ /**
24
+ * @public
25
+ */
17
26
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
18
27
  /**
19
28
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
20
29
  */
21
30
  requestHandler?: __HttpHandler;
22
31
  /**
23
- * A constructor for a class implementing the {@link __Checksum} interface
32
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
24
33
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
25
34
  * @internal
26
35
  */
@@ -110,23 +119,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
110
119
  */
111
120
  logger?: __Logger;
112
121
  /**
113
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
122
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
114
123
  */
115
124
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
116
125
  }
126
+ /**
127
+ * @public
128
+ */
117
129
  type IoTJobsDataPlaneClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
118
130
  /**
119
- * The configuration interface of IoTJobsDataPlaneClient class constructor that set the region, credentials and other options.
131
+ * @public
132
+ *
133
+ * The configuration interface of IoTJobsDataPlaneClient class constructor that set the region, credentials and other options.
120
134
  */
121
135
  export interface IoTJobsDataPlaneClientConfig extends IoTJobsDataPlaneClientConfigType {
122
136
  }
137
+ /**
138
+ * @public
139
+ */
123
140
  type IoTJobsDataPlaneClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
124
141
  /**
125
- * The resolved configuration interface of IoTJobsDataPlaneClient class. This is resolved and normalized from the {@link IoTJobsDataPlaneClientConfig | constructor configuration interface}.
142
+ * @public
143
+ *
144
+ * The resolved configuration interface of IoTJobsDataPlaneClient class. This is resolved and normalized from the {@link IoTJobsDataPlaneClientConfig | constructor configuration interface}.
126
145
  */
127
146
  export interface IoTJobsDataPlaneClientResolvedConfig extends IoTJobsDataPlaneClientResolvedConfigType {
128
147
  }
129
148
  /**
149
+ * @public
130
150
  * <p>AWS IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to
131
151
  * and executed on one or more devices connected to AWS IoT. For example, you can define a job that instructs a
132
152
  * set of devices to download and install application or firmware updates, reboot, rotate certificates, or perform
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTJobsDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTJobsDataPlaneClient";
5
5
  import { DescribeJobExecutionRequest, DescribeJobExecutionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeJobExecutionCommand}.
8
10
  */
9
11
  export interface DescribeJobExecutionCommandInput extends DescribeJobExecutionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeJobExecutionCommand}.
13
17
  */
14
18
  export interface DescribeJobExecutionCommandOutput extends DescribeJobExecutionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets details of a job execution.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeJobExecutionCommandOutput extends DescribeJobExecutionR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeJobExecutionCommandInput - {@link DescribeJobExecutionCommandInput}
34
+ * @returns {@link DescribeJobExecutionCommandOutput}
28
35
  * @see {@link DescribeJobExecutionCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeJobExecutionCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTJobsDataPlaneClientResolvedConfig | config} for IoTJobsDataPlaneClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DescribeJobExecutionCommandOutput extends DescribeJobExecutionR
52
59
  export declare class DescribeJobExecutionCommand extends $Command<DescribeJobExecutionCommandInput, DescribeJobExecutionCommandOutput, IoTJobsDataPlaneClientResolvedConfig> {
53
60
  readonly input: DescribeJobExecutionCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DescribeJobExecutionCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTJobsDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeJobExecutionCommandInput, DescribeJobExecutionCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTJobsDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTJobsDataPlaneClient";
5
5
  import { GetPendingJobExecutionsRequest, GetPendingJobExecutionsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetPendingJobExecutionsCommand}.
8
10
  */
9
11
  export interface GetPendingJobExecutionsCommandInput extends GetPendingJobExecutionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetPendingJobExecutionsCommand}.
13
17
  */
14
18
  export interface GetPendingJobExecutionsCommandOutput extends GetPendingJobExecutionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the list of all jobs for a thing that are not in a terminal status.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetPendingJobExecutionsCommandOutput extends GetPendingJobExecu
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetPendingJobExecutionsCommandInput - {@link GetPendingJobExecutionsCommandInput}
34
+ * @returns {@link GetPendingJobExecutionsCommandOutput}
28
35
  * @see {@link GetPendingJobExecutionsCommandInput} for command's `input` shape.
29
36
  * @see {@link GetPendingJobExecutionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTJobsDataPlaneClientResolvedConfig | config} for IoTJobsDataPlaneClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetPendingJobExecutionsCommandOutput extends GetPendingJobExecu
49
56
  export declare class GetPendingJobExecutionsCommand extends $Command<GetPendingJobExecutionsCommandInput, GetPendingJobExecutionsCommandOutput, IoTJobsDataPlaneClientResolvedConfig> {
50
57
  readonly input: GetPendingJobExecutionsCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetPendingJobExecutionsCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTJobsDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPendingJobExecutionsCommandInput, GetPendingJobExecutionsCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTJobsDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTJobsDataPlaneClient";
5
5
  import { StartNextPendingJobExecutionRequest, StartNextPendingJobExecutionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartNextPendingJobExecutionCommand}.
8
10
  */
9
11
  export interface StartNextPendingJobExecutionCommandInput extends StartNextPendingJobExecutionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartNextPendingJobExecutionCommand}.
13
17
  */
14
18
  export interface StartNextPendingJobExecutionCommandOutput extends StartNextPendingJobExecutionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface StartNextPendingJobExecutionCommandOutput extends StartNextPend
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param StartNextPendingJobExecutionCommandInput - {@link StartNextPendingJobExecutionCommandInput}
34
+ * @returns {@link StartNextPendingJobExecutionCommandOutput}
28
35
  * @see {@link StartNextPendingJobExecutionCommandInput} for command's `input` shape.
29
36
  * @see {@link StartNextPendingJobExecutionCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTJobsDataPlaneClientResolvedConfig | config} for IoTJobsDataPlaneClient's `config` shape.
@@ -49,11 +56,20 @@ export interface StartNextPendingJobExecutionCommandOutput extends StartNextPend
49
56
  export declare class StartNextPendingJobExecutionCommand extends $Command<StartNextPendingJobExecutionCommandInput, StartNextPendingJobExecutionCommandOutput, IoTJobsDataPlaneClientResolvedConfig> {
50
57
  readonly input: StartNextPendingJobExecutionCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: StartNextPendingJobExecutionCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTJobsDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartNextPendingJobExecutionCommandInput, StartNextPendingJobExecutionCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTJobsDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTJobsDataPlaneClient";
5
5
  import { UpdateJobExecutionRequest, UpdateJobExecutionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateJobExecutionCommand}.
8
10
  */
9
11
  export interface UpdateJobExecutionCommandInput extends UpdateJobExecutionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateJobExecutionCommand}.
13
17
  */
14
18
  export interface UpdateJobExecutionCommandOutput extends UpdateJobExecutionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the status of a job execution.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateJobExecutionCommandOutput extends UpdateJobExecutionRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateJobExecutionCommandInput - {@link UpdateJobExecutionCommandInput}
34
+ * @returns {@link UpdateJobExecutionCommandOutput}
28
35
  * @see {@link UpdateJobExecutionCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateJobExecutionCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTJobsDataPlaneClientResolvedConfig | config} for IoTJobsDataPlaneClient's `config` shape.
@@ -54,11 +61,20 @@ export interface UpdateJobExecutionCommandOutput extends UpdateJobExecutionRespo
54
61
  export declare class UpdateJobExecutionCommand extends $Command<UpdateJobExecutionCommandInput, UpdateJobExecutionCommandOutput, IoTJobsDataPlaneClientResolvedConfig> {
55
62
  readonly input: UpdateJobExecutionCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: UpdateJobExecutionCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTJobsDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateJobExecutionCommandInput, UpdateJobExecutionCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from IoTJobsDataPlane service.
4
6
  */
5
7
  export declare class IoTJobsDataPlaneServiceException extends __ServiceException {
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { IoTJobsDataPlaneServiceException as __BaseException } from "./IoTJobsDataPlaneServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>The certificate is invalid.</p>
5
6
  */
6
7
  export declare class CertificateValidationException extends __BaseException {
@@ -11,6 +12,9 @@ export declare class CertificateValidationException extends __BaseException {
11
12
  */
12
13
  constructor(opts: __ExceptionOptionType<CertificateValidationException, __BaseException>);
13
14
  }
15
+ /**
16
+ * @public
17
+ */
14
18
  export interface DescribeJobExecutionRequest {
15
19
  /**
16
20
  * <p>The unique identifier assigned to this job when it was created.</p>
@@ -30,6 +34,9 @@ export interface DescribeJobExecutionRequest {
30
34
  */
31
35
  executionNumber?: number;
32
36
  }
37
+ /**
38
+ * @public
39
+ */
33
40
  export declare enum JobExecutionStatus {
34
41
  CANCELED = "CANCELED",
35
42
  FAILED = "FAILED",
@@ -41,6 +48,7 @@ export declare enum JobExecutionStatus {
41
48
  TIMED_OUT = "TIMED_OUT"
42
49
  }
43
50
  /**
51
+ * @public
44
52
  * <p>Contains data about a job execution.</p>
45
53
  */
46
54
  export interface JobExecution {
@@ -93,6 +101,9 @@ export interface JobExecution {
93
101
  */
94
102
  jobDocument?: string;
95
103
  }
104
+ /**
105
+ * @public
106
+ */
96
107
  export interface DescribeJobExecutionResponse {
97
108
  /**
98
109
  * <p>Contains data about a job execution.</p>
@@ -100,6 +111,7 @@ export interface DescribeJobExecutionResponse {
100
111
  execution?: JobExecution;
101
112
  }
102
113
  /**
114
+ * @public
103
115
  * <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>
104
116
  */
105
117
  export declare class InvalidRequestException extends __BaseException {
@@ -111,6 +123,7 @@ export declare class InvalidRequestException extends __BaseException {
111
123
  constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
112
124
  }
113
125
  /**
126
+ * @public
114
127
  * <p>The specified resource does not exist.</p>
115
128
  */
116
129
  export declare class ResourceNotFoundException extends __BaseException {
@@ -122,6 +135,7 @@ export declare class ResourceNotFoundException extends __BaseException {
122
135
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
123
136
  }
124
137
  /**
138
+ * @public
125
139
  * <p>The service is temporarily unavailable.</p>
126
140
  */
127
141
  export declare class ServiceUnavailableException extends __BaseException {
@@ -133,6 +147,7 @@ export declare class ServiceUnavailableException extends __BaseException {
133
147
  constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
134
148
  }
135
149
  /**
150
+ * @public
136
151
  * <p>The job is in a terminal state.</p>
137
152
  */
138
153
  export declare class TerminalStateException extends __BaseException {
@@ -144,6 +159,7 @@ export declare class TerminalStateException extends __BaseException {
144
159
  constructor(opts: __ExceptionOptionType<TerminalStateException, __BaseException>);
145
160
  }
146
161
  /**
162
+ * @public
147
163
  * <p>The rate exceeds the limit.</p>
148
164
  */
149
165
  export declare class ThrottlingException extends __BaseException {
@@ -158,6 +174,9 @@ export declare class ThrottlingException extends __BaseException {
158
174
  */
159
175
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
160
176
  }
177
+ /**
178
+ * @public
179
+ */
161
180
  export interface GetPendingJobExecutionsRequest {
162
181
  /**
163
182
  * <p>The name of the thing that is executing the job.</p>
@@ -165,6 +184,7 @@ export interface GetPendingJobExecutionsRequest {
165
184
  thingName: string | undefined;
166
185
  }
167
186
  /**
187
+ * @public
168
188
  * <p>Contains a subset of information about a job execution.</p>
169
189
  */
170
190
  export interface JobExecutionSummary {
@@ -194,6 +214,9 @@ export interface JobExecutionSummary {
194
214
  */
195
215
  executionNumber?: number;
196
216
  }
217
+ /**
218
+ * @public
219
+ */
197
220
  export interface GetPendingJobExecutionsResponse {
198
221
  /**
199
222
  * <p>A list of JobExecutionSummary objects with status IN_PROGRESS.</p>
@@ -205,6 +228,7 @@ export interface GetPendingJobExecutionsResponse {
205
228
  queuedJobs?: JobExecutionSummary[];
206
229
  }
207
230
  /**
231
+ * @public
208
232
  * <p>An update attempted to change the job execution to a state that is invalid because of the job execution's
209
233
  * current state (for example, an attempt to change a request in state SUCCESS to state IN_PROGRESS). In this
210
234
  * case, the body of the error message also contains the executionState field.</p>
@@ -217,6 +241,9 @@ export declare class InvalidStateTransitionException extends __BaseException {
217
241
  */
218
242
  constructor(opts: __ExceptionOptionType<InvalidStateTransitionException, __BaseException>);
219
243
  }
244
+ /**
245
+ * @public
246
+ */
220
247
  export interface StartNextPendingJobExecutionRequest {
221
248
  /**
222
249
  * <p>The name of the thing associated with the device.</p>
@@ -238,12 +265,18 @@ export interface StartNextPendingJobExecutionRequest {
238
265
  */
239
266
  stepTimeoutInMinutes?: number;
240
267
  }
268
+ /**
269
+ * @public
270
+ */
241
271
  export interface StartNextPendingJobExecutionResponse {
242
272
  /**
243
273
  * <p>A JobExecution object.</p>
244
274
  */
245
275
  execution?: JobExecution;
246
276
  }
277
+ /**
278
+ * @public
279
+ */
247
280
  export interface UpdateJobExecutionRequest {
248
281
  /**
249
282
  * <p>The unique identifier assigned to this job when it was created.</p>
@@ -296,6 +329,7 @@ export interface UpdateJobExecutionRequest {
296
329
  executionNumber?: number;
297
330
  }
298
331
  /**
332
+ * @public
299
333
  * <p>Contains data about the state of a job execution.</p>
300
334
  */
301
335
  export interface JobExecutionState {
@@ -314,6 +348,9 @@ export interface JobExecutionState {
314
348
  */
315
349
  versionNumber?: number;
316
350
  }
351
+ /**
352
+ * @public
353
+ */
317
354
  export interface UpdateJobExecutionResponse {
318
355
  /**
319
356
  * <p>A JobExecutionState object.</p>
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.295.0",
4
+ "version": "3.297.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.295.0",
24
- "@aws-sdk/config-resolver": "3.295.0",
25
- "@aws-sdk/credential-provider-node": "3.295.0",
26
- "@aws-sdk/fetch-http-handler": "3.295.0",
27
- "@aws-sdk/hash-node": "3.295.0",
28
- "@aws-sdk/invalid-dependency": "3.295.0",
29
- "@aws-sdk/middleware-content-length": "3.295.0",
30
- "@aws-sdk/middleware-endpoint": "3.295.0",
31
- "@aws-sdk/middleware-host-header": "3.295.0",
32
- "@aws-sdk/middleware-logger": "3.295.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.295.0",
34
- "@aws-sdk/middleware-retry": "3.295.0",
35
- "@aws-sdk/middleware-serde": "3.295.0",
36
- "@aws-sdk/middleware-signing": "3.295.0",
37
- "@aws-sdk/middleware-stack": "3.295.0",
38
- "@aws-sdk/middleware-user-agent": "3.295.0",
39
- "@aws-sdk/node-config-provider": "3.295.0",
40
- "@aws-sdk/node-http-handler": "3.295.0",
41
- "@aws-sdk/protocol-http": "3.295.0",
42
- "@aws-sdk/smithy-client": "3.295.0",
43
- "@aws-sdk/types": "3.295.0",
44
- "@aws-sdk/url-parser": "3.295.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
+ "@aws-sdk/config-resolver": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
+ "@aws-sdk/fetch-http-handler": "3.296.0",
27
+ "@aws-sdk/hash-node": "3.296.0",
28
+ "@aws-sdk/invalid-dependency": "3.296.0",
29
+ "@aws-sdk/middleware-content-length": "3.296.0",
30
+ "@aws-sdk/middleware-endpoint": "3.296.0",
31
+ "@aws-sdk/middleware-host-header": "3.296.0",
32
+ "@aws-sdk/middleware-logger": "3.296.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.296.0",
34
+ "@aws-sdk/middleware-retry": "3.296.0",
35
+ "@aws-sdk/middleware-serde": "3.296.0",
36
+ "@aws-sdk/middleware-signing": "3.296.0",
37
+ "@aws-sdk/middleware-stack": "3.296.0",
38
+ "@aws-sdk/middleware-user-agent": "3.296.0",
39
+ "@aws-sdk/node-config-provider": "3.296.0",
40
+ "@aws-sdk/node-http-handler": "3.296.0",
41
+ "@aws-sdk/protocol-http": "3.296.0",
42
+ "@aws-sdk/smithy-client": "3.296.0",
43
+ "@aws-sdk/types": "3.296.0",
44
+ "@aws-sdk/url-parser": "3.296.0",
45
45
  "@aws-sdk/util-base64": "3.295.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.295.0",
47
47
  "@aws-sdk/util-body-length-node": "3.295.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.295.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.295.0",
50
- "@aws-sdk/util-endpoints": "3.295.0",
51
- "@aws-sdk/util-retry": "3.295.0",
52
- "@aws-sdk/util-user-agent-browser": "3.295.0",
53
- "@aws-sdk/util-user-agent-node": "3.295.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.296.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.296.0",
50
+ "@aws-sdk/util-endpoints": "3.296.0",
51
+ "@aws-sdk/util-retry": "3.296.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.296.0",
53
+ "@aws-sdk/util-user-agent-node": "3.296.0",
54
54
  "@aws-sdk/util-utf8": "3.295.0",
55
55
  "tslib": "^2.5.0"
56
56
  },