@aws-sdk/client-iot 3.259.0 → 3.262.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (79) hide show
  1. package/dist-cjs/endpoint/ruleset.js +3 -3
  2. package/dist-cjs/protocols/Aws_restJson1.js +2 -0
  3. package/dist-es/endpoint/ruleset.js +3 -3
  4. package/dist-es/protocols/Aws_restJson1.js +2 -0
  5. package/dist-types/IoT.d.ts +88 -94
  6. package/dist-types/IoTClient.d.ts +5 -5
  7. package/dist-types/commands/AddThingToBillingGroupCommand.d.ts +1 -1
  8. package/dist-types/commands/AddThingToThingGroupCommand.d.ts +1 -1
  9. package/dist-types/commands/AssociateTargetsWithJobCommand.d.ts +5 -5
  10. package/dist-types/commands/AttachThingPrincipalCommand.d.ts +1 -1
  11. package/dist-types/commands/CancelJobCommand.d.ts +1 -1
  12. package/dist-types/commands/CreateBillingGroupCommand.d.ts +1 -1
  13. package/dist-types/commands/CreateCertificateFromCsrCommand.d.ts +0 -3
  14. package/dist-types/commands/CreateDynamicThingGroupCommand.d.ts +1 -1
  15. package/dist-types/commands/CreateJobCommand.d.ts +1 -1
  16. package/dist-types/commands/CreateJobTemplateCommand.d.ts +1 -1
  17. package/dist-types/commands/CreateOTAUpdateCommand.d.ts +1 -1
  18. package/dist-types/commands/CreateStreamCommand.d.ts +1 -1
  19. package/dist-types/commands/CreateThingCommand.d.ts +4 -4
  20. package/dist-types/commands/CreateThingGroupCommand.d.ts +4 -4
  21. package/dist-types/commands/CreateThingTypeCommand.d.ts +1 -1
  22. package/dist-types/commands/DeleteBillingGroupCommand.d.ts +1 -1
  23. package/dist-types/commands/DeleteDynamicThingGroupCommand.d.ts +1 -1
  24. package/dist-types/commands/DeleteOTAUpdateCommand.d.ts +1 -1
  25. package/dist-types/commands/DeleteStreamCommand.d.ts +1 -1
  26. package/dist-types/commands/DeleteThingCommand.d.ts +1 -1
  27. package/dist-types/commands/DeleteThingGroupCommand.d.ts +1 -1
  28. package/dist-types/commands/DeleteThingTypeCommand.d.ts +1 -1
  29. package/dist-types/commands/DeprecateThingTypeCommand.d.ts +1 -1
  30. package/dist-types/commands/DescribeBillingGroupCommand.d.ts +1 -1
  31. package/dist-types/commands/DescribeEventConfigurationsCommand.d.ts +1 -1
  32. package/dist-types/commands/DescribeJobCommand.d.ts +1 -1
  33. package/dist-types/commands/DescribeJobExecutionCommand.d.ts +1 -1
  34. package/dist-types/commands/DescribeStreamCommand.d.ts +1 -1
  35. package/dist-types/commands/DescribeThingCommand.d.ts +1 -1
  36. package/dist-types/commands/DescribeThingGroupCommand.d.ts +1 -1
  37. package/dist-types/commands/DescribeThingRegistrationTaskCommand.d.ts +1 -1
  38. package/dist-types/commands/DescribeThingTypeCommand.d.ts +1 -1
  39. package/dist-types/commands/DetachThingPrincipalCommand.d.ts +4 -4
  40. package/dist-types/commands/GetJobDocumentCommand.d.ts +1 -1
  41. package/dist-types/commands/GetOTAUpdateCommand.d.ts +1 -1
  42. package/dist-types/commands/ListBillingGroupsCommand.d.ts +1 -1
  43. package/dist-types/commands/ListJobExecutionsForJobCommand.d.ts +1 -1
  44. package/dist-types/commands/ListJobExecutionsForThingCommand.d.ts +1 -1
  45. package/dist-types/commands/ListJobTemplatesCommand.d.ts +1 -1
  46. package/dist-types/commands/ListJobsCommand.d.ts +1 -1
  47. package/dist-types/commands/ListOTAUpdatesCommand.d.ts +1 -1
  48. package/dist-types/commands/ListPrincipalThingsCommand.d.ts +1 -1
  49. package/dist-types/commands/ListStreamsCommand.d.ts +1 -1
  50. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  51. package/dist-types/commands/ListThingGroupsCommand.d.ts +1 -1
  52. package/dist-types/commands/ListThingGroupsForThingCommand.d.ts +1 -1
  53. package/dist-types/commands/ListThingPrincipalsCommand.d.ts +1 -1
  54. package/dist-types/commands/ListThingRegistrationTasksCommand.d.ts +1 -1
  55. package/dist-types/commands/ListThingTypesCommand.d.ts +1 -1
  56. package/dist-types/commands/ListThingsCommand.d.ts +4 -5
  57. package/dist-types/commands/ListThingsInBillingGroupCommand.d.ts +1 -1
  58. package/dist-types/commands/ListThingsInThingGroupCommand.d.ts +1 -1
  59. package/dist-types/commands/RemoveThingFromBillingGroupCommand.d.ts +2 -2
  60. package/dist-types/commands/RemoveThingFromThingGroupCommand.d.ts +2 -2
  61. package/dist-types/commands/StartThingRegistrationTaskCommand.d.ts +1 -1
  62. package/dist-types/commands/StopThingRegistrationTaskCommand.d.ts +1 -1
  63. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  64. package/dist-types/commands/TransferCertificateCommand.d.ts +0 -1
  65. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  66. package/dist-types/commands/UpdateBillingGroupCommand.d.ts +1 -1
  67. package/dist-types/commands/UpdateCertificateCommand.d.ts +0 -1
  68. package/dist-types/commands/UpdateDynamicThingGroupCommand.d.ts +1 -1
  69. package/dist-types/commands/UpdateEventConfigurationsCommand.d.ts +1 -1
  70. package/dist-types/commands/UpdateJobCommand.d.ts +1 -1
  71. package/dist-types/commands/UpdateStreamCommand.d.ts +1 -1
  72. package/dist-types/commands/UpdateThingCommand.d.ts +1 -1
  73. package/dist-types/commands/UpdateThingGroupCommand.d.ts +1 -1
  74. package/dist-types/commands/UpdateThingGroupsForThingCommand.d.ts +1 -1
  75. package/dist-types/models/models_0.d.ts +51 -46
  76. package/dist-types/models/models_1.d.ts +27 -27
  77. package/dist-types/models/models_2.d.ts +18 -18
  78. package/dist-types/ts3.4/models/models_0.d.ts +1 -0
  79. package/package.json +6 -6
