cdk-lambda-subminute 2.0.482 → 2.0.484

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.
@@ -485,11 +485,11 @@ declare class IoTSiteWise extends Service {
485
485
  */
486
486
  listAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssetsResponse) => void): Request<IoTSiteWise.Types.ListAssetsResponse, AWSError>;
487
487
  /**
488
- * Retrieves a paginated list of associated assets. You can use this operation to do the following: List child assets associated to a parent asset by a hierarchy that you specify. List an asset's parent asset.
488
+ * Retrieves a paginated list of associated assets. You can use this operation to do the following: CHILD - List all child assets associated to the asset. PARENT - List the asset's parent asset.
489
489
  */
490
490
  listAssociatedAssets(params: IoTSiteWise.Types.ListAssociatedAssetsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssociatedAssetsResponse) => void): Request<IoTSiteWise.Types.ListAssociatedAssetsResponse, AWSError>;
491
491
  /**
492
- * Retrieves a paginated list of associated assets. You can use this operation to do the following: List child assets associated to a parent asset by a hierarchy that you specify. List an asset's parent asset.
492
+ * Retrieves a paginated list of associated assets. You can use this operation to do the following: CHILD - List all child assets associated to the asset. PARENT - List the asset's parent asset.
493
493
  */
494
494
  listAssociatedAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssociatedAssetsResponse) => void): Request<IoTSiteWise.Types.ListAssociatedAssetsResponse, AWSError>;
495
495
  /**
@@ -989,6 +989,14 @@ declare namespace IoTSiteWise {
989
989
  externalId?: ExternalId;
990
990
  }
991
991
  export interface AssetModelCompositeModelDefinition {
992
+ /**
993
+ * The ID to assign to the composite model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
994
+ */
995
+ id?: ID;
996
+ /**
997
+ * An external ID to assign to the composite model. The external ID must be unique among composite models within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
998
+ */
999
+ externalId?: ExternalId;
992
1000
  /**
993
1001
  * The name of the composite model.
994
1002
  */
@@ -1005,14 +1013,6 @@ declare namespace IoTSiteWise {
1005
1013
  * The asset property definitions for this composite model.
1006
1014
  */
1007
1015
  properties?: AssetModelPropertyDefinitions;
1008
- /**
1009
- * The ID to assign to the composite model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
1010
- */
1011
- id?: ID;
1012
- /**
1013
- * An external ID to assign to the composite model. The external ID must be unique among composite models within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
1014
- */
1015
- externalId?: ExternalId;
1016
1016
  }
1017
1017
  export type AssetModelCompositeModelDefinitions = AssetModelCompositeModelDefinition[];
1018
1018
  export type AssetModelCompositeModelPath = AssetModelCompositeModelPathSegment[];
