@aws-sdk/client-iotfleetwise 3.696.0 → 3.698.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 (66) hide show
  1. package/README.md +43 -0
  2. package/dist-cjs/index.js +345 -2
  3. package/dist-es/IoTFleetWise.js +10 -0
  4. package/dist-es/commands/CreateStateTemplateCommand.js +22 -0
  5. package/dist-es/commands/DeleteStateTemplateCommand.js +22 -0
  6. package/dist-es/commands/GetStateTemplateCommand.js +22 -0
  7. package/dist-es/commands/ListStateTemplatesCommand.js +22 -0
  8. package/dist-es/commands/UpdateStateTemplateCommand.js +22 -0
  9. package/dist-es/commands/index.js +5 -0
  10. package/dist-es/models/models_0.js +87 -0
  11. package/dist-es/pagination/ListStateTemplatesPaginator.js +4 -0
  12. package/dist-es/pagination/index.js +1 -0
  13. package/dist-es/protocols/Aws_json1_0.js +143 -0
  14. package/dist-types/IoTFleetWise.d.ts +39 -0
  15. package/dist-types/IoTFleetWiseClient.d.ts +10 -2
  16. package/dist-types/commands/BatchCreateVehicleCommand.d.ts +14 -0
  17. package/dist-types/commands/BatchUpdateVehicleCommand.d.ts +17 -0
  18. package/dist-types/commands/CreateCampaignCommand.d.ts +46 -0
  19. package/dist-types/commands/CreateDecoderManifestCommand.d.ts +11 -3
  20. package/dist-types/commands/CreateModelManifestCommand.d.ts +2 -1
  21. package/dist-types/commands/CreateSignalCatalogCommand.d.ts +2 -1
  22. package/dist-types/commands/CreateStateTemplateCommand.d.ts +119 -0
  23. package/dist-types/commands/CreateVehicleCommand.d.ts +14 -0
  24. package/dist-types/commands/DeleteDecoderManifestCommand.d.ts +0 -4
  25. package/dist-types/commands/DeleteFleetCommand.d.ts +0 -4
  26. package/dist-types/commands/DeleteModelManifestCommand.d.ts +0 -4
  27. package/dist-types/commands/DeleteSignalCatalogCommand.d.ts +0 -4
  28. package/dist-types/commands/DeleteStateTemplateCommand.d.ts +85 -0
  29. package/dist-types/commands/DeleteVehicleCommand.d.ts +0 -4
  30. package/dist-types/commands/DisassociateVehicleFleetCommand.d.ts +0 -4
  31. package/dist-types/commands/GetCampaignCommand.d.ts +46 -0
  32. package/dist-types/commands/GetStateTemplateCommand.d.ts +104 -0
  33. package/dist-types/commands/GetVehicleCommand.d.ts +14 -0
  34. package/dist-types/commands/GetVehicleStatusCommand.d.ts +2 -2
  35. package/dist-types/commands/ImportDecoderManifestCommand.d.ts +5 -2
  36. package/dist-types/commands/ImportSignalCatalogCommand.d.ts +2 -1
  37. package/dist-types/commands/ListDecoderManifestNetworkInterfacesCommand.d.ts +4 -1
  38. package/dist-types/commands/ListDecoderManifestSignalsCommand.d.ts +4 -1
  39. package/dist-types/commands/ListStateTemplatesCommand.d.ts +98 -0
  40. package/dist-types/commands/PutEncryptionConfigurationCommand.d.ts +4 -1
  41. package/dist-types/commands/RegisterAccountCommand.d.ts +12 -4
  42. package/dist-types/commands/UpdateDecoderManifestCommand.d.ts +19 -5
  43. package/dist-types/commands/UpdateFleetCommand.d.ts +0 -4
  44. package/dist-types/commands/UpdateModelManifestCommand.d.ts +2 -1
  45. package/dist-types/commands/UpdateSignalCatalogCommand.d.ts +2 -1
  46. package/dist-types/commands/UpdateStateTemplateCommand.d.ts +111 -0
  47. package/dist-types/commands/UpdateVehicleCommand.d.ts +17 -0
  48. package/dist-types/commands/index.d.ts +5 -0
  49. package/dist-types/index.d.ts +3 -0
  50. package/dist-types/models/models_0.d.ts +1137 -146
  51. package/dist-types/pagination/ListStateTemplatesPaginator.d.ts +7 -0
  52. package/dist-types/pagination/index.d.ts +1 -0
  53. package/dist-types/protocols/Aws_json1_0.d.ts +45 -0
  54. package/dist-types/ts3.4/IoTFleetWise.d.ts +86 -0
  55. package/dist-types/ts3.4/IoTFleetWiseClient.d.ts +30 -0
  56. package/dist-types/ts3.4/commands/CreateStateTemplateCommand.d.ts +51 -0
  57. package/dist-types/ts3.4/commands/DeleteStateTemplateCommand.d.ts +51 -0
  58. package/dist-types/ts3.4/commands/GetStateTemplateCommand.d.ts +50 -0
  59. package/dist-types/ts3.4/commands/ListStateTemplatesCommand.d.ts +51 -0
  60. package/dist-types/ts3.4/commands/UpdateStateTemplateCommand.d.ts +51 -0
  61. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  62. package/dist-types/ts3.4/models/models_0.d.ts +256 -0
  63. package/dist-types/ts3.4/pagination/ListStateTemplatesPaginator.d.ts +11 -0
  64. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  65. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +60 -0
  66. package/package.json +1 -1
