File: types.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.24.1-2~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 554,032 kB
  • sloc: java: 15,941; makefile: 419; sh: 175
file content (1519 lines) | stat: -rw-r--r-- 35,267 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	"github.com/aws/aws-sdk-go-v2/service/iottwinmaker/document"
	smithydocument "github.com/aws/smithy-go/document"
	"time"
)

// An error returned by the BatchPutProperty action.
type BatchPutPropertyError struct {

	// An object that contains information about errors returned by the
	// BatchPutProperty action.
	//
	// This member is required.
	Entry *PropertyValueEntry

	// The error code.
	//
	// This member is required.
	ErrorCode *string

	// The error message.
	//
	// This member is required.
	ErrorMessage *string

	noSmithyDocumentSerde
}

// An object that contains information about errors returned by the
// BatchPutProperty action.
type BatchPutPropertyErrorEntry struct {

	// A list of objects that contain information about errors returned by the
	// BatchPutProperty action.
	//
	// This member is required.
	Errors []BatchPutPropertyError

	noSmithyDocumentSerde
}

// Information about the pricing bundle.
type BundleInformation struct {

	// The bundle names.
	//
	// This member is required.
	BundleNames []string

	// The pricing tier.
	PricingTier PricingTier

	noSmithyDocumentSerde
}

// A description of the column in the query results.
type ColumnDescription struct {

	// The name of the column description.
	Name *string

	// The type of the column description.
	Type ColumnType

	noSmithyDocumentSerde
}

// The component property group request.
type ComponentPropertyGroupRequest struct {

	// The group type.
	GroupType GroupType

	// The property names.
	PropertyNames []string

	// The update type.
	UpdateType PropertyGroupUpdateType

	noSmithyDocumentSerde
}

// The component property group response.
type ComponentPropertyGroupResponse struct {

	// The group type.
	//
	// This member is required.
	GroupType GroupType

	// A Boolean value that specifies whether the property group is inherited from a
	// parent entity
	//
	// This member is required.
	IsInherited *bool

	// The names of properties
	//
	// This member is required.
	PropertyNames []string

	noSmithyDocumentSerde
}

// An object that sets information about a component type create or update request.
type ComponentRequest struct {

	// The ID of the component type.
	ComponentTypeId *string

	// The description of the component request.
	Description *string

	// An object that maps strings to the properties to set in the component type.
	// Each string in the mapping must be unique to this object.
	Properties map[string]PropertyRequest

	// The property groups.
	PropertyGroups map[string]ComponentPropertyGroupRequest

	noSmithyDocumentSerde
}

// An object that returns information about a component type create or update
// request.
type ComponentResponse struct {

	// This flag notes whether all compositeComponents are returned in the API
	// response.
	AreAllCompositeComponentsReturned *bool

	// This flag notes whether all properties of the component are returned in the API
	// response. The maximum number of properties returned is 800.
	AreAllPropertiesReturned *bool

	// The name of the component.
	ComponentName *string

	// The ID of the component type.
	ComponentTypeId *string

	// This lists objects that contain information about the compositeComponents .
	CompositeComponents map[string]ComponentSummary

	// The name of the property definition set in the request.
	DefinedIn *string

	// The description of the component type.
	Description *string

	// An object that maps strings to the properties to set in the component type.
	// Each string in the mapping must be unique to this object.
	Properties map[string]PropertyResponse

	// The property groups.
	PropertyGroups map[string]ComponentPropertyGroupResponse

	// The status of the component type.
	Status *Status

	// The syncSource of the sync job, if this entity was created by a sync job.
	SyncSource *string

	noSmithyDocumentSerde
}

// An object that returns information about a component summary.
type ComponentSummary struct {

	// The name of the component.
	//
	// This member is required.
	ComponentName *string

	// The ID of the component type.
	//
	// This member is required.
	ComponentTypeId *string

	// The status of the component type.
	//
	// This member is required.
	Status *Status

	// This string specifies the path to the composite component, starting from the
	// top-level component.
	ComponentPath *string

	// The name of the property definition set in the request.
	DefinedIn *string

	// The description of the component request.
	Description *string

	// The property groups.
	PropertyGroups map[string]ComponentPropertyGroupResponse

	// The syncSource of the sync job, if this entity was created by a sync job.
	SyncSource *string

	noSmithyDocumentSerde
}

