@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
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.GetPackageVersionResponseFilterSensitiveLog = exports.GetPackageResponseFilterSensitiveLog = exports.DetectMitigationActionExecutionStatus = exports.BehaviorCriteriaType = exports.NotConfiguredException = exports.ThingIndexingMode = exports.ThingConnectivityIndexingMode = exports.NamedShadowIndexingMode = exports.DeviceDefenderIndexingMode = exports.ThingGroupIndexingMode = exports.FieldType = exports.ModelStatus = exports.Status = exports.DynamicGroupStatus = exports.MitigationActionType = exports.JobExecutionStatus = exports.JobStatus = exports.IndexStatus = exports.EventType = exports.ServerCertificateStatus = exports.DomainType = exports.DomainConfigurationStatus = exports.DetectMitigationActionsTaskStatus = exports.CertificateStatus = exports.CACertificateStatus = exports.CertificateMode = exports.LogTargetType = void 0;
|
|
3
|
+
exports.GetPackageVersionResponseFilterSensitiveLog = exports.GetPackageResponseFilterSensitiveLog = exports.DetectMitigationActionExecutionStatus = exports.BehaviorCriteriaType = exports.NotConfiguredException = exports.ThingIndexingMode = exports.ThingConnectivityIndexingMode = exports.NamedShadowIndexingMode = exports.TargetFieldOrder = exports.DeviceDefenderIndexingMode = exports.ThingGroupIndexingMode = exports.FieldType = exports.ModelStatus = exports.Status = exports.DynamicGroupStatus = exports.MitigationActionType = exports.JobExecutionStatus = exports.JobStatus = exports.IndexStatus = exports.EventType = exports.ServerCertificateStatus = exports.DomainType = exports.DomainConfigurationStatus = exports.DetectMitigationActionsTaskStatus = exports.CertificateStatus = exports.CACertificateStatus = exports.CertificateMode = exports.LogTargetType = void 0;
|
|
4
4
|
const smithy_client_1 = require("@smithy/smithy-client");
|
|
5
5
|
const IoTServiceException_1 = require("./IoTServiceException");
|
|
6
6
|
exports.LogTargetType = {
|
|
@@ -120,6 +120,10 @@ exports.DeviceDefenderIndexingMode = {
|
|
|
120
120
|
OFF: "OFF",
|
|
121
121
|
VIOLATIONS: "VIOLATIONS",
|
|
122
122
|
};
|
|
123
|
+
exports.TargetFieldOrder = {
|
|
124
|
+
LatLon: "LatLon",
|
|
125
|
+
LonLat: "LonLat",
|
|
126
|
+
};
|
|
123
127
|
exports.NamedShadowIndexingMode = {
|
|
124
128
|
OFF: "OFF",
|
|
125
129
|
ON: "ON",
|
|
@@ -117,6 +117,10 @@ export const DeviceDefenderIndexingMode = {
|
|
|
117
117
|
OFF: "OFF",
|
|
118
118
|
VIOLATIONS: "VIOLATIONS",
|
|
119
119
|
};
|
|
120
|
+
export const TargetFieldOrder = {
|
|
121
|
+
LatLon: "LatLon",
|
|
122
|
+
LonLat: "LonLat",
|
|
123
|
+
};
|
|
120
124
|
export const NamedShadowIndexingMode = {
|
|
121
125
|
OFF: "OFF",
|
|
122
126
|
ON: "ON",
|
|
@@ -24,7 +24,7 @@ export interface AttachSecurityProfileCommandOutput extends AttachSecurityProfil
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Associates a Device Defender security profile with a thing group or this account. Each
|
|
27
|
-
*
|
|
27
|
+
* thing group or account can have up to five security profiles associated with it.</p>
|
|
28
28
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">AttachSecurityProfile</a> action.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,8 +23,9 @@ export interface CancelAuditMitigationActionsTaskCommandOutput extends CancelAud
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Cancels a mitigation action task that is in progress. If the task
|
|
27
|
-
*
|
|
26
|
+
* <p>Cancels a mitigation action task that is in progress. If the task
|
|
27
|
+
* is not
|
|
28
|
+
* in progress, an InvalidRequestException occurs.</p>
|
|
28
29
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CancelAuditMitigationActionsTask</a> action.</p>
|
|
29
30
|
* @example
|
|
30
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,8 +23,7 @@ export interface CancelAuditTaskCommandOutput extends CancelAuditTaskResponse, _
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Cancels an audit that is in progress. The audit can be either scheduled or on demand. If
|
|
27
|
-
* the audit isn't in progress, an "InvalidRequestException" occurs.</p>
|
|
26
|
+
* <p>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.</p>
|
|
28
27
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CancelAuditTask</a> action.</p>
|
|
29
28
|
* @example
|
|
30
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,7 +23,9 @@ export interface CancelDetectMitigationActionsTaskCommandOutput extends CancelDe
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>
|
|
26
|
+
* <p>
|
|
27
|
+
* Cancels a Device Defender ML Detect mitigation action.
|
|
28
|
+
* </p>
|
|
27
29
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CancelDetectMitigationActionsTask</a> action.</p>
|
|
28
30
|
* @example
|
|
29
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,7 +23,10 @@ export interface CreateCustomMetricCommandOutput extends CreateCustomMetricRespo
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p> Use this API to define a
|
|
26
|
+
* <p> Use this API to define a
|
|
27
|
+
* Custom
|
|
28
|
+
* Metric
|
|
29
|
+
* published by your devices to Device Defender. </p>
|
|
27
30
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateCustomMetric</a> action.</p>
|
|
28
31
|
* @example
|
|
29
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,10 +23,8 @@ export interface CreateDimensionCommandOutput extends CreateDimensionResponse, _
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Create a dimension that you can use to limit the scope of a metric used in a security
|
|
27
|
-
*
|
|
28
|
-
* down the scope of the metric only to MQTT topics whose name match the pattern specified in the
|
|
29
|
-
* dimension.</p>
|
|
26
|
+
* <p>Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender.
|
|
27
|
+
* For example, using a <code>TOPIC_FILTER</code> dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.</p>
|
|
30
28
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateDimension</a> action.</p>
|
|
31
29
|
* @example
|
|
32
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,10 +23,8 @@ export interface CreateMitigationActionCommandOutput extends CreateMitigationAct
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Defines an action that can be applied to audit findings by using
|
|
27
|
-
*
|
|
28
|
-
* specific check names. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-mitigation-actions.html">Mitigation
|
|
29
|
-
* actions</a>. Each mitigation action can apply only one type of change.</p>
|
|
26
|
+
* <p>Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names.
|
|
27
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-mitigation-actions.html">Mitigation actions</a>. Each mitigation action can apply only one type of change.</p>
|
|
30
28
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateMitigationAction</a> action.</p>
|
|
31
29
|
* @example
|
|
32
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,7 +23,8 @@ export interface CreateScheduledAuditCommandOutput extends CreateScheduledAuditR
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Creates a scheduled audit that is run at a specified
|
|
26
|
+
* <p>Creates a scheduled audit that is run at a specified
|
|
27
|
+
* time interval.</p>
|
|
27
28
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateScheduledAudit</a> action.</p>
|
|
28
29
|
* @example
|
|
29
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -24,9 +24,8 @@ export interface DeleteAccountAuditConfigurationCommandOutput extends DeleteAcco
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Restores the default settings for Device Defender audits for this account. Any
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* </p>
|
|
27
|
+
* configuration data you entered is deleted and all audit checks are reset to
|
|
28
|
+
* disabled. </p>
|
|
30
29
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteAccountAuditConfiguration</a> action.</p>
|
|
31
30
|
* @example
|
|
32
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,13 +23,17 @@ export interface DeleteCustomMetricCommandOutput extends DeleteCustomMetricRespo
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>
|
|
26
|
+
* <p>
|
|
27
|
+
* Deletes a Device Defender detect custom metric.
|
|
28
|
+
* </p>
|
|
27
29
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteCustomMetric</a> action.</p>
|
|
28
30
|
* <note>
|
|
29
31
|
* <p>Before you can delete a custom metric, you must first remove the custom metric from all
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
32
|
+
* security profiles it's a part of.
|
|
33
|
+
* The
|
|
34
|
+
* security
|
|
35
|
+
* profile associated with the custom metric can be found using the <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_ListSecurityProfiles.html">ListSecurityProfiles</a>
|
|
36
|
+
* API with <code>metricName</code> set to your custom metric name.</p>
|
|
33
37
|
* </note>
|
|
34
38
|
* @example
|
|
35
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,9 +23,9 @@ export interface DescribeAccountAuditConfigurationCommandOutput extends Describe
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Gets information about the Device Defender audit settings for this account.
|
|
27
|
-
*
|
|
28
|
-
*
|
|
26
|
+
* <p>Gets information about the Device Defender audit settings for this account.
|
|
27
|
+
* Settings include how audit notifications are sent and which audit checks are
|
|
28
|
+
* enabled or disabled.</p>
|
|
29
29
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeAccountAuditConfiguration</a> action.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -24,7 +24,9 @@ export interface DescribeAuditFindingCommandOutput extends DescribeAuditFindingR
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Gets information about a single audit finding. Properties include the reason for
|
|
27
|
-
* noncompliance, the severity of the issue,
|
|
27
|
+
* noncompliance, the severity of the issue,
|
|
28
|
+
* and the start time
|
|
29
|
+
* when the audit that returned the
|
|
28
30
|
* finding.</p>
|
|
29
31
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeAuditFinding</a> action.</p>
|
|
30
32
|
* @example
|
|
@@ -23,9 +23,7 @@ export interface DescribeAuditMitigationActionsTaskCommandOutput extends Describ
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Gets information about an audit mitigation task that is used to apply mitigation actions
|
|
27
|
-
* to a set of audit findings. Properties include the actions being applied, the audit checks to
|
|
28
|
-
* which they're being applied, the task status, and aggregated task statistics.</p>
|
|
26
|
+
* <p>Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.</p>
|
|
29
27
|
* @example
|
|
30
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
29
|
* ```javascript
|
|
@@ -23,7 +23,9 @@ export interface DescribeCustomMetricCommandOutput extends DescribeCustomMetricR
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>
|
|
26
|
+
* <p>
|
|
27
|
+
* Gets information about a Device Defender detect custom metric.
|
|
28
|
+
* </p>
|
|
27
29
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeCustomMetric</a> action.</p>
|
|
28
30
|
* @example
|
|
29
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,7 +23,9 @@ export interface DescribeDetectMitigationActionsTaskCommandOutput extends Descri
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>
|
|
26
|
+
* <p>
|
|
27
|
+
* Gets information about a Device Defender ML Detect mitigation action.
|
|
28
|
+
* </p>
|
|
27
29
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeDetectMitigationActionsTask</a> action.</p>
|
|
28
30
|
* @example
|
|
29
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,8 +23,7 @@ export interface DetachSecurityProfileCommandOutput extends DetachSecurityProfil
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Disassociates a Device Defender security profile from a thing group or from this
|
|
27
|
-
* account.</p>
|
|
26
|
+
* <p>Disassociates a Device Defender security profile from a thing group or from this account.</p>
|
|
28
27
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DetachSecurityProfile</a> action.</p>
|
|
29
28
|
* @example
|
|
30
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,7 +23,9 @@ export interface GetBehaviorModelTrainingSummariesCommandOutput extends GetBehav
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>
|
|
26
|
+
* <p>
|
|
27
|
+
* Returns a Device Defender's ML Detect Security Profile training model's status.
|
|
28
|
+
* </p>
|
|
27
29
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetBehaviorModelTrainingSummaries</a> action.</p>
|
|
28
30
|
* @example
|
|
29
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -56,6 +56,12 @@ export interface GetIndexingConfigurationCommandOutput extends GetIndexingConfig
|
|
|
56
56
|
* // namedShadowNames: [ // NamedShadowNamesFilter
|
|
57
57
|
* // "STRING_VALUE",
|
|
58
58
|
* // ],
|
|
59
|
+
* // geoLocations: [ // GeoLocationsFilter
|
|
60
|
+
* // { // GeoLocationTarget
|
|
61
|
+
* // name: "STRING_VALUE",
|
|
62
|
+
* // order: "LatLon" || "LonLat",
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
59
65
|
* // },
|
|
60
66
|
* // },
|
|
61
67
|
* // thingGroupIndexingConfiguration: { // ThingGroupIndexingConfiguration
|
|
@@ -23,8 +23,8 @@ export interface ListAuditFindingsCommandOutput extends ListAuditFindingsRespons
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists the findings (results) of a Device Defender audit or of the audits
|
|
27
|
-
*
|
|
26
|
+
* <p>Lists the findings (results) of a Device Defender audit or of the audits
|
|
27
|
+
* performed during a specified time period. (Findings are retained for 90 days.)</p>
|
|
28
28
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListAuditFindings</a> action.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,7 +23,8 @@ export interface ListAuditMitigationActionsExecutionsCommandOutput extends ListA
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Gets the status of audit mitigation action tasks that were
|
|
26
|
+
* <p>Gets the status of audit mitigation action tasks that were
|
|
27
|
+
* executed.</p>
|
|
27
28
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListAuditMitigationActionsExecutions</a> action.</p>
|
|
28
29
|
* @example
|
|
29
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,8 +23,8 @@ export interface ListAuditTasksCommandOutput extends ListAuditTasksResponse, __M
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists the Device Defender audits that have been performed during a given
|
|
27
|
-
*
|
|
26
|
+
* <p>Lists the Device Defender audits that have been performed during a given
|
|
27
|
+
* time period.</p>
|
|
28
28
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListAuditTasks</a> action.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,7 +23,9 @@ export interface ListCustomMetricsCommandOutput extends ListCustomMetricsRespons
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>
|
|
26
|
+
* <p>
|
|
27
|
+
* Lists your Device Defender detect custom metrics.
|
|
28
|
+
* </p>
|
|
27
29
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListCustomMetrics</a> action.</p>
|
|
28
30
|
* @example
|
|
29
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,7 +23,9 @@ export interface ListDetectMitigationActionsExecutionsCommandOutput extends List
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>
|
|
26
|
+
* <p>
|
|
27
|
+
* Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
|
|
28
|
+
* </p>
|
|
27
29
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListDetectMitigationActionsExecutions</a> action.</p>
|
|
28
30
|
* @example
|
|
29
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,7 +23,9 @@ export interface ListDetectMitigationActionsTasksCommandOutput extends ListDetec
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>
|
|
26
|
+
* <p>
|
|
27
|
+
* List of Device Defender ML Detect mitigation actions tasks.
|
|
28
|
+
* </p>
|
|
27
29
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListDetectMitigationActionsTasks</a> action.</p>
|
|
28
30
|
* @example
|
|
29
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,8 +23,8 @@ export interface ListMetricValuesCommandOutput extends ListMetricValuesResponse,
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric,
|
|
27
|
-
*
|
|
26
|
+
* <p>Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric)
|
|
27
|
+
* by the given thing during the specified time period.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
|
2
2
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
|
|
5
|
-
import { ListPolicyPrincipalsRequest, ListPolicyPrincipalsResponse } from "../models/
|
|
5
|
+
import { ListPolicyPrincipalsRequest, ListPolicyPrincipalsResponse } from "../models/models_2";
|
|
6
6
|
/**
|
|
7
7
|
* @public
|
|
8
8
|
*/
|
|
@@ -23,8 +23,8 @@ export interface ListRelatedResourcesForAuditFindingCommandOutput extends ListRe
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>The related resources of an Audit finding.
|
|
27
|
-
* calling this API:</p>
|
|
26
|
+
* <p>The related resources of an Audit finding.
|
|
27
|
+
* The following resources can be returned from calling this API:</p>
|
|
28
28
|
* <ul>
|
|
29
29
|
* <li>
|
|
30
30
|
* <p>DEVICE_CERTIFICATE</p>
|
|
@@ -55,10 +55,10 @@ export interface ListRelatedResourcesForAuditFindingCommandOutput extends ListRe
|
|
|
55
55
|
* </li>
|
|
56
56
|
* </ul>
|
|
57
57
|
* <note>
|
|
58
|
-
* <p>This API is similar to DescribeAuditFinding's <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html">RelatedResources</a>
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
58
|
+
* <p>This API is similar to DescribeAuditFinding's <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html">RelatedResources</a>
|
|
59
|
+
* but provides pagination and is not limited to 10 resources.
|
|
60
|
+
* When calling <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html">DescribeAuditFinding</a> for the intermediate CA revoked for
|
|
61
|
+
* active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.</p>
|
|
62
62
|
* </note>
|
|
63
63
|
* @example
|
|
64
64
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,13 +23,13 @@ export interface ListSecurityProfilesCommandOutput extends ListSecurityProfilesR
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists the Device Defender security profiles
|
|
27
|
-
*
|
|
26
|
+
* <p>Lists the Device Defender security profiles
|
|
27
|
+
* you've
|
|
28
|
+
* created. You can filter security profiles by dimension or custom metric.</p>
|
|
28
29
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListSecurityProfiles</a> action.</p>
|
|
29
30
|
* <note>
|
|
30
31
|
* <p>
|
|
31
|
-
* <code>dimensionName</code> and <code>metricName</code> cannot be used in the same
|
|
32
|
-
* request.</p>
|
|
32
|
+
* <code>dimensionName</code> and <code>metricName</code> cannot be used in the same request.</p>
|
|
33
33
|
* </note>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,8 +23,7 @@ export interface ListTargetsForSecurityProfileCommandOutput extends ListTargetsF
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists the targets (thing groups) associated with a given Device Defender security
|
|
27
|
-
* profile.</p>
|
|
26
|
+
* <p>Lists the targets (thing groups) associated with a given Device Defender security profile.</p>
|
|
28
27
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListTargetsForSecurityProfile</a> action.</p>
|
|
29
28
|
* @example
|
|
30
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,9 +23,9 @@ export interface ListViolationEventsCommandOutput extends ListViolationEventsRes
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists the Device Defender security profile violations discovered during the given time
|
|
27
|
-
*
|
|
28
|
-
*
|
|
26
|
+
* <p>Lists the Device Defender security profile violations discovered during the given time period.
|
|
27
|
+
* You can use filters to limit the results to those alerts issued for a particular security profile,
|
|
28
|
+
* behavior, or thing (device).</p>
|
|
29
29
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListViolationEvents</a> action.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,7 +23,9 @@ export interface StartDetectMitigationActionsTaskCommandOutput extends StartDete
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>
|
|
26
|
+
* <p>
|
|
27
|
+
* Starts a Device Defender ML Detect mitigation actions task.
|
|
28
|
+
* </p>
|
|
27
29
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StartDetectMitigationActionsTask</a> action.</p>
|
|
28
30
|
* @example
|
|
29
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,9 +23,9 @@ export interface UpdateAccountAuditConfigurationCommandOutput extends UpdateAcco
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Configures or reconfigures the Device Defender audit settings for this account.
|
|
27
|
-
*
|
|
28
|
-
*
|
|
26
|
+
* <p>Configures or reconfigures the Device Defender audit settings for this account.
|
|
27
|
+
* Settings include how audit notifications are sent and which audit checks are
|
|
28
|
+
* enabled or disabled.</p>
|
|
29
29
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateAccountAuditConfiguration</a> action.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,7 +23,8 @@ export interface UpdateCustomMetricCommandOutput extends UpdateCustomMetricRespo
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Updates a
|
|
26
|
+
* <p>Updates a
|
|
27
|
+
* Device Defender detect custom metric. </p>
|
|
27
28
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateCustomMetric</a> action.</p>
|
|
28
29
|
* @example
|
|
29
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,8 +23,12 @@ export interface UpdateDimensionCommandOutput extends UpdateDimensionResponse, _
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Updates the definition for a dimension. You
|
|
27
|
-
*
|
|
26
|
+
* <p>Updates the definition for a dimension. You
|
|
27
|
+
* cannot
|
|
28
|
+
* change the type of a dimension after
|
|
29
|
+
* it is created (you can delete it and
|
|
30
|
+
* recreate
|
|
31
|
+
* it).</p>
|
|
28
32
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateDimension</a> action.</p>
|
|
29
33
|
* @example
|
|
30
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -53,6 +53,12 @@ export interface UpdateIndexingConfigurationCommandOutput extends UpdateIndexing
|
|
|
53
53
|
* namedShadowNames: [ // NamedShadowNamesFilter
|
|
54
54
|
* "STRING_VALUE",
|
|
55
55
|
* ],
|
|
56
|
+
* geoLocations: [ // GeoLocationsFilter
|
|
57
|
+
* { // GeoLocationTarget
|
|
58
|
+
* name: "STRING_VALUE",
|
|
59
|
+
* order: "LatLon" || "LonLat",
|
|
60
|
+
* },
|
|
61
|
+
* ],
|
|
56
62
|
* },
|
|
57
63
|
* },
|
|
58
64
|
* thingGroupIndexingConfiguration: { // ThingGroupIndexingConfiguration
|
|
@@ -23,8 +23,8 @@ export interface UpdateScheduledAuditCommandOutput extends UpdateScheduledAuditR
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Updates a scheduled audit, including which checks are performed and
|
|
27
|
-
*
|
|
26
|
+
* <p>Updates a scheduled audit, including which checks are performed and
|
|
27
|
+
* how often the audit takes place.</p>
|
|
28
28
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateScheduledAudit</a> action.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|