@@ -0,0 +1,98 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTFleetWiseClient";
4
+ import { ListStateTemplatesRequest, ListStateTemplatesResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListStateTemplatesCommand}.
14
+ */
15
+ export interface ListStateTemplatesCommandInput extends ListStateTemplatesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListStateTemplatesCommand}.
21
+ */
22
+ export interface ListStateTemplatesCommandOutput extends ListStateTemplatesResponse, __MetadataBearer {
23
+ }
24
+ declare const ListStateTemplatesCommand_base: {
25
+ new (input: ListStateTemplatesCommandInput): import("@smithy/smithy-client").CommandImpl<ListStateTemplatesCommandInput, ListStateTemplatesCommandOutput, IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [ListStateTemplatesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListStateTemplatesCommandInput, ListStateTemplatesCommandOutput, IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Lists information about created state templates.</p>
31
+ * <important>
32
+ * <p>Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">Amazon Web Services Region and feature availability</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
33
+ * </important>
34
+ * @example
35
+ * Use a bare-bones client and the command you need to make an API call.
36
+ * ```javascript
37
+ * import { IoTFleetWiseClient, ListStateTemplatesCommand } from "@aws-sdk/client-iotfleetwise"; // ES Modules import
38
+ * // const { IoTFleetWiseClient, ListStateTemplatesCommand } = require("@aws-sdk/client-iotfleetwise"); // CommonJS import
39
+ * const client = new IoTFleetWiseClient(config);
40
+ * const input = { // ListStateTemplatesRequest
41
+ * nextToken: "STRING_VALUE",
42
+ * maxResults: Number("int"),
43
+ * };
44
+ * const command = new ListStateTemplatesCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // ListStateTemplatesResponse
47
+ * // summaries: [ // StateTemplateSummaries
48
+ * // { // StateTemplateSummary
49
+ * // name: "STRING_VALUE",
50
+ * // arn: "STRING_VALUE",
51
+ * // signalCatalogArn: "STRING_VALUE",
52
+ * // description: "STRING_VALUE",
53
+ * // creationTime: new Date("TIMESTAMP"),
54
+ * // lastModificationTime: new Date("TIMESTAMP"),
55
+ * // id: "STRING_VALUE",
56
+ * // },
57
+ * // ],
58
+ * // nextToken: "STRING_VALUE",
59
+ * // };
60
+ *
61
+ * ```
62
+ *
63
+ * @param ListStateTemplatesCommandInput - {@link ListStateTemplatesCommandInput}
64
+ * @returns {@link ListStateTemplatesCommandOutput}
65
+ * @see {@link ListStateTemplatesCommandInput} for command's `input` shape.
66
+ * @see {@link ListStateTemplatesCommandOutput} for command's `response` shape.
67
+ * @see {@link IoTFleetWiseClientResolvedConfig | config} for IoTFleetWiseClient's `config` shape.
68
+ *
69
+ * @throws {@link AccessDeniedException} (client fault)
70
+ * <p>You don't have sufficient permission to perform this action.</p>
71
+ *
72
+ * @throws {@link InternalServerException} (server fault)
73
+ * <p>The request couldn't be completed because the server temporarily failed.</p>
74
+ *
75
+ * @throws {@link ThrottlingException} (client fault)
76
+ * <p>The request couldn't be completed due to throttling.</p>
77
+ *
78
+ * @throws {@link ValidationException} (client fault)
79
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
80
+ *
81
+ * @throws {@link IoTFleetWiseServiceException}
82
+ * <p>Base exception class for all service exceptions from IoTFleetWise service.</p>
83
+ *
84
+ * @public
85
+ */
86
+ export declare class ListStateTemplatesCommand extends ListStateTemplatesCommand_base {
87
+ /** @internal type navigation helper, not in runtime. */
88
+ protected static __types: {
89
+ api: {
90
+ input: ListStateTemplatesRequest;
91
+ output: ListStateTemplatesResponse;
92
+ };
93
+ sdk: {
94
+ input: ListStateTemplatesCommandInput;
95
+ output: ListStateTemplatesCommandOutput;
96
+ };
97
+ };
98
+ }
@@ -27,7 +27,10 @@ declare const PutEncryptionConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and resources using an Amazon Web Services managed key. Or, you can use a KMS key that you own and manage. For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/data-encryption.html">Data encryption</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
30
+ * <p>Creates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and
31
+ * resources using an Amazon Web Services managed key. Or, you can use a KMS key that you own and
32
+ * manage. For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/data-encryption.html">Data
33
+ * encryption</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
31
34
  * @example
32
35
  * Use a bare-bones client and the command you need to make an API call.
33
36
  * ```javascript
@@ -28,16 +28,24 @@ declare const RegisterAccountCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <important>
31
- * <p>This API operation contains deprecated parameters. Register your account again without the Timestream resources parameter so that Amazon Web Services IoT FleetWise can remove the Timestream metadata stored. You should then pass the data destination into the <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/API_CreateCampaign.html">CreateCampaign</a> API operation.</p>
32
- * <p>You must delete any existing campaigns that include an empty data destination before you register your account again. For more information, see the <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/API_DeleteCampaign.html">DeleteCampaign</a> API operation.</p>
33
- * <p>If you want to delete the Timestream inline policy from the service-linked role, such as to mitigate an overly permissive policy, you must first delete any existing campaigns. Then delete the service-linked role and register your account again to enable CloudWatch metrics. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteServiceLinkedRole.html">DeleteServiceLinkedRole</a> in the <i>Identity and Access Management API Reference</i>.</p>
31
+ * <p>This API operation contains deprecated parameters. Register your account again
32
+ * without the Timestream resources parameter so that Amazon Web Services IoT FleetWise can remove the Timestream
33
+ * metadata stored. You should then pass the data destination into the <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/API_CreateCampaign.html">CreateCampaign</a> API operation.</p>
34
+ * <p>You must delete any existing campaigns that include an empty data destination
35
+ * before you register your account again. For more information, see the <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/API_DeleteCampaign.html">DeleteCampaign</a> API operation.</p>
36
+ * <p>If you want to delete the Timestream inline policy from the service-linked role, such
37
+ * as to mitigate an overly permissive policy, you must first delete any existing
38
+ * campaigns. Then delete the service-linked role and register your account again to
39
+ * enable CloudWatch metrics. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteServiceLinkedRole.html">DeleteServiceLinkedRole</a> in the <i>Identity and Access Management API
40
+ * Reference</i>.</p>
34
41
  * </important>
35
42
  * <p>Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can
36
43
  * transfer your vehicle data to the Amazon Web Services Cloud. For more information, including
37
44
  * step-by-step procedures, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/setting-up.html">Setting up
38
45
  * Amazon Web Services IoT FleetWise</a>. </p>
39
46
  * <note>
40
- * <p>An Amazon Web Services account is <b>not</b> the same thing as a "user." An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_identity-management.html#intro-identity-users">Amazon Web Services user</a> is an identity that you create using Identity and Access Management (IAM) and
47
+ * <p>An Amazon Web Services account is <b>not</b> the same thing as a
48
+ * "user." An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_identity-management.html#intro-identity-users">Amazon Web Services user</a> is an identity that you create using Identity and Access Management (IAM) and
41
49
  * takes the form of either an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html">IAM user</a> or an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM role, both
42
50
  * with credentials</a>. A single Amazon Web Services account can, and typically does,
43
51
  * contain many users and roles.</p>
@@ -42,7 +42,7 @@ declare const UpdateDecoderManifestCommand_base: {
42
42
  * signalDecodersToAdd: [ // SignalDecoders
43
43
  * { // SignalDecoder
44
44
  * fullyQualifiedName: "STRING_VALUE", // required
45
- * type: "CAN_SIGNAL" || "OBD_SIGNAL" || "MESSAGE_SIGNAL", // required
45
+ * type: "CAN_SIGNAL" || "OBD_SIGNAL" || "MESSAGE_SIGNAL" || "CUSTOM_DECODING_SIGNAL", // required
46
46
  * interfaceId: "STRING_VALUE", // required
47
47
  * canSignal: { // CanSignal
48
48
  * messageId: Number("int"), // required
@@ -111,12 +111,15 @@ declare const UpdateDecoderManifestCommand_base: {
111
111
  * ],
112
112
  * },
113
113
  * },
114
+ * customDecodingSignal: { // CustomDecodingSignal
115
+ * id: "STRING_VALUE", // required
116
+ * },
114
117
  * },
115
118
  * ],
116
119
  * signalDecodersToUpdate: [
117
120
  * {
118
121
  * fullyQualifiedName: "STRING_VALUE", // required
119
- * type: "CAN_SIGNAL" || "OBD_SIGNAL" || "MESSAGE_SIGNAL", // required
122
+ * type: "CAN_SIGNAL" || "OBD_SIGNAL" || "MESSAGE_SIGNAL" || "CUSTOM_DECODING_SIGNAL", // required
120
123
  * interfaceId: "STRING_VALUE", // required
121
124
  * canSignal: {
122
125
  * messageId: Number("int"), // required
@@ -143,6 +146,9 @@ declare const UpdateDecoderManifestCommand_base: {
143
146
  * topicName: "STRING_VALUE", // required
144
147
  * structuredMessage: "<StructuredMessage>", // required
145
148
  * },
149
+ * customDecodingSignal: {
150
+ * id: "STRING_VALUE", // required
151
+ * },
146
152
  * },
147
153
  * ],
148
154
  * signalDecodersToRemove: [ // Fqns
@@ -151,7 +157,7 @@ declare const UpdateDecoderManifestCommand_base: {
151
157
  * networkInterfacesToAdd: [ // NetworkInterfaces
152
158
  * { // NetworkInterface
153
159
  * interfaceId: "STRING_VALUE", // required
154
- * type: "CAN_INTERFACE" || "OBD_INTERFACE" || "VEHICLE_MIDDLEWARE", // required
160
+ * type: "CAN_INTERFACE" || "OBD_INTERFACE" || "VEHICLE_MIDDLEWARE" || "CUSTOM_DECODING_INTERFACE", // required
155
161
  * canInterface: { // CanInterface
156
162
  * name: "STRING_VALUE", // required
157
163
  * protocolName: "STRING_VALUE",
@@ -170,12 +176,15 @@ declare const UpdateDecoderManifestCommand_base: {
170
176
  * name: "STRING_VALUE", // required
171
177
  * protocolName: "ROS_2", // required
172
178
  * },
179
+ * customDecodingInterface: { // CustomDecodingInterface
180
+ * name: "STRING_VALUE", // required
181
+ * },
173
182
  * },
174
183
  * ],
175
184
  * networkInterfacesToUpdate: [
176
185
  * {
177
186
  * interfaceId: "STRING_VALUE", // required
178
- * type: "CAN_INTERFACE" || "OBD_INTERFACE" || "VEHICLE_MIDDLEWARE", // required
187
+ * type: "CAN_INTERFACE" || "OBD_INTERFACE" || "VEHICLE_MIDDLEWARE" || "CUSTOM_DECODING_INTERFACE", // required
179
188
  * canInterface: {
180
189
  * name: "STRING_VALUE", // required
181
190
  * protocolName: "STRING_VALUE",
@@ -194,12 +203,16 @@ declare const UpdateDecoderManifestCommand_base: {
194
203
  * name: "STRING_VALUE", // required
195
204
  * protocolName: "ROS_2", // required
196
205
  * },
206
+ * customDecodingInterface: {
207
+ * name: "STRING_VALUE", // required
208
+ * },
197
209
  * },
198
210
  * ],
199
211
  * networkInterfacesToRemove: [ // InterfaceIds
200
212
  * "STRING_VALUE",
201
213
  * ],
202
214
  * status: "ACTIVE" || "DRAFT" || "INVALID" || "VALIDATING",
215
+ * defaultForUnmappedSignals: "CUSTOM_DECODING",
203
216
  * };
204
217
  * const command = new UpdateDecoderManifestCommand(input);
205
218
  * const response = await client.send(command);
@@ -224,7 +237,8 @@ declare const UpdateDecoderManifestCommand_base: {
224
237
  * more than one operation on the same resource at the same time.</p>
225
238
  *
226
239
  * @throws {@link DecoderManifestValidationException} (client fault)
227
- * <p>The request couldn't be completed because it contains signal decoders with one or more validation errors.</p>
240
+ * <p>The request couldn't be completed because it contains signal decoders with one or more
241
+ * validation errors.</p>
228
242
  *
229
243
  * @throws {@link LimitExceededException} (client fault)
230
244
  * <p>A service quota was exceeded. </p>
@@ -28,10 +28,6 @@ declare const UpdateFleetCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p> Updates the description of an existing fleet. </p>
31
- * <note>
32
- * <p>If the fleet is successfully updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response
33
- * with an empty HTTP body.</p>
34
- * </note>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -72,7 +72,8 @@ declare const UpdateModelManifestCommand_base: {
72
72
  * <p>The request couldn't be completed because the server temporarily failed.</p>
73
73
  *
74
74
  * @throws {@link InvalidSignalsException} (client fault)
75
- * <p>The request couldn't be completed because it contains signals that aren't valid.</p>
75
+ * <p>The request couldn't be completed because it contains signals that aren't
76
+ * valid.</p>
76
77
  *
77
78
  * @throws {@link ResourceNotFoundException} (client fault)
78
79
  * <p>The resource wasn't found.</p>
@@ -207,7 +207,8 @@ declare const UpdateSignalCatalogCommand_base: {
207
207
  * specify the node type as branch, sensor, actuator, or attribute.</p>
208
208
  *
209
209
  * @throws {@link InvalidSignalsException} (client fault)
210
- * <p>The request couldn't be completed because it contains signals that aren't valid.</p>
210
+ * <p>The request couldn't be completed because it contains signals that aren't
211
+ * valid.</p>
211
212
  *
212
213
  * @throws {@link LimitExceededException} (client fault)
213
214
  * <p>A service quota was exceeded. </p>
@@ -0,0 +1,111 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTFleetWiseClient";
4
+ import { UpdateStateTemplateRequest, UpdateStateTemplateResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UpdateStateTemplateCommand}.
14
+ */
15
+ export interface UpdateStateTemplateCommandInput extends UpdateStateTemplateRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateStateTemplateCommand}.
21
+ */
22
+ export interface UpdateStateTemplateCommandOutput extends UpdateStateTemplateResponse, __MetadataBearer {
23
+ }
24
+ declare const UpdateStateTemplateCommand_base: {
25
+ new (input: UpdateStateTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateStateTemplateCommandInput, UpdateStateTemplateCommandOutput, IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: UpdateStateTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateStateTemplateCommandInput, UpdateStateTemplateCommandOutput, IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Updates a state template.</p>
31
+ * <important>
32
+ * <p>Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">Amazon Web Services Region and feature availability</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
33
+ * </important>
34
+ * @example
35
+ * Use a bare-bones client and the command you need to make an API call.
36
+ * ```javascript
37
+ * import { IoTFleetWiseClient, UpdateStateTemplateCommand } from "@aws-sdk/client-iotfleetwise"; // ES Modules import
38
+ * // const { IoTFleetWiseClient, UpdateStateTemplateCommand } = require("@aws-sdk/client-iotfleetwise"); // CommonJS import
39
+ * const client = new IoTFleetWiseClient(config);
40
+ * const input = { // UpdateStateTemplateRequest
41
+ * identifier: "STRING_VALUE", // required
42
+ * description: "STRING_VALUE",
43
+ * stateTemplatePropertiesToAdd: [ // StateTemplateProperties
44
+ * "STRING_VALUE",
45
+ * ],
46
+ * stateTemplatePropertiesToRemove: [
47
+ * "STRING_VALUE",
48
+ * ],
49
+ * dataExtraDimensions: [ // StateTemplateDataExtraDimensionNodePathList
50
+ * "STRING_VALUE",
51
+ * ],
52
+ * metadataExtraDimensions: [ // StateTemplateMetadataExtraDimensionNodePathList
53
+ * "STRING_VALUE",
54
+ * ],
55
+ * };
56
+ * const command = new UpdateStateTemplateCommand(input);
57
+ * const response = await client.send(command);
58
+ * // { // UpdateStateTemplateResponse
59
+ * // name: "STRING_VALUE",
60
+ * // arn: "STRING_VALUE",
61
+ * // id: "STRING_VALUE",
62
+ * // };
63
+ *
64
+ * ```
65
+ *
66
+ * @param UpdateStateTemplateCommandInput - {@link UpdateStateTemplateCommandInput}
67
+ * @returns {@link UpdateStateTemplateCommandOutput}
68
+ * @see {@link UpdateStateTemplateCommandInput} for command's `input` shape.
69
+ * @see {@link UpdateStateTemplateCommandOutput} for command's `response` shape.
70
+ * @see {@link IoTFleetWiseClientResolvedConfig | config} for IoTFleetWiseClient's `config` shape.
71
+ *
72
+ * @throws {@link AccessDeniedException} (client fault)
73
+ * <p>You don't have sufficient permission to perform this action.</p>
74
+ *
75
+ * @throws {@link InternalServerException} (server fault)
76
+ * <p>The request couldn't be completed because the server temporarily failed.</p>
77
+ *
78
+ * @throws {@link InvalidSignalsException} (client fault)
79
+ * <p>The request couldn't be completed because it contains signals that aren't
80
+ * valid.</p>
81
+ *
82
+ * @throws {@link LimitExceededException} (client fault)
83
+ * <p>A service quota was exceeded. </p>
84
+ *
85
+ * @throws {@link ResourceNotFoundException} (client fault)
86
+ * <p>The resource wasn't found.</p>
87
+ *
88
+ * @throws {@link ThrottlingException} (client fault)
89
+ * <p>The request couldn't be completed due to throttling.</p>
90
+ *
91
+ * @throws {@link ValidationException} (client fault)
92
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
93
+ *
94
+ * @throws {@link IoTFleetWiseServiceException}
95
+ * <p>Base exception class for all service exceptions from IoTFleetWise service.</p>
96
+ *
97
+ * @public
98
+ */
99
+ export declare class UpdateStateTemplateCommand extends UpdateStateTemplateCommand_base {
100
+ /** @internal type navigation helper, not in runtime. */
101
+ protected static __types: {
102
+ api: {
103
+ input: UpdateStateTemplateRequest;
104
+ output: UpdateStateTemplateResponse;
105
+ };
106
+ sdk: {
107
+ input: UpdateStateTemplateCommandInput;
108
+ output: UpdateStateTemplateCommandOutput;
109
+ };
110
+ };
111
+ }
@@ -42,6 +42,23 @@ declare const UpdateVehicleCommand_base: {
42
42
  * "<keys>": "STRING_VALUE",
43
43
  * },
44
44
  * attributeUpdateMode: "Overwrite" || "Merge",
45
+ * stateTemplatesToAdd: [ // StateTemplateAssociations
46
+ * { // StateTemplateAssociation
47
+ * identifier: "STRING_VALUE", // required
48
+ * stateTemplateUpdateStrategy: { // StateTemplateUpdateStrategy Union: only one key present
49
+ * periodic: { // PeriodicStateTemplateUpdateStrategy
50
+ * stateTemplateUpdateRate: { // TimePeriod
51
+ * unit: "MILLISECOND" || "SECOND" || "MINUTE" || "HOUR", // required
52
+ * value: Number("int"), // required
53
+ * },
54
+ * },
55
+ * onChange: {},
56
+ * },
57
+ * },
58
+ * ],
59
+ * stateTemplatesToRemove: [ // StateTemplateAssociationIdentifiers
60
+ * "STRING_VALUE",
61
+ * ],
45
62
  * };
46
63
  * const command = new UpdateVehicleCommand(input);
47
64
  * const response = await client.send(command);
@@ -6,12 +6,14 @@ export * from "./CreateDecoderManifestCommand";
6
6
  export * from "./CreateFleetCommand";
7
7
  export * from "./CreateModelManifestCommand";
8
8
  export * from "./CreateSignalCatalogCommand";
9
+ export * from "./CreateStateTemplateCommand";
9
10
  export * from "./CreateVehicleCommand";
10
11
  export * from "./DeleteCampaignCommand";
11
12
  export * from "./DeleteDecoderManifestCommand";
12
13
  export * from "./DeleteFleetCommand";
13
14
  export * from "./DeleteModelManifestCommand";
14
15
  export * from "./DeleteSignalCatalogCommand";
16
+ export * from "./DeleteStateTemplateCommand";
15
17
  export * from "./DeleteVehicleCommand";
16
18
  export * from "./DisassociateVehicleFleetCommand";
17
19
  export * from "./GetCampaignCommand";
@@ -22,6 +24,7 @@ export * from "./GetLoggingOptionsCommand";
22
24
  export * from "./GetModelManifestCommand";
23
25
  export * from "./GetRegisterAccountStatusCommand";
24
26
  export * from "./GetSignalCatalogCommand";
27
+ export * from "./GetStateTemplateCommand";
25
28
  export * from "./GetVehicleCommand";
26
29
  export * from "./GetVehicleStatusCommand";
27
30
  export * from "./ImportDecoderManifestCommand";
@@ -36,6 +39,7 @@ export * from "./ListModelManifestNodesCommand";
36
39
  export * from "./ListModelManifestsCommand";
37
40
  export * from "./ListSignalCatalogNodesCommand";
38
41
  export * from "./ListSignalCatalogsCommand";
42
+ export * from "./ListStateTemplatesCommand";
39
43
  export * from "./ListTagsForResourceCommand";
40
44
  export * from "./ListVehiclesCommand";
41
45
  export * from "./ListVehiclesInFleetCommand";
@@ -49,4 +53,5 @@ export * from "./UpdateDecoderManifestCommand";
49
53
  export * from "./UpdateFleetCommand";
50
54
  export * from "./UpdateModelManifestCommand";
51
55
  export * from "./UpdateSignalCatalogCommand";
56
+ export * from "./UpdateStateTemplateCommand";
52
57
  export * from "./UpdateVehicleCommand";
@@ -6,6 +6,9 @@
6
6
  * </p>
7
7
  * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/">What is Amazon Web Services IoT FleetWise?</a> in the
8
8
  * <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
9
+ * <important>
10
+ * <p>Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">Amazon Web Services Region and feature availability</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
11
+ * </important>
9
12
  *
10
13
  * @packageDocumentation
11
14
  */