@aws-sdk/client-iotsitewise 3.859.0 → 3.860.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/README.md +32 -0
  2. package/dist-cjs/index.js +271 -39
  3. package/dist-es/IoTSiteWise.js +8 -0
  4. package/dist-es/commands/DeleteAssetModelInterfaceRelationshipCommand.js +22 -0
  5. package/dist-es/commands/DescribeAssetModelInterfaceRelationshipCommand.js +22 -0
  6. package/dist-es/commands/InvokeAssistantCommand.js +2 -1
  7. package/dist-es/commands/ListInterfaceRelationshipsCommand.js +22 -0
  8. package/dist-es/commands/PutAssetModelInterfaceRelationshipCommand.js +22 -0
  9. package/dist-es/commands/index.js +4 -0
  10. package/dist-es/models/models_0.js +1 -50
  11. package/dist-es/models/models_1.js +50 -0
  12. package/dist-es/pagination/ListInterfaceRelationshipsPaginator.js +4 -0
  13. package/dist-es/pagination/index.js +1 -0
  14. package/dist-es/protocols/Aws_restJson1.js +151 -0
  15. package/dist-types/IoTSiteWise.d.ts +28 -0
  16. package/dist-types/IoTSiteWiseClient.d.ts +6 -2
  17. package/dist-types/commands/CreateAssetModelCommand.d.ts +12 -7
  18. package/dist-types/commands/CreateAssetModelCompositeModelCommand.d.ts +2 -2
  19. package/dist-types/commands/CreateBulkImportJobCommand.d.ts +2 -2
  20. package/dist-types/commands/DeleteAssetModelInterfaceRelationshipCommand.d.ts +110 -0
  21. package/dist-types/commands/DescribeAssetModelCommand.d.ts +13 -6
  22. package/dist-types/commands/DescribeAssetModelCompositeModelCommand.d.ts +2 -2
  23. package/dist-types/commands/DescribeAssetModelInterfaceRelationshipCommand.d.ts +103 -0
  24. package/dist-types/commands/DescribeAssetPropertyCommand.d.ts +4 -4
  25. package/dist-types/commands/InvokeAssistantCommand.d.ts +2 -1
  26. package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +8 -2
  27. package/dist-types/commands/ListAssetModelsCommand.d.ts +2 -2
  28. package/dist-types/commands/ListComputationModelDataBindingUsagesCommand.d.ts +3 -6
  29. package/dist-types/commands/ListComputationModelResolveToResourcesCommand.d.ts +2 -1
  30. package/dist-types/commands/ListInterfaceRelationshipsCommand.d.ts +96 -0
  31. package/dist-types/commands/PutAssetModelInterfaceRelationshipCommand.d.ts +126 -0
  32. package/dist-types/commands/UpdateAssetModelCommand.d.ts +4 -4
  33. package/dist-types/commands/UpdateAssetModelCompositeModelCommand.d.ts +2 -2
  34. package/dist-types/commands/index.d.ts +4 -0
  35. package/dist-types/models/models_0.d.ts +245 -361
  36. package/dist-types/models/models_1.d.ts +494 -41
  37. package/dist-types/pagination/ListInterfaceRelationshipsPaginator.d.ts +7 -0
  38. package/dist-types/pagination/index.d.ts +1 -0
  39. package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
  40. package/dist-types/ts3.4/IoTSiteWise.d.ts +86 -0
  41. package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +24 -0
  42. package/dist-types/ts3.4/commands/DeleteAssetModelInterfaceRelationshipCommand.d.ts +51 -0
  43. package/dist-types/ts3.4/commands/DescribeAssetModelInterfaceRelationshipCommand.d.ts +51 -0
  44. package/dist-types/ts3.4/commands/InvokeAssistantCommand.d.ts +2 -4
  45. package/dist-types/ts3.4/commands/ListInterfaceRelationshipsCommand.d.ts +51 -0
  46. package/dist-types/ts3.4/commands/PutAssetModelInterfaceRelationshipCommand.d.ts +51 -0
  47. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  48. package/dist-types/ts3.4/models/models_0.d.ts +41 -180
  49. package/dist-types/ts3.4/models/models_1.d.ts +217 -0
  50. package/dist-types/ts3.4/pagination/ListInterfaceRelationshipsPaginator.d.ts +11 -0
  51. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  52. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +48 -0
  53. package/package.json +1 -1