// An object that contains information about a component type.
type ComponentTypeSummary struct {

	// The ARN of the component type.
	//
	// This member is required.
	Arn *string

	// The ID of the component type.
	//
	// This member is required.
	ComponentTypeId *string

	// The date and time when the component type was created.
	//
	// This member is required.
	CreationDateTime *time.Time

	// The date and time when the component type was last updated.
	//
	// This member is required.
	UpdateDateTime *time.Time

	// The component type name.
	ComponentTypeName *string

	// The description of the component type.
	Description *string

	// The current status of the component type.
	Status *Status

	noSmithyDocumentSerde
}

// The component update request.
type ComponentUpdateRequest struct {

	// The ID of the component type.
	ComponentTypeId *string

	// The description of the component type.
	Description *string

	// The property group updates.
	PropertyGroupUpdates map[string]ComponentPropertyGroupRequest

	// An object that maps strings to the properties to set in the component type
	// update. Each string in the mapping must be unique to this object.
	PropertyUpdates map[string]PropertyRequest

	// The update type of the component update request.
	UpdateType ComponentUpdateType

	noSmithyDocumentSerde
}

// An object that sets information about the composite component update request.
type CompositeComponentRequest struct {

	// The description of the component type.
	Description *string

	// This is an object that maps strings to the properties to set in the component
	// type. Each string in the mapping must be unique to this object.
	Properties map[string]PropertyRequest

	// The property groups.
	PropertyGroups map[string]ComponentPropertyGroupRequest

	noSmithyDocumentSerde
}

// An object that sets information about the composite component types of a
// component type.
type CompositeComponentTypeRequest struct {

	// This is the componentTypeId that the compositeComponentType refers to.
	ComponentTypeId *string

	noSmithyDocumentSerde
}

// An object that returns information about the composite component types of a
// component type.
type CompositeComponentTypeResponse struct {

	// This is the componentTypeId that this compositeComponentType refers to.
	ComponentTypeId *string

	// This boolean indicates whether this compositeComponentType is inherited from
	// its parent.
	IsInherited *bool

	noSmithyDocumentSerde
}

// An object that sets information about the composite component update request.
type CompositeComponentUpdateRequest struct {

	// The description of the component type.
	Description *string

	// The property group updates.
	PropertyGroupUpdates map[string]ComponentPropertyGroupRequest

	// An object that maps strings to the properties to set in the component type
	// update. Each string in the mapping must be unique to this object.
	PropertyUpdates map[string]PropertyRequest

	// The update type of the component update request.
	UpdateType ComponentUpdateType

	noSmithyDocumentSerde
}

// The data connector.
type DataConnector struct {

	// A Boolean value that specifies whether the data connector is native to IoT
	// TwinMaker.
	IsNative *bool

	// The Lambda function associated with this data connector.
	Lambda *LambdaFunction

	noSmithyDocumentSerde
}

// An object that specifies the data type of a property.
type DataType struct {

	// The underlying type of the data type.
	//
	// This member is required.
	Type Type

	// The allowed values for this data type.
	AllowedValues []DataValue

	// The nested type in the data type.
	NestedType *DataType

	// A relationship that associates a component with another component.
	Relationship *Relationship

	// The unit of measure used in this data type.
	UnitOfMeasure *string

	noSmithyDocumentSerde
}

// An object that specifies a value for a property.
type DataValue struct {

	// A Boolean value.
	BooleanValue *bool

	// A double value.
	DoubleValue *float64

	// An expression that produces the value.
	Expression *string

	// An integer value.
	IntegerValue *int32

	// A list of multiple values.
	ListValue []DataValue

	// A long value.
	LongValue *int64

	// An object that maps strings to multiple DataValue objects.
	MapValue map[string]DataValue

	// A value that relates a component to another component.
	RelationshipValue *RelationshipValue

	// A string value.
	StringValue *string

	noSmithyDocumentSerde
}

