@aws-sdk/client-iot 3.694.0 → 3.698.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +64 -0
- package/dist-cjs/index.js +555 -0
- package/dist-es/IoT.js +16 -0
- package/dist-es/commands/CreateCommandCommand.js +22 -0
- package/dist-es/commands/DeleteCommandCommand.js +22 -0
- package/dist-es/commands/DeleteCommandExecutionCommand.js +22 -0
- package/dist-es/commands/GetCommandCommand.js +22 -0
- package/dist-es/commands/GetCommandExecutionCommand.js +22 -0
- package/dist-es/commands/ListCommandExecutionsCommand.js +22 -0
- package/dist-es/commands/ListCommandsCommand.js +22 -0
- package/dist-es/commands/UpdateCommandCommand.js +22 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/models/models_1.js +12 -0
- package/dist-es/pagination/ListCommandExecutionsPaginator.js +4 -0
- package/dist-es/pagination/ListCommandsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +387 -0
- package/dist-types/IoT.d.ts +58 -0
- package/dist-types/IoTClient.d.ts +10 -2
- package/dist-types/commands/AssociateSbomWithPackageVersionCommand.d.ts +2 -2
- package/dist-types/commands/AssociateTargetsWithJobCommand.d.ts +4 -3
- package/dist-types/commands/CreateCommandCommand.d.ts +127 -0
- package/dist-types/commands/CreateJobTemplateCommand.d.ts +1 -1
- package/dist-types/commands/CreatePackageCommand.d.ts +2 -2
- package/dist-types/commands/CreatePackageVersionCommand.d.ts +2 -2
- package/dist-types/commands/CreateTopicRuleDestinationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteAccountAuditConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAuditSuppressionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCommandCommand.d.ts +84 -0
- package/dist-types/commands/DeleteCommandExecutionCommand.d.ts +87 -0
- package/dist-types/commands/DeleteJobCommand.d.ts +6 -7
- package/dist-types/commands/DisassociateSbomFromPackageVersionCommand.d.ts +1 -1
- package/dist-types/commands/GetCommandCommand.d.ts +121 -0
- package/dist-types/commands/GetCommandExecutionCommand.d.ts +117 -0
- package/dist-types/commands/ListCommandExecutionsCommand.d.ts +116 -0
- package/dist-types/commands/ListCommandsCommand.d.ts +96 -0
- package/dist-types/commands/ListDetectMitigationActionsExecutionsCommand.d.ts +2 -1
- package/dist-types/commands/ListDetectMitigationActionsTasksCommand.d.ts +1 -1
- package/dist-types/commands/ListDimensionsCommand.d.ts +1 -1
- package/dist-types/commands/ListDomainConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListFleetMetricsCommand.d.ts +1 -1
- package/dist-types/commands/ListIndicesCommand.d.ts +1 -1
- package/dist-types/commands/ListJobExecutionsForJobCommand.d.ts +1 -1
- package/dist-types/commands/ListJobExecutionsForThingCommand.d.ts +1 -1
- package/dist-types/commands/ListJobTemplatesCommand.d.ts +1 -2
- package/dist-types/commands/ListJobsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCommandCommand.d.ts +94 -0
- package/dist-types/commands/UpdatePackageCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePackageConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePackageVersionCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/models/models_0.d.ts +332 -236
- package/dist-types/models/models_1.d.ts +880 -784
- package/dist-types/models/models_2.d.ts +671 -11
- package/dist-types/pagination/ListCommandExecutionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListCommandsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +72 -0
- package/dist-types/ts3.4/IoT.d.ts +138 -0
- package/dist-types/ts3.4/IoTClient.d.ts +48 -0
- package/dist-types/ts3.4/commands/CreateCommandCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateTopicRuleDestinationCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DeleteAccountAuditConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteAuditSuppressionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteCommandCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteCommandExecutionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetCommandCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetCommandExecutionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListCommandExecutionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListCommandsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListDetectMitigationActionsExecutionsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListDetectMitigationActionsTasksCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDimensionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDomainConfigurationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListFleetMetricsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIndicesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListJobExecutionsForJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListJobExecutionsForThingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListJobTemplatesCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/ListJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateCommandCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/models/models_0.d.ts +39 -21
- package/dist-types/ts3.4/models/models_1.d.ts +148 -129
- package/dist-types/ts3.4/models/models_2.d.ts +147 -1
- package/dist-types/ts3.4/pagination/ListCommandExecutionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListCommandsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +96 -0
- package/package.json +35 -35
|
@@ -1,6 +1,127 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { IoTServiceException as __BaseException } from "./IoTServiceException";
|
|
3
|
-
import { AbortConfig, Action, ActiveViolation, AggregationType, AlertTarget, AlertTargetType, ApplicationProtocol, AuditCheckConfiguration, AuditCheckDetails, AuditFinding, AuditFrequency, AuditMitigationActionExecutionMetadata, AuditMitigationActionsExecutionStatus, AuditMitigationActionsTaskMetadata, AuditMitigationActionsTaskStatus, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditNotificationType, AuditSuppression, AuditTaskMetadata, AuditTaskStatus, AuditTaskType, AuthenticationType, AuthorizerConfig, AuthorizerDescription, AuthorizerStatus, AuthorizerSummary, AutoRegistrationStatus, AwsJobExecutionsRolloutConfig, AwsJobPresignedUrlConfig, Behavior, BillingGroupProperties, CertificateProviderOperation, ClientCertificateConfig, CustomMetricType, DayOfWeek, DimensionType, FleetMetricUnit, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MaintenanceWindow, MetricsExportConfig, MetricToRetain, MitigationActionParams, OTAUpdateFile, OTAUpdateStatus, PackageVersionArtifact, PackageVersionStatus, Policy, PresignedUrlConfig, Protocol, ProvisioningHook, ResourceIdentifier, Sbom, SbomValidationStatus, SchedulingConfig, ServerCertificateConfig, ServiceType, StreamFile, TargetSelection, TaskStatisticsForAuditCheck, TemplateType, ThingGroupProperties, ThingTypeProperties, TimeoutConfig, TlsConfig,
|
|
3
|
+
import { AbortConfig, Action, ActiveViolation, AggregationType, AlertTarget, AlertTargetType, ApplicationProtocol, AuditCheckConfiguration, AuditCheckDetails, AuditFinding, AuditFrequency, AuditMitigationActionExecutionMetadata, AuditMitigationActionsExecutionStatus, AuditMitigationActionsTaskMetadata, AuditMitigationActionsTaskStatus, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditNotificationType, AuditSuppression, AuditTaskMetadata, AuditTaskStatus, AuditTaskType, AuthenticationType, AuthorizerConfig, AuthorizerDescription, AuthorizerStatus, AuthorizerSummary, AutoRegistrationStatus, AwsJobExecutionsRolloutConfig, AwsJobPresignedUrlConfig, Behavior, BillingGroupProperties, CertificateProviderOperation, ClientCertificateConfig, CommandNamespace, CommandParameter, CommandParameterValue, CommandPayload, CustomMetricType, DayOfWeek, DimensionType, FleetMetricUnit, HttpUrlDestinationProperties, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MaintenanceWindow, MetricsExportConfig, MetricToRetain, MitigationActionParams, OTAUpdateFile, OTAUpdateStatus, PackageVersionArtifact, PackageVersionStatus, Policy, PresignedUrlConfig, Protocol, ProvisioningHook, ResourceIdentifier, Sbom, SbomValidationStatus, SchedulingConfig, ServerCertificateConfig, ServiceType, StreamFile, TargetSelection, TaskStatisticsForAuditCheck, TemplateType, ThingGroupProperties, ThingTypeProperties, TimeoutConfig, TlsConfig, TopicRuleDestinationStatus, VerificationState, VpcDestinationProperties } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* <p>A topic rule destination.</p>
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface TopicRuleDestination {
|
|
9
|
+
/**
|
|
10
|
+
* <p>The topic rule destination URL.</p>
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
arn?: string | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* <p>The status of the topic rule destination. Valid values are:</p>
|
|
16
|
+
* <dl>
|
|
17
|
+
* <dt>IN_PROGRESS</dt>
|
|
18
|
+
* <dd>
|
|
19
|
+
* <p>A topic rule destination was created but has not been confirmed. You can set
|
|
20
|
+
* <code>status</code> to <code>IN_PROGRESS</code> by calling
|
|
21
|
+
* <code>UpdateTopicRuleDestination</code>. Calling
|
|
22
|
+
* <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to
|
|
23
|
+
* be sent to your confirmation endpoint.</p>
|
|
24
|
+
* </dd>
|
|
25
|
+
* <dt>ENABLED</dt>
|
|
26
|
+
* <dd>
|
|
27
|
+
* <p>Confirmation was completed, and traffic to this destination is allowed. You can
|
|
28
|
+
* set <code>status</code> to <code>DISABLED</code> by calling
|
|
29
|
+
* <code>UpdateTopicRuleDestination</code>.</p>
|
|
30
|
+
* </dd>
|
|
31
|
+
* <dt>DISABLED</dt>
|
|
32
|
+
* <dd>
|
|
33
|
+
* <p>Confirmation was completed, and traffic to this destination is not allowed. You
|
|
34
|
+
* can set <code>status</code> to <code>ENABLED</code> by calling
|
|
35
|
+
* <code>UpdateTopicRuleDestination</code>.</p>
|
|
36
|
+
* </dd>
|
|
37
|
+
* <dt>ERROR</dt>
|
|
38
|
+
* <dd>
|
|
39
|
+
* <p>Confirmation could not be completed, for example if the confirmation timed out.
|
|
40
|
+
* You can call <code>GetTopicRuleDestination</code> for details about the error. You
|
|
41
|
+
* can set <code>status</code> to <code>IN_PROGRESS</code> by calling
|
|
42
|
+
* <code>UpdateTopicRuleDestination</code>. Calling
|
|
43
|
+
* <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to
|
|
44
|
+
* be sent to your confirmation endpoint.</p>
|
|
45
|
+
* </dd>
|
|
46
|
+
* </dl>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
status?: TopicRuleDestinationStatus | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* <p>The date and time when the topic rule destination was created.</p>
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
createdAt?: Date | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* <p>The date and time when the topic rule destination was last updated.</p>
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
59
|
+
lastUpdatedAt?: Date | undefined;
|
|
60
|
+
/**
|
|
61
|
+
* <p>Additional details or reason why the topic rule destination is in the current
|
|
62
|
+
* status.</p>
|
|
63
|
+
* @public
|
|
64
|
+
*/
|
|
65
|
+
statusReason?: string | undefined;
|
|
66
|
+
/**
|
|
67
|
+
* <p>Properties of the HTTP URL.</p>
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
httpUrlProperties?: HttpUrlDestinationProperties | undefined;
|
|
71
|
+
/**
|
|
72
|
+
* <p>Properties of the virtual private cloud (VPC) connection.</p>
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
vpcProperties?: VpcDestinationProperties | undefined;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
export interface CreateTopicRuleDestinationResponse {
|
|
81
|
+
/**
|
|
82
|
+
* <p>The topic rule destination.</p>
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
topicRuleDestination?: TopicRuleDestination | undefined;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
export interface DeleteAccountAuditConfigurationRequest {
|
|
91
|
+
/**
|
|
92
|
+
* <p>If true, all scheduled audits are deleted.</p>
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
deleteScheduledAudits?: boolean | undefined;
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
export interface DeleteAccountAuditConfigurationResponse {
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
export interface DeleteAuditSuppressionRequest {
|
|
106
|
+
/**
|
|
107
|
+
* <p>An audit check name. Checks must be enabled
|
|
108
|
+
* for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list
|
|
109
|
+
* of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code>
|
|
110
|
+
* to select which checks are enabled.)</p>
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
checkName: string | undefined;
|
|
114
|
+
/**
|
|
115
|
+
* <p>Information that identifies the noncompliant resource.</p>
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
resourceIdentifier: ResourceIdentifier | undefined;
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* @public
|
|
122
|
+
*/
|
|
123
|
+
export interface DeleteAuditSuppressionResponse {
|
|
124
|
+
}
|
|
4
125
|
/**
|
|
5
126
|
* @public
|
|
6
127
|
*/
|
|
@@ -115,6 +236,64 @@ export interface DeleteCertificateProviderRequest {
|
|
|
115
236
|
*/
|
|
116
237
|
export interface DeleteCertificateProviderResponse {
|
|
117
238
|
}
|
|
239
|
+
/**
|
|
240
|
+
* @public
|
|
241
|
+
*/
|
|
242
|
+
export interface DeleteCommandRequest {
|
|
243
|
+
/**
|
|
244
|
+
* <p>The unique identifier of the command to be deleted.</p>
|
|
245
|
+
* @public
|
|
246
|
+
*/
|
|
247
|
+
commandId: string | undefined;
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* @public
|
|
251
|
+
*/
|
|
252
|
+
export interface DeleteCommandResponse {
|
|
253
|
+
/**
|
|
254
|
+
* <p>The status code for the command deletion request. The status code is in the 200 range
|
|
255
|
+
* for a successful request.</p>
|
|
256
|
+
* <ul>
|
|
257
|
+
* <li>
|
|
258
|
+
* <p>If the command hasn't been deprecated, or has been deprecated for a duration that
|
|
259
|
+
* is shorter than the maximum time out duration of 12 hours, when calling the
|
|
260
|
+
* <code>DeleteCommand</code> request, the deletion will be scheduled and a 202 status code
|
|
261
|
+
* will be returned. While the command is being deleted, it will be in a
|
|
262
|
+
* <code>pendingDeletion</code> state. Once the time out duration has been reached,
|
|
263
|
+
* the command will be permanently removed from your account.</p>
|
|
264
|
+
* </li>
|
|
265
|
+
* <li>
|
|
266
|
+
* <p>If the command has been deprecated for a duration that is longer than the
|
|
267
|
+
* maximum time out duration of 12 hours, when calling the <code>DeleteCommand</code> request,
|
|
268
|
+
* the command will be deleted immediately and a 204 status code will be returned.</p>
|
|
269
|
+
* </li>
|
|
270
|
+
* </ul>
|
|
271
|
+
* @public
|
|
272
|
+
*/
|
|
273
|
+
statusCode?: number | undefined;
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
* @public
|
|
277
|
+
*/
|
|
278
|
+
export interface DeleteCommandExecutionRequest {
|
|
279
|
+
/**
|
|
280
|
+
* <p>The unique identifier of the command execution that you want to delete from your
|
|
281
|
+
* account.</p>
|
|
282
|
+
* @public
|
|
283
|
+
*/
|
|
284
|
+
executionId: string | undefined;
|
|
285
|
+
/**
|
|
286
|
+
* <p>The Amazon Resource Number (ARN) of the target device for which you want to delete
|
|
287
|
+
* command executions.</p>
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
targetArn: string | undefined;
|
|
291
|
+
}
|
|
292
|
+
/**
|
|
293
|
+
* @public
|
|
294
|
+
*/
|
|
295
|
+
export interface DeleteCommandExecutionResponse {
|
|
296
|
+
}
|
|
118
297
|
/**
|
|
119
298
|
* @public
|
|
120
299
|
*/
|
|
@@ -203,36 +382,35 @@ export interface DeleteFleetMetricRequest {
|
|
|
203
382
|
export interface DeleteJobRequest {
|
|
204
383
|
/**
|
|
205
384
|
* <p>The ID of the job to be deleted.</p>
|
|
206
|
-
* <p>After a job deletion is completed, you may reuse this jobId when you create a new
|
|
207
|
-
*
|
|
208
|
-
*
|
|
385
|
+
* <p>After a job deletion is completed, you may reuse this jobId when you create a new
|
|
386
|
+
* job. However, this is not recommended, and you must ensure that your devices are not
|
|
387
|
+
* using the jobId to refer to the deleted job.</p>
|
|
209
388
|
* @public
|
|
210
389
|
*/
|
|
211
390
|
jobId: string | undefined;
|
|
212
391
|
/**
|
|
213
|
-
* <p>(Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you
|
|
214
|
-
*
|
|
215
|
-
*
|
|
392
|
+
* <p>(Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you
|
|
393
|
+
* can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an
|
|
394
|
+
* exception will occur. The default is false.</p>
|
|
216
395
|
* <note>
|
|
217
396
|
* <p>Deleting a job which is "IN_PROGRESS", will cause a device which is executing
|
|
218
|
-
*
|
|
219
|
-
*
|
|
220
|
-
*
|
|
397
|
+
* the job to be unable to access job information or update the job execution status.
|
|
398
|
+
* Use caution and ensure that each device executing a job which is deleted is able to
|
|
399
|
+
* recover to a valid state.</p>
|
|
221
400
|
* </note>
|
|
222
401
|
* @public
|
|
223
402
|
*/
|
|
224
403
|
force?: boolean | undefined;
|
|
225
404
|
/**
|
|
226
405
|
* <p>The namespace used to indicate that a job is a customer-managed job.</p>
|
|
227
|
-
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to
|
|
228
|
-
* contain the value in the following format.</p>
|
|
406
|
+
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to
|
|
407
|
+
* MQTT topics that contain the value in the following format.</p>
|
|
229
408
|
* <p>
|
|
230
409
|
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
|
|
231
410
|
* </p>
|
|
232
411
|
* <note>
|
|
233
|
-
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
|
|
234
|
-
*
|
|
235
|
-
* up IoT Greengrass core devices.</a>
|
|
412
|
+
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For
|
|
413
|
+
* more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a>
|
|
236
414
|
* </p>
|
|
237
415
|
* </note>
|
|
238
416
|
* @public
|
|
@@ -254,36 +432,36 @@ export interface DeleteJobExecutionRequest {
|
|
|
254
432
|
*/
|
|
255
433
|
thingName: string | undefined;
|
|
256
434
|
/**
|
|
257
|
-
* <p>The ID of the job execution to be deleted. The <code>executionNumber</code> refers
|
|
258
|
-
*
|
|
259
|
-
* <p>Note that once a job execution is deleted, the <code>executionNumber</code> may be
|
|
260
|
-
*
|
|
435
|
+
* <p>The ID of the job execution to be deleted. The <code>executionNumber</code> refers
|
|
436
|
+
* to the execution of a particular job on a particular device.</p>
|
|
437
|
+
* <p>Note that once a job execution is deleted, the <code>executionNumber</code> may be
|
|
438
|
+
* reused by IoT, so be sure you get and use the correct value here.</p>
|
|
261
439
|
* @public
|
|
262
440
|
*/
|
|
263
441
|
executionNumber: number | undefined;
|
|
264
442
|
/**
|
|
265
|
-
* <p>(Optional) When true, you can delete a job execution which is "IN_PROGRESS".
|
|
266
|
-
*
|
|
267
|
-
*
|
|
443
|
+
* <p>(Optional) When true, you can delete a job execution which is "IN_PROGRESS".
|
|
444
|
+
* Otherwise, you can only delete a job execution which is in a terminal state
|
|
445
|
+
* ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur.
|
|
446
|
+
* The default is false.</p>
|
|
268
447
|
* <note>
|
|
269
|
-
* <p>Deleting a job execution which is "IN_PROGRESS", will cause the device
|
|
270
|
-
*
|
|
271
|
-
*
|
|
448
|
+
* <p>Deleting a job execution which is "IN_PROGRESS", will cause the device to be
|
|
449
|
+
* unable to access job information or update the job execution status. Use caution and
|
|
450
|
+
* ensure that the device is able to recover to a valid state.</p>
|
|
272
451
|
* </note>
|
|
273
452
|
* @public
|
|
274
453
|
*/
|
|
275
454
|
force?: boolean | undefined;
|
|
276
455
|
/**
|
|
277
456
|
* <p>The namespace used to indicate that a job is a customer-managed job.</p>
|
|
278
|
-
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to
|
|
279
|
-
* contain the value in the following format.</p>
|
|
457
|
+
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to
|
|
458
|
+
* MQTT topics that contain the value in the following format.</p>
|
|
280
459
|
* <p>
|
|
281
460
|
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
|
|
282
461
|
* </p>
|
|
283
462
|
* <note>
|
|
284
|
-
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
|
|
285
|
-
*
|
|
286
|
-
* up IoT Greengrass core devices.</a>
|
|
463
|
+
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For
|
|
464
|
+
* more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a>
|
|
287
465
|
* </p>
|
|
288
466
|
* </note>
|
|
289
467
|
* @public
|
|
@@ -2162,7 +2340,7 @@ export interface DescribeJobRequest {
|
|
|
2162
2340
|
*/
|
|
2163
2341
|
jobId: string | undefined;
|
|
2164
2342
|
/**
|
|
2165
|
-
* <p>
|
|
2343
|
+
* <p>Provides a view of the job document before and after the substitution parameters have been resolved with their exact values.</p>
|
|
2166
2344
|
* @public
|
|
2167
2345
|
*/
|
|
2168
2346
|
beforeSubstitution?: boolean | undefined;
|
|
@@ -2173,7 +2351,9 @@ export interface DescribeJobRequest {
|
|
|
2173
2351
|
*/
|
|
2174
2352
|
export interface JobProcessDetails {
|
|
2175
2353
|
/**
|
|
2176
|
-
* <p>The target devices to which the job execution is being rolled out. This value will
|
|
2354
|
+
* <p>The target devices to which the job execution is being rolled out. This value will
|
|
2355
|
+
* be null after the job execution has finished rolling out to all the target
|
|
2356
|
+
* devices.</p>
|
|
2177
2357
|
* @public
|
|
2178
2358
|
*/
|
|
2179
2359
|
processingTargets?: string[] | undefined;
|
|
@@ -2208,8 +2388,9 @@ export interface JobProcessDetails {
|
|
|
2208
2388
|
*/
|
|
2209
2389
|
numberOfInProgressThings?: number | undefined;
|
|
2210
2390
|
/**
|
|
2211
|
-
* <p>The number of things that are no longer scheduled to execute the job because they
|
|
2212
|
-
* have been removed from the group that was a target of the
|
|
2391
|
+
* <p>The number of things that are no longer scheduled to execute the job because they
|
|
2392
|
+
* have been deleted or have been removed from the group that was a target of the
|
|
2393
|
+
* job.</p>
|
|
2213
2394
|
* @public
|
|
2214
2395
|
*/
|
|
2215
2396
|
numberOfRemovedThings?: number | undefined;
|
|
@@ -2251,7 +2432,8 @@ export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
|
|
|
2251
2432
|
*/
|
|
2252
2433
|
export interface Job {
|
|
2253
2434
|
/**
|
|
2254
|
-
* <p>An ARN identifying the job with format
|
|
2435
|
+
* <p>An ARN identifying the job with format
|
|
2436
|
+
* "arn:aws:iot:region:account:job/jobId".</p>
|
|
2255
2437
|
* @public
|
|
2256
2438
|
*/
|
|
2257
2439
|
jobArn?: string | undefined;
|
|
@@ -2261,28 +2443,29 @@ export interface Job {
|
|
|
2261
2443
|
*/
|
|
2262
2444
|
jobId?: string | undefined;
|
|
2263
2445
|
/**
|
|
2264
|
-
* <p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete
|
|
2265
|
-
* specified as targets have completed the job (SNAPSHOT). If
|
|
2266
|
-
*
|
|
2267
|
-
*
|
|
2446
|
+
* <p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete
|
|
2447
|
+
* after all those things specified as targets have completed the job (SNAPSHOT). If
|
|
2448
|
+
* continuous, the job may also be run on a thing when a change is detected in a target.
|
|
2449
|
+
* For example, a job will run on a device when the thing representing the device is added
|
|
2450
|
+
* to a target group, even after the job was completed by all things originally in the
|
|
2268
2451
|
* group. </p>
|
|
2269
2452
|
* <note>
|
|
2270
|
-
* <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic
|
|
2271
|
-
* By using continuous jobs, devices that join the group receive
|
|
2272
|
-
* been created.</p>
|
|
2453
|
+
* <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic
|
|
2454
|
+
* thing group targets. By using continuous jobs, devices that join the group receive
|
|
2455
|
+
* the job execution even after the job has been created.</p>
|
|
2273
2456
|
* </note>
|
|
2274
2457
|
* @public
|
|
2275
2458
|
*/
|
|
2276
2459
|
targetSelection?: TargetSelection | undefined;
|
|
2277
2460
|
/**
|
|
2278
2461
|
* <p>The status of the job, one of <code>IN_PROGRESS</code>, <code>CANCELED</code>,
|
|
2279
|
-
*
|
|
2462
|
+
* <code>DELETION_IN_PROGRESS</code> or <code>COMPLETED</code>. </p>
|
|
2280
2463
|
* @public
|
|
2281
2464
|
*/
|
|
2282
2465
|
status?: JobStatus | undefined;
|
|
2283
2466
|
/**
|
|
2284
|
-
* <p>Will be <code>true</code> if the job was canceled with the optional
|
|
2285
|
-
*
|
|
2467
|
+
* <p>Will be <code>true</code> if the job was canceled with the optional
|
|
2468
|
+
* <code>force</code> parameter set to <code>true</code>.</p>
|
|
2286
2469
|
* @public
|
|
2287
2470
|
*/
|
|
2288
2471
|
forceCanceled?: boolean | undefined;
|
|
@@ -2342,24 +2525,23 @@ export interface Job {
|
|
|
2342
2525
|
*/
|
|
2343
2526
|
jobProcessDetails?: JobProcessDetails | undefined;
|
|
2344
2527
|
/**
|
|
2345
|
-
* <p>Specifies the amount of time each device has to finish its execution of the job.
|
|
2346
|
-
*
|
|
2347
|
-
*
|
|
2348
|
-
*
|
|
2528
|
+
* <p>Specifies the amount of time each device has to finish its execution of the job. A
|
|
2529
|
+
* timer is started when the job execution status is set to <code>IN_PROGRESS</code>. If
|
|
2530
|
+
* the job execution status is not set to another terminal state before the timer expires,
|
|
2531
|
+
* it will be automatically set to <code>TIMED_OUT</code>.</p>
|
|
2349
2532
|
* @public
|
|
2350
2533
|
*/
|
|
2351
2534
|
timeoutConfig?: TimeoutConfig | undefined;
|
|
2352
2535
|
/**
|
|
2353
2536
|
* <p>The namespace used to indicate that a job is a customer-managed job.</p>
|
|
2354
|
-
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to
|
|
2355
|
-
* contain the value in the following format.</p>
|
|
2537
|
+
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to
|
|
2538
|
+
* MQTT topics that contain the value in the following format.</p>
|
|
2356
2539
|
* <p>
|
|
2357
2540
|
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
|
|
2358
2541
|
* </p>
|
|
2359
2542
|
* <note>
|
|
2360
|
-
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
|
|
2361
|
-
*
|
|
2362
|
-
* up IoT Greengrass core devices.</a>
|
|
2543
|
+
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For
|
|
2544
|
+
* more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a>
|
|
2363
2545
|
* </p>
|
|
2364
2546
|
* </note>
|
|
2365
2547
|
* @public
|
|
@@ -2377,8 +2559,8 @@ export interface Job {
|
|
|
2377
2559
|
jobExecutionsRetryConfig?: JobExecutionsRetryConfig | undefined;
|
|
2378
2560
|
/**
|
|
2379
2561
|
* <p>A key-value map that pairs the patterns that need to be replaced in a managed
|
|
2380
|
-
* template job document schema. You can use the description of each key as a guidance
|
|
2381
|
-
*
|
|
2562
|
+
* template job document schema. You can use the description of each key as a guidance to
|
|
2563
|
+
* specify the inputs during runtime when creating a job.</p>
|
|
2382
2564
|
* <note>
|
|
2383
2565
|
* <p>
|
|
2384
2566
|
* <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services
|
|
@@ -2389,9 +2571,8 @@ export interface Job {
|
|
|
2389
2571
|
*/
|
|
2390
2572
|
documentParameters?: Record<string, string> | undefined;
|
|
2391
2573
|
/**
|
|
2392
|
-
* <p>Indicates whether a job is concurrent. Will be true when a job is
|
|
2393
|
-
*
|
|
2394
|
-
* otherwise false.</p>
|
|
2574
|
+
* <p>Indicates whether a job is concurrent. Will be true when a job is rolling out new job
|
|
2575
|
+
* executions or canceling previously created executions, otherwise false.</p>
|
|
2395
2576
|
* @public
|
|
2396
2577
|
*/
|
|
2397
2578
|
isConcurrent?: boolean | undefined;
|
|
@@ -2407,11 +2588,13 @@ export interface Job {
|
|
|
2407
2588
|
*/
|
|
2408
2589
|
scheduledJobRollouts?: ScheduledJobRollout[] | undefined;
|
|
2409
2590
|
/**
|
|
2410
|
-
* <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the
|
|
2411
|
-
*
|
|
2591
|
+
* <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the job
|
|
2592
|
+
* successfully completes. The package version must be in either the Published or
|
|
2593
|
+
* Deprecated state when the job deploys. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>.The package version must be in either the
|
|
2594
|
+
* Published or Deprecated state when the job deploys. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>.</p>
|
|
2412
2595
|
* <p>
|
|
2413
|
-
* <b>Note:</b>The following Length Constraints relates to a
|
|
2414
|
-
* Up to 25
|
|
2596
|
+
* <b>Note:</b>The following Length Constraints relates to a
|
|
2597
|
+
* single ARN. Up to 25 package version ARNs are allowed.</p>
|
|
2415
2598
|
* @public
|
|
2416
2599
|
*/
|
|
2417
2600
|
destinationPackageVersions?: string[] | undefined;
|
|
@@ -2446,8 +2629,8 @@ export interface DescribeJobExecutionRequest {
|
|
|
2446
2629
|
*/
|
|
2447
2630
|
thingName: string | undefined;
|
|
2448
2631
|
/**
|
|
2449
|
-
* <p>A string (consisting of the digits "0" through "9" which is used to specify a
|
|
2450
|
-
* on a particular device.</p>
|
|
2632
|
+
* <p>A string (consisting of the digits "0" through "9" which is used to specify a
|
|
2633
|
+
* particular job execution on a particular device.</p>
|
|
2451
2634
|
* @public
|
|
2452
2635
|
*/
|
|
2453
2636
|
executionNumber?: number | undefined;
|
|
@@ -2482,7 +2665,8 @@ export interface JobExecutionStatusDetails {
|
|
|
2482
2665
|
detailsMap?: Record<string, string> | undefined;
|
|
2483
2666
|
}
|
|
2484
2667
|
/**
|
|
2485
|
-
* <p>The job execution object represents the execution of a job on a particular
|
|
2668
|
+
* <p>The job execution object represents the execution of a job on a particular
|
|
2669
|
+
* device.</p>
|
|
2486
2670
|
* @public
|
|
2487
2671
|
*/
|
|
2488
2672
|
export interface JobExecution {
|
|
@@ -2498,13 +2682,14 @@ export interface JobExecution {
|
|
|
2498
2682
|
*/
|
|
2499
2683
|
status?: JobExecutionStatus | undefined;
|
|
2500
2684
|
/**
|
|
2501
|
-
* <p>Will be <code>true</code> if the job execution was canceled with the optional
|
|
2502
|
-
*
|
|
2685
|
+
* <p>Will be <code>true</code> if the job execution was canceled with the optional
|
|
2686
|
+
* <code>force</code> parameter set to <code>true</code>.</p>
|
|
2503
2687
|
* @public
|
|
2504
2688
|
*/
|
|
2505
2689
|
forceCanceled?: boolean | undefined;
|
|
2506
2690
|
/**
|
|
2507
|
-
* <p>A collection of name/value pairs that describe the status of the job
|
|
2691
|
+
* <p>A collection of name/value pairs that describe the status of the job
|
|
2692
|
+
* execution.</p>
|
|
2508
2693
|
* @public
|
|
2509
2694
|
*/
|
|
2510
2695
|
statusDetails?: JobExecutionStatusDetails | undefined;
|
|
@@ -2524,28 +2709,30 @@ export interface JobExecution {
|
|
|
2524
2709
|
*/
|
|
2525
2710
|
startedAt?: Date | undefined;
|
|
2526
2711
|
/**
|
|
2527
|
-
* <p>The time, in seconds since the epoch, when the job execution was last
|
|
2712
|
+
* <p>The time, in seconds since the epoch, when the job execution was last
|
|
2713
|
+
* updated.</p>
|
|
2528
2714
|
* @public
|
|
2529
2715
|
*/
|
|
2530
2716
|
lastUpdatedAt?: Date | undefined;
|
|
2531
2717
|
/**
|
|
2532
|
-
* <p>A string (consisting of the digits "0" through "9") which identifies this
|
|
2533
|
-
* this particular device. It can be used in commands which
|
|
2534
|
-
*
|
|
2718
|
+
* <p>A string (consisting of the digits "0" through "9") which identifies this
|
|
2719
|
+
* particular job execution on this particular device. It can be used in commands which
|
|
2720
|
+
* return or update job execution information. </p>
|
|
2535
2721
|
* @public
|
|
2536
2722
|
*/
|
|
2537
2723
|
executionNumber?: number | undefined;
|
|
2538
2724
|
/**
|
|
2539
|
-
* <p>The version of the job execution. Job execution versions are incremented each time
|
|
2540
|
-
*
|
|
2725
|
+
* <p>The version of the job execution. Job execution versions are incremented each time
|
|
2726
|
+
* they are updated by a device.</p>
|
|
2541
2727
|
* @public
|
|
2542
2728
|
*/
|
|
2543
2729
|
versionNumber?: number | undefined;
|
|
2544
2730
|
/**
|
|
2545
2731
|
* <p>The estimated number of seconds that remain before the job execution status will be
|
|
2546
|
-
*
|
|
2547
|
-
*
|
|
2548
|
-
*
|
|
2732
|
+
* changed to <code>TIMED_OUT</code>. The timeout interval can be anywhere between 1 minute
|
|
2733
|
+
* and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60
|
|
2734
|
+
* seconds later than the estimated duration. This value will not be included if the job
|
|
2735
|
+
* execution has reached a terminal status.</p>
|
|
2549
2736
|
* @public
|
|
2550
2737
|
*/
|
|
2551
2738
|
approximateSecondsBeforeTimedOut?: number | undefined;
|
|
@@ -2620,10 +2807,10 @@ export interface DescribeJobTemplateResponse {
|
|
|
2620
2807
|
*/
|
|
2621
2808
|
abortConfig?: AbortConfig | undefined;
|
|
2622
2809
|
/**
|
|
2623
|
-
* <p>Specifies the amount of time each device has to finish its execution of the job.
|
|
2624
|
-
*
|
|
2625
|
-
*
|
|
2626
|
-
*
|
|
2810
|
+
* <p>Specifies the amount of time each device has to finish its execution of the job. A
|
|
2811
|
+
* timer is started when the job execution status is set to <code>IN_PROGRESS</code>. If
|
|
2812
|
+
* the job execution status is not set to another terminal state before the timer expires,
|
|
2813
|
+
* it will be automatically set to <code>TIMED_OUT</code>.</p>
|
|
2627
2814
|
* @public
|
|
2628
2815
|
*/
|
|
2629
2816
|
timeoutConfig?: TimeoutConfig | undefined;
|
|
@@ -2634,16 +2821,18 @@ export interface DescribeJobTemplateResponse {
|
|
|
2634
2821
|
*/
|
|
2635
2822
|
jobExecutionsRetryConfig?: JobExecutionsRetryConfig | undefined;
|
|
2636
2823
|
/**
|
|
2637
|
-
* <p>Allows you to configure an optional maintenance window for the rollout of a job
|
|
2824
|
+
* <p>Allows you to configure an optional maintenance window for the rollout of a job
|
|
2825
|
+
* document to all devices in the target group for a job.</p>
|
|
2638
2826
|
* @public
|
|
2639
2827
|
*/
|
|
2640
2828
|
maintenanceWindows?: MaintenanceWindow[] | undefined;
|
|
2641
2829
|
/**
|
|
2642
|
-
* <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the
|
|
2643
|
-
*
|
|
2830
|
+
* <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the job
|
|
2831
|
+
* successfully completes. The package version must be in either the Published or
|
|
2832
|
+
* Deprecated state when the job deploys. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>.</p>
|
|
2644
2833
|
* <p>
|
|
2645
|
-
* <b>Note:</b>The following Length Constraints relates to a
|
|
2646
|
-
* Up to 25
|
|
2834
|
+
* <b>Note:</b>The following Length Constraints relates to a
|
|
2835
|
+
* single ARN. Up to 25 package version ARNs are allowed.</p>
|
|
2647
2836
|
* @public
|
|
2648
2837
|
*/
|
|
2649
2838
|
destinationPackageVersions?: string[] | undefined;
|
|
@@ -2666,8 +2855,8 @@ export interface DescribeManagedJobTemplateRequest {
|
|
|
2666
2855
|
}
|
|
2667
2856
|
/**
|
|
2668
2857
|
* <p>A map of key-value pairs containing the patterns that need to be replaced in a managed
|
|
2669
|
-
* template job document schema. You can use the description of each key as a guidance to
|
|
2670
|
-
* the inputs during runtime when creating a job.</p>
|
|
2858
|
+
* template job document schema. You can use the description of each key as a guidance to
|
|
2859
|
+
* specify the inputs during runtime when creating a job.</p>
|
|
2671
2860
|
* <note>
|
|
2672
2861
|
* <p>
|
|
2673
2862
|
* <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services
|
|
@@ -2696,14 +2885,14 @@ export interface DocumentParameter {
|
|
|
2696
2885
|
*/
|
|
2697
2886
|
regex?: string | undefined;
|
|
2698
2887
|
/**
|
|
2699
|
-
* <p>An example illustrating a pattern that need to be replaced in a managed template
|
|
2700
|
-
*
|
|
2888
|
+
* <p>An example illustrating a pattern that need to be replaced in a managed template job
|
|
2889
|
+
* document schema.</p>
|
|
2701
2890
|
* @public
|
|
2702
2891
|
*/
|
|
2703
2892
|
example?: string | undefined;
|
|
2704
2893
|
/**
|
|
2705
|
-
* <p>Specifies whether a pattern that needs to be replaced in a managed template job
|
|
2706
|
-
* schema is optional or required.</p>
|
|
2894
|
+
* <p>Specifies whether a pattern that needs to be replaced in a managed template job
|
|
2895
|
+
* document schema is optional or required.</p>
|
|
2707
2896
|
* @public
|
|
2708
2897
|
*/
|
|
2709
2898
|
optional?: boolean | undefined;
|
|
@@ -2738,8 +2927,8 @@ export interface DescribeManagedJobTemplateResponse {
|
|
|
2738
2927
|
*/
|
|
2739
2928
|
environments?: string[] | undefined;
|
|
2740
2929
|
/**
|
|
2741
|
-
* <p>A map of key-value pairs that you can use as guidance to specify the inputs for
|
|
2742
|
-
* a job from a managed template.</p>
|
|
2930
|
+
* <p>A map of key-value pairs that you can use as guidance to specify the inputs for
|
|
2931
|
+
* creating a job from a managed template.</p>
|
|
2743
2932
|
* <note>
|
|
2744
2933
|
* <p>
|
|
2745
2934
|
* <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services
|
|
@@ -3910,174 +4099,431 @@ export interface GetCardinalityResponse {
|
|
|
3910
4099
|
/**
|
|
3911
4100
|
* @public
|
|
3912
4101
|
*/
|
|
3913
|
-
export interface
|
|
4102
|
+
export interface GetCommandRequest {
|
|
3914
4103
|
/**
|
|
3915
|
-
* <p>The
|
|
4104
|
+
* <p>The unique identifier of the command for which you want to retrieve
|
|
4105
|
+
* information.</p>
|
|
3916
4106
|
* @public
|
|
3917
4107
|
*/
|
|
3918
|
-
|
|
4108
|
+
commandId: string | undefined;
|
|
4109
|
+
}
|
|
4110
|
+
/**
|
|
4111
|
+
* @public
|
|
4112
|
+
*/
|
|
4113
|
+
export interface GetCommandResponse {
|
|
3919
4114
|
/**
|
|
3920
|
-
* <p>The
|
|
4115
|
+
* <p>The unique identifier of the command.</p>
|
|
3921
4116
|
* @public
|
|
3922
4117
|
*/
|
|
3923
|
-
|
|
4118
|
+
commandId?: string | undefined;
|
|
3924
4119
|
/**
|
|
3925
|
-
* <p>The
|
|
4120
|
+
* <p>The Amazon Resource Number (ARN) of the command. For example,
|
|
4121
|
+
* <code>arn:aws:iot:<region>:<accountid>:command/<commandId></code>
|
|
4122
|
+
* </p>
|
|
3926
4123
|
* @public
|
|
3927
4124
|
*/
|
|
3928
|
-
|
|
3929
|
-
}
|
|
3930
|
-
/**
|
|
3931
|
-
* <p>The policy that has the effect on the authorization results.</p>
|
|
3932
|
-
* @public
|
|
3933
|
-
*/
|
|
3934
|
-
export interface EffectivePolicy {
|
|
4125
|
+
commandArn?: string | undefined;
|
|
3935
4126
|
/**
|
|
3936
|
-
* <p>The
|
|
4127
|
+
* <p>The namespace of the command.</p>
|
|
3937
4128
|
* @public
|
|
3938
4129
|
*/
|
|
3939
|
-
|
|
4130
|
+
namespace?: CommandNamespace | undefined;
|
|
3940
4131
|
/**
|
|
3941
|
-
* <p>The
|
|
4132
|
+
* <p>The user-friendly name in the console for the command.</p>
|
|
3942
4133
|
* @public
|
|
3943
4134
|
*/
|
|
3944
|
-
|
|
4135
|
+
displayName?: string | undefined;
|
|
3945
4136
|
/**
|
|
3946
|
-
* <p>
|
|
4137
|
+
* <p>A short text description of the command.</p>
|
|
3947
4138
|
* @public
|
|
3948
4139
|
*/
|
|
3949
|
-
|
|
3950
|
-
}
|
|
3951
|
-
/**
|
|
3952
|
-
* @public
|
|
3953
|
-
*/
|
|
3954
|
-
export interface GetEffectivePoliciesResponse {
|
|
4140
|
+
description?: string | undefined;
|
|
3955
4141
|
/**
|
|
3956
|
-
* <p>
|
|
4142
|
+
* <p>A list of parameters for the command created.</p>
|
|
3957
4143
|
* @public
|
|
3958
4144
|
*/
|
|
3959
|
-
|
|
3960
|
-
|
|
3961
|
-
|
|
3962
|
-
|
|
3963
|
-
|
|
3964
|
-
|
|
4145
|
+
mandatoryParameters?: CommandParameter[] | undefined;
|
|
4146
|
+
/**
|
|
4147
|
+
* <p>The payload object that you provided for the command.</p>
|
|
4148
|
+
* @public
|
|
4149
|
+
*/
|
|
4150
|
+
payload?: CommandPayload | undefined;
|
|
4151
|
+
/**
|
|
4152
|
+
* <p>The IAM role that allows access to retrieve information about the command.</p>
|
|
4153
|
+
* @public
|
|
4154
|
+
*/
|
|
4155
|
+
roleArn?: string | undefined;
|
|
4156
|
+
/**
|
|
4157
|
+
* <p>The timestamp, when the command was created.</p>
|
|
4158
|
+
* @public
|
|
4159
|
+
*/
|
|
4160
|
+
createdAt?: Date | undefined;
|
|
4161
|
+
/**
|
|
4162
|
+
* <p>The timestamp, when the command was last updated.</p>
|
|
4163
|
+
* @public
|
|
4164
|
+
*/
|
|
4165
|
+
lastUpdatedAt?: Date | undefined;
|
|
4166
|
+
/**
|
|
4167
|
+
* <p>Indicates whether the command has been deprecated.</p>
|
|
4168
|
+
* @public
|
|
4169
|
+
*/
|
|
4170
|
+
deprecated?: boolean | undefined;
|
|
4171
|
+
/**
|
|
4172
|
+
* <p>Indicates whether the command is being deleted.</p>
|
|
4173
|
+
* @public
|
|
4174
|
+
*/
|
|
4175
|
+
pendingDeletion?: boolean | undefined;
|
|
3965
4176
|
}
|
|
3966
4177
|
/**
|
|
3967
|
-
* @public
|
|
3968
|
-
* @enum
|
|
3969
|
-
*/
|
|
3970
|
-
export declare const FieldType: {
|
|
3971
|
-
readonly BOOLEAN: "Boolean";
|
|
3972
|
-
readonly NUMBER: "Number";
|
|
3973
|
-
readonly STRING: "String";
|
|
3974
|
-
};
|
|
3975
|
-
/**
|
|
3976
|
-
* @public
|
|
3977
|
-
*/
|
|
3978
|
-
export type FieldType = (typeof FieldType)[keyof typeof FieldType];
|
|
3979
|
-
/**
|
|
3980
|
-
* <p>Describes the name and data type at a field.</p>
|
|
3981
4178
|
* @public
|
|
3982
4179
|
*/
|
|
3983
|
-
export interface
|
|
4180
|
+
export interface GetCommandExecutionRequest {
|
|
3984
4181
|
/**
|
|
3985
|
-
* <p>The
|
|
4182
|
+
* <p>The unique identifier for the command execution. This information is returned as a
|
|
4183
|
+
* response of the <code>StartCommandExecution</code> API request.</p>
|
|
3986
4184
|
* @public
|
|
3987
4185
|
*/
|
|
3988
|
-
|
|
4186
|
+
executionId: string | undefined;
|
|
3989
4187
|
/**
|
|
3990
|
-
* <p>The
|
|
4188
|
+
* <p>The Amazon Resource Number (ARN) of the device on which the command execution is being
|
|
4189
|
+
* performed.</p>
|
|
3991
4190
|
* @public
|
|
3992
4191
|
*/
|
|
3993
|
-
|
|
4192
|
+
targetArn: string | undefined;
|
|
4193
|
+
/**
|
|
4194
|
+
* <p>Can be used to specify whether to include the result of the command execution
|
|
4195
|
+
* in the <code>GetCommandExecution</code> API response. Your device can use this
|
|
4196
|
+
* field to provide additional information about the command execution. You only
|
|
4197
|
+
* need to specify this field when using the <code>AWS-IoT</code> namespace.</p>
|
|
4198
|
+
* @public
|
|
4199
|
+
*/
|
|
4200
|
+
includeResult?: boolean | undefined;
|
|
3994
4201
|
}
|
|
3995
4202
|
/**
|
|
3996
|
-
*
|
|
3997
|
-
*
|
|
3998
|
-
|
|
3999
|
-
|
|
4000
|
-
|
|
4001
|
-
|
|
4002
|
-
|
|
4003
|
-
/**
|
|
4004
|
-
* @public
|
|
4005
|
-
*/
|
|
4006
|
-
export type ThingGroupIndexingMode = (typeof ThingGroupIndexingMode)[keyof typeof ThingGroupIndexingMode];
|
|
4007
|
-
/**
|
|
4008
|
-
* <p>Thing group indexing configuration.</p>
|
|
4203
|
+
* <p>The result value of the command execution. The device can use the result field to
|
|
4204
|
+
* share additional details about the execution such as a return value of a remote function
|
|
4205
|
+
* call.</p>
|
|
4206
|
+
* <note>
|
|
4207
|
+
* <p>This field is not applicable if you use the <code>AWS-IoT-FleetWise</code>
|
|
4208
|
+
* namespace.</p>
|
|
4209
|
+
* </note>
|
|
4009
4210
|
* @public
|
|
4010
4211
|
*/
|
|
4011
|
-
export interface
|
|
4212
|
+
export interface CommandExecutionResult {
|
|
4012
4213
|
/**
|
|
4013
|
-
* <p>
|
|
4214
|
+
* <p>An attribute of type String. For example:</p>
|
|
4215
|
+
* <p>
|
|
4216
|
+
* <code>"S": "Hello"</code>
|
|
4217
|
+
* </p>
|
|
4014
4218
|
* @public
|
|
4015
4219
|
*/
|
|
4016
|
-
|
|
4220
|
+
S?: string | undefined;
|
|
4017
4221
|
/**
|
|
4018
|
-
* <p>
|
|
4019
|
-
*
|
|
4020
|
-
*
|
|
4021
|
-
*
|
|
4022
|
-
* </note>
|
|
4222
|
+
* <p>An attribute of type Boolean. For example:</p>
|
|
4223
|
+
* <p>
|
|
4224
|
+
* <code>"BOOL": true</code>
|
|
4225
|
+
* </p>
|
|
4023
4226
|
* @public
|
|
4024
4227
|
*/
|
|
4025
|
-
|
|
4228
|
+
B?: boolean | undefined;
|
|
4026
4229
|
/**
|
|
4027
|
-
* <p>
|
|
4028
|
-
* the GetIndexingConfiguration API to get a list of managed fields.</p>
|
|
4029
|
-
* <p>Contains custom field names and their data type.</p>
|
|
4230
|
+
* <p>An attribute of type Binary.</p>
|
|
4030
4231
|
* @public
|
|
4031
4232
|
*/
|
|
4032
|
-
|
|
4233
|
+
BIN?: Uint8Array | undefined;
|
|
4033
4234
|
}
|
|
4034
4235
|
/**
|
|
4035
4236
|
* @public
|
|
4036
4237
|
* @enum
|
|
4037
4238
|
*/
|
|
4038
|
-
export declare const
|
|
4039
|
-
readonly
|
|
4040
|
-
readonly
|
|
4041
|
-
|
|
4042
|
-
|
|
4043
|
-
|
|
4044
|
-
|
|
4045
|
-
export type DeviceDefenderIndexingMode = (typeof DeviceDefenderIndexingMode)[keyof typeof DeviceDefenderIndexingMode];
|
|
4046
|
-
/**
|
|
4047
|
-
* @public
|
|
4048
|
-
* @enum
|
|
4049
|
-
*/
|
|
4050
|
-
export declare const TargetFieldOrder: {
|
|
4051
|
-
readonly LatLon: "LatLon";
|
|
4052
|
-
readonly LonLat: "LonLat";
|
|
4239
|
+
export declare const CommandExecutionStatus: {
|
|
4240
|
+
readonly CREATED: "CREATED";
|
|
4241
|
+
readonly FAILED: "FAILED";
|
|
4242
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
4243
|
+
readonly REJECTED: "REJECTED";
|
|
4244
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
4245
|
+
readonly TIMED_OUT: "TIMED_OUT";
|
|
4053
4246
|
};
|
|
4054
4247
|
/**
|
|
4055
4248
|
* @public
|
|
4056
4249
|
*/
|
|
4057
|
-
export type
|
|
4250
|
+
export type CommandExecutionStatus = (typeof CommandExecutionStatus)[keyof typeof CommandExecutionStatus];
|
|
4058
4251
|
/**
|
|
4059
|
-
* <p>
|
|
4060
|
-
*
|
|
4061
|
-
* target fields.</p>
|
|
4252
|
+
* <p>Provide additional context about the status of a command execution using a reason code
|
|
4253
|
+
* and description.</p>
|
|
4062
4254
|
* @public
|
|
4063
4255
|
*/
|
|
4064
|
-
export interface
|
|
4256
|
+
export interface StatusReason {
|
|
4065
4257
|
/**
|
|
4066
|
-
* <p>
|
|
4067
|
-
* named shadow, you must select the named shadow using the <code>namedShadow</code> filter.</p>
|
|
4258
|
+
* <p>A code that provides additional context for the command execution status.</p>
|
|
4068
4259
|
* @public
|
|
4069
4260
|
*/
|
|
4070
|
-
|
|
4261
|
+
reasonCode: string | undefined;
|
|
4071
4262
|
/**
|
|
4072
|
-
* <p>
|
|
4073
|
-
*
|
|
4263
|
+
* <p>A literal string for devices to optionally provide additional information about the
|
|
4264
|
+
* reason code for a command execution status.</p>
|
|
4074
4265
|
* @public
|
|
4075
4266
|
*/
|
|
4076
|
-
|
|
4267
|
+
reasonDescription?: string | undefined;
|
|
4077
4268
|
}
|
|
4078
4269
|
/**
|
|
4079
|
-
*
|
|
4080
|
-
|
|
4270
|
+
* @public
|
|
4271
|
+
*/
|
|
4272
|
+
export interface GetCommandExecutionResponse {
|
|
4273
|
+
/**
|
|
4274
|
+
* <p>The unique identifier of the command execution.</p>
|
|
4275
|
+
* @public
|
|
4276
|
+
*/
|
|
4277
|
+
executionId?: string | undefined;
|
|
4278
|
+
/**
|
|
4279
|
+
* <p>The Amazon Resource Number (ARN) of the command. For example,
|
|
4280
|
+
* <code></code>arn:aws:iot:<region>:<accountid>:command/<commandId></p>
|
|
4281
|
+
* @public
|
|
4282
|
+
*/
|
|
4283
|
+
commandArn?: string | undefined;
|
|
4284
|
+
/**
|
|
4285
|
+
* <p>The Amazon Resource Number (ARN) of the device on which the command execution is being
|
|
4286
|
+
* performed.</p>
|
|
4287
|
+
* @public
|
|
4288
|
+
*/
|
|
4289
|
+
targetArn?: string | undefined;
|
|
4290
|
+
/**
|
|
4291
|
+
* <p>The status of the command execution. After your devices receive the command and start
|
|
4292
|
+
* performing the operations specified in the command, it can use the
|
|
4293
|
+
* <code>UpdateCommandExecution</code> MQTT API to update the status
|
|
4294
|
+
* information.</p>
|
|
4295
|
+
* @public
|
|
4296
|
+
*/
|
|
4297
|
+
status?: CommandExecutionStatus | undefined;
|
|
4298
|
+
/**
|
|
4299
|
+
* <p>Your devices can use this parameter to provide additional context about the status of
|
|
4300
|
+
* a command execution using a reason code and description.</p>
|
|
4301
|
+
* @public
|
|
4302
|
+
*/
|
|
4303
|
+
statusReason?: StatusReason | undefined;
|
|
4304
|
+
/**
|
|
4305
|
+
* <p>The result value for the current state of the command execution. The status provides
|
|
4306
|
+
* information about the progress of the command execution. The device can use the result
|
|
4307
|
+
* field to share additional details about the execution such as a return value of a remote
|
|
4308
|
+
* function call.</p>
|
|
4309
|
+
* <note>
|
|
4310
|
+
* <p>If you use the <code>AWS-IoT-FleetWise</code> namespace, then this field is not
|
|
4311
|
+
* applicable in the API response.</p>
|
|
4312
|
+
* </note>
|
|
4313
|
+
* @public
|
|
4314
|
+
*/
|
|
4315
|
+
result?: Record<string, CommandExecutionResult> | undefined;
|
|
4316
|
+
/**
|
|
4317
|
+
* <p>The list of parameters that the <code>StartCommandExecution</code> API used when
|
|
4318
|
+
* performing the command on the device.</p>
|
|
4319
|
+
* @public
|
|
4320
|
+
*/
|
|
4321
|
+
parameters?: Record<string, CommandParameterValue> | undefined;
|
|
4322
|
+
/**
|
|
4323
|
+
* <p>Specifies the amount of time in seconds that the device can take to finish a command
|
|
4324
|
+
* execution. A timer starts when the command execution is created. If the command
|
|
4325
|
+
* execution status is not set to another terminal state before the timer expires, it will
|
|
4326
|
+
* automatically update to <code>TIMED_OUT</code>.</p>
|
|
4327
|
+
* @public
|
|
4328
|
+
*/
|
|
4329
|
+
executionTimeoutSeconds?: number | undefined;
|
|
4330
|
+
/**
|
|
4331
|
+
* <p>The timestamp, when the command execution was created.</p>
|
|
4332
|
+
* @public
|
|
4333
|
+
*/
|
|
4334
|
+
createdAt?: Date | undefined;
|
|
4335
|
+
/**
|
|
4336
|
+
* <p>The timestamp, when the command execution was last updated.</p>
|
|
4337
|
+
* @public
|
|
4338
|
+
*/
|
|
4339
|
+
lastUpdatedAt?: Date | undefined;
|
|
4340
|
+
/**
|
|
4341
|
+
* <p>The timestamp, when the command execution was started.</p>
|
|
4342
|
+
* @public
|
|
4343
|
+
*/
|
|
4344
|
+
startedAt?: Date | undefined;
|
|
4345
|
+
/**
|
|
4346
|
+
* <p>The timestamp, when the command execution was completed.</p>
|
|
4347
|
+
* @public
|
|
4348
|
+
*/
|
|
4349
|
+
completedAt?: Date | undefined;
|
|
4350
|
+
/**
|
|
4351
|
+
* <p>The time to live (TTL) parameter for the <code>GetCommandExecution</code> API.</p>
|
|
4352
|
+
* @public
|
|
4353
|
+
*/
|
|
4354
|
+
timeToLive?: Date | undefined;
|
|
4355
|
+
}
|
|
4356
|
+
/**
|
|
4357
|
+
* @public
|
|
4358
|
+
*/
|
|
4359
|
+
export interface GetEffectivePoliciesRequest {
|
|
4360
|
+
/**
|
|
4361
|
+
* <p>The principal. Valid principals are CertificateArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:cert/<i>certificateId</i>), thingGroupArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:thinggroup/<i>groupName</i>) and CognitoId (<i>region</i>:<i>id</i>).</p>
|
|
4362
|
+
* @public
|
|
4363
|
+
*/
|
|
4364
|
+
principal?: string | undefined;
|
|
4365
|
+
/**
|
|
4366
|
+
* <p>The Cognito identity pool ID.</p>
|
|
4367
|
+
* @public
|
|
4368
|
+
*/
|
|
4369
|
+
cognitoIdentityPoolId?: string | undefined;
|
|
4370
|
+
/**
|
|
4371
|
+
* <p>The thing name.</p>
|
|
4372
|
+
* @public
|
|
4373
|
+
*/
|
|
4374
|
+
thingName?: string | undefined;
|
|
4375
|
+
}
|
|
4376
|
+
/**
|
|
4377
|
+
* <p>The policy that has the effect on the authorization results.</p>
|
|
4378
|
+
* @public
|
|
4379
|
+
*/
|
|
4380
|
+
export interface EffectivePolicy {
|
|
4381
|
+
/**
|
|
4382
|
+
* <p>The policy name.</p>
|
|
4383
|
+
* @public
|
|
4384
|
+
*/
|
|
4385
|
+
policyName?: string | undefined;
|
|
4386
|
+
/**
|
|
4387
|
+
* <p>The policy ARN.</p>
|
|
4388
|
+
* @public
|
|
4389
|
+
*/
|
|
4390
|
+
policyArn?: string | undefined;
|
|
4391
|
+
/**
|
|
4392
|
+
* <p>The IAM policy document.</p>
|
|
4393
|
+
* @public
|
|
4394
|
+
*/
|
|
4395
|
+
policyDocument?: string | undefined;
|
|
4396
|
+
}
|
|
4397
|
+
/**
|
|
4398
|
+
* @public
|
|
4399
|
+
*/
|
|
4400
|
+
export interface GetEffectivePoliciesResponse {
|
|
4401
|
+
/**
|
|
4402
|
+
* <p>The effective policies.</p>
|
|
4403
|
+
* @public
|
|
4404
|
+
*/
|
|
4405
|
+
effectivePolicies?: EffectivePolicy[] | undefined;
|
|
4406
|
+
}
|
|
4407
|
+
/**
|
|
4408
|
+
* @public
|
|
4409
|
+
*/
|
|
4410
|
+
export interface GetIndexingConfigurationRequest {
|
|
4411
|
+
}
|
|
4412
|
+
/**
|
|
4413
|
+
* @public
|
|
4414
|
+
* @enum
|
|
4415
|
+
*/
|
|
4416
|
+
export declare const FieldType: {
|
|
4417
|
+
readonly BOOLEAN: "Boolean";
|
|
4418
|
+
readonly NUMBER: "Number";
|
|
4419
|
+
readonly STRING: "String";
|
|
4420
|
+
};
|
|
4421
|
+
/**
|
|
4422
|
+
* @public
|
|
4423
|
+
*/
|
|
4424
|
+
export type FieldType = (typeof FieldType)[keyof typeof FieldType];
|
|
4425
|
+
/**
|
|
4426
|
+
* <p>Describes the name and data type at a field.</p>
|
|
4427
|
+
* @public
|
|
4428
|
+
*/
|
|
4429
|
+
export interface Field {
|
|
4430
|
+
/**
|
|
4431
|
+
* <p>The name of the field.</p>
|
|
4432
|
+
* @public
|
|
4433
|
+
*/
|
|
4434
|
+
name?: string | undefined;
|
|
4435
|
+
/**
|
|
4436
|
+
* <p>The data type of the field.</p>
|
|
4437
|
+
* @public
|
|
4438
|
+
*/
|
|
4439
|
+
type?: FieldType | undefined;
|
|
4440
|
+
}
|
|
4441
|
+
/**
|
|
4442
|
+
* @public
|
|
4443
|
+
* @enum
|
|
4444
|
+
*/
|
|
4445
|
+
export declare const ThingGroupIndexingMode: {
|
|
4446
|
+
readonly OFF: "OFF";
|
|
4447
|
+
readonly ON: "ON";
|
|
4448
|
+
};
|
|
4449
|
+
/**
|
|
4450
|
+
* @public
|
|
4451
|
+
*/
|
|
4452
|
+
export type ThingGroupIndexingMode = (typeof ThingGroupIndexingMode)[keyof typeof ThingGroupIndexingMode];
|
|
4453
|
+
/**
|
|
4454
|
+
* <p>Thing group indexing configuration.</p>
|
|
4455
|
+
* @public
|
|
4456
|
+
*/
|
|
4457
|
+
export interface ThingGroupIndexingConfiguration {
|
|
4458
|
+
/**
|
|
4459
|
+
* <p>Thing group indexing mode.</p>
|
|
4460
|
+
* @public
|
|
4461
|
+
*/
|
|
4462
|
+
thingGroupIndexingMode: ThingGroupIndexingMode | undefined;
|
|
4463
|
+
/**
|
|
4464
|
+
* <p>Contains fields that are indexed and whose types are already known by the Fleet Indexing
|
|
4465
|
+
* service. This is an optional field. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field">Managed fields</a> in the <i>Amazon Web Services IoT Core Developer Guide</i>.</p>
|
|
4466
|
+
* <note>
|
|
4467
|
+
* <p>You can't modify managed fields by updating fleet indexing configuration.</p>
|
|
4468
|
+
* </note>
|
|
4469
|
+
* @public
|
|
4470
|
+
*/
|
|
4471
|
+
managedFields?: Field[] | undefined;
|
|
4472
|
+
/**
|
|
4473
|
+
* <p>A list of thing group fields to index. This list cannot contain any managed fields. Use
|
|
4474
|
+
* the GetIndexingConfiguration API to get a list of managed fields.</p>
|
|
4475
|
+
* <p>Contains custom field names and their data type.</p>
|
|
4476
|
+
* @public
|
|
4477
|
+
*/
|
|
4478
|
+
customFields?: Field[] | undefined;
|
|
4479
|
+
}
|
|
4480
|
+
/**
|
|
4481
|
+
* @public
|
|
4482
|
+
* @enum
|
|
4483
|
+
*/
|
|
4484
|
+
export declare const DeviceDefenderIndexingMode: {
|
|
4485
|
+
readonly OFF: "OFF";
|
|
4486
|
+
readonly VIOLATIONS: "VIOLATIONS";
|
|
4487
|
+
};
|
|
4488
|
+
/**
|
|
4489
|
+
* @public
|
|
4490
|
+
*/
|
|
4491
|
+
export type DeviceDefenderIndexingMode = (typeof DeviceDefenderIndexingMode)[keyof typeof DeviceDefenderIndexingMode];
|
|
4492
|
+
/**
|
|
4493
|
+
* @public
|
|
4494
|
+
* @enum
|
|
4495
|
+
*/
|
|
4496
|
+
export declare const TargetFieldOrder: {
|
|
4497
|
+
readonly LatLon: "LatLon";
|
|
4498
|
+
readonly LonLat: "LonLat";
|
|
4499
|
+
};
|
|
4500
|
+
/**
|
|
4501
|
+
* @public
|
|
4502
|
+
*/
|
|
4503
|
+
export type TargetFieldOrder = (typeof TargetFieldOrder)[keyof typeof TargetFieldOrder];
|
|
4504
|
+
/**
|
|
4505
|
+
* <p>A geolocation target that you select to index. Each geolocation target contains a
|
|
4506
|
+
* <code>name</code> and <code>order</code> key-value pair that specifies the geolocation
|
|
4507
|
+
* target fields.</p>
|
|
4508
|
+
* @public
|
|
4509
|
+
*/
|
|
4510
|
+
export interface GeoLocationTarget {
|
|
4511
|
+
/**
|
|
4512
|
+
* <p>The <code>name</code> of the geolocation target field. If the target field is part of a
|
|
4513
|
+
* named shadow, you must select the named shadow using the <code>namedShadow</code> filter.</p>
|
|
4514
|
+
* @public
|
|
4515
|
+
*/
|
|
4516
|
+
name?: string | undefined;
|
|
4517
|
+
/**
|
|
4518
|
+
* <p>The <code>order</code> of the geolocation target field. This field is optional. The
|
|
4519
|
+
* default value is <code>LatLon</code>.</p>
|
|
4520
|
+
* @public
|
|
4521
|
+
*/
|
|
4522
|
+
order?: TargetFieldOrder | undefined;
|
|
4523
|
+
}
|
|
4524
|
+
/**
|
|
4525
|
+
* <p>Provides additional selections for named shadows and geolocation data. </p>
|
|
4526
|
+
* <p>To add named shadows to your fleet indexing configuration, set <code>namedShadowIndexingMode</code> to
|
|
4081
4527
|
* be ON and specify your shadow names in <code>namedShadowNames</code> filter.</p>
|
|
4082
4528
|
* <p>To add geolocation data to your fleet indexing configuration: </p>
|
|
4083
4529
|
* <ul>
|
|
@@ -4282,7 +4728,7 @@ export interface GetJobDocumentRequest {
|
|
|
4282
4728
|
*/
|
|
4283
4729
|
jobId: string | undefined;
|
|
4284
4730
|
/**
|
|
4285
|
-
* <p>
|
|
4731
|
+
* <p>Provides a view of the job document before and after the substitution parameters have been resolved with their exact values.</p>
|
|
4286
4732
|
* @public
|
|
4287
4733
|
*/
|
|
4288
4734
|
beforeSubstitution?: boolean | undefined;
|
|
@@ -5730,524 +6176,153 @@ export interface ListCertificatesByCAResponse {
|
|
|
5730
6176
|
nextMarker?: string | undefined;
|
|
5731
6177
|
}
|
|
5732
6178
|
/**
|
|
6179
|
+
* <p>A filter that can be used to list command executions for a device that started or
|
|
6180
|
+
* completed before or after a particular date and time.</p>
|
|
5733
6181
|
* @public
|
|
5734
6182
|
*/
|
|
5735
|
-
export interface
|
|
6183
|
+
export interface TimeFilter {
|
|
5736
6184
|
/**
|
|
5737
|
-
* <p>
|
|
5738
|
-
*
|
|
5739
|
-
* </p>
|
|
6185
|
+
* <p>Filter to display command executions that started or completed only after a particular
|
|
6186
|
+
* date and time.</p>
|
|
5740
6187
|
* @public
|
|
5741
6188
|
*/
|
|
5742
|
-
|
|
6189
|
+
after?: string | undefined;
|
|
5743
6190
|
/**
|
|
5744
|
-
* <p>
|
|
5745
|
-
*
|
|
5746
|
-
* </p>
|
|
6191
|
+
* <p>Filter to display command executions that started or completed only before a
|
|
6192
|
+
* particular date and time.</p>
|
|
5747
6193
|
* @public
|
|
5748
6194
|
*/
|
|
5749
|
-
|
|
6195
|
+
before?: string | undefined;
|
|
5750
6196
|
}
|
|
5751
6197
|
/**
|
|
5752
6198
|
* @public
|
|
6199
|
+
* @enum
|
|
5753
6200
|
*/
|
|
5754
|
-
export
|
|
6201
|
+
export declare const SortOrder: {
|
|
6202
|
+
readonly Ascending: "ASCENDING";
|
|
6203
|
+
readonly Descending: "DESCENDING";
|
|
6204
|
+
};
|
|
6205
|
+
/**
|
|
6206
|
+
* @public
|
|
6207
|
+
*/
|
|
6208
|
+
export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
6209
|
+
/**
|
|
6210
|
+
* @public
|
|
6211
|
+
*/
|
|
6212
|
+
export interface ListCommandExecutionsRequest {
|
|
5755
6213
|
/**
|
|
5756
|
-
* <p>
|
|
5757
|
-
* The name of the custom metric.
|
|
5758
|
-
* </p>
|
|
6214
|
+
* <p>The maximum number of results to return in this operation.</p>
|
|
5759
6215
|
* @public
|
|
5760
6216
|
*/
|
|
5761
|
-
|
|
6217
|
+
maxResults?: number | undefined;
|
|
5762
6218
|
/**
|
|
5763
|
-
* <p>
|
|
5764
|
-
*
|
|
5765
|
-
* or <code>null</code> if there are no additional results.
|
|
5766
|
-
* </p>
|
|
6219
|
+
* <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
|
|
6220
|
+
* response; otherwise <code>null</code> to receive the first set of results.</p>
|
|
5767
6221
|
* @public
|
|
5768
6222
|
*/
|
|
5769
6223
|
nextToken?: string | undefined;
|
|
5770
|
-
}
|
|
5771
|
-
/**
|
|
5772
|
-
* @public
|
|
5773
|
-
*/
|
|
5774
|
-
export interface ListDetectMitigationActionsExecutionsRequest {
|
|
5775
6224
|
/**
|
|
5776
|
-
* <p>
|
|
5777
|
-
* The unique identifier of the task.
|
|
5778
|
-
* </p>
|
|
6225
|
+
* <p>The namespace of the command.</p>
|
|
5779
6226
|
* @public
|
|
5780
6227
|
*/
|
|
5781
|
-
|
|
5782
|
-
/**
|
|
5783
|
-
* <p>
|
|
5784
|
-
* The unique identifier of the violation.
|
|
5785
|
-
* </p>
|
|
5786
|
-
* @public
|
|
5787
|
-
*/
|
|
5788
|
-
violationId?: string | undefined;
|
|
5789
|
-
/**
|
|
5790
|
-
* <p>
|
|
5791
|
-
* The name of the thing whose mitigation actions are listed.
|
|
5792
|
-
* </p>
|
|
5793
|
-
* @public
|
|
5794
|
-
*/
|
|
5795
|
-
thingName?: string | undefined;
|
|
5796
|
-
/**
|
|
5797
|
-
* <p>
|
|
5798
|
-
* A filter to limit results to those found after the specified time. You must
|
|
5799
|
-
* specify either the startTime and endTime or the taskId, but not both.
|
|
5800
|
-
* </p>
|
|
5801
|
-
* @public
|
|
5802
|
-
*/
|
|
5803
|
-
startTime?: Date | undefined;
|
|
5804
|
-
/**
|
|
5805
|
-
* <p>
|
|
5806
|
-
* The end of the time period for which ML Detect mitigation actions executions are returned.
|
|
5807
|
-
* </p>
|
|
5808
|
-
* @public
|
|
5809
|
-
*/
|
|
5810
|
-
endTime?: Date | undefined;
|
|
5811
|
-
/**
|
|
5812
|
-
* <p>
|
|
5813
|
-
* The maximum number of results to return at one time. The default is 25.
|
|
5814
|
-
* </p>
|
|
5815
|
-
* @public
|
|
5816
|
-
*/
|
|
5817
|
-
maxResults?: number | undefined;
|
|
5818
|
-
/**
|
|
5819
|
-
* <p>
|
|
5820
|
-
* The token for the next set of results.
|
|
5821
|
-
* </p>
|
|
5822
|
-
* @public
|
|
5823
|
-
*/
|
|
5824
|
-
nextToken?: string | undefined;
|
|
5825
|
-
}
|
|
5826
|
-
/**
|
|
5827
|
-
* @public
|
|
5828
|
-
* @enum
|
|
5829
|
-
*/
|
|
5830
|
-
export declare const DetectMitigationActionExecutionStatus: {
|
|
5831
|
-
readonly FAILED: "FAILED";
|
|
5832
|
-
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
5833
|
-
readonly SKIPPED: "SKIPPED";
|
|
5834
|
-
readonly SUCCESSFUL: "SUCCESSFUL";
|
|
5835
|
-
};
|
|
5836
|
-
/**
|
|
5837
|
-
* @public
|
|
5838
|
-
*/
|
|
5839
|
-
export type DetectMitigationActionExecutionStatus = (typeof DetectMitigationActionExecutionStatus)[keyof typeof DetectMitigationActionExecutionStatus];
|
|
5840
|
-
/**
|
|
5841
|
-
* <p>
|
|
5842
|
-
* Describes which mitigation actions should be executed.
|
|
5843
|
-
* </p>
|
|
5844
|
-
* @public
|
|
5845
|
-
*/
|
|
5846
|
-
export interface DetectMitigationActionExecution {
|
|
5847
|
-
/**
|
|
5848
|
-
* <p>
|
|
5849
|
-
* The unique identifier of the task.
|
|
5850
|
-
* </p>
|
|
5851
|
-
* @public
|
|
5852
|
-
*/
|
|
5853
|
-
taskId?: string | undefined;
|
|
5854
|
-
/**
|
|
5855
|
-
* <p>
|
|
5856
|
-
* The unique identifier of the violation.
|
|
5857
|
-
* </p>
|
|
5858
|
-
* @public
|
|
5859
|
-
*/
|
|
5860
|
-
violationId?: string | undefined;
|
|
5861
|
-
/**
|
|
5862
|
-
* <p>
|
|
5863
|
-
* The friendly name that uniquely identifies the mitigation action.
|
|
5864
|
-
* </p>
|
|
5865
|
-
* @public
|
|
5866
|
-
*/
|
|
5867
|
-
actionName?: string | undefined;
|
|
5868
|
-
/**
|
|
5869
|
-
* <p>
|
|
5870
|
-
* The name of the thing.
|
|
5871
|
-
* </p>
|
|
5872
|
-
* @public
|
|
5873
|
-
*/
|
|
5874
|
-
thingName?: string | undefined;
|
|
5875
|
-
/**
|
|
5876
|
-
* <p>
|
|
5877
|
-
* The date a mitigation action was started.
|
|
5878
|
-
* </p>
|
|
5879
|
-
* @public
|
|
5880
|
-
*/
|
|
5881
|
-
executionStartDate?: Date | undefined;
|
|
5882
|
-
/**
|
|
5883
|
-
* <p>
|
|
5884
|
-
* The date a mitigation action ended.
|
|
5885
|
-
* </p>
|
|
5886
|
-
* @public
|
|
5887
|
-
*/
|
|
5888
|
-
executionEndDate?: Date | undefined;
|
|
5889
|
-
/**
|
|
5890
|
-
* <p>
|
|
5891
|
-
* The status of a mitigation action.
|
|
5892
|
-
* </p>
|
|
5893
|
-
* @public
|
|
5894
|
-
*/
|
|
5895
|
-
status?: DetectMitigationActionExecutionStatus | undefined;
|
|
5896
|
-
/**
|
|
5897
|
-
* <p>
|
|
5898
|
-
* The error code of a mitigation action.
|
|
5899
|
-
* </p>
|
|
5900
|
-
* @public
|
|
5901
|
-
*/
|
|
5902
|
-
errorCode?: string | undefined;
|
|
5903
|
-
/**
|
|
5904
|
-
* <p>
|
|
5905
|
-
* The message of a mitigation action.
|
|
5906
|
-
* </p>
|
|
5907
|
-
* @public
|
|
5908
|
-
*/
|
|
5909
|
-
message?: string | undefined;
|
|
5910
|
-
}
|
|
5911
|
-
/**
|
|
5912
|
-
* @public
|
|
5913
|
-
*/
|
|
5914
|
-
export interface ListDetectMitigationActionsExecutionsResponse {
|
|
5915
|
-
/**
|
|
5916
|
-
* <p>
|
|
5917
|
-
* List of actions executions.
|
|
5918
|
-
* </p>
|
|
5919
|
-
* @public
|
|
5920
|
-
*/
|
|
5921
|
-
actionsExecutions?: DetectMitigationActionExecution[] | undefined;
|
|
5922
|
-
/**
|
|
5923
|
-
* <p>
|
|
5924
|
-
* A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
|
|
5925
|
-
* </p>
|
|
5926
|
-
* @public
|
|
5927
|
-
*/
|
|
5928
|
-
nextToken?: string | undefined;
|
|
5929
|
-
}
|
|
5930
|
-
/**
|
|
5931
|
-
* @public
|
|
5932
|
-
*/
|
|
5933
|
-
export interface ListDetectMitigationActionsTasksRequest {
|
|
5934
|
-
/**
|
|
5935
|
-
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
5936
|
-
* @public
|
|
5937
|
-
*/
|
|
5938
|
-
maxResults?: number | undefined;
|
|
5939
|
-
/**
|
|
5940
|
-
* <p>
|
|
5941
|
-
* The token for the next set of results.
|
|
5942
|
-
* </p>
|
|
5943
|
-
* @public
|
|
5944
|
-
*/
|
|
5945
|
-
nextToken?: string | undefined;
|
|
5946
|
-
/**
|
|
5947
|
-
* <p>
|
|
5948
|
-
* A filter to limit results to those found after the specified time. You must
|
|
5949
|
-
* specify either the startTime and endTime or the taskId, but not both.
|
|
5950
|
-
* </p>
|
|
5951
|
-
* @public
|
|
5952
|
-
*/
|
|
5953
|
-
startTime: Date | undefined;
|
|
5954
|
-
/**
|
|
5955
|
-
* <p>
|
|
5956
|
-
* The end of the time period for which ML Detect mitigation actions tasks are returned.
|
|
5957
|
-
* </p>
|
|
5958
|
-
* @public
|
|
5959
|
-
*/
|
|
5960
|
-
endTime: Date | undefined;
|
|
5961
|
-
}
|
|
5962
|
-
/**
|
|
5963
|
-
* @public
|
|
5964
|
-
*/
|
|
5965
|
-
export interface ListDetectMitigationActionsTasksResponse {
|
|
5966
|
-
/**
|
|
5967
|
-
* <p>
|
|
5968
|
-
* The collection of ML Detect mitigation tasks that matched the filter criteria.
|
|
5969
|
-
* </p>
|
|
5970
|
-
* @public
|
|
5971
|
-
*/
|
|
5972
|
-
tasks?: DetectMitigationActionsTaskSummary[] | undefined;
|
|
5973
|
-
/**
|
|
5974
|
-
* <p>
|
|
5975
|
-
* A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
|
|
5976
|
-
* </p>
|
|
5977
|
-
* @public
|
|
5978
|
-
*/
|
|
5979
|
-
nextToken?: string | undefined;
|
|
5980
|
-
}
|
|
5981
|
-
/**
|
|
5982
|
-
* @public
|
|
5983
|
-
*/
|
|
5984
|
-
export interface ListDimensionsRequest {
|
|
5985
|
-
/**
|
|
5986
|
-
* <p>The token for the next set of results.</p>
|
|
5987
|
-
* @public
|
|
5988
|
-
*/
|
|
5989
|
-
nextToken?: string | undefined;
|
|
5990
|
-
/**
|
|
5991
|
-
* <p>The maximum number of results to retrieve at one time.</p>
|
|
5992
|
-
* @public
|
|
5993
|
-
*/
|
|
5994
|
-
maxResults?: number | undefined;
|
|
5995
|
-
}
|
|
5996
|
-
/**
|
|
5997
|
-
* @public
|
|
5998
|
-
*/
|
|
5999
|
-
export interface ListDimensionsResponse {
|
|
6000
|
-
/**
|
|
6001
|
-
* <p>A list of the names of the defined dimensions. Use <code>DescribeDimension</code> to get details for a dimension.</p>
|
|
6002
|
-
* @public
|
|
6003
|
-
*/
|
|
6004
|
-
dimensionNames?: string[] | undefined;
|
|
6005
|
-
/**
|
|
6006
|
-
* <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>
|
|
6007
|
-
* @public
|
|
6008
|
-
*/
|
|
6009
|
-
nextToken?: string | undefined;
|
|
6010
|
-
}
|
|
6011
|
-
/**
|
|
6012
|
-
* @public
|
|
6013
|
-
*/
|
|
6014
|
-
export interface ListDomainConfigurationsRequest {
|
|
6015
|
-
/**
|
|
6016
|
-
* <p>The marker for the next set of results.</p>
|
|
6017
|
-
* @public
|
|
6018
|
-
*/
|
|
6019
|
-
marker?: string | undefined;
|
|
6020
|
-
/**
|
|
6021
|
-
* <p>The result page size.</p>
|
|
6022
|
-
* @public
|
|
6023
|
-
*/
|
|
6024
|
-
pageSize?: number | undefined;
|
|
6025
|
-
/**
|
|
6026
|
-
* <p>The type of service delivered by the endpoint.</p>
|
|
6027
|
-
* @public
|
|
6028
|
-
*/
|
|
6029
|
-
serviceType?: ServiceType | undefined;
|
|
6030
|
-
}
|
|
6031
|
-
/**
|
|
6032
|
-
* <p>The summary of a domain configuration. A domain configuration specifies custom IoT-specific information about a domain.
|
|
6033
|
-
* A domain configuration can be associated with an Amazon Web Services-managed domain
|
|
6034
|
-
* (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a default endpoint.</p>
|
|
6035
|
-
* <ul>
|
|
6036
|
-
* <li>
|
|
6037
|
-
* <p>Data</p>
|
|
6038
|
-
* </li>
|
|
6039
|
-
* <li>
|
|
6040
|
-
* <p>Jobs</p>
|
|
6041
|
-
* </li>
|
|
6042
|
-
* <li>
|
|
6043
|
-
* <p>CredentialProvider</p>
|
|
6044
|
-
* </li>
|
|
6045
|
-
* </ul>
|
|
6046
|
-
* @public
|
|
6047
|
-
*/
|
|
6048
|
-
export interface DomainConfigurationSummary {
|
|
6049
|
-
/**
|
|
6050
|
-
* <p>The name of the domain configuration. This value must be unique to a region.</p>
|
|
6051
|
-
* @public
|
|
6052
|
-
*/
|
|
6053
|
-
domainConfigurationName?: string | undefined;
|
|
6054
|
-
/**
|
|
6055
|
-
* <p>The ARN of the domain configuration.</p>
|
|
6056
|
-
* @public
|
|
6057
|
-
*/
|
|
6058
|
-
domainConfigurationArn?: string | undefined;
|
|
6059
|
-
/**
|
|
6060
|
-
* <p>The type of service delivered by the endpoint.</p>
|
|
6061
|
-
* @public
|
|
6062
|
-
*/
|
|
6063
|
-
serviceType?: ServiceType | undefined;
|
|
6064
|
-
}
|
|
6065
|
-
/**
|
|
6066
|
-
* @public
|
|
6067
|
-
*/
|
|
6068
|
-
export interface ListDomainConfigurationsResponse {
|
|
6069
|
-
/**
|
|
6070
|
-
* <p>A list of objects that contain summary information about the user's domain configurations.</p>
|
|
6071
|
-
* @public
|
|
6072
|
-
*/
|
|
6073
|
-
domainConfigurations?: DomainConfigurationSummary[] | undefined;
|
|
6074
|
-
/**
|
|
6075
|
-
* <p>The marker for the next set of results.</p>
|
|
6076
|
-
* @public
|
|
6077
|
-
*/
|
|
6078
|
-
nextMarker?: string | undefined;
|
|
6079
|
-
}
|
|
6080
|
-
/**
|
|
6081
|
-
* @public
|
|
6082
|
-
*/
|
|
6083
|
-
export interface ListFleetMetricsRequest {
|
|
6084
|
-
/**
|
|
6085
|
-
* <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response;
|
|
6086
|
-
* otherwise <code>null</code> to receive the first set of results.</p>
|
|
6087
|
-
* @public
|
|
6088
|
-
*/
|
|
6089
|
-
nextToken?: string | undefined;
|
|
6090
|
-
/**
|
|
6091
|
-
* <p>The maximum number of results to return in this operation.</p>
|
|
6092
|
-
* @public
|
|
6093
|
-
*/
|
|
6094
|
-
maxResults?: number | undefined;
|
|
6095
|
-
}
|
|
6096
|
-
/**
|
|
6097
|
-
* <p>The name and ARN of a fleet metric.</p>
|
|
6098
|
-
* @public
|
|
6099
|
-
*/
|
|
6100
|
-
export interface FleetMetricNameAndArn {
|
|
6101
|
-
/**
|
|
6102
|
-
* <p>The fleet metric name.</p>
|
|
6103
|
-
* @public
|
|
6104
|
-
*/
|
|
6105
|
-
metricName?: string | undefined;
|
|
6106
|
-
/**
|
|
6107
|
-
* <p>The fleet metric ARN.</p>
|
|
6108
|
-
* @public
|
|
6109
|
-
*/
|
|
6110
|
-
metricArn?: string | undefined;
|
|
6111
|
-
}
|
|
6112
|
-
/**
|
|
6113
|
-
* @public
|
|
6114
|
-
*/
|
|
6115
|
-
export interface ListFleetMetricsResponse {
|
|
6116
|
-
/**
|
|
6117
|
-
* <p>The list of fleet metrics objects.</p>
|
|
6118
|
-
* @public
|
|
6119
|
-
*/
|
|
6120
|
-
fleetMetrics?: FleetMetricNameAndArn[] | undefined;
|
|
6121
|
-
/**
|
|
6122
|
-
* <p>The token for the next set of results. Will not be returned if the operation has returned
|
|
6123
|
-
* all results.</p>
|
|
6124
|
-
* @public
|
|
6125
|
-
*/
|
|
6126
|
-
nextToken?: string | undefined;
|
|
6127
|
-
}
|
|
6128
|
-
/**
|
|
6129
|
-
* @public
|
|
6130
|
-
*/
|
|
6131
|
-
export interface ListIndicesRequest {
|
|
6132
|
-
/**
|
|
6133
|
-
* <p>The token used to get the next set of results, or <code>null</code> if there are no additional
|
|
6134
|
-
* results.</p>
|
|
6135
|
-
* @public
|
|
6136
|
-
*/
|
|
6137
|
-
nextToken?: string | undefined;
|
|
6138
|
-
/**
|
|
6139
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
6140
|
-
* @public
|
|
6141
|
-
*/
|
|
6142
|
-
maxResults?: number | undefined;
|
|
6143
|
-
}
|
|
6144
|
-
/**
|
|
6145
|
-
* @public
|
|
6146
|
-
*/
|
|
6147
|
-
export interface ListIndicesResponse {
|
|
6228
|
+
namespace?: CommandNamespace | undefined;
|
|
6148
6229
|
/**
|
|
6149
|
-
* <p>
|
|
6230
|
+
* <p>List all command executions for the device that have a particular status. For example,
|
|
6231
|
+
* you can filter the list to display only command executions that have failed or timed
|
|
6232
|
+
* out.</p>
|
|
6150
6233
|
* @public
|
|
6151
6234
|
*/
|
|
6152
|
-
|
|
6235
|
+
status?: CommandExecutionStatus | undefined;
|
|
6153
6236
|
/**
|
|
6154
|
-
* <p>
|
|
6155
|
-
*
|
|
6237
|
+
* <p>Specify whether to list the command executions that were created in the
|
|
6238
|
+
* ascending or descending order. By default, the API returns all commands in the
|
|
6239
|
+
* descending order based on the start time or completion time of the executions, that are
|
|
6240
|
+
* determined by the <code>startTimeFilter</code> and <code>completeTimeFilter</code>
|
|
6241
|
+
* parameters.</p>
|
|
6156
6242
|
* @public
|
|
6157
6243
|
*/
|
|
6158
|
-
|
|
6159
|
-
}
|
|
6160
|
-
/**
|
|
6161
|
-
* @public
|
|
6162
|
-
*/
|
|
6163
|
-
export interface ListJobExecutionsForJobRequest {
|
|
6244
|
+
sortOrder?: SortOrder | undefined;
|
|
6164
6245
|
/**
|
|
6165
|
-
* <p>
|
|
6246
|
+
* <p>List all command executions that started any time before or after the
|
|
6247
|
+
* date and time that you specify. The date and time uses the format
|
|
6248
|
+
* <code>yyyy-MM-dd'T'HH:mm</code>.</p>
|
|
6166
6249
|
* @public
|
|
6167
6250
|
*/
|
|
6168
|
-
|
|
6251
|
+
startedTimeFilter?: TimeFilter | undefined;
|
|
6169
6252
|
/**
|
|
6170
|
-
* <p>
|
|
6253
|
+
* <p>List all command executions that completed any time before or after the
|
|
6254
|
+
* date and time that you specify. The date and time uses the format
|
|
6255
|
+
* <code>yyyy-MM-dd'T'HH:mm</code>.</p>
|
|
6171
6256
|
* @public
|
|
6172
6257
|
*/
|
|
6173
|
-
|
|
6258
|
+
completedTimeFilter?: TimeFilter | undefined;
|
|
6174
6259
|
/**
|
|
6175
|
-
* <p>The
|
|
6260
|
+
* <p>The Amazon Resource Number (ARN) of the target device. You can use this information to
|
|
6261
|
+
* list all command executions for a particular device.</p>
|
|
6176
6262
|
* @public
|
|
6177
6263
|
*/
|
|
6178
|
-
|
|
6264
|
+
targetArn?: string | undefined;
|
|
6179
6265
|
/**
|
|
6180
|
-
* <p>The
|
|
6266
|
+
* <p>The Amazon Resource Number (ARN) of the command. You can use this information to
|
|
6267
|
+
* list all command executions for a particular command.</p>
|
|
6181
6268
|
* @public
|
|
6182
6269
|
*/
|
|
6183
|
-
|
|
6270
|
+
commandArn?: string | undefined;
|
|
6184
6271
|
}
|
|
6185
6272
|
/**
|
|
6186
|
-
* <p>
|
|
6273
|
+
* <p>Summary information about a particular command execution.</p>
|
|
6187
6274
|
* @public
|
|
6188
6275
|
*/
|
|
6189
|
-
export interface
|
|
6276
|
+
export interface CommandExecutionSummary {
|
|
6190
6277
|
/**
|
|
6191
|
-
* <p>The
|
|
6278
|
+
* <p>The Amazon Resource Name (ARN) of the command execution.</p>
|
|
6192
6279
|
* @public
|
|
6193
6280
|
*/
|
|
6194
|
-
|
|
6195
|
-
/**
|
|
6196
|
-
* <p>The time, in seconds since the epoch, when the job execution was queued.</p>
|
|
6197
|
-
* @public
|
|
6198
|
-
*/
|
|
6199
|
-
queuedAt?: Date | undefined;
|
|
6281
|
+
commandArn?: string | undefined;
|
|
6200
6282
|
/**
|
|
6201
|
-
* <p>The
|
|
6283
|
+
* <p>The unique identifier of the command execution.</p>
|
|
6202
6284
|
* @public
|
|
6203
6285
|
*/
|
|
6204
|
-
|
|
6286
|
+
executionId?: string | undefined;
|
|
6205
6287
|
/**
|
|
6206
|
-
* <p>The
|
|
6288
|
+
* <p>The Amazon Resource Name (ARN) of the target device for which the command is being
|
|
6289
|
+
* executed.</p>
|
|
6207
6290
|
* @public
|
|
6208
6291
|
*/
|
|
6209
|
-
|
|
6292
|
+
targetArn?: string | undefined;
|
|
6210
6293
|
/**
|
|
6211
|
-
* <p>
|
|
6212
|
-
* this particular device. It can be used later in commands which return or update job execution
|
|
6213
|
-
* information.</p>
|
|
6294
|
+
* <p>The status of the command executions.</p>
|
|
6214
6295
|
* @public
|
|
6215
6296
|
*/
|
|
6216
|
-
|
|
6297
|
+
status?: CommandExecutionStatus | undefined;
|
|
6217
6298
|
/**
|
|
6218
|
-
* <p>The
|
|
6219
|
-
* job on this device.</p>
|
|
6299
|
+
* <p>The date and time at which the command execution was created for the target device.</p>
|
|
6220
6300
|
* @public
|
|
6221
6301
|
*/
|
|
6222
|
-
|
|
6223
|
-
}
|
|
6224
|
-
/**
|
|
6225
|
-
* <p>Contains a summary of information about job executions for a specific job.</p>
|
|
6226
|
-
* @public
|
|
6227
|
-
*/
|
|
6228
|
-
export interface JobExecutionSummaryForJob {
|
|
6302
|
+
createdAt?: Date | undefined;
|
|
6229
6303
|
/**
|
|
6230
|
-
* <p>The
|
|
6304
|
+
* <p>The date and time at which the command started executing on the target device.</p>
|
|
6231
6305
|
* @public
|
|
6232
6306
|
*/
|
|
6233
|
-
|
|
6307
|
+
startedAt?: Date | undefined;
|
|
6234
6308
|
/**
|
|
6235
|
-
* <p>
|
|
6309
|
+
* <p>The date and time at which the command completed executing on the target
|
|
6310
|
+
* device.</p>
|
|
6236
6311
|
* @public
|
|
6237
6312
|
*/
|
|
6238
|
-
|
|
6313
|
+
completedAt?: Date | undefined;
|
|
6239
6314
|
}
|
|
6240
6315
|
/**
|
|
6241
6316
|
* @public
|
|
6242
6317
|
*/
|
|
6243
|
-
export interface
|
|
6318
|
+
export interface ListCommandExecutionsResponse {
|
|
6244
6319
|
/**
|
|
6245
|
-
* <p>
|
|
6320
|
+
* <p>The list of command executions.</p>
|
|
6246
6321
|
* @public
|
|
6247
6322
|
*/
|
|
6248
|
-
|
|
6323
|
+
commandExecutions?: CommandExecutionSummary[] | undefined;
|
|
6249
6324
|
/**
|
|
6250
|
-
* <p>The token
|
|
6325
|
+
* <p>The token to use to get the next set of results, or <code>null</code> if there are no
|
|
6251
6326
|
* additional results.</p>
|
|
6252
6327
|
* @public
|
|
6253
6328
|
*/
|
|
@@ -6256,256 +6331,277 @@ export interface ListJobExecutionsForJobResponse {
|
|
|
6256
6331
|
/**
|
|
6257
6332
|
* @public
|
|
6258
6333
|
*/
|
|
6259
|
-
export interface
|
|
6260
|
-
/**
|
|
6261
|
-
* <p>The thing name.</p>
|
|
6262
|
-
* @public
|
|
6263
|
-
*/
|
|
6264
|
-
thingName: string | undefined;
|
|
6334
|
+
export interface ListCommandsRequest {
|
|
6265
6335
|
/**
|
|
6266
|
-
* <p>
|
|
6336
|
+
* <p>The maximum number of results to return in this operation. By default, the API returns
|
|
6337
|
+
* up to a maximum of 25 results. You can override this default value to return up to a
|
|
6338
|
+
* maximum of 100 results for this operation.</p>
|
|
6267
6339
|
* @public
|
|
6268
6340
|
*/
|
|
6269
|
-
|
|
6341
|
+
maxResults?: number | undefined;
|
|
6270
6342
|
/**
|
|
6271
|
-
* <p>
|
|
6272
|
-
*
|
|
6273
|
-
* contain the value in the following format.</p>
|
|
6274
|
-
* <p>
|
|
6275
|
-
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
|
|
6276
|
-
* </p>
|
|
6277
|
-
* <note>
|
|
6278
|
-
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
|
|
6279
|
-
* this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting
|
|
6280
|
-
* up IoT Greengrass core devices.</a>
|
|
6281
|
-
* </p>
|
|
6282
|
-
* </note>
|
|
6343
|
+
* <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous
|
|
6344
|
+
* response; otherwise <code>null</code> to receive the first set of results.</p>
|
|
6283
6345
|
* @public
|
|
6284
6346
|
*/
|
|
6285
|
-
|
|
6347
|
+
nextToken?: string | undefined;
|
|
6286
6348
|
/**
|
|
6287
|
-
* <p>The
|
|
6349
|
+
* <p>The namespace of the command. By default, the API returns all commands that have been
|
|
6350
|
+
* created for both <code>AWS-IoT</code> and <code>AWS-IoT-FleetWise</code> namespaces. You
|
|
6351
|
+
* can override this default value if you want to return all commands that have been
|
|
6352
|
+
* created only for a specific namespace.</p>
|
|
6288
6353
|
* @public
|
|
6289
6354
|
*/
|
|
6290
|
-
|
|
6355
|
+
namespace?: CommandNamespace | undefined;
|
|
6291
6356
|
/**
|
|
6292
|
-
* <p>
|
|
6357
|
+
* <p>A filter that can be used to display the list of commands that have a specific command
|
|
6358
|
+
* parameter name.</p>
|
|
6293
6359
|
* @public
|
|
6294
6360
|
*/
|
|
6295
|
-
|
|
6361
|
+
commandParameterName?: string | undefined;
|
|
6296
6362
|
/**
|
|
6297
|
-
* <p>
|
|
6363
|
+
* <p>Specify whether to list the commands that you have created in the ascending or
|
|
6364
|
+
* descending order. By default, the API returns all commands in the descending order based
|
|
6365
|
+
* on the time that they were created.</p>
|
|
6298
6366
|
* @public
|
|
6299
6367
|
*/
|
|
6300
|
-
|
|
6368
|
+
sortOrder?: SortOrder | undefined;
|
|
6301
6369
|
}
|
|
6302
6370
|
/**
|
|
6303
|
-
* <p>
|
|
6371
|
+
* <p>Summary information about a particular command resource.</p>
|
|
6304
6372
|
* @public
|
|
6305
6373
|
*/
|
|
6306
|
-
export interface
|
|
6374
|
+
export interface CommandSummary {
|
|
6307
6375
|
/**
|
|
6308
|
-
* <p>The
|
|
6376
|
+
* <p>The Amazon Resource Name (ARN) of the command.</p>
|
|
6309
6377
|
* @public
|
|
6310
6378
|
*/
|
|
6311
|
-
|
|
6379
|
+
commandArn?: string | undefined;
|
|
6312
6380
|
/**
|
|
6313
|
-
* <p>
|
|
6381
|
+
* <p>The unique identifier of the command.</p>
|
|
6314
6382
|
* @public
|
|
6315
6383
|
*/
|
|
6316
|
-
|
|
6317
|
-
}
|
|
6318
|
-
/**
|
|
6319
|
-
* @public
|
|
6320
|
-
*/
|
|
6321
|
-
export interface ListJobExecutionsForThingResponse {
|
|
6384
|
+
commandId?: string | undefined;
|
|
6322
6385
|
/**
|
|
6323
|
-
* <p>
|
|
6386
|
+
* <p>The display name of the command.</p>
|
|
6324
6387
|
* @public
|
|
6325
6388
|
*/
|
|
6326
|
-
|
|
6389
|
+
displayName?: string | undefined;
|
|
6327
6390
|
/**
|
|
6328
|
-
* <p>
|
|
6329
|
-
* additional results.</p>
|
|
6391
|
+
* <p>Indicates whether the command has been deprecated.</p>
|
|
6330
6392
|
* @public
|
|
6331
6393
|
*/
|
|
6332
|
-
|
|
6333
|
-
}
|
|
6334
|
-
/**
|
|
6335
|
-
* @public
|
|
6336
|
-
*/
|
|
6337
|
-
export interface ListJobsRequest {
|
|
6394
|
+
deprecated?: boolean | undefined;
|
|
6338
6395
|
/**
|
|
6339
|
-
* <p>
|
|
6396
|
+
* <p>The timestamp, when the command was created.</p>
|
|
6340
6397
|
* @public
|
|
6341
6398
|
*/
|
|
6342
|
-
|
|
6399
|
+
createdAt?: Date | undefined;
|
|
6343
6400
|
/**
|
|
6344
|
-
* <p>
|
|
6345
|
-
* specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing
|
|
6346
|
-
* when a change is detected in a target. For example, a job will run on a thing when the thing is added to a
|
|
6347
|
-
* target group, even after the job was completed by all things originally in the group. </p>
|
|
6348
|
-
* <note>
|
|
6349
|
-
* <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets.
|
|
6350
|
-
* By using continuous jobs, devices that join the group receive the job execution even after the job has
|
|
6351
|
-
* been created.</p>
|
|
6352
|
-
* </note>
|
|
6401
|
+
* <p>The timestamp, when the command was last updated.</p>
|
|
6353
6402
|
* @public
|
|
6354
6403
|
*/
|
|
6355
|
-
|
|
6404
|
+
lastUpdatedAt?: Date | undefined;
|
|
6356
6405
|
/**
|
|
6357
|
-
* <p>
|
|
6406
|
+
* <p>Indicates whether the command is pending deletion.</p>
|
|
6358
6407
|
* @public
|
|
6359
6408
|
*/
|
|
6360
|
-
|
|
6409
|
+
pendingDeletion?: boolean | undefined;
|
|
6410
|
+
}
|
|
6411
|
+
/**
|
|
6412
|
+
* @public
|
|
6413
|
+
*/
|
|
6414
|
+
export interface ListCommandsResponse {
|
|
6361
6415
|
/**
|
|
6362
|
-
* <p>The
|
|
6416
|
+
* <p>The list of commands.</p>
|
|
6363
6417
|
* @public
|
|
6364
6418
|
*/
|
|
6365
|
-
|
|
6419
|
+
commands?: CommandSummary[] | undefined;
|
|
6366
6420
|
/**
|
|
6367
|
-
* <p>
|
|
6421
|
+
* <p>The token to use to get the next set of results, or <code>null</code> if there are no
|
|
6422
|
+
* additional results.</p>
|
|
6368
6423
|
* @public
|
|
6369
6424
|
*/
|
|
6370
|
-
|
|
6425
|
+
nextToken?: string | undefined;
|
|
6426
|
+
}
|
|
6427
|
+
/**
|
|
6428
|
+
* @public
|
|
6429
|
+
*/
|
|
6430
|
+
export interface ListCustomMetricsRequest {
|
|
6371
6431
|
/**
|
|
6372
|
-
* <p>
|
|
6432
|
+
* <p>
|
|
6433
|
+
* The token for the next set of results.
|
|
6434
|
+
* </p>
|
|
6373
6435
|
* @public
|
|
6374
6436
|
*/
|
|
6375
|
-
|
|
6437
|
+
nextToken?: string | undefined;
|
|
6376
6438
|
/**
|
|
6377
|
-
* <p>
|
|
6378
|
-
*
|
|
6379
|
-
*
|
|
6380
|
-
* <p>
|
|
6381
|
-
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
|
|
6382
|
-
* </p>
|
|
6383
|
-
* <note>
|
|
6384
|
-
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For
|
|
6385
|
-
* more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a>
|
|
6386
|
-
* </p>
|
|
6387
|
-
* </note>
|
|
6439
|
+
* <p>
|
|
6440
|
+
* The maximum number of results to return at one time. The default is 25.
|
|
6441
|
+
* </p>
|
|
6388
6442
|
* @public
|
|
6389
6443
|
*/
|
|
6390
|
-
|
|
6444
|
+
maxResults?: number | undefined;
|
|
6391
6445
|
}
|
|
6392
6446
|
/**
|
|
6393
|
-
* <p>The job summary.</p>
|
|
6394
6447
|
* @public
|
|
6395
6448
|
*/
|
|
6396
|
-
export interface
|
|
6449
|
+
export interface ListCustomMetricsResponse {
|
|
6397
6450
|
/**
|
|
6398
|
-
* <p>
|
|
6451
|
+
* <p>
|
|
6452
|
+
* The name of the custom metric.
|
|
6453
|
+
* </p>
|
|
6399
6454
|
* @public
|
|
6400
6455
|
*/
|
|
6401
|
-
|
|
6456
|
+
metricNames?: string[] | undefined;
|
|
6402
6457
|
/**
|
|
6403
|
-
* <p>
|
|
6458
|
+
* <p>
|
|
6459
|
+
* A token that can be used to retrieve the next set of results,
|
|
6460
|
+
* or <code>null</code> if there are no additional results.
|
|
6461
|
+
* </p>
|
|
6404
6462
|
* @public
|
|
6405
6463
|
*/
|
|
6406
|
-
|
|
6464
|
+
nextToken?: string | undefined;
|
|
6465
|
+
}
|
|
6466
|
+
/**
|
|
6467
|
+
* @public
|
|
6468
|
+
*/
|
|
6469
|
+
export interface ListDetectMitigationActionsExecutionsRequest {
|
|
6407
6470
|
/**
|
|
6408
|
-
* <p>
|
|
6471
|
+
* <p>
|
|
6472
|
+
* The unique identifier of the task.
|
|
6473
|
+
* </p>
|
|
6409
6474
|
* @public
|
|
6410
6475
|
*/
|
|
6411
|
-
|
|
6476
|
+
taskId?: string | undefined;
|
|
6412
6477
|
/**
|
|
6413
|
-
* <p>
|
|
6414
|
-
*
|
|
6415
|
-
*
|
|
6416
|
-
* target group, even after the job was completed by all things originally in the group.</p>
|
|
6417
|
-
* <note>
|
|
6418
|
-
* <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets.
|
|
6419
|
-
* By using continuous jobs, devices that join the group receive the job execution even after the job has
|
|
6420
|
-
* been created.</p>
|
|
6421
|
-
* </note>
|
|
6478
|
+
* <p>
|
|
6479
|
+
* The unique identifier of the violation.
|
|
6480
|
+
* </p>
|
|
6422
6481
|
* @public
|
|
6423
6482
|
*/
|
|
6424
|
-
|
|
6483
|
+
violationId?: string | undefined;
|
|
6425
6484
|
/**
|
|
6426
|
-
* <p>
|
|
6485
|
+
* <p>
|
|
6486
|
+
* The name of the thing whose mitigation actions are listed.
|
|
6487
|
+
* </p>
|
|
6427
6488
|
* @public
|
|
6428
6489
|
*/
|
|
6429
|
-
|
|
6490
|
+
thingName?: string | undefined;
|
|
6430
6491
|
/**
|
|
6431
|
-
* <p>
|
|
6492
|
+
* <p>
|
|
6493
|
+
* A filter to limit results to those found after the specified time. You must
|
|
6494
|
+
* specify either the startTime and endTime or the taskId, but not both.
|
|
6495
|
+
* </p>
|
|
6432
6496
|
* @public
|
|
6433
6497
|
*/
|
|
6434
|
-
|
|
6498
|
+
startTime?: Date | undefined;
|
|
6435
6499
|
/**
|
|
6436
|
-
* <p>
|
|
6500
|
+
* <p>
|
|
6501
|
+
* The end of the time period for which ML Detect mitigation actions executions are returned.
|
|
6502
|
+
* </p>
|
|
6437
6503
|
* @public
|
|
6438
6504
|
*/
|
|
6439
|
-
|
|
6505
|
+
endTime?: Date | undefined;
|
|
6440
6506
|
/**
|
|
6441
|
-
* <p>
|
|
6507
|
+
* <p>
|
|
6508
|
+
* The maximum number of results to return at one time. The default is 25.
|
|
6509
|
+
* </p>
|
|
6442
6510
|
* @public
|
|
6443
6511
|
*/
|
|
6444
|
-
|
|
6512
|
+
maxResults?: number | undefined;
|
|
6445
6513
|
/**
|
|
6446
|
-
* <p>
|
|
6447
|
-
*
|
|
6448
|
-
*
|
|
6514
|
+
* <p>
|
|
6515
|
+
* The token for the next set of results.
|
|
6516
|
+
* </p>
|
|
6449
6517
|
* @public
|
|
6450
6518
|
*/
|
|
6451
|
-
|
|
6519
|
+
nextToken?: string | undefined;
|
|
6452
6520
|
}
|
|
6453
6521
|
/**
|
|
6522
|
+
* @public
|
|
6523
|
+
* @enum
|
|
6524
|
+
*/
|
|
6525
|
+
export declare const DetectMitigationActionExecutionStatus: {
|
|
6526
|
+
readonly FAILED: "FAILED";
|
|
6527
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
6528
|
+
readonly SKIPPED: "SKIPPED";
|
|
6529
|
+
readonly SUCCESSFUL: "SUCCESSFUL";
|
|
6530
|
+
};
|
|
6531
|
+
/**
|
|
6532
|
+
* @public
|
|
6533
|
+
*/
|
|
6534
|
+
export type DetectMitigationActionExecutionStatus = (typeof DetectMitigationActionExecutionStatus)[keyof typeof DetectMitigationActionExecutionStatus];
|
|
6535
|
+
/**
|
|
6536
|
+
* <p>
|
|
6537
|
+
* Describes which mitigation actions should be executed.
|
|
6538
|
+
* </p>
|
|
6454
6539
|
* @public
|
|
6455
6540
|
*/
|
|
6456
|
-
export interface
|
|
6541
|
+
export interface DetectMitigationActionExecution {
|
|
6457
6542
|
/**
|
|
6458
|
-
* <p>
|
|
6543
|
+
* <p>
|
|
6544
|
+
* The unique identifier of the task.
|
|
6545
|
+
* </p>
|
|
6459
6546
|
* @public
|
|
6460
6547
|
*/
|
|
6461
|
-
|
|
6548
|
+
taskId?: string | undefined;
|
|
6462
6549
|
/**
|
|
6463
|
-
* <p>
|
|
6464
|
-
*
|
|
6550
|
+
* <p>
|
|
6551
|
+
* The unique identifier of the violation.
|
|
6552
|
+
* </p>
|
|
6465
6553
|
* @public
|
|
6466
6554
|
*/
|
|
6467
|
-
|
|
6468
|
-
}
|
|
6469
|
-
/**
|
|
6470
|
-
* @public
|
|
6471
|
-
*/
|
|
6472
|
-
export interface ListJobTemplatesRequest {
|
|
6555
|
+
violationId?: string | undefined;
|
|
6473
6556
|
/**
|
|
6474
|
-
* <p>
|
|
6557
|
+
* <p>
|
|
6558
|
+
* The friendly name that uniquely identifies the mitigation action.
|
|
6559
|
+
* </p>
|
|
6475
6560
|
* @public
|
|
6476
6561
|
*/
|
|
6477
|
-
|
|
6562
|
+
actionName?: string | undefined;
|
|
6478
6563
|
/**
|
|
6479
|
-
* <p>
|
|
6564
|
+
* <p>
|
|
6565
|
+
* The name of the thing.
|
|
6566
|
+
* </p>
|
|
6480
6567
|
* @public
|
|
6481
6568
|
*/
|
|
6482
|
-
|
|
6483
|
-
}
|
|
6484
|
-
/**
|
|
6485
|
-
* <p>An object that contains information about the job template.</p>
|
|
6486
|
-
* @public
|
|
6487
|
-
*/
|
|
6488
|
-
export interface JobTemplateSummary {
|
|
6569
|
+
thingName?: string | undefined;
|
|
6489
6570
|
/**
|
|
6490
|
-
* <p>
|
|
6571
|
+
* <p>
|
|
6572
|
+
* The date a mitigation action was started.
|
|
6573
|
+
* </p>
|
|
6491
6574
|
* @public
|
|
6492
6575
|
*/
|
|
6493
|
-
|
|
6576
|
+
executionStartDate?: Date | undefined;
|
|
6494
6577
|
/**
|
|
6495
|
-
* <p>
|
|
6578
|
+
* <p>
|
|
6579
|
+
* The date a mitigation action ended.
|
|
6580
|
+
* </p>
|
|
6496
6581
|
* @public
|
|
6497
6582
|
*/
|
|
6498
|
-
|
|
6583
|
+
executionEndDate?: Date | undefined;
|
|
6499
6584
|
/**
|
|
6500
|
-
* <p>
|
|
6585
|
+
* <p>
|
|
6586
|
+
* The status of a mitigation action.
|
|
6587
|
+
* </p>
|
|
6501
6588
|
* @public
|
|
6502
6589
|
*/
|
|
6503
|
-
|
|
6590
|
+
status?: DetectMitigationActionExecutionStatus | undefined;
|
|
6504
6591
|
/**
|
|
6505
|
-
* <p>
|
|
6592
|
+
* <p>
|
|
6593
|
+
* The error code of a mitigation action.
|
|
6594
|
+
* </p>
|
|
6506
6595
|
* @public
|
|
6507
6596
|
*/
|
|
6508
|
-
|
|
6597
|
+
errorCode?: string | undefined;
|
|
6598
|
+
/**
|
|
6599
|
+
* <p>
|
|
6600
|
+
* The message of a mitigation action.
|
|
6601
|
+
* </p>
|
|
6602
|
+
* @public
|
|
6603
|
+
*/
|
|
6604
|
+
message?: string | undefined;
|
|
6509
6605
|
}
|
|
6510
6606
|
/**
|
|
6511
6607
|
* @internal
|