@@ -9,7 +9,7 @@ export interface ListThingTypesCommandOutput extends ListThingTypesResponse, __M
9
9
  }
10
10
  /**
11
11
  * <p>Lists the existing thing types.</p>
12
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListThingTypes</a> action.</p>
12
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListThingTypes</a> action.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -13,11 +13,10 @@ export interface ListThingsCommandOutput extends ListThingsResponse, __MetadataB
13
13
  * retrieves all things in the registry that contain an attribute <b>Color</b> with the value <b>Red</b>. For more
14
14
  * information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html#list-things">List Things</a> from the <i>Amazon Web Services IoT Core Developer
15
15
  * Guide</i>.</p>
16
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListThings</a> action.</p>
17
- *
18
- * <note>
19
- * <p>You will not be charged for calling this API if an <code>Access denied</code> error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.</p>
20
- * </note>
16
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListThings</a> action.</p>
17
+ * <note>
18
+ * <p>You will not be charged for calling this API if an <code>Access denied</code> error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.</p>
19
+ * </note>
21
20
  * @example
22
21
  * Use a bare-bones client and the command you need to make an API call.
23
22
  * ```javascript
@@ -9,7 +9,7 @@ export interface ListThingsInBillingGroupCommandOutput extends ListThingsInBilli
9
9
  }
10
10
  /**
11
11
  * <p>Lists the things you have added to the given billing group.</p>
12
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListThingsInBillingGroup</a> action.</p>
12
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListThingsInBillingGroup</a> action.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -9,7 +9,7 @@ export interface ListThingsInThingGroupCommandOutput extends ListThingsInThingGr
9
9
  }
10
10
  /**
11
11
  * <p>Lists the things in the specified group.</p>
12
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListThingsInThingGroup</a> action.</p>
12
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListThingsInThingGroup</a> action.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -9,8 +9,8 @@ export interface RemoveThingFromBillingGroupCommandOutput extends RemoveThingFro
9
9
  }
10
10
  /**
11
11
  * <p>Removes the given thing from the billing group.</p>
12
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">RemoveThingFromBillingGroup</a> action.</p>
13
- * <note>
12
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">RemoveThingFromBillingGroup</a> action.</p>
13
+ * <note>
14
14
  * <p>This call is asynchronous. It might take several seconds for the detachment to propagate.</p>
15
15
  * </note>
16
16
  * @example
@@ -9,12 +9,12 @@ export interface RemoveThingFromThingGroupCommandOutput extends RemoveThingFromT
9
9
  }
10
10
  /**
11
11
  * <p>Remove the specified thing from the specified group.</p>
12
- * <p>You must specify either a <code>thingGroupArn</code> or a
12
+ * <p>You must specify either a <code>thingGroupArn</code> or a
13
13
  * <code>thingGroupName</code> to identify the thing group and
14
14
  * either a <code>thingArn</code> or a <code>thingName</code> to
15
15
  * identify the thing to remove from the thing group.
16
16
  * </p>
17
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">RemoveThingFromThingGroup</a> action.</p>
17
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">RemoveThingFromThingGroup</a> action.</p>
18
18
  * @example
19
19
  * Use a bare-bones client and the command you need to make an API call.
20
20
  * ```javascript
@@ -9,7 +9,7 @@ export interface StartThingRegistrationTaskCommandOutput extends StartThingRegis
9
9
  }
10
10
  /**
11
11
  * <p>Creates a bulk thing provisioning task.</p>
12
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StartThingRegistrationTask</a> action.</p>
12
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StartThingRegistrationTask</a> action.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -9,7 +9,7 @@ export interface StopThingRegistrationTaskCommandOutput extends StopThingRegistr
9
9
  }
10
10
  /**
11
11
  * <p>Cancels a bulk thing provisioning task.</p>
12
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StopThingRegistrationTask</a> action.</p>
12
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StopThingRegistrationTask</a> action.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -10,7 +10,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
10
10
  /**
11
11
  * <p>Adds to or modifies the tags of the given resource. Tags are metadata which can be
12
12
  * used to manage a resource.</p>
13
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">TagResource</a> action.</p>
13
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">TagResource</a> action.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
@@ -10,7 +10,6 @@ export interface TransferCertificateCommandOutput extends TransferCertificateRes
10
10
  /**
11
11
  * <p>Transfers the specified certificate to the specified Amazon Web Services account.</p>
12
12
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">TransferCertificate</a> action.</p>
13
- *
14
13
  * <p>You can cancel the transfer until it is acknowledged by the recipient.</p>
15
14
  * <p>No notification is sent to the transfer destination's account. It is up to the caller
16
15
  * to notify the transfer target.</p>
@@ -9,7 +9,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
9
9
  }
10
10
  /**
11
11
  * <p>Removes the given tags (metadata) from the resource.</p>
12
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UntagResource</a> action.</p>
12
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UntagResource</a> action.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -9,7 +9,7 @@ export interface UpdateBillingGroupCommandOutput extends UpdateBillingGroupRespo
9
9
  }
10
10
  /**
11
11
  * <p>Updates information about the billing group.</p>
12
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateBillingGroup</a> action.</p>
12
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateBillingGroup</a> action.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -11,7 +11,6 @@ export interface UpdateCertificateCommandOutput extends __MetadataBearer {
11
11
  * <p>Updates the status of the specified certificate. This operation is
12
12
  * idempotent.</p>
13
13
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateCertificate</a> action.</p>
14
- *
15
14
  * <p>Certificates must be in the ACTIVE state to authenticate devices that use
16
15
  * a certificate to connect to IoT.</p>
17
16
  * <p>Within a few minutes of updating a certificate from the ACTIVE state to any other
@@ -9,7 +9,7 @@ export interface UpdateDynamicThingGroupCommandOutput extends UpdateDynamicThing
9
9
  }
10
10
  /**
11
11
  * <p>Updates a dynamic thing group.</p>
12
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateDynamicThingGroup</a> action.</p>
12
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateDynamicThingGroup</a> action.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -9,7 +9,7 @@ export interface UpdateEventConfigurationsCommandOutput extends UpdateEventConfi
9
9
  }
10
10
  /**
11
11
  * <p>Updates the event configurations.</p>
12
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateEventConfigurations</a> action.</p>
12
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateEventConfigurations</a> action.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -9,7 +9,7 @@ export interface UpdateJobCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
11
  * <p>Updates supported fields of the specified job.</p>
12
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateJob</a> action.</p>
12
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateJob</a> action.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -9,7 +9,7 @@ export interface UpdateStreamCommandOutput extends UpdateStreamResponse, __Metad
9
9
  }
10
10
  /**
11
11
  * <p>Updates an existing stream. The stream version will be incremented by one.</p>
12
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateStream</a> action.</p>
12
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateStream</a> action.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -9,7 +9,7 @@ export interface UpdateThingCommandOutput extends UpdateThingResponse, __Metadat
9
9
  }
10
10
  /**
11
11
  * <p>Updates the data for a thing.</p>
12
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateThing</a> action.</p>
12
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateThing</a> action.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -9,7 +9,7 @@ export interface UpdateThingGroupCommandOutput extends UpdateThingGroupResponse,
9
9
  }
10
10
  /**
11
11
  * <p>Update a thing group.</p>
12
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateThingGroup</a> action.</p>
12
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateThingGroup</a> action.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -9,7 +9,7 @@ export interface UpdateThingGroupsForThingCommandOutput extends UpdateThingGroup
9
9
  }
10
10
  /**
11
11
  * <p>Updates the groups to which the thing belongs.</p>
12
- * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateThingGroupsForThing</a> action.</p>
12
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateThingGroupsForThing</a> action.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -23,7 +23,7 @@ export interface AbortCriteria {
23
23
  action: AbortAction | string | undefined;
24
24
  /**
25
25
  * <p>The minimum percentage of job execution failures that must occur to initiate the job abort.</p>
26
- * <p>Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).</p>
26
+ * <p>Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).</p>
27
27
  */