// The [link to action] metadata transfer job destination configuration.
type DestinationConfiguration struct {

	// The destination type.
	//
	// This member is required.
	Type DestinationType

	// The metadata transfer job Amazon Web Services IoT TwinMaker configuration.
	IotTwinMakerConfiguration *IotTwinMakerDestinationConfiguration

	// The metadata transfer job S3 configuration. [need to add S3 entity]
	S3Configuration *S3DestinationConfiguration

	noSmithyDocumentSerde
}

// An object that uniquely identifies an entity property.
type EntityPropertyReference struct {

	// The name of the property.
	//
	// This member is required.
	PropertyName *string

	// The name of the component.
	ComponentName *string

	// This string specifies the path to the composite component, starting from the
	// top-level component.
	ComponentPath *string

	// The ID of the entity.
	EntityId *string

	// A mapping of external IDs to property names. External IDs uniquely identify
	// properties from external data stores.
	ExternalIdProperty map[string]string

	noSmithyDocumentSerde
}

// An object that contains information about an entity.
type EntitySummary struct {

	// The ARN of the entity.
	//
	// This member is required.
	Arn *string

	// The date and time when the entity was created.
	//
	// This member is required.
	CreationDateTime *time.Time

	// The ID of the entity.
	//
	// This member is required.
	EntityId *string

	// The name of the entity.
	//
	// This member is required.
	EntityName *string

	// The current status of the entity.
	//
	// This member is required.
	Status *Status

	// The last date and time when the entity was updated.
	//
	// This member is required.
	UpdateDateTime *time.Time

	// The description of the entity.
	Description *string

	// An eventual Boolean value that specifies whether the entity has child entities
	// or not.
	HasChildEntities *bool

	// The ID of the parent entity.
	ParentEntityId *string

	noSmithyDocumentSerde
}

// The error details.
type ErrorDetails struct {

	// The error code.
	Code ErrorCode

	// The error message.
	Message *string

	noSmithyDocumentSerde
}

// Filter by asset. [TwinMaker asset]
type FilterByAsset struct {

	// The external-Id property of an asset.
	AssetExternalId *string

	// Filter by asset Id.
	AssetId *string

	// Boolean to include the asset model.
	IncludeAssetModel *bool

	// Includes sub-assets.[need description hekp for this]
	IncludeOffspring *bool

	noSmithyDocumentSerde
}

// Filter by asset model.
type FilterByAssetModel struct {

	// The external-Id property of an asset model.
	AssetModelExternalId *string

	// The asset model Id.
	AssetModelId *string

	// Bolean to include assets.
	IncludeAssets *bool

	// Include asset offspring. [need desc.]
	IncludeOffspring *bool

	noSmithyDocumentSerde
}

// Filter by component type.
type FilterByComponentType struct {

	// The component type Id.
	//
	// This member is required.
	ComponentTypeId *string

	noSmithyDocumentSerde
}

// Vilter by entity.
type FilterByEntity struct {

	// The entity Id.
	//
	// This member is required.
	EntityId *string

	noSmithyDocumentSerde
}

// The function request body.
type FunctionRequest struct {

	// The data connector.
	ImplementedBy *DataConnector

	// The required properties of the function.
	RequiredProperties []string

	// The scope of the function.
	Scope Scope

	noSmithyDocumentSerde
}

// The function response.
type FunctionResponse struct {

	// The data connector.
	ImplementedBy *DataConnector

	// Indicates whether this function is inherited.
	IsInherited *bool

	// The required properties of the function.
	RequiredProperties []string

	// The scope of the function.
	Scope Scope

	noSmithyDocumentSerde
}

// An object that specifies how to interpolate data in a list.
type InterpolationParameters struct {

	// The interpolation type.
	InterpolationType InterpolationType

	// The interpolation time interval in seconds.
	IntervalInSeconds *int64

	noSmithyDocumentSerde
}

// The metadata transfer job AWS IoT SiteWise source configuration.
type IotSiteWiseSourceConfiguration struct {

	// The AWS IoT SiteWise soucre configuration filters.
	Filters []IotSiteWiseSourceConfigurationFilter

	noSmithyDocumentSerde
}

// The AWS IoT SiteWise soucre configuration filter.[need held with desc here]
//
// The following types satisfy this interface:
//
//	IotSiteWiseSourceConfigurationFilterMemberFilterByAsset
//	IotSiteWiseSourceConfigurationFilterMemberFilterByAssetModel
type IotSiteWiseSourceConfigurationFilter interface {
	isIotSiteWiseSourceConfigurationFilter()
}

