@aws-sdk/client-iot 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.
Files changed (91) hide show
  1. package/README.md +64 -0
  2. package/dist-cjs/index.js +555 -0
  3. package/dist-es/IoT.js +16 -0
  4. package/dist-es/commands/CreateCommandCommand.js +22 -0
  5. package/dist-es/commands/DeleteCommandCommand.js +22 -0
  6. package/dist-es/commands/DeleteCommandExecutionCommand.js +22 -0
  7. package/dist-es/commands/GetCommandCommand.js +22 -0
  8. package/dist-es/commands/GetCommandExecutionCommand.js +22 -0
  9. package/dist-es/commands/ListCommandExecutionsCommand.js +22 -0
  10. package/dist-es/commands/ListCommandsCommand.js +22 -0
  11. package/dist-es/commands/UpdateCommandCommand.js +22 -0
  12. package/dist-es/commands/index.js +8 -0
  13. package/dist-es/models/models_0.js +4 -0
  14. package/dist-es/models/models_1.js +12 -0
  15. package/dist-es/pagination/ListCommandExecutionsPaginator.js +4 -0
  16. package/dist-es/pagination/ListCommandsPaginator.js +4 -0
  17. package/dist-es/pagination/index.js +2 -0
  18. package/dist-es/protocols/Aws_restJson1.js +387 -0
  19. package/dist-types/IoT.d.ts +58 -0
  20. package/dist-types/IoTClient.d.ts +10 -2
  21. package/dist-types/commands/AssociateSbomWithPackageVersionCommand.d.ts +2 -2
  22. package/dist-types/commands/AssociateTargetsWithJobCommand.d.ts +4 -3
  23. package/dist-types/commands/CreateCommandCommand.d.ts +127 -0
  24. package/dist-types/commands/CreateJobTemplateCommand.d.ts +1 -1
  25. package/dist-types/commands/CreatePackageCommand.d.ts +2 -2
  26. package/dist-types/commands/CreatePackageVersionCommand.d.ts +2 -2
  27. package/dist-types/commands/CreateTopicRuleDestinationCommand.d.ts +2 -1
  28. package/dist-types/commands/DeleteAccountAuditConfigurationCommand.d.ts +1 -1
  29. package/dist-types/commands/DeleteAuditSuppressionCommand.d.ts +1 -1
  30. package/dist-types/commands/DeleteCommandCommand.d.ts +84 -0
  31. package/dist-types/commands/DeleteCommandExecutionCommand.d.ts +87 -0
  32. package/dist-types/commands/DeleteJobCommand.d.ts +6 -7
  33. package/dist-types/commands/DisassociateSbomFromPackageVersionCommand.d.ts +1 -1
  34. package/dist-types/commands/GetCommandCommand.d.ts +121 -0
  35. package/dist-types/commands/GetCommandExecutionCommand.d.ts +117 -0
  36. package/dist-types/commands/ListCommandExecutionsCommand.d.ts +116 -0
  37. package/dist-types/commands/ListCommandsCommand.d.ts +96 -0
  38. package/dist-types/commands/ListDetectMitigationActionsExecutionsCommand.d.ts +2 -1
  39. package/dist-types/commands/ListDetectMitigationActionsTasksCommand.d.ts +1 -1
  40. package/dist-types/commands/ListDimensionsCommand.d.ts +1 -1
  41. package/dist-types/commands/ListDomainConfigurationsCommand.d.ts +1 -1
  42. package/dist-types/commands/ListFleetMetricsCommand.d.ts +1 -1
  43. package/dist-types/commands/ListIndicesCommand.d.ts +1 -1
  44. package/dist-types/commands/ListJobExecutionsForJobCommand.d.ts +1 -1
  45. package/dist-types/commands/ListJobExecutionsForThingCommand.d.ts +1 -1
  46. package/dist-types/commands/ListJobTemplatesCommand.d.ts +1 -2
  47. package/dist-types/commands/ListJobsCommand.d.ts +1 -1
  48. package/dist-types/commands/UpdateCommandCommand.d.ts +94 -0
  49. package/dist-types/commands/UpdatePackageCommand.d.ts +1 -1
  50. package/dist-types/commands/UpdatePackageConfigurationCommand.d.ts +1 -1
  51. package/dist-types/commands/UpdatePackageVersionCommand.d.ts +1 -1
  52. package/dist-types/commands/index.d.ts +8 -0
  53. package/dist-types/models/models_0.d.ts +332 -236
  54. package/dist-types/models/models_1.d.ts +880 -784
  55. package/dist-types/models/models_2.d.ts +671 -11
  56. package/dist-types/pagination/ListCommandExecutionsPaginator.d.ts +7 -0
  57. package/dist-types/pagination/ListCommandsPaginator.d.ts +7 -0
  58. package/dist-types/pagination/index.d.ts +2 -0
  59. package/dist-types/protocols/Aws_restJson1.d.ts +72 -0
  60. package/dist-types/ts3.4/IoT.d.ts +138 -0
  61. package/dist-types/ts3.4/IoTClient.d.ts +48 -0
  62. package/dist-types/ts3.4/commands/CreateCommandCommand.d.ts +50 -0
  63. package/dist-types/ts3.4/commands/CreateTopicRuleDestinationCommand.d.ts +2 -4
  64. package/dist-types/ts3.4/commands/DeleteAccountAuditConfigurationCommand.d.ts +1 -1
  65. package/dist-types/ts3.4/commands/DeleteAuditSuppressionCommand.d.ts +1 -1
  66. package/dist-types/ts3.4/commands/DeleteCommandCommand.d.ts +50 -0
  67. package/dist-types/ts3.4/commands/DeleteCommandExecutionCommand.d.ts +51 -0
  68. package/dist-types/ts3.4/commands/GetCommandCommand.d.ts +47 -0
  69. package/dist-types/ts3.4/commands/GetCommandExecutionCommand.d.ts +51 -0
  70. package/dist-types/ts3.4/commands/ListCommandExecutionsCommand.d.ts +51 -0
  71. package/dist-types/ts3.4/commands/ListCommandsCommand.d.ts +47 -0
  72. package/dist-types/ts3.4/commands/ListDetectMitigationActionsExecutionsCommand.d.ts +2 -4
  73. package/dist-types/ts3.4/commands/ListDetectMitigationActionsTasksCommand.d.ts +1 -1
  74. package/dist-types/ts3.4/commands/ListDimensionsCommand.d.ts +1 -1
  75. package/dist-types/ts3.4/commands/ListDomainConfigurationsCommand.d.ts +1 -1
  76. package/dist-types/ts3.4/commands/ListFleetMetricsCommand.d.ts +1 -1
  77. package/dist-types/ts3.4/commands/ListIndicesCommand.d.ts +1 -1
  78. package/dist-types/ts3.4/commands/ListJobExecutionsForJobCommand.d.ts +1 -1
  79. package/dist-types/ts3.4/commands/ListJobExecutionsForThingCommand.d.ts +1 -1
  80. package/dist-types/ts3.4/commands/ListJobTemplatesCommand.d.ts +4 -2
  81. package/dist-types/ts3.4/commands/ListJobsCommand.d.ts +1 -1
  82. package/dist-types/ts3.4/commands/UpdateCommandCommand.d.ts +50 -0
  83. package/dist-types/ts3.4/commands/index.d.ts +8 -0
  84. package/dist-types/ts3.4/models/models_0.d.ts +39 -21
  85. package/dist-types/ts3.4/models/models_1.d.ts +148 -129
  86. package/dist-types/ts3.4/models/models_2.d.ts +147 -1
  87. package/dist-types/ts3.4/pagination/ListCommandExecutionsPaginator.d.ts +11 -0
  88. package/dist-types/ts3.4/pagination/ListCommandsPaginator.d.ts +11 -0
  89. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  90. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +96 -0
  91. package/package.json +4 -4
