@aws-sdk/client-iot 3.451.0 → 3.453.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/dist-cjs/models/models_1.js +5 -1
- package/dist-es/models/models_1.js +4 -0
- package/dist-types/commands/AttachSecurityProfileCommand.d.ts +1 -1
- package/dist-types/commands/CancelAuditMitigationActionsTaskCommand.d.ts +3 -2
- package/dist-types/commands/CancelAuditTaskCommand.d.ts +1 -2
- package/dist-types/commands/CancelDetectMitigationActionsTaskCommand.d.ts +3 -1
- package/dist-types/commands/CreateCustomMetricCommand.d.ts +4 -1
- package/dist-types/commands/CreateDimensionCommand.d.ts +2 -4
- package/dist-types/commands/CreateMitigationActionCommand.d.ts +2 -4
- package/dist-types/commands/CreateScheduledAuditCommand.d.ts +2 -1
- package/dist-types/commands/DeleteAccountAuditConfigurationCommand.d.ts +2 -3
- package/dist-types/commands/DeleteCustomMetricCommand.d.ts +8 -4
- package/dist-types/commands/DescribeAccountAuditConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/DescribeAuditFindingCommand.d.ts +3 -1
- package/dist-types/commands/DescribeAuditMitigationActionsTaskCommand.d.ts +1 -3
- package/dist-types/commands/DescribeCustomMetricCommand.d.ts +3 -1
- package/dist-types/commands/DescribeDetectMitigationActionsTaskCommand.d.ts +3 -1
- package/dist-types/commands/DetachSecurityProfileCommand.d.ts +1 -2
- package/dist-types/commands/GetBehaviorModelTrainingSummariesCommand.d.ts +3 -1
- package/dist-types/commands/GetIndexingConfigurationCommand.d.ts +6 -0
- package/dist-types/commands/ListAuditFindingsCommand.d.ts +2 -2
- package/dist-types/commands/ListAuditMitigationActionsExecutionsCommand.d.ts +2 -1
- package/dist-types/commands/ListAuditTasksCommand.d.ts +2 -2
- package/dist-types/commands/ListCustomMetricsCommand.d.ts +3 -1
- package/dist-types/commands/ListDetectMitigationActionsExecutionsCommand.d.ts +3 -1
- package/dist-types/commands/ListDetectMitigationActionsTasksCommand.d.ts +3 -1
- package/dist-types/commands/ListMetricValuesCommand.d.ts +2 -2
- package/dist-types/commands/ListPolicyPrincipalsCommand.d.ts +1 -1
- package/dist-types/commands/ListRelatedResourcesForAuditFindingCommand.d.ts +6 -6
- package/dist-types/commands/ListSecurityProfilesCommand.d.ts +4 -4
- package/dist-types/commands/ListTargetsForSecurityProfileCommand.d.ts +1 -2
- package/dist-types/commands/ListViolationEventsCommand.d.ts +3 -3
- package/dist-types/commands/StartDetectMitigationActionsTaskCommand.d.ts +3 -1
- package/dist-types/commands/UpdateAccountAuditConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/UpdateCustomMetricCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDimensionCommand.d.ts +6 -2
- package/dist-types/commands/UpdateIndexingConfigurationCommand.d.ts +6 -0
- package/dist-types/commands/UpdateScheduledAuditCommand.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +64 -50
- package/dist-types/models/models_1.d.ts +272 -192
- package/dist-types/models/models_2.d.ts +216 -136
- package/dist-types/ts3.4/commands/ListPolicyPrincipalsCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/models_1.d.ts +11 -10
- package/dist-types/ts3.4/models/models_2.d.ts +10 -0
- package/package.json +1 -1
|
@@ -2,6 +2,50 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
|
|
|
2
2
|
import { IoTServiceException as __BaseException } from "./IoTServiceException";
|
|
3
3
|
import { AbortConfig, AggregationType, AlertTarget, AlertTargetType, AttributePayload, AuditCheckConfiguration, AuditFrequency, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditNotificationType, AuthInfo, AuthorizerConfig, AuthorizerStatus, AuthResult, AutoRegistrationStatus, Behavior, BillingGroupProperties, CustomMetricType, DayOfWeek, DimensionType, FleetMetricUnit, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MetricsExportConfig, MetricToRetain, MetricValue, MitigationActionParams, Policy, PresignedUrlConfig, ProvisioningHook, RelatedResource, ResourceIdentifier, StreamFile, Tag, TemplateType, ThingGroupProperties, ThingTypeProperties, TimeoutConfig, TlsConfig, TopicRuleDestinationStatus, TopicRulePayload, VerificationState, ViolationEventAdditionalInfo } from "./models_0";
|
|
4
4
|
import { BehaviorCriteriaType, CACertificateStatus, CertificateMode, CertificateStatus, Configuration, DetectMitigationActionsTaskTarget, DomainConfigurationStatus, EventType, GroupNameAndArn, LogTargetType, RegistrationConfig, Status, ThingGroupIndexingConfiguration, ThingIndexingConfiguration, ThingTypeMetadata, VersionUpdateByJobsConfig, ViolationEventOccurrenceRange } from "./models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
* <p>The input for the ListPolicyPrincipals operation.</p>
|
|
8
|
+
*/
|
|
9
|
+
export interface ListPolicyPrincipalsRequest {
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
* <p>The policy name.</p>
|
|
13
|
+
*/
|
|
14
|
+
policyName: string | undefined;
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
* <p>The marker for the next set of results.</p>
|
|
18
|
+
*/
|
|
19
|
+
marker?: string;
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>The result page size.</p>
|
|
23
|
+
*/
|
|
24
|
+
pageSize?: number;
|
|
25
|
+
/**
|
|
26
|
+
* @public
|
|
27
|
+
* <p>Specifies the order for results. If true, the results are returned in ascending
|
|
28
|
+
* creation order.</p>
|
|
29
|
+
*/
|
|
30
|
+
ascendingOrder?: boolean;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* @public
|
|
34
|
+
* <p>The output from the ListPolicyPrincipals operation.</p>
|
|
35
|
+
*/
|
|
36
|
+
export interface ListPolicyPrincipalsResponse {
|
|
37
|
+
/**
|
|
38
|
+
* @public
|
|
39
|
+
* <p>The descriptions of the principals.</p>
|
|
40
|
+
*/
|
|
41
|
+
principals?: string[];
|
|
42
|
+
/**
|
|
43
|
+
* @public
|
|
44
|
+
* <p>The marker for the next set of results, or null if there are no additional
|
|
45
|
+
* results.</p>
|
|
46
|
+
*/
|
|
47
|
+
nextMarker?: string;
|
|
48
|
+
}
|
|
5
49
|
/**
|
|
6
50
|
* @public
|
|
7
51
|
* <p>The input for the ListPolicyVersions operation.</p>
|
|
@@ -270,8 +314,8 @@ export interface ListRelatedResourcesForAuditFindingRequest {
|
|
|
270
314
|
findingId: string | undefined;
|
|
271
315
|
/**
|
|
272
316
|
* @public
|
|
273
|
-
* <p>A token that can be used to retrieve the next set of results,
|
|
274
|
-
* there are no additional results.</p>
|
|
317
|
+
* <p>A token that can be used to retrieve the next set of results,
|
|
318
|
+
* or <code>null</code> if there are no additional results.</p>
|
|
275
319
|
*/
|
|
276
320
|
nextToken?: string;
|
|
277
321
|
/**
|
|
@@ -291,8 +335,8 @@ export interface ListRelatedResourcesForAuditFindingResponse {
|
|
|
291
335
|
relatedResources?: RelatedResource[];
|
|
292
336
|
/**
|
|
293
337
|
* @public
|
|
294
|
-
* <p>A token that can be used to retrieve the next set of results,
|
|
295
|
-
* first API call.</p>
|
|
338
|
+
* <p>A token that can be used to retrieve the next set of results,
|
|
339
|
+
* or <code>null</code> for the first API call.</p>
|
|
296
340
|
*/
|
|
297
341
|
nextToken?: string;
|
|
298
342
|
}
|
|
@@ -392,8 +436,8 @@ export interface ListScheduledAuditsResponse {
|
|
|
392
436
|
scheduledAudits?: ScheduledAuditMetadata[];
|
|
393
437
|
/**
|
|
394
438
|
* @public
|
|
395
|
-
* <p>A token that can be used to retrieve the next set of results,
|
|
396
|
-
*
|
|
439
|
+
* <p>A token that can be used to retrieve the next set of results,
|
|
440
|
+
* or <code>null</code> if there are no additional results.</p>
|
|
397
441
|
*/
|
|
398
442
|
nextToken?: string;
|
|
399
443
|
}
|
|
@@ -413,14 +457,15 @@ export interface ListSecurityProfilesRequest {
|
|
|
413
457
|
maxResults?: number;
|
|
414
458
|
/**
|
|
415
459
|
* @public
|
|
416
|
-
* <p>A filter to limit results to the security profiles that use the defined dimension.
|
|
417
|
-
* be used with <code>metricName</code>
|
|
460
|
+
* <p>A filter to limit results to the security profiles that use the defined dimension.
|
|
461
|
+
* Cannot be used with <code>metricName</code>
|
|
418
462
|
* </p>
|
|
419
463
|
*/
|
|
420
464
|
dimensionName?: string;
|
|
421
465
|
/**
|
|
422
466
|
* @public
|
|
423
|
-
* <p> The name of the custom metric.
|
|
467
|
+
* <p> The name of the custom metric.
|
|
468
|
+
* Cannot be used with <code>dimensionName</code>. </p>
|
|
424
469
|
*/
|
|
425
470
|
metricName?: string;
|
|
426
471
|
}
|
|
@@ -451,8 +496,8 @@ export interface ListSecurityProfilesResponse {
|
|
|
451
496
|
securityProfileIdentifiers?: SecurityProfileIdentifier[];
|
|
452
497
|
/**
|
|
453
498
|
* @public
|
|
454
|
-
* <p>A token that can be used to retrieve the next set of results, or <code>null</code> if
|
|
455
|
-
*
|
|
499
|
+
* <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no
|
|
500
|
+
* additional results.</p>
|
|
456
501
|
*/
|
|
457
502
|
nextToken?: string;
|
|
458
503
|
}
|
|
@@ -477,8 +522,7 @@ export interface ListSecurityProfilesForTargetRequest {
|
|
|
477
522
|
recursive?: boolean;
|
|
478
523
|
/**
|
|
479
524
|
* @public
|
|
480
|
-
* <p>The ARN of the target (thing group) whose attached security profiles you want to
|
|
481
|
-
* get.</p>
|
|
525
|
+
* <p>The ARN of the target (thing group) whose attached security profiles you want to get.</p>
|
|
482
526
|
*/
|
|
483
527
|
securityProfileTargetArn: string | undefined;
|
|
484
528
|
}
|
|
@@ -521,8 +565,8 @@ export interface ListSecurityProfilesForTargetResponse {
|
|
|
521
565
|
securityProfileTargetMappings?: SecurityProfileTargetMapping[];
|
|
522
566
|
/**
|
|
523
567
|
* @public
|
|
524
|
-
* <p>A token that can be used to retrieve the next set of results, or <code>null</code> if
|
|
525
|
-
*
|
|
568
|
+
* <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no
|
|
569
|
+
* additional results.</p>
|
|
526
570
|
*/
|
|
527
571
|
nextToken?: string;
|
|
528
572
|
}
|
|
@@ -685,8 +729,8 @@ export interface ListTargetsForSecurityProfileResponse {
|
|
|
685
729
|
securityProfileTargets?: SecurityProfileTarget[];
|
|
686
730
|
/**
|
|
687
731
|
* @public
|
|
688
|
-
* <p>A token that can be used to retrieve the next set of results, or <code>null</code> if
|
|
689
|
-
*
|
|
732
|
+
* <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no
|
|
733
|
+
* additional results.</p>
|
|
690
734
|
*/
|
|
691
735
|
nextToken?: string;
|
|
692
736
|
}
|
|
@@ -1454,18 +1498,21 @@ export interface ListViolationEventsRequest {
|
|
|
1454
1498
|
thingName?: string;
|
|
1455
1499
|
/**
|
|
1456
1500
|
* @public
|
|
1457
|
-
* <p>A filter to limit results to those alerts generated by the specified security
|
|
1458
|
-
* profile.</p>
|
|
1501
|
+
* <p>A filter to limit results to those alerts generated by the specified security profile.</p>
|
|
1459
1502
|
*/
|
|
1460
1503
|
securityProfileName?: string;
|
|
1461
1504
|
/**
|
|
1462
1505
|
* @public
|
|
1463
|
-
* <p>
|
|
1506
|
+
* <p>
|
|
1507
|
+
* The criteria for a behavior.
|
|
1508
|
+
* </p>
|
|
1464
1509
|
*/
|
|
1465
1510
|
behaviorCriteriaType?: BehaviorCriteriaType;
|
|
1466
1511
|
/**
|
|
1467
1512
|
* @public
|
|
1468
|
-
* <p>
|
|
1513
|
+
* <p>
|
|
1514
|
+
* A list of all suppressed alerts.
|
|
1515
|
+
* </p>
|
|
1469
1516
|
*/
|
|
1470
1517
|
listSuppressedAlerts?: boolean;
|
|
1471
1518
|
/**
|
|
@@ -1561,15 +1608,14 @@ export interface ViolationEvent {
|
|
|
1561
1608
|
export interface ListViolationEventsResponse {
|
|
1562
1609
|
/**
|
|
1563
1610
|
* @public
|
|
1564
|
-
* <p>The security profile violation alerts issued for this account during the given time
|
|
1565
|
-
*
|
|
1566
|
-
* violating.</p>
|
|
1611
|
+
* <p>The security profile violation alerts issued for this account during the given time period,
|
|
1612
|
+
* potentially filtered by security profile, behavior violated, or thing (device) violating.</p>
|
|
1567
1613
|
*/
|
|
1568
1614
|
violationEvents?: ViolationEvent[];
|
|
1569
1615
|
/**
|
|
1570
1616
|
* @public
|
|
1571
|
-
* <p>A token that can be used to retrieve the next set of results, or <code>null</code> if
|
|
1572
|
-
*
|
|
1617
|
+
* <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no
|
|
1618
|
+
* additional results.</p>
|
|
1573
1619
|
*/
|
|
1574
1620
|
nextToken?: string;
|
|
1575
1621
|
}
|
|
@@ -1938,7 +1984,8 @@ export interface SearchIndexRequest {
|
|
|
1938
1984
|
nextToken?: string;
|
|
1939
1985
|
/**
|
|
1940
1986
|
* @public
|
|
1941
|
-
* <p>The maximum number of results to return at one time. The response might
|
|
1987
|
+
* <p>The maximum number of results to return per page at one time. The response might
|
|
1988
|
+
* contain fewer results but will never contain more.</p>
|
|
1942
1989
|
*/
|
|
1943
1990
|
maxResults?: number;
|
|
1944
1991
|
/**
|
|
@@ -2180,28 +2227,25 @@ export interface SetV2LoggingOptionsRequest {
|
|
|
2180
2227
|
export interface StartAuditMitigationActionsTaskRequest {
|
|
2181
2228
|
/**
|
|
2182
2229
|
* @public
|
|
2183
|
-
* <p>A unique identifier for the task. You can use this identifier to check the status of the
|
|
2184
|
-
* task or to cancel it.</p>
|
|
2230
|
+
* <p>A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.</p>
|
|
2185
2231
|
*/
|
|
2186
2232
|
taskId: string | undefined;
|
|
2187
2233
|
/**
|
|
2188
2234
|
* @public
|
|
2189
2235
|
* <p>Specifies the audit findings to which the mitigation actions are applied. You can apply
|
|
2190
|
-
* them to a type of audit check, to all findings from an audit, or to a
|
|
2236
|
+
* them to a type of audit check, to all findings from an audit, or to a
|
|
2237
|
+
* specific set of
|
|
2191
2238
|
* findings.</p>
|
|
2192
2239
|
*/
|
|
2193
2240
|
target: AuditMitigationActionsTaskTarget | undefined;
|
|
2194
2241
|
/**
|
|
2195
2242
|
* @public
|
|
2196
|
-
* <p>For an audit check, specifies which mitigation actions to apply. Those actions must be
|
|
2197
|
-
* defined in your Amazon Web Services accounts.</p>
|
|
2243
|
+
* <p>For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.</p>
|
|
2198
2244
|
*/
|
|
2199
2245
|
auditCheckToActionsMapping: Record<string, string[]> | undefined;
|
|
2200
2246
|
/**
|
|
2201
2247
|
* @public
|
|
2202
|
-
* <p>Each audit mitigation task must have a unique client request token. If you try to start a
|
|
2203
|
-
* new task with the same token as a task that already exists, an exception occurs. If you omit
|
|
2204
|
-
* this value, a unique client request token is generated automatically.</p>
|
|
2248
|
+
* <p>Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.</p>
|
|
2205
2249
|
*/
|
|
2206
2250
|
clientRequestToken?: string;
|
|
2207
2251
|
}
|
|
@@ -2211,8 +2255,7 @@ export interface StartAuditMitigationActionsTaskRequest {
|
|
|
2211
2255
|
export interface StartAuditMitigationActionsTaskResponse {
|
|
2212
2256
|
/**
|
|
2213
2257
|
* @public
|
|
2214
|
-
* <p>The unique identifier for the audit mitigation task. This matches the <code>taskId</code>
|
|
2215
|
-
* that you specified in the request.</p>
|
|
2258
|
+
* <p>The unique identifier for the audit mitigation task. This matches the <code>taskId</code> that you specified in the request.</p>
|
|
2216
2259
|
*/
|
|
2217
2260
|
taskId?: string;
|
|
2218
2261
|
}
|
|
@@ -2236,39 +2279,51 @@ export declare class TaskAlreadyExistsException extends __BaseException {
|
|
|
2236
2279
|
export interface StartDetectMitigationActionsTaskRequest {
|
|
2237
2280
|
/**
|
|
2238
2281
|
* @public
|
|
2239
|
-
* <p>
|
|
2282
|
+
* <p>
|
|
2283
|
+
* The unique identifier of the task.
|
|
2284
|
+
* </p>
|
|
2240
2285
|
*/
|
|
2241
2286
|
taskId: string | undefined;
|
|
2242
2287
|
/**
|
|
2243
2288
|
* @public
|
|
2244
|
-
* <p>
|
|
2289
|
+
* <p>
|
|
2290
|
+
* Specifies the ML Detect findings to which the mitigation actions are applied.
|
|
2291
|
+
* </p>
|
|
2245
2292
|
*/
|
|
2246
2293
|
target: DetectMitigationActionsTaskTarget | undefined;
|
|
2247
2294
|
/**
|
|
2248
2295
|
* @public
|
|
2249
|
-
* <p>
|
|
2296
|
+
* <p>
|
|
2297
|
+
* The actions to be performed when a device has unexpected behavior.
|
|
2298
|
+
* </p>
|
|
2250
2299
|
*/
|
|
2251
2300
|
actions: string[] | undefined;
|
|
2252
2301
|
/**
|
|
2253
2302
|
* @public
|
|
2254
|
-
* <p>
|
|
2303
|
+
* <p>
|
|
2304
|
+
* Specifies the time period of which violation events occurred between.
|
|
2305
|
+
* </p>
|
|
2255
2306
|
*/
|
|
2256
2307
|
violationEventOccurrenceRange?: ViolationEventOccurrenceRange;
|
|
2257
2308
|
/**
|
|
2258
2309
|
* @public
|
|
2259
|
-
* <p>
|
|
2310
|
+
* <p>
|
|
2311
|
+
* Specifies to list only active violations.
|
|
2312
|
+
* </p>
|
|
2260
2313
|
*/
|
|
2261
2314
|
includeOnlyActiveViolations?: boolean;
|
|
2262
2315
|
/**
|
|
2263
2316
|
* @public
|
|
2264
|
-
* <p>
|
|
2317
|
+
* <p>
|
|
2318
|
+
* Specifies to include suppressed alerts.
|
|
2319
|
+
* </p>
|
|
2265
2320
|
*/
|
|
2266
2321
|
includeSuppressedAlerts?: boolean;
|
|
2267
2322
|
/**
|
|
2268
2323
|
* @public
|
|
2269
|
-
* <p>
|
|
2270
|
-
* a new task with the same token as a task that already exists, an exception occurs. If you omit
|
|
2271
|
-
*
|
|
2324
|
+
* <p>
|
|
2325
|
+
* Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
|
|
2326
|
+
* </p>
|
|
2272
2327
|
*/
|
|
2273
2328
|
clientRequestToken?: string;
|
|
2274
2329
|
}
|
|
@@ -2278,7 +2333,9 @@ export interface StartDetectMitigationActionsTaskRequest {
|
|
|
2278
2333
|
export interface StartDetectMitigationActionsTaskResponse {
|
|
2279
2334
|
/**
|
|
2280
2335
|
* @public
|
|
2281
|
-
* <p>
|
|
2336
|
+
* <p>
|
|
2337
|
+
* The unique identifier of the task.
|
|
2338
|
+
* </p>
|
|
2282
2339
|
*/
|
|
2283
2340
|
taskId?: string;
|
|
2284
2341
|
}
|
|
@@ -2288,10 +2345,10 @@ export interface StartDetectMitigationActionsTaskResponse {
|
|
|
2288
2345
|
export interface StartOnDemandAuditTaskRequest {
|
|
2289
2346
|
/**
|
|
2290
2347
|
* @public
|
|
2291
|
-
* <p>Which checks are performed during the audit. The checks you specify must be enabled
|
|
2292
|
-
*
|
|
2293
|
-
*
|
|
2294
|
-
*
|
|
2348
|
+
* <p>Which checks are performed during the audit. The checks you specify must be enabled
|
|
2349
|
+
* for your account or an exception occurs. Use <code>DescribeAccountAuditConfiguration</code>
|
|
2350
|
+
* to see the list of all checks, including those that are enabled or
|
|
2351
|
+
* <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.</p>
|
|
2295
2352
|
*/
|
|
2296
2353
|
targetCheckNames: string[] | undefined;
|
|
2297
2354
|
}
|
|
@@ -2623,9 +2680,14 @@ export interface UntagResourceResponse {
|
|
|
2623
2680
|
export interface UpdateAccountAuditConfigurationRequest {
|
|
2624
2681
|
/**
|
|
2625
2682
|
* @public
|
|
2626
|
-
* <p>The Amazon
|
|
2627
|
-
*
|
|
2628
|
-
*
|
|
2683
|
+
* <p>The Amazon
|
|
2684
|
+
* Resource Name
|
|
2685
|
+
* (ARN)
|
|
2686
|
+
* of the role that grants permission
|
|
2687
|
+
* to
|
|
2688
|
+
* IoT to access information about your devices, policies,
|
|
2689
|
+
* certificates,
|
|
2690
|
+
* and other items as required when performing an audit.</p>
|
|
2629
2691
|
*/
|
|
2630
2692
|
roleArn?: string;
|
|
2631
2693
|
/**
|
|
@@ -2636,14 +2698,18 @@ export interface UpdateAccountAuditConfigurationRequest {
|
|
|
2636
2698
|
/**
|
|
2637
2699
|
* @public
|
|
2638
2700
|
* <p>Specifies which audit checks are enabled and disabled for this account. Use
|
|
2639
|
-
*
|
|
2640
|
-
*
|
|
2641
|
-
* <p>Some data collection might start immediately when certain checks are enabled.
|
|
2642
|
-
*
|
|
2643
|
-
* <p>You
|
|
2644
|
-
*
|
|
2645
|
-
*
|
|
2646
|
-
*
|
|
2701
|
+
* <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those
|
|
2702
|
+
* that are currently enabled.</p>
|
|
2703
|
+
* <p>Some data collection might start immediately when certain checks are enabled.
|
|
2704
|
+
* When a check is disabled, any data collected so far in relation to the check is deleted.</p>
|
|
2705
|
+
* <p>You
|
|
2706
|
+
* cannot
|
|
2707
|
+
* disable a check if
|
|
2708
|
+
* it's
|
|
2709
|
+
* used by any scheduled audit. You must first delete the check from the scheduled audit or
|
|
2710
|
+
* delete the scheduled audit itself.</p>
|
|
2711
|
+
* <p>On the first call to <code>UpdateAccountAuditConfiguration</code>,
|
|
2712
|
+
* this parameter is required and must specify at least one enabled check.</p>
|
|
2647
2713
|
*/
|
|
2648
2714
|
auditCheckConfigurations?: Record<string, AuditCheckConfiguration>;
|
|
2649
2715
|
}
|
|
@@ -2846,14 +2912,20 @@ export interface UpdateCertificateRequest {
|
|
|
2846
2912
|
export interface UpdateCustomMetricRequest {
|
|
2847
2913
|
/**
|
|
2848
2914
|
* @public
|
|
2849
|
-
* <p> The name of the custom metric.
|
|
2915
|
+
* <p> The name of the custom metric.
|
|
2916
|
+
* Cannot be updated. </p>
|
|
2850
2917
|
*/
|
|
2851
2918
|
metricName: string | undefined;
|
|
2852
2919
|
/**
|
|
2853
2920
|
* @public
|
|
2854
|
-
* <p>
|
|
2855
|
-
*
|
|
2856
|
-
*
|
|
2921
|
+
* <p>
|
|
2922
|
+
* Field
|
|
2923
|
+
* represents a friendly name in the console for the custom metric,
|
|
2924
|
+
* it
|
|
2925
|
+
* doesn't have to be unique. Don't use this name as the metric identifier in
|
|
2926
|
+
* the device metric report.
|
|
2927
|
+
* Can
|
|
2928
|
+
* be updated. </p>
|
|
2857
2929
|
*/
|
|
2858
2930
|
displayName: string | undefined;
|
|
2859
2931
|
}
|
|
@@ -2863,37 +2935,45 @@ export interface UpdateCustomMetricRequest {
|
|
|
2863
2935
|
export interface UpdateCustomMetricResponse {
|
|
2864
2936
|
/**
|
|
2865
2937
|
* @public
|
|
2866
|
-
* <p>
|
|
2938
|
+
* <p>
|
|
2939
|
+
* The name of the custom metric.
|
|
2940
|
+
* </p>
|
|
2867
2941
|
*/
|
|
2868
2942
|
metricName?: string;
|
|
2869
2943
|
/**
|
|
2870
2944
|
* @public
|
|
2871
|
-
* <p>
|
|
2945
|
+
* <p>
|
|
2946
|
+
* The Amazon Resource Number (ARN) of the custom metric.
|
|
2947
|
+
* </p>
|
|
2872
2948
|
*/
|
|
2873
2949
|
metricArn?: string;
|
|
2874
2950
|
/**
|
|
2875
2951
|
* @public
|
|
2876
2952
|
* <p> The type of the custom metric. </p>
|
|
2877
2953
|
* <important>
|
|
2878
|
-
* <p>The type <code>number</code> only takes a single metric value as an input, but while
|
|
2879
|
-
* submitting the metrics value in the DeviceMetrics report, it must be passed as an array with
|
|
2880
|
-
* a single value.</p>
|
|
2954
|
+
* <p>The type <code>number</code> only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.</p>
|
|
2881
2955
|
* </important>
|
|
2882
2956
|
*/
|
|
2883
2957
|
metricType?: CustomMetricType;
|
|
2884
2958
|
/**
|
|
2885
2959
|
* @public
|
|
2886
|
-
* <p>
|
|
2960
|
+
* <p>
|
|
2961
|
+
* A friendly name in the console for the custom metric
|
|
2962
|
+
* </p>
|
|
2887
2963
|
*/
|
|
2888
2964
|
displayName?: string;
|
|
2889
2965
|
/**
|
|
2890
2966
|
* @public
|
|
2891
|
-
* <p>
|
|
2967
|
+
* <p>
|
|
2968
|
+
* The creation date of the custom metric in milliseconds since epoch.
|
|
2969
|
+
* </p>
|
|
2892
2970
|
*/
|
|
2893
2971
|
creationDate?: Date;
|
|
2894
2972
|
/**
|
|
2895
2973
|
* @public
|
|
2896
|
-
* <p>
|
|
2974
|
+
* <p>
|
|
2975
|
+
* The time the custom metric was last modified in milliseconds since epoch.
|
|
2976
|
+
* </p>
|
|
2897
2977
|
*/
|
|
2898
2978
|
lastModifiedDate?: Date;
|
|
2899
2979
|
}
|
|
@@ -2903,14 +2983,12 @@ export interface UpdateCustomMetricResponse {
|
|
|
2903
2983
|
export interface UpdateDimensionRequest {
|
|
2904
2984
|
/**
|
|
2905
2985
|
* @public
|
|
2906
|
-
* <p>A unique identifier for the dimension. Choose something that describes the type and value
|
|
2907
|
-
* to make it easy to remember what it does.</p>
|
|
2986
|
+
* <p>A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.</p>
|
|
2908
2987
|
*/
|
|
2909
2988
|
name: string | undefined;
|
|
2910
2989
|
/**
|
|
2911
2990
|
* @public
|
|
2912
|
-
* <p>Specifies the value or list of values for the dimension. For <code>TOPIC_FILTER</code>
|
|
2913
|
-
* dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").</p>
|
|
2991
|
+
* <p>Specifies the value or list of values for the dimension. For <code>TOPIC_FILTER</code> dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").</p>
|
|
2914
2992
|
*/
|
|
2915
2993
|
stringValues: string[] | undefined;
|
|
2916
2994
|
}
|
|
@@ -2925,7 +3003,9 @@ export interface UpdateDimensionResponse {
|
|
|
2925
3003
|
name?: string;
|
|
2926
3004
|
/**
|
|
2927
3005
|
* @public
|
|
2928
|
-
* <p>The Amazon Resource
|
|
3006
|
+
* <p>The Amazon Resource
|
|
3007
|
+
* Name (ARN)of
|
|
3008
|
+
* the created dimension.</p>
|
|
2929
3009
|
*/
|
|
2930
3010
|
arn?: string;
|
|
2931
3011
|
/**
|
|
@@ -2935,20 +3015,17 @@ export interface UpdateDimensionResponse {
|
|
|
2935
3015
|
type?: DimensionType;
|
|
2936
3016
|
/**
|
|
2937
3017
|
* @public
|
|
2938
|
-
* <p>The value or list of values used to scope the dimension. For example, for topic filters,
|
|
2939
|
-
* this is the pattern used to match the MQTT topic name.</p>
|
|
3018
|
+
* <p>The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.</p>
|
|
2940
3019
|
*/
|
|
2941
3020
|
stringValues?: string[];
|
|
2942
3021
|
/**
|
|
2943
3022
|
* @public
|
|
2944
|
-
* <p>The date and time, in milliseconds since epoch, when the dimension was initially
|
|
2945
|
-
* created.</p>
|
|
3023
|
+
* <p>The date and time, in milliseconds since epoch, when the dimension was initially created.</p>
|
|
2946
3024
|
*/
|
|
2947
3025
|
creationDate?: Date;
|
|
2948
3026
|
/**
|
|
2949
3027
|
* @public
|
|
2950
|
-
* <p>The date and time, in milliseconds since epoch, when the dimension was most recently
|
|
2951
|
-
* updated.</p>
|
|
3028
|
+
* <p>The date and time, in milliseconds since epoch, when the dimension was most recently updated.</p>
|
|
2952
3029
|
*/
|
|
2953
3030
|
lastModifiedDate?: Date;
|
|
2954
3031
|
}
|
|
@@ -3201,8 +3278,9 @@ export interface UpdateMitigationActionRequest {
|
|
|
3201
3278
|
/**
|
|
3202
3279
|
* @public
|
|
3203
3280
|
* <p>The friendly name for the mitigation action. You cannot change the name by using
|
|
3204
|
-
* <code>UpdateMitigationAction</code>. Instead, you must delete and
|
|
3205
|
-
*
|
|
3281
|
+
* <code>UpdateMitigationAction</code>. Instead, you must delete and
|
|
3282
|
+
* recreate the
|
|
3283
|
+
* mitigation action with the new name.</p>
|
|
3206
3284
|
*/
|
|
3207
3285
|
actionName: string | undefined;
|
|
3208
3286
|
/**
|
|
@@ -3443,34 +3521,38 @@ export interface UpdateRoleAliasResponse {
|
|
|
3443
3521
|
export interface UpdateScheduledAuditRequest {
|
|
3444
3522
|
/**
|
|
3445
3523
|
* @public
|
|
3446
|
-
* <p>How often the scheduled audit takes
|
|
3447
|
-
*
|
|
3448
|
-
*
|
|
3524
|
+
* <p>How often the scheduled audit takes
|
|
3525
|
+
* place,
|
|
3526
|
+
* either <code>DAILY</code>,
|
|
3527
|
+
* <code>WEEKLY</code>, <code>BIWEEKLY</code>, or <code>MONTHLY</code>. The start time of each audit is determined by the
|
|
3528
|
+
* system.</p>
|
|
3449
3529
|
*/
|
|
3450
3530
|
frequency?: AuditFrequency;
|
|
3451
3531
|
/**
|
|
3452
3532
|
* @public
|
|
3453
|
-
* <p>The day of the month on which the scheduled audit takes place.
|
|
3454
|
-
*
|
|
3455
|
-
*
|
|
3456
|
-
*
|
|
3457
|
-
*
|
|
3533
|
+
* <p>The day of the month on which the scheduled audit takes place.
|
|
3534
|
+
* This
|
|
3535
|
+
* can
|
|
3536
|
+
* be <code>1</code> through <code>31</code> or <code>LAST</code>. This field is required if the <code>frequency</code> parameter is set to
|
|
3537
|
+
* <code>MONTHLY</code>. If days 29-31 are specified, and the month does not have that many days, the audit
|
|
3538
|
+
* takes place on the "LAST" day of the month.</p>
|
|
3458
3539
|
*/
|
|
3459
3540
|
dayOfMonth?: string;
|
|
3460
3541
|
/**
|
|
3461
3542
|
* @public
|
|
3462
|
-
* <p>The day of the week on which the scheduled audit takes place.
|
|
3463
|
-
*
|
|
3464
|
-
*
|
|
3465
|
-
*
|
|
3543
|
+
* <p>The day of the week on which the scheduled audit takes place.
|
|
3544
|
+
* This
|
|
3545
|
+
* can
|
|
3546
|
+
* be one of <code>SUN</code>, <code>MON</code>, <code>TUE</code>, <code>WED</code>, <code>THU</code>, <code>FRI</code>, or <code>SAT</code>. This field is required if the
|
|
3547
|
+
* "frequency" parameter is set to <code>WEEKLY</code> or <code>BIWEEKLY</code>.</p>
|
|
3466
3548
|
*/
|
|
3467
3549
|
dayOfWeek?: DayOfWeek;
|
|
3468
3550
|
/**
|
|
3469
3551
|
* @public
|
|
3470
|
-
* <p>Which checks are performed during the scheduled audit. Checks must be enabled
|
|
3471
|
-
*
|
|
3472
|
-
*
|
|
3473
|
-
*
|
|
3552
|
+
* <p>Which checks are performed during the scheduled audit. Checks must be enabled
|
|
3553
|
+
* for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list
|
|
3554
|
+
* of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code>
|
|
3555
|
+
* to select which checks are enabled.)</p>
|
|
3474
3556
|
*/
|
|
3475
3557
|
targetCheckNames?: string[];
|
|
3476
3558
|
/**
|
|
@@ -3505,8 +3587,7 @@ export interface UpdateSecurityProfileRequest {
|
|
|
3505
3587
|
securityProfileDescription?: string;
|
|
3506
3588
|
/**
|
|
3507
3589
|
* @public
|
|
3508
|
-
* <p>Specifies the behaviors that, when violated by a device (thing), cause an
|
|
3509
|
-
* alert.</p>
|
|
3590
|
+
* <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
|
|
3510
3591
|
*/
|
|
3511
3592
|
behaviors?: Behavior[];
|
|
3512
3593
|
/**
|
|
@@ -3519,46 +3600,46 @@ export interface UpdateSecurityProfileRequest {
|
|
|
3519
3600
|
* @deprecated
|
|
3520
3601
|
*
|
|
3521
3602
|
* <p>
|
|
3522
|
-
* <i>Please use
|
|
3523
|
-
*
|
|
3603
|
+
* <i>Please use
|
|
3604
|
+
* <a>UpdateSecurityProfileRequest$additionalMetricsToRetainV2</a>
|
|
3605
|
+
* instead.</i>
|
|
3524
3606
|
* </p>
|
|
3525
|
-
* <p>A list of metrics
|
|
3526
|
-
*
|
|
3527
|
-
*
|
|
3607
|
+
* <p>A list of metrics
|
|
3608
|
+
* whose data is retained (stored). By default, data is retained for any metric
|
|
3609
|
+
* used in the profile's <code>behaviors</code>, but
|
|
3610
|
+
* it is
|
|
3611
|
+
* also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
|
|
3528
3612
|
*/
|
|
3529
3613
|
additionalMetricsToRetain?: string[];
|
|
3530
3614
|
/**
|
|
3531
3615
|
* @public
|
|
3532
|
-
* <p>A list of metrics whose data is retained (stored). By default, data is retained for any
|
|
3533
|
-
* metric used in the profile's behaviors, but it is also retained for any metric specified here.
|
|
3534
|
-
* Can be used with custom metrics; cannot be used with dimensions.</p>
|
|
3616
|
+
* <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
|
|
3535
3617
|
*/
|
|
3536
3618
|
additionalMetricsToRetainV2?: MetricToRetain[];
|
|
3537
3619
|
/**
|
|
3538
3620
|
* @public
|
|
3539
|
-
* <p>If true, delete all <code>behaviors</code> defined for this security profile.
|
|
3540
|
-
* <code>behaviors</code> are defined in the current invocation, an exception occurs.</p>
|
|
3621
|
+
* <p>If true, delete all <code>behaviors</code> defined for this security profile.
|
|
3622
|
+
* If any <code>behaviors</code> are defined in the current invocation, an exception occurs.</p>
|
|
3541
3623
|
*/
|
|
3542
3624
|
deleteBehaviors?: boolean;
|
|
3543
3625
|
/**
|
|
3544
3626
|
* @public
|
|
3545
|
-
* <p>If true, delete all <code>alertTargets</code> defined for this security profile.
|
|
3546
|
-
* <code>alertTargets</code> are defined in the current invocation, an exception
|
|
3547
|
-
* occurs.</p>
|
|
3627
|
+
* <p>If true, delete all <code>alertTargets</code> defined for this security profile.
|
|
3628
|
+
* If any <code>alertTargets</code> are defined in the current invocation, an exception occurs.</p>
|
|
3548
3629
|
*/
|
|
3549
3630
|
deleteAlertTargets?: boolean;
|
|
3550
3631
|
/**
|
|
3551
3632
|
* @public
|
|
3552
|
-
* <p>If true, delete all <code>additionalMetricsToRetain</code> defined for this
|
|
3553
|
-
*
|
|
3554
|
-
*
|
|
3633
|
+
* <p>If true, delete all <code>additionalMetricsToRetain</code> defined for this
|
|
3634
|
+
* security profile. If any <code>additionalMetricsToRetain</code> are defined in the current
|
|
3635
|
+
* invocation, an exception occurs.</p>
|
|
3555
3636
|
*/
|
|
3556
3637
|
deleteAdditionalMetricsToRetain?: boolean;
|
|
3557
3638
|
/**
|
|
3558
3639
|
* @public
|
|
3559
|
-
* <p>The expected version of the security profile. A new version is generated whenever
|
|
3560
|
-
*
|
|
3561
|
-
*
|
|
3640
|
+
* <p>The expected version of the security profile. A new version is generated whenever
|
|
3641
|
+
* the security profile is updated. If you specify a value that is different from the actual
|
|
3642
|
+
* version, a <code>VersionConflictException</code> is thrown.</p>
|
|
3562
3643
|
*/
|
|
3563
3644
|
expectedVersion?: number;
|
|
3564
3645
|
/**
|
|
@@ -3593,8 +3674,7 @@ export interface UpdateSecurityProfileResponse {
|
|
|
3593
3674
|
securityProfileDescription?: string;
|
|
3594
3675
|
/**
|
|
3595
3676
|
* @public
|
|
3596
|
-
* <p>Specifies the behaviors that, when violated by a device (thing), cause an
|
|
3597
|
-
* alert.</p>
|
|
3677
|
+
* <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
|
|
3598
3678
|
*/
|
|
3599
3679
|
behaviors?: Behavior[];
|
|
3600
3680
|
/**
|
|
@@ -3607,19 +3687,20 @@ export interface UpdateSecurityProfileResponse {
|
|
|
3607
3687
|
* @deprecated
|
|
3608
3688
|
*
|
|
3609
3689
|
* <p>
|
|
3610
|
-
* <i>Please use
|
|
3611
|
-
*
|
|
3690
|
+
* <i>Please use
|
|
3691
|
+
* <a>UpdateSecurityProfileResponse$additionalMetricsToRetainV2</a>
|
|
3692
|
+
* instead.</i>
|
|
3612
3693
|
* </p>
|
|
3613
|
-
* <p>A list of metrics
|
|
3614
|
-
*
|
|
3615
|
-
*
|
|
3694
|
+
* <p>A list of metrics
|
|
3695
|
+
* whose data is retained (stored). By default, data is retained for any metric
|
|
3696
|
+
* used in the security profile's <code>behaviors</code>, but
|
|
3697
|
+
* it is
|
|
3698
|
+
* also retained for any metric specified here.</p>
|
|
3616
3699
|
*/
|
|
3617
3700
|
additionalMetricsToRetain?: string[];
|
|
3618
3701
|
/**
|
|
3619
3702
|
* @public
|
|
3620
|
-
* <p>A list of metrics whose data is retained (stored). By default, data is retained for any
|
|
3621
|
-
* metric used in the profile's behaviors, but it is also retained for any metric specified here.
|
|
3622
|
-
* Can be used with custom metrics; cannot be used with dimensions.</p>
|
|
3703
|
+
* <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.</p>
|
|
3623
3704
|
*/
|
|
3624
3705
|
additionalMetricsToRetainV2?: MetricToRetain[];
|
|
3625
3706
|
/**
|
|
@@ -3862,8 +3943,7 @@ export interface UpdateTopicRuleDestinationResponse {
|
|
|
3862
3943
|
export interface ValidateSecurityProfileBehaviorsRequest {
|
|
3863
3944
|
/**
|
|
3864
3945
|
* @public
|
|
3865
|
-
* <p>Specifies the behaviors that, when violated by a device (thing), cause an
|
|
3866
|
-
* alert.</p>
|
|
3946
|
+
* <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
|
|
3867
3947
|
*/
|
|
3868
3948
|
behaviors: Behavior[] | undefined;
|
|
3869
3949
|
}
|