@@ -1060,6 +1060,10 @@ declare namespace IoTSiteWise {
1060
1060
  * The ID of the asset model hierarchy. This ID is a hierarchyId. If you are callling UpdateAssetModel to create a new hierarchy: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique. If you are calling UpdateAssetModel to modify an existing hierarchy: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
1061
1061
  */
1062
1062
  id?: CustomID;
1063
+ /**
1064
+ * The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
1065
+ */
1066
+ externalId?: ExternalId;
1063
1067
  /**
1064
1068
  * The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
1065
1069
  */
@@ -1068,12 +1072,16 @@ declare namespace IoTSiteWise {
1068
1072
  * The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the childAssetModelId asset model. IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to UpdateAssetModel, you may provide either the asset model ID or else externalId: followed by the asset model's external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
1069
1073
  */
1070
1074
  childAssetModelId: CustomID;
1075
+ }
1076
+ export interface AssetModelHierarchyDefinition {
1071
1077
  /**
1072
- * The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
1078
+ * The ID to assign to the asset model hierarchy, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
1079
+ */
1080
+ id?: ID;
1081
+ /**
1082
+ * An external ID to assign to the asset model hierarchy. The external ID must be unique among asset model hierarchies within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
1073
1083
  */
1074
1084
  externalId?: ExternalId;
1075
- }
1076
- export interface AssetModelHierarchyDefinition {
1077
1085
  /**
1078
1086
  * The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).
1079
1087
  */
@@ -1082,14 +1090,6 @@ declare namespace IoTSiteWise {
1082
1090
  * The ID of an asset model for this hierarchy. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
1083
1091
  */
1084
1092
  childAssetModelId: CustomID;
1085
- /**
1086
- * The ID to assign to the asset model hierarchy, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
1087
- */
1088
- id?: ID;
1089
- /**
1090
- * An external ID to assign to the asset model hierarchy. The external ID must be unique among asset model hierarchies within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
1091
- */
1092
- externalId?: ExternalId;
1093
1093
  }
1094
1094
  export type AssetModelHierarchyDefinitions = AssetModelHierarchyDefinition[];
1095
1095
  export type AssetModelProperties = AssetModelProperty[];
@@ -1098,6 +1098,10 @@ declare namespace IoTSiteWise {
1098
1098
  * The ID of the asset model property. If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique. If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
1099
1099
  */
1100
1100
  id?: CustomID;
1101
+ /**
1102
+ * The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
1103
+ */
1104
+ externalId?: ExternalId;
1101
1105
  /**
1102
1106
  * The name of the asset model property.
1103
1107
  */
@@ -1122,12 +1126,16 @@ declare namespace IoTSiteWise {
1122
1126
  * The structured path to the property from the root of the asset model.
1123
1127
  */
1124
1128
  path?: AssetModelPropertyPath;
1129
+ }
1130
+ export interface AssetModelPropertyDefinition {
1125
1131
  /**
1126
- * The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
1132
+ * The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
1133
+ */
1134
+ id?: ID;
1135
+ /**
1136
+ * An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
1127
1137
  */
1128
1138
  externalId?: ExternalId;
1129
- }
1130
- export interface AssetModelPropertyDefinition {
1131
1139
  /**
1132
1140
  * The name of the property definition.
1133
1141
  */
@@ -1148,14 +1156,6 @@ declare namespace IoTSiteWise {
1148
1156
  * The property definition type (see PropertyType). You can only specify one type in a property definition.
1149
1157
  */
1150
1158
  type: PropertyType;
1151
- /**
1152
- * The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
1153
- */
1154
- id?: ID;
1155
- /**
1156
- * An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
1157
- */
1158
- externalId?: ExternalId;
1159
1159
  }
1160
1160
  export type AssetModelPropertyDefinitions = AssetModelPropertyDefinition[];
1161
1161
  export type AssetModelPropertyPath = AssetModelPropertyPathSegment[];
@@ -1175,6 +1175,10 @@ declare namespace IoTSiteWise {
1175
1175
  * The ID of the property.
1176
1176
  */
1177
1177
  id?: ID;
1178
+ /**
1179
+ * The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
1180
+ */
1181
+ externalId?: ExternalId;
1178
1182
  /**
1179
1183
  * The name of the property.
1180
1184
  */
@@ -1200,10 +1204,6 @@ declare namespace IoTSiteWise {
1200
1204
  * The structured path to the property from the root of the asset model.
1201
1205
  */
1202
1206
  path?: AssetModelPropertyPath;
1203
- /**
1204
- * The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
1205
- */
1206
- externalId?: ExternalId;
1207
1207
  }
1208
1208
  export type AssetModelState = "CREATING"|"ACTIVE"|"UPDATING"|"PROPAGATING"|"DELETING"|"FAILED"|string;
1209
1209
  export interface AssetModelStatus {
@@ -1222,6 +1222,10 @@ declare namespace IoTSiteWise {
1222
1222
  * The ID of the asset model (used with IoT SiteWise API operations).
1223
1223
  */
1224
1224
  id: ID;
1225
+ /**
1226
+ * The external ID of the asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
1227
+ */
1228
+ externalId?: ExternalId;
1225
1229
  /**
1226
1230
  * The ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
1227
1231
  */
@@ -1230,6 +1234,10 @@ declare namespace IoTSiteWise {
1230
1234
  * The name of the asset model.
1231
1235
  */
1232
1236
  name: Name;
1237
+ /**
1238
+ * The type of asset model. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
1239
+ */
1240
+ assetModelType?: AssetModelType;
1233
1241
  /**
1234
1242
  * The asset model description.
1235
1243
  */
@@ -1247,15 +1255,13 @@ declare namespace IoTSiteWise {
1247
1255
  */
1248
1256
  status: AssetModelStatus;
1249
1257
  /**
1250
- * The type of asset model. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
1251
- */
1252
- assetModelType?: AssetModelType;
1253
- /**
1254
- * The external ID of the asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
1258
+ * The version number of the asset model.
1255
1259
  */
1256
- externalId?: ExternalId;
1260
+ version?: Version;
1257
1261
  }
1258
1262
  export type AssetModelType = "ASSET_MODEL"|"COMPONENT_MODEL"|string;
1263
+ export type AssetModelVersionFilter = string;
1264
+ export type AssetModelVersionType = "LATEST"|"ACTIVE"|string;
1259
1265
  export type AssetProperties = AssetProperty[];
1260
1266
  export interface AssetProperty {
1261
1267
  /**
@@ -2060,14 +2066,14 @@ declare namespace IoTSiteWise {
2060
2066
  * The ID of the asset model this composite model is a part of.
2061
2067
  */
2062
2068
  assetModelId: CustomID;
2063
- /**
2064
- * The ID of the parent composite model in this asset model relationship.
2065
- */
2066
- parentAssetModelCompositeModelId?: CustomID;
2067
2069
  /**
2068
2070
  * An external ID to assign to the composite model. If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.
2069
2071
  */
2070
2072
  assetModelCompositeModelExternalId?: ExternalId;
2073
+ /**
2074
+ * The ID of the parent composite model in this asset model relationship.
2075
+ */
2076
+ parentAssetModelCompositeModelId?: CustomID;
2071
2077
  /**
2072
2078
  * The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
2073
2079
  */
@@ -2096,6 +2102,18 @@ declare namespace IoTSiteWise {
2096
2102
  * The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide. You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.
2097
2103
  */
2098
2104
  assetModelCompositeModelProperties?: AssetModelPropertyDefinitions;
2105
+ /**
2106
+ * The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The create request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
2107
+ */
2108
+ ifMatch?: ETag;
2109
+ /**
2110
+ * Accepts * to reject the create request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
2111
+ */
2112
+ ifNoneMatch?: SelectAll;
2113
+ /**
2114
+ * Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the create operation.
2115
+ */
2116
+ matchForVersionType?: AssetModelVersionType;
2099
2117
  }
2100
2118
  export interface CreateAssetModelCompositeModelResponse {
2101
2119
  /**
@@ -2113,6 +2131,18 @@ declare namespace IoTSiteWise {
2113
2131
  * A unique name for the asset model.
2114
2132
  */
2115
2133
  assetModelName: Name;
2134
+ /**
2135
+ * The type of asset model. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
2136
+ */
2137
+ assetModelType?: AssetModelType;
2138
+ /**
2139
+ * The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
2140
+ */
2141
+ assetModelId?: ID;
2142
+ /**
2143
+ * An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
2144
+ */
2145
+ assetModelExternalId?: ExternalId;
2116
2146
  /**
2117
2147
  * A description for the asset model.
2118
2148
  */
@@ -2137,18 +2167,6 @@ declare namespace IoTSiteWise {
2137
2167
  * A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
2138
2168
  */
2139
2169
  tags?: TagMap;
2140
- /**
2141
- * The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
2142
- */
2143
- assetModelId?: ID;
2144
- /**
2145
- * An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
2146
- */
2147
- assetModelExternalId?: ExternalId;
2148
- /**
2149
- * The type of asset model. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
2150
- */
2151
- assetModelType?: AssetModelType;
2152
2170
  }
2153
2171
  export interface CreateAssetModelResponse {
2154
2172
  /**
@@ -2494,6 +2512,18 @@ declare namespace IoTSiteWise {
2494
2512
  * 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.
2495
2513
  */
2496
2514
  clientToken?: ClientToken;
2515
+ /**
2516
+ * The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The delete request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
2517
+ */
2518
+ ifMatch?: ETag;
2519
+ /**
2520
+ * Accepts * to reject the delete request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
2521
+ */
2522
+ ifNoneMatch?: SelectAll;
2523
+ /**
2524
+ * Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the delete operation.
2525
+ */
2526
+ matchForVersionType?: AssetModelVersionType;
2497
2527
  }
2498
2528
  export interface DeleteAssetModelCompositeModelResponse {
2499
2529
  assetModelStatus: AssetModelStatus;
@@ -2507,6 +2537,18 @@ declare namespace IoTSiteWise {
2507
2537
  * 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.
2508
2538
  */
2509
2539
  clientToken?: ClientToken;
2540
+ /**
2541
+ * The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The delete request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
2542
+ */
2543
+ ifMatch?: ETag;
2544
+ /**
2545
+ * Accepts * to reject the delete request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
2546
+ */
2547
+ ifNoneMatch?: SelectAll;
2548
+ /**
2549
+ * Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the delete operation.
2550
+ */
2551
+ matchForVersionType?: AssetModelVersionType;
2510
2552
  }
2511
2553
  export interface DeleteAssetModelResponse {
2512
2554
  /**
@@ -2720,6 +2762,10 @@ declare namespace IoTSiteWise {
2720
2762
  * The ID of a composite model on this asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2721
2763
  */
2722
2764
  assetModelCompositeModelId: CustomID;
2765
+ /**
2766
+ * The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
2767
+ */
2768
+ assetModelVersion?: AssetModelVersionFilter;
2723
2769
  }
2724
2770
  export interface DescribeAssetModelCompositeModelResponse {
2725
2771
  /**
@@ -2776,12 +2822,20 @@ declare namespace IoTSiteWise {
2776
2822
  * Whether or not to exclude asset model properties from the response.
2777
2823
  */
2778
2824
  excludeProperties?: ExcludeProperties;
2825
+ /**
2826
+ * The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
2827
+ */
2828
+ assetModelVersion?: AssetModelVersionFilter;
2779
2829
  }
2780
2830
  export interface DescribeAssetModelResponse {
2781
2831
  /**
2782
2832
  * The ID of the asset model, in UUID format.
2783
2833
  */
2784
2834
  assetModelId: ID;
2835
+ /**
2836
+ * The external ID of the asset model, if any.
2837
+ */
2838
+ assetModelExternalId?: ExternalId;
2785
2839
  /**
2786
2840
  * The ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
2787
2841
  */
@@ -2790,6 +2844,10 @@ declare namespace IoTSiteWise {
2790
2844
  * The name of the asset model.
2791
2845
  */
2792
2846
  assetModelName: Name;
2847
+ /**
2848
+ * The type of asset model. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
2849
+ */
2850
+ assetModelType?: AssetModelType;
2793
2851
  /**
2794
2852
  * The asset model's description.
2795
2853
  */
@@ -2806,6 +2864,10 @@ declare namespace IoTSiteWise {
2806
2864
  * The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.
2807
2865
  */
2808
2866
  assetModelCompositeModels?: AssetModelCompositeModels;
2867
+ /**
2868
+ * The list of the immediate child custom composite model summaries for the asset model.
2869
+ */
2870
+ assetModelCompositeModelSummaries?: AssetModelCompositeModelSummaries;
2809
2871
  /**
2810
2872
  * The date the asset model was created, in Unix epoch time.
2811
2873
  */
@@ -2819,17 +2881,13 @@ declare namespace IoTSiteWise {
2819
2881
  */
2820
2882
  assetModelStatus: AssetModelStatus;
2821
2883
  /**
2822
- * The type of asset model. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
2884
+ * The version of the asset model. See Asset model versions in the IoT SiteWise User Guide.
2823
2885
  */
2824
- assetModelType?: AssetModelType;
2886
+ assetModelVersion?: Version;
2825
2887
  /**
2826
- * The list of the immediate child custom composite model summaries for the asset model.
2888
+ * The entity tag (ETag) is a hash of the retrieved version of the asset model. It's used to make concurrent updates safely to the resource. See Optimistic locking for asset model writes in the IoT SiteWise User Guide. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
2827
2889
  */
2828
- assetModelCompositeModelSummaries?: AssetModelCompositeModelSummaries;
2829
- /**
2830
- * The external ID of the asset model, if any.
2831
- */
2832
- assetModelExternalId?: ExternalId;
2890
+ eTag?: ETag;
2833
2891
  }
2834
2892
  export interface DescribeAssetPropertyRequest {
2835
2893
  /**
@@ -3351,6 +3409,7 @@ declare namespace IoTSiteWise {
3351
3409
  clientToken?: ClientToken;
3352
3410
  }
3353
3411
  export type DisassociatedDataStorageState = "ENABLED"|"DISABLED"|string;
3412
+ export type ETag = string;
3354
3413
  export type Email = string;
3355
3414
  export type EncryptionType = "SITEWISE_DEFAULT_ENCRYPTION"|"KMS_BASED_ENCRYPTION"|string;
3356
3415
  export type EntryId = string;
@@ -3915,6 +3974,10 @@ declare namespace IoTSiteWise {
3915
3974
  * The maximum number of results to return for each paginated request. Default: 50
3916
3975
  */
3917
3976
  maxResults?: MaxResults;
3977
+ /**
3978
+ * The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
3979
+ */
3980
+ assetModelVersion?: AssetModelVersionFilter;
3918
3981
  }
3919
3982
  export interface ListAssetModelCompositeModelsResponse {
3920
3983
  /**
@@ -3944,6 +4007,10 @@ declare namespace IoTSiteWise {
3944
4007
  * Filters the requested list of asset model properties. You can choose one of the following options: ALL – The list includes all asset model properties for a given asset model ID. BASE – The list includes only base asset model properties for a given asset model ID. Default: BASE
3945
4008
  */
3946
4009
  filter?: ListAssetModelPropertiesFilter;
4010
+ /**
4011
+ * The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
4012
+ */
4013
+ assetModelVersion?: AssetModelVersionFilter;
3947
4014
  }
3948
4015
  export interface ListAssetModelPropertiesResponse {
3949
4016
  /**
@@ -3956,6 +4023,10 @@ declare namespace IoTSiteWise {
3956
4023
  nextToken?: NextToken;
3957
4024
  }
3958
4025
  export interface ListAssetModelsRequest {
4026
+ /**
4027
+ * The type of asset model. If you don't provide an assetModelTypes, all types of asset models are returned. ASSET_MODEL – An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
4028
+ */
4029
+ assetModelTypes?: ListAssetModelsTypeFilter;
3959
4030
  /**
3960
4031
  * The token to be used for the next set of paginated results.
3961
4032
  */
@@ -3965,9 +4036,9 @@ declare namespace IoTSiteWise {
3965
4036
  */
3966
4037
  maxResults?: MaxResults;
3967
4038
  /**
3968
- * The type of asset model. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
4039
+ * The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
3969
4040
  */
3970
- assetModelTypes?: ListAssetModelsTypeFilter;
4041
+ assetModelVersion?: AssetModelVersionFilter;
3971
4042
  }
3972
4043
  export interface ListAssetModelsResponse {
3973
4044
  /**
@@ -4072,11 +4143,11 @@ declare namespace IoTSiteWise {
4072
4143
  */
4073
4144
  assetId: CustomID;
4074
4145
  /**
4075
- * The ID of the hierarchy by which child assets are associated to the asset. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
4146
+ * (Optional) If you don't provide a hierarchyId, all the immediate assets in the traversalDirection will be returned. The ID of the hierarchy by which child assets are associated to the asset. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) For more information, see Asset hierarchies in the IoT SiteWise User Guide.
4076
4147
  */
4077
4148
  hierarchyId?: CustomID;
4078
4149
  /**
4079
- * The direction to list associated assets. Choose one of the following options: CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD. PARENT – The list includes the asset's parent asset. Default: CHILD
4150
+ * The direction to list associated assets. Choose one of the following options: CHILD – The list includes all child assets associated to the asset. PARENT – The list includes the asset's parent asset. Default: CHILD
4080
4151
  */
4081
4152
  traversalDirection?: TraversalDirection;
4082
4153
  /**
@@ -4674,6 +4745,7 @@ declare namespace IoTSiteWise {
4674
4745
  export type SSOApplicationId = string;
4675
4746
  export type ScalarType = "BOOLEAN"|"INT"|"DOUBLE"|"TIMESTAMP"|"STRING"|string;
4676
4747
  export type ScalarValue = string;
4748
+ export type SelectAll = string;
4677
4749
  export interface SiemensIE {
4678
4750
  /**
4679
4751
  * The name of the IoT Thing for your SiteWise Edge gateway.
@@ -4858,6 +4930,18 @@ declare namespace IoTSiteWise {
4858
4930
  * The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide. You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.
4859
4931
  */
4860
4932
  assetModelCompositeModelProperties?: AssetModelProperties;
4933
+ /**
4934
+ * The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The update request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
4935
+ */
4936
+ ifMatch?: ETag;
4937
+ /**
4938
+ * Accepts * to reject the update request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
4939
+ */
4940
+ ifNoneMatch?: SelectAll;
4941
+ /**
4942
+ * Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the update operation.
4943
+ */
4944
+ matchForVersionType?: AssetModelVersionType;
4861
4945
  }
4862
4946
  export interface UpdateAssetModelCompositeModelResponse {
4863
4947
  /**
@@ -4871,6 +4955,10 @@ declare namespace IoTSiteWise {
4871
4955
  * The ID of the asset model to update. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
4872
4956
  */
4873
4957
  assetModelId: CustomID;
4958
+ /**
4959
+ * An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
4960
+ */
4961
+ assetModelExternalId?: ExternalId;
4874
4962
  /**
4875
4963
  * A unique name for the asset model.
4876
4964
  */
@@ -4896,9 +4984,17 @@ declare namespace IoTSiteWise {
4896
4984
  */
4897
4985
  clientToken?: ClientToken;
4898
4986
  /**
4899
- * An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
4987
+ * The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The update request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
4900
4988
  */
4901
- assetModelExternalId?: ExternalId;
4989
+ ifMatch?: ETag;
4990
+ /**
4991
+ * Accepts * to reject the update request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
4992
+ */
4993
+ ifNoneMatch?: SelectAll;
4994
+ /**
4995
+ * Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the update operation.
4996
+ */
4997
+ matchForVersionType?: AssetModelVersionType;
4902
4998
  }
4903
4999
  export interface UpdateAssetModelResponse {
4904
5000
  /**
@@ -5119,6 +5215,7 @@ declare namespace IoTSiteWise {
5119
5215
  */
5120
5216
  booleanValue?: PropertyValueBooleanValue;
5121
5217
  }
5218
+ export type Version = string;
5122
5219
  export interface WarmTierRetentionPeriod {
5123
5220
  /**
5124
5221
  * The number of days the data is stored in the warm tier.
@@ -102,11 +102,11 @@ declare class Omics extends Service {
102
102
  */
103
103
  createReferenceStore(callback?: (err: AWSError, data: Omics.Types.CreateReferenceStoreResponse) => void): Request<Omics.Types.CreateReferenceStoreResponse, AWSError>;
104
104
  /**
105
- * Creates a run group.
105
+ * You can optionally create a run group to limit the compute resources for the runs that you add to the group.
106
106
  */
107
107
  createRunGroup(params: Omics.Types.CreateRunGroupRequest, callback?: (err: AWSError, data: Omics.Types.CreateRunGroupResponse) => void): Request<Omics.Types.CreateRunGroupResponse, AWSError>;
108
108
  /**
109
- * Creates a run group.
109
+ * You can optionally create a run group to limit the compute resources for the runs that you add to the group.
110
110
  */
111
111
  createRunGroup(callback?: (err: AWSError, data: Omics.Types.CreateRunGroupResponse) => void): Request<Omics.Types.CreateRunGroupResponse, AWSError>;
112
112
  /**
@@ -118,11 +118,11 @@ declare class Omics extends Service {
118
118
  */
119
119
  createSequenceStore(callback?: (err: AWSError, data: Omics.Types.CreateSequenceStoreResponse) => void): Request<Omics.Types.CreateSequenceStoreResponse, AWSError>;
120
120
  /**
121
- * Creates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an AWS user with a different account than the resource owner). The following resources support cross-account sharing: Healthomics variant stores Healthomics annotation stores Private workflows
121
+ * Creates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an AWS user with a different account than the resource owner). The following resources support cross-account sharing: HealthOmics variant stores HealthOmics annotation stores Private workflows
122
122
  */
123
123
  createShare(params: Omics.Types.CreateShareRequest, callback?: (err: AWSError, data: Omics.Types.CreateShareResponse) => void): Request<Omics.Types.CreateShareResponse, AWSError>;
124
124
  /**
125
- * Creates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an AWS user with a different account than the resource owner). The following resources support cross-account sharing: Healthomics variant stores Healthomics annotation stores Private workflows
125
+ * Creates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an AWS user with a different account than the resource owner). The following resources support cross-account sharing: HealthOmics variant stores HealthOmics annotation stores Private workflows
126
126
  */
127
127
  createShare(callback?: (err: AWSError, data: Omics.Types.CreateShareResponse) => void): Request<Omics.Types.CreateShareResponse, AWSError>;
128
128
  /**
@@ -1392,15 +1392,15 @@ declare namespace Omics {
1392
1392
  */
1393
1393
  name?: RunGroupName;
1394
1394
  /**
1395
- * The maximum number of CPUs to use in the group.
1395
+ * The maximum number of CPUs that can run concurrently across all active runs in the run group.
1396
1396
  */
1397
1397
  maxCpus?: CreateRunGroupRequestMaxCpusInteger;
1398
1398
  /**
1399
- * The maximum number of concurrent runs for the group.
1399
+ * The maximum number of runs that can be running at the same time.
1400
1400
  */
1401
1401
  maxRuns?: CreateRunGroupRequestMaxRunsInteger;
1402
1402
  /**
1403
- * A maximum run time for the group in minutes.
1403
+ * The maximum time for each run (in minutes). If a run exceeds the maximum run time, the run fails automatically.
1404
1404
  */
1405
1405
  maxDuration?: CreateRunGroupRequestMaxDurationInteger;
1406
1406
  /**
@@ -1412,7 +1412,7 @@ declare namespace Omics {
1412
1412
  */
1413
1413
  requestId: RunGroupRequestId;
1414
1414
  /**
1415
- * The maximum GPUs that can be used by a run group.
1415
+ * The maximum number of GPUs that can run concurrently across all active runs in the run group.
1416
1416
  */
1417
1417
  maxGpus?: CreateRunGroupRequestMaxGpusInteger;
1418
1418
  }
@@ -1600,7 +1600,7 @@ declare namespace Omics {
1600
1600
  */
1601
1601
  parameterTemplate?: WorkflowParameterTemplate;
1602
1602
  /**
1603
- * The storage capacity for the workflow in gibibytes.
1603
+ * The default storage capacity for the workflow runs, in gibibytes.
1604
1604
  */
1605
1605
  storageCapacity?: CreateWorkflowRequestStorageCapacityInteger;
1606
1606
  /**
@@ -1635,6 +1635,7 @@ declare namespace Omics {
1635
1635
  */
1636
1636
  tags?: TagMap;
1637
1637
  }
1638
+ export type CreationJobId = string;
1638
1639
  export type CreationTime = Date;
1639
1640
  export type CreationType = "IMPORT"|"UPLOAD"|string;
1640
1641
  export interface DeleteAnnotationStoreRequest {
@@ -2274,6 +2275,10 @@ declare namespace Omics {
2274
2275
  * The entity tag (ETag) is a hash of the object meant to represent its semantic content.
2275
2276
  */
2276
2277
  etag?: ETag;
2278
+ /**
2279
+ * The read set's creation job ID.
2280
+ */
2281
+ creationJobId?: CreationJobId;
2277
2282
  }
2278
2283
  export interface GetReadSetRequest {
2279
2284
  /**
@@ -2395,6 +2400,14 @@ declare namespace Omics {
2395
2400
  * The reference's files.
2396
2401
  */
2397
2402
  files?: ReferenceFiles;
2403
+ /**
2404
+ * The reference's creation type.
2405
+ */
2406
+ creationType?: ReferenceCreationType;
2407
+ /**
2408
+ * The reference's creation job ID.
2409
+ */
2410
+ creationJobId?: CreationJobId;
2398
2411
  }
2399
2412
  export interface GetReferenceRequest {
2400
2413
  /**
@@ -2938,7 +2951,7 @@ declare namespace Omics {
2938
2951
  */
2939
2952
  parameterTemplate?: WorkflowParameterTemplate;
2940
2953
  /**
2941
- * The workflow's storage capacity in gibibytes.
2954
+ * The workflow's default run storage capacity in gibibytes.
2942
2955
  */
2943
2956
  storageCapacity?: GetWorkflowResponseStorageCapacityInteger;
2944
2957
  /**
@@ -3051,6 +3064,10 @@ declare namespace Omics {
3051
3064
  * The source's tags.
3052
3065
  */
3053
3066
  tags?: TagMap;
3067
+ /**
3068
+ * The source's read set ID.
3069
+ */
3070
+ readSetId?: ReadSetId;
3054
3071
  }
3055
3072
  export type ImportReadSetSourceList = ImportReadSetSourceItem[];
3056
3073
  export interface ImportReferenceFilter {
@@ -3119,6 +3136,10 @@ declare namespace Omics {
3119
3136
  * The source's tags.
3120
3137
  */
3121
3138
  tags?: TagMap;
3139
+ /**
3140
+ * The source's reference ID.
3141
+ */
3142
+ referenceId?: ReferenceId;
3122
3143
  }
3123
3144
  export type ImportReferenceSourceList = ImportReferenceSourceItem[];
3124
3145
  export type Integer = number;
@@ -4043,6 +4064,7 @@ declare namespace Omics {
4043
4064
  export type ReadSetUploadPartListItemPartSizeLong = number;
4044
4065
  export type ReferenceArn = string;
4045
4066
  export type ReferenceArnFilter = string;
4067
+ export type ReferenceCreationType = "IMPORT"|string;
4046
4068
  export type ReferenceDescription = string;
4047
4069
  export type ReferenceFile = "SOURCE"|"INDEX"|string;
4048
4070
  export interface ReferenceFiles {