@@ -1,7 +1,610 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { IoTServiceException as __BaseException } from "./IoTServiceException";
3
- import { AbortConfig, AggregationType, AlertTarget, AlertTargetType, ApplicationProtocol, AttributePayload, AuditCheckConfiguration, AuditFrequency, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditNotificationType, AuthenticationType, AuthInfo, AuthorizerConfig, AuthorizerStatus, AuthResult, AutoRegistrationStatus, Behavior, BillingGroupProperties, CertificateProviderOperation, ClientCertificateConfig, CustomMetricType, DayOfWeek, DimensionType, DimensionValueOperator, FleetMetricUnit, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MetricsExportConfig, MetricToRetain, MetricValue, MitigationActionParams, OTAUpdateStatus, PackageVersionArtifact, PackageVersionStatus, Policy, PresignedUrlConfig, ProvisioningHook, RelatedResource, ResourceIdentifier, ServerCertificateConfig, StreamFile, Tag, TemplateType, ThingGroupProperties, ThingPrincipalType, ThingTypeProperties, TimeoutConfig, TlsConfig, TopicRuleDestinationStatus, TopicRulePayload, VerificationState, ViolationEventAdditionalInfo } from "./models_0";
4
- import { BehaviorCriteriaType, CACertificateStatus, CertificateMode, CertificateStatus, Configuration, DetectMitigationActionsTaskTarget, DomainConfigurationStatus, EventType, GroupNameAndArn, JobTemplateSummary, LogTargetType, MitigationActionType, RegistrationConfig, Status, ThingGroupIndexingConfiguration, ThingIndexingConfiguration, ThingTypeMetadata, VersionUpdateByJobsConfig, ViolationEventOccurrenceRange } from "./models_1";
3
+ import { AbortConfig, AggregationType, AlertTarget, AlertTargetType, ApplicationProtocol, AttributePayload, AuditCheckConfiguration, AuditFrequency, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditNotificationType, AuthenticationType, AuthInfo, AuthorizerConfig, AuthorizerStatus, AuthResult, AutoRegistrationStatus, Behavior, BillingGroupProperties, CertificateProviderOperation, ClientCertificateConfig, CustomMetricType, DayOfWeek, DimensionType, DimensionValueOperator, FleetMetricUnit, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MetricsExportConfig, MetricToRetain, MetricValue, MitigationActionParams, OTAUpdateStatus, PackageVersionArtifact, PackageVersionStatus, Policy, PresignedUrlConfig, ProvisioningHook, RelatedResource, ResourceIdentifier, ServerCertificateConfig, ServiceType, StreamFile, Tag, TargetSelection, TemplateType, ThingGroupProperties, ThingPrincipalType, ThingTypeProperties, TimeoutConfig, TlsConfig, TopicRuleDestinationStatus, TopicRulePayload, VerificationState, ViolationEventAdditionalInfo } from "./models_0";
4
+ import { BehaviorCriteriaType, CACertificateStatus, CertificateMode, CertificateStatus, Configuration, DetectMitigationActionExecution, DetectMitigationActionsTaskSummary, DetectMitigationActionsTaskTarget, DomainConfigurationStatus, EventType, GroupNameAndArn, JobExecutionStatus, JobStatus, LogTargetType, MitigationActionType, RegistrationConfig, Status, ThingGroupIndexingConfiguration, ThingIndexingConfiguration, ThingTypeMetadata, VersionUpdateByJobsConfig, ViolationEventOccurrenceRange } from "./models_1";
5
+ /**
6
+ * @public
7
+ */
8
+ export interface ListDetectMitigationActionsExecutionsResponse {
9
+ /**
10
+ * <p>
11
+ * List of actions executions.
12
+ * </p>
13
+ * @public
14
+ */
15
+ actionsExecutions?: DetectMitigationActionExecution[] | undefined;
16
+ /**
17
+ * <p>
18
+ * A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
19
+ * </p>
20
+ * @public
21
+ */
22
+ nextToken?: string | undefined;
23
+ }
24
+ /**
25
+ * @public
26
+ */
27
+ export interface ListDetectMitigationActionsTasksRequest {
28
+ /**
29
+ * <p>The maximum number of results to return at one time. The default is 25.</p>
30
+ * @public
31
+ */
32
+ maxResults?: number | undefined;
33
+ /**
34
+ * <p>
35
+ * The token for the next set of results.
36
+ * </p>
37
+ * @public
38
+ */
39
+ nextToken?: string | undefined;
40
+ /**
41
+ * <p>
42
+ * A filter to limit results to those found after the specified time. You must
43
+ * specify either the startTime and endTime or the taskId, but not both.
44
+ * </p>
45
+ * @public
46
+ */
47
+ startTime: Date | undefined;
48
+ /**
49
+ * <p>
50
+ * The end of the time period for which ML Detect mitigation actions tasks are returned.
51
+ * </p>
52
+ * @public
53
+ */
54
+ endTime: Date | undefined;
55
+ }
56
+ /**
57
+ * @public
58
+ */
59
+ export interface ListDetectMitigationActionsTasksResponse {
60
+ /**
61
+ * <p>
62
+ * The collection of ML Detect mitigation tasks that matched the filter criteria.
63
+ * </p>
64
+ * @public
65
+ */
66
+ tasks?: DetectMitigationActionsTaskSummary[] | undefined;
67
+ /**
68
+ * <p>
69
+ * A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
70
+ * </p>
71
+ * @public
72
+ */
73
+ nextToken?: string | undefined;
74
+ }
75
+ /**
76
+ * @public
77
+ */
78
+ export interface ListDimensionsRequest {
79
+ /**
80
+ * <p>The token for the next set of results.</p>
81
+ * @public
82
+ */
83
+ nextToken?: string | undefined;
84
+ /**
85
+ * <p>The maximum number of results to retrieve at one time.</p>
86
+ * @public
87
+ */
88
+ maxResults?: number | undefined;
89
+ }
90
+ /**
91
+ * @public
92
+ */
93
+ export interface ListDimensionsResponse {
94
+ /**
95
+ * <p>A list of the names of the defined dimensions. Use <code>DescribeDimension</code> to get details for a dimension.</p>
96
+ * @public
97
+ */
98
+ dimensionNames?: string[] | undefined;
99
+ /**
100
+ * <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>
101
+ * @public
102
+ */
103
+ nextToken?: string | undefined;
104
+ }
105
+ /**
106
+ * @public
107
+ */
108
+ export interface ListDomainConfigurationsRequest {
109
+ /**
110
+ * <p>The marker for the next set of results.</p>
111
+ * @public
112
+ */
113
+ marker?: string | undefined;
114
+ /**
115
+ * <p>The result page size.</p>
116
+ * @public
117
+ */
118
+ pageSize?: number | undefined;
119
+ /**
120
+ * <p>The type of service delivered by the endpoint.</p>
121
+ * @public
122
+ */
123
+ serviceType?: ServiceType | undefined;
124
+ }
125
+ /**
126
+ * <p>The summary of a domain configuration. A domain configuration specifies custom IoT-specific information about a domain.
127
+ * A domain configuration can be associated with an Amazon Web Services-managed domain
128
+ * (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a default endpoint.</p>
129
+ * <ul>
130
+ * <li>
131
+ * <p>Data</p>
132
+ * </li>
133
+ * <li>
134
+ * <p>Jobs</p>
135
+ * </li>
136
+ * <li>
137
+ * <p>CredentialProvider</p>
138
+ * </li>
139
+ * </ul>
140
+ * @public
141
+ */
142
+ export interface DomainConfigurationSummary {
143
+ /**
144
+ * <p>The name of the domain configuration. This value must be unique to a region.</p>
145
+ * @public
146
+ */
147
+ domainConfigurationName?: string | undefined;
148
+ /**
149
+ * <p>The ARN of the domain configuration.</p>
150
+ * @public
151
+ */
152
+ domainConfigurationArn?: string | undefined;
153
+ /**
154
+ * <p>The type of service delivered by the endpoint.</p>
155
+ * @public
156
+ */
157
+ serviceType?: ServiceType | undefined;
158
+ }
159
+ /**
160
+ * @public
161
+ */
162
+ export interface ListDomainConfigurationsResponse {
163
+ /**
164
+ * <p>A list of objects that contain summary information about the user's domain configurations.</p>
165
+ * @public
166
+ */
167
+ domainConfigurations?: DomainConfigurationSummary[] | undefined;
168
+ /**
169
+ * <p>The marker for the next set of results.</p>
170
+ * @public
171
+ */
172
+ nextMarker?: string | undefined;
173
+ }
174
+ /**
175
+ * @public
176
+ */
177
+ export interface ListFleetMetricsRequest {
178
+ /**
179
+ * <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response;
180
+ * otherwise <code>null</code> to receive the first set of results.</p>
181
+ * @public
182
+ */
183
+ nextToken?: string | undefined;
184
+ /**
185
+ * <p>The maximum number of results to return in this operation.</p>
186
+ * @public
187
+ */
188
+ maxResults?: number | undefined;
189
+ }
190
+ /**
191
+ * <p>The name and ARN of a fleet metric.</p>
192
+ * @public
193
+ */
194
+ export interface FleetMetricNameAndArn {
195
+ /**
196
+ * <p>The fleet metric name.</p>
197
+ * @public
198
+ */
199
+ metricName?: string | undefined;
200
+ /**
201
+ * <p>The fleet metric ARN.</p>
202
+ * @public
203
+ */
204
+ metricArn?: string | undefined;
205
+ }
206
+ /**
207
+ * @public
208
+ */
209
+ export interface ListFleetMetricsResponse {
210
+ /**
211
+ * <p>The list of fleet metrics objects.</p>
212
+ * @public
213
+ */
214
+ fleetMetrics?: FleetMetricNameAndArn[] | undefined;
215
+ /**
216
+ * <p>The token for the next set of results. Will not be returned if the operation has returned
217
+ * all results.</p>
218
+ * @public
219
+ */
220
+ nextToken?: string | undefined;
221
+ }
222
+ /**
223
+ * @public
224
+ */
225
+ export interface ListIndicesRequest {
226
+ /**
227
+ * <p>The token used to get the next set of results, or <code>null</code> if there are no additional
228
+ * results.</p>
229
+ * @public
230
+ */
231
+ nextToken?: string | undefined;
232
+ /**
233
+ * <p>The maximum number of results to return at one time.</p>
234
+ * @public
235
+ */
236
+ maxResults?: number | undefined;
237
+ }
238
+ /**
239
+ * @public
240
+ */
241
+ export interface ListIndicesResponse {
242
+ /**
243
+ * <p>The index names.</p>
244
+ * @public
245
+ */
246
+ indexNames?: string[] | undefined;
247
+ /**
248
+ * <p>The token used to get the next set of results, or <code>null</code> if there are no additional
249
+ * results.</p>
250
+ * @public
251
+ */
252
+ nextToken?: string | undefined;
253
+ }
254
+ /**
255
+ * @public
256
+ */
257
+ export interface ListJobExecutionsForJobRequest {
258
+ /**
259
+ * <p>The unique identifier you assigned to this job when it was created.</p>
260
+ * @public
261
+ */
262
+ jobId: string | undefined;
263
+ /**
264
+ * <p>The status of the job.</p>
265
+ * @public
266
+ */
267
+ status?: JobExecutionStatus | undefined;
268
+ /**
269
+ * <p>The maximum number of results to be returned per request.</p>
270
+ * @public
271
+ */
272
+ maxResults?: number | undefined;
273
+ /**
274
+ * <p>The token to retrieve the next set of results.</p>
275
+ * @public
276
+ */
277
+ nextToken?: string | undefined;
278
+ }
279
+ /**
280
+ * <p>The job execution summary.</p>
281
+ * @public
282
+ */
283
+ export interface JobExecutionSummary {
284
+ /**
285
+ * <p>The status of the job execution.</p>
286
+ * @public
287
+ */
288
+ status?: JobExecutionStatus | undefined;
289
+ /**
290
+ * <p>The time, in seconds since the epoch, when the job execution was queued.</p>
291
+ * @public
292
+ */
293
+ queuedAt?: Date | undefined;
294
+ /**
295
+ * <p>The time, in seconds since the epoch, when the job execution started.</p>
296
+ * @public
297
+ */
298
+ startedAt?: Date | undefined;
299
+ /**
300
+ * <p>The time, in seconds since the epoch, when the job execution was last
301
+ * updated.</p>
302
+ * @public
303
+ */
304
+ lastUpdatedAt?: Date | undefined;
305
+ /**
306
+ * <p>A string (consisting of the digits "0" through "9") which identifies this
307
+ * particular job execution on this particular device. It can be used later in commands
308
+ * which return or update job execution information.</p>
309
+ * @public
310
+ */
311
+ executionNumber?: number | undefined;
312
+ /**
313
+ * <p>The number that indicates how many retry attempts have been completed for this job on
314
+ * this device.</p>
315
+ * @public
316
+ */
317
+ retryAttempt?: number | undefined;
318
+ }
319
+ /**
320
+ * <p>Contains a summary of information about job executions for a specific
321
+ * job.</p>
322
+ * @public
323
+ */
324
+ export interface JobExecutionSummaryForJob {
325
+ /**
326
+ * <p>The ARN of the thing on which the job execution is running.</p>
327
+ * @public
328
+ */
329
+ thingArn?: string | undefined;
330
+ /**
331
+ * <p>Contains a subset of information about a job execution.</p>
332
+ * @public
333
+ */
334
+ jobExecutionSummary?: JobExecutionSummary | undefined;
335
+ }
336
+ /**
337
+ * @public
338
+ */
339
+ export interface ListJobExecutionsForJobResponse {
340
+ /**
341
+ * <p>A list of job execution summaries.</p>
342
+ * @public
343
+ */
344
+ executionSummaries?: JobExecutionSummaryForJob[] | undefined;
345
+ /**
346
+ * <p>The token for the next set of results, or <b>null</b> if
347
+ * there are no additional results.</p>
348
+ * @public
349
+ */
350
+ nextToken?: string | undefined;
351
+ }
352
+ /**
353
+ * @public
354
+ */
355
+ export interface ListJobExecutionsForThingRequest {
356
+ /**
357
+ * <p>The thing name.</p>
358
+ * @public
359
+ */
360
+ thingName: string | undefined;
361
+ /**
362
+ * <p>An optional filter that lets you search for jobs that have the specified
363
+ * status.</p>
364
+ * @public
365
+ */
366
+ status?: JobExecutionStatus | undefined;
367
+ /**
368
+ * <p>The namespace used to indicate that a job is a customer-managed job.</p>
369
+ * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to
370
+ * MQTT topics that contain the value in the following format.</p>
371
+ * <p>
372
+ * <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
373
+ * </p>
374
+ * <note>
375
+ * <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For
376
+ * more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a>
377
+ * </p>
378
+ * </note>
379
+ * @public
380
+ */
381
+ namespaceId?: string | undefined;
382
+ /**
383
+ * <p>The maximum number of results to be returned per request.</p>
384
+ * @public
385
+ */
386
+ maxResults?: number | undefined;
387
+ /**
388
+ * <p>The token to retrieve the next set of results.</p>
389
+ * @public
390
+ */
391
+ nextToken?: string | undefined;
392
+ /**
393
+ * <p>The unique identifier you assigned to this job when it was created.</p>
394
+ * @public
395
+ */
396
+ jobId?: string | undefined;
397
+ }
398
+ /**
399
+ * <p>The job execution summary for a thing.</p>
400
+ * @public
401
+ */
402
+ export interface JobExecutionSummaryForThing {
403
+ /**
404
+ * <p>The unique identifier you assigned to this job when it was created.</p>
405
+ * @public
406
+ */
407
+ jobId?: string | undefined;
408
+ /**
409
+ * <p>Contains a subset of information about a job execution.</p>
410
+ * @public
411
+ */
412
+ jobExecutionSummary?: JobExecutionSummary | undefined;
413
+ }
414
+ /**
415
+ * @public
416
+ */
417
+ export interface ListJobExecutionsForThingResponse {
418
+ /**
419
+ * <p>A list of job execution summaries.</p>
420
+ * @public
421
+ */
422
+ executionSummaries?: JobExecutionSummaryForThing[] | undefined;
423
+ /**
424
+ * <p>The token for the next set of results, or <b>null</b> if
425
+ * there are no additional results.</p>
426
+ * @public
427
+ */
428
+ nextToken?: string | undefined;
429
+ }
430
+ /**
431
+ * @public
432
+ */
433
+ export interface ListJobsRequest {
434
+ /**
435
+ * <p>An optional filter that lets you search for jobs that have the specified
436
+ * status.</p>
437
+ * @public
438
+ */
439
+ status?: JobStatus | undefined;
440
+ /**
441
+ * <p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete
442
+ * after all those things specified as targets have completed the job (SNAPSHOT). If
443
+ * continuous, the job may also be run on a thing when a change is detected in a target.
444
+ * For example, a job will run on a thing when the thing is added to a target group, even
445
+ * after the job was completed by all things originally in the group. </p>
446
+ * <note>
447
+ * <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic
448
+ * thing group targets. By using continuous jobs, devices that join the group receive
449
+ * the job execution even after the job has been created.</p>
450
+ * </note>
451
+ * @public
452
+ */
453
+ targetSelection?: TargetSelection | undefined;
454
+ /**
455
+ * <p>The maximum number of results to return per request.</p>
456
+ * @public
457
+ */
458
+ maxResults?: number | undefined;
459
+ /**
460
+ * <p>The token to retrieve the next set of results.</p>
461
+ * @public
462
+ */
463
+ nextToken?: string | undefined;
464
+ /**
465
+ * <p>A filter that limits the returned jobs to those for the specified group.</p>
466
+ * @public
467
+ */
468
+ thingGroupName?: string | undefined;
469
+ /**
470
+ * <p>A filter that limits the returned jobs to those for the specified group.</p>
471
+ * @public
472
+ */
473
+ thingGroupId?: string | undefined;
474
+ /**
475
+ * <p>The namespace used to indicate that a job is a customer-managed job.</p>
476
+ * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to
477
+ * MQTT topics that contain the value in the following format.</p>
478
+ * <p>
479
+ * <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
480
+ * </p>
481
+ * <note>
482
+ * <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For
483
+ * more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a>
484
+ * </p>
485
+ * </note>
486
+ * @public
487
+ */
488
+ namespaceId?: string | undefined;
489
+ }
490
+ /**
491
+ * <p>The job summary.</p>
492
+ * @public
493
+ */
494
+ export interface JobSummary {
495
+ /**
496
+ * <p>The job ARN.</p>
497
+ * @public
498
+ */
499
+ jobArn?: string | undefined;
500
+ /**
501
+ * <p>The unique identifier you assigned to this job when it was created.</p>
502
+ * @public
503
+ */
504
+ jobId?: string | undefined;
505
+ /**
506
+ * <p>The ID of the thing group.</p>
507
+ * @public
508
+ */
509
+ thingGroupId?: string | undefined;
510
+ /**
511
+ * <p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete
512
+ * after all those things specified as targets have completed the job (SNAPSHOT). If
513
+ * continuous, the job may also be run on a thing when a change is detected in a target.
514
+ * For example, a job will run on a thing when the thing is added to a target group, even
515
+ * after the job was completed by all things originally in the group.</p>
516
+ * <note>
517
+ * <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic
518
+ * thing group targets. By using continuous jobs, devices that join the group receive
519
+ * the job execution even after the job has been created.</p>
520
+ * </note>
521
+ * @public
522
+ */
523
+ targetSelection?: TargetSelection | undefined;
524
+ /**
525
+ * <p>The job summary status.</p>
526
+ * @public
527
+ */
528
+ status?: JobStatus | undefined;
529
+ /**
530
+ * <p>The time, in seconds since the epoch, when the job was created.</p>
531
+ * @public
532
+ */
533
+ createdAt?: Date | undefined;
534
+ /**
535
+ * <p>The time, in seconds since the epoch, when the job was last updated.</p>
536
+ * @public
537
+ */
538
+ lastUpdatedAt?: Date | undefined;
539
+ /**
540
+ * <p>The time, in seconds since the epoch, when the job completed.</p>
541
+ * @public
542
+ */
543
+ completedAt?: Date | undefined;
544
+ /**
545
+ * <p>Indicates whether a job is concurrent. Will be true when a job is rolling out new job
546
+ * executions or canceling previously created executions, otherwise false.</p>
547
+ * @public
548
+ */
549
+ isConcurrent?: boolean | undefined;
550
+ }
551
+ /**
552
+ * @public
553
+ */
554
+ export interface ListJobsResponse {
555
+ /**
556
+ * <p>A list of jobs.</p>
557
+ * @public
558
+ */
559
+ jobs?: JobSummary[] | undefined;
560
+ /**
561
+ * <p>The token for the next set of results, or <b>null</b> if
562
+ * there are no additional results.</p>
563
+ * @public
564
+ */
565
+ nextToken?: string | undefined;
566
+ }
567
+ /**
568
+ * @public
569
+ */
570
+ export interface ListJobTemplatesRequest {
571
+ /**
572
+ * <p>The maximum number of results to return in the list.</p>
573
+ * @public
574
+ */
575
+ maxResults?: number | undefined;
576
+ /**
577
+ * <p>The token to use to return the next set of results in the list.</p>
578
+ * @public
579
+ */
580
+ nextToken?: string | undefined;
581
+ }
582
+ /**
583
+ * <p>An object that contains information about the job template.</p>
584
+ * @public
585
+ */
586
+ export interface JobTemplateSummary {
587
+ /**
588
+ * <p>The ARN of the job template.</p>
589
+ * @public
590
+ */
591
+ jobTemplateArn?: string | undefined;
592
+ /**
593
+ * <p>The unique identifier of the job template.</p>
594
+ * @public
595
+ */
596
+ jobTemplateId?: string | undefined;
597
+ /**
598
+ * <p>A description of the job template.</p>
599
+ * @public
600
+ */
601
+ description?: string | undefined;
602
+ /**
603
+ * <p>The time, in seconds since the epoch, when the job template was created.</p>
604
+ * @public
605
+ */
606
+ createdAt?: Date | undefined;
607
+ }
5
608
  /**
6
609
  * @public
7
610
  */