// Filter by asset.
type IotSiteWiseSourceConfigurationFilterMemberFilterByAsset struct {
	Value FilterByAsset

	noSmithyDocumentSerde
}

func (*IotSiteWiseSourceConfigurationFilterMemberFilterByAsset) isIotSiteWiseSourceConfigurationFilter() {
}

// Filter by asset model.
type IotSiteWiseSourceConfigurationFilterMemberFilterByAssetModel struct {
	Value FilterByAssetModel

	noSmithyDocumentSerde
}

func (*IotSiteWiseSourceConfigurationFilterMemberFilterByAssetModel) isIotSiteWiseSourceConfigurationFilter() {
}

// The metadata transfer job AWS IoT TwinMaker destination configuration.
type IotTwinMakerDestinationConfiguration struct {

	// The IoT TwinMaker workspace.
	//
	// This member is required.
	Workspace *string

	noSmithyDocumentSerde
}

// The metadata transfer job AWS IoT TwinMaker source configuration.
type IotTwinMakerSourceConfiguration struct {

	// The IoT TwinMaker workspace.
	//
	// This member is required.
	Workspace *string

	// The metadata transfer job AWS IoT TwinMaker source configuration filters.
	Filters []IotTwinMakerSourceConfigurationFilter

	noSmithyDocumentSerde
}

// The metadata transfer job AWS IoT TwinMaker source configuration filter.
//
// The following types satisfy this interface:
//
//	IotTwinMakerSourceConfigurationFilterMemberFilterByComponentType
//	IotTwinMakerSourceConfigurationFilterMemberFilterByEntity
type IotTwinMakerSourceConfigurationFilter interface {
	isIotTwinMakerSourceConfigurationFilter()
}

// Filter by component type.
type IotTwinMakerSourceConfigurationFilterMemberFilterByComponentType struct {
	Value FilterByComponentType

	noSmithyDocumentSerde
}

func (*IotTwinMakerSourceConfigurationFilterMemberFilterByComponentType) isIotTwinMakerSourceConfigurationFilter() {
}

// Filter by entity.
type IotTwinMakerSourceConfigurationFilterMemberFilterByEntity struct {
	Value FilterByEntity

	noSmithyDocumentSerde
}

func (*IotTwinMakerSourceConfigurationFilterMemberFilterByEntity) isIotTwinMakerSourceConfigurationFilter() {
}

// The Lambda function.
type LambdaFunction struct {

	// The ARN of the Lambda function.
	//
	// This member is required.
	Arn *string

	noSmithyDocumentSerde
}

// An object that filters items in a list of component types. Only one object is
// accepted as a valid input.
//
// The following types satisfy this interface:
//
//	ListComponentTypesFilterMemberExtendsFrom
//	ListComponentTypesFilterMemberIsAbstract
//	ListComponentTypesFilterMemberNamespace
type ListComponentTypesFilter interface {
	isListComponentTypesFilter()
}

// The component type that the component types in the list extend.
type ListComponentTypesFilterMemberExtendsFrom struct {
	Value string

	noSmithyDocumentSerde
}

func (*ListComponentTypesFilterMemberExtendsFrom) isListComponentTypesFilter() {}

// A Boolean value that specifies whether the component types in the list are
// abstract.
type ListComponentTypesFilterMemberIsAbstract struct {
	Value bool

	noSmithyDocumentSerde
}

func (*ListComponentTypesFilterMemberIsAbstract) isListComponentTypesFilter() {}

// The namespace to which the component types in the list belong.
type ListComponentTypesFilterMemberNamespace struct {
	Value string

	noSmithyDocumentSerde
}

func (*ListComponentTypesFilterMemberNamespace) isListComponentTypesFilter() {}

// An object that filters items in a list of entities.
//
// The following types satisfy this interface:
//
//	ListEntitiesFilterMemberComponentTypeId
//	ListEntitiesFilterMemberExternalId
//	ListEntitiesFilterMemberParentEntityId
type ListEntitiesFilter interface {
	isListEntitiesFilter()
}

