From 458186a164ddbb10cc21c43627f49d97aeaf8e08 Mon Sep 17 00:00:00 2001 From: awstools Date: Thu, 16 Nov 2023 19:22:01 +0000 Subject: [PATCH] feat(client-iot): GA release the ability to index and search devices based on their GeoLocation data. With GeoQueries you can narrow your search to retrieve devices located in the desired geographic boundary. --- .../commands/AttachSecurityProfileCommand.ts | 2 +- ...CancelAuditMitigationActionsTaskCommand.ts | 5 +- .../src/commands/CancelAuditTaskCommand.ts | 3 +- ...ancelDetectMitigationActionsTaskCommand.ts | 4 +- .../src/commands/CreateCustomMetricCommand.ts | 5 +- .../src/commands/CreateDimensionCommand.ts | 6 +- .../commands/CreateMitigationActionCommand.ts | 6 +- .../commands/CreateScheduledAuditCommand.ts | 3 +- .../DeleteAccountAuditConfigurationCommand.ts | 5 +- .../src/commands/DeleteCustomMetricCommand.ts | 12 +- ...escribeAccountAuditConfigurationCommand.ts | 6 +- .../commands/DescribeAuditFindingCommand.ts | 4 +- ...scribeAuditMitigationActionsTaskCommand.ts | 4 +- .../commands/DescribeCustomMetricCommand.ts | 4 +- ...cribeDetectMitigationActionsTaskCommand.ts | 4 +- .../commands/DetachSecurityProfileCommand.ts | 3 +- ...etBehaviorModelTrainingSummariesCommand.ts | 4 +- .../GetIndexingConfigurationCommand.ts | 6 + .../src/commands/ListAuditFindingsCommand.ts | 4 +- ...AuditMitigationActionsExecutionsCommand.ts | 3 +- .../src/commands/ListAuditTasksCommand.ts | 4 +- .../src/commands/ListCustomMetricsCommand.ts | 4 +- ...etectMitigationActionsExecutionsCommand.ts | 4 +- ...ListDetectMitigationActionsTasksCommand.ts | 4 +- .../src/commands/ListMetricValuesCommand.ts | 4 +- .../commands/ListPolicyPrincipalsCommand.ts | 2 +- ...tRelatedResourcesForAuditFindingCommand.ts | 12 +- .../commands/ListSecurityProfilesCommand.ts | 8 +- .../ListTargetsForSecurityProfileCommand.ts | 3 +- .../commands/ListViolationEventsCommand.ts | 6 +- ...StartDetectMitigationActionsTaskCommand.ts | 4 +- .../UpdateAccountAuditConfigurationCommand.ts | 6 +- .../src/commands/UpdateCustomMetricCommand.ts | 3 +- .../src/commands/UpdateDimensionCommand.ts | 8 +- .../UpdateIndexingConfigurationCommand.ts | 6 + .../commands/UpdateScheduledAuditCommand.ts | 4 +- clients/client-iot/src/models/models_0.ts | 114 +++-- clients/client-iot/src/models/models_1.ts | 475 ++++++++++-------- clients/client-iot/src/models/models_2.ts | 358 ++++++++----- .../client-iot/src/protocols/Aws_restJson1.ts | 9 + codegen/sdk-codegen/aws-models/iot.json | 442 +++++++++------- 41 files changed, 924 insertions(+), 649 deletions(-) diff --git a/clients/client-iot/src/commands/AttachSecurityProfileCommand.ts b/clients/client-iot/src/commands/AttachSecurityProfileCommand.ts index 04ce1e722e1b..f401c2744774 100644 --- a/clients/client-iot/src/commands/AttachSecurityProfileCommand.ts +++ b/clients/client-iot/src/commands/AttachSecurityProfileCommand.ts @@ -38,7 +38,7 @@ export interface AttachSecurityProfileCommandOutput extends AttachSecurityProfil /** * @public *

Associates a Device Defender security profile with a thing group or this account. Each - * thing group or account can have up to five security profiles associated with it.

+ * thing group or account can have up to five security profiles associated with it.

*

Requires permission to access the AttachSecurityProfile action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/CancelAuditMitigationActionsTaskCommand.ts b/clients/client-iot/src/commands/CancelAuditMitigationActionsTaskCommand.ts index 8faaede4f8bc..f30738bd88fe 100644 --- a/clients/client-iot/src/commands/CancelAuditMitigationActionsTaskCommand.ts +++ b/clients/client-iot/src/commands/CancelAuditMitigationActionsTaskCommand.ts @@ -42,8 +42,9 @@ export interface CancelAuditMitigationActionsTaskCommandOutput /** * @public - *

Cancels a mitigation action task that is in progress. If the task is not in progress, an - * InvalidRequestException occurs.

+ *

Cancels a mitigation action task that is in progress. If the task + * is not + * in progress, an InvalidRequestException occurs.

*

Requires permission to access the CancelAuditMitigationActionsTask action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/CancelAuditTaskCommand.ts b/clients/client-iot/src/commands/CancelAuditTaskCommand.ts index a636660ea0e7..741e38c63b12 100644 --- a/clients/client-iot/src/commands/CancelAuditTaskCommand.ts +++ b/clients/client-iot/src/commands/CancelAuditTaskCommand.ts @@ -37,8 +37,7 @@ export interface CancelAuditTaskCommandOutput extends CancelAuditTaskResponse, _ /** * @public - *

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.

+ *

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.

*

Requires permission to access the CancelAuditTask action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/CancelDetectMitigationActionsTaskCommand.ts b/clients/client-iot/src/commands/CancelDetectMitigationActionsTaskCommand.ts index 9a38d0b4b150..5fe23d7b0cbc 100644 --- a/clients/client-iot/src/commands/CancelDetectMitigationActionsTaskCommand.ts +++ b/clients/client-iot/src/commands/CancelDetectMitigationActionsTaskCommand.ts @@ -45,7 +45,9 @@ export interface CancelDetectMitigationActionsTaskCommandOutput /** * @public - *

Cancels a Device Defender ML Detect mitigation action.

+ *

+ * Cancels a Device Defender ML Detect mitigation action. + *

*

Requires permission to access the CancelDetectMitigationActionsTask action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/CreateCustomMetricCommand.ts b/clients/client-iot/src/commands/CreateCustomMetricCommand.ts index 77c2727e03e1..d7b1a7f2e38f 100644 --- a/clients/client-iot/src/commands/CreateCustomMetricCommand.ts +++ b/clients/client-iot/src/commands/CreateCustomMetricCommand.ts @@ -37,7 +37,10 @@ export interface CreateCustomMetricCommandOutput extends CreateCustomMetricRespo /** * @public - *

Use this API to define a Custom Metric published by your devices to Device Defender.

+ *

Use this API to define a + * Custom + * Metric + * published by your devices to Device Defender.

*

Requires permission to access the CreateCustomMetric action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/CreateDimensionCommand.ts b/clients/client-iot/src/commands/CreateDimensionCommand.ts index 9a4f400224e1..3f40748a0199 100644 --- a/clients/client-iot/src/commands/CreateDimensionCommand.ts +++ b/clients/client-iot/src/commands/CreateDimensionCommand.ts @@ -37,10 +37,8 @@ export interface CreateDimensionCommandOutput extends CreateDimensionResponse, _ /** * @public - *

Create a dimension that you can use to limit the scope of a metric used in a security - * profile for 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.

+ *

Create a dimension that you can use to limit the scope of a metric used in a security profile for 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.

*

Requires permission to access the CreateDimension action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/CreateMitigationActionCommand.ts b/clients/client-iot/src/commands/CreateMitigationActionCommand.ts index f352e6a80d66..ae253c2e1b8d 100644 --- a/clients/client-iot/src/commands/CreateMitigationActionCommand.ts +++ b/clients/client-iot/src/commands/CreateMitigationActionCommand.ts @@ -37,10 +37,8 @@ export interface CreateMitigationActionCommandOutput extends CreateMitigationAct /** * @public - *

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. For more information, see Mitigation - * actions. Each mitigation action can apply only one type of change.

+ *

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. + * For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

*

Requires permission to access the CreateMitigationAction action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/CreateScheduledAuditCommand.ts b/clients/client-iot/src/commands/CreateScheduledAuditCommand.ts index 5e50431d69c5..a001c72aa144 100644 --- a/clients/client-iot/src/commands/CreateScheduledAuditCommand.ts +++ b/clients/client-iot/src/commands/CreateScheduledAuditCommand.ts @@ -37,7 +37,8 @@ export interface CreateScheduledAuditCommandOutput extends CreateScheduledAuditR /** * @public - *

Creates a scheduled audit that is run at a specified time interval.

+ *

Creates a scheduled audit that is run at a specified + * time interval.

*

Requires permission to access the CreateScheduledAudit action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/DeleteAccountAuditConfigurationCommand.ts b/clients/client-iot/src/commands/DeleteAccountAuditConfigurationCommand.ts index 99a1e65fe9db..16667e70f108 100644 --- a/clients/client-iot/src/commands/DeleteAccountAuditConfigurationCommand.ts +++ b/clients/client-iot/src/commands/DeleteAccountAuditConfigurationCommand.ts @@ -43,9 +43,8 @@ export interface DeleteAccountAuditConfigurationCommandOutput /** * @public *

Restores the default settings for Device Defender audits for this account. Any - * configuration data you entered is deleted and all audit checks are reset to disabled. - * - *

+ * configuration data you entered is deleted and all audit checks are reset to + * disabled.

*

Requires permission to access the DeleteAccountAuditConfiguration action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/DeleteCustomMetricCommand.ts b/clients/client-iot/src/commands/DeleteCustomMetricCommand.ts index cdf11c138227..ad7062319f4c 100644 --- a/clients/client-iot/src/commands/DeleteCustomMetricCommand.ts +++ b/clients/client-iot/src/commands/DeleteCustomMetricCommand.ts @@ -37,13 +37,17 @@ export interface DeleteCustomMetricCommandOutput extends DeleteCustomMetricRespo /** * @public - *

Deletes a Device Defender detect custom metric.

+ *

+ * Deletes a Device Defender detect custom metric. + *

*

Requires permission to access the DeleteCustomMetric action.

* *

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.

+ * 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.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/DescribeAccountAuditConfigurationCommand.ts b/clients/client-iot/src/commands/DescribeAccountAuditConfigurationCommand.ts index 7279478e8aa3..2c4f498fec5c 100644 --- a/clients/client-iot/src/commands/DescribeAccountAuditConfigurationCommand.ts +++ b/clients/client-iot/src/commands/DescribeAccountAuditConfigurationCommand.ts @@ -45,9 +45,9 @@ export interface DescribeAccountAuditConfigurationCommandOutput /** * @public - *

Gets information about the Device Defender audit settings for this account. Settings - * include how audit notifications are sent and which audit checks are enabled or - * disabled.

+ *

Gets information about the Device Defender audit settings for this account. + * Settings include how audit notifications are sent and which audit checks are + * enabled or disabled.

*

Requires permission to access the DescribeAccountAuditConfiguration action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/DescribeAuditFindingCommand.ts b/clients/client-iot/src/commands/DescribeAuditFindingCommand.ts index 65c09a0d2ce8..47501d0d101b 100644 --- a/clients/client-iot/src/commands/DescribeAuditFindingCommand.ts +++ b/clients/client-iot/src/commands/DescribeAuditFindingCommand.ts @@ -38,7 +38,9 @@ export interface DescribeAuditFindingCommandOutput extends DescribeAuditFindingR /** * @public *

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 + * noncompliance, the severity of the issue, + * and the start time + * when the audit that returned the * finding.

*

Requires permission to access the DescribeAuditFinding action.

* @example diff --git a/clients/client-iot/src/commands/DescribeAuditMitigationActionsTaskCommand.ts b/clients/client-iot/src/commands/DescribeAuditMitigationActionsTaskCommand.ts index 72a1b2277e70..43e7c2b60171 100644 --- a/clients/client-iot/src/commands/DescribeAuditMitigationActionsTaskCommand.ts +++ b/clients/client-iot/src/commands/DescribeAuditMitigationActionsTaskCommand.ts @@ -45,9 +45,7 @@ export interface DescribeAuditMitigationActionsTaskCommandOutput /** * @public - *

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.

+ *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-iot/src/commands/DescribeCustomMetricCommand.ts b/clients/client-iot/src/commands/DescribeCustomMetricCommand.ts index 8df796b1f723..29a958fd5172 100644 --- a/clients/client-iot/src/commands/DescribeCustomMetricCommand.ts +++ b/clients/client-iot/src/commands/DescribeCustomMetricCommand.ts @@ -37,7 +37,9 @@ export interface DescribeCustomMetricCommandOutput extends DescribeCustomMetricR /** * @public - *

Gets information about a Device Defender detect custom metric.

+ *

+ * Gets information about a Device Defender detect custom metric. + *

*

Requires permission to access the DescribeCustomMetric action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/DescribeDetectMitigationActionsTaskCommand.ts b/clients/client-iot/src/commands/DescribeDetectMitigationActionsTaskCommand.ts index 301d842bdf4e..4585ec7128b6 100644 --- a/clients/client-iot/src/commands/DescribeDetectMitigationActionsTaskCommand.ts +++ b/clients/client-iot/src/commands/DescribeDetectMitigationActionsTaskCommand.ts @@ -45,7 +45,9 @@ export interface DescribeDetectMitigationActionsTaskCommandOutput /** * @public - *

Gets information about a Device Defender ML Detect mitigation action.

+ *

+ * Gets information about a Device Defender ML Detect mitigation action. + *

*

Requires permission to access the DescribeDetectMitigationActionsTask action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/DetachSecurityProfileCommand.ts b/clients/client-iot/src/commands/DetachSecurityProfileCommand.ts index 4937744729b3..f32290964e79 100644 --- a/clients/client-iot/src/commands/DetachSecurityProfileCommand.ts +++ b/clients/client-iot/src/commands/DetachSecurityProfileCommand.ts @@ -37,8 +37,7 @@ export interface DetachSecurityProfileCommandOutput extends DetachSecurityProfil /** * @public - *

Disassociates a Device Defender security profile from a thing group or from this - * account.

+ *

Disassociates a Device Defender security profile from a thing group or from this account.

*

Requires permission to access the DetachSecurityProfile action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/GetBehaviorModelTrainingSummariesCommand.ts b/clients/client-iot/src/commands/GetBehaviorModelTrainingSummariesCommand.ts index 09d90fbf51ec..0b6e9e5fef30 100644 --- a/clients/client-iot/src/commands/GetBehaviorModelTrainingSummariesCommand.ts +++ b/clients/client-iot/src/commands/GetBehaviorModelTrainingSummariesCommand.ts @@ -45,7 +45,9 @@ export interface GetBehaviorModelTrainingSummariesCommandOutput /** * @public - *

Returns a Device Defender's ML Detect Security Profile training model's status.

+ *

+ * Returns a Device Defender's ML Detect Security Profile training model's status. + *

*

Requires permission to access the GetBehaviorModelTrainingSummaries action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/GetIndexingConfigurationCommand.ts b/clients/client-iot/src/commands/GetIndexingConfigurationCommand.ts index 1a6eed4e761f..76b8ebea0f71 100644 --- a/clients/client-iot/src/commands/GetIndexingConfigurationCommand.ts +++ b/clients/client-iot/src/commands/GetIndexingConfigurationCommand.ts @@ -70,6 +70,12 @@ export interface GetIndexingConfigurationCommandOutput extends GetIndexingConfig * // namedShadowNames: [ // NamedShadowNamesFilter * // "STRING_VALUE", * // ], + * // geoLocations: [ // GeoLocationsFilter + * // { // GeoLocationTarget + * // name: "STRING_VALUE", + * // order: "LatLon" || "LonLat", + * // }, + * // ], * // }, * // }, * // thingGroupIndexingConfiguration: { // ThingGroupIndexingConfiguration diff --git a/clients/client-iot/src/commands/ListAuditFindingsCommand.ts b/clients/client-iot/src/commands/ListAuditFindingsCommand.ts index b7fca89c8904..09ecbe071924 100644 --- a/clients/client-iot/src/commands/ListAuditFindingsCommand.ts +++ b/clients/client-iot/src/commands/ListAuditFindingsCommand.ts @@ -37,8 +37,8 @@ export interface ListAuditFindingsCommandOutput extends ListAuditFindingsRespons /** * @public - *

Lists the findings (results) of a Device Defender audit or of the audits performed during - * a specified time period. (Findings are retained for 90 days.)

+ *

Lists the findings (results) of a Device Defender audit or of the audits + * performed during a specified time period. (Findings are retained for 90 days.)

*

Requires permission to access the ListAuditFindings action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/ListAuditMitigationActionsExecutionsCommand.ts b/clients/client-iot/src/commands/ListAuditMitigationActionsExecutionsCommand.ts index ebc2e1679960..06f13af2fd50 100644 --- a/clients/client-iot/src/commands/ListAuditMitigationActionsExecutionsCommand.ts +++ b/clients/client-iot/src/commands/ListAuditMitigationActionsExecutionsCommand.ts @@ -45,7 +45,8 @@ export interface ListAuditMitigationActionsExecutionsCommandOutput /** * @public - *

Gets the status of audit mitigation action tasks that were executed.

+ *

Gets the status of audit mitigation action tasks that were + * executed.

*

Requires permission to access the ListAuditMitigationActionsExecutions action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/ListAuditTasksCommand.ts b/clients/client-iot/src/commands/ListAuditTasksCommand.ts index 179dc51aea7b..d59192797cd6 100644 --- a/clients/client-iot/src/commands/ListAuditTasksCommand.ts +++ b/clients/client-iot/src/commands/ListAuditTasksCommand.ts @@ -37,8 +37,8 @@ export interface ListAuditTasksCommandOutput extends ListAuditTasksResponse, __M /** * @public - *

Lists the Device Defender audits that have been performed during a given time - * period.

+ *

Lists the Device Defender audits that have been performed during a given + * time period.

*

Requires permission to access the ListAuditTasks action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/ListCustomMetricsCommand.ts b/clients/client-iot/src/commands/ListCustomMetricsCommand.ts index 16e160e31ded..9fb5caf82892 100644 --- a/clients/client-iot/src/commands/ListCustomMetricsCommand.ts +++ b/clients/client-iot/src/commands/ListCustomMetricsCommand.ts @@ -37,7 +37,9 @@ export interface ListCustomMetricsCommandOutput extends ListCustomMetricsRespons /** * @public - *

Lists your Device Defender detect custom metrics.

+ *

+ * Lists your Device Defender detect custom metrics. + *

*

Requires permission to access the ListCustomMetrics action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/ListDetectMitigationActionsExecutionsCommand.ts b/clients/client-iot/src/commands/ListDetectMitigationActionsExecutionsCommand.ts index c1fa971ecd32..1f6229aaf603 100644 --- a/clients/client-iot/src/commands/ListDetectMitigationActionsExecutionsCommand.ts +++ b/clients/client-iot/src/commands/ListDetectMitigationActionsExecutionsCommand.ts @@ -46,7 +46,9 @@ export interface ListDetectMitigationActionsExecutionsCommandOutput /** * @public - *

Lists mitigation actions executions for a Device Defender ML Detect Security Profile.

+ *

+ * Lists mitigation actions executions for a Device Defender ML Detect Security Profile. + *

*

Requires permission to access the ListDetectMitigationActionsExecutions action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/ListDetectMitigationActionsTasksCommand.ts b/clients/client-iot/src/commands/ListDetectMitigationActionsTasksCommand.ts index 29cff43415c5..32eabbdf6f72 100644 --- a/clients/client-iot/src/commands/ListDetectMitigationActionsTasksCommand.ts +++ b/clients/client-iot/src/commands/ListDetectMitigationActionsTasksCommand.ts @@ -42,7 +42,9 @@ export interface ListDetectMitigationActionsTasksCommandOutput /** * @public - *

List of Device Defender ML Detect mitigation actions tasks.

+ *

+ * List of Device Defender ML Detect mitigation actions tasks. + *

*

Requires permission to access the ListDetectMitigationActionsTasks action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/ListMetricValuesCommand.ts b/clients/client-iot/src/commands/ListMetricValuesCommand.ts index 37178f43f13e..aa7b838ca425 100644 --- a/clients/client-iot/src/commands/ListMetricValuesCommand.ts +++ b/clients/client-iot/src/commands/ListMetricValuesCommand.ts @@ -37,8 +37,8 @@ export interface ListMetricValuesCommandOutput extends ListMetricValuesResponse, /** * @public - *

Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, - * or custom metric) by the given thing during the specified time period.

+ *

Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) + * by the given thing during the specified time period.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-iot/src/commands/ListPolicyPrincipalsCommand.ts b/clients/client-iot/src/commands/ListPolicyPrincipalsCommand.ts index e1490de4b4b9..36e8afd48831 100644 --- a/clients/client-iot/src/commands/ListPolicyPrincipalsCommand.ts +++ b/clients/client-iot/src/commands/ListPolicyPrincipalsCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; -import { ListPolicyPrincipalsRequest, ListPolicyPrincipalsResponse } from "../models/models_1"; +import { ListPolicyPrincipalsRequest, ListPolicyPrincipalsResponse } from "../models/models_2"; import { de_ListPolicyPrincipalsCommand, se_ListPolicyPrincipalsCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-iot/src/commands/ListRelatedResourcesForAuditFindingCommand.ts b/clients/client-iot/src/commands/ListRelatedResourcesForAuditFindingCommand.ts index dab7f60fa9a5..d680caff9bef 100644 --- a/clients/client-iot/src/commands/ListRelatedResourcesForAuditFindingCommand.ts +++ b/clients/client-iot/src/commands/ListRelatedResourcesForAuditFindingCommand.ts @@ -45,8 +45,8 @@ export interface ListRelatedResourcesForAuditFindingCommandOutput /** * @public - *

The related resources of an Audit finding. The following resources can be returned from - * calling this API:

+ *

The related resources of an Audit finding. + * The following resources can be returned from calling this API:

* * - *

This API is similar to DescribeAuditFinding's RelatedResources but - * provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding for the intermediate CA revoked for active device - * certificates check, RelatedResources will not be populated. You must use this API, - * ListRelatedResourcesForAuditFinding, to list the certificates.

+ *

This API is similar to DescribeAuditFinding's RelatedResources + * but provides pagination and is not limited to 10 resources. + * When calling DescribeAuditFinding for the intermediate CA revoked for + * active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/ListSecurityProfilesCommand.ts b/clients/client-iot/src/commands/ListSecurityProfilesCommand.ts index 82178a0d1672..ff702902d380 100644 --- a/clients/client-iot/src/commands/ListSecurityProfilesCommand.ts +++ b/clients/client-iot/src/commands/ListSecurityProfilesCommand.ts @@ -37,13 +37,13 @@ export interface ListSecurityProfilesCommandOutput extends ListSecurityProfilesR /** * @public - *

Lists the Device Defender security profiles you've created. You can filter security - * profiles by dimension or custom metric.

+ *

Lists the Device Defender security profiles + * you've + * created. You can filter security profiles by dimension or custom metric.

*

Requires permission to access the ListSecurityProfiles action.

* *

- * dimensionName and metricName cannot be used in the same - * request.

+ * dimensionName and metricName cannot be used in the same request.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/ListTargetsForSecurityProfileCommand.ts b/clients/client-iot/src/commands/ListTargetsForSecurityProfileCommand.ts index 3966e9960ace..93ac36093c98 100644 --- a/clients/client-iot/src/commands/ListTargetsForSecurityProfileCommand.ts +++ b/clients/client-iot/src/commands/ListTargetsForSecurityProfileCommand.ts @@ -42,8 +42,7 @@ export interface ListTargetsForSecurityProfileCommandOutput /** * @public - *

Lists the targets (thing groups) associated with a given Device Defender security - * profile.

+ *

Lists the targets (thing groups) associated with a given Device Defender security profile.

*

Requires permission to access the ListTargetsForSecurityProfile action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/ListViolationEventsCommand.ts b/clients/client-iot/src/commands/ListViolationEventsCommand.ts index 6ff448f2223d..028ac3bd1b86 100644 --- a/clients/client-iot/src/commands/ListViolationEventsCommand.ts +++ b/clients/client-iot/src/commands/ListViolationEventsCommand.ts @@ -37,9 +37,9 @@ export interface ListViolationEventsCommandOutput extends ListViolationEventsRes /** * @public - *

Lists the Device Defender security profile violations discovered during the given time - * period. You can use filters to limit the results to those alerts issued for a particular - * security profile, behavior, or thing (device).

+ *

Lists the Device Defender security profile violations discovered during the given time period. + * You can use filters to limit the results to those alerts issued for a particular security profile, + * behavior, or thing (device).

*

Requires permission to access the ListViolationEvents action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/StartDetectMitigationActionsTaskCommand.ts b/clients/client-iot/src/commands/StartDetectMitigationActionsTaskCommand.ts index 28d26997ea5c..c9d545b55fc9 100644 --- a/clients/client-iot/src/commands/StartDetectMitigationActionsTaskCommand.ts +++ b/clients/client-iot/src/commands/StartDetectMitigationActionsTaskCommand.ts @@ -42,7 +42,9 @@ export interface StartDetectMitigationActionsTaskCommandOutput /** * @public - *

Starts a Device Defender ML Detect mitigation actions task.

+ *

+ * Starts a Device Defender ML Detect mitigation actions task. + *

*

Requires permission to access the StartDetectMitigationActionsTask action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/UpdateAccountAuditConfigurationCommand.ts b/clients/client-iot/src/commands/UpdateAccountAuditConfigurationCommand.ts index ebb65f862532..4a1199e64865 100644 --- a/clients/client-iot/src/commands/UpdateAccountAuditConfigurationCommand.ts +++ b/clients/client-iot/src/commands/UpdateAccountAuditConfigurationCommand.ts @@ -42,9 +42,9 @@ export interface UpdateAccountAuditConfigurationCommandOutput /** * @public - *

Configures or reconfigures the Device Defender audit settings for this account. Settings - * include how audit notifications are sent and which audit checks are enabled or - * disabled.

+ *

Configures or reconfigures the Device Defender audit settings for this account. + * Settings include how audit notifications are sent and which audit checks are + * enabled or disabled.

*

Requires permission to access the UpdateAccountAuditConfiguration action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/UpdateCustomMetricCommand.ts b/clients/client-iot/src/commands/UpdateCustomMetricCommand.ts index 71b70246a00b..a2202da52b16 100644 --- a/clients/client-iot/src/commands/UpdateCustomMetricCommand.ts +++ b/clients/client-iot/src/commands/UpdateCustomMetricCommand.ts @@ -37,7 +37,8 @@ export interface UpdateCustomMetricCommandOutput extends UpdateCustomMetricRespo /** * @public - *

Updates a Device Defender detect custom metric.

+ *

Updates a + * Device Defender detect custom metric.

*

Requires permission to access the UpdateCustomMetric action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/UpdateDimensionCommand.ts b/clients/client-iot/src/commands/UpdateDimensionCommand.ts index 0c3dd96efb21..fb8952adb337 100644 --- a/clients/client-iot/src/commands/UpdateDimensionCommand.ts +++ b/clients/client-iot/src/commands/UpdateDimensionCommand.ts @@ -37,8 +37,12 @@ export interface UpdateDimensionCommandOutput extends UpdateDimensionResponse, _ /** * @public - *

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).

+ *

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).

*

Requires permission to access the UpdateDimension action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/commands/UpdateIndexingConfigurationCommand.ts b/clients/client-iot/src/commands/UpdateIndexingConfigurationCommand.ts index f6b897536e2f..5298752dffa9 100644 --- a/clients/client-iot/src/commands/UpdateIndexingConfigurationCommand.ts +++ b/clients/client-iot/src/commands/UpdateIndexingConfigurationCommand.ts @@ -72,6 +72,12 @@ export interface UpdateIndexingConfigurationCommandOutput * namedShadowNames: [ // NamedShadowNamesFilter * "STRING_VALUE", * ], + * geoLocations: [ // GeoLocationsFilter + * { // GeoLocationTarget + * name: "STRING_VALUE", + * order: "LatLon" || "LonLat", + * }, + * ], * }, * }, * thingGroupIndexingConfiguration: { // ThingGroupIndexingConfiguration diff --git a/clients/client-iot/src/commands/UpdateScheduledAuditCommand.ts b/clients/client-iot/src/commands/UpdateScheduledAuditCommand.ts index 1246362cf9f1..ddc7eb3a9e86 100644 --- a/clients/client-iot/src/commands/UpdateScheduledAuditCommand.ts +++ b/clients/client-iot/src/commands/UpdateScheduledAuditCommand.ts @@ -37,8 +37,8 @@ export interface UpdateScheduledAuditCommandOutput extends UpdateScheduledAuditR /** * @public - *

Updates a scheduled audit, including which checks are performed and how often the audit - * takes place.

+ *

Updates a scheduled audit, including which checks are performed and + * how often the audit takes place.

*

Requires permission to access the UpdateScheduledAudit action.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-iot/src/models/models_0.ts b/clients/client-iot/src/models/models_0.ts index 929b955e69d7..4a0405c06315 100644 --- a/clients/client-iot/src/models/models_0.ts +++ b/clients/client-iot/src/models/models_0.ts @@ -3470,8 +3470,8 @@ export interface CancelAuditMitigationActionsTaskResponse {} export interface CancelAuditTaskRequest { /** * @public - *

The ID of the audit you want to cancel. You can only cancel an audit that is - * "IN_PROGRESS".

+ *

The ID of the audit you want to cancel. You can only cancel an + * audit that is "IN_PROGRESS".

*/ taskId: string | undefined; } @@ -3500,7 +3500,9 @@ export interface CancelCertificateTransferRequest { export interface CancelDetectMitigationActionsTaskRequest { /** * @public - *

The unique identifier of the task.

+ *

+ * The unique identifier of the task. + *

*/ taskId: string | undefined; } @@ -4047,15 +4049,19 @@ export interface CreateCustomMetricRequest { /** * @public - *

Metadata that can be used to manage the custom metric.

+ *

+ * Metadata that can be used to manage the custom metric. + *

*/ tags?: Tag[]; /** * @public - *

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, Amazon Web Services SDKs will automatically generate a unique client request.

+ *

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, Amazon Web Services SDKs will automatically generate a unique client request.

*/ clientRequestToken?: string; } @@ -4066,7 +4072,9 @@ export interface CreateCustomMetricRequest { export interface CreateCustomMetricResponse { /** * @public - *

The name of the custom metric to be used in the metric report.

+ *

+ * The name of the custom metric to be used in the metric report. + *

*/ metricName?: string; @@ -4099,8 +4107,7 @@ export type DimensionType = (typeof DimensionType)[keyof typeof DimensionType]; export interface CreateDimensionRequest { /** * @public - *

A unique identifier for the dimension. Choose something that describes the type and value - * to make it easy to remember what it does.

+ *

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

*/ name: string | undefined; @@ -4113,8 +4120,7 @@ export interface CreateDimensionRequest { /** * @public - *

Specifies the value or list of values for the dimension. For TOPIC_FILTER - * dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

+ *

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

*/ stringValues: string[] | undefined; @@ -4126,9 +4132,8 @@ export interface CreateDimensionRequest { /** * @public - *

Each dimension must have a unique client request token. If you try to create a new - * dimension with the same token as a dimension that already exists, an exception occurs. If you - * omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

+ *

Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. + * If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

*/ clientRequestToken?: string; } @@ -4145,7 +4150,10 @@ export interface CreateDimensionResponse { /** * @public - *

The Amazon Resource Name (ARN) of the created dimension.

+ *

The Amazon Resource Name + * (ARN) + * of + * the created dimension.

*/ arn?: string; } @@ -4955,8 +4963,8 @@ export interface CreateJobRequest { *

The package version Amazon Resource Names (ARNs) that are installed on the device when the * job successfully completes.

*

- * Note:The following Length Constraints relates to a single string. - * Up to five strings are allowed.

+ * Note:The following Length Constraints relates to a single ARN. + * Up to 25 package version ARNs are allowed.

*/ destinationPackageVersions?: string[]; } @@ -5096,10 +5104,11 @@ export interface CreateJobTemplateRequest { /** * @public - *

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.

+ *

The package version Amazon Resource Names (ARNs) that are installed on the device when the + * job successfully completes.

*

- * Note:The following Length Constraints relates to a single string. - * Up to five strings are allowed.

+ * Note:The following Length Constraints relates to a single ARN. + * Up to 25 package version ARNs are allowed.

*/ destinationPackageVersions?: string[]; } @@ -5354,8 +5363,7 @@ export interface MitigationActionParams { export interface CreateMitigationActionRequest { /** * @public - *

A friendly name for the action. Choose a friendly name that accurately describes the - * action (for example, EnableLoggingAction).

+ *

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

*/ actionName: string | undefined; @@ -6673,36 +6681,44 @@ export type DayOfWeek = (typeof DayOfWeek)[keyof typeof DayOfWeek]; export interface CreateScheduledAuditRequest { /** * @public - *

How often the scheduled audit takes place, either DAILY, WEEKLY, - * BIWEEKLY or MONTHLY. The start time of each audit is determined by - * the system.

+ *

How often the scheduled audit takes + * place, either + * DAILY, + * WEEKLY, BIWEEKLY or MONTHLY. The start time of each audit is + * determined by the system.

*/ frequency: AuditFrequency | undefined; /** * @public - *

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.

+ *

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.

*/ dayOfMonth?: string; /** * @public - *

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.

+ *

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.

*/ dayOfWeek?: DayOfWeek; /** * @public - *

Which checks are performed during the scheduled audit. Checks must be enabled for your - * account. (Use DescribeAccountAuditConfiguration to see the list of all checks, - * including those that are enabled or use UpdateAccountAuditConfiguration to select - * which checks are enabled.)

+ *

Which checks are performed during the scheduled audit. Checks must be enabled + * for your account. (Use DescribeAccountAuditConfiguration to see the list + * of all checks, including those that are enabled or use UpdateAccountAuditConfiguration + * to select which checks are enabled.)

*/ targetCheckNames: string[] | undefined; @@ -6768,15 +6784,14 @@ export interface CreateSecurityProfileRequest { /** * @public - *

Specifies the behaviors that, when violated by a device (thing), cause an - * alert.

+ *

Specifies the behaviors that, when violated by a device (thing), cause an alert.

*/ behaviors?: Behavior[]; /** * @public *

Specifies the destinations to which alerts are sent. (Alerts are always sent to the - * console.) Alerts are generated when a device (thing) violates a behavior.

+ * console.) Alerts are generated when a device (thing) violates a behavior.

*/ alertTargets?: Partial>; @@ -6785,20 +6800,17 @@ export interface CreateSecurityProfileRequest { * @deprecated * *

- * Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 - * instead. + * 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.

+ *

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.

*/ additionalMetricsToRetain?: string[]; /** * @public - *

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.

+ *

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.

*/ additionalMetricsToRetainV2?: MetricToRetain[]; @@ -7579,7 +7591,9 @@ export interface DeleteCertificateRequest { export interface DeleteCustomMetricRequest { /** * @public - *

The name of the custom metric.

+ *

+ * The name of the custom metric. + *

*/ metricName: string | undefined; } diff --git a/clients/client-iot/src/models/models_1.ts b/clients/client-iot/src/models/models_1.ts index 30c9cd78b120..03452f14e74b 100644 --- a/clients/client-iot/src/models/models_1.ts +++ b/clients/client-iot/src/models/models_1.ts @@ -435,9 +435,9 @@ export interface DeleteSecurityProfileRequest { /** * @public - *

The expected version of the security profile. A new version is generated whenever the - * security profile is updated. If you specify a value that is different from the actual version, - * a VersionConflictException is thrown.

+ *

The expected version of the security profile. A new version is generated whenever + * the security profile is updated. If you specify a value that is different from the actual + * version, a VersionConflictException is thrown.

*/ expectedVersion?: number; } @@ -631,17 +631,18 @@ export interface DescribeAccountAuditConfigurationRequest {} export interface DescribeAccountAuditConfigurationResponse { /** * @public - *

The ARN of the role that grants permission to IoT to access information about your - * devices, policies, certificates, and other items as required when performing an audit.

- *

On the first call to UpdateAccountAuditConfiguration, this parameter is - * required.

+ *

The ARN of the role that grants permission to IoT to access information + * about your devices, policies, certificates, and other items as required when + * performing an audit.

+ *

On the first call to UpdateAccountAuditConfiguration, + * this parameter is required.

*/ roleArn?: string; /** * @public - *

Information about the targets to which audit notifications are sent for this - * account.

+ *

Information about the targets to which audit notifications are sent for + * this account.

*/ auditNotificationTargetConfigurations?: Partial>; @@ -658,8 +659,7 @@ export interface DescribeAccountAuditConfigurationResponse { export interface DescribeAuditFindingRequest { /** * @public - *

A unique identifier for a single audit finding. You can use this identifier to apply - * mitigation actions to the finding.

+ *

A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.

*/ findingId: string | undefined; } @@ -740,15 +740,13 @@ export interface DescribeAuditMitigationActionsTaskResponse { /** * @public - *

Aggregate counts of the results when the mitigation tasks were applied to the findings for - * this audit mitigation actions task.

+ *

Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.

*/ taskStatistics?: Record; /** * @public - *

Identifies the findings to which the mitigation actions are applied. This can be by audit - * checks, by audit task, or a set of findings.

+ *

Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.

*/ target?: AuditMitigationActionsTaskTarget; @@ -760,8 +758,7 @@ export interface DescribeAuditMitigationActionsTaskResponse { /** * @public - *

Specifies the mitigation actions and their parameters that are applied as part of this - * task.

+ *

Specifies the mitigation actions and their parameters that are applied as part of this task.

*/ actionsDefinition?: MitigationAction[]; } @@ -895,8 +892,8 @@ export interface TaskStatistics { export interface DescribeAuditTaskResponse { /** * @public - *

The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or - * "CANCELED".

+ *

The status of the audit: one of "IN_PROGRESS", "COMPLETED", + * "FAILED", or "CANCELED".

*/ taskStatus?: AuditTaskStatus; @@ -1384,7 +1381,9 @@ export interface DescribeCertificateResponse { export interface DescribeCustomMetricRequest { /** * @public - *

The name of the custom metric.

+ *

+ * The name of the custom metric. + *

*/ metricName: string | undefined; } @@ -1395,13 +1394,17 @@ export interface DescribeCustomMetricRequest { export interface DescribeCustomMetricResponse { /** * @public - *

The name of the custom metric.

+ *

+ * The name of the custom metric. + *

*/ metricName?: string; /** * @public - *

The Amazon Resource Number (ARN) of the custom metric.

+ *

+ * The Amazon Resource Number (ARN) of the custom metric. + *

*/ metricArn?: string; @@ -1409,30 +1412,32 @@ export interface DescribeCustomMetricResponse { * @public *

The type of the custom metric.

* - *

The type number only takes a single metric value as an input, but while - * submitting the metrics value in the DeviceMetrics report, it must be passed as an array with - * a single value.

+ *

The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

* */ metricType?: CustomMetricType; /** * @public - *

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.

+ *

+ * 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. + *

*/ displayName?: string; /** * @public - *

The creation date of the custom metric in milliseconds since epoch.

+ *

+ * The creation date of the custom metric in milliseconds since epoch. + *

*/ creationDate?: Date; /** * @public - *

The time the custom metric was last modified in milliseconds since epoch.

+ *

+ * The time the custom metric was last modified in milliseconds since epoch. + *

*/ lastModifiedDate?: Date; } @@ -1459,7 +1464,9 @@ export interface DescribeDefaultAuthorizerResponse { export interface DescribeDetectMitigationActionsTaskRequest { /** * @public - *

The unique identifier of the task.

+ *

+ * The unique identifier of the task. + *

*/ taskId: string | undefined; } @@ -1663,7 +1670,9 @@ export interface DetectMitigationActionsTaskSummary { export interface DescribeDetectMitigationActionsTaskResponse { /** * @public - *

The description of a task.

+ *

+ * The description of a task. + *

*/ taskSummary?: DetectMitigationActionsTaskSummary; } @@ -1691,7 +1700,10 @@ export interface DescribeDimensionResponse { /** * @public - *

The Amazon Resource Name (ARN) for the dimension.

+ *

The Amazon Resource Name + * (ARN) + * for + * the dimension.

*/ arn?: string; @@ -1703,8 +1715,7 @@ export interface DescribeDimensionResponse { /** * @public - *

The value or list of values used to scope the dimension. For example, for topic filters, - * this is the pattern used to match the MQTT topic name.

+ *

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

*/ stringValues?: string[]; @@ -2431,10 +2442,11 @@ export interface Job { /** * @public - *

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.

+ *

The package version Amazon Resource Names (ARNs) that are installed on the device when the + * job successfully completes.

*

- * Note:The following Length Constraints relates to a single string. - * Up to five strings are allowed.

+ * Note:The following Length Constraints relates to a single ARN. + * Up to 25 package version ARNs are allowed.

*/ destinationPackageVersions?: string[]; } @@ -2696,10 +2708,11 @@ export interface DescribeJobTemplateResponse { /** * @public - *

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.

+ *

The package version Amazon Resource Names (ARNs) that are installed on the device when the + * job successfully completes.

*

- * Note:The following Length Constraints relates to a single string. - * Up to five strings are allowed.

+ * Note:The following Length Constraints relates to a single ARN. + * Up to 25 package version ARNs are allowed.

*/ destinationPackageVersions?: string[]; } @@ -2890,8 +2903,7 @@ export interface DescribeMitigationActionResponse { /** * @public - *

Parameters that control how the mitigation action is applied, specific to the type of - * mitigation action.

+ *

Parameters that control how the mitigation action is applied, specific to the type of mitigation action.

*/ actionParams?: MitigationActionParams; @@ -3127,35 +3139,41 @@ export interface DescribeScheduledAuditRequest { export interface DescribeScheduledAuditResponse { /** * @public - *

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.

+ *

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.

*/ frequency?: AuditFrequency; /** * @public - *

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.

+ *

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.

*/ dayOfMonth?: string; /** * @public - *

The day of the week on which the scheduled audit takes place, either one of - * SUN, MON, TUE, WED, THU, - * FRI, or SAT.

+ *

The day of the week on which the scheduled audit takes + * place, + * either one of + * SUN, MON, TUE, WED, THU, FRI, or SAT.

*/ dayOfWeek?: DayOfWeek; /** * @public - *

Which checks are performed during the scheduled audit. Checks must be enabled for your - * account. (Use DescribeAccountAuditConfiguration to see the list of all checks, - * including those that are enabled or use UpdateAccountAuditConfiguration to select - * which checks are enabled.)

+ *

Which checks are performed during the scheduled audit. Checks must be + * enabled for your account. (Use DescribeAccountAuditConfiguration to see the list + * of all checks, including those that are enabled or use UpdateAccountAuditConfiguration + * to select which checks are enabled.)

*/ targetCheckNames?: string[]; @@ -3178,7 +3196,8 @@ export interface DescribeScheduledAuditResponse { export interface DescribeSecurityProfileRequest { /** * @public - *

The name of the security profile whose information you want to get.

+ *

The name of the security profile + * whose information you want to get.

*/ securityProfileName: string | undefined; } @@ -3201,15 +3220,14 @@ export interface DescribeSecurityProfileResponse { /** * @public - *

A description of the security profile (associated with the security profile when it was - * created or updated).

+ *

A description of the security profile (associated with the security profile + * when it was created or updated).

*/ securityProfileDescription?: string; /** * @public - *

Specifies the behaviors that, when violated by a device (thing), cause an - * alert.

+ *

Specifies the behaviors that, when violated by a device (thing), cause an alert.

*/ behaviors?: Behavior[]; @@ -3224,27 +3242,31 @@ export interface DescribeSecurityProfileResponse { * @deprecated * *

- * Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 + * Please use + * DescribeSecurityProfileResponse$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.

+ *

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.

*/ additionalMetricsToRetain?: string[]; /** * @public *

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.

+ * metric used in the profile's behaviors, but + * it is + * also retained for any metric specified here.

*/ additionalMetricsToRetainV2?: MetricToRetain[]; /** * @public - *

The version of the security profile. A new version is generated whenever the security - * profile is updated.

+ *

The version of the security profile. A new version is generated whenever the + * security profile is updated.

*/ version?: number; @@ -3847,19 +3869,25 @@ export interface EnableTopicRuleRequest { export interface GetBehaviorModelTrainingSummariesRequest { /** * @public - *

The name of the security profile.

+ *

+ * The name of the security profile. + *

*/ securityProfileName?: string; /** * @public - *

The maximum number of results to return at one time. The default is 10.

+ *

+ * The maximum number of results to return at one time. The default is 10. + *

*/ maxResults?: number; /** * @public - *

The token for the next set of results.

+ *

+ * The token for the next set of results. + *

*/ nextToken?: string; } @@ -3941,15 +3969,17 @@ export interface BehaviorModelTrainingSummary { export interface GetBehaviorModelTrainingSummariesResponse { /** * @public - *

A list of all ML Detect behaviors and their model status for a given Security Profile. + *

+ * A list of all ML Detect behaviors and their model status for a given Security Profile. *

*/ summaries?: BehaviorModelTrainingSummary[]; /** * @public - *

A token that can be used to retrieve the next set of results, or null if - * there are no additional results.

+ *

+ * A token that can be used to retrieve the next set of results, or null if there are no additional results. + *

*/ nextToken?: string; } @@ -4248,9 +4278,60 @@ export type DeviceDefenderIndexingMode = (typeof DeviceDefenderIndexingMode)[key /** * @public - *

Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. - * To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and - * specify your shadow names in filter.

+ * @enum + */ +export const TargetFieldOrder = { + LatLon: "LatLon", + LonLat: "LonLat", +} as const; + +/** + * @public + */ +export type TargetFieldOrder = (typeof TargetFieldOrder)[keyof typeof TargetFieldOrder]; + +/** + * @public + *

A geolocation target that you select to index. Each geolocation target contains a + * name and order key-value pair that specifies the geolocation + * target fields.

+ */ +export interface GeoLocationTarget { + /** + * @public + *

The name of the geolocation target field. If the target field is part of a + * named shadow, you must select the named shadow using the namedShadow filter.

+ */ + name?: string; + + /** + * @public + *

The order of the geolocation target field. This field is optional. The + * default value is LatLon.

+ */ + order?: TargetFieldOrder; +} + +/** + * @public + *

Provides additional selections for named shadows and geolocation data.

+ *

To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to + * be ON and specify your shadow names in namedShadowNames filter.

+ *

To add geolocation data to your fleet indexing configuration:

+ *
    + *
  • + *

    If you store geolocation data in a class/unnamed shadow, set + * thingIndexingMode to be REGISTRY_AND_SHADOW and specify your + * geolocation data in geoLocations filter.

    + *
    • + *
  • + *

    If you store geolocation data in a named shadow, set + * namedShadowIndexingMode to be ON, add the shadow name in + * namedShadowNames filter, and specify your geolocation data in + * geoLocations filter. For more information, see Managing fleet + * indexing.

    + *
    • + *
*/ export interface IndexingFilter { /** @@ -4261,6 +4342,14 @@ export interface IndexingFilter { *

*/ namedShadowNames?: string[]; + + /** + * @public + *

The list of geolocation targets that you select to index. The default maximum number of + * geolocation targets for indexing is 1. To increase the limit, see Amazon Web Services IoT Device + * Management Quotas in the Amazon Web Services General Reference.

+ */ + geoLocations?: GeoLocationTarget[]; } /** @@ -4400,9 +4489,23 @@ export interface ThingIndexingConfiguration { /** * @public - *

Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. - * To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and - * specify your shadow names in filter.

+ *

Provides additional selections for named shadows and geolocation data.

+ *

To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to + * be ON and specify your shadow names in namedShadowNames filter.

+ *

To add geolocation data to your fleet indexing configuration:

+ *
    + *
  • + *

    If you store geolocation data in a class/unnamed shadow, set + * thingIndexingMode to be REGISTRY_AND_SHADOW and specify your + * geolocation data in geoLocations filter.

    + *
    • + *
  • + *

    If you store geolocation data in a named shadow, set namedShadowIndexingMode + * to be ON, add the shadow name in namedShadowNames filter, and + * specify your geolocation data in geoLocations filter. For more information, see + * Managing fleet indexing.

    + *
    • + *
*/ filter?: IndexingFilter; } @@ -5284,13 +5387,17 @@ export interface ListActiveViolationsRequest { /** * @public - *

The criteria for a behavior.

+ *

+ * The criteria for a behavior. + *

*/ behaviorCriteriaType?: BehaviorCriteriaType; /** * @public - *

A list of all suppressed alerts.

+ *

+ * A list of all suppressed alerts. + *

*/ listSuppressedAlerts?: boolean; @@ -5325,8 +5432,8 @@ export interface ListActiveViolationsResponse { /** * @public - *

A token that can be used to retrieve the next set of results, or null if - * there are no additional results.

+ *

A token that can be used to retrieve the next set of results, + * or null if there are no additional results.

*/ nextToken?: string; } @@ -5384,8 +5491,8 @@ export interface ListAttachedPoliciesResponse { export interface ListAuditFindingsRequest { /** * @public - *

A filter to limit results to the audit with the specified ID. You must specify either the - * taskId or the startTime and endTime, but not both.

+ *

A filter to limit results to the audit with the specified ID. You must + * specify either the taskId or the startTime and endTime, but not both.

*/ taskId?: string; @@ -5415,15 +5522,15 @@ export interface ListAuditFindingsRequest { /** * @public - *

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.

+ *

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.

*/ startTime?: Date; /** * @public - *

A filter to limit results to those found before the specified time. You must specify - * either the startTime and endTime or the taskId, but not both.

+ *

A filter to limit results to those found before the specified time. You must + * specify either the startTime and endTime or the taskId, but not both.

*/ endTime?: Date; @@ -5448,8 +5555,8 @@ export interface ListAuditFindingsResponse { /** * @public - *

A token that can be used to retrieve the next set of results, or null if - * there are no additional results.

+ *

A token that can be used to retrieve the next set of results, or null + * if there are no additional results.

*/ nextToken?: string; } @@ -5460,8 +5567,7 @@ export interface ListAuditFindingsResponse { export interface ListAuditMitigationActionsExecutionsRequest { /** * @public - *

Specify this filter to limit results to actions for a specific audit mitigation actions - * task.

+ *

Specify this filter to limit results to actions for a specific audit mitigation actions task.

*/ taskId: string | undefined; @@ -5473,8 +5579,7 @@ export interface ListAuditMitigationActionsExecutionsRequest { /** * @public - *

Specify this filter to limit results to those that were applied to a specific audit - * finding.

+ *

Specify this filter to limit results to those that were applied to a specific audit finding.

*/ findingId: string | undefined; @@ -5497,8 +5602,7 @@ export interface ListAuditMitigationActionsExecutionsRequest { export interface ListAuditMitigationActionsExecutionsResponse { /** * @public - *

A set of task execution results based on the input parameters. Details include the - * mitigation action applied, start time, and task status.

+ *

A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.

*/ actionsExecutions?: AuditMitigationActionExecutionMetadata[]; @@ -5515,15 +5619,13 @@ export interface ListAuditMitigationActionsExecutionsResponse { export interface ListAuditMitigationActionsTasksRequest { /** * @public - *

Specify this filter to limit results to tasks that were applied to results for a specific - * audit.

+ *

Specify this filter to limit results to tasks that were applied to results for a specific audit.

*/ auditTaskId?: string; /** * @public - *

Specify this filter to limit results to tasks that were applied to a specific audit - * finding.

+ *

Specify this filter to limit results to tasks that were applied to a specific audit finding.

*/ findingId?: string; @@ -5547,15 +5649,13 @@ export interface ListAuditMitigationActionsTasksRequest { /** * @public - *

Specify this filter to limit results to tasks that began on or after a specific date and - * time.

+ *

Specify this filter to limit results to tasks that began on or after a specific date and time.

*/ startTime: Date | undefined; /** * @public - *

Specify this filter to limit results to tasks that were completed or canceled on or before - * a specific date and time.

+ *

Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.

*/ endTime: Date | undefined; } @@ -5648,9 +5748,9 @@ export interface ListAuditSuppressionsResponse { export interface ListAuditTasksRequest { /** * @public - *

The beginning of the time period. Audit information is retained for a limited time (90 - * days). Requesting a start time prior to what is retained results in an - * "InvalidRequestException".

+ *

The beginning of the time period. Audit information is retained for a + * limited time (90 days). Requesting a start time prior to what is retained + * results in an "InvalidRequestException".

*/ startTime: Date | undefined; @@ -5663,14 +5763,14 @@ export interface ListAuditTasksRequest { /** * @public *

A filter to limit the output to the specified type of audit: can be one of - * "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".

+ * "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".

*/ taskType?: AuditTaskType; /** * @public - *

A filter to limit the output to audits with the specified completion status: can be one of - * "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

+ *

A filter to limit the output to audits with the specified completion + * status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

*/ taskStatus?: AuditTaskStatus; @@ -5699,8 +5799,8 @@ export interface ListAuditTasksResponse { /** * @public - *

A token that can be used to retrieve the next set of results, or null if - * there are no additional results.

+ *

A token that can be used to retrieve the next set of results, or null + * if there are no additional results.

*/ nextToken?: string; } @@ -6021,13 +6121,17 @@ export interface ListCertificatesByCAResponse { export interface ListCustomMetricsRequest { /** * @public - *

The token for the next set of results.

+ *

+ * The token for the next set of results. + *

*/ nextToken?: string; /** * @public - *

The maximum number of results to return at one time. The default is 25.

+ *

+ * The maximum number of results to return at one time. The default is 25. + *

*/ maxResults?: number; } @@ -6038,14 +6142,18 @@ export interface ListCustomMetricsRequest { export interface ListCustomMetricsResponse { /** * @public - *

The name of the custom metric.

+ *

+ * The name of the custom metric. + *

*/ metricNames?: string[]; /** * @public - *

A token that can be used to retrieve the next set of results, or null if - * there are no additional results.

+ *

+ * A token that can be used to retrieve the next set of results, + * or null if there are no additional results. + *

*/ nextToken?: string; } @@ -6056,45 +6164,58 @@ export interface ListCustomMetricsResponse { export interface ListDetectMitigationActionsExecutionsRequest { /** * @public - *

The unique identifier of the task.

+ *

+ * The unique identifier of the task. + *

*/ taskId?: string; /** * @public - *

The unique identifier of the violation.

+ *

+ * The unique identifier of the violation. + *

*/ violationId?: string; /** * @public - *

The name of the thing whose mitigation actions are listed.

+ *

+ * The name of the thing whose mitigation actions are listed. + *

*/ thingName?: string; /** * @public - *

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.

+ *

+ * 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. + *

*/ startTime?: Date; /** * @public - *

The end of the time period for which ML Detect mitigation actions executions are - * returned.

+ *

+ * The end of the time period for which ML Detect mitigation actions executions are returned. + *

*/ endTime?: Date; /** * @public - *

The maximum number of results to return at one time. The default is 25.

+ *

+ * The maximum number of results to return at one time. The default is 25. + *

*/ maxResults?: number; /** * @public - *

The token for the next set of results.

+ *

+ * The token for the next set of results. + *

*/ nextToken?: string; } @@ -6202,14 +6323,17 @@ export interface DetectMitigationActionExecution { export interface ListDetectMitigationActionsExecutionsResponse { /** * @public - *

List of actions executions.

+ *

+ * List of actions executions. + *

*/ actionsExecutions?: DetectMitigationActionExecution[]; /** * @public - *

A token that can be used to retrieve the next set of results, or null if - * there are no additional results.

+ *

+ * A token that can be used to retrieve the next set of results, or null if there are no additional results. + *

*/ nextToken?: string; } @@ -6226,20 +6350,25 @@ export interface ListDetectMitigationActionsTasksRequest { /** * @public - *

The token for the next set of results.

+ *

+ * The token for the next set of results. + *

*/ nextToken?: string; /** * @public - *

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.

+ *

+ * 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. + *

*/ startTime: Date | undefined; /** * @public - *

The end of the time period for which ML Detect mitigation actions tasks are returned. + *

+ * The end of the time period for which ML Detect mitigation actions tasks are returned. *

*/ endTime: Date | undefined; @@ -6251,14 +6380,17 @@ export interface ListDetectMitigationActionsTasksRequest { export interface ListDetectMitigationActionsTasksResponse { /** * @public - *

The collection of ML Detect mitigation tasks that matched the filter criteria.

+ *

+ * The collection of ML Detect mitigation tasks that matched the filter criteria. + *

*/ tasks?: DetectMitigationActionsTaskSummary[]; /** * @public - *

A token that can be used to retrieve the next set of results, or null if - * there are no additional results.

+ *

+ * A token that can be used to retrieve the next set of results, or null if there are no additional results. + *

*/ nextToken?: string; } @@ -6286,15 +6418,13 @@ export interface ListDimensionsRequest { export interface ListDimensionsResponse { /** * @public - *

A list of the names of the defined dimensions. Use DescribeDimension to get - * details for a dimension.

+ *

A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.

*/ dimensionNames?: string[]; /** * @public - *

A token that can be used to retrieve the next set of results, or null if - * there are no additional results.

+ *

A token that can be used to retrieve the next set of results, or null if there are no additional results.

*/ nextToken?: string; } @@ -7037,8 +7167,8 @@ export interface ListMetricValuesResponse { /** * @public - *

A token that can be used to retrieve the next set of results, or null if - * there are no additional results.

+ *

A token that can be used to retrieve the next set of results, or null + * if there are no additional results.

*/ nextToken?: string; } @@ -7049,8 +7179,7 @@ export interface ListMetricValuesResponse { export interface ListMitigationActionsRequest { /** * @public - *

Specify a value to limit the result to mitigation actions with a specific action - * type.

+ *

Specify a value to limit the result to mitigation actions with a specific action type.

*/ actionType?: MitigationActionType; @@ -7447,56 +7576,6 @@ export interface ListPoliciesResponse { nextMarker?: string; } -/** - * @public - *

The input for the ListPolicyPrincipals operation.

- */ -export interface ListPolicyPrincipalsRequest { - /** - * @public - *

The policy name.

- */ - policyName: string | undefined; - - /** - * @public - *

The marker for the next set of results.

- */ - marker?: string; - - /** - * @public - *

The result page size.

- */ - pageSize?: number; - - /** - * @public - *

Specifies the order for results. If true, the results are returned in ascending - * creation order.

- */ - ascendingOrder?: boolean; -} - -/** - * @public - *

The output from the ListPolicyPrincipals operation.

- */ -export interface ListPolicyPrincipalsResponse { - /** - * @public - *

The descriptions of the principals.

- */ - principals?: string[]; - - /** - * @public - *

The marker for the next set of results, or null if there are no additional - * results.

- */ - nextMarker?: string; -} - /** * @internal */ diff --git a/clients/client-iot/src/models/models_2.ts b/clients/client-iot/src/models/models_2.ts index 2981c9d25675..4857338233ff 100644 --- a/clients/client-iot/src/models/models_2.ts +++ b/clients/client-iot/src/models/models_2.ts @@ -68,6 +68,56 @@ import { ViolationEventOccurrenceRange, } from "./models_1"; +/** + * @public + *

The input for the ListPolicyPrincipals operation.

+ */ +export interface ListPolicyPrincipalsRequest { + /** + * @public + *

The policy name.

+ */ + policyName: string | undefined; + + /** + * @public + *

The marker for the next set of results.

+ */ + marker?: string; + + /** + * @public + *

The result page size.

+ */ + pageSize?: number; + + /** + * @public + *

Specifies the order for results. If true, the results are returned in ascending + * creation order.

+ */ + ascendingOrder?: boolean; +} + +/** + * @public + *

The output from the ListPolicyPrincipals operation.

+ */ +export interface ListPolicyPrincipalsResponse { + /** + * @public + *

The descriptions of the principals.

+ */ + principals?: string[]; + + /** + * @public + *

The marker for the next set of results, or null if there are no additional + * results.

+ */ + nextMarker?: string; +} + /** * @public *

The input for the ListPolicyVersions operation.

@@ -372,8 +422,8 @@ export interface ListRelatedResourcesForAuditFindingRequest { /** * @public - *

A token that can be used to retrieve the next set of results, or null if - * there are no additional results.

+ *

A token that can be used to retrieve the next set of results, + * or null if there are no additional results.

*/ nextToken?: string; @@ -396,8 +446,8 @@ export interface ListRelatedResourcesForAuditFindingResponse { /** * @public - *

A token that can be used to retrieve the next set of results, or null for the - * first API call.

+ *

A token that can be used to retrieve the next set of results, + * or null for the first API call.

*/ nextToken?: string; } @@ -511,8 +561,8 @@ export interface ListScheduledAuditsResponse { /** * @public - *

A token that can be used to retrieve the next set of results, or null if - * there are no additional results.

+ *

A token that can be used to retrieve the next set of results, + * or null if there are no additional results.

*/ nextToken?: string; } @@ -535,15 +585,16 @@ export interface ListSecurityProfilesRequest { /** * @public - *

A filter to limit results to the security profiles that use the defined dimension. Cannot - * be used with metricName + *

A filter to limit results to the security profiles that use the defined dimension. + * Cannot be used with metricName *

*/ dimensionName?: string; /** * @public - *

The name of the custom metric. Cannot be used with dimensionName.

+ *

The name of the custom metric. + * Cannot be used with dimensionName.

*/ metricName?: string; } @@ -578,8 +629,8 @@ export interface ListSecurityProfilesResponse { /** * @public - *

A token that can be used to retrieve the next set of results, or null if - * there are no additional results.

+ *

A token that can be used to retrieve the next set of results, or null if there are no + * additional results.

*/ nextToken?: string; } @@ -608,8 +659,7 @@ export interface ListSecurityProfilesForTargetRequest { /** * @public - *

The ARN of the target (thing group) whose attached security profiles you want to - * get.

+ *

The ARN of the target (thing group) whose attached security profiles you want to get.

*/ securityProfileTargetArn: string | undefined; } @@ -657,8 +707,8 @@ export interface ListSecurityProfilesForTargetResponse { /** * @public - *

A token that can be used to retrieve the next set of results, or null if - * there are no additional results.

+ *

A token that can be used to retrieve the next set of results, or null if there are no + * additional results.

*/ nextToken?: string; } @@ -844,8 +894,8 @@ export interface ListTargetsForSecurityProfileResponse { /** * @public - *

A token that can be used to retrieve the next set of results, or null if - * there are no additional results.

+ *

A token that can be used to retrieve the next set of results, or null if there are no + * additional results.

*/ nextToken?: string; } @@ -1717,20 +1767,23 @@ export interface ListViolationEventsRequest { /** * @public - *

A filter to limit results to those alerts generated by the specified security - * profile.

+ *

A filter to limit results to those alerts generated by the specified security profile.

*/ securityProfileName?: string; /** * @public - *

The criteria for a behavior.

+ *

+ * The criteria for a behavior. + *

*/ behaviorCriteriaType?: BehaviorCriteriaType; /** * @public - *

A list of all suppressed alerts.

+ *

+ * A list of all suppressed alerts. + *

*/ listSuppressedAlerts?: boolean; @@ -1842,16 +1895,15 @@ export interface ViolationEvent { export interface ListViolationEventsResponse { /** * @public - *

The security profile violation alerts issued for this account during the given time - * period, potentially filtered by security profile, behavior violated, or thing (device) - * violating.

+ *

The security profile violation alerts issued for this account during the given time period, + * potentially filtered by security profile, behavior violated, or thing (device) violating.

*/ violationEvents?: ViolationEvent[]; /** * @public - *

A token that can be used to retrieve the next set of results, or null if - * there are no additional results.

+ *

A token that can be used to retrieve the next set of results, or null if there are no + * additional results.

*/ nextToken?: string; } @@ -2286,7 +2338,8 @@ export interface SearchIndexRequest { /** * @public - *

The maximum number of results to return at one time. The response might contain fewer results but will never contain more.

+ *

The maximum number of results to return per page at one time. The response might + * contain fewer results but will never contain more.

*/ maxResults?: number; @@ -2562,31 +2615,28 @@ export interface SetV2LoggingOptionsRequest { export interface StartAuditMitigationActionsTaskRequest { /** * @public - *

A unique identifier for the task. You can use this identifier to check the status of the - * task or to cancel it.

+ *

A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

*/ taskId: string | undefined; /** * @public *

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 + * them to a type of audit check, to all findings from an audit, or to a + * specific set of * findings.

*/ target: AuditMitigationActionsTaskTarget | undefined; /** * @public - *

For an audit check, specifies which mitigation actions to apply. Those actions must be - * defined in your Amazon Web Services accounts.

+ *

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.

*/ auditCheckToActionsMapping: Record | undefined; /** * @public - *

Each audit mitigation task must have a unique client request token. If you try to start a - * new task with the same token as a task that already exists, an exception occurs. If you omit - * this value, a unique client request token is generated automatically.

+ *

Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

*/ clientRequestToken?: string; } @@ -2597,8 +2647,7 @@ export interface StartAuditMitigationActionsTaskRequest { export interface StartAuditMitigationActionsTaskResponse { /** * @public - *

The unique identifier for the audit mitigation task. This matches the taskId - * that you specified in the request.

+ *

The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.

*/ taskId?: string; } @@ -2631,45 +2680,57 @@ export class TaskAlreadyExistsException extends __BaseException { export interface StartDetectMitigationActionsTaskRequest { /** * @public - *

The unique identifier of the task.

+ *

+ * The unique identifier of the task. + *

*/ taskId: string | undefined; /** * @public - *

Specifies the ML Detect findings to which the mitigation actions are applied.

+ *

+ * Specifies the ML Detect findings to which the mitigation actions are applied. + *

*/ target: DetectMitigationActionsTaskTarget | undefined; /** * @public - *

The actions to be performed when a device has unexpected behavior.

+ *

+ * The actions to be performed when a device has unexpected behavior. + *

*/ actions: string[] | undefined; /** * @public - *

Specifies the time period of which violation events occurred between.

+ *

+ * Specifies the time period of which violation events occurred between. + *

*/ violationEventOccurrenceRange?: ViolationEventOccurrenceRange; /** * @public - *

Specifies to list only active violations.

+ *

+ * Specifies to list only active violations. + *

*/ includeOnlyActiveViolations?: boolean; /** * @public - *

Specifies to include suppressed alerts.

+ *

+ * Specifies to include suppressed alerts. + *

*/ includeSuppressedAlerts?: boolean; /** * @public - *

Each mitigation action task must have a unique client request token. If you try to create - * a new task with the same token as a task that already exists, an exception occurs. If you omit - * this value, Amazon Web Services SDKs will automatically generate a unique client request.

+ *

+ * Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request. + *

*/ clientRequestToken?: string; } @@ -2680,7 +2741,9 @@ export interface StartDetectMitigationActionsTaskRequest { export interface StartDetectMitigationActionsTaskResponse { /** * @public - *

The unique identifier of the task.

+ *

+ * The unique identifier of the task. + *

*/ taskId?: string; } @@ -2691,10 +2754,10 @@ export interface StartDetectMitigationActionsTaskResponse { export interface StartOnDemandAuditTaskRequest { /** * @public - *

Which checks are performed during the audit. The checks you specify must be enabled for - * your account or an exception occurs. Use DescribeAccountAuditConfiguration to see - * the list of all checks, including those that are enabled or - * UpdateAccountAuditConfiguration to select which checks are enabled.

+ *

Which checks are performed during the audit. The checks you specify must be enabled + * for your account or an exception occurs. Use DescribeAccountAuditConfiguration + * to see the list of all checks, including those that are enabled or + * UpdateAccountAuditConfiguration to select which checks are enabled.

*/ targetCheckNames: string[] | undefined; } @@ -3082,9 +3145,14 @@ export interface UntagResourceResponse {} export interface UpdateAccountAuditConfigurationRequest { /** * @public - *

The Amazon Resource Name (ARN) of the role that grants permission to IoT to access - * information about your devices, policies, certificates, and other items as required when - * performing an audit.

+ *

The Amazon + * Resource Name + * (ARN) + * of the role that grants permission + * to + * IoT to access information about your devices, policies, + * certificates, + * and other items as required when performing an audit.

*/ roleArn?: string; @@ -3097,14 +3165,18 @@ export interface UpdateAccountAuditConfigurationRequest { /** * @public *

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.

+ * 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.

*/ auditCheckConfigurations?: Record; } @@ -3332,15 +3404,21 @@ export interface UpdateCertificateRequest { export interface UpdateCustomMetricRequest { /** * @public - *

The name of the custom metric. Cannot be updated.

+ *

The name of the custom metric. + * Cannot be updated.

*/ metricName: string | undefined; /** * @public - *

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.

+ *

+ * 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.

*/ displayName: string | undefined; } @@ -3351,13 +3429,17 @@ export interface UpdateCustomMetricRequest { export interface UpdateCustomMetricResponse { /** * @public - *

The name of the custom metric.

+ *

+ * The name of the custom metric. + *

*/ metricName?: string; /** * @public - *

The Amazon Resource Number (ARN) of the custom metric.

+ *

+ * The Amazon Resource Number (ARN) of the custom metric. + *

*/ metricArn?: string; @@ -3365,28 +3447,32 @@ export interface UpdateCustomMetricResponse { * @public *

The type of the custom metric.

* - *

The type number only takes a single metric value as an input, but while - * submitting the metrics value in the DeviceMetrics report, it must be passed as an array with - * a single value.

+ *

The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

* */ metricType?: CustomMetricType; /** * @public - *

A friendly name in the console for the custom metric

+ *

+ * A friendly name in the console for the custom metric + *

*/ displayName?: string; /** * @public - *

The creation date of the custom metric in milliseconds since epoch.

+ *

+ * The creation date of the custom metric in milliseconds since epoch. + *

*/ creationDate?: Date; /** * @public - *

The time the custom metric was last modified in milliseconds since epoch.

+ *

+ * The time the custom metric was last modified in milliseconds since epoch. + *

*/ lastModifiedDate?: Date; } @@ -3397,15 +3483,13 @@ export interface UpdateCustomMetricResponse { export interface UpdateDimensionRequest { /** * @public - *

A unique identifier for the dimension. Choose something that describes the type and value - * to make it easy to remember what it does.

+ *

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

*/ name: string | undefined; /** * @public - *

Specifies the value or list of values for the dimension. For TOPIC_FILTER - * dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

+ *

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

*/ stringValues: string[] | undefined; } @@ -3422,7 +3506,9 @@ export interface UpdateDimensionResponse { /** * @public - *

The Amazon Resource Name (ARN)of the created dimension.

+ *

The Amazon Resource + * Name (ARN)of + * the created dimension.

*/ arn?: string; @@ -3434,22 +3520,19 @@ export interface UpdateDimensionResponse { /** * @public - *

The value or list of values used to scope the dimension. For example, for topic filters, - * this is the pattern used to match the MQTT topic name.

+ *

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

*/ stringValues?: string[]; /** * @public - *

The date and time, in milliseconds since epoch, when the dimension was initially - * created.

+ *

The date and time, in milliseconds since epoch, when the dimension was initially created.

*/ creationDate?: Date; /** * @public - *

The date and time, in milliseconds since epoch, when the dimension was most recently - * updated.

+ *

The date and time, in milliseconds since epoch, when the dimension was most recently updated.

*/ lastModifiedDate?: Date; } @@ -3738,8 +3821,9 @@ export interface UpdateMitigationActionRequest { /** * @public *

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.

+ * UpdateMitigationAction. Instead, you must delete and + * recreate the + * mitigation action with the new name.

*/ actionName: string | undefined; @@ -4012,37 +4096,41 @@ export interface UpdateRoleAliasResponse { export interface UpdateScheduledAuditRequest { /** * @public - *

How often the scheduled audit takes place, either DAILY, WEEKLY, - * BIWEEKLY, or MONTHLY. The start time of each audit is determined - * by the system.

+ *

How often the scheduled audit takes + * place, + * either DAILY, + * WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the + * system.

*/ frequency?: AuditFrequency; /** * @public - *

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.

+ *

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.

*/ dayOfMonth?: string; /** * @public - *

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.

+ *

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.

*/ dayOfWeek?: DayOfWeek; /** * @public - *

Which checks are performed during the scheduled audit. Checks must be enabled for your - * account. (Use DescribeAccountAuditConfiguration to see the list of all checks, - * including those that are enabled or use UpdateAccountAuditConfiguration to select - * which checks are enabled.)

+ *

Which checks are performed during the scheduled audit. Checks must be enabled + * for your account. (Use DescribeAccountAuditConfiguration to see the list + * of all checks, including those that are enabled or use UpdateAccountAuditConfiguration + * to select which checks are enabled.)

*/ targetCheckNames?: string[]; @@ -4082,8 +4170,7 @@ export interface UpdateSecurityProfileRequest { /** * @public - *

Specifies the behaviors that, when violated by a device (thing), cause an - * alert.

+ *

Specifies the behaviors that, when violated by a device (thing), cause an alert.

*/ behaviors?: Behavior[]; @@ -4098,51 +4185,51 @@ export interface UpdateSecurityProfileRequest { * @deprecated * *

- * Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 - * instead. + * 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.

+ *

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.

*/ additionalMetricsToRetain?: string[]; /** * @public - *

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.

+ *

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.

*/ additionalMetricsToRetainV2?: MetricToRetain[]; /** * @public - *

If true, delete all behaviors defined for this security profile. If any - * behaviors are defined in the current invocation, an exception occurs.

+ *

If true, delete all behaviors defined for this security profile. + * If any behaviors are defined in the current invocation, an exception occurs.

*/ deleteBehaviors?: boolean; /** * @public - *

If true, delete all alertTargets defined for this security profile. If any - * alertTargets are defined in the current invocation, an exception - * occurs.

+ *

If true, delete all alertTargets defined for this security profile. + * If any alertTargets are defined in the current invocation, an exception occurs.

*/ deleteAlertTargets?: boolean; /** * @public - *

If true, delete all additionalMetricsToRetain defined for this security - * profile. If any additionalMetricsToRetain are defined in the current invocation, - * an exception occurs.

+ *

If true, delete all additionalMetricsToRetain defined for this + * security profile. If any additionalMetricsToRetain are defined in the current + * invocation, an exception occurs.

*/ deleteAdditionalMetricsToRetain?: boolean; /** * @public - *

The expected version of the security profile. A new version is generated whenever the - * security profile is updated. If you specify a value that is different from the actual version, - * a VersionConflictException is thrown.

+ *

The expected version of the security profile. A new version is generated whenever + * the security profile is updated. If you specify a value that is different from the actual + * version, a VersionConflictException is thrown.

*/ expectedVersion?: number; @@ -4183,8 +4270,7 @@ export interface UpdateSecurityProfileResponse { /** * @public - *

Specifies the behaviors that, when violated by a device (thing), cause an - * alert.

+ *

Specifies the behaviors that, when violated by a device (thing), cause an alert.

*/ behaviors?: Behavior[]; @@ -4199,20 +4285,21 @@ export interface UpdateSecurityProfileResponse { * @deprecated * *

- * Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 - * instead. + * Please use + * UpdateSecurityProfileResponse$additionalMetricsToRetainV2 + * instead. *

- *

A list of metrics whose data is retained (stored). By default, data is retained for any - * metric used in the security profile's behaviors, but it is also retained for any - * metric specified here.

+ *

A list of metrics + * whose data is retained (stored). By default, data is retained for any metric + * used in the security profile's behaviors, but + * it is + * also retained for any metric specified here.

*/ additionalMetricsToRetain?: string[]; /** * @public - *

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.

+ *

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.

*/ additionalMetricsToRetainV2?: MetricToRetain[]; @@ -4483,8 +4570,7 @@ export interface UpdateTopicRuleDestinationResponse {} export interface ValidateSecurityProfileBehaviorsRequest { /** * @public - *

Specifies the behaviors that, when violated by a device (thing), cause an - * alert.

+ *

Specifies the behaviors that, when violated by a device (thing), cause an alert.

*/ behaviors: Behavior[] | undefined; } diff --git a/clients/client-iot/src/protocols/Aws_restJson1.ts b/clients/client-iot/src/protocols/Aws_restJson1.ts index daef341ce11a..c9934812e22d 100644 --- a/clients/client-iot/src/protocols/Aws_restJson1.ts +++ b/clients/client-iot/src/protocols/Aws_restJson1.ts @@ -865,6 +865,7 @@ import { DetectMitigationActionsTaskTarget, EventType, Field, + GeoLocationTarget, IndexingFilter, Job, JobExecution, @@ -24517,6 +24518,10 @@ const se_ExponentialRolloutRate = (input: ExponentialRolloutRate, context: __Ser // se_FirehoseAction omitted. +// se_GeoLocationsFilter omitted. + +// se_GeoLocationTarget omitted. + // se_HeaderList omitted. // se_HttpAction omitted. @@ -25487,6 +25492,10 @@ const de_ExponentialRolloutRate = (output: any, context: __SerdeContext): Expone // de_FleetMetricNameAndArnList omitted. +// de_GeoLocationsFilter omitted. + +// de_GeoLocationTarget omitted. + // de_GroupNameAndArn omitted. // de_HeaderList omitted. diff --git a/codegen/sdk-codegen/aws-models/iot.json b/codegen/sdk-codegen/aws-models/iot.json index f108c87db2aa..920041bc6cb6 100644 --- a/codegen/sdk-codegen/aws-models/iot.json +++ b/codegen/sdk-codegen/aws-models/iot.json @@ -2965,7 +2965,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a Device Defender security profile with a thing group or this account. Each\n thing group or account can have up to five security profiles associated with it.

\n

Requires permission to access the AttachSecurityProfile action.

", + "smithy.api#documentation": "

Associates a Device Defender security profile with a thing group or this account. Each \n thing group or account can have up to five security profiles associated with it.

\n

Requires permission to access the AttachSecurityProfile action.

", "smithy.api#http": { "method": "PUT", "uri": "/security-profiles/{securityProfileName}/targets", @@ -4855,7 +4855,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a mitigation action task that is in progress. If the task is not in progress, an\n InvalidRequestException occurs.

\n

Requires permission to access the CancelAuditMitigationActionsTask action.

", + "smithy.api#documentation": "

Cancels a mitigation action task that is in progress. If the task\n is not\n in progress, an InvalidRequestException occurs.

\n

Requires permission to access the CancelAuditMitigationActionsTask action.

", "smithy.api#http": { "method": "PUT", "uri": "/audit/mitigationactions/tasks/{taskId}/cancel", @@ -4909,7 +4909,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels an audit that is in progress. The audit can be either scheduled or on demand. If\n the audit isn't in progress, an \"InvalidRequestException\" occurs.

\n

Requires permission to access the CancelAuditTask action.

", + "smithy.api#documentation": "

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.

\n

Requires permission to access the CancelAuditTask action.

", "smithy.api#http": { "method": "PUT", "uri": "/audit/tasks/{taskId}/cancel", @@ -4923,7 +4923,7 @@ "taskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { - "smithy.api#documentation": "

The ID of the audit you want to cancel. You can only cancel an audit that is\n \"IN_PROGRESS\".

", + "smithy.api#documentation": "

The ID of the audit you want to cancel. You can only cancel an\n audit that is \"IN_PROGRESS\".

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5020,7 +5020,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a Device Defender ML Detect mitigation action.

\n

Requires permission to access the CancelDetectMitigationActionsTask action.

", + "smithy.api#documentation": "

\n Cancels a Device Defender ML Detect mitigation action.\n

\n

Requires permission to access the CancelDetectMitigationActionsTask action.

", "smithy.api#http": { "method": "PUT", "uri": "/detect/mitigationactions/tasks/{taskId}/cancel", @@ -5034,7 +5034,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

The unique identifier of the task.

", + "smithy.api#documentation": "

\n The unique identifier of the task.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6540,7 +6540,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use this API to define a Custom Metric published by your devices to Device Defender.

\n

Requires permission to access the CreateCustomMetric action.

", + "smithy.api#documentation": "

Use this API to define a\n Custom\n Metric\n published by your devices to Device Defender.

\n

Requires permission to access the CreateCustomMetric action.

", "smithy.api#http": { "method": "POST", "uri": "/custom-metric/{metricName}", @@ -6575,13 +6575,13 @@ "tags": { "target": "com.amazonaws.iot#TagList", "traits": { - "smithy.api#documentation": "

Metadata that can be used to manage the custom metric.

" + "smithy.api#documentation": "

\n Metadata that can be used to manage the custom metric.\n

" } }, "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { - "smithy.api#documentation": "

Each custom metric must have a unique client request token. If you try to create a new\n custom metric that already exists with a different token, an exception occurs. If you omit\n this value, Amazon Web Services SDKs will automatically generate a unique client request.

", + "smithy.api#documentation": "

Each custom\n metric must have a unique client request token. If you try to create a new custom metric that\n already exists with a different token,\n an exception\n occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -6597,7 +6597,7 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "

The name of the custom metric to be used in the metric report.

" + "smithy.api#documentation": "

\n The name of the custom metric to be used in the metric report.\n

" } }, "metricArn": { @@ -6637,7 +6637,7 @@ } ], "traits": { - "smithy.api#documentation": "

Create a dimension that you can use to limit the scope of a metric used in a security\n profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow\n down the scope of the metric only to MQTT topics whose name match the pattern specified in the\n dimension.

\n

Requires permission to access the CreateDimension action.

", + "smithy.api#documentation": "

Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. \n 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.

\n

Requires permission to access the CreateDimension action.

", "smithy.api#http": { "method": "POST", "uri": "/dimensions/{name}", @@ -6651,7 +6651,7 @@ "name": { "target": "com.amazonaws.iot#DimensionName", "traits": { - "smithy.api#documentation": "

A unique identifier for the dimension. Choose something that describes the type and value\n to make it easy to remember what it does.

", + "smithy.api#documentation": "

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6666,7 +6666,7 @@ "stringValues": { "target": "com.amazonaws.iot#DimensionStringValues", "traits": { - "smithy.api#documentation": "

Specifies the value or list of values for the dimension. For TOPIC_FILTER\n dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").

", + "smithy.api#documentation": "

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").

", "smithy.api#required": {} } }, @@ -6679,7 +6679,7 @@ "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { - "smithy.api#documentation": "

Each dimension must have a unique client request token. If you try to create a new\n dimension with the same token as a dimension that already exists, an exception occurs. If you\n omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

", + "smithy.api#documentation": "

Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. \n If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -6701,7 +6701,7 @@ "arn": { "target": "com.amazonaws.iot#DimensionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created dimension.

" + "smithy.api#documentation": "

The Amazon Resource Name\n (ARN)\n of\n the created dimension.

" } } }, @@ -7249,7 +7249,7 @@ "destinationPackageVersions": { "target": "com.amazonaws.iot#DestinationPackageVersions", "traits": { - "smithy.api#documentation": "

The package version Amazon Resource Names (ARNs) that are installed on the device when the \n job successfully completes.

\n

\n Note:The following Length Constraints relates to a single string. \n Up to five strings are allowed.

" + "smithy.api#documentation": "

The package version Amazon Resource Names (ARNs) that are installed on the device when the \n job successfully completes.

\n

\n Note:The following Length Constraints relates to a single ARN. \n Up to 25 package version ARNs are allowed.

" } } }, @@ -7389,7 +7389,7 @@ "destinationPackageVersions": { "target": "com.amazonaws.iot#DestinationPackageVersions", "traits": { - "smithy.api#documentation": "

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.

\n

\n Note:The following Length Constraints relates to a single string. \n Up to five strings are allowed.

" + "smithy.api#documentation": "

The package version Amazon Resource Names (ARNs) that are installed on the device when the \n job successfully completes.

\n

\n Note:The following Length Constraints relates to a single ARN. \n Up to 25 package version ARNs are allowed.

" } } }, @@ -7527,7 +7527,7 @@ } ], "traits": { - "smithy.api#documentation": "

Defines an action that can be applied to audit findings by using\n StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to\n specific check names. For more information, see Mitigation\n actions. Each mitigation action can apply only one type of change.

\n

Requires permission to access the CreateMitigationAction action.

", + "smithy.api#documentation": "

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. \n For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

\n

Requires permission to access the CreateMitigationAction action.

", "smithy.api#http": { "method": "POST", "uri": "/mitigationactions/actions/{actionName}", @@ -7541,7 +7541,7 @@ "actionName": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { - "smithy.api#documentation": "

A friendly name for the action. Choose a friendly name that accurately describes the\n action (for example, EnableLoggingAction).

", + "smithy.api#documentation": "

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8640,7 +8640,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a scheduled audit that is run at a specified time interval.

\n

Requires permission to access the CreateScheduledAudit action.

", + "smithy.api#documentation": "

Creates a scheduled audit that is run at a specified \n time interval.

\n

Requires permission to access the CreateScheduledAudit action.

", "smithy.api#http": { "method": "POST", "uri": "/audit/scheduledaudits/{scheduledAuditName}", @@ -8654,26 +8654,26 @@ "frequency": { "target": "com.amazonaws.iot#AuditFrequency", "traits": { - "smithy.api#documentation": "

How often the scheduled audit takes place, either DAILY, WEEKLY,\n BIWEEKLY or MONTHLY. The start time of each audit is determined by\n the system.

", + "smithy.api#documentation": "

How often the scheduled audit takes\n place, either\n DAILY,\n WEEKLY, BIWEEKLY or MONTHLY. The start time of each audit is\n determined by the system.

", "smithy.api#required": {} } }, "dayOfMonth": { "target": "com.amazonaws.iot#DayOfMonth", "traits": { - "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place. This can be \"1\" through\n \"31\" or \"LAST\". This field is required if the \"frequency\" parameter is set to\n MONTHLY. If days 29 to 31 are specified, and the month doesn't have that many\n days, the audit takes place on the LAST day of the month.

" + "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place.\n This\n can be \"1\" through \"31\" or \"LAST\". This field is required if the \"frequency\"\n parameter is set to MONTHLY. If days\n 29\n to 31 are specified, and the month\n doesn't\n have that many days, the audit takes place on the LAST day of the month.

" } }, "dayOfWeek": { "target": "com.amazonaws.iot#DayOfWeek", "traits": { - "smithy.api#documentation": "

The day of the week on which the scheduled audit takes place, either SUN,\n MON, TUE, WED, THU, FRI, or\n SAT. This field is required if the frequency parameter is set to\n WEEKLY or BIWEEKLY.

" + "smithy.api#documentation": "

The day of the week on which the scheduled audit takes\n place,\n either\n SUN,\n MON, TUE, WED, THU, FRI, or SAT. This field is required if the frequency\n parameter is set to WEEKLY or BIWEEKLY.

" } }, "targetCheckNames": { "target": "com.amazonaws.iot#TargetAuditCheckNames", "traits": { - "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be enabled for your\n account. (Use DescribeAccountAuditConfiguration to see the list of all checks,\n including those that are enabled or use UpdateAccountAuditConfiguration to select\n which checks are enabled.)

", + "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be enabled \n for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)

", "smithy.api#required": {} } }, @@ -8761,13 +8761,13 @@ "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { - "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an\n alert.

" + "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" } }, "alertTargets": { "target": "com.amazonaws.iot#AlertTargets", "traits": { - "smithy.api#documentation": "

Specifies the destinations to which alerts are sent. (Alerts are always sent to the\n console.) Alerts are generated when a device (thing) violates a behavior.

" + "smithy.api#documentation": "

Specifies the destinations to which alerts are sent. (Alerts are always sent to the \n console.) Alerts are generated when a device (thing) violates a behavior.

" } }, "additionalMetricsToRetain": { @@ -8776,13 +8776,13 @@ "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, - "smithy.api#documentation": "

\n Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric\n specified here. Can be used with custom metrics; cannot be used with dimensions.

" + "smithy.api#documentation": "

\n Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.\n

\n

A list of metrics whose data is retained (stored). By default, data is retained \n for any metric used in the profile's behaviors, but it is also retained for \n any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

" } }, "additionalMetricsToRetainV2": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainV2List", "traits": { - "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric\n specified here. Can be used with custom metrics; cannot be used with dimensions.

" + "smithy.api#documentation": "

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.

" } }, "tags": { @@ -9551,7 +9551,7 @@ } ], "traits": { - "smithy.api#documentation": "

Restores the default settings for Device Defender audits for this account. Any\n configuration data you entered is deleted and all audit checks are reset to disabled.\n \n

\n

Requires permission to access the DeleteAccountAuditConfiguration action.

", + "smithy.api#documentation": "

Restores the default settings for Device Defender audits for this account. Any\n configuration data you entered is deleted and all audit checks are reset to \n disabled.

\n

Requires permission to access the DeleteAccountAuditConfiguration action.

", "smithy.api#http": { "method": "DELETE", "uri": "/audit/configuration", @@ -9948,7 +9948,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a Device Defender detect custom metric.

\n

Requires permission to access the DeleteCustomMetric action.

\n \n

Before you can delete a custom metric, you must first remove the custom metric from all\n security profiles it's a part of. The security profile associated with the custom metric can\n be found using the ListSecurityProfiles\n API with metricName set to your custom metric name.

\n ", + "smithy.api#documentation": "

\n Deletes a Device Defender detect custom metric.\n

\n

Requires permission to access the DeleteCustomMetric action.

\n \n

Before you can delete a custom metric, you must first remove the custom metric from all\n security profiles it's a part of.\n The\n security\n profile associated with the custom metric can be found using the ListSecurityProfiles\n API with metricName set to your custom metric name.

\n ", "smithy.api#http": { "method": "DELETE", "uri": "/custom-metric/{metricName}", @@ -9962,7 +9962,7 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "

The name of the custom metric.

", + "smithy.api#documentation": "

\n The name of the custom metric.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11145,7 +11145,7 @@ "expectedVersion": { "target": "com.amazonaws.iot#OptionalVersion", "traits": { - "smithy.api#documentation": "

The expected version of the security profile. A new version is generated whenever the\n security profile is updated. If you specify a value that is different from the actual version,\n a VersionConflictException is thrown.

", + "smithy.api#documentation": "

The expected version of the security profile. A new version is generated whenever\n the security profile is updated. If you specify a value that is different from the actual\n version, a VersionConflictException is thrown.

", "smithy.api#httpQuery": "expectedVersion" } } @@ -11697,7 +11697,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the Device Defender audit settings for this account. Settings\n include how audit notifications are sent and which audit checks are enabled or\n disabled.

\n

Requires permission to access the DescribeAccountAuditConfiguration action.

", + "smithy.api#documentation": "

Gets information about the Device Defender audit settings for this account.\n Settings include how audit notifications are sent and which audit checks are\n enabled or disabled.

\n

Requires permission to access the DescribeAccountAuditConfiguration action.

", "smithy.api#http": { "method": "GET", "uri": "/audit/configuration", @@ -11718,13 +11718,13 @@ "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the role that grants permission to IoT to access information about your\n devices, policies, certificates, and other items as required when performing an audit.

\n

On the first call to UpdateAccountAuditConfiguration, this parameter is\n required.

" + "smithy.api#documentation": "

The ARN of the role that grants permission to IoT to access information\n about your devices, policies, certificates, and other items as required when \n performing an audit.

\n

On the first call to UpdateAccountAuditConfiguration,\n this parameter is required.

" } }, "auditNotificationTargetConfigurations": { "target": "com.amazonaws.iot#AuditNotificationTargetConfigurations", "traits": { - "smithy.api#documentation": "

Information about the targets to which audit notifications are sent for this\n account.

" + "smithy.api#documentation": "

Information about the targets to which audit notifications are sent for \n this account.

" } }, "auditCheckConfigurations": { @@ -11761,7 +11761,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a single audit finding. Properties include the reason for\n noncompliance, the severity of the issue, and the start time when the audit that returned the\n finding.

\n

Requires permission to access the DescribeAuditFinding action.

", + "smithy.api#documentation": "

Gets information about a single audit finding. Properties include the reason for\n noncompliance, the severity of the issue,\n and the start time\n when the audit that returned the\n finding.

\n

Requires permission to access the DescribeAuditFinding action.

", "smithy.api#http": { "method": "GET", "uri": "/audit/findings/{findingId}", @@ -11775,7 +11775,7 @@ "findingId": { "target": "com.amazonaws.iot#FindingId", "traits": { - "smithy.api#documentation": "

A unique identifier for a single audit finding. You can use this identifier to apply\n mitigation actions to the finding.

", + "smithy.api#documentation": "

A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11819,7 +11819,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about an audit mitigation task that is used to apply mitigation actions\n to a set of audit findings. Properties include the actions being applied, the audit checks to\n which they're being applied, the task status, and aggregated task statistics.

", + "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "GET", "uri": "/audit/mitigationactions/tasks/{taskId}", @@ -11867,13 +11867,13 @@ "taskStatistics": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskStatistics", "traits": { - "smithy.api#documentation": "

Aggregate counts of the results when the mitigation tasks were applied to the findings for\n this audit mitigation actions task.

" + "smithy.api#documentation": "

Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.

" } }, "target": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskTarget", "traits": { - "smithy.api#documentation": "

Identifies the findings to which the mitigation actions are applied. This can be by audit\n checks, by audit task, or a set of findings.

" + "smithy.api#documentation": "

Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.

" } }, "auditCheckToActionsMapping": { @@ -11885,7 +11885,7 @@ "actionsDefinition": { "target": "com.amazonaws.iot#MitigationActionList", "traits": { - "smithy.api#documentation": "

Specifies the mitigation actions and their parameters that are applied as part of this\n task.

" + "smithy.api#documentation": "

Specifies the mitigation actions and their parameters that are applied as part of this task.

" } } }, @@ -12029,7 +12029,7 @@ "taskStatus": { "target": "com.amazonaws.iot#AuditTaskStatus", "traits": { - "smithy.api#documentation": "

The status of the audit: one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or\n \"CANCELED\".

" + "smithy.api#documentation": "

The status of the audit: one of \"IN_PROGRESS\", \"COMPLETED\",\n \"FAILED\", or \"CANCELED\".

" } }, "taskType": { @@ -12393,7 +12393,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a Device Defender detect custom metric.

\n

Requires permission to access the DescribeCustomMetric action.

", + "smithy.api#documentation": "

\n Gets information about a Device Defender detect custom metric.\n

\n

Requires permission to access the DescribeCustomMetric action.

", "smithy.api#http": { "method": "GET", "uri": "/custom-metric/{metricName}", @@ -12407,7 +12407,7 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "

The name of the custom metric.

", + "smithy.api#documentation": "

\n The name of the custom metric.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12423,37 +12423,37 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "

The name of the custom metric.

" + "smithy.api#documentation": "

\n The name of the custom metric.\n

" } }, "metricArn": { "target": "com.amazonaws.iot#CustomMetricArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the custom metric.

" + "smithy.api#documentation": "

\n The Amazon Resource Number (ARN) of the custom metric.\n

" } }, "metricType": { "target": "com.amazonaws.iot#CustomMetricType", "traits": { - "smithy.api#documentation": "

The type of the custom metric.

\n \n

The type number only takes a single metric value as an input, but while\n submitting the metrics value in the DeviceMetrics report, it must be passed as an array with\n a single value.

\n " + "smithy.api#documentation": "

The type of the custom metric.

\n \n

The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

\n " } }, "displayName": { "target": "com.amazonaws.iot#CustomMetricDisplayName", "traits": { - "smithy.api#documentation": "

Field represents a friendly name in the console for the custom metric; doesn't have to be\n unique. Don't use this name as the metric identifier in the device metric report. Can be\n updated.

" + "smithy.api#documentation": "

\n 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.\n

" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The creation date of the custom metric in milliseconds since epoch.

" + "smithy.api#documentation": "

\n The creation date of the custom metric in milliseconds since epoch.\n

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The time the custom metric was last modified in milliseconds since epoch.

" + "smithy.api#documentation": "

\n The time the custom metric was last modified in milliseconds since epoch.\n

" } } }, @@ -12542,7 +12542,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a Device Defender ML Detect mitigation action.

\n

Requires permission to access the DescribeDetectMitigationActionsTask action.

", + "smithy.api#documentation": "

\n Gets information about a Device Defender ML Detect mitigation action.\n

\n

Requires permission to access the DescribeDetectMitigationActionsTask action.

", "smithy.api#http": { "method": "GET", "uri": "/detect/mitigationactions/tasks/{taskId}", @@ -12556,7 +12556,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

The unique identifier of the task.

", + "smithy.api#documentation": "

\n The unique identifier of the task.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12572,7 +12572,7 @@ "taskSummary": { "target": "com.amazonaws.iot#DetectMitigationActionsTaskSummary", "traits": { - "smithy.api#documentation": "

The description of a task.

" + "smithy.api#documentation": "

\n The description of a task.\n

" } } }, @@ -12639,7 +12639,7 @@ "arn": { "target": "com.amazonaws.iot#DimensionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the dimension.

" + "smithy.api#documentation": "

The Amazon Resource Name\n (ARN)\n for\n the dimension.

" } }, "type": { @@ -12651,7 +12651,7 @@ "stringValues": { "target": "com.amazonaws.iot#DimensionStringValues", "traits": { - "smithy.api#documentation": "

The value or list of values used to scope the dimension. For example, for topic filters,\n this is the pattern used to match the MQTT topic name.

" + "smithy.api#documentation": "

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

" } }, "creationDate": { @@ -13387,7 +13387,7 @@ "destinationPackageVersions": { "target": "com.amazonaws.iot#DestinationPackageVersions", "traits": { - "smithy.api#documentation": "

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.

\n

\n Note:The following Length Constraints relates to a single string. \n Up to five strings are allowed.

" + "smithy.api#documentation": "

The package version Amazon Resource Names (ARNs) that are installed on the device when the \n job successfully completes.

\n

\n Note:The following Length Constraints relates to a single ARN. \n Up to 25 package version ARNs are allowed.

" } } }, @@ -13582,7 +13582,7 @@ "actionParams": { "target": "com.amazonaws.iot#MitigationActionParams", "traits": { - "smithy.api#documentation": "

Parameters that control how the mitigation action is applied, specific to the type of\n mitigation action.

" + "smithy.api#documentation": "

Parameters that control how the mitigation action is applied, specific to the type of mitigation action.

" } }, "creationDate": { @@ -13938,25 +13938,25 @@ "frequency": { "target": "com.amazonaws.iot#AuditFrequency", "traits": { - "smithy.api#documentation": "

How often the scheduled audit takes place, either one of DAILY,\n WEEKLY, BIWEEKLY, or MONTHLY. The start time of each\n audit is determined by the system.

" + "smithy.api#documentation": "

How often the scheduled audit takes\n place, either\n one of DAILY,\n WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the\n system.

" } }, "dayOfMonth": { "target": "com.amazonaws.iot#DayOfMonth", "traits": { - "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place. This is will be\n 1 through 31 or LAST. If days\n 29-31 are specified, and the month does not have that many days,\n the audit takes place on the LAST day of the month.

" + "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place.\n This is\n will be 1\n through 31 or LAST. If days\n 29-31\n are specified, and the month does not have that many days, the audit takes place on the LAST\n day of the month.

" } }, "dayOfWeek": { "target": "com.amazonaws.iot#DayOfWeek", "traits": { - "smithy.api#documentation": "

The day of the week on which the scheduled audit takes place, either one of\n SUN, MON, TUE, WED, THU,\n FRI, or SAT.

" + "smithy.api#documentation": "

The day of the week on which the scheduled audit takes\n place,\n either one of\n SUN, MON, TUE, WED, THU, FRI, or SAT.

" } }, "targetCheckNames": { "target": "com.amazonaws.iot#TargetAuditCheckNames", "traits": { - "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be enabled for your\n account. (Use DescribeAccountAuditConfiguration to see the list of all checks,\n including those that are enabled or use UpdateAccountAuditConfiguration to select\n which checks are enabled.)

" + "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be \n enabled for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)

" } }, "scheduledAuditName": { @@ -14013,7 +14013,7 @@ "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { - "smithy.api#documentation": "

The name of the security profile whose information you want to get.

", + "smithy.api#documentation": "

The name of the security profile\n whose information you want to get.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -14041,13 +14041,13 @@ "securityProfileDescription": { "target": "com.amazonaws.iot#SecurityProfileDescription", "traits": { - "smithy.api#documentation": "

A description of the security profile (associated with the security profile when it was\n created or updated).

" + "smithy.api#documentation": "

A description of the security profile (associated with the security profile\n when it was created or updated).

" } }, "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { - "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an\n alert.

" + "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" } }, "alertTargets": { @@ -14062,20 +14062,20 @@ "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, - "smithy.api#documentation": "

\n Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric\n specified here.

" + "smithy.api#documentation": "

\n Please use\n DescribeSecurityProfileResponse$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics\n whose data is retained (stored). By default, data is retained for any metric\n used in the profile's behaviors, but\n it is\n also retained for any metric specified here.

" } }, "additionalMetricsToRetainV2": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainV2List", "traits": { - "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric specified\n here.

" + "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but\n it is\n also retained for any metric specified here.

" } }, "version": { "target": "com.amazonaws.iot#Version", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The version of the security profile. A new version is generated whenever the security\n profile is updated.

" + "smithy.api#documentation": "

The version of the security profile. A new version is generated whenever the\n security profile is updated.

" } }, "creationDate": { @@ -14791,7 +14791,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates a Device Defender security profile from a thing group or from this\n account.

\n

Requires permission to access the DetachSecurityProfile action.

", + "smithy.api#documentation": "

Disassociates a Device Defender security profile from a thing group or from this account.

\n

Requires permission to access the DetachSecurityProfile action.

", "smithy.api#http": { "method": "DELETE", "uri": "/security-profiles/{securityProfileName}/targets", @@ -16470,6 +16470,32 @@ "com.amazonaws.iot#GenericLongValue": { "type": "long" }, + "com.amazonaws.iot#GeoLocationTarget": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iot#TargetFieldName", + "traits": { + "smithy.api#documentation": "

The name of the geolocation target field. If the target field is part of a\n named shadow, you must select the named shadow using the namedShadow filter.

" + } + }, + "order": { + "target": "com.amazonaws.iot#TargetFieldOrder", + "traits": { + "smithy.api#documentation": "

The order of the geolocation target field. This field is optional. The\n default value is LatLon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A geolocation target that you select to index. Each geolocation target contains a\n name and order key-value pair that specifies the geolocation\n target fields.

" + } + }, + "com.amazonaws.iot#GeoLocationsFilter": { + "type": "list", + "member": { + "target": "com.amazonaws.iot#GeoLocationTarget" + } + }, "com.amazonaws.iot#GetBehaviorModelTrainingSummaries": { "type": "operation", "input": { @@ -16493,7 +16519,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a Device Defender's ML Detect Security Profile training model's status.

\n

Requires permission to access the GetBehaviorModelTrainingSummaries action.

", + "smithy.api#documentation": "

\n Returns a Device Defender's ML Detect Security Profile training model's status.\n

\n

Requires permission to access the GetBehaviorModelTrainingSummaries action.

", "smithy.api#http": { "method": "GET", "uri": "/behavior-model-training/summaries", @@ -16513,21 +16539,21 @@ "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { - "smithy.api#documentation": "

The name of the security profile.

", + "smithy.api#documentation": "

\n The name of the security profile.\n

", "smithy.api#httpQuery": "securityProfileName" } }, "maxResults": { "target": "com.amazonaws.iot#TinyMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 10.

", + "smithy.api#documentation": "

\n The maximum number of results to return at one time. The default is 10.\n

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#documentation": "

\n The token for the next set of results.\n

", "smithy.api#httpQuery": "nextToken" } } @@ -16542,13 +16568,13 @@ "summaries": { "target": "com.amazonaws.iot#BehaviorModelTrainingSummaries", "traits": { - "smithy.api#documentation": "

A list of all ML Detect behaviors and their model status for a given Security Profile.\n

" + "smithy.api#documentation": "

\n A list of all ML Detect behaviors and their model status for a given Security Profile.\n

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" + "smithy.api#documentation": "

\n A token that can be used to retrieve the next set of results, or null if there are no additional results.\n

" } } }, @@ -18327,10 +18353,16 @@ "traits": { "smithy.api#documentation": "

The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase \n the limit, see Amazon Web Services IoT Device Management \n Quotas in the Amazon Web Services General Reference.\n

" } + }, + "geoLocations": { + "target": "com.amazonaws.iot#GeoLocationsFilter", + "traits": { + "smithy.api#documentation": "

The list of geolocation targets that you select to index. The default maximum number of\n geolocation targets for indexing is 1. To increase the limit, see Amazon Web Services IoT Device\n Management Quotas in the Amazon Web Services General Reference.

" + } } }, "traits": { - "smithy.api#documentation": "

Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter.\n To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and \n specify your shadow names in filter.

" + "smithy.api#documentation": "

Provides additional selections for named shadows and geolocation data.

\n

To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to\n be ON and specify your shadow names in namedShadowNames filter.

\n

To add geolocation data to your fleet indexing configuration:

\n
    \n
  • \n

    If you store geolocation data in a class/unnamed shadow, set\n thingIndexingMode to be REGISTRY_AND_SHADOW and specify your\n geolocation data in geoLocations filter.

    \n
    • \n
  • \n

    If you store geolocation data in a named shadow, set\n namedShadowIndexingMode to be ON, add the shadow name in\n namedShadowNames filter, and specify your geolocation data in\n geoLocations filter. For more information, see Managing fleet\n indexing.

    \n
    • \n
" } }, "com.amazonaws.iot#InlineDocument": { @@ -18776,7 +18808,7 @@ "destinationPackageVersions": { "target": "com.amazonaws.iot#DestinationPackageVersions", "traits": { - "smithy.api#documentation": "

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.

\n

\n Note:The following Length Constraints relates to a single string. \n Up to five strings are allowed.

" + "smithy.api#documentation": "

The package version Amazon Resource Names (ARNs) that are installed on the device when the \n job successfully completes.

\n

\n Note:The following Length Constraints relates to a single ARN. \n Up to 25 package version ARNs are allowed.

" } } }, @@ -19660,14 +19692,14 @@ "behaviorCriteriaType": { "target": "com.amazonaws.iot#BehaviorCriteriaType", "traits": { - "smithy.api#documentation": "

The criteria for a behavior.

", + "smithy.api#documentation": "

\n The criteria for a behavior.\n

", "smithy.api#httpQuery": "behaviorCriteriaType" } }, "listSuppressedAlerts": { "target": "com.amazonaws.iot#ListSuppressedAlerts", "traits": { - "smithy.api#documentation": "

A list of all suppressed alerts.

", + "smithy.api#documentation": "

\n A list of all suppressed alerts.\n

", "smithy.api#httpQuery": "listSuppressedAlerts" } }, @@ -19709,7 +19741,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, \n or null if there are no additional results.

" } } }, @@ -19841,7 +19873,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the findings (results) of a Device Defender audit or of the audits performed during\n a specified time period. (Findings are retained for 90 days.)

\n

Requires permission to access the ListAuditFindings action.

", + "smithy.api#documentation": "

Lists the findings (results) of a Device Defender audit or of the audits\n performed during a specified time period. (Findings are retained for 90 days.)

\n

Requires permission to access the ListAuditFindings action.

", "smithy.api#http": { "method": "POST", "uri": "/audit/findings", @@ -19861,7 +19893,7 @@ "taskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { - "smithy.api#documentation": "

A filter to limit results to the audit with the specified ID. You must specify either the\n taskId or the startTime and endTime, but not both.

" + "smithy.api#documentation": "

A filter to limit results to the audit with the specified ID. You must\n specify either the taskId or the startTime and endTime, but not both.

" } }, "checkName": { @@ -19891,13 +19923,13 @@ "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

A filter to limit results to those found after the specified time. You must specify either\n the startTime and endTime or the taskId, but not both.

" + "smithy.api#documentation": "

A filter to limit results to those found after the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.

" } }, "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

A filter to limit results to those found before the specified time. You must specify\n either the startTime and endTime or the taskId, but not both.

" + "smithy.api#documentation": "

A filter to limit results to those found before the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.

" } }, "listSuppressedFindings": { @@ -19924,7 +19956,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null \n if there are no additional results.

" } } }, @@ -19952,7 +19984,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the status of audit mitigation action tasks that were executed.

\n

Requires permission to access the ListAuditMitigationActionsExecutions action.

", + "smithy.api#documentation": "

Gets the status of audit mitigation action tasks that were\n executed.

\n

Requires permission to access the ListAuditMitigationActionsExecutions action.

", "smithy.api#http": { "method": "GET", "uri": "/audit/mitigationactions/executions", @@ -19972,7 +20004,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

Specify this filter to limit results to actions for a specific audit mitigation actions\n task.

", + "smithy.api#documentation": "

Specify this filter to limit results to actions for a specific audit mitigation actions task.

", "smithy.api#httpQuery": "taskId", "smithy.api#required": {} } @@ -19987,7 +20019,7 @@ "findingId": { "target": "com.amazonaws.iot#FindingId", "traits": { - "smithy.api#documentation": "

Specify this filter to limit results to those that were applied to a specific audit\n finding.

", + "smithy.api#documentation": "

Specify this filter to limit results to those that were applied to a specific audit finding.

", "smithy.api#httpQuery": "findingId", "smithy.api#required": {} } @@ -20017,7 +20049,7 @@ "actionsExecutions": { "target": "com.amazonaws.iot#AuditMitigationActionExecutionMetadataList", "traits": { - "smithy.api#documentation": "

A set of task execution results based on the input parameters. Details include the\n mitigation action applied, start time, and task status.

" + "smithy.api#documentation": "

A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.

" } }, "nextToken": { @@ -20071,14 +20103,14 @@ "auditTaskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { - "smithy.api#documentation": "

Specify this filter to limit results to tasks that were applied to results for a specific\n audit.

", + "smithy.api#documentation": "

Specify this filter to limit results to tasks that were applied to results for a specific audit.

", "smithy.api#httpQuery": "auditTaskId" } }, "findingId": { "target": "com.amazonaws.iot#FindingId", "traits": { - "smithy.api#documentation": "

Specify this filter to limit results to tasks that were applied to a specific audit\n finding.

", + "smithy.api#documentation": "

Specify this filter to limit results to tasks that were applied to a specific audit finding.

", "smithy.api#httpQuery": "findingId" } }, @@ -20106,7 +20138,7 @@ "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

Specify this filter to limit results to tasks that began on or after a specific date and\n time.

", + "smithy.api#documentation": "

Specify this filter to limit results to tasks that began on or after a specific date and time.

", "smithy.api#httpQuery": "startTime", "smithy.api#required": {} } @@ -20114,7 +20146,7 @@ "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

Specify this filter to limit results to tasks that were completed or canceled on or before\n a specific date and time.

", + "smithy.api#documentation": "

Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.

", "smithy.api#httpQuery": "endTime", "smithy.api#required": {} } @@ -20251,7 +20283,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the Device Defender audits that have been performed during a given time\n period.

\n

Requires permission to access the ListAuditTasks action.

", + "smithy.api#documentation": "

Lists the Device Defender audits that have been performed during a given\n time period.

\n

Requires permission to access the ListAuditTasks action.

", "smithy.api#http": { "method": "GET", "uri": "/audit/tasks", @@ -20271,7 +20303,7 @@ "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The beginning of the time period. Audit information is retained for a limited time (90\n days). Requesting a start time prior to what is retained results in an\n \"InvalidRequestException\".

", + "smithy.api#documentation": "

The beginning of the time period. Audit information is retained for a \n limited time (90 days). Requesting a start time prior to what is retained \n results in an \"InvalidRequestException\".

", "smithy.api#httpQuery": "startTime", "smithy.api#required": {} } @@ -20287,14 +20319,14 @@ "taskType": { "target": "com.amazonaws.iot#AuditTaskType", "traits": { - "smithy.api#documentation": "

A filter to limit the output to the specified type of audit: can be one of\n \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED__AUDIT_TASK\".

", + "smithy.api#documentation": "

A filter to limit the output to the specified type of audit: can be one of\n \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED__AUDIT_TASK\".

", "smithy.api#httpQuery": "taskType" } }, "taskStatus": { "target": "com.amazonaws.iot#AuditTaskStatus", "traits": { - "smithy.api#documentation": "

A filter to limit the output to audits with the specified completion status: can be one of\n \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".

", + "smithy.api#documentation": "

A filter to limit the output to audits with the specified completion\n status: can be one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".

", "smithy.api#httpQuery": "taskStatus" } }, @@ -20329,7 +20361,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null \n if there are no additional results.

" } } }, @@ -20831,7 +20863,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists your Device Defender detect custom metrics.

\n

Requires permission to access the ListCustomMetrics action.

", + "smithy.api#documentation": "

\n Lists your Device Defender detect custom metrics.\n

\n

Requires permission to access the ListCustomMetrics action.

", "smithy.api#http": { "method": "GET", "uri": "/custom-metrics", @@ -20851,14 +20883,14 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#documentation": "

\n The token for the next set of results.\n

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 25.

", + "smithy.api#documentation": "

\n The maximum number of results to return at one time. The default is 25.\n

", "smithy.api#httpQuery": "maxResults" } } @@ -20873,13 +20905,13 @@ "metricNames": { "target": "com.amazonaws.iot#MetricNames", "traits": { - "smithy.api#documentation": "

The name of the custom metric.

" + "smithy.api#documentation": "

\n The name of the custom metric.\n

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" + "smithy.api#documentation": "

\n A token that can be used to retrieve the next set of results, \n or null if there are no additional results.\n

" } } }, @@ -20907,7 +20939,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists mitigation actions executions for a Device Defender ML Detect Security Profile.

\n

Requires permission to access the ListDetectMitigationActionsExecutions action.

", + "smithy.api#documentation": "

\n Lists mitigation actions executions for a Device Defender ML Detect Security Profile.\n

\n

Requires permission to access the ListDetectMitigationActionsExecutions action.

", "smithy.api#http": { "method": "GET", "uri": "/detect/mitigationactions/executions", @@ -20927,49 +20959,49 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

The unique identifier of the task.

", + "smithy.api#documentation": "

\n The unique identifier of the task.\n

", "smithy.api#httpQuery": "taskId" } }, "violationId": { "target": "com.amazonaws.iot#ViolationId", "traits": { - "smithy.api#documentation": "

The unique identifier of the violation.

", + "smithy.api#documentation": "

\n The unique identifier of the violation.\n

", "smithy.api#httpQuery": "violationId" } }, "thingName": { "target": "com.amazonaws.iot#DeviceDefenderThingName", "traits": { - "smithy.api#documentation": "

The name of the thing whose mitigation actions are listed.

", + "smithy.api#documentation": "

\n The name of the thing whose mitigation actions are listed.\n

", "smithy.api#httpQuery": "thingName" } }, "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

A filter to limit results to those found after the specified time. You must specify\n either the startTime and endTime or the taskId, but not both.

", + "smithy.api#documentation": "

\n A filter to limit results to those found after the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.\n

", "smithy.api#httpQuery": "startTime" } }, "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The end of the time period for which ML Detect mitigation actions executions are\n returned.

", + "smithy.api#documentation": "

\n The end of the time period for which ML Detect mitigation actions executions are returned.\n

", "smithy.api#httpQuery": "endTime" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 25.

", + "smithy.api#documentation": "

\n The maximum number of results to return at one time. The default is 25.\n

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#documentation": "

\n The token for the next set of results.\n

", "smithy.api#httpQuery": "nextToken" } } @@ -20984,13 +21016,13 @@ "actionsExecutions": { "target": "com.amazonaws.iot#DetectMitigationActionExecutionList", "traits": { - "smithy.api#documentation": "

List of actions executions.

" + "smithy.api#documentation": "

\n List of actions executions.\n

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" + "smithy.api#documentation": "

\n A token that can be used to retrieve the next set of results, or null if there are no additional results.\n

" } } }, @@ -21018,7 +21050,7 @@ } ], "traits": { - "smithy.api#documentation": "

List of Device Defender ML Detect mitigation actions tasks.

\n

Requires permission to access the ListDetectMitigationActionsTasks action.

", + "smithy.api#documentation": "

\n List of Device Defender ML Detect mitigation actions tasks.\n

\n

Requires permission to access the ListDetectMitigationActionsTasks action.

", "smithy.api#http": { "method": "GET", "uri": "/detect/mitigationactions/tasks", @@ -21045,14 +21077,14 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#documentation": "

\n The token for the next set of results.\n

", "smithy.api#httpQuery": "nextToken" } }, "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

A filter to limit results to those found after the specified time. You must specify\n either the startTime and endTime or the taskId, but not both.

", + "smithy.api#documentation": "

\n A filter to limit results to those found after the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.\n

", "smithy.api#httpQuery": "startTime", "smithy.api#required": {} } @@ -21060,7 +21092,7 @@ "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The end of the time period for which ML Detect mitigation actions tasks are returned.\n

", + "smithy.api#documentation": "

\n The end of the time period for which ML Detect mitigation actions tasks are returned.\n

", "smithy.api#httpQuery": "endTime", "smithy.api#required": {} } @@ -21076,13 +21108,13 @@ "tasks": { "target": "com.amazonaws.iot#DetectMitigationActionsTaskSummaryList", "traits": { - "smithy.api#documentation": "

The collection of ML Detect mitigation tasks that matched the filter criteria.

" + "smithy.api#documentation": "

\n The collection of ML Detect mitigation tasks that matched the filter criteria.\n

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" + "smithy.api#documentation": "

\n A token that can be used to retrieve the next set of results, or null if there are no additional results.\n

" } } }, @@ -21152,13 +21184,13 @@ "dimensionNames": { "target": "com.amazonaws.iot#DimensionNames", "traits": { - "smithy.api#documentation": "

A list of the names of the defined dimensions. Use DescribeDimension to get\n details for a dimension.

" + "smithy.api#documentation": "

A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no additional results.

" } } }, @@ -21920,7 +21952,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric,\n or custom metric) by the given thing during the specified time period.

", + "smithy.api#documentation": "

Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) \n by the given thing during the specified time period.

", "smithy.api#http": { "method": "GET", "uri": "/metric-values", @@ -22014,7 +22046,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null \n if there are no additional results.

" } } }, @@ -22062,7 +22094,7 @@ "actionType": { "target": "com.amazonaws.iot#MitigationActionType", "traits": { - "smithy.api#documentation": "

Specify a value to limit the result to mitigation actions with a specific action\n type.

", + "smithy.api#documentation": "

Specify a value to limit the result to mitigation actions with a specific action type.

", "smithy.api#httpQuery": "actionType" } }, @@ -23109,7 +23141,7 @@ } ], "traits": { - "smithy.api#documentation": "

The related resources of an Audit finding. The following resources can be returned from\n calling this API:

\n
    \n
  • \n

    DEVICE_CERTIFICATE

    \n
    • \n
  • \n

    CA_CERTIFICATE

    \n
    • \n
  • \n

    IOT_POLICY

    \n
    • \n
  • \n

    COGNITO_IDENTITY_POOL

    \n
    • \n
  • \n

    CLIENT_ID

    \n
    • \n
  • \n

    ACCOUNT_SETTINGS

    \n
    • \n
  • \n

    ROLE_ALIAS

    \n
    • \n
  • \n

    IAM_ROLE

    \n
    • \n
  • \n

    ISSUER_CERTIFICATE

    \n
    • \n
\n \n

This API is similar to DescribeAuditFinding's RelatedResources but\n provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding for the intermediate CA revoked for active device\n certificates check, RelatedResources will not be populated. You must use this API,\n ListRelatedResourcesForAuditFinding, to list the certificates.

\n ", + "smithy.api#documentation": "

The related resources of an Audit finding. \n The following resources can be returned from calling this API:

\n
    \n
  • \n

    DEVICE_CERTIFICATE

    \n
    • \n
  • \n

    CA_CERTIFICATE

    \n
    • \n
  • \n

    IOT_POLICY

    \n
    • \n
  • \n

    COGNITO_IDENTITY_POOL

    \n
    • \n
  • \n

    CLIENT_ID

    \n
    • \n
  • \n

    ACCOUNT_SETTINGS

    \n
    • \n
  • \n

    ROLE_ALIAS

    \n
    • \n
  • \n

    IAM_ROLE

    \n
    • \n
  • \n

    ISSUER_CERTIFICATE

    \n
    • \n
\n \n

This API is similar to DescribeAuditFinding's RelatedResources \n but provides pagination and is not limited to 10 resources. \n When calling DescribeAuditFinding for the intermediate CA revoked for \n active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.

\n ", "smithy.api#http": { "method": "GET", "uri": "/audit/relatedResources", @@ -23137,7 +23169,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

", + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, \n or null if there are no additional results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -23165,7 +23197,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null for the\n first API call.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, \n or null for the first API call.

" } } }, @@ -23331,7 +23363,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, \n or null if there are no additional results.

" } } }, @@ -23362,7 +23394,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the Device Defender security profiles you've created. You can filter security\n profiles by dimension or custom metric.

\n

Requires permission to access the ListSecurityProfiles action.

\n \n

\n dimensionName and metricName cannot be used in the same\n request.

\n ", + "smithy.api#documentation": "

Lists the Device Defender security profiles\n you've\n created. You can filter security profiles by dimension or custom metric.

\n

Requires permission to access the ListSecurityProfiles action.

\n \n

\n dimensionName and metricName cannot be used in the same request.

\n ", "smithy.api#http": { "method": "GET", "uri": "/security-profiles", @@ -23441,7 +23473,7 @@ "securityProfileTargetArn": { "target": "com.amazonaws.iot#SecurityProfileTargetArn", "traits": { - "smithy.api#documentation": "

The ARN of the target (thing group) whose attached security profiles you want to\n get.

", + "smithy.api#documentation": "

The ARN of the target (thing group) whose attached security profiles you want to get.

", "smithy.api#httpQuery": "securityProfileTargetArn", "smithy.api#required": {} } @@ -23463,7 +23495,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no\n additional results.

" } } }, @@ -23491,14 +23523,14 @@ "dimensionName": { "target": "com.amazonaws.iot#DimensionName", "traits": { - "smithy.api#documentation": "

A filter to limit results to the security profiles that use the defined dimension. Cannot\n be used with metricName\n

", + "smithy.api#documentation": "

A filter to limit results to the security profiles that use the defined dimension.\n Cannot be used with metricName\n

", "smithy.api#httpQuery": "dimensionName" } }, "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "

The name of the custom metric. Cannot be used with dimensionName.

", + "smithy.api#documentation": "

The name of the custom metric.\n Cannot be used with dimensionName.

", "smithy.api#httpQuery": "metricName" } } @@ -23519,7 +23551,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no\n additional results.

" } } }, @@ -23824,7 +23856,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the targets (thing groups) associated with a given Device Defender security\n profile.

\n

Requires permission to access the ListTargetsForSecurityProfile action.

", + "smithy.api#documentation": "

Lists the targets (thing groups) associated with a given Device Defender security profile.

\n

Requires permission to access the ListTargetsForSecurityProfile action.

", "smithy.api#http": { "method": "GET", "uri": "/security-profiles/{securityProfileName}/targets", @@ -23880,7 +23912,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no\n additional results.

" } } }, @@ -25020,7 +25052,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the Device Defender security profile violations discovered during the given time\n period. You can use filters to limit the results to those alerts issued for a particular\n security profile, behavior, or thing (device).

\n

Requires permission to access the ListViolationEvents action.

", + "smithy.api#documentation": "

Lists the Device Defender security profile violations discovered during the given time period. \n You can use filters to limit the results to those alerts issued for a particular security profile, \n behavior, or thing (device).

\n

Requires permission to access the ListViolationEvents action.

", "smithy.api#http": { "method": "GET", "uri": "/violation-events", @@ -25063,21 +25095,21 @@ "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { - "smithy.api#documentation": "

A filter to limit results to those alerts generated by the specified security\n profile.

", + "smithy.api#documentation": "

A filter to limit results to those alerts generated by the specified security profile.

", "smithy.api#httpQuery": "securityProfileName" } }, "behaviorCriteriaType": { "target": "com.amazonaws.iot#BehaviorCriteriaType", "traits": { - "smithy.api#documentation": "

The criteria for a behavior.

", + "smithy.api#documentation": "

\n The criteria for a behavior.\n

", "smithy.api#httpQuery": "behaviorCriteriaType" } }, "listSuppressedAlerts": { "target": "com.amazonaws.iot#ListSuppressedAlerts", "traits": { - "smithy.api#documentation": "

A list of all suppressed alerts.

", + "smithy.api#documentation": "

\n A list of all suppressed alerts.\n

", "smithy.api#httpQuery": "listSuppressedAlerts" } }, @@ -25113,13 +25145,13 @@ "violationEvents": { "target": "com.amazonaws.iot#ViolationEvents", "traits": { - "smithy.api#documentation": "

The security profile violation alerts issued for this account during the given time\n period, potentially filtered by security profile, behavior violated, or thing (device)\n violating.

" + "smithy.api#documentation": "

The security profile violation alerts issued for this account during the given time period, \n potentially filtered by security profile, behavior violated, or thing (device) violating.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no\n additional results.

" } } }, @@ -29120,7 +29152,7 @@ "maxResults": { "target": "com.amazonaws.iot#QueryMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time. The response might contain fewer results but will never contain more.

" + "smithy.api#documentation": "

The maximum number of results to return per page at one time. The response might\n contain fewer results but will never contain more.

" } }, "queryVersion": { @@ -29733,7 +29765,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "^[a-zA-Z0-9:_-]+$" + "smithy.api#pattern": "^[$a-zA-Z0-9:_-]+$" } }, "com.amazonaws.iot#SigV4Authorization": { @@ -29939,7 +29971,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

A unique identifier for the task. You can use this identifier to check the status of the\n task or to cancel it.

", + "smithy.api#documentation": "

A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -29947,21 +29979,21 @@ "target": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskTarget", "traits": { - "smithy.api#documentation": "

Specifies the audit findings to which the mitigation actions are applied. You can apply\n them to a type of audit check, to all findings from an audit, or to a specific set of\n findings.

", + "smithy.api#documentation": "

Specifies the audit findings to which the mitigation actions are applied. You can apply\n them to a type of audit check, to all findings from an audit, or to a\n specific set of\n findings.

", "smithy.api#required": {} } }, "auditCheckToActionsMapping": { "target": "com.amazonaws.iot#AuditCheckToActionsMapping", "traits": { - "smithy.api#documentation": "

For an audit check, specifies which mitigation actions to apply. Those actions must be\n defined in your Amazon Web Services accounts.

", + "smithy.api#documentation": "

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.

", "smithy.api#required": {} } }, "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { - "smithy.api#documentation": "

Each audit mitigation task must have a unique client request token. If you try to start a\n new task with the same token as a task that already exists, an exception occurs. If you omit\n this value, a unique client request token is generated automatically.

", + "smithy.api#documentation": "

Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -29977,7 +30009,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

The unique identifier for the audit mitigation task. This matches the taskId\n that you specified in the request.

" + "smithy.api#documentation": "

The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.

" } } }, @@ -30011,7 +30043,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a Device Defender ML Detect mitigation actions task.

\n

Requires permission to access the StartDetectMitigationActionsTask action.

", + "smithy.api#documentation": "

\n Starts a Device Defender ML Detect mitigation actions task.\n

\n

Requires permission to access the StartDetectMitigationActionsTask action.

", "smithy.api#http": { "method": "PUT", "uri": "/detect/mitigationactions/tasks/{taskId}", @@ -30025,7 +30057,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

The unique identifier of the task.

", + "smithy.api#documentation": "

\n The unique identifier of the task.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -30033,39 +30065,39 @@ "target": { "target": "com.amazonaws.iot#DetectMitigationActionsTaskTarget", "traits": { - "smithy.api#documentation": "

Specifies the ML Detect findings to which the mitigation actions are applied.

", + "smithy.api#documentation": "

\n Specifies the ML Detect findings to which the mitigation actions are applied.\n

", "smithy.api#required": {} } }, "actions": { "target": "com.amazonaws.iot#DetectMitigationActionsToExecuteList", "traits": { - "smithy.api#documentation": "

The actions to be performed when a device has unexpected behavior.

", + "smithy.api#documentation": "

\n The actions to be performed when a device has unexpected behavior.\n

", "smithy.api#required": {} } }, "violationEventOccurrenceRange": { "target": "com.amazonaws.iot#ViolationEventOccurrenceRange", "traits": { - "smithy.api#documentation": "

Specifies the time period of which violation events occurred between.

" + "smithy.api#documentation": "

\n Specifies the time period of which violation events occurred between.\n

" } }, "includeOnlyActiveViolations": { "target": "com.amazonaws.iot#NullableBoolean", "traits": { - "smithy.api#documentation": "

Specifies to list only active violations.

" + "smithy.api#documentation": "

\n Specifies to list only active violations.\n

" } }, "includeSuppressedAlerts": { "target": "com.amazonaws.iot#NullableBoolean", "traits": { - "smithy.api#documentation": "

Specifies to include suppressed alerts.

" + "smithy.api#documentation": "

\n Specifies to include suppressed alerts.\n

" } }, "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { - "smithy.api#documentation": "

Each mitigation action task must have a unique client request token. If you try to create\n a new task with the same token as a task that already exists, an exception occurs. If you omit\n this value, Amazon Web Services SDKs will automatically generate a unique client request.

", + "smithy.api#documentation": "

\n Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.\n

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -30081,7 +30113,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

The unique identifier of the task.

" + "smithy.api#documentation": "

\n The unique identifier of the task.\n

" } } }, @@ -30126,7 +30158,7 @@ "targetCheckNames": { "target": "com.amazonaws.iot#TargetAuditCheckNames", "traits": { - "smithy.api#documentation": "

Which checks are performed during the audit. The checks you specify must be enabled for\n your account or an exception occurs. Use DescribeAccountAuditConfiguration to see\n the list of all checks, including those that are enabled or\n UpdateAccountAuditConfiguration to select which checks are enabled.

", + "smithy.api#documentation": "

Which checks are performed during the audit. The checks you specify must be enabled \n for your account or an exception occurs. Use DescribeAccountAuditConfiguration \n to see the list of all checks, including those that are enabled or \n UpdateAccountAuditConfiguration to select which checks are enabled.

", "smithy.api#required": {} } } @@ -30864,6 +30896,26 @@ "target": "com.amazonaws.iot#AuditCheckName" } }, + "com.amazonaws.iot#TargetFieldName": { + "type": "string" + }, + "com.amazonaws.iot#TargetFieldOrder": { + "type": "enum", + "members": { + "LatLon": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LatLon" + } + }, + "LonLat": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LonLat" + } + } + } + }, "com.amazonaws.iot#TargetSelection": { "type": "enum", "members": { @@ -31708,7 +31760,7 @@ "filter": { "target": "com.amazonaws.iot#IndexingFilter", "traits": { - "smithy.api#documentation": "

Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter.\n To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and \n specify your shadow names in filter.

" + "smithy.api#documentation": "

Provides additional selections for named shadows and geolocation data.

\n

To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to\n be ON and specify your shadow names in namedShadowNames filter.

\n

To add geolocation data to your fleet indexing configuration:

\n
    \n
  • \n

    If you store geolocation data in a class/unnamed shadow, set\n thingIndexingMode to be REGISTRY_AND_SHADOW and specify your\n geolocation data in geoLocations filter.

    \n
    • \n
  • \n

    If you store geolocation data in a named shadow, set namedShadowIndexingMode\n to be ON, add the shadow name in namedShadowNames filter, and\n specify your geolocation data in geoLocations filter. For more information, see\n Managing fleet indexing.

    \n
    • \n
" } } }, @@ -32697,7 +32749,7 @@ } ], "traits": { - "smithy.api#documentation": "

Configures or reconfigures the Device Defender audit settings for this account. Settings\n include how audit notifications are sent and which audit checks are enabled or\n disabled.

\n

Requires permission to access the UpdateAccountAuditConfiguration action.

", + "smithy.api#documentation": "

Configures or reconfigures the Device Defender audit settings for this account.\n Settings include how audit notifications are sent and which audit checks are\n enabled or disabled.

\n

Requires permission to access the UpdateAccountAuditConfiguration action.

", "smithy.api#http": { "method": "PATCH", "uri": "/audit/configuration", @@ -32711,7 +32763,7 @@ "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that grants permission to IoT to access\n information about your devices, policies, certificates, and other items as required when\n performing an audit.

" + "smithy.api#documentation": "

The Amazon\n Resource Name\n (ARN)\n of the role that grants permission\n to\n IoT to access information about your devices, policies,\n certificates,\n and other items as required when performing an audit.

" } }, "auditNotificationTargetConfigurations": { @@ -32723,7 +32775,7 @@ "auditCheckConfigurations": { "target": "com.amazonaws.iot#AuditCheckConfigurations", "traits": { - "smithy.api#documentation": "

Specifies which audit checks are enabled and disabled for this account. Use\n DescribeAccountAuditConfiguration to see the list of all checks, including\n those that are currently enabled.

\n

Some data collection might start immediately when certain checks are enabled. When a check\n is disabled, any data collected so far in relation to the check is deleted.

\n

You cannot disable a check if it's used by any scheduled audit. You must first delete the\n check from the scheduled audit or delete the scheduled audit itself.

\n

On the first call to UpdateAccountAuditConfiguration, this parameter is\n required and must specify at least one enabled check.

" + "smithy.api#documentation": "

Specifies which audit checks are enabled and disabled for this account. Use \n DescribeAccountAuditConfiguration to see the list of all checks, including those \n that are currently enabled.

\n

Some data collection might start immediately when certain checks are enabled. \n When a check is disabled, any data collected so far in relation to the check is deleted.

\n

You\n cannot\n disable a check if\n it's\n used by any scheduled audit. You must first delete the check from the scheduled audit or\n delete the scheduled audit itself.

\n

On the first call to UpdateAccountAuditConfiguration,\n this parameter is required and must specify at least one enabled check.

" } } }, @@ -33182,7 +33234,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a Device Defender detect custom metric.

\n

Requires permission to access the UpdateCustomMetric action.

", + "smithy.api#documentation": "

Updates a\n Device Defender detect custom metric.

\n

Requires permission to access the UpdateCustomMetric action.

", "smithy.api#http": { "method": "PATCH", "uri": "/custom-metric/{metricName}", @@ -33196,7 +33248,7 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "

The name of the custom metric. Cannot be updated.

", + "smithy.api#documentation": "

The name of the custom metric.\n Cannot be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -33204,7 +33256,7 @@ "displayName": { "target": "com.amazonaws.iot#CustomMetricDisplayName", "traits": { - "smithy.api#documentation": "

Field represents a friendly name in the console for the custom metric, it doesn't have to\n be unique. Don't use this name as the metric identifier in the device metric report. Can be\n updated.

", + "smithy.api#documentation": "

\n Field\n represents a friendly name in the console for the custom metric,\n it\n doesn't have to be unique. Don't use this name as the metric identifier in\n the device metric report.\n Can\n be updated.

", "smithy.api#required": {} } } @@ -33219,37 +33271,37 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "

The name of the custom metric.

" + "smithy.api#documentation": "

\n The name of the custom metric.\n

" } }, "metricArn": { "target": "com.amazonaws.iot#CustomMetricArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the custom metric.

" + "smithy.api#documentation": "

\n The Amazon Resource Number (ARN) of the custom metric.\n

" } }, "metricType": { "target": "com.amazonaws.iot#CustomMetricType", "traits": { - "smithy.api#documentation": "

The type of the custom metric.

\n \n

The type number only takes a single metric value as an input, but while\n submitting the metrics value in the DeviceMetrics report, it must be passed as an array with\n a single value.

\n " + "smithy.api#documentation": "

The type of the custom metric.

\n \n

The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

\n " } }, "displayName": { "target": "com.amazonaws.iot#CustomMetricDisplayName", "traits": { - "smithy.api#documentation": "

A friendly name in the console for the custom metric

" + "smithy.api#documentation": "

\n A friendly name in the console for the custom metric\n

" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The creation date of the custom metric in milliseconds since epoch.

" + "smithy.api#documentation": "

\n The creation date of the custom metric in milliseconds since epoch.\n

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The time the custom metric was last modified in milliseconds since epoch.

" + "smithy.api#documentation": "

\n The time the custom metric was last modified in milliseconds since epoch.\n

" } } }, @@ -33295,7 +33347,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the definition for a dimension. You cannot change the type of a dimension after it\n is created (you can delete it and recreate it).

\n

Requires permission to access the UpdateDimension action.

", + "smithy.api#documentation": "

Updates the definition for a dimension. You\n cannot\n change the type of a dimension after\n it is created (you can delete it and\n recreate\n it).

\n

Requires permission to access the UpdateDimension action.

", "smithy.api#http": { "method": "PATCH", "uri": "/dimensions/{name}", @@ -33309,7 +33361,7 @@ "name": { "target": "com.amazonaws.iot#DimensionName", "traits": { - "smithy.api#documentation": "

A unique identifier for the dimension. Choose something that describes the type and value\n to make it easy to remember what it does.

", + "smithy.api#documentation": "

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -33317,7 +33369,7 @@ "stringValues": { "target": "com.amazonaws.iot#DimensionStringValues", "traits": { - "smithy.api#documentation": "

Specifies the value or list of values for the dimension. For TOPIC_FILTER\n dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").

", + "smithy.api#documentation": "

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").

", "smithy.api#required": {} } } @@ -33338,7 +33390,7 @@ "arn": { "target": "com.amazonaws.iot#DimensionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN)of the created dimension.

" + "smithy.api#documentation": "

The Amazon Resource\n Name (ARN)of\n the created dimension.

" } }, "type": { @@ -33350,19 +33402,19 @@ "stringValues": { "target": "com.amazonaws.iot#DimensionStringValues", "traits": { - "smithy.api#documentation": "

The value or list of values used to scope the dimension. For example, for topic filters,\n this is the pattern used to match the MQTT topic name.

" + "smithy.api#documentation": "

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time, in milliseconds since epoch, when the dimension was initially\n created.

" + "smithy.api#documentation": "

The date and time, in milliseconds since epoch, when the dimension was initially created.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time, in milliseconds since epoch, when the dimension was most recently\n updated.

" + "smithy.api#documentation": "

The date and time, in milliseconds since epoch, when the dimension was most recently updated.

" } } }, @@ -33927,7 +33979,7 @@ "actionName": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { - "smithy.api#documentation": "

The friendly name for the mitigation action. You cannot change the name by using\n UpdateMitigationAction. Instead, you must delete and recreate the mitigation\n action with the new name.

", + "smithy.api#documentation": "

The friendly name for the mitigation action. You cannot change the name by using\n UpdateMitigationAction. Instead, you must delete and\n recreate the\n mitigation action with the new name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -34399,7 +34451,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a scheduled audit, including which checks are performed and how often the audit\n takes place.

\n

Requires permission to access the UpdateScheduledAudit action.

", + "smithy.api#documentation": "

Updates a scheduled audit, including which checks are performed and\n how often the audit takes place.

\n

Requires permission to access the UpdateScheduledAudit action.

", "smithy.api#http": { "method": "PATCH", "uri": "/audit/scheduledaudits/{scheduledAuditName}", @@ -34413,25 +34465,25 @@ "frequency": { "target": "com.amazonaws.iot#AuditFrequency", "traits": { - "smithy.api#documentation": "

How often the scheduled audit takes place, either DAILY, WEEKLY,\n BIWEEKLY, or MONTHLY. The start time of each audit is determined\n by the system.

" + "smithy.api#documentation": "

How often the scheduled audit takes\n place,\n either DAILY,\n WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the\n system.

" } }, "dayOfMonth": { "target": "com.amazonaws.iot#DayOfMonth", "traits": { - "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place. This can be 1\n through 31 or LAST. This field is required if the\n frequency parameter is set to MONTHLY. If days 29-31 are\n specified, and the month does not have that many days, the audit takes place on the \"LAST\" day\n of the month.

" + "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place.\n This\n can\n be 1 through 31 or LAST. This field is required if the frequency parameter is set to\n MONTHLY. If days 29-31 are specified, and the month does not have that many days, the audit\n takes place on the \"LAST\" day of the month.

" } }, "dayOfWeek": { "target": "com.amazonaws.iot#DayOfWeek", "traits": { - "smithy.api#documentation": "

The day of the week on which the scheduled audit takes place. This can be one of\n SUN, MON, TUE, WED, THU,\n FRI, or SAT. This field is required if the \"frequency\" parameter\n is set to WEEKLY or BIWEEKLY.

" + "smithy.api#documentation": "

The day of the week on which the scheduled audit takes place.\n This\n can\n be one of SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the\n \"frequency\" parameter is set to WEEKLY or BIWEEKLY.

" } }, "targetCheckNames": { "target": "com.amazonaws.iot#TargetAuditCheckNames", "traits": { - "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be enabled for your\n account. (Use DescribeAccountAuditConfiguration to see the list of all checks,\n including those that are enabled or use UpdateAccountAuditConfiguration to select\n which checks are enabled.)

" + "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be enabled \n for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)

" } }, "scheduledAuditName": { @@ -34515,7 +34567,7 @@ "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { - "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an\n alert.

" + "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" } }, "alertTargets": { @@ -34530,40 +34582,40 @@ "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, - "smithy.api#documentation": "

\n Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric\n specified here. Can be used with custom metrics; cannot be used with dimensions.

" + "smithy.api#documentation": "

\n Please use\n UpdateSecurityProfileRequest$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics\n whose data is retained (stored). By default, data is retained for any metric\n used in the profile's behaviors, but\n it is\n also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

" } }, "additionalMetricsToRetainV2": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainV2List", "traits": { - "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric specified here.\n Can be used with custom metrics; cannot be used with dimensions.

" + "smithy.api#documentation": "

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.

" } }, "deleteBehaviors": { "target": "com.amazonaws.iot#DeleteBehaviors", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If true, delete all behaviors defined for this security profile. If any\n behaviors are defined in the current invocation, an exception occurs.

" + "smithy.api#documentation": "

If true, delete all behaviors defined for this security profile. \n If any behaviors are defined in the current invocation, an exception occurs.

" } }, "deleteAlertTargets": { "target": "com.amazonaws.iot#DeleteAlertTargets", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If true, delete all alertTargets defined for this security profile. If any\n alertTargets are defined in the current invocation, an exception\n occurs.

" + "smithy.api#documentation": "

If true, delete all alertTargets defined for this security profile. \n If any alertTargets are defined in the current invocation, an exception occurs.

" } }, "deleteAdditionalMetricsToRetain": { "target": "com.amazonaws.iot#DeleteAdditionalMetricsToRetain", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If true, delete all additionalMetricsToRetain defined for this security\n profile. If any additionalMetricsToRetain are defined in the current invocation,\n an exception occurs.

" + "smithy.api#documentation": "

If true, delete all additionalMetricsToRetain defined for this \n security profile. If any additionalMetricsToRetain are defined in the current \n invocation, an exception occurs.

" } }, "expectedVersion": { "target": "com.amazonaws.iot#OptionalVersion", "traits": { - "smithy.api#documentation": "

The expected version of the security profile. A new version is generated whenever the\n security profile is updated. If you specify a value that is different from the actual version,\n a VersionConflictException is thrown.

", + "smithy.api#documentation": "

The expected version of the security profile. A new version is generated whenever\n the security profile is updated. If you specify a value that is different from the actual\n version, a VersionConflictException is thrown.

", "smithy.api#httpQuery": "expectedVersion" } }, @@ -34609,7 +34661,7 @@ "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { - "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an\n alert.

" + "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" } }, "alertTargets": { @@ -34624,13 +34676,13 @@ "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, - "smithy.api#documentation": "

\n Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the security profile's behaviors, but it is also retained for any\n metric specified here.

" + "smithy.api#documentation": "

\n Please use\n UpdateSecurityProfileResponse$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics\n whose data is retained (stored). By default, data is retained for any metric\n used in the security profile's behaviors, but\n it is\n also retained for any metric specified here.

" } }, "additionalMetricsToRetainV2": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainV2List", "traits": { - "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric specified here.\n Can be used with custom metrics; cannot be used with dimensions.

" + "smithy.api#documentation": "

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.

" } }, "version": { @@ -35172,7 +35224,7 @@ "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { - "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an\n alert.

", + "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

", "smithy.api#required": {} } }