@@ -12,8 +615,8 @@ export interface ListJobTemplatesResponse {
12
615
  */
13
616
  jobTemplates?: JobTemplateSummary[] | undefined;
14
617
  /**
15
- * <p>The token for the next set of results, or <b>null</b> if there are no
16
- * additional results.</p>
618
+ * <p>The token for the next set of results, or <b>null</b> if
619
+ * there are no additional results.</p>
17
620
  * @public
18
621
  */
19
622
  nextToken?: string | undefined;
@@ -3736,6 +4339,62 @@ export interface UpdateCertificateProviderResponse {
3736
4339
  */
3737
4340
  certificateProviderArn?: string | undefined;
3738
4341
  }
4342
+ /**
4343
+ * @public
4344
+ */
4345
+ export interface UpdateCommandRequest {
4346
+ /**
4347
+ * <p>The unique identifier of the command to be updated.</p>
4348
+ * @public
4349
+ */
4350
+ commandId: string | undefined;
4351
+ /**
4352
+ * <p>The new user-friendly name to use in the console for the command.</p>
4353
+ * @public
4354
+ */
4355
+ displayName?: string | undefined;
4356
+ /**
4357
+ * <p>A short text description of the command.</p>
4358
+ * @public
4359
+ */
4360
+ description?: string | undefined;
4361
+ /**
4362
+ * <p>A boolean that you can use to specify whether to deprecate a command.</p>
4363
+ * @public
4364
+ */
4365
+ deprecated?: boolean | undefined;
4366
+ }
4367
+ /**
4368
+ * @public
4369
+ */
4370
+ export interface UpdateCommandResponse {
4371
+ /**
4372
+ * <p>The unique identifier of the command.</p>
4373
+ * @public
4374
+ */
4375
+ commandId?: string | undefined;
4376
+ /**
4377
+ * <p>The updated user-friendly display name in the console for the command.</p>
4378
+ * @public
4379
+ */
4380
+ displayName?: string | undefined;
4381
+ /**
4382
+ * <p>The updated text description of the command.</p>
4383
+ * @public
4384
+ */
4385
+ description?: string | undefined;
4386
+ /**
4387
+ * <p>The boolean that indicates whether the command was deprecated.</p>
4388
+ * @public
4389
+ */
4390
+ deprecated?: boolean | undefined;
4391
+ /**
4392
+ * <p>The date and time (epoch timestamp in seconds) when the command was last
4393
+ * updated.</p>
4394
+ * @public
4395
+ */
4396
+ lastUpdatedAt?: Date | undefined;
4397
+ }
3739
4398
  /**
3740
4399
  * @public
3741
4400
  */
@@ -4155,22 +4814,23 @@ export interface UpdateJobRequest {
4155
4814
  */
4156
4815
  abortConfig?: AbortConfig | undefined;
4157
4816
  /**
4158
- * <p>Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to <code>IN_PROGRESS</code>.
4159
- * If the job execution status is not set to another terminal state before the time expires, it will be automatically set to <code>TIMED_OUT</code>. </p>
4817
+ * <p>Specifies the amount of time each device has to finish its execution of the job. The
4818
+ * timer is started when the job execution status is set to <code>IN_PROGRESS</code>. If
4819
+ * the job execution status is not set to another terminal state before the time expires,
4820
+ * it will be automatically set to <code>TIMED_OUT</code>. </p>
4160
4821
  * @public
4161
4822
  */
4162
4823
  timeoutConfig?: TimeoutConfig | undefined;
4163
4824
  /**
4164
4825
  * <p>The namespace used to indicate that a job is a customer-managed job.</p>
4165
- * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
4166
- * contain the value in the following format.</p>
4826
+ * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to
4827
+ * MQTT topics that contain the value in the following format.</p>
4167
4828
  * <p>
4168
4829
  * <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
4169
4830
  * </p>
4170
4831
  * <note>
4171
- * <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
4172
- * this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting
4173
- * up IoT Greengrass core devices.</a>
4832
+ * <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For
4833
+ * more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a>
4174
4834
  * </p>
4175
4835
  * </note>
4176
4836
  * @public