// The ID of the component type in the entities in the list.
type ListEntitiesFilterMemberComponentTypeId struct {
	Value string

	noSmithyDocumentSerde
}

func (*ListEntitiesFilterMemberComponentTypeId) isListEntitiesFilter() {}

// The external-Id property of a component. The external-Id property is the
// primary key of an external storage system.
type ListEntitiesFilterMemberExternalId struct {
	Value string

	noSmithyDocumentSerde
}

func (*ListEntitiesFilterMemberExternalId) isListEntitiesFilter() {}

// The parent of the entities in the list.
type ListEntitiesFilterMemberParentEntityId struct {
	Value string

	noSmithyDocumentSerde
}

func (*ListEntitiesFilterMemberParentEntityId) isListEntitiesFilter() {}

// The ListMetadataTransferJobs filter.
//
// The following types satisfy this interface:
//
//	ListMetadataTransferJobsFilterMemberState
//	ListMetadataTransferJobsFilterMemberWorkspaceId
type ListMetadataTransferJobsFilter interface {
	isListMetadataTransferJobsFilter()
}

// The filter state.
type ListMetadataTransferJobsFilterMemberState struct {
	Value MetadataTransferJobState

	noSmithyDocumentSerde
}

func (*ListMetadataTransferJobsFilterMemberState) isListMetadataTransferJobsFilter() {}

// The workspace Id.
type ListMetadataTransferJobsFilterMemberWorkspaceId struct {
	Value string

	noSmithyDocumentSerde
}

func (*ListMetadataTransferJobsFilterMemberWorkspaceId) isListMetadataTransferJobsFilter() {}

// The metadata transfer job's progress.
type MetadataTransferJobProgress struct {

	// The failed count.
	FailedCount *int32

	// The skipped count.
	SkippedCount *int32

	// The succeeded count.
	SucceededCount *int32

	// The total count. [of what]
	TotalCount *int32

	noSmithyDocumentSerde
}

// The metadata transfer job status.
type MetadataTransferJobStatus struct {

	// The metadata transfer job error.
	Error *ErrorDetails

	// The queued position.
	QueuedPosition *int32

	// The metadata transfer job state.
	State MetadataTransferJobState

	noSmithyDocumentSerde
}

// The metadata transfer job summary.
type MetadataTransferJobSummary struct {

	// The metadata transfer job summary ARN.
	//
	// This member is required.
	Arn *string

	// The metadata transfer job summary creation DateTime object.
	//
	// This member is required.
	CreationDateTime *time.Time

	// The metadata transfer job summary Id.
	//
	// This member is required.
	MetadataTransferJobId *string

	// The metadata transfer job summary status.
	//
	// This member is required.
	Status *MetadataTransferJobStatus

	// The metadata transfer job summary update DateTime object
	//
	// This member is required.
	UpdateDateTime *time.Time

	// The metadata transfer job summary progess.
	Progress *MetadataTransferJobProgress

	noSmithyDocumentSerde
}

// Filter criteria that orders the return output. It can be sorted in ascending or
// descending order.
type OrderBy struct {

	// The property name.
	//
	// This member is required.
	PropertyName *string

	// The set order that filters results.
	Order Order

	noSmithyDocumentSerde
}

// The parent entity update request.
type ParentEntityUpdateRequest struct {

	// The type of the update.
	//
	// This member is required.
	UpdateType ParentEntityUpdateType

	// The ID of the parent entity.
	ParentEntityId *string

	noSmithyDocumentSerde
}

// The pricing plan.
type PricingPlan struct {

	// The effective date and time of the pricing plan.
	//
	// This member is required.
	EffectiveDateTime *time.Time

	// The pricing mode.
	//
	// This member is required.
	PricingMode PricingMode

	// The set date and time for updating a pricing plan.
	//
	// This member is required.
	UpdateDateTime *time.Time

	// The update reason for changing a pricing plan.
	//
	// This member is required.
	UpdateReason UpdateReason

	// The billable entity count.
	BillableEntityCount *int64

	// The pricing plan's bundle information.
	BundleInformation *BundleInformation

	noSmithyDocumentSerde
}