@@ -1,6 +1,300 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { IoTSiteWiseServiceException as __BaseException } from "./IoTSiteWiseServiceException";
3
- import { AccessPolicySummary, ActionDefinition, ActionSummary, Alarms, AssetBindingValueFilter, AssetModelBindingValueFilter, AssetModelCompositeModel, AssetModelCompositeModelPathSegment, AssetModelCompositeModelSummary, AssetModelHierarchy, AssetModelProperty, AssetModelPropertyBindingValue, AssetModelPropertyBindingValueFilter, AssetModelPropertySummary, AssetModelStatus, AssetModelSummary, AssetModelType, AssetModelVersionType, AssetPropertyBindingValue, AssetPropertyBindingValueFilter, AssetPropertySummary, AssetRelationshipSummary, AssetStatus, AssetSummary, AssociatedAssetsSummary, CapabilitySyncStatus, ColumnInfo, ComputationModelConfiguration, ComputationModelStatus, ConfigurationStatus, DatasetSource, DatasetSourceType, DatasetStatus, DisassociatedDataStorageState, EncryptionType, ExecutionStatus, GatewayCapabilitySummary, GatewayPlatform, Identity, ImageFile, JobStatus, LoggingOptions, MultiLayerStorage, Permission, PortalStatus, PortalType, PortalTypeEntry, PropertyDataType, PropertyNotificationState, ResolveTo, ResolveToResourceType, Resource, RetentionPeriod, StorageType, TargetResource, WarmTierRetentionPeriod, WarmTierState } from "./models_0";
3
+ import { AccessDeniedException, AccessPolicySummary, ActionDefinition, ActionSummary, Alarms, AssetBindingValueFilter, AssetModelBindingValueFilter, AssetModelCompositeModel, AssetModelCompositeModelPathSegment, AssetModelCompositeModelSummary, AssetModelHierarchy, AssetModelProperty, AssetModelPropertyBindingValue, AssetModelPropertyBindingValueFilter, AssetModelPropertySummary, AssetModelStatus, AssetModelSummary, AssetModelType, AssetModelVersionType, AssetPropertyBindingValue, AssetPropertyBindingValueFilter, AssetPropertySummary, AssetRelationshipSummary, AssetStatus, AssetSummary, AssociatedAssetsSummary, CapabilitySyncStatus, ColumnInfo, ComputationModelConfiguration, ComputationModelStatus, ConfigurationStatus, ConflictingOperationException, Content, DatasetSource, DatasetSourceType, DatasetStatus, DisassociatedDataStorageState, EncryptionType, ExecutionStatus, GatewayCapabilitySummary, GatewayPlatform, Identity, ImageFile, InternalFailureException, InvalidRequestException, JobStatus, LimitExceededException, Location, LoggingOptions, MultiLayerStorage, Permission, PortalStatus, PortalType, PortalTypeEntry, PropertyDataType, PropertyMapping, PropertyNotificationState, ResolveTo, ResolveToResourceType, Resource, ResourceNotFoundException, RetentionPeriod, StorageType, TargetResource, ThrottlingException, WarmTierRetentionPeriod, WarmTierState } from "./models_0";
4
+ /**
5
+ * <p>The data source for the dataset.</p>
6
+ * @public
7
+ */
8
+ export interface Source {
9
+ /**
10
+ * <p>Contains the ARN of the dataset. If the source is Kendra, it's the ARN of the Kendra index.</p>
11
+ * @public
12
+ */
13
+ arn?: string | undefined;
14
+ /**
15
+ * <p>Contains the location information where the cited text is originally stored.
16
+ * For example, if the data source is Kendra, and the text synchronized is from an S3 bucket, then the location refers to an S3 object.</p>
17
+ * @public
18
+ */
19
+ location?: Location | undefined;
20
+ }
21
+ /**
22
+ * <p>Contains information about the dataset use and it's source.</p>
23
+ * @public
24
+ */
25
+ export interface DataSetReference {
26
+ /**
27
+ * <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">ARN</a> of the dataset.
28
+ * The format is <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:dataset/$\{DatasetId\}</code>.</p>
29
+ * @public
30
+ */
31
+ datasetArn?: string | undefined;
32
+ /**
33
+ * <p>The data source for the dataset.</p>
34
+ * @public
35
+ */
36
+ source?: Source | undefined;
37
+ }
38
+ /**
39
+ * <p>Contains the reference information.</p>
40
+ * @public
41
+ */
42
+ export interface Reference {
43
+ /**
44
+ * <p>Contains the dataset reference information.</p>
45
+ * @public
46
+ */
47
+ dataset?: DataSetReference | undefined;
48
+ }
49
+ /**
50
+ * <p>Contains text content to which the SiteWise Assistant refers to, and generate the final response.
51
+ * It also contains information about the source.</p>
52
+ * @public
53
+ */
54
+ export interface Citation {
55
+ /**
56
+ * <p>Contains information about the data source.</p>
57
+ * @public
58
+ */
59
+ reference?: Reference | undefined;
60
+ /**
61
+ * <p>Contains the cited text from the data source.</p>
62
+ * @public
63
+ */
64
+ content?: Content | undefined;
65
+ }
66
+ /**
67
+ * <p>This contains the SiteWise Assistant's response and the corresponding citation.</p>
68
+ * @public
69
+ */
70
+ export interface InvocationOutput {
71
+ /**
72
+ * <p>The text message of the SiteWise Assistant's response.</p>
73
+ * @public
74
+ */
75
+ message?: string | undefined;
76
+ /**
77
+ * <p>A list of citations, and related information for the SiteWise Assistant's response.</p>
78
+ * @public
79
+ */
80
+ citations?: Citation[] | undefined;
81
+ }
82
+ /**
83
+ * <p>Contains tracing information of the SiteWise Assistant's reasoning and data access.</p>
84
+ * @public
85
+ */
86
+ export interface Trace {
87
+ /**
88
+ * <p>The cited text from the data source.</p>
89
+ * @public
90
+ */
91
+ text?: string | undefined;
92
+ }
93
+ /**
94
+ * <p>Contains the response, citation, and trace from the SiteWise Assistant.</p>
95
+ * @public
96
+ */
97
+ export type ResponseStream = ResponseStream.AccessDeniedExceptionMember | ResponseStream.ConflictingOperationExceptionMember | ResponseStream.InternalFailureExceptionMember | ResponseStream.InvalidRequestExceptionMember | ResponseStream.LimitExceededExceptionMember | ResponseStream.OutputMember | ResponseStream.ResourceNotFoundExceptionMember | ResponseStream.ThrottlingExceptionMember | ResponseStream.TraceMember | ResponseStream.$UnknownMember;
98
+ /**
99
+ * @public
100
+ */
101
+ export declare namespace ResponseStream {
102
+ /**
103
+ * <p>Contains tracing information of the SiteWise Assistant's reasoning and data access.</p>
104
+ * @public
105
+ */
106
+ interface TraceMember {
107
+ trace: Trace;
108
+ output?: never;
109
+ accessDeniedException?: never;
110
+ conflictingOperationException?: never;
111
+ internalFailureException?: never;
112
+ invalidRequestException?: never;
113
+ limitExceededException?: never;
114
+ resourceNotFoundException?: never;
115
+ throttlingException?: never;
116
+ $unknown?: never;
117
+ }
118
+ /**
119
+ * <p>Contains the SiteWise Assistant's response.</p>
120
+ * @public
121
+ */
122
+ interface OutputMember {
123
+ trace?: never;
124
+ output: InvocationOutput;
125
+ accessDeniedException?: never;
126
+ conflictingOperationException?: never;
127
+ internalFailureException?: never;
128
+ invalidRequestException?: never;
129
+ limitExceededException?: never;
130
+ resourceNotFoundException?: never;
131
+ throttlingException?: never;
132
+ $unknown?: never;
133
+ }
134
+ /**
135
+ * <p>Access is denied.</p>
136
+ * @public
137
+ */
138
+ interface AccessDeniedExceptionMember {
139
+ trace?: never;
140
+ output?: never;
141
+ accessDeniedException: AccessDeniedException;
142
+ conflictingOperationException?: never;
143
+ internalFailureException?: never;
144
+ invalidRequestException?: never;
145
+ limitExceededException?: never;
146
+ resourceNotFoundException?: never;
147
+ throttlingException?: never;
148
+ $unknown?: never;
149
+ }
150
+ /**
151
+ * <p>Your request has conflicting operations. This can occur if you're trying to perform more
152
+ * than one operation on the same resource at the same time.</p>
153
+ * @public
154
+ */
155
+ interface ConflictingOperationExceptionMember {
156
+ trace?: never;
157
+ output?: never;
158
+ accessDeniedException?: never;
159
+ conflictingOperationException: ConflictingOperationException;
160
+ internalFailureException?: never;
161
+ invalidRequestException?: never;
162
+ limitExceededException?: never;
163
+ resourceNotFoundException?: never;
164
+ throttlingException?: never;
165
+ $unknown?: never;
166
+ }
167
+ /**
168
+ * <p>IoT SiteWise can't process your request right now. Try again later.</p>
169
+ * @public
170
+ */
171
+ interface InternalFailureExceptionMember {
172
+ trace?: never;
173
+ output?: never;
174
+ accessDeniedException?: never;
175
+ conflictingOperationException?: never;
176
+ internalFailureException: InternalFailureException;
177
+ invalidRequestException?: never;
178
+ limitExceededException?: never;
179
+ resourceNotFoundException?: never;
180
+ throttlingException?: never;
181
+ $unknown?: never;
182
+ }
183
+ /**
184
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or
185
+ * unsupported characters. Check your request and try again.</p>
186
+ * @public
187
+ */
188
+ interface InvalidRequestExceptionMember {
189
+ trace?: never;
190
+ output?: never;
191
+ accessDeniedException?: never;
192
+ conflictingOperationException?: never;
193
+ internalFailureException?: never;
194
+ invalidRequestException: InvalidRequestException;
195
+ limitExceededException?: never;
196
+ resourceNotFoundException?: never;
197
+ throttlingException?: never;
198
+ $unknown?: never;
199
+ }
200
+ /**
201
+ * <p>You've reached the quota for a resource. For example, this can occur if you're trying to
202
+ * associate more than the allowed number of child assets or attempting to create more than the
203
+ * allowed number of properties for an asset model.</p>
204
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
205
+ * @public
206
+ */
207
+ interface LimitExceededExceptionMember {
208
+ trace?: never;
209
+ output?: never;
210
+ accessDeniedException?: never;
211
+ conflictingOperationException?: never;
212
+ internalFailureException?: never;
213
+ invalidRequestException?: never;
214
+ limitExceededException: LimitExceededException;
215
+ resourceNotFoundException?: never;
216
+ throttlingException?: never;
217
+ $unknown?: never;
218
+ }
219
+ /**
220
+ * <p>The requested resource can't be found.</p>
221
+ * @public
222
+ */
223
+ interface ResourceNotFoundExceptionMember {
224
+ trace?: never;
225
+ output?: never;
226
+ accessDeniedException?: never;
227
+ conflictingOperationException?: never;
228
+ internalFailureException?: never;
229
+ invalidRequestException?: never;
230
+ limitExceededException?: never;
231
+ resourceNotFoundException: ResourceNotFoundException;
232
+ throttlingException?: never;
233
+ $unknown?: never;
234
+ }
235
+ /**
236
+ * <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
237
+ * IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
238
+ * on.</p>
239
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
240
+ * @public
241
+ */
242
+ interface ThrottlingExceptionMember {
243
+ trace?: never;
244
+ output?: never;
245
+ accessDeniedException?: never;
246
+ conflictingOperationException?: never;
247
+ internalFailureException?: never;
248
+ invalidRequestException?: never;
249
+ limitExceededException?: never;
250
+ resourceNotFoundException?: never;
251
+ throttlingException: ThrottlingException;
252
+ $unknown?: never;
253
+ }
254
+ /**
255
+ * @public
256
+ */
257
+ interface $UnknownMember {
258
+ trace?: never;
259
+ output?: never;
260
+ accessDeniedException?: never;
261
+ conflictingOperationException?: never;
262
+ internalFailureException?: never;
263
+ invalidRequestException?: never;
264
+ limitExceededException?: never;
265
+ resourceNotFoundException?: never;
266
+ throttlingException?: never;
267
+ $unknown: [string, any];
268
+ }
269
+ interface Visitor<T> {
270
+ trace: (value: Trace) => T;
271
+ output: (value: InvocationOutput) => T;
272
+ accessDeniedException: (value: AccessDeniedException) => T;
273
+ conflictingOperationException: (value: ConflictingOperationException) => T;
274
+ internalFailureException: (value: InternalFailureException) => T;
275
+ invalidRequestException: (value: InvalidRequestException) => T;
276
+ limitExceededException: (value: LimitExceededException) => T;
277
+ resourceNotFoundException: (value: ResourceNotFoundException) => T;
278
+ throttlingException: (value: ThrottlingException) => T;
279
+ _: (name: string, value: any) => T;
280
+ }
281
+ const visit: <T>(value: ResponseStream, visitor: Visitor<T>) => T;
282
+ }
283
+ /**
284
+ * @public
285
+ */
286
+ export interface InvokeAssistantResponse {
287
+ /**
288
+ * <p>Contains the response, citation, and trace from the SiteWise Assistant.</p>
289
+ * @public
290
+ */
291
+ body: AsyncIterable<ResponseStream> | undefined;
292
+ /**
293
+ * <p>The ID of the conversation, in UUID format. This ID uniquely identifies the conversation within IoT SiteWise.</p>
294
+ * @public
295
+ */
296
+ conversationId: string | undefined;
297
+ }
4
298
  /**
5
299
  * @public
6
300
  * @enum
@@ -288,6 +582,11 @@ export interface ListAssetModelsRequest {
288
582
  * you can include in the composite models of other asset models. You can't create
289
583
  * assets directly from this type of asset model. </p>
290
584
  * </li>
585
+ * <li>
586
+ * <p>
587
+ * <b>INTERFACE</b> – An interface is a type of model
588
+ * that defines a standard structure that can be applied to different asset models.</p>
589
+ * </li>
291
590
  * </ul>
292
591
  * @public
293
592
  */
