Skip to content

Commit 991cba0

Browse files
author
awstools
committed
feat(client-iot): Add support for dynamic payloads in IoT Device Management Commands
1 parent a8b712b commit 991cba0

22 files changed

+982
-356
lines changed

‎clients/client-iot/src/IoT.ts‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5941,19 +5941,19 @@ export interface IoT {
59415941
/**
59425942
* <fullname>IoT</fullname>
59435943
* <p>IoT provides secure, bi-directional communication between Internet-connected
5944-
* devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services
5945-
* cloud. You can discover your custom IoT-Data endpoint to communicate with, configure
5946-
* rules for data processing and integration with other services, organize resources
5947-
* associated with each device (Registry), configure logging, and create and manage
5948-
* policies and credentials to authenticate devices.</p>
5944+
* devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services
5945+
* cloud. You can discover your custom IoT-Data endpoint to communicate with, configure
5946+
* rules for data processing and integration with other services, organize resources
5947+
* associated with each device (Registry), configure logging, and create and manage
5948+
* policies and credentials to authenticate devices.</p>
59495949
* <p>The service endpoints that expose this API are listed in
5950-
* <a href="https://docs.aws.amazon.com/general/latest/gr/iot-core.html">Amazon Web Services IoT Core Endpoints and Quotas</a>.
5951-
* You must use the endpoint for the region that has the resources you want to access.</p>
5950+
* <a href="https://docs.aws.amazon.com/general/latest/gr/iot-core.html">Amazon Web Services IoT Core Endpoints and Quotas</a>.
5951+
* You must use the endpoint for the region that has the resources you want to access.</p>
59525952
* <p>The service name used by <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Amazon Web Services
5953-
* Signature Version 4</a> to sign the request is:
5954-
* <i>execute-api</i>.</p>
5953+
* Signature Version 4</a> to sign the request is:
5954+
* <i>execute-api</i>.</p>
59555955
* <p>For more information about how IoT works, see the <a href="https://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html">Developer
5956-
* Guide</a>.</p>
5956+
* Guide</a>.</p>
59575957
* <p>For information about how to use the credentials provider for IoT, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html">Authorizing Direct Calls to Amazon Web Services Services</a>.</p>
59585958
* @public
59595959
*/

‎clients/client-iot/src/IoTClient.ts‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1571,19 +1571,19 @@ export interface IoTClientResolvedConfig extends IoTClientResolvedConfigType {}
15711571
/**
15721572
* <fullname>IoT</fullname>
15731573
* <p>IoT provides secure, bi-directional communication between Internet-connected
1574-
* devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services
1575-
* cloud. You can discover your custom IoT-Data endpoint to communicate with, configure
1576-
* rules for data processing and integration with other services, organize resources
1577-
* associated with each device (Registry), configure logging, and create and manage
1578-
* policies and credentials to authenticate devices.</p>
1574+
* devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services
1575+
* cloud. You can discover your custom IoT-Data endpoint to communicate with, configure
1576+
* rules for data processing and integration with other services, organize resources
1577+
* associated with each device (Registry), configure logging, and create and manage
1578+
* policies and credentials to authenticate devices.</p>
15791579
* <p>The service endpoints that expose this API are listed in
1580-
* <a href="https://docs.aws.amazon.com/general/latest/gr/iot-core.html">Amazon Web Services IoT Core Endpoints and Quotas</a>.
1581-
* You must use the endpoint for the region that has the resources you want to access.</p>
1580+
* <a href="https://docs.aws.amazon.com/general/latest/gr/iot-core.html">Amazon Web Services IoT Core Endpoints and Quotas</a>.
1581+
* You must use the endpoint for the region that has the resources you want to access.</p>
15821582
* <p>The service name used by <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Amazon Web Services
1583-
* Signature Version 4</a> to sign the request is:
1584-
* <i>execute-api</i>.</p>
1583+
* Signature Version 4</a> to sign the request is:
1584+
* <i>execute-api</i>.</p>
15851585
* <p>For more information about how IoT works, see the <a href="https://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html">Developer
1586-
* Guide</a>.</p>
1586+
* Guide</a>.</p>
15871587
* <p>For information about how to use the credentials provider for IoT, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html">Authorizing Direct Calls to Amazon Web Services Services</a>.</p>
15881588
* @public
15891589
*/

‎clients/client-iot/src/commands/CreateCommandCommand.ts‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,16 @@ export interface CreateCommandCommandOutput extends CreateCommandResponse, __Met
4646
* content: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
4747
* contentType: "STRING_VALUE",
4848
* },
49+
* payloadTemplate: "STRING_VALUE",
50+
* preprocessor: { // CommandPreprocessor
51+
* awsJsonSubstitution: { // AwsJsonSubstitutionCommandPreprocessorConfig
52+
* outputFormat: "JSON" || "CBOR", // required
53+
* },
54+
* },
4955
* mandatoryParameters: [ // CommandParameterList
5056
* { // CommandParameter
5157
* name: "STRING_VALUE", // required
58+
* type: "STRING" || "INTEGER" || "DOUBLE" || "LONG" || "UNSIGNEDLONG" || "BOOLEAN" || "BINARY",
5259
* value: { // CommandParameterValue
5360
* S: "STRING_VALUE",
5461
* B: true || false,
@@ -67,6 +74,25 @@ export interface CreateCommandCommandOutput extends CreateCommandResponse, __Met
6774
* BIN: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
6875
* UL: "STRING_VALUE",
6976
* },
77+
* valueConditions: [ // CommandParameterValueConditionList
78+
* { // CommandParameterValueCondition
79+
* comparisonOperator: "EQUALS" || "NOT_EQUALS" || "LESS_THAN" || "LESS_THAN_EQUALS" || "GREATER_THAN" || "GREATER_THAN_EQUALS" || "IN_SET" || "NOT_IN_SET" || "IN_RANGE" || "NOT_IN_RANGE", // required
80+
* operand: { // CommandParameterValueComparisonOperand
81+
* number: "STRING_VALUE",
82+
* numbers: [ // CommandParameterValueStringList
83+
* "STRING_VALUE",
84+
* ],
85+
* string: "STRING_VALUE",
86+
* strings: [
87+
* "STRING_VALUE",
88+
* ],
89+
* numberRange: { // CommandParameterValueNumberRange
90+
* min: "STRING_VALUE", // required
91+
* max: "STRING_VALUE", // required
92+
* },
93+
* },
94+
* },
95+
* ],
7096
* description: "STRING_VALUE",
7197
* },
7298
* ],