// An object that sets information about a property.
type PropertyDefinitionRequest struct {

	// A mapping that specifies configuration information about the property. Use this
	// field to specify information that you read from and write to an external source.
	Configuration map[string]string

	// An object that contains information about the data type.
	DataType *DataType

	// An object that contains the default value.
	DefaultValue *DataValue

	// A friendly name for the property.
	DisplayName *string

	// A Boolean value that specifies whether the property ID comes from an external
	// data store.
	IsExternalId *bool

	// A Boolean value that specifies whether the property is required.
	IsRequiredInEntity *bool

	// A Boolean value that specifies whether the property is stored externally.
	IsStoredExternally *bool

	// A Boolean value that specifies whether the property consists of time series
	// data.
	IsTimeSeries *bool

	noSmithyDocumentSerde
}

// An object that contains response data from a property definition request.
type PropertyDefinitionResponse struct {

	// An object that contains information about the data type.
	//
	// This member is required.
	DataType *DataType

	// A Boolean value that specifies whether the property ID comes from an external
	// data store.
	//
	// This member is required.
	IsExternalId *bool

	// A Boolean value that specifies whether the property definition can be updated.
	//
	// This member is required.
	IsFinal *bool

	// A Boolean value that specifies whether the property definition is imported from
	// an external data store.
	//
	// This member is required.
	IsImported *bool

	// A Boolean value that specifies whether the property definition is inherited
	// from a parent entity.
	//
	// This member is required.
	IsInherited *bool

	// A Boolean value that specifies whether the property is required in an entity.
	//
	// This member is required.
	IsRequiredInEntity *bool

	// A Boolean value that specifies whether the property is stored externally.
	//
	// This member is required.
	IsStoredExternally *bool

	// A Boolean value that specifies whether the property consists of time series
	// data.
	//
	// This member is required.
	IsTimeSeries *bool

	// A mapping that specifies configuration information about the property.
	Configuration map[string]string

	// An object that contains the default value.
	DefaultValue *DataValue

	// A friendly name for the property.
	DisplayName *string

	noSmithyDocumentSerde
}

// An object that filters items returned by a property request.
type PropertyFilter struct {

	// The operator associated with this property filter.
	Operator *string

	// The property name associated with this property filter.
	PropertyName *string

	// The value associated with this property filter.
	Value *DataValue

	noSmithyDocumentSerde
}

type PropertyGroupRequest struct {

	// The group type.
	GroupType GroupType

	// The names of properties.
	PropertyNames []string

	noSmithyDocumentSerde
}

// The property group response
type PropertyGroupResponse struct {

	// The group types.
	//
	// This member is required.
	GroupType GroupType

	// A Boolean value that specifies whether the property group is inherited from a
	// parent entity
	//
	// This member is required.
	IsInherited *bool

	// The names of properties.
	//
	// This member is required.
	PropertyNames []string

	noSmithyDocumentSerde
}

// The latest value of the property.
type PropertyLatestValue struct {

	// An object that specifies information about a property.
	//
	// This member is required.
	PropertyReference *EntityPropertyReference

	// The value of the property.
	PropertyValue *DataValue

	noSmithyDocumentSerde
}

// An object that sets information about a property.
type PropertyRequest struct {

	// An object that specifies information about a property.
	Definition *PropertyDefinitionRequest

	// The update type of the update property request.
	UpdateType PropertyUpdateType

	// The value of the property.
	Value *DataValue

	noSmithyDocumentSerde
}

// An object that contains information about a property response.
type PropertyResponse struct {

	// This flag notes whether all values of a list or map type property are returned
	// in the API response. The maximum number of values per property returned is 50.
	AreAllPropertyValuesReturned *bool

	// An object that specifies information about a property.
	Definition *PropertyDefinitionResponse

	// The value of the property.
	Value *DataValue

	noSmithyDocumentSerde
}

// This is an object that contains the information of a property.
type PropertySummary struct {

	// This is the name of the property.
	//
	// This member is required.
	PropertyName *string

	// This flag notes whether all values of a list or map type property are returned
	// in the API response. The maximum number of values per property returned is 50.
	AreAllPropertyValuesReturned *bool

	// This is the schema for the property.
	Definition *PropertyDefinitionResponse

	// This is the value for the property.
	Value *DataValue

	noSmithyDocumentSerde
}

