aws-sdk 2.810.0 → 2.814.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/CHANGELOG.md +35 -1
  2. package/README.md +2 -3
  3. package/apis/amp-2020-08-01.examples.json +5 -0
  4. package/apis/amp-2020-08-01.min.json +211 -0
  5. package/apis/amp-2020-08-01.paginators.json +10 -0
  6. package/apis/ce-2017-10-25.min.json +101 -97
  7. package/apis/config-2014-11-12.min.json +40 -6
  8. package/apis/dlm-2018-01-12.min.json +104 -16
  9. package/apis/ec2-2016-11-15.min.json +11 -0
  10. package/apis/greengrassv2-2020-11-30.examples.json +5 -0
  11. package/apis/greengrassv2-2020-11-30.min.json +1069 -0
  12. package/apis/greengrassv2-2020-11-30.paginators.json +40 -0
  13. package/apis/imagebuilder-2019-12-02.min.json +375 -88
  14. package/apis/imagebuilder-2019-12-02.paginators.json +24 -9
  15. package/apis/iot-2015-05-28.min.json +904 -278
  16. package/apis/iot-2015-05-28.paginators.json +24 -0
  17. package/apis/iotanalytics-2017-11-27.min.json +79 -27
  18. package/apis/iotdeviceadvisor-2020-09-18.examples.json +5 -0
  19. package/apis/iotdeviceadvisor-2020-09-18.min.json +596 -0
  20. package/apis/iotdeviceadvisor-2020-09-18.paginators.json +19 -0
  21. package/apis/iotfleethub-2020-11-03.examples.json +5 -0
  22. package/apis/iotfleethub-2020-11-03.min.json +292 -0
  23. package/apis/iotfleethub-2020-11-03.paginators.json +9 -0
  24. package/apis/iotwireless-2020-11-22.examples.json +5 -0
  25. package/apis/iotwireless-2020-11-22.min.json +1832 -0
  26. package/apis/iotwireless-2020-11-22.paginators.json +29 -0
  27. package/apis/kms-2014-11-01.examples.json +7 -4
  28. package/apis/kms-2014-11-01.min.json +7 -1
  29. package/apis/lambda-2015-03-31.examples.json +6 -6
  30. package/apis/lambda-2015-03-31.min.json +140 -100
  31. package/apis/location-2020-11-19.examples.json +5 -0
  32. package/apis/location-2020-11-19.min.json +1759 -0
  33. package/apis/location-2020-11-19.paginators.json +44 -0
  34. package/apis/metadata.json +21 -0
  35. package/apis/quicksight-2018-04-01.min.json +120 -119
  36. package/apis/rds-2014-10-31.min.json +192 -172
  37. package/apis/route53-2013-04-01.min.json +372 -96
  38. package/apis/route53resolver-2018-04-01.min.json +81 -6
  39. package/apis/route53resolver-2018-04-01.paginators.json +6 -0
  40. package/apis/servicecatalog-2015-12-10.min.json +187 -117
  41. package/apis/servicecatalog-2015-12-10.paginators.json +5 -0
  42. package/apis/ssm-2014-11-06.min.json +606 -293
  43. package/apis/ssm-2014-11-06.paginators.json +12 -0
  44. package/apis/wellarchitected-2020-03-31.examples.json +5 -0
  45. package/apis/wellarchitected-2020-03-31.min.json +1329 -0
  46. package/apis/wellarchitected-2020-03-31.paginators.json +49 -0
  47. package/clients/all.d.ts +7 -0
  48. package/clients/all.js +8 -1
  49. package/clients/amp.d.ts +220 -0
  50. package/clients/amp.js +18 -0
  51. package/clients/configservice.d.ts +49 -28
  52. package/clients/costexplorer.d.ts +3 -2
  53. package/clients/dlm.d.ts +99 -7
  54. package/clients/ec2.d.ts +14 -2
  55. package/clients/greengrassv2.d.ts +1270 -0
  56. package/clients/greengrassv2.js +18 -0
  57. package/clients/imagebuilder.d.ts +433 -5
  58. package/clients/iot.d.ts +770 -60
  59. package/clients/iotanalytics.d.ts +68 -2
  60. package/clients/iotdeviceadvisor.d.ts +710 -0
  61. package/clients/iotdeviceadvisor.js +18 -0
  62. package/clients/iotfleethub.d.ts +315 -0
  63. package/clients/iotfleethub.js +18 -0
  64. package/clients/iotwireless.d.ts +2124 -0
  65. package/clients/iotwireless.js +18 -0
  66. package/clients/kms.d.ts +117 -109
  67. package/clients/lambda.d.ts +63 -17
  68. package/clients/location.d.ts +1498 -0
  69. package/clients/location.js +18 -0
  70. package/clients/quicksight.d.ts +15 -10
  71. package/clients/rds.d.ts +41 -14
  72. package/clients/route53.d.ts +247 -1
  73. package/clients/route53resolver.d.ts +105 -8
  74. package/clients/servicecatalog.d.ts +122 -14
  75. package/clients/sqs.d.ts +23 -23
  76. package/clients/ssm.d.ts +534 -31
  77. package/clients/wellarchitected.d.ts +871 -0
  78. package/clients/wellarchitected.js +18 -0
  79. package/dist/aws-sdk-core-react-native.js +7 -2
  80. package/dist/aws-sdk-react-native.js +293 -24
  81. package/dist/aws-sdk.js +2709 -1190
  82. package/dist/aws-sdk.min.js +81 -81
  83. package/lib/config_service_placeholders.d.ts +14 -0
  84. package/lib/core.js +1 -1
  85. package/lib/util.js +5 -0
  86. package/package.json +1 -1