28
28
  thresholdPercentage: number | undefined;
29
29
  /**
@@ -167,6 +167,11 @@ export interface CloudwatchLogsAction {
167
167
  * <p>The CloudWatch log group to which the action sends data.</p>
168
168
  */
169
169
  logGroupName: string | undefined;
170
+ /**
171
+ * <p>Indicates whether batches of log records will be extracted and uploaded into CloudWatch. Values include <code>true</code> or <code>false</code>
172
+ * <i>(default)</i>.</p>
173
+ */
174
+ batchMode?: boolean;
170
175
  }
171
176
  /**
172
177
  * <p>Describes an action that captures a CloudWatch metric.</p>
@@ -1457,7 +1462,7 @@ export interface AddThingsToThingGroupParams {
1457
1462
  export interface AddThingToBillingGroupRequest {
1458
1463
  /**
1459
1464
  * <p>The name of the billing group.</p>
1460
- * <note>
1465
+ * <note>
1461
1466
  * <p>This call is asynchronous. It might take several seconds for the detachment to propagate.</p>
1462
1467
  * </note>
1463
1468
  */
@@ -1576,12 +1581,12 @@ export interface AssociateTargetsWithJobRequest {
1576
1581
  comment?: string;
1577
1582
  /**
1578
1583
  * <p>The namespace used to indicate that a job is a customer-managed job.</p>
1579
- * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
1584
+ * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
1580
1585
  * contain the value in the following format.</p>
1581
- * <p>
1586
+ * <p>
1582
1587
  * <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
1583
1588
  * </p>
1584
- * <note>
1589
+ * <note>
1585
1590
  * <p>The <code>namespaceId</code> feature is in public preview.</p>
1586
1591
  * </note>
1587
1592
  */
@@ -1686,18 +1691,18 @@ export interface AttachThingPrincipalResponse {
1686
1691
  export interface AttributePayload {
1687
1692
  /**
1688
1693
  * <p>A JSON string containing up to three key-value pair in JSON format. For example:</p>
1689
- * <p>
1690
- * <code>{\"attributes\":{\"string1\":\"string2\"}}</code>
1691
- * </p>
1694
+ * <p>
1695
+ * <code>{\"attributes\":{\"string1\":\"string2\"}}</code>
1696
+ * </p>
1692
1697
  */
1693
1698
  attributes?: Record<string, string>;
1694
1699
  /**
1695
1700
  * <p>Specifies whether the list of attributes provided in the <code>AttributePayload</code> is merged with
1696
1701
  * the attributes stored in the registry, instead of overwriting them.</p>
1697
- * <p>To remove an attribute, call <code>UpdateThing</code> with an empty attribute value.</p>
1698
- * <note>
1699
- * <p>The <code>merge</code> attribute is only valid when calling <code>UpdateThing</code> or <code>UpdateThingGroup</code>.</p>
1700
- * </note>
1702
+ * <p>To remove an attribute, call <code>UpdateThing</code> with an empty attribute value.</p>
1703
+ * <note>
1704
+ * <p>The <code>merge</code> attribute is only valid when calling <code>UpdateThing</code> or <code>UpdateThingGroup</code>.</p>
1705
+ * </note>
1701
1706
  */
1702
1707
  merge?: boolean;
1703
1708
  }
@@ -2353,7 +2358,7 @@ export interface CancelJobRequest {
2353
2358
  * <p>(Optional) If <code>true</code> job executions with status "IN_PROGRESS" and "QUEUED"
2354
2359
  * are canceled, otherwise only job executions with status "QUEUED" are canceled. The default
2355
2360
  * is <code>false</code>.</p>
2356
- * <p>Canceling a job which is "IN_PROGRESS", will cause a device which is executing
2361
+ * <p>Canceling a job which is "IN_PROGRESS", will cause a device which is executing
2357
2362
  * the job to be unable to update the job execution status. Use caution and ensure that each
2358
2363
  * device executing a job which is canceled is able to recover to a valid state.</p>
2359
2364
  */
@@ -2388,7 +2393,7 @@ export interface CancelJobExecutionRequest {
2388
2393
  * QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set
2389
2394
  * <code>force</code> to <code>true</code>, then an <code>InvalidStateTransitionException</code>
2390
2395
  * will be thrown. The default is <code>false</code>.</p>
2391
- * <p>Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable
2396
+ * <p>Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable
2392
2397
  * to update the job execution status. Use caution and ensure that the device is able to
2393
2398
  * recover to a valid state.</p>
2394
2399
  */
@@ -2843,22 +2848,22 @@ export interface CreateDynamicThingGroupRequest {
2843
2848
  thingGroupProperties?: ThingGroupProperties;
2844
2849
  /**
2845
2850
  * <p>The dynamic thing group index name.</p>
2846
- * <note>
2847
- * <p>Currently one index is supported: <code>AWS_Things</code>.</p>
2848
- * </note>
2851
+ * <note>
2852
+ * <p>Currently one index is supported: <code>AWS_Things</code>.</p>
2853
+ * </note>
2849
2854
  */
2850
2855
  indexName?: string;
2851
2856
  /**
2852
2857
  * <p>The dynamic thing group search query string.</p>
2853
- * <p>See <a href="https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html">Query Syntax</a> for information about query string syntax.</p>
2858
+ * <p>See <a href="https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html">Query Syntax</a> for information about query string syntax.</p>
2854
2859
  */
2855
2860
  queryString: string | undefined;
2856
2861
  /**
2857
2862
  * <p>The dynamic thing group query version.</p>
2858
- * <note>
2859
- * <p>Currently one query version is supported: "2017-09-30". If not specified, the
2863
+ * <note>
2864
+ * <p>Currently one query version is supported: "2017-09-30". If not specified, the
2860
2865
  * query version defaults to this value.</p>
2861
- * </note>
2866
+ * </note>
2862
2867
  */
2863
2868
  queryVersion?: string;
2864
2869
  /**
@@ -3061,7 +3066,7 @@ export interface ExponentialRolloutRate {
3061
3066
  baseRatePerMinute: number | undefined;
3062
3067
  /**
3063
3068
  * <p>The exponential factor to increase the rate of rollout for a job.</p>
3064
- * <p>Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).</p>
3069
+ * <p>Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).</p>
3065
3070
  */
3066
3071
  incrementFactor: number | undefined;
3067
3072
  /**
@@ -3091,10 +3096,10 @@ export interface PresignedUrlConfig {
3091
3096
  /**
3092
3097
  * <p>The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job
3093
3098
  * data/updates are stored. The role must also grant permission for IoT to download the files.</p>
3094
- * <important>
3099
+ * <important>
3095
3100
  * <p>For information about addressing the confused deputy problem, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/cross-service-confused-deputy-prevention.html">cross-service
3096
3101
  * confused deputy prevention</a> in the <i>Amazon Web Services IoT Core developer guide</i>.</p>
3097
- * </important>
3102
+ * </important>
3098
3103
  */
3099
3104
  roleArn?: string;
3100
3105
  /**
@@ -3166,14 +3171,14 @@ export interface CreateJobRequest {
3166
3171
  targets: string[] | undefined;
3167
3172
  /**
3168
3173
  * <p>An S3 link to the job document. Required if you don't specify a value for <code>document</code>.</p>
3169
- * <note>
3174
+ * <note>
3170
3175
  * <p>If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.</p>
3171
3176
  * <p>The placeholder link is of the following form:</p>
3172
3177
  * <p>
3173
3178
  * <code>${aws:iot:s3-presigned-url:https://s3.amazonaws.com/<i>bucket</i>/<i>key</i>}</code>
3174
3179
  * </p>
3175
3180
  * <p>where <i>bucket</i> is your bucket name and <i>key</i> is the object in the bucket to which you are linking.</p>
3176
- * </note>
3181
+ * </note>
3177
3182
  */
3178
3183
  documentSource?: string;
3179
3184
  /**
@@ -3193,11 +3198,11 @@ export interface CreateJobRequest {
3193
3198
  * specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing
3194
3199
  * when a change is detected in a target. For example, a job will run on a thing when the thing is added to a
3195
3200
  * target group, even after the job was completed by all things originally in the group.</p>
3196
- * <note>
3201
+ * <note>
3197
3202
  * <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets.
3198
3203
  * By using continuous jobs, devices that join the group receive the job execution even after the job has
3199
3204
  * been created.</p>
3200
- * </note>
3205
+ * </note>
3201
3206
  */
3202
3207
  targetSelection?: TargetSelection | string;
3203
3208
  /**
@@ -3221,12 +3226,12 @@ export interface CreateJobRequest {
3221
3226
  tags?: Tag[];
3222
3227
  /**
3223
3228
  * <p>The namespace used to indicate that a job is a customer-managed job.</p>
3224
- * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
3229
+ * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
3225
3230
  * contain the value in the following format.</p>
3226
- * <p>
3231
+ * <p>
3227
3232
  * <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
3228
3233
  * </p>
3229
- * <note>
3234
+ * <note>
3230
3235
  * <p>The <code>namespaceId</code> feature is in public preview.</p>
3231
3236
  * </note>
3232
3237
  */
@@ -3241,12 +3246,12 @@ export interface CreateJobRequest {
3241
3246
  jobExecutionsRetryConfig?: JobExecutionsRetryConfig;
3242
3247
  /**
3243
3248
  * <p>Parameters of an Amazon Web Services managed template that you can specify to create the job document.</p>
3244
- * <note>
3249
+ * <note>
3245
3250
  * <p>
3246
3251
  * <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services
3247
3252
  * managed templates. This parameter can't be used with custom job templates or to
3248
3253
  * create jobs from them.</p>
3249
- * </note>
3254
+ * </note>
3250
3255
  */
3251
3256
  documentParameters?: Record<string, string>;
3252
3257
  /**
@@ -3292,14 +3297,14 @@ export interface CreateJobTemplateRequest {
3292
3297
  jobArn?: string;
3293
3298
  /**
3294
3299
  * <p>An S3 link to the job document to use in the template. Required if you don't specify a value for <code>document</code>.</p>
3295
- * <note>
3300
+ * <note>
3296
3301
  * <p>If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.</p>
3297
3302
  * <p>The placeholder link is of the following form:</p>
3298
3303
  * <p>
3299
3304
  * <code>${aws:iot:s3-presigned-url:https://s3.amazonaws.com/<i>bucket</i>/<i>key</i>}</code>
3300
3305
  * </p>
3301
3306
  * <p>where <i>bucket</i> is your bucket name and <i>key</i> is the object in the bucket to which you are linking.</p>
3302
- * </note>
3307
+ * </note>
3303
3308
  */
3304
3309
  documentSource?: string;
3305
3310
  /**
@@ -3588,7 +3593,7 @@ export interface AwsJobExponentialRolloutRate {
3588
3593
  incrementFactor: number | undefined;
3589
3594
  /**
3590
3595
  * <p>The criteria to initiate the increase in rate of rollout for a job.</p>
3591
- * <p>Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).</p>
3596
+ * <p>Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).</p>
3592
3597
  */
3593
3598
  rateIncreaseCriteria: AwsJobRateIncreaseCriteria | undefined;
3594
3599
  }
@@ -4371,7 +4376,7 @@ export interface CreateStreamResponse {
4371
4376
  export interface CreateThingRequest {
4372
4377
  /**
4373
4378
  * <p>The name of the thing to create.</p>
4374
- * <p>You can't change a thing's name after you create it. To change a thing's name, you must create a
4379
+ * <p>You can't change a thing's name after you create it. To change a thing's name, you must create a
4375
4380
  * new thing, give it the new name, and then delete the old thing.</p>
4376
4381
  */
4377
4382
  thingName: string | undefined;
@@ -4382,9 +4387,9 @@ export interface CreateThingRequest {
4382
4387
  /**
4383
4388
  * <p>The attribute payload, which consists of up to three name/value pairs in a JSON
4384
4389
  * document. For example:</p>
4385
- * <p>
4386
- * <code>{\"attributes\":{\"string1\":\"string2\"}}</code>
4387
- * </p>
4390
+ * <p>
4391
+ * <code>{\"attributes\":{\"string1\":\"string2\"}}</code>
4392
+ * </p>
4388
4393
  */
4389
4394
  attributePayload?: AttributePayload;
4390
4395
  /**
@@ -4883,12 +4888,12 @@ export interface DeleteJobRequest {
4883
4888
  force?: boolean;
4884
4889
  /**
4885
4890
  * <p>The namespace used to indicate that a job is a customer-managed job.</p>
4886
- * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
4891
+ * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
4887
4892
  * contain the value in the following format.</p>
4888
- * <p>
4893
+ * <p>
4889
4894
  * <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
4890
4895
  * </p>
4891
- * <note>
4896
+ * <note>
4892
4897
  * <p>The <code>namespaceId</code> feature is in public preview.</p>
4893
4898
  * </note>
4894
4899
  */
@@ -4923,12 +4928,12 @@ export interface DeleteJobExecutionRequest {
4923
4928
  force?: boolean;
4924
4929
  /**
4925
4930
  * <p>The namespace used to indicate that a job is a customer-managed job.</p>
4926
- * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
4931
+ * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
4927
4932
  * contain the value in the following format.</p>
4928
- * <p>
4933
+ * <p>
4929
4934
  * <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
4930
4935
  * </p>
4931
- * <note>
4936
+ * <note>
4932
4937
  * <p>The <code>namespaceId</code> feature is in public preview.</p>
4933
4938
  * </note>
4934
4939
  */