// An object that contains information about a value for a time series property.
type PropertyValue struct {

	// An object that specifies a value for a time series property.
	//
	// This member is required.
	Value *DataValue

	// ISO8601 DateTime of a value for a time series property. The time for when the
	// property value was recorded in ISO 8601 format:
	// YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm].
	//   - [YYYY]: year
	//   - [MM]: month
	//   - [DD]: day
	//   - [hh]: hour
	//   - [mm]: minute
	//   - [ss]: seconds
	//   - [.SSSSSSSSS]: additional precision, where precedence is maintained. For
	//   example: [.573123] is equal to 573123000 nanoseconds.
	//   - Z: default timezone UTC
	//   - ± HH:mm: time zone offset in Hours and Minutes.
	// Required sub-fields: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]
	Time *string

	// The timestamp of a value for a time series property.
	//
	// Deprecated: This field is deprecated and will throw an error in the future. Use
	// time instead.
	Timestamp *time.Time

	noSmithyDocumentSerde
}

// An object that specifies information about time series property values. This
// object is used and consumed by the BatchPutPropertyValues (https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_BatchPutPropertyValues.html)
// action.
type PropertyValueEntry struct {

	// An object that contains information about the entity that has the property.
	//
	// This member is required.
	EntityPropertyReference *EntityPropertyReference

	// A list of objects that specify time series property values.
	PropertyValues []PropertyValue

	noSmithyDocumentSerde
}

// The history of values for a time series property.
type PropertyValueHistory struct {

	// An object that uniquely identifies an entity property.
	//
	// This member is required.
	EntityPropertyReference *EntityPropertyReference

	// A list of objects that contain information about the values in the history of a
	// time series property.
	Values []PropertyValue

	noSmithyDocumentSerde
}

// An object that specifies a relationship with another component type.
type Relationship struct {

	// The type of the relationship.
	RelationshipType *string

	// The ID of the target component type associated with this relationship.
	TargetComponentTypeId *string

	noSmithyDocumentSerde
}

// A value that associates a component and an entity.
type RelationshipValue struct {

	// The name of the target component associated with the relationship value.
	TargetComponentName *string

	// The ID of the target entity associated with this relationship value.
	TargetEntityId *string

	noSmithyDocumentSerde
}

// Represents a single row in the query results.
type Row struct {

	// The data in a row of query results.
	RowData []document.Interface

	noSmithyDocumentSerde
}

// The S3 destination configuration.
type S3DestinationConfiguration struct {

	// The S3 destination configuration location.
	//
	// This member is required.
	Location *string

	noSmithyDocumentSerde
}

// The S3 destination source configuration.
type S3SourceConfiguration struct {

	// The S3 destination source configuration location.
	//
	// This member is required.
	Location *string

	noSmithyDocumentSerde
}

// The scene error.
type SceneError struct {

	// The SceneError code.
	Code SceneErrorCode

	// The SceneError message.
	Message *string

	noSmithyDocumentSerde
}

// An object that contains information about a scene.
type SceneSummary struct {

	// The ARN of the scene.
	//
	// This member is required.
	Arn *string

	// The relative path that specifies the location of the content definition file.
	//
	// This member is required.
	ContentLocation *string

	// The date and time when the scene was created.
	//
	// This member is required.
	CreationDateTime *time.Time

	// The ID of the scene.
	//
	// This member is required.
	SceneId *string

	// The date and time when the scene was last updated.
	//
	// This member is required.
	UpdateDateTime *time.Time

	// The scene description.
	Description *string

	noSmithyDocumentSerde
}

// The source configuration.
type SourceConfiguration struct {

	// The source configuration type.
	//
	// This member is required.
	Type SourceType

	// The source configuration IoT SiteWise configuration.
	IotSiteWiseConfiguration *IotSiteWiseSourceConfiguration

	// The source configuration IoT TwinMaker configuration.
	IotTwinMakerConfiguration *IotTwinMakerSourceConfiguration

	// The source configuration S3 configuration.
	S3Configuration *S3SourceConfiguration

	noSmithyDocumentSerde
}