package/clients/iot.d.ts CHANGED
@@ -84,11 +84,11 @@ declare class Iot extends Service {
84
84
  */
85
85
  cancelAuditMitigationActionsTask(callback?: (err: AWSError, data: Iot.Types.CancelAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.CancelAuditMitigationActionsTaskResponse, AWSError>;
86
86
  /**
87
- * Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs.
87
+ * Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.
88
88
  */
89
89
  cancelAuditTask(params: Iot.Types.CancelAuditTaskRequest, callback?: (err: AWSError, data: Iot.Types.CancelAuditTaskResponse) => void): Request<Iot.Types.CancelAuditTaskResponse, AWSError>;
90
90
  /**
91
- * Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs.
91
+ * Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.
92
92
  */
93
93
  cancelAuditTask(callback?: (err: AWSError, data: Iot.Types.CancelAuditTaskResponse) => void): Request<Iot.Types.CancelAuditTaskResponse, AWSError>;
94
94
  /**
@@ -99,6 +99,14 @@ declare class Iot extends Service {
99
99
  * Cancels a pending transfer for the specified certificate. Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled. After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
100
100
  */
101
101
  cancelCertificateTransfer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
102
+ /**
103
+ * Cancels a Device Defender ML Detect mitigation action.
104
+ */
105
+ cancelDetectMitigationActionsTask(params: Iot.Types.CancelDetectMitigationActionsTaskRequest, callback?: (err: AWSError, data: Iot.Types.CancelDetectMitigationActionsTaskResponse) => void): Request<Iot.Types.CancelDetectMitigationActionsTaskResponse, AWSError>;
106
+ /**
107
+ * Cancels a Device Defender ML Detect mitigation action.
108
+ */
109
+ cancelDetectMitigationActionsTask(callback?: (err: AWSError, data: Iot.Types.CancelDetectMitigationActionsTaskResponse) => void): Request<Iot.Types.CancelDetectMitigationActionsTaskResponse, AWSError>;
102
110
  /**
103
111
  * Cancels a job.
104
112
  */
@@ -163,6 +171,14 @@ declare class Iot extends Service {
163
171
  * Creates an X.509 certificate using the specified certificate signing request. Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves. Note: Reusing the same certificate signing request (CSR) results in a distinct certificate. You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. Assuming a set of CSRs are located inside of the directory my-csr-directory: On Linux and OS X, the command is: $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR. The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process: $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is: &gt; ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_} On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is: &gt; forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
164
172
  */
165
173
  createCertificateFromCsr(callback?: (err: AWSError, data: Iot.Types.CreateCertificateFromCsrResponse) => void): Request<Iot.Types.CreateCertificateFromCsrResponse, AWSError>;
174
+ /**
175
+ * Use this API to define a Custom Metric published by your devices to Device Defender.
176
+ */
177
+ createCustomMetric(params: Iot.Types.CreateCustomMetricRequest, callback?: (err: AWSError, data: Iot.Types.CreateCustomMetricResponse) => void): Request<Iot.Types.CreateCustomMetricResponse, AWSError>;
178
+ /**
179
+ * Use this API to define a Custom Metric published by your devices to Device Defender.
180
+ */
181
+ createCustomMetric(callback?: (err: AWSError, data: Iot.Types.CreateCustomMetricResponse) => void): Request<Iot.Types.CreateCustomMetricResponse, AWSError>;
166
182
  /**
167
183
  * Create a dimension that you can use to limit the scope of a metric used in a security profile for AWS IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.
168
184
  */
@@ -379,6 +395,14 @@ declare class Iot extends Service {
379
395
  * Deletes the specified certificate. A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
380
396
  */
381
397
  deleteCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
398
+ /**
399
+ * Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles API with metricName set to your custom metric name. Deletes a Device Defender detect custom metric.
400
+ */
401
+ deleteCustomMetric(params: Iot.Types.DeleteCustomMetricRequest, callback?: (err: AWSError, data: Iot.Types.DeleteCustomMetricResponse) => void): Request<Iot.Types.DeleteCustomMetricResponse, AWSError>;
402
+ /**
403
+ * Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles API with metricName set to your custom metric name. Deletes a Device Defender detect custom metric.
404
+ */
405
+ deleteCustomMetric(callback?: (err: AWSError, data: Iot.Types.DeleteCustomMetricResponse) => void): Request<Iot.Types.DeleteCustomMetricResponse, AWSError>;
382
406
  /**
383
407
  * Removes the specified dimension from your AWS account.
384
408
  */
@@ -572,11 +596,11 @@ declare class Iot extends Service {
572
596
  */
573
597
  describeAccountAuditConfiguration(callback?: (err: AWSError, data: Iot.Types.DescribeAccountAuditConfigurationResponse) => void): Request<Iot.Types.DescribeAccountAuditConfigurationResponse, AWSError>;
574
598
  /**
575
- * Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and when the audit that returned the finding was started.
599
+ * Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.
576
600
  */
577
601
  describeAuditFinding(params: Iot.Types.DescribeAuditFindingRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAuditFindingResponse) => void): Request<Iot.Types.DescribeAuditFindingResponse, AWSError>;
578
602
  /**
579
- * Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and when the audit that returned the finding was started.
603
+ * Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.
580
604
  */
581
605
  describeAuditFinding(callback?: (err: AWSError, data: Iot.Types.DescribeAuditFindingResponse) => void): Request<Iot.Types.DescribeAuditFindingResponse, AWSError>;
582
606
  /**
@@ -635,6 +659,14 @@ declare class Iot extends Service {
635
659
  * Gets information about the specified certificate.
636
660
  */
637
661
  describeCertificate(callback?: (err: AWSError, data: Iot.Types.DescribeCertificateResponse) => void): Request<Iot.Types.DescribeCertificateResponse, AWSError>;
662
+ /**
663
+ * Gets information about a Device Defender detect custom metric.
664
+ */
665
+ describeCustomMetric(params: Iot.Types.DescribeCustomMetricRequest, callback?: (err: AWSError, data: Iot.Types.DescribeCustomMetricResponse) => void): Request<Iot.Types.DescribeCustomMetricResponse, AWSError>;
666
+ /**
667
+ * Gets information about a Device Defender detect custom metric.
668
+ */
669
+ describeCustomMetric(callback?: (err: AWSError, data: Iot.Types.DescribeCustomMetricResponse) => void): Request<Iot.Types.DescribeCustomMetricResponse, AWSError>;
638
670
  /**
639
671
  * Describes the default authorizer.
640
672
  */
@@ -643,6 +675,14 @@ declare class Iot extends Service {
643
675
  * Describes the default authorizer.
644
676
  */
645
677
  describeDefaultAuthorizer(callback?: (err: AWSError, data: Iot.Types.DescribeDefaultAuthorizerResponse) => void): Request<Iot.Types.DescribeDefaultAuthorizerResponse, AWSError>;
678
+ /**
679
+ * Gets information about a Device Defender ML Detect mitigation action.
680
+ */
681
+ describeDetectMitigationActionsTask(params: Iot.Types.DescribeDetectMitigationActionsTaskRequest, callback?: (err: AWSError, data: Iot.Types.DescribeDetectMitigationActionsTaskResponse) => void): Request<Iot.Types.DescribeDetectMitigationActionsTaskResponse, AWSError>;
682
+ /**
683
+ * Gets information about a Device Defender ML Detect mitigation action.
684
+ */
685
+ describeDetectMitigationActionsTask(callback?: (err: AWSError, data: Iot.Types.DescribeDetectMitigationActionsTaskResponse) => void): Request<Iot.Types.DescribeDetectMitigationActionsTaskResponse, AWSError>;
646
686
  /**
647
687
  * Provides details about a dimension that is defined in your AWS account.
648
688
  */
@@ -835,6 +875,14 @@ declare class Iot extends Service {
835
875
  * Enables the rule.
836
876
  */
837
877
  enableTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
878
+ /**
879
+ * Returns a Device Defender's ML Detect Security Profile training model's status.
880
+ */
881
+ getBehaviorModelTrainingSummaries(params: Iot.Types.GetBehaviorModelTrainingSummariesRequest, callback?: (err: AWSError, data: Iot.Types.GetBehaviorModelTrainingSummariesResponse) => void): Request<Iot.Types.GetBehaviorModelTrainingSummariesResponse, AWSError>;
882
+ /**
883
+ * Returns a Device Defender's ML Detect Security Profile training model's status.
884
+ */
885
+ getBehaviorModelTrainingSummaries(callback?: (err: AWSError, data: Iot.Types.GetBehaviorModelTrainingSummariesResponse) => void): Request<Iot.Types.GetBehaviorModelTrainingSummariesResponse, AWSError>;
838
886
  /**
839
887
  * Returns the approximate count of unique values that match the query.
840
888
  */
@@ -1043,6 +1091,30 @@ declare class Iot extends Service {
1043
1091
  * List the device certificates signed by the specified CA certificate.
1044
1092
  */
1045
1093
  listCertificatesByCA(callback?: (err: AWSError, data: Iot.Types.ListCertificatesByCAResponse) => void): Request<Iot.Types.ListCertificatesByCAResponse, AWSError>;
1094
+ /**
1095
+ * Lists your Device Defender detect custom metrics.
1096
+ */
1097
+ listCustomMetrics(params: Iot.Types.ListCustomMetricsRequest, callback?: (err: AWSError, data: Iot.Types.ListCustomMetricsResponse) => void): Request<Iot.Types.ListCustomMetricsResponse, AWSError>;
1098
+ /**
1099
+ * Lists your Device Defender detect custom metrics.
1100
+ */
1101
+ listCustomMetrics(callback?: (err: AWSError, data: Iot.Types.ListCustomMetricsResponse) => void): Request<Iot.Types.ListCustomMetricsResponse, AWSError>;
1102
+ /**
1103
+ * Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
1104
+ */
1105
+ listDetectMitigationActionsExecutions(params: Iot.Types.ListDetectMitigationActionsExecutionsRequest, callback?: (err: AWSError, data: Iot.Types.ListDetectMitigationActionsExecutionsResponse) => void): Request<Iot.Types.ListDetectMitigationActionsExecutionsResponse, AWSError>;
1106
+ /**
1107
+ * Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
1108
+ */
1109
+ listDetectMitigationActionsExecutions(callback?: (err: AWSError, data: Iot.Types.ListDetectMitigationActionsExecutionsResponse) => void): Request<Iot.Types.ListDetectMitigationActionsExecutionsResponse, AWSError>;
1110
+ /**
1111
+ * List of Device Defender ML Detect mitigation actions tasks.
1112
+ */
1113
+ listDetectMitigationActionsTasks(params: Iot.Types.ListDetectMitigationActionsTasksRequest, callback?: (err: AWSError, data: Iot.Types.ListDetectMitigationActionsTasksResponse) => void): Request<Iot.Types.ListDetectMitigationActionsTasksResponse, AWSError>;
1114
+ /**
1115
+ * List of Device Defender ML Detect mitigation actions tasks.
1116
+ */
1117
+ listDetectMitigationActionsTasks(callback?: (err: AWSError, data: Iot.Types.ListDetectMitigationActionsTasksResponse) => void): Request<Iot.Types.ListDetectMitigationActionsTasksResponse, AWSError>;
1046
1118
  /**
1047
1119
  * List the set of dimensions that are defined for your AWS account.
1048
1120
  */
@@ -1188,11 +1260,11 @@ declare class Iot extends Service {
1188
1260
  */
1189
1261
  listScheduledAudits(callback?: (err: AWSError, data: Iot.Types.ListScheduledAuditsResponse) => void): Request<Iot.Types.ListScheduledAuditsResponse, AWSError>;
1190
1262
  /**
1191
- * Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.
1263
+ * Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric. dimensionName and metricName cannot be used in the same request.
1192
1264
  */
1193
1265
  listSecurityProfiles(params: Iot.Types.ListSecurityProfilesRequest, callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesResponse) => void): Request<Iot.Types.ListSecurityProfilesResponse, AWSError>;
1194
1266
  /**
1195
- * Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.
1267
+ * Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric. dimensionName and metricName cannot be used in the same request.
1196
1268
  */
1197
1269
  listSecurityProfiles(callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesResponse) => void): Request<Iot.Types.ListSecurityProfilesResponse, AWSError>;
1198
1270
  /**
@@ -1459,6 +1531,14 @@ declare class Iot extends Service {
1459
1531
  * Starts a task that applies a set of mitigation actions to the specified target.
1460
1532
  */
1461
1533
  startAuditMitigationActionsTask(callback?: (err: AWSError, data: Iot.Types.StartAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.StartAuditMitigationActionsTaskResponse, AWSError>;
1534
+ /**
1535
+ * Starts a Device Defender ML Detect mitigation actions task.
1536
+ */
1537
+ startDetectMitigationActionsTask(params: Iot.Types.StartDetectMitigationActionsTaskRequest, callback?: (err: AWSError, data: Iot.Types.StartDetectMitigationActionsTaskResponse) => void): Request<Iot.Types.StartDetectMitigationActionsTaskResponse, AWSError>;
1538
+ /**
1539
+ * Starts a Device Defender ML Detect mitigation actions task.
1540
+ */
1541
+ startDetectMitigationActionsTask(callback?: (err: AWSError, data: Iot.Types.StartDetectMitigationActionsTaskResponse) => void): Request<Iot.Types.StartDetectMitigationActionsTaskResponse, AWSError>;
1462
1542
  /**
1463
1543
  * Starts an on-demand Device Defender audit.
1464
1544
  */
@@ -1572,11 +1652,19 @@ declare class Iot extends Service {
1572
1652
  */
1573
1653
  updateCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1574
1654
  /**
1575
- * Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and re-create it).
1655
+ * Updates a Device Defender detect custom metric.
1656
+ */
1657
+ updateCustomMetric(params: Iot.Types.UpdateCustomMetricRequest, callback?: (err: AWSError, data: Iot.Types.UpdateCustomMetricResponse) => void): Request<Iot.Types.UpdateCustomMetricResponse, AWSError>;
1658
+ /**
1659
+ * Updates a Device Defender detect custom metric.
1660
+ */
1661
+ updateCustomMetric(callback?: (err: AWSError, data: Iot.Types.UpdateCustomMetricResponse) => void): Request<Iot.Types.UpdateCustomMetricResponse, AWSError>;
1662
+ /**
1663
+ * Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).
1576
1664
  */
1577
1665
  updateDimension(params: Iot.Types.UpdateDimensionRequest, callback?: (err: AWSError, data: Iot.Types.UpdateDimensionResponse) => void): Request<Iot.Types.UpdateDimensionResponse, AWSError>;
1578
1666
  /**
1579
- * Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and re-create it).
1667
+ * Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).
1580
1668
  */
1581
1669
  updateDimension(callback?: (err: AWSError, data: Iot.Types.UpdateDimensionResponse) => void): Request<Iot.Types.UpdateDimensionResponse, AWSError>;
1582
1670
  /**
@@ -1828,6 +1916,10 @@ declare namespace Iot {
1828
1916
  * Send data to an HTTPS endpoint.
1829
1917
  */
1830
1918
  http?: HttpAction;
1919
+ /**
1920
+ * Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
1921
+ */
1922
+ kafka?: KafkaAction;
1831
1923
  }
1832
1924
  export type ActionList = Action[];
1833
1925
  export type ActionType = "PUBLISH"|"SUBSCRIBE"|"RECEIVE"|"CONNECT"|string;
@@ -1841,17 +1933,21 @@ declare namespace Iot {
1841
1933
  */
1842
1934
  thingName?: DeviceDefenderThingName;
1843
1935
  /**
1844
- * The security profile whose behavior is in violation.
1936
+ * The security profile with the behavior is in violation.
1845
1937
  */
1846
1938
  securityProfileName?: SecurityProfileName;
1847
1939
  /**
1848
- * The behavior which is being violated.
1940
+ * The behavior that is being violated.
1849
1941
  */
1850
1942
  behavior?: Behavior;
1851
1943
  /**
1852
- * The value of the metric (the measurement) which caused the most recent violation.
1944
+ * The value of the metric (the measurement) that caused the most recent violation.
1853
1945
  */
1854
1946
  lastViolationValue?: MetricValue;
1947
+ /**
1948
+ * The details of a violation event.
1949
+ */
1950
+ violationEventAdditionalInfo?: ViolationEventAdditionalInfo;
1855
1951
  /**
1856
1952
  * The time the most recent violation occurred.
1857
1953
  */
@@ -1908,11 +2004,11 @@ declare namespace Iot {
1908
2004
  }
1909
2005
  export interface AddThingsToThingGroupParams {
1910
2006
  /**
1911
- * The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you cannot add a thing to more than one group in the same hierarchy.
2007
+ * The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you can't add a thing to more than one group in the same hierarchy.
1912
2008
  */
1913
2009
  thingGroupNames: ThingGroupNames;
1914
2010
  /**
1915
- * Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic things groups.
2011
+ * Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic thing groups.
1916
2012
  */
1917
2013
  overrideDynamicGroups?: OverrideDynamicGroups;
1918
2014
  }
@@ -1923,7 +2019,7 @@ declare namespace Iot {
1923
2019
  export type AlarmName = string;
1924
2020
  export interface AlertTarget {
1925
2021
  /**
1926
- * The ARN of the notification target to which alerts are sent.
2022
+ * The Amazon Resource Name (ARN) of the notification target to which alerts are sent.
1927
2023
  */
1928
2024
  alertTargetArn: AlertTargetArn;
1929
2025
  /**
@@ -2185,7 +2281,7 @@ declare namespace Iot {
2185
2281
  /**
2186
2282
  * The unique identifier for the task that applies the mitigation action.
2187
2283
  */
2188
- taskId?: AuditMitigationActionsTaskId;
2284
+ taskId?: MitigationActionsTaskId;
2189
2285
  /**
2190
2286
  * The unique identifier for the findings to which the task and associated mitigation action are applied.
2191
2287
  */
@@ -2221,12 +2317,11 @@ declare namespace Iot {
2221
2317
  }
2222
2318
  export type AuditMitigationActionExecutionMetadataList = AuditMitigationActionExecutionMetadata[];
2223
2319
  export type AuditMitigationActionsExecutionStatus = "IN_PROGRESS"|"COMPLETED"|"FAILED"|"CANCELED"|"SKIPPED"|"PENDING"|string;
2224
- export type AuditMitigationActionsTaskId = string;
2225
2320
  export interface AuditMitigationActionsTaskMetadata {
2226
2321
  /**
2227
2322
  * The unique identifier for the task.
2228
2323
  */
2229
- taskId?: AuditMitigationActionsTaskId;
2324
+ taskId?: MitigationActionsTaskId;
2230
2325
  /**
2231
2326
  * The time at which the audit mitigation actions task was started.
2232
2327
  */
@@ -2491,7 +2586,7 @@ declare namespace Iot {
2491
2586
  export type BatchMode = boolean;
2492
2587
  export interface Behavior {
2493
2588
  /**
2494
- * The name you have given to the behavior.
2589
+ * The name you've given to the behavior.
2495
2590
  */
2496
2591
  name: BehaviorName;
2497
2592
  /**
@@ -2499,17 +2594,21 @@ declare namespace Iot {
2499
2594
  */
2500
2595
  metric?: BehaviorMetric;
2501
2596
  /**
2502
- * The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.
2597
+ * The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric to only MQTT topics where the name matches the pattern specified in the dimension. This can't be used with custom metrics.
2503
2598
  */
2504
2599
  metricDimension?: MetricDimension;
2505
2600
  /**
2506
2601
  * The criteria that determine if a device is behaving normally in regard to the metric.
2507
2602
  */
2508
2603
  criteria?: BehaviorCriteria;
2604
+ /**
2605
+ * Suppresses alerts.
2606
+ */
2607
+ suppressAlerts?: SuppressAlerts;
2509
2608
  }
2510
2609
  export interface BehaviorCriteria {
2511
2610
  /**
2512
- * The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).
2611
+ * The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include: string-list: in-set and not-in-set number-list: in-set and not-in-set ip-address-list: in-cidr-set and not-in-cidr-set number: less-than, less-than-equals, greater-than, and greater-than-equals
2513
2612
  */
2514
2613
  comparisonOperator?: ComparisonOperator;
2515
2614
  /**
@@ -2517,7 +2616,7 @@ declare namespace Iot {
2517
2616
  */
2518
2617
  value?: MetricValue;
2519
2618
  /**
2520
- * Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank.
2619
+ * Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.
2521
2620
  */
2522
2621
  durationSeconds?: DurationSeconds;
2523
2622
  /**
@@ -2529,11 +2628,43 @@ declare namespace Iot {
2529
2628
  */
2530
2629
  consecutiveDatapointsToClear?: ConsecutiveDatapointsToClear;
2531
2630
  /**
2532
- * A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
2631
+ * A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
2533
2632
  */
2534
2633
  statisticalThreshold?: StatisticalThreshold;
2634
+ /**
2635
+ * The configuration of an ML Detect
2636
+ */
2637
+ mlDetectionConfig?: MachineLearningDetectionConfig;
2535
2638
  }
2639
+ export type BehaviorCriteriaType = "STATIC"|"STATISTICAL"|"MACHINE_LEARNING"|string;
2536
2640
  export type BehaviorMetric = string;
2641
+ export type BehaviorModelTrainingSummaries = BehaviorModelTrainingSummary[];
2642
+ export interface BehaviorModelTrainingSummary {
2643
+ /**
2644
+ * The name of the security profile.
2645
+ */
2646
+ securityProfileName?: SecurityProfileName;
2647
+ /**
2648
+ * The name of the behavior.
2649
+ */
2650
+ behaviorName?: BehaviorName;
2651
+ /**
2652
+ * The date a training model started collecting data.
2653
+ */
2654
+ trainingDataCollectionStartDate?: Timestamp;
2655
+ /**
2656
+ * The status of the behavior model.
2657
+ */
2658
+ modelStatus?: ModelStatus;
2659
+ /**
2660
+ * The percentage of datapoints collected.
2661
+ */
2662
+ datapointsCollectionPercentage?: DataCollectionPercentage;
2663
+ /**
2664
+ * The date the model was last refreshed.
2665
+ */
2666
+ lastModelRefreshDate?: Timestamp;
2667
+ }
2537
2668
  export type BehaviorName = string;
2538
2669
  export type Behaviors = Behavior[];
2539
2670
  export type BillingGroupArn = string;
@@ -2627,7 +2758,7 @@ declare namespace Iot {
2627
2758
  /**
2628
2759
  * The unique identifier for the task that you want to cancel.
2629
2760
  */
2630
- taskId: AuditMitigationActionsTaskId;
2761
+ taskId: MitigationActionsTaskId;
2631
2762
  }
2632
2763
  export interface CancelAuditMitigationActionsTaskResponse {
2633
2764
  }
@@ -2645,6 +2776,14 @@ declare namespace Iot {
2645
2776
  */
2646
2777
  certificateId: CertificateId;
2647
2778
  }
2779
+ export interface CancelDetectMitigationActionsTaskRequest {
2780
+ /**
2781
+ * The unique identifier of the task.
2782
+ */
2783
+ taskId: MitigationActionsTaskId;
2784
+ }
2785
+ export interface CancelDetectMitigationActionsTaskResponse {
2786
+ }
2648
2787
  export interface CancelJobExecutionRequest {
2649
2788
  /**
2650
2789
  * The ID of the job to be canceled.
@@ -2811,6 +2950,7 @@ declare namespace Iot {
2811
2950
  export interface ClearDefaultAuthorizerResponse {
2812
2951
  }
2813
2952
  export type ClientId = string;
2953
+ export type ClientProperties = {[key: string]: String};
2814
2954
  export type ClientRequestToken = string;
2815
2955
  export interface CloudwatchAlarmAction {
2816
2956
  /**
@@ -2899,8 +3039,9 @@ declare namespace Iot {
2899
3039
  }
2900
3040
  export type CognitoIdentityPoolId = string;
2901
3041
  export type Comment = string;
2902
- export type ComparisonOperator = "less-than"|"less-than-equals"|"greater-than"|"greater-than-equals"|"in-cidr-set"|"not-in-cidr-set"|"in-port-set"|"not-in-port-set"|string;
3042
+ export type ComparisonOperator = "less-than"|"less-than-equals"|"greater-than"|"greater-than-equals"|"in-cidr-set"|"not-in-cidr-set"|"in-port-set"|"not-in-port-set"|"in-set"|"not-in-set"|string;
2903
3043
  export type CompliantChecksCount = number;
3044
+ export type ConfidenceLevel = "LOW"|"MEDIUM"|"HIGH"|string;
2904
3045
  export interface Configuration {
2905
3046
  /**
2906
3047
  * True to enable the configuration.
@@ -3034,6 +3175,38 @@ declare namespace Iot {
3034
3175
  */
3035
3176
  certificatePem?: CertificatePem;
3036
3177
  }
3178
+ export interface CreateCustomMetricRequest {
3179
+ /**
3180
+ * The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws:. Cannot be updated once defined.
3181
+ */
3182
+ metricName: MetricName;
3183
+ /**
3184
+ * Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.
3185
+ */
3186
+ displayName?: CustomMetricDisplayName;
3187
+ /**
3188
+ * The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.
3189
+ */
3190
+ metricType: CustomMetricType;
3191
+ /**
3192
+ * Metadata that can be used to manage the custom metric.
3193
+ */
3194
+ tags?: TagList;
3195
+ /**
3196
+ * Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
3197
+ */
3198
+ clientRequestToken: ClientRequestToken;
3199
+ }
3200
+ export interface CreateCustomMetricResponse {
3201
+ /**
3202
+ * The name of the custom metric to be used in the metric report.
3203
+ */
3204
+ metricName?: MetricName;
3205
+ /**
3206
+ * The Amazon Resource Number (ARN) of the custom metric, e.g. arn:aws-partition:iot:region:accountId:custommetric/metricName
3207
+ */
3208
+ metricArn?: CustomMetricArn;
3209
+ }
3037
3210
  export interface CreateDimensionRequest {
3038
3211
  /**
3039
3212
  * A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.
@@ -3062,7 +3235,7 @@ declare namespace Iot {
3062
3235
  */
3063
3236
  name?: DimensionName;
3064
3237
  /**
3065
- * The ARN (Amazon resource name) of the created dimension.
3238
+ * The Amazon Resource Name (ARN) of the created dimension.
3066
3239
  */
3067
3240
  arn?: DimensionArn;
3068
3241
  }
@@ -3544,15 +3717,15 @@ declare namespace Iot {
3544
3717
  }
3545
3718
  export interface CreateScheduledAuditRequest {
3546
3719
  /**
3547
- * How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The start time of each audit is determined by the system.
3720
+ * How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY or MONTHLY. The start time of each audit is determined by the system.
3548
3721
  */
3549
3722
  frequency: AuditFrequency;
3550
3723
  /**
3551
- * The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
3724
+ * The day of the month on which the scheduled audit takes place. This can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to MONTHLY. If days 29 to 31 are specified, and the month doesn't have that many days, the audit takes place on the LAST day of the month.
3552
3725
  */
3553
3726
  dayOfMonth?: DayOfMonth;
3554
3727
  /**
3555
- * The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
3728
+ * The day of the week on which the scheduled audit takes place, either SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.
3556
3729
  */
3557
3730
  dayOfWeek?: DayOfWeek;
3558
3731
  /**
@@ -3592,11 +3765,11 @@ declare namespace Iot {
3592
3765
  */
3593
3766
  alertTargets?: AlertTargets;
3594
3767
  /**
3595
- * Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead. 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.
3768
+ * Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead. 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.
3596
3769
  */
3597
3770
  additionalMetricsToRetain?: AdditionalMetricsToRetainList;
3598
3771
  /**
3599
- * 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.
3772
+ * 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.
3600
3773
  */
3601
3774
  additionalMetricsToRetainV2?: AdditionalMetricsToRetainV2List;
3602
3775
  /**
@@ -3793,7 +3966,11 @@ declare namespace Iot {
3793
3966
  */
3794
3967
  signatureAlgorithm?: SignatureAlgorithm;
3795
3968
  }
3969
+ export type CustomMetricArn = string;
3970
+ export type CustomMetricDisplayName = string;
3971
+ export type CustomMetricType = "string-list"|"ip-address-list"|"number-list"|"number"|string;
3796
3972
  export type CustomerVersion = number;
3973
+ export type DataCollectionPercentage = number;
3797
3974
  export type DateType = Date;
3798
3975
  export type DayOfMonth = string;
3799
3976
  export type DayOfWeek = "SUN"|"MON"|"TUE"|"WED"|"THU"|"FRI"|"SAT"|string;
@@ -3852,6 +4029,14 @@ declare namespace Iot {
3852
4029
  */
3853
4030
  forceDelete?: ForceDelete;
3854
4031
  }
4032
+ export interface DeleteCustomMetricRequest {
4033
+ /**
4034
+ * The name of the custom metric.
4035
+ */
4036
+ metricName: MetricName;
4037
+ }
4038
+ export interface DeleteCustomMetricResponse {
4039
+ }
3855
4040
  export interface DeleteDimensionRequest {
3856
4041
  /**
3857
4042
  * The unique identifier for the dimension that you want to delete.
@@ -4127,7 +4312,7 @@ declare namespace Iot {
4127
4312
  /**
4128
4313
  * The unique identifier for the audit mitigation task.
4129
4314
  */
4130
- taskId: AuditMitigationActionsTaskId;
4315
+ taskId: MitigationActionsTaskId;
4131
4316
  }
4132
4317
  export interface DescribeAuditMitigationActionsTaskResponse {
4133
4318
  /**
@@ -4283,6 +4468,38 @@ declare namespace Iot {
4283
4468
  */
4284
4469
  certificateDescription?: CertificateDescription;
4285
4470
  }
4471
+ export interface DescribeCustomMetricRequest {
4472
+ /**
4473
+ * The name of the custom metric.
4474
+ */
4475
+ metricName: MetricName;
4476
+ }
4477
+ export interface DescribeCustomMetricResponse {
4478
+ /**
4479
+ * The name of the custom metric.
4480
+ */
4481
+ metricName?: MetricName;
4482
+ /**
4483
+ * The Amazon Resource Number (ARN) of the custom metric.
4484
+ */
4485
+ metricArn?: CustomMetricArn;
4486
+ /**
4487
+ * The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.
4488
+ */
4489
+ metricType?: CustomMetricType;
4490
+ /**
4491
+ * Field represents a friendly name in the console for the custom metric; doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.
4492
+ */
4493
+ displayName?: CustomMetricDisplayName;
4494
+ /**
4495
+ * The creation date of the custom metric in milliseconds since epoch.
4496
+ */
4497
+ creationDate?: Timestamp;
4498
+ /**
4499
+ * The time the custom metric was last modified in milliseconds since epoch.
4500
+ */
4501
+ lastModifiedDate?: Timestamp;
4502
+ }
4286
4503
  export interface DescribeDefaultAuthorizerRequest {
4287
4504
  }
4288
4505
  export interface DescribeDefaultAuthorizerResponse {
@@ -4291,6 +4508,18 @@ declare namespace Iot {
4291
4508
  */
4292
4509
  authorizerDescription?: AuthorizerDescription;
4293
4510
  }
4511
+ export interface DescribeDetectMitigationActionsTaskRequest {
4512
+ /**
4513
+ * The unique identifier of the task.
4514
+ */
4515
+ taskId: MitigationActionsTaskId;
4516
+ }
4517
+ export interface DescribeDetectMitigationActionsTaskResponse {
4518
+ /**
4519
+ * The description of a task.
4520
+ */
4521
+ taskSummary?: DetectMitigationActionsTaskSummary;
4522
+ }
4294
4523
  export interface DescribeDimensionRequest {
4295
4524
  /**
4296
4525
  * The unique identifier for the dimension.
@@ -4303,7 +4532,7 @@ declare namespace Iot {
4303
4532
  */
4304
4533
  name?: DimensionName;
4305
4534
  /**
4306
- * The ARN (Amazon resource name) for the dimension.
4535
+ * The Amazon Resource Name (ARN) for the dimension.
4307
4536
  */
4308
4537
  arn?: DimensionArn;
4309
4538
  /**
@@ -4587,15 +4816,15 @@ declare namespace Iot {
4587
4816
  }
4588
4817
  export interface DescribeScheduledAuditResponse {
4589
4818
  /**
4590
- * How often the scheduled audit takes place. One of "DAILY", "WEEKLY", "BIWEEKLY", or "MONTHLY". The start time of each audit is determined by the system.
4819
+ * How often the scheduled audit takes place, either one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.
4591
4820
  */
4592
4821
  frequency?: AuditFrequency;
4593
4822
  /**
4594
- * The day of the month on which the scheduled audit takes place. Will be "1" through "31" or "LAST". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
4823
+ * The day of the month on which the scheduled audit takes place. This is will be 1 through 31 or LAST. If days 29-31 are specified, and the month does not have that many days, the audit takes place on the LAST day of the month.
4595
4824
  */
4596
4825
  dayOfMonth?: DayOfMonth;
4597
4826
  /**
4598
- * The day of the week on which the scheduled audit takes place. One of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT".
4827
+ * The day of the week on which the scheduled audit takes place, either one of SUN, MON, TUE, WED, THU, FRI, or SAT.
4599
4828
  */
4600
4829
  dayOfWeek?: DayOfWeek;
4601
4830
  /**
@@ -4897,6 +5126,120 @@ declare namespace Iot {
4897
5126
  export type DetailsKey = string;
4898
5127
  export type DetailsMap = {[key: string]: DetailsValue};
4899
5128
  export type DetailsValue = string;
5129
+ export interface DetectMitigationActionExecution {
5130
+ /**
5131
+ * The unique identifier of the task.
5132
+ */
5133
+ taskId?: MitigationActionsTaskId;
5134
+ /**
5135
+ * The unique identifier of the violation.
5136
+ */
5137
+ violationId?: ViolationId;
5138
+ /**
5139
+ * The friendly name that uniquely identifies the mitigation action.
5140
+ */
5141
+ actionName?: MitigationActionName;
5142
+ /**
5143
+ * The name of the thing.
5144
+ */
5145
+ thingName?: DeviceDefenderThingName;
5146
+ /**
5147
+ * The date a mitigation action was started.
5148
+ */
5149
+ executionStartDate?: Timestamp;
5150
+ /**
5151
+ * The date a mitigation action ended.
5152
+ */
5153
+ executionEndDate?: Timestamp;
5154
+ /**
5155
+ * The status of a mitigation action.
5156
+ */
5157
+ status?: DetectMitigationActionExecutionStatus;
5158
+ /**
5159
+ * The error code of a mitigation action.
5160
+ */
5161
+ errorCode?: DetectMitigationActionExecutionErrorCode;
5162
+ /**
5163
+ * The message of a mitigation action.
5164
+ */
5165
+ message?: ErrorMessage;
5166
+ }
5167
+ export type DetectMitigationActionExecutionErrorCode = string;
5168
+ export type DetectMitigationActionExecutionList = DetectMitigationActionExecution[];
5169
+ export type DetectMitigationActionExecutionStatus = "IN_PROGRESS"|"SUCCESSFUL"|"FAILED"|"SKIPPED"|string;
5170
+ export interface DetectMitigationActionsTaskStatistics {
5171
+ /**
5172
+ * The actions that were performed.
5173
+ */
5174
+ actionsExecuted?: GenericLongValue;
5175
+ /**
5176
+ * The actions that were skipped.
5177
+ */
5178
+ actionsSkipped?: GenericLongValue;
5179
+ /**
5180
+ * The actions that failed.
5181
+ */
5182
+ actionsFailed?: GenericLongValue;
5183
+ }
5184
+ export type DetectMitigationActionsTaskStatus = "IN_PROGRESS"|"SUCCESSFUL"|"FAILED"|"CANCELED"|string;
5185
+ export interface DetectMitigationActionsTaskSummary {
5186
+ /**
5187
+ * The unique identifier of the task.
5188
+ */
5189
+ taskId?: MitigationActionsTaskId;
5190
+ /**
5191
+ * The status of the task.
5192
+ */
5193
+ taskStatus?: DetectMitigationActionsTaskStatus;
5194
+ /**
5195
+ * The date the task started.
5196
+ */
5197
+ taskStartTime?: Timestamp;
5198
+ /**
5199
+ * The date the task ended.
5200
+ */
5201
+ taskEndTime?: Timestamp;
5202
+ /**
5203
+ * Specifies the ML Detect findings to which the mitigation actions are applied.
5204
+ */
5205
+ target?: DetectMitigationActionsTaskTarget;
5206
+ /**
5207
+ * Specifies the time period of which violation events occurred between.
5208
+ */
5209
+ violationEventOccurrenceRange?: ViolationEventOccurrenceRange;
5210
+ /**
5211
+ * Includes only active violations.
5212
+ */
5213
+ onlyActiveViolationsIncluded?: PrimitiveBoolean;
5214
+ /**
5215
+ * Includes suppressed alerts.
5216
+ */
5217
+ suppressedAlertsIncluded?: PrimitiveBoolean;
5218
+ /**
5219
+ * The definition of the actions.
5220
+ */
5221
+ actionsDefinition?: MitigationActionList;
5222
+ /**
5223
+ * The statistics of a mitigation action task.
5224
+ */
5225
+ taskStatistics?: DetectMitigationActionsTaskStatistics;
5226
+ }
5227
+ export type DetectMitigationActionsTaskSummaryList = DetectMitigationActionsTaskSummary[];
5228
+ export interface DetectMitigationActionsTaskTarget {
5229
+ /**
5230
+ * The unique identifiers of the violations.
5231
+ */
5232
+ violationIds?: TargetViolationIdsForDetectMitigationActions;
5233
+ /**
5234
+ * The name of the security profile.
5235
+ */
5236
+ securityProfileName?: SecurityProfileName;
5237
+ /**
5238
+ * The name of the behavior.
5239
+ */
5240
+ behaviorName?: BehaviorName;
5241
+ }
5242
+ export type DetectMitigationActionsToExecuteList = MitigationActionName[];
4900
5243
  export type DeviceCertificateUpdateAction = "DEACTIVATE"|string;
4901
5244
  export type DeviceDefenderThingName = string;
4902
5245
  export type DimensionArn = string;
@@ -5032,11 +5375,11 @@ declare namespace Iot {
5032
5375
  export type ElasticsearchType = string;
5033
5376
  export interface EnableIoTLoggingParams {
5034
5377
  /**
5035
- * The ARN of the IAM role used for logging.
5378
+ * The Amazon Resource Name (ARN) of the IAM role used for logging.
5036
5379
  */
5037
5380
  roleArnForLogging: RoleArn;
5038
5381
  /**
5039
- * Specifies the types of information to be logged.
5382
+ * Specifies the type of information to be logged.
5040
5383
  */
5041
5384
  logLevel: LogLevel;
5042
5385
  }
@@ -5146,6 +5489,31 @@ declare namespace Iot {
5146
5489
  export type Forced = boolean;
5147
5490
  export type FunctionArn = string;
5148
5491
  export type GenerationId = string;
5492
+ export type GenericLongValue = number;
5493
+ export interface GetBehaviorModelTrainingSummariesRequest {
5494
+ /**
5495
+ * The name of the security profile.
5496
+ */
5497
+ securityProfileName?: SecurityProfileName;
5498
+ /**
5499
+ * The maximum number of results to return at one time. The default is 25.
5500
+ */
5501
+ maxResults?: TinyMaxResults;
5502
+ /**
5503
+ * The token for the next set of results.
5504
+ */
5505
+ nextToken?: NextToken;
5506
+ }
5507
+ export interface GetBehaviorModelTrainingSummariesResponse {
5508
+ /**
5509
+ * A list of all ML Detect behaviors and their model status for a given Security Profile.
5510
+ */
5511
+ summaries?: BehaviorModelTrainingSummaries;
5512
+ /**
5513
+ * A token that can be used to retrieve the next set of results, or null if there are no additional results.
5514
+ */
5515
+ nextToken?: NextToken;
5516
+ }
5149
5517
  export interface GetCardinalityRequest {
5150
5518
  /**
5151
5519
  * The name of the index to search.
@@ -5833,6 +6201,28 @@ declare namespace Iot {
5833
6201
  export type JobSummaryList = JobSummary[];
5834
6202
  export type JobTargets = TargetArn[];
5835
6203
  export type JsonDocument = string;
6204
+ export interface KafkaAction {
6205
+ /**
6206
+ * The ARN of Kafka action's VPC TopicRuleDestination.
6207
+ */
6208
+ destinationArn: AwsArn;
6209
+ /**
6210
+ * The Kafka topic for messages to be sent to the Kafka broker.
6211
+ */
6212
+ topic: String;
6213
+ /**
6214
+ * The Kafka message key.
6215
+ */
6216
+ key?: String;
6217
+ /**
6218
+ * The Kafka message partition.
6219
+ */
6220
+ partition?: String;
6221
+ /**
6222
+ * Properties of the Apache Kafka producer client.
6223
+ */
6224
+ clientProperties: ClientProperties;
6225
+ }
5836
6226
  export type Key = string;
5837
6227
  export type KeyName = string;
5838
6228
  export interface KeyPair {
@@ -5868,6 +6258,7 @@ declare namespace Iot {
5868
6258
  }
5869
6259
  export type LaserMaxResults = number;
5870
6260
  export type LastModifiedDate = Date;
6261
+ export type LastUpdatedAtDate = Date;
5871
6262
  export interface ListActiveViolationsRequest {
5872
6263
  /**
5873
6264
  * The name of the thing whose active violations are listed.
@@ -5877,6 +6268,14 @@ declare namespace Iot {
5877
6268
  * The name of the Device Defender security profile for which violations are listed.
5878
6269
  */
5879
6270
  securityProfileName?: SecurityProfileName;
6271
+ /**
6272
+ * The criteria for a behavior.
6273
+ */
6274
+ behaviorCriteriaType?: BehaviorCriteriaType;
6275
+ /**
6276
+ * A list of all suppressed alerts.
6277
+ */
6278
+ listSuppressedAlerts?: ListSuppressedAlerts;
5880
6279
  /**
5881
6280
  * The token for the next set of results.
5882
6281
  */
@@ -5972,7 +6371,7 @@ declare namespace Iot {
5972
6371
  /**
5973
6372
  * Specify this filter to limit results to actions for a specific audit mitigation actions task.
5974
6373
  */
5975
- taskId: AuditMitigationActionsTaskId;
6374
+ taskId: MitigationActionsTaskId;
5976
6375
  /**
5977
6376
  * Specify this filter to limit results to those with a specific status.
5978
6377
  */
@@ -6230,6 +6629,94 @@ declare namespace Iot {
6230
6629
  */
6231
6630
  nextMarker?: Marker;
6232
6631
  }
6632
+ export interface ListCustomMetricsRequest {
6633
+ /**
6634
+ * The token for the next set of results.
6635
+ */
6636
+ nextToken?: NextToken;
6637
+ /**
6638
+ * The maximum number of results to return at one time. The default is 25.
6639
+ */
6640
+ maxResults?: MaxResults;
6641
+ }
6642
+ export interface ListCustomMetricsResponse {
6643
+ /**
6644
+ * The name of the custom metric.
6645
+ */
6646
+ metricNames?: MetricNames;
6647
+ /**
6648
+ * A token that can be used to retrieve the next set of results, or null if there are no additional results.
6649
+ */
6650
+ nextToken?: NextToken;
6651
+ }
6652
+ export interface ListDetectMitigationActionsExecutionsRequest {
6653
+ /**
6654
+ * The unique identifier of the task.
6655
+ */
6656
+ taskId?: MitigationActionsTaskId;
6657
+ /**
6658
+ * The unique identifier of the violation.
6659
+ */
6660
+ violationId?: ViolationId;
6661
+ /**
6662
+ * The name of the thing whose mitigation actions are listed.
6663
+ */
6664
+ thingName?: DeviceDefenderThingName;
6665
+ /**
6666
+ * A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.
6667
+ */
6668
+ startTime?: Timestamp;
6669
+ /**
6670
+ * The end of the time period for which ML Detect mitigation actions executions are returned.
6671
+ */
6672
+ endTime?: Timestamp;
6673
+ /**
6674
+ * The maximum number of results to return at one time. The default is 25.
6675
+ */
6676
+ maxResults?: MaxResults;
6677
+ /**
6678
+ * The token for the next set of results.
6679
+ */
6680
+ nextToken?: NextToken;
6681
+ }
6682
+ export interface ListDetectMitigationActionsExecutionsResponse {
6683
+ /**
6684
+ * List of actions executions.
6685
+ */
6686
+ actionsExecutions?: DetectMitigationActionExecutionList;
6687
+ /**
6688
+ * A token that can be used to retrieve the next set of results, or null if there are no additional results.
6689
+ */
6690
+ nextToken?: NextToken;
6691
+ }
6692
+ export interface ListDetectMitigationActionsTasksRequest {
6693
+ /**
6694
+ * The maximum number of results to return at one time. The default is 25.
6695
+ */
6696
+ maxResults?: MaxResults;
6697
+ /**
6698
+ * The token for the next set of results.
6699
+ */
6700
+ nextToken?: NextToken;
6701
+ /**
6702
+ * A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.
6703
+ */
6704
+ startTime: Timestamp;
6705
+ /**
6706
+ * The end of the time period for which ML Detect mitigation actions tasks are returned.
6707
+ */
6708
+ endTime: Timestamp;
6709
+ }
6710
+ export interface ListDetectMitigationActionsTasksResponse {
6711
+ /**
6712
+ * The collection of ML Detect mitigation tasks that matched the filter criteria.
6713
+ */
6714
+ tasks?: DetectMitigationActionsTaskSummaryList;
6715
+ /**
6716
+ * A token that can be used to retrieve the next set of results, or null if there are no additional results.
6717
+ */
6718
+ nextToken?: NextToken;
6719
+ }
6233
6720
  export interface ListDimensionsRequest {
6234
6721
  /**
6235
6722
  * The token for the next set of results.
@@ -6708,9 +7195,13 @@ declare namespace Iot {
6708
7195
  */
6709
7196
  maxResults?: MaxResults;
6710
7197
  /**
6711
- * A filter to limit results to the security profiles that use the defined dimension.
7198
+ * A filter to limit results to the security profiles that use the defined dimension. Cannot be used with metricName
6712
7199
  */
6713
7200
  dimensionName?: DimensionName;
7201
+ /**
7202
+ * The name of the custom metric. Cannot be used with dimensionName.
7203
+ */
7204
+ metricName?: MetricName;
6714
7205
  }
6715
7206
  export interface ListSecurityProfilesResponse {
6716
7207
  /**
@@ -6746,6 +7237,7 @@ declare namespace Iot {
6746
7237
  */
6747
7238
  nextToken?: NextToken;
6748
7239
  }
7240
+ export type ListSuppressedAlerts = boolean;
6749
7241
  export type ListSuppressedFindings = boolean;
6750
7242
  export interface ListTagsForResourceRequest {
6751
7243
  /**
@@ -7148,6 +7640,14 @@ declare namespace Iot {
7148
7640
  * A filter to limit results to those alerts generated by the specified security profile.
7149
7641
  */
7150
7642
  securityProfileName?: SecurityProfileName;
7643
+ /**
7644
+ * The criteria for a behavior.
7645
+ */
7646
+ behaviorCriteriaType?: BehaviorCriteriaType;
7647
+ /**
7648
+ * A list of all suppressed alerts.
7649
+ */
7650
+ listSuppressedAlerts?: ListSuppressedAlerts;
7151
7651
  /**
7152
7652
  * The token for the next set of results.
7153
7653
  */
@@ -7202,6 +7702,12 @@ declare namespace Iot {
7202
7702
  */
7203
7703
  logLevel?: LogLevel;
7204
7704
  }
7705
+ export interface MachineLearningDetectionConfig {
7706
+ /**
7707
+ * The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.
7708
+ */
7709
+ confidenceLevel: ConfidenceLevel;
7710
+ }
7205
7711
  export type Marker = string;
7206
7712
  export type MaxJobExecutionsPerMin = number;
7207
7713
  export type MaxResults = number;
@@ -7220,13 +7726,15 @@ declare namespace Iot {
7220
7726
  */
7221
7727
  operator?: DimensionValueOperator;
7222
7728
  }
7729
+ export type MetricName = string;
7730
+ export type MetricNames = MetricName[];
7223
7731
  export interface MetricToRetain {
7224
7732
  /**
7225
7733
  * What is measured by the behavior.
7226
7734
  */
7227
7735
  metric: BehaviorMetric;
7228
7736
  /**
7229
- * The dimension of a metric.
7737
+ * The dimension of a metric. This can't be used with custom metrics.
7230
7738
  */
7231
7739
  metricDimension?: MetricDimension;
7232
7740
  }
@@ -7243,6 +7751,18 @@ declare namespace Iot {
7243
7751
  * If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.
7244
7752
  */
7245
7753
  ports?: Ports;
7754
+ /**
7755
+ * The numeral value of a metric.
7756
+ */
7757
+ number?: Number;
7758
+ /**
7759
+ * The numeral values of a metric.
7760
+ */
7761
+ numbers?: NumberList;
7762
+ /**
7763
+ * The string values of a metric.
7764
+ */
7765
+ strings?: StringList;
7246
7766
  }
7247
7767
  export type Minimum = number;
7248
7768
  export type MinimumNumberOfExecutedThings = number;
@@ -7308,11 +7828,13 @@ declare namespace Iot {
7308
7828
  */
7309
7829
  enableIoTLoggingParams?: EnableIoTLoggingParams;
7310
7830
  /**
7311
- * Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.
7831
+ * Parameters to define a mitigation action that publishes findings to Amazon Simple Notification Service (Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.
7312
7832
  */
7313
7833
  publishFindingToSnsParams?: PublishFindingToSnsParams;
7314
7834
  }
7315
7835
  export type MitigationActionType = "UPDATE_DEVICE_CERTIFICATE"|"UPDATE_CA_CERTIFICATE"|"ADD_THINGS_TO_THING_GROUP"|"REPLACE_DEFAULT_POLICY_VERSION"|"ENABLE_IOT_LOGGING"|"PUBLISH_FINDING_TO_SNS"|string;
7836
+ export type MitigationActionsTaskId = string;
7837
+ export type ModelStatus = "PENDING_BUILD"|"ACTIVE"|"EXPIRED"|string;
7316
7838
  export type MqttClientId = string;
7317
7839
  export interface MqttContext {
7318
7840
  /**
@@ -7348,6 +7870,9 @@ declare namespace Iot {
7348
7870
  additionalInfo?: StringMap;
7349
7871
  }
7350
7872
  export type NonCompliantResourcesCount = number;
7873
+ export type NullableBoolean = boolean;
7874
+ export type Number = number;
7875
+ export type NumberList = Number[];
7351
7876
  export type NumberOfThings = number;
7352
7877
  export type OTAUpdateArn = string;
7353
7878
  export type OTAUpdateDescription = string;
@@ -7572,6 +8097,7 @@ declare namespace Iot {
7572
8097
  */
7573
8098
  expiresInSec?: ExpiresInSec;
7574
8099
  }
8100
+ export type PrimitiveBoolean = boolean;
7575
8101
  export type Principal = string;
7576
8102
  export type PrincipalArn = string;
7577
8103
  export type PrincipalId = string;
@@ -8115,11 +8641,13 @@ declare namespace Iot {
8115
8641
  }
8116
8642
  export type SearchableAttributes = AttributeName[];
8117
8643
  export type Seconds = number;
8644
+ export type SecurityGroupId = string;
8645
+ export type SecurityGroupList = SecurityGroupId[];
8118
8646
  export type SecurityProfileArn = string;
8119
8647
  export type SecurityProfileDescription = string;
8120
8648
  export interface SecurityProfileIdentifier {
8121
8649
  /**
8122
- * The name you have given to the security profile.
8650
+ * The name you've given to the security profile.
8123
8651
  */
8124
8652
  name: SecurityProfileName;
8125
8653
  /**
@@ -8296,9 +8824,9 @@ declare namespace Iot {
8296
8824
  /**
8297
8825
  * A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.
8298
8826
  */
8299
- taskId: AuditMitigationActionsTaskId;
8827
+ taskId: MitigationActionsTaskId;
8300
8828
  /**
8301
- * Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a speecific set of findings.
8829
+ * Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a specific set of findings.
8302
8830
  */
8303
8831
  target: AuditMitigationActionsTaskTarget;
8304
8832
  /**
@@ -8314,7 +8842,43 @@ declare namespace Iot {
8314
8842
  /**
8315
8843
  * The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.
8316
8844
  */
8317
- taskId?: AuditMitigationActionsTaskId;
8845
+ taskId?: MitigationActionsTaskId;
8846
+ }
8847
+ export interface StartDetectMitigationActionsTaskRequest {
8848
+ /**
8849
+ * The unique identifier of the task.
8850
+ */
8851
+ taskId: MitigationActionsTaskId;
8852
+ /**
8853
+ * Specifies the ML Detect findings to which the mitigation actions are applied.
8854
+ */
8855
+ target: DetectMitigationActionsTaskTarget;
8856
+ /**
8857
+ * The actions to be performed when a device has unexpected behavior.
8858
+ */
8859
+ actions: DetectMitigationActionsToExecuteList;
8860
+ /**
8861
+ * Specifies the time period of which violation events occurred between.
8862
+ */
8863
+ violationEventOccurrenceRange?: ViolationEventOccurrenceRange;
8864
+ /**
8865
+ * Specifies to list only active violations.
8866
+ */
8867
+ includeOnlyActiveViolations?: NullableBoolean;
8868
+ /**
8869
+ * Specifies to include suppressed alerts.
8870
+ */
8871
+ includeSuppressedAlerts?: NullableBoolean;
8872
+ /**
8873
+ * 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, AWS SDKs will automatically generate a unique client request.
8874
+ */
8875
+ clientRequestToken: ClientRequestToken;
8876
+ }
8877
+ export interface StartDetectMitigationActionsTaskResponse {
8878
+ /**
8879
+ * The unique identifier of the task.
8880
+ */
8881
+ taskId?: MitigationActionsTaskId;
8318
8882
  }
8319
8883
  export interface StartOnDemandAuditTaskRequest {
8320
8884
  /**
@@ -8371,7 +8935,7 @@ declare namespace Iot {
8371
8935
  export type StateValue = string;
8372
8936
  export interface StatisticalThreshold {
8373
8937
  /**
8374
- * The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.
8938
+ * The percentile that resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.
8375
8939
  */
8376
8940
  statistic?: EvaluationStatistic;
8377
8941
  }
@@ -8513,11 +9077,15 @@ declare namespace Iot {
8513
9077
  export type StreamVersion = number;
8514
9078
  export type StreamsSummary = StreamSummary[];
8515
9079
  export type String = string;
9080
+ export type StringList = stringValue[];
8516
9081
  export type StringMap = {[key: string]: String};
9082
+ export type SubnetId = string;
9083
+ export type SubnetIdList = SubnetId[];
8517
9084
  export type SucceededFindingsCount = number;
8518
9085
  export type SucceededThings = number;
8519
9086
  export type Sum = number;
8520
9087
  export type SumOfSquares = number;
9088
+ export type SuppressAlerts = boolean;
8521
9089
  export type SuppressIndefinitely = boolean;
8522
9090
  export type SuppressedNonCompliantResourcesCount = number;
8523
9091
  export type TableName = string;
@@ -8551,6 +9119,7 @@ declare namespace Iot {
8551
9119
  export type TargetArn = string;
8552
9120
  export type TargetAuditCheckNames = AuditCheckName[];
8553
9121
  export type TargetSelection = "CONTINUOUS"|"SNAPSHOT"|string;
9122
+ export type TargetViolationIdsForDetectMitigationActions = ViolationId[];
8554
9123
  export type Targets = Target[];
8555
9124
  export type TaskId = string;
8556
9125
  export type TaskIdList = TaskId[];
@@ -8953,6 +9522,7 @@ declare namespace Iot {
8953
9522
  }
8954
9523
  export type TimestreamTimestampUnit = string;
8955
9524
  export type TimestreamTimestampValue = string;
9525
+ export type TinyMaxResults = number;
8956
9526
  export interface TlsContext {
8957
9527
  /**
8958
9528
  * The value of the serverName key in a TLS authorization request.
@@ -9007,6 +9577,14 @@ declare namespace Iot {
9007
9577
  * The status of the topic rule destination. Valid values are: IN_PROGRESS A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint. ENABLED Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination. DISABLED Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination. ERROR Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
9008
9578
  */
9009
9579
  status?: TopicRuleDestinationStatus;
9580
+ /**
9581
+ * The date and time when the topic rule destination was created.
9582
+ */
9583
+ createdAt?: CreatedAtDate;
9584
+ /**
9585
+ * The date and time when the topic rule destination was last updated.
9586
+ */
9587
+ lastUpdatedAt?: LastUpdatedAtDate;
9010
9588
  /**
9011
9589
  * Additional details or reason why the topic rule destination is in the current status.
9012
9590
  */
@@ -9015,15 +9593,23 @@ declare namespace Iot {
9015
9593
  * Properties of the HTTP URL.
9016
9594
  */
9017
9595
  httpUrlProperties?: HttpUrlDestinationProperties;
9596
+ /**
9597
+ * Properties of the virtual private cloud (VPC) connection.
9598
+ */
9599
+ vpcProperties?: VpcDestinationProperties;
9018
9600
  }
9019
9601
  export interface TopicRuleDestinationConfiguration {
9020
9602
  /**
9021
9603
  * Configuration of the HTTP URL.
9022
9604
  */
9023
9605
  httpUrlConfiguration?: HttpUrlDestinationConfiguration;
9606
+ /**
9607
+ * Configuration of the virtual private cloud (VPC) connection.
9608
+ */
9609
+ vpcConfiguration?: VpcDestinationConfiguration;
9024
9610
  }
9025
9611
  export type TopicRuleDestinationMaxResults = number;
9026
- export type TopicRuleDestinationStatus = "ENABLED"|"IN_PROGRESS"|"DISABLED"|"ERROR"|string;
9612
+ export type TopicRuleDestinationStatus = "ENABLED"|"IN_PROGRESS"|"DISABLED"|"ERROR"|"DELETING"|string;
9027
9613
  export type TopicRuleDestinationSummaries = TopicRuleDestinationSummary[];
9028
9614
  export interface TopicRuleDestinationSummary {
9029
9615
  /**
@@ -9034,6 +9620,14 @@ declare namespace Iot {
9034
9620
  * The status of the topic rule destination. Valid values are: IN_PROGRESS A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint. ENABLED Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination. DISABLED Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination. ERROR Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
9035
9621
  */
9036
9622
  status?: TopicRuleDestinationStatus;
9623
+ /**
9624
+ * The date and time when the topic rule destination was created.
9625
+ */
9626
+ createdAt?: CreatedAtDate;
9627
+ /**
9628
+ * The date and time when the topic rule destination was last updated.
9629
+ */
9630
+ lastUpdatedAt?: LastUpdatedAtDate;
9037
9631
  /**
9038
9632
  * The reason the topic rule destination is in the current status.
9039
9633
  */
@@ -9042,6 +9636,10 @@ declare namespace Iot {
9042
9636
  * Information about the HTTP URL.
9043
9637
  */
9044
9638
  httpUrlSummary?: HttpUrlDestinationSummary;
9639
+ /**
9640
+ * Information about the virtual private cloud (VPC) connection.
9641
+ */
9642
+ vpcDestinationSummary?: VpcDestinationSummary;
9045
9643
  }
9046
9644
  export type TopicRuleList = TopicRuleListItem[];
9047
9645
  export interface TopicRuleListItem {
@@ -9154,7 +9752,7 @@ declare namespace Iot {
9154
9752
  }
9155
9753
  export interface UpdateAccountAuditConfigurationRequest {
9156
9754
  /**
9157
- * The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit.
9755
+ * The Amazon Resource Name (ARN) of the role that grants permission to AWS IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.
9158
9756
  */
9159
9757
  roleArn?: RoleArn;
9160
9758
  /**
@@ -9162,7 +9760,7 @@ declare namespace Iot {
9162
9760
  */
9163
9761
  auditNotificationTargetConfigurations?: AuditNotificationTargetConfigurations;
9164
9762
  /**
9165
- * Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are currently enabled. Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted. You cannot disable a check if it is used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself. On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.
9763
+ * Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are currently enabled. Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted. You cannot disable a check if it's used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself. On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.
9166
9764
  */
9167
9765
  auditCheckConfigurations?: AuditCheckConfigurations;
9168
9766
  }
@@ -9240,7 +9838,7 @@ declare namespace Iot {
9240
9838
  }
9241
9839
  export interface UpdateCACertificateParams {
9242
9840
  /**
9243
- * The action that you want to apply to the CA cerrtificate. The only supported value is DEACTIVATE.
9841
+ * The action that you want to apply to the CA certificate. The only supported value is DEACTIVATE.
9244
9842
  */
9245
9843
  action: CACertificateUpdateAction;
9246
9844
  }
@@ -9276,9 +9874,45 @@ declare namespace Iot {
9276
9874
  */
9277
9875
  newStatus: CertificateStatus;
9278
9876
  }
9877
+ export interface UpdateCustomMetricRequest {
9878
+ /**
9879
+ * The name of the custom metric. Cannot be updated.
9880
+ */
9881
+ metricName: MetricName;
9882
+ /**
9883
+ * Field represents a friendly name in the console for the custom metric, it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.
9884
+ */
9885
+ displayName: CustomMetricDisplayName;
9886
+ }
9887
+ export interface UpdateCustomMetricResponse {
9888
+ /**
9889
+ * The name of the custom metric.
9890
+ */
9891
+ metricName?: MetricName;
9892
+ /**
9893
+ * The Amazon Resource Number (ARN) of the custom metric.
9894
+ */
9895
+ metricArn?: CustomMetricArn;
9896
+ /**
9897
+ * The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.
9898
+ */
9899
+ metricType?: CustomMetricType;
9900
+ /**
9901
+ * A friendly name in the console for the custom metric
9902
+ */
9903
+ displayName?: CustomMetricDisplayName;
9904
+ /**
9905
+ * The creation date of the custom metric in milliseconds since epoch.
9906
+ */
9907
+ creationDate?: Timestamp;
9908
+ /**
9909
+ * The time the custom metric was last modified in milliseconds since epoch.
9910
+ */
9911
+ lastModifiedDate?: Timestamp;
9912
+ }
9279
9913
  export interface UpdateDeviceCertificateParams {
9280
9914
  /**
9281
- * The action that you want to apply to the device cerrtificate. The only supported value is DEACTIVATE.
9915
+ * The action that you want to apply to the device certificate. The only supported value is DEACTIVATE.
9282
9916
  */
9283
9917
  action: DeviceCertificateUpdateAction;
9284
9918
  }
@@ -9298,7 +9932,7 @@ declare namespace Iot {
9298
9932
  */
9299
9933
  name?: DimensionName;
9300
9934
  /**
9301
- * The ARN (Amazon resource name) of the created dimension.
9935
+ * The Amazon Resource Name (ARN)of the created dimension.
9302
9936
  */
9303
9937
  arn?: DimensionArn;
9304
9938
  /**
@@ -9430,7 +10064,7 @@ declare namespace Iot {
9430
10064
  }
9431
10065
  export interface UpdateMitigationActionRequest {
9432
10066
  /**
9433
- * The friendly name for the mitigation action. You can't change the name by using UpdateMitigationAction. Instead, you must delete and re-create the mitigation action with the new name.
10067
+ * The friendly name for the mitigation action. You cannot change the name by using UpdateMitigationAction. Instead, you must delete and recreate the mitigation action with the new name.
9434
10068
  */
9435
10069
  actionName: MitigationActionName;
9436
10070
  /**
@@ -9510,15 +10144,15 @@ declare namespace Iot {
9510
10144
  }
9511
10145
  export interface UpdateScheduledAuditRequest {
9512
10146
  /**
9513
- * How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY", or "MONTHLY". The start time of each audit is determined by the system.
10147
+ * How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.
9514
10148
  */
9515
10149
  frequency?: AuditFrequency;
9516
10150
  /**
9517
- * The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
10151
+ * The day of the month on which the scheduled audit takes place. This can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY. If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
9518
10152
  */
9519
10153
  dayOfMonth?: DayOfMonth;
9520
10154
  /**
9521
- * The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
10155
+ * The day of the week on which the scheduled audit takes place. This can be one of SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the "frequency" parameter is set to WEEKLY or BIWEEKLY.
9522
10156
  */
9523
10157
  dayOfWeek?: DayOfWeek;
9524
10158
  /**
@@ -9554,11 +10188,11 @@ declare namespace Iot {
9554
10188
  */
9555
10189
  alertTargets?: AlertTargets;
9556
10190
  /**
9557
- * Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead. 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.
10191
+ * Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead. 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.
9558
10192
  */
9559
10193
  additionalMetricsToRetain?: AdditionalMetricsToRetainList;
9560
10194
  /**
9561
- * 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.
10195
+ * 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.
9562
10196
  */
9563
10197
  additionalMetricsToRetainV2?: AdditionalMetricsToRetainV2List;
9564
10198
  /**
@@ -9604,7 +10238,7 @@ declare namespace Iot {
9604
10238
  */
9605
10239
  additionalMetricsToRetain?: AdditionalMetricsToRetainList;
9606
10240
  /**
9607
- * 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.
10241
+ * 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.
9608
10242
  */
9609
10243
  additionalMetricsToRetainV2?: AdditionalMetricsToRetainV2List;
9610
10244
  /**
@@ -9776,13 +10410,17 @@ declare namespace Iot {
9776
10410
  */
9777
10411
  securityProfileName?: SecurityProfileName;
9778
10412
  /**
9779
- * The behavior which was violated.
10413
+ * The behavior that was violated.
9780
10414
  */
9781
10415
  behavior?: Behavior;
9782
10416
  /**
9783
10417
  * The value of the metric (the measurement).
9784
10418
  */
9785
10419
  metricValue?: MetricValue;
10420
+ /**
10421
+ * The details of a violation event.
10422
+ */
10423
+ violationEventAdditionalInfo?: ViolationEventAdditionalInfo;
9786
10424
  /**
9787
10425
  * The type of violation event.
9788
10426
  */
@@ -9792,10 +10430,82 @@ declare namespace Iot {
9792
10430
  */
9793
10431
  violationEventTime?: Timestamp;
9794
10432
  }
10433
+ export interface ViolationEventAdditionalInfo {
10434
+ /**
10435
+ * The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.
10436
+ */
10437
+ confidenceLevel?: ConfidenceLevel;
10438
+ }
10439
+ export interface ViolationEventOccurrenceRange {
10440
+ /**
10441
+ * The start date and time of a time period in which violation events occurred.
10442
+ */
10443
+ startTime: Timestamp;
10444
+ /**
10445
+ * The end date and time of a time period in which violation events occurred.
10446
+ */
10447
+ endTime: Timestamp;
10448
+ }
9795
10449
  export type ViolationEventType = "in-alarm"|"alarm-cleared"|"alarm-invalidated"|string;
9796
10450
  export type ViolationEvents = ViolationEvent[];
9797
10451
  export type ViolationId = string;
10452
+ export interface VpcDestinationConfiguration {
10453
+ /**
10454
+ * The subnet IDs of the VPC destination.
10455
+ */
10456
+ subnetIds: SubnetIdList;
10457
+ /**
10458
+ * The security groups of the VPC destination.
10459
+ */
10460
+ securityGroups?: SecurityGroupList;
10461
+ /**
10462
+ * The ID of the VPC.
10463
+ */
10464
+ vpcId: VpcId;
10465
+ /**
10466
+ * The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
10467
+ */
10468
+ roleArn: AwsArn;
10469
+ }
10470
+ export interface VpcDestinationProperties {
10471
+ /**
10472
+ * The subnet IDs of the VPC destination.
10473
+ */
10474
+ subnetIds?: SubnetIdList;
10475
+ /**
10476
+ * The security groups of the VPC destination.
10477
+ */
10478
+ securityGroups?: SecurityGroupList;
10479
+ /**
10480
+ * The ID of the VPC.
10481
+ */
10482
+ vpcId?: VpcId;
10483
+ /**
10484
+ * The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
10485
+ */
10486
+ roleArn?: AwsArn;
10487
+ }
10488
+ export interface VpcDestinationSummary {
10489
+ /**
10490
+ * The subnet IDs of the VPC destination.
10491
+ */
10492
+ subnetIds?: SubnetIdList;
10493
+ /**
10494
+ * The security groups of the VPC destination.
10495
+ */
10496
+ securityGroups?: SecurityGroupList;
10497
+ /**
10498
+ * The ID of the VPC.
10499
+ */
10500
+ vpcId?: VpcId;
10501
+ /**
10502
+ * The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
10503
+ */
10504
+ roleArn?: AwsArn;
10505
+ }
10506
+ export type VpcId = string;
9798
10507
  export type WaitingForDataCollectionChecksCount = number;
10508
+ export type stringValue = string;
9799
10509
  /**
9800
10510
  * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
9801
10511
  */