@aws-sdk/client-iotfleetwise 3.529.1 → 3.535.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/dist-types/IoTFleetWise.d.ts +11 -1
- package/dist-types/IoTFleetWiseClient.d.ts +1 -1
- package/dist-types/commands/AssociateVehicleFleetCommand.d.ts +2 -1
- package/dist-types/commands/BatchCreateVehicleCommand.d.ts +2 -1
- package/dist-types/commands/BatchUpdateVehicleCommand.d.ts +2 -1
- package/dist-types/commands/CreateCampaignCommand.d.ts +2 -1
- package/dist-types/commands/CreateDecoderManifestCommand.d.ts +2 -1
- package/dist-types/commands/CreateFleetCommand.d.ts +2 -1
- package/dist-types/commands/CreateModelManifestCommand.d.ts +2 -1
- package/dist-types/commands/CreateSignalCatalogCommand.d.ts +2 -1
- package/dist-types/commands/CreateVehicleCommand.d.ts +2 -1
- package/dist-types/commands/DeleteCampaignCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDecoderManifestCommand.d.ts +2 -1
- package/dist-types/commands/DeleteFleetCommand.d.ts +2 -1
- package/dist-types/commands/DeleteModelManifestCommand.d.ts +2 -1
- package/dist-types/commands/DeleteSignalCatalogCommand.d.ts +2 -1
- package/dist-types/commands/DeleteVehicleCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateVehicleFleetCommand.d.ts +2 -1
- package/dist-types/commands/GetCampaignCommand.d.ts +2 -1
- package/dist-types/commands/GetDecoderManifestCommand.d.ts +2 -1
- package/dist-types/commands/GetEncryptionConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/GetFleetCommand.d.ts +2 -1
- package/dist-types/commands/GetLoggingOptionsCommand.d.ts +2 -1
- package/dist-types/commands/GetModelManifestCommand.d.ts +2 -1
- package/dist-types/commands/GetRegisterAccountStatusCommand.d.ts +2 -1
- package/dist-types/commands/GetSignalCatalogCommand.d.ts +2 -1
- package/dist-types/commands/GetVehicleCommand.d.ts +2 -1
- package/dist-types/commands/GetVehicleStatusCommand.d.ts +2 -1
- package/dist-types/commands/ImportDecoderManifestCommand.d.ts +3 -2
- package/dist-types/commands/ImportSignalCatalogCommand.d.ts +2 -1
- package/dist-types/commands/ListCampaignsCommand.d.ts +2 -1
- package/dist-types/commands/ListDecoderManifestNetworkInterfacesCommand.d.ts +2 -1
- package/dist-types/commands/ListDecoderManifestSignalsCommand.d.ts +2 -1
- package/dist-types/commands/ListDecoderManifestsCommand.d.ts +2 -1
- package/dist-types/commands/ListFleetsCommand.d.ts +2 -1
- package/dist-types/commands/ListFleetsForVehicleCommand.d.ts +2 -1
- package/dist-types/commands/ListModelManifestNodesCommand.d.ts +2 -1
- package/dist-types/commands/ListModelManifestsCommand.d.ts +2 -1
- package/dist-types/commands/ListSignalCatalogNodesCommand.d.ts +2 -1
- package/dist-types/commands/ListSignalCatalogsCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListVehiclesCommand.d.ts +2 -1
- package/dist-types/commands/ListVehiclesInFleetCommand.d.ts +2 -1
- package/dist-types/commands/PutEncryptionConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/PutLoggingOptionsCommand.d.ts +2 -1
- package/dist-types/commands/RegisterAccountCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateCampaignCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDecoderManifestCommand.d.ts +2 -1
- package/dist-types/commands/UpdateFleetCommand.d.ts +2 -1
- package/dist-types/commands/UpdateModelManifestCommand.d.ts +2 -1
- package/dist-types/commands/UpdateSignalCatalogCommand.d.ts +2 -1
- package/dist-types/commands/UpdateVehicleCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +600 -600
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/IoTFleetWise.d.ts +10 -0
- package/dist-types/ts3.4/commands/AssociateVehicleFleetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchCreateVehicleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchUpdateVehicleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateCampaignCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateDecoderManifestCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateFleetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateModelManifestCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateSignalCatalogCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateVehicleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteCampaignCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteDecoderManifestCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteFleetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteModelManifestCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteSignalCatalogCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteVehicleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateVehicleFleetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCampaignCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetDecoderManifestCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetEncryptionConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetFleetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetLoggingOptionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetModelManifestCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetRegisterAccountStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSignalCatalogCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetVehicleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetVehicleStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ImportDecoderManifestCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ImportSignalCatalogCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListCampaignsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDecoderManifestNetworkInterfacesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDecoderManifestSignalsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDecoderManifestsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListFleetsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListFleetsForVehicleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListModelManifestNodesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListModelManifestsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSignalCatalogNodesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSignalCatalogsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListVehiclesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListVehiclesInFleetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutEncryptionConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutLoggingOptionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RegisterAccountCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateCampaignCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateDecoderManifestCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateFleetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateModelManifestCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateSignalCatalogCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateVehicleCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +40 -40
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { IoTFleetWiseServiceException as __BaseException } from "./IoTFleetWiseServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>You don't have sufficient permission to perform this action.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
@@ -52,71 +52,71 @@ export declare const NodeDataType: {
|
|
|
52
52
|
*/
|
|
53
53
|
export type NodeDataType = (typeof NodeDataType)[keyof typeof NodeDataType];
|
|
54
54
|
/**
|
|
55
|
-
* @public
|
|
56
55
|
* <p>A signal that represents a vehicle device such as the engine, heater, and door locks.
|
|
57
56
|
* Data from an actuator reports the state of a certain vehicle device.</p>
|
|
58
57
|
* <note>
|
|
59
58
|
* <p> Updating actuator data can change the state of a device. For example, you can
|
|
60
59
|
* turn on or off the heater by updating its actuator data.</p>
|
|
61
60
|
* </note>
|
|
61
|
+
* @public
|
|
62
62
|
*/
|
|
63
63
|
export interface Actuator {
|
|
64
64
|
/**
|
|
65
|
-
* @public
|
|
66
65
|
* <p>The fully qualified name of the actuator. For example, the fully qualified name of an
|
|
67
66
|
* actuator might be <code>Vehicle.Front.Left.Door.Lock</code>.</p>
|
|
67
|
+
* @public
|
|
68
68
|
*/
|
|
69
69
|
fullyQualifiedName: string | undefined;
|
|
70
70
|
/**
|
|
71
|
-
* @public
|
|
72
71
|
* <p>The specified data type of the actuator. </p>
|
|
72
|
+
* @public
|
|
73
73
|
*/
|
|
74
74
|
dataType: NodeDataType | undefined;
|
|
75
75
|
/**
|
|
76
|
-
* @public
|
|
77
76
|
* <p>A brief description of the actuator.</p>
|
|
77
|
+
* @public
|
|
78
78
|
*/
|
|
79
79
|
description?: string;
|
|
80
80
|
/**
|
|
81
|
-
* @public
|
|
82
81
|
* <p>The scientific unit for the actuator.</p>
|
|
82
|
+
* @public
|
|
83
83
|
*/
|
|
84
84
|
unit?: string;
|
|
85
85
|
/**
|
|
86
|
-
* @public
|
|
87
86
|
* <p>A list of possible values an actuator can take.</p>
|
|
87
|
+
* @public
|
|
88
88
|
*/
|
|
89
89
|
allowedValues?: string[];
|
|
90
90
|
/**
|
|
91
|
-
* @public
|
|
92
91
|
* <p>The specified possible minimum value of an actuator.</p>
|
|
92
|
+
* @public
|
|
93
93
|
*/
|
|
94
94
|
min?: number;
|
|
95
95
|
/**
|
|
96
|
-
* @public
|
|
97
96
|
* <p>The specified possible maximum value of an actuator.</p>
|
|
97
|
+
* @public
|
|
98
98
|
*/
|
|
99
99
|
max?: number;
|
|
100
100
|
/**
|
|
101
|
-
* @public
|
|
102
101
|
* @deprecated
|
|
103
102
|
*
|
|
104
103
|
* <p>A specified value for the actuator.</p>
|
|
104
|
+
* @public
|
|
105
105
|
*/
|
|
106
106
|
assignedValue?: string;
|
|
107
107
|
/**
|
|
108
|
-
* @public
|
|
109
108
|
* <p>The deprecation message for the node or the branch that was moved or deleted.</p>
|
|
109
|
+
* @public
|
|
110
110
|
*/
|
|
111
111
|
deprecationMessage?: string;
|
|
112
112
|
/**
|
|
113
|
-
* @public
|
|
114
113
|
* <p>A comment in addition to the description.</p>
|
|
114
|
+
* @public
|
|
115
115
|
*/
|
|
116
116
|
comment?: string;
|
|
117
117
|
/**
|
|
118
|
-
* @public
|
|
119
118
|
* <p>The fully qualified name of the struct node for the actuator if the data type of the actuator is <code>Struct</code> or <code>StructArray</code>. For example, the struct fully qualified name of an actuator might be <code>Vehicle.Door.LockStruct</code>.</p>
|
|
119
|
+
* @public
|
|
120
120
|
*/
|
|
121
121
|
structFullyQualifiedName?: string;
|
|
122
122
|
}
|
|
@@ -125,13 +125,13 @@ export interface Actuator {
|
|
|
125
125
|
*/
|
|
126
126
|
export interface AssociateVehicleFleetRequest {
|
|
127
127
|
/**
|
|
128
|
-
* @public
|
|
129
128
|
* <p> The unique ID of the vehicle to associate with the fleet. </p>
|
|
129
|
+
* @public
|
|
130
130
|
*/
|
|
131
131
|
vehicleName: string | undefined;
|
|
132
132
|
/**
|
|
133
|
-
* @public
|
|
134
133
|
* <p> The ID of a fleet. </p>
|
|
134
|
+
* @public
|
|
135
135
|
*/
|
|
136
136
|
fleetId: string | undefined;
|
|
137
137
|
}
|
|
@@ -141,15 +141,15 @@ export interface AssociateVehicleFleetRequest {
|
|
|
141
141
|
export interface AssociateVehicleFleetResponse {
|
|
142
142
|
}
|
|
143
143
|
/**
|
|
144
|
-
* @public
|
|
145
144
|
* <p>The request couldn't be completed because the server temporarily failed.</p>
|
|
145
|
+
* @public
|
|
146
146
|
*/
|
|
147
147
|
export declare class InternalServerException extends __BaseException {
|
|
148
148
|
readonly name: "InternalServerException";
|
|
149
149
|
readonly $fault: "server";
|
|
150
150
|
/**
|
|
151
|
-
* @public
|
|
152
151
|
* <p>The number of seconds to wait before retrying the command.</p>
|
|
152
|
+
* @public
|
|
153
153
|
*/
|
|
154
154
|
retryAfterSeconds?: number;
|
|
155
155
|
/**
|
|
@@ -158,20 +158,20 @@ export declare class InternalServerException extends __BaseException {
|
|
|
158
158
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
159
159
|
}
|
|
160
160
|
/**
|
|
161
|
-
* @public
|
|
162
161
|
* <p>A service quota was exceeded. </p>
|
|
162
|
+
* @public
|
|
163
163
|
*/
|
|
164
164
|
export declare class LimitExceededException extends __BaseException {
|
|
165
165
|
readonly name: "LimitExceededException";
|
|
166
166
|
readonly $fault: "client";
|
|
167
167
|
/**
|
|
168
|
-
* @public
|
|
169
168
|
* <p>The identifier of the resource that was exceeded.</p>
|
|
169
|
+
* @public
|
|
170
170
|
*/
|
|
171
171
|
resourceId: string | undefined;
|
|
172
172
|
/**
|
|
173
|
-
* @public
|
|
174
173
|
* <p>The type of resource that was exceeded.</p>
|
|
174
|
+
* @public
|
|
175
175
|
*/
|
|
176
176
|
resourceType: string | undefined;
|
|
177
177
|
/**
|
|
@@ -180,20 +180,20 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
180
180
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
181
181
|
}
|
|
182
182
|
/**
|
|
183
|
-
* @public
|
|
184
183
|
* <p>The resource wasn't found.</p>
|
|
184
|
+
* @public
|
|
185
185
|
*/
|
|
186
186
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
187
187
|
readonly name: "ResourceNotFoundException";
|
|
188
188
|
readonly $fault: "client";
|
|
189
189
|
/**
|
|
190
|
-
* @public
|
|
191
190
|
* <p>The identifier of the resource that wasn't found.</p>
|
|
191
|
+
* @public
|
|
192
192
|
*/
|
|
193
193
|
resourceId: string | undefined;
|
|
194
194
|
/**
|
|
195
|
-
* @public
|
|
196
195
|
* <p>The type of resource that wasn't found.</p>
|
|
196
|
+
* @public
|
|
197
197
|
*/
|
|
198
198
|
resourceType: string | undefined;
|
|
199
199
|
/**
|
|
@@ -202,25 +202,25 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
202
202
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
203
203
|
}
|
|
204
204
|
/**
|
|
205
|
-
* @public
|
|
206
205
|
* <p>The request couldn't be completed due to throttling.</p>
|
|
206
|
+
* @public
|
|
207
207
|
*/
|
|
208
208
|
export declare class ThrottlingException extends __BaseException {
|
|
209
209
|
readonly name: "ThrottlingException";
|
|
210
210
|
readonly $fault: "client";
|
|
211
211
|
/**
|
|
212
|
-
* @public
|
|
213
212
|
* <p>The quota identifier of the applied throttling rules for this request.</p>
|
|
213
|
+
* @public
|
|
214
214
|
*/
|
|
215
215
|
quotaCode?: string;
|
|
216
216
|
/**
|
|
217
|
-
* @public
|
|
218
217
|
* <p>The code for the service that couldn't be completed due to throttling.</p>
|
|
218
|
+
* @public
|
|
219
219
|
*/
|
|
220
220
|
serviceCode?: string;
|
|
221
221
|
/**
|
|
222
|
-
* @public
|
|
223
222
|
* <p>The number of seconds to wait before retrying the command.</p>
|
|
223
|
+
* @public
|
|
224
224
|
*/
|
|
225
225
|
retryAfterSeconds?: number;
|
|
226
226
|
/**
|
|
@@ -229,19 +229,19 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
229
229
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
230
230
|
}
|
|
231
231
|
/**
|
|
232
|
-
* @public
|
|
233
232
|
* <p>A validation error due to mismatch between the expected data type, length, or pattern
|
|
234
233
|
* of the parameter and the input.</p>
|
|
234
|
+
* @public
|
|
235
235
|
*/
|
|
236
236
|
export interface ValidationExceptionField {
|
|
237
237
|
/**
|
|
238
|
-
* @public
|
|
239
238
|
* <p>The name of the parameter field with the validation error.</p>
|
|
239
|
+
* @public
|
|
240
240
|
*/
|
|
241
241
|
name: string | undefined;
|
|
242
242
|
/**
|
|
243
|
-
* @public
|
|
244
243
|
* <p>A message about the validation error.</p>
|
|
244
|
+
* @public
|
|
245
245
|
*/
|
|
246
246
|
message: string | undefined;
|
|
247
247
|
}
|
|
@@ -260,20 +260,20 @@ export declare const ValidationExceptionReason: {
|
|
|
260
260
|
*/
|
|
261
261
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
262
262
|
/**
|
|
263
|
-
* @public
|
|
264
263
|
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
264
|
+
* @public
|
|
265
265
|
*/
|
|
266
266
|
export declare class ValidationException extends __BaseException {
|
|
267
267
|
readonly name: "ValidationException";
|
|
268
268
|
readonly $fault: "client";
|
|
269
269
|
/**
|
|
270
|
-
* @public
|
|
271
270
|
* <p>The reason the input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
271
|
+
* @public
|
|
272
272
|
*/
|
|
273
273
|
reason?: ValidationExceptionReason;
|
|
274
274
|
/**
|
|
275
|
-
* @public
|
|
276
275
|
* <p>The list of fields that fail to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
276
|
+
* @public
|
|
277
277
|
*/
|
|
278
278
|
fieldList?: ValidationExceptionField[];
|
|
279
279
|
/**
|
|
@@ -282,67 +282,67 @@ export declare class ValidationException extends __BaseException {
|
|
|
282
282
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
283
283
|
}
|
|
284
284
|
/**
|
|
285
|
-
* @public
|
|
286
285
|
* <p>A signal that represents static information about the vehicle, such as engine type or
|
|
287
286
|
* manufacturing date.</p>
|
|
287
|
+
* @public
|
|
288
288
|
*/
|
|
289
289
|
export interface Attribute {
|
|
290
290
|
/**
|
|
291
|
-
* @public
|
|
292
291
|
* <p>The fully qualified name of the attribute. For example, the fully qualified name of an
|
|
293
292
|
* attribute might be <code>Vehicle.Body.Engine.Type</code>.</p>
|
|
293
|
+
* @public
|
|
294
294
|
*/
|
|
295
295
|
fullyQualifiedName: string | undefined;
|
|
296
296
|
/**
|
|
297
|
-
* @public
|
|
298
297
|
* <p>The specified data type of the attribute. </p>
|
|
298
|
+
* @public
|
|
299
299
|
*/
|
|
300
300
|
dataType: NodeDataType | undefined;
|
|
301
301
|
/**
|
|
302
|
-
* @public
|
|
303
302
|
* <p>A brief description of the attribute.</p>
|
|
303
|
+
* @public
|
|
304
304
|
*/
|
|
305
305
|
description?: string;
|
|
306
306
|
/**
|
|
307
|
-
* @public
|
|
308
307
|
* <p>The scientific unit for the attribute.</p>
|
|
308
|
+
* @public
|
|
309
309
|
*/
|
|
310
310
|
unit?: string;
|
|
311
311
|
/**
|
|
312
|
-
* @public
|
|
313
312
|
* <p>A list of possible values an attribute can be assigned.</p>
|
|
313
|
+
* @public
|
|
314
314
|
*/
|
|
315
315
|
allowedValues?: string[];
|
|
316
316
|
/**
|
|
317
|
-
* @public
|
|
318
317
|
* <p>The specified possible minimum value of the attribute.</p>
|
|
318
|
+
* @public
|
|
319
319
|
*/
|
|
320
320
|
min?: number;
|
|
321
321
|
/**
|
|
322
|
-
* @public
|
|
323
322
|
* <p>The specified possible maximum value of the attribute.</p>
|
|
323
|
+
* @public
|
|
324
324
|
*/
|
|
325
325
|
max?: number;
|
|
326
326
|
/**
|
|
327
|
-
* @public
|
|
328
327
|
* @deprecated
|
|
329
328
|
*
|
|
330
329
|
* <p>A specified value for the attribute.</p>
|
|
330
|
+
* @public
|
|
331
331
|
*/
|
|
332
332
|
assignedValue?: string;
|
|
333
333
|
/**
|
|
334
|
-
* @public
|
|
335
334
|
* <p>The default value of the attribute.</p>
|
|
335
|
+
* @public
|
|
336
336
|
*/
|
|
337
337
|
defaultValue?: string;
|
|
338
338
|
/**
|
|
339
|
-
* @public
|
|
340
339
|
* <p>The deprecation message for the node or the branch that was moved or deleted.</p>
|
|
340
|
+
* @public
|
|
341
341
|
*/
|
|
342
342
|
deprecationMessage?: string;
|
|
343
343
|
/**
|
|
344
|
-
* @public
|
|
345
344
|
* <p>A comment in addition to the description.</p>
|
|
345
|
+
* @public
|
|
346
346
|
*/
|
|
347
347
|
comment?: string;
|
|
348
348
|
}
|
|
@@ -359,58 +359,58 @@ export declare const VehicleAssociationBehavior: {
|
|
|
359
359
|
*/
|
|
360
360
|
export type VehicleAssociationBehavior = (typeof VehicleAssociationBehavior)[keyof typeof VehicleAssociationBehavior];
|
|
361
361
|
/**
|
|
362
|
-
* @public
|
|
363
362
|
* <p>A set of key/value pairs that are used to manage the resource.</p>
|
|
363
|
+
* @public
|
|
364
364
|
*/
|
|
365
365
|
export interface Tag {
|
|
366
366
|
/**
|
|
367
|
-
* @public
|
|
368
367
|
* <p>The tag's key.</p>
|
|
368
|
+
* @public
|
|
369
369
|
*/
|
|
370
370
|
Key: string | undefined;
|
|
371
371
|
/**
|
|
372
|
-
* @public
|
|
373
372
|
* <p>The tag's value.</p>
|
|
373
|
+
* @public
|
|
374
374
|
*/
|
|
375
375
|
Value: string | undefined;
|
|
376
376
|
}
|
|
377
377
|
/**
|
|
378
|
-
* @public
|
|
379
378
|
* <p>Information about the vehicle to create.</p>
|
|
379
|
+
* @public
|
|
380
380
|
*/
|
|
381
381
|
export interface CreateVehicleRequestItem {
|
|
382
382
|
/**
|
|
383
|
-
* @public
|
|
384
383
|
* <p>The unique ID of the vehicle to create.</p>
|
|
384
|
+
* @public
|
|
385
385
|
*/
|
|
386
386
|
vehicleName: string | undefined;
|
|
387
387
|
/**
|
|
388
|
-
* @public
|
|
389
388
|
* <p>The ARN of the vehicle model (model manifest) to create the vehicle from.</p>
|
|
389
|
+
* @public
|
|
390
390
|
*/
|
|
391
391
|
modelManifestArn: string | undefined;
|
|
392
392
|
/**
|
|
393
|
-
* @public
|
|
394
393
|
* <p>The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
|
|
395
394
|
* </p>
|
|
395
|
+
* @public
|
|
396
396
|
*/
|
|
397
397
|
decoderManifestArn: string | undefined;
|
|
398
398
|
/**
|
|
399
|
-
* @public
|
|
400
399
|
* <p>Static information about a vehicle in a key-value pair. For example: <code>"engine
|
|
401
400
|
* Type"</code> : <code>"v6"</code>
|
|
402
401
|
* </p>
|
|
402
|
+
* @public
|
|
403
403
|
*/
|
|
404
404
|
attributes?: Record<string, string>;
|
|
405
405
|
/**
|
|
406
|
-
* @public
|
|
407
406
|
* <p>An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an
|
|
408
407
|
* existing thing as a vehicle.</p>
|
|
408
|
+
* @public
|
|
409
409
|
*/
|
|
410
410
|
associationBehavior?: VehicleAssociationBehavior;
|
|
411
411
|
/**
|
|
412
|
-
* @public
|
|
413
412
|
* <p>Metadata which can be used to manage the vehicle.</p>
|
|
413
|
+
* @public
|
|
414
414
|
*/
|
|
415
415
|
tags?: Tag[];
|
|
416
416
|
}
|
|
@@ -419,51 +419,51 @@ export interface CreateVehicleRequestItem {
|
|
|
419
419
|
*/
|
|
420
420
|
export interface BatchCreateVehicleRequest {
|
|
421
421
|
/**
|
|
422
|
-
* @public
|
|
423
422
|
* <p> A list of information about each vehicle to create. For more information, see the
|
|
424
423
|
* API data type.</p>
|
|
424
|
+
* @public
|
|
425
425
|
*/
|
|
426
426
|
vehicles: CreateVehicleRequestItem[] | undefined;
|
|
427
427
|
}
|
|
428
428
|
/**
|
|
429
|
-
* @public
|
|
430
429
|
* <p>An HTTP error resulting from creating a vehicle.</p>
|
|
430
|
+
* @public
|
|
431
431
|
*/
|
|
432
432
|
export interface CreateVehicleError {
|
|
433
433
|
/**
|
|
434
|
-
* @public
|
|
435
434
|
* <p>The ID of the vehicle with the error.</p>
|
|
435
|
+
* @public
|
|
436
436
|
*/
|
|
437
437
|
vehicleName?: string;
|
|
438
438
|
/**
|
|
439
|
-
* @public
|
|
440
439
|
* <p>An HTTP error code.</p>
|
|
440
|
+
* @public
|
|
441
441
|
*/
|
|
442
442
|
code?: string;
|
|
443
443
|
/**
|
|
444
|
-
* @public
|
|
445
444
|
* <p>A description of the HTTP error.</p>
|
|
445
|
+
* @public
|
|
446
446
|
*/
|
|
447
447
|
message?: string;
|
|
448
448
|
}
|
|
449
449
|
/**
|
|
450
|
-
* @public
|
|
451
450
|
* <p>Information about a created vehicle.</p>
|
|
451
|
+
* @public
|
|
452
452
|
*/
|
|
453
453
|
export interface CreateVehicleResponseItem {
|
|
454
454
|
/**
|
|
455
|
-
* @public
|
|
456
455
|
* <p>The unique ID of the vehicle to create.</p>
|
|
456
|
+
* @public
|
|
457
457
|
*/
|
|
458
458
|
vehicleName?: string;
|
|
459
459
|
/**
|
|
460
|
-
* @public
|
|
461
460
|
* <p>The ARN of the created vehicle.</p>
|
|
461
|
+
* @public
|
|
462
462
|
*/
|
|
463
463
|
arn?: string;
|
|
464
464
|
/**
|
|
465
|
-
* @public
|
|
466
465
|
* <p>The ARN of a created or validated Amazon Web Services IoT thing.</p>
|
|
466
|
+
* @public
|
|
467
467
|
*/
|
|
468
468
|
thingArn?: string;
|
|
469
469
|
}
|
|
@@ -472,15 +472,15 @@ export interface CreateVehicleResponseItem {
|
|
|
472
472
|
*/
|
|
473
473
|
export interface BatchCreateVehicleResponse {
|
|
474
474
|
/**
|
|
475
|
-
* @public
|
|
476
475
|
* <p> A list of information about a batch of created vehicles. For more information, see
|
|
477
476
|
* the API data type.</p>
|
|
477
|
+
* @public
|
|
478
478
|
*/
|
|
479
479
|
vehicles?: CreateVehicleResponseItem[];
|
|
480
480
|
/**
|
|
481
|
-
* @public
|
|
482
481
|
* <p>A list of information about creation errors, or an empty list if there aren't any
|
|
483
482
|
* errors. </p>
|
|
483
|
+
* @public
|
|
484
484
|
*/
|
|
485
485
|
errors?: CreateVehicleError[];
|
|
486
486
|
}
|
|
@@ -497,39 +497,39 @@ export declare const UpdateMode: {
|
|
|
497
497
|
*/
|
|
498
498
|
export type UpdateMode = (typeof UpdateMode)[keyof typeof UpdateMode];
|
|
499
499
|
/**
|
|
500
|
-
* @public
|
|
501
500
|
* <p>Information about the vehicle to update.</p>
|
|
501
|
+
* @public
|
|
502
502
|
*/
|
|
503
503
|
export interface UpdateVehicleRequestItem {
|
|
504
504
|
/**
|
|
505
|
-
* @public
|
|
506
505
|
* <p>The unique ID of the vehicle to update.</p>
|
|
506
|
+
* @public
|
|
507
507
|
*/
|
|
508
508
|
vehicleName: string | undefined;
|
|
509
509
|
/**
|
|
510
|
-
* @public
|
|
511
510
|
* <p>The ARN of the vehicle model (model manifest) associated with the vehicle to update.</p>
|
|
511
|
+
* @public
|
|
512
512
|
*/
|
|
513
513
|
modelManifestArn?: string;
|
|
514
514
|
/**
|
|
515
|
-
* @public
|
|
516
515
|
* <p>The ARN of the signal decoder manifest associated with the vehicle to update.</p>
|
|
516
|
+
* @public
|
|
517
517
|
*/
|
|
518
518
|
decoderManifestArn?: string;
|
|
519
519
|
/**
|
|
520
|
-
* @public
|
|
521
520
|
* <p>Static information about a vehicle in a key-value pair. For example:</p>
|
|
522
521
|
* <p>
|
|
523
522
|
* <code>"engineType"</code> : <code>"1.3 L R2"</code>
|
|
524
523
|
* </p>
|
|
524
|
+
* @public
|
|
525
525
|
*/
|
|
526
526
|
attributes?: Record<string, string>;
|
|
527
527
|
/**
|
|
528
|
-
* @public
|
|
529
528
|
* <p>The method the specified attributes will update the existing attributes on the
|
|
530
529
|
* vehicle. Use<code>Overwite</code> to replace the vehicle attributes with the specified
|
|
531
530
|
* attributes. Or use <code>Merge</code> to combine all attributes.</p>
|
|
532
531
|
* <p>This is required if attributes are present in the input.</p>
|
|
532
|
+
* @public
|
|
533
533
|
*/
|
|
534
534
|
attributeUpdateMode?: UpdateMode;
|
|
535
535
|
}
|
|
@@ -538,46 +538,46 @@ export interface UpdateVehicleRequestItem {
|
|
|
538
538
|
*/
|
|
539
539
|
export interface BatchUpdateVehicleRequest {
|
|
540
540
|
/**
|
|
541
|
-
* @public
|
|
542
541
|
* <p> A list of information about the vehicles to update. For more information, see the
|
|
543
542
|
* API data type.</p>
|
|
543
|
+
* @public
|
|
544
544
|
*/
|
|
545
545
|
vehicles: UpdateVehicleRequestItem[] | undefined;
|
|
546
546
|
}
|
|
547
547
|
/**
|
|
548
|
-
* @public
|
|
549
548
|
* <p>An HTTP error resulting from updating the description for a vehicle.</p>
|
|
549
|
+
* @public
|
|
550
550
|
*/
|
|
551
551
|
export interface UpdateVehicleError {
|
|
552
552
|
/**
|
|
553
|
-
* @public
|
|
554
553
|
* <p>The ID of the vehicle with the error.</p>
|
|
554
|
+
* @public
|
|
555
555
|
*/
|
|
556
556
|
vehicleName?: string;
|
|
557
557
|
/**
|
|
558
|
-
* @public
|
|
559
558
|
* <p>The relevant HTTP error code (400+).</p>
|
|
559
|
+
* @public
|
|
560
560
|
*/
|
|
561
561
|
code?: number;
|
|
562
562
|
/**
|
|
563
|
-
* @public
|
|
564
563
|
* <p>A message associated with the error.</p>
|
|
564
|
+
* @public
|
|
565
565
|
*/
|
|
566
566
|
message?: string;
|
|
567
567
|
}
|
|
568
568
|
/**
|
|
569
|
-
* @public
|
|
570
569
|
* <p>Information about the updated vehicle.</p>
|
|
570
|
+
* @public
|
|
571
571
|
*/
|
|
572
572
|
export interface UpdateVehicleResponseItem {
|
|
573
573
|
/**
|
|
574
|
-
* @public
|
|
575
574
|
* <p>The unique ID of the updated vehicle.</p>
|
|
575
|
+
* @public
|
|
576
576
|
*/
|
|
577
577
|
vehicleName?: string;
|
|
578
578
|
/**
|
|
579
|
-
* @public
|
|
580
579
|
* <p>The Amazon Resource Name (ARN) of the updated vehicle.</p>
|
|
580
|
+
* @public
|
|
581
581
|
*/
|
|
582
582
|
arn?: string;
|
|
583
583
|
}
|
|
@@ -586,63 +586,63 @@ export interface UpdateVehicleResponseItem {
|
|
|
586
586
|
*/
|
|
587
587
|
export interface BatchUpdateVehicleResponse {
|
|
588
588
|
/**
|
|
589
|
-
* @public
|
|
590
589
|
* <p> A list of information about the batch of updated vehicles. </p>
|
|
591
590
|
* <note>
|
|
592
591
|
* <p>This list contains only unique IDs for the vehicles that were updated.</p>
|
|
593
592
|
* </note>
|
|
593
|
+
* @public
|
|
594
594
|
*/
|
|
595
595
|
vehicles?: UpdateVehicleResponseItem[];
|
|
596
596
|
/**
|
|
597
|
-
* @public
|
|
598
597
|
* <p>A list of information about errors returned while updating a batch of vehicles, or, if
|
|
599
598
|
* there aren't any errors, an empty list.</p>
|
|
599
|
+
* @public
|
|
600
600
|
*/
|
|
601
601
|
errors?: UpdateVehicleError[];
|
|
602
602
|
}
|
|
603
603
|
/**
|
|
604
|
-
* @public
|
|
605
604
|
* <p>A group of signals that are defined in a hierarchical structure.</p>
|
|
605
|
+
* @public
|
|
606
606
|
*/
|
|
607
607
|
export interface Branch {
|
|
608
608
|
/**
|
|
609
|
-
* @public
|
|
610
609
|
* <p>The fully qualified name of the branch. For example, the fully qualified name of a
|
|
611
610
|
* branch might be <code>Vehicle.Body.Engine</code>.</p>
|
|
611
|
+
* @public
|
|
612
612
|
*/
|
|
613
613
|
fullyQualifiedName: string | undefined;
|
|
614
614
|
/**
|
|
615
|
-
* @public
|
|
616
615
|
* <p>A brief description of the branch.</p>
|
|
616
|
+
* @public
|
|
617
617
|
*/
|
|
618
618
|
description?: string;
|
|
619
619
|
/**
|
|
620
|
-
* @public
|
|
621
620
|
* <p>The deprecation message for the node or the branch that was moved or deleted.</p>
|
|
621
|
+
* @public
|
|
622
622
|
*/
|
|
623
623
|
deprecationMessage?: string;
|
|
624
624
|
/**
|
|
625
|
-
* @public
|
|
626
625
|
* <p>A comment in addition to the description.</p>
|
|
626
|
+
* @public
|
|
627
627
|
*/
|
|
628
628
|
comment?: string;
|
|
629
629
|
}
|
|
630
630
|
/**
|
|
631
|
-
* @public
|
|
632
631
|
* <p>The request has conflicting operations. This can occur if you're trying to perform
|
|
633
632
|
* more than one operation on the same resource at the same time.</p>
|
|
633
|
+
* @public
|
|
634
634
|
*/
|
|
635
635
|
export declare class ConflictException extends __BaseException {
|
|
636
636
|
readonly name: "ConflictException";
|
|
637
637
|
readonly $fault: "client";
|
|
638
638
|
/**
|
|
639
|
-
* @public
|
|
640
639
|
* <p>The resource on which there are conflicting operations.</p>
|
|
640
|
+
* @public
|
|
641
641
|
*/
|
|
642
642
|
resource: string | undefined;
|
|
643
643
|
/**
|
|
644
|
-
* @public
|
|
645
644
|
* <p>The type of resource on which there are conflicting operations..</p>
|
|
645
|
+
* @public
|
|
646
646
|
*/
|
|
647
647
|
resourceType: string | undefined;
|
|
648
648
|
/**
|
|
@@ -663,58 +663,58 @@ export declare const TriggerMode: {
|
|
|
663
663
|
*/
|
|
664
664
|
export type TriggerMode = (typeof TriggerMode)[keyof typeof TriggerMode];
|
|
665
665
|
/**
|
|
666
|
-
* @public
|
|
667
666
|
* <p>Information about a collection scheme that uses a simple logical expression to
|
|
668
667
|
* recognize what data to collect.</p>
|
|
668
|
+
* @public
|
|
669
669
|
*/
|
|
670
670
|
export interface ConditionBasedCollectionScheme {
|
|
671
671
|
/**
|
|
672
|
-
* @public
|
|
673
672
|
* <p>The logical expression used to recognize what data to collect. For example,
|
|
674
673
|
* <code>$variable.`Vehicle.OutsideAirTemperature` >= 105.0</code>.</p>
|
|
674
|
+
* @public
|
|
675
675
|
*/
|
|
676
676
|
expression: string | undefined;
|
|
677
677
|
/**
|
|
678
|
-
* @public
|
|
679
678
|
* <p>The minimum duration of time between two triggering events to collect data, in
|
|
680
679
|
* milliseconds.</p>
|
|
681
680
|
* <note>
|
|
682
681
|
* <p>If a signal changes often, you might want to collect data at a slower rate.</p>
|
|
683
682
|
* </note>
|
|
683
|
+
* @public
|
|
684
684
|
*/
|
|
685
685
|
minimumTriggerIntervalMs?: number;
|
|
686
686
|
/**
|
|
687
|
-
* @public
|
|
688
687
|
* <p>Whether to collect data for all triggering events (<code>ALWAYS</code>). Specify
|
|
689
688
|
* (<code>RISING_EDGE</code>), or specify only when the condition first evaluates to
|
|
690
689
|
* false. For example, triggering on "AirbagDeployed"; Users aren't interested on
|
|
691
690
|
* triggering when the airbag is already exploded; they only care about the change from not
|
|
692
691
|
* deployed => deployed.</p>
|
|
692
|
+
* @public
|
|
693
693
|
*/
|
|
694
694
|
triggerMode?: TriggerMode;
|
|
695
695
|
/**
|
|
696
|
-
* @public
|
|
697
696
|
* <p>Specifies the version of the conditional expression language.</p>
|
|
697
|
+
* @public
|
|
698
698
|
*/
|
|
699
699
|
conditionLanguageVersion?: number;
|
|
700
700
|
}
|
|
701
701
|
/**
|
|
702
|
-
* @public
|
|
703
702
|
* <p>Information about a collection scheme that uses a time period to decide how often to
|
|
704
703
|
* collect data.</p>
|
|
704
|
+
* @public
|
|
705
705
|
*/
|
|
706
706
|
export interface TimeBasedCollectionScheme {
|
|
707
707
|
/**
|
|
708
|
-
* @public
|
|
709
708
|
* <p>The time period (in milliseconds) to decide how often to collect data. For example,
|
|
710
709
|
* if the time period is <code>60000</code>, the Edge Agent software collects data once
|
|
711
710
|
* every minute.</p>
|
|
711
|
+
* @public
|
|
712
712
|
*/
|
|
713
713
|
periodMs: number | undefined;
|
|
714
714
|
}
|
|
715
715
|
/**
|
|
716
|
-
* @public
|
|
717
716
|
* <p>Specifies what data to collect and how often or when to collect it.</p>
|
|
717
|
+
* @public
|
|
718
718
|
*/
|
|
719
719
|
export type CollectionScheme = CollectionScheme.ConditionBasedCollectionSchemeMember | CollectionScheme.TimeBasedCollectionSchemeMember | CollectionScheme.$UnknownMember;
|
|
720
720
|
/**
|
|
@@ -722,9 +722,9 @@ export type CollectionScheme = CollectionScheme.ConditionBasedCollectionSchemeMe
|
|
|
722
722
|
*/
|
|
723
723
|
export declare namespace CollectionScheme {
|
|
724
724
|
/**
|
|
725
|
-
* @public
|
|
726
725
|
* <p>Information about a collection scheme that uses a time period to decide how often to
|
|
727
726
|
* collect data.</p>
|
|
727
|
+
* @public
|
|
728
728
|
*/
|
|
729
729
|
interface TimeBasedCollectionSchemeMember {
|
|
730
730
|
timeBasedCollectionScheme: TimeBasedCollectionScheme;
|
|
@@ -732,9 +732,9 @@ export declare namespace CollectionScheme {
|
|
|
732
732
|
$unknown?: never;
|
|
733
733
|
}
|
|
734
734
|
/**
|
|
735
|
-
* @public
|
|
736
735
|
* <p>Information about a collection scheme that uses a simple logical expression to
|
|
737
736
|
* recognize what data to collect.</p>
|
|
737
|
+
* @public
|
|
738
738
|
*/
|
|
739
739
|
interface ConditionBasedCollectionSchemeMember {
|
|
740
740
|
timeBasedCollectionScheme?: never;
|
|
@@ -793,17 +793,16 @@ export declare const StorageCompressionFormat: {
|
|
|
793
793
|
*/
|
|
794
794
|
export type StorageCompressionFormat = (typeof StorageCompressionFormat)[keyof typeof StorageCompressionFormat];
|
|
795
795
|
/**
|
|
796
|
-
* @public
|
|
797
796
|
* <p>The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data. Amazon S3 is an object storage service that stores data as objects within buckets. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, configuring, and working with Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
797
|
+
* @public
|
|
798
798
|
*/
|
|
799
799
|
export interface S3Config {
|
|
800
800
|
/**
|
|
801
|
-
* @public
|
|
802
801
|
* <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket.</p>
|
|
802
|
+
* @public
|
|
803
803
|
*/
|
|
804
804
|
bucketArn: string | undefined;
|
|
805
805
|
/**
|
|
806
|
-
* @public
|
|
807
806
|
* <p>Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.</p>
|
|
808
807
|
* <ul>
|
|
809
808
|
* <li>
|
|
@@ -815,40 +814,41 @@ export interface S3Config {
|
|
|
815
814
|
* <p>JSON - Store data in a standard text-based JSON file format.</p>
|
|
816
815
|
* </li>
|
|
817
816
|
* </ul>
|
|
817
|
+
* @public
|
|
818
818
|
*/
|
|
819
819
|
dataFormat?: DataFormat;
|
|
820
820
|
/**
|
|
821
|
-
* @public
|
|
822
821
|
* <p>By default, stored data is compressed as a .gzip file. Compressed files have a reduced
|
|
823
822
|
* file size, which can optimize the cost of data storage.</p>
|
|
823
|
+
* @public
|
|
824
824
|
*/
|
|
825
825
|
storageCompressionFormat?: StorageCompressionFormat;
|
|
826
826
|
/**
|
|
827
|
-
* @public
|
|
828
827
|
* <p>(Optional) Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
829
828
|
* <p>By default, Amazon Web Services IoT FleetWise sets the prefix <code>processed-data/year=YY/month=MM/date=DD/hour=HH/</code> (in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it to this default prefix. For example, if you enter the prefix <code>vehicles</code>, the prefix will be <code>vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/</code>.</p>
|
|
829
|
+
* @public
|
|
830
830
|
*/
|
|
831
831
|
prefix?: string;
|
|
832
832
|
}
|
|
833
833
|
/**
|
|
834
|
-
* @public
|
|
835
834
|
* <p>The Amazon Timestream table where the Amazon Web Services IoT FleetWise campaign sends data. Timestream stores and organizes data to optimize query processing time and to reduce storage costs. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/data-modeling.html">Data modeling</a> in the <i>Amazon Timestream Developer Guide</i>.</p>
|
|
835
|
+
* @public
|
|
836
836
|
*/
|
|
837
837
|
export interface TimestreamConfig {
|
|
838
838
|
/**
|
|
839
|
-
* @public
|
|
840
839
|
* <p>The Amazon Resource Name (ARN) of the Amazon Timestream table.</p>
|
|
840
|
+
* @public
|
|
841
841
|
*/
|
|
842
842
|
timestreamTableArn: string | undefined;
|
|
843
843
|
/**
|
|
844
|
-
* @public
|
|
845
844
|
* <p>The Amazon Resource Name (ARN) of the task execution role that grants Amazon Web Services IoT FleetWise permission to deliver data to the Amazon Timestream table.</p>
|
|
845
|
+
* @public
|
|
846
846
|
*/
|
|
847
847
|
executionRoleArn: string | undefined;
|
|
848
848
|
}
|
|
849
849
|
/**
|
|
850
|
-
* @public
|
|
851
850
|
* <p>The destination where the Amazon Web Services IoT FleetWise campaign sends data. You can send data to be stored in Amazon S3 or Amazon Timestream.</p>
|
|
851
|
+
* @public
|
|
852
852
|
*/
|
|
853
853
|
export type DataDestinationConfig = DataDestinationConfig.S3ConfigMember | DataDestinationConfig.TimestreamConfigMember | DataDestinationConfig.$UnknownMember;
|
|
854
854
|
/**
|
|
@@ -856,8 +856,8 @@ export type DataDestinationConfig = DataDestinationConfig.S3ConfigMember | DataD
|
|
|
856
856
|
*/
|
|
857
857
|
export declare namespace DataDestinationConfig {
|
|
858
858
|
/**
|
|
859
|
-
* @public
|
|
860
859
|
* <p>The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data.</p>
|
|
860
|
+
* @public
|
|
861
861
|
*/
|
|
862
862
|
interface S3ConfigMember {
|
|
863
863
|
s3Config: S3Config;
|
|
@@ -865,8 +865,8 @@ export declare namespace DataDestinationConfig {
|
|
|
865
865
|
$unknown?: never;
|
|
866
866
|
}
|
|
867
867
|
/**
|
|
868
|
-
* @public
|
|
869
868
|
* <p>The Amazon Timestream table where the campaign sends data.</p>
|
|
869
|
+
* @public
|
|
870
870
|
*/
|
|
871
871
|
interface TimestreamConfigMember {
|
|
872
872
|
s3Config?: never;
|
|
@@ -901,27 +901,27 @@ export declare const DiagnosticsMode: {
|
|
|
901
901
|
*/
|
|
902
902
|
export type DiagnosticsMode = (typeof DiagnosticsMode)[keyof typeof DiagnosticsMode];
|
|
903
903
|
/**
|
|
904
|
-
* @public
|
|
905
904
|
* <p>Information about a signal.</p>
|
|
905
|
+
* @public
|
|
906
906
|
*/
|
|
907
907
|
export interface SignalInformation {
|
|
908
908
|
/**
|
|
909
|
-
* @public
|
|
910
909
|
* <p>The name of the signal.</p>
|
|
910
|
+
* @public
|
|
911
911
|
*/
|
|
912
912
|
name: string | undefined;
|
|
913
913
|
/**
|
|
914
|
-
* @public
|
|
915
914
|
* <p>The maximum number of samples to collect.</p>
|
|
915
|
+
* @public
|
|
916
916
|
*/
|
|
917
917
|
maxSampleCount?: number;
|
|
918
918
|
/**
|
|
919
|
-
* @public
|
|
920
919
|
* <p>The minimum duration of time (in milliseconds) between two triggering events to
|
|
921
920
|
* collect data.</p>
|
|
922
921
|
* <note>
|
|
923
922
|
* <p>If a signal changes often, you might want to collect data at a slower rate.</p>
|
|
924
923
|
* </note>
|
|
924
|
+
* @public
|
|
925
925
|
*/
|
|
926
926
|
minimumSamplingIntervalMs?: number;
|
|
927
927
|
}
|
|
@@ -942,115 +942,115 @@ export type SpoolingMode = (typeof SpoolingMode)[keyof typeof SpoolingMode];
|
|
|
942
942
|
*/
|
|
943
943
|
export interface CreateCampaignRequest {
|
|
944
944
|
/**
|
|
945
|
-
* @public
|
|
946
945
|
* <p> The name of the campaign to create. </p>
|
|
946
|
+
* @public
|
|
947
947
|
*/
|
|
948
948
|
name: string | undefined;
|
|
949
949
|
/**
|
|
950
|
-
* @public
|
|
951
950
|
* <p>An optional description of the campaign to help identify its purpose.</p>
|
|
951
|
+
* @public
|
|
952
952
|
*/
|
|
953
953
|
description?: string;
|
|
954
954
|
/**
|
|
955
|
-
* @public
|
|
956
955
|
* <p>(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
|
|
957
956
|
* </p>
|
|
957
|
+
* @public
|
|
958
958
|
*/
|
|
959
959
|
signalCatalogArn: string | undefined;
|
|
960
960
|
/**
|
|
961
|
-
* @public
|
|
962
961
|
* <p> The ARN of the vehicle or fleet to deploy a campaign to. </p>
|
|
962
|
+
* @public
|
|
963
963
|
*/
|
|
964
964
|
targetArn: string | undefined;
|
|
965
965
|
/**
|
|
966
|
-
* @public
|
|
967
966
|
* <p>(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If
|
|
968
967
|
* it's not specified, <code>0</code> is used.</p>
|
|
969
968
|
* <p>Default: <code>0</code>
|
|
970
969
|
* </p>
|
|
970
|
+
* @public
|
|
971
971
|
*/
|
|
972
972
|
startTime?: Date;
|
|
973
973
|
/**
|
|
974
|
-
* @public
|
|
975
974
|
* <p> (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at
|
|
976
975
|
* midnight UTC time). Vehicle data isn't collected after the campaign expires. </p>
|
|
977
976
|
* <p>Default: 253402214400 (December 31, 9999, 00:00:00 UTC)</p>
|
|
977
|
+
* @public
|
|
978
978
|
*/
|
|
979
979
|
expiryTime?: Date;
|
|
980
980
|
/**
|
|
981
|
-
* @public
|
|
982
981
|
* <p> (Optional) How long (in milliseconds) to collect raw data after a triggering event
|
|
983
982
|
* initiates the collection. If it's not specified, <code>0</code> is used.</p>
|
|
984
983
|
* <p>Default: <code>0</code>
|
|
985
984
|
* </p>
|
|
985
|
+
* @public
|
|
986
986
|
*/
|
|
987
987
|
postTriggerCollectionDuration?: number;
|
|
988
988
|
/**
|
|
989
|
-
* @public
|
|
990
989
|
* <p> (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you
|
|
991
990
|
* want to send diagnostic trouble codes, use <code>SEND_ACTIVE_DTCS</code>. If it's not
|
|
992
991
|
* specified, <code>OFF</code> is used.</p>
|
|
993
992
|
* <p>Default: <code>OFF</code>
|
|
994
993
|
* </p>
|
|
994
|
+
* @public
|
|
995
995
|
*/
|
|
996
996
|
diagnosticsMode?: DiagnosticsMode;
|
|
997
997
|
/**
|
|
998
|
-
* @public
|
|
999
998
|
* <p>(Optional) Whether to store collected data after a vehicle lost a connection with the
|
|
1000
999
|
* cloud. After a connection is re-established, the data is automatically forwarded to
|
|
1001
1000
|
* Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the
|
|
1002
1001
|
* cloud, use <code>TO_DISK</code>. If it's not specified, <code>OFF</code> is used.</p>
|
|
1003
1002
|
* <p>Default: <code>OFF</code>
|
|
1004
1003
|
* </p>
|
|
1004
|
+
* @public
|
|
1005
1005
|
*/
|
|
1006
1006
|
spoolingMode?: SpoolingMode;
|
|
1007
1007
|
/**
|
|
1008
|
-
* @public
|
|
1009
1008
|
* <p> (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you
|
|
1010
1009
|
* don't want to compress the signals, use <code>OFF</code>. If it's not specified,
|
|
1011
1010
|
* <code>SNAPPY</code> is used. </p>
|
|
1012
1011
|
* <p>Default: <code>SNAPPY</code>
|
|
1013
1012
|
* </p>
|
|
1013
|
+
* @public
|
|
1014
1014
|
*/
|
|
1015
1015
|
compression?: Compression;
|
|
1016
1016
|
/**
|
|
1017
|
-
* @public
|
|
1018
1017
|
* <p>(Optional) A number indicating the priority of one campaign over another campaign for
|
|
1019
1018
|
* a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles
|
|
1020
1019
|
* before any other campaigns. If it's not specified, <code>0</code> is used. </p>
|
|
1021
1020
|
* <p>Default: <code>0</code>
|
|
1022
1021
|
* </p>
|
|
1022
|
+
* @public
|
|
1023
1023
|
*/
|
|
1024
1024
|
priority?: number;
|
|
1025
1025
|
/**
|
|
1026
|
-
* @public
|
|
1027
1026
|
* <p>(Optional) A list of information about signals to collect. </p>
|
|
1027
|
+
* @public
|
|
1028
1028
|
*/
|
|
1029
1029
|
signalsToCollect?: SignalInformation[];
|
|
1030
1030
|
/**
|
|
1031
|
-
* @public
|
|
1032
1031
|
* <p> The data collection scheme associated with the campaign. You can specify a scheme
|
|
1033
1032
|
* that collects data based on time or an event.</p>
|
|
1033
|
+
* @public
|
|
1034
1034
|
*/
|
|
1035
1035
|
collectionScheme: CollectionScheme | undefined;
|
|
1036
1036
|
/**
|
|
1037
|
-
* @public
|
|
1038
1037
|
* <p> (Optional) A list of vehicle attributes to associate with a campaign. </p>
|
|
1039
1038
|
* <p>Enrich the data with specified vehicle attributes. For example, add <code>make</code> and <code>model</code> to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against <code>make</code> and <code>model</code>.</p>
|
|
1040
1039
|
* <p>Default: An empty array</p>
|
|
1040
|
+
* @public
|
|
1041
1041
|
*/
|
|
1042
1042
|
dataExtraDimensions?: string[];
|
|
1043
1043
|
/**
|
|
1044
|
-
* @public
|
|
1045
1044
|
* <p>Metadata that can be used to manage the campaign.</p>
|
|
1045
|
+
* @public
|
|
1046
1046
|
*/
|
|
1047
1047
|
tags?: Tag[];
|
|
1048
1048
|
/**
|
|
1049
|
-
* @public
|
|
1050
1049
|
* <p>The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.</p>
|
|
1051
1050
|
* <p>Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.</p>
|
|
1052
1051
|
* <p>You can use Amazon Timestream to access and analyze time series data, and Timestream to query
|
|
1053
1052
|
* vehicle data so that you can identify trends and patterns.</p>
|
|
1053
|
+
* @public
|
|
1054
1054
|
*/
|
|
1055
1055
|
dataDestinationConfigs?: DataDestinationConfig[];
|
|
1056
1056
|
}
|
|
@@ -1059,13 +1059,13 @@ export interface CreateCampaignRequest {
|
|
|
1059
1059
|
*/
|
|
1060
1060
|
export interface CreateCampaignResponse {
|
|
1061
1061
|
/**
|
|
1062
|
-
* @public
|
|
1063
1062
|
* <p>The name of the created campaign.</p>
|
|
1063
|
+
* @public
|
|
1064
1064
|
*/
|
|
1065
1065
|
name?: string;
|
|
1066
1066
|
/**
|
|
1067
|
-
* @public
|
|
1068
1067
|
* <p> The ARN of the created campaign. </p>
|
|
1068
|
+
* @public
|
|
1069
1069
|
*/
|
|
1070
1070
|
arn?: string;
|
|
1071
1071
|
}
|
|
@@ -1074,8 +1074,8 @@ export interface CreateCampaignResponse {
|
|
|
1074
1074
|
*/
|
|
1075
1075
|
export interface DeleteCampaignRequest {
|
|
1076
1076
|
/**
|
|
1077
|
-
* @public
|
|
1078
1077
|
* <p> The name of the campaign to delete. </p>
|
|
1078
|
+
* @public
|
|
1079
1079
|
*/
|
|
1080
1080
|
name: string | undefined;
|
|
1081
1081
|
}
|
|
@@ -1084,16 +1084,16 @@ export interface DeleteCampaignRequest {
|
|
|
1084
1084
|
*/
|
|
1085
1085
|
export interface DeleteCampaignResponse {
|
|
1086
1086
|
/**
|
|
1087
|
-
* @public
|
|
1088
1087
|
* <p>The name of the deleted campaign.</p>
|
|
1088
|
+
* @public
|
|
1089
1089
|
*/
|
|
1090
1090
|
name?: string;
|
|
1091
1091
|
/**
|
|
1092
|
-
* @public
|
|
1093
1092
|
* <p> The Amazon Resource Name (ARN) of the deleted campaign.</p>
|
|
1094
1093
|
* <note>
|
|
1095
1094
|
* <p>The ARN isn’t returned if a campaign doesn’t exist.</p>
|
|
1096
1095
|
* </note>
|
|
1096
|
+
* @public
|
|
1097
1097
|
*/
|
|
1098
1098
|
arn?: string;
|
|
1099
1099
|
}
|
|
@@ -1102,8 +1102,8 @@ export interface DeleteCampaignResponse {
|
|
|
1102
1102
|
*/
|
|
1103
1103
|
export interface GetCampaignRequest {
|
|
1104
1104
|
/**
|
|
1105
|
-
* @public
|
|
1106
1105
|
* <p> The name of the campaign to retrieve information about. </p>
|
|
1106
|
+
* @public
|
|
1107
1107
|
*/
|
|
1108
1108
|
name: string | undefined;
|
|
1109
1109
|
}
|
|
@@ -1126,112 +1126,112 @@ export type CampaignStatus = (typeof CampaignStatus)[keyof typeof CampaignStatus
|
|
|
1126
1126
|
*/
|
|
1127
1127
|
export interface GetCampaignResponse {
|
|
1128
1128
|
/**
|
|
1129
|
-
* @public
|
|
1130
1129
|
* <p>The name of the campaign.</p>
|
|
1130
|
+
* @public
|
|
1131
1131
|
*/
|
|
1132
1132
|
name?: string;
|
|
1133
1133
|
/**
|
|
1134
|
-
* @public
|
|
1135
1134
|
* <p> The Amazon Resource Name (ARN) of the campaign. </p>
|
|
1135
|
+
* @public
|
|
1136
1136
|
*/
|
|
1137
1137
|
arn?: string;
|
|
1138
1138
|
/**
|
|
1139
|
-
* @public
|
|
1140
1139
|
* <p>The description of the campaign.</p>
|
|
1140
|
+
* @public
|
|
1141
1141
|
*/
|
|
1142
1142
|
description?: string;
|
|
1143
1143
|
/**
|
|
1144
|
-
* @public
|
|
1145
1144
|
* <p> The ARN of a signal catalog. </p>
|
|
1145
|
+
* @public
|
|
1146
1146
|
*/
|
|
1147
1147
|
signalCatalogArn?: string;
|
|
1148
1148
|
/**
|
|
1149
|
-
* @public
|
|
1150
1149
|
* <p> The ARN of the vehicle or the fleet targeted by the campaign. </p>
|
|
1150
|
+
* @public
|
|
1151
1151
|
*/
|
|
1152
1152
|
targetArn?: string;
|
|
1153
1153
|
/**
|
|
1154
|
-
* @public
|
|
1155
1154
|
* <p>The state of the campaign. The status can be one of: <code>CREATING</code>,
|
|
1156
1155
|
* <code>WAITING_FOR_APPROVAL</code>, <code>RUNNING</code>, and <code>SUSPENDED</code>.
|
|
1157
1156
|
* </p>
|
|
1157
|
+
* @public
|
|
1158
1158
|
*/
|
|
1159
1159
|
status?: CampaignStatus;
|
|
1160
1160
|
/**
|
|
1161
|
-
* @public
|
|
1162
1161
|
* <p> The time, in milliseconds, to deliver a campaign after it was approved.</p>
|
|
1162
|
+
* @public
|
|
1163
1163
|
*/
|
|
1164
1164
|
startTime?: Date;
|
|
1165
1165
|
/**
|
|
1166
|
-
* @public
|
|
1167
1166
|
* <p> The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight
|
|
1168
1167
|
* UTC time). Vehicle data won't be collected after the campaign expires.</p>
|
|
1168
|
+
* @public
|
|
1169
1169
|
*/
|
|
1170
1170
|
expiryTime?: Date;
|
|
1171
1171
|
/**
|
|
1172
|
-
* @public
|
|
1173
1172
|
* <p> How long (in seconds) to collect raw data after a triggering event initiates the
|
|
1174
1173
|
* collection. </p>
|
|
1174
|
+
* @public
|
|
1175
1175
|
*/
|
|
1176
1176
|
postTriggerCollectionDuration?: number;
|
|
1177
1177
|
/**
|
|
1178
|
-
* @public
|
|
1179
1178
|
* <p> Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. </p>
|
|
1179
|
+
* @public
|
|
1180
1180
|
*/
|
|
1181
1181
|
diagnosticsMode?: DiagnosticsMode;
|
|
1182
1182
|
/**
|
|
1183
|
-
* @public
|
|
1184
1183
|
* <p> Whether to store collected data after a vehicle lost a connection with the cloud.
|
|
1185
1184
|
* After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.
|
|
1186
1185
|
* </p>
|
|
1186
|
+
* @public
|
|
1187
1187
|
*/
|
|
1188
1188
|
spoolingMode?: SpoolingMode;
|
|
1189
1189
|
/**
|
|
1190
|
-
* @public
|
|
1191
1190
|
* <p> Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If
|
|
1192
1191
|
* <code>OFF</code> is specified, the signals aren't compressed. If it's not specified,
|
|
1193
1192
|
* <code>SNAPPY</code> is used. </p>
|
|
1193
|
+
* @public
|
|
1194
1194
|
*/
|
|
1195
1195
|
compression?: Compression;
|
|
1196
1196
|
/**
|
|
1197
|
-
* @public
|
|
1198
1197
|
* <p> A number indicating the priority of one campaign over another campaign for a certain
|
|
1199
1198
|
* vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any
|
|
1200
1199
|
* other campaigns.</p>
|
|
1200
|
+
* @public
|
|
1201
1201
|
*/
|
|
1202
1202
|
priority?: number;
|
|
1203
1203
|
/**
|
|
1204
|
-
* @public
|
|
1205
1204
|
* <p> Information about a list of signals to collect data on. </p>
|
|
1205
|
+
* @public
|
|
1206
1206
|
*/
|
|
1207
1207
|
signalsToCollect?: SignalInformation[];
|
|
1208
1208
|
/**
|
|
1209
|
-
* @public
|
|
1210
1209
|
* <p> Information about the data collection scheme associated with the campaign. </p>
|
|
1210
|
+
* @public
|
|
1211
1211
|
*/
|
|
1212
1212
|
collectionScheme?: CollectionScheme;
|
|
1213
1213
|
/**
|
|
1214
|
-
* @public
|
|
1215
1214
|
* <p> A list of vehicle attributes associated with the campaign. </p>
|
|
1215
|
+
* @public
|
|
1216
1216
|
*/
|
|
1217
1217
|
dataExtraDimensions?: string[];
|
|
1218
1218
|
/**
|
|
1219
|
-
* @public
|
|
1220
1219
|
* <p> The time the campaign was created in seconds since epoch (January 1, 1970 at midnight
|
|
1221
1220
|
* UTC time). </p>
|
|
1221
|
+
* @public
|
|
1222
1222
|
*/
|
|
1223
1223
|
creationTime?: Date;
|
|
1224
1224
|
/**
|
|
1225
|
-
* @public
|
|
1226
1225
|
* <p>The last time the campaign was modified.</p>
|
|
1226
|
+
* @public
|
|
1227
1227
|
*/
|
|
1228
1228
|
lastModificationTime?: Date;
|
|
1229
1229
|
/**
|
|
1230
|
-
* @public
|
|
1231
1230
|
* <p>The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.</p>
|
|
1232
1231
|
* <p>Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. </p>
|
|
1233
1232
|
* <p>You can use Amazon Timestream to access and analyze time series data, and Timestream to query
|
|
1234
1233
|
* vehicle data so that you can identify trends and patterns.</p>
|
|
1234
|
+
* @public
|
|
1235
1235
|
*/
|
|
1236
1236
|
dataDestinationConfigs?: DataDestinationConfig[];
|
|
1237
1237
|
}
|
|
@@ -1240,59 +1240,58 @@ export interface GetCampaignResponse {
|
|
|
1240
1240
|
*/
|
|
1241
1241
|
export interface ListCampaignsRequest {
|
|
1242
1242
|
/**
|
|
1243
|
-
* @public
|
|
1244
1243
|
* <p>A pagination token for the next set of results.</p>
|
|
1245
1244
|
* <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
|
|
1245
|
+
* @public
|
|
1246
1246
|
*/
|
|
1247
1247
|
nextToken?: string;
|
|
1248
1248
|
/**
|
|
1249
|
-
* @public
|
|
1250
1249
|
* <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
|
|
1250
|
+
* @public
|
|
1251
1251
|
*/
|
|
1252
1252
|
maxResults?: number;
|
|
1253
1253
|
/**
|
|
1254
|
-
* @public
|
|
1255
1254
|
* <p>Optional parameter to filter the results by the status of each created campaign in
|
|
1256
1255
|
* your account. The status can be one of: <code>CREATING</code>,
|
|
1257
1256
|
* <code>WAITING_FOR_APPROVAL</code>, <code>RUNNING</code>, or
|
|
1258
1257
|
* <code>SUSPENDED</code>.</p>
|
|
1258
|
+
* @public
|
|
1259
1259
|
*/
|
|
1260
1260
|
status?: string;
|
|
1261
1261
|
}
|
|
1262
1262
|
/**
|
|
1263
|
-
* @public
|
|
1264
1263
|
* <p>Information about a campaign. </p>
|
|
1265
1264
|
* <p>You can use the API operation to return this
|
|
1266
1265
|
* information about multiple created campaigns.</p>
|
|
1266
|
+
* @public
|
|
1267
1267
|
*/
|
|
1268
1268
|
export interface CampaignSummary {
|
|
1269
1269
|
/**
|
|
1270
|
-
* @public
|
|
1271
1270
|
* <p>The Amazon Resource Name (ARN) of a campaign.</p>
|
|
1271
|
+
* @public
|
|
1272
1272
|
*/
|
|
1273
1273
|
arn?: string;
|
|
1274
1274
|
/**
|
|
1275
|
-
* @public
|
|
1276
1275
|
* <p>The name of a campaign.</p>
|
|
1276
|
+
* @public
|
|
1277
1277
|
*/
|
|
1278
1278
|
name?: string;
|
|
1279
1279
|
/**
|
|
1280
|
-
* @public
|
|
1281
1280
|
* <p>The description of the campaign.</p>
|
|
1281
|
+
* @public
|
|
1282
1282
|
*/
|
|
1283
1283
|
description?: string;
|
|
1284
1284
|
/**
|
|
1285
|
-
* @public
|
|
1286
1285
|
* <p>The ARN of the signal catalog associated with the campaign.</p>
|
|
1286
|
+
* @public
|
|
1287
1287
|
*/
|
|
1288
1288
|
signalCatalogArn?: string;
|
|
1289
1289
|
/**
|
|
1290
|
-
* @public
|
|
1291
1290
|
* <p>The ARN of a vehicle or fleet to which the campaign is deployed.</p>
|
|
1291
|
+
* @public
|
|
1292
1292
|
*/
|
|
1293
1293
|
targetArn?: string;
|
|
1294
1294
|
/**
|
|
1295
|
-
* @public
|
|
1296
1295
|
* <p>The state of a campaign. The status can be one of the following:</p>
|
|
1297
1296
|
* <ul>
|
|
1298
1297
|
* <li>
|
|
@@ -1317,16 +1316,17 @@ export interface CampaignSummary {
|
|
|
1317
1316
|
* the API operation. </p>
|
|
1318
1317
|
* </li>
|
|
1319
1318
|
* </ul>
|
|
1319
|
+
* @public
|
|
1320
1320
|
*/
|
|
1321
1321
|
status?: CampaignStatus;
|
|
1322
1322
|
/**
|
|
1323
|
-
* @public
|
|
1324
1323
|
* <p>The time the campaign was created.</p>
|
|
1324
|
+
* @public
|
|
1325
1325
|
*/
|
|
1326
1326
|
creationTime: Date | undefined;
|
|
1327
1327
|
/**
|
|
1328
|
-
* @public
|
|
1329
1328
|
* <p>The last time the campaign was modified.</p>
|
|
1329
|
+
* @public
|
|
1330
1330
|
*/
|
|
1331
1331
|
lastModificationTime: Date | undefined;
|
|
1332
1332
|
}
|
|
@@ -1335,13 +1335,13 @@ export interface CampaignSummary {
|
|
|
1335
1335
|
*/
|
|
1336
1336
|
export interface ListCampaignsResponse {
|
|
1337
1337
|
/**
|
|
1338
|
-
* @public
|
|
1339
1338
|
* <p> A summary of information about each campaign. </p>
|
|
1339
|
+
* @public
|
|
1340
1340
|
*/
|
|
1341
1341
|
campaignSummaries?: CampaignSummary[];
|
|
1342
1342
|
/**
|
|
1343
|
-
* @public
|
|
1344
1343
|
* <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
|
|
1344
|
+
* @public
|
|
1345
1345
|
*/
|
|
1346
1346
|
nextToken?: string;
|
|
1347
1347
|
}
|
|
@@ -1364,23 +1364,22 @@ export type UpdateCampaignAction = (typeof UpdateCampaignAction)[keyof typeof Up
|
|
|
1364
1364
|
*/
|
|
1365
1365
|
export interface UpdateCampaignRequest {
|
|
1366
1366
|
/**
|
|
1367
|
-
* @public
|
|
1368
1367
|
* <p> The name of the campaign to update. </p>
|
|
1368
|
+
* @public
|
|
1369
1369
|
*/
|
|
1370
1370
|
name: string | undefined;
|
|
1371
1371
|
/**
|
|
1372
|
-
* @public
|
|
1373
1372
|
* <p>The description of the campaign.</p>
|
|
1373
|
+
* @public
|
|
1374
1374
|
*/
|
|
1375
1375
|
description?: string;
|
|
1376
1376
|
/**
|
|
1377
|
-
* @public
|
|
1378
1377
|
* <p> A list of vehicle attributes to associate with a signal. </p>
|
|
1379
1378
|
* <p>Default: An empty array</p>
|
|
1379
|
+
* @public
|
|
1380
1380
|
*/
|
|
1381
1381
|
dataExtraDimensions?: string[];
|
|
1382
1382
|
/**
|
|
1383
|
-
* @public
|
|
1384
1383
|
* <p> Specifies how to update a campaign. The action can be one of the following:</p>
|
|
1385
1384
|
* <ul>
|
|
1386
1385
|
* <li>
|
|
@@ -1401,6 +1400,7 @@ export interface UpdateCampaignRequest {
|
|
|
1401
1400
|
* <code>UPDATE</code> - To update a campaign. </p>
|
|
1402
1401
|
* </li>
|
|
1403
1402
|
* </ul>
|
|
1403
|
+
* @public
|
|
1404
1404
|
*/
|
|
1405
1405
|
action: UpdateCampaignAction | undefined;
|
|
1406
1406
|
}
|
|
@@ -1409,17 +1409,16 @@ export interface UpdateCampaignRequest {
|
|
|
1409
1409
|
*/
|
|
1410
1410
|
export interface UpdateCampaignResponse {
|
|
1411
1411
|
/**
|
|
1412
|
-
* @public
|
|
1413
1412
|
* <p> The Amazon Resource Name (ARN) of the campaign. </p>
|
|
1413
|
+
* @public
|
|
1414
1414
|
*/
|
|
1415
1415
|
arn?: string;
|
|
1416
1416
|
/**
|
|
1417
|
-
* @public
|
|
1418
1417
|
* <p>The name of the updated campaign.</p>
|
|
1418
|
+
* @public
|
|
1419
1419
|
*/
|
|
1420
1420
|
name?: string;
|
|
1421
1421
|
/**
|
|
1422
|
-
* @public
|
|
1423
1422
|
* <p>The state of a campaign. The status can be one of:</p>
|
|
1424
1423
|
* <ul>
|
|
1425
1424
|
* <li>
|
|
@@ -1444,100 +1443,101 @@ export interface UpdateCampaignResponse {
|
|
|
1444
1443
|
* the API operation. </p>
|
|
1445
1444
|
* </li>
|
|
1446
1445
|
* </ul>
|
|
1446
|
+
* @public
|
|
1447
1447
|
*/
|
|
1448
1448
|
status?: CampaignStatus;
|
|
1449
1449
|
}
|
|
1450
1450
|
/**
|
|
1451
|
-
* @public
|
|
1452
1451
|
* <p>Configurations used to create a decoder manifest.</p>
|
|
1452
|
+
* @public
|
|
1453
1453
|
*/
|
|
1454
1454
|
export interface CanDbcDefinition {
|
|
1455
1455
|
/**
|
|
1456
|
-
* @public
|
|
1457
1456
|
* <p>Contains information about a network interface.</p>
|
|
1457
|
+
* @public
|
|
1458
1458
|
*/
|
|
1459
1459
|
networkInterface: string | undefined;
|
|
1460
1460
|
/**
|
|
1461
|
-
* @public
|
|
1462
1461
|
* <p>A list of DBC files. You can upload only one DBC file for each network interface and
|
|
1463
1462
|
* specify up to five (inclusive) files in the list. The DBC file can be a maximum size of 200 MB.</p>
|
|
1463
|
+
* @public
|
|
1464
1464
|
*/
|
|
1465
1465
|
canDbcFiles: Uint8Array[] | undefined;
|
|
1466
1466
|
/**
|
|
1467
|
-
* @public
|
|
1468
1467
|
* <p>Pairs every signal specified in your vehicle model with a signal decoder.</p>
|
|
1468
|
+
* @public
|
|
1469
1469
|
*/
|
|
1470
1470
|
signalsMap?: Record<string, string>;
|
|
1471
1471
|
}
|
|
1472
1472
|
/**
|
|
1473
|
-
* @public
|
|
1474
1473
|
* <p>A single controller area network (CAN) device interface.</p>
|
|
1474
|
+
* @public
|
|
1475
1475
|
*/
|
|
1476
1476
|
export interface CanInterface {
|
|
1477
1477
|
/**
|
|
1478
|
-
* @public
|
|
1479
1478
|
* <p>The unique name of the interface.</p>
|
|
1479
|
+
* @public
|
|
1480
1480
|
*/
|
|
1481
1481
|
name: string | undefined;
|
|
1482
1482
|
/**
|
|
1483
|
-
* @public
|
|
1484
1483
|
* <p>The name of the communication protocol for the interface.</p>
|
|
1484
|
+
* @public
|
|
1485
1485
|
*/
|
|
1486
1486
|
protocolName?: string;
|
|
1487
1487
|
/**
|
|
1488
|
-
* @public
|
|
1489
1488
|
* <p>The version of the communication protocol for the interface.</p>
|
|
1489
|
+
* @public
|
|
1490
1490
|
*/
|
|
1491
1491
|
protocolVersion?: string;
|
|
1492
1492
|
}
|
|
1493
1493
|
/**
|
|
1494
|
-
* @public
|
|
1495
1494
|
* <p>Information about a single controller area network (CAN) signal and the messages it
|
|
1496
1495
|
* receives and transmits.</p>
|
|
1496
|
+
* @public
|
|
1497
1497
|
*/
|
|
1498
1498
|
export interface CanSignal {
|
|
1499
1499
|
/**
|
|
1500
|
-
* @public
|
|
1501
1500
|
* <p>The ID of the message.</p>
|
|
1501
|
+
* @public
|
|
1502
1502
|
*/
|
|
1503
1503
|
messageId: number | undefined;
|
|
1504
1504
|
/**
|
|
1505
|
-
* @public
|
|
1506
1505
|
* <p>Whether the byte ordering of a CAN message is big-endian.</p>
|
|
1506
|
+
* @public
|
|
1507
1507
|
*/
|
|
1508
1508
|
isBigEndian: boolean | undefined;
|
|
1509
1509
|
/**
|
|
1510
|
-
* @public
|
|
1511
1510
|
* <p>Whether the message data is specified as a signed value.</p>
|
|
1511
|
+
* @public
|
|
1512
1512
|
*/
|
|
1513
1513
|
isSigned: boolean | undefined;
|
|
1514
1514
|
/**
|
|
1515
|
-
* @public
|
|
1516
1515
|
* <p>Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).</p>
|
|
1517
1516
|
* <p>This value might be different from the value in a DBC file. For little endian signals,
|
|
1518
1517
|
* <code>startBit</code> is the same value as in the DBC file. For big endian signals
|
|
1519
1518
|
* in a DBC file, the start bit is the most significant bit (MSB). You will have to
|
|
1520
1519
|
* calculate the LSB instead and pass it as the <code>startBit</code>.</p>
|
|
1520
|
+
* @public
|
|
1521
1521
|
*/
|
|
1522
1522
|
startBit: number | undefined;
|
|
1523
1523
|
/**
|
|
1524
|
-
* @public
|
|
1525
1524
|
* <p>The offset used to calculate the signal value. Combined with factor, the calculation is <code>value = raw_value * factor + offset</code>.</p>
|
|
1525
|
+
* @public
|
|
1526
1526
|
*/
|
|
1527
1527
|
offset: number | undefined;
|
|
1528
1528
|
/**
|
|
1529
|
-
* @public
|
|
1530
1529
|
* <p>A multiplier used to decode the CAN message.</p>
|
|
1530
|
+
* @public
|
|
1531
1531
|
*/
|
|
1532
1532
|
factor: number | undefined;
|
|
1533
1533
|
/**
|
|
1534
|
-
* @public
|
|
1535
1534
|
* <p>How many bytes of data are in the message.</p>
|
|
1535
|
+
* @public
|
|
1536
1536
|
*/
|
|
1537
1537
|
length: number | undefined;
|
|
1538
1538
|
/**
|
|
1539
|
-
* @public
|
|
1540
1539
|
* <p>The name of the signal.</p>
|
|
1540
|
+
* @public
|
|
1541
1541
|
*/
|
|
1542
1542
|
name?: string;
|
|
1543
1543
|
}
|
|
@@ -1554,59 +1554,59 @@ export declare const LogType: {
|
|
|
1554
1554
|
*/
|
|
1555
1555
|
export type LogType = (typeof LogType)[keyof typeof LogType];
|
|
1556
1556
|
/**
|
|
1557
|
-
* @public
|
|
1558
1557
|
* <p>The log delivery option to send data to Amazon CloudWatch Logs.</p>
|
|
1558
|
+
* @public
|
|
1559
1559
|
*/
|
|
1560
1560
|
export interface CloudWatchLogDeliveryOptions {
|
|
1561
1561
|
/**
|
|
1562
|
-
* @public
|
|
1563
1562
|
* <p>The type of log to send data to Amazon CloudWatch Logs.</p>
|
|
1563
|
+
* @public
|
|
1564
1564
|
*/
|
|
1565
1565
|
logType: LogType | undefined;
|
|
1566
1566
|
/**
|
|
1567
|
-
* @public
|
|
1568
1567
|
* <p>The Amazon CloudWatch Logs group the operation sends data to.</p>
|
|
1568
|
+
* @public
|
|
1569
1569
|
*/
|
|
1570
1570
|
logGroupName?: string;
|
|
1571
1571
|
}
|
|
1572
1572
|
/**
|
|
1573
|
-
* @public
|
|
1574
1573
|
* <p>A network interface that specifies the On-board diagnostic (OBD) II network protocol.</p>
|
|
1574
|
+
* @public
|
|
1575
1575
|
*/
|
|
1576
1576
|
export interface ObdInterface {
|
|
1577
1577
|
/**
|
|
1578
|
-
* @public
|
|
1579
1578
|
* <p>The name of the interface.</p>
|
|
1579
|
+
* @public
|
|
1580
1580
|
*/
|
|
1581
1581
|
name: string | undefined;
|
|
1582
1582
|
/**
|
|
1583
|
-
* @public
|
|
1584
1583
|
* <p>The ID of the message requesting vehicle data.</p>
|
|
1584
|
+
* @public
|
|
1585
1585
|
*/
|
|
1586
1586
|
requestMessageId: number | undefined;
|
|
1587
1587
|
/**
|
|
1588
|
-
* @public
|
|
1589
1588
|
* <p>The standard OBD II PID.</p>
|
|
1589
|
+
* @public
|
|
1590
1590
|
*/
|
|
1591
1591
|
obdStandard?: string;
|
|
1592
1592
|
/**
|
|
1593
|
-
* @public
|
|
1594
1593
|
* <p>The maximum number message requests per second.</p>
|
|
1594
|
+
* @public
|
|
1595
1595
|
*/
|
|
1596
1596
|
pidRequestIntervalSeconds?: number;
|
|
1597
1597
|
/**
|
|
1598
|
-
* @public
|
|
1599
1598
|
* <p>The maximum number message requests per diagnostic trouble code per second.</p>
|
|
1599
|
+
* @public
|
|
1600
1600
|
*/
|
|
1601
1601
|
dtcRequestIntervalSeconds?: number;
|
|
1602
1602
|
/**
|
|
1603
|
-
* @public
|
|
1604
1603
|
* <p>Whether to use extended IDs in the message.</p>
|
|
1604
|
+
* @public
|
|
1605
1605
|
*/
|
|
1606
1606
|
useExtendedIds?: boolean;
|
|
1607
1607
|
/**
|
|
1608
|
-
* @public
|
|
1609
1608
|
* <p>Whether the vehicle has a transmission control module (TCM).</p>
|
|
1609
|
+
* @public
|
|
1610
1610
|
*/
|
|
1611
1611
|
hasTransmissionEcu?: boolean;
|
|
1612
1612
|
}
|
|
@@ -1635,58 +1635,58 @@ export declare const VehicleMiddlewareProtocol: {
|
|
|
1635
1635
|
*/
|
|
1636
1636
|
export type VehicleMiddlewareProtocol = (typeof VehicleMiddlewareProtocol)[keyof typeof VehicleMiddlewareProtocol];
|
|
1637
1637
|
/**
|
|
1638
|
-
* @public
|
|
1639
1638
|
* <p>The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include <code>ROS2</code> and <code>SOME/IP</code>.</p>
|
|
1639
|
+
* @public
|
|
1640
1640
|
*/
|
|
1641
1641
|
export interface VehicleMiddleware {
|
|
1642
1642
|
/**
|
|
1643
|
-
* @public
|
|
1644
1643
|
* <p>The name of the vehicle middleware. </p>
|
|
1644
|
+
* @public
|
|
1645
1645
|
*/
|
|
1646
1646
|
name: string | undefined;
|
|
1647
1647
|
/**
|
|
1648
|
-
* @public
|
|
1649
1648
|
* <p>The protocol name of the vehicle middleware. </p>
|
|
1649
|
+
* @public
|
|
1650
1650
|
*/
|
|
1651
1651
|
protocolName: VehicleMiddlewareProtocol | undefined;
|
|
1652
1652
|
}
|
|
1653
1653
|
/**
|
|
1654
|
-
* @public
|
|
1655
1654
|
* <p>Represents a node and its specifications in an in-vehicle communication network. All
|
|
1656
1655
|
* signal decoders must be associated with a network node. </p>
|
|
1657
1656
|
* <p> To return this information about all the network interfaces specified in a decoder
|
|
1658
1657
|
* manifest, use the API
|
|
1659
1658
|
* operation.</p>
|
|
1659
|
+
* @public
|
|
1660
1660
|
*/
|
|
1661
1661
|
export interface NetworkInterface {
|
|
1662
1662
|
/**
|
|
1663
|
-
* @public
|
|
1664
1663
|
* <p>The ID of the network interface.</p>
|
|
1664
|
+
* @public
|
|
1665
1665
|
*/
|
|
1666
1666
|
interfaceId: string | undefined;
|
|
1667
1667
|
/**
|
|
1668
|
-
* @public
|
|
1669
1668
|
* <p>The network protocol for the vehicle. For example, <code>CAN_SIGNAL</code> specifies
|
|
1670
1669
|
* a protocol that defines how data is communicated between electronic control units
|
|
1671
1670
|
* (ECUs). <code>OBD_SIGNAL</code> specifies a protocol that defines how self-diagnostic
|
|
1672
1671
|
* data is communicated between ECUs.</p>
|
|
1672
|
+
* @public
|
|
1673
1673
|
*/
|
|
1674
1674
|
type: NetworkInterfaceType | undefined;
|
|
1675
1675
|
/**
|
|
1676
|
-
* @public
|
|
1677
1676
|
* <p>Information about a network interface specified by the Controller Area Network (CAN)
|
|
1678
1677
|
* protocol.</p>
|
|
1678
|
+
* @public
|
|
1679
1679
|
*/
|
|
1680
1680
|
canInterface?: CanInterface;
|
|
1681
1681
|
/**
|
|
1682
|
-
* @public
|
|
1683
1682
|
* <p>Information about a network interface specified by the On-board diagnostic (OBD) II
|
|
1684
1683
|
* protocol.</p>
|
|
1684
|
+
* @public
|
|
1685
1685
|
*/
|
|
1686
1686
|
obdInterface?: ObdInterface;
|
|
1687
1687
|
/**
|
|
1688
|
-
* @public
|
|
1689
1688
|
* <p>The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include <code>ROS2</code> and <code>SOME/IP</code>.</p>
|
|
1689
|
+
* @public
|
|
1690
1690
|
*/
|
|
1691
1691
|
vehicleMiddleware?: VehicleMiddleware;
|
|
1692
1692
|
}
|
|
@@ -1716,34 +1716,34 @@ export declare const ROS2PrimitiveType: {
|
|
|
1716
1716
|
*/
|
|
1717
1717
|
export type ROS2PrimitiveType = (typeof ROS2PrimitiveType)[keyof typeof ROS2PrimitiveType];
|
|
1718
1718
|
/**
|
|
1719
|
-
* @public
|
|
1720
1719
|
* <p>Represents a ROS 2 compliant primitive type message of the complex data structure.</p>
|
|
1720
|
+
* @public
|
|
1721
1721
|
*/
|
|
1722
1722
|
export interface ROS2PrimitiveMessageDefinition {
|
|
1723
1723
|
/**
|
|
1724
|
-
* @public
|
|
1725
1724
|
* <p>The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.</p>
|
|
1725
|
+
* @public
|
|
1726
1726
|
*/
|
|
1727
1727
|
primitiveType: ROS2PrimitiveType | undefined;
|
|
1728
1728
|
/**
|
|
1729
|
-
* @public
|
|
1730
1729
|
* <p>The offset used to calculate the signal value. Combined with scaling, the calculation is <code>value = raw_value * scaling + offset</code>.</p>
|
|
1730
|
+
* @public
|
|
1731
1731
|
*/
|
|
1732
1732
|
offset?: number;
|
|
1733
1733
|
/**
|
|
1734
|
-
* @public
|
|
1735
1734
|
* <p>A multiplier used to decode the message.</p>
|
|
1735
|
+
* @public
|
|
1736
1736
|
*/
|
|
1737
1737
|
scaling?: number;
|
|
1738
1738
|
/**
|
|
1739
|
-
* @public
|
|
1740
1739
|
* <p>An optional attribute specifying the upper bound for <code>STRING</code> and <code>WSTRING</code>.</p>
|
|
1740
|
+
* @public
|
|
1741
1741
|
*/
|
|
1742
1742
|
upperBound?: number;
|
|
1743
1743
|
}
|
|
1744
1744
|
/**
|
|
1745
|
-
* @public
|
|
1746
1745
|
* <p>Represents a primitive type node of the complex data structure.</p>
|
|
1746
|
+
* @public
|
|
1747
1747
|
*/
|
|
1748
1748
|
export type PrimitiveMessageDefinition = PrimitiveMessageDefinition.Ros2PrimitiveMessageDefinitionMember | PrimitiveMessageDefinition.$UnknownMember;
|
|
1749
1749
|
/**
|
|
@@ -1751,8 +1751,8 @@ export type PrimitiveMessageDefinition = PrimitiveMessageDefinition.Ros2Primitiv
|
|
|
1751
1751
|
*/
|
|
1752
1752
|
export declare namespace PrimitiveMessageDefinition {
|
|
1753
1753
|
/**
|
|
1754
|
-
* @public
|
|
1755
1754
|
* <p>Information about a <code>PrimitiveMessage</code> using a ROS 2 compliant primitive type message of the complex data structure.</p>
|
|
1755
|
+
* @public
|
|
1756
1756
|
*/
|
|
1757
1757
|
interface Ros2PrimitiveMessageDefinitionMember {
|
|
1758
1758
|
ros2PrimitiveMessageDefinition: ROS2PrimitiveMessageDefinition;
|
|
@@ -1785,54 +1785,54 @@ export declare const StructuredMessageListType: {
|
|
|
1785
1785
|
*/
|
|
1786
1786
|
export type StructuredMessageListType = (typeof StructuredMessageListType)[keyof typeof StructuredMessageListType];
|
|
1787
1787
|
/**
|
|
1788
|
-
* @public
|
|
1789
1788
|
* <p>Information about signal messages using the on-board diagnostics (OBD) II protocol in
|
|
1790
1789
|
* a vehicle.</p>
|
|
1790
|
+
* @public
|
|
1791
1791
|
*/
|
|
1792
1792
|
export interface ObdSignal {
|
|
1793
1793
|
/**
|
|
1794
|
-
* @public
|
|
1795
1794
|
* <p>The length of the requested data.</p>
|
|
1795
|
+
* @public
|
|
1796
1796
|
*/
|
|
1797
1797
|
pidResponseLength: number | undefined;
|
|
1798
1798
|
/**
|
|
1799
|
-
* @public
|
|
1800
1799
|
* <p>The mode of operation (diagnostic service) in a message.</p>
|
|
1800
|
+
* @public
|
|
1801
1801
|
*/
|
|
1802
1802
|
serviceMode: number | undefined;
|
|
1803
1803
|
/**
|
|
1804
|
-
* @public
|
|
1805
1804
|
* <p>The diagnostic code used to request data from a vehicle for this signal.</p>
|
|
1805
|
+
* @public
|
|
1806
1806
|
*/
|
|
1807
1807
|
pid: number | undefined;
|
|
1808
1808
|
/**
|
|
1809
|
-
* @public
|
|
1810
1809
|
* <p>A multiplier used to decode the message.</p>
|
|
1810
|
+
* @public
|
|
1811
1811
|
*/
|
|
1812
1812
|
scaling: number | undefined;
|
|
1813
1813
|
/**
|
|
1814
|
-
* @public
|
|
1815
1814
|
* <p>The offset used to calculate the signal value. Combined with scaling, the calculation is <code>value = raw_value * scaling + offset</code>.</p>
|
|
1815
|
+
* @public
|
|
1816
1816
|
*/
|
|
1817
1817
|
offset: number | undefined;
|
|
1818
1818
|
/**
|
|
1819
|
-
* @public
|
|
1820
1819
|
* <p>Indicates the beginning of the message.</p>
|
|
1820
|
+
* @public
|
|
1821
1821
|
*/
|
|
1822
1822
|
startByte: number | undefined;
|
|
1823
1823
|
/**
|
|
1824
|
-
* @public
|
|
1825
1824
|
* <p>The length of a message.</p>
|
|
1825
|
+
* @public
|
|
1826
1826
|
*/
|
|
1827
1827
|
byteLength: number | undefined;
|
|
1828
1828
|
/**
|
|
1829
|
-
* @public
|
|
1830
1829
|
* <p>The number of positions to shift bits in the message.</p>
|
|
1830
|
+
* @public
|
|
1831
1831
|
*/
|
|
1832
1832
|
bitRightShift?: number;
|
|
1833
1833
|
/**
|
|
1834
|
-
* @public
|
|
1835
1834
|
* <p>The number of bits to mask in a message.</p>
|
|
1835
|
+
* @public
|
|
1836
1836
|
*/
|
|
1837
1837
|
bitMaskLength?: number;
|
|
1838
1838
|
}
|
|
@@ -1854,13 +1854,13 @@ export type SignalDecoderType = (typeof SignalDecoderType)[keyof typeof SignalDe
|
|
|
1854
1854
|
*/
|
|
1855
1855
|
export interface CreateDecoderManifestResponse {
|
|
1856
1856
|
/**
|
|
1857
|
-
* @public
|
|
1858
1857
|
* <p> The name of the created decoder manifest. </p>
|
|
1858
|
+
* @public
|
|
1859
1859
|
*/
|
|
1860
1860
|
name: string | undefined;
|
|
1861
1861
|
/**
|
|
1862
|
-
* @public
|
|
1863
1862
|
* <p> The ARN of the created decoder manifest. </p>
|
|
1863
|
+
* @public
|
|
1864
1864
|
*/
|
|
1865
1865
|
arn: string | undefined;
|
|
1866
1866
|
}
|
|
@@ -1882,18 +1882,18 @@ export declare const NetworkInterfaceFailureReason: {
|
|
|
1882
1882
|
*/
|
|
1883
1883
|
export type NetworkInterfaceFailureReason = (typeof NetworkInterfaceFailureReason)[keyof typeof NetworkInterfaceFailureReason];
|
|
1884
1884
|
/**
|
|
1885
|
-
* @public
|
|
1886
1885
|
* <p>A reason a vehicle network interface isn't valid.</p>
|
|
1886
|
+
* @public
|
|
1887
1887
|
*/
|
|
1888
1888
|
export interface InvalidNetworkInterface {
|
|
1889
1889
|
/**
|
|
1890
|
-
* @public
|
|
1891
1890
|
* <p>The ID of the interface that isn't valid.</p>
|
|
1891
|
+
* @public
|
|
1892
1892
|
*/
|
|
1893
1893
|
interfaceId?: string;
|
|
1894
1894
|
/**
|
|
1895
|
-
* @public
|
|
1896
1895
|
* <p>A message about why the interface isn't valid. </p>
|
|
1896
|
+
* @public
|
|
1897
1897
|
*/
|
|
1898
1898
|
reason?: NetworkInterfaceFailureReason;
|
|
1899
1899
|
}
|
|
@@ -1923,41 +1923,41 @@ export declare const SignalDecoderFailureReason: {
|
|
|
1923
1923
|
*/
|
|
1924
1924
|
export type SignalDecoderFailureReason = (typeof SignalDecoderFailureReason)[keyof typeof SignalDecoderFailureReason];
|
|
1925
1925
|
/**
|
|
1926
|
-
* @public
|
|
1927
1926
|
* <p>A reason that a signal decoder isn't valid.</p>
|
|
1927
|
+
* @public
|
|
1928
1928
|
*/
|
|
1929
1929
|
export interface InvalidSignalDecoder {
|
|
1930
1930
|
/**
|
|
1931
|
-
* @public
|
|
1932
1931
|
* <p>The name of a signal decoder that isn't valid.</p>
|
|
1932
|
+
* @public
|
|
1933
1933
|
*/
|
|
1934
1934
|
name?: string;
|
|
1935
1935
|
/**
|
|
1936
|
-
* @public
|
|
1937
1936
|
* <p>A message about why the signal decoder isn't valid.</p>
|
|
1937
|
+
* @public
|
|
1938
1938
|
*/
|
|
1939
1939
|
reason?: SignalDecoderFailureReason;
|
|
1940
1940
|
/**
|
|
1941
|
-
* @public
|
|
1942
1941
|
* <p>The possible cause for the invalid signal decoder.</p>
|
|
1942
|
+
* @public
|
|
1943
1943
|
*/
|
|
1944
1944
|
hint?: string;
|
|
1945
1945
|
}
|
|
1946
1946
|
/**
|
|
1947
|
-
* @public
|
|
1948
1947
|
* <p>The request couldn't be completed because it contains signal decoders with one or more validation errors.</p>
|
|
1948
|
+
* @public
|
|
1949
1949
|
*/
|
|
1950
1950
|
export declare class DecoderManifestValidationException extends __BaseException {
|
|
1951
1951
|
readonly name: "DecoderManifestValidationException";
|
|
1952
1952
|
readonly $fault: "client";
|
|
1953
1953
|
/**
|
|
1954
|
-
* @public
|
|
1955
1954
|
* <p>The request couldn't be completed because of invalid signals in the request.</p>
|
|
1955
|
+
* @public
|
|
1956
1956
|
*/
|
|
1957
1957
|
invalidSignals?: InvalidSignalDecoder[];
|
|
1958
1958
|
/**
|
|
1959
|
-
* @public
|
|
1960
1959
|
* <p>The request couldn't be completed because of invalid network interfaces in the request.</p>
|
|
1960
|
+
* @public
|
|
1961
1961
|
*/
|
|
1962
1962
|
invalidNetworkInterfaces?: InvalidNetworkInterface[];
|
|
1963
1963
|
/**
|
|
@@ -1970,23 +1970,23 @@ export declare class DecoderManifestValidationException extends __BaseException
|
|
|
1970
1970
|
*/
|
|
1971
1971
|
export interface CreateFleetRequest {
|
|
1972
1972
|
/**
|
|
1973
|
-
* @public
|
|
1974
1973
|
* <p> The unique ID of the fleet to create. </p>
|
|
1974
|
+
* @public
|
|
1975
1975
|
*/
|
|
1976
1976
|
fleetId: string | undefined;
|
|
1977
1977
|
/**
|
|
1978
|
-
* @public
|
|
1979
1978
|
* <p> A brief description of the fleet to create. </p>
|
|
1979
|
+
* @public
|
|
1980
1980
|
*/
|
|
1981
1981
|
description?: string;
|
|
1982
1982
|
/**
|
|
1983
|
-
* @public
|
|
1984
1983
|
* <p> The Amazon Resource Name (ARN) of a signal catalog. </p>
|
|
1984
|
+
* @public
|
|
1985
1985
|
*/
|
|
1986
1986
|
signalCatalogArn: string | undefined;
|
|
1987
1987
|
/**
|
|
1988
|
-
* @public
|
|
1989
1988
|
* <p>Metadata that can be used to manage the fleet.</p>
|
|
1989
|
+
* @public
|
|
1990
1990
|
*/
|
|
1991
1991
|
tags?: Tag[];
|
|
1992
1992
|
}
|
|
@@ -1995,13 +1995,13 @@ export interface CreateFleetRequest {
|
|
|
1995
1995
|
*/
|
|
1996
1996
|
export interface CreateFleetResponse {
|
|
1997
1997
|
/**
|
|
1998
|
-
* @public
|
|
1999
1998
|
* <p> The ID of the created fleet. </p>
|
|
1999
|
+
* @public
|
|
2000
2000
|
*/
|
|
2001
2001
|
id: string | undefined;
|
|
2002
2002
|
/**
|
|
2003
|
-
* @public
|
|
2004
2003
|
* <p> The ARN of the created fleet. </p>
|
|
2004
|
+
* @public
|
|
2005
2005
|
*/
|
|
2006
2006
|
arn: string | undefined;
|
|
2007
2007
|
}
|
|
@@ -2010,28 +2010,28 @@ export interface CreateFleetResponse {
|
|
|
2010
2010
|
*/
|
|
2011
2011
|
export interface CreateModelManifestRequest {
|
|
2012
2012
|
/**
|
|
2013
|
-
* @public
|
|
2014
2013
|
* <p> The name of the vehicle model to create.</p>
|
|
2014
|
+
* @public
|
|
2015
2015
|
*/
|
|
2016
2016
|
name: string | undefined;
|
|
2017
2017
|
/**
|
|
2018
|
-
* @public
|
|
2019
2018
|
* <p> A brief description of the vehicle model. </p>
|
|
2019
|
+
* @public
|
|
2020
2020
|
*/
|
|
2021
2021
|
description?: string;
|
|
2022
2022
|
/**
|
|
2023
|
-
* @public
|
|
2024
2023
|
* <p> A list of nodes, which are a general abstraction of signals. </p>
|
|
2024
|
+
* @public
|
|
2025
2025
|
*/
|
|
2026
2026
|
nodes: string[] | undefined;
|
|
2027
2027
|
/**
|
|
2028
|
-
* @public
|
|
2029
2028
|
* <p> The Amazon Resource Name (ARN) of a signal catalog. </p>
|
|
2029
|
+
* @public
|
|
2030
2030
|
*/
|
|
2031
2031
|
signalCatalogArn: string | undefined;
|
|
2032
2032
|
/**
|
|
2033
|
-
* @public
|
|
2034
2033
|
* <p>Metadata that can be used to manage the vehicle model.</p>
|
|
2034
|
+
* @public
|
|
2035
2035
|
*/
|
|
2036
2036
|
tags?: Tag[];
|
|
2037
2037
|
}
|
|
@@ -2040,42 +2040,42 @@ export interface CreateModelManifestRequest {
|
|
|
2040
2040
|
*/
|
|
2041
2041
|
export interface CreateModelManifestResponse {
|
|
2042
2042
|
/**
|
|
2043
|
-
* @public
|
|
2044
2043
|
* <p> The name of the created vehicle model.</p>
|
|
2044
|
+
* @public
|
|
2045
2045
|
*/
|
|
2046
2046
|
name: string | undefined;
|
|
2047
2047
|
/**
|
|
2048
|
-
* @public
|
|
2049
2048
|
* <p> The ARN of the created vehicle model.</p>
|
|
2049
|
+
* @public
|
|
2050
2050
|
*/
|
|
2051
2051
|
arn: string | undefined;
|
|
2052
2052
|
}
|
|
2053
2053
|
/**
|
|
2054
|
-
* @public
|
|
2055
2054
|
* <p>A reason that a signal isn't valid.</p>
|
|
2055
|
+
* @public
|
|
2056
2056
|
*/
|
|
2057
2057
|
export interface InvalidSignal {
|
|
2058
2058
|
/**
|
|
2059
|
-
* @public
|
|
2060
2059
|
* <p>The name of the signal that isn't valid.</p>
|
|
2060
|
+
* @public
|
|
2061
2061
|
*/
|
|
2062
2062
|
name?: string;
|
|
2063
2063
|
/**
|
|
2064
|
-
* @public
|
|
2065
2064
|
* <p>A message about why the signal isn't valid.</p>
|
|
2065
|
+
* @public
|
|
2066
2066
|
*/
|
|
2067
2067
|
reason?: string;
|
|
2068
2068
|
}
|
|
2069
2069
|
/**
|
|
2070
|
-
* @public
|
|
2071
2070
|
* <p>The request couldn't be completed because it contains signals that aren't valid.</p>
|
|
2071
|
+
* @public
|
|
2072
2072
|
*/
|
|
2073
2073
|
export declare class InvalidSignalsException extends __BaseException {
|
|
2074
2074
|
readonly name: "InvalidSignalsException";
|
|
2075
2075
|
readonly $fault: "client";
|
|
2076
2076
|
/**
|
|
2077
|
-
* @public
|
|
2078
2077
|
* <p>The signals which caused the exception.</p>
|
|
2078
|
+
* @public
|
|
2079
2079
|
*/
|
|
2080
2080
|
invalidSignals?: InvalidSignal[];
|
|
2081
2081
|
/**
|
|
@@ -2096,137 +2096,137 @@ export declare const NodeDataEncoding: {
|
|
|
2096
2096
|
*/
|
|
2097
2097
|
export type NodeDataEncoding = (typeof NodeDataEncoding)[keyof typeof NodeDataEncoding];
|
|
2098
2098
|
/**
|
|
2099
|
-
* @public
|
|
2100
2099
|
* <p>Represents a member of the complex data structure. The data type of the property can be either primitive or another <code>struct</code>.</p>
|
|
2100
|
+
* @public
|
|
2101
2101
|
*/
|
|
2102
2102
|
export interface CustomProperty {
|
|
2103
2103
|
/**
|
|
2104
|
-
* @public
|
|
2105
2104
|
* <p>The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be <code>ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS</code>.</p>
|
|
2105
|
+
* @public
|
|
2106
2106
|
*/
|
|
2107
2107
|
fullyQualifiedName: string | undefined;
|
|
2108
2108
|
/**
|
|
2109
|
-
* @public
|
|
2110
2109
|
* <p>The data type for the custom property. </p>
|
|
2110
|
+
* @public
|
|
2111
2111
|
*/
|
|
2112
2112
|
dataType: NodeDataType | undefined;
|
|
2113
2113
|
/**
|
|
2114
|
-
* @public
|
|
2115
2114
|
* <p>Indicates whether the property is binary data.</p>
|
|
2115
|
+
* @public
|
|
2116
2116
|
*/
|
|
2117
2117
|
dataEncoding?: NodeDataEncoding;
|
|
2118
2118
|
/**
|
|
2119
|
-
* @public
|
|
2120
2119
|
* <p>A brief description of the custom property.</p>
|
|
2120
|
+
* @public
|
|
2121
2121
|
*/
|
|
2122
2122
|
description?: string;
|
|
2123
2123
|
/**
|
|
2124
|
-
* @public
|
|
2125
2124
|
* <p>The deprecation message for the node or the branch that was moved or deleted.</p>
|
|
2125
|
+
* @public
|
|
2126
2126
|
*/
|
|
2127
2127
|
deprecationMessage?: string;
|
|
2128
2128
|
/**
|
|
2129
|
-
* @public
|
|
2130
2129
|
* <p>A comment in addition to the description.</p>
|
|
2130
|
+
* @public
|
|
2131
2131
|
*/
|
|
2132
2132
|
comment?: string;
|
|
2133
2133
|
/**
|
|
2134
|
-
* @public
|
|
2135
2134
|
* <p>The fully qualified name of the struct node for the custom property if the data type of the custom property is <code>Struct</code> or <code>StructArray</code>. </p>
|
|
2135
|
+
* @public
|
|
2136
2136
|
*/
|
|
2137
2137
|
structFullyQualifiedName?: string;
|
|
2138
2138
|
}
|
|
2139
2139
|
/**
|
|
2140
|
-
* @public
|
|
2141
2140
|
* <p>An input component that reports the environmental condition of a vehicle.</p>
|
|
2142
2141
|
* <note>
|
|
2143
2142
|
* <p>You can collect data about fluid levels, temperatures, vibrations, or battery
|
|
2144
2143
|
* voltage from sensors.</p>
|
|
2145
2144
|
* </note>
|
|
2145
|
+
* @public
|
|
2146
2146
|
*/
|
|
2147
2147
|
export interface Sensor {
|
|
2148
2148
|
/**
|
|
2149
|
-
* @public
|
|
2150
2149
|
* <p>The fully qualified name of the sensor. For example, the fully qualified name of a
|
|
2151
2150
|
* sensor might be <code>Vehicle.Body.Engine.Battery</code>.</p>
|
|
2151
|
+
* @public
|
|
2152
2152
|
*/
|
|
2153
2153
|
fullyQualifiedName: string | undefined;
|
|
2154
2154
|
/**
|
|
2155
|
-
* @public
|
|
2156
2155
|
* <p>The specified data type of the sensor. </p>
|
|
2156
|
+
* @public
|
|
2157
2157
|
*/
|
|
2158
2158
|
dataType: NodeDataType | undefined;
|
|
2159
2159
|
/**
|
|
2160
|
-
* @public
|
|
2161
2160
|
* <p>A brief description of a sensor.</p>
|
|
2161
|
+
* @public
|
|
2162
2162
|
*/
|
|
2163
2163
|
description?: string;
|
|
2164
2164
|
/**
|
|
2165
|
-
* @public
|
|
2166
2165
|
* <p>The scientific unit of measurement for data collected by the sensor.</p>
|
|
2166
|
+
* @public
|
|
2167
2167
|
*/
|
|
2168
2168
|
unit?: string;
|
|
2169
2169
|
/**
|
|
2170
|
-
* @public
|
|
2171
2170
|
* <p>A list of possible values a sensor can take.</p>
|
|
2171
|
+
* @public
|
|
2172
2172
|
*/
|
|
2173
2173
|
allowedValues?: string[];
|
|
2174
2174
|
/**
|
|
2175
|
-
* @public
|
|
2176
2175
|
* <p>The specified possible minimum value of the sensor.</p>
|
|
2176
|
+
* @public
|
|
2177
2177
|
*/
|
|
2178
2178
|
min?: number;
|
|
2179
2179
|
/**
|
|
2180
|
-
* @public
|
|
2181
2180
|
* <p>The specified possible maximum value of the sensor.</p>
|
|
2181
|
+
* @public
|
|
2182
2182
|
*/
|
|
2183
2183
|
max?: number;
|
|
2184
2184
|
/**
|
|
2185
|
-
* @public
|
|
2186
2185
|
* <p>The deprecation message for the node or the branch that was moved or deleted.</p>
|
|
2186
|
+
* @public
|
|
2187
2187
|
*/
|
|
2188
2188
|
deprecationMessage?: string;
|
|
2189
2189
|
/**
|
|
2190
|
-
* @public
|
|
2191
2190
|
* <p>A comment in addition to the description.</p>
|
|
2191
|
+
* @public
|
|
2192
2192
|
*/
|
|
2193
2193
|
comment?: string;
|
|
2194
2194
|
/**
|
|
2195
|
-
* @public
|
|
2196
2195
|
* <p>The fully qualified name of the struct node for a sensor if the data type of the actuator is <code>Struct</code> or <code>StructArray</code>. For example, the struct fully qualified name of a sensor might be <code>Vehicle.ADAS.CameraStruct</code>.</p>
|
|
2196
|
+
* @public
|
|
2197
2197
|
*/
|
|
2198
2198
|
structFullyQualifiedName?: string;
|
|
2199
2199
|
}
|
|
2200
2200
|
/**
|
|
2201
|
-
* @public
|
|
2202
2201
|
* <p>The custom structure represents a complex or higher-order data structure.</p>
|
|
2202
|
+
* @public
|
|
2203
2203
|
*/
|
|
2204
2204
|
export interface CustomStruct {
|
|
2205
2205
|
/**
|
|
2206
|
-
* @public
|
|
2207
2206
|
* <p>The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be <code>ComplexDataTypes.VehicleDataTypes.SVMCamera</code>.</p>
|
|
2207
|
+
* @public
|
|
2208
2208
|
*/
|
|
2209
2209
|
fullyQualifiedName: string | undefined;
|
|
2210
2210
|
/**
|
|
2211
|
-
* @public
|
|
2212
2211
|
* <p>A brief description of the custom structure.</p>
|
|
2212
|
+
* @public
|
|
2213
2213
|
*/
|
|
2214
2214
|
description?: string;
|
|
2215
2215
|
/**
|
|
2216
|
-
* @public
|
|
2217
2216
|
* <p>The deprecation message for the node or the branch that was moved or deleted.</p>
|
|
2217
|
+
* @public
|
|
2218
2218
|
*/
|
|
2219
2219
|
deprecationMessage?: string;
|
|
2220
2220
|
/**
|
|
2221
|
-
* @public
|
|
2222
2221
|
* <p>A comment in addition to the description.</p>
|
|
2222
|
+
* @public
|
|
2223
2223
|
*/
|
|
2224
2224
|
comment?: string;
|
|
2225
2225
|
}
|
|
2226
2226
|
/**
|
|
2227
|
-
* @public
|
|
2228
2227
|
* <p>A general abstraction of a signal. A node can be specified as an actuator, attribute,
|
|
2229
2228
|
* branch, or sensor.</p>
|
|
2229
|
+
* @public
|
|
2230
2230
|
*/
|
|
2231
2231
|
export type Node = Node.ActuatorMember | Node.AttributeMember | Node.BranchMember | Node.PropertyMember | Node.SensorMember | Node.StructMember | Node.$UnknownMember;
|
|
2232
2232
|
/**
|
|
@@ -2234,11 +2234,11 @@ export type Node = Node.ActuatorMember | Node.AttributeMember | Node.BranchMembe
|
|
|
2234
2234
|
*/
|
|
2235
2235
|
export declare namespace Node {
|
|
2236
2236
|
/**
|
|
2237
|
-
* @public
|
|
2238
2237
|
* <p>Information about a node specified as a branch.</p>
|
|
2239
2238
|
* <note>
|
|
2240
2239
|
* <p>A group of signals that are defined in a hierarchical structure.</p>
|
|
2241
2240
|
* </note>
|
|
2241
|
+
* @public
|
|
2242
2242
|
*/
|
|
2243
2243
|
interface BranchMember {
|
|
2244
2244
|
branch: Branch;
|
|
@@ -2250,12 +2250,12 @@ export declare namespace Node {
|
|
|
2250
2250
|
$unknown?: never;
|
|
2251
2251
|
}
|
|
2252
2252
|
/**
|
|
2253
|
-
* @public
|
|
2254
2253
|
* <p>An input component that reports the environmental condition of a vehicle.</p>
|
|
2255
2254
|
* <note>
|
|
2256
2255
|
* <p>You can collect data about fluid levels, temperatures, vibrations, or battery
|
|
2257
2256
|
* voltage from sensors.</p>
|
|
2258
2257
|
* </note>
|
|
2258
|
+
* @public
|
|
2259
2259
|
*/
|
|
2260
2260
|
interface SensorMember {
|
|
2261
2261
|
branch?: never;
|
|
@@ -2267,11 +2267,11 @@ export declare namespace Node {
|
|
|
2267
2267
|
$unknown?: never;
|
|
2268
2268
|
}
|
|
2269
2269
|
/**
|
|
2270
|
-
* @public
|
|
2271
2270
|
* <p>Information about a node specified as an actuator.</p>
|
|
2272
2271
|
* <note>
|
|
2273
2272
|
* <p>An actuator is a digital representation of a vehicle device.</p>
|
|
2274
2273
|
* </note>
|
|
2274
|
+
* @public
|
|
2275
2275
|
*/
|
|
2276
2276
|
interface ActuatorMember {
|
|
2277
2277
|
branch?: never;
|
|
@@ -2283,11 +2283,11 @@ export declare namespace Node {
|
|
|
2283
2283
|
$unknown?: never;
|
|
2284
2284
|
}
|
|
2285
2285
|
/**
|
|
2286
|
-
* @public
|
|
2287
2286
|
* <p>Information about a node specified as an attribute.</p>
|
|
2288
2287
|
* <note>
|
|
2289
2288
|
* <p>An attribute represents static information about a vehicle.</p>
|
|
2290
2289
|
* </note>
|
|
2290
|
+
* @public
|
|
2291
2291
|
*/
|
|
2292
2292
|
interface AttributeMember {
|
|
2293
2293
|
branch?: never;
|
|
@@ -2299,8 +2299,8 @@ export declare namespace Node {
|
|
|
2299
2299
|
$unknown?: never;
|
|
2300
2300
|
}
|
|
2301
2301
|
/**
|
|
2302
|
-
* @public
|
|
2303
2302
|
* <p>Represents a complex or higher-order data structure.</p>
|
|
2303
|
+
* @public
|
|
2304
2304
|
*/
|
|
2305
2305
|
interface StructMember {
|
|
2306
2306
|
branch?: never;
|
|
@@ -2312,8 +2312,8 @@ export declare namespace Node {
|
|
|
2312
2312
|
$unknown?: never;
|
|
2313
2313
|
}
|
|
2314
2314
|
/**
|
|
2315
|
-
* @public
|
|
2316
2315
|
* <p>Represents a member of the complex data structure. The <code>datatype</code> of the property can be either primitive or another <code>struct</code>.</p>
|
|
2316
|
+
* @public
|
|
2317
2317
|
*/
|
|
2318
2318
|
interface PropertyMember {
|
|
2319
2319
|
branch?: never;
|
|
@@ -2352,24 +2352,24 @@ export declare namespace Node {
|
|
|
2352
2352
|
*/
|
|
2353
2353
|
export interface CreateSignalCatalogRequest {
|
|
2354
2354
|
/**
|
|
2355
|
-
* @public
|
|
2356
2355
|
* <p> The name of the signal catalog to create. </p>
|
|
2356
|
+
* @public
|
|
2357
2357
|
*/
|
|
2358
2358
|
name: string | undefined;
|
|
2359
2359
|
/**
|
|
2360
|
-
* @public
|
|
2361
2360
|
* <p>A brief description of the signal catalog.</p>
|
|
2361
|
+
* @public
|
|
2362
2362
|
*/
|
|
2363
2363
|
description?: string;
|
|
2364
2364
|
/**
|
|
2365
|
-
* @public
|
|
2366
2365
|
* <p> A list of information about nodes, which are a general abstraction of signals. For
|
|
2367
2366
|
* more information, see the API data type.</p>
|
|
2367
|
+
* @public
|
|
2368
2368
|
*/
|
|
2369
2369
|
nodes?: Node[];
|
|
2370
2370
|
/**
|
|
2371
|
-
* @public
|
|
2372
2371
|
* <p>Metadata that can be used to manage the signal catalog.</p>
|
|
2372
|
+
* @public
|
|
2373
2373
|
*/
|
|
2374
2374
|
tags?: Tag[];
|
|
2375
2375
|
}
|
|
@@ -2378,32 +2378,32 @@ export interface CreateSignalCatalogRequest {
|
|
|
2378
2378
|
*/
|
|
2379
2379
|
export interface CreateSignalCatalogResponse {
|
|
2380
2380
|
/**
|
|
2381
|
-
* @public
|
|
2382
2381
|
* <p> The name of the created signal catalog. </p>
|
|
2382
|
+
* @public
|
|
2383
2383
|
*/
|
|
2384
2384
|
name: string | undefined;
|
|
2385
2385
|
/**
|
|
2386
|
-
* @public
|
|
2387
2386
|
* <p> The ARN of the created signal catalog. </p>
|
|
2387
|
+
* @public
|
|
2388
2388
|
*/
|
|
2389
2389
|
arn: string | undefined;
|
|
2390
2390
|
}
|
|
2391
2391
|
/**
|
|
2392
|
-
* @public
|
|
2393
2392
|
* <p>The specified node type doesn't match the expected node type for a node. You can
|
|
2394
2393
|
* specify the node type as branch, sensor, actuator, or attribute.</p>
|
|
2394
|
+
* @public
|
|
2395
2395
|
*/
|
|
2396
2396
|
export declare class InvalidNodeException extends __BaseException {
|
|
2397
2397
|
readonly name: "InvalidNodeException";
|
|
2398
2398
|
readonly $fault: "client";
|
|
2399
2399
|
/**
|
|
2400
|
-
* @public
|
|
2401
2400
|
* <p>The specified node type isn't valid.</p>
|
|
2401
|
+
* @public
|
|
2402
2402
|
*/
|
|
2403
2403
|
invalidNodes?: Node[];
|
|
2404
2404
|
/**
|
|
2405
|
-
* @public
|
|
2406
2405
|
* <p>The reason the node validation failed.</p>
|
|
2406
|
+
* @public
|
|
2407
2407
|
*/
|
|
2408
2408
|
reason?: string;
|
|
2409
2409
|
/**
|
|
@@ -2416,39 +2416,39 @@ export declare class InvalidNodeException extends __BaseException {
|
|
|
2416
2416
|
*/
|
|
2417
2417
|
export interface CreateVehicleRequest {
|
|
2418
2418
|
/**
|
|
2419
|
-
* @public
|
|
2420
2419
|
* <p> The unique ID of the vehicle to create. </p>
|
|
2420
|
+
* @public
|
|
2421
2421
|
*/
|
|
2422
2422
|
vehicleName: string | undefined;
|
|
2423
2423
|
/**
|
|
2424
|
-
* @public
|
|
2425
2424
|
* <p> The Amazon Resource Name ARN of a vehicle model. </p>
|
|
2425
|
+
* @public
|
|
2426
2426
|
*/
|
|
2427
2427
|
modelManifestArn: string | undefined;
|
|
2428
2428
|
/**
|
|
2429
|
-
* @public
|
|
2430
2429
|
* <p> The ARN of a decoder manifest. </p>
|
|
2430
|
+
* @public
|
|
2431
2431
|
*/
|
|
2432
2432
|
decoderManifestArn: string | undefined;
|
|
2433
2433
|
/**
|
|
2434
|
-
* @public
|
|
2435
2434
|
* <p>Static information about a vehicle in a key-value pair. For example:
|
|
2436
2435
|
* <code>"engineType"</code> : <code>"1.3 L R2"</code>
|
|
2437
2436
|
* </p>
|
|
2438
2437
|
* <p>A campaign must include the keys (attribute names) in <code>dataExtraDimensions</code> for them to display in Amazon Timestream.</p>
|
|
2438
|
+
* @public
|
|
2439
2439
|
*/
|
|
2440
2440
|
attributes?: Record<string, string>;
|
|
2441
2441
|
/**
|
|
2442
|
-
* @public
|
|
2443
2442
|
* <p> An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an
|
|
2444
2443
|
* existing Amazon Web Services IoT thing as a vehicle. </p>
|
|
2445
2444
|
* <p>Default: <code/>
|
|
2446
2445
|
* </p>
|
|
2446
|
+
* @public
|
|
2447
2447
|
*/
|
|
2448
2448
|
associationBehavior?: VehicleAssociationBehavior;
|
|
2449
2449
|
/**
|
|
2450
|
-
* @public
|
|
2451
2450
|
* <p>Metadata that can be used to manage the vehicle.</p>
|
|
2451
|
+
* @public
|
|
2452
2452
|
*/
|
|
2453
2453
|
tags?: Tag[];
|
|
2454
2454
|
}
|
|
@@ -2457,18 +2457,18 @@ export interface CreateVehicleRequest {
|
|
|
2457
2457
|
*/
|
|
2458
2458
|
export interface CreateVehicleResponse {
|
|
2459
2459
|
/**
|
|
2460
|
-
* @public
|
|
2461
2460
|
* <p>The unique ID of the created vehicle.</p>
|
|
2461
|
+
* @public
|
|
2462
2462
|
*/
|
|
2463
2463
|
vehicleName?: string;
|
|
2464
2464
|
/**
|
|
2465
|
-
* @public
|
|
2466
2465
|
* <p> The ARN of the created vehicle. </p>
|
|
2466
|
+
* @public
|
|
2467
2467
|
*/
|
|
2468
2468
|
arn?: string;
|
|
2469
2469
|
/**
|
|
2470
|
-
* @public
|
|
2471
2470
|
* <p> The ARN of a created or validated Amazon Web Services IoT thing. </p>
|
|
2471
|
+
* @public
|
|
2472
2472
|
*/
|
|
2473
2473
|
thingArn?: string;
|
|
2474
2474
|
}
|
|
@@ -2477,8 +2477,8 @@ export interface CreateVehicleResponse {
|
|
|
2477
2477
|
*/
|
|
2478
2478
|
export interface DeleteDecoderManifestRequest {
|
|
2479
2479
|
/**
|
|
2480
|
-
* @public
|
|
2481
2480
|
* <p> The name of the decoder manifest to delete. </p>
|
|
2481
|
+
* @public
|
|
2482
2482
|
*/
|
|
2483
2483
|
name: string | undefined;
|
|
2484
2484
|
}
|
|
@@ -2487,13 +2487,13 @@ export interface DeleteDecoderManifestRequest {
|
|
|
2487
2487
|
*/
|
|
2488
2488
|
export interface DeleteDecoderManifestResponse {
|
|
2489
2489
|
/**
|
|
2490
|
-
* @public
|
|
2491
2490
|
* <p>The name of the deleted decoder manifest.</p>
|
|
2491
|
+
* @public
|
|
2492
2492
|
*/
|
|
2493
2493
|
name: string | undefined;
|
|
2494
2494
|
/**
|
|
2495
|
-
* @public
|
|
2496
2495
|
* <p>The Amazon Resource Name (ARN) of the deleted decoder manifest.</p>
|
|
2496
|
+
* @public
|
|
2497
2497
|
*/
|
|
2498
2498
|
arn: string | undefined;
|
|
2499
2499
|
}
|
|
@@ -2502,8 +2502,8 @@ export interface DeleteDecoderManifestResponse {
|
|
|
2502
2502
|
*/
|
|
2503
2503
|
export interface GetDecoderManifestRequest {
|
|
2504
2504
|
/**
|
|
2505
|
-
* @public
|
|
2506
2505
|
* <p> The name of the decoder manifest to retrieve information about. </p>
|
|
2506
|
+
* @public
|
|
2507
2507
|
*/
|
|
2508
2508
|
name: string | undefined;
|
|
2509
2509
|
}
|
|
@@ -2526,52 +2526,52 @@ export type ManifestStatus = (typeof ManifestStatus)[keyof typeof ManifestStatus
|
|
|
2526
2526
|
*/
|
|
2527
2527
|
export interface GetDecoderManifestResponse {
|
|
2528
2528
|
/**
|
|
2529
|
-
* @public
|
|
2530
2529
|
* <p> The name of the decoder manifest. </p>
|
|
2530
|
+
* @public
|
|
2531
2531
|
*/
|
|
2532
2532
|
name: string | undefined;
|
|
2533
2533
|
/**
|
|
2534
|
-
* @public
|
|
2535
2534
|
* <p> The Amazon Resource Name (ARN) of the decoder manifest. </p>
|
|
2535
|
+
* @public
|
|
2536
2536
|
*/
|
|
2537
2537
|
arn: string | undefined;
|
|
2538
2538
|
/**
|
|
2539
|
-
* @public
|
|
2540
2539
|
* <p> A brief description of the decoder manifest.</p>
|
|
2540
|
+
* @public
|
|
2541
2541
|
*/
|
|
2542
2542
|
description?: string;
|
|
2543
2543
|
/**
|
|
2544
|
-
* @public
|
|
2545
2544
|
* <p> The ARN of a vehicle model (model manifest) associated with the decoder
|
|
2546
2545
|
* manifest.</p>
|
|
2546
|
+
* @public
|
|
2547
2547
|
*/
|
|
2548
2548
|
modelManifestArn?: string;
|
|
2549
2549
|
/**
|
|
2550
|
-
* @public
|
|
2551
2550
|
* <p> The state of the decoder manifest. If the status is <code>ACTIVE</code>, the decoder
|
|
2552
2551
|
* manifest can't be edited. If the status is marked <code>DRAFT</code>, you can edit the
|
|
2553
2552
|
* decoder manifest.</p>
|
|
2553
|
+
* @public
|
|
2554
2554
|
*/
|
|
2555
2555
|
status?: ManifestStatus;
|
|
2556
2556
|
/**
|
|
2557
|
-
* @public
|
|
2558
2557
|
* <p> The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time). </p>
|
|
2558
|
+
* @public
|
|
2559
2559
|
*/
|
|
2560
2560
|
creationTime: Date | undefined;
|
|
2561
2561
|
/**
|
|
2562
|
-
* @public
|
|
2563
2562
|
* <p> The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). </p>
|
|
2563
|
+
* @public
|
|
2564
2564
|
*/
|
|
2565
2565
|
lastModificationTime: Date | undefined;
|
|
2566
2566
|
/**
|
|
2567
|
-
* @public
|
|
2568
2567
|
* <p>The detailed message for the decoder manifest. When a decoder manifest is in an <code>INVALID</code> status, the message contains detailed reason and help information.</p>
|
|
2568
|
+
* @public
|
|
2569
2569
|
*/
|
|
2570
2570
|
message?: string;
|
|
2571
2571
|
}
|
|
2572
2572
|
/**
|
|
2573
|
-
* @public
|
|
2574
2573
|
* <p>Specifications for defining a vehicle network.</p>
|
|
2574
|
+
* @public
|
|
2575
2575
|
*/
|
|
2576
2576
|
export type NetworkFileDefinition = NetworkFileDefinition.CanDbcMember | NetworkFileDefinition.$UnknownMember;
|
|
2577
2577
|
/**
|
|
@@ -2579,9 +2579,9 @@ export type NetworkFileDefinition = NetworkFileDefinition.CanDbcMember | Network
|
|
|
2579
2579
|
*/
|
|
2580
2580
|
export declare namespace NetworkFileDefinition {
|
|
2581
2581
|
/**
|
|
2582
|
-
* @public
|
|
2583
2582
|
* <p>Information, including CAN DBC files, about the configurations used to create a
|
|
2584
2583
|
* decoder manifest.</p>
|
|
2584
|
+
* @public
|
|
2585
2585
|
*/
|
|
2586
2586
|
interface CanDbcMember {
|
|
2587
2587
|
canDbc: CanDbcDefinition;
|
|
@@ -2605,13 +2605,13 @@ export declare namespace NetworkFileDefinition {
|
|
|
2605
2605
|
*/
|
|
2606
2606
|
export interface ImportDecoderManifestRequest {
|
|
2607
2607
|
/**
|
|
2608
|
-
* @public
|
|
2609
2608
|
* <p> The name of the decoder manifest to import. </p>
|
|
2609
|
+
* @public
|
|
2610
2610
|
*/
|
|
2611
2611
|
name: string | undefined;
|
|
2612
2612
|
/**
|
|
2613
|
-
* @public
|
|
2614
2613
|
* <p> The file to load into an Amazon Web Services account. </p>
|
|
2614
|
+
* @public
|
|
2615
2615
|
*/
|
|
2616
2616
|
networkFileDefinitions: NetworkFileDefinition[] | undefined;
|
|
2617
2617
|
}
|
|
@@ -2620,13 +2620,13 @@ export interface ImportDecoderManifestRequest {
|
|
|
2620
2620
|
*/
|
|
2621
2621
|
export interface ImportDecoderManifestResponse {
|
|
2622
2622
|
/**
|
|
2623
|
-
* @public
|
|
2624
2623
|
* <p> The name of the imported decoder manifest. </p>
|
|
2624
|
+
* @public
|
|
2625
2625
|
*/
|
|
2626
2626
|
name: string | undefined;
|
|
2627
2627
|
/**
|
|
2628
|
-
* @public
|
|
2629
2628
|
* <p> The Amazon Resource Name (ARN) of the decoder manifest that was imported. </p>
|
|
2629
|
+
* @public
|
|
2630
2630
|
*/
|
|
2631
2631
|
arn: string | undefined;
|
|
2632
2632
|
}
|
|
@@ -2635,19 +2635,19 @@ export interface ImportDecoderManifestResponse {
|
|
|
2635
2635
|
*/
|
|
2636
2636
|
export interface ListDecoderManifestNetworkInterfacesRequest {
|
|
2637
2637
|
/**
|
|
2638
|
-
* @public
|
|
2639
2638
|
* <p> The name of the decoder manifest to list information about. </p>
|
|
2639
|
+
* @public
|
|
2640
2640
|
*/
|
|
2641
2641
|
name: string | undefined;
|
|
2642
2642
|
/**
|
|
2643
|
-
* @public
|
|
2644
2643
|
* <p>A pagination token for the next set of results.</p>
|
|
2645
2644
|
* <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
|
|
2645
|
+
* @public
|
|
2646
2646
|
*/
|
|
2647
2647
|
nextToken?: string;
|
|
2648
2648
|
/**
|
|
2649
|
-
* @public
|
|
2650
2649
|
* <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
|
|
2650
|
+
* @public
|
|
2651
2651
|
*/
|
|
2652
2652
|
maxResults?: number;
|
|
2653
2653
|
}
|
|
@@ -2656,13 +2656,13 @@ export interface ListDecoderManifestNetworkInterfacesRequest {
|
|
|
2656
2656
|
*/
|
|
2657
2657
|
export interface ListDecoderManifestNetworkInterfacesResponse {
|
|
2658
2658
|
/**
|
|
2659
|
-
* @public
|
|
2660
2659
|
* <p> A list of information about network interfaces. </p>
|
|
2660
|
+
* @public
|
|
2661
2661
|
*/
|
|
2662
2662
|
networkInterfaces?: NetworkInterface[];
|
|
2663
2663
|
/**
|
|
2664
|
-
* @public
|
|
2665
2664
|
* <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
|
|
2665
|
+
* @public
|
|
2666
2666
|
*/
|
|
2667
2667
|
nextToken?: string;
|
|
2668
2668
|
}
|
|
@@ -2671,73 +2671,73 @@ export interface ListDecoderManifestNetworkInterfacesResponse {
|
|
|
2671
2671
|
*/
|
|
2672
2672
|
export interface ListDecoderManifestsRequest {
|
|
2673
2673
|
/**
|
|
2674
|
-
* @public
|
|
2675
2674
|
* <p> The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with
|
|
2676
2675
|
* the decoder manifest. </p>
|
|
2676
|
+
* @public
|
|
2677
2677
|
*/
|
|
2678
2678
|
modelManifestArn?: string;
|
|
2679
2679
|
/**
|
|
2680
|
-
* @public
|
|
2681
2680
|
* <p>A pagination token for the next set of results.</p>
|
|
2682
2681
|
* <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
|
|
2682
|
+
* @public
|
|
2683
2683
|
*/
|
|
2684
2684
|
nextToken?: string;
|
|
2685
2685
|
/**
|
|
2686
|
-
* @public
|
|
2687
2686
|
* <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
|
|
2687
|
+
* @public
|
|
2688
2688
|
*/
|
|
2689
2689
|
maxResults?: number;
|
|
2690
2690
|
}
|
|
2691
2691
|
/**
|
|
2692
|
-
* @public
|
|
2693
2692
|
* <p>Information about a created decoder manifest. You can use the API operation to return this information about
|
|
2694
2693
|
* multiple decoder manifests.</p>
|
|
2694
|
+
* @public
|
|
2695
2695
|
*/
|
|
2696
2696
|
export interface DecoderManifestSummary {
|
|
2697
2697
|
/**
|
|
2698
|
-
* @public
|
|
2699
2698
|
* <p>The name of the decoder manifest.</p>
|
|
2699
|
+
* @public
|
|
2700
2700
|
*/
|
|
2701
2701
|
name?: string;
|
|
2702
2702
|
/**
|
|
2703
|
-
* @public
|
|
2704
2703
|
* <p>The ARN of a vehicle model (model manifest) associated with the decoder manifest.
|
|
2705
2704
|
* </p>
|
|
2705
|
+
* @public
|
|
2706
2706
|
*/
|
|
2707
2707
|
arn?: string;
|
|
2708
2708
|
/**
|
|
2709
|
-
* @public
|
|
2710
2709
|
* <p>The ARN of a vehicle model (model manifest) associated with the decoder
|
|
2711
2710
|
* manifest.</p>
|
|
2711
|
+
* @public
|
|
2712
2712
|
*/
|
|
2713
2713
|
modelManifestArn?: string;
|
|
2714
2714
|
/**
|
|
2715
|
-
* @public
|
|
2716
2715
|
* <p>A brief description of the decoder manifest.</p>
|
|
2716
|
+
* @public
|
|
2717
2717
|
*/
|
|
2718
2718
|
description?: string;
|
|
2719
2719
|
/**
|
|
2720
|
-
* @public
|
|
2721
2720
|
* <p>The state of the decoder manifest. If the status is <code>ACTIVE</code>, the decoder
|
|
2722
2721
|
* manifest can't be edited. If the status is marked <code>DRAFT</code>, you can edit the
|
|
2723
2722
|
* decoder manifest.</p>
|
|
2723
|
+
* @public
|
|
2724
2724
|
*/
|
|
2725
2725
|
status?: ManifestStatus;
|
|
2726
2726
|
/**
|
|
2727
|
-
* @public
|
|
2728
2727
|
* <p>The time the decoder manifest was created in seconds since epoch (January 1, 1970 at
|
|
2729
2728
|
* midnight UTC time).</p>
|
|
2729
|
+
* @public
|
|
2730
2730
|
*/
|
|
2731
2731
|
creationTime: Date | undefined;
|
|
2732
2732
|
/**
|
|
2733
|
-
* @public
|
|
2734
2733
|
* <p>The time the decoder manifest was last updated in seconds since epoch (January 1,
|
|
2735
2734
|
* 1970 at midnight UTC time).</p>
|
|
2735
|
+
* @public
|
|
2736
2736
|
*/
|
|
2737
2737
|
lastModificationTime: Date | undefined;
|
|
2738
2738
|
/**
|
|
2739
|
-
* @public
|
|
2740
2739
|
* <p>The detailed message for the decoder manifest. When a decoder manifest is in an <code>INVALID</code> status, the message contains detailed reason and help information.</p>
|
|
2740
|
+
* @public
|
|
2741
2741
|
*/
|
|
2742
2742
|
message?: string;
|
|
2743
2743
|
}
|
|
@@ -2746,13 +2746,13 @@ export interface DecoderManifestSummary {
|
|
|
2746
2746
|
*/
|
|
2747
2747
|
export interface ListDecoderManifestsResponse {
|
|
2748
2748
|
/**
|
|
2749
|
-
* @public
|
|
2750
2749
|
* <p> A list of information about each decoder manifest. </p>
|
|
2750
|
+
* @public
|
|
2751
2751
|
*/
|
|
2752
2752
|
summaries?: DecoderManifestSummary[];
|
|
2753
2753
|
/**
|
|
2754
|
-
* @public
|
|
2755
2754
|
* <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
|
|
2755
|
+
* @public
|
|
2756
2756
|
*/
|
|
2757
2757
|
nextToken?: string;
|
|
2758
2758
|
}
|
|
@@ -2761,19 +2761,19 @@ export interface ListDecoderManifestsResponse {
|
|
|
2761
2761
|
*/
|
|
2762
2762
|
export interface ListDecoderManifestSignalsRequest {
|
|
2763
2763
|
/**
|
|
2764
|
-
* @public
|
|
2765
2764
|
* <p> The name of the decoder manifest to list information about. </p>
|
|
2765
|
+
* @public
|
|
2766
2766
|
*/
|
|
2767
2767
|
name: string | undefined;
|
|
2768
2768
|
/**
|
|
2769
|
-
* @public
|
|
2770
2769
|
* <p>A pagination token for the next set of results.</p>
|
|
2771
2770
|
* <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
|
|
2771
|
+
* @public
|
|
2772
2772
|
*/
|
|
2773
2773
|
nextToken?: string;
|
|
2774
2774
|
/**
|
|
2775
|
-
* @public
|
|
2776
2775
|
* <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
|
|
2776
|
+
* @public
|
|
2777
2777
|
*/
|
|
2778
2778
|
maxResults?: number;
|
|
2779
2779
|
}
|
|
@@ -2782,13 +2782,13 @@ export interface ListDecoderManifestSignalsRequest {
|
|
|
2782
2782
|
*/
|
|
2783
2783
|
export interface UpdateDecoderManifestResponse {
|
|
2784
2784
|
/**
|
|
2785
|
-
* @public
|
|
2786
2785
|
* <p> The name of the updated decoder manifest. </p>
|
|
2786
|
+
* @public
|
|
2787
2787
|
*/
|
|
2788
2788
|
name: string | undefined;
|
|
2789
2789
|
/**
|
|
2790
|
-
* @public
|
|
2791
2790
|
* <p> The Amazon Resource Name (ARN) of the updated decoder manifest. </p>
|
|
2791
|
+
* @public
|
|
2792
2792
|
*/
|
|
2793
2793
|
arn: string | undefined;
|
|
2794
2794
|
}
|
|
@@ -2797,8 +2797,8 @@ export interface UpdateDecoderManifestResponse {
|
|
|
2797
2797
|
*/
|
|
2798
2798
|
export interface DeleteFleetRequest {
|
|
2799
2799
|
/**
|
|
2800
|
-
* @public
|
|
2801
2800
|
* <p> The ID of the fleet to delete. </p>
|
|
2801
|
+
* @public
|
|
2802
2802
|
*/
|
|
2803
2803
|
fleetId: string | undefined;
|
|
2804
2804
|
}
|
|
@@ -2807,13 +2807,13 @@ export interface DeleteFleetRequest {
|
|
|
2807
2807
|
*/
|
|
2808
2808
|
export interface DeleteFleetResponse {
|
|
2809
2809
|
/**
|
|
2810
|
-
* @public
|
|
2811
2810
|
* <p>The ID of the deleted fleet.</p>
|
|
2811
|
+
* @public
|
|
2812
2812
|
*/
|
|
2813
2813
|
id?: string;
|
|
2814
2814
|
/**
|
|
2815
|
-
* @public
|
|
2816
2815
|
* <p>The Amazon Resource Name (ARN) of the deleted fleet.</p>
|
|
2816
|
+
* @public
|
|
2817
2817
|
*/
|
|
2818
2818
|
arn?: string;
|
|
2819
2819
|
}
|
|
@@ -2822,8 +2822,8 @@ export interface DeleteFleetResponse {
|
|
|
2822
2822
|
*/
|
|
2823
2823
|
export interface DeleteModelManifestRequest {
|
|
2824
2824
|
/**
|
|
2825
|
-
* @public
|
|
2826
2825
|
* <p> The name of the model manifest to delete. </p>
|
|
2826
|
+
* @public
|
|
2827
2827
|
*/
|
|
2828
2828
|
name: string | undefined;
|
|
2829
2829
|
}
|
|
@@ -2832,13 +2832,13 @@ export interface DeleteModelManifestRequest {
|
|
|
2832
2832
|
*/
|
|
2833
2833
|
export interface DeleteModelManifestResponse {
|
|
2834
2834
|
/**
|
|
2835
|
-
* @public
|
|
2836
2835
|
* <p>The name of the deleted model manifest.</p>
|
|
2836
|
+
* @public
|
|
2837
2837
|
*/
|
|
2838
2838
|
name: string | undefined;
|
|
2839
2839
|
/**
|
|
2840
|
-
* @public
|
|
2841
2840
|
* <p>The Amazon Resource Name (ARN) of the deleted model manifest.</p>
|
|
2841
|
+
* @public
|
|
2842
2842
|
*/
|
|
2843
2843
|
arn: string | undefined;
|
|
2844
2844
|
}
|
|
@@ -2847,8 +2847,8 @@ export interface DeleteModelManifestResponse {
|
|
|
2847
2847
|
*/
|
|
2848
2848
|
export interface DeleteSignalCatalogRequest {
|
|
2849
2849
|
/**
|
|
2850
|
-
* @public
|
|
2851
2850
|
* <p> The name of the signal catalog to delete. </p>
|
|
2851
|
+
* @public
|
|
2852
2852
|
*/
|
|
2853
2853
|
name: string | undefined;
|
|
2854
2854
|
}
|
|
@@ -2857,13 +2857,13 @@ export interface DeleteSignalCatalogRequest {
|
|
|
2857
2857
|
*/
|
|
2858
2858
|
export interface DeleteSignalCatalogResponse {
|
|
2859
2859
|
/**
|
|
2860
|
-
* @public
|
|
2861
2860
|
* <p>The name of the deleted signal catalog.</p>
|
|
2861
|
+
* @public
|
|
2862
2862
|
*/
|
|
2863
2863
|
name: string | undefined;
|
|
2864
2864
|
/**
|
|
2865
|
-
* @public
|
|
2866
2865
|
* <p>The Amazon Resource Name (ARN) of the deleted signal catalog.</p>
|
|
2866
|
+
* @public
|
|
2867
2867
|
*/
|
|
2868
2868
|
arn: string | undefined;
|
|
2869
2869
|
}
|
|
@@ -2872,8 +2872,8 @@ export interface DeleteSignalCatalogResponse {
|
|
|
2872
2872
|
*/
|
|
2873
2873
|
export interface DeleteVehicleRequest {
|
|
2874
2874
|
/**
|
|
2875
|
-
* @public
|
|
2876
2875
|
* <p>The ID of the vehicle to delete. </p>
|
|
2876
|
+
* @public
|
|
2877
2877
|
*/
|
|
2878
2878
|
vehicleName: string | undefined;
|
|
2879
2879
|
}
|
|
@@ -2882,13 +2882,13 @@ export interface DeleteVehicleRequest {
|
|
|
2882
2882
|
*/
|
|
2883
2883
|
export interface DeleteVehicleResponse {
|
|
2884
2884
|
/**
|
|
2885
|
-
* @public
|
|
2886
2885
|
* <p>The ID of the deleted vehicle.</p>
|
|
2886
|
+
* @public
|
|
2887
2887
|
*/
|
|
2888
2888
|
vehicleName: string | undefined;
|
|
2889
2889
|
/**
|
|
2890
|
-
* @public
|
|
2891
2890
|
* <p>The Amazon Resource Name (ARN) of the deleted vehicle.</p>
|
|
2891
|
+
* @public
|
|
2892
2892
|
*/
|
|
2893
2893
|
arn: string | undefined;
|
|
2894
2894
|
}
|
|
@@ -2897,13 +2897,13 @@ export interface DeleteVehicleResponse {
|
|
|
2897
2897
|
*/
|
|
2898
2898
|
export interface DisassociateVehicleFleetRequest {
|
|
2899
2899
|
/**
|
|
2900
|
-
* @public
|
|
2901
2900
|
* <p> The unique ID of the vehicle to disassociate from the fleet.</p>
|
|
2901
|
+
* @public
|
|
2902
2902
|
*/
|
|
2903
2903
|
vehicleName: string | undefined;
|
|
2904
2904
|
/**
|
|
2905
|
-
* @public
|
|
2906
2905
|
* <p> The unique ID of a fleet. </p>
|
|
2906
|
+
* @public
|
|
2907
2907
|
*/
|
|
2908
2908
|
fleetId: string | undefined;
|
|
2909
2909
|
}
|
|
@@ -2942,19 +2942,19 @@ export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType
|
|
|
2942
2942
|
*/
|
|
2943
2943
|
export interface ListFleetsForVehicleRequest {
|
|
2944
2944
|
/**
|
|
2945
|
-
* @public
|
|
2946
2945
|
* <p> The ID of the vehicle to retrieve information about. </p>
|
|
2946
|
+
* @public
|
|
2947
2947
|
*/
|
|
2948
2948
|
vehicleName: string | undefined;
|
|
2949
2949
|
/**
|
|
2950
|
-
* @public
|
|
2951
2950
|
* <p>A pagination token for the next set of results.</p>
|
|
2952
2951
|
* <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
|
|
2952
|
+
* @public
|
|
2953
2953
|
*/
|
|
2954
2954
|
nextToken?: string;
|
|
2955
2955
|
/**
|
|
2956
|
-
* @public
|
|
2957
2956
|
* <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
|
|
2957
|
+
* @public
|
|
2958
2958
|
*/
|
|
2959
2959
|
maxResults?: number;
|
|
2960
2960
|
}
|
|
@@ -2963,13 +2963,13 @@ export interface ListFleetsForVehicleRequest {
|
|
|
2963
2963
|
*/
|
|
2964
2964
|
export interface ListFleetsForVehicleResponse {
|
|
2965
2965
|
/**
|
|
2966
|
-
* @public
|
|
2967
2966
|
* <p> A list of fleet IDs that the vehicle is associated with. </p>
|
|
2967
|
+
* @public
|
|
2968
2968
|
*/
|
|
2969
2969
|
fleets?: string[];
|
|
2970
2970
|
/**
|
|
2971
|
-
* @public
|
|
2972
2971
|
* <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
|
|
2972
|
+
* @public
|
|
2973
2973
|
*/
|
|
2974
2974
|
nextToken?: string;
|
|
2975
2975
|
}
|
|
@@ -2978,8 +2978,8 @@ export interface ListFleetsForVehicleResponse {
|
|
|
2978
2978
|
*/
|
|
2979
2979
|
export interface GetFleetRequest {
|
|
2980
2980
|
/**
|
|
2981
|
-
* @public
|
|
2982
2981
|
* <p> The ID of the fleet to retrieve information about. </p>
|
|
2982
|
+
* @public
|
|
2983
2983
|
*/
|
|
2984
2984
|
fleetId: string | undefined;
|
|
2985
2985
|
}
|
|
@@ -2988,35 +2988,35 @@ export interface GetFleetRequest {
|
|
|
2988
2988
|
*/
|
|
2989
2989
|
export interface GetFleetResponse {
|
|
2990
2990
|
/**
|
|
2991
|
-
* @public
|
|
2992
2991
|
* <p> The ID of the fleet.</p>
|
|
2992
|
+
* @public
|
|
2993
2993
|
*/
|
|
2994
2994
|
id: string | undefined;
|
|
2995
2995
|
/**
|
|
2996
|
-
* @public
|
|
2997
2996
|
* <p> The Amazon Resource Name (ARN) of the fleet. </p>
|
|
2997
|
+
* @public
|
|
2998
2998
|
*/
|
|
2999
2999
|
arn: string | undefined;
|
|
3000
3000
|
/**
|
|
3001
|
-
* @public
|
|
3002
3001
|
* <p> A brief description of the fleet. </p>
|
|
3002
|
+
* @public
|
|
3003
3003
|
*/
|
|
3004
3004
|
description?: string;
|
|
3005
3005
|
/**
|
|
3006
|
-
* @public
|
|
3007
3006
|
* <p> The ARN of a signal catalog associated with the fleet. </p>
|
|
3007
|
+
* @public
|
|
3008
3008
|
*/
|
|
3009
3009
|
signalCatalogArn: string | undefined;
|
|
3010
3010
|
/**
|
|
3011
|
-
* @public
|
|
3012
3011
|
* <p> The time the fleet was created in seconds since epoch (January 1, 1970 at midnight
|
|
3013
3012
|
* UTC time). </p>
|
|
3013
|
+
* @public
|
|
3014
3014
|
*/
|
|
3015
3015
|
creationTime: Date | undefined;
|
|
3016
3016
|
/**
|
|
3017
|
-
* @public
|
|
3018
3017
|
* <p> The time the fleet was last updated, in seconds since epoch (January 1, 1970 at
|
|
3019
3018
|
* midnight UTC time). </p>
|
|
3019
|
+
* @public
|
|
3020
3020
|
*/
|
|
3021
3021
|
lastModificationTime: Date | undefined;
|
|
3022
3022
|
}
|
|
@@ -3025,54 +3025,54 @@ export interface GetFleetResponse {
|
|
|
3025
3025
|
*/
|
|
3026
3026
|
export interface ListFleetsRequest {
|
|
3027
3027
|
/**
|
|
3028
|
-
* @public
|
|
3029
3028
|
* <p>A pagination token for the next set of results.</p>
|
|
3030
3029
|
* <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
|
|
3030
|
+
* @public
|
|
3031
3031
|
*/
|
|
3032
3032
|
nextToken?: string;
|
|
3033
3033
|
/**
|
|
3034
|
-
* @public
|
|
3035
3034
|
* <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
|
|
3035
|
+
* @public
|
|
3036
3036
|
*/
|
|
3037
3037
|
maxResults?: number;
|
|
3038
3038
|
}
|
|
3039
3039
|
/**
|
|
3040
|
-
* @public
|
|
3041
3040
|
* <p>Information about a fleet.</p>
|
|
3042
3041
|
* <p>You can use the API operation to return this
|
|
3043
3042
|
* information about multiple fleets.</p>
|
|
3043
|
+
* @public
|
|
3044
3044
|
*/
|
|
3045
3045
|
export interface FleetSummary {
|
|
3046
3046
|
/**
|
|
3047
|
-
* @public
|
|
3048
3047
|
* <p>The unique ID of the fleet.</p>
|
|
3048
|
+
* @public
|
|
3049
3049
|
*/
|
|
3050
3050
|
id: string | undefined;
|
|
3051
3051
|
/**
|
|
3052
|
-
* @public
|
|
3053
3052
|
* <p>The Amazon Resource Name (ARN) of the fleet.</p>
|
|
3053
|
+
* @public
|
|
3054
3054
|
*/
|
|
3055
3055
|
arn: string | undefined;
|
|
3056
3056
|
/**
|
|
3057
|
-
* @public
|
|
3058
3057
|
* <p>A brief description of the fleet.</p>
|
|
3058
|
+
* @public
|
|
3059
3059
|
*/
|
|
3060
3060
|
description?: string;
|
|
3061
3061
|
/**
|
|
3062
|
-
* @public
|
|
3063
3062
|
* <p>The ARN of the signal catalog associated with the fleet.</p>
|
|
3063
|
+
* @public
|
|
3064
3064
|
*/
|
|
3065
3065
|
signalCatalogArn: string | undefined;
|
|
3066
3066
|
/**
|
|
3067
|
-
* @public
|
|
3068
3067
|
* <p>The time the fleet was created, in seconds since epoch (January 1, 1970 at midnight
|
|
3069
3068
|
* UTC time).</p>
|
|
3069
|
+
* @public
|
|
3070
3070
|
*/
|
|
3071
3071
|
creationTime: Date | undefined;
|
|
3072
3072
|
/**
|
|
3073
|
-
* @public
|
|
3074
3073
|
* <p>The time the fleet was last updated in seconds since epoch (January 1, 1970 at
|
|
3075
3074
|
* midnight UTC time).</p>
|
|
3075
|
+
* @public
|
|
3076
3076
|
*/
|
|
3077
3077
|
lastModificationTime?: Date;
|
|
3078
3078
|
}
|
|
@@ -3081,13 +3081,13 @@ export interface FleetSummary {
|
|
|
3081
3081
|
*/
|
|
3082
3082
|
export interface ListFleetsResponse {
|
|
3083
3083
|
/**
|
|
3084
|
-
* @public
|
|
3085
3084
|
* <p> A list of information for each fleet. </p>
|
|
3085
|
+
* @public
|
|
3086
3086
|
*/
|
|
3087
3087
|
fleetSummaries?: FleetSummary[];
|
|
3088
3088
|
/**
|
|
3089
|
-
* @public
|
|
3090
3089
|
* <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
|
|
3090
|
+
* @public
|
|
3091
3091
|
*/
|
|
3092
3092
|
nextToken?: string;
|
|
3093
3093
|
}
|
|
@@ -3096,13 +3096,13 @@ export interface ListFleetsResponse {
|
|
|
3096
3096
|
*/
|
|
3097
3097
|
export interface UpdateFleetRequest {
|
|
3098
3098
|
/**
|
|
3099
|
-
* @public
|
|
3100
3099
|
* <p> The ID of the fleet to update. </p>
|
|
3100
|
+
* @public
|
|
3101
3101
|
*/
|
|
3102
3102
|
fleetId: string | undefined;
|
|
3103
3103
|
/**
|
|
3104
|
-
* @public
|
|
3105
3104
|
* <p> An updated description of the fleet. </p>
|
|
3105
|
+
* @public
|
|
3106
3106
|
*/
|
|
3107
3107
|
description?: string;
|
|
3108
3108
|
}
|
|
@@ -3111,13 +3111,13 @@ export interface UpdateFleetRequest {
|
|
|
3111
3111
|
*/
|
|
3112
3112
|
export interface UpdateFleetResponse {
|
|
3113
3113
|
/**
|
|
3114
|
-
* @public
|
|
3115
3114
|
* <p>The ID of the updated fleet.</p>
|
|
3115
|
+
* @public
|
|
3116
3116
|
*/
|
|
3117
3117
|
id?: string;
|
|
3118
3118
|
/**
|
|
3119
|
-
* @public
|
|
3120
3119
|
* <p>The Amazon Resource Name (ARN) of the updated fleet.</p>
|
|
3120
|
+
* @public
|
|
3121
3121
|
*/
|
|
3122
3122
|
arn?: string;
|
|
3123
3123
|
}
|
|
@@ -3126,19 +3126,19 @@ export interface UpdateFleetResponse {
|
|
|
3126
3126
|
*/
|
|
3127
3127
|
export interface ListVehiclesInFleetRequest {
|
|
3128
3128
|
/**
|
|
3129
|
-
* @public
|
|
3130
3129
|
* <p> The ID of a fleet. </p>
|
|
3130
|
+
* @public
|
|
3131
3131
|
*/
|
|
3132
3132
|
fleetId: string | undefined;
|
|
3133
3133
|
/**
|
|
3134
|
-
* @public
|
|
3135
3134
|
* <p>A pagination token for the next set of results.</p>
|
|
3136
3135
|
* <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
|
|
3136
|
+
* @public
|
|
3137
3137
|
*/
|
|
3138
3138
|
nextToken?: string;
|
|
3139
3139
|
/**
|
|
3140
|
-
* @public
|
|
3141
3140
|
* <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
|
|
3141
|
+
* @public
|
|
3142
3142
|
*/
|
|
3143
3143
|
maxResults?: number;
|
|
3144
3144
|
}
|
|
@@ -3147,22 +3147,22 @@ export interface ListVehiclesInFleetRequest {
|
|
|
3147
3147
|
*/
|
|
3148
3148
|
export interface ListVehiclesInFleetResponse {
|
|
3149
3149
|
/**
|
|
3150
|
-
* @public
|
|
3151
3150
|
* <p> A list of vehicles associated with the fleet. </p>
|
|
3151
|
+
* @public
|
|
3152
3152
|
*/
|
|
3153
3153
|
vehicles?: string[];
|
|
3154
3154
|
/**
|
|
3155
|
-
* @public
|
|
3156
3155
|
* <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
|
|
3156
|
+
* @public
|
|
3157
3157
|
*/
|
|
3158
3158
|
nextToken?: string;
|
|
3159
3159
|
}
|
|
3160
3160
|
/**
|
|
3161
|
-
* @public
|
|
3162
3161
|
* <p>
|
|
3163
3162
|
* <a href="https://www.w3.org/auto/wg/wiki/Vehicle_Signal_Specification_(VSS)/Vehicle_Data_Spec">Vehicle Signal Specification (VSS)</a> is a precise language used to describe and model
|
|
3164
3163
|
* signals in vehicle networks. The JSON file collects signal specificiations in a VSS
|
|
3165
3164
|
* format.</p>
|
|
3165
|
+
* @public
|
|
3166
3166
|
*/
|
|
3167
3167
|
export type FormattedVss = FormattedVss.VssJsonMember | FormattedVss.$UnknownMember;
|
|
3168
3168
|
/**
|
|
@@ -3170,8 +3170,8 @@ export type FormattedVss = FormattedVss.VssJsonMember | FormattedVss.$UnknownMem
|
|
|
3170
3170
|
*/
|
|
3171
3171
|
export declare namespace FormattedVss {
|
|
3172
3172
|
/**
|
|
3173
|
-
* @public
|
|
3174
3173
|
* <p>Provides the VSS in JSON format.</p>
|
|
3174
|
+
* @public
|
|
3175
3175
|
*/
|
|
3176
3176
|
interface VssJsonMember {
|
|
3177
3177
|
vssJson: string;
|
|
@@ -3200,33 +3200,33 @@ export interface GetEncryptionConfigurationRequest {
|
|
|
3200
3200
|
*/
|
|
3201
3201
|
export interface GetEncryptionConfigurationResponse {
|
|
3202
3202
|
/**
|
|
3203
|
-
* @public
|
|
3204
3203
|
* <p>The ID of the KMS key that is used for encryption.</p>
|
|
3204
|
+
* @public
|
|
3205
3205
|
*/
|
|
3206
3206
|
kmsKeyId?: string;
|
|
3207
3207
|
/**
|
|
3208
|
-
* @public
|
|
3209
3208
|
* <p>The encryption status.</p>
|
|
3209
|
+
* @public
|
|
3210
3210
|
*/
|
|
3211
3211
|
encryptionStatus: EncryptionStatus | undefined;
|
|
3212
3212
|
/**
|
|
3213
|
-
* @public
|
|
3214
3213
|
* <p>The type of encryption. Set to <code>KMS_BASED_ENCRYPTION</code> to use a KMS key that you own and manage. Set to <code>FLEETWISE_DEFAULT_ENCRYPTION</code> to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account.</p>
|
|
3214
|
+
* @public
|
|
3215
3215
|
*/
|
|
3216
3216
|
encryptionType: EncryptionType | undefined;
|
|
3217
3217
|
/**
|
|
3218
|
-
* @public
|
|
3219
3218
|
* <p>The error message that describes why encryption settings couldn't be configured, if applicable.</p>
|
|
3219
|
+
* @public
|
|
3220
3220
|
*/
|
|
3221
3221
|
errorMessage?: string;
|
|
3222
3222
|
/**
|
|
3223
|
-
* @public
|
|
3224
3223
|
* <p>The time when encryption was configured in seconds since epoch (January 1, 1970 at midnight UTC time).</p>
|
|
3224
|
+
* @public
|
|
3225
3225
|
*/
|
|
3226
3226
|
creationTime?: Date;
|
|
3227
3227
|
/**
|
|
3228
|
-
* @public
|
|
3229
3228
|
* <p>The time when encryption was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).</p>
|
|
3229
|
+
* @public
|
|
3230
3230
|
*/
|
|
3231
3231
|
lastModificationTime?: Date;
|
|
3232
3232
|
}
|
|
@@ -3240,8 +3240,8 @@ export interface GetLoggingOptionsRequest {
|
|
|
3240
3240
|
*/
|
|
3241
3241
|
export interface GetLoggingOptionsResponse {
|
|
3242
3242
|
/**
|
|
3243
|
-
* @public
|
|
3244
3243
|
* <p>Returns information about log delivery to Amazon CloudWatch Logs.</p>
|
|
3244
|
+
* @public
|
|
3245
3245
|
*/
|
|
3246
3246
|
cloudWatchLogDelivery: CloudWatchLogDeliveryOptions | undefined;
|
|
3247
3247
|
}
|
|
@@ -3250,8 +3250,8 @@ export interface GetLoggingOptionsResponse {
|
|
|
3250
3250
|
*/
|
|
3251
3251
|
export interface GetModelManifestRequest {
|
|
3252
3252
|
/**
|
|
3253
|
-
* @public
|
|
3254
3253
|
* <p> The name of the vehicle model to retrieve information about. </p>
|
|
3254
|
+
* @public
|
|
3255
3255
|
*/
|
|
3256
3256
|
name: string | undefined;
|
|
3257
3257
|
}
|
|
@@ -3260,41 +3260,41 @@ export interface GetModelManifestRequest {
|
|
|
3260
3260
|
*/
|
|
3261
3261
|
export interface GetModelManifestResponse {
|
|
3262
3262
|
/**
|
|
3263
|
-
* @public
|
|
3264
3263
|
* <p> The name of the vehicle model. </p>
|
|
3264
|
+
* @public
|
|
3265
3265
|
*/
|
|
3266
3266
|
name: string | undefined;
|
|
3267
3267
|
/**
|
|
3268
|
-
* @public
|
|
3269
3268
|
* <p> The Amazon Resource Name (ARN) of the vehicle model. </p>
|
|
3269
|
+
* @public
|
|
3270
3270
|
*/
|
|
3271
3271
|
arn: string | undefined;
|
|
3272
3272
|
/**
|
|
3273
|
-
* @public
|
|
3274
3273
|
* <p> A brief description of the vehicle model. </p>
|
|
3274
|
+
* @public
|
|
3275
3275
|
*/
|
|
3276
3276
|
description?: string;
|
|
3277
3277
|
/**
|
|
3278
|
-
* @public
|
|
3279
3278
|
* <p> The ARN of the signal catalog associated with the vehicle model. </p>
|
|
3279
|
+
* @public
|
|
3280
3280
|
*/
|
|
3281
3281
|
signalCatalogArn?: string;
|
|
3282
3282
|
/**
|
|
3283
|
-
* @public
|
|
3284
3283
|
* <p> The state of the vehicle model. If the status is <code>ACTIVE</code>, the vehicle
|
|
3285
3284
|
* model can't be edited. You can edit the vehicle model if the status is marked
|
|
3286
3285
|
* <code>DRAFT</code>.</p>
|
|
3286
|
+
* @public
|
|
3287
3287
|
*/
|
|
3288
3288
|
status?: ManifestStatus;
|
|
3289
3289
|
/**
|
|
3290
|
-
* @public
|
|
3291
3290
|
* <p>The time the vehicle model was created, in seconds since epoch (January 1, 1970 at
|
|
3292
3291
|
* midnight UTC time).</p>
|
|
3292
|
+
* @public
|
|
3293
3293
|
*/
|
|
3294
3294
|
creationTime: Date | undefined;
|
|
3295
3295
|
/**
|
|
3296
|
-
* @public
|
|
3297
3296
|
* <p>The last time the vehicle model was modified.</p>
|
|
3297
|
+
* @public
|
|
3298
3298
|
*/
|
|
3299
3299
|
lastModificationTime: Date | undefined;
|
|
3300
3300
|
}
|
|
@@ -3317,64 +3317,64 @@ export declare const RegistrationStatus: {
|
|
|
3317
3317
|
*/
|
|
3318
3318
|
export type RegistrationStatus = (typeof RegistrationStatus)[keyof typeof RegistrationStatus];
|
|
3319
3319
|
/**
|
|
3320
|
-
* @public
|
|
3321
3320
|
* <p>Information about registering an Identity and Access Management (IAM) resource so Amazon Web Services IoT FleetWise edge agent
|
|
3322
3321
|
* software can transfer your vehicle data to Amazon Timestream.</p>
|
|
3322
|
+
* @public
|
|
3323
3323
|
*/
|
|
3324
3324
|
export interface IamRegistrationResponse {
|
|
3325
3325
|
/**
|
|
3326
|
-
* @public
|
|
3327
3326
|
* <p>The Amazon Resource Name (ARN) of the IAM role to register.</p>
|
|
3327
|
+
* @public
|
|
3328
3328
|
*/
|
|
3329
3329
|
roleArn: string | undefined;
|
|
3330
3330
|
/**
|
|
3331
|
-
* @public
|
|
3332
3331
|
* <p>The status of registering your IAM resource. The status can be one of
|
|
3333
3332
|
* <code>REGISTRATION_SUCCESS</code>, <code>REGISTRATION_PENDING</code>,
|
|
3334
3333
|
* <code>REGISTRATION_FAILURE</code>.</p>
|
|
3334
|
+
* @public
|
|
3335
3335
|
*/
|
|
3336
3336
|
registrationStatus: RegistrationStatus | undefined;
|
|
3337
3337
|
/**
|
|
3338
|
-
* @public
|
|
3339
3338
|
* <p>A message associated with a registration error.</p>
|
|
3339
|
+
* @public
|
|
3340
3340
|
*/
|
|
3341
3341
|
errorMessage?: string;
|
|
3342
3342
|
}
|
|
3343
3343
|
/**
|
|
3344
|
-
* @public
|
|
3345
3344
|
* <p>Information about the registered Amazon Timestream resources or errors, if any.</p>
|
|
3345
|
+
* @public
|
|
3346
3346
|
*/
|
|
3347
3347
|
export interface TimestreamRegistrationResponse {
|
|
3348
3348
|
/**
|
|
3349
|
-
* @public
|
|
3350
3349
|
* <p>The name of the Timestream database.</p>
|
|
3350
|
+
* @public
|
|
3351
3351
|
*/
|
|
3352
3352
|
timestreamDatabaseName: string | undefined;
|
|
3353
3353
|
/**
|
|
3354
|
-
* @public
|
|
3355
3354
|
* <p>The name of the Timestream database table.</p>
|
|
3355
|
+
* @public
|
|
3356
3356
|
*/
|
|
3357
3357
|
timestreamTableName: string | undefined;
|
|
3358
3358
|
/**
|
|
3359
|
-
* @public
|
|
3360
3359
|
* <p>The Amazon Resource Name (ARN) of the Timestream database.</p>
|
|
3360
|
+
* @public
|
|
3361
3361
|
*/
|
|
3362
3362
|
timestreamDatabaseArn?: string;
|
|
3363
3363
|
/**
|
|
3364
|
-
* @public
|
|
3365
3364
|
* <p>The ARN of the Timestream database table.</p>
|
|
3365
|
+
* @public
|
|
3366
3366
|
*/
|
|
3367
3367
|
timestreamTableArn?: string;
|
|
3368
3368
|
/**
|
|
3369
|
-
* @public
|
|
3370
3369
|
* <p>The status of registering your Amazon Timestream resources. The status can be one of
|
|
3371
3370
|
* <code>REGISTRATION_SUCCESS</code>, <code>REGISTRATION_PENDING</code>,
|
|
3372
3371
|
* <code>REGISTRATION_FAILURE</code>.</p>
|
|
3372
|
+
* @public
|
|
3373
3373
|
*/
|
|
3374
3374
|
registrationStatus: RegistrationStatus | undefined;
|
|
3375
3375
|
/**
|
|
3376
|
-
* @public
|
|
3377
3376
|
* <p>A message associated with a registration error.</p>
|
|
3377
|
+
* @public
|
|
3378
3378
|
*/
|
|
3379
3379
|
errorMessage?: string;
|
|
3380
3380
|
}
|
|
@@ -3383,12 +3383,11 @@ export interface TimestreamRegistrationResponse {
|
|
|
3383
3383
|
*/
|
|
3384
3384
|
export interface GetRegisterAccountStatusResponse {
|
|
3385
3385
|
/**
|
|
3386
|
-
* @public
|
|
3387
3386
|
* <p> The unique ID of the Amazon Web Services account, provided at account creation. </p>
|
|
3387
|
+
* @public
|
|
3388
3388
|
*/
|
|
3389
3389
|
customerAccountId: string | undefined;
|
|
3390
3390
|
/**
|
|
3391
|
-
* @public
|
|
3392
3391
|
* <p> The status of registering your account and resources. The status can be one
|
|
3393
3392
|
* of:</p>
|
|
3394
3393
|
* <ul>
|
|
@@ -3408,28 +3407,29 @@ export interface GetRegisterAccountStatusResponse {
|
|
|
3408
3407
|
* Try again later.</p>
|
|
3409
3408
|
* </li>
|
|
3410
3409
|
* </ul>
|
|
3410
|
+
* @public
|
|
3411
3411
|
*/
|
|
3412
3412
|
accountStatus: RegistrationStatus | undefined;
|
|
3413
3413
|
/**
|
|
3414
|
-
* @public
|
|
3415
3414
|
* <p> Information about the registered Amazon Timestream resources or errors, if any.</p>
|
|
3415
|
+
* @public
|
|
3416
3416
|
*/
|
|
3417
3417
|
timestreamRegistrationResponse?: TimestreamRegistrationResponse;
|
|
3418
3418
|
/**
|
|
3419
|
-
* @public
|
|
3420
3419
|
* <p> Information about the registered IAM resources or errors, if any. </p>
|
|
3420
|
+
* @public
|
|
3421
3421
|
*/
|
|
3422
3422
|
iamRegistrationResponse: IamRegistrationResponse | undefined;
|
|
3423
3423
|
/**
|
|
3424
|
-
* @public
|
|
3425
3424
|
* <p> The time the account was registered, in seconds since epoch (January 1, 1970 at
|
|
3426
3425
|
* midnight UTC time). </p>
|
|
3426
|
+
* @public
|
|
3427
3427
|
*/
|
|
3428
3428
|
creationTime: Date | undefined;
|
|
3429
3429
|
/**
|
|
3430
|
-
* @public
|
|
3431
3430
|
* <p> The time this registration was last updated, in seconds since epoch (January 1, 1970
|
|
3432
3431
|
* at midnight UTC time). </p>
|
|
3432
|
+
* @public
|
|
3433
3433
|
*/
|
|
3434
3434
|
lastModificationTime: Date | undefined;
|
|
3435
3435
|
}
|
|
@@ -3438,49 +3438,49 @@ export interface GetRegisterAccountStatusResponse {
|
|
|
3438
3438
|
*/
|
|
3439
3439
|
export interface GetSignalCatalogRequest {
|
|
3440
3440
|
/**
|
|
3441
|
-
* @public
|
|
3442
3441
|
* <p> The name of the signal catalog to retrieve information about. </p>
|
|
3442
|
+
* @public
|
|
3443
3443
|
*/
|
|
3444
3444
|
name: string | undefined;
|
|
3445
3445
|
}
|
|
3446
3446
|
/**
|
|
3447
|
-
* @public
|
|
3448
3447
|
* <p>Information about the number of nodes and node types in a vehicle network.</p>
|
|
3448
|
+
* @public
|
|
3449
3449
|
*/
|
|
3450
3450
|
export interface NodeCounts {
|
|
3451
3451
|
/**
|
|
3452
|
-
* @public
|
|
3453
3452
|
* <p>The total number of nodes in a vehicle network.</p>
|
|
3453
|
+
* @public
|
|
3454
3454
|
*/
|
|
3455
3455
|
totalNodes?: number;
|
|
3456
3456
|
/**
|
|
3457
|
-
* @public
|
|
3458
3457
|
* <p>The total number of nodes in a vehicle network that represent branches.</p>
|
|
3458
|
+
* @public
|
|
3459
3459
|
*/
|
|
3460
3460
|
totalBranches?: number;
|
|
3461
3461
|
/**
|
|
3462
|
-
* @public
|
|
3463
3462
|
* <p>The total number of nodes in a vehicle network that represent sensors.</p>
|
|
3463
|
+
* @public
|
|
3464
3464
|
*/
|
|
3465
3465
|
totalSensors?: number;
|
|
3466
3466
|
/**
|
|
3467
|
-
* @public
|
|
3468
3467
|
* <p>The total number of nodes in a vehicle network that represent attributes.</p>
|
|
3468
|
+
* @public
|
|
3469
3469
|
*/
|
|
3470
3470
|
totalAttributes?: number;
|
|
3471
3471
|
/**
|
|
3472
|
-
* @public
|
|
3473
3472
|
* <p>The total number of nodes in a vehicle network that represent actuators.</p>
|
|
3473
|
+
* @public
|
|
3474
3474
|
*/
|
|
3475
3475
|
totalActuators?: number;
|
|
3476
3476
|
/**
|
|
3477
|
-
* @public
|
|
3478
3477
|
* <p>The total structure for the node.</p>
|
|
3478
|
+
* @public
|
|
3479
3479
|
*/
|
|
3480
3480
|
totalStructs?: number;
|
|
3481
3481
|
/**
|
|
3482
|
-
* @public
|
|
3483
3482
|
* <p>The total properties for the node.</p>
|
|
3483
|
+
* @public
|
|
3484
3484
|
*/
|
|
3485
3485
|
totalProperties?: number;
|
|
3486
3486
|
}
|
|
@@ -3489,33 +3489,33 @@ export interface NodeCounts {
|
|
|
3489
3489
|
*/
|
|
3490
3490
|
export interface GetSignalCatalogResponse {
|
|
3491
3491
|
/**
|
|
3492
|
-
* @public
|
|
3493
3492
|
* <p> The name of the signal catalog. </p>
|
|
3493
|
+
* @public
|
|
3494
3494
|
*/
|
|
3495
3495
|
name: string | undefined;
|
|
3496
3496
|
/**
|
|
3497
|
-
* @public
|
|
3498
3497
|
* <p> The Amazon Resource Name (ARN) of the signal catalog. </p>
|
|
3498
|
+
* @public
|
|
3499
3499
|
*/
|
|
3500
3500
|
arn: string | undefined;
|
|
3501
3501
|
/**
|
|
3502
|
-
* @public
|
|
3503
3502
|
* <p> A brief description of the signal catalog. </p>
|
|
3503
|
+
* @public
|
|
3504
3504
|
*/
|
|
3505
3505
|
description?: string;
|
|
3506
3506
|
/**
|
|
3507
|
-
* @public
|
|
3508
3507
|
* <p> The total number of network nodes specified in a signal catalog. </p>
|
|
3508
|
+
* @public
|
|
3509
3509
|
*/
|
|
3510
3510
|
nodeCounts?: NodeCounts;
|
|
3511
3511
|
/**
|
|
3512
|
-
* @public
|
|
3513
3512
|
* <p> The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time). </p>
|
|
3513
|
+
* @public
|
|
3514
3514
|
*/
|
|
3515
3515
|
creationTime: Date | undefined;
|
|
3516
3516
|
/**
|
|
3517
|
-
* @public
|
|
3518
3517
|
* <p>The last time the signal catalog was modified.</p>
|
|
3518
|
+
* @public
|
|
3519
3519
|
*/
|
|
3520
3520
|
lastModificationTime: Date | undefined;
|
|
3521
3521
|
}
|
|
@@ -3524,8 +3524,8 @@ export interface GetSignalCatalogResponse {
|
|
|
3524
3524
|
*/
|
|
3525
3525
|
export interface GetVehicleRequest {
|
|
3526
3526
|
/**
|
|
3527
|
-
* @public
|
|
3528
3527
|
* <p> The ID of the vehicle to retrieve information about. </p>
|
|
3528
|
+
* @public
|
|
3529
3529
|
*/
|
|
3530
3530
|
vehicleName: string | undefined;
|
|
3531
3531
|
}
|
|
@@ -3534,41 +3534,41 @@ export interface GetVehicleRequest {
|
|
|
3534
3534
|
*/
|
|
3535
3535
|
export interface GetVehicleResponse {
|
|
3536
3536
|
/**
|
|
3537
|
-
* @public
|
|
3538
3537
|
* <p>The ID of the vehicle.</p>
|
|
3538
|
+
* @public
|
|
3539
3539
|
*/
|
|
3540
3540
|
vehicleName?: string;
|
|
3541
3541
|
/**
|
|
3542
|
-
* @public
|
|
3543
3542
|
* <p> The Amazon Resource Name (ARN) of the vehicle to retrieve information about. </p>
|
|
3543
|
+
* @public
|
|
3544
3544
|
*/
|
|
3545
3545
|
arn?: string;
|
|
3546
3546
|
/**
|
|
3547
|
-
* @public
|
|
3548
3547
|
* <p> The ARN of a vehicle model (model manifest) associated with the vehicle. </p>
|
|
3548
|
+
* @public
|
|
3549
3549
|
*/
|
|
3550
3550
|
modelManifestArn?: string;
|
|
3551
3551
|
/**
|
|
3552
|
-
* @public
|
|
3553
3552
|
* <p> The ARN of a decoder manifest associated with the vehicle. </p>
|
|
3553
|
+
* @public
|
|
3554
3554
|
*/
|
|
3555
3555
|
decoderManifestArn?: string;
|
|
3556
3556
|
/**
|
|
3557
|
-
* @public
|
|
3558
3557
|
* <p>Static information about a vehicle in a key-value pair. For example:</p>
|
|
3559
3558
|
* <p>
|
|
3560
3559
|
* <code>"engineType"</code> : <code>"1.3 L R2"</code>
|
|
3561
3560
|
* </p>
|
|
3561
|
+
* @public
|
|
3562
3562
|
*/
|
|
3563
3563
|
attributes?: Record<string, string>;
|
|
3564
3564
|
/**
|
|
3565
|
-
* @public
|
|
3566
3565
|
* <p> The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time). </p>
|
|
3566
|
+
* @public
|
|
3567
3567
|
*/
|
|
3568
3568
|
creationTime?: Date;
|
|
3569
3569
|
/**
|
|
3570
|
-
* @public
|
|
3571
3570
|
* <p> The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). </p>
|
|
3571
|
+
* @public
|
|
3572
3572
|
*/
|
|
3573
3573
|
lastModificationTime?: Date;
|
|
3574
3574
|
}
|
|
@@ -3577,19 +3577,19 @@ export interface GetVehicleResponse {
|
|
|
3577
3577
|
*/
|
|
3578
3578
|
export interface GetVehicleStatusRequest {
|
|
3579
3579
|
/**
|
|
3580
|
-
* @public
|
|
3581
3580
|
* <p>A pagination token for the next set of results.</p>
|
|
3582
3581
|
* <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
|
|
3582
|
+
* @public
|
|
3583
3583
|
*/
|
|
3584
3584
|
nextToken?: string;
|
|
3585
3585
|
/**
|
|
3586
|
-
* @public
|
|
3587
3586
|
* <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
|
|
3587
|
+
* @public
|
|
3588
3588
|
*/
|
|
3589
3589
|
maxResults?: number;
|
|
3590
3590
|
/**
|
|
3591
|
-
* @public
|
|
3592
3591
|
* <p> The ID of the vehicle to retrieve information about. </p>
|
|
3592
|
+
* @public
|
|
3593
3593
|
*/
|
|
3594
3594
|
vehicleName: string | undefined;
|
|
3595
3595
|
}
|
|
@@ -3609,23 +3609,22 @@ export declare const VehicleState: {
|
|
|
3609
3609
|
*/
|
|
3610
3610
|
export type VehicleState = (typeof VehicleState)[keyof typeof VehicleState];
|
|
3611
3611
|
/**
|
|
3612
|
-
* @public
|
|
3613
3612
|
* <p>Information about the state of a vehicle and how it relates to the status of a
|
|
3614
3613
|
* campaign.</p>
|
|
3614
|
+
* @public
|
|
3615
3615
|
*/
|
|
3616
3616
|
export interface VehicleStatus {
|
|
3617
3617
|
/**
|
|
3618
|
-
* @public
|
|
3619
3618
|
* <p>The name of a campaign.</p>
|
|
3619
|
+
* @public
|
|
3620
3620
|
*/
|
|
3621
3621
|
campaignName?: string;
|
|
3622
3622
|
/**
|
|
3623
|
-
* @public
|
|
3624
3623
|
* <p>The unique ID of the vehicle.</p>
|
|
3624
|
+
* @public
|
|
3625
3625
|
*/
|
|
3626
3626
|
vehicleName?: string;
|
|
3627
3627
|
/**
|
|
3628
|
-
* @public
|
|
3629
3628
|
* <p>The state of a vehicle, which can be one of the following:</p>
|
|
3630
3629
|
* <ul>
|
|
3631
3630
|
* <li>
|
|
@@ -3653,6 +3652,7 @@ export interface VehicleStatus {
|
|
|
3653
3652
|
* </p>
|
|
3654
3653
|
* </li>
|
|
3655
3654
|
* </ul>
|
|
3655
|
+
* @public
|
|
3656
3656
|
*/
|
|
3657
3657
|
status?: VehicleState;
|
|
3658
3658
|
}
|
|
@@ -3661,29 +3661,29 @@ export interface VehicleStatus {
|
|
|
3661
3661
|
*/
|
|
3662
3662
|
export interface GetVehicleStatusResponse {
|
|
3663
3663
|
/**
|
|
3664
|
-
* @public
|
|
3665
3664
|
* <p> Lists information about the state of the vehicle with deployed campaigns. </p>
|
|
3665
|
+
* @public
|
|
3666
3666
|
*/
|
|
3667
3667
|
campaigns?: VehicleStatus[];
|
|
3668
3668
|
/**
|
|
3669
|
-
* @public
|
|
3670
3669
|
* <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
|
|
3670
|
+
* @public
|
|
3671
3671
|
*/
|
|
3672
3672
|
nextToken?: string;
|
|
3673
3673
|
}
|
|
3674
3674
|
/**
|
|
3675
|
-
* @public
|
|
3676
3675
|
* <p>The IAM resource that enables Amazon Web Services IoT FleetWise edge agent software to send data to
|
|
3677
3676
|
* Amazon Timestream. </p>
|
|
3678
3677
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM roles</a> in the
|
|
3679
3678
|
* <i>Identity and Access Management User Guide</i>.</p>
|
|
3679
|
+
* @public
|
|
3680
3680
|
*/
|
|
3681
3681
|
export interface IamResources {
|
|
3682
3682
|
/**
|
|
3683
|
-
* @public
|
|
3684
3683
|
* <p>The Amazon Resource Name (ARN) of the IAM resource that allows Amazon Web Services IoT FleetWise to send data to
|
|
3685
3684
|
* Amazon Timestream. For example, <code>arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN</code>.
|
|
3686
3685
|
* </p>
|
|
3686
|
+
* @public
|
|
3687
3687
|
*/
|
|
3688
3688
|
roleArn: string | undefined;
|
|
3689
3689
|
}
|
|
@@ -3692,24 +3692,24 @@ export interface IamResources {
|
|
|
3692
3692
|
*/
|
|
3693
3693
|
export interface ImportSignalCatalogRequest {
|
|
3694
3694
|
/**
|
|
3695
|
-
* @public
|
|
3696
3695
|
* <p>The name of the signal catalog to import.</p>
|
|
3696
|
+
* @public
|
|
3697
3697
|
*/
|
|
3698
3698
|
name: string | undefined;
|
|
3699
3699
|
/**
|
|
3700
|
-
* @public
|
|
3701
3700
|
* <p> A brief description of the signal catalog. </p>
|
|
3701
|
+
* @public
|
|
3702
3702
|
*/
|
|
3703
3703
|
description?: string;
|
|
3704
3704
|
/**
|
|
3705
|
-
* @public
|
|
3706
3705
|
* <p>The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a precise
|
|
3707
3706
|
* language used to describe and model signals in vehicle networks.</p>
|
|
3707
|
+
* @public
|
|
3708
3708
|
*/
|
|
3709
3709
|
vss?: FormattedVss;
|
|
3710
3710
|
/**
|
|
3711
|
-
* @public
|
|
3712
3711
|
* <p>Metadata that can be used to manage the signal catalog.</p>
|
|
3712
|
+
* @public
|
|
3713
3713
|
*/
|
|
3714
3714
|
tags?: Tag[];
|
|
3715
3715
|
}
|
|
@@ -3718,13 +3718,13 @@ export interface ImportSignalCatalogRequest {
|
|
|
3718
3718
|
*/
|
|
3719
3719
|
export interface ImportSignalCatalogResponse {
|
|
3720
3720
|
/**
|
|
3721
|
-
* @public
|
|
3722
3721
|
* <p> The name of the imported signal catalog. </p>
|
|
3722
|
+
* @public
|
|
3723
3723
|
*/
|
|
3724
3724
|
name: string | undefined;
|
|
3725
3725
|
/**
|
|
3726
|
-
* @public
|
|
3727
3726
|
* <p> The Amazon Resource Name (ARN) of the imported signal catalog.</p>
|
|
3727
|
+
* @public
|
|
3728
3728
|
*/
|
|
3729
3729
|
arn: string | undefined;
|
|
3730
3730
|
}
|
|
@@ -3733,8 +3733,8 @@ export interface ImportSignalCatalogResponse {
|
|
|
3733
3733
|
*/
|
|
3734
3734
|
export interface ListTagsForResourceRequest {
|
|
3735
3735
|
/**
|
|
3736
|
-
* @public
|
|
3737
3736
|
* <p>The ARN of the resource.</p>
|
|
3737
|
+
* @public
|
|
3738
3738
|
*/
|
|
3739
3739
|
ResourceARN: string | undefined;
|
|
3740
3740
|
}
|
|
@@ -3743,8 +3743,8 @@ export interface ListTagsForResourceRequest {
|
|
|
3743
3743
|
*/
|
|
3744
3744
|
export interface ListTagsForResourceResponse {
|
|
3745
3745
|
/**
|
|
3746
|
-
* @public
|
|
3747
3746
|
* <p>The list of tags assigned to the resource.</p>
|
|
3747
|
+
* @public
|
|
3748
3748
|
*/
|
|
3749
3749
|
Tags?: Tag[];
|
|
3750
3750
|
}
|
|
@@ -3753,19 +3753,19 @@ export interface ListTagsForResourceResponse {
|
|
|
3753
3753
|
*/
|
|
3754
3754
|
export interface ListModelManifestNodesRequest {
|
|
3755
3755
|
/**
|
|
3756
|
-
* @public
|
|
3757
3756
|
* <p> The name of the vehicle model to list information about. </p>
|
|
3757
|
+
* @public
|
|
3758
3758
|
*/
|
|
3759
3759
|
name: string | undefined;
|
|
3760
3760
|
/**
|
|
3761
|
-
* @public
|
|
3762
3761
|
* <p>A pagination token for the next set of results.</p>
|
|
3763
3762
|
* <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
|
|
3763
|
+
* @public
|
|
3764
3764
|
*/
|
|
3765
3765
|
nextToken?: string;
|
|
3766
3766
|
/**
|
|
3767
|
-
* @public
|
|
3768
3767
|
* <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
|
|
3768
|
+
* @public
|
|
3769
3769
|
*/
|
|
3770
3770
|
maxResults?: number;
|
|
3771
3771
|
}
|
|
@@ -3774,13 +3774,13 @@ export interface ListModelManifestNodesRequest {
|
|
|
3774
3774
|
*/
|
|
3775
3775
|
export interface ListModelManifestNodesResponse {
|
|
3776
3776
|
/**
|
|
3777
|
-
* @public
|
|
3778
3777
|
* <p> A list of information about nodes. </p>
|
|
3778
|
+
* @public
|
|
3779
3779
|
*/
|
|
3780
3780
|
nodes?: Node[];
|
|
3781
3781
|
/**
|
|
3782
|
-
* @public
|
|
3783
3782
|
* <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
|
|
3783
|
+
* @public
|
|
3784
3784
|
*/
|
|
3785
3785
|
nextToken?: string;
|
|
3786
3786
|
}
|
|
@@ -3789,66 +3789,66 @@ export interface ListModelManifestNodesResponse {
|
|
|
3789
3789
|
*/
|
|
3790
3790
|
export interface ListModelManifestsRequest {
|
|
3791
3791
|
/**
|
|
3792
|
-
* @public
|
|
3793
3792
|
* <p> The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models
|
|
3794
3793
|
* associated with it are returned.</p>
|
|
3794
|
+
* @public
|
|
3795
3795
|
*/
|
|
3796
3796
|
signalCatalogArn?: string;
|
|
3797
3797
|
/**
|
|
3798
|
-
* @public
|
|
3799
3798
|
* <p>A pagination token for the next set of results.</p>
|
|
3800
3799
|
* <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
|
|
3800
|
+
* @public
|
|
3801
3801
|
*/
|
|
3802
3802
|
nextToken?: string;
|
|
3803
3803
|
/**
|
|
3804
|
-
* @public
|
|
3805
3804
|
* <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
|
|
3805
|
+
* @public
|
|
3806
3806
|
*/
|
|
3807
3807
|
maxResults?: number;
|
|
3808
3808
|
}
|
|
3809
3809
|
/**
|
|
3810
|
-
* @public
|
|
3811
3810
|
* <p>Information about a vehicle model (model manifest). You can use the API operation to return this information about
|
|
3812
3811
|
* multiple vehicle models.</p>
|
|
3812
|
+
* @public
|
|
3813
3813
|
*/
|
|
3814
3814
|
export interface ModelManifestSummary {
|
|
3815
3815
|
/**
|
|
3816
|
-
* @public
|
|
3817
3816
|
* <p>The name of the vehicle model.</p>
|
|
3817
|
+
* @public
|
|
3818
3818
|
*/
|
|
3819
3819
|
name?: string;
|
|
3820
3820
|
/**
|
|
3821
|
-
* @public
|
|
3822
3821
|
* <p>The Amazon Resource Name (ARN) of the vehicle model.</p>
|
|
3822
|
+
* @public
|
|
3823
3823
|
*/
|
|
3824
3824
|
arn?: string;
|
|
3825
3825
|
/**
|
|
3826
|
-
* @public
|
|
3827
3826
|
* <p>The ARN of the signal catalog associated with the vehicle model.</p>
|
|
3827
|
+
* @public
|
|
3828
3828
|
*/
|
|
3829
3829
|
signalCatalogArn?: string;
|
|
3830
3830
|
/**
|
|
3831
|
-
* @public
|
|
3832
3831
|
* <p>A brief description of the vehicle model.</p>
|
|
3832
|
+
* @public
|
|
3833
3833
|
*/
|
|
3834
3834
|
description?: string;
|
|
3835
3835
|
/**
|
|
3836
|
-
* @public
|
|
3837
3836
|
* <p>The state of the vehicle model. If the status is <code>ACTIVE</code>, the vehicle
|
|
3838
3837
|
* model can't be edited. If the status is <code>DRAFT</code>, you can edit the vehicle
|
|
3839
3838
|
* model.</p>
|
|
3839
|
+
* @public
|
|
3840
3840
|
*/
|
|
3841
3841
|
status?: ManifestStatus;
|
|
3842
3842
|
/**
|
|
3843
|
-
* @public
|
|
3844
3843
|
* <p>The time the vehicle model was created, in seconds since epoch (January 1, 1970 at
|
|
3845
3844
|
* midnight UTC time).</p>
|
|
3845
|
+
* @public
|
|
3846
3846
|
*/
|
|
3847
3847
|
creationTime: Date | undefined;
|
|
3848
3848
|
/**
|
|
3849
|
-
* @public
|
|
3850
3849
|
* <p>The time the vehicle model was last updated, in seconds since epoch (January 1, 1970
|
|
3851
3850
|
* at midnight UTC time).</p>
|
|
3851
|
+
* @public
|
|
3852
3852
|
*/
|
|
3853
3853
|
lastModificationTime: Date | undefined;
|
|
3854
3854
|
}
|
|
@@ -3857,13 +3857,13 @@ export interface ModelManifestSummary {
|
|
|
3857
3857
|
*/
|
|
3858
3858
|
export interface ListModelManifestsResponse {
|
|
3859
3859
|
/**
|
|
3860
|
-
* @public
|
|
3861
3860
|
* <p> A list of information about vehicle models.</p>
|
|
3861
|
+
* @public
|
|
3862
3862
|
*/
|
|
3863
3863
|
summaries?: ModelManifestSummary[];
|
|
3864
3864
|
/**
|
|
3865
|
-
* @public
|
|
3866
3865
|
* <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
|
|
3866
|
+
* @public
|
|
3867
3867
|
*/
|
|
3868
3868
|
nextToken?: string;
|
|
3869
3869
|
}
|
|
@@ -3872,32 +3872,32 @@ export interface ListModelManifestsResponse {
|
|
|
3872
3872
|
*/
|
|
3873
3873
|
export interface UpdateModelManifestRequest {
|
|
3874
3874
|
/**
|
|
3875
|
-
* @public
|
|
3876
3875
|
* <p> The name of the vehicle model to update. </p>
|
|
3876
|
+
* @public
|
|
3877
3877
|
*/
|
|
3878
3878
|
name: string | undefined;
|
|
3879
3879
|
/**
|
|
3880
|
-
* @public
|
|
3881
3880
|
* <p> A brief description of the vehicle model. </p>
|
|
3881
|
+
* @public
|
|
3882
3882
|
*/
|
|
3883
3883
|
description?: string;
|
|
3884
3884
|
/**
|
|
3885
|
-
* @public
|
|
3886
3885
|
* <p> A list of <code>fullyQualifiedName</code> of nodes, which are a general abstraction
|
|
3887
3886
|
* of signals, to add to the vehicle model. </p>
|
|
3887
|
+
* @public
|
|
3888
3888
|
*/
|
|
3889
3889
|
nodesToAdd?: string[];
|
|
3890
3890
|
/**
|
|
3891
|
-
* @public
|
|
3892
3891
|
* <p> A list of <code>fullyQualifiedName</code> of nodes, which are a general abstraction
|
|
3893
3892
|
* of signals, to remove from the vehicle model. </p>
|
|
3893
|
+
* @public
|
|
3894
3894
|
*/
|
|
3895
3895
|
nodesToRemove?: string[];
|
|
3896
3896
|
/**
|
|
3897
|
-
* @public
|
|
3898
3897
|
* <p> The state of the vehicle model. If the status is <code>ACTIVE</code>, the vehicle
|
|
3899
3898
|
* model can't be edited. If the status is <code>DRAFT</code>, you can edit the vehicle
|
|
3900
3899
|
* model. </p>
|
|
3900
|
+
* @public
|
|
3901
3901
|
*/
|
|
3902
3902
|
status?: ManifestStatus;
|
|
3903
3903
|
}
|
|
@@ -3906,13 +3906,13 @@ export interface UpdateModelManifestRequest {
|
|
|
3906
3906
|
*/
|
|
3907
3907
|
export interface UpdateModelManifestResponse {
|
|
3908
3908
|
/**
|
|
3909
|
-
* @public
|
|
3910
3909
|
* <p> The name of the updated vehicle model. </p>
|
|
3910
|
+
* @public
|
|
3911
3911
|
*/
|
|
3912
3912
|
name: string | undefined;
|
|
3913
3913
|
/**
|
|
3914
|
-
* @public
|
|
3915
3914
|
* <p> The Amazon Resource Name (ARN) of the updated vehicle model. </p>
|
|
3915
|
+
* @public
|
|
3916
3916
|
*/
|
|
3917
3917
|
arn: string | undefined;
|
|
3918
3918
|
}
|
|
@@ -3921,13 +3921,13 @@ export interface UpdateModelManifestResponse {
|
|
|
3921
3921
|
*/
|
|
3922
3922
|
export interface PutEncryptionConfigurationRequest {
|
|
3923
3923
|
/**
|
|
3924
|
-
* @public
|
|
3925
3924
|
* <p>The ID of the KMS key that is used for encryption.</p>
|
|
3925
|
+
* @public
|
|
3926
3926
|
*/
|
|
3927
3927
|
kmsKeyId?: string;
|
|
3928
3928
|
/**
|
|
3929
|
-
* @public
|
|
3930
3929
|
* <p>The type of encryption. Choose <code>KMS_BASED_ENCRYPTION</code> to use a KMS key or <code>FLEETWISE_DEFAULT_ENCRYPTION</code> to use an Amazon Web Services managed key.</p>
|
|
3930
|
+
* @public
|
|
3931
3931
|
*/
|
|
3932
3932
|
encryptionType: EncryptionType | undefined;
|
|
3933
3933
|
}
|
|
@@ -3936,18 +3936,18 @@ export interface PutEncryptionConfigurationRequest {
|
|
|
3936
3936
|
*/
|
|
3937
3937
|
export interface PutEncryptionConfigurationResponse {
|
|
3938
3938
|
/**
|
|
3939
|
-
* @public
|
|
3940
3939
|
* <p>The ID of the KMS key that is used for encryption.</p>
|
|
3940
|
+
* @public
|
|
3941
3941
|
*/
|
|
3942
3942
|
kmsKeyId?: string;
|
|
3943
3943
|
/**
|
|
3944
|
-
* @public
|
|
3945
3944
|
* <p>The encryption status.</p>
|
|
3945
|
+
* @public
|
|
3946
3946
|
*/
|
|
3947
3947
|
encryptionStatus: EncryptionStatus | undefined;
|
|
3948
3948
|
/**
|
|
3949
|
-
* @public
|
|
3950
3949
|
* <p>The type of encryption. Set to <code>KMS_BASED_ENCRYPTION</code> to use an KMS key that you own and manage. Set to <code>FLEETWISE_DEFAULT_ENCRYPTION</code> to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account.</p>
|
|
3950
|
+
* @public
|
|
3951
3951
|
*/
|
|
3952
3952
|
encryptionType: EncryptionType | undefined;
|
|
3953
3953
|
}
|
|
@@ -3956,8 +3956,8 @@ export interface PutEncryptionConfigurationResponse {
|
|
|
3956
3956
|
*/
|
|
3957
3957
|
export interface PutLoggingOptionsRequest {
|
|
3958
3958
|
/**
|
|
3959
|
-
* @public
|
|
3960
3959
|
* <p>Creates or updates the log delivery option to Amazon CloudWatch Logs.</p>
|
|
3960
|
+
* @public
|
|
3961
3961
|
*/
|
|
3962
3962
|
cloudWatchLogDelivery: CloudWatchLogDeliveryOptions | undefined;
|
|
3963
3963
|
}
|
|
@@ -3967,19 +3967,19 @@ export interface PutLoggingOptionsRequest {
|
|
|
3967
3967
|
export interface PutLoggingOptionsResponse {
|
|
3968
3968
|
}
|
|
3969
3969
|
/**
|
|
3970
|
-
* @public
|
|
3971
3970
|
* <p>The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer
|
|
3972
3971
|
* your vehicle data to.</p>
|
|
3972
|
+
* @public
|
|
3973
3973
|
*/
|
|
3974
3974
|
export interface TimestreamResources {
|
|
3975
3975
|
/**
|
|
3976
|
-
* @public
|
|
3977
3976
|
* <p>The name of the registered Amazon Timestream database.</p>
|
|
3977
|
+
* @public
|
|
3978
3978
|
*/
|
|
3979
3979
|
timestreamDatabaseName: string | undefined;
|
|
3980
3980
|
/**
|
|
3981
|
-
* @public
|
|
3982
3981
|
* <p>The name of the registered Amazon Timestream database table.</p>
|
|
3982
|
+
* @public
|
|
3983
3983
|
*/
|
|
3984
3984
|
timestreamTableName: string | undefined;
|
|
3985
3985
|
}
|
|
@@ -3988,18 +3988,18 @@ export interface TimestreamResources {
|
|
|
3988
3988
|
*/
|
|
3989
3989
|
export interface RegisterAccountRequest {
|
|
3990
3990
|
/**
|
|
3991
|
-
* @public
|
|
3992
3991
|
* @deprecated
|
|
3993
3992
|
*
|
|
3994
3993
|
* <p>The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer
|
|
3995
3994
|
* your vehicle data to.</p>
|
|
3995
|
+
* @public
|
|
3996
3996
|
*/
|
|
3997
3997
|
timestreamResources?: TimestreamResources;
|
|
3998
3998
|
/**
|
|
3999
|
-
* @public
|
|
4000
3999
|
* @deprecated
|
|
4001
4000
|
*
|
|
4002
4001
|
* <p>The IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.</p>
|
|
4002
|
+
* @public
|
|
4003
4003
|
*/
|
|
4004
4004
|
iamResources?: IamResources;
|
|
4005
4005
|
}
|
|
@@ -4008,32 +4008,32 @@ export interface RegisterAccountRequest {
|
|
|
4008
4008
|
*/
|
|
4009
4009
|
export interface RegisterAccountResponse {
|
|
4010
4010
|
/**
|
|
4011
|
-
* @public
|
|
4012
4011
|
* <p> The status of registering your Amazon Web Services account, IAM role, and Timestream resources.
|
|
4013
4012
|
* </p>
|
|
4013
|
+
* @public
|
|
4014
4014
|
*/
|
|
4015
4015
|
registerAccountStatus: RegistrationStatus | undefined;
|
|
4016
4016
|
/**
|
|
4017
|
-
* @public
|
|
4018
4017
|
* <p>The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer
|
|
4019
4018
|
* your vehicle data to.</p>
|
|
4019
|
+
* @public
|
|
4020
4020
|
*/
|
|
4021
4021
|
timestreamResources?: TimestreamResources;
|
|
4022
4022
|
/**
|
|
4023
|
-
* @public
|
|
4024
4023
|
* <p> The registered IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream. </p>
|
|
4024
|
+
* @public
|
|
4025
4025
|
*/
|
|
4026
4026
|
iamResources: IamResources | undefined;
|
|
4027
4027
|
/**
|
|
4028
|
-
* @public
|
|
4029
4028
|
* <p> The time the account was registered, in seconds since epoch (January 1, 1970 at
|
|
4030
4029
|
* midnight UTC time). </p>
|
|
4030
|
+
* @public
|
|
4031
4031
|
*/
|
|
4032
4032
|
creationTime: Date | undefined;
|
|
4033
4033
|
/**
|
|
4034
|
-
* @public
|
|
4035
4034
|
* <p> The time this registration was last updated, in seconds since epoch (January 1, 1970
|
|
4036
4035
|
* at midnight UTC time). </p>
|
|
4036
|
+
* @public
|
|
4037
4037
|
*/
|
|
4038
4038
|
lastModificationTime: Date | undefined;
|
|
4039
4039
|
}
|
|
@@ -4058,24 +4058,24 @@ export type SignalNodeType = (typeof SignalNodeType)[keyof typeof SignalNodeType
|
|
|
4058
4058
|
*/
|
|
4059
4059
|
export interface ListSignalCatalogNodesRequest {
|
|
4060
4060
|
/**
|
|
4061
|
-
* @public
|
|
4062
4061
|
* <p> The name of the signal catalog to list information about. </p>
|
|
4062
|
+
* @public
|
|
4063
4063
|
*/
|
|
4064
4064
|
name: string | undefined;
|
|
4065
4065
|
/**
|
|
4066
|
-
* @public
|
|
4067
4066
|
* <p>A pagination token for the next set of results.</p>
|
|
4068
4067
|
* <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
|
|
4068
|
+
* @public
|
|
4069
4069
|
*/
|
|
4070
4070
|
nextToken?: string;
|
|
4071
4071
|
/**
|
|
4072
|
-
* @public
|
|
4073
4072
|
* <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
|
|
4073
|
+
* @public
|
|
4074
4074
|
*/
|
|
4075
4075
|
maxResults?: number;
|
|
4076
4076
|
/**
|
|
4077
|
-
* @public
|
|
4078
4077
|
* <p>The type of node in the signal catalog.</p>
|
|
4078
|
+
* @public
|
|
4079
4079
|
*/
|
|
4080
4080
|
signalNodeType?: SignalNodeType;
|
|
4081
4081
|
}
|
|
@@ -4084,13 +4084,13 @@ export interface ListSignalCatalogNodesRequest {
|
|
|
4084
4084
|
*/
|
|
4085
4085
|
export interface ListSignalCatalogNodesResponse {
|
|
4086
4086
|
/**
|
|
4087
|
-
* @public
|
|
4088
4087
|
* <p> A list of information about nodes. </p>
|
|
4088
|
+
* @public
|
|
4089
4089
|
*/
|
|
4090
4090
|
nodes?: Node[];
|
|
4091
4091
|
/**
|
|
4092
|
-
* @public
|
|
4093
4092
|
* <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
|
|
4093
|
+
* @public
|
|
4094
4094
|
*/
|
|
4095
4095
|
nextToken?: string;
|
|
4096
4096
|
}
|
|
@@ -4099,41 +4099,41 @@ export interface ListSignalCatalogNodesResponse {
|
|
|
4099
4099
|
*/
|
|
4100
4100
|
export interface ListSignalCatalogsRequest {
|
|
4101
4101
|
/**
|
|
4102
|
-
* @public
|
|
4103
4102
|
* <p>A pagination token for the next set of results.</p>
|
|
4104
4103
|
* <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
|
|
4104
|
+
* @public
|
|
4105
4105
|
*/
|
|
4106
4106
|
nextToken?: string;
|
|
4107
4107
|
/**
|
|
4108
|
-
* @public
|
|
4109
4108
|
* <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
|
|
4109
|
+
* @public
|
|
4110
4110
|
*/
|
|
4111
4111
|
maxResults?: number;
|
|
4112
4112
|
}
|
|
4113
4113
|
/**
|
|
4114
|
-
* @public
|
|
4115
4114
|
* <p>Information about a collection of standardized signals, which can be attributes,
|
|
4116
4115
|
* branches, sensors, or actuators.</p>
|
|
4116
|
+
* @public
|
|
4117
4117
|
*/
|
|
4118
4118
|
export interface SignalCatalogSummary {
|
|
4119
4119
|
/**
|
|
4120
|
-
* @public
|
|
4121
4120
|
* <p>The name of the signal catalog.</p>
|
|
4121
|
+
* @public
|
|
4122
4122
|
*/
|
|
4123
4123
|
name?: string;
|
|
4124
4124
|
/**
|
|
4125
|
-
* @public
|
|
4126
4125
|
* <p>The Amazon Resource Name (ARN) of the signal catalog.</p>
|
|
4126
|
+
* @public
|
|
4127
4127
|
*/
|
|
4128
4128
|
arn?: string;
|
|
4129
4129
|
/**
|
|
4130
|
-
* @public
|
|
4131
4130
|
* <p>The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time). </p>
|
|
4131
|
+
* @public
|
|
4132
4132
|
*/
|
|
4133
4133
|
creationTime?: Date;
|
|
4134
4134
|
/**
|
|
4135
|
-
* @public
|
|
4136
4135
|
* <p>The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). </p>
|
|
4136
|
+
* @public
|
|
4137
4137
|
*/
|
|
4138
4138
|
lastModificationTime?: Date;
|
|
4139
4139
|
}
|
|
@@ -4142,13 +4142,13 @@ export interface SignalCatalogSummary {
|
|
|
4142
4142
|
*/
|
|
4143
4143
|
export interface ListSignalCatalogsResponse {
|
|
4144
4144
|
/**
|
|
4145
|
-
* @public
|
|
4146
4145
|
* <p> A list of information about each signal catalog. </p>
|
|
4146
|
+
* @public
|
|
4147
4147
|
*/
|
|
4148
4148
|
summaries?: SignalCatalogSummary[];
|
|
4149
4149
|
/**
|
|
4150
|
-
* @public
|
|
4151
4150
|
* <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
|
|
4151
|
+
* @public
|
|
4152
4152
|
*/
|
|
4153
4153
|
nextToken?: string;
|
|
4154
4154
|
}
|
|
@@ -4157,29 +4157,29 @@ export interface ListSignalCatalogsResponse {
|
|
|
4157
4157
|
*/
|
|
4158
4158
|
export interface UpdateSignalCatalogRequest {
|
|
4159
4159
|
/**
|
|
4160
|
-
* @public
|
|
4161
4160
|
* <p> The name of the signal catalog to update. </p>
|
|
4161
|
+
* @public
|
|
4162
4162
|
*/
|
|
4163
4163
|
name: string | undefined;
|
|
4164
4164
|
/**
|
|
4165
|
-
* @public
|
|
4166
4165
|
* <p> A brief description of the signal catalog to update.</p>
|
|
4166
|
+
* @public
|
|
4167
4167
|
*/
|
|
4168
4168
|
description?: string;
|
|
4169
4169
|
/**
|
|
4170
|
-
* @public
|
|
4171
4170
|
* <p> A list of information about nodes to add to the signal catalog. </p>
|
|
4171
|
+
* @public
|
|
4172
4172
|
*/
|
|
4173
4173
|
nodesToAdd?: Node[];
|
|
4174
4174
|
/**
|
|
4175
|
-
* @public
|
|
4176
4175
|
* <p> A list of information about nodes to update in the signal catalog. </p>
|
|
4176
|
+
* @public
|
|
4177
4177
|
*/
|
|
4178
4178
|
nodesToUpdate?: Node[];
|
|
4179
4179
|
/**
|
|
4180
|
-
* @public
|
|
4181
4180
|
* <p> A list of <code>fullyQualifiedName</code> of nodes to remove from the signal catalog.
|
|
4182
4181
|
* </p>
|
|
4182
|
+
* @public
|
|
4183
4183
|
*/
|
|
4184
4184
|
nodesToRemove?: string[];
|
|
4185
4185
|
}
|
|
@@ -4188,13 +4188,13 @@ export interface UpdateSignalCatalogRequest {
|
|
|
4188
4188
|
*/
|
|
4189
4189
|
export interface UpdateSignalCatalogResponse {
|
|
4190
4190
|
/**
|
|
4191
|
-
* @public
|
|
4192
4191
|
* <p> The name of the updated signal catalog. </p>
|
|
4192
|
+
* @public
|
|
4193
4193
|
*/
|
|
4194
4194
|
name: string | undefined;
|
|
4195
4195
|
/**
|
|
4196
|
-
* @public
|
|
4197
4196
|
* <p> The ARN of the updated signal catalog. </p>
|
|
4197
|
+
* @public
|
|
4198
4198
|
*/
|
|
4199
4199
|
arn: string | undefined;
|
|
4200
4200
|
}
|
|
@@ -4203,13 +4203,13 @@ export interface UpdateSignalCatalogResponse {
|
|
|
4203
4203
|
*/
|
|
4204
4204
|
export interface TagResourceRequest {
|
|
4205
4205
|
/**
|
|
4206
|
-
* @public
|
|
4207
4206
|
* <p>The ARN of the resource.</p>
|
|
4207
|
+
* @public
|
|
4208
4208
|
*/
|
|
4209
4209
|
ResourceARN: string | undefined;
|
|
4210
4210
|
/**
|
|
4211
|
-
* @public
|
|
4212
4211
|
* <p>The new or modified tags for the resource.</p>
|
|
4212
|
+
* @public
|
|
4213
4213
|
*/
|
|
4214
4214
|
Tags: Tag[] | undefined;
|
|
4215
4215
|
}
|
|
@@ -4223,13 +4223,13 @@ export interface TagResourceResponse {
|
|
|
4223
4223
|
*/
|
|
4224
4224
|
export interface UntagResourceRequest {
|
|
4225
4225
|
/**
|
|
4226
|
-
* @public
|
|
4227
4226
|
* <p>The ARN of the resource.</p>
|
|
4227
|
+
* @public
|
|
4228
4228
|
*/
|
|
4229
4229
|
ResourceARN: string | undefined;
|
|
4230
4230
|
/**
|
|
4231
|
-
* @public
|
|
4232
4231
|
* <p>A list of the keys of the tags to be removed from the resource.</p>
|
|
4232
|
+
* @public
|
|
4233
4233
|
*/
|
|
4234
4234
|
TagKeys: string[] | undefined;
|
|
4235
4235
|
}
|
|
@@ -4243,65 +4243,65 @@ export interface UntagResourceResponse {
|
|
|
4243
4243
|
*/
|
|
4244
4244
|
export interface ListVehiclesRequest {
|
|
4245
4245
|
/**
|
|
4246
|
-
* @public
|
|
4247
4246
|
* <p> The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use this optional
|
|
4248
4247
|
* parameter to list only the vehicles created from a certain vehicle model. </p>
|
|
4248
|
+
* @public
|
|
4249
4249
|
*/
|
|
4250
4250
|
modelManifestArn?: string;
|
|
4251
4251
|
/**
|
|
4252
|
-
* @public
|
|
4253
4252
|
* <p>A pagination token for the next set of results.</p>
|
|
4254
4253
|
* <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
|
|
4254
|
+
* @public
|
|
4255
4255
|
*/
|
|
4256
4256
|
nextToken?: string;
|
|
4257
4257
|
/**
|
|
4258
|
-
* @public
|
|
4259
4258
|
* <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
|
|
4259
|
+
* @public
|
|
4260
4260
|
*/
|
|
4261
4261
|
maxResults?: number;
|
|
4262
4262
|
}
|
|
4263
4263
|
/**
|
|
4264
|
-
* @public
|
|
4265
4264
|
* <p>Information about a vehicle.</p>
|
|
4266
4265
|
* <p>To return this information about vehicles in your account, you can use the API operation.</p>
|
|
4266
|
+
* @public
|
|
4267
4267
|
*/
|
|
4268
4268
|
export interface VehicleSummary {
|
|
4269
4269
|
/**
|
|
4270
|
-
* @public
|
|
4271
4270
|
* <p>The unique ID of the vehicle.</p>
|
|
4271
|
+
* @public
|
|
4272
4272
|
*/
|
|
4273
4273
|
vehicleName: string | undefined;
|
|
4274
4274
|
/**
|
|
4275
|
-
* @public
|
|
4276
4275
|
* <p>The Amazon Resource Name (ARN) of the vehicle.</p>
|
|
4276
|
+
* @public
|
|
4277
4277
|
*/
|
|
4278
4278
|
arn: string | undefined;
|
|
4279
4279
|
/**
|
|
4280
|
-
* @public
|
|
4281
4280
|
* <p>The ARN of a vehicle model (model manifest) associated with the vehicle.</p>
|
|
4281
|
+
* @public
|
|
4282
4282
|
*/
|
|
4283
4283
|
modelManifestArn: string | undefined;
|
|
4284
4284
|
/**
|
|
4285
|
-
* @public
|
|
4286
4285
|
* <p>The ARN of a decoder manifest associated with the vehicle.</p>
|
|
4286
|
+
* @public
|
|
4287
4287
|
*/
|
|
4288
4288
|
decoderManifestArn: string | undefined;
|
|
4289
4289
|
/**
|
|
4290
|
-
* @public
|
|
4291
4290
|
* <p>The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).</p>
|
|
4291
|
+
* @public
|
|
4292
4292
|
*/
|
|
4293
4293
|
creationTime: Date | undefined;
|
|
4294
4294
|
/**
|
|
4295
|
-
* @public
|
|
4296
4295
|
* <p>The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). </p>
|
|
4296
|
+
* @public
|
|
4297
4297
|
*/
|
|
4298
4298
|
lastModificationTime: Date | undefined;
|
|
4299
4299
|
/**
|
|
4300
|
-
* @public
|
|
4301
4300
|
* <p>Static information about a vehicle in a key-value pair. For example:</p>
|
|
4302
4301
|
* <p>
|
|
4303
4302
|
* <code>"engineType"</code> : <code>"1.3 L R2"</code>
|
|
4304
4303
|
* </p>
|
|
4304
|
+
* @public
|
|
4305
4305
|
*/
|
|
4306
4306
|
attributes?: Record<string, string>;
|
|
4307
4307
|
}
|
|
@@ -4310,13 +4310,13 @@ export interface VehicleSummary {
|
|
|
4310
4310
|
*/
|
|
4311
4311
|
export interface ListVehiclesResponse {
|
|
4312
4312
|
/**
|
|
4313
|
-
* @public
|
|
4314
4313
|
* <p> A list of vehicles and information about them. </p>
|
|
4314
|
+
* @public
|
|
4315
4315
|
*/
|
|
4316
4316
|
vehicleSummaries?: VehicleSummary[];
|
|
4317
4317
|
/**
|
|
4318
|
-
* @public
|
|
4319
4318
|
* <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
|
|
4319
|
+
* @public
|
|
4320
4320
|
*/
|
|
4321
4321
|
nextToken?: string;
|
|
4322
4322
|
}
|
|
@@ -4325,34 +4325,34 @@ export interface ListVehiclesResponse {
|
|
|
4325
4325
|
*/
|
|
4326
4326
|
export interface UpdateVehicleRequest {
|
|
4327
4327
|
/**
|
|
4328
|
-
* @public
|
|
4329
4328
|
* <p>The unique ID of the vehicle to update.</p>
|
|
4329
|
+
* @public
|
|
4330
4330
|
*/
|
|
4331
4331
|
vehicleName: string | undefined;
|
|
4332
4332
|
/**
|
|
4333
|
-
* @public
|
|
4334
4333
|
* <p>The ARN of a vehicle model (model manifest) associated with the vehicle.</p>
|
|
4334
|
+
* @public
|
|
4335
4335
|
*/
|
|
4336
4336
|
modelManifestArn?: string;
|
|
4337
4337
|
/**
|
|
4338
|
-
* @public
|
|
4339
4338
|
* <p>The ARN of the decoder manifest associated with this vehicle.</p>
|
|
4339
|
+
* @public
|
|
4340
4340
|
*/
|
|
4341
4341
|
decoderManifestArn?: string;
|
|
4342
4342
|
/**
|
|
4343
|
-
* @public
|
|
4344
4343
|
* <p>Static information about a vehicle in a key-value pair. For example:</p>
|
|
4345
4344
|
* <p>
|
|
4346
4345
|
* <code>"engineType"</code> : <code>"1.3 L R2"</code>
|
|
4347
4346
|
* </p>
|
|
4347
|
+
* @public
|
|
4348
4348
|
*/
|
|
4349
4349
|
attributes?: Record<string, string>;
|
|
4350
4350
|
/**
|
|
4351
|
-
* @public
|
|
4352
4351
|
* <p>The method the specified attributes will update the existing attributes on the
|
|
4353
4352
|
* vehicle. Use<code>Overwite</code> to replace the vehicle attributes with the specified
|
|
4354
4353
|
* attributes. Or use <code>Merge</code> to combine all attributes.</p>
|
|
4355
4354
|
* <p>This is required if attributes are present in the input.</p>
|
|
4355
|
+
* @public
|
|
4356
4356
|
*/
|
|
4357
4357
|
attributeUpdateMode?: UpdateMode;
|
|
4358
4358
|
}
|
|
@@ -4361,19 +4361,19 @@ export interface UpdateVehicleRequest {
|
|
|
4361
4361
|
*/
|
|
4362
4362
|
export interface UpdateVehicleResponse {
|
|
4363
4363
|
/**
|
|
4364
|
-
* @public
|
|
4365
4364
|
* <p>The ID of the updated vehicle.</p>
|
|
4365
|
+
* @public
|
|
4366
4366
|
*/
|
|
4367
4367
|
vehicleName?: string;
|
|
4368
4368
|
/**
|
|
4369
|
-
* @public
|
|
4370
4369
|
* <p>The ARN of the updated vehicle.</p>
|
|
4370
|
+
* @public
|
|
4371
4371
|
*/
|
|
4372
4372
|
arn?: string;
|
|
4373
4373
|
}
|
|
4374
4374
|
/**
|
|
4375
|
-
* @public
|
|
4376
4375
|
* <p>The structured message for the message signal. It can be defined with either a <code>primitiveMessageDefinition</code>, <code>structuredMessageListDefinition</code>, or <code>structuredMessageDefinition</code> recursively.</p>
|
|
4376
|
+
* @public
|
|
4377
4377
|
*/
|
|
4378
4378
|
export type StructuredMessage = StructuredMessage.PrimitiveMessageDefinitionMember | StructuredMessage.StructuredMessageDefinitionMember | StructuredMessage.StructuredMessageListDefinitionMember | StructuredMessage.$UnknownMember;
|
|
4379
4379
|
/**
|
|
@@ -4381,8 +4381,8 @@ export type StructuredMessage = StructuredMessage.PrimitiveMessageDefinitionMemb
|
|
|
4381
4381
|
*/
|
|
4382
4382
|
export declare namespace StructuredMessage {
|
|
4383
4383
|
/**
|
|
4384
|
-
* @public
|
|
4385
4384
|
* <p>Represents a primitive type node of the complex data structure.</p>
|
|
4385
|
+
* @public
|
|
4386
4386
|
*/
|
|
4387
4387
|
interface PrimitiveMessageDefinitionMember {
|
|
4388
4388
|
primitiveMessageDefinition: PrimitiveMessageDefinition;
|
|
@@ -4391,8 +4391,8 @@ export declare namespace StructuredMessage {
|
|
|
4391
4391
|
$unknown?: never;
|
|
4392
4392
|
}
|
|
4393
4393
|
/**
|
|
4394
|
-
* @public
|
|
4395
4394
|
* <p>Represents a list type node of the complex data structure.</p>
|
|
4395
|
+
* @public
|
|
4396
4396
|
*/
|
|
4397
4397
|
interface StructuredMessageListDefinitionMember {
|
|
4398
4398
|
primitiveMessageDefinition?: never;
|
|
@@ -4401,8 +4401,8 @@ export declare namespace StructuredMessage {
|
|
|
4401
4401
|
$unknown?: never;
|
|
4402
4402
|
}
|
|
4403
4403
|
/**
|
|
4404
|
-
* @public
|
|
4405
4404
|
* <p>Represents a struct type node of the complex data structure.</p>
|
|
4405
|
+
* @public
|
|
4406
4406
|
*/
|
|
4407
4407
|
interface StructuredMessageDefinitionMember {
|
|
4408
4408
|
primitiveMessageDefinition?: never;
|
|
@@ -4428,99 +4428,99 @@ export declare namespace StructuredMessage {
|
|
|
4428
4428
|
const visit: <T>(value: StructuredMessage, visitor: Visitor<T>) => T;
|
|
4429
4429
|
}
|
|
4430
4430
|
/**
|
|
4431
|
-
* @public
|
|
4432
4431
|
* <p>Represents a <code>StructureMessageName</code> to <code>DataType</code> map element.</p>
|
|
4432
|
+
* @public
|
|
4433
4433
|
*/
|
|
4434
4434
|
export interface StructuredMessageFieldNameAndDataTypePair {
|
|
4435
4435
|
/**
|
|
4436
|
-
* @public
|
|
4437
4436
|
* <p>The field name of the structured message. It determines how a data value is referenced in the target language. </p>
|
|
4437
|
+
* @public
|
|
4438
4438
|
*/
|
|
4439
4439
|
fieldName: string | undefined;
|
|
4440
4440
|
/**
|
|
4441
|
-
* @public
|
|
4442
4441
|
* <p>The data type. </p>
|
|
4442
|
+
* @public
|
|
4443
4443
|
*/
|
|
4444
4444
|
dataType: StructuredMessage | undefined;
|
|
4445
4445
|
}
|
|
4446
4446
|
/**
|
|
4447
|
-
* @public
|
|
4448
4447
|
* <p>Represents a list type node of the complex data structure.</p>
|
|
4448
|
+
* @public
|
|
4449
4449
|
*/
|
|
4450
4450
|
export interface StructuredMessageListDefinition {
|
|
4451
4451
|
/**
|
|
4452
|
-
* @public
|
|
4453
4452
|
* <p>The name of the structured message list definition. </p>
|
|
4453
|
+
* @public
|
|
4454
4454
|
*/
|
|
4455
4455
|
name: string | undefined;
|
|
4456
4456
|
/**
|
|
4457
|
-
* @public
|
|
4458
4457
|
* <p>The member type of the structured message list definition.</p>
|
|
4458
|
+
* @public
|
|
4459
4459
|
*/
|
|
4460
4460
|
memberType: StructuredMessage | undefined;
|
|
4461
4461
|
/**
|
|
4462
|
-
* @public
|
|
4463
4462
|
* <p>The type of list of the structured message list definition.</p>
|
|
4463
|
+
* @public
|
|
4464
4464
|
*/
|
|
4465
4465
|
listType: StructuredMessageListType | undefined;
|
|
4466
4466
|
/**
|
|
4467
|
-
* @public
|
|
4468
4467
|
* <p>The capacity of the structured message list definition when the list type is <code>FIXED_CAPACITY</code> or <code>DYNAMIC_BOUNDED_CAPACITY</code>.</p>
|
|
4468
|
+
* @public
|
|
4469
4469
|
*/
|
|
4470
4470
|
capacity?: number;
|
|
4471
4471
|
}
|
|
4472
4472
|
/**
|
|
4473
|
-
* @public
|
|
4474
4473
|
* <p>The decoding information for a specific message which support higher order data types. </p>
|
|
4474
|
+
* @public
|
|
4475
4475
|
*/
|
|
4476
4476
|
export interface MessageSignal {
|
|
4477
4477
|
/**
|
|
4478
|
-
* @public
|
|
4479
4478
|
* <p>The topic name for the message signal. It corresponds to topics in ROS 2. </p>
|
|
4479
|
+
* @public
|
|
4480
4480
|
*/
|
|
4481
4481
|
topicName: string | undefined;
|
|
4482
4482
|
/**
|
|
4483
|
-
* @public
|
|
4484
4483
|
* <p>The structured message for the message signal. It can be defined with either a <code>primitiveMessageDefinition</code>, <code>structuredMessageListDefinition</code>, or <code>structuredMessageDefinition</code> recursively.</p>
|
|
4484
|
+
* @public
|
|
4485
4485
|
*/
|
|
4486
4486
|
structuredMessage: StructuredMessage | undefined;
|
|
4487
4487
|
}
|
|
4488
4488
|
/**
|
|
4489
|
-
* @public
|
|
4490
4489
|
* <p>Information about a signal decoder.</p>
|
|
4490
|
+
* @public
|
|
4491
4491
|
*/
|
|
4492
4492
|
export interface SignalDecoder {
|
|
4493
4493
|
/**
|
|
4494
|
-
* @public
|
|
4495
4494
|
* <p>The fully qualified name of a signal decoder as defined in a vehicle model.</p>
|
|
4495
|
+
* @public
|
|
4496
4496
|
*/
|
|
4497
4497
|
fullyQualifiedName: string | undefined;
|
|
4498
4498
|
/**
|
|
4499
|
-
* @public
|
|
4500
4499
|
* <p>The network protocol for the vehicle. For example, <code>CAN_SIGNAL</code> specifies
|
|
4501
4500
|
* a protocol that defines how data is communicated between electronic control units
|
|
4502
4501
|
* (ECUs). <code>OBD_SIGNAL</code> specifies a protocol that defines how self-diagnostic
|
|
4503
4502
|
* data is communicated between ECUs.</p>
|
|
4503
|
+
* @public
|
|
4504
4504
|
*/
|
|
4505
4505
|
type: SignalDecoderType | undefined;
|
|
4506
4506
|
/**
|
|
4507
|
-
* @public
|
|
4508
4507
|
* <p>The ID of a network interface that specifies what network protocol a vehicle follows.</p>
|
|
4508
|
+
* @public
|
|
4509
4509
|
*/
|
|
4510
4510
|
interfaceId: string | undefined;
|
|
4511
4511
|
/**
|
|
4512
|
-
* @public
|
|
4513
4512
|
* <p>Information about signal decoder using the Controller Area Network (CAN) protocol.</p>
|
|
4513
|
+
* @public
|
|
4514
4514
|
*/
|
|
4515
4515
|
canSignal?: CanSignal;
|
|
4516
4516
|
/**
|
|
4517
|
-
* @public
|
|
4518
4517
|
* <p>Information about signal decoder using the On-board diagnostic (OBD) II protocol.</p>
|
|
4518
|
+
* @public
|
|
4519
4519
|
*/
|
|
4520
4520
|
obdSignal?: ObdSignal;
|
|
4521
4521
|
/**
|
|
4522
|
-
* @public
|
|
4523
4522
|
* <p>The decoding information for a specific message which supports higher order data types. </p>
|
|
4523
|
+
* @public
|
|
4524
4524
|
*/
|
|
4525
4525
|
messageSignal?: MessageSignal;
|
|
4526
4526
|
}
|
|
@@ -4529,33 +4529,33 @@ export interface SignalDecoder {
|
|
|
4529
4529
|
*/
|
|
4530
4530
|
export interface CreateDecoderManifestRequest {
|
|
4531
4531
|
/**
|
|
4532
|
-
* @public
|
|
4533
4532
|
* <p> The unique name of the decoder manifest to create.</p>
|
|
4533
|
+
* @public
|
|
4534
4534
|
*/
|
|
4535
4535
|
name: string | undefined;
|
|
4536
4536
|
/**
|
|
4537
|
-
* @public
|
|
4538
4537
|
* <p> A brief description of the decoder manifest. </p>
|
|
4538
|
+
* @public
|
|
4539
4539
|
*/
|
|
4540
4540
|
description?: string;
|
|
4541
4541
|
/**
|
|
4542
|
-
* @public
|
|
4543
4542
|
* <p> The Amazon Resource Name (ARN) of the vehicle model (model manifest). </p>
|
|
4543
|
+
* @public
|
|
4544
4544
|
*/
|
|
4545
4545
|
modelManifestArn: string | undefined;
|
|
4546
4546
|
/**
|
|
4547
|
-
* @public
|
|
4548
4547
|
* <p> A list of information about signal decoders. </p>
|
|
4548
|
+
* @public
|
|
4549
4549
|
*/
|
|
4550
4550
|
signalDecoders?: SignalDecoder[];
|
|
4551
4551
|
/**
|
|
4552
|
-
* @public
|
|
4553
4552
|
* <p> A list of information about available network interfaces. </p>
|
|
4553
|
+
* @public
|
|
4554
4554
|
*/
|
|
4555
4555
|
networkInterfaces?: NetworkInterface[];
|
|
4556
4556
|
/**
|
|
4557
|
-
* @public
|
|
4558
4557
|
* <p>Metadata that can be used to manage the decoder manifest.</p>
|
|
4558
|
+
* @public
|
|
4559
4559
|
*/
|
|
4560
4560
|
tags?: Tag[];
|
|
4561
4561
|
}
|
|
@@ -4564,13 +4564,13 @@ export interface CreateDecoderManifestRequest {
|
|
|
4564
4564
|
*/
|
|
4565
4565
|
export interface ListDecoderManifestSignalsResponse {
|
|
4566
4566
|
/**
|
|
4567
|
-
* @public
|
|
4568
4567
|
* <p> Information about a list of signals to decode. </p>
|
|
4568
|
+
* @public
|
|
4569
4569
|
*/
|
|
4570
4570
|
signalDecoders?: SignalDecoder[];
|
|
4571
4571
|
/**
|
|
4572
|
-
* @public
|
|
4573
4572
|
* <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
|
|
4573
|
+
* @public
|
|
4574
4574
|
*/
|
|
4575
4575
|
nextToken?: string;
|
|
4576
4576
|
}
|
|
@@ -4579,54 +4579,54 @@ export interface ListDecoderManifestSignalsResponse {
|
|
|
4579
4579
|
*/
|
|
4580
4580
|
export interface UpdateDecoderManifestRequest {
|
|
4581
4581
|
/**
|
|
4582
|
-
* @public
|
|
4583
4582
|
* <p> The name of the decoder manifest to update.</p>
|
|
4583
|
+
* @public
|
|
4584
4584
|
*/
|
|
4585
4585
|
name: string | undefined;
|
|
4586
4586
|
/**
|
|
4587
|
-
* @public
|
|
4588
4587
|
* <p> A brief description of the decoder manifest to update. </p>
|
|
4588
|
+
* @public
|
|
4589
4589
|
*/
|
|
4590
4590
|
description?: string;
|
|
4591
4591
|
/**
|
|
4592
|
-
* @public
|
|
4593
4592
|
* <p> A list of information about decoding additional signals to add to the decoder
|
|
4594
4593
|
* manifest. </p>
|
|
4594
|
+
* @public
|
|
4595
4595
|
*/
|
|
4596
4596
|
signalDecodersToAdd?: SignalDecoder[];
|
|
4597
4597
|
/**
|
|
4598
|
-
* @public
|
|
4599
4598
|
* <p> A list of updated information about decoding signals to update in the decoder
|
|
4600
4599
|
* manifest. </p>
|
|
4600
|
+
* @public
|
|
4601
4601
|
*/
|
|
4602
4602
|
signalDecodersToUpdate?: SignalDecoder[];
|
|
4603
4603
|
/**
|
|
4604
|
-
* @public
|
|
4605
4604
|
* <p> A list of signal decoders to remove from the decoder manifest. </p>
|
|
4605
|
+
* @public
|
|
4606
4606
|
*/
|
|
4607
4607
|
signalDecodersToRemove?: string[];
|
|
4608
4608
|
/**
|
|
4609
|
-
* @public
|
|
4610
4609
|
* <p> A list of information about the network interfaces to add to the decoder manifest.
|
|
4611
4610
|
* </p>
|
|
4611
|
+
* @public
|
|
4612
4612
|
*/
|
|
4613
4613
|
networkInterfacesToAdd?: NetworkInterface[];
|
|
4614
4614
|
/**
|
|
4615
|
-
* @public
|
|
4616
4615
|
* <p> A list of information about the network interfaces to update in the decoder manifest.
|
|
4617
4616
|
* </p>
|
|
4617
|
+
* @public
|
|
4618
4618
|
*/
|
|
4619
4619
|
networkInterfacesToUpdate?: NetworkInterface[];
|
|
4620
4620
|
/**
|
|
4621
|
-
* @public
|
|
4622
4621
|
* <p> A list of network interfaces to remove from the decoder manifest.</p>
|
|
4622
|
+
* @public
|
|
4623
4623
|
*/
|
|
4624
4624
|
networkInterfacesToRemove?: string[];
|
|
4625
4625
|
/**
|
|
4626
|
-
* @public
|
|
4627
4626
|
* <p> The state of the decoder manifest. If the status is <code>ACTIVE</code>, the decoder
|
|
4628
4627
|
* manifest can't be edited. If the status is <code>DRAFT</code>, you can edit the decoder
|
|
4629
4628
|
* manifest. </p>
|
|
4629
|
+
* @public
|
|
4630
4630
|
*/
|
|
4631
4631
|
status?: ManifestStatus;
|
|
4632
4632
|
}
|