Skip to content

Commit

Permalink
feat(client-iot): GA release the ability to index and search devices …
Browse files Browse the repository at this point in the history
…based on their GeoLocation data. With GeoQueries you can narrow your search to retrieve devices located in the desired geographic boundary.
  • Loading branch information
awstools committed Nov 16, 2023
1 parent 8f6ad5b commit 458186a
Show file tree
Hide file tree
Showing 41 changed files with 924 additions and 649 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export interface AttachSecurityProfileCommandOutput extends AttachSecurityProfil
/**
* @public
* <p>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.</p>
* thing group or account can have up to five security profiles associated with it.</p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">AttachSecurityProfile</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,9 @@ export interface CancelAuditMitigationActionsTaskCommandOutput

/**
* @public
* <p>Cancels a mitigation action task that is in progress. If the task is not in progress, an
* InvalidRequestException occurs.</p>
* <p>Cancels a mitigation action task that is in progress. If the task
* is not
* in progress, an InvalidRequestException occurs.</p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CancelAuditMitigationActionsTask</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
3 changes: 1 addition & 2 deletions clients/client-iot/src/commands/CancelAuditTaskCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ export interface CancelAuditTaskCommandOutput extends CancelAuditTaskResponse, _

/**
* @public
* <p>Cancels an audit that is in progress. The audit can be either scheduled or on demand. If
* the audit isn't in progress, an "InvalidRequestException" occurs.</p>
* <p>Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.</p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CancelAuditTask</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ export interface CancelDetectMitigationActionsTaskCommandOutput

/**
* @public
* <p> Cancels a Device Defender ML Detect mitigation action. </p>
* <p>
* Cancels a Device Defender ML Detect mitigation action.
* </p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CancelDetectMitigationActionsTask</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
5 changes: 4 additions & 1 deletion clients/client-iot/src/commands/CreateCustomMetricCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,10 @@ export interface CreateCustomMetricCommandOutput extends CreateCustomMetricRespo

/**
* @public
* <p> Use this API to define a Custom Metric published by your devices to Device Defender. </p>
* <p> Use this API to define a
* Custom
* Metric
* published by your devices to Device Defender. </p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateCustomMetric</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
6 changes: 2 additions & 4 deletions clients/client-iot/src/commands/CreateDimensionCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,8 @@ export interface CreateDimensionCommandOutput extends CreateDimensionResponse, _

/**
* @public
* <p>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 <code>TOPIC_FILTER</code> dimension, you can narrow
* down the scope of the metric only to MQTT topics whose name match the pattern specified in the
* dimension.</p>
* <p>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 <code>TOPIC_FILTER</code> dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.</p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateDimension</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,8 @@ export interface CreateMitigationActionCommandOutput extends CreateMitigationAct

/**
* @public
* <p>Defines an action that can be applied to audit findings by using
* StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to
* specific check names. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-mitigation-actions.html">Mitigation
* actions</a>. Each mitigation action can apply only one type of change.</p>
* <p>Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names.
* For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-mitigation-actions.html">Mitigation actions</a>. Each mitigation action can apply only one type of change.</p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateMitigationAction</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ export interface CreateScheduledAuditCommandOutput extends CreateScheduledAuditR

/**
* @public
* <p>Creates a scheduled audit that is run at a specified time interval.</p>
* <p>Creates a scheduled audit that is run at a specified
* time interval.</p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateScheduledAudit</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,8 @@ export interface DeleteAccountAuditConfigurationCommandOutput
/**
* @public
* <p>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.
*
* </p>
* configuration data you entered is deleted and all audit checks are reset to
* disabled. </p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteAccountAuditConfiguration</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
12 changes: 8 additions & 4 deletions clients/client-iot/src/commands/DeleteCustomMetricCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,17 @@ export interface DeleteCustomMetricCommandOutput extends DeleteCustomMetricRespo

/**
* @public
* <p> Deletes a Device Defender detect custom metric. </p>
* <p>
* Deletes a Device Defender detect custom metric.
* </p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteCustomMetric</a> action.</p>
* <note>
* <p>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 <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_ListSecurityProfiles.html">ListSecurityProfiles</a>
* API with <code>metricName</code> set to your custom metric name.</p>
* security profiles it's a part of.
* The
* security
* profile associated with the custom metric can be found using the <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_ListSecurityProfiles.html">ListSecurityProfiles</a>
* API with <code>metricName</code> set to your custom metric name.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ export interface DescribeAccountAuditConfigurationCommandOutput

/**
* @public
* <p>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.</p>
* <p>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.</p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeAccountAuditConfiguration</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ export interface DescribeAuditFindingCommandOutput extends DescribeAuditFindingR
/**
* @public
* <p>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.</p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeAuditFinding</a> action.</p>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,7 @@ export interface DescribeAuditMitigationActionsTaskCommandOutput

/**
* @public
* <p>Gets information about an audit mitigation task that is used to apply mitigation actions
* to a set of audit findings. Properties include the actions being applied, the audit checks to
* which they're being applied, the task status, and aggregated task statistics.</p>
* <p>Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ export interface DescribeCustomMetricCommandOutput extends DescribeCustomMetricR

/**
* @public
* <p> Gets information about a Device Defender detect custom metric. </p>
* <p>
* Gets information about a Device Defender detect custom metric.
* </p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeCustomMetric</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ export interface DescribeDetectMitigationActionsTaskCommandOutput

/**
* @public
* <p> Gets information about a Device Defender ML Detect mitigation action. </p>
* <p>
* Gets information about a Device Defender ML Detect mitigation action.
* </p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeDetectMitigationActionsTask</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ export interface DetachSecurityProfileCommandOutput extends DetachSecurityProfil

/**
* @public
* <p>Disassociates a Device Defender security profile from a thing group or from this
* account.</p>
* <p>Disassociates a Device Defender security profile from a thing group or from this account.</p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DetachSecurityProfile</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ export interface GetBehaviorModelTrainingSummariesCommandOutput

/**
* @public
* <p> Returns a Device Defender's ML Detect Security Profile training model's status. </p>
* <p>
* Returns a Device Defender's ML Detect Security Profile training model's status.
* </p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetBehaviorModelTrainingSummaries</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ export interface GetIndexingConfigurationCommandOutput extends GetIndexingConfig
* // namedShadowNames: [ // NamedShadowNamesFilter
* // "STRING_VALUE",
* // ],
* // geoLocations: [ // GeoLocationsFilter
* // { // GeoLocationTarget
* // name: "STRING_VALUE",
* // order: "LatLon" || "LonLat",
* // },
* // ],
* // },
* // },
* // thingGroupIndexingConfiguration: { // ThingGroupIndexingConfiguration
Expand Down
4 changes: 2 additions & 2 deletions clients/client-iot/src/commands/ListAuditFindingsCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ export interface ListAuditFindingsCommandOutput extends ListAuditFindingsRespons

/**
* @public
* <p>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.)</p>
* <p>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.)</p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListAuditFindings</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ export interface ListAuditMitigationActionsExecutionsCommandOutput

/**
* @public
* <p>Gets the status of audit mitigation action tasks that were executed.</p>
* <p>Gets the status of audit mitigation action tasks that were
* executed.</p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListAuditMitigationActionsExecutions</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
4 changes: 2 additions & 2 deletions clients/client-iot/src/commands/ListAuditTasksCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ export interface ListAuditTasksCommandOutput extends ListAuditTasksResponse, __M

/**
* @public
* <p>Lists the Device Defender audits that have been performed during a given time
* period.</p>
* <p>Lists the Device Defender audits that have been performed during a given
* time period.</p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListAuditTasks</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
4 changes: 3 additions & 1 deletion clients/client-iot/src/commands/ListCustomMetricsCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ export interface ListCustomMetricsCommandOutput extends ListCustomMetricsRespons

/**
* @public
* <p> Lists your Device Defender detect custom metrics. </p>
* <p>
* Lists your Device Defender detect custom metrics.
* </p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListCustomMetrics</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ export interface ListDetectMitigationActionsExecutionsCommandOutput

/**
* @public
* <p> Lists mitigation actions executions for a Device Defender ML Detect Security Profile. </p>
* <p>
* Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
* </p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListDetectMitigationActionsExecutions</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ export interface ListDetectMitigationActionsTasksCommandOutput

/**
* @public
* <p> List of Device Defender ML Detect mitigation actions tasks. </p>
* <p>
* List of Device Defender ML Detect mitigation actions tasks.
* </p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListDetectMitigationActionsTasks</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
4 changes: 2 additions & 2 deletions clients/client-iot/src/commands/ListMetricValuesCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ export interface ListMetricValuesCommandOutput extends ListMetricValuesResponse,

/**
* @public
* <p>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.</p>
* <p>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.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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";

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ export interface ListRelatedResourcesForAuditFindingCommandOutput

/**
* @public
* <p>The related resources of an Audit finding. The following resources can be returned from
* calling this API:</p>
* <p>The related resources of an Audit finding.
* The following resources can be returned from calling this API:</p>
* <ul>
* <li>
* <p>DEVICE_CERTIFICATE</p>
Expand Down Expand Up @@ -77,10 +77,10 @@ export interface ListRelatedResourcesForAuditFindingCommandOutput
* </li>
* </ul>
* <note>
* <p>This API is similar to DescribeAuditFinding's <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html">RelatedResources</a> but
* provides pagination and is not limited to 10 resources. When calling <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html">DescribeAuditFinding</a> 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.</p>
* <p>This API is similar to DescribeAuditFinding's <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html">RelatedResources</a>
* but provides pagination and is not limited to 10 resources.
* When calling <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html">DescribeAuditFinding</a> 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.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Loading

0 comments on commit 458186a

Please sign in to comment.