‎clients/client-iot/src/commands/DescribeAccountAuditConfigurationCommand.ts‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,8 @@ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
55

66
import { commonParams } from "../endpoint/EndpointParameters";
77
import type { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
8-
import type {
9-
DescribeAccountAuditConfigurationRequest,
10-
DescribeAccountAuditConfigurationResponse,
11-
} from "../models/models_0";
8+
import type { DescribeAccountAuditConfigurationRequest } from "../models/models_0";
9+
import type { DescribeAccountAuditConfigurationResponse } from "../models/models_1";
1210
import { DescribeAccountAuditConfiguration$ } from "../schemas/schemas_0";
1311

1412
/**

‎clients/client-iot/src/commands/DescribeAuditFindingCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
55

66
import { commonParams } from "../endpoint/EndpointParameters";
77
import type { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
8-
import type { DescribeAuditFindingRequest, DescribeAuditFindingResponse } from "../models/models_0";
8+
import type { DescribeAuditFindingRequest, DescribeAuditFindingResponse } from "../models/models_1";
99
import { DescribeAuditFinding$ } from "../schemas/schemas_0";
1010

1111
/**

‎clients/client-iot/src/commands/DescribeAuditMitigationActionsTaskCommand.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
55

66
import { commonParams } from "../endpoint/EndpointParameters";
77
import type { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
8-
import type { DescribeAuditMitigationActionsTaskRequest } from "../models/models_0";
9-
import type { DescribeAuditMitigationActionsTaskResponse } from "../models/models_1";
8+
import type {
9+
DescribeAuditMitigationActionsTaskRequest,
10+
DescribeAuditMitigationActionsTaskResponse,
11+
} from "../models/models_1";
1012
import { DescribeAuditMitigationActionsTask$ } from "../schemas/schemas_0";
1113

1214
/**

‎clients/client-iot/src/commands/DescribeEncryptionConfigurationCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface DescribeEncryptionConfigurationCommandOutput
3333

3434
/**
3535
* <p>Retrieves the encryption configuration for resources and data of your Amazon Web Services account in
36-
* Amazon Web Services IoT Core. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/key-management.html">Key management in IoT</a> from
36+
* Amazon Web Services IoT Core. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/encryption-at-rest.html">Data encryption at rest</a> in
3737
* the <i>Amazon Web Services IoT Core Developer Guide</i>.</p>
3838
* @example
3939
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-iot/src/commands/GetCommandCommand.ts‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ export interface GetCommandCommandOutput extends GetCommandResponse, __MetadataB
5050
* // mandatoryParameters: [ // CommandParameterList
5151
* // { // CommandParameter
5252
* // name: "STRING_VALUE", // required
53+
* // type: "STRING" || "INTEGER" || "DOUBLE" || "LONG" || "UNSIGNEDLONG" || "BOOLEAN" || "BINARY",
5354
* // value: { // CommandParameterValue
5455
* // S: "STRING_VALUE",
5556
* // B: true || false,
@@ -68,13 +69,38 @@ export interface GetCommandCommandOutput extends GetCommandResponse, __MetadataB
6869
* // BIN: new Uint8Array(),
6970
* // UL: "STRING_VALUE",
7071
* // },
72+
* // valueConditions: [ // CommandParameterValueConditionList
73+
* // { // CommandParameterValueCondition
74+
* // comparisonOperator: "EQUALS" || "NOT_EQUALS" || "LESS_THAN" || "LESS_THAN_EQUALS" || "GREATER_THAN" || "GREATER_THAN_EQUALS" || "IN_SET" || "NOT_IN_SET" || "IN_RANGE" || "NOT_IN_RANGE", // required
75+
* // operand: { // CommandParameterValueComparisonOperand
76+
* // number: "STRING_VALUE",
77+
* // numbers: [ // CommandParameterValueStringList
78+
* // "STRING_VALUE",
79+
* // ],
80+
* // string: "STRING_VALUE",
81+
* // strings: [
82+
* // "STRING_VALUE",
83+
* // ],
84+
* // numberRange: { // CommandParameterValueNumberRange
85+
* // min: "STRING_VALUE", // required
86+
* // max: "STRING_VALUE", // required
87+
* // },
88+
* // },
89+
* // },
90+
* // ],
7191
* // description: "STRING_VALUE",
7292
* // },
7393
* // ],
7494
* // payload: { // CommandPayload
7595
* // content: new Uint8Array(),
7696
* // contentType: "STRING_VALUE",
7797
* // },
98+
* // payloadTemplate: "STRING_VALUE",
99+
* // preprocessor: { // CommandPreprocessor
100+
* // awsJsonSubstitution: { // AwsJsonSubstitutionCommandPreprocessorConfig
101+
* // outputFormat: "JSON" || "CBOR", // required
102+
* // },
103+
* // },
78104
* // roleArn: "STRING_VALUE",
79105
* // createdAt: new Date("TIMESTAMP"),
80106
* // lastUpdatedAt: new Date("TIMESTAMP"),

‎clients/client-iot/src/commands/ListThingGroupsCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
55

66
import { commonParams } from "../endpoint/EndpointParameters";
77
import type { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
8-
import type { ListThingGroupsRequest, ListThingGroupsResponse } from "../models/models_1";
8+
import type { ListThingGroupsRequest, ListThingGroupsResponse } from "../models/models_2";
99
import { ListThingGroups$ } from "../schemas/schemas_0";
1010

1111
/**

‎clients/client-iot/src/commands/ListThingGroupsForThingCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
55

66
import { commonParams } from "../endpoint/EndpointParameters";
77
import type { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
8-
import type { ListThingGroupsForThingRequest, ListThingGroupsForThingResponse } from "../models/models_1";
8+
import type { ListThingGroupsForThingRequest, ListThingGroupsForThingResponse } from "../models/models_2";
99
import { ListThingGroupsForThing$ } from "../schemas/schemas_0";
1010

1111
/**

0 commit comments

Comments
 (0)