// An object that represents the status of an entity, component, component type,
// or workspace.
type Status struct {

	// The error message.
	Error *ErrorDetails

	// The current state of the entity, component, component type, or workspace.
	State State

	noSmithyDocumentSerde
}

// The SyncJob status.
type SyncJobStatus struct {

	// The SyncJob error.
	Error *ErrorDetails

	// The SyncJob status state.
	State SyncJobState

	noSmithyDocumentSerde
}

// The SyncJob summary.
type SyncJobSummary struct {

	// The SyncJob summary ARN.
	Arn *string

	// The creation date and time.
	CreationDateTime *time.Time

	// The SyncJob summaries status.
	Status *SyncJobStatus

	// The sync source.
	SyncSource *string

	// The update date and time.
	UpdateDateTime *time.Time

	// The ID of the workspace that contains the sync job.
	WorkspaceId *string

	noSmithyDocumentSerde
}

// The sync resource filter.
//
// The following types satisfy this interface:
//
//	SyncResourceFilterMemberExternalId
//	SyncResourceFilterMemberResourceId
//	SyncResourceFilterMemberResourceType
//	SyncResourceFilterMemberState
type SyncResourceFilter interface {
	isSyncResourceFilter()
}

// The external ID.
type SyncResourceFilterMemberExternalId struct {
	Value string

	noSmithyDocumentSerde
}

func (*SyncResourceFilterMemberExternalId) isSyncResourceFilter() {}

// The sync resource filter resource ID.
type SyncResourceFilterMemberResourceId struct {
	Value string

	noSmithyDocumentSerde
}

func (*SyncResourceFilterMemberResourceId) isSyncResourceFilter() {}

// The sync resource filter resource type
type SyncResourceFilterMemberResourceType struct {
	Value SyncResourceType

	noSmithyDocumentSerde
}

func (*SyncResourceFilterMemberResourceType) isSyncResourceFilter() {}

// The sync resource filter's state.
type SyncResourceFilterMemberState struct {
	Value SyncResourceState

	noSmithyDocumentSerde
}

func (*SyncResourceFilterMemberState) isSyncResourceFilter() {}

// The sync resource status.
type SyncResourceStatus struct {

	// The status error.
	Error *ErrorDetails

	// The sync resource status state.
	State SyncResourceState

	noSmithyDocumentSerde
}

// The sync resource summary.
type SyncResourceSummary struct {

	// The external ID.
	ExternalId *string

	// The resource ID.
	ResourceId *string

	// The resource type.
	ResourceType SyncResourceType

	// The sync resource summary status.
	Status *SyncResourceStatus

	// The update date and time.
	UpdateDateTime *time.Time

	noSmithyDocumentSerde
}

// The tabular conditions.
type TabularConditions struct {

	// Filter criteria that orders the output. It can be sorted in ascending or
	// descending order.
	OrderBy []OrderBy

	// You can filter the request using various logical operators and a key-value
	// format. For example: {"key": "serverType", "value": "webServer"}
	PropertyFilters []PropertyFilter

	noSmithyDocumentSerde
}

// An object that contains information about a workspace.
type WorkspaceSummary struct {

	// The ARN of the workspace.
	//
	// This member is required.
	Arn *string

	// The date and time when the workspace was created.
	//
	// This member is required.
	CreationDateTime *time.Time

	// The date and time when the workspace was last updated.
	//
	// This member is required.
	UpdateDateTime *time.Time

	// The ID of the workspace.
	//
	// This member is required.
	WorkspaceId *string

	// The description of the workspace.
	Description *string

	// A list of services that are linked to the workspace.
	LinkedServices []string

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde

// UnknownUnionMember is returned when a union member is returned over the wire,
// but has an unknown tag.
type UnknownUnionMember struct {
	Tag   string
	Value []byte

	noSmithyDocumentSerde
}

func (*UnknownUnionMember) isIotSiteWiseSourceConfigurationFilter()  {}
func (*UnknownUnionMember) isIotTwinMakerSourceConfigurationFilter() {}
func (*UnknownUnionMember) isListComponentTypesFilter()              {}
func (*UnknownUnionMember) isListEntitiesFilter()                    {}
func (*UnknownUnionMember) isListMetadataTransferJobsFilter()        {}
func (*UnknownUnionMember) isSyncResourceFilter()                    {}