@@ -763,32 +1062,33 @@ export interface ListCompositionRelationshipsResponse {
763
1062
  nextToken?: string | undefined;
764
1063
  }
765
1064
  /**
766
- * <p>A filter used to match specific data binding values based on criteria.
767
- * This filter allows searching for data bindings by asset, asset model, asset property, or asset model property.</p>
1065
+ * <p>A filter used to match specific data binding values based on criteria. This filter allows
1066
+ * searching for data bindings by asset, asset model, asset property, or asset model
1067
+ * property.</p>
768
1068
  * @public
769
1069
  */
770
1070
  export interface DataBindingValueFilter {
771
1071
  /**
772
- * <p>Filter criteria for matching data bindings based on a specific asset.
773
- * Used to list all data bindings referencing a particular asset or its properties.</p>
1072
+ * <p>Filter criteria for matching data bindings based on a specific asset. Used to list all
1073
+ * data bindings referencing a particular asset or its properties.</p>
774
1074
  * @public
775
1075
  */
776
1076
  asset?: AssetBindingValueFilter | undefined;
777
1077
  /**
778
- * <p>Filter criteria for matching data bindings based on a specific asset model.
779
- * Used to list all data bindings referencing a particular asset model or its properties.</p>
1078
+ * <p>Filter criteria for matching data bindings based on a specific asset model. Used to list
1079
+ * all data bindings referencing a particular asset model or its properties.</p>
780
1080
  * @public
781
1081
  */
782
1082
  assetModel?: AssetModelBindingValueFilter | undefined;
783
1083
  /**
784
- * <p>Filter criteria for matching data bindings based on a specific asset property.
785
- * Used to list all data bindings referencing a particular property of an asset.</p>
1084
+ * <p>Filter criteria for matching data bindings based on a specific asset property. Used to
1085
+ * list all data bindings referencing a particular property of an asset.</p>
786
1086
  * @public
787
1087
  */
788
1088
  assetProperty?: AssetPropertyBindingValueFilter | undefined;
789
1089
  /**
790
- * <p>Filter criteria for matching data bindings based on a specific asset model property.
791
- * Used to list all data bindings referencing a particular property of an asset model.</p>
1090
+ * <p>Filter criteria for matching data bindings based on a specific asset model property. Used
1091
+ * to list all data bindings referencing a particular property of an asset model.</p>
792
1092
  * @public
793
1093
  */
794
1094
  assetModelProperty?: AssetModelPropertyBindingValueFilter | undefined;
@@ -798,11 +1098,9 @@ export interface DataBindingValueFilter {
798
1098
  */
799
1099
  export interface ListComputationModelDataBindingUsagesRequest {
800
1100
  /**
801
- * <p>A filter used to limit the returned data binding usages based on
802
- * specific data binding values.
803
- * You can filter by asset, asset model, asset property,
804
- * or asset model property to find all computation models
805
- * using these specific data sources.</p>
1101
+ * <p>A filter used to limit the returned data binding usages based on specific data binding
1102
+ * values. You can filter by asset, asset model, asset property, or asset model property to find
1103
+ * all computation models using these specific data sources.</p>
806
1104
  * @public
807
1105
  */
808
1106
  dataBindingValueFilter: DataBindingValueFilter | undefined;
@@ -818,7 +1116,8 @@ export interface ListComputationModelDataBindingUsagesRequest {
818
1116
  maxResults?: number | undefined;
819
1117
  }
820
1118
  /**
821
- * <p>Represents a value used in a data binding. It can be an asset property or an asset model property.</p>
1119
+ * <p>Represents a value used in a data binding. It can be an asset property or an asset model
1120
+ * property.</p>
822
1121
  * @public
823
1122
  */
824
1123
  export interface DataBindingValue {
@@ -845,21 +1144,21 @@ export interface MatchedDataBinding {
845
1144
  value: DataBindingValue | undefined;
846
1145
  }
847
1146
  /**
848
- * <p>A summary of how a specific data binding is used across computation models.
849
- * This tracks dependencies between data sources and computation models,
850
- * allowing you to understand the impact of changes to data sources.</p>
1147
+ * <p>A summary of how a specific data binding is used across computation models. This tracks
1148
+ * dependencies between data sources and computation models, allowing you to understand the
1149
+ * impact of changes to data sources.</p>
851
1150
  * @public
852
1151
  */
853
1152
  export interface ComputationModelDataBindingUsageSummary {
854
1153
  /**
855
- * <p>The list of computation model IDs that use this data binding.
856
- * This allows identification of all computation models affected by changes to the referenced data source.</p>
1154
+ * <p>The list of computation model IDs that use this data binding. This allows identification
1155
+ * of all computation models affected by changes to the referenced data source.</p>
857
1156
  * @public
858
1157
  */
859
1158
  computationModelIds: string[] | undefined;
860
1159
  /**
861
- * <p>The data binding matched by the filter criteria. Contains details
862
- * about specific data binding values used by the computation models.</p>
1160
+ * <p>The data binding matched by the filter criteria. Contains details about specific data
1161
+ * binding values used by the computation models.</p>
863
1162
  * @public
864
1163
  */
865
1164
  matchedDataBinding: MatchedDataBinding | undefined;
@@ -869,13 +1168,14 @@ export interface ComputationModelDataBindingUsageSummary {
869
1168
  */
870
1169
  export interface ListComputationModelDataBindingUsagesResponse {
871
1170
  /**
872
- * <p>A list of summaries describing the data binding usages across computation models.
873
- * Each summary includes the computation model IDs and the matched data binding details.</p>
1171
+ * <p>A list of summaries describing the data binding usages across computation models. Each
1172
+ * summary includes the computation model IDs and the matched data binding details.</p>
874
1173
  * @public
875
1174
  */
876
1175
  dataBindingUsageSummaries: ComputationModelDataBindingUsageSummary[] | undefined;
877
1176
  /**
878
- * <p>The token for the next set of paginated results, or null if there are no additional results.</p>
1177
+ * <p>The token for the next set of paginated results, or null if there are no additional
1178
+ * results.</p>
879
1179
  * @public
880
1180
  */
881
1181
  nextToken?: string | undefined;
@@ -916,12 +1216,14 @@ export interface ComputationModelResolveToResourceSummary {
916
1216
  */
917
1217
  export interface ListComputationModelResolveToResourcesResponse {
918
1218
  /**
919
- * <p>A list of summaries describing the distinct resources that this computation model resolves to when actions were executed.</p>
1219
+ * <p>A list of summaries describing the distinct resources that this computation model resolves
1220
+ * to when actions were executed.</p>
920
1221
  * @public
921
1222
  */
922
1223
  computationModelResolveToResourceSummaries: ComputationModelResolveToResourceSummary[] | undefined;
923
1224
  /**
924
- * <p>The token for the next set of paginated results, or null if there are no additional results.</p>
1225
+ * <p>The token for the next set of paginated results, or null if there are no additional
1226
+ * results.</p>
925
1227
  * @public
926
1228
  */
927
1229
  nextToken?: string | undefined;
@@ -942,7 +1244,8 @@ export type ComputationModelType = (typeof ComputationModelType)[keyof typeof Co
942
1244
  */
943
1245
  export interface ListComputationModelsRequest {
944
1246
  /**
945
- * <p>The type of computation model. If a <code>computationModelType</code> is not provided, all types of computation models are returned.</p>
1247
+ * <p>The type of computation model. If a <code>computationModelType</code> is not provided, all
1248
+ * types of computation models are returned.</p>
946
1249
  * @public
947
1250
  */
948
1251
  computationModelType?: ComputationModelType | undefined;
@@ -1227,7 +1530,8 @@ export interface ExecutionSummary {
1227
1530
  */
1228
1531
  actionType?: string | undefined;
1229
1532
  /**
1230
- * <p>The resource the action will be taken on.</p>
1533
+ * <p>The resource the action will be taken on. This can include asset-based resources and
1534
+ * computation model resources.</p>
1231
1535
  * @public
1232
1536
  */
1233
1537
  targetResource: TargetResource | undefined;
@@ -1309,10 +1613,15 @@ export interface GatewaySummary {
1309
1613
  */
1310
1614
  gatewayName: string | undefined;
1311
1615
  /**
1312
- * <p>The gateway's platform configuration. You can only specify one platform type in a gateway.</p>
1313
- * <p>(Legacy only) For Greengrass V1 gateways, specify the <code>greengrass</code> parameter with a valid Greengrass group ARN.</p>
1314
- * <p>For Greengrass V2 gateways, specify the <code>greengrassV2</code> parameter with a valid core device thing name. If creating a V3 gateway (<code>gatewayVersion=3</code>), you must also specify the <code>coreDeviceOperatingSystem</code>.</p>
1315
- * <p>For Siemens Industrial Edge gateways, specify the <code>siemensIE</code> parameter with a valid IoT Core thing name.</p>
1616
+ * <p>The gateway's platform configuration. You can only specify one platform type in a
1617
+ * gateway.</p>
1618
+ * <p>(Legacy only) For Greengrass V1 gateways, specify the <code>greengrass</code> parameter
1619
+ * with a valid Greengrass group ARN.</p>
1620
+ * <p>For Greengrass V2 gateways, specify the <code>greengrassV2</code> parameter with a valid
1621
+ * core device thing name. If creating a V3 gateway (<code>gatewayVersion=3</code>), you must
1622
+ * also specify the <code>coreDeviceOperatingSystem</code>.</p>
1623
+ * <p>For Siemens Industrial Edge gateways, specify the <code>siemensIE</code> parameter with a
1624
+ * valid IoT Core thing name.</p>
1316
1625
  * @public
1317
1626
  */
1318
1627
  gatewayPlatform?: GatewayPlatform | undefined;
@@ -1355,6 +1664,55 @@ export interface ListGatewaysResponse {
1355
1664
  */
1356
1665
  nextToken?: string | undefined;
1357
1666
  }
1667
+ /**
1668
+ * @public
1669
+ */
1670
+ export interface ListInterfaceRelationshipsRequest {
1671
+ /**
1672
+ * <p>The ID of the interface asset model. This can be either the actual ID in UUID format, or
1673
+ * else externalId: followed by the external ID.</p>
1674
+ * @public
1675
+ */
1676
+ interfaceAssetModelId: string | undefined;
1677
+ /**
1678
+ * <p>The token to be used for the next set of paginated results.</p>
1679
+ * @public
1680
+ */
1681
+ nextToken?: string | undefined;
1682
+ /**
1683
+ * <p>The maximum number of results to return for each paginated request. Default: 50</p>
1684
+ * @public
1685
+ */
1686
+ maxResults?: number | undefined;
1687
+ }
1688
+ /**
1689
+ * <p>Contains summary information about an interface relationship, which defines how an
1690
+ * interface is applied to an asset model. This summary provides the essential identifiers needed
1691
+ * to retrieve detailed information about the relationship.</p>
1692
+ * @public
1693
+ */
1694
+ export interface InterfaceRelationshipSummary {
1695
+ /**
1696
+ * <p>The ID of the asset model that has the interface applied to it.</p>
1697
+ * @public
1698
+ */
1699
+ id: string | undefined;
1700
+ }
1701
+ /**
1702
+ * @public
1703
+ */
1704
+ export interface ListInterfaceRelationshipsResponse {
1705
+ /**
1706
+ * <p>A list that summarizes each interface relationship.</p>
1707
+ * @public
1708
+ */
1709
+ interfaceRelationshipSummaries: InterfaceRelationshipSummary[] | undefined;
1710
+ /**
1711
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
1712
+ * @public
1713
+ */
1714
+ nextToken?: string | undefined;
1715
+ }
1358
1716
  /**
1359
1717
  * @public
1360
1718
  */
@@ -1708,6 +2066,89 @@ export interface ListTimeSeriesResponse {
1708
2066
  */
1709
2067
  nextToken?: string | undefined;
1710
2068
  }
2069
+ /**
2070
+ * <p>Contains configuration options for mapping properties from an interface asset model to an
2071
+ * asset model where the interface is applied.</p>
2072
+ * @public
2073
+ */
2074
+ export interface PropertyMappingConfiguration {
2075
+ /**
2076
+ * <p>If true, properties are matched by name between the interface asset model and the asset
2077
+ * model where the interface is applied.</p>
2078
+ * @public
2079
+ */
2080
+ matchByPropertyName?: boolean | undefined;
2081
+ /**
2082
+ * <p>If true, missing properties from the interface asset model are automatically created in
2083
+ * the asset model where the interface is applied.</p>
2084
+ * @public
2085
+ */
2086
+ createMissingProperty?: boolean | undefined;
2087
+ /**
2088
+ * <p>A list of specific property mappings that override the automatic mapping by name when an
2089
+ * interface is applied to an asset model.</p>
2090
+ * @public
2091
+ */
2092
+ overrides?: PropertyMapping[] | undefined;
2093
+ }
2094
+ /**
2095
+ * @public
2096
+ */
2097
+ export interface PutAssetModelInterfaceRelationshipRequest {
2098
+ /**
2099
+ * <p>The ID of the asset model. This can be either the actual ID in UUID format, or else
2100
+ * externalId: followed by the external ID.</p>
2101
+ * @public
2102
+ */
2103
+ assetModelId: string | undefined;
2104
+ /**
2105
+ * <p>The ID of the interface asset model. This can be either the actual ID in UUID format, or
2106
+ * else externalId: followed by the external ID.</p>
2107
+ * @public
2108
+ */
2109
+ interfaceAssetModelId: string | undefined;
2110
+ /**
2111
+ * <p>The configuration for mapping properties from the interface asset model to the asset model
2112
+ * where the interface is applied. This configuration controls how properties are matched and
2113
+ * created during the interface application process.</p>
2114
+ * @public
2115
+ */
2116
+ propertyMappingConfiguration: PropertyMappingConfiguration | undefined;
2117
+ /**
2118
+ * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the
2119
+ * request. Don't reuse this client token if a new idempotent request is required.</p>
2120
+ * @public
2121
+ */
2122
+ clientToken?: string | undefined;
2123
+ }
2124
+ /**
2125
+ * @public
2126
+ */
2127
+ export interface PutAssetModelInterfaceRelationshipResponse {
2128
+ /**
2129
+ * <p>The ID of the asset model.</p>
2130
+ * @public
2131
+ */
2132
+ assetModelId: string | undefined;
2133
+ /**
2134
+ * <p>The ID of the interface asset model.</p>
2135
+ * @public
2136
+ */
2137
+ interfaceAssetModelId: string | undefined;
2138
+ /**
2139
+ * <p>The ARN of the asset model, which has the following format.
2140
+ * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset-model/$\{AssetModelId\}</code>
2141
+ * </p>
2142
+ * @public
2143
+ */
2144
+ assetModelArn: string | undefined;
2145
+ /**
2146
+ * <p>Contains current status information for an asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html">Asset and model
2147
+ * states</a> in the <i>IoT SiteWise User Guide</i>.</p>
2148
+ * @public
2149
+ */
2150
+ assetModelStatus: AssetModelStatus | undefined;
2151
+ }
1711
2152
  /**
1712
2153
  * @public
1713
2154
  */
@@ -2272,7 +2713,8 @@ export interface UpdateAssetPropertyRequest {
2272
2713
  */
2273
2714
  export interface UpdateComputationModelResponse {
2274
2715
  /**
2275
- * <p>The status of the computation model. It contains a state (UPDATING after successfully calling this operation) and an error message if any.</p>
2716
+ * <p>The status of the computation model. It contains a state (UPDATING after successfully
2717
+ * calling this operation) and an error message if any.</p>
2276
2718
  * @public
2277
2719
  */
2278
2720
  computationModelStatus: ComputationModelStatus | undefined;
@@ -2593,7 +3035,8 @@ export interface UpdateProjectRequest {
2593
3035
  export interface UpdateProjectResponse {
2594
3036
  }
2595
3037
  /**
2596
- * <p>Contains computation model data binding value information, which can be one of <code>assetModelProperty</code>, <code>list</code>.</p>
3038
+ * <p>Contains computation model data binding value information, which can be one of
3039
+ * <code>assetModelProperty</code>, <code>list</code>.</p>
2597
3040
  * @public
2598
3041
  */
2599
3042
  export interface ComputationModelDataBindingValue {
@@ -2645,8 +3088,8 @@ export interface CreateComputationModelRequest {
2645
3088
  clientToken?: string | undefined;
2646
3089
  /**
2647
3090
  * <p>A list of key-value pairs that contain metadata for the asset. For more information, see
2648
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
2649
- * resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
3091
+ * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
3092
+ * resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
2650
3093
  * @public
2651
3094
  */
2652
3095
  tags?: Record<string, string> | undefined;
@@ -2700,7 +3143,8 @@ export interface DescribeComputationModelResponse {
2700
3143
  */
2701
3144
  computationModelLastUpdateDate: Date | undefined;
2702
3145
  /**
2703
- * <p>The current status of the asset model, which contains a state and an error message if any.</p>
3146
+ * <p>The current status of the asset model, which contains a state and an error message if
3147
+ * any.</p>
2704
3148
  * @public
2705
3149
  */
2706
3150
  computationModelStatus: ComputationModelStatus | undefined;
@@ -2746,7 +3190,8 @@ export interface UpdateComputationModelRequest {
2746
3190
  */
2747
3191
  computationModelDataBinding: Record<string, ComputationModelDataBindingValue> | undefined;
2748
3192
  /**
2749
- * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
3193
+ * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the
3194
+ * request. Don't reuse this client token if a new idempotent request is required.</p>
2750
3195
  * @public
2751
3196
  */
2752
3197
  clientToken?: string | undefined;
@@ -2809,6 +3254,14 @@ export interface ExecuteQueryResponse {
2809
3254
  */
2810
3255
  nextToken?: string | undefined;
2811
3256
  }
3257
+ /**
3258
+ * @internal
3259
+ */
3260
+ export declare const ResponseStreamFilterSensitiveLog: (obj: ResponseStream) => any;
3261
+ /**
3262
+ * @internal
3263
+ */
3264
+ export declare const InvokeAssistantResponseFilterSensitiveLog: (obj: InvokeAssistantResponse) => any;
2812
3265
  /**
2813
3266
  * @internal
2814
3267
  */