@aws-sdk/client-iot 3.261.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 +2 -2
@@ -177,7 +177,7 @@ export interface DescribeAccountAuditConfigurationResponse {
177
177
  * <p>The ARN of the role that grants permission to IoT to access information
178
178
  * about your devices, policies, certificates, and other items as required when
179
179
  * performing an audit.</p>
180
- * <p>On the first call to <code>UpdateAccountAuditConfiguration</code>,
180
+ * <p>On the first call to <code>UpdateAccountAuditConfiguration</code>,
181
181
  * this parameter is required.</p>
182
182
  */
183
183
  roleArn?: string;
@@ -1250,11 +1250,11 @@ export interface Job {
1250
1250
  * when a change is detected in a target. For example, a job will run on a device when the thing representing
1251
1251
  * the device is added to a target group, even after the job was completed by all things originally in the
1252
1252
  * group. </p>
1253
- * <note>
1253
+ * <note>
1254
1254
  * <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets.
1255
1255
  * By using continuous jobs, devices that join the group receive the job execution even after the job has
1256
1256
  * been created.</p>
1257
- * </note>
1257
+ * </note>
1258
1258
  */
1259
1259
  targetSelection?: TargetSelection | string;
1260
1260
  /**
@@ -1320,12 +1320,12 @@ export interface Job {
1320
1320
  timeoutConfig?: TimeoutConfig;
1321
1321
  /**
1322
1322
  * <p>The namespace used to indicate that a job is a customer-managed job.</p>
1323
- * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
1323
+ * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
1324
1324
  * contain the value in the following format.</p>
1325
- * <p>
1325
+ * <p>
1326
1326
  * <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
1327
1327
  * </p>
1328
- * <note>
1328
+ * <note>
1329
1329
  * <p>The <code>namespaceId</code> feature is in public preview.</p>
1330
1330
  * </note>
1331
1331
  */
@@ -1342,12 +1342,12 @@ export interface Job {
1342
1342
  * <p>A key-value map that pairs the patterns that need to be replaced in a managed
1343
1343
  * template job document schema. You can use the description of each key as a guidance
1344
1344
  * to specify the inputs during runtime when creating a job.</p>
1345
- * <note>
1345
+ * <note>
1346
1346
  * <p>
1347
1347
  * <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services
1348
1348
  * managed templates. This parameter can't be used with custom job templates or to
1349
1349
  * create jobs from them.</p>
1350
- * </note>
1350
+ * </note>
1351
1351
  */
1352
1352
  documentParameters?: Record<string, string>;
1353
1353
  /**
@@ -1540,12 +1540,12 @@ export interface DescribeManagedJobTemplateRequest {
1540
1540
  * <p>A map of key-value pairs containing the patterns that need to be replaced in a managed
1541
1541
  * template job document schema. You can use the description of each key as a guidance to specify
1542
1542
  * the inputs during runtime when creating a job.</p>
1543
- * <note>
1543
+ * <note>
1544
1544
  * <p>
1545
1545
  * <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services
1546
1546
  * managed templates. This parameter can't be used with custom job templates or to
1547
1547
  * create jobs from them.</p>
1548
- * </note>
1548
+ * </note>
1549
1549
  */
1550
1550
  export interface DocumentParameter {
1551
1551
  /**
@@ -1598,12 +1598,12 @@ export interface DescribeManagedJobTemplateResponse {
1598
1598
  /**
1599
1599
  * <p>A map of key-value pairs that you can use as guidance to specify the inputs for creating
1600
1600
  * a job from a managed template.</p>
1601
- * <note>
1601
+ * <note>
1602
1602
  * <p>
1603
1603
  * <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services
1604
1604
  * managed templates. This parameter can't be used with custom job templates or to
1605
1605
  * create jobs from them.</p>
1606
- * </note>
1606
+ * </note>
1607
1607
  */
1608
1608
  documentParameters?: DocumentParameter[];
1609
1609
  /**
@@ -1979,7 +1979,7 @@ export interface DescribeThingResponse {
1979
1979
  * <p>The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID.
1980
1980
  * Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or
1981
1981
  * shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.</p>
1982
- * <p>This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.</p>
1982
+ * <p>This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.</p>
1983
1983
  */
1984
1984
  defaultClientId?: string;
1985
1985
  /**
@@ -2004,11 +2004,11 @@ export interface DescribeThingResponse {
2004
2004
  attributes?: Record<string, string>;
2005
2005
  /**
2006
2006
  * <p>The current version of the thing record in the registry.</p>
2007
- * <note>
2008
- * <p>To avoid unintentional changes to the information in the registry, you can pass
2007
+ * <note>
2008
+ * <p>To avoid unintentional changes to the information in the registry, you can pass
2009
2009
  * the version information in the <code>expectedVersion</code> parameter of the
2010
2010
  * <code>UpdateThing</code> and <code>DeleteThing</code> calls.</p>
2011
- * </note>
2011
+ * </note>
2012
2012
  */
2013
2013
  version?: number;
2014
2014
  /**
@@ -2624,7 +2624,7 @@ export interface ThingIndexingConfiguration {
2624
2624
  * <p>OFF - Device Defender indexing is disabled.</p>
2625
2625
  * </li>
2626
2626
  * </ul>
2627
- * <p>For more information about Device Defender violations, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-detect.html">Device Defender Detect.</a>
2627
+ * <p>For more information about Device Defender violations, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-detect.html">Device Defender Detect.</a>
2628
2628
  * </p>
2629
2629
  */
2630
2630
  deviceDefenderIndexingMode?: DeviceDefenderIndexingMode | string;
@@ -4024,12 +4024,12 @@ export interface ListJobExecutionsForThingRequest {
4024
4024
  status?: JobExecutionStatus | string;
4025
4025
  /**
4026
4026
  * <p>The namespace used to indicate that a job is a customer-managed job.</p>
4027
- * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
4027
+ * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
4028
4028
  * contain the value in the following format.</p>
4029
- * <p>
4029
+ * <p>
4030
4030
  * <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
4031
4031
  * </p>
4032
- * <note>
4032
+ * <note>
4033
4033
  * <p>The <code>namespaceId</code> feature is in public preview.</p>
4034
4034
  * </note>
4035
4035
  */
@@ -4081,11 +4081,11 @@ export interface ListJobsRequest {
4081
4081
  * specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing
4082
4082
  * when a change is detected in a target. For example, a job will run on a thing when the thing is added to a
4083
4083
  * target group, even after the job was completed by all things originally in the group. </p>
4084
- * <note>
4084
+ * <note>
4085
4085
  * <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets.
4086
4086
  * By using continuous jobs, devices that join the group receive the job execution even after the job has
4087
4087
  * been created.</p>
4088
- * </note>
4088
+ * </note>
4089
4089
  */
4090
4090
  targetSelection?: TargetSelection | string;
4091
4091
  /**
@@ -4106,12 +4106,12 @@ export interface ListJobsRequest {
4106
4106
  thingGroupId?: string;
4107
4107
  /**
4108
4108
  * <p>The namespace used to indicate that a job is a customer-managed job.</p>
4109
- * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
4109
+ * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
4110
4110
  * contain the value in the following format.</p>
4111
- * <p>
4111
+ * <p>
4112
4112
  * <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
4113
4113
  * </p>
4114
- * <note>
4114
+ * <note>
4115
4115
  * <p>The <code>namespaceId</code> feature is in public preview.</p>
4116
4116
  * </note>
4117
4117
  */
@@ -4138,11 +4138,11 @@ export interface JobSummary {
4138
4138
  * specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing
4139
4139
  * when a change is detected in a target. For example, a job will run on a thing when the thing is added to a
4140
4140
  * target group, even after the job was completed by all things originally in the group.</p>
4141
- * <note>
4141
+ * <note>
4142
4142
  * <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets.
4143
4143
  * By using continuous jobs, devices that join the group receive the job execution even after the job has
4144
4144
  * been created.</p>
4145
- * </note>
4145
+ * </note>
4146
4146
  */
4147
4147
  targetSelection?: TargetSelection | string;
4148
4148
  /**
@@ -268,7 +268,7 @@ export interface ListThingsRequest {
268
268
  /**
269
269
  * <p>When <code>true</code>, the action returns the thing resources with attribute values
270
270
  * that start with the <code>attributeValue</code> provided.</p>
271
- * <p>When <code>false</code>, or not present, the action returns only the thing
271
+ * <p>When <code>false</code>, or not present, the action returns only the thing
272
272
  * resources with attribute values that match the entire <code>attributeValue</code>
273
273
  * provided. </p>
274
274
  */
@@ -1583,15 +1583,15 @@ export interface UpdateAccountAuditConfigurationRequest {
1583
1583
  * <p>Specifies which audit checks are enabled and disabled for this account. Use
1584
1584
  * <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those
1585
1585
  * that are currently enabled.</p>
1586
- * <p>Some data collection might start immediately when certain checks are enabled.
1586
+ * <p>Some data collection might start immediately when certain checks are enabled.
1587
1587
  * When a check is disabled, any data collected so far in relation to the check is deleted.</p>
1588
- * <p>You
1588
+ * <p>You
1589
1589
  * cannot
1590
1590
  * disable a check if
1591
1591
  * it's
1592
1592
  * used by any scheduled audit. You must first delete the check from the scheduled audit or
1593
1593
  * delete the scheduled audit itself.</p>
1594
- * <p>On the first call to <code>UpdateAccountAuditConfiguration</code>,
1594
+ * <p>On the first call to <code>UpdateAccountAuditConfiguration</code>,
1595
1595
  * this parameter is required and must specify at least one enabled check.</p>
1596
1596
  */
1597
1597
  auditCheckConfigurations?: Record<string, AuditCheckConfiguration>;
@@ -1880,9 +1880,9 @@ export interface UpdateDynamicThingGroupRequest {
1880
1880
  expectedVersion?: number;
1881
1881
  /**
1882
1882
  * <p>The dynamic thing group index to update.</p>
1883
- * <note>
1884
- * <p>Currently one index is supported: <code>AWS_Things</code>.</p>
1885
- * </note>
1883
+ * <note>
1884
+ * <p>Currently one index is supported: <code>AWS_Things</code>.</p>
1885
+ * </note>
1886
1886
  */
1887
1887
  indexName?: string;
1888
1888
  /**
@@ -1891,10 +1891,10 @@ export interface UpdateDynamicThingGroupRequest {
1891
1891
  queryString?: string;
1892
1892
  /**
1893
1893
  * <p>The dynamic thing group query version to update.</p>
1894
- * <note>
1895
- * <p>Currently one query version is supported: "2017-09-30". If not specified, the
1894
+ * <note>
1895
+ * <p>Currently one query version is supported: "2017-09-30". If not specified, the
1896
1896
  * query version defaults to this value.</p>
1897
- * </note>
1897
+ * </note>
1898
1898
  */
1899
1899
  queryVersion?: string;
1900
1900
  }
@@ -1995,12 +1995,12 @@ export interface UpdateJobRequest {
1995
1995
  timeoutConfig?: TimeoutConfig;
1996
1996
  /**
1997
1997
  * <p>The namespace used to indicate that a job is a customer-managed job.</p>
1998
- * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
1998
+ * <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
1999
1999
  * contain the value in the following format.</p>
2000
- * <p>
2000
+ * <p>
2001
2001
  * <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
2002
2002
  * </p>
2003
- * <note>
2003
+ * <note>
2004
2004
  * <p>The <code>namespaceId</code> feature is in public preview.</p>
2005
2005
  * </note>
2006
2006
  */
@@ -2296,7 +2296,7 @@ export interface UpdateStreamResponse {
2296
2296
  export interface UpdateThingRequest {
2297
2297
  /**
2298
2298
  * <p>The name of the thing to update.</p>
2299
- * <p>You can't change a thing's name. To change a thing's name, you must create a
2299
+ * <p>You can't change a thing's name. To change a thing's name, you must create a
2300
2300
  * new thing, give it the new name, and then delete the old thing.</p>
2301
2301
  */
2302
2302
  thingName: string | undefined;
@@ -2307,10 +2307,10 @@ export interface UpdateThingRequest {
2307
2307
  /**
2308
2308
  * <p>A list of thing attributes, a JSON string containing name-value pairs. For
2309
2309
  * example:</p>
2310
- * <p>
2311
- * <code>{\"attributes\":{\"name1\":\"value2\"}}</code>
2312
- * </p>
2313
- * <p>This data is used to add new attributes or update existing attributes.</p>
2310
+ * <p>
2311
+ * <code>{\"attributes\":{\"name1\":\"value2\"}}</code>
2312
+ * </p>
2313
+ * <p>This data is used to add new attributes or update existing attributes.</p>
2314
2314
  */
2315
2315
  attributePayload?: AttributePayload;
2316
2316
  /**
@@ -83,6 +83,7 @@ export interface CloudwatchAlarmAction {
83
83
  export interface CloudwatchLogsAction {
84
84
  roleArn: string | undefined;
85
85
  logGroupName: string | undefined;
86
+ batchMode?: boolean;
86
87
  }
87
88
  export interface CloudwatchMetricAction {
88
89
  roleArn: string | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-iot",
3
3
  "description": "AWS SDK for JavaScript Iot Client for Node.js, Browser and React Native",
4
- "version": "3.261.0",
4
+ "version": "3.262.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,7 +20,7 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.261.0",
23
+ "@aws-sdk/client-sts": "3.262.0",
24
24
  "@aws-sdk/config-resolver": "3.259.0",
25
25
  "@aws-sdk/credential-provider-node": "3.261.0",
26
26
  "@aws-sdk/fetch-http-handler": "3.257.0",