@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.
- package/README.md +43 -0
- package/dist-cjs/index.js +345 -2
- package/dist-es/IoTFleetWise.js +10 -0
- package/dist-es/commands/CreateStateTemplateCommand.js +22 -0
- package/dist-es/commands/DeleteStateTemplateCommand.js +22 -0
- package/dist-es/commands/GetStateTemplateCommand.js +22 -0
- package/dist-es/commands/ListStateTemplatesCommand.js +22 -0
- package/dist-es/commands/UpdateStateTemplateCommand.js +22 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +87 -0
- package/dist-es/pagination/ListStateTemplatesPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_0.js +143 -0
- package/dist-types/IoTFleetWise.d.ts +39 -0
- package/dist-types/IoTFleetWiseClient.d.ts +10 -2
- package/dist-types/commands/BatchCreateVehicleCommand.d.ts +14 -0
- package/dist-types/commands/BatchUpdateVehicleCommand.d.ts +17 -0
- package/dist-types/commands/CreateCampaignCommand.d.ts +46 -0
- package/dist-types/commands/CreateDecoderManifestCommand.d.ts +11 -3
- package/dist-types/commands/CreateModelManifestCommand.d.ts +2 -1
- package/dist-types/commands/CreateSignalCatalogCommand.d.ts +2 -1
- package/dist-types/commands/CreateStateTemplateCommand.d.ts +119 -0
- package/dist-types/commands/CreateVehicleCommand.d.ts +14 -0
- package/dist-types/commands/DeleteDecoderManifestCommand.d.ts +0 -4
- package/dist-types/commands/DeleteFleetCommand.d.ts +0 -4
- package/dist-types/commands/DeleteModelManifestCommand.d.ts +0 -4
- package/dist-types/commands/DeleteSignalCatalogCommand.d.ts +0 -4
- package/dist-types/commands/DeleteStateTemplateCommand.d.ts +85 -0
- package/dist-types/commands/DeleteVehicleCommand.d.ts +0 -4
- package/dist-types/commands/DisassociateVehicleFleetCommand.d.ts +0 -4
- package/dist-types/commands/GetCampaignCommand.d.ts +46 -0
- package/dist-types/commands/GetStateTemplateCommand.d.ts +104 -0
- package/dist-types/commands/GetVehicleCommand.d.ts +14 -0
- package/dist-types/commands/GetVehicleStatusCommand.d.ts +2 -2
- package/dist-types/commands/ImportDecoderManifestCommand.d.ts +5 -2
- package/dist-types/commands/ImportSignalCatalogCommand.d.ts +2 -1
- package/dist-types/commands/ListDecoderManifestNetworkInterfacesCommand.d.ts +4 -1
- package/dist-types/commands/ListDecoderManifestSignalsCommand.d.ts +4 -1
- package/dist-types/commands/ListStateTemplatesCommand.d.ts +98 -0
- package/dist-types/commands/PutEncryptionConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/RegisterAccountCommand.d.ts +12 -4
- package/dist-types/commands/UpdateDecoderManifestCommand.d.ts +19 -5
- package/dist-types/commands/UpdateFleetCommand.d.ts +0 -4
- package/dist-types/commands/UpdateModelManifestCommand.d.ts +2 -1
- package/dist-types/commands/UpdateSignalCatalogCommand.d.ts +2 -1
- package/dist-types/commands/UpdateStateTemplateCommand.d.ts +111 -0
- package/dist-types/commands/UpdateVehicleCommand.d.ts +17 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +1137 -146
- package/dist-types/pagination/ListStateTemplatesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_0.d.ts +45 -0
- package/dist-types/ts3.4/IoTFleetWise.d.ts +86 -0
- package/dist-types/ts3.4/IoTFleetWiseClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateStateTemplateCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteStateTemplateCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetStateTemplateCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListStateTemplatesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateStateTemplateCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +256 -0
- package/dist-types/ts3.4/pagination/ListStateTemplatesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +60 -0
- package/package.json +1 -1
|
@@ -141,7 +141,8 @@ declare const CreateSignalCatalogCommand_base: {
|
|
|
141
141
|
* specify the node type as branch, sensor, actuator, or attribute.</p>
|
|
142
142
|
*
|
|
143
143
|
* @throws {@link InvalidSignalsException} (client fault)
|
|
144
|
-
* <p>The request couldn't be completed because it contains signals that aren't
|
|
144
|
+
* <p>The request couldn't be completed because it contains signals that aren't
|
|
145
|
+
* valid.</p>
|
|
145
146
|
*
|
|
146
147
|
* @throws {@link LimitExceededException} (client fault)
|
|
147
148
|
* <p>A service quota was exceeded. </p>
|
|
@@ -0,0 +1,119 @@
|
|
|
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 { CreateStateTemplateRequest, CreateStateTemplateResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateStateTemplateCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateStateTemplateCommandInput extends CreateStateTemplateRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateStateTemplateCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateStateTemplateCommandOutput extends CreateStateTemplateResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateStateTemplateCommand_base: {
|
|
25
|
+
new (input: CreateStateTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<CreateStateTemplateCommandInput, CreateStateTemplateCommandOutput, IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: CreateStateTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<CreateStateTemplateCommandInput, CreateStateTemplateCommandOutput, IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates a state template. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud.</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, CreateStateTemplateCommand } from "@aws-sdk/client-iotfleetwise"; // ES Modules import
|
|
38
|
+
* // const { IoTFleetWiseClient, CreateStateTemplateCommand } = require("@aws-sdk/client-iotfleetwise"); // CommonJS import
|
|
39
|
+
* const client = new IoTFleetWiseClient(config);
|
|
40
|
+
* const input = { // CreateStateTemplateRequest
|
|
41
|
+
* name: "STRING_VALUE", // required
|
|
42
|
+
* description: "STRING_VALUE",
|
|
43
|
+
* signalCatalogArn: "STRING_VALUE", // required
|
|
44
|
+
* stateTemplateProperties: [ // StateTemplateProperties // required
|
|
45
|
+
* "STRING_VALUE",
|
|
46
|
+
* ],
|
|
47
|
+
* dataExtraDimensions: [ // StateTemplateDataExtraDimensionNodePathList
|
|
48
|
+
* "STRING_VALUE",
|
|
49
|
+
* ],
|
|
50
|
+
* metadataExtraDimensions: [ // StateTemplateMetadataExtraDimensionNodePathList
|
|
51
|
+
* "STRING_VALUE",
|
|
52
|
+
* ],
|
|
53
|
+
* tags: [ // TagList
|
|
54
|
+
* { // Tag
|
|
55
|
+
* Key: "STRING_VALUE", // required
|
|
56
|
+
* Value: "STRING_VALUE", // required
|
|
57
|
+
* },
|
|
58
|
+
* ],
|
|
59
|
+
* };
|
|
60
|
+
* const command = new CreateStateTemplateCommand(input);
|
|
61
|
+
* const response = await client.send(command);
|
|
62
|
+
* // { // CreateStateTemplateResponse
|
|
63
|
+
* // name: "STRING_VALUE",
|
|
64
|
+
* // arn: "STRING_VALUE",
|
|
65
|
+
* // id: "STRING_VALUE",
|
|
66
|
+
* // };
|
|
67
|
+
*
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* @param CreateStateTemplateCommandInput - {@link CreateStateTemplateCommandInput}
|
|
71
|
+
* @returns {@link CreateStateTemplateCommandOutput}
|
|
72
|
+
* @see {@link CreateStateTemplateCommandInput} for command's `input` shape.
|
|
73
|
+
* @see {@link CreateStateTemplateCommandOutput} for command's `response` shape.
|
|
74
|
+
* @see {@link IoTFleetWiseClientResolvedConfig | config} for IoTFleetWiseClient's `config` shape.
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
77
|
+
* <p>You don't have sufficient permission to perform this action.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ConflictException} (client fault)
|
|
80
|
+
* <p>The request has conflicting operations. This can occur if you're trying to perform
|
|
81
|
+
* more than one operation on the same resource at the same time.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InternalServerException} (server fault)
|
|
84
|
+
* <p>The request couldn't be completed because the server temporarily failed.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link InvalidSignalsException} (client fault)
|
|
87
|
+
* <p>The request couldn't be completed because it contains signals that aren't
|
|
88
|
+
* valid.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
91
|
+
* <p>A service quota was exceeded. </p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
94
|
+
* <p>The resource wasn't found.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
97
|
+
* <p>The request couldn't be completed due to throttling.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link ValidationException} (client fault)
|
|
100
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link IoTFleetWiseServiceException}
|
|
103
|
+
* <p>Base exception class for all service exceptions from IoTFleetWise service.</p>
|
|
104
|
+
*
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
export declare class CreateStateTemplateCommand extends CreateStateTemplateCommand_base {
|
|
108
|
+
/** @internal type navigation helper, not in runtime. */
|
|
109
|
+
protected static __types: {
|
|
110
|
+
api: {
|
|
111
|
+
input: CreateStateTemplateRequest;
|
|
112
|
+
output: CreateStateTemplateResponse;
|
|
113
|
+
};
|
|
114
|
+
sdk: {
|
|
115
|
+
input: CreateStateTemplateCommandInput;
|
|
116
|
+
output: CreateStateTemplateCommandOutput;
|
|
117
|
+
};
|
|
118
|
+
};
|
|
119
|
+
}
|
|
@@ -56,6 +56,20 @@ declare const CreateVehicleCommand_base: {
|
|
|
56
56
|
* Value: "STRING_VALUE", // required
|
|
57
57
|
* },
|
|
58
58
|
* ],
|
|
59
|
+
* stateTemplates: [ // StateTemplateAssociations
|
|
60
|
+
* { // StateTemplateAssociation
|
|
61
|
+
* identifier: "STRING_VALUE", // required
|
|
62
|
+
* stateTemplateUpdateStrategy: { // StateTemplateUpdateStrategy Union: only one key present
|
|
63
|
+
* periodic: { // PeriodicStateTemplateUpdateStrategy
|
|
64
|
+
* stateTemplateUpdateRate: { // TimePeriod
|
|
65
|
+
* unit: "MILLISECOND" || "SECOND" || "MINUTE" || "HOUR", // required
|
|
66
|
+
* value: Number("int"), // required
|
|
67
|
+
* },
|
|
68
|
+
* },
|
|
69
|
+
* onChange: {},
|
|
70
|
+
* },
|
|
71
|
+
* },
|
|
72
|
+
* ],
|
|
59
73
|
* };
|
|
60
74
|
* const command = new CreateVehicleCommand(input);
|
|
61
75
|
* const response = await client.send(command);
|
|
@@ -29,10 +29,6 @@ declare const DeleteDecoderManifestCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p> Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles
|
|
31
31
|
* associated with it. </p>
|
|
32
|
-
* <note>
|
|
33
|
-
* <p>If the decoder manifest is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200
|
|
34
|
-
* response with an empty body.</p>
|
|
35
|
-
* </note>
|
|
36
32
|
* @example
|
|
37
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
34
|
* ```javascript
|
|
@@ -30,10 +30,6 @@ declare const DeleteFleetCommand_base: {
|
|
|
30
30
|
* <p> Deletes a fleet. Before you delete a fleet, all vehicles must be
|
|
31
31
|
* dissociated from the fleet. For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/delete-fleet-cli.html">Delete a fleet (AWS
|
|
32
32
|
* CLI)</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
|
|
33
|
-
* <note>
|
|
34
|
-
* <p>If the fleet is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response
|
|
35
|
-
* with an empty body.</p>
|
|
36
|
-
* </note>
|
|
37
33
|
* @example
|
|
38
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
35
|
* ```javascript
|
|
@@ -28,10 +28,6 @@ declare const DeleteModelManifestCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p> Deletes a vehicle model (model manifest).</p>
|
|
31
|
-
* <note>
|
|
32
|
-
* <p>If the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200
|
|
33
|
-
* response with an empty 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
|
|
@@ -28,10 +28,6 @@ declare const DeleteSignalCatalogCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p> Deletes a signal catalog. </p>
|
|
31
|
-
* <note>
|
|
32
|
-
* <p>If the signal catalog is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200
|
|
33
|
-
* response with an empty 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
|
|
@@ -0,0 +1,85 @@
|
|
|
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 { DeleteStateTemplateRequest, DeleteStateTemplateResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteStateTemplateCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteStateTemplateCommandInput extends DeleteStateTemplateRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteStateTemplateCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteStateTemplateCommandOutput extends DeleteStateTemplateResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteStateTemplateCommand_base: {
|
|
25
|
+
new (input: DeleteStateTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteStateTemplateCommandInput, DeleteStateTemplateCommandOutput, IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeleteStateTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteStateTemplateCommandInput, DeleteStateTemplateCommandOutput, IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes a state template.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { IoTFleetWiseClient, DeleteStateTemplateCommand } from "@aws-sdk/client-iotfleetwise"; // ES Modules import
|
|
35
|
+
* // const { IoTFleetWiseClient, DeleteStateTemplateCommand } = require("@aws-sdk/client-iotfleetwise"); // CommonJS import
|
|
36
|
+
* const client = new IoTFleetWiseClient(config);
|
|
37
|
+
* const input = { // DeleteStateTemplateRequest
|
|
38
|
+
* identifier: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DeleteStateTemplateCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // DeleteStateTemplateResponse
|
|
43
|
+
* // name: "STRING_VALUE",
|
|
44
|
+
* // arn: "STRING_VALUE",
|
|
45
|
+
* // id: "STRING_VALUE",
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* @param DeleteStateTemplateCommandInput - {@link DeleteStateTemplateCommandInput}
|
|
51
|
+
* @returns {@link DeleteStateTemplateCommandOutput}
|
|
52
|
+
* @see {@link DeleteStateTemplateCommandInput} for command's `input` shape.
|
|
53
|
+
* @see {@link DeleteStateTemplateCommandOutput} for command's `response` shape.
|
|
54
|
+
* @see {@link IoTFleetWiseClientResolvedConfig | config} for IoTFleetWiseClient's `config` shape.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
57
|
+
* <p>You don't have sufficient permission to perform this action.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InternalServerException} (server fault)
|
|
60
|
+
* <p>The request couldn't be completed because the server temporarily failed.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
63
|
+
* <p>The request couldn't be completed due to throttling.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ValidationException} (client fault)
|
|
66
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link IoTFleetWiseServiceException}
|
|
69
|
+
* <p>Base exception class for all service exceptions from IoTFleetWise service.</p>
|
|
70
|
+
*
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
export declare class DeleteStateTemplateCommand extends DeleteStateTemplateCommand_base {
|
|
74
|
+
/** @internal type navigation helper, not in runtime. */
|
|
75
|
+
protected static __types: {
|
|
76
|
+
api: {
|
|
77
|
+
input: DeleteStateTemplateRequest;
|
|
78
|
+
output: DeleteStateTemplateResponse;
|
|
79
|
+
};
|
|
80
|
+
sdk: {
|
|
81
|
+
input: DeleteStateTemplateCommandInput;
|
|
82
|
+
output: DeleteStateTemplateCommandOutput;
|
|
83
|
+
};
|
|
84
|
+
};
|
|
85
|
+
}
|
|
@@ -28,10 +28,6 @@ declare const DeleteVehicleCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p> Deletes a vehicle and removes it from any campaigns.</p>
|
|
31
|
-
* <note>
|
|
32
|
-
* <p>If the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response
|
|
33
|
-
* with an empty 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
|
|
@@ -29,10 +29,6 @@ declare const DisassociateVehicleFleetCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a
|
|
31
31
|
* fleet doesn't delete the vehicle.</p>
|
|
32
|
-
* <note>
|
|
33
|
-
* <p>If the vehicle is successfully dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an
|
|
34
|
-
* HTTP 200 response with an empty body.</p>
|
|
35
|
-
* </note>
|
|
36
32
|
* @example
|
|
37
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
34
|
* ```javascript
|
|
@@ -28,6 +28,9 @@ declare const GetCampaignCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p> Retrieves information about a campaign. </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>
|
|
31
34
|
* @example
|
|
32
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
36
|
* ```javascript
|
|
@@ -58,6 +61,7 @@ declare const GetCampaignCommand_base: {
|
|
|
58
61
|
* // name: "STRING_VALUE", // required
|
|
59
62
|
* // maxSampleCount: Number("long"),
|
|
60
63
|
* // minimumSamplingIntervalMs: Number("long"),
|
|
64
|
+
* // dataPartitionId: "STRING_VALUE",
|
|
61
65
|
* // },
|
|
62
66
|
* // ],
|
|
63
67
|
* // collectionScheme: { // CollectionScheme Union: only one key present
|
|
@@ -88,6 +92,48 @@ declare const GetCampaignCommand_base: {
|
|
|
88
92
|
* // timestreamTableArn: "STRING_VALUE", // required
|
|
89
93
|
* // executionRoleArn: "STRING_VALUE", // required
|
|
90
94
|
* // },
|
|
95
|
+
* // mqttTopicConfig: { // MqttTopicConfig
|
|
96
|
+
* // mqttTopicArn: "STRING_VALUE", // required
|
|
97
|
+
* // executionRoleArn: "STRING_VALUE", // required
|
|
98
|
+
* // },
|
|
99
|
+
* // },
|
|
100
|
+
* // ],
|
|
101
|
+
* // dataPartitions: [ // DataPartitions
|
|
102
|
+
* // { // DataPartition
|
|
103
|
+
* // id: "STRING_VALUE", // required
|
|
104
|
+
* // storageOptions: { // DataPartitionStorageOptions
|
|
105
|
+
* // maximumSize: { // StorageMaximumSize
|
|
106
|
+
* // unit: "MB" || "GB" || "TB", // required
|
|
107
|
+
* // value: Number("int"), // required
|
|
108
|
+
* // },
|
|
109
|
+
* // storageLocation: "STRING_VALUE", // required
|
|
110
|
+
* // minimumTimeToLive: { // StorageMinimumTimeToLive
|
|
111
|
+
* // unit: "HOURS" || "DAYS" || "WEEKS", // required
|
|
112
|
+
* // value: Number("int"), // required
|
|
113
|
+
* // },
|
|
114
|
+
* // },
|
|
115
|
+
* // uploadOptions: { // DataPartitionUploadOptions
|
|
116
|
+
* // expression: "STRING_VALUE", // required
|
|
117
|
+
* // conditionLanguageVersion: Number("int"),
|
|
118
|
+
* // },
|
|
119
|
+
* // },
|
|
120
|
+
* // ],
|
|
121
|
+
* // signalsToFetch: [ // SignalFetchInformationList
|
|
122
|
+
* // { // SignalFetchInformation
|
|
123
|
+
* // fullyQualifiedName: "STRING_VALUE", // required
|
|
124
|
+
* // signalFetchConfig: { // SignalFetchConfig Union: only one key present
|
|
125
|
+
* // timeBased: { // TimeBasedSignalFetchConfig
|
|
126
|
+
* // executionFrequencyMs: Number("long"), // required
|
|
127
|
+
* // },
|
|
128
|
+
* // conditionBased: { // ConditionBasedSignalFetchConfig
|
|
129
|
+
* // conditionExpression: "STRING_VALUE", // required
|
|
130
|
+
* // triggerMode: "ALWAYS" || "RISING_EDGE", // required
|
|
131
|
+
* // },
|
|
132
|
+
* // },
|
|
133
|
+
* // conditionLanguageVersion: Number("int"),
|
|
134
|
+
* // actions: [ // EventExpressionList // required
|
|
135
|
+
* // "STRING_VALUE",
|
|
136
|
+
* // ],
|
|
91
137
|
* // },
|
|
92
138
|
* // ],
|
|
93
139
|
* // };
|
|
@@ -0,0 +1,104 @@
|
|
|
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 { GetStateTemplateRequest, GetStateTemplateResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetStateTemplateCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetStateTemplateCommandInput extends GetStateTemplateRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetStateTemplateCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetStateTemplateCommandOutput extends GetStateTemplateResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetStateTemplateCommand_base: {
|
|
25
|
+
new (input: GetStateTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<GetStateTemplateCommandInput, GetStateTemplateCommandOutput, IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetStateTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<GetStateTemplateCommandInput, GetStateTemplateCommandOutput, IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves information about 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, GetStateTemplateCommand } from "@aws-sdk/client-iotfleetwise"; // ES Modules import
|
|
38
|
+
* // const { IoTFleetWiseClient, GetStateTemplateCommand } = require("@aws-sdk/client-iotfleetwise"); // CommonJS import
|
|
39
|
+
* const client = new IoTFleetWiseClient(config);
|
|
40
|
+
* const input = { // GetStateTemplateRequest
|
|
41
|
+
* identifier: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetStateTemplateCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // GetStateTemplateResponse
|
|
46
|
+
* // name: "STRING_VALUE",
|
|
47
|
+
* // arn: "STRING_VALUE",
|
|
48
|
+
* // description: "STRING_VALUE",
|
|
49
|
+
* // signalCatalogArn: "STRING_VALUE",
|
|
50
|
+
* // stateTemplateProperties: [ // StateTemplateProperties
|
|
51
|
+
* // "STRING_VALUE",
|
|
52
|
+
* // ],
|
|
53
|
+
* // dataExtraDimensions: [ // StateTemplateDataExtraDimensionNodePathList
|
|
54
|
+
* // "STRING_VALUE",
|
|
55
|
+
* // ],
|
|
56
|
+
* // metadataExtraDimensions: [ // StateTemplateMetadataExtraDimensionNodePathList
|
|
57
|
+
* // "STRING_VALUE",
|
|
58
|
+
* // ],
|
|
59
|
+
* // creationTime: new Date("TIMESTAMP"),
|
|
60
|
+
* // lastModificationTime: new Date("TIMESTAMP"),
|
|
61
|
+
* // id: "STRING_VALUE",
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @param GetStateTemplateCommandInput - {@link GetStateTemplateCommandInput}
|
|
67
|
+
* @returns {@link GetStateTemplateCommandOutput}
|
|
68
|
+
* @see {@link GetStateTemplateCommandInput} for command's `input` shape.
|
|
69
|
+
* @see {@link GetStateTemplateCommandOutput} 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 ResourceNotFoundException} (client fault)
|
|
79
|
+
* <p>The resource wasn't found.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
82
|
+
* <p>The request couldn't be completed due to throttling.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ValidationException} (client fault)
|
|
85
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link IoTFleetWiseServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from IoTFleetWise service.</p>
|
|
89
|
+
*
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
export declare class GetStateTemplateCommand extends GetStateTemplateCommand_base {
|
|
93
|
+
/** @internal type navigation helper, not in runtime. */
|
|
94
|
+
protected static __types: {
|
|
95
|
+
api: {
|
|
96
|
+
input: GetStateTemplateRequest;
|
|
97
|
+
output: GetStateTemplateResponse;
|
|
98
|
+
};
|
|
99
|
+
sdk: {
|
|
100
|
+
input: GetStateTemplateCommandInput;
|
|
101
|
+
output: GetStateTemplateCommandOutput;
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
}
|
|
@@ -47,6 +47,20 @@ declare const GetVehicleCommand_base: {
|
|
|
47
47
|
* // attributes: { // attributesMap
|
|
48
48
|
* // "<keys>": "STRING_VALUE",
|
|
49
49
|
* // },
|
|
50
|
+
* // stateTemplates: [ // StateTemplateAssociations
|
|
51
|
+
* // { // StateTemplateAssociation
|
|
52
|
+
* // identifier: "STRING_VALUE", // required
|
|
53
|
+
* // stateTemplateUpdateStrategy: { // StateTemplateUpdateStrategy Union: only one key present
|
|
54
|
+
* // periodic: { // PeriodicStateTemplateUpdateStrategy
|
|
55
|
+
* // stateTemplateUpdateRate: { // TimePeriod
|
|
56
|
+
* // unit: "MILLISECOND" || "SECOND" || "MINUTE" || "HOUR", // required
|
|
57
|
+
* // value: Number("int"), // required
|
|
58
|
+
* // },
|
|
59
|
+
* // },
|
|
60
|
+
* // onChange: {},
|
|
61
|
+
* // },
|
|
62
|
+
* // },
|
|
63
|
+
* // ],
|
|
50
64
|
* // creationTime: new Date("TIMESTAMP"),
|
|
51
65
|
* // lastModificationTime: new Date("TIMESTAMP"),
|
|
52
66
|
* // };
|
|
@@ -27,8 +27,8 @@ declare const GetVehicleStatusCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p> Retrieves information about the status of
|
|
31
|
-
*
|
|
30
|
+
* <p> Retrieves information about the status of campaigns, decoder manifests, or state templates
|
|
31
|
+
* associated with a vehicle.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -29,6 +29,7 @@ declare const ImportDecoderManifestCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p> Creates a decoder manifest using your existing CAN DBC file from your local device.
|
|
31
31
|
* </p>
|
|
32
|
+
* <p>The CAN signal name must be unique and not repeated across CAN message definitions in a .dbc file. </p>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
35
|
* ```javascript
|
|
@@ -74,10 +75,12 @@ declare const ImportDecoderManifestCommand_base: {
|
|
|
74
75
|
* more than one operation on the same resource at the same time.</p>
|
|
75
76
|
*
|
|
76
77
|
* @throws {@link DecoderManifestValidationException} (client fault)
|
|
77
|
-
* <p>The request couldn't be completed because it contains signal decoders with one or more
|
|
78
|
+
* <p>The request couldn't be completed because it contains signal decoders with one or more
|
|
79
|
+
* validation errors.</p>
|
|
78
80
|
*
|
|
79
81
|
* @throws {@link InvalidSignalsException} (client fault)
|
|
80
|
-
* <p>The request couldn't be completed because it contains signals that aren't
|
|
82
|
+
* <p>The request couldn't be completed because it contains signals that aren't
|
|
83
|
+
* valid.</p>
|
|
81
84
|
*
|
|
82
85
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
83
86
|
* <p>The resource wasn't found.</p>
|
|
@@ -74,7 +74,8 @@ declare const ImportSignalCatalogCommand_base: {
|
|
|
74
74
|
* <p>The request couldn't be completed because the server temporarily failed.</p>
|
|
75
75
|
*
|
|
76
76
|
* @throws {@link InvalidSignalsException} (client fault)
|
|
77
|
-
* <p>The request couldn't be completed because it contains signals that aren't
|
|
77
|
+
* <p>The request couldn't be completed because it contains signals that aren't
|
|
78
|
+
* valid.</p>
|
|
78
79
|
*
|
|
79
80
|
* @throws {@link LimitExceededException} (client fault)
|
|
80
81
|
* <p>A service quota was exceeded. </p>
|
|
@@ -48,7 +48,7 @@ declare const ListDecoderManifestNetworkInterfacesCommand_base: {
|
|
|
48
48
|
* // networkInterfaces: [ // NetworkInterfaces
|
|
49
49
|
* // { // NetworkInterface
|
|
50
50
|
* // interfaceId: "STRING_VALUE", // required
|
|
51
|
-
* // type: "CAN_INTERFACE" || "OBD_INTERFACE" || "VEHICLE_MIDDLEWARE", // required
|
|
51
|
+
* // type: "CAN_INTERFACE" || "OBD_INTERFACE" || "VEHICLE_MIDDLEWARE" || "CUSTOM_DECODING_INTERFACE", // required
|
|
52
52
|
* // canInterface: { // CanInterface
|
|
53
53
|
* // name: "STRING_VALUE", // required
|
|
54
54
|
* // protocolName: "STRING_VALUE",
|
|
@@ -67,6 +67,9 @@ declare const ListDecoderManifestNetworkInterfacesCommand_base: {
|
|
|
67
67
|
* // name: "STRING_VALUE", // required
|
|
68
68
|
* // protocolName: "ROS_2", // required
|
|
69
69
|
* // },
|
|
70
|
+
* // customDecodingInterface: { // CustomDecodingInterface
|
|
71
|
+
* // name: "STRING_VALUE", // required
|
|
72
|
+
* // },
|
|
70
73
|
* // },
|
|
71
74
|
* // ],
|
|
72
75
|
* // nextToken: "STRING_VALUE",
|
|
@@ -48,7 +48,7 @@ declare const ListDecoderManifestSignalsCommand_base: {
|
|
|
48
48
|
* // signalDecoders: [ // SignalDecoders
|
|
49
49
|
* // { // SignalDecoder
|
|
50
50
|
* // fullyQualifiedName: "STRING_VALUE", // required
|
|
51
|
-
* // type: "CAN_SIGNAL" || "OBD_SIGNAL" || "MESSAGE_SIGNAL", // required
|
|
51
|
+
* // type: "CAN_SIGNAL" || "OBD_SIGNAL" || "MESSAGE_SIGNAL" || "CUSTOM_DECODING_SIGNAL", // required
|
|
52
52
|
* // interfaceId: "STRING_VALUE", // required
|
|
53
53
|
* // canSignal: { // CanSignal
|
|
54
54
|
* // messageId: Number("int"), // required
|
|
@@ -117,6 +117,9 @@ declare const ListDecoderManifestSignalsCommand_base: {
|
|
|
117
117
|
* // ],
|
|
118
118
|
* // },
|
|
119
119
|
* // },
|
|
120
|
+
* // customDecodingSignal: { // CustomDecodingSignal
|
|
121
|
+
* // id: "STRING_VALUE", // required
|
|
122
|
+
* // },
|
|
120
123
|
* // },
|
|
121
124
|
* // ],
|
|
122
125
|
* // nextToken: "STRING_VALUE",
|